Merge pull request #107 from julienloizelet/feat/twig-templating

Feat/twig templating

Author: julienloizelet

.github/workflows/test-suite.yml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Install DDEV
         env:
-          DDEV_VERSION: v1.20.0
+          DDEV_VERSION: v1.21.1
         run: |
           # @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
           sudo apt-get -qq update

CHANGELOG.md

@@ -4,6 +4,13 @@ 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](http://semver.org/spec/v2.0.0.html).
 
+## [0.31.0](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v0.31.0) - 2022-09-23
+[_Compare with previous release_](https://github.com/crowdsecurity/php-cs-bouncer/compare/v0.30.0...v0.31.0)
+
+### Changed
+- Use Twig as template engine for ban and captcha walls
+
+---
 
 ## [0.30.0](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v0.30.0) - 2022-09-22
 [_Compare with previous release_](https://github.com/crowdsecurity/php-cs-bouncer/compare/v0.29.0...v0.30.0)

composer.json

@@ -39,9 +39,10 @@
         }
     ],
     "require": {
-        "php": "^7.2 || ^8.0",
+        "php": ">=7.2.5",
         "symfony/config": "^4.4.27 || ^5.2 || ^6.0",
         "symfony/cache": "^5.4.11 || ^6.0.11",
+        "twig/twig": "^3.4.2",
         "monolog/monolog": "^1.17 || ^2.1",
         "gregwar/captcha": "^1.1",
         "mlocati/ip-lib": "^1.18",

docs/DEVELOPER.md

@@ -72,14 +72,14 @@ For a quick start, follow the below steps.
 
 #### DDEV installation
 
-This project is fully compatible with DDEV 1.20.0, and it is recommended to use this specific version.
+This project is fully compatible with DDEV 1.21.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.20.0
+bash install_ddev.sh v1.21.1
 rm install_ddev.sh
 ```
 

src/Bouncer.php

@@ -2,9 +2,6 @@
 
 namespace CrowdSecBouncer;
 
-require_once __DIR__ . '/templates/captcha.php';
-require_once __DIR__ . '/templates/access-forbidden.php';
-
 use CrowdSecBouncer\Fixes\Gregwar\Captcha\CaptchaBuilder;
 use CrowdSecBouncer\RestClient\AbstractClient;
 use ErrorException;
@@ -154,7 +151,7 @@ public function getRemediationForIp(string $ip): string
     }
 
     /**
-     * Returns a default "CrowdSec 403" HTML template to display to a web browser using a banned IP.
+     * Returns a default "CrowdSec 403" HTML template.
      * The input $config should match the TemplateConfiguration input format.
      *
      * @param array $config An array of template configuration parameters
@@ -167,16 +164,20 @@ public static function getAccessForbiddenHtmlTemplate(array $config): string
         $configuration = new TemplateConfiguration();
         $processor = new Processor();
         $config = $processor->processConfiguration($configuration, [$config]);
+        $template = new Template('ban.html.twig');
 
-        ob_start();
-        displayAccessForbiddenTemplate($config);
-
-        return ob_get_clean();
+        return $template->render($config);
     }
 
     /**
-     * Returns a default "CrowdSec Captcha" HTML template to display to a web browser using a captchable IP.
+     * Returns a default "CrowdSec Captcha (401)" HTML template.
      * The input $config should match the TemplateConfiguration input format.
+     *
+     * @param bool $error
+     * @param string $captchaImageSrc
+     * @param string $captchaResolutionFormUrl
+     * @param array $config
+     * @return string
      */
     public static function getCaptchaHtmlTemplate(
         bool $error,
@@ -188,11 +189,16 @@ public static function getCaptchaHtmlTemplate(
         $configuration = new TemplateConfiguration();
         $processor = new Processor();
         $config = $processor->processConfiguration($configuration, [$config]);
-
-        ob_start();
-        displayCaptchaTemplate($error, $captchaImageSrc, $captchaResolutionFormUrl, $config);
-
-        return ob_get_clean();
+        $template = new Template('captcha.html.twig');
+
+        return $template->render(array_merge(
+            $config,
+            [
+                    'error' => $error,
+                    'captcha_img' => $captchaImageSrc,
+                    'captcha_resolution_url' => $captchaResolutionFormUrl
+                ]
+        ));
     }
 
     /**

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.30.0';
+    public const VERSION = 'v0.31.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/' . self::VERSION;
@@ -105,4 +105,7 @@ class Constants
 
     /** @var string The "disabled" x-forwarded-for setting */
     public const X_FORWARDED_DISABLED = 'no_forward';
+
+    /** @var string Path for html templates folder (e.g. ban and captcha wall) */
+    public const TEMPLATES_DIR = __DIR__ . "/templates";
 }

src/Template.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace CrowdSecBouncer;
+
+use Twig\Error\LoaderError;
+use Twig\Error\RuntimeError;
+use Twig\Error\SyntaxError;
+use Twig\Loader\FilesystemLoader;
+use Twig\Environment;
+use Twig\TemplateWrapper;
+
+/**
+ * The template engine.
+ *
+ * @author    CrowdSec team
+ *
+ * @see      https://crowdsec.net CrowdSec Official Website
+ *
+ * @copyright Copyright (c) 2020+ CrowdSec
+ * @license   MIT License
+ */
+class Template
+{
+    /** @var TemplateWrapper */
+    private $template;
+
+    /**
+     * @param string $path
+     * @param string $templatesDir
+     * @param array $options
+     * @throws LoaderError
+     * @throws RuntimeError
+     * @throws SyntaxError
+     */
+    public function __construct(string $path, string $templatesDir = Constants::TEMPLATES_DIR, array $options = [])
+    {
+        $loader = new FilesystemLoader($templatesDir);
+        $env = new Environment($loader, $options);
+        $this->template = $env->load($path);
+    }
+
+    public function render(array $config = []): string
+    {
+        return $this->template->render(['config' => $config]);
+    }
+}

src/templates/_base.php

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    {% include('partials/head.html.twig') with {'tab_title': config.text.ban_wall.tab_title} %}
+</head>
+<body>
+<div class="container">
+    <div class="main">
+        <h1>{{ config.text.ban_wall.title | e }}</h1>
+        <p class="desc">{{ config.text.ban_wall.subtitle }}</p>
+        {% if config.text.ban_wall.footer is not empty %}
+            <p class="footer">{{ config.text.ban_wall.footer | e }}</p>
+        {% endif %}
+        {% if config.hide_crowdsec_mentions is empty %}
+            {% include('partials/mentions.html.twig') %}
+        {% endif %}
+    </div>
+</div>
+</body>
+</html>