Merge branch 'release/4.1.16' into v4

.github/workflows/code-analysis.yaml

@@ -14,11 +14,9 @@ jobs:
       fail-fast: false
       matrix:
         actions:
-          -
-            name: 'PHPStan'
+          - name: 'PHPStan'
             run: composer phpstan
-          -
-            name: 'Coding Standards'
+          - name: 'Coding Standards'
             run: composer fix-cs
     name: ${{ matrix.actions.name }}
     runs-on: ubuntu-latest
@@ -33,7 +31,7 @@ jobs:
         id: setup-php
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: 8.1
           extensions: 'ctype,curl,dom,iconv,imagick,intl,json,mbstring,openssl,pcre,pdo,reflection,spl,zip'
           ini-values: post_max_size=256M, max_execution_time=180, memory_limit=512M
           tools: composer:v2

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Retour Changelog
 
+## 4.1.16 - 2024.03.25
+### Fixed
+* Added  the unused `static` to the Tailwind CSS `blocklist` to avoid a name collision with a Craft CSS class ([#1412](https://github.com/nystudio107/craft-seomatic/issues/1412))
+* Fixed an issue with impropertly text-encoded characters in URLs potentially causing a db exception ([#291](https://github.com/nystudio107/craft-retour/issues/291))
+* Fixed an issue where an empty redirect in the `excludePatterns` list could cause redirects to stop functioning, add logging when a redirect is excluded ([#297](https://github.com/nystudio107/craft-retour/issues/297))
+
 ## 4.1.15 - 2024.02.05
 ### Added
 * Add `phpstan` and `ecs` code linting

buildchain/tailwind.config.ts

@@ -4,6 +4,9 @@ export default {
     '../src/templates/**/*.{twig,html}',
     './src/vue/**/*.{vue,html}',
   ],
+  blocklist: [
+    'static',
+  ],
   theme: {},
   plugins: [],
 };

composer.json

@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-retour",
   "description": "Retour allows you to intelligently redirect legacy URLs, so that you don't lose SEO value when rebuilding & restructuring a website",
   "type": "craft-plugin",
-  "version": "4.1.15",
+  "version": "4.1.16",
   "keywords": [
     "craftcms",
     "craft-plugin",
@@ -44,7 +44,8 @@
   "scripts": {
     "phpstan": "phpstan --ansi --memory-limit=1G",
     "check-cs": "ecs check --ansi",
-    "fix-cs": "ecs check --fix --ansi"
+    "fix-cs": "ecs check --fix --ansi",
+    "test": "codecept run unit --coverage-xml"
   },
   "config": {
     "allow-plugins": {

docs/docs/.vitepress/config.ts

@@ -23,8 +23,11 @@ export default defineConfig({
     },
     algolia: {
       appId: 'PBLZ7FT9Z3',
-      apiKey: 'ab56b755c575dc94a58f7d1cae6e4e0e',
-      indexName: 'retour'
+      apiKey: '953923b236f39535b8553f4143cab98d',
+      indexName: 'retour',
+      searchParameters: {
+        facetFilters: ["version:v4"],
+      },
     },
     lastUpdatedText: 'Last Updated',
     sidebar: [

phpstan.neon

@@ -1,5 +1,5 @@
 includes:
-    - vendor/craftcms/phpstan/phpstan.neon
+    - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
 
 parameters:
     level: 5

src/services/Redirects.php

@@ -16,6 +16,7 @@
 use craft\base\ElementInterface;
 use craft\base\Plugin;
 use craft\db\Query;
+use craft\errors\ElementNotFoundException;
 use craft\errors\SiteNotFoundException;
 use craft\helpers\Db;
 use craft\helpers\StringHelper;
@@ -24,9 +25,11 @@
 use nystudio107\retour\events\RedirectResolvedEvent;
 use nystudio107\retour\events\ResolveRedirectEvent;
 use nystudio107\retour\fields\ShortLink;
+use nystudio107\retour\helpers\Text as TextHelper;
 use nystudio107\retour\helpers\UrlHelper;
 use nystudio107\retour\models\StaticRedirects as StaticRedirectsModel;
 use nystudio107\retour\Retour;
+use Throwable;
 use yii\base\ExitException;
 use yii\base\InvalidConfigException;
 use yii\base\InvalidRouteException;
@@ -272,9 +275,21 @@ public function excludeUri($uri): bool
         $uri = '/' . ltrim($uri, '/');
         if (!empty(Retour::$settings->excludePatterns)) {
             foreach (Retour::$settings->excludePatterns as $excludePattern) {
+                if (empty($excludePattern['pattern'])) {
+                    continue;
+                }
                 $pattern = '`' . $excludePattern['pattern'] . '`i';
                 try {
                     if (preg_match($pattern, $uri) === 1) {
+                        Craft::info(
+                            Craft::t(
+                                'retour',
+                                'Excluded URI: {uri} due to match of pattern: {pattern}',
+                                ['uri' => $uri, 'pathOnly' => $pattern]
+                            ),
+                            __METHOD__
+                        );
+
                         return true;
                     }
                 } catch (\Exception $e) {
@@ -303,7 +318,7 @@ public function findRedirectMatch(string $fullUrl, string $pathOnly, $siteId = n
                 $siteId = $currentSite->id;
             } else {
                 $primarySite = Craft::$app->getSites()->primarySite;
-                    $siteId = $primarySite->id;
+                $siteId = $primarySite->id;
             }
         }
         // Try getting the full URL redirect from the cache
@@ -467,11 +482,11 @@ public function getStaticRedirect(string $fullUrl, string $pathOnly, $siteId, bo
             'or',
             ['and',
                 ['redirectSrcMatch' => 'pathonly'],
-                ['redirectSrcUrlParsed' => $pathOnly],
+                ['redirectSrcUrlParsed' => TextHelper::cleanupText($pathOnly)],
             ],
             ['and',
                 ['redirectSrcMatch' => 'fullurl'],
-                ['redirectSrcUrlParsed' => $fullUrl],
+                ['redirectSrcUrlParsed' => TextHelper::cleanupText($fullUrl)],
             ],
         ];
 
@@ -565,38 +580,6 @@ public function getAllExactMatchRedirects(int $limit = null, int $siteId = null,
         return $this->getRedirectsByMatchType($limit, $siteId, 'exactmatch', $enabledOnly);
     }
 
-    /**
-     * @param int|null $limit
-     * @param int|null $siteId
-     * @param string $type
-     * @return array
-     */
-    protected function getRedirectsByMatchType(int $limit = null, int $siteId = null, string $type, bool $enabledOnly = false): array
-    {
-        // Query the db table
-        $query = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
-            ->orderBy('redirectMatchType ASC, priority ASC');
-
-        if ($siteId) {
-            $query
-                ->where(['siteId' => $siteId])
-                ->orWhere(['siteId' => null]);
-        }
-
-        if ($limit) {
-            $query->limit($limit);
-        }
-
-        $query->andWhere(['redirectMatchType' => $type]);
-
-        if ($enabledOnly) {
-            $query->andWhere(['enabled' => 1]);
-        }
-
-        return $query->all();
-    }
-
     /**
      * @param int|null $limit
      * @param int|null $siteId
@@ -996,34 +979,6 @@ public function deleteRedirectById(int $id): int
         return $result;
     }
 
-    /**
-     * Updates an associated element short link value.
-     *
-     * @param array $redirectConfig
-     * @param array $existingData
-     */
-    protected function updateAssociatedElementShortLink(array $redirectConfig, array $existingData): void
-    {
-        if (empty($redirectConfig['associatedElementId'])) {
-            return;
-        }
-        // Get the element and set the scenario
-        $associatedElement = Craft::$app->getElements()->getElementById($redirectConfig['associatedElementId']);
-
-        if (!$associatedElement) {
-            return;
-        }
-
-        $fieldUpdated = $this->setShortLinkFieldValue($associatedElement, $existingData['redirectSrcUrl'], $redirectConfig['redirectSrcUrl']);
-
-        if ($fieldUpdated) {
-            // Prevent element from triggering an infinite loop.
-            ShortLink::preventShortLinkUpdates();
-            Craft::$app->getElements()->saveElement($associatedElement);
-            ShortLink::allowShortLinkUpdates();
-        }
-    }
-
     /**
      * Save an element redirect.
      *
@@ -1100,8 +1055,8 @@ public function getRedirectsByElementId(int $elementId, int $siteId = null)
     /**
      * Delete a short link by its ID.
      *
-     * @throws \Throwable
-     * @throws \craft\errors\ElementNotFoundException
+     * @throws Throwable
+     * @throws ElementNotFoundException
      * @throws \yii\base\Exception
      */
     public function deleteShortlinkById(int $redirectId): bool
@@ -1286,7 +1241,7 @@ public function getRedirectByRedirectSrcUrl(string $redirectSrcUrl, int $siteId
         // Query the db table
         $query = (new Query())
             ->from(['{{%retour_static_redirects}}'])
-            ->where(['redirectSrcUrl' => $redirectSrcUrl]);
+            ->where(['redirectSrcUrl' => TextHelper::cleanupText($redirectSrcUrl)]);
         if ($siteId) {
             $query
                 ->andWhere(['or', [
@@ -1321,6 +1276,66 @@ public function invalidateCaches(): void
         );
     }
 
+    /**
+     * @param int|null $limit
+     * @param int|null $siteId
+     * @param string $type
+     * @return array
+     */
+    protected function getRedirectsByMatchType(int $limit = null, int $siteId = null, string $type, bool $enabledOnly = false): array
+    {
+        // Query the db table
+        $query = (new Query())
+            ->from(['{{%retour_static_redirects}}'])
+            ->orderBy('redirectMatchType ASC, priority ASC');
+
+        if ($siteId) {
+            $query
+                ->where(['siteId' => $siteId])
+                ->orWhere(['siteId' => null]);
+        }
+
+        if ($limit) {
+            $query->limit($limit);
+        }
+
+        $query->andWhere(['redirectMatchType' => $type]);
+
+        if ($enabledOnly) {
+            $query->andWhere(['enabled' => 1]);
+        }
+
+        return $query->all();
+    }
+
+    /**
+     * Updates an associated element short link value.
+     *
+     * @param array $redirectConfig
+     * @param array $existingData
+     */
+    protected function updateAssociatedElementShortLink(array $redirectConfig, array $existingData): void
+    {
+        if (empty($redirectConfig['associatedElementId'])) {
+            return;
+        }
+        // Get the element and set the scenario
+        $associatedElement = Craft::$app->getElements()->getElementById($redirectConfig['associatedElementId']);
+
+        if (!$associatedElement) {
+            return;
+        }
+
+        $fieldUpdated = $this->setShortLinkFieldValue($associatedElement, $existingData['redirectSrcUrl'], $redirectConfig['redirectSrcUrl']);
+
+        if ($fieldUpdated) {
+            // Prevent element from triggering an infinite loop.
+            ShortLink::preventShortLinkUpdates();
+            Craft::$app->getElements()->saveElement($associatedElement);
+            ShortLink::allowShortLinkUpdates();
+        }
+    }
+
     /**
      * Find all short link fields on an element that have a matching redirect source url and update the value
      *

src/services/Statistics.php

@@ -17,6 +17,7 @@
 use craft\helpers\Db;
 use craft\helpers\UrlHelper;
 use DateTime;
+use nystudio107\retour\helpers\Text as TextHelper;
 use nystudio107\retour\models\Stats as StatsModel;
 use nystudio107\retour\Retour;
 use yii\db\Exception;
@@ -194,7 +195,7 @@ public function incrementStatistics(string $url, bool $handled = false, $siteId
         // Find any existing retour_stats record
         $statsConfig = (new Query())
             ->from(['{{%retour_stats}}'])
-            ->where(['redirectSrcUrl' => $stats->redirectSrcUrl])
+            ->where(['redirectSrcUrl' => TextHelper::cleanupText($stats->redirectSrcUrl)])
             ->one();
         // If no record is found, initialize some values
         if ($statsConfig === null) {
@@ -275,28 +276,6 @@ public function saveStatistics(array $statsConfig): void
         }
     }
 
-    /**
-     * Don't trim more than a given interval, so that performance is not affected
-     *
-     * @return bool
-     */
-    protected function rateLimited(): bool
-    {
-        $limited = false;
-        $now = round(microtime(true) * 1000);
-        $cache = Craft::$app->getCache();
-        $then = $cache->get(self::LAST_STATISTICS_TRIM_CACHE_KEY);
-        if (($then !== false) && ($now - (int)$then < Retour::$settings->statisticsRateLimitMs)) {
-            $limited = true;
-        }
-        $cache->set(self::LAST_STATISTICS_TRIM_CACHE_KEY, $now, 0);
-
-        return $limited;
-    }
-
-    // Protected Methods
-    // =========================================================================
-
     /**
      * Trim the retour_stats db table based on the statsStoredLimit config.php
      * setting
@@ -364,4 +343,26 @@ public function trimStatistics(int $limit = null): int
 
         return $affectedRows;
     }
+
+    // Protected Methods
+    // =========================================================================
+
+    /**
+     * Don't trim more than a given interval, so that performance is not affected
+     *
+     * @return bool
+     */
+    protected function rateLimited(): bool
+    {
+        $limited = false;
+        $now = round(microtime(true) * 1000);
+        $cache = Craft::$app->getCache();
+        $then = $cache->get(self::LAST_STATISTICS_TRIM_CACHE_KEY);
+        if (($then !== false) && ($now - (int)$then < Retour::$settings->statisticsRateLimitMs)) {
+            $limited = true;
+        }
+        $cache->set(self::LAST_STATISTICS_TRIM_CACHE_KEY, $now, 0);
+
+        return $limited;
+    }
 }

src/translations/en/retour.php

@@ -171,4 +171,5 @@
     'Some errors occured .' => 'Some errors occured .',
     'Some errors occured importing the CSV file.' => 'Some errors occured importing the CSV file.',
     'Select the priority that will determine the order of mathching the redirect.' => 'Select the priority that will determine the order of mathching the redirect.',
+    'Excluded URI: {uri} due to match of pattern: {pattern}' => 'Excluded URI: {uri} due to match of pattern: {pattern}'
 ];