9fe9c78670df01da54952022a37614357ab75681
[WebKit-https.git] / Source / WebCore / platform / network / cf / 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 #pragma once
28
29 #include "ResourceRequestBase.h"
30 #include <wtf/RetainPtr.h>
31
32 OBJC_CLASS NSCachedURLResponse;
33 OBJC_CLASS NSURLRequest;
34
35 #if PLATFORM(COCOA) || USE(CFURLCONNECTION)
36 typedef const struct _CFURLRequest* CFURLRequestRef;
37 typedef const struct __CFURLStorageSession* CFURLStorageSessionRef;
38 #endif
39
40 namespace WebCore {
41
42 class ResourceRequest : public ResourceRequestBase {
43 public:
44     ResourceRequest(const String& url) 
45         : ResourceRequestBase(URL(ParsedURLString, url), UseProtocolCachePolicy)
46     {
47     }
48
49     ResourceRequest(const URL& url) 
50         : ResourceRequestBase(url, UseProtocolCachePolicy)
51     {
52     }
53
54     ResourceRequest(const URL& url, const String& referrer, ResourceRequestCachePolicy policy = UseProtocolCachePolicy)
55         : ResourceRequestBase(url, policy)
56     {
57         setHTTPReferrer(referrer);
58     }
59     
60     ResourceRequest()
61         : ResourceRequestBase(URL(), UseProtocolCachePolicy)
62     {
63     }
64     
65 #if USE(CFURLCONNECTION)
66     ResourceRequest(CFURLRequestRef cfRequest)
67         : ResourceRequestBase()
68         , m_cfRequest(cfRequest)
69     {
70     }
71 #else
72     ResourceRequest(NSURLRequest *nsRequest)
73         : ResourceRequestBase()
74         , m_nsRequest(nsRequest)
75     {
76     }
77 #endif
78
79     WEBCORE_EXPORT void updateFromDelegatePreservingOldProperties(const ResourceRequest&);
80
81 #if PLATFORM(COCOA)
82     bool encodingRequiresPlatformData() const { return m_httpBody || m_nsRequest; }
83     WEBCORE_EXPORT NSURLRequest *nsURLRequest(HTTPBodyUpdatePolicy) const;
84
85     WEBCORE_EXPORT static CFStringRef isUserInitiatedKey();
86 #endif
87
88 #if PLATFORM(COCOA) || USE(CFURLCONNECTION)
89     WEBCORE_EXPORT CFURLRequestRef cfURLRequest(HTTPBodyUpdatePolicy) const;
90     void setStorageSession(CFURLStorageSessionRef);
91 #endif
92
93     WEBCORE_EXPORT static bool httpPipeliningEnabled();
94     WEBCORE_EXPORT static void setHTTPPipeliningEnabled(bool);
95
96     static bool resourcePrioritiesEnabled();
97
98 private:
99     friend class ResourceRequestBase;
100
101     void doUpdatePlatformRequest();
102     void doUpdateResourceRequest();
103     void doUpdatePlatformHTTPBody();
104     void doUpdateResourceHTTPBody();
105
106     void doPlatformSetAsIsolatedCopy(const ResourceRequest&);
107
108 #if USE(CFURLCONNECTION)
109     RetainPtr<CFURLRequestRef> m_cfRequest;
110 #endif
111 #if PLATFORM(COCOA)
112     RetainPtr<NSURLRequest> m_nsRequest;
113 #endif
114
115     static bool s_httpPipeliningEnabled;
116 };
117
118 inline bool ResourceRequest::resourcePrioritiesEnabled()
119 {
120 #if PLATFORM(MAC)
121     return true;
122 #elif PLATFORM(IOS)
123     return true;
124 #elif PLATFORM(WIN)
125     return false;
126 #endif
127 }
128
129 #if PLATFORM(COCOA)
130 NSURLRequest *copyRequestWithStorageSession(CFURLStorageSessionRef, NSURLRequest *);
131 WEBCORE_EXPORT NSCachedURLResponse *cachedResponseForRequest(CFURLStorageSessionRef, NSURLRequest *);
132 #endif
133
134 } // namespace WebCore