style(*): Pass through phpcsfixer for scripts folder

Author: julienloizelet

scripts/auto-prepend/bounce.php

@@ -1,7 +1,9 @@
 <?php
 /**
- * This script is aimed to be called by an auto-prepend directive
+ * 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';
@@ -10,10 +12,4 @@
 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';
-}
-$bounce->safelyBounce($crowdSecStandaloneBouncerConfig);
+$bounce->safelyBounce($crowdSecStandaloneBouncerConfig);

scripts/auto-prepend/refresh-cache.php

@@ -1,7 +1,9 @@
 <?php
 /**
- * This script is aimed to be called by an auto-prepend directive
+ * 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';
@@ -10,13 +12,7 @@
 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';
-}
 $bounce->initLogger($crowdSecStandaloneBouncerConfig);
 $bouncer = $bounce->init($crowdSecStandaloneBouncerConfig);
 $bouncer->refreshBlocklistCache();
-echo 'Cache has been refreshed'.PHP_EOL;
+echo 'Cache has been refreshed' . \PHP_EOL;

scripts/auto-prepend/settings.example.php

@@ -1,17 +1,17 @@
 <?php
+
 // @see ../../docs/USER_GUIDE.md for possible settings details
 use CrowdSecBouncer\Constants;
 
 $crowdSecStandaloneBouncerConfig = [
-
-    /** Select from 'api_key' and 'tls'
+    /** Select from 'api_key' and 'tls'.
      *
      * Choose if you want to use an API-KEY or a TLS (pki) authentification
      * TLS authentication is only available if you use CrowdSec agent with a version superior to 1.4.0
      */
     'auth_type' => Constants::AUTH_KEY,
 
-    /** Absolute path to the bouncer certificate
+    /** Absolute path to the bouncer certificate.
      *
      * Only required if you choose tls as "auth_type"
      */
@@ -29,11 +29,10 @@
      * If "tls_verify_peer" is set to true, request handler verifies whether the certificate is authentic.
      * This trust is based on a chain of digital signatures,
      * rooted in certification authority (CA) certificates you supply using the "tls_ca_cert_path" setting below.
-     *
      */
     'tls_verify_peer' => true,
 
-    /** Absolute path to the CA used to process peer verification
+    /** Absolute path to the CA used to process peer verification.
      *
      * Only required if you choose tls as "auth_type" and "tls_verify_peer" is true
      */
@@ -43,25 +42,22 @@
      *
      * Key generated by the cscli (CrowdSec cli) command like "cscli bouncers add bouncer-php-library"
      * Only required if you choose api_key as "auth_type"
-     *
      */
     'api_key' => 'YOUR_BOUNCER_API_KEY',
 
     /** Define the URL to your LAPI server, default to http://localhost:8080.
      *
      * If you have installed the CrowdSec agent on your server, it should be "http://localhost:8080" or
      * "https://localhost:8080"
-     *
      */
-    'api_url'=> Constants::DEFAULT_LAPI_URL,
+    'api_url' => Constants::DEFAULT_LAPI_URL,
 
     // In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
-    'api_timeout'=> 1,
+    'api_timeout' => 1,
 
     /**
      * By default, the lib call the REST LAPI using file_get_contents method (allow_url_fopen is required).
-     * Set 'use_curl' to true in order to use cURL request instead (curl is in then required)
-     *
+     * Set 'use_curl' to true in order to use cURL request instead (curl is in then required).
      */
     'use_curl' => false,
 
@@ -74,7 +70,7 @@
      *
      * Important note: be sur this path won't be publicly accessible
      */
-    'log_directory_path' => __DIR__.'/.logs',
+    'log_directory_path' => __DIR__ . '/.logs',
 
     // true to stop the process and display errors if any.
     'display_errors' => false,
@@ -89,7 +85,6 @@
      *
      * If not empty, it will be used instead of the real forwarded ip.
      * If set to "no_forward", the x-forwarded-for mechanism will not be used at all.
-     *
      */
     'forced_test_forwarded_ip' => '',
 
@@ -107,14 +102,14 @@
      *
      * Handle unknown remediations as.
      */
-    'fallback_remediation'=> Constants::REMEDIATION_CAPTCHA,
+    'fallback_remediation' => Constants::REMEDIATION_CAPTCHA,
 
     /** Select from 'bypass' (minimum remediation),'captcha' or 'ban' (maximum remediation).
      * Default to 'ban'.
      *
      * Cap the remediation to the selected one.
      */
-    'max_remediation_level'=> Constants::REMEDIATION_BAN,
+    'max_remediation_level' => Constants::REMEDIATION_BAN,
 
     /** If you use a CDN, a reverse proxy or a load balancer, set an array of IPs.
      *
@@ -123,18 +118,18 @@
     'trust_ip_forward_array' => [],
 
     /**
-     * array of URIs that will not be bounced
+     * array of URIs that will not be bounced.
      */
     'excluded_uris' => ['/favicon.ico'],
 
     // Select from 'phpfs' (File system cache), 'redis' or 'memcached'.
     'cache_system' => Constants::CACHE_SYSTEM_PHPFS,
 
-    /** Will be used only if you choose File system as cache_system
+    /** Will be used only if you choose File system as cache_system.
      *
      * Important note: be sur this path won't be publicly accessible
      */
-    'fs_cache_path' => __DIR__.'/.cache',
+    'fs_cache_path' => __DIR__ . '/.cache',
 
     // Will be used only if you choose Redis cache as cache_system
     'redis_dsn' => 'redis://localhost:6379',
@@ -143,16 +138,16 @@
     'memcached_dsn' => 'memcached://localhost:11211',
 
     // Set the duration we keep in cache the fact that an IP is clean. In seconds. Defaults to 5.
-    'clean_ip_cache_duration'=> Constants::CACHE_EXPIRATION_FOR_CLEAN_IP,
+    'clean_ip_cache_duration' => Constants::CACHE_EXPIRATION_FOR_CLEAN_IP,
 
     // Set the duration we keep in cache the fact that an IP is bad. In seconds. Defaults to 20.
-    'bad_ip_cache_duration'=> Constants::CACHE_EXPIRATION_FOR_BAD_IP,
+    'bad_ip_cache_duration' => Constants::CACHE_EXPIRATION_FOR_BAD_IP,
 
     // Set the duration we keep in cache the captcha flow variables for an IP. In seconds. Defaults to 86400.
-    'captcha_cache_duration'=> Constants::CACHE_EXPIRATION_FOR_CAPTCHA,
+    'captcha_cache_duration' => Constants::CACHE_EXPIRATION_FOR_CAPTCHA,
 
     // Set the duration we keep in cache a geolocation result for an IP . In seconds. Defaults to 86400.
-    'geolocation_cache_duration'=> Constants::CACHE_EXPIRATION_FOR_GEO,
+    'geolocation_cache_duration' => Constants::CACHE_EXPIRATION_FOR_GEO,
 
     /** true to enable stream mode, false to enable the live mode. Default to false.
      *
@@ -165,7 +160,7 @@
      * visitors. Besides, if your site has a lot of unique visitors at the same time, this will not influence the
      * traffic to the API of your CrowdSec instance.
      */
-    'stream_mode'=> false,
+    'stream_mode' => false,
 
     // Settings for geolocation remediation (i.e. country based remediation).
     'geolocation' => [
@@ -187,10 +182,10 @@
             'database_type' => Constants::MAXMIND_COUNTRY,
             // Absolute path to the MaxMind database (mmdb file).
             'database_path' => '/some/path/GeoLite2-Country.mmdb',
-        ]
+        ],
     ],
 
-    //true to hide CrowdSec mentions on ban and captcha walls.
+    // true to hide CrowdSec mentions on ban and captcha walls.
     'hide_mentions' => false,
 
     // Settings for ban and captcha walls

scripts/public/protected-page.php

@@ -13,4 +13,4 @@
     <p>In this example page, if you can see this text, the bouncer considers your IP as clean.</p>
 </body>
 </html>
-';
+';

tools/coding-standards/php-cs-fixer/.php-cs-fixer.dist.php

@@ -23,5 +23,6 @@
         PhpCsFixer\Finder::create()
             ->in(__DIR__ . '/../../../src')->exclude(['templates'])
             ->in(__DIR__ . '/../../../tests/Integration')->depth(1)
+            ->in(__DIR__ . '/../../../scripts')
     )
 ;