Merge branch 'main' into updated

Author: fsbraun

.github/workflows/codecov.yml

@@ -12,19 +12,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ 3.8, 3.9, "3.10", "3.11"]  # latest release minus two
+        python-version: [ 3.9, "3.10", "3.11", "3.12"]  # latest release minus two
         requirements-file: [
-            dj32_cms38.txt,
-            dj32_cms39.txt,
-            dj32_cms310.txt,
-            dj32_cms311.txt,
-            dj40_cms311.txt,
-            dj41_cms311.txt,
-            dj41_cms41.txt,
+            dj42_cms311.txt,
+            dj42_cms41.txt,
+            dj50_cms41.txt,
+            dj51_cms41.txt,
         ]
         os: [
             ubuntu-20.04,
         ]
+        exclude:
+          - python-version: 3.9
+            requirements-file: dj50_cms41.txt
+          - python-version: 3.9
+            requirements-file: dj51_cms41.txt
 
     steps:
     - uses: actions/checkout@v3
@@ -38,7 +40,8 @@ jobs:
     - name: Generate Report
       run: |
         pip install -r tests/requirements/${{ matrix.requirements-file }}
-        coverage run setup.py test
+        pip install -e .
+        coverage run ./run_tests.py
     - name: Upload Coverage to Codecov
       uses: codecov/codecov-action@v3
 

.github/workflows/publish-to-test-pypi.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
+    branches:
+      - main
 
 jobs:
   build-n-publish:
@@ -38,3 +41,4 @@ jobs:
         password: ${{ secrets.TEST_PYPI_API_TOKEN }}
         repository_url: https://test.pypi.org/legacy/
         skip_existing: true
+        verbose: true

.gitignore

@@ -18,6 +18,7 @@ build/
 dist/
 env/
 .venv/
+venv/
 
 /~
 /node_modules

.pre-commit-config.yaml

@@ -6,25 +6,9 @@ repos:
   rev: v2.32.1
   hooks:
     - id: pyupgrade
-      args: [ "--py37-plus" ]
+      args: [ "--py38-plus" ]
 - repo: https://github.com/adamchainz/django-upgrade
-  rev: '1.7.0'
+  rev: '1.16.0'
   hooks:
     - id: django-upgrade
-      args: [ --target-version, "2.2" ]
-- repo: https://github.com/pycqa/isort
-  rev: 5.10.1
-  hooks:
-    - id: isort
-      name: isort (python)
-- repo: https://github.com/PyCQA/flake8
-  rev: 4.0.1
-  hooks:
-    - id: flake8
-      additional_dependencies:
-        - flake8-bugbear
-        - flake8-builtins
-        - flake8-django
-        - flake8-length
-        - flake8-logging-format
-        - flake8-spellcheck
+      args: [ --target-version, "4.2" ]

CHANGELOG.rst

@@ -2,6 +2,37 @@
 Changelog
 =========
 
+0.3.0 (2025-01-07)
+==================
+
+* feat: Success message and redirect action by @fsbraun
+* fix: forms did not redirect to same page if sent from alias by @fsbraun
+
+0.2.0 (2025-01-06)
+==================
+
+* fix: github coverage action by @fsbraun in https://github.com/django-cms/djangocms-form-builder/pull/12
+* fix: an error when an anonymous user fills the form by @arunk in https://github.com/django-cms/djangocms-form-builder/pull/13
+* fix: Add support for Django-entangled 0.6+ by @fsbraun in https://github.com/django-cms/djangocms-form-builder/pull/19
+* docs: Updated README.rst to show where to add actions by @arunk in https://github.com/django-cms/djangocms-form-builder/pull/14
+* chore: Added venv/ directory to .gitignore by @arunk in https://github.com/django-cms/djangocms-form-builder/pull/15
+
+**New Contributors**
+* @arunk made their first contribution in https://github.com/django-cms/djangocms-form-builder/pull/13
+
+
+0.1.1 (2021-09-14)
+==================
+
+* feat: updated captcha optional til active by @svandeneertwegh in https://github.com/fsbraun/djangocms-form-builder/pull/4
+* feat: Allow actions to add form fields for configuration by @fsbraun in https://github.com/fsbraun/djangocms-form-builder/pull/6
+* fix: Update converage action by @fsbraun in https://github.com/fsbraun/djangocms-form-builder/pull/10
+* feat: move to hatch build process by @fsbraun
+* ci: Add tests for registry by @fsbraun in https://github.com/fsbraun/djangocms-form-builder/pull/5
+
+New Contributors
+
+* @svandeneertwegh made their first contribution in https://github.com/fsbraun/djangocms-form-builder/pull/4
 
 0.2.0 (unreleased)
 =================

MANIFEST.in

@@ -86,7 +86,21 @@ 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::
+Upon submission of a valid form actions can be performed.
+
+Four actions come with djangocms-form-builder comes with four actions built-in
+
+* **Save form submission** - Saves each form submission to the database. See the
+  results in the admin interface.
+* **Send email** - Sends an email to the site admins with the form data.
+* **Success message** - Specify a message to be shown to the user upon
+  successful form submission.
+* **Redirect after submission** - Specify a link to a page where the user is
+  redirected after successful form submission.
+
+Actions can be configured in the form plugin.
+
+A project can register as many actions as it likes::
 
     from djangocms_form_builder import actions
 
@@ -98,6 +112,33 @@ Upon submission of a valid form actions can be performed. A project can register
             ...  # This method is run upon successful submission of the form
 
 
+To add this action, might need to be added to your project only after all Django apps have loaded at startup.
+You can put these actions in your apps models.py file. Another options is your apps, apps.py file::
+
+    from django.apps import AppConfig
+
+    class MyAppConfig(AppConfig):
+        default_auto_field = 'django.db.models.BigAutoField'
+        name = 'myapp'
+        label = 'myapp'
+        verbose_name = _("My App")
+
+        def ready(self):
+            super().ready()
+
+            from djangocms_form_builder import actions
+
+            @actions.register
+            class MyAction(actions.FormAction):  # Or import from within the ready method
+                verbose_name = _("Everything included action")
+
+                def execute(self, form, request):
+                    ...  # This method is run upon successful submission of the form
+                    # Process form and request data, you can send an email to the person who filled the form
+                    # Or admins though that functionality is available from the default SendMailAction
+
+
+
 Using (existing) Django forms with djangocms-form-builder
 =========================================================
 
@@ -131,8 +172,8 @@ Actions are not available for Django forms. Any actions to be performed upon sub
 .. |pypi| image:: https://badge.fury.io/py/djangocms-form-builder.svg
    :target: http://badge.fury.io/py/djangocms-form-builder
 
-.. |coverage| image:: https://codecov.io/gh/fsbraun/djangocms-form-builder/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/fsbraun/djangocms-form-builder
+.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-form-builder/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/django-cms/djangocms-form-builder
 
 .. |python| image:: https://img.shields.io/badge/python-3.7+-blue.svg
    :target: https://pypi.org/project/djangocms-form-builder/

README.rst

@@ -3,10 +3,10 @@
 try:
     from django.utils.translation import gettext_lazy as _
 except ModuleNotFoundError:
-    _ = lambda x: x
+    _ = lambda x: x  # noqa: E731
 
 
-__version__ = "0.1"
+__version__ = "0.3.0"
 
 _form_registry = {}
 

djangocms_form_builder/__init__.py

@@ -1,13 +1,14 @@
 import hashlib
 
 from django import forms
+from django.apps import apps
 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 djangocms_text_ckeditor.fields import HTMLFormField
 from entangled.forms import EntangledModelFormMixin
 
 from . import models
@@ -125,7 +126,7 @@ def execute(self, form, request):
             keys = {}
             defaults = {
                 "form_name": get_option(form, "form_name"),
-                "form_user": form_user,
+                "form_user": None if request.user.is_anonymous else request.user
             }
         defaults.update(
             {
@@ -190,14 +191,16 @@ class Meta:
     )
 
     def execute(self, form, request):
-        recipients = (self.get_parameter(form, "sendemail_recipients") or []).split()
+        from django.core.mail import mail_admins, send_mail
+
+        recipients = self.get_parameter(form, "sendemail_recipients") or ""
         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"],
+            user_agent=request.headers["User-Agent"] if "User-Agent" in request.headers else "",
+            referer=request.headers["Referer"] if "Referer" in request.headers else "",
         )
 
         html_message = render_to_string(f"djangocms_form_builder/mails/{template_set}/mail_html.html", context)
@@ -209,19 +212,73 @@ def execute(self, form, request):
             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(
+            return mail_admins(
                 subject,
                 message,
                 fail_silently=True,
                 html_message=html_message,
             )
         else:
-            send_mail(
+            return send_mail(
                 subject,
                 message,
-                recipients,
                 self.from_mail,
+                recipients.split(),
                 fail_silently=True,
                 html_message=html_message,
             )
+
+
+@register
+class SuccessMessageAction(FormAction):
+    verbose_name = _("Success message")
+
+    class Meta:
+        entangled_fields = {
+            "action_parameters": [
+                "submitmessage_message",
+            ]
+        }
+
+    submitmessage_message = HTMLFormField(
+        label=_("Message"),
+        required=True,
+        initial=_("<p>Thank you for your submission.</p>"),
+    )
+
+    def execute(self, form, request):
+        from .cms_plugins.ajax_plugins import SAME_PAGE_REDIRECT
+
+        message = self.get_parameter(form, "submitmessage_message")
+        # Overwrite the success context and render template
+        form.get_success_context = lambda *args, **kwargs: {"message": message}
+        form.Meta.options["render_success"] = "djangocms_form_builder/actions/submit_message.html"
+        # Overwrite the default redirect to same page
+        if form.Meta.options.get("redirect") == SAME_PAGE_REDIRECT:
+            form.Meta.options["redirect"] = None
+
+
+if apps.is_installed("djangocms_link"):
+    from djangocms_link.fields import LinkFormField
+    from djangocms_link.helpers import get_link
+
+    @register
+    class RedirectAction(FormAction):
+        verbose_name = _("Redirect after submission")
+
+        class Meta:
+            entangled_fields = {
+                "action_parameters": [
+                    "redirect_link",
+                ]
+            }
+
+        redirect_link = LinkFormField(
+            label=_("Link"),
+            required=True,
+        )
+
+        def execute(self, form, request):
+            form.Meta.options["redirect"] = get_link(self.get_parameter(form, "redirect_link"))

djangocms_form_builder/actions.py

@@ -8,6 +8,10 @@ class FormEntryAdmin(admin.ModelAdmin):
     date_hierarchy = "entry_created_at"
     list_display = ("__str__", "form_user", "entry_created_at")
     list_filter = ("form_name", "form_user", "entry_created_at")
+    readonly_fields = ["form_name", "form_user"]
+
+    def has_add_permission(self, request):
+        return False
 
     def get_form(self, request, obj=None, **kwargs):
         if obj: