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