2fec1f3834e4116a1dd4ceb1f632898d5ece140d
[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 "FormDataStreamMac.h"
32 #import "HTTPHeaderNames.h"
33 #import "ResourceRequestCFNet.h"
34 #import "RuntimeApplicationChecks.h"
35 #import <Foundation/Foundation.h>
36 #import <pal/spi/cf/CFNetworkSPI.h>
37 #import <wtf/FileSystem.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 ResourceRequestCachePolicy::UseProtocolCachePolicy;
58     case NSURLRequestReturnCacheDataElseLoad:
59         return ResourceRequestCachePolicy::ReturnCacheDataElseLoad;
60     case NSURLRequestReturnCacheDataDontLoad:
61         return ResourceRequestCachePolicy::ReturnCacheDataDontLoad;
62     default:
63         return ResourceRequestCachePolicy::ReloadIgnoringCacheData;
64     }
65 }
66
67 static inline NSURLRequestCachePolicy toPlatformRequestCachePolicy(ResourceRequestCachePolicy policy)
68 {
69     switch (policy) {
70     case ResourceRequestCachePolicy::UseProtocolCachePolicy:
71         return NSURLRequestUseProtocolCachePolicy;
72     case ResourceRequestCachePolicy::ReturnCacheDataElseLoad:
73         return NSURLRequestReturnCacheDataElseLoad;
74     case ResourceRequestCachePolicy::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 == ResourceRequestCachePolicy::UseProtocolCachePolicy)
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 (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400) || (PLATFORM(IOS_FAMILY) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000)
91     URL siteForCookies { [m_nsRequest.get() _propertyForKey:@"_kCFHTTPCookiePolicyPropertySiteForCookies"] };
92     m_sameSiteDisposition = siteForCookies.isNull() ? SameSiteDisposition::Unspecified : (registrableDomainsAreEqual(siteForCookies, m_url) ? SameSiteDisposition::SameSite : SameSiteDisposition::CrossSite);
93
94     m_isTopSite = static_cast<NSNumber*>([m_nsRequest.get() _propertyForKey:@"_kCFHTTPCookiePolicyPropertyIsTopLevelNavigation"]).boolValue;
95 #endif
96
97     if (NSString* method = [m_nsRequest.get() HTTPMethod])
98         m_httpMethod = method;
99     m_allowCookies = [m_nsRequest.get() HTTPShouldHandleCookies];
100
101     if (resourcePrioritiesEnabled())
102         m_priority = toResourceLoadPriority(m_nsRequest ? CFURLRequestGetRequestPriority([m_nsRequest _CFURLRequest]) : 0);
103
104     m_httpHeaderFields.clear();
105     [[m_nsRequest allHTTPHeaderFields] enumerateKeysAndObjectsUsingBlock: ^(NSString *name, NSString *value, BOOL *) {
106         m_httpHeaderFields.set(name, value);
107     }];
108
109     m_responseContentDispositionEncodingFallbackArray.clear();
110     NSArray *encodingFallbacks = [m_nsRequest.get() contentDispositionEncodingFallbackArray];
111     m_responseContentDispositionEncodingFallbackArray.reserveCapacity([encodingFallbacks count]);
112     for (NSNumber *encodingFallback in [m_nsRequest contentDispositionEncodingFallbackArray]) {
113         CFStringEncoding encoding = CFStringConvertNSStringEncodingToEncoding([encodingFallback unsignedLongValue]);
114         if (encoding != kCFStringEncodingInvalidId)
115             m_responseContentDispositionEncodingFallbackArray.uncheckedAppend(CFStringConvertEncodingToIANACharSetName(encoding));
116     }
117
118     if (m_nsRequest) {
119         NSString* cachePartition = [NSURLProtocol propertyForKey:(NSString *)_kCFURLCachePartitionKey inRequest:m_nsRequest.get()];
120         if (cachePartition)
121             m_cachePartition = cachePartition;
122     }
123 }
124
125 void ResourceRequest::doUpdateResourceHTTPBody()
126 {
127     if (NSData* bodyData = [m_nsRequest.get() HTTPBody])
128         m_httpBody = FormData::create([bodyData bytes], [bodyData length]);
129     else if (NSInputStream* bodyStream = [m_nsRequest.get() HTTPBodyStream]) {
130         FormData* formData = httpBodyFromStream(bodyStream);
131         // There is no FormData object if a client provided a custom data stream.
132         // We shouldn't be looking at http body after client callbacks.
133         ASSERT(formData);
134         if (formData)
135             m_httpBody = formData;
136     }
137 }
138
139 #if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400) || (PLATFORM(IOS_FAMILY) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000)
140 static NSURL *siteForCookies(ResourceRequest::SameSiteDisposition disposition, NSURL *url)
141 {
142     switch (disposition) {
143     case ResourceRequest::SameSiteDisposition::Unspecified:
144         return { };
145     case ResourceRequest::SameSiteDisposition::SameSite:
146         return url;
147     case ResourceRequest::SameSiteDisposition::CrossSite:
148         static NSURL *emptyURL = [[NSURL alloc] initWithString:@""];
149         return emptyURL;
150     }
151 }
152 #endif
153
154 void ResourceRequest::doUpdatePlatformRequest()
155 {
156     if (isNull()) {
157         m_nsRequest = nil;
158         return;
159     }
160
161     NSMutableURLRequest *nsRequest = [m_nsRequest.get() mutableCopy];
162
163     if (nsRequest)
164         [nsRequest setURL:url()];
165     else
166         nsRequest = [[NSMutableURLRequest alloc] initWithURL:url()];
167
168     if (ResourceRequest::httpPipeliningEnabled())
169         CFURLRequestSetShouldPipelineHTTP([nsRequest _CFURLRequest], true, true);
170
171     if (ResourceRequest::resourcePrioritiesEnabled())
172         CFURLRequestSetRequestPriority([nsRequest _CFURLRequest], toPlatformRequestPriority(priority()));
173
174     [nsRequest setCachePolicy:toPlatformRequestCachePolicy(cachePolicy())];
175     _CFURLRequestSetProtocolProperty([nsRequest _CFURLRequest], kCFURLRequestAllowAllPOSTCaching, kCFBooleanTrue);
176
177     double timeoutInterval = ResourceRequestBase::timeoutInterval();
178     if (timeoutInterval)
179         [nsRequest setTimeoutInterval:timeoutInterval];
180     // Otherwise, respect NSURLRequest default timeout.
181
182     [nsRequest setMainDocumentURL:firstPartyForCookies()];
183     if (!httpMethod().isEmpty())
184         [nsRequest setHTTPMethod:httpMethod()];
185     [nsRequest setHTTPShouldHandleCookies:allowCookies()];
186
187 #if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400) || (PLATFORM(IOS_FAMILY) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000)
188     [nsRequest _setProperty:siteForCookies(m_sameSiteDisposition, nsRequest.URL) forKey:@"_kCFHTTPCookiePolicyPropertySiteForCookies"];
189     [nsRequest _setProperty:[NSNumber numberWithBool:m_isTopSite] forKey:@"_kCFHTTPCookiePolicyPropertyIsTopLevelNavigation"];
190 #endif
191
192     // Cannot just use setAllHTTPHeaderFields here, because it does not remove headers.
193     for (NSString *oldHeaderName in [nsRequest allHTTPHeaderFields])
194         [nsRequest setValue:nil forHTTPHeaderField:oldHeaderName];
195     for (const auto& header : httpHeaderFields())
196         [nsRequest setValue:header.value forHTTPHeaderField:header.key];
197
198     NSMutableArray *encodingFallbacks = [NSMutableArray array];
199     for (const auto& encodingName : m_responseContentDispositionEncodingFallbackArray) {
200         CFStringEncoding nsEncoding = CFStringConvertEncodingToNSStringEncoding(CFStringConvertIANACharSetNameToEncoding(encodingName.createCFString().get()));
201         if (nsEncoding != kCFStringEncodingInvalidId)
202             [encodingFallbacks addObject:[NSNumber numberWithUnsignedLong:nsEncoding]];
203     }
204     [nsRequest setContentDispositionEncodingFallbackArray:encodingFallbacks];
205
206     String partition = cachePartition();
207     if (!partition.isNull() && !partition.isEmpty()) {
208         NSString *partitionValue = [NSString stringWithUTF8String:partition.utf8().data()];
209         [NSURLProtocol setProperty:partitionValue forKey:(NSString *)_kCFURLCachePartitionKey inRequest:nsRequest];
210     }
211
212 #if PLATFORM(MAC)
213     if (m_url.isLocalFile()) {
214         auto fsRepFile = FileSystem::fileSystemRepresentation(m_url.fileSystemPath());
215         if (!fsRepFile.isNull()) {
216             auto fileDevice = FileSystem::getFileDeviceId(fsRepFile);
217             if (fileDevice && fileDevice.value())
218                 [nsRequest _setProperty:[NSNumber numberWithInteger:fileDevice.value()] forKey:@"NSURLRequestFileProtocolExpectedDevice"];
219         }
220     }
221 #endif
222
223     m_nsRequest = adoptNS(nsRequest);
224 }
225
226 void ResourceRequest::doUpdatePlatformHTTPBody()
227 {
228     if (isNull()) {
229         ASSERT(!m_nsRequest);
230         return;
231     }
232
233     NSMutableURLRequest *nsRequest = [m_nsRequest.get() mutableCopy];
234
235     if (nsRequest)
236         [nsRequest setURL:url()];
237     else
238         nsRequest = [[NSMutableURLRequest alloc] initWithURL:url()];
239
240     FormData* formData = httpBody();
241     if (formData && !formData->isEmpty())
242         WebCore::setHTTPBody(nsRequest, formData);
243
244     if (NSInputStream *bodyStream = [nsRequest HTTPBodyStream]) {
245         // For streams, provide a Content-Length to avoid using chunked encoding, and to get accurate total length in callbacks.
246         NSString *lengthString = [bodyStream propertyForKey:(__bridge NSString *)formDataStreamLengthPropertyName()];
247         if (lengthString) {
248             [nsRequest setValue:lengthString forHTTPHeaderField:@"Content-Length"];
249             // Since resource request is already marked updated, we need to keep it up to date too.
250             ASSERT(m_resourceRequestUpdated);
251             m_httpHeaderFields.set(HTTPHeaderName::ContentLength, lengthString);
252         }
253     }
254
255     m_nsRequest = adoptNS(nsRequest);
256 }
257
258 void ResourceRequest::setStorageSession(CFURLStorageSessionRef storageSession)
259 {
260     updatePlatformRequest();
261     m_nsRequest = adoptNS(copyRequestWithStorageSession(storageSession, m_nsRequest.get()));
262 }
263
264 NSURLRequest *copyRequestWithStorageSession(CFURLStorageSessionRef storageSession, NSURLRequest *request)
265 {
266     if (!storageSession || !request)
267         return [request copy];
268
269     auto cfRequest = adoptCF(CFURLRequestCreateMutableCopy(kCFAllocatorDefault, [request _CFURLRequest]));
270     _CFURLRequestSetStorageSession(cfRequest.get(), storageSession);
271     return [[NSURLRequest alloc] _initWithCFURLRequest:cfRequest.get()];
272 }
273
274 NSCachedURLResponse *cachedResponseForRequest(CFURLStorageSessionRef storageSession, NSURLRequest *request)
275 {
276     if (!storageSession)
277         return [[NSURLCache sharedURLCache] cachedResponseForRequest:request];
278
279     auto cache = adoptCF(_CFURLStorageSessionCopyCache(kCFAllocatorDefault, storageSession));
280     auto cachedResponse = adoptCF(CFURLCacheCopyResponseForRequest(cache.get(), [request _CFURLRequest]));
281     if (!cachedResponse)
282         return nil;
283
284     return [[[NSCachedURLResponse alloc] _initWithCFCachedURLResponse:cachedResponse.get()] autorelease];
285 }
286
287 } // namespace WebCore
288
289 #endif // PLATFORM(COCOA)
290