content/browser/frame_host/navigation_entry_impl.h

   1 // Copyright 2013 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_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_
   6 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "content/browser/site_instance_impl.h"
  11 #include "content/public/browser/favicon_status.h"
  12 #include "content/public/browser/global_request_id.h"
  13 #include "content/public/browser/navigation_entry.h"
  14 #include "content/public/common/page_state.h"
  15 #include "content/public/common/ssl_status.h"
  16
  17 namespace content {
  18
  19 class CONTENT_EXPORT NavigationEntryImpl
  20     : public NON_EXPORTED_BASE(NavigationEntry) {
  21  public:
  22   static NavigationEntryImpl* FromNavigationEntry(NavigationEntry* entry);
  23
  24   // The value of bindings() before it is set during commit.
  25   static int kInvalidBindings;
  26
  27   NavigationEntryImpl();
  28   NavigationEntryImpl(SiteInstanceImpl* instance,
  29                       int page_id,
  30                       const GURL& url,
  31                       const Referrer& referrer,
  32                       const base::string16& title,
  33                       PageTransition transition_type,
  34                       bool is_renderer_initiated);
  35   virtual ~NavigationEntryImpl();
  36
  37   // NavigationEntry implementation:
  38   virtual int GetUniqueID() const OVERRIDE;
  39   virtual PageType GetPageType() const OVERRIDE;
  40   virtual void SetURL(const GURL& url) OVERRIDE;
  41   virtual const GURL& GetURL() const OVERRIDE;
  42   virtual void SetBaseURLForDataURL(const GURL& url) OVERRIDE;
  43   virtual const GURL& GetBaseURLForDataURL() const OVERRIDE;
  44   virtual void SetReferrer(const Referrer& referrer) OVERRIDE;
  45   virtual const Referrer& GetReferrer() const OVERRIDE;
  46   virtual void SetVirtualURL(const GURL& url) OVERRIDE;
  47   virtual const GURL& GetVirtualURL() const OVERRIDE;
  48   virtual void SetTitle(const base::string16& title) OVERRIDE;
  49   virtual const base::string16& GetTitle() const OVERRIDE;
  50   virtual void SetPageState(const PageState& state) OVERRIDE;
  51   virtual const PageState& GetPageState() const OVERRIDE;
  52   virtual void SetPageID(int page_id) OVERRIDE;
  53   virtual int32 GetPageID() const OVERRIDE;
  54   virtual const base::string16& GetTitleForDisplay(
  55       const std::string& languages) const OVERRIDE;
  56   virtual bool IsViewSourceMode() const OVERRIDE;
  57   virtual void SetTransitionType(PageTransition transition_type) OVERRIDE;
  58   virtual PageTransition GetTransitionType() const OVERRIDE;
  59   virtual const GURL& GetUserTypedURL() const OVERRIDE;
  60   virtual void SetHasPostData(bool has_post_data) OVERRIDE;
  61   virtual bool GetHasPostData() const OVERRIDE;
  62   virtual void SetPostID(int64 post_id) OVERRIDE;
  63   virtual int64 GetPostID() const OVERRIDE;
  64   virtual void SetBrowserInitiatedPostData(
  65       const base::RefCountedMemory* data) OVERRIDE;
  66   virtual const base::RefCountedMemory*
  67       GetBrowserInitiatedPostData() const OVERRIDE;
  68   virtual const FaviconStatus& GetFavicon() const OVERRIDE;
  69   virtual FaviconStatus& GetFavicon() OVERRIDE;
  70   virtual const SSLStatus& GetSSL() const OVERRIDE;
  71   virtual SSLStatus& GetSSL() OVERRIDE;
  72   virtual void SetOriginalRequestURL(const GURL& original_url) OVERRIDE;
  73   virtual const GURL& GetOriginalRequestURL() const OVERRIDE;
  74   virtual void SetIsOverridingUserAgent(bool override) OVERRIDE;
  75   virtual bool GetIsOverridingUserAgent() const OVERRIDE;
  76   virtual void SetTimestamp(base::Time timestamp) OVERRIDE;
  77   virtual base::Time GetTimestamp() const OVERRIDE;
  78   virtual void SetCanLoadLocalResources(bool allow) OVERRIDE;
  79   virtual bool GetCanLoadLocalResources() const OVERRIDE;
  80   virtual void SetFrameToNavigate(const std::string& frame_name) OVERRIDE;
  81   virtual const std::string& GetFrameToNavigate() const OVERRIDE;
  82   virtual void SetExtraData(const std::string& key,
  83                             const base::string16& data) OVERRIDE;
  84   virtual bool GetExtraData(const std::string& key,
  85                             base::string16* data) const OVERRIDE;
  86   virtual void ClearExtraData(const std::string& key) OVERRIDE;
  87   virtual void SetHttpStatusCode(int http_status_code) OVERRIDE;
  88   virtual int GetHttpStatusCode() const OVERRIDE;
  89   virtual void SetRedirectChain(const std::vector<GURL>& redirects) OVERRIDE;
  90   virtual const std::vector<GURL>& GetRedirectChain() const OVERRIDE;
  91   virtual bool IsRestored() const OVERRIDE;
  92
  93   // Once a navigation entry is committed, we should no longer track several
  94   // pieces of non-persisted state, as documented on the members below.
  95   void ResetForCommit();
  96
  97   void set_unique_id(int unique_id) {
  98     unique_id_ = unique_id;
  99   }
 100
 101   // The SiteInstance tells us how to share sub-processes. This is a reference
 102   // counted pointer to a shared site instance.
 103   //
 104   // Note that the SiteInstance should usually not be changed after it is set,
 105   // but this may happen if the NavigationEntry was cloned and needs to use a
 106   // different SiteInstance.
 107   void set_site_instance(SiteInstanceImpl* site_instance);
 108   SiteInstanceImpl* site_instance() const {
 109     return site_instance_.get();
 110   }
 111
 112   // Remember the set of bindings granted to this NavigationEntry at the time
 113   // of commit, to ensure that we do not grant it additional bindings if we
 114   // navigate back to it in the future.  This can only be changed once.
 115   void SetBindings(int bindings);
 116   int bindings() const {
 117     return bindings_;
 118   }
 119
 120   void set_page_type(PageType page_type) {
 121     page_type_ = page_type;
 122   }
 123
 124   bool has_virtual_url() const {
 125     return !virtual_url_.is_empty();
 126   }
 127
 128   bool update_virtual_url_with_url() const {
 129     return update_virtual_url_with_url_;
 130   }
 131   void set_update_virtual_url_with_url(bool update) {
 132     update_virtual_url_with_url_ = update;
 133   }
 134
 135   // Extra headers (separated by \n) to send during the request.
 136   void set_extra_headers(const std::string& extra_headers) {
 137     extra_headers_ = extra_headers;
 138   }
 139   const std::string& extra_headers() const {
 140     return extra_headers_;
 141   }
 142
 143   // Whether this (pending) navigation is renderer-initiated.  Resets to false
 144   // for all types of navigations after commit.
 145   void set_is_renderer_initiated(bool is_renderer_initiated) {
 146     is_renderer_initiated_ = is_renderer_initiated;
 147   }
 148   bool is_renderer_initiated() const {
 149     return is_renderer_initiated_;
 150   }
 151
 152   void set_user_typed_url(const GURL& user_typed_url) {
 153     user_typed_url_ = user_typed_url;
 154   }
 155
 156   // Enumerations of the possible restore types.
 157   enum RestoreType {
 158     // Restore from the previous session.
 159     RESTORE_LAST_SESSION_EXITED_CLEANLY,
 160     RESTORE_LAST_SESSION_CRASHED,
 161
 162     // The entry has been restored from the current session. This is used when
 163     // the user issues 'reopen closed tab'.
 164     RESTORE_CURRENT_SESSION,
 165
 166     // The entry was not restored.
 167     RESTORE_NONE
 168   };
 169
 170   // The RestoreType for this entry. This is set if the entry was retored. This
 171   // is set to RESTORE_NONE once the entry is loaded.
 172   void set_restore_type(RestoreType type) {
 173     restore_type_ = type;
 174   }
 175   RestoreType restore_type() const {
 176     return restore_type_;
 177   }
 178
 179   void set_transferred_global_request_id(
 180       const GlobalRequestID& transferred_global_request_id) {
 181     transferred_global_request_id_ = transferred_global_request_id;
 182   }
 183
 184   GlobalRequestID transferred_global_request_id() const {
 185     return transferred_global_request_id_;
 186   }
 187
 188   // Whether this (pending) navigation needs to replace current entry.
 189   // Resets to false after commit.
 190   bool should_replace_entry() const {
 191     return should_replace_entry_;
 192   }
 193
 194   void set_should_replace_entry(bool should_replace_entry) {
 195     should_replace_entry_ = should_replace_entry;
 196   }
 197
 198   void SetScreenshotPNGData(scoped_refptr<base::RefCountedBytes> png_data);
 199   const scoped_refptr<base::RefCountedBytes> screenshot() const {
 200     return screenshot_;
 201   }
 202
 203   // Whether this (pending) navigation should clear the session history. Resets
 204   // to false after commit.
 205   bool should_clear_history_list() const {
 206     return should_clear_history_list_;
 207   }
 208   void set_should_clear_history_list(bool should_clear_history_list) {
 209     should_clear_history_list_ = should_clear_history_list;
 210   }
 211
 212   // Indicates which FrameTreeNode to navigate.  Currently only used if the
 213   // --site-per-process flag is passed.
 214   int64 frame_tree_node_id() const {
 215     return frame_tree_node_id_;
 216   }
 217   void set_frame_tree_node_id(int64 frame_tree_node_id) {
 218     frame_tree_node_id_ = frame_tree_node_id;
 219   }
 220
 221  private:
 222   // WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 223   // Session/Tab restore save portions of this class so that it can be recreated
 224   // later. If you add a new field that needs to be persisted you'll have to
 225   // update SessionService/TabRestoreService and Android WebView
 226   // state_serializer.cc appropriately.
 227   // WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 228
 229   // See the accessors above for descriptions.
 230   int unique_id_;
 231   scoped_refptr<SiteInstanceImpl> site_instance_;
 232   // TODO(creis): Persist bindings_. http://crbug.com/173672.
 233   int bindings_;
 234   PageType page_type_;
 235   GURL url_;
 236   Referrer referrer_;
 237   GURL virtual_url_;
 238   bool update_virtual_url_with_url_;
 239   base::string16 title_;
 240   FaviconStatus favicon_;
 241   PageState page_state_;
 242   int32 page_id_;
 243   SSLStatus ssl_;
 244   PageTransition transition_type_;
 245   GURL user_typed_url_;
 246   bool has_post_data_;
 247   int64 post_id_;
 248   RestoreType restore_type_;
 249   GURL original_request_url_;
 250   bool is_overriding_user_agent_;
 251   base::Time timestamp_;
 252   int http_status_code_;
 253
 254   // This member is not persisted with session restore because it is transient.
 255   // If the post request succeeds, this field is cleared since the same
 256   // information is stored in |content_state_| above. It is also only shallow
 257   // copied with compiler provided copy constructor.
 258   // Cleared in |ResetForCommit|.
 259   scoped_refptr<const base::RefCountedMemory> browser_initiated_post_data_;
 260
 261   // This is also a transient member (i.e. is not persisted with session
 262   // restore). The screenshot of a page is taken when navigating away from the
 263   // page. This screenshot is displayed during an overscroll-navigation
 264   // gesture. |screenshot_| will be NULL when the screenshot is not available
 265   // (e.g. after a session restore, or if taking the screenshot of a page
 266   // failed). The UI is responsible for dealing with missing screenshots
 267   // appropriately (e.g. display a placeholder image instead).
 268   scoped_refptr<base::RefCountedBytes> screenshot_;
 269
 270   // This member is not persisted with session restore.
 271   std::string extra_headers_;
 272
 273   // Used for specifying base URL for pages loaded via data URLs. Only used and
 274   // persisted by Android WebView.
 275   GURL base_url_for_data_url_;
 276
 277   // Whether the entry, while loading, was created for a renderer-initiated
 278   // navigation.  This dictates whether the URL should be displayed before the
 279   // navigation commits.  It is cleared in |ResetForCommit| and not persisted.
 280   bool is_renderer_initiated_;
 281
 282   // This is a cached version of the result of GetTitleForDisplay. It prevents
 283   // us from having to do URL formatting on the URL every time the title is
 284   // displayed. When the URL, virtual URL, or title is set, this should be
 285   // cleared to force a refresh.
 286   mutable base::string16 cached_display_title_;
 287
 288   // In case a navigation is transferred to a new RVH but the request has
 289   // been generated in the renderer already, this identifies the old request so
 290   // that it can be resumed. The old request is stored until the
 291   // ResourceDispatcher receives the navigation from the renderer which
 292   // carries this |transferred_global_request_id_| annotation. Once the request
 293   // is transferred to the new process, this is cleared and the request
 294   // continues as normal.
 295   // Cleared in |ResetForCommit|.
 296   GlobalRequestID transferred_global_request_id_;
 297
 298   // This is set to true when this entry is being reloaded and due to changes in
 299   // the state of the URL, it has to be reloaded in a different site instance.
 300   // In such case, we must treat it as an existing navigation in the new site
 301   // instance, instead of a new navigation. This value should not be persisted
 302   // and is cleared in |ResetForCommit|.
 303   //
 304   // We also use this flag for cross-process redirect navigations, so that the
 305   // browser will replace the current navigation entry (which is the page
 306   // doing the redirect).
 307   bool should_replace_entry_;
 308
 309   // This is used when transferring a pending entry from one process to another.
 310   // We also send this data through session sync for offline analysis.
 311   // It is preserved after commit but should not be persisted.
 312   std::vector<GURL> redirect_chain_;
 313
 314   // This is set to true when this entry's navigation should clear the session
 315   // history both on the renderer and browser side. The browser side history
 316   // won't be cleared until the renderer has committed this navigation. This
 317   // entry is not persisted by the session restore system, as it is always
 318   // cleared in |ResetForCommit|.
 319   bool should_clear_history_list_;
 320
 321   // Set when this entry should be able to access local file:// resources. This
 322   // value is not needed after the entry commits and is not persisted.
 323   bool can_load_local_resources_;
 324
 325   // If not empty, the name of the frame to navigate. This field is not
 326   // persisted, because it is currently only used in tests.
 327   std::string frame_to_navigate_;
 328
 329   // If not -1, this indicates which FrameTreeNode to navigate.  This field is
 330   // not persisted because it is experimental and only used when the
 331   // --site-per-process flag is passed.  It is cleared in |ResetForCommit|
 332   // because we only use it while the navigation is pending.
 333   // TODO(creis): Move this to FrameNavigationEntry.
 334   int64 frame_tree_node_id_;
 335
 336   // Used to store extra data to support browser features. This member is not
 337   // persisted, unless specific data is taken out/put back in at save/restore
 338   // time (see TabNavigation for an example of this).
 339   std::map<std::string, base::string16> extra_data_;
 340
 341   // Copy and assignment is explicitly allowed for this class.
 342 };
 343
 344 }  // namespace content
 345
 346 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_