Skip to main content

tuwunel_service/admin/
create.rs

1use std::collections::BTreeMap;
2
3use futures::FutureExt;
4use ruma::{
5	RoomId, RoomVersionId,
6	events::room::{
7		canonical_alias::RoomCanonicalAliasEventContent,
8		create::RoomCreateEventContent,
9		guest_access::{GuestAccess, RoomGuestAccessEventContent},
10		history_visibility::{HistoryVisibility, RoomHistoryVisibilityEventContent},
11		join_rules::{JoinRule, RoomJoinRulesEventContent},
12		member::{MembershipState, RoomMemberEventContent},
13		name::RoomNameEventContent,
14		power_levels::RoomPowerLevelsEventContent,
15		preview_url::RoomPreviewUrlsEventContent,
16		topic::{RoomTopicEventContent, TopicContentBlock},
17	},
18};
19use tuwunel_core::Result;
20use tuwunel_matrix::{pdu::PduBuilder, room_version};
21
22use crate::Services;
23
24/// Create the server user.
25///
26/// This should be the first user on the server and created prior to the
27/// admin room.
28pub async fn create_server_user(services: &Services) -> Result {
29	let server_user = services.globals.server_user.as_ref();
30
31	// Create a user for the server
32	services
33		.users
34		.create(server_user, None, None)
35		.await?;
36
37	Ok(())
38}
39
40/// Create the admin room.
41///
42/// Users in this room are considered admins by tuwunel, and the room can be
43/// used to issue admin commands by talking to the server user inside it.
44pub async fn create_admin_room(services: &Services) -> Result {
45	let room_id = RoomId::new_v1(services.globals.server_name());
46	let room_version_id = RoomVersionId::V11;
47
48	let room_version_rules = room_version::rules(&room_version_id)?;
49
50	let _short_id = services
51		.short
52		.get_or_create_shortroomid(&room_id)
53		.await;
54
55	let state_lock = services.state.mutex.lock(&room_id).await;
56
57	// Create a user for the server
58	let server_user = services.globals.server_user.as_ref();
59	if !services.users.exists(server_user).await {
60		create_server_user(services).await?;
61	}
62
63	let create_content = if !room_version_rules
64		.authorization
65		.use_room_create_sender
66	{
67		RoomCreateEventContent::new_v1(server_user.into())
68	} else {
69		RoomCreateEventContent::new_v11()
70	};
71
72	// 1. The room create event
73	services
74		.timeline
75		.build_and_append_pdu(
76			PduBuilder::state(String::new(), &RoomCreateEventContent {
77				federate: services.config.admin.room.federate,
78				predecessor: None,
79				room_version: room_version_id.clone(),
80				..create_content
81			}),
82			server_user,
83			&room_id,
84			&state_lock,
85		)
86		.boxed() // size firewall
87		.await?;
88
89	// 2. Make server user/bot join
90	services
91		.timeline
92		.build_and_append_pdu(
93			PduBuilder::state(
94				String::from(server_user),
95				&RoomMemberEventContent::new(MembershipState::Join),
96			),
97			server_user,
98			&room_id,
99			&state_lock,
100		)
101		.boxed() // size firewall
102		.await?;
103
104	// 3. Power levels
105	let users = BTreeMap::from_iter([(server_user.into(), 69420.into())]);
106
107	services
108		.timeline
109		.build_and_append_pdu(
110			PduBuilder::state(String::new(), &RoomPowerLevelsEventContent {
111				users,
112				..Default::default()
113			}),
114			server_user,
115			&room_id,
116			&state_lock,
117		)
118		.boxed() // size firewall
119		.await?;
120
121	// 4.1 Join Rules
122	services
123		.timeline
124		.build_and_append_pdu(
125			PduBuilder::state(String::new(), &RoomJoinRulesEventContent::new(JoinRule::Invite)),
126			server_user,
127			&room_id,
128			&state_lock,
129		)
130		.boxed() // size firewall
131		.await?;
132
133	// 4.2 History Visibility
134	services
135		.timeline
136		.build_and_append_pdu(
137			PduBuilder::state(
138				String::new(),
139				&RoomHistoryVisibilityEventContent::new(HistoryVisibility::Shared),
140			),
141			server_user,
142			&room_id,
143			&state_lock,
144		)
145		.boxed() // size firewall
146		.await?;
147
148	// 4.3 Guest Access
149	services
150		.timeline
151		.build_and_append_pdu(
152			PduBuilder::state(
153				String::new(),
154				&RoomGuestAccessEventContent::new(GuestAccess::Forbidden),
155			),
156			server_user,
157			&room_id,
158			&state_lock,
159		)
160		.boxed() // size firewall
161		.await?;
162
163	// 5. Events implied by name and topic
164	let room_name = format!("{} Admin Room", services.config.server_name);
165	services
166		.timeline
167		.build_and_append_pdu(
168			PduBuilder::state(String::new(), &RoomNameEventContent::new(room_name)),
169			server_user,
170			&room_id,
171			&state_lock,
172		)
173		.boxed() // size firewall
174		.await?;
175
176	services
177		.timeline
178		.build_and_append_pdu(
179			PduBuilder::state(String::new(), &RoomTopicEventContent {
180				topic_block: TopicContentBlock::default(),
181				topic: format!("Manage {} | Run commands prefixed with `!admin` | Run `!admin -h` for help | Documentation: https://matrix-construct.github.io/tuwunel", services.config.server_name),
182			}),
183			server_user,
184			&room_id,
185			&state_lock,
186		)
187		.boxed() // size firewall
188		.await?;
189
190	// 6. Room alias
191	let alias = &services.admin.admin_alias;
192
193	services
194		.timeline
195		.build_and_append_pdu(
196			PduBuilder::state(String::new(), &RoomCanonicalAliasEventContent {
197				alias: Some(alias.clone()),
198				alt_aliases: Vec::new(),
199			}),
200			server_user,
201			&room_id,
202			&state_lock,
203		)
204		.boxed() // size firewall
205		.await?;
206
207	services.alias.set_alias(alias, &room_id)?;
208
209	// 7. (ad-hoc) Disable room URL previews for everyone by default
210	services
211		.timeline
212		.build_and_append_pdu(
213			PduBuilder::state(String::new(), &RoomPreviewUrlsEventContent { disabled: true }),
214			server_user,
215			&room_id,
216			&state_lock,
217		)
218		.boxed() // size firewall
219		.await?;
220
221	Ok(())
222}