Double-Opt-In Feature (#470)

Author: solverat

README.md

@@ -53,7 +53,8 @@ Nothing to tell here, it's just [Symfony](https://symfony.com/doc/current/templa
 ## Further Information
 - [Usage (Rendering Types, Configuration)](docs/0_Usage.md)
   - [Headless Mode](docs/1_HeadlessMode.md)
-- [SPAM Protection (Honeypot, reCAPTCHA)](docs/03_SpamProtection.md)
+- [SPAM Protection](docs/03_SpamProtection.md)
+  - [Double-Opt-In Feature](docs/03_SpamProtection.md)
 - [Output Workflows](docs/OutputWorkflow/0_Usage.md)
   - [API Channel](docs/OutputWorkflow/09_ApiChannel.md)
   - [Email Channel](docs/OutputWorkflow/10_EmailChannel.md)

UPGRADE.md

@@ -1,6 +1,8 @@
 # Upgrade Notes
 
 ## 5.1.0
+- **[SECURITY FEATURE]** Double-Opt-In Feature, read more about it [here](/docs/.md)
+  - If you're using a custom form theme, please include the `instructions` type (`{% use '@FormBuilder/form/theme/type/instructions.html.twig' %}`)
 - **[SECURITY FEATURE]** Add [friendly captcha field](/docs/03_SpamProtection.md#friendly-captcha)
 - **[SECURITY FEATURE]** Add [cloudflare turnstile](/docs/03_SpamProtection.md#cloudflare-turnstile)
 - **[BUGFIX]** Use Pimcore AdminUserTranslator for Editable Dialog Box [#450](https://github.com/dachcom-digital/pimcore-formbuilder/issues/450)

config/doctrine/model/DoubleOptInSession.orm.yml

@@ -0,0 +1,49 @@
+FormBuilderBundle\Model\DoubleOptInSession:
+    type: entity
+    table: formbuilder_double_opt_in_session
+    indexes:
+        token_form:
+            columns: [ token, form_definition, applied ]
+    id:
+        token:
+            unique: true
+            column: token
+            type: uuid
+            generator:
+                strategy: CUSTOM
+            customIdGenerator:
+                class: Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator
+    fields:
+        email:
+            column: email
+            type: string
+            nullable: false
+            length: 190
+        additionalData:
+            column: additional_data
+            type: array
+            nullable: true
+        dispatchLocation:
+            column: dispatch_location
+            type: text
+            nullable: true
+        applied:
+            column: applied
+            type: boolean
+            options:
+                default: 0
+        creationDate:
+            column: creationDate
+            type: datetime
+            nullable: false
+    manyToOne:
+        formDefinition:
+            targetEntity: FormBuilderBundle\Model\FormDefinition
+            orphanRemoval: true
+            joinColumn:
+                name: form_definition
+                referencedColumnName: id
+                onDelete: CASCADE
+    uniqueConstraints:
+        email_form_definition:
+            columns: [email, form_definition, applied]

config/doctrine/model/FormDefinition.orm.yml

@@ -33,10 +33,6 @@ FormBuilderBundle\Model\FormDefinition:
         modifiedBy:
             column: modifiedBy
             type: integer
-        mailLayout:
-            column: mailLayout
-            type: object
-            nullable: true
         configuration:
             column: configuration
             type: object

config/install/sql/install.sql

@@ -6,7 +6,6 @@ CREATE TABLE IF NOT EXISTS `formbuilder_forms` (
   `modificationDate` datetime NOT NULL,
   `createdBy` int(11) NOT NULL,
   `modifiedBy` int(11) NOT NULL,
-  `mailLayout` longtext COMMENT '(DC2Type:object)',
   `configuration` longtext COMMENT '(DC2Type:object)',
   `conditionalLogic` longtext COMMENT '(DC2Type:object)',
   `fields` longtext COMMENT '(DC2Type:form_builder_fields)',
@@ -37,4 +36,20 @@ CREATE TABLE IF NOT EXISTS `formbuilder_output_workflow_channel` (
   UNIQUE KEY `ow_name` (`output_workflow`,`name`),
   KEY `IDX_CEC462362C75DDDC` (`output_workflow`),
   CONSTRAINT `FK_CEC462362C75DDDC` FOREIGN KEY (`output_workflow`) REFERENCES `formbuilder_output_workflow` (`id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC;
+
+CREATE TABLE IF NOT EXISTS `formbuilder_double_opt_in_session` (
+    `token` binary(16) NOT NULL COMMENT '(DC2Type:uuid)' PRIMARY KEY,
+    `form_definition` int NULL,
+    `email` varchar(190) NOT NULL,
+    `additional_data` longtext NULL COMMENT '(DC2Type:array)',
+    `dispatch_location` longtext NULL,
+    `applied` tinyint(1) DEFAULT 0 NOT null,
+    `creationDate` datetime NOT NULL,
+    CONSTRAINT email_form_definition UNIQUE (email, form_definition, applied),
+    CONSTRAINT FK_88815C4F61F7634C FOREIGN KEY (form_definition) REFERENCES formbuilder_forms (id) ON DELETE CASCADE
+);
+
+create index IDX_88815C4F61F7634C on formbuilder_double_opt_in_session (form_definition);
+create index token_form on formbuilder_double_opt_in_session (token, form_definition, applied);
+

config/install/translations/frontend.csv

@@ -36,4 +36,5 @@
 "form_builder.dynamic_multi_file.remove","Remove file","Datei entfernen"
 "form_builder.dynamic_multi_file.global.cannot_destroy_active_instance","This uploader is currently active or has some unprocessed files. in case there are some uploaded files, please remove them first.","Ein Uploader ist derzeit in dieser Sektion aktiv oder es wurden bereits Daten verarbeitet. Falls es bereits hochgeladene Dateien gibt, entfernen Sie diese bitte zuerst."
 "form_builder.form.container.repeater.min","%label%: You need to add at least %items% items.","%label%: Es werden mindestens %items% Einträge benötigt."
-"form_builder.form.container.repeater.max","%label%: Only %items% item(s) allowed.","%label%: Maximal %items% Einträge erlaubt."
+"form_builder.form.container.repeater.max","%label%: Only %items% item(s) allowed.","%label%: Maximal %items% Einträge erlaubt."
+"form_builder.form.double_opt_in.duplicate_session","Double-Opt-In Session for the given address has already been created.","Ein Zugang wurde für diese Adresse bereits erstellt."

config/services/double_opt_in.yaml

@@ -0,0 +1,6 @@
+services:
+
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: true

config/services/forms/forms.yaml

@@ -52,6 +52,11 @@ services:
         tags:
             - { name: form.type }
 
+    FormBuilderBundle\Form\Type\InstructionsType:
+        public: false
+        tags:
+            - { name: form.type }
+
     FormBuilderBundle\Form\Type\SnippetType:
         autowire: true
         public: false
@@ -96,3 +101,11 @@ services:
         tags:
             - { name: form.type }
 
+
+    #
+    # Double-Opt-In
+
+    FormBuilderBundle\Form\Type\DoubleOptIn\DoubleOptInType:
+        public: false
+        tags:
+            - { name: form.type }

config/services/manager.yaml

@@ -15,4 +15,7 @@ services:
     FormBuilderBundle\Manager\PresetManager: ~
 
     # manager: template (form themes, type templates)
-    FormBuilderBundle\Manager\TemplateManager: ~
+    FormBuilderBundle\Manager\TemplateManager: ~
+
+    # manager: double-opt-in
+    FormBuilderBundle\Manager\DoubleOptInManager: ~

config/services/repository.yaml

@@ -9,4 +9,7 @@ services:
     FormBuilderBundle\Repository\FormDefinitionRepository: ~
 
     FormBuilderBundle\Repository\OutputWorkflowRepositoryInterface: '@FormBuilderBundle\Repository\OutputWorkflowRepository'
-    FormBuilderBundle\Repository\OutputWorkflowRepository: ~
+    FormBuilderBundle\Repository\OutputWorkflowRepository: ~
+
+    FormBuilderBundle\Repository\DoubleOptInSessionRepositoryInterface: '@FormBuilderBundle\Repository\DoubleOptInSessionRepository'
+    FormBuilderBundle\Repository\DoubleOptInSessionRepository: ~