blob: 918a9b412a2b1d3f9f5798eeb92058fae0ff0aae [file] [log] [blame]
[email protected]e1cd5452010-08-26 18:03:251// Copyright (c) 2010 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]f3ec7742009-01-15 00:59:165#include "chrome/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]cd3d7892009-03-04 23:55:0612#include "chrome/browser/browser_about_handler.h"
initial.commit09911bf2008-07-26 23:55:2913#include "chrome/browser/browser_process.h"
[email protected]9423d9412009-04-14 22:13:5514#include "chrome/browser/browser_url_handler.h"
[email protected]6ee12c42010-09-14 09:36:0715#include "chrome/browser/in_process_webkit/session_storage_namespace.h"
[email protected]37858e52010-08-26 00:22:0216#include "chrome/browser/prefs/pref_service.h"
[email protected]ce560f82009-06-03 09:39:4417#include "chrome/browser/profile.h"
[email protected]14e60c8d2009-06-29 03:56:5118#include "chrome/browser/renderer_host/site_instance.h"
[email protected]169627b2008-12-06 19:30:1919#include "chrome/browser/sessions/session_types.h"
[email protected]25396da2010-03-11 19:19:1020#include "chrome/browser/tab_contents/interstitial_page.h"
[email protected]f3ec7742009-01-15 00:59:1621#include "chrome/browser/tab_contents/navigation_entry.h"
[email protected]5c238752009-06-13 10:29:0722#include "chrome/browser/tab_contents/tab_contents.h"
[email protected]14f3408a2009-08-31 20:53:5323#include "chrome/browser/tab_contents/tab_contents_delegate.h"
[email protected]3cc72b12010-03-18 23:03:0024#include "chrome/common/chrome_constants.h"
[email protected]299dabd2008-11-19 02:27:1625#include "chrome/common/navigation_types.h"
[email protected]bfd04a62009-02-01 18:16:5626#include "chrome/common/notification_service.h"
[email protected]a23de8572009-06-03 02:16:3227#include "chrome/common/pref_names.h"
[email protected]939856a2010-08-24 20:29:0228#include "chrome/common/render_messages_params.h"
[email protected]6de74452009-02-25 18:04:5929#include "chrome/common/url_constants.h"
[email protected]074f10562009-05-21 22:40:0530#include "grit/app_resources.h"
[email protected]a23de8572009-06-03 02:16:3231#include "net/base/escape.h"
32#include "net/base/net_util.h"
[email protected]31682282010-01-15 18:05:1633#include "net/base/mime_util.h"
[email protected]765b35502008-08-21 00:51:2034#include "webkit/glue/webkit_glue.h"
initial.commit09911bf2008-07-26 23:55:2935
[email protected]e9ba4472008-09-14 15:42:4336namespace {
37
[email protected]8030f012009-09-25 18:09:3738const int kInvalidateAllButShelves =
[email protected]6d7a6042010-08-12 20:12:4239 0xFFFFFFFF & ~TabContents::INVALIDATE_BOOKMARK_BAR;
[email protected]8030f012009-09-25 18:09:3740
[email protected]e9ba4472008-09-14 15:42:4341// Invoked when entries have been pruned, or removed. For example, if the
42// current entries are [google, digg, yahoo], with the current entry google,
43// and the user types in cnet, then digg and yahoo are pruned.
[email protected]c12bf1a12008-09-17 16:28:4944void NotifyPrunedEntries(NavigationController* nav_controller,
45 bool from_front,
46 int count) {
47 NavigationController::PrunedDetails details;
48 details.from_front = from_front;
49 details.count = count;
[email protected]e9ba4472008-09-14 15:42:4350 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:5651 NotificationType::NAV_LIST_PRUNED,
[email protected]e9ba4472008-09-14 15:42:4352 Source<NavigationController>(nav_controller),
[email protected]c12bf1a12008-09-17 16:28:4953 Details<NavigationController::PrunedDetails>(&details));
[email protected]e9ba4472008-09-14 15:42:4354}
55
56// Ensure the given NavigationEntry has a valid state, so that WebKit does not
57// get confused if we navigate back to it.
[email protected]40bcc302009-03-02 20:50:3958//
[email protected]e9ba4472008-09-14 15:42:4359// An empty state is treated as a new navigation by WebKit, which would mean
60// losing the navigation entries and generating a new navigation entry after
61// this one. We don't want that. To avoid this we create a valid state which
62// WebKit will not treat as a new navigation.
63void SetContentStateIfEmpty(NavigationEntry* entry) {
[email protected]965524b2009-04-04 21:32:4064 if (entry->content_state().empty()) {
[email protected]e9ba4472008-09-14 15:42:4365 entry->set_content_state(
66 webkit_glue::CreateHistoryStateForURL(entry->url()));
67 }
68}
69
70// Configure all the NavigationEntries in entries for restore. This resets
71// the transition type to reload and makes sure the content state isn't empty.
72void ConfigureEntriesForRestore(
[email protected]5e369672009-11-03 23:48:3073 std::vector<linked_ptr<NavigationEntry> >* entries,
74 bool from_last_session) {
[email protected]e9ba4472008-09-14 15:42:4375 for (size_t i = 0; i < entries->size(); ++i) {
76 // Use a transition type of reload so that we don't incorrectly increase
77 // the typed count.
78 (*entries)[i]->set_transition_type(PageTransition::RELOAD);
[email protected]5e369672009-11-03 23:48:3079 (*entries)[i]->set_restore_type(from_last_session ?
80 NavigationEntry::RESTORE_LAST_SESSION :
81 NavigationEntry::RESTORE_CURRENT_SESSION);
[email protected]e9ba4472008-09-14 15:42:4382 // NOTE(darin): This code is only needed for backwards compat.
83 SetContentStateIfEmpty((*entries)[i].get());
84 }
85}
86
87// See NavigationController::IsURLInPageNavigation for how this works and why.
88bool AreURLsInPageNavigation(const GURL& existing_url, const GURL& new_url) {
[email protected]192d8c5e2010-02-23 07:26:3289 if (existing_url == new_url || !new_url.has_ref()) {
90 // TODO(jcampan): what about when navigating back from a ref URL to the top
91 // non ref URL? Nothing is loaded in that case but we return false here.
92 // The user could also navigate from the ref URL to the non ref URL by
93 // entering the non ref URL in the location bar or through a bookmark, in
94 // which case there would be a load. I am not sure if the non-load/load
95 // scenarios can be differentiated with the TransitionType.
[email protected]e9ba4472008-09-14 15:42:4396 return false;
[email protected]192d8c5e2010-02-23 07:26:3297 }
[email protected]e9ba4472008-09-14 15:42:4398
99 url_canon::Replacements<char> replacements;
100 replacements.ClearRef();
101 return existing_url.ReplaceComponents(replacements) ==
102 new_url.ReplaceComponents(replacements);
103}
104
105} // namespace
106
initial.commit09911bf2008-07-26 23:55:29107// NavigationController ---------------------------------------------------
108
[email protected]765b35502008-08-21 00:51:20109// static
[email protected]3cc72b12010-03-18 23:03:00110size_t NavigationController::max_entry_count_ =
111 chrome::kMaxSessionHistoryEntries;
[email protected]765b35502008-08-21 00:51:20112
initial.commit09911bf2008-07-26 23:55:29113// static
114bool NavigationController::check_for_repost_ = true;
115
[email protected]6ee12c42010-09-14 09:36:07116NavigationController::NavigationController(
117 TabContents* contents,
118 Profile* profile,
119 SessionStorageNamespace* session_storage_namespace)
initial.commit09911bf2008-07-26 23:55:29120 : profile_(profile),
[email protected]765b35502008-08-21 00:51:20121 pending_entry_(NULL),
122 last_committed_entry_index_(-1),
123 pending_entry_index_(-1),
[email protected]cbab76d2008-10-13 22:42:47124 transient_entry_index_(-1),
[email protected]9423d9412009-04-14 22:13:55125 tab_contents_(contents),
initial.commit09911bf2008-07-26 23:55:29126 max_restored_page_id_(-1),
[email protected]5d063842009-05-15 04:08:24127 ALLOW_THIS_IN_INITIALIZER_LIST(ssl_manager_(this)),
[email protected]38b8f4e2009-09-24 19:44:57128 needs_reload_(false),
[email protected]6ee12c42010-09-14 09:36:07129 session_storage_namespace_(session_storage_namespace),
[email protected]106a0812010-03-18 00:15:12130 pending_reload_(NO_RELOAD) {
initial.commit09911bf2008-07-26 23:55:29131 DCHECK(profile_);
[email protected]6ee12c42010-09-14 09:36:07132 if (!session_storage_namespace_)
133 session_storage_namespace_ = new SessionStorageNamespace(profile_);
initial.commit09911bf2008-07-26 23:55:29134}
135
initial.commit09911bf2008-07-26 23:55:29136NavigationController::~NavigationController() {
[email protected]cbab76d2008-10-13 22:42:47137 DiscardNonCommittedEntriesInternal();
[email protected]c0993872008-08-21 19:59:44138
[email protected]bfd04a62009-02-01 18:16:56139 NotificationService::current()->Notify(
140 NotificationType::TAB_CLOSED,
141 Source<NavigationController>(this),
142 NotificationService::NoDetails());
initial.commit09911bf2008-07-26 23:55:29143}
144
[email protected]ce3fa3c2009-04-20 19:55:57145void NavigationController::RestoreFromState(
146 const std::vector<TabNavigation>& navigations,
[email protected]5e369672009-11-03 23:48:30147 int selected_navigation,
148 bool from_last_session) {
[email protected]ce3fa3c2009-04-20 19:55:57149 // Verify that this controller is unused and that the input is valid.
150 DCHECK(entry_count() == 0 && !pending_entry());
151 DCHECK(selected_navigation >= 0 &&
152 selected_navigation < static_cast<int>(navigations.size()));
153
154 // Populate entries_ from the supplied TabNavigations.
155 needs_reload_ = true;
156 CreateNavigationEntriesFromTabNavigations(navigations, &entries_);
157
158 // And finish the restore.
[email protected]5e369672009-11-03 23:48:30159 FinishRestore(selected_navigation, from_last_session);
[email protected]ce3fa3c2009-04-20 19:55:57160}
161
[email protected]f1c74112008-10-30 16:17:04162void NavigationController::Reload(bool check_for_repost) {
[email protected]1ccb3568d2010-02-19 10:51:16163 ReloadInternal(check_for_repost, RELOAD);
164}
165void NavigationController::ReloadIgnoringCache(bool check_for_repost) {
166 ReloadInternal(check_for_repost, RELOAD_IGNORING_CACHE);
167}
168
169void NavigationController::ReloadInternal(bool check_for_repost,
170 ReloadType reload_type) {
[email protected]cbab76d2008-10-13 22:42:47171 // Reloading a transient entry does nothing.
172 if (transient_entry_index_ != -1)
173 return;
174
175 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:29176 int current_index = GetCurrentEntryIndex();
[email protected]106a0812010-03-18 00:15:12177 // If we are no where, then we can't reload. TODO(darin): We should add a
178 // CanReload method.
179 if (current_index == -1) {
180 return;
181 }
182
[email protected]106a0812010-03-18 00:15:12183 if (check_for_repost_ && check_for_repost &&
[email protected]a3a1d142008-12-19 00:42:30184 GetEntryAtIndex(current_index)->has_post_data()) {
185 // The user is asking to reload a page with POST data. Prompt to make sure
[email protected]b5bb35f2009-02-05 20:17:07186 // they really want to do this. If they do, the dialog will call us back
187 // with check_for_repost = false.
[email protected]965bb092010-04-09 11:59:02188 NotificationService::current()->Notify(
189 NotificationType::REPOST_WARNING_SHOWN,
190 Source<NavigationController>(this),
191 NotificationService::NoDetails());
192
[email protected]106a0812010-03-18 00:15:12193 pending_reload_ = reload_type;
[email protected]9423d9412009-04-14 22:13:55194 tab_contents_->Activate();
[email protected]14f3408a2009-08-31 20:53:53195 tab_contents_->delegate()->ShowRepostFormWarningDialog(tab_contents_);
initial.commit09911bf2008-07-26 23:55:29196 } else {
[email protected]cbab76d2008-10-13 22:42:47197 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20198
199 pending_entry_index_ = current_index;
[email protected]1e5645ff2008-08-27 18:09:07200 entries_[pending_entry_index_]->set_transition_type(PageTransition::RELOAD);
[email protected]1ccb3568d2010-02-19 10:51:16201 NavigateToPendingEntry(reload_type);
initial.commit09911bf2008-07-26 23:55:29202 }
203}
204
[email protected]106a0812010-03-18 00:15:12205void NavigationController::CancelPendingReload() {
206 DCHECK(pending_reload_ != NO_RELOAD);
207 pending_reload_ = NO_RELOAD;
208}
209
210void NavigationController::ContinuePendingReload() {
211 if (pending_reload_ == NO_RELOAD) {
212 NOTREACHED();
213 } else {
214 ReloadInternal(false, pending_reload_);
[email protected]965bb092010-04-09 11:59:02215 pending_reload_ = NO_RELOAD;
[email protected]106a0812010-03-18 00:15:12216 }
217}
218
[email protected]c70f9b82010-04-21 07:31:11219bool NavigationController::IsInitialNavigation() {
220 return last_document_loaded_.is_null();
221}
222
[email protected]b6ea7412010-05-04 23:26:47223// static
224NavigationEntry* NavigationController::CreateNavigationEntry(
225 const GURL& url, const GURL& referrer, PageTransition::Type transition,
226 Profile* profile) {
227 // Allow the browser URL handler to rewrite the URL. This will, for example,
228 // remove "view-source:" from the beginning of the URL to get the URL that
229 // will actually be loaded. This real URL won't be shown to the user, just
230 // used internally.
231 GURL loaded_url(url);
232 bool reverse_on_redirect = false;
233 BrowserURLHandler::RewriteURLIfNecessary(
234 &loaded_url, profile, &reverse_on_redirect);
235
236 NavigationEntry* entry = new NavigationEntry(
237 NULL, // The site instance for tabs is sent on navigation
238 // (TabContents::GetSiteInstance).
239 -1,
240 loaded_url,
241 referrer,
242 string16(),
243 transition);
244 entry->set_virtual_url(url);
245 entry->set_user_typed_url(url);
246 entry->set_update_virtual_url_with_url(reverse_on_redirect);
247 if (url.SchemeIsFile()) {
[email protected]8d19c7d2010-07-01 23:19:02248 // Use the filename as the title, not the full path.
249 // We need to call FormatUrl() to perform URL de-escaping;
250 // it's a bit ugly to grab the filename out of the resulting string.
[email protected]9f284f132010-08-31 06:14:17251 std::string languages =
252 profile->GetPrefs()->GetString(prefs::kAcceptLanguages);
253 std::wstring formatted = UTF16ToWideHack(net::FormatUrl(url, languages));
[email protected]8d19c7d2010-07-01 23:19:02254 std::wstring filename =
255 FilePath::FromWStringHack(formatted).BaseName().ToWStringHack();
256 entry->set_title(WideToUTF16Hack(filename));
[email protected]b6ea7412010-05-04 23:26:47257 }
258 return entry;
259}
260
[email protected]765b35502008-08-21 00:51:20261NavigationEntry* NavigationController::GetEntryWithPageID(
[email protected]7f0005a2009-04-15 03:25:11262 SiteInstance* instance, int32 page_id) const {
263 int index = GetEntryIndexWithPageID(instance, page_id);
[email protected]765b35502008-08-21 00:51:20264 return (index != -1) ? entries_[index].get() : NULL;
265}
266
267void NavigationController::LoadEntry(NavigationEntry* entry) {
[email protected]cd3d7892009-03-04 23:55:06268 // Handle non-navigational URLs that popup dialogs and such, these should not
269 // actually navigate.
270 if (HandleNonNavigationAboutURL(entry->url()))
271 return;
272
[email protected]765b35502008-08-21 00:51:20273 // When navigating to a new page, we don't know for sure if we will actually
274 // end up leaving the current page. The new page load could for example
275 // result in a download or a 'no content' response (e.g., a mailto: URL).
[email protected]cbab76d2008-10-13 22:42:47276 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20277 pending_entry_ = entry;
278 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:56279 NotificationType::NAV_ENTRY_PENDING,
[email protected]765b35502008-08-21 00:51:20280 Source<NavigationController>(this),
281 NotificationService::NoDetails());
[email protected]1ccb3568d2010-02-19 10:51:16282 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20283}
284
[email protected]765b35502008-08-21 00:51:20285NavigationEntry* NavigationController::GetActiveEntry() const {
[email protected]cbab76d2008-10-13 22:42:47286 if (transient_entry_index_ != -1)
287 return entries_[transient_entry_index_].get();
288 if (pending_entry_)
289 return pending_entry_;
290 return GetLastCommittedEntry();
[email protected]765b35502008-08-21 00:51:20291}
292
293int NavigationController::GetCurrentEntryIndex() const {
[email protected]cbab76d2008-10-13 22:42:47294 if (transient_entry_index_ != -1)
295 return transient_entry_index_;
[email protected]765b35502008-08-21 00:51:20296 if (pending_entry_index_ != -1)
297 return pending_entry_index_;
298 return last_committed_entry_index_;
299}
300
301NavigationEntry* NavigationController::GetLastCommittedEntry() const {
302 if (last_committed_entry_index_ == -1)
303 return NULL;
304 return entries_[last_committed_entry_index_].get();
305}
306
[email protected]31682282010-01-15 18:05:16307bool NavigationController::CanViewSource() const {
308 bool is_supported_mime_type = net::IsSupportedNonImageMimeType(
309 tab_contents_->contents_mime_type().c_str());
310 NavigationEntry* active_entry = GetActiveEntry();
311 return active_entry && !active_entry->IsViewSourceMode() &&
312 is_supported_mime_type;
313}
314
[email protected]765b35502008-08-21 00:51:20315NavigationEntry* NavigationController::GetEntryAtOffset(int offset) const {
[email protected]cbab76d2008-10-13 22:42:47316 int index = (transient_entry_index_ != -1) ?
317 transient_entry_index_ + offset :
318 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11319 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20320 return NULL;
321
322 return entries_[index].get();
323}
324
[email protected]765b35502008-08-21 00:51:20325bool NavigationController::CanGoBack() const {
326 return entries_.size() > 1 && GetCurrentEntryIndex() > 0;
327}
328
329bool NavigationController::CanGoForward() const {
330 int index = GetCurrentEntryIndex();
331 return index >= 0 && index < (static_cast<int>(entries_.size()) - 1);
332}
333
334void NavigationController::GoBack() {
335 if (!CanGoBack()) {
336 NOTREACHED();
337 return;
338 }
339
[email protected]25396da2010-03-11 19:19:10340 // If an interstitial page is showing, going back is equivalent to hiding the
341 // interstitial.
342 if (tab_contents_->interstitial_page()) {
343 tab_contents_->interstitial_page()->DontProceed();
344 return;
345 }
346
[email protected]765b35502008-08-21 00:51:20347 // Base the navigation on where we are now...
348 int current_index = GetCurrentEntryIndex();
349
[email protected]cbab76d2008-10-13 22:42:47350 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20351
352 pending_entry_index_ = current_index - 1;
[email protected]784688a62010-09-13 07:06:52353 entries_[pending_entry_index_]->set_transition_type(
354 entries_[pending_entry_index_]->transition_type() |
355 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16356 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20357}
358
359void NavigationController::GoForward() {
360 if (!CanGoForward()) {
361 NOTREACHED();
362 return;
363 }
364
[email protected]25396da2010-03-11 19:19:10365 // If an interstitial page is showing, the previous renderer is blocked and
366 // cannot make new requests. Unblock (and disable) it to allow this
367 // navigation to succeed. The interstitial will stay visible until the
368 // resulting DidNavigate.
369 if (tab_contents_->interstitial_page()) {
370 tab_contents_->interstitial_page()->CancelForNavigation();
371 }
372
[email protected]cbab76d2008-10-13 22:42:47373 bool transient = (transient_entry_index_ != -1);
374
[email protected]765b35502008-08-21 00:51:20375 // Base the navigation on where we are now...
376 int current_index = GetCurrentEntryIndex();
377
[email protected]cbab76d2008-10-13 22:42:47378 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20379
[email protected]cbab76d2008-10-13 22:42:47380 pending_entry_index_ = current_index;
381 // If there was a transient entry, we removed it making the current index
382 // the next page.
383 if (!transient)
384 pending_entry_index_++;
385
[email protected]784688a62010-09-13 07:06:52386 entries_[pending_entry_index_]->set_transition_type(
387 entries_[pending_entry_index_]->transition_type() |
388 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16389 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20390}
391
392void NavigationController::GoToIndex(int index) {
393 if (index < 0 || index >= static_cast<int>(entries_.size())) {
394 NOTREACHED();
395 return;
396 }
397
[email protected]cbab76d2008-10-13 22:42:47398 if (transient_entry_index_ != -1) {
399 if (index == transient_entry_index_) {
400 // Nothing to do when navigating to the transient.
401 return;
402 }
403 if (index > transient_entry_index_) {
404 // Removing the transient is goint to shift all entries by 1.
405 index--;
406 }
407 }
408
[email protected]25396da2010-03-11 19:19:10409 // If an interstitial page is showing, the previous renderer is blocked and
410 // cannot make new requests.
411 if (tab_contents_->interstitial_page()) {
412 if (index == GetCurrentEntryIndex() - 1) {
413 // Going back one entry is equivalent to hiding the interstitial.
414 tab_contents_->interstitial_page()->DontProceed();
415 return;
416 } else {
417 // Unblock the renderer (and disable the interstitial) to allow this
418 // navigation to succeed. The interstitial will stay visible until the
419 // resulting DidNavigate.
420 tab_contents_->interstitial_page()->CancelForNavigation();
421 }
422 }
423
[email protected]cbab76d2008-10-13 22:42:47424 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20425
426 pending_entry_index_ = index;
[email protected]784688a62010-09-13 07:06:52427 entries_[pending_entry_index_]->set_transition_type(
428 entries_[pending_entry_index_]->transition_type() |
429 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16430 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20431}
432
433void NavigationController::GoToOffset(int offset) {
[email protected]cbab76d2008-10-13 22:42:47434 int index = (transient_entry_index_ != -1) ?
435 transient_entry_index_ + offset :
436 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11437 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20438 return;
439
440 GoToIndex(index);
441}
442
[email protected]cbab76d2008-10-13 22:42:47443void NavigationController::RemoveEntryAtIndex(int index,
444 const GURL& default_url) {
445 int size = static_cast<int>(entries_.size());
446 DCHECK(index < size);
447
448 DiscardNonCommittedEntries();
449
450 entries_.erase(entries_.begin() + index);
451
452 if (last_committed_entry_index_ == index) {
453 last_committed_entry_index_--;
454 // 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 }
463 } else if (last_committed_entry_index_ > index) {
464 last_committed_entry_index_--;
465 }
[email protected]cbab76d2008-10-13 22:42:47466}
467
[email protected]38178a42009-12-17 18:58:32468void NavigationController::UpdateVirtualURLToURL(
469 NavigationEntry* entry, const GURL& new_url) {
470 GURL new_virtual_url(new_url);
471 if (BrowserURLHandler::ReverseURLRewrite(
472 &new_virtual_url, entry->virtual_url(), profile_)) {
473 entry->set_virtual_url(new_virtual_url);
474 }
475}
476
[email protected]cbab76d2008-10-13 22:42:47477void NavigationController::AddTransientEntry(NavigationEntry* entry) {
478 // Discard any current transient entry, we can only have one at a time.
479 int index = 0;
480 if (last_committed_entry_index_ != -1)
481 index = last_committed_entry_index_ + 1;
482 DiscardTransientEntry();
483 entries_.insert(entries_.begin() + index, linked_ptr<NavigationEntry>(entry));
[email protected]e1cd5452010-08-26 18:03:25484 transient_entry_index_ = index;
[email protected]8030f012009-09-25 18:09:37485 tab_contents_->NotifyNavigationStateChanged(kInvalidateAllButShelves);
[email protected]cbab76d2008-10-13 22:42:47486}
487
[email protected]c0588052008-10-27 23:01:50488void NavigationController::LoadURL(const GURL& url, const GURL& referrer,
initial.commit09911bf2008-07-26 23:55:29489 PageTransition::Type transition) {
490 // The user initiated a load, we don't need to reload anymore.
491 needs_reload_ = false;
492
[email protected]b6ea7412010-05-04 23:26:47493 NavigationEntry* entry = CreateNavigationEntry(url, referrer, transition,
494 profile_);
initial.commit09911bf2008-07-26 23:55:29495
496 LoadEntry(entry);
497}
498
[email protected]09b8f82f2009-06-16 20:22:11499void NavigationController::DocumentLoadedInFrame() {
500 last_document_loaded_ = base::TimeTicks::Now();
501}
502
[email protected]e9ba4472008-09-14 15:42:43503bool NavigationController::RendererDidNavigate(
504 const ViewHostMsg_FrameNavigate_Params& params,
[email protected]8030f012009-09-25 18:09:37505 int extra_invalidate_flags,
[email protected]e9ba4472008-09-14 15:42:43506 LoadCommittedDetails* details) {
[email protected]4bf3522c2010-08-19 21:00:20507
[email protected]0e8db942008-09-24 21:21:48508 // Save the previous state before we clobber it.
509 if (GetLastCommittedEntry()) {
[email protected]ecd9d8702008-08-28 22:10:17510 details->previous_url = GetLastCommittedEntry()->url();
[email protected]7f0005a2009-04-15 03:25:11511 details->previous_entry_index = last_committed_entry_index();
[email protected]0e8db942008-09-24 21:21:48512 } else {
513 details->previous_url = GURL();
514 details->previous_entry_index = -1;
515 }
[email protected]ecd9d8702008-08-28 22:10:17516
[email protected]e9ba4472008-09-14 15:42:43517 // Assign the current site instance to any pending entry, so we can find it
518 // later by calling GetEntryIndexWithPageID. We only care about this if the
519 // pending entry is an existing navigation and not a new one (or else we
520 // wouldn't care about finding it with GetEntryIndexWithPageID).
521 //
522 // TODO(brettw) this seems slightly bogus as we don't really know if the
523 // pending entry is what this navigation is for. There is a similar TODO
524 // w.r.t. the pending entry in RendererDidNavigateToNewPage.
[email protected]5e369672009-11-03 23:48:30525 if (pending_entry_index_ >= 0) {
[email protected]9423d9412009-04-14 22:13:55526 pending_entry_->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]5e369672009-11-03 23:48:30527 pending_entry_->set_restore_type(NavigationEntry::RESTORE_NONE);
528 }
[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]e9ba4472008-09-14 15:42:43557 // There is nothing we can do with this navigation, so we just return to
558 // the caller that nothing has happened.
559 return false;
560 default:
561 NOTREACHED();
[email protected]765b35502008-08-21 00:51:20562 }
563
[email protected]e9ba4472008-09-14 15:42:43564 // All committed entries should have nonempty content state so WebKit doesn't
565 // get confused when we go back to them (see the function for details).
566 SetContentStateIfEmpty(GetActiveEntry());
[email protected]765b35502008-08-21 00:51:20567
[email protected]e9ba4472008-09-14 15:42:43568 // WebKit doesn't set the "auto" transition on meta refreshes properly (bug
569 // 1051891) so we manually set it for redirects which we normally treat as
570 // "non-user-gestures" where we want to update stuff after navigations.
571 //
572 // Note that the redirect check also checks for a pending entry to
573 // differentiate real redirects from browser initiated navigations to a
574 // redirected entry. This happens when you hit back to go to a page that was
575 // the destination of a redirect, we don't want to treat it as a redirect
576 // even though that's what its transition will be. See bug 1117048.
577 //
578 // TODO(brettw) write a test for this complicated logic.
579 details->is_auto = (PageTransition::IsRedirect(params.transition) &&
[email protected]7f0005a2009-04-15 03:25:11580 !pending_entry()) ||
[email protected]e9ba4472008-09-14 15:42:43581 params.gesture == NavigationGestureAuto;
[email protected]765b35502008-08-21 00:51:20582
[email protected]e9ba4472008-09-14 15:42:43583 // Now prep the rest of the details for the notification and broadcast.
584 details->entry = GetActiveEntry();
[email protected]e9ba4472008-09-14 15:42:43585 details->is_main_frame = PageTransition::IsMainFrame(params.transition);
[email protected]f072d2ce2008-09-17 17:16:24586 details->serialized_security_info = params.security_info;
[email protected]8a3422c92008-09-24 17:42:42587 details->is_content_filtered = params.is_content_filtered;
[email protected]2e39d2e2009-02-19 18:41:31588 details->http_status_code = params.http_status_code;
[email protected]8030f012009-09-25 18:09:37589 NotifyNavigationEntryCommitted(details, extra_invalidate_flags);
initial.commit09911bf2008-07-26 23:55:29590
[email protected]e9ba4472008-09-14 15:42:43591 return true;
initial.commit09911bf2008-07-26 23:55:29592}
593
[email protected]0e8db942008-09-24 21:21:48594NavigationType::Type NavigationController::ClassifyNavigation(
[email protected]e9ba4472008-09-14 15:42:43595 const ViewHostMsg_FrameNavigate_Params& params) const {
[email protected]e9ba4472008-09-14 15:42:43596 if (params.page_id == -1) {
[email protected]eef9de32009-09-23 17:19:46597 // The renderer generates the page IDs, and so if it gives us the invalid
598 // page ID (-1) we know it didn't actually navigate. This happens in a few
599 // cases:
600 //
601 // - If a page makes a popup navigated to about blank, and then writes
602 // stuff like a subframe navigated to a real page. We'll get the commit
603 // for the subframe, but there won't be any commit for the outer page.
604 //
605 // - We were also getting these for failed loads (for example, bug 21849).
606 // The guess is that we get a "load commit" for the alternate error page,
607 // but that doesn't affect the page ID, so we get the "old" one, which
608 // could be invalid. This can also happen for a cross-site transition
609 // that causes us to swap processes. Then the error page load will be in
610 // a new process with no page IDs ever assigned (and hence a -1 value),
611 // yet the navigation controller still might have previous pages in its
612 // list.
613 //
614 // In these cases, there's nothing we can do with them, so ignore.
[email protected]0e8db942008-09-24 21:21:48615 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43616 }
617
[email protected]9423d9412009-04-14 22:13:55618 if (params.page_id > tab_contents_->GetMaxPageID()) {
[email protected]e9ba4472008-09-14 15:42:43619 // Greater page IDs than we've ever seen before are new pages. We may or may
620 // not have a pending entry for the page, and this may or may not be the
621 // main frame.
622 if (PageTransition::IsMainFrame(params.transition))
[email protected]0e8db942008-09-24 21:21:48623 return NavigationType::NEW_PAGE;
[email protected]4c27ba82008-09-24 16:49:09624
625 // When this is a new subframe navigation, we should have a committed page
626 // for which it's a suframe in. This may not be the case when an iframe is
627 // navigated on a popup navigated to about:blank (the iframe would be
628 // written into the popup by script on the main page). For these cases,
629 // there isn't any navigation stuff we can do, so just ignore it.
630 if (!GetLastCommittedEntry())
[email protected]0e8db942008-09-24 21:21:48631 return NavigationType::NAV_IGNORE;
[email protected]4c27ba82008-09-24 16:49:09632
633 // Valid subframe navigation.
[email protected]0e8db942008-09-24 21:21:48634 return NavigationType::NEW_SUBFRAME;
[email protected]e9ba4472008-09-14 15:42:43635 }
636
637 // Now we know that the notification is for an existing page. Find that entry.
638 int existing_entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55639 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43640 params.page_id);
641 if (existing_entry_index == -1) {
[email protected]e9ba4472008-09-14 15:42:43642 // The page was not found. It could have been pruned because of the limit on
643 // back/forward entries (not likely since we'll usually tell it to navigate
644 // to such entries). It could also mean that the renderer is smoking crack.
645 NOTREACHED();
[email protected]0e8db942008-09-24 21:21:48646 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43647 }
648 NavigationEntry* existing_entry = entries_[existing_entry_index].get();
649
[email protected]e6035c22010-05-25 16:15:52650 if (!PageTransition::IsMainFrame(params.transition)) {
651 // All manual subframes would get new IDs and were handled above, so we
652 // know this is auto. Since the current page was found in the navigation
653 // entry list, we're guaranteed to have a last committed entry.
654 DCHECK(GetLastCommittedEntry());
655 return NavigationType::AUTO_SUBFRAME;
656 }
657
658 // Anything below here we know is a main frame navigation.
[email protected]e9ba4472008-09-14 15:42:43659 if (pending_entry_ &&
[email protected]e9ba4472008-09-14 15:42:43660 existing_entry != pending_entry_ &&
[email protected]a0e69262009-06-03 19:08:48661 pending_entry_->page_id() == -1) {
[email protected]e9ba4472008-09-14 15:42:43662 // In this case, we have a pending entry for a URL but WebCore didn't do a
663 // new navigation. This happens when you press enter in the URL bar to
664 // reload. We will create a pending entry, but WebKit will convert it to
665 // a reload since it's the same page and not create a new entry for it
666 // (the user doesn't want to have a new back/forward entry when they do
667 // this). In this case, we want to just ignore the pending entry and go
668 // back to where we were (the "existing entry").
[email protected]0e8db942008-09-24 21:21:48669 return NavigationType::SAME_PAGE;
[email protected]e9ba4472008-09-14 15:42:43670 }
671
[email protected]fc60f222008-12-18 17:36:54672 // Any toplevel navigations with the same base (minus the reference fragment)
673 // are in-page navigations. We weeded out subframe navigations above. Most of
674 // the time this doesn't matter since WebKit doesn't tell us about subframe
675 // navigations that don't actually navigate, but it can happen when there is
676 // an encoding override (it always sends a navigation request).
677 if (AreURLsInPageNavigation(existing_entry->url(), params.url))
678 return NavigationType::IN_PAGE;
679
[email protected]e9ba4472008-09-14 15:42:43680 // Since we weeded out "new" navigations above, we know this is an existing
[email protected]4c27ba82008-09-24 16:49:09681 // (back/forward) navigation.
[email protected]0e8db942008-09-24 21:21:48682 return NavigationType::EXISTING_PAGE;
[email protected]e9ba4472008-09-14 15:42:43683}
684
[email protected]09b8f82f2009-06-16 20:22:11685bool NavigationController::IsRedirect(
686 const ViewHostMsg_FrameNavigate_Params& params) {
687 // For main frame transition, we judge by params.transition.
688 // Otherwise, by params.redirects.
689 if (PageTransition::IsMainFrame(params.transition)) {
690 return PageTransition::IsRedirect(params.transition);
691 }
692 return params.redirects.size() > 1;
693}
694
[email protected]b6ea7412010-05-04 23:26:47695void NavigationController::CreateNavigationEntriesFromTabNavigations(
696 const std::vector<TabNavigation>& navigations,
697 std::vector<linked_ptr<NavigationEntry> >* entries) {
698 // Create a NavigationEntry for each of the navigations.
699 int page_id = 0;
700 for (std::vector<TabNavigation>::const_iterator i =
701 navigations.begin(); i != navigations.end(); ++i, ++page_id) {
702 linked_ptr<NavigationEntry> entry(i->ToNavigationEntry(page_id, profile_));
703 entries->push_back(entry);
704 }
705}
706
[email protected]e9ba4472008-09-14 15:42:43707void NavigationController::RendererDidNavigateToNewPage(
[email protected]befd8d822009-07-01 04:51:47708 const ViewHostMsg_FrameNavigate_Params& params, bool* did_replace_entry) {
[email protected]e9ba4472008-09-14 15:42:43709 NavigationEntry* new_entry;
710 if (pending_entry_) {
711 // TODO(brettw) this assumes that the pending entry is appropriate for the
712 // new page that was just loaded. I don't think this is necessarily the
713 // case! We should have some more tracking to know for sure. This goes along
714 // with a similar TODO at the top of RendererDidNavigate where we blindly
715 // set the site instance on the pending entry.
716 new_entry = new NavigationEntry(*pending_entry_);
717
718 // Don't use the page type from the pending entry. Some interstitial page
719 // may have set the type to interstitial. Once we commit, however, the page
720 // type must always be normal.
[email protected]cccd3762010-11-12 18:40:01721 new_entry->set_page_type(NORMAL_PAGE);
[email protected]e9ba4472008-09-14 15:42:43722 } else {
[email protected]b680ad22009-04-15 23:19:42723 new_entry = new NavigationEntry;
[email protected]e9ba4472008-09-14 15:42:43724 }
725
726 new_entry->set_url(params.url);
[email protected]38178a42009-12-17 18:58:32727 if (new_entry->update_virtual_url_with_url())
728 UpdateVirtualURLToURL(new_entry, params.url);
[email protected]740fbda2009-02-18 21:38:08729 new_entry->set_referrer(params.referrer);
[email protected]e9ba4472008-09-14 15:42:43730 new_entry->set_page_id(params.page_id);
731 new_entry->set_transition_type(params.transition);
[email protected]9423d9412009-04-14 22:13:55732 new_entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43733 new_entry->set_has_post_data(params.is_post);
734
[email protected]befd8d822009-07-01 04:51:47735 InsertOrReplaceEntry(new_entry, *did_replace_entry);
[email protected]e9ba4472008-09-14 15:42:43736}
737
738void NavigationController::RendererDidNavigateToExistingPage(
739 const ViewHostMsg_FrameNavigate_Params& params) {
740 // We should only get here for main frame navigations.
741 DCHECK(PageTransition::IsMainFrame(params.transition));
742
743 // This is a back/forward navigation. The existing page for the ID is
[email protected]4c27ba82008-09-24 16:49:09744 // guaranteed to exist by ClassifyNavigation, and we just need to update it
745 // with new information from the renderer.
[email protected]7f0005a2009-04-15 03:25:11746 int entry_index = GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(),
747 params.page_id);
[email protected]e9ba4472008-09-14 15:42:43748 DCHECK(entry_index >= 0 &&
749 entry_index < static_cast<int>(entries_.size()));
750 NavigationEntry* entry = entries_[entry_index].get();
751
752 // The URL may have changed due to redirects. The site instance will normally
753 // be the same except during session restore, when no site instance will be
754 // assigned.
755 entry->set_url(params.url);
[email protected]38178a42009-12-17 18:58:32756 if (entry->update_virtual_url_with_url())
757 UpdateVirtualURLToURL(entry, params.url);
[email protected]e9ba4472008-09-14 15:42:43758 DCHECK(entry->site_instance() == NULL ||
[email protected]9423d9412009-04-14 22:13:55759 entry->site_instance() == tab_contents_->GetSiteInstance());
760 entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43761
[email protected]d5a49e52010-01-08 03:01:41762 entry->set_has_post_data(params.is_post);
763
[email protected]e9ba4472008-09-14 15:42:43764 // The entry we found in the list might be pending if the user hit
765 // back/forward/reload. This load should commit it (since it's already in the
766 // list, we can just discard the pending pointer).
767 //
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.
770 if (entry == 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
812 // reference fragments, of course).
813 NavigationEntry* new_entry = new NavigationEntry(*existing_entry);
814 new_entry->set_page_id(params.page_id);
[email protected]38178a42009-12-17 18:58:32815 if (new_entry->update_virtual_url_with_url())
816 UpdateVirtualURLToURL(new_entry, params.url);
[email protected]e9ba4472008-09-14 15:42:43817 new_entry->set_url(params.url);
[email protected]ccbe04e2010-03-17 17:58:43818
819 // This replaces the existing entry since the page ID didn't change.
820 *did_replace_entry = true;
821 InsertOrReplaceEntry(new_entry, true);
[email protected]e9ba4472008-09-14 15:42:43822}
823
824void NavigationController::RendererDidNavigateNewSubframe(
825 const ViewHostMsg_FrameNavigate_Params& params) {
[email protected]09b8f82f2009-06-16 20:22:11826 if (PageTransition::StripQualifier(params.transition) ==
827 PageTransition::AUTO_SUBFRAME) {
828 // This is not user-initiated. Ignore.
829 return;
830 }
[email protected]09b8f82f2009-06-16 20:22:11831
[email protected]e9ba4472008-09-14 15:42:43832 // Manual subframe navigations just get the current entry cloned so the user
833 // can go back or forward to it. The actual subframe information will be
834 // stored in the page state for each of those entries. This happens out of
835 // band with the actual navigations.
[email protected]4c27ba82008-09-24 16:49:09836 DCHECK(GetLastCommittedEntry()) << "ClassifyNavigation should guarantee "
837 << "that a last committed entry exists.";
[email protected]e9ba4472008-09-14 15:42:43838 NavigationEntry* new_entry = new NavigationEntry(*GetLastCommittedEntry());
839 new_entry->set_page_id(params.page_id);
[email protected]672eba292009-05-13 13:22:45840 InsertOrReplaceEntry(new_entry, false);
[email protected]e9ba4472008-09-14 15:42:43841}
842
843bool NavigationController::RendererDidNavigateAutoSubframe(
844 const ViewHostMsg_FrameNavigate_Params& params) {
845 // We're guaranteed to have a previously committed entry, and we now need to
846 // handle navigation inside of a subframe in it without creating a new entry.
847 DCHECK(GetLastCommittedEntry());
848
849 // Handle the case where we're navigating back/forward to a previous subframe
850 // navigation entry. This is case "2." in NAV_AUTO_SUBFRAME comment in the
851 // header file. In case "1." this will be a NOP.
852 int entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55853 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43854 params.page_id);
855 if (entry_index < 0 ||
856 entry_index >= static_cast<int>(entries_.size())) {
857 NOTREACHED();
858 return false;
859 }
860
861 // Update the current navigation entry in case we're going back/forward.
862 if (entry_index != last_committed_entry_index_) {
[email protected]e9ba4472008-09-14 15:42:43863 last_committed_entry_index_ = entry_index;
[email protected]e9ba4472008-09-14 15:42:43864 return true;
865 }
866 return false;
867}
868
[email protected]ce3fa3c2009-04-20 19:55:57869// TODO(brettw) I think this function is unnecessary.
[email protected]e9ba4472008-09-14 15:42:43870void NavigationController::CommitPendingEntry() {
[email protected]cbab76d2008-10-13 22:42:47871 DiscardTransientEntry();
872
[email protected]7f0005a2009-04-15 03:25:11873 if (!pending_entry())
[email protected]e9ba4472008-09-14 15:42:43874 return; // Nothing to do.
875
876 // Need to save the previous URL for the notification.
877 LoadCommittedDetails details;
[email protected]0e8db942008-09-24 21:21:48878 if (GetLastCommittedEntry()) {
[email protected]e9ba4472008-09-14 15:42:43879 details.previous_url = GetLastCommittedEntry()->url();
[email protected]7f0005a2009-04-15 03:25:11880 details.previous_entry_index = last_committed_entry_index();
[email protected]0e8db942008-09-24 21:21:48881 } else {
882 details.previous_entry_index = -1;
883 }
[email protected]e9ba4472008-09-14 15:42:43884
885 if (pending_entry_index_ >= 0) {
886 // This is a previous navigation (back/forward) that we're just now
887 // committing. Just mark it as committed.
[email protected]0e8db942008-09-24 21:21:48888 details.type = NavigationType::EXISTING_PAGE;
[email protected]e9ba4472008-09-14 15:42:43889 int new_entry_index = pending_entry_index_;
[email protected]cbab76d2008-10-13 22:42:47890 DiscardNonCommittedEntriesInternal();
[email protected]e9ba4472008-09-14 15:42:43891
892 // Mark that entry as committed.
[email protected]e9ba4472008-09-14 15:42:43893 last_committed_entry_index_ = new_entry_index;
[email protected]e9ba4472008-09-14 15:42:43894 } else {
895 // This is a new navigation. It's easiest to just copy the entry and insert
[email protected]672eba292009-05-13 13:22:45896 // it new again, since InsertOrReplaceEntry expects to take ownership and
897 // also discard the pending entry. We also need to synthesize a page ID. We
898 // can only do this because this function will only be called by our custom
[email protected]57c6a652009-05-04 07:58:34899 // TabContents types. For TabContents, the IDs are generated by the
[email protected]e9ba4472008-09-14 15:42:43900 // renderer, so we can't do this.
[email protected]0e8db942008-09-24 21:21:48901 details.type = NavigationType::NEW_PAGE;
[email protected]9423d9412009-04-14 22:13:55902 pending_entry_->set_page_id(tab_contents_->GetMaxPageID() + 1);
903 tab_contents_->UpdateMaxPageID(pending_entry_->page_id());
[email protected]672eba292009-05-13 13:22:45904 InsertOrReplaceEntry(new NavigationEntry(*pending_entry_), false);
[email protected]e9ba4472008-09-14 15:42:43905 }
906
907 // Broadcast the notification of the navigation.
908 details.entry = GetActiveEntry();
909 details.is_auto = false;
910 details.is_in_page = AreURLsInPageNavigation(details.previous_url,
911 details.entry->url());
912 details.is_main_frame = true;
[email protected]8030f012009-09-25 18:09:37913 NotifyNavigationEntryCommitted(&details, 0);
[email protected]e9ba4472008-09-14 15:42:43914}
[email protected]765b35502008-08-21 00:51:20915
916int NavigationController::GetIndexOfEntry(
917 const NavigationEntry* entry) const {
918 const NavigationEntries::const_iterator i(std::find(
919 entries_.begin(),
920 entries_.end(),
921 entry));
922 return (i == entries_.end()) ? -1 : static_cast<int>(i - entries_.begin());
923}
924
[email protected]e9ba4472008-09-14 15:42:43925bool NavigationController::IsURLInPageNavigation(const GURL& url) const {
926 NavigationEntry* last_committed = GetLastCommittedEntry();
927 if (!last_committed)
928 return false;
929 return AreURLsInPageNavigation(last_committed->url(), url);
930}
931
[email protected]ce3fa3c2009-04-20 19:55:57932void NavigationController::CopyStateFrom(const NavigationController& source) {
933 // Verify that we look new.
934 DCHECK(entry_count() == 0 && !pending_entry());
935
936 if (source.entry_count() == 0)
937 return; // Nothing new to do.
938
939 needs_reload_ = true;
[email protected]e1cd5452010-08-26 18:03:25940 InsertEntriesFrom(source, source.entry_count());
[email protected]ce3fa3c2009-04-20 19:55:57941
[email protected]6ee12c42010-09-14 09:36:07942 session_storage_namespace_ = source.session_storage_namespace_->Clone();
[email protected]4e6419c2010-01-15 04:50:34943
[email protected]5e369672009-11-03 23:48:30944 FinishRestore(source.last_committed_entry_index_, false);
[email protected]ce3fa3c2009-04-20 19:55:57945}
946
[email protected]47e020a2010-10-15 14:43:37947void NavigationController::CopyStateFromAndPrune(NavigationController* source) {
[email protected]e1cd5452010-08-26 18:03:25948 // This code is intended for use when the last entry is the active entry.
949 DCHECK((transient_entry_index_ != -1 &&
950 transient_entry_index_ == entry_count() - 1) ||
951 (pending_entry_ && (pending_entry_index_ == -1 ||
952 pending_entry_index_ == entry_count() - 1)) ||
953 (!pending_entry_ && last_committed_entry_index_ == entry_count() - 1));
954
955 // Remove all the entries leaving the active entry.
956 PruneAllButActive();
957
[email protected]47e020a2010-10-15 14:43:37958 // Insert the entries from source. Don't use source->GetCurrentEntryIndex as
[email protected]e1cd5452010-08-26 18:03:25959 // we don't want to copy over the transient entry.
[email protected]47e020a2010-10-15 14:43:37960 int max_source_index = source->pending_entry_index_ != -1 ?
961 source->pending_entry_index_ : source->last_committed_entry_index_;
[email protected]e1cd5452010-08-26 18:03:25962 if (max_source_index == -1)
[email protected]47e020a2010-10-15 14:43:37963 max_source_index = source->entry_count();
[email protected]e1cd5452010-08-26 18:03:25964 else
965 max_source_index++;
[email protected]47e020a2010-10-15 14:43:37966 InsertEntriesFrom(*source, max_source_index);
[email protected]e1cd5452010-08-26 18:03:25967
968 // Adjust indices such that the last entry and pending are at the end now.
969 last_committed_entry_index_ = entry_count() - 1;
970 if (pending_entry_index_ != -1)
971 pending_entry_index_ = entry_count() - 1;
972 if (transient_entry_index_ != -1) {
973 // There's a transient entry. In this case we want the last committed to
974 // point to the previous entry.
975 transient_entry_index_ = entry_count() - 1;
976 if (last_committed_entry_index_ != -1)
977 last_committed_entry_index_--;
978 }
979
980 // Take over the session id from source.
[email protected]47e020a2010-10-15 14:43:37981 session_id_ = source->session_id_;
982
983 // Reset source's session id as we're taking it over.
984 source->session_id_.clear();
[email protected]e1cd5452010-08-26 18:03:25985}
986
[email protected]97b6c4f2010-09-27 19:31:26987void NavigationController::PruneAllButActive() {
988 int prune_count = entry_count();
989 if (transient_entry_index_ != -1) {
990 // There is a transient entry. Prune up to it.
991 DCHECK_EQ(entry_count() - 1, transient_entry_index_);
992 prune_count = transient_entry_index_;
993 transient_entry_index_ = 0;
994 last_committed_entry_index_ = -1;
995 pending_entry_index_ = -1;
996 } else if (!pending_entry_) {
997 // There's no pending entry. Leave the last entry (if there is one).
998 if (!prune_count)
999 return;
1000
1001 prune_count--;
1002 last_committed_entry_index_ = 0;
1003 } else if (pending_entry_index_ != -1) {
1004 DCHECK_EQ(pending_entry_index_, prune_count - 1);
1005 pending_entry_index_ = 0;
1006 last_committed_entry_index_ = 0;
1007 prune_count--;
1008 } else {
1009 // There is a pending_entry, but it's not in entries_.
1010 pending_entry_index_ = -1;
1011 last_committed_entry_index_ = -1;
1012 }
1013
1014 if (tab_contents_->interstitial_page()) {
1015 // Normally the interstitial page hides itself if the user doesn't proceeed.
1016 // This would result in showing a NavigationEntry we just removed. Set this
1017 // so the interstitial triggers a reload if the user doesn't proceed.
1018 tab_contents_->interstitial_page()->set_reload_on_dont_proceed(true);
1019 }
1020
1021 entries_.erase(entries_.begin(), entries_.begin() + prune_count);
1022}
1023
[email protected]cbab76d2008-10-13 22:42:471024void NavigationController::DiscardNonCommittedEntries() {
1025 bool transient = transient_entry_index_ != -1;
1026 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:291027
[email protected]cbab76d2008-10-13 22:42:471028 // If there was a transient entry, invalidate everything so the new active
1029 // entry state is shown.
1030 if (transient) {
[email protected]8030f012009-09-25 18:09:371031 tab_contents_->NotifyNavigationStateChanged(kInvalidateAllButShelves);
[email protected]cbab76d2008-10-13 22:42:471032 }
initial.commit09911bf2008-07-26 23:55:291033}
1034
[email protected]672eba292009-05-13 13:22:451035void NavigationController::InsertOrReplaceEntry(NavigationEntry* entry,
1036 bool replace) {
[email protected]1e5645ff2008-08-27 18:09:071037 DCHECK(entry->transition_type() != PageTransition::AUTO_SUBFRAME);
[email protected]765b35502008-08-21 00:51:201038
1039 // Copy the pending entry's unique ID to the committed entry.
1040 // I don't know if pending_entry_index_ can be other than -1 here.
1041 const NavigationEntry* const pending_entry = (pending_entry_index_ == -1) ?
1042 pending_entry_ : entries_[pending_entry_index_].get();
1043 if (pending_entry)
1044 entry->set_unique_id(pending_entry->unique_id());
1045
[email protected]cbab76d2008-10-13 22:42:471046 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:201047
1048 int current_size = static_cast<int>(entries_.size());
1049
[email protected]765b35502008-08-21 00:51:201050 if (current_size > 0) {
[email protected]672eba292009-05-13 13:22:451051 // Prune any entries which are in front of the current entry.
1052 // Also prune the current entry if we are to replace the current entry.
1053 int prune_up_to = replace ? last_committed_entry_index_ - 1
1054 : last_committed_entry_index_;
[email protected]c12bf1a12008-09-17 16:28:491055 int num_pruned = 0;
[email protected]672eba292009-05-13 13:22:451056 while (prune_up_to < (current_size - 1)) {
[email protected]c12bf1a12008-09-17 16:28:491057 num_pruned++;
[email protected]765b35502008-08-21 00:51:201058 entries_.pop_back();
1059 current_size--;
1060 }
[email protected]c12bf1a12008-09-17 16:28:491061 if (num_pruned > 0) // Only notify if we did prune something.
1062 NotifyPrunedEntries(this, false, num_pruned);
[email protected]765b35502008-08-21 00:51:201063 }
1064
[email protected]c12bf1a12008-09-17 16:28:491065 if (entries_.size() >= max_entry_count_) {
[email protected]cbab76d2008-10-13 22:42:471066 RemoveEntryAtIndex(0, GURL());
[email protected]c12bf1a12008-09-17 16:28:491067 NotifyPrunedEntries(this, true, 1);
1068 }
[email protected]765b35502008-08-21 00:51:201069
1070 entries_.push_back(linked_ptr<NavigationEntry>(entry));
1071 last_committed_entry_index_ = static_cast<int>(entries_.size()) - 1;
[email protected]e9ba4472008-09-14 15:42:431072
1073 // This is a new page ID, so we need everybody to know about it.
[email protected]9423d9412009-04-14 22:13:551074 tab_contents_->UpdateMaxPageID(entry->page_id());
initial.commit09911bf2008-07-26 23:55:291075}
1076
1077void NavigationController::SetWindowID(const SessionID& id) {
1078 window_id_ = id;
[email protected]bfd04a62009-02-01 18:16:561079 NotificationService::current()->Notify(NotificationType::TAB_PARENTED,
[email protected]534e54b2008-08-13 15:40:091080 Source<NavigationController>(this),
1081 NotificationService::NoDetails());
initial.commit09911bf2008-07-26 23:55:291082}
1083
[email protected]1ccb3568d2010-02-19 10:51:161084void NavigationController::NavigateToPendingEntry(ReloadType reload_type) {
[email protected]72097fd02010-01-21 23:36:011085 needs_reload_ = false;
1086
initial.commit09911bf2008-07-26 23:55:291087 // For session history navigations only the pending_entry_index_ is set.
1088 if (!pending_entry_) {
[email protected]4bf3522c2010-08-19 21:00:201089 DCHECK_NE(pending_entry_index_, -1);
[email protected]765b35502008-08-21 00:51:201090 pending_entry_ = entries_[pending_entry_index_].get();
initial.commit09911bf2008-07-26 23:55:291091 }
1092
[email protected]1ccb3568d2010-02-19 10:51:161093 if (!tab_contents_->NavigateToPendingEntry(reload_type))
[email protected]cbab76d2008-10-13 22:42:471094 DiscardNonCommittedEntries();
initial.commit09911bf2008-07-26 23:55:291095}
1096
[email protected]ecd9d8702008-08-28 22:10:171097void NavigationController::NotifyNavigationEntryCommitted(
[email protected]8030f012009-09-25 18:09:371098 LoadCommittedDetails* details,
1099 int extra_invalidate_flags) {
[email protected]df1af242009-05-01 00:11:401100 details->entry = GetActiveEntry();
1101 NotificationDetails notification_details =
1102 Details<LoadCommittedDetails>(details);
1103
1104 // We need to notify the ssl_manager_ before the tab_contents_ so the
1105 // location bar will have up-to-date information about the security style
1106 // when it wants to draw. See http://crbug.com/11157
1107 ssl_manager_.DidCommitProvisionalLoad(notification_details);
1108
initial.commit09911bf2008-07-26 23:55:291109 // TODO(pkasting): http://b/1113079 Probably these explicit notification paths
1110 // should be removed, and interested parties should just listen for the
1111 // notification below instead.
[email protected]9423d9412009-04-14 22:13:551112 tab_contents_->NotifyNavigationStateChanged(
[email protected]6ebdc9b2010-09-27 16:55:571113 kInvalidateAllButShelves | extra_invalidate_flags);
initial.commit09911bf2008-07-26 23:55:291114
[email protected]ecd9d8702008-08-28 22:10:171115 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:561116 NotificationType::NAV_ENTRY_COMMITTED,
[email protected]ecd9d8702008-08-28 22:10:171117 Source<NavigationController>(this),
[email protected]df1af242009-05-01 00:11:401118 notification_details);
initial.commit09911bf2008-07-26 23:55:291119}
1120
initial.commit09911bf2008-07-26 23:55:291121// static
1122void NavigationController::DisablePromptOnRepost() {
1123 check_for_repost_ = false;
1124}
1125
1126void NavigationController::SetActive(bool is_active) {
[email protected]ee613922009-09-02 20:38:221127 if (is_active && needs_reload_)
1128 LoadIfNecessary();
initial.commit09911bf2008-07-26 23:55:291129}
1130
1131void NavigationController::LoadIfNecessary() {
1132 if (!needs_reload_)
1133 return;
1134
initial.commit09911bf2008-07-26 23:55:291135 // Calling Reload() results in ignoring state, and not loading.
1136 // Explicitly use NavigateToPendingEntry so that the renderer uses the
1137 // cached state.
1138 pending_entry_index_ = last_committed_entry_index_;
[email protected]1ccb3568d2010-02-19 10:51:161139 NavigateToPendingEntry(NO_RELOAD);
initial.commit09911bf2008-07-26 23:55:291140}
1141
[email protected]534e54b2008-08-13 15:40:091142void NavigationController::NotifyEntryChanged(const NavigationEntry* entry,
1143 int index) {
1144 EntryChangedDetails det;
1145 det.changed_entry = entry;
1146 det.index = index;
[email protected]bfd04a62009-02-01 18:16:561147 NotificationService::current()->Notify(NotificationType::NAV_ENTRY_CHANGED,
[email protected]534e54b2008-08-13 15:40:091148 Source<NavigationController>(this),
1149 Details<EntryChangedDetails>(&det));
initial.commit09911bf2008-07-26 23:55:291150}
1151
[email protected]5e369672009-11-03 23:48:301152void NavigationController::FinishRestore(int selected_index,
1153 bool from_last_session) {
[email protected]7f0005a2009-04-15 03:25:111154 DCHECK(selected_index >= 0 && selected_index < entry_count());
[email protected]5e369672009-11-03 23:48:301155 ConfigureEntriesForRestore(&entries_, from_last_session);
initial.commit09911bf2008-07-26 23:55:291156
[email protected]61398152010-08-26 21:45:341157 set_max_restored_page_id(static_cast<int32>(entry_count()));
initial.commit09911bf2008-07-26 23:55:291158
1159 last_committed_entry_index_ = selected_index;
initial.commit09911bf2008-07-26 23:55:291160}
[email protected]765b35502008-08-21 00:51:201161
[email protected]cbab76d2008-10-13 22:42:471162void NavigationController::DiscardNonCommittedEntriesInternal() {
[email protected]765b35502008-08-21 00:51:201163 if (pending_entry_index_ == -1)
1164 delete pending_entry_;
1165 pending_entry_ = NULL;
1166 pending_entry_index_ = -1;
[email protected]cbab76d2008-10-13 22:42:471167
1168 DiscardTransientEntry();
1169}
1170
1171void NavigationController::DiscardTransientEntry() {
1172 if (transient_entry_index_ == -1)
1173 return;
[email protected]a0e69262009-06-03 19:08:481174 entries_.erase(entries_.begin() + transient_entry_index_);
[email protected]80858db52009-10-15 00:35:181175 if (last_committed_entry_index_ > transient_entry_index_)
1176 last_committed_entry_index_--;
[email protected]cbab76d2008-10-13 22:42:471177 transient_entry_index_ = -1;
[email protected]765b35502008-08-21 00:51:201178}
1179
1180int NavigationController::GetEntryIndexWithPageID(
[email protected]7f0005a2009-04-15 03:25:111181 SiteInstance* instance, int32 page_id) const {
[email protected]765b35502008-08-21 00:51:201182 for (int i = static_cast<int>(entries_.size()) - 1; i >= 0; --i) {
[email protected]7f0005a2009-04-15 03:25:111183 if ((entries_[i]->site_instance() == instance) &&
[email protected]1e5645ff2008-08-27 18:09:071184 (entries_[i]->page_id() == page_id))
[email protected]765b35502008-08-21 00:51:201185 return i;
1186 }
1187 return -1;
1188}
[email protected]cbab76d2008-10-13 22:42:471189
1190NavigationEntry* NavigationController::GetTransientEntry() const {
1191 if (transient_entry_index_ == -1)
1192 return NULL;
1193 return entries_[transient_entry_index_].get();
1194}
[email protected]e1cd5452010-08-26 18:03:251195
[email protected]e1cd5452010-08-26 18:03:251196void NavigationController::InsertEntriesFrom(
1197 const NavigationController& source,
1198 int max_index) {
1199 DCHECK_LE(max_index, source.entry_count());
1200 size_t insert_index = 0;
1201 for (int i = 0; i < max_index; i++) {
1202 // When cloning a tab, copy all entries except interstitial pages
[email protected]cccd3762010-11-12 18:40:011203 if (source.entries_[i].get()->page_type() != INTERSTITIAL_PAGE) {
[email protected]e1cd5452010-08-26 18:03:251204 entries_.insert(entries_.begin() + insert_index++,
1205 linked_ptr<NavigationEntry>(
1206 new NavigationEntry(*source.entries_[i])));
1207 }
1208 }
1209}