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