refactor: Retour now strips site path prefixes from incoming 404 URL …

…paths, such that redirects will work as expected (any Site sub-path prefix is ignored) ([#288](#288))
nystudio107 · Sep 12, 2024 · e5aadb7 · e5aadb7
1 parent 94f7165
commit e5aadb7
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 5 deletions.
diff --git a/src/helpers/UrlHelper.php b/src/helpers/UrlHelper.php
@@ -11,6 +11,7 @@
 
 namespace nystudio107\retour\helpers;
 
+use craft\errors\SiteNotFoundException;
 use craft\helpers\UrlHelper as CraftUrlHelper;
 
 /**
@@ -45,15 +46,46 @@ public static function combineQueryStringsFromUrls(...$urls): string
     }
 
     /**
-     * Merge the $url and $path together, combining any overlapping path segments
+     * Strip out any site-defined sub-path from the incoming $path
+     * e.g. if the Site's baseUrl is set to https://example.com/es and $path is /es/blog
+     * this function will return /blog
      *
-     * @param string $url
      * @param string $path
      * @return string
      */
-    public static function mergeUrlWithPath(string $url = '', string $path = ''): string
+    public static function stripSitePathPrefix($path): string
+    {
+        try {
+            $baseSiteUrl = self::baseSiteUrl();
+        } catch (SiteNotFoundException $e) {
+            $baseSiteUrl = '';
+        }
+        $sitePath = parse_url($baseSiteUrl, PHP_URL_PATH);
+        if (!empty($sitePath)) {
+            // Normalizes a URI path by trimming leading/ trailing slashes and removing double slashes
+            $sitePath = '/' . preg_replace('/\/\/+/', '/', trim($sitePath, '/'));
+        }
+        // Strip the $sitePath from the incoming $path
+        if (str_starts_with($path, $sitePath)) {
+            $path = substr($path, strlen($sitePath));
+            $path = '/' . preg_replace('/\/\/+/', '/', trim($path, '/'));
+        }
+
+        return $path;
+    }
+
+    /**
+     * Merge the $url and $path together, combining any overlapping path segments
+     *
+     * @param ?string $url
+     * @param ?string $path
+     * @return string
+     */
+    public static function mergeUrlWithPath($url, $path): string
     {
         $overlap = 0;
+        $url = $url ?? '';
+        $path = $path ?? '';
         $urlOffset = strlen($url);
         $pathLength = strlen($path);
         $pathOffset = 0;

diff --git a/src/services/Redirects.php b/src/services/Redirects.php
@@ -220,13 +220,15 @@ public function handle404()
                 $pathOnly = '';
                 $fullUrl = '';
             }
+            // Stash the $pathOnly for use when incrementing the statistics
+            $originalPathOnly = $pathOnly;
+            // Strip out any site-defined baseUrl path prefixes
+            $pathOnly = UrlHelper::stripSitePathPrefix($pathOnly);
             // Strip the query string if `alwaysStripQueryString` is set
             if (Retour::$settings->alwaysStripQueryString) {
                 $fullUrl = UrlHelper::stripQueryString($fullUrl);
                 $pathOnly = UrlHelper::stripQueryString($pathOnly);
             }
-            // Stash the $pathOnly for use when incrementing the statistics
-            $originalPathOnly = $pathOnly;
             Craft::info(
                 Craft::t(
                     'retour',