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