blob: 4b977225fd0152ed2d82cf4c5f375a6a2c10df8c [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"
Fabien Sanglard2d34e762019-02-21 15:13:29 -080070#include "trace/TraceBuffer.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070071#include "util/Files.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080072#include "xml/XmlDom.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070073
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070074using ::aapt::io::FileInputStream;
Mårten Kongstad24c9aa62018-06-20 08:46:41 +020075using ::android::ConfigDescription;
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070076using ::android::StringPiece;
77using ::android::base::StringPrintf;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070078
Adam Lesinski1ab598f2015-08-14 14:26:04 -070079namespace aapt {
80
Adam Lesinski64587af2016-02-18 18:33:06 -080081class LinkContext : public IAaptContext {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070082 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -080083 explicit LinkContext(IDiagnostics* diagnostics)
Chris Warrington820d72a2017-04-27 15:27:01 +010084 : diagnostics_(diagnostics), name_mangler_({}), symbols_(&name_mangler_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -070085 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070086
Adam Lesinskib522f042017-04-21 16:57:59 -070087 PackageType GetPackageType() override {
88 return package_type_;
89 }
90
91 void SetPackageType(PackageType type) {
92 package_type_ = type;
93 }
94
Adam Lesinskid0f492d2017-04-03 18:12:45 -070095 IDiagnostics* GetDiagnostics() override {
Chris Warrington820d72a2017-04-27 15:27:01 +010096 return diagnostics_;
Adam Lesinskid0f492d2017-04-03 18:12:45 -070097 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070098
Adam Lesinskid0f492d2017-04-03 18:12:45 -070099 NameMangler* GetNameMangler() override {
100 return &name_mangler_;
101 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700102
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700103 void SetNameManglerPolicy(const NameManglerPolicy& policy) {
104 name_mangler_ = NameMangler(policy);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700105 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800106
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700107 const std::string& GetCompilationPackage() override {
108 return compilation_package_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700109 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700110
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700111 void SetCompilationPackage(const StringPiece& package_name) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800112 compilation_package_ = package_name.to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700113 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800114
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700115 uint8_t GetPackageId() override {
116 return package_id_;
117 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700118
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700119 void SetPackageId(uint8_t id) {
120 package_id_ = id;
121 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800122
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700123 SymbolTable* GetExternalSymbols() override {
124 return &symbols_;
125 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800126
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700127 bool IsVerbose() override {
128 return verbose_;
129 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800130
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700131 void SetVerbose(bool val) {
132 verbose_ = val;
133 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800134
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700135 int GetMinSdkVersion() override {
136 return min_sdk_version_;
137 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700138
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700139 void SetMinSdkVersion(int minSdk) {
140 min_sdk_version_ = minSdk;
141 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700142
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700143 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700144 DISALLOW_COPY_AND_ASSIGN(LinkContext);
145
Adam Lesinskib522f042017-04-21 16:57:59 -0700146 PackageType package_type_ = PackageType::kApp;
Chris Warrington820d72a2017-04-27 15:27:01 +0100147 IDiagnostics* diagnostics_;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700148 NameMangler name_mangler_;
149 std::string compilation_package_;
150 uint8_t package_id_ = 0x0;
151 SymbolTable symbols_;
152 bool verbose_ = false;
153 int min_sdk_version_ = 0;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700154};
155
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700156// A custom delegate that generates compatible pre-O IDs for use with feature splits.
157// Feature splits use package IDs > 7f, which in Java (since Java doesn't have unsigned ints)
158// is interpreted as a negative number. Some verification was wrongly assuming negative values
159// were invalid.
160//
161// This delegate will attempt to masquerade any '@id/' references with ID 0xPPTTEEEE,
162// where PP > 7f, as 0x7fPPEEEE. Any potential overlapping is verified and an error occurs if such
163// an overlap exists.
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800164//
165// See b/37498913.
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700166class FeatureSplitSymbolTableDelegate : public DefaultSymbolTableDelegate {
167 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -0800168 explicit FeatureSplitSymbolTableDelegate(IAaptContext* context) : context_(context) {
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700169 }
170
171 virtual ~FeatureSplitSymbolTableDelegate() = default;
172
173 virtual std::unique_ptr<SymbolTable::Symbol> FindByName(
174 const ResourceName& name,
175 const std::vector<std::unique_ptr<ISymbolSource>>& sources) override {
176 std::unique_ptr<SymbolTable::Symbol> symbol =
177 DefaultSymbolTableDelegate::FindByName(name, sources);
178 if (symbol == nullptr) {
179 return {};
180 }
181
182 // Check to see if this is an 'id' with the target package.
183 if (name.type == ResourceType::kId && symbol->id) {
184 ResourceId* id = &symbol->id.value();
185 if (id->package_id() > kAppPackageId) {
186 // Rewrite the resource ID to be compatible pre-O.
187 ResourceId rewritten_id(kAppPackageId, id->package_id(), id->entry_id());
188
189 // Check that this doesn't overlap another resource.
190 if (DefaultSymbolTableDelegate::FindById(rewritten_id, sources) != nullptr) {
191 // The ID overlaps, so log a message (since this is a weird failure) and fail.
192 context_->GetDiagnostics()->Error(DiagMessage() << "Failed to rewrite " << name
193 << " for pre-O feature split support");
194 return {};
195 }
196
197 if (context_->IsVerbose()) {
198 context_->GetDiagnostics()->Note(DiagMessage() << "rewriting " << name << " (" << *id
199 << ") -> (" << rewritten_id << ")");
200 }
201
202 *id = rewritten_id;
203 }
204 }
205 return symbol;
206 }
207
208 private:
209 DISALLOW_COPY_AND_ASSIGN(FeatureSplitSymbolTableDelegate);
210
211 IAaptContext* context_;
212};
213
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700214static bool FlattenXml(IAaptContext* context, const xml::XmlResource& xml_res,
215 const StringPiece& path, bool keep_raw_values, bool utf16,
216 OutputFormat format, IArchiveWriter* writer) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800217 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700218 if (context->IsVerbose()) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700219 context->GetDiagnostics()->Note(DiagMessage(path) << "writing to archive (keep_raw_values="
220 << (keep_raw_values ? "true" : "false")
221 << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700222 }
223
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700224 switch (format) {
225 case OutputFormat::kApk: {
226 BigBuffer buffer(1024);
227 XmlFlattenerOptions options = {};
228 options.keep_raw_values = keep_raw_values;
229 options.use_utf16 = utf16;
230 XmlFlattener flattener(&buffer, options);
231 if (!flattener.Consume(context, &xml_res)) {
232 return false;
233 }
234
235 io::BigBufferInputStream input_stream(&buffer);
236 return io::CopyInputStreamToArchive(context, &input_stream, path.to_string(),
237 ArchiveEntry::kCompress, writer);
238 } break;
239
240 case OutputFormat::kProto: {
241 pb::XmlNode pb_node;
Ryan Mitchell467b6892018-11-09 15:52:07 -0800242 // Strip whitespace text nodes from tha AndroidManifest.xml
243 SerializeXmlOptions options;
244 options.remove_empty_text_nodes = (path == kAndroidManifestPath);
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700245 SerializeXmlResourceToPb(xml_res, &pb_node);
246 return io::CopyProtoToArchive(context, &pb_node, path.to_string(), ArchiveEntry::kCompress,
247 writer);
248 } break;
249 }
250 return false;
Adam Lesinski355f2852016-02-13 20:26:45 -0800251}
252
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700253// Inflates an XML file from the source path.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700254static std::unique_ptr<xml::XmlResource> LoadXml(const std::string& path, IDiagnostics* diag) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800255 TRACE_CALL();
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700256 FileInputStream fin(path);
257 if (fin.HadError()) {
258 diag->Error(DiagMessage(path) << "failed to load XML file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700259 return {};
260 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700261 return xml::Inflate(&fin, diag, Source(path));
Adam Lesinski355f2852016-02-13 20:26:45 -0800262}
263
Adam Lesinski355f2852016-02-13 20:26:45 -0800264struct ResourceFileFlattenerOptions {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700265 bool no_auto_version = false;
266 bool no_version_vectors = false;
Yuichi Araki4d35cca2017-01-18 20:42:17 +0900267 bool no_version_transitions = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700268 bool no_xml_namespaces = false;
269 bool keep_raw_values = false;
270 bool do_not_compress_anything = false;
271 bool update_proguard_spec = false;
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700272 OutputFormat output_format = OutputFormat::kApk;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700273 std::unordered_set<std::string> extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100274 Maybe<std::regex> regex_to_not_compress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800275};
276
Adam Lesinskic744ae82017-05-17 19:28:38 -0700277// A sampling of public framework resource IDs.
278struct R {
279 struct attr {
280 enum : uint32_t {
281 paddingLeft = 0x010100d6u,
282 paddingRight = 0x010100d8u,
283 paddingHorizontal = 0x0101053du,
284
285 paddingTop = 0x010100d7u,
286 paddingBottom = 0x010100d9u,
287 paddingVertical = 0x0101053eu,
288
289 layout_marginLeft = 0x010100f7u,
290 layout_marginRight = 0x010100f9u,
291 layout_marginHorizontal = 0x0101053bu,
292
293 layout_marginTop = 0x010100f8u,
294 layout_marginBottom = 0x010100fau,
295 layout_marginVertical = 0x0101053cu,
296 };
297 };
298};
299
Ryan Mitchell81dfca02019-06-07 10:20:27 -0700300template <typename T>
301uint32_t GetCompressionFlags(const StringPiece& str, T options) {
302 if (options.do_not_compress_anything) {
303 return 0;
304 }
305
306 if (options.regex_to_not_compress
307 && std::regex_search(str.to_string(), options.regex_to_not_compress.value())) {
308 return 0;
309 }
310
311 for (const std::string& extension : options.extensions_to_not_compress) {
312 if (util::EndsWith(str, extension)) {
313 return 0;
314 }
315 }
316 return ArchiveEntry::kCompress;
317}
318
Adam Lesinski355f2852016-02-13 20:26:45 -0800319class ResourceFileFlattener {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700320 public:
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700321 ResourceFileFlattener(const ResourceFileFlattenerOptions& options, IAaptContext* context,
Adam Lesinskic744ae82017-05-17 19:28:38 -0700322 proguard::KeepSet* keep_set);
Adam Lesinski355f2852016-02-13 20:26:45 -0800323
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700324 bool Flatten(ResourceTable* table, IArchiveWriter* archive_writer);
Adam Lesinski355f2852016-02-13 20:26:45 -0800325
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700326 private:
327 struct FileOperation {
328 ConfigDescription config;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700329
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700330 // The entry this file came from.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700331 ResourceEntry* entry;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700332
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700333 // The file to copy as-is.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700334 io::IFile* file_to_copy;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700335
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700336 // The XML to process and flatten.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700337 std::unique_ptr<xml::XmlResource> xml_to_flatten;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700338
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700339 // The destination to write this file to.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700340 std::string dst_path;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700341 };
Adam Lesinski355f2852016-02-13 20:26:45 -0800342
Adam Lesinskic744ae82017-05-17 19:28:38 -0700343 std::vector<std::unique_ptr<xml::XmlResource>> LinkAndVersionXmlFile(ResourceTable* table,
344 FileOperation* file_op);
Adam Lesinski355f2852016-02-13 20:26:45 -0800345
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700346 ResourceFileFlattenerOptions options_;
347 IAaptContext* context_;
348 proguard::KeepSet* keep_set_;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700349 XmlCompatVersioner::Rules rules_;
Adam Lesinski355f2852016-02-13 20:26:45 -0800350};
351
Adam Lesinskic744ae82017-05-17 19:28:38 -0700352ResourceFileFlattener::ResourceFileFlattener(const ResourceFileFlattenerOptions& options,
353 IAaptContext* context, proguard::KeepSet* keep_set)
354 : options_(options), context_(context), keep_set_(keep_set) {
355 SymbolTable* symm = context_->GetExternalSymbols();
356
357 // Build up the rules for degrading newer attributes to older ones.
358 // NOTE(adamlesinski): These rules are hardcoded right now, but they should be
359 // generated from the attribute definitions themselves (b/62028956).
360 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingHorizontal)) {
361 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800362 {"paddingLeft", R::attr::paddingLeft, Attribute(android::ResTable_map::TYPE_DIMENSION)},
363 {"paddingRight", R::attr::paddingRight, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700364 };
365 rules_[R::attr::paddingHorizontal] =
366 util::make_unique<DegradeToManyRule>(std::move(replacements));
367 }
368
369 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingVertical)) {
370 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800371 {"paddingTop", R::attr::paddingTop, Attribute(android::ResTable_map::TYPE_DIMENSION)},
372 {"paddingBottom", R::attr::paddingBottom, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700373 };
374 rules_[R::attr::paddingVertical] =
375 util::make_unique<DegradeToManyRule>(std::move(replacements));
376 }
377
378 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginHorizontal)) {
379 std::vector<ReplacementAttr> replacements{
380 {"layout_marginLeft", R::attr::layout_marginLeft,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800381 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700382 {"layout_marginRight", R::attr::layout_marginRight,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800383 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700384 };
385 rules_[R::attr::layout_marginHorizontal] =
386 util::make_unique<DegradeToManyRule>(std::move(replacements));
387 }
388
389 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginVertical)) {
390 std::vector<ReplacementAttr> replacements{
391 {"layout_marginTop", R::attr::layout_marginTop,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800392 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700393 {"layout_marginBottom", R::attr::layout_marginBottom,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800394 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700395 };
396 rules_[R::attr::layout_marginVertical] =
397 util::make_unique<DegradeToManyRule>(std::move(replacements));
398 }
399}
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" ||
Winsona00d9692019-01-24 15:55:29 -0800411 name == "objectAnimator" || name == "gradient" || name == "animated-selector" ||
412 name == "set";
Adam Lesinskibb94f322017-07-12 07:41:55 -0700413}
414
Adam Lesinskic744ae82017-05-17 19:28:38 -0700415template <typename T>
416std::vector<T> make_singleton_vec(T&& val) {
417 std::vector<T> vec;
418 vec.emplace_back(std::forward<T>(val));
419 return vec;
420}
421
422std::vector<std::unique_ptr<xml::XmlResource>> ResourceFileFlattener::LinkAndVersionXmlFile(
423 ResourceTable* table, FileOperation* file_op) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800424 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700425 xml::XmlResource* doc = file_op->xml_to_flatten.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700426 const Source& src = doc->file.source;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700427
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700428 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700429 context_->GetDiagnostics()->Note(DiagMessage()
430 << "linking " << src.path << " (" << doc->file.name << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700431 }
432
Adam Lesinski00451162017-10-03 07:44:08 -0700433 // First, strip out any tools namespace attributes. AAPT stripped them out early, which means
434 // that existing projects have out-of-date references which pass compilation.
435 xml::StripAndroidStudioAttributes(doc->root.get());
436
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700437 XmlReferenceLinker xml_linker;
438 if (!xml_linker.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700439 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700440 }
441
Ryan Mitchell9a2f6e62018-05-23 14:23:18 -0700442 if (options_.update_proguard_spec && !proguard::CollectProguardRules(context_, doc, keep_set_)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700443 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700444 }
445
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700446 if (options_.no_xml_namespaces) {
447 XmlNamespaceRemover namespace_remover;
448 if (!namespace_remover.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700449 return {};
Adam Lesinski355f2852016-02-13 20:26:45 -0800450 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700451 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800452
Adam Lesinskibb94f322017-07-12 07:41:55 -0700453 if (options_.no_auto_version) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700454 return make_singleton_vec(std::move(file_op->xml_to_flatten));
455 }
Alexandria Cornwalla7cc3f12016-08-16 13:33:32 -0700456
Adam Lesinskibb94f322017-07-12 07:41:55 -0700457 if (options_.no_version_vectors || options_.no_version_transitions) {
458 // Skip this if it is a vector or animated-vector.
Adam Lesinski6b372992017-08-09 10:54:23 -0700459 xml::Element* el = doc->root.get();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700460 if (el && el->namespace_uri.empty()) {
461 if ((options_.no_version_vectors && IsVectorElement(el->name)) ||
462 (options_.no_version_transitions && IsTransitionElement(el->name))) {
463 return make_singleton_vec(std::move(file_op->xml_to_flatten));
464 }
465 }
466 }
467
Adam Lesinskic744ae82017-05-17 19:28:38 -0700468 const ConfigDescription& config = file_op->config;
469 ResourceEntry* entry = file_op->entry;
470
471 XmlCompatVersioner xml_compat_versioner(&rules_);
472 const util::Range<ApiVersion> api_range{config.sdkVersion,
473 FindNextApiVersionForConfig(entry, config)};
474 return xml_compat_versioner.Process(context_, doc, api_range);
Adam Lesinski355f2852016-02-13 20:26:45 -0800475}
476
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800477ResourceFile::Type XmlFileTypeForOutputFormat(OutputFormat format) {
478 switch (format) {
479 case OutputFormat::kApk:
480 return ResourceFile::Type::kBinaryXml;
481 case OutputFormat::kProto:
482 return ResourceFile::Type::kProtoXml;
483 }
484 LOG_ALWAYS_FATAL("unreachable");
485 return ResourceFile::Type::kUnknown;
486}
487
Ryan Mitchell70f79722018-08-13 07:37:24 -0700488static auto kDrawableVersions = std::map<std::string, ApiVersion>{
489 { "adaptive-icon" , SDK_O },
490};
491
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700492bool ResourceFileFlattener::Flatten(ResourceTable* table, IArchiveWriter* archive_writer) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800493 TRACE_CALL();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700494 bool error = false;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700495 std::map<std::pair<ConfigDescription, StringPiece>, FileOperation> config_sorted_files;
Adam Lesinski355f2852016-02-13 20:26:45 -0800496
Adam Koskidc21dea2017-07-21 10:55:27 -0700497 proguard::CollectResourceReferences(context_, table, keep_set_);
498
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700499 for (auto& pkg : table->packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700500 CHECK(!pkg->name.empty()) << "Packages must have names when being linked";
501
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700502 for (auto& type : pkg->types) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700503 // Sort by config and name, so that we get better locality in the zip file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700504 config_sorted_files.clear();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700505 std::queue<FileOperation> file_operations;
Adam Lesinski355f2852016-02-13 20:26:45 -0800506
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700507 // Populate the queue with all files in the ResourceTable.
508 for (auto& entry : type->entries) {
Adam Lesinskibb94f322017-07-12 07:41:55 -0700509 for (auto& config_value : entry->values) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700510 // WARNING! Do not insert or remove any resources while executing in this scope. It will
511 // corrupt the iteration order.
512
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700513 FileReference* file_ref = ValueCast<FileReference>(config_value->value.get());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700514 if (!file_ref) {
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700515 continue;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700516 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700517
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700518 io::IFile* file = file_ref->file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700519 if (!file) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700520 context_->GetDiagnostics()->Error(DiagMessage(file_ref->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700521 << "file not found");
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700522 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700523 }
524
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700525 FileOperation file_op;
526 file_op.entry = entry.get();
527 file_op.dst_path = *file_ref->path;
528 file_op.config = config_value->config;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700529 file_op.file_to_copy = file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700530
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700531 if (type->type != ResourceType::kRaw &&
Adam Lesinski00451162017-10-03 07:44:08 -0700532 (file_ref->type == ResourceFile::Type::kBinaryXml ||
533 file_ref->type == ResourceFile::Type::kProtoXml)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700534 std::unique_ptr<io::IData> data = file->OpenAsData();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700535 if (!data) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700536 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700537 << "failed to open file");
538 return false;
539 }
540
Adam Lesinski00451162017-10-03 07:44:08 -0700541 if (file_ref->type == ResourceFile::Type::kProtoXml) {
542 pb::XmlNode pb_xml_node;
543 if (!pb_xml_node.ParseFromArray(data->data(), static_cast<int>(data->size()))) {
544 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700545 << "failed to parse proto XML");
Adam Lesinski00451162017-10-03 07:44:08 -0700546 return false;
547 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700548
Adam Lesinski00451162017-10-03 07:44:08 -0700549 std::string error;
550 file_op.xml_to_flatten = DeserializeXmlResourceFromPb(pb_xml_node, &error);
551 if (file_op.xml_to_flatten == nullptr) {
552 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700553 << "failed to deserialize proto XML: " << error);
Adam Lesinski00451162017-10-03 07:44:08 -0700554 return false;
555 }
556 } else {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700557 std::string error_str;
558 file_op.xml_to_flatten = xml::Inflate(data->data(), data->size(), &error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700559 if (file_op.xml_to_flatten == nullptr) {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700560 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
561 << "failed to parse binary XML: " << error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700562 return false;
563 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700564 }
565
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800566 // Update the type that this file will be written as.
567 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
568
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700569 file_op.xml_to_flatten->file.config = config_value->config;
570 file_op.xml_to_flatten->file.source = file_ref->GetSource();
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700571 file_op.xml_to_flatten->file.name = ResourceName(pkg->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700572 }
Adam Lesinskic744ae82017-05-17 19:28:38 -0700573
574 // NOTE(adamlesinski): Explicitly construct a StringPiece here, or
575 // else we end up copying the string in the std::make_pair() method,
576 // then creating a StringPiece from the copy, which would cause us
577 // to end up referencing garbage in the map.
578 const StringPiece entry_name(entry->name);
579 config_sorted_files[std::make_pair(config_value->config, entry_name)] =
580 std::move(file_op);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700581 }
582 }
583
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700584 // Now flatten the sorted values.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700585 for (auto& map_entry : config_sorted_files) {
586 const ConfigDescription& config = map_entry.first.first;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700587 FileOperation& file_op = map_entry.second;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700588
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700589 if (file_op.xml_to_flatten) {
Ryan Mitchell70f79722018-08-13 07:37:24 -0700590 // Check minimum sdk versions supported for drawables
591 auto drawable_entry = kDrawableVersions.find(file_op.xml_to_flatten->root->name);
592 if (drawable_entry != kDrawableVersions.end()) {
593 if (drawable_entry->second > context_->GetMinSdkVersion()
594 && drawable_entry->second > config.sdkVersion) {
595 context_->GetDiagnostics()->Error(DiagMessage(file_op.xml_to_flatten->file.source)
596 << "<" << drawable_entry->first << "> elements "
597 << "require a sdk version of at least "
598 << (int16_t) drawable_entry->second);
599 error = true;
600 continue;
601 }
602 }
603
Adam Lesinskic744ae82017-05-17 19:28:38 -0700604 std::vector<std::unique_ptr<xml::XmlResource>> versioned_docs =
605 LinkAndVersionXmlFile(table, &file_op);
Adam Lesinskic0a5e1e2017-08-07 11:56:32 -0700606 if (versioned_docs.empty()) {
607 error = true;
608 continue;
609 }
610
Adam Lesinskic744ae82017-05-17 19:28:38 -0700611 for (std::unique_ptr<xml::XmlResource>& doc : versioned_docs) {
612 std::string dst_path = file_op.dst_path;
613 if (doc->file.config != file_op.config) {
614 // Only add the new versioned configurations.
615 if (context_->IsVerbose()) {
616 context_->GetDiagnostics()->Note(DiagMessage(doc->file.source)
617 << "auto-versioning resource from config '"
618 << config << "' -> '" << doc->file.config << "'");
619 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700620
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800621 const ResourceFile& file = doc->file;
622 dst_path = ResourceUtils::BuildResourceFileName(file, context_->GetNameMangler());
623
624 std::unique_ptr<FileReference> file_ref =
625 util::make_unique<FileReference>(table->string_pool.MakeRef(dst_path));
626 file_ref->SetSource(doc->file.source);
627 // Update the output format of this XML file.
628 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
629 if (!table->AddResourceMangled(file.name, file.config, {}, std::move(file_ref),
630 context_->GetDiagnostics())) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700631 return false;
632 }
633 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700634
635 error |= !FlattenXml(context_, *doc, dst_path, options_.keep_raw_values,
636 false /*utf16*/, options_.output_format, archive_writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700637 }
638 } else {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700639 error |= !io::CopyFileToArchive(context_, file_op.file_to_copy, file_op.dst_path,
Ryan Mitchell81dfca02019-06-07 10:20:27 -0700640 GetCompressionFlags(file_op.dst_path, options_),
641 archive_writer);
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700642 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700643 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700644 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700645 }
646 return !error;
647}
648
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700649static bool WriteStableIdMapToPath(IDiagnostics* diag,
650 const std::unordered_map<ResourceName, ResourceId>& id_map,
651 const std::string& id_map_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800652 io::FileOutputStream fout(id_map_path);
653 if (fout.HadError()) {
654 diag->Error(DiagMessage(id_map_path) << "failed to open: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700655 return false;
656 }
657
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800658 text::Printer printer(&fout);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700659 for (const auto& entry : id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700660 const ResourceName& name = entry.first;
661 const ResourceId& id = entry.second;
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800662 printer.Print(name.to_string());
663 printer.Print(" = ");
664 printer.Println(id.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700665 }
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800666 fout.Flush();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700667
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800668 if (fout.HadError()) {
669 diag->Error(DiagMessage(id_map_path) << "failed writing to file: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700670 return false;
671 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700672 return true;
673}
674
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700675static bool LoadStableIdMap(IDiagnostics* diag, const std::string& path,
676 std::unordered_map<ResourceName, ResourceId>* out_id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700677 std::string content;
Adam Lesinski2354b562017-05-26 16:31:38 -0700678 if (!android::base::ReadFileToString(path, &content, true /*follow_symlinks*/)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700679 diag->Error(DiagMessage(path) << "failed reading stable ID file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700680 return false;
681 }
682
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700683 out_id_map->clear();
684 size_t line_no = 0;
685 for (StringPiece line : util::Tokenize(content, '\n')) {
686 line_no++;
687 line = util::TrimWhitespace(line);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700688 if (line.empty()) {
689 continue;
690 }
691
692 auto iter = std::find(line.begin(), line.end(), '=');
693 if (iter == line.end()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700694 diag->Error(DiagMessage(Source(path, line_no)) << "missing '='");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700695 return false;
696 }
697
698 ResourceNameRef name;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700699 StringPiece res_name_str =
700 util::TrimWhitespace(line.substr(0, std::distance(line.begin(), iter)));
701 if (!ResourceUtils::ParseResourceName(res_name_str, &name)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700702 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource name '" << res_name_str
703 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700704 return false;
705 }
706
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700707 const size_t res_id_start_idx = std::distance(line.begin(), iter) + 1;
708 const size_t res_id_str_len = line.size() - res_id_start_idx;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700709 StringPiece res_id_str = util::TrimWhitespace(line.substr(res_id_start_idx, res_id_str_len));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700710
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700711 Maybe<ResourceId> maybe_id = ResourceUtils::ParseResourceId(res_id_str);
712 if (!maybe_id) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700713 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource ID '" << res_id_str
714 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700715 return false;
716 }
717
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700718 (*out_id_map)[name.ToResourceName()] = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700719 }
720 return true;
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700721}
722
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800723static android::ApkAssetsCookie FindFrameworkAssetManagerCookie(
724 const android::AssetManager2& assets) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800725 using namespace android;
726
727 // Find the system package (0x01). AAPT always generates attributes with the type 0x01, so
728 // we're looking for the first attribute resource in the system package.
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800729 Res_value val{};
730 ResTable_config config{};
731 uint32_t type_spec_flags;
732 ApkAssetsCookie idx = assets.GetResource(0x01010000, true /** may_be_bag */,
733 0 /** density_override */, &val, &config,
734 &type_spec_flags);
Adam Lesinskic6284372017-12-04 13:46:23 -0800735
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800736 return idx;
Adam Lesinskic6284372017-12-04 13:46:23 -0800737}
738
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700739class Linker {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700740 public:
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700741 Linker(LinkContext* context, const LinkOptions& options)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700742 : options_(options),
743 context_(context),
744 final_table_(),
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700745 file_collection_(util::make_unique<io::FileCollection>()) {
746 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700747
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800748 void ExtractCompileSdkVersions(android::AssetManager2* assets) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800749 using namespace android;
750
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800751 android::ApkAssetsCookie cookie = FindFrameworkAssetManagerCookie(*assets);
752 if (cookie == android::kInvalidCookie) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800753 // No Framework assets loaded. Not a failure.
754 return;
755 }
756
757 std::unique_ptr<Asset> manifest(
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800758 assets->OpenNonAsset(kAndroidManifestPath, cookie, Asset::AccessMode::ACCESS_BUFFER));
Adam Lesinskic6284372017-12-04 13:46:23 -0800759 if (manifest == nullptr) {
760 // No errors.
761 return;
762 }
763
764 std::string error;
765 std::unique_ptr<xml::XmlResource> manifest_xml =
766 xml::Inflate(manifest->getBuffer(true /*wordAligned*/), manifest->getLength(), &error);
767 if (manifest_xml == nullptr) {
768 // No errors.
769 return;
770 }
771
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700772 if (!options_.manifest_fixer_options.compile_sdk_version) {
773 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionCode");
774 if (attr != nullptr) {
775 Maybe<std::string>& compile_sdk_version = options_.manifest_fixer_options.compile_sdk_version;
776 if (BinaryPrimitive* prim = ValueCast<BinaryPrimitive>(attr->compiled_value.get())) {
777 switch (prim->value.dataType) {
778 case Res_value::TYPE_INT_DEC:
779 compile_sdk_version = StringPrintf("%" PRId32, static_cast<int32_t>(prim->value.data));
780 break;
781 case Res_value::TYPE_INT_HEX:
782 compile_sdk_version = StringPrintf("%" PRIx32, prim->value.data);
783 break;
784 default:
785 break;
786 }
787 } else if (String* str = ValueCast<String>(attr->compiled_value.get())) {
788 compile_sdk_version = *str->value;
789 } else {
790 compile_sdk_version = attr->value;
Adam Lesinskic6284372017-12-04 13:46:23 -0800791 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800792 }
793 }
794
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700795 if (!options_.manifest_fixer_options.compile_sdk_version_codename) {
796 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionName");
797 if (attr != nullptr) {
798 Maybe<std::string>& compile_sdk_version_codename =
799 options_.manifest_fixer_options.compile_sdk_version_codename;
800 if (String* str = ValueCast<String>(attr->compiled_value.get())) {
801 compile_sdk_version_codename = *str->value;
802 } else {
803 compile_sdk_version_codename = attr->value;
804 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800805 }
806 }
807 }
808
Adam Lesinski8780eb62017-10-31 17:44:39 -0700809 // Creates a SymbolTable that loads symbols from the various APKs.
Adam Lesinskic6284372017-12-04 13:46:23 -0800810 // Pre-condition: context_->GetCompilationPackage() needs to be set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700811 bool LoadSymbolsFromIncludePaths() {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800812 TRACE_NAME("LoadSymbolsFromIncludePaths: #" + std::to_string(options_.include_paths.size()));
Adam Lesinski8780eb62017-10-31 17:44:39 -0700813 auto asset_source = util::make_unique<AssetManagerSymbolSource>();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700814 for (const std::string& path : options_.include_paths) {
815 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700816 context_->GetDiagnostics()->Note(DiagMessage() << "including " << path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700817 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700818
Adam Lesinski8780eb62017-10-31 17:44:39 -0700819 std::string error;
820 auto zip_collection = io::ZipFileCollection::Create(path, &error);
821 if (zip_collection == nullptr) {
822 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open APK: " << error);
823 return false;
824 }
825
826 if (zip_collection->FindFile(kProtoResourceTablePath) != nullptr) {
827 // Load this as a static library include.
828 std::unique_ptr<LoadedApk> static_apk = LoadedApk::LoadProtoApkFromFileCollection(
829 Source(path), std::move(zip_collection), context_->GetDiagnostics());
830 if (static_apk == nullptr) {
831 return false;
832 }
833
Adam Lesinskib522f042017-04-21 16:57:59 -0700834 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800835 // Can't include static libraries when not building a static library (they have no IDs
836 // assigned).
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700837 context_->GetDiagnostics()->Error(
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800838 DiagMessage(path) << "can't include static library when not building a static lib");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700839 return false;
840 }
841
Adam Lesinski8780eb62017-10-31 17:44:39 -0700842 ResourceTable* table = static_apk->GetResourceTable();
843
844 // If we are using --no-static-lib-packages, we need to rename the package of this table to
845 // our compilation package.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700846 if (options_.no_static_lib_packages) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800847 // Since package names can differ, and multiple packages can exist in a ResourceTable,
848 // we place the requirement that all static libraries are built with the package
849 // ID 0x7f. So if one is not found, this is an error.
Adam Lesinski8780eb62017-10-31 17:44:39 -0700850 if (ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700851 pkg->name = context_->GetCompilationPackage();
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800852 } else {
853 context_->GetDiagnostics()->Error(DiagMessage(path)
854 << "no package with ID 0x7f found in static library");
855 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700856 }
857 }
858
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700859 context_->GetExternalSymbols()->AppendSource(
Adam Lesinski8780eb62017-10-31 17:44:39 -0700860 util::make_unique<ResourceTableSymbolSource>(table));
861 static_library_includes_.push_back(std::move(static_apk));
862 } else {
863 if (!asset_source->AddAssetPath(path)) {
864 context_->GetDiagnostics()->Error(DiagMessage()
865 << "failed to load include path " << path);
866 return false;
867 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700868 }
869 }
870
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800871 // Capture the shared libraries so that the final resource table can be properly flattened
872 // with support for shared libraries.
873 for (auto& entry : asset_source->GetAssignedPackageIds()) {
Todd Kennedy32512992018-04-25 16:45:59 -0700874 if (entry.first == kAppPackageId) {
Adam Lesinski490595a2017-11-07 17:08:07 -0800875 // Capture the included base feature package.
876 included_feature_base_ = entry.second;
Adam Lesinskic6284372017-12-04 13:46:23 -0800877 } else if (entry.first == kFrameworkPackageId) {
878 // Try to embed which version of the framework we're compiling against.
879 // First check if we should use compileSdkVersion at all. Otherwise compilation may fail
880 // when linking our synthesized 'android:compileSdkVersion' attribute.
881 std::unique_ptr<SymbolTable::Symbol> symbol = asset_source->FindByName(
882 ResourceName("android", ResourceType::kAttr, "compileSdkVersion"));
883 if (symbol != nullptr && symbol->is_public) {
884 // The symbol is present and public, extract the android:versionName and
885 // android:versionCode from the framework AndroidManifest.xml.
886 ExtractCompileSdkVersions(asset_source->GetAssetManager());
887 }
Todd Kennedy32512992018-04-25 16:45:59 -0700888 } else if (asset_source->IsPackageDynamic(entry.first)) {
889 final_table_.included_packages_[entry.first] = entry.second;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800890 }
891 }
892
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700893 context_->GetExternalSymbols()->AppendSource(std::move(asset_source));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700894 return true;
895 }
896
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800897 Maybe<AppInfo> ExtractAppInfoFromManifest(xml::XmlResource* xml_res, IDiagnostics* diag) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -0800898 TRACE_CALL();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700899 // Make sure the first element is <manifest> with package attribute.
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800900 xml::Element* manifest_el = xml::FindRootElement(xml_res->root.get());
901 if (manifest_el == nullptr) {
902 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700903 }
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800904
905 AppInfo app_info;
906
907 if (!manifest_el->namespace_uri.empty() || manifest_el->name != "manifest") {
908 diag->Error(DiagMessage(xml_res->file.source) << "root tag must be <manifest>");
909 return {};
910 }
911
912 xml::Attribute* package_attr = manifest_el->FindAttribute({}, "package");
913 if (!package_attr) {
914 diag->Error(DiagMessage(xml_res->file.source)
915 << "<manifest> must have a 'package' attribute");
916 return {};
917 }
918 app_info.package = package_attr->value;
919
920 if (xml::Attribute* version_code_attr =
921 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCode")) {
922 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_attr->value);
923 if (!maybe_code) {
924 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
925 << "invalid android:versionCode '" << version_code_attr->value << "'");
926 return {};
927 }
928 app_info.version_code = maybe_code.value();
929 }
930
Ryan Mitchell5fa2bb12018-07-12 11:24:51 -0700931 if (xml::Attribute* version_code_major_attr =
932 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCodeMajor")) {
933 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_major_attr->value);
934 if (!maybe_code) {
935 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
936 << "invalid android:versionCodeMajor '"
937 << version_code_major_attr->value << "'");
938 return {};
939 }
940 app_info.version_code_major = maybe_code.value();
941 }
942
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800943 if (xml::Attribute* revision_code_attr =
944 manifest_el->FindAttribute(xml::kSchemaAndroid, "revisionCode")) {
945 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(revision_code_attr->value);
946 if (!maybe_code) {
947 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
948 << "invalid android:revisionCode '" << revision_code_attr->value << "'");
949 return {};
950 }
951 app_info.revision_code = maybe_code.value();
952 }
953
954 if (xml::Attribute* split_name_attr = manifest_el->FindAttribute({}, "split")) {
955 if (!split_name_attr->value.empty()) {
956 app_info.split_name = split_name_attr->value;
957 }
958 }
959
960 if (xml::Element* uses_sdk_el = manifest_el->FindChild({}, "uses-sdk")) {
961 if (xml::Attribute* min_sdk =
962 uses_sdk_el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion")) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700963 app_info.min_sdk_version = ResourceUtils::ParseSdkVersion(min_sdk->value);
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800964 }
965 }
966 return app_info;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700967 }
968
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700969 // Precondition: ResourceTable doesn't have any IDs assigned yet, nor is it linked.
970 // Postcondition: ResourceTable has only one package left. All others are
971 // stripped, or there is an error and false is returned.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700972 bool VerifyNoExternalPackages() {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700973 auto is_ext_package_func = [&](const std::unique_ptr<ResourceTablePackage>& pkg) -> bool {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700974 return context_->GetCompilationPackage() != pkg->name || !pkg->id ||
975 pkg->id.value() != context_->GetPackageId();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700976 };
977
978 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700979 for (const auto& package : final_table_.packages) {
980 if (is_ext_package_func(package)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700981 // We have a package that is not related to the one we're building!
982 for (const auto& type : package->types) {
983 for (const auto& entry : type->entries) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700984 ResourceNameRef res_name(package->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700985
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700986 for (const auto& config_value : entry->values) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700987 // Special case the occurrence of an ID that is being generated
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700988 // for the 'android' package. This is due to legacy reasons.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700989 if (ValueCast<Id>(config_value->value.get()) && package->name == "android") {
990 context_->GetDiagnostics()->Warn(DiagMessage(config_value->value->GetSource())
991 << "generated id '" << res_name
992 << "' for external package '" << package->name
993 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700994 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700995 context_->GetDiagnostics()->Error(DiagMessage(config_value->value->GetSource())
996 << "defined resource '" << res_name
997 << "' for external package '" << package->name
998 << "'");
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700999 error = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001000 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001001 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001002 }
1003 }
1004 }
1005 }
1006
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001007 auto new_end_iter = std::remove_if(final_table_.packages.begin(), final_table_.packages.end(),
1008 is_ext_package_func);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001009 final_table_.packages.erase(new_end_iter, final_table_.packages.end());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001010 return !error;
1011 }
1012
1013 /**
1014 * Returns true if no IDs have been set, false otherwise.
1015 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001016 bool VerifyNoIdsSet() {
1017 for (const auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001018 for (const auto& type : package->types) {
1019 if (type->id) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001020 context_->GetDiagnostics()->Error(DiagMessage() << "type " << type->type << " has ID "
1021 << StringPrintf("%02x", type->id.value())
1022 << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001023 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001024 }
1025
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001026 for (const auto& entry : type->entries) {
1027 if (entry->id) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001028 ResourceNameRef res_name(package->name, type->type, entry->name);
1029 context_->GetDiagnostics()->Error(
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001030 DiagMessage() << "entry " << res_name << " has ID "
1031 << StringPrintf("%02x", entry->id.value()) << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001032 return false;
1033 }
1034 }
1035 }
1036 }
1037 return true;
1038 }
1039
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001040 std::unique_ptr<IArchiveWriter> MakeArchiveWriter(const StringPiece& out) {
1041 if (options_.output_to_directory) {
1042 return CreateDirectoryArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001043 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001044 return CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001045 }
1046 }
1047
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001048 bool FlattenTable(ResourceTable* table, OutputFormat format, IArchiveWriter* writer) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001049 TRACE_CALL();
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001050 switch (format) {
1051 case OutputFormat::kApk: {
1052 BigBuffer buffer(1024);
1053 TableFlattener flattener(options_.table_flattener_options, &buffer);
1054 if (!flattener.Consume(context_, table)) {
1055 context_->GetDiagnostics()->Error(DiagMessage() << "failed to flatten resource table");
1056 return false;
1057 }
1058
1059 io::BigBufferInputStream input_stream(&buffer);
1060 return io::CopyInputStreamToArchive(context_, &input_stream, kApkResourceTablePath,
1061 ArchiveEntry::kAlign, writer);
1062 } break;
1063
1064 case OutputFormat::kProto: {
1065 pb::ResourceTable pb_table;
Ryan Mitchella15c2a82018-03-26 11:05:31 -07001066 SerializeTableToPb(*table, &pb_table, context_->GetDiagnostics());
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001067 return io::CopyProtoToArchive(context_, &pb_table, kProtoResourceTablePath,
1068 ArchiveEntry::kCompress, writer);
1069 } break;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001070 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001071 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001072 }
1073
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001074 bool WriteJavaFile(ResourceTable* table, const StringPiece& package_name_to_generate,
Adam Lesinski418763f2017-04-11 17:36:53 -07001075 const StringPiece& out_package, const JavaClassGeneratorOptions& java_options,
Chih-Hung Hsieh4dc58122017-08-03 16:28:10 -07001076 const Maybe<std::string>& out_text_symbols_path = {}) {
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001077 if (!options_.generate_java_class_path && !out_text_symbols_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001078 return true;
1079 }
1080
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001081 std::string out_path;
1082 std::unique_ptr<io::FileOutputStream> fout;
1083 if (options_.generate_java_class_path) {
1084 out_path = options_.generate_java_class_path.value();
1085 file::AppendPath(&out_path, file::PackageToPath(out_package));
1086 if (!file::mkdirs(out_path)) {
1087 context_->GetDiagnostics()->Error(DiagMessage()
1088 << "failed to create directory '" << out_path << "'");
1089 return false;
1090 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001091
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001092 file::AppendPath(&out_path, "R.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001093
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001094 fout = util::make_unique<io::FileOutputStream>(out_path);
1095 if (fout->HadError()) {
1096 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1097 << "': " << fout->GetError());
1098 return false;
1099 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001100 }
1101
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001102 std::unique_ptr<io::FileOutputStream> fout_text;
Adam Lesinski418763f2017-04-11 17:36:53 -07001103 if (out_text_symbols_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001104 fout_text = util::make_unique<io::FileOutputStream>(out_text_symbols_path.value());
1105 if (fout_text->HadError()) {
1106 context_->GetDiagnostics()->Error(DiagMessage()
1107 << "failed writing to '" << out_text_symbols_path.value()
1108 << "': " << fout_text->GetError());
Adam Lesinski418763f2017-04-11 17:36:53 -07001109 return false;
1110 }
1111 }
1112
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001113 JavaClassGenerator generator(context_, table, java_options);
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001114 if (!generator.Generate(package_name_to_generate, out_package, fout.get(), fout_text.get())) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001115 context_->GetDiagnostics()->Error(DiagMessage(out_path) << generator.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001116 return false;
1117 }
1118
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001119 return true;
1120 }
1121
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001122 bool GenerateJavaClasses() {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001123 TRACE_CALL();
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001124 // 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) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001207 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001208 if (!options_.generate_java_class_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001209 return true;
1210 }
1211
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001212 std::unique_ptr<ClassDefinition> manifest_class =
1213 GenerateManifestClass(context_->GetDiagnostics(), manifest_xml);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001214
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001215 if (!manifest_class) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001216 // Something bad happened, but we already logged it, so exit.
1217 return false;
1218 }
1219
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001220 if (manifest_class->empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001221 // Empty Manifest class, no need to generate it.
1222 return true;
1223 }
1224
1225 // Add any JavaDoc annotations to the generated class.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001226 for (const std::string& annotation : options_.javadoc_annotations) {
1227 std::string proper_annotation = "@";
1228 proper_annotation += annotation;
1229 manifest_class->GetCommentBuilder()->AppendComment(proper_annotation);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001230 }
1231
Adam Lesinski0d81f702017-06-27 15:51:09 -07001232 const std::string package_utf8 =
1233 options_.custom_java_package.value_or_default(context_->GetCompilationPackage());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001234
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001235 std::string out_path = options_.generate_java_class_path.value();
1236 file::AppendPath(&out_path, file::PackageToPath(package_utf8));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001237
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001238 if (!file::mkdirs(out_path)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001239 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create directory '" << out_path
1240 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001241 return false;
1242 }
1243
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001244 file::AppendPath(&out_path, "Manifest.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001245
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001246 io::FileOutputStream fout(out_path);
1247 if (fout.HadError()) {
1248 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1249 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001250 return false;
1251 }
1252
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001253 ClassDefinition::WriteJavaFile(manifest_class.get(), package_utf8, true, &fout);
1254 fout.Flush();
1255
1256 if (fout.HadError()) {
1257 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1258 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001259 return false;
1260 }
1261 return true;
1262 }
1263
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001264 bool WriteProguardFile(const Maybe<std::string>& out, const proguard::KeepSet& keep_set) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001265 TRACE_CALL();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001266 if (!out) {
1267 return true;
1268 }
1269
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001270 const std::string& out_path = out.value();
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001271 io::FileOutputStream fout(out_path);
1272 if (fout.HadError()) {
1273 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1274 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001275 return false;
1276 }
1277
Ryan Mitchell7e5236d2018-09-25 15:20:59 -07001278 proguard::WriteKeepSet(keep_set, &fout, options_.generate_minimal_proguard_rules);
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001279 fout.Flush();
1280
1281 if (fout.HadError()) {
1282 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1283 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001284 return false;
1285 }
1286 return true;
1287 }
1288
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001289 bool MergeStaticLibrary(const std::string& input, bool override) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001290 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001291 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001292 context_->GetDiagnostics()->Note(DiagMessage() << "merging static library " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001293 }
1294
Adam Lesinski8780eb62017-10-31 17:44:39 -07001295 std::unique_ptr<LoadedApk> apk = LoadedApk::LoadApkFromPath(input, context_->GetDiagnostics());
1296 if (apk == nullptr) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001297 context_->GetDiagnostics()->Error(DiagMessage(input) << "invalid static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001298 return false;
1299 }
1300
Adam Lesinski8780eb62017-10-31 17:44:39 -07001301 ResourceTable* table = apk->GetResourceTable();
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001302 ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001303 if (!pkg) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001304 context_->GetDiagnostics()->Error(DiagMessage(input) << "static library has no package");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001305 return false;
1306 }
1307
1308 bool result;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001309 if (options_.no_static_lib_packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001310 // Merge all resources as if they were in the compilation package. This is the old behavior
1311 // of aapt.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001312
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001313 // Add the package to the set of --extra-packages so we emit an R.java for each library
1314 // package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001315 if (!pkg->name.empty()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001316 options_.extra_java_packages.insert(pkg->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001317 }
1318
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001319 // Clear the package name, so as to make the resources look like they are coming from the
1320 // local package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001321 pkg->name = "";
Adam Lesinski8780eb62017-10-31 17:44:39 -07001322 result = table_merger_->Merge(Source(input), table, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001323
1324 } else {
1325 // This is the proper way to merge libraries, where the package name is
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001326 // preserved and resource names are mangled.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001327 result = table_merger_->MergeAndMangle(Source(input), pkg->name, table);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001328 }
1329
1330 if (!result) {
1331 return false;
1332 }
1333
1334 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001335 merged_apks_.push_back(std::move(apk));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001336 return true;
1337 }
1338
Adam Lesinski2427dce2017-11-30 15:10:28 -08001339 bool MergeExportedSymbols(const Source& source,
1340 const std::vector<SourcedResourceName>& exported_symbols) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001341 TRACE_CALL();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001342 // Add the exports of this file to the table.
Adam Lesinski2427dce2017-11-30 15:10:28 -08001343 for (const SourcedResourceName& exported_symbol : exported_symbols) {
Adam Lesinski00451162017-10-03 07:44:08 -07001344 ResourceName res_name = exported_symbol.name;
1345 if (res_name.package.empty()) {
1346 res_name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001347 }
1348
Adam Lesinski00451162017-10-03 07:44:08 -07001349 Maybe<ResourceName> mangled_name = context_->GetNameMangler()->MangleName(res_name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001350 if (mangled_name) {
1351 res_name = mangled_name.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001352 }
1353
1354 std::unique_ptr<Id> id = util::make_unique<Id>();
Adam Lesinski2427dce2017-11-30 15:10:28 -08001355 id->SetSource(source.WithLine(exported_symbol.line));
Adam Lesinski71be7052017-12-12 16:48:07 -08001356 bool result =
1357 final_table_.AddResourceMangled(res_name, ConfigDescription::DefaultConfig(),
1358 std::string(), std::move(id), context_->GetDiagnostics());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001359 if (!result) {
1360 return false;
1361 }
1362 }
1363 return true;
1364 }
1365
Adam Lesinski2427dce2017-11-30 15:10:28 -08001366 bool MergeCompiledFile(const ResourceFile& compiled_file, io::IFile* file, bool override) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001367 TRACE_CALL();
Adam Lesinski2427dce2017-11-30 15:10:28 -08001368 if (context_->IsVerbose()) {
1369 context_->GetDiagnostics()->Note(DiagMessage()
1370 << "merging '" << compiled_file.name
1371 << "' from compiled file " << compiled_file.source);
1372 }
1373
1374 if (!table_merger_->MergeFile(compiled_file, override, file)) {
1375 return false;
1376 }
1377 return MergeExportedSymbols(compiled_file.source, compiled_file.exported_symbols);
1378 }
1379
Adam Lesinski00451162017-10-03 07:44:08 -07001380 // Takes a path to load as a ZIP file and merges the files within into the master ResourceTable.
1381 // If override is true, conflicting resources are allowed to override each other, in order of last
1382 // seen.
1383 // An io::IFileCollection is created from the ZIP file and added to the set of
1384 // io::IFileCollections that are open.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001385 bool MergeArchive(const std::string& input, bool override) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001386 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001387 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001388 context_->GetDiagnostics()->Note(DiagMessage() << "merging archive " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001389 }
1390
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001391 std::string error_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001392 std::unique_ptr<io::ZipFileCollection> collection =
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001393 io::ZipFileCollection::Create(input, &error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001394 if (!collection) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001395 context_->GetDiagnostics()->Error(DiagMessage(input) << error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001396 return false;
1397 }
1398
1399 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001400 for (auto iter = collection->Iterator(); iter->HasNext();) {
1401 if (!MergeFile(iter->Next(), override)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001402 error = true;
1403 }
1404 }
1405
1406 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001407 collections_.push_back(std::move(collection));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001408 return !error;
1409 }
1410
Adam Lesinski00451162017-10-03 07:44:08 -07001411 // Takes a path to load and merge into the master ResourceTable. If override is true,
1412 // conflicting resources are allowed to override each other, in order of last seen.
1413 // If the file path ends with .flata, .jar, .jack, or .zip the file is treated
1414 // as ZIP archive and the files within are merged individually.
1415 // Otherwise the file is processed on its own.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001416 bool MergePath(const std::string& path, bool override) {
1417 if (util::EndsWith(path, ".flata") || util::EndsWith(path, ".jar") ||
1418 util::EndsWith(path, ".jack") || util::EndsWith(path, ".zip")) {
1419 return MergeArchive(path, override);
1420 } else if (util::EndsWith(path, ".apk")) {
1421 return MergeStaticLibrary(path, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001422 }
1423
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001424 io::IFile* file = file_collection_->InsertFile(path);
1425 return MergeFile(file, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001426 }
1427
Adam Lesinski00451162017-10-03 07:44:08 -07001428 // Takes an AAPT Container file (.apc/.flat) to load and merge into the master ResourceTable.
1429 // If override is true, conflicting resources are allowed to override each other, in order of last
1430 // seen.
1431 // All other file types are ignored. This is because these files could be coming from a zip,
1432 // where we could have other files like classes.dex.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001433 bool MergeFile(io::IFile* file, bool override) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001434 TRACE_CALL();
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001435 const Source& src = file->GetSource();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001436
Adam Lesinski00451162017-10-03 07:44:08 -07001437 if (util::EndsWith(src.path, ".xml") || util::EndsWith(src.path, ".png")) {
Adam Lesinski6a396c12016-10-20 14:38:23 -07001438 // Since AAPT compiles these file types and appends .flat to them, seeing
1439 // their raw extensions is a sign that they weren't compiled.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001440 const StringPiece file_type = util::EndsWith(src.path, ".xml") ? "XML" : "PNG";
1441 context_->GetDiagnostics()->Error(DiagMessage(src) << "uncompiled " << file_type
1442 << " file passed as argument. Must be "
1443 "compiled first into .flat file.");
Adam Lesinski6a396c12016-10-20 14:38:23 -07001444 return false;
Adam Lesinski00451162017-10-03 07:44:08 -07001445 } else if (!util::EndsWith(src.path, ".apc") && !util::EndsWith(src.path, ".flat")) {
1446 if (context_->IsVerbose()) {
1447 context_->GetDiagnostics()->Warn(DiagMessage(src) << "ignoring unrecognized file");
1448 return true;
1449 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001450 }
1451
Adam Lesinski00451162017-10-03 07:44:08 -07001452 std::unique_ptr<io::InputStream> input_stream = file->OpenInputStream();
1453 if (input_stream == nullptr) {
1454 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to open file");
1455 return false;
1456 }
1457
1458 if (input_stream->HadError()) {
1459 context_->GetDiagnostics()->Error(DiagMessage(src)
1460 << "failed to open file: " << input_stream->GetError());
1461 return false;
1462 }
1463
1464 ContainerReaderEntry* entry;
1465 ContainerReader reader(input_stream.get());
Mohamed Heikal10844322018-02-07 15:17:38 -05001466
1467 if (reader.HadError()) {
1468 context_->GetDiagnostics()->Error(DiagMessage(src)
1469 << "failed to read file: " << reader.GetError());
1470 return false;
1471 }
1472
Adam Lesinski00451162017-10-03 07:44:08 -07001473 while ((entry = reader.Next()) != nullptr) {
1474 if (entry->Type() == ContainerEntryType::kResTable) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001475 TRACE_NAME(std::string("Process ResTable:") + file->GetSource().path);
Adam Lesinski00451162017-10-03 07:44:08 -07001476 pb::ResourceTable pb_table;
1477 if (!entry->GetResTable(&pb_table)) {
1478 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to read resource table: "
1479 << entry->GetError());
1480 return false;
1481 }
1482
1483 ResourceTable table;
1484 std::string error;
Adam Lesinski8780eb62017-10-31 17:44:39 -07001485 if (!DeserializeTableFromPb(pb_table, nullptr /*files*/, &table, &error)) {
Adam Lesinski00451162017-10-03 07:44:08 -07001486 context_->GetDiagnostics()->Error(DiagMessage(src)
1487 << "failed to deserialize resource table: " << error);
1488 return false;
1489 }
1490
1491 if (!table_merger_->Merge(src, &table, override)) {
1492 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to merge resource table");
1493 return false;
1494 }
1495 } else if (entry->Type() == ContainerEntryType::kResFile) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001496 TRACE_NAME(std::string("Process ResFile") + file->GetSource().path);
Adam Lesinski00451162017-10-03 07:44:08 -07001497 pb::internal::CompiledFile pb_compiled_file;
1498 off64_t offset;
1499 size_t len;
1500 if (!entry->GetResFileOffsets(&pb_compiled_file, &offset, &len)) {
1501 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to get resource file: "
1502 << entry->GetError());
1503 return false;
1504 }
1505
1506 ResourceFile resource_file;
1507 std::string error;
1508 if (!DeserializeCompiledFileFromPb(pb_compiled_file, &resource_file, &error)) {
1509 context_->GetDiagnostics()->Error(DiagMessage(src)
1510 << "failed to read compiled header: " << error);
1511 return false;
1512 }
1513
1514 if (!MergeCompiledFile(resource_file, file->CreateFileSegment(offset, len), override)) {
1515 return false;
1516 }
1517 }
1518 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001519 return true;
1520 }
1521
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001522 bool CopyAssetsDirsToApk(IArchiveWriter* writer) {
1523 std::map<std::string, std::unique_ptr<io::RegularFile>> merged_assets;
1524 for (const std::string& assets_dir : options_.assets_dirs) {
1525 Maybe<std::vector<std::string>> files =
1526 file::FindFiles(assets_dir, context_->GetDiagnostics(), nullptr);
1527 if (!files) {
1528 return false;
1529 }
1530
1531 for (const std::string& file : files.value()) {
1532 std::string full_key = "assets/" + file;
1533 std::string full_path = assets_dir;
1534 file::AppendPath(&full_path, file);
1535
1536 auto iter = merged_assets.find(full_key);
1537 if (iter == merged_assets.end()) {
1538 merged_assets.emplace(std::move(full_key),
1539 util::make_unique<io::RegularFile>(Source(std::move(full_path))));
1540 } else if (context_->IsVerbose()) {
1541 context_->GetDiagnostics()->Warn(DiagMessage(iter->second->GetSource())
1542 << "asset file overrides '" << full_path << "'");
1543 }
1544 }
1545 }
1546
1547 for (auto& entry : merged_assets) {
Ryan Mitchell81dfca02019-06-07 10:20:27 -07001548 uint32_t compression_flags = GetCompressionFlags(entry.first, options_);
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) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001561 TRACE_CALL();
Ryan Mitchell479fa392019-01-02 17:15:39 -08001562 const bool keep_raw_values = (context_->GetPackageType() == PackageType::kStaticLib)
1563 || options_.keep_raw_values;
Ryan Mitchell467b6892018-11-09 15:52:07 -08001564 bool result = FlattenXml(context_, *manifest, kAndroidManifestPath, keep_raw_values,
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001565 true /*utf16*/, options_.output_format, writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001566 if (!result) {
1567 return false;
1568 }
1569
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001570 ResourceFileFlattenerOptions file_flattener_options;
1571 file_flattener_options.keep_raw_values = keep_raw_values;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001572 file_flattener_options.do_not_compress_anything = options_.do_not_compress_anything;
1573 file_flattener_options.extensions_to_not_compress = options_.extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01001574 file_flattener_options.regex_to_not_compress = options_.regex_to_not_compress;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001575 file_flattener_options.no_auto_version = options_.no_auto_version;
1576 file_flattener_options.no_version_vectors = options_.no_version_vectors;
Yuichi Araki4d35cca2017-01-18 20:42:17 +09001577 file_flattener_options.no_version_transitions = options_.no_version_transitions;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001578 file_flattener_options.no_xml_namespaces = options_.no_xml_namespaces;
1579 file_flattener_options.update_proguard_spec =
1580 static_cast<bool>(options_.generate_proguard_rules_path);
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001581 file_flattener_options.output_format = options_.output_format;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001582
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001583 ResourceFileFlattener file_flattener(file_flattener_options, context_, keep_set);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001584
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001585 if (!file_flattener.Flatten(table, writer)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001586 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking file resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001587 return false;
1588 }
1589
Adam Lesinski490595a2017-11-07 17:08:07 -08001590 // Hack to fix b/68820737.
1591 // We need to modify the ResourceTable's package name, but that should NOT affect
1592 // anything else being generated, which includes the Java classes.
1593 // If required, the package name is modifed before flattening, and then modified back
1594 // to its original name.
1595 ResourceTablePackage* package_to_rewrite = nullptr;
Todd Kennedy32512992018-04-25 16:45:59 -07001596 // Pre-O, the platform treats negative resource IDs [those with a package ID of 0x80
1597 // or higher] as invalid. In order to work around this limitation, we allow the use
1598 // of traditionally reserved resource IDs [those between 0x02 and 0x7E]. Allow the
1599 // definition of what a valid "split" package ID is to account for this.
1600 const bool isSplitPackage = (options_.allow_reserved_package_id &&
1601 context_->GetPackageId() != kAppPackageId &&
1602 context_->GetPackageId() != kFrameworkPackageId)
1603 || (!options_.allow_reserved_package_id && context_->GetPackageId() > kAppPackageId);
1604 if (isSplitPackage &&
Adam Lesinski490595a2017-11-07 17:08:07 -08001605 included_feature_base_ == make_value(context_->GetCompilationPackage())) {
1606 // The base APK is included, and this is a feature split. If the base package is
1607 // the same as this package, then we are building an old style Android Instant Apps feature
1608 // split and must apply this workaround to avoid requiring namespaces support.
1609 package_to_rewrite = table->FindPackage(context_->GetCompilationPackage());
1610 if (package_to_rewrite != nullptr) {
1611 CHECK_EQ(1u, table->packages.size()) << "can't change name of package when > 1 package";
1612
1613 std::string new_package_name =
1614 StringPrintf("%s.%s", package_to_rewrite->name.c_str(),
1615 app_info_.split_name.value_or_default("feature").c_str());
1616
1617 if (context_->IsVerbose()) {
1618 context_->GetDiagnostics()->Note(
1619 DiagMessage() << "rewriting resource package name for feature split to '"
1620 << new_package_name << "'");
1621 }
1622 package_to_rewrite->name = new_package_name;
1623 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001624 }
Adam Lesinski490595a2017-11-07 17:08:07 -08001625
1626 bool success = FlattenTable(table, options_.output_format, writer);
1627
1628 if (package_to_rewrite != nullptr) {
1629 // Change the name back.
1630 package_to_rewrite->name = context_->GetCompilationPackage();
1631 if (package_to_rewrite->id) {
1632 table->included_packages_.erase(package_to_rewrite->id.value());
1633 }
1634 }
1635
1636 if (!success) {
1637 context_->GetDiagnostics()->Error(DiagMessage() << "failed to write resource table");
1638 }
1639 return success;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001640 }
1641
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001642 int Run(const std::vector<std::string>& input_files) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001643 TRACE_CALL();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001644 // Load the AndroidManifest.xml
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001645 std::unique_ptr<xml::XmlResource> manifest_xml =
1646 LoadXml(options_.manifest_path, context_->GetDiagnostics());
1647 if (!manifest_xml) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001648 return 1;
1649 }
1650
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001651 // First extract the Package name without modifying it (via --rename-manifest-package).
1652 if (Maybe<AppInfo> maybe_app_info =
1653 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001654 const AppInfo& app_info = maybe_app_info.value();
1655 context_->SetCompilationPackage(app_info.package);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001656 }
1657
Adam Lesinskic6284372017-12-04 13:46:23 -08001658 // Now that the compilation package is set, load the dependencies. This will also extract
1659 // the Android framework's versionCode and versionName, if they exist.
1660 if (!LoadSymbolsFromIncludePaths()) {
1661 return 1;
1662 }
1663
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001664 ManifestFixer manifest_fixer(options_.manifest_fixer_options);
1665 if (!manifest_fixer.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001666 return 1;
1667 }
1668
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001669 Maybe<AppInfo> maybe_app_info =
1670 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001671 if (!maybe_app_info) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001672 return 1;
1673 }
1674
Adam Lesinski490595a2017-11-07 17:08:07 -08001675 app_info_ = maybe_app_info.value();
1676 context_->SetMinSdkVersion(app_info_.min_sdk_version.value_or_default(0));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001677
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001678 context_->SetNameManglerPolicy(NameManglerPolicy{context_->GetCompilationPackage()});
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001679
1680 // Override the package ID when it is "android".
1681 if (context_->GetCompilationPackage() == "android") {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001682 context_->SetPackageId(0x01);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001683
1684 // Verify we're building a regular app.
Adam Lesinskib522f042017-04-21 16:57:59 -07001685 if (context_->GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001686 context_->GetDiagnostics()->Error(
1687 DiagMessage() << "package 'android' can only be built as a regular app");
1688 return 1;
1689 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001690 }
1691
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001692 TableMergerOptions table_merger_options;
1693 table_merger_options.auto_add_overlay = options_.auto_add_overlay;
Izabela Orlowskad51efe82018-04-24 18:18:29 +01001694 table_merger_options.strict_visibility = options_.strict_visibility;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001695 table_merger_ = util::make_unique<TableMerger>(context_, &final_table_, table_merger_options);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001696
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001697 if (context_->IsVerbose()) {
1698 context_->GetDiagnostics()->Note(DiagMessage()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001699 << StringPrintf("linking package '%s' using package ID %02x",
1700 context_->GetCompilationPackage().data(),
1701 context_->GetPackageId()));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001702 }
1703
Adam Lesinski2427dce2017-11-30 15:10:28 -08001704 // Extract symbols from AndroidManifest.xml, since this isn't merged like the other XML files
1705 // in res/**/*.
1706 {
1707 XmlIdCollector collector;
1708 if (!collector.Consume(context_, manifest_xml.get())) {
1709 return false;
1710 }
1711
1712 if (!MergeExportedSymbols(manifest_xml->file.source, manifest_xml->file.exported_symbols)) {
1713 return false;
1714 }
1715 }
1716
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001717 for (const std::string& input : input_files) {
1718 if (!MergePath(input, false)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001719 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing input");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001720 return 1;
1721 }
1722 }
1723
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001724 for (const std::string& input : options_.overlay_files) {
1725 if (!MergePath(input, true)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001726 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing overlays");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001727 return 1;
1728 }
1729 }
1730
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001731 if (!VerifyNoExternalPackages()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001732 return 1;
1733 }
1734
Adam Lesinskib522f042017-04-21 16:57:59 -07001735 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001736 PrivateAttributeMover mover;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001737 if (!mover.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001738 context_->GetDiagnostics()->Error(DiagMessage() << "failed moving private attributes");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001739 return 1;
1740 }
1741
1742 // Assign IDs if we are building a regular app.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001743 IdAssigner id_assigner(&options_.stable_id_map);
1744 if (!id_assigner.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001745 context_->GetDiagnostics()->Error(DiagMessage() << "failed assigning IDs");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001746 return 1;
1747 }
1748
1749 // Now grab each ID and emit it as a file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001750 if (options_.resource_id_map_path) {
1751 for (auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001752 for (auto& type : package->types) {
1753 for (auto& entry : type->entries) {
1754 ResourceName name(package->name, type->type, entry->name);
1755 // The IDs are guaranteed to exist.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001756 options_.stable_id_map[std::move(name)] =
1757 ResourceId(package->id.value(), type->id.value(), entry->id.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001758 }
1759 }
1760 }
1761
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001762 if (!WriteStableIdMapToPath(context_->GetDiagnostics(), options_.stable_id_map,
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001763 options_.resource_id_map_path.value())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001764 return 1;
1765 }
1766 }
1767 } else {
1768 // Static libs are merged with other apps, and ID collisions are bad, so
1769 // verify that
1770 // no IDs have been set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001771 if (!VerifyNoIdsSet()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001772 return 1;
1773 }
1774 }
1775
1776 // Add the names to mangle based on our source merge earlier.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001777 context_->SetNameManglerPolicy(
1778 NameManglerPolicy{context_->GetCompilationPackage(), table_merger_->merged_packages()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001779
1780 // Add our table to the symbol table.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001781 context_->GetExternalSymbols()->PrependSource(
1782 util::make_unique<ResourceTableSymbolSource>(&final_table_));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001783
Adam Lesinski1e4b0e52017-04-27 15:01:10 -07001784 // Workaround for pre-O runtime that would treat negative resource IDs
1785 // (any ID with a package ID > 7f) as invalid. Intercept any ID (PPTTEEEE) with PP > 0x7f
1786 // and type == 'id', and return the ID 0x7fPPEEEE. IDs don't need to be real resources, they
1787 // are just identifiers.
1788 if (context_->GetMinSdkVersion() < SDK_O && context_->GetPackageType() == PackageType::kApp) {
1789 if (context_->IsVerbose()) {
1790 context_->GetDiagnostics()->Note(DiagMessage()
1791 << "enabling pre-O feature split ID rewriting");
1792 }
1793 context_->GetExternalSymbols()->SetDelegate(
1794 util::make_unique<FeatureSplitSymbolTableDelegate>(context_));
1795 }
1796
Adam Lesinski34a16872018-02-23 16:18:10 -08001797 // Before we process anything, remove the resources whose default values don't exist.
1798 // We want to force any references to these to fail the build.
Mårten Kongstadd8d29012018-06-11 14:13:37 +02001799 if (!options_.no_resource_removal) {
1800 if (!NoDefaultResourceRemover{}.Consume(context_, &final_table_)) {
1801 context_->GetDiagnostics()->Error(DiagMessage()
1802 << "failed removing resources with no defaults");
1803 return 1;
1804 }
Adam Lesinski34a16872018-02-23 16:18:10 -08001805 }
1806
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001807 ReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001808 if (!linker.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001809 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking references");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001810 return 1;
1811 }
1812
Adam Lesinskib522f042017-04-21 16:57:59 -07001813 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001814 if (!options_.products.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001815 context_->GetDiagnostics()->Warn(DiagMessage()
1816 << "can't select products when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001817 }
1818 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001819 ProductFilter product_filter(options_.products);
1820 if (!product_filter.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001821 context_->GetDiagnostics()->Error(DiagMessage() << "failed stripping products");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001822 return 1;
1823 }
1824 }
1825
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001826 if (!options_.no_auto_version) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001827 AutoVersioner versioner;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001828 if (!versioner.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001829 context_->GetDiagnostics()->Error(DiagMessage() << "failed versioning styles");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001830 return 1;
1831 }
1832 }
1833
Adam Lesinskib522f042017-04-21 16:57:59 -07001834 if (context_->GetPackageType() != PackageType::kStaticLib && context_->GetMinSdkVersion() > 0) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001835 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001836 context_->GetDiagnostics()->Note(DiagMessage()
1837 << "collapsing resource versions for minimum SDK "
1838 << context_->GetMinSdkVersion());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001839 }
1840
1841 VersionCollapser collapser;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001842 if (!collapser.Consume(context_, &final_table_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001843 return 1;
1844 }
1845 }
1846
Winson3c918b82019-01-25 14:25:37 -08001847 if (!options_.exclude_configs_.empty()) {
1848 std::vector<ConfigDescription> excluded_configs;
1849
1850 for (auto& config_string : options_.exclude_configs_) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08001851 TRACE_NAME("ConfigDescription::Parse");
Winson3c918b82019-01-25 14:25:37 -08001852 ConfigDescription config_description;
1853
1854 if (!ConfigDescription::Parse(config_string, &config_description)) {
1855 context_->GetDiagnostics()->Error(DiagMessage()
1856 << "failed to parse --excluded-configs "
1857 << config_string);
1858 return 1;
1859 }
1860
1861 excluded_configs.push_back(config_description);
1862 }
1863
1864 ResourceExcluder excluder(excluded_configs);
1865 if (!excluder.Consume(context_, &final_table_)) {
1866 context_->GetDiagnostics()->Error(DiagMessage() << "failed excluding configurations");
1867 return 1;
1868 }
1869 }
1870
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001871 if (!options_.no_resource_deduping) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001872 ResourceDeduper deduper;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001873 if (!deduper.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001874 context_->GetDiagnostics()->Error(DiagMessage() << "failed deduping resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001875 return 1;
1876 }
1877 }
1878
Adam Koskidc21dea2017-07-21 10:55:27 -07001879 proguard::KeepSet proguard_keep_set =
1880 proguard::KeepSet(options_.generate_conditional_proguard_rules);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001881 proguard::KeepSet proguard_main_dex_keep_set;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001882
Adam Lesinskib522f042017-04-21 16:57:59 -07001883 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001884 if (options_.table_splitter_options.config_filter != nullptr ||
Pierre Lecesne672384b2017-02-06 10:29:02 +00001885 !options_.table_splitter_options.preferred_densities.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001886 context_->GetDiagnostics()->Warn(DiagMessage()
1887 << "can't strip resources when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001888 }
1889 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001890 // Adjust the SplitConstraints so that their SDK version is stripped if it is less than or
1891 // equal to the minSdk.
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001892 const size_t origConstraintSize = options_.split_constraints.size();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001893 options_.split_constraints =
1894 AdjustSplitConstraintsForMinSdk(context_->GetMinSdkVersion(), options_.split_constraints);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001895
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001896 if (origConstraintSize != options_.split_constraints.size()) {
1897 context_->GetDiagnostics()->Warn(DiagMessage()
1898 << "requested to split resources prior to min sdk of "
1899 << context_->GetMinSdkVersion());
1900 }
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001901 TableSplitter table_splitter(options_.split_constraints, options_.table_splitter_options);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001902 if (!table_splitter.VerifySplitConstraints(context_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001903 return 1;
1904 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001905 table_splitter.SplitTable(&final_table_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001906
1907 // Now we need to write out the Split APKs.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001908 auto path_iter = options_.split_paths.begin();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001909 auto split_constraints_iter = options_.split_constraints.begin();
1910 for (std::unique_ptr<ResourceTable>& split_table : table_splitter.splits()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001911 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001912 context_->GetDiagnostics()->Note(DiagMessage(*path_iter)
1913 << "generating split with configurations '"
1914 << util::Joiner(split_constraints_iter->configs, ", ")
1915 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001916 }
1917
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001918 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(*path_iter);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001919 if (!archive_writer) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001920 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001921 return 1;
1922 }
1923
1924 // Generate an AndroidManifest.xml for each split.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001925 std::unique_ptr<xml::XmlResource> split_manifest =
Adam Lesinski490595a2017-11-07 17:08:07 -08001926 GenerateSplitManifest(app_info_, *split_constraints_iter);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001927
1928 XmlReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001929 if (!linker.Consume(context_, split_manifest.get())) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001930 context_->GetDiagnostics()->Error(DiagMessage()
1931 << "failed to create Split AndroidManifest.xml");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001932 return 1;
1933 }
1934
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001935 if (!WriteApk(archive_writer.get(), &proguard_keep_set, split_manifest.get(),
1936 split_table.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001937 return 1;
1938 }
1939
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001940 ++path_iter;
1941 ++split_constraints_iter;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001942 }
1943 }
1944
1945 // Start writing the base APK.
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001946 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(options_.output_path);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001947 if (!archive_writer) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001948 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001949 return 1;
1950 }
1951
1952 bool error = false;
1953 {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001954 // AndroidManifest.xml has no resource name, but the CallSite is built from the name
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001955 // (aka, which package the AndroidManifest.xml is coming from).
1956 // So we give it a package name so it can see local resources.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001957 manifest_xml->file.name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001958
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001959 XmlReferenceLinker manifest_linker;
1960 if (manifest_linker.Consume(context_, manifest_xml.get())) {
1961 if (options_.generate_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001962 !proguard::CollectProguardRulesForManifest(manifest_xml.get(), &proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001963 error = true;
1964 }
1965
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001966 if (options_.generate_main_dex_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001967 !proguard::CollectProguardRulesForManifest(manifest_xml.get(),
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001968 &proguard_main_dex_keep_set, true)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001969 error = true;
Alexandria Cornwall637b4822016-08-11 09:53:16 -07001970 }
1971
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001972 if (options_.generate_java_class_path) {
1973 if (!WriteManifestJavaFile(manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001974 error = true;
1975 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001976 }
1977
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001978 if (options_.no_xml_namespaces) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001979 // PackageParser will fail if URIs are removed from
1980 // AndroidManifest.xml.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001981 XmlNamespaceRemover namespace_remover(true /* keepUris */);
1982 if (!namespace_remover.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001983 error = true;
1984 }
Rohit Agrawale49bb302016-04-22 12:27:55 -07001985 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001986 } else {
1987 error = true;
1988 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001989 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001990
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001991 if (error) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001992 context_->GetDiagnostics()->Error(DiagMessage() << "failed processing manifest");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001993 return 1;
1994 }
Adam Lesinskia6fe3452015-12-09 15:20:52 -08001995
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001996 if (!WriteApk(archive_writer.get(), &proguard_keep_set, manifest_xml.get(), &final_table_)) {
1997 return 1;
1998 }
1999
2000 if (!CopyAssetsDirsToApk(archive_writer.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002001 return 1;
2002 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08002003
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00002004 if (options_.generate_java_class_path || options_.generate_text_symbols_path) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07002005 if (!GenerateJavaClasses()) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08002006 return 1;
2007 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002008 }
2009
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08002010 if (!WriteProguardFile(options_.generate_proguard_rules_path, proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002011 return 1;
2012 }
2013
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002014 if (!WriteProguardFile(options_.generate_main_dex_proguard_rules_path,
2015 proguard_main_dex_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002016 return 1;
2017 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002018 return 0;
2019 }
2020
2021 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002022 LinkOptions options_;
2023 LinkContext* context_;
2024 ResourceTable final_table_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002025
Adam Lesinski490595a2017-11-07 17:08:07 -08002026 AppInfo app_info_;
2027
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002028 std::unique_ptr<TableMerger> table_merger_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002029
2030 // A pointer to the FileCollection representing the filesystem (not archives).
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002031 std::unique_ptr<io::FileCollection> file_collection_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002032
Adam Lesinski8780eb62017-10-31 17:44:39 -07002033 // A vector of IFileCollections. This is mainly here to retain ownership of the
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002034 // collections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002035 std::vector<std::unique_ptr<io::IFileCollection>> collections_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002036
Adam Lesinski8780eb62017-10-31 17:44:39 -07002037 // The set of merged APKs. This is mainly here to retain ownership of the APKs.
2038 std::vector<std::unique_ptr<LoadedApk>> merged_apks_;
2039
2040 // The set of included APKs (not merged). This is mainly here to retain ownership of the APKs.
2041 std::vector<std::unique_ptr<LoadedApk>> static_library_includes_;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08002042
2043 // The set of shared libraries being used, mapping their assigned package ID to package name.
2044 std::map<size_t, std::string> shared_libs_;
Adam Lesinski490595a2017-11-07 17:08:07 -08002045
2046 // The package name of the base application, if it is included.
2047 Maybe<std::string> included_feature_base_;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002048};
2049
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002050int LinkCommand::Action(const std::vector<std::string>& args) {
Fabien Sanglard2d34e762019-02-21 15:13:29 -08002051 TRACE_FLUSH(trace_folder_ ? trace_folder_.value() : "", "LinkCommand::Action");
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002052 LinkContext context(diag_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002053
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002054 // Expand all argument-files passed into the command line. These start with '@'.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002055 std::vector<std::string> arg_list;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002056 for (const std::string& arg : args) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002057 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002058 const std::string path = arg.substr(1, arg.size() - 1);
2059 std::string error;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002060 if (!file::AppendArgsFromFile(path, &arg_list, &error)) {
2061 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002062 return 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002063 }
2064 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002065 arg_list.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002066 }
2067 }
2068
2069 // Expand all argument-files passed to -R.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002070 for (const std::string& arg : overlay_arg_list_) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002071 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002072 const std::string path = arg.substr(1, arg.size() - 1);
2073 std::string error;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002074 if (!file::AppendArgsFromFile(path, &options_.overlay_files, &error)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002075 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002076 return 1;
2077 }
2078 } else {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002079 options_.overlay_files.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002080 }
2081 }
2082
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002083 if (verbose_) {
2084 context.SetVerbose(verbose_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002085 }
2086
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002087 if (int{shared_lib_} + int{static_lib_} + int{proto_format_} > 1) {
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002088 context.GetDiagnostics()->Error(
2089 DiagMessage()
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002090 << "only one of --shared-lib, --static-lib, or --proto_format can be defined");
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002091 return 1;
2092 }
2093
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002094 // The default build type.
2095 context.SetPackageType(PackageType::kApp);
2096 context.SetPackageId(kAppPackageId);
2097
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002098 if (shared_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002099 context.SetPackageType(PackageType::kSharedLib);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002100 context.SetPackageId(0x00);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002101 } else if (static_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002102 context.SetPackageType(PackageType::kStaticLib);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002103 options_.output_format = OutputFormat::kProto;
2104 } else if (proto_format_) {
2105 options_.output_format = OutputFormat::kProto;
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002106 }
2107
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002108 if (package_id_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002109 if (context.GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002110 context.GetDiagnostics()->Error(
2111 DiagMessage() << "can't specify --package-id when not building a regular app");
2112 return 1;
2113 }
2114
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002115 const Maybe<uint32_t> maybe_package_id_int = ResourceUtils::ParseInt(package_id_.value());
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002116 if (!maybe_package_id_int) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002117 context.GetDiagnostics()->Error(DiagMessage() << "package ID '" << package_id_.value()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002118 << "' is not a valid integer");
2119 return 1;
2120 }
2121
2122 const uint32_t package_id_int = maybe_package_id_int.value();
Todd Kennedy32512992018-04-25 16:45:59 -07002123 if (package_id_int > std::numeric_limits<uint8_t>::max()
2124 || package_id_int == kFrameworkPackageId
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002125 || (!options_.allow_reserved_package_id && package_id_int < kAppPackageId)) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002126 context.GetDiagnostics()->Error(
2127 DiagMessage() << StringPrintf(
2128 "invalid package ID 0x%02x. Must be in the range 0x7f-0xff.", package_id_int));
2129 return 1;
2130 }
2131 context.SetPackageId(static_cast<uint8_t>(package_id_int));
2132 }
2133
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002134 // Populate the set of extra packages for which to generate R.java.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002135 for (std::string& extra_package : extra_java_packages_) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002136 // A given package can actually be a colon separated list of packages.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002137 for (StringPiece package : util::Split(extra_package, ':')) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002138 options_.extra_java_packages.insert(package.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002139 }
2140 }
2141
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002142 if (product_list_) {
2143 for (StringPiece product : util::Tokenize(product_list_.value(), ',')) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002144 if (product != "" && product != "default") {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002145 options_.products.insert(product.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002146 }
2147 }
2148 }
2149
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002150 std::unique_ptr<IConfigFilter> filter;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002151 if (!configs_.empty()) {
2152 filter = ParseConfigFilterParameters(configs_, context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002153 if (filter == nullptr) {
2154 return 1;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002155 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002156 options_.table_splitter_options.config_filter = filter.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002157 }
2158
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002159 if (preferred_density_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002160 Maybe<uint16_t> density =
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002161 ParseTargetDensityParameter(preferred_density_.value(), context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002162 if (!density) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002163 return 1;
Adam Lesinskic51562c2016-04-28 11:12:38 -07002164 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002165 options_.table_splitter_options.preferred_densities.push_back(density.value());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002166 }
Adam Lesinskic51562c2016-04-28 11:12:38 -07002167
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002168 // Parse the split parameters.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002169 for (const std::string& split_arg : split_args_) {
2170 options_.split_paths.push_back({});
2171 options_.split_constraints.push_back({});
2172 if (!ParseSplitParameter(split_arg, context.GetDiagnostics(), &options_.split_paths.back(),
2173 &options_.split_constraints.back())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002174 return 1;
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002175 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002176 }
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002177
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002178 if (context.GetPackageType() != PackageType::kStaticLib && stable_id_file_path_) {
2179 if (!LoadStableIdMap(context.GetDiagnostics(), stable_id_file_path_.value(),
2180 &options_.stable_id_map)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002181 return 1;
Adam Lesinski64587af2016-02-18 18:33:06 -08002182 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002183 }
Adam Lesinski64587af2016-02-18 18:33:06 -08002184
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01002185 if (no_compress_regex) {
2186 std::string regex = no_compress_regex.value();
2187 if (util::StartsWith(regex, "@")) {
2188 const std::string path = regex.substr(1, regex.size() -1);
2189 std::string error;
2190 if (!file::AppendSetArgsFromFile(path, &options_.extensions_to_not_compress, &error)) {
2191 context.GetDiagnostics()->Error(DiagMessage(path) << error);
2192 return 1;
2193 }
2194 } else {
2195 options_.regex_to_not_compress = GetRegularExpression(no_compress_regex.value());
2196 }
2197 }
2198
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002199 // Populate some default no-compress extensions that are already compressed.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002200 options_.extensions_to_not_compress.insert(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002201 {".jpg", ".jpeg", ".png", ".gif", ".wav", ".mp2", ".mp3", ".ogg",
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002202 ".aac", ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet", ".rtttl",
2203 ".imy", ".xmf", ".mp4", ".m4a", ".m4v", ".3gp", ".3gpp", ".3g2",
2204 ".3gpp2", ".amr", ".awb", ".wma", ".wmv", ".webm", ".mkv"});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002205
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002206 // Turn off auto versioning for static-libs.
Adam Lesinskib522f042017-04-21 16:57:59 -07002207 if (context.GetPackageType() == PackageType::kStaticLib) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002208 options_.no_auto_version = true;
2209 options_.no_version_vectors = true;
2210 options_.no_version_transitions = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002211 }
Adam Lesinskie4bb9eb2016-02-12 22:18:51 -08002212
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002213 Linker cmd(&context, options_);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002214 return cmd.Run(arg_list);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002215}
2216
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002217} // namespace aapt