blob: 179cfb60f4f5604e475f142cd5d49c78b8fb9d5f [file] [log] [blame]
// Copyright 2014 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.
module content.mojom;
import "content/common/navigation_params.mojom";
import "content/common/service_worker/controller_service_worker.mojom";
import "content/common/url_loader_factory_bundle.mojom";
import "content/public/common/resource_type.mojom";
import "content/public/common/window_container_type.mojom";
import "mojo/common/unguessable_token.mojom";
import "mojo/common/string16.mojom";
import "services/network/public/interfaces/url_loader.mojom";
import "services/service_manager/public/interfaces/interface_provider.mojom";
import "third_party/WebKit/common/feature_policy/feature_policy.mojom";
import "third_party/WebKit/public/platform/referrer.mojom";
import "third_party/WebKit/public/web/window_features.mojom";
import "ui/base/mojo/window_open_disposition.mojom";
import "url/mojo/url.mojom";
import "ui/gfx/geometry/mojo/geometry.mojom";
// The name of the InterfaceProviderSpec in service manifests used by the
// frame tree to expose frame-specific interfaces between renderer and browser.
const string kNavigation_FrameSpec = "navigation:frame";
// Implemented by the frame provider (e.g. renderer processes).
interface Frame {
GetInterfaceProvider(service_manager.mojom.InterfaceProvider& interfaces);
GetCanonicalUrlForSharing() => (url.mojom.Url? canonical_url);
// Samsung Galaxy Note-specific "smart clip" stylus text getter.
// Extracts the data at the given rect.
// TODO( Only enable for OS_ANDROID.
ExtractSmartClipData(gfx.mojom.Rect rect)
=> (mojo.common.mojom.String16 text, mojo.common.mojom.String16 html);
// See src/content/common/navigation_params.h
struct CommonNavigationParams;
// See src/content/common/navigation_params.h
struct RequestNavigationParams;
// Implemented by the frame provider and currently must be associated with the
// legacy IPC channel.
interface FrameNavigationControl {
// Tells the renderer that a navigation is ready to commit.
// The renderer should request |body_url| to get access to the stream
// containing the body of the response. When the Network Service or
// NavigationMojoResponse is enabled, |body_url| is not used and instead
// |url_loader_client_endpoints| provides a way to continue the navigation.
// Note: |body_url| and |url_loader_client_endpoints| will be empty iff the
// navigation URL wasn't handled by the network stack (i.e. JavaScript URLs,
// renderer debug URLs, same document navigations, about:blank, ...)
// When the Network Service is enabled, |subresource_loader_factories| may
// also be provided by the browser as a a means for the renderer to load
// subresources where applicable.
// When S13nServiceWorker/NavigationMojoResponse is enabled,
// |controller_service_worker_info| may also be provided by the browser if the
// frame that is being navigated is supposed to be controlled by a Service
// Worker.
// For automation driver-initiated navigations over the devtools protocol,
// |devtools_navigation_token_| is used to tag the navigation. This navigation
// token is then sent into the renderer and lands on the DocumentLoader. That
// way subsequent Blink-level frame lifecycle events can be associated with
// the concrete navigation.
// - The value should not be sent back to the browser.
// - The value on DocumentLoader may be generated in the renderer in some
// cases, and thus shouldn't be trusted.
// TODO( Replace devtools navigation token with the generic
// navigation token that can be passed from renderer to the browser.
network.mojom.URLResponseHead head,
url.mojom.Url body_url,
CommonNavigationParams common_params,
RequestNavigationParams request_params,
network.mojom.URLLoaderClientEndpoints? url_loader_client_endpoints,
URLLoaderFactoryBundle? subresource_loader_factories,
ControllerServiceWorkerInfo? controller_service_worker_info,
mojo.common.mojom.UnguessableToken devtools_navigation_token);
// Tells the renderer that a failed navigation is ready to commit.
// The result of this commit usually results in displaying an error page.
// Note |error_page_content| may contain the content of the error page
// (i.e. flattened HTML, JS, CSS).
// When the Network Service is enabled, |subresource_loader_factories| may
// also be provided by the browser as a a means for the renderer to load
// subresources where applicable.
CommonNavigationParams common_params,
RequestNavigationParams request_params,
bool has_stale_copy_in_cache,
int32 error_code,
string? error_page_content,
URLLoaderFactoryBundle? subresource_loader_factories);
// Implemented by the frame (e.g. renderer processes).
// Instances of this interface must be associated with (i.e., FIFO with) the
// legacy IPC channel.
interface FrameBindingsControl {
// Used to tell a render frame whether it should expose various bindings
// that allow JS content extended privileges. See BindingsPolicy for valid
// flag values.
AllowBindings(int32 enabled_bindings_flags);
// Implemented by a service that provides implementations of the Frame
// interface. (e.g. renderer processes).
interface FrameFactory {
CreateFrame(int32 frame_routing_id, Frame& frame);
struct CreateNewWindowParams {
// True if this open request came in the context of a user gesture.
bool user_gesture;
// Type of window requested.
WindowContainerType window_container_type;
// The session storage namespace ID this window should use.
int64 session_storage_namespace_id;
// The name of the resulting frame that should be created (empty if none
// has been specified). UTF8 encoded string.
string frame_name;
// Whether the opener will be suppressed in the new window, in which case
// scripting the new window is not allowed.
bool opener_suppressed;
// Whether the window should be opened in the foreground, background, etc.
ui.mojom.WindowOpenDisposition disposition;
// The URL that will be loaded in the new window (empty if none has been
// specified).
url.mojom.Url target_url;
// The referrer that will be used to load |target_url| (empty if none has
// been specified).
blink.mojom.Referrer referrer;
// The window features to use for the new window.
blink.mojom.WindowFeatures features;
// Operation result when the renderer asks the browser to create a new window.
enum CreateNewWindowStatus {
// Ignore creation of the new window. This can happen because creation is
// blocked or because the new window should have no opener relationship.
// Reuse the current window rather than creating a new window.
// Create a new window using the corresponding params in |reply|.
// All routing IDs in this struct must be set to a valid routing ID.
struct CreateNewWindowReply {
// The ID of the view to be created.
int32 route_id;
// The ID of the main frame hosted in the view.
int32 main_frame_route_id;
// The ID of the widget for the main frame.
int32 main_frame_widget_route_id;
// The InterfaceProvider through which the main RenderFrame can access
// services exposed by its RenderFrameHost.
service_manager.mojom.InterfaceProvider main_frame_interface_provider;
// Duplicated from CreateNewWindowParams because legacy code.
int64 cloned_session_storage_namespace_id;
// Used for devtools instrumentation and trace-ability. The token is
// propagated to Blink's LocalFrame and both Blink and content/
// can tag calls and requests with this instrumentation token in order to
// attribute them to the context frame.
// |devtools_frame_token| is only defined by the browser and is never
// sent back from the renderer in the control calls.
mojo.common.mojom.UnguessableToken devtools_main_frame_token;
// An opaque handle that keeps alive the associated render process even after
// the frame is detached. Used by resource requests with "keepalive" specified.
interface KeepAliveHandle {};
struct DidCommitProvisionalLoadParams;
// Implemented by the frame server (i.e. the browser process). For messages that
// must be associated with the IPC channel.
interface FrameHost {
// Sent by the renderer to request the browser to create a new window. |reply|
// is only non-null on when status == CreateNewWindowStatus::kSuccess.
[Sync] CreateNewWindow(CreateNewWindowParams params)
=> (CreateNewWindowStatus status, CreateNewWindowReply? reply);
// Creates and returns a KeepAliveHandle.
IssueKeepAliveHandle(KeepAliveHandle& keep_alive_handle);
// Sent by the renderer when a navigation commits in the frame.
// If |interface_provider_request| is non-empty, the FrameHost implementation
// must unbind the old InterfaceProvider connection, and drop any interface
// requests pending on it. Then it should bind |interface_provider_request|
// and start servicing GetInterface messages coming in on this new connection
// in a security context that is appropriate for the committed navigation.
// The FrameHost implementation must enforce that |interface_provider_request|
// is set for cross-document navigations. This prevents origin confusion by
// ensuring that interface requests racing with navigation commit will be
// either ignored, or serviced correctly in the security context of the
// document they originated from (based on which InterfaceProvider connection
// the GetInterface messages arrive on).
DidCommitProvisionalLoadParams params,
service_manager.mojom.InterfaceProvider&? interface_provider_request);
// Sent by the renderer to request a navigation.
CommonNavigationParams common_params,
BeginNavigationParams begin_params);
// Sent when a subresource response has started.
url.mojom.Url url,
url.mojom.Url referrer,
string method,
ResourceType resource_type,
string ip,
uint32 cert_status);
// Sent when the frame changes its
DidChangeName(string name, string unique_name);
// Sent when the frame starts enforcing an insecure request policy. Sending
// this information in DidCommitProvisionalLoad isn't sufficient; this
// message is needed because, for example, a document can dynamically insert
// a <meta> tag that causes strict mixed content checking to be enforced.
// Argument |policy_bitmap| represents blink::WebInsecureRequestPolicy uint8
// bitfield.
EnforceInsecureRequestPolicy(uint8 policy_bitmap);
// Elements of |set| are hashes of hosts to upgrade.
EnforceInsecureNavigationsSet(array<uint32> set);
// Notifies the browser process that HTTP headers which affect the frame
// polices were delivered with the document being loaded into the frame. This
// can be either or both of 'Feature-Policy' or 'Content-Security-Policy' (
// which can set sandbox flags).
// |parsed_header| is a list of an origin whitelist for each feature in the
// policy.
blink.mojom.WebSandboxFlags sandbox_flags,
array<blink.mojom.ParsedFeaturePolicyDeclaration> parsed_header);
// If a cross-process navigation was started for the initial history load in
// this subframe, this tries to cancel it to allow a client redirect to happen
// instead.
// Change the encoding name of the page in UI when the page has detected
// proper encoding name. Sent for top-level frames.
UpdateEncoding(string encoding_name);