wagtailstreamforms 0.0.0__py3-none-any.whl

wagtailstreamforms/models/file.py

@@ -0,0 +1,35 @@
+from django.db import models, transaction
+from django.db.models.signals import post_delete
+from django.utils.translation import gettext_lazy as _
+
+
+class FormSubmissionFile(models.Model):
+    """Data for a form submission file."""
+
+    submission = models.ForeignKey(
+        "FormSubmission",
+        verbose_name=_("Submission"),
+        on_delete=models.CASCADE,
+        related_name="files",
+    )
+    field = models.CharField(verbose_name=_("Field"), max_length=255)
+    file = models.FileField(verbose_name=_("File"), upload_to="streamforms/")
+
+    def __str__(self):
+        return self.file.name
+
+    class Meta:
+        ordering = ["field", "file"]
+        verbose_name = _("Form submission file")
+
+    @property
+    def url(self):
+        return self.file.url
+
+
+def delete_file_from_storage(instance, **kwargs):
+    """Cleanup deleted files from disk"""
+    transaction.on_commit(lambda: instance.file.delete(False))
+
+
+post_delete.connect(delete_file_from_storage, sender=FormSubmissionFile)

wagtailstreamforms/models/form.py

@@ -0,0 +1,188 @@
+import uuid
+
+from django.conf import settings
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from wagtail import VERSION as WAGTAIL_VERSION
+from wagtail.admin.panels import (
+    FieldPanel,
+    MultiFieldPanel,
+    ObjectList,
+    PageChooserPanel,
+    TabbedInterface,
+)
+from wagtail.models import Site
+
+from wagtailstreamforms import hooks
+from wagtailstreamforms.conf import get_setting
+from wagtailstreamforms.fields import HookSelectField
+from wagtailstreamforms.forms import FormBuilder
+from wagtailstreamforms.streamfield import FormFieldsStreamField
+from wagtailstreamforms.utils.general import get_slug_from_string
+from wagtailstreamforms.utils.loading import get_advanced_settings_model
+
+from .submission import FormSubmission
+
+
+class FormQuerySet(models.QuerySet):
+    def for_site(self, site):
+        """Return all forms for a specific site."""
+        return self.filter(site=site)
+
+
+class AbstractForm(models.Model):
+    site = models.ForeignKey(Site, on_delete=models.SET_NULL, null=True, blank=True)
+    title = models.CharField(_("Title"), max_length=255)
+    slug = models.SlugField(
+        _("Slug"),
+        allow_unicode=True,
+        max_length=255,
+        unique=True,
+        help_text=_("Used to identify the form in template tags"),
+    )
+    template_name = models.CharField(
+        _("Template"), max_length=255, choices=get_setting("FORM_TEMPLATES")
+    )
+    fields = FormFieldsStreamField([], use_json_field=True, verbose_name=_("Fields"))
+    submit_button_text = models.CharField(
+        _("Submit button text"), max_length=100, default="Submit"
+    )
+    success_message = models.CharField(
+        _("Success message"),
+        blank=True,
+        max_length=255,
+        help_text=_(
+            "An optional success message to show when the form has been successfully submitted"
+        ),
+    )
+    error_message = models.CharField(
+        _("Error message"),
+        blank=True,
+        max_length=255,
+        help_text=_("An optional error message to show when the form has validation errors"),
+    )
+    post_redirect_page = models.ForeignKey(
+        "wagtailcore.Page",
+        verbose_name=_("Post redirect page"),
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="+",
+        help_text=_("The page to redirect to after a successful submission"),
+    )
+    process_form_submission_hooks = HookSelectField(verbose_name=_("Submission hooks"), blank=True)
+
+    objects = FormQuerySet.as_manager()
+
+    settings_panels = [
+        FieldPanel("title", classname="full"),
+        FieldPanel("slug"),
+        FieldPanel("template_name"),
+        FieldPanel("submit_button_text"),
+        MultiFieldPanel(
+            [FieldPanel("success_message"), FieldPanel("error_message")], _("Messages")
+        ),
+        FieldPanel("process_form_submission_hooks", classname="choice_field"),
+        PageChooserPanel("post_redirect_page"),
+    ]
+
+    field_panels = [FieldPanel("fields")]
+
+    edit_handler = TabbedInterface(
+        [
+            ObjectList(settings_panels, heading=_("General")),
+            ObjectList(field_panels, heading=_("Fields")),
+        ]
+    )
+
+    def __str__(self):
+        return self.title
+
+    class Meta:
+        abstract = True
+        ordering = ["title"]
+        verbose_name = _("Form")
+        verbose_name_plural = _("Forms")
+
+    def copy(self):
+        """Copy this form and its fields."""
+
+        form_copy = Form(
+            site=self.site,
+            title=self.title,
+            slug=uuid.uuid4(),
+            template_name=self.template_name,
+            fields=self.fields,
+            submit_button_text=self.submit_button_text,
+            success_message=self.success_message,
+            error_message=self.error_message,
+            post_redirect_page=self.post_redirect_page,
+            process_form_submission_hooks=self.process_form_submission_hooks,
+        )
+        form_copy.save()
+
+        # additionally copy the advanced settings if they exist
+        SettingsModel = get_advanced_settings_model()
+
+        if SettingsModel:
+            try:
+                advanced = SettingsModel.objects.get(form=self)
+                advanced.pk = None
+                advanced.form = form_copy
+                advanced.save()
+            except SettingsModel.DoesNotExist:
+                pass
+
+        return form_copy
+
+    copy.alters_data = True
+
+    def get_data_fields(self):
+        """Returns a list of tuples with (field_name, field_label)."""
+
+        data_fields = [("submit_time", _("Submission date"))]
+        data_fields += [
+            (get_slug_from_string(field["value"]["label"]), field["value"]["label"])
+            for field in self.get_form_fields()
+        ]
+        if getattr(settings, "WAGTAILSTREAMFORMS_SHOW_FORM_REFERENCE", False):
+            data_fields += [("form_reference", _("Form reference"))]
+        return data_fields
+
+    def get_form(self, *args, **kwargs):
+        """Returns the form."""
+
+        form_class = self.get_form_class()
+        return form_class(*args, **kwargs)
+
+    def get_form_class(self):
+        """Returns the form class."""
+
+        return FormBuilder(self.get_form_fields()).get_form_class()
+
+    def get_form_fields(self):
+        """Returns the form field's stream data."""
+
+        if WAGTAIL_VERSION >= (2, 12):
+            form_fields = self.fields.raw_data
+        else:
+            form_fields = self.fields.stream_data
+        for fn in hooks.get_hooks("construct_submission_form_fields"):
+            form_fields = fn(form_fields)
+        return form_fields
+
+    def get_submission_class(self):
+        """Returns submission class."""
+
+        return FormSubmission
+
+    def process_form_submission(self, form):
+        """Runs each hook if selected in the form."""
+
+        for fn in hooks.get_hooks("process_form_submission"):
+            if fn.__name__ in self.process_form_submission_hooks:
+                fn(self, form)
+
+
+class Form(AbstractForm):
+    pass

wagtailstreamforms/models/submission.py

@@ -0,0 +1,27 @@
+import json
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class FormSubmission(models.Model):
+    """Data for a form submission."""
+
+    form_data = models.TextField(_("Form data"))
+    form = models.ForeignKey("Form", verbose_name=_("Form"), on_delete=models.CASCADE)
+    submit_time = models.DateTimeField(_("Submit time"), auto_now_add=True)
+
+    def get_data(self):
+        """Returns dict with form data."""
+        form_data = json.loads(self.form_data)
+
+        form_data.update({"submit_time": self.submit_time})
+
+        return form_data
+
+    def __str__(self):
+        return self.form_data
+
+    class Meta:
+        ordering = ["-submit_time"]
+        verbose_name = _("Form submission")

wagtailstreamforms/serializers.py

@@ -0,0 +1,11 @@
+from django.core.serializers.json import DjangoJSONEncoder
+from django.db import models
+
+
+class FormSubmissionSerializer(DjangoJSONEncoder):
+    """Form submission serializer"""
+
+    def default(self, o):
+        if isinstance(o, models.Model):
+            return str(o)
+        return super().default(o)

wagtailstreamforms/streamfield.py

@@ -0,0 +1,48 @@
+from django.core.exceptions import ImproperlyConfigured
+from wagtail import blocks
+from wagtail.fields import StreamField
+
+from wagtailstreamforms.fields import BaseField, get_fields
+
+
+class FormFieldStreamBlock(blocks.StreamBlock):
+    """Add all registered instances of BaseField's get_form_block method to the streamfield."""
+
+    def __init__(self, local_blocks=None, **kwargs) -> None:
+        self._constructor_kwargs = kwargs
+
+        # Note, this is calling BaseStreamBlock's super __init__, not FormFieldStreamBlock's.
+        # We don't want BaseStreamBlock.__init__() to run, because it tries to assign to
+        # self.child_blocks, which we've overridden with a @property. But we DO want
+        # Block.__init__() to run.
+        super(blocks.BaseStreamBlock, self).__init__()
+
+        self._child_blocks = self.base_blocks.copy()
+
+        for name, field_class in get_fields().items():
+            # ensure the field is a subclass of BaseField.
+            if not issubclass(field_class, BaseField):
+                raise ImproperlyConfigured(
+                    "'%s' must be a subclass of '%s'" % (field_class, BaseField)
+                )
+
+            # assign the block
+            block = field_class().get_form_block()
+            block.set_name(name)
+            self._child_blocks[name] = block
+
+        self._dependencies = self._child_blocks.values()
+
+    @property
+    def child_blocks(self):
+        return self._child_blocks
+
+    @property
+    def dependencies(self):
+        return self._dependencies
+
+
+class FormFieldsStreamField(StreamField):
+    def __init__(self, block_types, **kwargs) -> None:
+        super().__init__(block_types, **kwargs)
+        self.stream_block = FormFieldStreamBlock(block_types, required=not self.blank)

wagtailstreamforms/templates/streamforms/advanced_settings.html

@@ -0,0 +1,25 @@
+{% extends "wagtailadmin/base.html" %}
+{% load i18n %}
+{% block titletag %}{% blocktrans with form_title=object %}Advanced form settings for {{ form_title }}{% endblocktrans %}{% endblock %}
+{% block bodyclass %}menu-explorer{% endblock %}
+
+{% block content %}
+    {% trans "Advanced form settings" as title_str %}
+    {% include "wagtailadmin/shared/header.html" with title=title_str subtitle=object icon="doc-empty-inverse" %}
+
+    <div class="nice-padding">
+        <form action="." method="POST" novalidate>
+            {% csrf_token %}
+            <ul class="fields">
+                {% block visible_fields %}
+                    {% for field in form.visible_fields %}
+                        {% include "wagtailadmin/shared/field.html" %}
+                    {% endfor %}
+                {% endblock %}
+                <li>
+                    <input type="submit" value="{% trans 'Save' %}" class="button" />
+                </li>
+            </ul>
+        </form>
+    </div>
+{% endblock %}

wagtailstreamforms/templates/streamforms/confirm_copy.html

@@ -0,0 +1,26 @@
+{% extends "wagtailadmin/base.html" %}
+{% load i18n %}
+{% block titletag %}{% blocktrans with form_title=object.title|capfirst %}Copy of {{ form_title }}{% endblocktrans %}{% endblock %}
+{% block bodyclass %}menu-explorer{% endblock %}
+
+{% block content %}
+    {% trans "Copy" as copy_str %}
+    {% include "wagtailadmin/shared/header.html" with title=copy_str subtitle=object.title icon="doc-empty-inverse" %}
+
+    <div class="nice-padding">
+        <p>{% trans 'Are you sure you want to copy this form?' %}</p>
+        <form action="." method="POST" novalidate>
+            {% csrf_token %}
+            <ul class="fields">
+                {% block visible_fields %}
+                    {% for field in form.visible_fields %}
+                        {% include "wagtailadmin/shared/field.html" %}
+                    {% endfor %}
+                {% endblock %}
+                <li>
+                    <input type="submit" value="{% trans 'Copy' %}" class="button" />
+                </li>
+            </ul>
+        </form>
+    </div>
+{% endblock %}

wagtailstreamforms/templates/streamforms/confirm_delete.html

@@ -0,0 +1,23 @@
+{% extends "wagtailadmin/base.html" %}.
+{% load i18n %}
+{% block titletag %}{% blocktrans with form_title=object.title|capfirst %}Submissions of {{ form_title }}{% endblocktrans %}{% endblock %}
+{% block bodyclass %}menu-explorer{% endblock %}
+
+{% block content %}
+    {% trans "Delete form data" as del_str %}
+    {% include "wagtailadmin/shared/header.html" with title=del_str subtitle=object.title icon="doc-empty-inverse" %}
+
+    <div class="nice-padding">
+        <p>
+            {% blocktrans count counter=submissions.count %}
+                Are you sure you want to delete this form submission?
+            {% plural %}
+                Are you sure you want to delete these form submissions?
+            {% endblocktrans %}
+        </p>
+        <form action="{% url 'wagtailstreamforms:streamforms_delete_submissions' object.id %}?{{ request.GET.urlencode }}" method="POST">
+            {% csrf_token %}
+            <input type="submit" value="{% trans 'Delete' %}" class="button serious">
+        </form>
+    </div>
+{% endblock %}

wagtailstreamforms/templates/streamforms/form_block.html

@@ -0,0 +1,10 @@
+<h2>{{ value.form.title }}</h2>
+<form{% if form.is_multipart %} enctype="multipart/form-data"{% endif %} action="{{ value.form_action }}" method="post" novalidate>
+    {{ form.media }}
+    {% csrf_token %}
+    {% for hidden in form.hidden_fields %}{{ hidden }}{% endfor %}
+    {% for field in form.visible_fields %}
+        {% include 'streamforms/partials/form_field.html' %}
+    {% endfor %}
+    <input type="submit" value="{{ value.form.submit_button_text }}">
+</form>

wagtailstreamforms/templates/streamforms/index_submissions.html

@@ -0,0 +1,104 @@
+{% extends "wagtailadmin/base.html" %}
+{% load i18n %}
+{% block titletag %}{% blocktrans with form_title=object.title|capfirst %}Submissions of {{ form_title }}{% endblocktrans %}{% endblock %}
+{% block extra_js %}
+    {{ block.super }}
+    {% include "streamforms/wagtailadmin/shared/datetimepicker_translations.html" %}
+
+    <script>
+        $(function() {
+            $('#id_date_from').datetimepicker({
+                timepicker: false,
+                format: 'Y-m-d',
+            });
+            $('#id_date_to').datetimepicker({
+                timepicker: false,
+                format: 'Y-m-d',
+            });
+            var selectAllCheckbox = document.getElementById('select-all');
+            var deleteButton = document.getElementById('delete-submissions');
+            var selectedSubmissions = {};
+            function updateActions() {
+                var submissionCheckboxes = $('input[type=checkbox].select-submission');
+                var someSubmissionsSelected = submissionCheckboxes.is(':checked');
+                var everySubmissionSelected = !submissionCheckboxes.is(':not(:checked)');
+                // Select all box state
+                if (everySubmissionSelected) {
+                    // Every submission has been selected
+                    selectAllCheckbox.checked = true;
+                    selectAllCheckbox.indeterminate = false;
+                } else if (someSubmissionsSelected) {
+                    // At least one, but not all submissions have been selected
+                    selectAllCheckbox.checked = false;
+                    selectAllCheckbox.indeterminate = true;
+                } else {
+                    // No submissions have been selected
+                    selectAllCheckbox.checked = false;
+                    selectAllCheckbox.indeterminate = false;
+                }
+                // Delete button state
+                if (someSubmissionsSelected) {
+                    deleteButton.classList.remove('disabled')
+                    deleteButton.style.visibility = "visible";
+                } else {
+                    deleteButton.classList.add('disabled')
+                    deleteButton.style.visibility = "hidden";
+                }
+            }
+            // Event handlers
+            $(selectAllCheckbox).on('change', function() {
+                let checked = this.checked;
+                // Update checkbox states
+                $('input[type=checkbox].select-submission').each(function() {
+                    this.checked = checked;
+                });
+                updateActions();
+            });
+            $('input[type=checkbox].select-submission').on('change', function() {
+                updateActions();
+            });
+            // initial call to updateActions to bring delete button state in sync with checkboxes
+            // in the case that some checkboxes are pre-checked (which will be the case in some
+            // browsers when using the back button)
+            $(document).ready(function() { updateActions() });
+        });
+    </script>
+{% endblock %}
+{% block content %}
+    <header class="nice-padding hasform">
+        <form action="" method="get" novalidate>
+            <div class="row">
+                <div class="left">
+                    <div class="col">
+                        <h1 class="icon icon-form">
+                            {% blocktrans with form_title=object.title|capfirst %}Form data <span>{{ form_title }}</span>{% endblocktrans %}
+                        </h1>
+                    </div>
+                    <div class="col search-bar">
+                        <ul class="fields row rowflush">
+                            {% for field in filter_form %}
+                                {% include "wagtailadmin/shared/field.html" with field=field field_classes="field-small" li_classes="col4" %}
+                            {% endfor %}
+                            <li class="submit col2">
+                                <button name="action" value="filter" class="button button-filter">{% trans 'Filter' %}</button>
+                            </li>
+                        </ul>
+                    </div>
+                </div>
+                <div class="right">
+                    <button name="action" value="CSV" class="button bicolor icon icon-download">{% trans 'Download CSV' %}</button>
+                </div>
+            </div>
+        </form>
+    </header>
+    <div>
+        {% if object_list %}
+            <form action="{% url 'wagtailstreamforms:streamforms_delete_submissions' object.id %}" method="get">
+                {% include "streamforms/list_submissions.html" %}
+                {% include "streamforms/partials/pagination_nav.html" with items=page_obj %}
+            </form>
+        {% else %}
+            <p class="no-results-message nice-padding">{% blocktrans with title=object.title %}There have been no submissions of the '{{ title }}' form.{% endblocktrans %}</p>
+        {% endif %}
+    </div>
+{% endblock %}

wagtailstreamforms/templates/streamforms/list_submissions.html

@@ -0,0 +1,56 @@
+{% load i18n %}
+<div class="overflow">
+<table class="listing">
+    <col />
+    <col />
+    <col />
+    <thead>
+        {% if has_delete_permission %}
+        <tr>
+            <th colspan="{{ data_headings|length|add:1 }}">
+                <button class="button no" id="delete-submissions" style="visibility: hidden">{% trans "Delete selected submissions" %}</button>
+            </th>
+        </tr>
+        {% endif %}
+        <tr>
+            {% if has_delete_permission %}
+                <th><input type="checkbox" id="select-all" /></th>
+            {% endif %}
+            {% for heading in data_headings %}
+                <th>{{ heading }}</th>
+            {% endfor %}
+        </tr>
+    </thead>
+    <tbody>
+        {% for row in data_rows %}
+            <tr>
+                {% if has_delete_permission %}
+                <td>
+                    <input type="checkbox" name="selected-submissions" class="select-submission" value="{{ row.model_id }}" />
+                </td>
+                {% endif %}
+                {% for cell in row.fields %}
+                    <td>
+                        {{ cell }}
+                    </td>
+                {% endfor %}
+                <td>
+            </tr>
+            {% if row.files %}
+            <tr>
+                <td>{% trans 'Files' %}</td>
+                <td colspan="{{ row.fields|length }}">
+                    <ul>
+                        {% for file in row.files %}
+                        <li style="display: inline; margin-right: 20px;">
+                            <a href="{{ file.url }}" target="_blank">{{ file }}</a>
+                        </li>
+                        {% endfor %}
+                    </ul>
+                </td>
+            </tr>
+            {% endif %}
+        {% endfor %}
+    </tbody>
+</table>
+</div>

wagtailstreamforms/templates/streamforms/non_existent_form.html

@@ -0,0 +1,2 @@
+{% load i18n %}
+<p>{% trans 'Sorry, this form has been deleted.' %}</p>

wagtailstreamforms/templates/streamforms/partials/form_field.html

@@ -0,0 +1,6 @@
+<div class="field-row">
+    {{ field.label_tag }}
+    {{ field }}
+    {% if field.help_text %}<p class="help-text">{{ field.help_text }}</p>{% endif %}
+    {{ field.errors }}
+</div>

wagtailstreamforms/templates/streamforms/partials/pagination_nav.html

@@ -0,0 +1,17 @@
+{% load i18n streamforms_tags %}
+
+<div class="pagination">
+    <p>{% blocktrans with page_num=items.number total_pages=items.paginator.num_pages %}Page {{ page_num }} of {{ total_pages }}.{% endblocktrans %}</p>
+    <ul>
+        <li class="prev">
+            {% if items.has_previous %}
+            <a href="?{% url_replace p=items.previous_page_number %}" class="icon icon-arrow-left">{% trans 'Previous' %}</a>
+            {% endif %}
+        </li>
+        <li class="next">
+            {% if items.has_next %}
+            <a href="?{% url_replace p=items.next_page_number %}" class="icon icon-arrow-right-after">{% trans 'Next' %}</a>
+            {% endif %}
+        </li>
+    </ul>
+</div>

wagtailstreamforms/templates/streamforms/wagtailadmin/shared/datetimepicker_translations.html

@@ -0,0 +1,39 @@
+{% load i18n %}
+
+<script>
+    $.fn.datetimepicker.defaults.i18n.wagtail_custom_locale = {
+        months: [
+            '{% trans "January" %}',
+            '{% trans "February" %}',
+            '{% trans "March" %}',
+            '{% trans "April" %}',
+            '{% trans "May" %}',
+            '{% trans "June" %}',
+            '{% trans "July" %}',
+            '{% trans "August" %}',
+            '{% trans "September" %}',
+            '{% trans "October" %}',
+            '{% trans "November" %}',
+            '{% trans "December" %}'
+        ],
+        dayOfWeek: [
+            '{% trans "Sunday" %}',
+            '{% trans "Monday" %}',
+            '{% trans "Tuesday" %}',
+            '{% trans "Wednesday" %}',
+            '{% trans "Thursday" %}',
+            '{% trans "Friday" %}',
+            '{% trans "Saturday" %}'
+        ],
+        dayOfWeekShort: [
+            '{% trans "Sun" %}',
+            '{% trans "Mon" %}',
+            '{% trans "Tue" %}',
+            '{% trans "Wed" %}',
+            '{% trans "Thu" %}',
+            '{% trans "Fri" %}',
+            '{% trans "Sat" %}'
+        ],
+    }
+    $.datetimepicker.setLocale('wagtail_custom_locale');
+</script>