2 Copyright (C) 2015-2022 AsamK and contributors
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org
.asamk
.signal
.manager
.internal
;
19 import org
.asamk
.signal
.manager
.Manager
;
20 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
21 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
22 import org
.asamk
.signal
.manager
.api
.CaptchaRejectedException
;
23 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
24 import org
.asamk
.signal
.manager
.api
.Configuration
;
25 import org
.asamk
.signal
.manager
.api
.Device
;
26 import org
.asamk
.signal
.manager
.api
.DeviceLimitExceededException
;
27 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
28 import org
.asamk
.signal
.manager
.api
.Group
;
29 import org
.asamk
.signal
.manager
.api
.GroupId
;
30 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
31 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
32 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
33 import org
.asamk
.signal
.manager
.api
.Identity
;
34 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
35 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
36 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
39 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
40 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
41 import org
.asamk
.signal
.manager
.api
.Message
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
43 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
44 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
45 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
46 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
47 import org
.asamk
.signal
.manager
.api
.Pair
;
48 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
49 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
50 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
51 import org
.asamk
.signal
.manager
.api
.Profile
;
52 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
53 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
54 import org
.asamk
.signal
.manager
.api
.Recipient
;
55 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
56 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
58 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
61 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
62 import org
.asamk
.signal
.manager
.api
.TextStyle
;
63 import org
.asamk
.signal
.manager
.api
.TypingAction
;
64 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
65 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
66 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
67 import org
.asamk
.signal
.manager
.api
.UserStatus
;
68 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
69 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
70 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
71 import org
.asamk
.signal
.manager
.config
.ServiceConfig
;
72 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
73 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
74 import org
.asamk
.signal
.manager
.helper
.Context
;
75 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
76 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
77 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
78 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
79 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
80 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
81 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
82 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
83 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
84 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
85 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
86 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
87 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
88 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
89 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
90 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
91 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
92 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
93 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
94 import org
.slf4j
.Logger
;
95 import org
.slf4j
.LoggerFactory
;
96 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
101 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
103 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
104 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
105 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
106 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
107 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
108 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
109 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
110 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
111 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
112 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
113 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
114 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
116 import java
.io
.ByteArrayInputStream
;
118 import java
.io
.FileNotFoundException
;
119 import java
.io
.IOException
;
120 import java
.io
.InputStream
;
121 import java
.nio
.charset
.StandardCharsets
;
122 import java
.time
.Duration
;
123 import java
.util
.ArrayList
;
124 import java
.util
.Collection
;
125 import java
.util
.HashMap
;
126 import java
.util
.HashSet
;
127 import java
.util
.List
;
128 import java
.util
.Map
;
129 import java
.util
.Objects
;
130 import java
.util
.Optional
;
131 import java
.util
.Set
;
132 import java
.util
.concurrent
.ExecutorService
;
133 import java
.util
.concurrent
.Executors
;
134 import java
.util
.concurrent
.TimeUnit
;
135 import java
.util
.concurrent
.atomic
.AtomicInteger
;
136 import java
.util
.concurrent
.locks
.ReentrantLock
;
137 import java
.util
.function
.Function
;
138 import java
.util
.stream
.Collectors
;
139 import java
.util
.stream
.Stream
;
141 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
142 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
144 public class ManagerImpl
implements Manager
{
146 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
148 private SignalAccount account
;
149 private final SignalDependencies dependencies
;
150 private final Context context
;
152 private final ExecutorService executor
= Executors
.newCachedThreadPool();
154 private Thread receiveThread
;
155 private boolean isReceivingSynchronous
;
156 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
157 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
158 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
159 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
160 private final CompositeDisposable disposable
= new CompositeDisposable();
163 SignalAccount account
,
164 PathConfig pathConfig
,
165 AccountFileUpdater accountFileUpdater
,
166 ServiceEnvironmentConfig serviceEnvironmentConfig
,
169 this.account
= account
;
171 final var sessionLock
= new SignalSessionLock() {
172 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
175 public Lock
acquire() {
177 return LEGACY_LOCK
::unlock
;
180 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
182 account
.getCredentialsProvider(),
183 account
.getSignalServiceDataStore(),
186 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
187 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
188 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
190 this.context
= new Context(account
, new AccountFileUpdater() {
192 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
193 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
194 synchronized (addressChangedListeners
) {
195 addressChangedListeners
.forEach(Runnable
::run
);
200 public void removeAccount() {
201 accountFileUpdater
.removeAccount();
203 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
204 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
205 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
206 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
207 synchronized (this) {
211 disposable
.add(account
.getIdentityKeyStore()
212 .getIdentityChanges()
213 .observeOn(Schedulers
.from(executor
))
214 .subscribe(serviceId
-> {
215 logger
.trace("Archiving old sessions for {}", serviceId
);
216 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
217 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
218 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
219 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
220 final var profile
= account
.getProfileStore().getProfile(recipientId
);
221 if (profile
!= null) {
222 account
.getProfileStore()
223 .storeProfile(recipientId
,
224 Profile
.newBuilder(profile
)
225 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
226 .withLastUpdateTimestamp(0)
233 public String
getSelfNumber() {
234 return account
.getNumber();
237 public void checkAccountState() throws IOException
{
238 context
.getAccountHelper().checkAccountState();
239 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
240 if (lastRecipientsRefresh
== null
241 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
242 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
243 context
.getAccountHelper().checkWhoAmiI();
248 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
249 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
251 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
252 if (!canonicalizedNumber
.equals(n
)) {
253 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
255 return canonicalizedNumber
;
256 } catch (InvalidNumberException e
) {
261 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
262 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
264 .filter(s
-> !s
.isEmpty())
265 .collect(Collectors
.toSet());
267 final Map
<String
, RegisteredUser
> registeredUsers
;
269 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
270 } catch (CdsiResourceExhaustedException e
) {
271 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
272 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
275 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
276 final var number
= canonicalizedNumbers
.get(n
);
277 final var user
= registeredUsers
.get(number
);
278 final var serviceId
= user
== null ?
null : user
.getServiceId();
279 final var profile
= serviceId
== null
281 : context
.getProfileHelper()
282 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
283 return new UserStatus(number
.isEmpty() ?
null : number
,
284 serviceId
== null ?
null : serviceId
.getRawUuid(),
286 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
291 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
292 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
293 for (final var username
: usernames
) {
295 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
296 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
297 registeredUsers
.put(username
, address
);
298 } catch (UnregisteredRecipientException e
) {
303 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
304 final var user
= registeredUsers
.get(username
);
305 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
306 final var profile
= serviceId
== null
308 : context
.getProfileHelper()
309 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
310 return new UsernameStatus(username
,
311 serviceId
== null ?
null : serviceId
.getRawUuid(),
313 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
318 public void updateAccountAttributes(
320 Boolean unrestrictedUnidentifiedSender
,
321 final Boolean discoverableByNumber
,
322 final Boolean numberSharing
323 ) throws IOException
{
324 if (deviceName
!= null) {
325 context
.getAccountHelper().setDeviceName(deviceName
);
327 if (unrestrictedUnidentifiedSender
!= null) {
328 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
330 if (discoverableByNumber
!= null) {
331 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
333 if (numberSharing
!= null) {
334 account
.getConfigurationStore()
335 .setPhoneNumberSharingMode(numberSharing
336 ? PhoneNumberSharingMode
.EVERYBODY
337 : PhoneNumberSharingMode
.NOBODY
);
339 context
.getAccountHelper().updateAccountAttributes();
340 context
.getAccountHelper().checkWhoAmiI();
344 public Configuration
getConfiguration() {
345 final var configurationStore
= account
.getConfigurationStore();
346 return Configuration
.from(configurationStore
);
350 public void updateConfiguration(Configuration configuration
) {
351 final var configurationStore
= account
.getConfigurationStore();
352 if (configuration
.readReceipts().isPresent()) {
353 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
355 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
356 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
358 if (configuration
.typingIndicators().isPresent()) {
359 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
361 if (configuration
.linkPreviews().isPresent()) {
362 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
364 context
.getSyncHelper().sendConfigurationMessage();
369 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
370 context
.getProfileHelper()
371 .setProfile(updateProfile
.getGivenName(),
372 updateProfile
.getFamilyName(),
373 updateProfile
.getAbout(),
374 updateProfile
.getAboutEmoji(),
375 updateProfile
.isDeleteAvatar()
377 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
378 updateProfile
.getMobileCoinAddress());
379 context
.getSyncHelper().sendSyncFetchProfileMessage();
382 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
383 context
.getAccountHelper().refreshCurrentUsername();
387 public String
getUsername() {
388 return account
.getUsername();
392 public UsernameLinkUrl
getUsernameLink() {
393 return new UsernameLinkUrl(account
.getUsernameLink());
397 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
399 if (username
.contains(".")) {
400 context
.getAccountHelper().reserveExactUsername(username
);
402 context
.getAccountHelper().reserveUsernameFromNickname(username
);
404 } catch (UsernameMalformedException e
) {
405 throw new InvalidUsernameException("Username is malformed", e
);
406 } catch (UsernameTakenException e
) {
407 throw new InvalidUsernameException("Username is already registered", e
);
408 } catch (BaseUsernameException e
) {
409 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
414 public void deleteUsername() throws IOException
{
415 context
.getAccountHelper().deleteUsername();
419 public void startChangeNumber(
420 String newNumber
, boolean voiceVerification
, String captcha
421 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
422 if (!account
.isPrimaryDevice()) {
423 throw new NotPrimaryDeviceException();
425 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
429 public void finishChangeNumber(
430 String newNumber
, String verificationCode
, String pin
431 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
432 if (!account
.isPrimaryDevice()) {
433 throw new NotPrimaryDeviceException();
435 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
439 public void unregister() throws IOException
{
440 context
.getAccountHelper().unregister();
444 public void deleteAccount() throws IOException
{
445 context
.getAccountHelper().deleteAccount();
449 public void submitRateLimitRecaptchaChallenge(
450 String challenge
, String captcha
451 ) throws IOException
, CaptchaRejectedException
{
452 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
455 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
456 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
457 throw new CaptchaRejectedException();
462 public List
<Device
> getLinkedDevices() throws IOException
{
463 var devices
= dependencies
.getAccountManager().getDevices();
464 account
.setMultiDevice(devices
.size() > 1);
465 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
466 return devices
.stream().map(d
-> {
467 String deviceName
= d
.getName();
468 if (deviceName
!= null) {
470 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
471 } catch (IOException e
) {
472 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
475 return new Device(d
.getId(),
479 d
.getId() == account
.getDeviceId());
484 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
485 if (!account
.isPrimaryDevice()) {
486 throw new NotPrimaryDeviceException();
488 context
.getAccountHelper().removeLinkedDevices(deviceId
);
492 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
, DeviceLimitExceededException
{
493 if (!account
.isPrimaryDevice()) {
494 throw new NotPrimaryDeviceException();
496 context
.getAccountHelper().addDevice(linkUrl
);
500 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
501 if (!account
.isPrimaryDevice()) {
502 throw new NotPrimaryDeviceException();
504 if (pin
.isPresent()) {
505 context
.getAccountHelper().setRegistrationPin(pin
.get());
507 context
.getAccountHelper().removeRegistrationPin();
511 void refreshPreKeys() throws IOException
{
512 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
516 public List
<Group
> getGroups() {
517 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
520 private Group
toGroup(final GroupInfo groupInfo
) {
521 if (groupInfo
== null) {
525 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
529 public SendGroupMessageResults
quitGroup(
530 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
531 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
532 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
533 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
537 public void deleteGroup(GroupId groupId
) throws IOException
{
538 final var group
= context
.getGroupHelper().getGroup(groupId
);
539 if (group
.isMember(account
.getSelfRecipientId())) {
540 throw new IOException(
541 "The local group information cannot be removed, as the user is still a member of the group");
543 context
.getGroupHelper().deleteGroup(groupId
);
547 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
548 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
549 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
550 return context
.getGroupHelper()
552 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
557 public SendGroupMessageResults
updateGroup(
558 final GroupId groupId
, final UpdateGroup updateGroup
559 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
560 return context
.getGroupHelper()
561 .updateGroup(groupId
,
562 updateGroup
.getName(),
563 updateGroup
.getDescription(),
564 updateGroup
.getMembers() == null
566 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
567 updateGroup
.getRemoveMembers() == null
569 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
570 updateGroup
.getAdmins() == null
572 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
573 updateGroup
.getRemoveAdmins() == null
575 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
576 updateGroup
.getBanMembers() == null
578 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
579 updateGroup
.getUnbanMembers() == null
581 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
582 updateGroup
.isResetGroupLink(),
583 updateGroup
.getGroupLinkState(),
584 updateGroup
.getAddMemberPermission(),
585 updateGroup
.getEditDetailsPermission(),
586 updateGroup
.getAvatarFile(),
587 updateGroup
.getExpirationTimer(),
588 updateGroup
.getIsAnnouncementGroup());
592 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
593 GroupInviteLinkUrl inviteLinkUrl
594 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
595 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
598 private SendMessageResults
sendMessage(
599 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
600 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
601 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
604 private SendMessageResults
sendMessage(
605 SignalServiceDataMessage
.Builder messageBuilder
,
606 Set
<RecipientIdentifier
> recipients
,
608 Optional
<Long
> editTargetTimestamp
609 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
610 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
611 long timestamp
= System
.currentTimeMillis();
612 messageBuilder
.withTimestamp(timestamp
);
613 for (final var recipient
: recipients
) {
614 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
615 recipient
instanceof RecipientIdentifier
.Single single
616 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
618 final var result
= notifySelf
619 ? context
.getSendHelper()
620 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
621 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
622 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
623 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
625 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
626 final var result
= context
.getSendHelper()
627 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
628 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
629 } catch (UnregisteredRecipientException e
) {
630 results
.put(recipient
,
631 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
633 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
634 final var result
= context
.getSendHelper()
635 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
636 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
639 return new SendMessageResults(timestamp
, results
);
642 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
643 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
646 private SendMessageResults
sendTypingMessage(
647 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
648 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
649 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
650 final var timestamp
= System
.currentTimeMillis();
651 for (var recipient
: recipients
) {
652 if (recipient
instanceof RecipientIdentifier
.Single single
) {
653 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
655 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
656 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
657 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
658 } catch (UnregisteredRecipientException e
) {
659 results
.put(recipient
,
660 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
662 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
663 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
664 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
665 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
666 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
669 return new SendMessageResults(timestamp
, results
);
673 public SendMessageResults
sendTypingMessage(
674 TypingAction action
, Set
<RecipientIdentifier
> recipients
675 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
676 return sendTypingMessage(action
.toSignalService(), recipients
);
680 public SendMessageResults
sendReadReceipt(
681 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
683 final var timestamp
= System
.currentTimeMillis();
684 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
688 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
692 public SendMessageResults
sendViewedReceipt(
693 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
695 final var timestamp
= System
.currentTimeMillis();
696 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
700 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
703 private SendMessageResults
sendReceiptMessage(
704 final RecipientIdentifier
.Single sender
,
705 final long timestamp
,
706 final SignalServiceReceiptMessage receiptMessage
709 final var recipientId
= context
.getRecipientHelper().resolveRecipient(sender
);
710 final var result
= context
.getSendHelper().sendReceiptMessage(receiptMessage
, recipientId
);
712 final var serviceId
= account
.getRecipientAddressResolver()
713 .resolveRecipientAddress(recipientId
)
715 if (serviceId
.isPresent()) {
716 context
.getSyncHelper().sendSyncReceiptMessage(serviceId
.get(), receiptMessage
);
718 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
719 } catch (UnregisteredRecipientException e
) {
720 return new SendMessageResults(timestamp
,
721 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
726 public SendMessageResults
sendMessage(
727 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
728 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
729 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
730 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
732 "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.");
734 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
735 applyMessage(messageBuilder
, message
);
736 return sendMessage(messageBuilder
, recipients
, notifySelf
);
740 public SendMessageResults
sendEditMessage(
741 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
742 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
743 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
744 applyMessage(messageBuilder
, message
);
745 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
748 private void applyMessage(
749 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
750 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
751 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
752 if (message
.messageText().length() > ServiceConfig
.MAX_MESSAGE_BODY_SIZE
) {
753 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
754 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
755 final var streamDetails
= new StreamDetails(new ByteArrayInputStream(messageBytes
),
757 messageBytes
.length
);
758 final var textAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
761 messageBuilder
.withBody(message
.messageText().substring(0, ServiceConfig
.MAX_MESSAGE_BODY_SIZE
));
762 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
764 messageBuilder
.withBody(message
.messageText());
766 if (!message
.attachments().isEmpty()) {
767 final var uploadedAttachments
= context
.getAttachmentHelper().uploadAttachments(message
.attachments());
768 if (!additionalAttachments
.isEmpty()) {
769 additionalAttachments
.addAll(uploadedAttachments
);
770 messageBuilder
.withAttachments(additionalAttachments
);
772 messageBuilder
.withAttachments(uploadedAttachments
);
775 if (!message
.mentions().isEmpty()) {
776 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
778 if (!message
.textStyles().isEmpty()) {
779 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
781 if (message
.quote().isPresent()) {
782 final var quote
= message
.quote().get();
783 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
784 for (final var a
: quote
.attachments()) {
785 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
787 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
788 quotedAttachments
.add(quotedAttachment
);
790 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
791 context
.getRecipientHelper()
792 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
796 resolveMentions(quote
.mentions()),
797 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
798 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
800 if (message
.sticker().isPresent()) {
801 final var sticker
= message
.sticker().get();
802 final var packId
= StickerPackId
.deserialize(sticker
.packId());
803 final var stickerId
= sticker
.stickerId();
805 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
806 if (stickerPack
== null) {
807 throw new InvalidStickerException("Sticker pack not found");
809 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
810 if (manifest
.stickers().size() <= stickerId
) {
811 throw new InvalidStickerException("Sticker id not part of this pack");
813 final var manifestSticker
= manifest
.stickers().get(stickerId
);
814 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
815 if (streamDetails
== null) {
816 throw new InvalidStickerException("Missing local sticker file");
818 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
819 final var stickerAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
822 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
823 stickerPack
.packKey(),
825 manifestSticker
.emoji(),
828 if (!message
.previews().isEmpty()) {
829 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
830 for (final var p
: message
.previews()) {
831 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
832 .uploadAttachment(p
.image().get()) : null;
833 previews
.add(new SignalServicePreview(p
.url(),
837 Optional
.ofNullable(image
)));
839 messageBuilder
.withPreviews(previews
);
841 if (message
.storyReply().isPresent()) {
842 final var storyReply
= message
.storyReply().get();
843 final var authorServiceId
= context
.getRecipientHelper()
844 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
846 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
847 storyReply
.timestamp()));
851 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
852 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
853 for (final var m
: mentionList
) {
854 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
855 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
856 .resolveSignalServiceAddress(recipientId
)
857 .getServiceId(), m
.start(), m
.length()));
863 public SendMessageResults
sendRemoteDeleteMessage(
864 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
865 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
866 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
867 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
868 for (final var recipient
: recipients
) {
869 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
870 account
.getMessageSendLogStore()
871 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
872 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
873 account
.getMessageSendLogStore()
874 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.parseOrThrow(pni
.pni()));
875 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
877 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
878 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
879 if (address
.serviceId().isPresent()) {
880 account
.getMessageSendLogStore()
881 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
883 } catch (UnregisteredRecipientException ignored
) {
885 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
886 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
889 return sendMessage(messageBuilder
, recipients
, false);
893 public SendMessageResults
sendMessageReaction(
896 RecipientIdentifier
.Single targetAuthor
,
897 long targetSentTimestamp
,
898 Set
<RecipientIdentifier
> recipients
,
899 final boolean isStory
900 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
901 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
902 final var authorServiceId
= context
.getRecipientHelper()
903 .resolveSignalServiceAddress(targetAuthorRecipientId
)
905 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
906 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
908 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
909 targetSentTimestamp
));
911 return sendMessage(messageBuilder
, recipients
, false);
915 public SendMessageResults
sendPaymentNotificationMessage(
916 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
917 ) throws IOException
{
918 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
919 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
920 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
922 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
923 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
924 throw new AssertionError(e
);
929 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
930 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
933 return sendMessage(messageBuilder
,
934 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
936 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
937 throw new AssertionError(e
);
939 for (var recipient
: recipients
) {
940 final RecipientId recipientId
;
942 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
943 } catch (UnregisteredRecipientException e
) {
946 final var serviceId
= context
.getAccount()
947 .getRecipientAddressResolver()
948 .resolveRecipientAddress(recipientId
)
950 if (serviceId
.isPresent()) {
951 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
958 public SendMessageResults
sendMessageRequestResponse(
959 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
961 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
962 for (final var recipient
: recipients
) {
963 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
964 recipient
instanceof RecipientIdentifier
.Single single
965 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
967 final var result
= context
.getSyncHelper()
968 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
969 if (result
!= null) {
970 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
972 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
973 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
975 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
976 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
977 if (result
!= null) {
978 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
980 } catch (UnregisteredRecipientException e
) {
981 results
.put(recipient
,
982 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
984 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
985 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
986 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
989 return new SendMessageResults(0, results
);
993 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
994 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
995 if (recipientIdOptional
.isPresent()) {
996 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
997 account
.removeRecipient(recipientIdOptional
.get());
1003 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
1004 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1005 if (recipientIdOptional
.isPresent()) {
1006 account
.removeRecipient(recipientIdOptional
.get());
1007 syncRemoteStorage();
1012 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
1013 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1014 if (recipientIdOptional
.isPresent()) {
1015 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1016 syncRemoteStorage();
1021 public void setContactName(
1022 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
1023 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1024 if (!account
.isPrimaryDevice()) {
1025 throw new NotPrimaryDeviceException();
1027 context
.getContactHelper()
1028 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
1029 syncRemoteStorage();
1033 public void setContactsBlocked(
1034 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
1035 ) throws IOException
, UnregisteredRecipientException
{
1036 if (recipients
.isEmpty()) {
1039 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1040 final var selfRecipientId
= account
.getSelfRecipientId();
1041 boolean shouldRotateProfileKey
= false;
1042 for (final var recipientId
: recipientIds
) {
1043 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1046 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1047 context
.getSyncHelper()
1048 .sendMessageRequestResponse(blocked
1049 ? MessageRequestResponse
.Type
.BLOCK
1050 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1051 // if we don't have a common group with the blocked contact we need to rotate the profile key
1052 shouldRotateProfileKey
= blocked
&& (
1053 shouldRotateProfileKey
|| account
.getGroupStore()
1056 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1059 if (shouldRotateProfileKey
) {
1060 context
.getProfileHelper().rotateProfileKey();
1062 context
.getSyncHelper().sendBlockedList();
1063 syncRemoteStorage();
1067 public void setGroupsBlocked(
1068 final Collection
<GroupId
> groupIds
, final boolean blocked
1069 ) throws GroupNotFoundException
, IOException
{
1070 if (groupIds
.isEmpty()) {
1073 boolean shouldRotateProfileKey
= false;
1074 for (final var groupId
: groupIds
) {
1075 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1078 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1079 context
.getSyncHelper()
1080 .sendMessageRequestResponse(blocked
1081 ? MessageRequestResponse
.Type
.BLOCK
1082 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1083 shouldRotateProfileKey
= blocked
;
1085 if (shouldRotateProfileKey
) {
1086 context
.getProfileHelper().rotateProfileKey();
1088 context
.getSyncHelper().sendBlockedList();
1089 syncRemoteStorage();
1093 public void setExpirationTimer(
1094 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1095 ) throws IOException
, UnregisteredRecipientException
{
1096 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1097 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1098 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1100 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1101 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1102 throw new AssertionError(e
);
1104 syncRemoteStorage();
1108 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1109 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1111 var messageSender
= dependencies
.getMessageSender();
1113 var packKey
= KeyUtils
.createStickerUploadKey();
1114 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1115 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1117 var sticker
= new StickerPack(packId
, packKey
);
1118 account
.getStickerStore().addStickerPack(sticker
);
1119 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1121 return new StickerPackUrl(packId
, packKey
);
1125 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1126 final var packId
= url
.packId();
1127 final var packKey
= url
.packKey();
1129 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1130 } catch (InvalidMessageException e
) {
1131 throw new IOException(e
);
1134 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1135 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1139 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1140 final var stickerPackStore
= context
.getStickerPackStore();
1141 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1142 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1144 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1145 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1146 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1150 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1151 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1152 } catch (Exception e
) {
1153 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1157 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1162 public void requestAllSyncData() {
1163 context
.getSyncHelper().requestAllSyncData();
1164 syncRemoteStorage();
1167 void syncRemoteStorage() {
1168 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1172 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1173 synchronized (messageHandlers
) {
1174 if (isWeakListener
) {
1175 weakHandlers
.add(handler
);
1177 messageHandlers
.add(handler
);
1178 startReceiveThreadIfRequired();
1183 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1185 private void startReceiveThreadIfRequired() {
1186 if (receiveThread
!= null || isReceivingSynchronous
) {
1189 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1190 logger
.debug("Starting receiving messages");
1191 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1192 logger
.debug("Finished receiving messages");
1193 synchronized (messageHandlers
) {
1194 receiveThread
= null;
1196 // Check if in the meantime another handler has been registered
1197 if (!messageHandlers
.isEmpty()) {
1198 logger
.debug("Another handler has been registered, starting receive thread again");
1199 startReceiveThreadIfRequired();
1205 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1206 synchronized (messageHandlers
) {
1207 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1209 h
.handleMessage(envelope
, e
);
1210 } catch (Throwable ex
) {
1211 logger
.warn("Message handler failed, ignoring", ex
);
1218 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1219 final Thread thread
;
1220 synchronized (messageHandlers
) {
1221 weakHandlers
.remove(handler
);
1222 messageHandlers
.remove(handler
);
1223 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1226 thread
= receiveThread
;
1227 receiveThread
= null;
1230 stopReceiveThread(thread
);
1233 private void stopReceiveThread(final Thread thread
) {
1234 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1235 logger
.debug("Receive stop requested, interrupting read from server.");
1240 } catch (InterruptedException ignored
) {
1245 public boolean isReceiving() {
1246 if (isReceivingSynchronous
) {
1249 synchronized (messageHandlers
) {
1250 return !messageHandlers
.isEmpty();
1255 public void receiveMessages(
1256 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1257 ) throws IOException
, AlreadyReceivingException
{
1258 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1262 public void stopReceiveMessages() {
1263 Thread thread
= null;
1264 synchronized (messageHandlers
) {
1265 if (isReceivingSynchronous
) {
1266 thread
= receiveThread
;
1267 receiveThread
= null;
1270 if (thread
!= null) {
1271 stopReceiveThread(thread
);
1275 private void receiveMessages(
1276 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1277 ) throws IOException
, AlreadyReceivingException
{
1278 synchronized (messageHandlers
) {
1279 if (isReceiving()) {
1280 throw new AlreadyReceivingException("Already receiving message.");
1282 isReceivingSynchronous
= true;
1283 receiveThread
= Thread
.currentThread();
1286 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1287 passReceivedMessageToHandlers(envelope
, e
);
1288 handler
.handleMessage(envelope
, e
);
1291 synchronized (messageHandlers
) {
1292 receiveThread
= null;
1293 isReceivingSynchronous
= false;
1294 if (!messageHandlers
.isEmpty()) {
1295 startReceiveThreadIfRequired();
1302 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1303 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1307 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1308 final RecipientId recipientId
;
1310 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1311 } catch (UnregisteredRecipientException e
) {
1314 return context
.getContactHelper().isContactBlocked(recipientId
);
1318 public void sendContacts() throws IOException
{
1319 context
.getSyncHelper().sendContacts();
1323 public List
<Recipient
> getRecipients(
1324 boolean onlyContacts
,
1325 Optional
<Boolean
> blocked
,
1326 Collection
<RecipientIdentifier
.Single
> recipients
,
1327 Optional
<String
> name
1329 final var recipientIds
= recipients
.stream().map(a
-> {
1331 return context
.getRecipientHelper().resolveRecipient(a
);
1332 } catch (UnregisteredRecipientException e
) {
1335 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1336 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1339 // refresh profiles of explicitly given recipients
1340 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1341 return account
.getRecipientStore()
1342 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1344 .map(s
-> new Recipient(s
.getRecipientId(),
1345 s
.getAddress().toApiRecipientAddress(),
1348 s
.getExpiringProfileKeyCredential(),
1350 s
.getDiscoverable()))
1355 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1356 final RecipientId recipientId
;
1358 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1359 } catch (UnregisteredRecipientException e
) {
1363 final var contact
= account
.getContactStore().getContact(recipientId
);
1364 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1365 return contact
.getName();
1368 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1369 if (profile
!= null) {
1370 return profile
.getDisplayName();
1377 public Group
getGroup(GroupId groupId
) {
1378 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1382 public List
<Identity
> getIdentities() {
1383 return account
.getIdentityKeyStore()
1386 .map(this::toIdentity
)
1387 .filter(Objects
::nonNull
)
1391 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1392 if (identityInfo
== null) {
1396 final var address
= account
.getRecipientAddressResolver()
1397 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1398 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1399 identityInfo
.getServiceId())) {
1402 final var scannableFingerprint
= context
.getIdentityHelper()
1403 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1404 return new Identity(address
.toApiRecipientAddress(),
1405 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1406 context
.getIdentityHelper()
1407 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1408 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1409 identityInfo
.getTrustLevel(),
1410 identityInfo
.getDateAddedTimestamp());
1414 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1415 ServiceId serviceId
;
1417 final var address
= account
.getRecipientAddressResolver()
1418 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1419 if (address
.serviceId().isEmpty()) {
1422 serviceId
= address
.serviceId().get();
1423 } catch (UnregisteredRecipientException e
) {
1426 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1427 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1431 public boolean trustIdentityVerified(
1432 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1433 ) throws UnregisteredRecipientException
{
1434 return switch (verificationCode
) {
1435 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1436 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1437 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1438 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1439 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1440 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1441 case null -> throw new AssertionError("Invalid verification code type");
1446 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1447 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1450 private boolean trustIdentity(
1451 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1452 ) throws UnregisteredRecipientException
{
1453 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1454 final var updated
= trustMethod
.apply(recipientId
);
1455 if (updated
&& this.isReceiving()) {
1456 account
.setNeedsToRetryFailedMessages(true);
1462 public void addAddressChangedListener(final Runnable listener
) {
1463 synchronized (addressChangedListeners
) {
1464 addressChangedListeners
.add(listener
);
1469 public void addClosedListener(final Runnable listener
) {
1470 synchronized (closedListeners
) {
1471 closedListeners
.add(listener
);
1476 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1477 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1481 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1482 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1483 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1484 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1485 if (streamDetails
== null) {
1486 throw new FileNotFoundException();
1488 return streamDetails
.getStream();
1492 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1493 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1494 context
.getProfileHelper().getRecipientProfile(recipientId
);
1495 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1496 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1497 if (streamDetails
== null) {
1498 throw new FileNotFoundException();
1500 return streamDetails
.getStream();
1504 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1505 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1506 context
.getGroupHelper().getGroup(groupId
);
1507 if (streamDetails
== null) {
1508 throw new FileNotFoundException();
1510 return streamDetails
.getStream();
1514 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1515 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1516 if (streamDetails
== null) {
1517 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1520 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1521 } catch (InvalidMessageException e
) {
1522 logger
.warn("Failed to download sticker pack");
1526 if (streamDetails
== null) {
1527 throw new FileNotFoundException();
1529 return streamDetails
.getStream();
1533 public void close() {
1535 synchronized (messageHandlers
) {
1536 weakHandlers
.clear();
1537 messageHandlers
.clear();
1538 thread
= receiveThread
;
1539 receiveThread
= null;
1541 if (thread
!= null) {
1542 stopReceiveThread(thread
);
1547 dependencies
.getSignalWebSocket().disconnect();
1548 dependencies
.getPushServiceSocket().close();
1549 disposable
.dispose();
1551 if (account
!= null) {
1555 synchronized (closedListeners
) {
1556 closedListeners
.forEach(Runnable
::run
);
1557 closedListeners
.clear();