Do not Reject CacheStorage promises when updating the persistent filesystem data...
[WebKit-https.git] / Source / WebKit / NetworkProcess / cache / CacheStorageEngine.cpp
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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "CacheStorageEngine.h"
28
29 #include "NetworkCacheIOChannel.h"
30 #include "NetworkProcess.h"
31 #include <WebCore/CacheQueryOptions.h>
32 #include <pal/SessionID.h>
33 #include <wtf/MainThread.h>
34 #include <wtf/NeverDestroyed.h>
35 #include <wtf/text/StringHash.h>
36
37 using namespace WebCore::DOMCacheEngine;
38 using namespace WebKit::NetworkCache;
39
40 namespace WebKit {
41
42 namespace CacheStorage {
43
44 static HashMap<PAL::SessionID, RefPtr<Engine>>& globalEngineMap()
45 {
46     static NeverDestroyed<HashMap<PAL::SessionID, RefPtr<Engine>>> map;
47
48     return map;
49 }
50
51 Engine::~Engine()
52 {
53     for (auto& caches : m_caches.values())
54         caches->detach();
55 }
56
57 Engine& Engine::from(PAL::SessionID sessionID)
58 {
59     auto addResult = globalEngineMap().add(sessionID, nullptr);
60     if (addResult.isNewEntry)
61         addResult.iterator->value = Engine::create(NetworkProcess::singleton().cacheStorageDirectory(sessionID));
62     return *addResult.iterator->value;
63 }
64
65 void Engine::destroyEngine(PAL::SessionID sessionID)
66 {
67     ASSERT(sessionID != PAL::SessionID::defaultSessionID());
68     globalEngineMap().remove(sessionID);
69 }
70
71 Engine& Engine::defaultEngine()
72 {
73     auto sessionID = PAL::SessionID::defaultSessionID();
74     static NeverDestroyed<Ref<Engine>> defaultEngine = { Engine::create(NetworkProcess::singleton().cacheStorageDirectory(sessionID)) };
75     return defaultEngine.get();
76 }
77
78 Engine::Engine(String&& rootPath)
79     : m_rootPath(WTFMove(rootPath))
80 {
81     if (!m_rootPath.isNull())
82         m_ioQueue = WorkQueue::create("com.apple.WebKit.CacheStorageEngine.serialBackground", WorkQueue::Type::Serial, WorkQueue::QOS::Background);
83 }
84
85 void Engine::open(const String& origin, const String& cacheName, CacheIdentifierCallback&& callback)
86 {
87     readCachesFromDisk(origin, [this, cacheName, callback = WTFMove(callback)](CachesOrError&& cachesOrError) mutable {
88         if (!cachesOrError.hasValue()) {
89             callback(makeUnexpected(cachesOrError.error()));
90             return;
91         }
92
93         cachesOrError.value().get().open(cacheName, WTFMove(callback));
94     });
95 }
96
97 void Engine::remove(uint64_t cacheIdentifier, CacheIdentifierCallback&& callback)
98 {
99     Caches* cachesToModify = nullptr;
100     for (auto& caches : m_caches.values()) {
101         auto* cacheToRemove = caches->find(cacheIdentifier);
102         if (cacheToRemove) {
103             cachesToModify = caches.ptr();
104             break;
105         }
106     }
107     if (!cachesToModify) {
108         callback(makeUnexpected(Error::Internal));
109         return;
110     }
111
112     cachesToModify->remove(cacheIdentifier, WTFMove(callback));
113 }
114
115 void Engine::retrieveCaches(const String& origin, uint64_t updateCounter, CacheInfosCallback&& callback)
116 {
117     readCachesFromDisk(origin, [updateCounter, callback = WTFMove(callback)](CachesOrError&& cachesOrError) mutable {
118         if (!cachesOrError.hasValue()) {
119             callback(makeUnexpected(cachesOrError.error()));
120             return;
121         }
122
123         callback(cachesOrError.value().get().cacheInfos(updateCounter));
124     });
125 }
126
127 void Engine::retrieveRecords(uint64_t cacheIdentifier, RecordsCallback&& callback)
128 {
129     readCache(cacheIdentifier, [callback = WTFMove(callback)](CacheOrError&& result) mutable {
130         if (!result.hasValue()) {
131             callback(makeUnexpected(result.error()));
132             return;
133         }
134
135         callback(result.value().get().records());
136     });
137 }
138
139 void Engine::putRecords(uint64_t cacheIdentifier, Vector<Record>&& records, RecordIdentifiersCallback&& callback)
140 {
141     readCache(cacheIdentifier, [this, records = WTFMove(records), callback = WTFMove(callback)](CacheOrError&& result) mutable {
142         if (!result.hasValue()) {
143             callback(makeUnexpected(result.error()));
144             return;
145         }
146
147         result.value().get().put(WTFMove(records), WTFMove(callback));
148     });
149 }
150
151 void Engine::deleteMatchingRecords(uint64_t cacheIdentifier, WebCore::ResourceRequest&& request, WebCore::CacheQueryOptions&& options, RecordIdentifiersCallback&& callback)
152 {
153     readCache(cacheIdentifier, [this, request = WTFMove(request), options = WTFMove(options), callback = WTFMove(callback)](CacheOrError&& result) mutable {
154         if (!result.hasValue()) {
155             callback(makeUnexpected(result.error()));
156             return;
157         }
158
159         result.value().get().remove(WTFMove(request), WTFMove(options), WTFMove(callback));
160     });
161 }
162
163 void Engine::initialize(Function<void(std::optional<Error>&&)>&& callback)
164 {
165     if (m_salt) {
166         callback(std::nullopt);
167         return;
168     }
169
170     if (!shouldPersist()) {
171         callback(std::nullopt);
172         return;
173     }
174
175     String saltPath = WebCore::pathByAppendingComponent(m_rootPath, ASCIILiteral("salt"));
176     m_ioQueue->dispatch([protectedThis = makeRef(*this), this, callback = WTFMove(callback), saltPath = WTFMove(saltPath)] () mutable {
177         WebCore::makeAllDirectories(m_rootPath);
178         RunLoop::main().dispatch([protectedThis = WTFMove(protectedThis), this, salt = readOrMakeSalt(saltPath), callback = WTFMove(callback)]() mutable {
179             if (!salt) {
180                 callback(Error::WriteDisk);
181                 return;
182             }
183             m_salt = WTFMove(salt);
184             callback(std::nullopt);
185         });
186     });
187 }
188
189 void Engine::readCachesFromDisk(const String& origin, CachesCallback&& callback)
190 {
191     auto& caches = m_caches.ensure(origin, [&origin, this] {
192         return Caches::create(*this, origin);
193     }).iterator->value;
194
195     if (caches->isInitialized()) {
196         callback(std::reference_wrapper<Caches> { caches.get() });
197         return;
198     }
199
200     initialize([this, origin, callback = WTFMove(callback)](std::optional<Error>&& error) mutable {
201         if (error) {
202             callback(makeUnexpected(error.value()));
203             return;
204         }
205
206         auto caches = m_caches.get(origin);
207         ASSERT(caches);
208
209         caches->initialize([callback = WTFMove(callback), caches](std::optional<Error>&& error) mutable {
210             if (error) {
211                 callback(makeUnexpected(error.value()));
212                 return;
213             }
214
215             callback(std::reference_wrapper<Caches> { *caches });
216         });
217     });
218 }
219
220 void Engine::readCache(uint64_t cacheIdentifier, CacheCallback&& callback)
221 {
222     // FIXME: Implement reading.
223     auto* cache = this->cache(cacheIdentifier);
224     if (!cache) {
225         callback(makeUnexpected(Error::Internal));
226         return;
227     }
228     callback(std::reference_wrapper<Cache> { *cache });
229 }
230
231 Cache* Engine::cache(uint64_t cacheIdentifier)
232 {
233     Cache* result = nullptr;
234     for (auto& caches : m_caches.values()) {
235         if ((result = caches->find(cacheIdentifier)))
236             break;
237     }
238     return result;
239 }
240
241 void Engine::writeFile(const String& filename, NetworkCache::Data&& data, WebCore::DOMCacheEngine::CompletionCallback&& callback)
242 {
243     if (!shouldPersist()) {
244         callback(std::nullopt);
245         return;
246     }
247
248     m_ioQueue->dispatch([callback = WTFMove(callback), data = WTFMove(data), filename = filename.isolatedCopy()] () mutable {
249         auto channel = IOChannel::open(filename, IOChannel::Type::Create);
250         channel->write(0, data, nullptr, [callback = WTFMove(callback)](int error) mutable {
251             ASSERT(RunLoop::isMain());
252             if (error) {
253                 callback(Error::WriteDisk);
254                 return;
255             }
256             callback(std::nullopt);
257         });
258     });
259 }
260
261 void Engine::readFile(const String& filename, WTF::Function<void(const NetworkCache::Data&, int error)>&& callback)
262 {
263     if (!shouldPersist()) {
264         callback(Data { }, 0);
265         return;
266     }
267
268     m_ioQueue->dispatch([callback = WTFMove(callback), filename = filename.isolatedCopy()]() mutable {
269         auto channel = IOChannel::open(filename, IOChannel::Type::Read);
270         if (channel->fileDescriptor() < 0) {
271             RunLoop::main().dispatch([callback = WTFMove(callback)]() mutable {
272                 callback(Data { }, 0);
273             });
274             return;
275         }
276
277         channel->read(0, std::numeric_limits<size_t>::max(), nullptr, [callback = WTFMove(callback)](const Data& data, int error) mutable {
278             // FIXME: We should do the decoding in the background thread.
279             ASSERT(RunLoop::isMain());
280             callback(data, error);
281         });
282     });
283 }
284
285 void Engine::removeFile(const String& filename)
286 {
287     if (!shouldPersist())
288         return;
289
290     m_ioQueue->dispatch([filename = filename.isolatedCopy()]() mutable {
291         WebCore::deleteFile(filename);
292     });
293 }
294
295 void Engine::clearMemoryRepresentation(const String& origin)
296 {
297     readCachesFromDisk(origin, [](CachesOrError&& result) {
298         if (!result.hasValue())
299             return;
300         result.value().get().clearMemoryRepresentation();
301     });
302 }
303
304 } // namespace CacheStorage
305
306 } // namespace WebKit