feat(accounts): add default notification configuration to settings

Author: michael-smt

docs/admin/config.rst

@@ -723,6 +723,106 @@ DEFAULT_MERGE_STYLE
    * :ref:`component`
    * :ref:`component-merge_style`
 
+.. setting:: DEFAULT_NOTIFICATIONS
+
+DEFAULT_NOTIFICATIONS
+---------------------
+
+Default notification settings for every created user.
+
+A list of 3-tuples consisting of notification scope, notification frequency and notification handler.
+
+Scopes:
+
+``0``
+   :guilabel:`All`
+``10``
+   :guilabel:`Watched`
+``20``
+   :guilabel:`Administered`
+``30``
+   :guilabel:`Project`
+``40``
+   :guilabel:`Component`
+
+Frequencies:
+
+``0``
+   :guilabel:`No notification`
+``1``
+   :guilabel:`Instant notification`
+``2``
+   :guilabel:`Daily digest`
+``3``
+   :guilabel:`Weekly digest`
+``4``
+   :guilabel:`Monthly digest`
+
+Handlers:
+
+``RepositoryNotification``
+   :guilabel:`Operation was performed in the repository`
+``LockNotification``
+   :guilabel:`Component was locked or unlocked`
+``LicenseNotification``
+   :guilabel:`License was changed`
+``ParseErrorNotification``
+   :guilabel:`Parse error occurred`
+``NewStringNotificaton``
+   :guilabel:`String is available for translation`
+``NewContributorNotificaton``
+   :guilabel:`Contributor made their first translation`
+``NewSuggestionNotificaton``
+   :guilabel:`Suggestion was added`
+``LanguageTranslatedNotificaton``
+   :guilabel:`Language was translated`
+``ComponentTranslatedNotificaton``
+   :guilabel:`Component was translated`
+``NewCommentNotificaton``
+   :guilabel:`Comment was added`
+``MentionCommentNotificaton``
+   :guilabel:`You were mentioned in a comment`
+``LastAuthorCommentNotificaton``
+   :guilabel:`Your translation received a comment`
+``TranslatedStringNotificaton``
+   :guilabel:`String was edited by user`
+``ApprovedStringNotificaton``
+   :guilabel:`String was approved`
+``ChangedStringNotificaton``
+   :guilabel:`String was changed`
+``NewTranslationNotificaton``
+   :guilabel:`New language was added or requested`
+``NewComponentNotificaton``
+   :guilabel:`New translation component was created`
+``NewAnnouncementNotificaton``
+   :guilabel:`Announcement was published`
+``NewAlertNotificaton``
+   :guilabel:`New alert emerged in a component`
+``MergeFailureNotification``
+   :guilabel:`Repository operation failed`
+``PendingSuggestionsNotification``
+   :guilabel:`Pending suggestions exist`
+``ToDoStringsNotification``
+   :guilabel:`Unfinished strings exist`
+
+.. note::
+
+   This setting affects only newly created users.
+
+Example:
+
+.. code-block:: python
+
+   DEFAULT_NOTIFICATIONS = [
+       (0, 1, "MentionCommentNotificaton"),
+       (10, 1, "LastAuthorCommentNotificaton"),
+   ]
+
+.. seealso::
+
+   * :ref:`notifications`
+
+
 .. setting:: DEFAULT_SHARED_TM
 
 DEFAULT_SHARED_TM

docs/admin/install/docker.rst

@@ -1032,6 +1032,17 @@ Generic settings
 
    Configures :setting:`DEFAULT_AUTO_WATCH`.
 
+.. envvar:: WEBLATE_DEFAULT_NOTIFICATIONS
+
+   Configures :setting:`DEFAULT_NOTIFICATIONS`.
+
+    **Example:**
+
+    .. code-block:: yaml
+
+        environment:
+          WEBLATE_DEFAULT_NOTIFICATIONS: 0:1:MentionCommentNotificaton,10:1:LastAuthorCommentNotificaton
+
 .. envvar:: WEBLATE_RATELIMIT_ATTEMPTS
 .. envvar:: WEBLATE_RATELIMIT_LOCKOUT
 .. envvar:: WEBLATE_RATELIMIT_WINDOW

weblate/accounts/data.py

@@ -36,7 +36,6 @@
 from unidecode import unidecode
 
 from weblate.accounts.avatar import get_user_display
-from weblate.accounts.data import create_default_notifications
 from weblate.accounts.notifications import (
     NOTIFICATIONS,
     NotificationFrequency,
@@ -157,6 +156,61 @@ class WeblateAccountsConf(AppConf):
         r"{URL_PREFIX}/site.webmanifest$",  # The request for the manifest is made without credentials
     )
 
+    DEFAULT_NOTIFICATIONS: ClassVar[
+        list[tuple[NotificationScope, NotificationFrequency, str]]
+    ] = [
+        (
+            NotificationScope.SCOPE_ALL,
+            NotificationFrequency.FREQ_INSTANT,
+            "MentionCommentNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_WATCHED,
+            NotificationFrequency.FREQ_INSTANT,
+            "LastAuthorCommentNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_WATCHED,
+            NotificationFrequency.FREQ_INSTANT,
+            "MentionCommentNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_WATCHED,
+            NotificationFrequency.FREQ_INSTANT,
+            "NewAnnouncementNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_WATCHED,
+            NotificationFrequency.FREQ_WEEKLY,
+            "NewStringNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_ADMIN,
+            NotificationFrequency.FREQ_INSTANT,
+            "MergeFailureNotification",
+        ),
+        (
+            NotificationScope.SCOPE_ADMIN,
+            NotificationFrequency.FREQ_INSTANT,
+            "ParseErrorNotification",
+        ),
+        (
+            NotificationScope.SCOPE_ADMIN,
+            NotificationFrequency.FREQ_INSTANT,
+            "NewTranslationNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_ADMIN,
+            NotificationFrequency.FREQ_INSTANT,
+            "NewAlertNotificaton",
+        ),
+        (
+            NotificationScope.SCOPE_ADMIN,
+            NotificationFrequency.FREQ_INSTANT,
+            "NewAnnouncementNotificaton",
+        ),
+    ]
+
     # Multi-level rate limiting for email notifications
     # Each tuple contains (max_emails, time_window_seconds)
     RATELIMIT_NOTIFICATION_LIMITS: ClassVar[list[tuple[int, int]]] = [
@@ -1329,3 +1383,13 @@ def create_profile_callback(sender, instance, created=False, **kwargs) -> None:
         # Create subscriptions
         if not instance.is_anonymous and not instance.is_bot:
             create_default_notifications(instance)
+
+
+def create_default_notifications(user: User) -> None:
+    if settings.DEFAULT_NOTIFICATIONS:
+        for scope, frequency, notification in settings.DEFAULT_NOTIFICATIONS:
+            user.subscription_set.get_or_create(
+                scope=scope,
+                notification=notification,
+                defaults={"frequency": frequency},
+            )

weblate/accounts/models.py

@@ -30,6 +30,7 @@
     get_env_ratelimit,
     get_env_redis_url,
     get_env_str,
+    get_env_tuples_or_none,
     get_saml_idp,
     modify_env_list,
 )
@@ -1464,6 +1465,11 @@
 
 DEFAULT_AUTO_WATCH = get_env_bool("WEBLATE_DEFAULT_AUTO_WATCH", True)
 
+default_notifications = get_env_tuples_or_none("WEBLATE_DEFAULT_NOTIFICATIONS")
+if default_notifications is not None:
+    DEFAULT_NOTIFICATIONS = default_notifications
+del default_notifications
+
 DEFAULT_SHARED_TM = get_env_bool("WEBLATE_DEFAULT_SHARED_TM", True)
 
 DEFAULT_AUTOCLEAN_TM = get_env_bool("WEBLATE_AUTOCLEAN_TM", False)

weblate/settings_docker.py

@@ -119,6 +119,20 @@ def get_env_map(name: str, default: dict[str, str] | None = None) -> dict[str, s
     return default or {}
 
 
+def get_env_tuples_or_none(name: str) -> list[tuple] | None:
+    """
+    Get list of tuples from environment.
+
+    parses 'a:b:c,x:y:z' into [('a','b','c'), ('x','y','z')]
+    """
+    parsed_list = get_env_list_or_none(name)
+    if parsed_list is not None:
+        if parsed_list == [""]:
+            return []
+        return [tuple(e.split(":")) for e in parsed_list]
+    return None
+
+
 def get_env_int_or_none(name: str) -> int | None:
     """Get integer value from environment."""
     string_value = get_env_str(name)

weblate/utils/environment.py

@@ -22,6 +22,7 @@
     get_env_ratelimit,
     get_env_redis_url,
     get_env_str,
+    get_env_tuples_or_none,
     get_saml_idp,
     modify_env_list,
 )
@@ -181,6 +182,19 @@ def test_map_or_none(self) -> None:
         del os.environ["TEST_DATA"]
         self.assertIsNone(get_env_map_or_none("TEST_DATA"))
 
+    def test_tuples_or_none(self) -> None:
+        os.environ["TEST_DATA"] = "foo:bar:baz,bag:bak:bam"
+        self.assertEqual(
+            get_env_tuples_or_none("TEST_DATA"),
+            [("foo", "bar", "baz"), ("bag", "bak", "bam")],
+        )
+        os.environ["TEST_DATA"] = "foo:bar"
+        self.assertEqual(get_env_tuples_or_none("TEST_DATA"), [("foo", "bar")])
+        os.environ["TEST_DATA"] = ""
+        self.assertEqual(get_env_tuples_or_none("TEST_DATA"), [])
+        del os.environ["TEST_DATA"]
+        self.assertIsNone(get_env_tuples_or_none("TEST_DATA"))
+
     def test_bool(self) -> None:
         os.environ["TEST_DATA"] = "1"
         self.assertTrue(get_env_bool("TEST_DATA"))