Reduce PassRefPtr in WebKit2 - 3
[WebKit-https.git] / Source / WebKit2 / WebProcess / Network / WebResourceLoadScheduler.cpp
1 /*
2  * Copyright (C) 2012 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 #include "config.h"
27 #include "WebResourceLoadScheduler.h"
28
29 #include "Logging.h"
30 #include "NetworkConnectionToWebProcessMessages.h"
31 #include "NetworkProcessConnection.h"
32 #include "NetworkResourceLoadParameters.h"
33 #include "SessionTracker.h"
34 #include "WebCoreArgumentCoders.h"
35 #include "WebErrors.h"
36 #include "WebFrame.h"
37 #include "WebFrameLoaderClient.h"
38 #include "WebPage.h"
39 #include "WebProcess.h"
40 #include "WebResourceLoader.h"
41 #include <WebCore/ApplicationCacheHost.h>
42 #include <WebCore/CachedResource.h>
43 #include <WebCore/Document.h>
44 #include <WebCore/DocumentLoader.h>
45 #include <WebCore/Frame.h>
46 #include <WebCore/FrameLoader.h>
47 #include <WebCore/NetscapePlugInStreamLoader.h>
48 #include <WebCore/ReferrerPolicy.h>
49 #include <WebCore/ResourceLoader.h>
50 #include <WebCore/SessionID.h>
51 #include <WebCore/Settings.h>
52 #include <WebCore/SubresourceLoader.h>
53 #include <wtf/text/CString.h>
54
55 #if ENABLE(NETWORK_PROCESS)
56
57 using namespace WebCore;
58
59 namespace WebKit {
60
61 WebResourceLoadScheduler::WebResourceLoadScheduler()
62     : m_internallyFailedLoadTimer(RunLoop::main(), this, &WebResourceLoadScheduler::internallyFailedLoadTimerFired)
63 {
64 }
65
66 WebResourceLoadScheduler::~WebResourceLoadScheduler()
67 {
68 }
69
70 RefPtr<SubresourceLoader> WebResourceLoadScheduler::scheduleSubresourceLoad(Frame* frame, CachedResource* resource, const ResourceRequest& request, const ResourceLoaderOptions& options)
71 {
72     RefPtr<SubresourceLoader> loader = SubresourceLoader::create(frame, resource, request, options);
73     if (loader)
74         scheduleLoad(loader.get(), resource, frame->document()->referrerPolicy() == ReferrerPolicyDefault);
75     return loader;
76 }
77
78 RefPtr<NetscapePlugInStreamLoader> WebResourceLoadScheduler::schedulePluginStreamLoad(Frame* frame, NetscapePlugInStreamLoaderClient* client, const ResourceRequest& request)
79 {
80     RefPtr<NetscapePlugInStreamLoader> loader = NetscapePlugInStreamLoader::create(frame, client, request);
81     if (loader)
82         scheduleLoad(loader.get(), 0, frame->document()->referrerPolicy() == ReferrerPolicyDefault);
83     return loader;
84 }
85
86 static std::chrono::milliseconds maximumBufferingTime(CachedResource* resource)
87 {
88     if (!resource)
89         return 0_ms;
90
91     switch (resource->type()) {
92     case CachedResource::CSSStyleSheet:
93     case CachedResource::Script:
94 #if ENABLE(SVG_FONTS)
95     case CachedResource::SVGFontResource:
96 #endif
97     case CachedResource::FontResource:
98         return std::chrono::milliseconds::max();
99     case CachedResource::ImageResource:
100         return 500_ms;
101     case CachedResource::MainResource:
102     case CachedResource::RawResource:
103     case CachedResource::SVGDocumentResource:
104 #if ENABLE(LINK_PREFETCH)
105     case CachedResource::LinkPrefetch:
106     case CachedResource::LinkSubresource:
107 #endif
108 #if ENABLE(VIDEO_TRACK)
109     case CachedResource::TextTrackResource:
110 #endif
111 #if ENABLE(XSLT)
112     case CachedResource::XSLStyleSheet:
113 #endif
114         return 0_ms;
115     }
116
117     ASSERT_NOT_REACHED();
118     return 0_ms;
119 }
120
121 void WebResourceLoadScheduler::scheduleLoad(ResourceLoader* resourceLoader, CachedResource* resource, bool shouldClearReferrerOnHTTPSToHTTPRedirect)
122 {
123     ASSERT(resourceLoader);
124
125     ResourceLoadIdentifier identifier = resourceLoader->identifier();
126     ASSERT(identifier);
127
128 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
129     // If the DocumentLoader schedules this as an archive resource load,
130     // then we should remember the ResourceLoader in our records but not schedule it in the NetworkProcess.
131     if (resourceLoader->documentLoader()->scheduleArchiveLoad(resourceLoader, resourceLoader->request())) {
132         LOG(NetworkScheduling, "(WebProcess) WebResourceLoadScheduler::scheduleLoad, url '%s' will be handled as an archive resource.", resourceLoader->url().string().utf8().data());
133         m_webResourceLoaders.set(identifier, WebResourceLoader::create(resourceLoader));
134         return;
135     }
136 #endif
137
138     if (resourceLoader->documentLoader()->applicationCacheHost()->maybeLoadResource(resourceLoader, resourceLoader->request(), resourceLoader->request().url())) {
139         LOG(NetworkScheduling, "(WebProcess) WebResourceLoadScheduler::scheduleLoad, url '%s' will be loaded from application cache.", resourceLoader->url().string().utf8().data());
140         m_webResourceLoaders.set(identifier, WebResourceLoader::create(resourceLoader));
141         return;
142     }
143
144 #if USE(QUICK_LOOK)
145     if (maybeLoadQuickLookResource(*resourceLoader)) {
146         LOG(NetworkScheduling, "(WebProcess) WebResourceLoadScheduler::scheduleLoad, url '%s' will be handled as a QuickLook resource.", resourceLoader->url().string().utf8().data());
147         m_webResourceLoaders.set(identifier, WebResourceLoader::create(resourceLoader));
148         return;
149     }
150 #endif
151
152     LOG(NetworkScheduling, "(WebProcess) WebResourceLoadScheduler::scheduleLoad, url '%s' will be scheduled with the NetworkProcess with priority %u", resourceLoader->url().string().utf8().data(), resourceLoader->request().priority());
153
154     ContentSniffingPolicy contentSniffingPolicy = resourceLoader->shouldSniffContent() ? SniffContent : DoNotSniffContent;
155     StoredCredentials allowStoredCredentials = resourceLoader->shouldUseCredentialStorage() ? AllowStoredCredentials : DoNotAllowStoredCredentials;
156
157     // FIXME: Some entities in WebCore use WebCore's "EmptyFrameLoaderClient" instead of having a proper WebFrameLoaderClient.
158     // EmptyFrameLoaderClient shouldn't exist and everything should be using a WebFrameLoaderClient,
159     // but in the meantime we have to make sure not to mis-cast.
160     WebFrameLoaderClient* webFrameLoaderClient = toWebFrameLoaderClient(resourceLoader->frameLoader()->client());
161     WebFrame* webFrame = webFrameLoaderClient ? webFrameLoaderClient->webFrame() : 0;
162     WebPage* webPage = webFrame ? webFrame->page() : 0;
163
164     NetworkResourceLoadParameters loadParameters;
165     loadParameters.identifier = identifier;
166     loadParameters.webPageID = webPage ? webPage->pageID() : 0;
167     loadParameters.webFrameID = webFrame ? webFrame->frameID() : 0;
168     loadParameters.sessionID = webPage ? webPage->sessionID() : SessionID::defaultSessionID();
169     loadParameters.request = resourceLoader->request();
170     loadParameters.contentSniffingPolicy = contentSniffingPolicy;
171     loadParameters.allowStoredCredentials = allowStoredCredentials;
172     // If there is no WebFrame then this resource cannot be authenticated with the client.
173     loadParameters.clientCredentialPolicy = (webFrame && webPage && resourceLoader->isAllowedToAskUserForCredentials()) ? AskClientForAllCredentials : DoNotAskClientForAnyCredentials;
174     loadParameters.shouldClearReferrerOnHTTPSToHTTPRedirect = shouldClearReferrerOnHTTPSToHTTPRedirect;
175     loadParameters.defersLoading = resourceLoader->defersLoading();
176     loadParameters.needsCertificateInfo = resourceLoader->shouldIncludeCertificateInfo();
177     loadParameters.maximumBufferingTime = maximumBufferingTime(resource);
178
179     ASSERT((loadParameters.webPageID && loadParameters.webFrameID) || loadParameters.clientCredentialPolicy == DoNotAskClientForAnyCredentials);
180
181     if (!WebProcess::singleton().networkConnection()->connection()->send(Messages::NetworkConnectionToWebProcess::ScheduleResourceLoad(loadParameters), 0)) {
182         // We probably failed to schedule this load with the NetworkProcess because it had crashed.
183         // This load will never succeed so we will schedule it to fail asynchronously.
184         scheduleInternallyFailedLoad(resourceLoader);
185         return;
186     }
187     
188     m_webResourceLoaders.set(identifier, WebResourceLoader::create(resourceLoader));
189 }
190
191 void WebResourceLoadScheduler::scheduleInternallyFailedLoad(WebCore::ResourceLoader* resourceLoader)
192 {
193     m_internallyFailedResourceLoaders.add(resourceLoader);
194     m_internallyFailedLoadTimer.startOneShot(0);
195 }
196
197 void WebResourceLoadScheduler::internallyFailedLoadTimerFired()
198 {
199     Vector<RefPtr<ResourceLoader>> internallyFailedResourceLoaders;
200     copyToVector(m_internallyFailedResourceLoaders, internallyFailedResourceLoaders);
201     
202     for (size_t i = 0; i < internallyFailedResourceLoaders.size(); ++i)
203         internallyFailedResourceLoaders[i]->didFail(internalError(internallyFailedResourceLoaders[i]->url()));
204 }
205
206 void WebResourceLoadScheduler::remove(ResourceLoader* resourceLoader)
207 {
208     ASSERT(resourceLoader);
209     LOG(NetworkScheduling, "(WebProcess) WebResourceLoadScheduler::remove, url '%s'", resourceLoader->url().string().utf8().data());
210
211     if (m_internallyFailedResourceLoaders.contains(resourceLoader)) {
212         m_internallyFailedResourceLoaders.remove(resourceLoader);
213         return;
214     }
215     
216     ResourceLoadIdentifier identifier = resourceLoader->identifier();
217     if (!identifier) {
218         LOG_ERROR("WebResourceLoadScheduler removing a ResourceLoader that has no identifier.");
219         return;
220     }
221     
222     RefPtr<WebResourceLoader> loader = m_webResourceLoaders.take(identifier);
223     // Loader may not be registered if we created it, but haven't scheduled yet (a bundle client can decide to cancel such request via willSendRequest).
224     if (!loader)
225         return;
226
227     WebProcess::singleton().networkConnection()->connection()->send(Messages::NetworkConnectionToWebProcess::RemoveLoadIdentifier(identifier), 0);
228
229     // It's possible that this WebResourceLoader might be just about to message back to the NetworkProcess (e.g. ContinueWillSendRequest)
230     // but there's no point in doing so anymore.
231     loader->detachFromCoreLoader();
232 }
233
234 void WebResourceLoadScheduler::setDefersLoading(ResourceLoader* resourceLoader, bool defers)
235 {
236     ResourceLoadIdentifier identifier = resourceLoader->identifier();
237     WebProcess::singleton().networkConnection()->connection()->send(Messages::NetworkConnectionToWebProcess::SetDefersLoading(identifier, defers), 0);
238 }
239
240 void WebResourceLoadScheduler::crossOriginRedirectReceived(ResourceLoader*, const URL&)
241 {
242     // We handle cross origin redirects entirely within the NetworkProcess.
243     // We override this call in the WebProcess to make it a no-op.
244 }
245
246 void WebResourceLoadScheduler::servePendingRequests(ResourceLoadPriority)
247 {
248     // This overrides the base class version.
249     // We don't need to do anything as this is handled by the network process.
250 }
251
252 void WebResourceLoadScheduler::suspendPendingRequests()
253 {
254     // Network process does keep requests in pending state.
255 }
256
257 void WebResourceLoadScheduler::resumePendingRequests()
258 {
259     // Network process does keep requests in pending state.
260 }
261
262 void WebResourceLoadScheduler::setSerialLoadingEnabled(bool)
263 {
264     // Network process does not reorder loads.
265 }
266
267 void WebResourceLoadScheduler::networkProcessCrashed()
268 {
269     HashMap<unsigned long, RefPtr<WebResourceLoader>>::iterator end = m_webResourceLoaders.end();
270     for (HashMap<unsigned long, RefPtr<WebResourceLoader>>::iterator i = m_webResourceLoaders.begin(); i != end; ++i)
271         scheduleInternallyFailedLoad(i->value.get()->resourceLoader());
272
273     m_webResourceLoaders.clear();
274 }
275
276 } // namespace WebKit
277
278 #endif // ENABLE(NETWORK_PROCESS)