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
.CaptchaRejectedException
;
23 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
24 import org
.asamk
.signal
.manager
.api
.Configuration
;
25 import org
.asamk
.signal
.manager
.api
.Device
;
26 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
27 import org
.asamk
.signal
.manager
.api
.Group
;
28 import org
.asamk
.signal
.manager
.api
.GroupId
;
29 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
30 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
31 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
32 import org
.asamk
.signal
.manager
.api
.Identity
;
33 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
34 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
35 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
36 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
39 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
40 import org
.asamk
.signal
.manager
.api
.Message
;
41 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
43 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
44 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
45 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
46 import org
.asamk
.signal
.manager
.api
.Pair
;
47 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
48 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
49 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
50 import org
.asamk
.signal
.manager
.api
.Profile
;
51 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
52 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
53 import org
.asamk
.signal
.manager
.api
.Recipient
;
54 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
55 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
56 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
58 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
61 import org
.asamk
.signal
.manager
.api
.TextStyle
;
62 import org
.asamk
.signal
.manager
.api
.TypingAction
;
63 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
64 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
65 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
66 import org
.asamk
.signal
.manager
.api
.UserStatus
;
67 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
68 import org
.asamk
.signal
.manager
.api
.VerificationMethoNotAvailableException
;
69 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
70 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
71 import org
.asamk
.signal
.manager
.helper
.Context
;
72 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
73 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
74 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
75 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
76 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
77 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
78 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
79 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
80 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
81 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
82 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
83 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
84 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
85 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
86 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
87 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
88 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
89 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
90 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
91 import org
.slf4j
.Logger
;
92 import org
.slf4j
.LoggerFactory
;
93 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
94 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
95 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
98 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
99 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
100 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
101 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
102 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
103 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
104 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
105 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
106 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
107 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
109 import java
.io
.ByteArrayInputStream
;
111 import java
.io
.FileNotFoundException
;
112 import java
.io
.IOException
;
113 import java
.io
.InputStream
;
114 import java
.nio
.charset
.StandardCharsets
;
115 import java
.time
.Duration
;
116 import java
.util
.ArrayList
;
117 import java
.util
.Collection
;
118 import java
.util
.HashMap
;
119 import java
.util
.HashSet
;
120 import java
.util
.List
;
121 import java
.util
.Map
;
122 import java
.util
.Objects
;
123 import java
.util
.Optional
;
124 import java
.util
.Set
;
125 import java
.util
.concurrent
.ExecutorService
;
126 import java
.util
.concurrent
.Executors
;
127 import java
.util
.concurrent
.TimeUnit
;
128 import java
.util
.concurrent
.atomic
.AtomicInteger
;
129 import java
.util
.concurrent
.locks
.ReentrantLock
;
130 import java
.util
.function
.Function
;
131 import java
.util
.stream
.Collectors
;
132 import java
.util
.stream
.Stream
;
134 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
135 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
137 public class ManagerImpl
implements Manager
{
139 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
141 private SignalAccount account
;
142 private final SignalDependencies dependencies
;
143 private final Context context
;
145 private final ExecutorService executor
= Executors
.newCachedThreadPool();
147 private Thread receiveThread
;
148 private boolean isReceivingSynchronous
;
149 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
150 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
151 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
152 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
153 private final CompositeDisposable disposable
= new CompositeDisposable();
156 SignalAccount account
,
157 PathConfig pathConfig
,
158 AccountFileUpdater accountFileUpdater
,
159 ServiceEnvironmentConfig serviceEnvironmentConfig
,
162 this.account
= account
;
164 final var sessionLock
= new SignalSessionLock() {
165 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
168 public Lock
acquire() {
170 return LEGACY_LOCK
::unlock
;
173 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
175 account
.getCredentialsProvider(),
176 account
.getSignalServiceDataStore(),
179 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
180 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
181 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
183 this.context
= new Context(account
, new AccountFileUpdater() {
185 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
186 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
187 synchronized (addressChangedListeners
) {
188 addressChangedListeners
.forEach(Runnable
::run
);
193 public void removeAccount() {
194 accountFileUpdater
.removeAccount();
196 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
197 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
198 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
199 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
200 synchronized (this) {
204 disposable
.add(account
.getIdentityKeyStore()
205 .getIdentityChanges()
206 .observeOn(Schedulers
.from(executor
))
207 .subscribe(serviceId
-> {
208 logger
.trace("Archiving old sessions for {}", serviceId
);
209 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
210 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
211 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
212 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
213 final var profile
= account
.getProfileStore().getProfile(recipientId
);
214 if (profile
!= null) {
215 account
.getProfileStore()
216 .storeProfile(recipientId
,
217 Profile
.newBuilder(profile
)
218 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
219 .withLastUpdateTimestamp(0)
226 public String
getSelfNumber() {
227 return account
.getNumber();
230 public void checkAccountState() throws IOException
{
231 context
.getAccountHelper().checkAccountState();
232 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
233 if (lastRecipientsRefresh
== null
234 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
235 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
236 context
.getAccountHelper().checkWhoAmiI();
241 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
242 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
244 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
245 if (!canonicalizedNumber
.equals(n
)) {
246 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
248 return canonicalizedNumber
;
249 } catch (InvalidNumberException e
) {
254 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
255 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
257 .filter(s
-> !s
.isEmpty())
258 .collect(Collectors
.toSet());
260 final Map
<String
, RegisteredUser
> registeredUsers
;
262 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
263 } catch (CdsiResourceExhaustedException e
) {
264 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
265 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
268 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
269 final var number
= canonicalizedNumbers
.get(n
);
270 final var user
= registeredUsers
.get(number
);
271 final var serviceId
= user
== null ?
null : user
.getServiceId();
272 final var profile
= serviceId
== null
274 : context
.getProfileHelper()
275 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
276 return new UserStatus(number
.isEmpty() ?
null : number
,
277 serviceId
== null ?
null : serviceId
.getRawUuid(),
279 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
284 public void updateAccountAttributes(
286 Boolean unrestrictedUnidentifiedSender
,
287 final Boolean discoverableByNumber
,
288 final Boolean numberSharing
289 ) throws IOException
{
290 if (deviceName
!= null) {
291 context
.getAccountHelper().setDeviceName(deviceName
);
293 if (unrestrictedUnidentifiedSender
!= null) {
294 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
296 if (discoverableByNumber
!= null) {
297 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
299 if (numberSharing
!= null) {
300 account
.getConfigurationStore()
301 .setPhoneNumberSharingMode(numberSharing
302 ? PhoneNumberSharingMode
.EVERYBODY
303 : PhoneNumberSharingMode
.NOBODY
);
305 context
.getAccountHelper().updateAccountAttributes();
306 context
.getAccountHelper().checkWhoAmiI();
310 public Configuration
getConfiguration() {
311 final var configurationStore
= account
.getConfigurationStore();
312 return Configuration
.from(configurationStore
);
316 public void updateConfiguration(Configuration configuration
) {
317 final var configurationStore
= account
.getConfigurationStore();
318 if (configuration
.readReceipts().isPresent()) {
319 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
321 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
322 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
324 if (configuration
.typingIndicators().isPresent()) {
325 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
327 if (configuration
.linkPreviews().isPresent()) {
328 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
330 context
.getSyncHelper().sendConfigurationMessage();
335 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
336 context
.getProfileHelper()
337 .setProfile(updateProfile
.getGivenName(),
338 updateProfile
.getFamilyName(),
339 updateProfile
.getAbout(),
340 updateProfile
.getAboutEmoji(),
341 updateProfile
.isDeleteAvatar()
343 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
344 updateProfile
.getMobileCoinAddress());
345 context
.getSyncHelper().sendSyncFetchProfileMessage();
348 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
349 context
.getAccountHelper().refreshCurrentUsername();
353 public String
getUsername() {
354 return account
.getUsername();
358 public UsernameLinkUrl
getUsernameLink() {
359 return new UsernameLinkUrl(account
.getUsernameLink());
363 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
365 if (username
.contains(".")) {
366 context
.getAccountHelper().reserveExactUsername(username
);
368 context
.getAccountHelper().reserveUsernameFromNickname(username
);
370 } catch (BaseUsernameException e
) {
371 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
376 public void deleteUsername() throws IOException
{
377 context
.getAccountHelper().deleteUsername();
381 public void startChangeNumber(
382 String newNumber
, boolean voiceVerification
, String captcha
383 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethoNotAvailableException
{
384 if (!account
.isPrimaryDevice()) {
385 throw new NotPrimaryDeviceException();
387 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
391 public void finishChangeNumber(
392 String newNumber
, String verificationCode
, String pin
393 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
394 if (!account
.isPrimaryDevice()) {
395 throw new NotPrimaryDeviceException();
397 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
401 public void unregister() throws IOException
{
402 context
.getAccountHelper().unregister();
406 public void deleteAccount() throws IOException
{
407 context
.getAccountHelper().deleteAccount();
411 public void submitRateLimitRecaptchaChallenge(
414 ) throws IOException
, CaptchaRejectedException
{
415 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
418 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
419 } catch (org
.whispersystems
.signalservice
.api
.push
.exceptions
.CaptchaRejectedException ignored
) {
420 throw new CaptchaRejectedException();
425 public List
<Device
> getLinkedDevices() throws IOException
{
426 var devices
= dependencies
.getAccountManager().getDevices();
427 account
.setMultiDevice(devices
.size() > 1);
428 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
429 return devices
.stream().map(d
-> {
430 String deviceName
= d
.getName();
431 if (deviceName
!= null) {
433 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
434 } catch (IOException e
) {
435 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
438 return new Device(d
.getId(),
442 d
.getId() == account
.getDeviceId());
447 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
448 if (!account
.isPrimaryDevice()) {
449 throw new NotPrimaryDeviceException();
451 context
.getAccountHelper().removeLinkedDevices(deviceId
);
455 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
{
456 if (!account
.isPrimaryDevice()) {
457 throw new NotPrimaryDeviceException();
459 context
.getAccountHelper().addDevice(linkUrl
);
463 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
464 if (!account
.isPrimaryDevice()) {
465 throw new NotPrimaryDeviceException();
467 if (pin
.isPresent()) {
468 context
.getAccountHelper().setRegistrationPin(pin
.get());
470 context
.getAccountHelper().removeRegistrationPin();
474 void refreshPreKeys() throws IOException
{
475 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
479 public List
<Group
> getGroups() {
480 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
483 private Group
toGroup(final GroupInfo groupInfo
) {
484 if (groupInfo
== null) {
488 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
492 public SendGroupMessageResults
quitGroup(
493 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
494 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
495 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
496 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
500 public void deleteGroup(GroupId groupId
) throws IOException
{
501 final var group
= context
.getGroupHelper().getGroup(groupId
);
502 if (group
.isMember(account
.getSelfRecipientId())) {
503 throw new IOException(
504 "The local group information cannot be removed, as the user is still a member of the group");
506 context
.getGroupHelper().deleteGroup(groupId
);
510 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
511 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
512 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
513 return context
.getGroupHelper()
515 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
520 public SendGroupMessageResults
updateGroup(
521 final GroupId groupId
, final UpdateGroup updateGroup
522 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
523 return context
.getGroupHelper()
524 .updateGroup(groupId
,
525 updateGroup
.getName(),
526 updateGroup
.getDescription(),
527 updateGroup
.getMembers() == null
529 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
530 updateGroup
.getRemoveMembers() == null
532 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
533 updateGroup
.getAdmins() == null
535 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
536 updateGroup
.getRemoveAdmins() == null
538 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
539 updateGroup
.getBanMembers() == null
541 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
542 updateGroup
.getUnbanMembers() == null
544 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
545 updateGroup
.isResetGroupLink(),
546 updateGroup
.getGroupLinkState(),
547 updateGroup
.getAddMemberPermission(),
548 updateGroup
.getEditDetailsPermission(),
549 updateGroup
.getAvatarFile(),
550 updateGroup
.getExpirationTimer(),
551 updateGroup
.getIsAnnouncementGroup());
555 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
556 GroupInviteLinkUrl inviteLinkUrl
557 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
558 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
561 private SendMessageResults
sendMessage(
562 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
563 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
564 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
567 private SendMessageResults
sendMessage(
568 SignalServiceDataMessage
.Builder messageBuilder
,
569 Set
<RecipientIdentifier
> recipients
,
571 Optional
<Long
> editTargetTimestamp
572 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
573 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
574 long timestamp
= System
.currentTimeMillis();
575 messageBuilder
.withTimestamp(timestamp
);
576 for (final var recipient
: recipients
) {
577 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
578 recipient
instanceof RecipientIdentifier
.Single single
579 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
581 final var result
= notifySelf
582 ? context
.getSendHelper()
583 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
584 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
585 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
586 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
588 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
589 final var result
= context
.getSendHelper()
590 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
591 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
592 } catch (UnregisteredRecipientException e
) {
593 results
.put(recipient
,
594 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
596 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
597 final var result
= context
.getSendHelper()
598 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
599 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
602 return new SendMessageResults(timestamp
, results
);
605 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
606 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
609 private SendMessageResults
sendTypingMessage(
610 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
611 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
612 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
613 final var timestamp
= System
.currentTimeMillis();
614 for (var recipient
: recipients
) {
615 if (recipient
instanceof RecipientIdentifier
.Single single
) {
616 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
618 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
619 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
620 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
621 } catch (UnregisteredRecipientException e
) {
622 results
.put(recipient
,
623 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
625 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
626 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
627 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
628 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
629 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
632 return new SendMessageResults(timestamp
, results
);
636 public SendMessageResults
sendTypingMessage(
637 TypingAction action
, Set
<RecipientIdentifier
> recipients
638 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
639 return sendTypingMessage(action
.toSignalService(), recipients
);
643 public SendMessageResults
sendReadReceipt(
644 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
646 final var timestamp
= System
.currentTimeMillis();
647 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
651 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
655 public SendMessageResults
sendViewedReceipt(
656 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
658 final var timestamp
= System
.currentTimeMillis();
659 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
663 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
666 private SendMessageResults
sendReceiptMessage(
667 final RecipientIdentifier
.Single sender
,
668 final long timestamp
,
669 final SignalServiceReceiptMessage receiptMessage
672 final var result
= context
.getSendHelper()
673 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
674 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
675 } catch (UnregisteredRecipientException e
) {
676 return new SendMessageResults(timestamp
,
677 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
682 public SendMessageResults
sendMessage(
683 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
684 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
685 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
686 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
688 "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.");
690 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
691 applyMessage(messageBuilder
, message
);
692 return sendMessage(messageBuilder
, recipients
, notifySelf
);
696 public SendMessageResults
sendEditMessage(
697 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
698 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
699 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
700 applyMessage(messageBuilder
, message
);
701 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
704 private void applyMessage(
705 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
706 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
707 if (message
.messageText().length() > 2000) {
708 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
709 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
710 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
711 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
712 messageBuilder
.withAttachment(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
714 messageBuilder
.withBody(message
.messageText());
716 if (!message
.attachments().isEmpty()) {
717 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
719 if (!message
.mentions().isEmpty()) {
720 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
722 if (!message
.textStyles().isEmpty()) {
723 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
725 if (message
.quote().isPresent()) {
726 final var quote
= message
.quote().get();
727 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
728 for (final var a
: quote
.attachments()) {
729 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
731 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
732 quotedAttachments
.add(quotedAttachment
);
734 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
735 context
.getRecipientHelper()
736 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
740 resolveMentions(quote
.mentions()),
741 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
742 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
744 if (message
.sticker().isPresent()) {
745 final var sticker
= message
.sticker().get();
746 final var packId
= StickerPackId
.deserialize(sticker
.packId());
747 final var stickerId
= sticker
.stickerId();
749 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
750 if (stickerPack
== null) {
751 throw new InvalidStickerException("Sticker pack not found");
753 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
754 if (manifest
.stickers().size() <= stickerId
) {
755 throw new InvalidStickerException("Sticker id not part of this pack");
757 final var manifestSticker
= manifest
.stickers().get(stickerId
);
758 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
759 if (streamDetails
== null) {
760 throw new InvalidStickerException("Missing local sticker file");
762 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
763 stickerPack
.packKey(),
765 manifestSticker
.emoji(),
766 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
768 if (!message
.previews().isEmpty()) {
769 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
770 for (final var p
: message
.previews()) {
771 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
772 .uploadAttachment(p
.image().get()) : null;
773 previews
.add(new SignalServicePreview(p
.url(),
777 Optional
.ofNullable(image
)));
779 messageBuilder
.withPreviews(previews
);
781 if (message
.storyReply().isPresent()) {
782 final var storyReply
= message
.storyReply().get();
783 final var authorServiceId
= context
.getRecipientHelper()
784 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
786 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
787 storyReply
.timestamp()));
791 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
792 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
793 for (final var m
: mentionList
) {
794 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
795 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
796 .resolveSignalServiceAddress(recipientId
)
797 .getServiceId(), m
.start(), m
.length()));
803 public SendMessageResults
sendRemoteDeleteMessage(
804 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
805 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
806 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
807 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
808 for (final var recipient
: recipients
) {
809 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
810 account
.getMessageSendLogStore()
811 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
812 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
814 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
815 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
816 if (address
.serviceId().isPresent()) {
817 account
.getMessageSendLogStore()
818 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
820 } catch (UnregisteredRecipientException ignored
) {
822 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
823 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
826 return sendMessage(messageBuilder
, recipients
, false);
830 public SendMessageResults
sendMessageReaction(
833 RecipientIdentifier
.Single targetAuthor
,
834 long targetSentTimestamp
,
835 Set
<RecipientIdentifier
> recipients
,
836 final boolean isStory
837 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
838 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
839 final var authorServiceId
= context
.getRecipientHelper()
840 .resolveSignalServiceAddress(targetAuthorRecipientId
)
842 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
843 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
845 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
846 targetSentTimestamp
));
848 return sendMessage(messageBuilder
, recipients
, false);
852 public SendMessageResults
sendPaymentNotificationMessage(
853 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
854 ) throws IOException
{
855 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
856 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
857 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
859 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
860 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
861 throw new AssertionError(e
);
866 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
867 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
870 return sendMessage(messageBuilder
,
871 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
873 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
874 throw new AssertionError(e
);
876 for (var recipient
: recipients
) {
877 final RecipientId recipientId
;
879 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
880 } catch (UnregisteredRecipientException e
) {
883 final var serviceId
= context
.getAccount()
884 .getRecipientAddressResolver()
885 .resolveRecipientAddress(recipientId
)
887 if (serviceId
.isPresent()) {
888 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
895 public SendMessageResults
sendMessageRequestResponse(
896 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
898 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
899 for (final var recipient
: recipients
) {
900 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
901 recipient
instanceof RecipientIdentifier
.Single single
902 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
904 final var result
= context
.getSyncHelper()
905 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
906 if (result
!= null) {
907 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
909 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
910 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
912 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
913 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
914 if (result
!= null) {
915 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
917 } catch (UnregisteredRecipientException e
) {
918 results
.put(recipient
,
919 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
921 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
922 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
923 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
926 return new SendMessageResults(0, results
);
930 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
931 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
932 if (recipientIdOptional
.isPresent()) {
933 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
934 account
.removeRecipient(recipientIdOptional
.get());
940 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
941 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
942 if (recipientIdOptional
.isPresent()) {
943 account
.removeRecipient(recipientIdOptional
.get());
949 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
950 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
951 if (recipientIdOptional
.isPresent()) {
952 account
.getContactStore().deleteContact(recipientIdOptional
.get());
958 public void setContactName(
959 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
960 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
961 if (!account
.isPrimaryDevice()) {
962 throw new NotPrimaryDeviceException();
964 context
.getContactHelper()
965 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
970 public void setContactsBlocked(
971 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
972 ) throws IOException
, UnregisteredRecipientException
{
973 if (recipients
.isEmpty()) {
976 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
977 final var selfRecipientId
= account
.getSelfRecipientId();
978 boolean shouldRotateProfileKey
= false;
979 for (final var recipientId
: recipientIds
) {
980 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
983 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
984 context
.getSyncHelper()
985 .sendMessageRequestResponse(blocked
986 ? MessageRequestResponse
.Type
.BLOCK
987 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
988 // if we don't have a common group with the blocked contact we need to rotate the profile key
989 shouldRotateProfileKey
= blocked
&& (
990 shouldRotateProfileKey
|| account
.getGroupStore()
993 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
996 if (shouldRotateProfileKey
) {
997 context
.getProfileHelper().rotateProfileKey();
999 context
.getSyncHelper().sendBlockedList();
1000 syncRemoteStorage();
1004 public void setGroupsBlocked(
1005 final Collection
<GroupId
> groupIds
, final boolean blocked
1006 ) throws GroupNotFoundException
, IOException
{
1007 if (groupIds
.isEmpty()) {
1010 boolean shouldRotateProfileKey
= false;
1011 for (final var groupId
: groupIds
) {
1012 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1015 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1016 context
.getSyncHelper()
1017 .sendMessageRequestResponse(blocked
1018 ? MessageRequestResponse
.Type
.BLOCK
1019 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1020 shouldRotateProfileKey
= blocked
;
1022 if (shouldRotateProfileKey
) {
1023 context
.getProfileHelper().rotateProfileKey();
1025 context
.getSyncHelper().sendBlockedList();
1026 syncRemoteStorage();
1030 public void setExpirationTimer(
1031 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1032 ) throws IOException
, UnregisteredRecipientException
{
1033 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1034 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1035 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1037 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1038 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1039 throw new AssertionError(e
);
1041 syncRemoteStorage();
1045 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1046 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1048 var messageSender
= dependencies
.getMessageSender();
1050 var packKey
= KeyUtils
.createStickerUploadKey();
1051 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1052 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1054 var sticker
= new StickerPack(packId
, packKey
);
1055 account
.getStickerStore().addStickerPack(sticker
);
1056 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1058 return new StickerPackUrl(packId
, packKey
);
1062 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1063 final var packId
= url
.packId();
1064 final var packKey
= url
.packKey();
1066 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1067 } catch (InvalidMessageException e
) {
1068 throw new IOException(e
);
1071 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1072 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1076 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1077 final var stickerPackStore
= context
.getStickerPackStore();
1078 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1079 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1081 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1082 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1083 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1087 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1088 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1089 } catch (Exception e
) {
1090 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1094 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1099 public void requestAllSyncData() {
1100 context
.getSyncHelper().requestAllSyncData();
1101 syncRemoteStorage();
1104 void syncRemoteStorage() {
1105 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1109 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1110 synchronized (messageHandlers
) {
1111 if (isWeakListener
) {
1112 weakHandlers
.add(handler
);
1114 messageHandlers
.add(handler
);
1115 startReceiveThreadIfRequired();
1120 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1122 private void startReceiveThreadIfRequired() {
1123 if (receiveThread
!= null || isReceivingSynchronous
) {
1126 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1127 logger
.debug("Starting receiving messages");
1128 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1129 logger
.debug("Finished receiving messages");
1130 synchronized (messageHandlers
) {
1131 receiveThread
= null;
1133 // Check if in the meantime another handler has been registered
1134 if (!messageHandlers
.isEmpty()) {
1135 logger
.debug("Another handler has been registered, starting receive thread again");
1136 startReceiveThreadIfRequired();
1142 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1143 synchronized (messageHandlers
) {
1144 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1146 h
.handleMessage(envelope
, e
);
1147 } catch (Throwable ex
) {
1148 logger
.warn("Message handler failed, ignoring", ex
);
1155 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1156 final Thread thread
;
1157 synchronized (messageHandlers
) {
1158 weakHandlers
.remove(handler
);
1159 messageHandlers
.remove(handler
);
1160 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1163 thread
= receiveThread
;
1164 receiveThread
= null;
1167 stopReceiveThread(thread
);
1170 private void stopReceiveThread(final Thread thread
) {
1171 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1172 logger
.debug("Receive stop requested, interrupting read from server.");
1177 } catch (InterruptedException ignored
) {
1182 public boolean isReceiving() {
1183 if (isReceivingSynchronous
) {
1186 synchronized (messageHandlers
) {
1187 return !messageHandlers
.isEmpty();
1192 public void receiveMessages(
1193 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1194 ) throws IOException
, AlreadyReceivingException
{
1195 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1199 public void stopReceiveMessages() {
1200 Thread thread
= null;
1201 synchronized (messageHandlers
) {
1202 if (isReceivingSynchronous
) {
1203 thread
= receiveThread
;
1204 receiveThread
= null;
1207 if (thread
!= null) {
1208 stopReceiveThread(thread
);
1212 private void receiveMessages(
1213 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1214 ) throws IOException
, AlreadyReceivingException
{
1215 synchronized (messageHandlers
) {
1216 if (isReceiving()) {
1217 throw new AlreadyReceivingException("Already receiving message.");
1219 isReceivingSynchronous
= true;
1220 receiveThread
= Thread
.currentThread();
1223 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1224 passReceivedMessageToHandlers(envelope
, e
);
1225 handler
.handleMessage(envelope
, e
);
1228 synchronized (messageHandlers
) {
1229 receiveThread
= null;
1230 isReceivingSynchronous
= false;
1231 if (!messageHandlers
.isEmpty()) {
1232 startReceiveThreadIfRequired();
1239 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1240 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1244 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1245 final RecipientId recipientId
;
1247 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1248 } catch (UnregisteredRecipientException e
) {
1251 return context
.getContactHelper().isContactBlocked(recipientId
);
1255 public void sendContacts() throws IOException
{
1256 context
.getSyncHelper().sendContacts();
1260 public List
<Recipient
> getRecipients(
1261 boolean onlyContacts
,
1262 Optional
<Boolean
> blocked
,
1263 Collection
<RecipientIdentifier
.Single
> recipients
,
1264 Optional
<String
> name
1266 final var recipientIds
= recipients
.stream().map(a
-> {
1268 return context
.getRecipientHelper().resolveRecipient(a
);
1269 } catch (UnregisteredRecipientException e
) {
1272 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1273 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1276 // refresh profiles of explicitly given recipients
1277 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1278 return account
.getRecipientStore()
1279 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1281 .map(s
-> new Recipient(s
.getRecipientId(),
1282 s
.getAddress().toApiRecipientAddress(),
1285 s
.getExpiringProfileKeyCredential(),
1291 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1292 final RecipientId recipientId
;
1294 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1295 } catch (UnregisteredRecipientException e
) {
1299 final var contact
= account
.getContactStore().getContact(recipientId
);
1300 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1301 return contact
.getName();
1304 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1305 if (profile
!= null) {
1306 return profile
.getDisplayName();
1313 public Group
getGroup(GroupId groupId
) {
1314 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1318 public List
<Identity
> getIdentities() {
1319 return account
.getIdentityKeyStore()
1322 .map(this::toIdentity
)
1323 .filter(Objects
::nonNull
)
1327 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1328 if (identityInfo
== null) {
1332 final var address
= account
.getRecipientAddressResolver()
1333 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1334 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1335 identityInfo
.getServiceId())) {
1338 final var scannableFingerprint
= context
.getIdentityHelper()
1339 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1340 return new Identity(address
.toApiRecipientAddress(),
1341 identityInfo
.getIdentityKey(),
1342 context
.getIdentityHelper()
1343 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1344 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1345 identityInfo
.getTrustLevel(),
1346 identityInfo
.getDateAddedTimestamp());
1350 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1351 ServiceId serviceId
;
1353 final var address
= account
.getRecipientAddressResolver()
1354 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1355 if (address
.serviceId().isEmpty()) {
1358 serviceId
= address
.serviceId().get();
1359 } catch (UnregisteredRecipientException e
) {
1362 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1363 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1367 public boolean trustIdentityVerified(
1368 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1369 ) throws UnregisteredRecipientException
{
1370 return switch (verificationCode
) {
1371 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1372 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1373 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1374 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1375 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1376 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1377 case null -> throw new AssertionError("Invalid verification code type");
1382 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1383 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1386 private boolean trustIdentity(
1387 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1388 ) throws UnregisteredRecipientException
{
1389 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1390 final var updated
= trustMethod
.apply(recipientId
);
1391 if (updated
&& this.isReceiving()) {
1392 context
.getReceiveHelper().setNeedsToRetryFailedMessages(true);
1398 public void addAddressChangedListener(final Runnable listener
) {
1399 synchronized (addressChangedListeners
) {
1400 addressChangedListeners
.add(listener
);
1405 public void addClosedListener(final Runnable listener
) {
1406 synchronized (closedListeners
) {
1407 closedListeners
.add(listener
);
1412 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1413 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1417 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1418 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1419 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1420 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1421 if (streamDetails
== null) {
1422 throw new FileNotFoundException();
1424 return streamDetails
.getStream();
1428 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1429 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1430 context
.getProfileHelper().getRecipientProfile(recipientId
);
1431 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1432 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1433 if (streamDetails
== null) {
1434 throw new FileNotFoundException();
1436 return streamDetails
.getStream();
1440 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1441 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1442 context
.getGroupHelper().getGroup(groupId
);
1443 if (streamDetails
== null) {
1444 throw new FileNotFoundException();
1446 return streamDetails
.getStream();
1450 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1451 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1452 if (streamDetails
== null) {
1453 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1456 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1457 } catch (InvalidMessageException e
) {
1458 logger
.warn("Failed to download sticker pack");
1462 if (streamDetails
== null) {
1463 throw new FileNotFoundException();
1465 return streamDetails
.getStream();
1469 public void close() {
1471 synchronized (messageHandlers
) {
1472 weakHandlers
.clear();
1473 messageHandlers
.clear();
1474 thread
= receiveThread
;
1475 receiveThread
= null;
1477 if (thread
!= null) {
1478 stopReceiveThread(thread
);
1483 dependencies
.getSignalWebSocket().disconnect();
1484 dependencies
.getPushServiceSocket().close();
1485 disposable
.dispose();
1487 if (account
!= null) {
1491 synchronized (closedListeners
) {
1492 closedListeners
.forEach(Runnable
::run
);
1493 closedListeners
.clear();