[WebIDL] Split-up and cleanup Fetch IDL files in preparation for removing unnecessary...
[WebKit.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 #if ENABLE(FETCH_API)
32
33 #include "ActiveDOMObject.h"
34 #include "FetchBody.h"
35 #include "FetchHeaders.h"
36 #include "FetchLoader.h"
37 #include "FetchLoaderClient.h"
38 #include "FetchResponseSource.h"
39
40 namespace WebCore {
41
42 class FetchBodyOwner : public RefCounted<FetchBodyOwner>, public ActiveDOMObject {
43 public:
44     FetchBodyOwner(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&);
45
46     // Exposed Body API
47     // FIXME: Missing body attribute returning a ReadableStream.
48     bool bodyUsed() const { return isDisturbed(); }
49     void arrayBuffer(Ref<DeferredPromise>&&);
50     void blob(Ref<DeferredPromise>&&);
51     void formData(Ref<DeferredPromise>&&);
52     void json(Ref<DeferredPromise>&&);
53     void text(Ref<DeferredPromise>&&);
54
55     bool isDisturbed() const { return m_isDisturbed; };
56     bool isDisturbedOrLocked() const;
57
58     void loadBlob(const Blob&, FetchBodyConsumer*);
59
60     bool isActive() const { return !!m_blobLoader; }
61
62 protected:
63     const FetchBody& body() const { return *m_body; }
64     FetchBody& body() { return *m_body; }
65     bool isBodyNull() const { return !m_body; }
66     void cloneBody(const FetchBodyOwner&);
67
68     void extractBody(ScriptExecutionContext&, FetchBody::BindingDataType&&);
69     void updateContentType();
70     void consumeOnceLoadingFinished(FetchBodyConsumer::Type, Ref<DeferredPromise>&&);
71
72     void setBody(FetchBody&& body) { m_body = WTFMove(body); }
73
74     // ActiveDOMObject API
75     void stop() override;
76
77     void setDisturbed() { m_isDisturbed = true; }
78
79 private:
80     // Blob loading routines
81     void blobChunk(const char*, size_t);
82     void blobLoadingSucceeded();
83     void blobLoadingFailed();
84     void finishBlobLoading();
85
86     struct BlobLoader final : FetchLoaderClient {
87         BlobLoader(FetchBodyOwner&);
88
89         // FetchLoaderClient API
90         void didReceiveResponse(const ResourceResponse&) final;
91         void didReceiveData(const char* data, size_t size) final { owner.blobChunk(data, size); }
92         void didFail() final;
93         void didSucceed() final { owner.blobLoadingSucceeded(); }
94
95         FetchBodyOwner& owner;
96         std::unique_ptr<FetchLoader> loader;
97     };
98
99 protected:
100     std::optional<FetchBody> m_body;
101     String m_contentType;
102     bool m_isDisturbed { false };
103 #if ENABLE(STREAMS_API)
104     RefPtr<FetchResponseSource> m_readableStreamSource;
105 #endif
106     Ref<FetchHeaders> m_headers;
107
108 private:
109     std::optional<BlobLoader> m_blobLoader;
110 };
111
112 } // namespace WebCore
113
114 #endif // ENABLE(FETCH_API)