Merge pull request #6485 from WoltLab/6.2-list-view-canonical-url

Set `canonicalURL` in `AbstractListViewPage`

Author: BurntimeX

wcfsetup/install/files/lib/page/AbstractGridViewPage.class.php

@@ -6,6 +6,7 @@
 use wcf\system\request\LinkHandler;
 use wcf\system\gridView\AbstractGridView;
 use wcf\system\WCF;
+use wcf\util\StringUtil;
 
 /**
  * Abstract implementation of a page that is rendering a grid view.
@@ -49,6 +50,8 @@ public function readParameters()
         if (isset($_REQUEST['filters']) && \is_array($_REQUEST['filters'])) {
             $this->filters = $_REQUEST['filters'];
         }
+
+        $this->canonicalURL = $this->getCanonicalUrl();
     }
 
     #[\Override]
@@ -66,6 +69,7 @@ public function assignVariables()
 
         WCF::getTPL()->assign([
             'gridView' => $this->gridView,
+            'headContent' => $this->getHeadContent(),
         ]);
     }
 
@@ -88,7 +92,65 @@ protected function initGridView(): void
         if ($this->pageNo != 1) {
             $this->gridView->setPageNo($this->pageNo);
         }
-        $this->gridView->setBaseUrl(LinkHandler::getInstance()->getControllerLink(static::class));
+        $this->gridView->setBaseUrl(
+            LinkHandler::getInstance()->getControllerLink(static::class, $this->getBaseUrlParameters())
+        );
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function getBaseUrlParameters(): array
+    {
+        return [];
+    }
+
+    protected function getHeadContent(): string
+    {
+        $linkTags = [];
+        if ($this->gridView->getPageNo() < $this->gridView->countPages()) {
+            $linkTags[] = \sprintf(
+                '<link rel="next" href="%s">',
+                StringUtil::encodeHTML(
+                    LinkHandler::getInstance()->getControllerLink(static::class, \array_merge(
+                        $this->getBaseUrlParameters(),
+                        [
+                            'pageNo' => $this->gridView->getPageNo() + 1,
+                            'sortField' => $this->sortField ?: null,
+                            'sortOrder' => $this->sortOrder ?: null,
+                        ]
+                    ))
+                )
+            );
+        }
+
+        if ($this->gridView->getPageNo() > 1) {
+            $linkTags[] = \sprintf(
+                '<link rel="prev" href="%s">',
+                StringUtil::encodeHTML(
+                    LinkHandler::getInstance()->getControllerLink(static::class, \array_merge(
+                        $this->getBaseUrlParameters(),
+                        [
+                            'pageNo' => $this->gridView->getPageNo() !== 2 ? $this->gridView->getPageNo() - 1 : null,
+                            'sortField' => $this->sortField ?: null,
+                            'sortOrder' => $this->sortOrder ?: null,
+                        ]
+                    ))
+                )
+            );
+        }
+
+        return \implode("\n", $linkTags);
+    }
+
+    protected function getCanonicalUrl(): string
+    {
+        return LinkHandler::getInstance()->getControllerLink(static::class, \array_merge(
+            $this->getBaseUrlParameters(),
+            [
+                'pageNo' => $this->pageNo !== 1 ? $this->pageNo : null,
+            ]
+        ));
     }
 
     /**

wcfsetup/install/files/lib/page/AbstractListViewPage.class.php

@@ -51,6 +51,8 @@ public function readParameters()
         if (isset($_REQUEST['filters']) && \is_array($_REQUEST['filters'])) {
             $this->filters = $_REQUEST['filters'];
         }
+
+        $this->canonicalURL = $this->getCanonicalUrl();
     }
 
     #[\Override]
@@ -139,21 +141,19 @@ protected function getHeadContent(): string
             );
         }
 
-        $linkTags[] = \sprintf(
-            '<link rel="canonical" href="%s">',
-            StringUtil::encodeHTML(
-                LinkHandler::getInstance()->getControllerLink(static::class, \array_merge(
-                    $this->getBaseUrlParameters(),
-                    [
-                        'pageNo' => $this->listView->getPageNo() !== 1 ? $this->listView->getPageNo() : null,
-                    ]
-                ))
-            )
-        );
-
         return \implode("\n", $linkTags);
     }
 
+    protected function getCanonicalUrl(): string
+    {
+        return LinkHandler::getInstance()->getControllerLink(static::class, \array_merge(
+            $this->getBaseUrlParameters(),
+            [
+                'pageNo' => $this->pageNo !== 1 ? $this->pageNo : null,
+            ]
+        ));
+    }
+
     /**
      * Returns the list view instance for the rendering of this page.
      *