2007-07-06 Tony Chang <idealisms@gmail.com>
[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, bool sendResourceLoadCallbacks)
56     : m_reachedTerminalState(false)
57     , m_cancelled(false)
58     , m_calledDidFinishLoad(false)
59     , m_sendResourceLoadCallbacks(sendResourceLoadCallbacks)
60     , m_frame(frame)
61     , m_documentLoader(frame->loader()->activeDocumentLoader())
62     , m_identifier(0)
63     , m_defersLoading(frame->page()->defersLoading())
64 {
65 }
66
67 ResourceLoader::~ResourceLoader()
68 {
69     ASSERT(m_reachedTerminalState);
70 }
71
72 void ResourceLoader::releaseResources()
73 {
74     ASSERT(!m_reachedTerminalState);
75     
76     // It's possible that when we release the handle, it will be
77     // deallocated and release the last reference to this object.
78     // We need to retain to avoid accessing the object after it
79     // has been deallocated and also to avoid reentering this method.
80     RefPtr<ResourceLoader> protector(this);
81
82     m_frame = 0;
83     m_documentLoader = 0;
84     
85     // We need to set reachedTerminalState to true before we release
86     // the resources to prevent a double dealloc of WebView <rdar://problem/4372628>
87     m_reachedTerminalState = true;
88
89     m_identifier = 0;
90
91     m_handle = 0;
92     m_resourceData = 0;
93     m_deferredRequest = ResourceRequest();
94 }
95
96 bool ResourceLoader::load(const ResourceRequest& r)
97 {
98     ASSERT(!m_handle);
99     ASSERT(m_deferredRequest.isNull());
100     ASSERT(!frameLoader()->isArchiveLoadPending(this));
101     
102     m_originalURL = r.url();
103     
104     ResourceRequest clientRequest(r);
105     willSendRequest(clientRequest, ResourceResponse());
106     if (clientRequest.isNull()) {
107         didFail(frameLoader()->cancelledError(r));
108         return false;
109     }
110     
111     if (frameLoader()->willUseArchive(this, clientRequest, m_originalURL))
112         return true;
113     
114     if (m_defersLoading) {
115         m_deferredRequest = clientRequest;
116         return true;
117     }
118     
119     m_handle = ResourceHandle::create(clientRequest, this, m_frame.get(), m_defersLoading);
120
121     return true;
122 }
123
124 void ResourceLoader::setDefersLoading(bool defers)
125 {
126     m_defersLoading = defers;
127     if (m_handle)
128         m_handle->setDefersLoading(defers);
129     if (!defers && !m_deferredRequest.isNull()) {
130         ResourceRequest request(m_deferredRequest);
131         m_deferredRequest = ResourceRequest();
132         load(request);
133     }
134 }
135
136 FrameLoader* ResourceLoader::frameLoader() const
137 {
138     if (!m_frame)
139         return 0;
140     return m_frame->loader();
141 }
142
143 void ResourceLoader::addData(const char* data, int length, bool allAtOnce)
144 {
145     if (allAtOnce) {
146         m_resourceData = new SharedBuffer(data, length);
147         return;
148     }
149         
150     if (ResourceHandle::supportsBufferedData()) {
151         // Buffer data only if the connection has handed us the data because is has stopped buffering it.
152         if (m_resourceData)
153             m_resourceData->append(data, length);
154     } else {
155         if (!m_resourceData)
156             m_resourceData = new SharedBuffer(data, length);
157         else
158             m_resourceData->append(data, length);
159     }
160 }
161
162 void ResourceLoader::clearResourceData()
163 {
164     if (m_resourceData)
165         m_resourceData->clear();
166 }
167
168 void ResourceLoader::willSendRequest(ResourceRequest& request, const ResourceResponse& redirectResponse)
169 {
170     // Protect this in this delegate method since the additional processing can do
171     // anything including possibly derefing this; one example of this is Radar 3266216.
172     RefPtr<ResourceLoader> protector(this);
173         
174     ASSERT(!m_reachedTerminalState);
175
176     if (m_sendResourceLoadCallbacks) {
177         if (!m_identifier) {
178             m_identifier = m_frame->page()->progress()->createUniqueIdentifier();
179             frameLoader()->assignIdentifierToInitialRequest(m_identifier, request);
180         }
181
182         frameLoader()->willSendRequest(this, request, redirectResponse);
183     }
184     
185     m_request = request;
186 }
187
188 void ResourceLoader::didReceiveResponse(const ResourceResponse& r)
189 {
190     ASSERT(!m_reachedTerminalState);
191
192     // Protect this in this delegate method since the additional processing can do
193     // anything including possibly derefing this; one example of this is Radar 3266216.
194     RefPtr<ResourceLoader> protector(this);
195
196     m_response = r;
197
198     if (m_sendResourceLoadCallbacks)
199         frameLoader()->didReceiveResponse(this, m_response);
200 }
201
202 void ResourceLoader::didReceiveData(const char* data, int length, long long lengthReceived, bool allAtOnce)
203 {
204     // The following assertions are not quite valid here, since a subclass
205     // might override didReceiveData in a way that invalidates them. This
206     // happens with the steps listed in 3266216
207     // ASSERT(con == connection);
208     // ASSERT(!m_reachedTerminalState);
209
210     // Protect this in this delegate method since the additional processing can do
211     // anything including possibly derefing this; one example of this is Radar 3266216.
212     RefPtr<ResourceLoader> protector(this);
213
214     addData(data, length, allAtOnce);
215     // FIXME: If we get a resource with more than 2B bytes, this code won't do the right thing.
216     // However, with today's computers and networking speeds, this won't happen in practice.
217     // Could be an issue with a giant local file.
218     if (m_sendResourceLoadCallbacks && m_frame)
219         frameLoader()->didReceiveData(this, data, length, static_cast<int>(lengthReceived));
220 }
221
222 void ResourceLoader::willStopBufferingData(const char* data, int length)
223 {
224     ASSERT(!m_resourceData);
225     m_resourceData = new SharedBuffer(data, length);
226 }
227
228 void ResourceLoader::didFinishLoading()
229 {
230     // If load has been cancelled after finishing (which could happen with a 
231     // JavaScript that changes the window location), do nothing.
232     if (m_cancelled)
233         return;
234     ASSERT(!m_reachedTerminalState);
235
236     didFinishLoadingOnePart();
237     releaseResources();
238 }
239
240 void ResourceLoader::didFinishLoadingOnePart()
241 {
242     if (m_cancelled)
243         return;
244     ASSERT(!m_reachedTerminalState);
245
246     if (m_calledDidFinishLoad)
247         return;
248     m_calledDidFinishLoad = true;
249     if (m_sendResourceLoadCallbacks)
250         frameLoader()->didFinishLoad(this);
251 }
252
253 void ResourceLoader::didFail(const ResourceError& error)
254 {
255     if (m_cancelled)
256         return;
257     ASSERT(!m_reachedTerminalState);
258
259     // Protect this in this delegate method since the additional processing can do
260     // anything including possibly derefing this; one example of this is Radar 3266216.
261     RefPtr<ResourceLoader> protector(this);
262
263     if (m_sendResourceLoadCallbacks && !m_calledDidFinishLoad)
264         frameLoader()->didFailToLoad(this, error);
265
266     releaseResources();
267 }
268
269 void ResourceLoader::wasBlocked()
270 {
271     didFail(blockedError());
272 }
273
274 void ResourceLoader::didCancel(const ResourceError& error)
275 {
276     ASSERT(!m_cancelled);
277     ASSERT(!m_reachedTerminalState);
278
279     // This flag prevents bad behavior when loads that finish cause the
280     // load itself to be cancelled (which could happen with a javascript that 
281     // changes the window location). This is used to prevent both the body
282     // of this method and the body of connectionDidFinishLoading: running
283     // for a single delegate. Cancelling wins.
284     m_cancelled = true;
285     
286     if (m_handle)
287         m_handle->clearAuthentication();
288
289     frameLoader()->cancelPendingArchiveLoad(this);
290     if (m_handle) {
291         m_handle->cancel();
292         m_handle = 0;
293     }
294     if (m_sendResourceLoadCallbacks && !m_calledDidFinishLoad)
295         frameLoader()->didFailToLoad(this, error);
296
297     releaseResources();
298 }
299
300 void ResourceLoader::cancel()
301 {
302     cancel(ResourceError());
303 }
304
305 void ResourceLoader::cancel(const ResourceError& error)
306 {
307     if (m_reachedTerminalState)
308         return;
309     if (!error.isNull())
310         didCancel(error);
311     else
312         didCancel(cancelledError());
313 }
314
315 const ResourceResponse& ResourceLoader::response() const
316 {
317     return m_response;
318 }
319
320 ResourceError ResourceLoader::cancelledError()
321 {
322     return frameLoader()->cancelledError(m_request);
323 }
324
325 ResourceError ResourceLoader::blockedError()
326 {
327     return frameLoader()->blockedError(m_request);
328 }
329
330 void ResourceLoader::willSendRequest(ResourceHandle*, ResourceRequest& request, const ResourceResponse& redirectResponse)
331 {
332     willSendRequest(request, redirectResponse);
333 }
334
335 void ResourceLoader::didReceiveResponse(ResourceHandle*, const ResourceResponse& response)
336 {
337     didReceiveResponse(response);
338 }
339
340 void ResourceLoader::didReceiveData(ResourceHandle*, const char* data, int length, int lengthReceived)
341 {
342     didReceiveData(data, length, lengthReceived, false);
343 }
344
345 void ResourceLoader::didFinishLoading(ResourceHandle*)
346 {
347     didFinishLoading();
348 }
349
350 void ResourceLoader::didFail(ResourceHandle*, const ResourceError& error)
351 {
352     didFail(error);
353 }
354
355 void ResourceLoader::wasBlocked(ResourceHandle*)
356 {
357     wasBlocked();
358 }
359
360 void ResourceLoader::didReceiveAuthenticationChallenge(const AuthenticationChallenge& challenge)
361 {
362     // Protect this in this delegate method since the additional processing can do
363     // anything including possibly derefing this; one example of this is Radar 3266216.
364     RefPtr<ResourceLoader> protector(this);
365     frameLoader()->didReceiveAuthenticationChallenge(this, challenge);
366 }
367
368 void ResourceLoader::didCancelAuthenticationChallenge(const AuthenticationChallenge& challenge)
369 {
370     // Protect this in this delegate method since the additional processing can do
371     // anything including possibly derefing this; one example of this is Radar 3266216.
372     RefPtr<ResourceLoader> protector(this);
373     frameLoader()->didCancelAuthenticationChallenge(this, challenge);
374 }
375
376 void ResourceLoader::receivedCancellation(const AuthenticationChallenge&)
377 {
378     cancel();
379 }
380
381 void ResourceLoader::willCacheResponse(ResourceHandle*, CacheStoragePolicy& policy)
382 {
383     // When in private browsing mode, prevent caching to disk
384     if (policy == StorageAllowed && frameLoader()->privateBrowsingEnabled())
385         policy = StorageAllowedInMemoryOnly;    
386 }
387
388 }