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