blob: d204190d59dc7f13fef2cec672eae4dc369536ff [file] [log] [blame]
Adam Lesinski2ae4a872015-11-02 16:10:55 -08001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Adam Lesinski2ae4a872015-11-02 16:10:55 -080017#include "link/ManifestFixer.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070018
19#include <unordered_set>
20
21#include "android-base/logging.h"
22
Adam Lesinskicacb28f2016-10-19 12:18:14 -070023#include "ResourceUtils.h"
Fabien Sanglard2d34e762019-02-21 15:13:29 -080024#include "trace/TraceBuffer.h"
Adam Lesinski2ae4a872015-11-02 16:10:55 -080025#include "util/Util.h"
Adam Lesinskicc5609d2016-04-05 12:41:07 -070026#include "xml/XmlActionExecutor.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080027#include "xml/XmlDom.h"
Adam Lesinski2ae4a872015-11-02 16:10:55 -080028
Adam Lesinskid5083f62017-01-16 15:07:21 -080029using android::StringPiece;
30
Adam Lesinski2ae4a872015-11-02 16:10:55 -080031namespace aapt {
32
Adam Lesinskifca5e422017-12-20 15:03:36 -080033static bool RequiredNameIsNotEmpty(xml::Element* el, SourcePathDiagnostics* diag) {
34 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "name");
35 if (attr == nullptr) {
36 diag->Error(DiagMessage(el->line_number)
37 << "<" << el->name << "> is missing attribute 'android:name'");
38 return false;
39 }
40
41 if (attr->value.empty()) {
42 diag->Error(DiagMessage(el->line_number)
43 << "attribute 'android:name' in <" << el->name << "> tag must not be empty");
44 return false;
45 }
46 return true;
47}
48
Adam Lesinskib0c47ef2017-03-06 20:05:57 -080049// This is how PackageManager builds class names from AndroidManifest.xml entries.
Adam Lesinskice5e56e2016-10-21 17:56:45 -070050static bool NameIsJavaClassName(xml::Element* el, xml::Attribute* attr,
Adam Lesinskicc5609d2016-04-05 12:41:07 -070051 SourcePathDiagnostics* diag) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070052 // We allow unqualified class names (ie: .HelloActivity)
53 // Since we don't know the package name, we can just make a fake one here and
54 // the test will be identical as long as the real package name is valid too.
Ryan Mitchell4382e442021-07-14 12:53:01 -070055 std::optional<std::string> fully_qualified_class_name =
Adam Lesinskice5e56e2016-10-21 17:56:45 -070056 util::GetFullyQualifiedClassName("a", attr->value);
Adam Lesinskicc5609d2016-04-05 12:41:07 -070057
Adam Lesinskice5e56e2016-10-21 17:56:45 -070058 StringPiece qualified_class_name = fully_qualified_class_name
59 ? fully_qualified_class_name.value()
60 : attr->value;
Adam Lesinskid0f116b2016-07-08 15:00:32 -070061
Adam Lesinskice5e56e2016-10-21 17:56:45 -070062 if (!util::IsJavaClassName(qualified_class_name)) {
63 diag->Error(DiagMessage(el->line_number)
Adam Lesinskicacb28f2016-10-19 12:18:14 -070064 << "attribute 'android:name' in <" << el->name
65 << "> tag must be a valid Java class name");
Adam Lesinski52364f72016-01-11 13:10:24 -080066 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070067 }
68 return true;
69}
70
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -080071static bool OptionalNameIsJavaClassName(xml::Element* el, SourcePathDiagnostics* diag) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -070072 if (xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "name")) {
73 return NameIsJavaClassName(el, attr, diag);
Adam Lesinskicacb28f2016-10-19 12:18:14 -070074 }
75 return true;
76}
77
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -080078static bool RequiredNameIsJavaClassName(xml::Element* el, SourcePathDiagnostics* diag) {
Adam Lesinskifca5e422017-12-20 15:03:36 -080079 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "name");
80 if (attr == nullptr) {
81 diag->Error(DiagMessage(el->line_number)
82 << "<" << el->name << "> is missing attribute 'android:name'");
83 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070084 }
Adam Lesinskifca5e422017-12-20 15:03:36 -080085 return NameIsJavaClassName(el, attr, diag);
Adam Lesinski52364f72016-01-11 13:10:24 -080086}
87
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -080088static bool RequiredNameIsJavaPackage(xml::Element* el, SourcePathDiagnostics* diag) {
Adam Lesinskifca5e422017-12-20 15:03:36 -080089 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "name");
90 if (attr == nullptr) {
91 diag->Error(DiagMessage(el->line_number)
92 << "<" << el->name << "> is missing attribute 'android:name'");
93 return false;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -080094 }
Adam Lesinskifca5e422017-12-20 15:03:36 -080095
96 if (!util::IsJavaPackageName(attr->value)) {
97 diag->Error(DiagMessage(el->line_number) << "attribute 'android:name' in <" << el->name
98 << "> tag must be a valid Java package name");
99 return false;
100 }
101 return true;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800102}
103
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -0800104static xml::XmlNodeAction::ActionFuncWithDiag RequiredAndroidAttribute(const std::string& attr) {
105 return [=](xml::Element* el, SourcePathDiagnostics* diag) -> bool {
106 if (el->FindAttribute(xml::kSchemaAndroid, attr) == nullptr) {
107 diag->Error(DiagMessage(el->line_number)
108 << "<" << el->name << "> is missing required attribute 'android:" << attr << "'");
109 return false;
110 }
111 return true;
112 };
113}
114
Todd Kennedyce3e1292020-10-29 17:14:24 -0700115static xml::XmlNodeAction::ActionFuncWithDiag RequiredOneAndroidAttribute(
116 const std::string& attrName1, const std::string& attrName2) {
117 return [=](xml::Element* el, SourcePathDiagnostics* diag) -> bool {
118 xml::Attribute* attr1 = el->FindAttribute(xml::kSchemaAndroid, attrName1);
119 xml::Attribute* attr2 = el->FindAttribute(xml::kSchemaAndroid, attrName2);
120 if (attr1 == nullptr && attr2 == nullptr) {
121 diag->Error(DiagMessage(el->line_number)
122 << "<" << el->name << "> is missing required attribute 'android:" << attrName1
123 << "' or 'android:" << attrName2 << "'");
124 return false;
125 }
126 if (attr1 != nullptr && attr2 != nullptr) {
127 diag->Error(DiagMessage(el->line_number)
128 << "<" << el->name << "> can only specify one of attribute 'android:" << attrName1
129 << "' or 'android:" << attrName2 << "'");
130 return false;
131 }
132 return true;
133 };
134}
135
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800136static bool AutoGenerateIsFeatureSplit(xml::Element* el, SourcePathDiagnostics* diag) {
137 constexpr const char* kFeatureSplit = "featureSplit";
138 constexpr const char* kIsFeatureSplit = "isFeatureSplit";
139
140 xml::Attribute* attr = el->FindAttribute({}, kFeatureSplit);
141 if (attr != nullptr) {
142 // Rewrite the featureSplit attribute to be "split". This is what the
143 // platform recognizes.
144 attr->name = "split";
145
146 // Now inject the android:isFeatureSplit="true" attribute.
147 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, kIsFeatureSplit);
148 if (attr != nullptr) {
Ryan Mitchell4382e442021-07-14 12:53:01 -0700149 if (!ResourceUtils::ParseBool(attr->value).value_or(false)) {
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800150 // The isFeatureSplit attribute is false, which conflicts with the use
151 // of "featureSplit".
152 diag->Error(DiagMessage(el->line_number)
153 << "attribute 'featureSplit' used in <manifest> but 'android:isFeatureSplit' "
154 "is not 'true'");
155 return false;
156 }
157
158 // The attribute is already there and set to true, nothing to do.
159 } else {
160 el->attributes.push_back(xml::Attribute{xml::kSchemaAndroid, kIsFeatureSplit, "true"});
161 }
162 }
163 return true;
164}
165
Jackal Guo0c01abb2021-07-30 22:17:43 +0800166static bool AutoGenerateIsSplitRequired(xml::Element* el, SourcePathDiagnostics* diag) {
167 constexpr const char* kRequiredSplitTypes = "requiredSplitTypes";
168 constexpr const char* kIsSplitRequired = "isSplitRequired";
169
170 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, kRequiredSplitTypes);
171 if (attr != nullptr) {
172 // Now inject the android:isSplitRequired="true" attribute.
173 xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, kIsSplitRequired);
174 if (attr != nullptr) {
175 if (!ResourceUtils::ParseBool(attr->value).value_or(false)) {
176 // The isFeatureSplit attribute is false, which conflicts with the use
177 // of "featureSplit".
178 diag->Error(DiagMessage(el->line_number)
179 << "attribute 'requiredSplitTypes' used in <manifest> but "
180 "'android:isSplitRequired' is not 'true'");
181 return false;
182 }
183 // The attribute is already there and set to true, nothing to do.
184 } else {
185 el->attributes.push_back(xml::Attribute{xml::kSchemaAndroid, kIsSplitRequired, "true"});
186 }
187 }
188 return true;
189}
190
Rhed Jao2c434422020-11-12 10:48:03 +0800191static bool VerifyManifest(xml::Element* el, xml::XmlActionExecutorPolicy policy,
192 SourcePathDiagnostics* diag) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700193 xml::Attribute* attr = el->FindAttribute({}, "package");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700194 if (!attr) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700195 diag->Error(DiagMessage(el->line_number)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700196 << "<manifest> tag is missing 'package' attribute");
197 return false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700198 } else if (ResourceUtils::IsReference(attr->value)) {
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800199 diag->Error(DiagMessage(el->line_number)
200 << "attribute 'package' in <manifest> tag must not be a reference");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700201 return false;
Adam Lesinski96ea08f2017-11-06 10:44:46 -0800202 } else if (!util::IsAndroidPackageName(attr->value)) {
Rhed Jao2c434422020-11-12 10:48:03 +0800203 DiagMessage error_msg(el->line_number);
204 error_msg << "attribute 'package' in <manifest> tag is not a valid Android package name: '"
205 << attr->value << "'";
206 if (policy == xml::XmlActionExecutorPolicy::kAllowListWarning) {
207 // Treat the error only as a warning.
208 diag->Warn(error_msg);
209 } else {
210 diag->Error(error_msg);
211 return false;
212 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700213 }
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800214
215 attr = el->FindAttribute({}, "split");
216 if (attr) {
217 if (!util::IsJavaPackageName(attr->value)) {
218 diag->Error(DiagMessage(el->line_number) << "attribute 'split' in <manifest> tag is not a "
219 "valid split name");
220 return false;
221 }
222 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700223 return true;
Adam Lesinski52364f72016-01-11 13:10:24 -0800224}
225
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800226// The coreApp attribute in <manifest> is not a regular AAPT attribute, so type
227// checking on it is manual.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700228static bool FixCoreAppAttribute(xml::Element* el, SourcePathDiagnostics* diag) {
229 if (xml::Attribute* attr = el->FindAttribute("", "coreApp")) {
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800230 std::unique_ptr<BinaryPrimitive> result = ResourceUtils::TryParseBool(attr->value);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700231 if (!result) {
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800232 diag->Error(DiagMessage(el->line_number) << "attribute coreApp must be a boolean");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700233 return false;
Adam Lesinski6b17d2c2016-08-10 11:37:06 -0700234 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700235 attr->compiled_value = std::move(result);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700236 }
237 return true;
Adam Lesinski6b17d2c2016-08-10 11:37:06 -0700238}
239
Adam Lesinski86d67df2017-01-31 13:47:27 -0800240// Checks that <uses-feature> has android:glEsVersion or android:name, not both (or neither).
241static bool VerifyUsesFeature(xml::Element* el, SourcePathDiagnostics* diag) {
242 bool has_name = false;
243 if (xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "name")) {
244 if (attr->value.empty()) {
245 diag->Error(DiagMessage(el->line_number)
246 << "android:name in <uses-feature> must not be empty");
247 return false;
248 }
249 has_name = true;
250 }
251
252 bool has_gl_es_version = false;
253 if (xml::Attribute* attr = el->FindAttribute(xml::kSchemaAndroid, "glEsVersion")) {
254 if (has_name) {
255 diag->Error(DiagMessage(el->line_number)
256 << "cannot define both android:name and android:glEsVersion in <uses-feature>");
257 return false;
258 }
259 has_gl_es_version = true;
260 }
261
262 if (!has_name && !has_gl_es_version) {
263 diag->Error(DiagMessage(el->line_number)
264 << "<uses-feature> must have either android:name or android:glEsVersion attribute");
265 return false;
266 }
267 return true;
268}
269
Donald Chai6e497352019-05-19 21:07:50 -0700270// Ensure that 'ns_decls' contains a declaration for 'uri', using 'prefix' as
271// the xmlns prefix if possible.
272static void EnsureNamespaceIsDeclared(const std::string& prefix, const std::string& uri,
273 std::vector<xml::NamespaceDecl>* ns_decls) {
274 if (std::find_if(ns_decls->begin(), ns_decls->end(), [&](const xml::NamespaceDecl& ns_decl) {
275 return ns_decl.uri == uri;
276 }) != ns_decls->end()) {
277 return;
278 }
279
280 std::set<std::string> used_prefixes;
281 for (const auto& ns_decl : *ns_decls) {
282 used_prefixes.insert(ns_decl.prefix);
283 }
284
285 // Make multiple attempts in the unlikely event that 'prefix' is already taken.
286 std::string disambiguator;
287 for (int i = 0; i < used_prefixes.size() + 1; i++) {
288 std::string attempted_prefix = prefix + disambiguator;
289 if (used_prefixes.find(attempted_prefix) == used_prefixes.end()) {
290 ns_decls->push_back(xml::NamespaceDecl{attempted_prefix, uri});
291 return;
292 }
293 disambiguator = std::to_string(i);
294 }
295}
296
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700297bool ManifestFixer::BuildRules(xml::XmlActionExecutor* executor,
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700298 IDiagnostics* diag) {
299 // First verify some options.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700300 if (options_.rename_manifest_package) {
301 if (!util::IsJavaPackageName(options_.rename_manifest_package.value())) {
302 diag->Error(DiagMessage() << "invalid manifest package override '"
303 << options_.rename_manifest_package.value()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700304 << "'");
305 return false;
306 }
307 }
308
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700309 if (options_.rename_instrumentation_target_package) {
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800310 if (!util::IsJavaPackageName(options_.rename_instrumentation_target_package.value())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700311 diag->Error(DiagMessage()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700312 << "invalid instrumentation target package override '"
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700313 << options_.rename_instrumentation_target_package.value()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700314 << "'");
315 return false;
316 }
317 }
318
Roshan Piusae12ce42020-04-25 16:08:55 -0700319 if (options_.rename_overlay_target_package) {
320 if (!util::IsJavaPackageName(options_.rename_overlay_target_package.value())) {
321 diag->Error(DiagMessage()
322 << "invalid overlay target package override '"
323 << options_.rename_overlay_target_package.value()
324 << "'");
325 return false;
326 }
327 }
328
Adam Lesinski86d67df2017-01-31 13:47:27 -0800329 // Common <intent-filter> actions.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700330 xml::XmlNodeAction intent_filter_action;
Adam Lesinskifca5e422017-12-20 15:03:36 -0800331 intent_filter_action["action"].Action(RequiredNameIsNotEmpty);
332 intent_filter_action["category"].Action(RequiredNameIsNotEmpty);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700333 intent_filter_action["data"];
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700334
Adam Lesinski86d67df2017-01-31 13:47:27 -0800335 // Common <meta-data> actions.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700336 xml::XmlNodeAction meta_data_action;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700337
Todd Kennedyce3e1292020-10-29 17:14:24 -0700338 // Common <property> actions.
339 xml::XmlNodeAction property_action;
340 property_action.Action(RequiredOneAndroidAttribute("resource", "value"));
341
Adam Lesinski86d67df2017-01-31 13:47:27 -0800342 // Common <uses-feature> actions.
343 xml::XmlNodeAction uses_feature_action;
344 uses_feature_action.Action(VerifyUsesFeature);
345
346 // Common component actions.
347 xml::XmlNodeAction component_action;
348 component_action.Action(RequiredNameIsJavaClassName);
349 component_action["intent-filter"] = intent_filter_action;
Ryan Mitchell28afe682018-09-07 14:33:14 -0700350 component_action["preferred"] = intent_filter_action;
Adam Lesinski86d67df2017-01-31 13:47:27 -0800351 component_action["meta-data"] = meta_data_action;
Todd Kennedyce3e1292020-10-29 17:14:24 -0700352 component_action["property"] = property_action;
Adam Lesinski86d67df2017-01-31 13:47:27 -0800353
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700354 // Manifest actions.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700355 xml::XmlNodeAction& manifest_action = (*executor)["manifest"];
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800356 manifest_action.Action(AutoGenerateIsFeatureSplit);
Jackal Guo0c01abb2021-07-30 22:17:43 +0800357 manifest_action.Action(AutoGenerateIsSplitRequired);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700358 manifest_action.Action(VerifyManifest);
359 manifest_action.Action(FixCoreAppAttribute);
360 manifest_action.Action([&](xml::Element* el) -> bool {
Donald Chai6e497352019-05-19 21:07:50 -0700361 EnsureNamespaceIsDeclared("android", xml::kSchemaAndroid, &el->namespace_decls);
362
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700363 if (options_.version_name_default) {
Colin Crossdcd58c42018-05-25 22:46:35 -0700364 if (options_.replace_version) {
365 el->RemoveAttribute(xml::kSchemaAndroid, "versionName");
366 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700367 if (el->FindAttribute(xml::kSchemaAndroid, "versionName") == nullptr) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700368 el->attributes.push_back(
369 xml::Attribute{xml::kSchemaAndroid, "versionName",
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700370 options_.version_name_default.value()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700371 }
Adam Lesinskicc5609d2016-04-05 12:41:07 -0700372 }
373
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700374 if (options_.version_code_default) {
Colin Crossdcd58c42018-05-25 22:46:35 -0700375 if (options_.replace_version) {
376 el->RemoveAttribute(xml::kSchemaAndroid, "versionCode");
377 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700378 if (el->FindAttribute(xml::kSchemaAndroid, "versionCode") == nullptr) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700379 el->attributes.push_back(
380 xml::Attribute{xml::kSchemaAndroid, "versionCode",
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700381 options_.version_code_default.value()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700382 }
Adam Lesinskicc5609d2016-04-05 12:41:07 -0700383 }
Ryan Mitchell7cb82a82018-05-10 15:35:31 -0700384
Ryan Mitchell704090e2018-07-31 14:59:25 -0700385 if (options_.version_code_major_default) {
386 if (options_.replace_version) {
387 el->RemoveAttribute(xml::kSchemaAndroid, "versionCodeMajor");
388 }
389 if (el->FindAttribute(xml::kSchemaAndroid, "versionCodeMajor") == nullptr) {
390 el->attributes.push_back(
391 xml::Attribute{xml::kSchemaAndroid, "versionCodeMajor",
392 options_.version_code_major_default.value()});
393 }
394 }
395
Rhed Jaob9ccb8a42020-11-30 21:42:16 +0800396 if (options_.revision_code_default) {
397 if (options_.replace_version) {
398 el->RemoveAttribute(xml::kSchemaAndroid, "revisionCode");
399 }
400 if (el->FindAttribute(xml::kSchemaAndroid, "revisionCode") == nullptr) {
401 el->attributes.push_back(xml::Attribute{xml::kSchemaAndroid, "revisionCode",
402 options_.revision_code_default.value()});
403 }
404 }
405
Adam Lesinski2ae4a872015-11-02 16:10:55 -0800406 return true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700407 });
408
409 // Meta tags.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700410 manifest_action["eat-comment"];
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700411
412 // Uses-sdk actions.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700413 manifest_action["uses-sdk"].Action([&](xml::Element* el) -> bool {
414 if (options_.min_sdk_version_default &&
415 el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion") == nullptr) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700416 // There was no minSdkVersion defined and we have a default to assign.
417 el->attributes.push_back(
418 xml::Attribute{xml::kSchemaAndroid, "minSdkVersion",
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700419 options_.min_sdk_version_default.value()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700420 }
421
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700422 if (options_.target_sdk_version_default &&
423 el->FindAttribute(xml::kSchemaAndroid, "targetSdkVersion") == nullptr) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700424 // There was no targetSdkVersion defined and we have a default to assign.
425 el->attributes.push_back(
426 xml::Attribute{xml::kSchemaAndroid, "targetSdkVersion",
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700427 options_.target_sdk_version_default.value()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700428 }
429 return true;
430 });
Anton Hanssonb2f709d2020-01-09 10:25:23 +0000431 manifest_action["uses-sdk"]["extension-sdk"];
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700432
433 // Instrumentation actions.
Adam Lesinski86d67df2017-01-31 13:47:27 -0800434 manifest_action["instrumentation"].Action(RequiredNameIsJavaClassName);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700435 manifest_action["instrumentation"].Action([&](xml::Element* el) -> bool {
436 if (!options_.rename_instrumentation_target_package) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700437 return true;
438 }
439
440 if (xml::Attribute* attr =
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700441 el->FindAttribute(xml::kSchemaAndroid, "targetPackage")) {
442 attr->value = options_.rename_instrumentation_target_package.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700443 }
444 return true;
445 });
Adam Lesinski86d67df2017-01-31 13:47:27 -0800446 manifest_action["instrumentation"]["meta-data"] = meta_data_action;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700447
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -0800448 manifest_action["attribution"];
449 manifest_action["attribution"]["inherit-from"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700450 manifest_action["original-package"];
Roshan Piusae12ce42020-04-25 16:08:55 -0700451 manifest_action["overlay"].Action([&](xml::Element* el) -> bool {
452 if (!options_.rename_overlay_target_package) {
453 return true;
454 }
455
456 if (xml::Attribute* attr =
457 el->FindAttribute(xml::kSchemaAndroid, "targetPackage")) {
458 attr->value = options_.rename_overlay_target_package.value();
459 }
460 return true;
461 });
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700462 manifest_action["protected-broadcast"];
Alan Viverettecf5326f2018-01-05 16:03:50 -0500463 manifest_action["adopt-permissions"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700464 manifest_action["uses-permission"];
Sergey Nikolaienkov65f90992020-09-30 08:17:09 +0000465 manifest_action["uses-permission"]["required-feature"].Action(RequiredNameIsNotEmpty);
466 manifest_action["uses-permission"]["required-not-feature"].Action(RequiredNameIsNotEmpty);
Adam Lesinski4b585db2017-05-12 15:25:50 -0700467 manifest_action["uses-permission-sdk-23"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700468 manifest_action["permission"];
Ryan Mitchell66f6cfb2018-07-25 16:15:17 -0700469 manifest_action["permission"]["meta-data"] = meta_data_action;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700470 manifest_action["permission-tree"];
471 manifest_action["permission-group"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700472 manifest_action["uses-configuration"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700473 manifest_action["supports-screens"];
Adam Lesinski86d67df2017-01-31 13:47:27 -0800474 manifest_action["uses-feature"] = uses_feature_action;
475 manifest_action["feature-group"]["uses-feature"] = uses_feature_action;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700476 manifest_action["compatible-screens"];
477 manifest_action["compatible-screens"]["screen"];
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700478 manifest_action["supports-gl-texture"];
Ryan Mitchell66f6cfb2018-07-25 16:15:17 -0700479 manifest_action["restrict-update"];
480 manifest_action["package-verifier"];
Adam Lesinski5119e512016-12-05 19:48:20 -0800481 manifest_action["meta-data"] = meta_data_action;
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800482 manifest_action["uses-split"].Action(RequiredNameIsJavaPackage);
Patrick Baumanna4ffb452019-06-24 15:01:49 -0700483 manifest_action["queries"]["package"].Action(RequiredNameIsJavaPackage);
484 manifest_action["queries"]["intent"] = intent_filter_action;
Patrick Baumann99181232020-01-28 10:55:25 -0800485 manifest_action["queries"]["provider"].Action(RequiredAndroidAttribute("authorities"));
Patrick Baumanna4ffb452019-06-24 15:01:49 -0700486 // TODO: more complicated component name tag
Adam Lesinski5119e512016-12-05 19:48:20 -0800487
Adam Lesinski87f1e0f2017-06-27 16:21:58 -0700488 manifest_action["key-sets"]["key-set"]["public-key"];
489 manifest_action["key-sets"]["upgrade-key-set"];
490
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700491 // Application actions.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700492 xml::XmlNodeAction& application_action = manifest_action["application"];
493 application_action.Action(OptionalNameIsJavaClassName);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700494
Adam Lesinskifca5e422017-12-20 15:03:36 -0800495 application_action["uses-library"].Action(RequiredNameIsNotEmpty);
Jiyong Park6a5b8b12020-06-30 13:23:36 +0900496 application_action["uses-native-library"].Action(RequiredNameIsNotEmpty);
Adam Lesinskifca5e422017-12-20 15:03:36 -0800497 application_action["library"].Action(RequiredNameIsNotEmpty);
Chris Craik335b5652019-04-04 12:46:47 -0700498 application_action["profileable"];
Todd Kennedyce3e1292020-10-29 17:14:24 -0700499 application_action["property"] = property_action;
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -0800500
501 xml::XmlNodeAction& static_library_action = application_action["static-library"];
502 static_library_action.Action(RequiredNameIsJavaPackage);
503 static_library_action.Action(RequiredAndroidAttribute("version"));
504
505 xml::XmlNodeAction& uses_static_library_action = application_action["uses-static-library"];
506 uses_static_library_action.Action(RequiredNameIsJavaPackage);
507 uses_static_library_action.Action(RequiredAndroidAttribute("version"));
508 uses_static_library_action.Action(RequiredAndroidAttribute("certDigest"));
Ryan Mitchell66f6cfb2018-07-25 16:15:17 -0700509 uses_static_library_action["additional-certificate"];
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -0800510
Alex Buynytskyya16137052021-12-02 13:26:54 +0000511 xml::XmlNodeAction& sdk_library_action = application_action["sdk-library"];
512 sdk_library_action.Action(RequiredNameIsJavaPackage);
513 sdk_library_action.Action(RequiredAndroidAttribute("versionMajor"));
514
515 xml::XmlNodeAction& uses_sdk_library_action = application_action["uses-sdk-library"];
516 uses_sdk_library_action.Action(RequiredNameIsJavaPackage);
517 uses_sdk_library_action.Action(RequiredAndroidAttribute("versionMajor"));
518 uses_sdk_library_action.Action(RequiredAndroidAttribute("certDigest"));
519 uses_sdk_library_action["additional-certificate"];
520
Dianne Hackborn813d7502018-10-02 16:59:46 -0700521 xml::XmlNodeAction& uses_package_action = application_action["uses-package"];
522 uses_package_action.Action(RequiredNameIsJavaPackage);
523 uses_package_action["additional-certificate"];
524
Ryan Mitchelle5b38a62018-03-23 13:35:00 -0700525 if (options_.debug_mode) {
526 application_action.Action([&](xml::Element* el) -> bool {
527 xml::Attribute *attr = el->FindOrCreateAttribute(xml::kSchemaAndroid, "debuggable");
528 attr->value = "true";
529 return true;
530 });
531 }
532
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700533 application_action["meta-data"] = meta_data_action;
Adam Lesinski7a917a22017-06-02 12:55:24 -0700534
Dianne Hackbornfc0839a2020-01-31 11:02:28 -0800535 application_action["processes"];
536 application_action["processes"]["deny-permission"];
537 application_action["processes"]["allow-permission"];
538 application_action["processes"]["process"]["deny-permission"];
539 application_action["processes"]["process"]["allow-permission"];
540
Adam Lesinski86d67df2017-01-31 13:47:27 -0800541 application_action["activity"] = component_action;
Adam Lesinski7a917a22017-06-02 12:55:24 -0700542 application_action["activity"]["layout"];
543
Adam Lesinski86d67df2017-01-31 13:47:27 -0800544 application_action["activity-alias"] = component_action;
545 application_action["service"] = component_action;
546 application_action["receiver"] = component_action;
Gavin Corkeryad5d4ba2021-10-26 12:24:43 +0100547 application_action["apex-system-service"] = component_action;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700548
549 // Provider actions.
Adam Lesinski86d67df2017-01-31 13:47:27 -0800550 application_action["provider"] = component_action;
Adam Lesinskic10c0d02017-04-28 12:54:08 -0700551 application_action["provider"]["grant-uri-permission"];
Adam Lesinski25783ca2017-04-24 13:33:47 -0700552 application_action["provider"]["path-permission"];
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700553
Ryan Mitchell28afe682018-09-07 14:33:14 -0700554 manifest_action["package"] = manifest_action;
555
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700556 return true;
Adam Lesinski2ae4a872015-11-02 16:10:55 -0800557}
558
Adam Lesinski23034b92017-11-29 16:27:44 -0800559static void FullyQualifyClassName(const StringPiece& package, const StringPiece& attr_ns,
560 const StringPiece& attr_name, xml::Element* el) {
561 xml::Attribute* attr = el->FindAttribute(attr_ns, attr_name);
562 if (attr != nullptr) {
Ryan Mitchell4382e442021-07-14 12:53:01 -0700563 if (std::optional<std::string> new_value =
564 util::GetFullyQualifiedClassName(package, attr->value)) {
Adam Lesinski23034b92017-11-29 16:27:44 -0800565 attr->value = std::move(new_value.value());
Adam Lesinski52364f72016-01-11 13:10:24 -0800566 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700567 }
Adam Lesinski23034b92017-11-29 16:27:44 -0800568}
Adam Lesinski52364f72016-01-11 13:10:24 -0800569
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800570static bool RenameManifestPackage(const StringPiece& package_override, xml::Element* manifest_el) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700571 xml::Attribute* attr = manifest_el->FindAttribute({}, "package");
Adam Lesinski52364f72016-01-11 13:10:24 -0800572
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700573 // We've already verified that the manifest element is present, with a package
574 // name specified.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700575 CHECK(attr != nullptr);
Adam Lesinski52364f72016-01-11 13:10:24 -0800576
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700577 std::string original_package = std::move(attr->value);
Adam Lesinskid5083f62017-01-16 15:07:21 -0800578 attr->value = package_override.to_string();
Adam Lesinski52364f72016-01-11 13:10:24 -0800579
Adam Lesinski23034b92017-11-29 16:27:44 -0800580 xml::Element* application_el = manifest_el->FindChild({}, "application");
581 if (application_el != nullptr) {
582 FullyQualifyClassName(original_package, xml::kSchemaAndroid, "name", application_el);
583 FullyQualifyClassName(original_package, xml::kSchemaAndroid, "backupAgent", application_el);
584
585 for (xml::Element* child_el : application_el->GetChildElements()) {
586 if (child_el->namespace_uri.empty()) {
587 if (child_el->name == "activity" || child_el->name == "activity-alias" ||
588 child_el->name == "provider" || child_el->name == "receiver" ||
589 child_el->name == "service") {
590 FullyQualifyClassName(original_package, xml::kSchemaAndroid, "name", child_el);
591 }
592
593 if (child_el->name == "activity-alias") {
594 FullyQualifyClassName(original_package, xml::kSchemaAndroid, "targetActivity", child_el);
595 }
596 }
597 }
598 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700599 return true;
Adam Lesinski52364f72016-01-11 13:10:24 -0800600}
601
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700602bool ManifestFixer::Consume(IAaptContext* context, xml::XmlResource* doc) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800603 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700604 xml::Element* root = xml::FindRootElement(doc->root.get());
605 if (!root || !root->namespace_uri.empty() || root->name != "manifest") {
606 context->GetDiagnostics()->Error(DiagMessage(doc->file.source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700607 << "root tag must be <manifest>");
608 return false;
609 }
Adam Lesinski2ae4a872015-11-02 16:10:55 -0800610
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800611 if ((options_.min_sdk_version_default || options_.target_sdk_version_default) &&
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700612 root->FindChild({}, "uses-sdk") == nullptr) {
Adam Lesinskie343eb12016-10-27 16:31:58 -0700613 // Auto insert a <uses-sdk> element. This must be inserted before the
614 // <application> tag. The device runtime PackageParser will make SDK version
615 // decisions while parsing <application>.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700616 std::unique_ptr<xml::Element> uses_sdk = util::make_unique<xml::Element>();
617 uses_sdk->name = "uses-sdk";
Adam Lesinskie343eb12016-10-27 16:31:58 -0700618 root->InsertChild(0, std::move(uses_sdk));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700619 }
Adam Lesinski2ae4a872015-11-02 16:10:55 -0800620
Adam Lesinskic6284372017-12-04 13:46:23 -0800621 if (options_.compile_sdk_version) {
622 xml::Attribute* attr = root->FindOrCreateAttribute(xml::kSchemaAndroid, "compileSdkVersion");
623
624 // Make sure we un-compile the value if it was set to something else.
625 attr->compiled_value = {};
Adam Lesinskic6284372017-12-04 13:46:23 -0800626 attr->value = options_.compile_sdk_version.value();
Ryan Mitchellaada89c2019-02-12 08:06:26 -0800627
628 attr = root->FindOrCreateAttribute("", "platformBuildVersionCode");
629
630 // Make sure we un-compile the value if it was set to something else.
631 attr->compiled_value = {};
632 attr->value = options_.compile_sdk_version.value();
633
Adam Lesinskic6284372017-12-04 13:46:23 -0800634 }
635
636 if (options_.compile_sdk_version_codename) {
637 xml::Attribute* attr =
638 root->FindOrCreateAttribute(xml::kSchemaAndroid, "compileSdkVersionCodename");
639
640 // Make sure we un-compile the value if it was set to something else.
641 attr->compiled_value = {};
Ryan Mitchellaada89c2019-02-12 08:06:26 -0800642 attr->value = options_.compile_sdk_version_codename.value();
Adam Lesinskic6284372017-12-04 13:46:23 -0800643
Ryan Mitchellaada89c2019-02-12 08:06:26 -0800644 attr = root->FindOrCreateAttribute("", "platformBuildVersionName");
645
646 // Make sure we un-compile the value if it was set to something else.
647 attr->compiled_value = {};
Adam Lesinskic6284372017-12-04 13:46:23 -0800648 attr->value = options_.compile_sdk_version_codename.value();
649 }
650
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700651 xml::XmlActionExecutor executor;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700652 if (!BuildRules(&executor, context->GetDiagnostics())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700653 return false;
654 }
Adam Lesinskicc5609d2016-04-05 12:41:07 -0700655
Izabela Orlowskaad9e1322017-12-19 16:22:42 +0000656 xml::XmlActionExecutorPolicy policy = options_.warn_validation
Ryan Mitchell4ea90752020-07-31 08:21:43 -0700657 ? xml::XmlActionExecutorPolicy::kAllowListWarning
658 : xml::XmlActionExecutorPolicy::kAllowList;
Izabela Orlowskaad9e1322017-12-19 16:22:42 +0000659 if (!executor.Execute(policy, context->GetDiagnostics(), doc)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700660 return false;
661 }
Adam Lesinskicc5609d2016-04-05 12:41:07 -0700662
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700663 if (options_.rename_manifest_package) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700664 // Rename manifest package outside of the XmlActionExecutor.
Adam Lesinskie343eb12016-10-27 16:31:58 -0700665 // We need to extract the old package name and FullyQualify all class
666 // names.
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800667 if (!RenameManifestPackage(options_.rename_manifest_package.value(), root)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700668 return false;
Adam Lesinskicc5609d2016-04-05 12:41:07 -0700669 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700670 }
671 return true;
Adam Lesinski2ae4a872015-11-02 16:10:55 -0800672}
673
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700674} // namespace aapt