feat: Allow actions to add form fields for configuration (#6)

* Add: Configuration options for actions

* Update readme, form parameter storage in form Meta class

* Simplification

Author: fsbraun

README.rst

@@ -69,6 +69,9 @@ First create a ``Form`` plugin to add a form. Each form created with help of the
 
 Add form fields by adding child classes to the form plugin. Child classes can be form fields but also any other CMS Plugin. CMS Plugins may, e.g., be used to add custom formatting or additional help texts to a form.
 
+Form fields
+-----------
+
 Currently the following form fields are supported:
 
 * CharField, EmailField, URLField
@@ -80,6 +83,21 @@ Currently the following form fields are supported:
 
 A Form plugin must not be used within another Form plugin.
 
+Actions
+-------
+
+Upon submission of a valid form actions can be performed. A project can register as many actions as it likes::
+
+    from djangocms_form_builder import actions
+
+    @actions.register
+    class MyAction(actions.FormAction):
+        verbose_name = _("Everything included action")
+
+        def execute(self, form, request):
+            ...  # This method is run upon successful submission of the form
+
+
 Using (existing) Django forms with djangocms-form-builder
 =========================================================
 
@@ -105,8 +123,9 @@ By default the class name is translated to a human readable form (``MyGreatForm`
 
 The verbose name will be shown in a Select field of the Form plugin.
 
-Upon form submission a ``save()`` method of the form (if it has one). After executing the ``save()`` method the user is redirected to the url given in the  ``redirect`` attribute. 
+Upon form submission a ``save()`` method of the form (if it has one). After executing the ``save()`` method the user is redirected to the url given in the  ``redirect`` attribute.
 
+Actions are not available for Django forms. Any actions to be performed upon submission should reside in its ``save()`` method.
 
 
 .. |pypi| image:: https://badge.fury.io/py/djangocms-form-builder.svg

djangocms_form_builder/actions.py

@@ -1,13 +1,19 @@
 import hashlib
 
+from django import forms
 from django.core.exceptions import ImproperlyConfigured
 from django.core.mail import mail_admins, send_mail
+from django.core.validators import EmailValidator
+from django.template import TemplateDoesNotExist
 from django.template.loader import render_to_string
 from django.utils.html import strip_tags
 from django.utils.translation import gettext_lazy as _
+from entangled.forms import EntangledModelFormMixin
 
+from . import models
 from .entry_model import FormEntry
-from .helpers import get_option
+from .helpers import get_option, insert_fields
+from .settings import MAIL_TEMPLATE_SETS
 
 _action_registry = {}
 
@@ -38,16 +44,63 @@ def register(action_class):
     return action_class
 
 
+def unregister(action_class):
+    hash = hashlib.sha1(action_class.__name__.encode("utf-8")).hexdigest()
+    if hash in _action_registry:
+        del _action_registry[hash]
+    return action_class
+
+
 def get_action_class(action):
     return _action_registry.get(action, None)
 
 
-class FormAction:
+class ActionMixin:
+    """Adds action form elements to Form plugin admin"""
+    def get_form(self, request, *args, **kwargs):
+        """Creates new form class based adding the actions as mixins"""
+        return type(
+            "FormActionAdminForm",
+            (self.form, *_action_registry.values()),
+            {}
+        )
+
+    def get_fieldsets(self, request, obj=None):
+        fieldsets = super().get_fieldsets(request, obj)
+        for action in _action_registry.values():
+            new_fields = list(action.declared_fields.keys())
+            if new_fields:
+                hash = hashlib.sha1(action.__name__.encode("utf-8")).hexdigest()
+                fieldsets = insert_fields(
+                    fieldsets,
+                    new_fields,
+                    block=None,
+                    position=-1,
+                    blockname=action.verbose_name,
+                    blockattrs=dict(classes=(hash, 'action-hide')),
+                )
+        return fieldsets
+
+
+class FormAction(EntangledModelFormMixin):
+    class Meta:
+        entangled_fields = {"action_parameters": []}
+        model = models.Form
+        exclude = ()
+
+    class Media:
+        js = ("djangocms_form_builder/js/actions_form.js",)
+        css = {"all": ("djangocms_form_builder/css/actions_form.css",)}
+
     verbose_name = None
 
     def execute(self, form, request):
         raise NotImplementedError()
 
+    @staticmethod
+    def get_parameter(form, param):
+        return (get_option(form, "form_parameters") or {}).get(param, None)
+
 
 @register
 class SaveToDBAction(FormAction):
@@ -90,36 +143,78 @@ def execute(self, form, request):
 SAVE_TO_DB_ACTION = next(iter(_action_registry)) if _action_registry else None
 
 
+def validate_recipients(value):
+    recipients = value.split()
+    for recipient in recipients:
+        EmailValidator(message=_("Please replace \"%s\" by a valid email address.") % recipient)(recipient)
+
+
 @register
 class SendMailAction(FormAction):
-    verbose_name = _("Send email to administrators")
-    recipients = None
+    class Meta:
+        entangled_fields = {
+            "action_parameters": [
+                "sendemail_recipients",
+                "sendemail_template",
+            ]
+        }
+
+    verbose_name = _("Send email")
     from_mail = None
     template = "djangocms_form_builder/actions/mail.html"
     subject = _("%(form_name)s form submission")
 
+    sendemail_recipients = forms.CharField(
+        label=_("Mail recipients"),
+        required=False,
+        initial="",
+        validators=[
+            validate_recipients,
+        ],
+        help_text=_("Space or newline separated list of email addresses."),
+        widget=forms.Textarea,
+    )
+
+    sendemail_template = forms.ChoiceField(
+        label=_("Mail template set"),
+        required=True,
+        initial=MAIL_TEMPLATE_SETS[0][0],
+        choices=MAIL_TEMPLATE_SETS,
+        widget=forms.Select if len(MAIL_TEMPLATE_SETS) > 1 else forms.HiddenInput,
+    )
+
     def execute(self, form, request):
+        recipients = (self.get_parameter(form, "sendemail_recipients") or []).split()
+        template_set = self.get_parameter(form, "sendemail_template") or "default"
         context = dict(
             cleaned_data=form.cleaned_data,
+            form_name=getattr(form.Meta, "verbose_name", ""),
             user=request.user,
             user_agent=request.headers["User-Agent"],
             referer=request.headers["Referer"],
         )
-        html_message = render_to_string(self.template, context)
-        message = strip_tags(html_message)
-        form_name = form.cleaned_data["form_name"].replace("-", " ").capitalize()
-        if self.recipients is None:
+
+        html_message = render_to_string(f"djangocms_form_builder/mails/{template_set}/mail_html.html", context)
+        try:
+            message = render_to_string(f"djangocms_form_builder/mails/{template_set}/mail.txt", context)
+        except TemplateDoesNotExist:
+            message = strip_tags(html_message)
+        try:
+            subject = render_to_string(f"djangocms_form_builder/mails/{template_set}/subject.txt", context)
+        except TemplateDoesNotExist:
+            subject = self.subject % dict(form_name=context["form_name"])
+        if not recipients:
             mail_admins(
-                self.subject % dict(form_name=form_name),
+                subject,
                 message,
                 fail_silently=True,
                 html_message=html_message,
             )
         else:
             send_mail(
-                self.subject % dict(form_name=form_name),
+                subject,
                 message,
-                self.recipients,
+                recipients,
                 self.from_mail,
                 fail_silently=True,
                 html_message=html_message,

djangocms_form_builder/cms_plugins/ajax_plugins.py

@@ -1,3 +1,4 @@
+import json
 from urllib.parse import urlencode
 
 from cms.plugin_base import CMSPluginBase
@@ -14,6 +15,7 @@
 from djangocms_form_builder import settings
 
 from .. import forms, models, recaptcha
+from ..actions import ActionMixin
 from ..forms import SimpleFrontendForm
 from ..helpers import get_option, insert_fields, mark_safe_lazy
 
@@ -46,7 +48,11 @@ def json_return(self, errors, result, redirect, content):
         )
 
     def form_valid(self, form):
+        # Execute save method
         save = getattr(form, "save", None)
+        if callable(save):
+            result = form.save()
+        # Identify redirect
         redirect = get_option(form, "redirect", None)
         if isinstance(redirect, str):
             try:
@@ -56,8 +62,6 @@ def form_valid(self, form):
         elif hasattr(redirect, "get_absolute_url"):
             redirect = redirect.get_absolute_url()
 
-        if callable(save):
-            form.save()
         get_success_context = "get_success_context"
         render_success = "render_success"
         if hasattr(form, "slug"):
@@ -242,7 +246,7 @@ def render(self, context, instance, placeholder):
 
 
 @plugin_pool.register_plugin
-class FormPlugin(CMSAjaxForm):
+class FormPlugin(ActionMixin, CMSAjaxForm):
     name = _("Form")
     model = models.Form
 
@@ -267,13 +271,6 @@ class FormPlugin(CMSAjaxForm):
                 ],
             },
         ),
-        (
-            _("Actions"),
-            {
-                "classes": ("collapse",),
-                "fields": ["form_actions"],
-            },
-        ),
     ]
 
     cache_parent_classes = False
@@ -289,9 +286,19 @@ def get_parent_classes(cls, slot, page, instance=None):
         return super().get_parent_classes(slot, page, instance)
 
     def get_fieldsets(self, request, obj=None):
+        fieldsets = super().get_fieldsets(request, obj)
+        if obj is None or not obj.form_selection:  # No Actions if a Django form has been selected
+            fieldsets = insert_fields(
+                fieldsets,
+                ("form_actions",),
+                block=None,
+                position=1,
+                blockname=_("Actions"),
+                blockattrs={"classes": ("collapse", "action-auto-hide")},
+            )
         if recaptcha.installed:
             return insert_fields(
-                super().get_fieldsets(request, obj),
+                fieldsets,
                 ("captcha_widget", "captcha_requirement", "captcha_config"),
                 block=None,
                 position=1,
@@ -310,9 +317,10 @@ def get_fieldsets(self, request, obj=None):
                     )
                 ),
             )
-        return super().get_fieldsets(request, obj)
+        return fieldsets
 
     def get_form_class(self, slug=None):
+        """Retrieve or create form for this plugin"""
         if self.instance.child_plugin_instances is None:  # not set if in ajax_post
             self.instance.child_plugin_instances = [
                 child.get_plugin_instance()[0] for child in self.instance.get_children()
@@ -359,8 +367,14 @@ def traverse(instance):
         ] = self.instance.placeholder.page  # Default behavior: redirect to same page
         meta_options["login_required"] = self.instance.form_login_required
         meta_options["unique"] = self.instance.form_unique
-        meta_options["form_actions"] = self.instance.form_actions
-        fields["Meta"] = type("Meta", (), dict(options=meta_options))  # Meta class
+        form_actions = self.instance.form_actions or "[]"
+        meta_options["form_actions"] = json.loads(form_actions.replace("'", '"'))
+        meta_options["form_parameters"] = getattr(self.instance, "action_parameters", {})
+
+        fields["Meta"] = type("Meta", (), dict(
+            options=meta_options,
+            verbose_name=self.instance.form_name.replace("-", " ").replace("_", " ").capitalize(),
+        ))  # Meta class with options and verbose name
 
         return type(
             "FrontendAutoForm",