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