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