chrome/browser/web_applications/web_app_migration_manager.cc

// Copyright 2020 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 "chrome/browser/web_applications/web_app_migration_manager.h"

#include <map>
#include <utility>

#include "base/bind.h"
#include "base/callback.h"
#include "base/containers/contains.h"
#include "base/feature_list.h"
#include "base/logging.h"
#include "base/stl_util.h"
#include "base/threading/sequenced_task_runner_handle.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/web_applications/components/web_app_chromeos_data.h"
#include "chrome/browser/web_applications/components/web_app_constants.h"
#include "chrome/browser/web_applications/components/web_app_helpers.h"
#include "chrome/browser/web_applications/components/web_app_ui_manager.h"
#include "chrome/browser/web_applications/components/web_app_utils.h"
#include "chrome/browser/web_applications/extensions/bookmark_app_file_handler_manager.h"
#include "chrome/browser/web_applications/extensions/bookmark_app_icon_manager.h"
#include "chrome/browser/web_applications/extensions/bookmark_app_registrar.h"
#include "chrome/browser/web_applications/extensions/bookmark_app_registry_controller.h"
#include "chrome/browser/web_applications/web_app.h"
#include "chrome/browser/web_applications/web_app_database.h"
#include "chrome/browser/web_applications/web_app_database_factory.h"
#include "chrome/browser/web_applications/web_app_icon_manager.h"
#include "chrome/browser/web_applications/web_app_registry_update.h"
#include "chrome/common/chrome_features.h"
#include "components/services/app_service/public/cpp/file_handler.h"
#include "components/sync/model/metadata_batch.h"
#include "components/sync/model/metadata_change_list.h"
#include "components/sync/model/model_error.h"
#include "components/sync/model/model_type_store.h"

namespace web_app {

WebAppMigrationManager::WebAppMigrationManager(
    Profile* profile,
    AbstractWebAppDatabaseFactory* database_factory,
    WebAppIconManager* web_app_icon_manager,
    OsIntegrationManager* os_integration_manager)
    : bookmark_app_registrar_(
          std::make_unique<extensions::BookmarkAppRegistrar>(profile)),
      bookmark_app_registry_controller_(
          std::make_unique<extensions::BookmarkAppRegistryController>(
              profile,
              bookmark_app_registrar_.get())),
      bookmark_app_icon_manager_(
          std::make_unique<extensions::BookmarkAppIconManager>(profile)),
      bookmark_app_file_handler_manager_(
          std::make_unique<extensions::BookmarkAppFileHandlerManager>(profile)),
      database_factory_(database_factory),
      web_app_icon_manager_(web_app_icon_manager) {
  database_ = std::make_unique<WebAppDatabase>(
      database_factory_,
      base::BindRepeating(&WebAppMigrationManager::ReportDatabaseError,
                          base::Unretained(this)));
  bookmark_app_file_handler_manager_->SetSubsystems(
      bookmark_app_registrar_.get());
  bookmark_app_registrar_->SetSubsystems(os_integration_manager);
}

WebAppMigrationManager::~WebAppMigrationManager() = default;

void WebAppMigrationManager::StartDatabaseMigration(
    MigrationCompletedCallback migration_completed_callback) {
  DCHECK(database_);
  migration_completed_callback_ = std::move(migration_completed_callback);

  // Open LevelDB first. The extension system behind
  // BookmarkAppRegistryController is already started in parallel.
  database_->OpenDatabase(
      base::BindOnce(&WebAppMigrationManager::OnWebAppDatabaseOpened,
                     weak_ptr_factory_.GetWeakPtr()));
}

void WebAppMigrationManager::OnWebAppDatabaseOpened(
    Registry web_app_registry,
    std::unique_ptr<syncer::MetadataBatch> metadata_batch) {
  if (metadata_batch->GetModelTypeState().initial_sync_done()) {
    // If initial sync is done, then WebAppSyncBridge::MergeSyncData was already
    // called once. All the migrated entities are already listed in sync
    // metadata. Any additional apps from this point in time should be installed
    // via WebAppSyncBridge::CommitUpdate() "as if" a user installs them.
    ScheduleDestructDatabaseAndCallCallback(/*success=*/true);
    return;
  }

  // Wait for the Extensions System to be ready.
  bookmark_app_registry_controller_->Init(base::BindOnce(
      &WebAppMigrationManager::OnBookmarkAppRegistryReady,
      weak_ptr_factory_.GetWeakPtr(), std::move(web_app_registry)));
}

void WebAppMigrationManager::OnBookmarkAppRegistryReady(
    Registry web_app_registry) {
  bookmark_app_ids_ = bookmark_app_registrar_->GetAppIds();

  // Remove bookmark app ids already listed in the web app registry.
  base::EraseIf(bookmark_app_ids_, [&web_app_registry](const AppId& app_id) {
    return base::Contains(web_app_registry, app_id);
  });

  // Migrate icons first, the registry data (the LevelDB transaction) last.
  next_app_id_iterator_ = bookmark_app_ids_.begin();
  MigrateNextBookmarkAppIcons();
}

void WebAppMigrationManager::MigrateNextBookmarkAppIcons() {
  AppId app_id;
  do {
    if (next_app_id_iterator_ == bookmark_app_ids_.end()) {
      MigrateBookmarkAppsRegistry();
      return;
    }

    app_id = *next_app_id_iterator_;
    ++next_app_id_iterator_;
  } while (!CanMigrateBookmarkApp(app_id));

  bookmark_app_icon_manager_->ReadAllIcons(
      app_id, base::BindOnce(&WebAppMigrationManager::OnBookmarkAppIconsRead,
                             weak_ptr_factory_.GetWeakPtr(), app_id));
}

void WebAppMigrationManager::OnBookmarkAppIconsRead(const AppId& app_id,
                                                    IconBitmaps icon_bitmaps) {
  if (icon_bitmaps.empty()) {
    DLOG(ERROR) << "Read bookmark app icons failed.";
    MigrateNextBookmarkAppIcons();
    return;
  }

  web_app_icon_manager_->WriteData(
      app_id, std::move(icon_bitmaps),
      base::BindOnce(&WebAppMigrationManager::OnWebAppIconsWritten,
                     weak_ptr_factory_.GetWeakPtr(), app_id));
}

void WebAppMigrationManager::OnWebAppIconsWritten(const AppId& app_id,
                                                  bool success) {
  if (!success)
    DLOG(ERROR) << "Write web app icons failed.";
  if (base::FeatureList::IsEnabled(
          features::kDesktopPWAsAppIconShortcutsMenu)) {
    bookmark_app_icon_manager_->ReadAllShortcutsMenuIcons(
        app_id,
        base::BindOnce(
            &WebAppMigrationManager::OnBookmarkAppShortcutsMenuIconsRead,
            weak_ptr_factory_.GetWeakPtr(), app_id));
  } else {
    MigrateNextBookmarkAppIcons();
  }
}

void WebAppMigrationManager::OnBookmarkAppShortcutsMenuIconsRead(
    const AppId& app_id,
    ShortcutsMenuIconBitmaps shortcuts_menu_icon_bitmaps) {
  web_app_icon_manager_->WriteShortcutsMenuIconsData(
      app_id, std::move(shortcuts_menu_icon_bitmaps),
      base::BindOnce(&WebAppMigrationManager::OnWebAppShortcutsMenuIconsWritten,
                     weak_ptr_factory_.GetWeakPtr()));
}

void WebAppMigrationManager::OnWebAppShortcutsMenuIconsWritten(bool success) {
  if (!success)
    DLOG(ERROR) << "Write web app shortcuts menu icons failed.";
  MigrateNextBookmarkAppIcons();
}

void WebAppMigrationManager::MigrateBookmarkAppInstallSource(
    const AppId& app_id,
    WebApp* web_app) {
  bool is_arc = bookmark_app_registrar_->HasExternalAppWithInstallSource(
      app_id, ExternalInstallSource::kArc);

  bool is_policy = bookmark_app_registrar_->HasExternalAppWithInstallSource(
      app_id, ExternalInstallSource::kExternalPolicy);

  bool is_default = bookmark_app_registrar_->HasExternalAppWithInstallSource(
                        app_id, ExternalInstallSource::kInternalDefault) ||
                    bookmark_app_registrar_->HasExternalAppWithInstallSource(
                        app_id, ExternalInstallSource::kExternalDefault);

  bool is_system = bookmark_app_registrar_->HasExternalAppWithInstallSource(
      app_id, ExternalInstallSource::kSystemInstalled);

  if (is_default)
    web_app->AddSource(Source::kDefault);

  if (is_policy)
    web_app->AddSource(Source::kPolicy);

  if (is_system)
    web_app->AddSource(Source::kSystem);

  if (is_arc)
    web_app->AddSource(Source::kWebAppStore);

  if (!bookmark_app_registrar_->HasExternalApp(app_id))
    web_app->AddSource(Source::kSync);

  DCHECK(web_app->HasAnySources());
}

bool WebAppMigrationManager::CanMigrateBookmarkApp(const AppId& app_id) const {
  if (!bookmark_app_registrar_->IsInstalled(app_id))
    return false;

  // SystemWebAppManager will re-install these.
  if (bookmark_app_registrar_->HasExternalAppWithInstallSource(
          app_id, ExternalInstallSource::kSystemInstalled)) {
    return false;
  }

  GURL start_url = bookmark_app_registrar_->GetAppStartUrl(app_id);
  return GenerateAppIdFromURL(start_url) == app_id;
}

std::unique_ptr<WebApp> WebAppMigrationManager::MigrateBookmarkApp(
    const AppId& app_id) {
  DCHECK(CanMigrateBookmarkApp(app_id));

  auto web_app = std::make_unique<WebApp>(app_id);

  web_app->SetName(bookmark_app_registrar_->GetAppShortName(app_id));
  web_app->SetDescription(bookmark_app_registrar_->GetAppDescription(app_id));
  web_app->SetStartUrl(bookmark_app_registrar_->GetAppStartUrl(app_id));
  web_app->SetLastLaunchTime(
      bookmark_app_registrar_->GetAppLastLaunchTime(app_id));
  web_app->SetInstallTime(bookmark_app_registrar_->GetAppInstallTime(app_id));
  base::Optional<GURL> scope = bookmark_app_registrar_->GetAppScope(app_id);
  if (scope)
    web_app->SetScope(*scope);

  web_app->SetThemeColor(bookmark_app_registrar_->GetAppThemeColor(app_id));
  web_app->SetDisplayMode(bookmark_app_registrar_->GetAppDisplayMode(app_id));

  DisplayMode user_display_mode =
      bookmark_app_registrar_->GetAppUserDisplayModeForMigration(app_id);
  if (user_display_mode != DisplayMode::kUndefined)
    web_app->SetUserDisplayMode(user_display_mode);

  web_app->SetIsLocallyInstalled(
      bookmark_app_registrar_->IsLocallyInstalled(app_id));
  web_app->SetIconInfos(bookmark_app_registrar_->GetAppIconInfos(app_id));
  web_app->SetDownloadedIconSizes(
      IconPurpose::ANY,
      bookmark_app_registrar_->GetAppDownloadedIconSizesAny(app_id));
  // Migrated bookmark apps will have no IconPurpose::MASKABLE icons downloaded.

  if (base::FeatureList::IsEnabled(
          features::kDesktopPWAsAppIconShortcutsMenu)) {
    web_app->SetShortcutsMenuItemInfos(
        bookmark_app_registrar_->GetAppShortcutsMenuItemInfos(app_id));
    web_app->SetDownloadedShortcutsMenuIconsSizes(
        bookmark_app_registrar_->GetAppDownloadedShortcutsMenuIconsSizes(
            app_id));
  }

  web_app->SetUserPageOrdinal(
      bookmark_app_registrar_->GetUserPageOrdinal(app_id));
  web_app->SetUserLaunchOrdinal(
      bookmark_app_registrar_->GetUserLaunchOrdinal(app_id));

  WebApp::SyncFallbackData sync_fallback_data;
  sync_fallback_data.name = bookmark_app_registrar_->GetAppShortName(app_id);
  sync_fallback_data.theme_color =
      bookmark_app_registrar_->GetAppThemeColor(app_id);
  // Avoid using derived scope as we are transferring raw data.
  sync_fallback_data.scope =
      bookmark_app_registrar_->GetAppScopeInternal(app_id).value_or(GURL());
  sync_fallback_data.icon_infos =
      bookmark_app_registrar_->GetAppIconInfos(app_id);
  web_app->SetSyncFallbackData(std::move(sync_fallback_data));

  const apps::FileHandlers* file_handlers =
      bookmark_app_file_handler_manager_->GetAllFileHandlers(app_id);
  if (file_handlers)
    web_app->SetFileHandlers(*file_handlers);

  MigrateBookmarkAppInstallSource(app_id, web_app.get());

  return web_app;
}

void WebAppMigrationManager::MigrateBookmarkAppsRegistry() {
  DCHECK(database_);

  if (bookmark_app_ids_.empty()) {
    ScheduleDestructDatabaseAndCallCallback(/*success=*/true);
    return;
  }

  std::unique_ptr<syncer::MetadataChangeList> metadata_change_list =
      syncer::ModelTypeStore::WriteBatch::CreateMetadataChangeList();

  RegistryUpdateData update_data;
  update_data.apps_to_create.reserve(bookmark_app_ids_.size());

  for (const AppId& app_id : bookmark_app_ids_) {
    if (CanMigrateBookmarkApp(app_id)) {
      std::unique_ptr<WebApp> web_app = MigrateBookmarkApp(app_id);
      update_data.apps_to_create.push_back(std::move(web_app));
    }
  }

  database_->Write(
      update_data, std::move(metadata_change_list),
      base::BindOnce(&WebAppMigrationManager::OnWebAppRegistryWritten,
                     weak_ptr_factory_.GetWeakPtr()));
}

void WebAppMigrationManager::OnWebAppRegistryWritten(bool success) {
  if (!success)
    DLOG(ERROR) << "Web app registry commit failed.";

  ScheduleDestructDatabaseAndCallCallback(success);
}

void WebAppMigrationManager::ReportDatabaseError(
    const syncer::ModelError& error) {
  DLOG(ERROR) << "Web app database error. " << error.ToString();

  ScheduleDestructDatabaseAndCallCallback(/*success=*/false);
}

void WebAppMigrationManager::ScheduleDestructDatabaseAndCallCallback(
    bool success) {
  base::SequencedTaskRunnerHandle::Get()->PostTask(
      FROM_HERE,
      base::BindOnce(&WebAppMigrationManager::DestructDatabaseAndCallCallback,
                     weak_ptr_factory_.GetWeakPtr(), success));
}

void WebAppMigrationManager::DestructDatabaseAndCallCallback(bool success) {
  // Close the database.
  database_ = nullptr;

  if (migration_completed_callback_)
    std::move(migration_completed_callback_).Run(success);
}

}  // namespace web_app