Make the Matrix ID field configurable #1

pretix_matrix_inviter/forms.py

 from django import forms
 from django.utils.translation import ugettext_lazy as _
+from i18nfield.forms import I18nFormField, I18nTextInput
 from pretix.base.forms import SettingsForm
 
 
@@ -25,6 +26,11 @@ class MatrixInviterForm(SettingsForm):
         regex="![^:]+:.+",
         strip=True,
     )
+    matrix_inviter_hint = I18nFormField(
+        widget=I18nTextInput,
+        label=_("Help text for the Matrix ID field"),
+        required=True,
+    )
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

pretix_matrix_inviter/locale/de/LC_MESSAGES/django.po

@@ -2,7 +2,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-02-04 17:28+0100\n"
+"POT-Creation-Date: 2022-02-04 19:41+0100\n"
 "PO-Revision-Date: \n"
 "Last-Translator: Felix Schäfer\n"
 "Language-Team: \n"
@@ -21,45 +21,49 @@ msgid ""
 "Space."
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:11
+#: pretix_matrix_inviter/forms.py:12
 msgid "Ask Matrix ID for"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:16
+#: pretix_matrix_inviter/forms.py:17
 msgid "Authorization token"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:20
+#: pretix_matrix_inviter/forms.py:21
 msgid "Matrix server"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:24
+#: pretix_matrix_inviter/forms.py:25
 msgid "Matrix room"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:33
-msgid "Matrix ID"
+#: pretix_matrix_inviter/forms.py:31
+msgid "Help text for the Matrix ID field"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:38
-msgid "Enter a Matrix ID of the form @username:homeserver.tld"
+#: pretix_matrix_inviter/signals.py:22
+msgid "You will be invited to the event's Matrix Space."
+msgstr ""
+
+#: pretix_matrix_inviter/signals.py:42
+msgid "Matrix ID"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:40
-msgid "You will be invited to a Matrix room using this Matrix ID"
+#: pretix_matrix_inviter/signals.py:47
+msgid "Enter a Matrix ID of the form @username:homeserver.tld"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:73
+#: pretix_matrix_inviter/signals.py:82
 #: pretix_matrix_inviter/templates/pretix_matrix_inviter/settings.html:6
 msgid "Matrix inviter"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:94
+#: pretix_matrix_inviter/signals.py:103
 #, python-brace-format
 msgid "{matrix_id} has been invited to {matrix_room}."
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:97
+#: pretix_matrix_inviter/signals.py:106
 #, python-brace-format
 msgid "There was an error inviting {matrix_id} to {matrix_room}: {error}"
 msgstr ""

pretix_matrix_inviter/locale/de_Informal/LC_MESSAGES/django.po

@@ -2,7 +2,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-02-04 17:28+0100\n"
+"POT-Creation-Date: 2022-02-04 19:41+0100\n"
 "PO-Revision-Date: \n"
 "Last-Translator: Felix Schäfer\n"
 "Language-Team: \n"
@@ -21,45 +21,49 @@ msgid ""
 "Space."
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:11
+#: pretix_matrix_inviter/forms.py:12
 msgid "Ask Matrix ID for"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:16
+#: pretix_matrix_inviter/forms.py:17
 msgid "Authorization token"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:20
+#: pretix_matrix_inviter/forms.py:21
 msgid "Matrix server"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:24
+#: pretix_matrix_inviter/forms.py:25
 msgid "Matrix room"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:33
-msgid "Matrix ID"
+#: pretix_matrix_inviter/forms.py:31
+msgid "Help text for the Matrix ID field"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:38
-msgid "Enter a Matrix ID of the form @username:homeserver.tld"
+#: pretix_matrix_inviter/signals.py:22
+msgid "You will be invited to the event's Matrix Space."
+msgstr ""
+
+#: pretix_matrix_inviter/signals.py:42
+msgid "Matrix ID"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:40
-msgid "You will be invited to a Matrix room using this Matrix ID"
+#: pretix_matrix_inviter/signals.py:47
+msgid "Enter a Matrix ID of the form @username:homeserver.tld"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:73
+#: pretix_matrix_inviter/signals.py:82
 #: pretix_matrix_inviter/templates/pretix_matrix_inviter/settings.html:6
 msgid "Matrix inviter"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:94
+#: pretix_matrix_inviter/signals.py:103
 #, python-brace-format
 msgid "{matrix_id} has been invited to {matrix_room}."
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:97
+#: pretix_matrix_inviter/signals.py:106
 #, python-brace-format
 msgid "There was an error inviting {matrix_id} to {matrix_room}: {error}"
 msgstr ""

pretix_matrix_inviter/locale/django.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-02-04 17:28+0100\n"
+"POT-Creation-Date: 2022-02-04 19:41+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -27,45 +27,49 @@ msgid ""
 "Space."
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:11
+#: pretix_matrix_inviter/forms.py:12
 msgid "Ask Matrix ID for"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:16
+#: pretix_matrix_inviter/forms.py:17
 msgid "Authorization token"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:20
+#: pretix_matrix_inviter/forms.py:21
 msgid "Matrix server"
 msgstr ""
 
-#: pretix_matrix_inviter/forms.py:24
+#: pretix_matrix_inviter/forms.py:25
 msgid "Matrix room"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:33
-msgid "Matrix ID"
+#: pretix_matrix_inviter/forms.py:31
+msgid "Help text for the Matrix ID field"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:38
-msgid "Enter a Matrix ID of the form @username:homeserver.tld"
+#: pretix_matrix_inviter/signals.py:22
+msgid "You will be invited to the event's Matrix Space."
+msgstr ""
+
+#: pretix_matrix_inviter/signals.py:42
+msgid "Matrix ID"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:40
-msgid "You will be invited to a Matrix room using this Matrix ID"
+#: pretix_matrix_inviter/signals.py:47
+msgid "Enter a Matrix ID of the form @username:homeserver.tld"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:73
+#: pretix_matrix_inviter/signals.py:82
 #: pretix_matrix_inviter/templates/pretix_matrix_inviter/settings.html:6
 msgid "Matrix inviter"
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:94
+#: pretix_matrix_inviter/signals.py:103
 #, python-brace-format
 msgid "{matrix_id} has been invited to {matrix_room}."
 msgstr ""
 
-#: pretix_matrix_inviter/signals.py:97
+#: pretix_matrix_inviter/signals.py:106
 #, python-brace-format
 msgid "There was an error inviting {matrix_id} to {matrix_room}: {error}"
 msgstr ""

pretix_matrix_inviter/signals.py

@@ -2,9 +2,11 @@ import json
 from django import forms
 from django.dispatch import receiver
 from django.urls import resolve, reverse
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_noop, ugettext_lazy as _
+from i18nfield.strings import LazyI18nString
 from pretix.base.settings import settings_hierarkey
 from pretix.base.signals import logentry_display, order_placed
+from pretix.base.templatetags.rich_text import rich_text_snippet
 from pretix.control.signals import nav_event_settings
 from pretix.presale.signals import question_form_fields
 
@@ -14,6 +16,13 @@ settings_hierarkey.add_default("matrix_inviter_items", [], list)
 settings_hierarkey.add_default("matrix_inviter_authorization_token", "", str)
 settings_hierarkey.add_default("matrix_inviter_matrix_server", "", str)
 settings_hierarkey.add_default("matrix_inviter_matrix_room", "", str)
+settings_hierarkey.add_default(
+    "matrix_inviter_hint",
+    LazyI18nString.from_gettext(
+        gettext_noop("You will be invited to the event's Matrix Space.")
+    ),
+    LazyI18nString,
+)
 
 
 @receiver(question_form_fields, dispatch_uid="matrix_inviter_questions")
@@ -37,7 +46,7 @@ def add_matrix_id_question(sender, position, **kwargs):
             error_messages={
                 "invalid": _("Enter a Matrix ID of the form @username:homeserver.tld")
             },
-            help_text=_("You will be invited to a Matrix room using this Matrix ID"),
+            help_text=rich_text_snippet(sender.settings.matrix_inviter_hint),
         )
     }