2 Copyright (C) 2015-2022 AsamK and contributors
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.
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.
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/>.
17 package org
.asamk
.signal
.manager
;
19 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
20 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
21 import org
.asamk
.signal
.manager
.api
.Configuration
;
22 import org
.asamk
.signal
.manager
.api
.Device
;
23 import org
.asamk
.signal
.manager
.api
.Group
;
24 import org
.asamk
.signal
.manager
.api
.Identity
;
25 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
26 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
27 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
28 import org
.asamk
.signal
.manager
.api
.Message
;
29 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
30 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
31 import org
.asamk
.signal
.manager
.api
.Pair
;
32 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
33 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
34 import org
.asamk
.signal
.manager
.api
.Recipient
;
35 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
36 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
37 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
38 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
39 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
40 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
41 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
42 import org
.asamk
.signal
.manager
.api
.TypingAction
;
43 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
44 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
45 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
46 import org
.asamk
.signal
.manager
.api
.UserStatus
;
47 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
48 import org
.asamk
.signal
.manager
.groups
.GroupId
;
49 import org
.asamk
.signal
.manager
.groups
.GroupInviteLinkUrl
;
50 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
51 import org
.asamk
.signal
.manager
.groups
.GroupSendingNotAllowedException
;
52 import org
.asamk
.signal
.manager
.groups
.LastGroupAdminException
;
53 import org
.asamk
.signal
.manager
.groups
.NotAGroupMemberException
;
54 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
55 import org
.asamk
.signal
.manager
.helper
.Context
;
56 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
57 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
58 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
59 import org
.asamk
.signal
.manager
.storage
.recipients
.Profile
;
60 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
61 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
62 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
63 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
64 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
65 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
66 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
67 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
68 import org
.slf4j
.Logger
;
69 import org
.slf4j
.LoggerFactory
;
70 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
71 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
72 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
73 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
74 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
75 import org
.whispersystems
.signalservice
.api
.push
.ACI
;
76 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
77 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
78 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
79 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
80 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
81 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
82 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
84 import java
.io
.ByteArrayInputStream
;
86 import java
.io
.IOException
;
87 import java
.io
.InputStream
;
89 import java
.nio
.charset
.StandardCharsets
;
90 import java
.time
.Duration
;
91 import java
.util
.ArrayList
;
92 import java
.util
.Collection
;
93 import java
.util
.HashMap
;
94 import java
.util
.HashSet
;
95 import java
.util
.List
;
97 import java
.util
.Objects
;
98 import java
.util
.Optional
;
100 import java
.util
.concurrent
.ExecutorService
;
101 import java
.util
.concurrent
.Executors
;
102 import java
.util
.concurrent
.atomic
.AtomicInteger
;
103 import java
.util
.concurrent
.locks
.ReentrantLock
;
104 import java
.util
.function
.Function
;
105 import java
.util
.stream
.Collectors
;
106 import java
.util
.stream
.Stream
;
108 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
110 class ManagerImpl
implements Manager
{
112 private final static Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
114 private SignalAccount account
;
115 private final SignalDependencies dependencies
;
116 private final Context context
;
118 private final ExecutorService executor
= Executors
.newCachedThreadPool();
120 private Thread receiveThread
;
121 private boolean isReceivingSynchronous
;
122 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
123 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
124 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
125 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
126 private final CompositeDisposable disposable
= new CompositeDisposable();
129 SignalAccount account
,
130 PathConfig pathConfig
,
131 AccountFileUpdater accountFileUpdater
,
132 ServiceEnvironmentConfig serviceEnvironmentConfig
,
135 this.account
= account
;
137 final var sessionLock
= new SignalSessionLock() {
138 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
141 public Lock
acquire() {
143 return LEGACY_LOCK
::unlock
;
146 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
148 account
.getCredentialsProvider(),
149 account
.getSignalServiceDataStore(),
152 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
153 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
154 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
156 this.context
= new Context(account
, new AccountFileUpdater() {
158 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
159 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
160 synchronized (addressChangedListeners
) {
161 addressChangedListeners
.forEach(Runnable
::run
);
166 public void removeAccount() {
167 accountFileUpdater
.removeAccount();
169 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
170 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
171 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
172 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
173 synchronized (this) {
177 disposable
.add(account
.getIdentityKeyStore().getIdentityChanges().subscribe(serviceId
-> {
178 logger
.trace("Archiving old sessions for {}", serviceId
);
179 account
.getAciSessionStore().archiveSessions(serviceId
);
180 account
.getPniSessionStore().archiveSessions(serviceId
);
181 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
182 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
183 final var profile
= account
.getProfileStore().getProfile(recipientId
);
184 if (profile
!= null) {
185 account
.getProfileStore()
186 .storeProfile(recipientId
,
187 Profile
.newBuilder(profile
)
188 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
189 .withLastUpdateTimestamp(0)
196 public String
getSelfNumber() {
197 return account
.getNumber();
200 void checkAccountState() throws IOException
{
201 context
.getAccountHelper().checkAccountState();
205 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
{
206 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
208 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
209 if (!canonicalizedNumber
.equals(n
)) {
210 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
212 return canonicalizedNumber
;
213 } catch (InvalidNumberException e
) {
218 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
219 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
221 .filter(s
-> !s
.isEmpty())
222 .collect(Collectors
.toSet());
223 final var registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
225 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
226 final var number
= canonicalizedNumbers
.get(n
);
227 final var user
= registeredUsers
.get(number
);
228 final var serviceId
= user
== null ?
null : user
.getServiceId();
229 final var profile
= serviceId
== null
231 : context
.getProfileHelper()
232 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
233 return new UserStatus(number
.isEmpty() ?
null : number
,
234 serviceId
== null ?
null : serviceId
.uuid(),
236 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
241 public void updateAccountAttributes(String deviceName
) throws IOException
{
242 if (deviceName
!= null) {
243 context
.getAccountHelper().setDeviceName(deviceName
);
245 context
.getAccountHelper().updateAccountAttributes();
246 context
.getAccountHelper().checkWhoAmiI();
250 public Configuration
getConfiguration() {
251 final var configurationStore
= account
.getConfigurationStore();
252 return Configuration
.from(configurationStore
);
256 public void updateConfiguration(
257 Configuration configuration
258 ) throws NotPrimaryDeviceException
{
259 if (!account
.isPrimaryDevice()) {
260 throw new NotPrimaryDeviceException();
263 final var configurationStore
= account
.getConfigurationStore();
264 if (configuration
.readReceipts().isPresent()) {
265 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
267 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
268 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
270 if (configuration
.typingIndicators().isPresent()) {
271 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
273 if (configuration
.linkPreviews().isPresent()) {
274 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
276 context
.getSyncHelper().sendConfigurationMessage();
280 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
281 context
.getProfileHelper()
282 .setProfile(updateProfile
.getGivenName(),
283 updateProfile
.getFamilyName(),
284 updateProfile
.getAbout(),
285 updateProfile
.getAboutEmoji(),
286 updateProfile
.isDeleteAvatar()
288 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
289 updateProfile
.getMobileCoinAddress());
290 context
.getSyncHelper().sendSyncFetchProfileMessage();
294 public void unregister() throws IOException
{
295 context
.getAccountHelper().unregister();
299 public void deleteAccount() throws IOException
{
300 context
.getAccountHelper().deleteAccount();
304 public void submitRateLimitRecaptchaChallenge(String challenge
, String captcha
) throws IOException
{
305 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
307 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
311 public List
<Device
> getLinkedDevices() throws IOException
{
312 var devices
= dependencies
.getAccountManager().getDevices();
313 account
.setMultiDevice(devices
.size() > 1);
314 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
315 return devices
.stream().map(d
-> {
316 String deviceName
= d
.getName();
317 if (deviceName
!= null) {
319 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
320 } catch (IOException e
) {
321 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
324 return new Device(d
.getId(),
328 d
.getId() == account
.getDeviceId());
333 public void removeLinkedDevices(int deviceId
) throws IOException
{
334 context
.getAccountHelper().removeLinkedDevices(deviceId
);
338 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidDeviceLinkException
{
339 var deviceLinkInfo
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
340 context
.getAccountHelper().addDevice(deviceLinkInfo
);
344 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
345 if (!account
.isPrimaryDevice()) {
346 throw new NotPrimaryDeviceException();
348 if (pin
.isPresent()) {
349 context
.getAccountHelper().setRegistrationPin(pin
.get());
351 context
.getAccountHelper().removeRegistrationPin();
355 void refreshPreKeys() throws IOException
{
356 context
.getPreKeyHelper().refreshPreKeys();
360 public Profile
getRecipientProfile(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
361 return context
.getProfileHelper().getRecipientProfile(context
.getRecipientHelper().resolveRecipient(recipient
));
365 public List
<Group
> getGroups() {
366 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
369 private Group
toGroup(final GroupInfo groupInfo
) {
370 if (groupInfo
== null) {
374 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
378 public SendGroupMessageResults
quitGroup(
379 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
380 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
381 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
382 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
386 public void deleteGroup(GroupId groupId
) throws IOException
{
387 final var group
= context
.getGroupHelper().getGroup(groupId
);
388 if (group
.isMember(account
.getSelfRecipientId())) {
389 throw new IOException(
390 "The local group information cannot be removed, as the user is still a member of the group");
392 context
.getGroupHelper().deleteGroup(groupId
);
396 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
397 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
398 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
399 return context
.getGroupHelper()
401 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
406 public SendGroupMessageResults
updateGroup(
407 final GroupId groupId
, final UpdateGroup updateGroup
408 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
409 return context
.getGroupHelper()
410 .updateGroup(groupId
,
411 updateGroup
.getName(),
412 updateGroup
.getDescription(),
413 updateGroup
.getMembers() == null
415 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
416 updateGroup
.getRemoveMembers() == null
418 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
419 updateGroup
.getAdmins() == null
421 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
422 updateGroup
.getRemoveAdmins() == null
424 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
425 updateGroup
.getBanMembers() == null
427 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
428 updateGroup
.getUnbanMembers() == null
430 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
431 updateGroup
.isResetGroupLink(),
432 updateGroup
.getGroupLinkState(),
433 updateGroup
.getAddMemberPermission(),
434 updateGroup
.getEditDetailsPermission(),
435 updateGroup
.getAvatarFile(),
436 updateGroup
.getExpirationTimer(),
437 updateGroup
.getIsAnnouncementGroup());
441 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
442 GroupInviteLinkUrl inviteLinkUrl
443 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
444 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
447 private SendMessageResults
sendMessage(
448 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
449 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
450 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
451 long timestamp
= System
.currentTimeMillis();
452 messageBuilder
.withTimestamp(timestamp
);
453 for (final var recipient
: recipients
) {
454 if (recipient
instanceof RecipientIdentifier
.Single single
) {
456 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
457 final var result
= context
.getSendHelper().sendMessage(messageBuilder
, recipientId
);
458 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
459 } catch (UnregisteredRecipientException e
) {
460 results
.put(recipient
,
461 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
463 } else if (recipient
instanceof RecipientIdentifier
.NoteToSelf
) {
464 final var result
= context
.getSendHelper().sendSelfMessage(messageBuilder
);
465 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
466 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
467 final var result
= context
.getSendHelper().sendAsGroupMessage(messageBuilder
, group
.groupId());
468 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
471 return new SendMessageResults(timestamp
, results
);
474 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
475 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
478 private SendMessageResults
sendTypingMessage(
479 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
480 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
481 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
482 final var timestamp
= System
.currentTimeMillis();
483 for (var recipient
: recipients
) {
484 if (recipient
instanceof RecipientIdentifier
.Single single
) {
485 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
487 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
488 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
489 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
490 } catch (UnregisteredRecipientException e
) {
491 results
.put(recipient
,
492 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
494 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
495 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
496 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
497 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
498 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
501 return new SendMessageResults(timestamp
, results
);
505 public SendMessageResults
sendTypingMessage(
506 TypingAction action
, Set
<RecipientIdentifier
> recipients
507 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
508 return sendTypingMessage(action
.toSignalService(), recipients
);
512 public SendMessageResults
sendReadReceipt(
513 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
515 final var timestamp
= System
.currentTimeMillis();
516 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
520 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
524 public SendMessageResults
sendViewedReceipt(
525 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
527 final var timestamp
= System
.currentTimeMillis();
528 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
532 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
535 private SendMessageResults
sendReceiptMessage(
536 final RecipientIdentifier
.Single sender
,
537 final long timestamp
,
538 final SignalServiceReceiptMessage receiptMessage
541 final var result
= context
.getSendHelper()
542 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
543 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
544 } catch (UnregisteredRecipientException e
) {
545 return new SendMessageResults(timestamp
,
546 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
551 public SendMessageResults
sendMessage(
552 Message message
, Set
<RecipientIdentifier
> recipients
553 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
554 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
555 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
557 "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.");
559 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
560 applyMessage(messageBuilder
, message
);
561 return sendMessage(messageBuilder
, recipients
);
564 private void applyMessage(
565 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
566 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
567 if (message
.messageText().length() > 2000) {
568 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
569 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
570 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
571 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
572 messageBuilder
.withAttachment(textAttachment
);
574 messageBuilder
.withBody(message
.messageText());
576 if (message
.attachments().size() > 0) {
577 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
579 if (message
.mentions().size() > 0) {
580 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
582 if (message
.quote().isPresent()) {
583 final var quote
= message
.quote().get();
584 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
585 context
.getRecipientHelper()
586 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
590 resolveMentions(quote
.mentions()),
591 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
594 if (message
.sticker().isPresent()) {
595 final var sticker
= message
.sticker().get();
596 final var packId
= StickerPackId
.deserialize(sticker
.packId());
597 final var stickerId
= sticker
.stickerId();
599 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
600 if (stickerPack
== null) {
601 throw new InvalidStickerException("Sticker pack not found");
603 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
604 if (manifest
.stickers().size() <= stickerId
) {
605 throw new InvalidStickerException("Sticker id not part of this pack");
607 final var manifestSticker
= manifest
.stickers().get(stickerId
);
608 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
609 if (streamDetails
== null) {
610 throw new InvalidStickerException("Missing local sticker file");
612 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
613 stickerPack
.packKey(),
615 manifestSticker
.emoji(),
616 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
618 if (message
.previews().size() > 0) {
619 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
620 for (final var p
: message
.previews()) {
621 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
622 .uploadAttachment(p
.image().get()) : null;
623 previews
.add(new SignalServicePreview(p
.url(),
627 Optional
.ofNullable(image
)));
629 messageBuilder
.withPreviews(previews
);
631 if (message
.storyReply().isPresent()) {
632 final var storyReply
= message
.storyReply().get();
633 final var authorServiceId
= context
.getRecipientHelper()
634 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
636 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
637 storyReply
.timestamp()));
641 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
642 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
643 for (final var m
: mentionList
) {
644 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
645 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
646 .resolveSignalServiceAddress(recipientId
)
647 .getServiceId(), m
.start(), m
.length()));
653 public SendMessageResults
sendRemoteDeleteMessage(
654 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
655 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
656 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
657 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
658 for (final var recipient
: recipients
) {
659 if (recipient
instanceof RecipientIdentifier
.Single r
) {
661 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
662 account
.getMessageSendLogStore()
663 .deleteEntryForRecipientNonGroup(targetSentTimestamp
,
664 account
.getRecipientAddressResolver()
665 .resolveRecipientAddress(recipientId
)
667 } catch (UnregisteredRecipientException ignored
) {
669 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
670 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
673 return sendMessage(messageBuilder
, recipients
);
677 public SendMessageResults
sendMessageReaction(
680 RecipientIdentifier
.Single targetAuthor
,
681 long targetSentTimestamp
,
682 Set
<RecipientIdentifier
> recipients
,
683 final boolean isStory
684 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
685 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
686 final var authorServiceId
= context
.getRecipientHelper()
687 .resolveSignalServiceAddress(targetAuthorRecipientId
)
689 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
690 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
692 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
693 targetSentTimestamp
));
695 return sendMessage(messageBuilder
, recipients
);
699 public SendMessageResults
sendPaymentNotificationMessage(
700 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
701 ) throws IOException
{
702 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
703 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
704 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
706 return sendMessage(messageBuilder
, Set
.of(recipient
));
707 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
708 throw new AssertionError(e
);
713 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
714 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
717 return sendMessage(messageBuilder
,
718 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()));
719 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
720 throw new AssertionError(e
);
722 for (var recipient
: recipients
) {
723 final RecipientId recipientId
;
725 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
726 } catch (UnregisteredRecipientException e
) {
729 final var serviceId
= context
.getAccount()
730 .getRecipientAddressResolver()
731 .resolveRecipientAddress(recipientId
)
733 account
.getAciSessionStore().deleteAllSessions(serviceId
);
739 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
740 account
.removeRecipient(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
744 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
745 account
.getContactStore()
746 .deleteContact(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
750 public void setContactName(
751 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
752 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
753 if (!account
.isPrimaryDevice()) {
754 throw new NotPrimaryDeviceException();
756 context
.getContactHelper()
757 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
761 public void setContactsBlocked(
762 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
763 ) throws NotPrimaryDeviceException
, IOException
, UnregisteredRecipientException
{
764 if (!account
.isPrimaryDevice()) {
765 throw new NotPrimaryDeviceException();
767 if (recipients
.size() == 0) {
770 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
771 final var selfRecipientId
= account
.getSelfRecipientId();
772 boolean shouldRotateProfileKey
= false;
773 for (final var recipientId
: recipientIds
) {
774 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
777 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
778 // if we don't have a common group with the blocked contact we need to rotate the profile key
779 shouldRotateProfileKey
= blocked
&& (
780 shouldRotateProfileKey
|| account
.getGroupStore()
783 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
786 if (shouldRotateProfileKey
) {
787 context
.getProfileHelper().rotateProfileKey();
789 context
.getSyncHelper().sendBlockedList();
793 public void setGroupsBlocked(
794 final Collection
<GroupId
> groupIds
, final boolean blocked
795 ) throws GroupNotFoundException
, NotPrimaryDeviceException
, IOException
{
796 if (!account
.isPrimaryDevice()) {
797 throw new NotPrimaryDeviceException();
799 if (groupIds
.size() == 0) {
802 boolean shouldRotateProfileKey
= false;
803 for (final var groupId
: groupIds
) {
804 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
807 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
808 shouldRotateProfileKey
= blocked
;
810 if (shouldRotateProfileKey
) {
811 context
.getProfileHelper().rotateProfileKey();
813 context
.getSyncHelper().sendBlockedList();
817 public void setExpirationTimer(
818 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
819 ) throws IOException
, UnregisteredRecipientException
{
820 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
821 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
822 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
824 sendMessage(messageBuilder
, Set
.of(recipient
));
825 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
826 throw new AssertionError(e
);
831 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
832 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
834 var messageSender
= dependencies
.getMessageSender();
836 var packKey
= KeyUtils
.createStickerUploadKey();
837 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
838 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
840 var sticker
= new StickerPack(packId
, packKey
);
841 account
.getStickerStore().addStickerPack(sticker
);
843 return new StickerPackUrl(packId
, packKey
);
847 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
848 final var stickerPackStore
= context
.getStickerPackStore();
849 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
850 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
852 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
853 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
854 new StickerPackUrl(pack
.packId(), pack
.packKey()),
858 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
859 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
860 } catch (Exception e
) {
861 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
865 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
870 public void requestAllSyncData() throws IOException
{
871 context
.getSyncHelper().requestAllSyncData();
872 retrieveRemoteStorage();
875 void retrieveRemoteStorage() throws IOException
{
876 context
.getStorageHelper().readDataFromStorage();
880 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
881 synchronized (messageHandlers
) {
882 if (isWeakListener
) {
883 weakHandlers
.add(handler
);
885 messageHandlers
.add(handler
);
886 startReceiveThreadIfRequired();
891 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
893 private void startReceiveThreadIfRequired() {
894 if (receiveThread
!= null || isReceivingSynchronous
) {
897 receiveThread
= new Thread(() -> {
898 logger
.debug("Starting receiving messages");
899 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
900 logger
.debug("Finished receiving messages");
901 synchronized (messageHandlers
) {
902 receiveThread
= null;
904 // Check if in the meantime another handler has been registered
905 if (!messageHandlers
.isEmpty()) {
906 logger
.debug("Another handler has been registered, starting receive thread again");
907 startReceiveThreadIfRequired();
911 receiveThread
.setName("receive-" + threadNumber
.getAndIncrement());
913 receiveThread
.start();
916 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
917 synchronized (messageHandlers
) {
918 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
920 h
.handleMessage(envelope
, e
);
921 } catch (Throwable ex
) {
922 logger
.warn("Message handler failed, ignoring", ex
);
929 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
931 synchronized (messageHandlers
) {
932 weakHandlers
.remove(handler
);
933 messageHandlers
.remove(handler
);
934 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
937 thread
= receiveThread
;
938 receiveThread
= null;
941 stopReceiveThread(thread
);
944 private void stopReceiveThread(final Thread thread
) {
945 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
946 logger
.debug("Receive stop requested, interrupting read from server.");
951 } catch (InterruptedException ignored
) {
956 public boolean isReceiving() {
957 if (isReceivingSynchronous
) {
960 synchronized (messageHandlers
) {
961 return messageHandlers
.size() > 0;
966 public void receiveMessages(
967 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
968 ) throws IOException
, AlreadyReceivingException
{
969 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
972 private void receiveMessages(
973 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
974 ) throws IOException
, AlreadyReceivingException
{
975 synchronized (messageHandlers
) {
977 throw new AlreadyReceivingException("Already receiving message.");
979 isReceivingSynchronous
= true;
980 receiveThread
= Thread
.currentThread();
983 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
984 passReceivedMessageToHandlers(envelope
, e
);
985 handler
.handleMessage(envelope
, e
);
988 synchronized (messageHandlers
) {
989 receiveThread
= null;
990 isReceivingSynchronous
= false;
991 if (messageHandlers
.size() > 0) {
992 startReceiveThreadIfRequired();
999 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1000 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1004 public boolean hasCaughtUpWithOldMessages() {
1005 return context
.getReceiveHelper().hasCaughtUpWithOldMessages();
1009 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1010 final RecipientId recipientId
;
1012 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1013 } catch (UnregisteredRecipientException e
) {
1016 return context
.getContactHelper().isContactBlocked(recipientId
);
1020 public void sendContacts() throws IOException
{
1021 context
.getSyncHelper().sendContacts();
1025 public List
<Recipient
> getRecipients(
1026 boolean onlyContacts
,
1027 Optional
<Boolean
> blocked
,
1028 Collection
<RecipientIdentifier
.Single
> recipients
,
1029 Optional
<String
> name
1031 final var recipientIds
= recipients
.stream().map(a
-> {
1033 return context
.getRecipientHelper().resolveRecipient(a
);
1034 } catch (UnregisteredRecipientException e
) {
1037 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1038 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1041 // refresh profiles of explicitly given recipients
1042 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1043 return account
.getRecipientStore()
1044 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1046 .map(s
-> new Recipient(s
.getRecipientId(),
1047 s
.getAddress().toApiRecipientAddress(),
1050 s
.getExpiringProfileKeyCredential(),
1056 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1057 final RecipientId recipientId
;
1059 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1060 } catch (UnregisteredRecipientException e
) {
1064 final var contact
= account
.getContactStore().getContact(recipientId
);
1065 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1066 return contact
.getName();
1069 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1070 if (profile
!= null) {
1071 return profile
.getDisplayName();
1078 public Group
getGroup(GroupId groupId
) {
1079 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1083 public List
<Identity
> getIdentities() {
1084 return account
.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity
).toList();
1087 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1088 if (identityInfo
== null) {
1092 final var address
= account
.getRecipientAddressResolver()
1093 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1094 final var scannableFingerprint
= context
.getIdentityHelper()
1095 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1096 return new Identity(address
.toApiRecipientAddress(),
1097 identityInfo
.getIdentityKey(),
1098 context
.getIdentityHelper()
1099 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1100 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1101 identityInfo
.getTrustLevel(),
1102 identityInfo
.getDateAddedTimestamp());
1106 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1107 ServiceId serviceId
;
1109 serviceId
= account
.getRecipientAddressResolver()
1110 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
))
1112 } catch (UnregisteredRecipientException e
) {
1115 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1116 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1120 public boolean trustIdentityVerified(
1121 RecipientIdentifier
.Single recipient
, byte[] fingerprint
1122 ) throws UnregisteredRecipientException
{
1123 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
));
1127 public boolean trustIdentityVerifiedSafetyNumber(
1128 RecipientIdentifier
.Single recipient
, String safetyNumber
1129 ) throws UnregisteredRecipientException
{
1130 return trustIdentity(recipient
,
1131 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1135 public boolean trustIdentityVerifiedSafetyNumber(
1136 RecipientIdentifier
.Single recipient
, byte[] safetyNumber
1137 ) throws UnregisteredRecipientException
{
1138 return trustIdentity(recipient
,
1139 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1143 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1144 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1147 private boolean trustIdentity(
1148 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1149 ) throws UnregisteredRecipientException
{
1150 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1151 final var updated
= trustMethod
.apply(recipientId
);
1152 if (updated
&& this.isReceiving()) {
1153 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1159 public void addAddressChangedListener(final Runnable listener
) {
1160 synchronized (addressChangedListeners
) {
1161 addressChangedListeners
.add(listener
);
1166 public void addClosedListener(final Runnable listener
) {
1167 synchronized (closedListeners
) {
1168 closedListeners
.add(listener
);
1173 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1174 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1178 public void close() {
1180 synchronized (messageHandlers
) {
1181 weakHandlers
.clear();
1182 messageHandlers
.clear();
1183 thread
= receiveThread
;
1184 receiveThread
= null;
1186 if (thread
!= null) {
1187 stopReceiveThread(thread
);
1189 executor
.shutdown();
1191 dependencies
.getSignalWebSocket().disconnect();
1192 disposable
.dispose();
1194 if (account
!= null) {
1198 synchronized (closedListeners
) {
1199 closedListeners
.forEach(Runnable
::run
);
1200 closedListeners
.clear();