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 'package:collection/collection.dart';
20 :
21 : import 'package:matrix/encryption.dart';
22 : import 'package:matrix/matrix.dart';
23 : import 'package:matrix/msc_extensions/msc_3381_polls/models/poll_event_content.dart';
24 :
25 : abstract class EventLocalizations {
26 : // As we need to create the localized body off of a different set of parameters, we
27 : // might create it with `event.plaintextBody`, maybe with `event.body`, maybe with the
28 : // reply fallback stripped, and maybe with the new body in `event.content['m.new_content']`.
29 : // Thus, it seems easier to offload that logic into `Event.getLocalizedBody()` and pass the
30 : // `body` variable around here.
31 2 : static String _localizedBodyNormalMessage(
32 : Event event,
33 : MatrixLocalizations i18n,
34 : String body,
35 : ) {
36 2 : switch (event.messageType) {
37 2 : case MessageTypes.Image:
38 2 : return i18n.sentAPicture(
39 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
40 : );
41 2 : case MessageTypes.File:
42 2 : return i18n.sentAFile(
43 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
44 : );
45 2 : case MessageTypes.Audio:
46 2 : return i18n.sentAnAudio(
47 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
48 : );
49 2 : case MessageTypes.Video:
50 2 : return i18n.sentAVideo(
51 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
52 : );
53 2 : case MessageTypes.Location:
54 2 : return i18n.sharedTheLocation(
55 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
56 : );
57 2 : case MessageTypes.Sticker:
58 0 : return i18n.sentASticker(
59 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
60 : );
61 2 : case MessageTypes.Emote:
62 2 : return '* $body';
63 2 : case EventTypes.KeyVerificationRequest:
64 2 : return i18n.requestedKeyVerification(
65 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
66 : );
67 2 : case EventTypes.KeyVerificationCancel:
68 2 : return i18n.canceledKeyVerification(
69 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
70 : );
71 2 : case EventTypes.KeyVerificationDone:
72 2 : return i18n.completedKeyVerification(
73 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
74 : );
75 2 : case EventTypes.KeyVerificationReady:
76 2 : return i18n.isReadyForKeyVerification(
77 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
78 : );
79 2 : case EventTypes.KeyVerificationAccept:
80 2 : return i18n.acceptedKeyVerification(
81 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
82 : );
83 2 : case EventTypes.KeyVerificationStart:
84 2 : return i18n.startedKeyVerification(
85 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
86 : );
87 2 : case MessageTypes.BadEncrypted:
88 : String errorText;
89 0 : switch (event.body) {
90 0 : case DecryptException.channelCorrupted:
91 0 : errorText = '${i18n.channelCorruptedDecryptError}.';
92 : break;
93 0 : case DecryptException.notEnabled:
94 0 : errorText = '${i18n.encryptionNotEnabled}.';
95 : break;
96 0 : case DecryptException.unknownAlgorithm:
97 0 : errorText = '${i18n.unknownEncryptionAlgorithm}.';
98 : break;
99 0 : case DecryptException.unknownSession:
100 0 : errorText = '${i18n.noPermission}.';
101 : break;
102 : default:
103 : errorText = body;
104 : break;
105 : }
106 0 : return i18n.couldNotDecryptMessage(errorText);
107 : case MessageTypes.Text:
108 : case MessageTypes.Notice:
109 : case MessageTypes.None:
110 : default:
111 : return body;
112 : }
113 : }
114 :
115 : // This map holds how to localize event types, and thus which event types exist.
116 : // If an event exists but it does not have a localized body, set its callback to null
117 : static final Map<String,
118 : String Function(Event event, MatrixLocalizations i18n, String body)?>
119 6 : localizationsMap = {
120 4 : EventTypes.Sticker: (event, i18n, body) => i18n.sentASticker(
121 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
122 : ),
123 4 : EventTypes.Redaction: (event, i18n, body) => i18n.redactedAnEvent(event),
124 4 : EventTypes.RoomAliases: (event, i18n, body) => i18n.changedTheRoomAliases(
125 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
126 : ),
127 2 : EventTypes.RoomCanonicalAlias: (event, i18n, body) =>
128 2 : i18n.changedTheRoomInvitationLink(
129 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
130 : ),
131 4 : EventTypes.RoomCreate: (event, i18n, body) => i18n.createdTheChat(
132 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
133 : ),
134 4 : EventTypes.RoomTombstone: (event, i18n, body) => i18n.roomHasBeenUpgraded,
135 2 : EventTypes.RoomJoinRules: (event, i18n, body) {
136 2 : final joinRules = JoinRules.values.firstWhereOrNull(
137 2 : (r) =>
138 6 : r.toString().replaceAll('JoinRules.', '') ==
139 4 : event.content['join_rule'],
140 : );
141 : if (joinRules == null) {
142 0 : return i18n.changedTheJoinRules(
143 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
144 : );
145 : } else {
146 2 : return i18n.changedTheJoinRulesTo(
147 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
148 2 : joinRules.getLocalizedString(i18n),
149 : );
150 : }
151 : },
152 2 : EventTypes.RoomMember: (event, i18n, body) {
153 4 : final targetName = event.stateKeyUser?.calcDisplayname(i18n: i18n) ?? '';
154 : final senderName =
155 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n);
156 10 : final userIsTarget = event.stateKey == event.room.client.userID;
157 10 : final userIsSender = event.senderId == event.room.client.userID;
158 :
159 2 : switch (event.roomMemberChangeType) {
160 2 : case RoomMemberChangeType.avatar:
161 0 : return i18n.changedTheProfileAvatar(targetName);
162 2 : case RoomMemberChangeType.displayname:
163 : final newDisplayname =
164 0 : event.content.tryGet<String>('displayname') ?? '';
165 : final oldDisplayname =
166 0 : event.prevContent?.tryGet<String>('displayname') ?? '';
167 0 : return i18n.changedTheDisplaynameTo(oldDisplayname, newDisplayname);
168 2 : case RoomMemberChangeType.join:
169 : return userIsTarget
170 0 : ? i18n.youJoinedTheChat
171 2 : : i18n.joinedTheChat(targetName);
172 2 : case RoomMemberChangeType.acceptInvite:
173 : return userIsTarget
174 0 : ? i18n.youAcceptedTheInvitation
175 2 : : i18n.acceptedTheInvitation(targetName);
176 2 : case RoomMemberChangeType.rejectInvite:
177 : return userIsTarget
178 0 : ? i18n.youRejectedTheInvitation
179 2 : : i18n.rejectedTheInvitation(targetName);
180 2 : case RoomMemberChangeType.withdrawInvitation:
181 : return userIsSender
182 0 : ? i18n.youHaveWithdrawnTheInvitationFor(targetName)
183 2 : : i18n.hasWithdrawnTheInvitationFor(senderName, targetName);
184 2 : case RoomMemberChangeType.leave:
185 0 : return i18n.userLeftTheChat(targetName);
186 2 : case RoomMemberChangeType.kick:
187 : return userIsSender
188 0 : ? i18n.youKicked(targetName)
189 2 : : i18n.kicked(senderName, targetName);
190 2 : case RoomMemberChangeType.invite:
191 : return userIsSender
192 0 : ? i18n.youInvitedUser(targetName)
193 : : userIsTarget
194 0 : ? i18n.youInvitedBy(senderName)
195 2 : : i18n.invitedUser(senderName, targetName);
196 2 : case RoomMemberChangeType.ban:
197 : return userIsSender
198 0 : ? i18n.youBannedUser(targetName)
199 2 : : i18n.bannedUser(senderName, targetName);
200 0 : case RoomMemberChangeType.unban:
201 : return userIsSender
202 0 : ? i18n.youUnbannedUser(targetName)
203 0 : : i18n.unbannedUser(senderName, targetName);
204 0 : case RoomMemberChangeType.knock:
205 0 : return i18n.hasKnocked(targetName);
206 0 : case RoomMemberChangeType.other:
207 : return userIsTarget
208 0 : ? i18n.youJoinedTheChat
209 0 : : i18n.joinedTheChat(targetName);
210 : }
211 : },
212 2 : EventTypes.RoomPowerLevels: (event, i18n, body) =>
213 2 : i18n.changedTheChatPermissions(
214 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
215 : ),
216 4 : EventTypes.RoomName: (event, i18n, body) => i18n.changedTheChatNameTo(
217 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
218 4 : event.content.tryGet<String>('name') ?? '',
219 : ),
220 2 : EventTypes.RoomTopic: (event, i18n, body) =>
221 2 : i18n.changedTheChatDescriptionTo(
222 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
223 4 : event.content.tryGet<String>('topic') ?? '',
224 : ),
225 4 : EventTypes.RoomAvatar: (event, i18n, body) => i18n.changedTheChatAvatar(
226 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
227 : ),
228 0 : EventTypes.GuestAccess: (event, i18n, body) {
229 0 : final guestAccess = GuestAccess.values.firstWhereOrNull(
230 0 : (r) =>
231 0 : r.toString().replaceAll('GuestAccess.', '') ==
232 0 : event.content['guest_access'],
233 : );
234 : if (guestAccess == null) {
235 0 : return i18n.changedTheGuestAccessRules(
236 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
237 : );
238 : } else {
239 0 : return i18n.changedTheGuestAccessRulesTo(
240 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
241 0 : guestAccess.getLocalizedString(i18n),
242 : );
243 : }
244 : },
245 2 : EventTypes.HistoryVisibility: (event, i18n, body) {
246 2 : final historyVisibility = HistoryVisibility.values.firstWhereOrNull(
247 2 : (r) =>
248 6 : r.toString().replaceAll('HistoryVisibility.', '') ==
249 4 : event.content['history_visibility'],
250 : );
251 : if (historyVisibility == null) {
252 0 : return i18n.changedTheHistoryVisibility(
253 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
254 : );
255 : } else {
256 2 : return i18n.changedTheHistoryVisibilityTo(
257 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
258 2 : historyVisibility.getLocalizedString(i18n),
259 : );
260 : }
261 : },
262 2 : EventTypes.Encryption: (event, i18n, body) {
263 2 : var localizedBody = i18n.activatedEndToEndEncryption(
264 4 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
265 : );
266 8 : if (event.room.client.encryptionEnabled == false) {
267 6 : localizedBody += '. ${i18n.needPantalaimonWarning}';
268 : }
269 : return localizedBody;
270 : },
271 0 : EventTypes.CallAnswer: (event, i18n, body) => i18n.answeredTheCall(
272 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
273 : ),
274 0 : EventTypes.CallHangup: (event, i18n, body) => i18n.endedTheCall(
275 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
276 : ),
277 0 : EventTypes.CallInvite: (event, i18n, body) => i18n.startedACall(
278 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
279 : ),
280 0 : EventTypes.CallCandidates: (event, i18n, body) => i18n.sentCallInformations(
281 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
282 : ),
283 0 : EventTypes.Encrypted: (event, i18n, body) =>
284 0 : _localizedBodyNormalMessage(event, i18n, body),
285 2 : EventTypes.Message: (event, i18n, body) =>
286 2 : _localizedBodyNormalMessage(event, i18n, body),
287 0 : EventTypes.Reaction: (event, i18n, body) => i18n.sentReaction(
288 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
289 0 : event.content
290 0 : .tryGetMap<String, Object?>('m.relates_to')
291 0 : ?.tryGet<String>('key') ??
292 : body,
293 : ),
294 0 : PollEventContent.startType: (event, i18n, body) => i18n.startedAPoll(
295 0 : event.senderFromMemoryOrFallback.calcDisplayname(i18n: i18n),
296 : ),
297 : };
298 : }
|
