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
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "ResourceUtils.h"
#include "link/ManifestFixer.h"
#include "util/Util.h"
#include "xml/XmlActionExecutor.h"
#include "xml/XmlDom.h"
namespace aapt {
/**
* This is how PackageManager builds class names from AndroidManifest.xml entries.
*/
static bool nameIsJavaClassName(xml::Element* el, xml::Attribute* attr,
SourcePathDiagnostics* diag) {
std::u16string className = attr->value;
if (className.find(u'.') == std::u16string::npos) {
// There is no '.', so add one to the beginning.
className = u".";
className += attr->value;
}
// We allow unqualified class names (ie: .HelloActivity)
// Since we don't know the package name, we can just make a fake one here and
// the test will be identical as long as the real package name is valid too.
Maybe<std::u16string> fullyQualifiedClassName =
util::getFullyQualifiedClassName(u"a", className);
StringPiece16 qualifiedClassName = fullyQualifiedClassName
? fullyQualifiedClassName.value() : className;
if (!util::isJavaClassName(qualifiedClassName)) {
diag->error(DiagMessage(el->lineNumber)
<< "attribute 'android:name' in <"
<< el->name << "> tag must be a valid Java class name");
return false;
}
return true;
}
static bool optionalNameIsJavaClassName(xml::Element* el, SourcePathDiagnostics* diag) {
if (xml::Attribute* attr = el->findAttribute(xml::kSchemaAndroid, u"name")) {
return nameIsJavaClassName(el, attr, diag);
}
return true;
}
static bool requiredNameIsJavaClassName(xml::Element* el, SourcePathDiagnostics* diag) {
if (xml::Attribute* attr = el->findAttribute(xml::kSchemaAndroid, u"name")) {
return nameIsJavaClassName(el, attr, diag);
}
diag->error(DiagMessage(el->lineNumber)
<< "<" << el->name << "> is missing attribute 'android:name'");
return false;
}
static bool verifyManifest(xml::Element* el, SourcePathDiagnostics* diag) {
xml::Attribute* attr = el->findAttribute({}, u"package");
if (!attr) {
diag->error(DiagMessage(el->lineNumber) << "<manifest> tag is missing 'package' attribute");
return false;
} else if (ResourceUtils::isReference(attr->value)) {
diag->error(DiagMessage(el->lineNumber)
<< "attribute 'package' in <manifest> tag must not be a reference");
return false;
} else if (!util::isJavaPackageName(attr->value)) {
diag->error(DiagMessage(el->lineNumber)
<< "attribute 'package' in <manifest> tag is not a valid Java package name: '"
<< attr->value << "'");
return false;
}
return true;
}
bool ManifestFixer::buildRules(xml::XmlActionExecutor* executor, IDiagnostics* diag) {
// First verify some options.
if (mOptions.renameManifestPackage) {
if (!util::isJavaPackageName(mOptions.renameManifestPackage.value())) {
diag->error(DiagMessage() << "invalid manifest package override '"
<< mOptions.renameManifestPackage.value() << "'");
return false;
}
}
if (mOptions.renameInstrumentationTargetPackage) {
if (!util::isJavaPackageName(mOptions.renameInstrumentationTargetPackage.value())) {
diag->error(DiagMessage() << "invalid instrumentation target package override '"
<< mOptions.renameInstrumentationTargetPackage.value() << "'");
return false;
}
}
// Common intent-filter actions.
xml::XmlNodeAction intentFilterAction;
intentFilterAction[u"action"];
intentFilterAction[u"category"];
intentFilterAction[u"data"];
// Common meta-data actions.
xml::XmlNodeAction metaDataAction;
// Manifest actions.
xml::XmlNodeAction& manifestAction = (*executor)[u"manifest"];
manifestAction.action(verifyManifest);
manifestAction.action([&](xml::Element* el) -> bool {
if (mOptions.versionNameDefault) {
if (el->findAttribute(xml::kSchemaAndroid, u"versionName") == nullptr) {
el->attributes.push_back(xml::Attribute{
xml::kSchemaAndroid,
u"versionName",
mOptions.versionNameDefault.value() });
}
}
if (mOptions.versionCodeDefault) {
if (el->findAttribute(xml::kSchemaAndroid, u"versionCode") == nullptr) {
el->attributes.push_back(xml::Attribute{
xml::kSchemaAndroid,
u"versionCode",
mOptions.versionCodeDefault.value() });
}
}
return true;
});
// Meta tags.
manifestAction[u"eat-comment"];
// Uses-sdk actions.
manifestAction[u"uses-sdk"].action([&](xml::Element* el) -> bool {
if (mOptions.minSdkVersionDefault &&
el->findAttribute(xml::kSchemaAndroid, u"minSdkVersion") == nullptr) {
// There was no minSdkVersion defined and we have a default to assign.
el->attributes.push_back(xml::Attribute{
xml::kSchemaAndroid, u"minSdkVersion",
mOptions.minSdkVersionDefault.value() });
}
if (mOptions.targetSdkVersionDefault &&
el->findAttribute(xml::kSchemaAndroid, u"targetSdkVersion") == nullptr) {
// There was no targetSdkVersion defined and we have a default to assign.
el->attributes.push_back(xml::Attribute{
xml::kSchemaAndroid, u"targetSdkVersion",
mOptions.targetSdkVersionDefault.value() });
}
return true;
});
// Instrumentation actions.
manifestAction[u"instrumentation"].action([&](xml::Element* el) -> bool {
if (!mOptions.renameInstrumentationTargetPackage) {
return true;
}
if (xml::Attribute* attr = el->findAttribute(xml::kSchemaAndroid, u"targetPackage")) {
attr->value = mOptions.renameInstrumentationTargetPackage.value();
}
return true;
});
manifestAction[u"original-package"];
manifestAction[u"protected-broadcast"];
manifestAction[u"uses-permission"];
manifestAction[u"permission"];
manifestAction[u"permission-tree"];
manifestAction[u"permission-group"];
manifestAction[u"uses-configuration"];
manifestAction[u"uses-feature"];
manifestAction[u"uses-library"];
manifestAction[u"supports-screens"];
manifestAction[u"compatible-screens"];
manifestAction[u"supports-gl-texture"];
// Application actions.
xml::XmlNodeAction& applicationAction = (*executor)[u"manifest"][u"application"];
applicationAction.action(optionalNameIsJavaClassName);
// Activity actions.
applicationAction[u"activity"].action(requiredNameIsJavaClassName);
applicationAction[u"activity"][u"intent-filter"] = intentFilterAction;
applicationAction[u"activity"][u"meta-data"] = metaDataAction;
// Activity alias actions.
applicationAction[u"activity-alias"][u"intent-filter"] = intentFilterAction;
applicationAction[u"activity-alias"][u"meta-data"] = metaDataAction;
// Service actions.
applicationAction[u"service"].action(requiredNameIsJavaClassName);
applicationAction[u"service"][u"intent-filter"] = intentFilterAction;
applicationAction[u"service"][u"meta-data"] = metaDataAction;
// Receiver actions.
applicationAction[u"receiver"].action(requiredNameIsJavaClassName);
applicationAction[u"receiver"][u"intent-filter"] = intentFilterAction;
applicationAction[u"receiver"][u"meta-data"] = metaDataAction;
// Provider actions.
applicationAction[u"provider"].action(requiredNameIsJavaClassName);
applicationAction[u"provider"][u"grant-uri-permissions"];
applicationAction[u"provider"][u"meta-data"] = metaDataAction;
applicationAction[u"provider"][u"path-permissions"];
return true;
}
class FullyQualifiedClassNameVisitor : public xml::Visitor {
public:
using xml::Visitor::visit;
FullyQualifiedClassNameVisitor(const StringPiece16& package) : mPackage(package) {
}
void visit(xml::Element* el) override {
for (xml::Attribute& attr : el->attributes) {
if (Maybe<std::u16string> newValue =
util::getFullyQualifiedClassName(mPackage, attr.value)) {
attr.value = std::move(newValue.value());
}
}
// Super implementation to iterate over the children.
xml::Visitor::visit(el);
}
private:
StringPiece16 mPackage;
};
static bool renameManifestPackage(const StringPiece16& packageOverride, xml::Element* manifestEl) {
xml::Attribute* attr = manifestEl->findAttribute({}, u"package");
// We've already verified that the manifest element is present, with a package name specified.
assert(attr);
std::u16string originalPackage = std::move(attr->value);
attr->value = packageOverride.toString();
FullyQualifiedClassNameVisitor visitor(originalPackage);
manifestEl->accept(&visitor);
return true;
}
bool ManifestFixer::consume(IAaptContext* context, xml::XmlResource* doc) {
xml::Element* root = xml::findRootElement(doc->root.get());
if (!root || !root->namespaceUri.empty() || root->name != u"manifest") {
context->getDiagnostics()->error(DiagMessage(doc->file.source)
<< "root tag must be <manifest>");
return false;
}
if ((mOptions.minSdkVersionDefault || mOptions.targetSdkVersionDefault)
&& root->findChild({}, u"uses-sdk") == nullptr) {
// Auto insert a <uses-sdk> element.
std::unique_ptr<xml::Element> usesSdk = util::make_unique<xml::Element>();
usesSdk->name = u"uses-sdk";
root->addChild(std::move(usesSdk));
}
xml::XmlActionExecutor executor;
if (!buildRules(&executor, context->getDiagnostics())) {
return false;
}
if (!executor.execute(xml::XmlActionExecutorPolicy::Whitelist, context->getDiagnostics(),
doc)) {
return false;
}
if (mOptions.renameManifestPackage) {
// Rename manifest package outside of the XmlActionExecutor.
// We need to extract the old package name and FullyQualify all class names.
if (!renameManifestPackage(mOptions.renameManifestPackage.value(), root)) {
return false;
}
}
return true;
}
} // namespace aapt
|