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