feat: enable add button on the SnippetPluginForm

Allows creation of a new Snippet when adding a snippet plugin to a page

Author: michaeljcollinsuk

djangocms_snippet/cms_plugins.py

@@ -7,6 +7,7 @@
 from cms.plugin_base import CMSPluginBase
 from cms.plugin_pool import plugin_pool
 
+from .forms import SnippetPluginForm
 from .models import SnippetPtr
 from .utils import show_draft_content
 
@@ -21,6 +22,7 @@ class SnippetPlugin(CMSPluginBase):
     text_enabled = True
     text_editor_preview = False
     cache = CACHE_ENABLED
+    form = SnippetPluginForm
 
     def render(self, context, instance, placeholder):
         snippet = instance.snippet_grouper.snippet(show_editable=show_draft_content(context["request"]))

djangocms_snippet/forms.py

@@ -1,10 +1,11 @@
+from cms.utils.urlutils import admin_reverse
 from django import forms
+from django.contrib import admin
 from django.db import transaction
 from django.utils.translation import ugettext_lazy as _
 
 from djangocms_snippet.cms_config import SnippetCMSAppConfig
-from djangocms_snippet.models import Snippet, SnippetGrouper
-
+from djangocms_snippet.models import Snippet, SnippetGrouper, SnippetPtr
 
 try:
     from djangocms_versioning import __version__  # NOQA
@@ -64,3 +65,26 @@ def save(self, **kwargs):
         if commit:
             snippet.save()
         return snippet
+
+
+class SnippetPluginForm(forms.ModelForm):
+
+    class Meta:
+        model = SnippetPtr
+        fields = ("cmsplugin_ptr", "snippet_grouper")
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initialise the form with the add button enabled to allow adding a new snippet from the plugin form. To enable
+        this the get_related_url method on the widget is monkey patched to build a URL for the Snippet admin instead of
+        the SnippetGrouper, as this is not enabled in the admin.
+        """
+        super(SnippetPluginForm, self).__init__(*args, **kwargs)
+        self.fields["snippet_grouper"].widget.can_add_related = True
+        self.fields["snippet_grouper"].widget.get_related_url = self.get_related_url_for_snippet
+
+    def get_related_url_for_snippet(self, info, action, *args):
+        """
+        Build URL to the Snippet admin for the given action
+        """
+        return admin_reverse(f"djangocms_snippet_snippet_{action}", current_app=admin.site.name, args=args)