-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathPushDatabase.cpp
More file actions
991 lines (827 loc) · 40.8 KB
/
PushDatabase.cpp
File metadata and controls
991 lines (827 loc) · 40.8 KB
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
/*
* Copyright (C) 2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "PushDatabase.h"
#include "Logging.h"
#include "SQLValue.h"
#include "SQLiteFileSystem.h"
#include "SQLiteTransaction.h"
#include "SecurityOrigin.h"
#include <iterator>
#include <wtf/CrossThreadCopier.h>
#include <wtf/Expected.h>
#include <wtf/FileSystem.h>
#include <wtf/RunLoop.h>
#include <wtf/Scope.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/UniqueRef.h>
#include <wtf/text/MakeString.h>
#define PUSHDB_RELEASE_LOG(fmt, ...) RELEASE_LOG(Push, "%p - PushDatabase::" fmt, this, ##__VA_ARGS__)
#define PUSHDB_RELEASE_LOG_ERROR(fmt, ...) RELEASE_LOG_ERROR(Push, "%p - PushDatabase::" fmt, this, ##__VA_ARGS__)
#define kPushRecordColumns " sub.rowID, ss.bundleID, ss.pushPartition, ss.dataStoreUUID, ss.securityOrigin, sub.scope, sub.endpoint, sub.topic, sub.serverVAPIDPublicKey, sub.clientPublicKey, sub.clientPrivateKey, sub.sharedAuthSecret, sub.expirationTime "
// This helper makers sure that we always bind the empty string rather than NULL for the
// subscription set identifier columns. This is because these columns are part of a unique index
// constraint. Since all NULL values are treated as distinct by SQLite, this would render the unique
// index constraint meaningless.
#define bindSubscriptionSetParameters(ss) \
!(ss).bundleIdentifier.isNull() ? (ss).bundleIdentifier : emptyString(), \
!(ss).pushPartition.isNull() ? (ss).pushPartition : emptyString(), \
uuidToSpan((ss).dataStoreIdentifier)
namespace WebCore {
// In the database, the state column in the SubscriptionSets table uses 0 for enabled and 1 for ignored.
enum class SubscriptionSetsStateColumn { Enabled, Ignored };
static constexpr std::array<ASCIILiteral, 1> pushDatabaseSchemaV1Statements {
"PRAGMA auto_vacuum=INCREMENTAL"_s,
};
static constexpr std::array<ASCIILiteral, 3> pushDatabaseSchemaV2Statements {
"CREATE TABLE SubscriptionSets("
" rowID INTEGER PRIMARY KEY AUTOINCREMENT,"
" creationTime INT NOT NULL,"
" bundleID TEXT NOT NULL,"
" securityOrigin TEXT NOT NULL,"
" silentPushCount INT NOT NULL,"
" UNIQUE(bundleID, securityOrigin))"_s,
"CREATE TABLE Subscriptions("
" rowID INTEGER PRIMARY KEY AUTOINCREMENT,"
" creationTime INT NOT NULL,"
" subscriptionSetID INT NOT NULL,"
" scope TEXT NOT NULL,"
" endpoint TEXT NOT NULL,"
" topic TEXT NOT NULL UNIQUE,"
" serverVAPIDPublicKey BLOB NOT NULL,"
" clientPublicKey BLOB NOT NULL,"
" clientPrivateKey BLOB NOT NULL,"
" sharedAuthSecret BLOB NOT NULL,"
" expirationTime INT,"
" UNIQUE(scope, subscriptionSetID))"_s,
"CREATE INDEX Subscriptions_SubscriptionSetID_Index ON Subscriptions(subscriptionSetID)"_s,
};
static constexpr std::array<ASCIILiteral, 1> pushDatabaseSchemaV3Statements {
"CREATE TABLE Metadata(key TEXT, value, UNIQUE(key))"_s,
};
static constexpr std::array<ASCIILiteral, 1> pushDatabaseSchemaV4Statements {
"ALTER TABLE SubscriptionSets ADD COLUMN state INT NOT NULL DEFAULT 0"_s,
};
static constexpr std::array<ASCIILiteral, 4> pushDatabaseSchemaV5Statements {
"ALTER TABLE SubscriptionSets RENAME TO SubscriptionSetsOld"_s,
"CREATE TABLE SubscriptionSets("
" rowID INTEGER PRIMARY KEY AUTOINCREMENT,"
" creationTime INT NOT NULL,"
" bundleID TEXT NOT NULL,"
" pushPartition TEXT NOT NULL,"
" dataStoreUUID BLOB NOT NULL,"
" securityOrigin TEXT NOT NULL,"
" silentPushCount INT NOT NULL,"
" state INT NOT NULL DEFAULT 0,"
" UNIQUE(bundleID, pushPartition, dataStoreUUID, securityOrigin))"_s,
"INSERT INTO SubscriptionSets SELECT rowID, creationTime, bundleID, '', X'', securityOrigin, silentPushCount, state FROM SubscriptionSetsOld"_s,
"DROP TABLE SubscriptionSetsOld"_s,
};
static constexpr std::array<std::span<const ASCIILiteral>, 5> pushDatabaseSchemaStatements {
std::span { pushDatabaseSchemaV1Statements },
std::span { pushDatabaseSchemaV2Statements },
std::span { pushDatabaseSchemaV3Statements },
std::span { pushDatabaseSchemaV4Statements },
std::span { pushDatabaseSchemaV5Statements },
};
static constexpr int currentPushDatabaseVersion = std::size(pushDatabaseSchemaStatements);
static constexpr ASCIILiteral publicTokenKey = "publicToken"_s;
PushRecord PushRecord::isolatedCopy() const &
{
return {
identifier,
subscriptionSetIdentifier.isolatedCopy(),
securityOrigin.isolatedCopy(),
scope.isolatedCopy(),
endpoint.isolatedCopy(),
topic.isolatedCopy(),
serverVAPIDPublicKey,
clientPublicKey,
clientPrivateKey,
sharedAuthSecret,
expirationTime
};
}
PushRecord PushRecord::isolatedCopy() &&
{
return {
identifier,
WTF::move(subscriptionSetIdentifier).isolatedCopy(),
WTF::move(securityOrigin).isolatedCopy(),
WTF::move(scope).isolatedCopy(),
WTF::move(endpoint).isolatedCopy(),
WTF::move(topic).isolatedCopy(),
WTF::move(serverVAPIDPublicKey),
WTF::move(clientPublicKey),
WTF::move(clientPrivateKey),
WTF::move(sharedAuthSecret),
expirationTime
};
}
RemovedPushRecord RemovedPushRecord::isolatedCopy() const &
{
return { identifier, topic.isolatedCopy(), serverVAPIDPublicKey };
}
RemovedPushRecord RemovedPushRecord::isolatedCopy() &&
{
return { identifier, WTF::move(topic).isolatedCopy(), WTF::move(serverVAPIDPublicKey) };
}
PushSubscriptionSetRecord PushSubscriptionSetRecord::isolatedCopy() const &
{
return { identifier.isolatedCopy(), securityOrigin.isolatedCopy(), enabled };
}
PushSubscriptionSetRecord PushSubscriptionSetRecord::isolatedCopy() &&
{
return { WTF::move(identifier).isolatedCopy(), WTF::move(securityOrigin).isolatedCopy(), enabled };
}
PushTopics PushTopics::isolatedCopy() const &
{
return { crossThreadCopy(enabledTopics), crossThreadCopy(ignoredTopics) };
}
PushTopics PushTopics::isolatedCopy() &&
{
return { crossThreadCopy(WTF::move(enabledTopics)), crossThreadCopy(WTF::move(ignoredTopics)) };
}
enum class ShouldDeleteAndRetry : bool { No, Yes };
static Expected<UniqueRef<SQLiteDatabase>, ShouldDeleteAndRetry> openAndMigrateDatabaseImpl(const String& path)
{
ASSERT(!RunLoop::isMain());
if (path != ":memory:"_s && !FileSystem::fileExists(path) && !FileSystem::makeAllDirectories(FileSystem::parentPath(path))) {
RELEASE_LOG_ERROR(Push, "Couldn't create PushDatabase parent directories for path %s", path.utf8().data());
return makeUnexpected(ShouldDeleteAndRetry::No);
}
auto db = WTF::makeUniqueRef<SQLiteDatabase>();
db->disableThreadingChecks();
if (!db->open(path)) {
RELEASE_LOG_ERROR(Push, "Couldn't open PushDatabase at path %s", path.utf8().data());
return makeUnexpected(ShouldDeleteAndRetry::Yes);
}
int version = 0;
{
auto sql = db->prepareStatement("PRAGMA user_version"_s);
if (!sql || sql->step() != SQLITE_ROW) {
RELEASE_LOG_ERROR(Push, "Couldn't get PushDatabase version at path %s", path.utf8().data());
return makeUnexpected(ShouldDeleteAndRetry::Yes);
}
version = sql->columnInt(0);
}
if (version < 0 || version > currentPushDatabaseVersion) {
RELEASE_LOG_ERROR(Push, "Found unexpected PushDatabase version: %d (expected: %d) at path: %s", version, currentPushDatabaseVersion, path.utf8().data());
return makeUnexpected(ShouldDeleteAndRetry::Yes);
}
if (version < currentPushDatabaseVersion) {
FileSystem::setExcludedFromBackup(FileSystem::parentPath(path), true);
SQLiteTransaction transaction(db);
transaction.begin();
for (auto i = version; i < currentPushDatabaseVersion; i++) {
for (auto statement : pushDatabaseSchemaStatements[i]) {
if (!db->executeCommand(statement)) {
RELEASE_LOG_ERROR(Push, "Error executing PushDatabase DDL statement %s at path %s: %d", statement.characters(), path.utf8().data(), db->lastError());
return makeUnexpected(ShouldDeleteAndRetry::Yes);
}
}
}
if (!db->executeCommandSlow(makeString("PRAGMA user_version = "_s, currentPushDatabaseVersion)))
RELEASE_LOG_ERROR(Push, "Error setting user version for PushDatabase at path %s: %d", path.utf8().data(), db->lastError());
transaction.commit();
}
return db;
}
static std::unique_ptr<SQLiteDatabase> openAndMigrateDatabase(const String& path)
{
ASSERT(!RunLoop::isMain());
auto result = openAndMigrateDatabaseImpl(path);
if (!result && result.error() == ShouldDeleteAndRetry::Yes) {
if (path == SQLiteDatabase::inMemoryPath() || !SQLiteFileSystem::deleteDatabaseFile(path)) {
RELEASE_LOG_ERROR(Push, "Failed to delete PushDatabase at path %s; bailing on recreating from scratch", path.utf8().data());
return nullptr;
}
RELEASE_LOG_ERROR(Push, "Deleted PushDatabase at path %s and recreating from scratch", path.utf8().data());
result = openAndMigrateDatabaseImpl(path);
}
if (!result)
return nullptr;
auto database = WTF::move(*result);
return database.moveToUniquePtr();
}
WTF_MAKE_TZONE_ALLOCATED_IMPL(PushDatabase);
void PushDatabase::create(const String& path, CreationHandler&& completionHandler)
{
ASSERT(RunLoop::isMain());
auto queue = WorkQueue::create("PushDatabase I/O Thread"_s);
queue->dispatch([queue, path = crossThreadCopy(path), completionHandler = WTF::move(completionHandler)]() mutable {
auto database = openAndMigrateDatabase(path);
WorkQueue::mainSingleton().dispatch([queue = WTF::move(queue), database = WTF::move(database), completionHandler = WTF::move(completionHandler)]() mutable {
if (!database) {
completionHandler(nullptr);
return;
}
completionHandler(adoptRef(*new PushDatabase(WTF::move(queue), makeUniqueRefFromNonNullUniquePtr(WTF::move(database)))));
});
});
}
PushDatabase::PushDatabase(Ref<WorkQueue>&& queue, UniqueRef<SQLiteDatabase>&& db)
: m_queue(WTF::move(queue))
, m_db(WTF::move(db))
{
}
PushDatabase::~PushDatabase()
{
// In practice we aren't actually expecting this to run, since a NeverDestroyed<WebPushDaemon> instance
// holds on to this object.
//
// If we intend to delete this object for real, we should probably make this object refcounted and make
// the blocks on the queue protect the database object rather than using dispatchSync.
ASSERT(RunLoop::isMain());
// Flush any outstanding requests.
m_queue->dispatchSync([]() { });
// Finalize member variables on the queue, since they were are only meant to be used on the queue.
m_queue->dispatchSync([db = WTF::move(m_db), statements = WTF::move(m_statements)]() mutable {
statements.clear();
db->close();
});
}
void PushDatabase::dispatchOnWorkQueue(Function<void()>&& function)
{
RELEASE_ASSERT(RunLoop::isMain());
m_queue->dispatch(WTF::move(function));
}
SQLiteStatementAutoResetScope PushDatabase::cachedStatementOnQueue(ASCIILiteral query)
{
ASSERT(!RunLoop::isMain());
auto it = m_statements.find(query);
if (it != m_statements.end())
return SQLiteStatementAutoResetScope(it->value.ptr());
auto statement = m_db->prepareStatement(query);
if (!statement) {
PUSHDB_RELEASE_LOG_ERROR("Failed with '%" PUBLIC_LOG_STRING "' preparing statement: %" PUBLIC_LOG_STRING, m_db->lastErrorMsg(), query.characters());
return SQLiteStatementAutoResetScope(nullptr);
}
auto statementRef = makeUniqueRefFromNonNullUniquePtr(WTF::move(statement));
CheckedPtr statementPtr = statementRef.ptr();
m_statements.add(query, WTF::move(statementRef));
return SQLiteStatementAutoResetScope(statementPtr);
}
template<typename... Args>
WebCore::SQLiteStatementAutoResetScope PushDatabase::bindStatementOnQueue(ASCIILiteral query, Args&&... args)
{
auto sql = cachedStatementOnQueue(query);
if (!sql || !sql->bind(std::forward<Args>(args)...)) {
PUSHDB_RELEASE_LOG_ERROR("Failed with %d (%" PUBLIC_LOG_STRING ") while binding statement: %" PUBLIC_LOG_STRING, m_db->lastError(), m_db->lastErrorMsg(), query.characters());
return SQLiteStatementAutoResetScope(nullptr);
}
return sql;
}
static std::span<const uint8_t> NODELETE uuidToSpan(const std::optional<WTF::UUID>& uuid)
{
if (!uuid) {
// We store a null UUID as a zero-length blob rather than a SQL NULL. This is because the
// data store UUID is part of a unique index, and storing the UUID as a SQL NULL doesn't
// work well with a unique index (since all SQL NULL values are treated as distinct values).
//
// To do this, the span must have zero length and point to a non-nullptr value. This is
// because calling sqlite3_bind_blob with a nullptr causes a SQL NULL to be stored in the
// column rather than a zero-length blob.
static const uint8_t junk = 0;
return std::span(&junk, static_cast<size_t>(0));
}
return uuid->span();
}
static std::optional<WTF::UUID> uuidFromSpan(std::span<const uint8_t> span)
{
if (span.size() != 16)
return std::nullopt;
return WTF::UUID(span.first<16>());
}
static SQLValue expirationTimeToValue(std::optional<EpochTimeStamp> timestamp)
{
if (!timestamp)
return nullptr;
return convertEpochTimeStampToSeconds(*timestamp);
}
static std::optional<EpochTimeStamp> expirationTimeFromValue(SQLValue value)
{
if (std::holds_alternative<double>(value))
return convertSecondsToEpochTimeStamp(std::get<double>(value));
return std::nullopt;
}
template <class T, class U>
static void completeOnMainQueue(CompletionHandler<void(T)>&& completionHandler, U&& result)
{
ASSERT(!RunLoop::isMain());
WorkQueue::mainSingleton().dispatch([completionHandler = WTF::move(completionHandler), result = crossThreadCopy(std::forward<U>(result))]() mutable {
completionHandler(WTF::move(result));
});
}
void PushDatabase::updatePublicToken(std::span<const uint8_t> publicToken, CompletionHandler<void(PublicTokenChanged)>&& completionHandler)
{
dispatchOnWorkQueue([this, newPublicToken = Vector<uint8_t> { publicToken }, completionHandler = WTF::move(completionHandler)]() mutable {
SQLiteTransaction transaction(m_db);
transaction.begin();
auto result = PublicTokenChanged::No;
Vector<uint8_t> currentPublicToken;
auto scope = makeScopeExit([&completionHandler, &result] {
completeOnMainQueue(WTF::move(completionHandler), result);
});
{
auto sql = bindStatementOnQueue("SELECT value FROM Metadata WHERE key = ?"_s, publicTokenKey);
if (!sql)
return;
if (sql->step() == SQLITE_ROW)
currentPublicToken = sql->columnBlob(0);
}
if (currentPublicToken == newPublicToken)
return;
{
auto sql = bindStatementOnQueue("REPLACE INTO Metadata(key, value) VALUES(?, ?)"_s, publicTokenKey, newPublicToken);
if (!sql || sql->step() != SQLITE_DONE)
return;
}
// If we are updating an old version of the database where currentPublicToken doesn't exist, just
// save the initial publicToken without deleting all subscriptions and notifying the caller that
// the token changed.
if (!currentPublicToken.isEmpty()) {
auto deleteSubscriptionSets = cachedStatementOnQueue("DELETE FROM SubscriptionSets"_s);
auto deleteSubscriptions = cachedStatementOnQueue("DELETE FROM Subscriptions"_s);
if (!deleteSubscriptionSets || !deleteSubscriptions || deleteSubscriptionSets->step() != SQLITE_DONE || deleteSubscriptions->step() != SQLITE_DONE)
return;
result = PublicTokenChanged::Yes;
}
scope.release();
transaction.commit();
completeOnMainQueue(WTF::move(completionHandler), result);
});
}
void PushDatabase::getPublicToken(CompletionHandler<void(Vector<uint8_t>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, completionHandler = WTF::move(completionHandler)]() mutable {
SQLiteTransaction transaction(m_db);
transaction.begin();
auto sql = bindStatementOnQueue("SELECT value FROM Metadata WHERE key = ?"_s, publicTokenKey);
if (!sql)
return completeOnMainQueue(WTF::move(completionHandler), Vector<uint8_t> { });
Vector<uint8_t> result;
if (sql->step() == SQLITE_ROW)
result = sql->columnBlob(0);
transaction.commit();
completeOnMainQueue(WTF::move(completionHandler), WTF::move(result));
});
}
void PushDatabase::insertRecord(const PushRecord& record, CompletionHandler<void(std::optional<PushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, record = crossThreadCopy(record), completionHandler = WTF::move(completionHandler)]() mutable {
SQLiteTransaction transaction(m_db);
transaction.begin();
int64_t subscriptionSetID = 0;
{
auto sql = bindStatementOnQueue(
"SELECT rowID FROM SubscriptionSets WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ? AND securityOrigin = ?"_s,
bindSubscriptionSetParameters(record.subscriptionSetIdentifier),
record.securityOrigin);
if (!sql)
return completeOnMainQueue(WTF::move(completionHandler), std::optional<PushRecord> { });
if (sql->step() == SQLITE_ROW)
subscriptionSetID = sql->columnInt64(0);
}
if (!subscriptionSetID) {
auto sql = bindStatementOnQueue(
"INSERT INTO SubscriptionSets VALUES(NULL, ?, ?, ?, ?, ?, 0, 0)"_s,
time(nullptr),
bindSubscriptionSetParameters(record.subscriptionSetIdentifier),
record.securityOrigin);
if (!sql || sql->step() != SQLITE_DONE)
return completeOnMainQueue(WTF::move(completionHandler), std::optional<PushRecord> { });
subscriptionSetID = m_db->lastInsertRowID();
}
{
auto sql = bindStatementOnQueue(
"INSERT INTO Subscriptions VALUES(NULL, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"_s,
time(nullptr),
subscriptionSetID,
record.scope,
record.endpoint,
record.topic,
record.serverVAPIDPublicKey,
record.clientPublicKey,
record.clientPrivateKey,
record.sharedAuthSecret,
expirationTimeToValue(record.expirationTime));
if (!sql || sql->step() != SQLITE_DONE)
return completeOnMainQueue(WTF::move(completionHandler), std::optional<PushRecord> { });
record.identifier = ObjectIdentifier<PushSubscriptionIdentifierType>(m_db->lastInsertRowID());
}
transaction.commit();
completeOnMainQueue(WTF::move(completionHandler), WTF::move(record));
});
}
void PushDatabase::removeRecordByIdentifier(PushSubscriptionIdentifier identifier, CompletionHandler<void(bool)>&& completionHandler)
{
dispatchOnWorkQueue([this, rowIdentifier = identifier.toUInt64(), completionHandler = WTF::move(completionHandler)]() mutable {
SQLiteTransaction transaction(m_db);
transaction.begin();
bool isLastSubscriptionInSet = false;
int64_t subscriptionSetID = 0;
// FIXME: Remove this and use RETURNING instead once EWS moves to a macOS build that supports it (SQLite >3.35.0).
{
auto sql = bindStatementOnQueue("SELECT subscriptionSetID FROM Subscriptions WHERE rowid = ?"_s, rowIdentifier);
if (!sql || sql->step() != SQLITE_ROW)
return completeOnMainQueue(WTF::move(completionHandler), false);
subscriptionSetID = sql->columnInt(0);
}
{
auto sql = bindStatementOnQueue("DELETE FROM Subscriptions WHERE rowid = ?"_s, rowIdentifier);
if (!sql || sql->step() != SQLITE_DONE)
return completeOnMainQueue(WTF::move(completionHandler), false);
}
{
// Check if this was the last subscription in the subscription set.
auto sql = bindStatementOnQueue("SELECT rowid FROM Subscriptions WHERE subscriptionSetID = ?"_s, subscriptionSetID);
if (!sql)
return completeOnMainQueue(WTF::move(completionHandler), false);
isLastSubscriptionInSet = (sql->step() == SQLITE_DONE);
}
if (isLastSubscriptionInSet) {
// Delete the entire subscription set if it is no longer associated with any subscriptions.
auto sql = bindStatementOnQueue("DELETE FROM SubscriptionSets WHERE rowid = ?"_s, subscriptionSetID);
if (!sql || sql->step() != SQLITE_DONE)
return completeOnMainQueue(WTF::move(completionHandler), false);
}
transaction.commit();
completeOnMainQueue(WTF::move(completionHandler), true);
});
}
static PushRecord makePushRecordFromRow(SQLiteStatementAutoResetScope& sql, int columnIndex)
{
return PushRecord {
.identifier = ObjectIdentifier<PushSubscriptionIdentifierType>(sql->columnInt64(columnIndex)),
.subscriptionSetIdentifier = {
.bundleIdentifier = sql->columnText(columnIndex + 1),
.pushPartition = sql->columnText(columnIndex + 2),
.dataStoreIdentifier = uuidFromSpan(sql->columnBlobAsSpan(columnIndex + 3))
},
.securityOrigin = sql->columnText(columnIndex + 4),
.scope = sql->columnText(columnIndex + 5),
.endpoint = sql->columnText(columnIndex + 6),
.topic = sql->columnText(columnIndex + 7),
.serverVAPIDPublicKey = sql->columnBlob(columnIndex + 8),
.clientPublicKey = sql->columnBlob(columnIndex + 9),
.clientPrivateKey = sql->columnBlob(columnIndex + 10),
.sharedAuthSecret = sql->columnBlob(columnIndex + 11),
.expirationTime = expirationTimeFromValue(sql->columnValue(columnIndex + 12))
};
}
void PushDatabase::getRecordByTopic(const String& topic, CompletionHandler<void(std::optional<PushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, topic = crossThreadCopy(topic), completionHandler = WTF::move(completionHandler)]() mutable {
// Force SQLite to consult the Subscriptions(scope) index first via CROSS JOIN.
auto sql = bindStatementOnQueue(
"SELECT " kPushRecordColumns
"FROM Subscriptions sub "
"CROSS JOIN SubscriptionSets ss "
"ON sub.subscriptionSetID = ss.rowid "
"WHERE sub.topic = ?"_s, topic);
if (!sql || sql->step() != SQLITE_ROW)
return completeOnMainQueue(WTF::move(completionHandler), std::optional<PushRecord> { });
completeOnMainQueue(WTF::move(completionHandler), makePushRecordFromRow(sql, 0));
});
}
void PushDatabase::getRecordBySubscriptionSetAndScope(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, const String& scope, CompletionHandler<void(std::optional<PushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), scope = crossThreadCopy(scope), completionHandler = WTF::move(completionHandler)]() mutable {
// Force SQLite to consult the Subscriptions(scope) index first via CROSS JOIN.
auto sql = bindStatementOnQueue(
"SELECT " kPushRecordColumns
"FROM Subscriptions sub "
"CROSS JOIN SubscriptionSets ss "
"ON sub.subscriptionSetID = ss.rowid "
"WHERE sub.scope = ? AND ss.bundleID = ? AND ss.pushPartition = ? AND ss.dataStoreUUID = ?"_s,
scope,
bindSubscriptionSetParameters(subscriptionSetIdentifier));
if (!sql || sql->step() != SQLITE_ROW)
return completeOnMainQueue(WTF::move(completionHandler), std::optional<PushRecord> { });
completeOnMainQueue(WTF::move(completionHandler), makePushRecordFromRow(sql, 0));
});
}
void PushDatabase::getIdentifiers(CompletionHandler<void(HashSet<PushSubscriptionIdentifier>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, completionHandler = WTF::move(completionHandler)]() mutable {
HashSet<PushSubscriptionIdentifier> result;
auto sql = cachedStatementOnQueue("SELECT rowid FROM Subscriptions"_s);
while (sql && sql->step() == SQLITE_ROW)
result.add(ObjectIdentifier<PushSubscriptionIdentifierType>(sql->columnInt64(0)));
completeOnMainQueue(WTF::move(completionHandler), WTF::move(result));
});
}
void PushDatabase::getTopics(CompletionHandler<void(PushTopics&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, completionHandler = WTF::move(completionHandler)]() mutable {
PushTopics topics;
auto sql = cachedStatementOnQueue(
"SELECT sub.topic, ss.state "
"FROM Subscriptions sub "
"JOIN SubscriptionSets ss "
"ON sub.subscriptionSetID = ss.rowid"_s);
if (!sql)
return completeOnMainQueue(WTF::move(completionHandler), topics);
while (sql->step() == SQLITE_ROW) {
switch (static_cast<SubscriptionSetsStateColumn>(sql->columnInt(1))) {
case SubscriptionSetsStateColumn::Enabled:
topics.enabledTopics.append(sql->columnText(0));
break;
case SubscriptionSetsStateColumn::Ignored:
topics.ignoredTopics.append(sql->columnText(0));
break;
}
}
completeOnMainQueue(WTF::move(completionHandler), WTF::move(topics));
});
}
void PushDatabase::getPushSubscriptionSetRecords(CompletionHandler<void(Vector<PushSubscriptionSetRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, completionHandler = WTF::move(completionHandler)]() mutable {
Vector<PushSubscriptionSetRecord> result;
auto sql = cachedStatementOnQueue("SELECT bundleID, pushPartition, dataStoreUUID, securityOrigin, state FROM SubscriptionSets"_s);
if (!sql)
return completeOnMainQueue(WTF::move(completionHandler), result);
while (sql->step() == SQLITE_ROW) {
PushSubscriptionSetIdentifier identifier {
.bundleIdentifier = sql->columnText(0),
.pushPartition = sql->columnText(1),
.dataStoreIdentifier = uuidFromSpan(sql->columnBlobAsSpan(2))
};
String securityOrigin = sql->columnText(3);
bool enabled = static_cast<SubscriptionSetsStateColumn>(sql->columnInt(4)) == SubscriptionSetsStateColumn::Enabled;
result.append(PushSubscriptionSetRecord { WTF::move(identifier), WTF::move(securityOrigin), enabled });
}
completeOnMainQueue(WTF::move(completionHandler), WTF::move(result));
});
}
void PushDatabase::incrementSilentPushCount(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, const String& securityOrigin, CompletionHandler<void(unsigned)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), securityOrigin = crossThreadCopy(securityOrigin), completionHandler = WTF::move(completionHandler)]() mutable {
int silentPushCount = 0;
SQLiteTransaction transaction(m_db);
transaction.begin();
{
auto sql = bindStatementOnQueue(
"UPDATE SubscriptionSets "
"SET silentPushCount = silentPushCount + 1 "
"WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ? AND securityOrigin = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier),
securityOrigin);
if (!sql || sql->step() != SQLITE_DONE)
return completeOnMainQueue(WTF::move(completionHandler), 0u);
}
// FIXME: Remove this and use RETURNING instead once EWS moves to a macOS build that supports it (SQLite >3.35.0).
{
auto sql = bindStatementOnQueue(
"SELECT silentPushCount "
"FROM SubscriptionSets "
"WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ? AND securityOrigin = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier),
securityOrigin);
if (!sql || sql->step() != SQLITE_ROW)
return completeOnMainQueue(WTF::move(completionHandler), 0u);
silentPushCount = sql->columnInt(0);
}
transaction.commit();
completeOnMainQueue(WTF::move(completionHandler), silentPushCount);
});
}
void PushDatabase::removeRecordsBySubscriptionSet(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, CompletionHandler<void(Vector<RemovedPushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), completionHandler = WTF::move(completionHandler)]() mutable {
auto scope = makeScopeExit([&completionHandler] {
completeOnMainQueue(WTF::move(completionHandler), Vector<RemovedPushRecord> { });
});
Vector<RemovedPushRecord> removedPushRecords;
SQLiteTransaction transaction(m_db);
transaction.begin();
{
auto sql = bindStatementOnQueue(
"SELECT sub.subscriptionSetID, sub.rowid, sub.topic, sub.serverVAPIDPublicKey "
"FROM SubscriptionSets ss "
"JOIN Subscriptions sub "
"ON ss.rowid = sub.subscriptionSetID "
"WHERE ss.bundleID = ? AND ss.pushPartition = ? AND ss.dataStoreUUID = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier));
if (!sql)
return;
while (sql->step() == SQLITE_ROW) {
auto identifier = ObjectIdentifier<PushSubscriptionIdentifierType>(sql->columnInt(1));
auto topic = sql->columnText(2);
auto serverVAPIDPublicKey = sql->columnBlob(3);
removedPushRecords.append({ identifier, WTF::move(topic), WTF::move(serverVAPIDPublicKey) });
}
}
{
auto sql = bindStatementOnQueue(
"DELETE FROM Subscriptions "
"WHERE subscriptionSetID IN ("
" SELECT rowid FROM SubscriptionSets "
" WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ? "
")"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier));
if (!sql || sql->step() != SQLITE_DONE)
return;
}
{
auto sql = bindStatementOnQueue(
"DELETE FROM SubscriptionSets "
"WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier));
if (!sql || sql->step() != SQLITE_DONE)
return;
}
transaction.commit();
scope.release();
completeOnMainQueue(WTF::move(completionHandler), WTF::move(removedPushRecords));
});
}
void PushDatabase::removeRecordsBySubscriptionSetAndSecurityOrigin(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, const String& securityOrigin, CompletionHandler<void(Vector<RemovedPushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), securityOrigin = crossThreadCopy(securityOrigin), completionHandler = WTF::move(completionHandler)]() mutable {
auto scope = makeScopeExit([&completionHandler] {
completeOnMainQueue(WTF::move(completionHandler), Vector<RemovedPushRecord> { });
});
Vector<RemovedPushRecord> removedPushRecords;
SQLiteTransaction transaction(m_db);
transaction.begin();
int64_t subscriptionSetID = 0;
{
auto sql = bindStatementOnQueue(
"SELECT sub.subscriptionSetID, sub.rowid, sub.topic, sub.serverVAPIDPublicKey "
"FROM SubscriptionSets ss "
"JOIN Subscriptions sub "
"ON ss.rowid = sub.subscriptionSetID "
"WHERE ss.bundleID = ? AND ss.pushPartition = ? AND ss.dataStoreUUID = ? AND ss.securityOrigin = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier),
securityOrigin);
if (!sql)
return;
while (sql->step() == SQLITE_ROW) {
subscriptionSetID = sql->columnInt(0);
auto identifier = ObjectIdentifier<PushSubscriptionIdentifierType>(sql->columnInt(1));
auto topic = sql->columnText(2);
auto serverVAPIDPublicKey = sql->columnBlob(3);
removedPushRecords.append({ identifier, WTF::move(topic), WTF::move(serverVAPIDPublicKey) });
}
}
{
auto sql = bindStatementOnQueue("DELETE FROM Subscriptions WHERE subscriptionSetID = ?"_s, subscriptionSetID);
if (!sql || sql->step() != SQLITE_DONE)
return;
}
{
auto sql = bindStatementOnQueue("DELETE FROM SubscriptionSets WHERE rowid = ?"_s, subscriptionSetID);
if (!sql || sql->step() != SQLITE_DONE)
return;
}
transaction.commit();
scope.release();
completeOnMainQueue(WTF::move(completionHandler), WTF::move(removedPushRecords));
});
}
void PushDatabase::removeRecordsByBundleIdentifierAndDataStore(const String& bundleIdentifier, const std::optional<WTF::UUID>& dataStoreIdentifier, CompletionHandler<void(Vector<RemovedPushRecord>&&)>&& completionHandler)
{
dispatchOnWorkQueue([this, bundleIdentifier = crossThreadCopy(bundleIdentifier), dataStoreIdentifier, completionHandler = WTF::move(completionHandler)]() mutable {
auto scope = makeScopeExit([&completionHandler] {
completeOnMainQueue(WTF::move(completionHandler), Vector<RemovedPushRecord> { });
});
Vector<RemovedPushRecord> removedPushRecords;
SQLiteTransaction transaction(m_db);
transaction.begin();
{
auto sql = bindStatementOnQueue(
"SELECT sub.subscriptionSetID, sub.rowid, sub.topic, sub.serverVAPIDPublicKey "
"FROM SubscriptionSets ss "
"JOIN Subscriptions sub "
"ON ss.rowid = sub.subscriptionSetID "
"WHERE ss.bundleID = ? AND ss.dataStoreUUID = ?"_s,
!bundleIdentifier.isNull() ? bundleIdentifier : emptyString(),
uuidToSpan(dataStoreIdentifier));
if (!sql)
return;
while (sql->step() == SQLITE_ROW) {
auto identifier = ObjectIdentifier<PushSubscriptionIdentifierType>(sql->columnInt(1));
auto topic = sql->columnText(2);
auto serverVAPIDPublicKey = sql->columnBlob(3);
removedPushRecords.append({ identifier, WTF::move(topic), WTF::move(serverVAPIDPublicKey) });
}
}
{
auto sql = bindStatementOnQueue(
"DELETE FROM Subscriptions "
"WHERE subscriptionSetID IN ("
" SELECT rowid FROM SubscriptionSets "
" WHERE bundleID = ? AND dataStoreUUID = ? "
")"_s,
!bundleIdentifier.isNull() ? bundleIdentifier : emptyString(),
uuidToSpan(dataStoreIdentifier));
if (!sql || sql->step() != SQLITE_DONE)
return;
}
{
auto sql = bindStatementOnQueue(
"DELETE FROM SubscriptionSets "
"WHERE bundleID = ? AND dataStoreUUID = ?"_s,
!bundleIdentifier.isNull() ? bundleIdentifier : emptyString(),
uuidToSpan(dataStoreIdentifier));
if (!sql || sql->step() != SQLITE_DONE)
return;
}
transaction.commit();
scope.release();
completeOnMainQueue(WTF::move(completionHandler), WTF::move(removedPushRecords));
});
}
void PushDatabase::setPushesEnabled(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, bool enabled, CompletionHandler<void(bool recordsChanged)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), enabled, completionHandler = WTF::move(completionHandler)]() mutable {
auto scope = makeScopeExit([&completionHandler] {
completeOnMainQueue(WTF::move(completionHandler), false);
});
SQLiteTransaction transaction(m_db);
transaction.begin();
Vector<int64_t> subscriptionSetIDs;
auto newState = enabled ? SubscriptionSetsStateColumn::Enabled : SubscriptionSetsStateColumn::Ignored;
{
auto sql = bindStatementOnQueue(
"SELECT rowid, state "
"FROM SubscriptionSets "
"WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier));
if (!sql)
return;
while (sql->step() == SQLITE_ROW) {
auto currentState = static_cast<SubscriptionSetsStateColumn>(sql->columnInt(1));
if (currentState != newState)
subscriptionSetIDs.append(sql->columnInt64(0));
}
}
if (subscriptionSetIDs.isEmpty())
return;
for (auto subscriptionSetID : subscriptionSetIDs) {
auto sql = bindStatementOnQueue("UPDATE SubscriptionSets SET state = ? WHERE rowid = ?"_s, static_cast<int>(newState), subscriptionSetID);
if (!sql || sql->step() != SQLITE_DONE)
return;
}
transaction.commit();
scope.release();
completeOnMainQueue(WTF::move(completionHandler), true);
});
}
void PushDatabase::setPushesEnabledForOrigin(const PushSubscriptionSetIdentifier& subscriptionSetIdentifier, const String& securityOrigin, bool enabled, CompletionHandler<void(bool recordsChanged)>&& completionHandler)
{
dispatchOnWorkQueue([this, subscriptionSetIdentifier = crossThreadCopy(subscriptionSetIdentifier), securityOrigin = crossThreadCopy(securityOrigin), enabled, completionHandler = WTF::move(completionHandler)]() mutable {
auto scope = makeScopeExit([&completionHandler] {
completeOnMainQueue(WTF::move(completionHandler), false);
});
SQLiteTransaction transaction(m_db);
transaction.begin();
int64_t subscriptionSetID = 0;
auto newState = enabled ? SubscriptionSetsStateColumn::Enabled : SubscriptionSetsStateColumn::Ignored;
{
auto sql = bindStatementOnQueue(
"SELECT rowid, state "
"FROM SubscriptionSets "
"WHERE bundleID = ? AND pushPartition = ? AND dataStoreUUID = ? AND securityOrigin = ?"_s,
bindSubscriptionSetParameters(subscriptionSetIdentifier),
securityOrigin);
if (!sql || sql->step() != SQLITE_ROW || static_cast<SubscriptionSetsStateColumn>(sql->columnInt(1)) == newState)
return;
subscriptionSetID = sql->columnInt64(0);
}
{
auto sql = bindStatementOnQueue("UPDATE SubscriptionSets SET state = ? WHERE rowid = ?"_s, static_cast<int>(newState), subscriptionSetID);
if (!sql || sql->step() != SQLITE_DONE)
return;
}
transaction.commit();
scope.release();
completeOnMainQueue(WTF::move(completionHandler), true);
});
}
} // namespace WebCore