1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/app_restore/full_restore_read_handler.h"
#include <cstdint>
#include <memory>
#include <utility>
#include "base/functional/bind.h"
#include "base/no_destructor.h"
#include "base/task/single_thread_task_runner.h"
#include "components/app_constants/constants.h"
#include "components/app_restore/app_launch_info.h"
#include "components/app_restore/app_restore_info.h"
#include "components/app_restore/app_restore_utils.h"
#include "components/app_restore/desk_template_read_handler.h"
#include "components/app_restore/features.h"
#include "components/app_restore/full_restore_file_handler.h"
#include "components/app_restore/full_restore_save_handler.h"
#include "components/app_restore/restore_data.h"
#include "components/app_restore/window_info.h"
#include "components/app_restore/window_properties.h"
#include "components/sessions/core/session_id.h"
#include "ui/aura/client/aura_constants.h"
namespace full_restore {
namespace {
// These are temporary estimate of how long it takes full restore to launch
// apps.
constexpr base::TimeDelta kFullRestoreEstimateDuration = base::Seconds(5);
constexpr base::TimeDelta kFullRestoreARCEstimateDuration = base::Minutes(3);
} // namespace
FullRestoreReadHandler* FullRestoreReadHandler::GetInstance() {
static base::NoDestructor<FullRestoreReadHandler> full_restore_read_handler;
return full_restore_read_handler.get();
}
FullRestoreReadHandler::FullRestoreReadHandler() {
if (aura::Env::HasInstance())
env_observer_.Observe(aura::Env::GetInstance());
arc_info_observer_.Observe(app_restore::AppRestoreArcInfo::GetInstance());
}
FullRestoreReadHandler::~FullRestoreReadHandler() = default;
void FullRestoreReadHandler::OnWindowInitialized(aura::Window* window) {
int32_t window_id = window->GetProperty(app_restore::kRestoreWindowIdKey);
// Ignore desk template and saved desk windows.
if (window_id < app_restore::kParentToHiddenContainer)
return;
if (app_restore::IsArcWindow(window)) {
// If there isn't restore data for ARC apps, we don't need to handle ARC app
// windows restoration.
if (!arc_read_handler_)
return;
if (window_id == app_restore::kParentToHiddenContainer ||
arc_read_handler_->HasRestoreData(window_id)) {
observed_windows_.AddObservation(window);
arc_read_handler_->AddArcWindowCandidate(window);
app_restore::AppRestoreInfo::GetInstance()->OnWindowInitialized(window);
}
return;
}
if (!SessionID::IsValidValue(window_id)) {
return;
}
observed_windows_.AddObservation(window);
app_restore::AppRestoreInfo::GetInstance()->OnWindowInitialized(window);
}
void FullRestoreReadHandler::OnWindowDestroyed(aura::Window* window) {
DCHECK(observed_windows_.IsObservingSource(window));
observed_windows_.RemoveObservation(window);
if (app_restore::IsArcWindow(window)) {
if (arc_read_handler_)
arc_read_handler_->OnWindowDestroyed(window);
return;
}
int32_t restore_window_id =
window->GetProperty(app_restore::kRestoreWindowIdKey);
DCHECK(SessionID::IsValidValue(restore_window_id));
RemoveAppRestoreData(restore_window_id);
}
std::unique_ptr<app_restore::AppLaunchInfo>
FullRestoreReadHandler::GetAppLaunchInfo(const base::FilePath& profile_path,
const std::string& app_id,
int32_t restore_window_id) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return nullptr;
return restore_data->GetAppLaunchInfo(app_id, restore_window_id);
}
std::unique_ptr<app_restore::WindowInfo> FullRestoreReadHandler::GetWindowInfo(
const base::FilePath& profile_path,
const std::string& app_id,
int32_t restore_window_id) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return nullptr;
return restore_data->GetWindowInfo(app_id, restore_window_id);
}
void FullRestoreReadHandler::RemoveAppRestoreData(
const base::FilePath& profile_path,
const std::string& app_id,
int32_t restore_window_id) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return;
restore_data->RemoveAppRestoreData(app_id, restore_window_id);
}
void FullRestoreReadHandler::OnTaskCreated(const std::string& app_id,
int32_t task_id,
int32_t session_id) {
if (arc_read_handler_)
arc_read_handler_->OnTaskCreated(app_id, task_id, session_id);
}
void FullRestoreReadHandler::OnTaskDestroyed(int32_t task_id) {
if (arc_read_handler_)
arc_read_handler_->OnTaskDestroyed(task_id);
}
void FullRestoreReadHandler::SetPrimaryProfilePath(
const base::FilePath& profile_path) {
primary_profile_path_ = profile_path;
}
void FullRestoreReadHandler::SetActiveProfilePath(
const base::FilePath& profile_path) {
active_profile_path_ = profile_path;
}
void FullRestoreReadHandler::SetCheckRestoreData(
const base::FilePath& profile_path) {
should_check_restore_data_.insert(profile_path);
}
void FullRestoreReadHandler::ReadFromFile(const base::FilePath& profile_path,
Callback callback) {
auto it = profile_path_to_restore_data_.find(profile_path);
if (it != profile_path_to_restore_data_.end()) {
// If the restore data has been read from the file, just use it, and don't
// need to read it again.
//
// We must use post task here, because FullRestoreAppLaunchHandler calls
// ReadFromFile in FullRestoreService construct function, and the callback
// in FullRestoreAppLaunchHandler calls the init function of
// FullRestoreService. If we don't use post task, and call the callback
// function directly, it could cause deadloop.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(std::move(callback),
(it->second ? it->second->Clone() : nullptr)));
return;
}
auto file_handler =
base::MakeRefCounted<FullRestoreFileHandler>(profile_path);
file_handler->owning_task_runner()->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&FullRestoreFileHandler::ReadFromFile, file_handler.get()),
base::BindOnce(&FullRestoreReadHandler::OnGetRestoreData,
weak_factory_.GetWeakPtr(), profile_path,
std::move(callback)));
}
void FullRestoreReadHandler::SetNextRestoreWindowIdForChromeApp(
const base::FilePath& profile_path,
const std::string& app_id) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return;
restore_data->SetNextRestoreWindowIdForChromeApp(app_id);
}
void FullRestoreReadHandler::RemoveApp(const base::FilePath& profile_path,
const std::string& app_id) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return;
restore_data->RemoveApp(app_id);
}
bool FullRestoreReadHandler::HasAppTypeBrowser(
const base::FilePath& profile_path) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return false;
return restore_data->HasAppTypeBrowser();
}
bool FullRestoreReadHandler::HasBrowser(const base::FilePath& profile_path) {
auto* restore_data = GetRestoreData(profile_path);
if (!restore_data)
return false;
return restore_data->HasBrowser();
}
bool FullRestoreReadHandler::HasWindowInfo(int32_t restore_window_id) {
if (!SessionID::IsValidValue(restore_window_id) ||
!base::Contains(should_check_restore_data_, active_profile_path_)) {
return false;
}
auto it = window_id_to_app_restore_info_.find(restore_window_id);
if (it == window_id_to_app_restore_info_.end())
return false;
return true;
}
std::unique_ptr<app_restore::WindowInfo> FullRestoreReadHandler::GetWindowInfo(
aura::Window* window) {
if (!window)
return nullptr;
const int32_t restore_window_id =
window->GetProperty(app_restore::kRestoreWindowIdKey);
if (app_restore::IsArcWindow(window)) {
return arc_read_handler_
? arc_read_handler_->GetWindowInfo(restore_window_id)
: nullptr;
}
return GetWindowInfo(restore_window_id);
}
std::unique_ptr<app_restore::WindowInfo>
FullRestoreReadHandler::GetWindowInfoForActiveProfile(
int32_t restore_window_id) {
if (!base::Contains(should_check_restore_data_, active_profile_path_))
return nullptr;
return GetWindowInfo(restore_window_id);
}
std::unique_ptr<app_restore::AppLaunchInfo>
FullRestoreReadHandler::GetArcAppLaunchInfo(const std::string& app_id,
int32_t session_id) {
return arc_read_handler_
? arc_read_handler_->GetArcAppLaunchInfo(app_id, session_id)
: nullptr;
}
int32_t FullRestoreReadHandler::FetchRestoreWindowId(
const std::string& app_id) {
auto* restore_data = GetRestoreData(active_profile_path_);
if (!restore_data)
return 0;
return restore_data->FetchRestoreWindowId(app_id);
}
int32_t FullRestoreReadHandler::GetArcRestoreWindowIdForTaskId(
int32_t task_id) {
if (!arc_read_handler_)
return 0;
return arc_read_handler_->GetArcRestoreWindowIdForTaskId(task_id);
}
int32_t FullRestoreReadHandler::GetArcRestoreWindowIdForSessionId(
int32_t session_id) {
if (!arc_read_handler_)
return 0;
return arc_read_handler_->GetArcRestoreWindowIdForSessionId(session_id);
}
void FullRestoreReadHandler::SetArcSessionIdForWindowId(int32_t arc_session_id,
int32_t window_id) {
if (arc_read_handler_)
arc_read_handler_->SetArcSessionIdForWindowId(arc_session_id, window_id);
}
void FullRestoreReadHandler::SetStartTimeForProfile(
const base::FilePath& profile_path) {
profile_path_to_start_time_data_[profile_path] = base::TimeTicks::Now();
}
bool FullRestoreReadHandler::IsFullRestoreRunning() const {
auto it = profile_path_to_start_time_data_.find(active_profile_path_);
if (it == profile_path_to_start_time_data_.end())
return false;
if (IsArcRestoreRunning()) {
return true;
}
// We estimate that full restore is still running if it has been less than
// five seconds since it started.
return base::TimeTicks::Now() - it->second < kFullRestoreEstimateDuration;
}
void FullRestoreReadHandler::AddChromeBrowserLaunchInfoForTesting(
const base::FilePath& profile_path) {
auto session_id = SessionID::NewUnique();
auto app_launch_info = std::make_unique<app_restore::AppLaunchInfo>(
app_constants::kChromeAppId, session_id.id());
app_launch_info->browser_extra_info.app_type_browser = true;
if (profile_path_to_restore_data_.find(profile_path) ==
profile_path_to_restore_data_.end()) {
profile_path_to_restore_data_[profile_path] =
std::make_unique<app_restore::RestoreData>();
}
profile_path_to_restore_data_[profile_path]->AddAppLaunchInfo(
std::move(app_launch_info));
window_id_to_app_restore_info_[session_id.id()] =
std::make_pair(profile_path, app_constants::kChromeAppId);
}
std::unique_ptr<app_restore::WindowInfo> FullRestoreReadHandler::GetWindowInfo(
int32_t restore_window_id) {
if (!SessionID::IsValidValue(restore_window_id))
return nullptr;
auto it = window_id_to_app_restore_info_.find(restore_window_id);
if (it == window_id_to_app_restore_info_.end())
return nullptr;
const base::FilePath& profile_path = it->second.first;
const std::string& app_id = it->second.second;
return GetWindowInfo(profile_path, app_id, restore_window_id);
}
bool FullRestoreReadHandler::IsArcRestoreRunning() const {
if (!arc_read_handler_ || active_profile_path_ != primary_profile_path_)
return false;
auto it = profile_path_to_start_time_data_.find(primary_profile_path_);
if (it == profile_path_to_start_time_data_.end())
return false;
// We estimate that full restore is still running for ARC windows if it has
// been less than five minutes since it started, when there is at least one
// ARC app, since it might take long time to boot ARC.
return base::TimeTicks::Now() - it->second < kFullRestoreARCEstimateDuration;
}
void FullRestoreReadHandler::OnGetRestoreData(
const base::FilePath& profile_path,
Callback callback,
std::unique_ptr<app_restore::RestoreData> restore_data) {
if (restore_data) {
profile_path_to_restore_data_[profile_path] = restore_data->Clone();
for (auto it = restore_data->app_id_to_launch_list().begin();
it != restore_data->app_id_to_launch_list().end(); it++) {
const std::string& app_id = it->first;
for (auto data_it = it->second.begin(); data_it != it->second.end();
data_it++) {
int32_t window_id = data_it->first;
// Only ARC app launch parameters have event_flag.
if (data_it->second->event_flag.has_value()) {
if (!arc_read_handler_) {
arc_read_handler_ = std::make_unique<app_restore::ArcReadHandler>(
profile_path, this);
}
arc_read_handler_->AddRestoreData(app_id, window_id);
} else {
window_id_to_app_restore_info_[window_id] =
std::make_pair(profile_path, app_id);
}
}
}
} else {
profile_path_to_restore_data_[profile_path] = nullptr;
}
std::move(callback).Run(std::move(restore_data));
// Call FullRestoreSaveHandler to start a timer to clear the restore data
// after reading the restore data. Otherwise, if the user doesn't select
// restore, and never launch a new app, the restore data is not cleared. So
// when the system is reboot, the restore process could restore the previous
// record before the last reboot.
FullRestoreSaveHandler::GetInstance()->ClearRestoreData(profile_path);
}
void FullRestoreReadHandler::RemoveAppRestoreData(int32_t window_id) {
auto it = window_id_to_app_restore_info_.find(window_id);
if (it == window_id_to_app_restore_info_.end())
return;
const base::FilePath& profile_path = it->second.first;
const std::string& app_id = it->second.second;
RemoveAppRestoreData(profile_path, app_id, window_id);
window_id_to_app_restore_info_.erase(it);
}
app_restore::RestoreData* FullRestoreReadHandler::GetRestoreData(
const base::FilePath& profile_path) {
auto it = profile_path_to_restore_data_.find(profile_path);
if (it == profile_path_to_restore_data_.end() || !it->second) {
return nullptr;
}
return it->second.get();
}
} // namespace full_restore
|