2 Copyright (C) 2015-2022 AsamK and contributors
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org
.asamk
.signal
.manager
.internal
;
19 import org
.asamk
.signal
.manager
.Manager
;
20 import org
.asamk
.signal
.manager
.api
.AlreadyReceivingException
;
21 import org
.asamk
.signal
.manager
.api
.AttachmentInvalidException
;
22 import org
.asamk
.signal
.manager
.api
.CaptchaRejectedException
;
23 import org
.asamk
.signal
.manager
.api
.CaptchaRequiredException
;
24 import org
.asamk
.signal
.manager
.api
.Configuration
;
25 import org
.asamk
.signal
.manager
.api
.Device
;
26 import org
.asamk
.signal
.manager
.api
.DeviceLinkUrl
;
27 import org
.asamk
.signal
.manager
.api
.Group
;
28 import org
.asamk
.signal
.manager
.api
.GroupId
;
29 import org
.asamk
.signal
.manager
.api
.GroupInviteLinkUrl
;
30 import org
.asamk
.signal
.manager
.api
.GroupNotFoundException
;
31 import org
.asamk
.signal
.manager
.api
.GroupSendingNotAllowedException
;
32 import org
.asamk
.signal
.manager
.api
.Identity
;
33 import org
.asamk
.signal
.manager
.api
.IdentityVerificationCode
;
34 import org
.asamk
.signal
.manager
.api
.InactiveGroupLinkException
;
35 import org
.asamk
.signal
.manager
.api
.IncorrectPinException
;
36 import org
.asamk
.signal
.manager
.api
.InvalidDeviceLinkException
;
37 import org
.asamk
.signal
.manager
.api
.InvalidStickerException
;
38 import org
.asamk
.signal
.manager
.api
.InvalidUsernameException
;
39 import org
.asamk
.signal
.manager
.api
.LastGroupAdminException
;
40 import org
.asamk
.signal
.manager
.api
.Message
;
41 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
42 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
.Sync
.MessageRequestResponse
;
43 import org
.asamk
.signal
.manager
.api
.NonNormalizedPhoneNumberException
;
44 import org
.asamk
.signal
.manager
.api
.NotAGroupMemberException
;
45 import org
.asamk
.signal
.manager
.api
.NotPrimaryDeviceException
;
46 import org
.asamk
.signal
.manager
.api
.Pair
;
47 import org
.asamk
.signal
.manager
.api
.PendingAdminApprovalException
;
48 import org
.asamk
.signal
.manager
.api
.PhoneNumberSharingMode
;
49 import org
.asamk
.signal
.manager
.api
.PinLockedException
;
50 import org
.asamk
.signal
.manager
.api
.Profile
;
51 import org
.asamk
.signal
.manager
.api
.RateLimitException
;
52 import org
.asamk
.signal
.manager
.api
.ReceiveConfig
;
53 import org
.asamk
.signal
.manager
.api
.Recipient
;
54 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
55 import org
.asamk
.signal
.manager
.api
.SendGroupMessageResults
;
56 import org
.asamk
.signal
.manager
.api
.SendMessageResult
;
57 import org
.asamk
.signal
.manager
.api
.SendMessageResults
;
58 import org
.asamk
.signal
.manager
.api
.StickerPackId
;
59 import org
.asamk
.signal
.manager
.api
.StickerPackInvalidException
;
60 import org
.asamk
.signal
.manager
.api
.StickerPackUrl
;
61 import org
.asamk
.signal
.manager
.api
.TextStyle
;
62 import org
.asamk
.signal
.manager
.api
.TypingAction
;
63 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
64 import org
.asamk
.signal
.manager
.api
.UpdateGroup
;
65 import org
.asamk
.signal
.manager
.api
.UpdateProfile
;
66 import org
.asamk
.signal
.manager
.api
.UserStatus
;
67 import org
.asamk
.signal
.manager
.api
.UsernameLinkUrl
;
68 import org
.asamk
.signal
.manager
.api
.UsernameStatus
;
69 import org
.asamk
.signal
.manager
.api
.VerificationMethodNotAvailableException
;
70 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
71 import org
.asamk
.signal
.manager
.helper
.AccountFileUpdater
;
72 import org
.asamk
.signal
.manager
.helper
.Context
;
73 import org
.asamk
.signal
.manager
.helper
.RecipientHelper
.RegisteredUser
;
74 import org
.asamk
.signal
.manager
.jobs
.RefreshRecipientsJob
;
75 import org
.asamk
.signal
.manager
.jobs
.SyncStorageJob
;
76 import org
.asamk
.signal
.manager
.storage
.AttachmentStore
;
77 import org
.asamk
.signal
.manager
.storage
.AvatarStore
;
78 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
79 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
80 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
81 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientAddress
;
82 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
83 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.JsonStickerPack
;
84 import org
.asamk
.signal
.manager
.storage
.stickerPacks
.StickerPackStore
;
85 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPack
;
86 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
87 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
88 import org
.asamk
.signal
.manager
.util
.MimeUtils
;
89 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
90 import org
.signal
.libsignal
.protocol
.InvalidMessageException
;
91 import org
.signal
.libsignal
.usernames
.BaseUsernameException
;
92 import org
.slf4j
.Logger
;
93 import org
.slf4j
.LoggerFactory
;
94 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
95 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServicePreview
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
99 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
100 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
101 import org
.whispersystems
.signalservice
.api
.push
.ServiceIdType
;
102 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.CdsiResourceExhaustedException
;
103 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
104 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
105 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
106 import org
.whispersystems
.signalservice
.api
.util
.StreamDetails
;
107 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
108 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
110 import java
.io
.ByteArrayInputStream
;
112 import java
.io
.FileNotFoundException
;
113 import java
.io
.IOException
;
114 import java
.io
.InputStream
;
115 import java
.nio
.charset
.StandardCharsets
;
116 import java
.time
.Duration
;
117 import java
.util
.ArrayList
;
118 import java
.util
.Collection
;
119 import java
.util
.HashMap
;
120 import java
.util
.HashSet
;
121 import java
.util
.List
;
122 import java
.util
.Map
;
123 import java
.util
.Objects
;
124 import java
.util
.Optional
;
125 import java
.util
.Set
;
126 import java
.util
.concurrent
.ExecutorService
;
127 import java
.util
.concurrent
.Executors
;
128 import java
.util
.concurrent
.TimeUnit
;
129 import java
.util
.concurrent
.atomic
.AtomicInteger
;
130 import java
.util
.concurrent
.locks
.ReentrantLock
;
131 import java
.util
.function
.Function
;
132 import java
.util
.stream
.Collectors
;
133 import java
.util
.stream
.Stream
;
135 import io
.reactivex
.rxjava3
.disposables
.CompositeDisposable
;
136 import io
.reactivex
.rxjava3
.schedulers
.Schedulers
;
138 public class ManagerImpl
implements Manager
{
140 private static final Logger logger
= LoggerFactory
.getLogger(ManagerImpl
.class);
142 private SignalAccount account
;
143 private final SignalDependencies dependencies
;
144 private final Context context
;
146 private final ExecutorService executor
= Executors
.newCachedThreadPool();
148 private Thread receiveThread
;
149 private boolean isReceivingSynchronous
;
150 private final Set
<ReceiveMessageHandler
> weakHandlers
= new HashSet
<>();
151 private final Set
<ReceiveMessageHandler
> messageHandlers
= new HashSet
<>();
152 private final List
<Runnable
> closedListeners
= new ArrayList
<>();
153 private final List
<Runnable
> addressChangedListeners
= new ArrayList
<>();
154 private final CompositeDisposable disposable
= new CompositeDisposable();
157 SignalAccount account
,
158 PathConfig pathConfig
,
159 AccountFileUpdater accountFileUpdater
,
160 ServiceEnvironmentConfig serviceEnvironmentConfig
,
163 this.account
= account
;
165 final var sessionLock
= new SignalSessionLock() {
166 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
169 public Lock
acquire() {
171 return LEGACY_LOCK
::unlock
;
174 this.dependencies
= new SignalDependencies(serviceEnvironmentConfig
,
176 account
.getCredentialsProvider(),
177 account
.getSignalServiceDataStore(),
180 final var avatarStore
= new AvatarStore(pathConfig
.avatarsPath());
181 final var attachmentStore
= new AttachmentStore(pathConfig
.attachmentsPath());
182 final var stickerPackStore
= new StickerPackStore(pathConfig
.stickerPacksPath());
184 this.context
= new Context(account
, new AccountFileUpdater() {
186 public void updateAccountIdentifiers(final String number
, final ACI aci
) {
187 accountFileUpdater
.updateAccountIdentifiers(number
, aci
);
188 synchronized (addressChangedListeners
) {
189 addressChangedListeners
.forEach(Runnable
::run
);
194 public void removeAccount() {
195 accountFileUpdater
.removeAccount();
197 }, dependencies
, avatarStore
, attachmentStore
, stickerPackStore
);
198 this.context
.getAccountHelper().setUnregisteredListener(this::close
);
199 this.context
.getReceiveHelper().setAuthenticationFailureListener(this::close
);
200 this.context
.getReceiveHelper().setCaughtUpWithOldMessagesListener(() -> {
201 synchronized (this) {
205 disposable
.add(account
.getIdentityKeyStore()
206 .getIdentityChanges()
207 .observeOn(Schedulers
.from(executor
))
208 .subscribe(serviceId
-> {
209 logger
.trace("Archiving old sessions for {}", serviceId
);
210 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().archiveSessions(serviceId
);
211 account
.getAccountData(ServiceIdType
.PNI
).getSessionStore().archiveSessions(serviceId
);
212 account
.getSenderKeyStore().deleteSharedWith(serviceId
);
213 final var recipientId
= account
.getRecipientResolver().resolveRecipient(serviceId
);
214 final var profile
= account
.getProfileStore().getProfile(recipientId
);
215 if (profile
!= null) {
216 account
.getProfileStore()
217 .storeProfile(recipientId
,
218 Profile
.newBuilder(profile
)
219 .withUnidentifiedAccessMode(Profile
.UnidentifiedAccessMode
.UNKNOWN
)
220 .withLastUpdateTimestamp(0)
227 public String
getSelfNumber() {
228 return account
.getNumber();
231 public void checkAccountState() throws IOException
{
232 context
.getAccountHelper().checkAccountState();
233 final var lastRecipientsRefresh
= account
.getLastRecipientsRefresh();
234 if (lastRecipientsRefresh
== null
235 || lastRecipientsRefresh
< System
.currentTimeMillis() - TimeUnit
.DAYS
.toMillis(1)) {
236 context
.getJobExecutor().enqueueJob(new RefreshRecipientsJob());
237 context
.getAccountHelper().checkWhoAmiI();
242 public Map
<String
, UserStatus
> getUserStatus(Set
<String
> numbers
) throws IOException
, RateLimitException
{
243 final var canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
245 final var canonicalizedNumber
= PhoneNumberFormatter
.formatNumber(n
, account
.getNumber());
246 if (!canonicalizedNumber
.equals(n
)) {
247 logger
.debug("Normalized number {} to {}.", n
, canonicalizedNumber
);
249 return canonicalizedNumber
;
250 } catch (InvalidNumberException e
) {
255 // Note "registeredUsers" has no optionals. It only gives us info on users who are registered
256 final var canonicalizedNumbersSet
= canonicalizedNumbers
.values()
258 .filter(s
-> !s
.isEmpty())
259 .collect(Collectors
.toSet());
261 final Map
<String
, RegisteredUser
> registeredUsers
;
263 registeredUsers
= context
.getRecipientHelper().getRegisteredUsers(canonicalizedNumbersSet
);
264 } catch (CdsiResourceExhaustedException e
) {
265 logger
.debug("CDSI resource exhausted: {}", e
.getMessage());
266 throw new RateLimitException(System
.currentTimeMillis() + e
.getRetryAfterSeconds() * 1000L);
269 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
270 final var number
= canonicalizedNumbers
.get(n
);
271 final var user
= registeredUsers
.get(number
);
272 final var serviceId
= user
== null ?
null : user
.getServiceId();
273 final var profile
= serviceId
== null
275 : context
.getProfileHelper()
276 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
277 return new UserStatus(number
.isEmpty() ?
null : number
,
278 serviceId
== null ?
null : serviceId
.getRawUuid(),
280 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
285 public Map
<String
, UsernameStatus
> getUsernameStatus(Set
<String
> usernames
) {
286 final var registeredUsers
= new HashMap
<String
, RecipientAddress
>();
287 for (final var username
: usernames
) {
289 final var recipientId
= context
.getRecipientHelper().resolveRecipientByUsernameOrLink(username
, true);
290 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
291 registeredUsers
.put(username
, address
);
292 } catch (UnregisteredRecipientException e
) {
297 return usernames
.stream().collect(Collectors
.toMap(n
-> n
, username
-> {
298 final var user
= registeredUsers
.get(username
);
299 final var serviceId
= user
== null ?
null : user
.serviceId().orElse(null);
300 final var profile
= serviceId
== null
302 : context
.getProfileHelper()
303 .getRecipientProfile(account
.getRecipientResolver().resolveRecipient(serviceId
));
304 return new UsernameStatus(username
,
305 serviceId
== null ?
null : serviceId
.getRawUuid(),
307 && profile
.getUnidentifiedAccessMode() == Profile
.UnidentifiedAccessMode
.UNRESTRICTED
);
312 public void updateAccountAttributes(
314 Boolean unrestrictedUnidentifiedSender
,
315 final Boolean discoverableByNumber
,
316 final Boolean numberSharing
317 ) throws IOException
{
318 if (deviceName
!= null) {
319 context
.getAccountHelper().setDeviceName(deviceName
);
321 if (unrestrictedUnidentifiedSender
!= null) {
322 account
.setUnrestrictedUnidentifiedAccess(unrestrictedUnidentifiedSender
);
324 if (discoverableByNumber
!= null) {
325 account
.getConfigurationStore().setPhoneNumberUnlisted(!discoverableByNumber
);
327 if (numberSharing
!= null) {
328 account
.getConfigurationStore()
329 .setPhoneNumberSharingMode(numberSharing
330 ? PhoneNumberSharingMode
.EVERYBODY
331 : PhoneNumberSharingMode
.NOBODY
);
333 context
.getAccountHelper().updateAccountAttributes();
334 context
.getAccountHelper().checkWhoAmiI();
338 public Configuration
getConfiguration() {
339 final var configurationStore
= account
.getConfigurationStore();
340 return Configuration
.from(configurationStore
);
344 public void updateConfiguration(Configuration configuration
) {
345 final var configurationStore
= account
.getConfigurationStore();
346 if (configuration
.readReceipts().isPresent()) {
347 configurationStore
.setReadReceipts(configuration
.readReceipts().get());
349 if (configuration
.unidentifiedDeliveryIndicators().isPresent()) {
350 configurationStore
.setUnidentifiedDeliveryIndicators(configuration
.unidentifiedDeliveryIndicators().get());
352 if (configuration
.typingIndicators().isPresent()) {
353 configurationStore
.setTypingIndicators(configuration
.typingIndicators().get());
355 if (configuration
.linkPreviews().isPresent()) {
356 configurationStore
.setLinkPreviews(configuration
.linkPreviews().get());
358 context
.getSyncHelper().sendConfigurationMessage();
363 public void updateProfile(UpdateProfile updateProfile
) throws IOException
{
364 context
.getProfileHelper()
365 .setProfile(updateProfile
.getGivenName(),
366 updateProfile
.getFamilyName(),
367 updateProfile
.getAbout(),
368 updateProfile
.getAboutEmoji(),
369 updateProfile
.isDeleteAvatar()
371 : updateProfile
.getAvatar() == null ?
null : Optional
.of(updateProfile
.getAvatar()),
372 updateProfile
.getMobileCoinAddress());
373 context
.getSyncHelper().sendSyncFetchProfileMessage();
376 void refreshCurrentUsername() throws IOException
, BaseUsernameException
{
377 context
.getAccountHelper().refreshCurrentUsername();
381 public String
getUsername() {
382 return account
.getUsername();
386 public UsernameLinkUrl
getUsernameLink() {
387 return new UsernameLinkUrl(account
.getUsernameLink());
391 public void setUsername(final String username
) throws IOException
, InvalidUsernameException
{
393 if (username
.contains(".")) {
394 context
.getAccountHelper().reserveExactUsername(username
);
396 context
.getAccountHelper().reserveUsernameFromNickname(username
);
398 } catch (BaseUsernameException e
) {
399 throw new InvalidUsernameException(e
.getMessage() + " (" + e
.getClass().getSimpleName() + ")", e
);
404 public void deleteUsername() throws IOException
{
405 context
.getAccountHelper().deleteUsername();
409 public void startChangeNumber(
410 String newNumber
, boolean voiceVerification
, String captcha
411 ) throws RateLimitException
, IOException
, CaptchaRequiredException
, NonNormalizedPhoneNumberException
, NotPrimaryDeviceException
, VerificationMethodNotAvailableException
{
412 if (!account
.isPrimaryDevice()) {
413 throw new NotPrimaryDeviceException();
415 context
.getAccountHelper().startChangeNumber(newNumber
, voiceVerification
, captcha
);
419 public void finishChangeNumber(
420 String newNumber
, String verificationCode
, String pin
421 ) throws IncorrectPinException
, PinLockedException
, IOException
, NotPrimaryDeviceException
{
422 if (!account
.isPrimaryDevice()) {
423 throw new NotPrimaryDeviceException();
425 context
.getAccountHelper().finishChangeNumber(newNumber
, verificationCode
, pin
);
429 public void unregister() throws IOException
{
430 context
.getAccountHelper().unregister();
434 public void deleteAccount() throws IOException
{
435 context
.getAccountHelper().deleteAccount();
439 public void submitRateLimitRecaptchaChallenge(
440 String challenge
, String captcha
441 ) throws IOException
, CaptchaRejectedException
{
442 captcha
= captcha
== null ?
null : captcha
.replace("signalcaptcha://", "");
445 dependencies
.getAccountManager().submitRateLimitRecaptchaChallenge(challenge
, captcha
);
446 } catch (org
.whispersystems
.signalservice
.internal
.push
.exceptions
.CaptchaRejectedException ignored
) {
447 throw new CaptchaRejectedException();
452 public List
<Device
> getLinkedDevices() throws IOException
{
453 var devices
= dependencies
.getAccountManager().getDevices();
454 account
.setMultiDevice(devices
.size() > 1);
455 var identityKey
= account
.getAciIdentityKeyPair().getPrivateKey();
456 return devices
.stream().map(d
-> {
457 String deviceName
= d
.getName();
458 if (deviceName
!= null) {
460 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
461 } catch (IOException e
) {
462 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
465 return new Device(d
.getId(),
469 d
.getId() == account
.getDeviceId());
474 public void removeLinkedDevices(int deviceId
) throws IOException
, NotPrimaryDeviceException
{
475 if (!account
.isPrimaryDevice()) {
476 throw new NotPrimaryDeviceException();
478 context
.getAccountHelper().removeLinkedDevices(deviceId
);
482 public void addDeviceLink(DeviceLinkUrl linkUrl
) throws IOException
, InvalidDeviceLinkException
, NotPrimaryDeviceException
{
483 if (!account
.isPrimaryDevice()) {
484 throw new NotPrimaryDeviceException();
486 context
.getAccountHelper().addDevice(linkUrl
);
490 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, NotPrimaryDeviceException
{
491 if (!account
.isPrimaryDevice()) {
492 throw new NotPrimaryDeviceException();
494 if (pin
.isPresent()) {
495 context
.getAccountHelper().setRegistrationPin(pin
.get());
497 context
.getAccountHelper().removeRegistrationPin();
501 void refreshPreKeys() throws IOException
{
502 context
.getPreKeyHelper().refreshPreKeysIfNecessary();
506 public List
<Group
> getGroups() {
507 return account
.getGroupStore().getGroups().stream().map(this::toGroup
).toList();
510 private Group
toGroup(final GroupInfo groupInfo
) {
511 if (groupInfo
== null) {
515 return Group
.from(groupInfo
, account
.getRecipientAddressResolver(), account
.getSelfRecipientId());
519 public SendGroupMessageResults
quitGroup(
520 GroupId groupId
, Set
<RecipientIdentifier
.Single
> groupAdmins
521 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, LastGroupAdminException
, UnregisteredRecipientException
{
522 final var newAdmins
= context
.getRecipientHelper().resolveRecipients(groupAdmins
);
523 return context
.getGroupHelper().quitGroup(groupId
, newAdmins
);
527 public void deleteGroup(GroupId groupId
) throws IOException
{
528 final var group
= context
.getGroupHelper().getGroup(groupId
);
529 if (group
.isMember(account
.getSelfRecipientId())) {
530 throw new IOException(
531 "The local group information cannot be removed, as the user is still a member of the group");
533 context
.getGroupHelper().deleteGroup(groupId
);
537 public Pair
<GroupId
, SendGroupMessageResults
> createGroup(
538 String name
, Set
<RecipientIdentifier
.Single
> members
, String avatarFile
539 ) throws IOException
, AttachmentInvalidException
, UnregisteredRecipientException
{
540 return context
.getGroupHelper()
542 members
== null ?
null : context
.getRecipientHelper().resolveRecipients(members
),
547 public SendGroupMessageResults
updateGroup(
548 final GroupId groupId
, final UpdateGroup updateGroup
549 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
550 return context
.getGroupHelper()
551 .updateGroup(groupId
,
552 updateGroup
.getName(),
553 updateGroup
.getDescription(),
554 updateGroup
.getMembers() == null
556 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getMembers()),
557 updateGroup
.getRemoveMembers() == null
559 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveMembers()),
560 updateGroup
.getAdmins() == null
562 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getAdmins()),
563 updateGroup
.getRemoveAdmins() == null
565 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getRemoveAdmins()),
566 updateGroup
.getBanMembers() == null
568 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getBanMembers()),
569 updateGroup
.getUnbanMembers() == null
571 : context
.getRecipientHelper().resolveRecipients(updateGroup
.getUnbanMembers()),
572 updateGroup
.isResetGroupLink(),
573 updateGroup
.getGroupLinkState(),
574 updateGroup
.getAddMemberPermission(),
575 updateGroup
.getEditDetailsPermission(),
576 updateGroup
.getAvatarFile(),
577 updateGroup
.getExpirationTimer(),
578 updateGroup
.getIsAnnouncementGroup());
582 public Pair
<GroupId
, SendGroupMessageResults
> joinGroup(
583 GroupInviteLinkUrl inviteLinkUrl
584 ) throws IOException
, InactiveGroupLinkException
, PendingAdminApprovalException
{
585 return context
.getGroupHelper().joinGroup(inviteLinkUrl
);
588 private SendMessageResults
sendMessage(
589 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
590 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
591 return sendMessage(messageBuilder
, recipients
, notifySelf
, Optional
.empty());
594 private SendMessageResults
sendMessage(
595 SignalServiceDataMessage
.Builder messageBuilder
,
596 Set
<RecipientIdentifier
> recipients
,
598 Optional
<Long
> editTargetTimestamp
599 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
600 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
601 long timestamp
= System
.currentTimeMillis();
602 messageBuilder
.withTimestamp(timestamp
);
603 for (final var recipient
: recipients
) {
604 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
605 recipient
instanceof RecipientIdentifier
.Single single
606 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
608 final var result
= notifySelf
609 ? context
.getSendHelper()
610 .sendMessage(messageBuilder
, account
.getSelfRecipientId(), editTargetTimestamp
)
611 : context
.getSendHelper().sendSelfMessage(messageBuilder
, editTargetTimestamp
);
612 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
613 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
615 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
616 final var result
= context
.getSendHelper()
617 .sendMessage(messageBuilder
, recipientId
, editTargetTimestamp
);
618 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
619 } catch (UnregisteredRecipientException e
) {
620 results
.put(recipient
,
621 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
623 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
624 final var result
= context
.getSendHelper()
625 .sendAsGroupMessage(messageBuilder
, group
.groupId(), notifySelf
, editTargetTimestamp
);
626 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
629 return new SendMessageResults(timestamp
, results
);
632 private SendMessageResult
toSendMessageResult(final org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult result
) {
633 return SendMessageResult
.from(result
, account
.getRecipientResolver(), account
.getRecipientAddressResolver());
636 private SendMessageResults
sendTypingMessage(
637 SignalServiceTypingMessage
.Action action
, Set
<RecipientIdentifier
> recipients
638 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
639 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
640 final var timestamp
= System
.currentTimeMillis();
641 for (var recipient
: recipients
) {
642 if (recipient
instanceof RecipientIdentifier
.Single single
) {
643 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.empty());
645 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
646 final var result
= context
.getSendHelper().sendTypingMessage(message
, recipientId
);
647 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
648 } catch (UnregisteredRecipientException e
) {
649 results
.put(recipient
,
650 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
652 } else if (recipient
instanceof RecipientIdentifier
.Group
) {
653 final var groupId
= ((RecipientIdentifier
.Group
) recipient
).groupId();
654 final var message
= new SignalServiceTypingMessage(action
, timestamp
, Optional
.of(groupId
.serialize()));
655 final var result
= context
.getSendHelper().sendGroupTypingMessage(message
, groupId
);
656 results
.put(recipient
, result
.stream().map(this::toSendMessageResult
).toList());
659 return new SendMessageResults(timestamp
, results
);
663 public SendMessageResults
sendTypingMessage(
664 TypingAction action
, Set
<RecipientIdentifier
> recipients
665 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
666 return sendTypingMessage(action
.toSignalService(), recipients
);
670 public SendMessageResults
sendReadReceipt(
671 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
673 final var timestamp
= System
.currentTimeMillis();
674 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
678 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
682 public SendMessageResults
sendViewedReceipt(
683 RecipientIdentifier
.Single sender
, List
<Long
> messageIds
685 final var timestamp
= System
.currentTimeMillis();
686 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
690 return sendReceiptMessage(sender
, timestamp
, receiptMessage
);
693 private SendMessageResults
sendReceiptMessage(
694 final RecipientIdentifier
.Single sender
,
695 final long timestamp
,
696 final SignalServiceReceiptMessage receiptMessage
699 final var result
= context
.getSendHelper()
700 .sendReceiptMessage(receiptMessage
, context
.getRecipientHelper().resolveRecipient(sender
));
701 return new SendMessageResults(timestamp
, Map
.of(sender
, List
.of(toSendMessageResult(result
))));
702 } catch (UnregisteredRecipientException e
) {
703 return new SendMessageResults(timestamp
,
704 Map
.of(sender
, List
.of(SendMessageResult
.unregisteredFailure(sender
.toPartialRecipientAddress()))));
709 public SendMessageResults
sendMessage(
710 Message message
, Set
<RecipientIdentifier
> recipients
, boolean notifySelf
711 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
712 final var selfProfile
= context
.getProfileHelper().getSelfProfile();
713 if (selfProfile
== null || selfProfile
.getDisplayName().isEmpty()) {
715 "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.");
717 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
718 applyMessage(messageBuilder
, message
);
719 return sendMessage(messageBuilder
, recipients
, notifySelf
);
723 public SendMessageResults
sendEditMessage(
724 Message message
, Set
<RecipientIdentifier
> recipients
, long editTargetTimestamp
725 ) throws IOException
, AttachmentInvalidException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
, InvalidStickerException
{
726 final var messageBuilder
= SignalServiceDataMessage
.newBuilder();
727 applyMessage(messageBuilder
, message
);
728 return sendMessage(messageBuilder
, recipients
, false, Optional
.of(editTargetTimestamp
));
731 private void applyMessage(
732 final SignalServiceDataMessage
.Builder messageBuilder
, final Message message
733 ) throws AttachmentInvalidException
, IOException
, UnregisteredRecipientException
, InvalidStickerException
{
734 if (message
.messageText().length() > 2000) {
735 final var messageBytes
= message
.messageText().getBytes(StandardCharsets
.UTF_8
);
736 final var textAttachment
= AttachmentUtils
.createAttachmentStream(new StreamDetails(new ByteArrayInputStream(
737 messageBytes
), MimeUtils
.LONG_TEXT
, messageBytes
.length
), Optional
.empty());
738 messageBuilder
.withBody(message
.messageText().substring(0, 2000));
739 messageBuilder
.withAttachment(context
.getAttachmentHelper().uploadAttachment(textAttachment
));
741 messageBuilder
.withBody(message
.messageText());
743 if (!message
.attachments().isEmpty()) {
744 messageBuilder
.withAttachments(context
.getAttachmentHelper().uploadAttachments(message
.attachments()));
746 if (!message
.mentions().isEmpty()) {
747 messageBuilder
.withMentions(resolveMentions(message
.mentions()));
749 if (!message
.textStyles().isEmpty()) {
750 messageBuilder
.withBodyRanges(message
.textStyles().stream().map(TextStyle
::toBodyRange
).toList());
752 if (message
.quote().isPresent()) {
753 final var quote
= message
.quote().get();
754 final var quotedAttachments
= new ArrayList
<SignalServiceDataMessage
.Quote
.QuotedAttachment
>();
755 for (final var a
: quote
.attachments()) {
756 final var quotedAttachment
= new SignalServiceDataMessage
.Quote
.QuotedAttachment(a
.contentType(),
758 a
.preview() == null ?
null : context
.getAttachmentHelper().uploadAttachment(a
.preview()));
759 quotedAttachments
.add(quotedAttachment
);
761 messageBuilder
.withQuote(new SignalServiceDataMessage
.Quote(quote
.timestamp(),
762 context
.getRecipientHelper()
763 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(quote
.author()))
767 resolveMentions(quote
.mentions()),
768 SignalServiceDataMessage
.Quote
.Type
.NORMAL
,
769 quote
.textStyles().stream().map(TextStyle
::toBodyRange
).toList()));
771 if (message
.sticker().isPresent()) {
772 final var sticker
= message
.sticker().get();
773 final var packId
= StickerPackId
.deserialize(sticker
.packId());
774 final var stickerId
= sticker
.stickerId();
776 final var stickerPack
= context
.getAccount().getStickerStore().getStickerPack(packId
);
777 if (stickerPack
== null) {
778 throw new InvalidStickerException("Sticker pack not found");
780 final var manifest
= context
.getStickerHelper().getOrRetrieveStickerPack(packId
, stickerPack
.packKey());
781 if (manifest
.stickers().size() <= stickerId
) {
782 throw new InvalidStickerException("Sticker id not part of this pack");
784 final var manifestSticker
= manifest
.stickers().get(stickerId
);
785 final var streamDetails
= context
.getStickerPackStore().retrieveSticker(packId
, stickerId
);
786 if (streamDetails
== null) {
787 throw new InvalidStickerException("Missing local sticker file");
789 messageBuilder
.withSticker(new SignalServiceDataMessage
.Sticker(packId
.serialize(),
790 stickerPack
.packKey(),
792 manifestSticker
.emoji(),
793 AttachmentUtils
.createAttachmentStream(streamDetails
, Optional
.empty())));
795 if (!message
.previews().isEmpty()) {
796 final var previews
= new ArrayList
<SignalServicePreview
>(message
.previews().size());
797 for (final var p
: message
.previews()) {
798 final var image
= p
.image().isPresent() ? context
.getAttachmentHelper()
799 .uploadAttachment(p
.image().get()) : null;
800 previews
.add(new SignalServicePreview(p
.url(),
804 Optional
.ofNullable(image
)));
806 messageBuilder
.withPreviews(previews
);
808 if (message
.storyReply().isPresent()) {
809 final var storyReply
= message
.storyReply().get();
810 final var authorServiceId
= context
.getRecipientHelper()
811 .resolveSignalServiceAddress(context
.getRecipientHelper().resolveRecipient(storyReply
.author()))
813 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
814 storyReply
.timestamp()));
818 private ArrayList
<SignalServiceDataMessage
.Mention
> resolveMentions(final List
<Message
.Mention
> mentionList
) throws UnregisteredRecipientException
{
819 final var mentions
= new ArrayList
<SignalServiceDataMessage
.Mention
>();
820 for (final var m
: mentionList
) {
821 final var recipientId
= context
.getRecipientHelper().resolveRecipient(m
.recipient());
822 mentions
.add(new SignalServiceDataMessage
.Mention(context
.getRecipientHelper()
823 .resolveSignalServiceAddress(recipientId
)
824 .getServiceId(), m
.start(), m
.length()));
830 public SendMessageResults
sendRemoteDeleteMessage(
831 long targetSentTimestamp
, Set
<RecipientIdentifier
> recipients
832 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
{
833 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
834 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
835 for (final var recipient
: recipients
) {
836 if (recipient
instanceof RecipientIdentifier
.Uuid u
) {
837 account
.getMessageSendLogStore()
838 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, ACI
.from(u
.uuid()));
839 } else if (recipient
instanceof RecipientIdentifier
.Single r
) {
841 final var recipientId
= context
.getRecipientHelper().resolveRecipient(r
);
842 final var address
= account
.getRecipientAddressResolver().resolveRecipientAddress(recipientId
);
843 if (address
.serviceId().isPresent()) {
844 account
.getMessageSendLogStore()
845 .deleteEntryForRecipientNonGroup(targetSentTimestamp
, address
.serviceId().get());
847 } catch (UnregisteredRecipientException ignored
) {
849 } else if (recipient
instanceof RecipientIdentifier
.Group r
) {
850 account
.getMessageSendLogStore().deleteEntryForGroup(targetSentTimestamp
, r
.groupId());
853 return sendMessage(messageBuilder
, recipients
, false);
857 public SendMessageResults
sendMessageReaction(
860 RecipientIdentifier
.Single targetAuthor
,
861 long targetSentTimestamp
,
862 Set
<RecipientIdentifier
> recipients
,
863 final boolean isStory
864 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, GroupSendingNotAllowedException
, UnregisteredRecipientException
{
865 var targetAuthorRecipientId
= context
.getRecipientHelper().resolveRecipient(targetAuthor
);
866 final var authorServiceId
= context
.getRecipientHelper()
867 .resolveSignalServiceAddress(targetAuthorRecipientId
)
869 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
, remove
, authorServiceId
, targetSentTimestamp
);
870 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
872 messageBuilder
.withStoryContext(new SignalServiceDataMessage
.StoryContext(authorServiceId
,
873 targetSentTimestamp
));
875 return sendMessage(messageBuilder
, recipients
, false);
879 public SendMessageResults
sendPaymentNotificationMessage(
880 byte[] receipt
, String note
, RecipientIdentifier
.Single recipient
881 ) throws IOException
{
882 final var paymentNotification
= new SignalServiceDataMessage
.PaymentNotification(receipt
, note
);
883 final var payment
= new SignalServiceDataMessage
.Payment(paymentNotification
, null);
884 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withPayment(payment
);
886 return sendMessage(messageBuilder
, Set
.of(recipient
), false);
887 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
888 throw new AssertionError(e
);
893 public SendMessageResults
sendEndSessionMessage(Set
<RecipientIdentifier
.Single
> recipients
) throws IOException
{
894 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
897 return sendMessage(messageBuilder
,
898 recipients
.stream().map(RecipientIdentifier
.class::cast
).collect(Collectors
.toSet()),
900 } catch (GroupNotFoundException
| NotAGroupMemberException
| GroupSendingNotAllowedException e
) {
901 throw new AssertionError(e
);
903 for (var recipient
: recipients
) {
904 final RecipientId recipientId
;
906 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
907 } catch (UnregisteredRecipientException e
) {
910 final var serviceId
= context
.getAccount()
911 .getRecipientAddressResolver()
912 .resolveRecipientAddress(recipientId
)
914 if (serviceId
.isPresent()) {
915 account
.getAccountData(ServiceIdType
.ACI
).getSessionStore().deleteAllSessions(serviceId
.get());
922 public SendMessageResults
sendMessageRequestResponse(
923 final MessageRequestResponse
.Type type
, final Set
<RecipientIdentifier
> recipients
925 var results
= new HashMap
<RecipientIdentifier
, List
<SendMessageResult
>>();
926 for (final var recipient
: recipients
) {
927 if (recipient
instanceof RecipientIdentifier
.NoteToSelf
|| (
928 recipient
instanceof RecipientIdentifier
.Single single
929 && new RecipientAddress(single
.toPartialRecipientAddress()).matches(account
.getSelfRecipientAddress())
931 final var result
= context
.getSyncHelper()
932 .sendMessageRequestResponse(type
, account
.getSelfRecipientId());
933 if (result
!= null) {
934 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
936 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
937 } else if (recipient
instanceof RecipientIdentifier
.Single single
) {
939 final var recipientId
= context
.getRecipientHelper().resolveRecipient(single
);
940 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, recipientId
);
941 if (result
!= null) {
942 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
944 } catch (UnregisteredRecipientException e
) {
945 results
.put(recipient
,
946 List
.of(SendMessageResult
.unregisteredFailure(single
.toPartialRecipientAddress())));
948 } else if (recipient
instanceof RecipientIdentifier
.Group group
) {
949 final var result
= context
.getSyncHelper().sendMessageRequestResponse(type
, group
.groupId());
950 results
.put(recipient
, List
.of(toSendMessageResult(result
)));
953 return new SendMessageResults(0, results
);
957 public void hideRecipient(final RecipientIdentifier
.Single recipient
) {
958 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
959 if (recipientIdOptional
.isPresent()) {
960 context
.getContactHelper().setContactHidden(recipientIdOptional
.get(), true);
961 account
.removeRecipient(recipientIdOptional
.get());
967 public void deleteRecipient(final RecipientIdentifier
.Single recipient
) {
968 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
969 if (recipientIdOptional
.isPresent()) {
970 account
.removeRecipient(recipientIdOptional
.get());
976 public void deleteContact(final RecipientIdentifier
.Single recipient
) {
977 final var recipientIdOptional
= context
.getRecipientHelper().resolveRecipientOptional(recipient
);
978 if (recipientIdOptional
.isPresent()) {
979 account
.getContactStore().deleteContact(recipientIdOptional
.get());
985 public void setContactName(
986 RecipientIdentifier
.Single recipient
, String givenName
, final String familyName
987 ) throws NotPrimaryDeviceException
, UnregisteredRecipientException
{
988 if (!account
.isPrimaryDevice()) {
989 throw new NotPrimaryDeviceException();
991 context
.getContactHelper()
992 .setContactName(context
.getRecipientHelper().resolveRecipient(recipient
), givenName
, familyName
);
997 public void setContactsBlocked(
998 Collection
<RecipientIdentifier
.Single
> recipients
, boolean blocked
999 ) throws IOException
, UnregisteredRecipientException
{
1000 if (recipients
.isEmpty()) {
1003 final var recipientIds
= context
.getRecipientHelper().resolveRecipients(recipients
);
1004 final var selfRecipientId
= account
.getSelfRecipientId();
1005 boolean shouldRotateProfileKey
= false;
1006 for (final var recipientId
: recipientIds
) {
1007 if (context
.getContactHelper().isContactBlocked(recipientId
) == blocked
) {
1010 context
.getContactHelper().setContactBlocked(recipientId
, blocked
);
1011 context
.getSyncHelper()
1012 .sendMessageRequestResponse(blocked
1013 ? MessageRequestResponse
.Type
.BLOCK
1014 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, recipientId
);
1015 // if we don't have a common group with the blocked contact we need to rotate the profile key
1016 shouldRotateProfileKey
= blocked
&& (
1017 shouldRotateProfileKey
|| account
.getGroupStore()
1020 .noneMatch(g
-> g
.isMember(selfRecipientId
) && g
.isMember(recipientId
))
1023 if (shouldRotateProfileKey
) {
1024 context
.getProfileHelper().rotateProfileKey();
1026 context
.getSyncHelper().sendBlockedList();
1027 syncRemoteStorage();
1031 public void setGroupsBlocked(
1032 final Collection
<GroupId
> groupIds
, final boolean blocked
1033 ) throws GroupNotFoundException
, IOException
{
1034 if (groupIds
.isEmpty()) {
1037 boolean shouldRotateProfileKey
= false;
1038 for (final var groupId
: groupIds
) {
1039 if (context
.getGroupHelper().isGroupBlocked(groupId
) == blocked
) {
1042 context
.getGroupHelper().setGroupBlocked(groupId
, blocked
);
1043 context
.getSyncHelper()
1044 .sendMessageRequestResponse(blocked
1045 ? MessageRequestResponse
.Type
.BLOCK
1046 : MessageRequestResponse
.Type
.UNBLOCK_AND_ACCEPT
, groupId
);
1047 shouldRotateProfileKey
= blocked
;
1049 if (shouldRotateProfileKey
) {
1050 context
.getProfileHelper().rotateProfileKey();
1052 context
.getSyncHelper().sendBlockedList();
1053 syncRemoteStorage();
1057 public void setExpirationTimer(
1058 RecipientIdentifier
.Single recipient
, int messageExpirationTimer
1059 ) throws IOException
, UnregisteredRecipientException
{
1060 var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1061 context
.getContactHelper().setExpirationTimer(recipientId
, messageExpirationTimer
);
1062 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1064 sendMessage(messageBuilder
, Set
.of(recipient
), false);
1065 } catch (NotAGroupMemberException
| GroupNotFoundException
| GroupSendingNotAllowedException e
) {
1066 throw new AssertionError(e
);
1068 syncRemoteStorage();
1072 public StickerPackUrl
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1073 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1075 var messageSender
= dependencies
.getMessageSender();
1077 var packKey
= KeyUtils
.createStickerUploadKey();
1078 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1079 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1081 var sticker
= new StickerPack(packId
, packKey
);
1082 account
.getStickerStore().addStickerPack(sticker
);
1083 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1085 return new StickerPackUrl(packId
, packKey
);
1089 public void installStickerPack(StickerPackUrl url
) throws IOException
{
1090 final var packId
= url
.packId();
1091 final var packKey
= url
.packKey();
1093 context
.getStickerHelper().retrieveStickerPack(packId
, packKey
);
1094 } catch (InvalidMessageException e
) {
1095 throw new IOException(e
);
1098 final var sticker
= context
.getStickerHelper().addOrUpdateStickerPack(packId
, packKey
, true);
1099 context
.getSyncHelper().sendStickerOperationsMessage(List
.of(sticker
), List
.of());
1103 public List
<org
.asamk
.signal
.manager
.api
.StickerPack
> getStickerPacks() {
1104 final var stickerPackStore
= context
.getStickerPackStore();
1105 return account
.getStickerStore().getStickerPacks().stream().map(pack
-> {
1106 if (stickerPackStore
.existsStickerPack(pack
.packId())) {
1108 final var manifest
= stickerPackStore
.retrieveManifest(pack
.packId());
1109 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(),
1110 new StickerPackUrl(pack
.packId(), pack
.packKey()),
1114 Optional
.ofNullable(manifest
.cover() == null ?
null : manifest
.cover().toApi()),
1115 manifest
.stickers().stream().map(JsonStickerPack
.JsonSticker
::toApi
).toList());
1116 } catch (Exception e
) {
1117 logger
.warn("Failed to read local sticker pack manifest: {}", e
.getMessage(), e
);
1121 return new org
.asamk
.signal
.manager
.api
.StickerPack(pack
.packId(), pack
.packKey(), pack
.isInstalled());
1126 public void requestAllSyncData() {
1127 context
.getSyncHelper().requestAllSyncData();
1128 syncRemoteStorage();
1131 void syncRemoteStorage() {
1132 context
.getJobExecutor().enqueueJob(new SyncStorageJob());
1136 public void addReceiveHandler(final ReceiveMessageHandler handler
, final boolean isWeakListener
) {
1137 synchronized (messageHandlers
) {
1138 if (isWeakListener
) {
1139 weakHandlers
.add(handler
);
1141 messageHandlers
.add(handler
);
1142 startReceiveThreadIfRequired();
1147 private static final AtomicInteger threadNumber
= new AtomicInteger(0);
1149 private void startReceiveThreadIfRequired() {
1150 if (receiveThread
!= null || isReceivingSynchronous
) {
1153 receiveThread
= Thread
.ofPlatform().name("receive-" + threadNumber
.getAndIncrement()).start(() -> {
1154 logger
.debug("Starting receiving messages");
1155 context
.getReceiveHelper().receiveMessagesContinuously(this::passReceivedMessageToHandlers
);
1156 logger
.debug("Finished receiving messages");
1157 synchronized (messageHandlers
) {
1158 receiveThread
= null;
1160 // Check if in the meantime another handler has been registered
1161 if (!messageHandlers
.isEmpty()) {
1162 logger
.debug("Another handler has been registered, starting receive thread again");
1163 startReceiveThreadIfRequired();
1169 private void passReceivedMessageToHandlers(MessageEnvelope envelope
, Throwable e
) {
1170 synchronized (messageHandlers
) {
1171 Stream
.concat(messageHandlers
.stream(), weakHandlers
.stream()).forEach(h
-> {
1173 h
.handleMessage(envelope
, e
);
1174 } catch (Throwable ex
) {
1175 logger
.warn("Message handler failed, ignoring", ex
);
1182 public void removeReceiveHandler(final ReceiveMessageHandler handler
) {
1183 final Thread thread
;
1184 synchronized (messageHandlers
) {
1185 weakHandlers
.remove(handler
);
1186 messageHandlers
.remove(handler
);
1187 if (!messageHandlers
.isEmpty() || receiveThread
== null || isReceivingSynchronous
) {
1190 thread
= receiveThread
;
1191 receiveThread
= null;
1194 stopReceiveThread(thread
);
1197 private void stopReceiveThread(final Thread thread
) {
1198 if (context
.getReceiveHelper().requestStopReceiveMessages()) {
1199 logger
.debug("Receive stop requested, interrupting read from server.");
1204 } catch (InterruptedException ignored
) {
1209 public boolean isReceiving() {
1210 if (isReceivingSynchronous
) {
1213 synchronized (messageHandlers
) {
1214 return !messageHandlers
.isEmpty();
1219 public void receiveMessages(
1220 Optional
<Duration
> timeout
, Optional
<Integer
> maxMessages
, ReceiveMessageHandler handler
1221 ) throws IOException
, AlreadyReceivingException
{
1222 receiveMessages(timeout
.orElse(Duration
.ofMinutes(1)), timeout
.isPresent(), maxMessages
.orElse(null), handler
);
1226 public void stopReceiveMessages() {
1227 Thread thread
= null;
1228 synchronized (messageHandlers
) {
1229 if (isReceivingSynchronous
) {
1230 thread
= receiveThread
;
1231 receiveThread
= null;
1234 if (thread
!= null) {
1235 stopReceiveThread(thread
);
1239 private void receiveMessages(
1240 Duration timeout
, boolean returnOnTimeout
, Integer maxMessages
, ReceiveMessageHandler handler
1241 ) throws IOException
, AlreadyReceivingException
{
1242 synchronized (messageHandlers
) {
1243 if (isReceiving()) {
1244 throw new AlreadyReceivingException("Already receiving message.");
1246 isReceivingSynchronous
= true;
1247 receiveThread
= Thread
.currentThread();
1250 context
.getReceiveHelper().receiveMessages(timeout
, returnOnTimeout
, maxMessages
, (envelope
, e
) -> {
1251 passReceivedMessageToHandlers(envelope
, e
);
1252 handler
.handleMessage(envelope
, e
);
1255 synchronized (messageHandlers
) {
1256 receiveThread
= null;
1257 isReceivingSynchronous
= false;
1258 if (!messageHandlers
.isEmpty()) {
1259 startReceiveThreadIfRequired();
1266 public void setReceiveConfig(final ReceiveConfig receiveConfig
) {
1267 context
.getReceiveHelper().setReceiveConfig(receiveConfig
);
1271 public boolean isContactBlocked(final RecipientIdentifier
.Single recipient
) {
1272 final RecipientId recipientId
;
1274 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1275 } catch (UnregisteredRecipientException e
) {
1278 return context
.getContactHelper().isContactBlocked(recipientId
);
1282 public void sendContacts() throws IOException
{
1283 context
.getSyncHelper().sendContacts();
1287 public List
<Recipient
> getRecipients(
1288 boolean onlyContacts
,
1289 Optional
<Boolean
> blocked
,
1290 Collection
<RecipientIdentifier
.Single
> recipients
,
1291 Optional
<String
> name
1293 final var recipientIds
= recipients
.stream().map(a
-> {
1295 return context
.getRecipientHelper().resolveRecipient(a
);
1296 } catch (UnregisteredRecipientException e
) {
1299 }).filter(Objects
::nonNull
).collect(Collectors
.toSet());
1300 if (!recipients
.isEmpty() && recipientIds
.isEmpty()) {
1303 // refresh profiles of explicitly given recipients
1304 context
.getProfileHelper().refreshRecipientProfiles(recipientIds
);
1305 return account
.getRecipientStore()
1306 .getRecipients(onlyContacts
, blocked
, recipientIds
, name
)
1308 .map(s
-> new Recipient(s
.getRecipientId(),
1309 s
.getAddress().toApiRecipientAddress(),
1312 s
.getExpiringProfileKeyCredential(),
1314 s
.getDiscoverable()))
1319 public String
getContactOrProfileName(RecipientIdentifier
.Single recipient
) {
1320 final RecipientId recipientId
;
1322 recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1323 } catch (UnregisteredRecipientException e
) {
1327 final var contact
= account
.getContactStore().getContact(recipientId
);
1328 if (contact
!= null && !Util
.isEmpty(contact
.getName())) {
1329 return contact
.getName();
1332 final var profile
= context
.getProfileHelper().getRecipientProfile(recipientId
);
1333 if (profile
!= null) {
1334 return profile
.getDisplayName();
1341 public Group
getGroup(GroupId groupId
) {
1342 return toGroup(context
.getGroupHelper().getGroup(groupId
));
1346 public List
<Identity
> getIdentities() {
1347 return account
.getIdentityKeyStore()
1350 .map(this::toIdentity
)
1351 .filter(Objects
::nonNull
)
1355 private Identity
toIdentity(final IdentityInfo identityInfo
) {
1356 if (identityInfo
== null) {
1360 final var address
= account
.getRecipientAddressResolver()
1361 .resolveRecipientAddress(account
.getRecipientResolver().resolveRecipient(identityInfo
.getServiceId()));
1362 if (address
.serviceId().isPresent() && !Objects
.equals(address
.serviceId().get(),
1363 identityInfo
.getServiceId())) {
1366 final var scannableFingerprint
= context
.getIdentityHelper()
1367 .computeSafetyNumberForScanning(identityInfo
.getServiceId(), identityInfo
.getIdentityKey());
1368 return new Identity(address
.toApiRecipientAddress(),
1369 identityInfo
.getIdentityKey(),
1370 context
.getIdentityHelper()
1371 .computeSafetyNumber(identityInfo
.getServiceId(), identityInfo
.getIdentityKey()),
1372 scannableFingerprint
== null ?
null : scannableFingerprint
.getSerialized(),
1373 identityInfo
.getTrustLevel(),
1374 identityInfo
.getDateAddedTimestamp());
1378 public List
<Identity
> getIdentities(RecipientIdentifier
.Single recipient
) {
1379 ServiceId serviceId
;
1381 final var address
= account
.getRecipientAddressResolver()
1382 .resolveRecipientAddress(context
.getRecipientHelper().resolveRecipient(recipient
));
1383 if (address
.serviceId().isEmpty()) {
1386 serviceId
= address
.serviceId().get();
1387 } catch (UnregisteredRecipientException e
) {
1390 final var identity
= account
.getIdentityKeyStore().getIdentityInfo(serviceId
);
1391 return identity
== null ? List
.of() : List
.of(toIdentity(identity
));
1395 public boolean trustIdentityVerified(
1396 RecipientIdentifier
.Single recipient
, IdentityVerificationCode verificationCode
1397 ) throws UnregisteredRecipientException
{
1398 return switch (verificationCode
) {
1399 case IdentityVerificationCode
.Fingerprint fingerprint
-> trustIdentity(recipient
,
1400 r
-> context
.getIdentityHelper().trustIdentityVerified(r
, fingerprint
.fingerprint()));
1401 case IdentityVerificationCode
.SafetyNumber safetyNumber
-> trustIdentity(recipient
,
1402 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1403 case IdentityVerificationCode
.ScannableSafetyNumber safetyNumber
-> trustIdentity(recipient
,
1404 r
-> context
.getIdentityHelper().trustIdentityVerifiedSafetyNumber(r
, safetyNumber
.safetyNumber()));
1405 case null -> throw new AssertionError("Invalid verification code type");
1410 public boolean trustIdentityAllKeys(RecipientIdentifier
.Single recipient
) throws UnregisteredRecipientException
{
1411 return trustIdentity(recipient
, r
-> context
.getIdentityHelper().trustIdentityAllKeys(r
));
1414 private boolean trustIdentity(
1415 RecipientIdentifier
.Single recipient
, Function
<RecipientId
, Boolean
> trustMethod
1416 ) throws UnregisteredRecipientException
{
1417 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1418 final var updated
= trustMethod
.apply(recipientId
);
1419 if (updated
&& this.isReceiving()) {
1420 account
.setNeedsToRetryFailedMessages(true);
1426 public void addAddressChangedListener(final Runnable listener
) {
1427 synchronized (addressChangedListeners
) {
1428 addressChangedListeners
.add(listener
);
1433 public void addClosedListener(final Runnable listener
) {
1434 synchronized (closedListeners
) {
1435 closedListeners
.add(listener
);
1440 public InputStream
retrieveAttachment(final String id
) throws IOException
{
1441 return context
.getAttachmentHelper().retrieveAttachment(id
).getStream();
1445 public InputStream
retrieveContactAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1446 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1447 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1448 final var streamDetails
= context
.getAvatarStore().retrieveContactAvatar(address
);
1449 if (streamDetails
== null) {
1450 throw new FileNotFoundException();
1452 return streamDetails
.getStream();
1456 public InputStream
retrieveProfileAvatar(final RecipientIdentifier
.Single recipient
) throws IOException
, UnregisteredRecipientException
{
1457 final var recipientId
= context
.getRecipientHelper().resolveRecipient(recipient
);
1458 context
.getProfileHelper().getRecipientProfile(recipientId
);
1459 final var address
= account
.getRecipientStore().resolveRecipientAddress(recipientId
);
1460 final var streamDetails
= context
.getAvatarStore().retrieveProfileAvatar(address
);
1461 if (streamDetails
== null) {
1462 throw new FileNotFoundException();
1464 return streamDetails
.getStream();
1468 public InputStream
retrieveGroupAvatar(final GroupId groupId
) throws IOException
{
1469 final var streamDetails
= context
.getAvatarStore().retrieveGroupAvatar(groupId
);
1470 context
.getGroupHelper().getGroup(groupId
);
1471 if (streamDetails
== null) {
1472 throw new FileNotFoundException();
1474 return streamDetails
.getStream();
1478 public InputStream
retrieveSticker(final StickerPackId stickerPackId
, final int stickerId
) throws IOException
{
1479 var streamDetails
= context
.getStickerPackStore().retrieveSticker(stickerPackId
, stickerId
);
1480 if (streamDetails
== null) {
1481 final var pack
= account
.getStickerStore().getStickerPack(stickerPackId
);
1484 context
.getStickerHelper().retrieveStickerPack(stickerPackId
, pack
.packKey());
1485 } catch (InvalidMessageException e
) {
1486 logger
.warn("Failed to download sticker pack");
1490 if (streamDetails
== null) {
1491 throw new FileNotFoundException();
1493 return streamDetails
.getStream();
1497 public void close() {
1499 synchronized (messageHandlers
) {
1500 weakHandlers
.clear();
1501 messageHandlers
.clear();
1502 thread
= receiveThread
;
1503 receiveThread
= null;
1505 if (thread
!= null) {
1506 stopReceiveThread(thread
);
1511 dependencies
.getSignalWebSocket().disconnect();
1512 dependencies
.getPushServiceSocket().close();
1513 disposable
.dispose();
1515 if (account
!= null) {
1519 synchronized (closedListeners
) {
1520 closedListeners
.forEach(Runnable
::run
);
1521 closedListeners
.clear();