Line data Source code
1 : /*
2 : * Famedly Matrix SDK
3 : * Copyright (C) 2019, 2020, 2021 Famedly GmbH
4 : *
5 : * This program is free software: you can redistribute it and/or modify
6 : * it under the terms of the GNU Affero General Public License as
7 : * published by the Free Software Foundation, either version 3 of the
8 : * License, or (at your option) any later version.
9 : *
10 : * This program is distributed in the hope that it will be useful,
11 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 : * GNU Affero General Public License for more details.
14 : *
15 : * You should have received a copy of the GNU Affero General Public License
16 : * along with this program. If not, see <https://www.gnu.org/licenses/>.
17 : */
18 :
19 : import 'dart:async';
20 : import 'dart:convert';
21 : import 'dart:math';
22 :
23 : import 'package:async/async.dart';
24 : import 'package:collection/collection.dart';
25 : import 'package:html_unescape/html_unescape.dart';
26 :
27 : import 'package:matrix/matrix.dart';
28 : import 'package:matrix/src/models/timeline_chunk.dart';
29 : import 'package:matrix/src/utils/cached_stream_controller.dart';
30 : import 'package:matrix/src/utils/file_send_request_credentials.dart';
31 : import 'package:matrix/src/utils/markdown.dart';
32 : import 'package:matrix/src/utils/marked_unread.dart';
33 : import 'package:matrix/src/utils/space_child.dart';
34 :
35 : /// max PDU size for server to accept the event with some buffer incase the server adds unsigned data f.ex age
36 : /// https://spec.matrix.org/v1.9/client-server-api/#size-limits
37 : const int maxPDUSize = 60000;
38 :
39 : const String messageSendingStatusKey =
40 : 'com.famedly.famedlysdk.message_sending_status';
41 :
42 : const String fileSendingStatusKey =
43 : 'com.famedly.famedlysdk.file_sending_status';
44 :
45 : /// Represents a Matrix room.
46 : class Room {
47 : /// The full qualified Matrix ID for the room in the format '!localid:server.abc'.
48 : final String id;
49 :
50 : /// Membership status of the user for this room.
51 : Membership membership;
52 :
53 : /// The count of unread notifications.
54 : int notificationCount;
55 :
56 : /// The count of highlighted notifications.
57 : int highlightCount;
58 :
59 : /// A token that can be supplied to the from parameter of the rooms/{roomId}/messages endpoint.
60 : String? prev_batch;
61 :
62 : RoomSummary summary;
63 :
64 : /// The room states are a key value store of the key (`type`,`state_key`) => State(event).
65 : /// In a lot of cases the `state_key` might be an empty string. You **should** use the
66 : /// methods `getState()` and `setState()` to interact with the room states.
67 : Map<String, Map<String, StrippedStateEvent>> states = {};
68 :
69 : /// Key-Value store for ephemerals.
70 : Map<String, BasicEvent> ephemerals = {};
71 :
72 : /// Key-Value store for private account data only visible for this user.
73 : Map<String, BasicEvent> roomAccountData = {};
74 :
75 : final _sendingQueue = <Completer>[];
76 :
77 : Timer? _clearTypingIndicatorTimer;
78 :
79 64 : Map<String, dynamic> toJson() => {
80 32 : 'id': id,
81 128 : 'membership': membership.toString().split('.').last,
82 32 : 'highlight_count': highlightCount,
83 32 : 'notification_count': notificationCount,
84 32 : 'prev_batch': prev_batch,
85 64 : 'summary': summary.toJson(),
86 63 : 'last_event': lastEvent?.toJson(),
87 : };
88 :
89 12 : factory Room.fromJson(Map<String, dynamic> json, Client client) {
90 12 : final room = Room(
91 : client: client,
92 12 : id: json['id'],
93 12 : membership: Membership.values.singleWhere(
94 60 : (m) => m.toString() == 'Membership.${json['membership']}',
95 0 : orElse: () => Membership.join,
96 : ),
97 12 : notificationCount: json['notification_count'],
98 12 : highlightCount: json['highlight_count'],
99 12 : prev_batch: json['prev_batch'],
100 36 : summary: RoomSummary.fromJson(Map<String, dynamic>.from(json['summary'])),
101 : );
102 12 : if (json['last_event'] != null) {
103 33 : room.lastEvent = Event.fromJson(json['last_event'], room);
104 : }
105 : return room;
106 : }
107 :
108 : /// Flag if the room is partial, meaning not all state events have been loaded yet
109 : bool partial = true;
110 :
111 : /// Post-loads the room.
112 : /// This load all the missing state events for the room from the database
113 : /// If the room has already been loaded, this does nothing.
114 5 : Future<void> postLoad() async {
115 5 : if (!partial) {
116 : return;
117 : }
118 : final allStates =
119 15 : await client.database?.getUnimportantRoomEventStatesForRoom(
120 15 : client.importantStateEvents.toList(),
121 : this,
122 : );
123 :
124 : if (allStates != null) {
125 8 : for (final state in allStates) {
126 3 : setState(state);
127 : }
128 : }
129 5 : partial = false;
130 : }
131 :
132 : /// Returns the [Event] for the given [typeKey] and optional [stateKey].
133 : /// If no [stateKey] is provided, it defaults to an empty string.
134 : /// This returns either a `StrippedStateEvent` for rooms with membership
135 : /// "invite" or a `User`/`Event`. If you need additional information like
136 : /// the Event ID or originServerTs you need to do a type check like:
137 : /// ```dart
138 : /// if (state is Event) { /*...*/ }
139 : /// ```
140 34 : StrippedStateEvent? getState(String typeKey, [String stateKey = '']) =>
141 102 : states[typeKey]?[stateKey];
142 :
143 : /// Adds the [state] to this room and overwrites a state with the same
144 : /// typeKey/stateKey key pair if there is one.
145 34 : void setState(StrippedStateEvent state) {
146 : // Ignore other non-state events
147 34 : final stateKey = state.stateKey;
148 :
149 : // For non invite rooms this is usually an Event and we should validate
150 : // the room ID:
151 34 : if (state is Event) {
152 34 : final roomId = state.roomId;
153 68 : if (roomId != id) {
154 0 : Logs().wtf('Tried to set state event for wrong room!');
155 0 : assert(roomId == id);
156 : return;
157 : }
158 : }
159 :
160 : if (stateKey == null) {
161 6 : Logs().w(
162 6 : 'Tried to set a non state event with type "${state.type}" as state event for a room',
163 : );
164 3 : assert(stateKey != null);
165 : return;
166 : }
167 :
168 170 : (states[state.type] ??= {})[stateKey] = state;
169 :
170 136 : client.onRoomState.add((roomId: id, state: state));
171 : }
172 :
173 : /// ID of the fully read marker event.
174 3 : String get fullyRead =>
175 10 : roomAccountData['m.fully_read']?.content.tryGet<String>('event_id') ?? '';
176 :
177 : /// If something changes, this callback will be triggered. Will return the
178 : /// room id.
179 : @Deprecated('Use `client.onSync` instead and filter for this room ID')
180 : final CachedStreamController<String> onUpdate = CachedStreamController();
181 :
182 : /// If there is a new session key received, this will be triggered with
183 : /// the session ID.
184 : final CachedStreamController<String> onSessionKeyReceived =
185 : CachedStreamController();
186 :
187 : /// The name of the room if set by a participant.
188 8 : String get name {
189 20 : final n = getState(EventTypes.RoomName)?.content['name'];
190 8 : return (n is String) ? n : '';
191 : }
192 :
193 : /// The pinned events for this room. If there are none this returns an empty
194 : /// list.
195 2 : List<String> get pinnedEventIds {
196 6 : final pinned = getState(EventTypes.RoomPinnedEvents)?.content['pinned'];
197 12 : return pinned is Iterable ? pinned.map((e) => e.toString()).toList() : [];
198 : }
199 :
200 : /// Returns the heroes as `User` objects.
201 : /// This is very useful if you want to make sure that all users are loaded
202 : /// from the database, that you need to correctly calculate the displayname
203 : /// and the avatar of the room.
204 2 : Future<List<User>> loadHeroUsers() async {
205 : // For invite rooms request own user and invitor.
206 4 : if (membership == Membership.invite) {
207 0 : final ownUser = await requestUser(client.userID!, requestProfile: false);
208 0 : if (ownUser != null) await requestUser(ownUser.senderId);
209 : }
210 :
211 4 : var heroes = summary.mHeroes;
212 : if (heroes == null) {
213 0 : final directChatMatrixID = this.directChatMatrixID;
214 : if (directChatMatrixID != null) {
215 0 : heroes = [directChatMatrixID];
216 : }
217 : }
218 :
219 0 : if (heroes == null) return [];
220 :
221 2 : return await Future.wait(
222 2 : heroes.map(
223 2 : (hero) async =>
224 2 : (await requestUser(
225 : hero,
226 : ignoreErrors: true,
227 : )) ??
228 0 : User(hero, room: this),
229 : ),
230 : );
231 : }
232 :
233 : /// Returns a localized displayname for this server. If the room is a groupchat
234 : /// without a name, then it will return the localized version of 'Group with Alice' instead
235 : /// of just 'Alice' to make it different to a direct chat.
236 : /// Empty chats will become the localized version of 'Empty Chat'.
237 : /// Please note, that necessary room members are lazy loaded. To be sure
238 : /// that you have the room members, call and await `Room.loadHeroUsers()`
239 : /// before.
240 : /// This method requires a localization class which implements [MatrixLocalizations]
241 4 : String getLocalizedDisplayname([
242 : MatrixLocalizations i18n = const MatrixDefaultLocalizations(),
243 : ]) {
244 10 : if (name.isNotEmpty) return name;
245 :
246 8 : final canonicalAlias = this.canonicalAlias.localpart;
247 2 : if (canonicalAlias != null && canonicalAlias.isNotEmpty) {
248 : return canonicalAlias;
249 : }
250 :
251 4 : final directChatMatrixID = this.directChatMatrixID;
252 8 : final heroes = summary.mHeroes ?? [];
253 0 : if (directChatMatrixID != null && heroes.isEmpty) {
254 0 : heroes.add(directChatMatrixID);
255 : }
256 4 : if (heroes.isNotEmpty) {
257 : final result = heroes
258 2 : .where(
259 : // removing oneself from the hero list
260 10 : (hero) => hero.isNotEmpty && hero != client.userID,
261 : )
262 2 : .map(
263 4 : (hero) => unsafeGetUserFromMemoryOrFallback(hero)
264 2 : .calcDisplayname(i18n: i18n),
265 : )
266 2 : .join(', ');
267 2 : if (isAbandonedDMRoom) {
268 0 : return i18n.wasDirectChatDisplayName(result);
269 : }
270 :
271 4 : return isDirectChat ? result : i18n.groupWith(result);
272 : }
273 4 : if (membership == Membership.invite) {
274 0 : final ownMember = unsafeGetUserFromMemoryOrFallback(client.userID!);
275 :
276 0 : if (ownMember.senderId != ownMember.stateKey) {
277 0 : return i18n.invitedBy(
278 0 : unsafeGetUserFromMemoryOrFallback(ownMember.senderId)
279 0 : .calcDisplayname(i18n: i18n),
280 : );
281 : }
282 : }
283 4 : if (membership == Membership.leave) {
284 : if (directChatMatrixID != null) {
285 0 : return i18n.wasDirectChatDisplayName(
286 0 : unsafeGetUserFromMemoryOrFallback(directChatMatrixID)
287 0 : .calcDisplayname(i18n: i18n),
288 : );
289 : }
290 : }
291 2 : return i18n.emptyChat;
292 : }
293 :
294 : /// The topic of the room if set by a participant.
295 2 : String get topic {
296 6 : final t = getState(EventTypes.RoomTopic)?.content['topic'];
297 2 : return t is String ? t : '';
298 : }
299 :
300 : /// The avatar of the room if set by a participant.
301 : /// Please note, that necessary room members are lazy loaded. To be sure
302 : /// that you have the room members, call and await `Room.loadHeroUsers()`
303 : /// before.
304 4 : Uri? get avatar {
305 : // Check content of `m.room.avatar`
306 : final avatarUrl =
307 8 : getState(EventTypes.RoomAvatar)?.content.tryGet<String>('url');
308 : if (avatarUrl != null) {
309 2 : return Uri.tryParse(avatarUrl);
310 : }
311 :
312 : // Room has no avatar and is not a direct chat
313 4 : final directChatMatrixID = this.directChatMatrixID;
314 : if (directChatMatrixID != null) {
315 0 : return unsafeGetUserFromMemoryOrFallback(directChatMatrixID).avatarUrl;
316 : }
317 :
318 : return null;
319 : }
320 :
321 : /// The address in the format: #roomname:homeserver.org.
322 5 : String get canonicalAlias {
323 11 : final alias = getState(EventTypes.RoomCanonicalAlias)?.content['alias'];
324 5 : return (alias is String) ? alias : '';
325 : }
326 :
327 : /// Sets the canonical alias. If the [canonicalAlias] is not yet an alias of
328 : /// this room, it will create one.
329 0 : Future<void> setCanonicalAlias(String canonicalAlias) async {
330 0 : final aliases = await client.getLocalAliases(id);
331 0 : if (!aliases.contains(canonicalAlias)) {
332 0 : await client.setRoomAlias(canonicalAlias, id);
333 : }
334 0 : await client.setRoomStateWithKey(id, EventTypes.RoomCanonicalAlias, '', {
335 : 'alias': canonicalAlias,
336 : });
337 : }
338 :
339 : String? _cachedDirectChatMatrixId;
340 :
341 : /// If this room is a direct chat, this is the matrix ID of the user.
342 : /// Returns null otherwise.
343 34 : String? get directChatMatrixID {
344 : // Calculating the directChatMatrixId can be expensive. We cache it and
345 : // validate the cache instead every time.
346 34 : final cache = _cachedDirectChatMatrixId;
347 : if (cache != null) {
348 12 : final roomIds = client.directChats[cache];
349 12 : if (roomIds is List && roomIds.contains(id)) {
350 : return cache;
351 : }
352 : }
353 :
354 68 : if (membership == Membership.invite) {
355 0 : final userID = client.userID;
356 : if (userID == null) return null;
357 0 : final invitation = getState(EventTypes.RoomMember, userID);
358 0 : if (invitation != null && invitation.content['is_direct'] == true) {
359 0 : return _cachedDirectChatMatrixId = invitation.senderId;
360 : }
361 : }
362 :
363 102 : final mxId = client.directChats.entries
364 50 : .firstWhereOrNull((MapEntry<String, dynamic> e) {
365 16 : final roomIds = e.value;
366 48 : return roomIds is List<dynamic> && roomIds.contains(id);
367 8 : })?.key;
368 48 : if (mxId?.isValidMatrixId == true) return _cachedDirectChatMatrixId = mxId;
369 34 : return _cachedDirectChatMatrixId = null;
370 : }
371 :
372 : /// Wheither this is a direct chat or not
373 68 : bool get isDirectChat => directChatMatrixID != null;
374 :
375 : Event? lastEvent;
376 :
377 33 : void setEphemeral(BasicEvent ephemeral) {
378 99 : ephemerals[ephemeral.type] = ephemeral;
379 66 : if (ephemeral.type == 'm.typing') {
380 33 : _clearTypingIndicatorTimer?.cancel();
381 134 : _clearTypingIndicatorTimer = Timer(client.typingIndicatorTimeout, () {
382 4 : ephemerals.remove('m.typing');
383 : });
384 : }
385 : }
386 :
387 : /// Returns a list of all current typing users.
388 1 : List<User> get typingUsers {
389 4 : final typingMxid = ephemerals['m.typing']?.content['user_ids'];
390 1 : return (typingMxid is List)
391 : ? typingMxid
392 1 : .cast<String>()
393 2 : .map(unsafeGetUserFromMemoryOrFallback)
394 1 : .toList()
395 0 : : [];
396 : }
397 :
398 : /// Your current client instance.
399 : final Client client;
400 :
401 36 : Room({
402 : required this.id,
403 : this.membership = Membership.join,
404 : this.notificationCount = 0,
405 : this.highlightCount = 0,
406 : this.prev_batch,
407 : required this.client,
408 : Map<String, BasicEvent>? roomAccountData,
409 : RoomSummary? summary,
410 : this.lastEvent,
411 36 : }) : roomAccountData = roomAccountData ?? <String, BasicEvent>{},
412 : summary = summary ??
413 72 : RoomSummary.fromJson({
414 : 'm.joined_member_count': 0,
415 : 'm.invited_member_count': 0,
416 36 : 'm.heroes': [],
417 : });
418 :
419 : /// The default count of how much events should be requested when requesting the
420 : /// history of this room.
421 : static const int defaultHistoryCount = 30;
422 :
423 : /// Checks if this is an abandoned DM room where the other participant has
424 : /// left the room. This is false when there are still other users in the room
425 : /// or the room is not marked as a DM room.
426 2 : bool get isAbandonedDMRoom {
427 2 : final directChatMatrixID = this.directChatMatrixID;
428 :
429 : if (directChatMatrixID == null) return false;
430 : final dmPartnerMembership =
431 0 : unsafeGetUserFromMemoryOrFallback(directChatMatrixID).membership;
432 0 : return dmPartnerMembership == Membership.leave &&
433 0 : summary.mJoinedMemberCount == 1 &&
434 0 : summary.mInvitedMemberCount == 0;
435 : }
436 :
437 : /// Calculates the displayname. First checks if there is a name, then checks for a canonical alias and
438 : /// then generates a name from the heroes.
439 0 : @Deprecated('Use `getLocalizedDisplayname()` instead')
440 0 : String get displayname => getLocalizedDisplayname();
441 :
442 : /// When was the last event received.
443 33 : DateTime get latestEventReceivedTime =>
444 99 : lastEvent?.originServerTs ?? DateTime.now();
445 :
446 : /// Call the Matrix API to change the name of this room. Returns the event ID of the
447 : /// new m.room.name event.
448 6 : Future<String> setName(String newName) => client.setRoomStateWithKey(
449 2 : id,
450 : EventTypes.RoomName,
451 : '',
452 2 : {'name': newName},
453 : );
454 :
455 : /// Call the Matrix API to change the topic of this room.
456 6 : Future<String> setDescription(String newName) => client.setRoomStateWithKey(
457 2 : id,
458 : EventTypes.RoomTopic,
459 : '',
460 2 : {'topic': newName},
461 : );
462 :
463 : /// Add a tag to the room.
464 6 : Future<void> addTag(String tag, {double? order}) => client.setRoomTag(
465 4 : client.userID!,
466 2 : id,
467 : tag,
468 2 : Tag(
469 : order: order,
470 : ),
471 : );
472 :
473 : /// Removes a tag from the room.
474 6 : Future<void> removeTag(String tag) => client.deleteRoomTag(
475 4 : client.userID!,
476 2 : id,
477 : tag,
478 : );
479 :
480 : // Tag is part of client-to-server-API, so it uses strict parsing.
481 : // For roomAccountData, permissive parsing is more suitable,
482 : // so it is implemented here.
483 33 : static Tag _tryTagFromJson(Object o) {
484 33 : if (o is Map<String, dynamic>) {
485 33 : return Tag(
486 66 : order: o.tryGet<num>('order', TryGet.silent)?.toDouble(),
487 66 : additionalProperties: Map.from(o)..remove('order'),
488 : );
489 : }
490 0 : return Tag();
491 : }
492 :
493 : /// Returns all tags for this room.
494 33 : Map<String, Tag> get tags {
495 132 : final tags = roomAccountData['m.tag']?.content['tags'];
496 :
497 33 : if (tags is Map) {
498 : final parsedTags =
499 132 : tags.map((k, v) => MapEntry<String, Tag>(k, _tryTagFromJson(v)));
500 99 : parsedTags.removeWhere((k, v) => !TagType.isValid(k));
501 : return parsedTags;
502 : }
503 :
504 33 : return {};
505 : }
506 :
507 2 : bool get markedUnread {
508 2 : return MarkedUnread.fromJson(
509 6 : roomAccountData[EventType.markedUnread]?.content ??
510 4 : roomAccountData[EventType.oldMarkedUnread]?.content ??
511 2 : {},
512 2 : ).unread;
513 : }
514 :
515 : /// Checks if the last event has a read marker of the user.
516 : /// Warning: This compares the origin server timestamp which might not map
517 : /// to the real sort order of the timeline.
518 2 : bool get hasNewMessages {
519 2 : final lastEvent = this.lastEvent;
520 :
521 : // There is no known event or the last event is only a state fallback event,
522 : // we assume there is no new messages.
523 : if (lastEvent == null ||
524 8 : !client.roomPreviewLastEvents.contains(lastEvent.type)) {
525 : return false;
526 : }
527 :
528 : // Read marker is on the last event so no new messages.
529 2 : if (lastEvent.receipts
530 2 : .any((receipt) => receipt.user.senderId == client.userID!)) {
531 : return false;
532 : }
533 :
534 : // If the last event is sent, we mark the room as read.
535 8 : if (lastEvent.senderId == client.userID) return false;
536 :
537 : // Get the timestamp of read marker and compare
538 6 : final readAtMilliseconds = receiptState.global.latestOwnReceipt?.ts ?? 0;
539 6 : return readAtMilliseconds < lastEvent.originServerTs.millisecondsSinceEpoch;
540 : }
541 :
542 66 : LatestReceiptState get receiptState => LatestReceiptState.fromJson(
543 68 : roomAccountData[LatestReceiptState.eventType]?.content ??
544 33 : <String, dynamic>{},
545 : );
546 :
547 : /// Returns true if this room is unread. To check if there are new messages
548 : /// in muted rooms, use [hasNewMessages].
549 8 : bool get isUnread => notificationCount > 0 || markedUnread;
550 :
551 : /// Returns true if this room is to be marked as unread. This extends
552 : /// [isUnread] to rooms with [Membership.invite].
553 8 : bool get isUnreadOrInvited => isUnread || membership == Membership.invite;
554 :
555 0 : @Deprecated('Use waitForRoomInSync() instead')
556 0 : Future<SyncUpdate> get waitForSync => waitForRoomInSync();
557 :
558 : /// Wait for the room to appear in join, leave or invited section of the
559 : /// sync.
560 0 : Future<SyncUpdate> waitForRoomInSync() async {
561 0 : return await client.waitForRoomInSync(id);
562 : }
563 :
564 : /// Sets an unread flag manually for this room. This changes the local account
565 : /// data model before syncing it to make sure
566 : /// this works if there is no connection to the homeserver. This does **not**
567 : /// set a read marker!
568 2 : Future<void> markUnread(bool unread) async {
569 4 : final content = MarkedUnread(unread).toJson();
570 2 : await _handleFakeSync(
571 2 : SyncUpdate(
572 : nextBatch: '',
573 2 : rooms: RoomsUpdate(
574 2 : join: {
575 4 : id: JoinedRoomUpdate(
576 2 : accountData: [
577 2 : BasicEvent(
578 : content: content,
579 : type: EventType.markedUnread,
580 : ),
581 : ],
582 : ),
583 : },
584 : ),
585 : ),
586 : );
587 4 : await client.setAccountDataPerRoom(
588 4 : client.userID!,
589 2 : id,
590 : EventType.markedUnread,
591 : content,
592 : );
593 : }
594 :
595 : /// Returns true if this room has a m.favourite tag.
596 99 : bool get isFavourite => tags[TagType.favourite] != null;
597 :
598 : /// Sets the m.favourite tag for this room.
599 2 : Future<void> setFavourite(bool favourite) =>
600 2 : favourite ? addTag(TagType.favourite) : removeTag(TagType.favourite);
601 :
602 : /// Call the Matrix API to change the pinned events of this room.
603 0 : Future<String> setPinnedEvents(List<String> pinnedEventIds) =>
604 0 : client.setRoomStateWithKey(
605 0 : id,
606 : EventTypes.RoomPinnedEvents,
607 : '',
608 0 : {'pinned': pinnedEventIds},
609 : );
610 :
611 : /// returns the resolved mxid for a mention string, or null if none found
612 4 : String? getMention(String mention) => getParticipants()
613 8 : .firstWhereOrNull((u) => u.mentionFragments.contains(mention))
614 2 : ?.id;
615 :
616 : /// Sends a normal text message to this room. Returns the event ID generated
617 : /// by the server for this message.
618 5 : Future<String?> sendTextEvent(
619 : String message, {
620 : String? txid,
621 : Event? inReplyTo,
622 : String? editEventId,
623 : bool parseMarkdown = true,
624 : bool parseCommands = true,
625 : String msgtype = MessageTypes.Text,
626 : String? threadRootEventId,
627 : String? threadLastEventId,
628 : StringBuffer? commandStdout,
629 : }) {
630 : if (parseCommands) {
631 10 : return client.parseAndRunCommand(
632 : this,
633 : message,
634 : inReplyTo: inReplyTo,
635 : editEventId: editEventId,
636 : txid: txid,
637 : threadRootEventId: threadRootEventId,
638 : threadLastEventId: threadLastEventId,
639 : stdout: commandStdout,
640 : );
641 : }
642 5 : final event = <String, dynamic>{
643 : 'msgtype': msgtype,
644 : 'body': message,
645 : };
646 : if (parseMarkdown) {
647 5 : final html = markdown(
648 5 : event['body'],
649 0 : getEmotePacks: () => getImagePacksFlat(ImagePackUsage.emoticon),
650 5 : getMention: getMention,
651 10 : convertLinebreaks: client.convertLinebreaksInFormatting,
652 : );
653 : // if the decoded html is the same as the body, there is no need in sending a formatted message
654 25 : if (HtmlUnescape().convert(html.replaceAll(RegExp(r'<br />\n?'), '\n')) !=
655 5 : event['body']) {
656 3 : event['format'] = 'org.matrix.custom.html';
657 3 : event['formatted_body'] = html;
658 : }
659 : }
660 5 : return sendEvent(
661 : event,
662 : txid: txid,
663 : inReplyTo: inReplyTo,
664 : editEventId: editEventId,
665 : threadRootEventId: threadRootEventId,
666 : threadLastEventId: threadLastEventId,
667 : );
668 : }
669 :
670 : /// Sends a reaction to an event with an [eventId] and the content [key] into a room.
671 : /// Returns the event ID generated by the server for this reaction.
672 3 : Future<String?> sendReaction(String eventId, String key, {String? txid}) {
673 3 : return sendEvent(
674 3 : {
675 3 : 'm.relates_to': {
676 : 'rel_type': RelationshipTypes.reaction,
677 : 'event_id': eventId,
678 : 'key': key,
679 : },
680 : },
681 : type: EventTypes.Reaction,
682 : txid: txid,
683 : );
684 : }
685 :
686 : /// Sends the location with description [body] and geo URI [geoUri] into a room.
687 : /// Returns the event ID generated by the server for this message.
688 2 : Future<String?> sendLocation(String body, String geoUri, {String? txid}) {
689 2 : final event = <String, dynamic>{
690 : 'msgtype': 'm.location',
691 : 'body': body,
692 : 'geo_uri': geoUri,
693 : };
694 2 : return sendEvent(event, txid: txid);
695 : }
696 :
697 : final Map<String, MatrixFile> sendingFilePlaceholders = {};
698 : final Map<String, MatrixImageFile> sendingFileThumbnails = {};
699 :
700 : /// Sends a [file] to this room after uploading it. Returns the mxc uri of
701 : /// the uploaded file. If [waitUntilSent] is true, the future will wait until
702 : /// the message event has received the server. Otherwise the future will only
703 : /// wait until the file has been uploaded.
704 : /// Optionally specify [extraContent] to tack on to the event.
705 : ///
706 : /// In case [file] is a [MatrixImageFile], [thumbnail] is automatically
707 : /// computed unless it is explicitly provided.
708 : /// Set [shrinkImageMaxDimension] to for example `1600` if you want to shrink
709 : /// your image before sending. This is ignored if the File is not a
710 : /// [MatrixImageFile].
711 3 : Future<String?> sendFileEvent(
712 : MatrixFile file, {
713 : String? txid,
714 : Event? inReplyTo,
715 : String? editEventId,
716 : int? shrinkImageMaxDimension,
717 : MatrixImageFile? thumbnail,
718 : Map<String, dynamic>? extraContent,
719 : String? threadRootEventId,
720 : String? threadLastEventId,
721 : }) async {
722 2 : txid ??= client.generateUniqueTransactionId();
723 6 : sendingFilePlaceholders[txid] = file;
724 : if (thumbnail != null) {
725 0 : sendingFileThumbnails[txid] = thumbnail;
726 : }
727 :
728 : // Create a fake Event object as a placeholder for the uploading file:
729 3 : final syncUpdate = SyncUpdate(
730 : nextBatch: '',
731 3 : rooms: RoomsUpdate(
732 3 : join: {
733 6 : id: JoinedRoomUpdate(
734 3 : timeline: TimelineUpdate(
735 3 : events: [
736 3 : MatrixEvent(
737 3 : content: {
738 3 : 'msgtype': file.msgType,
739 3 : 'body': file.name,
740 3 : 'filename': file.name,
741 : },
742 : type: EventTypes.Message,
743 : eventId: txid,
744 6 : senderId: client.userID!,
745 3 : originServerTs: DateTime.now(),
746 3 : unsigned: {
747 6 : messageSendingStatusKey: EventStatus.sending.intValue,
748 3 : 'transaction_id': txid,
749 3 : ...FileSendRequestCredentials(
750 0 : inReplyTo: inReplyTo?.eventId,
751 : editEventId: editEventId,
752 : shrinkImageMaxDimension: shrinkImageMaxDimension,
753 : extraContent: extraContent,
754 3 : ).toJson(),
755 : },
756 : ),
757 : ],
758 : ),
759 : ),
760 : },
761 : ),
762 : );
763 :
764 : MatrixFile uploadFile = file; // ignore: omit_local_variable_types
765 : // computing the thumbnail in case we can
766 3 : if (file is MatrixImageFile &&
767 : (thumbnail == null || shrinkImageMaxDimension != null)) {
768 0 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
769 0 : .unsigned![fileSendingStatusKey] =
770 0 : FileSendingStatus.generatingThumbnail.name;
771 0 : await _handleFakeSync(syncUpdate);
772 0 : thumbnail ??= await file.generateThumbnail(
773 0 : nativeImplementations: client.nativeImplementations,
774 0 : customImageResizer: client.customImageResizer,
775 : );
776 : if (shrinkImageMaxDimension != null) {
777 0 : file = await MatrixImageFile.shrink(
778 0 : bytes: file.bytes,
779 0 : name: file.name,
780 : maxDimension: shrinkImageMaxDimension,
781 0 : customImageResizer: client.customImageResizer,
782 0 : nativeImplementations: client.nativeImplementations,
783 : );
784 : }
785 :
786 0 : if (thumbnail != null && file.size < thumbnail.size) {
787 : thumbnail = null; // in this case, the thumbnail is not usefull
788 : }
789 : }
790 :
791 : // Check media config of the server before sending the file. Stop if the
792 : // Media config is unreachable or the file is bigger than the given maxsize.
793 : try {
794 6 : final mediaConfig = await client.getConfig();
795 3 : final maxMediaSize = mediaConfig.mUploadSize;
796 9 : if (maxMediaSize != null && maxMediaSize < file.bytes.lengthInBytes) {
797 0 : throw FileTooBigMatrixException(file.bytes.lengthInBytes, maxMediaSize);
798 : }
799 : } catch (e) {
800 0 : Logs().d('Config error while sending file', e);
801 0 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
802 0 : .unsigned![messageSendingStatusKey] = EventStatus.error.intValue;
803 0 : await _handleFakeSync(syncUpdate);
804 : rethrow;
805 : }
806 :
807 : MatrixFile? uploadThumbnail =
808 : thumbnail; // ignore: omit_local_variable_types
809 : EncryptedFile? encryptedFile;
810 : EncryptedFile? encryptedThumbnail;
811 3 : if (encrypted && client.fileEncryptionEnabled) {
812 0 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
813 0 : .unsigned![fileSendingStatusKey] = FileSendingStatus.encrypting.name;
814 0 : await _handleFakeSync(syncUpdate);
815 0 : encryptedFile = await file.encrypt();
816 0 : uploadFile = encryptedFile.toMatrixFile();
817 :
818 : if (thumbnail != null) {
819 0 : encryptedThumbnail = await thumbnail.encrypt();
820 0 : uploadThumbnail = encryptedThumbnail.toMatrixFile();
821 : }
822 : }
823 : Uri? uploadResp, thumbnailUploadResp;
824 :
825 12 : final timeoutDate = DateTime.now().add(client.sendTimelineEventTimeout);
826 :
827 21 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
828 9 : .unsigned![fileSendingStatusKey] = FileSendingStatus.uploading.name;
829 : while (uploadResp == null ||
830 : (uploadThumbnail != null && thumbnailUploadResp == null)) {
831 : try {
832 6 : uploadResp = await client.uploadContent(
833 3 : uploadFile.bytes,
834 3 : filename: uploadFile.name,
835 3 : contentType: uploadFile.mimeType,
836 : );
837 : thumbnailUploadResp = uploadThumbnail != null
838 0 : ? await client.uploadContent(
839 0 : uploadThumbnail.bytes,
840 0 : filename: uploadThumbnail.name,
841 0 : contentType: uploadThumbnail.mimeType,
842 : )
843 : : null;
844 0 : } on MatrixException catch (_) {
845 0 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
846 0 : .unsigned![messageSendingStatusKey] = EventStatus.error.intValue;
847 0 : await _handleFakeSync(syncUpdate);
848 : rethrow;
849 : } catch (_) {
850 0 : if (DateTime.now().isAfter(timeoutDate)) {
851 0 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
852 0 : .unsigned![messageSendingStatusKey] = EventStatus.error.intValue;
853 0 : await _handleFakeSync(syncUpdate);
854 : rethrow;
855 : }
856 0 : Logs().v('Send File into room failed. Try again...');
857 0 : await Future.delayed(Duration(seconds: 1));
858 : }
859 : }
860 :
861 : // Send event
862 3 : final content = <String, dynamic>{
863 6 : 'msgtype': file.msgType,
864 6 : 'body': file.name,
865 6 : 'filename': file.name,
866 6 : if (encryptedFile == null) 'url': uploadResp.toString(),
867 : if (encryptedFile != null)
868 0 : 'file': {
869 0 : 'url': uploadResp.toString(),
870 0 : 'mimetype': file.mimeType,
871 : 'v': 'v2',
872 0 : 'key': {
873 : 'alg': 'A256CTR',
874 : 'ext': true,
875 0 : 'k': encryptedFile.k,
876 0 : 'key_ops': ['encrypt', 'decrypt'],
877 : 'kty': 'oct',
878 : },
879 0 : 'iv': encryptedFile.iv,
880 0 : 'hashes': {'sha256': encryptedFile.sha256},
881 : },
882 6 : 'info': {
883 3 : ...file.info,
884 : if (thumbnail != null && encryptedThumbnail == null)
885 0 : 'thumbnail_url': thumbnailUploadResp.toString(),
886 : if (thumbnail != null && encryptedThumbnail != null)
887 0 : 'thumbnail_file': {
888 0 : 'url': thumbnailUploadResp.toString(),
889 0 : 'mimetype': thumbnail.mimeType,
890 : 'v': 'v2',
891 0 : 'key': {
892 : 'alg': 'A256CTR',
893 : 'ext': true,
894 0 : 'k': encryptedThumbnail.k,
895 0 : 'key_ops': ['encrypt', 'decrypt'],
896 : 'kty': 'oct',
897 : },
898 0 : 'iv': encryptedThumbnail.iv,
899 0 : 'hashes': {'sha256': encryptedThumbnail.sha256},
900 : },
901 0 : if (thumbnail != null) 'thumbnail_info': thumbnail.info,
902 0 : if (thumbnail?.blurhash != null &&
903 0 : file is MatrixImageFile &&
904 0 : file.blurhash == null)
905 0 : 'xyz.amorgan.blurhash': thumbnail!.blurhash,
906 : },
907 0 : if (extraContent != null) ...extraContent,
908 : };
909 3 : final eventId = await sendEvent(
910 : content,
911 : txid: txid,
912 : inReplyTo: inReplyTo,
913 : editEventId: editEventId,
914 : threadRootEventId: threadRootEventId,
915 : threadLastEventId: threadLastEventId,
916 : );
917 6 : sendingFilePlaceholders.remove(txid);
918 6 : sendingFileThumbnails.remove(txid);
919 : return eventId;
920 : }
921 :
922 : /// Calculates how secure the communication is. When all devices are blocked or
923 : /// verified, then this returns [EncryptionHealthState.allVerified]. When at
924 : /// least one device is not verified, then it returns
925 : /// [EncryptionHealthState.unverifiedDevices]. Apps should display this health
926 : /// state next to the input text field to inform the user about the current
927 : /// encryption security level.
928 2 : Future<EncryptionHealthState> calcEncryptionHealthState() async {
929 2 : final users = await requestParticipants();
930 2 : users.removeWhere(
931 2 : (u) =>
932 8 : !{Membership.invite, Membership.join}.contains(u.membership) ||
933 8 : !client.userDeviceKeys.containsKey(u.id),
934 : );
935 :
936 2 : if (users.any(
937 2 : (u) =>
938 12 : client.userDeviceKeys[u.id]!.verified != UserVerifiedStatus.verified,
939 : )) {
940 : return EncryptionHealthState.unverifiedDevices;
941 : }
942 :
943 : return EncryptionHealthState.allVerified;
944 : }
945 :
946 9 : Future<String?> _sendContent(
947 : String type,
948 : Map<String, dynamic> content, {
949 : String? txid,
950 : }) async {
951 0 : txid ??= client.generateUniqueTransactionId();
952 :
953 13 : final mustEncrypt = encrypted && client.encryptionEnabled;
954 :
955 : final sendMessageContent = mustEncrypt
956 2 : ? await client.encryption!
957 2 : .encryptGroupMessagePayload(id, content, type: type)
958 : : content;
959 :
960 18 : return await client.sendMessage(
961 9 : id,
962 9 : sendMessageContent.containsKey('ciphertext')
963 : ? EventTypes.Encrypted
964 : : type,
965 : txid,
966 : sendMessageContent,
967 : );
968 : }
969 :
970 3 : String _stripBodyFallback(String body) {
971 3 : if (body.startsWith('> <@')) {
972 : var temp = '';
973 : var inPrefix = true;
974 4 : for (final l in body.split('\n')) {
975 4 : if (inPrefix && (l.isEmpty || l.startsWith('> '))) {
976 : continue;
977 : }
978 :
979 : inPrefix = false;
980 4 : temp += temp.isEmpty ? l : ('\n$l');
981 : }
982 :
983 : return temp;
984 : } else {
985 : return body;
986 : }
987 : }
988 :
989 : /// Sends an event to this room with this json as a content. Returns the
990 : /// event ID generated from the server.
991 : /// It uses list of completer to make sure events are sending in a row.
992 9 : Future<String?> sendEvent(
993 : Map<String, dynamic> content, {
994 : String type = EventTypes.Message,
995 : String? txid,
996 : Event? inReplyTo,
997 : String? editEventId,
998 : String? threadRootEventId,
999 : String? threadLastEventId,
1000 : }) async {
1001 : // Create new transaction id
1002 : final String messageID;
1003 : if (txid == null) {
1004 6 : messageID = client.generateUniqueTransactionId();
1005 : } else {
1006 : messageID = txid;
1007 : }
1008 :
1009 : if (inReplyTo != null) {
1010 : var replyText =
1011 12 : '<${inReplyTo.senderId}> ${_stripBodyFallback(inReplyTo.body)}';
1012 15 : replyText = replyText.split('\n').map((line) => '> $line').join('\n');
1013 3 : content['format'] = 'org.matrix.custom.html';
1014 : // be sure that we strip any previous reply fallbacks
1015 6 : final replyHtml = (inReplyTo.formattedText.isNotEmpty
1016 2 : ? inReplyTo.formattedText
1017 9 : : htmlEscape.convert(inReplyTo.body).replaceAll('\n', '<br>'))
1018 3 : .replaceAll(
1019 3 : RegExp(
1020 : r'<mx-reply>.*</mx-reply>',
1021 : caseSensitive: false,
1022 : multiLine: false,
1023 : dotAll: true,
1024 : ),
1025 : '',
1026 : );
1027 3 : final repliedHtml = content.tryGet<String>('formatted_body') ??
1028 : htmlEscape
1029 6 : .convert(content.tryGet<String>('body') ?? '')
1030 3 : .replaceAll('\n', '<br>');
1031 3 : content['formatted_body'] =
1032 15 : '<mx-reply><blockquote><a href="https://matrix.to/#/${inReplyTo.roomId!}/${inReplyTo.eventId}">In reply to</a> <a href="https://matrix.to/#/${inReplyTo.senderId}">${inReplyTo.senderId}</a><br>$replyHtml</blockquote></mx-reply>$repliedHtml';
1033 : // We escape all @room-mentions here to prevent accidental room pings when an admin
1034 : // replies to a message containing that!
1035 3 : content['body'] =
1036 9 : '${replyText.replaceAll('@room', '@\u200broom')}\n\n${content.tryGet<String>('body') ?? ''}';
1037 6 : content['m.relates_to'] = {
1038 3 : 'm.in_reply_to': {
1039 3 : 'event_id': inReplyTo.eventId,
1040 : },
1041 : };
1042 : }
1043 :
1044 : if (threadRootEventId != null) {
1045 2 : content['m.relates_to'] = {
1046 1 : 'event_id': threadRootEventId,
1047 1 : 'rel_type': RelationshipTypes.thread,
1048 1 : 'is_falling_back': inReplyTo == null,
1049 1 : if (inReplyTo != null) ...{
1050 1 : 'm.in_reply_to': {
1051 1 : 'event_id': inReplyTo.eventId,
1052 : },
1053 1 : } else ...{
1054 : if (threadLastEventId != null)
1055 2 : 'm.in_reply_to': {
1056 : 'event_id': threadLastEventId,
1057 : },
1058 : },
1059 : };
1060 : }
1061 :
1062 : if (editEventId != null) {
1063 2 : final newContent = content.copy();
1064 2 : content['m.new_content'] = newContent;
1065 4 : content['m.relates_to'] = {
1066 : 'event_id': editEventId,
1067 : 'rel_type': RelationshipTypes.edit,
1068 : };
1069 4 : if (content['body'] is String) {
1070 6 : content['body'] = '* ${content['body']}';
1071 : }
1072 4 : if (content['formatted_body'] is String) {
1073 0 : content['formatted_body'] = '* ${content['formatted_body']}';
1074 : }
1075 : }
1076 9 : final sentDate = DateTime.now();
1077 9 : final syncUpdate = SyncUpdate(
1078 : nextBatch: '',
1079 9 : rooms: RoomsUpdate(
1080 9 : join: {
1081 18 : id: JoinedRoomUpdate(
1082 9 : timeline: TimelineUpdate(
1083 9 : events: [
1084 9 : MatrixEvent(
1085 : content: content,
1086 : type: type,
1087 : eventId: messageID,
1088 18 : senderId: client.userID!,
1089 : originServerTs: sentDate,
1090 9 : unsigned: {
1091 9 : messageSendingStatusKey: EventStatus.sending.intValue,
1092 : 'transaction_id': messageID,
1093 : },
1094 : ),
1095 : ],
1096 : ),
1097 : ),
1098 : },
1099 : ),
1100 : );
1101 9 : await _handleFakeSync(syncUpdate);
1102 9 : final completer = Completer();
1103 18 : _sendingQueue.add(completer);
1104 27 : while (_sendingQueue.first != completer) {
1105 0 : await _sendingQueue.first.future;
1106 : }
1107 :
1108 36 : final timeoutDate = DateTime.now().add(client.sendTimelineEventTimeout);
1109 : // Send the text and on success, store and display a *sent* event.
1110 : String? res;
1111 :
1112 : while (res == null) {
1113 : try {
1114 9 : res = await _sendContent(
1115 : type,
1116 : content,
1117 : txid: messageID,
1118 : );
1119 : } catch (e, s) {
1120 4 : if (e is MatrixException &&
1121 4 : e.retryAfterMs != null &&
1122 0 : !DateTime.now()
1123 0 : .add(Duration(milliseconds: e.retryAfterMs!))
1124 0 : .isAfter(timeoutDate)) {
1125 0 : Logs().w(
1126 0 : 'Ratelimited while sending message, waiting for ${e.retryAfterMs}ms',
1127 : );
1128 0 : await Future.delayed(Duration(milliseconds: e.retryAfterMs!));
1129 4 : } else if (e is MatrixException ||
1130 2 : e is EventTooLarge ||
1131 0 : DateTime.now().isAfter(timeoutDate)) {
1132 8 : Logs().w('Problem while sending message', e, s);
1133 28 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
1134 12 : .unsigned![messageSendingStatusKey] = EventStatus.error.intValue;
1135 4 : await _handleFakeSync(syncUpdate);
1136 4 : completer.complete();
1137 8 : _sendingQueue.remove(completer);
1138 4 : if (e is EventTooLarge ||
1139 12 : (e is MatrixException && e.error == MatrixError.M_FORBIDDEN)) {
1140 : rethrow;
1141 : }
1142 : return null;
1143 : } else {
1144 0 : Logs()
1145 0 : .w('Problem while sending message: $e Try again in 1 seconds...');
1146 0 : await Future.delayed(Duration(seconds: 1));
1147 : }
1148 : }
1149 : }
1150 63 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first
1151 27 : .unsigned![messageSendingStatusKey] = EventStatus.sent.intValue;
1152 72 : syncUpdate.rooms!.join!.values.first.timeline!.events!.first.eventId = res;
1153 9 : await _handleFakeSync(syncUpdate);
1154 9 : completer.complete();
1155 18 : _sendingQueue.remove(completer);
1156 :
1157 : return res;
1158 : }
1159 :
1160 : /// Call the Matrix API to join this room if the user is not already a member.
1161 : /// If this room is intended to be a direct chat, the direct chat flag will
1162 : /// automatically be set.
1163 0 : Future<void> join({
1164 : /// In case of the room is not found on the server, the client leaves the
1165 : /// room and rethrows the exception.
1166 : bool leaveIfNotFound = true,
1167 : }) async {
1168 0 : final dmId = directChatMatrixID;
1169 : try {
1170 : // If this is a DM, mark it as a DM first, because otherwise the current member
1171 : // event might be the join event already and there is also a race condition there for SDK users.
1172 0 : if (dmId != null) await addToDirectChat(dmId);
1173 :
1174 : // now join
1175 0 : await client.joinRoomById(id);
1176 0 : } on MatrixException catch (exception) {
1177 0 : if (dmId != null) await removeFromDirectChat();
1178 : if (leaveIfNotFound &&
1179 0 : membership == Membership.invite &&
1180 : // Right now Synapse responses with `M_UNKNOWN` when the room can not
1181 : // be found. This is the case for example when User A invites User B
1182 : // to a direct chat and then User A leaves the chat before User B
1183 : // joined.
1184 : // See: https://github.com/element-hq/synapse/issues/1533
1185 0 : exception.error == MatrixError.M_UNKNOWN) {
1186 0 : await leave();
1187 : }
1188 : rethrow;
1189 : }
1190 : return;
1191 : }
1192 :
1193 : /// Call the Matrix API to leave this room. If this room is set as a direct
1194 : /// chat, this will be removed too.
1195 1 : Future<void> leave() async {
1196 : try {
1197 3 : await client.leaveRoom(id);
1198 0 : } on MatrixException catch (e, s) {
1199 0 : if ([MatrixError.M_NOT_FOUND, MatrixError.M_UNKNOWN].contains(e.error)) {
1200 0 : Logs().w(
1201 : 'Unable to leave room. Deleting manually from database...',
1202 : e,
1203 : s,
1204 : );
1205 0 : await _handleFakeSync(
1206 0 : SyncUpdate(
1207 : nextBatch: '',
1208 0 : rooms: RoomsUpdate(
1209 0 : leave: {
1210 0 : id: LeftRoomUpdate(),
1211 : },
1212 : ),
1213 : ),
1214 : );
1215 : }
1216 : rethrow;
1217 : }
1218 : return;
1219 : }
1220 :
1221 : /// Call the Matrix API to forget this room if you already left it.
1222 0 : Future<void> forget() async {
1223 0 : await client.database?.forgetRoom(id);
1224 0 : await client.forgetRoom(id);
1225 : // Update archived rooms, otherwise an archived room may still be in the
1226 : // list after a forget room call
1227 0 : final roomIndex = client.archivedRooms.indexWhere((r) => r.room.id == id);
1228 0 : if (roomIndex != -1) {
1229 0 : client.archivedRooms.removeAt(roomIndex);
1230 : }
1231 : return;
1232 : }
1233 :
1234 : /// Call the Matrix API to kick a user from this room.
1235 20 : Future<void> kick(String userID) => client.kick(id, userID);
1236 :
1237 : /// Call the Matrix API to ban a user from this room.
1238 20 : Future<void> ban(String userID) => client.ban(id, userID);
1239 :
1240 : /// Call the Matrix API to unban a banned user from this room.
1241 20 : Future<void> unban(String userID) => client.unban(id, userID);
1242 :
1243 : /// Set the power level of the user with the [userID] to the value [power].
1244 : /// Returns the event ID of the new state event. If there is no known
1245 : /// power level event, there might something broken and this returns null.
1246 : /// Please note, that you need to await the power level state from sync before
1247 : /// the changes are actually applied. Especially if you want to set multiple
1248 : /// power levels at once, you need to await each change in the sync, to not
1249 : /// override those.
1250 5 : Future<String> setPower(String userId, int power) async {
1251 : final powerLevelMapCopy =
1252 13 : getState(EventTypes.RoomPowerLevels)?.content.copy() ?? {};
1253 :
1254 5 : var users = powerLevelMapCopy['users'];
1255 :
1256 5 : if (users is! Map<String, Object?>) {
1257 : if (users != null) {
1258 4 : Logs().v(
1259 6 : 'Repairing Power Level "users" has the wrong type "${powerLevelMapCopy['users'].runtimeType}"',
1260 : );
1261 : }
1262 10 : users = powerLevelMapCopy['users'] = <String, Object?>{};
1263 : }
1264 :
1265 5 : users[userId] = power;
1266 :
1267 10 : return await client.setRoomStateWithKey(
1268 5 : id,
1269 : EventTypes.RoomPowerLevels,
1270 : '',
1271 : powerLevelMapCopy,
1272 : );
1273 : }
1274 :
1275 : /// Call the Matrix API to invite a user to this room.
1276 3 : Future<void> invite(
1277 : String userID, {
1278 : String? reason,
1279 : }) =>
1280 6 : client.inviteUser(
1281 3 : id,
1282 : userID,
1283 : reason: reason,
1284 : );
1285 :
1286 : /// Request more previous events from the server. [historyCount] defines how many events should
1287 : /// be received maximum. When the request is answered, [onHistoryReceived] will be triggered **before**
1288 : /// the historical events will be published in the onEvent stream. [filter] allows you to specify a
1289 : /// [StateFilter] object to filter the events, which can include various criteria such as event types
1290 : /// (e.g., [EventTypes.Message]) and other state-related filters. The [StateFilter] object will have
1291 : /// [lazyLoadMembers] set to true by default, but this can be overridden.
1292 : /// Returns the actual count of received timeline events.
1293 3 : Future<int> requestHistory({
1294 : int historyCount = defaultHistoryCount,
1295 : void Function()? onHistoryReceived,
1296 : direction = Direction.b,
1297 : StateFilter? filter,
1298 : }) async {
1299 3 : final prev_batch = this.prev_batch;
1300 :
1301 3 : final storeInDatabase = !isArchived;
1302 :
1303 : // Ensure stateFilter is not null and set lazyLoadMembers to true if not already set
1304 3 : filter ??= StateFilter(lazyLoadMembers: true);
1305 3 : filter.lazyLoadMembers ??= true;
1306 :
1307 : if (prev_batch == null) {
1308 : throw 'Tried to request history without a prev_batch token';
1309 : }
1310 6 : final resp = await client.getRoomEvents(
1311 3 : id,
1312 : direction,
1313 : from: prev_batch,
1314 : limit: historyCount,
1315 6 : filter: jsonEncode(filter.toJson()),
1316 : );
1317 :
1318 2 : if (onHistoryReceived != null) onHistoryReceived();
1319 6 : this.prev_batch = resp.end;
1320 :
1321 3 : Future<void> loadFn() async {
1322 9 : if (!((resp.chunk.isNotEmpty) && resp.end != null)) return;
1323 :
1324 6 : await client.handleSync(
1325 3 : SyncUpdate(
1326 : nextBatch: '',
1327 3 : rooms: RoomsUpdate(
1328 6 : join: membership == Membership.join
1329 1 : ? {
1330 2 : id: JoinedRoomUpdate(
1331 1 : state: resp.state,
1332 1 : timeline: TimelineUpdate(
1333 : limited: false,
1334 1 : events: direction == Direction.b
1335 1 : ? resp.chunk
1336 0 : : resp.chunk.reversed.toList(),
1337 : prevBatch:
1338 2 : direction == Direction.b ? resp.end : resp.start,
1339 : ),
1340 : ),
1341 : }
1342 : : null,
1343 6 : leave: membership != Membership.join
1344 2 : ? {
1345 4 : id: LeftRoomUpdate(
1346 2 : state: resp.state,
1347 2 : timeline: TimelineUpdate(
1348 : limited: false,
1349 2 : events: direction == Direction.b
1350 2 : ? resp.chunk
1351 0 : : resp.chunk.reversed.toList(),
1352 : prevBatch:
1353 4 : direction == Direction.b ? resp.end : resp.start,
1354 : ),
1355 : ),
1356 : }
1357 : : null,
1358 : ),
1359 : ),
1360 : direction: Direction.b,
1361 : );
1362 : }
1363 :
1364 6 : if (client.database != null) {
1365 12 : await client.database?.transaction(() async {
1366 : if (storeInDatabase) {
1367 6 : await client.database?.setRoomPrevBatch(resp.end, id, client);
1368 : }
1369 3 : await loadFn();
1370 : });
1371 : } else {
1372 0 : await loadFn();
1373 : }
1374 :
1375 6 : return resp.chunk.length;
1376 : }
1377 :
1378 : /// Sets this room as a direct chat for this user if not already.
1379 8 : Future<void> addToDirectChat(String userID) async {
1380 16 : final directChats = client.directChats;
1381 16 : if (directChats[userID] is List) {
1382 0 : if (!directChats[userID].contains(id)) {
1383 0 : directChats[userID].add(id);
1384 : } else {
1385 : return;
1386 : } // Is already in direct chats
1387 : } else {
1388 24 : directChats[userID] = [id];
1389 : }
1390 :
1391 16 : await client.setAccountData(
1392 16 : client.userID!,
1393 : 'm.direct',
1394 : directChats,
1395 : );
1396 : return;
1397 : }
1398 :
1399 : /// Removes this room from all direct chat tags.
1400 1 : Future<void> removeFromDirectChat() async {
1401 3 : final directChats = client.directChats.copy();
1402 2 : for (final k in directChats.keys) {
1403 1 : final directChat = directChats[k];
1404 3 : if (directChat is List && directChat.contains(id)) {
1405 2 : directChat.remove(id);
1406 : }
1407 : }
1408 :
1409 4 : directChats.removeWhere((_, v) => v is List && v.isEmpty);
1410 :
1411 3 : if (directChats == client.directChats) {
1412 : return;
1413 : }
1414 :
1415 2 : await client.setAccountData(
1416 2 : client.userID!,
1417 : 'm.direct',
1418 : directChats,
1419 : );
1420 : return;
1421 : }
1422 :
1423 : /// Get the user fully read marker
1424 0 : @Deprecated('Use fullyRead marker')
1425 0 : String? get userFullyReadMarker => fullyRead;
1426 :
1427 2 : bool get isFederated =>
1428 6 : getState(EventTypes.RoomCreate)?.content.tryGet<bool>('m.federate') ??
1429 : true;
1430 :
1431 : /// Sets the position of the read marker for a given room, and optionally the
1432 : /// read receipt's location.
1433 : /// If you set `public` to false, only a private receipt will be sent. A private receipt is always sent if `mRead` is set. If no value is provided, the default from the `client` is used.
1434 : /// You can leave out the `eventId`, which will not update the read marker but just send receipts, but there are few cases where that makes sense.
1435 4 : Future<void> setReadMarker(
1436 : String? eventId, {
1437 : String? mRead,
1438 : bool? public,
1439 : }) async {
1440 8 : await client.setReadMarker(
1441 4 : id,
1442 : mFullyRead: eventId,
1443 8 : mRead: (public ?? client.receiptsPublicByDefault) ? mRead : null,
1444 : // we always send the private receipt, because there is no reason not to.
1445 : mReadPrivate: mRead,
1446 : );
1447 : return;
1448 : }
1449 :
1450 0 : Future<TimelineChunk?> getEventContext(String eventId) async {
1451 0 : final resp = await client.getEventContext(
1452 0 : id, eventId,
1453 : limit: Room.defaultHistoryCount,
1454 : // filter: jsonEncode(StateFilter(lazyLoadMembers: true).toJson()),
1455 : );
1456 :
1457 0 : final events = [
1458 0 : if (resp.eventsAfter != null) ...resp.eventsAfter!.reversed,
1459 0 : if (resp.event != null) resp.event!,
1460 0 : if (resp.eventsBefore != null) ...resp.eventsBefore!,
1461 0 : ].map((e) => Event.fromMatrixEvent(e, this)).toList();
1462 :
1463 : // Try again to decrypt encrypted events but don't update the database.
1464 0 : if (encrypted && client.database != null && client.encryptionEnabled) {
1465 0 : for (var i = 0; i < events.length; i++) {
1466 0 : if (events[i].type == EventTypes.Encrypted &&
1467 0 : events[i].content['can_request_session'] == true) {
1468 0 : events[i] = await client.encryption!.decryptRoomEvent(events[i]);
1469 : }
1470 : }
1471 : }
1472 :
1473 0 : final chunk = TimelineChunk(
1474 0 : nextBatch: resp.end ?? '',
1475 0 : prevBatch: resp.start ?? '',
1476 : events: events,
1477 : );
1478 :
1479 : return chunk;
1480 : }
1481 :
1482 : /// This API updates the marker for the given receipt type to the event ID
1483 : /// specified. In general you want to use `setReadMarker` instead to set private
1484 : /// and public receipt as well as the marker at the same time.
1485 0 : @Deprecated(
1486 : 'Use setReadMarker with mRead set instead. That allows for more control and there are few cases to not send a marker at the same time.',
1487 : )
1488 : Future<void> postReceipt(
1489 : String eventId, {
1490 : ReceiptType type = ReceiptType.mRead,
1491 : }) async {
1492 0 : await client.postReceipt(
1493 0 : id,
1494 : ReceiptType.mRead,
1495 : eventId,
1496 : );
1497 : return;
1498 : }
1499 :
1500 : /// Is the room archived
1501 15 : bool get isArchived => membership == Membership.leave;
1502 :
1503 : /// Creates a timeline from the store. Returns a [Timeline] object. If you
1504 : /// just want to update the whole timeline on every change, use the [onUpdate]
1505 : /// callback. For updating only the parts that have changed, use the
1506 : /// [onChange], [onRemove], [onInsert] and the [onHistoryReceived] callbacks.
1507 : /// This method can also retrieve the timeline at a specific point by setting
1508 : /// the [eventContextId]
1509 4 : Future<Timeline> getTimeline({
1510 : void Function(int index)? onChange,
1511 : void Function(int index)? onRemove,
1512 : void Function(int insertID)? onInsert,
1513 : void Function()? onNewEvent,
1514 : void Function()? onUpdate,
1515 : String? eventContextId,
1516 : }) async {
1517 4 : await postLoad();
1518 :
1519 : List<Event> events;
1520 :
1521 4 : if (!isArchived) {
1522 6 : events = await client.database?.getEventList(
1523 : this,
1524 : limit: defaultHistoryCount,
1525 : ) ??
1526 0 : <Event>[];
1527 : } else {
1528 6 : final archive = client.getArchiveRoomFromCache(id);
1529 6 : events = archive?.timeline.events.toList() ?? [];
1530 6 : for (var i = 0; i < events.length; i++) {
1531 : // Try to decrypt encrypted events but don't update the database.
1532 2 : if (encrypted && client.encryptionEnabled) {
1533 0 : if (events[i].type == EventTypes.Encrypted) {
1534 0 : events[i] = await client.encryption!.decryptRoomEvent(events[i]);
1535 : }
1536 : }
1537 : }
1538 : }
1539 :
1540 4 : var chunk = TimelineChunk(events: events);
1541 : // Load the timeline arround eventContextId if set
1542 : if (eventContextId != null) {
1543 0 : if (!events.any((Event event) => event.eventId == eventContextId)) {
1544 : chunk =
1545 0 : await getEventContext(eventContextId) ?? TimelineChunk(events: []);
1546 : }
1547 : }
1548 :
1549 4 : final timeline = Timeline(
1550 : room: this,
1551 : chunk: chunk,
1552 : onChange: onChange,
1553 : onRemove: onRemove,
1554 : onInsert: onInsert,
1555 : onNewEvent: onNewEvent,
1556 : onUpdate: onUpdate,
1557 : );
1558 :
1559 : // Fetch all users from database we have got here.
1560 : if (eventContextId == null) {
1561 16 : final userIds = events.map((event) => event.senderId).toSet();
1562 8 : for (final userId in userIds) {
1563 4 : if (getState(EventTypes.RoomMember, userId) != null) continue;
1564 12 : final dbUser = await client.database?.getUser(userId, this);
1565 0 : if (dbUser != null) setState(dbUser);
1566 : }
1567 : }
1568 :
1569 : // Try again to decrypt encrypted events and update the database.
1570 4 : if (encrypted && client.encryptionEnabled) {
1571 : // decrypt messages
1572 0 : for (var i = 0; i < chunk.events.length; i++) {
1573 0 : if (chunk.events[i].type == EventTypes.Encrypted) {
1574 : if (eventContextId != null) {
1575 : // for the fragmented timeline, we don't cache the decrypted
1576 : //message in the database
1577 0 : chunk.events[i] = await client.encryption!.decryptRoomEvent(
1578 0 : chunk.events[i],
1579 : );
1580 0 : } else if (client.database != null) {
1581 : // else, we need the database
1582 0 : await client.database?.transaction(() async {
1583 0 : for (var i = 0; i < chunk.events.length; i++) {
1584 0 : if (chunk.events[i].content['can_request_session'] == true) {
1585 0 : chunk.events[i] = await client.encryption!.decryptRoomEvent(
1586 0 : chunk.events[i],
1587 0 : store: !isArchived,
1588 : updateType: EventUpdateType.history,
1589 : );
1590 : }
1591 : }
1592 : });
1593 : }
1594 : }
1595 : }
1596 : }
1597 :
1598 : return timeline;
1599 : }
1600 :
1601 : /// Returns all participants for this room. With lazy loading this
1602 : /// list may not be complete. Use [requestParticipants] in this
1603 : /// case.
1604 : /// List `membershipFilter` defines with what membership do you want the
1605 : /// participants, default set to
1606 : /// [[Membership.join, Membership.invite, Membership.knock]]
1607 33 : List<User> getParticipants([
1608 : List<Membership> membershipFilter = const [
1609 : Membership.join,
1610 : Membership.invite,
1611 : Membership.knock,
1612 : ],
1613 : ]) {
1614 66 : final members = states[EventTypes.RoomMember];
1615 : if (members != null) {
1616 33 : return members.entries
1617 165 : .where((entry) => entry.value.type == EventTypes.RoomMember)
1618 132 : .map((entry) => entry.value.asUser(this))
1619 132 : .where((user) => membershipFilter.contains(user.membership))
1620 33 : .toList();
1621 : }
1622 6 : return <User>[];
1623 : }
1624 :
1625 : /// Request the full list of participants from the server. The local list
1626 : /// from the store is not complete if the client uses lazy loading.
1627 : /// List `membershipFilter` defines with what membership do you want the
1628 : /// participants, default set to
1629 : /// [[Membership.join, Membership.invite, Membership.knock]]
1630 : /// Set [cache] to `false` if you do not want to cache the users in memory
1631 : /// for this session which is highly recommended for large public rooms.
1632 : /// By default users are only cached in encrypted rooms as encrypted rooms
1633 : /// need a full member list.
1634 31 : Future<List<User>> requestParticipants([
1635 : List<Membership> membershipFilter = const [
1636 : Membership.join,
1637 : Membership.invite,
1638 : Membership.knock,
1639 : ],
1640 : bool suppressWarning = false,
1641 : bool? cache,
1642 : ]) async {
1643 62 : if (!participantListComplete || partial) {
1644 : // we aren't fully loaded, maybe the users are in the database
1645 : // We always need to check the database in the partial case, since state
1646 : // events won't get written to memory in this case and someone new could
1647 : // have joined, while someone else left, which might lead to the same
1648 : // count in the completeness check.
1649 94 : final users = await client.database?.getUsers(this) ?? [];
1650 34 : for (final user in users) {
1651 3 : setState(user);
1652 : }
1653 : }
1654 :
1655 : // Do not request users from the server if we have already have a complete list locally.
1656 31 : if (participantListComplete) {
1657 31 : return getParticipants(membershipFilter);
1658 : }
1659 :
1660 3 : cache ??= encrypted;
1661 :
1662 6 : final memberCount = summary.mJoinedMemberCount;
1663 3 : if (!suppressWarning && cache && memberCount != null && memberCount > 100) {
1664 0 : Logs().w('''
1665 0 : Loading a list of $memberCount participants for the room $id.
1666 : This may affect the performance. Please make sure to not unnecessary
1667 : request so many participants or suppress this warning.
1668 0 : ''');
1669 : }
1670 :
1671 9 : final matrixEvents = await client.getMembersByRoom(id);
1672 : final users = matrixEvents
1673 12 : ?.map((e) => Event.fromMatrixEvent(e, this).asUser)
1674 3 : .toList() ??
1675 0 : [];
1676 :
1677 : if (cache) {
1678 6 : for (final user in users) {
1679 3 : setState(user); // at *least* cache this in-memory
1680 9 : await client.database?.storeEventUpdate(
1681 3 : id,
1682 : user,
1683 : EventUpdateType.state,
1684 3 : client,
1685 : );
1686 : }
1687 : }
1688 :
1689 12 : users.removeWhere((u) => !membershipFilter.contains(u.membership));
1690 : return users;
1691 : }
1692 :
1693 : /// Checks if the local participant list of joined and invited users is complete.
1694 31 : bool get participantListComplete {
1695 31 : final knownParticipants = getParticipants();
1696 : final joinedCount =
1697 155 : knownParticipants.where((u) => u.membership == Membership.join).length;
1698 : final invitedCount = knownParticipants
1699 124 : .where((u) => u.membership == Membership.invite)
1700 31 : .length;
1701 :
1702 93 : return (summary.mJoinedMemberCount ?? 0) == joinedCount &&
1703 93 : (summary.mInvitedMemberCount ?? 0) == invitedCount;
1704 : }
1705 :
1706 0 : @Deprecated(
1707 : 'The method was renamed unsafeGetUserFromMemoryOrFallback. Please prefer requestParticipants.',
1708 : )
1709 : User getUserByMXIDSync(String mxID) {
1710 0 : return unsafeGetUserFromMemoryOrFallback(mxID);
1711 : }
1712 :
1713 : /// Returns the [User] object for the given [mxID] or return
1714 : /// a fallback [User] and start a request to get the user
1715 : /// from the homeserver.
1716 8 : User unsafeGetUserFromMemoryOrFallback(String mxID) {
1717 8 : final user = getState(EventTypes.RoomMember, mxID);
1718 : if (user != null) {
1719 6 : return user.asUser(this);
1720 : } else {
1721 5 : if (mxID.isValidMatrixId) {
1722 : // ignore: discarded_futures
1723 5 : requestUser(
1724 : mxID,
1725 : ignoreErrors: true,
1726 : );
1727 : }
1728 5 : return User(mxID, room: this);
1729 : }
1730 : }
1731 :
1732 : // Internal helper to implement requestUser
1733 8 : Future<User?> _requestSingleParticipantViaState(
1734 : String mxID, {
1735 : required bool ignoreErrors,
1736 : }) async {
1737 : try {
1738 32 : Logs().v('Request missing user $mxID in room $id from the server...');
1739 16 : final resp = await client.getRoomStateWithKey(
1740 8 : id,
1741 : EventTypes.RoomMember,
1742 : mxID,
1743 : );
1744 :
1745 : // valid member events require a valid membership key
1746 6 : final membership = resp.tryGet<String>('membership', TryGet.required);
1747 6 : assert(membership != null);
1748 :
1749 6 : final foundUser = User(
1750 : mxID,
1751 : room: this,
1752 6 : displayName: resp.tryGet<String>('displayname', TryGet.silent),
1753 6 : avatarUrl: resp.tryGet<String>('avatar_url', TryGet.silent),
1754 : membership: membership,
1755 : );
1756 :
1757 : // Store user in database:
1758 24 : await client.database?.transaction(() async {
1759 18 : await client.database?.storeEventUpdate(
1760 6 : id,
1761 : foundUser,
1762 : EventUpdateType.state,
1763 6 : client,
1764 : );
1765 : });
1766 :
1767 : return foundUser;
1768 5 : } on MatrixException catch (_) {
1769 : // Ignore if we have no permission
1770 : return null;
1771 : } catch (e, s) {
1772 : if (!ignoreErrors) {
1773 : rethrow;
1774 : } else {
1775 6 : Logs().w('Unable to request the user $mxID from the server', e, s);
1776 : return null;
1777 : }
1778 : }
1779 : }
1780 :
1781 : // Internal helper to implement requestUser
1782 9 : Future<User?> _requestUser(
1783 : String mxID, {
1784 : required bool ignoreErrors,
1785 : required bool requestState,
1786 : required bool requestProfile,
1787 : }) async {
1788 : // Is user already in cache?
1789 :
1790 : // If not in cache, try the database
1791 12 : User? foundUser = getState(EventTypes.RoomMember, mxID)?.asUser(this);
1792 :
1793 : // If the room is not postloaded, check the database
1794 9 : if (partial && foundUser == null) {
1795 16 : foundUser = await client.database?.getUser(mxID, this);
1796 : }
1797 :
1798 : // If not in the database, try fetching the member from the server
1799 : if (requestState && foundUser == null) {
1800 8 : foundUser = await _requestSingleParticipantViaState(
1801 : mxID,
1802 : ignoreErrors: ignoreErrors,
1803 : );
1804 : }
1805 :
1806 : // If the user isn't found or they have left and no displayname set anymore, request their profile from the server
1807 : if (requestProfile) {
1808 : if (foundUser
1809 : case null ||
1810 : User(
1811 14 : membership: Membership.ban || Membership.leave,
1812 6 : displayName: null
1813 : )) {
1814 : try {
1815 10 : final profile = await client.getUserProfile(mxID);
1816 2 : foundUser = User(
1817 : mxID,
1818 2 : displayName: profile.displayname,
1819 4 : avatarUrl: profile.avatarUrl?.toString(),
1820 6 : membership: foundUser?.membership.name ?? Membership.leave.name,
1821 : room: this,
1822 : );
1823 : } catch (e, s) {
1824 : if (!ignoreErrors) {
1825 : rethrow;
1826 : } else {
1827 2 : Logs()
1828 4 : .w('Unable to request the profile $mxID from the server', e, s);
1829 : }
1830 : }
1831 : }
1832 : }
1833 :
1834 : if (foundUser == null) return null;
1835 : // make sure we didn't actually store anything by the time we did those requests
1836 : final userFromCurrentState =
1837 10 : getState(EventTypes.RoomMember, mxID)?.asUser(this);
1838 :
1839 : // Set user in the local state if the state changed.
1840 : // If we set the state unconditionally, we might end up with a client calling this over and over thinking the user changed.
1841 : if (userFromCurrentState == null ||
1842 9 : userFromCurrentState.displayName != foundUser.displayName) {
1843 6 : setState(foundUser);
1844 : // ignore: deprecated_member_use_from_same_package
1845 18 : onUpdate.add(id);
1846 : }
1847 :
1848 : return foundUser;
1849 : }
1850 :
1851 : final Map<
1852 : ({
1853 : String mxID,
1854 : bool ignoreErrors,
1855 : bool requestState,
1856 : bool requestProfile,
1857 : }),
1858 : AsyncCache<User?>> _inflightUserRequests = {};
1859 :
1860 : /// Requests a missing [User] for this room. Important for clients using
1861 : /// lazy loading. If the user can't be found this method tries to fetch
1862 : /// the displayname and avatar from the server if [requestState] is true.
1863 : /// If that fails, it falls back to requesting the global profile if
1864 : /// [requestProfile] is true.
1865 9 : Future<User?> requestUser(
1866 : String mxID, {
1867 : bool ignoreErrors = false,
1868 : bool requestState = true,
1869 : bool requestProfile = true,
1870 : }) async {
1871 18 : assert(mxID.isValidMatrixId);
1872 :
1873 : final parameters = (
1874 : mxID: mxID,
1875 : ignoreErrors: ignoreErrors,
1876 : requestState: requestState,
1877 : requestProfile: requestProfile,
1878 : );
1879 :
1880 27 : final cache = _inflightUserRequests[parameters] ??= AsyncCache.ephemeral();
1881 :
1882 : try {
1883 9 : final user = await cache.fetch(
1884 18 : () => _requestUser(
1885 : mxID,
1886 : ignoreErrors: ignoreErrors,
1887 : requestState: requestState,
1888 : requestProfile: requestProfile,
1889 : ),
1890 : );
1891 18 : _inflightUserRequests.remove(parameters);
1892 : return user;
1893 : } catch (_) {
1894 2 : _inflightUserRequests.remove(parameters);
1895 : rethrow;
1896 : }
1897 : }
1898 :
1899 : /// Searches for the event in the local cache and then on the server if not
1900 : /// found. Returns null if not found anywhere.
1901 4 : Future<Event?> getEventById(String eventID) async {
1902 : try {
1903 12 : final dbEvent = await client.database?.getEventById(eventID, this);
1904 : if (dbEvent != null) return dbEvent;
1905 12 : final matrixEvent = await client.getOneRoomEvent(id, eventID);
1906 4 : final event = Event.fromMatrixEvent(matrixEvent, this);
1907 12 : if (event.type == EventTypes.Encrypted && client.encryptionEnabled) {
1908 : // attempt decryption
1909 6 : return await client.encryption?.decryptRoomEvent(event);
1910 : }
1911 : return event;
1912 2 : } on MatrixException catch (err) {
1913 4 : if (err.errcode == 'M_NOT_FOUND') {
1914 : return null;
1915 : }
1916 : rethrow;
1917 : }
1918 : }
1919 :
1920 : /// Returns the power level of the given user ID.
1921 : /// If a user_id is in the users list, then that user_id has the associated
1922 : /// power level. Otherwise they have the default level users_default.
1923 : /// If users_default is not supplied, it is assumed to be 0. If the room
1924 : /// contains no m.room.power_levels event, the room’s creator has a power
1925 : /// level of 100, and all other users have a power level of 0.
1926 8 : int getPowerLevelByUserId(String userId) {
1927 14 : final powerLevelMap = getState(EventTypes.RoomPowerLevels)?.content;
1928 :
1929 : final userSpecificPowerLevel =
1930 12 : powerLevelMap?.tryGetMap<String, Object?>('users')?.tryGet<int>(userId);
1931 :
1932 6 : final defaultUserPowerLevel = powerLevelMap?.tryGet<int>('users_default');
1933 :
1934 : final fallbackPowerLevel =
1935 18 : getState(EventTypes.RoomCreate)?.senderId == userId ? 100 : 0;
1936 :
1937 : return userSpecificPowerLevel ??
1938 : defaultUserPowerLevel ??
1939 : fallbackPowerLevel;
1940 : }
1941 :
1942 : /// Returns the user's own power level.
1943 24 : int get ownPowerLevel => getPowerLevelByUserId(client.userID!);
1944 :
1945 : /// Returns the power levels from all users for this room or null if not given.
1946 0 : @Deprecated('Use `getPowerLevelByUserId(String userId)` instead')
1947 : Map<String, int>? get powerLevels {
1948 : final powerLevelState =
1949 0 : getState(EventTypes.RoomPowerLevels)?.content['users'];
1950 0 : return (powerLevelState is Map<String, int>) ? powerLevelState : null;
1951 : }
1952 :
1953 : /// Uploads a new user avatar for this room. Returns the event ID of the new
1954 : /// m.room.avatar event. Leave empty to remove the current avatar.
1955 2 : Future<String> setAvatar(MatrixFile? file) async {
1956 : final uploadResp = file == null
1957 : ? null
1958 8 : : await client.uploadContent(file.bytes, filename: file.name);
1959 4 : return await client.setRoomStateWithKey(
1960 2 : id,
1961 : EventTypes.RoomAvatar,
1962 : '',
1963 2 : {
1964 4 : if (uploadResp != null) 'url': uploadResp.toString(),
1965 : },
1966 : );
1967 : }
1968 :
1969 : /// The level required to ban a user.
1970 4 : bool get canBan =>
1971 8 : (getState(EventTypes.RoomPowerLevels)?.content.tryGet<int>('ban') ??
1972 4 : 50) <=
1973 4 : ownPowerLevel;
1974 :
1975 : /// returns if user can change a particular state event by comparing `ownPowerLevel`
1976 : /// with possible overrides in `events`, if not present compares `ownPowerLevel`
1977 : /// with state_default
1978 6 : bool canChangeStateEvent(String action) {
1979 18 : return powerForChangingStateEvent(action) <= ownPowerLevel;
1980 : }
1981 :
1982 : /// returns the powerlevel required for changing the `action` defaults to
1983 : /// state_default if `action` isn't specified in events override.
1984 : /// If there is no state_default in the m.room.power_levels event, the
1985 : /// state_default is 50. If the room contains no m.room.power_levels event,
1986 : /// the state_default is 0.
1987 6 : int powerForChangingStateEvent(String action) {
1988 10 : final powerLevelMap = getState(EventTypes.RoomPowerLevels)?.content;
1989 : if (powerLevelMap == null) return 0;
1990 : return powerLevelMap
1991 4 : .tryGetMap<String, Object?>('events')
1992 4 : ?.tryGet<int>(action) ??
1993 4 : powerLevelMap.tryGet<int>('state_default') ??
1994 : 50;
1995 : }
1996 :
1997 : /// if returned value is not null `EventTypes.GroupCallMember` is present
1998 : /// and group calls can be used
1999 2 : bool get groupCallsEnabledForEveryone {
2000 4 : final powerLevelMap = getState(EventTypes.RoomPowerLevels)?.content;
2001 : if (powerLevelMap == null) return false;
2002 4 : return powerForChangingStateEvent(EventTypes.GroupCallMember) <=
2003 2 : getDefaultPowerLevel(powerLevelMap);
2004 : }
2005 :
2006 4 : bool get canJoinGroupCall => canChangeStateEvent(EventTypes.GroupCallMember);
2007 :
2008 : /// sets the `EventTypes.GroupCallMember` power level to users default for
2009 : /// group calls, needs permissions to change power levels
2010 2 : Future<void> enableGroupCalls() async {
2011 2 : if (!canChangePowerLevel) return;
2012 4 : final currentPowerLevelsMap = getState(EventTypes.RoomPowerLevels)?.content;
2013 : if (currentPowerLevelsMap != null) {
2014 : final newPowerLevelMap = currentPowerLevelsMap;
2015 2 : final eventsMap = newPowerLevelMap.tryGetMap<String, Object?>('events') ??
2016 2 : <String, Object?>{};
2017 4 : eventsMap.addAll({
2018 2 : EventTypes.GroupCallMember: getDefaultPowerLevel(currentPowerLevelsMap),
2019 : });
2020 4 : newPowerLevelMap.addAll({'events': eventsMap});
2021 4 : await client.setRoomStateWithKey(
2022 2 : id,
2023 : EventTypes.RoomPowerLevels,
2024 : '',
2025 : newPowerLevelMap,
2026 : );
2027 : }
2028 : }
2029 :
2030 : /// Takes in `[m.room.power_levels].content` and returns the default power level
2031 2 : int getDefaultPowerLevel(Map<String, dynamic> powerLevelMap) {
2032 2 : return powerLevelMap.tryGet('users_default') ?? 0;
2033 : }
2034 :
2035 : /// The default level required to send message events. This checks if the
2036 : /// user is capable of sending `m.room.message` events.
2037 : /// Please be aware that this also returns false
2038 : /// if the room is encrypted but the client is not able to use encryption.
2039 : /// If you do not want this check or want to check other events like
2040 : /// `m.sticker` use `canSendEvent('<event-type>')`.
2041 2 : bool get canSendDefaultMessages {
2042 2 : if (encrypted && !client.encryptionEnabled) return false;
2043 :
2044 4 : return canSendEvent(encrypted ? EventTypes.Encrypted : EventTypes.Message);
2045 : }
2046 :
2047 : /// The level required to invite a user.
2048 2 : bool get canInvite =>
2049 6 : (getState(EventTypes.RoomPowerLevels)?.content.tryGet<int>('invite') ??
2050 2 : 0) <=
2051 2 : ownPowerLevel;
2052 :
2053 : /// The level required to kick a user.
2054 4 : bool get canKick =>
2055 8 : (getState(EventTypes.RoomPowerLevels)?.content.tryGet<int>('kick') ??
2056 4 : 50) <=
2057 4 : ownPowerLevel;
2058 :
2059 : /// The level required to redact an event.
2060 2 : bool get canRedact =>
2061 6 : (getState(EventTypes.RoomPowerLevels)?.content.tryGet<int>('redact') ??
2062 2 : 50) <=
2063 2 : ownPowerLevel;
2064 :
2065 : /// The default level required to send state events. Can be overridden by the events key.
2066 0 : bool get canSendDefaultStates {
2067 0 : final powerLevelsMap = getState(EventTypes.RoomPowerLevels)?.content;
2068 0 : if (powerLevelsMap == null) return 0 <= ownPowerLevel;
2069 0 : return (getState(EventTypes.RoomPowerLevels)
2070 0 : ?.content
2071 0 : .tryGet<int>('state_default') ??
2072 0 : 50) <=
2073 0 : ownPowerLevel;
2074 : }
2075 :
2076 6 : bool get canChangePowerLevel =>
2077 6 : canChangeStateEvent(EventTypes.RoomPowerLevels);
2078 :
2079 : /// The level required to send a certain event. Defaults to 0 if there is no
2080 : /// events_default set or there is no power level state in the room.
2081 2 : bool canSendEvent(String eventType) {
2082 4 : final powerLevelsMap = getState(EventTypes.RoomPowerLevels)?.content;
2083 :
2084 : final pl = powerLevelsMap
2085 2 : ?.tryGetMap<String, Object?>('events')
2086 2 : ?.tryGet<int>(eventType) ??
2087 2 : powerLevelsMap?.tryGet<int>('events_default') ??
2088 : 0;
2089 :
2090 4 : return ownPowerLevel >= pl;
2091 : }
2092 :
2093 : /// The power level requirements for specific notification types.
2094 2 : bool canSendNotification(String userid, {String notificationType = 'room'}) {
2095 2 : final userLevel = getPowerLevelByUserId(userid);
2096 2 : final notificationLevel = getState(EventTypes.RoomPowerLevels)
2097 2 : ?.content
2098 2 : .tryGetMap<String, Object?>('notifications')
2099 2 : ?.tryGet<int>(notificationType) ??
2100 : 50;
2101 :
2102 2 : return userLevel >= notificationLevel;
2103 : }
2104 :
2105 : /// Returns the [PushRuleState] for this room, based on the m.push_rules stored in
2106 : /// the account_data.
2107 2 : PushRuleState get pushRuleState {
2108 4 : final globalPushRules = client.globalPushRules;
2109 : if (globalPushRules == null) {
2110 : // We have no push rules specified at all so we fallback to just notify:
2111 : return PushRuleState.notify;
2112 : }
2113 :
2114 2 : final overridePushRules = globalPushRules.override;
2115 : if (overridePushRules != null) {
2116 4 : for (final pushRule in overridePushRules) {
2117 6 : if (pushRule.ruleId == id) {
2118 : // "dont_notify" and "coalesce" should be ignored in actions since
2119 : // https://spec.matrix.org/v1.7/client-server-api/#actions
2120 2 : pushRule.actions
2121 2 : ..remove('dont_notify')
2122 2 : ..remove('coalesce');
2123 4 : if (pushRule.actions.isEmpty) {
2124 : return PushRuleState.dontNotify;
2125 : }
2126 : break;
2127 : }
2128 : }
2129 : }
2130 :
2131 2 : final roomPushRules = globalPushRules.room;
2132 : if (roomPushRules != null) {
2133 4 : for (final pushRule in roomPushRules) {
2134 6 : if (pushRule.ruleId == id) {
2135 : // "dont_notify" and "coalesce" should be ignored in actions since
2136 : // https://spec.matrix.org/v1.7/client-server-api/#actions
2137 2 : pushRule.actions
2138 2 : ..remove('dont_notify')
2139 2 : ..remove('coalesce');
2140 4 : if (pushRule.actions.isEmpty) {
2141 : return PushRuleState.mentionsOnly;
2142 : }
2143 : break;
2144 : }
2145 : }
2146 : }
2147 :
2148 : return PushRuleState.notify;
2149 : }
2150 :
2151 : /// Sends a request to the homeserver to set the [PushRuleState] for this room.
2152 : /// Returns ErrorResponse if something goes wrong.
2153 2 : Future<void> setPushRuleState(PushRuleState newState) async {
2154 4 : if (newState == pushRuleState) return;
2155 : dynamic resp;
2156 : switch (newState) {
2157 : // All push notifications should be sent to the user
2158 2 : case PushRuleState.notify:
2159 4 : if (pushRuleState == PushRuleState.dontNotify) {
2160 6 : await client.deletePushRule(PushRuleKind.override, id);
2161 0 : } else if (pushRuleState == PushRuleState.mentionsOnly) {
2162 0 : await client.deletePushRule(PushRuleKind.room, id);
2163 : }
2164 : break;
2165 : // Only when someone mentions the user, a push notification should be sent
2166 2 : case PushRuleState.mentionsOnly:
2167 4 : if (pushRuleState == PushRuleState.dontNotify) {
2168 6 : await client.deletePushRule(PushRuleKind.override, id);
2169 4 : await client.setPushRule(
2170 : PushRuleKind.room,
2171 2 : id,
2172 2 : [],
2173 : );
2174 0 : } else if (pushRuleState == PushRuleState.notify) {
2175 0 : await client.setPushRule(
2176 : PushRuleKind.room,
2177 0 : id,
2178 0 : [],
2179 : );
2180 : }
2181 : break;
2182 : // No push notification should be ever sent for this room.
2183 0 : case PushRuleState.dontNotify:
2184 0 : if (pushRuleState == PushRuleState.mentionsOnly) {
2185 0 : await client.deletePushRule(PushRuleKind.room, id);
2186 : }
2187 0 : await client.setPushRule(
2188 : PushRuleKind.override,
2189 0 : id,
2190 0 : [],
2191 0 : conditions: [
2192 0 : PushCondition(
2193 0 : kind: PushRuleConditions.eventMatch.name,
2194 : key: 'room_id',
2195 0 : pattern: id,
2196 : ),
2197 : ],
2198 : );
2199 : }
2200 : return resp;
2201 : }
2202 :
2203 : /// Redacts this event. Throws `ErrorResponse` on error.
2204 1 : Future<String?> redactEvent(
2205 : String eventId, {
2206 : String? reason,
2207 : String? txid,
2208 : }) async {
2209 : // Create new transaction id
2210 : String messageID;
2211 2 : final now = DateTime.now().millisecondsSinceEpoch;
2212 : if (txid == null) {
2213 0 : messageID = 'msg$now';
2214 : } else {
2215 : messageID = txid;
2216 : }
2217 1 : final data = <String, dynamic>{};
2218 1 : if (reason != null) data['reason'] = reason;
2219 2 : return await client.redactEvent(
2220 1 : id,
2221 : eventId,
2222 : messageID,
2223 : reason: reason,
2224 : );
2225 : }
2226 :
2227 : /// This tells the server that the user is typing for the next N milliseconds
2228 : /// where N is the value specified in the timeout key. Alternatively, if typing is false,
2229 : /// it tells the server that the user has stopped typing.
2230 0 : Future<void> setTyping(bool isTyping, {int? timeout}) =>
2231 0 : client.setTyping(client.userID!, id, isTyping, timeout: timeout);
2232 :
2233 : /// A room may be public meaning anyone can join the room without any prior action. Alternatively,
2234 : /// it can be invite meaning that a user who wishes to join the room must first receive an invite
2235 : /// to the room from someone already inside of the room. Currently, knock and private are reserved
2236 : /// keywords which are not implemented.
2237 2 : JoinRules? get joinRules {
2238 : final joinRulesString =
2239 6 : getState(EventTypes.RoomJoinRules)?.content.tryGet<String>('join_rule');
2240 : return JoinRules.values
2241 8 : .singleWhereOrNull((element) => element.text == joinRulesString);
2242 : }
2243 :
2244 : /// Changes the join rules. You should check first if the user is able to change it.
2245 2 : Future<void> setJoinRules(JoinRules joinRules) async {
2246 4 : await client.setRoomStateWithKey(
2247 2 : id,
2248 : EventTypes.RoomJoinRules,
2249 : '',
2250 2 : {
2251 4 : 'join_rule': joinRules.toString().replaceAll('JoinRules.', ''),
2252 : },
2253 : );
2254 : return;
2255 : }
2256 :
2257 : /// Whether the user has the permission to change the join rules.
2258 4 : bool get canChangeJoinRules => canChangeStateEvent(EventTypes.RoomJoinRules);
2259 :
2260 : /// This event controls whether guest users are allowed to join rooms. If this event
2261 : /// is absent, servers should act as if it is present and has the guest_access value "forbidden".
2262 2 : GuestAccess get guestAccess {
2263 2 : final guestAccessString = getState(EventTypes.GuestAccess)
2264 2 : ?.content
2265 2 : .tryGet<String>('guest_access');
2266 2 : return GuestAccess.values.singleWhereOrNull(
2267 6 : (element) => element.text == guestAccessString,
2268 : ) ??
2269 : GuestAccess.forbidden;
2270 : }
2271 :
2272 : /// Changes the guest access. You should check first if the user is able to change it.
2273 2 : Future<void> setGuestAccess(GuestAccess guestAccess) async {
2274 4 : await client.setRoomStateWithKey(
2275 2 : id,
2276 : EventTypes.GuestAccess,
2277 : '',
2278 2 : {
2279 2 : 'guest_access': guestAccess.text,
2280 : },
2281 : );
2282 : return;
2283 : }
2284 :
2285 : /// Whether the user has the permission to change the guest access.
2286 4 : bool get canChangeGuestAccess => canChangeStateEvent(EventTypes.GuestAccess);
2287 :
2288 : /// This event controls whether a user can see the events that happened in a room from before they joined.
2289 2 : HistoryVisibility? get historyVisibility {
2290 2 : final historyVisibilityString = getState(EventTypes.HistoryVisibility)
2291 2 : ?.content
2292 2 : .tryGet<String>('history_visibility');
2293 2 : return HistoryVisibility.values.singleWhereOrNull(
2294 6 : (element) => element.text == historyVisibilityString,
2295 : );
2296 : }
2297 :
2298 : /// Changes the history visibility. You should check first if the user is able to change it.
2299 2 : Future<void> setHistoryVisibility(HistoryVisibility historyVisibility) async {
2300 4 : await client.setRoomStateWithKey(
2301 2 : id,
2302 : EventTypes.HistoryVisibility,
2303 : '',
2304 2 : {
2305 2 : 'history_visibility': historyVisibility.text,
2306 : },
2307 : );
2308 : return;
2309 : }
2310 :
2311 : /// Whether the user has the permission to change the history visibility.
2312 2 : bool get canChangeHistoryVisibility =>
2313 2 : canChangeStateEvent(EventTypes.HistoryVisibility);
2314 :
2315 : /// Returns the encryption algorithm. Currently only `m.megolm.v1.aes-sha2` is supported.
2316 : /// Returns null if there is no encryption algorithm.
2317 33 : String? get encryptionAlgorithm =>
2318 95 : getState(EventTypes.Encryption)?.parsedRoomEncryptionContent.algorithm;
2319 :
2320 : /// Checks if this room is encrypted.
2321 66 : bool get encrypted => encryptionAlgorithm != null;
2322 :
2323 2 : Future<void> enableEncryption({int algorithmIndex = 0}) async {
2324 2 : if (encrypted) throw ('Encryption is already enabled!');
2325 2 : final algorithm = Client.supportedGroupEncryptionAlgorithms[algorithmIndex];
2326 4 : await client.setRoomStateWithKey(
2327 2 : id,
2328 : EventTypes.Encryption,
2329 : '',
2330 2 : {
2331 : 'algorithm': algorithm,
2332 : },
2333 : );
2334 : return;
2335 : }
2336 :
2337 : /// Returns all known device keys for all participants in this room.
2338 7 : Future<List<DeviceKeys>> getUserDeviceKeys() async {
2339 14 : await client.userDeviceKeysLoading;
2340 7 : final deviceKeys = <DeviceKeys>[];
2341 7 : final users = await requestParticipants();
2342 11 : for (final user in users) {
2343 24 : final userDeviceKeys = client.userDeviceKeys[user.id]?.deviceKeys.values;
2344 12 : if ([Membership.invite, Membership.join].contains(user.membership) &&
2345 : userDeviceKeys != null) {
2346 8 : for (final deviceKeyEntry in userDeviceKeys) {
2347 4 : deviceKeys.add(deviceKeyEntry);
2348 : }
2349 : }
2350 : }
2351 : return deviceKeys;
2352 : }
2353 :
2354 1 : Future<void> requestSessionKey(String sessionId, String senderKey) async {
2355 2 : if (!client.encryptionEnabled) {
2356 : return;
2357 : }
2358 4 : await client.encryption?.keyManager.request(this, sessionId, senderKey);
2359 : }
2360 :
2361 9 : Future<void> _handleFakeSync(
2362 : SyncUpdate syncUpdate, {
2363 : Direction? direction,
2364 : }) async {
2365 18 : if (client.database != null) {
2366 28 : await client.database?.transaction(() async {
2367 14 : await client.handleSync(syncUpdate, direction: direction);
2368 : });
2369 : } else {
2370 4 : await client.handleSync(syncUpdate, direction: direction);
2371 : }
2372 : }
2373 :
2374 : /// Whether this is an extinct room which has been archived in favor of a new
2375 : /// room which replaces this. Use `getLegacyRoomInformations()` to get more
2376 : /// informations about it if this is true.
2377 0 : bool get isExtinct => getState(EventTypes.RoomTombstone) != null;
2378 :
2379 : /// Returns informations about how this room is
2380 0 : TombstoneContent? get extinctInformations =>
2381 0 : getState(EventTypes.RoomTombstone)?.parsedTombstoneContent;
2382 :
2383 : /// Checks if the `m.room.create` state has a `type` key with the value
2384 : /// `m.space`.
2385 2 : bool get isSpace =>
2386 8 : getState(EventTypes.RoomCreate)?.content.tryGet<String>('type') ==
2387 : RoomCreationTypes.mSpace;
2388 :
2389 : /// The parents of this room. Currently this SDK doesn't yet set the canonical
2390 : /// flag and is not checking if this room is in fact a child of this space.
2391 : /// You should therefore not rely on this and always check the children of
2392 : /// the space.
2393 2 : List<SpaceParent> get spaceParents =>
2394 4 : states[EventTypes.SpaceParent]
2395 2 : ?.values
2396 6 : .map((state) => SpaceParent.fromState(state))
2397 8 : .where((child) => child.via.isNotEmpty)
2398 2 : .toList() ??
2399 2 : [];
2400 :
2401 : /// List all children of this space. Children without a `via` domain will be
2402 : /// ignored.
2403 : /// Children are sorted by the `order` while those without this field will be
2404 : /// sorted at the end of the list.
2405 4 : List<SpaceChild> get spaceChildren => !isSpace
2406 0 : ? throw Exception('Room is not a space!')
2407 4 : : (states[EventTypes.SpaceChild]
2408 2 : ?.values
2409 6 : .map((state) => SpaceChild.fromState(state))
2410 8 : .where((child) => child.via.isNotEmpty)
2411 2 : .toList() ??
2412 2 : [])
2413 2 : ..sort(
2414 10 : (a, b) => a.order.isEmpty || b.order.isEmpty
2415 6 : ? b.order.compareTo(a.order)
2416 6 : : a.order.compareTo(b.order),
2417 : );
2418 :
2419 : /// Adds or edits a child of this space.
2420 0 : Future<void> setSpaceChild(
2421 : String roomId, {
2422 : List<String>? via,
2423 : String? order,
2424 : bool? suggested,
2425 : }) async {
2426 0 : if (!isSpace) throw Exception('Room is not a space!');
2427 0 : via ??= [client.userID!.domain!];
2428 0 : await client.setRoomStateWithKey(id, EventTypes.SpaceChild, roomId, {
2429 0 : 'via': via,
2430 0 : if (order != null) 'order': order,
2431 0 : if (suggested != null) 'suggested': suggested,
2432 : });
2433 0 : await client.setRoomStateWithKey(roomId, EventTypes.SpaceParent, id, {
2434 : 'via': via,
2435 : });
2436 : return;
2437 : }
2438 :
2439 : /// Generates a matrix.to link with appropriate routing info to share the room
2440 2 : Future<Uri> matrixToInviteLink() async {
2441 4 : if (canonicalAlias.isNotEmpty) {
2442 2 : return Uri.parse(
2443 6 : 'https://matrix.to/#/${Uri.encodeComponent(canonicalAlias)}',
2444 : );
2445 : }
2446 2 : final List queryParameters = [];
2447 4 : final users = await requestParticipants([Membership.join]);
2448 4 : final currentPowerLevelsMap = getState(EventTypes.RoomPowerLevels)?.content;
2449 :
2450 2 : final temp = List<User>.from(users);
2451 8 : temp.removeWhere((user) => user.powerLevel < 50);
2452 : if (currentPowerLevelsMap != null) {
2453 : // just for weird rooms
2454 2 : temp.removeWhere(
2455 0 : (user) => user.powerLevel < getDefaultPowerLevel(currentPowerLevelsMap),
2456 : );
2457 : }
2458 :
2459 2 : if (temp.isNotEmpty) {
2460 0 : temp.sort((a, b) => a.powerLevel.compareTo(b.powerLevel));
2461 0 : if (temp.last.id.domain != null) {
2462 0 : queryParameters.add(temp.last.id.domain!);
2463 : }
2464 : }
2465 :
2466 2 : final Map<String, int> servers = {};
2467 4 : for (final user in users) {
2468 4 : if (user.id.domain != null) {
2469 6 : if (servers.containsKey(user.id.domain!)) {
2470 0 : servers[user.id.domain!] = servers[user.id.domain!]! + 1;
2471 : } else {
2472 6 : servers[user.id.domain!] = 1;
2473 : }
2474 : }
2475 : }
2476 2 : final sortedServers = Map.fromEntries(
2477 14 : servers.entries.toList()..sort((e1, e2) => e2.value.compareTo(e1.value)),
2478 4 : ).keys.take(3);
2479 4 : for (final server in sortedServers) {
2480 2 : if (!queryParameters.contains(server)) {
2481 2 : queryParameters.add(server);
2482 : }
2483 : }
2484 :
2485 : var queryString = '?';
2486 8 : for (var i = 0; i < min(queryParameters.length, 3); i++) {
2487 2 : if (i != 0) {
2488 2 : queryString += '&';
2489 : }
2490 6 : queryString += 'via=${queryParameters[i]}';
2491 : }
2492 2 : return Uri.parse(
2493 6 : 'https://matrix.to/#/${Uri.encodeComponent(id)}$queryString',
2494 : );
2495 : }
2496 :
2497 : /// Remove a child from this space by setting the `via` to an empty list.
2498 0 : Future<void> removeSpaceChild(String roomId) => !isSpace
2499 0 : ? throw Exception('Room is not a space!')
2500 0 : : setSpaceChild(roomId, via: const []);
2501 :
2502 1 : @override
2503 4 : bool operator ==(Object other) => (other is Room && other.id == id);
2504 :
2505 0 : @override
2506 0 : int get hashCode => Object.hashAll([id]);
2507 : }
2508 :
2509 : enum EncryptionHealthState {
2510 : allVerified,
2511 : unverifiedDevices,
2512 : }
|
