Merge branch 'feature/keep_querystring' into develop

vdlp · Nov 30, 2023 · 913a4d5 · 913a4d5
2 parents 3c81f7c + 1588474
commit 913a4d5
Show file tree

Hide file tree

Showing 14 changed files with 81 additions and 0 deletions.
diff --git a/classes/PublishManager.php b/classes/PublishManager.php
@@ -40,6 +40,7 @@ public function publish(): int
             'ignore_query_parameters',
             'ignore_case',
             'ignore_trailing_slash',
+            'keep_querystring',
         ];
 
         /** @var Collection $redirects */

diff --git a/classes/RedirectManager.php b/classes/RedirectManager.php
@@ -175,6 +175,14 @@ public function redirectWithRule(RedirectRule $rule, string $requestUri): void
             return;
         }
 
+        if ($rule->isKeepQuerystring()) {
+            $parsedUrl = parse_url($requestUri);
+
+            if (isset($parsedUrl['query'])) {
+                $toUrl .= '?' . $parsedUrl['query'];
+            }
+        }
+
         $this->addLogEntry($rule, $requestUri, $toUrl);
 
         header(self::$headers[$statusCode], true, $statusCode);

diff --git a/classes/RedirectRule.php b/classes/RedirectRule.php
@@ -29,6 +29,7 @@ final class RedirectRule
     private bool $ignoreQueryParameters;
     private bool $ignoreCase;
     private bool $ignoreTrailingSlash;
+    private bool $keepQuerystring;
 
     public function __construct(array $attributes)
     {
@@ -92,6 +93,12 @@ public function __construct(array $attributes)
             }
         }
 
+        if ($attributes['ignore_query_parameters'] === false) {
+            $this->keepQuerystring = false;
+        } else {
+            $this->keepQuerystring = (bool) ($attributes['keep_querystring'] ?? false);
+        }
+
         $this->ignoreQueryParameters = (bool) ($attributes['ignore_query_parameters'] ?? false);
         $this->ignoreCase = (bool) ($attributes['ignore_case'] ?? false);
         $this->ignoreTrailingSlash = (bool) ($attributes['ignore_trailing_slash'] ?? false);
@@ -234,4 +241,9 @@ public function isIgnoreTrailingSlash(): bool
     {
         return $this->ignoreTrailingSlash;
     }
+
+    public function isKeepQuerystring(): bool
+    {
+        return $this->keepQuerystring;
+    }
 }
diff --git a/lang/de/lang.php b/lang/de/lang.php
@@ -112,6 +112,8 @@
         'ignore_case_comment' => 'Gross-/Kleinschreibung wird für die Weiterleitung nicht beachtet.',
         'ignore_trailing_slash' => 'Schrägstrich am Ende ignorieren',
         'ignore_trailing_slash_comment' => 'Pfade mit und ohne Schrägstrich am Schluss werden umgeleitet.',
+        'keep_querystring' => 'Abfragezeichenfolge erben',
+        'keep_querystring_comment' => 'Eventuell vorhandene Abfrageparameter werden an den Zielpfad bzw. die Ziel-URL übergeben.',
         'last_used_at' => 'Letzter Treffer',
         'updated_at' => 'Aktualisiert',
         'invalid_regex' => 'Ungültiger Regulärer Ausdruck.',

diff --git a/lang/en/lang.php b/lang/en/lang.php
@@ -112,6 +112,8 @@
         'ignore_case_comment' => 'The redirect engine will do case-insensitive matching.',
         'ignore_trailing_slash' => 'Ignore trailing slash',
         'ignore_trailing_slash_comment' => 'The redirect engine will ignore trailing slashes.',
+        'keep_querystring' => 'Inherit querystring',
+        'keep_querystring_comment' => 'Any query parameters present are passed to the target path or URL.',
         'last_used_at' => 'Last hit',
         'updated_at' => 'Updated at',
         'invalid_regex' => 'Invalid regular expression.',

diff --git a/lang/es/lang.php b/lang/es/lang.php
@@ -114,6 +114,8 @@
         'ignore_case_comment' => 'El motor de redirección hará coincidir las mayúsculas y minúsculas.',
         'ignore_trailing_slash' => 'Ignoren la barra de arrastre',
         'ignore_trailing_slash_comment' => 'El motor de redireccionamiento ignorará las barras de arrastre.',
+        'keep_querystring' => 'Heredar cadena de consulta',
+        'keep_querystring_comment' => 'Todos los parámetros de consulta presentes se pasan a la ruta o URL de destino.',
         'last_used_at' => 'Último resultado',
         'updated_at' => 'Actualizado en',
         'invalid_regex' => 'Expresión regular inválida.',

diff --git a/lang/fr/lang.php b/lang/fr/lang.php
@@ -114,6 +114,8 @@
         'ignore_case_comment' => 'The redirect engine will do case-insensitive matching.', // TODO
         'ignore_trailing_slash' => 'Ignore trailing slash', // TODO
         'ignore_trailing_slash_comment' => 'The redirect engine will ignore trailing slashes.', // TODO
+        'keep_querystring' => 'Hériter de la chaîne de requête',
+        'keep_querystring_comment' => 'Tous les paramètres de requête présents sont transmis au chemin ou à l\'URL cible.',
         'last_used_at' => 'Last hit', // TODO
         'updated_at' => 'Updated at', // TODO
         'invalid_regex' => 'Invalid regular expression.', // TODO

diff --git a/lang/nl/lang.php b/lang/nl/lang.php
@@ -112,6 +112,8 @@
         'ignore_case_comment' => 'Het matching-algoritme is niet hoofdlettergevoelig.',
         'ignore_trailing_slash' => 'Negeer slashes aan het einde van het bronpad.',
         'ignore_trailing_slash_comment' => '',
+        'keep_querystring' => 'Neem querystring over',
+        'keep_querystring_comment' => 'Aanwezige query parameters worden meegegeven aan het doelpad of URL.',
         'last_used_at' => 'Laatste treffer',
         'updated_at' => 'Bijgewerkt op',
         'invalid_regex' => 'Ongeldige reguliere expressie.',

diff --git a/lang/ru/lang.php b/lang/ru/lang.php
@@ -112,6 +112,8 @@
         'ignore_case_comment' => 'Дивжок редиректов будет работать без учета регистра.',
         'ignore_trailing_slash' => 'Игнорировать завершающий слэш',
         'ignore_trailing_slash_comment' => 'Дивжок редиректов будет игнорировать завершающий слэш.',
+        'keep_querystring' => 'наследовать строку запроса',
+        'keep_querystring_comment' => 'Любые имеющиеся параметры запроса передаются по целевому пути или URL-адресу.',
         'last_used_at' => 'Последний хит',
         'updated_at' => 'Обновлено',
         'invalid_regex' => 'Неправильное регулярное выражение.',

diff --git a/lang/sv/lang.php b/lang/sv/lang.php
@@ -110,6 +110,8 @@
         'ignore_case_comment' => 'The redirect engine will do case-insensitive matching.', // TODO
         'ignore_trailing_slash' => 'Ignore trailing slash', // TODO
         'ignore_trailing_slash_comment' => 'The redirect engine will ignore trailing slashes.', // TODO
+        'keep_querystring' => 'Ärv frågesträng',
+        'keep_querystring_comment' => 'Alla frågeparametrar som finns skickas till målsökvägen eller webbadressen.',
         'last_used_at' => 'Användes senast',
         'updated_at' => 'Updated at', // TODO
         'invalid_regex' => 'Invalid regular expression.', // TODO

diff --git a/models/Redirect.php b/models/Redirect.php
@@ -151,6 +151,7 @@ final class Redirect extends Model
         'is_enabled' => 'boolean',
         'test_lab' => 'boolean',
         'system' => 'boolean',
+        'keep_querystring' => 'boolean',
     ];
 
     protected static function makeValidator(

diff --git a/models/redirect/fields.yaml b/models/redirect/fields.yaml
@@ -93,6 +93,17 @@ tabs:
             span: left
             default: false
             comment: vdlp.redirect::lang.redirect.ignore_query_parameters_comment
+        keep_querystring:
+            label: vdlp.redirect::lang.redirect.keep_querystring
+            type: checkbox
+            span: left
+            cssClass: field-indent
+            default: false
+            trigger:
+                action: show
+                field: ignore_query_parameters
+                condition: checked
+            comment: vdlp.redirect::lang.redirect.keep_querystring_comment
         description:
             label: vdlp.redirect::lang.redirect.description
             span: right

diff --git a/updates/20231108_0013_add_keep_querystring_to_redirects_table.php b/updates/20231108_0013_add_keep_querystring_to_redirects_table.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Schema\Blueprint;
+use October\Rain\Database\Updates\Migration;
+
+class AddKeepQueryStringToRedirectsTable extends Migration
+{
+    public function up(): void
+    {
+        if (Schema::hasColumn('vdlp_redirect_redirects', 'keep_querystring')) {
+            return;
+        }
+
+        Schema::table('vdlp_redirect_redirects', static function (Blueprint $table): void {
+            $table->boolean('keep_querystring')
+                ->default(false)
+                ->after('ignore_trailing_slash');
+        });
+    }
+
+    public function down(): void
+    {
+        if (Schema::hasColumn('vdlp_redirect_redirects', 'keep_querystring')) {
+            Schema::table('vdlp_redirect_redirects', static function (Blueprint $table): void {
+                $table->dropColumn('keep_querystring');
+            });
+        }
+    }
+}
diff --git a/updates/version.yaml b/updates/version.yaml
@@ -84,3 +84,6 @@ v3.1.7: "Remove use of old BrandSetting constants."
 v3.1.8: "Add German translation."
 v3.1.9: "Added environment variables for manipulating the navigation."
 v3.1.10: "Fixed backend filtering for MySQL >= 8.0.3."
+v3.1.11:
+    - "Added feature to keep the querystring when redirecting"
+    - 20231108_0013_add_keep_querystring_to_redirects_table.php