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
// Copyright 2024 New Vector Ltd.
// Copyright 2022-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.
use async_trait::async_trait;
use mas_data_model::{User, UserEmail, UserEmailVerification};
use rand_core::RngCore;
use ulid::Ulid;
use crate::{pagination::Page, repository_impl, Clock, Pagination};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum UserEmailState {
Pending,
Verified,
}
impl UserEmailState {
/// Returns true if the filter should only return non-verified emails
pub fn is_pending(self) -> bool {
matches!(self, Self::Pending)
}
/// Returns true if the filter should only return verified emails
pub fn is_verified(self) -> bool {
matches!(self, Self::Verified)
}
}
/// Filter parameters for listing user emails
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub struct UserEmailFilter<'a> {
user: Option<&'a User>,
email: Option<&'a str>,
state: Option<UserEmailState>,
}
impl<'a> UserEmailFilter<'a> {
/// Create a new [`UserEmailFilter`] with default values
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Filter for emails of a specific user
#[must_use]
pub fn for_user(mut self, user: &'a User) -> Self {
self.user = Some(user);
self
}
/// Filter for emails matching a specific email address
#[must_use]
pub fn for_email(mut self, email: &'a str) -> Self {
self.email = Some(email);
self
}
/// Get the user filter
///
/// Returns [`None`] if no user filter is set
#[must_use]
pub fn user(&self) -> Option<&User> {
self.user
}
/// Get the email filter
///
/// Returns [`None`] if no email filter is set
#[must_use]
pub fn email(&self) -> Option<&str> {
self.email
}
/// Filter for emails that are verified
#[must_use]
pub fn verified_only(mut self) -> Self {
self.state = Some(UserEmailState::Verified);
self
}
/// Filter for emails that are not verified
#[must_use]
pub fn pending_only(mut self) -> Self {
self.state = Some(UserEmailState::Pending);
self
}
/// Get the state filter
///
/// Returns [`None`] if no state filter is set
#[must_use]
pub fn state(&self) -> Option<UserEmailState> {
self.state
}
}
/// A [`UserEmailRepository`] helps interacting with [`UserEmail`] saved in the
/// storage backend
#[async_trait]
pub trait UserEmailRepository: Send + Sync {
/// The error type returned by the repository
type Error;
/// Lookup an [`UserEmail`] by its ID
///
/// Returns `None` if no [`UserEmail`] was found
///
/// # Parameters
///
/// * `id`: The ID of the [`UserEmail`] to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn lookup(&mut self, id: Ulid) -> Result<Option<UserEmail>, Self::Error>;
/// Lookup an [`UserEmail`] by its email address for a [`User`]
///
/// Returns `None` if no matching [`UserEmail`] was found
///
/// # Parameters
///
/// * `user`: The [`User`] for whom to lookup the [`UserEmail`]
/// * `email`: The email address to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn find(&mut self, user: &User, email: &str) -> Result<Option<UserEmail>, Self::Error>;
/// Get the primary [`UserEmail`] of a [`User`]
///
/// Returns `None` if no the user has no primary [`UserEmail`]
///
/// # Parameters
///
/// * `user`: The [`User`] for whom to lookup the primary [`UserEmail`]
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn get_primary(&mut self, user: &User) -> Result<Option<UserEmail>, Self::Error>;
/// Get all [`UserEmail`] of a [`User`]
///
/// # Parameters
///
/// * `user`: The [`User`] for whom to lookup the [`UserEmail`]
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn all(&mut self, user: &User) -> Result<Vec<UserEmail>, Self::Error>;
/// List [`UserEmail`] 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: UserEmailFilter<'_>,
pagination: Pagination,
) -> Result<Page<UserEmail>, Self::Error>;
/// Count the [`UserEmail`] with the given filter
///
/// # Parameters
///
/// * `filter`: The filter parameters
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn count(&mut self, filter: UserEmailFilter<'_>) -> Result<usize, Self::Error>;
/// Create a new [`UserEmail`] for a [`User`]
///
/// Returns the newly created [`UserEmail`]
///
/// # Parameters
///
/// * `rng`: The random number generator to use
/// * `clock`: The clock to use
/// * `user`: The [`User`] for whom to create the [`UserEmail`]
/// * `email`: The email address of the [`UserEmail`]
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user: &User,
email: String,
) -> Result<UserEmail, Self::Error>;
/// Delete a [`UserEmail`]
///
/// # Parameters
///
/// * `user_email`: The [`UserEmail`] to delete
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn remove(&mut self, user_email: UserEmail) -> Result<(), Self::Error>;
/// Mark a [`UserEmail`] as verified
///
/// Returns the updated [`UserEmail`]
///
/// # Parameters
///
/// * `clock`: The clock to use
/// * `user_email`: The [`UserEmail`] to mark as verified
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn mark_as_verified(
&mut self,
clock: &dyn Clock,
user_email: UserEmail,
) -> Result<UserEmail, Self::Error>;
/// Mark a [`UserEmail`] as primary
///
/// # Parameters
///
/// * `user_email`: The [`UserEmail`] to mark as primary
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn set_as_primary(&mut self, user_email: &UserEmail) -> Result<(), Self::Error>;
/// Add a [`UserEmailVerification`] for a [`UserEmail`]
///
/// # Parameters
///
/// * `rng`: The random number generator to use
/// * `clock`: The clock to use
/// * `user_email`: The [`UserEmail`] for which to add the
/// [`UserEmailVerification`]
/// * `max_age`: The duration for which the [`UserEmailVerification`] is
/// valid
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn add_verification_code(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user_email: &UserEmail,
max_age: chrono::Duration,
code: String,
) -> Result<UserEmailVerification, Self::Error>;
/// Find a [`UserEmailVerification`] for a [`UserEmail`] by its code
///
/// Returns `None` if no matching [`UserEmailVerification`] was found
///
/// # Parameters
///
/// * `clock`: The clock to use
/// * `user_email`: The [`UserEmail`] for which to lookup the
/// [`UserEmailVerification`]
/// * `code`: The code used to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn find_verification_code(
&mut self,
clock: &dyn Clock,
user_email: &UserEmail,
code: &str,
) -> Result<Option<UserEmailVerification>, Self::Error>;
/// Consume a [`UserEmailVerification`]
///
/// Returns the consumed [`UserEmailVerification`]
///
/// # Parameters
///
/// * `clock`: The clock to use
/// * `verification`: The [`UserEmailVerification`] to consume
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn consume_verification_code(
&mut self,
clock: &dyn Clock,
verification: UserEmailVerification,
) -> Result<UserEmailVerification, Self::Error>;
}
repository_impl!(UserEmailRepository:
async fn lookup(&mut self, id: Ulid) -> Result<Option<UserEmail>, Self::Error>;
async fn find(&mut self, user: &User, email: &str) -> Result<Option<UserEmail>, Self::Error>;
async fn get_primary(&mut self, user: &User) -> Result<Option<UserEmail>, Self::Error>;
async fn all(&mut self, user: &User) -> Result<Vec<UserEmail>, Self::Error>;
async fn list(
&mut self,
filter: UserEmailFilter<'_>,
pagination: Pagination,
) -> Result<Page<UserEmail>, Self::Error>;
async fn count(&mut self, filter: UserEmailFilter<'_>) -> Result<usize, Self::Error>;
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user: &User,
email: String,
) -> Result<UserEmail, Self::Error>;
async fn remove(&mut self, user_email: UserEmail) -> Result<(), Self::Error>;
async fn mark_as_verified(
&mut self,
clock: &dyn Clock,
user_email: UserEmail,
) -> Result<UserEmail, Self::Error>;
async fn set_as_primary(&mut self, user_email: &UserEmail) -> Result<(), Self::Error>;
async fn add_verification_code(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user_email: &UserEmail,
max_age: chrono::Duration,
code: String,
) -> Result<UserEmailVerification, Self::Error>;
async fn find_verification_code(
&mut self,
clock: &dyn Clock,
user_email: &UserEmail,
code: &str,
) -> Result<Option<UserEmailVerification>, Self::Error>;
async fn consume_verification_code(
&mut self,
clock: &dyn Clock,
verification: UserEmailVerification,
) -> Result<UserEmailVerification, Self::Error>;
);