summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-03-23 17:43:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-03-23 17:43:36 +0000
commitd06e38179a142f4d7ca1bfe27b9be572230e150b (patch)
tree244a91e570b7db74b636b6a1d357d38d3c95e20b
parentInitial commit. (diff)
downloadicingaweb2-module-pdfexport-d06e38179a142f4d7ca1bfe27b9be572230e150b.tar.xz
icingaweb2-module-pdfexport-d06e38179a142f4d7ca1bfe27b9be572230e150b.zip
Adding upstream version 0.9.0.upstream/0.9.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
-rw-r--r--.github/ISSUE_TEMPLATE.md46
-rw-r--r--.gitignore5
-rw-r--r--LICENSE339
-rw-r--r--README.md7
-rw-r--r--doc/02-Installation.md21
-rw-r--r--library/Pdfexport/HeadlessChrome.php188
-rw-r--r--library/Pdfexport/ProvidedHook/Pdfexport.php116
-rw-r--r--library/Pdfexport/ShellCommand.php148
-rw-r--r--module.info3
-rw-r--r--run.php6
10 files changed, 879 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..feb3c1c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,46 @@
+<!--- Provide a general summary of the issue in the Title above -->
+
+<!-- Formatting tips:
+
+GitHub supports Markdown: https://guides.github.com/features/mastering-markdown/
+Multi-line code blocks either with three back ticks, or four space indent.
+
+```
+Stacktrace ...
+<line>
+<line>
+```
+-->
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement: the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include configuration, logs, etc. to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the problem in -->
+* Module version (System - About):
+* Icinga Web 2 version and modules (System - About):
+* Icinga 2 version (`icinga2 --version`):
+* Operating System and version:
+* Webserver, PHP versions:
+
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1f03d4b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+# Exclude all hidden files
+.*
+
+# Except those related to Git
+!.git*
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..23cb790
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ {description}
+ Copyright (C) {year} {fullname}
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ {signature of Ty Coon}, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db4f3fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Icinga PDF Export
+
+PDF export functionality for Icinga Web 2 using Google Chrome/Chromium for rendering.
+
+## Documentation
+
+* [Installation](doc/02-Installation.md)
diff --git a/doc/02-Installation.md b/doc/02-Installation.md
new file mode 100644
index 0000000..02286a6
--- /dev/null
+++ b/doc/02-Installation.md
@@ -0,0 +1,21 @@
+# <a id="Installation"></a>Installation
+
+## Requirements
+
+* Icinga Web 2 (&gt;= 2.6)
+* PHP (&gt;= 5.6, preferably 7.x)
+
+## Google Chrome/Chromium Setup
+
+The module needs Google Chrome or Chromium supporting headless mode.
+For RHEL based systems you'll find `chromium-headless` in the EPEL repositories.
+For debian based systems you may add `https://dl.google.com/linux/chrome/deb/ stable main` to your apt sources.
+
+## Installation
+
+1. Just drop this module to a `pdfexport` subfolder in your Icinga Web 2 module path.
+
+2. Log in with a privileged user in Icinga Web 2 and enable the module in `Configuration -> Modules -> pdfexport`.
+Or use the `icingacli` and run `icingacli module enable pdfexport`.
+
+This concludes the installation. PDF exports now use Google Chrome/Chromium for rendering.
diff --git a/library/Pdfexport/HeadlessChrome.php b/library/Pdfexport/HeadlessChrome.php
new file mode 100644
index 0000000..d9f480d
--- /dev/null
+++ b/library/Pdfexport/HeadlessChrome.php
@@ -0,0 +1,188 @@
+<?php
+// Icinga PDF Export | (c) 2018 Icinga GmbH | GPLv2
+
+namespace Icinga\Module\Pdfexport;
+
+use Icinga\File\Storage\TemporaryLocalFileStorage;
+
+class HeadlessChrome
+{
+ /** @var string Path to the Chrome binary */
+ protected $binary;
+
+ /** @var string Target Url */
+ protected $url;
+
+ /** @var TemporaryLocalFileStorage */
+ protected $fileStorage;
+
+ public function __construct()
+ {
+ $this->fileStorage = new TemporaryLocalFileStorage();
+ }
+
+ /**
+ * Get the path to the Chrome binary
+ *
+ * @return string
+ */
+ public function getBinary()
+ {
+ return $this->binary;
+ }
+
+ /**
+ * Set the path to the Chrome binary
+ *
+ * @param string $binary
+ *
+ * @return $this
+ */
+ public function setBinary($binary)
+ {
+ $this->binary = $binary;
+
+ return $this;
+ }
+
+ /**
+ * Render the given argument name-value pairs as shell-escaped string
+ *
+ * @param array $arguments
+ *
+ * @return string
+ */
+ public static function renderArgumentList(array $arguments)
+ {
+ $list = [];
+
+ foreach ($arguments as $name => $value) {
+ if ($value !== null) {
+ $value = escapeshellarg($value);
+
+ if (! is_int($name)) {
+ if (substr($name, -1) === '=') {
+ $glue = '';
+ } else {
+ $glue = ' ';
+ }
+
+ $list[] = escapeshellarg($name) . $glue . $value;
+ } else {
+ $list[] = $value;
+ }
+ } else {
+ $list[] = escapeshellarg($name);
+ }
+ }
+
+ return implode(' ', $list);
+ }
+
+ /**
+ * Get the target Url
+ *
+ * @return string
+ */
+ public function getUrl()
+ {
+ return $this->url;
+ }
+
+ /**
+ * Set the target Url
+ *
+ * @param string $url
+ *
+ * @return $this
+ */
+ public function setUrl($url)
+ {
+ $this->url = $url;
+
+ return $this;
+ }
+
+ /**
+ * Use the given HTML string as input
+ *
+ * @param string $html
+ * @param bool $asFile
+ *
+ * @return $this
+ */
+ public function fromHtml($html, $asFile = true)
+ {
+ if ($asFile) {
+ $path = uniqid('icingaweb2-pdfexport-') . '.html';
+
+ $this->fileStorage->create($path, $html);
+
+ $path = $this->fileStorage->resolvePath($path, true);
+
+ $this->setUrl("file://$path");
+ } else {
+ $this->setUrl('data:text/html,' . rawurlencode($html));
+ }
+
+ return $this;
+ }
+
+ /**
+ * Export to PDF
+ *
+ * @param $filename
+ *
+ * @return string
+ */
+ public function toPdf($filename)
+ {
+ $path = uniqid('icingaweb2-pdfexport-') . $filename;
+
+ $this->fileStorage->create($path, '');
+
+ $path = $this->fileStorage->resolvePath($path, true);
+
+ $arguments = [
+ '--headless',
+ '--disable-gpu',
+ '--no-sandbox',
+ '--print-to-pdf=' => $path,
+ $this->getUrl()
+ ];
+
+ $command = new ShellCommand(
+ escapeshellarg($this->getBinary()) . ' ' . static::renderArgumentList($arguments),
+ false
+ );
+
+ $command->execute();
+
+ return $path;
+ }
+
+ /**
+ * Get the major version number of Chrome or false on failure
+ *
+ * @return bool|int
+ */
+ public function getVersion()
+ {
+ $command = new ShellCommand(
+ escapeshellarg($this->getBinary()) . ' ' . static::renderArgumentList(['--version']),
+ false
+ );
+
+ $output = $command->execute();
+
+ if ($command->getExitCode() !== 0) {
+ return false;
+ }
+
+ $parts = explode(' ', trim($output->stdout));
+
+ $version = (int) array_pop($parts);
+
+ return $version;
+ }
+}
diff --git a/library/Pdfexport/ProvidedHook/Pdfexport.php b/library/Pdfexport/ProvidedHook/Pdfexport.php
new file mode 100644
index 0000000..b73ffa7
--- /dev/null
+++ b/library/Pdfexport/ProvidedHook/Pdfexport.php
@@ -0,0 +1,116 @@
+<?php
+// Icinga PDF Export | (c) 2018 Icinga GmbH | GPLv2
+
+namespace Icinga\Module\Pdfexport\ProvidedHook;
+
+use Icinga\Application\Config;
+use Icinga\Application\Hook\PdfexportHook;
+use Icinga\Application\Icinga;
+use Icinga\Module\Pdfexport\HeadlessChrome;
+
+class Pdfexport extends PdfexportHook
+{
+ public static function getBinary()
+ {
+ return Config::module('pdfexport')->get('chrome', 'binary', '/bin/google-chrome');
+ }
+
+ public function isSupported()
+ {
+ return (new HeadlessChrome())->setBinary(static::getBinary())->getVersion() >= 59;
+ }
+
+ public function htmlToPdf($html)
+ {
+ $style = strpos($html, '</style>');
+ if ($style !== false) {
+ // Inject custom CSS
+ $css = <<<'CSS'
+@page {
+ margin: 1.6cm;
+}
+
+body {
+ margin: 0;
+}
+
+body > img {
+ margin-top: -1em;
+}
+</style>
+CSS;
+ $html = substr($html, 0, $style) . $css . substr($html, $style + 8);
+ }
+
+ $footer = strrpos($html, '<div id="page-footer">');
+ if ($footer !== false) {
+ // Hide page footer
+ $html = substr($html, 0, $footer)
+ . '<div id="page-footer" style="display: none !important;">'
+ . substr($html, $footer + 22);
+ }
+
+ // Keep reference to the chrome object because it is using temp files which are automatically removed when
+ // the object is destructed
+ $chrome = new HeadlessChrome();
+
+ $pdf = $chrome
+ ->setBinary(static::getBinary())
+ ->fromHtml($html)
+ ->toPdf('direct');
+
+ return file_get_contents($pdf);
+ }
+
+ public function streamPdfFromHtml($html, $filename)
+ {
+ $filename = basename($filename, '.pdf') . '.pdf';
+
+ $style = strpos($html, '</style>');
+ if ($style !== false) {
+ // Inject custom CSS
+ $css = <<<'CSS'
+@page {
+ margin: 1.6cm;
+}
+
+body {
+ margin: 0;
+}
+
+body > img {
+ margin-top: -1em;
+}
+</style>
+CSS;
+ $html = substr($html, 0, $style) . $css . substr($html, $style + 8);
+ }
+
+ $footer = strrpos($html, '<div id="page-footer">');
+ if ($footer !== false) {
+ // Hide page footer
+ $html = substr($html, 0, $footer)
+ . '<div id="page-footer" style="display: none !important;">'
+ . substr($html, $footer + 22);
+ }
+
+ // Keep reference to the chrome object because it is using temp files which are automatically removed when
+ // the object is destructed
+ $chrome = new HeadlessChrome();
+
+ $pdf = $chrome
+ ->setBinary(static::getBinary())
+ ->fromHtml($html)
+ ->toPdf($filename);
+
+ $response = Icinga::app()->getResponse();
+
+ $response->setHeader('Content-Type', 'application/pdf', true);
+ $response->setHeader('Content-Disposition', "inline; filename=\"$filename\"", true);
+ $response->sendHeaders();
+
+ readfile($pdf);
+
+ exit;
+ }
+}
diff --git a/library/Pdfexport/ShellCommand.php b/library/Pdfexport/ShellCommand.php
new file mode 100644
index 0000000..71bcca5
--- /dev/null
+++ b/library/Pdfexport/ShellCommand.php
@@ -0,0 +1,148 @@
+<?php
+// Icinga PDF Export | (c) 2018 Icinga GmbH | GPLv2
+
+namespace Icinga\Module\Pdfexport;
+
+class ShellCommand
+{
+ /** @var string Command to execute */
+ protected $command;
+
+ /** @var int Exit code of the command */
+ protected $exitCode;
+
+ /** @var resource Process resource */
+ protected $resource;
+
+ /**
+ * Create a new command
+ *
+ * @param string $command The command to execute
+ * @param bool $escape Whether to escape the command
+ */
+ public function __construct($command, $escape = true)
+ {
+ $command = (string) $command;
+
+ $this->command = $escape ? escapeshellcmd($command) : $command;
+ }
+
+ /**
+ * Get the exit code of the command
+ *
+ * @return int
+ */
+ public function getExitCode()
+ {
+ return $this->exitCode;
+ }
+
+ /**
+ * Get the status of the command
+ *
+ * @return object
+ */
+ public function getStatus()
+ {
+ $status = (object) proc_get_status($this->resource);
+ if ($status->running === false
+ && $this->exitCode === null
+ ) {
+ // The exit code is only valid the first time proc_get_status is
+ // called in terms of running false, hence we capture it
+ $this->exitCode = $status->exitcode;
+ }
+ return $status;
+ }
+
+ /**
+ * Execute the command
+ *
+ * @return object
+ *
+ * @throws \Exception
+ */
+ public function execute()
+ {
+ if ($this->resource !== null) {
+ throw new \Exception('Command already started');
+ }
+
+ $descriptors = [
+ ['pipe', 'r'], // stdin
+ ['pipe', 'w'], // stdout
+ ['pipe', 'w'] // stderr
+ ];
+
+ $this->resource = proc_open(
+ $this->command,
+ $descriptors,
+ $pipes
+ );
+
+ if (! is_resource($this->resource)) {
+ throw new \Exception(sprintf(
+ "Can't fork '%s'",
+ $this->command
+ ));
+ }
+
+ $namedpipes = (object) [
+ 'stdin' => &$pipes[0],
+ 'stdout' => &$pipes[1],
+ 'stderr' => &$pipes[2]
+ ];
+
+ fclose($namedpipes->stdin);
+
+ $read = [$namedpipes->stderr, $namedpipes->stdout];
+ $origRead = $read;
+ $write = null; // stdin not handled
+ $except = null;
+ $stdout = '';
+ $stderr = '';
+
+ stream_set_blocking($namedpipes->stdout, 0); // non-blocking
+ stream_set_blocking($namedpipes->stderr, 0);
+
+ while (stream_select($read, $write, $except, null, 20000) !== false) {
+ foreach ($read as $pipe) {
+ if ($pipe === $namedpipes->stdout) {
+ $stdout .= stream_get_contents($pipe);
+ }
+
+ if ($pipe === $namedpipes->stderr) {
+ $stderr .= stream_get_contents($pipe);
+ }
+ }
+
+ foreach ($origRead as $i => $str) {
+ if (feof($str)) {
+ unset($origRead[$i]);
+ }
+ }
+
+ if (empty($origRead)) {
+ break;
+ }
+
+ // Reset pipes
+ $read = $origRead;
+ }
+
+ fclose($namedpipes->stderr);
+ fclose($namedpipes->stdout);
+
+ $exitCode = proc_close($this->resource);
+ if ($this->exitCode === null) {
+ $this->exitCode = $exitCode;
+ }
+
+ $this->resource = null;
+
+ return (object) [
+ 'stdout' => $stdout,
+ 'stderr' => $stderr
+ ];
+ }
+}
diff --git a/module.info b/module.info
new file mode 100644
index 0000000..2002f31
--- /dev/null
+++ b/module.info
@@ -0,0 +1,3 @@
+Module: PDF Export
+Version: 0.9.0
+Description: PDF Export via Google Chrome/Chromium
diff --git a/run.php b/run.php
new file mode 100644
index 0000000..c6a479d
--- /dev/null
+++ b/run.php
@@ -0,0 +1,6 @@
+<?php
+// Icinga PDF Export | (c) 2018 Icinga GmbH | GPLv2
+
+/** @var \Icinga\Application\Modules\Module $this */
+
+$this->provideHook('Pdfexport');