add: journal page memberships

add: "Joined" write access option

crates/core/src/model/journal.rs

@@ -1,6 +1,8 @@
 use serde::{Deserialize, Serialize};
 use tetratto_shared::{snow::AlmostSnowflake, unix_epoch_timestamp};
 
+use super::journal_permissions::JournalPermission;
+
 #[derive(Serialize, Deserialize)]
 pub struct JournalPage {
     pub id: usize,
@@ -37,7 +39,7 @@ impl JournalPage {
 }
 
 /// Who can read a [`JournalPage`].
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, PartialEq, Eq)]
 pub enum JournalPageReadAccess {
     /// Everybody can view the journal page from the owner's profile.
     Everybody,
@@ -54,12 +56,16 @@ impl Default for JournalPageReadAccess {
 }
 
 /// Who can write to a [`JournalPage`].
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, PartialEq, Eq)]
 pub enum JournalPageWriteAccess {
     /// Everybody (authenticated + anonymous users).
     Everybody,
     /// Authenticated users only.
     Authenticated,
+    /// Only people who joined the journal page can write to it.
+    ///
+    /// Memberships can be managed by the owner of the journal page.
+    Joined,
     /// Only the owner of the journal page.
     Owner,
 }
@@ -70,6 +76,30 @@ impl Default for JournalPageWriteAccess {
     }
 }
 
+#[derive(Serialize, Deserialize)]
+pub struct JournalPageMembership {
+    pub id: usize,
+    pub created: usize,
+    pub owner: usize,
+    pub journal: usize,
+    pub role: JournalPermission,
+}
+
+impl JournalPageMembership {
+    pub fn new(owner: usize, journal: usize, role: JournalPermission) -> Self {
+        Self {
+            id: AlmostSnowflake::new(1234567890)
+                .to_string()
+                .parse::<usize>()
+                .unwrap(),
+            created: unix_epoch_timestamp() as usize,
+            owner,
+            journal,
+            role,
+        }
+    }
+}
+
 #[derive(Serialize, Deserialize)]
 pub struct JournalEntry {
     pub id: usize,

crates/core/src/model/journal_permissions.rs

@@ -0,0 +1,105 @@
+use bitflags::bitflags;
+use serde::{
+    Deserialize, Deserializer, Serialize,
+    de::{Error as DeError, Visitor},
+};
+
+bitflags! {
+    /// Fine-grained journal permissions built using bitwise operations.
+    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+    pub struct JournalPermission: u32 {
+        const DEFAULT = 1 << 0;
+        const ADMINISTRATOR = 1 << 1;
+        const MEMBER = 1 << 2;
+
+        const _ = !0;
+    }
+}
+
+impl Serialize for JournalPermission {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        serializer.serialize_u32(self.bits())
+    }
+}
+
+struct JournalPermissionVisitor;
+impl<'de> Visitor<'de> for JournalPermissionVisitor {
+    type Value = JournalPermission;
+
+    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+        formatter.write_str("u32")
+    }
+
+    fn visit_u32<E>(self, value: u32) -> Result<Self::Value, E>
+    where
+        E: DeError,
+    {
+        if let Some(permission) = JournalPermission::from_bits(value) {
+            Ok(permission)
+        } else {
+            Ok(JournalPermission::from_bits_retain(value))
+        }
+    }
+
+    fn visit_i32<E>(self, value: i32) -> Result<Self::Value, E>
+    where
+        E: DeError,
+    {
+        if let Some(permission) = JournalPermission::from_bits(value as u32) {
+            Ok(permission)
+        } else {
+            Ok(JournalPermission::from_bits_retain(value as u32))
+        }
+    }
+
+    fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
+    where
+        E: DeError,
+    {
+        if let Some(permission) = JournalPermission::from_bits(value as u32) {
+            Ok(permission)
+        } else {
+            Ok(JournalPermission::from_bits_retain(value as u32))
+        }
+    }
+}
+
+impl<'de> Deserialize<'de> for JournalPermission {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        deserializer.deserialize_any(JournalPermissionVisitor)
+    }
+}
+
+impl JournalPermission {
+    /// Join two [`JournalPermission`]s into a single `u32`.
+    pub fn join(lhs: JournalPermission, rhs: JournalPermission) -> JournalPermission {
+        lhs | rhs
+    }
+
+    /// Check if the given `input` contains the given [`JournalPermission`].
+    pub fn check(self, permission: JournalPermission) -> bool {
+        if (self & JournalPermission::ADMINISTRATOR) == JournalPermission::ADMINISTRATOR {
+            // has administrator permission, meaning everything else is automatically true
+            return true;
+        }
+
+        (self & permission) == permission
+    }
+
+    /// Check if the given [`JournalPermission`] qualifies as "Member" status.
+    pub fn check_helper(self) -> bool {
+        self.check(JournalPermission::MEMBER)
+    }
+}
+
+impl Default for JournalPermission {
+    fn default() -> Self {
+        Self::DEFAULT
+    }
+}

crates/core/src/model/mod.rs

@@ -1,5 +1,6 @@
 pub mod auth;
 pub mod journal;
+pub mod journal_permissions;
 pub mod permissions;
 
 use serde::{Deserialize, Serialize};

crates/core/src/model/permissions.rs

@@ -19,6 +19,7 @@ bitflags! {
         const MANAGE_NOTIFICATIONS = 1 << 8;
         const VIEW_REPORTS = 1 << 9;
         const VIEW_AUDIT_LOG = 1 << 10;
+        const MANAGE_MEMBERSHIPS = 1 << 11;
 
         const _ = !0;
     }
@@ -100,7 +101,7 @@ impl FinePermission {
         (self & permission) == permission
     }
 
-    /// Check if thhe given [`FinePermission`] is qualifies as "Helper" status.
+    /// Check if the given [`FinePermission`] qualifies as "Helper" status.
     pub fn check_helper(self) -> bool {
         self.check(FinePermission::MANAGE_JOURNAL_ENTRIES)
             && self.check(FinePermission::MANAGE_JOURNAL_PAGES)
@@ -110,7 +111,7 @@ impl FinePermission {
             && self.check(FinePermission::VIEW_AUDIT_LOG)
     }
 
-    /// Check if thhe given [`FinePermission`] is qualifies as "Manager" status.
+    /// Check if the given [`FinePermission`] qualifies as "Manager" status.
     pub fn check_manager(self) -> bool {
         self.check_helper() && self.check(FinePermission::ADMINISTRATOR)
     }