-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathAPIContentRuleListStore.cpp
More file actions
793 lines (659 loc) · 33.2 KB
/
APIContentRuleListStore.cpp
File metadata and controls
793 lines (659 loc) · 33.2 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
/*
* Copyright (C) 2015-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 "APIContentRuleListStore.h"
#if ENABLE(CONTENT_EXTENSIONS)
#include "APIContentRuleList.h"
#include "Logging.h"
#include "NetworkCacheData.h"
#include "NetworkCacheFileSystem.h"
#include "WebCompiledContentRuleList.h"
#include <WebCore/CommonAtomStrings.h>
#include <WebCore/ContentExtensionCompiler.h>
#include <WebCore/ContentExtensionError.h>
#include <WebCore/ContentExtensionParser.h>
#include <WebCore/DFABytecodeInterpreter.h>
#include <WebCore/QualifiedName.h>
#include <WebCore/SharedBuffer.h>
#include <WebCore/SharedMemory.h>
#include <string>
#include <wtf/CompletionHandler.h>
#include <wtf/CrossThreadCopier.h>
#include <wtf/FileHandle.h>
#include <wtf/FileSystem.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/RunLoop.h>
#include <wtf/StdLibExtras.h>
#include <wtf/WeakRandom.h>
#include <wtf/WorkQueue.h>
#include <wtf/persistence/PersistentDecoder.h>
#include <wtf/persistence/PersistentEncoder.h>
#include <wtf/text/MakeString.h>
namespace API {
using namespace WebKit::NetworkCache;
using namespace FileSystem;
static WorkQueue& fileSystemQueueSingleton()
{
static MainRunLoopNeverDestroyed<Ref<WorkQueue>> fileSystemQueue = WorkQueue::create("ContentRuleListStore FileSystem Queue"_s);
return fileSystemQueue.get().get();
}
ContentRuleListStore& ContentRuleListStore::defaultStoreSingleton()
{
static NeverDestroyed<Ref<ContentRuleListStore>> defaultStore = adoptRef(*new ContentRuleListStore);
return defaultStore->get();
}
Ref<ContentRuleListStore> ContentRuleListStore::storeWithPath(const WTF::String& storePath)
{
return adoptRef(*new ContentRuleListStore(storePath));
}
ContentRuleListStore::ContentRuleListStore()
: ContentRuleListStore(defaultStorePath())
{
}
ContentRuleListStore::ContentRuleListStore(const WTF::String& storePath)
: m_storePath(storePath)
{
makeAllDirectories(storePath);
}
ContentRuleListStore::~ContentRuleListStore() = default;
static constexpr auto constructedPathPrefix { "ContentRuleList-"_s };
static WTF::String constructedPath(const WTF::String& base, const WTF::String& identifier)
{
RELEASE_ASSERT(!base.isEmpty());
return pathByAppendingComponent(base, makeString(constructedPathPrefix, encodeForFileName(identifier)));
}
// The size and offset of the densely packed bytes in the file, not sizeof and offsetof, which would
// represent the size and offset of the structure in memory, possibly with compiler-added padding.
constexpr size_t currentVersionFileHeaderSize = 2 * sizeof(uint32_t) + 7 * sizeof(uint64_t);
static constexpr size_t NODELETE headerSize(uint32_t version)
{
if (version < 12)
return 2 * sizeof(uint32_t) + 5 * sizeof(uint64_t);
return currentVersionFileHeaderSize;
}
struct ContentRuleListMetaData {
uint32_t version { ContentRuleListStore::CurrentContentRuleListFileVersion };
uint64_t sourceSize { 0 };
uint64_t actionsSize { 0 };
uint64_t urlFiltersBytecodeSize { 0 };
uint64_t topURLFiltersBytecodeSize { 0 };
uint64_t frameURLFiltersBytecodeSize { 0 };
uint32_t unused32bits { false };
uint64_t unused64bits1 { 0 };
uint64_t unused64bits2 { 0 }; // Additional space on disk reserved so we can add something without incrementing the version number.
size_t NODELETE fileSize() const
{
return headerSize(version)
+ sourceSize
+ actionsSize
+ urlFiltersBytecodeSize
+ topURLFiltersBytecodeSize
+ frameURLFiltersBytecodeSize;
}
};
static WebKit::NetworkCache::Data encodeContentRuleListMetaData(const ContentRuleListMetaData& metaData)
{
WTF::Persistence::Encoder encoder;
encoder << metaData.version;
encoder << metaData.sourceSize;
encoder << metaData.actionsSize;
encoder << metaData.urlFiltersBytecodeSize;
encoder << metaData.topURLFiltersBytecodeSize;
encoder << metaData.frameURLFiltersBytecodeSize;
encoder << metaData.unused32bits;
encoder << metaData.unused64bits1;
encoder << metaData.unused64bits2;
ASSERT(encoder.bufferSize() == currentVersionFileHeaderSize);
return WebKit::NetworkCache::Data(encoder.span());
}
template<typename T> void getData(const T&, NOESCAPE const Function<bool(std::span<const uint8_t>)>&);
template<> void getData(const WebKit::NetworkCache::Data& data, NOESCAPE const Function<bool(std::span<const uint8_t>)>& function)
{
data.apply(function);
}
template<> void getData(const WebCore::SharedBuffer& data, NOESCAPE const Function<bool(std::span<const uint8_t>)>& function)
{
function(data.span());
}
static std::optional<ContentRuleListMetaData> decodeContentRuleListMetaData(const WebKit::NetworkCache::Data& fileData)
{
ContentRuleListMetaData metaData;
auto span = fileData.span();
WTF::Persistence::Decoder decoder(span);
std::optional<uint32_t> version;
decoder >> version;
if (!version)
return std::nullopt;
metaData.version = WTF::move(*version);
std::optional<uint64_t> sourceSize;
decoder >> sourceSize;
if (!sourceSize)
return std::nullopt;
metaData.sourceSize = WTF::move(*sourceSize);
std::optional<uint64_t> actionsSize;
decoder >> actionsSize;
if (!actionsSize)
return std::nullopt;
metaData.actionsSize = WTF::move(*actionsSize);
std::optional<uint64_t> urlFiltersBytecodeSize;
decoder >> urlFiltersBytecodeSize;
if (!urlFiltersBytecodeSize)
return std::nullopt;
metaData.urlFiltersBytecodeSize = WTF::move(*urlFiltersBytecodeSize);
std::optional<uint64_t> topURLFiltersBytecodeSize;
decoder >> topURLFiltersBytecodeSize;
if (!topURLFiltersBytecodeSize)
return std::nullopt;
metaData.topURLFiltersBytecodeSize = WTF::move(*topURLFiltersBytecodeSize);
std::optional<uint64_t> frameURLFiltersBytecodeSize;
decoder >> frameURLFiltersBytecodeSize;
if (!frameURLFiltersBytecodeSize)
return std::nullopt;
metaData.frameURLFiltersBytecodeSize = WTF::move(*frameURLFiltersBytecodeSize);
std::optional<uint32_t> unused32bits;
decoder >> unused32bits;
if (!unused32bits)
return std::nullopt;
metaData.unused32bits = 0;
if (metaData.version < 12)
return metaData;
std::optional<uint64_t> unused1;
decoder >> unused1;
if (!unused1)
return std::nullopt;
metaData.unused64bits1 = 0;
std::optional<uint64_t> unused2;
decoder >> unused2;
if (!unused2)
return std::nullopt;
metaData.unused64bits2 = 0;
return metaData;
}
struct MappedData {
ContentRuleListMetaData metaData;
WebKit::NetworkCache::Data data;
};
static bool validateContentRuleListActionsMatchingEverything(const WTF::String& path, const WebKit::NetworkCache::Data& fileData, const ContentRuleListMetaData& metaData)
{
const size_t headerAndSourceSize = headerSize(metaData.version) + metaData.sourceSize;
const size_t actionsOffset = headerAndSourceSize;
const size_t urlFiltersOffset = actionsOffset + metaData.actionsSize;
if (!metaData.urlFiltersBytecodeSize)
return true;
if (urlFiltersOffset + metaData.urlFiltersBytecodeSize > fileData.size())
return false;
WebCore::ContentExtensions::DFABytecodeInterpreter interpreter(fileData.span().subspan(urlFiltersOffset, metaData.urlFiltersBytecodeSize));
auto universalActions = copyToVector(interpreter.actionsMatchingEverything());
for (uint64_t universalActionLocation : universalActions) {
if (universalActionLocation >= metaData.actionsSize) {
LOG(ContentRuleLists, "Universal action has location outside range of serialized actions. The compiled extension may be corrupted: %s", path.utf8().data());
return false;
}
}
return true;
}
static std::optional<MappedData> openAndMapContentRuleList(const WTF::String& path)
{
if (!FileSystem::makeSafeToUseMemoryMapForPath(path))
return std::nullopt;
auto fileData = mapFile(path);
if (fileData.isNull())
return std::nullopt;
auto metaData = decodeContentRuleListMetaData(fileData);
if (!metaData)
return std::nullopt;
return {{ WTF::move(*metaData), { WTF::move(fileData) }}};
}
static bool writeDataToFile(const WebKit::NetworkCache::Data& fileData, FileHandle& fileHandle)
{
bool success = true;
fileData.apply([&fileHandle, &success](std::span<const uint8_t> span) {
if (!fileHandle.write(span)) {
success = false;
return false;
}
return true;
});
return success;
}
static Expected<MappedData, std::error_code> compiledToFile(WTF::String&& json, Vector<WebCore::ContentExtensions::ContentExtensionRule>&& parsedRules, const WTF::String& finalFilePath)
{
using namespace WebCore::ContentExtensions;
class CompilationClient final : public ContentExtensionCompilationClient {
public:
CompilationClient(FileSystem::FileHandle&& fileHandle, ContentRuleListMetaData& metaData)
: m_fileHandle(WTF::move(fileHandle))
, m_metaData(metaData)
{
ASSERT(!metaData.sourceSize);
ASSERT(!metaData.actionsSize);
ASSERT(!metaData.urlFiltersBytecodeSize);
ASSERT(!metaData.topURLFiltersBytecodeSize);
ASSERT(!metaData.frameURLFiltersBytecodeSize);
}
void writeSource(WTF::String&& sourceJSON) final
{
ASSERT(!m_sourceWritten);
ASSERT(!m_actionsWritten);
ASSERT(!m_urlFiltersBytecodeWritten);
ASSERT(!m_topURLFiltersBytecodeWritten);
ASSERT(!m_frameURLFiltersBytecodeWritten);
writeToFile(sourceJSON.is8Bit());
m_sourceWritten += sizeof(bool);
if (sourceJSON.is8Bit()) {
writeToFile(WebKit::NetworkCache::Data(sourceJSON.span8()));
m_sourceWritten += sourceJSON.length();
} else {
writeToFile(WebKit::NetworkCache::Data(asBytes(sourceJSON.span16())));
m_sourceWritten += sourceJSON.length() * sizeof(char16_t);
}
}
void writeActions(Vector<SerializedActionByte>&& actions) final
{
ASSERT(!m_actionsWritten);
ASSERT(!m_urlFiltersBytecodeWritten);
ASSERT(!m_topURLFiltersBytecodeWritten);
ASSERT(!m_frameURLFiltersBytecodeWritten);
m_actionsWritten += actions.size();
writeToFile(WebKit::NetworkCache::Data(actions.span()));
}
void writeURLFiltersBytecode(Vector<DFABytecode>&& bytecode) final
{
ASSERT(!m_topURLFiltersBytecodeWritten);
ASSERT(!m_frameURLFiltersBytecodeWritten);
m_urlFiltersBytecodeWritten += bytecode.size();
writeToFile(WebKit::NetworkCache::Data(bytecode.span()));
}
void writeTopURLFiltersBytecode(Vector<DFABytecode>&& bytecode) final
{
ASSERT(!m_frameURLFiltersBytecodeWritten);
m_topURLFiltersBytecodeWritten += bytecode.size();
writeToFile(WebKit::NetworkCache::Data(bytecode.span()));
}
void writeFrameURLFiltersBytecode(Vector<DFABytecode>&& bytecode) final
{
m_frameURLFiltersBytecodeWritten += bytecode.size();
writeToFile(WebKit::NetworkCache::Data(bytecode.span()));
}
void finalize() final
{
m_metaData.sourceSize = m_sourceWritten;
m_metaData.actionsSize = m_actionsWritten;
m_metaData.urlFiltersBytecodeSize = m_urlFiltersBytecodeWritten;
m_metaData.topURLFiltersBytecodeSize = m_topURLFiltersBytecodeWritten;
m_metaData.frameURLFiltersBytecodeSize = m_frameURLFiltersBytecodeWritten;
WebKit::NetworkCache::Data header = encodeContentRuleListMetaData(m_metaData);
if (!m_hadFileError && !m_fileHandle.seek(0ll, FileSeekOrigin::Beginning)) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: seek to file beginning failed");
m_fileHandle = { };
m_hadFileError = true;
return;
}
writeToFile(header);
// Close file to flush changes to disk.
m_fileHandle = { };
}
bool NODELETE hadErrorWhileWritingToFile() { return m_hadFileError; }
private:
void writeToFile(bool value)
{
writeToFile(WebKit::NetworkCache::Data(asByteSpan(value)));
}
void writeToFile(const WebKit::NetworkCache::Data& data)
{
if (!m_hadFileError && !writeDataToFile(data, m_fileHandle)) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: writeDataToFile failed");
m_fileHandle = { };
m_hadFileError = true;
}
}
FileSystem::FileHandle m_fileHandle;
ContentRuleListMetaData& m_metaData;
size_t m_sourceWritten { 0 };
size_t m_actionsWritten { 0 };
size_t m_urlFiltersBytecodeWritten { 0 };
size_t m_topURLFiltersBytecodeWritten { 0 };
size_t m_frameURLFiltersBytecodeWritten { 0 };
bool m_hadFileError { false };
};
auto [temporaryFilePath, temporaryFileHandle] = openTemporaryFile("ContentRuleList"_s);
if (!temporaryFileHandle) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Opening temporary file failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
std::array<uint8_t, currentVersionFileHeaderSize> invalidHeader;
invalidHeader.fill(0xFF);
// This header will be rewritten in CompilationClient::finalize.
if (!temporaryFileHandle.write(invalidHeader)) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Writing header to file failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
ContentRuleListMetaData metaData;
CompilationClient compilationClient(WTF::move(temporaryFileHandle), metaData);
if (auto compilerError = compileRuleList(compilationClient, WTF::move(json), WTF::move(parsedRules))) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Compiling failed.");
return makeUnexpected(compilerError);
}
if (compilationClient.hadErrorWhileWritingToFile()) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Writing to file failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
// Try and delete any files at the destination instead of overwriting them
// in case there is already a file there and it is mmapped.
deleteFile(finalFilePath);
if (!moveFile(temporaryFilePath, finalFilePath)) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Moving file failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
if (!FileSystem::makeSafeToUseMemoryMapForPath(finalFilePath)) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: makeSafeToUseMemoryMapForPath failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
auto mappedData = mapFile(finalFilePath);
if (mappedData.isNull()) {
RELEASE_LOG_ERROR(ContentRuleLists, "Content Rule List compiling failed: Mapping file failed.");
return makeUnexpected(ContentRuleListStore::Error::CompileFailed);
}
return {{ WTF::move(metaData), WTF::move(mappedData) }};
}
static Ref<API::ContentRuleList> createExtension(WTF::String&& identifier, MappedData&& data)
{
auto sharedMemory = data.data.tryCreateSharedMemory();
// Content extensions are always compiled to files, and at this point the file
// has been already mapped, therefore tryCreateSharedMemory() cannot fail.
RELEASE_ASSERT(sharedMemory);
const size_t headerAndSourceSize = headerSize(data.metaData.version) + data.metaData.sourceSize;
const size_t actionsOffset = headerAndSourceSize;
const size_t urlFiltersOffset = actionsOffset + data.metaData.actionsSize;
const size_t topURLFiltersOffset = urlFiltersOffset + data.metaData.urlFiltersBytecodeSize;
const size_t frameURLFiltersOffset = topURLFiltersOffset + data.metaData.topURLFiltersBytecodeSize;
auto compiledContentRuleListData = WebKit::WebCompiledContentRuleListData(
WTF::move(identifier),
sharedMemory.releaseNonNull(),
actionsOffset,
data.metaData.actionsSize,
urlFiltersOffset,
data.metaData.urlFiltersBytecodeSize,
topURLFiltersOffset,
data.metaData.topURLFiltersBytecodeSize,
frameURLFiltersOffset,
data.metaData.frameURLFiltersBytecodeSize
);
RefPtr compiledContentRuleList = WebKit::WebCompiledContentRuleList::create(WTF::move(compiledContentRuleListData));
ASSERT(compiledContentRuleList);
return API::ContentRuleList::create(compiledContentRuleList.releaseNonNull(), WTF::move(data.data));
}
static WTF::String getContentRuleListSourceFromMappedFile(const MappedData& mappedData)
{
ASSERT(!RunLoop::isMain());
if (mappedData.metaData.version == std::numeric_limits<decltype(mappedData.metaData.version)>::max()) {
WTFLogAlways("Content Rule List source recovery failed: Version is invalid.");
return { };
}
if (mappedData.metaData.version < 9) {
WTFLogAlways("Content Rule List source recovery failed: Version is too old to recover the original JSON source from disk.");
return { };
}
auto sourceSizeBytes = mappedData.metaData.sourceSize;
if (!sourceSizeBytes || sourceSizeBytes == std::numeric_limits<decltype(sourceSizeBytes)>::max()) {
WTFLogAlways("Content Rule List source recovery failed: No source size specified; cannot retrieve content.");
return { };
}
auto headerSizeBytes = headerSize(mappedData.metaData.version);
if (headerSizeBytes > std::numeric_limits<decltype(headerSizeBytes)>::max() - sourceSizeBytes) {
WTFLogAlways("Content Rule List source recovery failed: Source size is invalid and would overflow.");
return { };
}
auto dataSpan = mappedData.data.span();
if (dataSpan.size() < headerSizeBytes + sourceSizeBytes) {
WTFLogAlways("Content Rule List source recovery failed: Data size is smaller than the header and source size; data is invalid.");
return { };
}
bool is8Bit = dataSpan[headerSizeBytes];
size_t start = headerSizeBytes + sizeof(bool);
size_t length = sourceSizeBytes - sizeof(bool);
if (is8Bit)
return byteCast<Latin1Character>(dataSpan.subspan(start, length));
if (length % sizeof(char16_t)) {
ASSERT_NOT_REACHED();
WTFLogAlways("Content Rule List source recovery failed: Length is not a multiple of char16_t size; data is corrupted.");
return { };
}
return spanReinterpretCast<const char16_t>(dataSpan.subspan(start, length));
}
void ContentRuleListStore::lookupContentRuleList(WTF::String&& identifier, CompletionHandler<void(RefPtr<API::ContentRuleList>, std::error_code)> completionHandler)
{
auto filePath = constructedPath(m_storePath, identifier);
lookupContentRuleListFile(WTF::move(filePath), WTF::move(identifier), WTF::move(completionHandler));
}
void ContentRuleListStore::lookupContentRuleListFile(WTF::String&& filePath, WTF::String&& identifier, CompletionHandler<void(RefPtr<API::ContentRuleList>, std::error_code)> completionHandler)
{
ASSERT(RunLoop::isMain());
fileSystemQueueSingleton().dispatch([protectedThis = Ref { *this }, filePath = WTF::move(filePath).isolatedCopy(), identifier = WTF::move(identifier).isolatedCopy(), completionHandler = WTF::move(completionHandler)]() mutable {
auto contentRuleList = openAndMapContentRuleList(filePath);
if (!contentRuleList) {
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler)] () mutable {
completionHandler(nullptr, Error::LookupFailed);
});
return;
}
bool versionMismatch = contentRuleList->metaData.version != ContentRuleListStore::CurrentContentRuleListFileVersion;
bool fileSizeMismatch = contentRuleList->metaData.fileSize() != contentRuleList->data.size();
bool actionsMatchingEverythingValid = validateContentRuleListActionsMatchingEverything(identifier, contentRuleList->data, contentRuleList->metaData);
if (versionMismatch || fileSizeMismatch || !actionsMatchingEverythingValid) {
if (auto sourceFromOldVersion = getContentRuleListSourceFromMappedFile(*contentRuleList); actionsMatchingEverythingValid && !sourceFromOldVersion.isEmpty()) {
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), sourceFromOldVersion = WTF::move(sourceFromOldVersion).isolatedCopy(), identifier = WTF::move(identifier).isolatedCopy(), completionHandler = WTF::move(completionHandler)] () mutable {
protectedThis->compileContentRuleList(WTF::move(identifier), WTF::move(sourceFromOldVersion), WTF::move(completionHandler));
});
return;
}
RunLoop::mainSingleton().dispatch([versionMismatch, protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler)] () mutable {
completionHandler(nullptr, versionMismatch ? Error::VersionMismatch : (Error::LookupFailed));
});
return;
}
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), identifier = WTF::move(identifier).isolatedCopy(), contentRuleList = WTF::move(*contentRuleList), completionHandler = WTF::move(completionHandler)] () mutable {
completionHandler(createExtension(WTF::move(identifier), WTF::move(contentRuleList)), { });
});
});
}
void ContentRuleListStore::getAvailableContentRuleListIdentifiers(CompletionHandler<void(WTF::Vector<WTF::String>)> completionHandler)
{
ASSERT(RunLoop::isMain());
fileSystemQueueSingleton().dispatch([protectedThis = Ref { *this }, storePath = m_storePath.isolatedCopy(), completionHandler = WTF::move(completionHandler)]() mutable {
Vector<WTF::String> identifiers;
for (auto& fileName : listDirectory(storePath)) {
if (fileName.startsWith(constructedPathPrefix))
identifiers.append(decodeFromFilename(fileName.substring(constructedPathPrefix.length())));
}
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler), identifiers = WTF::move(identifiers)]() mutable {
completionHandler(WTF::move(identifiers));
});
});
}
void ContentRuleListStore::compileContentRuleList(WTF::String&& identifier, WTF::String&& json, CompletionHandler<void(RefPtr<API::ContentRuleList>, std::error_code)> completionHandler)
{
auto filePath = constructedPath(m_storePath, identifier);
compileContentRuleListFile(WTF::move(filePath), WTF::move(identifier), WTF::move(json), WebCore::ContentExtensions::CSSSelectorsAllowed::Yes, WTF::move(completionHandler));
}
void ContentRuleListStore::compileContentRuleListFile(WTF::String&& filePath, WTF::String&& identifier, WTF::String&& json, WebCore::ContentExtensions::CSSSelectorsAllowed cssSelectorsAllowed, CompletionHandler<void(RefPtr<API::ContentRuleList>, std::error_code)> completionHandler)
{
ASSERT(RunLoop::isMain());
WebCore::initializeCommonAtomStrings();
WebCore::QualifiedName::init();
Expected<Vector<WebCore::ContentExtensions::ContentExtensionRule>, std::error_code> parsedRules;
if (cssSelectorsAllowed == WebCore::ContentExtensions::CSSSelectorsAllowed::Yes) {
parsedRules = WebCore::ContentExtensions::parseRuleList(json, cssSelectorsAllowed);
if (!parsedRules.has_value())
return completionHandler(nullptr, parsedRules.error());
}
fileSystemQueueSingleton().dispatch([protectedThis = Ref { *this }, filePath = WTF::move(filePath).isolatedCopy(), identifier = WTF::move(identifier).isolatedCopy(), json = WTF::move(json).isolatedCopy(), parsedRules = crossThreadCopy(WTF::move(parsedRules).value()), storePath = m_storePath.isolatedCopy(), completionHandler = WTF::move(completionHandler), cssSelectorsAllowed] () mutable {
if (cssSelectorsAllowed == WebCore::ContentExtensions::CSSSelectorsAllowed::No) {
auto parsedRulesOnBackgroundQueue = WebCore::ContentExtensions::parseRuleList(json, cssSelectorsAllowed);
if (!parsedRulesOnBackgroundQueue.has_value())
return completionHandler(nullptr, parsedRulesOnBackgroundQueue.error());
parsedRules = parsedRulesOnBackgroundQueue.value();
}
auto result = compiledToFile(WTF::move(json), WTF::move(parsedRules), filePath);
if (!result.has_value()) {
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), error = WTF::move(result.error()), completionHandler = WTF::move(completionHandler)] () mutable {
completionHandler(nullptr, error);
});
return;
}
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), identifier = WTF::move(identifier), data = WTF::move(result.value()), completionHandler = WTF::move(completionHandler)] () mutable {
auto contentRuleList = createExtension(WTF::move(identifier), WTF::move(data));
completionHandler(contentRuleList.ptr(), { });
});
});
}
void ContentRuleListStore::removeContentRuleList(WTF::String&& identifier, CompletionHandler<void(std::error_code)> completionHandler)
{
auto filePath = constructedPath(m_storePath, identifier);
removeContentRuleListFile(WTF::move(filePath), WTF::move(completionHandler));
}
void ContentRuleListStore::removeContentRuleListFile(WTF::String&& filePath, CompletionHandler<void(std::error_code)> completionHandler)
{
ASSERT(RunLoop::isMain());
fileSystemQueueSingleton().dispatch([protectedThis = Ref { *this }, filePath = WTF::move(filePath).isolatedCopy(), completionHandler = WTF::move(completionHandler)]() mutable {
auto complete = [protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler)](std::error_code error) mutable {
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler), error = WTF::move(error)] () mutable {
completionHandler(error);
});
};
if (!deleteFile(filePath))
return complete(Error::RemoveFailed);
complete({ });
});
}
void ContentRuleListStore::synchronousRemoveAllContentRuleLists()
{
for (const auto& fileName : listDirectory(m_storePath))
deleteFile(FileSystem::pathByAppendingComponent(m_storePath, fileName));
}
void ContentRuleListStore::invalidateContentRuleListVersion(const WTF::String& identifier)
{
auto fileHandle = openFile(constructedPath(m_storePath, identifier), FileOpenMode::ReadWrite);
if (!fileHandle)
return;
ContentRuleListMetaData header;
if (fileHandle.read(asMutableByteSpan(header)) != sizeof(header))
return;
// Invalidate the version by setting it to one less than the current version.
header.version = CurrentContentRuleListFileVersion - 1;
if (!fileHandle.seek(0, FileSeekOrigin::Beginning))
return;
auto bytesWritten = fileHandle.write(asByteSpan(header));
ASSERT_UNUSED(bytesWritten, bytesWritten == sizeof(header));
}
void ContentRuleListStore::corruptContentRuleListHeader(const WTF::String& identifier, bool usingCurrentVersion)
{
auto fileHandle = openFile(constructedPath(m_storePath, identifier), FileOpenMode::ReadWrite);
if (!fileHandle)
return;
static WeakRandom random;
ContentRuleListMetaData invalidHeader = { CurrentContentRuleListFileVersion - 1, random.getUint64(), random.getUint64(), random.getUint64(), random.getUint64(), random.getUint64() };
if (usingCurrentVersion)
invalidHeader.version = CurrentContentRuleListFileVersion;
auto bytesWritten = fileHandle.write(asByteSpan(invalidHeader));
ASSERT_UNUSED(bytesWritten, bytesWritten == sizeof(invalidHeader));
}
void ContentRuleListStore::corruptContentRuleListActionsMatchingEverything(const WTF::String& identifier)
{
auto path = constructedPath(m_storePath, identifier);
if (!FileSystem::makeSafeToUseMemoryMapForPath(path))
return;
auto fileData = mapFile(path);
if (fileData.isNull())
return;
auto metaData = decodeContentRuleListMetaData(fileData);
if (!metaData)
return;
auto fileHandle = openFile(constructedPath(m_storePath, identifier), FileOpenMode::ReadWrite);
if (!fileHandle)
return;
size_t headerAndSourceSize = headerSize(metaData->version) + metaData->sourceSize;
size_t actionsOffset = headerAndSourceSize;
size_t urlFiltersOffset = actionsOffset + metaData->actionsSize;
size_t dfaFirstInstructionOffset = urlFiltersOffset + sizeof(WebCore::ContentExtensions::DFAHeader);
size_t urlFilterLocationOffset = dfaFirstInstructionOffset + 1;
if (!fileHandle.seek(urlFilterLocationOffset, FileSeekOrigin::Beginning))
return;
// FIXME: we should check data[dfaFirstInstructionOffset] & DFABytecodeActionSizeMask) to decide how many bytes
std::array<uint8_t, 3> values { 0xFF, 0xFF, 0xFF };
fileHandle.write(asByteSpan(values));
}
void ContentRuleListStore::invalidateContentRuleListHeader(const WTF::String& identifier)
{
auto fileHandle = openFile(constructedPath(m_storePath, identifier), FileOpenMode::ReadWrite);
if (!fileHandle)
return;
std::array<uint8_t, currentVersionFileHeaderSize> invalidHeader;
invalidHeader.fill(0xFF);
auto bytesWritten = fileHandle.write(asByteSpan(invalidHeader));
ASSERT_UNUSED(bytesWritten, bytesWritten == sizeof(invalidHeader));
}
void ContentRuleListStore::getContentRuleListSource(WTF::String&& identifier, CompletionHandler<void(WTF::String)> completionHandler)
{
ASSERT(RunLoop::isMain());
fileSystemQueueSingleton().dispatch([protectedThis = Ref { *this }, filePath = constructedPath(m_storePath, identifier).isolatedCopy(), completionHandler = WTF::move(completionHandler)]() mutable {
auto complete = [protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler)](WTF::String&& source) mutable {
RunLoop::mainSingleton().dispatch([protectedThis = WTF::move(protectedThis), completionHandler = WTF::move(completionHandler), source = WTF::move(source).isolatedCopy()] () mutable {
completionHandler(source);
});
};
auto contentRuleList = openAndMapContentRuleList(filePath);
if (!contentRuleList)
return complete({ });
complete(getContentRuleListSourceFromMappedFile(*contentRuleList));
});
}
const std::error_category& contentRuleListStoreErrorCategory()
{
class ContentRuleListStoreErrorCategory : public std::error_category {
const char* name() const noexcept final
{
return "content extension store";
}
std::string message(int errorCode) const final
{
switch (static_cast<ContentRuleListStore::Error>(errorCode)) {
case ContentRuleListStore::Error::LookupFailed:
return "Unspecified error during lookup.";
case ContentRuleListStore::Error::VersionMismatch:
return "Version of file does not match version of interpreter.";
case ContentRuleListStore::Error::CompileFailed:
return "Unspecified error during compile.";
case ContentRuleListStore::Error::RemoveFailed:
return "Unspecified error during remove.";
}
return std::string();
}
};
static NeverDestroyed<ContentRuleListStoreErrorCategory> contentRuleListErrorCategory;
return contentRuleListErrorCategory;
}
} // namespace API
#endif // ENABLE(CONTENT_EXTENSIONS)