1 package org
.asamk
.signal
.manager
.storage
.recipients
;
3 import org
.asamk
.signal
.manager
.api
.Contact
;
4 import org
.asamk
.signal
.manager
.api
.Pair
;
5 import org
.asamk
.signal
.manager
.api
.Profile
;
6 import org
.asamk
.signal
.manager
.api
.UnregisteredRecipientException
;
7 import org
.asamk
.signal
.manager
.storage
.Database
;
8 import org
.asamk
.signal
.manager
.storage
.Utils
;
9 import org
.asamk
.signal
.manager
.storage
.contacts
.ContactsStore
;
10 import org
.asamk
.signal
.manager
.storage
.profiles
.ProfileStore
;
11 import org
.signal
.libsignal
.zkgroup
.InvalidInputException
;
12 import org
.signal
.libsignal
.zkgroup
.profiles
.ExpiringProfileKeyCredential
;
13 import org
.signal
.libsignal
.zkgroup
.profiles
.ProfileKey
;
14 import org
.slf4j
.Logger
;
15 import org
.slf4j
.LoggerFactory
;
16 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
;
17 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.ACI
;
18 import org
.whispersystems
.signalservice
.api
.push
.ServiceId
.PNI
;
19 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
20 import org
.whispersystems
.signalservice
.api
.util
.UuidUtil
;
22 import java
.sql
.Connection
;
23 import java
.sql
.ResultSet
;
24 import java
.sql
.SQLException
;
25 import java
.util
.ArrayList
;
26 import java
.util
.Arrays
;
27 import java
.util
.Collection
;
28 import java
.util
.HashMap
;
29 import java
.util
.List
;
31 import java
.util
.Objects
;
32 import java
.util
.Optional
;
34 import java
.util
.function
.Supplier
;
35 import java
.util
.stream
.Collectors
;
37 public class RecipientStore
implements RecipientIdCreator
, RecipientResolver
, RecipientTrustedResolver
, ContactsStore
, ProfileStore
{
39 private final static Logger logger
= LoggerFactory
.getLogger(RecipientStore
.class);
40 private static final String TABLE_RECIPIENT
= "recipient";
41 private static final String SQL_IS_CONTACT
= "r.given_name IS NOT NULL OR r.family_name IS NOT NULL OR r.expiration_time > 0 OR r.profile_sharing = TRUE OR r.color IS NOT NULL OR r.blocked = TRUE OR r.archived = TRUE";
43 private final RecipientMergeHandler recipientMergeHandler
;
44 private final SelfAddressProvider selfAddressProvider
;
45 private final Database database
;
47 private final Object recipientsLock
= new Object();
48 private final Map
<Long
, Long
> recipientsMerged
= new HashMap
<>();
50 private final Map
<ServiceId
, RecipientWithAddress
> recipientAddressCache
= new HashMap
<>();
52 public static void createSql(Connection connection
) throws SQLException
{
53 // When modifying the CREATE statement here, also add a migration in AccountDatabase.java
54 try (final var statement
= connection
.createStatement()) {
55 statement
.executeUpdate("""
56 CREATE TABLE recipient (
57 _id INTEGER PRIMARY KEY AUTOINCREMENT,
63 profile_key_credential BLOB,
69 expiration_time INTEGER NOT NULL DEFAULT 0,
70 blocked INTEGER NOT NULL DEFAULT FALSE,
71 archived INTEGER NOT NULL DEFAULT FALSE,
72 profile_sharing INTEGER NOT NULL DEFAULT FALSE,
74 profile_last_update_timestamp INTEGER NOT NULL DEFAULT 0,
75 profile_given_name TEXT,
76 profile_family_name TEXT,
78 profile_about_emoji TEXT,
79 profile_avatar_url_path TEXT,
80 profile_mobile_coin_address BLOB,
81 profile_unidentified_access_mode TEXT,
82 profile_capabilities TEXT
88 public RecipientStore(
89 final RecipientMergeHandler recipientMergeHandler
,
90 final SelfAddressProvider selfAddressProvider
,
91 final Database database
93 this.recipientMergeHandler
= recipientMergeHandler
;
94 this.selfAddressProvider
= selfAddressProvider
;
95 this.database
= database
;
98 public RecipientAddress
resolveRecipientAddress(RecipientId recipientId
) {
101 SELECT r.number, r.uuid, r.pni, r.username
105 ).formatted(TABLE_RECIPIENT
);
106 try (final var connection
= database
.getConnection()) {
107 try (final var statement
= connection
.prepareStatement(sql
)) {
108 statement
.setLong(1, recipientId
.id());
109 return Utils
.executeQuerySingleRow(statement
, this::getRecipientAddressFromResultSet
);
111 } catch (SQLException e
) {
112 throw new RuntimeException("Failed read from recipient store", e
);
116 public Collection
<RecipientId
> getRecipientIdsWithEnabledProfileSharing() {
121 WHERE r.blocked = FALSE AND r.profile_sharing = TRUE
123 ).formatted(TABLE_RECIPIENT
);
124 try (final var connection
= database
.getConnection()) {
125 try (final var statement
= connection
.prepareStatement(sql
)) {
126 try (var result
= Utils
.executeQueryForStream(statement
, this::getRecipientIdFromResultSet
)) {
127 return result
.toList();
130 } catch (SQLException e
) {
131 throw new RuntimeException("Failed read from recipient store", e
);
136 public RecipientId
resolveRecipient(final long rawRecipientId
) {
143 ).formatted(TABLE_RECIPIENT
);
144 try (final var connection
= database
.getConnection()) {
145 try (final var statement
= connection
.prepareStatement(sql
)) {
146 statement
.setLong(1, rawRecipientId
);
147 return Utils
.executeQueryForOptional(statement
, this::getRecipientIdFromResultSet
).orElse(null);
149 } catch (SQLException e
) {
150 throw new RuntimeException("Failed read from recipient store", e
);
155 public RecipientId
resolveRecipient(final String identifier
) {
156 final var serviceId
= ServiceId
.parseOrNull(identifier
);
157 if (serviceId
!= null) {
158 return resolveRecipient(serviceId
);
160 return resolveRecipientByNumber(identifier
);
164 private RecipientId
resolveRecipientByNumber(final String number
) {
165 synchronized (recipientsLock
) {
166 final RecipientId recipientId
;
167 try (final var connection
= database
.getConnection()) {
168 connection
.setAutoCommit(false);
169 recipientId
= resolveRecipientLocked(connection
, number
);
171 } catch (SQLException e
) {
172 throw new RuntimeException("Failed read recipient store", e
);
179 public RecipientId
resolveRecipient(final ServiceId serviceId
) {
180 synchronized (recipientsLock
) {
181 final var recipientWithAddress
= recipientAddressCache
.get(serviceId
);
182 if (recipientWithAddress
!= null) {
183 return recipientWithAddress
.id();
185 try (final var connection
= database
.getConnection()) {
186 connection
.setAutoCommit(false);
187 final var recipientId
= resolveRecipientLocked(connection
, serviceId
);
190 } catch (SQLException e
) {
191 throw new RuntimeException("Failed read recipient store", e
);
197 * Should only be used for recipientIds from the database.
198 * Where the foreign key relations ensure a valid recipientId.
201 public RecipientId
create(final long recipientId
) {
202 return new RecipientId(recipientId
, this);
205 public RecipientId
resolveRecipientByNumber(
206 final String number
, Supplier
<ServiceId
> serviceIdSupplier
207 ) throws UnregisteredRecipientException
{
208 final Optional
<RecipientWithAddress
> byNumber
;
209 try (final var connection
= database
.getConnection()) {
210 byNumber
= findByNumber(connection
, number
);
211 } catch (SQLException e
) {
212 throw new RuntimeException("Failed read from recipient store", e
);
214 if (byNumber
.isEmpty() || byNumber
.get().address().serviceId().isEmpty()) {
215 final var serviceId
= serviceIdSupplier
.get();
216 if (serviceId
== null) {
217 throw new UnregisteredRecipientException(new org
.asamk
.signal
.manager
.api
.RecipientAddress(null,
221 return resolveRecipient(serviceId
);
223 return byNumber
.get().id();
226 public Optional
<RecipientId
> resolveRecipientByNumberOptional(final String number
) {
227 final Optional
<RecipientWithAddress
> byNumber
;
228 try (final var connection
= database
.getConnection()) {
229 byNumber
= findByNumber(connection
, number
);
230 } catch (SQLException e
) {
231 throw new RuntimeException("Failed read from recipient store", e
);
233 return byNumber
.map(RecipientWithAddress
::id
);
236 public RecipientId
resolveRecipientByUsername(
237 final String username
, Supplier
<ACI
> aciSupplier
238 ) throws UnregisteredRecipientException
{
239 final Optional
<RecipientWithAddress
> byUsername
;
240 try (final var connection
= database
.getConnection()) {
241 byUsername
= findByUsername(connection
, username
);
242 } catch (SQLException e
) {
243 throw new RuntimeException("Failed read from recipient store", e
);
245 if (byUsername
.isEmpty() || byUsername
.get().address().serviceId().isEmpty()) {
246 final var aci
= aciSupplier
.get();
248 throw new UnregisteredRecipientException(new org
.asamk
.signal
.manager
.api
.RecipientAddress(null,
253 return resolveRecipientTrusted(aci
, username
);
255 return byUsername
.get().id();
258 public RecipientId
resolveRecipient(RecipientAddress address
) {
259 synchronized (recipientsLock
) {
260 final RecipientId recipientId
;
261 try (final var connection
= database
.getConnection()) {
262 connection
.setAutoCommit(false);
263 recipientId
= resolveRecipientLocked(connection
, address
);
265 } catch (SQLException e
) {
266 throw new RuntimeException("Failed read recipient store", e
);
273 public RecipientId
resolveSelfRecipientTrusted(RecipientAddress address
) {
274 return resolveRecipientTrusted(address
, true);
277 public RecipientId
resolveRecipientTrusted(RecipientAddress address
) {
278 return resolveRecipientTrusted(address
, false);
282 public RecipientId
resolveRecipientTrusted(SignalServiceAddress address
) {
283 return resolveRecipientTrusted(new RecipientAddress(address
), false);
287 public RecipientId
resolveRecipientTrusted(
288 final Optional
<ACI
> aci
, final Optional
<PNI
> pni
, final Optional
<String
> number
290 final var serviceId
= aci
.map(a
-> (ServiceId
) a
).or(() -> pni
);
291 return resolveRecipientTrusted(new RecipientAddress(serviceId
, pni
, number
, Optional
.empty()), false);
295 public RecipientId
resolveRecipientTrusted(final ACI aci
, final String username
) {
296 return resolveRecipientTrusted(new RecipientAddress(aci
, null, null, username
), false);
300 public void storeContact(RecipientId recipientId
, final Contact contact
) {
301 try (final var connection
= database
.getConnection()) {
302 storeContact(connection
, recipientId
, contact
);
303 } catch (SQLException e
) {
304 throw new RuntimeException("Failed update recipient store", e
);
309 public Contact
getContact(RecipientId recipientId
) {
310 try (final var connection
= database
.getConnection()) {
311 return getContact(connection
, recipientId
);
312 } catch (SQLException e
) {
313 throw new RuntimeException("Failed read from recipient store", e
);
318 public List
<Pair
<RecipientId
, Contact
>> getContacts() {
321 SELECT r._id, r.given_name, r.family_name, r.expiration_time, r.profile_sharing, r.color, r.blocked, r.archived
323 WHERE (r.number IS NOT NULL OR r.uuid IS NOT NULL) AND %s
325 ).formatted(TABLE_RECIPIENT
, SQL_IS_CONTACT
);
326 try (final var connection
= database
.getConnection()) {
327 try (final var statement
= connection
.prepareStatement(sql
)) {
328 try (var result
= Utils
.executeQueryForStream(statement
,
329 resultSet
-> new Pair
<>(getRecipientIdFromResultSet(resultSet
),
330 getContactFromResultSet(resultSet
)))) {
331 return result
.toList();
334 } catch (SQLException e
) {
335 throw new RuntimeException("Failed read from recipient store", e
);
339 public List
<Recipient
> getRecipients(
340 boolean onlyContacts
, Optional
<Boolean
> blocked
, Set
<RecipientId
> recipientIds
, Optional
<String
> name
342 final var sqlWhere
= new ArrayList
<String
>();
344 sqlWhere
.add("(" + SQL_IS_CONTACT
+ ")");
346 if (blocked
.isPresent()) {
347 sqlWhere
.add("r.blocked = ?");
349 if (!recipientIds
.isEmpty()) {
350 final var recipientIdsCommaSeparated
= recipientIds
.stream()
351 .map(recipientId
-> String
.valueOf(recipientId
.id()))
352 .collect(Collectors
.joining(","));
353 sqlWhere
.add("r._id IN (" + recipientIdsCommaSeparated
+ ")");
358 r.number, r.uuid, r.pni, r.username,
359 r.profile_key, r.profile_key_credential,
360 r.given_name, r.family_name, r.expiration_time, r.profile_sharing, r.color, r.blocked, r.archived,
361 r.profile_last_update_timestamp, r.profile_given_name, r.profile_family_name, r.profile_about, r.profile_about_emoji, r.profile_avatar_url_path, r.profile_mobile_coin_address, r.profile_unidentified_access_mode, r.profile_capabilities
363 WHERE (r.number IS NOT NULL OR r.uuid IS NOT NULL) AND %s
365 ).formatted(TABLE_RECIPIENT
, sqlWhere
.isEmpty() ?
"TRUE" : String
.join(" AND ", sqlWhere
));
366 try (final var connection
= database
.getConnection()) {
367 try (final var statement
= connection
.prepareStatement(sql
)) {
368 if (blocked
.isPresent()) {
369 statement
.setBoolean(1, blocked
.get());
371 try (var result
= Utils
.executeQueryForStream(statement
, this::getRecipientFromResultSet
)) {
372 return result
.filter(r
-> name
.isEmpty() || (
373 r
.getContact() != null && name
.get().equals(r
.getContact().getName())
374 ) || (r
.getProfile() != null && name
.get().equals(r
.getProfile().getDisplayName()))).toList();
377 } catch (SQLException e
) {
378 throw new RuntimeException("Failed read from recipient store", e
);
382 public Set
<String
> getAllNumbers() {
387 WHERE r.number IS NOT NULL
389 ).formatted(TABLE_RECIPIENT
);
390 try (final var connection
= database
.getConnection()) {
391 try (final var statement
= connection
.prepareStatement(sql
)) {
392 return Utils
.executeQueryForStream(statement
, resultSet
-> resultSet
.getString("number"))
393 .filter(Objects
::nonNull
)
398 } catch (NumberFormatException e
) {
402 .collect(Collectors
.toSet());
404 } catch (SQLException e
) {
405 throw new RuntimeException("Failed read from recipient store", e
);
409 public Map
<ServiceId
, ProfileKey
> getServiceIdToProfileKeyMap() {
412 SELECT r.uuid, r.profile_key
414 WHERE r.uuid IS NOT NULL AND r.profile_key IS NOT NULL
416 ).formatted(TABLE_RECIPIENT
);
417 try (final var connection
= database
.getConnection()) {
418 try (final var statement
= connection
.prepareStatement(sql
)) {
419 return Utils
.executeQueryForStream(statement
, resultSet
-> {
420 final var serviceId
= ServiceId
.parseOrThrow(resultSet
.getBytes("uuid"));
421 final var profileKey
= getProfileKeyFromResultSet(resultSet
);
422 return new Pair
<>(serviceId
, profileKey
);
423 }).filter(Objects
::nonNull
).collect(Collectors
.toMap(Pair
::first
, Pair
::second
));
425 } catch (SQLException e
) {
426 throw new RuntimeException("Failed read from recipient store", e
);
431 public void deleteContact(RecipientId recipientId
) {
432 storeContact(recipientId
, null);
435 public void deleteRecipientData(RecipientId recipientId
) {
436 logger
.debug("Deleting recipient data for {}", recipientId
);
437 synchronized (recipientsLock
) {
438 recipientAddressCache
.entrySet()
440 .filter(e
-> e
.getValue().id().equals(recipientId
))
441 .forEach(e
-> recipientAddressCache
.remove(e
.getKey()));
442 try (final var connection
= database
.getConnection()) {
443 connection
.setAutoCommit(false);
444 storeContact(connection
, recipientId
, null);
445 storeProfile(connection
, recipientId
, null);
446 storeProfileKey(connection
, recipientId
, null, false);
447 storeExpiringProfileKeyCredential(connection
, recipientId
, null);
448 deleteRecipient(connection
, recipientId
);
450 } catch (SQLException e
) {
451 throw new RuntimeException("Failed update recipient store", e
);
457 public Profile
getProfile(final RecipientId recipientId
) {
458 try (final var connection
= database
.getConnection()) {
459 return getProfile(connection
, recipientId
);
460 } catch (SQLException e
) {
461 throw new RuntimeException("Failed read from recipient store", e
);
466 public ProfileKey
getProfileKey(final RecipientId recipientId
) {
467 try (final var connection
= database
.getConnection()) {
468 return getProfileKey(connection
, recipientId
);
469 } catch (SQLException e
) {
470 throw new RuntimeException("Failed read from recipient store", e
);
475 public ExpiringProfileKeyCredential
getExpiringProfileKeyCredential(final RecipientId recipientId
) {
476 try (final var connection
= database
.getConnection()) {
477 return getExpiringProfileKeyCredential(connection
, recipientId
);
478 } catch (SQLException e
) {
479 throw new RuntimeException("Failed read from recipient store", e
);
484 public void storeProfile(RecipientId recipientId
, final Profile profile
) {
485 try (final var connection
= database
.getConnection()) {
486 storeProfile(connection
, recipientId
, profile
);
487 } catch (SQLException e
) {
488 throw new RuntimeException("Failed update recipient store", e
);
493 public void storeSelfProfileKey(final RecipientId recipientId
, final ProfileKey profileKey
) {
494 try (final var connection
= database
.getConnection()) {
495 storeProfileKey(connection
, recipientId
, profileKey
, false);
496 } catch (SQLException e
) {
497 throw new RuntimeException("Failed update recipient store", e
);
502 public void storeProfileKey(RecipientId recipientId
, final ProfileKey profileKey
) {
503 try (final var connection
= database
.getConnection()) {
504 storeProfileKey(connection
, recipientId
, profileKey
, true);
505 } catch (SQLException e
) {
506 throw new RuntimeException("Failed update recipient store", e
);
511 public void storeExpiringProfileKeyCredential(
512 RecipientId recipientId
, final ExpiringProfileKeyCredential profileKeyCredential
514 try (final var connection
= database
.getConnection()) {
515 storeExpiringProfileKeyCredential(connection
, recipientId
, profileKeyCredential
);
516 } catch (SQLException e
) {
517 throw new RuntimeException("Failed update recipient store", e
);
521 void addLegacyRecipients(final Map
<RecipientId
, Recipient
> recipients
) {
522 logger
.debug("Migrating legacy recipients to database");
523 long start
= System
.nanoTime();
526 INSERT INTO %s (_id, number, uuid)
529 ).formatted(TABLE_RECIPIENT
);
530 try (final var connection
= database
.getConnection()) {
531 connection
.setAutoCommit(false);
532 try (final var statement
= connection
.prepareStatement("DELETE FROM %s".formatted(TABLE_RECIPIENT
))) {
533 statement
.executeUpdate();
535 try (final var statement
= connection
.prepareStatement(sql
)) {
536 for (final var recipient
: recipients
.values()) {
537 statement
.setLong(1, recipient
.getRecipientId().id());
538 statement
.setString(2, recipient
.getAddress().number().orElse(null));
539 statement
.setBytes(3,
540 recipient
.getAddress()
542 .map(ServiceId
::getRawUuid
)
543 .map(UuidUtil
::toByteArray
)
545 statement
.executeUpdate();
548 logger
.debug("Initial inserts took {}ms", (System
.nanoTime() - start
) / 1000000);
550 for (final var recipient
: recipients
.values()) {
551 if (recipient
.getContact() != null) {
552 storeContact(connection
, recipient
.getRecipientId(), recipient
.getContact());
554 if (recipient
.getProfile() != null) {
555 storeProfile(connection
, recipient
.getRecipientId(), recipient
.getProfile());
557 if (recipient
.getProfileKey() != null) {
558 storeProfileKey(connection
, recipient
.getRecipientId(), recipient
.getProfileKey(), false);
560 if (recipient
.getExpiringProfileKeyCredential() != null) {
561 storeExpiringProfileKeyCredential(connection
,
562 recipient
.getRecipientId(),
563 recipient
.getExpiringProfileKeyCredential());
567 } catch (SQLException e
) {
568 throw new RuntimeException("Failed update recipient store", e
);
570 logger
.debug("Complete recipients migration took {}ms", (System
.nanoTime() - start
) / 1000000);
573 long getActualRecipientId(long recipientId
) {
574 while (recipientsMerged
.containsKey(recipientId
)) {
575 final var newRecipientId
= recipientsMerged
.get(recipientId
);
576 logger
.debug("Using {} instead of {}, because recipients have been merged", newRecipientId
, recipientId
);
577 recipientId
= newRecipientId
;
582 private void storeContact(
583 final Connection connection
, final RecipientId recipientId
, final Contact contact
584 ) throws SQLException
{
588 SET given_name = ?, family_name = ?, expiration_time = ?, profile_sharing = ?, color = ?, blocked = ?, archived = ?
591 ).formatted(TABLE_RECIPIENT
);
592 try (final var statement
= connection
.prepareStatement(sql
)) {
593 statement
.setString(1, contact
== null ?
null : contact
.getGivenName());
594 statement
.setString(2, contact
== null ?
null : contact
.getFamilyName());
595 statement
.setInt(3, contact
== null ?
0 : contact
.getMessageExpirationTime());
596 statement
.setBoolean(4, contact
!= null && contact
.isProfileSharingEnabled());
597 statement
.setString(5, contact
== null ?
null : contact
.getColor());
598 statement
.setBoolean(6, contact
!= null && contact
.isBlocked());
599 statement
.setBoolean(7, contact
!= null && contact
.isArchived());
600 statement
.setLong(8, recipientId
.id());
601 statement
.executeUpdate();
605 private void storeExpiringProfileKeyCredential(
606 final Connection connection
,
607 final RecipientId recipientId
,
608 final ExpiringProfileKeyCredential profileKeyCredential
609 ) throws SQLException
{
613 SET profile_key_credential = ?
616 ).formatted(TABLE_RECIPIENT
);
617 try (final var statement
= connection
.prepareStatement(sql
)) {
618 statement
.setBytes(1, profileKeyCredential
== null ?
null : profileKeyCredential
.serialize());
619 statement
.setLong(2, recipientId
.id());
620 statement
.executeUpdate();
624 private void storeProfile(
625 final Connection connection
, final RecipientId recipientId
, final Profile profile
626 ) throws SQLException
{
630 SET profile_last_update_timestamp = ?, profile_given_name = ?, profile_family_name = ?, profile_about = ?, profile_about_emoji = ?, profile_avatar_url_path = ?, profile_mobile_coin_address = ?, profile_unidentified_access_mode = ?, profile_capabilities = ?
633 ).formatted(TABLE_RECIPIENT
);
634 try (final var statement
= connection
.prepareStatement(sql
)) {
635 statement
.setLong(1, profile
== null ?
0 : profile
.getLastUpdateTimestamp());
636 statement
.setString(2, profile
== null ?
null : profile
.getGivenName());
637 statement
.setString(3, profile
== null ?
null : profile
.getFamilyName());
638 statement
.setString(4, profile
== null ?
null : profile
.getAbout());
639 statement
.setString(5, profile
== null ?
null : profile
.getAboutEmoji());
640 statement
.setString(6, profile
== null ?
null : profile
.getAvatarUrlPath());
641 statement
.setBytes(7, profile
== null ?
null : profile
.getMobileCoinAddress());
642 statement
.setString(8, profile
== null ?
null : profile
.getUnidentifiedAccessMode().name());
643 statement
.setString(9,
646 : profile
.getCapabilities().stream().map(Enum
::name
).collect(Collectors
.joining(",")));
647 statement
.setLong(10, recipientId
.id());
648 statement
.executeUpdate();
652 private void storeProfileKey(
653 Connection connection
, RecipientId recipientId
, final ProfileKey profileKey
, boolean resetProfile
654 ) throws SQLException
{
655 if (profileKey
!= null) {
656 final var recipientProfileKey
= getProfileKey(recipientId
);
657 if (profileKey
.equals(recipientProfileKey
)) {
658 final var recipientProfile
= getProfile(recipientId
);
659 if (recipientProfile
== null || (
660 recipientProfile
.getUnidentifiedAccessMode() != Profile
.UnidentifiedAccessMode
.UNKNOWN
661 && recipientProfile
.getUnidentifiedAccessMode()
662 != Profile
.UnidentifiedAccessMode
.DISABLED
672 SET profile_key = ?, profile_key_credential = NULL%s
675 ).formatted(TABLE_RECIPIENT
, resetProfile ?
", profile_last_update_timestamp = 0" : "");
676 try (final var statement
= connection
.prepareStatement(sql
)) {
677 statement
.setBytes(1, profileKey
== null ?
null : profileKey
.serialize());
678 statement
.setLong(2, recipientId
.id());
679 statement
.executeUpdate();
683 private RecipientId
resolveRecipientTrusted(RecipientAddress address
, boolean isSelf
) {
684 final Pair
<RecipientId
, List
<RecipientId
>> pair
;
685 synchronized (recipientsLock
) {
686 try (final var connection
= database
.getConnection()) {
687 connection
.setAutoCommit(false);
688 if (address
.hasSingleIdentifier() || (
689 !isSelf
&& selfAddressProvider
.getSelfAddress().matches(address
)
691 pair
= new Pair
<>(resolveRecipientLocked(connection
, address
), List
.of());
693 pair
= MergeRecipientHelper
.resolveRecipientTrustedLocked(new HelperStore(connection
), address
);
695 for (final var toBeMergedRecipientId
: pair
.second()) {
696 mergeRecipientsLocked(connection
, pair
.first(), toBeMergedRecipientId
);
700 } catch (SQLException e
) {
701 throw new RuntimeException("Failed update recipient store", e
);
705 if (!pair
.second().isEmpty()) {
706 try (final var connection
= database
.getConnection()) {
707 for (final var toBeMergedRecipientId
: pair
.second()) {
708 recipientMergeHandler
.mergeRecipients(connection
, pair
.first(), toBeMergedRecipientId
);
709 deleteRecipient(connection
, toBeMergedRecipientId
);
710 synchronized (recipientsLock
) {
711 recipientAddressCache
.entrySet()
713 .filter(e
-> e
.getValue().id().equals(toBeMergedRecipientId
))
714 .forEach(e
-> recipientAddressCache
.remove(e
.getKey()));
717 } catch (SQLException e
) {
718 throw new RuntimeException("Failed update recipient store", e
);
724 private RecipientId
resolveRecipientLocked(
725 Connection connection
, RecipientAddress address
726 ) throws SQLException
{
727 final var byServiceId
= address
.serviceId().isEmpty()
728 ? Optional
.<RecipientWithAddress
>empty()
729 : findByServiceId(connection
, address
.serviceId().get());
731 if (byServiceId
.isPresent()) {
732 return byServiceId
.get().id();
735 final var byPni
= address
.pni().isEmpty()
736 ? Optional
.<RecipientWithAddress
>empty()
737 : findByServiceId(connection
, address
.pni().get());
739 if (byPni
.isPresent()) {
740 return byPni
.get().id();
743 final var byNumber
= address
.number().isEmpty()
744 ? Optional
.<RecipientWithAddress
>empty()
745 : findByNumber(connection
, address
.number().get());
747 if (byNumber
.isPresent()) {
748 return byNumber
.get().id();
751 logger
.debug("Got new recipient, both serviceId and number are unknown");
753 if (address
.serviceId().isEmpty()) {
754 return addNewRecipient(connection
, address
);
757 return addNewRecipient(connection
, new RecipientAddress(address
.serviceId().get()));
760 private RecipientId
resolveRecipientLocked(Connection connection
, ServiceId serviceId
) throws SQLException
{
761 final var recipient
= findByServiceId(connection
, serviceId
);
763 if (recipient
.isEmpty()) {
764 logger
.debug("Got new recipient, serviceId is unknown");
765 return addNewRecipient(connection
, new RecipientAddress(serviceId
));
768 return recipient
.get().id();
771 private RecipientId
resolveRecipientLocked(Connection connection
, String number
) throws SQLException
{
772 final var recipient
= findByNumber(connection
, number
);
774 if (recipient
.isEmpty()) {
775 logger
.debug("Got new recipient, number is unknown");
776 return addNewRecipient(connection
, new RecipientAddress(null, number
));
779 return recipient
.get().id();
782 private RecipientId
addNewRecipient(
783 final Connection connection
, final RecipientAddress address
784 ) throws SQLException
{
787 INSERT INTO %s (number, uuid, pni)
791 ).formatted(TABLE_RECIPIENT
);
792 try (final var statement
= connection
.prepareStatement(sql
)) {
793 statement
.setString(1, address
.number().orElse(null));
794 statement
.setBytes(2,
795 address
.serviceId().map(ServiceId
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
796 statement
.setBytes(3, address
.pni().map(PNI
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
797 final var generatedKey
= Utils
.executeQueryForOptional(statement
, Utils
::getIdMapper
);
798 if (generatedKey
.isPresent()) {
799 final var recipientId
= new RecipientId(generatedKey
.get(), this);
800 logger
.debug("Added new recipient {} with address {}", recipientId
, address
);
803 throw new RuntimeException("Failed to add new recipient to database");
808 private void removeRecipientAddress(Connection connection
, RecipientId recipientId
) throws SQLException
{
809 synchronized (recipientsLock
) {
810 recipientAddressCache
.entrySet()
812 .filter(e
-> e
.getValue().id().equals(recipientId
))
813 .forEach(e
-> recipientAddressCache
.remove(e
.getKey()));
817 SET number = NULL, uuid = NULL, pni = NULL
820 ).formatted(TABLE_RECIPIENT
);
821 try (final var statement
= connection
.prepareStatement(sql
)) {
822 statement
.setLong(1, recipientId
.id());
823 statement
.executeUpdate();
828 private void updateRecipientAddress(
829 Connection connection
, RecipientId recipientId
, final RecipientAddress address
830 ) throws SQLException
{
831 synchronized (recipientsLock
) {
832 recipientAddressCache
.entrySet()
834 .filter(e
-> e
.getValue().id().equals(recipientId
))
835 .forEach(e
-> recipientAddressCache
.remove(e
.getKey()));
839 SET number = ?, uuid = ?, pni = ?, username = ?
842 ).formatted(TABLE_RECIPIENT
);
843 try (final var statement
= connection
.prepareStatement(sql
)) {
844 statement
.setString(1, address
.number().orElse(null));
845 statement
.setBytes(2,
846 address
.serviceId().map(ServiceId
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
847 statement
.setBytes(3, address
.pni().map(PNI
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
848 statement
.setString(4, address
.username().orElse(null));
849 statement
.setLong(5, recipientId
.id());
850 statement
.executeUpdate();
855 private void deleteRecipient(final Connection connection
, final RecipientId recipientId
) throws SQLException
{
861 ).formatted(TABLE_RECIPIENT
);
862 try (final var statement
= connection
.prepareStatement(sql
)) {
863 statement
.setLong(1, recipientId
.id());
864 statement
.executeUpdate();
868 private void mergeRecipientsLocked(
869 Connection connection
, RecipientId recipientId
, RecipientId toBeMergedRecipientId
870 ) throws SQLException
{
871 final var contact
= getContact(connection
, recipientId
);
872 if (contact
== null) {
873 final var toBeMergedContact
= getContact(connection
, toBeMergedRecipientId
);
874 storeContact(connection
, recipientId
, toBeMergedContact
);
877 final var profileKey
= getProfileKey(connection
, recipientId
);
878 if (profileKey
== null) {
879 final var toBeMergedProfileKey
= getProfileKey(connection
, toBeMergedRecipientId
);
880 storeProfileKey(connection
, recipientId
, toBeMergedProfileKey
, false);
883 final var profileKeyCredential
= getExpiringProfileKeyCredential(connection
, recipientId
);
884 if (profileKeyCredential
== null) {
885 final var toBeMergedProfileKeyCredential
= getExpiringProfileKeyCredential(connection
,
886 toBeMergedRecipientId
);
887 storeExpiringProfileKeyCredential(connection
, recipientId
, toBeMergedProfileKeyCredential
);
890 final var profile
= getProfile(connection
, recipientId
);
891 if (profile
== null) {
892 final var toBeMergedProfile
= getProfile(connection
, toBeMergedRecipientId
);
893 storeProfile(connection
, recipientId
, toBeMergedProfile
);
896 recipientsMerged
.put(toBeMergedRecipientId
.id(), recipientId
.id());
899 private Optional
<RecipientWithAddress
> findByNumber(
900 final Connection connection
, final String number
901 ) throws SQLException
{
903 SELECT r._id, r.number, r.uuid, r.pni, r.username
907 """.formatted(TABLE_RECIPIENT
);
908 try (final var statement
= connection
.prepareStatement(sql
)) {
909 statement
.setString(1, number
);
910 return Utils
.executeQueryForOptional(statement
, this::getRecipientWithAddressFromResultSet
);
914 private Optional
<RecipientWithAddress
> findByUsername(
915 final Connection connection
, final String username
916 ) throws SQLException
{
918 SELECT r._id, r.number, r.uuid, r.pni, r.username
922 """.formatted(TABLE_RECIPIENT
);
923 try (final var statement
= connection
.prepareStatement(sql
)) {
924 statement
.setString(1, username
);
925 return Utils
.executeQueryForOptional(statement
, this::getRecipientWithAddressFromResultSet
);
929 private Optional
<RecipientWithAddress
> findByServiceId(
930 final Connection connection
, final ServiceId serviceId
931 ) throws SQLException
{
932 var recipientWithAddress
= Optional
.ofNullable(recipientAddressCache
.get(serviceId
));
933 if (recipientWithAddress
.isPresent()) {
934 return recipientWithAddress
;
937 SELECT r._id, r.number, r.uuid, r.pni, r.username
939 WHERE r.uuid = ?1 OR r.pni = ?1
941 """.formatted(TABLE_RECIPIENT
);
942 try (final var statement
= connection
.prepareStatement(sql
)) {
943 statement
.setBytes(1, UuidUtil
.toByteArray(serviceId
.getRawUuid()));
944 recipientWithAddress
= Utils
.executeQueryForOptional(statement
, this::getRecipientWithAddressFromResultSet
);
945 recipientWithAddress
.ifPresent(r
-> recipientAddressCache
.put(serviceId
, r
));
946 return recipientWithAddress
;
950 private Set
<RecipientWithAddress
> findAllByAddress(
951 final Connection connection
, final RecipientAddress address
952 ) throws SQLException
{
954 SELECT r._id, r.number, r.uuid, r.pni, r.username
956 WHERE r.uuid = ?1 OR r.pni = ?1 OR
957 r.uuid = ?2 OR r.pni = ?2 OR
960 """.formatted(TABLE_RECIPIENT
);
961 try (final var statement
= connection
.prepareStatement(sql
)) {
962 statement
.setBytes(1,
963 address
.serviceId().map(ServiceId
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
964 statement
.setBytes(2, address
.pni().map(ServiceId
::getRawUuid
).map(UuidUtil
::toByteArray
).orElse(null));
965 statement
.setString(3, address
.number().orElse(null));
966 statement
.setString(4, address
.username().orElse(null));
967 return Utils
.executeQueryForStream(statement
, this::getRecipientWithAddressFromResultSet
)
968 .collect(Collectors
.toSet());
972 private Contact
getContact(final Connection connection
, final RecipientId recipientId
) throws SQLException
{
975 SELECT r.given_name, r.family_name, r.expiration_time, r.profile_sharing, r.color, r.blocked, r.archived
977 WHERE r._id = ? AND (%s)
979 ).formatted(TABLE_RECIPIENT
, SQL_IS_CONTACT
);
980 try (final var statement
= connection
.prepareStatement(sql
)) {
981 statement
.setLong(1, recipientId
.id());
982 return Utils
.executeQueryForOptional(statement
, this::getContactFromResultSet
).orElse(null);
986 private ProfileKey
getProfileKey(final Connection connection
, final RecipientId recipientId
) throws SQLException
{
993 ).formatted(TABLE_RECIPIENT
);
994 try (final var statement
= connection
.prepareStatement(sql
)) {
995 statement
.setLong(1, recipientId
.id());
996 return Utils
.executeQueryForOptional(statement
, this::getProfileKeyFromResultSet
).orElse(null);
1000 private ExpiringProfileKeyCredential
getExpiringProfileKeyCredential(
1001 final Connection connection
, final RecipientId recipientId
1002 ) throws SQLException
{
1005 SELECT r.profile_key_credential
1009 ).formatted(TABLE_RECIPIENT
);
1010 try (final var statement
= connection
.prepareStatement(sql
)) {
1011 statement
.setLong(1, recipientId
.id());
1012 return Utils
.executeQueryForOptional(statement
, this::getExpiringProfileKeyCredentialFromResultSet
)
1017 private Profile
getProfile(final Connection connection
, final RecipientId recipientId
) throws SQLException
{
1020 SELECT r.profile_last_update_timestamp, r.profile_given_name, r.profile_family_name, r.profile_about, r.profile_about_emoji, r.profile_avatar_url_path, r.profile_mobile_coin_address, r.profile_unidentified_access_mode, r.profile_capabilities
1022 WHERE r._id = ? AND r.profile_capabilities IS NOT NULL
1024 ).formatted(TABLE_RECIPIENT
);
1025 try (final var statement
= connection
.prepareStatement(sql
)) {
1026 statement
.setLong(1, recipientId
.id());
1027 return Utils
.executeQueryForOptional(statement
, this::getProfileFromResultSet
).orElse(null);
1031 private RecipientAddress
getRecipientAddressFromResultSet(ResultSet resultSet
) throws SQLException
{
1032 final var pni
= Optional
.ofNullable(resultSet
.getBytes("pni")).map(UuidUtil
::parseOrNull
).map(PNI
::from
);
1033 final var serviceIdUuid
= Optional
.ofNullable(resultSet
.getBytes("uuid")).map(UuidUtil
::parseOrNull
);
1034 final var serviceId
= serviceIdUuid
.isPresent() && pni
.isPresent() && serviceIdUuid
.get()
1035 .equals(pni
.get().getRawUuid()) ? pni
.<ServiceId
>map(p
-> p
) : serviceIdUuid
.<ServiceId
>map(ACI
::from
);
1036 final var number
= Optional
.ofNullable(resultSet
.getString("number"));
1037 final var username
= Optional
.ofNullable(resultSet
.getString("username"));
1038 return new RecipientAddress(serviceId
, pni
, number
, username
);
1041 private RecipientId
getRecipientIdFromResultSet(ResultSet resultSet
) throws SQLException
{
1042 return new RecipientId(resultSet
.getLong("_id"), this);
1045 private RecipientWithAddress
getRecipientWithAddressFromResultSet(final ResultSet resultSet
) throws SQLException
{
1046 return new RecipientWithAddress(getRecipientIdFromResultSet(resultSet
),
1047 getRecipientAddressFromResultSet(resultSet
));
1050 private Recipient
getRecipientFromResultSet(final ResultSet resultSet
) throws SQLException
{
1051 return new Recipient(getRecipientIdFromResultSet(resultSet
),
1052 getRecipientAddressFromResultSet(resultSet
),
1053 getContactFromResultSet(resultSet
),
1054 getProfileKeyFromResultSet(resultSet
),
1055 getExpiringProfileKeyCredentialFromResultSet(resultSet
),
1056 getProfileFromResultSet(resultSet
));
1059 private Contact
getContactFromResultSet(ResultSet resultSet
) throws SQLException
{
1060 return new Contact(resultSet
.getString("given_name"),
1061 resultSet
.getString("family_name"),
1062 resultSet
.getString("color"),
1063 resultSet
.getInt("expiration_time"),
1064 resultSet
.getBoolean("blocked"),
1065 resultSet
.getBoolean("archived"),
1066 resultSet
.getBoolean("profile_sharing"));
1069 private Profile
getProfileFromResultSet(ResultSet resultSet
) throws SQLException
{
1070 final var profileCapabilities
= resultSet
.getString("profile_capabilities");
1071 final var profileUnidentifiedAccessMode
= resultSet
.getString("profile_unidentified_access_mode");
1072 return new Profile(resultSet
.getLong("profile_last_update_timestamp"),
1073 resultSet
.getString("profile_given_name"),
1074 resultSet
.getString("profile_family_name"),
1075 resultSet
.getString("profile_about"),
1076 resultSet
.getString("profile_about_emoji"),
1077 resultSet
.getString("profile_avatar_url_path"),
1078 resultSet
.getBytes("profile_mobile_coin_address"),
1079 profileUnidentifiedAccessMode
== null
1080 ? Profile
.UnidentifiedAccessMode
.UNKNOWN
1081 : Profile
.UnidentifiedAccessMode
.valueOfOrUnknown(profileUnidentifiedAccessMode
),
1082 profileCapabilities
== null
1084 : Arrays
.stream(profileCapabilities
.split(","))
1085 .map(Profile
.Capability
::valueOfOrNull
)
1086 .filter(Objects
::nonNull
)
1087 .collect(Collectors
.toSet()));
1090 private ProfileKey
getProfileKeyFromResultSet(ResultSet resultSet
) throws SQLException
{
1091 final var profileKey
= resultSet
.getBytes("profile_key");
1093 if (profileKey
== null) {
1097 return new ProfileKey(profileKey
);
1098 } catch (InvalidInputException ignored
) {
1103 private ExpiringProfileKeyCredential
getExpiringProfileKeyCredentialFromResultSet(ResultSet resultSet
) throws SQLException
{
1104 final var profileKeyCredential
= resultSet
.getBytes("profile_key_credential");
1106 if (profileKeyCredential
== null) {
1110 return new ExpiringProfileKeyCredential(profileKeyCredential
);
1111 } catch (Throwable ignored
) {
1116 public interface RecipientMergeHandler
{
1118 void mergeRecipients(
1119 final Connection connection
, RecipientId recipientId
, RecipientId toBeMergedRecipientId
1120 ) throws SQLException
;
1123 private class HelperStore
implements MergeRecipientHelper
.Store
{
1125 private final Connection connection
;
1127 public HelperStore(final Connection connection
) {
1128 this.connection
= connection
;
1132 public Set
<RecipientWithAddress
> findAllByAddress(final RecipientAddress address
) throws SQLException
{
1133 return RecipientStore
.this.findAllByAddress(connection
, address
);
1137 public RecipientId
addNewRecipient(final RecipientAddress address
) throws SQLException
{
1138 return RecipientStore
.this.addNewRecipient(connection
, address
);
1142 public void updateRecipientAddress(
1143 final RecipientId recipientId
, final RecipientAddress address
1144 ) throws SQLException
{
1145 RecipientStore
.this.updateRecipientAddress(connection
, recipientId
, address
);
1149 public void removeRecipientAddress(final RecipientId recipientId
) throws SQLException
{
1150 RecipientStore
.this.removeRecipientAddress(connection
, recipientId
);