[CrOS Settings] Add CrostiniStringsProvider

This CL migrates Crostini UI strings to a per-page provider and adds
TODOs for adding relevant search tags.

Bug: 1069849
Change-Id: Iaf4e84cb39b30386a3baf87c82b67c2d8055e4ee
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2164038
Reviewed-by: James Cook <jamescook@chromium.org>
Commit-Queue: Kyle Horimoto <khorimoto@chromium.org>
Cr-Commit-Position: refs/heads/master@{#762534}

chrome/browser/ui/BUILD.gn

@@ -2015,6 +2015,8 @@ jumbo_static_library("ui") {
       "webui/settings/chromeos/change_picture_handler.h",
       "webui/settings/chromeos/crostini_handler.cc",
       "webui/settings/chromeos/crostini_handler.h",
+      "webui/settings/chromeos/crostini_strings_provider.cc",
+      "webui/settings/chromeos/crostini_strings_provider.h",
       "webui/settings/chromeos/cups_printers_handler.cc",
       "webui/settings/chromeos/cups_printers_handler.h",
       "webui/settings/chromeos/date_time_handler.cc",

chrome/browser/ui/webui/settings/chromeos/crostini_strings_provider.cc

@@ -0,0 +1,342 @@
+// 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/ui/webui/settings/chromeos/crostini_strings_provider.h"
+
+#include "base/feature_list.h"
+#include "base/no_destructor.h"
+#include "base/strings/utf_string_conversions.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/browser/browser_process_platform_part.h"
+#include "chrome/browser/chromeos/crostini/crostini_features.h"
+#include "chrome/browser/chromeos/crostini/crostini_pref_names.h"
+#include "chrome/browser/chromeos/crostini/crostini_util.h"
+#include "chrome/browser/chromeos/policy/browser_policy_connector_chromeos.h"
+#include "chrome/browser/chromeos/profiles/profile_helper.h"
+#include "chrome/browser/policy/profile_policy_connector.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ui/webui/webui_util.h"
+#include "chrome/common/url_constants.h"
+#include "chrome/grit/generated_resources.h"
+#include "chromeos/constants/chromeos_features.h"
+#include "components/arc/arc_prefs.h"
+#include "components/prefs/pref_service.h"
+#include "content/public/browser/web_ui_data_source.h"
+#include "ui/base/l10n/l10n_util.h"
+#include "ui/base/webui/web_ui_util.h"
+#include "ui/chromeos/devicetype_utils.h"
+
+namespace chromeos {
+namespace settings {
+namespace {
+
+const std::vector<SearchConcept>& GetCrostiniSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniExportImportSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini export/import" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniAdbSideloadingSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini ADB sideloading" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniPortForwardingSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini port forwarding" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniContainerUpgradeSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini container upgrade" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniDiskResizingSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini disk resizing" search concepts.
+  });
+  return *tags;
+}
+
+const std::vector<SearchConcept>& GetCrostiniMicSearchConcepts() {
+  static const base::NoDestructor<std::vector<SearchConcept>> tags({
+      // TODO(khorimoto): Add "Crostini mic" search concepts.
+  });
+  return *tags;
+}
+
+bool IsProfileManaged(Profile* profile) {
+  return profile->GetProfilePolicyConnector()->IsManaged();
+}
+
+bool IsDeviceManaged() {
+  policy::BrowserPolicyConnectorChromeOS* connector =
+      g_browser_process->platform_part()->browser_policy_connector_chromeos();
+  return connector->IsEnterpriseManaged();
+}
+
+bool IsAdbSideloadingAllowed() {
+  return base::FeatureList::IsEnabled(features::kArcAdbSideloadingFeature);
+}
+
+bool IsPortForwardingAllowed() {
+  return base::FeatureList::IsEnabled(features::kCrostiniPortForwarding);
+}
+
+bool IsDiskResizingAllowed() {
+  return base::FeatureList::IsEnabled(features::kCrostiniDiskResizing);
+}
+
+bool IsMicSettingAllowed() {
+  return base::FeatureList::IsEnabled(features::kCrostiniShowMicSetting);
+}
+
+}  // namespace
+
+CrostiniStringsProvider::CrostiniStringsProvider(Profile* profile,
+                                                 Delegate* per_page_delegate,
+                                                 PrefService* pref_service)
+    : OsSettingsPerPageStringsProvider(profile, per_page_delegate),
+      pref_service_(pref_service) {
+  pref_change_registrar_.Init(pref_service_);
+  pref_change_registrar_.Add(
+      crostini::prefs::kUserCrostiniAllowedByPolicy,
+      base::BindRepeating(&CrostiniStringsProvider::UpdateSearchTags,
+                          base::Unretained(this)));
+  pref_change_registrar_.Add(
+      crostini::prefs::kUserCrostiniExportImportUIAllowedByPolicy,
+      base::BindRepeating(&CrostiniStringsProvider::UpdateSearchTags,
+                          base::Unretained(this)));
+  pref_change_registrar_.Add(
+      arc::prefs::kArcEnabled,
+      base::BindRepeating(&CrostiniStringsProvider::UpdateSearchTags,
+                          base::Unretained(this)));
+  UpdateSearchTags();
+}
+
+CrostiniStringsProvider::~CrostiniStringsProvider() = default;
+
+void CrostiniStringsProvider::AddUiStrings(
+    content::WebUIDataSource* html_source) {
+  static constexpr webui::LocalizedString kLocalizedStrings[] = {
+      {"crostiniPageTitle", IDS_SETTINGS_CROSTINI_TITLE},
+      {"crostiniPageLabel", IDS_SETTINGS_CROSTINI_LABEL},
+      {"crostiniEnable", IDS_SETTINGS_TURN_ON},
+      {"crostiniSharedPaths", IDS_SETTINGS_CROSTINI_SHARED_PATHS},
+      {"crostiniSharedPathsListHeading",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_LIST_HEADING},
+      {"crostiniSharedPathsInstructionsAdd",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_INSTRUCTIONS_ADD},
+      {"crostiniSharedPathsInstructionsRemove",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_INSTRUCTIONS_REMOVE},
+      {"crostiniSharedPathsRemoveSharing",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_REMOVE_SHARING},
+      {"crostiniSharedPathsRemoveFailureDialogMessage",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_REMOVE_FAILURE_DIALOG_MESSAGE},
+      {"crostiniSharedPathsRemoveFailureDialogTitle",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_REMOVE_FAILURE_DIALOG_TITLE},
+      {"crostiniSharedPathsRemoveFailureTryAgain",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_REMOVE_FAILURE_TRY_AGAIN},
+      {"crostiniSharedPathsListEmptyMessage",
+       IDS_SETTINGS_CROSTINI_SHARED_PATHS_LIST_EMPTY_MESSAGE},
+      {"crostiniExportImportTitle", IDS_SETTINGS_CROSTINI_EXPORT_IMPORT_TITLE},
+      {"crostiniExport", IDS_SETTINGS_CROSTINI_EXPORT},
+      {"crostiniExportLabel", IDS_SETTINGS_CROSTINI_EXPORT_LABEL},
+      {"crostiniImport", IDS_SETTINGS_CROSTINI_IMPORT},
+      {"crostiniImportLabel", IDS_SETTINGS_CROSTINI_IMPORT_LABEL},
+      {"crostiniImportConfirmationDialogTitle",
+       IDS_SETTINGS_CROSTINI_CONFIRM_IMPORT_DIALOG_WINDOW_TITLE},
+      {"crostiniImportConfirmationDialogMessage",
+       IDS_SETTINGS_CROSTINI_CONFIRM_IMPORT_DIALOG_WINDOW_MESSAGE},
+      {"crostiniImportConfirmationDialogConfirmationButton",
+       IDS_SETTINGS_CROSTINI_IMPORT},
+      {"crostiniRemoveButton", IDS_SETTINGS_CROSTINI_REMOVE_BUTTON},
+      {"crostiniSharedUsbDevicesLabel",
+       IDS_SETTINGS_CROSTINI_SHARED_USB_DEVICES_LABEL},
+      {"crostiniSharedUsbDevicesDescription",
+       IDS_SETTINGS_CROSTINI_SHARED_USB_DEVICES_DESCRIPTION},
+      {"crostiniSharedUsbDevicesExtraDescription",
+       IDS_SETTINGS_CROSTINI_SHARED_USB_DEVICES_EXTRA_DESCRIPTION},
+      {"crostiniSharedUsbDevicesListEmptyMessage",
+       IDS_SETTINGS_CROSTINI_SHARED_USB_DEVICES_LIST_EMPTY_MESSAGE},
+      {"crostiniArcAdbTitle", IDS_SETTINGS_CROSTINI_ARC_ADB_TITLE},
+      {"crostiniArcAdbDescription", IDS_SETTINGS_CROSTINI_ARC_ADB_DESCRIPTION},
+      {"crostiniArcAdbLabel", IDS_SETTINGS_CROSTINI_ARC_ADB_LABEL},
+      {"crostiniArcAdbRestartButton",
+       IDS_SETTINGS_CROSTINI_ARC_ADB_RESTART_BUTTON},
+      {"crostiniArcAdbConfirmationTitleEnable",
+       IDS_SETTINGS_CROSTINI_ARC_ADB_CONFIRMATION_TITLE_ENABLE},
+      {"crostiniArcAdbConfirmationTitleDisable",
+       IDS_SETTINGS_CROSTINI_ARC_ADB_CONFIRMATION_TITLE_DISABLE},
+      {"crostiniContainerUpgrade",
+       IDS_SETTINGS_CROSTINI_CONTAINER_UPGRADE_MESSAGE},
+      {"crostiniContainerUpgradeSubtext",
+       IDS_SETTINGS_CROSTINI_CONTAINER_UPGRADE_SUBTEXT},
+      {"crostiniContainerUpgradeButton",
+       IDS_SETTINGS_CROSTINI_CONTAINER_UPGRADE_BUTTON},
+      {"crostiniPortForwarding", IDS_SETTINGS_CROSTINI_PORT_FORWARDING},
+      {"crostiniPortForwardingDescription",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_DESCRIPTION},
+      {"crostiniPortForwardingNoPorts",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_NO_PORTS},
+      {"crostiniPortForwardingTableTitle",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_TABLE_TITLE},
+      {"crostiniPortForwardingListPortNumber",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_LIST_PORT_NUMBER},
+      {"crostiniPortForwardingListLabel",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_LIST_LABEL},
+      {"crostiniPortForwardingAddPortButton",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_ADD_PORT_BUTTON},
+      {"crostiniPortForwardingAddPortButtonDescription",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_ADD_PORT_BUTTON_DESCRIPTION},
+      {"crostiniPortForwardingAddPortDialogTitle",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_ADD_PORT_DIALOG_TITLE},
+      {"crostiniPortForwardingAddPortDialogLabel",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_ADD_PORT_DIALOG_LABEL},
+      {"crostiniPortForwardingTCP", IDS_SETTINGS_CROSTINI_PORT_FORWARDING_TCP},
+      {"crostiniPortForwardingUDP", IDS_SETTINGS_CROSTINI_PORT_FORWARDING_UDP},
+      {"crostiniPortForwardingAddError",
+       IDS_SETTINGS_CROSTINI_PORT_FORWARDING_ADD_ERROR},
+      {"crostiniDiskResizeTitle", IDS_SETTINGS_CROSTINI_DISK_RESIZE_TITLE},
+      {"crostiniDiskResizeShowButton",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_SHOW_BUTTON},
+      {"crostiniDiskResizeShowButtonAriaLabel",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_SHOW_BUTTON_ARIA_LABEL},
+      {"crostiniDiskResizeLabel", IDS_SETTINGS_CROSTINI_DISK_RESIZE_LABEL},
+      {"crostiniDiskResizeUnsupported",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_UNSUPPORTED},
+      {"crostiniDiskResizeLoading", IDS_SETTINGS_CROSTINI_DISK_RESIZE_LOADING},
+      {"crostiniDiskResizeError", IDS_SETTINGS_CROSTINI_DISK_RESIZE_ERROR},
+      {"crostiniDiskResizeErrorRetry",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_ERROR_RETRY},
+      {"crostiniDiskResizeCancel", IDS_SETTINGS_CROSTINI_DISK_RESIZE_CANCEL},
+      {"crostiniDiskResizeGoButton",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_GO_BUTTON},
+      {"crostiniDiskResizeInProgress",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_IN_PROGRESS},
+      {"crostiniDiskResizeResizingError",
+       IDS_SETTINGS_CROSTINI_DISK_RESIZE_RESIZING_ERROR},
+      {"crostiniDiskResizeDone", IDS_SETTINGS_CROSTINI_DISK_RESIZE_DONE},
+      {"crostiniMicTitle", IDS_SETTINGS_CROSTINI_MIC_TITLE},
+      {"crostiniMicDialogTitle", IDS_SETTINGS_CROSTINI_MIC_DIALOG_TITLE},
+      {"crostiniMicDialogLabel", IDS_SETTINGS_CROSTINI_MIC_DIALOG_LABEL},
+  };
+  AddLocalizedStringsBulk(html_source, kLocalizedStrings);
+
+  html_source->AddBoolean("showCrostini", IsCrostiniAllowed());
+  html_source->AddBoolean(
+      "allowCrostini",
+      crostini::CrostiniFeatures::Get()->IsUIAllowed(profile()));
+
+  html_source->AddString(
+      "crostiniSubtext",
+      l10n_util::GetStringFUTF16(
+          IDS_SETTINGS_CROSTINI_SUBTEXT, ui::GetChromeOSDeviceName(),
+          GetHelpUrlWithBoard(chrome::kLinuxAppsLearnMoreURL)));
+  html_source->AddString(
+      "crostiniArcAdbPowerwashRequiredSublabel",
+      l10n_util::GetStringFUTF16(
+          IDS_SETTINGS_CROSTINI_ARC_ADB_POWERWASH_REQUIRED_SUBLABEL,
+          base::ASCIIToUTF16(chrome::kArcAdbSideloadingLearnMoreURL)));
+  html_source->AddString("crostiniRemove", l10n_util::GetStringFUTF16(
+                                               IDS_SETTINGS_CROSTINI_REMOVE,
+                                               ui::GetChromeOSDeviceName()));
+  html_source->AddString(
+      "crostiniArcAdbConfirmationMessageEnable",
+      l10n_util::GetStringFUTF16(
+          IDS_SETTINGS_CROSTINI_ARC_ADB_CONFIRMATION_MESSAGE_ENABLE,
+          ui::GetChromeOSDeviceName()));
+  html_source->AddString(
+      "crostiniArcAdbConfirmationMessageDisable",
+      l10n_util::GetStringFUTF16(
+          IDS_SETTINGS_CROSTINI_ARC_ADB_CONFIRMATION_MESSAGE_DISABLE,
+          ui::GetChromeOSDeviceName()));
+  html_source->AddString(
+      "crostiniSharedPathsInstructionsLocate",
+      l10n_util::GetStringFUTF16(
+          IDS_SETTINGS_CROSTINI_SHARED_PATHS_INSTRUCTIONS_LOCATE,
+          base::ASCIIToUTF16(
+              crostini::ContainerChromeOSBaseDirectory().value())));
+  html_source->AddBoolean("showCrostiniExportImport", IsExportImportAllowed());
+  html_source->AddBoolean("arcAdbSideloadingSupported",
+                          IsAdbSideloadingAllowed());
+  html_source->AddBoolean("showCrostiniPortForwarding",
+                          IsPortForwardingAllowed());
+  html_source->AddBoolean("isOwnerProfile",
+                          chromeos::ProfileHelper::IsOwnerProfile(profile()));
+  html_source->AddBoolean("isEnterpriseManaged",
+                          IsDeviceManaged() || IsProfileManaged(profile()));
+  html_source->AddBoolean(
+      "canChangeAdbSideloading",
+      crostini::CrostiniFeatures::Get()->CanChangeAdbSideloading(profile()));
+  html_source->AddBoolean("showCrostiniContainerUpgrade",
+                          IsContainerUpgradeAllowed());
+  html_source->AddBoolean("showCrostiniDiskResize", IsDiskResizingAllowed());
+  html_source->AddBoolean("showCrostiniMic", IsMicSettingAllowed());
+}
+
+bool CrostiniStringsProvider::IsCrostiniAllowed() {
+  return crostini::CrostiniFeatures::Get()->IsUIAllowed(profile(),
+                                                        /*check_policy=*/false);
+}
+
+bool CrostiniStringsProvider::IsExportImportAllowed() {
+  return crostini::CrostiniFeatures::Get()->IsExportImportUIAllowed(profile());
+}
+
+bool CrostiniStringsProvider::IsContainerUpgradeAllowed() {
+  return crostini::ShouldAllowContainerUpgrade(profile());
+}
+
+void CrostiniStringsProvider::UpdateSearchTags() {
+  delegate()->RemoveSearchTags(GetCrostiniSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniExportImportSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniAdbSideloadingSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniPortForwardingSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniContainerUpgradeSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniDiskResizingSearchConcepts());
+  delegate()->RemoveSearchTags(GetCrostiniMicSearchConcepts());
+
+  if (!IsCrostiniAllowed())
+    return;
+
+  delegate()->AddSearchTags(GetCrostiniSearchConcepts());
+
+  if (IsExportImportAllowed())
+    delegate()->AddSearchTags(GetCrostiniExportImportSearchConcepts());
+
+  if (IsAdbSideloadingAllowed() &&
+      pref_service_->GetBoolean(arc::prefs::kArcEnabled)) {
+    delegate()->AddSearchTags(GetCrostiniAdbSideloadingSearchConcepts());
+  }
+
+  if (IsPortForwardingAllowed())
+    delegate()->AddSearchTags(GetCrostiniPortForwardingSearchConcepts());
+
+  if (IsContainerUpgradeAllowed())
+    delegate()->AddSearchTags(GetCrostiniContainerUpgradeSearchConcepts());
+
+  if (IsDiskResizingAllowed())
+    delegate()->AddSearchTags(GetCrostiniDiskResizingSearchConcepts());
+
+  if (IsMicSettingAllowed())
+    delegate()->AddSearchTags(GetCrostiniMicSearchConcepts());
+}
+
+}  // namespace settings
+}  // namespace chromeos

chrome/browser/ui/webui/settings/chromeos/crostini_strings_provider.h

@@ -0,0 +1,44 @@
+// 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.
+
+#ifndef CHROME_BROWSER_UI_WEBUI_SETTINGS_CHROMEOS_CROSTINI_STRINGS_PROVIDER_H_
+#define CHROME_BROWSER_UI_WEBUI_SETTINGS_CHROMEOS_CROSTINI_STRINGS_PROVIDER_H_
+
+#include "chrome/browser/ui/webui/settings/chromeos/os_settings_per_page_strings_provider.h"
+#include "components/prefs/pref_change_registrar.h"
+
+namespace content {
+class WebUIDataSource;
+}  // namespace content
+
+namespace chromeos {
+namespace settings {
+
+// Provides UI strings and search tags for Crostini settings. Search tags are
+// only added if Crostini is available, and subpage search tags are added only
+// when those subpages are available.
+class CrostiniStringsProvider : public OsSettingsPerPageStringsProvider {
+ public:
+  CrostiniStringsProvider(Profile* profile,
+                          Delegate* per_page_delegate,
+                          PrefService* pref_service);
+  ~CrostiniStringsProvider() override;
+
+ private:
+  // OsSettingsPerPageStringsProvider:
+  void AddUiStrings(content::WebUIDataSource* html_source) override;
+
+  bool IsCrostiniAllowed();
+  bool IsExportImportAllowed();
+  bool IsContainerUpgradeAllowed();
+  void UpdateSearchTags();
+
+  PrefService* pref_service_;
+  PrefChangeRegistrar pref_change_registrar_;
+};
+
+}  // namespace settings
+}  // namespace chromeos
+
+#endif  // CHROME_BROWSER_UI_WEBUI_SETTINGS_CHROMEOS_CROSTINI_STRINGS_PROVIDER_H_