2 Copyright (C) 2015-2022 AsamK and contributors
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org
.asamk
.signal
.manager
.internal
;
19 import org
.asamk
.signal
.manager
.Manager
;
20 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
21 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
22 import org
.asamk
.signal
.manager
.api
.CaptchaRejectedException
;
23 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
24 import org
.asamk
.signal
.manager
.api
.Configuration
;
25 import org
.asamk
.signal
.manager
.api
.Device
;
26 import org
.asamk
.signal
.manager
.api
.DeviceLimitExceededException
;
27 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
28 import org
.asamk
.signal
.manager
.api
.Group
;
29 import org
.asamk
.signal
.manager
.api
.GroupId
;
30 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
31 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
32 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
33 import org
.asamk
.signal
.manager
.api
.Identity
;
34 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
35 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
36 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
39 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
40 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
41 import org
.asamk
.signal
.manager
.api
.Message
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
43 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
44 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
45 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
46 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
47 import org
.asamk
.signal
.manager
.api
.Pair
;
48 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
49 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
50 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
51 import org
.asamk
.signal
.manager
.api
.Profile
;
52 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
53 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
54 import org
.asamk
.signal
.manager
.api
.Recipient
;
55 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
56 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
58 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
61 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
62 import org
.asamk
.signal
.manager
.api
.TextStyle
;
63 import org
.asamk
.signal
.manager
.api
.TypingAction
;
64 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
65 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
66 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
67 import org
.asamk
.signal
.manager
.api
.UserStatus
;
68 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
69 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
70 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
71 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
72 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
73 import org
.asamk
.signal
.manager
.helper
.Context
;
74 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
75 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
76 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
77 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
78 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
79 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
80 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
81 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
82 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
83 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
84 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
85 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
86 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
87 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
88 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
89 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
90 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
91 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
92 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
93 import org
.slf4j
.Logger
;
94 import org
.slf4j
.LoggerFactory
;
95 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
101 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
102 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
103 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
104 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
105 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
106 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameMalformedException
;
107 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UsernameTakenException
;
108 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
109 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
110 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
111 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
112 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
113 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
115 import java
.io
.ByteArrayInputStream
;
117 import java
.io
.FileNotFoundException
;
118 import java
.io
.IOException
;
119 import java
.io
.InputStream
;
120 import java
.nio
.charset
.StandardCharsets
;
121 import java
.time
.Duration
;
122 import java
.util
.ArrayList
;
123 import java
.util
.Collection
;
124 import java
.util
.HashMap
;
125 import java
.util
.HashSet
;
126 import java
.util
.List
;
127 import java
.util
.Map
;
128 import java
.util
.Objects
;
129 import java
.util
.Optional
;
130 import java
.util
.Set
;
131 import java
.util
.concurrent
.ExecutorService
;
132 import java
.util
.concurrent
.Executors
;
133 import java
.util
.concurrent
.TimeUnit
;
134 import java
.util
.concurrent
.atomic
.AtomicInteger
;
135 import java
.util
.concurrent
.locks
.ReentrantLock
;
136 import java
.util
.function
.Function
;
137 import java
.util
.stream
.Collectors
;
138 import java
.util
.stream
.Stream
;
140 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
141 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
144 import static org
.asamk
.signal
.manager
.config
.ServiceConfig
.MAX_MESSAGE_SIZE_BYTES
;
145 import static org
.signal
.core
.util
.StringExtensionsKt
.splitByByteLength
;
147 public class ManagerImpl
implements Manager
{
149 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
151 private SignalAccount account
;
152 private final SignalDependencies dependencies
;
153 private final Context context
;
155 private final ExecutorService executor
= Executors
.newCachedThreadPool();
157 private Thread receiveThread
;
158 private boolean isReceivingSynchronous
;
159 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
160 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
161 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
162 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
163 private final CompositeDisposable disposable
= new CompositeDisposable();
166 SignalAccount account
,
167 PathConfig pathConfig
,
168 AccountFileUpdater accountFileUpdater
,
169 ServiceEnvironmentConfig serviceEnvironmentConfig
,
172 this.account
= account
;
174 final var sessionLock
= new SignalSessionLock() {
175 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
178 public Lock
acquire() {
180 return LEGACY_LOCK
::unlock
;
183 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
185 account
.getCredentialsProvider(),
186 account
.getSignalServiceDataStore(),
189 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
190 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
191 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
193 this.context
= new Context(account
, new AccountFileUpdater() {
195 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
196 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
197 synchronized (addressChangedListeners
) {
198 addressChangedListeners
.forEach(Runnable
::run
);
203 public void removeAccount() {
204 accountFileUpdater
.removeAccount();
206 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
207 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
208 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
209 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
210 synchronized (this) {
214 disposable
.add(account
.getIdentityKeyStore()
215 .getIdentityChanges()
216 .observeOn(Schedulers
.from(executor
))
217 .subscribe(serviceId
-> {
218 logger
.trace("Archiving old sessions for {}", serviceId
);
219 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
220 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
221 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
222 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
223 final var profile
= account
.getProfileStore().getProfile(recipientId
);
224 if (profile
!= null) {
225 account
.getProfileStore()
226 .storeProfile(recipientId
,
227 Profile
.newBuilder(profile
)
228 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
229 .withLastUpdateTimestamp(0)
236 public String
getSelfNumber() {
237 return account
.getNumber();
240 public void checkAccountState() throws IOException
{
241 context
.getAccountHelper().checkAccountState();
242 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
243 if (lastRecipientsRefresh
== null
244 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
245 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
246 context
.getAccountHelper().checkWhoAmiI();
251 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
252 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
254 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
255 if (!canonicalizedNumber
.equals(n
)) {
256 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
258 return canonicalizedNumber
;
259 } catch (InvalidNumberException e
) {
264 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
265 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
267 .filter(s
-> !s
.isEmpty())
268 .collect(Collectors
.toSet());
270 final Map
<String
, RegisteredUser
> registeredUsers
;
272 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
273 } catch (CdsiResourceExhaustedException e
) {
274 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
275 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
278 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
279 final var number
= canonicalizedNumbers
.get(n
);
280 final var user
= registeredUsers
.get(number
);
281 final var serviceId
= user
== null ?
null : user
.getServiceId();
282 final var profile
= serviceId
== null
284 : context
.getProfileHelper()
285 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
286 return new UserStatus(number
.isEmpty() ?
null : number
,
287 serviceId
== null ?
null : serviceId
.getRawUuid(),
289 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
294 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
295 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
296 for (final var username
: usernames
) {
298 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
299 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
300 registeredUsers
.put(username
, address
);
301 } catch (UnregisteredRecipientException e
) {
306 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
307 final var user
= registeredUsers
.get(username
);
308 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
309 final var profile
= serviceId
== null
311 : context
.getProfileHelper()
312 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
313 return new UsernameStatus(username
,
314 serviceId
== null ?
null : serviceId
.getRawUuid(),
316 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
321 public void updateAccountAttributes(
323 Boolean unrestrictedUnidentifiedSender
,
324 final Boolean discoverableByNumber
,
325 final Boolean numberSharing
326 ) throws IOException
{
327 if (deviceName
!= null) {
328 context
.getAccountHelper().setDeviceName(deviceName
);
330 if (unrestrictedUnidentifiedSender
!= null) {
331 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
333 if (discoverableByNumber
!= null) {
334 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
336 if (numberSharing
!= null) {
337 account
.getConfigurationStore()
338 .setPhoneNumberSharingMode(numberSharing
339 ? PhoneNumberSharingMode
.EVERYBODY
340 : PhoneNumberSharingMode
.NOBODY
);
342 context
.getAccountHelper().updateAccountAttributes();
343 context
.getAccountHelper().checkWhoAmiI();
347 public Configuration
getConfiguration() {
348 final var configurationStore
= account
.getConfigurationStore();
349 return Configuration
.from(configurationStore
);
353 public void updateConfiguration(Configuration configuration
) {
354 final var configurationStore
= account
.getConfigurationStore();
355 if (configuration
.readReceipts().isPresent()) {
356 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
358 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
359 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
361 if (configuration
.typingIndicators().isPresent()) {
362 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
364 if (configuration
.linkPreviews().isPresent()) {
365 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
367 context
.getSyncHelper().sendConfigurationMessage();
372 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
373 context
.getProfileHelper()
374 .setProfile(updateProfile
.getGivenName(),
375 updateProfile
.getFamilyName(),
376 updateProfile
.getAbout(),
377 updateProfile
.getAboutEmoji(),
378 updateProfile
.isDeleteAvatar()
380 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
381 updateProfile
.getMobileCoinAddress());
382 context
.getSyncHelper().sendSyncFetchProfileMessage();
385 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
386 context
.getAccountHelper().refreshCurrentUsername();
390 public String
getUsername() {
391 return account
.getUsername();
395 public UsernameLinkUrl
getUsernameLink() {
396 return new UsernameLinkUrl(account
.getUsernameLink());
400 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
402 if (username
.contains(".")) {
403 context
.getAccountHelper().reserveExactUsername(username
);
405 context
.getAccountHelper().reserveUsernameFromNickname(username
);
407 } catch (UsernameMalformedException e
) {
408 throw new InvalidUsernameException("Username is malformed", e
);
409 } catch (UsernameTakenException e
) {
410 throw new InvalidUsernameException("Username is already registered", e
);
411 } catch (BaseUsernameException e
) {
412 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
417 public void deleteUsername() throws IOException
{
418 context
.getAccountHelper().deleteUsername();
422 public void startChangeNumber(
424 boolean voiceVerification
,
426 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
427 if (!account
.isPrimaryDevice()) {
428 throw new NotPrimaryDeviceException();
430 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
434 public void finishChangeNumber(
436 String verificationCode
,
438 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
439 if (!account
.isPrimaryDevice()) {
440 throw new NotPrimaryDeviceException();
442 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
446 public void unregister() throws IOException
{
447 context
.getAccountHelper().unregister();
451 public void deleteAccount() throws IOException
{
452 context
.getAccountHelper().deleteAccount();
456 public void submitRateLimitRecaptchaChallenge(
459 ) throws IOException
, CaptchaRejectedException
{
460 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
463 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
464 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
465 throw new CaptchaRejectedException();
470 public List
<Device
> getLinkedDevices() throws IOException
{
471 var devices
= dependencies
.getAccountManager().getDevices();
472 account
.setMultiDevice(devices
.size() > 1);
473 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
474 return devices
.stream().map(d
-> {
475 String deviceName
= d
.getName();
476 if (deviceName
!= null) {
478 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
479 } catch (IOException e
) {
480 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
483 return new Device(d
.getId(),
487 d
.getId() == account
.getDeviceId());
492 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
493 if (!account
.isPrimaryDevice()) {
494 throw new NotPrimaryDeviceException();
496 context
.getAccountHelper().removeLinkedDevices(deviceId
);
500 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
, DeviceLimitExceededException
{
501 if (!account
.isPrimaryDevice()) {
502 throw new NotPrimaryDeviceException();
504 context
.getAccountHelper().addDevice(linkUrl
);
508 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
509 if (!account
.isPrimaryDevice()) {
510 throw new NotPrimaryDeviceException();
512 if (pin
.isPresent()) {
513 context
.getAccountHelper().setRegistrationPin(pin
.get());
515 context
.getAccountHelper().removeRegistrationPin();
519 void refreshPreKeys() throws IOException
{
520 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
524 public List
<Group
> getGroups() {
525 return context
.getGroupHelper().getGroups().stream().map(this::toGroup
).toList();
528 private Group
toGroup(final GroupInfo groupInfo
) {
529 if (groupInfo
== null) {
533 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
537 public SendGroupMessageResults
quitGroup(
539 Set
<RecipientIdentifier
.Single
> groupAdmins
540 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
541 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
542 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
546 public void deleteGroup(GroupId groupId
) throws IOException
{
547 final var group
= context
.getGroupHelper().getGroup(groupId
);
548 if (group
.isMember(account
.getSelfRecipientId())) {
549 throw new IOException(
550 "The local group information cannot be removed, as the user is still a member of the group");
552 context
.getGroupHelper().deleteGroup(groupId
);
556 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
558 Set
<RecipientIdentifier
.Single
> members
,
560 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
561 return context
.getGroupHelper()
563 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
568 public SendGroupMessageResults
updateGroup(
569 final GroupId groupId
,
570 final UpdateGroup updateGroup
571 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
572 return context
.getGroupHelper()
573 .updateGroup(groupId
,
574 updateGroup
.getName(),
575 updateGroup
.getDescription(),
576 updateGroup
.getMembers() == null
578 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
579 updateGroup
.getRemoveMembers() == null
581 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
582 updateGroup
.getAdmins() == null
584 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
585 updateGroup
.getRemoveAdmins() == null
587 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
588 updateGroup
.getBanMembers() == null
590 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
591 updateGroup
.getUnbanMembers() == null
593 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
594 updateGroup
.isResetGroupLink(),
595 updateGroup
.getGroupLinkState(),
596 updateGroup
.getAddMemberPermission(),
597 updateGroup
.getEditDetailsPermission(),
598 updateGroup
.getAvatarFile(),
599 updateGroup
.getExpirationTimer(),
600 updateGroup
.getIsAnnouncementGroup());
604 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
605 GroupInviteLinkUrl inviteLinkUrl
606 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
607 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
610 private SendMessageResults
sendMessage(
611 SignalServiceDataMessage
.Builder messageBuilder
,
612 Set
<RecipientIdentifier
> recipients
,
614 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
615 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
618 private SendMessageResults
sendMessage(
619 SignalServiceDataMessage
.Builder messageBuilder
,
620 Set
<RecipientIdentifier
> recipients
,
622 Optional
<Long
> editTargetTimestamp
623 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
624 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
625 long timestamp
= System
.currentTimeMillis();
626 messageBuilder
.withTimestamp(timestamp
);
627 for (final var recipient
: recipients
) {
628 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
629 recipient
instanceof RecipientIdentifier
.Single single
630 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
632 final var result
= notifySelf
633 ? context
.getSendHelper()
634 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
635 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
636 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
637 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
639 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
640 final var result
= context
.getSendHelper()
641 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
642 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
643 } catch (UnregisteredRecipientException e
) {
644 results
.put(recipient
,
645 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
647 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
648 final var result
= context
.getSendHelper()
649 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
650 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
653 return new SendMessageResults(timestamp
, results
);
656 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
657 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
660 private SendMessageResults
sendTypingMessage(
661 SignalServiceTypingMessage
.Action action
,
662 Set
<RecipientIdentifier
> recipients
663 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
664 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
665 final var timestamp
= System
.currentTimeMillis();
666 for (var recipient
: recipients
) {
667 if (recipient
instanceof RecipientIdentifier
.Single single
) {
668 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
670 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
671 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
672 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
673 } catch (UnregisteredRecipientException e
) {
674 results
.put(recipient
,
675 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
677 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
678 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
679 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
680 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
681 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
684 return new SendMessageResults(timestamp
, results
);
688 public SendMessageResults
sendTypingMessage(
690 Set
<RecipientIdentifier
> recipients
691 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
692 return sendTypingMessage(action
.toSignalService(), recipients
);
696 public SendMessageResults
sendReadReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
697 final var timestamp
= System
.currentTimeMillis();
698 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
702 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
706 public SendMessageResults
sendViewedReceipt(RecipientIdentifier
.Single sender
, List
<Long
> messageIds
) {
707 final var timestamp
= System
.currentTimeMillis();
708 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
712 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
715 private SendMessageResults
sendReceiptMessage(
716 final RecipientIdentifier
.Single sender
,
717 final long timestamp
,
718 final SignalServiceReceiptMessage receiptMessage
721 final var recipientId
= context
.getRecipientHelper().resolveRecipient(sender
);
722 final var result
= context
.getSendHelper().sendReceiptMessage(receiptMessage
, recipientId
);
724 final var serviceId
= account
.getRecipientAddressResolver()
725 .resolveRecipientAddress(recipientId
)
727 if (serviceId
.isPresent()) {
728 context
.getSyncHelper().sendSyncReceiptMessage(serviceId
.get(), receiptMessage
);
730 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
731 } catch (UnregisteredRecipientException e
) {
732 return new SendMessageResults(timestamp
,
733 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
738 public SendMessageResults
sendMessage(
740 Set
<RecipientIdentifier
> recipients
,
742 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
743 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
744 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
746 "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.");
748 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
749 applyMessage(messageBuilder
, message
);
750 return sendMessage(messageBuilder
, recipients
, notifySelf
);
754 public SendMessageResults
sendEditMessage(
756 Set
<RecipientIdentifier
> recipients
,
757 long editTargetTimestamp
758 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
759 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
760 applyMessage(messageBuilder
, message
);
761 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
764 private void applyMessage(
765 final SignalServiceDataMessage
.Builder messageBuilder
,
766 final Message message
767 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
768 final var additionalAttachments
= new ArrayList
<SignalServiceAttachment
>();
769 if (Utf8
.size(message
.messageText()) > MAX_MESSAGE_SIZE_BYTES
) {
770 final var result
= splitByByteLength(message
.messageText(), MAX_MESSAGE_SIZE_BYTES
);
771 final var trimmed
= result
.getFirst();
772 final var remainder
= result
.getSecond();
773 if (remainder
!= null) {
774 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
775 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
776 final var streamDetails
= new StreamDetails(new ByteArrayInputStream(messageBytes
),
778 messageBytes
.length
);
779 final var textAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
782 messageBuilder
.withBody(trimmed
);
783 additionalAttachments
.add(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
785 messageBuilder
.withBody(message
.messageText());
788 messageBuilder
.withBody(message
.messageText());
790 if (!message
.attachments().isEmpty()) {
791 final var uploadedAttachments
= context
.getAttachmentHelper().uploadAttachments(message
.attachments());
792 if (!additionalAttachments
.isEmpty()) {
793 additionalAttachments
.addAll(uploadedAttachments
);
794 messageBuilder
.withAttachments(additionalAttachments
);
796 messageBuilder
.withAttachments(uploadedAttachments
);
798 } else if (!additionalAttachments
.isEmpty()) {
799 messageBuilder
.withAttachments(additionalAttachments
);
801 if (!message
.mentions().isEmpty()) {
802 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
804 if (!message
.textStyles().isEmpty()) {
805 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
807 if (message
.quote().isPresent()) {
808 final var quote
= message
.quote().get();
809 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
810 for (final var a
: quote
.attachments()) {
811 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
813 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
814 quotedAttachments
.add(quotedAttachment
);
816 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
817 context
.getRecipientHelper()
818 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
822 resolveMentions(quote
.mentions()),
823 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
824 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
826 if (message
.sticker().isPresent()) {
827 final var sticker
= message
.sticker().get();
828 final var packId
= StickerPackId
.deserialize(sticker
.packId());
829 final var stickerId
= sticker
.stickerId();
831 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
832 if (stickerPack
== null) {
833 throw new InvalidStickerException("Sticker pack not found");
835 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
836 if (manifest
.stickers().size() <= stickerId
) {
837 throw new InvalidStickerException("Sticker id not part of this pack");
839 final var manifestSticker
= manifest
.stickers().get(stickerId
);
840 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
841 if (streamDetails
== null) {
842 throw new InvalidStickerException("Missing local sticker file");
844 final var uploadSpec
= dependencies
.getMessageSender().getResumableUploadSpec();
845 final var stickerAttachment
= AttachmentUtils
.createAttachmentStream(streamDetails
,
848 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
849 stickerPack
.packKey(),
851 manifestSticker
.emoji(),
854 if (!message
.previews().isEmpty()) {
855 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
856 for (final var p
: message
.previews()) {
857 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
858 .uploadAttachment(p
.image().get()) : null;
859 previews
.add(new SignalServicePreview(p
.url(),
863 Optional
.ofNullable(image
)));
865 messageBuilder
.withPreviews(previews
);
867 if (message
.storyReply().isPresent()) {
868 final var storyReply
= message
.storyReply().get();
869 final var authorServiceId
= context
.getRecipientHelper()
870 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
872 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
873 storyReply
.timestamp()));
877 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
878 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
879 for (final var m
: mentionList
) {
880 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
881 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
882 .resolveSignalServiceAddress(recipientId
)
883 .getServiceId(), m
.start(), m
.length()));
889 public SendMessageResults
sendRemoteDeleteMessage(
890 long targetSentTimestamp
,
891 Set
<RecipientIdentifier
> recipients
892 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
893 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
894 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
895 for (final var recipient
: recipients
) {
896 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
897 account
.getMessageSendLogStore()
898 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
899 } else if (recipient
instanceof RecipientIdentifier
.Pni pni
) {
900 account
.getMessageSendLogStore()
901 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, PNI
.from(pni
.pni()));
902 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
904 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
905 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
906 if (address
.serviceId().isPresent()) {
907 account
.getMessageSendLogStore()
908 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
910 } catch (UnregisteredRecipientException ignored
) {
912 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
913 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
916 return sendMessage(messageBuilder
, recipients
, false);
920 public SendMessageResults
sendMessageReaction(
923 RecipientIdentifier
.Single targetAuthor
,
924 long targetSentTimestamp
,
925 Set
<RecipientIdentifier
> recipients
,
926 final boolean isStory
927 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
928 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
929 final var authorServiceId
= context
.getRecipientHelper()
930 .resolveSignalServiceAddress(targetAuthorRecipientId
)
932 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
933 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
935 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
936 targetSentTimestamp
));
938 return sendMessage(messageBuilder
, recipients
, false);
942 public SendMessageResults
sendPaymentNotificationMessage(
945 RecipientIdentifier
.Single recipient
946 ) throws IOException
{
947 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
948 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
949 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
951 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
952 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
953 throw new AssertionError(e
);
958 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
959 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
962 return sendMessage(messageBuilder
,
963 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
965 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
966 throw new AssertionError(e
);
968 for (var recipient
: recipients
) {
969 final RecipientId recipientId
;
971 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
972 } catch (UnregisteredRecipientException e
) {
975 final var serviceId
= context
.getAccount()
976 .getRecipientAddressResolver()
977 .resolveRecipientAddress(recipientId
)
979 if (serviceId
.isPresent()) {
980 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
987 public SendMessageResults
sendMessageRequestResponse(
988 final MessageRequestResponse
.Type type
,
989 final Set
<RecipientIdentifier
> recipients
991 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
992 for (final var recipient
: recipients
) {
993 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
994 recipient
instanceof RecipientIdentifier
.Single single
995 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
997 final var result
= context
.getSyncHelper()
998 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
999 if (result
!= null) {
1000 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1002 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1003 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
1005 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
1006 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
1007 if (result
!= null) {
1008 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1010 } catch (UnregisteredRecipientException e
) {
1011 results
.put(recipient
,
1012 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
1014 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
1015 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
1016 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
1019 return new SendMessageResults(0, results
);
1023 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
1024 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1025 if (recipientIdOptional
.isPresent()) {
1026 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
1027 account
.removeRecipient(recipientIdOptional
.get());
1028 syncRemoteStorage();
1033 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
1034 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1035 if (recipientIdOptional
.isPresent()) {
1036 account
.removeRecipient(recipientIdOptional
.get());
1037 syncRemoteStorage();
1042 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
1043 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
1044 if (recipientIdOptional
.isPresent()) {
1045 account
.getContactStore().deleteContact(recipientIdOptional
.get());
1046 syncRemoteStorage();
1051 public void setContactName(
1052 final RecipientIdentifier
.Single recipient
,
1053 final String givenName
,
1054 final String familyName
,
1055 final String nickGivenName
,
1056 final String nickFamilyName
,
1058 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
1059 if (!account
.isPrimaryDevice()) {
1060 throw new NotPrimaryDeviceException();
1062 context
.getContactHelper()
1063 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
),
1069 syncRemoteStorage();
1073 public void setContactsBlocked(
1074 Collection
<RecipientIdentifier
.Single
> recipients
,
1076 ) throws IOException
, UnregisteredRecipientException
{
1077 if (recipients
.isEmpty()) {
1080 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1081 final var selfRecipientId
= account
.getSelfRecipientId();
1082 boolean shouldRotateProfileKey
= false;
1083 for (final var recipientId
: recipientIds
) {
1084 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1087 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1088 context
.getSyncHelper()
1089 .sendMessageRequestResponse(blocked
1090 ? MessageRequestResponse
.Type
.BLOCK
1091 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1092 // if we don't have a common group with the blocked contact we need to rotate the profile key
1093 shouldRotateProfileKey
= blocked
&& (
1094 shouldRotateProfileKey
|| account
.getGroupStore()
1097 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1100 if (shouldRotateProfileKey
) {
1101 context
.getProfileHelper().rotateProfileKey();
1103 context
.getSyncHelper().sendBlockedList();
1104 syncRemoteStorage();
1108 public void setGroupsBlocked(
1109 final Collection
<GroupId
> groupIds
,
1110 final boolean blocked
1111 ) throws GroupNotFoundException
, IOException
{
1112 if (groupIds
.isEmpty()) {
1115 boolean shouldRotateProfileKey
= false;
1116 for (final var groupId
: groupIds
) {
1117 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1120 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1121 context
.getSyncHelper()
1122 .sendMessageRequestResponse(blocked
1123 ? MessageRequestResponse
.Type
.BLOCK
1124 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1125 shouldRotateProfileKey
= blocked
;
1127 if (shouldRotateProfileKey
) {
1128 context
.getProfileHelper().rotateProfileKey();
1130 context
.getSyncHelper().sendBlockedList();
1131 syncRemoteStorage();
1135 public void setExpirationTimer(
1136 RecipientIdentifier
.Single recipient
,
1137 int messageExpirationTimer
1138 ) throws IOException
, UnregisteredRecipientException
{
1139 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1140 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1141 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1143 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1144 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1145 throw new AssertionError(e
);
1147 syncRemoteStorage();
1151 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1152 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1154 var messageSender
= dependencies
.getMessageSender();
1156 var packKey
= KeyUtils
.createStickerUploadKey();
1157 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1158 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1160 var sticker
= new StickerPack(packId
, packKey
);
1161 account
.getStickerStore().addStickerPack(sticker
);
1162 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1164 return new StickerPackUrl(packId
, packKey
);
1168 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1169 final var packId
= url
.packId();
1170 final var packKey
= url
.packKey();
1172 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1173 } catch (InvalidMessageException e
) {
1174 throw new IOException(e
);
1177 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1178 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1182 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1183 final var stickerPackStore
= context
.getStickerPackStore();
1184 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1185 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1187 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1188 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1189 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1193 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1194 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1195 } catch (Exception e
) {
1196 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1200 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1205 public void requestAllSyncData() {
1206 context
.getSyncHelper().requestAllSyncData();
1207 syncRemoteStorage();
1210 void syncRemoteStorage() {
1211 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1215 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1216 synchronized (messageHandlers
) {
1217 if (isWeakListener
) {
1218 weakHandlers
.add(handler
);
1220 messageHandlers
.add(handler
);
1221 startReceiveThreadIfRequired();
1226 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1228 private void startReceiveThreadIfRequired() {
1229 if (receiveThread
!= null || isReceivingSynchronous
) {
1232 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1233 logger
.debug("Starting receiving messages");
1234 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1235 logger
.debug("Finished receiving messages");
1236 synchronized (messageHandlers
) {
1237 receiveThread
= null;
1239 // Check if in the meantime another handler has been registered
1240 if (!messageHandlers
.isEmpty()) {
1241 logger
.debug("Another handler has been registered, starting receive thread again");
1242 startReceiveThreadIfRequired();
1248 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1249 synchronized (messageHandlers
) {
1250 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1252 h
.handleMessage(envelope
, e
);
1253 } catch (Throwable ex
) {
1254 logger
.warn("Message handler failed, ignoring", ex
);
1261 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1262 final Thread thread
;
1263 synchronized (messageHandlers
) {
1264 weakHandlers
.remove(handler
);
1265 messageHandlers
.remove(handler
);
1266 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1269 thread
= receiveThread
;
1270 receiveThread
= null;
1273 stopReceiveThread(thread
);
1276 private void stopReceiveThread(final Thread thread
) {
1277 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1278 logger
.debug("Receive stop requested, interrupting read from server.");
1283 } catch (InterruptedException ignored
) {
1288 public boolean isReceiving() {
1289 if (isReceivingSynchronous
) {
1292 synchronized (messageHandlers
) {
1293 return !messageHandlers
.isEmpty();
1298 public void receiveMessages(
1299 Optional
<Duration
> timeout
,
1300 Optional
<Integer
> maxMessages
,
1301 ReceiveMessageHandler handler
1302 ) throws IOException
, AlreadyReceivingException
{
1303 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1307 public void stopReceiveMessages() {
1308 Thread thread
= null;
1309 synchronized (messageHandlers
) {
1310 if (isReceivingSynchronous
) {
1311 thread
= receiveThread
;
1312 receiveThread
= null;
1315 if (thread
!= null) {
1316 stopReceiveThread(thread
);
1320 private void receiveMessages(
1322 boolean returnOnTimeout
,
1323 Integer maxMessages
,
1324 ReceiveMessageHandler handler
1325 ) throws IOException
, AlreadyReceivingException
{
1326 synchronized (messageHandlers
) {
1327 if (isReceiving()) {
1328 throw new AlreadyReceivingException("Already receiving message.");
1330 isReceivingSynchronous
= true;
1331 receiveThread
= Thread
.currentThread();
1334 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1335 passReceivedMessageToHandlers(envelope
, e
);
1336 handler
.handleMessage(envelope
, e
);
1339 synchronized (messageHandlers
) {
1340 receiveThread
= null;
1341 isReceivingSynchronous
= false;
1342 if (!messageHandlers
.isEmpty()) {
1343 startReceiveThreadIfRequired();
1350 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1351 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1355 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1356 final RecipientId recipientId
;
1358 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1359 } catch (UnregisteredRecipientException e
) {
1362 return context
.getContactHelper().isContactBlocked(recipientId
);
1366 public void sendContacts() throws IOException
{
1367 context
.getSyncHelper().sendContacts();
1371 public List
<Recipient
> getRecipients(
1372 boolean onlyContacts
,
1373 Optional
<Boolean
> blocked
,
1374 Collection
<RecipientIdentifier
.Single
> recipients
,
1375 Optional
<String
> name
1377 final var recipientIds
= recipients
.stream().map(a
-> {
1379 return context
.getRecipientHelper().resolveRecipient(a
);
1380 } catch (UnregisteredRecipientException e
) {
1383 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1384 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1387 // refresh profiles of explicitly given recipients
1388 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1389 return account
.getRecipientStore()
1390 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1392 .map(s
-> new Recipient(s
.getRecipientId(),
1393 s
.getAddress().toApiRecipientAddress(),
1396 s
.getExpiringProfileKeyCredential(),
1398 s
.getDiscoverable()))
1403 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1404 final RecipientId recipientId
;
1406 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1407 } catch (UnregisteredRecipientException e
) {
1411 final var contact
= account
.getContactStore().getContact(recipientId
);
1412 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1413 return contact
.getName();
1416 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1417 if (profile
!= null) {
1418 return profile
.getDisplayName();
1425 public Group
getGroup(GroupId groupId
) {
1426 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1430 public List
<Identity
> getIdentities() {
1431 return account
.getIdentityKeyStore()
1434 .map(this::toIdentity
)
1435 .filter(Objects
::nonNull
)
1439 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1440 if (identityInfo
== null) {
1444 final var address
= account
.getRecipientAddressResolver()
1445 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1446 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1447 identityInfo
.getServiceId())) {
1450 final var scannableFingerprint
= context
.getIdentityHelper()
1451 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1452 return new Identity(address
.toApiRecipientAddress(),
1453 identityInfo
.getIdentityKey().getPublicKey().serialize(),
1454 context
.getIdentityHelper()
1455 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1456 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1457 identityInfo
.getTrustLevel(),
1458 identityInfo
.getDateAddedTimestamp());
1462 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1463 ServiceId serviceId
;
1465 final var address
= account
.getRecipientAddressResolver()
1466 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1467 if (address
.serviceId().isEmpty()) {
1470 serviceId
= address
.serviceId().get();
1471 } catch (UnregisteredRecipientException e
) {
1474 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1475 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1479 public boolean trustIdentityVerified(
1480 RecipientIdentifier
.Single recipient
,
1481 IdentityVerificationCode verificationCode
1482 ) throws UnregisteredRecipientException
{
1483 return switch (verificationCode
) {
1484 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1485 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1486 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1487 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1488 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1489 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1490 case null -> throw new AssertionError("Invalid verification code type");
1495 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1496 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1499 private boolean trustIdentity(
1500 RecipientIdentifier
.Single recipient
,
1501 Function
<RecipientId
, Boolean
> trustMethod
1502 ) throws UnregisteredRecipientException
{
1503 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1504 final var updated
= trustMethod
.apply(recipientId
);
1505 if (updated
&& this.isReceiving()) {
1506 account
.setNeedsToRetryFailedMessages(true);
1512 public void addAddressChangedListener(final Runnable listener
) {
1513 synchronized (addressChangedListeners
) {
1514 addressChangedListeners
.add(listener
);
1519 public void addClosedListener(final Runnable listener
) {
1520 synchronized (closedListeners
) {
1521 closedListeners
.add(listener
);
1526 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1527 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1531 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1532 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1533 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1534 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1535 if (streamDetails
== null) {
1536 throw new FileNotFoundException();
1538 return streamDetails
.getStream();
1542 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1543 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1544 context
.getProfileHelper().getRecipientProfile(recipientId
);
1545 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1546 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1547 if (streamDetails
== null) {
1548 throw new FileNotFoundException();
1550 return streamDetails
.getStream();
1554 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1555 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1556 context
.getGroupHelper().getGroup(groupId
);
1557 if (streamDetails
== null) {
1558 throw new FileNotFoundException();
1560 return streamDetails
.getStream();
1564 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1565 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1566 if (streamDetails
== null) {
1567 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1570 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1571 } catch (InvalidMessageException e
) {
1572 logger
.warn("Failed to download sticker pack");
1576 if (streamDetails
== null) {
1577 throw new FileNotFoundException();
1579 return streamDetails
.getStream();
1583 public void close() {
1585 synchronized (messageHandlers
) {
1586 weakHandlers
.clear();
1587 messageHandlers
.clear();
1588 thread
= receiveThread
;
1589 receiveThread
= null;
1591 if (thread
!= null) {
1592 stopReceiveThread(thread
);
1597 dependencies
.getSignalWebSocket().disconnect();
1598 dependencies
.getPushServiceSocket().close();
1599 disposable
.dispose();
1601 if (account
!= null) {
1605 synchronized (closedListeners
) {
1606 closedListeners
.forEach(Runnable
::run
);
1607 closedListeners
.clear();