// Copyright 2017 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 "components/update_client/component.h" #include #include #include "base/bind.h" #include "base/files/file_util.h" #include "base/files/scoped_temp_dir.h" #include "base/location.h" #include "base/logging.h" #include "base/single_thread_task_runner.h" #include "base/task_scheduler/post_task.h" #include "base/threading/thread_task_runner_handle.h" #include "components/update_client/action_runner.h" #include "components/update_client/component_unpacker.h" #include "components/update_client/configurator.h" #include "components/update_client/protocol_builder.h" #include "components/update_client/task_traits.h" #include "components/update_client/update_client.h" #include "components/update_client/update_client_errors.h" #include "components/update_client/update_engine.h" #include "components/update_client/utils.h" // The state machine representing how a CRX component changes during an update. // // +------------------------> kNew <---------------------+--------+ // | | | | // | V | | // | kChecking | | // | | | | // | error V no no | | // kUpdateError <------------- [update?] -> [action?] -> kUpToDate kUpdated // ^ | | ^ ^ // | yes | | yes | | // | V | | | // | kCanUpdate +--------> kRun | // | | | // | no V | // | +-<- [differential update?] | // | | | | // | | yes | | // | | error V | // | +-<----- kDownloadingDiff kRun---->-+ // | | | ^ | // | | | yes | | // | | error V | | // | +-<----- kUpdatingDiff ---------> [action?] ->-+ // | | ^ no // | error V | // +-<-------- kDownloading | // | | | // | | | // | error V | // +-<-------- kUpdating --------------------------------+ namespace update_client { namespace { using InstallOnBlockingTaskRunnerCompleteCallback = base::OnceCallback< void(int error_category, int error_code, int extra_code1)>; void InstallComplete( scoped_refptr main_task_runner, InstallOnBlockingTaskRunnerCompleteCallback callback, const base::FilePath& unpack_path, const CrxInstaller::Result& result) { base::PostTaskWithTraits( FROM_HERE, {base::TaskPriority::BACKGROUND, base::MayBlock()}, base::BindOnce( [](scoped_refptr main_task_runner, InstallOnBlockingTaskRunnerCompleteCallback callback, const base::FilePath& unpack_path, const CrxInstaller::Result& result) { base::DeleteFile(unpack_path, true); const ErrorCategory error_category = result.error ? ErrorCategory::kInstallError : ErrorCategory::kErrorNone; main_task_runner->PostTask( FROM_HERE, base::BindOnce(std::move(callback), static_cast(error_category), static_cast(result.error), result.extended_error)); }, main_task_runner, std::move(callback), unpack_path, result)); } void InstallOnBlockingTaskRunner( scoped_refptr main_task_runner, const base::FilePath& unpack_path, const std::string& public_key, const std::string& fingerprint, scoped_refptr installer, InstallOnBlockingTaskRunnerCompleteCallback callback) { DCHECK(base::DirectoryExists(unpack_path)); // Acquire the ownership of the |unpack_path|. base::ScopedTempDir unpack_path_owner; ignore_result(unpack_path_owner.Set(unpack_path)); if (static_cast(fingerprint.size()) != base::WriteFile( unpack_path.Append(FILE_PATH_LITERAL("manifest.fingerprint")), fingerprint.c_str(), base::checked_cast(fingerprint.size()))) { const CrxInstaller::Result result(InstallError::FINGERPRINT_WRITE_FAILED); main_task_runner->PostTask( FROM_HERE, base::BindOnce(std::move(callback), static_cast(ErrorCategory::kInstallError), static_cast(result.error), result.extended_error)); return; } installer->Install( unpack_path, public_key, base::BindOnce(&InstallComplete, main_task_runner, std::move(callback), unpack_path_owner.Take())); } void UnpackCompleteOnBlockingTaskRunner( scoped_refptr main_task_runner, const base::FilePath& crx_path, const std::string& fingerprint, scoped_refptr installer, InstallOnBlockingTaskRunnerCompleteCallback callback, const ComponentUnpacker::Result& result) { update_client::DeleteFileAndEmptyParentDirectory(crx_path); if (result.error != UnpackerError::kNone) { main_task_runner->PostTask( FROM_HERE, base::BindOnce(std::move(callback), static_cast(ErrorCategory::kUnpackError), static_cast(result.error), result.extended_error)); return; } base::PostTaskWithTraits( FROM_HERE, kTaskTraits, base::BindOnce(&InstallOnBlockingTaskRunner, main_task_runner, result.unpack_path, result.public_key, fingerprint, installer, std::move(callback))); } void StartInstallOnBlockingTaskRunner( scoped_refptr main_task_runner, const std::vector& pk_hash, const base::FilePath& crx_path, const std::string& fingerprint, scoped_refptr installer, std::unique_ptr connector, InstallOnBlockingTaskRunnerCompleteCallback callback) { auto unpacker = base::MakeRefCounted( pk_hash, crx_path, installer, std::move(connector)); unpacker->Unpack(base::BindOnce(&UnpackCompleteOnBlockingTaskRunner, main_task_runner, crx_path, fingerprint, installer, std::move(callback))); } } // namespace Component::Component(const UpdateContext& update_context, const std::string& id) : id_(id), state_(std::make_unique(this)), update_context_(update_context) {} Component::~Component() {} scoped_refptr Component::config() const { return update_context_.config; } std::string Component::session_id() const { return update_context_.session_id; } bool Component::is_foreground() const { return update_context_.is_foreground; } void Component::Handle(CallbackHandleComplete callback_handle_complete) { DCHECK(thread_checker_.CalledOnValidThread()); DCHECK(state_); callback_handle_complete_ = std::move(callback_handle_complete); state_->Handle( base::BindOnce(&Component::ChangeState, base::Unretained(this))); } void Component::ChangeState(std::unique_ptr next_state) { DCHECK(thread_checker_.CalledOnValidThread()); previous_state_ = state(); if (next_state) state_ = std::move(next_state); else is_handled_ = true; base::ThreadTaskRunnerHandle::Get()->PostTask( FROM_HERE, std::move(callback_handle_complete_)); } CrxUpdateItem Component::GetCrxUpdateItem() const { DCHECK(thread_checker_.CalledOnValidThread()); CrxUpdateItem crx_update_item; crx_update_item.state = state_->state(); crx_update_item.id = id_; crx_update_item.component = crx_component_; crx_update_item.last_check = last_check_; crx_update_item.next_version = next_version_; crx_update_item.next_fp = next_fp_; return crx_update_item; } void Component::SetParseResult(const ProtocolParser::Result& result) { DCHECK(thread_checker_.CalledOnValidThread()); DCHECK_EQ(0, update_check_error_); status_ = result.status; action_run_ = result.action_run; if (result.manifest.packages.empty()) return; next_version_ = base::Version(result.manifest.version); const auto& package = result.manifest.packages.front(); next_fp_ = package.fingerprint; // Resolve the urls by combining the base urls with the package names. for (const auto& crx_url : result.crx_urls) { const GURL url = crx_url.Resolve(package.name); if (url.is_valid()) crx_urls_.push_back(url); } for (const auto& crx_diffurl : result.crx_diffurls) { const GURL url = crx_diffurl.Resolve(package.namediff); if (url.is_valid()) crx_diffurls_.push_back(url); } hash_sha256_ = package.hash_sha256; hashdiff_sha256_ = package.hashdiff_sha256; } void Component::Uninstall(const base::Version& version, int reason) { DCHECK(thread_checker_.CalledOnValidThread()); DCHECK_EQ(ComponentState::kNew, state()); previous_version_ = version; next_version_ = base::Version("0"); extra_code1_ = reason; state_ = std::make_unique(this); } void Component::UpdateCheckComplete() { DCHECK(thread_checker_.CalledOnValidThread()); DCHECK_EQ(ComponentState::kChecking, state()); base::ThreadTaskRunnerHandle::Get()->PostTask( FROM_HERE, std::move(update_check_complete_)); } bool Component::CanDoBackgroundDownload() const { // Foreground component updates are always downloaded in foreground. return !is_foreground() && crx_component_.allows_background_download && update_context_.config->EnabledBackgroundDownloader(); } void Component::AppendEvent(const std::string& event) { events_.push_back(event); } void Component::NotifyObservers(UpdateClient::Observer::Events event) const { DCHECK(thread_checker_.CalledOnValidThread()); update_context_.notify_observers_callback.Run(event, id_); } base::TimeDelta Component::GetUpdateDuration() const { DCHECK(thread_checker_.CalledOnValidThread()); if (update_begin_.is_null()) return base::TimeDelta(); const base::TimeDelta update_cost(base::TimeTicks::Now() - update_begin_); DCHECK_GE(update_cost, base::TimeDelta()); const base::TimeDelta max_update_delay = base::TimeDelta::FromSeconds(update_context_.config->UpdateDelay()); return std::min(update_cost, max_update_delay); } Component::State::State(Component* component, ComponentState state) : state_(state), component_(*component) {} Component::State::~State() {} void Component::State::Handle(CallbackNextState callback_next_state) { DCHECK(thread_checker_.CalledOnValidThread()); callback_next_state_ = std::move(callback_next_state); DoHandle(); } void Component::State::TransitionState(std::unique_ptr next_state) { DCHECK(thread_checker_.CalledOnValidThread()); DCHECK(next_state); base::ThreadTaskRunnerHandle::Get()->PostTask( FROM_HERE, base::BindOnce(std::move(callback_next_state_), std::move(next_state))); } void Component::State::EndState() { DCHECK(thread_checker_.CalledOnValidThread()); base::ThreadTaskRunnerHandle::Get()->PostTask( FROM_HERE, base::BindOnce(std::move(callback_next_state_), nullptr)); } Component::StateNew::StateNew(Component* component) : State(component, ComponentState::kNew) {} Component::StateNew::~StateNew() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateNew::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); TransitionState(std::make_unique(&component)); } Component::StateChecking::StateChecking(Component* component) : State(component, ComponentState::kChecking) {} Component::StateChecking::~StateChecking() { DCHECK(thread_checker_.CalledOnValidThread()); } // Unlike how other states are handled, this function does not change the // state right away. The state transition happens when the UpdateChecker // calls Component::UpdateCheckComplete and |update_check_complete_| is invoked. // This is an artifact of how multiple components must be checked for updates // together but the state machine defines the transitions for one component // at a time. void Component::StateChecking::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.last_check_ = base::TimeTicks::Now(); component.update_check_complete_ = base::BindOnce( &Component::StateChecking::UpdateCheckComplete, base::Unretained(this)); component.NotifyObservers(Events::COMPONENT_CHECKING_FOR_UPDATES); } void Component::StateChecking::UpdateCheckComplete() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); if (!component.update_check_error_) { if (component.status_ == "ok") { TransitionState(std::make_unique(&component)); return; } if (component.status_ == "noupdate") { if (component.action_run_.empty()) TransitionState(std::make_unique(&component)); else TransitionState(std::make_unique(&component)); return; } } TransitionState(std::make_unique(&component)); } Component::StateUpdateError::StateUpdateError(Component* component) : State(component, ComponentState::kUpdateError) {} Component::StateUpdateError::~StateUpdateError() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUpdateError::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); // Create an event only when the server response included an update. if (component.IsUpdateAvailable()) component.AppendEvent(BuildUpdateCompleteEventElement(component)); EndState(); component.NotifyObservers(Events::COMPONENT_UPDATE_ERROR); } Component::StateCanUpdate::StateCanUpdate(Component* component) : State(component, ComponentState::kCanUpdate) {} Component::StateCanUpdate::~StateCanUpdate() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateCanUpdate::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.is_update_available_ = true; component.NotifyObservers(Events::COMPONENT_UPDATE_FOUND); if (component.crx_component_.supports_group_policy_enable_component_updates && !component.update_context_.enabled_component_updates) { component.error_category_ = static_cast(ErrorCategory::kServiceError); component.error_code_ = static_cast(ServiceError::UPDATE_DISABLED); component.extra_code1_ = 0; TransitionState(std::make_unique(&component)); return; } // Start computing the cost of the this update from here on. component.update_begin_ = base::TimeTicks::Now(); if (CanTryDiffUpdate()) TransitionState(std::make_unique(&component)); else TransitionState(std::make_unique(&component)); } // Returns true if a differential update is available, it has not failed yet, // and the configuration allows this update. bool Component::StateCanUpdate::CanTryDiffUpdate() const { const auto& component = Component::State::component(); return HasDiffUpdate(component) && !component.diff_error_code_ && component.update_context_.config->EnabledDeltas(); } Component::StateUpToDate::StateUpToDate(Component* component) : State(component, ComponentState::kUpToDate) {} Component::StateUpToDate::~StateUpToDate() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUpToDate::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.NotifyObservers(Events::COMPONENT_NOT_UPDATED); EndState(); } Component::StateDownloadingDiff::StateDownloadingDiff(Component* component) : State(component, ComponentState::kDownloadingDiff) {} Component::StateDownloadingDiff::~StateDownloadingDiff() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateDownloadingDiff::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); const auto& component = Component::State::component(); const auto& update_context = component.update_context_; crx_downloader_ = update_context.crx_downloader_factory( component.CanDoBackgroundDownload(), update_context.config->RequestContext()); const auto& id = component.id_; crx_downloader_->set_progress_callback( base::Bind(&Component::StateDownloadingDiff::DownloadProgress, base::Unretained(this), id)); crx_downloader_->StartDownload( component.crx_diffurls_, component.hashdiff_sha256_, base::BindOnce(&Component::StateDownloadingDiff::DownloadComplete, base::Unretained(this), id)); component.NotifyObservers(Events::COMPONENT_UPDATE_DOWNLOADING); } // Called when progress is being made downloading a CRX. The progress may // not monotonically increase due to how the CRX downloader switches between // different downloaders and fallback urls. void Component::StateDownloadingDiff::DownloadProgress( const std::string& id, const CrxDownloader::Result& download_result) { DCHECK(thread_checker_.CalledOnValidThread()); component().NotifyObservers(Events::COMPONENT_UPDATE_DOWNLOADING); } void Component::StateDownloadingDiff::DownloadComplete( const std::string& id, const CrxDownloader::Result& download_result) { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = Component::State::component(); for (const auto& metrics : crx_downloader_->download_metrics()) component.AppendEvent( BuildDownloadCompleteEventElement(component, metrics)); crx_downloader_.reset(); if (download_result.error) { DCHECK(download_result.response.empty()); component.diff_error_category_ = static_cast(ErrorCategory::kNetworkError); component.diff_error_code_ = download_result.error; TransitionState(std::make_unique(&component)); return; } component.crx_path_ = download_result.response; TransitionState(std::make_unique(&component)); } Component::StateDownloading::StateDownloading(Component* component) : State(component, ComponentState::kDownloading) {} Component::StateDownloading::~StateDownloading() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateDownloading::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); const auto& component = Component::State::component(); const auto& update_context = component.update_context_; crx_downloader_ = update_context.crx_downloader_factory( component.CanDoBackgroundDownload(), update_context.config->RequestContext()); const auto& id = component.id_; crx_downloader_->set_progress_callback( base::Bind(&Component::StateDownloading::DownloadProgress, base::Unretained(this), id)); crx_downloader_->StartDownload( component.crx_urls_, component.hash_sha256_, base::BindOnce(&Component::StateDownloading::DownloadComplete, base::Unretained(this), id)); component.NotifyObservers(Events::COMPONENT_UPDATE_DOWNLOADING); } // Called when progress is being made downloading a CRX. The progress may // not monotonically increase due to how the CRX downloader switches between // different downloaders and fallback urls. void Component::StateDownloading::DownloadProgress( const std::string& id, const CrxDownloader::Result& download_result) { DCHECK(thread_checker_.CalledOnValidThread()); component().NotifyObservers(Events::COMPONENT_UPDATE_DOWNLOADING); } void Component::StateDownloading::DownloadComplete( const std::string& id, const CrxDownloader::Result& download_result) { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = Component::State::component(); for (const auto& metrics : crx_downloader_->download_metrics()) component.AppendEvent( BuildDownloadCompleteEventElement(component, metrics)); crx_downloader_.reset(); if (download_result.error) { DCHECK(download_result.response.empty()); component.error_category_ = static_cast(ErrorCategory::kNetworkError); component.error_code_ = download_result.error; TransitionState(std::make_unique(&component)); return; } component.crx_path_ = download_result.response; TransitionState(std::make_unique(&component)); } Component::StateUpdatingDiff::StateUpdatingDiff(Component* component) : State(component, ComponentState::kUpdatingDiff) {} Component::StateUpdatingDiff::~StateUpdatingDiff() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUpdatingDiff::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); const auto& component = Component::State::component(); const auto& update_context = component.update_context_; component.NotifyObservers(Events::COMPONENT_UPDATE_READY); // Create a fresh connector that can be used on the other task runner. std::unique_ptr connector = update_context.config->CreateServiceManagerConnector(); base::CreateSequencedTaskRunnerWithTraits(kTaskTraits) ->PostTask( FROM_HERE, base::BindOnce( &update_client::StartInstallOnBlockingTaskRunner, base::ThreadTaskRunnerHandle::Get(), component.crx_component_.pk_hash, component.crx_path_, component.next_fp_, component.crx_component_.installer, std::move(connector), base::BindOnce(&Component::StateUpdatingDiff::InstallComplete, base::Unretained(this)))); } void Component::StateUpdatingDiff::InstallComplete(int error_category, int error_code, int extra_code1) { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = Component::State::component(); component.diff_error_category_ = error_category; component.diff_error_code_ = error_code; component.diff_extra_code1_ = extra_code1; if (component.diff_error_code_ != 0) { TransitionState(std::make_unique(&component)); return; } DCHECK_EQ(static_cast(ErrorCategory::kErrorNone), component.diff_error_category_); DCHECK_EQ(0, component.diff_error_code_); DCHECK_EQ(0, component.diff_extra_code1_); DCHECK_EQ(static_cast(ErrorCategory::kErrorNone), component.error_category_); DCHECK_EQ(0, component.error_code_); DCHECK_EQ(0, component.extra_code1_); if (component.action_run_.empty()) TransitionState(std::make_unique(&component)); else TransitionState(std::make_unique(&component)); } Component::StateUpdating::StateUpdating(Component* component) : State(component, ComponentState::kUpdating) {} Component::StateUpdating::~StateUpdating() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUpdating::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); const auto& component = Component::State::component(); const auto& update_context = component.update_context_; component.NotifyObservers(Events::COMPONENT_UPDATE_READY); // Create a fresh connector that can be used on the other task runner. std::unique_ptr connector = update_context.config->CreateServiceManagerConnector(); base::CreateSequencedTaskRunnerWithTraits(kTaskTraits) ->PostTask(FROM_HERE, base::BindOnce( &update_client::StartInstallOnBlockingTaskRunner, base::ThreadTaskRunnerHandle::Get(), component.crx_component_.pk_hash, component.crx_path_, component.next_fp_, component.crx_component_.installer, std::move(connector), base::BindOnce(&Component::StateUpdating::InstallComplete, base::Unretained(this)))); } void Component::StateUpdating::InstallComplete(int error_category, int error_code, int extra_code1) { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = Component::State::component(); component.error_category_ = error_category; component.error_code_ = error_code; component.extra_code1_ = extra_code1; if (component.error_code_ != 0) { TransitionState(std::make_unique(&component)); return; } DCHECK_EQ(static_cast(ErrorCategory::kErrorNone), component.error_category_); DCHECK_EQ(0, component.error_code_); DCHECK_EQ(0, component.extra_code1_); if (component.action_run_.empty()) TransitionState(std::make_unique(&component)); else TransitionState(std::make_unique(&component)); } Component::StateUpdated::StateUpdated(Component* component) : State(component, ComponentState::kUpdated) { DCHECK(thread_checker_.CalledOnValidThread()); } Component::StateUpdated::~StateUpdated() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUpdated::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.crx_component_.version = component.next_version_; component.crx_component_.fingerprint = component.next_fp_; component.AppendEvent(BuildUpdateCompleteEventElement(component)); component.NotifyObservers(Events::COMPONENT_UPDATED); EndState(); } Component::StateUninstalled::StateUninstalled(Component* component) : State(component, ComponentState::kUninstalled) { DCHECK(thread_checker_.CalledOnValidThread()); } Component::StateUninstalled::~StateUninstalled() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateUninstalled::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.AppendEvent(BuildUninstalledEventElement(component)); EndState(); } Component::StateRun::StateRun(Component* component) : State(component, ComponentState::kRun) {} Component::StateRun::~StateRun() { DCHECK(thread_checker_.CalledOnValidThread()); } void Component::StateRun::DoHandle() { DCHECK(thread_checker_.CalledOnValidThread()); const auto& component = State::component(); action_runner_ = std::make_unique(component); action_runner_->Run( base::BindOnce(&StateRun::ActionRunComplete, base::Unretained(this))); } void Component::StateRun::ActionRunComplete(bool succeeded, int error_code, int extra_code1) { DCHECK(thread_checker_.CalledOnValidThread()); auto& component = State::component(); component.AppendEvent( BuildActionRunEventElement(succeeded, error_code, extra_code1)); switch (component.previous_state_) { case ComponentState::kChecking: TransitionState(std::make_unique(&component)); return; case ComponentState::kUpdating: case ComponentState::kUpdatingDiff: TransitionState(std::make_unique(&component)); return; default: break; } NOTREACHED(); } } // namespace update_client