Abstract WebContents/NavigationController from core TabRestore code

chrome/browser/sessions/tab_restore_service_helper.cc

 // Copyright 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/sessions/tab_restore_service_helper.h"
 
 #include <algorithm>
 #include <iterator>
 
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/stl_util.h"
 #include "chrome/browser/sessions/tab_restore_service_delegate.h"
 #include "chrome/browser/sessions/tab_restore_service_observer.h"
-#include "components/sessions/content/content_serialized_navigation_builder.h"
+#include "components/sessions/core/open_tab.h"
 #include "components/sessions/core/tab_restore_service_client.h"
+#include "components/sessions/serialized_navigation_entry.h"
 #include "components/sessions/session_types.h"
-#include "content/public/browser/navigation_controller.h"
-#include "content/public/browser/navigation_entry.h"
-#include "content/public/browser/web_contents.h"
 
-using content::NavigationController;
-using content::NavigationEntry;
-using content::WebContents;
+using sessions::OpenTab;
 
 // TabRestoreServiceHelper::Observer -------------------------------------------
 
 TabRestoreServiceHelper::Observer::~Observer() {}
 
 void TabRestoreServiceHelper::Observer::OnClearEntries() {}
 
 void TabRestoreServiceHelper::Observer::OnRestoreEntryById(
     SessionID::id_type id,
     Entries::const_iterator entry_iterator) {
@@ skipping 25 matching lines @@
 void TabRestoreServiceHelper::AddObserver(
     TabRestoreServiceObserver* observer) {
   observer_list_.AddObserver(observer);
 }
 
 void TabRestoreServiceHelper::RemoveObserver(
     TabRestoreServiceObserver* observer) {
   observer_list_.RemoveObserver(observer);
 }
 
-void TabRestoreServiceHelper::CreateHistoricalTab(
-    content::WebContents* contents,
-    int index) {
+void TabRestoreServiceHelper::CreateHistoricalTab(OpenTab* open_tab,
+                                                  int index) {
   if (restoring_)
     return;
 
   TabRestoreServiceDelegate* delegate =
-      client_->FindTabRestoreServiceDelegateForWebContents(contents);
+      client_->FindTabRestoreServiceDelegateForTab(open_tab);
   if (closing_delegates_.find(delegate) != closing_delegates_.end())
     return;
 
   scoped_ptr<Tab> local_tab(new Tab());
-  PopulateTab(local_tab.get(), index, delegate, &contents->GetController());
+  PopulateTab(local_tab.get(), index, delegate, open_tab);
   if (local_tab->navigations.empty())
     return;
 
   AddEntry(local_tab.release(), true, true);
 }
 
 void TabRestoreServiceHelper::BrowserClosing(
     TabRestoreServiceDelegate* delegate) {
   closing_delegates_.insert(delegate);
 
   scoped_ptr<Window> window(new Window());
   window->selected_tab_index = delegate->GetSelectedIndex();
   window->timestamp = TimeNow();
   window->app_name = delegate->GetAppName();
 
   // Don't use std::vector::resize() because it will push copies of an empty tab
   // into the vector, which will give all tabs in a window the same ID.
   for (int i = 0; i < delegate->GetTabCount(); ++i) {
     window->tabs.push_back(Tab());
   }
   size_t entry_index = 0;
   for (int tab_index = 0; tab_index < delegate->GetTabCount(); ++tab_index) {
-    PopulateTab(&(window->tabs[entry_index]),
-                tab_index,
-                delegate,
-                &delegate->GetWebContentsAt(tab_index)->GetController());
+    PopulateTab(&(window->tabs[entry_index]), tab_index, delegate,
+                delegate->GetOpenTabAt(tab_index));
     if (window->tabs[entry_index].navigations.empty()) {
       window->tabs.erase(window->tabs.begin() + entry_index);
     } else {
       window->tabs[entry_index].browser_id = delegate->GetSessionID().id();
       entry_index++;
     }
   }
   if (window->tabs.size() == 1 && window->app_name.empty()) {
     // Short-circuit creating a Window if only 1 tab was present. This fixes
     // http://crbug.com/56744. Copy the Tab because it's owned by an object on
@@ skipping 16 matching lines @@
   if (observer_)
     observer_->OnClearEntries();
   STLDeleteElements(&entries_);
   NotifyTabsChanged();
 }
 
 const TabRestoreService::Entries& TabRestoreServiceHelper::entries() const {
   return entries_;
 }
 
-std::vector<content::WebContents*>
-TabRestoreServiceHelper::RestoreMostRecentEntry(
+std::vector<OpenTab*> TabRestoreServiceHelper::RestoreMostRecentEntry(
     TabRestoreServiceDelegate* delegate,
     int host_desktop_type) {
   if (entries_.empty())
-    return std::vector<WebContents*>();
+    return std::vector<OpenTab*>();
 
   return RestoreEntryById(delegate, entries_.front()->id, host_desktop_type,
       UNKNOWN);
 }
 
 TabRestoreService::Tab* TabRestoreServiceHelper::RemoveTabEntryById(
     SessionID::id_type id) {
   Entries::iterator i = GetEntryIteratorById(id);
   if (i == entries_.end())
     return NULL;
 
   Entry* entry = *i;
   if (entry->type != TabRestoreService::TAB)
     return NULL;
 
   Tab* tab = static_cast<Tab*>(entry);
   entries_.erase(i);
   return tab;
 }
 
-std::vector<content::WebContents*> TabRestoreServiceHelper::RestoreEntryById(
+std::vector<OpenTab*> TabRestoreServiceHelper::RestoreEntryById(
     TabRestoreServiceDelegate* delegate,
     SessionID::id_type id,
     int host_desktop_type,
     WindowOpenDisposition disposition) {
   Entries::iterator entry_iterator = GetEntryIteratorById(id);
   if (entry_iterator == entries_.end())
     // Don't hoark here, we allow an invalid id.
-    return std::vector<WebContents*>();
+    return std::vector<OpenTab*>();
 
   if (observer_)
     observer_->OnRestoreEntryById(id, entry_iterator);
   restoring_ = true;
   Entry* entry = *entry_iterator;
 
   // If the entry's ID does not match the ID that is being restored, then the
   // entry is a window from which a single tab will be restored.
   bool restoring_tab_in_window = entry->id != id;
 
   if (!restoring_tab_in_window) {
     entries_.erase(entry_iterator);
     entry_iterator = entries_.end();
   }
 
   // |delegate| will be NULL in cases where one isn't already available (eg,
   // when invoked on Mac OS X with no windows open). In this case, create a
   // new browser into which we restore the tabs.
-  std::vector<WebContents*> web_contents;
+  std::vector<OpenTab*> open_tabs;
   if (entry->type == TabRestoreService::TAB) {
     Tab* tab = static_cast<Tab*>(entry);
-    WebContents* restored_tab = NULL;
+    OpenTab* restored_tab = NULL;
     delegate = RestoreTab(*tab, delegate, host_desktop_type, disposition,
         &restored_tab);
-    web_contents.push_back(restored_tab);
+    open_tabs.push_back(restored_tab);
     delegate->ShowBrowserWindow();
   } else if (entry->type == TabRestoreService::WINDOW) {
     TabRestoreServiceDelegate* current_delegate = delegate;
     Window* window = static_cast<Window*>(entry);
 
     // When restoring a window, either the entire window can be restored, or a
     // single tab within it. If the entry's ID matches the one to restore, then
     // the entire window will be restored.
     if (!restoring_tab_in_window) {
       delegate = client_->CreateTabRestoreServiceDelegate(host_desktop_type,
                                                           window->app_name);
       for (size_t tab_i = 0; tab_i < window->tabs.size(); ++tab_i) {
         const Tab& tab = window->tabs[tab_i];
-        WebContents* restored_tab = delegate->AddRestoredTab(
+        OpenTab* restored_tab = delegate->AddRestoredTab(
             tab.navigations, delegate->GetTabCount(),
             tab.current_navigation_index, tab.extension_app_id,
             static_cast<int>(tab_i) == window->selected_tab_index, tab.pinned,
             tab.from_last_session, tab.client_data.get(),
             tab.user_agent_override);
         if (restored_tab) {
-          restored_tab->GetController().LoadIfNecessary();
+          restored_tab->LoadIfNecessary();
           client_->OnTabRestored(
               tab.navigations.at(tab.current_navigation_index).virtual_url());
-          web_contents.push_back(restored_tab);
+          open_tabs.push_back(restored_tab);
         }
       }
       // All the window's tabs had the same former browser_id.
       if (window->tabs[0].has_browser()) {
         UpdateTabBrowserIDs(window->tabs[0].browser_id,
                             delegate->GetSessionID().id());
       }
     } else {
       // Restore a single tab from the window. Find the tab that matches the ID
       // in the window and restore it.
       for (std::vector<Tab>::iterator tab_i = window->tabs.begin();
            tab_i != window->tabs.end(); ++tab_i) {
         const Tab& tab = *tab_i;
         if (tab.id == id) {
-          WebContents* restored_tab = NULL;
+          OpenTab* restored_tab = NULL;
           delegate = RestoreTab(tab, delegate, host_desktop_type, disposition,
               &restored_tab);
-          web_contents.push_back(restored_tab);
+          open_tabs.push_back(restored_tab);
           window->tabs.erase(tab_i);
           // If restoring the tab leaves the window with nothing else, delete it
           // as well.
           if (!window->tabs.size()) {
             entries_.erase(entry_iterator);
             delete entry;
           } else {
             // Update the browser ID of the rest of the tabs in the window so if
             // any one is restored, it goes into the same window as the tab
             // being restored now.
             UpdateTabBrowserIDs(tab.browser_id,
                                 delegate->GetSessionID().id());
             for (std::vector<Tab>::iterator tab_j = window->tabs.begin();
                  tab_j != window->tabs.end(); ++tab_j) {
               (*tab_j).browser_id = delegate->GetSessionID().id();
             }
           }
           break;
         }
       }
     }
     delegate->ShowBrowserWindow();
 
     if (disposition == CURRENT_TAB && current_delegate &&
-        current_delegate->GetActiveWebContents()) {
+        current_delegate->GetActiveOpenTab()) {
       current_delegate->CloseTab();
     }
   } else {
     NOTREACHED();
   }
 
   if (!restoring_tab_in_window) {
     delete entry;
   }
 
   restoring_ = false;
   NotifyTabsChanged();
-  return web_contents;
+  return open_tabs;
 }
 
 void TabRestoreServiceHelper::NotifyTabsChanged() {
   FOR_EACH_OBSERVER(TabRestoreServiceObserver, observer_list_,
                     TabRestoreServiceChanged(tab_restore_service_));
 }
 
 void TabRestoreServiceHelper::NotifyLoaded() {
   FOR_EACH_OBSERVER(TabRestoreServiceObserver, observer_list_,
                     TabRestoreServiceLoaded(tab_restore_service_));
@@ skipping 65 matching lines @@
   if (entry->type == TabRestoreService::TAB)
     return ValidateTab(static_cast<Tab*>(entry));
 
   if (entry->type == TabRestoreService::WINDOW)
     return ValidateWindow(static_cast<Window*>(entry));
 
   NOTREACHED();
   return false;
 }
 
-void TabRestoreServiceHelper::PopulateTab(
-    Tab* tab,
-    int index,
-    TabRestoreServiceDelegate* delegate,
-    NavigationController* controller) {
-  const int pending_index = controller->GetPendingEntryIndex();
-  int entry_count = controller->GetEntryCount();
+void TabRestoreServiceHelper::PopulateTab(Tab* tab,
+                                          int index,
+                                          TabRestoreServiceDelegate* delegate,
+                                          OpenTab* open_tab) {
+  const int pending_index = open_tab->GetPendingEntryIndex();
+  int entry_count = open_tab->GetEntryCount();
   if (entry_count == 0 && pending_index == 0)
     entry_count++;
   tab->navigations.resize(static_cast<int>(entry_count));
   for (int i = 0; i < entry_count; ++i) {
-    NavigationEntry* entry = (i == pending_index) ?
-        controller->GetPendingEntry() : controller->GetEntryAtIndex(i);
-    tab->navigations[i] =
-        sessions::ContentSerializedNavigationBuilder::FromNavigationEntry(
-            i, *entry);
+    sessions::SerializedNavigationEntry entry =
+        (i == pending_index) ? open_tab->GetPendingEntry()
+                             : open_tab->GetEntryAtIndex(i);
+    tab->navigations[i] = entry;
   }
   tab->timestamp = TimeNow();
-  tab->current_navigation_index = controller->GetCurrentEntryIndex();
+  tab->current_navigation_index = open_tab->GetCurrentEntryIndex();
   if (tab->current_navigation_index == -1 && entry_count > 0)
     tab->current_navigation_index = 0;
   tab->tabstrip_index = index;
 
-  tab->extension_app_id =
-      client_->GetExtensionAppIDForWebContents(controller->GetWebContents());
+  tab->extension_app_id = client_->GetExtensionAppIDForTab(open_tab);
 
-  tab->user_agent_override =
-      controller->GetWebContents()->GetUserAgentOverride();
+  tab->user_agent_override = open_tab->GetUserAgentOverride();
 
-  tab->client_data =
-      client_->GetTabClientDataForWebContents(controller->GetWebContents());
+  tab->client_data = client_->GetTabClientDataForTab(open_tab);
 
   // Delegate may be NULL during unit tests.
   if (delegate) {
     tab->browser_id = delegate->GetSessionID().id();
     tab->pinned = delegate->IsTabPinned(tab->tabstrip_index);
   }
 }
 
 TabRestoreServiceDelegate* TabRestoreServiceHelper::RestoreTab(
     const Tab& tab,
     TabRestoreServiceDelegate* delegate,
     int host_desktop_type,
     WindowOpenDisposition disposition,
-    WebContents** contents) {
-  WebContents* web_contents;
+    OpenTab** open_tab) {
+  OpenTab* restored_tab;
   if (disposition == CURRENT_TAB && delegate) {
-    web_contents = delegate->ReplaceRestoredTab(
+    restored_tab = delegate->ReplaceRestoredTab(
         tab.navigations, tab.current_navigation_index, tab.from_last_session,
         tab.extension_app_id, tab.client_data.get(), tab.user_agent_override);
   } else {
     // We only respsect the tab's original browser if there's no disposition.
     if (disposition == UNKNOWN && tab.has_browser()) {
       delegate = client_->FindTabRestoreServiceDelegateWithID(
           tab.browser_id, host_desktop_type);
     }
 
     int tab_index = -1;
@@ skipping 10 matching lines @@
         UpdateTabBrowserIDs(tab.browser_id, delegate->GetSessionID().id());
     }
 
     // Place the tab at the end if the tab index is no longer valid or
     // we were passed a specific disposition.
     if (tab_index < 0 || tab_index > delegate->GetTabCount() ||
         disposition != UNKNOWN) {
       tab_index = delegate->GetTabCount();
     }
 
-    web_contents = delegate->AddRestoredTab(
+    restored_tab = delegate->AddRestoredTab(
         tab.navigations, tab_index, tab.current_navigation_index,
         tab.extension_app_id, disposition != NEW_BACKGROUND_TAB, tab.pinned,
         tab.from_last_session, tab.client_data.get(), tab.user_agent_override);
-    web_contents->GetController().LoadIfNecessary();
+    restored_tab->LoadIfNecessary();
   }
   client_->OnTabRestored(
       tab.navigations.at(tab.current_navigation_index).virtual_url());
-  if (contents)
-    *contents = web_contents;
+  if (open_tab)
+    *open_tab = restored_tab;
 
   return delegate;
 }
 
 
 bool TabRestoreServiceHelper::ValidateTab(Tab* tab) {
   if (tab->navigations.empty())
     return false;
 
   tab->current_navigation_index =
@@ skipping 71 matching lines @@
       Tab* tab = static_cast<Tab*>(entry);
       if (tab->browser_id == old_id)
         tab->browser_id = new_id;
     }
   }
 }
 
 base::Time TabRestoreServiceHelper::TimeNow() const {
   return time_factory_ ? time_factory_->TimeNow() : base::Time::Now();
 }