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