Add Plugin (WIP)

Author: jakubboucek

composer.json

@@ -18,6 +18,14 @@
         "php": ">=7.4",
         "nette/utils": "^3.0"
     },
+    "require-dev": {
+        "firebase/php-jwt": "^5.0",
+        "nette/tester": "^2.4",
+        "phpstan/phpstan": "^0.12.98"
+    },
+    "suggest": {
+        "firebase/php-jwt": "Optional, required for SignedUrl plugin"
+    },
     "autoload": {
         "psr-4": {
             "Redbitcz\\DebugMode\\": "src/"
@@ -36,10 +44,6 @@
             "dev-master": "2.0-dev"
         }
     },
-    "require-dev": {
-        "phpstan/phpstan": "^0.12.98",
-        "nette/tester": "^2.4"
-    },
     "scripts": {
         "phpstan": "phpstan analyze src -c phpstan.neon --level 8",
         "tester": "tester tests"

src/Detector.php

@@ -8,6 +8,8 @@
 
 namespace Redbitcz\DebugMode;
 
+use Redbitcz\DebugMode\Plugin\Plugin;
+
 class Detector
 {
     /** Name of Environment variable used to detect Debug mode */
@@ -36,10 +38,12 @@ class Detector
 
 
     private ?Enabler $enabler;
-    private int $mode;
     /** @var string[] */
     private array $ips = ['::1', '127.0.0.1'];
 
+    /** @var array<int, callable> */
+    private array $detections;
+
     /**
      * @param int $mode Enables methods which is used to detect Debug mode
      * @param Enabler|null $enabler Enabler instance. Optional, but required when Enabler mode is enabled
@@ -52,8 +56,21 @@ public function __construct(int $mode = self::MODE_SIMPLE, ?Enabler $enabler = n
             );
         }
 
+        $this->detections = array_filter(
+            [
+                $mode & self::MODE_ENABLER ? [$this, 'isDebugModeByEnabler'] : null,
+                $mode & self::MODE_COOKIE ? [$this, 'isDebugModeByCookie'] : null,
+                $mode & self::MODE_ENV ? [$this, 'isDebugModeByEnv'] : null,
+                $mode & self::MODE_IP ? [$this, 'isDebugModeByIp'] : null,
+            ]
+        );
+
         $this->enabler = $enabler;
-        $this->mode = $mode;
+    }
+
+    public function hasEnabler(): bool
+    {
+        return $this->enabler !== null;
     }
 
     public function getEnabler(): Enabler
@@ -74,11 +91,12 @@ public function getEnabler(): Enabler
      */
     public function isDebugMode(?bool $default = false): ?bool
     {
-        return ($this->mode & self::MODE_ENABLER ? $this->isDebugModeByEnabler() : null)
-            ?? ($this->mode & self::MODE_COOKIE ? $this->isDebugModeByCookie() : null)
-            ?? ($this->mode & self::MODE_ENV ? $this->isDebugModeByEnv() : null)
-            ?? ($this->mode & self::MODE_IP ? $this->isDebugModeByIp() : null)
-            ?? $default;
+        foreach ($this->detections as $detection) {
+            if (($result = $detection()) !== null) {
+                return $result;
+            }
+        }
+        return $default;
     }
 
     /**
@@ -152,6 +170,7 @@ public function isDebugModeByIp(): ?bool
 
     /**
      * Set client IP address with allowed Debug mode
+     * @return static
      */
     public function setAllowedIp(string ...$ips): self
     {
@@ -161,13 +180,28 @@ public function setAllowedIp(string ...$ips): self
 
     /**
      * Add client IP address with allowed Debug mode
+     * @return static
      */
     public function addAllowedIp(string ...$ips): self
     {
         $this->ips = array_merge($this->ips, $ips);
         return $this;
     }
 
+    /** @return static */
+    public function prependPlugin(Plugin $plugin): self
+    {
+        array_unshift($this->detections, $plugin);
+        return $this;
+    }
+
+    /** @return static */
+    public function appendPlugin(Plugin $plugin): self
+    {
+        $this->detections[] = $plugin;
+        return $this;
+    }
+
     /**
      * Shortcut to simple detect Debug mode by all method enabled by Detector mode (argument `$mode`)
      *

src/Enabler.php

@@ -8,6 +8,7 @@
 
 namespace Redbitcz\DebugMode;
 
+use DateTimeInterface;
 use Nette\IOException;
 use Nette\Utils\DateTime as NetteDateTime;
 use Nette\Utils\FileSystem;
@@ -68,14 +69,17 @@ public function setCookieOptions(
         return $this;
     }
 
-    public function activate(bool $isDebug, ?string $time = self::DEFAULT_TTL): void
+    /**
+     * @param string|int|DateTimeInterface|null $expires
+     */
+    public function activate(bool $isDebug, $expires = null): void
     {
         if ($tokenName = $this->getTokenName()) {
             $this->destroyToken($tokenName);
         }
 
-        $tokenExpires = (int)NetteDateTime::from($time ?? self::DEFAULT_TTL)->format('U');
-        $cookieExpires = $time === null ? 0 : $tokenExpires;
+        $tokenExpires = (int)NetteDateTime::from($expires ?? self::DEFAULT_TTL)->format('U');
+        $cookieExpires = $expires === null ? 0 : $tokenExpires;
         $tokenName = $this->createToken($isDebug, $tokenExpires);
         setcookie(self::DEBUG_COOKIE_NAME, $tokenName, ['expires' => $cookieExpires] + $this->cookieOptions);
 

src/Plugin/Plugin.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redbitcz\DebugMode\Plugin;
+
+use Redbitcz\DebugMode\Detector;
+
+interface Plugin
+{
+    /**
+     * Method invoked when Debug mode detection is called
+     * Returned value:
+     *   - `true` (force to turn-on debug mode)
+     *   - `false` (force to turn-off debug mode)
+     *   - `null` (unknown debug mode state, next detection method will be called)
+     */
+    public function __invoke(Detector $detector): ?bool;
+}