feat: removed configuration for enabling rewrite rules

thorsten · Jul 29, 2023 · bb85ab7 · bb85ab7
1 parent d209bce
commit bb85ab7
Show file tree

Hide file tree

Showing 35 changed files with 202 additions and 382 deletions.
diff --git a/phpmyfaq/index.php b/phpmyfaq/index.php
@@ -603,78 +603,40 @@
     );
 }
 
-if ($faqConfig->get('main.enableRewriteRules')) {
-    $tplNavigation = [
-        'backToHome' => '<a class="nav-link" href="./index.html">' . Translation::get('msgHome') . '</a>',
-        'allCategories' => '<a class="nav-link px-2 text-white" href="./show-categories.html">' .
-            Translation::get('msgShowAllCategories') . '</a>',
-        'msgAddContent' => '<a class="nav-link px-2 text-white" href="./addcontent.html">' .
-            Translation::get('msgAddContent') . '</a>',
-        'msgQuestion' => $faqConfig->get('main.enableAskQuestions')
-            ?
-            '<a class="nav-link px-2 text-white" href="./ask.html">' . Translation::get('msgQuestion') . '</a>'
-            :
-            '',
-        'msgOpenQuestions' => $faqConfig->get('main.enableAskQuestions')
-            ?
-            '<a class="nav-link px-2 text-white" href="./open-questions.html">' .
-            Translation::get('msgOpenQuestions') . '</a>'
-            :
-            '',
-        'msgSearch' => '<a class="nav-link" href="./search.html">' . Translation::get('msgAdvancedSearch') . '</a>',
-        'msgContact' => '<a class="nav-link px-2 link-light" href="./contact.html">' . Translation::get('msgContact') .
-            '</a>',
-        'msgGlossary' => '<a class="nav-link px-2 link-light" href="./glossary.html">' .
-            Translation::get('ad_menu_glossary') . '</a>',
-        'privacyLink' => sprintf(
-            '<a class="nav-link px-2 link-light" target="_blank" href="%s">%s</a>',
-            Strings::htmlentities($faqConfig->get('main.privacyURL')),
-            Translation::get('msgPrivacyNote')
-        ),
-        'faqOverview' => '<a class="nav-link px-2 link-light" href="./overview.html">' .
-            Translation::get('faqOverview') . '</a>',
-        'showSitemap' => '<a class="nav-link px-2 link-light" href="./sitemap/A/' . $faqLangCode . '.html">' .
-            Translation::get('msgSitemap') . '</a>',
-        'breadcrumbHome' => '<a href="./index.html">' . Translation::get('msgHome') . '</a>',
-    ];
-} else {
-    $tplNavigation = [
-        'backToHome' => '<a href="index.php?' . $sids . '">' . Translation::get('msgHome') . '</a>',
-        'allCategories' => '<a class="nav-link" href="index.php?' . $sids . 'action=show">' .
-            Translation::get('msgShowAllCategories') . '</a>',
-        'msgAddContent' => '<a class="nav-link" href="index.php?' . $sids . 'action=add&cat=' . $cat . '">' .
-            Translation::get('msgAddContent') . '</a>',
-        'msgQuestion' => $faqConfig->get('main.enableAskQuestions')
-            ?
-            '<a class="nav-link" href="index.php?' . $sids . 'action=ask&category_id=' . $cat . '">' .
-            Translation::get('msgQuestion') . '</a>'
-            :
-            '',
-        'msgOpenQuestions' => $faqConfig->get('main.enableAskQuestions')
-            ?
-            '<a class="nav-link" href="index.php?' . $sids . 'action=open-questions">' .
-            Translation::get('msgOpenQuestions') . '</a>'
-            :
-            '',
-        'msgSearch' => '<a class="nav-link" href="index.php?' . $sids . 'action=search">' .
-            Translation::get('msgAdvancedSearch') . '</a>',
-        'msgContact' => '<a class="nav-link px-2 link-light" href="index.php?' . $sids . 'action=contact">' .
-            Translation::get('msgContact') . '</a>',
-        'msgGlossary' => '<a class="nav-link px-2 link-light" href="index.php?' . $sids . 'action=glossary">' .
-            Translation::get('ad_menu_glossary') . '</a>',
-        'privacyLink' => sprintf(
-            '<a class="nav-link px-2 link-light" target="_blank" href="%s">%s</a>',
-            Strings::htmlentities($faqConfig->get('main.privacyURL')),
-            Translation::get('msgPrivacyNote')
-        ),
-        'faqOverview' => '<a class="nav-link px-2 link-light" href="index.php?' . $sids . 'action=overview">' .
-            Translation::get('faqOverview') . '</a>',
-        'showSitemap' => '<a class="nav-link px-2 link-light" href="index.php?' . $sids . 'action=sitemap&amp;lang=' .
-            $faqLangCode . '">' .
-            Translation::get('msgSitemap') . '</a>',
-        'breadcrumbHome' => '<a href="index.php?' . $sids . '">' . Translation::get('msgHome') . '</a>',
-    ];
-}
+$tplNavigation = [
+    'backToHome' => '<a class="nav-link" href="./index.html">' . Translation::get('msgHome') . '</a>',
+    'allCategories' => '<a class="nav-link px-2 text-white" href="./show-categories.html">' .
+        Translation::get('msgShowAllCategories') . '</a>',
+    'msgAddContent' => '<a class="nav-link px-2 text-white" href="./addcontent.html">' .
+        Translation::get('msgAddContent') . '</a>',
+    'msgQuestion' => $faqConfig->get('main.enableAskQuestions')
+        ?
+        '<a class="nav-link px-2 text-white" href="./ask.html">' . Translation::get('msgQuestion') . '</a>'
+        :
+        '',
+    'msgOpenQuestions' => $faqConfig->get('main.enableAskQuestions')
+        ?
+        '<a class="nav-link px-2 text-white" href="./open-questions.html">' .
+        Translation::get('msgOpenQuestions') . '</a>'
+        :
+        '',
+    'msgSearch' => '<a class="nav-link" href="./search.html">' . Translation::get('msgAdvancedSearch') . '</a>',
+    'msgContact' => '<a class="nav-link px-2 link-light" href="./contact.html">' . Translation::get('msgContact') .
+        '</a>',
+    'msgGlossary' => '<a class="nav-link px-2 link-light" href="./glossary.html">' .
+        Translation::get('ad_menu_glossary') . '</a>',
+    'privacyLink' => sprintf(
+        '<a class="nav-link px-2 link-light" target="_blank" href="%s">%s</a>',
+        Strings::htmlentities($faqConfig->get('main.privacyURL')),
+        Translation::get('msgPrivacyNote')
+    ),
+    'faqOverview' => '<a class="nav-link px-2 link-light" href="./overview.html">' .
+        Translation::get('faqOverview') . '</a>',
+    'showSitemap' => '<a class="nav-link px-2 link-light" href="./sitemap/A/' . $faqLangCode . '.html">' .
+        Translation::get('msgSitemap') . '</a>',
+    'breadcrumbHome' => '<a href="./index.html">' . Translation::get('msgHome') . '</a>',
+];
+
 
 $tplNavigation['faqHome'] = Strings::htmlentities($faqConfig->getDefaultUrl());
 $tplNavigation['activeSearch'] = ('search' == $action) ? 'active' : '';

diff --git a/phpmyfaq/search.php b/phpmyfaq/search.php
@@ -202,11 +202,7 @@
     ) && $faqConfig->get('search.searchForSolutionId')
 ) {
     $response = new Response();
-    if ($faqConfig->get('main.enableRewriteRules')) {
-        $response->isRedirect($faqConfig->getDefaultUrl() . 'solution_id_' . $inputSearchTerm . '.html');
-    } else {
-        $response->isRedirect($faqConfig->getDefaultUrl() . 'index.php?solution_id=' . $inputSearchTerm);
-    }
+    $response->isRedirect($faqConfig->getDefaultUrl() . 'solution_id_' . $inputSearchTerm . '.html');
     $response->send();
     exit();
 }
@@ -216,26 +212,14 @@
 $mostPopularSearchData = $faqSearch->getMostPopularSearches($faqConfig->get('search.numberSearchTerms'));
 
 // Set base URL scheme
-if ($faqConfig->get('main.enableRewriteRules')) {
-    $baseUrl = sprintf(
-        '%ssearch.html?search=%s&amp;seite=%d%s&amp;pmf-search-category=%d',
-        $faqConfig->getDefaultUrl(),
-        urlencode($inputSearchTerm),
-        $page,
-        $languages,
-        $inputCategory
-    );
-} else {
-    $baseUrl = sprintf(
-        '%s?%saction=search&amp;search=%s&amp;seite=%d%s&amp;pmf-search-category=%d',
-        $faqConfig->getDefaultUrl(),
-        empty($sids) ? '' : 'sids=' . $sids . '&amp;',
-        urlencode($inputSearchTerm),
-        $page,
-        $languages,
-        $inputCategory
-    );
-}
+$baseUrl = sprintf(
+    '%ssearch.html?search=%s&amp;seite=%d%s&amp;pmf-search-category=%d',
+    $faqConfig->getDefaultUrl(),
+    urlencode($inputSearchTerm),
+    $page,
+    $languages,
+    $inputCategory
+);
 
 // Pagination options
 $options = [

diff --git a/phpmyfaq/setup/migrations.php b/phpmyfaq/setup/migrations.php
@@ -187,6 +187,9 @@
     $faqConfig->add('upgrade.releaseEnvironment', 'development');
     $faqConfig->add('upgrade.dateLastChecked', '');
 
+    // Rewrite rules are now mandatory
+    $faqConfig->delete('main.enableRewriteRules');
+
     // Bookmarks support
     $query[] = match ($dbConfig->getType()) {
         'mysqli' => 'CREATE TABLE ' . $prefix . 'faqbookmarks (

diff --git a/phpmyfaq/src/phpMyFAQ/Api/Controller/AutoCompleteController.php b/phpmyfaq/src/phpMyFAQ/Api/Controller/AutoCompleteController.php
@@ -29,9 +29,11 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 class AutoCompleteController
 {
+    #[Route('api/autocomplete')]
     public function search(Request $request): JsonResponse
     {
         $response = new JsonResponse();

diff --git a/phpmyfaq/src/phpMyFAQ/Core/Controller.php b/phpmyfaq/src/phpMyFAQ/Core/Controller.php
diff --git a/phpmyfaq/src/phpMyFAQ/Faq.php b/phpmyfaq/src/phpMyFAQ/Faq.php
@@ -471,20 +471,15 @@ public function renderRecordsByCategoryId(int $categoryId, string $orderBy = 'id
         }
 
         if ($pages > 1) {
-            // Set rewrite URL, if needed
-            if ($this->config->get('main.enableRewriteRules')) {
-                $link = new Link($this->config->getDefaultUrl(), $this->config);
-                $useRewrite = true;
-                $rewriteUrl = sprintf(
-                    '%scategory/%d/%%d/%s.html',
-                    $this->config->getDefaultUrl(),
-                    $categoryId,
-                    $link->getSEOItemTitle($title)
-                );
-            } else {
-                $useRewrite = false;
-                $rewriteUrl = '';
-            }
+            $link = new Link($this->config->getDefaultUrl(), $this->config);
+            $useRewrite = true;
+            $rewriteUrl = sprintf(
+                '%scategory/%d/%%d/%s.html',
+                $this->config->getDefaultUrl(),
+                $categoryId,
+                $link->getSEOItemTitle($title)
+            );
+
             $baseUrl = sprintf(
                 '%sindex.php?%saction=show&amp;cat=%d&amp;seite=%d',
                 $this->config->getDefaultUrl(),