Merge branch 'release/3.5.10' into v3

CHANGELOG.md

@@ -1,5 +1,10 @@
 # SEOmatic Changelog
 
+## 3.5.10 - 2025.01.08
+### Changed
+* Encode the URI in the `canonical` `link` header ([#1519](https://github.com/nystudio107/craft-seomatic/issues/1519))
+* Ensure that URLs that are a site index URL and have a path prefix strip trailing slashes as appropriate ([#717](https://github.com/nystudio107/craft-seomatic/issues/717)) ([#5675](https://github.com/craftcms/cms/issues/5675))
+
 ## 3.5.9 - 2024.12.21
 ### Changed
 * If an incoming URL has a trailing slash, preserve it for things like the Canonical URL ([#1547](https://github.com/nystudio107/craft-seomatic/issues/1547))

buildchain/Dockerfile

@@ -1,7 +1,7 @@
 ARG TAG=20-alpine
 FROM node:$TAG
 
-RUN npm install -g npm@^10.0.0
+RUN npm install -g npm@^11.0.0
 
 WORKDIR /app/buildchain/
 

composer.json

@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-seomatic",
   "description": "SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 3. It is a turnkey SEO system that is comprehensive, powerful, and flexible.",
   "type": "craft-plugin",
-  "version": "3.5.9",
+  "version": "3.5.10",
   "keywords": [
     "craft",
     "cms",

docs/Dockerfile

@@ -1,7 +1,7 @@
 ARG TAG=20-alpine
 FROM node:$TAG
 
-RUN npm install -g npm@^10.0.0
+RUN npm install -g npm@^11.0.0
 
 WORKDIR /app/
 

src/helpers/DynamicMeta.php

@@ -189,10 +189,12 @@ public static function includeHttpHeaders()
                     if (is_array($href)) {
                         $headerValue = '';
                         foreach ($href as $hrefVal) {
+                            $hrefVal = UrlHelper::encodeUrl($hrefVal);
                             $headerValue .= ('<' . $hrefVal . '>' . ',');
                         }
                         $headerValue = rtrim($headerValue, ',');
                     } else {
+                        $href = UrlHelper::encodeUrl($href);
                         $headerValue = '<' . $href . '>';
                     }
                     $headerValue .= "; rel='canonical'";

src/helpers/UrlHelper.php

@@ -160,7 +160,7 @@ public static function absoluteUrlWithProtocol($url): string
         if ($generalConfig->addTrailingSlashesToUrls && !preg_match('/(.+\?.*)|(\.[^\/]+$)/', $url)) {
             $url = rtrim($url, '/') . '/';
         }
-        if (!$generalConfig->addTrailingSlashesToUrls && !$preserveTrailingSlash) {
+        if (!$generalConfig->addTrailingSlashesToUrls && (!$preserveTrailingSlash || self::urlIsSiteIndex($url))) {
             $url = rtrim($url, '/');
         }
 
@@ -219,6 +219,34 @@ public static function urlHasSubDir(string $url): bool
         return !empty(parse_url(trim($url, '/'), PHP_URL_PATH));
     }
 
+    /**
+     * See if the url is a site index, and if so, strip the trailing slash
+     * ref: https://github.com/craftcms/cms/issues/5675
+     *
+     * @param string $url
+     * @return bool
+     */
+    public static function urlIsSiteIndex(string $url): bool
+    {
+        $sites = Craft::$app->getSites()->getAllSites();
+        $result = false;
+        foreach ($sites as $site) {
+            $sitePath = parse_url(self::siteUrl('/', null, null, $site->id), PHP_URL_PATH);
+            if (!empty($sitePath)) {
+                // Normalizes a URI path by trimming leading/ trailing slashes and removing double slashes
+                $sitePath = '/' . preg_replace('/\/\/+/', '/', trim($sitePath, '/'));
+            }
+            // Normalizes a URI path by trimming leading/ trailing slashes and removing double slashes
+            $url = '/' . preg_replace('/\/\/+/', '/', trim($url, '/'));
+            // See if this url ends with a site prefix, and thus is a site index
+            if (str_ends_with($url, $sitePath)) {
+                $result = true;
+            }
+        }
+
+        return $result;
+    }
+
     /**
      * Return the siteUrlOverride setting, which can be a string or an array of site URLs
      * indexed by the site handle
@@ -250,6 +278,27 @@ public static function getSiteUrlOverrideSetting(?int $siteId = null): string
         }
     }
 
+    /**
+     * Encodes non-alphanumeric characters in a URL, except reserved characters and already-encoded characters.
+     *
+     * @param string $url
+     * @return string
+     * @since 4.13.0
+     */
+    public static function encodeUrl(string $url): string
+    {
+        $parts = preg_split('/([:\/?#\[\]@!$&\'()*+,;=%])/', $url, flags: PREG_SPLIT_DELIM_CAPTURE);
+        $url = '';
+        foreach ($parts as $i => $part) {
+            if ($i % 2 === 0) {
+                $url .= urlencode($part);
+            } else {
+                $url .= $part;
+            }
+        }
+        return $url;
+    }
+
     // Protected Methods
     // =========================================================================