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