LayoutTests:
[WebKit-https.git] / WebCore / loader / ResourceLoader.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  *           (C) 2007 Graham Dennis (graham.dennis@gmail.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "config.h"
31 #include "ResourceLoader.h"
32
33 #include "DocumentLoader.h"
34 #include "Frame.h"
35 #include "FrameLoader.h"
36 #include "Page.h"
37 #include "ProgressTracker.h"
38 #include "ResourceHandle.h"
39 #include "ResourceError.h"
40 #include "SharedBuffer.h"
41
42 namespace WebCore {
43
44 PassRefPtr<SharedBuffer> ResourceLoader::resourceData()
45 {
46     if (m_resourceData)
47         return m_resourceData;
48
49     if (ResourceHandle::supportsBufferedData() && m_handle)
50         return m_handle->bufferedData();
51     
52     return 0;
53 }
54
55 ResourceLoader::ResourceLoader(Frame* frame)
56     : m_reachedTerminalState(false)
57     , m_cancelled(false)
58     , m_calledDidFinishLoad(false)
59     , m_frame(frame)
60     , m_documentLoader(frame->loader()->activeDocumentLoader())
61     , m_identifier(0)
62     , m_defersLoading(frame->page()->defersLoading())
63 {
64 }
65
66 ResourceLoader::~ResourceLoader()
67 {
68     ASSERT(m_reachedTerminalState);
69 }
70
71 void ResourceLoader::releaseResources()
72 {
73     ASSERT(!m_reachedTerminalState);
74     
75     // It's possible that when we release the handle, it will be
76     // deallocated and release the last reference to this object.
77     // We need to retain to avoid accessing the object after it
78     // has been deallocated and also to avoid reentering this method.
79     RefPtr<ResourceLoader> protector(this);
80
81     m_frame = 0;
82     m_documentLoader = 0;
83     
84     // We need to set reachedTerminalState to true before we release
85     // the resources to prevent a double dealloc of WebView <rdar://problem/4372628>
86     m_reachedTerminalState = true;
87
88     m_identifier = 0;
89
90     m_handle = 0;
91     m_resourceData = 0;
92     m_deferredRequest = ResourceRequest();
93 }
94
95 bool ResourceLoader::load(const ResourceRequest& r)
96 {
97     ASSERT(!m_handle);
98     ASSERT(m_deferredRequest.isNull());
99     ASSERT(!frameLoader()->isArchiveLoadPending(this));
100     
101     m_originalURL = r.url();
102     
103     ResourceRequest clientRequest(r);
104     willSendRequest(clientRequest, ResourceResponse());
105     if (clientRequest.isNull()) {
106         didFail(frameLoader()->cancelledError(r));
107         return false;
108     }
109     
110     if (frameLoader()->willUseArchive(this, clientRequest, m_originalURL))
111         return true;
112     
113     if (m_defersLoading) {
114         m_deferredRequest = clientRequest;
115         return true;
116     }
117     
118     m_handle = ResourceHandle::create(clientRequest, this, m_frame.get(), m_defersLoading);
119
120     return true;
121 }
122
123 void ResourceLoader::setDefersLoading(bool defers)
124 {
125     m_defersLoading = defers;
126     if (m_handle)
127         m_handle->setDefersLoading(defers);
128     if (!defers && !m_deferredRequest.isNull()) {
129         ResourceRequest request(m_deferredRequest);
130         m_deferredRequest = ResourceRequest();
131         load(request);
132     }
133 }
134
135 FrameLoader* ResourceLoader::frameLoader() const
136 {
137     if (!m_frame)
138         return 0;
139     return m_frame->loader();
140 }
141
142 void ResourceLoader::addData(const char* data, int length, bool allAtOnce)
143 {
144     if (allAtOnce) {
145         m_resourceData = new SharedBuffer(data, length);
146         return;
147     }
148         
149     if (ResourceHandle::supportsBufferedData()) {
150         // Buffer data only if the connection has handed us the data because is has stopped buffering it.
151         if (m_resourceData)
152             m_resourceData->append(data, length);
153     } else {
154         if (!m_resourceData)
155             m_resourceData = new SharedBuffer(data, length);
156         else
157             m_resourceData->append(data, length);
158     }
159 }
160
161 void ResourceLoader::clearResourceData()
162 {
163     m_resourceData->clear();
164 }
165
166 void ResourceLoader::willSendRequest(ResourceRequest& request, const ResourceResponse& redirectResponse)
167 {
168     // Protect this in this delegate method since the additional processing can do
169     // anything including possibly derefing this; one example of this is Radar 3266216.
170     RefPtr<ResourceLoader> protector(this);
171         
172     ASSERT(!m_reachedTerminalState);
173
174     if (!m_identifier) {
175         m_identifier = m_frame->page()->progress()->createUniqueIdentifier();
176         frameLoader()->assignIdentifierToInitialRequest(m_identifier, request);
177     }
178
179     frameLoader()->willSendRequest(this, request, redirectResponse);
180     m_request = request;
181 }
182
183 void ResourceLoader::didReceiveResponse(const ResourceResponse& r)
184 {
185     ASSERT(!m_reachedTerminalState);
186
187     // Protect this in this delegate method since the additional processing can do
188     // anything including possibly derefing this; one example of this is Radar 3266216.
189     RefPtr<ResourceLoader> protector(this);
190
191     m_response = r;
192
193     frameLoader()->didReceiveResponse(this, m_response);
194 }
195
196 void ResourceLoader::didReceiveData(const char* data, int length, long long lengthReceived, bool allAtOnce)
197 {
198     // The following assertions are not quite valid here, since a subclass
199     // might override didReceiveData in a way that invalidates them. This
200     // happens with the steps listed in 3266216
201     // ASSERT(con == connection);
202     // ASSERT(!m_reachedTerminalState);
203
204     // Protect this in this delegate method since the additional processing can do
205     // anything including possibly derefing this; one example of this is Radar 3266216.
206     RefPtr<ResourceLoader> protector(this);
207
208     addData(data, length, allAtOnce);
209     if (m_frame)
210         frameLoader()->didReceiveData(this, data, length, lengthReceived);
211 }
212
213 void ResourceLoader::willStopBufferingData(const char* data, int length)
214 {
215     ASSERT(!m_resourceData);
216     m_resourceData = new SharedBuffer(data, length);
217 }
218
219 void ResourceLoader::didFinishLoading()
220 {
221     // If load has been cancelled after finishing (which could happen with a 
222     // JavaScript that changes the window location), do nothing.
223     if (m_cancelled)
224         return;
225     ASSERT(!m_reachedTerminalState);
226
227     didFinishLoadingOnePart();
228     releaseResources();
229 }
230
231 void ResourceLoader::didFinishLoadingOnePart()
232 {
233     if (m_cancelled)
234         return;
235     ASSERT(!m_reachedTerminalState);
236
237     if (m_calledDidFinishLoad)
238         return;
239     m_calledDidFinishLoad = true;
240     frameLoader()->didFinishLoad(this);
241 }
242
243 void ResourceLoader::didFail(const ResourceError& error)
244 {
245     if (m_cancelled)
246         return;
247     ASSERT(!m_reachedTerminalState);
248
249     // Protect this in this delegate method since the additional processing can do
250     // anything including possibly derefing this; one example of this is Radar 3266216.
251     RefPtr<ResourceLoader> protector(this);
252
253     frameLoader()->didFailToLoad(this, error);
254
255     releaseResources();
256 }
257
258 void ResourceLoader::wasBlocked()
259 {
260     didFail(blockedError());
261 }
262
263 void ResourceLoader::didCancel(const ResourceError& error)
264 {
265     ASSERT(!m_cancelled);
266     ASSERT(!m_reachedTerminalState);
267
268     // This flag prevents bad behavior when loads that finish cause the
269     // load itself to be cancelled (which could happen with a javascript that 
270     // changes the window location). This is used to prevent both the body
271     // of this method and the body of connectionDidFinishLoading: running
272     // for a single delegate. Cancelling wins.
273     m_cancelled = true;
274     
275     if (m_handle)
276         m_handle->clearAuthentication();
277
278     frameLoader()->cancelPendingArchiveLoad(this);
279     if (m_handle) {
280         m_handle->cancel();
281         m_handle = 0;
282     }
283     frameLoader()->didFailToLoad(this, error);
284
285     releaseResources();
286 }
287
288 void ResourceLoader::cancel()
289 {
290     cancel(ResourceError());
291 }
292
293 void ResourceLoader::cancel(const ResourceError& error)
294 {
295     if (m_reachedTerminalState)
296         return;
297     if (!error.isNull())
298         didCancel(error);
299     else
300         didCancel(cancelledError());
301 }
302
303 const ResourceResponse& ResourceLoader::response() const
304 {
305     return m_response;
306 }
307
308 ResourceError ResourceLoader::cancelledError()
309 {
310     return frameLoader()->cancelledError(m_request);
311 }
312
313 ResourceError ResourceLoader::blockedError()
314 {
315     return frameLoader()->blockedError(m_request);
316 }
317
318 void ResourceLoader::willSendRequest(ResourceHandle*, ResourceRequest& request, const ResourceResponse& redirectResponse)
319 {
320     willSendRequest(request, redirectResponse);
321 }
322
323 void ResourceLoader::didReceiveResponse(ResourceHandle*, const ResourceResponse& response)
324 {
325     didReceiveResponse(response);
326 }
327
328 void ResourceLoader::didReceiveData(ResourceHandle*, const char* data, int length, int lengthReceived)
329 {
330     didReceiveData(data, length, lengthReceived, false);
331 }
332
333 void ResourceLoader::didFinishLoading(ResourceHandle*)
334 {
335     didFinishLoading();
336 }
337
338 void ResourceLoader::didFail(ResourceHandle*, const ResourceError& error)
339 {
340     didFail(error);
341 }
342
343 void ResourceLoader::wasBlocked(ResourceHandle*)
344 {
345     wasBlocked();
346 }
347
348 void ResourceLoader::didReceiveAuthenticationChallenge(const AuthenticationChallenge& challenge)
349 {
350     // Protect this in this delegate method since the additional processing can do
351     // anything including possibly derefing this; one example of this is Radar 3266216.
352     RefPtr<ResourceLoader> protector(this);
353     frameLoader()->didReceiveAuthenticationChallenge(this, challenge);
354 }
355
356 void ResourceLoader::didCancelAuthenticationChallenge(const AuthenticationChallenge& challenge)
357 {
358     // Protect this in this delegate method since the additional processing can do
359     // anything including possibly derefing this; one example of this is Radar 3266216.
360     RefPtr<ResourceLoader> protector(this);
361     frameLoader()->didCancelAuthenticationChallenge(this, challenge);
362 }
363
364 void ResourceLoader::receivedCancellation(const AuthenticationChallenge&)
365 {
366     cancel();
367 }
368
369 void ResourceLoader::willCacheResponse(ResourceHandle*, CacheStoragePolicy& policy)
370 {
371     // When in private browsing mode, prevent caching to disk
372     if (policy == StorageAllowed && frameLoader()->privateBrowsingEnabled())
373         policy = StorageAllowedInMemoryOnly;    
374 }
375
376 }