7b50d4439c41d07947e9e058726cd804de06e9c1
[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         Internal
49     };
50
51     static ExceptionOr<void> errorToException(Error);
52     template<typename T> static ExceptionOr<T> exceptionOrResult(T&& value, Error error)
53     {
54         auto result = errorToException(error);
55         if (result.hasException())
56             return result.releaseException();
57         return std::forward<T>(value);
58     }
59
60     WEBCORE_EXPORT static bool queryCacheMatch(const ResourceRequest& request, const ResourceRequest& cachedRequest, const ResourceResponse&, const CacheQueryOptions&);
61
62     struct Record {
63         uint64_t identifier;
64
65         FetchHeaders::Guard requestHeadersGuard;
66         ResourceRequest request;
67         FetchOptions options;
68         String referrer;
69
70         FetchHeaders::Guard responseHeadersGuard;
71         ResourceResponse response;
72     };
73
74     struct CacheInfo {
75         uint64_t identifier;
76         String name;
77     };
78
79     using OpenRemoveCallback = WTF::Function<void(uint64_t, Error)>;
80     using CachesCallback = WTF::Function<void(Vector<CacheInfo>&&)>;
81     using RecordsCallback = WTF::Function<void(Vector<Record>&&)>;
82     using BatchOperationCallback = WTF::Function<void(Vector<uint64_t>&&, Error)>;
83
84     void open(const String& /* origin */, const String& /* cacheName */, OpenRemoveCallback&&);
85     void remove(uint64_t /* cacheIdentifier */, OpenRemoveCallback&&);
86     void retrieveCaches(const String& /* origin */, CachesCallback&&);
87
88     void retrieveRecords(uint64_t /* cacheIdentifier */, RecordsCallback&&);
89     void batchDeleteOperation(uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&, BatchOperationCallback&&);
90     void batchPutOperation(uint64_t /* cacheIdentifier */, Vector<Record>&&, BatchOperationCallback&&);
91
92 protected:
93     CacheStorageConnection() =  default;
94
95     void openCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
96     void removeCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
97     WEBCORE_EXPORT void updateCaches(uint64_t requestIdentifier, Vector<CacheInfo>&&);
98
99     WEBCORE_EXPORT void updateRecords(uint64_t requestIdentifier, Vector<Record>&&);
100     WEBCORE_EXPORT void deleteRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
101     WEBCORE_EXPORT void putRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
102
103 private:
104     virtual void doOpen(uint64_t requestIdentifier, const String& /* origin */, const String& /* cacheName */) { openCompleted(requestIdentifier, 0, Error::NotImplemented); }
105     virtual void doRemove(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { removeCompleted(requestIdentifier, 0, Error::NotImplemented); }
106     virtual void doRetrieveCaches(uint64_t requestIdentifier, const String& /* origin */) { updateCaches(requestIdentifier, { }); }
107
108     virtual void doRetrieveRecords(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { updateRecords(requestIdentifier, { }); }
109     virtual void doBatchDeleteOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&) { deleteRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
110     virtual void doBatchPutOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, Vector<Record>&&) { putRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
111
112     WEBCORE_EXPORT void openOrRemoveCompleted(uint64_t requestIdentifier, uint64_t cacheIdentifier, Error);
113
114     HashMap<uint64_t, OpenRemoveCallback> m_openAndRemoveCachePendingRequests;
115     HashMap<uint64_t, CachesCallback> m_retrieveCachesPendingRequests;
116     HashMap<uint64_t, RecordsCallback> m_retrieveRecordsPendingRequests;
117     HashMap<uint64_t, BatchOperationCallback> m_batchDeleteAndPutPendingRequests;
118
119     uint64_t m_lastRequestIdentifier { 0 };
120 };
121
122 } // namespace WebCore
123