Move Archive processing to DocumentLoader, instead of FrameLoader.
[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         Archive* archive() const { return m_archive.get(); }
136         void setArchive(PassRefPtr<Archive>);
137         void addAllArchiveResources(Archive*);
138         void addArchiveResource(PassRefPtr<ArchiveResource>);
139         PassRefPtr<Archive> popArchiveForSubframe(const String& frameName, const KURL&);
140         SharedBuffer* parsedArchiveData() const;
141
142         bool scheduleArchiveLoad(ResourceLoader*, const ResourceRequest&, const KURL&);
143 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
144
145         // Return the ArchiveResource for the URL only when loading an Archive
146         ArchiveResource* archiveResourceForURL(const KURL&) const;
147
148         PassRefPtr<ArchiveResource> mainResource() const;
149
150         // Return an ArchiveResource for the URL, either creating from live data or
151         // pulling from the ArchiveResourceCollection
152         PassRefPtr<ArchiveResource> subresource(const KURL&) const;
153         void getSubresources(Vector<PassRefPtr<ArchiveResource> >&) const;
154
155
156 #ifndef NDEBUG
157         bool isSubstituteLoadPending(ResourceLoader*) const;
158 #endif
159         void cancelPendingSubstituteLoad(ResourceLoader*);   
160         
161         void addResponse(const ResourceResponse&);
162         const ResponseVector& responses() const { return m_responses; }
163
164         const NavigationAction& triggeringAction() const { return m_triggeringAction; }
165         void setTriggeringAction(const NavigationAction& action) { m_triggeringAction = action; }
166         void setOverrideEncoding(const String& encoding) { m_overrideEncoding = encoding; }
167         void setLastCheckedRequest(const ResourceRequest& request) { m_lastCheckedRequest = request; }
168         const ResourceRequest& lastCheckedRequest()  { return m_lastCheckedRequest; }
169
170         void stopRecordingResponses();
171         const StringWithDirection& title() const { return m_pageTitle; }
172
173         KURL urlForHistory() const;
174         bool urlForHistoryReflectsFailure() const;
175
176         // These accessors accommodate WebCore's somewhat fickle custom of creating history
177         // items for redirects, but only sometimes. For "source" and "destination",
178         // these accessors return the URL that would have been used if a history
179         // item were created. This allows WebKit to link history items reflecting
180         // redirects into a chain from start to finish.
181         String clientRedirectSourceForHistory() const { return m_clientRedirectSourceForHistory; } // null if no client redirect occurred.
182         String clientRedirectDestinationForHistory() const { return urlForHistory(); }
183         void setClientRedirectSourceForHistory(const String& clientRedirectSourceForHistory) { m_clientRedirectSourceForHistory = clientRedirectSourceForHistory; }
184         
185         String serverRedirectSourceForHistory() const { return urlForHistory() == url() ? String() : urlForHistory().string(); } // null if no server redirect occurred.
186         String serverRedirectDestinationForHistory() const { return url(); }
187
188         bool didCreateGlobalHistoryEntry() const { return m_didCreateGlobalHistoryEntry; }
189         void setDidCreateGlobalHistoryEntry(bool didCreateGlobalHistoryEntry) { m_didCreateGlobalHistoryEntry = didCreateGlobalHistoryEntry; }
190         
191         void setDefersLoading(bool);
192
193         void startLoadingMainResource();
194         void cancelMainResourceLoad(const ResourceError&);
195         
196         // Support iconDatabase in synchronous mode.
197         void iconLoadDecisionAvailable();
198         
199         // Support iconDatabase in asynchronous mode.
200         void continueIconLoadWithDecision(IconLoadDecision);
201         void getIconLoadDecisionForIconURL(const String&);
202         void getIconDataForIconURL(const String&);
203         
204         bool isLoadingMainResource() const;
205         bool isLoadingMultipartContent() const;
206
207         void stopLoadingPlugIns();
208         void stopLoadingSubresources();
209
210         void addSubresourceLoader(ResourceLoader*);
211         void removeSubresourceLoader(ResourceLoader*);
212         void addPlugInStreamLoader(ResourceLoader*);
213         void removePlugInStreamLoader(ResourceLoader*);
214
215         void subresourceLoaderFinishedLoadingOnePart(ResourceLoader*);
216
217         void maybeFinishLoadingMultipartContent();
218
219         void setDeferMainResourceDataLoad(bool defer) { m_deferMainResourceDataLoad = defer; }
220         bool deferMainResourceDataLoad() const { return m_deferMainResourceDataLoad; }
221         
222         void didTellClientAboutLoad(const String& url)
223         { 
224 #if !PLATFORM(MAC)
225             // Don't include data urls here, as if a lot of data is loaded
226             // that way, we hold on to the (large) url string for too long.
227             if (protocolIs(url, "data"))
228                 return;
229 #endif
230             if (!url.isEmpty())
231                 m_resourcesClientKnowsAbout.add(url);
232         }
233         bool haveToldClientAboutLoad(const String& url) { return m_resourcesClientKnowsAbout.contains(url); }
234         void recordMemoryCacheLoadForFutureClientNotification(const String& url);
235         void takeMemoryCacheLoadsForClientNotification(Vector<String>& loads);
236
237         DocumentLoadTiming* timing() { return &m_documentLoadTiming; }
238         void resetTiming() { m_documentLoadTiming = DocumentLoadTiming(); }
239
240         // The WebKit layer calls this function when it's ready for the data to
241         // actually be added to the document.
242         void commitData(const char* bytes, size_t length);
243
244         ApplicationCacheHost* applicationCacheHost() const { return m_applicationCacheHost.get(); }
245
246     protected:
247         DocumentLoader(const ResourceRequest&, const SubstituteData&);
248
249         bool m_deferMainResourceDataLoad;
250
251     private:
252         void setupForReplace();
253         void commitIfReady();
254         void setMainDocumentError(const ResourceError&);
255         void commitLoad(const char*, int);
256         bool doesProgressiveLoad(const String& MIMEType) const;
257         void checkLoadComplete();
258         void clearMainResourceLoader();
259         
260         bool maybeCreateArchive();
261 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
262         void clearArchiveResources();
263 #endif
264
265         void deliverSubstituteResourcesAfterDelay();
266         void substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*);
267                 
268         Frame* m_frame;
269
270         RefPtr<MainResourceLoader> m_mainResourceLoader;
271         ResourceLoaderSet m_subresourceLoaders;
272         ResourceLoaderSet m_multipartSubresourceLoaders;
273         ResourceLoaderSet m_plugInStreamLoaders;
274
275         RefPtr<SharedBuffer> m_mainResourceData;
276         
277         mutable DocumentWriter m_writer;
278
279         // A reference to actual request used to create the data source.
280         // This should only be used by the resourceLoadDelegate's
281         // identifierForInitialRequest:fromDatasource: method. It is
282         // not guaranteed to remain unchanged, as requests are mutable.
283         ResourceRequest m_originalRequest;   
284
285         SubstituteData m_substituteData;
286
287         // A copy of the original request used to create the data source.
288         // We have to copy the request because requests are mutable.
289         ResourceRequest m_originalRequestCopy;
290         
291         // The 'working' request. It may be mutated
292         // several times from the original request to include additional
293         // headers, cookie information, canonicalization and redirects.
294         ResourceRequest m_request;
295
296         ResourceResponse m_response;
297     
298         ResourceError m_mainDocumentError;    
299
300         bool m_committed;
301         bool m_isStopping;
302         bool m_gotFirstByte;
303         bool m_isClientRedirect;
304
305         // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
306         // and should be merged.
307         bool m_wasOnloadHandled;
308
309         StringWithDirection m_pageTitle;
310
311         String m_overrideEncoding;
312
313         // The action that triggered loading - we keep this around for the
314         // benefit of the various policy handlers.
315         NavigationAction m_triggeringAction;
316
317         // The last request that we checked click policy for - kept around
318         // so we can avoid asking again needlessly.
319         ResourceRequest m_lastCheckedRequest;
320
321         // We retain all the received responses so we can play back the
322         // WebResourceLoadDelegate messages if the item is loaded from the
323         // page cache.
324         ResponseVector m_responses;
325         bool m_stopRecordingResponses;
326         
327         typedef HashMap<RefPtr<ResourceLoader>, RefPtr<SubstituteResource> > SubstituteResourceMap;
328         SubstituteResourceMap m_pendingSubstituteResources;
329         Timer<DocumentLoader> m_substituteResourceDeliveryTimer;
330
331         OwnPtr<ArchiveResourceCollection> m_archiveResourceCollection;
332 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
333         RefPtr<Archive> m_archive;
334         RefPtr<SharedBuffer> m_parsedArchiveData;
335 #endif
336
337         HashSet<String> m_resourcesClientKnowsAbout;
338         Vector<String> m_resourcesLoadedFromMemoryCacheForClientNotification;
339         
340         String m_clientRedirectSourceForHistory;
341         bool m_didCreateGlobalHistoryEntry;
342
343         DocumentLoadTiming m_documentLoadTiming;
344     
345         RefPtr<IconLoadDecisionCallback> m_iconLoadDecisionCallback;
346         RefPtr<IconDataCallback> m_iconDataCallback;
347
348         friend class ApplicationCacheHost;  // for substitute resource delivery
349         OwnPtr<ApplicationCacheHost> m_applicationCacheHost;
350     };
351
352     inline void DocumentLoader::recordMemoryCacheLoadForFutureClientNotification(const String& url)
353     {
354         m_resourcesLoadedFromMemoryCacheForClientNotification.append(url);
355     }
356
357     inline void DocumentLoader::takeMemoryCacheLoadsForClientNotification(Vector<String>& loadsSet)
358     {
359         loadsSet.swap(m_resourcesLoadedFromMemoryCacheForClientNotification);
360         m_resourcesLoadedFromMemoryCacheForClientNotification.clear();
361     }
362
363 }
364
365 #endif // DocumentLoader_h