]> nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/internal/ManagerImpl.java
47a5bc031655b70162d9dcaa279e2842a8a6568b
[signal-cli] / lib / src / main / java / org / asamk / signal / manager / internal / 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.internal;
18
19 import org.asamk.signal.manager.Manager;
20 import org.asamk.signal.manager.api.AlreadyReceivingException;
21 import org.asamk.signal.manager.api.AttachmentInvalidException;
22 import org.asamk.signal.manager.api.CaptchaRejectedException;
23 import org.asamk.signal.manager.api.CaptchaRequiredException;
24 import org.asamk.signal.manager.api.Configuration;
25 import org.asamk.signal.manager.api.Device;
26 import org.asamk.signal.manager.api.DeviceLinkUrl;
27 import org.asamk.signal.manager.api.Group;
28 import org.asamk.signal.manager.api.GroupId;
29 import org.asamk.signal.manager.api.GroupInviteLinkUrl;
30 import org.asamk.signal.manager.api.GroupNotFoundException;
31 import org.asamk.signal.manager.api.GroupSendingNotAllowedException;
32 import org.asamk.signal.manager.api.Identity;
33 import org.asamk.signal.manager.api.IdentityVerificationCode;
34 import org.asamk.signal.manager.api.InactiveGroupLinkException;
35 import org.asamk.signal.manager.api.IncorrectPinException;
36 import org.asamk.signal.manager.api.InvalidDeviceLinkException;
37 import org.asamk.signal.manager.api.InvalidStickerException;
38 import org.asamk.signal.manager.api.InvalidUsernameException;
39 import org.asamk.signal.manager.api.LastGroupAdminException;
40 import org.asamk.signal.manager.api.Message;
41 import org.asamk.signal.manager.api.MessageEnvelope;
42 import org.asamk.signal.manager.api.MessageEnvelope.Sync.MessageRequestResponse;
43 import org.asamk.signal.manager.api.NonNormalizedPhoneNumberException;
44 import org.asamk.signal.manager.api.NotAGroupMemberException;
45 import org.asamk.signal.manager.api.NotPrimaryDeviceException;
46 import org.asamk.signal.manager.api.Pair;
47 import org.asamk.signal.manager.api.PendingAdminApprovalException;
48 import org.asamk.signal.manager.api.PhoneNumberSharingMode;
49 import org.asamk.signal.manager.api.PinLockedException;
50 import org.asamk.signal.manager.api.Profile;
51 import org.asamk.signal.manager.api.RateLimitException;
52 import org.asamk.signal.manager.api.ReceiveConfig;
53 import org.asamk.signal.manager.api.Recipient;
54 import org.asamk.signal.manager.api.RecipientIdentifier;
55 import org.asamk.signal.manager.api.SendGroupMessageResults;
56 import org.asamk.signal.manager.api.SendMessageResult;
57 import org.asamk.signal.manager.api.SendMessageResults;
58 import org.asamk.signal.manager.api.StickerPackId;
59 import org.asamk.signal.manager.api.StickerPackInvalidException;
60 import org.asamk.signal.manager.api.StickerPackUrl;
61 import org.asamk.signal.manager.api.TextStyle;
62 import org.asamk.signal.manager.api.TypingAction;
63 import org.asamk.signal.manager.api.UnregisteredRecipientException;
64 import org.asamk.signal.manager.api.UpdateGroup;
65 import org.asamk.signal.manager.api.UpdateProfile;
66 import org.asamk.signal.manager.api.UserStatus;
67 import org.asamk.signal.manager.api.UsernameLinkUrl;
68 import org.asamk.signal.manager.api.VerificationMethodNotAvailableException;
69 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
70 import org.asamk.signal.manager.helper.AccountFileUpdater;
71 import org.asamk.signal.manager.helper.Context;
72 import org.asamk.signal.manager.helper.RecipientHelper.RegisteredUser;
73 import org.asamk.signal.manager.jobs.RefreshRecipientsJob;
74 import org.asamk.signal.manager.jobs.SyncStorageJob;
75 import org.asamk.signal.manager.storage.AttachmentStore;
76 import org.asamk.signal.manager.storage.AvatarStore;
77 import org.asamk.signal.manager.storage.SignalAccount;
78 import org.asamk.signal.manager.storage.groups.GroupInfo;
79 import org.asamk.signal.manager.storage.identities.IdentityInfo;
80 import org.asamk.signal.manager.storage.recipients.RecipientAddress;
81 import org.asamk.signal.manager.storage.recipients.RecipientId;
82 import org.asamk.signal.manager.storage.stickerPacks.JsonStickerPack;
83 import org.asamk.signal.manager.storage.stickerPacks.StickerPackStore;
84 import org.asamk.signal.manager.storage.stickers.StickerPack;
85 import org.asamk.signal.manager.util.AttachmentUtils;
86 import org.asamk.signal.manager.util.KeyUtils;
87 import org.asamk.signal.manager.util.MimeUtils;
88 import org.asamk.signal.manager.util.StickerUtils;
89 import org.signal.libsignal.protocol.InvalidMessageException;
90 import org.signal.libsignal.usernames.BaseUsernameException;
91 import org.slf4j.Logger;
92 import org.slf4j.LoggerFactory;
93 import org.whispersystems.signalservice.api.SignalSessionLock;
94 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
95 import org.whispersystems.signalservice.api.messages.SignalServicePreview;
96 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
97 import org.whispersystems.signalservice.api.messages.SignalServiceTypingMessage;
98 import org.whispersystems.signalservice.api.push.ServiceId;
99 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
100 import org.whispersystems.signalservice.api.push.ServiceIdType;
101 import org.whispersystems.signalservice.api.push.exceptions.CdsiResourceExhaustedException;
102 import org.whispersystems.signalservice.api.util.DeviceNameUtil;
103 import org.whispersystems.signalservice.api.util.InvalidNumberException;
104 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
105 import org.whispersystems.signalservice.api.util.StreamDetails;
106 import org.whispersystems.signalservice.internal.util.Hex;
107 import org.whispersystems.signalservice.internal.util.Util;
108
109 import java.io.ByteArrayInputStream;
110 import java.io.File;
111 import java.io.FileNotFoundException;
112 import java.io.IOException;
113 import java.io.InputStream;
114 import java.nio.charset.StandardCharsets;
115 import java.time.Duration;
116 import java.util.ArrayList;
117 import java.util.Collection;
118 import java.util.HashMap;
119 import java.util.HashSet;
120 import java.util.List;
121 import java.util.Map;
122 import java.util.Objects;
123 import java.util.Optional;
124 import java.util.Set;
125 import java.util.concurrent.ExecutorService;
126 import java.util.concurrent.Executors;
127 import java.util.concurrent.TimeUnit;
128 import java.util.concurrent.atomic.AtomicInteger;
129 import java.util.concurrent.locks.ReentrantLock;
130 import java.util.function.Function;
131 import java.util.stream.Collectors;
132 import java.util.stream.Stream;
133
134 import io.reactivex.rxjava3.disposables.CompositeDisposable;
135 import io.reactivex.rxjava3.schedulers.Schedulers;
136
137 public class ManagerImpl implements Manager {
138
139 private static final Logger logger = LoggerFactory.getLogger(ManagerImpl.class);
140
141 private SignalAccount account;
142 private final SignalDependencies dependencies;
143 private final Context context;
144
145 private final ExecutorService executor = Executors.newCachedThreadPool();
146
147 private Thread receiveThread;
148 private boolean isReceivingSynchronous;
149 private final Set<ReceiveMessageHandler> weakHandlers = new HashSet<>();
150 private final Set<ReceiveMessageHandler> messageHandlers = new HashSet<>();
151 private final List<Runnable> closedListeners = new ArrayList<>();
152 private final List<Runnable> addressChangedListeners = new ArrayList<>();
153 private final CompositeDisposable disposable = new CompositeDisposable();
154
155 public ManagerImpl(
156 SignalAccount account,
157 PathConfig pathConfig,
158 AccountFileUpdater accountFileUpdater,
159 ServiceEnvironmentConfig serviceEnvironmentConfig,
160 String userAgent
161 ) {
162 this.account = account;
163
164 final var sessionLock = new SignalSessionLock() {
165 private final ReentrantLock LEGACY_LOCK = new ReentrantLock();
166
167 @Override
168 public Lock acquire() {
169 LEGACY_LOCK.lock();
170 return LEGACY_LOCK::unlock;
171 }
172 };
173 this.dependencies = new SignalDependencies(serviceEnvironmentConfig,
174 userAgent,
175 account.getCredentialsProvider(),
176 account.getSignalServiceDataStore(),
177 executor,
178 sessionLock);
179 final var avatarStore = new AvatarStore(pathConfig.avatarsPath());
180 final var attachmentStore = new AttachmentStore(pathConfig.attachmentsPath());
181 final var stickerPackStore = new StickerPackStore(pathConfig.stickerPacksPath());
182
183 this.context = new Context(account, new AccountFileUpdater() {
184 @Override
185 public void updateAccountIdentifiers(final String number, final ACI aci) {
186 accountFileUpdater.updateAccountIdentifiers(number, aci);
187 synchronized (addressChangedListeners) {
188 addressChangedListeners.forEach(Runnable::run);
189 }
190 }
191
192 @Override
193 public void removeAccount() {
194 accountFileUpdater.removeAccount();
195 }
196 }, dependencies, avatarStore, attachmentStore, stickerPackStore);
197 this.context.getAccountHelper().setUnregisteredListener(this::close);
198 this.context.getReceiveHelper().setAuthenticationFailureListener(this::close);
199 this.context.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
200 synchronized (this) {
201 this.notifyAll();
202 }
203 });
204 disposable.add(account.getIdentityKeyStore()
205 .getIdentityChanges()
206 .observeOn(Schedulers.from(executor))
207 .subscribe(serviceId -> {
208 logger.trace("Archiving old sessions for {}", serviceId);
209 account.getAccountData(ServiceIdType.ACI).getSessionStore().archiveSessions(serviceId);
210 account.getAccountData(ServiceIdType.PNI).getSessionStore().archiveSessions(serviceId);
211 account.getSenderKeyStore().deleteSharedWith(serviceId);
212 final var recipientId = account.getRecipientResolver().resolveRecipient(serviceId);
213 final var profile = account.getProfileStore().getProfile(recipientId);
214 if (profile != null) {
215 account.getProfileStore()
216 .storeProfile(recipientId,
217 Profile.newBuilder(profile)
218 .withUnidentifiedAccessMode(Profile.UnidentifiedAccessMode.UNKNOWN)
219 .withLastUpdateTimestamp(0)
220 .build());
221 }
222 }));
223 }
224
225 @Override
226 public String getSelfNumber() {
227 return account.getNumber();
228 }
229
230 public void checkAccountState() throws IOException {
231 context.getAccountHelper().checkAccountState();
232 final var lastRecipientsRefresh = account.getLastRecipientsRefresh();
233 if (lastRecipientsRefresh == null
234 || lastRecipientsRefresh < System.currentTimeMillis() - TimeUnit.DAYS.toMillis(1)) {
235 context.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
236 context.getAccountHelper().checkWhoAmiI();
237 }
238 }
239
240 @Override
241 public Map<String, UserStatus> getUserStatus(Set<String> numbers) throws IOException, RateLimitException {
242 final var canonicalizedNumbers = numbers.stream().collect(Collectors.toMap(n -> n, n -> {
243 try {
244 final var canonicalizedNumber = PhoneNumberFormatter.formatNumber(n, account.getNumber());
245 if (!canonicalizedNumber.equals(n)) {
246 logger.debug("Normalized number {} to {}.", n, canonicalizedNumber);
247 }
248 return canonicalizedNumber;
249 } catch (InvalidNumberException e) {
250 return "";
251 }
252 }));
253
254 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
255 final var canonicalizedNumbersSet = canonicalizedNumbers.values()
256 .stream()
257 .filter(s -> !s.isEmpty())
258 .collect(Collectors.toSet());
259
260 final Map<String, RegisteredUser> registeredUsers;
261 try {
262 registeredUsers = context.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet);
263 } catch (CdsiResourceExhaustedException e) {
264 logger.debug("CDSI resource exhausted: {}", e.getMessage());
265 throw new RateLimitException(System.currentTimeMillis() + e.getRetryAfterSeconds() * 1000L);
266 }
267
268 return numbers.stream().collect(Collectors.toMap(n -> n, n -> {
269 final var number = canonicalizedNumbers.get(n);
270 final var user = registeredUsers.get(number);
271 final var serviceId = user == null ? null : user.getServiceId();
272 final var profile = serviceId == null
273 ? null
274 : context.getProfileHelper()
275 .getRecipientProfile(account.getRecipientResolver().resolveRecipient(serviceId));
276 return new UserStatus(number.isEmpty() ? null : number,
277 serviceId == null ? null : serviceId.getRawUuid(),
278 profile != null
279 && profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.UNRESTRICTED);
280 }));
281 }
282
283 @Override
284 public void updateAccountAttributes(
285 String deviceName,
286 Boolean unrestrictedUnidentifiedSender,
287 final Boolean discoverableByNumber,
288 final Boolean numberSharing
289 ) throws IOException {
290 if (deviceName != null) {
291 context.getAccountHelper().setDeviceName(deviceName);
292 }
293 if (unrestrictedUnidentifiedSender != null) {
294 account.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender);
295 }
296 if (discoverableByNumber != null) {
297 account.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber);
298 }
299 if (numberSharing != null) {
300 account.getConfigurationStore()
301 .setPhoneNumberSharingMode(numberSharing
302 ? PhoneNumberSharingMode.EVERYBODY
303 : PhoneNumberSharingMode.NOBODY);
304 }
305 context.getAccountHelper().updateAccountAttributes();
306 context.getAccountHelper().checkWhoAmiI();
307 }
308
309 @Override
310 public Configuration getConfiguration() {
311 final var configurationStore = account.getConfigurationStore();
312 return Configuration.from(configurationStore);
313 }
314
315 @Override
316 public void updateConfiguration(Configuration configuration) {
317 final var configurationStore = account.getConfigurationStore();
318 if (configuration.readReceipts().isPresent()) {
319 configurationStore.setReadReceipts(configuration.readReceipts().get());
320 }
321 if (configuration.unidentifiedDeliveryIndicators().isPresent()) {
322 configurationStore.setUnidentifiedDeliveryIndicators(configuration.unidentifiedDeliveryIndicators().get());
323 }
324 if (configuration.typingIndicators().isPresent()) {
325 configurationStore.setTypingIndicators(configuration.typingIndicators().get());
326 }
327 if (configuration.linkPreviews().isPresent()) {
328 configurationStore.setLinkPreviews(configuration.linkPreviews().get());
329 }
330 context.getSyncHelper().sendConfigurationMessage();
331 syncRemoteStorage();
332 }
333
334 @Override
335 public void updateProfile(UpdateProfile updateProfile) throws IOException {
336 context.getProfileHelper()
337 .setProfile(updateProfile.getGivenName(),
338 updateProfile.getFamilyName(),
339 updateProfile.getAbout(),
340 updateProfile.getAboutEmoji(),
341 updateProfile.isDeleteAvatar()
342 ? Optional.empty()
343 : updateProfile.getAvatar() == null ? null : Optional.of(updateProfile.getAvatar()),
344 updateProfile.getMobileCoinAddress());
345 context.getSyncHelper().sendSyncFetchProfileMessage();
346 }
347
348 void refreshCurrentUsername() throws IOException, BaseUsernameException {
349 context.getAccountHelper().refreshCurrentUsername();
350 }
351
352 @Override
353 public String getUsername() {
354 return account.getUsername();
355 }
356
357 @Override
358 public UsernameLinkUrl getUsernameLink() {
359 return new UsernameLinkUrl(account.getUsernameLink());
360 }
361
362 @Override
363 public void setUsername(final String username) throws IOException, InvalidUsernameException {
364 try {
365 if (username.contains(".")) {
366 context.getAccountHelper().reserveExactUsername(username);
367 } else {
368 context.getAccountHelper().reserveUsernameFromNickname(username);
369 }
370 } catch (BaseUsernameException e) {
371 throw new InvalidUsernameException(e.getMessage() + " (" + e.getClass().getSimpleName() + ")", e);
372 }
373 }
374
375 @Override
376 public void deleteUsername() throws IOException {
377 context.getAccountHelper().deleteUsername();
378 }
379
380 @Override
381 public void startChangeNumber(
382 String newNumber, boolean voiceVerification, String captcha
383 ) throws RateLimitException, IOException, CaptchaRequiredException, NonNormalizedPhoneNumberException, NotPrimaryDeviceException, VerificationMethodNotAvailableException {
384 if (!account.isPrimaryDevice()) {
385 throw new NotPrimaryDeviceException();
386 }
387 context.getAccountHelper().startChangeNumber(newNumber, voiceVerification, captcha);
388 }
389
390 @Override
391 public void finishChangeNumber(
392 String newNumber, String verificationCode, String pin
393 ) throws IncorrectPinException, PinLockedException, IOException, NotPrimaryDeviceException {
394 if (!account.isPrimaryDevice()) {
395 throw new NotPrimaryDeviceException();
396 }
397 context.getAccountHelper().finishChangeNumber(newNumber, verificationCode, pin);
398 }
399
400 @Override
401 public void unregister() throws IOException {
402 context.getAccountHelper().unregister();
403 }
404
405 @Override
406 public void deleteAccount() throws IOException {
407 context.getAccountHelper().deleteAccount();
408 }
409
410 @Override
411 public void submitRateLimitRecaptchaChallenge(
412 String challenge, String captcha
413 ) throws IOException, CaptchaRejectedException {
414 captcha = captcha == null ? null : captcha.replace("signalcaptcha://", "");
415
416 try {
417 dependencies.getAccountManager().submitRateLimitRecaptchaChallenge(challenge, captcha);
418 } catch (org.whispersystems.signalservice.api.push.exceptions.CaptchaRejectedException ignored) {
419 throw new CaptchaRejectedException();
420 }
421 }
422
423 @Override
424 public List<Device> getLinkedDevices() throws IOException {
425 var devices = dependencies.getAccountManager().getDevices();
426 account.setMultiDevice(devices.size() > 1);
427 var identityKey = account.getAciIdentityKeyPair().getPrivateKey();
428 return devices.stream().map(d -> {
429 String deviceName = d.getName();
430 if (deviceName != null) {
431 try {
432 deviceName = DeviceNameUtil.decryptDeviceName(deviceName, identityKey);
433 } catch (IOException e) {
434 logger.debug("Failed to decrypt device name, maybe plain text?", e);
435 }
436 }
437 return new Device(d.getId(),
438 deviceName,
439 d.getCreated(),
440 d.getLastSeen(),
441 d.getId() == account.getDeviceId());
442 }).toList();
443 }
444
445 @Override
446 public void removeLinkedDevices(int deviceId) throws IOException, NotPrimaryDeviceException {
447 if (!account.isPrimaryDevice()) {
448 throw new NotPrimaryDeviceException();
449 }
450 context.getAccountHelper().removeLinkedDevices(deviceId);
451 }
452
453 @Override
454 public void addDeviceLink(DeviceLinkUrl linkUrl) throws IOException, InvalidDeviceLinkException, NotPrimaryDeviceException {
455 if (!account.isPrimaryDevice()) {
456 throw new NotPrimaryDeviceException();
457 }
458 context.getAccountHelper().addDevice(linkUrl);
459 }
460
461 @Override
462 public void setRegistrationLockPin(Optional<String> pin) throws IOException, NotPrimaryDeviceException {
463 if (!account.isPrimaryDevice()) {
464 throw new NotPrimaryDeviceException();
465 }
466 if (pin.isPresent()) {
467 context.getAccountHelper().setRegistrationPin(pin.get());
468 } else {
469 context.getAccountHelper().removeRegistrationPin();
470 }
471 }
472
473 void refreshPreKeys() throws IOException {
474 context.getPreKeyHelper().refreshPreKeysIfNecessary();
475 }
476
477 @Override
478 public List<Group> getGroups() {
479 return account.getGroupStore().getGroups().stream().map(this::toGroup).toList();
480 }
481
482 private Group toGroup(final GroupInfo groupInfo) {
483 if (groupInfo == null) {
484 return null;
485 }
486
487 return Group.from(groupInfo, account.getRecipientAddressResolver(), account.getSelfRecipientId());
488 }
489
490 @Override
491 public SendGroupMessageResults quitGroup(
492 GroupId groupId, Set<RecipientIdentifier.Single> groupAdmins
493 ) throws GroupNotFoundException, IOException, NotAGroupMemberException, LastGroupAdminException, UnregisteredRecipientException {
494 final var newAdmins = context.getRecipientHelper().resolveRecipients(groupAdmins);
495 return context.getGroupHelper().quitGroup(groupId, newAdmins);
496 }
497
498 @Override
499 public void deleteGroup(GroupId groupId) throws IOException {
500 final var group = context.getGroupHelper().getGroup(groupId);
501 if (group.isMember(account.getSelfRecipientId())) {
502 throw new IOException(
503 "The local group information cannot be removed, as the user is still a member of the group");
504 }
505 context.getGroupHelper().deleteGroup(groupId);
506 }
507
508 @Override
509 public Pair<GroupId, SendGroupMessageResults> createGroup(
510 String name, Set<RecipientIdentifier.Single> members, String avatarFile
511 ) throws IOException, AttachmentInvalidException, UnregisteredRecipientException {
512 return context.getGroupHelper()
513 .createGroup(name,
514 members == null ? null : context.getRecipientHelper().resolveRecipients(members),
515 avatarFile);
516 }
517
518 @Override
519 public SendGroupMessageResults updateGroup(
520 final GroupId groupId, final UpdateGroup updateGroup
521 ) throws IOException, GroupNotFoundException, AttachmentInvalidException, NotAGroupMemberException, GroupSendingNotAllowedException, UnregisteredRecipientException {
522 return context.getGroupHelper()
523 .updateGroup(groupId,
524 updateGroup.getName(),
525 updateGroup.getDescription(),
526 updateGroup.getMembers() == null
527 ? null
528 : context.getRecipientHelper().resolveRecipients(updateGroup.getMembers()),
529 updateGroup.getRemoveMembers() == null
530 ? null
531 : context.getRecipientHelper().resolveRecipients(updateGroup.getRemoveMembers()),
532 updateGroup.getAdmins() == null
533 ? null
534 : context.getRecipientHelper().resolveRecipients(updateGroup.getAdmins()),
535 updateGroup.getRemoveAdmins() == null
536 ? null
537 : context.getRecipientHelper().resolveRecipients(updateGroup.getRemoveAdmins()),
538 updateGroup.getBanMembers() == null
539 ? null
540 : context.getRecipientHelper().resolveRecipients(updateGroup.getBanMembers()),
541 updateGroup.getUnbanMembers() == null
542 ? null
543 : context.getRecipientHelper().resolveRecipients(updateGroup.getUnbanMembers()),
544 updateGroup.isResetGroupLink(),
545 updateGroup.getGroupLinkState(),
546 updateGroup.getAddMemberPermission(),
547 updateGroup.getEditDetailsPermission(),
548 updateGroup.getAvatarFile(),
549 updateGroup.getExpirationTimer(),
550 updateGroup.getIsAnnouncementGroup());
551 }
552
553 @Override
554 public Pair<GroupId, SendGroupMessageResults> joinGroup(
555 GroupInviteLinkUrl inviteLinkUrl
556 ) throws IOException, InactiveGroupLinkException, PendingAdminApprovalException {
557 return context.getGroupHelper().joinGroup(inviteLinkUrl);
558 }
559
560 private SendMessageResults sendMessage(
561 SignalServiceDataMessage.Builder messageBuilder, Set<RecipientIdentifier> recipients, boolean notifySelf
562 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
563 return sendMessage(messageBuilder, recipients, notifySelf, Optional.empty());
564 }
565
566 private SendMessageResults sendMessage(
567 SignalServiceDataMessage.Builder messageBuilder,
568 Set<RecipientIdentifier> recipients,
569 boolean notifySelf,
570 Optional<Long> editTargetTimestamp
571 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
572 var results = new HashMap<RecipientIdentifier, List<SendMessageResult>>();
573 long timestamp = System.currentTimeMillis();
574 messageBuilder.withTimestamp(timestamp);
575 for (final var recipient : recipients) {
576 if (recipient instanceof RecipientIdentifier.NoteToSelf || (
577 recipient instanceof RecipientIdentifier.Single single
578 && new RecipientAddress(single.toPartialRecipientAddress()).matches(account.getSelfRecipientAddress())
579 )) {
580 final var result = notifySelf
581 ? context.getSendHelper()
582 .sendMessage(messageBuilder, account.getSelfRecipientId(), editTargetTimestamp)
583 : context.getSendHelper().sendSelfMessage(messageBuilder, editTargetTimestamp);
584 results.put(recipient, List.of(toSendMessageResult(result)));
585 } else if (recipient instanceof RecipientIdentifier.Single single) {
586 try {
587 final var recipientId = context.getRecipientHelper().resolveRecipient(single);
588 final var result = context.getSendHelper()
589 .sendMessage(messageBuilder, recipientId, editTargetTimestamp);
590 results.put(recipient, List.of(toSendMessageResult(result)));
591 } catch (UnregisteredRecipientException e) {
592 results.put(recipient,
593 List.of(SendMessageResult.unregisteredFailure(single.toPartialRecipientAddress())));
594 }
595 } else if (recipient instanceof RecipientIdentifier.Group group) {
596 final var result = context.getSendHelper()
597 .sendAsGroupMessage(messageBuilder, group.groupId(), notifySelf, editTargetTimestamp);
598 results.put(recipient, result.stream().map(this::toSendMessageResult).toList());
599 }
600 }
601 return new SendMessageResults(timestamp, results);
602 }
603
604 private SendMessageResult toSendMessageResult(final org.whispersystems.signalservice.api.messages.SendMessageResult result) {
605 return SendMessageResult.from(result, account.getRecipientResolver(), account.getRecipientAddressResolver());
606 }
607
608 private SendMessageResults sendTypingMessage(
609 SignalServiceTypingMessage.Action action, Set<RecipientIdentifier> recipients
610 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
611 var results = new HashMap<RecipientIdentifier, List<SendMessageResult>>();
612 final var timestamp = System.currentTimeMillis();
613 for (var recipient : recipients) {
614 if (recipient instanceof RecipientIdentifier.Single single) {
615 final var message = new SignalServiceTypingMessage(action, timestamp, Optional.empty());
616 try {
617 final var recipientId = context.getRecipientHelper().resolveRecipient(single);
618 final var result = context.getSendHelper().sendTypingMessage(message, recipientId);
619 results.put(recipient, List.of(toSendMessageResult(result)));
620 } catch (UnregisteredRecipientException e) {
621 results.put(recipient,
622 List.of(SendMessageResult.unregisteredFailure(single.toPartialRecipientAddress())));
623 }
624 } else if (recipient instanceof RecipientIdentifier.Group) {
625 final var groupId = ((RecipientIdentifier.Group) recipient).groupId();
626 final var message = new SignalServiceTypingMessage(action, timestamp, Optional.of(groupId.serialize()));
627 final var result = context.getSendHelper().sendGroupTypingMessage(message, groupId);
628 results.put(recipient, result.stream().map(this::toSendMessageResult).toList());
629 }
630 }
631 return new SendMessageResults(timestamp, results);
632 }
633
634 @Override
635 public SendMessageResults sendTypingMessage(
636 TypingAction action, Set<RecipientIdentifier> recipients
637 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
638 return sendTypingMessage(action.toSignalService(), recipients);
639 }
640
641 @Override
642 public SendMessageResults sendReadReceipt(
643 RecipientIdentifier.Single sender, List<Long> messageIds
644 ) {
645 final var timestamp = System.currentTimeMillis();
646 var receiptMessage = new SignalServiceReceiptMessage(SignalServiceReceiptMessage.Type.READ,
647 messageIds,
648 timestamp);
649
650 return sendReceiptMessage(sender, timestamp, receiptMessage);
651 }
652
653 @Override
654 public SendMessageResults sendViewedReceipt(
655 RecipientIdentifier.Single sender, List<Long> messageIds
656 ) {
657 final var timestamp = System.currentTimeMillis();
658 var receiptMessage = new SignalServiceReceiptMessage(SignalServiceReceiptMessage.Type.VIEWED,
659 messageIds,
660 timestamp);
661
662 return sendReceiptMessage(sender, timestamp, receiptMessage);
663 }
664
665 private SendMessageResults sendReceiptMessage(
666 final RecipientIdentifier.Single sender,
667 final long timestamp,
668 final SignalServiceReceiptMessage receiptMessage
669 ) {
670 try {
671 final var result = context.getSendHelper()
672 .sendReceiptMessage(receiptMessage, context.getRecipientHelper().resolveRecipient(sender));
673 return new SendMessageResults(timestamp, Map.of(sender, List.of(toSendMessageResult(result))));
674 } catch (UnregisteredRecipientException e) {
675 return new SendMessageResults(timestamp,
676 Map.of(sender, List.of(SendMessageResult.unregisteredFailure(sender.toPartialRecipientAddress()))));
677 }
678 }
679
680 @Override
681 public SendMessageResults sendMessage(
682 Message message, Set<RecipientIdentifier> recipients, boolean notifySelf
683 ) throws IOException, AttachmentInvalidException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException, InvalidStickerException {
684 final var selfProfile = context.getProfileHelper().getSelfProfile();
685 if (selfProfile == null || selfProfile.getDisplayName().isEmpty()) {
686 logger.warn(
687 "No profile name set. When sending a message it's recommended to set a profile name with the updateProfile command. This may become mandatory in the future.");
688 }
689 final var messageBuilder = SignalServiceDataMessage.newBuilder();
690 applyMessage(messageBuilder, message);
691 return sendMessage(messageBuilder, recipients, notifySelf);
692 }
693
694 @Override
695 public SendMessageResults sendEditMessage(
696 Message message, Set<RecipientIdentifier> recipients, long editTargetTimestamp
697 ) throws IOException, AttachmentInvalidException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException, InvalidStickerException {
698 final var messageBuilder = SignalServiceDataMessage.newBuilder();
699 applyMessage(messageBuilder, message);
700 return sendMessage(messageBuilder, recipients, false, Optional.of(editTargetTimestamp));
701 }
702
703 private void applyMessage(
704 final SignalServiceDataMessage.Builder messageBuilder, final Message message
705 ) throws AttachmentInvalidException, IOException, UnregisteredRecipientException, InvalidStickerException {
706 if (message.messageText().length() > 2000) {
707 final var messageBytes = message.messageText().getBytes(StandardCharsets.UTF_8);
708 final var textAttachment = AttachmentUtils.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
709 messageBytes), MimeUtils.LONG_TEXT, messageBytes.length), Optional.empty());
710 messageBuilder.withBody(message.messageText().substring(0, 2000));
711 messageBuilder.withAttachment(context.getAttachmentHelper().uploadAttachment(textAttachment));
712 } else {
713 messageBuilder.withBody(message.messageText());
714 }
715 if (!message.attachments().isEmpty()) {
716 messageBuilder.withAttachments(context.getAttachmentHelper().uploadAttachments(message.attachments()));
717 }
718 if (!message.mentions().isEmpty()) {
719 messageBuilder.withMentions(resolveMentions(message.mentions()));
720 }
721 if (!message.textStyles().isEmpty()) {
722 messageBuilder.withBodyRanges(message.textStyles().stream().map(TextStyle::toBodyRange).toList());
723 }
724 if (message.quote().isPresent()) {
725 final var quote = message.quote().get();
726 final var quotedAttachments = new ArrayList<SignalServiceDataMessage.Quote.QuotedAttachment>();
727 for (final var a : quote.attachments()) {
728 final var quotedAttachment = new SignalServiceDataMessage.Quote.QuotedAttachment(a.contentType(),
729 a.filename(),
730 a.preview() == null ? null : context.getAttachmentHelper().uploadAttachment(a.preview()));
731 quotedAttachments.add(quotedAttachment);
732 }
733 messageBuilder.withQuote(new SignalServiceDataMessage.Quote(quote.timestamp(),
734 context.getRecipientHelper()
735 .resolveSignalServiceAddress(context.getRecipientHelper().resolveRecipient(quote.author()))
736 .getServiceId(),
737 quote.message(),
738 quotedAttachments,
739 resolveMentions(quote.mentions()),
740 SignalServiceDataMessage.Quote.Type.NORMAL,
741 quote.textStyles().stream().map(TextStyle::toBodyRange).toList()));
742 }
743 if (message.sticker().isPresent()) {
744 final var sticker = message.sticker().get();
745 final var packId = StickerPackId.deserialize(sticker.packId());
746 final var stickerId = sticker.stickerId();
747
748 final var stickerPack = context.getAccount().getStickerStore().getStickerPack(packId);
749 if (stickerPack == null) {
750 throw new InvalidStickerException("Sticker pack not found");
751 }
752 final var manifest = context.getStickerHelper().getOrRetrieveStickerPack(packId, stickerPack.packKey());
753 if (manifest.stickers().size() <= stickerId) {
754 throw new InvalidStickerException("Sticker id not part of this pack");
755 }
756 final var manifestSticker = manifest.stickers().get(stickerId);
757 final var streamDetails = context.getStickerPackStore().retrieveSticker(packId, stickerId);
758 if (streamDetails == null) {
759 throw new InvalidStickerException("Missing local sticker file");
760 }
761 messageBuilder.withSticker(new SignalServiceDataMessage.Sticker(packId.serialize(),
762 stickerPack.packKey(),
763 stickerId,
764 manifestSticker.emoji(),
765 AttachmentUtils.createAttachmentStream(streamDetails, Optional.empty())));
766 }
767 if (!message.previews().isEmpty()) {
768 final var previews = new ArrayList<SignalServicePreview>(message.previews().size());
769 for (final var p : message.previews()) {
770 final var image = p.image().isPresent() ? context.getAttachmentHelper()
771 .uploadAttachment(p.image().get()) : null;
772 previews.add(new SignalServicePreview(p.url(),
773 p.title(),
774 p.description(),
775 0,
776 Optional.ofNullable(image)));
777 }
778 messageBuilder.withPreviews(previews);
779 }
780 if (message.storyReply().isPresent()) {
781 final var storyReply = message.storyReply().get();
782 final var authorServiceId = context.getRecipientHelper()
783 .resolveSignalServiceAddress(context.getRecipientHelper().resolveRecipient(storyReply.author()))
784 .getServiceId();
785 messageBuilder.withStoryContext(new SignalServiceDataMessage.StoryContext(authorServiceId,
786 storyReply.timestamp()));
787 }
788 }
789
790 private ArrayList<SignalServiceDataMessage.Mention> resolveMentions(final List<Message.Mention> mentionList) throws UnregisteredRecipientException {
791 final var mentions = new ArrayList<SignalServiceDataMessage.Mention>();
792 for (final var m : mentionList) {
793 final var recipientId = context.getRecipientHelper().resolveRecipient(m.recipient());
794 mentions.add(new SignalServiceDataMessage.Mention(context.getRecipientHelper()
795 .resolveSignalServiceAddress(recipientId)
796 .getServiceId(), m.start(), m.length()));
797 }
798 return mentions;
799 }
800
801 @Override
802 public SendMessageResults sendRemoteDeleteMessage(
803 long targetSentTimestamp, Set<RecipientIdentifier> recipients
804 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
805 var delete = new SignalServiceDataMessage.RemoteDelete(targetSentTimestamp);
806 final var messageBuilder = SignalServiceDataMessage.newBuilder().withRemoteDelete(delete);
807 for (final var recipient : recipients) {
808 if (recipient instanceof RecipientIdentifier.Uuid u) {
809 account.getMessageSendLogStore()
810 .deleteEntryForRecipientNonGroup(targetSentTimestamp, ACI.from(u.uuid()));
811 } else if (recipient instanceof RecipientIdentifier.Single r) {
812 try {
813 final var recipientId = context.getRecipientHelper().resolveRecipient(r);
814 final var address = account.getRecipientAddressResolver().resolveRecipientAddress(recipientId);
815 if (address.serviceId().isPresent()) {
816 account.getMessageSendLogStore()
817 .deleteEntryForRecipientNonGroup(targetSentTimestamp, address.serviceId().get());
818 }
819 } catch (UnregisteredRecipientException ignored) {
820 }
821 } else if (recipient instanceof RecipientIdentifier.Group r) {
822 account.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp, r.groupId());
823 }
824 }
825 return sendMessage(messageBuilder, recipients, false);
826 }
827
828 @Override
829 public SendMessageResults sendMessageReaction(
830 String emoji,
831 boolean remove,
832 RecipientIdentifier.Single targetAuthor,
833 long targetSentTimestamp,
834 Set<RecipientIdentifier> recipients,
835 final boolean isStory
836 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException {
837 var targetAuthorRecipientId = context.getRecipientHelper().resolveRecipient(targetAuthor);
838 final var authorServiceId = context.getRecipientHelper()
839 .resolveSignalServiceAddress(targetAuthorRecipientId)
840 .getServiceId();
841 var reaction = new SignalServiceDataMessage.Reaction(emoji, remove, authorServiceId, targetSentTimestamp);
842 final var messageBuilder = SignalServiceDataMessage.newBuilder().withReaction(reaction);
843 if (isStory) {
844 messageBuilder.withStoryContext(new SignalServiceDataMessage.StoryContext(authorServiceId,
845 targetSentTimestamp));
846 }
847 return sendMessage(messageBuilder, recipients, false);
848 }
849
850 @Override
851 public SendMessageResults sendPaymentNotificationMessage(
852 byte[] receipt, String note, RecipientIdentifier.Single recipient
853 ) throws IOException {
854 final var paymentNotification = new SignalServiceDataMessage.PaymentNotification(receipt, note);
855 final var payment = new SignalServiceDataMessage.Payment(paymentNotification, null);
856 final var messageBuilder = SignalServiceDataMessage.newBuilder().withPayment(payment);
857 try {
858 return sendMessage(messageBuilder, Set.of(recipient), false);
859 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
860 throw new AssertionError(e);
861 }
862 }
863
864 @Override
865 public SendMessageResults sendEndSessionMessage(Set<RecipientIdentifier.Single> recipients) throws IOException {
866 var messageBuilder = SignalServiceDataMessage.newBuilder().asEndSessionMessage();
867
868 try {
869 return sendMessage(messageBuilder,
870 recipients.stream().map(RecipientIdentifier.class::cast).collect(Collectors.toSet()),
871 false);
872 } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
873 throw new AssertionError(e);
874 } finally {
875 for (var recipient : recipients) {
876 final RecipientId recipientId;
877 try {
878 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
879 } catch (UnregisteredRecipientException e) {
880 continue;
881 }
882 final var serviceId = context.getAccount()
883 .getRecipientAddressResolver()
884 .resolveRecipientAddress(recipientId)
885 .serviceId();
886 if (serviceId.isPresent()) {
887 account.getAccountData(ServiceIdType.ACI).getSessionStore().deleteAllSessions(serviceId.get());
888 }
889 }
890 }
891 }
892
893 @Override
894 public SendMessageResults sendMessageRequestResponse(
895 final MessageRequestResponse.Type type, final Set<RecipientIdentifier> recipients
896 ) {
897 var results = new HashMap<RecipientIdentifier, List<SendMessageResult>>();
898 for (final var recipient : recipients) {
899 if (recipient instanceof RecipientIdentifier.NoteToSelf || (
900 recipient instanceof RecipientIdentifier.Single single
901 && new RecipientAddress(single.toPartialRecipientAddress()).matches(account.getSelfRecipientAddress())
902 )) {
903 final var result = context.getSyncHelper()
904 .sendMessageRequestResponse(type, account.getSelfRecipientId());
905 if (result != null) {
906 results.put(recipient, List.of(toSendMessageResult(result)));
907 }
908 results.put(recipient, List.of(toSendMessageResult(result)));
909 } else if (recipient instanceof RecipientIdentifier.Single single) {
910 try {
911 final var recipientId = context.getRecipientHelper().resolveRecipient(single);
912 final var result = context.getSyncHelper().sendMessageRequestResponse(type, recipientId);
913 if (result != null) {
914 results.put(recipient, List.of(toSendMessageResult(result)));
915 }
916 } catch (UnregisteredRecipientException e) {
917 results.put(recipient,
918 List.of(SendMessageResult.unregisteredFailure(single.toPartialRecipientAddress())));
919 }
920 } else if (recipient instanceof RecipientIdentifier.Group group) {
921 final var result = context.getSyncHelper().sendMessageRequestResponse(type, group.groupId());
922 results.put(recipient, List.of(toSendMessageResult(result)));
923 }
924 }
925 return new SendMessageResults(0, results);
926 }
927
928 @Override
929 public void hideRecipient(final RecipientIdentifier.Single recipient) {
930 final var recipientIdOptional = context.getRecipientHelper().resolveRecipientOptional(recipient);
931 if (recipientIdOptional.isPresent()) {
932 context.getContactHelper().setContactHidden(recipientIdOptional.get(), true);
933 account.removeRecipient(recipientIdOptional.get());
934 syncRemoteStorage();
935 }
936 }
937
938 @Override
939 public void deleteRecipient(final RecipientIdentifier.Single recipient) {
940 final var recipientIdOptional = context.getRecipientHelper().resolveRecipientOptional(recipient);
941 if (recipientIdOptional.isPresent()) {
942 account.removeRecipient(recipientIdOptional.get());
943 syncRemoteStorage();
944 }
945 }
946
947 @Override
948 public void deleteContact(final RecipientIdentifier.Single recipient) {
949 final var recipientIdOptional = context.getRecipientHelper().resolveRecipientOptional(recipient);
950 if (recipientIdOptional.isPresent()) {
951 account.getContactStore().deleteContact(recipientIdOptional.get());
952 syncRemoteStorage();
953 }
954 }
955
956 @Override
957 public void setContactName(
958 RecipientIdentifier.Single recipient, String givenName, final String familyName
959 ) throws NotPrimaryDeviceException, UnregisteredRecipientException {
960 if (!account.isPrimaryDevice()) {
961 throw new NotPrimaryDeviceException();
962 }
963 context.getContactHelper()
964 .setContactName(context.getRecipientHelper().resolveRecipient(recipient), givenName, familyName);
965 syncRemoteStorage();
966 }
967
968 @Override
969 public void setContactsBlocked(
970 Collection<RecipientIdentifier.Single> recipients, boolean blocked
971 ) throws IOException, UnregisteredRecipientException {
972 if (recipients.isEmpty()) {
973 return;
974 }
975 final var recipientIds = context.getRecipientHelper().resolveRecipients(recipients);
976 final var selfRecipientId = account.getSelfRecipientId();
977 boolean shouldRotateProfileKey = false;
978 for (final var recipientId : recipientIds) {
979 if (context.getContactHelper().isContactBlocked(recipientId) == blocked) {
980 continue;
981 }
982 context.getContactHelper().setContactBlocked(recipientId, blocked);
983 context.getSyncHelper()
984 .sendMessageRequestResponse(blocked
985 ? MessageRequestResponse.Type.BLOCK
986 : MessageRequestResponse.Type.UNBLOCK_AND_ACCEPT, recipientId);
987 // if we don't have a common group with the blocked contact we need to rotate the profile key
988 shouldRotateProfileKey = blocked && (
989 shouldRotateProfileKey || account.getGroupStore()
990 .getGroups()
991 .stream()
992 .noneMatch(g -> g.isMember(selfRecipientId) && g.isMember(recipientId))
993 );
994 }
995 if (shouldRotateProfileKey) {
996 context.getProfileHelper().rotateProfileKey();
997 }
998 context.getSyncHelper().sendBlockedList();
999 syncRemoteStorage();
1000 }
1001
1002 @Override
1003 public void setGroupsBlocked(
1004 final Collection<GroupId> groupIds, final boolean blocked
1005 ) throws GroupNotFoundException, IOException {
1006 if (groupIds.isEmpty()) {
1007 return;
1008 }
1009 boolean shouldRotateProfileKey = false;
1010 for (final var groupId : groupIds) {
1011 if (context.getGroupHelper().isGroupBlocked(groupId) == blocked) {
1012 continue;
1013 }
1014 context.getGroupHelper().setGroupBlocked(groupId, blocked);
1015 context.getSyncHelper()
1016 .sendMessageRequestResponse(blocked
1017 ? MessageRequestResponse.Type.BLOCK
1018 : MessageRequestResponse.Type.UNBLOCK_AND_ACCEPT, groupId);
1019 shouldRotateProfileKey = blocked;
1020 }
1021 if (shouldRotateProfileKey) {
1022 context.getProfileHelper().rotateProfileKey();
1023 }
1024 context.getSyncHelper().sendBlockedList();
1025 syncRemoteStorage();
1026 }
1027
1028 @Override
1029 public void setExpirationTimer(
1030 RecipientIdentifier.Single recipient, int messageExpirationTimer
1031 ) throws IOException, UnregisteredRecipientException {
1032 var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1033 context.getContactHelper().setExpirationTimer(recipientId, messageExpirationTimer);
1034 final var messageBuilder = SignalServiceDataMessage.newBuilder().asExpirationUpdate();
1035 try {
1036 sendMessage(messageBuilder, Set.of(recipient), false);
1037 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
1038 throw new AssertionError(e);
1039 }
1040 syncRemoteStorage();
1041 }
1042
1043 @Override
1044 public StickerPackUrl uploadStickerPack(File path) throws IOException, StickerPackInvalidException {
1045 var manifest = StickerUtils.getSignalServiceStickerManifestUpload(path);
1046
1047 var messageSender = dependencies.getMessageSender();
1048
1049 var packKey = KeyUtils.createStickerUploadKey();
1050 var packIdString = messageSender.uploadStickerManifest(manifest, packKey);
1051 var packId = StickerPackId.deserialize(Hex.fromStringCondensed(packIdString));
1052
1053 var sticker = new StickerPack(packId, packKey);
1054 account.getStickerStore().addStickerPack(sticker);
1055 context.getSyncHelper().sendStickerOperationsMessage(List.of(sticker), List.of());
1056
1057 return new StickerPackUrl(packId, packKey);
1058 }
1059
1060 @Override
1061 public void installStickerPack(StickerPackUrl url) throws IOException {
1062 final var packId = url.packId();
1063 final var packKey = url.packKey();
1064 try {
1065 context.getStickerHelper().retrieveStickerPack(packId, packKey);
1066 } catch (InvalidMessageException e) {
1067 throw new IOException(e);
1068 }
1069
1070 final var sticker = context.getStickerHelper().addOrUpdateStickerPack(packId, packKey, true);
1071 context.getSyncHelper().sendStickerOperationsMessage(List.of(sticker), List.of());
1072 }
1073
1074 @Override
1075 public List<org.asamk.signal.manager.api.StickerPack> getStickerPacks() {
1076 final var stickerPackStore = context.getStickerPackStore();
1077 return account.getStickerStore().getStickerPacks().stream().map(pack -> {
1078 if (stickerPackStore.existsStickerPack(pack.packId())) {
1079 try {
1080 final var manifest = stickerPackStore.retrieveManifest(pack.packId());
1081 return new org.asamk.signal.manager.api.StickerPack(pack.packId(),
1082 new StickerPackUrl(pack.packId(), pack.packKey()),
1083 pack.isInstalled(),
1084 manifest.title(),
1085 manifest.author(),
1086 Optional.ofNullable(manifest.cover() == null ? null : manifest.cover().toApi()),
1087 manifest.stickers().stream().map(JsonStickerPack.JsonSticker::toApi).toList());
1088 } catch (Exception e) {
1089 logger.warn("Failed to read local sticker pack manifest: {}", e.getMessage(), e);
1090 }
1091 }
1092
1093 return new org.asamk.signal.manager.api.StickerPack(pack.packId(), pack.packKey(), pack.isInstalled());
1094 }).toList();
1095 }
1096
1097 @Override
1098 public void requestAllSyncData() {
1099 context.getSyncHelper().requestAllSyncData();
1100 syncRemoteStorage();
1101 }
1102
1103 void syncRemoteStorage() {
1104 context.getJobExecutor().enqueueJob(new SyncStorageJob());
1105 }
1106
1107 @Override
1108 public void addReceiveHandler(final ReceiveMessageHandler handler, final boolean isWeakListener) {
1109 synchronized (messageHandlers) {
1110 if (isWeakListener) {
1111 weakHandlers.add(handler);
1112 } else {
1113 messageHandlers.add(handler);
1114 startReceiveThreadIfRequired();
1115 }
1116 }
1117 }
1118
1119 private static final AtomicInteger threadNumber = new AtomicInteger(0);
1120
1121 private void startReceiveThreadIfRequired() {
1122 if (receiveThread != null || isReceivingSynchronous) {
1123 return;
1124 }
1125 receiveThread = Thread.ofPlatform().name("receive-" + threadNumber.getAndIncrement()).start(() -> {
1126 logger.debug("Starting receiving messages");
1127 context.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers);
1128 logger.debug("Finished receiving messages");
1129 synchronized (messageHandlers) {
1130 receiveThread = null;
1131
1132 // Check if in the meantime another handler has been registered
1133 if (!messageHandlers.isEmpty()) {
1134 logger.debug("Another handler has been registered, starting receive thread again");
1135 startReceiveThreadIfRequired();
1136 }
1137 }
1138 });
1139 }
1140
1141 private void passReceivedMessageToHandlers(MessageEnvelope envelope, Throwable e) {
1142 synchronized (messageHandlers) {
1143 Stream.concat(messageHandlers.stream(), weakHandlers.stream()).forEach(h -> {
1144 try {
1145 h.handleMessage(envelope, e);
1146 } catch (Throwable ex) {
1147 logger.warn("Message handler failed, ignoring", ex);
1148 }
1149 });
1150 }
1151 }
1152
1153 @Override
1154 public void removeReceiveHandler(final ReceiveMessageHandler handler) {
1155 final Thread thread;
1156 synchronized (messageHandlers) {
1157 weakHandlers.remove(handler);
1158 messageHandlers.remove(handler);
1159 if (!messageHandlers.isEmpty() || receiveThread == null || isReceivingSynchronous) {
1160 return;
1161 }
1162 thread = receiveThread;
1163 receiveThread = null;
1164 }
1165
1166 stopReceiveThread(thread);
1167 }
1168
1169 private void stopReceiveThread(final Thread thread) {
1170 if (context.getReceiveHelper().requestStopReceiveMessages()) {
1171 logger.debug("Receive stop requested, interrupting read from server.");
1172 thread.interrupt();
1173 }
1174 try {
1175 thread.join();
1176 } catch (InterruptedException ignored) {
1177 }
1178 }
1179
1180 @Override
1181 public boolean isReceiving() {
1182 if (isReceivingSynchronous) {
1183 return true;
1184 }
1185 synchronized (messageHandlers) {
1186 return !messageHandlers.isEmpty();
1187 }
1188 }
1189
1190 @Override
1191 public void receiveMessages(
1192 Optional<Duration> timeout, Optional<Integer> maxMessages, ReceiveMessageHandler handler
1193 ) throws IOException, AlreadyReceivingException {
1194 receiveMessages(timeout.orElse(Duration.ofMinutes(1)), timeout.isPresent(), maxMessages.orElse(null), handler);
1195 }
1196
1197 @Override
1198 public void stopReceiveMessages() {
1199 Thread thread = null;
1200 synchronized (messageHandlers) {
1201 if (isReceivingSynchronous) {
1202 thread = receiveThread;
1203 receiveThread = null;
1204 }
1205 }
1206 if (thread != null) {
1207 stopReceiveThread(thread);
1208 }
1209 }
1210
1211 private void receiveMessages(
1212 Duration timeout, boolean returnOnTimeout, Integer maxMessages, ReceiveMessageHandler handler
1213 ) throws IOException, AlreadyReceivingException {
1214 synchronized (messageHandlers) {
1215 if (isReceiving()) {
1216 throw new AlreadyReceivingException("Already receiving message.");
1217 }
1218 isReceivingSynchronous = true;
1219 receiveThread = Thread.currentThread();
1220 }
1221 try {
1222 context.getReceiveHelper().receiveMessages(timeout, returnOnTimeout, maxMessages, (envelope, e) -> {
1223 passReceivedMessageToHandlers(envelope, e);
1224 handler.handleMessage(envelope, e);
1225 });
1226 } finally {
1227 synchronized (messageHandlers) {
1228 receiveThread = null;
1229 isReceivingSynchronous = false;
1230 if (!messageHandlers.isEmpty()) {
1231 startReceiveThreadIfRequired();
1232 }
1233 }
1234 }
1235 }
1236
1237 @Override
1238 public void setReceiveConfig(final ReceiveConfig receiveConfig) {
1239 context.getReceiveHelper().setReceiveConfig(receiveConfig);
1240 }
1241
1242 @Override
1243 public boolean isContactBlocked(final RecipientIdentifier.Single recipient) {
1244 final RecipientId recipientId;
1245 try {
1246 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1247 } catch (UnregisteredRecipientException e) {
1248 return false;
1249 }
1250 return context.getContactHelper().isContactBlocked(recipientId);
1251 }
1252
1253 @Override
1254 public void sendContacts() throws IOException {
1255 context.getSyncHelper().sendContacts();
1256 }
1257
1258 @Override
1259 public List<Recipient> getRecipients(
1260 boolean onlyContacts,
1261 Optional<Boolean> blocked,
1262 Collection<RecipientIdentifier.Single> recipients,
1263 Optional<String> name
1264 ) {
1265 final var recipientIds = recipients.stream().map(a -> {
1266 try {
1267 return context.getRecipientHelper().resolveRecipient(a);
1268 } catch (UnregisteredRecipientException e) {
1269 return null;
1270 }
1271 }).filter(Objects::nonNull).collect(Collectors.toSet());
1272 if (!recipients.isEmpty() && recipientIds.isEmpty()) {
1273 return List.of();
1274 }
1275 // refresh profiles of explicitly given recipients
1276 context.getProfileHelper().refreshRecipientProfiles(recipientIds);
1277 return account.getRecipientStore()
1278 .getRecipients(onlyContacts, blocked, recipientIds, name)
1279 .stream()
1280 .map(s -> new Recipient(s.getRecipientId(),
1281 s.getAddress().toApiRecipientAddress(),
1282 s.getContact(),
1283 s.getProfileKey(),
1284 s.getExpiringProfileKeyCredential(),
1285 s.getProfile()))
1286 .toList();
1287 }
1288
1289 @Override
1290 public String getContactOrProfileName(RecipientIdentifier.Single recipient) {
1291 final RecipientId recipientId;
1292 try {
1293 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1294 } catch (UnregisteredRecipientException e) {
1295 return null;
1296 }
1297
1298 final var contact = account.getContactStore().getContact(recipientId);
1299 if (contact != null && !Util.isEmpty(contact.getName())) {
1300 return contact.getName();
1301 }
1302
1303 final var profile = context.getProfileHelper().getRecipientProfile(recipientId);
1304 if (profile != null) {
1305 return profile.getDisplayName();
1306 }
1307
1308 return null;
1309 }
1310
1311 @Override
1312 public Group getGroup(GroupId groupId) {
1313 return toGroup(context.getGroupHelper().getGroup(groupId));
1314 }
1315
1316 @Override
1317 public List<Identity> getIdentities() {
1318 return account.getIdentityKeyStore()
1319 .getIdentities()
1320 .stream()
1321 .map(this::toIdentity)
1322 .filter(Objects::nonNull)
1323 .toList();
1324 }
1325
1326 private Identity toIdentity(final IdentityInfo identityInfo) {
1327 if (identityInfo == null) {
1328 return null;
1329 }
1330
1331 final var address = account.getRecipientAddressResolver()
1332 .resolveRecipientAddress(account.getRecipientResolver().resolveRecipient(identityInfo.getServiceId()));
1333 if (address.serviceId().isPresent() && !Objects.equals(address.serviceId().get(),
1334 identityInfo.getServiceId())) {
1335 return null;
1336 }
1337 final var scannableFingerprint = context.getIdentityHelper()
1338 .computeSafetyNumberForScanning(identityInfo.getServiceId(), identityInfo.getIdentityKey());
1339 return new Identity(address.toApiRecipientAddress(),
1340 identityInfo.getIdentityKey(),
1341 context.getIdentityHelper()
1342 .computeSafetyNumber(identityInfo.getServiceId(), identityInfo.getIdentityKey()),
1343 scannableFingerprint == null ? null : scannableFingerprint.getSerialized(),
1344 identityInfo.getTrustLevel(),
1345 identityInfo.getDateAddedTimestamp());
1346 }
1347
1348 @Override
1349 public List<Identity> getIdentities(RecipientIdentifier.Single recipient) {
1350 ServiceId serviceId;
1351 try {
1352 final var address = account.getRecipientAddressResolver()
1353 .resolveRecipientAddress(context.getRecipientHelper().resolveRecipient(recipient));
1354 if (address.serviceId().isEmpty()) {
1355 return List.of();
1356 }
1357 serviceId = address.serviceId().get();
1358 } catch (UnregisteredRecipientException e) {
1359 return List.of();
1360 }
1361 final var identity = account.getIdentityKeyStore().getIdentityInfo(serviceId);
1362 return identity == null ? List.of() : List.of(toIdentity(identity));
1363 }
1364
1365 @Override
1366 public boolean trustIdentityVerified(
1367 RecipientIdentifier.Single recipient, IdentityVerificationCode verificationCode
1368 ) throws UnregisteredRecipientException {
1369 return switch (verificationCode) {
1370 case IdentityVerificationCode.Fingerprint fingerprint -> trustIdentity(recipient,
1371 r -> context.getIdentityHelper().trustIdentityVerified(r, fingerprint.fingerprint()));
1372 case IdentityVerificationCode.SafetyNumber safetyNumber -> trustIdentity(recipient,
1373 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber.safetyNumber()));
1374 case IdentityVerificationCode.ScannableSafetyNumber safetyNumber -> trustIdentity(recipient,
1375 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber.safetyNumber()));
1376 case null -> throw new AssertionError("Invalid verification code type");
1377 };
1378 }
1379
1380 @Override
1381 public boolean trustIdentityAllKeys(RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
1382 return trustIdentity(recipient, r -> context.getIdentityHelper().trustIdentityAllKeys(r));
1383 }
1384
1385 private boolean trustIdentity(
1386 RecipientIdentifier.Single recipient, Function<RecipientId, Boolean> trustMethod
1387 ) throws UnregisteredRecipientException {
1388 final var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1389 final var updated = trustMethod.apply(recipientId);
1390 if (updated && this.isReceiving()) {
1391 account.setNeedsToRetryFailedMessages(true);
1392 }
1393 return updated;
1394 }
1395
1396 @Override
1397 public void addAddressChangedListener(final Runnable listener) {
1398 synchronized (addressChangedListeners) {
1399 addressChangedListeners.add(listener);
1400 }
1401 }
1402
1403 @Override
1404 public void addClosedListener(final Runnable listener) {
1405 synchronized (closedListeners) {
1406 closedListeners.add(listener);
1407 }
1408 }
1409
1410 @Override
1411 public InputStream retrieveAttachment(final String id) throws IOException {
1412 return context.getAttachmentHelper().retrieveAttachment(id).getStream();
1413 }
1414
1415 @Override
1416 public InputStream retrieveContactAvatar(final RecipientIdentifier.Single recipient) throws IOException, UnregisteredRecipientException {
1417 final var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1418 final var address = account.getRecipientStore().resolveRecipientAddress(recipientId);
1419 final var streamDetails = context.getAvatarStore().retrieveContactAvatar(address);
1420 if (streamDetails == null) {
1421 throw new FileNotFoundException();
1422 }
1423 return streamDetails.getStream();
1424 }
1425
1426 @Override
1427 public InputStream retrieveProfileAvatar(final RecipientIdentifier.Single recipient) throws IOException, UnregisteredRecipientException {
1428 final var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1429 context.getProfileHelper().getRecipientProfile(recipientId);
1430 final var address = account.getRecipientStore().resolveRecipientAddress(recipientId);
1431 final var streamDetails = context.getAvatarStore().retrieveProfileAvatar(address);
1432 if (streamDetails == null) {
1433 throw new FileNotFoundException();
1434 }
1435 return streamDetails.getStream();
1436 }
1437
1438 @Override
1439 public InputStream retrieveGroupAvatar(final GroupId groupId) throws IOException {
1440 final var streamDetails = context.getAvatarStore().retrieveGroupAvatar(groupId);
1441 context.getGroupHelper().getGroup(groupId);
1442 if (streamDetails == null) {
1443 throw new FileNotFoundException();
1444 }
1445 return streamDetails.getStream();
1446 }
1447
1448 @Override
1449 public InputStream retrieveSticker(final StickerPackId stickerPackId, final int stickerId) throws IOException {
1450 var streamDetails = context.getStickerPackStore().retrieveSticker(stickerPackId, stickerId);
1451 if (streamDetails == null) {
1452 final var pack = account.getStickerStore().getStickerPack(stickerPackId);
1453 if (pack != null) {
1454 try {
1455 context.getStickerHelper().retrieveStickerPack(stickerPackId, pack.packKey());
1456 } catch (InvalidMessageException e) {
1457 logger.warn("Failed to download sticker pack");
1458 }
1459 }
1460 }
1461 if (streamDetails == null) {
1462 throw new FileNotFoundException();
1463 }
1464 return streamDetails.getStream();
1465 }
1466
1467 @Override
1468 public void close() {
1469 Thread thread;
1470 synchronized (messageHandlers) {
1471 weakHandlers.clear();
1472 messageHandlers.clear();
1473 thread = receiveThread;
1474 receiveThread = null;
1475 }
1476 if (thread != null) {
1477 stopReceiveThread(thread);
1478 }
1479 context.close();
1480 executor.close();
1481
1482 dependencies.getSignalWebSocket().disconnect();
1483 dependencies.getPushServiceSocket().close();
1484 disposable.dispose();
1485
1486 if (account != null) {
1487 account.close();
1488 }
1489
1490 synchronized (closedListeners) {
1491 closedListeners.forEach(Runnable::run);
1492 closedListeners.clear();
1493 }
1494
1495 account = null;
1496 }
1497 }