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