Add trusted IP feature (#51)

* 💎 Add whitelist feature

* Use trusted ips keyword

---------

Co-authored-by: Dimitri BOUTEILLE <dimitri.bouteille@reflet-digital.com>

Author: dimitriBouteille

Model/Config.php

@@ -21,6 +21,8 @@ class Config
 
     public const CONFIG_PATH_ENDPOINT = 'imi_friendly_captcha/general/endpoint';
 
+    public const CONFIG_PATH_TRUSTED_IPS = 'imi_friendly_captcha/general/trusted_ips';
+
     public const CONFIG_PATH_ENABLED_FRONTEND = 'imi_friendly_captcha/frontend/enabled';
 
     public const CONFIG_PATH_ENABLED_FRONTEND_LOGIN = 'imi_friendly_captcha/frontend/enabled_login';
@@ -261,4 +263,19 @@ public function isEnabledFrontendSendFriend(): bool
             ScopeInterface::SCOPE_WEBSITE
         );
     }
+
+    /**
+     * Returns trusted IPS
+     *
+     * @return array<string>
+     */
+    public function getTrustedIps(): array
+    {
+        $config = $this->scopeConfig->getValue(static::CONFIG_PATH_TRUSTED_IPS);
+        if ($config === null || $config === '') {
+            return [];
+        }
+
+        return array_map('trim', explode(',', (string)$config));
+    }
 }

Model/Validate.php

@@ -13,6 +13,7 @@
 use Magento\Framework\HTTP\Client\CurlFactory;
 use Magento\Framework\Serialize\Serializer\Json;
 use Psr\Log\LoggerInterface;
+use Magento\Framework\HTTP\PhpEnvironment\RemoteAddress;
 
 class Validate implements ValidateInterface
 {
@@ -43,23 +44,31 @@ class Validate implements ValidateInterface
     private $serializer;
 
     /**
-     * Validate constructor.
+     * @var
+     */
+    private $remoteAddress;
+
+    /**
+     * Validate Constructor
      *
      * @param LoggerInterface $logger
      * @param Config $config
      * @param CurlFactory $curlFactory
      * @param Json $serializer
+     * @param RemoteAddress $remoteAddress
      */
     public function __construct(
         LoggerInterface $logger,
         Config $config,
         CurlFactory $curlFactory,
-        Json $serializer
+        Json $serializer,
+        RemoteAddress $remoteAddress
     ) {
         $this->logger = $logger;
         $this->config = $config;
         $this->curlFactory = $curlFactory;
         $this->serializer = $serializer;
+        $this->remoteAddress = $remoteAddress;
     }
 
     /**
@@ -71,6 +80,12 @@ public function __construct(
      */
     public function validate(string $friendlyCaptchaSolution): bool
     {
+        $ips = $this->config->getTrustedIps();
+        $clientIp = $this->remoteAddress->getRemoteAddress();
+        if ($ips !== [] && in_array((string)$clientIp, $ips, true)) {
+            return true;
+        }
+
         $parameters = [
             self::PARAMETER_SOLUTION => $friendlyCaptchaSolution,
             self::PARAMETER_SECRET => $this->config->getApikey(),

etc/adminhtml/system.xml

@@ -50,6 +50,13 @@
                     </depends>
                     <validate>required-entry validate-url validate-no-html-tags</validate>
                 </field>
+
+                <field id="trusted_ips" translate="label comment tooltip" type="textarea" sortOrder="33"
+                       showInDefault="1" showInWebsite="0" showInStore="0" canRestore="1">
+                    <label>Trusted IPS</label>
+                    <tooltip>Friendly captcha will be disabled for the specified IP addresses</tooltip>
+                    <comment><![CDATA[For example: <strong>192.168.1.2</strong> </br>Each IP must be seperated by comma]]></comment>
+                </field>
             </group>
             <group id="frontend" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1"
                    showInStore="1">