]> nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/ManagerImpl.java
Move sticker store to database
[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.StickerPackId;
36 import org.asamk.signal.manager.api.StickerPackInvalidException;
37 import org.asamk.signal.manager.api.StickerPackUrl;
38 import org.asamk.signal.manager.api.TypingAction;
39 import org.asamk.signal.manager.api.UnregisteredRecipientException;
40 import org.asamk.signal.manager.api.UpdateGroup;
41 import org.asamk.signal.manager.api.UpdateProfile;
42 import org.asamk.signal.manager.api.UserStatus;
43 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
44 import org.asamk.signal.manager.groups.GroupId;
45 import org.asamk.signal.manager.groups.GroupInviteLinkUrl;
46 import org.asamk.signal.manager.groups.GroupNotFoundException;
47 import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;
48 import org.asamk.signal.manager.groups.LastGroupAdminException;
49 import org.asamk.signal.manager.groups.NotAGroupMemberException;
50 import org.asamk.signal.manager.helper.AccountFileUpdater;
51 import org.asamk.signal.manager.helper.Context;
52 import org.asamk.signal.manager.storage.SignalAccount;
53 import org.asamk.signal.manager.storage.groups.GroupInfo;
54 import org.asamk.signal.manager.storage.identities.IdentityInfo;
55 import org.asamk.signal.manager.storage.recipients.Profile;
56 import org.asamk.signal.manager.storage.recipients.Recipient;
57 import org.asamk.signal.manager.storage.recipients.RecipientId;
58 import org.asamk.signal.manager.storage.stickerPacks.JsonStickerPack;
59 import org.asamk.signal.manager.storage.stickerPacks.StickerPackStore;
60 import org.asamk.signal.manager.storage.stickers.StickerPack;
61 import org.asamk.signal.manager.util.AttachmentUtils;
62 import org.asamk.signal.manager.util.KeyUtils;
63 import org.asamk.signal.manager.util.StickerUtils;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
66 import org.whispersystems.signalservice.api.SignalSessionLock;
67 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
68 import org.whispersystems.signalservice.api.messages.SignalServicePreview;
69 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
70 import org.whispersystems.signalservice.api.messages.SignalServiceTypingMessage;
71 import org.whispersystems.signalservice.api.push.ACI;
72 import org.whispersystems.signalservice.api.util.DeviceNameUtil;
73 import org.whispersystems.signalservice.api.util.InvalidNumberException;
74 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
75 import org.whispersystems.signalservice.internal.util.Hex;
76 import org.whispersystems.signalservice.internal.util.Util;
77
78 import java.io.File;
79 import java.io.IOException;
80 import java.net.URI;
81 import java.time.Duration;
82 import java.util.ArrayList;
83 import java.util.Collection;
84 import java.util.HashMap;
85 import java.util.HashSet;
86 import java.util.List;
87 import java.util.Map;
88 import java.util.Objects;
89 import java.util.Optional;
90 import java.util.Set;
91 import java.util.concurrent.ExecutorService;
92 import java.util.concurrent.Executors;
93 import java.util.concurrent.atomic.AtomicInteger;
94 import java.util.concurrent.locks.ReentrantLock;
95 import java.util.function.Function;
96 import java.util.stream.Collectors;
97 import java.util.stream.Stream;
98
99 import io.reactivex.rxjava3.disposables.CompositeDisposable;
100
101 class ManagerImpl implements Manager {
102
103 private final static Logger logger = LoggerFactory.getLogger(ManagerImpl.class);
104
105 private SignalAccount account;
106 private final SignalDependencies dependencies;
107 private final Context context;
108
109 private final ExecutorService executor = Executors.newCachedThreadPool();
110
111 private Thread receiveThread;
112 private boolean isReceivingSynchronous;
113 private final Set<ReceiveMessageHandler> weakHandlers = new HashSet<>();
114 private final Set<ReceiveMessageHandler> messageHandlers = new HashSet<>();
115 private final List<Runnable> closedListeners = new ArrayList<>();
116 private final List<Runnable> addressChangedListeners = new ArrayList<>();
117 private final CompositeDisposable disposable = new CompositeDisposable();
118
119 ManagerImpl(
120 SignalAccount account,
121 PathConfig pathConfig,
122 AccountFileUpdater accountFileUpdater,
123 ServiceEnvironmentConfig serviceEnvironmentConfig,
124 String userAgent
125 ) {
126 this.account = account;
127
128 final var sessionLock = new SignalSessionLock() {
129 private final ReentrantLock LEGACY_LOCK = new ReentrantLock();
130
131 @Override
132 public Lock acquire() {
133 LEGACY_LOCK.lock();
134 return LEGACY_LOCK::unlock;
135 }
136 };
137 this.dependencies = new SignalDependencies(serviceEnvironmentConfig,
138 userAgent,
139 account.getCredentialsProvider(),
140 account.getSignalServiceDataStore(),
141 executor,
142 sessionLock);
143 final var avatarStore = new AvatarStore(pathConfig.avatarsPath());
144 final var attachmentStore = new AttachmentStore(pathConfig.attachmentsPath());
145 final var stickerPackStore = new StickerPackStore(pathConfig.stickerPacksPath());
146
147 this.context = new Context(account, new AccountFileUpdater() {
148 @Override
149 public void updateAccountIdentifiers(final String number, final ACI aci) {
150 accountFileUpdater.updateAccountIdentifiers(number, aci);
151 synchronized (addressChangedListeners) {
152 addressChangedListeners.forEach(Runnable::run);
153 }
154 }
155
156 @Override
157 public void removeAccount() {
158 accountFileUpdater.removeAccount();
159 }
160 }, dependencies, avatarStore, attachmentStore, stickerPackStore);
161 this.context.getAccountHelper().setUnregisteredListener(this::close);
162 this.context.getReceiveHelper().setAuthenticationFailureListener(this::close);
163 this.context.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
164 synchronized (this) {
165 this.notifyAll();
166 }
167 });
168 disposable.add(account.getIdentityKeyStore().getIdentityChanges().subscribe(recipientId -> {
169 logger.trace("Archiving old sessions for {}", recipientId);
170 account.getSessionStore().archiveSessions(recipientId);
171 account.getSenderKeyStore().deleteSharedWith(recipientId);
172 final var profile = account.getProfileStore().getProfile(recipientId);
173 if (profile != null) {
174 account.getProfileStore()
175 .storeProfile(recipientId,
176 Profile.newBuilder(profile)
177 .withUnidentifiedAccessMode(Profile.UnidentifiedAccessMode.UNKNOWN)
178 .withLastUpdateTimestamp(0)
179 .build());
180 }
181 }));
182 }
183
184 @Override
185 public String getSelfNumber() {
186 return account.getNumber();
187 }
188
189 void checkAccountState() throws IOException {
190 context.getAccountHelper().checkAccountState();
191 }
192
193 @Override
194 public Map<String, UserStatus> getUserStatus(Set<String> numbers) throws IOException {
195 final var canonicalizedNumbers = numbers.stream().collect(Collectors.toMap(n -> n, n -> {
196 try {
197 final var canonicalizedNumber = PhoneNumberFormatter.formatNumber(n, account.getNumber());
198 if (!canonicalizedNumber.equals(n)) {
199 logger.debug("Normalized number {} to {}.", n, canonicalizedNumber);
200 }
201 return canonicalizedNumber;
202 } catch (InvalidNumberException e) {
203 return "";
204 }
205 }));
206
207 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
208 final var canonicalizedNumbersSet = canonicalizedNumbers.values()
209 .stream()
210 .filter(s -> !s.isEmpty())
211 .collect(Collectors.toSet());
212 final var registeredUsers = context.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet);
213
214 return numbers.stream().collect(Collectors.toMap(n -> n, n -> {
215 final var number = canonicalizedNumbers.get(n);
216 final var aci = registeredUsers.get(number);
217 final var profile = aci == null
218 ? null
219 : context.getProfileHelper()
220 .getRecipientProfile(account.getRecipientResolver().resolveRecipient(aci));
221 return new UserStatus(number.isEmpty() ? null : number,
222 aci == null ? null : aci.uuid(),
223 profile != null
224 && profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.UNRESTRICTED);
225 }));
226 }
227
228 @Override
229 public void updateAccountAttributes(String deviceName) throws IOException {
230 if (deviceName != null) {
231 context.getAccountHelper().setDeviceName(deviceName);
232 }
233 context.getAccountHelper().updateAccountAttributes();
234 context.getAccountHelper().checkWhoAmiI();
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 .getServiceId(),
568 quote.message(),
569 List.of(),
570 resolveMentions(quote.mentions()),
571 SignalServiceDataMessage.Quote.Type.NORMAL));
572 }
573 if (message.sticker().isPresent()) {
574 final var sticker = message.sticker().get();
575 final var packId = StickerPackId.deserialize(sticker.packId());
576 final var stickerId = sticker.stickerId();
577
578 final var stickerPack = context.getAccount().getStickerStore().getStickerPack(packId);
579 if (stickerPack == null) {
580 throw new InvalidStickerException("Sticker pack not found");
581 }
582 final var manifest = context.getStickerHelper().getOrRetrieveStickerPack(packId, stickerPack.packKey());
583 if (manifest.stickers().size() <= stickerId) {
584 throw new InvalidStickerException("Sticker id not part of this pack");
585 }
586 final var manifestSticker = manifest.stickers().get(stickerId);
587 final var streamDetails = context.getStickerPackStore().retrieveSticker(packId, stickerId);
588 if (streamDetails == null) {
589 throw new InvalidStickerException("Missing local sticker file");
590 }
591 messageBuilder.withSticker(new SignalServiceDataMessage.Sticker(packId.serialize(),
592 stickerPack.packKey(),
593 stickerId,
594 manifestSticker.emoji(),
595 AttachmentUtils.createAttachmentStream(streamDetails, Optional.empty())));
596 }
597 if (message.previews().size() > 0) {
598 final var previews = new ArrayList<SignalServicePreview>(message.previews().size());
599 for (final var p : message.previews()) {
600 final var image = p.image().isPresent() ? context.getAttachmentHelper()
601 .uploadAttachment(p.image().get()) : null;
602 previews.add(new SignalServicePreview(p.url(),
603 p.title(),
604 p.description(),
605 0,
606 Optional.ofNullable(image)));
607 }
608 messageBuilder.withPreviews(previews);
609 }
610 }
611
612 private ArrayList<SignalServiceDataMessage.Mention> resolveMentions(final List<Message.Mention> mentionList) throws UnregisteredRecipientException {
613 final var mentions = new ArrayList<SignalServiceDataMessage.Mention>();
614 for (final var m : mentionList) {
615 final var recipientId = context.getRecipientHelper().resolveRecipient(m.recipient());
616 mentions.add(new SignalServiceDataMessage.Mention(context.getRecipientHelper()
617 .resolveSignalServiceAddress(recipientId)
618 .getServiceId(), m.start(), m.length()));
619 }
620 return mentions;
621 }
622
623 @Override
624 public SendMessageResults sendRemoteDeleteMessage(
625 long targetSentTimestamp, Set<RecipientIdentifier> recipients
626 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
627 var delete = new SignalServiceDataMessage.RemoteDelete(targetSentTimestamp);
628 final var messageBuilder = SignalServiceDataMessage.newBuilder().withRemoteDelete(delete);
629 for (final var recipient : recipients) {
630 if (recipient instanceof RecipientIdentifier.Single r) {
631 try {
632 final var recipientId = context.getRecipientHelper().resolveRecipient(r);
633 account.getMessageSendLogStore().deleteEntryForRecipientNonGroup(targetSentTimestamp, recipientId);
634 } catch (UnregisteredRecipientException ignored) {
635 }
636 } else if (recipient instanceof RecipientIdentifier.Group r) {
637 account.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp, r.groupId());
638 }
639 }
640 return sendMessage(messageBuilder, recipients);
641 }
642
643 @Override
644 public SendMessageResults sendMessageReaction(
645 String emoji,
646 boolean remove,
647 RecipientIdentifier.Single targetAuthor,
648 long targetSentTimestamp,
649 Set<RecipientIdentifier> recipients
650 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException, UnregisteredRecipientException {
651 var targetAuthorRecipientId = context.getRecipientHelper().resolveRecipient(targetAuthor);
652 var reaction = new SignalServiceDataMessage.Reaction(emoji,
653 remove,
654 context.getRecipientHelper().resolveSignalServiceAddress(targetAuthorRecipientId).getServiceId(),
655 targetSentTimestamp);
656 final var messageBuilder = SignalServiceDataMessage.newBuilder().withReaction(reaction);
657 return sendMessage(messageBuilder, recipients);
658 }
659
660 @Override
661 public SendMessageResults sendPaymentNotificationMessage(
662 byte[] receipt, String note, RecipientIdentifier.Single recipient
663 ) throws IOException {
664 final var paymentNotification = new SignalServiceDataMessage.PaymentNotification(receipt, note);
665 final var payment = new SignalServiceDataMessage.Payment(paymentNotification);
666 final var messageBuilder = SignalServiceDataMessage.newBuilder().withPayment(payment);
667 try {
668 return sendMessage(messageBuilder, Set.of(recipient));
669 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
670 throw new AssertionError(e);
671 }
672 }
673
674 @Override
675 public SendMessageResults sendEndSessionMessage(Set<RecipientIdentifier.Single> recipients) throws IOException {
676 var messageBuilder = SignalServiceDataMessage.newBuilder().asEndSessionMessage();
677
678 try {
679 return sendMessage(messageBuilder,
680 recipients.stream().map(RecipientIdentifier.class::cast).collect(Collectors.toSet()));
681 } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
682 throw new AssertionError(e);
683 } finally {
684 for (var recipient : recipients) {
685 final RecipientId recipientId;
686 try {
687 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
688 } catch (UnregisteredRecipientException e) {
689 continue;
690 }
691 account.getSessionStore().deleteAllSessions(recipientId);
692 }
693 }
694 }
695
696 @Override
697 public void deleteRecipient(final RecipientIdentifier.Single recipient) {
698 account.removeRecipient(account.getRecipientResolver().resolveRecipient(recipient.toPartialRecipientAddress()));
699 }
700
701 @Override
702 public void deleteContact(final RecipientIdentifier.Single recipient) {
703 account.getContactStore()
704 .deleteContact(account.getRecipientResolver().resolveRecipient(recipient.toPartialRecipientAddress()));
705 }
706
707 @Override
708 public void setContactName(
709 RecipientIdentifier.Single recipient, String givenName, final String familyName
710 ) throws NotPrimaryDeviceException, UnregisteredRecipientException {
711 if (!account.isPrimaryDevice()) {
712 throw new NotPrimaryDeviceException();
713 }
714 context.getContactHelper()
715 .setContactName(context.getRecipientHelper().resolveRecipient(recipient), givenName, familyName);
716 }
717
718 @Override
719 public void setContactsBlocked(
720 Collection<RecipientIdentifier.Single> recipients, boolean blocked
721 ) throws NotPrimaryDeviceException, IOException, UnregisteredRecipientException {
722 if (!account.isPrimaryDevice()) {
723 throw new NotPrimaryDeviceException();
724 }
725 if (recipients.size() == 0) {
726 return;
727 }
728 final var recipientIds = context.getRecipientHelper().resolveRecipients(recipients);
729 final var selfRecipientId = account.getSelfRecipientId();
730 boolean shouldRotateProfileKey = false;
731 for (final var recipientId : recipientIds) {
732 if (context.getContactHelper().isContactBlocked(recipientId) == blocked) {
733 continue;
734 }
735 context.getContactHelper().setContactBlocked(recipientId, blocked);
736 // if we don't have a common group with the blocked contact we need to rotate the profile key
737 shouldRotateProfileKey = blocked && (
738 shouldRotateProfileKey || account.getGroupStore()
739 .getGroups()
740 .stream()
741 .noneMatch(g -> g.isMember(selfRecipientId) && g.isMember(recipientId))
742 );
743 }
744 if (shouldRotateProfileKey) {
745 context.getProfileHelper().rotateProfileKey();
746 }
747 context.getSyncHelper().sendBlockedList();
748 }
749
750 @Override
751 public void setGroupsBlocked(
752 final Collection<GroupId> groupIds, final boolean blocked
753 ) throws GroupNotFoundException, NotPrimaryDeviceException, IOException {
754 if (!account.isPrimaryDevice()) {
755 throw new NotPrimaryDeviceException();
756 }
757 if (groupIds.size() == 0) {
758 return;
759 }
760 boolean shouldRotateProfileKey = false;
761 for (final var groupId : groupIds) {
762 if (context.getGroupHelper().isGroupBlocked(groupId) == blocked) {
763 continue;
764 }
765 context.getGroupHelper().setGroupBlocked(groupId, blocked);
766 shouldRotateProfileKey = blocked;
767 }
768 if (shouldRotateProfileKey) {
769 context.getProfileHelper().rotateProfileKey();
770 }
771 context.getSyncHelper().sendBlockedList();
772 }
773
774 @Override
775 public void setExpirationTimer(
776 RecipientIdentifier.Single recipient, int messageExpirationTimer
777 ) throws IOException, UnregisteredRecipientException {
778 var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
779 context.getContactHelper().setExpirationTimer(recipientId, messageExpirationTimer);
780 final var messageBuilder = SignalServiceDataMessage.newBuilder().asExpirationUpdate();
781 try {
782 sendMessage(messageBuilder, Set.of(recipient));
783 } catch (NotAGroupMemberException | GroupNotFoundException | GroupSendingNotAllowedException e) {
784 throw new AssertionError(e);
785 }
786 }
787
788 @Override
789 public StickerPackUrl uploadStickerPack(File path) throws IOException, StickerPackInvalidException {
790 var manifest = StickerUtils.getSignalServiceStickerManifestUpload(path);
791
792 var messageSender = dependencies.getMessageSender();
793
794 var packKey = KeyUtils.createStickerUploadKey();
795 var packIdString = messageSender.uploadStickerManifest(manifest, packKey);
796 var packId = StickerPackId.deserialize(Hex.fromStringCondensed(packIdString));
797
798 var sticker = new StickerPack(packId, packKey);
799 account.getStickerStore().addStickerPack(sticker);
800
801 return new StickerPackUrl(packId, packKey);
802 }
803
804 @Override
805 public List<org.asamk.signal.manager.api.StickerPack> getStickerPacks() {
806 final var stickerPackStore = context.getStickerPackStore();
807 return account.getStickerStore().getStickerPacks().stream().map(pack -> {
808 if (stickerPackStore.existsStickerPack(pack.packId())) {
809 try {
810 final var manifest = stickerPackStore.retrieveManifest(pack.packId());
811 return new org.asamk.signal.manager.api.StickerPack(pack.packId(),
812 new StickerPackUrl(pack.packId(), pack.packKey()),
813 pack.isInstalled(),
814 manifest.title(),
815 manifest.author(),
816 Optional.ofNullable(manifest.cover() == null ? null : manifest.cover().toApi()),
817 manifest.stickers().stream().map(JsonStickerPack.JsonSticker::toApi).toList());
818 } catch (Exception e) {
819 logger.warn("Failed to read local sticker pack manifest: {}", e.getMessage(), e);
820 }
821 }
822
823 return new org.asamk.signal.manager.api.StickerPack(pack.packId(), pack.packKey(), pack.isInstalled());
824 }).toList();
825 }
826
827 @Override
828 public void requestAllSyncData() throws IOException {
829 context.getSyncHelper().requestAllSyncData();
830 retrieveRemoteStorage();
831 }
832
833 void retrieveRemoteStorage() throws IOException {
834 context.getStorageHelper().readDataFromStorage();
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 final var handlers = Stream.concat(messageHandlers.stream(), weakHandlers.stream()).toList();
863 handlers.forEach(h -> {
864 try {
865 h.handleMessage(envelope, e);
866 } catch (Throwable ex) {
867 logger.warn("Message handler failed, ignoring", ex);
868 }
869 });
870 }
871 });
872 logger.debug("Finished receiving messages");
873 synchronized (messageHandlers) {
874 receiveThread = null;
875
876 // Check if in the meantime another handler has been registered
877 if (!messageHandlers.isEmpty()) {
878 logger.debug("Another handler has been registered, starting receive thread again");
879 startReceiveThreadIfRequired();
880 }
881 }
882 });
883 receiveThread.setName("receive-" + threadNumber.getAndIncrement());
884
885 receiveThread.start();
886 }
887
888 @Override
889 public void removeReceiveHandler(final ReceiveMessageHandler handler) {
890 final Thread thread;
891 synchronized (messageHandlers) {
892 weakHandlers.remove(handler);
893 messageHandlers.remove(handler);
894 if (!messageHandlers.isEmpty() || receiveThread == null || isReceivingSynchronous) {
895 return;
896 }
897 thread = receiveThread;
898 receiveThread = null;
899 }
900
901 stopReceiveThread(thread);
902 }
903
904 private void stopReceiveThread(final Thread thread) {
905 if (context.getReceiveHelper().requestStopReceiveMessages()) {
906 logger.debug("Receive stop requested, interrupting read from server.");
907 thread.interrupt();
908 }
909 try {
910 thread.join();
911 } catch (InterruptedException ignored) {
912 }
913 }
914
915 @Override
916 public boolean isReceiving() {
917 if (isReceivingSynchronous) {
918 return true;
919 }
920 synchronized (messageHandlers) {
921 return messageHandlers.size() > 0;
922 }
923 }
924
925 @Override
926 public void receiveMessages(Duration timeout, ReceiveMessageHandler handler) throws IOException {
927 receiveMessages(timeout, true, handler);
928 }
929
930 @Override
931 public void receiveMessages(ReceiveMessageHandler handler) throws IOException {
932 receiveMessages(Duration.ofMinutes(1), false, handler);
933 }
934
935 private void receiveMessages(
936 Duration timeout, boolean returnOnTimeout, ReceiveMessageHandler handler
937 ) throws IOException {
938 if (isReceiving()) {
939 throw new IllegalStateException("Already receiving message.");
940 }
941 isReceivingSynchronous = true;
942 receiveThread = Thread.currentThread();
943 try {
944 context.getReceiveHelper().receiveMessages(timeout, returnOnTimeout, handler);
945 } finally {
946 receiveThread = null;
947 isReceivingSynchronous = false;
948 }
949 }
950
951 @Override
952 public void setReceiveConfig(final ReceiveConfig receiveConfig) {
953 context.getReceiveHelper().setReceiveConfig(receiveConfig);
954 }
955
956 @Override
957 public boolean hasCaughtUpWithOldMessages() {
958 return context.getReceiveHelper().hasCaughtUpWithOldMessages();
959 }
960
961 @Override
962 public boolean isContactBlocked(final RecipientIdentifier.Single recipient) {
963 final RecipientId recipientId;
964 try {
965 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
966 } catch (UnregisteredRecipientException e) {
967 return false;
968 }
969 return context.getContactHelper().isContactBlocked(recipientId);
970 }
971
972 @Override
973 public void sendContacts() throws IOException {
974 context.getSyncHelper().sendContacts();
975 }
976
977 @Override
978 public List<Recipient> getRecipients(
979 boolean onlyContacts,
980 Optional<Boolean> blocked,
981 Collection<RecipientIdentifier.Single> recipients,
982 Optional<String> name
983 ) {
984 final var recipientIds = recipients.stream().map(a -> {
985 try {
986 return context.getRecipientHelper().resolveRecipient(a);
987 } catch (UnregisteredRecipientException e) {
988 return null;
989 }
990 }).filter(Objects::nonNull).collect(Collectors.toSet());
991 if (!recipients.isEmpty() && recipientIds.isEmpty()) {
992 return List.of();
993 }
994 // refresh profiles of explicitly given recipients
995 context.getProfileHelper().refreshRecipientProfiles(recipientIds);
996 return account.getRecipientStore().getRecipients(onlyContacts, blocked, recipientIds, name);
997 }
998
999 @Override
1000 public String getContactOrProfileName(RecipientIdentifier.Single recipient) {
1001 final RecipientId recipientId;
1002 try {
1003 recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1004 } catch (UnregisteredRecipientException e) {
1005 return null;
1006 }
1007
1008 final var contact = account.getContactStore().getContact(recipientId);
1009 if (contact != null && !Util.isEmpty(contact.getName())) {
1010 return contact.getName();
1011 }
1012
1013 final var profile = context.getProfileHelper().getRecipientProfile(recipientId);
1014 if (profile != null) {
1015 return profile.getDisplayName();
1016 }
1017
1018 return null;
1019 }
1020
1021 @Override
1022 public Group getGroup(GroupId groupId) {
1023 return toGroup(context.getGroupHelper().getGroup(groupId));
1024 }
1025
1026 @Override
1027 public List<Identity> getIdentities() {
1028 return account.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity).toList();
1029 }
1030
1031 private Identity toIdentity(final IdentityInfo identityInfo) {
1032 if (identityInfo == null) {
1033 return null;
1034 }
1035
1036 final var address = account.getRecipientAddressResolver()
1037 .resolveRecipientAddress(identityInfo.getRecipientId());
1038 final var scannableFingerprint = context.getIdentityHelper()
1039 .computeSafetyNumberForScanning(identityInfo.getRecipientId(), identityInfo.getIdentityKey());
1040 return new Identity(address,
1041 identityInfo.getIdentityKey(),
1042 context.getIdentityHelper()
1043 .computeSafetyNumber(identityInfo.getRecipientId(), identityInfo.getIdentityKey()),
1044 scannableFingerprint == null ? null : scannableFingerprint.getSerialized(),
1045 identityInfo.getTrustLevel(),
1046 identityInfo.getDateAdded());
1047 }
1048
1049 @Override
1050 public List<Identity> getIdentities(RecipientIdentifier.Single recipient) {
1051 IdentityInfo identity;
1052 try {
1053 identity = account.getIdentityKeyStore()
1054 .getIdentityInfo(context.getRecipientHelper().resolveRecipient(recipient));
1055 } catch (UnregisteredRecipientException e) {
1056 identity = null;
1057 }
1058 return identity == null ? List.of() : List.of(toIdentity(identity));
1059 }
1060
1061 @Override
1062 public boolean trustIdentityVerified(
1063 RecipientIdentifier.Single recipient, byte[] fingerprint
1064 ) throws UnregisteredRecipientException {
1065 return trustIdentity(recipient, r -> context.getIdentityHelper().trustIdentityVerified(r, fingerprint));
1066 }
1067
1068 @Override
1069 public boolean trustIdentityVerifiedSafetyNumber(
1070 RecipientIdentifier.Single recipient, String safetyNumber
1071 ) throws UnregisteredRecipientException {
1072 return trustIdentity(recipient,
1073 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber));
1074 }
1075
1076 @Override
1077 public boolean trustIdentityVerifiedSafetyNumber(
1078 RecipientIdentifier.Single recipient, byte[] safetyNumber
1079 ) throws UnregisteredRecipientException {
1080 return trustIdentity(recipient,
1081 r -> context.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r, safetyNumber));
1082 }
1083
1084 @Override
1085 public boolean trustIdentityAllKeys(RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
1086 return trustIdentity(recipient, r -> context.getIdentityHelper().trustIdentityAllKeys(r));
1087 }
1088
1089 private boolean trustIdentity(
1090 RecipientIdentifier.Single recipient, Function<RecipientId, Boolean> trustMethod
1091 ) throws UnregisteredRecipientException {
1092 final var recipientId = context.getRecipientHelper().resolveRecipient(recipient);
1093 final var updated = trustMethod.apply(recipientId);
1094 if (updated && this.isReceiving()) {
1095 context.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1096 }
1097 return updated;
1098 }
1099
1100 @Override
1101 public void addAddressChangedListener(final Runnable listener) {
1102 synchronized (addressChangedListeners) {
1103 addressChangedListeners.add(listener);
1104 }
1105 }
1106
1107 @Override
1108 public void addClosedListener(final Runnable listener) {
1109 synchronized (closedListeners) {
1110 closedListeners.add(listener);
1111 }
1112 }
1113
1114 @Override
1115 public void close() {
1116 Thread thread;
1117 synchronized (messageHandlers) {
1118 weakHandlers.clear();
1119 messageHandlers.clear();
1120 thread = receiveThread;
1121 receiveThread = null;
1122 }
1123 if (thread != null) {
1124 stopReceiveThread(thread);
1125 }
1126 executor.shutdown();
1127
1128 dependencies.getSignalWebSocket().disconnect();
1129 disposable.dispose();
1130
1131 if (account != null) {
1132 account.close();
1133 }
1134
1135 synchronized (closedListeners) {
1136 closedListeners.forEach(Runnable::run);
1137 closedListeners.clear();
1138 }
1139
1140 account = null;
1141 }
1142 }