Merge branch 'release/8.1.0'

rhukster · rhukster · commit 0bee90894fb0 · 2025-11-03T23:52:27.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+# v8.1.0
+## 11/03/2025
+
+1. [](#bugfix)
+    - Fixed an issue with DropZone file field with `js_pipeline` enabled [#621](https://github.com/getgrav/grav-plugin-form/issues/621)
+    - Fixed general pipeline issues with form javascript
+1. [](#improved)
+    - Added a field-based configuration of basic-captcha [#622](https://github.com/getgrav/grav-plugin-form/issues/622)
+    - Improved filesize min/max error handling
+
 # v8.0.6
 ## 10/07/2025
 
diff --git a/assets/captcha/basic-captcha-refresh.js b/assets/captcha/basic-captcha-refresh.js
@@ -9,10 +9,17 @@
             return;
         }
 
-        // Force reload by adding/updating timestamp
+        // Get the base URL and field ID
+        const baseUrl = img.dataset.baseUrl || img.src.split('?')[0];
+        const fieldId = img.dataset.fieldId || container.dataset.fieldId;
+
+        // Force reload by adding/updating timestamp and field ID
         const timestamp = new Date().getTime();
-        const baseUrl = img.src.split('?')[0];
-        img.src = baseUrl + '?t=' + timestamp;
+        let newUrl = baseUrl + '?t=' + timestamp;
+        if (fieldId) {
+            newUrl += '&field=' + fieldId;
+        }
+        img.src = newUrl;
 
         // Also clear the input field if we can find it
         const formField = container.closest('.form-field');
diff --git a/blueprints.yaml b/blueprints.yaml
@@ -1,7 +1,7 @@
 name: Form
 slug: form
 type: plugin
-version: 8.0.6
+version: 8.1.0
 description: Enables forms handling and processing
 icon: check-square
 author:
diff --git a/classes/Captcha/BasicCaptcha.php b/classes/Captcha/BasicCaptcha.php
@@ -8,27 +8,42 @@ class BasicCaptcha
 {
     protected $session = null;
     protected $key = 'basic_captcha_value';
+    protected $typeKey = 'basic_captcha_type';
+    protected $config = null;
 
-    public function __construct()
+    public function __construct($fieldConfig = null)
     {
         $this->session = Grav::instance()['session'];
+
+        // Load global configuration
+        $globalConfig = Grav::instance()['config']->get('plugins.form.basic_captcha', []);
+
+        // Merge field-specific config with global config
+        if ($fieldConfig && is_array($fieldConfig)) {
+            $this->config = array_replace_recursive($globalConfig, $fieldConfig);
+        } else {
+            $this->config = $globalConfig;
+        }
     }
 
     public function getCaptchaCode($length = null): string
     {
-        $config = Grav::instance()['config']->get('plugins.form.basic_captcha');
-        $type = $config['type'] ?? 'characters';
+        // Support both 'type' (from global config) and 'captcha_type' (from field config)
+        $type = $this->config['captcha_type'] ?? $this->config['type'] ?? 'characters';
+
+        // Store the captcha type in session for validation
+        $this->setSession($this->typeKey, $type);
 
         switch ($type) {
             case 'dotcount':
-                return $this->getDotCountCaptcha($config);
+                return $this->getDotCountCaptcha($this->config);
             case 'position':
-                return $this->getPositionCaptcha($config);
+                return $this->getPositionCaptcha($this->config);
             case 'math':
-                return $this->getMathCaptcha($config);
+                return $this->getMathCaptcha($this->config);
             case 'characters':
             default:
-                return $this->getCharactersCaptcha($config, $length);
+                return $this->getCharactersCaptcha($this->config, $length);
         }
     }
 
@@ -158,15 +173,37 @@ public function getSession($key = null): ?string
      */
     public function createCaptchaImage($captcha_code)
     {
-        $config = Grav::instance()['config']->get('plugins.form.basic_captcha');
-        $width = $config['image']['width'] ?? 135;
-        $height = $config['image']['height'] ?? 40;
+        // Determine image dimensions based on type
+        $isCharacterCaptcha = false;
+        if (strpos($captcha_code, '|') === false && !preg_match('/[\+\-x]/', $captcha_code)) {
+            $isCharacterCaptcha = true;
+        }
+
+        // Use box_width/box_height for character captchas if specified, otherwise use default image dimensions
+        if ($isCharacterCaptcha && isset($this->config['chars']['box_width'])) {
+            $width = $this->config['chars']['box_width'];
+        } else {
+            $width = $this->config['image']['width'] ?? 135;
+        }
+
+        if ($isCharacterCaptcha && isset($this->config['chars']['box_height'])) {
+            $height = $this->config['chars']['box_height'];
+        } else {
+            $height = $this->config['image']['height'] ?? 40;
+        }
 
         // Create a blank image
         $image = imagecreatetruecolor($width, $height);
 
-        // Set background color
-        $bg = $this->hexToRgb($config['image']['bg'] ?? '#ffffff');
+        // Set background color (support both image.bg and chars.bg for character captchas)
+        $bgColor = '#ffffff';
+        if ($isCharacterCaptcha && isset($this->config['chars']['bg'])) {
+            $bgColor = $this->config['chars']['bg'];
+        } elseif (isset($this->config['image']['bg'])) {
+            $bgColor = $this->config['image']['bg'];
+        }
+
+        $bg = $this->hexToRgb($bgColor);
         $backgroundColor = imagecolorallocate($image, $bg[0], $bg[1], $bg[2]);
         imagefill($image, 0, 0, $backgroundColor);
 
@@ -177,16 +214,16 @@ public function createCaptchaImage($captcha_code)
 
             switch ($type) {
                 case 'count_dots':
-                    return $this->createDotCountImage($image, $parts, $config);
+                    return $this->createDotCountImage($image, $parts, $this->config);
                 case 'position':
-                    return $this->createPositionImage($image, $parts, $config);
+                    return $this->createPositionImage($image, $parts, $this->config);
             }
         } else {
             // Assume it's a character or math captcha if no type indicator
             if (preg_match('/[\+\-x]/', $captcha_code)) {
-                return $this->createMathImage($image, $captcha_code, $config);
+                return $this->createMathImage($image, $captcha_code, $this->config);
             } else {
-                return $this->createCharacterImage($image, $captcha_code, $config);
+                return $this->createCharacterImage($image, $captcha_code, $this->config);
             }
         }
 
@@ -408,21 +445,28 @@ protected function createCharacterImage($image, $captcha_code, $config)
         $width = imagesx($image);
         $height = imagesy($image);
 
-        // Get font settings
+        // Get font settings with support for custom box dimensions, position, and colors
         $fontPath = __DIR__.'/../../fonts/'.($config['chars']['font'] ?? 'zxx-xed.ttf');
         $fontSize = $config['chars']['size'] ?? 16;
-        $textColor = imagecolorallocate($image, 0, 0, 0);
+
+        // Support custom text color (defaults to black)
+        $textColorHex = $config['chars']['text'] ?? '#000000';
+        $textRgb = $this->hexToRgb($textColorHex);
+        $textColor = imagecolorallocate($image, $textRgb[0], $textRgb[1], $textRgb[2]);
+
+        // Support custom start position (useful for fine-tuning text placement)
+        $startX = $config['chars']['start_x'] ?? ($width / (strlen($captcha_code) + 2));
+        $baseY = $config['chars']['start_y'] ?? ($height / 2 + 5);
 
         // Draw each character with random rotation and position
         $charWidth = $width / (strlen($captcha_code) + 2);
-        $startX = $charWidth; // Leave some space at the beginning
 
         for ($i = 0; $i < strlen($captcha_code); $i++) {
             $char = $captcha_code[$i];
             $angle = mt_rand(-15, 15); // Random rotation
 
-            // Random vertical position
-            $y = mt_rand($height / 2 - 5, $height / 2 + 5);
+            // Random vertical position with custom base Y
+            $y = $baseY + mt_rand(-5, 5);
 
             imagettftext($image, $fontSize, $angle, $startX, $y, $textColor, $fontPath, $char);
 
diff --git a/classes/Captcha/BasicCaptchaProvider.php b/classes/Captcha/BasicCaptchaProvider.php
@@ -29,6 +29,9 @@ public function validate(array $form, array $params = []): array
             // Make sure to use the same session key that the image generation code uses
             $expectedValue = $session->basic_captcha_value ?? null; // Changed from basic_captcha to basic_captcha_value
 
+            // Get the captcha type from session (stored during generation)
+            $captchaType = $session->basic_captcha_type ?? null;
+
             // Get the user's answer
             $userValue = $form['basic-captcha'] ?? null;
 
@@ -48,13 +51,16 @@ public function validate(array $form, array $params = []): array
                 ];
             }
 
-            // Compare the values (case-insensitive string comparison for character captchas)
-            $captchaType = $this->config['type'] ?? 'math';
+            // Compare the values based on the type stored in session
+            // If type is not in session, try to infer from global/field config
+            if (!$captchaType) {
+                $captchaType = $this->config['captcha_type'] ?? $this->config['type'] ?? 'characters';
+            }
 
             if ($captchaType === 'characters') {
                 $isValid = strtolower((string)$userValue) === strtolower((string)$expectedValue);
             } else {
-                // For math, ensure both are treated as integers
+                // For math, dotcount, position - ensure both are treated as integers or exact match
                 $isValid = (int)$userValue === (int)$expectedValue;
             }
 
@@ -69,8 +75,9 @@ public function validate(array $form, array $params = []): array
                 ];
             }
 
-            // Clear the session value to prevent reuse
+            // Clear the session values to prevent reuse
             $session->basic_captcha_value = null;
+            $session->basic_captcha_type = null;
 
             return [
                 'success' => true
@@ -89,14 +96,31 @@ public function validate(array $form, array $params = []): array
      */
     public function getClientProperties(string $formId, array $field): array
     {
-        $captchaType = $field['basic_captcha_type'] ?? $this->config['type'] ?? 'math';
+        $grav = Grav::instance();
+        $session = $grav['session'];
+
+        // Merge field-level configuration with global defaults
+        $fieldConfig = array_replace_recursive($this->config, $field);
+
+        // Remove non-config keys from field array
+        unset($fieldConfig['type'], $fieldConfig['label'], $fieldConfig['placeholder'],
+              $fieldConfig['validate'], $fieldConfig['name'], $fieldConfig['classes']);
+
+        // Generate unique field ID for this form/field combination
+        $fieldId = md5($formId . '_basic_captcha_' . ($field['name'] ?? 'default'));
+
+        // Store field configuration in session for image generation
+        $session->{"basic_captcha_config_{$fieldId}"} = $fieldConfig;
+
+        $captchaType = $fieldConfig['type'] ?? 'math';
 
         return [
             'provider' => 'basic-captcha',
             'type' => $captchaType,
-            'imageUrl' => '/forms-basic-captcha-image.jpg',
+            'imageUrl' => "/forms-basic-captcha-image.jpg?field={$fieldId}",
             'refreshable' => true,
-            'containerId' => "basic-captcha-{$formId}"
+            'containerId' => "basic-captcha-{$formId}",
+            'fieldId' => $fieldId
         ];
     }
 
diff --git a/form.php b/form.php
@@ -398,6 +398,14 @@ public function onTwigExtensions(): void
         $twig->addFunction(new TwigFunction('captcha_template_exists', function ($template) use ($twig) {
             return $twig->getLoader()->exists($template);
         }));
+
+        // Add function to store basic captcha configuration in session
+        $twig->addFunction(new TwigFunction('store_basic_captcha_config', function ($fieldId, $config) {
+            $session = $this->grav['session'];
+            $sessionKey = "basic_captcha_config_{$fieldId}";
+            $session->{$sessionKey} = $config;
+            return true;
+        }));
     }
 
     /**
@@ -1242,7 +1250,19 @@ protected function udate($format = 'u', $raw = false)
     protected function processBasicCaptchaImage(Uri $uri): void
     {
         if ($uri->path() === '/forms-basic-captcha-image.jpg') {
-            $captcha = new BasicCaptcha();
+            // Get field ID from query parameter
+            $fieldId = $_GET['field'] ?? null;
+            $fieldConfig = null;
+
+            // Retrieve field-specific configuration from session if available
+            if ($fieldId) {
+                $session = $this->grav['session'];
+                $sessionKey = "basic_captcha_config_{$fieldId}";
+                $fieldConfig = $session->{$sessionKey} ?? null;
+            }
+
+            // Create captcha with field-specific or global config
+            $captcha = new BasicCaptcha($fieldConfig);
             $code = $captcha->getCaptchaCode();
             $image = $captcha->createCaptchaImage($code);
             $captcha->renderCaptchaImage($image);
diff --git a/templates/forms/fields/basic-captcha/basic-captcha.html.twig b/templates/forms/fields/basic-captcha/basic-captcha.html.twig
@@ -3,9 +3,24 @@
 {% extends "forms/field.html.twig" %}
 
 {% block prepend %}
-    <div class="form-input-addon form-input-prepend" data-captcha-provider="basic-captcha">
-        <img id="basic-captcha-reload-{{ form.id }}" src="{{ url('/forms-basic-captcha-image.jpg') }}" alt="human test" />
-        <button type="button" id="reload-captcha-{{ form.id }}" class="reload-captcha-button"><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><g fill="currentColor"><path d="M14.74 22.39c4.68-1.24 8-5.49 8-10.4 0-5.95-4.79-10.75-10.75-10.75 -3.11 0-5.78 1.11-7.99 2.95 -.77.64-1.43 1.32-1.98 2.01 -.34.41-.57.75-.69.95 -.22.35-.1.81.25 1.02 .35.21.81.09 1.02-.26 .08-.15.27-.43.56-.79 .49-.62 1.08-1.23 1.76-1.81C6.87 3.67 9.21 2.7 11.94 2.7c5.13 0 9.25 4.12 9.25 9.25 0 4.22-2.86 7.88-6.9 8.94 -.41.1-.64.51-.54.91 .1.4.51.63.91.53Zm-12-14.84V2.99c-.001-.42-.34-.75-.75-.75 -.42 0-.75.33-.75.75v4.56c0 .41.33.75.75.75 .41 0 .75-.34.75-.75Zm-.75.75H4h2.43c.41 0 .75-.34.75-.75 0-.42-.34-.75-.75-.75H4 1.99c-.42 0-.75.33-.75.75 0 .41.33.75.75.75Z"/><path d="M1.25 12c0 1.09.16 2.16.48 3.18 .12.39.54.61.93.49 .39-.13.61-.55.49-.94 -.28-.89-.42-1.81-.42-2.75 0-.42-.34-.75-.75-.75 -.42 0-.75.33-.75.75Zm1.93 6.15c.61.88 1.36 1.67 2.22 2.33 .32.25.79.19 1.05-.14 .25-.33.19-.8-.14-1.06 -.74-.58-1.38-1.25-1.92-2.02 -.24-.34-.71-.43-1.05-.19 -.34.23-.43.7-.19 1.04Zm5.02 3.91c1 .37 2.06.6 3.15.66 .41.02.76-.3.79-.71 .02-.42-.3-.77-.71-.8 -.94-.06-1.85-.25-2.72-.58 -.39-.15-.83.04-.97.43 -.15.38.04.82.43.96Z"/></g></svg></button>
+    {% set field_id = field.name|default('default') %}
+    {% set config_hash = (form.id ~ '_basic_captcha_' ~ field_id)|md5 %}
+    {% set image_url = url('/forms-basic-captcha-image.jpg') ~ '?field=' ~ config_hash %}
+
+    {# Store field configuration in session for image generation #}
+    {% set global_config = grav.config.get('plugins.form.basic_captcha', {}) %}
+    {% set merged_config = global_config|merge(field) %}
+    {% do store_basic_captcha_config(config_hash, merged_config) %}
+
+    <div class="form-input-addon form-input-prepend"
+         data-captcha-provider="basic-captcha"
+         data-field-id="{{ config_hash }}">
+        <img id="basic-captcha-reload-{{ form.id }}"
+             src="{{ image_url }}"
+             alt="human test"
+             data-base-url="{{ url('/forms-basic-captcha-image.jpg') }}"
+             data-field-id="{{ config_hash }}" />
+        <button type="button" id="reload-captcha-{{ form.id }}" class="reload-captcha-button"><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><g fill="currentColor"><path d="M14.74 22.39c4.68-1.24 8-5.49 8-10.4 0-5.95-4.79-10.75-10.75-10.75 -3.11 0-5.78 1.11-7.99 2.95 -.77.64-1.43 1.32-1.98 2.01 -.34.41-.57.75-.69.95 -.22.35-.1.81.25 1.02 .35.21.81.09 1.02-.26 .08-.15.27-.43.56-.79 .49-.62 1.08-1.23 1.76-1.81C6.87 3.67 9.21 2.7 11.94 2.7c5.13 0 9.25 4.12 9.25 9.25 0 4.22-2.86 7.88-6.9 8.94 -.41.1-.64.51-.54.91 .1.4.51.63.91.53Zm-12-14.84V2.99c-.001-.42-.34-.75-.75-.75 -.42 0-.75.33-.75.75v4.56c0 .41.33.75.75.75 .41 0 .75-.34.75-.75Zm-.75.75H4h2.43c.41 0 .75-.34.75-.75 0-.42-.34-.75-.75-.75H4 1.99c-.42 0-.75.33-.75.75 0 .41.33.75.75.75Z"/><path d="M1.25 12c0 1.09.16 2.16.48 3.18 .12.39.54.61.93.49 .39-.13.61-.55.49-.94 -.28-.89-.42-1.81-.42-2.75 0-.42-.34-.75-.75-.75 -.42 0-.75.33-.75.75Zm1.93 6.15c.61.88 1.36 1.67 2.22 2.33 .32.25.79.19 1.05-.14 .25-.33.19-.8-.14-1.06 -.74-.58-1.38-1.25-1.92-2.02 -.24-.34-.71-.43-1.05-.19 -.34.23-.43.7-.19 1.04Zm5.02 3.91c1 .37 2.06.6 3.15.66 .41.02.76-.3.79-.71 .02-.42-.30-.77-.71-.80 -.94-.06-1.85-.25-2.72-.58 -.39-.15-.83.04-.97.43 -.15.38.04.82.43.96Z"/></g></svg></button>
     </div>
 
     {% do assets.addJs('plugin://form/assets/captcha/basic-captcha-refresh.js') %}
@@ -17,4 +32,4 @@
     {% if field.minlength is defined or field.validate.min is defined %}minlength="{{ field.minlength | default(field.validate.min) }}"{% endif %}
     {% if field.maxlength is defined or field.validate.max is defined %}maxlength="{{ field.maxlength | default(field.validate.max) }}"{% endif %}
     {{ parent() }}
-{% endblock %}
+{% endblock %}
