[CacheAPI] Introduce a WebKit::CacheStorage namespace
[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 "CacheStorageEngineCache.h"
29 #include <wtf/HashMap.h>
30
31 namespace IPC {
32 class Connection;
33 }
34
35 namespace WebCore {
36 class SessionID;
37 }
38
39 namespace WebKit {
40
41 namespace CacheStorage {
42
43 class Engine {
44 public:
45     static Engine& from(PAL::SessionID);
46     static void destroyEngine(PAL::SessionID);
47
48     void open(const String& origin, const String& cacheName, CacheIdentifierCallback&&);
49     void remove(uint64_t cacheIdentifier, CacheIdentifierCallback&&);
50     void retrieveCaches(const String& origin, CacheInfosCallback&&);
51
52     void retrieveRecords(uint64_t cacheIdentifier, RecordsCallback&&);
53     void putRecords(uint64_t cacheIdentifier, Vector<Record>&&, RecordIdentifiersCallback&&);
54     void deleteMatchingRecords(uint64_t cacheIdentifier, WebCore::ResourceRequest&&, WebCore::CacheQueryOptions&&, RecordIdentifiersCallback&&);
55
56 private:
57     static Engine& defaultEngine();
58
59     void writeCachesToDisk(CompletionCallback&&);
60
61     using CachesOrError = Expected<std::reference_wrapper<Vector<Cache>>, Error>;
62     using CachesCallback = Function<void(CachesOrError&&)>;
63     void readCachesFromDisk(const String& origin, Function<void(CachesOrError&&)>&&);
64
65     using CacheOrError = Expected<std::reference_wrapper<Cache>, Error>;
66     using CacheCallback = Function<void(CacheOrError&&)>;
67
68     void readCache(uint64_t cacheIdentifier, CacheCallback&&);
69     void writeCacheRecords(uint64_t cacheIdentifier, Vector<uint64_t>&&, RecordIdentifiersCallback&&);
70     void removeCacheRecords(uint64_t cacheIdentifier, Vector<uint64_t>&&, RecordIdentifiersCallback&&);
71
72     Vector<uint64_t> queryCache(const Vector<Record>&, const WebCore::ResourceRequest&, const WebCore::CacheQueryOptions&);
73
74     Cache* cache(uint64_t cacheIdentifier);
75
76     HashMap<String, Vector<Cache>> m_caches;
77     Vector<Cache> m_removedCaches;
78     uint64_t m_nextCacheIdentifier { 0 };
79 };
80
81 } // namespace CacheStorage
82
83 } // namespace WebKit