Merge pull request #373 from hotosm/feature/notification

Feature : Notification System

Author: kshitijrajsharma

backend/aiproject/celery.py

@@ -18,6 +18,7 @@
 # read config from Django settings, the CELERY namespace would make celery
 # config keys has `CELERY` prefix
 app.config_from_object("django.conf:settings", namespace="CELERY")
+app.conf.task_track_started = True
 
 # discover and load tasks.py from from all registered Django apps
 app.autodiscover_tasks(lambda: settings.INSTALLED_APPS)

backend/aiproject/settings.py

@@ -33,6 +33,10 @@
 LOG_PATH = env("LOG_PATH", default=os.path.join(os.getcwd(), "log"))
 
 HOSTNAME = env("HOSTNAME", default="127.0.0.1")
+
+FRONTEND_URL = env("FRONTEND_URL", default="https://fair.hotosm.org")
+
+
 EXPORT_TOOL_API_URL = env(
     "EXPORT_TOOL_API_URL",
     default="https://api-prod.raw-data.hotosm.org/v1",
@@ -270,3 +274,13 @@
 
 
 TEST_RUNNER = "tests.test_runners.NoDestroyTestRunner"
+
+
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
+EMAIL_HOST = os.getenv("EMAIL_HOST", "smtp.gmail.com")
+EMAIL_PORT = int(os.getenv("EMAIL_PORT", 587))
+EMAIL_USE_TLS = os.getenv("EMAIL_USE_TLS", "True") == "True"
+EMAIL_USE_SSL = os.getenv("EMAIL_USE_SSL", "False") == "True"
+EMAIL_HOST_USER = os.getenv("EMAIL_HOST_USER", "example-email@example.com")
+EMAIL_HOST_PASSWORD = os.getenv("EMAIL_HOST_PASSWORD", "example-email-password")
+DEFAULT_FROM_EMAIL = os.getenv("DEFAULT_FROM_EMAIL", "no-reply@example.com")

backend/core/models.py

@@ -173,3 +173,26 @@ def is_displayable(self):
 
     def __str__(self):
         return self.message
+
+
+class UserNotification(models.Model):
+
+    user = models.ForeignKey(
+        OsmUser,
+        to_field="osm_id",
+        on_delete=models.CASCADE,
+        related_name="notifications",
+    )
+    is_read = models.BooleanField(default=False)
+    created_at = models.DateTimeField(default=timezone.now)
+    read_at = models.DateTimeField(null=True, blank=True)
+    message = models.TextField(max_length=500)
+
+    def mark_as_read(self):
+        if not self.is_read:
+            self.is_read = True
+            self.read_at = timezone.now()
+            self.save()
+
+    def __str__(self):
+        return f"Notification for {self.user.username}: {self.message[:50]}..."

backend/core/serializers.py

@@ -91,13 +91,6 @@ def __init__(self, *args, **kwargs):
         ):
             self.fields["dataset"] = DatasetSerializer(read_only=True)
 
-    # def get_training(self, obj):
-    #     if not hasattr(self, "_cached_training"):
-    #         self._cached_training = Training.objects.filter(
-    #             id=obj.published_training
-    #         ).first()
-    #     return self._cached_training
-
     def get_thumbnail_url(self, obj):
         training = Training.objects.filter(id=obj.published_training).first()
 
@@ -144,14 +137,6 @@ def get_geometry(self, obj):
             }
         return None
 
-    # def to_representation(self, instance):
-    #     """
-    #     Override to_representation to customize GeoJSON structure.
-    #     """
-    #     representation = super().to_representation(instance)
-    #     representation["properties"]["id"] = representation.pop("id")
-    #     return representation
-
 
 class AOISerializer(
     GeoFeatureModelSerializer
@@ -451,6 +436,7 @@ class UserStatsSerializer(serializers.ModelSerializer):
     feedbacks_count = serializers.SerializerMethodField()
     approved_predictions_count = serializers.SerializerMethodField()
     profile_completion_percentage = serializers.SerializerMethodField()
+    unread_notifications_count = serializers.SerializerMethodField()
 
     class Meta:
         model = OsmUser
@@ -460,13 +446,28 @@ class Meta:
             "email",
             "date_joined",
             "img_url",
+            "notifications_delivery_methods",
+            "newsletter_subscription",
+            "account_deletion_requested",
+            "models_count",
+            "datasets_count",
+            "feedbacks_count",
+            "approved_predictions_count",
+            "profile_completion_percentage",
+            "unread_notifications_count",
+        ]
+        read_only_fields = [
+            "osm_id",
+            "username",
+            "date_joined",
+            "img_url",
             "models_count",
             "datasets_count",
             "feedbacks_count",
             "approved_predictions_count",
             "profile_completion_percentage",
+            "unread_notifications_count",
         ]
-        read_only_fields = ["osm_id", "username", "date_joined", "img_url"]
 
     def get_models_count(self, obj):
         return Model.objects.filter(user=obj).count()
@@ -489,3 +490,18 @@ def get_profile_completion_percentage(self, obj):
         if obj.email is not None and obj.email != "":
             profile_percentage += 25
         return profile_percentage
+
+    def get_unread_notifications_count(self, obj):
+        return UserNotification.objects.filter(user=obj, is_read=False).count()
+
+
+class UserNotificationSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = UserNotification
+        fields = ("id", "is_read", "created_at", "read_at", "message")
+        read_only_fields = (
+            "id",
+            "created_at",
+            "read_at",
+            "message",
+        )

backend/core/tasks.py

@@ -17,6 +17,7 @@
     Label,
     Model,
     Training,
+    UserNotification,
 )
 from core.serializers import (
     AOISerializer,
@@ -29,6 +30,7 @@
 from django.conf import settings
 from django.contrib.gis.db.models.aggregates import Extent
 from django.contrib.gis.geos import GEOSGeometry
+from django.core.mail import send_mail
 from django.shortcuts import get_object_or_404
 from django.utils import timezone
 
@@ -514,14 +516,15 @@ def train_model(
 
     training_instance = get_object_or_404(Training, id=training_id)
     model_instance = get_object_or_404(Model, id=training_instance.model.id)
+    
+    send_notification(training_instance,"Started")
 
     training_instance.status = "RUNNING"
     training_instance.started_at = timezone.now()
+    training_instance.task_id = train_model.request.id
+
     training_instance.save()
     os.makedirs(settings.LOG_PATH, exist_ok=True)
-    if training_instance.task_id is None or training_instance.task_id.strip() == "":
-        training_instance.task_id = train_model.request.id
-        training_instance.save()
     log_file = os.path.join(settings.LOG_PATH, f"run_{train_model.request.id}.log")
 
     if model_instance.base_model == "YOLO_V8_V1" and settings.YOLO_HOME is None:
@@ -567,10 +570,55 @@ def train_model(
                 )
 
             logging.info(f"Training task {training_id} completed successfully")
+            send_notification(training_instance, "Completed")
             return response
 
     except Exception as ex:
         training_instance.status = "FAILED"
         training_instance.finished_at = timezone.now()
         training_instance.save()
+        send_notification(training_instance, "Failed")
         raise ex
+
+def get_email_message(training_instance,status):
+    
+    hostname = settings.FRONTEND_URL  
+    training_model_url = f"{hostname}/ai-models/{training_instance.model.id}"
+
+    message_template = (
+        "Hi {username},\n\n"
+        "Your training task (ID: {training_id}) of model {model_name} has {status}. You can view the details here:\n"
+        "{training_model_url}\n\n"
+        "Thank you for using fAIr - AI Assisted Mapping Tool.\n\n"
+        "Best regards,\n"
+        "The fAIr Dev Team\n\n"
+        "Get Involved : https://www.hotosm.org/get-involved/\n"
+        "https://github.com/hotosm/fAIr/"
+    )
+
+    message = message_template.format(
+        username=training_instance.user.username,
+        training_id=training_instance.id,
+        model_name=training_instance.model.name,
+        status=status.lower(),
+        training_model_url=training_model_url,
+        hostname=hostname,
+
+    )
+    subject = f"fAIr : Training {training_instance.id} {status.capitalize()}"
+    return message, subject
+
+
+def send_notification(training_instance,status):
+    if any(method in training_instance.user.notifications_delivery_methods for method in ["web", "email"]):
+        UserNotification.objects.create(user=training_instance.user, message=f"Training {training_instance.id} has {status}.")
+    if "email" in training_instance.user.notifications_delivery_methods:
+        if training_instance.user.email and training_instance.user.email != '':
+            message,subject=get_email_message(training_instance,status)
+            send_mail(
+                subject=subject,
+                message=message,
+                from_email=settings.DEFAULT_FROM_EMAIL,
+                recipient_list=[training_instance.user.email],
+                fail_silently=False,
+            )

backend/core/urls.py

@@ -3,8 +3,7 @@
 from django.urls import path
 from rest_framework import routers
 
-# now import the views.py file into this code
-from .views import (  # APIStatus,
+from .views import (
     AOIViewSet,
     ApprovedPredictionsViewSet,
     BannerViewSet,
@@ -18,13 +17,17 @@
     GenerateGpxView,
     LabelUploadView,
     LabelViewSet,
+    MarkAllNotificationsAsRead,
+    MarkNotificationAsRead,
     ModelCentroidView,
     ModelViewSet,
     RawdataApiAOIView,
     RawdataApiFeedbackView,
+    TerminateTrainingView,
     TrainingViewSet,
     TrainingWorkspaceDownloadView,
     TrainingWorkspaceView,
+    UserNotificationViewSet,
     UsersView,
     download_training_data,
     geojson2osmconverter,
@@ -48,7 +51,7 @@
 router.register(r"feedback-aoi", FeedbackAOIViewset)
 router.register(r"feedback-label", FeedbackLabelViewset)
 router.register(r"banner", BannerViewSet)
-
+router.register(r'notifications/me', UserNotificationViewSet, basename='notifications')
 
 urlpatterns = [
     path("", include(router.urls)),
@@ -63,6 +66,7 @@
     # path("download/<int:dataset_id>/", download_training_data),
     path("training/status/<str:run_id>/", run_task_status),
     path("training/publish/<int:training_id>/", publish_training),
+    path("training/terminate/<int:training_id>/", TerminateTrainingView.as_view(), name="cancel_training"),
     path("feedback/training/submit/", FeedbackView.as_view()),
     # path("status/", APIStatus.as_view()),
     path("geojson2osm/", geojson2osmconverter, name="geojson2osmconverter"),
@@ -71,12 +75,14 @@
     path(
         "feedback-aoi/gpx/<int:feedback_aoi_id>/", GenerateFeedbackAOIGpxView.as_view()
     ),
-    # path("workspace/", TrainingWorkspaceView.as_view()),
     path(
         "workspace/download/<path:lookup_dir>/", TrainingWorkspaceDownloadView.as_view()
     ),
     path("workspace/<path:lookup_dir>/", TrainingWorkspaceView.as_view()),
     path("kpi/stats/", get_kpi_stats, name="get_kpi_stats"),
+    path("notifications/mark-as-read/<int:notification_id>/", MarkNotificationAsRead.as_view(), name="mark_notification_as_read"),
+    path("notifications/mark-all-as-read/", MarkAllNotificationsAsRead.as_view(), name="mark_all_notifications_as_read"),
+
 ]
 if settings.ENABLE_PREDICTION_API:
     urlpatterns.append(path("prediction/", PredictionView.as_view()))