content/browser/frame_host/navigation_entry_impl.cc

   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 #include "content/browser/frame_host/navigation_entry_impl.h"
   6
   7 #include "base/metrics/histogram.h"
   8 #include "base/strings/string_util.h"
   9 #include "base/strings/utf_string_conversions.h"
  10 #include "content/public/common/content_constants.h"
  11 #include "content/public/common/url_constants.h"
  12 #include "net/base/net_util.h"
  13 #include "ui/gfx/text_elider.h"
  14
  15 // Use this to get a new unique ID for a NavigationEntry during construction.
  16 // The returned ID is guaranteed to be nonzero (which is the "no ID" indicator).
  17 static int GetUniqueIDInConstructor() {
  18   static int unique_id_counter = 0;
  19   return ++unique_id_counter;
  20 }
  21
  22 namespace content {
  23
  24 int NavigationEntryImpl::kInvalidBindings = -1;
  25
  26 NavigationEntry* NavigationEntry::Create() {
  27   return new NavigationEntryImpl();
  28 }
  29
  30 NavigationEntry* NavigationEntry::Create(const NavigationEntry& copy) {
  31   return new NavigationEntryImpl(static_cast<const NavigationEntryImpl&>(copy));
  32 }
  33
  34 NavigationEntryImpl* NavigationEntryImpl::FromNavigationEntry(
  35     NavigationEntry* entry) {
  36   return static_cast<NavigationEntryImpl*>(entry);
  37 }
  38
  39 NavigationEntryImpl::NavigationEntryImpl()
  40     : NavigationEntryImpl(nullptr, -1, GURL(), Referrer(), base::string16(),
  41                           ui::PAGE_TRANSITION_LINK, false) {
  42 }
  43
  44 NavigationEntryImpl::NavigationEntryImpl(SiteInstanceImpl* instance,
  45                                          int page_id,
  46                                          const GURL& url,
  47                                          const Referrer& referrer,
  48                                          const base::string16& title,
  49                                          ui::PageTransition transition_type,
  50                                          bool is_renderer_initiated)
  51     : frame_entry_(instance, url, referrer),
  52       unique_id_(GetUniqueIDInConstructor()),
  53       bindings_(kInvalidBindings),
  54       page_type_(PAGE_TYPE_NORMAL),
  55       update_virtual_url_with_url_(false),
  56       title_(title),
  57       page_id_(page_id),
  58       transition_type_(transition_type),
  59       has_post_data_(false),
  60       post_id_(-1),
  61       restore_type_(RESTORE_NONE),
  62       is_overriding_user_agent_(false),
  63       http_status_code_(0),
  64       is_renderer_initiated_(is_renderer_initiated),
  65       should_replace_entry_(false),
  66       should_clear_history_list_(false),
  67       can_load_local_resources_(false),
  68       frame_tree_node_id_(-1) {
  69 }
  70
  71 NavigationEntryImpl::~NavigationEntryImpl() {
  72 }
  73
  74 int NavigationEntryImpl::GetUniqueID() const {
  75   return unique_id_;
  76 }
  77
  78 PageType NavigationEntryImpl::GetPageType() const {
  79   return page_type_;
  80 }
  81
  82 void NavigationEntryImpl::SetURL(const GURL& url) {
  83   frame_entry_.set_url(url);
  84   cached_display_title_.clear();
  85 }
  86
  87 const GURL& NavigationEntryImpl::GetURL() const {
  88   return frame_entry_.url();
  89 }
  90
  91 void NavigationEntryImpl::SetBaseURLForDataURL(const GURL& url) {
  92   base_url_for_data_url_ = url;
  93 }
  94
  95 const GURL& NavigationEntryImpl::GetBaseURLForDataURL() const {
  96   return base_url_for_data_url_;
  97 }
  98
  99 void NavigationEntryImpl::SetReferrer(const Referrer& referrer) {
 100   frame_entry_.set_referrer(referrer);
 101 }
 102
 103 const Referrer& NavigationEntryImpl::GetReferrer() const {
 104   return frame_entry_.referrer();
 105 }
 106
 107 void NavigationEntryImpl::SetVirtualURL(const GURL& url) {
 108   virtual_url_ = (url == GetURL()) ? GURL() : url;
 109   cached_display_title_.clear();
 110 }
 111
 112 const GURL& NavigationEntryImpl::GetVirtualURL() const {
 113   return virtual_url_.is_empty() ? GetURL() : virtual_url_;
 114 }
 115
 116 void NavigationEntryImpl::SetTitle(const base::string16& title) {
 117   title_ = title;
 118   cached_display_title_.clear();
 119 }
 120
 121 const base::string16& NavigationEntryImpl::GetTitle() const {
 122   return title_;
 123 }
 124
 125 void NavigationEntryImpl::SetPageState(const PageState& state) {
 126   page_state_ = state;
 127 }
 128
 129 const PageState& NavigationEntryImpl::GetPageState() const {
 130   return page_state_;
 131 }
 132
 133 void NavigationEntryImpl::SetPageID(int page_id) {
 134   page_id_ = page_id;
 135 }
 136
 137 int32 NavigationEntryImpl::GetPageID() const {
 138   return page_id_;
 139 }
 140
 141 void NavigationEntryImpl::set_site_instance(SiteInstanceImpl* site_instance) {
 142   frame_entry_.set_site_instance(site_instance);
 143 }
 144
 145 void NavigationEntryImpl::set_source_site_instance(
 146     SiteInstanceImpl* source_site_instance) {
 147   source_site_instance_ = source_site_instance;
 148 }
 149
 150 void NavigationEntryImpl::SetBindings(int bindings) {
 151   // Ensure this is set to a valid value, and that it stays the same once set.
 152   CHECK_NE(bindings, kInvalidBindings);
 153   CHECK(bindings_ == kInvalidBindings || bindings_ == bindings);
 154   bindings_ = bindings;
 155 }
 156
 157 const base::string16& NavigationEntryImpl::GetTitleForDisplay(
 158     const std::string& languages) const {
 159   // Most pages have real titles. Don't even bother caching anything if this is
 160   // the case.
 161   if (!title_.empty())
 162     return title_;
 163
 164   // More complicated cases will use the URLs as the title. This result we will
 165   // cache since it's more complicated to compute.
 166   if (!cached_display_title_.empty())
 167     return cached_display_title_;
 168
 169   // Use the virtual URL first if any, and fall back on using the real URL.
 170   base::string16 title;
 171   if (!virtual_url_.is_empty()) {
 172     title = net::FormatUrl(virtual_url_, languages);
 173   } else if (!GetURL().is_empty()) {
 174     title = net::FormatUrl(GetURL(), languages);
 175   }
 176
 177   // For file:// URLs use the filename as the title, not the full path.
 178   if (GetURL().SchemeIsFile()) {
 179     base::string16::size_type slashpos = title.rfind('/');
 180     if (slashpos != base::string16::npos)
 181       title = title.substr(slashpos + 1);
 182   }
 183
 184   gfx::ElideString(title, kMaxTitleChars, &cached_display_title_);
 185   return cached_display_title_;
 186 }
 187
 188 bool NavigationEntryImpl::IsViewSourceMode() const {
 189   return virtual_url_.SchemeIs(kViewSourceScheme);
 190 }
 191
 192 void NavigationEntryImpl::SetTransitionType(
 193     ui::PageTransition transition_type) {
 194   transition_type_ = transition_type;
 195 }
 196
 197 ui::PageTransition NavigationEntryImpl::GetTransitionType() const {
 198   return transition_type_;
 199 }
 200
 201 const GURL& NavigationEntryImpl::GetUserTypedURL() const {
 202   return user_typed_url_;
 203 }
 204
 205 void NavigationEntryImpl::SetHasPostData(bool has_post_data) {
 206   has_post_data_ = has_post_data;
 207 }
 208
 209 bool NavigationEntryImpl::GetHasPostData() const {
 210   return has_post_data_;
 211 }
 212
 213 void NavigationEntryImpl::SetPostID(int64 post_id) {
 214   post_id_ = post_id;
 215 }
 216
 217 int64 NavigationEntryImpl::GetPostID() const {
 218   return post_id_;
 219 }
 220
 221 void NavigationEntryImpl::SetBrowserInitiatedPostData(
 222     const base::RefCountedMemory* data) {
 223   browser_initiated_post_data_ = data;
 224 }
 225
 226 const base::RefCountedMemory*
 227 NavigationEntryImpl::GetBrowserInitiatedPostData() const {
 228   return browser_initiated_post_data_.get();
 229 }
 230
 231
 232 const FaviconStatus& NavigationEntryImpl::GetFavicon() const {
 233   return favicon_;
 234 }
 235
 236 FaviconStatus& NavigationEntryImpl::GetFavicon() {
 237   return favicon_;
 238 }
 239
 240 const SSLStatus& NavigationEntryImpl::GetSSL() const {
 241   return ssl_;
 242 }
 243
 244 SSLStatus& NavigationEntryImpl::GetSSL() {
 245   return ssl_;
 246 }
 247
 248 void NavigationEntryImpl::SetOriginalRequestURL(const GURL& original_url) {
 249   original_request_url_ = original_url;
 250 }
 251
 252 const GURL& NavigationEntryImpl::GetOriginalRequestURL() const {
 253   return original_request_url_;
 254 }
 255
 256 void NavigationEntryImpl::SetIsOverridingUserAgent(bool override) {
 257   is_overriding_user_agent_ = override;
 258 }
 259
 260 bool NavigationEntryImpl::GetIsOverridingUserAgent() const {
 261   return is_overriding_user_agent_;
 262 }
 263
 264 void NavigationEntryImpl::SetTimestamp(base::Time timestamp) {
 265   timestamp_ = timestamp;
 266 }
 267
 268 base::Time NavigationEntryImpl::GetTimestamp() const {
 269   return timestamp_;
 270 }
 271
 272 void NavigationEntryImpl::SetHttpStatusCode(int http_status_code) {
 273   http_status_code_ = http_status_code;
 274 }
 275
 276 int NavigationEntryImpl::GetHttpStatusCode() const {
 277   return http_status_code_;
 278 }
 279
 280 void NavigationEntryImpl::SetRedirectChain(
 281     const std::vector<GURL>& redirect_chain) {
 282   redirect_chain_ = redirect_chain;
 283 }
 284
 285 const std::vector<GURL>& NavigationEntryImpl::GetRedirectChain() const {
 286   return redirect_chain_;
 287 }
 288
 289 bool NavigationEntryImpl::IsRestored() const {
 290   return restore_type_ != RESTORE_NONE;
 291 }
 292
 293 void NavigationEntryImpl::SetCanLoadLocalResources(bool allow) {
 294   can_load_local_resources_ = allow;
 295 }
 296
 297 bool NavigationEntryImpl::GetCanLoadLocalResources() const {
 298   return can_load_local_resources_;
 299 }
 300
 301 void NavigationEntryImpl::SetFrameToNavigate(const std::string& frame_name) {
 302   frame_to_navigate_ = frame_name;
 303 }
 304
 305 const std::string& NavigationEntryImpl::GetFrameToNavigate() const {
 306   return frame_to_navigate_;
 307 }
 308
 309 void NavigationEntryImpl::SetExtraData(const std::string& key,
 310                                        const base::string16& data) {
 311   extra_data_[key] = data;
 312 }
 313
 314 bool NavigationEntryImpl::GetExtraData(const std::string& key,
 315                                        base::string16* data) const {
 316   std::map<std::string, base::string16>::const_iterator iter =
 317       extra_data_.find(key);
 318   if (iter == extra_data_.end())
 319     return false;
 320   *data = iter->second;
 321   return true;
 322 }
 323
 324 void NavigationEntryImpl::ClearExtraData(const std::string& key) {
 325   extra_data_.erase(key);
 326 }
 327
 328 void NavigationEntryImpl::ResetForCommit() {
 329   // Any state that only matters when a navigation entry is pending should be
 330   // cleared here.
 331   SetBrowserInitiatedPostData(nullptr);
 332   set_is_renderer_initiated(false);
 333   set_transferred_global_request_id(GlobalRequestID());
 334   set_should_replace_entry(false);
 335
 336   set_should_clear_history_list(false);
 337   set_frame_tree_node_id(-1);
 338   set_source_site_instance(nullptr);
 339
 340 #if defined(OS_ANDROID)
 341   // Reset the time stamp so that the metrics are not reported if this entry is
 342   // loaded again in the future.
 343   set_intent_received_timestamp(base::TimeTicks());
 344 #endif
 345 }
 346
 347 void NavigationEntryImpl::SetScreenshotPNGData(
 348     scoped_refptr<base::RefCountedBytes> png_data) {
 349   screenshot_ = png_data;
 350   if (screenshot_.get())
 351     UMA_HISTOGRAM_MEMORY_KB("Overscroll.ScreenshotSize", screenshot_->size());
 352 }
 353
 354 GURL NavigationEntryImpl::GetHistoryURLForDataURL() const {
 355   return GetBaseURLForDataURL().is_empty() ? GURL() : GetVirtualURL();
 356 }
 357
 358 }  // namespace content