chrome/browser/web_applications/commands/install_from_info_command.h

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_WEB_APPLICATIONS_COMMANDS_INSTALL_FROM_INFO_COMMAND_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_COMMANDS_INSTALL_FROM_INFO_COMMAND_H_

#include <memory>

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/values.h"
#include "chrome/browser/web_applications/commands/web_app_command.h"
#include "chrome/browser/web_applications/os_integration/os_integration_manager.h"
#include "chrome/browser/web_applications/web_app_id.h"
#include "chrome/browser/web_applications/web_app_install_info.h"
#include "chrome/browser/web_applications/web_app_install_params.h"
#include "chrome/browser/web_applications/web_app_uninstall_and_replace_job.h"
#include "components/webapps/browser/installable/installable_metrics.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "third_party/blink/public/mojom/manifest/manifest.mojom-forward.h"

class Profile;

namespace web_app {

class AppLock;
class AppLockDescription;
class LockDescription;

// Starts a web app installation process using prefilled
// |install_info| which holds all the data needed for installation.
// This doesn't fetch a manifest and doesn't perform all required steps for
// External installed apps: use |ExternallyManagedAppManager::Install|
// instead.
//
// The web app can be simultaneously installed from multiple sources.
// If the web app already exists and `overwrite_existing_manifest_fields` is
// false then manifest fields in `install_info` are treated only as
// fallback manifest values. If `overwrite_existing_manifest_fields` is true
// then the existing web app manifest fields will be overwritten.
// If `install_info` contains data freshly fetched from the web app's
// site then `overwrite_existing_manifest_fields` should be true.
class InstallFromInfoCommand : public WebAppCommandTemplate<AppLock> {
 public:
  using InstallAndReplaceCallback =
      base::OnceCallback<void(const AppId& app_id,
                              webapps::InstallResultCode code,
                              bool did_uninstall_and_replace)>;

  // This doesn't install OS hooks.
  InstallFromInfoCommand(Profile* profile,
                         std::unique_ptr<WebAppInstallInfo> install_info,
                         bool overwrite_existing_manifest_fields,
                         webapps::WebappInstallSource install_surface,
                         OnceInstallCallback install_callback);

  // The `install_params` controls whether and how OS hooks get installed.
  InstallFromInfoCommand(Profile* profile,
                         std::unique_ptr<WebAppInstallInfo> install_info,
                         bool overwrite_existing_manifest_fields,
                         webapps::WebappInstallSource install_surface,
                         OnceInstallCallback install_callback,
                         const WebAppInstallParams& install_params);

  // The `install_params` controls whether and how OS hooks get installed.
  InstallFromInfoCommand(
      Profile* profile,
      std::unique_ptr<WebAppInstallInfo> install_info,
      bool overwrite_existing_manifest_fields,
      webapps::WebappInstallSource install_surface,
      InstallAndReplaceCallback install_callback,
      const WebAppInstallParams& install_params,
      const std::vector<AppId>& apps_or_extensions_to_uninstall);

  ~InstallFromInfoCommand() override;

  // WebAppCommandTemplate<AppLock>:
  const LockDescription& lock_description() const override;
  void StartWithLock(std::unique_ptr<AppLock> lock) override;
  void OnSyncSourceRemoved() override;
  void OnShutdown() override;
  base::Value ToDebugValue() const override;

 private:
  void PopulateInitialDebugInfo();

  void Abort(webapps::InstallResultCode code);

  void OnInstallCompleted(const AppId& app_id,
                          webapps::InstallResultCode code,
                          OsHooksErrors os_hooks_errors);

  void OnUnintallAndReplaceFinished(const AppId& app_id,
                                    webapps::InstallResultCode code,
                                    bool did_uninstall_and_replace);

  const raw_ptr<Profile> profile_;

  std::unique_ptr<AppLockDescription> lock_description_;
  std::unique_ptr<AppLock> lock_;

  AppId app_id_;
  std::unique_ptr<WebAppInstallInfo> install_info_;
  bool overwrite_existing_manifest_fields_;
  webapps::WebappInstallSource install_surface_;
  InstallAndReplaceCallback install_callback_;
  absl::optional<WebAppInstallParams> install_params_;

  const std::vector<AppId> apps_or_extensions_to_uninstall_;
  absl::optional<WebAppUninstallAndReplaceJob> uninstall_and_replace_job_;

  base::Value::Dict debug_value_;

  base::WeakPtrFactory<InstallFromInfoCommand> weak_factory_{this};
};

}  // namespace web_app

#endif  // CHROME_BROWSER_WEB_APPLICATIONS_COMMANDS_INSTALL_FROM_INFO_COMMAND_H_