Merge branch 'release/3.2.14' into v3

.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
 
+## 3.2.14 - 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))
+
 ## 3.2.13 - 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": "3.2.13",
+  "version": "3.2.14",
   "keywords": [
     "craftcms",
     "craft-plugin",
@@ -32,14 +32,20 @@
     "craftcms/ecs": "dev-main",
     "craftcms/phpstan": "dev-main",
     "craftcms/rector": "dev-main",
-    "codeception/codeception": "^3.0",
+    "codeception/codeception": "^4.1.29",
+    "codeception/module-asserts": "^1.3.1",
+    "codeception/module-datafactory": "^1.1.0",
+    "codeception/module-phpbrowser": "^1.0.2",
+    "codeception/module-rest": "^1.4.2",
+    "codeception/module-yii2": "^1.1.5",
     "markhuot/craftql": "^1.0.0",
     "vlucas/phpdotenv": "^3.0"
   },
   "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:v3"],
+      },
     },
     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/controllers/FileController.php

@@ -106,6 +106,7 @@ public function actionImportCsvColumns()
         if (!ini_get('auto_detect_line_endings')) {
             ini_set('auto_detect_line_endings', '1');
         }
+        $csv = null;
         $this->requirePostRequest();
         $filename = Craft::$app->getRequest()->getRequiredBodyParam('filename');
         $columns = Craft::$app->getRequest()->getRequiredBodyParam('columns');
@@ -137,7 +138,7 @@ public function actionImportCsvColumns()
         }
         $hasErrors = false;
         // If we have headers, then we have a file, so parse it
-        if ($headers !== null) {
+        if ($csv && $headers) {
             switch (VersionHelper::getLeagueCsvVersion()) {
                 case 8:
                     $hasErrors = $this->importCsvApi8($csv, $columns, $headers);

src/migrations/Install.php

@@ -14,6 +14,7 @@
 use Craft;
 use craft\db\Migration;
 use nystudio107\retour\widgets\RetourWidget;
+use yii\base\NotSupportedException;
 
 /**
  * @author    nystudio107
@@ -71,13 +72,14 @@ public function safeDown()
 
     /**
      * @return bool
+     * @throws NotSupportedException
      */
     protected function createTables(): bool
     {
         $tablesCreated = false;
 
-        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_redirects}}');
-        if ($tableSchema === null) {
+        $tableSchema = $this->getDb()->getSchema()->getTableSchema('{{%retour_redirects}}');
+        if ($tableSchema) {
             $tablesCreated = true;
             $this->createTable(
                 '{{%retour_redirects}}',
@@ -103,8 +105,8 @@ protected function createTables(): bool
             );
         }
 
-        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_static_redirects}}');
-        if ($tableSchema === null) {
+        $tableSchema = $this->getDb()->schema->getTableSchema('{{%retour_static_redirects}}');
+        if ($tableSchema) {
             $tablesCreated = true;
             $this->createTable(
                 '{{%retour_static_redirects}}',
@@ -130,8 +132,8 @@ protected function createTables(): bool
             );
         }
 
-        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_stats}}');
-        if ($tableSchema === null) {
+        $tableSchema = $this->getDb()->schema->getTableSchema('{{%retour_stats}}');
+        if ($tableSchema) {
             $tablesCreated = true;
             $this->createTable(
                 '{{%retour_stats}}',
@@ -165,70 +167,70 @@ protected function createTables(): bool
     protected function createIndexes()
     {
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_static_redirects}}',
             'redirectSrcUrlParsed',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_redirects}}',
             'redirectSrcUrlParsed',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_static_redirects}}',
             'redirectSrcUrl',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_redirects}}',
             'redirectSrcUrl',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_stats}}',
             'redirectSrcUrl',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_static_redirects}}',
             'redirectMatchType',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_redirects}}',
             'redirectMatchType',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_redirects}}',
             'siteId',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_static_redirects}}',
             'siteId',
             false
         );
 
         $this->createIndex(
-            $this->db->getIndexName(),
+            $this->getDb()->getIndexName(),
             '{{%retour_stats}}',
             'siteId',
             false
@@ -241,7 +243,7 @@ protected function createIndexes()
     protected function addForeignKeys()
     {
         $this->addForeignKey(
-            $this->db->getForeignKeyName(),
+            $this->getDb()->getForeignKeyName(),
             '{{%retour_redirects}}',
             'associatedElementId',
             '{{%elements}}',
@@ -251,7 +253,7 @@ protected function addForeignKeys()
         );
 
         $this->addForeignKey(
-            $this->db->getForeignKeyName(),
+            $this->getDb()->getForeignKeyName(),
             '{{%retour_static_redirects}}',
             'siteId',
             '{{%sites}}',
@@ -261,7 +263,7 @@ protected function addForeignKeys()
         );
 
         $this->addForeignKey(
-            $this->db->getForeignKeyName(),
+            $this->getDb()->getForeignKeyName(),
             '{{%retour_stats}}',
             'siteId',
             '{{%sites}}',

src/services/Redirects.php

@@ -25,6 +25,7 @@
 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;
@@ -706,11 +707,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)],
             ],
         ];
 
@@ -860,7 +861,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', [
@@ -1209,9 +1210,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) {

src/services/Statistics.php

@@ -16,6 +16,8 @@
 use craft\db\Query;
 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;
@@ -193,7 +195,7 @@ public function incrementStatistics(string $url, $handled = false, $siteId = nul
         // 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) {
@@ -211,7 +213,7 @@ public function incrementStatistics(string $url, $handled = false, $siteId = nul
         $stats->exceptionMessage = $exceptionMessage;
         $stats->exceptionFilePath = $exceptionFilePath;
         $stats->exceptionFileLine = (int)$exceptionFileLine;
-        $stats->hitLastTime = Db::prepareDateForDb(new \DateTime());
+        $stats->hitLastTime = Db::prepareDateForDb(new DateTime());
         $stats->handledByRetour = (int)$handled;
         $stats->hitCount++;
         $statsConfig = $stats->getAttributes();

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}'
 ];

src/web/assets/dist/manifest.json

@@ -57,9 +57,9 @@
   },
   "src/js/Retour.js": {
     "css": [
-      "assets/retour-axBeLE34.css"
+      "assets/retour-0lLzocvu.css"
     ],
-    "file": "assets/retour-GsbkZ0RI.js",
+    "file": "assets/retour-mao8V0mm.js",
     "isEntry": true,
     "src": "src/js/Retour.js"
   },