blob: 37b1af035401ee8e9ab394831888b68c6519e4e9 [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.
#include <string>
#include "base/basictypes.h"
#include "base/time/time.h"
#include "content/common/content_export.h"
#include "content/common/frame_message_enums.h"
#include "content/public/common/page_state.h"
#include "content/public/common/referrer.h"
#include "ui/base/page_transition_types.h"
#include "url/gurl.h"
namespace base {
class RefCountedMemory;
namespace content {
// PlzNavigate
// Helper function to determine if the navigation to |url| should make a request
// to the network stack. A request should not be sent for data URLs, JavaScript
// URLs or about:blank. In these cases, no request needs to be sent.
bool ShouldMakeNetworkRequestForURL(const GURL& url);
// The following structures hold parameters used during a navigation. In
// particular they are used by FrameMsg_Navigate, FrameMsg_CommitNavigation and
// FrameHostMsg_BeginNavigation.
// Provided by the browser or the renderer -------------------------------------
// Used by all navigation IPCs.
struct CONTENT_EXPORT CommonNavigationParams {
CommonNavigationParams(const GURL& url,
const Referrer& referrer,
ui::PageTransition transition,
FrameMsg_Navigate_Type::Value navigation_type,
bool allow_download,
bool should_replace_current_entry,
base::TimeTicks ui_timestamp,
FrameMsg_UILoadMetricsReportType::Value report_type,
const GURL& base_url_for_data_url,
const GURL& history_url_for_data_url);
// The URL to navigate to.
// PlzNavigate: May be modified when the navigation is ready to commit.
GURL url;
// The URL to send in the "Referer" header field. Can be empty if there is
// no referrer.
Referrer referrer;
// The type of transition.
ui::PageTransition transition;
// Type of navigation.
FrameMsg_Navigate_Type::Value navigation_type;
// Allows the URL to be downloaded (true by default).
// Avoid downloading when in view-source mode.
bool allow_download;
// Informs the RenderView the pending navigation should replace the current
// history entry when it commits. This is used for cross-process redirects so
// the transferred navigation can recover the navigation state.
// PlzNavigate: this is used by client-side redirects to indicate that when
// the navigation commits, it should commit in the existing page.
bool should_replace_current_entry;
// Timestamp of the user input event that triggered this navigation. Empty if
// the navigation was not triggered by clicking on a link or by receiving an
// intent on Android.
base::TimeTicks ui_timestamp;
// The report type to be used when recording the metric using |ui_timestamp|.
FrameMsg_UILoadMetricsReportType::Value report_type;
// Base URL for use in Blink's SubstituteData.
// Is only used with data: URLs.
GURL base_url_for_data_url;
// History URL for use in Blink's SubstituteData.
// Is only used with data: URLs.
GURL history_url_for_data_url;
// Provided by the renderer ----------------------------------------------------
// This struct holds parameters sent by the renderer to the browser. It is only
// used in PlzNavigate (since in the current architecture, the renderer does not
// inform the browser of navigations until they commit).
// This struct is not used outside of the PlzNavigate project.
// PlzNavigate: parameters needed to start a navigation on the IO thread,
// following a renderer-initiated navigation request.
struct CONTENT_EXPORT BeginNavigationParams {
// TODO(clamy): See if it is possible to reuse this in
// ResourceMsg_Request_Params.
BeginNavigationParams(std::string method,
std::string headers,
int load_flags,
bool has_user_gesture);
// The request method: GET, POST, etc.
std::string method;
// Additional HTTP request headers.
std::string headers;
// net::URLRequest load flags (net::LOAD_NORMAL) by default).
int load_flags;
// True if the request was user initiated.
bool has_user_gesture;
// Provided by the browser -----------------------------------------------------
// These structs are sent by the browser to the renderer to start/commit a
// navigation depending on whether browser-side navigation is enabled.
// Parameters used both in the current architecture and PlzNavigate should be
// put in RequestNavigationParams. Parameters only used by the current
// architecture should go in StartNavigationParams.
// Used by FrameMsg_Navigate. Holds the parameters needed by the renderer to
// start a browser-initiated navigation besides those in CommonNavigationParams.
// The difference with the RequestNavigationParams below is that they are only
// used in the current architecture of navigation, and will not be used by
// PlzNavigate.
// PlzNavigate: These are not used.
struct CONTENT_EXPORT StartNavigationParams {
bool is_post,
const std::string& extra_headers,
const std::vector<unsigned char>& browser_initiated_post_data,
#if defined(OS_ANDROID)
bool has_user_gesture,
int transferred_request_child_id,
int transferred_request_request_id);
// Whether the navigation is a POST request (as opposed to a GET).
bool is_post;
// Extra headers (separated by \n) to send during the request.
std::string extra_headers;
// If is_post is true, holds the post_data information from browser. Empty
// otherwise.
std::vector<unsigned char> browser_initiated_post_data;
#if defined(OS_ANDROID)
bool has_user_gesture;
// The following two members identify a previous request that has been
// created before this navigation is being transferred to a new render view.
// This serves the purpose of recycling the old request.
// Unless this refers to a transferred navigation, these values are -1 and -1.
int transferred_request_child_id;
int transferred_request_request_id;
// Used by FrameMsg_Navigate. Holds the parameters needed by the renderer to
// start a browser-initiated navigation besides those in CommonNavigationParams.
// PlzNavigate: sent to the renderer to make it issue a stream request for a
// navigation that is ready to commit.
struct CONTENT_EXPORT RequestNavigationParams {
RequestNavigationParams(bool is_overriding_user_agent,
base::TimeTicks navigation_start,
const std::vector<GURL>& redirects,
bool can_load_local_resources,
base::Time request_time,
const PageState& page_state,
int32 page_id,
int nav_entry_id,
bool is_same_document_history_load,
bool has_committed_real_load,
bool intended_as_new_entry,
int pending_history_list_offset,
int current_history_list_offset,
int current_history_list_length,
bool should_clear_history_list);
// Whether or not the user agent override string should be used.
bool is_overriding_user_agent;
// The navigationStart time to expose through the Navigation Timing API to JS.
base::TimeTicks browser_navigation_start;
// Any redirect URLs that occurred before |url|. Useful for cross-process
// navigations; defaults to empty.
std::vector<GURL> redirects;
// Whether or not this url should be allowed to access local file://
// resources.
bool can_load_local_resources;
// The time the request was created. This is used by the old performance
// infrastructure to set up DocumentState associated with the RenderView.
// TODO(ppi): make it go away.
base::Time request_time;
// Opaque history state (received by ViewHostMsg_UpdateState).
PageState page_state;
// The page_id for this navigation, or -1 if it is a new navigation. Back,
// Forward, and Reload navigations should have a valid page_id. If the load
// succeeds, then this page_id will be reflected in the resultant
// FrameHostMsg_DidCommitProvisionalLoad message.
int32 page_id;
// For browser-initiated navigations, this is the unique id of the
// NavigationEntry being navigated to. (For renderer-initiated navigations it
// is 0.) If the load succeeds, then this nav_entry_id will be reflected in
// the resulting FrameHostMsg_DidCommitProvisionalLoad message.
int nav_entry_id;
// For history navigations, this indicates whether the load will stay within
// the same document. Defaults to false.
bool is_same_document_history_load;
// Whether the frame being navigated has already committed a real page, which
// affects how new navigations are classified in the renderer process.
// This currently is only ever set to true in --site-per-process mode.
// TODO(creis): Create FrameNavigationEntries by default so this always works.
bool has_committed_real_load;
// For browser-initiated navigations, this is true if this is a new entry
// being navigated to. This is false otherwise. TODO(avi): Remove this when
// the pending entry situation is made sane and the browser keeps them around
// long enough to match them via nav_entry_id, above.
bool intended_as_new_entry;
// For history navigations, this is the offset in the history list of the
// pending load. For non-history navigations, this will be ignored.
int pending_history_list_offset;
// Where its current page contents reside in session history and the total
// size of the session history list.
int current_history_list_offset;
int current_history_list_length;
// Whether session history should be cleared. In that case, the RenderView
// needs to notify the browser that the clearing was succesful when the
// navigation commits.
bool should_clear_history_list;
// Helper struct keeping track in one place of all the parameters the browser
// needs to provide to the renderer.
struct NavigationParams {
NavigationParams(const CommonNavigationParams& common_params,
const StartNavigationParams& start_params,
const RequestNavigationParams& request_params);
CommonNavigationParams common_params;
StartNavigationParams start_params;
RequestNavigationParams request_params;
} // namespace content