feat(core): permissions query, finish bots impl

crates/core/permissions/Cargo.toml

@@ -3,16 +3,16 @@ name = "revolt-permissions"
 version = "0.6.5"
 edition = "2021"
 license = "AGPL-3.0-or-later"
-authors = [ "Paul Makles <me@insrt.uk>" ]
+authors = ["Paul Makles <me@insrt.uk>"]
 description = "Revolt Backend: Permission Logic"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
 bson = ["dep:bson"]
-serde = [ "dep:serde" ]
-schemas = [ "dep:schemars" ]
-try-from-primitive = [ "dep:num_enum" ]
+serde = ["dep:serde"]
+schemas = ["dep:schemars"]
+try-from-primitive = ["dep:num_enum"]
 
 
 [dev-dependencies]
@@ -20,6 +20,9 @@ try-from-primitive = [ "dep:num_enum" ]
 async-std = { version = "1.8.0", features = ["attributes"] }
 
 [dependencies]
+# Core
+revolt-result = { version = "0.6.5", path = "../result" }
+
 # Utility
 auto_ops = "0.3.0"
 once_cell = "1.17"
@@ -30,7 +33,7 @@ async-trait = "0.1.51"
 
 # Serialisation
 serde = { version = "1", features = ["derive"], optional = true }
-bson = { version = "2.1.0", optional = true}
+bson = { version = "2.1.0", optional = true }
 
 # Spec Generation
-schemars = { version = "0.8.8", optional = true }
+schemars = { version = "0.8.8", optional = true }

crates/core/permissions/src/models/channel.rs

@@ -1,5 +1,5 @@
 use once_cell::sync::Lazy;
-use std::ops::Add;
+use std::{fmt, ops::Add};
 
 /// Abstract channel type
 pub enum ChannelType {
@@ -102,6 +102,12 @@ pub enum ChannelPermission {
     GrantAll = u64::MAX,
 }
 
+impl fmt::Display for ChannelPermission {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        fmt::Debug::fmt(self, f)
+    }
+}
+
 impl_op_ex!(+ |a: &ChannelPermission, b: &ChannelPermission| -> u64 { *a as u64 | *b as u64 });
 impl_op_ex_commutative!(+ |a: &u64, b: &ChannelPermission| -> u64 { *a | *b as u64 });
 
@@ -136,4 +142,9 @@ pub static DEFAULT_PERMISSION_SERVER: Lazy<u64> = Lazy::new(|| {
     )
 });
 
-pub static DEFAULT_WEBHOOK_PERMISSIONS: Lazy<u64> = Lazy::new(|| ChannelPermission::SendMessage + ChannelPermission::SendEmbeds + ChannelPermission::Masquerade + ChannelPermission::React);
+pub static DEFAULT_WEBHOOK_PERMISSIONS: Lazy<u64> = Lazy::new(|| {
+    ChannelPermission::SendMessage
+        + ChannelPermission::SendEmbeds
+        + ChannelPermission::Masquerade
+        + ChannelPermission::React
+});

crates/core/permissions/src/models/mod.rs

@@ -3,6 +3,7 @@ mod server;
 mod user;
 
 pub use channel::*;
+use revolt_result::{create_error, Result};
 pub use server::*;
 pub use user::*;
 
@@ -31,6 +32,30 @@ impl PermissionValue {
     pub fn restrict(&mut self, v: u64) {
         self.0 &= v;
     }
+
+    /// Check whether certain a permission has been granted
+    pub fn has(&mut self, v: u64) -> bool {
+        (self.0 & v) == v
+    }
+
+    /// Check whether certain a channel permission has been granted
+    pub fn has_channel_permission(&mut self, permission: ChannelPermission) -> bool {
+        self.has(permission as u64)
+    }
+
+    /// Throw if missing channel permission
+    pub fn throw_if_lacking_channel_permission(
+        &mut self,
+        permission: ChannelPermission,
+    ) -> Result<()> {
+        if self.has_channel_permission(permission) {
+            Ok(())
+        } else {
+            Err(create_error!(MissingPermission {
+                permission: permission.to_string()
+            }))
+        }
+    }
 }
 
 impl From<i64> for PermissionValue {

crates/core/permissions/src/models/user.rs

@@ -1,3 +1,5 @@
+use std::fmt;
+
 /// User's relationship with another user (or themselves)
 pub enum RelationshipStatus {
     None,
@@ -21,5 +23,11 @@ pub enum UserPermission {
     Invite = 1 << 3,
 }
 
+impl fmt::Display for UserPermission {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        fmt::Debug::fmt(self, f)
+    }
+}
+
 impl_op_ex!(+ |a: &UserPermission, b: &UserPermission| -> u32 { *a as u32 | *b as u32 });
 impl_op_ex_commutative!(+ |a: &u32, b: &UserPermission| -> u32 { *a | *b as u32 });