netbox-community-netbox/netbox/extras/forms/scripts.py

from django import forms
from django.utils.translation import gettext as _

from utilities.forms import BootstrapMixin
from utilities.forms.widgets import DateTimePicker, SelectDurationWidget
from utilities.utils import local_now

__all__ = (
    'ScriptForm',
)


class ScriptForm(BootstrapMixin, forms.Form):
    _commit = forms.BooleanField(
        required=False,
        initial=True,
        label=_("Commit changes"),
        help_text=_("Commit changes to the database (uncheck for a dry-run)")
    )
    _schedule_at = forms.DateTimeField(
        required=False,
        widget=DateTimePicker(),
        label=_("Schedule at"),
        help_text=_("Schedule execution of script to a set time"),
    )
    _interval = forms.IntegerField(
        required=False,
        min_value=1,
        label=_("Recurs every"),
        widget=SelectDurationWidget(),
        help_text=_("Interval at which this script is re-run (in minutes)")
    )

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        # Annotate the current system time for reference
        now = local_now().strftime('%Y-%m-%d %H:%M:%S')
        self.fields['_schedule_at'].help_text += f' (current time: <strong>{now}</strong>)'

        # Move _commit and _schedule_at to the end of the form
        schedule_at = self.fields.pop('_schedule_at')
        interval = self.fields.pop('_interval')
        commit = self.fields.pop('_commit')
        self.fields['_schedule_at'] = schedule_at
        self.fields['_interval'] = interval
        self.fields['_commit'] = commit

    def clean(self):
        scheduled_time = self.cleaned_data['_schedule_at']
        if scheduled_time and scheduled_time < local_now():
            raise forms.ValidationError(_('Scheduled time must be in the future.'))

        # When interval is used without schedule at, raise an exception
        if self.cleaned_data['_interval'] and not scheduled_time:
            self.cleaned_data['_schedule_at'] = local_now()

        return self.cleaned_data

    @property
    def requires_input(self):
        """
        A boolean indicating whether the form requires user input (ignore the built-in fields).
        """
        return bool(len(self.fields) > 3)