Google Git
Sign in
chromium / chromium / src / 9e48a72755def0eba2068bfd5e674adda22d1856 / . / chrome / browser / sessions / session_restore.cc
blob: 07e7b6b4e46a59b095753c96d4837e3e3c9c7025 [file] [log] [blame]
// 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/session_restore.h"
#include <stddef.h>
#include <algorithm>
#include <iterator>
#include <list>
#include <map>
#include <memory>
#include <set>
#include <string>
#include "base/bind.h"
#include "base/callback.h"
#include "base/callback_helpers.h"
#include "base/command_line.h"
#include "base/containers/flat_map.h"
#include "base/cxx17_backports.h"
#include "base/debug/alias.h"
#include "base/feature_list.h"
#include "base/location.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/metrics/field_trial.h"
#include "base/metrics/histogram_macros.h"
#include "base/run_loop.h"
#include "base/task/cancelable_task_tracker.h"
#include "base/task/single_thread_task_runner.h"
#include "base/threading/thread_task_runner_handle.h"
#include "build/build_config.h"
#include "build/chromeos_buildflags.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/buildflags.h"
#include "chrome/browser/prefs/session_startup_pref.h"
#include "chrome/browser/profiles/keep_alive/profile_keep_alive_types.h"
#include "chrome/browser/profiles/keep_alive/scoped_profile_keep_alive.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/search/search.h"
#include "chrome/browser/sessions/app_session_service.h"
#include "chrome/browser/sessions/app_session_service_factory.h"
#include "chrome/browser/sessions/session_restore_delegate.h"
#include "chrome/browser/sessions/session_service.h"
#include "chrome/browser/sessions/session_service_factory.h"
#include "chrome/browser/sessions/session_service_log.h"
#include "chrome/browser/sessions/session_service_lookup.h"
#include "chrome/browser/sessions/session_service_utils.h"
#include "chrome/browser/sessions/tab_loader.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_finder.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_list_observer.h"
#include "chrome/browser/ui/browser_navigator.h"
#include "chrome/browser/ui/browser_navigator_params.h"
#include "chrome/browser/ui/browser_tabrestore.h"
#include "chrome/browser/ui/browser_tabstrip.h"
#include "chrome/browser/ui/browser_window.h"
#include "chrome/browser/ui/startup/startup_browser_creator.h"
#include "chrome/browser/ui/startup/startup_tab.h"
#include "chrome/browser/ui/startup/startup_types.h"
#include "chrome/browser/ui/tabs/tab_group.h"
#include "chrome/browser/ui/tabs/tab_group_model.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/browser/ui/ui_features.h"
#include "chrome/browser/ui/webui/whats_new/whats_new_util.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/common/extensions/extension_metrics.h"
#include "chrome/common/url_constants.h"
#include "components/keep_alive_registry/keep_alive_types.h"
#include "components/keep_alive_registry/scoped_keep_alive.h"
#include "components/sessions/core/session_types.h"
#include "components/tab_groups/tab_group_id.h"
#include "content/public/browser/child_process_security_policy.h"
#include "content/public/browser/dom_storage_context.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/render_widget_host.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/browser/session_storage_namespace.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/browser/web_contents.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/common/extension_set.h"
#if BUILDFLAG(IS_CHROMEOS_ASH)
#include "chrome/browser/ash/boot_times_recorder.h"
#include "components/app_restore/features.h"
#endif
using content::NavigationController;
using content::RenderWidgetHost;
using content::WebContents;
using RestoredTab = SessionRestoreDelegate::RestoredTab;
namespace {
bool HasSingleNewTabPage(Browser* browser) {
if (browser->tab_strip_model()->count() != 1)
return false;
content::WebContents* active_tab =
browser->tab_strip_model()->GetWebContentsAt(0);
return active_tab->GetURL() == chrome::kChromeUINewTabURL ||
search::IsInstantNTP(active_tab);
}
// Pointers to SessionRestoreImpls which are currently restoring the session.
std::set<SessionRestoreImpl*>* active_session_restorers = nullptr;
} // namespace
// SessionRestoreImpl ---------------------------------------------------------
// SessionRestoreImpl is responsible for fetching the set of tabs to create
// from SessionService. SessionRestoreImpl deletes itself when done.
class SessionRestoreImpl : public BrowserListObserver {
public:
SessionRestoreImpl(Profile* profile,
Browser* browser,
bool synchronous,
bool clobber_existing_tab,
bool always_create_tabbed_browser,
bool restore_apps,
bool restore_browser,
bool log_event,
const StartupTabs& startup_tabs)
: profile_(profile),
browser_(browser),
synchronous_(synchronous),
clobber_existing_tab_(clobber_existing_tab),
always_create_tabbed_browser_(always_create_tabbed_browser),
log_event_(log_event),
restore_apps_(restore_apps),
restore_browser_(restore_browser),
startup_tabs_(startup_tabs),
active_window_id_(SessionID::InvalidValue()),
restore_started_(base::TimeTicks::Now()) {
DCHECK(restore_browser_ || restore_apps_);
if (active_session_restorers == nullptr)
active_session_restorers = new std::set<SessionRestoreImpl*>();
// Only one SessionRestoreImpl should be operating on the profile at the
// same time.
std::set<SessionRestoreImpl*>::iterator it;
for (it = active_session_restorers->begin();
it != active_session_restorers->end(); ++it) {
if ((*it)->profile_ == profile)
break;
}
DCHECK(it == active_session_restorers->end());
active_session_restorers->insert(this);
keep_alive_ = std::make_unique<ScopedKeepAlive>(
KeepAliveOrigin::SESSION_RESTORE, KeepAliveRestartOption::DISABLED);
profile_keep_alive_ = std::make_unique<ScopedProfileKeepAlive>(
profile, ProfileKeepAliveOrigin::kBrowserWindow);
}
bool synchronous() const { return synchronous_; }
Browser* Restore() {
if (restore_browser_) {
SessionServiceBase* service =
SessionServiceFactory::GetForProfileForSessionRestore(profile_);
CHECK(service);
service->GetLastSession(base::BindOnce(&SessionRestoreImpl::OnGotSession,
weak_factory_.GetWeakPtr(),
/* for_apps */ false));
}
if (restore_apps_) {
SessionServiceBase* app_service =
AppSessionServiceFactory::GetForProfileForSessionRestore(profile_);
CHECK(app_service);
app_service->GetLastSession(base::BindOnce(
&SessionRestoreImpl::OnGotSession, weak_factory_.GetWeakPtr(),
/* for_apps */ true));
// Ensure the registry is ready so that when we reopen apps they work
// properly. If we don't wait, it's possible that apps are restored in
// an incoherent state.
web_app::WebAppProvider* provider =
web_app::WebAppProvider::GetForLocalAppsUnchecked(profile_);
DCHECK(provider);
provider->on_registry_ready().Post(
FROM_HERE, base::BindOnce(&SessionRestoreImpl::WebAppRegistryReady,
weak_factory_.GetWeakPtr()));
}
if (synchronous_) {
{
base::RunLoop loop(base::RunLoop::Type::kNestableTasksAllowed);
quit_closure_for_sync_restore_ = loop.QuitClosure();
loop.Run();
quit_closure_for_sync_restore_ = base::OnceClosure();
}
Browser* browser =
ProcessSessionWindowsAndNotify(&windows_, active_window_id_);
delete this;
return browser;
}
if (browser_)
BrowserList::AddObserver(this);
return browser_;
}
// Restore window(s) from a foreign session. Returns newly created Browsers.
std::vector<Browser*> RestoreForeignSession(
std::vector<const sessions::SessionWindow*>::const_iterator begin,
std::vector<const sessions::SessionWindow*>::const_iterator end) {
std::vector<Browser*> browsers;
std::vector<RestoredTab> created_contents;
// Create a browser instance to put the restored tabs in.
for (auto i = begin; i != end; ++i) {
Browser* browser = CreateRestoredBrowser(
BrowserTypeForWindowType((*i)->type), (*i)->bounds, (*i)->workspace,
(*i)->visible_on_all_workspaces, (*i)->show_state, (*i)->app_name,
(*i)->user_title, (*i)->extra_data, (*i)->window_id.id());
browsers.push_back(browser);
// A foreign session window will not contain tab groups, however an
// instance is still required for RestoreTabsToBrowser.
base::flat_map<tab_groups::TabGroupId, tab_groups::TabGroupId>
new_group_ids;
// Restore and show the browser.
const int initial_tab_count = 0;
RestoreTabsToBrowser(*(*i), browser, initial_tab_count, &created_contents,
&new_group_ids);
NotifySessionServiceOfRestoredTabs(browser, initial_tab_count);
}
// Always create in a new window.
FinishedTabCreation(true, true, &created_contents);
SessionRestore::on_session_restored_callbacks()->Notify(
profile_, static_cast<int>(created_contents.size()));
return browsers;
}
// Restore a single tab from a foreign session.
// Opens in the tab in the last active browser, unless disposition is
// NEW_WINDOW, in which case the tab will be opened in a new browser. Returns
// the WebContents of the restored tab.
WebContents* RestoreForeignTab(const sessions::SessionTab& tab,
WindowOpenDisposition disposition) {
DCHECK(!tab.navigations.empty());
int selected_index = tab.current_navigation_index;
selected_index = std::max(
0,
std::min(selected_index, static_cast<int>(tab.navigations.size() - 1)));
bool use_new_window = disposition == WindowOpenDisposition::NEW_WINDOW;
Browser* browser =
use_new_window ? Browser::Create(Browser::CreateParams(profile_, true))
: browser_.get();
RecordAppLaunchForTab(browser, tab, selected_index);
WebContents* web_contents;
if (disposition == WindowOpenDisposition::CURRENT_TAB) {
DCHECK(!use_new_window);
web_contents = chrome::ReplaceRestoredTab(
browser, tab.navigations, selected_index, tab.extension_app_id,
nullptr, tab.user_agent_override, tab.extra_data,
true /* from_session_restore */);
} else {
int tab_index =
use_new_window ? 0 : browser->tab_strip_model()->active_index() + 1;
web_contents = chrome::AddRestoredTab(
browser, tab.navigations, tab_index, selected_index,
tab.extension_app_id, absl::nullopt,
disposition == WindowOpenDisposition::NEW_FOREGROUND_TAB, // selected
tab.pinned, base::TimeTicks(), nullptr, tab.user_agent_override,
tab.extra_data, true /* from_session_restore */);
// Start loading the tab immediately.
web_contents->GetController().LoadIfNecessary();
}
if (use_new_window) {
browser->tab_strip_model()->ActivateTabAt(
0, {TabStripModel::GestureType::kOther});
browser->window()->Show();
}
NotifySessionServiceOfRestoredTabs(browser,
browser->tab_strip_model()->count());
// Since FinishedTabCreation() is not called here, |this| will leak if we
// are not in sychronous mode.
DCHECK(synchronous_);
SessionRestore::on_session_restored_callbacks()->Notify(profile_, 1);
return web_contents;
}
SessionRestoreImpl(const SessionRestoreImpl&) = delete;
SessionRestoreImpl& operator=(const SessionRestoreImpl&) = delete;
~SessionRestoreImpl() override {
BrowserList::RemoveObserver(this);
active_session_restorers->erase(this);
if (active_session_restorers->empty()) {
delete active_session_restorers;
active_session_restorers = nullptr;
}
}
// BrowserListObserver:
void OnBrowserRemoved(Browser* browser) override {
if (browser == browser_)
delete this;
}
Profile* profile() { return profile_; }
private:
// Invoked when done with creating all the tabs/browsers.
//
// |created_tabbed_browser| indicates whether a tabbed browser was created,
// or we used an existing tabbed browser.
//
// If successful, this begins loading tabs and deletes itself when all tabs
// have been loaded.
//
// Returns the Browser that was created, if any.
Browser* FinishedTabCreation(bool succeeded,
bool created_tabbed_browser,
std::vector<RestoredTab>* contents_created) {
Browser* browser = nullptr;
if (!created_tabbed_browser && always_create_tabbed_browser_) {
browser = Browser::Create(Browser::CreateParams(profile_, false));
if (startup_tabs_.empty() ||
(startup_tabs_.size() == 1 &&
startup_tabs_[0].url == whats_new::GetWebUIStartupURL())) {
// No tab browsers were created and no URLs were supplied on the command
// line, or only the What's New page is specified at startup and may or
// may not add a tab. Open the new tab page.
startup_tabs_.emplace_back(GURL(chrome::kChromeUINewTabURL));
}
AppendURLsToBrowser(browser, startup_tabs_);
browser->window()->Show();
}
if (succeeded) {
// Sort the tabs in the order they should be restored, and start loading
// them.
std::stable_sort(contents_created->begin(), contents_created->end());
SessionRestoreDelegate::RestoreTabs(*contents_created, restore_started_);
}
if (!synchronous_) {
// If we're not synchronous we need to delete ourself.
// NOTE: we must use DeleteLater here as most likely we're in a callback
// from the history service which doesn't deal well with deleting the
// object it is notifying.
base::ThreadTaskRunnerHandle::Get()->DeleteSoon(FROM_HERE, this);
// The delete may take a while and at this point we no longer care about
// if the browser is deleted. Don't listen to anything. This avoid a
// possible double delete too (if browser is closed before DeleteSoon() is
// processed).
BrowserList::RemoveObserver(this);
}
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker("SessionRestore-End",
false);
#endif
return browser;
}
// We typically want to restore windows in order of creation.
void SortWindowsByWindowId() {
std::sort(windows_.begin(), windows_.end(),
[](const std::unique_ptr<sessions::SessionWindow>& lhs,
const std::unique_ptr<sessions::SessionWindow>& rhs) {
return lhs->window_id < rhs->window_id;
});
}
void OnGotSession(
bool for_apps,
std::vector<std::unique_ptr<sessions::SessionWindow>> windows,
SessionID active_window_id,
bool read_error) {
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker(
"SessionRestore-GotSession", false);
#endif
// This function could be called twice from both SessionService and
// AppSessionService. If one of them returns error, then |read_error_| is
// true. So check whether |read_error_| has been set as true to prevent the
// result is overwritten.
if (!read_error_)
read_error_ = read_error;
// Copy windows into windows_ so that we can combine both app and browser
// windows together before doing a one-pass restore.
std::copy(std::make_move_iterator(windows.begin()),
std::make_move_iterator(windows.end()),
std::back_inserter(windows_));
SessionRestore::OnGotSession(profile(), for_apps, windows.size());
windows.clear();
// Since we could now be possibly waiting for two |GetSession|s, we need
// to track if we're completely finished or not. While we're at it,
// store the windows for later merging and restoring.
if (for_apps) {
got_app_windows_ = true;
} else {
got_browser_windows_ = true;
}
// Don't let app restores set the active_window_id, or else it will
// always bring the app to the forefront.
if (!for_apps)
active_window_id_ = active_window_id;
ProcessSessionWindowsIfReady();
}
void WebAppRegistryReady() {
DCHECK_EQ(web_app_registry_ready_, false);
DCHECK(restore_apps_);
web_app_registry_ready_ = true;
ProcessSessionWindowsIfReady();
}
// This is called by callback handlers and may trigger session restore if
// all the required conditions have been met. It also handles the differences
// between async/sync restores.
void ProcessSessionWindowsIfReady() {
bool got_all_sessions = IsReadyToProcessSessionWindows();
// For async restores, we need to early exit here if we aren't ready to
// start restoring windows.
if (!got_all_sessions)
return;
SortWindowsByWindowId();
if (synchronous_) {
CHECK(!quit_closure_for_sync_restore_.is_null());
// now we know we have all the windows we need merge them into windows_
// for processing.
std::move(quit_closure_for_sync_restore_).Run();
return;
}
ProcessSessionWindowsAndNotify(&windows_, active_window_id_);
}
// This helper, based on the restore_apps_ state tells us if we're ready to
// begin restoring windows. There's two ways we are ready to process:
// 1. we aren't restoring apps, and have browser_windows.
// 2. we are restoring apps, we have both browser and app windows and
// WebAppRegistryReady() has been called.
bool IsReadyToProcessSessionWindows() const {
if (!restore_apps_)
return got_browser_windows_;
if (!restore_browser_)
return got_app_windows_ && web_app_registry_ready_;
return (got_app_windows_ && got_browser_windows_ &&
web_app_registry_ready_);
}
Browser* ProcessSessionWindowsAndNotify(
std::vector<std::unique_ptr<sessions::SessionWindow>>* windows,
SessionID active_window_id) {
int window_count = 0;
int tab_count = 0;
std::vector<RestoredTab> contents;
Browser* result = ProcessSessionWindows(
windows, active_window_id, &contents, &window_count, &tab_count);
if (log_event_) {
LogSessionServiceRestoreEvent(profile_, window_count, tab_count,
read_error_);
}
SessionRestore::on_session_restored_callbacks()->Notify(
profile_, static_cast<int>(contents.size()));
return result;
}
Browser* ProcessSessionWindows(
std::vector<std::unique_ptr<sessions::SessionWindow>>* windows,
SessionID active_window_id,
std::vector<RestoredTab>* created_contents,
int* window_count,
int* tab_count) {
DVLOG(1) << "ProcessSessionWindows " << windows->size();
if (windows->empty()) {
// Restore was unsuccessful. The DOM storage system can also delete its
// data, since no session restore will happen at a later point in time.
profile_->GetDefaultStoragePartition()
->GetDOMStorageContext()
->StartScavengingUnusedSessionStorage();
return FinishedTabCreation(false, false, created_contents);
}
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker(
"SessionRestore-CreatingTabs-Start", false);
#endif
// After the for loop this contains the last TYPE_NORMAL browser, or nullptr
// if no TYPE_NORMAL browser exists.
Browser* last_normal_browser = nullptr;
bool has_normal_browser = false;
// After the for loop, this contains the browser to activate, if one of the
// windows has the same id as specified in active_window_id.
Browser* browser_to_activate = nullptr;
// Determine if there is a visible window, or if the active window exists.
// Even if all windows are ui::SHOW_STATE_MINIMIZED, if one of them is the
// active window it will be made visible by the call to
// browser_to_activate->window()->Activate() later on in this method.
bool has_visible_browser = false;
for (const auto& window : *windows) {
if (window->show_state != ui::SHOW_STATE_MINIMIZED ||
window->window_id == active_window_id)
has_visible_browser = true;
}
for (auto i = windows->begin(); i != windows->end(); ++i) {
++(*window_count);
// 1. Choose between restoring tabs in an existing browser or in a newly
// created browser.
Browser* browser = nullptr;
if (i == windows->begin() &&
(*i)->type == sessions::SessionWindow::TYPE_NORMAL && browser_ &&
browser_->is_type_normal() &&
!browser_->profile()->IsOffTheRecord()) {
// The first set of tabs is added to the existing browser.
browser = browser_;
} else {
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker(
"SessionRestore-CreateRestoredBrowser-Start", false);
#endif
// Change the initial show state of the created browser to
// SHOW_STATE_NORMAL if there are no visible browsers.
ui::WindowShowState show_state = (*i)->show_state;
if (!has_visible_browser) {
show_state = ui::SHOW_STATE_NORMAL;
has_visible_browser = true;
}
browser = CreateRestoredBrowser(
BrowserTypeForWindowType((*i)->type), (*i)->bounds, (*i)->workspace,
(*i)->visible_on_all_workspaces, show_state, (*i)->app_name,
(*i)->user_title, (*i)->extra_data, (*i)->window_id.id());
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker(
"SessionRestore-CreateRestoredBrowser-End", false);
#endif
}
// 2. Track TYPE_NORMAL browsers.
if ((*i)->type == sessions::SessionWindow::TYPE_NORMAL) {
has_normal_browser = true;
last_normal_browser = browser;
browser->SetWindowUserTitle((*i)->user_title);
}
// 3. Determine whether the currently active tab should be closed.
WebContents* active_tab =
browser->tab_strip_model()->GetActiveWebContents();
int initial_tab_count = browser->tab_strip_model()->count();
bool close_active_tab =
clobber_existing_tab_ && i == windows->begin() &&
(*i)->type == sessions::SessionWindow::TYPE_NORMAL && active_tab &&
browser == browser_ && !(*i)->tabs.empty();
if (close_active_tab)
--initial_tab_count;
if ((*i)->window_id == active_window_id)
browser_to_activate = browser;
// 5. Restore tabs in |browser|. This will also call Show() on |browser|
// if its initial show state is not mimimized.
// For the cases that users have more than one desk, a window is restored
// to its parent desk, which can be non-active desk, and left invisible
// but unminimized.
base::flat_map<tab_groups::TabGroupId, tab_groups::TabGroupId>
new_group_ids;
RestoreTabsToBrowser(*(*i), browser, initial_tab_count, created_contents,
&new_group_ids);
(*tab_count) += (static_cast<int>(browser->tab_strip_model()->count()) -
initial_tab_count);
#if !BUILDFLAG(IS_CHROMEOS_ASH)
#if defined(OS_MAC)
// On the mac, app visibility is asynchronously available, so we can't
// rely on a particular value here.
const bool is_visibility_async =
browser->type() == Browser::Type::TYPE_APP;
#else
const bool is_visibility_async = false;
#endif // defined(OS_MAC)
DCHECK(is_visibility_async || browser->window()->IsVisible() ||
browser->window()->IsMinimized());
#endif // !BUILDFLAG(IS_CHROMEOS_ASH)
// 6. Tabs will be grouped appropriately in RestoreTabsToBrowser. Now
// restore the groups' visual data.
TabGroupModel* group_model = browser->tab_strip_model()->group_model();
for (auto& session_tab_group : (*i)->tab_groups) {
TabGroup* model_tab_group =
group_model->GetTabGroup(new_group_ids.at(session_tab_group->id));
DCHECK(model_tab_group);
model_tab_group->SetVisualData(session_tab_group->visual_data);
}
// 7. Notify SessionService of restored tabs, so they can be saved to the
// current session.
// TODO(fdoray): This seems redundant with the call to
// SessionService::TabRestored() at the end of chrome::AddRestoredTab().
// Consider removing it.
NotifySessionServiceOfRestoredTabs(browser, initial_tab_count);
// 8. Close the tab that was active in the window prior to session
// restore, if needed.
if (close_active_tab)
chrome::CloseWebContents(browser, active_tab, true);
// Sanity check: A restored browser should have an active tab.
// TODO(https://crbug.com/1032348): Change to DCHECK once we understand
// why some browsers don't have an active tab on startup.
CHECK(browser->tab_strip_model()->GetActiveWebContents());
}
if (browser_to_activate && browser_to_activate->is_type_normal())
last_normal_browser = browser_to_activate;
if (last_normal_browser && !startup_tabs_.empty())
AppendURLsToBrowser(last_normal_browser, startup_tabs_);
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker(
"SessionRestore-CreatingTabs-End", false);
#endif
if (browser_to_activate)
browser_to_activate->window()->Activate();
// If last_normal_browser is NULL and startup_tabs_ is non-empty,
// FinishedTabCreation will create a new TabbedBrowser and add the urls to
// it.
Browser* finished_browser =
FinishedTabCreation(true, has_normal_browser, created_contents);
if (finished_browser)
last_normal_browser = finished_browser;
// sessionStorages needed for the session restore have now been recreated
// by RestoreTab. Now it's safe for the DOM storage system to start
// deleting leftover data.
profile_->GetDefaultStoragePartition()
->GetDOMStorageContext()
->StartScavengingUnusedSessionStorage();
return last_normal_browser;
}
// Record an app launch event (if appropriate) for a tab which is about to
// be restored. Callers should ensure that selected_index is within the
// bounds of tab.navigations before calling.
void RecordAppLaunchForTab(Browser* browser,
const sessions::SessionTab& tab,
int selected_index) {
DCHECK(selected_index >= 0 &&
selected_index < static_cast<int>(tab.navigations.size()));
GURL url = tab.navigations[selected_index].virtual_url();
const extensions::Extension* extension =
extensions::ExtensionRegistry::Get(profile())
->enabled_extensions()
.GetAppByURL(url);
if (extension) {
extensions::RecordAppLaunchType(
extension_misc::APP_LAUNCH_SESSION_RESTORE, extension->GetType());
}
}
// Adds the tabs from |window| to |browser|. Normal tabs go after the existing
// tabs but pinned tabs will be pushed in front.
// If there are no existing tabs, the tab at |window.selected_tab_index| will
// be selected. Otherwise, the tab selection will remain untouched.
void RestoreTabsToBrowser(
const sessions::SessionWindow& window,
Browser* browser,
int initial_tab_count,
std::vector<RestoredTab>* created_contents,
base::flat_map<tab_groups::TabGroupId, tab_groups::TabGroupId>*
new_group_ids) {
DVLOG(1) << "RestoreTabsToBrowser " << window.tabs.size();
// TODO(https://crbug.com/1032348): Change to DCHECK once we understand
// why some browsers don't have an active tab on startup.
CHECK(!window.tabs.empty());
base::TimeTicks now = base::TimeTicks::Now();
base::TimeTicks latest_last_active_time = base::TimeTicks::UnixEpoch();
// The last active time of a WebContents is initially set to the
// creation time of the tab, which is not necessarly the same as the
// loading time, so we have to restore the values. Also, since TimeTicks
// only make sense in their current session, these values have to be
// sanitized first. To do so, we need to first figure out the largest
// time. This will then be used to set the last active time of
// each tab where the most recent tab will have its time set to |now|
// and the rest of the tabs will have theirs set earlier by the same
// delta as they originally had.
for (int i = 0; i < static_cast<int>(window.tabs.size()); ++i) {
const sessions::SessionTab& tab = *(window.tabs[i]);
if (tab.last_active_time > latest_last_active_time)
latest_last_active_time = tab.last_active_time;
}
// TODO(crbug.com/930991): Check that tab groups are contiguous in |window|
// to ensure tabs will not be reordered when restoring. This is not possible
// yet due the ordering of TabStripModelObserver notifications in an edge
// case.
const int selected_tab_index = base::clamp(
window.selected_tab_index, 0, static_cast<int>(window.tabs.size() - 1));
for (int i = 0; i < static_cast<int>(window.tabs.size()); ++i) {
const sessions::SessionTab& tab = *(window.tabs[i]);
// Loads are scheduled for each restored tab unless the tab is going to
// be selected as ShowBrowser() will load the selected tab.
bool is_selected_tab =
(initial_tab_count == 0) && (i == selected_tab_index);
// Sanitize the last active time.
base::TimeDelta delta = latest_last_active_time - tab.last_active_time;
base::TimeTicks last_active_time = now - delta;
// If the browser already has tabs, we want to restore the new ones after
// the existing ones. E.g. this happens in Win8 Metro where we merge
// windows or when launching a hosted app from the app launcher.
int tab_index = i + initial_tab_count;
RestoreTab(tab, browser, created_contents, new_group_ids, tab_index,
is_selected_tab, last_active_time);
}
}
// |tab_index| is ignored for pinned tabs which will always be pushed behind
// the last existing pinned tab.
// |tab_loader_| will schedule this tab for loading if |is_selected_tab| is
// false. |last_active_time| is the value to use to set the last time the
// WebContents was made active.
void RestoreTab(const sessions::SessionTab& tab,
Browser* browser,
std::vector<RestoredTab>* created_contents,
base::flat_map<tab_groups::TabGroupId,
tab_groups::TabGroupId>* new_group_ids,
const int tab_index,
bool is_selected_tab,
base::TimeTicks last_active_time) {
// It's possible (particularly for foreign sessions) to receive a tab
// without valid navigations. In that case, just skip it.
// See crbug.com/154129.
if (tab.navigations.empty())
return;
SessionRestore::NotifySessionRestoreStartedLoadingTabs();
int selected_index = GetNavigationIndexToSelect(tab);
RecordAppLaunchForTab(browser, tab, selected_index);
// Associate sessionStorage (if any) to the restored tab.
scoped_refptr<content::SessionStorageNamespace> session_storage_namespace;
if (!tab.session_storage_persistent_id.empty()) {
session_storage_namespace =
profile_->GetDefaultStoragePartition()
->GetDOMStorageContext()
->RecreateSessionStorage(tab.session_storage_persistent_id);
}
// Relabel group IDs to prevent duplicating groups. See crbug.com/1202102.
absl::optional<tab_groups::TabGroupId> new_group;
if (tab.group) {
auto it = new_group_ids->find(*tab.group);
if (it == new_group_ids->end()) {
it = new_group_ids
->emplace(*tab.group, tab_groups::TabGroupId::GenerateNew())
.first;
}
new_group = it->second;
}
// Apply the stored group.
WebContents* web_contents = chrome::AddRestoredTab(
browser, tab.navigations, tab_index, selected_index,
tab.extension_app_id, new_group, is_selected_tab, tab.pinned,
last_active_time, session_storage_namespace.get(),
tab.user_agent_override, tab.extra_data,
true /* from_session_restore */);
DCHECK(web_contents);
RestoredTab restored_tab(web_contents, is_selected_tab,
tab.extension_app_id.empty(), tab.pinned,
new_group);
created_contents->push_back(restored_tab);
// If this isn't the selected tab, there's nothing else to do.
if (!is_selected_tab)
return;
ShowBrowser(browser, browser->tab_strip_model()->GetIndexOfWebContents(
web_contents));
}
Browser* CreateRestoredBrowser(
Browser::Type type,
gfx::Rect bounds,
const std::string& workspace,
bool visible_on_all_workspaces,
ui::WindowShowState show_state,
const std::string& app_name,
const std::string& user_title,
const std::map<std::string, std::string>& extra_data,
int32_t restore_id) {
Browser::CreateParams params(type, profile_, false);
params.initial_bounds = bounds;
params.user_title = user_title;
// We only store trusted app windows, so we also create them as trusted.
if (type == Browser::Type::TYPE_APP) {
params = Browser::CreateParams::CreateForApp(
app_name, /*trusted_source=*/true, bounds, profile_,
/*user_gesture=*/false);
} else if (type == Browser::Type::TYPE_APP_POPUP) {
params = Browser::CreateParams::CreateForAppPopup(
app_name, /*trusted_source=*/true, bounds, profile_,
/*user_gesture=*/false);
}
#if defined(OS_CHROMEOS)
params.restore_id = restore_id;
#endif
params.initial_show_state = show_state;
params.initial_workspace = workspace;
params.initial_visible_on_all_workspaces_state = visible_on_all_workspaces;
params.creation_source = Browser::CreationSource::kSessionRestore;
Browser* browser = Browser::Create(params);
#if BUILDFLAG(ENABLE_SIDE_SEARCH)
browser->window()->MaybeRestoreSideSearchStatePerWindow(extra_data);
#endif // BUILDFLAG(ENABLE_SIDE_SEARCH)
return browser;
}
void ShowBrowser(Browser* browser, int selected_tab_index) {
DCHECK(browser);
DCHECK(browser->tab_strip_model()->count());
browser->tab_strip_model()->ActivateTabAt(
selected_tab_index, {TabStripModel::GestureType::kOther});
if (browser_ == browser)
return;
browser->window()->Show();
browser->set_is_session_restore(false);
}
// Appends the urls in |startup_tabs| to |browser|.
void AppendURLsToBrowser(Browser* browser, const StartupTabs& startup_tabs) {
bool is_first_tab = true;
for (const auto& startup_tab : startup_tabs) {
const GURL& url = startup_tab.url;
if (url == whats_new::GetWebUIStartupURL()) {
whats_new::StartWhatsNewFetch(browser);
continue;
}
int add_types = TabStripModel::ADD_FORCE_INDEX;
if (is_first_tab)
add_types |= TabStripModel::ADD_ACTIVE;
NavigateParams params(browser, url, ui::PAGE_TRANSITION_AUTO_TOPLEVEL);
params.disposition = is_first_tab
? WindowOpenDisposition::NEW_FOREGROUND_TAB
: WindowOpenDisposition::NEW_BACKGROUND_TAB;
params.tabstrip_add_types = add_types;
is_first_tab = false;
Navigate(&params);
}
}
// Invokes TabRestored on the SessionService for all tabs in browser after
// initial_count.
void NotifySessionServiceOfRestoredTabs(Browser* browser, int initial_count) {
SessionServiceBase* service =
GetAppropriateSessionServiceForProfile(browser);
if (!service)
return;
TabStripModel* tab_strip = browser->tab_strip_model();
for (int i = initial_count; i < tab_strip->count(); ++i) {
service->TabRestored(tab_strip->GetWebContentsAt(i),
tab_strip->IsTabPinned(i));
}
}
// The profile to create the sessions for.
raw_ptr<Profile> profile_;
// The first browser to restore to, may be null.
raw_ptr<Browser> browser_;
// Whether or not restore is synchronous.
const bool synchronous_;
// The quit-closure to terminate the nested message-loop started for
// synchronous session-restore.
base::OnceClosure quit_closure_for_sync_restore_;
// See description of CLOBBER_CURRENT_TAB.
const bool clobber_existing_tab_;
// If true and there is an error or there are no windows to restore, we
// create a tabbed browser anyway. This is used on startup to make sure at
// at least one window is created.
const bool always_create_tabbed_browser_;
// If true, LogSessionServiceRestoreEvent() is called after restore.
const bool log_event_;
// If true, restores apps.
const bool restore_apps_;
// If true, restores the normal browser.
bool restore_browser_ = true;
// App restores depend on web_app::WebAppProvider on_registry_ready(). This
// bool will track that and hold up restores until that's ready too if apps
// are being restored.
bool web_app_registry_ready_ = false;
// During app restores, we make two GetLastSession calls to
// [App]SessionService, we need to wait till they both return before
// processing the windows together in one pass.
bool got_app_windows_ = false;
bool got_browser_windows_ = false;
// Set of URLs to open in addition to those restored from the session.
StartupTabs startup_tabs_;
// Responsible for loading the tabs.
scoped_refptr<TabLoader> tab_loader_;
// When synchronous we run a nested run loop. To avoid creating windows
// from the nested run loop (which can make exiting the nested message
// loop take a while) we cache the SessionWindows here and create the actual
// windows when the nested run loop exits.
std::vector<std::unique_ptr<sessions::SessionWindow>> windows_;
SessionID active_window_id_;
// When asynchronous it's possible for there to be no windows. To make sure
// Chrome doesn't prematurely exit we register a KeepAlive for the lifetime
// of this object.
std::unique_ptr<ScopedKeepAlive> keep_alive_;
// Same as |keep_alive_|, but also prevent |profile_| from getting deleted
// (when DestroyProfileOnBrowserClose is enabled).
std::unique_ptr<ScopedProfileKeepAlive> profile_keep_alive_;
// The time we started the restore.
base::TimeTicks restore_started_;
// Set to true if reading the last commands encountered an error.
bool read_error_ = false;
base::WeakPtrFactory<SessionRestoreImpl> weak_factory_{this};
};
// SessionRestore -------------------------------------------------------------
// static
Browser* SessionRestore::RestoreSession(
Profile* profile,
Browser* browser,
SessionRestore::BehaviorBitmask behavior,
const StartupTabs& startup_tabs) {
#if BUILDFLAG(IS_CHROMEOS_ASH)
ash::BootTimesRecorder::Get()->AddLoginTimeMarker("SessionRestore-Start",
false);
#endif
DCHECK(profile);
DCHECK(SessionServiceFactory::GetForProfile(profile));
profile->set_restored_last_session(true);
#if BUILDFLAG(IS_CHROMEOS_LACROS)
if (!profile->IsMainProfile())
behavior &= ~RESTORE_APPS;
#endif // BUILDFLAG(IS_CHROMEOS_LACROS)
// SessionRestoreImpl takes care of deleting itself when done.
SessionRestoreImpl* restorer = new SessionRestoreImpl(
profile, browser, (behavior & SYNCHRONOUS) != 0,
(behavior & CLOBBER_CURRENT_TAB) != 0,
(behavior & ALWAYS_CREATE_TABBED_BROWSER) != 0,
(behavior & RESTORE_APPS) != 0, (behavior & RESTORE_BROWSER) != 0,
/* log_event */ true, startup_tabs);
return restorer->Restore();
}
// static
void SessionRestore::RestoreSessionAfterCrash(Browser* browser) {
auto* profile = browser->profile();
#if BUILDFLAG(IS_CHROMEOS_ASH) || BUILDFLAG(IS_CHROMEOS_LACROS)
// Desks restore a window to the right desk, so we should not reuse any
// browser window. Otherwise, the conflict of the parent desk arises because
// tabs created in this |browser| should remain in the current active desk,
// but the first restored window should be restored to its saved parent desk
// before a crash. This also avoids users' confusion of the current window
// disappearing from the current desk after pressing a restore button.
browser = nullptr;
#endif
SessionRestore::BehaviorBitmask behavior =
SessionRestore::RESTORE_BROWSER |
(browser && HasSingleNewTabPage(browser)
? SessionRestore::CLOBBER_CURRENT_TAB
: 0);
#if BUILDFLAG(IS_CHROMEOS_ASH)
// In Chrome OS, apps are restored by full restore only. This function is
// called when the chrome browser is launched after crash, so only browser
// tabs are restored, apps are not restroed.
if (!full_restore::features::IsFullRestoreEnabled())
behavior |= SessionRestore::RESTORE_APPS;
#else
// Apps should always be restored on crash restore.
behavior |= SessionRestore::RESTORE_APPS;
#endif
SessionRestore::RestoreSession(profile, browser, behavior, StartupTabs());
}
// static
void SessionRestore::OpenStartupPagesAfterCrash(Browser* browser) {
WebContents* tab_to_clobber = nullptr;
if (HasSingleNewTabPage(browser))
tab_to_clobber = browser->tab_strip_model()->GetActiveWebContents();
StartupBrowserCreator::OpenStartupPages(
browser, chrome::startup::IsProcessStartup::kYes);
if (tab_to_clobber && browser->tab_strip_model()->count() > 1)
chrome::CloseWebContents(browser, tab_to_clobber, true);
}
// static
std::vector<Browser*> SessionRestore::RestoreForeignSessionWindows(
Profile* profile,
std::vector<const sessions::SessionWindow*>::const_iterator begin,
std::vector<const sessions::SessionWindow*>::const_iterator end) {
StartupTabs startup_tabs;
SessionRestoreImpl restorer(
profile, static_cast<Browser*>(nullptr), true, false, true,
/* restore_apps */ false, /* restore_browser */ true,
/* log_event */ false, startup_tabs);
return restorer.RestoreForeignSession(begin, end);
}
// static
WebContents* SessionRestore::RestoreForeignSessionTab(
content::WebContents* source_web_contents,
const sessions::SessionTab& tab,
WindowOpenDisposition disposition) {
Browser* browser = chrome::FindBrowserWithWebContents(source_web_contents);
Profile* profile = browser->profile();
StartupTabs startup_tabs;
SessionRestoreImpl restorer(profile, browser, true, false, false,
/* restore_apps */ false,
/* restore_browser */ true,
/* log_event */ false, startup_tabs);
return restorer.RestoreForeignTab(tab, disposition);
}
// static
bool SessionRestore::IsRestoring(const Profile* profile) {
if (active_session_restorers == nullptr)
return false;
for (auto it = active_session_restorers->begin();
it != active_session_restorers->end(); ++it) {
if ((*it)->profile() == profile)
return true;
}
return false;
}
// static
bool SessionRestore::IsRestoringSynchronously() {
if (!active_session_restorers)
return false;
for (auto it = active_session_restorers->begin();
it != active_session_restorers->end(); ++it) {
if ((*it)->synchronous())
return true;
}
return false;
}
// static
base::CallbackListSubscription
SessionRestore::RegisterOnSessionRestoredCallback(
const RestoredCallback& callback) {
return on_session_restored_callbacks()->Add(callback);
}
// static
void SessionRestore::AddObserver(SessionRestoreObserver* observer) {
observers()->AddObserver(observer);
}
// static
void SessionRestore::RemoveObserver(SessionRestoreObserver* observer) {
observers()->RemoveObserver(observer);
}
// static
void SessionRestore::OnTabLoaderFinishedLoadingTabs() {
if (!session_restore_started_)
return;
session_restore_started_ = false;
for (auto& observer : *observers())
observer.OnSessionRestoreFinishedLoadingTabs();
}
// static
void SessionRestore::NotifySessionRestoreStartedLoadingTabs() {
if (session_restore_started_)
return;
session_restore_started_ = true;
for (auto& observer : *observers())
observer.OnSessionRestoreStartedLoadingTabs();
}
// static
void SessionRestore::OnWillRestoreTab(content::WebContents* web_contents) {
for (auto& observer : *observers())
observer.OnWillRestoreTab(web_contents);
}
// static
void SessionRestore::OnGotSession(Profile* profile,
bool for_apps,
int window_count) {
for (auto& observer : *observers())
observer.OnGotSession(profile, for_apps, window_count);
}
// static
SessionRestore::CallbackList* SessionRestore::on_session_restored_callbacks_ =
nullptr;
// static
base::ObserverList<SessionRestoreObserver>::Unchecked*
SessionRestore::observers_ = nullptr;
// static
bool SessionRestore::session_restore_started_ = false;