feat: allow wildcard route exclusion

SychO9 · Feb 4, 2024 · 0f7b202 · 0f7b202
1 parent a6d628c
commit 0f7b202
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 56 deletions.
diff --git a/extend.php b/extend.php
@@ -53,9 +53,6 @@
     (new Extend\View())
         ->namespace('sycho-private-facade', __DIR__.'/views'),
 
-    (new Extend\ServiceProvider())
-        ->register(RouteExclusionProvider::class),
-
     (new Extend\Settings())
         ->default('sycho-private-facade.header_layout', 'show_only_logo')
         ->default('sycho-private-facade.primary_color_bg', true)

diff --git a/src/Extend/FacadeExclusions.php b/src/Extend/FacadeExclusions.php
@@ -5,6 +5,7 @@
 use Flarum\Extend\ExtenderInterface;
 use Flarum\Extension\Extension;
 use Illuminate\Contracts\Container\Container;
+use SychO\PrivateFacade\PrivateFacadeMiddleware;
 
 class FacadeExclusions implements ExtenderInterface
 {
@@ -31,12 +32,7 @@ public function extend(Container $container, Extension $extension = null)
             return;
         }
 
-        $container->extend('sycho-private-facade.backend-route-exclusions', function ($excludedRoutes) {
-            return array_merge($excludedRoutes, $this->excludedBackendRoutes);
-        });
-
-        $container->extend('sycho-private-facade.frontend-route-exclusions', function ($excludedRoutes) {
-            return array_merge($excludedRoutes, $this->excludedFrontendRoutes);
-        });
+        PrivateFacadeMiddleware::$backendRouteExclusions = array_merge(PrivateFacadeMiddleware::$backendRouteExclusions, $this->excludedBackendRoutes);
+        PrivateFacadeMiddleware::$frontendRouteExclusions = array_merge(PrivateFacadeMiddleware::$frontendRouteExclusions, $this->excludedFrontendRoutes);
     }
 }
diff --git a/src/Helper.php b/src/Helper.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace SychO\PrivateFacade;
+
+class Helper
+{
+    public static function itemsInclude(array $items, string $value): bool
+    {
+        $included = false;
+
+        foreach ($items as $item) {
+            // allow for wildcards
+            if (strpos($item, '*') !== false) {
+                $item = str_replace('*', '.*', preg_quote($item, '/'));
+
+                if (preg_match('/' . $item . '/', $value)) {
+                    $included = true;
+                    break;
+                }
+            } elseif ($value === $item) {
+                $included = true;
+                break;
+            }
+        }
+
+        return $included;
+    }
+}
diff --git a/src/PrivateFacadeMiddleware.php b/src/PrivateFacadeMiddleware.php
@@ -13,6 +13,19 @@
 
 class PrivateFacadeMiddleware implements MiddlewareInterface
 {
+    public static $backendRouteExclusions = [
+        'login', 'register', 'sycho-private-facade.login', 'sycho-private-facade.signup',
+        'resetPassword', 'confirmEmail', 'savePassword', 'confirmEmail.submit',
+        // FoF-OAuth
+        'auth.twitter', 'fof-oauth',
+        // PWA
+        'askvortsov-pwa.*',
+    ];
+
+    public static $frontendRouteExclusions = [
+        'sycho-private-facade.login', 'sycho-private-facade.signup',
+    ];
+
     /**
      * @var SettingsRepositoryInterface
      */
@@ -39,25 +52,10 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         $extensionExcludedRoutes = self::getBackendRouteExclusions($userExcludedRoutes);
         $extensionExcludedUrls = explode(',', str_replace(' ', '', $userExcludedUrls));
 
-        $excludedRoute = in_array($request->getAttribute('routeName'), $extensionExcludedRoutes, true);
+        $excludedRoute = Helper::itemsInclude($extensionExcludedRoutes, $request->getAttribute('routeName'));
 
         if (! $excludedRoute) {
-            $currentUri = $request->getUri()->getPath();
-
-            foreach ($extensionExcludedUrls as $url) {
-                // allow for wildcards
-                if (strpos($url, '*') !== false) {
-                    $url = str_replace('*', '.*', preg_quote($url, '/'));
-
-                    if (preg_match('/' . $url . '/', $currentUri)) {
-                        $excludedRoute = true;
-                        break;
-                    }
-                } elseif ($currentUri === $url) {
-                    $excludedRoute = true;
-                    break;
-                }
-            }
+            $excludedRoute = Helper::itemsInclude($extensionExcludedUrls, $request->getUri()->getPath());
         }
 
         $isPrivateFacade = in_array(
@@ -89,12 +87,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
     public static function getBackendRouteExclusions(?string $userExcludedRoutes): array
     {
-        return self::getRouteExclusions($userExcludedRoutes, resolve('sycho-private-facade.backend-route-exclusions'));
+        return self::getRouteExclusions($userExcludedRoutes, self::$backendRouteExclusions);
     }
 
     public static function getFrontendRouteExclusions(?string $userExcludedRoutes): array
     {
-        return self::getRouteExclusions($userExcludedRoutes, resolve('sycho-private-facade.frontend-route-exclusions'));
+        return self::getRouteExclusions($userExcludedRoutes, self::$frontendRouteExclusions);
     }
 
     protected static function getRouteExclusions(?string $userExcludedRoutes, array $extensionExcludedRoutes): array

diff --git a/src/Providers/RouteExclusionProvider.php b/src/Providers/RouteExclusionProvider.php