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