Add ignore domains option (#11)

Author: AlexisSerneels

README.md

@@ -214,6 +214,18 @@ For example:
 ],
 ```
 
+#### ☑️ Ignore Domains
+
+If for any reason you wish to disable StageFront on specific doamins, you can add these to the `ignore_udomains` array in the [configuration file](#-publish-configuration-file). You can't set this in the `.env` file.
+
+For example:
+
+```php
+'ignore_domains' => [
+    'admin.domain.com',
+],
+```
+
 #### ☑️ Link Live Site
 
 If you set the URL to your live site, a link will be shown underneath the login form.

config/stagefront.php

@@ -157,4 +157,14 @@
      */
     'ignore_urls' => [],
 
+    
+    /**
+     * The following domains will be ignored by StageFront.
+     * Access to these domains will never be blocked.
+     * Default: []
+     * Example: 'admin.domain.com'
+     */
+    'ignore_domains' => [
+    ],
+
 ];

src/Shield.php

@@ -55,6 +55,7 @@ protected function isActive()
      */
     protected function currentUrlIsIgnored()
     {
+        $ignoredDomains = Config::get('stagefront.ignore_domains', []);
         $ignoredUrls = Config::get('stagefront.ignore_urls', []);
         $ignoredUrls[] = Config::get('stagefront.url');
 
@@ -66,6 +67,14 @@ protected function currentUrlIsIgnored()
             }
         }
 
+        foreach ($ignoredDomains as $url) {
+            $url = trim($url, '/');
+
+            if (str_contains(Request::url(), $url)) {
+                return true;
+            }
+        }
+
         return false;
     }
 

tests/StageFrontTest.php

@@ -358,6 +358,20 @@ public function urls_can_be_ignored_so_access_is_not_denied_by_stagefront()
         $this->get('/public/route')->assertStatus(200)->assertSee('Route');
     }
 
+    /** @test */
+    public function domains_can_be_ignored_so_access_is_not_denied_by_stagefront()
+    {
+        $this->url = Config::get('stagefront.url');
+
+        $this->registerRouteWithDomain('/admin', 'Admin');
+
+        Config::set('stagefront.ignore_domains', ['domain.example.com']);
+
+        $this->enableStageFront();
+
+        $this->call('GET', 'http://domain.example.com/admin')->assertStatus(200)->assertSee('Admin');
+    }
+
     /** @test */
     public function ignored_urls_can_be_accessed_by_non_whitelisted_ips()
     {
@@ -486,4 +500,19 @@ protected function registerRoute($url, $text)
             return $text;
         })->middleware(Config::get('stagefront.middleware'));
     }
+
+    /**
+     * Register a test route.
+     *
+     * @param string $url
+     * @param string $text
+     */
+    protected function registerRouteWithDomain($url, $text)
+    {
+        Route::domain('domain.example.com')->group(function () use ($url, $text) {
+            Route::get($url, function () use ($text) {
+                return $text;
+            })->middleware(Config::get('stagefront.middleware'));
+        });
+    }
 }