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