blob: 839b45fedec6475e0b14ce4a1abaa4e4e8400037 [file] [log] [blame]
// 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.
#include "chrome/browser/web_applications/components/web_app_install_utils.h"
#include <utility>
#include "base/metrics/histogram_functions.h"
#include "base/stl_util.h"
#include "base/time/time.h"
#include "chrome/browser/banners/app_banner_manager.h"
#include "chrome/browser/banners/app_banner_manager_desktop.h"
#include "chrome/browser/banners/app_banner_settings_helper.h"
#include "chrome/browser/installable/installable_data.h"
#include "chrome/browser/installable/installable_metrics.h"
#include "chrome/browser/web_applications/components/web_app_constants.h"
#include "chrome/browser/web_applications/components/web_app_icon_generator.h"
#include "chrome/common/web_application_info.h"
#include "third_party/blink/public/common/manifest/manifest.h"
#include "third_party/skia/include/core/SkBitmap.h"
namespace web_app {
namespace {
constexpr int kMaxIcons = 20;
constexpr int kMaxIconSize = 1024;
// Get a list of non-empty square icons from |icons_map|.
void FilterSquareIconsFromMap(const IconsMap& icons_map,
std::vector<BitmapAndSource>* square_icons) {
for (const std::pair<GURL, std::vector<SkBitmap>>& url_icon : icons_map) {
for (const SkBitmap& icon : url_icon.second) {
if (!icon.empty() && icon.width() == icon.height())
square_icons->push_back(BitmapAndSource(url_icon.first, icon));
}
}
}
// Get all non-empty square icons from |icons_map|.
void FilterSquareIconsFromBitmaps(
const std::map<SquareSizePx, SkBitmap> bitmaps,
std::vector<BitmapAndSource>* square_icons) {
for (const std::pair<SquareSizePx, SkBitmap>& icon : bitmaps) {
DCHECK_EQ(icon.first, icon.second.width());
DCHECK_EQ(icon.first, icon.second.height());
if (!icon.second.empty())
square_icons->push_back(BitmapAndSource(GURL(), icon.second));
}
}
} // namespace
void UpdateWebAppInfoFromManifest(const blink::Manifest& manifest,
WebApplicationInfo* web_app_info,
ForInstallableSite for_installable_site) {
if (!manifest.short_name.is_null())
web_app_info->title = manifest.short_name.string();
// Give the full length name priority.
if (!manifest.name.is_null())
web_app_info->title = manifest.name.string();
// Set the url based on the manifest value, if any.
if (manifest.start_url.is_valid())
web_app_info->app_url = manifest.start_url;
if (for_installable_site == ForInstallableSite::kYes)
web_app_info->scope = manifest.scope;
if (manifest.theme_color)
web_app_info->theme_color = *manifest.theme_color;
// When the display member is missing, or if there is no valid display member,
// the user agent uses the browser display mode as the default display mode.
// https://w3c.github.io/manifest/#display-modes
web_app_info->display_mode = (manifest.display == DisplayMode::kUndefined)
? DisplayMode::kBrowser
: manifest.display;
// Create the WebApplicationInfo icons list *outside* of |web_app_info|, so
// that we can decide later whether or not to replace the existing icons array
// (conditionally on whether there were any that didn't have purpose ANY).
std::vector<WebApplicationIconInfo> web_app_icons;
for (const auto& icon : manifest.icons) {
// An icon's purpose vector should never be empty (the manifest parser
// should have added ANY if there was no purpose specified in the manifest).
DCHECK(!icon.purpose.empty());
if (!base::Contains(icon.purpose,
blink::Manifest::ImageResource::Purpose::ANY)) {
continue;
}
WebApplicationIconInfo info;
if (!icon.sizes.empty()) {
// Filter out non-square or too large icons.
auto valid_size = std::find_if(icon.sizes.begin(), icon.sizes.end(),
[](const gfx::Size& size) {
return size.width() == size.height() &&
size.width() <= kMaxIconSize;
});
if (valid_size == icon.sizes.end())
continue;
// TODO(benwells): Take the declared icon density and sizes into account.
info.square_size_px = valid_size->width();
}
info.url = icon.src;
web_app_icons.push_back(std::move(info));
// Limit the number of icons we store on the user's machine.
if (web_app_icons.size() == kMaxIcons)
break;
}
// If any icons are specified in the manifest, they take precedence over any
// we picked up from the web_app stuff.
if (!web_app_icons.empty())
web_app_info->icon_infos = std::move(web_app_icons);
web_app_info->file_handlers = manifest.file_handlers;
}
std::vector<GURL> GetValidIconUrlsToDownload(
const WebApplicationInfo& web_app_info) {
std::vector<GURL> web_app_info_icon_urls;
for (const WebApplicationIconInfo& info : web_app_info.icon_infos) {
if (!info.url.is_valid())
continue;
web_app_info_icon_urls.push_back(info.url);
}
return web_app_info_icon_urls;
}
void FilterAndResizeIconsGenerateMissing(WebApplicationInfo* web_app_info,
const IconsMap* icons_map,
bool is_for_sync) {
// Ensure that all icons that are in web_app_info are present, by generating
// icons for any sizes which have failed to download. This ensures that the
// created manifest for the web app does not contain links to icons
// which are not actually created and linked on disk.
std::vector<BitmapAndSource> square_icons;
if (icons_map)
FilterSquareIconsFromMap(*icons_map, &square_icons);
if (!is_for_sync)
FilterSquareIconsFromBitmaps(web_app_info->icon_bitmaps, &square_icons);
std::set<int> sizes_to_generate = SizesToGenerate();
if (is_for_sync) {
// Ensure that all icon widths in the web app info icon array are present in
// the sizes to generate set. This ensures that we will have all of the
// icon sizes from when the app was originally added, even if icon URLs are
// no longer accessible.
for (const auto& icon : web_app_info->icon_infos)
sizes_to_generate.insert(icon.square_size_px);
}
web_app_info->generated_icon_color = SK_ColorTRANSPARENT;
// TODO(https://crbug.com/1029223): Don't resize before writing to disk, it's
// not necessary and would simplify this code path to remove.
std::map<int, BitmapAndSource> size_to_icon = ResizeIconsAndGenerateMissing(
square_icons, sizes_to_generate, web_app_info->app_url,
&web_app_info->generated_icon_color);
for (std::pair<const int, BitmapAndSource>& item : size_to_icon) {
// Retain any bitmaps provided as input to the installation.
if (web_app_info->icon_bitmaps.count(item.first) == 0) {
web_app_info->icon_bitmaps[item.first] = std::move(item.second.bitmap);
}
}
}
void RecordAppBanner(content::WebContents* contents, const GURL& app_url) {
AppBannerSettingsHelper::RecordBannerEvent(
contents, app_url, app_url.spec(),
AppBannerSettingsHelper::APP_BANNER_EVENT_DID_ADD_TO_HOMESCREEN,
base::Time::Now());
}
WebappInstallSource ConvertExternalInstallSourceToInstallSource(
ExternalInstallSource external_install_source) {
WebappInstallSource install_source;
switch (external_install_source) {
case ExternalInstallSource::kInternalDefault:
install_source = WebappInstallSource::INTERNAL_DEFAULT;
break;
case ExternalInstallSource::kExternalDefault:
install_source = WebappInstallSource::EXTERNAL_DEFAULT;
break;
case ExternalInstallSource::kExternalPolicy:
install_source = WebappInstallSource::EXTERNAL_POLICY;
break;
case ExternalInstallSource::kSystemInstalled:
install_source = WebappInstallSource::SYSTEM_DEFAULT;
break;
case ExternalInstallSource::kArc:
install_source = WebappInstallSource::ARC;
break;
}
return install_source;
}
void RecordExternalAppInstallResultCode(
const char* histogram_name,
std::map<GURL, InstallResultCode> install_results) {
for (const auto& url_and_result : install_results)
base::UmaHistogramEnumeration(histogram_name, url_and_result.second);
}
} // namespace web_app