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