REGRESSION (r160908): Safari doesn't draw rotated images properly first time
[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
41 #if PLATFORM(COCOA)
42 #ifdef __OBJC__ 
43 #import <Foundation/Foundation.h>
44 typedef id RemoteAXObjectRef;
45 #else
46 typedef void* RemoteAXObjectRef;
47 #endif
48 #endif
49
50 typedef class _jobject* jobject;
51
52 #if PLATFORM(COCOA)
53 OBJC_CLASS NSCachedURLResponse;
54 OBJC_CLASS NSView;
55 #endif
56
57 namespace WebCore {
58
59     class AuthenticationChallenge;
60     class CachedFrame;
61     class CachedResourceRequest;
62     class Color;
63     class DOMWindowExtension;
64     class DOMWrapperWorld;
65     class DocumentLoader;
66     class Element;
67     class FormState;
68     class Frame;
69     class FrameLoader;
70     class FrameNetworkingContext;
71     class HistoryItem;
72     class HTMLAppletElement;
73     class HTMLFormElement;
74     class HTMLFrameOwnerElement;
75 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
76     class HTMLMediaElement;
77 #endif
78     class HTMLPlugInElement;
79     class IntSize;
80     class URL;
81     class MessageEvent;
82     class NavigationAction;
83     class Page;
84     class ProtectionSpace;
85     class PluginView;
86     class PolicyChecker;
87     class ResourceError;
88     class ResourceHandle;
89     class ResourceRequest;
90     class ResourceResponse;
91 #if ENABLE(MEDIA_STREAM)
92     class RTCPeerConnectionHandler;
93 #endif
94     class SecurityOrigin;
95     class SharedBuffer;
96     class StringWithDirection;
97     class SubstituteData;
98     class Widget;
99
100 #if USE(QUICK_LOOK)
101     class QuickLookHandle;
102 #endif
103
104     typedef std::function<void (PolicyAction)> FramePolicyFunction;
105
106     class FrameLoaderClient {
107     public:
108         // An inline function cannot be the first non-abstract virtual function declared
109         // in the class as it results in the vtable being generated as a weak symbol.
110         // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
111         // don't want to do it in WebKit.
112         virtual bool hasHTMLView() const;
113
114         virtual ~FrameLoaderClient() { }
115
116         virtual void frameLoaderDestroyed() = 0;
117
118         virtual bool hasWebView() const = 0; // mainly for assertions
119
120         virtual void makeRepresentation(DocumentLoader*) = 0;
121         
122 #if PLATFORM(IOS)
123         // Returns true if the client forced the layout.
124         virtual bool forceLayoutOnRestoreFromPageCache() = 0;
125 #endif
126         virtual void forceLayoutForNonHTML() = 0;
127
128         virtual void setCopiesOnScroll() = 0;
129
130         virtual void detachedFromParent2() = 0;
131         virtual void detachedFromParent3() = 0;
132
133         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
134
135         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
136         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
137         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
138         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;        
139 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
140         virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
141 #endif
142
143 #if PLATFORM(IOS)
144         virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
145 #endif
146
147         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
148         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
149         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
150         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
151         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
152
153         virtual void dispatchDidHandleOnloadEvents() = 0;
154         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
155         virtual void dispatchDidCancelClientRedirect() = 0;
156         virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
157         virtual void dispatchDidNavigateWithinPage() { }
158         virtual void dispatchDidChangeLocationWithinPage() = 0;
159         virtual void dispatchDidPushStateWithinPage() = 0;
160         virtual void dispatchDidReplaceStateWithinPage() = 0;
161         virtual void dispatchDidPopStateWithinPage() = 0;
162         virtual void dispatchWillClose() = 0;
163         virtual void dispatchDidReceiveIcon() = 0;
164         virtual void dispatchDidStartProvisionalLoad() = 0;
165         virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
166         virtual void dispatchDidChangeIcons(IconType) = 0;
167         virtual void dispatchDidCommitLoad() = 0;
168         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
169         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
170         virtual void dispatchDidFinishDocumentLoad() = 0;
171         virtual void dispatchDidFinishLoad() = 0;
172
173         virtual void dispatchDidLayout() { }
174         virtual void dispatchDidLayout(LayoutMilestones) { }
175
176         virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
177         virtual void dispatchShow() = 0;
178
179         virtual void dispatchDecidePolicyForResponse(const ResourceResponse&, const ResourceRequest&, FramePolicyFunction) = 0;
180         virtual void dispatchDecidePolicyForNewWindowAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName, FramePolicyFunction) = 0;
181         virtual void dispatchDecidePolicyForNavigationAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, FramePolicyFunction) = 0;
182         virtual void cancelPolicyCheck() = 0;
183
184         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
185
186         virtual void dispatchWillRequestResource(CachedResourceRequest*) { }
187
188         virtual void dispatchWillSendSubmitEvent(PassRefPtr<FormState>) = 0;
189         virtual void dispatchWillSubmitForm(PassRefPtr<FormState>, FramePolicyFunction) = 0;
190
191         virtual void revertToProvisionalState(DocumentLoader*) = 0;
192         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
193
194         virtual void setMainFrameDocumentReady(bool) = 0;
195
196         virtual void startDownload(const ResourceRequest&, const String& suggestedName = String()) = 0;
197
198         virtual void willChangeTitle(DocumentLoader*) = 0;
199         virtual void didChangeTitle(DocumentLoader*) = 0;
200
201         virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
202         virtual void finishedLoading(DocumentLoader*) = 0;
203         
204         virtual void updateGlobalHistory() = 0;
205         virtual void updateGlobalHistoryRedirectLinks() = 0;
206
207         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
208         virtual void updateGlobalHistoryItemForPage() { }
209
210         // This frame has set its opener to null, disowning it for the lifetime of the frame.
211         // See http://html.spec.whatwg.org/#dom-opener.
212         // FIXME: JSC should allow disowning opener. - <https://bugs.webkit.org/show_bug.cgi?id=103913>.
213         virtual void didDisownOpener() { }
214
215         // This frame has displayed inactive content (such as an image) from an
216         // insecure source.  Inactive content cannot spread to other frames.
217         virtual void didDisplayInsecureContent() = 0;
218
219         // The indicated security origin has run active content (such as a
220         // script) from an insecure source.  Note that the insecure content can
221         // spread to other frames in the same origin.
222         virtual void didRunInsecureContent(SecurityOrigin*, const URL&) = 0;
223         virtual void didDetectXSS(const URL&, bool didBlockEntirePage) = 0;
224
225         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
226         virtual ResourceError blockedError(const ResourceRequest&) = 0;
227         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
228         virtual ResourceError interruptedForPolicyChangeError(const ResourceRequest&) = 0;
229
230         virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
231         virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
232         virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
233
234         virtual bool shouldFallBack(const ResourceError&) = 0;
235
236         virtual bool canHandleRequest(const ResourceRequest&) const = 0;
237         virtual bool canShowMIMEType(const String& MIMEType) const = 0;
238         virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
239         virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
240         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
241
242         virtual void frameLoadCompleted() = 0;
243         virtual void saveViewStateToItem(HistoryItem*) = 0;
244         virtual void restoreViewState() = 0;
245         virtual void provisionalLoadStarted() = 0;
246         virtual void didFinishLoad() = 0;
247         virtual void prepareForDataSourceReplacement() = 0;
248
249         virtual PassRefPtr<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
250         virtual void setTitle(const StringWithDirection&, const URL&) = 0;
251
252         virtual String userAgent(const URL&) = 0;
253         
254         virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
255         virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
256 #if PLATFORM(IOS)
257         virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
258 #endif
259         virtual void transitionToCommittedForNewPage() = 0;
260
261         virtual void didSaveToPageCache() = 0;
262         virtual void didRestoreFromPageCache() = 0;
263
264         virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
265
266         virtual bool canCachePage() const = 0;
267         virtual void convertMainResourceLoadToDownload(DocumentLoader*, const ResourceRequest&, const ResourceResponse&) = 0;
268
269         virtual PassRefPtr<Frame> createFrame(const URL& url, const String& name, HTMLFrameOwnerElement* ownerElement, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
270         virtual PassRefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
271         virtual void recreatePlugin(Widget*) = 0;
272         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
273
274         virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
275
276         virtual void dispatchDidFailToStartPlugin(const PluginView*) const { }
277 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
278         virtual PassRefPtr<Widget> createMediaPlayerProxyPlugin(const IntSize&, HTMLMediaElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&) = 0;
279         virtual void hideMediaPlayerProxyPlugin(Widget*) = 0;
280         virtual void showMediaPlayerProxyPlugin(Widget*) = 0;
281 #endif
282
283         virtual ObjectContentType objectContentType(const URL&, const String& mimeType, bool shouldPreferPlugInsForImages) = 0;
284         virtual String overrideMediaType() const = 0;
285
286         virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&) = 0;
287
288         virtual void registerForIconNotification(bool listen = true) = 0;
289
290 #if PLATFORM(COCOA)
291         // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
292         virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
293         virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
294 #endif
295 #if PLATFORM(WIN) && USE(CFNETWORK)
296         // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
297         virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
298 #endif
299
300         virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
301         virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
302
303         virtual void didChangeScrollOffset() { }
304
305         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
306
307         // Clients that generally disallow universal access can make exceptions for particular URLs.
308         virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
309
310         virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
311
312         virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
313
314         virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
315         virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
316         virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
317         virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
318
319 #if ENABLE(MEDIA_STREAM)
320         virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
321 #endif
322
323 #if ENABLE(WEBGL)
324         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
325         // Informs the embedder that a WebGL canvas inside this frame received a lost context
326         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
327         virtual void didLoseWebGLContext(int) { }
328         virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
329         virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
330 #endif
331
332         virtual void forcePageTransitionIfNeeded() { }
333
334         // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
335         virtual bool isEmptyFrameLoaderClient() { return false; }
336
337 #if USE(QUICK_LOOK)
338         virtual void didCreateQuickLookHandle(QuickLookHandle&) { }
339 #endif
340     };
341
342 } // namespace WebCore
343
344 #endif // FrameLoaderClient_h