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
// Copyright 2024 New Vector Ltd.
// Copyright 2021-2024 The Matrix.org Foundation C.I.C.
//
// SPDX-License-Identifier: AGPL-3.0-only
// Please see LICENSE in the repository root for full details.
//! Repositories to interact with entities related to user accounts
use async_trait::async_trait;
use mas_data_model::User;
use rand_core::RngCore;
use ulid::Ulid;
use crate::{repository_impl, Clock, Page, Pagination};
mod email;
mod password;
mod recovery;
mod session;
mod terms;
pub use self::{
email::{UserEmailFilter, UserEmailRepository},
password::UserPasswordRepository,
recovery::UserRecoveryRepository,
session::{BrowserSessionFilter, BrowserSessionRepository},
terms::UserTermsRepository,
};
/// The state of a user account
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum UserState {
/// The account is locked, it has the `locked_at` timestamp set
Locked,
/// The account is active
Active,
}
impl UserState {
/// Returns `true` if the user state is [`Locked`].
///
/// [`Locked`]: UserState::Locked
#[must_use]
pub fn is_locked(&self) -> bool {
matches!(self, Self::Locked)
}
/// Returns `true` if the user state is [`Active`].
///
/// [`Active`]: UserState::Active
#[must_use]
pub fn is_active(&self) -> bool {
matches!(self, Self::Active)
}
}
/// Filter parameters for listing users
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub struct UserFilter<'a> {
state: Option<UserState>,
can_request_admin: Option<bool>,
_phantom: std::marker::PhantomData<&'a ()>,
}
impl<'a> UserFilter<'a> {
/// Create a new [`UserFilter`] with default values
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Filter for active users
#[must_use]
pub fn active_only(mut self) -> Self {
self.state = Some(UserState::Active);
self
}
/// Filter for locked users
#[must_use]
pub fn locked_only(mut self) -> Self {
self.state = Some(UserState::Locked);
self
}
/// Filter for users that can request admin privileges
#[must_use]
pub fn can_request_admin_only(mut self) -> Self {
self.can_request_admin = Some(true);
self
}
/// Filter for users that can't request admin privileges
#[must_use]
pub fn cannot_request_admin_only(mut self) -> Self {
self.can_request_admin = Some(false);
self
}
/// Get the state filter
///
/// Returns [`None`] if no state filter was set
#[must_use]
pub fn state(&self) -> Option<UserState> {
self.state
}
/// Get the can request admin filter
///
/// Returns [`None`] if no can request admin filter was set
#[must_use]
pub fn can_request_admin(&self) -> Option<bool> {
self.can_request_admin
}
}
/// A [`UserRepository`] helps interacting with [`User`] saved in the storage
/// backend
#[async_trait]
pub trait UserRepository: Send + Sync {
/// The error type returned by the repository
type Error;
/// Lookup a [`User`] by its ID
///
/// Returns `None` if no [`User`] was found
///
/// # Parameters
///
/// * `id`: The ID of the [`User`] to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn lookup(&mut self, id: Ulid) -> Result<Option<User>, Self::Error>;
/// Find a [`User`] by its username
///
/// Returns `None` if no [`User`] was found
///
/// # Parameters
///
/// * `username`: The username of the [`User`] to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn find_by_username(&mut self, username: &str) -> Result<Option<User>, Self::Error>;
/// Create a new [`User`]
///
/// Returns the newly created [`User`]
///
/// # Parameters
///
/// * `rng`: A random number generator to generate the [`User`] ID
/// * `clock`: The clock used to generate timestamps
/// * `username`: The username of the [`User`]
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
username: String,
) -> Result<User, Self::Error>;
/// Check if a [`User`] exists
///
/// Returns `true` if the [`User`] exists, `false` otherwise
///
/// # Parameters
///
/// * `username`: The username of the [`User`] to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn exists(&mut self, username: &str) -> Result<bool, Self::Error>;
/// Lock a [`User`]
///
/// Returns the locked [`User`]
///
/// # Parameters
///
/// * `clock`: The clock used to generate timestamps
/// * `user`: The [`User`] to lock
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn lock(&mut self, clock: &dyn Clock, user: User) -> Result<User, Self::Error>;
/// Unlock a [`User`]
///
/// Returns the unlocked [`User`]
///
/// # Parameters
///
/// * `user`: The [`User`] to unlock
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn unlock(&mut self, user: User) -> Result<User, Self::Error>;
/// Set whether a [`User`] can request admin
///
/// Returns the [`User`] with the new `can_request_admin` value
///
/// # Parameters
///
/// * `user`: The [`User`] to update
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn set_can_request_admin(
&mut self,
user: User,
can_request_admin: bool,
) -> Result<User, Self::Error>;
/// List [`User`] with the given filter and pagination
///
/// # Parameters
///
/// * `filter`: The filter parameters
/// * `pagination`: The pagination parameters
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn list(
&mut self,
filter: UserFilter<'_>,
pagination: Pagination,
) -> Result<Page<User>, Self::Error>;
/// Count the [`User`] with the given filter
///
/// # Parameters
///
/// * `filter`: The filter parameters
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn count(&mut self, filter: UserFilter<'_>) -> Result<usize, Self::Error>;
/// Acquire a lock on the user to make sure device operations are done in a
/// sequential way. The lock is released when the repository is saved or
/// rolled back.
///
/// # Parameters
///
/// * `user`: The user to lock
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn acquire_lock_for_sync(&mut self, user: &User) -> Result<(), Self::Error>;
}
repository_impl!(UserRepository:
async fn lookup(&mut self, id: Ulid) -> Result<Option<User>, Self::Error>;
async fn find_by_username(&mut self, username: &str) -> Result<Option<User>, Self::Error>;
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
username: String,
) -> Result<User, Self::Error>;
async fn exists(&mut self, username: &str) -> Result<bool, Self::Error>;
async fn lock(&mut self, clock: &dyn Clock, user: User) -> Result<User, Self::Error>;
async fn unlock(&mut self, user: User) -> Result<User, Self::Error>;
async fn set_can_request_admin(
&mut self,
user: User,
can_request_admin: bool,
) -> Result<User, Self::Error>;
async fn list(
&mut self,
filter: UserFilter<'_>,
pagination: Pagination,
) -> Result<Page<User>, Self::Error>;
async fn count(&mut self, filter: UserFilter<'_>) -> Result<usize, Self::Error>;
async fn acquire_lock_for_sync(&mut self, user: &User) -> Result<(), Self::Error>;
);