chrome/browser/web_applications/components/install_finalizer.h

// Copyright 2018 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_WEB_APPLICATIONS_COMPONENTS_INSTALL_FINALIZER_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_COMPONENTS_INSTALL_FINALIZER_H_

#include "base/callback_forward.h"
#include "chrome/browser/web_applications/components/web_app_chromeos_data.h"
#include "chrome/browser/web_applications/components/web_app_id.h"
#include "chrome/browser/web_applications/components/web_app_system_web_app_data.h"
#include "components/webapps/browser/installable/installable_metrics.h"
#include "third_party/abseil-cpp/absl/types/optional.h"

struct WebApplicationInfo;
class GURL;

namespace content {
class WebContents;
}

namespace webapps {
enum class WebappUninstallSource;
}

namespace web_app {

enum class ExternalInstallSource;
enum class InstallResultCode;
class WebAppRegistrar;
class AppRegistryController;
class WebApp;
class WebAppUiManager;
class OsIntegrationManager;

// An abstract finalizer for the installation process, represents the last step.
// Takes WebApplicationInfo as input, writes data to disk (e.g icons, shortcuts)
// and registers an app.
class InstallFinalizer {
 public:
  using InstallFinalizedCallback =
      base::OnceCallback<void(const AppId& app_id, InstallResultCode code)>;
  using UninstallWebAppCallback = base::OnceCallback<void(bool uninstalled)>;
  using RepeatingUninstallCallback =
      base::RepeatingCallback<void(const AppId& app_id, bool uninstalled)>;

  struct FinalizeOptions {
    FinalizeOptions();
    ~FinalizeOptions();
    FinalizeOptions(const FinalizeOptions&);

    webapps::WebappInstallSource install_source =
        webapps::WebappInstallSource::COUNT;
    bool locally_installed = true;

    absl::optional<WebAppChromeOsData> chromeos_data;
    absl::optional<WebAppSystemWebAppData> system_web_app_data;
  };

  // Write the WebApp data to disk and register the app.
  virtual void FinalizeInstall(const WebApplicationInfo& web_app_info,
                               const FinalizeOptions& options,
                               InstallFinalizedCallback callback) = 0;

  // Write the new WebApp data to disk and update the app.
  // TODO(https://crbug.com/1196051): Chrome fails to update the manifest
  // if the app window needing update closes at the same time as Chrome.
  // Therefore, the manifest may not always update as expected.
  virtual void FinalizeUpdate(const WebApplicationInfo& web_app_info,
                              content::WebContents* web_contents,
                              InstallFinalizedCallback callback) = 0;

  // Removes |webapp_uninstall_source| from |app_id|. If no more interested
  // sources left, deletes the app from disk and registrar.
  virtual void UninstallExternalWebApp(
      const AppId& app_id,
      webapps::WebappUninstallSource webapp_uninstall_source,
      UninstallWebAppCallback callback) = 0;

  // Removes the external app for |app_url| from disk and registrar. Fails if
  // there is no installed external app for |app_url|. Virtual for testing.
  virtual void UninstallExternalWebAppByUrl(
      const GURL& app_url,
      webapps::WebappUninstallSource webapp_uninstall_source,
      UninstallWebAppCallback callback);

  virtual bool CanUserUninstallWebApp(const AppId& app_id) const = 0;

  // Removes |webapp_uninstall_source| from |app_id|. If no more interested
  // sources left, deletes the app from disk and registrar.
  virtual void UninstallWebApp(
      const AppId& app_id,
      webapps::WebappUninstallSource webapp_uninstall_source,
      UninstallWebAppCallback callback) = 0;

  // Sync-initiated uninstall. Copied from WebAppInstallSyncInstallDelegate.
  // Called before the web apps are removed from the registry. Begins process of
  // uninstalling OS hooks, which initially requires the registrar to still
  // contain the web app data. Also notify observers of WebAppWillBeUninstalled.
  // TODO(dmurph): After migration to WebApp* from the registry, this could
  // potentially just be done in one step, after removal from registry, as os
  // hooks information could be passed.
  virtual void UninstallFromSyncBeforeRegistryUpdate(
      std::vector<AppId> web_apps) = 0;
  // Delete non-database app data from disk (icon .png files). |app_id| must be
  // unregistered. Observers are notified of WebAppUninstalled and the
  // |callback| is called after the app data is fully deleted & os hooks
  // uninstalled.
  virtual void UninstallFromSyncAfterRegistryUpdate(
      std::vector<std::unique_ptr<WebApp>> web_apps,
      RepeatingUninstallCallback callback) = 0;

  // Returns true if the app with |app_id| was previously uninstalled by the
  // user. For example, if a user uninstalls a default app ('default apps' are
  // considered external apps), then this will return true.
  virtual bool WasPreinstalledWebAppUninstalled(const AppId& app_id) const = 0;

  // |virtual| for testing.
  virtual bool CanReparentTab(const AppId& app_id, bool shortcut_created) const;
  virtual void ReparentTab(const AppId& app_id,
                           bool shortcut_created,
                           content::WebContents* web_contents);

  virtual void Start() {}
  virtual void Shutdown() {}

  void SetSubsystems(WebAppRegistrar* registrar,
                     WebAppUiManager* ui_manager,
                     AppRegistryController* registry_controller,
                     OsIntegrationManager* os_integration_manager);

  virtual ~InstallFinalizer() = default;

 protected:
  bool is_legacy_finalizer() const { return registrar_ == nullptr; }
  WebAppRegistrar& registrar() const;

  WebAppUiManager& ui_manager() const { return *ui_manager_; }
  AppRegistryController& registry_controller() { return *registry_controller_; }
  OsIntegrationManager& os_integration_manager() {
    return *os_integration_manager_;
  }

 private:
  // If these pointers are nullptr then this is legacy install finalizer
  // operating in standalone mode.
  WebAppRegistrar* registrar_ = nullptr;
  AppRegistryController* registry_controller_ = nullptr;
  WebAppUiManager* ui_manager_ = nullptr;
  OsIntegrationManager* os_integration_manager_ = nullptr;
};

}  // namespace web_app

#endif  // CHROME_BROWSER_WEB_APPLICATIONS_COMPONENTS_INSTALL_FINALIZER_H_