[chromium] Lower priority of preloaded images
[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 Computer, 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 <wtf/Forward.h>
38 #include <wtf/Vector.h>
39
40 #if PLATFORM(MAC)
41 #ifdef __OBJC__ 
42 #import <Foundation/Foundation.h>
43 typedef id RemoteAXObjectRef;
44 #else
45 typedef void* RemoteAXObjectRef;
46 #endif
47 #endif
48
49 typedef class _jobject* jobject;
50
51 #if PLATFORM(MAC) && !defined(__OBJC__)
52 class NSCachedURLResponse;
53 class NSView;
54 #endif
55
56 #if USE(V8)
57 namespace v8 {
58 class Context;
59 template<class T> class Handle;
60 }
61 #endif
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 HistoryItem;
78     class HTMLAppletElement;
79     class HTMLFormElement;
80     class HTMLFrameOwnerElement;
81 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
82     class HTMLMediaElement;
83 #endif
84     class HTMLPlugInElement;
85     class IntSize;
86     class KURL;
87     class MainResourceLoader;
88     class MessageEvent;
89     class NavigationAction;
90     class Page;
91     class ProtectionSpace;
92     class PluginView;
93     class PolicyChecker;
94     class ResourceError;
95     class ResourceHandle;
96     class ResourceLoader;
97     class ResourceRequest;
98     class ResourceResponse;
99 #if ENABLE(MEDIA_STREAM)
100     class RTCPeerConnectionHandler;
101 #endif
102     class SecurityOrigin;
103     class SharedBuffer;
104     class SocketStreamHandle;
105     class StringWithDirection;
106     class SubstituteData;
107     class Widget;
108
109     typedef void (PolicyChecker::*FramePolicyFunction)(PolicyAction);
110
111     class FrameLoaderClient {
112     public:
113         // An inline function cannot be the first non-abstract virtual function declared
114         // in the class as it results in the vtable being generated as a weak symbol.
115         // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
116         // don't want to do it in WebKit.
117         virtual bool hasHTMLView() const;
118
119         virtual ~FrameLoaderClient() { }
120
121         virtual void frameLoaderDestroyed() = 0;
122
123         virtual bool hasWebView() const = 0; // mainly for assertions
124
125         virtual void makeRepresentation(DocumentLoader*) = 0;
126         virtual void forceLayout() = 0;
127         virtual void forceLayoutForNonHTML() = 0;
128
129         virtual void setCopiesOnScroll() = 0;
130
131         virtual void detachedFromParent2() = 0;
132         virtual void detachedFromParent3() = 0;
133
134         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
135
136         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
137         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
138         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
139         virtual void dispatchDidCancelAuthenticationChallenge(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         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
144         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
145         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
146         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
147         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
148
149         virtual void dispatchDidHandleOnloadEvents() = 0;
150         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
151         virtual void dispatchDidCancelClientRedirect() = 0;
152         virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate) = 0;
153         virtual void dispatchDidNavigateWithinPage() { }
154         virtual void dispatchDidChangeLocationWithinPage() = 0;
155         virtual void dispatchDidPushStateWithinPage() = 0;
156         virtual void dispatchDidReplaceStateWithinPage() = 0;
157         virtual void dispatchDidPopStateWithinPage() = 0;
158         virtual void dispatchWillClose() = 0;
159         virtual void dispatchDidReceiveIcon() = 0;
160         virtual void dispatchDidStartProvisionalLoad() = 0;
161         virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
162         virtual void dispatchDidChangeIcons(IconType) = 0;
163         virtual void dispatchDidCommitLoad() = 0;
164         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
165         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
166         virtual void dispatchDidFinishDocumentLoad() = 0;
167         virtual void dispatchDidFinishLoad() = 0;
168
169         virtual void dispatchDidLayout() { }
170         virtual void dispatchDidLayout(LayoutMilestones) { }
171
172         virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
173         virtual void dispatchShow() = 0;
174
175         virtual void dispatchDecidePolicyForResponse(FramePolicyFunction, const ResourceResponse&, const ResourceRequest&) = 0;
176         virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName) = 0;
177         virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction, const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>) = 0;
178         virtual void cancelPolicyCheck() = 0;
179
180         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
181
182         virtual void dispatchWillRequestResource(CachedResourceRequest*) { }
183
184         virtual void dispatchWillSendSubmitEvent(PassRefPtr<FormState>) = 0;
185         virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>) = 0;
186
187         virtual void revertToProvisionalState(DocumentLoader*) = 0;
188         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
189
190         // Maybe these should go into a ProgressTrackerClient some day
191         virtual void willChangeEstimatedProgress() { }
192         virtual void didChangeEstimatedProgress() { }
193         virtual void postProgressStartedNotification() = 0;
194         virtual void postProgressEstimateChangedNotification() = 0;
195         virtual void postProgressFinishedNotification() = 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 committedLoad(DocumentLoader*, const char*, int) = 0;
205         virtual void finishedLoading(DocumentLoader*) = 0;
206         
207         virtual void updateGlobalHistory() = 0;
208         virtual void updateGlobalHistoryRedirectLinks() = 0;
209
210         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
211         virtual bool shouldStopLoadingForHistoryItem(HistoryItem*) const = 0;
212         virtual void updateGlobalHistoryItemForPage() { }
213
214         // This frame has set its opener to null, disowning it for the lifetime of the frame.
215         // See http://html.spec.whatwg.org/#dom-opener.
216         // FIXME: JSC should allow disowning opener. - <https://bugs.webkit.org/show_bug.cgi?id=103913>.
217         virtual void didDisownOpener() { }
218
219         // This frame has displayed inactive content (such as an image) from an
220         // insecure source.  Inactive content cannot spread to other frames.
221         virtual void didDisplayInsecureContent() = 0;
222
223         // The indicated security origin has run active content (such as a
224         // script) from an insecure source.  Note that the insecure content can
225         // spread to other frames in the same origin.
226         virtual void didRunInsecureContent(SecurityOrigin*, const KURL&) = 0;
227         virtual void didDetectXSS(const KURL&, bool didBlockEntirePage) = 0;
228
229         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
230         virtual ResourceError blockedError(const ResourceRequest&) = 0;
231         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
232         virtual ResourceError interruptedForPolicyChangeError(const ResourceRequest&) = 0;
233
234         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
235         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
236         virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
237
238         virtual bool shouldFallBack(const ResourceError&) = 0;
239
240         virtual bool canHandleRequest(const ResourceRequest&) const = 0;
241         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
242         virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
243         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
244         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
245
246         virtual void frameLoadCompleted() = 0;
247         virtual void saveViewStateToItem(HistoryItem*) = 0;
248         virtual void restoreViewState() = 0;
249         virtual void provisionalLoadStarted() = 0;
250         virtual void didFinishLoad() = 0;
251         virtual void prepareForDataSourceReplacement() = 0;
252
253         virtual PassRefPtr<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
254         virtual void setTitle(const StringWithDirection&, const KURL&) = 0;
255
256         virtual String userAgent(const KURL&) = 0;
257         
258         virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
259         virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
260         virtual void transitionToCommittedForNewPage() = 0;
261
262         virtual void didSaveToPageCache() = 0;
263         virtual void didRestoreFromPageCache() = 0;
264
265         virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
266
267         virtual bool canCachePage() const = 0;
268         virtual void convertMainResourceLoadToDownload(MainResourceLoader*, const ResourceRequest&, const ResourceResponse&) = 0;
269
270         virtual PassRefPtr<Frame> createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
271         virtual PassRefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
272         virtual void recreatePlugin(Widget*) = 0;
273         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
274
275         virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
276
277         virtual void dispatchDidFailToStartPlugin(const PluginView*) const { }
278 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
279         virtual PassRefPtr<Widget> createMediaPlayerProxyPlugin(const IntSize&, HTMLMediaElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&) = 0;
280         virtual void hideMediaPlayerProxyPlugin(Widget*) = 0;
281         virtual void showMediaPlayerProxyPlugin(Widget*) = 0;
282 #endif
283
284         virtual ObjectContentType objectContentType(const KURL&, const String& mimeType, bool shouldPreferPlugInsForImages) = 0;
285         virtual String overrideMediaType() const = 0;
286
287         virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld*) = 0;
288         virtual void documentElementAvailable() = 0;
289         virtual void didPerformFirstNavigation() const = 0; // "Navigation" here means a transition from one page to another that ends up in the back/forward list.
290
291         virtual void didExhaustMemoryAvailableForScript() { };
292
293 #if USE(V8)
294         virtual void didCreateScriptContext(v8::Handle<v8::Context>, int extensionGroup, int worldId) = 0;
295         virtual void willReleaseScriptContext(v8::Handle<v8::Context>, int worldId) = 0;
296         virtual bool allowScriptExtension(const String& extensionName, int extensionGroup, int worldId) = 0;
297 #endif
298
299         virtual void registerForIconNotification(bool listen = true) = 0;
300         
301 #if PLATFORM(MAC)
302         // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
303         virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
304         virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
305 #endif
306 #if PLATFORM(WIN) && USE(CFNETWORK)
307         // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
308         virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
309 #endif
310
311         virtual bool shouldUsePluginDocument(const String& /*mimeType*/) const { return false; }
312         virtual bool shouldLoadMediaElementURL(const KURL&) const { return true; }
313
314         virtual void didChangeScrollOffset() { }
315
316         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
317         virtual bool allowScriptFromSource(bool enabledPerSettings, const KURL&) { return enabledPerSettings; }
318         virtual bool allowPlugins(bool enabledPerSettings) { return enabledPerSettings; }
319         virtual bool allowImage(bool enabledPerSettings, const KURL&) { return enabledPerSettings; }
320         virtual bool allowDisplayingInsecureContent(bool enabledPerSettings, SecurityOrigin*, const KURL&) { return enabledPerSettings; }
321         virtual bool allowRunningInsecureContent(bool enabledPerSettings, SecurityOrigin*, const KURL&) { return enabledPerSettings; }
322
323         // This callback notifies the client that the frame was about to run
324         // JavaScript but did not because allowScript returned false. We
325         // have a separate callback here because there are a number of places
326         // that need to know if JavaScript is enabled but are not necessarily
327         // preparing to execute script.
328         virtual void didNotAllowScript() { }
329         // This callback is similar, but for plugins.
330         virtual void didNotAllowPlugins() { }
331
332         // Clients that generally disallow universal access can make exceptions for particular URLs.
333         virtual bool shouldForceUniversalAccessFromLocalURL(const KURL&) { return false; }
334
335         virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
336
337         virtual bool shouldPaintBrokenImage(const KURL&) const { return true; }
338
339         // Returns true if the embedder intercepted the postMessage call
340         virtual bool willCheckAndDispatchMessageEvent(SecurityOrigin* /*target*/, MessageEvent*) const { return false; }
341
342         virtual void didChangeName(const String&) { }
343
344         virtual void dispatchWillOpenSocketStream(SocketStreamHandle*) { }
345
346         virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld*) { }
347         virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
348         virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
349         virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
350
351 #if ENABLE(MEDIA_STREAM)
352         virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
353 #endif
354
355 #if ENABLE(REQUEST_AUTOCOMPLETE)
356         virtual void didRequestAutocomplete(PassRefPtr<FormState>) = 0;
357 #endif
358
359 #if ENABLE(WEBGL)
360         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
361         // Informs the embedder that a WebGL canvas inside this frame received a lost context
362         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
363         virtual void didLoseWebGLContext(int) { }
364 #endif
365
366         // If an HTML document is being loaded, informs the embedder that the document will have its <body> attached soon.
367         virtual void dispatchWillInsertBody() { }
368
369         virtual void dispatchDidChangeResourcePriority(unsigned long /*identifier*/, ResourceLoadPriority) { }
370     };
371
372 } // namespace WebCore
373
374 #endif // FrameLoaderClient_h