content/common/navigation_params.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_COMMON_NAVIGATION_PARAMS_H_
   6 #define CONTENT_COMMON_NAVIGATION_PARAMS_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/time/time.h"
  12 #include "content/common/content_export.h"
  13 #include "content/common/frame_message_enums.h"
  14 #include "content/public/common/page_state.h"
  15 #include "content/public/common/referrer.h"
  16 #include "ui/base/page_transition_types.h"
  17 #include "url/gurl.h"
  18
  19 namespace base {
  20 class RefCountedMemory;
  21 }
  22
  23 namespace content {
  24 class NavigationEntry;
  25
  26 // The following structures hold parameters used during a navigation. In
  27 // particular they are used by FrameMsg_Navigate, FrameMsg_CommitNavigation and
  28 // FrameHostMsg_BeginNavigation.
  29 // TODO(clamy): Depending on the avancement of the history refactoring move the
  30 // history parameters from FrameMsg_Navigate into one of the structs.
  31
  32 // Used by all navigation IPCs.
  33 struct CONTENT_EXPORT CommonNavigationParams {
  34   CommonNavigationParams();
  35   CommonNavigationParams(const GURL& url,
  36                          const Referrer& referrer,
  37                          ui::PageTransition transition,
  38                          FrameMsg_Navigate_Type::Value navigation_type,
  39                          bool allow_download,
  40                          base::TimeTicks ui_timestamp,
  41                          FrameMsg_UILoadMetricsReportType::Value report_type,
  42                          const GURL& base_url_for_data_url,
  43                          const GURL& history_url_for_data_url);
  44   ~CommonNavigationParams();
  45
  46   // The URL to navigate to.
  47   // PlzNavigate: May be modified when the navigation is ready to commit.
  48   GURL url;
  49
  50   // The URL to send in the "Referer" header field. Can be empty if there is
  51   // no referrer.
  52   Referrer referrer;
  53
  54   // The type of transition.
  55   ui::PageTransition transition;
  56
  57   // Type of navigation.
  58   FrameMsg_Navigate_Type::Value navigation_type;
  59
  60   // Allows the URL to be downloaded (true by default).
  61   // Avoid downloading when in view-source mode.
  62   bool allow_download;
  63
  64   // Timestamp of the user input event that triggered this navigation. Empty if
  65   // the navigation was not triggered by clicking on a link or by receiving an
  66   // intent on Android.
  67   base::TimeTicks ui_timestamp;
  68
  69   // The report type to be used when recording the metric using |ui_timestamp|.
  70   FrameMsg_UILoadMetricsReportType::Value report_type;
  71
  72   // Base URL for use in Blink's SubstituteData.
  73   // Is only used with data: URLs.
  74   GURL base_url_for_data_url;
  75
  76   // History URL for use in Blink's SubstituteData.
  77   // Is only used with data: URLs.
  78   GURL history_url_for_data_url;
  79 };
  80
  81 // PlzNavigate: parameters needed to start a navigation on the IO thread.
  82 struct CONTENT_EXPORT BeginNavigationParams {
  83   // TODO(clamy): See if it is possible to reuse this in
  84   // ResourceMsg_Request_Params.
  85   BeginNavigationParams();
  86   BeginNavigationParams(std::string method,
  87                         std::string headers,
  88                         int load_flags,
  89                         bool has_user_gesture);
  90
  91   // The request method: GET, POST, etc.
  92   std::string method;
  93
  94   // Additional HTTP request headers.
  95   std::string headers;
  96
  97   // net::URLRequest load flags (net::LOAD_NORMAL) by default).
  98   int load_flags;
  99
 100   // True if the request was user initiated.
 101   bool has_user_gesture;
 102 };
 103
 104 // Used by FrameMsg_Navigate.
 105 // PlzNavigate: sent to the renderer when the navigation is ready to commit.
 106 struct CONTENT_EXPORT CommitNavigationParams {
 107   CommitNavigationParams();
 108   CommitNavigationParams(const PageState& page_state,
 109                          bool is_overriding_user_agent,
 110                          base::TimeTicks navigation_start);
 111   ~CommitNavigationParams();
 112
 113   // Opaque history state (received by ViewHostMsg_UpdateState).
 114   PageState page_state;
 115
 116   // Whether or not the user agent override string should be used.
 117   bool is_overriding_user_agent;
 118
 119   // The navigationStart time to expose through the Navigation Timing API to JS.
 120   base::TimeTicks browser_navigation_start;
 121
 122   // TODO(clamy): Move the redirect chain here.
 123 };
 124
 125 }  // namespace content
 126
 127 #endif  // CONTENT_COMMON_NAVIGATION_PARAMS_H_