blob: 3a6cd68aeb5f0ce3c2645ea9e12528c9f1dc7f8a [file] [log] [blame]
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef IOS_WEB_PUBLIC_WEB_STATE_WEB_STATE_H_
#define IOS_WEB_PUBLIC_WEB_STATE_WEB_STATE_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/callback_forward.h"
#include "base/callback_list.h"
#include "base/memory/weak_ptr.h"
#include "base/supports_user_data.h"
#include "ios/web/public/deprecated/url_verification_constants.h"
#include "ios/web/public/navigation/referrer.h"
#include "mojo/public/cpp/bindings/interface_request.h"
#include "mojo/public/cpp/system/message_pipe.h"
#include "ui/base/page_transition_types.h"
#include "ui/base/window_open_disposition.h"
#include "url/gurl.h"
class GURL;
@class CRWJSInjectionReceiver;
@class CRWSessionStorage;
@protocol CRWScrollableContent;
@protocol CRWWebViewProxy;
typedef id<CRWWebViewProxy> CRWWebViewProxyType;
@class UIView;
typedef UIView<CRWScrollableContent> CRWContentView;
namespace base {
class DictionaryValue;
class Value;
}
namespace gfx {
class Image;
class RectF;
}
namespace web {
class BrowserState;
class NavigationManager;
class SessionCertificatePolicyCache;
class WebFrame;
class WebFramesManager;
class WebInterstitial;
class WebStateDelegate;
class WebStateInterfaceProvider;
class WebStateObserver;
class WebStatePolicyDecider;
// Core interface for interaction with the web.
class WebState : public base::SupportsUserData {
public:
// Parameters for the Create() method.
struct CreateParams {
explicit CreateParams(web::BrowserState* browser_state);
~CreateParams();
// The corresponding BrowserState for the new WebState.
web::BrowserState* browser_state;
// Whether the WebState is created as the result of a window.open or by
// clicking a link with a blank target. Used to determine whether the
// WebState is allowed to be closed via window.close().
bool created_with_opener;
};
// Parameters for the OpenURL() method.
struct OpenURLParams {
OpenURLParams(const GURL& url,
const GURL& virtual_url,
const Referrer& referrer,
WindowOpenDisposition disposition,
ui::PageTransition transition,
bool is_renderer_initiated);
OpenURLParams(const GURL& url,
const Referrer& referrer,
WindowOpenDisposition disposition,
ui::PageTransition transition,
bool is_renderer_initiated);
OpenURLParams(const OpenURLParams& params);
~OpenURLParams();
// The URL/virtualURL/referrer to be opened.
GURL url;
GURL virtual_url;
Referrer referrer;
// The disposition requested by the navigation source.
WindowOpenDisposition disposition;
// The transition type of navigation.
ui::PageTransition transition;
// Whether this navigation is initiated by the renderer process.
bool is_renderer_initiated;
};
// Creates a new WebState.
static std::unique_ptr<WebState> Create(const CreateParams& params);
// Creates a new WebState from a serialized representation of the session.
// |session_storage| must not be nil.
static std::unique_ptr<WebState> CreateWithStorageSession(
const CreateParams& params,
CRWSessionStorage* session_storage);
~WebState() override {}
// Gets/Sets the delegate.
virtual WebStateDelegate* GetDelegate() = 0;
virtual void SetDelegate(WebStateDelegate* delegate) = 0;
// Whether or not a web view is allowed to exist in this WebState. Defaults
// to false; this should be enabled before attempting to access the view.
virtual bool IsWebUsageEnabled() const = 0;
virtual void SetWebUsageEnabled(bool enabled) = 0;
// The view containing the contents of the current web page. If the view has
// been purged due to low memory, this will recreate it. It is up to the
// caller to size the view.
virtual UIView* GetView() = 0;
// Must be called when the WebState becomes shown/hidden.
virtual void WasShown() = 0;
virtual void WasHidden() = 0;
// When |true|, attempt to prevent the WebProcess from suspending. Embedder
// must override WebClient::GetWindowedContainer to maintain this
// functionality.
virtual void SetKeepRenderProcessAlive(bool keep_alive) = 0;
// Gets the BrowserState associated with this WebState. Can never return null.
virtual BrowserState* GetBrowserState() const = 0;
// Opens a URL with the given disposition. The transition specifies how this
// navigation should be recorded in the history system (for example, typed).
virtual void OpenURL(const OpenURLParams& params) = 0;
// Stops any pending navigation.
virtual void Stop() = 0;
// Gets the NavigationManager associated with this WebState. Can never return
// null.
virtual const NavigationManager* GetNavigationManager() const = 0;
virtual NavigationManager* GetNavigationManager() = 0;
// Gets the WebFramesManager associated with this WebState. Can never return
// null.
virtual const WebFramesManager* GetWebFramesManager() const = 0;
virtual WebFramesManager* GetWebFramesManager() = 0;
// Gets the SessionCertificatePolicyCache for this WebState. Can never return
// null.
virtual const SessionCertificatePolicyCache*
GetSessionCertificatePolicyCache() const = 0;
virtual SessionCertificatePolicyCache* GetSessionCertificatePolicyCache() = 0;
// Creates a serializable representation of the session. The returned value
// is autoreleased.
virtual CRWSessionStorage* BuildSessionStorage() = 0;
// Gets the CRWJSInjectionReceiver associated with this WebState.
virtual CRWJSInjectionReceiver* GetJSInjectionReceiver() const = 0;
// Loads |data| of type |mime_type| and replaces last committed URL with the
// given |url|.
virtual void LoadData(NSData* data, NSString* mime_type, const GURL& url) = 0;
// DISCOURAGED. Prefer using |WebFrame CallJavaScriptFunction| instead because
// it restricts JavaScript execution to functions within __gCrWeb and can also
// call those functions on any frame in the page. ExecuteJavaScript here can
// execute arbitrary JavaScript code, which is not as safe and is retricted to
// executing only on the main frame.
// Runs JavaScript in the main frame's context. If a callback is provided, it
// will be used to return the result, when the result is available or script
// execution has failed due to an error.
// NOTE: Integer values will be returned as Type::DOUBLE because of underlying
// library limitation.
typedef base::OnceCallback<void(const base::Value*)> JavaScriptResultCallback;
virtual void ExecuteJavaScript(const base::string16& javascript) = 0;
virtual void ExecuteJavaScript(const base::string16& javascript,
JavaScriptResultCallback callback) = 0;
// Asynchronously executes |javaScript| in the main frame's context,
// registering user interaction.
virtual void ExecuteUserJavaScript(NSString* javaScript) = 0;
// Gets the contents MIME type.
virtual const std::string& GetContentsMimeType() const = 0;
// Returns true if the current page is a web view with HTML.
virtual bool ContentIsHTML() const = 0;
// Returns the current navigation title. This could be the title of the page
// if it is available or the URL.
virtual const base::string16& GetTitle() const = 0;
// Returns true if the current page is loading.
virtual bool IsLoading() const = 0;
// The fraction of the page load that has completed as a number between 0.0
// (nothing loaded) and 1.0 (fully loaded).
virtual double GetLoadingProgress() const = 0;
// Whether the WebState is visible. Returns true after WasShown() call and
// false after WasHidden() call.
virtual bool IsVisible() const = 0;
// Returns true if the web process backing this WebState is believed to
// currently be crashed.
virtual bool IsCrashed() const = 0;
// Returns true if the web process backing this WebState is believed to
// currently be crashed or was evicted (by calling SetWebUsageEnabled
// with false).
// TODO(crbug.com/619971): Remove once all code has been ported to use
// IsCrashed() instead of IsEvicted().
virtual bool IsEvicted() const = 0;
// Whether this instance is in the process of being destroyed.
virtual bool IsBeingDestroyed() const = 0;
// Gets the URL currently being displayed in the URL bar, if there is one.
// This URL might be a pending navigation that hasn't committed yet, so it is
// not guaranteed to match the current page in this WebState. A typical
// example of this is interstitials, which show the URL of the new/loading
// page (active) but the security context is of the old page (last committed).
virtual const GURL& GetVisibleURL() const = 0;
// Gets the last committed URL. It represents the current page that is
// displayed in this WebState. It represents the current security context.
virtual const GURL& GetLastCommittedURL() const = 0;
// Returns the WebState view of the current URL. Moreover, this method
// will set the trustLevel enum to the appropriate level from a security point
// of view. The caller has to handle the case where |trust_level| is not
// appropriate. Passing |null| will skip the trust check.
// TODO(stuartmorgan): Figure out a clean API for this.
// See http://crbug.com/457679
virtual GURL GetCurrentURL(URLVerificationTrustLevel* trust_level) const = 0;
// Returns true if a WebInterstitial is currently displayed.
virtual bool IsShowingWebInterstitial() const = 0;
// Returns the currently visible WebInterstitial if one is shown.
virtual WebInterstitial* GetWebInterstitial() const = 0;
// Callback used to handle script commands. |message| is the JS message sent
// from the |sender_frame| in the page, |page_url| is the URL of page's main
// frame, |user_is_interacting| indicates if the user is interacting with the
// page.
// TODO(crbug.com/881813): remove |page_url|.
using ScriptCommandCallbackSignature =
void(const base::DictionaryValue& message,
const GURL& page_url,
bool user_is_interacting,
web::WebFrame* sender_frame);
using ScriptCommandCallback =
base::RepeatingCallback<ScriptCommandCallbackSignature>;
using ScriptCommandSubscription =
base::CallbackList<ScriptCommandCallbackSignature>::Subscription;
// Registers |callback| for JS message whose 'command' matches
// |command_prefix|. The returned ScriptCommandSubscription should be stored
// by the caller. When the description object is destroyed, it will unregister
// |callback| if this WebState is still alive, and do nothing if this WebState
// is already destroyed. Therefore if the caller want to stop receiving JS
// messages it can just destroy the subscription object.
virtual std::unique_ptr<ScriptCommandSubscription> AddScriptCommandCallback(
const ScriptCommandCallback& callback,
const std::string& command_prefix) WARN_UNUSED_RESULT = 0;
// Returns the current CRWWebViewProxy object.
virtual CRWWebViewProxyType GetWebViewProxy() const = 0;
// Returns Mojo interface registry for this WebState.
virtual WebStateInterfaceProvider* GetWebStateInterfaceProvider() = 0;
// Typically an embedder will:
// - Implement this method to receive notification of changes to the page's
// |VisibleSecurityState|, updating security UI (e.g. a lock icon) to
// reflect the current security state of the page.
// ...and optionally:
// - Invoke this method upon detection of an event that will change
// the security state (e.g. a non-secure form element is edited).
virtual void DidChangeVisibleSecurityState() = 0;
protected:
// Binds |interface_pipe| to an implementation of |interface_name| that is
// scoped to this WebState instance (if that such an implementation is
// present). Embedders of //ios/web can inject interface implementations by
// overriding WebClient::BindInterfaceRequestFromMainFrame().
// NOTE: Callers should use the more-friendly wrapper below.
virtual void BindInterfaceRequestFromMainFrame(
const std::string& interface_name,
mojo::ScopedMessagePipeHandle interface_pipe) {}
public:
template <class Interface>
void BindInterfaceRequestFromMainFrame(
mojo::InterfaceRequest<Interface> request) {
BindInterfaceRequestFromMainFrame(Interface::Name_,
std::move(request.PassMessagePipe()));
}
// Whether this WebState was created with an opener.
// See CreateParams::created_with_opener for more details.
virtual bool HasOpener() const = 0;
virtual void SetHasOpener(bool has_opener) = 0;
// Callback used to handle snapshots. The parameter is the snapshot image.
typedef base::RepeatingCallback<void(const gfx::Image&)> SnapshotCallback;
// Returns whether TakeSnapshot() can be executed. The API may be disabled if
// the WKWebView IPC mechanism is blocked due to an outstanding JavaScript
// dialog.
virtual bool CanTakeSnapshot() const = 0;
// Takes a snapshot of this WebState with |rect|. |rect| should be specified
// in the coordinate system of the view returned by GetView(). |callback| is
// asynchronously invoked after performing the snapshot. Prior to iOS 11, the
// callback is invoked with a nil snapshot.
virtual void TakeSnapshot(const gfx::RectF& rect,
SnapshotCallback callback) = 0;
// Adds and removes observers for page navigation notifications. The order in
// which notifications are sent to observers is undefined. Clients must be
// sure to remove the observer before they go away.
virtual void AddObserver(WebStateObserver* observer) = 0;
virtual void RemoveObserver(WebStateObserver* observer) = 0;
protected:
friend class WebStatePolicyDecider;
// Adds and removes policy deciders for navigation actions. The order in which
// deciders are called is undefined, and will stop on the first decider that
// refuses a navigation. Clients must be sure to remove the deciders before
// they go away.
virtual void AddPolicyDecider(WebStatePolicyDecider* decider) = 0;
virtual void RemovePolicyDecider(WebStatePolicyDecider* decider) = 0;
WebState() {}
private:
DISALLOW_COPY_AND_ASSIGN(WebState);
};
} // namespace web
#endif // IOS_WEB_PUBLIC_WEB_STATE_WEB_STATE_H_