Add Orgnization and OrganizationRole models to studio

Author: yazzylazy

contentcuration/contentcuration/models.py

@@ -1840,6 +1840,172 @@ def delete(self, *args, **kwargs):
             self.secret_token.delete()
 
 
+class Organization(models.Model):
+    """
+    Represents an organization that manages and owns channels.
+    Organizations can have roles defined for users and manage multiple channels.
+    """
+
+    id = UUIDField(primary_key=True, default=uuid.uuid4)
+    name = models.CharField(max_length=200, db_index=True)
+    description = models.TextField(blank=True)
+    tagline = models.CharField(
+        max_length=150, blank=True, null=True, help_text="Short description"
+    )
+    website = models.URLField(max_length=200, blank=True, null=True)
+    email = models.EmailField(blank=True, null=True)
+    thumbnail = models.TextField(blank=True, null=True)
+    thumbnail_encoding = JSONField(default=dict)
+    public = models.BooleanField(
+        default=False, db_index=True, help_text="Whether organization is publicly visible"
+    )
+    deleted = models.BooleanField(
+        default=False, db_index=True, help_text="Soft delete flag"
+    )
+
+    # Foreign Keys
+    channel = models.ForeignKey(
+        "Channel",
+        null=True,
+        blank=True,
+        related_name="organization_channel",
+        on_delete=models.SET_NULL,
+        help_text="Primary channel managed by this organization",
+    )
+    organization_role = models.ForeignKey(
+        "OrganizationRole",
+        null=True,
+        blank=True,
+        related_name="organizations",
+        on_delete=models.SET_NULL,
+        help_text="Tracking the creator or primary role associated with this organization",
+    )
+
+    # Metadata
+    preferences = models.TextField(
+        default=DEFAULT_USER_PREFERENCES, help_text="Organization preferences as JSON"
+    )
+    settings = JSONField(default=dict, help_text="Additional organization settings")
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    objects = CustomManager()
+
+    class Meta:
+        verbose_name = "Organization"
+        verbose_name_plural = "Organizations"
+        ordering = ["name"]
+        indexes = [
+            models.Index(fields=["name"], name="organization_name_idx"),
+            models.Index(
+                fields=["deleted", "public"], name="organization_deleted_public_idx"
+            ),
+            models.Index(fields=["created_at"], name="organization_created_at_idx"),
+        ]
+
+    def __str__(self):
+        return self.name
+
+
+class OrganizationRole(models.Model):
+    """
+    Through model for the User-Organization relationship.
+    Defines the role and membership status of a user within an organization.
+    Each user-organization pairing has its own role and metadata.
+    """
+
+    STATUS_CHOICES = [
+        ("active", "Active"),
+        ("inactive", "Inactive"),
+        ("pending", "Pending Invitation"),
+        ("suspended", "Suspended"),
+        ("declined", "Declined Invitation"),
+    ]
+
+    id = UUIDField(primary_key=True, default=uuid.uuid4)
+
+    # Foreign Keys
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="organization_roles",
+        help_text="User in the organization",
+    )
+    organization = models.ForeignKey(
+        "Organization",
+        on_delete=models.CASCADE,
+        related_name="user_roles",
+        help_text="Organization the user belongs to",
+    )
+
+    # Role and status fields
+    role = models.CharField(
+        max_length=100,
+        help_text="Role name (e.g., Admin, Editor, Viewer, Content Creator)",
+    )
+    description = models.TextField(
+        blank=True, help_text="Description of the user's role within the organization"
+    )
+    permissions = JSONField(
+        default=dict, help_text="JSON object defining user's permissions"
+    )
+    status = models.CharField(
+        max_length=20,
+        choices=STATUS_CHOICES,
+        default="pending",
+        db_index=True,
+        help_text="Membership status",
+    )
+
+    # Metadata
+    joined_at = models.DateTimeField(
+        auto_now_add=True, help_text="Date user joined the organization"
+    )
+    updated_at = models.DateTimeField(
+        auto_now=True, help_text="Last update timestamp"
+    )
+    invitation_accepted_at = models.DateTimeField(
+        null=True, blank=True, help_text="Date invitation was accepted"
+    )
+    invited_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        null=True,
+        blank=True,
+        related_name="organization_invitations_sent",
+        on_delete=models.SET_NULL,
+        help_text="User who invited this user to the organization",
+    )
+
+    class Meta:
+        unique_together = ("user", "organization")
+        verbose_name = "Organization Role"
+        verbose_name_plural = "Organization Roles"
+        ordering = ["-joined_at"]
+        indexes = [
+            models.Index(
+                fields=["organization", "status"], name="org_role_org_status_idx"
+            ),
+            models.Index(
+                fields=["user", "organization"], name="org_role_unique_idx"
+            ),
+            models.Index(fields=["status"], name="org_role_status_idx"),
+        ]
+
+    def __str__(self):
+        return f"{self.user.email} - {self.organization.name} ({self.role})"
+
+    def accept_invitation(self):
+        """Mark the invitation as accepted."""
+        self.status = "active"
+        self.invitation_accepted_at = timezone.now()
+        self.save()
+
+    def decline_invitation(self):
+        """Mark the invitation as declined."""
+        self.status = "declined"
+        self.save()
+
+
 class ContentTag(models.Model):
     id = UUIDField(primary_key=True, default=uuid.uuid4)
     tag_name = models.CharField(max_length=50)