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
.function
.Function
;
135 import java
.util
.stream
.Collectors
;
136 import java
.util
.stream
.Stream
;
138 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
139 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
142 import static org
.asamk
.signal
.manager
.config
.ServiceConfig
.MAX_MESSAGE_SIZE_BYTES
;
143 import static org
.asamk
.signal
.manager
.util
.Utils
.handleResponseException
;
144 import static org
.signal
.core
.util
.StringExtensionsKt
.splitByByteLength
;
146 public class ManagerImpl
implements Manager
{
148 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
150 private SignalAccount account
;
151 private final SignalDependencies dependencies
;
152 private final Context context
;
154 private final ExecutorService executor
= Executors
.newCachedThreadPool();
156 private Thread receiveThread
;
157 private boolean isReceivingSynchronous
;
158 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
159 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
160 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
161 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
162 private final CompositeDisposable disposable
= new CompositeDisposable();
165 SignalAccount account
,
166 PathConfig pathConfig
,
167 AccountFileUpdater accountFileUpdater
,
168 ServiceEnvironmentConfig serviceEnvironmentConfig
,
171 this.account
= account
;
173 final var sessionLock
= new ReentrantSignalSessionLock();
174 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
176 account
.getCredentialsProvider(),
177 account
.getSignalServiceDataStore(),
180 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
181 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
182 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
184 this.context
= new Context(account
, new AccountFileUpdater() {
186 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
187 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
188 synchronized (addressChangedListeners
) {
189 addressChangedListeners
.forEach(Runnable
::run
);
194 public void removeAccount() {
195 accountFileUpdater
.removeAccount();
197 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
198 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
199 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
200 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
201 synchronized (this) {
205 disposable
.add(account
.getIdentityKeyStore()
206 .getIdentityChanges()
207 .observeOn(Schedulers
.from(executor
))
208 .subscribe(serviceId
-> {
209 logger
.trace("Archiving old sessions for {}", serviceId
);
210 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
211 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
212 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
213 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
214 final var profile
= account
.getProfileStore().getProfile(recipientId
);
215 if (profile
!= null) {
216 account
.getProfileStore()
217 .storeProfile(recipientId
,
218 Profile
.newBuilder(profile
)
219 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
220 .withLastUpdateTimestamp(0)
227 public String
getSelfNumber() {
228 return account
.getNumber();
231 public void checkAccountState() throws IOException
{
232 context
.getAccountHelper().checkAccountState();
233 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
234 if (lastRecipientsRefresh
== null
235 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
236 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
237 context
.getAccountHelper().checkWhoAmiI();
242 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
243 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
245 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
246 if (!canonicalizedNumber
.equals(n
)) {
247 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
249 return canonicalizedNumber
;
250 } catch (InvalidNumberException e
) {
255 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
256 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
258 .filter(s
-> !s
.isEmpty())
259 .collect(Collectors
.toSet());
261 final Map
<String
, RegisteredUser
> registeredUsers
;
263 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
264 } catch (CdsiResourceExhaustedException e
) {
265 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
266 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
269 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
270 final var number
= canonicalizedNumbers
.get(n
);
271 final var user
= registeredUsers
.get(number
);
272 final var serviceId
= user
== null ?
null : user
.getServiceId();
273 final var profile
= serviceId
== null
275 : context
.getProfileHelper()
276 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
277 return new UserStatus(number
.isEmpty() ?
null : number
,
278 serviceId
== null ?
null : serviceId
.getRawUuid(),
280 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
285 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
286 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
287 for (final var username
: usernames
) {
289 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
290 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
291 registeredUsers
.put(username
, address
);
292 } catch (UnregisteredRecipientException e
) {
297 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
298 final var user
= registeredUsers
.get(username
);
299 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
300 final var profile
= serviceId
== null
302 : context
.getProfileHelper()
303 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
304 return new UsernameStatus(username
,
305 serviceId
== null ?
null : serviceId
.getRawUuid(),
307 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
312 public void updateAccountAttributes(
314 Boolean unrestrictedUnidentifiedSender
,
315 final Boolean discoverableByNumber
,
316 final Boolean numberSharing
317 ) throws IOException
{
318 if (deviceName
!= null) {
319 context
.getAccountHelper().setDeviceName(deviceName
);
321 if (unrestrictedUnidentifiedSender
!= null) {
322 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
324 if (discoverableByNumber
!= null) {
325 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
327 if (numberSharing
!= null) {
328 account
.getConfigurationStore()
329 .setPhoneNumberSharingMode(numberSharing
330 ? PhoneNumberSharingMode
.EVERYBODY
331 : PhoneNumberSharingMode
.NOBODY
);
333 context
.getAccountHelper().updateAccountAttributes();
334 context
.getAccountHelper().checkWhoAmiI();
338 public Configuration
getConfiguration() {
339 final var configurationStore
= account
.getConfigurationStore();
340 return Configuration
.from(configurationStore
);
344 public void updateConfiguration(Configuration configuration
) {
345 final var configurationStore
= account
.getConfigurationStore();
346 if (configuration
.readReceipts().isPresent()) {
347 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
349 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
350 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
352 if (configuration
.typingIndicators().isPresent()) {
353 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
355 if (configuration
.linkPreviews().isPresent()) {
356 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
358 context
.getSyncHelper().sendConfigurationMessage();
363 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
364 context
.getProfileHelper()
365 .setProfile(updateProfile
.getGivenName(),
366 updateProfile
.getFamilyName(),
367 updateProfile
.getAbout(),
368 updateProfile
.getAboutEmoji(),
369 updateProfile
.isDeleteAvatar()
371 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
372 updateProfile
.getMobileCoinAddress());
373 context
.getSyncHelper().sendSyncFetchProfileMessage();
376 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
377 context
.getAccountHelper().refreshCurrentUsername();
381 public String
getUsername() {
382 return account
.getUsername();
386 public UsernameLinkUrl
getUsernameLink() {
387 return new UsernameLinkUrl(account
.getUsernameLink());
391 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
393 if (username
.contains(".")) {
394 context
.getAccountHelper().reserveExactUsername(username
);
396 context
.getAccountHelper().reserveUsernameFromNickname(username
);
398 } catch (UsernameMalformedException e
) {
399 throw new InvalidUsernameException("Username is malformed", e
);
400 } catch (UsernameTakenException e
) {
401 throw new InvalidUsernameException("Username is already registered", e
);
402 } catch (BaseUsernameException e
) {
403 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
408 public void deleteUsername() throws IOException
{
409 context
.getAccountHelper().deleteUsername();
413 public void startChangeNumber(
415 boolean voiceVerification
,
417 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
418 if (!account
.isPrimaryDevice()) {
419 throw new NotPrimaryDeviceException();
421 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
425 public void finishChangeNumber(
427 String verificationCode
,
429 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
430 if (!account
.isPrimaryDevice()) {
431 throw new NotPrimaryDeviceException();
433 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
437 public void unregister() throws IOException
{
438 context
.getAccountHelper().unregister();
442 public void deleteAccount() throws IOException
{
443 context
.getAccountHelper().deleteAccount();
447 public void submitRateLimitRecaptchaChallenge(
450 ) throws IOException
, CaptchaRejectedException
{
451 captcha
= captcha
== null ?
"" : captcha
.replace("signalcaptcha://", "");
454 handleResponseException(dependencies
.getRateLimitChallengeApi().submitCaptchaChallenge(challenge
, captcha
));
455 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
456 throw new CaptchaRejectedException();
461 public List
<Device
> getLinkedDevices() throws IOException
{
462 var devices
= handleResponseException(dependencies
.getLinkDeviceApi().getDevices());
463 account
.setMultiDevice(devices
.size() > 1);
464 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
465 return devices
.stream().map(d
-> {
466 String deviceName
= d
.getName();
467 if (deviceName
!= null) {
469 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
470 } catch (IOException e
) {
471 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
474 return new Device(d
.getId(),
478 d
.getId() == account
.getDeviceId());
483 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
484 if (!account
.isPrimaryDevice()) {
485 throw new NotPrimaryDeviceException();
487 context
.getAccountHelper().removeLinkedDevices(deviceId
);
491 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
, DeviceLimitExceededException
{
492 if (!account
.isPrimaryDevice()) {
493 throw new NotPrimaryDeviceException();
495 context
.getAccountHelper().addDevice(linkUrl
);
499 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
500 if (!account
.isPrimaryDevice()) {
501 throw new NotPrimaryDeviceException();
503 if (pin
.isPresent()) {
504 context
.getAccountHelper().setRegistrationPin(pin
.get());
506 context
.getAccountHelper().removeRegistrationPin();
510 void refreshPreKeys() throws IOException
{
511 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
515 public List
<Group
> getGroups() {
516 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
519 private Group
toGroup(final GroupInfo groupInfo
) {
520 if (groupInfo
== null) {
524 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
528 public SendGroupMessageResults
quitGroup(
530 Set
<RecipientIdentifier
.Single
> groupAdmins
531 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
532 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
533 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
537 public void deleteGroup(GroupId groupId
) throws IOException
{
538 final var group
= context
.getGroupHelper().getGroup(groupId
);
539 if (group
.isMember(account
.getSelfRecipientId())) {
540 throw new IOException(
541 "The local group information cannot be removed, as the user is still a member of the group");
543 context
.getGroupHelper().deleteGroup(groupId
);
547 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
549 Set
<RecipientIdentifier
.Single
> members
,
551 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
552 return context
.getGroupHelper()
554 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
559 public SendGroupMessageResults
updateGroup(
560 final GroupId groupId
,
561 final UpdateGroup updateGroup
562 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
563 return context
.getGroupHelper()
564 .updateGroup(groupId
,
565 updateGroup
.getName(),
566 updateGroup
.getDescription(),
567 updateGroup
.getMembers() == null
569 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
570 updateGroup
.getRemoveMembers() == null
572 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
573 updateGroup
.getAdmins() == null
575 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
576 updateGroup
.getRemoveAdmins() == null
578 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
579 updateGroup
.getBanMembers() == null
581 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
582 updateGroup
.getUnbanMembers() == null
584 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
585 updateGroup
.isResetGroupLink(),
586 updateGroup
.getGroupLinkState(),
587 updateGroup
.getAddMemberPermission(),
588 updateGroup
.getEditDetailsPermission(),
589 updateGroup
.getAvatarFile(),
590 updateGroup
.getExpirationTimer(),
591 updateGroup
.getIsAnnouncementGroup());
595 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
596 GroupInviteLinkUrl inviteLinkUrl
597 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
598 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
601 private SendMessageResults
sendMessage(
602 SignalServiceDataMessage
.Builder messageBuilder
,
603 Set
<RecipientIdentifier
> recipients
,
605 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
606 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
609 private SendMessageResults
sendMessage(
610 SignalServiceDataMessage
.Builder messageBuilder
,
611 Set
<RecipientIdentifier
> recipients
,
613 Optional
<Long
> editTargetTimestamp
614 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
615 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
616 long timestamp
= System
.currentTimeMillis();
617 messageBuilder
.withTimestamp(timestamp
);
618 for (final var recipient
: recipients
) {
619 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
620 recipient
instanceof RecipientIdentifier
.Single single
621 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
623 final var result
= notifySelf
624 ? context
.getSendHelper()
625 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
626 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
627 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
628 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
630 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
631 final var result
= context
.getSendHelper()
632 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
633 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
634 } catch (UnregisteredRecipientException e
) {
635 results
.put(recipient
,
636 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
638 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
639 final var result
= context
.getSendHelper()
640 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
641 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
644 return new SendMessageResults(timestamp
, results
);
647 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
648 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
651 private SendMessageResults
sendTypingMessage(
652 SignalServiceTypingMessage
.Action action
,
653 Set
<RecipientIdentifier
> recipients
654 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
655 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
656 final var timestamp
= System
.currentTimeMillis();
657 for (var recipient
: recipients
) {
658 if (recipient
instanceof RecipientIdentifier
.Single single
) {
659 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
661 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
662 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
663 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
664 } catch (UnregisteredRecipientException e
) {
665 results
.put(recipient
,
666 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
668 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
669 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
670 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
671 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
672 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
675 return new SendMessageResults(timestamp
, results
);
679 public SendMessageResults
sendTypingMessage(
681 Set
<RecipientIdentifier
> recipients
682 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
683 return sendTypingMessage(action
.toSignalService(), recipients
);
687 public SendMessageResults
sendReadReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
688 final var timestamp
= System
.currentTimeMillis();
689 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
693 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
697 public SendMessageResults
sendViewedReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
698 final var timestamp
= System
.currentTimeMillis();
699 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
703 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
706 private SendMessageResults
sendReceiptMessage(
707 final RecipientIdentifier
.Single sender
,
708 final long timestamp
,
709 final SignalServiceReceiptMessage receiptMessage
712 final var recipientId
= context
.getRecipientHelper().resolveRecipient(sender
);
713 final var result
= context
.getSendHelper().sendReceiptMessage(receiptMessage
, recipientId
);
715 final var serviceId
= account
.getRecipientAddressResolver()
716 .resolveRecipientAddress(recipientId
)
718 if (serviceId
.isPresent()) {
719 context
.getSyncHelper().sendSyncReceiptMessage(serviceId
.get(), receiptMessage
);
721 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
722 } catch (UnregisteredRecipientException e
) {
723 return new SendMessageResults(timestamp
,
724 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
729 public SendMessageResults
sendMessage(
731 Set
<RecipientIdentifier
> recipients
,
733 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
734 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
735 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
737 "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.");
739 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
740 applyMessage(messageBuilder
, message
);
741 return sendMessage(messageBuilder
, recipients
, notifySelf
);
745 public SendMessageResults
sendEditMessage(
747 Set
<RecipientIdentifier
> recipients
,
748 long editTargetTimestamp
749 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
750 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
751 applyMessage(messageBuilder
, message
);
752 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
755 private void applyMessage(
756 final SignalServiceDataMessage
.Builder messageBuilder
,
757 final Message message
758 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
759 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
760 if (Utf8
.size(message
.messageText()) > MAX_MESSAGE_SIZE_BYTES
) {
761 final var result
= splitByByteLength(message
.messageText(), MAX_MESSAGE_SIZE_BYTES
);
762 final var trimmed
= result
.getFirst();
763 final var remainder
= result
.getSecond();
764 if (remainder
!= null) {
765 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
766 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
767 final var streamDetails
= new StreamDetails(new ByteArrayInputStream(messageBytes
),
769 messageBytes
.length
);
770 final var textAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
773 messageBuilder
.withBody(trimmed
);
774 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
776 messageBuilder
.withBody(message
.messageText());
779 messageBuilder
.withBody(message
.messageText());
781 if (!message
.attachments().isEmpty()) {
782 final var uploadedAttachments
= context
.getAttachmentHelper().uploadAttachments(message
.attachments());
783 if (!additionalAttachments
.isEmpty()) {
784 additionalAttachments
.addAll(uploadedAttachments
);
785 messageBuilder
.withAttachments(additionalAttachments
);
787 messageBuilder
.withAttachments(uploadedAttachments
);
789 } else if (!additionalAttachments
.isEmpty()) {
790 messageBuilder
.withAttachments(additionalAttachments
);
792 if (!message
.mentions().isEmpty()) {
793 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
795 if (!message
.textStyles().isEmpty()) {
796 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
798 if (message
.quote().isPresent()) {
799 final var quote
= message
.quote().get();
800 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
801 for (final var a
: quote
.attachments()) {
802 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
804 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
805 quotedAttachments
.add(quotedAttachment
);
807 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
808 context
.getRecipientHelper()
809 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
813 resolveMentions(quote
.mentions()),
814 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
815 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
817 if (message
.sticker().isPresent()) {
818 final var sticker
= message
.sticker().get();
819 final var packId
= StickerPackId
.deserialize(sticker
.packId());
820 final var stickerId
= sticker
.stickerId();
822 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
823 if (stickerPack
== null) {
824 throw new InvalidStickerException("Sticker pack not found");
826 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
827 if (manifest
.stickers().size() <= stickerId
) {
828 throw new InvalidStickerException("Sticker id not part of this pack");
830 final var manifestSticker
= manifest
.stickers().get(stickerId
);
831 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
832 if (streamDetails
== null) {
833 throw new InvalidStickerException("Missing local sticker file");
835 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
836 final var stickerAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
839 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
840 stickerPack
.packKey(),
842 manifestSticker
.emoji(),
845 if (!message
.previews().isEmpty()) {
846 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
847 for (final var p
: message
.previews()) {
848 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
849 .uploadAttachment(p
.image().get()) : null;
850 previews
.add(new SignalServicePreview(p
.url(),
854 Optional
.ofNullable(image
)));
856 messageBuilder
.withPreviews(previews
);
858 if (message
.storyReply().isPresent()) {
859 final var storyReply
= message
.storyReply().get();
860 final var authorServiceId
= context
.getRecipientHelper()
861 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
863 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
864 storyReply
.timestamp()));
868 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
869 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
870 for (final var m
: mentionList
) {
871 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
872 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
873 .resolveSignalServiceAddress(recipientId
)
874 .getServiceId(), m
.start(), m
.length()));
880 public SendMessageResults
sendRemoteDeleteMessage(
881 long targetSentTimestamp
,
882 Set
<RecipientIdentifier
> recipients
883 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
884 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
885 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
886 for (final var recipient
: recipients
) {
887 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
888 account
.getMessageSendLogStore()
889 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
890 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
891 account
.getMessageSendLogStore()
892 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.from(pni
.pni()));
893 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
895 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
896 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
897 if (address
.serviceId().isPresent()) {
898 account
.getMessageSendLogStore()
899 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
901 } catch (UnregisteredRecipientException ignored
) {
903 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
904 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
907 return sendMessage(messageBuilder
, recipients
, false);
911 public SendMessageResults
sendMessageReaction(
914 RecipientIdentifier
.Single targetAuthor
,
915 long targetSentTimestamp
,
916 Set
<RecipientIdentifier
> recipients
,
917 final boolean isStory
918 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
919 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
920 final var authorServiceId
= context
.getRecipientHelper()
921 .resolveSignalServiceAddress(targetAuthorRecipientId
)
923 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
924 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
926 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
927 targetSentTimestamp
));
929 return sendMessage(messageBuilder
, recipients
, false);
933 public SendMessageResults
sendPaymentNotificationMessage(
936 RecipientIdentifier
.Single recipient
937 ) throws IOException
{
938 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
939 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
940 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
942 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
943 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
944 throw new AssertionError(e
);
949 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
950 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
953 return sendMessage(messageBuilder
,
954 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
956 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
957 throw new AssertionError(e
);
959 for (var recipient
: recipients
) {
960 final RecipientId recipientId
;
962 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
963 } catch (UnregisteredRecipientException e
) {
966 final var serviceId
= context
.getAccount()
967 .getRecipientAddressResolver()
968 .resolveRecipientAddress(recipientId
)
970 if (serviceId
.isPresent()) {
971 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
978 public SendMessageResults
sendMessageRequestResponse(
979 final MessageRequestResponse
.Type type
,
980 final Set
<RecipientIdentifier
> recipients
982 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
983 for (final var recipient
: recipients
) {
984 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
985 recipient
instanceof RecipientIdentifier
.Single single
986 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
988 final var result
= context
.getSyncHelper()
989 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
990 if (result
!= null) {
991 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
993 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
994 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
996 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
997 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
998 if (result
!= null) {
999 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1001 } catch (UnregisteredRecipientException e
) {
1002 results
.put(recipient
,
1003 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
1005 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
1006 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
1007 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1010 return new SendMessageResults(0, results
);
1014 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
1015 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1016 if (recipientIdOptional
.isPresent()) {
1017 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
1018 account
.removeRecipient(recipientIdOptional
.get());
1019 syncRemoteStorage();
1024 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
1025 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1026 if (recipientIdOptional
.isPresent()) {
1027 account
.removeRecipient(recipientIdOptional
.get());
1028 syncRemoteStorage();
1033 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
1034 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1035 if (recipientIdOptional
.isPresent()) {
1036 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1037 syncRemoteStorage();
1042 public void setContactName(
1043 final RecipientIdentifier
.Single recipient
,
1044 final String givenName
,
1045 final String familyName
,
1046 final String nickGivenName
,
1047 final String nickFamilyName
,
1049 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1050 if (!account
.isPrimaryDevice()) {
1051 throw new NotPrimaryDeviceException();
1053 context
.getContactHelper()
1054 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
),
1060 syncRemoteStorage();
1064 public void setContactsBlocked(
1065 Collection
<RecipientIdentifier
.Single
> recipients
,
1067 ) throws IOException
, UnregisteredRecipientException
{
1068 if (recipients
.isEmpty()) {
1071 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1072 final var selfRecipientId
= account
.getSelfRecipientId();
1073 boolean shouldRotateProfileKey
= false;
1074 for (final var recipientId
: recipientIds
) {
1075 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1078 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1079 context
.getSyncHelper()
1080 .sendMessageRequestResponse(blocked
1081 ? MessageRequestResponse
.Type
.BLOCK
1082 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1083 // if we don't have a common group with the blocked contact we need to rotate the profile key
1084 shouldRotateProfileKey
= blocked
&& (
1085 shouldRotateProfileKey
|| account
.getGroupStore()
1088 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1091 if (shouldRotateProfileKey
) {
1092 context
.getProfileHelper().rotateProfileKey();
1094 context
.getSyncHelper().sendBlockedList();
1095 syncRemoteStorage();
1099 public void setGroupsBlocked(
1100 final Collection
<GroupId
> groupIds
,
1101 final boolean blocked
1102 ) throws GroupNotFoundException
, IOException
{
1103 if (groupIds
.isEmpty()) {
1106 boolean shouldRotateProfileKey
= false;
1107 for (final var groupId
: groupIds
) {
1108 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1111 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1112 context
.getSyncHelper()
1113 .sendMessageRequestResponse(blocked
1114 ? MessageRequestResponse
.Type
.BLOCK
1115 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1116 shouldRotateProfileKey
= blocked
;
1118 if (shouldRotateProfileKey
) {
1119 context
.getProfileHelper().rotateProfileKey();
1121 context
.getSyncHelper().sendBlockedList();
1122 syncRemoteStorage();
1126 public void setExpirationTimer(
1127 RecipientIdentifier
.Single recipient
,
1128 int messageExpirationTimer
1129 ) throws IOException
, UnregisteredRecipientException
{
1130 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1131 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1132 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1134 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1135 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1136 throw new AssertionError(e
);
1138 syncRemoteStorage();
1142 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1143 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1145 var messageSender
= dependencies
.getMessageSender();
1147 var packKey
= KeyUtils
.createStickerUploadKey();
1148 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1149 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1151 var sticker
= new StickerPack(packId
, packKey
);
1152 account
.getStickerStore().addStickerPack(sticker
);
1153 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1155 return new StickerPackUrl(packId
, packKey
);
1159 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1160 final var packId
= url
.packId();
1161 final var packKey
= url
.packKey();
1163 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1164 } catch (InvalidMessageException e
) {
1165 throw new IOException(e
);
1168 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1169 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1173 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1174 final var stickerPackStore
= context
.getStickerPackStore();
1175 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1176 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1178 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1179 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1180 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1184 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1185 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1186 } catch (Exception e
) {
1187 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1191 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1196 public void requestAllSyncData() {
1197 context
.getSyncHelper().requestAllSyncData();
1198 syncRemoteStorage();
1201 void syncRemoteStorage() {
1202 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1206 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1207 synchronized (messageHandlers
) {
1208 if (isWeakListener
) {
1209 weakHandlers
.add(handler
);
1211 messageHandlers
.add(handler
);
1212 startReceiveThreadIfRequired();
1217 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1219 private void startReceiveThreadIfRequired() {
1220 if (receiveThread
!= null || isReceivingSynchronous
) {
1223 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1224 logger
.debug("Starting receiving messages");
1225 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1226 logger
.debug("Finished receiving messages");
1227 synchronized (messageHandlers
) {
1228 receiveThread
= null;
1230 // Check if in the meantime another handler has been registered
1231 if (!messageHandlers
.isEmpty()) {
1232 logger
.debug("Another handler has been registered, starting receive thread again");
1233 startReceiveThreadIfRequired();
1239 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1240 synchronized (messageHandlers
) {
1241 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1243 h
.handleMessage(envelope
, e
);
1244 } catch (Throwable ex
) {
1245 logger
.warn("Message handler failed, ignoring", ex
);
1252 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1253 final Thread thread
;
1254 synchronized (messageHandlers
) {
1255 weakHandlers
.remove(handler
);
1256 messageHandlers
.remove(handler
);
1257 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1260 thread
= receiveThread
;
1261 receiveThread
= null;
1264 stopReceiveThread(thread
);
1267 private void stopReceiveThread(final Thread thread
) {
1268 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1269 logger
.debug("Receive stop requested, interrupting read from server.");
1274 } catch (InterruptedException ignored
) {
1279 public boolean isReceiving() {
1280 if (isReceivingSynchronous
) {
1283 synchronized (messageHandlers
) {
1284 return !messageHandlers
.isEmpty();
1289 public void receiveMessages(
1290 Optional
<Duration
> timeout
,
1291 Optional
<Integer
> maxMessages
,
1292 ReceiveMessageHandler handler
1293 ) throws IOException
, AlreadyReceivingException
{
1294 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1298 public void stopReceiveMessages() {
1299 Thread thread
= null;
1300 synchronized (messageHandlers
) {
1301 if (isReceivingSynchronous
) {
1302 thread
= receiveThread
;
1303 receiveThread
= null;
1306 if (thread
!= null) {
1307 stopReceiveThread(thread
);
1311 private void receiveMessages(
1313 boolean returnOnTimeout
,
1314 Integer maxMessages
,
1315 ReceiveMessageHandler handler
1316 ) throws IOException
, AlreadyReceivingException
{
1317 synchronized (messageHandlers
) {
1318 if (isReceiving()) {
1319 throw new AlreadyReceivingException("Already receiving message.");
1321 isReceivingSynchronous
= true;
1322 receiveThread
= Thread
.currentThread();
1325 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1326 passReceivedMessageToHandlers(envelope
, e
);
1327 handler
.handleMessage(envelope
, e
);
1330 synchronized (messageHandlers
) {
1331 receiveThread
= null;
1332 isReceivingSynchronous
= false;
1333 if (!messageHandlers
.isEmpty()) {
1334 startReceiveThreadIfRequired();
1341 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1342 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1346 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1347 final RecipientId recipientId
;
1349 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1350 } catch (UnregisteredRecipientException e
) {
1353 return context
.getContactHelper().isContactBlocked(recipientId
);
1357 public void sendContacts() throws IOException
{
1358 context
.getSyncHelper().sendContacts();
1362 public List
<Recipient
> getRecipients(
1363 boolean onlyContacts
,
1364 Optional
<Boolean
> blocked
,
1365 Collection
<RecipientIdentifier
.Single
> recipients
,
1366 Optional
<String
> name
1368 final var recipientIds
= recipients
.stream().map(a
-> {
1370 return context
.getRecipientHelper().resolveRecipient(a
);
1371 } catch (UnregisteredRecipientException e
) {
1374 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1375 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1378 // refresh profiles of explicitly given recipients
1379 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1380 return account
.getRecipientStore()
1381 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1383 .map(s
-> new Recipient(s
.getRecipientId(),
1384 s
.getAddress().toApiRecipientAddress(),
1387 s
.getExpiringProfileKeyCredential(),
1389 s
.getDiscoverable()))
1394 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1395 final RecipientId recipientId
;
1397 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1398 } catch (UnregisteredRecipientException e
) {
1402 final var contact
= account
.getContactStore().getContact(recipientId
);
1403 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1404 return contact
.getName();
1407 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1408 if (profile
!= null) {
1409 return profile
.getDisplayName();
1416 public Group
getGroup(GroupId groupId
) {
1417 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1421 public List
<Identity
> getIdentities() {
1422 return account
.getIdentityKeyStore()
1425 .map(this::toIdentity
)
1426 .filter(Objects
::nonNull
)
1430 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1431 if (identityInfo
== null) {
1435 final var address
= account
.getRecipientAddressResolver()
1436 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1437 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1438 identityInfo
.getServiceId())) {
1441 final var scannableFingerprint
= context
.getIdentityHelper()
1442 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1443 return new Identity(address
.toApiRecipientAddress(),
1444 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1445 context
.getIdentityHelper()
1446 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1447 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1448 identityInfo
.getTrustLevel(),
1449 identityInfo
.getDateAddedTimestamp());
1453 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1454 ServiceId serviceId
;
1456 final var address
= account
.getRecipientAddressResolver()
1457 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1458 if (address
.serviceId().isEmpty()) {
1461 serviceId
= address
.serviceId().get();
1462 } catch (UnregisteredRecipientException e
) {
1465 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1466 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1470 public boolean trustIdentityVerified(
1471 RecipientIdentifier
.Single recipient
,
1472 IdentityVerificationCode verificationCode
1473 ) throws UnregisteredRecipientException
{
1474 return switch (verificationCode
) {
1475 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1476 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1477 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1478 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1479 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1480 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1481 case null -> throw new AssertionError("Invalid verification code type");
1486 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1487 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1490 private boolean trustIdentity(
1491 RecipientIdentifier
.Single recipient
,
1492 Function
<RecipientId
, Boolean
> trustMethod
1493 ) throws UnregisteredRecipientException
{
1494 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1495 final var updated
= trustMethod
.apply(recipientId
);
1496 if (updated
&& this.isReceiving()) {
1497 account
.setNeedsToRetryFailedMessages(true);
1503 public void addAddressChangedListener(final Runnable listener
) {
1504 synchronized (addressChangedListeners
) {
1505 addressChangedListeners
.add(listener
);
1510 public void addClosedListener(final Runnable listener
) {
1511 synchronized (closedListeners
) {
1512 closedListeners
.add(listener
);
1517 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1518 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1522 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1523 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1524 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1525 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1526 if (streamDetails
== null) {
1527 throw new FileNotFoundException();
1529 return streamDetails
.getStream();
1533 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1534 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1535 context
.getProfileHelper().getRecipientProfile(recipientId
);
1536 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1537 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1538 if (streamDetails
== null) {
1539 throw new FileNotFoundException();
1541 return streamDetails
.getStream();
1545 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1546 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1547 context
.getGroupHelper().getGroup(groupId
);
1548 if (streamDetails
== null) {
1549 throw new FileNotFoundException();
1551 return streamDetails
.getStream();
1555 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1556 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1557 if (streamDetails
== null) {
1558 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1561 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1562 } catch (InvalidMessageException e
) {
1563 logger
.warn("Failed to download sticker pack");
1567 if (streamDetails
== null) {
1568 throw new FileNotFoundException();
1570 return streamDetails
.getStream();
1574 public void close() {
1576 synchronized (messageHandlers
) {
1577 weakHandlers
.clear();
1578 messageHandlers
.clear();
1579 thread
= receiveThread
;
1580 receiveThread
= null;
1582 if (thread
!= null) {
1583 stopReceiveThread(thread
);
1588 dependencies
.getAuthenticatedSignalWebSocket().disconnect();
1589 dependencies
.getUnauthenticatedSignalWebSocket().disconnect();
1590 dependencies
.getPushServiceSocket().close();
1591 disposable
.dispose();
1593 if (account
!= null) {
1597 synchronized (closedListeners
) {
1598 closedListeners
.forEach(Runnable
::run
);
1599 closedListeners
.clear();