fix: prevent duplicate submit buttons in forms (#27)

* fix: prevent duplicate submit buttons in forms

* perf: optimize submit button check to avoid extra DB query

* test: add test for indirect children

* fix: handle submit button rendering

* fix: remove unnecessary check

* fix: add test app for testing nested plugins

* fix: remove unnecessary files

Author: earthcomfy

djangocms_form_builder/cms_plugins/__init__.py

@@ -10,6 +10,7 @@
     EmailFieldPlugin,
     IntegerFieldPlugin,
     SelectPlugin,
+    SubmitPlugin,
     TextareaPlugin,
     TimeFieldPlugin,
     URLFieldPlugin,
@@ -26,6 +27,7 @@
     "EmailFieldPlugin",
     "IntegerFieldPlugin",
     "SelectPlugin",
+    "SubmitPlugin",
     "TextareaPlugin",
     "TimeFieldPlugin",
     "URLFieldPlugin",

djangocms_form_builder/cms_plugins/ajax_plugins.py

@@ -240,11 +240,24 @@ def render(self, context, instance, placeholder):
         form = self.get_ajax_form()
         context.update(self.set_context(context, instance, placeholder))
         context["form_counter"] = context.get("form_counter", 0) + 1
-        context.update({
-            "instance": instance,
-            "form": form,
-            "uid": f"{instance.id}{getattr(form, 'slug', '')}-{context['form_counter']}",
-        })
+
+        def has_submit_button(plugins):
+            for child in plugins:
+                if child.plugin_type == "SubmitPlugin":
+                    return True
+                child_plugins = getattr(child, "child_plugin_instances", None) or []
+                if has_submit_button(child_plugins):
+                    return True
+            return False
+
+        context.update(
+            {
+                "instance": instance,
+                "form": form,
+                "uid": f"{instance.id}{getattr(form, 'slug', '')}-{context['form_counter']}",
+                "has_submit_button": has_submit_button(instance.child_plugin_instances),
+            }
+        )
         return context
 
 
@@ -290,7 +303,9 @@ def get_parent_classes(cls, slot, page, instance=None):
 
     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
+        if (
+            obj is None or not obj.form_selection
+        ):  # No Actions if a Django form has been selected
             fieldsets = insert_fields(
                 fieldsets,
                 ("form_actions",),
@@ -362,22 +377,28 @@ def traverse(instance):
         meta_options = dict(form_name=self.instance.form_name)
         if self.instance.form_floating_labels:
             meta_options["floating_labels"] = True
-        meta_options[
-            "field_sep"
-        ] = f'{self.instance.form_spacing}'
-        meta_options[
-            "redirect"
-        ] = SAME_PAGE_REDIRECT  # Default behavior: redirect to same page
+        meta_options["field_sep"] = f"{self.instance.form_spacing}"
+        meta_options["redirect"] = (
+            SAME_PAGE_REDIRECT  # Default behavior: redirect to same page
+        )
         meta_options["login_required"] = self.instance.form_login_required
         meta_options["unique"] = self.instance.form_unique
         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", {})
+        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
+        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",

djangocms_form_builder/templates/djangocms_form_builder/bootstrap5/form.html

@@ -7,8 +7,10 @@
               method="post">
             {% csrf_token %}
             {% include 'djangocms_form_builder/ajax_form.html' with form=form instance=instance tracking=instance.tracking_code RECAPTCHA_PUBLIC_KEY=RECAPTCHA_PUBLIC_KEY %}
-            <input type="submit" value="{{ instance.form_submit_message|default:_("Submit") }}"
-                class="btn btn-{{ instance.form_submit_context|default:"primary" }}">
+            {% if not has_submit_button %}
+                <input type="submit" value="{{ instance.form_submit_message|default:_("Submit") }}"
+                    class="btn btn-{{ instance.form_submit_context|default:"primary" }}">
+            {% endif %}
         </form><div class="clearfix"></div>
     {% endif %}
 {% endspaceless %}

djangocms_form_builder/templates/djangocms_form_builder/bootstrap5/widgets/submit.html

@@ -1 +1 @@
-<input type="submit" value="{{ instance.form_submit_message|default:_("Submit") }}" class="btn btn-{{ instance.form_submit_context|default:"primary" }}
+<input type="submit" value="{{ instance.config.submit_cta|default:_("Submit") }}" class="btn btn-{{ instance.form_submit_context|default:"primary" }}">

tests/test_app/cms_plugins.py

@@ -0,0 +1,10 @@
+from cms.plugin_base import CMSPluginBase
+from cms.plugin_pool import plugin_pool
+from django.utils.translation import gettext_lazy as _
+
+
+@plugin_pool.register_plugin
+class ContainerPlugin(CMSPluginBase):
+    name = _("Container")
+    render_template = "test_app/container.html"
+    allow_children = True

tests/test_app/templates/test_app/container.html

@@ -0,0 +1,6 @@
+{% load cms_tags %}
+<div class="test-container">
+    {% for plugin in instance.child_plugin_instances %}
+        {% render_plugin plugin %}
+    {% endfor %}
+</div>

tests/test_formeditor.py

@@ -5,6 +5,7 @@
 
 from djangocms_form_builder import cms_plugins
 from djangocms_form_builder.cms_plugins.form_plugins import FormElementPlugin
+from tests.test_app.cms_plugins import ContainerPlugin
 
 from .fixtures import TestFixture
 
@@ -24,6 +25,7 @@ def test_form_editor(self):
                 inspect.isclass(cls)
                 and issubclass(cls, FormElementPlugin)
                 and not issubclass(cls, cms_plugins.ChoicePlugin)
+                and cls is not cms_plugins.SubmitPlugin
             ):
                 field = add_plugin(
                     placeholder=self.placeholder,
@@ -48,5 +50,153 @@ def test_form_editor(self):
                 inspect.isclass(cls)
                 and issubclass(cls, FormElementPlugin)
                 and not issubclass(cls, cms_plugins.ChoicePlugin)
+                and cls is not cms_plugins.SubmitPlugin
             ):
                 self.assertContains(response, f'name="field_{item}"')
+
+    def test_auto_submit_button_appears_when_no_button(self):
+        form = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.FormPlugin.__name__,
+            language=self.language,
+            form_selection="",
+            form_name="test-form",
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.CharFieldPlugin.__name__,
+            target=form,
+            language=self.language,
+            config=dict(
+                field_name="text_field",
+            ),
+        )
+        self.publish(self.page, self.language)
+        with self.login_user_context(self.superuser):
+            response = self.client.get(self.request_url)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content.decode().count('type="submit"'), 1)
+        self.assertIn('value="Submit"', response.content.decode())
+
+    def test_auto_submit_button_does_not_appear_when_button_exists(self):
+        form = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.FormPlugin.__name__,
+            language=self.language,
+            form_selection="",
+            form_name="test-form",
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.CharFieldPlugin.__name__,
+            target=form,
+            language=self.language,
+            config=dict(
+                field_name="text_field",
+            ),
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.SubmitPlugin.__name__,
+            target=form,
+            language=self.language,
+            config=dict(
+                submit_cta="Submit Form",
+            ),
+        )
+        self.publish(self.page, self.language)
+        with self.login_user_context(self.superuser):
+            response = self.client.get(self.request_url)
+
+        self.assertEqual(response.status_code, 200)
+        content = response.content.decode()
+        self.assertEqual(content.count('type="submit"'), 1)
+        self.assertIn('value="Submit Form"', content)
+        self.assertNotIn('value="Submit"', content)
+
+    def test_auto_submit_button_does_not_appear_with_nested_button(self):
+        form = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.FormPlugin.__name__,
+            language=self.language,
+            form_selection="",
+            form_name="test-form",
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.CharFieldPlugin.__name__,
+            target=form,
+            language=self.language,
+            config=dict(
+                field_name="text_field",
+            ),
+        )
+        container = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=ContainerPlugin.__name__,
+            target=form,
+            language=self.language,
+        )
+        nested_container = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=ContainerPlugin.__name__,
+            target=container,
+            language=self.language,
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.SubmitPlugin.__name__,
+            target=nested_container,
+            language=self.language,
+            config=dict(
+                submit_cta="Submit Form",
+            ),
+        )
+        self.publish(self.page, self.language)
+        with self.login_user_context(self.superuser):
+            response = self.client.get(self.request_url)
+
+        self.assertEqual(response.status_code, 200)
+        content = response.content.decode()
+        self.assertEqual(content.count('type="submit"'), 1)
+        self.assertIn('value="Submit Form"', content)
+        self.assertNotIn('value="Submit"', content)
+
+    def test_auto_submit_button_appears_with_empty_nested_containers(self):
+        form = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.FormPlugin.__name__,
+            language=self.language,
+            form_selection="",
+            form_name="test-form",
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=cms_plugins.CharFieldPlugin.__name__,
+            target=form,
+            language=self.language,
+            config=dict(
+                field_name="text_field",
+            ),
+        )
+        container = add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=ContainerPlugin.__name__,
+            target=form,
+            language=self.language,
+        )
+        add_plugin(
+            placeholder=self.placeholder,
+            plugin_type=ContainerPlugin.__name__,
+            target=container,
+            language=self.language,
+        )
+        self.publish(self.page, self.language)
+        with self.login_user_context(self.superuser):
+            response = self.client.get(self.request_url)
+
+        self.assertEqual(response.status_code, 200)
+        content = response.content.decode()
+        self.assertEqual(content.count('type="submit"'), 1)
+        self.assertIn('value="Submit"', content)

tests/test_settings.py

@@ -2,6 +2,17 @@
 
 from cms.utils.compat import DJANGO_3_1
 
+
+class DisableMigrations(dict):
+    def __contains__(self, item):
+        return True
+
+    def __getitem__(self, item):
+        return None
+
+
+MIGRATION_MODULES = DisableMigrations()
+
 INSTALLED_APPS = [
     "django.contrib.contenttypes",
     "django.contrib.auth",
@@ -17,6 +28,7 @@
     "djangocms_text_ckeditor",
     "djangocms_form_builder",
     "sekizai",
+    "tests.test_app",
 ]
 
 if DJANGO_3_1: