04d5d4841bb5228a5bed5107ca4cd3ad3ca16985
[WebKit-https.git] / Source / WebCore / platform / network / soup / ResourceRequest.h
1 /*
2  * Copyright (C) 2003, 2006 Apple Inc.  All rights reserved.
3  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef ResourceRequest_h
28 #define ResourceRequest_h
29
30 #include "GUniquePtrSoup.h"
31 #include "ResourceRequestBase.h"
32 #include <libsoup/soup.h>
33
34 namespace WebCore {
35
36     class ResourceRequest : public ResourceRequestBase {
37     public:
38         ResourceRequest(const String& url)
39             : ResourceRequestBase(URL(ParsedURLString, url), UseProtocolCachePolicy)
40             , m_acceptEncoding(true)
41             , m_soupFlags(static_cast<SoupMessageFlags>(0))
42             , m_initiatingPageID(0)
43         {
44         }
45
46         ResourceRequest(const URL& url)
47             : ResourceRequestBase(url, UseProtocolCachePolicy)
48             , m_acceptEncoding(true)
49             , m_soupFlags(static_cast<SoupMessageFlags>(0))
50             , m_initiatingPageID(0)
51         {
52         }
53
54         ResourceRequest(const URL& url, const String& referrer, ResourceRequestCachePolicy policy = UseProtocolCachePolicy)
55             : ResourceRequestBase(url, policy)
56             , m_acceptEncoding(true)
57             , m_soupFlags(static_cast<SoupMessageFlags>(0))
58             , m_initiatingPageID(0)
59         {
60             setHTTPReferrer(referrer);
61         }
62
63         ResourceRequest()
64             : ResourceRequestBase(URL(), UseProtocolCachePolicy)
65             , m_acceptEncoding(true)
66             , m_soupFlags(static_cast<SoupMessageFlags>(0))
67             , m_initiatingPageID(0)
68         {
69         }
70
71         ResourceRequest(SoupMessage* soupMessage)
72             : ResourceRequestBase(URL(), UseProtocolCachePolicy)
73             , m_acceptEncoding(true)
74             , m_soupFlags(static_cast<SoupMessageFlags>(0))
75             , m_initiatingPageID(0)
76         {
77             updateFromSoupMessage(soupMessage);
78         }
79
80         ResourceRequest(SoupRequest* soupRequest)
81             : ResourceRequestBase(URL(soup_request_get_uri(soupRequest)), UseProtocolCachePolicy)
82             , m_acceptEncoding(true)
83             , m_soupFlags(static_cast<SoupMessageFlags>(0))
84             , m_initiatingPageID(0)
85         {
86             updateFromSoupRequest(soupRequest);
87         }
88
89         void updateFromDelegatePreservingOldProperties(const ResourceRequest& delegateProvidedRequest) { *this = delegateProvidedRequest; }
90
91         bool acceptEncoding() const { return m_acceptEncoding; }
92         void setAcceptEncoding(bool acceptEncoding) { m_acceptEncoding = acceptEncoding; }
93
94         void updateSoupMessageHeaders(SoupMessageHeaders*) const;
95         void updateFromSoupMessageHeaders(SoupMessageHeaders*);
96         void updateSoupMessage(SoupMessage*) const;
97         void updateFromSoupMessage(SoupMessage*);
98         void updateSoupRequest(SoupRequest*) const;
99         void updateFromSoupRequest(SoupRequest*);
100
101         SoupMessageFlags soupMessageFlags() const { return m_soupFlags; }
102         void setSoupMessageFlags(SoupMessageFlags soupFlags) { m_soupFlags = soupFlags; }
103
104         uint64_t initiatingPageID() const { return m_initiatingPageID; }
105         void setInitiatingPageID(uint64_t pageID) { m_initiatingPageID = pageID; }
106
107         GUniquePtr<SoupURI> createSoupURI() const;
108
109         template<class Encoder> void encodeWithPlatformData(Encoder&) const;
110         template<class Decoder> bool decodeWithPlatformData(Decoder&);
111
112     private:
113         friend class ResourceRequestBase;
114
115         bool m_acceptEncoding : 1;
116         SoupMessageFlags m_soupFlags;
117         uint64_t m_initiatingPageID;
118
119         void updateSoupMessageMembers(SoupMessage*) const;
120         void updateSoupMessageBody(SoupMessage*) const;
121         void doUpdatePlatformRequest() { }
122         void doUpdateResourceRequest() { }
123         void doUpdatePlatformHTTPBody() { }
124         void doUpdateResourceHTTPBody() { }
125
126         void doPlatformSetAsIsolatedCopy(const ResourceRequest&) { }
127     };
128
129 template<class Encoder>
130 void ResourceRequest::encodeWithPlatformData(Encoder& encoder) const
131 {
132     encodeBase(encoder);
133
134     // FIXME: Do not encode HTTP message body.
135     // 1. It can be large and thus costly to send across.
136     // 2. It is misleading to provide a body with some requests, while others use body streams, which cannot be serialized at all.
137     encoder << static_cast<bool>(m_httpBody);
138     if (m_httpBody)
139         encoder << m_httpBody->flattenToString();
140
141     encoder << static_cast<uint32_t>(m_soupFlags);
142     encoder << m_initiatingPageID;
143 }
144
145 template<class Decoder>
146 bool ResourceRequest::decodeWithPlatformData(Decoder& decoder)
147 {
148     if (!decodeBase(decoder))
149         return false;
150
151     bool hasHTTPBody;
152     if (!decoder.decode(hasHTTPBody))
153         return false;
154     if (hasHTTPBody) {
155         String httpBody;
156         if (!decoder.decode(httpBody))
157             return false;
158         setHTTPBody(FormData::create(httpBody.utf8()));
159     }
160
161     uint32_t soupMessageFlags;
162     if (!decoder.decode(soupMessageFlags))
163         return false;
164     m_soupFlags = static_cast<SoupMessageFlags>(soupMessageFlags);
165
166     uint64_t initiatingPageID;
167     if (!decoder.decode(initiatingPageID))
168         return false;
169     m_initiatingPageID = initiatingPageID;
170
171     return true;
172 }
173
174
175 #if SOUP_CHECK_VERSION(2, 43, 1)
176 inline SoupMessagePriority toSoupMessagePriority(ResourceLoadPriority priority)
177 {
178     switch (priority) {
179     case ResourceLoadPriority::VeryLow:
180         return SOUP_MESSAGE_PRIORITY_VERY_LOW;
181     case ResourceLoadPriority::Low:
182         return SOUP_MESSAGE_PRIORITY_LOW;
183     case ResourceLoadPriority::Medium:
184         return SOUP_MESSAGE_PRIORITY_NORMAL;
185     case ResourceLoadPriority::High:
186         return SOUP_MESSAGE_PRIORITY_HIGH;
187     case ResourceLoadPriority::VeryHigh:
188         return SOUP_MESSAGE_PRIORITY_VERY_HIGH;
189     }
190
191     ASSERT_NOT_REACHED();
192     return SOUP_MESSAGE_PRIORITY_VERY_LOW;
193 }
194 #endif
195
196 } // namespace WebCore
197
198 #endif // ResourceRequest_h