Merge pull request #9 from julienloizelet/feat/lib-0-22-0-no-more-session

Feat/lib 0 22 0 no more session

Author: julienloizelet

Block/Adminhtml/System/Config/Geolocation/Country.php

@@ -61,6 +61,13 @@ class Country extends Button
      */
     protected $_forcedTestIpField = 'crowdsec_bouncer_advanced_debug_forced_test_ip';
 
+    /**
+     * Save result field name
+     *
+     * @var string
+     */
+    protected $_saveResultField = 'crowdsec_bouncer_advanced_geolocation_save_result';
+
     /** @var string  */
     protected $template = 'CrowdSec_Bouncer::system/config/geolocation/country.phtml';
     /** @var string  */
@@ -106,6 +113,16 @@ public function getForcedTestIpField(): string
         return $this->_forcedTestIpField;
     }
 
+    /**
+     * Save result field name
+     *
+     * @return string
+     */
+    public function getSaveResultField(): string
+    {
+        return $this->_saveResultField;
+    }
+
     /**
      * Get the button and scripts contents
      *

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.0] - 2022-06-09
+
+### Added
+- Add configuration to set captcha flow cache lifetime
+- Add configuration to set geolocation result cache lifetime
+### Changed
+- Use cache instead of session to store some values
+### Fixed
+- Fix wrong deleted decisions count during cache refresh
 
 ## [1.2.0] - 2022-05-12
 

Constants.php

@@ -33,7 +33,7 @@ class Constants extends LibConstants
 {
 
     /** @var string The last version of this library */
-    public const VERSION = 'v1.2.0';
+    public const VERSION = 'v1.3.0';
 
     /** @var string The user agent used to send request to LAPI or CAPI */
     public const BASE_USER_AGENT = 'Magento 2 CrowdSec Bouncer/'.self::VERSION;

Controller/Adminhtml/System/Config/Geolocation/Country.php

@@ -28,6 +28,7 @@
 namespace CrowdSec\Bouncer\Controller\Adminhtml\System\Config\Geolocation;
 
 use CrowdSec\Bouncer\Controller\Adminhtml\System\Config\Action;
+use CrowdSec\Bouncer\Registry\CurrentBouncer as RegistryBouncer;
 use Exception;
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\App\Action\HttpPostActionInterface;
@@ -56,25 +57,33 @@ class Country extends Action implements HttpPostActionInterface
     /** @var  DirectoryList */
     protected $directoryList;
 
+    /**
+     * @var RegistryBouncer
+     */
+    protected $registryBouncer;
+
     /**
      * @param Context $context
      * @param JsonFactory $resultJsonFactory
      * @param Helper $helper
      * @param Geolocation $geolocation
      * @param DirectoryList $directoryList
+     * @param RegistryBouncer $registryBouncer
      */
     public function __construct(
         Context $context,
         JsonFactory $resultJsonFactory,
         Helper $helper,
         Geolocation $geolocation,
-        DirectoryList $directoryList
+        DirectoryList $directoryList,
+        RegistryBouncer $registryBouncer
     ) {
         parent::__construct($context);
         $this->resultJsonFactory = $resultJsonFactory;
         $this->helper = $helper;
         $this->geolocation = $geolocation;
         $this->directoryList = $directoryList;
+        $this->registryBouncer = $registryBouncer;
     }
 
     /**
@@ -85,15 +94,22 @@ public function __construct(
     public function execute(): Json
     {
         try {
+            if (!($bouncer = $this->registryBouncer->get())) {
+                $bouncer = $this->registryBouncer->create();
+            }
+            $configs = $this->helper->getBouncerConfigs();
+            $bouncer = $bouncer->init($configs);
+            $apiCache = $bouncer->getApiCache();
 
             $type = $this->getRequest()->getParam('geolocation_type');
             $maxmindType = $this->getRequest()->getParam('geolocation_maxmind_database_type');
             $maxmindPath = $this->getRequest()->getParam('geolocation_maxmind_database_path');
             $forcedIP = $this->getRequest()->getParam('forced_test_ip');
+            $saveResult = (bool) $this->getRequest()->getParam('save_result');
             $ip = !empty($forcedIP) ? $forcedIP : $this->helper->getRemoteIp();
             $geolocConfig = [
                 'type' => $type,
-                'save_in_session' => false,
+                'save_result' => $saveResult,
             ];
             if ($type === Constants::GEOLOCATION_TYPE_MAXMIND) {
                 $geolocConfig['maxmind'] = [
@@ -102,7 +118,7 @@ public function execute(): Json
                 ];
             }
 
-            $countryResult = $this->geolocation->getCountryResult($geolocConfig, $ip);
+            $countryResult = $this->geolocation->getCountryResult($geolocConfig, $ip, $apiCache);
             $countryMessage = null;
             $result = false;
             $message = __('Geolocation test result: failed.');

Helper/Config.php

@@ -86,14 +86,16 @@ class Config extends AbstractHelper
     public const XML_PATH_ADVANCED_CACHE_MEMCACHED_DSN = self::SECTION . '/advanced/cache/memcached_dsn';
     public const XML_PATH_ADVANCED_CACHE_CLEAN = self::SECTION . '/advanced/cache/clean_ip_cache_duration';
     public const XML_PATH_ADVANCED_CACHE_BAD = self::SECTION . '/advanced/cache/bad_ip_cache_duration';
+    public const XML_PATH_ADVANCED_CACHE_CAPTCHA = self::SECTION . '/advanced/cache/captcha_cache_duration';
+    public const XML_PATH_ADVANCED_CACHE_GEO = self::SECTION . '/advanced/cache/geolocation_cache_duration';
     public const XML_PATH_ADVANCED_DEBUG_LOG = self::SECTION . '/advanced/debug/log';
     public const XML_PATH_ADVANCED_DISPLAY_ERRORS = self::SECTION . '/advanced/debug/display_errors';
     public const XML_PATH_ADVANCED_DISABLE_PROD_LOG = self::SECTION . '/advanced/debug/disable_prod_log';
     public const XML_PATH_ADVANCED_FORCED_TEST_IP = self::SECTION . '/advanced/debug/forced_test_ip';
 
     public const XML_PATH_ADVANCED_GEOLOCATION_ENABLED = self::SECTION . '/advanced/geolocation/enabled';
     public const XML_PATH_ADVANCED_GEOLOCATION_TYPE = self::SECTION . '/advanced/geolocation/type';
-    public const XML_PATH_ADVANCED_GEOLOCATION_SAVE_SESSION = self::SECTION . '/advanced/geolocation/save_in_session';
+    public const XML_PATH_ADVANCED_GEOLOCATION_SAVE_RESULT = self::SECTION . '/advanced/geolocation/save_result';
     public const XML_PATH_ADVANCED_GEOLOCATION_MAXMIND_DB_TYPE = self::SECTION .
                                                                  '/advanced/geolocation/maxmind_database_type';
     public const XML_PATH_ADVANCED_GEOLOCATION_MAXMIND_DB_PATH = self::SECTION .
@@ -140,6 +142,8 @@ class Config extends AbstractHelper
         'memcached_dsn' => null,
         'clean_ip_duration' => null,
         'bad_ip_duration' => null,
+        'captcha_duration' => null,
+        'geolocation_duration' => null,
         'trusted_forwarded_ip' => null,
         'geolocation' => null,
     ];
@@ -344,8 +348,8 @@ public function getGeolocation(): array
             $result = ['enabled' => false];
             if ($this->scopeConfig->getValue(self::XML_PATH_ADVANCED_GEOLOCATION_ENABLED)) {
                 $result['enabled'] = true;
-                $result['save_in_session'] =
-                    (bool)$this->scopeConfig->getValue(self::XML_PATH_ADVANCED_GEOLOCATION_SAVE_SESSION);
+                $result['save_result'] =
+                    (bool)$this->scopeConfig->getValue(self::XML_PATH_ADVANCED_GEOLOCATION_SAVE_RESULT);
                 $type = (string)$this->scopeConfig->getValue(self::XML_PATH_ADVANCED_GEOLOCATION_TYPE);
                 $result['type'] = $type;
                 if ($type === Constants::GEOLOCATION_TYPE_MAXMIND) {
@@ -506,6 +510,38 @@ public function getBadIpCacheDuration(): int
         return (int) $this->_globals['bad_ip_duration'];
     }
 
+    /**
+     * Get captcha cache duration config
+     *
+     * @return int
+     */
+    public function getCaptchaCacheDuration(): int
+    {
+        if (!isset($this->_globals['captcha_duration'])) {
+            $this->_globals['captcha_duration'] = (int)$this->scopeConfig->getValue(
+                self::XML_PATH_ADVANCED_CACHE_CAPTCHA
+            );
+        }
+
+        return (int) $this->_globals['captcha_duration'];
+    }
+
+    /**
+     * Get geolocation cache duration config
+     *
+     * @return int
+     */
+    public function getGeolocationCacheDuration(): int
+    {
+        if (!isset($this->_globals['geolocation_duration'])) {
+            $this->_globals['geolocation_duration'] = (int)$this->scopeConfig->getValue(
+                self::XML_PATH_ADVANCED_CACHE_GEO
+            );
+        }
+
+        return (int) $this->_globals['geolocation_duration'];
+    }
+
     /**
      * Get bouncing level config
      *

Helper/Data.php

@@ -418,6 +418,8 @@ public function getBouncerConfigs(): array
                 'memcached_dsn' => $this->getMemcachedDSN(),
                 'clean_ip_cache_duration' => $this->getCleanIpCacheDuration(),
                 'bad_ip_cache_duration' => $this->getBadIpCacheDuration(),
+                'captcha_cache_duration' => $this->getCaptchaCacheDuration(),
+                'geolocation_cache_duration' => $this->getGeolocationCacheDuration(),
                 // Geolocation
                 'geolocation' => $this->getGeolocation(),
                 // Extra configs

Model/Bouncer.php

@@ -38,7 +38,7 @@
 use Psr\Cache\InvalidArgumentException;
 
 /**
- * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Bouncer extends AbstractBounce implements IBounce
@@ -49,11 +49,6 @@ class Bouncer extends AbstractBounce implements IBounce
      */
     protected $response;
 
-    /**
-     * @var Session
-     */
-    protected $session;
-
     /**
      * @var Helper
      */
@@ -77,20 +72,17 @@ class Bouncer extends AbstractBounce implements IBounce
      * Constructor
      *
      * @param Http $response
-     * @param Session $session
      * @param Helper $helper
      * @param CacheFactory $cacheFactory
      * @param BouncerFactory $bouncerInstanceFactory
      */
     public function __construct(
         Http $response,
-        Session $session,
         Helper $helper,
         CacheFactory $cacheFactory,
         BouncerFactory $bouncerInstanceFactory
     ) {
         $this->response = $response;
-        $this->session = $session;
         $this->helper = $helper;
         $this->cacheFactory = $cacheFactory;
         $this->bouncerInstanceFactory = $bouncerInstanceFactory;
@@ -152,6 +144,7 @@ public function getBouncerInstance(array $settings = [], bool $forceReload = fal
             }
 
             try {
+                /** @var BouncerInstance $bouncerInstance */
                 $bouncerInstance =
                     $this->bouncerInstanceFactory->create(
                         ['cacheAdapter' => $cacheAdapter, 'logger' => $this->logger ]
@@ -181,6 +174,8 @@ public function getBouncerInstance(array $settings = [], bool $forceReload = fal
                     'memcached_dsn' => $settings['memcached_dsn'],
                     'clean_ip_cache_duration' => $settings['clean_ip_cache_duration'],
                     'bad_ip_cache_duration' => $settings['bad_ip_cache_duration'],
+                    'captcha_cache_duration' => $settings['captcha_cache_duration'],
+                    'geolocation_cache_duration' => $settings['geolocation_cache_duration'],
                     // Geolocation
                     'geolocation' => $settings['geolocation']
                 ]);
@@ -270,50 +265,6 @@ public function getTrustForwardedIpBoundsList(): array
         return $this->helper->getTrustedForwardedIps();
     }
 
-    /**
-     * Get session variable value
-     *
-     * @param string $name
-     * @return mixed
-     */
-    public function getSessionVariable(string $name)
-    {
-        return $this->session->getData($name);
-    }
-
-    /**
-     * Get all session variables
-     *
-     * @return mixed
-     */
-    public function getAllSessionVariables()
-    {
-        return $this->session->getData();
-    }
-
-    /**
-     * Set a session variable.
-     *
-     * @param string $name
-     * @param mixed $value
-     * @return void
-     */
-    public function setSessionVariable(string $name, $value): void
-    {
-        $this->session->setData($name, $value);
-    }
-
-    /**
-     * Unset a session variable, throw an error if this does not exist.
-     *
-     * @param string $name
-     * @return void
-     */
-    public function unsetSessionVariable(string $name): void
-    {
-        $this->session->unsetData($name);
-    }
-
     /**
      * Get the value of a posted field.
      *

Model/Cache.php

@@ -27,14 +27,17 @@
 
 namespace CrowdSec\Bouncer\Model;
 
+use CrowdSec\Bouncer\Exception\CrowdSecException;
+use CrowdSec\Bouncer\Constants;
+use CrowdSecBouncer\Fixes\Memcached\TagAwareAdapter as MemcachedTagAwareAdapter;
 use ErrorException;
 use Symfony\Component\Cache\Adapter\MemcachedAdapter;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
+use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
-use CrowdSec\Bouncer\Exception\CrowdSecException;
-use CrowdSec\Bouncer\Constants;
 
 class Cache
 {
@@ -65,7 +68,7 @@ public function getAdapter(
             $cacheSystem = $forcedCacheSystem ?: $cacheSystem;
             switch ($cacheSystem) {
                 case Constants::CACHE_SYSTEM_PHPFS:
-                    $cacheAdapterInstance = new PhpFilesAdapter('', 0, $fsCachePath);
+                    $cacheAdapterInstance = new TagAwareAdapter(new PhpFilesAdapter('', 0, $fsCachePath));
                     break;
 
                 case Constants::CACHE_SYSTEM_MEMCACHED:
@@ -75,7 +78,9 @@ public function getAdapter(
                                ' Please set a Memcached DSN or select another cache technology.'
                         );
                     }
-                    $cacheAdapterInstance = new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedDsn));
+                    $cacheAdapterInstance = new MemcachedTagAwareAdapter(
+                        new MemcachedAdapter(MemcachedAdapter::createConnection($memcachedDsn))
+                    );
                     break;
                 case Constants::CACHE_SYSTEM_REDIS:
                     if (empty($redisDsn)) {
@@ -84,7 +89,7 @@ public function getAdapter(
                     }
 
                     try {
-                        $cacheAdapterInstance = new RedisAdapter(RedisAdapter::createConnection($redisDsn));
+                        $cacheAdapterInstance = new RedisTagAwareAdapter(RedisAdapter::createConnection($redisDsn));
                     } catch (InvalidArgumentException $e) {
                         throw new CrowdSecException('Error when connecting to Redis.' .
                                ' Please fix the Redis DSN or select another cache technology.');