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
|
// 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/web_applications/jobs/install_placeholder_job.h"
#include <memory>
#include <utility>
#include "base/strings/utf_string_conversions.h"
#include "base/task/sequenced_task_runner.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/web_applications/external_install_options.h"
#include "chrome/browser/web_applications/externally_managed_app_manager.h"
#include "chrome/browser/web_applications/install_bounce_metric.h"
#include "chrome/browser/web_applications/locks/shared_web_contents_with_app_lock.h"
#include "chrome/browser/web_applications/web_app_helpers.h"
#include "chrome/browser/web_applications/web_app_install_finalizer.h"
#include "chrome/browser/web_applications/web_app_install_utils.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/browser/web_applications/web_contents/web_app_data_retriever.h"
#include "chrome/browser/web_applications/web_contents/web_contents_manager.h"
#include "components/webapps/browser/install_result_code.h"
#include "components/webapps/browser/web_contents/web_app_url_loader.h"
#include "components/webapps/common/web_app_id.h"
#include "content/public/browser/web_contents.h"
#include "ui/gfx/geometry/size.h"
class Profile;
namespace content {
class WebContents;
}
namespace web_app {
namespace {
// How often we retry to download a custom icon, not counting the first attempt.
const int MAX_ICON_DOWNLOAD_RETRIES = 1;
const base::TimeDelta ICON_DOWNLOAD_RETRY_DELAY = base::Seconds(5);
} // namespace
InstallPlaceholderJob::InstallPlaceholderJob(
Profile* profile,
base::Value::Dict& debug_value,
const ExternalInstallOptions& install_options,
InstallAndReplaceCallback callback,
SharedWebContentsWithAppLock& lock)
: profile_(*profile),
debug_value_(debug_value),
// For placeholder installs, the install_url is treated as the start_url.
app_id_(GenerateAppId(/*manifest_id_path=*/std::nullopt,
install_options.install_url)),
lock_(lock),
install_options_(install_options),
callback_(std::move(callback)),
web_contents_(&lock_->shared_web_contents()),
data_retriever_(WebAppProvider::GetForWebApps(&profile_.get())
->web_contents_manager()
.CreateDataRetriever()) {
debug_value_->Set("external_install_options", install_options.AsDebugValue());
debug_value_->Set("app_id", app_id_);
}
InstallPlaceholderJob::~InstallPlaceholderJob() = default;
void InstallPlaceholderJob::Start() {
url_loader_ = lock_->web_contents_manager().CreateUrlLoader();
url_loader_->LoadUrl(install_options_.install_url, web_contents_,
webapps::WebAppUrlLoader::UrlComparison::kSameOrigin,
base::BindOnce(&InstallPlaceholderJob::OnUrlLoaded,
weak_factory_.GetWeakPtr()));
}
void InstallPlaceholderJob::SetDataRetrieverForTesting(
std::unique_ptr<WebAppDataRetriever> data_retriever) {
data_retriever_ = std::move(data_retriever);
}
void InstallPlaceholderJob::Abort(webapps::InstallResultCode code) {
debug_value_->Set("result_code", base::ToString(code));
if (!callback_) {
return;
}
webapps::InstallableMetrics::TrackInstallResult(
false, ConvertExternalInstallSourceToInstallSource(
install_options_.install_source));
std::move(callback_).Run(code, std::move(app_id_));
}
void InstallPlaceholderJob::OnUrlLoaded(
webapps::WebAppUrlLoaderResult load_url_result) {
CHECK(web_contents_ && !web_contents_->IsBeingDestroyed());
if (install_options_.override_icon_url) {
FetchCustomIcon(install_options_.override_icon_url.value(),
MAX_ICON_DOWNLOAD_RETRIES);
return;
}
FinalizeInstall(/*bitmaps=*/std::nullopt);
}
void InstallPlaceholderJob::FetchCustomIcon(const GURL& url, int retries_left) {
CHECK(web_contents_ && !web_contents_->IsBeingDestroyed());
data_retriever_->GetIcons(
web_contents_.get(), {IconUrlWithSize::CreateForUnspecifiedSize(url)},
/*skip_page_favicons=*/true,
/*fail_all_if_any_fail=*/false,
base::BindOnce(&InstallPlaceholderJob::OnCustomIconFetched,
weak_factory_.GetWeakPtr(), url, retries_left));
}
void InstallPlaceholderJob::OnCustomIconFetched(
const GURL& image_url,
int retries_left,
IconsDownloadedResult result,
IconsMap icons_map,
DownloadedIconsHttpResults icons_http_results) {
auto bitmaps_it = icons_map.find(image_url);
if (bitmaps_it != icons_map.end() && !bitmaps_it->second.empty()) {
// Download succeeded.
debug_value_->Set("custom_icon_download_success", true);
FinalizeInstall(bitmaps_it->second);
return;
}
if (retries_left <= 0) {
// Download failed.
debug_value_->Set("custom_icon_download_success", false);
FinalizeInstall(std::nullopt);
return;
}
// Retry download.
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&InstallPlaceholderJob::FetchCustomIcon,
weak_factory_.GetWeakPtr(), image_url, retries_left - 1),
ICON_DOWNLOAD_RETRY_DELAY);
}
void InstallPlaceholderJob::FinalizeInstall(
std::optional<std::reference_wrapper<const std::vector<SkBitmap>>>
bitmaps) {
// For placeholder installs, the install_url is treated as the start_url.
GURL start_url = install_options_.install_url;
webapps::ManifestId manifest_id =
GenerateManifestIdFromStartUrlOnly(start_url);
auto web_app_info =
std::make_unique<WebAppInstallInfo>(manifest_id, start_url);
web_app_info->title =
install_options_.override_name
? base::UTF8ToUTF16(install_options_.override_name.value())
: install_options_.fallback_app_name
? base::UTF8ToUTF16(install_options_.fallback_app_name.value())
: base::UTF8ToUTF16(install_options_.install_url.spec());
if (bitmaps) {
IconsMap icons_map;
icons_map.emplace(GURL(install_options_.override_icon_url.value()),
bitmaps.value());
PopulateProductIcons(web_app_info.get(), &icons_map);
}
web_app_info->install_url = install_options_.install_url;
web_app_info->user_display_mode = install_options_.user_display_mode;
WebAppInstallFinalizer::FinalizeOptions options(
ConvertExternalInstallSourceToInstallSource(
install_options_.install_source));
// Overwrite fields if we are doing a forced reinstall, because some
// values (custom name or icon) might have changed.
options.overwrite_existing_manifest_fields = install_options_.force_reinstall;
options.add_to_applications_menu = install_options_.add_to_applications_menu;
options.add_to_desktop = install_options_.add_to_desktop;
options.add_to_quick_launch_bar = install_options_.add_to_quick_launch_bar;
web_app_info->is_placeholder = true;
lock_->install_finalizer().FinalizeInstall(
*web_app_info, options,
base::BindOnce(&InstallPlaceholderJob::OnInstallFinalized,
weak_factory_.GetWeakPtr()));
}
void InstallPlaceholderJob::OnInstallFinalized(
const webapps::AppId& app_id,
webapps::InstallResultCode code) {
debug_value_->Set("result_code", base::ToString(code));
CHECK(web_contents_ && !web_contents_->IsBeingDestroyed());
if (code != webapps::InstallResultCode::kSuccessNewInstall) {
Abort(code);
return;
}
RecordWebAppInstallationTimestamp(
Profile::FromBrowserContext(web_contents_->GetBrowserContext())
->GetPrefs(),
app_id,
ConvertExternalInstallSourceToInstallSource(
install_options_.install_source));
webapps::InstallableMetrics::TrackInstallResult(
webapps::IsSuccess(code), ConvertExternalInstallSourceToInstallSource(
install_options_.install_source));
std::move(callback_).Run(code, std::move(app_id));
}
} // namespace web_app
|
