feat(tup-308): working form plugin (aka tup-230)

package.json

@@ -9,7 +9,7 @@
     "npm": "^8.5.5"
   },
   "devDependencies": {
-    "@tacc/core-styles": "^0.6.0",
+    "@tacc/core-styles": "https://gitpkg.now.sh/TACC/tup-ui/libs/core-styles?task/tup-308-what-forms-should-get-from-core",
     "minimist": "^1.2.6"
   },
   "repository": "git@github.com:TACC/Core-CMS.git",

pyproject.toml

@@ -48,7 +48,7 @@ djangocms-blog = "1.1.1"
 djangocms-bootstrap4 = "2.0.0"
 djangocms-column = "1.11.0"
 djangocms-file = "3.0.0"
-djangocms-forms = "0.2.5"
+djangocms-forms-maintained = { git = "https://github.com/avryhof/djangocms-forms", rev = "eaa6415efeefc8a3018450d0ca7b864e0e4b9dd2" }
 djangocms-googlemap = "2.0.0"
 djangocms-icon = "2.0.0"
 djangocms-link = "3.0.0"

taccsite_cms/_settings/form_plugin.py

@@ -0,0 +1,128 @@
+"""Configure djangocms_forms and related apps"""
+
+from django.utils.translation import gettext_lazy as _
+
+########################
+# KNOWN ISSUES
+########################
+
+# Unable to export to Excel nor YAML
+# (No success hiding those formats from editor)
+# https://github.com/avryhof/djangocms-forms/issues/8
+
+########################
+# DJANGO_RECAPTCHA
+# https://github.com/avryhof/django-recaptcha/
+########################
+
+# To properly avoid client error about using test keys
+# RECAPTCHA_PUBLIC_KEY = '__this_must_be_on_server_not_here__'
+# RECAPTCHA_SECRET_KEY = '__this_must_be_on_server_not_here__'
+
+# To silence server error about using test keys
+# SILENCED_SYSTEM_CHECKS = ['captcha.recaptcha_test_key_error']
+
+########################
+# DJANGOCMS_FORMS
+# https://github.com/avryhof/djangocms-forms/
+########################
+
+# DJANGOCMS_FORMS_PLUGIN_MODULE = ('Generic')
+# DJANGOCMS_FORMS_PLUGIN_NAME = ('Form')
+
+# DJANGOCMS_FORMS_TEMPLATES = (
+#     ('djangocms_forms/form_template/default.html', ('Default')),
+# )
+DJANGOCMS_FORMS_USE_HTML5_REQUIRED = True
+
+# DJANGOCMS_FORMS_REDIRECT_DELAY = 1000
+
+DJANGOCMS_FORMS_SPAM_PROTECTIONS = (
+    (0, _('None')),
+    # (1, _('Honeypot')), # if necessary, learn how to use
+    (2, _('ReCAPTCHA')),
+)
+DEFAULT_SPAM_PROTECTION = 0
+
+# Improve form legibility and conceal unavailable features
+# https://github.com/avryhof/djangocms-forms/blob/97d7c21/djangocms_forms/cms_plugins.py#L69-L121
+DJANGOCMS_FORMS_FIELDSETS = (
+    (None, {'fields': ('name', 'form_template',),}),
+    (
+        _('Text'),
+        {
+            'description': _(
+                'The <strong>Title</strong> and <strong>Description</strong> '
+                'will display above the input fields and Submit button.'
+            ),
+            'fields': ('title', 'description','submit_btn_txt',),
+        },
+    ),
+    (
+        None,
+        {
+            'description': _(
+                'You can change the message that appears <em>after</em> someone submits your form. By default, this says "<strong>Thank you!</strong>"'
+            ),
+            'fields': ('post_submit_msg',),
+        },
+    ),
+    (
+        _('Redirect settings'),
+        {
+            'description': _(
+                'Whether and how to redirect the form <em>after</em> submission.'
+            ),
+            'fields': ('success_redirect', ('page_redirect', 'external_redirect'), 'redirect_delay',),
+        }
+    ),
+    (
+        _('Submission settings'),
+        {
+            'description': 'Whether to save form data.',
+            'fields': (
+                'save_data',
+                'spam_protection',
+            ),
+        },
+    ),
+    (
+        _('Submission e-mail (unavailable feature)'),
+        {
+            'classes': ('collapse',),
+            'description': 'Choose storage options to capture form data. You can enter an e-mail address to which to e-mail form submissions.',
+            'fields': (
+                # Submitting form with 'email_to' defined causes server error
+                # FAQ: We may need to setup some django e-mail server for these
+                'email_to',
+                'email_from',
+                'email_subject',
+                'email_uploaded_files',
+            ),
+        },
+    ),
+)
+
+DJANGOCMS_FORMS_FORMAT_CHOICES = (
+    ("csv", _("CSV")),
+    ("json", _("JSON")),
+)
+
+########################
+# DJANGO
+# https://docs.djangoproject.com/en/2.2/ref/settings/#form-renderer
+########################
+
+# Allow form template override
+# https://github.com/torchbox/django-recaptcha/issues/211#issuecomment-675608391
+FORM_RENDERER = 'django.forms.renderers.TemplatesSetting'
+
+########################
+# DJANGO CMS
+########################
+
+_INSTALLED_APPS = [
+    'djangocms_forms',         # form plugin for editors
+    'django.forms',            # support form template override
+    'captcha',                 # support recaptcha for djangocms_forms
+]

taccsite_cms/settings.py

@@ -16,6 +16,11 @@
 
 from django.utils.translation import gettext_lazy as _
 
+from taccsite_cms._settings.form_plugin import *
+from taccsite_cms._settings.form_plugin import (
+    _INSTALLED_APPS as form_plugin_INSTALLED_APPS
+)
+
 SECRET_KEY = 'CHANGE_ME'
 def gettext(s): return s
 
@@ -93,16 +98,6 @@ def gettext(s): return s
 GOOGLE_ANALYTICS_PROPERTY_ID = "UA-123ABC@%$&-#"
 GOOGLE_ANALYTICS_PRELOAD = True
 
-########################
-# CMS FORMS
-########################
-
-# Create CMS Forms
-# SEE: https://pypi.org/project/djangocms-forms/
-# SEE: https://www.google.com/recaptcha/admin/create
-DJANGOCMS_FORMS_RECAPTCHA_PUBLIC_KEY = ""
-DJANGOCMS_FORMS_RECAPTCHA_SECRET_KEY = ""
-
 ########################
 # ELASTICSEARCH
 ########################
@@ -352,6 +347,8 @@ def gettext(s): return s
     'aldryn_apphooks_config',  # search index & django CMS Blog
     'test_without_migrations', # run tests faster
 
+] + form_plugin_INSTALLED_APPS + [
+
     # core TACC CMS
     # HELP: If this were top of list, would TACC/Core-CMS/pull/169 fix break?
     'taccsite_cms',
@@ -461,18 +458,6 @@ def get_subdirs_as_module_names(path):
 
 DJANGOCMS_AUDIO_ALLOWED_EXTENSIONS = ['mp3', 'ogg', 'wav']
 
-# Djangocms Forms Settings.
-# SEE: https://github.com/mishbahr/djangocms-forms#configuration
-DJANGOCMS_FORMS_PLUGIN_MODULE = ('Generic')
-DJANGOCMS_FORMS_PLUGIN_NAME = ('Form')
-
-DJANGOCMS_FORMS_TEMPLATES = (
-    ('djangocms_forms/form_template/default.html', ('Default')),
-)
-DJANGOCMS_FORMS_USE_HTML5_REQUIRED = False
-
-DJANGOCMS_FORMS_REDIRECT_DELAY = 1
-
 # Elasticsearch Indexing
 HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ]
 HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor'

taccsite_cms/static/djangocms_forms/css/djangocms_forms.css

@@ -0,0 +1,3 @@
+/* SEE: ../../site_cms/css/src/app.djangocms_forms.css */
+/* FAQ: We uses future syntax that must be processed to work in the present;
+        and the process does not support outputting files to this directory */

taccsite_cms/static/site_cms/css/src/_imports/components/c-button.css

@@ -0,0 +1,7 @@
+@import url("@tacc/core-styles/src/lib/_imports/components/c-button.css");
+
+.c-button {
+  --max-width: unset;
+
+  font-size: 1.6rem;
+}