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