2bf69e5ac5d22ba2d0a49ba88d540d37f37ea29a
[WebKit-https.git] / Source / WebCore / Modules / cache / CacheStorageConnection.h
1
2 /*
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "FetchHeaders.h"
30 #include "FetchOptions.h"
31 #include "ResourceRequest.h"
32 #include "ResourceResponse.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 namespace WebCore {
37
38 struct CacheQueryOptions;
39
40 class CacheStorageConnection : public ThreadSafeRefCounted<CacheStorageConnection> {
41 public:
42     static Ref<CacheStorageConnection> create() { return adoptRef(*new CacheStorageConnection()); }
43     virtual ~CacheStorageConnection() = default;
44
45     enum class Error {
46         None,
47         NotImplemented,
48     };
49
50     WEBCORE_EXPORT static bool queryCacheMatch(const ResourceRequest& request, const ResourceRequest& cachedRequest, const ResourceResponse&, const CacheQueryOptions&);
51
52     static Exception exceptionFromError(Error);
53
54     struct Record {
55         uint64_t identifier;
56
57         FetchHeaders::Guard requestHeadersGuard;
58         ResourceRequest request;
59         FetchOptions options;
60         String referrer;
61
62         FetchHeaders::Guard responseHeadersGuard;
63         ResourceResponse response;
64     };
65
66     struct CacheInfo {
67         uint64_t identifier;
68         String name;
69     };
70
71     using OpenRemoveCallback = WTF::Function<void(uint64_t, Error)>;
72     using CachesCallback = WTF::Function<void(Vector<CacheInfo>&&)>;
73     using RecordsCallback = WTF::Function<void(Vector<Record>&&)>;
74     using BatchOperationCallback = WTF::Function<void(Vector<uint64_t>&&, Error)>;
75
76     void open(const String& /* origin */, const String& /* cacheName */, OpenRemoveCallback&&);
77     void remove(uint64_t /* cacheIdentifier */, OpenRemoveCallback&&);
78     void retrieveCaches(const String& /* origin */, CachesCallback&&);
79
80     void retrieveRecords(uint64_t /* cacheIdentifier */, RecordsCallback&&);
81     void batchDeleteOperation(uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&, BatchOperationCallback&&);
82     void batchPutOperation(uint64_t /* cacheIdentifier */, Vector<Record>&&, BatchOperationCallback&&);
83
84 protected:
85     CacheStorageConnection() =  default;
86
87     void openCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
88     void removeCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
89     WEBCORE_EXPORT void updateCaches(uint64_t requestIdentifier, Vector<CacheInfo>&&);
90
91     WEBCORE_EXPORT void updateRecords(uint64_t requestIdentifier, Vector<Record>&&);
92     WEBCORE_EXPORT void deleteRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
93     WEBCORE_EXPORT void putRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
94
95 private:
96     virtual void doOpen(uint64_t requestIdentifier, const String& /* origin */, const String& /* cacheName */) { openCompleted(requestIdentifier, 0, Error::NotImplemented); }
97     virtual void doRemove(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { removeCompleted(requestIdentifier, 0, Error::NotImplemented); }
98     virtual void doRetrieveCaches(uint64_t requestIdentifier, const String& /* origin */) { updateCaches(requestIdentifier, { }); }
99
100     virtual void doRetrieveRecords(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { updateRecords(requestIdentifier, { }); }
101     virtual void doBatchDeleteOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&) { deleteRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
102     virtual void doBatchPutOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, Vector<Record>&&) { putRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
103
104     WEBCORE_EXPORT void openOrRemoveCompleted(uint64_t requestIdentifier, uint64_t cacheIdentifier, Error);
105
106     HashMap<uint64_t, OpenRemoveCallback> m_openAndRemoveCachePendingRequests;
107     HashMap<uint64_t, CachesCallback> m_retrieveCachesPendingRequests;
108     HashMap<uint64_t, RecordsCallback> m_retrieveRecordsPendingRequests;
109     HashMap<uint64_t, BatchOperationCallback> m_batchDeleteAndPutPendingRequests;
110
111     uint64_t m_lastRequestIdentifier { 0 };
112 };
113
114 } // namespace WebCore
115