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
;
88 import java
.nio
.charset
.StandardCharsets
;
89 import java
.time
.Duration
;
90 import java
.util
.ArrayList
;
91 import java
.util
.Collection
;
92 import java
.util
.HashMap
;
93 import java
.util
.HashSet
;
94 import java
.util
.List
;
96 import java
.util
.Objects
;
97 import java
.util
.Optional
;
99 import java
.util
.concurrent
.ExecutorService
;
100 import java
.util
.concurrent
.Executors
;
101 import java
.util
.concurrent
.atomic
.AtomicInteger
;
102 import java
.util
.concurrent
.locks
.ReentrantLock
;
103 import java
.util
.function
.Function
;
104 import java
.util
.stream
.Collectors
;
105 import java
.util
.stream
.Stream
;
107 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
109 class ManagerImpl
implements Manager
{
111 private final static Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
113 private SignalAccount account
;
114 private final SignalDependencies dependencies
;
115 private final Context context
;
117 private final ExecutorService executor
= Executors
.newCachedThreadPool();
119 private Thread receiveThread
;
120 private boolean isReceivingSynchronous
;
121 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
122 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
123 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
124 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
125 private final CompositeDisposable disposable
= new CompositeDisposable();
128 SignalAccount account
,
129 PathConfig pathConfig
,
130 AccountFileUpdater accountFileUpdater
,
131 ServiceEnvironmentConfig serviceEnvironmentConfig
,
134 this.account
= account
;
136 final var sessionLock
= new SignalSessionLock() {
137 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
140 public Lock
acquire() {
142 return LEGACY_LOCK
::unlock
;
145 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
147 account
.getCredentialsProvider(),
148 account
.getSignalServiceDataStore(),
151 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
152 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
153 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
155 this.context
= new Context(account
, new AccountFileUpdater() {
157 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
158 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
159 synchronized (addressChangedListeners
) {
160 addressChangedListeners
.forEach(Runnable
::run
);
165 public void removeAccount() {
166 accountFileUpdater
.removeAccount();
168 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
169 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
170 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
171 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
172 synchronized (this) {
176 disposable
.add(account
.getIdentityKeyStore().getIdentityChanges().subscribe(serviceId
-> {
177 logger
.trace("Archiving old sessions for {}", serviceId
);
178 account
.getAciSessionStore().archiveSessions(serviceId
);
179 account
.getPniSessionStore().archiveSessions(serviceId
);
180 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
181 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
182 final var profile
= account
.getProfileStore().getProfile(recipientId
);
183 if (profile
!= null) {
184 account
.getProfileStore()
185 .storeProfile(recipientId
,
186 Profile
.newBuilder(profile
)
187 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
188 .withLastUpdateTimestamp(0)
195 public String
getSelfNumber() {
196 return account
.getNumber();
199 void checkAccountState() throws IOException
{
200 context
.getAccountHelper().checkAccountState();
204 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
{
205 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
207 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
208 if (!canonicalizedNumber
.equals(n
)) {
209 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
211 return canonicalizedNumber
;
212 } catch (InvalidNumberException e
) {
217 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
218 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
220 .filter(s
-> !s
.isEmpty())
221 .collect(Collectors
.toSet());
222 final var registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
224 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
225 final var number
= canonicalizedNumbers
.get(n
);
226 final var user
= registeredUsers
.get(number
);
227 final var serviceId
= user
== null ?
null : user
.getServiceId();
228 final var profile
= serviceId
== null
230 : context
.getProfileHelper()
231 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
232 return new UserStatus(number
.isEmpty() ?
null : number
,
233 serviceId
== null ?
null : serviceId
.uuid(),
235 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
240 public void updateAccountAttributes(String deviceName
) throws IOException
{
241 if (deviceName
!= null) {
242 context
.getAccountHelper().setDeviceName(deviceName
);
244 context
.getAccountHelper().updateAccountAttributes();
245 context
.getAccountHelper().checkWhoAmiI();
249 public Configuration
getConfiguration() {
250 final var configurationStore
= account
.getConfigurationStore();
251 return Configuration
.from(configurationStore
);
255 public void updateConfiguration(
256 Configuration configuration
257 ) throws NotPrimaryDeviceException
{
258 if (!account
.isPrimaryDevice()) {
259 throw new NotPrimaryDeviceException();
262 final var configurationStore
= account
.getConfigurationStore();
263 if (configuration
.readReceipts().isPresent()) {
264 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
266 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
267 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
269 if (configuration
.typingIndicators().isPresent()) {
270 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
272 if (configuration
.linkPreviews().isPresent()) {
273 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
275 context
.getSyncHelper().sendConfigurationMessage();
279 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
280 context
.getProfileHelper()
281 .setProfile(updateProfile
.getGivenName(),
282 updateProfile
.getFamilyName(),
283 updateProfile
.getAbout(),
284 updateProfile
.getAboutEmoji(),
285 updateProfile
.isDeleteAvatar()
287 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
288 updateProfile
.getMobileCoinAddress());
289 context
.getSyncHelper().sendSyncFetchProfileMessage();
293 public void unregister() throws IOException
{
294 context
.getAccountHelper().unregister();
298 public void deleteAccount() throws IOException
{
299 context
.getAccountHelper().deleteAccount();
303 public void submitRateLimitRecaptchaChallenge(String challenge
, String captcha
) throws IOException
{
304 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
306 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
310 public List
<Device
> getLinkedDevices() throws IOException
{
311 var devices
= dependencies
.getAccountManager().getDevices();
312 account
.setMultiDevice(devices
.size() > 1);
313 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
314 return devices
.stream().map(d
-> {
315 String deviceName
= d
.getName();
316 if (deviceName
!= null) {
318 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
319 } catch (IOException e
) {
320 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
323 return new Device(d
.getId(),
327 d
.getId() == account
.getDeviceId());
332 public void removeLinkedDevices(int deviceId
) throws IOException
{
333 context
.getAccountHelper().removeLinkedDevices(deviceId
);
337 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidDeviceLinkException
{
338 var deviceLinkInfo
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
339 context
.getAccountHelper().addDevice(deviceLinkInfo
);
343 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
344 if (!account
.isPrimaryDevice()) {
345 throw new NotPrimaryDeviceException();
347 if (pin
.isPresent()) {
348 context
.getAccountHelper().setRegistrationPin(pin
.get());
350 context
.getAccountHelper().removeRegistrationPin();
354 void refreshPreKeys() throws IOException
{
355 context
.getPreKeyHelper().refreshPreKeys();
359 public Profile
getRecipientProfile(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
360 return context
.getProfileHelper().getRecipientProfile(context
.getRecipientHelper().resolveRecipient(recipient
));
364 public List
<Group
> getGroups() {
365 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
368 private Group
toGroup(final GroupInfo groupInfo
) {
369 if (groupInfo
== null) {
373 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
377 public SendGroupMessageResults
quitGroup(
378 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
379 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
380 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
381 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
385 public void deleteGroup(GroupId groupId
) throws IOException
{
386 final var group
= context
.getGroupHelper().getGroup(groupId
);
387 if (group
.isMember(account
.getSelfRecipientId())) {
388 throw new IOException(
389 "The local group information cannot be removed, as the user is still a member of the group");
391 context
.getGroupHelper().deleteGroup(groupId
);
395 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
396 String name
, Set
<RecipientIdentifier
.Single
> members
, File avatarFile
397 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
398 return context
.getGroupHelper()
400 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
405 public SendGroupMessageResults
updateGroup(
406 final GroupId groupId
, final UpdateGroup updateGroup
407 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
408 return context
.getGroupHelper()
409 .updateGroup(groupId
,
410 updateGroup
.getName(),
411 updateGroup
.getDescription(),
412 updateGroup
.getMembers() == null
414 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
415 updateGroup
.getRemoveMembers() == null
417 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
418 updateGroup
.getAdmins() == null
420 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
421 updateGroup
.getRemoveAdmins() == null
423 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
424 updateGroup
.getBanMembers() == null
426 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
427 updateGroup
.getUnbanMembers() == null
429 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
430 updateGroup
.isResetGroupLink(),
431 updateGroup
.getGroupLinkState(),
432 updateGroup
.getAddMemberPermission(),
433 updateGroup
.getEditDetailsPermission(),
434 updateGroup
.getAvatarFile(),
435 updateGroup
.getExpirationTimer(),
436 updateGroup
.getIsAnnouncementGroup());
440 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
441 GroupInviteLinkUrl inviteLinkUrl
442 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
443 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
446 private SendMessageResults
sendMessage(
447 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
448 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
449 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
450 long timestamp
= System
.currentTimeMillis();
451 messageBuilder
.withTimestamp(timestamp
);
452 for (final var recipient
: recipients
) {
453 if (recipient
instanceof RecipientIdentifier
.Single single
) {
455 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
456 final var result
= context
.getSendHelper().sendMessage(messageBuilder
, recipientId
);
457 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
458 } catch (UnregisteredRecipientException e
) {
459 results
.put(recipient
,
460 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
462 } else if (recipient
instanceof RecipientIdentifier
.NoteToSelf
) {
463 final var result
= context
.getSendHelper().sendSelfMessage(messageBuilder
);
464 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
465 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
466 final var result
= context
.getSendHelper().sendAsGroupMessage(messageBuilder
, group
.groupId());
467 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
470 return new SendMessageResults(timestamp
, results
);
473 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
474 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
477 private SendMessageResults
sendTypingMessage(
478 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
479 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
480 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
481 final var timestamp
= System
.currentTimeMillis();
482 for (var recipient
: recipients
) {
483 if (recipient
instanceof RecipientIdentifier
.Single single
) {
484 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
486 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
487 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
488 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
489 } catch (UnregisteredRecipientException e
) {
490 results
.put(recipient
,
491 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
493 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
494 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
495 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
496 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
497 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
500 return new SendMessageResults(timestamp
, results
);
504 public SendMessageResults
sendTypingMessage(
505 TypingAction action
, Set
<RecipientIdentifier
> recipients
506 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
507 return sendTypingMessage(action
.toSignalService(), recipients
);
511 public SendMessageResults
sendReadReceipt(
512 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
514 final var timestamp
= System
.currentTimeMillis();
515 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
519 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
523 public SendMessageResults
sendViewedReceipt(
524 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
526 final var timestamp
= System
.currentTimeMillis();
527 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
531 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
534 private SendMessageResults
sendReceiptMessage(
535 final RecipientIdentifier
.Single sender
,
536 final long timestamp
,
537 final SignalServiceReceiptMessage receiptMessage
540 final var result
= context
.getSendHelper()
541 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
542 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
543 } catch (UnregisteredRecipientException e
) {
544 return new SendMessageResults(timestamp
,
545 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
550 public SendMessageResults
sendMessage(
551 Message message
, Set
<RecipientIdentifier
> recipients
552 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
553 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
554 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
556 "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.");
558 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
559 applyMessage(messageBuilder
, message
);
560 return sendMessage(messageBuilder
, recipients
);
563 private void applyMessage(
564 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
565 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
566 if (message
.messageText().length() > 2000) {
567 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
568 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
569 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
570 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
571 messageBuilder
.withAttachment(textAttachment
);
573 messageBuilder
.withBody(message
.messageText());
575 if (message
.attachments().size() > 0) {
576 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
578 if (message
.mentions().size() > 0) {
579 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
581 if (message
.quote().isPresent()) {
582 final var quote
= message
.quote().get();
583 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
584 context
.getRecipientHelper()
585 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
589 resolveMentions(quote
.mentions()),
590 SignalServiceDataMessage
.Quote
.Type
.NORMAL
));
592 if (message
.sticker().isPresent()) {
593 final var sticker
= message
.sticker().get();
594 final var packId
= StickerPackId
.deserialize(sticker
.packId());
595 final var stickerId
= sticker
.stickerId();
597 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
598 if (stickerPack
== null) {
599 throw new InvalidStickerException("Sticker pack not found");
601 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
602 if (manifest
.stickers().size() <= stickerId
) {
603 throw new InvalidStickerException("Sticker id not part of this pack");
605 final var manifestSticker
= manifest
.stickers().get(stickerId
);
606 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
607 if (streamDetails
== null) {
608 throw new InvalidStickerException("Missing local sticker file");
610 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
611 stickerPack
.packKey(),
613 manifestSticker
.emoji(),
614 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
616 if (message
.previews().size() > 0) {
617 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
618 for (final var p
: message
.previews()) {
619 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
620 .uploadAttachment(p
.image().get()) : null;
621 previews
.add(new SignalServicePreview(p
.url(),
625 Optional
.ofNullable(image
)));
627 messageBuilder
.withPreviews(previews
);
629 if (message
.storyReply().isPresent()) {
630 final var storyReply
= message
.storyReply().get();
631 final var authorServiceId
= context
.getRecipientHelper()
632 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
634 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
635 storyReply
.timestamp()));
639 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
640 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
641 for (final var m
: mentionList
) {
642 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
643 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
644 .resolveSignalServiceAddress(recipientId
)
645 .getServiceId(), m
.start(), m
.length()));
651 public SendMessageResults
sendRemoteDeleteMessage(
652 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
653 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
654 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
655 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
656 for (final var recipient
: recipients
) {
657 if (recipient
instanceof RecipientIdentifier
.Single r
) {
659 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
660 account
.getMessageSendLogStore()
661 .deleteEntryForRecipientNonGroup(targetSentTimestamp
,
662 account
.getRecipientAddressResolver()
663 .resolveRecipientAddress(recipientId
)
665 } catch (UnregisteredRecipientException ignored
) {
667 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
668 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
671 return sendMessage(messageBuilder
, recipients
);
675 public SendMessageResults
sendMessageReaction(
678 RecipientIdentifier
.Single targetAuthor
,
679 long targetSentTimestamp
,
680 Set
<RecipientIdentifier
> recipients
,
681 final boolean isStory
682 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
683 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
684 final var authorServiceId
= context
.getRecipientHelper()
685 .resolveSignalServiceAddress(targetAuthorRecipientId
)
687 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
688 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
690 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
691 targetSentTimestamp
));
693 return sendMessage(messageBuilder
, recipients
);
697 public SendMessageResults
sendPaymentNotificationMessage(
698 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
699 ) throws IOException
{
700 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
701 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
);
702 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
704 return sendMessage(messageBuilder
, Set
.of(recipient
));
705 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
706 throw new AssertionError(e
);
711 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
712 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
715 return sendMessage(messageBuilder
,
716 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()));
717 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
718 throw new AssertionError(e
);
720 for (var recipient
: recipients
) {
721 final RecipientId recipientId
;
723 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
724 } catch (UnregisteredRecipientException e
) {
727 final var serviceId
= context
.getAccount()
728 .getRecipientAddressResolver()
729 .resolveRecipientAddress(recipientId
)
731 account
.getAciSessionStore().deleteAllSessions(serviceId
);
737 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
738 account
.removeRecipient(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
742 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
743 account
.getContactStore()
744 .deleteContact(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
748 public void setContactName(
749 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
750 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
751 if (!account
.isPrimaryDevice()) {
752 throw new NotPrimaryDeviceException();
754 context
.getContactHelper()
755 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
759 public void setContactsBlocked(
760 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
761 ) throws NotPrimaryDeviceException
, IOException
, UnregisteredRecipientException
{
762 if (!account
.isPrimaryDevice()) {
763 throw new NotPrimaryDeviceException();
765 if (recipients
.size() == 0) {
768 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
769 final var selfRecipientId
= account
.getSelfRecipientId();
770 boolean shouldRotateProfileKey
= false;
771 for (final var recipientId
: recipientIds
) {
772 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
775 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
776 // if we don't have a common group with the blocked contact we need to rotate the profile key
777 shouldRotateProfileKey
= blocked
&& (
778 shouldRotateProfileKey
|| account
.getGroupStore()
781 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
784 if (shouldRotateProfileKey
) {
785 context
.getProfileHelper().rotateProfileKey();
787 context
.getSyncHelper().sendBlockedList();
791 public void setGroupsBlocked(
792 final Collection
<GroupId
> groupIds
, final boolean blocked
793 ) throws GroupNotFoundException
, NotPrimaryDeviceException
, IOException
{
794 if (!account
.isPrimaryDevice()) {
795 throw new NotPrimaryDeviceException();
797 if (groupIds
.size() == 0) {
800 boolean shouldRotateProfileKey
= false;
801 for (final var groupId
: groupIds
) {
802 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
805 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
806 shouldRotateProfileKey
= blocked
;
808 if (shouldRotateProfileKey
) {
809 context
.getProfileHelper().rotateProfileKey();
811 context
.getSyncHelper().sendBlockedList();
815 public void setExpirationTimer(
816 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
817 ) throws IOException
, UnregisteredRecipientException
{
818 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
819 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
820 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
822 sendMessage(messageBuilder
, Set
.of(recipient
));
823 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
824 throw new AssertionError(e
);
829 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
830 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
832 var messageSender
= dependencies
.getMessageSender();
834 var packKey
= KeyUtils
.createStickerUploadKey();
835 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
836 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
838 var sticker
= new StickerPack(packId
, packKey
);
839 account
.getStickerStore().addStickerPack(sticker
);
841 return new StickerPackUrl(packId
, packKey
);
845 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
846 final var stickerPackStore
= context
.getStickerPackStore();
847 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
848 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
850 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
851 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
852 new StickerPackUrl(pack
.packId(), pack
.packKey()),
856 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
857 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
858 } catch (Exception e
) {
859 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
863 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
868 public void requestAllSyncData() throws IOException
{
869 context
.getSyncHelper().requestAllSyncData();
870 retrieveRemoteStorage();
873 void retrieveRemoteStorage() throws IOException
{
874 context
.getStorageHelper().readDataFromStorage();
878 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
879 synchronized (messageHandlers
) {
880 if (isWeakListener
) {
881 weakHandlers
.add(handler
);
883 messageHandlers
.add(handler
);
884 startReceiveThreadIfRequired();
889 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
891 private void startReceiveThreadIfRequired() {
892 if (receiveThread
!= null || isReceivingSynchronous
) {
895 receiveThread
= new Thread(() -> {
896 logger
.debug("Starting receiving messages");
897 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
898 logger
.debug("Finished receiving messages");
899 synchronized (messageHandlers
) {
900 receiveThread
= null;
902 // Check if in the meantime another handler has been registered
903 if (!messageHandlers
.isEmpty()) {
904 logger
.debug("Another handler has been registered, starting receive thread again");
905 startReceiveThreadIfRequired();
909 receiveThread
.setName("receive-" + threadNumber
.getAndIncrement());
911 receiveThread
.start();
914 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
915 synchronized (messageHandlers
) {
916 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
918 h
.handleMessage(envelope
, e
);
919 } catch (Throwable ex
) {
920 logger
.warn("Message handler failed, ignoring", ex
);
927 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
929 synchronized (messageHandlers
) {
930 weakHandlers
.remove(handler
);
931 messageHandlers
.remove(handler
);
932 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
935 thread
= receiveThread
;
936 receiveThread
= null;
939 stopReceiveThread(thread
);
942 private void stopReceiveThread(final Thread thread
) {
943 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
944 logger
.debug("Receive stop requested, interrupting read from server.");
949 } catch (InterruptedException ignored
) {
954 public boolean isReceiving() {
955 if (isReceivingSynchronous
) {
958 synchronized (messageHandlers
) {
959 return messageHandlers
.size() > 0;
964 public void receiveMessages(
965 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
966 ) throws IOException
, AlreadyReceivingException
{
967 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
970 private void receiveMessages(
971 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
972 ) throws IOException
, AlreadyReceivingException
{
973 synchronized (messageHandlers
) {
975 throw new AlreadyReceivingException("Already receiving message.");
977 isReceivingSynchronous
= true;
978 receiveThread
= Thread
.currentThread();
981 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
982 passReceivedMessageToHandlers(envelope
, e
);
983 handler
.handleMessage(envelope
, e
);
986 synchronized (messageHandlers
) {
987 receiveThread
= null;
988 isReceivingSynchronous
= false;
989 if (messageHandlers
.size() > 0) {
990 startReceiveThreadIfRequired();
997 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
998 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1002 public boolean hasCaughtUpWithOldMessages() {
1003 return context
.getReceiveHelper().hasCaughtUpWithOldMessages();
1007 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1008 final RecipientId recipientId
;
1010 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1011 } catch (UnregisteredRecipientException e
) {
1014 return context
.getContactHelper().isContactBlocked(recipientId
);
1018 public void sendContacts() throws IOException
{
1019 context
.getSyncHelper().sendContacts();
1023 public List
<Recipient
> getRecipients(
1024 boolean onlyContacts
,
1025 Optional
<Boolean
> blocked
,
1026 Collection
<RecipientIdentifier
.Single
> recipients
,
1027 Optional
<String
> name
1029 final var recipientIds
= recipients
.stream().map(a
-> {
1031 return context
.getRecipientHelper().resolveRecipient(a
);
1032 } catch (UnregisteredRecipientException e
) {
1035 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1036 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1039 // refresh profiles of explicitly given recipients
1040 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1041 return account
.getRecipientStore()
1042 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1044 .map(s
-> new Recipient(s
.getRecipientId(),
1045 s
.getAddress().toApiRecipientAddress(),
1048 s
.getExpiringProfileKeyCredential(),
1054 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1055 final RecipientId recipientId
;
1057 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1058 } catch (UnregisteredRecipientException e
) {
1062 final var contact
= account
.getContactStore().getContact(recipientId
);
1063 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1064 return contact
.getName();
1067 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1068 if (profile
!= null) {
1069 return profile
.getDisplayName();
1076 public Group
getGroup(GroupId groupId
) {
1077 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1081 public List
<Identity
> getIdentities() {
1082 return account
.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity
).toList();
1085 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1086 if (identityInfo
== null) {
1090 final var address
= account
.getRecipientAddressResolver()
1091 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1092 final var scannableFingerprint
= context
.getIdentityHelper()
1093 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1094 return new Identity(address
.toApiRecipientAddress(),
1095 identityInfo
.getIdentityKey(),
1096 context
.getIdentityHelper()
1097 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1098 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1099 identityInfo
.getTrustLevel(),
1100 identityInfo
.getDateAddedTimestamp());
1104 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1105 ServiceId serviceId
;
1107 serviceId
= account
.getRecipientAddressResolver()
1108 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
))
1110 } catch (UnregisteredRecipientException e
) {
1113 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1114 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1118 public boolean trustIdentityVerified(
1119 RecipientIdentifier
.Single recipient
, byte[] fingerprint
1120 ) throws UnregisteredRecipientException
{
1121 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
));
1125 public boolean trustIdentityVerifiedSafetyNumber(
1126 RecipientIdentifier
.Single recipient
, String safetyNumber
1127 ) throws UnregisteredRecipientException
{
1128 return trustIdentity(recipient
,
1129 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1133 public boolean trustIdentityVerifiedSafetyNumber(
1134 RecipientIdentifier
.Single recipient
, byte[] safetyNumber
1135 ) throws UnregisteredRecipientException
{
1136 return trustIdentity(recipient
,
1137 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1141 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1142 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1145 private boolean trustIdentity(
1146 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1147 ) throws UnregisteredRecipientException
{
1148 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1149 final var updated
= trustMethod
.apply(recipientId
);
1150 if (updated
&& this.isReceiving()) {
1151 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1157 public void addAddressChangedListener(final Runnable listener
) {
1158 synchronized (addressChangedListeners
) {
1159 addressChangedListeners
.add(listener
);
1164 public void addClosedListener(final Runnable listener
) {
1165 synchronized (closedListeners
) {
1166 closedListeners
.add(listener
);
1171 public void close() {
1173 synchronized (messageHandlers
) {
1174 weakHandlers
.clear();
1175 messageHandlers
.clear();
1176 thread
= receiveThread
;
1177 receiveThread
= null;
1179 if (thread
!= null) {
1180 stopReceiveThread(thread
);
1182 executor
.shutdown();
1184 dependencies
.getSignalWebSocket().disconnect();
1185 disposable
.dispose();
1187 if (account
!= null) {
1191 synchronized (closedListeners
) {
1192 closedListeners
.forEach(Runnable
::run
);
1193 closedListeners
.clear();