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