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