third_party/WebKit/Source/web/FrameLoaderClientImpl.h

/*
 * Copyright (C) 2009, 2012 Google Inc. All rights reserved.
 * Copyright (C) 2011 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef FrameLoaderClientImpl_h
#define FrameLoaderClientImpl_h

#include "core/loader/FrameLoaderClient.h"
#include "platform/heap/Handle.h"
#include "platform/weborigin/KURL.h"
#include "wtf/PassOwnPtr.h"
#include "wtf/RefPtr.h"

namespace blink {

class WebLocalFrameImpl;

class FrameLoaderClientImpl final : public FrameLoaderClient {
public:
    static FrameLoaderClientImpl* create(WebLocalFrameImpl*);

    ~FrameLoaderClientImpl() override;

    DECLARE_VIRTUAL_TRACE();

    WebLocalFrameImpl* webFrame() const { return m_webFrame.get(); }

    // FrameLoaderClient ----------------------------------------------

    void didCreateNewDocument() override;
    // Notifies the WebView delegate that the JS window object has been cleared,
    // giving it a chance to bind native objects to the window before script
    // parsing begins.
    void dispatchDidClearWindowObjectInMainWorld() override;
    void documentElementAvailable() override;
    void runScriptsAtDocumentElementAvailable() override;
    void runScriptsAtDocumentReady(bool documentIsEmpty) override;

    void didCreateScriptContext(v8::Local<v8::Context>, int extensionGroup, int worldId) override;
    void willReleaseScriptContext(v8::Local<v8::Context>, int worldId) override;

    // Returns true if we should allow the given V8 extension to be added to
    // the script context at the currently loading page and given extension group.
    bool allowScriptExtension(const String& extensionName, int extensionGroup, int worldId) override;

    bool hasWebView() const override;
    bool inShadowTree() const override;
    Frame* opener() const override;
    void setOpener(Frame*) override;
    Frame* parent() const override;
    Frame* top() const override;
    Frame* previousSibling() const override;
    Frame* nextSibling() const override;
    Frame* firstChild() const override;
    Frame* lastChild() const override;
    void willBeDetached() override;
    void detached(FrameDetachType) override;
    void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse) override;
    void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&) override;
    void dispatchDidChangeResourcePriority(unsigned long identifier, ResourceLoadPriority, int intraPriorityValue) override;
    void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier) override;
    void dispatchDidLoadResourceFromMemoryCache(const ResourceRequest&, const ResourceResponse&) override;
    void dispatchDidHandleOnloadEvents() override;
    void dispatchDidReceiveServerRedirectForProvisionalLoad() override;
    void dispatchDidNavigateWithinPage(HistoryItem*, HistoryCommitType) override;
    void dispatchWillClose() override;
    void dispatchDidStartProvisionalLoad(double triggeringEventTime) override;
    void dispatchDidReceiveTitle(const String&) override;
    void dispatchDidChangeIcons(IconType) override;
    void dispatchDidCommitLoad(HistoryItem*, HistoryCommitType) override;
    void dispatchDidFailProvisionalLoad(const ResourceError&, HistoryCommitType) override;
    void dispatchDidFailLoad(const ResourceError&, HistoryCommitType) override;
    void dispatchDidFinishDocumentLoad() override;
    void dispatchDidFinishLoad() override;

    void dispatchDidChangeThemeColor() override;
    NavigationPolicy decidePolicyForNavigation(const ResourceRequest&, DocumentLoader*, NavigationType, NavigationPolicy, bool shouldReplaceCurrentEntry, bool isClientRedirect) override;
    bool hasPendingNavigation() override;
    void dispatchWillSendSubmitEvent(HTMLFormElement*) override;
    void dispatchWillSubmitForm(HTMLFormElement*) override;
    void didStartLoading(LoadStartType) override;
    void didStopLoading() override;
    void progressEstimateChanged(double progressEstimate) override;
    void loadURLExternally(const ResourceRequest&, NavigationPolicy, const String& suggestedName, bool shouldReplaceCurrentEntry) override;
    bool navigateBackForward(int offset) const override;
    void didAccessInitialDocument() override;
    void didDisplayInsecureContent() override;
    void didRunInsecureContent(SecurityOrigin*, const KURL& insecureURL) override;
    void didDetectXSS(const KURL&, bool didBlockEntirePage) override;
    void didDispatchPingLoader(const KURL&) override;
    void didDisplayContentWithCertificateErrors(const KURL&, const CString& securityInfo, const WebURL& mainResourceUrl, const CString& mainResourceSecurityInfo) override;
    void didRunContentWithCertificateErrors(const KURL&, const CString& securityInfo, const WebURL& mainResourceUrl, const CString& mainResourceSecurityInfo) override;
    void didChangePerformanceTiming() override;
    void selectorMatchChanged(const Vector<String>& addedSelectors, const Vector<String>& removedSelectors) override;
    DocumentLoader* createDocumentLoader(LocalFrame*, const ResourceRequest&, const SubstituteData&) override;
    WTF::String userAgent() override;
    WTF::String doNotTrackValue() override;
    void transitionToCommittedForNewPage() override;
    LocalFrame* createFrame(const FrameLoadRequest&, const WTF::AtomicString& name, HTMLFrameOwnerElement*) override;
    virtual bool canCreatePluginWithoutRenderer(const String& mimeType) const;
    Widget* createPlugin(
        HTMLPlugInElement*, const KURL&,
        const Vector<WTF::String>&, const Vector<WTF::String>&,
        const WTF::String&, bool loadManually, DetachedPluginPolicy) override;
    PassOwnPtr<WebMediaPlayer> createWebMediaPlayer(HTMLMediaElement&, const WebMediaPlayerSource&, WebMediaPlayerClient*) override;
    PassOwnPtr<WebMediaSession> createWebMediaSession() override;
    ObjectContentType getObjectContentType(
        const KURL&, const WTF::String& mimeType, bool shouldPreferPlugInsForImages) override;
    void didChangeScrollOffset() override;
    void didUpdateCurrentHistoryItem() override;
    void didRemoveAllPendingStylesheet() override;
    bool allowScript(bool enabledPerSettings) override;
    bool allowScriptFromSource(bool enabledPerSettings, const KURL& scriptURL) override;
    bool allowPlugins(bool enabledPerSettings) override;
    bool allowImage(bool enabledPerSettings, const KURL& imageURL) override;
    bool allowMedia(const KURL& mediaURL) override;
    bool allowDisplayingInsecureContent(bool enabledPerSettings, const KURL&) override;
    bool allowRunningInsecureContent(bool enabledPerSettings, SecurityOrigin*, const KURL&) override;
    void didNotAllowScript() override;
    void didNotAllowPlugins() override;
    void didUseKeygen() override;

    WebCookieJar* cookieJar() const override;
    bool willCheckAndDispatchMessageEvent(SecurityOrigin* target, MessageEvent*, LocalFrame* sourceFrame) const override;
    void frameFocused() const override;
    void didChangeName(const String& name, const String& uniqueName) override;
    void didEnforceStrictMixedContentChecking() override;
    void didUpdateToUniqueOrigin() override;
    void didChangeSandboxFlags(Frame* childFrame, SandboxFlags) override;
    void didChangeFrameOwnerProperties(HTMLFrameElementBase*) override;

    void dispatchWillOpenWebSocket(WebSocketHandle*) override;

    void dispatchWillStartUsingPeerConnectionHandler(WebRTCPeerConnectionHandler*) override;

    void didRequestAutocomplete(HTMLFormElement*) override;

    bool allowWebGL(bool enabledPerSettings) override;

    void dispatchWillInsertBody() override;

    v8::Local<v8::Value> createTestInterface(const AtomicString& name) override;

    PassOwnPtr<WebServiceWorkerProvider> createServiceWorkerProvider() override;
    bool isControlledByServiceWorker(DocumentLoader&) override;
    int64_t serviceWorkerID(DocumentLoader&) override;
    SharedWorkerRepositoryClient* sharedWorkerRepositoryClient() override;

    PassOwnPtr<WebApplicationCacheHost> createApplicationCacheHost(WebApplicationCacheHostClient*) override;

    void dispatchDidChangeManifest() override;

    unsigned backForwardLength() override;

    void suddenTerminationDisablerChanged(bool present, SuddenTerminationDisablerType) override;

    BlameContext* frameBlameContext() override;

    LinkResource* createServiceWorkerLinkResource(HTMLLinkElement*) override;

private:
    explicit FrameLoaderClientImpl(WebLocalFrameImpl*);

    bool isFrameLoaderClientImpl() const override { return true; }

    // The WebFrame that owns this object and manages its lifetime. Therefore,
    // the web frame object is guaranteed to exist.
    Member<WebLocalFrameImpl> m_webFrame;

    String m_userAgent;
};

DEFINE_TYPE_CASTS(FrameLoaderClientImpl, FrameLoaderClient, client, client->isFrameLoaderClientImpl(), client.isFrameLoaderClientImpl());

} // namespace blink

#endif