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