2 Copyright (C) 2015-2022 AsamK and contributors
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org
.asamk
.signal
.manager
.internal
;
19 import org
.asamk
.signal
.manager
.Manager
;
20 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
21 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
22 import org
.asamk
.signal
.manager
.api
.CaptchaRejectedException
;
23 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
24 import org
.asamk
.signal
.manager
.api
.Configuration
;
25 import org
.asamk
.signal
.manager
.api
.Device
;
26 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
27 import org
.asamk
.signal
.manager
.api
.Group
;
28 import org
.asamk
.signal
.manager
.api
.GroupId
;
29 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
30 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
31 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
32 import org
.asamk
.signal
.manager
.api
.Identity
;
33 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
34 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
35 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
36 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
39 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
40 import org
.asamk
.signal
.manager
.api
.Message
;
41 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
43 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
44 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
45 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
46 import org
.asamk
.signal
.manager
.api
.Pair
;
47 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
48 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
49 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
50 import org
.asamk
.signal
.manager
.api
.Profile
;
51 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
52 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
53 import org
.asamk
.signal
.manager
.api
.Recipient
;
54 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
55 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
56 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
58 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
61 import org
.asamk
.signal
.manager
.api
.TextStyle
;
62 import org
.asamk
.signal
.manager
.api
.TypingAction
;
63 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
64 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
65 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
66 import org
.asamk
.signal
.manager
.api
.UserStatus
;
67 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
68 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
69 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
70 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
71 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
72 import org
.asamk
.signal
.manager
.helper
.Context
;
73 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
74 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
75 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
76 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
77 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
78 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
79 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
80 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
81 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
82 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
83 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
84 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
85 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
86 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
87 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
88 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
89 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
90 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
91 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
92 import org
.slf4j
.Logger
;
93 import org
.slf4j
.LoggerFactory
;
94 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
95 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
100 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
101 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
103 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
104 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
105 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
106 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
107 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
108 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
109 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
110 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
111 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
112 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
114 import java
.io
.ByteArrayInputStream
;
116 import java
.io
.FileNotFoundException
;
117 import java
.io
.IOException
;
118 import java
.io
.InputStream
;
119 import java
.nio
.charset
.StandardCharsets
;
120 import java
.time
.Duration
;
121 import java
.util
.ArrayList
;
122 import java
.util
.Collection
;
123 import java
.util
.HashMap
;
124 import java
.util
.HashSet
;
125 import java
.util
.List
;
126 import java
.util
.Map
;
127 import java
.util
.Objects
;
128 import java
.util
.Optional
;
129 import java
.util
.Set
;
130 import java
.util
.concurrent
.ExecutorService
;
131 import java
.util
.concurrent
.Executors
;
132 import java
.util
.concurrent
.TimeUnit
;
133 import java
.util
.concurrent
.atomic
.AtomicInteger
;
134 import java
.util
.concurrent
.locks
.ReentrantLock
;
135 import java
.util
.function
.Function
;
136 import java
.util
.stream
.Collectors
;
137 import java
.util
.stream
.Stream
;
139 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
140 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
142 public class ManagerImpl
implements Manager
{
144 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
146 private SignalAccount account
;
147 private final SignalDependencies dependencies
;
148 private final Context context
;
150 private final ExecutorService executor
= Executors
.newCachedThreadPool();
152 private Thread receiveThread
;
153 private boolean isReceivingSynchronous
;
154 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
155 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
156 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
157 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
158 private final CompositeDisposable disposable
= new CompositeDisposable();
161 SignalAccount account
,
162 PathConfig pathConfig
,
163 AccountFileUpdater accountFileUpdater
,
164 ServiceEnvironmentConfig serviceEnvironmentConfig
,
167 this.account
= account
;
169 final var sessionLock
= new SignalSessionLock() {
170 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
173 public Lock
acquire() {
175 return LEGACY_LOCK
::unlock
;
178 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
180 account
.getCredentialsProvider(),
181 account
.getSignalServiceDataStore(),
184 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
185 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
186 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
188 this.context
= new Context(account
, new AccountFileUpdater() {
190 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
191 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
192 synchronized (addressChangedListeners
) {
193 addressChangedListeners
.forEach(Runnable
::run
);
198 public void removeAccount() {
199 accountFileUpdater
.removeAccount();
201 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
202 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
203 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
204 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
205 synchronized (this) {
209 disposable
.add(account
.getIdentityKeyStore()
210 .getIdentityChanges()
211 .observeOn(Schedulers
.from(executor
))
212 .subscribe(serviceId
-> {
213 logger
.trace("Archiving old sessions for {}", serviceId
);
214 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
215 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
216 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
217 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
218 final var profile
= account
.getProfileStore().getProfile(recipientId
);
219 if (profile
!= null) {
220 account
.getProfileStore()
221 .storeProfile(recipientId
,
222 Profile
.newBuilder(profile
)
223 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
224 .withLastUpdateTimestamp(0)
231 public String
getSelfNumber() {
232 return account
.getNumber();
235 public void checkAccountState() throws IOException
{
236 context
.getAccountHelper().checkAccountState();
237 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
238 if (lastRecipientsRefresh
== null
239 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
240 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
241 context
.getAccountHelper().checkWhoAmiI();
246 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
247 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
249 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
250 if (!canonicalizedNumber
.equals(n
)) {
251 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
253 return canonicalizedNumber
;
254 } catch (InvalidNumberException e
) {
259 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
260 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
262 .filter(s
-> !s
.isEmpty())
263 .collect(Collectors
.toSet());
265 final Map
<String
, RegisteredUser
> registeredUsers
;
267 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
268 } catch (CdsiResourceExhaustedException e
) {
269 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
270 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
273 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
274 final var number
= canonicalizedNumbers
.get(n
);
275 final var user
= registeredUsers
.get(number
);
276 final var serviceId
= user
== null ?
null : user
.getServiceId();
277 final var profile
= serviceId
== null
279 : context
.getProfileHelper()
280 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
281 return new UserStatus(number
.isEmpty() ?
null : number
,
282 serviceId
== null ?
null : serviceId
.getRawUuid(),
284 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
289 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
290 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
291 for (final var username
: usernames
) {
293 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
294 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
295 registeredUsers
.put(username
, address
);
296 } catch (UnregisteredRecipientException e
) {
301 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
302 final var user
= registeredUsers
.get(username
);
303 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
304 final var profile
= serviceId
== null
306 : context
.getProfileHelper()
307 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
308 return new UsernameStatus(username
,
309 serviceId
== null ?
null : serviceId
.getRawUuid(),
311 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
316 public void updateAccountAttributes(
318 Boolean unrestrictedUnidentifiedSender
,
319 final Boolean discoverableByNumber
,
320 final Boolean numberSharing
321 ) throws IOException
{
322 if (deviceName
!= null) {
323 context
.getAccountHelper().setDeviceName(deviceName
);
325 if (unrestrictedUnidentifiedSender
!= null) {
326 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
328 if (discoverableByNumber
!= null) {
329 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
331 if (numberSharing
!= null) {
332 account
.getConfigurationStore()
333 .setPhoneNumberSharingMode(numberSharing
334 ? PhoneNumberSharingMode
.EVERYBODY
335 : PhoneNumberSharingMode
.NOBODY
);
337 context
.getAccountHelper().updateAccountAttributes();
338 context
.getAccountHelper().checkWhoAmiI();
342 public Configuration
getConfiguration() {
343 final var configurationStore
= account
.getConfigurationStore();
344 return Configuration
.from(configurationStore
);
348 public void updateConfiguration(Configuration configuration
) {
349 final var configurationStore
= account
.getConfigurationStore();
350 if (configuration
.readReceipts().isPresent()) {
351 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
353 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
354 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
356 if (configuration
.typingIndicators().isPresent()) {
357 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
359 if (configuration
.linkPreviews().isPresent()) {
360 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
362 context
.getSyncHelper().sendConfigurationMessage();
367 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
368 context
.getProfileHelper()
369 .setProfile(updateProfile
.getGivenName(),
370 updateProfile
.getFamilyName(),
371 updateProfile
.getAbout(),
372 updateProfile
.getAboutEmoji(),
373 updateProfile
.isDeleteAvatar()
375 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
376 updateProfile
.getMobileCoinAddress());
377 context
.getSyncHelper().sendSyncFetchProfileMessage();
380 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
381 context
.getAccountHelper().refreshCurrentUsername();
385 public String
getUsername() {
386 return account
.getUsername();
390 public UsernameLinkUrl
getUsernameLink() {
391 return new UsernameLinkUrl(account
.getUsernameLink());
395 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
397 if (username
.contains(".")) {
398 context
.getAccountHelper().reserveExactUsername(username
);
400 context
.getAccountHelper().reserveUsernameFromNickname(username
);
402 } catch (UsernameMalformedException e
) {
403 throw new InvalidUsernameException("Username is malformed", e
);
404 } catch (UsernameTakenException e
) {
405 throw new InvalidUsernameException("Username is already registered", e
);
406 } catch (BaseUsernameException e
) {
407 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
412 public void deleteUsername() throws IOException
{
413 context
.getAccountHelper().deleteUsername();
417 public void startChangeNumber(
418 String newNumber
, boolean voiceVerification
, String captcha
419 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
420 if (!account
.isPrimaryDevice()) {
421 throw new NotPrimaryDeviceException();
423 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
427 public void finishChangeNumber(
428 String newNumber
, String verificationCode
, String pin
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(
448 String challenge
, String captcha
449 ) throws IOException
, CaptchaRejectedException
{
450 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
453 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
454 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
455 throw new CaptchaRejectedException();
460 public List
<Device
> getLinkedDevices() throws IOException
{
461 var devices
= dependencies
.getAccountManager().getDevices();
462 account
.setMultiDevice(devices
.size() > 1);
463 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
464 return devices
.stream().map(d
-> {
465 String deviceName
= d
.getName();
466 if (deviceName
!= null) {
468 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
469 } catch (IOException e
) {
470 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
473 return new Device(d
.getId(),
477 d
.getId() == account
.getDeviceId());
482 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
483 if (!account
.isPrimaryDevice()) {
484 throw new NotPrimaryDeviceException();
486 context
.getAccountHelper().removeLinkedDevices(deviceId
);
490 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
{
491 if (!account
.isPrimaryDevice()) {
492 throw new NotPrimaryDeviceException();
494 context
.getAccountHelper().addDevice(linkUrl
);
498 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
499 if (!account
.isPrimaryDevice()) {
500 throw new NotPrimaryDeviceException();
502 if (pin
.isPresent()) {
503 context
.getAccountHelper().setRegistrationPin(pin
.get());
505 context
.getAccountHelper().removeRegistrationPin();
509 void refreshPreKeys() throws IOException
{
510 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
514 public List
<Group
> getGroups() {
515 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
518 private Group
toGroup(final GroupInfo groupInfo
) {
519 if (groupInfo
== null) {
523 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
527 public SendGroupMessageResults
quitGroup(
528 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
529 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
530 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
531 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
535 public void deleteGroup(GroupId groupId
) throws IOException
{
536 final var group
= context
.getGroupHelper().getGroup(groupId
);
537 if (group
.isMember(account
.getSelfRecipientId())) {
538 throw new IOException(
539 "The local group information cannot be removed, as the user is still a member of the group");
541 context
.getGroupHelper().deleteGroup(groupId
);
545 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
546 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
547 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
548 return context
.getGroupHelper()
550 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
555 public SendGroupMessageResults
updateGroup(
556 final GroupId groupId
, final UpdateGroup updateGroup
557 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
558 return context
.getGroupHelper()
559 .updateGroup(groupId
,
560 updateGroup
.getName(),
561 updateGroup
.getDescription(),
562 updateGroup
.getMembers() == null
564 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
565 updateGroup
.getRemoveMembers() == null
567 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
568 updateGroup
.getAdmins() == null
570 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
571 updateGroup
.getRemoveAdmins() == null
573 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
574 updateGroup
.getBanMembers() == null
576 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
577 updateGroup
.getUnbanMembers() == null
579 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
580 updateGroup
.isResetGroupLink(),
581 updateGroup
.getGroupLinkState(),
582 updateGroup
.getAddMemberPermission(),
583 updateGroup
.getEditDetailsPermission(),
584 updateGroup
.getAvatarFile(),
585 updateGroup
.getExpirationTimer(),
586 updateGroup
.getIsAnnouncementGroup());
590 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
591 GroupInviteLinkUrl inviteLinkUrl
592 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
593 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
596 private SendMessageResults
sendMessage(
597 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
598 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
599 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
602 private SendMessageResults
sendMessage(
603 SignalServiceDataMessage
.Builder messageBuilder
,
604 Set
<RecipientIdentifier
> recipients
,
606 Optional
<Long
> editTargetTimestamp
607 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
608 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
609 long timestamp
= System
.currentTimeMillis();
610 messageBuilder
.withTimestamp(timestamp
);
611 for (final var recipient
: recipients
) {
612 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
613 recipient
instanceof RecipientIdentifier
.Single single
614 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
616 final var result
= notifySelf
617 ? context
.getSendHelper()
618 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
619 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
620 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
621 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
623 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
624 final var result
= context
.getSendHelper()
625 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
626 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
627 } catch (UnregisteredRecipientException e
) {
628 results
.put(recipient
,
629 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
631 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
632 final var result
= context
.getSendHelper()
633 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
634 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
637 return new SendMessageResults(timestamp
, results
);
640 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
641 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
644 private SendMessageResults
sendTypingMessage(
645 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
646 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
647 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
648 final var timestamp
= System
.currentTimeMillis();
649 for (var recipient
: recipients
) {
650 if (recipient
instanceof RecipientIdentifier
.Single single
) {
651 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
653 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
654 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
655 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
656 } catch (UnregisteredRecipientException e
) {
657 results
.put(recipient
,
658 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
660 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
661 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
662 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
663 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
664 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
667 return new SendMessageResults(timestamp
, results
);
671 public SendMessageResults
sendTypingMessage(
672 TypingAction action
, Set
<RecipientIdentifier
> recipients
673 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
674 return sendTypingMessage(action
.toSignalService(), recipients
);
678 public SendMessageResults
sendReadReceipt(
679 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
681 final var timestamp
= System
.currentTimeMillis();
682 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
686 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
690 public SendMessageResults
sendViewedReceipt(
691 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
693 final var timestamp
= System
.currentTimeMillis();
694 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
698 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
701 private SendMessageResults
sendReceiptMessage(
702 final RecipientIdentifier
.Single sender
,
703 final long timestamp
,
704 final SignalServiceReceiptMessage receiptMessage
707 final var result
= context
.getSendHelper()
708 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
709 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
710 } catch (UnregisteredRecipientException e
) {
711 return new SendMessageResults(timestamp
,
712 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
717 public SendMessageResults
sendMessage(
718 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
719 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
720 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
721 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
723 "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.");
725 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
726 applyMessage(messageBuilder
, message
);
727 return sendMessage(messageBuilder
, recipients
, notifySelf
);
731 public SendMessageResults
sendEditMessage(
732 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
733 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
734 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
735 applyMessage(messageBuilder
, message
);
736 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
739 private void applyMessage(
740 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
741 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
742 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
743 if (message
.messageText().length() > 2000) {
744 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
745 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
746 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
747 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
748 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
750 messageBuilder
.withBody(message
.messageText());
752 if (!message
.attachments().isEmpty()) {
753 if (!additionalAttachments
.isEmpty()) {
754 additionalAttachments
.addAll(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
755 messageBuilder
.withAttachments(additionalAttachments
);
757 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
760 if (!message
.mentions().isEmpty()) {
761 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
763 if (!message
.textStyles().isEmpty()) {
764 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
766 if (message
.quote().isPresent()) {
767 final var quote
= message
.quote().get();
768 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
769 for (final var a
: quote
.attachments()) {
770 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
772 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
773 quotedAttachments
.add(quotedAttachment
);
775 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
776 context
.getRecipientHelper()
777 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
781 resolveMentions(quote
.mentions()),
782 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
783 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
785 if (message
.sticker().isPresent()) {
786 final var sticker
= message
.sticker().get();
787 final var packId
= StickerPackId
.deserialize(sticker
.packId());
788 final var stickerId
= sticker
.stickerId();
790 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
791 if (stickerPack
== null) {
792 throw new InvalidStickerException("Sticker pack not found");
794 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
795 if (manifest
.stickers().size() <= stickerId
) {
796 throw new InvalidStickerException("Sticker id not part of this pack");
798 final var manifestSticker
= manifest
.stickers().get(stickerId
);
799 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
800 if (streamDetails
== null) {
801 throw new InvalidStickerException("Missing local sticker file");
803 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
804 stickerPack
.packKey(),
806 manifestSticker
.emoji(),
807 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
809 if (!message
.previews().isEmpty()) {
810 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
811 for (final var p
: message
.previews()) {
812 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
813 .uploadAttachment(p
.image().get()) : null;
814 previews
.add(new SignalServicePreview(p
.url(),
818 Optional
.ofNullable(image
)));
820 messageBuilder
.withPreviews(previews
);
822 if (message
.storyReply().isPresent()) {
823 final var storyReply
= message
.storyReply().get();
824 final var authorServiceId
= context
.getRecipientHelper()
825 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
827 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
828 storyReply
.timestamp()));
832 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
833 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
834 for (final var m
: mentionList
) {
835 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
836 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
837 .resolveSignalServiceAddress(recipientId
)
838 .getServiceId(), m
.start(), m
.length()));
844 public SendMessageResults
sendRemoteDeleteMessage(
845 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
846 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
847 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
848 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
849 for (final var recipient
: recipients
) {
850 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
851 account
.getMessageSendLogStore()
852 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
853 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
854 account
.getMessageSendLogStore()
855 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.parseOrThrow(pni
.pni()));
856 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
858 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
859 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
860 if (address
.serviceId().isPresent()) {
861 account
.getMessageSendLogStore()
862 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
864 } catch (UnregisteredRecipientException ignored
) {
866 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
867 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
870 return sendMessage(messageBuilder
, recipients
, false);
874 public SendMessageResults
sendMessageReaction(
877 RecipientIdentifier
.Single targetAuthor
,
878 long targetSentTimestamp
,
879 Set
<RecipientIdentifier
> recipients
,
880 final boolean isStory
881 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
882 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
883 final var authorServiceId
= context
.getRecipientHelper()
884 .resolveSignalServiceAddress(targetAuthorRecipientId
)
886 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
887 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
889 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
890 targetSentTimestamp
));
892 return sendMessage(messageBuilder
, recipients
, false);
896 public SendMessageResults
sendPaymentNotificationMessage(
897 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
898 ) throws IOException
{
899 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
900 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
901 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
903 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
904 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
905 throw new AssertionError(e
);
910 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
911 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
914 return sendMessage(messageBuilder
,
915 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
917 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
918 throw new AssertionError(e
);
920 for (var recipient
: recipients
) {
921 final RecipientId recipientId
;
923 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
924 } catch (UnregisteredRecipientException e
) {
927 final var serviceId
= context
.getAccount()
928 .getRecipientAddressResolver()
929 .resolveRecipientAddress(recipientId
)
931 if (serviceId
.isPresent()) {
932 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
939 public SendMessageResults
sendMessageRequestResponse(
940 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
942 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
943 for (final var recipient
: recipients
) {
944 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
945 recipient
instanceof RecipientIdentifier
.Single single
946 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
948 final var result
= context
.getSyncHelper()
949 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
950 if (result
!= null) {
951 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
953 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
954 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
956 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
957 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
958 if (result
!= null) {
959 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
961 } catch (UnregisteredRecipientException e
) {
962 results
.put(recipient
,
963 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
965 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
966 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
967 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
970 return new SendMessageResults(0, results
);
974 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
975 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
976 if (recipientIdOptional
.isPresent()) {
977 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
978 account
.removeRecipient(recipientIdOptional
.get());
984 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
985 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
986 if (recipientIdOptional
.isPresent()) {
987 account
.removeRecipient(recipientIdOptional
.get());
993 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
994 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
995 if (recipientIdOptional
.isPresent()) {
996 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1002 public void setContactName(
1003 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
1004 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1005 if (!account
.isPrimaryDevice()) {
1006 throw new NotPrimaryDeviceException();
1008 context
.getContactHelper()
1009 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
1010 syncRemoteStorage();
1014 public void setContactsBlocked(
1015 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
1016 ) throws IOException
, UnregisteredRecipientException
{
1017 if (recipients
.isEmpty()) {
1020 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1021 final var selfRecipientId
= account
.getSelfRecipientId();
1022 boolean shouldRotateProfileKey
= false;
1023 for (final var recipientId
: recipientIds
) {
1024 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1027 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1028 context
.getSyncHelper()
1029 .sendMessageRequestResponse(blocked
1030 ? MessageRequestResponse
.Type
.BLOCK
1031 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1032 // if we don't have a common group with the blocked contact we need to rotate the profile key
1033 shouldRotateProfileKey
= blocked
&& (
1034 shouldRotateProfileKey
|| account
.getGroupStore()
1037 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1040 if (shouldRotateProfileKey
) {
1041 context
.getProfileHelper().rotateProfileKey();
1043 context
.getSyncHelper().sendBlockedList();
1044 syncRemoteStorage();
1048 public void setGroupsBlocked(
1049 final Collection
<GroupId
> groupIds
, final boolean blocked
1050 ) throws GroupNotFoundException
, IOException
{
1051 if (groupIds
.isEmpty()) {
1054 boolean shouldRotateProfileKey
= false;
1055 for (final var groupId
: groupIds
) {
1056 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1059 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1060 context
.getSyncHelper()
1061 .sendMessageRequestResponse(blocked
1062 ? MessageRequestResponse
.Type
.BLOCK
1063 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1064 shouldRotateProfileKey
= blocked
;
1066 if (shouldRotateProfileKey
) {
1067 context
.getProfileHelper().rotateProfileKey();
1069 context
.getSyncHelper().sendBlockedList();
1070 syncRemoteStorage();
1074 public void setExpirationTimer(
1075 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1076 ) throws IOException
, UnregisteredRecipientException
{
1077 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1078 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1079 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1081 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1082 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1083 throw new AssertionError(e
);
1085 syncRemoteStorage();
1089 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1090 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1092 var messageSender
= dependencies
.getMessageSender();
1094 var packKey
= KeyUtils
.createStickerUploadKey();
1095 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1096 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1098 var sticker
= new StickerPack(packId
, packKey
);
1099 account
.getStickerStore().addStickerPack(sticker
);
1100 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1102 return new StickerPackUrl(packId
, packKey
);
1106 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1107 final var packId
= url
.packId();
1108 final var packKey
= url
.packKey();
1110 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1111 } catch (InvalidMessageException e
) {
1112 throw new IOException(e
);
1115 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1116 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1120 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1121 final var stickerPackStore
= context
.getStickerPackStore();
1122 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1123 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1125 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1126 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1127 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1131 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1132 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1133 } catch (Exception e
) {
1134 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1138 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1143 public void requestAllSyncData() {
1144 context
.getSyncHelper().requestAllSyncData();
1145 syncRemoteStorage();
1148 void syncRemoteStorage() {
1149 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1153 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1154 synchronized (messageHandlers
) {
1155 if (isWeakListener
) {
1156 weakHandlers
.add(handler
);
1158 messageHandlers
.add(handler
);
1159 startReceiveThreadIfRequired();
1164 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1166 private void startReceiveThreadIfRequired() {
1167 if (receiveThread
!= null || isReceivingSynchronous
) {
1170 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1171 logger
.debug("Starting receiving messages");
1172 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1173 logger
.debug("Finished receiving messages");
1174 synchronized (messageHandlers
) {
1175 receiveThread
= null;
1177 // Check if in the meantime another handler has been registered
1178 if (!messageHandlers
.isEmpty()) {
1179 logger
.debug("Another handler has been registered, starting receive thread again");
1180 startReceiveThreadIfRequired();
1186 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1187 synchronized (messageHandlers
) {
1188 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1190 h
.handleMessage(envelope
, e
);
1191 } catch (Throwable ex
) {
1192 logger
.warn("Message handler failed, ignoring", ex
);
1199 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1200 final Thread thread
;
1201 synchronized (messageHandlers
) {
1202 weakHandlers
.remove(handler
);
1203 messageHandlers
.remove(handler
);
1204 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1207 thread
= receiveThread
;
1208 receiveThread
= null;
1211 stopReceiveThread(thread
);
1214 private void stopReceiveThread(final Thread thread
) {
1215 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1216 logger
.debug("Receive stop requested, interrupting read from server.");
1221 } catch (InterruptedException ignored
) {
1226 public boolean isReceiving() {
1227 if (isReceivingSynchronous
) {
1230 synchronized (messageHandlers
) {
1231 return !messageHandlers
.isEmpty();
1236 public void receiveMessages(
1237 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1238 ) throws IOException
, AlreadyReceivingException
{
1239 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1243 public void stopReceiveMessages() {
1244 Thread thread
= null;
1245 synchronized (messageHandlers
) {
1246 if (isReceivingSynchronous
) {
1247 thread
= receiveThread
;
1248 receiveThread
= null;
1251 if (thread
!= null) {
1252 stopReceiveThread(thread
);
1256 private void receiveMessages(
1257 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1258 ) throws IOException
, AlreadyReceivingException
{
1259 synchronized (messageHandlers
) {
1260 if (isReceiving()) {
1261 throw new AlreadyReceivingException("Already receiving message.");
1263 isReceivingSynchronous
= true;
1264 receiveThread
= Thread
.currentThread();
1267 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1268 passReceivedMessageToHandlers(envelope
, e
);
1269 handler
.handleMessage(envelope
, e
);
1272 synchronized (messageHandlers
) {
1273 receiveThread
= null;
1274 isReceivingSynchronous
= false;
1275 if (!messageHandlers
.isEmpty()) {
1276 startReceiveThreadIfRequired();
1283 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1284 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1288 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1289 final RecipientId recipientId
;
1291 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1292 } catch (UnregisteredRecipientException e
) {
1295 return context
.getContactHelper().isContactBlocked(recipientId
);
1299 public void sendContacts() throws IOException
{
1300 context
.getSyncHelper().sendContacts();
1304 public List
<Recipient
> getRecipients(
1305 boolean onlyContacts
,
1306 Optional
<Boolean
> blocked
,
1307 Collection
<RecipientIdentifier
.Single
> recipients
,
1308 Optional
<String
> name
1310 final var recipientIds
= recipients
.stream().map(a
-> {
1312 return context
.getRecipientHelper().resolveRecipient(a
);
1313 } catch (UnregisteredRecipientException e
) {
1316 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1317 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1320 // refresh profiles of explicitly given recipients
1321 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1322 return account
.getRecipientStore()
1323 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1325 .map(s
-> new Recipient(s
.getRecipientId(),
1326 s
.getAddress().toApiRecipientAddress(),
1329 s
.getExpiringProfileKeyCredential(),
1331 s
.getDiscoverable()))
1336 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1337 final RecipientId recipientId
;
1339 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1340 } catch (UnregisteredRecipientException e
) {
1344 final var contact
= account
.getContactStore().getContact(recipientId
);
1345 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1346 return contact
.getName();
1349 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1350 if (profile
!= null) {
1351 return profile
.getDisplayName();
1358 public Group
getGroup(GroupId groupId
) {
1359 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1363 public List
<Identity
> getIdentities() {
1364 return account
.getIdentityKeyStore()
1367 .map(this::toIdentity
)
1368 .filter(Objects
::nonNull
)
1372 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1373 if (identityInfo
== null) {
1377 final var address
= account
.getRecipientAddressResolver()
1378 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1379 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1380 identityInfo
.getServiceId())) {
1383 final var scannableFingerprint
= context
.getIdentityHelper()
1384 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1385 return new Identity(address
.toApiRecipientAddress(),
1386 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1387 context
.getIdentityHelper()
1388 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1389 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1390 identityInfo
.getTrustLevel(),
1391 identityInfo
.getDateAddedTimestamp());
1395 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1396 ServiceId serviceId
;
1398 final var address
= account
.getRecipientAddressResolver()
1399 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1400 if (address
.serviceId().isEmpty()) {
1403 serviceId
= address
.serviceId().get();
1404 } catch (UnregisteredRecipientException e
) {
1407 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1408 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1412 public boolean trustIdentityVerified(
1413 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1414 ) throws UnregisteredRecipientException
{
1415 return switch (verificationCode
) {
1416 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1417 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1418 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1419 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1420 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1421 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1422 case null -> throw new AssertionError("Invalid verification code type");
1427 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1428 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1431 private boolean trustIdentity(
1432 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1433 ) throws UnregisteredRecipientException
{
1434 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1435 final var updated
= trustMethod
.apply(recipientId
);
1436 if (updated
&& this.isReceiving()) {
1437 account
.setNeedsToRetryFailedMessages(true);
1443 public void addAddressChangedListener(final Runnable listener
) {
1444 synchronized (addressChangedListeners
) {
1445 addressChangedListeners
.add(listener
);
1450 public void addClosedListener(final Runnable listener
) {
1451 synchronized (closedListeners
) {
1452 closedListeners
.add(listener
);
1457 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1458 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1462 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1463 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1464 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1465 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1466 if (streamDetails
== null) {
1467 throw new FileNotFoundException();
1469 return streamDetails
.getStream();
1473 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1474 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1475 context
.getProfileHelper().getRecipientProfile(recipientId
);
1476 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1477 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1478 if (streamDetails
== null) {
1479 throw new FileNotFoundException();
1481 return streamDetails
.getStream();
1485 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1486 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1487 context
.getGroupHelper().getGroup(groupId
);
1488 if (streamDetails
== null) {
1489 throw new FileNotFoundException();
1491 return streamDetails
.getStream();
1495 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1496 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1497 if (streamDetails
== null) {
1498 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1501 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1502 } catch (InvalidMessageException e
) {
1503 logger
.warn("Failed to download sticker pack");
1507 if (streamDetails
== null) {
1508 throw new FileNotFoundException();
1510 return streamDetails
.getStream();
1514 public void close() {
1516 synchronized (messageHandlers
) {
1517 weakHandlers
.clear();
1518 messageHandlers
.clear();
1519 thread
= receiveThread
;
1520 receiveThread
= null;
1522 if (thread
!= null) {
1523 stopReceiveThread(thread
);
1528 dependencies
.getSignalWebSocket().disconnect();
1529 dependencies
.getPushServiceSocket().close();
1530 disposable
.dispose();
1532 if (account
!= null) {
1536 synchronized (closedListeners
) {
1537 closedListeners
.forEach(Runnable
::run
);
1538 closedListeners
.clear();