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