Move more of committing and starting to write a Document
[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_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     if (!maybeCreateArchive())
291         frameLoader()->client()->finishedLoading(this);
292     
293     // If this is an empty document, it will not have actually been created yet. Commit dummy data so that
294     // DocumentWriter::begin() gets called and creates the Document.
295     if (!m_gotFirstByte)
296         commitData(0, 0);
297
298     m_writer.end();
299     if (!m_mainDocumentError.isNull())
300         return;
301     clearMainResourceLoader();
302     frameLoader()->checkLoadComplete();
303 }
304
305 void DocumentLoader::commitLoad(const char* data, int length)
306 {
307     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
308     // by starting a new load, so retain temporarily.
309     RefPtr<Frame> protectFrame(m_frame);
310     RefPtr<DocumentLoader> protectLoader(this);
311
312     commitIfReady();
313     FrameLoader* frameLoader = DocumentLoader::frameLoader();
314     if (!frameLoader)
315         return;
316 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
317     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
318         return;
319 #endif
320     frameLoader->client()->committedLoad(this, data, length);
321 }
322
323 void DocumentLoader::commitData(const char* bytes, size_t length)
324 {
325     if (!m_gotFirstByte) {
326         m_gotFirstByte = true;
327         m_writer.begin(documentURL(), false);
328         m_writer.setDocumentWasLoadedAsPartOfNavigation();
329         
330 #if ENABLE(MHTML)
331         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
332         // relative URLs are resolved properly.
333         if (m_archive && m_archive->type() == Archive::MHTML)
334             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
335 #endif
336
337         frameLoader()->receivedFirstData();
338
339         bool userChosen = true;
340         String encoding = overrideEncoding();
341         if (encoding.isNull()) {
342             userChosen = false;
343             encoding = response().textEncodingName();
344         }
345         m_writer.setEncoding(encoding, userChosen);
346     }
347     ASSERT(m_frame->document()->parsing());
348     m_writer.addData(bytes, length);
349 }
350
351 bool DocumentLoader::doesProgressiveLoad(const String& MIMEType) const
352 {
353     return !frameLoader()->isReplacing() || MIMEType == "text/html";
354 }
355
356 void DocumentLoader::receivedData(const char* data, int length)
357 {
358     if (doesProgressiveLoad(m_response.mimeType()))
359         commitLoad(data, length);
360 }
361
362 void DocumentLoader::setupForReplaceByMIMEType(const String& newMIMEType)
363 {
364     if (!m_gotFirstByte)
365         return;
366     
367     String oldMIMEType = m_response.mimeType();
368     
369     if (!doesProgressiveLoad(oldMIMEType)) {
370         frameLoader()->client()->revertToProvisionalState(this);
371         setupForReplace();
372         RefPtr<SharedBuffer> resourceData = mainResourceData();
373         commitLoad(resourceData->data(), resourceData->size());
374     }
375     
376     maybeCreateArchive();
377     m_writer.end();
378     
379     frameLoader()->setReplacing();
380     m_gotFirstByte = false;
381     
382     if (doesProgressiveLoad(newMIMEType)) {
383         frameLoader()->client()->revertToProvisionalState(this);
384         setupForReplace();
385     }
386     
387     stopLoadingSubresources();
388     stopLoadingPlugIns();
389 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
390     clearArchiveResources();
391 #endif
392 }
393
394 void DocumentLoader::checkLoadComplete()
395 {
396     if (!m_frame || isLoading())
397         return;
398     ASSERT(this == frameLoader()->activeDocumentLoader());
399
400     if (DOMWindow* window = m_frame->existingDOMWindow())
401         window->finishedLoading();
402 }
403
404 void DocumentLoader::setFrame(Frame* frame)
405 {
406     if (m_frame == frame)
407         return;
408     ASSERT(frame && !m_frame);
409     m_frame = frame;
410     m_writer.setFrame(frame);
411     attachToFrame();
412 }
413
414 void DocumentLoader::attachToFrame()
415 {
416     ASSERT(m_frame);
417 }
418
419 void DocumentLoader::detachFromFrame()
420 {
421     ASSERT(m_frame);
422     RefPtr<Frame> protectFrame(m_frame);
423     RefPtr<DocumentLoader> protectLoader(this);
424
425     // It never makes sense to have a document loader that is detached from its
426     // frame have any loads active, so go ahead and kill all the loads.
427     stopLoading();
428
429     m_applicationCacheHost->setDOMApplicationCache(0);
430     InspectorInstrumentation::loaderDetachedFromFrame(m_frame, this);
431     m_frame = 0;
432 }
433
434 void DocumentLoader::clearMainResourceLoader()
435 {
436     if (m_mainResourceLoader) {
437         m_mainResourceData = m_mainResourceLoader->resourceData();
438         m_mainResourceLoader = 0;
439     }
440
441     if (this == frameLoader()->activeDocumentLoader())
442         checkLoadComplete();
443 }
444
445 bool DocumentLoader::isLoadingInAPISense() const
446 {
447     // Once a frame has loaded, we no longer need to consider subresources,
448     // but we still need to consider subframes.
449     if (frameLoader()->state() != FrameStateComplete) {
450         if (m_frame->settings()->needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
451             return true;
452     
453         Document* doc = m_frame->document();
454         if ((m_mainResourceLoader || !m_frame->document()->loadEventFinished()) && isLoading())
455             return true;
456         if (doc->cachedResourceLoader()->requestCount())
457             return true;
458         if (DocumentParser* parser = doc->parser())
459             if (parser->processingData())
460                 return true;
461     }
462     return frameLoader()->subframeIsLoading();
463 }
464
465 bool DocumentLoader::maybeCreateArchive()
466 {
467 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
468     return false;
469 #else
470     
471     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
472     m_archive = ArchiveFactory::create(m_response.url(), mainResourceData().get(), m_response.mimeType());
473     if (!m_archive)
474         return false;
475     
476     addAllArchiveResources(m_archive.get());
477     ArchiveResource* mainResource = m_archive->mainResource();
478     m_parsedArchiveData = mainResource->data();
479     m_writer.setMIMEType(mainResource->mimeType());
480     
481     ASSERT(m_frame->document());
482     commitData(mainResource->data()->data(), mainResource->data()->size());
483     return true;
484 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
485 }
486
487 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
488 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
489 {
490     m_archive = archive;
491     addAllArchiveResources(m_archive.get());
492 }
493
494 void DocumentLoader::addAllArchiveResources(Archive* archive)
495 {
496     if (!m_archiveResourceCollection)
497         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
498         
499     ASSERT(archive);
500     if (!archive)
501         return;
502         
503     m_archiveResourceCollection->addAllResources(archive);
504 }
505
506 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
507 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
508 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
509 {
510     if (!m_archiveResourceCollection)
511         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
512         
513     ASSERT(resource);
514     if (!resource)
515         return;
516         
517     m_archiveResourceCollection->addResource(resource);
518 }
519
520 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const KURL& url)
521 {
522     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
523 }
524
525 void DocumentLoader::clearArchiveResources()
526 {
527     m_archiveResourceCollection.clear();
528     m_substituteResourceDeliveryTimer.stop();
529 }
530
531 SharedBuffer* DocumentLoader::parsedArchiveData() const
532 {
533     return m_parsedArchiveData.get();
534 }
535 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
536
537 ArchiveResource* DocumentLoader::archiveResourceForURL(const KURL& url) const
538 {
539     if (!m_archiveResourceCollection)
540         return 0;
541         
542     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
543
544     return resource && !resource->shouldIgnoreWhenUnarchiving() ? resource : 0;
545 }
546
547 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
548 {
549     const ResourceResponse& r = response();
550     RefPtr<SharedBuffer> mainResourceBuffer = mainResourceData();
551     if (!mainResourceBuffer)
552         mainResourceBuffer = SharedBuffer::create();
553         
554     return ArchiveResource::create(mainResourceBuffer, r.url(), r.mimeType(), r.textEncodingName(), frame()->tree()->uniqueName());
555 }
556
557 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const KURL& url) const
558 {
559     if (!isCommitted())
560         return 0;
561     
562     CachedResource* resource = m_frame->document()->cachedResourceLoader()->cachedResource(url);
563     if (!resource || !resource->isLoaded())
564         return archiveResourceForURL(url);
565
566     // FIXME: This has the side effect of making the resource non-purgeable.
567     // It would be better if it didn't have this permanent effect.
568     if (!resource->makePurgeable(false))
569         return 0;
570
571     RefPtr<SharedBuffer> data = resource->data();
572     if (!data)
573         return 0;
574
575     return ArchiveResource::create(data.release(), url, resource->response());
576 }
577
578 void DocumentLoader::getSubresources(Vector<PassRefPtr<ArchiveResource> >& subresources) const
579 {
580     if (!isCommitted())
581         return;
582
583     Document* document = m_frame->document();
584
585     const CachedResourceLoader::DocumentResourceMap& allResources = document->cachedResourceLoader()->allCachedResources();
586     CachedResourceLoader::DocumentResourceMap::const_iterator end = allResources.end();
587     for (CachedResourceLoader::DocumentResourceMap::const_iterator it = allResources.begin(); it != end; ++it) {
588         RefPtr<ArchiveResource> subresource = this->subresource(KURL(ParsedURLString, it->second->url()));
589         if (subresource)
590             subresources.append(subresource.release());
591     }
592
593     return;
594 }
595
596 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
597 {
598     if (m_pendingSubstituteResources.isEmpty())
599         return;
600     ASSERT(m_frame && m_frame->page());
601     if (m_frame->page()->defersLoading())
602         return;
603     if (!m_substituteResourceDeliveryTimer.isActive())
604         m_substituteResourceDeliveryTimer.startOneShot(0);
605 }
606
607 void DocumentLoader::substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*)
608 {
609     if (m_pendingSubstituteResources.isEmpty())
610         return;
611     ASSERT(m_frame && m_frame->page());
612     if (m_frame->page()->defersLoading())
613         return;
614
615     SubstituteResourceMap copy;
616     copy.swap(m_pendingSubstituteResources);
617
618     SubstituteResourceMap::const_iterator end = copy.end();
619     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
620         RefPtr<ResourceLoader> loader = it->first;
621         SubstituteResource* resource = it->second.get();
622         
623         if (resource) {
624             SharedBuffer* data = resource->data();
625         
626             loader->didReceiveResponse(resource->response());
627
628             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
629             // so we need to check if the loader has reached its terminal state.
630             if (loader->reachedTerminalState())
631                 return;
632
633             loader->didReceiveData(data->data(), data->size(), data->size(), true);
634
635             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
636             // so we need to check if the loader has reached its terminal state.
637             if (loader->reachedTerminalState())
638                 return;
639
640             loader->didFinishLoading(0);
641         } else {
642             // A null resource means that we should fail the load.
643             // FIXME: Maybe we should use another error here - something like "not in cache".
644             loader->didFail(loader->cannotShowURLError());
645         }
646     }
647 }
648
649 #ifndef NDEBUG
650 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
651 {
652     return m_pendingSubstituteResources.contains(loader);
653 }
654 #endif
655
656 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
657 {
658     if (m_pendingSubstituteResources.isEmpty())
659         return;
660     m_pendingSubstituteResources.remove(loader);
661     if (m_pendingSubstituteResources.isEmpty())
662         m_substituteResourceDeliveryTimer.stop();
663 }
664
665 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
666 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request, const KURL& originalURL)
667 {
668     if (request.url() == originalURL) {
669         if (ArchiveResource* resource = archiveResourceForURL(originalURL)) {
670             m_pendingSubstituteResources.set(loader, resource);
671             deliverSubstituteResourcesAfterDelay();
672             return true;
673         }
674     }
675
676     if (!m_archive)
677         return false;
678
679     switch (m_archive->type()) {
680 #if ENABLE(WEB_ARCHIVE)
681     case Archive::WebArchive:
682         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
683         return m_frame->settings() && m_frame->settings()->webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
684 #endif
685 #if ENABLE(MHTML)
686     case Archive::MHTML:
687         return true; // Always fail the load for resources not included in the MHTML.
688 #endif
689     default:
690         return false;
691     }
692 }
693 #endif // ENABLE(WEB_ARCHIVE)
694
695 void DocumentLoader::addResponse(const ResourceResponse& r)
696 {
697     if (!m_stopRecordingResponses)
698         m_responses.append(r);
699 }
700
701 void DocumentLoader::stopRecordingResponses()
702 {
703     m_stopRecordingResponses = true;
704 }
705
706 void DocumentLoader::setTitle(const StringWithDirection& title)
707 {
708     if (title.isEmpty())
709         return;
710
711     if (m_pageTitle != title) {
712         frameLoader()->willChangeTitle(this);
713         m_pageTitle = title;
714         frameLoader()->didChangeTitle(this);
715     }
716 }
717
718 KURL DocumentLoader::urlForHistory() const
719 {
720     // Return the URL to be used for history and B/F list.
721     // Returns nil for WebDataProtocol URLs that aren't alternates 
722     // for unreachable URLs, because these can't be stored in history.
723     if (m_substituteData.isValid())
724         return unreachableURL();
725
726     return m_originalRequestCopy.url();
727 }
728
729 bool DocumentLoader::urlForHistoryReflectsFailure() const
730 {
731     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
732 }
733
734 const KURL& DocumentLoader::originalURL() const
735 {
736     return m_originalRequestCopy.url();
737 }
738
739 const KURL& DocumentLoader::requestURL() const
740 {
741     return request().url();
742 }
743
744 const KURL& DocumentLoader::responseURL() const
745 {
746     return m_response.url();
747 }
748
749 KURL DocumentLoader::documentURL() const
750 {
751     KURL url = substituteData().responseURL();
752 #if ENABLE(WEB_ARCHIVE)
753     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
754         url = m_archive->mainResource()->url();
755 #endif
756     if (url.isEmpty())
757         url = requestURL();
758     if (url.isEmpty())
759         url = responseURL();
760     if (url.isEmpty())
761         url = blankURL();
762     return url;
763 }
764
765 const String& DocumentLoader::responseMIMEType() const
766 {
767     return m_response.mimeType();
768 }
769
770 const KURL& DocumentLoader::unreachableURL() const
771 {
772     return m_substituteData.failingURL();
773 }
774
775 void DocumentLoader::setDefersLoading(bool defers)
776 {
777     if (m_mainResourceLoader)
778         m_mainResourceLoader->setDefersLoading(defers);
779     setAllDefersLoading(m_subresourceLoaders, defers);
780     setAllDefersLoading(m_plugInStreamLoaders, defers);
781     if (!defers)
782         deliverSubstituteResourcesAfterDelay();
783 }
784
785 void DocumentLoader::stopLoadingPlugIns()
786 {
787     cancelAll(m_plugInStreamLoaders);
788 }
789
790 void DocumentLoader::stopLoadingSubresources()
791 {
792     cancelAll(m_subresourceLoaders);
793 }
794
795 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
796 {
797     m_subresourceLoaders.add(loader);
798 }
799
800 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
801 {
802     m_subresourceLoaders.remove(loader);
803     checkLoadComplete();
804     if (Frame* frame = m_frame)
805         frame->loader()->checkLoadComplete();
806 }
807
808 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
809 {
810     m_plugInStreamLoaders.add(loader);
811 }
812
813 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
814 {
815     m_plugInStreamLoaders.remove(loader);
816     checkLoadComplete();
817 }
818
819 bool DocumentLoader::isLoadingMainResource() const
820 {
821     return !!m_mainResourceLoader;
822 }
823
824 bool DocumentLoader::isLoadingMultipartContent() const
825 {
826     return m_mainResourceLoader && m_mainResourceLoader->isLoadingMultipartContent();
827 }
828
829 void DocumentLoader::startLoadingMainResource()
830 {
831     m_mainDocumentError = ResourceError();
832     timing()->markNavigationStart(m_frame);
833     ASSERT(!m_mainResourceLoader);
834     m_mainResourceLoader = MainResourceLoader::create(m_frame);
835
836     // FIXME: Is there any way the extra fields could have not been added by now?
837     // If not, it would be great to remove this line of code.
838     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
839     
840     // Protect MainResourceLoader::load() method chain from clearMainResourceLoader() stomping m_mainResourceLoader.
841     RefPtr<MainResourceLoader> protectedMainResourceLoader(m_mainResourceLoader);
842     if (!protectedMainResourceLoader->load(m_request, m_substituteData)) {
843         // FIXME: If this should really be caught, we should just ASSERT this doesn't happen;
844         // should it be caught by other parts of WebKit or other parts of the app?
845         LOG_ERROR("could not create WebResourceHandle for URL %s -- should be caught by policy handler level", m_request.url().string().ascii().data());
846         m_mainResourceLoader = 0;
847         ASSERT(!isLoading());
848         checkLoadComplete();
849     }
850 }
851
852 void DocumentLoader::cancelMainResourceLoad(const ResourceError& error)
853 {
854     m_mainResourceLoader->cancel(error);
855 }
856
857 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
858 {
859     m_multipartSubresourceLoaders.add(loader);
860     m_subresourceLoaders.remove(loader);
861     checkLoadComplete();
862     if (Frame* frame = m_frame)
863         frame->loader()->checkLoadComplete();    
864 }
865
866 void DocumentLoader::maybeFinishLoadingMultipartContent()
867 {
868     if (!doesProgressiveLoad(m_response.mimeType())) {
869         frameLoader()->client()->revertToProvisionalState(this);
870         setupForReplace();
871         RefPtr<SharedBuffer> resourceData = mainResourceData();
872         commitLoad(resourceData->data(), resourceData->size());
873     }
874 }
875
876 void DocumentLoader::iconLoadDecisionAvailable()
877 {
878     if (m_frame)
879         m_frame->loader()->icon()->loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon()->url(), this));
880 }
881
882 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
883 {
884     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
885 }
886
887 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
888 {
889     if (m_iconLoadDecisionCallback)
890         m_iconLoadDecisionCallback->invalidate();
891     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
892     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
893 }
894
895 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
896 {
897     ASSERT(m_iconLoadDecisionCallback);
898     m_iconLoadDecisionCallback = 0;
899     if (m_frame)
900         m_frame->loader()->icon()->continueLoadWithDecision(decision);
901 }
902
903 static void iconDataCallback(SharedBuffer*, void*)
904 {
905     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
906 }
907
908 void DocumentLoader::getIconDataForIconURL(const String& urlString)
909 {   
910     if (m_iconDataCallback)
911         m_iconDataCallback->invalidate();
912     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
913     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
914 }
915
916 void DocumentLoader::handledOnloadEvents()
917 {
918     m_wasOnloadHandled = true;
919     applicationCacheHost()->stopDeferringEvents();
920 }
921
922 } // namespace WebCore