Move more of committing and starting to write a Document
[WebKit-https.git] / Source / WebCore / loader / DocumentLoader.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 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 #ifndef DocumentLoader_h
31 #define DocumentLoader_h
32
33 #include "DocumentLoadTiming.h"
34 #include "DocumentWriter.h"
35 #include "IconDatabaseBase.h"
36 #include "NavigationAction.h"
37 #include "ResourceError.h"
38 #include "ResourceRequest.h"
39 #include "ResourceResponse.h"
40 #include "StringWithDirection.h"
41 #include "SubstituteData.h"
42 #include "Timer.h"
43 #include <wtf/HashSet.h>
44 #include <wtf/RefPtr.h>
45 #include <wtf/Vector.h>
46
47 namespace WebCore {
48
49     class ApplicationCacheHost;
50 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
51     class Archive;
52 #endif
53     class ArchiveResource;
54     class ArchiveResourceCollection;
55     class Frame;
56     class FrameLoader;
57     class MainResourceLoader;
58     class Page;
59     class ResourceLoader;
60     class SchedulePair;
61     class SharedBuffer;
62     class SubstituteResource;
63
64     typedef HashSet<RefPtr<ResourceLoader> > ResourceLoaderSet;
65     typedef Vector<ResourceResponse> ResponseVector;
66
67     class DocumentLoader : public RefCounted<DocumentLoader> {
68     public:
69         static PassRefPtr<DocumentLoader> create(const ResourceRequest& request, const SubstituteData& data)
70         {
71             return adoptRef(new DocumentLoader(request, data));
72         }
73         virtual ~DocumentLoader();
74
75         void setFrame(Frame*);
76         Frame* frame() const { return m_frame; }
77
78         virtual void attachToFrame();
79         virtual void detachFromFrame();
80
81         FrameLoader* frameLoader() const;
82         MainResourceLoader* mainResourceLoader() const { return m_mainResourceLoader.get(); }
83         PassRefPtr<SharedBuffer> mainResourceData() const;
84         
85         DocumentWriter* writer() const { return &m_writer; }
86
87         const ResourceRequest& originalRequest() const;
88         const ResourceRequest& originalRequestCopy() const;
89
90         const ResourceRequest& request() const;
91         ResourceRequest& request();
92         void setRequest(const ResourceRequest&);
93
94         const SubstituteData& substituteData() const { return m_substituteData; }
95
96         // FIXME: This is the same as requestURL(). We should remove one of them.
97         const KURL& url() const;
98         const KURL& unreachableURL() const;
99
100         // The URL of the document resulting from this DocumentLoader.
101         KURL documentURL() const;
102
103         const KURL& originalURL() const;
104         const KURL& requestURL() const;
105         const KURL& responseURL() const;
106         const String& responseMIMEType() const;
107
108         void replaceRequestURLForSameDocumentNavigation(const KURL&);
109         bool isStopping() const { return m_isStopping; }
110         void stopLoading();
111         void setCommitted(bool committed) { m_committed = committed; }
112         bool isCommitted() const { return m_committed; }
113         bool isLoading() const { return isLoadingMainResource() || !m_subresourceLoaders.isEmpty() || !m_plugInStreamLoaders.isEmpty(); }
114         void receivedData(const char*, int);
115         void setupForReplaceByMIMEType(const String& newMIMEType);
116         void finishedLoading();
117         const ResourceResponse& response() const { return m_response; }
118         const ResourceError& mainDocumentError() const { return m_mainDocumentError; }
119         void mainReceivedError(const ResourceError&);
120         void setResponse(const ResourceResponse& response) { m_response = response; }
121         bool isClientRedirect() const { return m_isClientRedirect; }
122         void setIsClientRedirect(bool isClientRedirect) { m_isClientRedirect = isClientRedirect; }
123         void handledOnloadEvents();
124         bool wasOnloadHandled() { return m_wasOnloadHandled; }
125         bool isLoadingInAPISense() const;
126         void setTitle(const StringWithDirection&);
127         const String& overrideEncoding() const { return m_overrideEncoding; }
128
129 #if PLATFORM(MAC)
130         void schedule(SchedulePair*);
131         void unschedule(SchedulePair*);
132 #endif
133
134 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
135         void setArchive(PassRefPtr<Archive>);
136         void addAllArchiveResources(Archive*);
137         void addArchiveResource(PassRefPtr<ArchiveResource>);
138         PassRefPtr<Archive> popArchiveForSubframe(const String& frameName, const KURL&);
139         SharedBuffer* parsedArchiveData() const;
140
141         bool scheduleArchiveLoad(ResourceLoader*, const ResourceRequest&, const KURL&);
142 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
143
144         // Return the ArchiveResource for the URL only when loading an Archive
145         ArchiveResource* archiveResourceForURL(const KURL&) const;
146
147         PassRefPtr<ArchiveResource> mainResource() const;
148
149         // Return an ArchiveResource for the URL, either creating from live data or
150         // pulling from the ArchiveResourceCollection
151         PassRefPtr<ArchiveResource> subresource(const KURL&) const;
152         void getSubresources(Vector<PassRefPtr<ArchiveResource> >&) const;
153
154
155 #ifndef NDEBUG
156         bool isSubstituteLoadPending(ResourceLoader*) const;
157 #endif
158         void cancelPendingSubstituteLoad(ResourceLoader*);   
159         
160         void addResponse(const ResourceResponse&);
161         const ResponseVector& responses() const { return m_responses; }
162
163         const NavigationAction& triggeringAction() const { return m_triggeringAction; }
164         void setTriggeringAction(const NavigationAction& action) { m_triggeringAction = action; }
165         void setOverrideEncoding(const String& encoding) { m_overrideEncoding = encoding; }
166         void setLastCheckedRequest(const ResourceRequest& request) { m_lastCheckedRequest = request; }
167         const ResourceRequest& lastCheckedRequest()  { return m_lastCheckedRequest; }
168
169         void stopRecordingResponses();
170         const StringWithDirection& title() const { return m_pageTitle; }
171
172         KURL urlForHistory() const;
173         bool urlForHistoryReflectsFailure() const;
174
175         // These accessors accommodate WebCore's somewhat fickle custom of creating history
176         // items for redirects, but only sometimes. For "source" and "destination",
177         // these accessors return the URL that would have been used if a history
178         // item were created. This allows WebKit to link history items reflecting
179         // redirects into a chain from start to finish.
180         String clientRedirectSourceForHistory() const { return m_clientRedirectSourceForHistory; } // null if no client redirect occurred.
181         String clientRedirectDestinationForHistory() const { return urlForHistory(); }
182         void setClientRedirectSourceForHistory(const String& clientRedirectSourceForHistory) { m_clientRedirectSourceForHistory = clientRedirectSourceForHistory; }
183         
184         String serverRedirectSourceForHistory() const { return urlForHistory() == url() ? String() : urlForHistory().string(); } // null if no server redirect occurred.
185         String serverRedirectDestinationForHistory() const { return url(); }
186
187         bool didCreateGlobalHistoryEntry() const { return m_didCreateGlobalHistoryEntry; }
188         void setDidCreateGlobalHistoryEntry(bool didCreateGlobalHistoryEntry) { m_didCreateGlobalHistoryEntry = didCreateGlobalHistoryEntry; }
189         
190         void setDefersLoading(bool);
191
192         void startLoadingMainResource();
193         void cancelMainResourceLoad(const ResourceError&);
194         
195         // Support iconDatabase in synchronous mode.
196         void iconLoadDecisionAvailable();
197         
198         // Support iconDatabase in asynchronous mode.
199         void continueIconLoadWithDecision(IconLoadDecision);
200         void getIconLoadDecisionForIconURL(const String&);
201         void getIconDataForIconURL(const String&);
202         
203         bool isLoadingMainResource() const;
204         bool isLoadingMultipartContent() const;
205
206         void stopLoadingPlugIns();
207         void stopLoadingSubresources();
208
209         void addSubresourceLoader(ResourceLoader*);
210         void removeSubresourceLoader(ResourceLoader*);
211         void addPlugInStreamLoader(ResourceLoader*);
212         void removePlugInStreamLoader(ResourceLoader*);
213
214         void subresourceLoaderFinishedLoadingOnePart(ResourceLoader*);
215
216         void maybeFinishLoadingMultipartContent();
217
218         void setDeferMainResourceDataLoad(bool defer) { m_deferMainResourceDataLoad = defer; }
219         bool deferMainResourceDataLoad() const { return m_deferMainResourceDataLoad; }
220         
221         void didTellClientAboutLoad(const String& url)
222         { 
223 #if !PLATFORM(MAC)
224             // Don't include data urls here, as if a lot of data is loaded
225             // that way, we hold on to the (large) url string for too long.
226             if (protocolIs(url, "data"))
227                 return;
228 #endif
229             if (!url.isEmpty())
230                 m_resourcesClientKnowsAbout.add(url);
231         }
232         bool haveToldClientAboutLoad(const String& url) { return m_resourcesClientKnowsAbout.contains(url); }
233         void recordMemoryCacheLoadForFutureClientNotification(const String& url);
234         void takeMemoryCacheLoadsForClientNotification(Vector<String>& loads);
235
236         DocumentLoadTiming* timing() { return &m_documentLoadTiming; }
237         void resetTiming() { m_documentLoadTiming = DocumentLoadTiming(); }
238
239         // The WebKit layer calls this function when it's ready for the data to
240         // actually be added to the document.
241         void commitData(const char* bytes, size_t length);
242
243         ApplicationCacheHost* applicationCacheHost() const { return m_applicationCacheHost.get(); }
244
245     protected:
246         DocumentLoader(const ResourceRequest&, const SubstituteData&);
247
248         bool m_deferMainResourceDataLoad;
249
250     private:
251         void setupForReplace();
252         void commitIfReady();
253         void setMainDocumentError(const ResourceError&);
254         void commitLoad(const char*, int);
255         bool doesProgressiveLoad(const String& MIMEType) const;
256         void checkLoadComplete();
257         void clearMainResourceLoader();
258         
259         bool maybeCreateArchive();
260 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
261         void clearArchiveResources();
262 #endif
263
264         void deliverSubstituteResourcesAfterDelay();
265         void substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*);
266                 
267         Frame* m_frame;
268
269         RefPtr<MainResourceLoader> m_mainResourceLoader;
270         ResourceLoaderSet m_subresourceLoaders;
271         ResourceLoaderSet m_multipartSubresourceLoaders;
272         ResourceLoaderSet m_plugInStreamLoaders;
273
274         RefPtr<SharedBuffer> m_mainResourceData;
275         
276         mutable DocumentWriter m_writer;
277
278         // A reference to actual request used to create the data source.
279         // This should only be used by the resourceLoadDelegate's
280         // identifierForInitialRequest:fromDatasource: method. It is
281         // not guaranteed to remain unchanged, as requests are mutable.
282         ResourceRequest m_originalRequest;   
283
284         SubstituteData m_substituteData;
285
286         // A copy of the original request used to create the data source.
287         // We have to copy the request because requests are mutable.
288         ResourceRequest m_originalRequestCopy;
289         
290         // The 'working' request. It may be mutated
291         // several times from the original request to include additional
292         // headers, cookie information, canonicalization and redirects.
293         ResourceRequest m_request;
294
295         ResourceResponse m_response;
296     
297         ResourceError m_mainDocumentError;    
298
299         bool m_committed;
300         bool m_isStopping;
301         bool m_gotFirstByte;
302         bool m_isClientRedirect;
303
304         // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
305         // and should be merged.
306         bool m_wasOnloadHandled;
307
308         StringWithDirection m_pageTitle;
309
310         String m_overrideEncoding;
311
312         // The action that triggered loading - we keep this around for the
313         // benefit of the various policy handlers.
314         NavigationAction m_triggeringAction;
315
316         // The last request that we checked click policy for - kept around
317         // so we can avoid asking again needlessly.
318         ResourceRequest m_lastCheckedRequest;
319
320         // We retain all the received responses so we can play back the
321         // WebResourceLoadDelegate messages if the item is loaded from the
322         // page cache.
323         ResponseVector m_responses;
324         bool m_stopRecordingResponses;
325         
326         typedef HashMap<RefPtr<ResourceLoader>, RefPtr<SubstituteResource> > SubstituteResourceMap;
327         SubstituteResourceMap m_pendingSubstituteResources;
328         Timer<DocumentLoader> m_substituteResourceDeliveryTimer;
329
330         OwnPtr<ArchiveResourceCollection> m_archiveResourceCollection;
331 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
332         RefPtr<Archive> m_archive;
333         RefPtr<SharedBuffer> m_parsedArchiveData;
334 #endif
335
336         HashSet<String> m_resourcesClientKnowsAbout;
337         Vector<String> m_resourcesLoadedFromMemoryCacheForClientNotification;
338         
339         String m_clientRedirectSourceForHistory;
340         bool m_didCreateGlobalHistoryEntry;
341
342         DocumentLoadTiming m_documentLoadTiming;
343     
344         RefPtr<IconLoadDecisionCallback> m_iconLoadDecisionCallback;
345         RefPtr<IconDataCallback> m_iconDataCallback;
346
347         friend class ApplicationCacheHost;  // for substitute resource delivery
348         OwnPtr<ApplicationCacheHost> m_applicationCacheHost;
349     };
350
351     inline void DocumentLoader::recordMemoryCacheLoadForFutureClientNotification(const String& url)
352     {
353         m_resourcesLoadedFromMemoryCacheForClientNotification.append(url);
354     }
355
356     inline void DocumentLoader::takeMemoryCacheLoadsForClientNotification(Vector<String>& loadsSet)
357     {
358         loadsSet.swap(m_resourcesLoadedFromMemoryCacheForClientNotification);
359         m_resourcesLoadedFromMemoryCacheForClientNotification.clear();
360     }
361
362 }
363
364 #endif // DocumentLoader_h