essence 0.7.0

Essential models and database logic for the Adapt chat platform.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

use crate::models::{PermissionOverwrite, Permissions, Role};

/// Calculates the permissions after applying all role permissions and channel overwrites.
/// This mutates `roles` by sorting it by position.
///
/// # Note
/// This does not account for guild owners (they should have all permissions), this should be
/// handled by the caller.
///
/// # Parameters
/// * `user_id` - The ID of the user to calculate permissions for.
/// * `roles` - The roles the user has.
/// * `overwrites` - The channel overwrites, or `None` to apply no overwrites.
#[must_use]
pub fn calculate_permissions(
    user_id: u64,
    base: Permissions,
    mut roles: impl AsMut<[Role]>,
    overwrites: Option<&[PermissionOverwrite]>,
) -> Permissions {
    let roles = roles.as_mut();
    roles.sort_unstable_by_key(|r| r.position);

    calculate_permissions_sorted(user_id, base, roles, overwrites)
}

/// Calculates the permissions after applying all role permissions and channel overwrites.
/// This assumes `roles` is sorted by position.
///
/// # Note
/// This does not account for guild owners (they should have all permissions), this should be
/// handled by the caller.
///
/// # Parameters
/// * `user_id` - The ID of the user to calculate permissions for.
/// * `roles` - The roles the user has.
/// * `overwrites` - The channel overwrites, or `None` to apply no overwrites.
#[must_use]
pub fn calculate_permissions_sorted(
    user_id: u64,
    base: Permissions,
    roles: impl AsRef<[Role]>,
    overwrites: Option<&[PermissionOverwrite]>,
) -> Permissions {
    let roles = roles.as_ref();

    let mut perms = roles
        .iter()
        .fold(base, |acc, role| acc | role.permissions.allow);
    perms &= !roles
        .iter()
        .fold(base, |acc, role| acc | role.permissions.deny);

    // currently, administrator acts after denied perms, meaning administrator does *not* take
    // precedence when a higher role denies the administrator permission. this could change in the
    // future
    if perms.contains(Permissions::ADMINISTRATOR) {
        return Permissions::all();
    }

    if let Some(overwrites) = overwrites {
        let mut role_overwrites = overwrites
            .iter()
            .filter_map(|o| roles.iter().find(|r| r.id == o.id).map(|r| (o, r.position)))
            .collect::<Vec<_>>();

        role_overwrites.sort_by_key(|(_, pos)| *pos);

        for (overwrite, _) in role_overwrites {
            perms |= overwrite.permissions.allow;
            perms &= !overwrite.permissions.deny;
        }

        if let Some(o) = overwrites.iter().find(|o| o.id == user_id) {
            perms |= o.permissions.allow;
            perms &= !o.permissions.deny;
        }
    }

    perms
}