-
-
Notifications
You must be signed in to change notification settings - Fork 6k
/
GroupTable.kt
1540 lines (1321 loc) · 53.9 KB
/
GroupTable.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package org.thoughtcrime.securesms.database
import android.content.ContentValues
import android.content.Context
import android.database.Cursor
import android.text.TextUtils
import androidx.annotation.WorkerThread
import androidx.core.content.contentValuesOf
import org.intellij.lang.annotations.Language
import org.signal.core.util.SetUtil
import org.signal.core.util.SqlUtil
import org.signal.core.util.SqlUtil.appendArg
import org.signal.core.util.SqlUtil.buildArgs
import org.signal.core.util.SqlUtil.buildCaseInsensitiveGlobPattern
import org.signal.core.util.SqlUtil.buildCollectionQuery
import org.signal.core.util.delete
import org.signal.core.util.exists
import org.signal.core.util.isAbsent
import org.signal.core.util.logging.Log
import org.signal.core.util.optionalString
import org.signal.core.util.readToList
import org.signal.core.util.readToSingleInt
import org.signal.core.util.readToSingleObject
import org.signal.core.util.requireBlob
import org.signal.core.util.requireBoolean
import org.signal.core.util.requireInt
import org.signal.core.util.requireLong
import org.signal.core.util.requireNonNullString
import org.signal.core.util.requireString
import org.signal.core.util.select
import org.signal.core.util.update
import org.signal.core.util.withinTransaction
import org.signal.libsignal.zkgroup.groups.GroupMasterKey
import org.signal.storageservice.protos.groups.Member
import org.signal.storageservice.protos.groups.local.DecryptedGroup
import org.thoughtcrime.securesms.contacts.paged.ContactSearchSortOrder
import org.thoughtcrime.securesms.contacts.paged.collections.ContactSearchIterator
import org.thoughtcrime.securesms.crypto.SenderKeyUtil
import org.thoughtcrime.securesms.database.SignalDatabase.Companion.messages
import org.thoughtcrime.securesms.database.SignalDatabase.Companion.recipients
import org.thoughtcrime.securesms.database.model.GroupRecord
import org.thoughtcrime.securesms.dependencies.ApplicationDependencies
import org.thoughtcrime.securesms.groups.BadGroupIdException
import org.thoughtcrime.securesms.groups.GroupId
import org.thoughtcrime.securesms.groups.GroupId.Push
import org.thoughtcrime.securesms.groups.GroupMigrationMembershipChange
import org.thoughtcrime.securesms.groups.GroupsV1MigratedCache
import org.thoughtcrime.securesms.groups.v2.processing.GroupsV2StateProcessor
import org.thoughtcrime.securesms.jobs.RequestGroupV2InfoJob
import org.thoughtcrime.securesms.keyvalue.SignalStore
import org.thoughtcrime.securesms.recipients.Recipient
import org.thoughtcrime.securesms.recipients.RecipientId
import org.whispersystems.signalservice.api.groupsv2.DecryptedGroupUtil
import org.whispersystems.signalservice.api.groupsv2.GroupChangeReconstruct
import org.whispersystems.signalservice.api.messages.SignalServiceAttachmentPointer
import org.whispersystems.signalservice.api.push.DistributionId
import org.whispersystems.signalservice.api.push.ServiceId
import org.whispersystems.signalservice.api.util.UuidUtil
import java.io.Closeable
import java.security.SecureRandom
import java.util.Optional
import java.util.UUID
import java.util.stream.Collectors
import javax.annotation.CheckReturnValue
class GroupTable(context: Context?, databaseHelper: SignalDatabase?) : DatabaseTable(context, databaseHelper), RecipientIdDatabaseReference {
companion object {
private val TAG = Log.tag(GroupTable::class.java)
const val MEMBER_GROUP_CONCAT = "member_group_concat"
const val THREAD_DATE = "thread_date"
const val TABLE_NAME = "groups"
const val ID = "_id"
const val GROUP_ID = "group_id"
const val RECIPIENT_ID = "recipient_id"
const val TITLE = "title"
const val AVATAR_ID = "avatar_id"
const val AVATAR_KEY = "avatar_key"
const val AVATAR_CONTENT_TYPE = "avatar_content_type"
const val AVATAR_RELAY = "avatar_relay"
const val AVATAR_DIGEST = "avatar_digest"
const val TIMESTAMP = "timestamp"
const val ACTIVE = "active"
const val MMS = "mms"
const val EXPECTED_V2_ID = "expected_v2_id"
const val UNMIGRATED_V1_MEMBERS = "former_v1_members"
const val DISTRIBUTION_ID = "distribution_id"
const val SHOW_AS_STORY_STATE = "display_as_story"
const val LAST_FORCE_UPDATE_TIMESTAMP = "last_force_update_timestamp"
/** 32 bytes serialized [GroupMasterKey] */
const val V2_MASTER_KEY = "master_key"
/** Increments with every change to the group */
const val V2_REVISION = "revision"
/** Serialized [DecryptedGroup] protobuf */
const val V2_DECRYPTED_GROUP = "decrypted_group"
/** Was temporarily used for PNP accept by pni but is no longer needed/updated */
@Deprecated("")
private val AUTH_SERVICE_ID = "auth_service_id"
@JvmField
val CREATE_TABLE = """
CREATE TABLE $TABLE_NAME (
$ID INTEGER PRIMARY KEY,
$GROUP_ID TEXT,
$RECIPIENT_ID INTEGER,
$TITLE TEXT,
$AVATAR_ID INTEGER,
$AVATAR_KEY BLOB,
$AVATAR_CONTENT_TYPE TEXT,
$AVATAR_RELAY TEXT,
$TIMESTAMP INTEGER,
$ACTIVE INTEGER DEFAULT 1,
$AVATAR_DIGEST BLOB,
$MMS INTEGER DEFAULT 0,
$V2_MASTER_KEY BLOB,
$V2_REVISION BLOB,
$V2_DECRYPTED_GROUP BLOB,
$EXPECTED_V2_ID TEXT DEFAULT NULL,
$UNMIGRATED_V1_MEMBERS TEXT DEFAULT NULL,
$DISTRIBUTION_ID TEXT DEFAULT NULL,
$SHOW_AS_STORY_STATE INTEGER DEFAULT 0,
$AUTH_SERVICE_ID TEXT DEFAULT NULL,
$LAST_FORCE_UPDATE_TIMESTAMP INTEGER DEFAULT 0
)
"""
@JvmField
val CREATE_INDEXS = arrayOf(
"CREATE UNIQUE INDEX IF NOT EXISTS group_id_index ON $TABLE_NAME ($GROUP_ID);",
"CREATE UNIQUE INDEX IF NOT EXISTS group_recipient_id_index ON $TABLE_NAME ($RECIPIENT_ID);",
"CREATE UNIQUE INDEX IF NOT EXISTS expected_v2_id_index ON $TABLE_NAME ($EXPECTED_V2_ID);",
"CREATE UNIQUE INDEX IF NOT EXISTS group_distribution_id_index ON $TABLE_NAME($DISTRIBUTION_ID);"
) + MembershipTable.CREATE_INDEXES
private val GROUP_PROJECTION = arrayOf(
GROUP_ID,
RECIPIENT_ID,
TITLE,
UNMIGRATED_V1_MEMBERS,
AVATAR_ID,
AVATAR_KEY,
AVATAR_CONTENT_TYPE,
AVATAR_RELAY,
AVATAR_DIGEST,
TIMESTAMP,
ACTIVE,
MMS,
V2_MASTER_KEY,
V2_REVISION,
V2_DECRYPTED_GROUP,
LAST_FORCE_UPDATE_TIMESTAMP
)
val TYPED_GROUP_PROJECTION = GROUP_PROJECTION
.filterNot { it == RECIPIENT_ID }
.map { columnName: String -> "$TABLE_NAME.$columnName" }
.toList()
//language=sql
private val JOINED_GROUP_SELECT = """
SELECT
DISTINCT $TABLE_NAME.*,
(
SELECT GROUP_CONCAT(${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID})
FROM ${MembershipTable.TABLE_NAME}
WHERE ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
) as $MEMBER_GROUP_CONCAT
FROM $TABLE_NAME
"""
val CREATE_TABLES = arrayOf(CREATE_TABLE, MembershipTable.CREATE_TABLE)
}
class MembershipTable(context: Context, databaseHelper: SignalDatabase) : DatabaseTable(context, databaseHelper) {
companion object {
const val TABLE_NAME = "group_membership"
const val ID = "_id"
const val GROUP_ID = "group_id"
const val RECIPIENT_ID = "recipient_id"
//language=sql
@JvmField
val CREATE_TABLE = """
CREATE TABLE $TABLE_NAME (
$ID INTEGER PRIMARY KEY,
$GROUP_ID TEXT NOT NULL,
$RECIPIENT_ID INTEGER NOT NULL REFERENCES ${RecipientTable.TABLE_NAME} (${RecipientTable.ID}) ON DELETE CASCADE,
UNIQUE($GROUP_ID, $RECIPIENT_ID)
)
"""
val CREATE_INDEXES = arrayOf(
"CREATE INDEX IF NOT EXISTS group_membership_recipient_id ON $TABLE_NAME ($RECIPIENT_ID)"
)
}
}
fun getGroup(recipientId: RecipientId): Optional<GroupRecord> {
return getGroup(SqlUtil.Query("$TABLE_NAME.$RECIPIENT_ID = ?", buildArgs(recipientId)))
}
fun getGroup(groupId: GroupId): Optional<GroupRecord> {
return getGroup(SqlUtil.Query("$TABLE_NAME.$GROUP_ID = ?", buildArgs(groupId)))
}
private fun getGroup(query: SqlUtil.Query): Optional<GroupRecord> {
//language=sql
val select = "$JOINED_GROUP_SELECT WHERE ${query.where}"
readableDatabase
.query(select, query.whereArgs)
.use { cursor ->
return if (cursor.moveToFirst()) {
val groupRecord = getGroup(cursor)
if (groupRecord.isPresent && RemappedRecords.getInstance().areAnyRemapped(groupRecord.get().members)) {
val groupId = groupRecord.get().id
val remaps = RemappedRecords.getInstance().buildRemapDescription(groupRecord.get().members)
Log.w(TAG, "Found a group with remapped recipients in it's membership list! Updating the list. GroupId: $groupId, Remaps: $remaps", true)
val oldToNew: List<Pair<RecipientId, RecipientId>> = groupRecord.get().members
.map { it to RemappedRecords.getInstance().getRecipient(it).orElse(null) }
.filterNot { (old, new) -> new == null || old == new }
if (oldToNew.isNotEmpty()) {
writableDatabase.withinTransaction { db ->
oldToNew.forEach { remapRecipient(it.first, it.second) }
}
}
readableDatabase.query(select, query.whereArgs).use { refreshedCursor ->
if (refreshedCursor.moveToFirst()) {
getGroup(refreshedCursor)
} else {
Optional.empty()
}
}
} else {
getGroup(cursor)
}
} else {
Optional.empty()
}
}
}
/**
* Call if you are sure this group should exist.
* Finds group and throws if it cannot.
*/
fun requireGroup(groupId: GroupId): GroupRecord {
val group = getGroup(groupId)
if (!group.isPresent) {
throw AssertionError("Group not found")
}
return group.get()
}
fun groupExists(groupId: GroupId): Boolean {
return readableDatabase
.exists(TABLE_NAME)
.where("$GROUP_ID = ?", groupId.toString())
.run()
}
/**
* @return A gv1 group whose expected v2 ID matches the one provided.
*/
fun getGroupV1ByExpectedV2(gv2Id: GroupId.V2): Optional<GroupRecord> {
return getGroup(SqlUtil.Query("$TABLE_NAME.$EXPECTED_V2_ID = ?", buildArgs(gv2Id)))
}
/**
* @return A gv1 group whose expected v2 ID matches the one provided or a gv2 group whose ID matches the one provided.
*
* If a gv1 group is present, it will be returned first.
*/
fun getGroupV1OrV2ByExpectedV2(gv2Id: GroupId.V2): Optional<GroupRecord> {
return getGroup(SqlUtil.Query("$TABLE_NAME.$EXPECTED_V2_ID = ? OR $TABLE_NAME.$GROUP_ID = ? ORDER BY $TABLE_NAME.$EXPECTED_V2_ID DESC", buildArgs(gv2Id, gv2Id)))
}
fun getGroupByDistributionId(distributionId: DistributionId): Optional<GroupRecord> {
return getGroup(SqlUtil.Query("$TABLE_NAME.$DISTRIBUTION_ID = ?", buildArgs(distributionId)))
}
fun removeUnmigratedV1Members(id: GroupId.V2) {
val group = getGroup(id)
if (!group.isPresent) {
Log.w(TAG, "Couldn't find the group!", Throwable())
return
}
removeUnmigratedV1Members(id, group.get().unmigratedV1Members)
}
/**
* Removes the specified members from the list of 'unmigrated V1 members' -- the list of members
* that were either dropped or had to be invited when migrating the group from V1->V2.
*/
fun removeUnmigratedV1Members(id: GroupId.V2, toRemove: List<RecipientId>) {
val group = getGroup(id)
if (group.isAbsent()) {
Log.w(TAG, "Couldn't find the group!", Throwable())
return
}
val newUnmigrated = group.get().unmigratedV1Members - toRemove.toSet()
writableDatabase
.update(TABLE_NAME)
.values(UNMIGRATED_V1_MEMBERS to if (newUnmigrated.isEmpty()) null else newUnmigrated.serialize())
.where("$GROUP_ID = ?", id)
.run()
Recipient.live(Recipient.externalGroupExact(id).id).refresh()
}
private fun getGroup(cursor: Cursor?): Optional<GroupRecord> {
val reader = Reader(cursor)
return Optional.ofNullable(reader.getCurrent())
}
/**
* @return local db group revision or -1 if not present.
*/
fun getGroupV2Revision(groupId: GroupId.V2): Int {
readableDatabase
.select()
.from(TABLE_NAME)
.where("$GROUP_ID = ?", groupId.toString())
.run()
.use { cursor ->
return if (cursor.moveToNext()) {
cursor.getInt(cursor.getColumnIndexOrThrow(V2_REVISION))
} else {
-1
}
}
}
fun isUnknownGroup(groupId: GroupId): Boolean {
return isUnknownGroup(getGroup(groupId))
}
fun isUnknownGroup(group: Optional<GroupRecord>): Boolean {
if (!group.isPresent) {
return true
}
val noMetadata = !group.get().hasAvatar() && group.get().title.isNullOrEmpty()
val noMembers = group.get().members.isEmpty() || group.get().members.size == 1 && group.get().members.contains(Recipient.self().id)
return noMetadata && noMembers
}
fun queryGroupsByMemberName(inputQuery: String): Cursor {
val subquery = recipients.getAllContactsSubquery(inputQuery)
val statement = """
SELECT
DISTINCT $TABLE_NAME.*,
GROUP_CONCAT(${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID}) as $MEMBER_GROUP_CONCAT,
${ThreadTable.TABLE_NAME}.${ThreadTable.DATE} as $THREAD_DATE
FROM $TABLE_NAME
INNER JOIN ${MembershipTable.TABLE_NAME} ON ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
INNER JOIN ${ThreadTable.TABLE_NAME} ON ${ThreadTable.TABLE_NAME}.${ThreadTable.RECIPIENT_ID} = $TABLE_NAME.$RECIPIENT_ID
WHERE $TABLE_NAME.$ACTIVE = 1 AND ${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID} IN (${subquery.where})
GROUP BY ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID}
ORDER BY $TITLE COLLATE NOCASE ASC
"""
return databaseHelper.signalReadableDatabase.query(statement, subquery.whereArgs)
}
fun queryGroupsByTitle(inputQuery: String, includeInactive: Boolean, excludeV1: Boolean, excludeMms: Boolean): Reader {
val query = getGroupQueryWhereStatement(inputQuery, includeInactive, excludeV1, excludeMms)
//language=sql
val statement = """
$JOINED_GROUP_SELECT
WHERE ${query.where}
ORDER BY $TITLE COLLATE NOCASE ASC
"""
val cursor = databaseHelper.signalReadableDatabase.query(statement, query.whereArgs)
return Reader(cursor)
}
fun queryGroupsByMembership(recipientIds: Set<RecipientId>, includeInactive: Boolean, excludeV1: Boolean, excludeMms: Boolean): Reader {
var recipientIds = recipientIds
if (recipientIds.isEmpty()) {
return Reader(null)
}
if (recipientIds.size > 30) {
Log.w(TAG, "[queryGroupsByMembership] Large set of recipientIds (${recipientIds.size})! Using the first 30.")
recipientIds = recipientIds.take(30).toSet()
}
val membershipQuery = SqlUtil.buildSingleCollectionQuery("${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID}", recipientIds)
var query: String
val queryArgs: Array<String>
if (includeInactive) {
query = "${membershipQuery.where} AND ($TABLE_NAME.$ACTIVE = ? OR $TABLE_NAME.$RECIPIENT_ID IN (SELECT ${ThreadTable.RECIPIENT_ID} FROM ${ThreadTable.TABLE_NAME} WHERE ${ThreadTable.TABLE_NAME}.${ThreadTable.ACTIVE} = 1))"
queryArgs = membershipQuery.whereArgs + buildArgs(1)
} else {
query = "${membershipQuery.where} AND $TABLE_NAME.$ACTIVE = ?"
queryArgs = membershipQuery.whereArgs + buildArgs(1)
}
if (excludeV1) {
query += " AND $EXPECTED_V2_ID IS NULL"
}
if (excludeMms) {
query += " AND $MMS = 0"
}
val selection = """
SELECT DISTINCT
$TABLE_NAME.*,
(
SELECT GROUP_CONCAT(${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID})
FROM ${MembershipTable.TABLE_NAME}
WHERE ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
) as $MEMBER_GROUP_CONCAT
FROM ${MembershipTable.TABLE_NAME}
INNER JOIN $TABLE_NAME ON ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
WHERE $query
"""
return Reader(readableDatabase.query(selection, queryArgs))
}
private fun queryGroupsByRecency(groupQuery: GroupQuery): Reader {
val query = getGroupQueryWhereStatement(groupQuery.searchQuery, groupQuery.includeInactive, !groupQuery.includeV1, !groupQuery.includeMms)
val sql = """
$JOINED_GROUP_SELECT
INNER JOIN ${ThreadTable.TABLE_NAME} ON ${ThreadTable.TABLE_NAME}.${ThreadTable.RECIPIENT_ID} = $TABLE_NAME.$RECIPIENT_ID
WHERE ${query.where}
ORDER BY ${ThreadTable.TABLE_NAME}.${ThreadTable.DATE} DESC
"""
return Reader(databaseHelper.signalReadableDatabase.rawQuery(sql, query.whereArgs))
}
fun queryGroups(groupQuery: GroupQuery): Reader {
return if (groupQuery.sortOrder === ContactSearchSortOrder.NATURAL) {
queryGroupsByTitle(groupQuery.searchQuery, groupQuery.includeInactive, !groupQuery.includeV1, !groupQuery.includeMms)
} else {
queryGroupsByRecency(groupQuery)
}
}
private fun getGroupQueryWhereStatement(inputQuery: String, includeInactive: Boolean, excludeV1: Boolean, excludeMms: Boolean): SqlUtil.Query {
var query: String
val queryArgs: Array<String>
val caseInsensitiveQuery = buildCaseInsensitiveGlobPattern(inputQuery)
if (includeInactive) {
query = "$TITLE GLOB ? AND ($TABLE_NAME.$ACTIVE = ? OR $TABLE_NAME.$RECIPIENT_ID IN (SELECT ${ThreadTable.RECIPIENT_ID} FROM ${ThreadTable.TABLE_NAME} WHERE ${ThreadTable.TABLE_NAME}.${ThreadTable.ACTIVE} = 1))"
queryArgs = buildArgs(caseInsensitiveQuery, 1)
} else {
query = "$TITLE GLOB ? AND $TABLE_NAME.$ACTIVE = ?"
queryArgs = buildArgs(caseInsensitiveQuery, 1)
}
if (excludeV1) {
query += " AND $EXPECTED_V2_ID IS NULL"
}
if (excludeMms) {
query += " AND $MMS = 0"
}
return SqlUtil.Query(query, queryArgs)
}
fun getOrCreateDistributionId(groupId: GroupId.V2): DistributionId {
readableDatabase
.select(DISTRIBUTION_ID)
.from(TABLE_NAME)
.where("$GROUP_ID = ?", groupId)
.run()
.use { cursor ->
return if (cursor.moveToFirst()) {
val serialized = cursor.optionalString(DISTRIBUTION_ID)
if (serialized.isPresent) {
DistributionId.from(serialized.get())
} else {
Log.w(TAG, "Missing distributionId! Creating one.")
val distributionId = DistributionId.create()
val count = writableDatabase
.update(TABLE_NAME)
.values(DISTRIBUTION_ID to distributionId.toString())
.where("$GROUP_ID = ?", groupId)
.run()
check(count >= 1) { "Tried to create a distributionId for $groupId, but it doesn't exist!" }
distributionId
}
} else {
throw IllegalStateException("Group $groupId doesn't exist!")
}
}
}
fun getOrCreateMmsGroupForMembers(members: Set<RecipientId>): GroupId.Mms {
val joinedTestMembers = members
.toList()
.map { it.toLong() }
.sorted()
.joinToString(separator = ",")
//language=sql
val statement = """
SELECT
$TABLE_NAME.$GROUP_ID as gid,
(
SELECT GROUP_CONCAT(${MembershipTable.RECIPIENT_ID}, ',')
FROM (
SELECT ${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID}
FROM ${MembershipTable.TABLE_NAME}
WHERE ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
ORDER BY ${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID} ASC
)
) as $MEMBER_GROUP_CONCAT
FROM $TABLE_NAME
WHERE $MEMBER_GROUP_CONCAT = ?
"""
return readableDatabase.rawQuery(statement, buildArgs(joinedTestMembers)).use { cursor ->
if (cursor.moveToNext()) {
return GroupId.parseOrThrow(cursor.requireNonNullString("gid")).requireMms()
} else {
val groupId = GroupId.createMms(SecureRandom())
create(groupId, null, members)
groupId
}
}
}
@WorkerThread
fun getPushGroupNamesContainingMember(recipientId: RecipientId): List<String> {
return getPushGroupsContainingMember(recipientId)
.map { groupRecord -> Recipient.resolved(groupRecord.recipientId).getDisplayName(context) }
.toList()
}
@WorkerThread
fun getPushGroupsContainingMember(recipientId: RecipientId): List<GroupRecord> {
return getGroupsContainingMember(recipientId, true)
}
fun getGroupsContainingMember(recipientId: RecipientId, pushOnly: Boolean): List<GroupRecord> {
return getGroupsContainingMember(recipientId, pushOnly, false)
}
@WorkerThread
fun getGroupsContainingMember(recipientId: RecipientId, pushOnly: Boolean, includeInactive: Boolean): List<GroupRecord> {
//language=sql
val table = """
SELECT
DISTINCT $TABLE_NAME.*,
(
SELECT GROUP_CONCAT(${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID})
FROM ${MembershipTable.TABLE_NAME}
WHERE ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
) as $MEMBER_GROUP_CONCAT
FROM ${MembershipTable.TABLE_NAME}
INNER JOIN $TABLE_NAME ON ${MembershipTable.TABLE_NAME}.${MembershipTable.GROUP_ID} = $TABLE_NAME.$GROUP_ID
LEFT JOIN ${ThreadTable.TABLE_NAME} ON $TABLE_NAME.$RECIPIENT_ID = ${ThreadTable.TABLE_NAME}.${ThreadTable.RECIPIENT_ID}
"""
var query = "${MembershipTable.TABLE_NAME}.${MembershipTable.RECIPIENT_ID} = ?"
var args = buildArgs(recipientId)
val orderBy = "${ThreadTable.TABLE_NAME}.${ThreadTable.DATE} DESC"
if (pushOnly) {
query += " AND $MMS = ?"
args = appendArg(args, "0")
}
if (!includeInactive) {
query += " AND $TABLE_NAME.$ACTIVE = ?"
args = appendArg(args, "1")
}
return readableDatabase
.query("$table WHERE $query ORDER BY $orderBy", args)
.readToList { cursor ->
getGroup(cursor).get()
}
}
fun getGroups(): Reader {
val cursor = readableDatabase.query(JOINED_GROUP_SELECT)
return Reader(cursor)
}
fun getActiveGroupCount(): Int {
return readableDatabase
.select("COUNT(*)")
.from(TABLE_NAME)
.where("$ACTIVE = ?", 1)
.run()
.readToSingleInt(0)
}
@WorkerThread
fun getGroupMemberIds(groupId: GroupId, memberSet: MemberSet): List<RecipientId> {
return if (groupId.isV2) {
getGroup(groupId)
.map { it.requireV2GroupProperties().getMemberRecipientIds(memberSet) }
.orElse(emptyList())
} else {
val currentMembers: MutableList<RecipientId> = getCurrentMembers(groupId)
if (!memberSet.includeSelf) {
currentMembers -= Recipient.self().id
}
currentMembers
}
}
@WorkerThread
fun getGroupMembers(groupId: GroupId, memberSet: MemberSet): List<Recipient> {
return if (groupId.isV2) {
getGroup(groupId)
.map { it.requireV2GroupProperties().getMemberRecipients(memberSet) }
.orElse(emptyList())
} else {
val currentMembers: List<RecipientId> = getCurrentMembers(groupId)
val recipients: MutableList<Recipient> = ArrayList(currentMembers.size)
for (member in currentMembers) {
val resolved = Recipient.resolved(member)
if (memberSet.includeSelf || !resolved.isSelf) {
recipients += resolved
}
}
recipients
}
}
@CheckReturnValue
fun create(groupId: GroupId.V1, title: String?, members: Collection<RecipientId>, avatar: SignalServiceAttachmentPointer?, relay: String?): Boolean {
if (groupExists(groupId.deriveV2MigrationGroupId())) {
throw LegacyGroupInsertException(groupId)
}
return create(groupId, title, members, avatar, relay, null, null)
}
@CheckReturnValue
fun create(groupId: GroupId.Mms, title: String?, members: Collection<RecipientId>): Boolean {
return create(groupId, if (title.isNullOrEmpty()) null else title, members, null, null, null, null)
}
@JvmOverloads
@CheckReturnValue
fun create(groupMasterKey: GroupMasterKey, groupState: DecryptedGroup, force: Boolean = false): GroupId.V2? {
val groupId = GroupId.v2(groupMasterKey)
if (!force && GroupsV1MigratedCache.hasV1Group(groupId)) {
throw MissedGroupMigrationInsertException(groupId)
} else if (force) {
Log.w(TAG, "Forcing the creation of a group even though we already have a V1 ID!")
}
return if (create(groupId = groupId, title = groupState.title, memberCollection = emptyList(), avatar = null, relay = null, groupMasterKey = groupMasterKey, groupState = groupState)) {
groupId
} else {
null
}
}
/**
* There was a point in time where we weren't properly responding to group creates on linked devices. This would result in us having a Recipient entry for the
* group, but we'd either be missing the group entry, or that entry would be missing a master key. This method fixes this scenario.
*/
fun fixMissingMasterKey(groupMasterKey: GroupMasterKey) {
val groupId = GroupId.v2(groupMasterKey)
if (GroupsV1MigratedCache.hasV1Group(groupId)) {
Log.w(TAG, "There already exists a V1 group that should be migrated into this group. But if the recipient already exists, there's not much we can do here.")
}
writableDatabase.withinTransaction { db ->
val updated = db
.update(TABLE_NAME)
.values(V2_MASTER_KEY to groupMasterKey.serialize())
.where("$GROUP_ID = ?", groupId)
.run()
if (updated < 1) {
Log.w(TAG, "No group entry. Creating restore placeholder for $groupId")
create(
groupMasterKey,
DecryptedGroup.newBuilder()
.setRevision(GroupsV2StateProcessor.RESTORE_PLACEHOLDER_REVISION)
.build(),
true
)
} else {
Log.w(TAG, "Had a group entry, but it was missing a master key. Updated.")
}
}
Log.w(TAG, "Scheduling request for latest group info for $groupId")
ApplicationDependencies.getJobManager().add(RequestGroupV2InfoJob(groupId))
}
/**
* @param groupMasterKey null for V1, must be non-null for V2 (presence dictates group version).
*/
@CheckReturnValue
private fun create(
groupId: GroupId,
title: String?,
memberCollection: Collection<RecipientId>,
avatar: SignalServiceAttachmentPointer?,
relay: String?,
groupMasterKey: GroupMasterKey?,
groupState: DecryptedGroup?
): Boolean {
val membershipValues = mutableListOf<ContentValues>()
val groupRecipientId = recipients.getOrInsertFromGroupId(groupId)
val members: List<RecipientId> = memberCollection.toSet().sorted()
var groupMembers: List<RecipientId> = members
val values = ContentValues()
values.put(RECIPIENT_ID, groupRecipientId.serialize())
values.put(GROUP_ID, groupId.toString())
values.put(TITLE, title)
membershipValues.addAll(members.toContentValues(groupId))
values.put(MMS, groupId.isMms)
if (avatar != null) {
values.put(AVATAR_ID, avatar.remoteId.v2.get())
values.put(AVATAR_KEY, avatar.key)
values.put(AVATAR_CONTENT_TYPE, avatar.contentType)
values.put(AVATAR_DIGEST, avatar.digest.orElse(null))
} else {
values.put(AVATAR_ID, 0)
}
values.put(AVATAR_RELAY, relay)
values.put(TIMESTAMP, System.currentTimeMillis())
if (groupId.isV2) {
values.put(ACTIVE, if (groupState != null && gv2GroupActive(groupState)) 1 else 0)
values.put(DISTRIBUTION_ID, DistributionId.create().toString())
} else if (groupId.isV1) {
values.put(ACTIVE, 1)
values.put(EXPECTED_V2_ID, groupId.requireV1().deriveV2MigrationGroupId().toString())
} else {
values.put(ACTIVE, 1)
}
if (groupMasterKey != null) {
if (groupState == null) {
throw AssertionError("V2 master key but no group state")
}
groupId.requireV2()
groupMembers = getV2GroupMembers(groupState, true)
values.put(V2_MASTER_KEY, groupMasterKey.serialize())
values.put(V2_REVISION, groupState.revision)
values.put(V2_DECRYPTED_GROUP, groupState.toByteArray())
membershipValues.clear()
membershipValues.addAll(groupMembers.toContentValues(groupId))
} else {
if (groupId.isV2) {
throw AssertionError("V2 group id but no master key")
}
}
writableDatabase.beginTransaction()
try {
val result: Long = writableDatabase.insert(TABLE_NAME, null, values)
if (result < 1) {
Log.w(TAG, "Unable to create group, group record already exists")
return false
}
for (query in SqlUtil.buildBulkInsert(MembershipTable.TABLE_NAME, arrayOf(MembershipTable.GROUP_ID, MembershipTable.RECIPIENT_ID), membershipValues)) {
writableDatabase.execSQL(query.where, query.whereArgs)
}
writableDatabase.setTransactionSuccessful()
} finally {
writableDatabase.endTransaction()
}
if (groupState != null && groupState.hasDisappearingMessagesTimer()) {
recipients.setExpireMessages(groupRecipientId, groupState.disappearingMessagesTimer.duration)
}
if (groupId.isMms || Recipient.resolved(groupRecipientId).isProfileSharing) {
recipients.setHasGroupsInCommon(groupMembers)
}
Recipient.live(groupRecipientId).refresh()
notifyConversationListListeners()
return true
}
fun update(groupId: GroupId.V1, title: String?, avatar: SignalServiceAttachmentPointer?) {
val contentValues = ContentValues().apply {
if (title != null) {
put(TITLE, title)
}
if (avatar != null) {
put(AVATAR_ID, avatar.remoteId.v2.get())
put(AVATAR_CONTENT_TYPE, avatar.contentType)
put(AVATAR_KEY, avatar.key)
put(AVATAR_DIGEST, avatar.digest.orElse(null))
} else {
put(AVATAR_ID, 0)
}
}
writableDatabase
.update(TABLE_NAME)
.values(contentValues)
.where("$GROUP_ID = ?", groupId)
.run()
val groupRecipient = recipients.getOrInsertFromGroupId(groupId)
Recipient.live(groupRecipient).refresh()
notifyConversationListListeners()
}
/**
* Migrates a V1 group to a V2 group.
*
* @param decryptedGroup The state that represents the group on the server. This will be used to
* determine if we need to save our old membership list and stuff.
*/
fun migrateToV2(
threadId: Long,
groupIdV1: GroupId.V1,
decryptedGroup: DecryptedGroup
): GroupId.V2 {
val groupIdV2 = groupIdV1.deriveV2MigrationGroupId()
val groupMasterKey = groupIdV1.deriveV2MigrationMasterKey()
writableDatabase.withinTransaction { db ->
val record = getGroup(groupIdV1).get()
val newMembers: MutableList<RecipientId> = DecryptedGroupUtil.membersToUuidList(decryptedGroup.membersList).toRecipientIds()
val pendingMembers: List<RecipientId> = DecryptedGroupUtil.pendingToUuidList(decryptedGroup.pendingMembersList).toRecipientIds()
newMembers.addAll(pendingMembers)
val droppedMembers: List<RecipientId> = SetUtil.difference(record.members, newMembers).toList()
val unmigratedMembers: List<RecipientId> = pendingMembers + droppedMembers
val updated: Int = db.update(TABLE_NAME)
.values(
GROUP_ID to groupIdV2.toString(),
V2_MASTER_KEY to groupMasterKey.serialize(),
DISTRIBUTION_ID to DistributionId.create().toString(),
EXPECTED_V2_ID to null,
UNMIGRATED_V1_MEMBERS to if (unmigratedMembers.isEmpty()) null else unmigratedMembers.serialize()
)
.where("$GROUP_ID = ?", groupIdV1)
.run()
if (updated != 1) {
throw AssertionError()
}
recipients.updateGroupId(groupIdV1, groupIdV2)
update(groupMasterKey, decryptedGroup)
messages.insertGroupV1MigrationEvents(
record.recipientId,
threadId,
GroupMigrationMembershipChange(pendingMembers, droppedMembers)
)
}
return groupIdV2
}
fun update(groupMasterKey: GroupMasterKey, decryptedGroup: DecryptedGroup) {
update(GroupId.v2(groupMasterKey), decryptedGroup)
}
fun update(groupId: GroupId.V2, decryptedGroup: DecryptedGroup) {
val groupRecipientId: RecipientId = recipients.getOrInsertFromGroupId(groupId)
val existingGroup: Optional<GroupRecord> = getGroup(groupId)
val title: String = decryptedGroup.title
val contentValues = ContentValues()
contentValues.put(TITLE, title)
contentValues.put(V2_REVISION, decryptedGroup.revision)
contentValues.put(V2_DECRYPTED_GROUP, decryptedGroup.toByteArray())
contentValues.put(ACTIVE, if (gv2GroupActive(decryptedGroup)) 1 else 0)
if (existingGroup.isPresent && existingGroup.get().unmigratedV1Members.isNotEmpty() && existingGroup.get().isV2Group) {
val unmigratedV1Members: MutableSet<RecipientId> = existingGroup.get().unmigratedV1Members.toMutableSet()
val change = GroupChangeReconstruct.reconstructGroupChange(existingGroup.get().requireV2GroupProperties().decryptedGroup, decryptedGroup)
val addedMembers: Set<RecipientId> = DecryptedGroupUtil.membersToUuidList(change.newMembersList).toRecipientIds().toSet()
val removedMembers: Set<RecipientId> = DecryptedGroupUtil.removedMembersUuidList(change).toRecipientIds().toSet()
val addedInvites: Set<RecipientId> = DecryptedGroupUtil.pendingToUuidList(change.newPendingMembersList).toRecipientIds().toSet()
val removedInvites: Set<RecipientId> = DecryptedGroupUtil.removedPendingMembersUuidList(change).toRecipientIds().toSet()
val acceptedInvites: Set<RecipientId> = DecryptedGroupUtil.membersToUuidList(change.promotePendingMembersList).toRecipientIds().toSet()
unmigratedV1Members -= addedMembers
unmigratedV1Members -= removedMembers
unmigratedV1Members -= addedInvites
unmigratedV1Members -= removedInvites
unmigratedV1Members -= acceptedInvites
contentValues.put(UNMIGRATED_V1_MEMBERS, if (unmigratedV1Members.isEmpty()) null else unmigratedV1Members.serialize())
}
val groupMembers = getV2GroupMembers(decryptedGroup, true)
if (existingGroup.isPresent && existingGroup.get().isV2Group) {
val change = GroupChangeReconstruct.reconstructGroupChange(existingGroup.get().requireV2GroupProperties().decryptedGroup, decryptedGroup)
val removed: List<UUID> = DecryptedGroupUtil.removedMembersUuidList(change)
if (removed.isNotEmpty()) {
val distributionId = existingGroup.get().distributionId!!
Log.i(TAG, removed.size.toString() + " members were removed from group " + groupId + ". Rotating the DistributionId " + distributionId)
SenderKeyUtil.rotateOurKey(distributionId)
}
}
writableDatabase.withinTransaction { database ->
database
.update(TABLE_NAME)
.values(contentValues)
.where("$GROUP_ID = ?", groupId.toString())
.run()
performMembershipUpdate(database, groupId, groupMembers)
}
if (decryptedGroup.hasDisappearingMessagesTimer()) {
recipients.setExpireMessages(groupRecipientId, decryptedGroup.disappearingMessagesTimer.duration)
}
if (groupId.isMms || Recipient.resolved(groupRecipientId).isProfileSharing) {
recipients.setHasGroupsInCommon(groupMembers)
}
Recipient.live(groupRecipientId).refresh()
notifyConversationListListeners()
}
fun updateTitle(groupId: GroupId.V1, title: String?) {
updateTitle(groupId as GroupId, title)
}
fun updateTitle(groupId: GroupId.Mms, title: String?) {
updateTitle(groupId as GroupId, if (title.isNullOrEmpty()) null else title)
}
private fun updateTitle(groupId: GroupId, title: String?) {
if (!groupId.isV1 && !groupId.isMms) {
throw AssertionError()
}
writableDatabase
.update(TABLE_NAME)
.values(TITLE to title)
.where("$GROUP_ID = ?", groupId)
.run()
val groupRecipient = recipients.getOrInsertFromGroupId(groupId)
Recipient.live(groupRecipient).refresh()
}
/**
* Used to bust the Glide cache when an avatar changes.
*/
fun onAvatarUpdated(groupId: GroupId, hasAvatar: Boolean) {
writableDatabase
.update(TABLE_NAME)
.values(AVATAR_ID to if (hasAvatar) Math.abs(SecureRandom().nextLong()) else 0)
.where("$GROUP_ID = ?", groupId)
.run()
val groupRecipient = recipients.getOrInsertFromGroupId(groupId)