cf2061d28f9e82d17c256d8d72b5f2361529b7ff
[WebKit-https.git] / Source / WebCore / Modules / cache / DOMCache.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 "ActiveDOMObject.h"
29 #include "CacheStorageConnection.h"
30 #include "CacheStorageRecord.h"
31 #include <wtf/UniqueRef.h>
32
33 namespace WebCore {
34
35 class ScriptExecutionContext;
36 class SuspendableTaskQueue;
37
38 class DOMCache final : public RefCounted<DOMCache>, public ActiveDOMObject {
39 public:
40     static Ref<DOMCache> create(ScriptExecutionContext& context, String&& name, uint64_t identifier, Ref<CacheStorageConnection>&& connection) { return adoptRef(*new DOMCache(context, WTFMove(name), identifier, WTFMove(connection))); }
41     ~DOMCache();
42
43     using RequestInfo = FetchRequest::Info;
44
45     using KeysPromise = DOMPromiseDeferred<IDLSequence<IDLInterface<FetchRequest>>>;
46
47     void match(RequestInfo&&, CacheQueryOptions&&, Ref<DeferredPromise>&&);
48
49     using MatchAllPromise = DOMPromiseDeferred<IDLSequence<IDLInterface<FetchResponse>>>;
50     void matchAll(Optional<RequestInfo>&&, CacheQueryOptions&&, MatchAllPromise&&);
51     void add(RequestInfo&&, DOMPromiseDeferred<void>&&);
52
53     void addAll(Vector<RequestInfo>&&, DOMPromiseDeferred<void>&&);
54     void put(RequestInfo&&, Ref<FetchResponse>&&, DOMPromiseDeferred<void>&&);
55     void remove(RequestInfo&&, CacheQueryOptions&&, DOMPromiseDeferred<IDLBoolean>&&);
56     void keys(Optional<RequestInfo>&&, CacheQueryOptions&&, KeysPromise&&);
57
58     const String& name() const { return m_name; }
59     uint64_t identifier() const { return m_identifier; }
60
61     using MatchCallback = Function<void(ExceptionOr<RefPtr<FetchResponse>>)>;
62     void doMatch(RequestInfo&&, CacheQueryOptions&&, MatchCallback&&);
63
64     CacheStorageConnection& connection() { return m_connection.get(); }
65
66 private:
67     DOMCache(ScriptExecutionContext&, String&& name, uint64_t identifier, Ref<CacheStorageConnection>&&);
68
69     ExceptionOr<Ref<FetchRequest>> requestFromInfo(RequestInfo&&, bool ignoreMethod);
70
71     // ActiveDOMObject
72     void stop() final;
73     const char* activeDOMObjectName() const final;
74     bool canSuspendForDocumentSuspension() const final;
75
76     void putWithResponseData(DOMPromiseDeferred<void>&&, Ref<FetchRequest>&&, Ref<FetchResponse>&&, ExceptionOr<RefPtr<SharedBuffer>>&&);
77
78     void retrieveRecords(const URL&, WTF::Function<void(Optional<Exception>&&)>&&);
79     Vector<CacheStorageRecord> queryCacheWithTargetStorage(const FetchRequest&, const CacheQueryOptions&, const Vector<CacheStorageRecord>&);
80     void queryCache(Ref<FetchRequest>&&, CacheQueryOptions&&, WTF::Function<void(ExceptionOr<Vector<CacheStorageRecord>>&&)>&&);
81     void batchDeleteOperation(const FetchRequest&, CacheQueryOptions&&, WTF::Function<void(ExceptionOr<bool>&&)>&&);
82     void batchPutOperation(const FetchRequest&, FetchResponse&, DOMCacheEngine::ResponseBody&&, WTF::Function<void(ExceptionOr<void>&&)>&&);
83     void batchPutOperation(Vector<DOMCacheEngine::Record>&&, WTF::Function<void(ExceptionOr<void>&&)>&&);
84
85     void updateRecords(Vector<DOMCacheEngine::Record>&&);
86     Vector<Ref<FetchResponse>> cloneResponses(const Vector<CacheStorageRecord>&);
87     DOMCacheEngine::Record toConnectionRecord(const FetchRequest&, FetchResponse&, DOMCacheEngine::ResponseBody&&);
88
89     String m_name;
90     uint64_t m_identifier;
91     Ref<CacheStorageConnection> m_connection;
92
93     Vector<CacheStorageRecord> m_records;
94     bool m_isStopped { false };
95     UniqueRef<SuspendableTaskQueue> m_taskQueue;
96 };
97
98 } // namespace WebCore