refactor: migrated PDF export (#3834)

Author: thorsten

phpmyfaq/pdf.php

@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * PDF Controller
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * @package   phpMyFAQ
+ * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
+ * @author    Peter Beauvain <pbeauvain@web.de>
+ * @author    Olivier Plathey <olivier@fpdf.org>
+ * @author    Krzysztof Kruszynski <thywolf@wolf.homelinux.net>
+ * @author    Matteo Scaramuccia <matteo@phpmyfaq.de>
+ * @copyright 2003-2026 phpMyFAQ Team
+ * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ * @link      https://www.phpmyfaq.de
+ * @since     2003-02-12
+ */
+
+namespace phpMyFAQ\Controller\Frontend;
+
+use DateTime;
+use League\CommonMark\Exception\CommonMarkException;
+use phpMyFAQ\Attachment\AttachmentException;
+use phpMyFAQ\Attachment\AttachmentFactory;
+use phpMyFAQ\Category;
+use phpMyFAQ\Core\Exception;
+use phpMyFAQ\Export\Pdf;
+use phpMyFAQ\Filter;
+use phpMyFAQ\Helper\AttachmentHelper;
+use phpMyFAQ\User\CurrentUser;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+final class PdfController extends AbstractFrontController
+{
+    /**
+     * @throws Exception|\Exception|CommonMarkException
+     */
+    #[Route(path: '/pdf/{categoryId}/{faqId}/{faqLanguage}', name: 'public.pdf.faq')]
+    public function index(Request $request): Response
+    {
+        $categoryId = Filter::filterVar($request->attributes->get('categoryId'), FILTER_VALIDATE_INT);
+        $faqId = Filter::filterVar($request->attributes->get('faqId'), FILTER_VALIDATE_INT);
+        $faqLanguage = Filter::filterVar($request->attributes->get('faqLanguage'), FILTER_SANITIZE_SPECIAL_CHARS);
+
+        if ($categoryId === false || $categoryId === null || $faqId === false || $faqId === null) {
+            return new RedirectResponse($this->configuration->getDefaultUrl());
+        }
+
+        [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
+
+        $faq = $this->container->get('phpmyfaq.faq');
+        $faq->setUser($currentUser);
+        $faq->setGroups($currentGroups);
+
+        $category = new Category($this->configuration, $currentGroups, true);
+        $category->setUser($currentUser);
+
+        $tags = $this->container->get('phpmyfaq.tags');
+        $tags->setUser($currentUser)->setGroups($currentGroups);
+
+        $pdf = new Pdf($faq, $category, $this->configuration);
+
+        $faq->getFaq($faqId);
+        $faq->faqRecord['category_id'] = $categoryId;
+
+        if (!$this->configuration->get('records.disableAttachments') && 'yes' === $faq->faqRecord['active']) {
+            try {
+                $attachmentHelper = new AttachmentHelper();
+                $attList = AttachmentFactory::fetchByRecordId($this->configuration, $faqId);
+                $faq->faqRecord['attachmentList'] = $attachmentHelper->getAttachmentList($attList);
+            } catch (AttachmentException) {
+                $faq->faqRecord['attachmentList'] = '';
+            }
+        }
+
+        $filename = 'FAQ-' . $faqId . '-' . $faqLanguage . '.pdf';
+        $pdfFile = $pdf->generateFile($faq->faqRecord, $filename);
+
+        $response = new Response();
+        $response->setExpires(new DateTime());
+        $response->headers->set('Content-Type', 'application/pdf');
+        $response->setContent($pdfFile);
+
+        return $response;
+    }
+}

phpmyfaq/src/phpMyFAQ/Controller/Frontend/PdfController.php

@@ -100,7 +100,7 @@ public function setQuestion(string $question): void
     public function getPdfLink(): string
     {
         return sprintf(
-            '%spdf.php?cat=%d&id=%d&artlang=%s',
+            '%spdf/%d/%d/%s',
             $this->configuration->getDefaultUrl(),
             $this->getCategoryId(),
             $this->getFaqId(),
@@ -114,7 +114,7 @@ public function getPdfLink(): string
     public function getPdfApiLink(): string
     {
         return sprintf(
-            '%spdf.php?cat=%d&id=%d&artlang=%s',
+            '%spdf/%d/%d/%s',
             $this->configuration->getDefaultUrl(),
             $this->getCategoryId(),
             $this->getFaqId(),

phpmyfaq/src/phpMyFAQ/Services.php

@@ -21,7 +21,7 @@
 use phpMyFAQ\Controller\Frontend\AttachmentController;use phpMyFAQ\Controller\Frontend\ContactController;
 use phpMyFAQ\Controller\Frontend\GlossaryController;use phpMyFAQ\Controller\Frontend\LoginController;use phpMyFAQ\Controller\Frontend\OverviewController;
 use phpMyFAQ\Controller\Frontend\PageNotFoundController;
-use phpMyFAQ\Controller\Frontend\SitemapController as FrontendSitemapController;
+use phpMyFAQ\Controller\Frontend\PdfController;use phpMyFAQ\Controller\Frontend\SitemapController as FrontendSitemapController;
 use phpMyFAQ\Controller\Frontend\WebAuthnController;
 use phpMyFAQ\Controller\LlmsController;
 use phpMyFAQ\Controller\RobotsController;
@@ -62,6 +62,11 @@
         'controller' => [OverviewController::class, 'index'],
         'methods' => 'GET',
     ],
+    'public.pdf.faq' => [
+        'path' => '/pdf/{categoryId}/{faqId}/{faqLanguage}',
+        'controller' => [PdfController::class, 'index'],
+        'methods' => 'GET',
+    ],
     'public.sitemap' => [
         'path' => '/sitemap/{letter}/{language}.html',
         'controller' => [FrontendSitemapController::class, 'index'],

phpmyfaq/src/public-routes.php

@@ -34,7 +34,7 @@ public function testGetPdfLink(): void
         $services->setLanguage('en');
 
         // Test getPdfLink method
-        $expected = 'http://example.com/pdf.php?cat=1&id=123&artlang=en';
+        $expected = 'http://example.com/pdf/1/123/en';
         $this->assertEquals($expected, $services->getPdfLink());
     }
 
@@ -51,7 +51,7 @@ public function testGetPdfApiLink(): void
         $services->setLanguage('en');
 
         // Test getPdfApiLink method
-        $expected = 'http://example.com/pdf.php?cat=1&id=123&artlang=en';
+        $expected = 'http://example.com/pdf/1/123/en';
         $this->assertEquals($expected, $services->getPdfApiLink());
     }
 }