Implement Cache API partitioning based on ClientOrigin
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / CacheStorageEngineCaches.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 "CacheStorageEngineCache.h"
29 #include "NetworkCacheStorage.h"
30 #include <WebCore/ClientOrigin.h>
31 #include <wtf/CompletionHandler.h>
32
33 namespace WebKit {
34
35 namespace CacheStorage {
36
37 class Engine;
38
39 class Caches : public RefCounted<Caches> {
40 public:
41     static Ref<Caches> create(Engine& engine, WebCore::ClientOrigin&& origin, String&& rootPath, uint64_t quota) { return adoptRef(*new Caches { engine, WTFMove(origin), WTFMove(rootPath), quota }); }
42
43     static void retrieveOriginFromDirectory(const String& folderPath, WorkQueue&, WTF::CompletionHandler<void(std::optional<WebCore::ClientOrigin>&&)>&&);
44
45     void initialize(WebCore::DOMCacheEngine::CompletionCallback&&);
46     void open(const String& name, WebCore::DOMCacheEngine::CacheIdentifierCallback&&);
47     void remove(uint64_t identifier, WebCore::DOMCacheEngine::CacheIdentifierCallback&&);
48     void dispose(Cache&);
49
50     void detach();
51
52     bool isInitialized() const { return m_isInitialized; }
53     WebCore::DOMCacheEngine::CacheInfos cacheInfos(uint64_t updateCounter) const;
54
55     Cache* find(uint64_t identifier);
56     void appendRepresentation(StringBuilder&) const;
57
58     void readRecordsList(Cache&, NetworkCache::Storage::TraverseHandler&&);
59     void readRecord(const NetworkCache::Key&, WTF::Function<void(Expected<WebCore::DOMCacheEngine::Record, WebCore::DOMCacheEngine::Error>&&)>&&);
60
61     bool hasEnoughSpace(uint64_t spaceRequired) const { return m_quota >= m_size + spaceRequired; }
62     void requestSpace(uint64_t spaceRequired, WebCore::DOMCacheEngine::CompletionCallback&&);
63     void writeRecord(const Cache&, const RecordInformation&, WebCore::DOMCacheEngine::Record&&, uint64_t previousRecordSize, WebCore::DOMCacheEngine::CompletionCallback&&);
64
65     void removeCacheEntry(const NetworkCache::Key&);
66     void removeRecord(const RecordInformation&);
67
68     const NetworkCache::Salt& salt() const;
69     const WebCore::ClientOrigin& origin() const { return m_origin; }
70
71     bool shouldPersist() const { return !m_rootPath.isNull(); }
72
73     void clear(WTF::CompletionHandler<void()>&&);
74     void clearMemoryRepresentation();
75
76     uint64_t storageSize() const;
77
78 private:
79     Caches(Engine&, WebCore::ClientOrigin&&, String&& rootPath, uint64_t quota);
80
81     void initializeSize(WebCore::DOMCacheEngine::CompletionCallback&&);
82     void readCachesFromDisk(WTF::Function<void(Expected<Vector<Cache>, WebCore::DOMCacheEngine::Error>&&)>&&);
83     void writeCachesToDisk(WebCore::DOMCacheEngine::CompletionCallback&&);
84
85     void storeOrigin(WebCore::DOMCacheEngine::CompletionCallback&&);
86     static std::optional<WebCore::ClientOrigin> readOrigin(const NetworkCache::Data&);
87
88     Cache* find(const String& name);
89
90     void makeDirty() { ++m_updateCounter; }
91     bool isDirty(uint64_t updateCounter) const;
92
93     bool m_isInitialized { false };
94     Engine* m_engine { nullptr };
95     uint64_t m_updateCounter { 0 };
96     WebCore::ClientOrigin m_origin;
97     String m_rootPath;
98     uint64_t m_quota { 0 };
99     uint64_t m_size { 0 };
100     Vector<Cache> m_caches;
101     Vector<Cache> m_removedCaches;
102     RefPtr<NetworkCache::Storage> m_storage;
103     HashMap<NetworkCache::Key, WebCore::DOMCacheEngine::Record> m_volatileStorage;
104     mutable std::optional<NetworkCache::Salt> m_volatileSalt;
105     Vector<WebCore::DOMCacheEngine::CompletionCallback> m_pendingInitializationCallbacks;
106 };
107
108 } // namespace CacheStorage
109
110 } // namespace WebKit