Automatically prevent folder/file names that are in public folder fro…

…m being used as keywords (#977)
realodix · May 5, 2024 · 9ba217e · 9ba217e
1 parent 2641ec2
commit 9ba217e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/app/Services/KeyGeneratorService.php b/app/Services/KeyGeneratorService.php
@@ -100,8 +100,9 @@ public function ensureStringCanBeUsedAsKey(string $value): bool
         $alreadyInUse = Url::whereKeyword($value)->exists();
         $isReservedKeyword = in_array($value, config('urlhub.reserved_keyword'));
         $isRoute = in_array($value, $route);
+        $isPublicPath = in_array($value, scandir(public_path()));
 
-        if ($alreadyInUse || $isReservedKeyword || $isRoute) {
+        if ($alreadyInUse || $isReservedKeyword || $isRoute || $isPublicPath) {
             return false;
         }
 

diff --git a/config/urlhub.php b/config/urlhub.php
@@ -56,12 +56,7 @@
      * example rude words.
      */
     'reserved_keyword' => [
-        'css',
-        'images',
-        'img',
-        'fonts',
-        'js',
-        'svg',
+        'images', 'img', 'fonts',
     ],
 
     'web_title' => env('UH_WEB_TITLE', true),

diff --git a/tests/Feature/FrontPage/ShortenUrl/ValidationTest.php b/tests/Feature/FrontPage/ShortenUrl/ValidationTest.php
@@ -62,7 +62,7 @@ public static function customKeyFailProvider(): array
         return [
             ['fooBar'],
             ['foo_bar'],
-            ['css'], // reserved keyword
+            ['fonts'], // reserved keyword
             ['login'], // registered route
         ];
     }

diff --git a/tests/Unit/Rule/NotBlacklistedKeywordTest.php b/tests/Unit/Rule/NotBlacklistedKeywordTest.php
@@ -44,6 +44,10 @@ public static function registeredRouteDataProvider(): array
         return [
             ['login'],
             ['register'],
+
+            // in public folder
+            ['svg'], // folder
+            ['build'], // vite folder
         ];
     }
 
@@ -68,7 +72,7 @@ public function testCustomKeywordIsRegisteredRoute($value): void
     #[Group('u-rule')]
     public function testCustomKeywordIsReservedKeyword(): void
     {
-        $value = 'css';
+        $value = 'reserved_keyword';
         config(['urlhub.reserved_keyword' => [$value]]);
 
         $val = Helper::validator(['foo' => $value], ['foo' => new NotBlacklistedKeyword]);