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
.SignalServiceDataMessage
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
99 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
100 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
101 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
103 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
104 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
105 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
106 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
107 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
108 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
109 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
110 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
111 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
113 import java
.io
.ByteArrayInputStream
;
115 import java
.io
.FileNotFoundException
;
116 import java
.io
.IOException
;
117 import java
.io
.InputStream
;
118 import java
.nio
.charset
.StandardCharsets
;
119 import java
.time
.Duration
;
120 import java
.util
.ArrayList
;
121 import java
.util
.Collection
;
122 import java
.util
.HashMap
;
123 import java
.util
.HashSet
;
124 import java
.util
.List
;
125 import java
.util
.Map
;
126 import java
.util
.Objects
;
127 import java
.util
.Optional
;
128 import java
.util
.Set
;
129 import java
.util
.concurrent
.ExecutorService
;
130 import java
.util
.concurrent
.Executors
;
131 import java
.util
.concurrent
.TimeUnit
;
132 import java
.util
.concurrent
.atomic
.AtomicInteger
;
133 import java
.util
.concurrent
.locks
.ReentrantLock
;
134 import java
.util
.function
.Function
;
135 import java
.util
.stream
.Collectors
;
136 import java
.util
.stream
.Stream
;
138 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
139 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
141 public class ManagerImpl
implements Manager
{
143 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
145 private SignalAccount account
;
146 private final SignalDependencies dependencies
;
147 private final Context context
;
149 private final ExecutorService executor
= Executors
.newCachedThreadPool();
151 private Thread receiveThread
;
152 private boolean isReceivingSynchronous
;
153 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
154 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
155 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
156 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
157 private final CompositeDisposable disposable
= new CompositeDisposable();
160 SignalAccount account
,
161 PathConfig pathConfig
,
162 AccountFileUpdater accountFileUpdater
,
163 ServiceEnvironmentConfig serviceEnvironmentConfig
,
166 this.account
= account
;
168 final var sessionLock
= new SignalSessionLock() {
169 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
172 public Lock
acquire() {
174 return LEGACY_LOCK
::unlock
;
177 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
179 account
.getCredentialsProvider(),
180 account
.getSignalServiceDataStore(),
183 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
184 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
185 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
187 this.context
= new Context(account
, new AccountFileUpdater() {
189 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
190 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
191 synchronized (addressChangedListeners
) {
192 addressChangedListeners
.forEach(Runnable
::run
);
197 public void removeAccount() {
198 accountFileUpdater
.removeAccount();
200 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
201 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
202 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
203 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
204 synchronized (this) {
208 disposable
.add(account
.getIdentityKeyStore()
209 .getIdentityChanges()
210 .observeOn(Schedulers
.from(executor
))
211 .subscribe(serviceId
-> {
212 logger
.trace("Archiving old sessions for {}", serviceId
);
213 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
214 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
215 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
216 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
217 final var profile
= account
.getProfileStore().getProfile(recipientId
);
218 if (profile
!= null) {
219 account
.getProfileStore()
220 .storeProfile(recipientId
,
221 Profile
.newBuilder(profile
)
222 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
223 .withLastUpdateTimestamp(0)
230 public String
getSelfNumber() {
231 return account
.getNumber();
234 public void checkAccountState() throws IOException
{
235 context
.getAccountHelper().checkAccountState();
236 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
237 if (lastRecipientsRefresh
== null
238 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
239 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
240 context
.getAccountHelper().checkWhoAmiI();
245 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
246 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
248 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
249 if (!canonicalizedNumber
.equals(n
)) {
250 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
252 return canonicalizedNumber
;
253 } catch (InvalidNumberException e
) {
258 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
259 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
261 .filter(s
-> !s
.isEmpty())
262 .collect(Collectors
.toSet());
264 final Map
<String
, RegisteredUser
> registeredUsers
;
266 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
267 } catch (CdsiResourceExhaustedException e
) {
268 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
269 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
272 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
273 final var number
= canonicalizedNumbers
.get(n
);
274 final var user
= registeredUsers
.get(number
);
275 final var serviceId
= user
== null ?
null : user
.getServiceId();
276 final var profile
= serviceId
== null
278 : context
.getProfileHelper()
279 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
280 return new UserStatus(number
.isEmpty() ?
null : number
,
281 serviceId
== null ?
null : serviceId
.getRawUuid(),
283 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
288 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
289 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
290 for (final var username
: usernames
) {
292 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
293 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
294 registeredUsers
.put(username
, address
);
295 } catch (UnregisteredRecipientException e
) {
300 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
301 final var user
= registeredUsers
.get(username
);
302 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
303 final var profile
= serviceId
== null
305 : context
.getProfileHelper()
306 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
307 return new UsernameStatus(username
,
308 serviceId
== null ?
null : serviceId
.getRawUuid(),
310 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
315 public void updateAccountAttributes(
317 Boolean unrestrictedUnidentifiedSender
,
318 final Boolean discoverableByNumber
,
319 final Boolean numberSharing
320 ) throws IOException
{
321 if (deviceName
!= null) {
322 context
.getAccountHelper().setDeviceName(deviceName
);
324 if (unrestrictedUnidentifiedSender
!= null) {
325 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
327 if (discoverableByNumber
!= null) {
328 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
330 if (numberSharing
!= null) {
331 account
.getConfigurationStore()
332 .setPhoneNumberSharingMode(numberSharing
333 ? PhoneNumberSharingMode
.EVERYBODY
334 : PhoneNumberSharingMode
.NOBODY
);
336 context
.getAccountHelper().updateAccountAttributes();
337 context
.getAccountHelper().checkWhoAmiI();
341 public Configuration
getConfiguration() {
342 final var configurationStore
= account
.getConfigurationStore();
343 return Configuration
.from(configurationStore
);
347 public void updateConfiguration(Configuration configuration
) {
348 final var configurationStore
= account
.getConfigurationStore();
349 if (configuration
.readReceipts().isPresent()) {
350 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
352 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
353 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
355 if (configuration
.typingIndicators().isPresent()) {
356 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
358 if (configuration
.linkPreviews().isPresent()) {
359 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
361 context
.getSyncHelper().sendConfigurationMessage();
366 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
367 context
.getProfileHelper()
368 .setProfile(updateProfile
.getGivenName(),
369 updateProfile
.getFamilyName(),
370 updateProfile
.getAbout(),
371 updateProfile
.getAboutEmoji(),
372 updateProfile
.isDeleteAvatar()
374 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
375 updateProfile
.getMobileCoinAddress());
376 context
.getSyncHelper().sendSyncFetchProfileMessage();
379 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
380 context
.getAccountHelper().refreshCurrentUsername();
384 public String
getUsername() {
385 return account
.getUsername();
389 public UsernameLinkUrl
getUsernameLink() {
390 return new UsernameLinkUrl(account
.getUsernameLink());
394 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
396 if (username
.contains(".")) {
397 context
.getAccountHelper().reserveExactUsername(username
);
399 context
.getAccountHelper().reserveUsernameFromNickname(username
);
401 } catch (UsernameMalformedException e
) {
402 throw new InvalidUsernameException("Username is malformed", e
);
403 } catch (UsernameTakenException e
) {
404 throw new InvalidUsernameException("Username is already registered", e
);
405 } catch (BaseUsernameException e
) {
406 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
411 public void deleteUsername() throws IOException
{
412 context
.getAccountHelper().deleteUsername();
416 public void startChangeNumber(
417 String newNumber
, boolean voiceVerification
, String captcha
418 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
419 if (!account
.isPrimaryDevice()) {
420 throw new NotPrimaryDeviceException();
422 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
426 public void finishChangeNumber(
427 String newNumber
, String verificationCode
, String pin
428 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
429 if (!account
.isPrimaryDevice()) {
430 throw new NotPrimaryDeviceException();
432 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
436 public void unregister() throws IOException
{
437 context
.getAccountHelper().unregister();
441 public void deleteAccount() throws IOException
{
442 context
.getAccountHelper().deleteAccount();
446 public void submitRateLimitRecaptchaChallenge(
447 String challenge
, String captcha
448 ) throws IOException
, CaptchaRejectedException
{
449 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
452 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
453 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
454 throw new CaptchaRejectedException();
459 public List
<Device
> getLinkedDevices() throws IOException
{
460 var devices
= dependencies
.getAccountManager().getDevices();
461 account
.setMultiDevice(devices
.size() > 1);
462 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
463 return devices
.stream().map(d
-> {
464 String deviceName
= d
.getName();
465 if (deviceName
!= null) {
467 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
468 } catch (IOException e
) {
469 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
472 return new Device(d
.getId(),
476 d
.getId() == account
.getDeviceId());
481 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
482 if (!account
.isPrimaryDevice()) {
483 throw new NotPrimaryDeviceException();
485 context
.getAccountHelper().removeLinkedDevices(deviceId
);
489 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
{
490 if (!account
.isPrimaryDevice()) {
491 throw new NotPrimaryDeviceException();
493 context
.getAccountHelper().addDevice(linkUrl
);
497 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
498 if (!account
.isPrimaryDevice()) {
499 throw new NotPrimaryDeviceException();
501 if (pin
.isPresent()) {
502 context
.getAccountHelper().setRegistrationPin(pin
.get());
504 context
.getAccountHelper().removeRegistrationPin();
508 void refreshPreKeys() throws IOException
{
509 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
513 public List
<Group
> getGroups() {
514 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
517 private Group
toGroup(final GroupInfo groupInfo
) {
518 if (groupInfo
== null) {
522 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
526 public SendGroupMessageResults
quitGroup(
527 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
528 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
529 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
530 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
534 public void deleteGroup(GroupId groupId
) throws IOException
{
535 final var group
= context
.getGroupHelper().getGroup(groupId
);
536 if (group
.isMember(account
.getSelfRecipientId())) {
537 throw new IOException(
538 "The local group information cannot be removed, as the user is still a member of the group");
540 context
.getGroupHelper().deleteGroup(groupId
);
544 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
545 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
546 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
547 return context
.getGroupHelper()
549 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
554 public SendGroupMessageResults
updateGroup(
555 final GroupId groupId
, final UpdateGroup updateGroup
556 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
557 return context
.getGroupHelper()
558 .updateGroup(groupId
,
559 updateGroup
.getName(),
560 updateGroup
.getDescription(),
561 updateGroup
.getMembers() == null
563 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
564 updateGroup
.getRemoveMembers() == null
566 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
567 updateGroup
.getAdmins() == null
569 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
570 updateGroup
.getRemoveAdmins() == null
572 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
573 updateGroup
.getBanMembers() == null
575 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
576 updateGroup
.getUnbanMembers() == null
578 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
579 updateGroup
.isResetGroupLink(),
580 updateGroup
.getGroupLinkState(),
581 updateGroup
.getAddMemberPermission(),
582 updateGroup
.getEditDetailsPermission(),
583 updateGroup
.getAvatarFile(),
584 updateGroup
.getExpirationTimer(),
585 updateGroup
.getIsAnnouncementGroup());
589 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
590 GroupInviteLinkUrl inviteLinkUrl
591 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
592 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
595 private SendMessageResults
sendMessage(
596 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
597 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
598 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
601 private SendMessageResults
sendMessage(
602 SignalServiceDataMessage
.Builder messageBuilder
,
603 Set
<RecipientIdentifier
> recipients
,
605 Optional
<Long
> editTargetTimestamp
606 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
607 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
608 long timestamp
= System
.currentTimeMillis();
609 messageBuilder
.withTimestamp(timestamp
);
610 for (final var recipient
: recipients
) {
611 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
612 recipient
instanceof RecipientIdentifier
.Single single
613 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
615 final var result
= notifySelf
616 ? context
.getSendHelper()
617 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
618 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
619 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
620 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
622 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
623 final var result
= context
.getSendHelper()
624 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
625 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
626 } catch (UnregisteredRecipientException e
) {
627 results
.put(recipient
,
628 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
630 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
631 final var result
= context
.getSendHelper()
632 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
633 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
636 return new SendMessageResults(timestamp
, results
);
639 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
640 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
643 private SendMessageResults
sendTypingMessage(
644 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
645 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
646 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
647 final var timestamp
= System
.currentTimeMillis();
648 for (var recipient
: recipients
) {
649 if (recipient
instanceof RecipientIdentifier
.Single single
) {
650 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
652 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
653 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
654 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
655 } catch (UnregisteredRecipientException e
) {
656 results
.put(recipient
,
657 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
659 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
660 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
661 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
662 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
663 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
666 return new SendMessageResults(timestamp
, results
);
670 public SendMessageResults
sendTypingMessage(
671 TypingAction action
, Set
<RecipientIdentifier
> recipients
672 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
673 return sendTypingMessage(action
.toSignalService(), recipients
);
677 public SendMessageResults
sendReadReceipt(
678 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
680 final var timestamp
= System
.currentTimeMillis();
681 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
685 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
689 public SendMessageResults
sendViewedReceipt(
690 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
692 final var timestamp
= System
.currentTimeMillis();
693 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
697 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
700 private SendMessageResults
sendReceiptMessage(
701 final RecipientIdentifier
.Single sender
,
702 final long timestamp
,
703 final SignalServiceReceiptMessage receiptMessage
706 final var result
= context
.getSendHelper()
707 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
708 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
709 } catch (UnregisteredRecipientException e
) {
710 return new SendMessageResults(timestamp
,
711 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
716 public SendMessageResults
sendMessage(
717 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
718 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
719 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
720 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
722 "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.");
724 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
725 applyMessage(messageBuilder
, message
);
726 return sendMessage(messageBuilder
, recipients
, notifySelf
);
730 public SendMessageResults
sendEditMessage(
731 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
732 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
733 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
734 applyMessage(messageBuilder
, message
);
735 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
738 private void applyMessage(
739 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
740 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
741 if (message
.messageText().length() > 2000) {
742 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
743 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
744 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
745 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
746 messageBuilder
.withAttachment(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
748 messageBuilder
.withBody(message
.messageText());
750 if (!message
.attachments().isEmpty()) {
751 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
753 if (!message
.mentions().isEmpty()) {
754 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
756 if (!message
.textStyles().isEmpty()) {
757 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
759 if (message
.quote().isPresent()) {
760 final var quote
= message
.quote().get();
761 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
762 for (final var a
: quote
.attachments()) {
763 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
765 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
766 quotedAttachments
.add(quotedAttachment
);
768 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
769 context
.getRecipientHelper()
770 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
774 resolveMentions(quote
.mentions()),
775 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
776 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
778 if (message
.sticker().isPresent()) {
779 final var sticker
= message
.sticker().get();
780 final var packId
= StickerPackId
.deserialize(sticker
.packId());
781 final var stickerId
= sticker
.stickerId();
783 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
784 if (stickerPack
== null) {
785 throw new InvalidStickerException("Sticker pack not found");
787 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
788 if (manifest
.stickers().size() <= stickerId
) {
789 throw new InvalidStickerException("Sticker id not part of this pack");
791 final var manifestSticker
= manifest
.stickers().get(stickerId
);
792 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
793 if (streamDetails
== null) {
794 throw new InvalidStickerException("Missing local sticker file");
796 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
797 stickerPack
.packKey(),
799 manifestSticker
.emoji(),
800 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
802 if (!message
.previews().isEmpty()) {
803 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
804 for (final var p
: message
.previews()) {
805 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
806 .uploadAttachment(p
.image().get()) : null;
807 previews
.add(new SignalServicePreview(p
.url(),
811 Optional
.ofNullable(image
)));
813 messageBuilder
.withPreviews(previews
);
815 if (message
.storyReply().isPresent()) {
816 final var storyReply
= message
.storyReply().get();
817 final var authorServiceId
= context
.getRecipientHelper()
818 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
820 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
821 storyReply
.timestamp()));
825 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
826 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
827 for (final var m
: mentionList
) {
828 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
829 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
830 .resolveSignalServiceAddress(recipientId
)
831 .getServiceId(), m
.start(), m
.length()));
837 public SendMessageResults
sendRemoteDeleteMessage(
838 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
839 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
840 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
841 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
842 for (final var recipient
: recipients
) {
843 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
844 account
.getMessageSendLogStore()
845 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
846 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
847 account
.getMessageSendLogStore()
848 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.parseOrThrow(pni
.pni()));
849 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
851 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
852 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
853 if (address
.serviceId().isPresent()) {
854 account
.getMessageSendLogStore()
855 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
857 } catch (UnregisteredRecipientException ignored
) {
859 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
860 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
863 return sendMessage(messageBuilder
, recipients
, false);
867 public SendMessageResults
sendMessageReaction(
870 RecipientIdentifier
.Single targetAuthor
,
871 long targetSentTimestamp
,
872 Set
<RecipientIdentifier
> recipients
,
873 final boolean isStory
874 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
875 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
876 final var authorServiceId
= context
.getRecipientHelper()
877 .resolveSignalServiceAddress(targetAuthorRecipientId
)
879 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
880 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
882 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
883 targetSentTimestamp
));
885 return sendMessage(messageBuilder
, recipients
, false);
889 public SendMessageResults
sendPaymentNotificationMessage(
890 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
891 ) throws IOException
{
892 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
893 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
894 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
896 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
897 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
898 throw new AssertionError(e
);
903 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
904 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
907 return sendMessage(messageBuilder
,
908 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
910 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
911 throw new AssertionError(e
);
913 for (var recipient
: recipients
) {
914 final RecipientId recipientId
;
916 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
917 } catch (UnregisteredRecipientException e
) {
920 final var serviceId
= context
.getAccount()
921 .getRecipientAddressResolver()
922 .resolveRecipientAddress(recipientId
)
924 if (serviceId
.isPresent()) {
925 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
932 public SendMessageResults
sendMessageRequestResponse(
933 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
935 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
936 for (final var recipient
: recipients
) {
937 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
938 recipient
instanceof RecipientIdentifier
.Single single
939 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
941 final var result
= context
.getSyncHelper()
942 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
943 if (result
!= null) {
944 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
946 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
947 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
949 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
950 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
951 if (result
!= null) {
952 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
954 } catch (UnregisteredRecipientException e
) {
955 results
.put(recipient
,
956 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
958 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
959 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
960 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
963 return new SendMessageResults(0, results
);
967 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
968 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
969 if (recipientIdOptional
.isPresent()) {
970 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
971 account
.removeRecipient(recipientIdOptional
.get());
977 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
978 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
979 if (recipientIdOptional
.isPresent()) {
980 account
.removeRecipient(recipientIdOptional
.get());
986 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
987 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
988 if (recipientIdOptional
.isPresent()) {
989 account
.getContactStore().deleteContact(recipientIdOptional
.get());
995 public void setContactName(
996 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
997 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
998 if (!account
.isPrimaryDevice()) {
999 throw new NotPrimaryDeviceException();
1001 context
.getContactHelper()
1002 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
1003 syncRemoteStorage();
1007 public void setContactsBlocked(
1008 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
1009 ) throws IOException
, UnregisteredRecipientException
{
1010 if (recipients
.isEmpty()) {
1013 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1014 final var selfRecipientId
= account
.getSelfRecipientId();
1015 boolean shouldRotateProfileKey
= false;
1016 for (final var recipientId
: recipientIds
) {
1017 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1020 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1021 context
.getSyncHelper()
1022 .sendMessageRequestResponse(blocked
1023 ? MessageRequestResponse
.Type
.BLOCK
1024 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1025 // if we don't have a common group with the blocked contact we need to rotate the profile key
1026 shouldRotateProfileKey
= blocked
&& (
1027 shouldRotateProfileKey
|| account
.getGroupStore()
1030 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1033 if (shouldRotateProfileKey
) {
1034 context
.getProfileHelper().rotateProfileKey();
1036 context
.getSyncHelper().sendBlockedList();
1037 syncRemoteStorage();
1041 public void setGroupsBlocked(
1042 final Collection
<GroupId
> groupIds
, final boolean blocked
1043 ) throws GroupNotFoundException
, IOException
{
1044 if (groupIds
.isEmpty()) {
1047 boolean shouldRotateProfileKey
= false;
1048 for (final var groupId
: groupIds
) {
1049 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1052 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1053 context
.getSyncHelper()
1054 .sendMessageRequestResponse(blocked
1055 ? MessageRequestResponse
.Type
.BLOCK
1056 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1057 shouldRotateProfileKey
= blocked
;
1059 if (shouldRotateProfileKey
) {
1060 context
.getProfileHelper().rotateProfileKey();
1062 context
.getSyncHelper().sendBlockedList();
1063 syncRemoteStorage();
1067 public void setExpirationTimer(
1068 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1069 ) throws IOException
, UnregisteredRecipientException
{
1070 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1071 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1072 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1074 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1075 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1076 throw new AssertionError(e
);
1078 syncRemoteStorage();
1082 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1083 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1085 var messageSender
= dependencies
.getMessageSender();
1087 var packKey
= KeyUtils
.createStickerUploadKey();
1088 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1089 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1091 var sticker
= new StickerPack(packId
, packKey
);
1092 account
.getStickerStore().addStickerPack(sticker
);
1093 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1095 return new StickerPackUrl(packId
, packKey
);
1099 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1100 final var packId
= url
.packId();
1101 final var packKey
= url
.packKey();
1103 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1104 } catch (InvalidMessageException e
) {
1105 throw new IOException(e
);
1108 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1109 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1113 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1114 final var stickerPackStore
= context
.getStickerPackStore();
1115 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1116 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1118 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1119 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1120 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1124 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1125 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1126 } catch (Exception e
) {
1127 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1131 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1136 public void requestAllSyncData() {
1137 context
.getSyncHelper().requestAllSyncData();
1138 syncRemoteStorage();
1141 void syncRemoteStorage() {
1142 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1146 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1147 synchronized (messageHandlers
) {
1148 if (isWeakListener
) {
1149 weakHandlers
.add(handler
);
1151 messageHandlers
.add(handler
);
1152 startReceiveThreadIfRequired();
1157 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1159 private void startReceiveThreadIfRequired() {
1160 if (receiveThread
!= null || isReceivingSynchronous
) {
1163 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1164 logger
.debug("Starting receiving messages");
1165 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1166 logger
.debug("Finished receiving messages");
1167 synchronized (messageHandlers
) {
1168 receiveThread
= null;
1170 // Check if in the meantime another handler has been registered
1171 if (!messageHandlers
.isEmpty()) {
1172 logger
.debug("Another handler has been registered, starting receive thread again");
1173 startReceiveThreadIfRequired();
1179 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1180 synchronized (messageHandlers
) {
1181 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1183 h
.handleMessage(envelope
, e
);
1184 } catch (Throwable ex
) {
1185 logger
.warn("Message handler failed, ignoring", ex
);
1192 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1193 final Thread thread
;
1194 synchronized (messageHandlers
) {
1195 weakHandlers
.remove(handler
);
1196 messageHandlers
.remove(handler
);
1197 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1200 thread
= receiveThread
;
1201 receiveThread
= null;
1204 stopReceiveThread(thread
);
1207 private void stopReceiveThread(final Thread thread
) {
1208 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1209 logger
.debug("Receive stop requested, interrupting read from server.");
1214 } catch (InterruptedException ignored
) {
1219 public boolean isReceiving() {
1220 if (isReceivingSynchronous
) {
1223 synchronized (messageHandlers
) {
1224 return !messageHandlers
.isEmpty();
1229 public void receiveMessages(
1230 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1231 ) throws IOException
, AlreadyReceivingException
{
1232 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1236 public void stopReceiveMessages() {
1237 Thread thread
= null;
1238 synchronized (messageHandlers
) {
1239 if (isReceivingSynchronous
) {
1240 thread
= receiveThread
;
1241 receiveThread
= null;
1244 if (thread
!= null) {
1245 stopReceiveThread(thread
);
1249 private void receiveMessages(
1250 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1251 ) throws IOException
, AlreadyReceivingException
{
1252 synchronized (messageHandlers
) {
1253 if (isReceiving()) {
1254 throw new AlreadyReceivingException("Already receiving message.");
1256 isReceivingSynchronous
= true;
1257 receiveThread
= Thread
.currentThread();
1260 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1261 passReceivedMessageToHandlers(envelope
, e
);
1262 handler
.handleMessage(envelope
, e
);
1265 synchronized (messageHandlers
) {
1266 receiveThread
= null;
1267 isReceivingSynchronous
= false;
1268 if (!messageHandlers
.isEmpty()) {
1269 startReceiveThreadIfRequired();
1276 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1277 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1281 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1282 final RecipientId recipientId
;
1284 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1285 } catch (UnregisteredRecipientException e
) {
1288 return context
.getContactHelper().isContactBlocked(recipientId
);
1292 public void sendContacts() throws IOException
{
1293 context
.getSyncHelper().sendContacts();
1297 public List
<Recipient
> getRecipients(
1298 boolean onlyContacts
,
1299 Optional
<Boolean
> blocked
,
1300 Collection
<RecipientIdentifier
.Single
> recipients
,
1301 Optional
<String
> name
1303 final var recipientIds
= recipients
.stream().map(a
-> {
1305 return context
.getRecipientHelper().resolveRecipient(a
);
1306 } catch (UnregisteredRecipientException e
) {
1309 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1310 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1313 // refresh profiles of explicitly given recipients
1314 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1315 return account
.getRecipientStore()
1316 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1318 .map(s
-> new Recipient(s
.getRecipientId(),
1319 s
.getAddress().toApiRecipientAddress(),
1322 s
.getExpiringProfileKeyCredential(),
1324 s
.getDiscoverable()))
1329 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1330 final RecipientId recipientId
;
1332 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1333 } catch (UnregisteredRecipientException e
) {
1337 final var contact
= account
.getContactStore().getContact(recipientId
);
1338 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1339 return contact
.getName();
1342 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1343 if (profile
!= null) {
1344 return profile
.getDisplayName();
1351 public Group
getGroup(GroupId groupId
) {
1352 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1356 public List
<Identity
> getIdentities() {
1357 return account
.getIdentityKeyStore()
1360 .map(this::toIdentity
)
1361 .filter(Objects
::nonNull
)
1365 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1366 if (identityInfo
== null) {
1370 final var address
= account
.getRecipientAddressResolver()
1371 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1372 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1373 identityInfo
.getServiceId())) {
1376 final var scannableFingerprint
= context
.getIdentityHelper()
1377 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1378 return new Identity(address
.toApiRecipientAddress(),
1379 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1380 context
.getIdentityHelper()
1381 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1382 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1383 identityInfo
.getTrustLevel(),
1384 identityInfo
.getDateAddedTimestamp());
1388 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1389 ServiceId serviceId
;
1391 final var address
= account
.getRecipientAddressResolver()
1392 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1393 if (address
.serviceId().isEmpty()) {
1396 serviceId
= address
.serviceId().get();
1397 } catch (UnregisteredRecipientException e
) {
1400 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1401 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1405 public boolean trustIdentityVerified(
1406 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1407 ) throws UnregisteredRecipientException
{
1408 return switch (verificationCode
) {
1409 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1410 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1411 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1412 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1413 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1414 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1415 case null -> throw new AssertionError("Invalid verification code type");
1420 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1421 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1424 private boolean trustIdentity(
1425 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1426 ) throws UnregisteredRecipientException
{
1427 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1428 final var updated
= trustMethod
.apply(recipientId
);
1429 if (updated
&& this.isReceiving()) {
1430 account
.setNeedsToRetryFailedMessages(true);
1436 public void addAddressChangedListener(final Runnable listener
) {
1437 synchronized (addressChangedListeners
) {
1438 addressChangedListeners
.add(listener
);
1443 public void addClosedListener(final Runnable listener
) {
1444 synchronized (closedListeners
) {
1445 closedListeners
.add(listener
);
1450 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1451 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1455 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1456 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1457 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1458 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1459 if (streamDetails
== null) {
1460 throw new FileNotFoundException();
1462 return streamDetails
.getStream();
1466 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1467 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1468 context
.getProfileHelper().getRecipientProfile(recipientId
);
1469 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1470 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1471 if (streamDetails
== null) {
1472 throw new FileNotFoundException();
1474 return streamDetails
.getStream();
1478 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1479 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1480 context
.getGroupHelper().getGroup(groupId
);
1481 if (streamDetails
== null) {
1482 throw new FileNotFoundException();
1484 return streamDetails
.getStream();
1488 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1489 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1490 if (streamDetails
== null) {
1491 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1494 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1495 } catch (InvalidMessageException e
) {
1496 logger
.warn("Failed to download sticker pack");
1500 if (streamDetails
== null) {
1501 throw new FileNotFoundException();
1503 return streamDetails
.getStream();
1507 public void close() {
1509 synchronized (messageHandlers
) {
1510 weakHandlers
.clear();
1511 messageHandlers
.clear();
1512 thread
= receiveThread
;
1513 receiveThread
= null;
1515 if (thread
!= null) {
1516 stopReceiveThread(thread
);
1521 dependencies
.getSignalWebSocket().disconnect();
1522 dependencies
.getPushServiceSocket().close();
1523 disposable
.dispose();
1525 if (account
!= null) {
1529 synchronized (closedListeners
) {
1530 closedListeners
.forEach(Runnable
::run
);
1531 closedListeners
.clear();