-
Notifications
You must be signed in to change notification settings - Fork 5
/
room_handler.rs
360 lines (312 loc) · 14.9 KB
/
room_handler.rs
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
use std::collections::HashMap;
use std::convert::TryFrom;
use diesel::sqlite::SqliteConnection;
use diesel::Connection;
use iron::url::Host;
use ruma_events::room::member::{MemberEvent, MembershipState};
use ruma_identifiers::{RoomId, UserId};
use slog::Logger;
use api::{MatrixApi, RocketchatApi};
use api::rocketchat::Channel;
use config::Config;
use db::{RocketchatServer, Room, User};
use errors::*;
use handlers::ErrorNotifier;
use handlers::rocketchat::VirtualUserHandler;
use i18n::*;
use log;
use serde_json::{self, Value};
use super::CommandHandler;
/// Handles room events
pub struct RoomHandler<'a> {
config: &'a Config,
connection: &'a SqliteConnection,
logger: &'a Logger,
matrix_api: &'a MatrixApi,
}
impl<'a> RoomHandler<'a> {
/// Create a new `RoomHandler`.
pub fn new(
config: &'a Config,
connection: &'a SqliteConnection,
logger: &'a Logger,
matrix_api: &'a MatrixApi,
) -> RoomHandler<'a> {
RoomHandler {
config: config,
connection: connection,
logger: logger,
matrix_api: matrix_api,
}
}
/// Handles room membership changes
pub fn process(&self, event: &MemberEvent) -> Result<()> {
let matrix_bot_user_id = self.config.matrix_bot_user_id()?;
let state_key = UserId::try_from(&event.state_key).chain_err(|| ErrorKind::InvalidUserId(event.state_key.clone()))?;
let addressed_to_matrix_bot = state_key == matrix_bot_user_id;
match event.content.membership {
MembershipState::Invite if addressed_to_matrix_bot => {
let msg = format!("Bot `{}` got invite for room `{}`", matrix_bot_user_id, event.room_id);
debug!(self.logger, msg);
self.handle_bot_invite(event.room_id.clone(), matrix_bot_user_id)?;
}
MembershipState::Join if addressed_to_matrix_bot => {
let msg = format!("Received join event for bot user {} and room {}", matrix_bot_user_id, event.room_id);
debug!(self.logger, msg);
let unsigned: HashMap<String, Value> = serde_json::from_value(event.unsigned.clone().unwrap_or_default())
.unwrap_or_default();
let inviter_id = match unsigned.get("prev_sender") {
Some(prev_sender) => {
let raw_id: String = serde_json::from_value(prev_sender.clone()).unwrap_or_else(|_| "".to_string());
let inviter_id = UserId::try_from(&raw_id).chain_err(|| ErrorKind::InvalidUserId(raw_id))?;
Some(inviter_id)
}
None => None,
};
self.handle_bot_join(event.room_id.clone(), matrix_bot_user_id, inviter_id)?;
}
MembershipState::Join => {
let msg = format!("Received join event for user {} and room {}", &state_key, &event.room_id);
debug!(self.logger, msg);
self.handle_user_join(event.room_id.clone())?;
}
MembershipState::Leave if !addressed_to_matrix_bot => {
let msg = format!("User {} left room {}", event.user_id, event.room_id);
debug!(self.logger, msg);
self.handle_user_leave(event.room_id.clone())?;
}
_ => {
let msg = format!(
"Skipping event, don't know how to handle membership state `{}` with state key `{}`",
event.content.membership,
event.state_key
);
debug!(self.logger, msg);
}
}
Ok(())
}
/// Bridges a new room between Rocket.Chat and Matrix. It creates the room on the Matrix
/// homeserver and manages the rooms virtual users.
pub fn bridge_new_room(
&self,
rocketchat_api: Box<RocketchatApi>,
rocketchat_server: &RocketchatServer,
channel: &Channel,
room_creator_id: UserId,
invited_user_id: UserId,
) -> Result<RoomId> {
debug!(self.logger, "Briding new room, Rocket.Chat channel: {}", channel.name.clone().unwrap_or_default());
let matrix_room_id = self.create_room(
channel.id.clone(),
rocketchat_server.id.clone(),
room_creator_id,
invited_user_id,
channel.name.clone(),
)?;
let matrix_room_alias_id = Room::build_room_alias_id(self.config, &rocketchat_server.id, &channel.id)?;
self.matrix_api.put_canonical_room_alias(matrix_room_id.clone(), Some(matrix_room_alias_id))?;
self.add_virtual_users_to_room(rocketchat_api, channel, rocketchat_server.id.clone(), matrix_room_id.clone())?;
Ok(matrix_room_id)
}
/// Bridges a room that is already bridged (for other users) for a new user.
pub fn bridge_existing_room(
&self,
matrix_room_id: RoomId,
matrix_user_id: UserId,
rocketchat_channel_name: String,
) -> Result<()> {
debug!(self.logger, "Briding existing room, Rocket.Chat channel: {}", rocketchat_channel_name);
if User::is_in_room(self.matrix_api, &matrix_user_id, matrix_room_id.clone())? {
bail_error!(
ErrorKind::RocketchatChannelAlreadyBridged(rocketchat_channel_name.clone()),
t!(["errors", "rocketchat_channel_already_bridged"]).with_vars(vec![("channel_name", rocketchat_channel_name)])
);
}
let bot_matrix_user_id = self.config.matrix_bot_user_id()?;
self.matrix_api.invite(matrix_room_id, matrix_user_id, bot_matrix_user_id)
}
fn handle_bot_invite(&self, matrix_room_id: RoomId, invited_user_id: UserId) -> Result<()> {
if !self.config.accept_remote_invites && self.is_remote_invite(&matrix_room_id)? {
info!(
self.logger,
"Bot was invited by a user from another homeserver ({}). \
Ignoring the invite because remote invites are disabled.",
&matrix_room_id
);
return Ok(());
}
self.matrix_api.join(matrix_room_id, invited_user_id)?;
Ok(())
}
fn handle_bot_join(&self, matrix_room_id: RoomId, matrix_bot_user_id: UserId, inviter_id: Option<UserId>) -> Result<()> {
let is_admin_room = match Room::is_admin_room(self.matrix_api, self.config, matrix_room_id.clone()) {
Ok(is_admin_room) => is_admin_room,
Err(err) => {
warn!(
self.logger,
"Could not determine if the room that the bot user was invited to is an admin room or not, bot is leaving"
);
self.handle_admin_room_setup_error(&err, matrix_room_id, matrix_bot_user_id);
return Err(err);
}
};
if is_admin_room {
self.setup_admin_room(matrix_room_id.clone(), matrix_bot_user_id.clone(), inviter_id)?;
}
// leave direct message room, the bot only joined it to be able to read the room members
if Room::is_direct_message_room(self.matrix_api, matrix_room_id.clone())? {
self.matrix_api.leave_room(matrix_room_id.clone(), matrix_bot_user_id)?;
}
Ok(())
}
fn setup_admin_room(&self, matrix_room_id: RoomId, matrix_bot_user_id: UserId, inviter_id: Option<UserId>) -> Result<()> {
debug!(self.logger, "Setting up a new admin room with id {}", matrix_room_id);
let inviter_id = match inviter_id {
Some(inviter_id) => inviter_id,
None => {
bail_error!(ErrorKind::InviterUnknown(matrix_room_id.clone()), t!(["errors", "inviter_unknown"]));
}
};
if let Err(err) = self.is_admin_room_valid(matrix_room_id.clone(), &inviter_id) {
info!(self.logger, "Admin room {} is not valid, bot will leave and forget the room", matrix_room_id);
self.handle_admin_room_setup_error(&err, matrix_room_id, matrix_bot_user_id);
return Ok(());
}
self.connection.transaction(|| {
let invitation_submitter = User::find_or_create_by_matrix_user_id(self.connection, inviter_id.clone())?;
match CommandHandler::build_help_message(
self.connection,
self.matrix_api,
self.config.as_url.clone(),
matrix_room_id.clone(),
&invitation_submitter,
) {
Ok(body) => {
self.matrix_api.send_text_message_event(matrix_room_id.clone(), matrix_bot_user_id, body)?;
}
Err(err) => {
log::log_info(self.logger, &err);
}
}
let room_name = t!(["defaults", "admin_room_display_name"]).l(&invitation_submitter.language);
if let Err(err) = self.matrix_api.set_room_name(matrix_room_id, room_name) {
log::log_info(self.logger, &err);
}
Ok(())
})
}
fn handle_user_join(&self, matrix_room_id: RoomId) -> Result<()> {
if Room::is_admin_room(self.matrix_api, self.config, matrix_room_id.clone())? &&
!self.is_private_room(matrix_room_id.clone())?
{
info!(self.logger, "Another user join the admin room {}, bot user is leaving", matrix_room_id);
let admin_room_language = self.admin_room_language(matrix_room_id.clone())?;
let body = t!(["errors", "other_user_joined"]).l(&admin_room_language);
let bot_matrix_user_id = self.config.matrix_bot_user_id()?;
self.matrix_api.send_text_message_event(matrix_room_id.clone(), bot_matrix_user_id.clone(), body)?;
self.leave_and_forget_room(matrix_room_id, bot_matrix_user_id)?;
}
Ok(())
}
fn handle_user_leave(&self, matrix_room_id: RoomId) -> Result<()> {
if Room::is_admin_room(self.matrix_api, self.config, matrix_room_id.clone())? {
let bot_matrix_user_id = self.config.matrix_bot_user_id()?;
return self.leave_and_forget_room(matrix_room_id, bot_matrix_user_id);
}
Ok(())
}
fn leave_and_forget_room(&self, matrix_room_id: RoomId, matrix_user_id: UserId) -> Result<()> {
self.matrix_api.leave_room(matrix_room_id.clone(), matrix_user_id)?;
self.matrix_api.forget_room(matrix_room_id)
}
fn admin_room_language(&self, matrix_room_id: RoomId) -> Result<String> {
let user_id = self.matrix_api.get_room_creator(matrix_room_id.clone())?;
let user = User::find(self.connection, &user_id)?;
Ok(user.language.clone())
}
fn is_remote_invite(&self, matrix_room_id: &RoomId) -> Result<bool> {
let hs_hostname =
Host::parse(&self.config.hs_domain).chain_err(|| ErrorKind::InvalidHostname(self.config.hs_domain.clone()))?;
Ok(matrix_room_id.hostname().ne(&hs_hostname))
}
fn is_admin_room_valid(&self, matrix_room_id: RoomId, inviter_id: &UserId) -> Result<()> {
debug!(self.logger, "Validating admin room");
let room_creator_id = self.matrix_api.get_room_creator(matrix_room_id.clone())?;
if inviter_id != &room_creator_id {
let err = ErrorKind::OnlyRoomCreatorCanInviteBotUser(inviter_id.clone(), matrix_room_id.clone(), room_creator_id);
bail_error!(err, t!(["errors", "only_room_creator_can_invite_bot_user"]));
}
if !self.is_private_room(matrix_room_id.clone())? {
bail_error!(ErrorKind::TooManyUsersInAdminRoom(matrix_room_id), t!(["errors", "too_many_members_in_room"]));
}
Ok(())
}
fn is_private_room(&self, matrix_room_id: RoomId) -> Result<bool> {
Ok(Room::user_ids(self.matrix_api, matrix_room_id, None)?.len() <= 2)
}
/// Create a room on the Matrix homeserver with the power levels for a bridged room.
pub fn create_room(
&self,
rocketchat_channel_id: String,
rocketchat_server_id: String,
room_creator_id: UserId,
invited_user_id: UserId,
room_display_name: Option<String>,
) -> Result<RoomId> {
let matrix_room_alias_id = Room::build_room_alias_name(self.config, &rocketchat_server_id, &rocketchat_channel_id);
let matrix_room_id =
self.matrix_api.create_room(room_display_name.clone(), Some(matrix_room_alias_id), &room_creator_id)?;
debug!(self.logger, "Successfully created room, matrix_room_id is {}", &matrix_room_id);
self.matrix_api.set_default_powerlevels(matrix_room_id.clone(), room_creator_id.clone())?;
debug!(self.logger, "Successfully set powerlevels for room {}", &matrix_room_id);
self.matrix_api.invite(matrix_room_id.clone(), invited_user_id.clone(), room_creator_id.clone())?;
debug!(self.logger, "{} successfully invited {} into room {}", &room_creator_id, &invited_user_id, &matrix_room_id);
Ok(matrix_room_id)
}
/// Add all users that are in a Rocket.Chat room to the Matrix room.
pub fn add_virtual_users_to_room(
&self,
rocketchat_api: Box<RocketchatApi>,
channel: &Channel,
rocketchat_server_id: String,
matrix_room_id: RoomId,
) -> Result<()> {
debug!(self.logger, "Starting to add virtual users to room {}", matrix_room_id);
let virtual_user_handler = VirtualUserHandler {
config: self.config,
connection: self.connection,
logger: self.logger,
matrix_api: self.matrix_api,
};
//TODO: Check if a max number of users per channel has to be defined to avoid problems when
//there are several thousand users in a channel.
let bot_matrix_user_id = self.config.matrix_bot_user_id()?;
for username in &channel.usernames {
let rocketchat_user = rocketchat_api.users_info(username)?;
let user_on_rocketchat_server =
virtual_user_handler.find_or_register(rocketchat_server_id.clone(), rocketchat_user.id, username.to_string())?;
virtual_user_handler.add_to_room(
user_on_rocketchat_server.matrix_user_id,
bot_matrix_user_id.clone(),
matrix_room_id.clone(),
)?;
}
debug!(self.logger, "Successfully added {} virtual users to room {}", channel.usernames.len(), matrix_room_id);
Ok(())
}
fn handle_admin_room_setup_error(&self, err: &Error, matrix_room_id: RoomId, matrix_bot_user_id: UserId) {
let error_notifier = ErrorNotifier {
config: self.config,
connection: self.connection,
logger: self.logger,
matrix_api: self.matrix_api,
};
if let Err(err) = error_notifier.send_message_to_user(err, matrix_room_id.clone(), &matrix_bot_user_id) {
log::log_error(self.logger, &err);
}
if let Err(err) = self.leave_and_forget_room(matrix_room_id.clone(), matrix_bot_user_id.clone()) {
log::log_error(self.logger, &err);
}
}
}