ic-canister-kit 1.0.18

An ic canister package
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use std::{
    collections::{HashMap, HashSet},
    fmt::{Debug, Display},
    hash::Hash,
};

use candid::CandidType;
use serde::{Deserialize, Serialize};

use crate::{common::option::display_option_by, identity::UserId};

/// 权限管理

/// 权限修改参数
#[derive(CandidType, Serialize, Deserialize, Debug, Clone)]
pub enum PermissionUpdatedArg<Permission: Eq + Hash> {
    /// 更新用户权限
    UpdateUserPermission(UserId, Option<HashSet<Permission>>),
    /// 更新角色权限
    UpdateRolePermission(String, Option<HashSet<Permission>>),
    /// 更新用户角色
    UpdateUserRole(UserId, Option<HashSet<String>>),
}

/// 权限更新错误
#[derive(CandidType, Serialize, Deserialize, Debug, Clone)]
pub enum PermissionUpdatedError<Permission> {
    /// 权限不存在错误
    InvalidPermission(Permission),
    /// 角色不存在错误
    InvalidRole(String),
}
impl<Permission: Debug> Display for PermissionUpdatedError<Permission> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PermissionUpdatedError::InvalidPermission(permission) => {
                write!(f, "InvalidPermission({permission:?})")
            }
            PermissionUpdatedError::InvalidRole(role) => write!(f, "InvalidRole({role})"),
        }
    }
}
impl<Permission: Debug> std::error::Error for PermissionUpdatedError<Permission> {}

/// 权限管理
pub trait Permissable<Permission: Eq + Hash> {
    // 查询
    ///  当前管理的所有用户 包括直接授权的和通过角色授权的
    fn permission_users(&self) -> HashSet<&UserId>;
    ///  当前管理的所有角色
    fn permission_roles(&self) -> HashSet<&String>;

    ///  某用户被直接授权的权限
    fn permission_assigned(&self, user_id: &UserId) -> Option<&HashSet<Permission>>;
    ///  某角色被直接授权的权限
    fn permission_role_assigned(&self, role: &str) -> Option<&HashSet<Permission>>;
    /// 某用户被授权的角色
    fn permission_user_roles(&self, user_id: &UserId) -> Option<&HashSet<String>>;

    /// 综合直接授权和角色间接授权的情况
    /// 若权限是默认没有的(Permitted),任意路径包含则有该权限,fallback 是 无
    /// 若权限是默认拥有的(Forbidden),任意路径包含则无该权限,fallback 是 有

    /// 判断用户是否拥有某权限
    fn permission_has(&self, user_id: &UserId, permission: &Permission) -> bool;
    /// 获取用户的综合权限情况
    fn permission_owned(&self, user_id: &UserId) -> HashMap<&Permission, bool>;

    // 修改

    /// 重置管理的权限,防止版本更新导致某一个权限的信息不一致
    fn permission_reset(&mut self, permissions: HashSet<Permission>);
    /// 权限更新
    fn permission_update(
        &mut self,
        args: Vec<PermissionUpdatedArg<Permission>>,
    ) -> Result<(), PermissionUpdatedError<Permission>>;
}

impl Display for PermissionUpdatedArg<String> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::UpdateUserPermission(user_id, permissions) => f.write_str(&format!(
                "update user: {} permissions: {}",
                user_id.to_text(),
                display_option_by(permissions, |permissions| format!(
                    "[{}]",
                    permissions
                        .iter()
                        .map(|p| p.to_string())
                        .collect::<Vec<_>>()
                        .join(",")
                ))
            )),
            Self::UpdateRolePermission(role, permissions) => f.write_str(&format!(
                "update role: {} permissions: {}",
                role,
                display_option_by(permissions, |permissions| format!(
                    "[{}]",
                    permissions
                        .iter()
                        .map(|p| p.to_string())
                        .collect::<Vec<_>>()
                        .join(",")
                ))
            )),
            Self::UpdateUserRole(user_id, roles) => f.write_str(&format!(
                "update user: {} roles: {}",
                user_id.to_text(),
                display_option_by(roles, |roles| format!(
                    "[{}]",
                    roles.iter().cloned().collect::<Vec<_>>().join(",")
                ))
            )),
        }
    }
}

// ================== 简单实现 ==================

/// 权限功能简单实现
pub mod basic {
    use std::{
        collections::{HashMap, HashSet},
        fmt::Display,
    };

    use candid::CandidType;
    use serde::{Deserialize, Serialize};

    use crate::{
        functions::types::{Permissable, PermissionUpdatedArg, PermissionUpdatedError},
        identity::UserId,
    };

    /// 被管理的用户类型
    #[derive(CandidType, Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
    pub enum Permission {
        /// 授权类型 默认没有该权限 只有被加入的用户才有该权限
        Permitted(String),
        /// 禁止类型 默认拥有该权限 如果被加入了就没有该权限了
        Forbidden(String),
    }

    impl Display for Permission {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            match self {
                Permission::Permitted(name) => write!(f, "Permitted({name})"),
                Permission::Forbidden(name) => write!(f, "Forbidden({name})"),
            }
        }
    }

    impl Permission {
        /// 构造许可权限
        pub fn by_permit(name: &str) -> Self {
            Permission::Permitted(name.to_string())
        }
        /// 构造禁止权限
        pub fn by_forbid(name: &str) -> Self {
            Permission::Forbidden(name.to_string())
        }
        /// 判断是否许可权限
        pub fn is_permit(&self) -> bool {
            matches!(self, Self::Permitted(_))
        }
        /// 判断是否禁止权限
        pub fn is_forbid(&self) -> bool {
            matches!(self, Self::Forbidden(_))
        }
        /// 文本化
        pub fn name(&self) -> &str {
            match self {
                Permission::Permitted(name) => name,
                Permission::Forbidden(name) => name,
            }
        }
    }

    /// 多个权限对象
    #[derive(CandidType, Serialize, Deserialize, Debug, Clone, Default)]
    pub struct Permissions {
        /// 所有权限种类
        pub permissions: HashSet<Permission>,
        /// 用户分配的特别权限, Permitted表示拥有, Forbidden表示禁止
        pub user_permissions: HashMap<UserId, HashSet<Permission>>,
        /// 某角色对权限的限制
        pub role_permissions: HashMap<String, HashSet<Permission>>,
        /// 用户被授权的角色
        pub user_roles: HashMap<UserId, HashSet<String>>,
    }

    impl Permissions {
        // 检查一定存在权限
        fn assure_permission_exist(
            &self,
            permissions: &Option<HashSet<Permission>>,
        ) -> Result<(), PermissionUpdatedError<Permission>> {
            if let Some(permissions) = permissions {
                for permission in permissions {
                    if !self.permissions.contains(permission) {
                        return Err(PermissionUpdatedError::InvalidPermission(
                            permission.clone(),
                        ));
                    }
                }
            }

            Ok(())
        }
        // 检查一定存在角色
        fn assure_role_exist(
            &self,
            roles: &Option<HashSet<String>>,
        ) -> Result<(), PermissionUpdatedError<Permission>> {
            if let Some(roles) = roles {
                for role in roles {
                    if !self.role_permissions.contains_key(role) {
                        return Err(PermissionUpdatedError::InvalidRole(role.clone()));
                    }
                }
            }
            Ok(())
        }
    }

    impl Permissable<Permission> for Permissions {
        // 查询
        fn permission_users(&self) -> HashSet<&UserId> {
            let mut users: HashSet<&UserId> = self.user_roles.keys().collect();
            users.extend(self.user_permissions.keys());
            users
        }
        fn permission_roles(&self) -> HashSet<&String> {
            self.role_permissions.keys().collect()
        }

        fn permission_assigned(&self, user_id: &UserId) -> Option<&HashSet<Permission>> {
            self.user_permissions.get(user_id)
        }
        fn permission_role_assigned(&self, role: &str) -> Option<&HashSet<Permission>> {
            self.role_permissions.get(role)
        }
        fn permission_user_roles(&self, user_id: &UserId) -> Option<&HashSet<String>> {
            self.user_roles.get(user_id)
        }

        fn permission_has(&self, user_id: &UserId, permission: &Permission) -> bool {
            // 单独指定
            if let Some(permissions) = self.user_permissions.get(user_id) {
                if permissions.contains(permission) {
                    return match permission {
                        Permission::Permitted(_) => true,
                        Permission::Forbidden(_) => false,
                    };
                }
            }
            // 角色自定
            if let Some(roles) = self.user_roles.get(user_id) {
                for role in roles {
                    if let Some(permissions) = self.role_permissions.get(role) {
                        if permissions.contains(permission) {
                            return match permission {
                                Permission::Permitted(_) => true,
                                Permission::Forbidden(_) => false,
                            };
                        }
                    }
                }
            }
            // 不存在则默认
            match permission {
                Permission::Permitted(_) => false,
                Permission::Forbidden(_) => true,
            }
        }
        fn permission_owned(&self, user_id: &UserId) -> HashMap<&Permission, bool> {
            self.permissions
                .iter()
                .map(|permission| (permission, self.permission_has(user_id, permission)))
                .collect()
        }

        // 修改
        fn permission_reset(&mut self, permissions: HashSet<Permission>) {
            self.permissions = permissions;
            // 核对其他数据中的权限是否正确
            self.role_permissions
                .iter_mut()
                .for_each(|(_, permissions)| {
                    let mut removed = Vec::new();
                    for permission in permissions.iter() {
                        if !self.permissions.contains(permission) {
                            removed.push(permission.clone());
                        }
                    }
                    for permission in removed {
                        permissions.remove(&permission);
                    }
                });
            self.user_permissions
                .iter_mut()
                .for_each(|(_, permissions)| {
                    let mut removed = Vec::new();
                    for permission in permissions.iter() {
                        if !self.permissions.contains(permission) {
                            removed.push(permission.clone());
                        }
                    }
                    for permission in removed {
                        permissions.remove(&permission);
                    }
                });
        }
        fn permission_update(
            &mut self,
            args: Vec<PermissionUpdatedArg<Permission>>,
        ) -> Result<(), PermissionUpdatedError<Permission>> {
            for arg in args.iter() {
                match arg {
                    PermissionUpdatedArg::UpdateUserPermission(user_id, permissions) => {
                        // 先检查权限是否都存在
                        self.assure_permission_exist(permissions)?;

                        let exist = self.user_permissions.get(user_id);
                        if let Some(permissions) = &permissions {
                            if let Some(exist) = exist {
                                if exist == permissions {
                                    continue;
                                }
                            }
                        } else if exist.is_none() {
                            continue;
                        }
                        if let Some(permissions) = permissions {
                            self.user_permissions.insert(*user_id, permissions.clone());
                        } else {
                            self.user_permissions.remove(user_id);
                        }
                    }
                    PermissionUpdatedArg::UpdateRolePermission(role, permissions) => {
                        // 先检查权限是否都存在
                        self.assure_permission_exist(permissions)?;

                        let exist = self.role_permissions.get(role);
                        if let Some(permissions) = permissions {
                            if let Some(exist) = exist {
                                if exist == permissions {
                                    continue;
                                }
                            }
                        } else if exist.is_none() {
                            continue;
                        }
                        if let Some(permissions) = permissions {
                            self.role_permissions
                                .insert(role.clone(), permissions.clone());
                        } else {
                            self.role_permissions.remove(role);
                            // 移除要检查用户角色数据对不对
                            self.user_roles.iter_mut().for_each(|(_, roles)| {
                                let mut removed = Vec::new();
                                for role in roles.iter() {
                                    if !self.role_permissions.contains_key(role) {
                                        removed.push(role.clone());
                                    }
                                }
                                for role in removed {
                                    roles.remove(&role);
                                }
                            });
                        }
                    }
                    PermissionUpdatedArg::UpdateUserRole(user_id, roles) => {
                        // 先检查角色是否都存在
                        self.assure_role_exist(roles)?;

                        let exist = self.user_roles.get(user_id);
                        if let Some(roles) = &roles {
                            if let Some(exist) = exist {
                                if exist == roles {
                                    continue;
                                }
                            }
                        } else if exist.is_none() {
                            continue;
                        }
                        if let Some(roles) = roles {
                            self.user_roles.insert(*user_id, roles.clone());
                        } else {
                            self.user_roles.remove(user_id);
                        }
                    }
                }
            }
            Ok(())
        }
    }

    impl PermissionUpdatedArg<String> {
        /// 解析权限,返回 PermissionUpdatedArg
        ///
        /// # Arguments
        ///
        /// * `f` - 权限解析函数,将字符串解析为 Permission
        pub fn parse_permission<E, F: Fn(&str) -> Result<Permission, E>>(
            self,
            f: F,
        ) -> Result<PermissionUpdatedArg<Permission>, E> {
            Ok(match self {
                PermissionUpdatedArg::UpdateUserPermission(user_id, permissions) => {
                    PermissionUpdatedArg::UpdateUserPermission(
                        user_id,
                        permissions
                            .map(|ps| {
                                ps.into_iter()
                                    .map(|p| f(&p))
                                    .collect::<Result<HashSet<_>, _>>()
                            })
                            .transpose()?,
                    )
                }
                PermissionUpdatedArg::UpdateRolePermission(role, permissions) => {
                    PermissionUpdatedArg::UpdateRolePermission(
                        role,
                        permissions
                            .map(|ps| {
                                ps.into_iter()
                                    .map(|p| f(&p))
                                    .collect::<Result<HashSet<_>, _>>()
                            })
                            .transpose()?,
                    )
                }
                PermissionUpdatedArg::UpdateUserRole(user_id, roles) => {
                    PermissionUpdatedArg::UpdateUserRole(user_id, roles)
                }
            })
        }
    }
}