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