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
.DeviceLimitExceededException
;
27 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
28 import org
.asamk
.signal
.manager
.api
.Group
;
29 import org
.asamk
.signal
.manager
.api
.GroupId
;
30 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
31 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
32 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
33 import org
.asamk
.signal
.manager
.api
.Identity
;
34 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
35 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
36 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidNumberException
;
39 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
40 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
41 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
42 import org
.asamk
.signal
.manager
.api
.Message
;
43 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
44 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
45 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
46 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
47 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
48 import org
.asamk
.signal
.manager
.api
.Pair
;
49 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
50 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
51 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
52 import org
.asamk
.signal
.manager
.api
.Profile
;
53 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
54 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
55 import org
.asamk
.signal
.manager
.api
.Recipient
;
56 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
57 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
58 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
59 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
61 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
62 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
63 import org
.asamk
.signal
.manager
.api
.TextStyle
;
64 import org
.asamk
.signal
.manager
.api
.TypingAction
;
65 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
66 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
67 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
68 import org
.asamk
.signal
.manager
.api
.UserStatus
;
69 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
70 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
71 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
72 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
73 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
74 import org
.asamk
.signal
.manager
.helper
.Context
;
75 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
76 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
77 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
78 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
79 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
80 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
81 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
82 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
83 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
84 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
85 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
86 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
87 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
88 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
89 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
90 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
91 import org
.asamk
.signal
.manager
.util
.PhoneNumberFormatter
;
92 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
93 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
94 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
95 import org
.slf4j
.Logger
;
96 import org
.slf4j
.LoggerFactory
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
101 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
103 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
104 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
105 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
106 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
107 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
108 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
109 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
110 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
111 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
112 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
114 import java
.io
.ByteArrayInputStream
;
116 import java
.io
.FileNotFoundException
;
117 import java
.io
.IOException
;
118 import java
.io
.InputStream
;
119 import java
.nio
.charset
.StandardCharsets
;
120 import java
.time
.Duration
;
121 import java
.util
.ArrayList
;
122 import java
.util
.Collection
;
123 import java
.util
.HashMap
;
124 import java
.util
.HashSet
;
125 import java
.util
.List
;
126 import java
.util
.Map
;
127 import java
.util
.Objects
;
128 import java
.util
.Optional
;
129 import java
.util
.Set
;
130 import java
.util
.concurrent
.ExecutorService
;
131 import java
.util
.concurrent
.Executors
;
132 import java
.util
.concurrent
.TimeUnit
;
133 import java
.util
.concurrent
.atomic
.AtomicInteger
;
134 import java
.util
.concurrent
.atomic
.AtomicLong
;
135 import java
.util
.function
.Function
;
136 import java
.util
.stream
.Collectors
;
137 import java
.util
.stream
.Stream
;
139 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
140 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
143 import static org
.asamk
.signal
.manager
.config
.ServiceConfig
.MAX_MESSAGE_SIZE_BYTES
;
144 import static org
.asamk
.signal
.manager
.util
.Utils
.handleResponseException
;
145 import static org
.signal
.core
.util
.StringExtensionsKt
.splitByByteLength
;
147 public class ManagerImpl
implements Manager
{
149 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
151 private SignalAccount account
;
152 private final SignalDependencies dependencies
;
153 private final Context context
;
155 private final ExecutorService executor
= Executors
.newCachedThreadPool();
157 private Thread receiveThread
;
158 private boolean isReceivingSynchronous
;
159 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
160 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
161 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
162 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
163 private final CompositeDisposable disposable
= new CompositeDisposable();
164 private final AtomicLong lastMessageTimestamp
= new AtomicLong();
167 SignalAccount account
,
168 PathConfig pathConfig
,
169 AccountFileUpdater accountFileUpdater
,
170 ServiceEnvironmentConfig serviceEnvironmentConfig
,
173 this.account
= account
;
175 final var sessionLock
= new ReentrantSignalSessionLock();
176 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
178 account
.getCredentialsProvider(),
179 account
.getSignalServiceDataStore(),
182 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
183 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
184 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
186 this.context
= new Context(account
, new AccountFileUpdater() {
188 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
189 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
190 synchronized (addressChangedListeners
) {
191 addressChangedListeners
.forEach(Runnable
::run
);
196 public void removeAccount() {
197 accountFileUpdater
.removeAccount();
199 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
200 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
201 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
202 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
203 synchronized (this) {
207 disposable
.add(account
.getIdentityKeyStore()
208 .getIdentityChanges()
209 .observeOn(Schedulers
.from(executor
))
210 .subscribe(serviceId
-> {
211 logger
.trace("Archiving old sessions for {}", serviceId
);
212 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
213 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
214 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
215 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
216 final var profile
= account
.getProfileStore().getProfile(recipientId
);
217 if (profile
!= null) {
218 account
.getProfileStore()
219 .storeProfile(recipientId
,
220 Profile
.newBuilder(profile
)
221 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
222 .withLastUpdateTimestamp(0)
229 public String
getSelfNumber() {
230 return account
.getNumber();
233 public void checkAccountState() throws IOException
{
234 context
.getAccountHelper().checkAccountState();
235 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
236 if (lastRecipientsRefresh
== null
237 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
238 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
239 context
.getAccountHelper().checkWhoAmiI();
244 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
245 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
247 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
248 if (!canonicalizedNumber
.equals(n
)) {
249 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
251 return canonicalizedNumber
;
252 } catch (InvalidNumberException e
) {
257 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
258 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
260 .filter(s
-> !s
.isEmpty())
261 .collect(Collectors
.toSet());
263 final Map
<String
, RegisteredUser
> registeredUsers
;
265 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
266 } catch (CdsiResourceExhaustedException e
) {
267 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
268 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
271 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
272 final var number
= canonicalizedNumbers
.get(n
);
273 final var user
= registeredUsers
.get(number
);
274 final var serviceId
= user
== null ?
null : user
.getServiceId();
275 final var profile
= serviceId
== null
277 : context
.getProfileHelper()
278 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
279 return new UserStatus(number
.isEmpty() ?
null : number
,
280 serviceId
== null ?
null : serviceId
.getRawUuid(),
282 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
287 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
288 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
289 for (final var username
: usernames
) {
291 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
292 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
293 registeredUsers
.put(username
, address
);
294 } catch (UnregisteredRecipientException e
) {
299 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
300 final var user
= registeredUsers
.get(username
);
301 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
302 final var profile
= serviceId
== null
304 : context
.getProfileHelper()
305 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
306 return new UsernameStatus(username
,
307 serviceId
== null ?
null : serviceId
.getRawUuid(),
309 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
314 public void updateAccountAttributes(
316 Boolean unrestrictedUnidentifiedSender
,
317 final Boolean discoverableByNumber
,
318 final Boolean numberSharing
319 ) throws IOException
{
320 if (deviceName
!= null) {
321 context
.getAccountHelper().setDeviceName(deviceName
);
323 if (unrestrictedUnidentifiedSender
!= null) {
324 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
326 if (discoverableByNumber
!= null) {
327 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
329 if (numberSharing
!= null) {
330 account
.getConfigurationStore()
331 .setPhoneNumberSharingMode(numberSharing
332 ? PhoneNumberSharingMode
.EVERYBODY
333 : PhoneNumberSharingMode
.NOBODY
);
335 context
.getAccountHelper().updateAccountAttributes();
336 context
.getAccountHelper().checkWhoAmiI();
340 public Configuration
getConfiguration() {
341 final var configurationStore
= account
.getConfigurationStore();
342 return Configuration
.from(configurationStore
);
346 public void updateConfiguration(Configuration configuration
) {
347 final var configurationStore
= account
.getConfigurationStore();
348 if (configuration
.readReceipts().isPresent()) {
349 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
351 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
352 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
354 if (configuration
.typingIndicators().isPresent()) {
355 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
357 if (configuration
.linkPreviews().isPresent()) {
358 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
360 context
.getSyncHelper().sendConfigurationMessage();
365 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
366 context
.getProfileHelper()
367 .setProfile(updateProfile
.getGivenName(),
368 updateProfile
.getFamilyName(),
369 updateProfile
.getAbout(),
370 updateProfile
.getAboutEmoji(),
371 updateProfile
.isDeleteAvatar()
373 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
374 updateProfile
.getMobileCoinAddress());
375 context
.getSyncHelper().sendSyncFetchProfileMessage();
378 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
379 context
.getAccountHelper().refreshCurrentUsername();
383 public String
getUsername() {
384 return account
.getUsername();
388 public UsernameLinkUrl
getUsernameLink() {
389 return new UsernameLinkUrl(account
.getUsernameLink());
393 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
395 if (username
.contains(".")) {
396 context
.getAccountHelper().reserveExactUsername(username
);
398 context
.getAccountHelper().reserveUsernameFromNickname(username
);
400 } catch (UsernameMalformedException e
) {
401 throw new InvalidUsernameException("Username is malformed", e
);
402 } catch (UsernameTakenException e
) {
403 throw new InvalidUsernameException("Username is already registered", e
);
404 } catch (BaseUsernameException e
) {
405 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
410 public void deleteUsername() throws IOException
{
411 context
.getAccountHelper().deleteUsername();
415 public void startChangeNumber(
417 boolean voiceVerification
,
419 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
420 if (!account
.isPrimaryDevice()) {
421 throw new NotPrimaryDeviceException();
423 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
427 public void finishChangeNumber(
429 String verificationCode
,
431 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
432 if (!account
.isPrimaryDevice()) {
433 throw new NotPrimaryDeviceException();
435 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
439 public void unregister() throws IOException
{
440 context
.getAccountHelper().unregister();
444 public void deleteAccount() throws IOException
{
445 context
.getAccountHelper().deleteAccount();
449 public void submitRateLimitRecaptchaChallenge(
452 ) throws IOException
, CaptchaRejectedException
{
453 captcha
= captcha
== null ?
"" : captcha
.replace("signalcaptcha://", "");
456 handleResponseException(dependencies
.getRateLimitChallengeApi().submitCaptchaChallenge(challenge
, captcha
));
457 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
458 throw new CaptchaRejectedException();
463 public List
<Device
> getLinkedDevices() throws IOException
{
464 var devices
= handleResponseException(dependencies
.getLinkDeviceApi().getDevices());
465 account
.setMultiDevice(devices
.size() > 1);
466 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
467 return devices
.stream().map(d
-> {
468 String deviceName
= d
.getName();
469 if (deviceName
!= null) {
471 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
472 } catch (IOException e
) {
473 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
476 return new Device(d
.getId(),
480 d
.getId() == account
.getDeviceId());
485 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
486 if (!account
.isPrimaryDevice()) {
487 throw new NotPrimaryDeviceException();
489 context
.getAccountHelper().removeLinkedDevices(deviceId
);
493 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
, DeviceLimitExceededException
{
494 if (!account
.isPrimaryDevice()) {
495 throw new NotPrimaryDeviceException();
497 context
.getAccountHelper().addDevice(linkUrl
);
501 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
502 if (!account
.isPrimaryDevice()) {
503 throw new NotPrimaryDeviceException();
505 if (pin
.isPresent()) {
506 context
.getAccountHelper().setRegistrationPin(pin
.get());
508 context
.getAccountHelper().removeRegistrationPin();
512 void refreshPreKeys() throws IOException
{
513 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
517 public List
<Group
> getGroups() {
518 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
521 private Group
toGroup(final GroupInfo groupInfo
) {
522 if (groupInfo
== null) {
526 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
530 public SendGroupMessageResults
quitGroup(
532 Set
<RecipientIdentifier
.Single
> groupAdmins
533 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
534 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
535 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
539 public void deleteGroup(GroupId groupId
) throws IOException
{
540 final var group
= context
.getGroupHelper().getGroup(groupId
);
541 if (group
.isMember(account
.getSelfRecipientId())) {
542 throw new IOException(
543 "The local group information cannot be removed, as the user is still a member of the group");
545 context
.getGroupHelper().deleteGroup(groupId
);
549 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
551 Set
<RecipientIdentifier
.Single
> members
,
553 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
554 return context
.getGroupHelper()
556 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
561 public SendGroupMessageResults
updateGroup(
562 final GroupId groupId
,
563 final UpdateGroup updateGroup
564 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
565 return context
.getGroupHelper()
566 .updateGroup(groupId
,
567 updateGroup
.getName(),
568 updateGroup
.getDescription(),
569 updateGroup
.getMembers() == null
571 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
572 updateGroup
.getRemoveMembers() == null
574 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
575 updateGroup
.getAdmins() == null
577 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
578 updateGroup
.getRemoveAdmins() == null
580 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
581 updateGroup
.getBanMembers() == null
583 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
584 updateGroup
.getUnbanMembers() == null
586 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
587 updateGroup
.isResetGroupLink(),
588 updateGroup
.getGroupLinkState(),
589 updateGroup
.getAddMemberPermission(),
590 updateGroup
.getEditDetailsPermission(),
591 updateGroup
.getAvatarFile(),
592 updateGroup
.getExpirationTimer(),
593 updateGroup
.getIsAnnouncementGroup());
597 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
598 GroupInviteLinkUrl inviteLinkUrl
599 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
600 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
603 private long getNextMessageTimestamp() {
605 final var last
= lastMessageTimestamp
.get();
606 final var timestamp
= System
.currentTimeMillis();
607 if (last
== timestamp
) {
610 } catch (InterruptedException e
) {
611 Thread
.currentThread().interrupt();
615 if (lastMessageTimestamp
.compareAndSet(last
, timestamp
)) {
621 private SendMessageResults
sendMessage(
622 SignalServiceDataMessage
.Builder messageBuilder
,
623 Set
<RecipientIdentifier
> recipients
,
625 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
626 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
629 private SendMessageResults
sendMessage(
630 SignalServiceDataMessage
.Builder messageBuilder
,
631 Set
<RecipientIdentifier
> recipients
,
633 Optional
<Long
> editTargetTimestamp
634 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
635 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
636 long timestamp
= getNextMessageTimestamp();
637 messageBuilder
.withTimestamp(timestamp
);
638 for (final var recipient
: recipients
) {
639 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
640 recipient
instanceof RecipientIdentifier
.Single single
641 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
643 final var result
= notifySelf
644 ? context
.getSendHelper()
645 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
646 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
647 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
648 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
650 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
651 final var result
= context
.getSendHelper()
652 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
653 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
654 } catch (UnregisteredRecipientException e
) {
655 results
.put(recipient
,
656 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
658 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
659 final var result
= context
.getSendHelper()
660 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
661 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
664 return new SendMessageResults(timestamp
, results
);
667 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
668 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
671 private SendMessageResults
sendTypingMessage(
672 SignalServiceTypingMessage
.Action action
,
673 Set
<RecipientIdentifier
> recipients
674 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
675 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
676 final var timestamp
= getNextMessageTimestamp();
677 for (var recipient
: recipients
) {
678 if (recipient
instanceof RecipientIdentifier
.Single single
) {
679 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
681 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
682 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
683 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
684 } catch (UnregisteredRecipientException e
) {
685 results
.put(recipient
,
686 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
688 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
689 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
690 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
691 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
692 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
695 return new SendMessageResults(timestamp
, results
);
699 public SendMessageResults
sendTypingMessage(
701 Set
<RecipientIdentifier
> recipients
702 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
703 return sendTypingMessage(action
.toSignalService(), recipients
);
707 public SendMessageResults
sendReadReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
708 final var timestamp
= getNextMessageTimestamp();
709 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
713 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
717 public SendMessageResults
sendViewedReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
718 final var timestamp
= getNextMessageTimestamp();
719 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
723 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
726 private SendMessageResults
sendReceiptMessage(
727 final RecipientIdentifier
.Single sender
,
728 final long timestamp
,
729 final SignalServiceReceiptMessage receiptMessage
732 final var recipientId
= context
.getRecipientHelper().resolveRecipient(sender
);
733 final var result
= context
.getSendHelper().sendReceiptMessage(receiptMessage
, recipientId
);
735 final var serviceId
= account
.getRecipientAddressResolver()
736 .resolveRecipientAddress(recipientId
)
738 if (serviceId
.isPresent()) {
739 context
.getSyncHelper().sendSyncReceiptMessage(serviceId
.get(), receiptMessage
);
741 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
742 } catch (UnregisteredRecipientException e
) {
743 return new SendMessageResults(timestamp
,
744 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
749 public SendMessageResults
sendMessage(
751 Set
<RecipientIdentifier
> recipients
,
753 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
754 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
755 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
757 "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.");
759 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
760 applyMessage(messageBuilder
, message
);
761 return sendMessage(messageBuilder
, recipients
, notifySelf
);
765 public SendMessageResults
sendEditMessage(
767 Set
<RecipientIdentifier
> recipients
,
768 long editTargetTimestamp
769 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
770 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
771 applyMessage(messageBuilder
, message
);
772 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
775 private void applyMessage(
776 final SignalServiceDataMessage
.Builder messageBuilder
,
777 final Message message
778 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
779 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
780 if (Utf8
.size(message
.messageText()) > MAX_MESSAGE_SIZE_BYTES
) {
781 final var result
= splitByByteLength(message
.messageText(), MAX_MESSAGE_SIZE_BYTES
);
782 final var trimmed
= result
.getFirst();
783 final var remainder
= result
.getSecond();
784 if (remainder
!= null) {
785 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
786 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
787 final var streamDetails
= new StreamDetails(new ByteArrayInputStream(messageBytes
),
789 messageBytes
.length
);
790 final var textAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
793 messageBuilder
.withBody(trimmed
);
794 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
796 messageBuilder
.withBody(message
.messageText());
799 messageBuilder
.withBody(message
.messageText());
801 if (!message
.attachments().isEmpty()) {
802 final var uploadedAttachments
= context
.getAttachmentHelper().uploadAttachments(message
.attachments());
803 if (!additionalAttachments
.isEmpty()) {
804 additionalAttachments
.addAll(uploadedAttachments
);
805 messageBuilder
.withAttachments(additionalAttachments
);
807 messageBuilder
.withAttachments(uploadedAttachments
);
809 } else if (!additionalAttachments
.isEmpty()) {
810 messageBuilder
.withAttachments(additionalAttachments
);
812 if (!message
.mentions().isEmpty()) {
813 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
815 if (!message
.textStyles().isEmpty()) {
816 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
818 if (message
.quote().isPresent()) {
819 final var quote
= message
.quote().get();
820 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
821 for (final var a
: quote
.attachments()) {
822 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
824 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
825 quotedAttachments
.add(quotedAttachment
);
827 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
828 context
.getRecipientHelper()
829 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
833 resolveMentions(quote
.mentions()),
834 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
835 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
837 if (message
.sticker().isPresent()) {
838 final var sticker
= message
.sticker().get();
839 final var packId
= StickerPackId
.deserialize(sticker
.packId());
840 final var stickerId
= sticker
.stickerId();
842 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
843 if (stickerPack
== null) {
844 throw new InvalidStickerException("Sticker pack not found");
846 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
847 if (manifest
.stickers().size() <= stickerId
) {
848 throw new InvalidStickerException("Sticker id not part of this pack");
850 final var manifestSticker
= manifest
.stickers().get(stickerId
);
851 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
852 if (streamDetails
== null) {
853 throw new InvalidStickerException("Missing local sticker file");
855 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
856 final var stickerAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
859 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
860 stickerPack
.packKey(),
862 manifestSticker
.emoji(),
865 if (!message
.previews().isEmpty()) {
866 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
867 for (final var p
: message
.previews()) {
868 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
869 .uploadAttachment(p
.image().get()) : null;
870 previews
.add(new SignalServicePreview(p
.url(),
874 Optional
.ofNullable(image
)));
876 messageBuilder
.withPreviews(previews
);
878 if (message
.storyReply().isPresent()) {
879 final var storyReply
= message
.storyReply().get();
880 final var authorServiceId
= context
.getRecipientHelper()
881 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
883 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
884 storyReply
.timestamp()));
888 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
889 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
890 for (final var m
: mentionList
) {
891 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
892 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
893 .resolveSignalServiceAddress(recipientId
)
894 .getServiceId(), m
.start(), m
.length()));
900 public SendMessageResults
sendRemoteDeleteMessage(
901 long targetSentTimestamp
,
902 Set
<RecipientIdentifier
> recipients
903 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
904 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
905 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
906 for (final var recipient
: recipients
) {
907 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
908 account
.getMessageSendLogStore()
909 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
910 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
911 account
.getMessageSendLogStore()
912 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.from(pni
.pni()));
913 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
915 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
916 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
917 if (address
.serviceId().isPresent()) {
918 account
.getMessageSendLogStore()
919 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
921 } catch (UnregisteredRecipientException ignored
) {
923 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
924 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
927 return sendMessage(messageBuilder
, recipients
, false);
931 public SendMessageResults
sendMessageReaction(
934 RecipientIdentifier
.Single targetAuthor
,
935 long targetSentTimestamp
,
936 Set
<RecipientIdentifier
> recipients
,
937 final boolean isStory
938 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
939 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
940 final var authorServiceId
= context
.getRecipientHelper()
941 .resolveSignalServiceAddress(targetAuthorRecipientId
)
943 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
944 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
946 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
947 targetSentTimestamp
));
949 return sendMessage(messageBuilder
, recipients
, false);
953 public SendMessageResults
sendPaymentNotificationMessage(
956 RecipientIdentifier
.Single recipient
957 ) throws IOException
{
958 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
959 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
960 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
962 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
963 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
964 throw new AssertionError(e
);
969 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
970 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
973 return sendMessage(messageBuilder
,
974 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
976 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
977 throw new AssertionError(e
);
979 for (var recipient
: recipients
) {
980 final RecipientId recipientId
;
982 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
983 } catch (UnregisteredRecipientException e
) {
986 final var serviceId
= context
.getAccount()
987 .getRecipientAddressResolver()
988 .resolveRecipientAddress(recipientId
)
990 if (serviceId
.isPresent()) {
991 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
998 public SendMessageResults
sendMessageRequestResponse(
999 final MessageRequestResponse
.Type type
,
1000 final Set
<RecipientIdentifier
> recipients
1002 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
1003 for (final var recipient
: recipients
) {
1004 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
1005 recipient
instanceof RecipientIdentifier
.Single single
1006 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
1008 final var result
= context
.getSyncHelper()
1009 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
1010 if (result
!= null) {
1011 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1013 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1014 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
1016 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
1017 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
1018 if (result
!= null) {
1019 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1021 } catch (UnregisteredRecipientException e
) {
1022 results
.put(recipient
,
1023 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
1025 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
1026 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
1027 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1030 return new SendMessageResults(0, results
);
1034 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
1035 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1036 if (recipientIdOptional
.isPresent()) {
1037 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
1038 account
.removeRecipient(recipientIdOptional
.get());
1039 syncRemoteStorage();
1044 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
1045 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1046 if (recipientIdOptional
.isPresent()) {
1047 account
.removeRecipient(recipientIdOptional
.get());
1048 syncRemoteStorage();
1053 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
1054 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1055 if (recipientIdOptional
.isPresent()) {
1056 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1057 syncRemoteStorage();
1062 public void setContactName(
1063 final RecipientIdentifier
.Single recipient
,
1064 final String givenName
,
1065 final String familyName
,
1066 final String nickGivenName
,
1067 final String nickFamilyName
,
1069 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1070 if (!account
.isPrimaryDevice()) {
1071 throw new NotPrimaryDeviceException();
1073 context
.getContactHelper()
1074 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
),
1080 syncRemoteStorage();
1084 public void setContactsBlocked(
1085 Collection
<RecipientIdentifier
.Single
> recipients
,
1087 ) throws IOException
, UnregisteredRecipientException
{
1088 if (recipients
.isEmpty()) {
1091 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1092 final var selfRecipientId
= account
.getSelfRecipientId();
1093 boolean shouldRotateProfileKey
= false;
1094 for (final var recipientId
: recipientIds
) {
1095 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1098 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1099 context
.getSyncHelper()
1100 .sendMessageRequestResponse(blocked
1101 ? MessageRequestResponse
.Type
.BLOCK
1102 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1103 // if we don't have a common group with the blocked contact we need to rotate the profile key
1104 shouldRotateProfileKey
= blocked
&& (
1105 shouldRotateProfileKey
|| account
.getGroupStore()
1108 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1111 if (shouldRotateProfileKey
) {
1112 context
.getProfileHelper().rotateProfileKey();
1114 context
.getSyncHelper().sendBlockedList();
1115 syncRemoteStorage();
1119 public void setGroupsBlocked(
1120 final Collection
<GroupId
> groupIds
,
1121 final boolean blocked
1122 ) throws GroupNotFoundException
, IOException
{
1123 if (groupIds
.isEmpty()) {
1126 boolean shouldRotateProfileKey
= false;
1127 for (final var groupId
: groupIds
) {
1128 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1131 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1132 context
.getSyncHelper()
1133 .sendMessageRequestResponse(blocked
1134 ? MessageRequestResponse
.Type
.BLOCK
1135 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1136 shouldRotateProfileKey
= blocked
;
1138 if (shouldRotateProfileKey
) {
1139 context
.getProfileHelper().rotateProfileKey();
1141 context
.getSyncHelper().sendBlockedList();
1142 syncRemoteStorage();
1146 public void setExpirationTimer(
1147 RecipientIdentifier
.Single recipient
,
1148 int messageExpirationTimer
1149 ) throws IOException
, UnregisteredRecipientException
{
1150 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1151 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1152 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1154 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1155 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1156 throw new AssertionError(e
);
1158 syncRemoteStorage();
1162 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1163 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1165 var messageSender
= dependencies
.getMessageSender();
1167 var packKey
= KeyUtils
.createStickerUploadKey();
1168 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1169 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1171 var sticker
= new StickerPack(packId
, packKey
);
1172 account
.getStickerStore().addStickerPack(sticker
);
1173 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1175 return new StickerPackUrl(packId
, packKey
);
1179 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1180 final var packId
= url
.packId();
1181 final var packKey
= url
.packKey();
1183 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1184 } catch (InvalidMessageException e
) {
1185 throw new IOException(e
);
1188 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1189 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1193 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1194 final var stickerPackStore
= context
.getStickerPackStore();
1195 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1196 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1198 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1199 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1200 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1204 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1205 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1206 } catch (Exception e
) {
1207 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1211 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1216 public void requestAllSyncData() {
1217 context
.getSyncHelper().requestAllSyncData();
1218 syncRemoteStorage();
1221 void syncRemoteStorage() {
1222 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1226 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1227 synchronized (messageHandlers
) {
1228 if (isWeakListener
) {
1229 weakHandlers
.add(handler
);
1231 messageHandlers
.add(handler
);
1232 startReceiveThreadIfRequired();
1237 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1239 private void startReceiveThreadIfRequired() {
1240 if (receiveThread
!= null || isReceivingSynchronous
) {
1243 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1244 logger
.debug("Starting receiving messages");
1245 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1246 logger
.debug("Finished receiving messages");
1247 synchronized (messageHandlers
) {
1248 receiveThread
= null;
1250 // Check if in the meantime another handler has been registered
1251 if (!messageHandlers
.isEmpty()) {
1252 logger
.debug("Another handler has been registered, starting receive thread again");
1253 startReceiveThreadIfRequired();
1259 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1260 synchronized (messageHandlers
) {
1261 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1263 h
.handleMessage(envelope
, e
);
1264 } catch (Throwable ex
) {
1265 logger
.warn("Message handler failed, ignoring", ex
);
1272 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1273 final Thread thread
;
1274 synchronized (messageHandlers
) {
1275 weakHandlers
.remove(handler
);
1276 messageHandlers
.remove(handler
);
1277 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1280 thread
= receiveThread
;
1281 receiveThread
= null;
1284 stopReceiveThread(thread
);
1287 private void stopReceiveThread(final Thread thread
) {
1288 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1289 logger
.debug("Receive stop requested, interrupting read from server.");
1294 } catch (InterruptedException ignored
) {
1299 public boolean isReceiving() {
1300 if (isReceivingSynchronous
) {
1303 synchronized (messageHandlers
) {
1304 return !messageHandlers
.isEmpty();
1309 public void receiveMessages(
1310 Optional
<Duration
> timeout
,
1311 Optional
<Integer
> maxMessages
,
1312 ReceiveMessageHandler handler
1313 ) throws IOException
, AlreadyReceivingException
{
1314 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1318 public void stopReceiveMessages() {
1319 Thread thread
= null;
1320 synchronized (messageHandlers
) {
1321 if (isReceivingSynchronous
) {
1322 thread
= receiveThread
;
1323 receiveThread
= null;
1326 if (thread
!= null) {
1327 stopReceiveThread(thread
);
1331 private void receiveMessages(
1333 boolean returnOnTimeout
,
1334 Integer maxMessages
,
1335 ReceiveMessageHandler handler
1336 ) throws IOException
, AlreadyReceivingException
{
1337 synchronized (messageHandlers
) {
1338 if (isReceiving()) {
1339 throw new AlreadyReceivingException("Already receiving message.");
1341 isReceivingSynchronous
= true;
1342 receiveThread
= Thread
.currentThread();
1345 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1346 passReceivedMessageToHandlers(envelope
, e
);
1347 handler
.handleMessage(envelope
, e
);
1350 synchronized (messageHandlers
) {
1351 receiveThread
= null;
1352 isReceivingSynchronous
= false;
1353 if (!messageHandlers
.isEmpty()) {
1354 startReceiveThreadIfRequired();
1361 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1362 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1366 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1367 final RecipientId recipientId
;
1369 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1370 } catch (UnregisteredRecipientException e
) {
1373 return context
.getContactHelper().isContactBlocked(recipientId
);
1377 public void sendContacts() throws IOException
{
1378 context
.getSyncHelper().sendContacts();
1382 public List
<Recipient
> getRecipients(
1383 boolean onlyContacts
,
1384 Optional
<Boolean
> blocked
,
1385 Collection
<RecipientIdentifier
.Single
> recipients
,
1386 Optional
<String
> name
1388 final var recipientIds
= recipients
.stream().map(a
-> {
1390 return context
.getRecipientHelper().resolveRecipient(a
);
1391 } catch (UnregisteredRecipientException e
) {
1394 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1395 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1398 // refresh profiles of explicitly given recipients
1399 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1400 return account
.getRecipientStore()
1401 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1403 .map(s
-> new Recipient(s
.getRecipientId(),
1404 s
.getAddress().toApiRecipientAddress(),
1407 s
.getExpiringProfileKeyCredential(),
1409 s
.getDiscoverable()))
1414 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1415 final RecipientId recipientId
;
1417 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1418 } catch (UnregisteredRecipientException e
) {
1422 final var contact
= account
.getContactStore().getContact(recipientId
);
1423 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1424 return contact
.getName();
1427 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1428 if (profile
!= null) {
1429 return profile
.getDisplayName();
1436 public Group
getGroup(GroupId groupId
) {
1437 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1441 public List
<Identity
> getIdentities() {
1442 return account
.getIdentityKeyStore()
1445 .map(this::toIdentity
)
1446 .filter(Objects
::nonNull
)
1450 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1451 if (identityInfo
== null) {
1455 final var address
= account
.getRecipientAddressResolver()
1456 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1457 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1458 identityInfo
.getServiceId())) {
1461 final var scannableFingerprint
= context
.getIdentityHelper()
1462 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1463 return new Identity(address
.toApiRecipientAddress(),
1464 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1465 context
.getIdentityHelper()
1466 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1467 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1468 identityInfo
.getTrustLevel(),
1469 identityInfo
.getDateAddedTimestamp());
1473 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1474 ServiceId serviceId
;
1476 final var address
= account
.getRecipientAddressResolver()
1477 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1478 if (address
.serviceId().isEmpty()) {
1481 serviceId
= address
.serviceId().get();
1482 } catch (UnregisteredRecipientException e
) {
1485 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1486 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1490 public boolean trustIdentityVerified(
1491 RecipientIdentifier
.Single recipient
,
1492 IdentityVerificationCode verificationCode
1493 ) throws UnregisteredRecipientException
{
1494 return switch (verificationCode
) {
1495 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1496 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1497 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1498 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1499 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1500 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1501 case null -> throw new AssertionError("Invalid verification code type");
1506 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1507 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1510 private boolean trustIdentity(
1511 RecipientIdentifier
.Single recipient
,
1512 Function
<RecipientId
, Boolean
> trustMethod
1513 ) throws UnregisteredRecipientException
{
1514 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1515 final var updated
= trustMethod
.apply(recipientId
);
1516 if (updated
&& this.isReceiving()) {
1517 account
.setNeedsToRetryFailedMessages(true);
1523 public void addAddressChangedListener(final Runnable listener
) {
1524 synchronized (addressChangedListeners
) {
1525 addressChangedListeners
.add(listener
);
1530 public void addClosedListener(final Runnable listener
) {
1531 synchronized (closedListeners
) {
1532 closedListeners
.add(listener
);
1537 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1538 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1542 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1543 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1544 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1545 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1546 if (streamDetails
== null) {
1547 throw new FileNotFoundException();
1549 return streamDetails
.getStream();
1553 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1554 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1555 context
.getProfileHelper().getRecipientProfile(recipientId
);
1556 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1557 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1558 if (streamDetails
== null) {
1559 throw new FileNotFoundException();
1561 return streamDetails
.getStream();
1565 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1566 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1567 context
.getGroupHelper().getGroup(groupId
);
1568 if (streamDetails
== null) {
1569 throw new FileNotFoundException();
1571 return streamDetails
.getStream();
1575 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1576 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1577 if (streamDetails
== null) {
1578 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1581 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1582 } catch (InvalidMessageException e
) {
1583 logger
.warn("Failed to download sticker pack");
1587 if (streamDetails
== null) {
1588 throw new FileNotFoundException();
1590 return streamDetails
.getStream();
1594 public void close() {
1596 synchronized (messageHandlers
) {
1597 weakHandlers
.clear();
1598 messageHandlers
.clear();
1599 thread
= receiveThread
;
1600 receiveThread
= null;
1602 if (thread
!= null) {
1603 stopReceiveThread(thread
);
1608 dependencies
.getAuthenticatedSignalWebSocket().disconnect();
1609 dependencies
.getUnauthenticatedSignalWebSocket().disconnect();
1610 dependencies
.getPushServiceSocket().close();
1611 disposable
.dispose();
1613 if (account
!= null) {
1617 synchronized (closedListeners
) {
1618 closedListeners
.forEach(Runnable
::run
);
1619 closedListeners
.clear();