blob: 2ac9aba98be7287c2c3e5c7cf79f137de0276370 [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]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]cd3d7892009-03-04 23:55:0612#include "chrome/browser/browser_about_handler.h"
[email protected]9423d9412009-04-14 22:13:5513#include "chrome/browser/browser_url_handler.h"
[email protected]6ee12c42010-09-14 09:36:0714#include "chrome/browser/in_process_webkit/session_storage_namespace.h"
[email protected]37858e52010-08-26 00:22:0215#include "chrome/browser/prefs/pref_service.h"
[email protected]8ecad5e2010-12-02 21:18:3316#include "chrome/browser/profiles/profile.h"
[email protected]14e60c8d2009-06-29 03:56:5117#include "chrome/browser/renderer_host/site_instance.h"
[email protected]169627b2008-12-06 19:30:1918#include "chrome/browser/sessions/session_types.h"
[email protected]3cc72b12010-03-18 23:03:0019#include "chrome/common/chrome_constants.h"
[email protected]299dabd2008-11-19 02:27:1620#include "chrome/common/navigation_types.h"
[email protected]bfd04a62009-02-01 18:16:5621#include "chrome/common/notification_service.h"
[email protected]a23de8572009-06-03 02:16:3222#include "chrome/common/pref_names.h"
[email protected]939856a2010-08-24 20:29:0223#include "chrome/common/render_messages_params.h"
[email protected]6de74452009-02-25 18:04:5924#include "chrome/common/url_constants.h"
[email protected]0dd3a0ab2011-02-18 08:17:4425#include "content/browser/tab_contents/interstitial_page.h"
26#include "content/browser/tab_contents/navigation_entry.h"
27#include "content/browser/tab_contents/tab_contents.h"
28#include "content/browser/tab_contents/tab_contents_delegate.h"
[email protected]074f10562009-05-21 22:40:0529#include "grit/app_resources.h"
[email protected]a23de8572009-06-03 02:16:3230#include "net/base/escape.h"
31#include "net/base/net_util.h"
[email protected]31682282010-01-15 18:05:1632#include "net/base/mime_util.h"
[email protected]765b35502008-08-21 00:51:2033#include "webkit/glue/webkit_glue.h"
initial.commit09911bf2008-07-26 23:55:2934
[email protected]e9ba4472008-09-14 15:42:4335namespace {
36
[email protected]8030f012009-09-25 18:09:3737const int kInvalidateAllButShelves =
[email protected]6d7a6042010-08-12 20:12:4238 0xFFFFFFFF & ~TabContents::INVALIDATE_BOOKMARK_BAR;
[email protected]8030f012009-09-25 18:09:3739
[email protected]e9ba4472008-09-14 15:42:4340// Invoked when entries have been pruned, or removed. For example, if the
41// current entries are [google, digg, yahoo], with the current entry google,
42// and the user types in cnet, then digg and yahoo are pruned.
[email protected]c12bf1a12008-09-17 16:28:4943void NotifyPrunedEntries(NavigationController* nav_controller,
44 bool from_front,
45 int count) {
46 NavigationController::PrunedDetails details;
47 details.from_front = from_front;
48 details.count = count;
[email protected]e9ba4472008-09-14 15:42:4349 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:5650 NotificationType::NAV_LIST_PRUNED,
[email protected]e9ba4472008-09-14 15:42:4351 Source<NavigationController>(nav_controller),
[email protected]c12bf1a12008-09-17 16:28:4952 Details<NavigationController::PrunedDetails>(&details));
[email protected]e9ba4472008-09-14 15:42:4353}
54
55// Ensure the given NavigationEntry has a valid state, so that WebKit does not
56// get confused if we navigate back to it.
[email protected]40bcc302009-03-02 20:50:3957//
[email protected]e9ba4472008-09-14 15:42:4358// An empty state is treated as a new navigation by WebKit, which would mean
59// losing the navigation entries and generating a new navigation entry after
60// this one. We don't want that. To avoid this we create a valid state which
61// WebKit will not treat as a new navigation.
62void SetContentStateIfEmpty(NavigationEntry* entry) {
[email protected]965524b2009-04-04 21:32:4063 if (entry->content_state().empty()) {
[email protected]e9ba4472008-09-14 15:42:4364 entry->set_content_state(
65 webkit_glue::CreateHistoryStateForURL(entry->url()));
66 }
67}
68
69// Configure all the NavigationEntries in entries for restore. This resets
70// the transition type to reload and makes sure the content state isn't empty.
71void ConfigureEntriesForRestore(
[email protected]5e369672009-11-03 23:48:3072 std::vector<linked_ptr<NavigationEntry> >* entries,
73 bool from_last_session) {
[email protected]e9ba4472008-09-14 15:42:4374 for (size_t i = 0; i < entries->size(); ++i) {
75 // Use a transition type of reload so that we don't incorrectly increase
76 // the typed count.
77 (*entries)[i]->set_transition_type(PageTransition::RELOAD);
[email protected]5e369672009-11-03 23:48:3078 (*entries)[i]->set_restore_type(from_last_session ?
79 NavigationEntry::RESTORE_LAST_SESSION :
80 NavigationEntry::RESTORE_CURRENT_SESSION);
[email protected]e9ba4472008-09-14 15:42:4381 // NOTE(darin): This code is only needed for backwards compat.
82 SetContentStateIfEmpty((*entries)[i].get());
83 }
84}
85
86// See NavigationController::IsURLInPageNavigation for how this works and why.
87bool AreURLsInPageNavigation(const GURL& existing_url, const GURL& new_url) {
[email protected]192d8c5e2010-02-23 07:26:3288 if (existing_url == new_url || !new_url.has_ref()) {
89 // TODO(jcampan): what about when navigating back from a ref URL to the top
90 // non ref URL? Nothing is loaded in that case but we return false here.
91 // The user could also navigate from the ref URL to the non ref URL by
92 // entering the non ref URL in the location bar or through a bookmark, in
93 // which case there would be a load. I am not sure if the non-load/load
94 // scenarios can be differentiated with the TransitionType.
[email protected]e9ba4472008-09-14 15:42:4395 return false;
[email protected]192d8c5e2010-02-23 07:26:3296 }
[email protected]e9ba4472008-09-14 15:42:4397
98 url_canon::Replacements<char> replacements;
99 replacements.ClearRef();
100 return existing_url.ReplaceComponents(replacements) ==
101 new_url.ReplaceComponents(replacements);
102}
103
104} // namespace
105
initial.commit09911bf2008-07-26 23:55:29106// NavigationController ---------------------------------------------------
107
[email protected]765b35502008-08-21 00:51:20108// static
[email protected]3cc72b12010-03-18 23:03:00109size_t NavigationController::max_entry_count_ =
110 chrome::kMaxSessionHistoryEntries;
[email protected]765b35502008-08-21 00:51:20111
initial.commit09911bf2008-07-26 23:55:29112// static
113bool NavigationController::check_for_repost_ = true;
114
[email protected]6ee12c42010-09-14 09:36:07115NavigationController::NavigationController(
116 TabContents* contents,
117 Profile* profile,
118 SessionStorageNamespace* session_storage_namespace)
initial.commit09911bf2008-07-26 23:55:29119 : profile_(profile),
[email protected]765b35502008-08-21 00:51:20120 pending_entry_(NULL),
121 last_committed_entry_index_(-1),
122 pending_entry_index_(-1),
[email protected]cbab76d2008-10-13 22:42:47123 transient_entry_index_(-1),
[email protected]9423d9412009-04-14 22:13:55124 tab_contents_(contents),
initial.commit09911bf2008-07-26 23:55:29125 max_restored_page_id_(-1),
[email protected]5d063842009-05-15 04:08:24126 ALLOW_THIS_IN_INITIALIZER_LIST(ssl_manager_(this)),
[email protected]38b8f4e2009-09-24 19:44:57127 needs_reload_(false),
[email protected]6ee12c42010-09-14 09:36:07128 session_storage_namespace_(session_storage_namespace),
[email protected]106a0812010-03-18 00:15:12129 pending_reload_(NO_RELOAD) {
initial.commit09911bf2008-07-26 23:55:29130 DCHECK(profile_);
[email protected]6ee12c42010-09-14 09:36:07131 if (!session_storage_namespace_)
132 session_storage_namespace_ = new SessionStorageNamespace(profile_);
initial.commit09911bf2008-07-26 23:55:29133}
134
initial.commit09911bf2008-07-26 23:55:29135NavigationController::~NavigationController() {
[email protected]cbab76d2008-10-13 22:42:47136 DiscardNonCommittedEntriesInternal();
[email protected]c0993872008-08-21 19:59:44137
[email protected]bfd04a62009-02-01 18:16:56138 NotificationService::current()->Notify(
139 NotificationType::TAB_CLOSED,
140 Source<NavigationController>(this),
141 NotificationService::NoDetails());
initial.commit09911bf2008-07-26 23:55:29142}
143
[email protected]ce3fa3c2009-04-20 19:55:57144void NavigationController::RestoreFromState(
145 const std::vector<TabNavigation>& navigations,
[email protected]5e369672009-11-03 23:48:30146 int selected_navigation,
147 bool from_last_session) {
[email protected]ce3fa3c2009-04-20 19:55:57148 // Verify that this controller is unused and that the input is valid.
149 DCHECK(entry_count() == 0 && !pending_entry());
150 DCHECK(selected_navigation >= 0 &&
151 selected_navigation < static_cast<int>(navigations.size()));
152
153 // Populate entries_ from the supplied TabNavigations.
154 needs_reload_ = true;
155 CreateNavigationEntriesFromTabNavigations(navigations, &entries_);
156
157 // And finish the restore.
[email protected]5e369672009-11-03 23:48:30158 FinishRestore(selected_navigation, from_last_session);
[email protected]ce3fa3c2009-04-20 19:55:57159}
160
[email protected]f1c74112008-10-30 16:17:04161void NavigationController::Reload(bool check_for_repost) {
[email protected]1ccb3568d2010-02-19 10:51:16162 ReloadInternal(check_for_repost, RELOAD);
163}
164void NavigationController::ReloadIgnoringCache(bool check_for_repost) {
165 ReloadInternal(check_for_repost, RELOAD_IGNORING_CACHE);
166}
167
168void NavigationController::ReloadInternal(bool check_for_repost,
169 ReloadType reload_type) {
[email protected]cbab76d2008-10-13 22:42:47170 // Reloading a transient entry does nothing.
171 if (transient_entry_index_ != -1)
172 return;
173
174 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:29175 int current_index = GetCurrentEntryIndex();
[email protected]106a0812010-03-18 00:15:12176 // If we are no where, then we can't reload. TODO(darin): We should add a
177 // CanReload method.
178 if (current_index == -1) {
179 return;
180 }
181
[email protected]106a0812010-03-18 00:15:12182 if (check_for_repost_ && check_for_repost &&
[email protected]a3a1d142008-12-19 00:42:30183 GetEntryAtIndex(current_index)->has_post_data()) {
184 // The user is asking to reload a page with POST data. Prompt to make sure
[email protected]b5bb35f2009-02-05 20:17:07185 // they really want to do this. If they do, the dialog will call us back
186 // with check_for_repost = false.
[email protected]965bb092010-04-09 11:59:02187 NotificationService::current()->Notify(
188 NotificationType::REPOST_WARNING_SHOWN,
189 Source<NavigationController>(this),
190 NotificationService::NoDetails());
191
[email protected]106a0812010-03-18 00:15:12192 pending_reload_ = reload_type;
[email protected]9423d9412009-04-14 22:13:55193 tab_contents_->Activate();
[email protected]14f3408a2009-08-31 20:53:53194 tab_contents_->delegate()->ShowRepostFormWarningDialog(tab_contents_);
initial.commit09911bf2008-07-26 23:55:29195 } else {
[email protected]cbab76d2008-10-13 22:42:47196 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20197
198 pending_entry_index_ = current_index;
[email protected]1e5645ff2008-08-27 18:09:07199 entries_[pending_entry_index_]->set_transition_type(PageTransition::RELOAD);
[email protected]1ccb3568d2010-02-19 10:51:16200 NavigateToPendingEntry(reload_type);
initial.commit09911bf2008-07-26 23:55:29201 }
202}
203
[email protected]106a0812010-03-18 00:15:12204void NavigationController::CancelPendingReload() {
205 DCHECK(pending_reload_ != NO_RELOAD);
206 pending_reload_ = NO_RELOAD;
207}
208
209void NavigationController::ContinuePendingReload() {
210 if (pending_reload_ == NO_RELOAD) {
211 NOTREACHED();
212 } else {
213 ReloadInternal(false, pending_reload_);
[email protected]965bb092010-04-09 11:59:02214 pending_reload_ = NO_RELOAD;
[email protected]106a0812010-03-18 00:15:12215 }
216}
217
[email protected]c70f9b82010-04-21 07:31:11218bool NavigationController::IsInitialNavigation() {
219 return last_document_loaded_.is_null();
220}
221
[email protected]b6ea7412010-05-04 23:26:47222// static
223NavigationEntry* NavigationController::CreateNavigationEntry(
224 const GURL& url, const GURL& referrer, PageTransition::Type transition,
225 Profile* profile) {
226 // 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;
232 BrowserURLHandler::RewriteURLIfNecessary(
233 &loaded_url, profile, &reverse_on_redirect);
234
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,
241 string16(),
242 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);
246 if (url.SchemeIsFile()) {
[email protected]8d19c7d2010-07-01 23:19:02247 // Use the filename as the title, not the full path.
248 // We need to call FormatUrl() to perform URL de-escaping;
249 // it's a bit ugly to grab the filename out of the resulting string.
[email protected]9f284f132010-08-31 06:14:17250 std::string languages =
251 profile->GetPrefs()->GetString(prefs::kAcceptLanguages);
252 std::wstring formatted = UTF16ToWideHack(net::FormatUrl(url, languages));
[email protected]8d19c7d2010-07-01 23:19:02253 std::wstring filename =
254 FilePath::FromWStringHack(formatted).BaseName().ToWStringHack();
255 entry->set_title(WideToUTF16Hack(filename));
[email protected]b6ea7412010-05-04 23:26:47256 }
257 return entry;
258}
259
[email protected]765b35502008-08-21 00:51:20260NavigationEntry* NavigationController::GetEntryWithPageID(
[email protected]7f0005a2009-04-15 03:25:11261 SiteInstance* instance, int32 page_id) const {
262 int index = GetEntryIndexWithPageID(instance, page_id);
[email protected]765b35502008-08-21 00:51:20263 return (index != -1) ? entries_[index].get() : NULL;
264}
265
266void NavigationController::LoadEntry(NavigationEntry* entry) {
[email protected]cd3d7892009-03-04 23:55:06267 // Handle non-navigational URLs that popup dialogs and such, these should not
268 // actually navigate.
269 if (HandleNonNavigationAboutURL(entry->url()))
270 return;
271
[email protected]765b35502008-08-21 00:51:20272 // When navigating to a new page, we don't know for sure if we will actually
273 // end up leaving the current page. The new page load could for example
274 // result in a download or a 'no content' response (e.g., a mailto: URL).
[email protected]cbab76d2008-10-13 22:42:47275 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:20276 pending_entry_ = entry;
277 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:56278 NotificationType::NAV_ENTRY_PENDING,
[email protected]765b35502008-08-21 00:51:20279 Source<NavigationController>(this),
280 NotificationService::NoDetails());
[email protected]1ccb3568d2010-02-19 10:51:16281 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20282}
283
[email protected]765b35502008-08-21 00:51:20284NavigationEntry* NavigationController::GetActiveEntry() const {
[email protected]cbab76d2008-10-13 22:42:47285 if (transient_entry_index_ != -1)
286 return entries_[transient_entry_index_].get();
287 if (pending_entry_)
288 return pending_entry_;
289 return GetLastCommittedEntry();
[email protected]765b35502008-08-21 00:51:20290}
291
292int NavigationController::GetCurrentEntryIndex() const {
[email protected]cbab76d2008-10-13 22:42:47293 if (transient_entry_index_ != -1)
294 return transient_entry_index_;
[email protected]765b35502008-08-21 00:51:20295 if (pending_entry_index_ != -1)
296 return pending_entry_index_;
297 return last_committed_entry_index_;
298}
299
300NavigationEntry* NavigationController::GetLastCommittedEntry() const {
301 if (last_committed_entry_index_ == -1)
302 return NULL;
303 return entries_[last_committed_entry_index_].get();
304}
305
[email protected]31682282010-01-15 18:05:16306bool NavigationController::CanViewSource() const {
307 bool is_supported_mime_type = net::IsSupportedNonImageMimeType(
308 tab_contents_->contents_mime_type().c_str());
309 NavigationEntry* active_entry = GetActiveEntry();
310 return active_entry && !active_entry->IsViewSourceMode() &&
311 is_supported_mime_type;
312}
313
[email protected]765b35502008-08-21 00:51:20314NavigationEntry* NavigationController::GetEntryAtOffset(int offset) const {
[email protected]cbab76d2008-10-13 22:42:47315 int index = (transient_entry_index_ != -1) ?
316 transient_entry_index_ + offset :
317 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11318 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20319 return NULL;
320
321 return entries_[index].get();
322}
323
[email protected]765b35502008-08-21 00:51:20324bool NavigationController::CanGoBack() const {
325 return entries_.size() > 1 && GetCurrentEntryIndex() > 0;
326}
327
328bool NavigationController::CanGoForward() const {
329 int index = GetCurrentEntryIndex();
330 return index >= 0 && index < (static_cast<int>(entries_.size()) - 1);
331}
332
333void NavigationController::GoBack() {
334 if (!CanGoBack()) {
335 NOTREACHED();
336 return;
337 }
338
[email protected]25396da2010-03-11 19:19:10339 // If an interstitial page is showing, going back is equivalent to hiding the
340 // interstitial.
341 if (tab_contents_->interstitial_page()) {
342 tab_contents_->interstitial_page()->DontProceed();
343 return;
344 }
345
[email protected]765b35502008-08-21 00:51:20346 // Base the navigation on where we are now...
347 int current_index = GetCurrentEntryIndex();
348
[email protected]cbab76d2008-10-13 22:42:47349 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20350
351 pending_entry_index_ = current_index - 1;
[email protected]784688a62010-09-13 07:06:52352 entries_[pending_entry_index_]->set_transition_type(
353 entries_[pending_entry_index_]->transition_type() |
354 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16355 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20356}
357
358void NavigationController::GoForward() {
359 if (!CanGoForward()) {
360 NOTREACHED();
361 return;
362 }
363
[email protected]25396da2010-03-11 19:19:10364 // If an interstitial page is showing, the previous renderer is blocked and
365 // cannot make new requests. Unblock (and disable) it to allow this
366 // navigation to succeed. The interstitial will stay visible until the
367 // resulting DidNavigate.
368 if (tab_contents_->interstitial_page()) {
369 tab_contents_->interstitial_page()->CancelForNavigation();
370 }
371
[email protected]cbab76d2008-10-13 22:42:47372 bool transient = (transient_entry_index_ != -1);
373
[email protected]765b35502008-08-21 00:51:20374 // Base the navigation on where we are now...
375 int current_index = GetCurrentEntryIndex();
376
[email protected]cbab76d2008-10-13 22:42:47377 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20378
[email protected]cbab76d2008-10-13 22:42:47379 pending_entry_index_ = current_index;
380 // If there was a transient entry, we removed it making the current index
381 // the next page.
382 if (!transient)
383 pending_entry_index_++;
384
[email protected]784688a62010-09-13 07:06:52385 entries_[pending_entry_index_]->set_transition_type(
386 entries_[pending_entry_index_]->transition_type() |
387 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16388 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20389}
390
391void NavigationController::GoToIndex(int index) {
392 if (index < 0 || index >= static_cast<int>(entries_.size())) {
393 NOTREACHED();
394 return;
395 }
396
[email protected]cbab76d2008-10-13 22:42:47397 if (transient_entry_index_ != -1) {
398 if (index == transient_entry_index_) {
399 // Nothing to do when navigating to the transient.
400 return;
401 }
402 if (index > transient_entry_index_) {
403 // Removing the transient is goint to shift all entries by 1.
404 index--;
405 }
406 }
407
[email protected]25396da2010-03-11 19:19:10408 // If an interstitial page is showing, the previous renderer is blocked and
409 // cannot make new requests.
410 if (tab_contents_->interstitial_page()) {
411 if (index == GetCurrentEntryIndex() - 1) {
412 // Going back one entry is equivalent to hiding the interstitial.
413 tab_contents_->interstitial_page()->DontProceed();
414 return;
415 } else {
416 // Unblock the renderer (and disable the interstitial) to allow this
417 // navigation to succeed. The interstitial will stay visible until the
418 // resulting DidNavigate.
419 tab_contents_->interstitial_page()->CancelForNavigation();
420 }
421 }
422
[email protected]cbab76d2008-10-13 22:42:47423 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:20424
425 pending_entry_index_ = index;
[email protected]784688a62010-09-13 07:06:52426 entries_[pending_entry_index_]->set_transition_type(
427 entries_[pending_entry_index_]->transition_type() |
428 PageTransition::FORWARD_BACK);
[email protected]1ccb3568d2010-02-19 10:51:16429 NavigateToPendingEntry(NO_RELOAD);
[email protected]765b35502008-08-21 00:51:20430}
431
432void NavigationController::GoToOffset(int offset) {
[email protected]cbab76d2008-10-13 22:42:47433 int index = (transient_entry_index_ != -1) ?
434 transient_entry_index_ + offset :
435 last_committed_entry_index_ + offset;
[email protected]7f0005a2009-04-15 03:25:11436 if (index < 0 || index >= entry_count())
[email protected]765b35502008-08-21 00:51:20437 return;
438
439 GoToIndex(index);
440}
441
[email protected]cbab76d2008-10-13 22:42:47442void NavigationController::RemoveEntryAtIndex(int index,
443 const GURL& default_url) {
444 int size = static_cast<int>(entries_.size());
445 DCHECK(index < size);
446
447 DiscardNonCommittedEntries();
448
449 entries_.erase(entries_.begin() + index);
450
451 if (last_committed_entry_index_ == index) {
452 last_committed_entry_index_--;
453 // We removed the currently shown entry, so we have to load something else.
454 if (last_committed_entry_index_ != -1) {
455 pending_entry_index_ = last_committed_entry_index_;
[email protected]1ccb3568d2010-02-19 10:51:16456 NavigateToPendingEntry(NO_RELOAD);
[email protected]cbab76d2008-10-13 22:42:47457 } else {
458 // If there is nothing to show, show a default page.
[email protected]ed3456f2009-02-26 20:24:48459 LoadURL(default_url.is_empty() ? GURL("about:blank") : default_url,
[email protected]c0588052008-10-27 23:01:50460 GURL(), PageTransition::START_PAGE);
[email protected]cbab76d2008-10-13 22:42:47461 }
462 } else if (last_committed_entry_index_ > index) {
463 last_committed_entry_index_--;
464 }
[email protected]cbab76d2008-10-13 22:42:47465}
466
[email protected]38178a42009-12-17 18:58:32467void NavigationController::UpdateVirtualURLToURL(
468 NavigationEntry* entry, const GURL& new_url) {
469 GURL new_virtual_url(new_url);
470 if (BrowserURLHandler::ReverseURLRewrite(
471 &new_virtual_url, entry->virtual_url(), profile_)) {
472 entry->set_virtual_url(new_virtual_url);
473 }
474}
475
[email protected]cbab76d2008-10-13 22:42:47476void NavigationController::AddTransientEntry(NavigationEntry* entry) {
477 // Discard any current transient entry, we can only have one at a time.
478 int index = 0;
479 if (last_committed_entry_index_ != -1)
480 index = last_committed_entry_index_ + 1;
481 DiscardTransientEntry();
482 entries_.insert(entries_.begin() + index, linked_ptr<NavigationEntry>(entry));
[email protected]e1cd5452010-08-26 18:03:25483 transient_entry_index_ = index;
[email protected]8030f012009-09-25 18:09:37484 tab_contents_->NotifyNavigationStateChanged(kInvalidateAllButShelves);
[email protected]cbab76d2008-10-13 22:42:47485}
486
[email protected]c0588052008-10-27 23:01:50487void NavigationController::LoadURL(const GURL& url, const GURL& referrer,
initial.commit09911bf2008-07-26 23:55:29488 PageTransition::Type transition) {
489 // The user initiated a load, we don't need to reload anymore.
490 needs_reload_ = false;
491
[email protected]b6ea7412010-05-04 23:26:47492 NavigationEntry* entry = CreateNavigationEntry(url, referrer, transition,
493 profile_);
initial.commit09911bf2008-07-26 23:55:29494
495 LoadEntry(entry);
496}
497
[email protected]09b8f82f2009-06-16 20:22:11498void NavigationController::DocumentLoadedInFrame() {
499 last_document_loaded_ = base::TimeTicks::Now();
500}
501
[email protected]e9ba4472008-09-14 15:42:43502bool NavigationController::RendererDidNavigate(
503 const ViewHostMsg_FrameNavigate_Params& params,
[email protected]8030f012009-09-25 18:09:37504 int extra_invalidate_flags,
[email protected]e9ba4472008-09-14 15:42:43505 LoadCommittedDetails* details) {
[email protected]4bf3522c2010-08-19 21:00:20506
[email protected]0e8db942008-09-24 21:21:48507 // Save the previous state before we clobber it.
508 if (GetLastCommittedEntry()) {
[email protected]ecd9d8702008-08-28 22:10:17509 details->previous_url = GetLastCommittedEntry()->url();
[email protected]7f0005a2009-04-15 03:25:11510 details->previous_entry_index = last_committed_entry_index();
[email protected]0e8db942008-09-24 21:21:48511 } else {
512 details->previous_url = GURL();
513 details->previous_entry_index = -1;
514 }
[email protected]ecd9d8702008-08-28 22:10:17515
[email protected]e9ba4472008-09-14 15:42:43516 // Assign the current site instance to any pending entry, so we can find it
517 // later by calling GetEntryIndexWithPageID. We only care about this if the
518 // pending entry is an existing navigation and not a new one (or else we
519 // wouldn't care about finding it with GetEntryIndexWithPageID).
520 //
521 // TODO(brettw) this seems slightly bogus as we don't really know if the
522 // pending entry is what this navigation is for. There is a similar TODO
523 // w.r.t. the pending entry in RendererDidNavigateToNewPage.
[email protected]5e369672009-11-03 23:48:30524 if (pending_entry_index_ >= 0) {
[email protected]9423d9412009-04-14 22:13:55525 pending_entry_->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]5e369672009-11-03 23:48:30526 pending_entry_->set_restore_type(NavigationEntry::RESTORE_NONE);
527 }
[email protected]e9ba4472008-09-14 15:42:43528
[email protected]192d8c5e2010-02-23 07:26:32529 // is_in_page must be computed before the entry gets committed.
530 details->is_in_page = IsURLInPageNavigation(params.url);
531
[email protected]e9ba4472008-09-14 15:42:43532 // Do navigation-type specific actions. These will make and commit an entry.
[email protected]0e8db942008-09-24 21:21:48533 details->type = ClassifyNavigation(params);
[email protected]4bf3522c2010-08-19 21:00:20534
[email protected]0e8db942008-09-24 21:21:48535 switch (details->type) {
536 case NavigationType::NEW_PAGE:
[email protected]befd8d822009-07-01 04:51:47537 RendererDidNavigateToNewPage(params, &(details->did_replace_entry));
[email protected]e9ba4472008-09-14 15:42:43538 break;
[email protected]0e8db942008-09-24 21:21:48539 case NavigationType::EXISTING_PAGE:
[email protected]e9ba4472008-09-14 15:42:43540 RendererDidNavigateToExistingPage(params);
541 break;
[email protected]0e8db942008-09-24 21:21:48542 case NavigationType::SAME_PAGE:
[email protected]e9ba4472008-09-14 15:42:43543 RendererDidNavigateToSamePage(params);
544 break;
[email protected]0e8db942008-09-24 21:21:48545 case NavigationType::IN_PAGE:
[email protected]befd8d822009-07-01 04:51:47546 RendererDidNavigateInPage(params, &(details->did_replace_entry));
[email protected]e9ba4472008-09-14 15:42:43547 break;
[email protected]0e8db942008-09-24 21:21:48548 case NavigationType::NEW_SUBFRAME:
[email protected]e9ba4472008-09-14 15:42:43549 RendererDidNavigateNewSubframe(params);
550 break;
[email protected]0e8db942008-09-24 21:21:48551 case NavigationType::AUTO_SUBFRAME:
[email protected]e9ba4472008-09-14 15:42:43552 if (!RendererDidNavigateAutoSubframe(params))
553 return false;
554 break;
[email protected]0e8db942008-09-24 21:21:48555 case NavigationType::NAV_IGNORE:
[email protected]e9ba4472008-09-14 15:42:43556 // There is nothing we can do with this navigation, so we just return to
557 // the caller that nothing has happened.
558 return false;
559 default:
560 NOTREACHED();
[email protected]765b35502008-08-21 00:51:20561 }
562
[email protected]e9ba4472008-09-14 15:42:43563 // All committed entries should have nonempty content state so WebKit doesn't
564 // get confused when we go back to them (see the function for details).
565 SetContentStateIfEmpty(GetActiveEntry());
[email protected]765b35502008-08-21 00:51:20566
[email protected]e9ba4472008-09-14 15:42:43567 // WebKit doesn't set the "auto" transition on meta refreshes properly (bug
568 // 1051891) so we manually set it for redirects which we normally treat as
569 // "non-user-gestures" where we want to update stuff after navigations.
570 //
571 // Note that the redirect check also checks for a pending entry to
572 // differentiate real redirects from browser initiated navigations to a
573 // redirected entry. This happens when you hit back to go to a page that was
574 // the destination of a redirect, we don't want to treat it as a redirect
575 // even though that's what its transition will be. See bug 1117048.
576 //
577 // TODO(brettw) write a test for this complicated logic.
578 details->is_auto = (PageTransition::IsRedirect(params.transition) &&
[email protected]7f0005a2009-04-15 03:25:11579 !pending_entry()) ||
[email protected]e9ba4472008-09-14 15:42:43580 params.gesture == NavigationGestureAuto;
[email protected]765b35502008-08-21 00:51:20581
[email protected]e9ba4472008-09-14 15:42:43582 // Now prep the rest of the details for the notification and broadcast.
583 details->entry = GetActiveEntry();
[email protected]e9ba4472008-09-14 15:42:43584 details->is_main_frame = PageTransition::IsMainFrame(params.transition);
[email protected]f072d2ce2008-09-17 17:16:24585 details->serialized_security_info = params.security_info;
[email protected]8a3422c92008-09-24 17:42:42586 details->is_content_filtered = params.is_content_filtered;
[email protected]2e39d2e2009-02-19 18:41:31587 details->http_status_code = params.http_status_code;
[email protected]8030f012009-09-25 18:09:37588 NotifyNavigationEntryCommitted(details, extra_invalidate_flags);
initial.commit09911bf2008-07-26 23:55:29589
[email protected]e9ba4472008-09-14 15:42:43590 return true;
initial.commit09911bf2008-07-26 23:55:29591}
592
[email protected]0e8db942008-09-24 21:21:48593NavigationType::Type NavigationController::ClassifyNavigation(
[email protected]e9ba4472008-09-14 15:42:43594 const ViewHostMsg_FrameNavigate_Params& params) const {
[email protected]e9ba4472008-09-14 15:42:43595 if (params.page_id == -1) {
[email protected]eef9de32009-09-23 17:19:46596 // The renderer generates the page IDs, and so if it gives us the invalid
597 // page ID (-1) we know it didn't actually navigate. This happens in a few
598 // cases:
599 //
600 // - If a page makes a popup navigated to about blank, and then writes
601 // stuff like a subframe navigated to a real page. We'll get the commit
602 // for the subframe, but there won't be any commit for the outer page.
603 //
604 // - We were also getting these for failed loads (for example, bug 21849).
605 // The guess is that we get a "load commit" for the alternate error page,
606 // but that doesn't affect the page ID, so we get the "old" one, which
607 // could be invalid. This can also happen for a cross-site transition
608 // that causes us to swap processes. Then the error page load will be in
609 // a new process with no page IDs ever assigned (and hence a -1 value),
610 // yet the navigation controller still might have previous pages in its
611 // list.
612 //
613 // In these cases, there's nothing we can do with them, so ignore.
[email protected]0e8db942008-09-24 21:21:48614 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43615 }
616
[email protected]9423d9412009-04-14 22:13:55617 if (params.page_id > tab_contents_->GetMaxPageID()) {
[email protected]e9ba4472008-09-14 15:42:43618 // Greater page IDs than we've ever seen before are new pages. We may or may
619 // not have a pending entry for the page, and this may or may not be the
620 // main frame.
621 if (PageTransition::IsMainFrame(params.transition))
[email protected]0e8db942008-09-24 21:21:48622 return NavigationType::NEW_PAGE;
[email protected]4c27ba82008-09-24 16:49:09623
624 // When this is a new subframe navigation, we should have a committed page
625 // for which it's a suframe in. This may not be the case when an iframe is
626 // navigated on a popup navigated to about:blank (the iframe would be
627 // written into the popup by script on the main page). For these cases,
628 // there isn't any navigation stuff we can do, so just ignore it.
629 if (!GetLastCommittedEntry())
[email protected]0e8db942008-09-24 21:21:48630 return NavigationType::NAV_IGNORE;
[email protected]4c27ba82008-09-24 16:49:09631
632 // Valid subframe navigation.
[email protected]0e8db942008-09-24 21:21:48633 return NavigationType::NEW_SUBFRAME;
[email protected]e9ba4472008-09-14 15:42:43634 }
635
636 // Now we know that the notification is for an existing page. Find that entry.
637 int existing_entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55638 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43639 params.page_id);
640 if (existing_entry_index == -1) {
[email protected]e9ba4472008-09-14 15:42:43641 // The page was not found. It could have been pruned because of the limit on
642 // back/forward entries (not likely since we'll usually tell it to navigate
643 // to such entries). It could also mean that the renderer is smoking crack.
644 NOTREACHED();
[email protected]0e8db942008-09-24 21:21:48645 return NavigationType::NAV_IGNORE;
[email protected]e9ba4472008-09-14 15:42:43646 }
647 NavigationEntry* existing_entry = entries_[existing_entry_index].get();
648
[email protected]e6035c22010-05-25 16:15:52649 if (!PageTransition::IsMainFrame(params.transition)) {
650 // All manual subframes would get new IDs and were handled above, so we
651 // know this is auto. Since the current page was found in the navigation
652 // entry list, we're guaranteed to have a last committed entry.
653 DCHECK(GetLastCommittedEntry());
654 return NavigationType::AUTO_SUBFRAME;
655 }
656
657 // Anything below here we know is a main frame navigation.
[email protected]e9ba4472008-09-14 15:42:43658 if (pending_entry_ &&
[email protected]e9ba4472008-09-14 15:42:43659 existing_entry != pending_entry_ &&
[email protected]a0e69262009-06-03 19:08:48660 pending_entry_->page_id() == -1) {
[email protected]e9ba4472008-09-14 15:42:43661 // In this case, we have a pending entry for a URL but WebCore didn't do a
662 // new navigation. This happens when you press enter in the URL bar to
663 // reload. We will create a pending entry, but WebKit will convert it to
664 // a reload since it's the same page and not create a new entry for it
665 // (the user doesn't want to have a new back/forward entry when they do
666 // this). In this case, we want to just ignore the pending entry and go
667 // back to where we were (the "existing entry").
[email protected]0e8db942008-09-24 21:21:48668 return NavigationType::SAME_PAGE;
[email protected]e9ba4472008-09-14 15:42:43669 }
670
[email protected]fc60f222008-12-18 17:36:54671 // Any toplevel navigations with the same base (minus the reference fragment)
672 // are in-page navigations. We weeded out subframe navigations above. Most of
673 // the time this doesn't matter since WebKit doesn't tell us about subframe
674 // navigations that don't actually navigate, but it can happen when there is
675 // an encoding override (it always sends a navigation request).
676 if (AreURLsInPageNavigation(existing_entry->url(), params.url))
677 return NavigationType::IN_PAGE;
678
[email protected]e9ba4472008-09-14 15:42:43679 // Since we weeded out "new" navigations above, we know this is an existing
[email protected]4c27ba82008-09-24 16:49:09680 // (back/forward) navigation.
[email protected]0e8db942008-09-24 21:21:48681 return NavigationType::EXISTING_PAGE;
[email protected]e9ba4472008-09-14 15:42:43682}
683
[email protected]09b8f82f2009-06-16 20:22:11684bool NavigationController::IsRedirect(
685 const ViewHostMsg_FrameNavigate_Params& params) {
686 // For main frame transition, we judge by params.transition.
687 // Otherwise, by params.redirects.
688 if (PageTransition::IsMainFrame(params.transition)) {
689 return PageTransition::IsRedirect(params.transition);
690 }
691 return params.redirects.size() > 1;
692}
693
[email protected]b6ea7412010-05-04 23:26:47694void NavigationController::CreateNavigationEntriesFromTabNavigations(
695 const std::vector<TabNavigation>& navigations,
696 std::vector<linked_ptr<NavigationEntry> >* entries) {
697 // Create a NavigationEntry for each of the navigations.
698 int page_id = 0;
699 for (std::vector<TabNavigation>::const_iterator i =
700 navigations.begin(); i != navigations.end(); ++i, ++page_id) {
701 linked_ptr<NavigationEntry> entry(i->ToNavigationEntry(page_id, profile_));
702 entries->push_back(entry);
703 }
704}
705
[email protected]e9ba4472008-09-14 15:42:43706void NavigationController::RendererDidNavigateToNewPage(
[email protected]befd8d822009-07-01 04:51:47707 const ViewHostMsg_FrameNavigate_Params& params, bool* did_replace_entry) {
[email protected]e9ba4472008-09-14 15:42:43708 NavigationEntry* new_entry;
709 if (pending_entry_) {
710 // TODO(brettw) this assumes that the pending entry is appropriate for the
711 // new page that was just loaded. I don't think this is necessarily the
712 // case! We should have some more tracking to know for sure. This goes along
713 // with a similar TODO at the top of RendererDidNavigate where we blindly
714 // set the site instance on the pending entry.
715 new_entry = new NavigationEntry(*pending_entry_);
716
717 // Don't use the page type from the pending entry. Some interstitial page
718 // may have set the type to interstitial. Once we commit, however, the page
719 // type must always be normal.
[email protected]cccd3762010-11-12 18:40:01720 new_entry->set_page_type(NORMAL_PAGE);
[email protected]e9ba4472008-09-14 15:42:43721 } else {
[email protected]b680ad22009-04-15 23:19:42722 new_entry = new NavigationEntry;
[email protected]e9ba4472008-09-14 15:42:43723 }
724
725 new_entry->set_url(params.url);
[email protected]38178a42009-12-17 18:58:32726 if (new_entry->update_virtual_url_with_url())
727 UpdateVirtualURLToURL(new_entry, params.url);
[email protected]740fbda2009-02-18 21:38:08728 new_entry->set_referrer(params.referrer);
[email protected]e9ba4472008-09-14 15:42:43729 new_entry->set_page_id(params.page_id);
730 new_entry->set_transition_type(params.transition);
[email protected]9423d9412009-04-14 22:13:55731 new_entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43732 new_entry->set_has_post_data(params.is_post);
733
[email protected]befd8d822009-07-01 04:51:47734 InsertOrReplaceEntry(new_entry, *did_replace_entry);
[email protected]e9ba4472008-09-14 15:42:43735}
736
737void NavigationController::RendererDidNavigateToExistingPage(
738 const ViewHostMsg_FrameNavigate_Params& params) {
739 // We should only get here for main frame navigations.
740 DCHECK(PageTransition::IsMainFrame(params.transition));
741
742 // This is a back/forward navigation. The existing page for the ID is
[email protected]4c27ba82008-09-24 16:49:09743 // guaranteed to exist by ClassifyNavigation, and we just need to update it
744 // with new information from the renderer.
[email protected]7f0005a2009-04-15 03:25:11745 int entry_index = GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(),
746 params.page_id);
[email protected]e9ba4472008-09-14 15:42:43747 DCHECK(entry_index >= 0 &&
748 entry_index < static_cast<int>(entries_.size()));
749 NavigationEntry* entry = entries_[entry_index].get();
750
751 // The URL may have changed due to redirects. The site instance will normally
752 // be the same except during session restore, when no site instance will be
753 // assigned.
754 entry->set_url(params.url);
[email protected]38178a42009-12-17 18:58:32755 if (entry->update_virtual_url_with_url())
756 UpdateVirtualURLToURL(entry, params.url);
[email protected]e9ba4472008-09-14 15:42:43757 DCHECK(entry->site_instance() == NULL ||
[email protected]9423d9412009-04-14 22:13:55758 entry->site_instance() == tab_contents_->GetSiteInstance());
759 entry->set_site_instance(tab_contents_->GetSiteInstance());
[email protected]e9ba4472008-09-14 15:42:43760
[email protected]d5a49e52010-01-08 03:01:41761 entry->set_has_post_data(params.is_post);
762
[email protected]e9ba4472008-09-14 15:42:43763 // The entry we found in the list might be pending if the user hit
764 // back/forward/reload. This load should commit it (since it's already in the
765 // list, we can just discard the pending pointer).
766 //
767 // Note that we need to use the "internal" version since we don't want to
768 // actually change any other state, just kill the pointer.
769 if (entry == pending_entry_)
[email protected]cbab76d2008-10-13 22:42:47770 DiscardNonCommittedEntriesInternal();
[email protected]40bcc302009-03-02 20:50:39771
[email protected]80858db52009-10-15 00:35:18772 // If a transient entry was removed, the indices might have changed, so we
773 // have to query the entry index again.
774 last_committed_entry_index_ =
775 GetEntryIndexWithPageID(tab_contents_->GetSiteInstance(), params.page_id);
[email protected]e9ba4472008-09-14 15:42:43776}
777
778void NavigationController::RendererDidNavigateToSamePage(
779 const ViewHostMsg_FrameNavigate_Params& params) {
780 // This mode implies we have a pending entry that's the same as an existing
[email protected]4c27ba82008-09-24 16:49:09781 // entry for this page ID. This entry is guaranteed to exist by
782 // ClassifyNavigation. All we need to do is update the existing entry.
[email protected]e9ba4472008-09-14 15:42:43783 NavigationEntry* existing_entry = GetEntryWithPageID(
[email protected]9423d9412009-04-14 22:13:55784 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43785 params.page_id);
786
787 // We assign the entry's unique ID to be that of the new one. Since this is
788 // always the result of a user action, we want to dismiss infobars, etc. like
789 // a regular user-initiated navigation.
790 existing_entry->set_unique_id(pending_entry_->unique_id());
791
[email protected]a0e69262009-06-03 19:08:48792 // The URL may have changed due to redirects.
[email protected]38178a42009-12-17 18:58:32793 if (existing_entry->update_virtual_url_with_url())
794 UpdateVirtualURLToURL(existing_entry, params.url);
[email protected]a0e69262009-06-03 19:08:48795 existing_entry->set_url(params.url);
796
[email protected]cbab76d2008-10-13 22:42:47797 DiscardNonCommittedEntries();
[email protected]e9ba4472008-09-14 15:42:43798}
799
800void NavigationController::RendererDidNavigateInPage(
[email protected]befd8d822009-07-01 04:51:47801 const ViewHostMsg_FrameNavigate_Params& params, bool* did_replace_entry) {
[email protected]e9ba4472008-09-14 15:42:43802 DCHECK(PageTransition::IsMainFrame(params.transition)) <<
803 "WebKit should only tell us about in-page navs for the main frame.";
804 // We're guaranteed to have an entry for this one.
805 NavigationEntry* existing_entry = GetEntryWithPageID(
[email protected]9423d9412009-04-14 22:13:55806 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43807 params.page_id);
808
809 // Reference fragment navigation. We're guaranteed to have the last_committed
810 // entry and it will be the same page as the new navigation (minus the
811 // reference fragments, of course).
812 NavigationEntry* new_entry = new NavigationEntry(*existing_entry);
813 new_entry->set_page_id(params.page_id);
[email protected]38178a42009-12-17 18:58:32814 if (new_entry->update_virtual_url_with_url())
815 UpdateVirtualURLToURL(new_entry, params.url);
[email protected]e9ba4472008-09-14 15:42:43816 new_entry->set_url(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;
820 InsertOrReplaceEntry(new_entry, true);
[email protected]e9ba4472008-09-14 15:42:43821}
822
823void NavigationController::RendererDidNavigateNewSubframe(
824 const ViewHostMsg_FrameNavigate_Params& params) {
[email protected]09b8f82f2009-06-16 20:22:11825 if (PageTransition::StripQualifier(params.transition) ==
826 PageTransition::AUTO_SUBFRAME) {
827 // This is not user-initiated. Ignore.
828 return;
829 }
[email protected]09b8f82f2009-06-16 20:22:11830
[email protected]e9ba4472008-09-14 15:42:43831 // Manual subframe navigations just get the current entry cloned so the user
832 // can go back or forward to it. The actual subframe information will be
833 // stored in the page state for each of those entries. This happens out of
834 // band with the actual navigations.
[email protected]4c27ba82008-09-24 16:49:09835 DCHECK(GetLastCommittedEntry()) << "ClassifyNavigation should guarantee "
836 << "that a last committed entry exists.";
[email protected]e9ba4472008-09-14 15:42:43837 NavigationEntry* new_entry = new NavigationEntry(*GetLastCommittedEntry());
838 new_entry->set_page_id(params.page_id);
[email protected]672eba292009-05-13 13:22:45839 InsertOrReplaceEntry(new_entry, false);
[email protected]e9ba4472008-09-14 15:42:43840}
841
842bool NavigationController::RendererDidNavigateAutoSubframe(
843 const ViewHostMsg_FrameNavigate_Params& params) {
844 // We're guaranteed to have a previously committed entry, and we now need to
845 // handle navigation inside of a subframe in it without creating a new entry.
846 DCHECK(GetLastCommittedEntry());
847
848 // Handle the case where we're navigating back/forward to a previous subframe
849 // navigation entry. This is case "2." in NAV_AUTO_SUBFRAME comment in the
850 // header file. In case "1." this will be a NOP.
851 int entry_index = GetEntryIndexWithPageID(
[email protected]9423d9412009-04-14 22:13:55852 tab_contents_->GetSiteInstance(),
[email protected]e9ba4472008-09-14 15:42:43853 params.page_id);
854 if (entry_index < 0 ||
855 entry_index >= static_cast<int>(entries_.size())) {
856 NOTREACHED();
857 return false;
858 }
859
860 // Update the current navigation entry in case we're going back/forward.
861 if (entry_index != last_committed_entry_index_) {
[email protected]e9ba4472008-09-14 15:42:43862 last_committed_entry_index_ = entry_index;
[email protected]e9ba4472008-09-14 15:42:43863 return true;
864 }
865 return false;
866}
867
[email protected]ce3fa3c2009-04-20 19:55:57868// TODO(brettw) I think this function is unnecessary.
[email protected]e9ba4472008-09-14 15:42:43869void NavigationController::CommitPendingEntry() {
[email protected]cbab76d2008-10-13 22:42:47870 DiscardTransientEntry();
871
[email protected]7f0005a2009-04-15 03:25:11872 if (!pending_entry())
[email protected]e9ba4472008-09-14 15:42:43873 return; // Nothing to do.
874
875 // Need to save the previous URL for the notification.
876 LoadCommittedDetails details;
[email protected]0e8db942008-09-24 21:21:48877 if (GetLastCommittedEntry()) {
[email protected]e9ba4472008-09-14 15:42:43878 details.previous_url = GetLastCommittedEntry()->url();
[email protected]7f0005a2009-04-15 03:25:11879 details.previous_entry_index = last_committed_entry_index();
[email protected]0e8db942008-09-24 21:21:48880 } else {
881 details.previous_entry_index = -1;
882 }
[email protected]e9ba4472008-09-14 15:42:43883
884 if (pending_entry_index_ >= 0) {
885 // This is a previous navigation (back/forward) that we're just now
886 // committing. Just mark it as committed.
[email protected]0e8db942008-09-24 21:21:48887 details.type = NavigationType::EXISTING_PAGE;
[email protected]e9ba4472008-09-14 15:42:43888 int new_entry_index = pending_entry_index_;
[email protected]cbab76d2008-10-13 22:42:47889 DiscardNonCommittedEntriesInternal();
[email protected]e9ba4472008-09-14 15:42:43890
891 // Mark that entry as committed.
[email protected]e9ba4472008-09-14 15:42:43892 last_committed_entry_index_ = new_entry_index;
[email protected]e9ba4472008-09-14 15:42:43893 } else {
894 // This is a new navigation. It's easiest to just copy the entry and insert
[email protected]672eba292009-05-13 13:22:45895 // it new again, since InsertOrReplaceEntry expects to take ownership and
896 // also discard the pending entry. We also need to synthesize a page ID. We
897 // can only do this because this function will only be called by our custom
[email protected]57c6a652009-05-04 07:58:34898 // TabContents types. For TabContents, the IDs are generated by the
[email protected]e9ba4472008-09-14 15:42:43899 // renderer, so we can't do this.
[email protected]0e8db942008-09-24 21:21:48900 details.type = NavigationType::NEW_PAGE;
[email protected]9423d9412009-04-14 22:13:55901 pending_entry_->set_page_id(tab_contents_->GetMaxPageID() + 1);
902 tab_contents_->UpdateMaxPageID(pending_entry_->page_id());
[email protected]672eba292009-05-13 13:22:45903 InsertOrReplaceEntry(new NavigationEntry(*pending_entry_), false);
[email protected]e9ba4472008-09-14 15:42:43904 }
905
906 // Broadcast the notification of the navigation.
907 details.entry = GetActiveEntry();
908 details.is_auto = false;
909 details.is_in_page = AreURLsInPageNavigation(details.previous_url,
910 details.entry->url());
911 details.is_main_frame = true;
[email protected]8030f012009-09-25 18:09:37912 NotifyNavigationEntryCommitted(&details, 0);
[email protected]e9ba4472008-09-14 15:42:43913}
[email protected]765b35502008-08-21 00:51:20914
915int NavigationController::GetIndexOfEntry(
916 const NavigationEntry* entry) const {
917 const NavigationEntries::const_iterator i(std::find(
918 entries_.begin(),
919 entries_.end(),
920 entry));
921 return (i == entries_.end()) ? -1 : static_cast<int>(i - entries_.begin());
922}
923
[email protected]e9ba4472008-09-14 15:42:43924bool NavigationController::IsURLInPageNavigation(const GURL& url) const {
925 NavigationEntry* last_committed = GetLastCommittedEntry();
926 if (!last_committed)
927 return false;
928 return AreURLsInPageNavigation(last_committed->url(), url);
929}
930
[email protected]ce3fa3c2009-04-20 19:55:57931void NavigationController::CopyStateFrom(const NavigationController& source) {
932 // Verify that we look new.
933 DCHECK(entry_count() == 0 && !pending_entry());
934
935 if (source.entry_count() == 0)
936 return; // Nothing new to do.
937
938 needs_reload_ = true;
[email protected]e1cd5452010-08-26 18:03:25939 InsertEntriesFrom(source, source.entry_count());
[email protected]ce3fa3c2009-04-20 19:55:57940
[email protected]6ee12c42010-09-14 09:36:07941 session_storage_namespace_ = source.session_storage_namespace_->Clone();
[email protected]4e6419c2010-01-15 04:50:34942
[email protected]5e369672009-11-03 23:48:30943 FinishRestore(source.last_committed_entry_index_, false);
[email protected]ce3fa3c2009-04-20 19:55:57944}
945
[email protected]47e020a2010-10-15 14:43:37946void NavigationController::CopyStateFromAndPrune(NavigationController* source) {
[email protected]e1cd5452010-08-26 18:03:25947 // This code is intended for use when the last entry is the active entry.
948 DCHECK((transient_entry_index_ != -1 &&
949 transient_entry_index_ == entry_count() - 1) ||
950 (pending_entry_ && (pending_entry_index_ == -1 ||
951 pending_entry_index_ == entry_count() - 1)) ||
952 (!pending_entry_ && last_committed_entry_index_ == entry_count() - 1));
953
954 // Remove all the entries leaving the active entry.
955 PruneAllButActive();
956
[email protected]47e020a2010-10-15 14:43:37957 // Insert the entries from source. Don't use source->GetCurrentEntryIndex as
[email protected]e1cd5452010-08-26 18:03:25958 // we don't want to copy over the transient entry.
[email protected]47e020a2010-10-15 14:43:37959 int max_source_index = source->pending_entry_index_ != -1 ?
960 source->pending_entry_index_ : source->last_committed_entry_index_;
[email protected]e1cd5452010-08-26 18:03:25961 if (max_source_index == -1)
[email protected]47e020a2010-10-15 14:43:37962 max_source_index = source->entry_count();
[email protected]e1cd5452010-08-26 18:03:25963 else
964 max_source_index++;
[email protected]47e020a2010-10-15 14:43:37965 InsertEntriesFrom(*source, max_source_index);
[email protected]e1cd5452010-08-26 18:03:25966
967 // Adjust indices such that the last entry and pending are at the end now.
968 last_committed_entry_index_ = entry_count() - 1;
969 if (pending_entry_index_ != -1)
970 pending_entry_index_ = entry_count() - 1;
971 if (transient_entry_index_ != -1) {
972 // There's a transient entry. In this case we want the last committed to
973 // point to the previous entry.
974 transient_entry_index_ = entry_count() - 1;
975 if (last_committed_entry_index_ != -1)
976 last_committed_entry_index_--;
977 }
[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]cbab76d2008-10-13 22:42:471018void NavigationController::DiscardNonCommittedEntries() {
1019 bool transient = transient_entry_index_ != -1;
1020 DiscardNonCommittedEntriesInternal();
initial.commit09911bf2008-07-26 23:55:291021
[email protected]cbab76d2008-10-13 22:42:471022 // If there was a transient entry, invalidate everything so the new active
1023 // entry state is shown.
1024 if (transient) {
[email protected]8030f012009-09-25 18:09:371025 tab_contents_->NotifyNavigationStateChanged(kInvalidateAllButShelves);
[email protected]cbab76d2008-10-13 22:42:471026 }
initial.commit09911bf2008-07-26 23:55:291027}
1028
[email protected]672eba292009-05-13 13:22:451029void NavigationController::InsertOrReplaceEntry(NavigationEntry* entry,
1030 bool replace) {
[email protected]1e5645ff2008-08-27 18:09:071031 DCHECK(entry->transition_type() != PageTransition::AUTO_SUBFRAME);
[email protected]765b35502008-08-21 00:51:201032
1033 // Copy the pending entry's unique ID to the committed entry.
1034 // I don't know if pending_entry_index_ can be other than -1 here.
1035 const NavigationEntry* const pending_entry = (pending_entry_index_ == -1) ?
1036 pending_entry_ : entries_[pending_entry_index_].get();
1037 if (pending_entry)
1038 entry->set_unique_id(pending_entry->unique_id());
1039
[email protected]cbab76d2008-10-13 22:42:471040 DiscardNonCommittedEntriesInternal();
[email protected]765b35502008-08-21 00:51:201041
1042 int current_size = static_cast<int>(entries_.size());
1043
[email protected]765b35502008-08-21 00:51:201044 if (current_size > 0) {
[email protected]672eba292009-05-13 13:22:451045 // Prune any entries which are in front of the current entry.
1046 // Also prune the current entry if we are to replace the current entry.
1047 int prune_up_to = replace ? last_committed_entry_index_ - 1
1048 : last_committed_entry_index_;
[email protected]c12bf1a12008-09-17 16:28:491049 int num_pruned = 0;
[email protected]672eba292009-05-13 13:22:451050 while (prune_up_to < (current_size - 1)) {
[email protected]c12bf1a12008-09-17 16:28:491051 num_pruned++;
[email protected]765b35502008-08-21 00:51:201052 entries_.pop_back();
1053 current_size--;
1054 }
[email protected]c12bf1a12008-09-17 16:28:491055 if (num_pruned > 0) // Only notify if we did prune something.
1056 NotifyPrunedEntries(this, false, num_pruned);
[email protected]765b35502008-08-21 00:51:201057 }
1058
[email protected]c12bf1a12008-09-17 16:28:491059 if (entries_.size() >= max_entry_count_) {
[email protected]cbab76d2008-10-13 22:42:471060 RemoveEntryAtIndex(0, GURL());
[email protected]c12bf1a12008-09-17 16:28:491061 NotifyPrunedEntries(this, true, 1);
1062 }
[email protected]765b35502008-08-21 00:51:201063
1064 entries_.push_back(linked_ptr<NavigationEntry>(entry));
1065 last_committed_entry_index_ = static_cast<int>(entries_.size()) - 1;
[email protected]e9ba4472008-09-14 15:42:431066
1067 // This is a new page ID, so we need everybody to know about it.
[email protected]9423d9412009-04-14 22:13:551068 tab_contents_->UpdateMaxPageID(entry->page_id());
initial.commit09911bf2008-07-26 23:55:291069}
1070
1071void NavigationController::SetWindowID(const SessionID& id) {
1072 window_id_ = id;
[email protected]bfd04a62009-02-01 18:16:561073 NotificationService::current()->Notify(NotificationType::TAB_PARENTED,
[email protected]534e54b2008-08-13 15:40:091074 Source<NavigationController>(this),
1075 NotificationService::NoDetails());
initial.commit09911bf2008-07-26 23:55:291076}
1077
[email protected]1ccb3568d2010-02-19 10:51:161078void NavigationController::NavigateToPendingEntry(ReloadType reload_type) {
[email protected]72097fd02010-01-21 23:36:011079 needs_reload_ = false;
1080
initial.commit09911bf2008-07-26 23:55:291081 // For session history navigations only the pending_entry_index_ is set.
1082 if (!pending_entry_) {
[email protected]4bf3522c2010-08-19 21:00:201083 DCHECK_NE(pending_entry_index_, -1);
[email protected]765b35502008-08-21 00:51:201084 pending_entry_ = entries_[pending_entry_index_].get();
initial.commit09911bf2008-07-26 23:55:291085 }
1086
[email protected]1ccb3568d2010-02-19 10:51:161087 if (!tab_contents_->NavigateToPendingEntry(reload_type))
[email protected]cbab76d2008-10-13 22:42:471088 DiscardNonCommittedEntries();
initial.commit09911bf2008-07-26 23:55:291089}
1090
[email protected]ecd9d8702008-08-28 22:10:171091void NavigationController::NotifyNavigationEntryCommitted(
[email protected]8030f012009-09-25 18:09:371092 LoadCommittedDetails* details,
1093 int extra_invalidate_flags) {
[email protected]df1af242009-05-01 00:11:401094 details->entry = GetActiveEntry();
1095 NotificationDetails notification_details =
1096 Details<LoadCommittedDetails>(details);
1097
1098 // We need to notify the ssl_manager_ before the tab_contents_ so the
1099 // location bar will have up-to-date information about the security style
1100 // when it wants to draw. See http://crbug.com/11157
1101 ssl_manager_.DidCommitProvisionalLoad(notification_details);
1102
initial.commit09911bf2008-07-26 23:55:291103 // TODO(pkasting): http://b/1113079 Probably these explicit notification paths
1104 // should be removed, and interested parties should just listen for the
1105 // notification below instead.
[email protected]9423d9412009-04-14 22:13:551106 tab_contents_->NotifyNavigationStateChanged(
[email protected]6ebdc9b2010-09-27 16:55:571107 kInvalidateAllButShelves | extra_invalidate_flags);
initial.commit09911bf2008-07-26 23:55:291108
[email protected]ecd9d8702008-08-28 22:10:171109 NotificationService::current()->Notify(
[email protected]bfd04a62009-02-01 18:16:561110 NotificationType::NAV_ENTRY_COMMITTED,
[email protected]ecd9d8702008-08-28 22:10:171111 Source<NavigationController>(this),
[email protected]df1af242009-05-01 00:11:401112 notification_details);
initial.commit09911bf2008-07-26 23:55:291113}
1114
initial.commit09911bf2008-07-26 23:55:291115// static
1116void NavigationController::DisablePromptOnRepost() {
1117 check_for_repost_ = false;
1118}
1119
1120void NavigationController::SetActive(bool is_active) {
[email protected]ee613922009-09-02 20:38:221121 if (is_active && needs_reload_)
1122 LoadIfNecessary();
initial.commit09911bf2008-07-26 23:55:291123}
1124
1125void NavigationController::LoadIfNecessary() {
1126 if (!needs_reload_)
1127 return;
1128
initial.commit09911bf2008-07-26 23:55:291129 // Calling Reload() results in ignoring state, and not loading.
1130 // Explicitly use NavigateToPendingEntry so that the renderer uses the
1131 // cached state.
1132 pending_entry_index_ = last_committed_entry_index_;
[email protected]1ccb3568d2010-02-19 10:51:161133 NavigateToPendingEntry(NO_RELOAD);
initial.commit09911bf2008-07-26 23:55:291134}
1135
[email protected]534e54b2008-08-13 15:40:091136void NavigationController::NotifyEntryChanged(const NavigationEntry* entry,
1137 int index) {
1138 EntryChangedDetails det;
1139 det.changed_entry = entry;
1140 det.index = index;
[email protected]bfd04a62009-02-01 18:16:561141 NotificationService::current()->Notify(NotificationType::NAV_ENTRY_CHANGED,
[email protected]534e54b2008-08-13 15:40:091142 Source<NavigationController>(this),
1143 Details<EntryChangedDetails>(&det));
initial.commit09911bf2008-07-26 23:55:291144}
1145
[email protected]5e369672009-11-03 23:48:301146void NavigationController::FinishRestore(int selected_index,
1147 bool from_last_session) {
[email protected]7f0005a2009-04-15 03:25:111148 DCHECK(selected_index >= 0 && selected_index < entry_count());
[email protected]5e369672009-11-03 23:48:301149 ConfigureEntriesForRestore(&entries_, from_last_session);
initial.commit09911bf2008-07-26 23:55:291150
[email protected]61398152010-08-26 21:45:341151 set_max_restored_page_id(static_cast<int32>(entry_count()));
initial.commit09911bf2008-07-26 23:55:291152
1153 last_committed_entry_index_ = selected_index;
initial.commit09911bf2008-07-26 23:55:291154}
[email protected]765b35502008-08-21 00:51:201155
[email protected]cbab76d2008-10-13 22:42:471156void NavigationController::DiscardNonCommittedEntriesInternal() {
[email protected]765b35502008-08-21 00:51:201157 if (pending_entry_index_ == -1)
1158 delete pending_entry_;
1159 pending_entry_ = NULL;
1160 pending_entry_index_ = -1;
[email protected]cbab76d2008-10-13 22:42:471161
1162 DiscardTransientEntry();
1163}
1164
1165void NavigationController::DiscardTransientEntry() {
1166 if (transient_entry_index_ == -1)
1167 return;
[email protected]a0e69262009-06-03 19:08:481168 entries_.erase(entries_.begin() + transient_entry_index_);
[email protected]80858db52009-10-15 00:35:181169 if (last_committed_entry_index_ > transient_entry_index_)
1170 last_committed_entry_index_--;
[email protected]cbab76d2008-10-13 22:42:471171 transient_entry_index_ = -1;
[email protected]765b35502008-08-21 00:51:201172}
1173
1174int NavigationController::GetEntryIndexWithPageID(
[email protected]7f0005a2009-04-15 03:25:111175 SiteInstance* instance, int32 page_id) const {
[email protected]765b35502008-08-21 00:51:201176 for (int i = static_cast<int>(entries_.size()) - 1; i >= 0; --i) {
[email protected]7f0005a2009-04-15 03:25:111177 if ((entries_[i]->site_instance() == instance) &&
[email protected]1e5645ff2008-08-27 18:09:071178 (entries_[i]->page_id() == page_id))
[email protected]765b35502008-08-21 00:51:201179 return i;
1180 }
1181 return -1;
1182}
[email protected]cbab76d2008-10-13 22:42:471183
1184NavigationEntry* NavigationController::GetTransientEntry() const {
1185 if (transient_entry_index_ == -1)
1186 return NULL;
1187 return entries_[transient_entry_index_].get();
1188}
[email protected]e1cd5452010-08-26 18:03:251189
[email protected]e1cd5452010-08-26 18:03:251190void NavigationController::InsertEntriesFrom(
1191 const NavigationController& source,
1192 int max_index) {
1193 DCHECK_LE(max_index, source.entry_count());
1194 size_t insert_index = 0;
1195 for (int i = 0; i < max_index; i++) {
1196 // When cloning a tab, copy all entries except interstitial pages
[email protected]cccd3762010-11-12 18:40:011197 if (source.entries_[i].get()->page_type() != INTERSTITIAL_PAGE) {
[email protected]e1cd5452010-08-26 18:03:251198 entries_.insert(entries_.begin() + insert_index++,
1199 linked_ptr<NavigationEntry>(
1200 new NavigationEntry(*source.entries_[i])));
1201 }
1202 }
1203}