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 NSArray;
  59 OBJC_CLASS NSCachedURLResponse;
  60 OBJC_CLASS NSView;
  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     class HTMLPlugInElement;
  82     class IntSize;
  83     class URL;
  84     class MessageEvent;
  85     class NavigationAction;
  86     class Page;
  87     class ProtectionSpace;
  88     class PluginViewBase;
  89     class PolicyChecker;
  90     class ResourceError;
  91     class ResourceHandle;
  92     class ResourceRequest;
  93     class ResourceResponse;
  94 #if ENABLE(MEDIA_STREAM)
  95     class RTCPeerConnectionHandler;
  96 #endif
  97     class SecurityOrigin;
  98     class SessionID;
  99     class SharedBuffer;
 100     class StringWithDirection;
 101     class SubstituteData;
 102     class Widget;
 103
 104 #if USE(QUICK_LOOK)
 105     class QuickLookHandle;
 106 #endif
 107
 108     typedef std::function<void (PolicyAction)> FramePolicyFunction;
 109
 110     class WEBCORE_EXPORT FrameLoaderClient {
 111     public:
 112         // An inline function cannot be the first non-abstract virtual function declared
 113         // in the class as it results in the vtable being generated as a weak symbol.
 114         // This hurts performance (in Mac OS X at least, when loadig frameworks), so we
 115         // don't want to do it in WebKit.
 116         virtual bool hasHTMLView() const;
 117
 118         virtual ~FrameLoaderClient() { }
 119
 120         virtual void frameLoaderDestroyed() = 0;
 121
 122         virtual bool hasWebView() const = 0; // mainly for assertions
 123
 124         virtual void makeRepresentation(DocumentLoader*) = 0;
 125
 126 #if PLATFORM(IOS)
 127         // Returns true if the client forced the layout.
 128         virtual bool forceLayoutOnRestoreFromPageCache() = 0;
 129 #endif
 130         virtual void forceLayoutForNonHTML() = 0;
 131
 132         virtual void setCopiesOnScroll() = 0;
 133
 134         virtual void detachedFromParent2() = 0;
 135         virtual void detachedFromParent3() = 0;
 136
 137         virtual void assignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&) = 0;
 138
 139         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
 140         virtual bool shouldUseCredentialStorage(DocumentLoader*, unsigned long identifier) = 0;
 141         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
 142         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&) = 0;
 143 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
 144         virtual bool canAuthenticateAgainstProtectionSpace(DocumentLoader*, unsigned long identifier, const ProtectionSpace&) = 0;
 145 #endif
 146
 147 #if PLATFORM(IOS)
 148         virtual RetainPtr<CFDictionaryRef> connectionProperties(DocumentLoader*, unsigned long identifier) = 0;
 149 #endif
 150
 151         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
 152         virtual void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int dataLength) = 0;
 153         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
 154         virtual void dispatchDidFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&) = 0;
 155         virtual bool dispatchDidLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length) = 0;
 156
 157         virtual void dispatchDidDispatchOnloadEvents() = 0;
 158         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
 159         virtual void dispatchDidChangeProvisionalURL() { }
 160         virtual void dispatchDidCancelClientRedirect() = 0;
 161         virtual void dispatchWillPerformClientRedirect(const URL&, double interval, double fireDate) = 0;
 162         virtual void dispatchDidNavigateWithinPage() { }
 163         virtual void dispatchDidChangeLocationWithinPage() = 0;
 164         virtual void dispatchDidPushStateWithinPage() = 0;
 165         virtual void dispatchDidReplaceStateWithinPage() = 0;
 166         virtual void dispatchDidPopStateWithinPage() = 0;
 167         virtual void dispatchWillClose() = 0;
 168         virtual void dispatchDidReceiveIcon() = 0;
 169         virtual void dispatchDidStartProvisionalLoad() = 0;
 170         virtual void dispatchDidReceiveTitle(const StringWithDirection&) = 0;
 171         virtual void dispatchDidChangeIcons(IconType) = 0;
 172         virtual void dispatchDidCommitLoad() = 0;
 173         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
 174         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
 175         virtual void dispatchDidFinishDocumentLoad() = 0;
 176         virtual void dispatchDidFinishLoad() = 0;
 177 #if ENABLE(DATA_DETECTION)
 178         virtual void dispatchDidFinishDataDetection(NSArray *detectionResults) = 0;
 179 #endif
 180
 181         virtual void dispatchDidLayout() { }
 182         virtual void dispatchDidLayout(LayoutMilestones) { }
 183
 184         virtual Frame* dispatchCreatePage(const NavigationAction&) = 0;
 185         virtual void dispatchShow() = 0;
 186
 187         virtual void dispatchDecidePolicyForResponse(const ResourceResponse&, const ResourceRequest&, FramePolicyFunction) = 0;
 188         virtual void dispatchDecidePolicyForNewWindowAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, const String& frameName, FramePolicyFunction) = 0;
 189         virtual void dispatchDecidePolicyForNavigationAction(const NavigationAction&, const ResourceRequest&, PassRefPtr<FormState>, FramePolicyFunction) = 0;
 190         virtual void cancelPolicyCheck() = 0;
 191
 192         virtual void dispatchUnableToImplementPolicy(const ResourceError&) = 0;
 193
 194         virtual void dispatchWillSendSubmitEvent(PassRefPtr<FormState>) = 0;
 195         virtual void dispatchWillSubmitForm(PassRefPtr<FormState>, FramePolicyFunction) = 0;
 196
 197         virtual void revertToProvisionalState(DocumentLoader*) = 0;
 198         virtual void setMainDocumentError(DocumentLoader*, const ResourceError&) = 0;
 199
 200         virtual void setMainFrameDocumentReady(bool) = 0;
 201
 202         virtual void startDownload(const ResourceRequest&, const String& suggestedName = String()) = 0;
 203
 204         virtual void willChangeTitle(DocumentLoader*) = 0;
 205         virtual void didChangeTitle(DocumentLoader*) = 0;
 206
 207         virtual void willReplaceMultipartContent() = 0;
 208         virtual void didReplaceMultipartContent() = 0;
 209
 210         virtual void committedLoad(DocumentLoader*, const char*, int) = 0;
 211         virtual void finishedLoading(DocumentLoader*) = 0;
 212
 213         virtual void updateGlobalHistory() = 0;
 214         virtual void updateGlobalHistoryRedirectLinks() = 0;
 215
 216         virtual bool shouldGoToHistoryItem(HistoryItem*) const = 0;
 217         virtual void updateGlobalHistoryItemForPage() { }
 218
 219         // This frame has set its opener to null, disowning it for the lifetime of the frame.
 220         // See http://html.spec.whatwg.org/#dom-opener.
 221         // FIXME: JSC should allow disowning opener. - <https://bugs.webkit.org/show_bug.cgi?id=103913>.
 222         virtual void didDisownOpener() { }
 223
 224         // This frame has displayed inactive content (such as an image) from an
 225         // insecure source.  Inactive content cannot spread to other frames.
 226         virtual void didDisplayInsecureContent() = 0;
 227
 228         // The indicated security origin has run active content (such as a
 229         // script) from an insecure source.  Note that the insecure content can
 230         // spread to other frames in the same origin.
 231         virtual void didRunInsecureContent(SecurityOrigin*, const URL&) = 0;
 232         virtual void didDetectXSS(const URL&, bool didBlockEntirePage) = 0;
 233
 234         virtual ResourceError cancelledError(const ResourceRequest&) = 0;
 235         virtual ResourceError blockedError(const ResourceRequest&) = 0;
 236         virtual ResourceError blockedByContentBlockerError(const ResourceRequest&) = 0;
 237         virtual ResourceError cannotShowURLError(const ResourceRequest&) = 0;
 238         virtual ResourceError interruptedForPolicyChangeError(const ResourceRequest&) = 0;
 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 void savePlatformDataToCachedFrame(CachedFrame*) = 0;
 266         virtual void transitionToCommittedFromCachedFrame(CachedFrame*) = 0;
 267 #if PLATFORM(IOS)
 268         virtual void didRestoreFrameHierarchyForCachedFrame() = 0;
 269 #endif
 270         virtual void transitionToCommittedForNewPage() = 0;
 271
 272         virtual void didSaveToPageCache() = 0;
 273         virtual void didRestoreFromPageCache() = 0;
 274
 275         virtual void dispatchDidBecomeFrameset(bool) = 0; // Can change due to navigation or DOM modification.
 276
 277         virtual bool canCachePage() const = 0;
 278         virtual void convertMainResourceLoadToDownload(DocumentLoader*, SessionID, const ResourceRequest&, const ResourceResponse&) = 0;
 279
 280         virtual RefPtr<Frame> createFrame(const URL&, const String& name, HTMLFrameOwnerElement*, const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) = 0;
 281         virtual RefPtr<Widget> createPlugin(const IntSize&, HTMLPlugInElement*, const URL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually) = 0;
 282         virtual void recreatePlugin(Widget*) = 0;
 283         virtual void redirectDataToPlugin(Widget* pluginWidget) = 0;
 284
 285         virtual PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const URL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
 286
 287         virtual void dispatchDidFailToStartPlugin(const PluginViewBase*) const { }
 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(bool listen = true) = 0;
 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 #endif
 301 #if PLATFORM(WIN) && USE(CFNETWORK)
 302         // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
 303         virtual bool shouldCacheResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&, const unsigned char* data, unsigned long long length) = 0;
 304 #endif
 305
 306         virtual bool shouldAlwaysUsePluginDocument(const String& /*mimeType*/) const { return false; }
 307         virtual bool shouldLoadMediaElementURL(const URL&) const { return true; }
 308
 309         virtual void didChangeScrollOffset() { }
 310
 311         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
 312
 313         // Clients that generally disallow universal access can make exceptions for particular URLs.
 314         virtual bool shouldForceUniversalAccessFromLocalURL(const URL&) { return false; }
 315
 316         virtual PassRefPtr<FrameNetworkingContext> createNetworkingContext() = 0;
 317
 318 #if ENABLE(REQUEST_AUTOCOMPLETE)
 319         virtual void didRequestAutocomplete(PassRefPtr<FormState>) = 0;
 320 #endif
 321
 322         virtual bool shouldPaintBrokenImage(const URL&) const { return true; }
 323
 324         virtual void dispatchGlobalObjectAvailable(DOMWrapperWorld&) { }
 325         virtual void dispatchWillDisconnectDOMWindowExtensionFromGlobalObject(DOMWindowExtension*) { }
 326         virtual void dispatchDidReconnectDOMWindowExtensionToGlobalObject(DOMWindowExtension*) { }
 327         virtual void dispatchWillDestroyGlobalObjectForDOMWindowExtension(DOMWindowExtension*) { }
 328
 329 #if ENABLE(MEDIA_STREAM)
 330         virtual void dispatchWillStartUsingPeerConnectionHandler(RTCPeerConnectionHandler*) { }
 331 #endif
 332
 333 #if ENABLE(WEBGL)
 334         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
 335         // Informs the embedder that a WebGL canvas inside this frame received a lost context
 336         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
 337         virtual void didLoseWebGLContext(int) { }
 338         virtual WebGLLoadPolicy webGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
 339         virtual WebGLLoadPolicy resolveWebGLPolicyForURL(const String&) const { return WebGLAllowCreation; }
 340 #endif
 341
 342         virtual void forcePageTransitionIfNeeded() { }
 343
 344         // FIXME (bug 116233): We need to get rid of EmptyFrameLoaderClient completely, then this will no longer be needed.
 345         virtual bool isEmptyFrameLoaderClient() { return false; }
 346
 347 #if USE(QUICK_LOOK)
 348         virtual void didCreateQuickLookHandle(QuickLookHandle&) { }
 349 #endif
 350
 351 #if ENABLE(CONTENT_FILTERING)
 352         virtual void contentFilterDidBlockLoad(ContentFilterUnblockHandler) { }
 353 #endif
 354
 355         virtual void prefetchDNS(const String&) = 0;
 356
 357         virtual void didRestoreScrollPosition() { }
 358     };
 359
 360 } // namespace WebCore
 361
 362 #endif // FrameLoaderClient_h