2 * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Apple Inc. All rights reserved.
3 * Copyright (C) 2012 Google Inc. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
30 #ifndef FrameLoaderClient_h
31 #define FrameLoaderClient_h
33 #include "FrameLoaderTypes.h"
35 #include "LayoutMilestones.h"
36 #include "ResourceLoadPriority.h"
38 #include <wtf/Forward.h>
39 #include <wtf/Vector.h>
40 #include <wtf/text/WTFString.h>
42 #if ENABLE(CONTENT_FILTERING)
43 #include "ContentFilterUnblockHandler.h"
48 #import <Foundation/Foundation.h>
49 typedef id RemoteAXObjectRef;
51 typedef void* RemoteAXObjectRef;
55 typedef class _jobject* jobject;
58 OBJC_CLASS NSCachedURLResponse;
64 class AuthenticationChallenge;
66 class CachedResourceRequest;
68 class DOMWindowExtension;
69 class DOMWrapperWorld;
75 class FrameNetworkingContext;
77 class HTMLAppletElement;
78 class HTMLFormElement;
79 class HTMLFrameOwnerElement;
80 class HTMLPlugInElement;
84 class NavigationAction;
86 class ProtectionSpace;
91 class ResourceRequest;
92 class ResourceResponse;
93 #if ENABLE(MEDIA_STREAM)
94 class RTCPeerConnectionHandler;
98 class StringWithDirection;
103 class QuickLookHandle;
106 typedef std::function<void (PolicyAction)> FramePolicyFunction;
108 class WEBCORE_EXPORT FrameLoaderClient {
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;
116 virtual ~FrameLoaderClient() { }
118 virtual void frameLoaderDestroyed() = 0;
120 virtual bool hasWebView() const = 0; // mainly for assertions
122 virtual void makeRepresentation(DocumentLoader*) = 0;
125 // Returns true if the client forced the layout.
126 virtual bool forceLayoutOnRestoreFromPageCache() = 0;
128 virtual void forceLayoutForNonHTML() = 0;
130 virtual void setCopiesOnScroll() = 0;
132 virtual void detachedFromParent2() = 0;
133 virtual void detachedFromParent3() = 0;
135 virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
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 virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
141 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
142 virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
146 virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
149 virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
150 virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
151 virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
152 virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
153 virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
155 virtual void dispatchDidHandleOnloadEvents() = 0;
156 virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
157 virtual void dispatchDidChangeProvisionalURL() { }
158 virtual void dispatchDidCancelClientRedirect() = 0;
159 virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
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() = 0;
167 virtual void dispatchDidStartProvisionalLoad() = 0;
168 virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
169 virtual void dispatchDidChangeIcons(IconType) = 0;
170 virtual void dispatchDidCommitLoad() = 0;
171 virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
172 virtual void dispatchDidFailLoad(const ResourceError&) = 0;
173 virtual void dispatchDidFinishDocumentLoad() = 0;
174 virtual void dispatchDidFinishLoad() = 0;
176 virtual void dispatchDidLayout() { }
177 virtual void dispatchDidLayout(LayoutMilestones) { }
179 virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
180 virtual void dispatchShow() = 0;
182 virtual void dispatchDecidePolicyForResponse(const ResourceResponse&, const ResourceRequest&, FramePolicyFunction) = 0;
183 virtual void dispatchDecidePolicyForNewWindowAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName, FramePolicyFunction) = 0;
184 virtual void dispatchDecidePolicyForNavigationAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, FramePolicyFunction) = 0;
185 virtual void cancelPolicyCheck() = 0;
187 virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
189 virtual void dispatchWillSendSubmitEvent(PassRefPtr<FormState>) = 0;
190 virtual void dispatchWillSubmitForm(PassRefPtr<FormState>, FramePolicyFunction) = 0;
192 virtual void revertToProvisionalState(DocumentLoader*) = 0;
193 virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
195 virtual void setMainFrameDocumentReady(bool) = 0;
197 virtual void startDownload(const ResourceRequest&, const String& suggestedName = String()) = 0;
199 virtual void willChangeTitle(DocumentLoader*) = 0;
200 virtual void didChangeTitle(DocumentLoader*) = 0;
202 virtual void willReplaceMultipartContent() = 0;
203 virtual void didReplaceMultipartContent() = 0;
205 virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
206 virtual void finishedLoading(DocumentLoader*) = 0;
208 virtual void updateGlobalHistory() = 0;
209 virtual void updateGlobalHistoryRedirectLinks() = 0;
211 virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
212 virtual void updateGlobalHistoryItemForPage() { }
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() { }
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;
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 URL&) = 0;
227 virtual void didDetectXSS(const URL&, bool didBlockEntirePage) = 0;
229 virtual ResourceError cancelledError(const ResourceRequest&) = 0;
230 virtual ResourceError blockedError(const ResourceRequest&) = 0;
231 virtual ResourceError blockedByContentBlockerError(const ResourceRequest&) = 0;
232 virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
233 virtual ResourceError interruptedForPolicyChangeError(const ResourceRequest&) = 0;
235 virtual ResourceError cannotShowMIMETypeError(const ResourceResponse&) = 0;
236 virtual ResourceError fileDoesNotExistError(const ResourceResponse&) = 0;
237 virtual ResourceError pluginWillHandleLoadError(const ResourceResponse&) = 0;
239 virtual bool shouldFallBack(const ResourceError&) = 0;
241 virtual bool canHandleRequest(const ResourceRequest&) const = 0;
242 virtual bool canShowMIMEType(const String& MIMEType) const = 0;
243 virtual bool canShowMIMETypeAsHTML(const String& MIMEType) const = 0;
244 virtual bool representationExistsForURLScheme(const String& URLScheme) const = 0;
245 virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const = 0;
247 virtual void frameLoadCompleted() = 0;
248 virtual void saveViewStateToItem(HistoryItem*) = 0;
249 virtual void restoreViewState() = 0;
250 virtual void provisionalLoadStarted() = 0;
251 virtual void didFinishLoad() = 0;
252 virtual void prepareForDataSourceReplacement() = 0;
254 virtual Ref<DocumentLoader> createDocumentLoader(const ResourceRequest&, const SubstituteData&) = 0;
255 virtual void updateCachedDocumentLoader(DocumentLoader&) = 0;
256 virtual void setTitle(const StringWithDirection&, const URL&) = 0;
258 virtual String userAgent(const URL&) = 0;
260 virtual void savePlatformDataToCachedFrame(CachedFrame*) = 0;
261 virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
263 virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
265 virtual void transitionToCommittedForNewPage() = 0;
267 virtual void didSaveToPageCache() = 0;
268 virtual void didRestoreFromPageCache() = 0;
270 virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
272 virtual bool canCachePage() const = 0;
273 virtual void convertMainResourceLoadToDownload(DocumentLoader*, const ResourceRequest&, const ResourceResponse&) = 0;
275 virtual RefPtr<Frame> createFrame(const URL&, const String& name, HTMLFrameOwnerElement*, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
276 virtual RefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
277 virtual void recreatePlugin(Widget*) = 0;
278 virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
280 virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
282 virtual void dispatchDidFailToStartPlugin(const PluginViewBase*) const { }
284 virtual ObjectContentType objectContentType(const URL&, const String& mimeType, bool shouldPreferPlugInsForImages) = 0;
285 virtual String overrideMediaType() const = 0;
287 virtual void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&) = 0;
289 virtual void registerForIconNotification(bool listen = true) = 0;
292 // Allow an accessibility object to retrieve a Frame parent if there's no PlatformWidget.
293 virtual RemoteAXObjectRef accessibilityRemoteObject() = 0;
294 virtual NSCachedURLResponse* willCacheResponse(DocumentLoader*, unsigned long identifier, NSCachedURLResponse*) const = 0;
296 #if PLATFORM(WIN) && USE(CFNETWORK)
297 // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
298 virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
301 virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
302 virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
304 virtual void didChangeScrollOffset() { }
306 virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
308 // Clients that generally disallow universal access can make exceptions for particular URLs.
309 virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
311 virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
313 #if ENABLE(REQUEST_AUTOCOMPLETE)
314 virtual void didRequestAutocomplete(PassRefPtr<FormState>) = 0;
317 virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
319 virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
320 virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
321 virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
322 virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
324 #if ENABLE(MEDIA_STREAM)
325 virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
329 virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
330 // Informs the embedder that a WebGL canvas inside this frame received a lost context
331 // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
332 virtual void didLoseWebGLContext(int) { }
333 virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
334 virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
337 virtual void forcePageTransitionIfNeeded() { }
339 // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
340 virtual bool isEmptyFrameLoaderClient() { return false; }
343 virtual void didCreateQuickLookHandle(QuickLookHandle&) { }
346 #if ENABLE(CONTENT_FILTERING)
347 virtual void contentFilterDidBlockLoad(ContentFilterUnblockHandler) { }
351 } // namespace WebCore
353 #endif // FrameLoaderClient_h