blob: 0befb6ff7c9d4df81b9838a2a5831558f40521cd [file] [log] [blame]
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001/*
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
Ryan Mitchell833a1a62018-07-10 13:51:36 -070017#include "Link.h"
18
Adam Lesinskice5e56e2016-10-21 17:56:45 -070019#include <sys/stat.h>
Adam Lesinskic6284372017-12-04 13:46:23 -080020#include <cinttypes>
Adam Lesinskice5e56e2016-10-21 17:56:45 -070021
Mohamed Heikald3c5fb62018-01-12 11:37:26 -050022#include <algorithm>
Adam Lesinskice5e56e2016-10-21 17:56:45 -070023#include <queue>
24#include <unordered_map>
25#include <vector>
26
27#include "android-base/errors.h"
28#include "android-base/file.h"
Adam Lesinskif34b6f42017-03-03 16:33:26 -080029#include "android-base/stringprintf.h"
Mårten Kongstad24c9aa62018-06-20 08:46:41 +020030#include "androidfw/Locale.h"
Adam Lesinskid5083f62017-01-16 15:07:21 -080031#include "androidfw/StringPiece.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070032
Adam Lesinski1ab598f2015-08-14 14:26:04 -070033#include "AppInfo.h"
34#include "Debug.h"
Adam Lesinski8780eb62017-10-31 17:44:39 -070035#include "LoadedApk.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070036#include "NameMangler.h"
Adam Lesinski59e04c62016-02-04 15:59:23 -080037#include "ResourceUtils.h"
Adam Lesinskid3ffa8442017-09-28 13:34:35 -070038#include "ResourceValues.h"
39#include "ValueVisitor.h"
Adam Lesinskid0f492d2017-04-03 18:12:45 -070040#include "cmd/Util.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070041#include "compile/IdAssigner.h"
Adam Lesinski2427dce2017-11-30 15:10:28 -080042#include "compile/XmlIdCollector.h"
Adam Lesinski6a008172016-02-02 17:02:58 -080043#include "filter/ConfigFilter.h"
Adam Lesinski46708052017-09-29 14:49:15 -070044#include "format/Archive.h"
Adam Lesinski00451162017-10-03 07:44:08 -070045#include "format/Container.h"
Adam Lesinski46708052017-09-29 14:49:15 -070046#include "format/binary/TableFlattener.h"
47#include "format/binary/XmlFlattener.h"
48#include "format/proto/ProtoDeserialize.h"
49#include "format/proto/ProtoSerialize.h"
Adam Lesinski00451162017-10-03 07:44:08 -070050#include "io/BigBufferStream.h"
51#include "io/FileStream.h"
Adam Lesinskia40e9722015-11-24 19:11:46 -080052#include "io/FileSystem.h"
Adam Lesinskid0f492d2017-04-03 18:12:45 -070053#include "io/Util.h"
Adam Lesinskia40e9722015-11-24 19:11:46 -080054#include "io/ZipArchive.h"
Adam Lesinskica5638f2015-10-21 14:42:43 -070055#include "java/JavaClassGenerator.h"
56#include "java/ManifestClassGenerator.h"
57#include "java/ProguardRules.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070058#include "link/Linkers.h"
Adam Lesinskicacb28f2016-10-19 12:18:14 -070059#include "link/ManifestFixer.h"
Adam Lesinski34a16872018-02-23 16:18:10 -080060#include "link/NoDefaultResourceRemover.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080061#include "link/ReferenceLinker.h"
Winson3c918b82019-01-25 14:25:37 -080062#include "link/ResourceExcluder.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070063#include "link/TableMerger.h"
Adam Lesinskic744ae82017-05-17 19:28:38 -070064#include "link/XmlCompatVersioner.h"
Adam Lesinskid48944a2017-02-21 14:22:30 -080065#include "optimize/ResourceDeduper.h"
66#include "optimize/VersionCollapser.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070067#include "process/IResourceTableConsumer.h"
68#include "process/SymbolTable.h"
Adam Lesinski355f2852016-02-13 20:26:45 -080069#include "split/TableSplitter.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070070#include "util/Files.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080071#include "xml/XmlDom.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070072
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070073using ::aapt::io::FileInputStream;
Mårten Kongstad24c9aa62018-06-20 08:46:41 +020074using ::android::ConfigDescription;
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070075using ::android::StringPiece;
76using ::android::base::StringPrintf;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070077
Adam Lesinski1ab598f2015-08-14 14:26:04 -070078namespace aapt {
79
Adam Lesinski64587af2016-02-18 18:33:06 -080080class LinkContext : public IAaptContext {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070081 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -080082 explicit LinkContext(IDiagnostics* diagnostics)
Chris Warrington820d72a2017-04-27 15:27:01 +010083 : diagnostics_(diagnostics), name_mangler_({}), symbols_(&name_mangler_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -070084 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070085
Adam Lesinskib522f042017-04-21 16:57:59 -070086 PackageType GetPackageType() override {
87 return package_type_;
88 }
89
90 void SetPackageType(PackageType type) {
91 package_type_ = type;
92 }
93
Adam Lesinskid0f492d2017-04-03 18:12:45 -070094 IDiagnostics* GetDiagnostics() override {
Chris Warrington820d72a2017-04-27 15:27:01 +010095 return diagnostics_;
Adam Lesinskid0f492d2017-04-03 18:12:45 -070096 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070097
Adam Lesinskid0f492d2017-04-03 18:12:45 -070098 NameMangler* GetNameMangler() override {
99 return &name_mangler_;
100 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700101
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700102 void SetNameManglerPolicy(const NameManglerPolicy& policy) {
103 name_mangler_ = NameMangler(policy);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700104 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800105
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700106 const std::string& GetCompilationPackage() override {
107 return compilation_package_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700108 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700109
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700110 void SetCompilationPackage(const StringPiece& package_name) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800111 compilation_package_ = package_name.to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700112 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800113
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700114 uint8_t GetPackageId() override {
115 return package_id_;
116 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700117
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700118 void SetPackageId(uint8_t id) {
119 package_id_ = id;
120 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800121
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700122 SymbolTable* GetExternalSymbols() override {
123 return &symbols_;
124 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800125
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700126 bool IsVerbose() override {
127 return verbose_;
128 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800129
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700130 void SetVerbose(bool val) {
131 verbose_ = val;
132 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800133
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700134 int GetMinSdkVersion() override {
135 return min_sdk_version_;
136 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700137
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700138 void SetMinSdkVersion(int minSdk) {
139 min_sdk_version_ = minSdk;
140 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700141
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700142 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700143 DISALLOW_COPY_AND_ASSIGN(LinkContext);
144
Adam Lesinskib522f042017-04-21 16:57:59 -0700145 PackageType package_type_ = PackageType::kApp;
Chris Warrington820d72a2017-04-27 15:27:01 +0100146 IDiagnostics* diagnostics_;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700147 NameMangler name_mangler_;
148 std::string compilation_package_;
149 uint8_t package_id_ = 0x0;
150 SymbolTable symbols_;
151 bool verbose_ = false;
152 int min_sdk_version_ = 0;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700153};
154
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700155// A custom delegate that generates compatible pre-O IDs for use with feature splits.
156// Feature splits use package IDs > 7f, which in Java (since Java doesn't have unsigned ints)
157// is interpreted as a negative number. Some verification was wrongly assuming negative values
158// were invalid.
159//
160// This delegate will attempt to masquerade any '@id/' references with ID 0xPPTTEEEE,
161// where PP > 7f, as 0x7fPPEEEE. Any potential overlapping is verified and an error occurs if such
162// an overlap exists.
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800163//
164// See b/37498913.
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700165class FeatureSplitSymbolTableDelegate : public DefaultSymbolTableDelegate {
166 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -0800167 explicit FeatureSplitSymbolTableDelegate(IAaptContext* context) : context_(context) {
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700168 }
169
170 virtual ~FeatureSplitSymbolTableDelegate() = default;
171
172 virtual std::unique_ptr<SymbolTable::Symbol> FindByName(
173 const ResourceName& name,
174 const std::vector<std::unique_ptr<ISymbolSource>>& sources) override {
175 std::unique_ptr<SymbolTable::Symbol> symbol =
176 DefaultSymbolTableDelegate::FindByName(name, sources);
177 if (symbol == nullptr) {
178 return {};
179 }
180
181 // Check to see if this is an 'id' with the target package.
182 if (name.type == ResourceType::kId && symbol->id) {
183 ResourceId* id = &symbol->id.value();
184 if (id->package_id() > kAppPackageId) {
185 // Rewrite the resource ID to be compatible pre-O.
186 ResourceId rewritten_id(kAppPackageId, id->package_id(), id->entry_id());
187
188 // Check that this doesn't overlap another resource.
189 if (DefaultSymbolTableDelegate::FindById(rewritten_id, sources) != nullptr) {
190 // The ID overlaps, so log a message (since this is a weird failure) and fail.
191 context_->GetDiagnostics()->Error(DiagMessage() << "Failed to rewrite " << name
192 << " for pre-O feature split support");
193 return {};
194 }
195
196 if (context_->IsVerbose()) {
197 context_->GetDiagnostics()->Note(DiagMessage() << "rewriting " << name << " (" << *id
198 << ") -> (" << rewritten_id << ")");
199 }
200
201 *id = rewritten_id;
202 }
203 }
204 return symbol;
205 }
206
207 private:
208 DISALLOW_COPY_AND_ASSIGN(FeatureSplitSymbolTableDelegate);
209
210 IAaptContext* context_;
211};
212
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700213static bool FlattenXml(IAaptContext* context, const xml::XmlResource& xml_res,
214 const StringPiece& path, bool keep_raw_values, bool utf16,
215 OutputFormat format, IArchiveWriter* writer) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700216 if (context->IsVerbose()) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700217 context->GetDiagnostics()->Note(DiagMessage(path) << "writing to archive (keep_raw_values="
218 << (keep_raw_values ? "true" : "false")
219 << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700220 }
221
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700222 switch (format) {
223 case OutputFormat::kApk: {
224 BigBuffer buffer(1024);
225 XmlFlattenerOptions options = {};
226 options.keep_raw_values = keep_raw_values;
227 options.use_utf16 = utf16;
228 XmlFlattener flattener(&buffer, options);
229 if (!flattener.Consume(context, &xml_res)) {
230 return false;
231 }
232
233 io::BigBufferInputStream input_stream(&buffer);
234 return io::CopyInputStreamToArchive(context, &input_stream, path.to_string(),
235 ArchiveEntry::kCompress, writer);
236 } break;
237
238 case OutputFormat::kProto: {
239 pb::XmlNode pb_node;
Ryan Mitchell467b6892018-11-09 15:52:07 -0800240 // Strip whitespace text nodes from tha AndroidManifest.xml
241 SerializeXmlOptions options;
242 options.remove_empty_text_nodes = (path == kAndroidManifestPath);
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700243 SerializeXmlResourceToPb(xml_res, &pb_node);
244 return io::CopyProtoToArchive(context, &pb_node, path.to_string(), ArchiveEntry::kCompress,
245 writer);
246 } break;
247 }
248 return false;
Adam Lesinski355f2852016-02-13 20:26:45 -0800249}
250
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700251// Inflates an XML file from the source path.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700252static std::unique_ptr<xml::XmlResource> LoadXml(const std::string& path, IDiagnostics* diag) {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700253 FileInputStream fin(path);
254 if (fin.HadError()) {
255 diag->Error(DiagMessage(path) << "failed to load XML file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700256 return {};
257 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700258 return xml::Inflate(&fin, diag, Source(path));
Adam Lesinski355f2852016-02-13 20:26:45 -0800259}
260
Adam Lesinski355f2852016-02-13 20:26:45 -0800261struct ResourceFileFlattenerOptions {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700262 bool no_auto_version = false;
263 bool no_version_vectors = false;
Yuichi Araki4d35cca2017-01-18 20:42:17 +0900264 bool no_version_transitions = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700265 bool no_xml_namespaces = false;
266 bool keep_raw_values = false;
267 bool do_not_compress_anything = false;
268 bool update_proguard_spec = false;
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700269 OutputFormat output_format = OutputFormat::kApk;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700270 std::unordered_set<std::string> extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100271 Maybe<std::regex> regex_to_not_compress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800272};
273
Adam Lesinskic744ae82017-05-17 19:28:38 -0700274// A sampling of public framework resource IDs.
275struct R {
276 struct attr {
277 enum : uint32_t {
278 paddingLeft = 0x010100d6u,
279 paddingRight = 0x010100d8u,
280 paddingHorizontal = 0x0101053du,
281
282 paddingTop = 0x010100d7u,
283 paddingBottom = 0x010100d9u,
284 paddingVertical = 0x0101053eu,
285
286 layout_marginLeft = 0x010100f7u,
287 layout_marginRight = 0x010100f9u,
288 layout_marginHorizontal = 0x0101053bu,
289
290 layout_marginTop = 0x010100f8u,
291 layout_marginBottom = 0x010100fau,
292 layout_marginVertical = 0x0101053cu,
293 };
294 };
295};
296
Adam Lesinski355f2852016-02-13 20:26:45 -0800297class ResourceFileFlattener {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700298 public:
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700299 ResourceFileFlattener(const ResourceFileFlattenerOptions& options, IAaptContext* context,
Adam Lesinskic744ae82017-05-17 19:28:38 -0700300 proguard::KeepSet* keep_set);
Adam Lesinski355f2852016-02-13 20:26:45 -0800301
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700302 bool Flatten(ResourceTable* table, IArchiveWriter* archive_writer);
Adam Lesinski355f2852016-02-13 20:26:45 -0800303
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700304 private:
305 struct FileOperation {
306 ConfigDescription config;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700307
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700308 // The entry this file came from.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700309 ResourceEntry* entry;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700310
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700311 // The file to copy as-is.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700312 io::IFile* file_to_copy;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700313
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700314 // The XML to process and flatten.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700315 std::unique_ptr<xml::XmlResource> xml_to_flatten;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700316
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700317 // The destination to write this file to.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700318 std::string dst_path;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700319 };
Adam Lesinski355f2852016-02-13 20:26:45 -0800320
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700321 uint32_t GetCompressionFlags(const StringPiece& str);
Adam Lesinski355f2852016-02-13 20:26:45 -0800322
Adam Lesinskic744ae82017-05-17 19:28:38 -0700323 std::vector<std::unique_ptr<xml::XmlResource>> LinkAndVersionXmlFile(ResourceTable* table,
324 FileOperation* file_op);
Adam Lesinski355f2852016-02-13 20:26:45 -0800325
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700326 ResourceFileFlattenerOptions options_;
327 IAaptContext* context_;
328 proguard::KeepSet* keep_set_;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700329 XmlCompatVersioner::Rules rules_;
Adam Lesinski355f2852016-02-13 20:26:45 -0800330};
331
Adam Lesinskic744ae82017-05-17 19:28:38 -0700332ResourceFileFlattener::ResourceFileFlattener(const ResourceFileFlattenerOptions& options,
333 IAaptContext* context, proguard::KeepSet* keep_set)
334 : options_(options), context_(context), keep_set_(keep_set) {
335 SymbolTable* symm = context_->GetExternalSymbols();
336
337 // Build up the rules for degrading newer attributes to older ones.
338 // NOTE(adamlesinski): These rules are hardcoded right now, but they should be
339 // generated from the attribute definitions themselves (b/62028956).
340 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingHorizontal)) {
341 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800342 {"paddingLeft", R::attr::paddingLeft, Attribute(android::ResTable_map::TYPE_DIMENSION)},
343 {"paddingRight", R::attr::paddingRight, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700344 };
345 rules_[R::attr::paddingHorizontal] =
346 util::make_unique<DegradeToManyRule>(std::move(replacements));
347 }
348
349 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingVertical)) {
350 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800351 {"paddingTop", R::attr::paddingTop, Attribute(android::ResTable_map::TYPE_DIMENSION)},
352 {"paddingBottom", R::attr::paddingBottom, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700353 };
354 rules_[R::attr::paddingVertical] =
355 util::make_unique<DegradeToManyRule>(std::move(replacements));
356 }
357
358 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginHorizontal)) {
359 std::vector<ReplacementAttr> replacements{
360 {"layout_marginLeft", R::attr::layout_marginLeft,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800361 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700362 {"layout_marginRight", R::attr::layout_marginRight,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800363 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700364 };
365 rules_[R::attr::layout_marginHorizontal] =
366 util::make_unique<DegradeToManyRule>(std::move(replacements));
367 }
368
369 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginVertical)) {
370 std::vector<ReplacementAttr> replacements{
371 {"layout_marginTop", R::attr::layout_marginTop,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800372 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700373 {"layout_marginBottom", R::attr::layout_marginBottom,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800374 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700375 };
376 rules_[R::attr::layout_marginVertical] =
377 util::make_unique<DegradeToManyRule>(std::move(replacements));
378 }
379}
380
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100381// TODO(rtmitchell): turn this function into a variable that points to a method that retrieves the
382// compression flag
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700383uint32_t ResourceFileFlattener::GetCompressionFlags(const StringPiece& str) {
384 if (options_.do_not_compress_anything) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700385 return 0;
386 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800387
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100388 if (options_.regex_to_not_compress
389 && std::regex_search(str.to_string(), options_.regex_to_not_compress.value())) {
390 return 0;
391 }
392
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700393 for (const std::string& extension : options_.extensions_to_not_compress) {
394 if (util::EndsWith(str, extension)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700395 return 0;
Adam Lesinski355f2852016-02-13 20:26:45 -0800396 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700397 }
398 return ArchiveEntry::kCompress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800399}
400
Adam Lesinskibb94f322017-07-12 07:41:55 -0700401static bool IsTransitionElement(const std::string& name) {
402 return name == "fade" || name == "changeBounds" || name == "slide" || name == "explode" ||
403 name == "changeImageTransform" || name == "changeTransform" ||
404 name == "changeClipBounds" || name == "autoTransition" || name == "recolor" ||
405 name == "changeScroll" || name == "transitionSet" || name == "transition" ||
406 name == "transitionManager";
407}
408
409static bool IsVectorElement(const std::string& name) {
410 return name == "vector" || name == "animated-vector" || name == "pathInterpolator" ||
Nick Butchere78a8162018-01-09 15:24:21 +0000411 name == "objectAnimator" || name == "gradient" || name == "animated-selector";
Adam Lesinskibb94f322017-07-12 07:41:55 -0700412}
413
Adam Lesinskic744ae82017-05-17 19:28:38 -0700414template <typename T>
415std::vector<T> make_singleton_vec(T&& val) {
416 std::vector<T> vec;
417 vec.emplace_back(std::forward<T>(val));
418 return vec;
419}
420
421std::vector<std::unique_ptr<xml::XmlResource>> ResourceFileFlattener::LinkAndVersionXmlFile(
422 ResourceTable* table, FileOperation* file_op) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700423 xml::XmlResource* doc = file_op->xml_to_flatten.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700424 const Source& src = doc->file.source;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700425
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700426 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700427 context_->GetDiagnostics()->Note(DiagMessage()
428 << "linking " << src.path << " (" << doc->file.name << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700429 }
430
Adam Lesinski00451162017-10-03 07:44:08 -0700431 // First, strip out any tools namespace attributes. AAPT stripped them out early, which means
432 // that existing projects have out-of-date references which pass compilation.
433 xml::StripAndroidStudioAttributes(doc->root.get());
434
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700435 XmlReferenceLinker xml_linker;
436 if (!xml_linker.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700437 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700438 }
439
Ryan Mitchell9a2f6e62018-05-23 14:23:18 -0700440 if (options_.update_proguard_spec && !proguard::CollectProguardRules(context_, doc, keep_set_)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700441 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700442 }
443
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700444 if (options_.no_xml_namespaces) {
445 XmlNamespaceRemover namespace_remover;
446 if (!namespace_remover.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700447 return {};
Adam Lesinski355f2852016-02-13 20:26:45 -0800448 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700449 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800450
Adam Lesinskibb94f322017-07-12 07:41:55 -0700451 if (options_.no_auto_version) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700452 return make_singleton_vec(std::move(file_op->xml_to_flatten));
453 }
Alexandria Cornwalla7cc3f12016-08-16 13:33:32 -0700454
Adam Lesinskibb94f322017-07-12 07:41:55 -0700455 if (options_.no_version_vectors || options_.no_version_transitions) {
456 // Skip this if it is a vector or animated-vector.
Adam Lesinski6b372992017-08-09 10:54:23 -0700457 xml::Element* el = doc->root.get();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700458 if (el && el->namespace_uri.empty()) {
459 if ((options_.no_version_vectors && IsVectorElement(el->name)) ||
460 (options_.no_version_transitions && IsTransitionElement(el->name))) {
461 return make_singleton_vec(std::move(file_op->xml_to_flatten));
462 }
463 }
464 }
465
Adam Lesinskic744ae82017-05-17 19:28:38 -0700466 const ConfigDescription& config = file_op->config;
467 ResourceEntry* entry = file_op->entry;
468
469 XmlCompatVersioner xml_compat_versioner(&rules_);
470 const util::Range<ApiVersion> api_range{config.sdkVersion,
471 FindNextApiVersionForConfig(entry, config)};
472 return xml_compat_versioner.Process(context_, doc, api_range);
Adam Lesinski355f2852016-02-13 20:26:45 -0800473}
474
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800475ResourceFile::Type XmlFileTypeForOutputFormat(OutputFormat format) {
476 switch (format) {
477 case OutputFormat::kApk:
478 return ResourceFile::Type::kBinaryXml;
479 case OutputFormat::kProto:
480 return ResourceFile::Type::kProtoXml;
481 }
482 LOG_ALWAYS_FATAL("unreachable");
483 return ResourceFile::Type::kUnknown;
484}
485
Ryan Mitchell70f79722018-08-13 07:37:24 -0700486static auto kDrawableVersions = std::map<std::string, ApiVersion>{
487 { "adaptive-icon" , SDK_O },
488};
489
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700490bool ResourceFileFlattener::Flatten(ResourceTable* table, IArchiveWriter* archive_writer) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700491 bool error = false;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700492 std::map<std::pair<ConfigDescription, StringPiece>, FileOperation> config_sorted_files;
Adam Lesinski355f2852016-02-13 20:26:45 -0800493
Adam Koskidc21dea2017-07-21 10:55:27 -0700494 proguard::CollectResourceReferences(context_, table, keep_set_);
495
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700496 for (auto& pkg : table->packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700497 CHECK(!pkg->name.empty()) << "Packages must have names when being linked";
498
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700499 for (auto& type : pkg->types) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700500 // Sort by config and name, so that we get better locality in the zip file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700501 config_sorted_files.clear();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700502 std::queue<FileOperation> file_operations;
Adam Lesinski355f2852016-02-13 20:26:45 -0800503
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700504 // Populate the queue with all files in the ResourceTable.
505 for (auto& entry : type->entries) {
Adam Lesinskibb94f322017-07-12 07:41:55 -0700506 for (auto& config_value : entry->values) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700507 // WARNING! Do not insert or remove any resources while executing in this scope. It will
508 // corrupt the iteration order.
509
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700510 FileReference* file_ref = ValueCast<FileReference>(config_value->value.get());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700511 if (!file_ref) {
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700512 continue;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700513 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700514
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700515 io::IFile* file = file_ref->file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700516 if (!file) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700517 context_->GetDiagnostics()->Error(DiagMessage(file_ref->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700518 << "file not found");
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700519 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700520 }
521
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700522 FileOperation file_op;
523 file_op.entry = entry.get();
524 file_op.dst_path = *file_ref->path;
525 file_op.config = config_value->config;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700526 file_op.file_to_copy = file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700527
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700528 if (type->type != ResourceType::kRaw &&
Adam Lesinski00451162017-10-03 07:44:08 -0700529 (file_ref->type == ResourceFile::Type::kBinaryXml ||
530 file_ref->type == ResourceFile::Type::kProtoXml)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700531 std::unique_ptr<io::IData> data = file->OpenAsData();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700532 if (!data) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700533 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700534 << "failed to open file");
535 return false;
536 }
537
Adam Lesinski00451162017-10-03 07:44:08 -0700538 if (file_ref->type == ResourceFile::Type::kProtoXml) {
539 pb::XmlNode pb_xml_node;
540 if (!pb_xml_node.ParseFromArray(data->data(), static_cast<int>(data->size()))) {
541 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700542 << "failed to parse proto XML");
Adam Lesinski00451162017-10-03 07:44:08 -0700543 return false;
544 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700545
Adam Lesinski00451162017-10-03 07:44:08 -0700546 std::string error;
547 file_op.xml_to_flatten = DeserializeXmlResourceFromPb(pb_xml_node, &error);
548 if (file_op.xml_to_flatten == nullptr) {
549 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700550 << "failed to deserialize proto XML: " << error);
Adam Lesinski00451162017-10-03 07:44:08 -0700551 return false;
552 }
553 } else {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700554 std::string error_str;
555 file_op.xml_to_flatten = xml::Inflate(data->data(), data->size(), &error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700556 if (file_op.xml_to_flatten == nullptr) {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700557 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
558 << "failed to parse binary XML: " << error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700559 return false;
560 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700561 }
562
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800563 // Update the type that this file will be written as.
564 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
565
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700566 file_op.xml_to_flatten->file.config = config_value->config;
567 file_op.xml_to_flatten->file.source = file_ref->GetSource();
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700568 file_op.xml_to_flatten->file.name = ResourceName(pkg->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700569 }
Adam Lesinskic744ae82017-05-17 19:28:38 -0700570
571 // NOTE(adamlesinski): Explicitly construct a StringPiece here, or
572 // else we end up copying the string in the std::make_pair() method,
573 // then creating a StringPiece from the copy, which would cause us
574 // to end up referencing garbage in the map.
575 const StringPiece entry_name(entry->name);
576 config_sorted_files[std::make_pair(config_value->config, entry_name)] =
577 std::move(file_op);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700578 }
579 }
580
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700581 // Now flatten the sorted values.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700582 for (auto& map_entry : config_sorted_files) {
583 const ConfigDescription& config = map_entry.first.first;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700584 FileOperation& file_op = map_entry.second;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700585
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700586 if (file_op.xml_to_flatten) {
Ryan Mitchell70f79722018-08-13 07:37:24 -0700587 // Check minimum sdk versions supported for drawables
588 auto drawable_entry = kDrawableVersions.find(file_op.xml_to_flatten->root->name);
589 if (drawable_entry != kDrawableVersions.end()) {
590 if (drawable_entry->second > context_->GetMinSdkVersion()
591 && drawable_entry->second > config.sdkVersion) {
592 context_->GetDiagnostics()->Error(DiagMessage(file_op.xml_to_flatten->file.source)
593 << "<" << drawable_entry->first << "> elements "
594 << "require a sdk version of at least "
595 << (int16_t) drawable_entry->second);
596 error = true;
597 continue;
598 }
599 }
600
Adam Lesinskic744ae82017-05-17 19:28:38 -0700601 std::vector<std::unique_ptr<xml::XmlResource>> versioned_docs =
602 LinkAndVersionXmlFile(table, &file_op);
Adam Lesinskic0a5e1e2017-08-07 11:56:32 -0700603 if (versioned_docs.empty()) {
604 error = true;
605 continue;
606 }
607
Adam Lesinskic744ae82017-05-17 19:28:38 -0700608 for (std::unique_ptr<xml::XmlResource>& doc : versioned_docs) {
609 std::string dst_path = file_op.dst_path;
610 if (doc->file.config != file_op.config) {
611 // Only add the new versioned configurations.
612 if (context_->IsVerbose()) {
613 context_->GetDiagnostics()->Note(DiagMessage(doc->file.source)
614 << "auto-versioning resource from config '"
615 << config << "' -> '" << doc->file.config << "'");
616 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700617
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800618 const ResourceFile& file = doc->file;
619 dst_path = ResourceUtils::BuildResourceFileName(file, context_->GetNameMangler());
620
621 std::unique_ptr<FileReference> file_ref =
622 util::make_unique<FileReference>(table->string_pool.MakeRef(dst_path));
623 file_ref->SetSource(doc->file.source);
624 // Update the output format of this XML file.
625 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
626 if (!table->AddResourceMangled(file.name, file.config, {}, std::move(file_ref),
627 context_->GetDiagnostics())) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700628 return false;
629 }
630 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700631
632 error |= !FlattenXml(context_, *doc, dst_path, options_.keep_raw_values,
633 false /*utf16*/, options_.output_format, archive_writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700634 }
635 } else {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700636 error |= !io::CopyFileToArchive(context_, file_op.file_to_copy, file_op.dst_path,
637 GetCompressionFlags(file_op.dst_path), archive_writer);
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700638 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700639 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700640 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700641 }
642 return !error;
643}
644
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700645static bool WriteStableIdMapToPath(IDiagnostics* diag,
646 const std::unordered_map<ResourceName, ResourceId>& id_map,
647 const std::string& id_map_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800648 io::FileOutputStream fout(id_map_path);
649 if (fout.HadError()) {
650 diag->Error(DiagMessage(id_map_path) << "failed to open: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700651 return false;
652 }
653
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800654 text::Printer printer(&fout);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700655 for (const auto& entry : id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700656 const ResourceName& name = entry.first;
657 const ResourceId& id = entry.second;
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800658 printer.Print(name.to_string());
659 printer.Print(" = ");
660 printer.Println(id.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700661 }
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800662 fout.Flush();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700663
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800664 if (fout.HadError()) {
665 diag->Error(DiagMessage(id_map_path) << "failed writing to file: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700666 return false;
667 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700668 return true;
669}
670
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700671static bool LoadStableIdMap(IDiagnostics* diag, const std::string& path,
672 std::unordered_map<ResourceName, ResourceId>* out_id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700673 std::string content;
Adam Lesinski2354b562017-05-26 16:31:38 -0700674 if (!android::base::ReadFileToString(path, &content, true /*follow_symlinks*/)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700675 diag->Error(DiagMessage(path) << "failed reading stable ID file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700676 return false;
677 }
678
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700679 out_id_map->clear();
680 size_t line_no = 0;
681 for (StringPiece line : util::Tokenize(content, '\n')) {
682 line_no++;
683 line = util::TrimWhitespace(line);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700684 if (line.empty()) {
685 continue;
686 }
687
688 auto iter = std::find(line.begin(), line.end(), '=');
689 if (iter == line.end()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700690 diag->Error(DiagMessage(Source(path, line_no)) << "missing '='");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700691 return false;
692 }
693
694 ResourceNameRef name;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700695 StringPiece res_name_str =
696 util::TrimWhitespace(line.substr(0, std::distance(line.begin(), iter)));
697 if (!ResourceUtils::ParseResourceName(res_name_str, &name)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700698 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource name '" << res_name_str
699 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700700 return false;
701 }
702
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700703 const size_t res_id_start_idx = std::distance(line.begin(), iter) + 1;
704 const size_t res_id_str_len = line.size() - res_id_start_idx;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700705 StringPiece res_id_str = util::TrimWhitespace(line.substr(res_id_start_idx, res_id_str_len));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700706
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700707 Maybe<ResourceId> maybe_id = ResourceUtils::ParseResourceId(res_id_str);
708 if (!maybe_id) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700709 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource ID '" << res_id_str
710 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700711 return false;
712 }
713
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700714 (*out_id_map)[name.ToResourceName()] = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700715 }
716 return true;
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700717}
718
Adam Lesinskic6284372017-12-04 13:46:23 -0800719static int32_t FindFrameworkAssetManagerCookie(const android::AssetManager& assets) {
720 using namespace android;
721
722 // Find the system package (0x01). AAPT always generates attributes with the type 0x01, so
723 // we're looking for the first attribute resource in the system package.
724 const ResTable& table = assets.getResources(true);
725 Res_value val;
726 ssize_t idx = table.getResource(0x01010000, &val, true);
727 if (idx != NO_ERROR) {
728 // Try as a bag.
729 const ResTable::bag_entry* entry;
730 ssize_t cnt = table.lockBag(0x01010000, &entry);
731 if (cnt >= 0) {
732 idx = entry->stringBlock;
733 }
734 table.unlockBag(entry);
735 }
736
737 if (idx < 0) {
738 return 0;
739 }
740 return table.getTableCookie(idx);
741}
742
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700743class Linker {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700744 public:
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700745 Linker(LinkContext* context, const LinkOptions& options)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700746 : options_(options),
747 context_(context),
748 final_table_(),
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700749 file_collection_(util::make_unique<io::FileCollection>()) {
750 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700751
Adam Lesinskic6284372017-12-04 13:46:23 -0800752 void ExtractCompileSdkVersions(android::AssetManager* assets) {
753 using namespace android;
754
755 int32_t cookie = FindFrameworkAssetManagerCookie(*assets);
756 if (cookie == 0) {
757 // No Framework assets loaded. Not a failure.
758 return;
759 }
760
761 std::unique_ptr<Asset> manifest(
762 assets->openNonAsset(cookie, kAndroidManifestPath, Asset::AccessMode::ACCESS_BUFFER));
763 if (manifest == nullptr) {
764 // No errors.
765 return;
766 }
767
768 std::string error;
769 std::unique_ptr<xml::XmlResource> manifest_xml =
770 xml::Inflate(manifest->getBuffer(true /*wordAligned*/), manifest->getLength(), &error);
771 if (manifest_xml == nullptr) {
772 // No errors.
773 return;
774 }
775
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700776 if (!options_.manifest_fixer_options.compile_sdk_version) {
777 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionCode");
778 if (attr != nullptr) {
779 Maybe<std::string>& compile_sdk_version = options_.manifest_fixer_options.compile_sdk_version;
780 if (BinaryPrimitive* prim = ValueCast<BinaryPrimitive>(attr->compiled_value.get())) {
781 switch (prim->value.dataType) {
782 case Res_value::TYPE_INT_DEC:
783 compile_sdk_version = StringPrintf("%" PRId32, static_cast<int32_t>(prim->value.data));
784 break;
785 case Res_value::TYPE_INT_HEX:
786 compile_sdk_version = StringPrintf("%" PRIx32, prim->value.data);
787 break;
788 default:
789 break;
790 }
791 } else if (String* str = ValueCast<String>(attr->compiled_value.get())) {
792 compile_sdk_version = *str->value;
793 } else {
794 compile_sdk_version = attr->value;
Adam Lesinskic6284372017-12-04 13:46:23 -0800795 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800796 }
797 }
798
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700799 if (!options_.manifest_fixer_options.compile_sdk_version_codename) {
800 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionName");
801 if (attr != nullptr) {
802 Maybe<std::string>& compile_sdk_version_codename =
803 options_.manifest_fixer_options.compile_sdk_version_codename;
804 if (String* str = ValueCast<String>(attr->compiled_value.get())) {
805 compile_sdk_version_codename = *str->value;
806 } else {
807 compile_sdk_version_codename = attr->value;
808 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800809 }
810 }
811 }
812
Adam Lesinski8780eb62017-10-31 17:44:39 -0700813 // Creates a SymbolTable that loads symbols from the various APKs.
Adam Lesinskic6284372017-12-04 13:46:23 -0800814 // Pre-condition: context_->GetCompilationPackage() needs to be set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700815 bool LoadSymbolsFromIncludePaths() {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700816 auto asset_source = util::make_unique<AssetManagerSymbolSource>();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700817 for (const std::string& path : options_.include_paths) {
818 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700819 context_->GetDiagnostics()->Note(DiagMessage() << "including " << path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700820 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700821
Adam Lesinski8780eb62017-10-31 17:44:39 -0700822 std::string error;
823 auto zip_collection = io::ZipFileCollection::Create(path, &error);
824 if (zip_collection == nullptr) {
825 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open APK: " << error);
826 return false;
827 }
828
829 if (zip_collection->FindFile(kProtoResourceTablePath) != nullptr) {
830 // Load this as a static library include.
831 std::unique_ptr<LoadedApk> static_apk = LoadedApk::LoadProtoApkFromFileCollection(
832 Source(path), std::move(zip_collection), context_->GetDiagnostics());
833 if (static_apk == nullptr) {
834 return false;
835 }
836
Adam Lesinskib522f042017-04-21 16:57:59 -0700837 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800838 // Can't include static libraries when not building a static library (they have no IDs
839 // assigned).
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700840 context_->GetDiagnostics()->Error(
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800841 DiagMessage(path) << "can't include static library when not building a static lib");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700842 return false;
843 }
844
Adam Lesinski8780eb62017-10-31 17:44:39 -0700845 ResourceTable* table = static_apk->GetResourceTable();
846
847 // If we are using --no-static-lib-packages, we need to rename the package of this table to
848 // our compilation package.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700849 if (options_.no_static_lib_packages) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800850 // Since package names can differ, and multiple packages can exist in a ResourceTable,
851 // we place the requirement that all static libraries are built with the package
852 // ID 0x7f. So if one is not found, this is an error.
Adam Lesinski8780eb62017-10-31 17:44:39 -0700853 if (ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700854 pkg->name = context_->GetCompilationPackage();
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800855 } else {
856 context_->GetDiagnostics()->Error(DiagMessage(path)
857 << "no package with ID 0x7f found in static library");
858 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700859 }
860 }
861
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700862 context_->GetExternalSymbols()->AppendSource(
Adam Lesinski8780eb62017-10-31 17:44:39 -0700863 util::make_unique<ResourceTableSymbolSource>(table));
864 static_library_includes_.push_back(std::move(static_apk));
865 } else {
866 if (!asset_source->AddAssetPath(path)) {
867 context_->GetDiagnostics()->Error(DiagMessage()
868 << "failed to load include path " << path);
869 return false;
870 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700871 }
872 }
873
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800874 // Capture the shared libraries so that the final resource table can be properly flattened
875 // with support for shared libraries.
876 for (auto& entry : asset_source->GetAssignedPackageIds()) {
Todd Kennedy32512992018-04-25 16:45:59 -0700877 if (entry.first == kAppPackageId) {
Adam Lesinski490595a2017-11-07 17:08:07 -0800878 // Capture the included base feature package.
879 included_feature_base_ = entry.second;
Adam Lesinskic6284372017-12-04 13:46:23 -0800880 } else if (entry.first == kFrameworkPackageId) {
881 // Try to embed which version of the framework we're compiling against.
882 // First check if we should use compileSdkVersion at all. Otherwise compilation may fail
883 // when linking our synthesized 'android:compileSdkVersion' attribute.
884 std::unique_ptr<SymbolTable::Symbol> symbol = asset_source->FindByName(
885 ResourceName("android", ResourceType::kAttr, "compileSdkVersion"));
886 if (symbol != nullptr && symbol->is_public) {
887 // The symbol is present and public, extract the android:versionName and
888 // android:versionCode from the framework AndroidManifest.xml.
889 ExtractCompileSdkVersions(asset_source->GetAssetManager());
890 }
Todd Kennedy32512992018-04-25 16:45:59 -0700891 } else if (asset_source->IsPackageDynamic(entry.first)) {
892 final_table_.included_packages_[entry.first] = entry.second;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800893 }
894 }
895
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700896 context_->GetExternalSymbols()->AppendSource(std::move(asset_source));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700897 return true;
898 }
899
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800900 Maybe<AppInfo> ExtractAppInfoFromManifest(xml::XmlResource* xml_res, IDiagnostics* diag) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700901 // Make sure the first element is <manifest> with package attribute.
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800902 xml::Element* manifest_el = xml::FindRootElement(xml_res->root.get());
903 if (manifest_el == nullptr) {
904 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700905 }
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800906
907 AppInfo app_info;
908
909 if (!manifest_el->namespace_uri.empty() || manifest_el->name != "manifest") {
910 diag->Error(DiagMessage(xml_res->file.source) << "root tag must be <manifest>");
911 return {};
912 }
913
914 xml::Attribute* package_attr = manifest_el->FindAttribute({}, "package");
915 if (!package_attr) {
916 diag->Error(DiagMessage(xml_res->file.source)
917 << "<manifest> must have a 'package' attribute");
918 return {};
919 }
920 app_info.package = package_attr->value;
921
922 if (xml::Attribute* version_code_attr =
923 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCode")) {
924 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_attr->value);
925 if (!maybe_code) {
926 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
927 << "invalid android:versionCode '" << version_code_attr->value << "'");
928 return {};
929 }
930 app_info.version_code = maybe_code.value();
931 }
932
Ryan Mitchell5fa2bb12018-07-12 11:24:51 -0700933 if (xml::Attribute* version_code_major_attr =
934 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCodeMajor")) {
935 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_major_attr->value);
936 if (!maybe_code) {
937 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
938 << "invalid android:versionCodeMajor '"
939 << version_code_major_attr->value << "'");
940 return {};
941 }
942 app_info.version_code_major = maybe_code.value();
943 }
944
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800945 if (xml::Attribute* revision_code_attr =
946 manifest_el->FindAttribute(xml::kSchemaAndroid, "revisionCode")) {
947 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(revision_code_attr->value);
948 if (!maybe_code) {
949 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
950 << "invalid android:revisionCode '" << revision_code_attr->value << "'");
951 return {};
952 }
953 app_info.revision_code = maybe_code.value();
954 }
955
956 if (xml::Attribute* split_name_attr = manifest_el->FindAttribute({}, "split")) {
957 if (!split_name_attr->value.empty()) {
958 app_info.split_name = split_name_attr->value;
959 }
960 }
961
962 if (xml::Element* uses_sdk_el = manifest_el->FindChild({}, "uses-sdk")) {
963 if (xml::Attribute* min_sdk =
964 uses_sdk_el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion")) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700965 app_info.min_sdk_version = ResourceUtils::ParseSdkVersion(min_sdk->value);
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800966 }
967 }
968 return app_info;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700969 }
970
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700971 // Precondition: ResourceTable doesn't have any IDs assigned yet, nor is it linked.
972 // Postcondition: ResourceTable has only one package left. All others are
973 // stripped, or there is an error and false is returned.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700974 bool VerifyNoExternalPackages() {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700975 auto is_ext_package_func = [&](const std::unique_ptr<ResourceTablePackage>& pkg) -> bool {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700976 return context_->GetCompilationPackage() != pkg->name || !pkg->id ||
977 pkg->id.value() != context_->GetPackageId();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700978 };
979
980 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700981 for (const auto& package : final_table_.packages) {
982 if (is_ext_package_func(package)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700983 // We have a package that is not related to the one we're building!
984 for (const auto& type : package->types) {
985 for (const auto& entry : type->entries) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700986 ResourceNameRef res_name(package->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700987
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700988 for (const auto& config_value : entry->values) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700989 // Special case the occurrence of an ID that is being generated
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700990 // for the 'android' package. This is due to legacy reasons.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700991 if (ValueCast<Id>(config_value->value.get()) && package->name == "android") {
992 context_->GetDiagnostics()->Warn(DiagMessage(config_value->value->GetSource())
993 << "generated id '" << res_name
994 << "' for external package '" << package->name
995 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700996 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700997 context_->GetDiagnostics()->Error(DiagMessage(config_value->value->GetSource())
998 << "defined resource '" << res_name
999 << "' for external package '" << package->name
1000 << "'");
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001001 error = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001002 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001003 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001004 }
1005 }
1006 }
1007 }
1008
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001009 auto new_end_iter = std::remove_if(final_table_.packages.begin(), final_table_.packages.end(),
1010 is_ext_package_func);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001011 final_table_.packages.erase(new_end_iter, final_table_.packages.end());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001012 return !error;
1013 }
1014
1015 /**
1016 * Returns true if no IDs have been set, false otherwise.
1017 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001018 bool VerifyNoIdsSet() {
1019 for (const auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001020 for (const auto& type : package->types) {
1021 if (type->id) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001022 context_->GetDiagnostics()->Error(DiagMessage() << "type " << type->type << " has ID "
1023 << StringPrintf("%02x", type->id.value())
1024 << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001025 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001026 }
1027
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001028 for (const auto& entry : type->entries) {
1029 if (entry->id) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001030 ResourceNameRef res_name(package->name, type->type, entry->name);
1031 context_->GetDiagnostics()->Error(
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001032 DiagMessage() << "entry " << res_name << " has ID "
1033 << StringPrintf("%02x", entry->id.value()) << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001034 return false;
1035 }
1036 }
1037 }
1038 }
1039 return true;
1040 }
1041
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001042 std::unique_ptr<IArchiveWriter> MakeArchiveWriter(const StringPiece& out) {
1043 if (options_.output_to_directory) {
1044 return CreateDirectoryArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001045 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001046 return CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001047 }
1048 }
1049
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001050 bool FlattenTable(ResourceTable* table, OutputFormat format, IArchiveWriter* writer) {
1051 switch (format) {
1052 case OutputFormat::kApk: {
1053 BigBuffer buffer(1024);
1054 TableFlattener flattener(options_.table_flattener_options, &buffer);
1055 if (!flattener.Consume(context_, table)) {
1056 context_->GetDiagnostics()->Error(DiagMessage() << "failed to flatten resource table");
1057 return false;
1058 }
1059
1060 io::BigBufferInputStream input_stream(&buffer);
1061 return io::CopyInputStreamToArchive(context_, &input_stream, kApkResourceTablePath,
1062 ArchiveEntry::kAlign, writer);
1063 } break;
1064
1065 case OutputFormat::kProto: {
1066 pb::ResourceTable pb_table;
Ryan Mitchella15c2a82018-03-26 11:05:31 -07001067 SerializeTableToPb(*table, &pb_table, context_->GetDiagnostics());
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001068 return io::CopyProtoToArchive(context_, &pb_table, kProtoResourceTablePath,
1069 ArchiveEntry::kCompress, writer);
1070 } break;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001071 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001072 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001073 }
1074
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001075 bool WriteJavaFile(ResourceTable* table, const StringPiece& package_name_to_generate,
Adam Lesinski418763f2017-04-11 17:36:53 -07001076 const StringPiece& out_package, const JavaClassGeneratorOptions& java_options,
Chih-Hung Hsieh4dc58122017-08-03 16:28:10 -07001077 const Maybe<std::string>& out_text_symbols_path = {}) {
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001078 if (!options_.generate_java_class_path && !out_text_symbols_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001079 return true;
1080 }
1081
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001082 std::string out_path;
1083 std::unique_ptr<io::FileOutputStream> fout;
1084 if (options_.generate_java_class_path) {
1085 out_path = options_.generate_java_class_path.value();
1086 file::AppendPath(&out_path, file::PackageToPath(out_package));
1087 if (!file::mkdirs(out_path)) {
1088 context_->GetDiagnostics()->Error(DiagMessage()
1089 << "failed to create directory '" << out_path << "'");
1090 return false;
1091 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001092
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001093 file::AppendPath(&out_path, "R.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001094
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001095 fout = util::make_unique<io::FileOutputStream>(out_path);
1096 if (fout->HadError()) {
1097 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1098 << "': " << fout->GetError());
1099 return false;
1100 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001101 }
1102
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001103 std::unique_ptr<io::FileOutputStream> fout_text;
Adam Lesinski418763f2017-04-11 17:36:53 -07001104 if (out_text_symbols_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001105 fout_text = util::make_unique<io::FileOutputStream>(out_text_symbols_path.value());
1106 if (fout_text->HadError()) {
1107 context_->GetDiagnostics()->Error(DiagMessage()
1108 << "failed writing to '" << out_text_symbols_path.value()
1109 << "': " << fout_text->GetError());
Adam Lesinski418763f2017-04-11 17:36:53 -07001110 return false;
1111 }
1112 }
1113
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001114 JavaClassGenerator generator(context_, table, java_options);
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001115 if (!generator.Generate(package_name_to_generate, out_package, fout.get(), fout_text.get())) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001116 context_->GetDiagnostics()->Error(DiagMessage(out_path) << generator.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001117 return false;
1118 }
1119
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001120 return true;
1121 }
1122
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001123 bool GenerateJavaClasses() {
1124 // The set of packages whose R class to call in the main classes onResourcesLoaded callback.
1125 std::vector<std::string> packages_to_callback;
1126
1127 JavaClassGeneratorOptions template_options;
1128 template_options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1129 template_options.javadoc_annotations = options_.javadoc_annotations;
1130
1131 if (context_->GetPackageType() == PackageType::kStaticLib || options_.generate_non_final_ids) {
1132 template_options.use_final = false;
1133 }
1134
1135 if (context_->GetPackageType() == PackageType::kSharedLib) {
1136 template_options.use_final = false;
1137 template_options.rewrite_callback_options = OnResourcesLoadedCallbackOptions{};
1138 }
1139
1140 const StringPiece actual_package = context_->GetCompilationPackage();
1141 StringPiece output_package = context_->GetCompilationPackage();
1142 if (options_.custom_java_package) {
1143 // Override the output java package to the custom one.
1144 output_package = options_.custom_java_package.value();
1145 }
1146
1147 // Generate the private symbols if required.
1148 if (options_.private_symbols) {
1149 packages_to_callback.push_back(options_.private_symbols.value());
1150
1151 // If we defined a private symbols package, we only emit Public symbols
1152 // to the original package, and private and public symbols to the private package.
1153 JavaClassGeneratorOptions options = template_options;
1154 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate;
1155 if (!WriteJavaFile(&final_table_, actual_package, options_.private_symbols.value(),
1156 options)) {
1157 return false;
1158 }
1159 }
1160
1161 // Generate copies of the original package R class but with different package names.
1162 // This is to support non-namespaced builds.
1163 for (const std::string& extra_package : options_.extra_java_packages) {
1164 packages_to_callback.push_back(extra_package);
1165
1166 JavaClassGeneratorOptions options = template_options;
1167 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1168 if (!WriteJavaFile(&final_table_, actual_package, extra_package, options)) {
1169 return false;
1170 }
1171 }
1172
1173 // Generate R classes for each package that was merged (static library).
1174 // Use the actual package's resources only.
1175 for (const std::string& package : table_merger_->merged_packages()) {
1176 packages_to_callback.push_back(package);
1177
1178 JavaClassGeneratorOptions options = template_options;
1179 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1180 if (!WriteJavaFile(&final_table_, package, package, options)) {
1181 return false;
1182 }
1183 }
1184
1185 // Generate the main public R class.
1186 JavaClassGeneratorOptions options = template_options;
1187
1188 // Only generate public symbols if we have a private package.
1189 if (options_.private_symbols) {
1190 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublic;
1191 }
1192
1193 if (options.rewrite_callback_options) {
1194 options.rewrite_callback_options.value().packages_to_callback =
1195 std::move(packages_to_callback);
1196 }
1197
1198 if (!WriteJavaFile(&final_table_, actual_package, output_package, options,
1199 options_.generate_text_symbols_path)) {
1200 return false;
1201 }
1202
1203 return true;
1204 }
1205
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001206 bool WriteManifestJavaFile(xml::XmlResource* manifest_xml) {
1207 if (!options_.generate_java_class_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001208 return true;
1209 }
1210
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001211 std::unique_ptr<ClassDefinition> manifest_class =
1212 GenerateManifestClass(context_->GetDiagnostics(), manifest_xml);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001213
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001214 if (!manifest_class) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001215 // Something bad happened, but we already logged it, so exit.
1216 return false;
1217 }
1218
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001219 if (manifest_class->empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001220 // Empty Manifest class, no need to generate it.
1221 return true;
1222 }
1223
1224 // Add any JavaDoc annotations to the generated class.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001225 for (const std::string& annotation : options_.javadoc_annotations) {
1226 std::string proper_annotation = "@";
1227 proper_annotation += annotation;
1228 manifest_class->GetCommentBuilder()->AppendComment(proper_annotation);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001229 }
1230
Adam Lesinski0d81f702017-06-27 15:51:09 -07001231 const std::string package_utf8 =
1232 options_.custom_java_package.value_or_default(context_->GetCompilationPackage());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001233
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001234 std::string out_path = options_.generate_java_class_path.value();
1235 file::AppendPath(&out_path, file::PackageToPath(package_utf8));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001236
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001237 if (!file::mkdirs(out_path)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001238 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create directory '" << out_path
1239 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001240 return false;
1241 }
1242
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001243 file::AppendPath(&out_path, "Manifest.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001244
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001245 io::FileOutputStream fout(out_path);
1246 if (fout.HadError()) {
1247 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1248 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001249 return false;
1250 }
1251
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001252 ClassDefinition::WriteJavaFile(manifest_class.get(), package_utf8, true, &fout);
1253 fout.Flush();
1254
1255 if (fout.HadError()) {
1256 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1257 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001258 return false;
1259 }
1260 return true;
1261 }
1262
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001263 bool WriteProguardFile(const Maybe<std::string>& out, const proguard::KeepSet& keep_set) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001264 if (!out) {
1265 return true;
1266 }
1267
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001268 const std::string& out_path = out.value();
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001269 io::FileOutputStream fout(out_path);
1270 if (fout.HadError()) {
1271 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1272 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001273 return false;
1274 }
1275
Ryan Mitchell7e5236d2018-09-25 15:20:59 -07001276 proguard::WriteKeepSet(keep_set, &fout, options_.generate_minimal_proguard_rules);
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001277 fout.Flush();
1278
1279 if (fout.HadError()) {
1280 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1281 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001282 return false;
1283 }
1284 return true;
1285 }
1286
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001287 bool MergeStaticLibrary(const std::string& input, bool override) {
1288 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001289 context_->GetDiagnostics()->Note(DiagMessage() << "merging static library " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001290 }
1291
Adam Lesinski8780eb62017-10-31 17:44:39 -07001292 std::unique_ptr<LoadedApk> apk = LoadedApk::LoadApkFromPath(input, context_->GetDiagnostics());
1293 if (apk == nullptr) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001294 context_->GetDiagnostics()->Error(DiagMessage(input) << "invalid static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001295 return false;
1296 }
1297
Adam Lesinski8780eb62017-10-31 17:44:39 -07001298 ResourceTable* table = apk->GetResourceTable();
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001299 ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001300 if (!pkg) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001301 context_->GetDiagnostics()->Error(DiagMessage(input) << "static library has no package");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001302 return false;
1303 }
1304
1305 bool result;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001306 if (options_.no_static_lib_packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001307 // Merge all resources as if they were in the compilation package. This is the old behavior
1308 // of aapt.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001309
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001310 // Add the package to the set of --extra-packages so we emit an R.java for each library
1311 // package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001312 if (!pkg->name.empty()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001313 options_.extra_java_packages.insert(pkg->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001314 }
1315
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001316 // Clear the package name, so as to make the resources look like they are coming from the
1317 // local package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001318 pkg->name = "";
Adam Lesinski8780eb62017-10-31 17:44:39 -07001319 result = table_merger_->Merge(Source(input), table, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001320
1321 } else {
1322 // This is the proper way to merge libraries, where the package name is
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001323 // preserved and resource names are mangled.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001324 result = table_merger_->MergeAndMangle(Source(input), pkg->name, table);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001325 }
1326
1327 if (!result) {
1328 return false;
1329 }
1330
1331 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001332 merged_apks_.push_back(std::move(apk));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001333 return true;
1334 }
1335
Adam Lesinski2427dce2017-11-30 15:10:28 -08001336 bool MergeExportedSymbols(const Source& source,
1337 const std::vector<SourcedResourceName>& exported_symbols) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001338 // Add the exports of this file to the table.
Adam Lesinski2427dce2017-11-30 15:10:28 -08001339 for (const SourcedResourceName& exported_symbol : exported_symbols) {
Adam Lesinski00451162017-10-03 07:44:08 -07001340 ResourceName res_name = exported_symbol.name;
1341 if (res_name.package.empty()) {
1342 res_name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001343 }
1344
Adam Lesinski00451162017-10-03 07:44:08 -07001345 Maybe<ResourceName> mangled_name = context_->GetNameMangler()->MangleName(res_name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001346 if (mangled_name) {
1347 res_name = mangled_name.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001348 }
1349
1350 std::unique_ptr<Id> id = util::make_unique<Id>();
Adam Lesinski2427dce2017-11-30 15:10:28 -08001351 id->SetSource(source.WithLine(exported_symbol.line));
Adam Lesinski71be7052017-12-12 16:48:07 -08001352 bool result =
1353 final_table_.AddResourceMangled(res_name, ConfigDescription::DefaultConfig(),
1354 std::string(), std::move(id), context_->GetDiagnostics());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001355 if (!result) {
1356 return false;
1357 }
1358 }
1359 return true;
1360 }
1361
Adam Lesinski2427dce2017-11-30 15:10:28 -08001362 bool MergeCompiledFile(const ResourceFile& compiled_file, io::IFile* file, bool override) {
1363 if (context_->IsVerbose()) {
1364 context_->GetDiagnostics()->Note(DiagMessage()
1365 << "merging '" << compiled_file.name
1366 << "' from compiled file " << compiled_file.source);
1367 }
1368
1369 if (!table_merger_->MergeFile(compiled_file, override, file)) {
1370 return false;
1371 }
1372 return MergeExportedSymbols(compiled_file.source, compiled_file.exported_symbols);
1373 }
1374
Adam Lesinski00451162017-10-03 07:44:08 -07001375 // Takes a path to load as a ZIP file and merges the files within into the master ResourceTable.
1376 // If override is true, conflicting resources are allowed to override each other, in order of last
1377 // seen.
1378 // An io::IFileCollection is created from the ZIP file and added to the set of
1379 // io::IFileCollections that are open.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001380 bool MergeArchive(const std::string& input, bool override) {
1381 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001382 context_->GetDiagnostics()->Note(DiagMessage() << "merging archive " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001383 }
1384
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001385 std::string error_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001386 std::unique_ptr<io::ZipFileCollection> collection =
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001387 io::ZipFileCollection::Create(input, &error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001388 if (!collection) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001389 context_->GetDiagnostics()->Error(DiagMessage(input) << error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001390 return false;
1391 }
1392
1393 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001394 for (auto iter = collection->Iterator(); iter->HasNext();) {
1395 if (!MergeFile(iter->Next(), override)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001396 error = true;
1397 }
1398 }
1399
1400 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001401 collections_.push_back(std::move(collection));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001402 return !error;
1403 }
1404
Adam Lesinski00451162017-10-03 07:44:08 -07001405 // Takes a path to load and merge into the master ResourceTable. If override is true,
1406 // conflicting resources are allowed to override each other, in order of last seen.
1407 // If the file path ends with .flata, .jar, .jack, or .zip the file is treated
1408 // as ZIP archive and the files within are merged individually.
1409 // Otherwise the file is processed on its own.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001410 bool MergePath(const std::string& path, bool override) {
1411 if (util::EndsWith(path, ".flata") || util::EndsWith(path, ".jar") ||
1412 util::EndsWith(path, ".jack") || util::EndsWith(path, ".zip")) {
1413 return MergeArchive(path, override);
1414 } else if (util::EndsWith(path, ".apk")) {
1415 return MergeStaticLibrary(path, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001416 }
1417
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001418 io::IFile* file = file_collection_->InsertFile(path);
1419 return MergeFile(file, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001420 }
1421
Adam Lesinski00451162017-10-03 07:44:08 -07001422 // Takes an AAPT Container file (.apc/.flat) to load and merge into the master ResourceTable.
1423 // If override is true, conflicting resources are allowed to override each other, in order of last
1424 // seen.
1425 // All other file types are ignored. This is because these files could be coming from a zip,
1426 // where we could have other files like classes.dex.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001427 bool MergeFile(io::IFile* file, bool override) {
1428 const Source& src = file->GetSource();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001429
Adam Lesinski00451162017-10-03 07:44:08 -07001430 if (util::EndsWith(src.path, ".xml") || util::EndsWith(src.path, ".png")) {
Adam Lesinski6a396c12016-10-20 14:38:23 -07001431 // Since AAPT compiles these file types and appends .flat to them, seeing
1432 // their raw extensions is a sign that they weren't compiled.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001433 const StringPiece file_type = util::EndsWith(src.path, ".xml") ? "XML" : "PNG";
1434 context_->GetDiagnostics()->Error(DiagMessage(src) << "uncompiled " << file_type
1435 << " file passed as argument. Must be "
1436 "compiled first into .flat file.");
Adam Lesinski6a396c12016-10-20 14:38:23 -07001437 return false;
Adam Lesinski00451162017-10-03 07:44:08 -07001438 } else if (!util::EndsWith(src.path, ".apc") && !util::EndsWith(src.path, ".flat")) {
1439 if (context_->IsVerbose()) {
1440 context_->GetDiagnostics()->Warn(DiagMessage(src) << "ignoring unrecognized file");
1441 return true;
1442 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001443 }
1444
Adam Lesinski00451162017-10-03 07:44:08 -07001445 std::unique_ptr<io::InputStream> input_stream = file->OpenInputStream();
1446 if (input_stream == nullptr) {
1447 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to open file");
1448 return false;
1449 }
1450
1451 if (input_stream->HadError()) {
1452 context_->GetDiagnostics()->Error(DiagMessage(src)
1453 << "failed to open file: " << input_stream->GetError());
1454 return false;
1455 }
1456
1457 ContainerReaderEntry* entry;
1458 ContainerReader reader(input_stream.get());
Mohamed Heikal10844322018-02-07 15:17:38 -05001459
1460 if (reader.HadError()) {
1461 context_->GetDiagnostics()->Error(DiagMessage(src)
1462 << "failed to read file: " << reader.GetError());
1463 return false;
1464 }
1465
Adam Lesinski00451162017-10-03 07:44:08 -07001466 while ((entry = reader.Next()) != nullptr) {
1467 if (entry->Type() == ContainerEntryType::kResTable) {
1468 pb::ResourceTable pb_table;
1469 if (!entry->GetResTable(&pb_table)) {
1470 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to read resource table: "
1471 << entry->GetError());
1472 return false;
1473 }
1474
1475 ResourceTable table;
1476 std::string error;
Adam Lesinski8780eb62017-10-31 17:44:39 -07001477 if (!DeserializeTableFromPb(pb_table, nullptr /*files*/, &table, &error)) {
Adam Lesinski00451162017-10-03 07:44:08 -07001478 context_->GetDiagnostics()->Error(DiagMessage(src)
1479 << "failed to deserialize resource table: " << error);
1480 return false;
1481 }
1482
1483 if (!table_merger_->Merge(src, &table, override)) {
1484 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to merge resource table");
1485 return false;
1486 }
1487 } else if (entry->Type() == ContainerEntryType::kResFile) {
1488 pb::internal::CompiledFile pb_compiled_file;
1489 off64_t offset;
1490 size_t len;
1491 if (!entry->GetResFileOffsets(&pb_compiled_file, &offset, &len)) {
1492 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to get resource file: "
1493 << entry->GetError());
1494 return false;
1495 }
1496
1497 ResourceFile resource_file;
1498 std::string error;
1499 if (!DeserializeCompiledFileFromPb(pb_compiled_file, &resource_file, &error)) {
1500 context_->GetDiagnostics()->Error(DiagMessage(src)
1501 << "failed to read compiled header: " << error);
1502 return false;
1503 }
1504
1505 if (!MergeCompiledFile(resource_file, file->CreateFileSegment(offset, len), override)) {
1506 return false;
1507 }
1508 }
1509 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001510 return true;
1511 }
1512
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001513 bool CopyAssetsDirsToApk(IArchiveWriter* writer) {
1514 std::map<std::string, std::unique_ptr<io::RegularFile>> merged_assets;
1515 for (const std::string& assets_dir : options_.assets_dirs) {
1516 Maybe<std::vector<std::string>> files =
1517 file::FindFiles(assets_dir, context_->GetDiagnostics(), nullptr);
1518 if (!files) {
1519 return false;
1520 }
1521
1522 for (const std::string& file : files.value()) {
1523 std::string full_key = "assets/" + file;
1524 std::string full_path = assets_dir;
1525 file::AppendPath(&full_path, file);
1526
1527 auto iter = merged_assets.find(full_key);
1528 if (iter == merged_assets.end()) {
1529 merged_assets.emplace(std::move(full_key),
1530 util::make_unique<io::RegularFile>(Source(std::move(full_path))));
1531 } else if (context_->IsVerbose()) {
1532 context_->GetDiagnostics()->Warn(DiagMessage(iter->second->GetSource())
1533 << "asset file overrides '" << full_path << "'");
1534 }
1535 }
1536 }
1537
1538 for (auto& entry : merged_assets) {
1539 uint32_t compression_flags = ArchiveEntry::kCompress;
1540 std::string extension = file::GetExtension(entry.first).to_string();
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01001541
1542 if (options_.do_not_compress_anything
1543 || options_.extensions_to_not_compress.count(extension) > 0
1544 || (options_.regex_to_not_compress
1545 && std::regex_search(extension, options_.regex_to_not_compress.value()))) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001546 compression_flags = 0u;
1547 }
1548
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001549 if (!io::CopyFileToArchive(context_, entry.second.get(), entry.first, compression_flags,
1550 writer)) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001551 return false;
1552 }
1553 }
1554 return true;
1555 }
1556
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001557 // Writes the AndroidManifest, ResourceTable, and all XML files referenced by the ResourceTable
1558 // to the IArchiveWriter.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001559 bool WriteApk(IArchiveWriter* writer, proguard::KeepSet* keep_set, xml::XmlResource* manifest,
1560 ResourceTable* table) {
Ryan Mitchell479fa392019-01-02 17:15:39 -08001561 const bool keep_raw_values = (context_->GetPackageType() == PackageType::kStaticLib)
1562 || options_.keep_raw_values;
Ryan Mitchell467b6892018-11-09 15:52:07 -08001563 bool result = FlattenXml(context_, *manifest, kAndroidManifestPath, keep_raw_values,
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001564 true /*utf16*/, options_.output_format, writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001565 if (!result) {
1566 return false;
1567 }
1568
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001569 ResourceFileFlattenerOptions file_flattener_options;
1570 file_flattener_options.keep_raw_values = keep_raw_values;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001571 file_flattener_options.do_not_compress_anything = options_.do_not_compress_anything;
1572 file_flattener_options.extensions_to_not_compress = options_.extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01001573 file_flattener_options.regex_to_not_compress = options_.regex_to_not_compress;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001574 file_flattener_options.no_auto_version = options_.no_auto_version;
1575 file_flattener_options.no_version_vectors = options_.no_version_vectors;
Yuichi Araki4d35cca2017-01-18 20:42:17 +09001576 file_flattener_options.no_version_transitions = options_.no_version_transitions;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001577 file_flattener_options.no_xml_namespaces = options_.no_xml_namespaces;
1578 file_flattener_options.update_proguard_spec =
1579 static_cast<bool>(options_.generate_proguard_rules_path);
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001580 file_flattener_options.output_format = options_.output_format;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001581
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001582 ResourceFileFlattener file_flattener(file_flattener_options, context_, keep_set);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001583
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001584 if (!file_flattener.Flatten(table, writer)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001585 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking file resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001586 return false;
1587 }
1588
Adam Lesinski490595a2017-11-07 17:08:07 -08001589 // Hack to fix b/68820737.
1590 // We need to modify the ResourceTable's package name, but that should NOT affect
1591 // anything else being generated, which includes the Java classes.
1592 // If required, the package name is modifed before flattening, and then modified back
1593 // to its original name.
1594 ResourceTablePackage* package_to_rewrite = nullptr;
Todd Kennedy32512992018-04-25 16:45:59 -07001595 // Pre-O, the platform treats negative resource IDs [those with a package ID of 0x80
1596 // or higher] as invalid. In order to work around this limitation, we allow the use
1597 // of traditionally reserved resource IDs [those between 0x02 and 0x7E]. Allow the
1598 // definition of what a valid "split" package ID is to account for this.
1599 const bool isSplitPackage = (options_.allow_reserved_package_id &&
1600 context_->GetPackageId() != kAppPackageId &&
1601 context_->GetPackageId() != kFrameworkPackageId)
1602 || (!options_.allow_reserved_package_id && context_->GetPackageId() > kAppPackageId);
1603 if (isSplitPackage &&
Adam Lesinski490595a2017-11-07 17:08:07 -08001604 included_feature_base_ == make_value(context_->GetCompilationPackage())) {
1605 // The base APK is included, and this is a feature split. If the base package is
1606 // the same as this package, then we are building an old style Android Instant Apps feature
1607 // split and must apply this workaround to avoid requiring namespaces support.
1608 package_to_rewrite = table->FindPackage(context_->GetCompilationPackage());
1609 if (package_to_rewrite != nullptr) {
1610 CHECK_EQ(1u, table->packages.size()) << "can't change name of package when > 1 package";
1611
1612 std::string new_package_name =
1613 StringPrintf("%s.%s", package_to_rewrite->name.c_str(),
1614 app_info_.split_name.value_or_default("feature").c_str());
1615
1616 if (context_->IsVerbose()) {
1617 context_->GetDiagnostics()->Note(
1618 DiagMessage() << "rewriting resource package name for feature split to '"
1619 << new_package_name << "'");
1620 }
1621 package_to_rewrite->name = new_package_name;
1622 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001623 }
Adam Lesinski490595a2017-11-07 17:08:07 -08001624
1625 bool success = FlattenTable(table, options_.output_format, writer);
1626
1627 if (package_to_rewrite != nullptr) {
1628 // Change the name back.
1629 package_to_rewrite->name = context_->GetCompilationPackage();
1630 if (package_to_rewrite->id) {
1631 table->included_packages_.erase(package_to_rewrite->id.value());
1632 }
1633 }
1634
1635 if (!success) {
1636 context_->GetDiagnostics()->Error(DiagMessage() << "failed to write resource table");
1637 }
1638 return success;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001639 }
1640
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001641 int Run(const std::vector<std::string>& input_files) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001642 // Load the AndroidManifest.xml
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001643 std::unique_ptr<xml::XmlResource> manifest_xml =
1644 LoadXml(options_.manifest_path, context_->GetDiagnostics());
1645 if (!manifest_xml) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001646 return 1;
1647 }
1648
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001649 // First extract the Package name without modifying it (via --rename-manifest-package).
1650 if (Maybe<AppInfo> maybe_app_info =
1651 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001652 const AppInfo& app_info = maybe_app_info.value();
1653 context_->SetCompilationPackage(app_info.package);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001654 }
1655
Adam Lesinskic6284372017-12-04 13:46:23 -08001656 // Now that the compilation package is set, load the dependencies. This will also extract
1657 // the Android framework's versionCode and versionName, if they exist.
1658 if (!LoadSymbolsFromIncludePaths()) {
1659 return 1;
1660 }
1661
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001662 ManifestFixer manifest_fixer(options_.manifest_fixer_options);
1663 if (!manifest_fixer.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001664 return 1;
1665 }
1666
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001667 Maybe<AppInfo> maybe_app_info =
1668 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001669 if (!maybe_app_info) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001670 return 1;
1671 }
1672
Adam Lesinski490595a2017-11-07 17:08:07 -08001673 app_info_ = maybe_app_info.value();
1674 context_->SetMinSdkVersion(app_info_.min_sdk_version.value_or_default(0));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001675
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001676 context_->SetNameManglerPolicy(NameManglerPolicy{context_->GetCompilationPackage()});
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001677
1678 // Override the package ID when it is "android".
1679 if (context_->GetCompilationPackage() == "android") {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001680 context_->SetPackageId(0x01);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001681
1682 // Verify we're building a regular app.
Adam Lesinskib522f042017-04-21 16:57:59 -07001683 if (context_->GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001684 context_->GetDiagnostics()->Error(
1685 DiagMessage() << "package 'android' can only be built as a regular app");
1686 return 1;
1687 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001688 }
1689
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001690 TableMergerOptions table_merger_options;
1691 table_merger_options.auto_add_overlay = options_.auto_add_overlay;
Izabela Orlowskad51efe82018-04-24 18:18:29 +01001692 table_merger_options.strict_visibility = options_.strict_visibility;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001693 table_merger_ = util::make_unique<TableMerger>(context_, &final_table_, table_merger_options);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001694
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001695 if (context_->IsVerbose()) {
1696 context_->GetDiagnostics()->Note(DiagMessage()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001697 << StringPrintf("linking package '%s' using package ID %02x",
1698 context_->GetCompilationPackage().data(),
1699 context_->GetPackageId()));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001700 }
1701
Adam Lesinski2427dce2017-11-30 15:10:28 -08001702 // Extract symbols from AndroidManifest.xml, since this isn't merged like the other XML files
1703 // in res/**/*.
1704 {
1705 XmlIdCollector collector;
1706 if (!collector.Consume(context_, manifest_xml.get())) {
1707 return false;
1708 }
1709
1710 if (!MergeExportedSymbols(manifest_xml->file.source, manifest_xml->file.exported_symbols)) {
1711 return false;
1712 }
1713 }
1714
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001715 for (const std::string& input : input_files) {
1716 if (!MergePath(input, false)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001717 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing input");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001718 return 1;
1719 }
1720 }
1721
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001722 for (const std::string& input : options_.overlay_files) {
1723 if (!MergePath(input, true)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001724 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing overlays");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001725 return 1;
1726 }
1727 }
1728
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001729 if (!VerifyNoExternalPackages()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001730 return 1;
1731 }
1732
Adam Lesinskib522f042017-04-21 16:57:59 -07001733 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001734 PrivateAttributeMover mover;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001735 if (!mover.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001736 context_->GetDiagnostics()->Error(DiagMessage() << "failed moving private attributes");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001737 return 1;
1738 }
1739
1740 // Assign IDs if we are building a regular app.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001741 IdAssigner id_assigner(&options_.stable_id_map);
1742 if (!id_assigner.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001743 context_->GetDiagnostics()->Error(DiagMessage() << "failed assigning IDs");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001744 return 1;
1745 }
1746
1747 // Now grab each ID and emit it as a file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001748 if (options_.resource_id_map_path) {
1749 for (auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001750 for (auto& type : package->types) {
1751 for (auto& entry : type->entries) {
1752 ResourceName name(package->name, type->type, entry->name);
1753 // The IDs are guaranteed to exist.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001754 options_.stable_id_map[std::move(name)] =
1755 ResourceId(package->id.value(), type->id.value(), entry->id.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001756 }
1757 }
1758 }
1759
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001760 if (!WriteStableIdMapToPath(context_->GetDiagnostics(), options_.stable_id_map,
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001761 options_.resource_id_map_path.value())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001762 return 1;
1763 }
1764 }
1765 } else {
1766 // Static libs are merged with other apps, and ID collisions are bad, so
1767 // verify that
1768 // no IDs have been set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001769 if (!VerifyNoIdsSet()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001770 return 1;
1771 }
1772 }
1773
1774 // Add the names to mangle based on our source merge earlier.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001775 context_->SetNameManglerPolicy(
1776 NameManglerPolicy{context_->GetCompilationPackage(), table_merger_->merged_packages()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001777
1778 // Add our table to the symbol table.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001779 context_->GetExternalSymbols()->PrependSource(
1780 util::make_unique<ResourceTableSymbolSource>(&final_table_));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001781
Adam Lesinski1e4b0e52017-04-27 15:01:10 -07001782 // Workaround for pre-O runtime that would treat negative resource IDs
1783 // (any ID with a package ID > 7f) as invalid. Intercept any ID (PPTTEEEE) with PP > 0x7f
1784 // and type == 'id', and return the ID 0x7fPPEEEE. IDs don't need to be real resources, they
1785 // are just identifiers.
1786 if (context_->GetMinSdkVersion() < SDK_O && context_->GetPackageType() == PackageType::kApp) {
1787 if (context_->IsVerbose()) {
1788 context_->GetDiagnostics()->Note(DiagMessage()
1789 << "enabling pre-O feature split ID rewriting");
1790 }
1791 context_->GetExternalSymbols()->SetDelegate(
1792 util::make_unique<FeatureSplitSymbolTableDelegate>(context_));
1793 }
1794
Adam Lesinski34a16872018-02-23 16:18:10 -08001795 // Before we process anything, remove the resources whose default values don't exist.
1796 // We want to force any references to these to fail the build.
Mårten Kongstadd8d29012018-06-11 14:13:37 +02001797 if (!options_.no_resource_removal) {
1798 if (!NoDefaultResourceRemover{}.Consume(context_, &final_table_)) {
1799 context_->GetDiagnostics()->Error(DiagMessage()
1800 << "failed removing resources with no defaults");
1801 return 1;
1802 }
Adam Lesinski34a16872018-02-23 16:18:10 -08001803 }
1804
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001805 ReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001806 if (!linker.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001807 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking references");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001808 return 1;
1809 }
1810
Adam Lesinskib522f042017-04-21 16:57:59 -07001811 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001812 if (!options_.products.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001813 context_->GetDiagnostics()->Warn(DiagMessage()
1814 << "can't select products when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001815 }
1816 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001817 ProductFilter product_filter(options_.products);
1818 if (!product_filter.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001819 context_->GetDiagnostics()->Error(DiagMessage() << "failed stripping products");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001820 return 1;
1821 }
1822 }
1823
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001824 if (!options_.no_auto_version) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001825 AutoVersioner versioner;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001826 if (!versioner.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001827 context_->GetDiagnostics()->Error(DiagMessage() << "failed versioning styles");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001828 return 1;
1829 }
1830 }
1831
Adam Lesinskib522f042017-04-21 16:57:59 -07001832 if (context_->GetPackageType() != PackageType::kStaticLib && context_->GetMinSdkVersion() > 0) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001833 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001834 context_->GetDiagnostics()->Note(DiagMessage()
1835 << "collapsing resource versions for minimum SDK "
1836 << context_->GetMinSdkVersion());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001837 }
1838
1839 VersionCollapser collapser;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001840 if (!collapser.Consume(context_, &final_table_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001841 return 1;
1842 }
1843 }
1844
Winson3c918b82019-01-25 14:25:37 -08001845 if (!options_.exclude_configs_.empty()) {
1846 std::vector<ConfigDescription> excluded_configs;
1847
1848 for (auto& config_string : options_.exclude_configs_) {
1849 ConfigDescription config_description;
1850
1851 if (!ConfigDescription::Parse(config_string, &config_description)) {
1852 context_->GetDiagnostics()->Error(DiagMessage()
1853 << "failed to parse --excluded-configs "
1854 << config_string);
1855 return 1;
1856 }
1857
1858 excluded_configs.push_back(config_description);
1859 }
1860
1861 ResourceExcluder excluder(excluded_configs);
1862 if (!excluder.Consume(context_, &final_table_)) {
1863 context_->GetDiagnostics()->Error(DiagMessage() << "failed excluding configurations");
1864 return 1;
1865 }
1866 }
1867
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001868 if (!options_.no_resource_deduping) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001869 ResourceDeduper deduper;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001870 if (!deduper.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001871 context_->GetDiagnostics()->Error(DiagMessage() << "failed deduping resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001872 return 1;
1873 }
1874 }
1875
Adam Koskidc21dea2017-07-21 10:55:27 -07001876 proguard::KeepSet proguard_keep_set =
1877 proguard::KeepSet(options_.generate_conditional_proguard_rules);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001878 proguard::KeepSet proguard_main_dex_keep_set;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001879
Adam Lesinskib522f042017-04-21 16:57:59 -07001880 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001881 if (options_.table_splitter_options.config_filter != nullptr ||
Pierre Lecesne672384b2017-02-06 10:29:02 +00001882 !options_.table_splitter_options.preferred_densities.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001883 context_->GetDiagnostics()->Warn(DiagMessage()
1884 << "can't strip resources when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001885 }
1886 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001887 // Adjust the SplitConstraints so that their SDK version is stripped if it is less than or
1888 // equal to the minSdk.
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001889 const size_t origConstraintSize = options_.split_constraints.size();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001890 options_.split_constraints =
1891 AdjustSplitConstraintsForMinSdk(context_->GetMinSdkVersion(), options_.split_constraints);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001892
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001893 if (origConstraintSize != options_.split_constraints.size()) {
1894 context_->GetDiagnostics()->Warn(DiagMessage()
1895 << "requested to split resources prior to min sdk of "
1896 << context_->GetMinSdkVersion());
1897 }
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001898 TableSplitter table_splitter(options_.split_constraints, options_.table_splitter_options);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001899 if (!table_splitter.VerifySplitConstraints(context_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001900 return 1;
1901 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001902 table_splitter.SplitTable(&final_table_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001903
1904 // Now we need to write out the Split APKs.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001905 auto path_iter = options_.split_paths.begin();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001906 auto split_constraints_iter = options_.split_constraints.begin();
1907 for (std::unique_ptr<ResourceTable>& split_table : table_splitter.splits()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001908 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001909 context_->GetDiagnostics()->Note(DiagMessage(*path_iter)
1910 << "generating split with configurations '"
1911 << util::Joiner(split_constraints_iter->configs, ", ")
1912 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001913 }
1914
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001915 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(*path_iter);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001916 if (!archive_writer) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001917 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001918 return 1;
1919 }
1920
1921 // Generate an AndroidManifest.xml for each split.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001922 std::unique_ptr<xml::XmlResource> split_manifest =
Adam Lesinski490595a2017-11-07 17:08:07 -08001923 GenerateSplitManifest(app_info_, *split_constraints_iter);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001924
1925 XmlReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001926 if (!linker.Consume(context_, split_manifest.get())) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001927 context_->GetDiagnostics()->Error(DiagMessage()
1928 << "failed to create Split AndroidManifest.xml");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001929 return 1;
1930 }
1931
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001932 if (!WriteApk(archive_writer.get(), &proguard_keep_set, split_manifest.get(),
1933 split_table.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001934 return 1;
1935 }
1936
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001937 ++path_iter;
1938 ++split_constraints_iter;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001939 }
1940 }
1941
1942 // Start writing the base APK.
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001943 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(options_.output_path);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001944 if (!archive_writer) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001945 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001946 return 1;
1947 }
1948
1949 bool error = false;
1950 {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001951 // AndroidManifest.xml has no resource name, but the CallSite is built from the name
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001952 // (aka, which package the AndroidManifest.xml is coming from).
1953 // So we give it a package name so it can see local resources.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001954 manifest_xml->file.name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001955
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001956 XmlReferenceLinker manifest_linker;
1957 if (manifest_linker.Consume(context_, manifest_xml.get())) {
1958 if (options_.generate_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001959 !proguard::CollectProguardRulesForManifest(manifest_xml.get(), &proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001960 error = true;
1961 }
1962
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001963 if (options_.generate_main_dex_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001964 !proguard::CollectProguardRulesForManifest(manifest_xml.get(),
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001965 &proguard_main_dex_keep_set, true)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001966 error = true;
Alexandria Cornwall637b4822016-08-11 09:53:16 -07001967 }
1968
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001969 if (options_.generate_java_class_path) {
1970 if (!WriteManifestJavaFile(manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001971 error = true;
1972 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001973 }
1974
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001975 if (options_.no_xml_namespaces) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001976 // PackageParser will fail if URIs are removed from
1977 // AndroidManifest.xml.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001978 XmlNamespaceRemover namespace_remover(true /* keepUris */);
1979 if (!namespace_remover.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001980 error = true;
1981 }
Rohit Agrawale49bb302016-04-22 12:27:55 -07001982 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001983 } else {
1984 error = true;
1985 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001986 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001987
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001988 if (error) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001989 context_->GetDiagnostics()->Error(DiagMessage() << "failed processing manifest");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001990 return 1;
1991 }
Adam Lesinskia6fe3452015-12-09 15:20:52 -08001992
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001993 if (!WriteApk(archive_writer.get(), &proguard_keep_set, manifest_xml.get(), &final_table_)) {
1994 return 1;
1995 }
1996
1997 if (!CopyAssetsDirsToApk(archive_writer.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001998 return 1;
1999 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08002000
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00002001 if (options_.generate_java_class_path || options_.generate_text_symbols_path) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07002002 if (!GenerateJavaClasses()) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08002003 return 1;
2004 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002005 }
2006
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08002007 if (!WriteProguardFile(options_.generate_proguard_rules_path, proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002008 return 1;
2009 }
2010
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002011 if (!WriteProguardFile(options_.generate_main_dex_proguard_rules_path,
2012 proguard_main_dex_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002013 return 1;
2014 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002015 return 0;
2016 }
2017
2018 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002019 LinkOptions options_;
2020 LinkContext* context_;
2021 ResourceTable final_table_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002022
Adam Lesinski490595a2017-11-07 17:08:07 -08002023 AppInfo app_info_;
2024
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002025 std::unique_ptr<TableMerger> table_merger_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002026
2027 // A pointer to the FileCollection representing the filesystem (not archives).
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002028 std::unique_ptr<io::FileCollection> file_collection_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002029
Adam Lesinski8780eb62017-10-31 17:44:39 -07002030 // A vector of IFileCollections. This is mainly here to retain ownership of the
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002031 // collections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002032 std::vector<std::unique_ptr<io::IFileCollection>> collections_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002033
Adam Lesinski8780eb62017-10-31 17:44:39 -07002034 // The set of merged APKs. This is mainly here to retain ownership of the APKs.
2035 std::vector<std::unique_ptr<LoadedApk>> merged_apks_;
2036
2037 // The set of included APKs (not merged). This is mainly here to retain ownership of the APKs.
2038 std::vector<std::unique_ptr<LoadedApk>> static_library_includes_;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08002039
2040 // The set of shared libraries being used, mapping their assigned package ID to package name.
2041 std::map<size_t, std::string> shared_libs_;
Adam Lesinski490595a2017-11-07 17:08:07 -08002042
2043 // The package name of the base application, if it is included.
2044 Maybe<std::string> included_feature_base_;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002045};
2046
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002047int LinkCommand::Action(const std::vector<std::string>& args) {
2048 LinkContext context(diag_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002049
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002050 // Expand all argument-files passed into the command line. These start with '@'.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002051 std::vector<std::string> arg_list;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002052 for (const std::string& arg : args) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002053 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002054 const std::string path = arg.substr(1, arg.size() - 1);
2055 std::string error;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002056 if (!file::AppendArgsFromFile(path, &arg_list, &error)) {
2057 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002058 return 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002059 }
2060 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002061 arg_list.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002062 }
2063 }
2064
2065 // Expand all argument-files passed to -R.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002066 for (const std::string& arg : overlay_arg_list_) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002067 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002068 const std::string path = arg.substr(1, arg.size() - 1);
2069 std::string error;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002070 if (!file::AppendArgsFromFile(path, &options_.overlay_files, &error)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002071 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002072 return 1;
2073 }
2074 } else {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002075 options_.overlay_files.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002076 }
2077 }
2078
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002079 if (verbose_) {
2080 context.SetVerbose(verbose_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002081 }
2082
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002083 if (int{shared_lib_} + int{static_lib_} + int{proto_format_} > 1) {
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002084 context.GetDiagnostics()->Error(
2085 DiagMessage()
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002086 << "only one of --shared-lib, --static-lib, or --proto_format can be defined");
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002087 return 1;
2088 }
2089
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002090 // The default build type.
2091 context.SetPackageType(PackageType::kApp);
2092 context.SetPackageId(kAppPackageId);
2093
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002094 if (shared_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002095 context.SetPackageType(PackageType::kSharedLib);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002096 context.SetPackageId(0x00);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002097 } else if (static_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002098 context.SetPackageType(PackageType::kStaticLib);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002099 options_.output_format = OutputFormat::kProto;
2100 } else if (proto_format_) {
2101 options_.output_format = OutputFormat::kProto;
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002102 }
2103
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002104 if (package_id_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002105 if (context.GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002106 context.GetDiagnostics()->Error(
2107 DiagMessage() << "can't specify --package-id when not building a regular app");
2108 return 1;
2109 }
2110
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002111 const Maybe<uint32_t> maybe_package_id_int = ResourceUtils::ParseInt(package_id_.value());
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002112 if (!maybe_package_id_int) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002113 context.GetDiagnostics()->Error(DiagMessage() << "package ID '" << package_id_.value()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002114 << "' is not a valid integer");
2115 return 1;
2116 }
2117
2118 const uint32_t package_id_int = maybe_package_id_int.value();
Todd Kennedy32512992018-04-25 16:45:59 -07002119 if (package_id_int > std::numeric_limits<uint8_t>::max()
2120 || package_id_int == kFrameworkPackageId
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002121 || (!options_.allow_reserved_package_id && package_id_int < kAppPackageId)) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002122 context.GetDiagnostics()->Error(
2123 DiagMessage() << StringPrintf(
2124 "invalid package ID 0x%02x. Must be in the range 0x7f-0xff.", package_id_int));
2125 return 1;
2126 }
2127 context.SetPackageId(static_cast<uint8_t>(package_id_int));
2128 }
2129
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002130 // Populate the set of extra packages for which to generate R.java.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002131 for (std::string& extra_package : extra_java_packages_) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002132 // A given package can actually be a colon separated list of packages.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002133 for (StringPiece package : util::Split(extra_package, ':')) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002134 options_.extra_java_packages.insert(package.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002135 }
2136 }
2137
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002138 if (product_list_) {
2139 for (StringPiece product : util::Tokenize(product_list_.value(), ',')) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002140 if (product != "" && product != "default") {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002141 options_.products.insert(product.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002142 }
2143 }
2144 }
2145
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002146 std::unique_ptr<IConfigFilter> filter;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002147 if (!configs_.empty()) {
2148 filter = ParseConfigFilterParameters(configs_, context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002149 if (filter == nullptr) {
2150 return 1;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002151 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002152 options_.table_splitter_options.config_filter = filter.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002153 }
2154
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002155 if (preferred_density_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002156 Maybe<uint16_t> density =
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002157 ParseTargetDensityParameter(preferred_density_.value(), context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002158 if (!density) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002159 return 1;
Adam Lesinskic51562c2016-04-28 11:12:38 -07002160 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002161 options_.table_splitter_options.preferred_densities.push_back(density.value());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002162 }
Adam Lesinskic51562c2016-04-28 11:12:38 -07002163
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002164 // Parse the split parameters.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002165 for (const std::string& split_arg : split_args_) {
2166 options_.split_paths.push_back({});
2167 options_.split_constraints.push_back({});
2168 if (!ParseSplitParameter(split_arg, context.GetDiagnostics(), &options_.split_paths.back(),
2169 &options_.split_constraints.back())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002170 return 1;
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002171 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002172 }
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002173
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002174 if (context.GetPackageType() != PackageType::kStaticLib && stable_id_file_path_) {
2175 if (!LoadStableIdMap(context.GetDiagnostics(), stable_id_file_path_.value(),
2176 &options_.stable_id_map)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002177 return 1;
Adam Lesinski64587af2016-02-18 18:33:06 -08002178 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002179 }
Adam Lesinski64587af2016-02-18 18:33:06 -08002180
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01002181 if (no_compress_regex) {
2182 std::string regex = no_compress_regex.value();
2183 if (util::StartsWith(regex, "@")) {
2184 const std::string path = regex.substr(1, regex.size() -1);
2185 std::string error;
2186 if (!file::AppendSetArgsFromFile(path, &options_.extensions_to_not_compress, &error)) {
2187 context.GetDiagnostics()->Error(DiagMessage(path) << error);
2188 return 1;
2189 }
2190 } else {
2191 options_.regex_to_not_compress = GetRegularExpression(no_compress_regex.value());
2192 }
2193 }
2194
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002195 // Populate some default no-compress extensions that are already compressed.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002196 options_.extensions_to_not_compress.insert(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002197 {".jpg", ".jpeg", ".png", ".gif", ".wav", ".mp2", ".mp3", ".ogg",
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002198 ".aac", ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet", ".rtttl",
2199 ".imy", ".xmf", ".mp4", ".m4a", ".m4v", ".3gp", ".3gpp", ".3g2",
2200 ".3gpp2", ".amr", ".awb", ".wma", ".wmv", ".webm", ".mkv"});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002201
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002202 // Turn off auto versioning for static-libs.
Adam Lesinskib522f042017-04-21 16:57:59 -07002203 if (context.GetPackageType() == PackageType::kStaticLib) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002204 options_.no_auto_version = true;
2205 options_.no_version_vectors = true;
2206 options_.no_version_transitions = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002207 }
Adam Lesinskie4bb9eb2016-02-12 22:18:51 -08002208
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002209 Linker cmd(&context, options_);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002210 return cmd.Run(arg_list);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002211}
2212
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002213} // namespace aapt