[feat] Notification Preferences Page

docs/user/notification-preferences.rst

@@ -1,8 +1,8 @@
 Notification Preferences
 ========================
 
-.. image:: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-settings.png
-    :target: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-settings.png
+.. image:: https://i.imgur.com/lIGqry5.png
+    :target: https://i.imgur.com/lIGqry5.png
     :align: center
 
 OpenWISP Notifications enables users to customize their notification
@@ -12,6 +12,10 @@ organized by notification type and organization, allowing users to tailor
 their notification experience by opting to receive updates only from
 specific organizations or notification types.
 
+Users can access and manage their notification preferences by visiting the
+``/notification/preferences/``. Alternatively, this page can also be
+accessed directly from the notification widget.
+
 Notification settings are automatically generated for all notification
 types and organizations for every user. Superusers have the ability to
 manage notification settings for all users, including adding or deleting

openwisp_notifications/admin.py

@@ -1,25 +1,3 @@
-from django.contrib import admin
-
-from openwisp_notifications.base.admin import NotificationSettingAdminMixin
-from openwisp_notifications.swapper import load_model
 from openwisp_notifications.widgets import _add_object_notification_widget
-from openwisp_users.admin import UserAdmin
-from openwisp_utils.admin import AlwaysHasChangedMixin
-
-Notification = load_model('Notification')
-NotificationSetting = load_model('NotificationSetting')
-
-
-class NotificationSettingInline(
-    NotificationSettingAdminMixin, AlwaysHasChangedMixin, admin.TabularInline
-):
-    model = NotificationSetting
-    extra = 0
-
-    def has_change_permission(self, request, obj=None):
-        return request.user.is_superuser or request.user == obj
-
-
-UserAdmin.inlines = [NotificationSettingInline] + UserAdmin.inlines
 
 _add_object_notification_widget()

openwisp_notifications/api/permissions.py

@@ -0,0 +1,16 @@
+from rest_framework.permissions import BasePermission
+
+
+class PreferencesPermission(BasePermission):
+    """
+    Permission class for the notification preferences.
+
+    Permission is granted only in these two cases:
+    1. Superusers can change the notification preferences of any user.
+    2. Regular users can only change their own preferences.
+    """
+
+    def has_permission(self, request, view):
+        return request.user.is_superuser or request.user.id == view.kwargs.get(
+            'user_id'
+        )

openwisp_notifications/api/serializers.py

@@ -73,6 +73,11 @@ class Meta(NotificationSerializer.Meta):
 
 
 class NotificationSettingSerializer(serializers.ModelSerializer):
+    organization_name = serializers.CharField(
+        source='organization.name', read_only=True
+    )
+    type_label = serializers.CharField(source='get_type_display', read_only=True)
+
     class Meta:
         model = NotificationSetting
         exclude = ['user']
@@ -87,3 +92,14 @@ class Meta:
             'object_content_type',
             'object_id',
         ]
+
+
+class NotificationSettingUpdateSerializer(serializers.Serializer):
+    email = serializers.BooleanField(required=False)
+    web = serializers.BooleanField(required=False)
+
+    def validate(self, attrs):
+        attrs = super().validate(attrs)
+        if 'email' not in attrs and attrs.get('web') is False:
+            attrs['email'] = False
+        return attrs

openwisp_notifications/api/urls.py

@@ -9,32 +9,56 @@ def get_api_urls(api_views=None):
     if not api_views:
         api_views = views
     return [
-        path('', views.notifications_list, name='notifications_list'),
-        path('read/', views.notifications_read_all, name='notifications_read_all'),
-        path('<uuid:pk>/', views.notification_detail, name='notification_detail'),
+        path('notification/', views.notifications_list, name='notifications_list'),
         path(
-            '<uuid:pk>/redirect/',
+            'notification/read/',
+            views.notifications_read_all,
+            name='notifications_read_all',
+        ),
+        path(
+            'notification/<uuid:pk>/',
+            views.notification_detail,
+            name='notification_detail',
+        ),
+        path(
+            'notification/<uuid:pk>/redirect/',
             views.notification_read_redirect,
             name='notification_read_redirect',
         ),
         path(
-            'user-setting/',
+            'user/<uuid:user_id>/user-setting/',
             views.notification_setting_list,
-            name='notification_setting_list',
+            name='user_notification_setting_list',
         ),
         path(
-            'user-setting/<uuid:pk>/',
+            'user/<uuid:user_id>/user-setting/<uuid:pk>/',
             views.notification_setting,
-            name='notification_setting',
+            name='user_notification_setting',
         ),
         path(
-            'ignore/',
+            'notification/ignore/',
             views.ignore_object_notification_list,
             name='ignore_object_notification_list',
         ),
         path(
-            'ignore/<str:app_label>/<str:model_name>/<uuid:object_id>/',
+            'notification/ignore/<str:app_label>/<str:model_name>/<uuid:object_id>/',
             views.ignore_object_notification,
             name='ignore_object_notification',
         ),
+        path(
+            'user/<uuid:user_id>/organization/<uuid:organization_id>/setting/',
+            views.organization_notification_setting,
+            name='organization_notification_setting',
+        ),
+        # DEPRECATED
+        path(
+            'user/user-setting/',
+            views.notification_setting_list,
+            name='notification_setting_list',
+        ),
+        path(
+            'user/user-setting/<uuid:pk>/',
+            views.notification_setting,
+            name='notification_setting',
+        ),
     ]

openwisp_notifications/api/views.py

@@ -15,11 +15,13 @@
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 
+from openwisp_notifications.api.permissions import PreferencesPermission
 from openwisp_notifications.api.serializers import (
     IgnoreObjectNotificationSerializer,
     NotificationListSerializer,
     NotificationSerializer,
     NotificationSettingSerializer,
+    NotificationSettingUpdateSerializer,
 )
 from openwisp_notifications.swapper import load_model
 from openwisp_users.api.authentication import BearerAuthentication
@@ -114,12 +116,13 @@ class BaseNotificationSettingView(GenericAPIView):
     model = NotificationSetting
     serializer_class = NotificationSettingSerializer
     authentication_classes = [BearerAuthentication, SessionAuthentication]
-    permission_classes = [IsAuthenticated]
+    permission_classes = [IsAuthenticated, PreferencesPermission]
 
     def get_queryset(self):
         if getattr(self, 'swagger_fake_view', False):
             return NotificationSetting.objects.none()  # pragma: no cover
-        return NotificationSetting.objects.filter(user=self.request.user)
+        user_id = self.kwargs.get('user_id', self.request.user.id)
+        return NotificationSetting.objects.filter(user_id=user_id)
 
 
 class NotificationSettingListView(BaseNotificationSettingView, ListModelMixin):
@@ -198,11 +201,27 @@ def perform_create(self, serializer):
         )
 
 
+class OrganizationNotificationSettingView(GenericAPIView):
+    permission_classes = [IsAuthenticated, PreferencesPermission]
+    serializer_class = NotificationSettingUpdateSerializer
+
+    def post(self, request, user_id, organization_id):
+        serializer = self.get_serializer(data=request.data)
+        if serializer.is_valid():
+            validated_data = serializer.validated_data
+            NotificationSetting.objects.filter(
+                organization_id=organization_id, user_id=user_id
+            ).update(**validated_data)
+            return Response(status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+
 notifications_list = NotificationListView.as_view()
 notification_detail = NotificationDetailView.as_view()
 notifications_read_all = NotificationReadAllView.as_view()
 notification_read_redirect = NotificationReadRedirect.as_view()
 notification_setting_list = NotificationSettingListView.as_view()
 notification_setting = NotificationSettingView.as_view()
+organization_notification_setting = OrganizationNotificationSettingView.as_view()
 ignore_object_notification_list = IgnoreObjectNotificationListView.as_view()
 ignore_object_notification = IgnoreObjectNotificationView.as_view()

openwisp_notifications/base/admin.py

@@ -26,12 +26,12 @@ def get_queryset(self, request):
             super()
             .get_queryset(request)
             .filter(deleted=False)
+            .exclude(organization=None)
             .prefetch_related('organization')
         )
 
     class Media:
         extends = True
         js = [
             'admin/js/jquery.init.js',
-            'openwisp-notifications/js/notification-settings.js',
         ]

openwisp_notifications/base/models.py

@@ -6,7 +6,8 @@
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
 from django.core.cache import cache
-from django.db import models
+from django.core.exceptions import ValidationError
+from django.db import models, transaction
 from django.db.models.constraints import UniqueConstraint
 from django.template.loader import render_to_string
 from django.urls import reverse
@@ -246,12 +247,15 @@ class AbstractNotificationSetting(UUIDModel):
     type = models.CharField(
         max_length=30,
         null=True,
+        blank=True,
         choices=NOTIFICATION_CHOICES,
         verbose_name='Notification Type',
     )
     organization = models.ForeignKey(
         get_model_name('openwisp_users', 'Organization'),
         on_delete=models.CASCADE,
+        null=True,
+        blank=True,
     )
     web = models.BooleanField(
         _('web notifications'), null=True, blank=True, help_text=_(_RECEIVE_HELP)
@@ -277,21 +281,64 @@ class Meta:
         ]
 
     def __str__(self):
-        return '{type} - {organization}'.format(
-            type=self.type_config['verbose_name'],
-            organization=self.organization,
-        )
+        type_name = self.type_config.get('verbose_name', 'Global Setting')
+        if self.organization:
+            return '{type} - {organization}'.format(
+                type=type_name,
+                organization=self.organization,
+            )
+        else:
+            return type_name
+
+    def validate_global_setting(self):
+        if self.organization is None and self.type is None:
+            if (
+                self.__class__.objects.filter(
+                    user=self.user,
+                    organization=None,
+                    type=None,
+                )
+                .exclude(pk=self.pk)
+                .exists()
+            ):
+                raise ValidationError("There can only be one global setting per user.")
 
     def save(self, *args, **kwargs):
         if not self.web_notification:
             self.email = self.web_notification
+        with transaction.atomic():
+            if not self.organization and not self.type:
+                try:
+                    previous_state = self.__class__.objects.only('email').get(
+                        pk=self.pk
+                    )
+                    updates = {'web': self.web}
+
+                    # If global web notifiations are disabled, then disable email notifications as well
+                    if not self.web:
+                        updates['email'] = False
+
+                    # Update email notifiations only if it's different from the previous state
+                    # Otherwise, it would overwrite the email notification settings for specific
+                    # setting that were enabled by the user after disabling global email notifications
+                    if self.email != previous_state.email:
+                        updates['email'] = self.email
+
+                    self.user.notificationsetting_set.exclude(pk=self.pk).update(
+                        **updates
+                    )
+                except self.__class__.DoesNotExist:
+                    # Handle case when the object is being created
+                    pass
         return super().save(*args, **kwargs)
 
     def full_clean(self, *args, **kwargs):
-        if self.email == self.type_config['email_notification']:
-            self.email = None
-        if self.web == self.type_config['web_notification']:
-            self.web = None
+        self.validate_global_setting()
+        if self.organization and self.type:
+            if self.email == self.type_config['email_notification']:
+                self.email = None
+            if self.web == self.type_config['web_notification']:
+                self.web = None
         return super().full_clean(*args, **kwargs)
 
     @property

openwisp_notifications/handlers.py

@@ -170,6 +170,7 @@ def send_email_notification(sender, instance, created, **kwargs):
         return
     # Get email preference of user for this type of notification.
     target_org = getattr(getattr(instance, 'target', None), 'organization_id', None)
+
     if instance.type and target_org:
         try:
             notification_setting = instance.recipient.notificationsetting_set.get(

openwisp_notifications/migrations/0008_alter_notificationsetting_organization_and_more.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.16 on 2024-09-17 13:19
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("openwisp_users", "0020_populate_password_updated_field"),
+        ("openwisp_notifications", "0007_notificationsetting_deleted"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="notificationsetting",
+            name="organization",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                to="openwisp_users.organization",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="notificationsetting",
+            name="type",
+            field=models.CharField(
+                blank=True,
+                choices=[
+                    ("default", "Default Type"),
+                    ("generic_message", "Generic Message Type"),
+                ],
+                max_length=30,
+                null=True,
+                verbose_name="Notification Type",
+            ),
+        ),
+    ]