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