Remove Cocoa CFURLConnection loading code
[WebKit-https.git] / Source / WebCore / platform / network / cocoa / ResourceRequestCocoa.mm
1 /*
2  * Copyright (C) 2014-2017 Apple, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "ResourceRequest.h"
28
29 #if PLATFORM(COCOA)
30
31 #import "FileSystem.h"
32 #import "FormDataStreamMac.h"
33 #import "HTTPHeaderNames.h"
34 #import "ResourceRequestCFNet.h"
35 #import "RuntimeApplicationChecks.h"
36 #import <Foundation/Foundation.h>
37 #import <pal/spi/cf/CFNetworkSPI.h>
38 #import <wtf/text/CString.h>
39
40 namespace WebCore {
41
42 NSURLRequest *ResourceRequest::nsURLRequest(HTTPBodyUpdatePolicy bodyPolicy) const
43 {
44     updatePlatformRequest(bodyPolicy);
45     return [[m_nsRequest.get() retain] autorelease];
46 }
47
48 CFURLRequestRef ResourceRequest::cfURLRequest(HTTPBodyUpdatePolicy bodyPolicy) const
49 {
50     return [nsURLRequest(bodyPolicy) _CFURLRequest];
51 }
52
53 static inline ResourceRequestCachePolicy fromPlatformRequestCachePolicy(NSURLRequestCachePolicy policy)
54 {
55     switch (policy) {
56     case NSURLRequestUseProtocolCachePolicy:
57         return UseProtocolCachePolicy;
58     case NSURLRequestReturnCacheDataElseLoad:
59         return ReturnCacheDataElseLoad;
60     case NSURLRequestReturnCacheDataDontLoad:
61         return ReturnCacheDataDontLoad;
62     default:
63         return ReloadIgnoringCacheData;
64     }
65 }
66
67 static inline NSURLRequestCachePolicy toPlatformRequestCachePolicy(ResourceRequestCachePolicy policy)
68 {
69     switch (policy) {
70     case UseProtocolCachePolicy:
71         return NSURLRequestUseProtocolCachePolicy;
72     case ReturnCacheDataElseLoad:
73         return NSURLRequestReturnCacheDataElseLoad;
74     case ReturnCacheDataDontLoad:
75         return NSURLRequestReturnCacheDataDontLoad;
76     default:
77         return NSURLRequestReloadIgnoringLocalCacheData;
78     }
79 }
80
81 void ResourceRequest::doUpdateResourceRequest()
82 {
83     m_url = [m_nsRequest.get() URL];
84
85     if (!m_cachePolicy)
86         m_cachePolicy = fromPlatformRequestCachePolicy([m_nsRequest.get() cachePolicy]);
87     m_timeoutInterval = [m_nsRequest.get() timeoutInterval];
88     m_firstPartyForCookies = [m_nsRequest.get() mainDocumentURL];
89
90     if (NSString* method = [m_nsRequest.get() HTTPMethod])
91         m_httpMethod = method;
92     m_allowCookies = [m_nsRequest.get() HTTPShouldHandleCookies];
93
94     if (resourcePrioritiesEnabled())
95         m_priority = toResourceLoadPriority(m_nsRequest ? CFURLRequestGetRequestPriority([m_nsRequest _CFURLRequest]) : 0);
96
97     m_httpHeaderFields.clear();
98     [[m_nsRequest allHTTPHeaderFields] enumerateKeysAndObjectsUsingBlock: ^(NSString *name, NSString *value, BOOL *) {
99         m_httpHeaderFields.set(name, value);
100     }];
101
102     m_responseContentDispositionEncodingFallbackArray.clear();
103     NSArray *encodingFallbacks = [m_nsRequest.get() contentDispositionEncodingFallbackArray];
104     m_responseContentDispositionEncodingFallbackArray.reserveCapacity([encodingFallbacks count]);
105     for (NSNumber *encodingFallback in [m_nsRequest contentDispositionEncodingFallbackArray]) {
106         CFStringEncoding encoding = CFStringConvertNSStringEncodingToEncoding([encodingFallback unsignedLongValue]);
107         if (encoding != kCFStringEncodingInvalidId)
108             m_responseContentDispositionEncodingFallbackArray.uncheckedAppend(CFStringConvertEncodingToIANACharSetName(encoding));
109     }
110
111     if (m_nsRequest) {
112         NSString* cachePartition = [NSURLProtocol propertyForKey:(NSString *)_kCFURLCachePartitionKey inRequest:m_nsRequest.get()];
113         if (cachePartition)
114             m_cachePartition = cachePartition;
115     }
116 }
117
118 void ResourceRequest::doUpdateResourceHTTPBody()
119 {
120     if (NSData* bodyData = [m_nsRequest.get() HTTPBody])
121         m_httpBody = FormData::create([bodyData bytes], [bodyData length]);
122     else if (NSInputStream* bodyStream = [m_nsRequest.get() HTTPBodyStream]) {
123         FormData* formData = httpBodyFromStream(bodyStream);
124         // There is no FormData object if a client provided a custom data stream.
125         // We shouldn't be looking at http body after client callbacks.
126         ASSERT(formData);
127         if (formData)
128             m_httpBody = formData;
129     }
130 }
131
132 void ResourceRequest::doUpdatePlatformRequest()
133 {
134     if (isNull()) {
135         m_nsRequest = nil;
136         return;
137     }
138
139     NSMutableURLRequest *nsRequest = [m_nsRequest.get() mutableCopy];
140
141     if (nsRequest)
142         [nsRequest setURL:url()];
143     else
144         nsRequest = [[NSMutableURLRequest alloc] initWithURL:url()];
145
146     if (ResourceRequest::httpPipeliningEnabled())
147         CFURLRequestSetShouldPipelineHTTP([nsRequest _CFURLRequest], true, true);
148
149     if (ResourceRequest::resourcePrioritiesEnabled())
150         CFURLRequestSetRequestPriority([nsRequest _CFURLRequest], toPlatformRequestPriority(priority()));
151
152     [nsRequest setCachePolicy:toPlatformRequestCachePolicy(cachePolicy())];
153     _CFURLRequestSetProtocolProperty([nsRequest _CFURLRequest], kCFURLRequestAllowAllPOSTCaching, kCFBooleanTrue);
154
155     double timeoutInterval = ResourceRequestBase::timeoutInterval();
156     if (timeoutInterval)
157         [nsRequest setTimeoutInterval:timeoutInterval];
158     // Otherwise, respect NSURLRequest default timeout.
159
160     [nsRequest setMainDocumentURL:firstPartyForCookies()];
161     if (!httpMethod().isEmpty())
162         [nsRequest setHTTPMethod:httpMethod()];
163     [nsRequest setHTTPShouldHandleCookies:allowCookies()];
164
165     // Cannot just use setAllHTTPHeaderFields here, because it does not remove headers.
166     for (NSString *oldHeaderName in [nsRequest allHTTPHeaderFields])
167         [nsRequest setValue:nil forHTTPHeaderField:oldHeaderName];
168     for (const auto& header : httpHeaderFields())
169         [nsRequest setValue:header.value forHTTPHeaderField:header.key];
170
171     NSMutableArray *encodingFallbacks = [NSMutableArray array];
172     for (const auto& encodingName : m_responseContentDispositionEncodingFallbackArray) {
173         CFStringEncoding nsEncoding = CFStringConvertEncodingToNSStringEncoding(CFStringConvertIANACharSetNameToEncoding(encodingName.createCFString().get()));
174         if (nsEncoding != kCFStringEncodingInvalidId)
175             [encodingFallbacks addObject:[NSNumber numberWithUnsignedLong:nsEncoding]];
176     }
177     [nsRequest setContentDispositionEncodingFallbackArray:encodingFallbacks];
178
179     String partition = cachePartition();
180     if (!partition.isNull() && !partition.isEmpty()) {
181         NSString *partitionValue = [NSString stringWithUTF8String:partition.utf8().data()];
182         [NSURLProtocol setProperty:partitionValue forKey:(NSString *)_kCFURLCachePartitionKey inRequest:nsRequest];
183     }
184
185 #if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101200)
186     if (m_url.isLocalFile()) {
187         auto fsRepFile = FileSystem::fileSystemRepresentation(m_url.fileSystemPath());
188         if (!fsRepFile.isNull()) {
189             auto fileDevice = FileSystem::getFileDeviceId(fsRepFile);
190             if (fileDevice && fileDevice.value())
191                 [nsRequest _setProperty:[NSNumber numberWithInteger:fileDevice.value()] forKey:@"NSURLRequestFileProtocolExpectedDevice"];
192         }
193     }
194 #endif
195
196     m_nsRequest = adoptNS(nsRequest);
197 }
198
199 void ResourceRequest::doUpdatePlatformHTTPBody()
200 {
201     if (isNull()) {
202         ASSERT(!m_nsRequest);
203         return;
204     }
205
206     NSMutableURLRequest *nsRequest = [m_nsRequest.get() mutableCopy];
207
208     if (nsRequest)
209         [nsRequest setURL:url()];
210     else
211         nsRequest = [[NSMutableURLRequest alloc] initWithURL:url()];
212
213     FormData* formData = httpBody();
214     if (formData && !formData->isEmpty())
215         WebCore::setHTTPBody(nsRequest, formData);
216
217     if (NSInputStream *bodyStream = [nsRequest HTTPBodyStream]) {
218         // For streams, provide a Content-Length to avoid using chunked encoding, and to get accurate total length in callbacks.
219         NSString *lengthString = [bodyStream propertyForKey:(NSString *)formDataStreamLengthPropertyName()];
220         if (lengthString) {
221             [nsRequest setValue:lengthString forHTTPHeaderField:@"Content-Length"];
222             // Since resource request is already marked updated, we need to keep it up to date too.
223             ASSERT(m_resourceRequestUpdated);
224             m_httpHeaderFields.set(HTTPHeaderName::ContentLength, lengthString);
225         }
226     }
227
228     m_nsRequest = adoptNS(nsRequest);
229 }
230
231 void ResourceRequest::setStorageSession(CFURLStorageSessionRef storageSession)
232 {
233     updatePlatformRequest();
234     m_nsRequest = adoptNS(copyRequestWithStorageSession(storageSession, m_nsRequest.get()));
235 }
236
237 NSURLRequest *copyRequestWithStorageSession(CFURLStorageSessionRef storageSession, NSURLRequest *request)
238 {
239     if (!storageSession || !request)
240         return [request copy];
241
242     auto cfRequest = adoptCF(CFURLRequestCreateMutableCopy(kCFAllocatorDefault, [request _CFURLRequest]));
243     _CFURLRequestSetStorageSession(cfRequest.get(), storageSession);
244     return [[NSURLRequest alloc] _initWithCFURLRequest:cfRequest.get()];
245 }
246
247 NSCachedURLResponse *cachedResponseForRequest(CFURLStorageSessionRef storageSession, NSURLRequest *request)
248 {
249     if (!storageSession)
250         return [[NSURLCache sharedURLCache] cachedResponseForRequest:request];
251
252     auto cache = adoptCF(_CFURLStorageSessionCopyCache(kCFAllocatorDefault, storageSession));
253     auto cachedResponse = adoptCF(CFURLCacheCopyResponseForRequest(cache.get(), [request _CFURLRequest]));
254     if (!cachedResponse)
255         return nil;
256
257     return [[[NSCachedURLResponse alloc] _initWithCFCachedURLResponse:cachedResponse.get()] autorelease];
258 }
259
260 } // namespace WebCore
261
262 #endif // PLATFORM(COCOA)
263