Next batch of conversions to use C++ enum class instead of strings for enumerations
[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 #pragma once
30
31 #if ENABLE(FETCH_API)
32
33 #include "FetchBodyOwner.h"
34 #include "FetchHeaders.h"
35 #include "ResourceResponse.h"
36
37 namespace JSC {
38 class ArrayBuffer;
39 };
40
41 namespace WebCore {
42
43 class Dictionary;
44 class FetchRequest;
45 class ReadableStreamSource;
46
47 typedef int ExceptionCode;
48
49 enum class ResponseType { Basic, Cors, Default, Error, Opaque, Opaqueredirect };
50
51 class FetchResponse final : public FetchBodyOwner {
52 public:
53     static Ref<FetchResponse> create(ScriptExecutionContext& context) { return adoptRef(*new FetchResponse(context, ResponseType::Default, { }, FetchHeaders::create(FetchHeaders::Guard::Response), ResourceResponse())); }
54     static Ref<FetchResponse> error(ScriptExecutionContext&);
55     static RefPtr<FetchResponse> redirect(ScriptExecutionContext&, const String&, int, ExceptionCode&);
56
57     using FetchPromise = DOMPromise<RefPtr<FetchResponse>, ExceptionCode>;
58     static void fetch(ScriptExecutionContext&, FetchRequest&, const Dictionary&, FetchPromise&&);
59     static void fetch(ScriptExecutionContext&, const String&, const Dictionary&, FetchPromise&&);
60
61     void initializeWith(const Dictionary&, ExceptionCode&);
62
63     ResponseType type() const;
64     const String& url() const { return m_response.url().string(); }
65     bool redirected() const { return m_isRedirected; }
66     int status() const { return m_response.httpStatusCode(); }
67     bool ok() const { return status() >= 200 && status() <= 299; }
68     const String& statusText() const { return m_response.httpStatusText(); }
69
70     FetchHeaders& headers() { return m_headers; }
71     RefPtr<FetchResponse> clone(ScriptExecutionContext&, ExceptionCode&);
72
73 #if ENABLE(STREAMS_API)
74     ReadableStreamSource* createReadableStreamSource();
75     void consumeBodyAsStream();
76 #endif
77
78 private:
79     FetchResponse(ScriptExecutionContext&, ResponseType, FetchBody&&, Ref<FetchHeaders>&&, ResourceResponse&&);
80
81     static void startFetching(ScriptExecutionContext&, const FetchRequest&, FetchPromise&&);
82
83     // ActiveDOMObject API
84     void stop() final;
85     const char* activeDOMObjectName() const final;
86     bool canSuspendForDocumentSuspension() const final;
87
88     class BodyLoader final : public FetchLoaderClient {
89     public:
90         BodyLoader(FetchResponse&, FetchPromise&&);
91
92         bool start(ScriptExecutionContext&, const FetchRequest&);
93         void stop();
94
95 #if ENABLE(STREAMS_API)
96         RefPtr<SharedBuffer> startStreaming();
97 #endif
98
99     private:
100         // FetchLoaderClient API
101         void didSucceed() final;
102         void didFail() final;
103         void didReceiveResponse(const ResourceResponse&);
104         void didReceiveData(const char*, size_t) final;
105         void didFinishLoadingAsArrayBuffer(RefPtr<ArrayBuffer>&&) final;
106
107         FetchResponse& m_response;
108         Optional<FetchPromise> m_promise;
109         std::unique_ptr<FetchLoader> m_loader;
110     };
111
112     ResponseType m_type;
113     ResourceResponse m_response;
114     Ref<FetchHeaders> m_headers;
115     bool m_isRedirected = false;
116     Optional<BodyLoader> m_bodyLoader;
117 };
118
119 inline ResponseType FetchResponse::type() const
120 {
121     return m_type;
122 }
123
124 } // namespace WebCore
125
126 #endif // ENABLE(FETCH_API)