base

2026-04-18 18:39:25 +03:00
commit 3ba092b60c
4944 changed files with 497564 additions and 0 deletions
@@ -0,0 +1,149 @@
+# Copyright (c) 2023-present Plane Software, Inc. and contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+# See the LICENSE file for details.
+
+# Django imports
+from django.conf import settings
+from django.db import models
+
+# Module imports
+from .base import BaseModel
+
+
+class Notification(BaseModel):
+    workspace = models.ForeignKey("db.Workspace", related_name="notifications", on_delete=models.CASCADE)
+    project = models.ForeignKey("db.Project", related_name="notifications", on_delete=models.CASCADE, null=True)
+    data = models.JSONField(null=True)
+    entity_identifier = models.UUIDField(null=True)
+    entity_name = models.CharField(max_length=255)
+    title = models.TextField()
+    message = models.JSONField(null=True)
+    message_html = models.TextField(blank=True, default="<p></p>")
+    message_stripped = models.TextField(blank=True, null=True)
+    sender = models.CharField(max_length=255)
+    triggered_by = models.ForeignKey(
+        "db.User",
+        related_name="triggered_notifications",
+        on_delete=models.SET_NULL,
+        null=True,
+    )
+    receiver = models.ForeignKey("db.User", related_name="received_notifications", on_delete=models.CASCADE)
+    read_at = models.DateTimeField(null=True)
+    snoozed_till = models.DateTimeField(null=True)
+    archived_at = models.DateTimeField(null=True)
+
+    class Meta:
+        verbose_name = "Notification"
+        verbose_name_plural = "Notifications"
+        db_table = "notifications"
+        ordering = ("-created_at",)
+        indexes = [
+            models.Index(fields=["entity_identifier"], name="notif_entity_identifier_idx"),
+            models.Index(fields=["entity_name"], name="notif_entity_name_idx"),
+            models.Index(fields=["read_at"], name="notif_read_at_idx"),
+            models.Index(fields=["receiver", "read_at"], name="notif_entity_idx"),
+            models.Index(
+                fields=["receiver", "workspace", "read_at", "created_at"],
+                name="notif_receiver_status_idx",
+            ),
+            models.Index(
+                fields=["receiver", "workspace", "entity_name", "read_at"],
+                name="notif_receiver_entity_idx",
+            ),
+            models.Index(
+                fields=["receiver", "workspace", "snoozed_till", "archived_at"],
+                name="notif_receiver_state_idx",
+            ),
+            models.Index(
+                fields=["receiver", "workspace", "sender"],
+                name="notif_receiver_sender_idx",
+            ),
+            models.Index(
+                fields=["workspace", "entity_identifier", "entity_name"],
+                name="notif_entity_lookup_idx",
+            ),
+        ]
+
+    def __str__(self):
+        """Return name of the notifications"""
+        return f"{self.receiver.email} <{self.workspace.name}>"
+
+
+def get_default_preference():
+    return {
+        "property_change": {"email": True},
+        "state": {"email": True},
+        "comment": {"email": True},
+        "mentions": {"email": True},
+    }
+
+
+class UserNotificationPreference(BaseModel):
+    # user it is related to
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="notification_preferences",
+    )
+    # workspace if it is applicable
+    workspace = models.ForeignKey(
+        "db.Workspace",
+        on_delete=models.CASCADE,
+        related_name="workspace_notification_preferences",
+        null=True,
+    )
+    # project
+    project = models.ForeignKey(
+        "db.Project",
+        on_delete=models.CASCADE,
+        related_name="project_notification_preferences",
+        null=True,
+    )
+
+    # preference fields
+    property_change = models.BooleanField(default=True)
+    state_change = models.BooleanField(default=True)
+    comment = models.BooleanField(default=True)
+    mention = models.BooleanField(default=True)
+    issue_completed = models.BooleanField(default=True)
+
+    class Meta:
+        verbose_name = "UserNotificationPreference"
+        verbose_name_plural = "UserNotificationPreferences"
+        db_table = "user_notification_preferences"
+        ordering = ("-created_at",)
+
+    def __str__(self):
+        """Return the user"""
+        return f"<{self.user}>"
+
+
+class EmailNotificationLog(BaseModel):
+    # receiver
+    receiver = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="email_notifications",
+    )
+    triggered_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="triggered_emails",
+    )
+    # entity - can be issues, pages, etc.
+    entity_identifier = models.UUIDField(null=True)
+    entity_name = models.CharField(max_length=255)
+    # data
+    data = models.JSONField(null=True)
+    # sent at
+    processed_at = models.DateTimeField(null=True)
+    sent_at = models.DateTimeField(null=True)
+    entity = models.CharField(max_length=200)
+    old_value = models.CharField(max_length=300, blank=True, null=True)
+    new_value = models.CharField(max_length=300, blank=True, null=True)
+
+    class Meta:
+        verbose_name = "Email Notification Log"
+        verbose_name_plural = "Email Notification Logs"
+        db_table = "email_notification_logs"
+        ordering = ("-created_at",)