5cd8e4f8639c567d5258d605485b5f4d93bb6a48
[WebKit-https.git] / Source / WebKit / NetworkProcess / CustomProtocols / Cocoa / LegacyCustomProtocolManagerCocoa.mm
1 /*
2  * Copyright (C) 2012, 2013 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "LegacyCustomProtocolManager.h"
28
29 #import "DataReference.h"
30 #import "LegacyCustomProtocolManagerMessages.h"
31 #import "NetworkProcess.h"
32 #import <Foundation/NSURLSession.h>
33 #import <WebCore/ResourceError.h>
34 #import <WebCore/ResourceRequest.h>
35 #import <WebCore/ResourceResponse.h>
36 #import <WebCore/TextEncoding.h>
37 #import <WebCore/URL.h>
38 #import <pal/spi/cocoa/NSURLConnectionSPI.h>
39
40 using namespace WebKit;
41
42 @interface WKCustomProtocol : NSURLProtocol {
43 @private
44     uint64_t _customProtocolID;
45     RetainPtr<CFRunLoopRef> _initializationRunLoop;
46 }
47 @property (nonatomic, readonly) uint64_t customProtocolID;
48 @property (nonatomic, readonly) CFRunLoopRef initializationRunLoop;
49 @end
50
51 @implementation WKCustomProtocol
52
53 @synthesize customProtocolID=_customProtocolID;
54
55 + (BOOL)canInitWithRequest:(NSURLRequest *)request
56 {
57     if (auto* customProtocolManager = NetworkProcess::singleton().supplement<LegacyCustomProtocolManager>())
58         return customProtocolManager->supportsScheme([[[request URL] scheme] lowercaseString]);
59     return NO;
60 }
61
62 + (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request
63 {
64     return request;
65 }
66
67 + (BOOL)requestIsCacheEquivalent:(NSURLRequest *)a toRequest:(NSURLRequest *)b
68 {
69     return NO;
70 }
71
72 - (id)initWithRequest:(NSURLRequest *)request cachedResponse:(NSCachedURLResponse *)cachedResponse client:(id<NSURLProtocolClient>)client
73 {
74     self = [super initWithRequest:request cachedResponse:cachedResponse client:client];
75     if (!self)
76         return nil;
77
78     if (auto* customProtocolManager = NetworkProcess::singleton().supplement<LegacyCustomProtocolManager>())
79         _customProtocolID = customProtocolManager->addCustomProtocol(self);
80     _initializationRunLoop = CFRunLoopGetCurrent();
81
82     return self;
83 }
84
85 - (CFRunLoopRef)initializationRunLoop
86 {
87     return _initializationRunLoop.get();
88 }
89
90 - (void)startLoading
91 {
92     if (auto* customProtocolManager = NetworkProcess::singleton().supplement<LegacyCustomProtocolManager>())
93         customProtocolManager->startLoading(self.customProtocolID, [self request]);
94 }
95
96 - (void)stopLoading
97 {
98     if (auto* customProtocolManager = NetworkProcess::singleton().supplement<LegacyCustomProtocolManager>()) {
99         customProtocolManager->stopLoading(self.customProtocolID);
100         customProtocolManager->removeCustomProtocol(self.customProtocolID);
101     }
102 }
103
104 @end
105
106 namespace WebKit {
107
108 void LegacyCustomProtocolManager::registerProtocolClass()
109 {
110 #if !USE(NETWORK_SESSION)
111     [NSURLProtocol registerClass:[WKCustomProtocol class]];
112 #endif
113 }
114
115 #if USE(NETWORK_SESSION)
116 void LegacyCustomProtocolManager::registerProtocolClass(NSURLSessionConfiguration *configuration)
117 {
118     configuration.protocolClasses = @[[WKCustomProtocol class]];
119 }
120 #endif
121
122 void LegacyCustomProtocolManager::registerScheme(const String& scheme)
123 {
124     ASSERT(!scheme.isNull());
125     LockHolder locker(m_registeredSchemesMutex);
126     m_registeredSchemes.add(scheme);
127 }
128
129 void LegacyCustomProtocolManager::unregisterScheme(const String& scheme)
130 {
131     ASSERT(!scheme.isNull());
132     LockHolder locker(m_registeredSchemesMutex);
133     m_registeredSchemes.remove(scheme);
134 }
135
136 bool LegacyCustomProtocolManager::supportsScheme(const String& scheme)
137 {
138     if (scheme.isNull())
139         return false;
140
141     LockHolder locker(m_registeredSchemesMutex);
142     return m_registeredSchemes.contains(scheme);
143 }
144
145 static inline void dispatchOnInitializationRunLoop(WKCustomProtocol* protocol, void (^block)())
146 {
147     CFRunLoopRef runloop = protocol.initializationRunLoop;
148     CFRunLoopPerformBlock(runloop, kCFRunLoopDefaultMode, block);
149     CFRunLoopWakeUp(runloop);
150 }
151
152 void LegacyCustomProtocolManager::didFailWithError(uint64_t customProtocolID, const WebCore::ResourceError& error)
153 {
154     RetainPtr<WKCustomProtocol> protocol = protocolForID(customProtocolID);
155     if (!protocol)
156         return;
157
158     RetainPtr<NSError> nsError = error.nsError();
159
160     dispatchOnInitializationRunLoop(protocol.get(), ^ {
161         [[protocol client] URLProtocol:protocol.get() didFailWithError:nsError.get()];
162     });
163
164     removeCustomProtocol(customProtocolID);
165 }
166
167 void LegacyCustomProtocolManager::didLoadData(uint64_t customProtocolID, const IPC::DataReference& data)
168 {
169     RetainPtr<WKCustomProtocol> protocol = protocolForID(customProtocolID);
170     if (!protocol)
171         return;
172
173     RetainPtr<NSData> nsData = adoptNS([[NSData alloc] initWithBytes:data.data() length:data.size()]);
174
175     dispatchOnInitializationRunLoop(protocol.get(), ^ {
176         [[protocol client] URLProtocol:protocol.get() didLoadData:nsData.get()];
177     });
178 }
179
180 void LegacyCustomProtocolManager::didReceiveResponse(uint64_t customProtocolID, const WebCore::ResourceResponse& response, uint32_t cacheStoragePolicy)
181 {
182     RetainPtr<WKCustomProtocol> protocol = protocolForID(customProtocolID);
183     if (!protocol)
184         return;
185
186     RetainPtr<NSURLResponse> nsResponse = response.nsURLResponse();
187
188     dispatchOnInitializationRunLoop(protocol.get(), ^ {
189         [[protocol client] URLProtocol:protocol.get() didReceiveResponse:nsResponse.get() cacheStoragePolicy:static_cast<NSURLCacheStoragePolicy>(cacheStoragePolicy)];
190     });
191 }
192
193 void LegacyCustomProtocolManager::didFinishLoading(uint64_t customProtocolID)
194 {
195     RetainPtr<WKCustomProtocol> protocol = protocolForID(customProtocolID);
196     if (!protocol)
197         return;
198
199     dispatchOnInitializationRunLoop(protocol.get(), ^ {
200         [[protocol client] URLProtocolDidFinishLoading:protocol.get()];
201     });
202
203     removeCustomProtocol(customProtocolID);
204 }
205
206 void LegacyCustomProtocolManager::wasRedirectedToRequest(uint64_t customProtocolID, const WebCore::ResourceRequest& request, const WebCore::ResourceResponse& redirectResponse)
207 {
208     RetainPtr<WKCustomProtocol> protocol = protocolForID(customProtocolID);
209     if (!protocol)
210         return;
211
212     RetainPtr<NSURLRequest> nsRequest = request.nsURLRequest(WebCore::DoNotUpdateHTTPBody);
213     RetainPtr<NSURLResponse> nsRedirectResponse = redirectResponse.nsURLResponse();
214
215     dispatchOnInitializationRunLoop(protocol.get(), [protocol, nsRequest, nsRedirectResponse]() {
216         [[protocol client] URLProtocol:protocol.get() wasRedirectedToRequest:nsRequest.get() redirectResponse:nsRedirectResponse.get()];
217     });
218 }
219
220 RetainPtr<WKCustomProtocol> LegacyCustomProtocolManager::protocolForID(uint64_t customProtocolID)
221 {
222     LockHolder locker(m_customProtocolMapMutex);
223
224     CustomProtocolMap::const_iterator it = m_customProtocolMap.find(customProtocolID);
225     if (it == m_customProtocolMap.end())
226         return nil;
227     
228     ASSERT(it->value);
229     return it->value;
230 }
231
232 } // namespace WebKit