Redesign of email settings (#2426)

Co-authored-by: Felix Rindt <felix@rindt.me>

src/pretix/control/forms/__init__.py

@@ -48,7 +48,7 @@ from django.utils.timezone import now
 from django.utils.translation import gettext_lazy as _
 from django_scopes.forms import SafeModelMultipleChoiceField
 
-from ...base.forms import I18nModelForm, SecretKeySettingsField
+from ...base.forms import I18nModelForm
 
 # Import for backwards compatibility with okd import paths
 from ...base.forms.widgets import (  # noqa
@@ -373,49 +373,6 @@ class FontSelect(forms.RadioSelect):
     option_template_name = 'pretixcontrol/font_option.html'
 
 
-class SMTPSettingsMixin(forms.Form):
-    smtp_use_custom = forms.BooleanField(
-        label=_("Use custom SMTP server"),
-        help_text=_("All mail related to your event will be sent over the smtp server specified by you."),
-        required=False
-    )
-    smtp_host = forms.CharField(
-        label=_("Hostname"),
-        required=False,
-        widget=forms.TextInput(attrs={'placeholder': 'mail.example.org'})
-    )
-    smtp_port = forms.IntegerField(
-        label=_("Port"),
-        required=False,
-        widget=forms.TextInput(attrs={'placeholder': 'e.g. 587, 465, 25, ...'})
-    )
-    smtp_username = forms.CharField(
-        label=_("Username"),
-        widget=forms.TextInput(attrs={'placeholder': 'myuser@example.org'}),
-        required=False
-    )
-    smtp_password = SecretKeySettingsField(
-        label=_("Password"),
-        required=False,
-    )
-    smtp_use_tls = forms.BooleanField(
-        label=_("Use STARTTLS"),
-        help_text=_("Commonly enabled on port 587."),
-        required=False
-    )
-    smtp_use_ssl = forms.BooleanField(
-        label=_("Use SSL"),
-        help_text=_("Commonly enabled on port 465."),
-        required=False
-    )
-
-    def clean(self):
-        data = super().clean()
-        if data.get('smtp_use_tls') and data.get('smtp_use_ssl'):
-            raise ValidationError(_('You can activate either SSL or STARTTLS security, but not both at the same time.'))
-        return data
-
-
 class ItemMultipleChoiceField(SafeModelMultipleChoiceField):
     def label_from_instance(self, obj):
         return str(obj) if obj.active else mark_safe(f'<strike class="text-muted">{escape(obj)}</strike>')

src/pretix/control/forms/event.py

@@ -64,7 +64,7 @@ from pretix.base.settings import (
     PERSON_NAME_SCHEMES, PERSON_NAME_TITLE_GROUPS, validate_event_settings,
 )
 from pretix.control.forms import (
-    MultipleLanguagesWidget, SlugWidget, SMTPSettingsMixin, SplitDateTimeField,
+    MultipleLanguagesWidget, SlugWidget, SplitDateTimeField,
     SplitDateTimePickerWidget,
 )
 from pretix.control.forms.widgets import Select2
@@ -865,10 +865,9 @@ def contains_web_channel_validate(val):
         raise ValidationError(_("The online shop must be selected to receive these emails."))
 
 
-class MailSettingsForm(SMTPSettingsMixin, SettingsForm):
+class MailSettingsForm(SettingsForm):
     auto_fields = [
         'mail_prefix',
-        'mail_from',
         'mail_from_name',
         'mail_attach_ical',
         'mail_attach_tickets',

src/pretix/control/forms/mailsetup.py

@@ -0,0 +1,129 @@
+#
+# This file is part of pretix (Community Edition).
+#
+# Copyright (C) 2014-2020 Raphael Michel and contributors
+# Copyright (C) 2020-2021 rami.io GmbH and contributors
+#
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+# Public License as published by the Free Software Foundation in version 3 of the License.
+#
+# ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
+# applicable granting you additional permissions and placing additional restrictions on your usage of this software.
+# Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
+# this file, see <https://pretix.eu/about/en/license>.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
+# <https://www.gnu.org/licenses/>.
+#
+import ipaddress
+import socket
+
+from django import forms
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+from pretix.base.forms import SecretKeySettingsField, SettingsForm
+
+
+class SMTPMailForm(SettingsForm):
+    mail_from = forms.EmailField(
+        label=_("Sender address"),
+        help_text=_("Sender address for outgoing emails"),
+        required=True,
+    )
+    smtp_host = forms.CharField(
+        label=_("Hostname"),
+        required=True,
+        widget=forms.TextInput(attrs={'placeholder': 'mail.example.org'})
+    )
+    smtp_port = forms.IntegerField(
+        label=_("Port"),
+        required=True,
+        widget=forms.TextInput(attrs={'placeholder': 'e.g. 587, 465, 25, ...'})
+    )
+    smtp_username = forms.CharField(
+        label=_("Username"),
+        widget=forms.TextInput(attrs={'placeholder': 'myuser@example.org'}),
+        required=False
+    )
+    smtp_password = SecretKeySettingsField(
+        label=_("Password"),
+        required=False,
+    )
+    smtp_use_tls = forms.BooleanField(
+        label=_("Use STARTTLS"),
+        help_text=_("Commonly enabled on port 587."),
+        required=False
+    )
+    smtp_use_ssl = forms.BooleanField(
+        label=_("Use SSL"),
+        help_text=_("Commonly enabled on port 465."),
+        required=False
+    )
+
+    def clean(self):
+        data = super().clean()
+        if data.get('smtp_use_tls') and data.get('smtp_use_ssl'):
+            raise ValidationError(_('You can activate either SSL or STARTTLS security, but not both at the same time.'))
+        for k, v in self.fields.items():
+            val = data.get(k)
+            if v._required and not val:
+                self.add_error(k, _('This field is required.'))
+        return data
+
+    def clean_smtp_host(self):
+        v = self.cleaned_data['smtp_host']
+        if not settings.MAIL_CUSTOM_SMTP_ALLOW_PRIVATE_NETWORKS:
+            try:
+                if ipaddress.ip_address(v).is_private:
+                    raise ValidationError(_('You are not allowed to use this mail server, please choose one with a '
+                                            'public IP address instead.'))
+            except ValueError:
+                try:
+                    if ipaddress.ip_address(socket.gethostbyname(v)).is_private:
+                        raise ValidationError(_('You are not allowed to use this mail server, please choose one with a '
+                                                'public IP address instead.'))
+                except OSError:
+                    raise ValidationError(_('We were unable to resolve this hostname.'))
+        return v
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.obj.settings.mail_from in (settings.MAIL_FROM, settings.MAIL_FROM_ORGANIZERS):
+            self.initial.pop('mail_from')
+
+        for k, v in self.fields.items():
+            v._required = v.required
+            v.required = False
+            v.widget.is_required = False
+
+
+class SimpleMailForm(SettingsForm):
+    mail_from = forms.EmailField(
+        label=_("Sender address"),
+        help_text=_("Sender address for outgoing emails"),
+        required=True,
+    )
+
+    def clean(self):
+        cleaned_data = super().clean()
+        for k, v in self.fields.items():
+            val = cleaned_data.get(k)
+            if v._required and not val:
+                self.add_error(k, _('This field is required.'))
+        return cleaned_data
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.obj.settings.mail_from in (settings.MAIL_FROM, settings.MAIL_FROM_ORGANIZERS):
+            self.initial.pop('mail_from')
+
+        for k, v in self.fields.items():
+            v._required = v.required
+            v.required = False
+            v.widget.is_required = False

src/pretix/control/forms/organizer.py

@@ -60,9 +60,7 @@ from pretix.base.models import (
     MembershipType, Organizer, Team,
 )
 from pretix.base.settings import PERSON_NAME_SCHEMES, PERSON_NAME_TITLE_GROUPS
-from pretix.control.forms import (
-    ExtFileField, SMTPSettingsMixin, SplitDateTimeField,
-)
+from pretix.control.forms import ExtFileField, SplitDateTimeField
 from pretix.control.forms.event import (
     SafeEventMultipleChoiceField, multimail_validate,
 )
@@ -358,9 +356,8 @@ class OrganizerSettingsForm(SettingsForm):
         ]
 
 
-class MailSettingsForm(SMTPSettingsMixin, SettingsForm):
+class MailSettingsForm(SettingsForm):
     auto_fields = [
-        'mail_from',
         'mail_from_name',
     ]