Progress towards implementing Downloads with NETWORK_SESSION
[WebKit-https.git] / Source / WebCore / loader / FrameLoaderClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 #ifndef FrameLoaderClient_h
31 #define FrameLoaderClient_h
32
33 #include "FrameLoaderTypes.h"
34 #include "IconURL.h"
35 #include "LayoutMilestones.h"
36 #include "ResourceLoadPriority.h"
37 #include <functional>
38 #include <wtf/Forward.h>
39 #include <wtf/Vector.h>
40 #include <wtf/text/WTFString.h>
41
42 #if ENABLE(CONTENT_FILTERING)
43 #include "ContentFilterUnblockHandler.h"
44 #endif
45
46 #if PLATFORM(COCOA)
47 #ifdef __OBJC__ 
48 #import <Foundation/Foundation.h>
49 typedef id RemoteAXObjectRef;
50 #else
51 typedef void* RemoteAXObjectRef;
52 #endif
53 #endif
54
55 typedef class _jobject* jobject;
56
57 #if PLATFORM(COCOA)
58 OBJC_CLASS NSCachedURLResponse;
59 OBJC_CLASS NSView;
60 #endif
61
62 namespace WebCore {
63
64     class AuthenticationChallenge;
65     class CachedFrame;
66     class CachedResourceRequest;
67     class Color;
68     class DOMWindowExtension;
69     class DOMWrapperWorld;
70     class DocumentLoader;
71     class Element;
72     class FormState;
73     class Frame;
74     class FrameLoader;
75     class FrameNetworkingContext;
76     class HistoryItem;
77     class HTMLAppletElement;
78     class HTMLFormElement;
79     class HTMLFrameOwnerElement;
80     class HTMLPlugInElement;
81     class IntSize;
82     class URL;
83     class MessageEvent;
84     class NavigationAction;
85     class Page;
86     class ProtectionSpace;
87     class PluginViewBase;
88     class PolicyChecker;
89     class ResourceError;
90     class ResourceHandle;
91     class ResourceRequest;
92     class ResourceResponse;
93 #if ENABLE(MEDIA_STREAM)
94     class RTCPeerConnectionHandler;
95 #endif
96     class SecurityOrigin;
97     class SessionID;
98     class SharedBuffer;
99     class StringWithDirection;
100     class SubstituteData;
101     class Widget;
102
103 #if USE(QUICK_LOOK)
104     class QuickLookHandle;
105 #endif
106
107     typedef std::function<void (PolicyAction)> FramePolicyFunction;
108
109     class WEBCORE_EXPORT FrameLoaderClient {
110     public:
111         // An inline function cannot be the first non-abstract virtual function declared
112         // in the class as it results in the vtable being generated as a weak symbol.
113         // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
114         // don't want to do it in WebKit.
115         virtual bool hasHTMLView() const;
116
117         virtual ~FrameLoaderClient() { }
118
119         virtual void frameLoaderDestroyed() = 0;
120
121         virtual bool hasWebView() const = 0; // mainly for assertions
122
123         virtual void makeRepresentation(DocumentLoader*) = 0;
124         
125 #if PLATFORM(IOS)
126         // Returns true if the client forced the layout.
127         virtual bool forceLayoutOnRestoreFromPageCache() = 0;
128 #endif
129         virtual void forceLayoutForNonHTML() = 0;
130
131         virtual void setCopiesOnScroll() = 0;
132
133         virtual void detachedFromParent2() = 0;
134         virtual void detachedFromParent3() = 0;
135
136         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
137
138         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
139         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
140         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
141         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;        
142 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
143         virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
144 #endif
145
146 #if PLATFORM(IOS)
147         virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
148 #endif
149
150         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
151         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
152         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
153         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
154         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
155
156         virtual void dispatchDidDispatchOnloadEvents() = 0;
157         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
158         virtual void dispatchDidChangeProvisionalURL() { }
159         virtual void dispatchDidCancelClientRedirect() = 0;
160         virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
161         virtual void dispatchDidNavigateWithinPage() { }
162         virtual void dispatchDidChangeLocationWithinPage() = 0;
163         virtual void dispatchDidPushStateWithinPage() = 0;
164         virtual void dispatchDidReplaceStateWithinPage() = 0;
165         virtual void dispatchDidPopStateWithinPage() = 0;
166         virtual void dispatchWillClose() = 0;
167         virtual void dispatchDidReceiveIcon() = 0;
168         virtual void dispatchDidStartProvisionalLoad() = 0;
169         virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
170         virtual void dispatchDidChangeIcons(IconType) = 0;
171         virtual void dispatchDidCommitLoad() = 0;
172         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
173         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
174         virtual void dispatchDidFinishDocumentLoad() = 0;
175         virtual void dispatchDidFinishLoad() = 0;
176
177         virtual void dispatchDidLayout() { }
178         virtual void dispatchDidLayout(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
236         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
237         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
238         virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
239
240         virtual bool shouldFallBack(const ResourceError&) = 0;
241
242         virtual bool canHandleRequest(const ResourceRequest&) const = 0;
243         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
244         virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
245         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
246         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
247
248         virtual void frameLoadCompleted() = 0;
249         virtual void saveViewStateToItem(HistoryItem*) = 0;
250         virtual void restoreViewState() = 0;
251         virtual void provisionalLoadStarted() = 0;
252         virtual void didFinishLoad() = 0;
253         virtual void prepareForDataSourceReplacement() = 0;
254
255         virtual Ref<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
256         virtual void updateCachedDocumentLoader(DocumentLoader&) = 0;
257         virtual void setTitle(const StringWithDirection&, const URL&) = 0;
258
259         virtual String userAgent(const URL&) = 0;
260         
261         virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
262         virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
263 #if PLATFORM(IOS)
264         virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
265 #endif
266         virtual void transitionToCommittedForNewPage() = 0;
267
268         virtual void didSaveToPageCache() = 0;
269         virtual void didRestoreFromPageCache() = 0;
270
271         virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
272
273         virtual bool canCachePage() const = 0;
274         virtual void convertMainResourceLoadToDownload(DocumentLoader*, SessionID, const ResourceRequest&, const ResourceResponse&) = 0;
275
276         virtual RefPtr<Frame> createFrame(const URL&, const String& name, HTMLFrameOwnerElement*, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
277         virtual RefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
278         virtual void recreatePlugin(Widget*) = 0;
279         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
280
281         virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
282
283         virtual void dispatchDidFailToStartPlugin(const PluginViewBase*) const { }
284
285         virtual ObjectContentType objectContentType(const URL&, const String& mimeType) = 0;
286         virtual String overrideMediaType() const = 0;
287
288         virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&) = 0;
289
290         virtual void registerForIconNotification(bool listen = true) = 0;
291
292 #if PLATFORM(COCOA)
293         // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
294         virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
295         virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
296 #endif
297 #if PLATFORM(WIN) && USE(CFNETWORK)
298         // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
299         virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
300 #endif
301
302         virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
303         virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
304
305         virtual void didChangeScrollOffset() { }
306
307         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
308
309         // Clients that generally disallow universal access can make exceptions for particular URLs.
310         virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
311
312         virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
313
314 #if ENABLE(REQUEST_AUTOCOMPLETE)
315         virtual void didRequestAutocomplete(PassRefPtr<FormState>) = 0;
316 #endif
317
318         virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
319
320         virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
321         virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
322         virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
323         virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
324
325 #if ENABLE(MEDIA_STREAM)
326         virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
327 #endif
328
329 #if ENABLE(WEBGL)
330         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
331         // Informs the embedder that a WebGL canvas inside this frame received a lost context
332         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
333         virtual void didLoseWebGLContext(int) { }
334         virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
335         virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
336 #endif
337
338         virtual void forcePageTransitionIfNeeded() { }
339
340         // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
341         virtual bool isEmptyFrameLoaderClient() { return false; }
342
343 #if USE(QUICK_LOOK)
344         virtual void didCreateQuickLookHandle(QuickLookHandle&) { }
345 #endif
346
347 #if ENABLE(CONTENT_FILTERING)
348         virtual void contentFilterDidBlockLoad(ContentFilterUnblockHandler) { }
349 #endif
350
351         virtual void prefetchDNS(const String&) = 0;
352     };
353
354 } // namespace WebCore
355
356 #endif // FrameLoaderClient_h