PDF: Added implmentation of command PDF option

Tested quickly manually but not yet covered by PHPUnit tests.

diff --git a/app/Entities/Tools/PdfGenerator.php b/app/Entities/Tools/PdfGenerator.php
index e187b9ab2c4e50d892c40de70588c54586082939..4f23ad334ec58513e4a1779d0fe45247403e08d5 100644 (file)
--- a/app/Entities/Tools/PdfGenerator.php
+++ b/app/Entities/Tools/PdfGenerator.php
@@ -2,8 +2,10 @@
 
 namespace BookStack\Entities\Tools;
 
 
 namespace BookStack\Entities\Tools;
 

+use BookStack\Exceptions\PdfExportException;

 use Knp\Snappy\Pdf as SnappyPdf;
 use Dompdf\Dompdf;
 use Knp\Snappy\Pdf as SnappyPdf;
 use Dompdf\Dompdf;

+use Symfony\Component\Process\Process;

 
 class PdfGenerator
 {
 
 class PdfGenerator
 {


@@ -13,19 +15,15 @@ class PdfGenerator
 
     /**
      * Generate PDF content from the given HTML content.
 
     /**
      * Generate PDF content from the given HTML content.

+     * @throws PdfExportException

      */
     public function fromHtml(string $html): string
     {
      */
     public function fromHtml(string $html): string
     {

-        $engine = $this->getActiveEngine();
-
-        if ($engine === self::ENGINE_WKHTML) {
-            return $this->renderUsingWkhtml($html);
-        } else if ($engine === self::ENGINE_COMMAND) {
-            // TODO - Support PDF command
-            return '';
-        }
-
-        return $this->renderUsingDomPdf($html);
+        return match ($this->getActiveEngine()) {
+            self::ENGINE_COMMAND => $this->renderUsingCommand($html),
+            self::ENGINE_WKHTML => $this->renderUsingWkhtml($html),
+            default => $this->renderUsingDomPdf($html)
+        };

     }
 
     /**
     }
 
     /**


@@ -34,6 +32,10 @@ class PdfGenerator
      */
     public function getActiveEngine(): string
     {
      */
     public function getActiveEngine(): string
     {

+        if (config('exports.pdf_command')) {
+            return self::ENGINE_COMMAND;
+        }
+

         if ($this->getWkhtmlBinaryPath() && config('app.allow_untrusted_server_fetching') === true) {
             return self::ENGINE_WKHTML;
         }
         if ($this->getWkhtmlBinaryPath() && config('app.allow_untrusted_server_fetching') === true) {
             return self::ENGINE_WKHTML;
         }


@@ -63,6 +65,46 @@ class PdfGenerator
         return (string) $domPdf->output();
     }
 
         return (string) $domPdf->output();
     }
 

+    /**
+     * @throws PdfExportException
+     */
+    protected function renderUsingCommand(string $html): string
+    {
+        $command = config('exports.pdf_command');
+        $inputHtml = tempnam(sys_get_temp_dir(), 'bs-pdfgen-html-');
+        $outputPdf = tempnam(sys_get_temp_dir(), 'bs-pdfgen-output-');
+
+        $replacementsByPlaceholder = [
+            '{input_html_path}' => $inputHtml,
+            '{output_html_path}' => $outputPdf,
+        ];
+
+        foreach ($replacementsByPlaceholder as $placeholder => $replacement) {
+            $command = str_replace($placeholder, escapeshellarg($replacement), $command);
+        }
+
+        file_put_contents($inputHtml, $html);
+
+        $process = Process::fromShellCommandline($command);
+        $process->setTimeout(15);
+        $process->run();
+
+        if (!$process->isSuccessful()) {
+            throw new PdfExportException("PDF Export via command failed with exit code {$process->getExitCode()}, stdout: {$process->getOutput()}, stderr: {$process->getErrorOutput()}");
+        }
+
+        $pdfContents = file_get_contents($outputPdf);
+        unlink($outputPdf);
+
+        if ($pdfContents === false) {
+            throw new PdfExportException("PDF Export via command failed, unable to read PDF output file");
+        } else if (empty($pdfContents)) {
+            throw new PdfExportException("PDF Export via command failed, PDF output file is empty");
+        }
+
+        return $pdfContents;
+    }
+

     protected function renderUsingWkhtml(string $html): string
     {
         $snappy = new SnappyPdf($this->getWkhtmlBinaryPath());
     protected function renderUsingWkhtml(string $html): string
     {
         $snappy = new SnappyPdf($this->getWkhtmlBinaryPath());

diff --git a/app/Exceptions/PdfExportException.php b/app/Exceptions/PdfExportException.php
new file mode 100644 (file)
index 0000000..beeda81
--- /dev/null
+++ b/app/Exceptions/PdfExportException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace BookStack\Exceptions;
+
+class PdfExportException extends \Exception
+{
+}

diff --git a/phpunit.xml b/phpunit.xml
index a9e97f0c78a56cc33902eebf0d56972bbaeb7635..21f17685b5b63aacd448fcbfa898ca9d16b6ffaa 100644 (file)
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -51,6 +51,7 @@
     <server name="LOG_FAILED_LOGIN_MESSAGE" value=""/>
     <server name="LOG_FAILED_LOGIN_CHANNEL" value="testing"/>
     <server name="WKHTMLTOPDF" value="false"/>
     <server name="LOG_FAILED_LOGIN_MESSAGE" value=""/>
     <server name="LOG_FAILED_LOGIN_CHANNEL" value="testing"/>
     <server name="WKHTMLTOPDF" value="false"/>

+    <server name="EXPORT_PDF_COMMAND" value="false"/>

     <server name="APP_DEFAULT_DARK_MODE" value="false"/>
     <server name="IP_ADDRESS_PRECISION" value="4"/>
   </php>
     <server name="APP_DEFAULT_DARK_MODE" value="false"/>
     <server name="IP_ADDRESS_PRECISION" value="4"/>
   </php>