Returning NULL from willSendRequest should cancel a load from the memory cache
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadNotifier.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "ResourceLoadNotifier.h"
33
34 #include "DocumentLoader.h"
35 #include "Frame.h"
36 #include "FrameLoader.h"
37 #include "FrameLoaderClient.h"
38 #include "InspectorInstrumentation.h"
39 #include "Page.h"
40 #include "ProgressTracker.h"
41 #include "ResourceLoader.h"
42
43 namespace WebCore {
44
45 ResourceLoadNotifier::ResourceLoadNotifier(Frame* frame)
46     : m_frame(frame)
47 {
48 }
49
50 void ResourceLoadNotifier::didReceiveAuthenticationChallenge(ResourceLoader* loader, const AuthenticationChallenge& currentWebChallenge)
51 {
52     m_frame->loader()->client()->dispatchDidReceiveAuthenticationChallenge(loader->documentLoader(), loader->identifier(), currentWebChallenge);
53 }
54
55 void ResourceLoadNotifier::didCancelAuthenticationChallenge(ResourceLoader* loader, const AuthenticationChallenge& currentWebChallenge)
56 {
57     m_frame->loader()->client()->dispatchDidCancelAuthenticationChallenge(loader->documentLoader(), loader->identifier(), currentWebChallenge);
58 }
59
60 void ResourceLoadNotifier::willSendRequest(ResourceLoader* loader, ResourceRequest& clientRequest, const ResourceResponse& redirectResponse)
61 {
62     m_frame->loader()->applyUserAgent(clientRequest);
63
64     dispatchWillSendRequest(loader->documentLoader(), loader->identifier(), clientRequest, redirectResponse);
65 }
66
67 void ResourceLoadNotifier::didReceiveResponse(ResourceLoader* loader, const ResourceResponse& r)
68 {
69     loader->documentLoader()->addResponse(r);
70
71     if (Page* page = m_frame->page())
72         page->progress()->incrementProgress(loader->identifier(), r);
73
74     dispatchDidReceiveResponse(loader->documentLoader(), loader->identifier(), r, loader);
75 }
76
77 void ResourceLoadNotifier::didReceiveData(ResourceLoader* loader, const char* data, int dataLength, int encodedDataLength)
78 {
79     if (Page* page = m_frame->page())
80         page->progress()->incrementProgress(loader->identifier(), data, dataLength);
81
82     dispatchDidReceiveData(loader->documentLoader(), loader->identifier(), data, dataLength, encodedDataLength);
83 }
84
85 void ResourceLoadNotifier::didFinishLoad(ResourceLoader* loader, double finishTime)
86 {    
87     if (Page* page = m_frame->page())
88         page->progress()->completeProgress(loader->identifier());
89     dispatchDidFinishLoading(loader->documentLoader(), loader->identifier(), finishTime);
90 }
91
92 void ResourceLoadNotifier::didFailToLoad(ResourceLoader* loader, const ResourceError& error)
93 {
94     if (Page* page = m_frame->page())
95         page->progress()->completeProgress(loader->identifier());
96
97     if (!error.isNull())
98         m_frame->loader()->client()->dispatchDidFailLoading(loader->documentLoader(), loader->identifier(), error);
99
100     InspectorInstrumentation::didFailLoading(m_frame, loader->documentLoader(), loader->identifier(), error);
101 }
102
103 void ResourceLoadNotifier::assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader* loader, const ResourceRequest& request)
104 {
105     m_frame->loader()->client()->assignIdentifierToInitialRequest(identifier, loader, request);
106 }
107
108 void ResourceLoadNotifier::dispatchWillSendRequest(DocumentLoader* loader, unsigned long identifier, ResourceRequest& request, const ResourceResponse& redirectResponse)
109 {
110     String oldRequestURL = request.url().string();
111     m_frame->loader()->documentLoader()->didTellClientAboutLoad(request.url());
112
113     m_frame->loader()->client()->dispatchWillSendRequest(loader, identifier, request, redirectResponse);
114
115     // If the URL changed, then we want to put that new URL in the "did tell client" set too.
116     if (!request.isNull() && oldRequestURL != request.url().string())
117         m_frame->loader()->documentLoader()->didTellClientAboutLoad(request.url());
118
119     InspectorInstrumentation::willSendRequest(m_frame, identifier, loader, request, redirectResponse);
120
121     // Report WebTiming for all frames.
122     if (loader && !request.isNull() && request.url() == loader->requestURL())
123         request.setReportLoadTiming(true);
124
125 #if ENABLE(RESOURCE_TIMING)
126     request.setReportLoadTiming(true);
127 #endif
128 }
129
130 void ResourceLoadNotifier::dispatchDidReceiveResponse(DocumentLoader* loader, unsigned long identifier, const ResourceResponse& r, ResourceLoader* resourceLoader)
131 {
132     InspectorInstrumentationCookie cookie = InspectorInstrumentation::willReceiveResourceResponse(m_frame, identifier, r);
133     m_frame->loader()->client()->dispatchDidReceiveResponse(loader, identifier, r);
134     InspectorInstrumentation::didReceiveResourceResponse(cookie, identifier, loader, r, resourceLoader);
135 }
136
137 void ResourceLoadNotifier::dispatchDidReceiveData(DocumentLoader* loader, unsigned long identifier, const char* data, int dataLength, int encodedDataLength)
138 {
139     m_frame->loader()->client()->dispatchDidReceiveContentLength(loader, identifier, dataLength);
140
141     InspectorInstrumentation::didReceiveData(m_frame, identifier, data, dataLength, encodedDataLength);
142 }
143
144 void ResourceLoadNotifier::dispatchDidFinishLoading(DocumentLoader* loader, unsigned long identifier, double finishTime)
145 {
146     m_frame->loader()->client()->dispatchDidFinishLoading(loader, identifier);
147
148     InspectorInstrumentation::didFinishLoading(m_frame, loader, identifier, finishTime);
149 }
150
151 void ResourceLoadNotifier::dispatchDidFailLoading(DocumentLoader* loader, unsigned long identifier, const ResourceError& error)
152 {
153     m_frame->loader()->client()->dispatchDidFailLoading(loader, identifier, error);
154
155     InspectorInstrumentation::didFailLoading(m_frame, loader, identifier, error);
156 }
157
158 void ResourceLoadNotifier::sendRemainingDelegateMessages(DocumentLoader* loader, unsigned long identifier, const ResourceRequest& request, const ResourceResponse& response, const char* data, int dataLength, int encodedDataLength, const ResourceError& error)
159 {
160     // If the request is null, willSendRequest cancelled the load. We should
161     // only dispatch didFailLoading in this case.
162     if (request.isNull()) {
163         ASSERT(error.isCancellation());
164         dispatchDidFailLoading(loader, identifier, error);
165         return;
166     }
167
168     if (!response.isNull())
169         dispatchDidReceiveResponse(loader, identifier, response);
170
171     if (dataLength > 0)
172         dispatchDidReceiveData(loader, identifier, data, dataLength, encodedDataLength);
173
174     if (error.isNull())
175         dispatchDidFinishLoading(loader, identifier, 0);
176     else
177         dispatchDidFailLoading(loader, identifier, error);
178 }
179
180 } // namespace WebCore