chrome/browser/component_updater/cros_component_installer.h

// 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.

#ifndef CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_
#define CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "chromeos/dbus/dbus_method_call_status.h"
#include "components/component_updater/component_installer.h"
#include "components/component_updater/component_updater_service.h"
#include "components/update_client/update_client.h"
#include "crypto/sha2.h"

//  Developer API usage:
//  ...
//  void LoadCallback(const std::string& mount_point){
//    if (mount_point.empty()) {
//      // component is not loaded.
//      return;
//    }
//    ...
//  }
//  ...
//  component_updater::CrOSComponent::LoadComponent(
//            name,
//            base::BindOnce(&LoadCallback));
//
namespace component_updater {

struct ComponentConfig {
  std::string name;
  std::string env_version;
  std::string sha2hashstr;
  ComponentConfig(const std::string& name,
                  const std::string& env_version,
                  const std::string& sha2hashstr);
  ~ComponentConfig();
};

class CrOSComponentInstallerPolicy : public ComponentInstallerPolicy {
 public:
  explicit CrOSComponentInstallerPolicy(const ComponentConfig& config);
  ~CrOSComponentInstallerPolicy() override {}

 private:
  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest, IsCompatibleOrNot);
  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest,
                           ComponentReadyCorrectManifest);
  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest,
                           ComponentReadyWrongManifest);
  // The following methods override ComponentInstallerPolicy.
  bool SupportsGroupPolicyEnabledComponentUpdates() const override;
  bool RequiresNetworkEncryption() const override;
  update_client::CrxInstaller::Result OnCustomInstall(
      const base::DictionaryValue& manifest,
      const base::FilePath& install_dir) override;
  void OnCustomUninstall() override;
  bool VerifyInstallation(const base::DictionaryValue& manifest,
                          const base::FilePath& install_dir) const override;
  void ComponentReady(const base::Version& version,
                      const base::FilePath& path,
                      std::unique_ptr<base::DictionaryValue> manifest) override;
  base::FilePath GetRelativeInstallDir() const override;
  void GetHash(std::vector<uint8_t>* hash) const override;
  std::string GetName() const override;
  update_client::InstallerAttributes GetInstallerAttributes() const override;
  std::vector<std::string> GetMimeTypes() const override;

  virtual bool IsCompatible(const std::string& env_version_str,
                            const std::string& min_env_version_str);
  std::string name;
  std::string env_version;
  uint8_t kSha2Hash_[crypto::kSHA256Length] = {};

  DISALLOW_COPY_AND_ASSIGN(CrOSComponentInstallerPolicy);
};

// This class contains functions used to register and install a component.
class CrOSComponent {
 public:
  // Installs a component and keeps it up-to-date.
  static void LoadComponent(
      const std::string& name,
      base::OnceCallback<void(const std::string&)> load_callback);

  // Stops updating and removes a component.
  // Returns true if the component was successfully unloaded
  // or false if it couldn't be unloaded or already wasn't loaded.
  static bool UnloadComponent(const std::string& name);

  // Returns all installed components.
  static std::vector<ComponentConfig> GetInstalledComponents();

  // Registers component |configs| to be updated.
  static void RegisterComponents(const std::vector<ComponentConfig>& configs);

 private:
  static void RegisterResult(ComponentUpdateService* cus,
                             const std::string& id,
                             update_client::Callback install_callback);
  static void InstallComponent(
      ComponentUpdateService* cus,
      const std::string& name,
      base::OnceCallback<void(const std::string&)> load_callback);
};

}  // namespace component_updater

#endif  // CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_