Add Cache API support of records persistency
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / CacheStorageEngineCache.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "NetworkCacheStorage.h"
29 #include <WebCore/DOMCacheEngine.h>
30 #include <wtf/Vector.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WebKit {
34
35 namespace CacheStorage {
36
37 class Caches;
38
39 struct RecordInformation {
40     NetworkCache::Key key;
41     double insertionTime { 0 };
42
43     uint64_t identifier { 0 };
44     uint64_t updateResponseCounter { 0 };
45
46     WebCore::URL url;
47     bool hasVaryStar { false };
48     HashMap<String, String> varyHeaders;
49 };
50
51 class AsynchronousPutTaskCounter;
52 class ReadRecordTaskCounter;
53
54 class Cache {
55 public:
56     enum class State { Uninitialized, Opening, Open };
57     Cache(Caches&, uint64_t identifier, State, String&& name, String&& uniqueName);
58
59     bool isOpened() const { return m_state == State::Open; }
60     void open(WebCore::DOMCacheEngine::CompletionCallback&&);
61
62     uint64_t identifier() const { return m_identifier; }
63     const String& name() const { return m_name; }
64     const String& uniqueName() const { return m_uniqueName; }
65     bool isActive() const { return m_state != State::Uninitialized; }
66
67     void retrieveRecords(const WebCore::URL&, WebCore::DOMCacheEngine::RecordsCallback&&);
68     WebCore::DOMCacheEngine::CacheInfo info() const { return { m_identifier, m_name }; }
69
70     void put(Vector<WebCore::DOMCacheEngine::Record>&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&);
71     void remove(WebCore::ResourceRequest&&, WebCore::CacheQueryOptions&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&);
72
73     Vector<NetworkCache::Key> keys() const;
74
75     void dispose();
76     void clearMemoryRepresentation();
77
78     static std::optional<WebCore::DOMCacheEngine::Record> decode(const NetworkCache::Storage::Record&);
79     static NetworkCache::Storage::Record encode(const RecordInformation&, const WebCore::DOMCacheEngine::Record&);
80
81 private:
82     Vector<RecordInformation>* recordsFromURL(const WebCore::URL&);
83     const Vector<RecordInformation>* recordsFromURL(const WebCore::URL&) const;
84     RecordInformation& addRecord(Vector<RecordInformation>*, const WebCore::DOMCacheEngine::Record&);
85
86     RecordInformation toRecordInformation(const WebCore::DOMCacheEngine::Record&);
87
88     void finishOpening(WebCore::DOMCacheEngine::CompletionCallback&&, std::optional<WebCore::DOMCacheEngine::Error>&&);
89     void retrieveRecord(const RecordInformation&, Ref<ReadRecordTaskCounter>&&);
90
91     void readRecordsList(WebCore::DOMCacheEngine::CompletionCallback&&);
92     void writeRecordToDisk(const RecordInformation&, WebCore::DOMCacheEngine::Record&&, Ref<AsynchronousPutTaskCounter>&&);
93     void updateRecordToDisk(RecordInformation&, WebCore::DOMCacheEngine::Record&&, Ref<AsynchronousPutTaskCounter>&&);
94     void removeRecordFromDisk(const RecordInformation&);
95     void readRecordFromDisk(const RecordInformation&, WTF::Function<void(Expected<WebCore::DOMCacheEngine::Record, WebCore::DOMCacheEngine::Error>&&)>&&);
96     void removeFromRecordList(const Vector<uint64_t>&);
97
98     Caches& m_caches;
99     State m_state;
100     uint64_t m_identifier { 0 };
101     String m_name;
102     String m_uniqueName;
103     HashMap<String, Vector<RecordInformation>> m_records;
104     uint64_t m_nextRecordIdentifier { 0 };
105     Vector<WebCore::DOMCacheEngine::CompletionCallback> m_pendingOpeningCallbacks;
106 };
107
108 } // namespace CacheStorage
109
110 } // namespace WebKit