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