Implement Cache API partitioning based on ClientOrigin
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / CacheStorageEngine.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 "CacheStorageEngineCaches.h"
29 #include "NetworkCacheData.h"
30 #include "WebsiteData.h"
31 #include <WebCore/ClientOrigin.h>
32 #include <wtf/HashMap.h>
33 #include <wtf/ThreadSafeRefCounted.h>
34 #include <wtf/WorkQueue.h>
35
36 namespace IPC {
37 class Connection;
38 }
39
40 namespace WebCore {
41 class SessionID;
42 }
43
44 namespace WTF {
45 class CallbackAggregator;
46 };
47
48 namespace WebKit {
49
50 namespace CacheStorage {
51
52 using CacheIdentifier = uint64_t;
53 using LockCount = uint64_t;
54
55 class Engine : public ThreadSafeRefCounted<Engine> {
56 public:
57     ~Engine();
58
59     static Engine& from(PAL::SessionID);
60     static void destroyEngine(PAL::SessionID);
61     static void fetchEntries(PAL::SessionID, bool shouldComputeSize, WTF::CompletionHandler<void(Vector<WebsiteData::Entry>)>&&);
62
63     static Ref<Engine> create(String&& rootPath) { return adoptRef(*new Engine(WTFMove(rootPath))); }
64
65     bool shouldPersist() const { return !!m_ioQueue;}
66
67     void open(const WebCore::ClientOrigin&, const String& cacheName, WebCore::DOMCacheEngine::CacheIdentifierCallback&&);
68     void remove(uint64_t cacheIdentifier, WebCore::DOMCacheEngine::CacheIdentifierCallback&&);
69     void retrieveCaches(const WebCore::ClientOrigin&, uint64_t updateCounter, WebCore::DOMCacheEngine::CacheInfosCallback&&);
70
71     void retrieveRecords(uint64_t cacheIdentifier, WebCore::URL&&, WebCore::DOMCacheEngine::RecordsCallback&&);
72     void putRecords(uint64_t cacheIdentifier, Vector<WebCore::DOMCacheEngine::Record>&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&);
73     void deleteMatchingRecords(uint64_t cacheIdentifier, WebCore::ResourceRequest&&, WebCore::CacheQueryOptions&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&);
74
75     void lock(uint64_t cacheIdentifier);
76     void unlock(uint64_t cacheIdentifier);
77
78     void writeFile(const String& filename, NetworkCache::Data&&, WebCore::DOMCacheEngine::CompletionCallback&&);
79     void readFile(const String& filename, WTF::Function<void(const NetworkCache::Data&, int error)>&&);
80     void removeFile(const String& filename);
81
82     const String& rootPath() const { return m_rootPath; }
83     const NetworkCache::Salt& salt() const { return m_salt.value(); }
84     uint64_t nextCacheIdentifier() { return ++m_nextCacheIdentifier; }
85
86     void clearMemoryRepresentation(const WebCore::ClientOrigin&, WebCore::DOMCacheEngine::CompletionCallback&&);
87     String representation();
88
89     void clearAllCaches(WTF::CallbackAggregator&);
90     void clearCachesForOrigin(const WebCore::SecurityOriginData&, WTF::CallbackAggregator&);
91
92 private:
93     static Engine& defaultEngine();
94     explicit Engine(String&& rootPath);
95
96     String cachesRootPath(const WebCore::ClientOrigin&);
97
98     void fetchEntries(bool /* shouldComputeSize */, WTF::CompletionHandler<void(Vector<WebsiteData::Entry>)>&&);
99
100     void initialize(WTF::Function<void(std::optional<WebCore::DOMCacheEngine::Error>&&)>&&);
101
102     using CachesOrError = Expected<std::reference_wrapper<Caches>, WebCore::DOMCacheEngine::Error>;
103     using CachesCallback = WTF::Function<void(CachesOrError&&)>;
104     void readCachesFromDisk(const WebCore::ClientOrigin&, CachesCallback&&);
105
106     using CacheOrError = Expected<std::reference_wrapper<Cache>, WebCore::DOMCacheEngine::Error>;
107     using CacheCallback = WTF::Function<void(CacheOrError&&)>;
108     void readCache(uint64_t cacheIdentifier, CacheCallback&&);
109
110     Cache* cache(uint64_t cacheIdentifier);
111
112     HashMap<WebCore::ClientOrigin, RefPtr<Caches>> m_caches;
113     uint64_t m_nextCacheIdentifier { 0 };
114     String m_rootPath;
115     RefPtr<WorkQueue> m_ioQueue;
116     std::optional<NetworkCache::Salt> m_salt;
117     HashMap<CacheIdentifier, LockCount> m_cacheLocks;
118 };
119
120 } // namespace CacheStorage
121
122 } // namespace WebKit