Merge pull request #81 from julienloizelet/fix/boolean-parameter

fix(captcha): Fix displayCaptchaWall function and handle some retro-c…

Author: julienloizelet

.github/workflows/test-suite.yml

@@ -1,6 +1,6 @@
 name: Test suite
 on:
-  pull_request:
+  push:
     branches:
       - main
     paths-ignore:
@@ -113,6 +113,7 @@ jobs:
         run: |
           cd ${{ github.workspace }}
           cp .ddev/custom_files/phpinfo.php my-own-modules/crowdsec-php-lib/scripts/public/phpinfo.php
+          curl -v https://${{ env.PHP_VERSION_CODE }}.ddev.site/my-own-modules/crowdsec-php-lib/scripts/public/phpinfo.php
           PREPENDVERIF=$(curl https://${{ env.PHP_VERSION_CODE }}.ddev.site/my-own-modules/crowdsec-php-lib/scripts/public/phpinfo.php | grep -o -E "auto_prepend_file=(.*)php(.*)" | sed 's/<\/tr>//g; s/<\/td>//g;' | tr '\n' '#')
           if [[ $PREPENDVERIF == "auto_prepend_file=/var/www/html/my-own-modules/crowdsec-php-lib/scripts/auto-prepend/bounce.php#auto_prepend_file=/var/www/html/my-own-modules/crowdsec-php-lib/scripts/auto-prepend/bounce.php#" ]]
           then

CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## [0.20.1] - 2022-04-07
+
+### Added
+- Handle old lib version (`< 0.14.0`) settings values retro-compatibility for Standalone bouncer
+### Fixed
+- Fix `AbstractBounce:displayCaptchaWall` function
+
 
 ## [0.20.0] - 2022-03-31
 
@@ -15,7 +22,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [0.19.0] - 2022-03-24
 
 ### Added
-
 - Add `excluded_uris` configuration to exclude some uris (was hardcoded to `/favicon.ico`)
 
 ### Changed

docs/DEVELOPER.md

@@ -67,14 +67,14 @@ For a quick start, follow the below steps.
 
 #### DDEV installation
 
-This project is fully compatible with DDEV 1.18.2 and it is recommended to use this specific version.
+This project is fully compatible with DDEV 1.19.1, and it is recommended to use this specific version.
 For the DDEV installation, please follow the [official instructions](https://ddev.readthedocs.io/en/stable/#installation).
 On a Linux distribution, you can run:
 ```
 sudo apt-get -qq update
 sudo apt-get -qq -y install libnss3-tools
 curl -LO https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh
-bash install_ddev.sh v1.18.2
+bash install_ddev.sh v1.19.1
 rm install_ddev.sh
 ```
 

scripts/auto-prepend/bounce.php

@@ -2,15 +2,19 @@
 /**
  * This script is aimed to be called by an auto-prepend directive
  * @see docs/USER_GUIDE.md
+ * @var $crowdSecStandaloneBouncerConfig
  */
 require_once __DIR__ . '/../../vendor/autoload.php';
 require_once __DIR__ . '/settings.php';
 
 use CrowdSecBouncer\StandaloneBounce;
 
-
-
 $bounce = new StandaloneBounce();
+// Retro compatibility with crowdsec php lib < 0.14.0
+if(isset($crowdSecStandaloneBouncerConfig['bouncing_level']) && $crowdSecStandaloneBouncerConfig['bouncing_level'] === 'normal_boucing'){
+    $crowdSecStandaloneBouncerConfig['bouncing_level'] = 'normal_bouncing';
+}elseif($crowdSecStandaloneBouncerConfig['bouncing_level'] === 'flex_boucing'){
+    $crowdSecStandaloneBouncerConfig['bouncing_level'] = 'flex_bouncing';
+}
 
-/** @var $crowdSecStandaloneBouncerConfig */
 $bounce->safelyBounce($crowdSecStandaloneBouncerConfig);

scripts/auto-prepend/refresh-cache.php

@@ -2,15 +2,21 @@
 /**
  * This script is aimed to be called by an auto-prepend directive
  * @see docs/USER_GUIDE.md
+ * @var $crowdSecStandaloneBouncerConfig
  */
 require_once __DIR__ . '/../../vendor/autoload.php';
 require_once __DIR__ . '/settings.php';
 
 use CrowdSecBouncer\StandaloneBounce;
 
 $bounce = new StandaloneBounce();
+// Retro compatibility with crowdsec php lib < 0.14.0
+if(isset($crowdSecStandaloneBouncerConfig['bouncing_level']) && $crowdSecStandaloneBouncerConfig['bouncing_level'] === 'normal_boucing'){
+    $crowdSecStandaloneBouncerConfig['bouncing_level'] = 'normal_bouncing';
+}elseif($crowdSecStandaloneBouncerConfig['bouncing_level'] === 'flex_boucing'){
+    $crowdSecStandaloneBouncerConfig['bouncing_level'] = 'flex_bouncing';
+}
 
-/** @var $crowdSecStandaloneBouncerConfig */
 $bouncer = $bounce->init($crowdSecStandaloneBouncerConfig);
 $bouncer->refreshBlocklistCache();
-echo 'Cache has been refreshed';
+echo 'Cache has been refreshed';

src/AbstractBounce.php

@@ -175,8 +175,8 @@ protected function displayCaptchaWall()
     {
         $options = $this->getCaptchaWallOptions();
         $body = Bouncer::getCaptchaHtmlTemplate(
-            $this->getSessionVariable('crowdsec_captcha_resolution_failed'),
-            $this->getSessionVariable('crowdsec_captcha_inline_image'),
+            (bool) $this->getSessionVariable('crowdsec_captcha_resolution_failed'),
+            (string) $this->getSessionVariable('crowdsec_captcha_inline_image'),
             '',
             $options
         );

src/Bouncer.php

@@ -145,9 +145,11 @@ public static function getAccessForbiddenHtmlTemplate(array $config): string
      * Returns a default "CrowdSec Captcha" HTML template to display to a web browser using a captchable IP.
      * The input $config should match the TemplateConfiguration input format.
      *
-     * @param array $config An array of template configuration parameters
-     *
-     * @return string The HTML compiled template
+     * @param bool $error
+     * @param string $captchaImageSrc
+     * @param string $captchaResolutionFormUrl
+     * @param array $config
+     * @return string
      */
     public static function getCaptchaHtmlTemplate(bool $error, string $captchaImageSrc, string $captchaResolutionFormUrl, array $config): string
     {

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.20.0';
+    public const VERSION = 'v0.20.1';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/'.self::VERSION;