Unreviewed, rolling out r135172.
[WebKit-https.git] / Source / WebCore / loader / DocumentLoader.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
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 "DocumentLoader.h"
32
33 #include "ApplicationCacheHost.h"
34 #include "ArchiveResourceCollection.h"
35 #include "CachedPage.h"
36 #include "CachedResourceLoader.h"
37 #include "DOMWindow.h"
38 #include "Document.h"
39 #include "DocumentParser.h"
40 #include "DocumentWriter.h"
41 #include "Event.h"
42 #include "Frame.h"
43 #include "FrameLoader.h"
44 #include "FrameLoaderClient.h"
45 #include "FrameTree.h"
46 #include "HistoryItem.h"
47 #include "InspectorInstrumentation.h"
48 #include "Logging.h"
49 #include "MainResourceLoader.h"
50 #include "Page.h"
51 #include "ResourceBuffer.h"
52 #include "Settings.h"
53 #include "TextResourceDecoder.h"
54 #include "WebCoreMemoryInstrumentation.h"
55 #include <wtf/Assertions.h>
56 #include <wtf/MemoryInstrumentationHashMap.h>
57 #include <wtf/MemoryInstrumentationHashSet.h>
58 #include <wtf/MemoryInstrumentationVector.h>
59 #include <wtf/text/CString.h>
60 #include <wtf/text/WTFString.h>
61 #include <wtf/unicode/Unicode.h>
62
63 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
64 #include "ArchiveFactory.h"
65 #endif
66
67 namespace WebCore {
68
69 static void cancelAll(const ResourceLoaderSet& loaders)
70 {
71     Vector<RefPtr<ResourceLoader> > loadersCopy;
72     copyToVector(loaders, loadersCopy);
73     size_t size = loadersCopy.size();
74     for (size_t i = 0; i < size; ++i)
75         loadersCopy[i]->cancel();
76 }
77
78 static void setAllDefersLoading(const ResourceLoaderSet& loaders, bool defers)
79 {
80     Vector<RefPtr<ResourceLoader> > loadersCopy;
81     copyToVector(loaders, loadersCopy);
82     size_t size = loadersCopy.size();
83     for (size_t i = 0; i < size; ++i)
84         loadersCopy[i]->setDefersLoading(defers);
85 }
86
87 DocumentLoader::DocumentLoader(const ResourceRequest& req, const SubstituteData& substituteData)
88     : m_deferMainResourceDataLoad(true)
89     , m_frame(0)
90     , m_cachedResourceLoader(CachedResourceLoader::create(this))
91     , m_writer(m_frame)
92     , m_originalRequest(req)
93     , m_substituteData(substituteData)
94     , m_originalRequestCopy(req)
95     , m_request(req)
96     , m_committed(false)
97     , m_isStopping(false)
98     , m_gotFirstByte(false)
99     , m_isClientRedirect(false)
100     , m_wasOnloadHandled(false)
101     , m_stopRecordingResponses(false)
102     , m_substituteResourceDeliveryTimer(this, &DocumentLoader::substituteResourceDeliveryTimerFired)
103     , m_didCreateGlobalHistoryEntry(false)
104     , m_applicationCacheHost(adoptPtr(new ApplicationCacheHost(this)))
105 {
106 }
107
108 FrameLoader* DocumentLoader::frameLoader() const
109 {
110     if (!m_frame)
111         return 0;
112     return m_frame->loader();
113 }
114
115 DocumentLoader::~DocumentLoader()
116 {
117     ASSERT(!m_frame || frameLoader()->activeDocumentLoader() != this || !frameLoader()->isLoading());
118     if (m_iconLoadDecisionCallback)
119         m_iconLoadDecisionCallback->invalidate();
120     if (m_iconDataCallback)
121         m_iconDataCallback->invalidate();
122     m_cachedResourceLoader->clearDocumentLoader();
123 }
124
125 PassRefPtr<ResourceBuffer> DocumentLoader::mainResourceData() const
126 {
127     if (m_mainResourceData)
128         return m_mainResourceData;
129     if (m_mainResourceLoader)
130         return m_mainResourceLoader->resourceData();
131     return 0;
132 }
133
134 const ResourceRequest& DocumentLoader::originalRequest() const
135 {
136     return m_originalRequest;
137 }
138
139 const ResourceRequest& DocumentLoader::originalRequestCopy() const
140 {
141     return m_originalRequestCopy;
142 }
143
144 const ResourceRequest& DocumentLoader::request() const
145 {
146     return m_request;
147 }
148
149 ResourceRequest& DocumentLoader::request()
150 {
151     return m_request;
152 }
153
154 const KURL& DocumentLoader::url() const
155 {
156     return request().url();
157 }
158
159 void DocumentLoader::replaceRequestURLForSameDocumentNavigation(const KURL& url)
160 {
161     m_originalRequestCopy.setURL(url);
162     m_request.setURL(url);
163 }
164
165 void DocumentLoader::setRequest(const ResourceRequest& req)
166 {
167     // Replacing an unreachable URL with alternate content looks like a server-side
168     // redirect at this point, but we can replace a committed dataSource.
169     bool handlingUnreachableURL = false;
170
171     handlingUnreachableURL = m_substituteData.isValid() && !m_substituteData.failingURL().isEmpty();
172
173     if (handlingUnreachableURL)
174         m_committed = false;
175
176     // We should never be getting a redirect callback after the data
177     // source is committed, except in the unreachable URL case. It 
178     // would be a WebFoundation bug if it sent a redirect callback after commit.
179     ASSERT(!m_committed);
180
181     KURL oldURL = m_request.url();
182     m_request = req;
183
184     // Only dispatchDidReceiveServerRedirectForProvisionalLoad() if URL changed (and is non-null).
185     // Also, don't send it when replacing unreachable URLs with alternate content.
186     if (!handlingUnreachableURL && !req.url().isNull() && oldURL != req.url())
187         frameLoader()->client()->dispatchDidReceiveServerRedirectForProvisionalLoad();
188 }
189
190 void DocumentLoader::setMainDocumentError(const ResourceError& error)
191 {
192     m_mainDocumentError = error;    
193     frameLoader()->client()->setMainDocumentError(this, error);
194 }
195
196 void DocumentLoader::mainReceivedError(const ResourceError& error)
197 {
198     ASSERT(!error.isNull());
199
200     m_applicationCacheHost->failedLoadingMainResource();
201
202     if (!frameLoader())
203         return;
204     setMainDocumentError(error);
205     clearMainResourceLoader();
206     frameLoader()->receivedMainResourceError(error);
207 }
208
209 // Cancels the data source's pending loads.  Conceptually, a data source only loads
210 // one document at a time, but one document may have many related resources. 
211 // stopLoading will stop all loads initiated by the data source, 
212 // but not loads initiated by child frames' data sources -- that's the WebFrame's job.
213 void DocumentLoader::stopLoading()
214 {
215     // In some rare cases, calling FrameLoader::stopLoading could cause isLoading() to return false.
216     // (This can happen when there's a single XMLHttpRequest currently loading and stopLoading causes it
217     // to stop loading. Because of this, we need to save it so we don't return early.
218     bool loading = isLoading();
219     
220     if (m_committed) {
221         // Attempt to stop the frame if the document loader is loading, or if it is done loading but
222         // still  parsing. Failure to do so can cause a world leak.
223         Document* doc = m_frame->document();
224         
225         if (loading || doc->parsing())
226             m_frame->loader()->stopLoading(UnloadEventPolicyNone);
227     }
228
229     // Always cancel multipart loaders
230     cancelAll(m_multipartSubresourceLoaders);
231
232     // Appcache uses ResourceHandle directly, DocumentLoader doesn't count these loads.
233     m_applicationCacheHost->stopLoadingInFrame(m_frame);
234     
235 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
236     clearArchiveResources();
237 #endif
238
239     if (!loading) {
240         // If something above restarted loading we might run into mysterious crashes like 
241         // https://bugs.webkit.org/show_bug.cgi?id=62764 and <rdar://problem/9328684>
242         ASSERT(!isLoading());
243         return;
244     }
245
246     // We might run in to infinite recursion if we're stopping loading as the result of 
247     // detaching from the frame, so break out of that recursion here.
248     // See <rdar://problem/9673866> for more details.
249     if (m_isStopping)
250         return;
251     
252     RefPtr<Frame> protectFrame(m_frame);
253     RefPtr<DocumentLoader> protectLoader(this);
254
255     m_isStopping = true;
256
257     FrameLoader* frameLoader = DocumentLoader::frameLoader();
258     
259     if (m_mainResourceLoader)
260         // Stop the main resource loader and let it send the cancelled message.
261         m_mainResourceLoader->cancel();
262     else if (!m_subresourceLoaders.isEmpty())
263         // The main resource loader already finished loading. Set the cancelled error on the 
264         // document and let the subresourceLoaders send individual cancelled messages below.
265         setMainDocumentError(frameLoader->cancelledError(m_request));
266     else
267         // If there are no resource loaders, we need to manufacture a cancelled message.
268         // (A back/forward navigation has no resource loaders because its resources are cached.)
269         mainReceivedError(frameLoader->cancelledError(m_request));
270     
271     stopLoadingSubresources();
272     stopLoadingPlugIns();
273     
274     m_isStopping = false;
275 }
276
277 void DocumentLoader::commitIfReady()
278 {
279     if (!m_committed) {
280         m_committed = true;
281         frameLoader()->commitProvisionalLoad();
282     }
283 }
284
285 void DocumentLoader::finishedLoading()
286 {
287     commitIfReady();
288     if (!frameLoader() || frameLoader()->stateMachine()->creatingInitialEmptyDocument())
289         return;
290
291     if (!maybeCreateArchive()) {
292         // If this is an empty document, it will not have actually been created yet. Commit dummy data so that
293         // DocumentWriter::begin() gets called and creates the Document.
294         if (!m_gotFirstByte)
295             commitData(0, 0);
296         frameLoader()->client()->finishedLoading(this);
297     }
298
299     m_writer.end();
300     if (!m_mainDocumentError.isNull())
301         return;
302     clearMainResourceLoader();
303     frameLoader()->checkLoadComplete();
304 }
305
306 void DocumentLoader::commitLoad(const char* data, int length)
307 {
308     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
309     // by starting a new load, so retain temporarily.
310     RefPtr<Frame> protectFrame(m_frame);
311     RefPtr<DocumentLoader> protectLoader(this);
312
313     commitIfReady();
314     FrameLoader* frameLoader = DocumentLoader::frameLoader();
315     if (!frameLoader)
316         return;
317 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
318     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
319         return;
320 #endif
321     frameLoader->client()->committedLoad(this, data, length);
322 }
323
324 void DocumentLoader::commitData(const char* bytes, size_t length)
325 {
326     if (!m_gotFirstByte) {
327         m_gotFirstByte = true;
328         m_writer.begin(documentURL(), false);
329         m_writer.setDocumentWasLoadedAsPartOfNavigation();
330         
331 #if ENABLE(MHTML)
332         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
333         // relative URLs are resolved properly.
334         if (m_archive && m_archive->type() == Archive::MHTML)
335             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
336 #endif
337
338         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
339         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
340         if (!isMultipartReplacingLoad())
341             frameLoader()->receivedFirstData();
342
343         bool userChosen = true;
344         String encoding = overrideEncoding();
345         if (encoding.isNull()) {
346             userChosen = false;
347             encoding = response().textEncodingName();
348 #if ENABLE(WEB_ARCHIVE)
349             if (m_archive && m_archive->type() == Archive::WebArchive)
350                 encoding = m_archive->mainResource()->textEncoding();
351 #endif
352         }
353         m_writer.setEncoding(encoding, userChosen);
354     }
355     ASSERT(m_frame->document()->parsing());
356     m_writer.addData(bytes, length);
357 }
358
359 void DocumentLoader::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
360 {
361     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::Loader);
362     info.addMember(m_frame);
363     info.addMember(m_mainResourceLoader);
364     info.addMember(m_subresourceLoaders);
365     info.addMember(m_multipartSubresourceLoaders);
366     info.addMember(m_plugInStreamLoaders);
367     info.addMember(m_substituteData);
368     info.addMember(m_pageTitle.string());
369     info.addMember(m_overrideEncoding);
370     info.addMember(m_responses);
371     info.addMember(m_originalRequest);
372     info.addMember(m_originalRequestCopy);
373     info.addMember(m_request);
374     info.addMember(m_response);
375     info.addMember(m_lastCheckedRequest);
376     info.addMember(m_responses);
377     info.addMember(m_pendingSubstituteResources);
378     info.addMember(m_resourcesClientKnowsAbout);
379     info.addMember(m_resourcesLoadedFromMemoryCacheForClientNotification);
380     info.addMember(m_clientRedirectSourceForHistory);
381     info.addMember(m_mainResourceData);
382 }
383
384 void DocumentLoader::receivedData(const char* data, int length)
385 {
386     if (!isMultipartReplacingLoad())
387         commitLoad(data, length);
388 }
389
390 void DocumentLoader::setupForReplace()
391 {
392     if (!mainResourceData())
393         return;
394     
395     maybeFinishLoadingMultipartContent();
396     maybeCreateArchive();
397     m_writer.end();
398     frameLoader()->setReplacing();
399     m_gotFirstByte = false;
400     
401     stopLoadingSubresources();
402     stopLoadingPlugIns();
403 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
404     clearArchiveResources();
405 #endif
406 }
407
408 void DocumentLoader::checkLoadComplete()
409 {
410     if (!m_frame || isLoading())
411         return;
412     ASSERT(this == frameLoader()->activeDocumentLoader());
413     m_frame->document()->domWindow()->finishedLoading();
414 }
415
416 void DocumentLoader::setFrame(Frame* frame)
417 {
418     if (m_frame == frame)
419         return;
420     ASSERT(frame && !m_frame);
421     m_frame = frame;
422     m_writer.setFrame(frame);
423     attachToFrame();
424 }
425
426 void DocumentLoader::attachToFrame()
427 {
428     ASSERT(m_frame);
429 }
430
431 void DocumentLoader::detachFromFrame()
432 {
433     ASSERT(m_frame);
434     RefPtr<Frame> protectFrame(m_frame);
435     RefPtr<DocumentLoader> protectLoader(this);
436
437     // It never makes sense to have a document loader that is detached from its
438     // frame have any loads active, so go ahead and kill all the loads.
439     stopLoading();
440
441     m_applicationCacheHost->setDOMApplicationCache(0);
442     InspectorInstrumentation::loaderDetachedFromFrame(m_frame, this);
443     m_frame = 0;
444 }
445
446 void DocumentLoader::clearMainResourceLoader()
447 {
448     if (m_mainResourceLoader) {
449         m_mainResourceData = m_mainResourceLoader->resourceData();
450         m_mainResourceLoader = 0;
451     }
452
453     if (this == frameLoader()->activeDocumentLoader())
454         checkLoadComplete();
455 }
456
457 bool DocumentLoader::isLoadingInAPISense() const
458 {
459     // Once a frame has loaded, we no longer need to consider subresources,
460     // but we still need to consider subframes.
461     if (frameLoader()->state() != FrameStateComplete) {
462         if (m_frame->settings()->needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
463             return true;
464     
465         Document* doc = m_frame->document();
466         if ((m_mainResourceLoader || !m_frame->document()->loadEventFinished()) && isLoading())
467             return true;
468         if (m_cachedResourceLoader->requestCount())
469             return true;
470         if (DocumentParser* parser = doc->parser())
471             if (parser->processingData())
472                 return true;
473     }
474     return frameLoader()->subframeIsLoading();
475 }
476
477 bool DocumentLoader::maybeCreateArchive()
478 {
479 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
480     return false;
481 #else
482     
483     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
484     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
485     m_archive = ArchiveFactory::create(m_response.url(), mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0, m_response.mimeType());
486     if (!m_archive)
487         return false;
488     
489     addAllArchiveResources(m_archive.get());
490     ArchiveResource* mainResource = m_archive->mainResource();
491     m_parsedArchiveData = mainResource->data();
492     m_writer.setMIMEType(mainResource->mimeType());
493     
494     ASSERT(m_frame->document());
495     commitData(mainResource->data()->data(), mainResource->data()->size());
496     return true;
497 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
498 }
499
500 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
501 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
502 {
503     m_archive = archive;
504     addAllArchiveResources(m_archive.get());
505 }
506
507 void DocumentLoader::addAllArchiveResources(Archive* archive)
508 {
509     if (!m_archiveResourceCollection)
510         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
511         
512     ASSERT(archive);
513     if (!archive)
514         return;
515         
516     m_archiveResourceCollection->addAllResources(archive);
517 }
518
519 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
520 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
521 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
522 {
523     if (!m_archiveResourceCollection)
524         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
525         
526     ASSERT(resource);
527     if (!resource)
528         return;
529         
530     m_archiveResourceCollection->addResource(resource);
531 }
532
533 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const KURL& url)
534 {
535     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
536 }
537
538 void DocumentLoader::clearArchiveResources()
539 {
540     m_archiveResourceCollection.clear();
541     m_substituteResourceDeliveryTimer.stop();
542 }
543
544 SharedBuffer* DocumentLoader::parsedArchiveData() const
545 {
546     return m_parsedArchiveData.get();
547 }
548 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
549
550 ArchiveResource* DocumentLoader::archiveResourceForURL(const KURL& url) const
551 {
552     if (!m_archiveResourceCollection)
553         return 0;
554         
555     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
556
557     return resource && !resource->shouldIgnoreWhenUnarchiving() ? resource : 0;
558 }
559
560 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
561 {
562     const ResourceResponse& r = response();
563     
564     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
565     RefPtr<SharedBuffer> data = mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0;
566     if (!data)
567         data = SharedBuffer::create();
568         
569     return ArchiveResource::create(data, r.url(), r.mimeType(), r.textEncodingName(), frame()->tree()->uniqueName());
570 }
571
572 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const KURL& url) const
573 {
574     if (!isCommitted())
575         return 0;
576     
577     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
578     if (!resource || !resource->isLoaded())
579         return archiveResourceForURL(url);
580
581     // FIXME: This has the side effect of making the resource non-purgeable.
582     // It would be better if it didn't have this permanent effect.
583     if (!resource->makePurgeable(false))
584         return 0;
585
586     ResourceBuffer* data = resource->resourceBuffer();
587     if (!data)
588         return 0;
589
590     return ArchiveResource::create(data->sharedBuffer(), url, resource->response());
591 }
592
593 void DocumentLoader::getSubresources(Vector<PassRefPtr<ArchiveResource> >& subresources) const
594 {
595     if (!isCommitted())
596         return;
597
598     const CachedResourceLoader::DocumentResourceMap& allResources = m_cachedResourceLoader->allCachedResources();
599     CachedResourceLoader::DocumentResourceMap::const_iterator end = allResources.end();
600     for (CachedResourceLoader::DocumentResourceMap::const_iterator it = allResources.begin(); it != end; ++it) {
601         RefPtr<ArchiveResource> subresource = this->subresource(KURL(ParsedURLString, it->value->url()));
602         if (subresource)
603             subresources.append(subresource.release());
604     }
605
606     return;
607 }
608
609 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
610 {
611     if (m_pendingSubstituteResources.isEmpty())
612         return;
613     ASSERT(m_frame && m_frame->page());
614     if (m_frame->page()->defersLoading())
615         return;
616     if (!m_substituteResourceDeliveryTimer.isActive())
617         m_substituteResourceDeliveryTimer.startOneShot(0);
618 }
619
620 void DocumentLoader::substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*)
621 {
622     if (m_pendingSubstituteResources.isEmpty())
623         return;
624     ASSERT(m_frame && m_frame->page());
625     if (m_frame->page()->defersLoading())
626         return;
627
628     SubstituteResourceMap copy;
629     copy.swap(m_pendingSubstituteResources);
630
631     SubstituteResourceMap::const_iterator end = copy.end();
632     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
633         RefPtr<ResourceLoader> loader = it->key;
634         SubstituteResource* resource = it->value.get();
635         
636         if (resource) {
637             SharedBuffer* data = resource->data();
638         
639             loader->didReceiveResponse(resource->response());
640
641             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
642             // so we need to check if the loader has reached its terminal state.
643             if (loader->reachedTerminalState())
644                 return;
645
646             loader->didReceiveData(data->data(), data->size(), data->size(), true);
647
648             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
649             // so we need to check if the loader has reached its terminal state.
650             if (loader->reachedTerminalState())
651                 return;
652
653             loader->didFinishLoading(0);
654         } else {
655             // A null resource means that we should fail the load.
656             // FIXME: Maybe we should use another error here - something like "not in cache".
657             loader->didFail(loader->cannotShowURLError());
658         }
659     }
660 }
661
662 #ifndef NDEBUG
663 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
664 {
665     return m_pendingSubstituteResources.contains(loader);
666 }
667 #endif
668
669 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
670 {
671     if (m_pendingSubstituteResources.isEmpty())
672         return;
673     m_pendingSubstituteResources.remove(loader);
674     if (m_pendingSubstituteResources.isEmpty())
675         m_substituteResourceDeliveryTimer.stop();
676 }
677
678 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
679 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request, const KURL& originalURL)
680 {
681     if (request.url() == originalURL) {
682         if (ArchiveResource* resource = archiveResourceForURL(originalURL)) {
683             m_pendingSubstituteResources.set(loader, resource);
684             deliverSubstituteResourcesAfterDelay();
685             return true;
686         }
687     }
688
689     if (!m_archive)
690         return false;
691
692     switch (m_archive->type()) {
693 #if ENABLE(WEB_ARCHIVE)
694     case Archive::WebArchive:
695         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
696         return m_frame->settings() && m_frame->settings()->webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
697 #endif
698 #if ENABLE(MHTML)
699     case Archive::MHTML:
700         return true; // Always fail the load for resources not included in the MHTML.
701 #endif
702     default:
703         return false;
704     }
705 }
706 #endif // ENABLE(WEB_ARCHIVE)
707
708 void DocumentLoader::addResponse(const ResourceResponse& r)
709 {
710     if (!m_stopRecordingResponses)
711         m_responses.append(r);
712 }
713
714 void DocumentLoader::stopRecordingResponses()
715 {
716     m_stopRecordingResponses = true;
717     m_responses.shrinkToFit();
718 }
719
720 void DocumentLoader::setTitle(const StringWithDirection& title)
721 {
722     if (m_pageTitle == title)
723         return;
724
725     frameLoader()->willChangeTitle(this);
726     m_pageTitle = title;
727     frameLoader()->didChangeTitle(this);
728 }
729
730 KURL DocumentLoader::urlForHistory() const
731 {
732     // Return the URL to be used for history and B/F list.
733     // Returns nil for WebDataProtocol URLs that aren't alternates 
734     // for unreachable URLs, because these can't be stored in history.
735     if (m_substituteData.isValid())
736         return unreachableURL();
737
738     return m_originalRequestCopy.url();
739 }
740
741 bool DocumentLoader::urlForHistoryReflectsFailure() const
742 {
743     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
744 }
745
746 const KURL& DocumentLoader::originalURL() const
747 {
748     return m_originalRequestCopy.url();
749 }
750
751 const KURL& DocumentLoader::requestURL() const
752 {
753     return request().url();
754 }
755
756 const KURL& DocumentLoader::responseURL() const
757 {
758     return m_response.url();
759 }
760
761 KURL DocumentLoader::documentURL() const
762 {
763     KURL url = substituteData().responseURL();
764 #if ENABLE(WEB_ARCHIVE)
765     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
766         url = m_archive->mainResource()->url();
767 #endif
768     if (url.isEmpty())
769         url = requestURL();
770     if (url.isEmpty())
771         url = responseURL();
772     if (url.isEmpty())
773         url = blankURL();
774     return url;
775 }
776
777 const String& DocumentLoader::responseMIMEType() const
778 {
779     return m_response.mimeType();
780 }
781
782 const KURL& DocumentLoader::unreachableURL() const
783 {
784     return m_substituteData.failingURL();
785 }
786
787 void DocumentLoader::setDefersLoading(bool defers)
788 {
789     if (m_mainResourceLoader)
790         m_mainResourceLoader->setDefersLoading(defers);
791     setAllDefersLoading(m_subresourceLoaders, defers);
792     setAllDefersLoading(m_plugInStreamLoaders, defers);
793     if (!defers)
794         deliverSubstituteResourcesAfterDelay();
795 }
796
797 void DocumentLoader::stopLoadingPlugIns()
798 {
799     cancelAll(m_plugInStreamLoaders);
800 }
801
802 void DocumentLoader::stopLoadingSubresources()
803 {
804     cancelAll(m_subresourceLoaders);
805 }
806
807 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
808 {
809     m_subresourceLoaders.add(loader);
810 }
811
812 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
813 {
814     m_subresourceLoaders.remove(loader);
815     checkLoadComplete();
816     if (Frame* frame = m_frame)
817         frame->loader()->checkLoadComplete();
818 }
819
820 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
821 {
822     m_plugInStreamLoaders.add(loader);
823 }
824
825 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
826 {
827     m_plugInStreamLoaders.remove(loader);
828     checkLoadComplete();
829 }
830
831 bool DocumentLoader::isLoadingMainResource() const
832 {
833     return !!m_mainResourceLoader;
834 }
835
836 bool DocumentLoader::isLoadingMultipartContent() const
837 {
838     return m_mainResourceLoader && m_mainResourceLoader->isLoadingMultipartContent();
839 }
840
841 bool DocumentLoader::isMultipartReplacingLoad() const
842 {
843     return isLoadingMultipartContent() && frameLoader()->isReplacing();
844 }
845
846 void DocumentLoader::startLoadingMainResource()
847 {
848     m_mainDocumentError = ResourceError();
849     timing()->markNavigationStart();
850     ASSERT(!m_mainResourceLoader);
851     m_mainResourceLoader = MainResourceLoader::create(m_frame);
852
853     // FIXME: Is there any way the extra fields could have not been added by now?
854     // If not, it would be great to remove this line of code.
855     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
856     m_mainResourceLoader->load(m_request, m_substituteData);
857 }
858
859 void DocumentLoader::cancelMainResourceLoad(const ResourceError& error)
860 {
861     m_mainResourceLoader->cancel(error);
862 }
863
864 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
865 {
866     m_multipartSubresourceLoaders.add(loader);
867     m_subresourceLoaders.remove(loader);
868     checkLoadComplete();
869     if (Frame* frame = m_frame)
870         frame->loader()->checkLoadComplete();    
871 }
872
873 void DocumentLoader::maybeFinishLoadingMultipartContent()
874 {
875     if (!frameLoader()->isReplacing())
876         return;
877
878     frameLoader()->setupForReplace();
879     m_committed = false;
880     RefPtr<ResourceBuffer> resourceData = mainResourceData();
881     commitLoad(resourceData->data(), resourceData->size());
882 }
883
884 void DocumentLoader::iconLoadDecisionAvailable()
885 {
886     if (m_frame)
887         m_frame->loader()->icon()->loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon()->url(), this));
888 }
889
890 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
891 {
892     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
893 }
894
895 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
896 {
897     if (m_iconLoadDecisionCallback)
898         m_iconLoadDecisionCallback->invalidate();
899     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
900     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
901 }
902
903 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
904 {
905     ASSERT(m_iconLoadDecisionCallback);
906     m_iconLoadDecisionCallback = 0;
907     if (m_frame)
908         m_frame->loader()->icon()->continueLoadWithDecision(decision);
909 }
910
911 static void iconDataCallback(SharedBuffer*, void*)
912 {
913     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
914 }
915
916 void DocumentLoader::getIconDataForIconURL(const String& urlString)
917 {   
918     if (m_iconDataCallback)
919         m_iconDataCallback->invalidate();
920     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
921     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
922 }
923
924 void DocumentLoader::handledOnloadEvents()
925 {
926     m_wasOnloadHandled = true;
927     applicationCacheHost()->stopDeferringEvents();
928 }
929
930 } // namespace WebCore