1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
|
// Copyright 2023 The Chromium Authors
// 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/web_app_internals/web_app_internals_handler.h"
#include <algorithm>
#include <string>
#include <vector>
#include "base/containers/to_value_list.h"
#include "base/containers/to_vector.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_util.h"
#include "base/functional/callback_helpers.h"
#include "base/functional/overloaded.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/strings/to_string.h"
#include "base/task/thread_pool.h"
#include "base/types/expected_macros.h"
#include "base/values.h"
#include "build/build_config.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/web_applications/isolated_web_apps/isolated_web_app_update_manager.h"
#include "chrome/browser/web_applications/isolated_web_apps/policy/isolated_web_app_policy_manager.h"
#include "chrome/browser/web_applications/navigation_capturing_log.h"
#include "chrome/browser/web_applications/preinstalled_web_app_manager.h"
#include "chrome/browser/web_applications/web_app.h"
#include "chrome/browser/web_applications/web_app_command_manager.h"
#include "chrome/browser/web_applications/web_app_icon_manager.h"
#include "chrome/browser/web_applications/web_app_install_manager.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/browser/web_applications/web_app_registrar.h"
#include "chrome/browser/web_applications/web_app_utils.h"
#include "chrome/common/pref_names.h"
#include "components/prefs/pref_service.h"
#include "components/webapps/isolated_web_apps/iwa_key_distribution_info_provider.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_ui.h"
#if BUILDFLAG(IS_MAC)
#include "chrome/browser/web_applications/os_integration/mac/app_shim_registry.h"
#endif
namespace {
// New fields must be added to BuildIndexJson().
constexpr char kInstalledWebApps[] = "InstalledWebApps";
constexpr char kPreinstalledWebAppConfigs[] = "PreinstalledWebAppConfigs";
constexpr char kUserUninstalledPreinstalledWebAppPrefs[] =
"UserUninstalledPreinstalledWebAppPrefs";
constexpr char kWebAppPreferences[] = "WebAppPreferences";
constexpr char kWebAppIphPreferences[] = "WebAppIphPreferences";
constexpr char kWebAppMlPreferences[] = "WebAppMlPreferences";
constexpr char kWebAppIphLcPreferences[] = "WebAppIPHLinkCapturingPreferences";
constexpr char kShouldGarbageCollectStoragePartitions[] =
"ShouldGarbageCollectStoragePartitions";
constexpr char kLockManager[] = "LockManager";
constexpr char kCommandManager[] = "CommandManager";
constexpr char kIconErrorLog[] = "IconErrorLog";
constexpr char kInstallationProcessErrorLog[] = "InstallationProcessErrorLog";
#if BUILDFLAG(IS_MAC)
constexpr char kAppShimRegistryLocalStorage[] = "AppShimRegistryLocalStorage";
#endif
constexpr char kWebAppDirectoryDiskState[] = "WebAppDirectoryDiskState";
constexpr char kIsolatedWebAppUpdateManager[] = "IsolatedWebAppUpdateManager";
constexpr char kIsolatedWebAppPolicyManager[] = "IsolatedWebAppPolicyManager";
constexpr char kIwaKeyDistributionInfoProvider[] =
"IwaKeyDistributionInfoProvider";
constexpr char kNavigationCapturing[] = "NavigationCapturing";
constexpr char kNeedsRecordWebAppDebugInfo[] =
"No debugging info available! Please enable: "
"chrome://flags/#record-web-app-debug-info";
base::Value::Dict BuildIndexJson() {
return base::Value::Dict().Set(
"Index", base::Value::List()
.Append(kInstalledWebApps)
.Append(kPreinstalledWebAppConfigs)
.Append(kUserUninstalledPreinstalledWebAppPrefs)
.Append(kWebAppPreferences)
.Append(kWebAppIphPreferences)
.Append(kWebAppMlPreferences)
.Append(kWebAppIphLcPreferences)
.Append(kShouldGarbageCollectStoragePartitions)
.Append(kLockManager)
.Append(kNavigationCapturing)
.Append(kCommandManager)
.Append(kIconErrorLog)
.Append(kInstallationProcessErrorLog)
#if BUILDFLAG(IS_MAC)
.Append(kAppShimRegistryLocalStorage)
#endif
.Append(kIsolatedWebAppUpdateManager)
.Append(kIsolatedWebAppPolicyManager)
.Append(kWebAppDirectoryDiskState));
}
base::Value::Dict BuildInstalledWebAppsJson(web_app::WebAppProvider& provider) {
return base::Value::Dict().Set(kInstalledWebApps,
provider.registrar_unsafe().AsDebugValue());
}
base::Value::Dict BuildPreinstalledWebAppConfigsJson(
web_app::WebAppProvider& provider) {
base::Value::Dict root;
const web_app::PreinstalledWebAppManager::DebugInfo* debug_info =
provider.preinstalled_web_app_manager().debug_info();
if (!debug_info) {
root.Set(kPreinstalledWebAppConfigs, kNeedsRecordWebAppDebugInfo);
return root;
}
auto config_to_dict = [](const auto& config) {
return base::Value::Dict()
.Set("!Reason", config.second)
.Set("Config", config.first.AsDebugValue());
};
root.Set(
kPreinstalledWebAppConfigs,
base::Value::Dict()
.Set("ConfigParseErrors", base::ToValueList(debug_info->parse_errors))
.Set("UninstallConfigs",
base::ToValueList(debug_info->uninstall_configs, config_to_dict))
.Set("InstallConfigs",
base::ToValueList(debug_info->install_configs, config_to_dict))
.Set("IgnoreConfigs",
base::ToValueList(debug_info->ignore_configs, config_to_dict))
.Set("InstallResults",
base::ToValueList(
debug_info->install_results,
[](const auto& install_result) {
return base::Value::Dict()
.Set("InstallUrl", install_result.first.spec())
.Set("ResultCode",
base::ToString(install_result.second.code))
.Set("DidUninstallAndReplace",
install_result.second.did_uninstall_and_replace);
}))
.Set("IsStartUpTaskComplete", debug_info->is_start_up_task_complete)
.Set("UninstallResults",
base::ToValueList(
debug_info->uninstall_results,
[](const auto& uninstall_result) {
return base::Value::Dict()
.Set("InstallUrl", uninstall_result.first.spec())
.Set("Success",
base::ToString(uninstall_result.second));
})));
return root;
}
base::Value::Dict BuildUserUninstalledPreinstalledWebAppPrefsJson(
Profile* profile) {
return base::Value::Dict().Set(
kUserUninstalledPreinstalledWebAppPrefs,
profile->GetPrefs()
->GetDict(prefs::kUserUninstalledPreinstalledWebAppPref)
.Clone());
}
base::Value::Dict BuildWebAppsPrefsJson(Profile* profile) {
return base::Value::Dict().Set(
kWebAppPreferences,
profile->GetPrefs()->GetDict(prefs::kWebAppsPreferences).Clone());
}
base::Value::Dict BuildWebAppIphPrefsJson(Profile* profile) {
return base::Value::Dict().Set(
kWebAppIphPreferences,
profile->GetPrefs()->GetDict(prefs::kWebAppsAppAgnosticIphState).Clone());
}
base::Value::Dict BuildWebAppMlPrefsJson(Profile* profile) {
return base::Value::Dict().Set(
kWebAppMlPreferences,
profile->GetPrefs()->GetDict(prefs::kWebAppsAppAgnosticMlState).Clone());
}
base::Value::Dict BuildWebAppLinkCapturingIphPrefsJson(Profile* profile) {
return base::Value::Dict().Set(
kWebAppIphLcPreferences,
profile->GetPrefs()
->GetDict(prefs::kWebAppsAppAgnosticIPHLinkCapturingState)
.Clone());
}
base::Value::Dict BuildShouldGarbageCollectStoragePartitionsPrefsJson(
Profile* profile) {
return base::Value::Dict().Set(
kShouldGarbageCollectStoragePartitions,
profile->GetPrefs()->GetBoolean(
prefs::kShouldGarbageCollectStoragePartitions));
}
base::Value::Dict BuildLockManagerJson(web_app::WebAppProvider& provider) {
return base::Value::Dict().Set(
kLockManager, provider.command_manager().lock_manager().ToDebugValue());
}
base::Value::Dict BuildCommandManagerJson(web_app::WebAppProvider& provider) {
return base::Value::Dict().Set(kCommandManager,
provider.command_manager().ToDebugValue());
}
base::Value::Dict BuildIconErrorLogJson(web_app::WebAppProvider& provider) {
base::Value::Dict root;
const std::vector<std::string>* error_log =
provider.icon_manager().error_log();
if (!error_log) {
root.Set(kIconErrorLog, kNeedsRecordWebAppDebugInfo);
return root;
}
root.Set(kIconErrorLog, base::ToValueList(*error_log));
return root;
}
base::Value::Dict BuildInstallProcessErrorLogJson(
web_app::WebAppProvider& provider) {
base::Value::Dict root;
const web_app::WebAppInstallManager::ErrorLog* error_log =
provider.install_manager().error_log();
if (!error_log) {
root.Set(kInstallationProcessErrorLog, kNeedsRecordWebAppDebugInfo);
return root;
}
root.Set(kInstallationProcessErrorLog,
base::ToValueList(*error_log, &base::Value::Clone));
return root;
}
#if BUILDFLAG(IS_MAC)
base::Value::Dict BuildAppShimRegistryLocalStorageJson() {
return base::Value::Dict().Set(kAppShimRegistryLocalStorage,
AppShimRegistry::Get()->AsDebugDict().Clone());
}
#endif
base::Value BuildIsolatedWebAppUpdaterManagerJson(
web_app::WebAppProvider& provider) {
return base::Value(
base::Value::Dict().Set(kIsolatedWebAppUpdateManager,
provider.iwa_update_manager().AsDebugValue()));
}
base::Value BuildIsolatedWebAppPolicyManagerJson(
web_app::WebAppProvider& provider) {
return base::Value(
base::Value::Dict().Set(kIsolatedWebAppPolicyManager,
provider.iwa_policy_manager().GetDebugValue()));
}
base::Value BuildIwaKeyDistributionInfoProviderJson() {
return base::Value(base::Value::Dict().Set(
kIwaKeyDistributionInfoProvider,
web_app::IwaKeyDistributionInfoProvider::GetInstance()->AsDebugValue()));
}
void BuildDirectoryState(base::FilePath file_or_folder,
base::Value::Dict* folder) {
base::File::Info info;
bool success = base::GetFileInfo(file_or_folder, &info);
if (!success) {
folder->Set(file_or_folder.AsUTF8Unsafe(), "Invalid file or folder");
return;
}
// The path of files is fully printed to allow easy copy-paste for developer
// reference.
if (!info.is_directory) {
folder->Set(file_or_folder.AsUTF8Unsafe(),
base::StrCat({base::NumberToString(info.size), " bytes"}));
return;
}
base::Value::Dict contents;
base::FileEnumerator files(
file_or_folder, false,
base::FileEnumerator::FILES | base::FileEnumerator::DIRECTORIES);
for (base::FilePath current = files.Next(); !current.empty();
current = files.Next()) {
BuildDirectoryState(current, &contents);
}
folder->Set(file_or_folder.BaseName().AsUTF8Unsafe(), std::move(contents));
}
base::Value BuildWebAppDiskStateJson(base::FilePath root_directory,
base::Value::List root) {
base::Value::Dict contents;
BuildDirectoryState(root_directory, &contents);
root.Append(
base::Value::Dict().Set(kWebAppDirectoryDiskState, std::move(contents)));
return base::Value(std::move(root));
}
base::Value::Dict BuildNavigationCapturingLog(
web_app::WebAppProvider& provider) {
return base::Value::Dict().Set(kNavigationCapturing,
provider.navigation_capturing_log().GetLog());
}
} // namespace
// static
void WebAppInternalsHandler::BuildDebugInfo(
Profile* profile,
base::OnceCallback<void(base::Value root)> callback) {
auto* provider = web_app::WebAppProvider::GetForLocalAppsUnchecked(profile);
base::Value::List root =
base::Value::List()
.Append(BuildIndexJson())
.Append(BuildInstalledWebAppsJson(*provider))
.Append(BuildPreinstalledWebAppConfigsJson(*provider))
.Append(BuildUserUninstalledPreinstalledWebAppPrefsJson(profile))
.Append(BuildWebAppsPrefsJson(profile))
.Append(BuildWebAppIphPrefsJson(profile))
.Append(BuildWebAppMlPrefsJson(profile))
.Append(BuildWebAppLinkCapturingIphPrefsJson(profile))
.Append(BuildShouldGarbageCollectStoragePartitionsPrefsJson(profile))
.Append(BuildLockManagerJson(*provider))
.Append(BuildNavigationCapturingLog(*provider))
.Append(BuildCommandManagerJson(*provider))
.Append(BuildIconErrorLogJson(*provider))
.Append(BuildInstallProcessErrorLogJson(*provider))
#if BUILDFLAG(IS_MAC)
.Append(BuildAppShimRegistryLocalStorageJson())
#endif
.Append(BuildIsolatedWebAppUpdaterManagerJson(*provider))
.Append(BuildIsolatedWebAppPolicyManagerJson(*provider))
.Append(BuildIwaKeyDistributionInfoProviderJson());
base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::TaskPriority::USER_VISIBLE, base::MayBlock()},
base::BindOnce(&BuildWebAppDiskStateJson,
web_app::GetWebAppsRootDirectory(profile),
std::move(root)),
std::move(callback));
}
WebAppInternalsHandler::WebAppInternalsHandler(
content::WebUI* web_ui,
mojo::PendingReceiver<mojom::WebAppInternalsHandler> receiver)
: web_ui_(raw_ref<content::WebUI>::from_ptr(web_ui)),
profile_(raw_ref<Profile>::from_ptr(Profile::FromBrowserContext(
web_ui_->GetWebContents()->GetBrowserContext()))),
receiver_(this, std::move(receiver)),
iwa_handler_(*web_ui_, *profile_) {}
WebAppInternalsHandler::~WebAppInternalsHandler() = default;
void WebAppInternalsHandler::GetDebugInfoAsJsonString(
GetDebugInfoAsJsonStringCallback callback) {
auto* provider =
web_app::WebAppProvider::GetForLocalAppsUnchecked(&profile_.get());
if (!provider) {
return std::move(callback).Run("Web app system not enabled for profile.");
}
auto value_to_string =
base::BindOnce([](base::Value value) { return value.DebugString(); });
provider->on_registry_ready().Post(
FROM_HERE,
base::BindOnce(&WebAppInternalsHandler::BuildDebugInfo, &profile_.get(),
std::move(value_to_string).Then(std::move(callback))));
}
void WebAppInternalsHandler::InstallIsolatedWebAppFromDevProxy(
const GURL& url,
InstallIsolatedWebAppFromDevProxyCallback callback) {
iwa_handler_.InstallIsolatedWebAppFromDevProxy(url, std::move(callback));
}
void WebAppInternalsHandler::ParseUpdateManifestFromUrl(
const GURL& update_manifest_url,
ParseUpdateManifestFromUrlCallback callback) {
iwa_handler_.ParseUpdateManifestFromUrl(update_manifest_url,
std::move(callback));
}
void WebAppInternalsHandler::InstallIsolatedWebAppFromBundleUrl(
mojom::InstallFromBundleUrlParamsPtr params,
InstallIsolatedWebAppFromBundleUrlCallback callback) {
iwa_handler_.InstallIsolatedWebAppFromBundleUrl(std::move(params),
std::move(callback));
}
void WebAppInternalsHandler::SelectFileAndInstallIsolatedWebAppFromDevBundle(
SelectFileAndInstallIsolatedWebAppFromDevBundleCallback callback) {
iwa_handler_.SelectFileAndInstallIsolatedWebAppFromDevBundle(
std::move(callback));
}
void WebAppInternalsHandler::SelectFileAndUpdateIsolatedWebAppFromDevBundle(
const webapps::AppId& app_id,
SelectFileAndUpdateIsolatedWebAppFromDevBundleCallback callback) {
iwa_handler_.SelectFileAndUpdateIsolatedWebAppFromDevBundle(
app_id, std::move(callback));
}
void WebAppInternalsHandler::SearchForIsolatedWebAppUpdates(
SearchForIsolatedWebAppUpdatesCallback callback) {
iwa_handler_.SearchForIsolatedWebAppUpdates(std::move(callback));
}
void WebAppInternalsHandler::GetIsolatedWebAppDevModeAppInfo(
GetIsolatedWebAppDevModeAppInfoCallback callback) {
iwa_handler_.GetIsolatedWebAppDevModeAppInfo(std::move(callback));
}
void WebAppInternalsHandler::UpdateDevProxyIsolatedWebApp(
const webapps::AppId& app_id,
UpdateDevProxyIsolatedWebAppCallback callback) {
iwa_handler_.UpdateDevProxyIsolatedWebApp(app_id, std::move(callback));
}
void WebAppInternalsHandler::RotateKey(
const std::string& web_bundle_id,
const std::optional<std::vector<uint8_t>>& public_key) {
iwa_handler_.RotateKey(web_bundle_id, public_key);
}
void WebAppInternalsHandler::UpdateManifestInstalledIsolatedWebApp(
const webapps::AppId& app_id,
UpdateManifestInstalledIsolatedWebAppCallback callback) {
iwa_handler_.UpdateManifestInstalledIsolatedWebApp(app_id,
std::move(callback));
}
void WebAppInternalsHandler::SetUpdateChannelForIsolatedWebApp(
const webapps::AppId& app_id,
const std::string& update_channel,
SetUpdateChannelForIsolatedWebAppCallback callback) {
iwa_handler_.SetUpdateChannelForIsolatedWebApp(app_id, update_channel,
std::move(callback));
}
void WebAppInternalsHandler::SetPinnedVersionForIsolatedWebApp(
const webapps::AppId& app_id,
const std::string& pinned_version,
SetPinnedVersionForIsolatedWebAppCallback callback) {
iwa_handler_.SetPinnedVersionForIsolatedWebApp(app_id, pinned_version,
std::move(callback));
}
void WebAppInternalsHandler::ResetPinnedVersionForIsolatedWebApp(
const webapps::AppId& app_id) {
iwa_handler_.ResetPinnedVersionForIsolatedWebApp(app_id);
}
void WebAppInternalsHandler::SetAllowDowngradesForIsolatedWebApp(
bool allow_downgrades,
const webapps::AppId& app_id) {
iwa_handler_.SetAllowDowngradesForIsolatedWebApp(allow_downgrades, app_id);
}
|