Add file uploaded error message and enctype

Author: bencroker

.github/workflows/code-analysis.yaml

@@ -17,7 +17,7 @@ jobs:
           - name: 'PHPStan'
             run: composer phpstan
           - name: 'Coding Standards'
-            run: composer fix-cs
+            run: composer check-cs
     name: ${{ matrix.actions.name }}
     runs-on: ubuntu-latest
     steps:

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Release Notes for Snaptcha
 
-## 5.0.0 - 2024-04-08
+## 5.1.0 - Unreleased
+
+- Added an error message that is displayed if Snaptcha identifies a submission as spam when a file is uploaded, in which case the user must go back and resubmit their data ([#32](https://github.com/putyourlightson/craft-snaptcha/issues/32)).
+- Added the ability to maintain the encoding type of the submitted form on the error page.
 
-### Added
+## 5.0.0 - 2024-04-08
 
 - Added compatibility with Craft 5.

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "putyourlightson/craft-snaptcha",
   "description": "Automatically validates forms and prevents spam bots from submitting to your site.",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "type": "craft-plugin",
   "homepage": "https://putyourlightson.com/plugins/snaptcha",
   "license": "proprietary",

src/Snaptcha.php

@@ -179,6 +179,8 @@ public function validateField(ActionEvent $event): void
         if (!$this->snaptcha->validateField($value, $event->action)) {
             $variables = [
                 'settings' => $this->settings,
+                'hasFileUpload' => $this->snaptcha->hasFileUpload(),
+                'encodingType' => $this->snaptcha->getEncodingType(),
                 'postedValues' => $this->snaptcha->getPostedValues(),
             ];
 

src/config.php

@@ -40,6 +40,9 @@
         // The message that will be displayed if Snaptcha identifies a submission as spam.
         //'errorMessage' => 'For some reason your submission was flagged as spam. Please click the button below to resubmit your data.'
 
+        // The message that will be displayed when a file is uploaded, in which case the user must go back and resubmit their data.
+        //'errorMessageFileUploaded' => 'For some reason your submission was flagged as spam. Since a file was uploaded, you must go back and resubmit your data.'
+
         // The error that will be displayed if Snaptcha identifies a submission as spam and JavaScript is disabled.
         //'errorJavascriptDisabled' => 'JavaScript must be enabled for your submission to be verified. Please enable it and refresh the page.'
 

src/models/SettingsModel.php

@@ -49,6 +49,11 @@ class SettingsModel extends Model
      */
     public string $errorMessage = 'For some reason your submission was flagged as spam. Please click the button below to resubmit your data.';
 
+    /**
+     * @var string
+     */
+    public string $errorMessageFileUploaded = 'For some reason your submission was flagged as spam. Since a file was uploaded, you must go back and resubmit your data.';
+
     /**
      * @var string
      */

src/services/SnaptchaService.php

@@ -68,12 +68,22 @@ public function getFieldValue(SnaptchaModel $model): ?string
         return $record ? $record->value : null;
     }
 
+    /**
+     * Returns the encoding type of the request.
+     */
+    public function getEncodingType(): string
+    {
+        $contentType = Craft::$app->getRequest()->getHeaders()->get('Content-Type');
+
+        return is_string($contentType) ? $contentType : '';
+    }
+
     /**
      * Returns flattened posted values.
      */
     public function getPostedValues(): array
     {
-        $values = Craft::$app->request->getBodyParams();
+        $values = Craft::$app->getRequest()->getBodyParams();
 
         if (isset($values[Snaptcha::$plugin->settings->fieldName])) {
             unset($values[Snaptcha::$plugin->settings->fieldName]);
@@ -82,6 +92,14 @@ public function getPostedValues(): array
         return $this->flattenValues($values);
     }
 
+    /**
+     * Returns whether the request has a file upload.
+     */
+    public function hasFileUpload(): bool
+    {
+        return !empty($_FILES) && $_FILES['file']['error'] === UPLOAD_ERR_OK;
+    }
+
     /**
      * Returns whether the controller action is excluded from validation.
      */

src/templates/_error.twig

@@ -10,24 +10,28 @@
     <h2>{{ settings.errorTitle }}</h2>
 
     <p id="error" class="hidden">
-        {{ settings.errorMessage }}
+        {{ hasFileUpload ? settings.errorMessageFileUpload : settings.errorMessage }}
     </p>
 
     <p id="warning" class="warning">
         {{ settings.errorJavascriptDisabled }}
     </p>
 
-    <form action="" method="post">
-        {% for name, value in postedValues %}
-            {{ hiddenInput(name, value) }}
-        {% endfor %}
-
-        {{ craft.snaptcha.field }}
-
-        <button id="resubmit" type="submit" class="btn submit disabled" data-timeout="{{ settings.minimumSubmitTime }}">
-            {{ settings.errorButtonText }}
-        </button>
-        <div id="graphic" class="spinner hidden"></div>
-    </form>
+    {% if hasFileUpload %}
+        <button onclick="history.back()" class="btn submit">Back</button>
+    {% else %}
+        <form action="" method="post" enctype="{{ encodingType }}">
+            {% for name, value in postedValues %}
+                {{ hiddenInput(name, value) }}
+            {% endfor %}
+
+            {{ craft.snaptcha.field }}
+
+            <button id="resubmit" type="submit" class="btn submit disabled" data-timeout="{{ settings.minimumSubmitTime }}">
+                {{ settings.errorButtonText }}
+            </button>
+            <div id="graphic" class="spinner hidden"></div>
+        </form>
+    {% endif %}
 
 {% endblock %}

src/templates/_settings.twig

@@ -76,6 +76,16 @@
     errors: settings.getErrors('errorMessage')
 }) }}
 
+{{ forms.textField({
+    required: true,
+    label: 'Error Message File Uploaded'|t('snaptcha'),
+    name: 'errorMessageFileUploaded',
+    instructions: 'The message that will be displayed when a file is uploaded, in which case the user must go back and resubmit their data.'|t('snaptcha'),
+    warning: (config.errorMessageFileUploaded is defined ? configWarning('errorMessageFileUploaded')),
+    value: settings.errorMessageFileUploaded,
+    errors: settings.getErrors('errorMessageFileUploaded')
+}) }}
+
 {{ forms.textField({
     required: true,
     label: 'Error JavaScript Disabled'|t('snaptcha'),