feat: added seo friendly URLs for bookmarks (#2552)

Author: thorsten

nginx.conf

@@ -80,6 +80,9 @@ server {
             # a solution id page
             rewrite ^/solution_id_([0-9]+).html$ /index.php?solution_id=$1 last;
 
+            # the bookmarks page
+            rewrite ^/bookmarks.html$ /index.php?action=bookmarks last;
+
             # PMF faq record page
             # * http://[...]/content/1/1/<LANGUAGE CODE>/<FAQ TOPIC>.htm
             # * http://[...]/content/1/1/<LANGUAGE CODE>/<FAQ TOPIC>.html

phpmyfaq/.htaccess

@@ -91,6 +91,10 @@ RewriteRule ^index.html$            index.php [PT]
 RewriteCond %{REQUEST_URI}              solution_id_([0-9]+)\.html$ [NC]
 RewriteRule ^solution_id_(.*)\.html$    index.php?solution_id=$1 [L,QSA]
 
+# the bookmarks page
+RewriteCond %{REQUEST_URI}          /bookmarks\.html$ [NC]
+RewriteRule ^(.*)$                  index.php?action=bookmarks [L,QSA]
+
 # PMF faq record page
 # * http://[...]/content/1/1/<LANGUAGE CODE>/<FAQ TOPIC>.htm
 # * http://[...]/content/1/1/<LANGUAGE CODE>/<FAQ TOPIC>.html

phpmyfaq/bookmarks.php

@@ -16,16 +16,18 @@
  * @since     2023-07-20
  */
 
-use Symfony\Component\HttpFoundation\Request;
+use phpMyFAQ\Configuration;
 use phpMyFAQ\Translation;
 use phpMyFAQ\Bookmark;
+use phpMyFAQ\User\CurrentUser;
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     http_response_code(400);
     exit();
 }
 
-$request = Request::createFromGlobals();
+$faqConfig = Configuration::getConfigurationInstance();
+$user = CurrentUser::getCurrentUser($faqConfig);
 
 $bookmark = new Bookmark($faqConfig, $user);
 

phpmyfaq/faq.php

@@ -90,7 +90,7 @@
     $bookmarkAlert = $alert->success('msgBookmarkAdded');
 }
 if ($bookmarkAction === 'remove' && isset($faqId)) {
-    $bookmark->removeBookmark($faqId);
+    $bookmark->remove($faqId);
     $alert = new Alert();
     $bookmarkAlert = $alert->success('msgBookmarkRemoved');
 }
@@ -303,7 +303,7 @@
     $response->setStatusCode(Response::HTTP_NOT_FOUND);
 }
 
-// Check if author name should be visible according to GDPR option
+// Check if the author name should be visible, according to the GDPR option
 if ($user->getUserVisibilityByEmail($faq->faqRecord['email'])) {
     $author = $faq->faqRecord['author'];
 } else {
@@ -349,12 +349,23 @@
         'msgNewContentSubmit' => Translation::get('msgNewContentSubmit'),
         'csrfInput' => Token::getInstance()->getTokenInput('add-comment'),
         'captchaFieldset' =>
-            $captchaHelper->renderCaptcha($captcha, 'writecomment', Translation::get('msgCaptcha'), $user->isLoggedIn()),
+            $captchaHelper->renderCaptcha(
+                $captcha,
+                'writecomment',
+                Translation::get('msgCaptcha'),
+                $user->isLoggedIn()
+            ),
         'renderComments' => $comment->getComments($faqId, CommentType::FAQ),
         'msg_about_faq' => Translation::get('msg_about_faq'),
-        'bookmarkIcon' => ($bookmark->isFaqBookmark($faqId)===true) ? 'fa fa-bookmark' : 'fa fa-bookmark-o',
-        'bookmarkLink' => ($bookmark->isFaqBookmark($faqId)===true) ? sprintf('index.php?action=faq&bookmark_action=remove&id=%s', $faqId) : sprintf('index.php?action=faq&bookmark_action=add&id=%s', $faqId),
-        'msgAddBookmark' => ($bookmark->isFaqBookmark($faqId)===true) ? Translation::get('removeBookmark') : Translation::get('msgAddBookmark'),
+        'bookmarkIcon' => $bookmark->isFaqBookmark($faqId) ? 'fa fa-bookmark' : 'fa fa-bookmark-o',
+        'bookmarkLink' =>
+            $bookmark->isFaqBookmark($faqId)
+                ?
+                sprintf('index.php?action=faq&bookmark_action=remove&id=%d', $faqId)
+                :
+                sprintf('index.php?action=faq&bookmark_action=add&id=%d', $faqId),
+        'msgAddBookmark' =>
+            $bookmark->isFaqBookmark($faqId) ? Translation::get('removeBookmark') : Translation::get('msgAddBookmark'),
         'alert' => (isset($bookmarkAlert)) ? $bookmarkAlert : '',
     ]
 );

phpmyfaq/index.php

@@ -721,8 +721,10 @@
                 '<a class="dropdown-item" href="?action=logout&csrf=%s">%s</a>',
                 Token::getInstance()->getTokenString('logout'),
                 Translation::get('ad_menu_logout'),
-            'msgBookmarks' => sprintf('<a class="dropdown-item" href="?action=bookmarks">%s</a>',
-                Translation::get('msgBookmarks'))
+            ),
+            'msgBookmarks' => sprintf(
+                '<a class="dropdown-item" href="?action=bookmarks">%s</a>',
+                Translation::get('msgBookmarks')
             )
         ]
     );

phpmyfaq/src/phpMyFAQ/Bookmark.php

@@ -9,15 +9,15 @@
  *
  * @package   phpMyFAQ
  * @author    Jan Harms <model_railroader@gmx-topmail.de>
- * @copyright 2004-2023 phpMyFAQ Team
+ * @copyright 2023 phpMyFAQ Team
  * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
  * @link      https://www.phpmyfaq.de
  * @since     2023-07-19
  */
 
 namespace phpMyFAQ;
 
-use phpMyFAQ\Configuration;
+use phpMyFAQ\Language\Plurals;
 use phpMyFAQ\User\CurrentUser;
 
 /**
@@ -33,7 +33,7 @@ class Bookmark
      * @param Configuration $config Configuration object
      * @param CurrentUser   $user   CurrentUser object
      */
-    public function __construct(private Configuration $config, private CurrentUser $user)
+    public function __construct(private readonly Configuration $config, private readonly CurrentUser $user)
     {
     }
 
@@ -59,7 +59,7 @@ public function isFaqBookmark(int $faqId): bool
     /**
      * Saves a given Faq to the bookmark collection of the current user.
      *
-     * @param int $faqId Id of the Faq
+     * @param int $faqId ID of the Faq
      */
     public function saveFaqAsBookmarkById(int $faqId)
     {
@@ -78,7 +78,7 @@ public function saveFaqAsBookmarkById(int $faqId)
     public function getAll()
     {
         $query = sprintf(
-            'SELECT faqid FROM %sfaqbookmarks WHERE userid=%d',
+            'SELECT faqid FROM %sfaqbookmarks WHERE userid = %d',
             Database::getTablePrefix(),
             $this->user->getUserId()
         );
@@ -89,21 +89,22 @@ public function getAll()
     /**
      * Removes a bookmark from the current user.
      *
-     * @param int $faqId Id of the Faq
+     * @param int $faqId ID of the Faq
      */
-    public function removeBookmark(int $faqId)
+    public function remove(int $faqId): bool
     {
         $query = sprintf(
-            'DELETE FROM %sfaqbookmarks WHERE userid=%d AND faqid=%d',
+            'DELETE FROM %sfaqbookmarks WHERE userid = %d AND faqid = %d',
             Database::getTablePrefix(),
             $this->user->getUserId(),
             $faqId
         );
-        return $this->config->getDb()->query($query);
+
+        return (bool) $this->config->getDb()->query($query);
     }
 
     /**
-     * Renders the bookmark tree for the personally bookmark list.
+     * Renders the bookmark tree for the personal bookmark list.
      *
      * @return string
      */
@@ -122,7 +123,8 @@ public function renderBookmarkTree(): string
      */
     public function buildBookmarkList(): string
     {
-        $bookmarks = $this->getAllBookmarks();
+        $bookmarks = $this->getAll();
+        $plurals = new Plurals();
         $html = '';
         foreach ($bookmarks as $object => $key) {
             $faq = new Faq($this->config);
@@ -139,7 +141,7 @@ public function buildBookmarkList(): string
             $link->itemTitle = $faqData['title'];
             $link->tooltip = $faqData['title'];
 
-            $plurals = new Plurals();
+
             $visits = new Visits($this->config);
             foreach ($visits->getAllData() as $item) {
                 if ((string) $key->faqid === $item['id']) {

phpmyfaq/src/phpMyFAQ/Link.php

@@ -67,6 +67,7 @@ class Link
     private const LINK_GET_ACTION_SEARCH = 'search';
     private const LINK_GET_ACTION_SITEMAP = 'sitemap';
     private const LINK_GET_ACTION_SHOW = 'show';
+    private const LINK_GET_ACTION_BOOKMARKS = 'bookmarks';
     private const LINK_HTML_EXTENSION = '.html';
 
     private const LINK_HTML_ADDCONTENT = 'addcontent.html';
@@ -78,6 +79,7 @@ class Link
     private const LINK_HTML_OPEN = 'open-questions.html';
     private const LINK_HTML_SEARCH = 'search.html';
     private const LINK_HTML_SHOWCAT = 'show-categories.html';
+    private const LINK_HTML_BOOKMARKS = 'bookmarks.html';
 
     /**
      * @var int[] List of allowed action parameters
@@ -363,6 +365,10 @@ public function toString(bool $removeSessionFromUrl = false): string
                             $url .= self::LINK_HTML_LOGIN;
                             break;
 
+                        case self::LINK_GET_ACTION_BOOKMARKS:
+                            $url .= self::LINK_HTML_BOOKMARKS;
+                            break;
+
                         case self::LINK_GET_ACTION_SEARCH:
                             if (
                                 !isset($getParams[self::LINK_GET_ACTION_SEARCH])