Skip to content

Latest commit

 

History

History
128 lines (88 loc) · 3.36 KB

developer.md

File metadata and controls

128 lines (88 loc) · 3.36 KB
Raw

Developer setup and configuration

Development Setup

With a virtual environment activated, install the package in editable mode:

pip install -e ".[development]"

There is a testapp provided that is a fully configured minimal setup using Wagtail v5.1+

Setup the app:

make migrate

Optional:

make superuser

This add an admin account with login details of Username: admin Password: changeme

Run the development server:

make run

View the site at http://localhost:8000 or add /admin to login.

A convenient SMTP server

If you have docker and docker-compose installed

make mail

Will spin up a Mailhog instance and simulate a real email inbox. View the Mailhog app in your browser at http://localhost:8025

Now when you submit the form with settings to send the notification email you will see the email in the Mailhog inbox

Configuration

Optional configuration settings.

Honeypot Text Field

You can change the text field name by adding the following to your settings.

HONEYPOT_NAME_FIELD = "new-field-name"

The honeypot text field would be rendered ...

<input type="text" name="new-field-name" id="new-field-name" data-new-field-name="" tabindex="-1" autocomplete="off">

You can change the time field name and/or the time interval by adding the following to your settings.

HONEYPOT_TIME_FIELD = "time-field-name"
HONEYPOT_TIME_INTERVAL = 1 # seconds

The time field and checks a time interval between the form being displayed and submitted.
The default interval is 3 seconds.
If the form is submitted before the interval expires the submission is ignored.

Honeypot Time Field

The honeypot time field would be rendered ...

<input type="hidden" name="time-field-name" id="time-field-name" data-time-field-name="" tabindex="-1" autocomplete="off">

Custom process_form_submission method

This is a copy of the package process_form_submission() method.

If need be you can use this a basis and override it in your FormPage model and alter it for your own needs.

class HoneypotFormSubmissionMixin(AbstractEmailForm):
    """
    Adds the overridden process_form_submission method to your form model
    """

    def process_form_submission(self, form):
        honeypot_name_field = getattr(settings, "HONEYPOT_NAME_FIELD", "whf_name")
        honeypot_time_field = getattr(settings, "HONEYPOT_TIME_FIELD", "whf_time")
        honeypot_time_interval = getattr(settings, "HONEYPOT_TIME_INTERVAL", 3)

        # honey pot disabled
        if not self.honeypot:
            return super().process_form_submission(form)

        # honeypot enabled
        score = []
        if honeypot_name_field in form.data and honeypot_time_field in form.data:
            score.append(form.data[honeypot_name_field] == "")
            score.append(
                self.time_diff(form.data[honeypot_time_field], honeypot_time_interval)
            )
            return (
                super().process_form_submission(form)
                if len(score) and all(score)
                else None
            )

    @staticmethod
    def time_diff(value, interval):
        now_time = str(time.time()).split(".")[0]
        diff = abs(int(now_time) - int(value))
        return True if diff > interval else False

    class Meta:
        abstract = True