Rename didLayout(LayoutMilestones) to didReachLayoutMilestone(), and related WK2...
[WebKit-https.git] / Source / WebCore / loader / FrameLoaderClient.h
1 /*
2  * Copyright (C) 2006-2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 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 #pragma once
31
32 #include "FrameLoaderTypes.h"
33 #include "LayoutMilestones.h"
34 #include "ResourceLoadPriority.h"
35 #include <functional>
36 #include <wtf/Forward.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 #if ENABLE(CONTENT_FILTERING)
41 #include "ContentFilterUnblockHandler.h"
42 #endif
43
44 #if PLATFORM(COCOA)
45 #ifdef __OBJC__ 
46 #import <Foundation/Foundation.h>
47 typedef id RemoteAXObjectRef;
48 #else
49 typedef void* RemoteAXObjectRef;
50 #endif
51 #endif
52
53 #if PLATFORM(COCOA)
54 OBJC_CLASS NSArray;
55 OBJC_CLASS NSCachedURLResponse;
56 OBJC_CLASS NSDictionary;
57 OBJC_CLASS NSView;
58 #endif
59
60 namespace WebCore {
61
62     class AuthenticationChallenge;
63     class CachedFrame;
64     class CachedResourceRequest;
65     class Color;
66     class DOMWindowExtension;
67     class DOMWrapperWorld;
68     class DocumentLoader;
69     class Element;
70     class FormState;
71     class Frame;
72     class FrameLoader;
73     class FrameNetworkingContext;
74     class HistoryItem;
75     class HTMLAppletElement;
76     class HTMLFormElement;
77     class HTMLFrameOwnerElement;
78     class HTMLPlugInElement;
79     class IntSize;
80     class URL;
81     class MessageEvent;
82     class NavigationAction;
83     class Page;
84     class ProtectionSpace;
85     class PluginViewBase;
86     class PolicyChecker;
87     class ResourceError;
88     class ResourceHandle;
89     class ResourceRequest;
90     class ResourceResponse;
91 #if ENABLE(WEB_RTC)
92     class RTCPeerConnectionHandler;
93 #endif
94     class SecurityOrigin;
95     class SessionID;
96     class SharedBuffer;
97     class StringWithDirection;
98     class SubstituteData;
99     class Widget;
100
101 #if USE(QUICK_LOOK)
102     class QuickLookHandle;
103 #endif
104
105     typedef std::function<void (PolicyAction)> FramePolicyFunction;
106
107     class WEBCORE_EXPORT FrameLoaderClient {
108     public:
109         // An inline function cannot be the first non-abstract virtual function declared
110         // in the class as it results in the vtable being generated as a weak symbol.
111         // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
112         // don't want to do it in WebKit.
113         virtual bool hasHTMLView() const;
114
115         virtual ~FrameLoaderClient() { }
116
117         virtual void frameLoaderDestroyed() = 0;
118
119         virtual bool hasWebView() const = 0; // mainly for assertions
120
121         virtual void makeRepresentation(DocumentLoader*) = 0;
122         
123 #if PLATFORM(IOS)
124         // Returns true if the client forced the layout.
125         virtual bool forceLayoutOnRestoreFromPageCache() = 0;
126 #endif
127         virtual void forceLayoutForNonHTML() = 0;
128
129         virtual void setCopiesOnScroll() = 0;
130
131         virtual void detachedFromParent2() = 0;
132         virtual void detachedFromParent3() = 0;
133
134         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
135
136         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
137         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
138         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
139 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
140         virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
141 #endif
142
143 #if PLATFORM(IOS)
144         virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
145 #endif
146
147         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
148         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
149         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
150         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
151         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
152
153         virtual void dispatchDidDispatchOnloadEvents() = 0;
154         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
155         virtual void dispatchDidChangeProvisionalURL() { }
156         virtual void dispatchDidCancelClientRedirect() = 0;
157         virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
158         virtual void dispatchDidNavigateWithinPage() { }
159         virtual void dispatchDidChangeLocationWithinPage() = 0;
160         virtual void dispatchDidPushStateWithinPage() = 0;
161         virtual void dispatchDidReplaceStateWithinPage() = 0;
162         virtual void dispatchDidPopStateWithinPage() = 0;
163         virtual void dispatchWillClose() = 0;
164         virtual void dispatchDidReceiveIcon() = 0;
165         virtual void dispatchDidStartProvisionalLoad() = 0;
166         virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
167         virtual void dispatchDidCommitLoad() = 0;
168         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
169         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
170         virtual void dispatchDidFinishDocumentLoad() = 0;
171         virtual void dispatchDidFinishLoad() = 0;
172 #if ENABLE(DATA_DETECTION)
173         virtual void dispatchDidFinishDataDetection(NSArray *detectionResults) = 0;
174 #endif
175
176         virtual void dispatchDidLayout() { }
177         virtual void dispatchDidReachLayoutMilestone(LayoutMilestones) { }
178
179         virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
180         virtual void dispatchShow() = 0;
181
182         virtual void dispatchDecidePolicyForResponse(const ResourceResponse&, const ResourceRequest&, FramePolicyFunction) = 0;
183         virtual void dispatchDecidePolicyForNewWindowAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName, FramePolicyFunction) = 0;
184         virtual void dispatchDecidePolicyForNavigationAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, FramePolicyFunction) = 0;
185         virtual void cancelPolicyCheck() = 0;
186
187         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
188
189         virtual void dispatchWillSendSubmitEvent(PassRefPtr<FormState>) = 0;
190         virtual void dispatchWillSubmitForm(PassRefPtr<FormState>, FramePolicyFunction) = 0;
191
192         virtual void revertToProvisionalState(DocumentLoader*) = 0;
193         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
194
195         virtual void setMainFrameDocumentReady(bool) = 0;
196
197         virtual void startDownload(const ResourceRequest&, const String& suggestedName = String()) = 0;
198
199         virtual void willChangeTitle(DocumentLoader*) = 0;
200         virtual void didChangeTitle(DocumentLoader*) = 0;
201
202         virtual void willReplaceMultipartContent() = 0;
203         virtual void didReplaceMultipartContent() = 0;
204
205         virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
206         virtual void finishedLoading(DocumentLoader*) = 0;
207         
208         virtual void updateGlobalHistory() = 0;
209         virtual void updateGlobalHistoryRedirectLinks() = 0;
210
211         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
212         virtual void updateGlobalHistoryItemForPage() { }
213
214         // This frame has set its opener to null, disowning it for the lifetime of the frame.
215         // See http://html.spec.whatwg.org/#dom-opener.
216         // FIXME: JSC should allow disowning opener. - <https://bugs.webkit.org/show_bug.cgi?id=103913>.
217         virtual void didDisownOpener() { }
218
219         // This frame has displayed inactive content (such as an image) from an
220         // insecure source.  Inactive content cannot spread to other frames.
221         virtual void didDisplayInsecureContent() = 0;
222
223         // The indicated security origin has run active content (such as a
224         // script) from an insecure source.  Note that the insecure content can
225         // spread to other frames in the same origin.
226         virtual void didRunInsecureContent(SecurityOrigin*, const URL&) = 0;
227         virtual void didDetectXSS(const URL&, bool didBlockEntirePage) = 0;
228
229         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
230         virtual ResourceError blockedError(const ResourceRequest&) = 0;
231         virtual ResourceError blockedByContentBlockerError(const ResourceRequest&) = 0;
232         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
233         virtual ResourceError interruptedForPolicyChangeError(const ResourceRequest&) = 0;
234 #if ENABLE(CONTENT_FILTERING)
235         virtual ResourceError blockedByContentFilterError(const ResourceRequest&) = 0;
236 #endif
237
238         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
239         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
240         virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
241
242         virtual bool shouldFallBack(const ResourceError&) = 0;
243
244         virtual bool canHandleRequest(const ResourceRequest&) const = 0;
245         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
246         virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
247         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
248         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
249
250         virtual void frameLoadCompleted() = 0;
251         virtual void saveViewStateToItem(HistoryItem&) = 0;
252         virtual void restoreViewState() = 0;
253         virtual void provisionalLoadStarted() = 0;
254         virtual void didFinishLoad() = 0;
255         virtual void prepareForDataSourceReplacement() = 0;
256
257         virtual Ref<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
258         virtual void updateCachedDocumentLoader(DocumentLoader&) = 0;
259         virtual void setTitle(const StringWithDirection&, const URL&) = 0;
260
261         virtual String userAgent(const URL&) = 0;
262         
263         virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
264         virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
265 #if PLATFORM(IOS)
266         virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
267 #endif
268         virtual void transitionToCommittedForNewPage() = 0;
269
270         virtual void didSaveToPageCache() = 0;
271         virtual void didRestoreFromPageCache() = 0;
272
273         virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
274
275         virtual bool canCachePage() const = 0;
276         virtual void convertMainResourceLoadToDownload(DocumentLoader*, SessionID, const ResourceRequest&, const ResourceResponse&) = 0;
277
278         virtual RefPtr<Frame> createFrame(const URL&, const String& name, HTMLFrameOwnerElement*, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
279         virtual RefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
280         virtual void recreatePlugin(Widget*) = 0;
281         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
282
283         virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
284
285         virtual void dispatchDidFailToStartPlugin(const PluginViewBase*) const { }
286
287         virtual ObjectContentType objectContentType(const URL&, const String& mimeType) = 0;
288         virtual String overrideMediaType() const = 0;
289
290         virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&) = 0;
291
292         virtual void registerForIconNotification(bool listen = true) = 0;
293
294 #if PLATFORM(COCOA)
295         // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
296         virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
297         virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
298         virtual NSDictionary *dataDetectionContext() { return nullptr; }
299 #endif
300 #if PLATFORM(WIN) && USE(CFNETWORK)
301         // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
302         virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
303 #endif
304
305         virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
306         virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
307
308         virtual void didChangeScrollOffset() { }
309
310         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
311
312         // Clients that generally disallow universal access can make exceptions for particular URLs.
313         virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
314
315         virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
316
317 #if ENABLE(REQUEST_AUTOCOMPLETE)
318         virtual void didRequestAutocomplete(PassRefPtr<FormState>) = 0;
319 #endif
320
321         virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
322
323         virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
324         virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
325         virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
326         virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
327
328 #if ENABLE(WEB_RTC)
329         virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
330 #endif
331
332 #if ENABLE(WEBGL)
333         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
334         // Informs the embedder that a WebGL canvas inside this frame received a lost context
335         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
336         virtual void didLoseWebGLContext(int) { }
337         virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
338         virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
339 #endif
340
341         virtual void forcePageTransitionIfNeeded() { }
342
343         // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
344         virtual bool isEmptyFrameLoaderClient() { return false; }
345
346 #if USE(QUICK_LOOK)
347         virtual void didCreateQuickLookHandle(QuickLookHandle&) { }
348 #endif
349
350 #if ENABLE(CONTENT_FILTERING)
351         virtual void contentFilterDidBlockLoad(ContentFilterUnblockHandler) { }
352 #endif
353
354         virtual void prefetchDNS(const String&) = 0;
355
356         virtual void didRestoreScrollPosition() { }
357     };
358
359 } // namespace WebCore