[Cache API] Add response body storage
[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 "SharedBuffer.h"
34 #include <wtf/HashMap.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36
37 namespace WebCore {
38
39 struct CacheQueryOptions;
40
41 class CacheStorageConnection : public ThreadSafeRefCounted<CacheStorageConnection> {
42 public:
43     static Ref<CacheStorageConnection> create() { return adoptRef(*new CacheStorageConnection()); }
44     virtual ~CacheStorageConnection() = default;
45
46     enum class Error {
47         None,
48         NotImplemented,
49         Internal
50     };
51
52     static ExceptionOr<void> errorToException(Error);
53     template<typename T> static ExceptionOr<T> exceptionOrResult(T&& value, Error error)
54     {
55         auto result = errorToException(error);
56         if (result.hasException())
57             return result.releaseException();
58         return std::forward<T>(value);
59     }
60
61     WEBCORE_EXPORT static bool queryCacheMatch(const ResourceRequest& request, const ResourceRequest& cachedRequest, const ResourceResponse&, const CacheQueryOptions&);
62
63     using ResponseBody = Variant<std::nullptr_t, Ref<FormData>, Ref<SharedBuffer>>;
64     static ResponseBody isolatedResponseBody(const ResponseBody&);
65
66     struct Record {
67         WEBCORE_EXPORT Record copy() const;
68
69         uint64_t identifier;
70
71         FetchHeaders::Guard requestHeadersGuard;
72         ResourceRequest request;
73         FetchOptions options;
74         String referrer;
75
76         FetchHeaders::Guard responseHeadersGuard;
77         ResourceResponse response;
78         ResponseBody responseBody;
79     };
80
81     struct CacheInfo {
82         uint64_t identifier;
83         String name;
84     };
85
86     using OpenRemoveCallback = WTF::Function<void(uint64_t, Error)>;
87     using CachesCallback = WTF::Function<void(Vector<CacheInfo>&&)>;
88     using RecordsCallback = WTF::Function<void(Vector<Record>&&)>;
89     using BatchOperationCallback = WTF::Function<void(Vector<uint64_t>&&, Error)>;
90
91     void open(const String& /* origin */, const String& /* cacheName */, OpenRemoveCallback&&);
92     void remove(uint64_t /* cacheIdentifier */, OpenRemoveCallback&&);
93     void retrieveCaches(const String& /* origin */, CachesCallback&&);
94
95     void retrieveRecords(uint64_t /* cacheIdentifier */, RecordsCallback&&);
96     void batchDeleteOperation(uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&, BatchOperationCallback&&);
97     void batchPutOperation(uint64_t /* cacheIdentifier */, Vector<Record>&&, BatchOperationCallback&&);
98
99 protected:
100     CacheStorageConnection() =  default;
101
102     void openCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
103     void removeCompleted(uint64_t identifier, uint64_t cacheIdentifier, Error error) { openOrRemoveCompleted(identifier, cacheIdentifier, error); }
104     WEBCORE_EXPORT void updateCaches(uint64_t requestIdentifier, Vector<CacheInfo>&&);
105
106     WEBCORE_EXPORT void updateRecords(uint64_t requestIdentifier, Vector<Record>&&);
107     WEBCORE_EXPORT void deleteRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
108     WEBCORE_EXPORT void putRecordsCompleted(uint64_t requestIdentifier, Vector<uint64_t>&&, Error);
109
110 private:
111     virtual void doOpen(uint64_t requestIdentifier, const String& /* origin */, const String& /* cacheName */) { openCompleted(requestIdentifier, 0, Error::NotImplemented); }
112     virtual void doRemove(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { removeCompleted(requestIdentifier, 0, Error::NotImplemented); }
113     virtual void doRetrieveCaches(uint64_t requestIdentifier, const String& /* origin */) { updateCaches(requestIdentifier, { }); }
114
115     virtual void doRetrieveRecords(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */) { updateRecords(requestIdentifier, { }); }
116     virtual void doBatchDeleteOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, const ResourceRequest&, CacheQueryOptions&&) { deleteRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
117     virtual void doBatchPutOperation(uint64_t requestIdentifier, uint64_t /* cacheIdentifier */, Vector<Record>&&) { putRecordsCompleted(requestIdentifier, { }, Error::NotImplemented); }
118
119     WEBCORE_EXPORT void openOrRemoveCompleted(uint64_t requestIdentifier, uint64_t cacheIdentifier, Error);
120
121     HashMap<uint64_t, OpenRemoveCallback> m_openAndRemoveCachePendingRequests;
122     HashMap<uint64_t, CachesCallback> m_retrieveCachesPendingRequests;
123     HashMap<uint64_t, RecordsCallback> m_retrieveRecordsPendingRequests;
124     HashMap<uint64_t, BatchOperationCallback> m_batchDeleteAndPutPendingRequests;
125
126     uint64_t m_lastRequestIdentifier { 0 };
127 };
128
129 } // namespace WebCore
130