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
.Recipient
;
33 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
34 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
35 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
36 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
37 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
38 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
39 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
40 import org
.asamk
.signal
.manager
.api
.TypingAction
;
41 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
42 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
43 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
44 import org
.asamk
.signal
.manager
.api
.UserStatus
;
45 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
46 import org
.asamk
.signal
.manager
.groups
.GroupId
;
47 import org
.asamk
.signal
.manager
.groups
.GroupInviteLinkUrl
;
48 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
49 import org
.asamk
.signal
.manager
.groups
.GroupSendingNotAllowedException
;
50 import org
.asamk
.signal
.manager
.groups
.LastGroupAdminException
;
51 import org
.asamk
.signal
.manager
.groups
.NotAGroupMemberException
;
52 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
53 import org
.asamk
.signal
.manager
.helper
.Context
;
54 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
55 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
56 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
57 import org
.asamk
.signal
.manager
.storage
.recipients
.Profile
;
58 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
59 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
60 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
61 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
62 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
63 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
64 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
65 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
66 import org
.slf4j
.Logger
;
67 import org
.slf4j
.LoggerFactory
;
68 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
69 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
70 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
71 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
72 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
73 import org
.whispersystems
.signalservice
.api
.push
.ACI
;
74 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
75 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
76 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
77 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
78 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
79 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
80 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
82 import java
.io
.ByteArrayInputStream
;
84 import java
.io
.IOException
;
86 import java
.nio
.charset
.StandardCharsets
;
87 import java
.time
.Duration
;
88 import java
.util
.ArrayList
;
89 import java
.util
.Collection
;
90 import java
.util
.HashMap
;
91 import java
.util
.HashSet
;
92 import java
.util
.List
;
94 import java
.util
.Objects
;
95 import java
.util
.Optional
;
97 import java
.util
.concurrent
.ExecutorService
;
98 import java
.util
.concurrent
.Executors
;
99 import java
.util
.concurrent
.atomic
.AtomicInteger
;
100 import java
.util
.concurrent
.locks
.ReentrantLock
;
101 import java
.util
.function
.Function
;
102 import java
.util
.stream
.Collectors
;
103 import java
.util
.stream
.Stream
;
105 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
107 class ManagerImpl
implements Manager
{
109 private final static Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
111 private SignalAccount account
;
112 private final SignalDependencies dependencies
;
113 private final Context context
;
115 private final ExecutorService executor
= Executors
.newCachedThreadPool();
117 private Thread receiveThread
;
118 private boolean isReceivingSynchronous
;
119 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
120 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
121 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
122 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
123 private final CompositeDisposable disposable
= new CompositeDisposable();
126 SignalAccount account
,
127 PathConfig pathConfig
,
128 AccountFileUpdater accountFileUpdater
,
129 ServiceEnvironmentConfig serviceEnvironmentConfig
,
132 this.account
= account
;
134 final var sessionLock
= new SignalSessionLock() {
135 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
138 public Lock
acquire() {
140 return LEGACY_LOCK
::unlock
;
143 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
145 account
.getCredentialsProvider(),
146 account
.getSignalServiceDataStore(),
149 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
150 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
151 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
153 this.context
= new Context(account
, new AccountFileUpdater() {
155 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
156 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
157 synchronized (addressChangedListeners
) {
158 addressChangedListeners
.forEach(Runnable
::run
);
163 public void removeAccount() {
164 accountFileUpdater
.removeAccount();
166 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
167 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
168 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
169 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
170 synchronized (this) {
174 disposable
.add(account
.getIdentityKeyStore().getIdentityChanges().subscribe(serviceId
-> {
175 logger
.trace("Archiving old sessions for {}", serviceId
);
176 account
.getAciSessionStore().archiveSessions(serviceId
);
177 account
.getPniSessionStore().archiveSessions(serviceId
);
178 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
179 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
180 final var profile
= account
.getProfileStore().getProfile(recipientId
);
181 if (profile
!= null) {
182 account
.getProfileStore()
183 .storeProfile(recipientId
,
184 Profile
.newBuilder(profile
)
185 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
186 .withLastUpdateTimestamp(0)
193 public String
getSelfNumber() {
194 return account
.getNumber();
197 void checkAccountState() throws IOException
{
198 context
.getAccountHelper().checkAccountState();
202 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
{
203 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
205 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
206 if (!canonicalizedNumber
.equals(n
)) {
207 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
209 return canonicalizedNumber
;
210 } catch (InvalidNumberException e
) {
215 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
216 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
218 .filter(s
-> !s
.isEmpty())
219 .collect(Collectors
.toSet());
220 final var registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
222 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
223 final var number
= canonicalizedNumbers
.get(n
);
224 final var user
= registeredUsers
.get(number
);
225 final var serviceId
= user
== null ?
null : user
.getServiceId();
226 final var profile
= serviceId
== null
228 : context
.getProfileHelper()
229 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
230 return new UserStatus(number
.isEmpty() ?
null : number
,
231 serviceId
== null ?
null : serviceId
.uuid(),
233 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
238 public void updateAccountAttributes(String deviceName
) throws IOException
{
239 if (deviceName
!= null) {
240 context
.getAccountHelper().setDeviceName(deviceName
);
242 context
.getAccountHelper().updateAccountAttributes();
243 context
.getAccountHelper().checkWhoAmiI();
247 public Configuration
getConfiguration() {
248 final var configurationStore
= account
.getConfigurationStore();
249 return Configuration
.from(configurationStore
);
253 public void updateConfiguration(
254 Configuration configuration
255 ) throws NotPrimaryDeviceException
{
256 if (!account
.isPrimaryDevice()) {
257 throw new NotPrimaryDeviceException();
260 final var configurationStore
= account
.getConfigurationStore();
261 if (configuration
.readReceipts().isPresent()) {
262 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
264 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
265 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
267 if (configuration
.typingIndicators().isPresent()) {
268 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
270 if (configuration
.linkPreviews().isPresent()) {
271 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
273 context
.getSyncHelper().sendConfigurationMessage();
277 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
278 context
.getProfileHelper()
279 .setProfile(updateProfile
.getGivenName(),
280 updateProfile
.getFamilyName(),
281 updateProfile
.getAbout(),
282 updateProfile
.getAboutEmoji(),
283 updateProfile
.isDeleteAvatar()
285 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
286 updateProfile
.getMobileCoinAddress());
287 context
.getSyncHelper().sendSyncFetchProfileMessage();
291 public void unregister() throws IOException
{
292 context
.getAccountHelper().unregister();
296 public void deleteAccount() throws IOException
{
297 context
.getAccountHelper().deleteAccount();
301 public void submitRateLimitRecaptchaChallenge(String challenge
, String captcha
) throws IOException
{
302 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
304 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
308 public List
<Device
> getLinkedDevices() throws IOException
{
309 var devices
= dependencies
.getAccountManager().getDevices();
310 account
.setMultiDevice(devices
.size() > 1);
311 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
312 return devices
.stream().map(d
-> {
313 String deviceName
= d
.getName();
314 if (deviceName
!= null) {
316 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
317 } catch (IOException e
) {
318 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
321 return new Device(d
.getId(),
325 d
.getId() == account
.getDeviceId());
330 public void removeLinkedDevices(int deviceId
) throws IOException
{
331 context
.getAccountHelper().removeLinkedDevices(deviceId
);
335 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidDeviceLinkException
{
336 var deviceLinkInfo
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
337 context
.getAccountHelper().addDevice(deviceLinkInfo
);
341 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
342 if (!account
.isPrimaryDevice()) {
343 throw new NotPrimaryDeviceException();
345 if (pin
.isPresent()) {
346 context
.getAccountHelper().setRegistrationPin(pin
.get());
348 context
.getAccountHelper().removeRegistrationPin();
352 void refreshPreKeys() throws IOException
{
353 context
.getPreKeyHelper().refreshPreKeys();
357 public Profile
getRecipientProfile(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
358 return context
.getProfileHelper().getRecipientProfile(context
.getRecipientHelper().resolveRecipient(recipient
));
362 public List
<Group
> getGroups() {
363 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
366 private Group
toGroup(final GroupInfo groupInfo
) {
367 if (groupInfo
== null) {
371 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
375 public SendGroupMessageResults
quitGroup(
376 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
377 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
378 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
379 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
383 public void deleteGroup(GroupId groupId
) throws IOException
{
384 final var group
= context
.getGroupHelper().getGroup(groupId
);
385 if (group
.isMember(account
.getSelfRecipientId())) {
386 throw new IOException(
387 "The local group information cannot be removed, as the user is still a member of the group");
389 context
.getGroupHelper().deleteGroup(groupId
);
393 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
394 String name
, Set
<RecipientIdentifier
.Single
> members
, File avatarFile
395 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
396 return context
.getGroupHelper()
398 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
403 public SendGroupMessageResults
updateGroup(
404 final GroupId groupId
, final UpdateGroup updateGroup
405 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
406 return context
.getGroupHelper()
407 .updateGroup(groupId
,
408 updateGroup
.getName(),
409 updateGroup
.getDescription(),
410 updateGroup
.getMembers() == null
412 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
413 updateGroup
.getRemoveMembers() == null
415 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
416 updateGroup
.getAdmins() == null
418 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
419 updateGroup
.getRemoveAdmins() == null
421 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
422 updateGroup
.getBanMembers() == null
424 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
425 updateGroup
.getUnbanMembers() == null
427 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
428 updateGroup
.isResetGroupLink(),
429 updateGroup
.getGroupLinkState(),
430 updateGroup
.getAddMemberPermission(),
431 updateGroup
.getEditDetailsPermission(),
432 updateGroup
.getAvatarFile(),
433 updateGroup
.getExpirationTimer(),
434 updateGroup
.getIsAnnouncementGroup());
438 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
439 GroupInviteLinkUrl inviteLinkUrl
440 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
441 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
444 private SendMessageResults
sendMessage(
445 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
446 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
447 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
448 long timestamp
= System
.currentTimeMillis();
449 messageBuilder
.withTimestamp(timestamp
);
450 for (final var recipient
: recipients
) {
451 if (recipient
instanceof RecipientIdentifier
.Single single
) {
453 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
454 final var result
= context
.getSendHelper().sendMessage(messageBuilder
, recipientId
);
455 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
456 } catch (UnregisteredRecipientException e
) {
457 results
.put(recipient
,
458 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
460 } else if (recipient
instanceof RecipientIdentifier
.NoteToSelf
) {
461 final var result
= context
.getSendHelper().sendSelfMessage(messageBuilder
);
462 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
463 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
464 final var result
= context
.getSendHelper().sendAsGroupMessage(messageBuilder
, group
.groupId());
465 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
468 return new SendMessageResults(timestamp
, results
);
471 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
472 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
475 private SendMessageResults
sendTypingMessage(
476 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
477 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
478 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
479 final var timestamp
= System
.currentTimeMillis();
480 for (var recipient
: recipients
) {
481 if (recipient
instanceof RecipientIdentifier
.Single single
) {
482 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
484 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
485 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
486 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
487 } catch (UnregisteredRecipientException e
) {
488 results
.put(recipient
,
489 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
491 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
492 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
493 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
494 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
495 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
498 return new SendMessageResults(timestamp
, results
);
502 public SendMessageResults
sendTypingMessage(
503 TypingAction action
, Set
<RecipientIdentifier
> recipients
504 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
505 return sendTypingMessage(action
.toSignalService(), recipients
);
509 public SendMessageResults
sendReadReceipt(
510 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
512 final var timestamp
= System
.currentTimeMillis();
513 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
517 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
521 public SendMessageResults
sendViewedReceipt(
522 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
524 final var timestamp
= System
.currentTimeMillis();
525 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
529 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
532 private SendMessageResults
sendReceiptMessage(
533 final RecipientIdentifier
.Single sender
,
534 final long timestamp
,
535 final SignalServiceReceiptMessage receiptMessage
538 final var result
= context
.getSendHelper()
539 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
540 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
541 } catch (UnregisteredRecipientException e
) {
542 return new SendMessageResults(timestamp
,
543 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
548 public SendMessageResults
sendMessage(
549 Message message
, Set
<RecipientIdentifier
> recipients
550 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
551 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
552 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
554 "No profile name set. When sending a message it's recommended to set a profile name with the updateProfile command. This may become mandatory in the future.");
556 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
557 applyMessage(messageBuilder
, message
);
558 return sendMessage(messageBuilder
, recipients
);
561 private void applyMessage(
562 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
563 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
564 if (message
.messageText().length() > 2000) {
565 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
566 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
567 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
568 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
569 messageBuilder
.withAttachment(textAttachment
);
571 messageBuilder
.withBody(message
.messageText());
573 if (message
.attachments().size() > 0) {
574 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
576 if (message
.mentions().size() > 0) {
577 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
579 if (message
.quote().isPresent()) {
580 final var quote
= message
.quote().get();
581 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
582 context
.getRecipientHelper()
583 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
587 resolveMentions(quote
.mentions()),
588 SignalServiceDataMessage
.Quote
.Type
.NORMAL
));
590 if (message
.sticker().isPresent()) {
591 final var sticker
= message
.sticker().get();
592 final var packId
= StickerPackId
.deserialize(sticker
.packId());
593 final var stickerId
= sticker
.stickerId();
595 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
596 if (stickerPack
== null) {
597 throw new InvalidStickerException("Sticker pack not found");
599 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
600 if (manifest
.stickers().size() <= stickerId
) {
601 throw new InvalidStickerException("Sticker id not part of this pack");
603 final var manifestSticker
= manifest
.stickers().get(stickerId
);
604 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
605 if (streamDetails
== null) {
606 throw new InvalidStickerException("Missing local sticker file");
608 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
609 stickerPack
.packKey(),
611 manifestSticker
.emoji(),
612 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
614 if (message
.previews().size() > 0) {
615 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
616 for (final var p
: message
.previews()) {
617 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
618 .uploadAttachment(p
.image().get()) : null;
619 previews
.add(new SignalServicePreview(p
.url(),
623 Optional
.ofNullable(image
)));
625 messageBuilder
.withPreviews(previews
);
629 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
630 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
631 for (final var m
: mentionList
) {
632 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
633 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
634 .resolveSignalServiceAddress(recipientId
)
635 .getServiceId(), m
.start(), m
.length()));
641 public SendMessageResults
sendRemoteDeleteMessage(
642 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
643 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
644 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
645 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
646 for (final var recipient
: recipients
) {
647 if (recipient
instanceof RecipientIdentifier
.Single r
) {
649 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
650 account
.getMessageSendLogStore()
651 .deleteEntryForRecipientNonGroup(targetSentTimestamp
,
652 account
.getRecipientAddressResolver()
653 .resolveRecipientAddress(recipientId
)
655 } catch (UnregisteredRecipientException ignored
) {
657 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
658 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
661 return sendMessage(messageBuilder
, recipients
);
665 public SendMessageResults
sendMessageReaction(
668 RecipientIdentifier
.Single targetAuthor
,
669 long targetSentTimestamp
,
670 Set
<RecipientIdentifier
> recipients
,
671 final boolean isStory
672 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
673 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
674 final var authorServiceId
= context
.getRecipientHelper()
675 .resolveSignalServiceAddress(targetAuthorRecipientId
)
677 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
678 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
680 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
681 targetSentTimestamp
));
683 return sendMessage(messageBuilder
, recipients
);
687 public SendMessageResults
sendPaymentNotificationMessage(
688 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
689 ) throws IOException
{
690 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
691 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
);
692 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
694 return sendMessage(messageBuilder
, Set
.of(recipient
));
695 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
696 throw new AssertionError(e
);
701 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
702 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
705 return sendMessage(messageBuilder
,
706 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()));
707 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
708 throw new AssertionError(e
);
710 for (var recipient
: recipients
) {
711 final RecipientId recipientId
;
713 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
714 } catch (UnregisteredRecipientException e
) {
717 final var serviceId
= context
.getAccount()
718 .getRecipientAddressResolver()
719 .resolveRecipientAddress(recipientId
)
721 account
.getAciSessionStore().deleteAllSessions(serviceId
);
727 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
728 account
.removeRecipient(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
732 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
733 account
.getContactStore()
734 .deleteContact(account
.getRecipientResolver().resolveRecipient(recipient
.getIdentifier()));
738 public void setContactName(
739 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
740 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
741 if (!account
.isPrimaryDevice()) {
742 throw new NotPrimaryDeviceException();
744 context
.getContactHelper()
745 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
749 public void setContactsBlocked(
750 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
751 ) throws NotPrimaryDeviceException
, IOException
, UnregisteredRecipientException
{
752 if (!account
.isPrimaryDevice()) {
753 throw new NotPrimaryDeviceException();
755 if (recipients
.size() == 0) {
758 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
759 final var selfRecipientId
= account
.getSelfRecipientId();
760 boolean shouldRotateProfileKey
= false;
761 for (final var recipientId
: recipientIds
) {
762 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
765 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
766 // if we don't have a common group with the blocked contact we need to rotate the profile key
767 shouldRotateProfileKey
= blocked
&& (
768 shouldRotateProfileKey
|| account
.getGroupStore()
771 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
774 if (shouldRotateProfileKey
) {
775 context
.getProfileHelper().rotateProfileKey();
777 context
.getSyncHelper().sendBlockedList();
781 public void setGroupsBlocked(
782 final Collection
<GroupId
> groupIds
, final boolean blocked
783 ) throws GroupNotFoundException
, NotPrimaryDeviceException
, IOException
{
784 if (!account
.isPrimaryDevice()) {
785 throw new NotPrimaryDeviceException();
787 if (groupIds
.size() == 0) {
790 boolean shouldRotateProfileKey
= false;
791 for (final var groupId
: groupIds
) {
792 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
795 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
796 shouldRotateProfileKey
= blocked
;
798 if (shouldRotateProfileKey
) {
799 context
.getProfileHelper().rotateProfileKey();
801 context
.getSyncHelper().sendBlockedList();
805 public void setExpirationTimer(
806 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
807 ) throws IOException
, UnregisteredRecipientException
{
808 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
809 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
810 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
812 sendMessage(messageBuilder
, Set
.of(recipient
));
813 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
814 throw new AssertionError(e
);
819 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
820 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
822 var messageSender
= dependencies
.getMessageSender();
824 var packKey
= KeyUtils
.createStickerUploadKey();
825 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
826 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
828 var sticker
= new StickerPack(packId
, packKey
);
829 account
.getStickerStore().addStickerPack(sticker
);
831 return new StickerPackUrl(packId
, packKey
);
835 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
836 final var stickerPackStore
= context
.getStickerPackStore();
837 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
838 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
840 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
841 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
842 new StickerPackUrl(pack
.packId(), pack
.packKey()),
846 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
847 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
848 } catch (Exception e
) {
849 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
853 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
858 public void requestAllSyncData() throws IOException
{
859 context
.getSyncHelper().requestAllSyncData();
860 retrieveRemoteStorage();
863 void retrieveRemoteStorage() throws IOException
{
864 context
.getStorageHelper().readDataFromStorage();
868 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
869 if (isReceivingSynchronous
) {
870 throw new IllegalStateException("Already receiving message synchronously.");
872 synchronized (messageHandlers
) {
873 if (isWeakListener
) {
874 weakHandlers
.add(handler
);
876 messageHandlers
.add(handler
);
877 startReceiveThreadIfRequired();
882 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
884 private void startReceiveThreadIfRequired() {
885 if (receiveThread
!= null) {
888 receiveThread
= new Thread(() -> {
889 logger
.debug("Starting receiving messages");
890 context
.getReceiveHelper().receiveMessagesContinuously((envelope
, e
) -> {
891 synchronized (messageHandlers
) {
892 final var handlers
= Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).toList();
893 handlers
.forEach(h
-> {
895 h
.handleMessage(envelope
, e
);
896 } catch (Throwable ex
) {
897 logger
.warn("Message handler failed, ignoring", ex
);
902 logger
.debug("Finished receiving messages");
903 synchronized (messageHandlers
) {
904 receiveThread
= null;
906 // Check if in the meantime another handler has been registered
907 if (!messageHandlers
.isEmpty()) {
908 logger
.debug("Another handler has been registered, starting receive thread again");
909 startReceiveThreadIfRequired();
913 receiveThread
.setName("receive-" + threadNumber
.getAndIncrement());
915 receiveThread
.start();
919 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
921 synchronized (messageHandlers
) {
922 weakHandlers
.remove(handler
);
923 messageHandlers
.remove(handler
);
924 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
927 thread
= receiveThread
;
928 receiveThread
= null;
931 stopReceiveThread(thread
);
934 private void stopReceiveThread(final Thread thread
) {
935 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
936 logger
.debug("Receive stop requested, interrupting read from server.");
941 } catch (InterruptedException ignored
) {
946 public boolean isReceiving() {
947 if (isReceivingSynchronous
) {
950 synchronized (messageHandlers
) {
951 return messageHandlers
.size() > 0;
956 public void receiveMessages(Duration timeout
, ReceiveMessageHandler handler
) throws IOException
{
957 receiveMessages(timeout
, true, handler
);
961 public void receiveMessages(ReceiveMessageHandler handler
) throws IOException
{
962 receiveMessages(Duration
.ofMinutes(1), false, handler
);
965 private void receiveMessages(
966 Duration timeout
, boolean returnOnTimeout
, ReceiveMessageHandler handler
967 ) throws IOException
{
969 throw new IllegalStateException("Already receiving message.");
971 isReceivingSynchronous
= true;
972 receiveThread
= Thread
.currentThread();
974 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, handler
);
976 receiveThread
= null;
977 isReceivingSynchronous
= false;
982 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
983 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
987 public boolean hasCaughtUpWithOldMessages() {
988 return context
.getReceiveHelper().hasCaughtUpWithOldMessages();
992 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
993 final RecipientId recipientId
;
995 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
996 } catch (UnregisteredRecipientException e
) {
999 return context
.getContactHelper().isContactBlocked(recipientId
);
1003 public void sendContacts() throws IOException
{
1004 context
.getSyncHelper().sendContacts();
1008 public List
<Recipient
> getRecipients(
1009 boolean onlyContacts
,
1010 Optional
<Boolean
> blocked
,
1011 Collection
<RecipientIdentifier
.Single
> recipients
,
1012 Optional
<String
> name
1014 final var recipientIds
= recipients
.stream().map(a
-> {
1016 return context
.getRecipientHelper().resolveRecipient(a
);
1017 } catch (UnregisteredRecipientException e
) {
1020 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1021 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1024 // refresh profiles of explicitly given recipients
1025 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1026 return account
.getRecipientStore()
1027 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1029 .map(s
-> new Recipient(s
.getRecipientId(),
1030 s
.getAddress().toApiRecipientAddress(),
1033 s
.getExpiringProfileKeyCredential(),
1039 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1040 final RecipientId recipientId
;
1042 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1043 } catch (UnregisteredRecipientException e
) {
1047 final var contact
= account
.getContactStore().getContact(recipientId
);
1048 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1049 return contact
.getName();
1052 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1053 if (profile
!= null) {
1054 return profile
.getDisplayName();
1061 public Group
getGroup(GroupId groupId
) {
1062 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1066 public List
<Identity
> getIdentities() {
1067 return account
.getIdentityKeyStore().getIdentities().stream().map(this::toIdentity
).toList();
1070 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1071 if (identityInfo
== null) {
1075 final var address
= account
.getRecipientAddressResolver()
1076 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1077 final var scannableFingerprint
= context
.getIdentityHelper()
1078 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1079 return new Identity(address
.toApiRecipientAddress(),
1080 identityInfo
.getIdentityKey(),
1081 context
.getIdentityHelper()
1082 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1083 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1084 identityInfo
.getTrustLevel(),
1085 identityInfo
.getDateAddedTimestamp());
1089 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1090 ServiceId serviceId
;
1092 serviceId
= account
.getRecipientAddressResolver()
1093 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
))
1095 } catch (UnregisteredRecipientException e
) {
1098 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1099 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1103 public boolean trustIdentityVerified(
1104 RecipientIdentifier
.Single recipient
, byte[] fingerprint
1105 ) throws UnregisteredRecipientException
{
1106 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
));
1110 public boolean trustIdentityVerifiedSafetyNumber(
1111 RecipientIdentifier
.Single recipient
, String safetyNumber
1112 ) throws UnregisteredRecipientException
{
1113 return trustIdentity(recipient
,
1114 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1118 public boolean trustIdentityVerifiedSafetyNumber(
1119 RecipientIdentifier
.Single recipient
, byte[] safetyNumber
1120 ) throws UnregisteredRecipientException
{
1121 return trustIdentity(recipient
,
1122 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
));
1126 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1127 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1130 private boolean trustIdentity(
1131 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1132 ) throws UnregisteredRecipientException
{
1133 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1134 final var updated
= trustMethod
.apply(recipientId
);
1135 if (updated
&& this.isReceiving()) {
1136 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1142 public void addAddressChangedListener(final Runnable listener
) {
1143 synchronized (addressChangedListeners
) {
1144 addressChangedListeners
.add(listener
);
1149 public void addClosedListener(final Runnable listener
) {
1150 synchronized (closedListeners
) {
1151 closedListeners
.add(listener
);
1156 public void close() {
1158 synchronized (messageHandlers
) {
1159 weakHandlers
.clear();
1160 messageHandlers
.clear();
1161 thread
= receiveThread
;
1162 receiveThread
= null;
1164 if (thread
!= null) {
1165 stopReceiveThread(thread
);
1167 executor
.shutdown();
1169 dependencies
.getSignalWebSocket().disconnect();
1170 disposable
.dispose();
1172 if (account
!= null) {
1176 synchronized (closedListeners
) {
1177 closedListeners
.forEach(Runnable
::run
);
1178 closedListeners
.clear();