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
// Copyright 2024 New Vector Ltd.
// Copyright 2023, 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.
mod mock;
use std::{collections::HashSet, sync::Arc};
pub use self::mock::HomeserverConnection as MockHomeserverConnection;
// TODO: this should probably be another error type by default
pub type BoxHomeserverConnection<Error = anyhow::Error> =
Box<dyn HomeserverConnection<Error = Error>>;
#[derive(Debug)]
pub struct MatrixUser {
pub displayname: Option<String>,
pub avatar_url: Option<String>,
pub deactivated: bool,
}
#[derive(Debug, Default)]
enum FieldAction<T> {
#[default]
DoNothing,
Set(T),
Unset,
}
pub struct ProvisionRequest {
mxid: String,
sub: String,
displayname: FieldAction<String>,
avatar_url: FieldAction<String>,
emails: FieldAction<Vec<String>>,
}
impl ProvisionRequest {
/// Create a new [`ProvisionRequest`].
///
/// # Parameters
///
/// * `mxid` - The Matrix ID to provision.
/// * `sub` - The `sub` of the user, aka the internal ID.
#[must_use]
pub fn new(mxid: impl Into<String>, sub: impl Into<String>) -> Self {
Self {
mxid: mxid.into(),
sub: sub.into(),
displayname: FieldAction::DoNothing,
avatar_url: FieldAction::DoNothing,
emails: FieldAction::DoNothing,
}
}
/// Get the `sub` of the user to provision, aka the internal ID.
#[must_use]
pub fn sub(&self) -> &str {
&self.sub
}
/// Get the Matrix ID to provision.
#[must_use]
pub fn mxid(&self) -> &str {
&self.mxid
}
/// Ask to set the displayname of the user.
///
/// # Parameters
///
/// * `displayname` - The displayname to set.
#[must_use]
pub fn set_displayname(mut self, displayname: String) -> Self {
self.displayname = FieldAction::Set(displayname);
self
}
/// Ask to unset the displayname of the user.
#[must_use]
pub fn unset_displayname(mut self) -> Self {
self.displayname = FieldAction::Unset;
self
}
/// Call the given callback if the displayname should be set or unset.
///
/// # Parameters
///
/// * `callback` - The callback to call.
pub fn on_displayname<F>(&self, callback: F) -> &Self
where
F: FnOnce(Option<&str>),
{
match &self.displayname {
FieldAction::Unset => callback(None),
FieldAction::Set(displayname) => callback(Some(displayname)),
FieldAction::DoNothing => {}
}
self
}
/// Ask to set the avatar URL of the user.
///
/// # Parameters
///
/// * `avatar_url` - The avatar URL to set.
#[must_use]
pub fn set_avatar_url(mut self, avatar_url: String) -> Self {
self.avatar_url = FieldAction::Set(avatar_url);
self
}
/// Ask to unset the avatar URL of the user.
#[must_use]
pub fn unset_avatar_url(mut self) -> Self {
self.avatar_url = FieldAction::Unset;
self
}
/// Call the given callback if the avatar URL should be set or unset.
///
/// # Parameters
///
/// * `callback` - The callback to call.
pub fn on_avatar_url<F>(&self, callback: F) -> &Self
where
F: FnOnce(Option<&str>),
{
match &self.avatar_url {
FieldAction::Unset => callback(None),
FieldAction::Set(avatar_url) => callback(Some(avatar_url)),
FieldAction::DoNothing => {}
}
self
}
/// Ask to set the emails of the user.
///
/// # Parameters
///
/// * `emails` - The list of emails to set.
#[must_use]
pub fn set_emails(mut self, emails: Vec<String>) -> Self {
self.emails = FieldAction::Set(emails);
self
}
/// Ask to unset the emails of the user.
#[must_use]
pub fn unset_emails(mut self) -> Self {
self.emails = FieldAction::Unset;
self
}
/// Call the given callback if the emails should be set or unset.
///
/// # Parameters
///
/// * `callback` - The callback to call.
pub fn on_emails<F>(&self, callback: F) -> &Self
where
F: FnOnce(Option<&[String]>),
{
match &self.emails {
FieldAction::Unset => callback(None),
FieldAction::Set(emails) => callback(Some(emails)),
FieldAction::DoNothing => {}
}
self
}
}
#[async_trait::async_trait]
pub trait HomeserverConnection: Send + Sync {
/// The error type returned by all methods.
type Error;
/// Get the homeserver URL.
fn homeserver(&self) -> &str;
/// Get the Matrix ID of the user with the given localpart.
///
/// # Parameters
///
/// * `localpart` - The localpart of the user.
fn mxid(&self, localpart: &str) -> String {
format!("@{}:{}", localpart, self.homeserver())
}
/// Query the state of a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to query.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the user does not
/// exist.
async fn query_user(&self, mxid: &str) -> Result<MatrixUser, Self::Error>;
/// Provision a user on the homeserver.
///
/// # Parameters
///
/// * `request` - a [`ProvisionRequest`] containing the details of the user
/// to provision.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the user could not
/// be provisioned.
async fn provision_user(&self, request: &ProvisionRequest) -> Result<bool, Self::Error>;
/// Check whether a given username is available on the homeserver.
///
/// # Parameters
///
/// * `localpart` - The localpart to check.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable.
async fn is_localpart_available(&self, localpart: &str) -> Result<bool, Self::Error>;
/// Create a device for a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to create a device for.
/// * `device_id` - The device ID to create.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the device could
/// not be created.
async fn create_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error>;
/// Delete a device for a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to delete a device for.
/// * `device_id` - The device ID to delete.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the device could
/// not be deleted.
async fn delete_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error>;
/// Sync the list of devices of a user with the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to sync the devices for.
/// * `devices` - The list of devices to sync.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the devices could
/// not be synced.
async fn sync_devices(&self, mxid: &str, devices: HashSet<String>) -> Result<(), Self::Error>;
/// Delete a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to delete.
/// * `erase` - Whether to ask the homeserver to erase the user's data.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the user could not
/// be deleted.
async fn delete_user(&self, mxid: &str, erase: bool) -> Result<(), Self::Error>;
/// Reactivate a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to reactivate.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the user could not
/// be reactivated.
async fn reactivate_user(&self, mxid: &str) -> Result<(), Self::Error>;
/// Set the displayname of a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to set the displayname for.
/// * `displayname` - The displayname to set.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the displayname
/// could not be set.
async fn set_displayname(&self, mxid: &str, displayname: &str) -> Result<(), Self::Error>;
/// Unset the displayname of a user on the homeserver.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to unset the displayname for.
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the displayname
/// could not be unset.
async fn unset_displayname(&self, mxid: &str) -> Result<(), Self::Error>;
/// Temporarily allow a user to reset their cross-signing keys.
///
/// # Parameters
///
/// * `mxid` - The Matrix ID of the user to allow cross-signing key reset
///
/// # Errors
///
/// Returns an error if the homeserver is unreachable or the cross-signing
/// reset could not be allowed.
async fn allow_cross_signing_reset(&self, mxid: &str) -> Result<(), Self::Error>;
}
#[async_trait::async_trait]
impl<T: HomeserverConnection + Send + Sync + ?Sized> HomeserverConnection for &T {
type Error = T::Error;
fn homeserver(&self) -> &str {
(**self).homeserver()
}
async fn query_user(&self, mxid: &str) -> Result<MatrixUser, Self::Error> {
(**self).query_user(mxid).await
}
async fn provision_user(&self, request: &ProvisionRequest) -> Result<bool, Self::Error> {
(**self).provision_user(request).await
}
async fn is_localpart_available(&self, localpart: &str) -> Result<bool, Self::Error> {
(**self).is_localpart_available(localpart).await
}
async fn create_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error> {
(**self).create_device(mxid, device_id).await
}
async fn delete_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error> {
(**self).delete_device(mxid, device_id).await
}
async fn sync_devices(&self, mxid: &str, devices: HashSet<String>) -> Result<(), Self::Error> {
(**self).sync_devices(mxid, devices).await
}
async fn delete_user(&self, mxid: &str, erase: bool) -> Result<(), Self::Error> {
(**self).delete_user(mxid, erase).await
}
async fn reactivate_user(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).reactivate_user(mxid).await
}
async fn set_displayname(&self, mxid: &str, displayname: &str) -> Result<(), Self::Error> {
(**self).set_displayname(mxid, displayname).await
}
async fn unset_displayname(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).unset_displayname(mxid).await
}
async fn allow_cross_signing_reset(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).allow_cross_signing_reset(mxid).await
}
}
// Implement for Arc<T> where T: HomeserverConnection
#[async_trait::async_trait]
impl<T: HomeserverConnection + ?Sized> HomeserverConnection for Arc<T> {
type Error = T::Error;
fn homeserver(&self) -> &str {
(**self).homeserver()
}
async fn query_user(&self, mxid: &str) -> Result<MatrixUser, Self::Error> {
(**self).query_user(mxid).await
}
async fn provision_user(&self, request: &ProvisionRequest) -> Result<bool, Self::Error> {
(**self).provision_user(request).await
}
async fn is_localpart_available(&self, localpart: &str) -> Result<bool, Self::Error> {
(**self).is_localpart_available(localpart).await
}
async fn create_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error> {
(**self).create_device(mxid, device_id).await
}
async fn delete_device(&self, mxid: &str, device_id: &str) -> Result<(), Self::Error> {
(**self).delete_device(mxid, device_id).await
}
async fn sync_devices(&self, mxid: &str, devices: HashSet<String>) -> Result<(), Self::Error> {
(**self).sync_devices(mxid, devices).await
}
async fn delete_user(&self, mxid: &str, erase: bool) -> Result<(), Self::Error> {
(**self).delete_user(mxid, erase).await
}
async fn reactivate_user(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).reactivate_user(mxid).await
}
async fn set_displayname(&self, mxid: &str, displayname: &str) -> Result<(), Self::Error> {
(**self).set_displayname(mxid, displayname).await
}
async fn unset_displayname(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).unset_displayname(mxid).await
}
async fn allow_cross_signing_reset(&self, mxid: &str) -> Result<(), Self::Error> {
(**self).allow_cross_signing_reset(mxid).await
}
}