tuwunel_api/client/
user_directory.rs

1use axum::extract::State;
2use futures::{FutureExt, StreamExt, pin_mut};
3use ruma::{
4	UserId,
5	api::client::user_directory::search_users::{self},
6	events::room::join_rules::JoinRule,
7};
8use tuwunel_core::{
9	Result,
10	utils::{
11		BoolExt, FutureBoolExt,
12		stream::{BroadbandExt, ReadyExt},
13	},
14};
15use tuwunel_service::Services;
16
17use crate::Ruma;
18
19// Tuwunel can handle a lot more results than synapse
20const LIMIT_MAX: usize = 500;
21const LIMIT_DEFAULT: usize = 10;
22
23/// # `POST /_matrix/client/r0/user_directory/search`
24///
25/// Searches all known users for a match.
26///
27/// - Hides any local users that aren't in any public rooms (i.e. those that
28///   have the join rule set to public) and don't share a room with the sender
29pub(crate) async fn search_users_route(
30	State(services): State<crate::State>,
31	body: Ruma<search_users::v3::Request>,
32) -> Result<search_users::v3::Response> {
33	let sender_user = body.sender_user();
34	let limit = usize::try_from(body.limit)
35		.unwrap_or(LIMIT_DEFAULT)
36		.min(LIMIT_MAX);
37
38	let search_term = body.search_term.to_lowercase();
39	let users = services
40		.users
41		.stream()
42		.ready_filter(|&user_id| user_id != sender_user)
43		.map(ToOwned::to_owned)
44		.broad_filter_map(async |user_id| {
45			let display_name = services.users.displayname(&user_id).await.ok();
46
47			should_show_user(
48				&services,
49				sender_user,
50				&user_id,
51				display_name.as_deref(),
52				&search_term,
53			)
54			.await
55			.then_async(async || search_users::v3::User {
56				user_id: user_id.clone(),
57				display_name,
58				avatar_url: services.users.avatar_url(&user_id).await.ok(),
59			})
60			.await
61		});
62
63	pin_mut!(users);
64	let results = users.by_ref().take(limit).collect().await;
65	let limited = users.next().await.is_some();
66
67	Ok(search_users::v3::Response { results, limited })
68}
69
70async fn should_show_user(
71	services: &Services,
72	sender_user: &UserId,
73	target_user: &UserId,
74	target_display_name: Option<&str>,
75	search_term: &str,
76) -> bool {
77	let user_id_matches = target_user
78		.as_str()
79		.to_lowercase()
80		.contains(search_term);
81
82	let display_name_matches = target_display_name
83		.map(str::to_lowercase)
84		.is_some_and(|display_name| display_name.contains(search_term));
85
86	if !user_id_matches && !display_name_matches {
87		return false;
88	}
89
90	if services
91		.server
92		.config
93		.show_all_local_users_in_user_directory
94	{
95		return true;
96	}
97
98	let user_in_public_room = services
99		.state_cache
100		.rooms_joined(target_user)
101		.map(ToOwned::to_owned)
102		.broad_any(async |room_id| {
103			services
104				.state_accessor
105				.get_join_rules(&room_id)
106				.map(|rule| matches!(rule, JoinRule::Public))
107				.await
108		});
109
110	let user_sees_user = services
111		.state_cache
112		.user_sees_user(sender_user, target_user);
113
114	pin_mut!(user_in_public_room, user_sees_user);
115	user_in_public_room.or(user_sees_user).await
116}
tuwunel_api/client/user_directory.rs

tuwunel_api/client/
user_directory.rs
