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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/common/manifest_handlers/options_page_info.h"
#include <memory>
#include "base/files/file_util.h"
#include "base/memory/ptr_util.h"
#include "base/strings/utf_string_conversions.h"
#include "extensions/common/api/extensions_manifest_types.h"
#include "extensions/common/error_utils.h"
#include "extensions/common/feature_switch.h"
#include "extensions/common/file_util.h"
#include "extensions/common/manifest_constants.h"
#include "extensions/strings/grit/extensions_strings.h"
#include "ui/base/l10n/l10n_util.h"
namespace extensions {
namespace keys = manifest_keys;
namespace errors = manifest_errors;
using api::extensions_manifest_types::OptionsUI;
namespace {
OptionsPageInfo* GetOptionsPageInfo(const Extension* extension) {
return static_cast<OptionsPageInfo*>(
extension->GetManifestData(keys::kOptionsUI));
}
// Parses |url_string| into a GURL |result| if it is a valid options page for
// this app/extension. If not, it returns the reason in |error|. Because this
// handles URLs for both "options_page" and "options_ui.page", the name of the
// manifest field must be provided in |manifest_field_name|.
bool ParseOptionsUrl(Extension* extension,
const std::string& url_string,
const std::string& manifest_field_name,
std::u16string* error,
GURL* result) {
if (extension->is_hosted_app()) {
// Hosted apps require an absolute URL.
GURL options_url(url_string);
if (!options_url.is_valid() || !options_url.SchemeIsHTTPOrHTTPS()) {
*error = errors::kInvalidOptionsPageInHostedApp;
return false;
}
*result = options_url;
return true;
}
GURL resource_url = extension->ResolveExtensionURL(url_string);
if (!resource_url.is_valid()) {
*error = ErrorUtils::FormatErrorMessageUTF16(errors::kInvalidOptionsPage,
manifest_field_name);
return false;
}
*result = resource_url;
return true;
}
} // namespace
OptionsPageInfo::OptionsPageInfo(const GURL& options_page,
bool chrome_styles,
bool open_in_tab)
: options_page_(options_page),
chrome_styles_(chrome_styles),
open_in_tab_(open_in_tab) {
}
OptionsPageInfo::~OptionsPageInfo() = default;
// static
const GURL& OptionsPageInfo::GetOptionsPage(const Extension* extension) {
OptionsPageInfo* info = GetOptionsPageInfo(extension);
return info ? info->options_page_ : GURL::EmptyGURL();
}
// static
bool OptionsPageInfo::HasOptionsPage(const Extension* extension) {
return !OptionsPageInfo::GetOptionsPage(extension).is_empty();
}
// static
bool OptionsPageInfo::ShouldUseChromeStyle(const Extension* extension) {
OptionsPageInfo* info = GetOptionsPageInfo(extension);
return info && info->chrome_styles_;
}
// static
bool OptionsPageInfo::ShouldOpenInTab(const Extension* extension) {
OptionsPageInfo* info = GetOptionsPageInfo(extension);
return info && info->open_in_tab_;
}
std::unique_ptr<OptionsPageInfo> OptionsPageInfo::Create(
Extension* extension,
const base::Value::Dict* options_ui_dict,
const std::string& options_page_string,
std::vector<InstallWarning>* install_warnings,
std::u16string* error) {
GURL options_page;
// Chrome styling is always opt-in.
bool chrome_style = false;
// Extensions can opt in or out to opening in a tab, and users can choose via
// the --embedded-extension-options flag which should be the default.
bool open_in_tab = !FeatureSwitch::embedded_extension_options()->IsEnabled();
// Parse the options_ui object.
if (options_ui_dict) {
auto options_ui = OptionsUI::FromValue(*options_ui_dict);
if (!options_ui.has_value()) {
install_warnings->emplace_back(base::UTF16ToASCII(options_ui.error()));
} else {
std::u16string options_parse_error;
if (!ParseOptionsUrl(extension,
options_ui->page,
keys::kOptionsUI,
&options_parse_error,
&options_page)) {
install_warnings->emplace_back(base::UTF16ToASCII(options_parse_error));
}
if (options_ui->chrome_style) {
if (extension->manifest_version() < 3) {
chrome_style = *options_ui->chrome_style;
} else {
*error = errors::kChromeStyleInvalidForManifestV3;
return nullptr;
}
}
open_in_tab = options_ui->open_in_tab.value_or(false);
}
}
// Parse the legacy options_page entry if there was no entry for
// options_ui.page.
if (!options_page_string.empty() && !options_page.is_valid()) {
if (!ParseOptionsUrl(extension,
options_page_string,
keys::kOptionsPage,
error,
&options_page)) {
return nullptr;
}
}
return std::make_unique<OptionsPageInfo>(options_page, chrome_style,
open_in_tab);
}
OptionsPageHandler::OptionsPageHandler() = default;
OptionsPageHandler::~OptionsPageHandler() = default;
bool OptionsPageHandler::Parse(Extension* extension, std::u16string* error) {
std::vector<InstallWarning> install_warnings;
const Manifest* manifest = extension->manifest();
std::string options_page_string;
if (const base::Value* temp = manifest->FindPath(keys::kOptionsPage)) {
if (!temp->is_string()) {
*error = ErrorUtils::FormatErrorMessageUTF16(errors::kInvalidOptionsPage,
keys::kOptionsPage);
return false;
}
options_page_string = temp->GetString();
}
const base::Value::Dict* options_ui_dict =
manifest->FindDictPath(keys::kOptionsUI);
std::unique_ptr<OptionsPageInfo> info =
OptionsPageInfo::Create(extension, options_ui_dict, options_page_string,
&install_warnings, error);
if (!info) {
return false;
}
extension->AddInstallWarnings(std::move(install_warnings));
extension->SetManifestData(keys::kOptionsUI, std::move(info));
return true;
}
bool OptionsPageHandler::Validate(const Extension& extension,
std::string* error,
std::vector<InstallWarning>* warnings) const {
// Validate path to the options page. Don't check the URL for hosted apps,
// because they are expected to refer to an external URL.
if (!OptionsPageInfo::HasOptionsPage(&extension) ||
extension.is_hosted_app()) {
return true;
}
base::FilePath options_path = file_util::ExtensionURLToRelativeFilePath(
OptionsPageInfo::GetOptionsPage(&extension));
base::FilePath path = extension.GetResource(options_path).GetFilePath();
if (path.empty() || !base::PathExists(path)) {
*error = l10n_util::GetStringFUTF8(IDS_EXTENSION_LOAD_OPTIONS_PAGE_FAILED,
options_path.LossyDisplayName());
return false;
}
return true;
}
base::span<const char* const> OptionsPageHandler::Keys() const {
static constexpr const char* kKeys[] = {keys::kOptionsPage, keys::kOptionsUI};
return kKeys;
}
} // namespace extensions
|
