blob: 1ee7492bdbaec2b5761e20ebfd192e1d4942e3b8 [file] [log] [blame]
[email protected]7f070d42011-03-09 20:25:321// Copyright (c) 2011 The Chromium Authors. All rights reserved.
license.botbf09a502008-08-24 00:55:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit09911bf2008-07-26 23:55:294
[email protected]0dd3a0ab2011-02-18 08:17:445#include "content/browser/tab_contents/navigation_controller.h"
initial.commit09911bf2008-07-26 23:55:296
initial.commit09911bf2008-07-26 23:55:297#include "base/file_util.h"
8#include "base/logging.h"
9#include "base/string_util.h"
[email protected]b689fce72009-03-17 22:45:3410#include "base/time.h"
[email protected]252cad62010-08-18 18:33:5711#include "base/utf_string_conversions.h"
[email protected]3d7474ff2011-07-27 17:47:3712#include "content/browser/browser_context.h"
[email protected]b8148ac2011-07-13 22:03:2513#include "content/browser/browser_url_handler.h"
[email protected]419a0572011-04-18 22:21:4614#include "content/browser/child_process_security_policy.h"
[email protected]567812d2011-02-24 17:40:5015#include "content/browser/in_process_webkit/session_storage_namespace.h"
16#include "content/browser/site_instance.h"
[email protected]0dd3a0ab2011-02-18 08:17:4417#include "content/browser/tab_contents/interstitial_page.h"
[email protected]8286f51a2011-05-31 17:39:1318#include "content/browser/tab_contents/navigation_details.h"
[email protected]0dd3a0ab2011-02-18 08:17:4419#include "content/browser/tab_contents/navigation_entry.h"
20#include "content/browser/tab_contents/tab_contents.h"
21#include "content/browser/tab_contents/tab_contents_delegate.h"
[email protected]485e8232011-07-24 18:03:4622#include "content/browser/user_metrics.h"
[email protected]9966325b2011-04-18 05:00:1023#include "content/common/content_constants.h"
[email protected]4dd57932011-03-17 06:06:1224#include "content/common/navigation_types.h"
[email protected]7f070d42011-03-09 20:25:3225#include "content/common/notification_service.h"
[email protected]0aed2f52011-03-23 18:06:3626#include "content/common/view_messages.h"
[email protected]a23de8572009-06-03 02:16:3227#include "net/base/escape.h"
[email protected]31682282010-01-15 18:05:1628#include "net/base/mime_util.h"
[email protected]7f070d42011-03-09 20:25:3229#include "net/base/net_util.h"
[email protected]765b35502008-08-21 00:51:2030#include "webkit/glue/webkit_glue.h"
initial.commit09911bf2008-07-26 23:55:2931
[email protected]e9ba4472008-09-14 15:42:4332namespace {
33
[email protected]93f230e02011-06-01 14:40:0034const int kInvalidateAll = 0xFFFFFFFF;
[email protected]8030f012009-09-25 18:09:3735
[email protected]e9ba4472008-09-14 15:42:4336// Invoked when entries have been pruned, or removed. For example, if the
37// current entries are [google, digg, yahoo], with the current entry google,
38// and the user types in cnet, then digg and yahoo are pruned.
[email protected]c12bf1a12008-09-17 16:28:4939void NotifyPrunedEntries(NavigationController* nav_controller,
40 bool from_front,
41 int count) {
[email protected]8286f51a2011-05-31 17:39:1342 content::PrunedDetails details;
[email protected]c12bf1a12008-09-17 16:28:4943 details.from_front = from_front;
44 details.count = count;
[email protected]e9ba4472008-09-14 15:42:4345 NotificationService::current()->Notify(
[email protected]432115822011-07-10 15:52:2746 content::NOTIFICATION_NAV_LIST_PRUNED,
[email protected]e9ba4472008-09-14 15:42:4347 Source<NavigationController>(nav_controller),
[email protected]8286f51a2011-05-31 17:39:1348 Details<content::PrunedDetails>(&details));
[email protected]e9ba4472008-09-14 15:42:4349}
50
51// Ensure the given NavigationEntry has a valid state, so that WebKit does not
52// get confused if we navigate back to it.
[email protected]40bcc302009-03-02 20:50:3953//
[email protected]e9ba4472008-09-14 15:42:4354// An empty state is treated as a new navigation by WebKit, which would mean
55// losing the navigation entries and generating a new navigation entry after
56// this one. We don't want that. To avoid this we create a valid state which
57// WebKit will not treat as a new navigation.
58void SetContentStateIfEmpty(NavigationEntry* entry) {
[email protected]965524b2009-04-04 21:32:4059 if (entry->content_state().empty()) {
[email protected]e9ba4472008-09-14 15:42:4360 entry->set_content_state(
61 webkit_glue::CreateHistoryStateForURL(entry->url()));
62 }
63}
64
65// Configure all the NavigationEntries in entries for restore. This resets
66// the transition type to reload and makes sure the content state isn't empty.
67void ConfigureEntriesForRestore(
[email protected]5e369672009-11-03 23:48:3068 std::vector<linked_ptr<NavigationEntry> >* entries,
69 bool from_last_session) {
[email protected]e9ba4472008-09-14 15:42:4370 for (size_t i = 0; i < entries->size(); ++i) {
71 // Use a transition type of reload so that we don't incorrectly increase
72 // the typed count.
73 (*entries)[i]->set_transition_type(PageTransition::RELOAD);
[email protected]5e369672009-11-03 23:48:3074 (*entries)[i]->set_restore_type(from_last_session ?
75 NavigationEntry::RESTORE_LAST_SESSION :
76 NavigationEntry::RESTORE_CURRENT_SESSION);
[email protected]e9ba4472008-09-14 15:42:4377 // NOTE(darin): This code is only needed for backwards compat.
78 SetContentStateIfEmpty((*entries)[i].get());
79 }
80}
81
82// See NavigationController::IsURLInPageNavigation for how this works and why.
83bool AreURLsInPageNavigation(const GURL& existing_url, const GURL& new_url) {
[email protected]192d8c5e2010-02-23 07:26:3284 if (existing_url == new_url || !new_url.has_ref()) {
85 // TODO(jcampan): what about when navigating back from a ref URL to the top
86 // non ref URL? Nothing is loaded in that case but we return false here.
87 // The user could also navigate from the ref URL to the non ref URL by
88 // entering the non ref URL in the location bar or through a bookmark, in
89 // which case there would be a load. I am not sure if the non-load/load
90 // scenarios can be differentiated with the TransitionType.
[email protected]e9ba4472008-09-14 15:42:4391 return false;
[email protected]192d8c5e2010-02-23 07:26:3292 }
[email protected]e9ba4472008-09-14 15:42:4393
94 url_canon::Replacements<char> replacements;
95 replacements.ClearRef();
96 return existing_url.ReplaceComponents(replacements) ==
97 new_url.ReplaceComponents(replacements);
98}
99
100} // namespace
101
initial.commit09911bf2008-07-26 23:55:29102// NavigationController ---------------------------------------------------
103
[email protected]765b35502008-08-21 00:51:20104// static
[email protected]3cc72b12010-03-18 23:03:00105size_t NavigationController::max_entry_count_ =
[email protected]9966325b2011-04-18 05:00:10106 content::kMaxSessionHistoryEntries;
[email protected]765b35502008-08-21 00:51:20107
initial.commit09911bf2008-07-26 23:55:29108// static
109bool NavigationController::check_for_repost_ = true;
110
[email protected]6ee12c42010-09-14 09:36:07111NavigationController::NavigationController(
112 TabContents* contents,
[email protected]3d7474ff2011-07-27 17:47:37113 content::BrowserContext* browser_context,
[email protected]6ee12c42010-09-14 09:36:07114 SessionStorageNamespace* session_storage_namespace)
[email protected]3d7474ff2011-07-27 17:47:37115 : browser_context_(browser_context),
[email protected]765b35502008-08-21 00:51:20116 pending_entry_(NULL),
117 last_committed_entry_index_(-1),
118 pending_entry_index_(-1),
[email protected]cbab76d2008-10-13 22:42:47119 transient_entry_index_(-1),
[email protected]9423d9412009-04-14 22:13:55120 tab_contents_(contents),
initial.commit09911bf2008-07-26 23:55:29121 max_restored_page_id_(-1),
[email protected]5d063842009-05-15 04:08:24122 ALLOW_THIS_IN_INITIALIZER_LIST(ssl_manager_(this)),
[email protected]38b8f4e2009-09-24 19:44:57123 needs_reload_(false),
[email protected]6ee12c42010-09-14 09:36:07124 session_storage_namespace_(session_storage_namespace),
[email protected]106a0812010-03-18 00:15:12125 pending_reload_(NO_RELOAD) {
[email protected]3d7474ff2011-07-27 17:47:37126 DCHECK(browser_context_);
[email protected]228d06592011-04-01 20:38:59127 if (!session_storage_namespace_) {
128 session_storage_namespace_ = new SessionStorageNamespace(
[email protected]3d7474ff2011-07-27 17:47:37129 browser_context_->GetWebKitContext());
[email protected]228d06592011-04-01 20:38:59130 }
initial.commit09911bf2008-07-26 23:55:29131}
132
initial.commit09911bf2008-07-26 23:55:29133NavigationController::~NavigationController() {
[email protected]cbab76d2008-10-13 22:42:47134 DiscardNonCommittedEntriesInternal();
[email protected]c0993872008-08-21 19:59:44135
[email protected]bfd04a62009-02-01 18:16:56136 NotificationService::current()->Notify(
[email protected]432115822011-07-10 15:52:27137 content::NOTIFICATION_TAB_CLOSED,
[email protected]bfd04a62009-02-01 18:16:56138 Source<NavigationController>(this),
139 NotificationService::NoDetails());
initial.commit09911bf2008-07-26 23:55:29140}
141
[email protected]03838e22011-06-06 15:27:14142void NavigationController::Restore(
[email protected]5e369672009-11-03 23:48:30143 int selected_navigation,
[email protected]03838e22011-06-06 15:27:14144 bool from_last_session,
145 std::vector<NavigationEntry*>* entries) {
[email protected]ce3fa3c2009-04-20 19:55:57146 // Verify that this controller is unused and that the input is valid.
147 DCHECK(entry_count() == 0 && !pending_entry());
148 DCHECK(selected_navigation >= 0 &&
[email protected]03838e22011-06-06 15:27:14149 selected_navigation < static_cast<int>(entries->size()));
[email protected]ce3fa3c2009-04-20 19:55:57150
[email protected]ce3fa3c2009-04-20 19:55:57151 needs_reload_ = true;
[email protected]03838e22011-06-06 15:27:14152 for (size_t i = 0; i < entries->size(); ++i)
153 entries_.push_back(linked_ptr<NavigationEntry>((*entries)[i]));
154 entries->clear();
[email protected]ce3fa3c2009-04-20 19:55:57155
156 // And finish the restore.
[email protected]5e369672009-11-03 23:48:30157 FinishRestore(selected_navigation, from_last_session);
[email protected]ce3fa3c2009-04-20 19:55:57158}
159
[email protected]f1c74112008-10-30 16:17:04160void NavigationController::Reload(bool check_for_repost) {
[email protected]1ccb3568d2010-02-19 10:51:16161 ReloadInternal(check_for_repost, RELOAD);
162}
163void NavigationController::ReloadIgnoringCache(bool check_for_repost) {
164 ReloadInternal(check_for_repost, RELOAD_IGNORING_CACHE);
165}
166
167void NavigationController::ReloadInternal(bool check_for_repost,
168 ReloadType reload_type) {
[email protected]cbab76d2008-10-13 22:42:47169 // Reloading a transient entry does nothing.
170 if (transient_entry_index_ != -1)
171 return;
172
173 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:29174 int current_index = GetCurrentEntryIndex();
[email protected]106a0812010-03-18 00:15:12175 // If we are no where, then we can't reload. TODO(darin): We should add a
176 // CanReload method.
177 if (current_index == -1) {
178 return;
179 }
180
[email protected]106a0812010-03-18 00:15:12181 if (check_for_repost_ && check_for_repost &&
[email protected]a3a1d142008-12-19 00:42:30182 GetEntryAtIndex(current_index)->has_post_data()) {
183 // The user is asking to reload a page with POST data. Prompt to make sure
[email protected]b5bb35f2009-02-05 20:17:07184 // they really want to do this. If they do, the dialog will call us back
185 // with check_for_repost = false.
[email protected]965bb092010-04-09 11:59:02186 NotificationService::current()->Notify(
[email protected]432115822011-07-10 15:52:27187 content::NOTIFICATION_REPOST_WARNING_SHOWN,
[email protected]965bb092010-04-09 11:59:02188 Source<NavigationController>(this),
189 NotificationService::NoDetails());
190
[email protected]106a0812010-03-18 00:15:12191 pending_reload_ = reload_type;
[email protected]9423d9412009-04-14 22:13:55192 tab_contents_->Activate();
[email protected]14f3408a2009-08-31 20:53:53193 tab_contents_->delegate()->ShowRepostFormWarningDialog(tab_contents_);
initial.commit09911bf2008-07-26 23:55:29194 } else {
[email protected]cbab76d2008-10-13 22:42:47195 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20196
197 pending_entry_index_ = current_index;
[email protected]1e5645ff2008-08-27 18:09:07198 entries_[pending_entry_index_]->set_transition_type(PageTransition::RELOAD);
[email protected]1ccb3568d2010-02-19 10:51:16199 NavigateToPendingEntry(reload_type);
initial.commit09911bf2008-07-26 23:55:29200 }
201}
202
[email protected]106a0812010-03-18 00:15:12203void NavigationController::CancelPendingReload() {
204 DCHECK(pending_reload_ != NO_RELOAD);
205 pending_reload_ = NO_RELOAD;
206}
207
208void NavigationController::ContinuePendingReload() {
209 if (pending_reload_ == NO_RELOAD) {
210 NOTREACHED();
211 } else {
212 ReloadInternal(false, pending_reload_);
[email protected]965bb092010-04-09 11:59:02213 pending_reload_ = NO_RELOAD;
[email protected]106a0812010-03-18 00:15:12214 }
215}
216
[email protected]c70f9b82010-04-21 07:31:11217bool NavigationController::IsInitialNavigation() {
218 return last_document_loaded_.is_null();
219}
220
[email protected]b6ea7412010-05-04 23:26:47221// static
222NavigationEntry* NavigationController::CreateNavigationEntry(
223 const GURL& url, const GURL& referrer, PageTransition::Type transition,
[email protected]6c6b02d2011-09-02 03:36:47224 const std::string& extra_headers,
[email protected]3d7474ff2011-07-27 17:47:37225 content::BrowserContext* browser_context) {
[email protected]b6ea7412010-05-04 23:26:47226 // Allow the browser URL handler to rewrite the URL. This will, for example,
227 // remove "view-source:" from the beginning of the URL to get the URL that
228 // will actually be loaded. This real URL won't be shown to the user, just
229 // used internally.
230 GURL loaded_url(url);
231 bool reverse_on_redirect = false;
[email protected]f1eb87a2011-05-06 17:49:41232 BrowserURLHandler::GetInstance()->RewriteURLIfNecessary(
[email protected]3d7474ff2011-07-27 17:47:37233 &loaded_url, browser_context, &reverse_on_redirect);
[email protected]b6ea7412010-05-04 23:26:47234
235 NavigationEntry* entry = new NavigationEntry(
236 NULL, // The site instance for tabs is sent on navigation
237 // (TabContents::GetSiteInstance).
238 -1,
239 loaded_url,
240 referrer,
[email protected]6b2f7a82011-04-25 19:30:51241 string16(),
[email protected]b6ea7412010-05-04 23:26:47242 transition);
243 entry->set_virtual_url(url);
244 entry->set_user_typed_url(url);
245 entry->set_update_virtual_url_with_url(reverse_on_redirect);
[email protected]6c6b02d2011-09-02 03:36:47246 entry->set_extra_headers(extra_headers);
[email protected]b6ea7412010-05-04 23:26:47247 return entry;
248}
249
[email protected]765b35502008-08-21 00:51:20250NavigationEntry* NavigationController::GetEntryWithPageID(
[email protected]7f0005a2009-04-15 03:25:11251 SiteInstance* instance, int32 page_id) const {
252 int index = GetEntryIndexWithPageID(instance, page_id);
[email protected]765b35502008-08-21 00:51:20253 return (index != -1) ? entries_[index].get() : NULL;
254}
255
256void NavigationController::LoadEntry(NavigationEntry* entry) {
[email protected]419a0572011-04-18 22:21:46257 // Don't navigate to URLs disabled by policy. This prevents showing the URL
258 // on the Omnibar when it is also going to be blocked by
259 // ChildProcessSecurityPolicy::CanRequestURL.
260 ChildProcessSecurityPolicy *policy =
261 ChildProcessSecurityPolicy::GetInstance();
262 if (policy->IsDisabledScheme(entry->url().scheme()) ||
263 policy->IsDisabledScheme(entry->virtual_url().scheme())) {
264 VLOG(1) << "URL not loaded because the scheme is blocked by policy: "
265 << entry->url();
266 delete entry;
267 return;
268 }
269
[email protected]765b35502008-08-21 00:51:20270 // When navigating to a new page, we don't know for sure if we will actually
271 // end up leaving the current page. The new page load could for example
272 // result in a download or a 'no content' response (e.g., a mailto: URL).
[email protected]cbab76d2008-10-13 22:42:47273 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20274 pending_entry_ = entry;
275 NotificationService::current()->Notify(
[email protected]432115822011-07-10 15:52:27276 content::NOTIFICATION_NAV_ENTRY_PENDING,
[email protected]765b35502008-08-21 00:51:20277 Source<NavigationController>(this),
[email protected]6c6b02d2011-09-02 03:36:47278 Details<NavigationEntry>(entry));
[email protected]1ccb3568d2010-02-19 10:51:16279 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20280}
281
[email protected]765b35502008-08-21 00:51:20282NavigationEntry* NavigationController::GetActiveEntry() const {
[email protected]cbab76d2008-10-13 22:42:47283 if (transient_entry_index_ != -1)
284 return entries_[transient_entry_index_].get();
285 if (pending_entry_)
286 return pending_entry_;
287 return GetLastCommittedEntry();
[email protected]765b35502008-08-21 00:51:20288}
289
[email protected]867e1f92011-08-30 19:01:19290NavigationEntry* NavigationController::GetVisibleEntry() const {
291 if (transient_entry_index_ != -1)
292 return entries_[transient_entry_index_].get();
293 // Only return pending_entry for new navigations.
294 if (pending_entry_ && pending_entry_->page_id() == -1)
295 return pending_entry_;
296 return GetLastCommittedEntry();
297}
298
[email protected]765b35502008-08-21 00:51:20299int NavigationController::GetCurrentEntryIndex() const {
[email protected]cbab76d2008-10-13 22:42:47300 if (transient_entry_index_ != -1)
301 return transient_entry_index_;
[email protected]765b35502008-08-21 00:51:20302 if (pending_entry_index_ != -1)
303 return pending_entry_index_;
304 return last_committed_entry_index_;
305}
306
307NavigationEntry* NavigationController::GetLastCommittedEntry() const {
308 if (last_committed_entry_index_ == -1)
309 return NULL;
310 return entries_[last_committed_entry_index_].get();
311}
312
[email protected]31682282010-01-15 18:05:16313bool NavigationController::CanViewSource() const {
314 bool is_supported_mime_type = net::IsSupportedNonImageMimeType(
315 tab_contents_->contents_mime_type().c_str());
316 NavigationEntry* active_entry = GetActiveEntry();
317 return active_entry && !active_entry->IsViewSourceMode() &&
318 is_supported_mime_type;
319}
320
[email protected]765b35502008-08-21 00:51:20321NavigationEntry* NavigationController::GetEntryAtOffset(int offset) const {
[email protected]cbab76d2008-10-13 22:42:47322 int index = (transient_entry_index_ != -1) ?
323 transient_entry_index_ + offset :
324 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11325 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20326 return NULL;
327
328 return entries_[index].get();
329}
330
[email protected]765b35502008-08-21 00:51:20331bool NavigationController::CanGoBack() const {
332 return entries_.size() > 1 && GetCurrentEntryIndex() > 0;
333}
334
335bool NavigationController::CanGoForward() const {
336 int index = GetCurrentEntryIndex();
337 return index >= 0 && index < (static_cast<int>(entries_.size()) - 1);
338}
339
340void NavigationController::GoBack() {
341 if (!CanGoBack()) {
342 NOTREACHED();
343 return;
344 }
345
[email protected]25396da2010-03-11 19:19:10346 // If an interstitial page is showing, going back is equivalent to hiding the
347 // interstitial.
348 if (tab_contents_->interstitial_page()) {
349 tab_contents_->interstitial_page()->DontProceed();
350 return;
351 }
352
[email protected]765b35502008-08-21 00:51:20353 // Base the navigation on where we are now...
354 int current_index = GetCurrentEntryIndex();
355
[email protected]cbab76d2008-10-13 22:42:47356 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20357
358 pending_entry_index_ = current_index - 1;
[email protected]784688a62010-09-13 07:06:52359 entries_[pending_entry_index_]->set_transition_type(
360 entries_[pending_entry_index_]->transition_type() |
361 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16362 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20363}
364
365void NavigationController::GoForward() {
366 if (!CanGoForward()) {
367 NOTREACHED();
368 return;
369 }
370
[email protected]25396da2010-03-11 19:19:10371 // If an interstitial page is showing, the previous renderer is blocked and
372 // cannot make new requests. Unblock (and disable) it to allow this
373 // navigation to succeed. The interstitial will stay visible until the
374 // resulting DidNavigate.
375 if (tab_contents_->interstitial_page()) {
376 tab_contents_->interstitial_page()->CancelForNavigation();
377 }
378
[email protected]cbab76d2008-10-13 22:42:47379 bool transient = (transient_entry_index_ != -1);
380
[email protected]765b35502008-08-21 00:51:20381 // Base the navigation on where we are now...
382 int current_index = GetCurrentEntryIndex();
383
[email protected]cbab76d2008-10-13 22:42:47384 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20385
[email protected]cbab76d2008-10-13 22:42:47386 pending_entry_index_ = current_index;
387 // If there was a transient entry, we removed it making the current index
388 // the next page.
389 if (!transient)
390 pending_entry_index_++;
391
[email protected]784688a62010-09-13 07:06:52392 entries_[pending_entry_index_]->set_transition_type(
393 entries_[pending_entry_index_]->transition_type() |
394 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16395 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20396}
397
398void NavigationController::GoToIndex(int index) {
399 if (index < 0 || index >= static_cast<int>(entries_.size())) {
400 NOTREACHED();
401 return;
402 }
403
[email protected]cbab76d2008-10-13 22:42:47404 if (transient_entry_index_ != -1) {
405 if (index == transient_entry_index_) {
406 // Nothing to do when navigating to the transient.
407 return;
408 }
409 if (index > transient_entry_index_) {
410 // Removing the transient is goint to shift all entries by 1.
411 index--;
412 }
413 }
414
[email protected]25396da2010-03-11 19:19:10415 // If an interstitial page is showing, the previous renderer is blocked and
416 // cannot make new requests.
417 if (tab_contents_->interstitial_page()) {
418 if (index == GetCurrentEntryIndex() - 1) {
419 // Going back one entry is equivalent to hiding the interstitial.
420 tab_contents_->interstitial_page()->DontProceed();
421 return;
422 } else {
423 // Unblock the renderer (and disable the interstitial) to allow this
424 // navigation to succeed. The interstitial will stay visible until the
425 // resulting DidNavigate.
426 tab_contents_->interstitial_page()->CancelForNavigation();
427 }
428 }
429
[email protected]cbab76d2008-10-13 22:42:47430 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20431
432 pending_entry_index_ = index;
[email protected]784688a62010-09-13 07:06:52433 entries_[pending_entry_index_]->set_transition_type(
434 entries_[pending_entry_index_]->transition_type() |
435 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16436 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20437}
438
439void NavigationController::GoToOffset(int offset) {
[email protected]cbab76d2008-10-13 22:42:47440 int index = (transient_entry_index_ != -1) ?
441 transient_entry_index_ + offset :
442 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11443 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20444 return;
445
446 GoToIndex(index);
447}
448
[email protected]cbab76d2008-10-13 22:42:47449void NavigationController::RemoveEntryAtIndex(int index,
450 const GURL& default_url) {
[email protected]43032342011-03-21 14:10:31451 bool is_current = index == last_committed_entry_index_;
452 RemoveEntryAtIndexInternal(index);
453 if (is_current) {
[email protected]cbab76d2008-10-13 22:42:47454 // We removed the currently shown entry, so we have to load something else.
455 if (last_committed_entry_index_ != -1) {
456 pending_entry_index_ = last_committed_entry_index_;
[email protected]1ccb3568d2010-02-19 10:51:16457 NavigateToPendingEntry(NO_RELOAD);
[email protected]cbab76d2008-10-13 22:42:47458 } else {
459 // If there is nothing to show, show a default page.
[email protected]ed3456f2009-02-26 20:24:48460 LoadURL(default_url.is_empty() ? GURL("about:blank") : default_url,
[email protected]c0588052008-10-27 23:01:50461 GURL(), PageTransition::START_PAGE);
[email protected]cbab76d2008-10-13 22:42:47462 }
[email protected]cbab76d2008-10-13 22:42:47463 }
[email protected]cbab76d2008-10-13 22:42:47464}
465
[email protected]38178a42009-12-17 18:58:32466void NavigationController::UpdateVirtualURLToURL(
467 NavigationEntry* entry, const GURL& new_url) {
468 GURL new_virtual_url(new_url);
[email protected]f1eb87a2011-05-06 17:49:41469 if (BrowserURLHandler::GetInstance()->ReverseURLRewrite(
[email protected]3d7474ff2011-07-27 17:47:37470 &new_virtual_url, entry->virtual_url(), browser_context_)) {
[email protected]38178a42009-12-17 18:58:32471 entry->set_virtual_url(new_virtual_url);
472 }
473}
474
[email protected]cbab76d2008-10-13 22:42:47475void NavigationController::AddTransientEntry(NavigationEntry* entry) {
476 // Discard any current transient entry, we can only have one at a time.
477 int index = 0;
478 if (last_committed_entry_index_ != -1)
479 index = last_committed_entry_index_ + 1;
480 DiscardTransientEntry();
481 entries_.insert(entries_.begin() + index, linked_ptr<NavigationEntry>(entry));
[email protected]e1cd5452010-08-26 18:03:25482 transient_entry_index_ = index;
[email protected]93f230e02011-06-01 14:40:00483 tab_contents_->NotifyNavigationStateChanged(kInvalidateAll);
[email protected]cbab76d2008-10-13 22:42:47484}
485
[email protected]c0588052008-10-27 23:01:50486void NavigationController::LoadURL(const GURL& url, const GURL& referrer,
initial.commit09911bf2008-07-26 23:55:29487 PageTransition::Type transition) {
[email protected]6c6b02d2011-09-02 03:36:47488 LoadURLWithHeaders(url, referrer, transition, std::string());
489}
490
491// TODO(rogerta): Remove this call and put the extra_headers argument directly
492// in LoadURL().
493void NavigationController::LoadURLWithHeaders(
494 const GURL& url,
495 const GURL& referrer,
496 PageTransition::Type transition,
497 const std::string& extra_headers) {
initial.commit09911bf2008-07-26 23:55:29498 // The user initiated a load, we don't need to reload anymore.
499 needs_reload_ = false;
500
[email protected]b6ea7412010-05-04 23:26:47501 NavigationEntry* entry = CreateNavigationEntry(url, referrer, transition,
[email protected]6c6b02d2011-09-02 03:36:47502 extra_headers,
[email protected]3d7474ff2011-07-27 17:47:37503 browser_context_);
initial.commit09911bf2008-07-26 23:55:29504
505 LoadEntry(entry);
506}
507
[email protected]09b8f82f2009-06-16 20:22:11508void NavigationController::DocumentLoadedInFrame() {
509 last_document_loaded_ = base::TimeTicks::Now();
510}
511
[email protected]e9ba4472008-09-14 15:42:43512bool NavigationController::RendererDidNavigate(
513 const ViewHostMsg_FrameNavigate_Params& params,
[email protected]8286f51a2011-05-31 17:39:13514 content::LoadCommittedDetails* details) {
[email protected]4bf3522c2010-08-19 21:00:20515
[email protected]0e8db942008-09-24 21:21:48516 // Save the previous state before we clobber it.
517 if (GetLastCommittedEntry()) {
[email protected]ecd9d8702008-08-28 22:10:17518 details->previous_url = GetLastCommittedEntry()->url();
[email protected]7f0005a2009-04-15 03:25:11519 details->previous_entry_index = last_committed_entry_index();
[email protected]0e8db942008-09-24 21:21:48520 } else {
521 details->previous_url = GURL();
522 details->previous_entry_index = -1;
523 }
[email protected]ecd9d8702008-08-28 22:10:17524
[email protected]77362eb2011-08-01 17:18:38525 // If we have a pending entry at this point, it should have a SiteInstance.
526 // Restored entries start out with a null SiteInstance, but we should have
527 // assigned one in NavigateToPendingEntry.
528 DCHECK(pending_entry_index_ == -1 || pending_entry_->site_instance());
[email protected]e9ba4472008-09-14 15:42:43529
[email protected]192d8c5e2010-02-23 07:26:32530 // is_in_page must be computed before the entry gets committed.
531 details->is_in_page = IsURLInPageNavigation(params.url);
532
[email protected]e9ba4472008-09-14 15:42:43533 // Do navigation-type specific actions. These will make and commit an entry.
[email protected]0e8db942008-09-24 21:21:48534 details->type = ClassifyNavigation(params);
[email protected]4bf3522c2010-08-19 21:00:20535
[email protected]0e8db942008-09-24 21:21:48536 switch (details->type) {
537 case NavigationType::NEW_PAGE:
[email protected]befd8d822009-07-01 04:51:47538 RendererDidNavigateToNewPage(params, &(details->did_replace_entry));
[email protected]e9ba4472008-09-14 15:42:43539 break;
[email protected]0e8db942008-09-24 21:21:48540 case NavigationType::EXISTING_PAGE:
[email protected]e9ba4472008-09-14 15:42:43541 RendererDidNavigateToExistingPage(params);
542 break;
[email protected]0e8db942008-09-24 21:21:48543 case NavigationType::SAME_PAGE:
[email protected]e9ba4472008-09-14 15:42:43544 RendererDidNavigateToSamePage(params);
545 break;
[email protected]0e8db942008-09-24 21:21:48546 case NavigationType::IN_PAGE:
[email protected]befd8d822009-07-01 04:51:47547 RendererDidNavigateInPage(params, &(details->did_replace_entry));
[email protected]e9ba4472008-09-14 15:42:43548 break;
[email protected]0e8db942008-09-24 21:21:48549 case NavigationType::NEW_SUBFRAME:
[email protected]e9ba4472008-09-14 15:42:43550 RendererDidNavigateNewSubframe(params);
551 break;
[email protected]0e8db942008-09-24 21:21:48552 case NavigationType::AUTO_SUBFRAME:
[email protected]e9ba4472008-09-14 15:42:43553 if (!RendererDidNavigateAutoSubframe(params))
554 return false;
555 break;
[email protected]0e8db942008-09-24 21:21:48556 case NavigationType::NAV_IGNORE:
[email protected]20d1c992011-04-12 21:17:49557 // If a pending navigation was in progress, this canceled it. We should
558 // discard it and make sure it is removed from the URL bar. After that,
559 // there is nothing we can do with this navigation, so we just return to
[email protected]e9ba4472008-09-14 15:42:43560 // the caller that nothing has happened.
[email protected]20d1c992011-04-12 21:17:49561 if (pending_entry_) {
562 DiscardNonCommittedEntries();
[email protected]93f230e02011-06-01 14:40:00563 tab_contents_->NotifyNavigationStateChanged(
564 TabContents::INVALIDATE_URL);
[email protected]20d1c992011-04-12 21:17:49565 }
[email protected]e9ba4472008-09-14 15:42:43566 return false;
567 default:
568 NOTREACHED();
[email protected]765b35502008-08-21 00:51:20569 }
570
[email protected]e9ba4472008-09-14 15:42:43571 // All committed entries should have nonempty content state so WebKit doesn't
572 // get confused when we go back to them (see the function for details).
[email protected]0f38dc4552011-02-25 11:24:00573 DCHECK(!params.content_state.empty());
574 NavigationEntry* active_entry = GetActiveEntry();
575 active_entry->set_content_state(params.content_state);
[email protected]765b35502008-08-21 00:51:20576
[email protected]49bd30e62011-03-22 20:12:59577 // The active entry's SiteInstance should match our SiteInstance.
578 DCHECK(active_entry->site_instance() == tab_contents_->GetSiteInstance());
579
[email protected]e9ba4472008-09-14 15:42:43580 // Now prep the rest of the details for the notification and broadcast.
[email protected]0f38dc4552011-02-25 11:24:00581 details->entry = active_entry;
[email protected]e9ba4472008-09-14 15:42:43582 details->is_main_frame = PageTransition::IsMainFrame(params.transition);
[email protected]f072d2ce2008-09-17 17:16:24583 details->serialized_security_info = params.security_info;
[email protected]2e39d2e2009-02-19 18:41:31584 details->http_status_code = params.http_status_code;
[email protected]93f230e02011-06-01 14:40:00585 NotifyNavigationEntryCommitted(details);
initial.commit09911bf2008-07-26 23:55:29586
[email protected]e9ba4472008-09-14 15:42:43587 return true;
initial.commit09911bf2008-07-26 23:55:29588}
589
[email protected]0e8db942008-09-24 21:21:48590NavigationType::Type NavigationController::ClassifyNavigation(
[email protected]e9ba4472008-09-14 15:42:43591 const ViewHostMsg_FrameNavigate_Params& params) const {
[email protected]e9ba4472008-09-14 15:42:43592 if (params.page_id == -1) {
[email protected]eef9de32009-09-23 17:19:46593 // The renderer generates the page IDs, and so if it gives us the invalid
594 // page ID (-1) we know it didn't actually navigate. This happens in a few
595 // cases:
596 //
597 // - If a page makes a popup navigated to about blank, and then writes
598 // stuff like a subframe navigated to a real page. We'll get the commit
599 // for the subframe, but there won't be any commit for the outer page.
600 //
601 // - We were also getting these for failed loads (for example, bug 21849).
602 // The guess is that we get a "load commit" for the alternate error page,
603 // but that doesn't affect the page ID, so we get the "old" one, which
604 // could be invalid. This can also happen for a cross-site transition
605 // that causes us to swap processes. Then the error page load will be in
606 // a new process with no page IDs ever assigned (and hence a -1 value),
607 // yet the navigation controller still might have previous pages in its
608 // list.
609 //
610 // In these cases, there's nothing we can do with them, so ignore.
[email protected]0e8db942008-09-24 21:21:48611 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43612 }
613
[email protected]9423d9412009-04-14 22:13:55614 if (params.page_id > tab_contents_->GetMaxPageID()) {
[email protected]e9ba4472008-09-14 15:42:43615 // Greater page IDs than we've ever seen before are new pages. We may or may
616 // not have a pending entry for the page, and this may or may not be the
617 // main frame.
618 if (PageTransition::IsMainFrame(params.transition))
[email protected]0e8db942008-09-24 21:21:48619 return NavigationType::NEW_PAGE;
[email protected]4c27ba82008-09-24 16:49:09620
621 // When this is a new subframe navigation, we should have a committed page
622 // for which it's a suframe in. This may not be the case when an iframe is
623 // navigated on a popup navigated to about:blank (the iframe would be
624 // written into the popup by script on the main page). For these cases,
625 // there isn't any navigation stuff we can do, so just ignore it.
626 if (!GetLastCommittedEntry())
[email protected]0e8db942008-09-24 21:21:48627 return NavigationType::NAV_IGNORE;
[email protected]4c27ba82008-09-24 16:49:09628
629 // Valid subframe navigation.
[email protected]0e8db942008-09-24 21:21:48630 return NavigationType::NEW_SUBFRAME;
[email protected]e9ba4472008-09-14 15:42:43631 }
632
633 // Now we know that the notification is for an existing page. Find that entry.
634 int existing_entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55635 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43636 params.page_id);
637 if (existing_entry_index == -1) {
638 // The page was not found. It could have been pruned because of the limit on
639 // back/forward entries (not likely since we'll usually tell it to navigate
640 // to such entries). It could also mean that the renderer is smoking crack.
641 NOTREACHED();
[email protected]485e8232011-07-24 18:03:46642
643 // Because the unknown entry has committed, we risk showing the wrong URL in
644 // release builds. Instead, we'll kill the renderer process to be safe.
645 LOG(ERROR) << "terminating renderer for bad navigation: " << params.url;
646 UserMetrics::RecordAction(UserMetricsAction("BadMessageTerminate_NC"));
647 if (tab_contents_->GetSiteInstance()->HasProcess())
648 tab_contents_->GetSiteInstance()->GetProcess()->ReceivedBadMessage();
[email protected]0e8db942008-09-24 21:21:48649 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43650 }
651 NavigationEntry* existing_entry = entries_[existing_entry_index].get();
652
[email protected]e6035c22010-05-25 16:15:52653 if (!PageTransition::IsMainFrame(params.transition)) {
654 // All manual subframes would get new IDs and were handled above, so we
655 // know this is auto. Since the current page was found in the navigation
656 // entry list, we're guaranteed to have a last committed entry.
657 DCHECK(GetLastCommittedEntry());
658 return NavigationType::AUTO_SUBFRAME;
659 }
660
661 // Anything below here we know is a main frame navigation.
[email protected]e9ba4472008-09-14 15:42:43662 if (pending_entry_ &&
[email protected]e9ba4472008-09-14 15:42:43663 existing_entry != pending_entry_ &&
[email protected]230c0012011-04-08 16:27:24664 pending_entry_->page_id() == -1 &&
665 existing_entry == GetLastCommittedEntry()) {
[email protected]e9ba4472008-09-14 15:42:43666 // In this case, we have a pending entry for a URL but WebCore didn't do a
667 // new navigation. This happens when you press enter in the URL bar to
668 // reload. We will create a pending entry, but WebKit will convert it to
669 // a reload since it's the same page and not create a new entry for it
670 // (the user doesn't want to have a new back/forward entry when they do
[email protected]230c0012011-04-08 16:27:24671 // this). If this matches the last committed entry, we want to just ignore
672 // the pending entry and go back to where we were (the "existing entry").
[email protected]0e8db942008-09-24 21:21:48673 return NavigationType::SAME_PAGE;
[email protected]e9ba4472008-09-14 15:42:43674 }
675
[email protected]fc60f222008-12-18 17:36:54676 // Any toplevel navigations with the same base (minus the reference fragment)
677 // are in-page navigations. We weeded out subframe navigations above. Most of
678 // the time this doesn't matter since WebKit doesn't tell us about subframe
679 // navigations that don't actually navigate, but it can happen when there is
680 // an encoding override (it always sends a navigation request).
681 if (AreURLsInPageNavigation(existing_entry->url(), params.url))
682 return NavigationType::IN_PAGE;
683
[email protected]e9ba4472008-09-14 15:42:43684 // Since we weeded out "new" navigations above, we know this is an existing
[email protected]4c27ba82008-09-24 16:49:09685 // (back/forward) navigation.
[email protected]0e8db942008-09-24 21:21:48686 return NavigationType::EXISTING_PAGE;
[email protected]e9ba4472008-09-14 15:42:43687}
688
[email protected]09b8f82f2009-06-16 20:22:11689bool NavigationController::IsRedirect(
690 const ViewHostMsg_FrameNavigate_Params& params) {
691 // For main frame transition, we judge by params.transition.
692 // Otherwise, by params.redirects.
693 if (PageTransition::IsMainFrame(params.transition)) {
694 return PageTransition::IsRedirect(params.transition);
695 }
696 return params.redirects.size() > 1;
697}
698
[email protected]e9ba4472008-09-14 15:42:43699void NavigationController::RendererDidNavigateToNewPage(
[email protected]befd8d822009-07-01 04:51:47700 const ViewHostMsg_FrameNavigate_Params& params, bool* did_replace_entry) {
[email protected]e9ba4472008-09-14 15:42:43701 NavigationEntry* new_entry;
[email protected]f1eb87a2011-05-06 17:49:41702 bool update_virtual_url;
[email protected]e9ba4472008-09-14 15:42:43703 if (pending_entry_) {
704 // TODO(brettw) this assumes that the pending entry is appropriate for the
705 // new page that was just loaded. I don't think this is necessarily the
[email protected]49bd30e62011-03-22 20:12:59706 // case! We should have some more tracking to know for sure.
[email protected]e9ba4472008-09-14 15:42:43707 new_entry = new NavigationEntry(*pending_entry_);
708
709 // Don't use the page type from the pending entry. Some interstitial page
710 // may have set the type to interstitial. Once we commit, however, the page
711 // type must always be normal.
[email protected]cccd3762010-11-12 18:40:01712 new_entry->set_page_type(NORMAL_PAGE);
[email protected]f1eb87a2011-05-06 17:49:41713 update_virtual_url = new_entry->update_virtual_url_with_url();
[email protected]e9ba4472008-09-14 15:42:43714 } else {
[email protected]b680ad22009-04-15 23:19:42715 new_entry = new NavigationEntry;
[email protected]f1eb87a2011-05-06 17:49:41716 // When navigating to a new page, give the browser URL handler a chance to
717 // update the virtual URL based on the new URL. For example, this is needed
718 // to show chrome://bookmarks/#1 when the bookmarks webui extension changes
719 // the URL.
720 update_virtual_url = true;
[email protected]e9ba4472008-09-14 15:42:43721 }
722
723 new_entry->set_url(params.url);
[email protected]f1eb87a2011-05-06 17:49:41724 if (update_virtual_url)
[email protected]38178a42009-12-17 18:58:32725 UpdateVirtualURLToURL(new_entry, params.url);
[email protected]740fbda2009-02-18 21:38:08726 new_entry->set_referrer(params.referrer);
[email protected]e9ba4472008-09-14 15:42:43727 new_entry->set_page_id(params.page_id);
728 new_entry->set_transition_type(params.transition);
[email protected]9423d9412009-04-14 22:13:55729 new_entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43730 new_entry->set_has_post_data(params.is_post);
731
[email protected]befd8d822009-07-01 04:51:47732 InsertOrReplaceEntry(new_entry, *did_replace_entry);
[email protected]e9ba4472008-09-14 15:42:43733}
734
735void NavigationController::RendererDidNavigateToExistingPage(
736 const ViewHostMsg_FrameNavigate_Params& params) {
737 // We should only get here for main frame navigations.
738 DCHECK(PageTransition::IsMainFrame(params.transition));
739
740 // This is a back/forward navigation. The existing page for the ID is
[email protected]4c27ba82008-09-24 16:49:09741 // guaranteed to exist by ClassifyNavigation, and we just need to update it
742 // with new information from the renderer.
[email protected]7f0005a2009-04-15 03:25:11743 int entry_index = GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(),
744 params.page_id);
[email protected]e9ba4472008-09-14 15:42:43745 DCHECK(entry_index >= 0 &&
746 entry_index < static_cast<int>(entries_.size()));
747 NavigationEntry* entry = entries_[entry_index].get();
748
749 // The URL may have changed due to redirects. The site instance will normally
750 // be the same except during session restore, when no site instance will be
751 // assigned.
752 entry->set_url(params.url);
[email protected]38178a42009-12-17 18:58:32753 if (entry->update_virtual_url_with_url())
754 UpdateVirtualURLToURL(entry, params.url);
[email protected]e9ba4472008-09-14 15:42:43755 DCHECK(entry->site_instance() == NULL ||
[email protected]9423d9412009-04-14 22:13:55756 entry->site_instance() == tab_contents_->GetSiteInstance());
757 entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43758
[email protected]d5a49e52010-01-08 03:01:41759 entry->set_has_post_data(params.is_post);
760
[email protected]e9ba4472008-09-14 15:42:43761 // The entry we found in the list might be pending if the user hit
762 // back/forward/reload. This load should commit it (since it's already in the
[email protected]49bd30e62011-03-22 20:12:59763 // list, we can just discard the pending pointer). We should also discard the
764 // pending entry if it corresponds to a different navigation, since that one
765 // is now likely canceled. If it is not canceled, we will treat it as a new
766 // navigation when it arrives, which is also ok.
[email protected]e9ba4472008-09-14 15:42:43767 //
768 // Note that we need to use the "internal" version since we don't want to
769 // actually change any other state, just kill the pointer.
[email protected]49bd30e62011-03-22 20:12:59770 if (pending_entry_)
[email protected]cbab76d2008-10-13 22:42:47771 DiscardNonCommittedEntriesInternal();
[email protected]40bcc302009-03-02 20:50:39772
[email protected]80858db52009-10-15 00:35:18773 // If a transient entry was removed, the indices might have changed, so we
774 // have to query the entry index again.
775 last_committed_entry_index_ =
776 GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(), params.page_id);
[email protected]e9ba4472008-09-14 15:42:43777}
778
779void NavigationController::RendererDidNavigateToSamePage(
780 const ViewHostMsg_FrameNavigate_Params& params) {
781 // This mode implies we have a pending entry that's the same as an existing
[email protected]4c27ba82008-09-24 16:49:09782 // entry for this page ID. This entry is guaranteed to exist by
783 // ClassifyNavigation. All we need to do is update the existing entry.
[email protected]e9ba4472008-09-14 15:42:43784 NavigationEntry* existing_entry = GetEntryWithPageID(
[email protected]9423d9412009-04-14 22:13:55785 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43786 params.page_id);
787
788 // We assign the entry's unique ID to be that of the new one. Since this is
789 // always the result of a user action, we want to dismiss infobars, etc. like
790 // a regular user-initiated navigation.
791 existing_entry->set_unique_id(pending_entry_->unique_id());
792
[email protected]a0e69262009-06-03 19:08:48793 // The URL may have changed due to redirects.
[email protected]38178a42009-12-17 18:58:32794 if (existing_entry->update_virtual_url_with_url())
795 UpdateVirtualURLToURL(existing_entry, params.url);
[email protected]a0e69262009-06-03 19:08:48796 existing_entry->set_url(params.url);
797
[email protected]cbab76d2008-10-13 22:42:47798 DiscardNonCommittedEntries();
[email protected]e9ba4472008-09-14 15:42:43799}
800
801void NavigationController::RendererDidNavigateInPage(
[email protected]befd8d822009-07-01 04:51:47802 const ViewHostMsg_FrameNavigate_Params& params, bool* did_replace_entry) {
[email protected]e9ba4472008-09-14 15:42:43803 DCHECK(PageTransition::IsMainFrame(params.transition)) <<
804 "WebKit should only tell us about in-page navs for the main frame.";
805 // We're guaranteed to have an entry for this one.
806 NavigationEntry* existing_entry = GetEntryWithPageID(
[email protected]9423d9412009-04-14 22:13:55807 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43808 params.page_id);
809
810 // Reference fragment navigation. We're guaranteed to have the last_committed
811 // entry and it will be the same page as the new navigation (minus the
[email protected]d466b8a2011-07-15 21:48:03812 // reference fragments, of course). We'll update the URL of the existing
813 // entry without pruning the forward history.
814 existing_entry->set_url(params.url);
815 if (existing_entry->update_virtual_url_with_url())
816 UpdateVirtualURLToURL(existing_entry, params.url);
[email protected]ccbe04e2010-03-17 17:58:43817
818 // This replaces the existing entry since the page ID didn't change.
819 *did_replace_entry = true;
[email protected]d466b8a2011-07-15 21:48:03820
821 if (pending_entry_)
822 DiscardNonCommittedEntriesInternal();
823
824 // If a transient entry was removed, the indices might have changed, so we
825 // have to query the entry index again.
826 last_committed_entry_index_ =
827 GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(), params.page_id);
[email protected]e9ba4472008-09-14 15:42:43828}
829
830void NavigationController::RendererDidNavigateNewSubframe(
831 const ViewHostMsg_FrameNavigate_Params& params) {
[email protected]09b8f82f2009-06-16 20:22:11832 if (PageTransition::StripQualifier(params.transition) ==
833 PageTransition::AUTO_SUBFRAME) {
834 // This is not user-initiated. Ignore.
835 return;
836 }
[email protected]09b8f82f2009-06-16 20:22:11837
[email protected]e9ba4472008-09-14 15:42:43838 // Manual subframe navigations just get the current entry cloned so the user
839 // can go back or forward to it. The actual subframe information will be
840 // stored in the page state for each of those entries. This happens out of
841 // band with the actual navigations.
[email protected]4c27ba82008-09-24 16:49:09842 DCHECK(GetLastCommittedEntry()) << "ClassifyNavigation should guarantee "
843 << "that a last committed entry exists.";
[email protected]e9ba4472008-09-14 15:42:43844 NavigationEntry* new_entry = new NavigationEntry(*GetLastCommittedEntry());
845 new_entry->set_page_id(params.page_id);
[email protected]672eba292009-05-13 13:22:45846 InsertOrReplaceEntry(new_entry, false);
[email protected]e9ba4472008-09-14 15:42:43847}
848
849bool NavigationController::RendererDidNavigateAutoSubframe(
850 const ViewHostMsg_FrameNavigate_Params& params) {
851 // We're guaranteed to have a previously committed entry, and we now need to
852 // handle navigation inside of a subframe in it without creating a new entry.
853 DCHECK(GetLastCommittedEntry());
854
855 // Handle the case where we're navigating back/forward to a previous subframe
856 // navigation entry. This is case "2." in NAV_AUTO_SUBFRAME comment in the
857 // header file. In case "1." this will be a NOP.
858 int entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55859 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43860 params.page_id);
861 if (entry_index < 0 ||
862 entry_index >= static_cast<int>(entries_.size())) {
863 NOTREACHED();
864 return false;
865 }
866
867 // Update the current navigation entry in case we're going back/forward.
868 if (entry_index != last_committed_entry_index_) {
[email protected]e9ba4472008-09-14 15:42:43869 last_committed_entry_index_ = entry_index;
[email protected]e9ba4472008-09-14 15:42:43870 return true;
871 }
872 return false;
873}
874
[email protected]765b35502008-08-21 00:51:20875int NavigationController::GetIndexOfEntry(
876 const NavigationEntry* entry) const {
877 const NavigationEntries::const_iterator i(std::find(
878 entries_.begin(),
879 entries_.end(),
880 entry));
881 return (i == entries_.end()) ? -1 : static_cast<int>(i - entries_.begin());
882}
883
[email protected]e9ba4472008-09-14 15:42:43884bool NavigationController::IsURLInPageNavigation(const GURL& url) const {
885 NavigationEntry* last_committed = GetLastCommittedEntry();
886 if (!last_committed)
887 return false;
888 return AreURLsInPageNavigation(last_committed->url(), url);
889}
890
[email protected]ce3fa3c2009-04-20 19:55:57891void NavigationController::CopyStateFrom(const NavigationController& source) {
892 // Verify that we look new.
893 DCHECK(entry_count() == 0 && !pending_entry());
894
895 if (source.entry_count() == 0)
896 return; // Nothing new to do.
897
898 needs_reload_ = true;
[email protected]e1cd5452010-08-26 18:03:25899 InsertEntriesFrom(source, source.entry_count());
[email protected]ce3fa3c2009-04-20 19:55:57900
[email protected]6ee12c42010-09-14 09:36:07901 session_storage_namespace_ = source.session_storage_namespace_->Clone();
[email protected]4e6419c2010-01-15 04:50:34902
[email protected]5e369672009-11-03 23:48:30903 FinishRestore(source.last_committed_entry_index_, false);
[email protected]ce3fa3c2009-04-20 19:55:57904}
905
[email protected]43032342011-03-21 14:10:31906void NavigationController::CopyStateFromAndPrune(NavigationController* source,
907 bool remove_first_entry) {
[email protected]9e1ad4b2011-08-14 16:49:19908 // The SiteInstance and page_id of the last committed entry needs to be
909 // remembered at this point, in case there is only one committed entry
910 // and it is pruned.
911 NavigationEntry* last_committed = GetLastCommittedEntry();
912 SiteInstance* site_instance =
913 last_committed ? last_committed->site_instance() : NULL;
914 int32 minimum_page_id = last_committed ? last_committed->page_id() : -1;
915
[email protected]e1cd5452010-08-26 18:03:25916 // This code is intended for use when the last entry is the active entry.
917 DCHECK((transient_entry_index_ != -1 &&
918 transient_entry_index_ == entry_count() - 1) ||
919 (pending_entry_ && (pending_entry_index_ == -1 ||
920 pending_entry_index_ == entry_count() - 1)) ||
921 (!pending_entry_ && last_committed_entry_index_ == entry_count() - 1));
922
[email protected]43032342011-03-21 14:10:31923 if (remove_first_entry && entry_count()) {
[email protected]9e1ad4b2011-08-14 16:49:19924 // If there is only one committed entry and |remove_first_entry| is true,
925 // it needs to be pruned. This is accomplished by specifying a larger
926 // |minimum_page_id| than the committed entry's page_id in the
927 // ViewMsg_SetHistoryLengthAndPrune message. However, any pages which are
928 // committed between now and when the RenderView handles the message will
929 // need to be retained. Both constraints can be met by incrementing the
930 // |minimum_page_id| by 1.
931 DCHECK(minimum_page_id >= 0);
932 if (entry_count() == 1)
933 ++minimum_page_id;
[email protected]43032342011-03-21 14:10:31934 // Save then restore the pending entry (RemoveEntryAtIndexInternal chucks
935 // the pending entry).
936 NavigationEntry* pending_entry = pending_entry_;
937 pending_entry_ = NULL;
938 int pending_entry_index = pending_entry_index_;
939 RemoveEntryAtIndexInternal(0);
940 // Restore the pending entry.
941 if (pending_entry_index != -1) {
942 pending_entry_index_ = pending_entry_index - 1;
943 if (pending_entry_index_ != -1)
944 pending_entry_ = entries_[pending_entry_index_].get();
945 } else if (pending_entry) {
946 pending_entry_ = pending_entry;
947 }
948 }
949
[email protected]e1cd5452010-08-26 18:03:25950 // Remove all the entries leaving the active entry.
951 PruneAllButActive();
952
[email protected]47e020a2010-10-15 14:43:37953 // Insert the entries from source. Don't use source->GetCurrentEntryIndex as
[email protected]e1cd5452010-08-26 18:03:25954 // we don't want to copy over the transient entry.
[email protected]47e020a2010-10-15 14:43:37955 int max_source_index = source->pending_entry_index_ != -1 ?
956 source->pending_entry_index_ : source->last_committed_entry_index_;
[email protected]e1cd5452010-08-26 18:03:25957 if (max_source_index == -1)
[email protected]47e020a2010-10-15 14:43:37958 max_source_index = source->entry_count();
[email protected]e1cd5452010-08-26 18:03:25959 else
960 max_source_index++;
[email protected]47e020a2010-10-15 14:43:37961 InsertEntriesFrom(*source, max_source_index);
[email protected]e1cd5452010-08-26 18:03:25962
963 // Adjust indices such that the last entry and pending are at the end now.
964 last_committed_entry_index_ = entry_count() - 1;
965 if (pending_entry_index_ != -1)
966 pending_entry_index_ = entry_count() - 1;
967 if (transient_entry_index_ != -1) {
968 // There's a transient entry. In this case we want the last committed to
969 // point to the previous entry.
970 transient_entry_index_ = entry_count() - 1;
971 if (last_committed_entry_index_ != -1)
972 last_committed_entry_index_--;
973 }
[email protected]796931a92011-08-10 01:32:14974
[email protected]9e1ad4b2011-08-14 16:49:19975 tab_contents_->SetHistoryLengthAndPrune(site_instance,
976 max_source_index,
977 minimum_page_id);
[email protected]e1cd5452010-08-26 18:03:25978}
979
[email protected]97b6c4f2010-09-27 19:31:26980void NavigationController::PruneAllButActive() {
[email protected]97b6c4f2010-09-27 19:31:26981 if (transient_entry_index_ != -1) {
982 // There is a transient entry. Prune up to it.
983 DCHECK_EQ(entry_count() - 1, transient_entry_index_);
[email protected]77d8d622010-12-15 10:30:12984 entries_.erase(entries_.begin(), entries_.begin() + transient_entry_index_);
[email protected]97b6c4f2010-09-27 19:31:26985 transient_entry_index_ = 0;
986 last_committed_entry_index_ = -1;
987 pending_entry_index_ = -1;
988 } else if (!pending_entry_) {
989 // There's no pending entry. Leave the last entry (if there is one).
[email protected]77d8d622010-12-15 10:30:12990 if (!entry_count())
[email protected]97b6c4f2010-09-27 19:31:26991 return;
992
[email protected]77d8d622010-12-15 10:30:12993 DCHECK(last_committed_entry_index_ >= 0);
994 entries_.erase(entries_.begin(),
995 entries_.begin() + last_committed_entry_index_);
996 entries_.erase(entries_.begin() + 1, entries_.end());
[email protected]97b6c4f2010-09-27 19:31:26997 last_committed_entry_index_ = 0;
998 } else if (pending_entry_index_ != -1) {
[email protected]77d8d622010-12-15 10:30:12999 entries_.erase(entries_.begin(), entries_.begin() + pending_entry_index_);
1000 entries_.erase(entries_.begin() + 1, entries_.end());
[email protected]97b6c4f2010-09-27 19:31:261001 pending_entry_index_ = 0;
1002 last_committed_entry_index_ = 0;
[email protected]97b6c4f2010-09-27 19:31:261003 } else {
1004 // There is a pending_entry, but it's not in entries_.
1005 pending_entry_index_ = -1;
1006 last_committed_entry_index_ = -1;
[email protected]77d8d622010-12-15 10:30:121007 entries_.clear();
[email protected]97b6c4f2010-09-27 19:31:261008 }
1009
1010 if (tab_contents_->interstitial_page()) {
1011 // Normally the interstitial page hides itself if the user doesn't proceeed.
1012 // This would result in showing a NavigationEntry we just removed. Set this
1013 // so the interstitial triggers a reload if the user doesn't proceed.
1014 tab_contents_->interstitial_page()->set_reload_on_dont_proceed(true);
1015 }
[email protected]97b6c4f2010-09-27 19:31:261016}
1017
[email protected]43032342011-03-21 14:10:311018void NavigationController::RemoveEntryAtIndexInternal(int index) {
1019 DCHECK(index < entry_count());
1020
1021 DiscardNonCommittedEntries();
1022
1023 entries_.erase(entries_.begin() + index);
1024 if (last_committed_entry_index_ == index)
1025 last_committed_entry_index_--;
1026 else if (last_committed_entry_index_ > index)
1027 last_committed_entry_index_--;
1028}
1029
[email protected]cbab76d2008-10-13 22:42:471030void NavigationController::DiscardNonCommittedEntries() {
1031 bool transient = transient_entry_index_ != -1;
1032 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:291033
[email protected]cbab76d2008-10-13 22:42:471034 // If there was a transient entry, invalidate everything so the new active
1035 // entry state is shown.
1036 if (transient) {
[email protected]93f230e02011-06-01 14:40:001037 tab_contents_->NotifyNavigationStateChanged(kInvalidateAll);
[email protected]cbab76d2008-10-13 22:42:471038 }
initial.commit09911bf2008-07-26 23:55:291039}
1040
[email protected]672eba292009-05-13 13:22:451041void NavigationController::InsertOrReplaceEntry(NavigationEntry* entry,
1042 bool replace) {
[email protected]1e5645ff2008-08-27 18:09:071043 DCHECK(entry->transition_type() != PageTransition::AUTO_SUBFRAME);
[email protected]765b35502008-08-21 00:51:201044
1045 // Copy the pending entry's unique ID to the committed entry.
1046 // I don't know if pending_entry_index_ can be other than -1 here.
1047 const NavigationEntry* const pending_entry = (pending_entry_index_ == -1) ?
1048 pending_entry_ : entries_[pending_entry_index_].get();
1049 if (pending_entry)
1050 entry->set_unique_id(pending_entry->unique_id());
1051
[email protected]cbab76d2008-10-13 22:42:471052 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:201053
1054 int current_size = static_cast<int>(entries_.size());
1055
[email protected]765b35502008-08-21 00:51:201056 if (current_size > 0) {
[email protected]672eba292009-05-13 13:22:451057 // Prune any entries which are in front of the current entry.
1058 // Also prune the current entry if we are to replace the current entry.
[email protected]47dcbdc2011-05-27 15:08:311059 // last_committed_entry_index_ must be updated here since calls to
1060 // NotifyPrunedEntries() below may re-enter and we must make sure
1061 // last_committed_entry_index_ is not left in an invalid state.
1062 if (replace)
1063 --last_committed_entry_index_;
1064
[email protected]c12bf1a12008-09-17 16:28:491065 int num_pruned = 0;
[email protected]47dcbdc2011-05-27 15:08:311066 while (last_committed_entry_index_ < (current_size - 1)) {
[email protected]c12bf1a12008-09-17 16:28:491067 num_pruned++;
[email protected]765b35502008-08-21 00:51:201068 entries_.pop_back();
1069 current_size--;
1070 }
[email protected]c12bf1a12008-09-17 16:28:491071 if (num_pruned > 0) // Only notify if we did prune something.
1072 NotifyPrunedEntries(this, false, num_pruned);
[email protected]765b35502008-08-21 00:51:201073 }
1074
[email protected]c12bf1a12008-09-17 16:28:491075 if (entries_.size() >= max_entry_count_) {
[email protected]cbab76d2008-10-13 22:42:471076 RemoveEntryAtIndex(0, GURL());
[email protected]c12bf1a12008-09-17 16:28:491077 NotifyPrunedEntries(this, true, 1);
1078 }
[email protected]765b35502008-08-21 00:51:201079
1080 entries_.push_back(linked_ptr<NavigationEntry>(entry));
1081 last_committed_entry_index_ = static_cast<int>(entries_.size()) - 1;
[email protected]e9ba4472008-09-14 15:42:431082
1083 // This is a new page ID, so we need everybody to know about it.
[email protected]9423d9412009-04-14 22:13:551084 tab_contents_->UpdateMaxPageID(entry->page_id());
initial.commit09911bf2008-07-26 23:55:291085}
1086
[email protected]1ccb3568d2010-02-19 10:51:161087void NavigationController::NavigateToPendingEntry(ReloadType reload_type) {
[email protected]72097fd02010-01-21 23:36:011088 needs_reload_ = false;
1089
initial.commit09911bf2008-07-26 23:55:291090 // For session history navigations only the pending_entry_index_ is set.
1091 if (!pending_entry_) {
[email protected]4bf3522c2010-08-19 21:00:201092 DCHECK_NE(pending_entry_index_, -1);
[email protected]765b35502008-08-21 00:51:201093 pending_entry_ = entries_[pending_entry_index_].get();
initial.commit09911bf2008-07-26 23:55:291094 }
1095
[email protected]1ccb3568d2010-02-19 10:51:161096 if (!tab_contents_->NavigateToPendingEntry(reload_type))
[email protected]cbab76d2008-10-13 22:42:471097 DiscardNonCommittedEntries();
[email protected]77362eb2011-08-01 17:18:381098
1099 // If the entry is being restored and doesn't have a SiteInstance yet, fill
1100 // it in now that we know. This allows us to find the entry when it commits.
1101 // This works for browser-initiated navigations. We handle renderer-initiated
1102 // navigations to restored entries in TabContents::OnGoToEntryAtOffset.
1103 if (pending_entry_ && !pending_entry_->site_instance() &&
1104 pending_entry_->restore_type() != NavigationEntry::RESTORE_NONE) {
1105 pending_entry_->set_site_instance(tab_contents_->GetPendingSiteInstance());
1106 pending_entry_->set_restore_type(NavigationEntry::RESTORE_NONE);
1107 }
initial.commit09911bf2008-07-26 23:55:291108}
1109
[email protected]ecd9d8702008-08-28 22:10:171110void NavigationController::NotifyNavigationEntryCommitted(
[email protected]93f230e02011-06-01 14:40:001111 content::LoadCommittedDetails* details) {
[email protected]df1af242009-05-01 00:11:401112 details->entry = GetActiveEntry();
1113 NotificationDetails notification_details =
[email protected]8286f51a2011-05-31 17:39:131114 Details<content::LoadCommittedDetails>(details);
[email protected]df1af242009-05-01 00:11:401115
1116 // We need to notify the ssl_manager_ before the tab_contents_ so the
1117 // location bar will have up-to-date information about the security style
1118 // when it wants to draw. See http://crbug.com/11157
1119 ssl_manager_.DidCommitProvisionalLoad(notification_details);
1120
initial.commit09911bf2008-07-26 23:55:291121 // TODO(pkasting): http://b/1113079 Probably these explicit notification paths
1122 // should be removed, and interested parties should just listen for the
1123 // notification below instead.
[email protected]93f230e02011-06-01 14:40:001124 tab_contents_->NotifyNavigationStateChanged(kInvalidateAll);
initial.commit09911bf2008-07-26 23:55:291125
[email protected]ecd9d8702008-08-28 22:10:171126 NotificationService::current()->Notify(
[email protected]432115822011-07-10 15:52:271127 content::NOTIFICATION_NAV_ENTRY_COMMITTED,
[email protected]ecd9d8702008-08-28 22:10:171128 Source<NavigationController>(this),
[email protected]df1af242009-05-01 00:11:401129 notification_details);
initial.commit09911bf2008-07-26 23:55:291130}
1131
initial.commit09911bf2008-07-26 23:55:291132// static
1133void NavigationController::DisablePromptOnRepost() {
1134 check_for_repost_ = false;
1135}
1136
1137void NavigationController::SetActive(bool is_active) {
[email protected]ee613922009-09-02 20:38:221138 if (is_active && needs_reload_)
1139 LoadIfNecessary();
initial.commit09911bf2008-07-26 23:55:291140}
1141
1142void NavigationController::LoadIfNecessary() {
1143 if (!needs_reload_)
1144 return;
1145
initial.commit09911bf2008-07-26 23:55:291146 // Calling Reload() results in ignoring state, and not loading.
1147 // Explicitly use NavigateToPendingEntry so that the renderer uses the
1148 // cached state.
1149 pending_entry_index_ = last_committed_entry_index_;
[email protected]1ccb3568d2010-02-19 10:51:161150 NavigateToPendingEntry(NO_RELOAD);
initial.commit09911bf2008-07-26 23:55:291151}
1152
[email protected]534e54b2008-08-13 15:40:091153void NavigationController::NotifyEntryChanged(const NavigationEntry* entry,
1154 int index) {
[email protected]8286f51a2011-05-31 17:39:131155 content::EntryChangedDetails det;
[email protected]534e54b2008-08-13 15:40:091156 det.changed_entry = entry;
1157 det.index = index;
[email protected]432115822011-07-10 15:52:271158 NotificationService::current()->Notify(
1159 content::NOTIFICATION_NAV_ENTRY_CHANGED,
[email protected]8286f51a2011-05-31 17:39:131160 Source<NavigationController>(this),
1161 Details<content::EntryChangedDetails>(&det));
initial.commit09911bf2008-07-26 23:55:291162}
1163
[email protected]5e369672009-11-03 23:48:301164void NavigationController::FinishRestore(int selected_index,
1165 bool from_last_session) {
[email protected]7f0005a2009-04-15 03:25:111166 DCHECK(selected_index >= 0 && selected_index < entry_count());
[email protected]5e369672009-11-03 23:48:301167 ConfigureEntriesForRestore(&entries_, from_last_session);
initial.commit09911bf2008-07-26 23:55:291168
[email protected]61398152010-08-26 21:45:341169 set_max_restored_page_id(static_cast<int32>(entry_count()));
initial.commit09911bf2008-07-26 23:55:291170
1171 last_committed_entry_index_ = selected_index;
initial.commit09911bf2008-07-26 23:55:291172}
[email protected]765b35502008-08-21 00:51:201173
[email protected]cbab76d2008-10-13 22:42:471174void NavigationController::DiscardNonCommittedEntriesInternal() {
[email protected]765b35502008-08-21 00:51:201175 if (pending_entry_index_ == -1)
1176 delete pending_entry_;
1177 pending_entry_ = NULL;
1178 pending_entry_index_ = -1;
[email protected]cbab76d2008-10-13 22:42:471179
1180 DiscardTransientEntry();
1181}
1182
1183void NavigationController::DiscardTransientEntry() {
1184 if (transient_entry_index_ == -1)
1185 return;
[email protected]a0e69262009-06-03 19:08:481186 entries_.erase(entries_.begin() + transient_entry_index_);
[email protected]80858db52009-10-15 00:35:181187 if (last_committed_entry_index_ > transient_entry_index_)
1188 last_committed_entry_index_--;
[email protected]cbab76d2008-10-13 22:42:471189 transient_entry_index_ = -1;
[email protected]765b35502008-08-21 00:51:201190}
1191
1192int NavigationController::GetEntryIndexWithPageID(
[email protected]7f0005a2009-04-15 03:25:111193 SiteInstance* instance, int32 page_id) const {
[email protected]765b35502008-08-21 00:51:201194 for (int i = static_cast<int>(entries_.size()) - 1; i >= 0; --i) {
[email protected]7f0005a2009-04-15 03:25:111195 if ((entries_[i]->site_instance() == instance) &&
[email protected]1e5645ff2008-08-27 18:09:071196 (entries_[i]->page_id() == page_id))
[email protected]765b35502008-08-21 00:51:201197 return i;
1198 }
1199 return -1;
1200}
[email protected]cbab76d2008-10-13 22:42:471201
1202NavigationEntry* NavigationController::GetTransientEntry() const {
1203 if (transient_entry_index_ == -1)
1204 return NULL;
1205 return entries_[transient_entry_index_].get();
1206}
[email protected]e1cd5452010-08-26 18:03:251207
[email protected]e1cd5452010-08-26 18:03:251208void NavigationController::InsertEntriesFrom(
1209 const NavigationController& source,
1210 int max_index) {
1211 DCHECK_LE(max_index, source.entry_count());
1212 size_t insert_index = 0;
1213 for (int i = 0; i < max_index; i++) {
1214 // When cloning a tab, copy all entries except interstitial pages
[email protected]cccd3762010-11-12 18:40:011215 if (source.entries_[i].get()->page_type() != INTERSTITIAL_PAGE) {
[email protected]e1cd5452010-08-26 18:03:251216 entries_.insert(entries_.begin() + insert_index++,
1217 linked_ptr<NavigationEntry>(
1218 new NavigationEntry(*source.entries_[i])));
1219 }
1220 }
1221}