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