Opaque being-loaded responses should clone their body
[WebKit-https.git] / Source / WebCore / Modules / fetch / FetchBodyOwner.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 #include "ActiveDOMObject.h"
32 #include "FetchBody.h"
33 #include "FetchBodySource.h"
34 #include "FetchHeaders.h"
35 #include "FetchLoader.h"
36 #include "FetchLoaderClient.h"
37
38 namespace WebCore {
39
40 class FetchBodyOwner : public RefCounted<FetchBodyOwner>, public ActiveDOMObject {
41 public:
42     FetchBodyOwner(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&);
43
44     bool bodyUsed() const { return isDisturbed(); }
45     void arrayBuffer(Ref<DeferredPromise>&&);
46     void blob(Ref<DeferredPromise>&&);
47     void formData(Ref<DeferredPromise>&&);
48     void json(Ref<DeferredPromise>&&);
49     void text(Ref<DeferredPromise>&&);
50
51     bool isDisturbed() const;
52     bool isDisturbedOrLocked() const;
53
54     void loadBlob(const Blob&, FetchBodyConsumer*);
55
56     bool isActive() const { return !!m_blobLoader; }
57
58     RefPtr<ReadableStream> readableStream(JSC::ExecState&);
59     bool hasReadableStreamBody() const { return m_body && m_body->hasReadableStream(); }
60
61 #if ENABLE(STREAMS_API)
62     virtual void consumeBodyAsStream();
63     virtual void feedStream() { }
64     virtual void cancel() { }
65 #endif
66
67 protected:
68     const FetchBody& body() const { return *m_body; }
69     FetchBody& body() { return *m_body; }
70     bool isBodyNull() const { return !m_body; }
71     bool isBodyNullOrOpaque() const { return !m_body || m_isBodyOpaque; }
72     void cloneBody(FetchBodyOwner&);
73
74     void extractBody(ScriptExecutionContext&, FetchBody::Init&&);
75     void updateContentType();
76     void consumeOnceLoadingFinished(FetchBodyConsumer::Type, Ref<DeferredPromise>&&);
77
78     void setBody(FetchBody&& body) { m_body = WTFMove(body); }
79     void createReadableStream(JSC::ExecState&);
80
81     // ActiveDOMObject API
82     void stop() override;
83
84     void setDisturbed() { m_isDisturbed = true; }
85
86     void setBodyAsOpaque() { m_isBodyOpaque = true; }
87     bool isBodyOpaque() const { return m_isBodyOpaque; }
88
89 private:
90     // Blob loading routines
91     void blobChunk(const char*, size_t);
92     void blobLoadingSucceeded();
93     void blobLoadingFailed();
94     void finishBlobLoading();
95
96     struct BlobLoader final : FetchLoaderClient {
97         BlobLoader(FetchBodyOwner&);
98
99         // FetchLoaderClient API
100         void didReceiveResponse(const ResourceResponse&) final;
101         void didReceiveData(const char* data, size_t size) final { owner.blobChunk(data, size); }
102         void didFail(const ResourceError&) final;
103         void didSucceed() final { owner.blobLoadingSucceeded(); }
104
105         FetchBodyOwner& owner;
106         std::unique_ptr<FetchLoader> loader;
107     };
108
109 protected:
110     std::optional<FetchBody> m_body;
111     String m_contentType;
112     bool m_isDisturbed { false };
113 #if ENABLE(STREAMS_API)
114     RefPtr<FetchBodySource> m_readableStreamSource;
115 #endif
116     Ref<FetchHeaders> m_headers;
117
118 private:
119     std::optional<BlobLoader> m_blobLoader;
120     bool m_isBodyOpaque { false };
121 };
122
123 } // namespace WebCore