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
.InvalidStickerException
;
39 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
40 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
41 import org
.asamk
.signal
.manager
.api
.Message
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
43 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
44 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
45 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
46 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
47 import org
.asamk
.signal
.manager
.api
.Pair
;
48 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
49 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
50 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
51 import org
.asamk
.signal
.manager
.api
.Profile
;
52 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
53 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
54 import org
.asamk
.signal
.manager
.api
.Recipient
;
55 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
56 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
58 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
61 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
62 import org
.asamk
.signal
.manager
.api
.TextStyle
;
63 import org
.asamk
.signal
.manager
.api
.TypingAction
;
64 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
65 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
66 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
67 import org
.asamk
.signal
.manager
.api
.UserStatus
;
68 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
69 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
70 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
71 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
72 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
73 import org
.asamk
.signal
.manager
.helper
.Context
;
74 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
75 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
76 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
77 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
78 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
79 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
80 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
81 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
82 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
83 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
84 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
85 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
86 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
87 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
88 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
89 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
90 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
91 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
92 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
93 import org
.slf4j
.Logger
;
94 import org
.slf4j
.LoggerFactory
;
95 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
101 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
103 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
104 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
105 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
106 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
107 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
108 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
109 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
110 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
111 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
112 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
113 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
115 import java
.io
.ByteArrayInputStream
;
117 import java
.io
.FileNotFoundException
;
118 import java
.io
.IOException
;
119 import java
.io
.InputStream
;
120 import java
.nio
.charset
.StandardCharsets
;
121 import java
.time
.Duration
;
122 import java
.util
.ArrayList
;
123 import java
.util
.Collection
;
124 import java
.util
.HashMap
;
125 import java
.util
.HashSet
;
126 import java
.util
.List
;
127 import java
.util
.Map
;
128 import java
.util
.Objects
;
129 import java
.util
.Optional
;
130 import java
.util
.Set
;
131 import java
.util
.concurrent
.ExecutorService
;
132 import java
.util
.concurrent
.Executors
;
133 import java
.util
.concurrent
.TimeUnit
;
134 import java
.util
.concurrent
.atomic
.AtomicInteger
;
135 import java
.util
.concurrent
.locks
.ReentrantLock
;
136 import java
.util
.function
.Function
;
137 import java
.util
.stream
.Collectors
;
138 import java
.util
.stream
.Stream
;
140 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
141 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
143 public class ManagerImpl
implements Manager
{
145 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
147 private SignalAccount account
;
148 private final SignalDependencies dependencies
;
149 private final Context context
;
151 private final ExecutorService executor
= Executors
.newCachedThreadPool();
153 private Thread receiveThread
;
154 private boolean isReceivingSynchronous
;
155 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
156 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
157 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
158 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
159 private final CompositeDisposable disposable
= new CompositeDisposable();
162 SignalAccount account
,
163 PathConfig pathConfig
,
164 AccountFileUpdater accountFileUpdater
,
165 ServiceEnvironmentConfig serviceEnvironmentConfig
,
168 this.account
= account
;
170 final var sessionLock
= new SignalSessionLock() {
171 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
174 public Lock
acquire() {
176 return LEGACY_LOCK
::unlock
;
179 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
181 account
.getCredentialsProvider(),
182 account
.getSignalServiceDataStore(),
185 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
186 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
187 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
189 this.context
= new Context(account
, new AccountFileUpdater() {
191 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
192 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
193 synchronized (addressChangedListeners
) {
194 addressChangedListeners
.forEach(Runnable
::run
);
199 public void removeAccount() {
200 accountFileUpdater
.removeAccount();
202 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
203 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
204 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
205 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
206 synchronized (this) {
210 disposable
.add(account
.getIdentityKeyStore()
211 .getIdentityChanges()
212 .observeOn(Schedulers
.from(executor
))
213 .subscribe(serviceId
-> {
214 logger
.trace("Archiving old sessions for {}", serviceId
);
215 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
216 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
217 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
218 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
219 final var profile
= account
.getProfileStore().getProfile(recipientId
);
220 if (profile
!= null) {
221 account
.getProfileStore()
222 .storeProfile(recipientId
,
223 Profile
.newBuilder(profile
)
224 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
225 .withLastUpdateTimestamp(0)
232 public String
getSelfNumber() {
233 return account
.getNumber();
236 public void checkAccountState() throws IOException
{
237 context
.getAccountHelper().checkAccountState();
238 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
239 if (lastRecipientsRefresh
== null
240 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
241 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
242 context
.getAccountHelper().checkWhoAmiI();
247 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
248 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
250 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
251 if (!canonicalizedNumber
.equals(n
)) {
252 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
254 return canonicalizedNumber
;
255 } catch (InvalidNumberException e
) {
260 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
261 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
263 .filter(s
-> !s
.isEmpty())
264 .collect(Collectors
.toSet());
266 final Map
<String
, RegisteredUser
> registeredUsers
;
268 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
269 } catch (CdsiResourceExhaustedException e
) {
270 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
271 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
274 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
275 final var number
= canonicalizedNumbers
.get(n
);
276 final var user
= registeredUsers
.get(number
);
277 final var serviceId
= user
== null ?
null : user
.getServiceId();
278 final var profile
= serviceId
== null
280 : context
.getProfileHelper()
281 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
282 return new UserStatus(number
.isEmpty() ?
null : number
,
283 serviceId
== null ?
null : serviceId
.getRawUuid(),
285 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
290 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
291 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
292 for (final var username
: usernames
) {
294 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
295 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
296 registeredUsers
.put(username
, address
);
297 } catch (UnregisteredRecipientException e
) {
302 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
303 final var user
= registeredUsers
.get(username
);
304 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
305 final var profile
= serviceId
== null
307 : context
.getProfileHelper()
308 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
309 return new UsernameStatus(username
,
310 serviceId
== null ?
null : serviceId
.getRawUuid(),
312 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
317 public void updateAccountAttributes(
319 Boolean unrestrictedUnidentifiedSender
,
320 final Boolean discoverableByNumber
,
321 final Boolean numberSharing
322 ) throws IOException
{
323 if (deviceName
!= null) {
324 context
.getAccountHelper().setDeviceName(deviceName
);
326 if (unrestrictedUnidentifiedSender
!= null) {
327 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
329 if (discoverableByNumber
!= null) {
330 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
332 if (numberSharing
!= null) {
333 account
.getConfigurationStore()
334 .setPhoneNumberSharingMode(numberSharing
335 ? PhoneNumberSharingMode
.EVERYBODY
336 : PhoneNumberSharingMode
.NOBODY
);
338 context
.getAccountHelper().updateAccountAttributes();
339 context
.getAccountHelper().checkWhoAmiI();
343 public Configuration
getConfiguration() {
344 final var configurationStore
= account
.getConfigurationStore();
345 return Configuration
.from(configurationStore
);
349 public void updateConfiguration(Configuration configuration
) {
350 final var configurationStore
= account
.getConfigurationStore();
351 if (configuration
.readReceipts().isPresent()) {
352 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
354 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
355 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
357 if (configuration
.typingIndicators().isPresent()) {
358 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
360 if (configuration
.linkPreviews().isPresent()) {
361 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
363 context
.getSyncHelper().sendConfigurationMessage();
368 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
369 context
.getProfileHelper()
370 .setProfile(updateProfile
.getGivenName(),
371 updateProfile
.getFamilyName(),
372 updateProfile
.getAbout(),
373 updateProfile
.getAboutEmoji(),
374 updateProfile
.isDeleteAvatar()
376 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
377 updateProfile
.getMobileCoinAddress());
378 context
.getSyncHelper().sendSyncFetchProfileMessage();
381 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
382 context
.getAccountHelper().refreshCurrentUsername();
386 public String
getUsername() {
387 return account
.getUsername();
391 public UsernameLinkUrl
getUsernameLink() {
392 return new UsernameLinkUrl(account
.getUsernameLink());
396 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
398 if (username
.contains(".")) {
399 context
.getAccountHelper().reserveExactUsername(username
);
401 context
.getAccountHelper().reserveUsernameFromNickname(username
);
403 } catch (UsernameMalformedException e
) {
404 throw new InvalidUsernameException("Username is malformed", e
);
405 } catch (UsernameTakenException e
) {
406 throw new InvalidUsernameException("Username is already registered", e
);
407 } catch (BaseUsernameException e
) {
408 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
413 public void deleteUsername() throws IOException
{
414 context
.getAccountHelper().deleteUsername();
418 public void startChangeNumber(
419 String newNumber
, boolean voiceVerification
, String captcha
420 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
421 if (!account
.isPrimaryDevice()) {
422 throw new NotPrimaryDeviceException();
424 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
428 public void finishChangeNumber(
429 String newNumber
, String verificationCode
, String pin
430 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
431 if (!account
.isPrimaryDevice()) {
432 throw new NotPrimaryDeviceException();
434 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
438 public void unregister() throws IOException
{
439 context
.getAccountHelper().unregister();
443 public void deleteAccount() throws IOException
{
444 context
.getAccountHelper().deleteAccount();
448 public void submitRateLimitRecaptchaChallenge(
449 String challenge
, String captcha
450 ) throws IOException
, CaptchaRejectedException
{
451 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
454 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(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
= dependencies
.getAccountManager().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(
529 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
530 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
531 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
532 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
536 public void deleteGroup(GroupId groupId
) throws IOException
{
537 final var group
= context
.getGroupHelper().getGroup(groupId
);
538 if (group
.isMember(account
.getSelfRecipientId())) {
539 throw new IOException(
540 "The local group information cannot be removed, as the user is still a member of the group");
542 context
.getGroupHelper().deleteGroup(groupId
);
546 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
547 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
548 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
549 return context
.getGroupHelper()
551 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
556 public SendGroupMessageResults
updateGroup(
557 final GroupId groupId
, final UpdateGroup updateGroup
558 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
559 return context
.getGroupHelper()
560 .updateGroup(groupId
,
561 updateGroup
.getName(),
562 updateGroup
.getDescription(),
563 updateGroup
.getMembers() == null
565 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
566 updateGroup
.getRemoveMembers() == null
568 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
569 updateGroup
.getAdmins() == null
571 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
572 updateGroup
.getRemoveAdmins() == null
574 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
575 updateGroup
.getBanMembers() == null
577 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
578 updateGroup
.getUnbanMembers() == null
580 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
581 updateGroup
.isResetGroupLink(),
582 updateGroup
.getGroupLinkState(),
583 updateGroup
.getAddMemberPermission(),
584 updateGroup
.getEditDetailsPermission(),
585 updateGroup
.getAvatarFile(),
586 updateGroup
.getExpirationTimer(),
587 updateGroup
.getIsAnnouncementGroup());
591 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
592 GroupInviteLinkUrl inviteLinkUrl
593 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
594 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
597 private SendMessageResults
sendMessage(
598 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
599 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
600 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
603 private SendMessageResults
sendMessage(
604 SignalServiceDataMessage
.Builder messageBuilder
,
605 Set
<RecipientIdentifier
> recipients
,
607 Optional
<Long
> editTargetTimestamp
608 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
609 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
610 long timestamp
= System
.currentTimeMillis();
611 messageBuilder
.withTimestamp(timestamp
);
612 for (final var recipient
: recipients
) {
613 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
614 recipient
instanceof RecipientIdentifier
.Single single
615 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
617 final var result
= notifySelf
618 ? context
.getSendHelper()
619 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
620 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
621 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
622 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
624 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
625 final var result
= context
.getSendHelper()
626 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
627 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
628 } catch (UnregisteredRecipientException e
) {
629 results
.put(recipient
,
630 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
632 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
633 final var result
= context
.getSendHelper()
634 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
635 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
638 return new SendMessageResults(timestamp
, results
);
641 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
642 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
645 private SendMessageResults
sendTypingMessage(
646 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
647 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
648 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
649 final var timestamp
= System
.currentTimeMillis();
650 for (var recipient
: recipients
) {
651 if (recipient
instanceof RecipientIdentifier
.Single single
) {
652 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
654 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
655 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
656 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
657 } catch (UnregisteredRecipientException e
) {
658 results
.put(recipient
,
659 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
661 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
662 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
663 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
664 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
665 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
668 return new SendMessageResults(timestamp
, results
);
672 public SendMessageResults
sendTypingMessage(
673 TypingAction action
, Set
<RecipientIdentifier
> recipients
674 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
675 return sendTypingMessage(action
.toSignalService(), recipients
);
679 public SendMessageResults
sendReadReceipt(
680 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
682 final var timestamp
= System
.currentTimeMillis();
683 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
687 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
691 public SendMessageResults
sendViewedReceipt(
692 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
694 final var timestamp
= System
.currentTimeMillis();
695 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
699 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
702 private SendMessageResults
sendReceiptMessage(
703 final RecipientIdentifier
.Single sender
,
704 final long timestamp
,
705 final SignalServiceReceiptMessage receiptMessage
708 final var recipientId
= context
.getRecipientHelper().resolveRecipient(sender
);
709 final var result
= context
.getSendHelper().sendReceiptMessage(receiptMessage
, recipientId
);
711 final var serviceId
= account
.getRecipientAddressResolver()
712 .resolveRecipientAddress(recipientId
)
714 if (serviceId
.isPresent()) {
715 context
.getSyncHelper().sendSyncReceiptMessage(serviceId
.get(), receiptMessage
);
717 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
718 } catch (UnregisteredRecipientException e
) {
719 return new SendMessageResults(timestamp
,
720 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
725 public SendMessageResults
sendMessage(
726 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
727 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
728 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
729 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
731 "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.");
733 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
734 applyMessage(messageBuilder
, message
);
735 return sendMessage(messageBuilder
, recipients
, notifySelf
);
739 public SendMessageResults
sendEditMessage(
740 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
741 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
742 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
743 applyMessage(messageBuilder
, message
);
744 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
747 private void applyMessage(
748 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
749 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
750 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
751 if (message
.messageText().length() > 2000) {
752 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
753 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
754 final var streamDetails
= new StreamDetails(new ByteArrayInputStream(messageBytes
),
756 messageBytes
.length
);
757 final var textAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
760 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
761 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
763 messageBuilder
.withBody(message
.messageText());
765 if (!message
.attachments().isEmpty()) {
766 if (!additionalAttachments
.isEmpty()) {
767 additionalAttachments
.addAll(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
768 messageBuilder
.withAttachments(additionalAttachments
);
770 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
773 if (!message
.mentions().isEmpty()) {
774 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
776 if (!message
.textStyles().isEmpty()) {
777 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
779 if (message
.quote().isPresent()) {
780 final var quote
= message
.quote().get();
781 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
782 for (final var a
: quote
.attachments()) {
783 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
785 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
786 quotedAttachments
.add(quotedAttachment
);
788 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
789 context
.getRecipientHelper()
790 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
794 resolveMentions(quote
.mentions()),
795 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
796 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
798 if (message
.sticker().isPresent()) {
799 final var sticker
= message
.sticker().get();
800 final var packId
= StickerPackId
.deserialize(sticker
.packId());
801 final var stickerId
= sticker
.stickerId();
803 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
804 if (stickerPack
== null) {
805 throw new InvalidStickerException("Sticker pack not found");
807 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
808 if (manifest
.stickers().size() <= stickerId
) {
809 throw new InvalidStickerException("Sticker id not part of this pack");
811 final var manifestSticker
= manifest
.stickers().get(stickerId
);
812 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
813 if (streamDetails
== null) {
814 throw new InvalidStickerException("Missing local sticker file");
816 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
817 final var stickerAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
820 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
821 stickerPack
.packKey(),
823 manifestSticker
.emoji(),
826 if (!message
.previews().isEmpty()) {
827 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
828 for (final var p
: message
.previews()) {
829 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
830 .uploadAttachment(p
.image().get()) : null;
831 previews
.add(new SignalServicePreview(p
.url(),
835 Optional
.ofNullable(image
)));
837 messageBuilder
.withPreviews(previews
);
839 if (message
.storyReply().isPresent()) {
840 final var storyReply
= message
.storyReply().get();
841 final var authorServiceId
= context
.getRecipientHelper()
842 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
844 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
845 storyReply
.timestamp()));
849 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
850 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
851 for (final var m
: mentionList
) {
852 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
853 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
854 .resolveSignalServiceAddress(recipientId
)
855 .getServiceId(), m
.start(), m
.length()));
861 public SendMessageResults
sendRemoteDeleteMessage(
862 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
863 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
864 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
865 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
866 for (final var recipient
: recipients
) {
867 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
868 account
.getMessageSendLogStore()
869 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
870 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
871 account
.getMessageSendLogStore()
872 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.parseOrThrow(pni
.pni()));
873 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
875 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
876 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
877 if (address
.serviceId().isPresent()) {
878 account
.getMessageSendLogStore()
879 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
881 } catch (UnregisteredRecipientException ignored
) {
883 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
884 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
887 return sendMessage(messageBuilder
, recipients
, false);
891 public SendMessageResults
sendMessageReaction(
894 RecipientIdentifier
.Single targetAuthor
,
895 long targetSentTimestamp
,
896 Set
<RecipientIdentifier
> recipients
,
897 final boolean isStory
898 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
899 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
900 final var authorServiceId
= context
.getRecipientHelper()
901 .resolveSignalServiceAddress(targetAuthorRecipientId
)
903 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
904 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
906 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
907 targetSentTimestamp
));
909 return sendMessage(messageBuilder
, recipients
, false);
913 public SendMessageResults
sendPaymentNotificationMessage(
914 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
915 ) throws IOException
{
916 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
917 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
918 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
920 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
921 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
922 throw new AssertionError(e
);
927 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
928 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
931 return sendMessage(messageBuilder
,
932 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
934 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
935 throw new AssertionError(e
);
937 for (var recipient
: recipients
) {
938 final RecipientId recipientId
;
940 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
941 } catch (UnregisteredRecipientException e
) {
944 final var serviceId
= context
.getAccount()
945 .getRecipientAddressResolver()
946 .resolveRecipientAddress(recipientId
)
948 if (serviceId
.isPresent()) {
949 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
956 public SendMessageResults
sendMessageRequestResponse(
957 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
959 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
960 for (final var recipient
: recipients
) {
961 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
962 recipient
instanceof RecipientIdentifier
.Single single
963 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
965 final var result
= context
.getSyncHelper()
966 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
967 if (result
!= null) {
968 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
970 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
971 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
973 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
974 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
975 if (result
!= null) {
976 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
978 } catch (UnregisteredRecipientException e
) {
979 results
.put(recipient
,
980 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
982 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
983 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
984 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
987 return new SendMessageResults(0, results
);
991 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
992 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
993 if (recipientIdOptional
.isPresent()) {
994 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
995 account
.removeRecipient(recipientIdOptional
.get());
1001 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
1002 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1003 if (recipientIdOptional
.isPresent()) {
1004 account
.removeRecipient(recipientIdOptional
.get());
1005 syncRemoteStorage();
1010 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
1011 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1012 if (recipientIdOptional
.isPresent()) {
1013 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1014 syncRemoteStorage();
1019 public void setContactName(
1020 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
1021 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1022 if (!account
.isPrimaryDevice()) {
1023 throw new NotPrimaryDeviceException();
1025 context
.getContactHelper()
1026 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
1027 syncRemoteStorage();
1031 public void setContactsBlocked(
1032 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
1033 ) throws IOException
, UnregisteredRecipientException
{
1034 if (recipients
.isEmpty()) {
1037 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1038 final var selfRecipientId
= account
.getSelfRecipientId();
1039 boolean shouldRotateProfileKey
= false;
1040 for (final var recipientId
: recipientIds
) {
1041 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1044 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1045 context
.getSyncHelper()
1046 .sendMessageRequestResponse(blocked
1047 ? MessageRequestResponse
.Type
.BLOCK
1048 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1049 // if we don't have a common group with the blocked contact we need to rotate the profile key
1050 shouldRotateProfileKey
= blocked
&& (
1051 shouldRotateProfileKey
|| account
.getGroupStore()
1054 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1057 if (shouldRotateProfileKey
) {
1058 context
.getProfileHelper().rotateProfileKey();
1060 context
.getSyncHelper().sendBlockedList();
1061 syncRemoteStorage();
1065 public void setGroupsBlocked(
1066 final Collection
<GroupId
> groupIds
, final boolean blocked
1067 ) throws GroupNotFoundException
, IOException
{
1068 if (groupIds
.isEmpty()) {
1071 boolean shouldRotateProfileKey
= false;
1072 for (final var groupId
: groupIds
) {
1073 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1076 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1077 context
.getSyncHelper()
1078 .sendMessageRequestResponse(blocked
1079 ? MessageRequestResponse
.Type
.BLOCK
1080 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1081 shouldRotateProfileKey
= blocked
;
1083 if (shouldRotateProfileKey
) {
1084 context
.getProfileHelper().rotateProfileKey();
1086 context
.getSyncHelper().sendBlockedList();
1087 syncRemoteStorage();
1091 public void setExpirationTimer(
1092 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1093 ) throws IOException
, UnregisteredRecipientException
{
1094 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1095 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1096 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1098 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1099 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1100 throw new AssertionError(e
);
1102 syncRemoteStorage();
1106 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1107 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1109 var messageSender
= dependencies
.getMessageSender();
1111 var packKey
= KeyUtils
.createStickerUploadKey();
1112 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1113 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1115 var sticker
= new StickerPack(packId
, packKey
);
1116 account
.getStickerStore().addStickerPack(sticker
);
1117 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1119 return new StickerPackUrl(packId
, packKey
);
1123 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1124 final var packId
= url
.packId();
1125 final var packKey
= url
.packKey();
1127 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1128 } catch (InvalidMessageException e
) {
1129 throw new IOException(e
);
1132 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1133 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1137 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1138 final var stickerPackStore
= context
.getStickerPackStore();
1139 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1140 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1142 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1143 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1144 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1148 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1149 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1150 } catch (Exception e
) {
1151 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1155 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1160 public void requestAllSyncData() {
1161 context
.getSyncHelper().requestAllSyncData();
1162 syncRemoteStorage();
1165 void syncRemoteStorage() {
1166 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1170 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1171 synchronized (messageHandlers
) {
1172 if (isWeakListener
) {
1173 weakHandlers
.add(handler
);
1175 messageHandlers
.add(handler
);
1176 startReceiveThreadIfRequired();
1181 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1183 private void startReceiveThreadIfRequired() {
1184 if (receiveThread
!= null || isReceivingSynchronous
) {
1187 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1188 logger
.debug("Starting receiving messages");
1189 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1190 logger
.debug("Finished receiving messages");
1191 synchronized (messageHandlers
) {
1192 receiveThread
= null;
1194 // Check if in the meantime another handler has been registered
1195 if (!messageHandlers
.isEmpty()) {
1196 logger
.debug("Another handler has been registered, starting receive thread again");
1197 startReceiveThreadIfRequired();
1203 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1204 synchronized (messageHandlers
) {
1205 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1207 h
.handleMessage(envelope
, e
);
1208 } catch (Throwable ex
) {
1209 logger
.warn("Message handler failed, ignoring", ex
);
1216 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1217 final Thread thread
;
1218 synchronized (messageHandlers
) {
1219 weakHandlers
.remove(handler
);
1220 messageHandlers
.remove(handler
);
1221 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1224 thread
= receiveThread
;
1225 receiveThread
= null;
1228 stopReceiveThread(thread
);
1231 private void stopReceiveThread(final Thread thread
) {
1232 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1233 logger
.debug("Receive stop requested, interrupting read from server.");
1238 } catch (InterruptedException ignored
) {
1243 public boolean isReceiving() {
1244 if (isReceivingSynchronous
) {
1247 synchronized (messageHandlers
) {
1248 return !messageHandlers
.isEmpty();
1253 public void receiveMessages(
1254 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1255 ) throws IOException
, AlreadyReceivingException
{
1256 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1260 public void stopReceiveMessages() {
1261 Thread thread
= null;
1262 synchronized (messageHandlers
) {
1263 if (isReceivingSynchronous
) {
1264 thread
= receiveThread
;
1265 receiveThread
= null;
1268 if (thread
!= null) {
1269 stopReceiveThread(thread
);
1273 private void receiveMessages(
1274 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1275 ) throws IOException
, AlreadyReceivingException
{
1276 synchronized (messageHandlers
) {
1277 if (isReceiving()) {
1278 throw new AlreadyReceivingException("Already receiving message.");
1280 isReceivingSynchronous
= true;
1281 receiveThread
= Thread
.currentThread();
1284 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1285 passReceivedMessageToHandlers(envelope
, e
);
1286 handler
.handleMessage(envelope
, e
);
1289 synchronized (messageHandlers
) {
1290 receiveThread
= null;
1291 isReceivingSynchronous
= false;
1292 if (!messageHandlers
.isEmpty()) {
1293 startReceiveThreadIfRequired();
1300 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1301 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1305 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1306 final RecipientId recipientId
;
1308 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1309 } catch (UnregisteredRecipientException e
) {
1312 return context
.getContactHelper().isContactBlocked(recipientId
);
1316 public void sendContacts() throws IOException
{
1317 context
.getSyncHelper().sendContacts();
1321 public List
<Recipient
> getRecipients(
1322 boolean onlyContacts
,
1323 Optional
<Boolean
> blocked
,
1324 Collection
<RecipientIdentifier
.Single
> recipients
,
1325 Optional
<String
> name
1327 final var recipientIds
= recipients
.stream().map(a
-> {
1329 return context
.getRecipientHelper().resolveRecipient(a
);
1330 } catch (UnregisteredRecipientException e
) {
1333 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1334 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1337 // refresh profiles of explicitly given recipients
1338 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1339 return account
.getRecipientStore()
1340 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1342 .map(s
-> new Recipient(s
.getRecipientId(),
1343 s
.getAddress().toApiRecipientAddress(),
1346 s
.getExpiringProfileKeyCredential(),
1348 s
.getDiscoverable()))
1353 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1354 final RecipientId recipientId
;
1356 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1357 } catch (UnregisteredRecipientException e
) {
1361 final var contact
= account
.getContactStore().getContact(recipientId
);
1362 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1363 return contact
.getName();
1366 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1367 if (profile
!= null) {
1368 return profile
.getDisplayName();
1375 public Group
getGroup(GroupId groupId
) {
1376 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1380 public List
<Identity
> getIdentities() {
1381 return account
.getIdentityKeyStore()
1384 .map(this::toIdentity
)
1385 .filter(Objects
::nonNull
)
1389 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1390 if (identityInfo
== null) {
1394 final var address
= account
.getRecipientAddressResolver()
1395 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1396 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1397 identityInfo
.getServiceId())) {
1400 final var scannableFingerprint
= context
.getIdentityHelper()
1401 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1402 return new Identity(address
.toApiRecipientAddress(),
1403 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1404 context
.getIdentityHelper()
1405 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1406 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1407 identityInfo
.getTrustLevel(),
1408 identityInfo
.getDateAddedTimestamp());
1412 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1413 ServiceId serviceId
;
1415 final var address
= account
.getRecipientAddressResolver()
1416 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1417 if (address
.serviceId().isEmpty()) {
1420 serviceId
= address
.serviceId().get();
1421 } catch (UnregisteredRecipientException e
) {
1424 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1425 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1429 public boolean trustIdentityVerified(
1430 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1431 ) throws UnregisteredRecipientException
{
1432 return switch (verificationCode
) {
1433 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1434 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1435 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1436 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1437 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1438 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1439 case null -> throw new AssertionError("Invalid verification code type");
1444 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1445 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1448 private boolean trustIdentity(
1449 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1450 ) throws UnregisteredRecipientException
{
1451 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1452 final var updated
= trustMethod
.apply(recipientId
);
1453 if (updated
&& this.isReceiving()) {
1454 account
.setNeedsToRetryFailedMessages(true);
1460 public void addAddressChangedListener(final Runnable listener
) {
1461 synchronized (addressChangedListeners
) {
1462 addressChangedListeners
.add(listener
);
1467 public void addClosedListener(final Runnable listener
) {
1468 synchronized (closedListeners
) {
1469 closedListeners
.add(listener
);
1474 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1475 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1479 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1480 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1481 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1482 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1483 if (streamDetails
== null) {
1484 throw new FileNotFoundException();
1486 return streamDetails
.getStream();
1490 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1491 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1492 context
.getProfileHelper().getRecipientProfile(recipientId
);
1493 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1494 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1495 if (streamDetails
== null) {
1496 throw new FileNotFoundException();
1498 return streamDetails
.getStream();
1502 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1503 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1504 context
.getGroupHelper().getGroup(groupId
);
1505 if (streamDetails
== null) {
1506 throw new FileNotFoundException();
1508 return streamDetails
.getStream();
1512 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1513 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1514 if (streamDetails
== null) {
1515 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1518 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1519 } catch (InvalidMessageException e
) {
1520 logger
.warn("Failed to download sticker pack");
1524 if (streamDetails
== null) {
1525 throw new FileNotFoundException();
1527 return streamDetails
.getStream();
1531 public void close() {
1533 synchronized (messageHandlers
) {
1534 weakHandlers
.clear();
1535 messageHandlers
.clear();
1536 thread
= receiveThread
;
1537 receiveThread
= null;
1539 if (thread
!= null) {
1540 stopReceiveThread(thread
);
1545 dependencies
.getSignalWebSocket().disconnect();
1546 dependencies
.getPushServiceSocket().close();
1547 disposable
.dispose();
1549 if (account
!= null) {
1553 synchronized (closedListeners
) {
1554 closedListeners
.forEach(Runnable
::run
);
1555 closedListeners
.clear();