]> nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/ManagerImpl.java
b5dcb5e0de851ad1e4c4a84b0f8a71bb373f390c
[signal-cli] / lib / src / main / java / org / asamk / signal / manager / ManagerImpl.java
1 /*
2 Copyright (C) 2015-2022 AsamK and contributors
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17 package org.asamk.signal.manager;
18
19 import org.asamk.signal.manager.api.AttachmentInvalidException;
20 import org.asamk.signal.manager.api.Configuration;
21 import org.asamk.signal.manager.api.Device;
22 import org.asamk.signal.manager.api.Group;
23 import org.asamk.signal.manager.api.Identity;
24 import org.asamk.signal.manager.api.InactiveGroupLinkException;
25 import org.asamk.signal.manager.api.InvalidDeviceLinkException;
26 import org.asamk.signal.manager.api.InvalidStickerException;
27 import org.asamk.signal.manager.api.Message;
28 import org.asamk.signal.manager.api.NotPrimaryDeviceException;
29 import org.asamk.signal.manager.api.Pair;
30 import org.asamk.signal.manager.api.RecipientIdentifier;
31 import org.asamk.signal.manager.api.SendGroupMessageResults;
32 import org.asamk.signal.manager.api.SendMessageResult;
33 import org.asamk.signal.manager.api.SendMessageResults;
34 import org.asamk.signal.manager.api.StickerPack;
35 import org.asamk.signal.manager.api.StickerPackId;
36 import org.asamk.signal.manager.api.StickerPackInvalidException;
37 import org.asamk.signal.manager.api.StickerPackUrl;
38 import org.asamk.signal.manager.api.TypingAction;
39 import org.asamk.signal.manager.api.UnregisteredRecipientException;
40 import org.asamk.signal.manager.api.UpdateGroup;
41 import org.asamk.signal.manager.api.UpdateProfile;
42 import org.asamk.signal.manager.api.UserStatus;
43 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
44 import org.asamk.signal.manager.groups.GroupId;
45 import org.asamk.signal.manager.groups.GroupInviteLinkUrl;
46 import org.asamk.signal.manager.groups.GroupNotFoundException;
47 import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;
48 import org.asamk.signal.manager.groups.LastGroupAdminException;
49 import org.asamk.signal.manager.groups.NotAGroupMemberException;
50 import org.asamk.signal.manager.helper.AccountFileUpdater;
51 import org.asamk.signal.manager.helper.Context;
52 import org.asamk.signal.manager.storage.SignalAccount;
53 import org.asamk.signal.manager.storage.groups.GroupInfo;
54 import org.asamk.signal.manager.storage.identities.IdentityInfo;
55 import org.asamk.signal.manager.storage.recipients.Profile;
56 import org.asamk.signal.manager.storage.recipients.Recipient;
57 import org.asamk.signal.manager.storage.recipients.RecipientId;
58 import org.asamk.signal.manager.storage.stickerPacks.JsonStickerPack;
59 import org.asamk.signal.manager.storage.stickerPacks.StickerPackStore;
60 import org.asamk.signal.manager.storage.stickers.Sticker;
61 import org.asamk.signal.manager.util.AttachmentUtils;
62 import org.asamk.signal.manager.util.KeyUtils;
63 import org.asamk.signal.manager.util.StickerUtils;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
66 import org.whispersystems.signalservice.api.SignalSessionLock;
67 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
68 import org.whispersystems.signalservice.api.messages.SignalServicePreview;
69 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
70 import org.whispersystems.signalservice.api.messages.SignalServiceTypingMessage;
71 import org.whispersystems.signalservice.api.push.ACI;
72 import org.whispersystems.signalservice.api.util.DeviceNameUtil;
73 import org.whispersystems.signalservice.api.util.InvalidNumberException;
74 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
75 import org.whispersystems.signalservice.internal.util.Hex;
76 import org.whispersystems.signalservice.internal.util.Util;
77
78 import java.io.File;
79 import java.io.IOException;
80 import java.net.URI;
81 import java.time.Duration;
82 import java.util.ArrayList;
83 import java.util.Collection;
84 import java.util.HashMap;
85 import java.util.HashSet;
86 import java.util.List;
87 import java.util.Map;
88 import java.util.Objects;
89 import java.util.Optional;
90 import java.util.Set;
91 import java.util.concurrent.ExecutorService;
92 import java.util.concurrent.Executors;
93 import java.util.concurrent.atomic.AtomicInteger;
94 import java.util.concurrent.locks.ReentrantLock;
95 import java.util.function.Function;
96 import java.util.stream.Collectors;
97 import java.util.stream.Stream;
98
99 import io.reactivex.rxjava3.disposables.CompositeDisposable;
100
101 class ManagerImpl implements Manager {
102
103 private final static Logger logger = LoggerFactory.getLogger(ManagerImpl.class);
104
105 private SignalAccount account;
106 private final SignalDependencies dependencies;
107 private final Context context;
108
109 private final ExecutorService executor = Executors.newCachedThreadPool();
110
111 private Thread receiveThread;
112 private boolean isReceivingSynchronous;
113 private final Set<ReceiveMessageHandler> weakHandlers = new HashSet<>();
114 private final Set<ReceiveMessageHandler> messageHandlers = new HashSet<>();
115 private final List<Runnable> closedListeners = new ArrayList<>();
116 private final List<Runnable> addressChangedListeners = new ArrayList<>();
117 private final CompositeDisposable disposable = new CompositeDisposable();
118
119 ManagerImpl(
120 SignalAccount account,
121 PathConfig pathConfig,
122 AccountFileUpdater accountFileUpdater,
123 ServiceEnvironmentConfig serviceEnvironmentConfig,
124 String userAgent
125 ) {
126 this.account = account;
127
128 final var sessionLock = new SignalSessionLock() {
129 private final ReentrantLock LEGACY_LOCK = new ReentrantLock();
130
131 @Override
132 public Lock acquire() {
133 LEGACY_LOCK.lock();
134 return LEGACY_LOCK::unlock;
135 }
136 };
137 this.dependencies = new SignalDependencies(serviceEnvironmentConfig,
138 userAgent,
139 account.getCredentialsProvider(),
140 account.getSignalServiceDataStore(),
141 executor,
142 sessionLock);
143 final var avatarStore = new AvatarStore(pathConfig.avatarsPath());
144 final var attachmentStore = new AttachmentStore(pathConfig.attachmentsPath());
145 final var stickerPackStore = new StickerPackStore(pathConfig.stickerPacksPath());
146
147 this.context = new Context(account, new AccountFileUpdater() {
148 @Override
149 public void updateAccountIdentifiers(final String number, final ACI aci) {
150 accountFileUpdater.updateAccountIdentifiers(number, aci);
151 synchronized (addressChangedListeners) {
152 addressChangedListeners.forEach(Runnable::run);
153 }
154 }
155
156 @Override
157 public void removeAccount() {
158 accountFileUpdater.removeAccount();
159 }
160 }, dependencies, avatarStore, attachmentStore, stickerPackStore);
161 this.context.getAccountHelper().setUnregisteredListener(this::close);
162 this.context.getReceiveHelper().setAuthenticationFailureListener(this::close);
163 this.context.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
164 synchronized (this) {
165 this.notifyAll();
166 }
167 });
168 disposable.add(account.getIdentityKeyStore().getIdentityChanges().subscribe(recipientId -> {
169 logger.trace("Archiving old sessions for {}", recipientId);
170 account.getSessionStore().archiveSessions(recipientId);
171 account.getSenderKeyStore().deleteSharedWith(recipientId);
172 final var profile = account.getProfileStore().getProfile(recipientId);
173 if (profile != null) {
174 account.getProfileStore()
175 .storeProfile(recipientId,
176 Profile.newBuilder(profile)
177 .withUnidentifiedAccessMode(Profile.UnidentifiedAccessMode.UNKNOWN)
178 .withLastUpdateTimestamp(0)
179 .build());
180 }
181 }));
182 }
183
184 @Override
185 public String getSelfNumber() {
186 return account.getNumber();
187 }
188
189 void checkAccountState() throws IOException {
190 context.getAccountHelper().checkAccountState();
191 }
192
193 @Override
194 public Map<String, UserStatus> getUserStatus(Set<String> numbers) throws IOException {
195 final var canonicalizedNumbers = numbers.stream().collect(Collectors.toMap(n -> n, n -> {
196 try {
197 final var canonicalizedNumber = PhoneNumberFormatter.formatNumber(n, account.getNumber());
198 if (!canonicalizedNumber.equals(n)) {
199 logger.debug("Normalized number {} to {}.", n, canonicalizedNumber);
200 }
201 return canonicalizedNumber;
202 } catch (InvalidNumberException e) {
203 return "";
204 }
205 }));
206
207 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
208 final var canonicalizedNumbersSet = canonicalizedNumbers.values()
209 .stream()
210 .filter(s -> !s.isEmpty())
211 .collect(Collectors.toSet());
212 final var registeredUsers = context.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet);
213
214 return numbers.stream().collect(Collectors.toMap(n -> n, n -> {
215 final var number = canonicalizedNumbers.get(n);
216 final var aci = registeredUsers.get(number);
217 final var profile = aci == null
218 ? null
219 : context.getProfileHelper()
220 .getRecipientProfile(account.getRecipientResolver().resolveRecipient(aci));
221 return new UserStatus(number.isEmpty() ? null : number,
222 aci == null ? null : aci.uuid(),
223 profile != null
224 && profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.UNRESTRICTED);
225 }));
226 }
227
228 @Override
229 public void updateAccountAttributes(String deviceName) throws IOException {
230 if (deviceName != null) {
231 context.getAccountHelper().setDeviceName(deviceName);
232 }
233 context.getAccountHelper().updateAccountAttributes();
234 }
235
236 @Override
237 public Configuration getConfiguration() {
238 final var configurationStore = account.getConfigurationStore();
239 return Configuration.from(configurationStore);
240 }
241
242 @Override
243 public void updateConfiguration(
244 Configuration configuration
245 ) throws NotPrimaryDeviceException {
246 if (!account.isPrimaryDevice()) {
247 throw new NotPrimaryDeviceException();
248 }
249
250 final var configurationStore = account.getConfigurationStore();
251 if (configuration.readReceipts().isPresent()) {
252 configurationStore.setReadReceipts(configuration.readReceipts().get());
253 }
254 if (configuration.unidentifiedDeliveryIndicators().isPresent()) {
255 configurationStore.setUnidentifiedDeliveryIndicators(configuration.unidentifiedDeliveryIndicators().get());
256 }
257 if (configuration.typingIndicators().isPresent()) {
258 configurationStore.setTypingIndicators(configuration.typingIndicators().get());
259 }
260 if (configuration.linkPreviews().isPresent()) {
261 configurationStore.setLinkPreviews(configuration.linkPreviews().get());
262 }
263 context.getSyncHelper().sendConfigurationMessage();
264 }
265
266 @Override
267 public void updateProfile(UpdateProfile updateProfile) throws IOException {
268 context.getProfileHelper()
269 .setProfile(updateProfile.getGivenName(),
270 updateProfile.getFamilyName(),
271 updateProfile.getAbout(),
272 updateProfile.getAboutEmoji(),
273 updateProfile.isDeleteAvatar()
274 ? Optional.empty()
275 : updateProfile.getAvatar() == null ? null : Optional.of(updateProfile.getAvatar()),
276 updateProfile.getMobileCoinAddress());
277 context.getSyncHelper().sendSyncFetchProfileMessage();
278 }
279
280 @Override
281 public void unregister() throws IOException {
282 context.getAccountHelper().unregister();
283 }
284
285 @Override
286 public void deleteAccount() throws IOException {
287 context.getAccountHelper().deleteAccount();
288 }
289
290 @Override
291 public void submitRateLimitRecaptchaChallenge(String challenge, String captcha) throws IOException {
292 captcha = captcha == null ? null : captcha.replace("signalcaptcha://", "");
293
294 dependencies.getAccountManager().submitRateLimitRecaptchaChallenge(challenge, captcha);
295 }
296
297 @Override
298 public List<Device> getLinkedDevices() throws IOException {
299 var devices = dependencies.getAccountManager().getDevices();
300 account.setMultiDevice(devices.size() > 1);
301 var identityKey = account.getAciIdentityKeyPair().getPrivateKey();
302 return devices.stream().map(d -> {
303 String deviceName = d.getName();
304 if (deviceName != null) {
305 try {
306 deviceName = DeviceNameUtil.decryptDeviceName(deviceName, identityKey);
307 } catch (IOException e) {
308 logger.debug("Failed to decrypt device name, maybe plain text?", e);
309 }
310 }
311 return new Device(d.getId(),
312 deviceName,
313 d.getCreated(),
314 d.getLastSeen(),
315 d.getId() == account.getDeviceId());
316 }).toList();
317 }
318
319 @Override
320 public void removeLinkedDevices(int deviceId) throws IOException {
321 context.getAccountHelper().removeLinkedDevices(deviceId);
322 }
323
324 @Override
325 public void addDeviceLink(URI linkUri) throws IOException, InvalidDeviceLinkException {
326 var deviceLinkInfo = DeviceLinkInfo.parseDeviceLinkUri(linkUri);
327 context.getAccountHelper().addDevice(deviceLinkInfo);
328 }
329
330 @Override
331 public void setRegistrationLockPin(Optional<String> pin) throws IOException, NotPrimaryDeviceException {
332 if (!account.isPrimaryDevice()) {
333 throw new NotPrimaryDeviceException();
334 }
335 if (pin.isPresent()) {
336 context.getAccountHelper().setRegistrationPin(pin.get());
337 } else {
338 context.getAccountHelper().removeRegistrationPin();
339 }
340 }
341
342 void refreshPreKeys() throws IOException {
343 context.getPreKeyHelper().refreshPreKeys();
344 }
345
346 @Override
347 public Profile getRecipientProfile(RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
348 return context.getProfileHelper().getRecipientProfile(context.getRecipientHelper().resolveRecipient(recipient));
349 }
350
351 @Override
352 public List<Group> getGroups() {
353 return account.getGroupStore().getGroups().stream().map(this::toGroup).toList();
354 }
355
356 private Group toGroup(final GroupInfo groupInfo) {
357 if (groupInfo == null) {
358 return null;
359 }
360
361 return Group.from(groupInfo, account.getRecipientAddressResolver(), account.getSelfRecipientId());
362 }
363
364 @Override
365 public SendGroupMessageResults quitGroup(
366 GroupId groupId, Set<RecipientIdentifier.Single> groupAdmins
367 ) throws GroupNotFoundException, IOException, NotAGroupMemberException, LastGroupAdminException, UnregisteredRecipientException {
368 final var newAdmins = context.getRecipientHelper().resolveRecipients(groupAdmins);
369 return context.getGroupHelper().quitGroup(groupId, newAdmins);
370 }
371
372 @Override
373 public void deleteGroup(GroupId groupId) throws IOException {
374 final var group = context.getGroupHelper().getGroup(groupId);
375 if (group.isMember(account.getSelfRecipientId())) {
376 throw new IOException(
377 "The local group information cannot be removed, as the user is still a member of the group");
378 }
379 context.getGroupHelper().deleteGroup(groupId);
380 }
381
382 @Override
383 public Pair<GroupId, SendGroupMessageResults> createGroup(
384 String name, Set<RecipientIdentifier.Single> members, File avatarFile
385 ) throws IOException, AttachmentInvalidException, UnregisteredRecipientException {
386 return context.getGroupHelper()
387 .createGroup(name,
388 members == null ? null : context.getRecipientHelper().resolveRecipients(members),
389 avatarFile);
390 }
391
392 @Override
393 public SendGroupMessageResults updateGroup(
394 final GroupId groupId, final UpdateGroup updateGroup
395 ) throws IOException, GroupNotFoundException, AttachmentInvalidException, NotAGroupMemberException, GroupSendingNotAllowedException, UnregisteredRecipientException {
396 return context.getGroupHelper()
397 .updateGroup(groupId,
398 updateGroup.getName(),
399 updateGroup.getDescription(),
400 updateGroup.getMembers() == null
401 ? null
402 : context.getRecipientHelper().resolveRecipients(updateGroup.getMembers()),
403 updateGroup.getRemoveMembers() == null
404 ? null
405 : context.getRecipientHelper().resolveRecipients(updateGroup.getRemoveMembers()),
406 updateGroup.getAdmins() == null
407 ? null
408 : context.getRecipientHelper().resolveRecipients(updateGroup.getAdmins()),
409 updateGroup.getRemoveAdmins() == null
410 ? null
411 : context.getRecipientHelper().resolveRecipients(updateGroup.getRemoveAdmins()),
412 updateGroup.getBanMembers() == null
413 ? null
414 : context.getRecipientHelper().resolveRecipients(updateGroup.getBanMembers()),
415 updateGroup.getUnbanMembers() == null
416 ? null
417 : context.getRecipientHelper().resolveRecipients(updateGroup.getUnbanMembers()),
418 updateGroup.isResetGroupLink(),
419 updateGroup.getGroupLinkState(),
420 updateGroup.getAddMemberPermission(),
421 updateGroup.getEditDetailsPermission(),
422 updateGroup.getAvatarFile(),
423 updateGroup.getExpirationTimer(),
424 updateGroup.getIsAnnouncementGroup());
425 }
426
427 @Override
428 public Pair<GroupId, SendGroupMessageResults> joinGroup(
429 GroupInviteLinkUrl inviteLinkUrl
430 ) throws IOException, InactiveGroupLinkException {
431 return context.getGroupHelper().joinGroup(inviteLinkUrl);
432 }
433
434 private SendMessageResults sendMessage(
435 SignalServiceDataMessage.Builder messageBuilder, Set<RecipientIdentifier> recipients
436 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
437 var results = new HashMap<RecipientIdentifier, List<SendMessageResult>>();
438 long timestamp = System.currentTimeMillis();
439 messageBuilder.withTimestamp(timestamp);
440 for (final var recipient : recipients) {
441 if (recipient instanceof RecipientIdentifier.Single single) {
442 try {
443 final var recipientId = context.getRecipientHelper().resolveRecipient(single);
444 final var result = context.getSendHelper().sendMessage(messageBuilder, recipientId);
445 results.put(recipient, List.of(toSendMessageResult(result)));
446 } catch (UnregisteredRecipientException e) {
447 results.put(recipient,
448 List.of(SendMessageResult.unregisteredFailure(single.toPartialRecipientAddress())));
449 }
450 } else if (recipient instanceof RecipientIdentifier.NoteToSelf) {
451 final var result = context.getSendHelper().sendSelfMessage(messageBuilder);
452 results.put(recipient, List.of(toSendMessageResult(result)));
453 } else if (recipient instanceof RecipientIdentifier.Group group) {
454 final var result = context.getSendHelper().sendAsGroupMessage(messageBuilder, group.groupId());
455 results.put(recipient, result.stream().map(this::toSendMessageResult).toList());
456 }
457 }
458 return new SendMessageResults(timestamp, results);
459 }
460
461 private SendMessageResult toSendMessageResult(final org.whispersystems.signalservice.api.messages.SendMessageResult result) {
462 return SendMessageResult.from(result, account.getRecipientResolver(), account.getRecipientAddressResolver());
463 }
464
465 private SendMessageResults sendTypingMessage(
466 SignalServiceTypingMessage.Action action, Set<RecipientIdentifier> recipients
467 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
468 var results = new HashMap<RecipientIdentifier, List<SendMessageResult>>();
469 final var timestamp = System.currentTimeMillis();
470 for (var recipient : recipients) {
471 if (recipient instanceof RecipientIdentifier.Single single) {
472 final var message = new SignalServiceTypingMessage(action, timestamp, Optional.empty());
473 try {
474 final var recipientId = context.getRecipientHelper().resolveRecipient(single);
475 final var result = context.getSendHelper().sendTypingMessage(message, recipientId);
476 results.put(recipient, List.of(toSendMessageResult(result)));
477 } catch (UnregisteredRecipientException e) {
478 results.put(recipient,
479 List.of(SendMessageResult.unregisteredFailure(single.toPartialRecipientAddress())));
480 }
481 } else if (recipient instanceof RecipientIdentifier.Group) {
482 final var groupId = ((RecipientIdentifier.Group) recipient).groupId();
483 final var message = new SignalServiceTypingMessage(action, timestamp, Optional.of(groupId.serialize()));
484 final var result = context.getSendHelper().sendGroupTypingMessage(message, groupId);
485 results.put(recipient, result.stream().map(this::toSendMessageResult).toList());
486 }
487 }
488 return new SendMessageResults(timestamp, results);
489 }
490
491 @Override
492 public SendMessageResults sendTypingMessage(
493 TypingAction action, Set<RecipientIdentifier> recipients
494 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
495 return sendTypingMessage(action.toSignalService(), recipients);
496 }
497
498 @Override
499 public SendMessageResults sendReadReceipt(
500 RecipientIdentifier.Single sender, List<Long> messageIds
501 ) {
502 final var timestamp = System.currentTimeMillis();
503 var receiptMessage = new SignalServiceReceiptMessage(SignalServiceReceiptMessage.Type.READ,
504 messageIds,
505 timestamp);
506
507 return sendReceiptMessage(sender, timestamp, receiptMessage);
508 }
509
510 @Override
511 public SendMessageResults sendViewedReceipt(
512 RecipientIdentifier.Single sender, List<Long> messageIds
513 ) {
514 final var timestamp = System.currentTimeMillis();
515 var receiptMessage = new SignalServiceReceiptMessage(SignalServiceReceiptMessage.Type.VIEWED,
516 messageIds,
517 timestamp);
518
519 return sendReceiptMessage(sender, timestamp, receiptMessage);
520 }
521
522 private SendMessageResults sendReceiptMessage(
523 final RecipientIdentifier.Single sender,
524 final long timestamp,
525 final SignalServiceReceiptMessage receiptMessage
526 ) {
527 try {
528 final var result = context.getSendHelper()
529 .sendReceiptMessage(receiptMessage, context.getRecipientHelper().resolveRecipient(sender));
530 return new SendMessageResults(timestamp, Map.of(sender, List.of(toSendMessageResult(result))));
531 } catch (UnregisteredRecipientException e) {
532 return new SendMessageResults(timestamp,
533 Map.of(sender, List.of(SendMessageResult.unregisteredFailure(sender.toPartialRecipientAddress()))));
534 }
535 }
536
537 @Override
538 public SendMessageResults sendMessage(
539 Message message, Set<RecipientIdentifier> recipients
540 ) throws IOException, AttachmentInvalidException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException, InvalidStickerException {
541 final var selfProfile = context.getProfileHelper().getSelfProfile();
542 if (selfProfile == null || selfProfile.getDisplayName().isEmpty()) {
543 logger.warn(
544 "No profile name set. When sending a message it's recommended to set a profile name wit the updateProfile command. This may become mandatory in the future.");
545 }
546 final var messageBuilder = SignalServiceDataMessage.newBuilder();
547 applyMessage(messageBuilder, message);
548 return sendMessage(messageBuilder, recipients);
549 }
550
551 private void applyMessage(
552 final SignalServiceDataMessage.Builder messageBuilder, final Message message
553 ) throws AttachmentInvalidException, IOException, UnregisteredRecipientException, InvalidStickerException {
554 messageBuilder.withBody(message.messageText());
555 if (message.attachments().size() > 0) {
556 messageBuilder.withAttachments(context.getAttachmentHelper().uploadAttachments(message.attachments()));
557 }
558 if (message.mentions().size() > 0) {
559 messageBuilder.withMentions(resolveMentions(message.mentions()));
560 }
561 if (message.quote().isPresent()) {
562 final var quote = message.quote().get();
563 messageBuilder.withQuote(new SignalServiceDataMessage.Quote(quote.timestamp(),
564 context.getRecipientHelper()
565 .resolveSignalServiceAddress(context.getRecipientHelper().resolveRecipient(quote.author())),
566 quote.message(),
567 List.of(),
568 resolveMentions(quote.mentions()),
569 SignalServiceDataMessage.Quote.Type.NORMAL));
570 }
571 if (message.sticker().isPresent()) {
572 final var sticker = message.sticker().get();
573 final var packId = StickerPackId.deserialize(sticker.packId());
574 final var stickerId = sticker.stickerId();
575
576 final var stickerPack = context.getAccount().getStickerStore().getStickerPack(packId);
577 if (stickerPack == null) {
578 throw new InvalidStickerException("Sticker pack not found");
579 }
580 final var manifest = context.getStickerHelper().getOrRetrieveStickerPack(packId, stickerPack.getPackKey());
581 if (manifest.stickers().size() <= stickerId) {
582 throw new InvalidStickerException("Sticker id not part of this pack");
583 }
584 final var manifestSticker = manifest.stickers().get(stickerId);
585 final var streamDetails = context.getStickerPackStore().retrieveSticker(packId, stickerId);
586 if (streamDetails == null) {
587 throw new InvalidStickerException("Missing local sticker file");
588 }
589 messageBuilder.withSticker(new SignalServiceDataMessage.Sticker(packId.serialize(),
590 stickerPack.getPackKey(),
591 stickerId,
592 manifestSticker.emoji(),
593 AttachmentUtils.createAttachmentStream(streamDetails, Optional.empty())));
594 }
595 if (message.previews().size() > 0) {
596 final var previews = new ArrayList<SignalServicePreview>(message.previews().size());
597 for (final var p : message.previews()) {
598 final var image = p.image().isPresent() ? context.getAttachmentHelper()
599 .uploadAttachment(p.image().get()) : null;
600 previews.add(new SignalServicePreview(p.url(),
601 p.title(),
602 p.description(),
603 0,
604 Optional.ofNullable(image)));
605 }
606 messageBuilder.withPreviews(previews);
607 }
608 }
609
610 private ArrayList<SignalServiceDataMessage.Mention> resolveMentions(final List<Message.Mention> mentionList) throws UnregisteredRecipientException {
611 final var mentions = new ArrayList<SignalServiceDataMessage.Mention>();
612 for (final var m : mentionList) {
613 final var recipientId = context.getRecipientHelper().resolveRecipient(m.recipient());
614 mentions.add(new SignalServiceDataMessage.Mention(context.getRecipientHelper()
615 .resolveSignalServiceAddress(recipientId)
616 .getServiceId(), m.start(), m.length()));
617 }
618 return mentions;
619 }
620
621 @Override
622 public SendMessageResults sendRemoteDeleteMessage(
623 long targetSentTimestamp, Set<RecipientIdentifier> recipients
624 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
625 var delete = new SignalServiceDataMessage.RemoteDelete(targetSentTimestamp);
626 final var messageBuilder = SignalServiceDataMessage.newBuilder().withRemoteDelete(delete);
627 for (final var recipient : recipients) {
628 if (recipient instanceof RecipientIdentifier.Single r) {
629 try {
630 final var recipientId = context.getRecipientHelper().resolveRecipient(r);
631 account.getMessageSendLogStore().deleteEntryForRecipientNonGroup(targetSentTimestamp, recipientId);
632 } catch (UnregisteredRecipientException ignored) {
633 }
634 } else if (recipient instanceof RecipientIdentifier.Group r) {
635 account.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp, r.groupId());
636 }
637 }
638 return sendMessage(messageBuilder, recipients);
639 }
640
641 @Override
642 public SendMessageResults sendMessageReaction(
643 String emoji,
644 boolean remove,
645 RecipientIdentifier.Single targetAuthor,
646 long targetSentTimestamp,
647 Set<RecipientIdentifier> recipients
648 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException {
649 var targetAuthorRecipientId = context.getRecipientHelper().resolveRecipient(targetAuthor);
650 var reaction = new SignalServiceDataMessage.Reaction(emoji,
651 remove,
652 context.getRecipientHelper().resolveSignalServiceAddress(targetAuthorRecipientId),
653 targetSentTimestamp);
654 final var messageBuilder = SignalServiceDataMessage.newBuilder().withReaction(reaction);
655 return sendMessage(messageBuilder, recipients);
656 }
657
658 @Override
659 public SendMessageResults sendPaymentNotificationMessage(
660 byte[] receipt, String note, RecipientIdentifier.Single recipient
661 ) throws IOException {
662 final var paymentNotification = new SignalServiceDataMessage.PaymentNotification(receipt, note);
663 final var payment = new SignalServiceDataMessage.Payment(paymentNotification);
664 final var messageBuilder = SignalServiceDataMessage.newBuilder().withPayment(payment);
665 try {
666 return sendMessage(messageBuilder, Set.of(recipient));
667 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
668 throw new AssertionError(e);
669 }
670 }
671
672 @Override
673 public SendMessageResults sendEndSessionMessage(Set<RecipientIdentifier.Single> recipients) throws IOException {
674 var messageBuilder = SignalServiceDataMessage.newBuilder().asEndSessionMessage();
675
676 try {
677 return sendMessage(messageBuilder,
678 recipients.stream().map(RecipientIdentifier.class::cast).collect(Collectors.toSet()));
679 } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
680 throw new AssertionError(e);
681 } finally {
682 for (var recipient : recipients) {
683 final RecipientId recipientId;
684 try {
685 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
686 } catch (UnregisteredRecipientException e) {
687 continue;
688 }
689 account.getSessionStore().deleteAllSessions(recipientId);
690 }
691 }
692 }
693
694 @Override
695 public void deleteRecipient(final RecipientIdentifier.Single recipient) {
696 account.removeRecipient(account.getRecipientResolver().resolveRecipient(recipient.toPartialRecipientAddress()));
697 }
698
699 @Override
700 public void deleteContact(final RecipientIdentifier.Single recipient) {
701 account.getContactStore()
702 .deleteContact(account.getRecipientResolver().resolveRecipient(recipient.toPartialRecipientAddress()));
703 }
704
705 @Override
706 public void setContactName(
707 RecipientIdentifier.Single recipient, String name
708 ) throws NotPrimaryDeviceException, UnregisteredRecipientException {
709 if (!account.isPrimaryDevice()) {
710 throw new NotPrimaryDeviceException();
711 }
712 context.getContactHelper().setContactName(context.getRecipientHelper().resolveRecipient(recipient), name);
713 }
714
715 @Override
716 public void setContactsBlocked(
717 Collection<RecipientIdentifier.Single> recipients, boolean blocked
718 ) throws NotPrimaryDeviceException, IOException, UnregisteredRecipientException {
719 if (!account.isPrimaryDevice()) {
720 throw new NotPrimaryDeviceException();
721 }
722 if (recipients.size() == 0) {
723 return;
724 }
725 final var recipientIds = context.getRecipientHelper().resolveRecipients(recipients);
726 final var selfRecipientId = account.getSelfRecipientId();
727 boolean shouldRotateProfileKey = false;
728 for (final var recipientId : recipientIds) {
729 if (context.getContactHelper().isContactBlocked(recipientId) == blocked) {
730 continue;
731 }
732 context.getContactHelper().setContactBlocked(recipientId, blocked);
733 // if we don't have a common group with the blocked contact we need to rotate the profile key
734 shouldRotateProfileKey = blocked && (
735 shouldRotateProfileKey || account.getGroupStore()
736 .getGroups()
737 .stream()
738 .noneMatch(g -> g.isMember(selfRecipientId) && g.isMember(recipientId))
739 );
740 }
741 if (shouldRotateProfileKey) {
742 context.getProfileHelper().rotateProfileKey();
743 }
744 context.getSyncHelper().sendBlockedList();
745 }
746
747 @Override
748 public void setGroupsBlocked(
749 final Collection<GroupId> groupIds, final boolean blocked
750 ) throws GroupNotFoundException, NotPrimaryDeviceException, IOException {
751 if (!account.isPrimaryDevice()) {
752 throw new NotPrimaryDeviceException();
753 }
754 if (groupIds.size() == 0) {
755 return;
756 }
757 boolean shouldRotateProfileKey = false;
758 for (final var groupId : groupIds) {
759 if (context.getGroupHelper().isGroupBlocked(groupId) == blocked) {
760 continue;
761 }
762 context.getGroupHelper().setGroupBlocked(groupId, blocked);
763 shouldRotateProfileKey = blocked;
764 }
765 if (shouldRotateProfileKey) {
766 context.getProfileHelper().rotateProfileKey();
767 }
768 context.getSyncHelper().sendBlockedList();
769 }
770
771 @Override
772 public void setExpirationTimer(
773 RecipientIdentifier.Single recipient, int messageExpirationTimer
774 ) throws IOException, UnregisteredRecipientException {
775 var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
776 context.getContactHelper().setExpirationTimer(recipientId, messageExpirationTimer);
777 final var messageBuilder = SignalServiceDataMessage.newBuilder().asExpirationUpdate();
778 try {
779 sendMessage(messageBuilder, Set.of(recipient));
780 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
781 throw new AssertionError(e);
782 }
783 }
784
785 @Override
786 public StickerPackUrl uploadStickerPack(File path) throws IOException, StickerPackInvalidException {
787 var manifest = StickerUtils.getSignalServiceStickerManifestUpload(path);
788
789 var messageSender = dependencies.getMessageSender();
790
791 var packKey = KeyUtils.createStickerUploadKey();
792 var packIdString = messageSender.uploadStickerManifest(manifest, packKey);
793 var packId = StickerPackId.deserialize(Hex.fromStringCondensed(packIdString));
794
795 var sticker = new Sticker(packId, packKey);
796 account.getStickerStore().updateSticker(sticker);
797
798 return new StickerPackUrl(packId, packKey);
799 }
800
801 @Override
802 public List<StickerPack> getStickerPacks() {
803 final var stickerPackStore = context.getStickerPackStore();
804 return account.getStickerStore().getStickerPacks().stream().map(pack -> {
805 if (stickerPackStore.existsStickerPack(pack.getPackId())) {
806 try {
807 final var manifest = stickerPackStore.retrieveManifest(pack.getPackId());
808 return new StickerPack(pack.getPackId(),
809 new StickerPackUrl(pack.getPackId(), pack.getPackKey()),
810 pack.isInstalled(),
811 manifest.title(),
812 manifest.author(),
813 Optional.ofNullable(manifest.cover() == null ? null : manifest.cover().toApi()),
814 manifest.stickers().stream().map(JsonStickerPack.JsonSticker::toApi).toList());
815 } catch (Exception e) {
816 logger.warn("Failed to read local sticker pack manifest: {}", e.getMessage(), e);
817 }
818 }
819
820 return new StickerPack(pack.getPackId(), pack.getPackKey(), pack.isInstalled());
821 }).toList();
822 }
823
824 @Override
825 public void requestAllSyncData() throws IOException {
826 context.getSyncHelper().requestAllSyncData();
827 retrieveRemoteStorage();
828 }
829
830 void retrieveRemoteStorage() throws IOException {
831 if (account.getStorageKey() != null) {
832 context.getStorageHelper().readDataFromStorage();
833 }
834 }
835
836 @Override
837 public void addReceiveHandler(final ReceiveMessageHandler handler, final boolean isWeakListener) {
838 if (isReceivingSynchronous) {
839 throw new IllegalStateException("Already receiving message synchronously.");
840 }
841 synchronized (messageHandlers) {
842 if (isWeakListener) {
843 weakHandlers.add(handler);
844 } else {
845 messageHandlers.add(handler);
846 startReceiveThreadIfRequired();
847 }
848 }
849 }
850
851 private static final AtomicInteger threadNumber = new AtomicInteger(0);
852
853 private void startReceiveThreadIfRequired() {
854 if (receiveThread != null) {
855 return;
856 }
857 receiveThread = new Thread(() -> {
858 logger.debug("Starting receiving messages");
859 context.getReceiveHelper().receiveMessagesContinuously((envelope, e) -> {
860 synchronized (messageHandlers) {
861 Stream.concat(messageHandlers.stream(), weakHandlers.stream()).forEach(h -> {
862 try {
863 h.handleMessage(envelope, e);
864 } catch (Throwable ex) {
865 logger.warn("Message handler failed, ignoring", ex);
866 }
867 });
868 }
869 });
870 logger.debug("Finished receiving messages");
871 synchronized (messageHandlers) {
872 receiveThread = null;
873
874 // Check if in the meantime another handler has been registered
875 if (!messageHandlers.isEmpty()) {
876 logger.debug("Another handler has been registered, starting receive thread again");
877 startReceiveThreadIfRequired();
878 }
879 }
880 });
881 receiveThread.setName("receive-" + threadNumber.getAndIncrement());
882
883 receiveThread.start();
884 }
885
886 @Override
887 public void removeReceiveHandler(final ReceiveMessageHandler handler) {
888 final Thread thread;
889 synchronized (messageHandlers) {
890 weakHandlers.remove(handler);
891 messageHandlers.remove(handler);
892 if (!messageHandlers.isEmpty() || receiveThread == null || isReceivingSynchronous) {
893 return;
894 }
895 thread = receiveThread;
896 receiveThread = null;
897 }
898
899 stopReceiveThread(thread);
900 }
901
902 private void stopReceiveThread(final Thread thread) {
903 if (context.getReceiveHelper().requestStopReceiveMessages()) {
904 logger.debug("Receive stop requested, interrupting read from server.");
905 thread.interrupt();
906 }
907 try {
908 thread.join();
909 } catch (InterruptedException ignored) {
910 }
911 }
912
913 @Override
914 public boolean isReceiving() {
915 if (isReceivingSynchronous) {
916 return true;
917 }
918 synchronized (messageHandlers) {
919 return messageHandlers.size() > 0;
920 }
921 }
922
923 @Override
924 public void receiveMessages(Duration timeout, ReceiveMessageHandler handler) throws IOException {
925 receiveMessages(timeout, true, handler);
926 }
927
928 @Override
929 public void receiveMessages(ReceiveMessageHandler handler) throws IOException {
930 receiveMessages(Duration.ofMinutes(1), false, handler);
931 }
932
933 private void receiveMessages(
934 Duration timeout, boolean returnOnTimeout, ReceiveMessageHandler handler
935 ) throws IOException {
936 if (isReceiving()) {
937 throw new IllegalStateException("Already receiving message.");
938 }
939 isReceivingSynchronous = true;
940 receiveThread = Thread.currentThread();
941 try {
942 context.getReceiveHelper().receiveMessages(timeout, returnOnTimeout, handler);
943 } finally {
944 receiveThread = null;
945 isReceivingSynchronous = false;
946 }
947 }
948
949 @Override
950 public void setIgnoreAttachments(final boolean ignoreAttachments) {
951 context.getReceiveHelper().setIgnoreAttachments(ignoreAttachments);
952 }
953
954 @Override
955 public boolean hasCaughtUpWithOldMessages() {
956 return context.getReceiveHelper().hasCaughtUpWithOldMessages();
957 }
958
959 @Override
960 public boolean isContactBlocked(final RecipientIdentifier.Single recipient) {
961 final RecipientId recipientId;
962 try {
963 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
964 } catch (UnregisteredRecipientException e) {
965 return false;
966 }
967 return context.getContactHelper().isContactBlocked(recipientId);
968 }
969
970 @Override
971 public void sendContacts() throws IOException {
972 context.getSyncHelper().sendContacts();
973 }
974
975 @Override
976 public List<Recipient> getRecipients(
977 boolean onlyContacts,
978 Optional<Boolean> blocked,
979 Collection<RecipientIdentifier.Single> recipients,
980 Optional<String> name
981 ) {
982 final var recipientIds = recipients.stream().map(a -> {
983 try {
984 return context.getRecipientHelper().resolveRecipient(a);
985 } catch (UnregisteredRecipientException e) {
986 return null;
987 }
988 }).filter(Objects::nonNull).collect(Collectors.toSet());
989 // refresh profiles of explicitly given recipients
990 context.getProfileHelper().refreshRecipientProfiles(recipientIds);
991 return account.getRecipientStore().getRecipients(onlyContacts, blocked, recipientIds, name);
992 }
993
994 @Override
995 public String getContactOrProfileName(RecipientIdentifier.Single recipient) {
996 final RecipientId recipientId;
997 try {
998 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
999 } catch (UnregisteredRecipientException e) {
1000 return null;
1001 }
1002
1003 final var contact = account.getContactStore().getContact(recipientId);
1004 if (contact != null && !Util.isEmpty(contact.getName())) {
1005 return contact.getName();
1006 }
1007
1008 final var profile = context.getProfileHelper().getRecipientProfile(recipientId);
1009 if (profile != null) {
1010 return profile.getDisplayName();
1011 }
1012
1013 return null;
1014 }
1015
1016 @Override
1017 public Group getGroup(GroupId groupId) {
1018 return toGroup(context.getGroupHelper().getGroup(groupId));
1019 }
1020
1021 @Override
1022 public List<Identity> getIdentities() {
1023 return account.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity).toList();
1024 }
1025
1026 private Identity toIdentity(final IdentityInfo identityInfo) {
1027 if (identityInfo == null) {
1028 return null;
1029 }
1030
1031 final var address = account.getRecipientAddressResolver()
1032 .resolveRecipientAddress(identityInfo.getRecipientId());
1033 final var scannableFingerprint = context.getIdentityHelper()
1034 .computeSafetyNumberForScanning(identityInfo.getRecipientId(), identityInfo.getIdentityKey());
1035 return new Identity(address,
1036 identityInfo.getIdentityKey(),
1037 context.getIdentityHelper()
1038 .computeSafetyNumber(identityInfo.getRecipientId(), identityInfo.getIdentityKey()),
1039 scannableFingerprint == null ? null : scannableFingerprint.getSerialized(),
1040 identityInfo.getTrustLevel(),
1041 identityInfo.getDateAdded());
1042 }
1043
1044 @Override
1045 public List<Identity> getIdentities(RecipientIdentifier.Single recipient) {
1046 IdentityInfo identity;
1047 try {
1048 identity = account.getIdentityKeyStore()
1049 .getIdentity(context.getRecipientHelper().resolveRecipient(recipient));
1050 } catch (UnregisteredRecipientException e) {
1051 identity = null;
1052 }
1053 return identity == null ? List.of() : List.of(toIdentity(identity));
1054 }
1055
1056 @Override
1057 public boolean trustIdentityVerified(
1058 RecipientIdentifier.Single recipient, byte[] fingerprint
1059 ) throws UnregisteredRecipientException {
1060 return trustIdentity(recipient, r -> context.getIdentityHelper().trustIdentityVerified(r, fingerprint));
1061 }
1062
1063 @Override
1064 public boolean trustIdentityVerifiedSafetyNumber(
1065 RecipientIdentifier.Single recipient, String safetyNumber
1066 ) throws UnregisteredRecipientException {
1067 return trustIdentity(recipient,
1068 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber));
1069 }
1070
1071 @Override
1072 public boolean trustIdentityVerifiedSafetyNumber(
1073 RecipientIdentifier.Single recipient, byte[] safetyNumber
1074 ) throws UnregisteredRecipientException {
1075 return trustIdentity(recipient,
1076 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber));
1077 }
1078
1079 @Override
1080 public boolean trustIdentityAllKeys(RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
1081 return trustIdentity(recipient, r -> context.getIdentityHelper().trustIdentityAllKeys(r));
1082 }
1083
1084 private boolean trustIdentity(
1085 RecipientIdentifier.Single recipient, Function<RecipientId, Boolean> trustMethod
1086 ) throws UnregisteredRecipientException {
1087 final var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1088 final var updated = trustMethod.apply(recipientId);
1089 if (updated && this.isReceiving()) {
1090 context.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1091 }
1092 return updated;
1093 }
1094
1095 @Override
1096 public void addAddressChangedListener(final Runnable listener) {
1097 synchronized (addressChangedListeners) {
1098 addressChangedListeners.add(listener);
1099 }
1100 }
1101
1102 @Override
1103 public void addClosedListener(final Runnable listener) {
1104 synchronized (closedListeners) {
1105 closedListeners.add(listener);
1106 }
1107 }
1108
1109 @Override
1110 public void close() {
1111 Thread thread;
1112 synchronized (messageHandlers) {
1113 weakHandlers.clear();
1114 messageHandlers.clear();
1115 thread = receiveThread;
1116 receiveThread = null;
1117 }
1118 if (thread != null) {
1119 stopReceiveThread(thread);
1120 }
1121 executor.shutdown();
1122
1123 dependencies.getSignalWebSocket().disconnect();
1124 disposable.dispose();
1125
1126 if (account != null) {
1127 account.close();
1128 }
1129
1130 synchronized (closedListeners) {
1131 closedListeners.forEach(Runnable::run);
1132 closedListeners.clear();
1133 }
1134
1135 account = null;
1136 }
1137 }