Sessions API - previously Session Restore API. Supports restoring currently open foreign windows an…

chrome/browser/sessions/tab_restore_service_helper.cc

 // Copyright (c) 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"
@@ skipping 152 matching lines @@
   if (observer_)
     observer_->OnClearEntries();
   STLDeleteElements(&entries_);
   NotifyTabsChanged();
 }
 
 const TabRestoreService::Entries& TabRestoreServiceHelper::entries() const {
   return entries_;
 }
 
-void TabRestoreServiceHelper::RestoreMostRecentEntry(
+content::WebContents* TabRestoreServiceHelper::RestoreMostRecentEntry(
     TabRestoreServiceDelegate* delegate,
     chrome::HostDesktopType host_desktop_type) {
   if (entries_.empty())
-    return;
+    return NULL;
 
-  RestoreEntryById(delegate, entries_.front()->id, host_desktop_type, UNKNOWN);
+  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;
 }
 
-void TabRestoreServiceHelper::RestoreEntryById(
+content::WebContents* TabRestoreServiceHelper::RestoreEntryById(
     TabRestoreServiceDelegate* delegate,
     SessionID::id_type id,
     chrome::HostDesktopType 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;
+    return NULL;
 
   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.
+  WebContents* web_contents = NULL;
   if (entry->type == TabRestoreService::TAB) {
     Tab* tab = static_cast<Tab*>(entry);
-    delegate = RestoreTab(*tab, delegate, host_desktop_type, disposition);
+    delegate = RestoreTab(*tab, delegate, host_desktop_type, disposition,
+        &web_contents);
     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 = TabRestoreServiceDelegate::Create(profile_, 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(
             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.session_storage_namespace.get(),
             tab.user_agent_override);
         if (restored_tab) {
           restored_tab->GetController().LoadIfNecessary();
           RecordAppLaunch(profile_, tab);
+          // Return the last successfully restored tab for window entries.
+          web_contents = 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) {
-          delegate = RestoreTab(tab, delegate, host_desktop_type, disposition);
+          delegate = RestoreTab(tab, delegate, host_desktop_type, disposition,
+              &web_contents);
           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.
@@ skipping 17 matching lines @@
   } else {
     NOTREACHED();
   }
 
   if (!restoring_tab_in_window) {
     delete entry;
   }
 
   restoring_ = false;
   NotifyTabsChanged();
+  // Returns the WebContents of the restored tab if entry is a Tab. In the case
+  // of restoring type Window, returns the WebContents of the last successfully
+  // restored tab in the window.
+  return web_contents;
 }
 
 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 115 matching lines @@
   if (delegate) {
     tab->browser_id = delegate->GetSessionID().id();
     tab->pinned = delegate->IsTabPinned(tab->tabstrip_index);
   }
 }
 
 TabRestoreServiceDelegate* TabRestoreServiceHelper::RestoreTab(
     const Tab& tab,
     TabRestoreServiceDelegate* delegate,
     chrome::HostDesktopType host_desktop_type,
-    WindowOpenDisposition disposition) {
+    WindowOpenDisposition disposition,
+    WebContents** contents) {
+  WebContents* web_contents;
   if (disposition == CURRENT_TAB && delegate) {
-    delegate->ReplaceRestoredTab(tab.navigations,
-                                 tab.current_navigation_index,
-                                 tab.from_last_session,
-                                 tab.extension_app_id,
-                                 tab.session_storage_namespace.get(),
-                                 tab.user_agent_override);
+    web_contents = delegate->ReplaceRestoredTab(
+        tab.navigations,
+        tab.current_navigation_index,
+        tab.from_last_session,
+        tab.extension_app_id,
+        tab.session_storage_namespace.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 = TabRestoreServiceDelegate::FindDelegateWithID(
                      tab.browser_id, host_desktop_type);
     }
 
     int tab_index = -1;
 
     // |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.
     if (delegate && disposition != NEW_WINDOW) {
       tab_index = tab.tabstrip_index;
     } else {
       delegate = TabRestoreServiceDelegate::Create(profile_, host_desktop_type,
                                                    std::string());
       if (tab.has_browser())
         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();
     }
 
-    WebContents* web_contents =
-        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.session_storage_namespace.get(),
-                                 tab.user_agent_override);
+    web_contents = 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.session_storage_namespace.get(),
+                                            tab.user_agent_override);
     web_contents->GetController().LoadIfNecessary();
   }
   RecordAppLaunch(profile_, tab);
+  if (contents)
+    *contents = web_contents;
+
   return delegate;
 }
 
 
 bool TabRestoreServiceHelper::ValidateTab(Tab* tab) {
   if (tab->navigations.empty())
     return false;
 
   tab->current_navigation_index =
       std::max(0, std::min(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();
 }