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
.internal
;
19 import org
.asamk
.signal
.manager
.Manager
;
20 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
21 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
22 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
23 import org
.asamk
.signal
.manager
.api
.Configuration
;
24 import org
.asamk
.signal
.manager
.api
.Device
;
25 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
26 import org
.asamk
.signal
.manager
.api
.Group
;
27 import org
.asamk
.signal
.manager
.api
.GroupId
;
28 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
29 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
30 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
31 import org
.asamk
.signal
.manager
.api
.Identity
;
32 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
33 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
34 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
35 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
36 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
38 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
39 import org
.asamk
.signal
.manager
.api
.Message
;
40 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
41 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
42 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
43 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
44 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
45 import org
.asamk
.signal
.manager
.api
.Pair
;
46 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
47 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
48 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
49 import org
.asamk
.signal
.manager
.api
.Profile
;
50 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
51 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
52 import org
.asamk
.signal
.manager
.api
.Recipient
;
53 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
54 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
55 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
56 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
57 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
58 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
60 import org
.asamk
.signal
.manager
.api
.TextStyle
;
61 import org
.asamk
.signal
.manager
.api
.TypingAction
;
62 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
63 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
64 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
65 import org
.asamk
.signal
.manager
.api
.UserStatus
;
66 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
67 import org
.asamk
.signal
.manager
.api
.VerificationMethoNotAvailableException
;
68 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
69 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
70 import org
.asamk
.signal
.manager
.helper
.Context
;
71 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
72 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
73 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
74 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
75 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
76 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
77 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
78 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
79 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
80 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
81 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
82 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
83 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
84 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
85 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
86 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
87 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
88 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
89 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
90 import org
.slf4j
.Logger
;
91 import org
.slf4j
.LoggerFactory
;
92 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
93 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
94 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
95 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
97 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
98 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
99 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
100 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
101 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
102 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
103 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
104 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
105 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
106 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
108 import java
.io
.ByteArrayInputStream
;
110 import java
.io
.FileNotFoundException
;
111 import java
.io
.IOException
;
112 import java
.io
.InputStream
;
113 import java
.nio
.charset
.StandardCharsets
;
114 import java
.time
.Duration
;
115 import java
.util
.ArrayList
;
116 import java
.util
.Collection
;
117 import java
.util
.HashMap
;
118 import java
.util
.HashSet
;
119 import java
.util
.List
;
120 import java
.util
.Map
;
121 import java
.util
.Objects
;
122 import java
.util
.Optional
;
123 import java
.util
.Set
;
124 import java
.util
.concurrent
.ExecutorService
;
125 import java
.util
.concurrent
.Executors
;
126 import java
.util
.concurrent
.TimeUnit
;
127 import java
.util
.concurrent
.atomic
.AtomicInteger
;
128 import java
.util
.concurrent
.locks
.ReentrantLock
;
129 import java
.util
.function
.Function
;
130 import java
.util
.stream
.Collectors
;
131 import java
.util
.stream
.Stream
;
133 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
134 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
136 public class ManagerImpl
implements Manager
{
138 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
140 private SignalAccount account
;
141 private final SignalDependencies dependencies
;
142 private final Context context
;
144 private final ExecutorService executor
= Executors
.newCachedThreadPool();
146 private Thread receiveThread
;
147 private boolean isReceivingSynchronous
;
148 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
149 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
150 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
151 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
152 private final CompositeDisposable disposable
= new CompositeDisposable();
155 SignalAccount account
,
156 PathConfig pathConfig
,
157 AccountFileUpdater accountFileUpdater
,
158 ServiceEnvironmentConfig serviceEnvironmentConfig
,
161 this.account
= account
;
163 final var sessionLock
= new SignalSessionLock() {
164 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
167 public Lock
acquire() {
169 return LEGACY_LOCK
::unlock
;
172 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
174 account
.getCredentialsProvider(),
175 account
.getSignalServiceDataStore(),
178 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
179 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
180 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
182 this.context
= new Context(account
, new AccountFileUpdater() {
184 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
185 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
186 synchronized (addressChangedListeners
) {
187 addressChangedListeners
.forEach(Runnable
::run
);
192 public void removeAccount() {
193 accountFileUpdater
.removeAccount();
195 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
196 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
197 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
198 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
199 synchronized (this) {
203 disposable
.add(account
.getIdentityKeyStore()
204 .getIdentityChanges()
205 .observeOn(Schedulers
.from(executor
))
206 .subscribe(serviceId
-> {
207 logger
.trace("Archiving old sessions for {}", serviceId
);
208 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
209 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
210 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
211 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
212 final var profile
= account
.getProfileStore().getProfile(recipientId
);
213 if (profile
!= null) {
214 account
.getProfileStore()
215 .storeProfile(recipientId
,
216 Profile
.newBuilder(profile
)
217 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
218 .withLastUpdateTimestamp(0)
225 public String
getSelfNumber() {
226 return account
.getNumber();
229 public void checkAccountState() throws IOException
{
230 context
.getAccountHelper().checkAccountState();
231 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
232 if (lastRecipientsRefresh
== null
233 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
234 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
235 context
.getAccountHelper().checkWhoAmiI();
240 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
241 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
243 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
244 if (!canonicalizedNumber
.equals(n
)) {
245 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
247 return canonicalizedNumber
;
248 } catch (InvalidNumberException e
) {
253 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
254 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
256 .filter(s
-> !s
.isEmpty())
257 .collect(Collectors
.toSet());
259 final Map
<String
, RegisteredUser
> registeredUsers
;
261 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
262 } catch (CdsiResourceExhaustedException e
) {
263 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
264 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
267 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
268 final var number
= canonicalizedNumbers
.get(n
);
269 final var user
= registeredUsers
.get(number
);
270 final var serviceId
= user
== null ?
null : user
.getServiceId();
271 final var profile
= serviceId
== null
273 : context
.getProfileHelper()
274 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
275 return new UserStatus(number
.isEmpty() ?
null : number
,
276 serviceId
== null ?
null : serviceId
.getRawUuid(),
278 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
283 public void updateAccountAttributes(
285 Boolean unrestrictedUnidentifiedSender
,
286 final Boolean discoverableByNumber
,
287 final Boolean numberSharing
288 ) throws IOException
{
289 if (deviceName
!= null) {
290 context
.getAccountHelper().setDeviceName(deviceName
);
292 if (unrestrictedUnidentifiedSender
!= null) {
293 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
295 if (discoverableByNumber
!= null) {
296 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
298 if (numberSharing
!= null) {
299 account
.getConfigurationStore()
300 .setPhoneNumberSharingMode(numberSharing
301 ? PhoneNumberSharingMode
.EVERYBODY
302 : PhoneNumberSharingMode
.NOBODY
);
304 context
.getAccountHelper().updateAccountAttributes();
305 context
.getAccountHelper().checkWhoAmiI();
309 public Configuration
getConfiguration() {
310 final var configurationStore
= account
.getConfigurationStore();
311 return Configuration
.from(configurationStore
);
315 public void updateConfiguration(Configuration configuration
) {
316 final var configurationStore
= account
.getConfigurationStore();
317 if (configuration
.readReceipts().isPresent()) {
318 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
320 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
321 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
323 if (configuration
.typingIndicators().isPresent()) {
324 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
326 if (configuration
.linkPreviews().isPresent()) {
327 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
329 context
.getSyncHelper().sendConfigurationMessage();
334 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
335 context
.getProfileHelper()
336 .setProfile(updateProfile
.getGivenName(),
337 updateProfile
.getFamilyName(),
338 updateProfile
.getAbout(),
339 updateProfile
.getAboutEmoji(),
340 updateProfile
.isDeleteAvatar()
342 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
343 updateProfile
.getMobileCoinAddress());
344 context
.getSyncHelper().sendSyncFetchProfileMessage();
347 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
348 context
.getAccountHelper().refreshCurrentUsername();
352 public String
getUsername() {
353 return account
.getUsername();
357 public UsernameLinkUrl
getUsernameLink() {
358 return new UsernameLinkUrl(account
.getUsernameLink());
362 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
364 if (username
.contains(".")) {
365 context
.getAccountHelper().reserveExactUsername(username
);
367 context
.getAccountHelper().reserveUsernameFromNickname(username
);
369 } catch (BaseUsernameException e
) {
370 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
375 public void deleteUsername() throws IOException
{
376 context
.getAccountHelper().deleteUsername();
380 public void startChangeNumber(
381 String newNumber
, boolean voiceVerification
, String captcha
382 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethoNotAvailableException
{
383 if (!account
.isPrimaryDevice()) {
384 throw new NotPrimaryDeviceException();
386 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
390 public void finishChangeNumber(
391 String newNumber
, String verificationCode
, String pin
392 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
393 if (!account
.isPrimaryDevice()) {
394 throw new NotPrimaryDeviceException();
396 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
400 public void unregister() throws IOException
{
401 context
.getAccountHelper().unregister();
405 public void deleteAccount() throws IOException
{
406 context
.getAccountHelper().deleteAccount();
410 public void submitRateLimitRecaptchaChallenge(String challenge
, String captcha
) throws IOException
{
411 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
413 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
417 public List
<Device
> getLinkedDevices() throws IOException
{
418 var devices
= dependencies
.getAccountManager().getDevices();
419 account
.setMultiDevice(devices
.size() > 1);
420 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
421 return devices
.stream().map(d
-> {
422 String deviceName
= d
.getName();
423 if (deviceName
!= null) {
425 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
426 } catch (IOException e
) {
427 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
430 return new Device(d
.getId(),
434 d
.getId() == account
.getDeviceId());
439 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
440 if (!account
.isPrimaryDevice()) {
441 throw new NotPrimaryDeviceException();
443 context
.getAccountHelper().removeLinkedDevices(deviceId
);
447 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
{
448 if (!account
.isPrimaryDevice()) {
449 throw new NotPrimaryDeviceException();
451 context
.getAccountHelper().addDevice(linkUrl
);
455 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
456 if (!account
.isPrimaryDevice()) {
457 throw new NotPrimaryDeviceException();
459 if (pin
.isPresent()) {
460 context
.getAccountHelper().setRegistrationPin(pin
.get());
462 context
.getAccountHelper().removeRegistrationPin();
466 void refreshPreKeys() throws IOException
{
467 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
471 public List
<Group
> getGroups() {
472 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
475 private Group
toGroup(final GroupInfo groupInfo
) {
476 if (groupInfo
== null) {
480 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
484 public SendGroupMessageResults
quitGroup(
485 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
486 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
487 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
488 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
492 public void deleteGroup(GroupId groupId
) throws IOException
{
493 final var group
= context
.getGroupHelper().getGroup(groupId
);
494 if (group
.isMember(account
.getSelfRecipientId())) {
495 throw new IOException(
496 "The local group information cannot be removed, as the user is still a member of the group");
498 context
.getGroupHelper().deleteGroup(groupId
);
502 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
503 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
504 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
505 return context
.getGroupHelper()
507 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
512 public SendGroupMessageResults
updateGroup(
513 final GroupId groupId
, final UpdateGroup updateGroup
514 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
515 return context
.getGroupHelper()
516 .updateGroup(groupId
,
517 updateGroup
.getName(),
518 updateGroup
.getDescription(),
519 updateGroup
.getMembers() == null
521 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
522 updateGroup
.getRemoveMembers() == null
524 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
525 updateGroup
.getAdmins() == null
527 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
528 updateGroup
.getRemoveAdmins() == null
530 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
531 updateGroup
.getBanMembers() == null
533 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
534 updateGroup
.getUnbanMembers() == null
536 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
537 updateGroup
.isResetGroupLink(),
538 updateGroup
.getGroupLinkState(),
539 updateGroup
.getAddMemberPermission(),
540 updateGroup
.getEditDetailsPermission(),
541 updateGroup
.getAvatarFile(),
542 updateGroup
.getExpirationTimer(),
543 updateGroup
.getIsAnnouncementGroup());
547 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
548 GroupInviteLinkUrl inviteLinkUrl
549 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
550 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
553 private SendMessageResults
sendMessage(
554 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
555 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
556 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
559 private SendMessageResults
sendMessage(
560 SignalServiceDataMessage
.Builder messageBuilder
,
561 Set
<RecipientIdentifier
> recipients
,
563 Optional
<Long
> editTargetTimestamp
564 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
565 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
566 long timestamp
= System
.currentTimeMillis();
567 messageBuilder
.withTimestamp(timestamp
);
568 for (final var recipient
: recipients
) {
569 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
570 recipient
instanceof RecipientIdentifier
.Single single
571 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
573 final var result
= notifySelf
574 ? context
.getSendHelper()
575 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
576 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
577 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
578 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
580 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
581 final var result
= context
.getSendHelper()
582 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
583 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
584 } catch (UnregisteredRecipientException e
) {
585 results
.put(recipient
,
586 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
588 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
589 final var result
= context
.getSendHelper()
590 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
591 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
594 return new SendMessageResults(timestamp
, results
);
597 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
598 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
601 private SendMessageResults
sendTypingMessage(
602 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
603 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
604 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
605 final var timestamp
= System
.currentTimeMillis();
606 for (var recipient
: recipients
) {
607 if (recipient
instanceof RecipientIdentifier
.Single single
) {
608 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
610 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
611 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
612 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
613 } catch (UnregisteredRecipientException e
) {
614 results
.put(recipient
,
615 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
617 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
618 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
619 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
620 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
621 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
624 return new SendMessageResults(timestamp
, results
);
628 public SendMessageResults
sendTypingMessage(
629 TypingAction action
, Set
<RecipientIdentifier
> recipients
630 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
631 return sendTypingMessage(action
.toSignalService(), recipients
);
635 public SendMessageResults
sendReadReceipt(
636 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
638 final var timestamp
= System
.currentTimeMillis();
639 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
643 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
647 public SendMessageResults
sendViewedReceipt(
648 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
650 final var timestamp
= System
.currentTimeMillis();
651 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
655 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
658 private SendMessageResults
sendReceiptMessage(
659 final RecipientIdentifier
.Single sender
,
660 final long timestamp
,
661 final SignalServiceReceiptMessage receiptMessage
664 final var result
= context
.getSendHelper()
665 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
666 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
667 } catch (UnregisteredRecipientException e
) {
668 return new SendMessageResults(timestamp
,
669 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
674 public SendMessageResults
sendMessage(
675 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
676 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
677 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
678 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
680 "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.");
682 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
683 applyMessage(messageBuilder
, message
);
684 return sendMessage(messageBuilder
, recipients
, notifySelf
);
688 public SendMessageResults
sendEditMessage(
689 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
690 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
691 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
692 applyMessage(messageBuilder
, message
);
693 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
696 private void applyMessage(
697 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
698 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
699 if (message
.messageText().length() > 2000) {
700 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
701 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
702 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
703 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
704 messageBuilder
.withAttachment(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
706 messageBuilder
.withBody(message
.messageText());
708 if (!message
.attachments().isEmpty()) {
709 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
711 if (!message
.mentions().isEmpty()) {
712 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
714 if (!message
.textStyles().isEmpty()) {
715 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
717 if (message
.quote().isPresent()) {
718 final var quote
= message
.quote().get();
719 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
720 for (final var a
: quote
.attachments()) {
721 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
723 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
724 quotedAttachments
.add(quotedAttachment
);
726 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
727 context
.getRecipientHelper()
728 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
732 resolveMentions(quote
.mentions()),
733 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
734 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
736 if (message
.sticker().isPresent()) {
737 final var sticker
= message
.sticker().get();
738 final var packId
= StickerPackId
.deserialize(sticker
.packId());
739 final var stickerId
= sticker
.stickerId();
741 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
742 if (stickerPack
== null) {
743 throw new InvalidStickerException("Sticker pack not found");
745 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
746 if (manifest
.stickers().size() <= stickerId
) {
747 throw new InvalidStickerException("Sticker id not part of this pack");
749 final var manifestSticker
= manifest
.stickers().get(stickerId
);
750 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
751 if (streamDetails
== null) {
752 throw new InvalidStickerException("Missing local sticker file");
754 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
755 stickerPack
.packKey(),
757 manifestSticker
.emoji(),
758 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
760 if (!message
.previews().isEmpty()) {
761 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
762 for (final var p
: message
.previews()) {
763 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
764 .uploadAttachment(p
.image().get()) : null;
765 previews
.add(new SignalServicePreview(p
.url(),
769 Optional
.ofNullable(image
)));
771 messageBuilder
.withPreviews(previews
);
773 if (message
.storyReply().isPresent()) {
774 final var storyReply
= message
.storyReply().get();
775 final var authorServiceId
= context
.getRecipientHelper()
776 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
778 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
779 storyReply
.timestamp()));
783 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
784 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
785 for (final var m
: mentionList
) {
786 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
787 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
788 .resolveSignalServiceAddress(recipientId
)
789 .getServiceId(), m
.start(), m
.length()));
795 public SendMessageResults
sendRemoteDeleteMessage(
796 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
797 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
798 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
799 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
800 for (final var recipient
: recipients
) {
801 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
802 account
.getMessageSendLogStore()
803 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
804 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
806 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
807 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
808 if (address
.serviceId().isPresent()) {
809 account
.getMessageSendLogStore()
810 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
812 } catch (UnregisteredRecipientException ignored
) {
814 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
815 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
818 return sendMessage(messageBuilder
, recipients
, false);
822 public SendMessageResults
sendMessageReaction(
825 RecipientIdentifier
.Single targetAuthor
,
826 long targetSentTimestamp
,
827 Set
<RecipientIdentifier
> recipients
,
828 final boolean isStory
829 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
830 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
831 final var authorServiceId
= context
.getRecipientHelper()
832 .resolveSignalServiceAddress(targetAuthorRecipientId
)
834 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
835 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
837 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
838 targetSentTimestamp
));
840 return sendMessage(messageBuilder
, recipients
, false);
844 public SendMessageResults
sendPaymentNotificationMessage(
845 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
846 ) throws IOException
{
847 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
848 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
849 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
851 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
852 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
853 throw new AssertionError(e
);
858 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
859 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
862 return sendMessage(messageBuilder
,
863 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
865 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
866 throw new AssertionError(e
);
868 for (var recipient
: recipients
) {
869 final RecipientId recipientId
;
871 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
872 } catch (UnregisteredRecipientException e
) {
875 final var serviceId
= context
.getAccount()
876 .getRecipientAddressResolver()
877 .resolveRecipientAddress(recipientId
)
879 if (serviceId
.isPresent()) {
880 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
887 public SendMessageResults
sendMessageRequestResponse(
888 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
890 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
891 for (final var recipient
: recipients
) {
892 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
893 recipient
instanceof RecipientIdentifier
.Single single
894 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
896 final var result
= context
.getSyncHelper()
897 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
898 if (result
!= null) {
899 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
901 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
902 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
904 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
905 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
906 if (result
!= null) {
907 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
909 } catch (UnregisteredRecipientException e
) {
910 results
.put(recipient
,
911 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
913 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
914 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
915 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
918 return new SendMessageResults(0, results
);
922 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
923 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
924 if (recipientIdOptional
.isPresent()) {
925 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
926 account
.removeRecipient(recipientIdOptional
.get());
932 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
933 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
934 if (recipientIdOptional
.isPresent()) {
935 account
.removeRecipient(recipientIdOptional
.get());
941 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
942 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
943 if (recipientIdOptional
.isPresent()) {
944 account
.getContactStore().deleteContact(recipientIdOptional
.get());
950 public void setContactName(
951 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
952 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
953 if (!account
.isPrimaryDevice()) {
954 throw new NotPrimaryDeviceException();
956 context
.getContactHelper()
957 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
962 public void setContactsBlocked(
963 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
964 ) throws IOException
, UnregisteredRecipientException
{
965 if (recipients
.isEmpty()) {
968 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
969 final var selfRecipientId
= account
.getSelfRecipientId();
970 boolean shouldRotateProfileKey
= false;
971 for (final var recipientId
: recipientIds
) {
972 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
975 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
976 context
.getSyncHelper()
977 .sendMessageRequestResponse(blocked
978 ? MessageRequestResponse
.Type
.BLOCK
979 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
980 // if we don't have a common group with the blocked contact we need to rotate the profile key
981 shouldRotateProfileKey
= blocked
&& (
982 shouldRotateProfileKey
|| account
.getGroupStore()
985 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
988 if (shouldRotateProfileKey
) {
989 context
.getProfileHelper().rotateProfileKey();
991 context
.getSyncHelper().sendBlockedList();
996 public void setGroupsBlocked(
997 final Collection
<GroupId
> groupIds
, final boolean blocked
998 ) throws GroupNotFoundException
, IOException
{
999 if (groupIds
.isEmpty()) {
1002 boolean shouldRotateProfileKey
= false;
1003 for (final var groupId
: groupIds
) {
1004 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1007 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1008 context
.getSyncHelper()
1009 .sendMessageRequestResponse(blocked
1010 ? MessageRequestResponse
.Type
.BLOCK
1011 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1012 shouldRotateProfileKey
= blocked
;
1014 if (shouldRotateProfileKey
) {
1015 context
.getProfileHelper().rotateProfileKey();
1017 context
.getSyncHelper().sendBlockedList();
1018 syncRemoteStorage();
1022 public void setExpirationTimer(
1023 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1024 ) throws IOException
, UnregisteredRecipientException
{
1025 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1026 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1027 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1029 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1030 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1031 throw new AssertionError(e
);
1033 syncRemoteStorage();
1037 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1038 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1040 var messageSender
= dependencies
.getMessageSender();
1042 var packKey
= KeyUtils
.createStickerUploadKey();
1043 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1044 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1046 var sticker
= new StickerPack(packId
, packKey
);
1047 account
.getStickerStore().addStickerPack(sticker
);
1048 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1050 return new StickerPackUrl(packId
, packKey
);
1054 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1055 final var packId
= url
.packId();
1056 final var packKey
= url
.packKey();
1058 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1059 } catch (InvalidMessageException e
) {
1060 throw new IOException(e
);
1063 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1064 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1068 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1069 final var stickerPackStore
= context
.getStickerPackStore();
1070 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1071 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1073 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1074 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1075 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1079 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1080 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1081 } catch (Exception e
) {
1082 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1086 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1091 public void requestAllSyncData() {
1092 context
.getSyncHelper().requestAllSyncData();
1093 syncRemoteStorage();
1096 void syncRemoteStorage() {
1097 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1101 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1102 synchronized (messageHandlers
) {
1103 if (isWeakListener
) {
1104 weakHandlers
.add(handler
);
1106 messageHandlers
.add(handler
);
1107 startReceiveThreadIfRequired();
1112 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1114 private void startReceiveThreadIfRequired() {
1115 if (receiveThread
!= null || isReceivingSynchronous
) {
1118 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1119 logger
.debug("Starting receiving messages");
1120 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1121 logger
.debug("Finished receiving messages");
1122 synchronized (messageHandlers
) {
1123 receiveThread
= null;
1125 // Check if in the meantime another handler has been registered
1126 if (!messageHandlers
.isEmpty()) {
1127 logger
.debug("Another handler has been registered, starting receive thread again");
1128 startReceiveThreadIfRequired();
1134 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1135 synchronized (messageHandlers
) {
1136 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1138 h
.handleMessage(envelope
, e
);
1139 } catch (Throwable ex
) {
1140 logger
.warn("Message handler failed, ignoring", ex
);
1147 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1148 final Thread thread
;
1149 synchronized (messageHandlers
) {
1150 weakHandlers
.remove(handler
);
1151 messageHandlers
.remove(handler
);
1152 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1155 thread
= receiveThread
;
1156 receiveThread
= null;
1159 stopReceiveThread(thread
);
1162 private void stopReceiveThread(final Thread thread
) {
1163 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1164 logger
.debug("Receive stop requested, interrupting read from server.");
1169 } catch (InterruptedException ignored
) {
1174 public boolean isReceiving() {
1175 if (isReceivingSynchronous
) {
1178 synchronized (messageHandlers
) {
1179 return !messageHandlers
.isEmpty();
1184 public void receiveMessages(
1185 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1186 ) throws IOException
, AlreadyReceivingException
{
1187 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1191 public void stopReceiveMessages() {
1192 Thread thread
= null;
1193 synchronized (messageHandlers
) {
1194 if (isReceivingSynchronous
) {
1195 thread
= receiveThread
;
1196 receiveThread
= null;
1199 if (thread
!= null) {
1200 stopReceiveThread(thread
);
1204 private void receiveMessages(
1205 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1206 ) throws IOException
, AlreadyReceivingException
{
1207 synchronized (messageHandlers
) {
1208 if (isReceiving()) {
1209 throw new AlreadyReceivingException("Already receiving message.");
1211 isReceivingSynchronous
= true;
1212 receiveThread
= Thread
.currentThread();
1215 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1216 passReceivedMessageToHandlers(envelope
, e
);
1217 handler
.handleMessage(envelope
, e
);
1220 synchronized (messageHandlers
) {
1221 receiveThread
= null;
1222 isReceivingSynchronous
= false;
1223 if (!messageHandlers
.isEmpty()) {
1224 startReceiveThreadIfRequired();
1231 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1232 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1236 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1237 final RecipientId recipientId
;
1239 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1240 } catch (UnregisteredRecipientException e
) {
1243 return context
.getContactHelper().isContactBlocked(recipientId
);
1247 public void sendContacts() throws IOException
{
1248 context
.getSyncHelper().sendContacts();
1252 public List
<Recipient
> getRecipients(
1253 boolean onlyContacts
,
1254 Optional
<Boolean
> blocked
,
1255 Collection
<RecipientIdentifier
.Single
> recipients
,
1256 Optional
<String
> name
1258 final var recipientIds
= recipients
.stream().map(a
-> {
1260 return context
.getRecipientHelper().resolveRecipient(a
);
1261 } catch (UnregisteredRecipientException e
) {
1264 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1265 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1268 // refresh profiles of explicitly given recipients
1269 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1270 return account
.getRecipientStore()
1271 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1273 .map(s
-> new Recipient(s
.getRecipientId(),
1274 s
.getAddress().toApiRecipientAddress(),
1277 s
.getExpiringProfileKeyCredential(),
1283 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1284 final RecipientId recipientId
;
1286 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1287 } catch (UnregisteredRecipientException e
) {
1291 final var contact
= account
.getContactStore().getContact(recipientId
);
1292 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1293 return contact
.getName();
1296 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1297 if (profile
!= null) {
1298 return profile
.getDisplayName();
1305 public Group
getGroup(GroupId groupId
) {
1306 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1310 public List
<Identity
> getIdentities() {
1311 return account
.getIdentityKeyStore()
1314 .map(this::toIdentity
)
1315 .filter(Objects
::nonNull
)
1319 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1320 if (identityInfo
== null) {
1324 final var address
= account
.getRecipientAddressResolver()
1325 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1326 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1327 identityInfo
.getServiceId())) {
1330 final var scannableFingerprint
= context
.getIdentityHelper()
1331 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1332 return new Identity(address
.toApiRecipientAddress(),
1333 identityInfo
.getIdentityKey(),
1334 context
.getIdentityHelper()
1335 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1336 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1337 identityInfo
.getTrustLevel(),
1338 identityInfo
.getDateAddedTimestamp());
1342 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1343 ServiceId serviceId
;
1345 final var address
= account
.getRecipientAddressResolver()
1346 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1347 if (address
.serviceId().isEmpty()) {
1350 serviceId
= address
.serviceId().get();
1351 } catch (UnregisteredRecipientException e
) {
1354 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1355 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1359 public boolean trustIdentityVerified(
1360 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1361 ) throws UnregisteredRecipientException
{
1362 return switch (verificationCode
) {
1363 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1364 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1365 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1366 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1367 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1368 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1369 case null -> throw new AssertionError("Invalid verification code type");
1374 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1375 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1378 private boolean trustIdentity(
1379 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1380 ) throws UnregisteredRecipientException
{
1381 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1382 final var updated
= trustMethod
.apply(recipientId
);
1383 if (updated
&& this.isReceiving()) {
1384 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1390 public void addAddressChangedListener(final Runnable listener
) {
1391 synchronized (addressChangedListeners
) {
1392 addressChangedListeners
.add(listener
);
1397 public void addClosedListener(final Runnable listener
) {
1398 synchronized (closedListeners
) {
1399 closedListeners
.add(listener
);
1404 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1405 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1409 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1410 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1411 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1412 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1413 if (streamDetails
== null) {
1414 throw new FileNotFoundException();
1416 return streamDetails
.getStream();
1420 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1421 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1422 context
.getProfileHelper().getRecipientProfile(recipientId
);
1423 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1424 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1425 if (streamDetails
== null) {
1426 throw new FileNotFoundException();
1428 return streamDetails
.getStream();
1432 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1433 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1434 context
.getGroupHelper().getGroup(groupId
);
1435 if (streamDetails
== null) {
1436 throw new FileNotFoundException();
1438 return streamDetails
.getStream();
1442 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1443 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1444 if (streamDetails
== null) {
1445 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1448 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1449 } catch (InvalidMessageException e
) {
1450 logger
.warn("Failed to download sticker pack");
1454 if (streamDetails
== null) {
1455 throw new FileNotFoundException();
1457 return streamDetails
.getStream();
1461 public void close() {
1463 synchronized (messageHandlers
) {
1464 weakHandlers
.clear();
1465 messageHandlers
.clear();
1466 thread
= receiveThread
;
1467 receiveThread
= null;
1469 if (thread
!= null) {
1470 stopReceiveThread(thread
);
1475 dependencies
.getSignalWebSocket().disconnect();
1476 dependencies
.getPushServiceSocket().close();
1477 disposable
.dispose();
1479 if (account
!= null) {
1483 synchronized (closedListeners
) {
1484 closedListeners
.forEach(Runnable
::run
);
1485 closedListeners
.clear();