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
.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
.RecipientIdentifier
;
33 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
34 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
35 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
36 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
37 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
38 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
39 import org
.asamk
.signal
.manager
.api
.TypingAction
;
40 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
41 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
42 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
43 import org
.asamk
.signal
.manager
.api
.UserStatus
;
44 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
45 import org
.asamk
.signal
.manager
.groups
.GroupId
;
46 import org
.asamk
.signal
.manager
.groups
.GroupInviteLinkUrl
;
47 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
48 import org
.asamk
.signal
.manager
.groups
.GroupSendingNotAllowedException
;
49 import org
.asamk
.signal
.manager
.groups
.LastGroupAdminException
;
50 import org
.asamk
.signal
.manager
.groups
.NotAGroupMemberException
;
51 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
52 import org
.asamk
.signal
.manager
.helper
.Context
;
53 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
54 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
55 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
56 import org
.asamk
.signal
.manager
.storage
.recipients
.Profile
;
57 import org
.asamk
.signal
.manager
.storage
.recipients
.Recipient
;
58 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
59 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
60 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
61 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
62 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
63 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
64 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
65 import org
.slf4j
.Logger
;
66 import org
.slf4j
.LoggerFactory
;
67 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
68 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
69 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
70 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
71 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
72 import org
.whispersystems
.signalservice
.api
.push
.ACI
;
73 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
74 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
75 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
76 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
77 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
78 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
81 import java
.io
.IOException
;
83 import java
.time
.Duration
;
84 import java
.util
.ArrayList
;
85 import java
.util
.Collection
;
86 import java
.util
.HashMap
;
87 import java
.util
.HashSet
;
88 import java
.util
.List
;
90 import java
.util
.Objects
;
91 import java
.util
.Optional
;
93 import java
.util
.concurrent
.ExecutorService
;
94 import java
.util
.concurrent
.Executors
;
95 import java
.util
.concurrent
.atomic
.AtomicInteger
;
96 import java
.util
.concurrent
.locks
.ReentrantLock
;
97 import java
.util
.function
.Function
;
98 import java
.util
.stream
.Collectors
;
99 import java
.util
.stream
.Stream
;
101 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
103 class ManagerImpl
implements Manager
{
105 private final static Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
107 private SignalAccount account
;
108 private final SignalDependencies dependencies
;
109 private final Context context
;
111 private final ExecutorService executor
= Executors
.newCachedThreadPool();
113 private Thread receiveThread
;
114 private boolean isReceivingSynchronous
;
115 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
116 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
117 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
118 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
119 private final CompositeDisposable disposable
= new CompositeDisposable();
122 SignalAccount account
,
123 PathConfig pathConfig
,
124 AccountFileUpdater accountFileUpdater
,
125 ServiceEnvironmentConfig serviceEnvironmentConfig
,
128 this.account
= account
;
130 final var sessionLock
= new SignalSessionLock() {
131 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
134 public Lock
acquire() {
136 return LEGACY_LOCK
::unlock
;
139 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
141 account
.getCredentialsProvider(),
142 account
.getSignalServiceDataStore(),
145 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
146 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
147 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
149 this.context
= new Context(account
, new AccountFileUpdater() {
151 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
152 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
153 synchronized (addressChangedListeners
) {
154 addressChangedListeners
.forEach(Runnable
::run
);
159 public void removeAccount() {
160 accountFileUpdater
.removeAccount();
162 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
163 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
164 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
165 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
166 synchronized (this) {
170 disposable
.add(account
.getIdentityKeyStore().getIdentityChanges().subscribe(serviceId
-> {
171 logger
.trace("Archiving old sessions for {}", serviceId
);
172 account
.getAciSessionStore().archiveSessions(serviceId
);
173 account
.getPniSessionStore().archiveSessions(serviceId
);
174 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
175 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
176 final var profile
= account
.getProfileStore().getProfile(recipientId
);
177 if (profile
!= null) {
178 account
.getProfileStore()
179 .storeProfile(recipientId
,
180 Profile
.newBuilder(profile
)
181 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
182 .withLastUpdateTimestamp(0)
189 public String
getSelfNumber() {
190 return account
.getNumber();
193 void checkAccountState() throws IOException
{
194 context
.getAccountHelper().checkAccountState();
198 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
{
199 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
201 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
202 if (!canonicalizedNumber
.equals(n
)) {
203 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
205 return canonicalizedNumber
;
206 } catch (InvalidNumberException e
) {
211 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
212 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
214 .filter(s
-> !s
.isEmpty())
215 .collect(Collectors
.toSet());
216 final var registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
218 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
219 final var number
= canonicalizedNumbers
.get(n
);
220 final var aci
= registeredUsers
.get(number
);
221 final var profile
= aci
== null
223 : context
.getProfileHelper()
224 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(aci
));
225 return new UserStatus(number
.isEmpty() ?
null : number
,
226 aci
== null ?
null : aci
.uuid(),
228 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
233 public void updateAccountAttributes(String deviceName
) throws IOException
{
234 if (deviceName
!= null) {
235 context
.getAccountHelper().setDeviceName(deviceName
);
237 context
.getAccountHelper().updateAccountAttributes();
238 context
.getAccountHelper().checkWhoAmiI();
242 public Configuration
getConfiguration() {
243 final var configurationStore
= account
.getConfigurationStore();
244 return Configuration
.from(configurationStore
);
248 public void updateConfiguration(
249 Configuration configuration
250 ) throws NotPrimaryDeviceException
{
251 if (!account
.isPrimaryDevice()) {
252 throw new NotPrimaryDeviceException();
255 final var configurationStore
= account
.getConfigurationStore();
256 if (configuration
.readReceipts().isPresent()) {
257 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
259 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
260 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
262 if (configuration
.typingIndicators().isPresent()) {
263 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
265 if (configuration
.linkPreviews().isPresent()) {
266 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
268 context
.getSyncHelper().sendConfigurationMessage();
272 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
273 context
.getProfileHelper()
274 .setProfile(updateProfile
.getGivenName(),
275 updateProfile
.getFamilyName(),
276 updateProfile
.getAbout(),
277 updateProfile
.getAboutEmoji(),
278 updateProfile
.isDeleteAvatar()
280 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
281 updateProfile
.getMobileCoinAddress());
282 context
.getSyncHelper().sendSyncFetchProfileMessage();
286 public void unregister() throws IOException
{
287 context
.getAccountHelper().unregister();
291 public void deleteAccount() throws IOException
{
292 context
.getAccountHelper().deleteAccount();
296 public void submitRateLimitRecaptchaChallenge(String challenge
, String captcha
) throws IOException
{
297 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
299 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
303 public List
<Device
> getLinkedDevices() throws IOException
{
304 var devices
= dependencies
.getAccountManager().getDevices();
305 account
.setMultiDevice(devices
.size() > 1);
306 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
307 return devices
.stream().map(d
-> {
308 String deviceName
= d
.getName();
309 if (deviceName
!= null) {
311 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
312 } catch (IOException e
) {
313 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
316 return new Device(d
.getId(),
320 d
.getId() == account
.getDeviceId());
325 public void removeLinkedDevices(int deviceId
) throws IOException
{
326 context
.getAccountHelper().removeLinkedDevices(deviceId
);
330 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidDeviceLinkException
{
331 var deviceLinkInfo
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
332 context
.getAccountHelper().addDevice(deviceLinkInfo
);
336 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
337 if (!account
.isPrimaryDevice()) {
338 throw new NotPrimaryDeviceException();
340 if (pin
.isPresent()) {
341 context
.getAccountHelper().setRegistrationPin(pin
.get());
343 context
.getAccountHelper().removeRegistrationPin();
347 void refreshPreKeys() throws IOException
{
348 context
.getPreKeyHelper().refreshPreKeys();
352 public Profile
getRecipientProfile(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
353 return context
.getProfileHelper().getRecipientProfile(context
.getRecipientHelper().resolveRecipient(recipient
));
357 public List
<Group
> getGroups() {
358 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
361 private Group
toGroup(final GroupInfo groupInfo
) {
362 if (groupInfo
== null) {
366 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
370 public SendGroupMessageResults
quitGroup(
371 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
372 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
373 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
374 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
378 public void deleteGroup(GroupId groupId
) throws IOException
{
379 final var group
= context
.getGroupHelper().getGroup(groupId
);
380 if (group
.isMember(account
.getSelfRecipientId())) {
381 throw new IOException(
382 "The local group information cannot be removed, as the user is still a member of the group");
384 context
.getGroupHelper().deleteGroup(groupId
);
388 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
389 String name
, Set
<RecipientIdentifier
.Single
> members
, File avatarFile
390 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
391 return context
.getGroupHelper()
393 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
398 public SendGroupMessageResults
updateGroup(
399 final GroupId groupId
, final UpdateGroup updateGroup
400 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
401 return context
.getGroupHelper()
402 .updateGroup(groupId
,
403 updateGroup
.getName(),
404 updateGroup
.getDescription(),
405 updateGroup
.getMembers() == null
407 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
408 updateGroup
.getRemoveMembers() == null
410 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
411 updateGroup
.getAdmins() == null
413 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
414 updateGroup
.getRemoveAdmins() == null
416 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
417 updateGroup
.getBanMembers() == null
419 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
420 updateGroup
.getUnbanMembers() == null
422 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
423 updateGroup
.isResetGroupLink(),
424 updateGroup
.getGroupLinkState(),
425 updateGroup
.getAddMemberPermission(),
426 updateGroup
.getEditDetailsPermission(),
427 updateGroup
.getAvatarFile(),
428 updateGroup
.getExpirationTimer(),
429 updateGroup
.getIsAnnouncementGroup());
433 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
434 GroupInviteLinkUrl inviteLinkUrl
435 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
436 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
439 private SendMessageResults
sendMessage(
440 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
441 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
442 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
443 long timestamp
= System
.currentTimeMillis();
444 messageBuilder
.withTimestamp(timestamp
);
445 for (final var recipient
: recipients
) {
446 if (recipient
instanceof RecipientIdentifier
.Single single
) {
448 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
449 final var result
= context
.getSendHelper().sendMessage(messageBuilder
, recipientId
);
450 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
451 } catch (UnregisteredRecipientException e
) {
452 results
.put(recipient
,
453 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
455 } else if (recipient
instanceof RecipientIdentifier
.NoteToSelf
) {
456 final var result
= context
.getSendHelper().sendSelfMessage(messageBuilder
);
457 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
458 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
459 final var result
= context
.getSendHelper().sendAsGroupMessage(messageBuilder
, group
.groupId());
460 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
463 return new SendMessageResults(timestamp
, results
);
466 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
467 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
470 private SendMessageResults
sendTypingMessage(
471 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
472 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
473 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
474 final var timestamp
= System
.currentTimeMillis();
475 for (var recipient
: recipients
) {
476 if (recipient
instanceof RecipientIdentifier
.Single single
) {
477 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
479 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
480 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
481 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
482 } catch (UnregisteredRecipientException e
) {
483 results
.put(recipient
,
484 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
486 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
487 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
488 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
489 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
490 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
493 return new SendMessageResults(timestamp
, results
);
497 public SendMessageResults
sendTypingMessage(
498 TypingAction action
, Set
<RecipientIdentifier
> recipients
499 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
500 return sendTypingMessage(action
.toSignalService(), recipients
);
504 public SendMessageResults
sendReadReceipt(
505 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
507 final var timestamp
= System
.currentTimeMillis();
508 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
512 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
516 public SendMessageResults
sendViewedReceipt(
517 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
519 final var timestamp
= System
.currentTimeMillis();
520 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
524 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
527 private SendMessageResults
sendReceiptMessage(
528 final RecipientIdentifier
.Single sender
,
529 final long timestamp
,
530 final SignalServiceReceiptMessage receiptMessage
533 final var result
= context
.getSendHelper()
534 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
535 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
536 } catch (UnregisteredRecipientException e
) {
537 return new SendMessageResults(timestamp
,
538 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
543 public SendMessageResults
sendMessage(
544 Message message
, Set
<RecipientIdentifier
> recipients
545 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
546 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
547 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
549 "No profile name set. When sending a message it's recommended to set a profile name with the updateProfile command. This may become mandatory in the future.");
551 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
552 applyMessage(messageBuilder
, message
);
553 return sendMessage(messageBuilder
, recipients
);
556 private void applyMessage(
557 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
558 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
559 messageBuilder
.withBody(message
.messageText());
560 if (message
.attachments().size() > 0) {
561 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
563 if (message
.mentions().size() > 0) {
564 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
566 if (message
.quote().isPresent()) {
567 final var quote
= message
.quote().get();
568 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
569 context
.getRecipientHelper()
570 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
574 resolveMentions(quote
.mentions()),
575 SignalServiceDataMessage
.Quote
.Type
.NORMAL
));
577 if (message
.sticker().isPresent()) {
578 final var sticker
= message
.sticker().get();
579 final var packId
= StickerPackId
.deserialize(sticker
.packId());
580 final var stickerId
= sticker
.stickerId();
582 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
583 if (stickerPack
== null) {
584 throw new InvalidStickerException("Sticker pack not found");
586 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
587 if (manifest
.stickers().size() <= stickerId
) {
588 throw new InvalidStickerException("Sticker id not part of this pack");
590 final var manifestSticker
= manifest
.stickers().get(stickerId
);
591 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
592 if (streamDetails
== null) {
593 throw new InvalidStickerException("Missing local sticker file");
595 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
596 stickerPack
.packKey(),
598 manifestSticker
.emoji(),
599 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
601 if (message
.previews().size() > 0) {
602 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
603 for (final var p
: message
.previews()) {
604 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
605 .uploadAttachment(p
.image().get()) : null;
606 previews
.add(new SignalServicePreview(p
.url(),
610 Optional
.ofNullable(image
)));
612 messageBuilder
.withPreviews(previews
);
616 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
617 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
618 for (final var m
: mentionList
) {
619 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
620 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
621 .resolveSignalServiceAddress(recipientId
)
622 .getServiceId(), m
.start(), m
.length()));
628 public SendMessageResults
sendRemoteDeleteMessage(
629 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
630 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
631 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
632 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
633 for (final var recipient
: recipients
) {
634 if (recipient
instanceof RecipientIdentifier
.Single r
) {
636 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
637 account
.getMessageSendLogStore()
638 .deleteEntryForRecipientNonGroup(targetSentTimestamp
,
639 account
.getRecipientAddressResolver()
640 .resolveRecipientAddress(recipientId
)
642 } catch (UnregisteredRecipientException ignored
) {
644 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
645 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
648 return sendMessage(messageBuilder
, recipients
);
652 public SendMessageResults
sendMessageReaction(
655 RecipientIdentifier
.Single targetAuthor
,
656 long targetSentTimestamp
,
657 Set
<RecipientIdentifier
> recipients
658 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
659 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
660 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
,
662 context
.getRecipientHelper().resolveSignalServiceAddress(targetAuthorRecipientId
).getServiceId(),
663 targetSentTimestamp
);
664 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
665 return sendMessage(messageBuilder
, recipients
);
669 public SendMessageResults
sendPaymentNotificationMessage(
670 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
671 ) throws IOException
{
672 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
673 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
);
674 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
676 return sendMessage(messageBuilder
, Set
.of(recipient
));
677 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
678 throw new AssertionError(e
);
683 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
684 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
687 return sendMessage(messageBuilder
,
688 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()));
689 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
690 throw new AssertionError(e
);
692 for (var recipient
: recipients
) {
693 final RecipientId recipientId
;
695 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
696 } catch (UnregisteredRecipientException e
) {
699 final var serviceId
= context
.getAccount()
700 .getRecipientAddressResolver()
701 .resolveRecipientAddress(recipientId
)
703 account
.getAciSessionStore().deleteAllSessions(serviceId
);
709 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
710 account
.removeRecipient(account
.getRecipientResolver().resolveRecipient(recipient
.toPartialRecipientAddress()));
714 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
715 account
.getContactStore()
716 .deleteContact(account
.getRecipientResolver().resolveRecipient(recipient
.toPartialRecipientAddress()));
720 public void setContactName(
721 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
722 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
723 if (!account
.isPrimaryDevice()) {
724 throw new NotPrimaryDeviceException();
726 context
.getContactHelper()
727 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
731 public void setContactsBlocked(
732 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
733 ) throws NotPrimaryDeviceException
, IOException
, UnregisteredRecipientException
{
734 if (!account
.isPrimaryDevice()) {
735 throw new NotPrimaryDeviceException();
737 if (recipients
.size() == 0) {
740 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
741 final var selfRecipientId
= account
.getSelfRecipientId();
742 boolean shouldRotateProfileKey
= false;
743 for (final var recipientId
: recipientIds
) {
744 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
747 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
748 // if we don't have a common group with the blocked contact we need to rotate the profile key
749 shouldRotateProfileKey
= blocked
&& (
750 shouldRotateProfileKey
|| account
.getGroupStore()
753 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
756 if (shouldRotateProfileKey
) {
757 context
.getProfileHelper().rotateProfileKey();
759 context
.getSyncHelper().sendBlockedList();
763 public void setGroupsBlocked(
764 final Collection
<GroupId
> groupIds
, final boolean blocked
765 ) throws GroupNotFoundException
, NotPrimaryDeviceException
, IOException
{
766 if (!account
.isPrimaryDevice()) {
767 throw new NotPrimaryDeviceException();
769 if (groupIds
.size() == 0) {
772 boolean shouldRotateProfileKey
= false;
773 for (final var groupId
: groupIds
) {
774 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
777 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
778 shouldRotateProfileKey
= blocked
;
780 if (shouldRotateProfileKey
) {
781 context
.getProfileHelper().rotateProfileKey();
783 context
.getSyncHelper().sendBlockedList();
787 public void setExpirationTimer(
788 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
789 ) throws IOException
, UnregisteredRecipientException
{
790 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
791 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
792 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
794 sendMessage(messageBuilder
, Set
.of(recipient
));
795 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
796 throw new AssertionError(e
);
801 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
802 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
804 var messageSender
= dependencies
.getMessageSender();
806 var packKey
= KeyUtils
.createStickerUploadKey();
807 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
808 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
810 var sticker
= new StickerPack(packId
, packKey
);
811 account
.getStickerStore().addStickerPack(sticker
);
813 return new StickerPackUrl(packId
, packKey
);
817 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
818 final var stickerPackStore
= context
.getStickerPackStore();
819 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
820 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
822 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
823 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
824 new StickerPackUrl(pack
.packId(), pack
.packKey()),
828 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
829 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
830 } catch (Exception e
) {
831 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
835 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
840 public void requestAllSyncData() throws IOException
{
841 context
.getSyncHelper().requestAllSyncData();
842 retrieveRemoteStorage();
845 void retrieveRemoteStorage() throws IOException
{
846 context
.getStorageHelper().readDataFromStorage();
850 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
851 if (isReceivingSynchronous
) {
852 throw new IllegalStateException("Already receiving message synchronously.");
854 synchronized (messageHandlers
) {
855 if (isWeakListener
) {
856 weakHandlers
.add(handler
);
858 messageHandlers
.add(handler
);
859 startReceiveThreadIfRequired();
864 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
866 private void startReceiveThreadIfRequired() {
867 if (receiveThread
!= null) {
870 receiveThread
= new Thread(() -> {
871 logger
.debug("Starting receiving messages");
872 context
.getReceiveHelper().receiveMessagesContinuously((envelope
, e
) -> {
873 synchronized (messageHandlers
) {
874 final var handlers
= Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).toList();
875 handlers
.forEach(h
-> {
877 h
.handleMessage(envelope
, e
);
878 } catch (Throwable ex
) {
879 logger
.warn("Message handler failed, ignoring", ex
);
884 logger
.debug("Finished receiving messages");
885 synchronized (messageHandlers
) {
886 receiveThread
= null;
888 // Check if in the meantime another handler has been registered
889 if (!messageHandlers
.isEmpty()) {
890 logger
.debug("Another handler has been registered, starting receive thread again");
891 startReceiveThreadIfRequired();
895 receiveThread
.setName("receive-" + threadNumber
.getAndIncrement());
897 receiveThread
.start();
901 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
903 synchronized (messageHandlers
) {
904 weakHandlers
.remove(handler
);
905 messageHandlers
.remove(handler
);
906 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
909 thread
= receiveThread
;
910 receiveThread
= null;
913 stopReceiveThread(thread
);
916 private void stopReceiveThread(final Thread thread
) {
917 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
918 logger
.debug("Receive stop requested, interrupting read from server.");
923 } catch (InterruptedException ignored
) {
928 public boolean isReceiving() {
929 if (isReceivingSynchronous
) {
932 synchronized (messageHandlers
) {
933 return messageHandlers
.size() > 0;
938 public void receiveMessages(Duration timeout
, ReceiveMessageHandler handler
) throws IOException
{
939 receiveMessages(timeout
, true, handler
);
943 public void receiveMessages(ReceiveMessageHandler handler
) throws IOException
{
944 receiveMessages(Duration
.ofMinutes(1), false, handler
);
947 private void receiveMessages(
948 Duration timeout
, boolean returnOnTimeout
, ReceiveMessageHandler handler
949 ) throws IOException
{
951 throw new IllegalStateException("Already receiving message.");
953 isReceivingSynchronous
= true;
954 receiveThread
= Thread
.currentThread();
956 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, handler
);
958 receiveThread
= null;
959 isReceivingSynchronous
= false;
964 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
965 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
969 public boolean hasCaughtUpWithOldMessages() {
970 return context
.getReceiveHelper().hasCaughtUpWithOldMessages();
974 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
975 final RecipientId recipientId
;
977 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
978 } catch (UnregisteredRecipientException e
) {
981 return context
.getContactHelper().isContactBlocked(recipientId
);
985 public void sendContacts() throws IOException
{
986 context
.getSyncHelper().sendContacts();
990 public List
<Recipient
> getRecipients(
991 boolean onlyContacts
,
992 Optional
<Boolean
> blocked
,
993 Collection
<RecipientIdentifier
.Single
> recipients
,
994 Optional
<String
> name
996 final var recipientIds
= recipients
.stream().map(a
-> {
998 return context
.getRecipientHelper().resolveRecipient(a
);
999 } catch (UnregisteredRecipientException e
) {
1002 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1003 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1006 // refresh profiles of explicitly given recipients
1007 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1008 return account
.getRecipientStore().getRecipients(onlyContacts
, blocked
, recipientIds
, name
);
1012 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1013 final RecipientId recipientId
;
1015 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1016 } catch (UnregisteredRecipientException e
) {
1020 final var contact
= account
.getContactStore().getContact(recipientId
);
1021 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1022 return contact
.getName();
1025 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1026 if (profile
!= null) {
1027 return profile
.getDisplayName();
1034 public Group
getGroup(GroupId groupId
) {
1035 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1039 public List
<Identity
> getIdentities() {
1040 return account
.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity
).toList();
1043 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1044 if (identityInfo
== null) {
1048 final var address
= account
.getRecipientAddressResolver()
1049 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1050 final var scannableFingerprint
= context
.getIdentityHelper()
1051 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1052 return new Identity(address
,
1053 identityInfo
.getIdentityKey(),
1054 context
.getIdentityHelper()
1055 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1056 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1057 identityInfo
.getTrustLevel(),
1058 identityInfo
.getDateAddedTimestamp());
1062 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1063 ServiceId serviceId
;
1065 serviceId
= account
.getRecipientAddressResolver()
1066 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
))
1068 } catch (UnregisteredRecipientException e
) {
1071 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1072 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1076 public boolean trustIdentityVerified(
1077 RecipientIdentifier
.Single recipient
, byte[] fingerprint
1078 ) throws UnregisteredRecipientException
{
1079 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
));
1083 public boolean trustIdentityVerifiedSafetyNumber(
1084 RecipientIdentifier
.Single recipient
, String safetyNumber
1085 ) throws UnregisteredRecipientException
{
1086 return trustIdentity(recipient
,
1087 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1091 public boolean trustIdentityVerifiedSafetyNumber(
1092 RecipientIdentifier
.Single recipient
, byte[] safetyNumber
1093 ) throws UnregisteredRecipientException
{
1094 return trustIdentity(recipient
,
1095 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1099 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1100 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1103 private boolean trustIdentity(
1104 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1105 ) throws UnregisteredRecipientException
{
1106 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1107 final var updated
= trustMethod
.apply(recipientId
);
1108 if (updated
&& this.isReceiving()) {
1109 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1115 public void addAddressChangedListener(final Runnable listener
) {
1116 synchronized (addressChangedListeners
) {
1117 addressChangedListeners
.add(listener
);
1122 public void addClosedListener(final Runnable listener
) {
1123 synchronized (closedListeners
) {
1124 closedListeners
.add(listener
);
1129 public void close() {
1131 synchronized (messageHandlers
) {
1132 weakHandlers
.clear();
1133 messageHandlers
.clear();
1134 thread
= receiveThread
;
1135 receiveThread
= null;
1137 if (thread
!= null) {
1138 stopReceiveThread(thread
);
1140 executor
.shutdown();
1142 dependencies
.getSignalWebSocket().disconnect();
1143 disposable
.dispose();
1145 if (account
!= null) {
1149 synchronized (closedListeners
) {
1150 closedListeners
.forEach(Runnable
::run
);
1151 closedListeners
.clear();