src/third_party/WebKit/Source/core/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 "core/dom/IconURL.h"
  34 #include "core/frame/FrameClient.h"
  35 #include "core/loader/FrameLoaderTypes.h"
  36 #include "core/loader/NavigationPolicy.h"
  37 #include "platform/network/ResourceLoadPriority.h"
  38 #include "platform/weborigin/Referrer.h"
  39 #include "wtf/Forward.h"
  40 #include "wtf/Vector.h"
  41 #include <v8.h>
  42
  43 namespace blink {
  44 class WebCookieJar;
  45 class WebRTCPeerConnectionHandler;
  46 class WebServiceWorkerProvider;
  47 class WebServiceWorkerProviderClient;
  48 class WebSocketHandle;
  49 class WebApplicationCacheHost;
  50 class WebApplicationCacheHostClient;
  51 }
  52
  53 namespace blink {
  54
  55     class Color;
  56     class DOMWindowExtension;
  57     class DOMWrapperWorld;
  58     class DocumentLoader;
  59     class Element;
  60     class FetchRequest;
  61     class FrameLoader;
  62     class FrameNetworkingContext;
  63     class HTMLAppletElement;
  64     class HTMLFormElement;
  65     class HTMLFrameOwnerElement;
  66     class HTMLPlugInElement;
  67     class HistoryItem;
  68     class IntSize;
  69     class KURL;
  70     class LocalFrame;
  71     class MessageEvent;
  72     class Page;
  73     class PluginView;
  74     class ResourceError;
  75     class ResourceHandle;
  76     class ResourceRequest;
  77     class ResourceResponse;
  78     class SecurityOrigin;
  79     class SharedBuffer;
  80     class SharedWorkerRepositoryClient;
  81     class SocketStreamHandle;
  82     class SubstituteData;
  83     class Widget;
  84
  85     class FrameLoaderClient : public FrameClient {
  86     public:
  87         virtual ~FrameLoaderClient() { }
  88
  89         virtual bool hasWebView() const = 0; // mainly for assertions
  90
  91         virtual void detachedFromParent() = 0;
  92
  93         virtual void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) = 0;
  94         virtual void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) = 0;
  95         virtual void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) = 0;
  96         virtual void dispatchDidLoadResourceFromMemoryCache(const ResourceRequest&, const ResourceResponse&) = 0;
  97
  98         virtual void dispatchDidHandleOnloadEvents() = 0;
  99         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad() = 0;
 100         virtual void dispatchDidNavigateWithinPage(HistoryItem*, HistoryCommitType) { }
 101         virtual void dispatchWillClose() = 0;
 102         virtual void dispatchDidStartProvisionalLoad(bool isTransitionNavigation) = 0;
 103         virtual void dispatchDidReceiveTitle(const String&) = 0;
 104         virtual void dispatchDidChangeIcons(IconType) = 0;
 105         virtual void dispatchDidCommitLoad(LocalFrame*, HistoryItem*, HistoryCommitType) = 0;
 106         virtual void dispatchDidFailProvisionalLoad(const ResourceError&) = 0;
 107         virtual void dispatchDidFailLoad(const ResourceError&) = 0;
 108         virtual void dispatchDidFinishDocumentLoad() = 0;
 109         virtual void dispatchDidFinishLoad() = 0;
 110         virtual void dispatchDidFirstVisuallyNonEmptyLayout() = 0;
 111         virtual void dispatchDidChangeThemeColor() = 0;
 112
 113         virtual NavigationPolicy decidePolicyForNavigation(const ResourceRequest&, DocumentLoader*, NavigationPolicy, bool isTransitionNavigation) = 0;
 114
 115         virtual void dispatchAddNavigationTransitionData(const String& origin, const String& selector, const String& markup) { }
 116         virtual void dispatchWillRequestResource(FetchRequest*) { }
 117
 118         virtual void dispatchWillSendSubmitEvent(HTMLFormElement*) = 0;
 119         virtual void dispatchWillSubmitForm(HTMLFormElement*) = 0;
 120
 121         virtual void didStartLoading(LoadStartType) = 0;
 122         virtual void progressEstimateChanged(double progressEstimate) = 0;
 123         virtual void didStopLoading() = 0;
 124
 125         virtual void loadURLExternally(const ResourceRequest&, NavigationPolicy, const String& suggestedName = String()) = 0;
 126
 127         virtual bool navigateBackForward(int offset) const = 0;
 128
 129         // Another page has accessed the initial empty document of this frame.
 130         // It is no longer safe to display a provisional URL, since a URL spoof
 131         // is now possible.
 132         virtual void didAccessInitialDocument() { }
 133
 134         // This frame has displayed inactive content (such as an image) from an
 135         // insecure source.  Inactive content cannot spread to other frames.
 136         virtual void didDisplayInsecureContent() = 0;
 137
 138         // The indicated security origin has run active content (such as a
 139         // script) from an insecure source.  Note that the insecure content can
 140         // spread to other frames in the same origin.
 141         virtual void didRunInsecureContent(SecurityOrigin*, const KURL&) = 0;
 142         virtual void didDetectXSS(const KURL&, bool didBlockEntirePage) = 0;
 143         virtual void didDispatchPingLoader(const KURL&) = 0;
 144
 145         // Transmits the change in the set of watched CSS selectors property
 146         // that match any element on the frame.
 147         virtual void selectorMatchChanged(const Vector<String>& addedSelectors, const Vector<String>& removedSelectors) = 0;
 148
 149         virtual PassRefPtr<DocumentLoader> createDocumentLoader(LocalFrame*, const ResourceRequest&, const SubstituteData&) = 0;
 150
 151         virtual String userAgent(const KURL&) = 0;
 152
 153         virtual String doNotTrackValue() = 0;
 154
 155         virtual void transitionToCommittedForNewPage() = 0;
 156
 157         virtual PassRefPtr<LocalFrame> createFrame(const KURL&, const AtomicString& name, const Referrer&, HTMLFrameOwnerElement*) = 0;
 158         // Whether or not plugin creation should fail if the HTMLPlugInElement isn't in the DOM after plugin initialization.
 159         enum DetachedPluginPolicy {
 160             FailOnDetachedPlugin,
 161             AllowDetachedPlugin,
 162         };
 163         virtual bool canCreatePluginWithoutRenderer(const String& mimeType) const = 0;
 164         virtual PassRefPtr<Widget> createPlugin(HTMLPlugInElement*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool loadManually, DetachedPluginPolicy) = 0;
 165
 166         virtual PassRefPtr<Widget> createJavaAppletWidget(HTMLAppletElement*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues) = 0;
 167
 168         virtual ObjectContentType objectContentType(const KURL&, const String& mimeType, bool shouldPreferPlugInsForImages) = 0;
 169
 170         virtual void dispatchDidClearWindowObjectInMainWorld() = 0;
 171         virtual void documentElementAvailable() = 0;
 172
 173         virtual void didCreateScriptContext(v8::Handle<v8::Context>, int extensionGroup, int worldId) = 0;
 174         virtual void willReleaseScriptContext(v8::Handle<v8::Context>, int worldId) = 0;
 175         virtual bool allowScriptExtension(const String& extensionName, int extensionGroup, int worldId) = 0;
 176
 177         virtual void didChangeScrollOffset() { }
 178         virtual void didUpdateCurrentHistoryItem() { }
 179         virtual void didRemoveAllPendingStylesheet() { }
 180
 181         virtual bool allowScript(bool enabledPerSettings) { return enabledPerSettings; }
 182         virtual bool allowScriptFromSource(bool enabledPerSettings, const KURL&) { return enabledPerSettings; }
 183         virtual bool allowPlugins(bool enabledPerSettings) { return enabledPerSettings; }
 184         virtual bool allowImage(bool enabledPerSettings, const KURL&) { return enabledPerSettings; }
 185         virtual bool allowMedia(const KURL&) { return true; }
 186         virtual bool allowDisplayingInsecureContent(bool enabledPerSettings, SecurityOrigin*, const KURL&) { return enabledPerSettings; }
 187         virtual bool allowRunningInsecureContent(bool enabledPerSettings, SecurityOrigin*, const KURL&) { return enabledPerSettings; }
 188
 189         // This callback notifies the client that the frame was about to run
 190         // JavaScript but did not because allowScript returned false. We
 191         // have a separate callback here because there are a number of places
 192         // that need to know if JavaScript is enabled but are not necessarily
 193         // preparing to execute script.
 194         virtual void didNotAllowScript() { }
 195         // This callback is similar, but for plugins.
 196         virtual void didNotAllowPlugins() { }
 197
 198         virtual blink::WebCookieJar* cookieJar() const = 0;
 199
 200         // Returns true if the embedder intercepted the postMessage call
 201         virtual bool willCheckAndDispatchMessageEvent(SecurityOrigin* /*target*/, MessageEvent*) const { return false; }
 202
 203         virtual void didChangeName(const String&) { }
 204
 205         virtual void dispatchWillOpenSocketStream(SocketStreamHandle*) { }
 206         virtual void dispatchWillOpenWebSocket(blink::WebSocketHandle*) { }
 207
 208         virtual void dispatchWillStartUsingPeerConnectionHandler(blink::WebRTCPeerConnectionHandler*) { }
 209
 210         virtual void didRequestAutocomplete(HTMLFormElement*) = 0;
 211
 212         virtual bool allowWebGL(bool enabledPerSettings) { return enabledPerSettings; }
 213         // Informs the embedder that a WebGL canvas inside this frame received a lost context
 214         // notification with the given GL_ARB_robustness guilt/innocence code (see Extensions3D.h).
 215         virtual void didLoseWebGLContext(int) { }
 216
 217         // If an HTML document is being loaded, informs the embedder that the document will have its <body> attached soon.
 218         virtual void dispatchWillInsertBody() { }
 219
 220         virtual void dispatchDidChangeResourcePriority(unsigned long identifier, ResourceLoadPriority, int intraPriorityValue) { }
 221
 222         virtual PassOwnPtr<blink::WebServiceWorkerProvider> createServiceWorkerProvider() = 0;
 223
 224         virtual SharedWorkerRepositoryClient* sharedWorkerRepositoryClient() { return 0; }
 225
 226         virtual PassOwnPtr<blink::WebApplicationCacheHost> createApplicationCacheHost(blink::WebApplicationCacheHostClient*) = 0;
 227
 228         virtual void didStopAllLoaders() { }
 229
 230         virtual void dispatchDidChangeManifest() { }
 231
 232         virtual bool isFrameLoaderClientImpl() const { return false; }
 233     };
 234
 235 } // namespace blink
 236
 237 #endif // FrameLoaderClient_h