[PAL] Move SessionID into PAL
[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 <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 PAL {
61 class SessionID;
62 }
63
64 namespace WebCore {
65
66 class AuthenticationChallenge;
67 class CachedFrame;
68 class CachedResourceRequest;
69 class Color;
70 class DOMWindowExtension;
71 class DOMWrapperWorld;
72 class DocumentLoader;
73 class Element;
74 class FormState;
75 class Frame;
76 class FrameLoader;
77 class FrameNetworkingContext;
78 class HTMLAppletElement;
79 class HTMLFormElement;
80 class HTMLFrameOwnerElement;
81 class HTMLPlugInElement;
82 class HistoryItem;
83 class IntSize;
84 class MessageEvent;
85 class NavigationAction;
86 class Page;
87 class PluginViewBase;
88 class PolicyChecker;
89 class PreviewLoaderClient;
90 class ProtectionSpace;
91 class RTCPeerConnectionHandler;
92 class ResourceError;
93 class ResourceHandle;
94 class ResourceRequest;
95 class ResourceResponse;
96 class SecurityOrigin;
97 class SharedBuffer;
98 class SubstituteData;
99 class URL;
100 class Widget;
101
102 struct StringWithDirection;
103
104 typedef WTF::Function<void (PolicyAction)> FramePolicyFunction;
105
106 class WEBCORE_EXPORT FrameLoaderClient {
107 public:
108     // An inline function cannot be the first non-abstract virtual function declared
109     // in the class as it results in the vtable being generated as a weak symbol.
110     // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
111     // don't want to do it in WebKit.
112     virtual bool hasHTMLView() const;
113
114     virtual ~FrameLoaderClient() { }
115
116     virtual void frameLoaderDestroyed() = 0;
117
118     virtual bool hasWebView() const = 0; // mainly for assertions
119
120     virtual void makeRepresentation(DocumentLoader*) = 0;
121     
122 #if PLATFORM(IOS)
123     // Returns true if the client forced the layout.
124     virtual bool forceLayoutOnRestoreFromPageCache() = 0;
125 #endif
126     virtual void forceLayoutForNonHTML() = 0;
127
128     virtual void setCopiesOnScroll() = 0;
129
130     virtual void detachedFromParent2() = 0;
131     virtual void detachedFromParent3() = 0;
132
133     virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
134
135     virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
136     virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
137     virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
138 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
139     virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
140 #endif
141
142 #if PLATFORM(IOS)
143     virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
144 #endif
145
146     virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
147     virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
148     virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
149     virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
150     virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
151
152     virtual void dispatchDidDispatchOnloadEvents() = 0;
153     virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
154     virtual void dispatchDidChangeProvisionalURL() { }
155     virtual void dispatchDidCancelClientRedirect() = 0;
156     virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
157     virtual void dispatchDidPerformClientRedirect() { }
158     virtual void dispatchDidChangeMainDocument() { }
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() { }
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&, FormState*, const String& frameName, FramePolicyFunction&&) = 0;
185     virtual void dispatchDecidePolicyForNavigationAction(const NavigationAction&, const ResourceRequest&, bool didReceiveRedirectResponse, FormState*, FramePolicyFunction&&) = 0;
186     virtual void cancelPolicyCheck() = 0;
187
188     virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
189
190     virtual void dispatchWillSendSubmitEvent(Ref<FormState>&&) = 0;
191     virtual void dispatchWillSubmitForm(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 String overrideContentSecurityPolicy() const { return String(); }
265     
266     virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
267     virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
268 #if PLATFORM(IOS)
269     virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
270 #endif
271     virtual void transitionToCommittedForNewPage() = 0;
272
273     virtual void didSaveToPageCache() = 0;
274     virtual void didRestoreFromPageCache() = 0;
275
276     virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
277
278     virtual bool canCachePage() const = 0;
279     virtual void convertMainResourceLoadToDownload(DocumentLoader*, PAL::SessionID, const ResourceRequest&, const ResourceResponse&) = 0;
280
281     virtual RefPtr<Frame> createFrame(const URL&, const String& name, HTMLFrameOwnerElement&, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
282     virtual RefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement&, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
283     virtual void recreatePlugin(Widget*) = 0;
284     virtual void redirectDataToPlugin(Widget&) = 0;
285
286     virtual RefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement&, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
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() { }
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
302 #if PLATFORM(WIN) && USE(CFURLCONNECTION)
303     // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
304     virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
305 #endif
306
307     virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
308     virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
309
310     virtual void didChangeScrollOffset() { }
311
312     virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
313
314     // Clients that generally disallow universal access can make exceptions for particular URLs.
315     virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
316
317     virtual Ref<FrameNetworkingContext> createNetworkingContext() = 0;
318
319     virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
320
321     virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
322     virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
323     virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
324     virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
325
326 #if ENABLE(WEB_RTC)
327     virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
328 #endif
329
330 #if ENABLE(WEBGL)
331     virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
332     // Informs the embedder that a WebGL canvas inside this frame received a lost context
333     // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
334     virtual void didLoseWebGLContext(int) { }
335     virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
336     virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
337 #endif
338
339     virtual void forcePageTransitionIfNeeded() { }
340
341     // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
342     virtual bool isEmptyFrameLoaderClient() { return false; }
343
344 #if USE(QUICK_LOOK)
345     virtual RefPtr<PreviewLoaderClient> createPreviewLoaderClient(const String&, const String&) = 0;
346 #endif
347
348 #if ENABLE(CONTENT_FILTERING)
349     virtual void contentFilterDidBlockLoad(ContentFilterUnblockHandler) { }
350 #endif
351
352     virtual void prefetchDNS(const String&) = 0;
353
354     virtual void didRestoreScrollPosition() { }
355
356     virtual void getLoadDecisionForIcons(const Vector<std::pair<WebCore::LinkIcon&, uint64_t>>&) { }
357     virtual void finishedLoadingIcon(uint64_t, SharedBuffer*) { }
358 };
359
360 } // namespace WebCore