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