LayoutTests/imported/w3c:
[WebKit-https.git] / Source / WebCore / Modules / fetch / FetchResponse.h
1 /*
2  * Copyright (C) 2016 Canon Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted, provided that the following conditions
6  * are required to be met:
7  *
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  * 3.  Neither the name of Canon Inc. nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef FetchResponse_h
30 #define FetchResponse_h
31
32 #if ENABLE(FETCH_API)
33
34 #include "FetchBodyOwner.h"
35 #include "FetchHeaders.h"
36 #include "ResourceResponse.h"
37
38 namespace JSC {
39 class ArrayBuffer;
40 };
41
42 namespace WebCore {
43
44 class Dictionary;
45 class FetchRequest;
46 class ReadableStreamSource;
47
48 typedef int ExceptionCode;
49
50 class FetchResponse final : public FetchBodyOwner {
51 public:
52     static Ref<FetchResponse> create(ScriptExecutionContext& context) { return adoptRef(*new FetchResponse(context, Type::Default, { }, FetchHeaders::create(FetchHeaders::Guard::Response), ResourceResponse())); }
53     static Ref<FetchResponse> error(ScriptExecutionContext&);
54     static RefPtr<FetchResponse> redirect(ScriptExecutionContext&, const String&, int, ExceptionCode&);
55     // FIXME: Binding generator should not require below method to handle optional status parameter.
56     static RefPtr<FetchResponse> redirect(ScriptExecutionContext& context, const String& url, ExceptionCode& ec) { return redirect(context, url, 302, ec); }
57
58     using FetchPromise = DOMPromise<RefPtr<FetchResponse>, ExceptionCode>;
59     static void fetch(ScriptExecutionContext&, FetchRequest&, const Dictionary&, FetchPromise&&);
60     static void fetch(ScriptExecutionContext&, const String&, const Dictionary&, FetchPromise&&);
61
62     void initializeWith(const Dictionary&, ExceptionCode&);
63
64     String type() const;
65     const String& url() const { return m_response.url().string(); }
66     bool redirected() const { return m_isRedirected; }
67     int status() const { return m_response.httpStatusCode(); }
68     bool ok() const { return status() >= 200 && status() <= 299; }
69     const String& statusText() const { return m_response.httpStatusText(); }
70
71     FetchHeaders& headers() { return m_headers; }
72     RefPtr<FetchResponse> clone(ScriptExecutionContext&, ExceptionCode&);
73
74 #if ENABLE(STREAMS_API)
75     ReadableStreamSource* createReadableStreamSource();
76     void consumeBodyAsStream();
77 #endif
78
79 private:
80     enum class Type { Basic, Cors, Default, Error, Opaque, OpaqueRedirect };
81
82     FetchResponse(ScriptExecutionContext&, Type, FetchBody&&, Ref<FetchHeaders>&&, ResourceResponse&&);
83
84     static void startFetching(ScriptExecutionContext&, const FetchRequest&, FetchPromise&&);
85
86     // ActiveDOMObject API
87     void stop() final;
88     const char* activeDOMObjectName() const final;
89     bool canSuspendForDocumentSuspension() const final;
90
91     class BodyLoader final : public FetchLoaderClient {
92     public:
93         BodyLoader(FetchResponse&, FetchPromise&&);
94
95         bool start(ScriptExecutionContext&, const FetchRequest&);
96         void stop();
97
98 #if ENABLE(STREAMS_API)
99         RefPtr<SharedBuffer> startStreaming();
100 #endif
101
102     private:
103         // FetchLoaderClient API
104         void didSucceed() final;
105         void didFail() final;
106         void didReceiveResponse(const ResourceResponse&);
107         void didReceiveData(const char*, size_t) final;
108         void didFinishLoadingAsArrayBuffer(RefPtr<ArrayBuffer>&&) final;
109
110         FetchResponse& m_response;
111         Optional<FetchPromise> m_promise;
112         std::unique_ptr<FetchLoader> m_loader;
113     };
114
115     Type m_type;
116     ResourceResponse m_response;
117     Ref<FetchHeaders> m_headers;
118     bool m_isRedirected = false;
119     Optional<BodyLoader> m_bodyLoader;
120 };
121
122 } // namespace WebCore
123
124 #endif // ENABLE(FETCH_API)
125
126 #endif // FetchResponse_h