blob: a7b8d2535e790fd2fdb19c13126002cd3bda66ef [file] [log] [blame]
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Ryan Mitchell833a1a62018-07-10 13:51:36 -070017#include "Link.h"
18
Adam Lesinskice5e56e2016-10-21 17:56:45 -070019#include <sys/stat.h>
Adam Lesinskic6284372017-12-04 13:46:23 -080020#include <cinttypes>
Adam Lesinskice5e56e2016-10-21 17:56:45 -070021
Mohamed Heikald3c5fb62018-01-12 11:37:26 -050022#include <algorithm>
Adam Lesinskice5e56e2016-10-21 17:56:45 -070023#include <queue>
24#include <unordered_map>
25#include <vector>
26
27#include "android-base/errors.h"
28#include "android-base/file.h"
Adam Lesinskif34b6f42017-03-03 16:33:26 -080029#include "android-base/stringprintf.h"
Mårten Kongstad24c9aa62018-06-20 08:46:41 +020030#include "androidfw/Locale.h"
Adam Lesinskid5083f62017-01-16 15:07:21 -080031#include "androidfw/StringPiece.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070032
Adam Lesinski1ab598f2015-08-14 14:26:04 -070033#include "AppInfo.h"
34#include "Debug.h"
Adam Lesinski8780eb62017-10-31 17:44:39 -070035#include "LoadedApk.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070036#include "NameMangler.h"
Adam Lesinski59e04c62016-02-04 15:59:23 -080037#include "ResourceUtils.h"
Adam Lesinskid3ffa8442017-09-28 13:34:35 -070038#include "ResourceValues.h"
39#include "ValueVisitor.h"
Adam Lesinskid0f492d2017-04-03 18:12:45 -070040#include "cmd/Util.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070041#include "compile/IdAssigner.h"
Adam Lesinski2427dce2017-11-30 15:10:28 -080042#include "compile/XmlIdCollector.h"
Adam Lesinski6a008172016-02-02 17:02:58 -080043#include "filter/ConfigFilter.h"
Adam Lesinski46708052017-09-29 14:49:15 -070044#include "format/Archive.h"
Adam Lesinski00451162017-10-03 07:44:08 -070045#include "format/Container.h"
Adam Lesinski46708052017-09-29 14:49:15 -070046#include "format/binary/TableFlattener.h"
47#include "format/binary/XmlFlattener.h"
48#include "format/proto/ProtoDeserialize.h"
49#include "format/proto/ProtoSerialize.h"
Adam Lesinski00451162017-10-03 07:44:08 -070050#include "io/BigBufferStream.h"
51#include "io/FileStream.h"
Adam Lesinskia40e9722015-11-24 19:11:46 -080052#include "io/FileSystem.h"
Adam Lesinskid0f492d2017-04-03 18:12:45 -070053#include "io/Util.h"
Adam Lesinskia40e9722015-11-24 19:11:46 -080054#include "io/ZipArchive.h"
Adam Lesinskica5638f2015-10-21 14:42:43 -070055#include "java/JavaClassGenerator.h"
56#include "java/ManifestClassGenerator.h"
57#include "java/ProguardRules.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070058#include "link/Linkers.h"
Adam Lesinskicacb28f2016-10-19 12:18:14 -070059#include "link/ManifestFixer.h"
Adam Lesinski34a16872018-02-23 16:18:10 -080060#include "link/NoDefaultResourceRemover.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080061#include "link/ReferenceLinker.h"
Winson3c918b82019-01-25 14:25:37 -080062#include "link/ResourceExcluder.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070063#include "link/TableMerger.h"
Adam Lesinskic744ae82017-05-17 19:28:38 -070064#include "link/XmlCompatVersioner.h"
Adam Lesinskid48944a2017-02-21 14:22:30 -080065#include "optimize/ResourceDeduper.h"
66#include "optimize/VersionCollapser.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070067#include "process/IResourceTableConsumer.h"
68#include "process/SymbolTable.h"
Adam Lesinski355f2852016-02-13 20:26:45 -080069#include "split/TableSplitter.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070070#include "util/Files.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080071#include "xml/XmlDom.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070072
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070073using ::aapt::io::FileInputStream;
Mårten Kongstad24c9aa62018-06-20 08:46:41 +020074using ::android::ConfigDescription;
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070075using ::android::StringPiece;
76using ::android::base::StringPrintf;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070077
Adam Lesinski1ab598f2015-08-14 14:26:04 -070078namespace aapt {
79
Adam Lesinski64587af2016-02-18 18:33:06 -080080class LinkContext : public IAaptContext {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070081 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -080082 explicit LinkContext(IDiagnostics* diagnostics)
Chris Warrington820d72a2017-04-27 15:27:01 +010083 : diagnostics_(diagnostics), name_mangler_({}), symbols_(&name_mangler_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -070084 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070085
Adam Lesinskib522f042017-04-21 16:57:59 -070086 PackageType GetPackageType() override {
87 return package_type_;
88 }
89
90 void SetPackageType(PackageType type) {
91 package_type_ = type;
92 }
93
Adam Lesinskid0f492d2017-04-03 18:12:45 -070094 IDiagnostics* GetDiagnostics() override {
Chris Warrington820d72a2017-04-27 15:27:01 +010095 return diagnostics_;
Adam Lesinskid0f492d2017-04-03 18:12:45 -070096 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070097
Adam Lesinskid0f492d2017-04-03 18:12:45 -070098 NameMangler* GetNameMangler() override {
99 return &name_mangler_;
100 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700101
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700102 void SetNameManglerPolicy(const NameManglerPolicy& policy) {
103 name_mangler_ = NameMangler(policy);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700104 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800105
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700106 const std::string& GetCompilationPackage() override {
107 return compilation_package_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700108 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700109
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700110 void SetCompilationPackage(const StringPiece& package_name) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800111 compilation_package_ = package_name.to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700112 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800113
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700114 uint8_t GetPackageId() override {
115 return package_id_;
116 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700117
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700118 void SetPackageId(uint8_t id) {
119 package_id_ = id;
120 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800121
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700122 SymbolTable* GetExternalSymbols() override {
123 return &symbols_;
124 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800125
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700126 bool IsVerbose() override {
127 return verbose_;
128 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800129
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700130 void SetVerbose(bool val) {
131 verbose_ = val;
132 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800133
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700134 int GetMinSdkVersion() override {
135 return min_sdk_version_;
136 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700137
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700138 void SetMinSdkVersion(int minSdk) {
139 min_sdk_version_ = minSdk;
140 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700141
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700142 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700143 DISALLOW_COPY_AND_ASSIGN(LinkContext);
144
Adam Lesinskib522f042017-04-21 16:57:59 -0700145 PackageType package_type_ = PackageType::kApp;
Chris Warrington820d72a2017-04-27 15:27:01 +0100146 IDiagnostics* diagnostics_;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700147 NameMangler name_mangler_;
148 std::string compilation_package_;
149 uint8_t package_id_ = 0x0;
150 SymbolTable symbols_;
151 bool verbose_ = false;
152 int min_sdk_version_ = 0;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700153};
154
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700155// A custom delegate that generates compatible pre-O IDs for use with feature splits.
156// Feature splits use package IDs > 7f, which in Java (since Java doesn't have unsigned ints)
157// is interpreted as a negative number. Some verification was wrongly assuming negative values
158// were invalid.
159//
160// This delegate will attempt to masquerade any '@id/' references with ID 0xPPTTEEEE,
161// where PP > 7f, as 0x7fPPEEEE. Any potential overlapping is verified and an error occurs if such
162// an overlap exists.
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800163//
164// See b/37498913.
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700165class FeatureSplitSymbolTableDelegate : public DefaultSymbolTableDelegate {
166 public:
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -0800167 explicit FeatureSplitSymbolTableDelegate(IAaptContext* context) : context_(context) {
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700168 }
169
170 virtual ~FeatureSplitSymbolTableDelegate() = default;
171
172 virtual std::unique_ptr<SymbolTable::Symbol> FindByName(
173 const ResourceName& name,
174 const std::vector<std::unique_ptr<ISymbolSource>>& sources) override {
175 std::unique_ptr<SymbolTable::Symbol> symbol =
176 DefaultSymbolTableDelegate::FindByName(name, sources);
177 if (symbol == nullptr) {
178 return {};
179 }
180
181 // Check to see if this is an 'id' with the target package.
182 if (name.type == ResourceType::kId && symbol->id) {
183 ResourceId* id = &symbol->id.value();
184 if (id->package_id() > kAppPackageId) {
185 // Rewrite the resource ID to be compatible pre-O.
186 ResourceId rewritten_id(kAppPackageId, id->package_id(), id->entry_id());
187
188 // Check that this doesn't overlap another resource.
189 if (DefaultSymbolTableDelegate::FindById(rewritten_id, sources) != nullptr) {
190 // The ID overlaps, so log a message (since this is a weird failure) and fail.
191 context_->GetDiagnostics()->Error(DiagMessage() << "Failed to rewrite " << name
192 << " for pre-O feature split support");
193 return {};
194 }
195
196 if (context_->IsVerbose()) {
197 context_->GetDiagnostics()->Note(DiagMessage() << "rewriting " << name << " (" << *id
198 << ") -> (" << rewritten_id << ")");
199 }
200
201 *id = rewritten_id;
202 }
203 }
204 return symbol;
205 }
206
207 private:
208 DISALLOW_COPY_AND_ASSIGN(FeatureSplitSymbolTableDelegate);
209
210 IAaptContext* context_;
211};
212
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700213static bool FlattenXml(IAaptContext* context, const xml::XmlResource& xml_res,
214 const StringPiece& path, bool keep_raw_values, bool utf16,
215 OutputFormat format, IArchiveWriter* writer) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700216 if (context->IsVerbose()) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700217 context->GetDiagnostics()->Note(DiagMessage(path) << "writing to archive (keep_raw_values="
218 << (keep_raw_values ? "true" : "false")
219 << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700220 }
221
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700222 switch (format) {
223 case OutputFormat::kApk: {
224 BigBuffer buffer(1024);
225 XmlFlattenerOptions options = {};
226 options.keep_raw_values = keep_raw_values;
227 options.use_utf16 = utf16;
228 XmlFlattener flattener(&buffer, options);
229 if (!flattener.Consume(context, &xml_res)) {
230 return false;
231 }
232
233 io::BigBufferInputStream input_stream(&buffer);
234 return io::CopyInputStreamToArchive(context, &input_stream, path.to_string(),
235 ArchiveEntry::kCompress, writer);
236 } break;
237
238 case OutputFormat::kProto: {
239 pb::XmlNode pb_node;
Ryan Mitchell467b6892018-11-09 15:52:07 -0800240 // Strip whitespace text nodes from tha AndroidManifest.xml
241 SerializeXmlOptions options;
242 options.remove_empty_text_nodes = (path == kAndroidManifestPath);
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700243 SerializeXmlResourceToPb(xml_res, &pb_node);
244 return io::CopyProtoToArchive(context, &pb_node, path.to_string(), ArchiveEntry::kCompress,
245 writer);
246 } break;
247 }
248 return false;
Adam Lesinski355f2852016-02-13 20:26:45 -0800249}
250
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700251// Inflates an XML file from the source path.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700252static std::unique_ptr<xml::XmlResource> LoadXml(const std::string& path, IDiagnostics* diag) {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700253 FileInputStream fin(path);
254 if (fin.HadError()) {
255 diag->Error(DiagMessage(path) << "failed to load XML file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700256 return {};
257 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700258 return xml::Inflate(&fin, diag, Source(path));
Adam Lesinski355f2852016-02-13 20:26:45 -0800259}
260
Adam Lesinski355f2852016-02-13 20:26:45 -0800261struct ResourceFileFlattenerOptions {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700262 bool no_auto_version = false;
263 bool no_version_vectors = false;
Yuichi Araki4d35cca2017-01-18 20:42:17 +0900264 bool no_version_transitions = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700265 bool no_xml_namespaces = false;
266 bool keep_raw_values = false;
267 bool do_not_compress_anything = false;
268 bool update_proguard_spec = false;
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700269 OutputFormat output_format = OutputFormat::kApk;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700270 std::unordered_set<std::string> extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100271 Maybe<std::regex> regex_to_not_compress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800272};
273
Adam Lesinskic744ae82017-05-17 19:28:38 -0700274// A sampling of public framework resource IDs.
275struct R {
276 struct attr {
277 enum : uint32_t {
278 paddingLeft = 0x010100d6u,
279 paddingRight = 0x010100d8u,
280 paddingHorizontal = 0x0101053du,
281
282 paddingTop = 0x010100d7u,
283 paddingBottom = 0x010100d9u,
284 paddingVertical = 0x0101053eu,
285
286 layout_marginLeft = 0x010100f7u,
287 layout_marginRight = 0x010100f9u,
288 layout_marginHorizontal = 0x0101053bu,
289
290 layout_marginTop = 0x010100f8u,
291 layout_marginBottom = 0x010100fau,
292 layout_marginVertical = 0x0101053cu,
293 };
294 };
295};
296
Adam Lesinski355f2852016-02-13 20:26:45 -0800297class ResourceFileFlattener {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700298 public:
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700299 ResourceFileFlattener(const ResourceFileFlattenerOptions& options, IAaptContext* context,
Adam Lesinskic744ae82017-05-17 19:28:38 -0700300 proguard::KeepSet* keep_set);
Adam Lesinski355f2852016-02-13 20:26:45 -0800301
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700302 bool Flatten(ResourceTable* table, IArchiveWriter* archive_writer);
Adam Lesinski355f2852016-02-13 20:26:45 -0800303
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700304 private:
305 struct FileOperation {
306 ConfigDescription config;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700307
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700308 // The entry this file came from.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700309 ResourceEntry* entry;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700310
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700311 // The file to copy as-is.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700312 io::IFile* file_to_copy;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700313
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700314 // The XML to process and flatten.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700315 std::unique_ptr<xml::XmlResource> xml_to_flatten;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700316
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700317 // The destination to write this file to.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700318 std::string dst_path;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700319 };
Adam Lesinski355f2852016-02-13 20:26:45 -0800320
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700321 uint32_t GetCompressionFlags(const StringPiece& str);
Adam Lesinski355f2852016-02-13 20:26:45 -0800322
Adam Lesinskic744ae82017-05-17 19:28:38 -0700323 std::vector<std::unique_ptr<xml::XmlResource>> LinkAndVersionXmlFile(ResourceTable* table,
324 FileOperation* file_op);
Adam Lesinski355f2852016-02-13 20:26:45 -0800325
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700326 ResourceFileFlattenerOptions options_;
327 IAaptContext* context_;
328 proguard::KeepSet* keep_set_;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700329 XmlCompatVersioner::Rules rules_;
Adam Lesinski355f2852016-02-13 20:26:45 -0800330};
331
Adam Lesinskic744ae82017-05-17 19:28:38 -0700332ResourceFileFlattener::ResourceFileFlattener(const ResourceFileFlattenerOptions& options,
333 IAaptContext* context, proguard::KeepSet* keep_set)
334 : options_(options), context_(context), keep_set_(keep_set) {
335 SymbolTable* symm = context_->GetExternalSymbols();
336
337 // Build up the rules for degrading newer attributes to older ones.
338 // NOTE(adamlesinski): These rules are hardcoded right now, but they should be
339 // generated from the attribute definitions themselves (b/62028956).
340 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingHorizontal)) {
341 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800342 {"paddingLeft", R::attr::paddingLeft, Attribute(android::ResTable_map::TYPE_DIMENSION)},
343 {"paddingRight", R::attr::paddingRight, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700344 };
345 rules_[R::attr::paddingHorizontal] =
346 util::make_unique<DegradeToManyRule>(std::move(replacements));
347 }
348
349 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingVertical)) {
350 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800351 {"paddingTop", R::attr::paddingTop, Attribute(android::ResTable_map::TYPE_DIMENSION)},
352 {"paddingBottom", R::attr::paddingBottom, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700353 };
354 rules_[R::attr::paddingVertical] =
355 util::make_unique<DegradeToManyRule>(std::move(replacements));
356 }
357
358 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginHorizontal)) {
359 std::vector<ReplacementAttr> replacements{
360 {"layout_marginLeft", R::attr::layout_marginLeft,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800361 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700362 {"layout_marginRight", R::attr::layout_marginRight,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800363 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700364 };
365 rules_[R::attr::layout_marginHorizontal] =
366 util::make_unique<DegradeToManyRule>(std::move(replacements));
367 }
368
369 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginVertical)) {
370 std::vector<ReplacementAttr> replacements{
371 {"layout_marginTop", R::attr::layout_marginTop,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800372 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700373 {"layout_marginBottom", R::attr::layout_marginBottom,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800374 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700375 };
376 rules_[R::attr::layout_marginVertical] =
377 util::make_unique<DegradeToManyRule>(std::move(replacements));
378 }
379}
380
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100381// TODO(rtmitchell): turn this function into a variable that points to a method that retrieves the
382// compression flag
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700383uint32_t ResourceFileFlattener::GetCompressionFlags(const StringPiece& str) {
384 if (options_.do_not_compress_anything) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700385 return 0;
386 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800387
Izabela Orlowska0faba5f2018-06-01 12:06:31 +0100388 if (options_.regex_to_not_compress
389 && std::regex_search(str.to_string(), options_.regex_to_not_compress.value())) {
390 return 0;
391 }
392
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700393 for (const std::string& extension : options_.extensions_to_not_compress) {
394 if (util::EndsWith(str, extension)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700395 return 0;
Adam Lesinski355f2852016-02-13 20:26:45 -0800396 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700397 }
398 return ArchiveEntry::kCompress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800399}
400
Adam Lesinskibb94f322017-07-12 07:41:55 -0700401static bool IsTransitionElement(const std::string& name) {
402 return name == "fade" || name == "changeBounds" || name == "slide" || name == "explode" ||
403 name == "changeImageTransform" || name == "changeTransform" ||
404 name == "changeClipBounds" || name == "autoTransition" || name == "recolor" ||
405 name == "changeScroll" || name == "transitionSet" || name == "transition" ||
406 name == "transitionManager";
407}
408
409static bool IsVectorElement(const std::string& name) {
410 return name == "vector" || name == "animated-vector" || name == "pathInterpolator" ||
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) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700424 xml::XmlResource* doc = file_op->xml_to_flatten.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700425 const Source& src = doc->file.source;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700426
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700427 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700428 context_->GetDiagnostics()->Note(DiagMessage()
429 << "linking " << src.path << " (" << doc->file.name << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700430 }
431
Adam Lesinski00451162017-10-03 07:44:08 -0700432 // First, strip out any tools namespace attributes. AAPT stripped them out early, which means
433 // that existing projects have out-of-date references which pass compilation.
434 xml::StripAndroidStudioAttributes(doc->root.get());
435
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700436 XmlReferenceLinker xml_linker;
437 if (!xml_linker.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700438 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700439 }
440
Ryan Mitchell9a2f6e62018-05-23 14:23:18 -0700441 if (options_.update_proguard_spec && !proguard::CollectProguardRules(context_, doc, keep_set_)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700442 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700443 }
444
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700445 if (options_.no_xml_namespaces) {
446 XmlNamespaceRemover namespace_remover;
447 if (!namespace_remover.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700448 return {};
Adam Lesinski355f2852016-02-13 20:26:45 -0800449 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700450 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800451
Adam Lesinskibb94f322017-07-12 07:41:55 -0700452 if (options_.no_auto_version) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700453 return make_singleton_vec(std::move(file_op->xml_to_flatten));
454 }
Alexandria Cornwalla7cc3f12016-08-16 13:33:32 -0700455
Adam Lesinskibb94f322017-07-12 07:41:55 -0700456 if (options_.no_version_vectors || options_.no_version_transitions) {
457 // Skip this if it is a vector or animated-vector.
Adam Lesinski6b372992017-08-09 10:54:23 -0700458 xml::Element* el = doc->root.get();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700459 if (el && el->namespace_uri.empty()) {
460 if ((options_.no_version_vectors && IsVectorElement(el->name)) ||
461 (options_.no_version_transitions && IsTransitionElement(el->name))) {
462 return make_singleton_vec(std::move(file_op->xml_to_flatten));
463 }
464 }
465 }
466
Adam Lesinskic744ae82017-05-17 19:28:38 -0700467 const ConfigDescription& config = file_op->config;
468 ResourceEntry* entry = file_op->entry;
469
470 XmlCompatVersioner xml_compat_versioner(&rules_);
471 const util::Range<ApiVersion> api_range{config.sdkVersion,
472 FindNextApiVersionForConfig(entry, config)};
473 return xml_compat_versioner.Process(context_, doc, api_range);
Adam Lesinski355f2852016-02-13 20:26:45 -0800474}
475
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800476ResourceFile::Type XmlFileTypeForOutputFormat(OutputFormat format) {
477 switch (format) {
478 case OutputFormat::kApk:
479 return ResourceFile::Type::kBinaryXml;
480 case OutputFormat::kProto:
481 return ResourceFile::Type::kProtoXml;
482 }
483 LOG_ALWAYS_FATAL("unreachable");
484 return ResourceFile::Type::kUnknown;
485}
486
Ryan Mitchell70f79722018-08-13 07:37:24 -0700487static auto kDrawableVersions = std::map<std::string, ApiVersion>{
488 { "adaptive-icon" , SDK_O },
489};
490
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700491bool ResourceFileFlattener::Flatten(ResourceTable* table, IArchiveWriter* archive_writer) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700492 bool error = false;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700493 std::map<std::pair<ConfigDescription, StringPiece>, FileOperation> config_sorted_files;
Adam Lesinski355f2852016-02-13 20:26:45 -0800494
Adam Koskidc21dea2017-07-21 10:55:27 -0700495 proguard::CollectResourceReferences(context_, table, keep_set_);
496
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700497 for (auto& pkg : table->packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700498 CHECK(!pkg->name.empty()) << "Packages must have names when being linked";
499
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700500 for (auto& type : pkg->types) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700501 // Sort by config and name, so that we get better locality in the zip file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700502 config_sorted_files.clear();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700503 std::queue<FileOperation> file_operations;
Adam Lesinski355f2852016-02-13 20:26:45 -0800504
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700505 // Populate the queue with all files in the ResourceTable.
506 for (auto& entry : type->entries) {
Adam Lesinskibb94f322017-07-12 07:41:55 -0700507 for (auto& config_value : entry->values) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700508 // WARNING! Do not insert or remove any resources while executing in this scope. It will
509 // corrupt the iteration order.
510
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700511 FileReference* file_ref = ValueCast<FileReference>(config_value->value.get());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700512 if (!file_ref) {
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700513 continue;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700514 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700515
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700516 io::IFile* file = file_ref->file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700517 if (!file) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700518 context_->GetDiagnostics()->Error(DiagMessage(file_ref->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700519 << "file not found");
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700520 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700521 }
522
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700523 FileOperation file_op;
524 file_op.entry = entry.get();
525 file_op.dst_path = *file_ref->path;
526 file_op.config = config_value->config;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700527 file_op.file_to_copy = file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700528
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700529 if (type->type != ResourceType::kRaw &&
Adam Lesinski00451162017-10-03 07:44:08 -0700530 (file_ref->type == ResourceFile::Type::kBinaryXml ||
531 file_ref->type == ResourceFile::Type::kProtoXml)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700532 std::unique_ptr<io::IData> data = file->OpenAsData();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700533 if (!data) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700534 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700535 << "failed to open file");
536 return false;
537 }
538
Adam Lesinski00451162017-10-03 07:44:08 -0700539 if (file_ref->type == ResourceFile::Type::kProtoXml) {
540 pb::XmlNode pb_xml_node;
541 if (!pb_xml_node.ParseFromArray(data->data(), static_cast<int>(data->size()))) {
542 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700543 << "failed to parse proto XML");
Adam Lesinski00451162017-10-03 07:44:08 -0700544 return false;
545 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700546
Adam Lesinski00451162017-10-03 07:44:08 -0700547 std::string error;
548 file_op.xml_to_flatten = DeserializeXmlResourceFromPb(pb_xml_node, &error);
549 if (file_op.xml_to_flatten == nullptr) {
550 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700551 << "failed to deserialize proto XML: " << error);
Adam Lesinski00451162017-10-03 07:44:08 -0700552 return false;
553 }
554 } else {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700555 std::string error_str;
556 file_op.xml_to_flatten = xml::Inflate(data->data(), data->size(), &error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700557 if (file_op.xml_to_flatten == nullptr) {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700558 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
559 << "failed to parse binary XML: " << error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700560 return false;
561 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700562 }
563
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800564 // Update the type that this file will be written as.
565 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
566
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700567 file_op.xml_to_flatten->file.config = config_value->config;
568 file_op.xml_to_flatten->file.source = file_ref->GetSource();
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700569 file_op.xml_to_flatten->file.name = ResourceName(pkg->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700570 }
Adam Lesinskic744ae82017-05-17 19:28:38 -0700571
572 // NOTE(adamlesinski): Explicitly construct a StringPiece here, or
573 // else we end up copying the string in the std::make_pair() method,
574 // then creating a StringPiece from the copy, which would cause us
575 // to end up referencing garbage in the map.
576 const StringPiece entry_name(entry->name);
577 config_sorted_files[std::make_pair(config_value->config, entry_name)] =
578 std::move(file_op);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700579 }
580 }
581
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700582 // Now flatten the sorted values.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700583 for (auto& map_entry : config_sorted_files) {
584 const ConfigDescription& config = map_entry.first.first;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700585 FileOperation& file_op = map_entry.second;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700586
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700587 if (file_op.xml_to_flatten) {
Ryan Mitchell70f79722018-08-13 07:37:24 -0700588 // Check minimum sdk versions supported for drawables
589 auto drawable_entry = kDrawableVersions.find(file_op.xml_to_flatten->root->name);
590 if (drawable_entry != kDrawableVersions.end()) {
591 if (drawable_entry->second > context_->GetMinSdkVersion()
592 && drawable_entry->second > config.sdkVersion) {
593 context_->GetDiagnostics()->Error(DiagMessage(file_op.xml_to_flatten->file.source)
594 << "<" << drawable_entry->first << "> elements "
595 << "require a sdk version of at least "
596 << (int16_t) drawable_entry->second);
597 error = true;
598 continue;
599 }
600 }
601
Adam Lesinskic744ae82017-05-17 19:28:38 -0700602 std::vector<std::unique_ptr<xml::XmlResource>> versioned_docs =
603 LinkAndVersionXmlFile(table, &file_op);
Adam Lesinskic0a5e1e2017-08-07 11:56:32 -0700604 if (versioned_docs.empty()) {
605 error = true;
606 continue;
607 }
608
Adam Lesinskic744ae82017-05-17 19:28:38 -0700609 for (std::unique_ptr<xml::XmlResource>& doc : versioned_docs) {
610 std::string dst_path = file_op.dst_path;
611 if (doc->file.config != file_op.config) {
612 // Only add the new versioned configurations.
613 if (context_->IsVerbose()) {
614 context_->GetDiagnostics()->Note(DiagMessage(doc->file.source)
615 << "auto-versioning resource from config '"
616 << config << "' -> '" << doc->file.config << "'");
617 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700618
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800619 const ResourceFile& file = doc->file;
620 dst_path = ResourceUtils::BuildResourceFileName(file, context_->GetNameMangler());
621
622 std::unique_ptr<FileReference> file_ref =
623 util::make_unique<FileReference>(table->string_pool.MakeRef(dst_path));
624 file_ref->SetSource(doc->file.source);
625 // Update the output format of this XML file.
626 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
627 if (!table->AddResourceMangled(file.name, file.config, {}, std::move(file_ref),
628 context_->GetDiagnostics())) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700629 return false;
630 }
631 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700632
633 error |= !FlattenXml(context_, *doc, dst_path, options_.keep_raw_values,
634 false /*utf16*/, options_.output_format, archive_writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700635 }
636 } else {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700637 error |= !io::CopyFileToArchive(context_, file_op.file_to_copy, file_op.dst_path,
638 GetCompressionFlags(file_op.dst_path), archive_writer);
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700639 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700640 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700641 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700642 }
643 return !error;
644}
645
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700646static bool WriteStableIdMapToPath(IDiagnostics* diag,
647 const std::unordered_map<ResourceName, ResourceId>& id_map,
648 const std::string& id_map_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800649 io::FileOutputStream fout(id_map_path);
650 if (fout.HadError()) {
651 diag->Error(DiagMessage(id_map_path) << "failed to open: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700652 return false;
653 }
654
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800655 text::Printer printer(&fout);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700656 for (const auto& entry : id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700657 const ResourceName& name = entry.first;
658 const ResourceId& id = entry.second;
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800659 printer.Print(name.to_string());
660 printer.Print(" = ");
661 printer.Println(id.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700662 }
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800663 fout.Flush();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700664
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800665 if (fout.HadError()) {
666 diag->Error(DiagMessage(id_map_path) << "failed writing to file: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700667 return false;
668 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700669 return true;
670}
671
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700672static bool LoadStableIdMap(IDiagnostics* diag, const std::string& path,
673 std::unordered_map<ResourceName, ResourceId>* out_id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700674 std::string content;
Adam Lesinski2354b562017-05-26 16:31:38 -0700675 if (!android::base::ReadFileToString(path, &content, true /*follow_symlinks*/)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700676 diag->Error(DiagMessage(path) << "failed reading stable ID file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700677 return false;
678 }
679
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700680 out_id_map->clear();
681 size_t line_no = 0;
682 for (StringPiece line : util::Tokenize(content, '\n')) {
683 line_no++;
684 line = util::TrimWhitespace(line);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700685 if (line.empty()) {
686 continue;
687 }
688
689 auto iter = std::find(line.begin(), line.end(), '=');
690 if (iter == line.end()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700691 diag->Error(DiagMessage(Source(path, line_no)) << "missing '='");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700692 return false;
693 }
694
695 ResourceNameRef name;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700696 StringPiece res_name_str =
697 util::TrimWhitespace(line.substr(0, std::distance(line.begin(), iter)));
698 if (!ResourceUtils::ParseResourceName(res_name_str, &name)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700699 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource name '" << res_name_str
700 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700701 return false;
702 }
703
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700704 const size_t res_id_start_idx = std::distance(line.begin(), iter) + 1;
705 const size_t res_id_str_len = line.size() - res_id_start_idx;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700706 StringPiece res_id_str = util::TrimWhitespace(line.substr(res_id_start_idx, res_id_str_len));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700707
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700708 Maybe<ResourceId> maybe_id = ResourceUtils::ParseResourceId(res_id_str);
709 if (!maybe_id) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700710 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource ID '" << res_id_str
711 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700712 return false;
713 }
714
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700715 (*out_id_map)[name.ToResourceName()] = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700716 }
717 return true;
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700718}
719
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800720static android::ApkAssetsCookie FindFrameworkAssetManagerCookie(
721 const android::AssetManager2& assets) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800722 using namespace android;
723
724 // Find the system package (0x01). AAPT always generates attributes with the type 0x01, so
725 // we're looking for the first attribute resource in the system package.
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800726 Res_value val{};
727 ResTable_config config{};
728 uint32_t type_spec_flags;
729 ApkAssetsCookie idx = assets.GetResource(0x01010000, true /** may_be_bag */,
730 0 /** density_override */, &val, &config,
731 &type_spec_flags);
Adam Lesinskic6284372017-12-04 13:46:23 -0800732
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800733 return idx;
Adam Lesinskic6284372017-12-04 13:46:23 -0800734}
735
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700736class Linker {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700737 public:
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700738 Linker(LinkContext* context, const LinkOptions& options)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700739 : options_(options),
740 context_(context),
741 final_table_(),
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700742 file_collection_(util::make_unique<io::FileCollection>()) {
743 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700744
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800745 void ExtractCompileSdkVersions(android::AssetManager2* assets) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800746 using namespace android;
747
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800748 android::ApkAssetsCookie cookie = FindFrameworkAssetManagerCookie(*assets);
749 if (cookie == android::kInvalidCookie) {
Adam Lesinskic6284372017-12-04 13:46:23 -0800750 // No Framework assets loaded. Not a failure.
751 return;
752 }
753
754 std::unique_ptr<Asset> manifest(
Ryan Mitchella55dc2e2019-01-24 10:58:23 -0800755 assets->OpenNonAsset(kAndroidManifestPath, cookie, Asset::AccessMode::ACCESS_BUFFER));
Adam Lesinskic6284372017-12-04 13:46:23 -0800756 if (manifest == nullptr) {
757 // No errors.
758 return;
759 }
760
761 std::string error;
762 std::unique_ptr<xml::XmlResource> manifest_xml =
763 xml::Inflate(manifest->getBuffer(true /*wordAligned*/), manifest->getLength(), &error);
764 if (manifest_xml == nullptr) {
765 // No errors.
766 return;
767 }
768
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700769 if (!options_.manifest_fixer_options.compile_sdk_version) {
770 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionCode");
771 if (attr != nullptr) {
772 Maybe<std::string>& compile_sdk_version = options_.manifest_fixer_options.compile_sdk_version;
773 if (BinaryPrimitive* prim = ValueCast<BinaryPrimitive>(attr->compiled_value.get())) {
774 switch (prim->value.dataType) {
775 case Res_value::TYPE_INT_DEC:
776 compile_sdk_version = StringPrintf("%" PRId32, static_cast<int32_t>(prim->value.data));
777 break;
778 case Res_value::TYPE_INT_HEX:
779 compile_sdk_version = StringPrintf("%" PRIx32, prim->value.data);
780 break;
781 default:
782 break;
783 }
784 } else if (String* str = ValueCast<String>(attr->compiled_value.get())) {
785 compile_sdk_version = *str->value;
786 } else {
787 compile_sdk_version = attr->value;
Adam Lesinskic6284372017-12-04 13:46:23 -0800788 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800789 }
790 }
791
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700792 if (!options_.manifest_fixer_options.compile_sdk_version_codename) {
793 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionName");
794 if (attr != nullptr) {
795 Maybe<std::string>& compile_sdk_version_codename =
796 options_.manifest_fixer_options.compile_sdk_version_codename;
797 if (String* str = ValueCast<String>(attr->compiled_value.get())) {
798 compile_sdk_version_codename = *str->value;
799 } else {
800 compile_sdk_version_codename = attr->value;
801 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800802 }
803 }
804 }
805
Adam Lesinski8780eb62017-10-31 17:44:39 -0700806 // Creates a SymbolTable that loads symbols from the various APKs.
Adam Lesinskic6284372017-12-04 13:46:23 -0800807 // Pre-condition: context_->GetCompilationPackage() needs to be set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700808 bool LoadSymbolsFromIncludePaths() {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700809 auto asset_source = util::make_unique<AssetManagerSymbolSource>();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700810 for (const std::string& path : options_.include_paths) {
811 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700812 context_->GetDiagnostics()->Note(DiagMessage() << "including " << path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700813 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700814
Adam Lesinski8780eb62017-10-31 17:44:39 -0700815 std::string error;
816 auto zip_collection = io::ZipFileCollection::Create(path, &error);
817 if (zip_collection == nullptr) {
818 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open APK: " << error);
819 return false;
820 }
821
822 if (zip_collection->FindFile(kProtoResourceTablePath) != nullptr) {
823 // Load this as a static library include.
824 std::unique_ptr<LoadedApk> static_apk = LoadedApk::LoadProtoApkFromFileCollection(
825 Source(path), std::move(zip_collection), context_->GetDiagnostics());
826 if (static_apk == nullptr) {
827 return false;
828 }
829
Adam Lesinskib522f042017-04-21 16:57:59 -0700830 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800831 // Can't include static libraries when not building a static library (they have no IDs
832 // assigned).
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700833 context_->GetDiagnostics()->Error(
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800834 DiagMessage(path) << "can't include static library when not building a static lib");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700835 return false;
836 }
837
Adam Lesinski8780eb62017-10-31 17:44:39 -0700838 ResourceTable* table = static_apk->GetResourceTable();
839
840 // If we are using --no-static-lib-packages, we need to rename the package of this table to
841 // our compilation package.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700842 if (options_.no_static_lib_packages) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800843 // Since package names can differ, and multiple packages can exist in a ResourceTable,
844 // we place the requirement that all static libraries are built with the package
845 // ID 0x7f. So if one is not found, this is an error.
Adam Lesinski8780eb62017-10-31 17:44:39 -0700846 if (ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700847 pkg->name = context_->GetCompilationPackage();
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800848 } else {
849 context_->GetDiagnostics()->Error(DiagMessage(path)
850 << "no package with ID 0x7f found in static library");
851 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700852 }
853 }
854
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700855 context_->GetExternalSymbols()->AppendSource(
Adam Lesinski8780eb62017-10-31 17:44:39 -0700856 util::make_unique<ResourceTableSymbolSource>(table));
857 static_library_includes_.push_back(std::move(static_apk));
858 } else {
859 if (!asset_source->AddAssetPath(path)) {
860 context_->GetDiagnostics()->Error(DiagMessage()
861 << "failed to load include path " << path);
862 return false;
863 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700864 }
865 }
866
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800867 // Capture the shared libraries so that the final resource table can be properly flattened
868 // with support for shared libraries.
869 for (auto& entry : asset_source->GetAssignedPackageIds()) {
Todd Kennedy32512992018-04-25 16:45:59 -0700870 if (entry.first == kAppPackageId) {
Adam Lesinski490595a2017-11-07 17:08:07 -0800871 // Capture the included base feature package.
872 included_feature_base_ = entry.second;
Adam Lesinskic6284372017-12-04 13:46:23 -0800873 } else if (entry.first == kFrameworkPackageId) {
874 // Try to embed which version of the framework we're compiling against.
875 // First check if we should use compileSdkVersion at all. Otherwise compilation may fail
876 // when linking our synthesized 'android:compileSdkVersion' attribute.
877 std::unique_ptr<SymbolTable::Symbol> symbol = asset_source->FindByName(
878 ResourceName("android", ResourceType::kAttr, "compileSdkVersion"));
879 if (symbol != nullptr && symbol->is_public) {
880 // The symbol is present and public, extract the android:versionName and
881 // android:versionCode from the framework AndroidManifest.xml.
882 ExtractCompileSdkVersions(asset_source->GetAssetManager());
883 }
Todd Kennedy32512992018-04-25 16:45:59 -0700884 } else if (asset_source->IsPackageDynamic(entry.first)) {
885 final_table_.included_packages_[entry.first] = entry.second;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800886 }
887 }
888
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700889 context_->GetExternalSymbols()->AppendSource(std::move(asset_source));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700890 return true;
891 }
892
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800893 Maybe<AppInfo> ExtractAppInfoFromManifest(xml::XmlResource* xml_res, IDiagnostics* diag) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700894 // Make sure the first element is <manifest> with package attribute.
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800895 xml::Element* manifest_el = xml::FindRootElement(xml_res->root.get());
896 if (manifest_el == nullptr) {
897 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700898 }
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800899
900 AppInfo app_info;
901
902 if (!manifest_el->namespace_uri.empty() || manifest_el->name != "manifest") {
903 diag->Error(DiagMessage(xml_res->file.source) << "root tag must be <manifest>");
904 return {};
905 }
906
907 xml::Attribute* package_attr = manifest_el->FindAttribute({}, "package");
908 if (!package_attr) {
909 diag->Error(DiagMessage(xml_res->file.source)
910 << "<manifest> must have a 'package' attribute");
911 return {};
912 }
913 app_info.package = package_attr->value;
914
915 if (xml::Attribute* version_code_attr =
916 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCode")) {
917 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_attr->value);
918 if (!maybe_code) {
919 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
920 << "invalid android:versionCode '" << version_code_attr->value << "'");
921 return {};
922 }
923 app_info.version_code = maybe_code.value();
924 }
925
Ryan Mitchell5fa2bb12018-07-12 11:24:51 -0700926 if (xml::Attribute* version_code_major_attr =
927 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCodeMajor")) {
928 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_major_attr->value);
929 if (!maybe_code) {
930 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
931 << "invalid android:versionCodeMajor '"
932 << version_code_major_attr->value << "'");
933 return {};
934 }
935 app_info.version_code_major = maybe_code.value();
936 }
937
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800938 if (xml::Attribute* revision_code_attr =
939 manifest_el->FindAttribute(xml::kSchemaAndroid, "revisionCode")) {
940 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(revision_code_attr->value);
941 if (!maybe_code) {
942 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
943 << "invalid android:revisionCode '" << revision_code_attr->value << "'");
944 return {};
945 }
946 app_info.revision_code = maybe_code.value();
947 }
948
949 if (xml::Attribute* split_name_attr = manifest_el->FindAttribute({}, "split")) {
950 if (!split_name_attr->value.empty()) {
951 app_info.split_name = split_name_attr->value;
952 }
953 }
954
955 if (xml::Element* uses_sdk_el = manifest_el->FindChild({}, "uses-sdk")) {
956 if (xml::Attribute* min_sdk =
957 uses_sdk_el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion")) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700958 app_info.min_sdk_version = ResourceUtils::ParseSdkVersion(min_sdk->value);
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800959 }
960 }
961 return app_info;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700962 }
963
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700964 // Precondition: ResourceTable doesn't have any IDs assigned yet, nor is it linked.
965 // Postcondition: ResourceTable has only one package left. All others are
966 // stripped, or there is an error and false is returned.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700967 bool VerifyNoExternalPackages() {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700968 auto is_ext_package_func = [&](const std::unique_ptr<ResourceTablePackage>& pkg) -> bool {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700969 return context_->GetCompilationPackage() != pkg->name || !pkg->id ||
970 pkg->id.value() != context_->GetPackageId();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700971 };
972
973 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700974 for (const auto& package : final_table_.packages) {
975 if (is_ext_package_func(package)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700976 // We have a package that is not related to the one we're building!
977 for (const auto& type : package->types) {
978 for (const auto& entry : type->entries) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700979 ResourceNameRef res_name(package->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700980
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700981 for (const auto& config_value : entry->values) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700982 // Special case the occurrence of an ID that is being generated
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700983 // for the 'android' package. This is due to legacy reasons.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700984 if (ValueCast<Id>(config_value->value.get()) && package->name == "android") {
985 context_->GetDiagnostics()->Warn(DiagMessage(config_value->value->GetSource())
986 << "generated id '" << res_name
987 << "' for external package '" << package->name
988 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700989 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700990 context_->GetDiagnostics()->Error(DiagMessage(config_value->value->GetSource())
991 << "defined resource '" << res_name
992 << "' for external package '" << package->name
993 << "'");
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700994 error = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700995 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700996 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700997 }
998 }
999 }
1000 }
1001
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001002 auto new_end_iter = std::remove_if(final_table_.packages.begin(), final_table_.packages.end(),
1003 is_ext_package_func);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001004 final_table_.packages.erase(new_end_iter, final_table_.packages.end());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001005 return !error;
1006 }
1007
1008 /**
1009 * Returns true if no IDs have been set, false otherwise.
1010 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001011 bool VerifyNoIdsSet() {
1012 for (const auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001013 for (const auto& type : package->types) {
1014 if (type->id) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001015 context_->GetDiagnostics()->Error(DiagMessage() << "type " << type->type << " has ID "
1016 << StringPrintf("%02x", type->id.value())
1017 << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001018 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001019 }
1020
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001021 for (const auto& entry : type->entries) {
1022 if (entry->id) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001023 ResourceNameRef res_name(package->name, type->type, entry->name);
1024 context_->GetDiagnostics()->Error(
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001025 DiagMessage() << "entry " << res_name << " has ID "
1026 << StringPrintf("%02x", entry->id.value()) << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001027 return false;
1028 }
1029 }
1030 }
1031 }
1032 return true;
1033 }
1034
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001035 std::unique_ptr<IArchiveWriter> MakeArchiveWriter(const StringPiece& out) {
1036 if (options_.output_to_directory) {
1037 return CreateDirectoryArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001038 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001039 return CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001040 }
1041 }
1042
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001043 bool FlattenTable(ResourceTable* table, OutputFormat format, IArchiveWriter* writer) {
1044 switch (format) {
1045 case OutputFormat::kApk: {
1046 BigBuffer buffer(1024);
1047 TableFlattener flattener(options_.table_flattener_options, &buffer);
1048 if (!flattener.Consume(context_, table)) {
1049 context_->GetDiagnostics()->Error(DiagMessage() << "failed to flatten resource table");
1050 return false;
1051 }
1052
1053 io::BigBufferInputStream input_stream(&buffer);
1054 return io::CopyInputStreamToArchive(context_, &input_stream, kApkResourceTablePath,
1055 ArchiveEntry::kAlign, writer);
1056 } break;
1057
1058 case OutputFormat::kProto: {
1059 pb::ResourceTable pb_table;
Ryan Mitchella15c2a82018-03-26 11:05:31 -07001060 SerializeTableToPb(*table, &pb_table, context_->GetDiagnostics());
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001061 return io::CopyProtoToArchive(context_, &pb_table, kProtoResourceTablePath,
1062 ArchiveEntry::kCompress, writer);
1063 } break;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001064 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001065 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001066 }
1067
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001068 bool WriteJavaFile(ResourceTable* table, const StringPiece& package_name_to_generate,
Adam Lesinski418763f2017-04-11 17:36:53 -07001069 const StringPiece& out_package, const JavaClassGeneratorOptions& java_options,
Chih-Hung Hsieh4dc58122017-08-03 16:28:10 -07001070 const Maybe<std::string>& out_text_symbols_path = {}) {
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001071 if (!options_.generate_java_class_path && !out_text_symbols_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001072 return true;
1073 }
1074
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001075 std::string out_path;
1076 std::unique_ptr<io::FileOutputStream> fout;
1077 if (options_.generate_java_class_path) {
1078 out_path = options_.generate_java_class_path.value();
1079 file::AppendPath(&out_path, file::PackageToPath(out_package));
1080 if (!file::mkdirs(out_path)) {
1081 context_->GetDiagnostics()->Error(DiagMessage()
1082 << "failed to create directory '" << out_path << "'");
1083 return false;
1084 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001085
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001086 file::AppendPath(&out_path, "R.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001087
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001088 fout = util::make_unique<io::FileOutputStream>(out_path);
1089 if (fout->HadError()) {
1090 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1091 << "': " << fout->GetError());
1092 return false;
1093 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001094 }
1095
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001096 std::unique_ptr<io::FileOutputStream> fout_text;
Adam Lesinski418763f2017-04-11 17:36:53 -07001097 if (out_text_symbols_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001098 fout_text = util::make_unique<io::FileOutputStream>(out_text_symbols_path.value());
1099 if (fout_text->HadError()) {
1100 context_->GetDiagnostics()->Error(DiagMessage()
1101 << "failed writing to '" << out_text_symbols_path.value()
1102 << "': " << fout_text->GetError());
Adam Lesinski418763f2017-04-11 17:36:53 -07001103 return false;
1104 }
1105 }
1106
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001107 JavaClassGenerator generator(context_, table, java_options);
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001108 if (!generator.Generate(package_name_to_generate, out_package, fout.get(), fout_text.get())) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001109 context_->GetDiagnostics()->Error(DiagMessage(out_path) << generator.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001110 return false;
1111 }
1112
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001113 return true;
1114 }
1115
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001116 bool GenerateJavaClasses() {
1117 // The set of packages whose R class to call in the main classes onResourcesLoaded callback.
1118 std::vector<std::string> packages_to_callback;
1119
1120 JavaClassGeneratorOptions template_options;
1121 template_options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1122 template_options.javadoc_annotations = options_.javadoc_annotations;
1123
1124 if (context_->GetPackageType() == PackageType::kStaticLib || options_.generate_non_final_ids) {
1125 template_options.use_final = false;
1126 }
1127
1128 if (context_->GetPackageType() == PackageType::kSharedLib) {
1129 template_options.use_final = false;
1130 template_options.rewrite_callback_options = OnResourcesLoadedCallbackOptions{};
1131 }
1132
1133 const StringPiece actual_package = context_->GetCompilationPackage();
1134 StringPiece output_package = context_->GetCompilationPackage();
1135 if (options_.custom_java_package) {
1136 // Override the output java package to the custom one.
1137 output_package = options_.custom_java_package.value();
1138 }
1139
1140 // Generate the private symbols if required.
1141 if (options_.private_symbols) {
1142 packages_to_callback.push_back(options_.private_symbols.value());
1143
1144 // If we defined a private symbols package, we only emit Public symbols
1145 // to the original package, and private and public symbols to the private package.
1146 JavaClassGeneratorOptions options = template_options;
1147 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate;
1148 if (!WriteJavaFile(&final_table_, actual_package, options_.private_symbols.value(),
1149 options)) {
1150 return false;
1151 }
1152 }
1153
1154 // Generate copies of the original package R class but with different package names.
1155 // This is to support non-namespaced builds.
1156 for (const std::string& extra_package : options_.extra_java_packages) {
1157 packages_to_callback.push_back(extra_package);
1158
1159 JavaClassGeneratorOptions options = template_options;
1160 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1161 if (!WriteJavaFile(&final_table_, actual_package, extra_package, options)) {
1162 return false;
1163 }
1164 }
1165
1166 // Generate R classes for each package that was merged (static library).
1167 // Use the actual package's resources only.
1168 for (const std::string& package : table_merger_->merged_packages()) {
1169 packages_to_callback.push_back(package);
1170
1171 JavaClassGeneratorOptions options = template_options;
1172 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1173 if (!WriteJavaFile(&final_table_, package, package, options)) {
1174 return false;
1175 }
1176 }
1177
1178 // Generate the main public R class.
1179 JavaClassGeneratorOptions options = template_options;
1180
1181 // Only generate public symbols if we have a private package.
1182 if (options_.private_symbols) {
1183 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublic;
1184 }
1185
1186 if (options.rewrite_callback_options) {
1187 options.rewrite_callback_options.value().packages_to_callback =
1188 std::move(packages_to_callback);
1189 }
1190
1191 if (!WriteJavaFile(&final_table_, actual_package, output_package, options,
1192 options_.generate_text_symbols_path)) {
1193 return false;
1194 }
1195
1196 return true;
1197 }
1198
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001199 bool WriteManifestJavaFile(xml::XmlResource* manifest_xml) {
1200 if (!options_.generate_java_class_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001201 return true;
1202 }
1203
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001204 std::unique_ptr<ClassDefinition> manifest_class =
1205 GenerateManifestClass(context_->GetDiagnostics(), manifest_xml);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001206
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001207 if (!manifest_class) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001208 // Something bad happened, but we already logged it, so exit.
1209 return false;
1210 }
1211
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001212 if (manifest_class->empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001213 // Empty Manifest class, no need to generate it.
1214 return true;
1215 }
1216
1217 // Add any JavaDoc annotations to the generated class.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001218 for (const std::string& annotation : options_.javadoc_annotations) {
1219 std::string proper_annotation = "@";
1220 proper_annotation += annotation;
1221 manifest_class->GetCommentBuilder()->AppendComment(proper_annotation);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001222 }
1223
Adam Lesinski0d81f702017-06-27 15:51:09 -07001224 const std::string package_utf8 =
1225 options_.custom_java_package.value_or_default(context_->GetCompilationPackage());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001226
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001227 std::string out_path = options_.generate_java_class_path.value();
1228 file::AppendPath(&out_path, file::PackageToPath(package_utf8));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001229
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001230 if (!file::mkdirs(out_path)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001231 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create directory '" << out_path
1232 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001233 return false;
1234 }
1235
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001236 file::AppendPath(&out_path, "Manifest.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001237
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001238 io::FileOutputStream fout(out_path);
1239 if (fout.HadError()) {
1240 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1241 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001242 return false;
1243 }
1244
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001245 ClassDefinition::WriteJavaFile(manifest_class.get(), package_utf8, true, &fout);
1246 fout.Flush();
1247
1248 if (fout.HadError()) {
1249 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1250 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001251 return false;
1252 }
1253 return true;
1254 }
1255
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001256 bool WriteProguardFile(const Maybe<std::string>& out, const proguard::KeepSet& keep_set) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001257 if (!out) {
1258 return true;
1259 }
1260
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001261 const std::string& out_path = out.value();
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001262 io::FileOutputStream fout(out_path);
1263 if (fout.HadError()) {
1264 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1265 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001266 return false;
1267 }
1268
Ryan Mitchell7e5236d2018-09-25 15:20:59 -07001269 proguard::WriteKeepSet(keep_set, &fout, options_.generate_minimal_proguard_rules);
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001270 fout.Flush();
1271
1272 if (fout.HadError()) {
1273 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1274 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001275 return false;
1276 }
1277 return true;
1278 }
1279
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001280 bool MergeStaticLibrary(const std::string& input, bool override) {
1281 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001282 context_->GetDiagnostics()->Note(DiagMessage() << "merging static library " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001283 }
1284
Adam Lesinski8780eb62017-10-31 17:44:39 -07001285 std::unique_ptr<LoadedApk> apk = LoadedApk::LoadApkFromPath(input, context_->GetDiagnostics());
1286 if (apk == nullptr) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001287 context_->GetDiagnostics()->Error(DiagMessage(input) << "invalid static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001288 return false;
1289 }
1290
Adam Lesinski8780eb62017-10-31 17:44:39 -07001291 ResourceTable* table = apk->GetResourceTable();
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001292 ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001293 if (!pkg) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001294 context_->GetDiagnostics()->Error(DiagMessage(input) << "static library has no package");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001295 return false;
1296 }
1297
1298 bool result;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001299 if (options_.no_static_lib_packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001300 // Merge all resources as if they were in the compilation package. This is the old behavior
1301 // of aapt.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001302
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001303 // Add the package to the set of --extra-packages so we emit an R.java for each library
1304 // package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001305 if (!pkg->name.empty()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001306 options_.extra_java_packages.insert(pkg->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001307 }
1308
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001309 // Clear the package name, so as to make the resources look like they are coming from the
1310 // local package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001311 pkg->name = "";
Adam Lesinski8780eb62017-10-31 17:44:39 -07001312 result = table_merger_->Merge(Source(input), table, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001313
1314 } else {
1315 // This is the proper way to merge libraries, where the package name is
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001316 // preserved and resource names are mangled.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001317 result = table_merger_->MergeAndMangle(Source(input), pkg->name, table);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001318 }
1319
1320 if (!result) {
1321 return false;
1322 }
1323
1324 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001325 merged_apks_.push_back(std::move(apk));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001326 return true;
1327 }
1328
Adam Lesinski2427dce2017-11-30 15:10:28 -08001329 bool MergeExportedSymbols(const Source& source,
1330 const std::vector<SourcedResourceName>& exported_symbols) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001331 // Add the exports of this file to the table.
Adam Lesinski2427dce2017-11-30 15:10:28 -08001332 for (const SourcedResourceName& exported_symbol : exported_symbols) {
Adam Lesinski00451162017-10-03 07:44:08 -07001333 ResourceName res_name = exported_symbol.name;
1334 if (res_name.package.empty()) {
1335 res_name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001336 }
1337
Adam Lesinski00451162017-10-03 07:44:08 -07001338 Maybe<ResourceName> mangled_name = context_->GetNameMangler()->MangleName(res_name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001339 if (mangled_name) {
1340 res_name = mangled_name.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001341 }
1342
1343 std::unique_ptr<Id> id = util::make_unique<Id>();
Adam Lesinski2427dce2017-11-30 15:10:28 -08001344 id->SetSource(source.WithLine(exported_symbol.line));
Adam Lesinski71be7052017-12-12 16:48:07 -08001345 bool result =
1346 final_table_.AddResourceMangled(res_name, ConfigDescription::DefaultConfig(),
1347 std::string(), std::move(id), context_->GetDiagnostics());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001348 if (!result) {
1349 return false;
1350 }
1351 }
1352 return true;
1353 }
1354
Adam Lesinski2427dce2017-11-30 15:10:28 -08001355 bool MergeCompiledFile(const ResourceFile& compiled_file, io::IFile* file, bool override) {
1356 if (context_->IsVerbose()) {
1357 context_->GetDiagnostics()->Note(DiagMessage()
1358 << "merging '" << compiled_file.name
1359 << "' from compiled file " << compiled_file.source);
1360 }
1361
1362 if (!table_merger_->MergeFile(compiled_file, override, file)) {
1363 return false;
1364 }
1365 return MergeExportedSymbols(compiled_file.source, compiled_file.exported_symbols);
1366 }
1367
Adam Lesinski00451162017-10-03 07:44:08 -07001368 // Takes a path to load as a ZIP file and merges the files within into the master ResourceTable.
1369 // If override is true, conflicting resources are allowed to override each other, in order of last
1370 // seen.
1371 // An io::IFileCollection is created from the ZIP file and added to the set of
1372 // io::IFileCollections that are open.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001373 bool MergeArchive(const std::string& input, bool override) {
1374 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001375 context_->GetDiagnostics()->Note(DiagMessage() << "merging archive " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001376 }
1377
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001378 std::string error_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001379 std::unique_ptr<io::ZipFileCollection> collection =
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001380 io::ZipFileCollection::Create(input, &error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001381 if (!collection) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001382 context_->GetDiagnostics()->Error(DiagMessage(input) << error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001383 return false;
1384 }
1385
1386 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001387 for (auto iter = collection->Iterator(); iter->HasNext();) {
1388 if (!MergeFile(iter->Next(), override)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001389 error = true;
1390 }
1391 }
1392
1393 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001394 collections_.push_back(std::move(collection));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001395 return !error;
1396 }
1397
Adam Lesinski00451162017-10-03 07:44:08 -07001398 // Takes a path to load and merge into the master ResourceTable. If override is true,
1399 // conflicting resources are allowed to override each other, in order of last seen.
1400 // If the file path ends with .flata, .jar, .jack, or .zip the file is treated
1401 // as ZIP archive and the files within are merged individually.
1402 // Otherwise the file is processed on its own.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001403 bool MergePath(const std::string& path, bool override) {
1404 if (util::EndsWith(path, ".flata") || util::EndsWith(path, ".jar") ||
1405 util::EndsWith(path, ".jack") || util::EndsWith(path, ".zip")) {
1406 return MergeArchive(path, override);
1407 } else if (util::EndsWith(path, ".apk")) {
1408 return MergeStaticLibrary(path, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001409 }
1410
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001411 io::IFile* file = file_collection_->InsertFile(path);
1412 return MergeFile(file, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001413 }
1414
Adam Lesinski00451162017-10-03 07:44:08 -07001415 // Takes an AAPT Container file (.apc/.flat) to load and merge into the master ResourceTable.
1416 // If override is true, conflicting resources are allowed to override each other, in order of last
1417 // seen.
1418 // All other file types are ignored. This is because these files could be coming from a zip,
1419 // where we could have other files like classes.dex.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001420 bool MergeFile(io::IFile* file, bool override) {
1421 const Source& src = file->GetSource();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001422
Adam Lesinski00451162017-10-03 07:44:08 -07001423 if (util::EndsWith(src.path, ".xml") || util::EndsWith(src.path, ".png")) {
Adam Lesinski6a396c12016-10-20 14:38:23 -07001424 // Since AAPT compiles these file types and appends .flat to them, seeing
1425 // their raw extensions is a sign that they weren't compiled.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001426 const StringPiece file_type = util::EndsWith(src.path, ".xml") ? "XML" : "PNG";
1427 context_->GetDiagnostics()->Error(DiagMessage(src) << "uncompiled " << file_type
1428 << " file passed as argument. Must be "
1429 "compiled first into .flat file.");
Adam Lesinski6a396c12016-10-20 14:38:23 -07001430 return false;
Adam Lesinski00451162017-10-03 07:44:08 -07001431 } else if (!util::EndsWith(src.path, ".apc") && !util::EndsWith(src.path, ".flat")) {
1432 if (context_->IsVerbose()) {
1433 context_->GetDiagnostics()->Warn(DiagMessage(src) << "ignoring unrecognized file");
1434 return true;
1435 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001436 }
1437
Adam Lesinski00451162017-10-03 07:44:08 -07001438 std::unique_ptr<io::InputStream> input_stream = file->OpenInputStream();
1439 if (input_stream == nullptr) {
1440 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to open file");
1441 return false;
1442 }
1443
1444 if (input_stream->HadError()) {
1445 context_->GetDiagnostics()->Error(DiagMessage(src)
1446 << "failed to open file: " << input_stream->GetError());
1447 return false;
1448 }
1449
1450 ContainerReaderEntry* entry;
1451 ContainerReader reader(input_stream.get());
Mohamed Heikal10844322018-02-07 15:17:38 -05001452
1453 if (reader.HadError()) {
1454 context_->GetDiagnostics()->Error(DiagMessage(src)
1455 << "failed to read file: " << reader.GetError());
1456 return false;
1457 }
1458
Adam Lesinski00451162017-10-03 07:44:08 -07001459 while ((entry = reader.Next()) != nullptr) {
1460 if (entry->Type() == ContainerEntryType::kResTable) {
1461 pb::ResourceTable pb_table;
1462 if (!entry->GetResTable(&pb_table)) {
1463 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to read resource table: "
1464 << entry->GetError());
1465 return false;
1466 }
1467
1468 ResourceTable table;
1469 std::string error;
Adam Lesinski8780eb62017-10-31 17:44:39 -07001470 if (!DeserializeTableFromPb(pb_table, nullptr /*files*/, &table, &error)) {
Adam Lesinski00451162017-10-03 07:44:08 -07001471 context_->GetDiagnostics()->Error(DiagMessage(src)
1472 << "failed to deserialize resource table: " << error);
1473 return false;
1474 }
1475
1476 if (!table_merger_->Merge(src, &table, override)) {
1477 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to merge resource table");
1478 return false;
1479 }
1480 } else if (entry->Type() == ContainerEntryType::kResFile) {
1481 pb::internal::CompiledFile pb_compiled_file;
1482 off64_t offset;
1483 size_t len;
1484 if (!entry->GetResFileOffsets(&pb_compiled_file, &offset, &len)) {
1485 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to get resource file: "
1486 << entry->GetError());
1487 return false;
1488 }
1489
1490 ResourceFile resource_file;
1491 std::string error;
1492 if (!DeserializeCompiledFileFromPb(pb_compiled_file, &resource_file, &error)) {
1493 context_->GetDiagnostics()->Error(DiagMessage(src)
1494 << "failed to read compiled header: " << error);
1495 return false;
1496 }
1497
1498 if (!MergeCompiledFile(resource_file, file->CreateFileSegment(offset, len), override)) {
1499 return false;
1500 }
1501 }
1502 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001503 return true;
1504 }
1505
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001506 bool CopyAssetsDirsToApk(IArchiveWriter* writer) {
1507 std::map<std::string, std::unique_ptr<io::RegularFile>> merged_assets;
1508 for (const std::string& assets_dir : options_.assets_dirs) {
1509 Maybe<std::vector<std::string>> files =
1510 file::FindFiles(assets_dir, context_->GetDiagnostics(), nullptr);
1511 if (!files) {
1512 return false;
1513 }
1514
1515 for (const std::string& file : files.value()) {
1516 std::string full_key = "assets/" + file;
1517 std::string full_path = assets_dir;
1518 file::AppendPath(&full_path, file);
1519
1520 auto iter = merged_assets.find(full_key);
1521 if (iter == merged_assets.end()) {
1522 merged_assets.emplace(std::move(full_key),
1523 util::make_unique<io::RegularFile>(Source(std::move(full_path))));
1524 } else if (context_->IsVerbose()) {
1525 context_->GetDiagnostics()->Warn(DiagMessage(iter->second->GetSource())
1526 << "asset file overrides '" << full_path << "'");
1527 }
1528 }
1529 }
1530
1531 for (auto& entry : merged_assets) {
1532 uint32_t compression_flags = ArchiveEntry::kCompress;
1533 std::string extension = file::GetExtension(entry.first).to_string();
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01001534
1535 if (options_.do_not_compress_anything
1536 || options_.extensions_to_not_compress.count(extension) > 0
1537 || (options_.regex_to_not_compress
1538 && std::regex_search(extension, options_.regex_to_not_compress.value()))) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001539 compression_flags = 0u;
1540 }
1541
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001542 if (!io::CopyFileToArchive(context_, entry.second.get(), entry.first, compression_flags,
1543 writer)) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001544 return false;
1545 }
1546 }
1547 return true;
1548 }
1549
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001550 // Writes the AndroidManifest, ResourceTable, and all XML files referenced by the ResourceTable
1551 // to the IArchiveWriter.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001552 bool WriteApk(IArchiveWriter* writer, proguard::KeepSet* keep_set, xml::XmlResource* manifest,
1553 ResourceTable* table) {
Ryan Mitchell479fa392019-01-02 17:15:39 -08001554 const bool keep_raw_values = (context_->GetPackageType() == PackageType::kStaticLib)
1555 || options_.keep_raw_values;
Ryan Mitchell467b6892018-11-09 15:52:07 -08001556 bool result = FlattenXml(context_, *manifest, kAndroidManifestPath, keep_raw_values,
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001557 true /*utf16*/, options_.output_format, writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001558 if (!result) {
1559 return false;
1560 }
1561
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001562 ResourceFileFlattenerOptions file_flattener_options;
1563 file_flattener_options.keep_raw_values = keep_raw_values;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001564 file_flattener_options.do_not_compress_anything = options_.do_not_compress_anything;
1565 file_flattener_options.extensions_to_not_compress = options_.extensions_to_not_compress;
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01001566 file_flattener_options.regex_to_not_compress = options_.regex_to_not_compress;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001567 file_flattener_options.no_auto_version = options_.no_auto_version;
1568 file_flattener_options.no_version_vectors = options_.no_version_vectors;
Yuichi Araki4d35cca2017-01-18 20:42:17 +09001569 file_flattener_options.no_version_transitions = options_.no_version_transitions;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001570 file_flattener_options.no_xml_namespaces = options_.no_xml_namespaces;
1571 file_flattener_options.update_proguard_spec =
1572 static_cast<bool>(options_.generate_proguard_rules_path);
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001573 file_flattener_options.output_format = options_.output_format;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001574
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001575 ResourceFileFlattener file_flattener(file_flattener_options, context_, keep_set);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001576
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001577 if (!file_flattener.Flatten(table, writer)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001578 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking file resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001579 return false;
1580 }
1581
Adam Lesinski490595a2017-11-07 17:08:07 -08001582 // Hack to fix b/68820737.
1583 // We need to modify the ResourceTable's package name, but that should NOT affect
1584 // anything else being generated, which includes the Java classes.
1585 // If required, the package name is modifed before flattening, and then modified back
1586 // to its original name.
1587 ResourceTablePackage* package_to_rewrite = nullptr;
Todd Kennedy32512992018-04-25 16:45:59 -07001588 // Pre-O, the platform treats negative resource IDs [those with a package ID of 0x80
1589 // or higher] as invalid. In order to work around this limitation, we allow the use
1590 // of traditionally reserved resource IDs [those between 0x02 and 0x7E]. Allow the
1591 // definition of what a valid "split" package ID is to account for this.
1592 const bool isSplitPackage = (options_.allow_reserved_package_id &&
1593 context_->GetPackageId() != kAppPackageId &&
1594 context_->GetPackageId() != kFrameworkPackageId)
1595 || (!options_.allow_reserved_package_id && context_->GetPackageId() > kAppPackageId);
1596 if (isSplitPackage &&
Adam Lesinski490595a2017-11-07 17:08:07 -08001597 included_feature_base_ == make_value(context_->GetCompilationPackage())) {
1598 // The base APK is included, and this is a feature split. If the base package is
1599 // the same as this package, then we are building an old style Android Instant Apps feature
1600 // split and must apply this workaround to avoid requiring namespaces support.
1601 package_to_rewrite = table->FindPackage(context_->GetCompilationPackage());
1602 if (package_to_rewrite != nullptr) {
1603 CHECK_EQ(1u, table->packages.size()) << "can't change name of package when > 1 package";
1604
1605 std::string new_package_name =
1606 StringPrintf("%s.%s", package_to_rewrite->name.c_str(),
1607 app_info_.split_name.value_or_default("feature").c_str());
1608
1609 if (context_->IsVerbose()) {
1610 context_->GetDiagnostics()->Note(
1611 DiagMessage() << "rewriting resource package name for feature split to '"
1612 << new_package_name << "'");
1613 }
1614 package_to_rewrite->name = new_package_name;
1615 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001616 }
Adam Lesinski490595a2017-11-07 17:08:07 -08001617
1618 bool success = FlattenTable(table, options_.output_format, writer);
1619
1620 if (package_to_rewrite != nullptr) {
1621 // Change the name back.
1622 package_to_rewrite->name = context_->GetCompilationPackage();
1623 if (package_to_rewrite->id) {
1624 table->included_packages_.erase(package_to_rewrite->id.value());
1625 }
1626 }
1627
1628 if (!success) {
1629 context_->GetDiagnostics()->Error(DiagMessage() << "failed to write resource table");
1630 }
1631 return success;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001632 }
1633
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001634 int Run(const std::vector<std::string>& input_files) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001635 // Load the AndroidManifest.xml
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001636 std::unique_ptr<xml::XmlResource> manifest_xml =
1637 LoadXml(options_.manifest_path, context_->GetDiagnostics());
1638 if (!manifest_xml) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001639 return 1;
1640 }
1641
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001642 // First extract the Package name without modifying it (via --rename-manifest-package).
1643 if (Maybe<AppInfo> maybe_app_info =
1644 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001645 const AppInfo& app_info = maybe_app_info.value();
1646 context_->SetCompilationPackage(app_info.package);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001647 }
1648
Adam Lesinskic6284372017-12-04 13:46:23 -08001649 // Now that the compilation package is set, load the dependencies. This will also extract
1650 // the Android framework's versionCode and versionName, if they exist.
1651 if (!LoadSymbolsFromIncludePaths()) {
1652 return 1;
1653 }
1654
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001655 ManifestFixer manifest_fixer(options_.manifest_fixer_options);
1656 if (!manifest_fixer.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001657 return 1;
1658 }
1659
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001660 Maybe<AppInfo> maybe_app_info =
1661 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001662 if (!maybe_app_info) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001663 return 1;
1664 }
1665
Adam Lesinski490595a2017-11-07 17:08:07 -08001666 app_info_ = maybe_app_info.value();
1667 context_->SetMinSdkVersion(app_info_.min_sdk_version.value_or_default(0));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001668
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001669 context_->SetNameManglerPolicy(NameManglerPolicy{context_->GetCompilationPackage()});
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001670
1671 // Override the package ID when it is "android".
1672 if (context_->GetCompilationPackage() == "android") {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001673 context_->SetPackageId(0x01);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001674
1675 // Verify we're building a regular app.
Adam Lesinskib522f042017-04-21 16:57:59 -07001676 if (context_->GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001677 context_->GetDiagnostics()->Error(
1678 DiagMessage() << "package 'android' can only be built as a regular app");
1679 return 1;
1680 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001681 }
1682
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001683 TableMergerOptions table_merger_options;
1684 table_merger_options.auto_add_overlay = options_.auto_add_overlay;
Izabela Orlowskad51efe82018-04-24 18:18:29 +01001685 table_merger_options.strict_visibility = options_.strict_visibility;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001686 table_merger_ = util::make_unique<TableMerger>(context_, &final_table_, table_merger_options);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001687
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001688 if (context_->IsVerbose()) {
1689 context_->GetDiagnostics()->Note(DiagMessage()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001690 << StringPrintf("linking package '%s' using package ID %02x",
1691 context_->GetCompilationPackage().data(),
1692 context_->GetPackageId()));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001693 }
1694
Adam Lesinski2427dce2017-11-30 15:10:28 -08001695 // Extract symbols from AndroidManifest.xml, since this isn't merged like the other XML files
1696 // in res/**/*.
1697 {
1698 XmlIdCollector collector;
1699 if (!collector.Consume(context_, manifest_xml.get())) {
1700 return false;
1701 }
1702
1703 if (!MergeExportedSymbols(manifest_xml->file.source, manifest_xml->file.exported_symbols)) {
1704 return false;
1705 }
1706 }
1707
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001708 for (const std::string& input : input_files) {
1709 if (!MergePath(input, false)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001710 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing input");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001711 return 1;
1712 }
1713 }
1714
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001715 for (const std::string& input : options_.overlay_files) {
1716 if (!MergePath(input, true)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001717 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing overlays");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001718 return 1;
1719 }
1720 }
1721
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001722 if (!VerifyNoExternalPackages()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001723 return 1;
1724 }
1725
Adam Lesinskib522f042017-04-21 16:57:59 -07001726 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001727 PrivateAttributeMover mover;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001728 if (!mover.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001729 context_->GetDiagnostics()->Error(DiagMessage() << "failed moving private attributes");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001730 return 1;
1731 }
1732
1733 // Assign IDs if we are building a regular app.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001734 IdAssigner id_assigner(&options_.stable_id_map);
1735 if (!id_assigner.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001736 context_->GetDiagnostics()->Error(DiagMessage() << "failed assigning IDs");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001737 return 1;
1738 }
1739
1740 // Now grab each ID and emit it as a file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001741 if (options_.resource_id_map_path) {
1742 for (auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001743 for (auto& type : package->types) {
1744 for (auto& entry : type->entries) {
1745 ResourceName name(package->name, type->type, entry->name);
1746 // The IDs are guaranteed to exist.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001747 options_.stable_id_map[std::move(name)] =
1748 ResourceId(package->id.value(), type->id.value(), entry->id.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001749 }
1750 }
1751 }
1752
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001753 if (!WriteStableIdMapToPath(context_->GetDiagnostics(), options_.stable_id_map,
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001754 options_.resource_id_map_path.value())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001755 return 1;
1756 }
1757 }
1758 } else {
1759 // Static libs are merged with other apps, and ID collisions are bad, so
1760 // verify that
1761 // no IDs have been set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001762 if (!VerifyNoIdsSet()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001763 return 1;
1764 }
1765 }
1766
1767 // Add the names to mangle based on our source merge earlier.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001768 context_->SetNameManglerPolicy(
1769 NameManglerPolicy{context_->GetCompilationPackage(), table_merger_->merged_packages()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001770
1771 // Add our table to the symbol table.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001772 context_->GetExternalSymbols()->PrependSource(
1773 util::make_unique<ResourceTableSymbolSource>(&final_table_));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001774
Adam Lesinski1e4b0e52017-04-27 15:01:10 -07001775 // Workaround for pre-O runtime that would treat negative resource IDs
1776 // (any ID with a package ID > 7f) as invalid. Intercept any ID (PPTTEEEE) with PP > 0x7f
1777 // and type == 'id', and return the ID 0x7fPPEEEE. IDs don't need to be real resources, they
1778 // are just identifiers.
1779 if (context_->GetMinSdkVersion() < SDK_O && context_->GetPackageType() == PackageType::kApp) {
1780 if (context_->IsVerbose()) {
1781 context_->GetDiagnostics()->Note(DiagMessage()
1782 << "enabling pre-O feature split ID rewriting");
1783 }
1784 context_->GetExternalSymbols()->SetDelegate(
1785 util::make_unique<FeatureSplitSymbolTableDelegate>(context_));
1786 }
1787
Adam Lesinski34a16872018-02-23 16:18:10 -08001788 // Before we process anything, remove the resources whose default values don't exist.
1789 // We want to force any references to these to fail the build.
Mårten Kongstadd8d29012018-06-11 14:13:37 +02001790 if (!options_.no_resource_removal) {
1791 if (!NoDefaultResourceRemover{}.Consume(context_, &final_table_)) {
1792 context_->GetDiagnostics()->Error(DiagMessage()
1793 << "failed removing resources with no defaults");
1794 return 1;
1795 }
Adam Lesinski34a16872018-02-23 16:18:10 -08001796 }
1797
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001798 ReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001799 if (!linker.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001800 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking references");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001801 return 1;
1802 }
1803
Adam Lesinskib522f042017-04-21 16:57:59 -07001804 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001805 if (!options_.products.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001806 context_->GetDiagnostics()->Warn(DiagMessage()
1807 << "can't select products when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001808 }
1809 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001810 ProductFilter product_filter(options_.products);
1811 if (!product_filter.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001812 context_->GetDiagnostics()->Error(DiagMessage() << "failed stripping products");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001813 return 1;
1814 }
1815 }
1816
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001817 if (!options_.no_auto_version) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001818 AutoVersioner versioner;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001819 if (!versioner.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001820 context_->GetDiagnostics()->Error(DiagMessage() << "failed versioning styles");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001821 return 1;
1822 }
1823 }
1824
Adam Lesinskib522f042017-04-21 16:57:59 -07001825 if (context_->GetPackageType() != PackageType::kStaticLib && context_->GetMinSdkVersion() > 0) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001826 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001827 context_->GetDiagnostics()->Note(DiagMessage()
1828 << "collapsing resource versions for minimum SDK "
1829 << context_->GetMinSdkVersion());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001830 }
1831
1832 VersionCollapser collapser;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001833 if (!collapser.Consume(context_, &final_table_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001834 return 1;
1835 }
1836 }
1837
Winson3c918b82019-01-25 14:25:37 -08001838 if (!options_.exclude_configs_.empty()) {
1839 std::vector<ConfigDescription> excluded_configs;
1840
1841 for (auto& config_string : options_.exclude_configs_) {
1842 ConfigDescription config_description;
1843
1844 if (!ConfigDescription::Parse(config_string, &config_description)) {
1845 context_->GetDiagnostics()->Error(DiagMessage()
1846 << "failed to parse --excluded-configs "
1847 << config_string);
1848 return 1;
1849 }
1850
1851 excluded_configs.push_back(config_description);
1852 }
1853
1854 ResourceExcluder excluder(excluded_configs);
1855 if (!excluder.Consume(context_, &final_table_)) {
1856 context_->GetDiagnostics()->Error(DiagMessage() << "failed excluding configurations");
1857 return 1;
1858 }
1859 }
1860
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001861 if (!options_.no_resource_deduping) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001862 ResourceDeduper deduper;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001863 if (!deduper.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001864 context_->GetDiagnostics()->Error(DiagMessage() << "failed deduping resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001865 return 1;
1866 }
1867 }
1868
Adam Koskidc21dea2017-07-21 10:55:27 -07001869 proguard::KeepSet proguard_keep_set =
1870 proguard::KeepSet(options_.generate_conditional_proguard_rules);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001871 proguard::KeepSet proguard_main_dex_keep_set;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001872
Adam Lesinskib522f042017-04-21 16:57:59 -07001873 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001874 if (options_.table_splitter_options.config_filter != nullptr ||
Pierre Lecesne672384b2017-02-06 10:29:02 +00001875 !options_.table_splitter_options.preferred_densities.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001876 context_->GetDiagnostics()->Warn(DiagMessage()
1877 << "can't strip resources when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001878 }
1879 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001880 // Adjust the SplitConstraints so that their SDK version is stripped if it is less than or
1881 // equal to the minSdk.
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001882 const size_t origConstraintSize = options_.split_constraints.size();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001883 options_.split_constraints =
1884 AdjustSplitConstraintsForMinSdk(context_->GetMinSdkVersion(), options_.split_constraints);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001885
Todd Kennedy9fbdf892018-08-28 16:31:15 -07001886 if (origConstraintSize != options_.split_constraints.size()) {
1887 context_->GetDiagnostics()->Warn(DiagMessage()
1888 << "requested to split resources prior to min sdk of "
1889 << context_->GetMinSdkVersion());
1890 }
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001891 TableSplitter table_splitter(options_.split_constraints, options_.table_splitter_options);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001892 if (!table_splitter.VerifySplitConstraints(context_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001893 return 1;
1894 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001895 table_splitter.SplitTable(&final_table_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001896
1897 // Now we need to write out the Split APKs.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001898 auto path_iter = options_.split_paths.begin();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001899 auto split_constraints_iter = options_.split_constraints.begin();
1900 for (std::unique_ptr<ResourceTable>& split_table : table_splitter.splits()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001901 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001902 context_->GetDiagnostics()->Note(DiagMessage(*path_iter)
1903 << "generating split with configurations '"
1904 << util::Joiner(split_constraints_iter->configs, ", ")
1905 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001906 }
1907
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001908 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(*path_iter);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001909 if (!archive_writer) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001910 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001911 return 1;
1912 }
1913
1914 // Generate an AndroidManifest.xml for each split.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001915 std::unique_ptr<xml::XmlResource> split_manifest =
Adam Lesinski490595a2017-11-07 17:08:07 -08001916 GenerateSplitManifest(app_info_, *split_constraints_iter);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001917
1918 XmlReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001919 if (!linker.Consume(context_, split_manifest.get())) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001920 context_->GetDiagnostics()->Error(DiagMessage()
1921 << "failed to create Split AndroidManifest.xml");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001922 return 1;
1923 }
1924
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001925 if (!WriteApk(archive_writer.get(), &proguard_keep_set, split_manifest.get(),
1926 split_table.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001927 return 1;
1928 }
1929
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001930 ++path_iter;
1931 ++split_constraints_iter;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001932 }
1933 }
1934
1935 // Start writing the base APK.
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001936 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(options_.output_path);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001937 if (!archive_writer) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001938 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001939 return 1;
1940 }
1941
1942 bool error = false;
1943 {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001944 // AndroidManifest.xml has no resource name, but the CallSite is built from the name
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001945 // (aka, which package the AndroidManifest.xml is coming from).
1946 // So we give it a package name so it can see local resources.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001947 manifest_xml->file.name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001948
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001949 XmlReferenceLinker manifest_linker;
1950 if (manifest_linker.Consume(context_, manifest_xml.get())) {
1951 if (options_.generate_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001952 !proguard::CollectProguardRulesForManifest(manifest_xml.get(), &proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001953 error = true;
1954 }
1955
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001956 if (options_.generate_main_dex_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001957 !proguard::CollectProguardRulesForManifest(manifest_xml.get(),
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001958 &proguard_main_dex_keep_set, true)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001959 error = true;
Alexandria Cornwall637b4822016-08-11 09:53:16 -07001960 }
1961
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001962 if (options_.generate_java_class_path) {
1963 if (!WriteManifestJavaFile(manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001964 error = true;
1965 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001966 }
1967
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001968 if (options_.no_xml_namespaces) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001969 // PackageParser will fail if URIs are removed from
1970 // AndroidManifest.xml.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001971 XmlNamespaceRemover namespace_remover(true /* keepUris */);
1972 if (!namespace_remover.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001973 error = true;
1974 }
Rohit Agrawale49bb302016-04-22 12:27:55 -07001975 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001976 } else {
1977 error = true;
1978 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001979 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001980
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001981 if (error) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001982 context_->GetDiagnostics()->Error(DiagMessage() << "failed processing manifest");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001983 return 1;
1984 }
Adam Lesinskia6fe3452015-12-09 15:20:52 -08001985
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001986 if (!WriteApk(archive_writer.get(), &proguard_keep_set, manifest_xml.get(), &final_table_)) {
1987 return 1;
1988 }
1989
1990 if (!CopyAssetsDirsToApk(archive_writer.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001991 return 1;
1992 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001993
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001994 if (options_.generate_java_class_path || options_.generate_text_symbols_path) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001995 if (!GenerateJavaClasses()) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001996 return 1;
1997 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001998 }
1999
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08002000 if (!WriteProguardFile(options_.generate_proguard_rules_path, proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002001 return 1;
2002 }
2003
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002004 if (!WriteProguardFile(options_.generate_main_dex_proguard_rules_path,
2005 proguard_main_dex_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002006 return 1;
2007 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002008 return 0;
2009 }
2010
2011 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002012 LinkOptions options_;
2013 LinkContext* context_;
2014 ResourceTable final_table_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002015
Adam Lesinski490595a2017-11-07 17:08:07 -08002016 AppInfo app_info_;
2017
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002018 std::unique_ptr<TableMerger> table_merger_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002019
2020 // A pointer to the FileCollection representing the filesystem (not archives).
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002021 std::unique_ptr<io::FileCollection> file_collection_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002022
Adam Lesinski8780eb62017-10-31 17:44:39 -07002023 // A vector of IFileCollections. This is mainly here to retain ownership of the
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002024 // collections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002025 std::vector<std::unique_ptr<io::IFileCollection>> collections_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002026
Adam Lesinski8780eb62017-10-31 17:44:39 -07002027 // The set of merged APKs. This is mainly here to retain ownership of the APKs.
2028 std::vector<std::unique_ptr<LoadedApk>> merged_apks_;
2029
2030 // The set of included APKs (not merged). This is mainly here to retain ownership of the APKs.
2031 std::vector<std::unique_ptr<LoadedApk>> static_library_includes_;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08002032
2033 // The set of shared libraries being used, mapping their assigned package ID to package name.
2034 std::map<size_t, std::string> shared_libs_;
Adam Lesinski490595a2017-11-07 17:08:07 -08002035
2036 // The package name of the base application, if it is included.
2037 Maybe<std::string> included_feature_base_;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002038};
2039
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002040int LinkCommand::Action(const std::vector<std::string>& args) {
2041 LinkContext context(diag_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002042
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002043 // Expand all argument-files passed into the command line. These start with '@'.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002044 std::vector<std::string> arg_list;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002045 for (const std::string& arg : args) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002046 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002047 const std::string path = arg.substr(1, arg.size() - 1);
2048 std::string error;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002049 if (!file::AppendArgsFromFile(path, &arg_list, &error)) {
2050 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002051 return 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002052 }
2053 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002054 arg_list.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002055 }
2056 }
2057
2058 // Expand all argument-files passed to -R.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002059 for (const std::string& arg : overlay_arg_list_) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002060 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002061 const std::string path = arg.substr(1, arg.size() - 1);
2062 std::string error;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002063 if (!file::AppendArgsFromFile(path, &options_.overlay_files, &error)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002064 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002065 return 1;
2066 }
2067 } else {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002068 options_.overlay_files.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002069 }
2070 }
2071
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002072 if (verbose_) {
2073 context.SetVerbose(verbose_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002074 }
2075
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002076 if (int{shared_lib_} + int{static_lib_} + int{proto_format_} > 1) {
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002077 context.GetDiagnostics()->Error(
2078 DiagMessage()
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002079 << "only one of --shared-lib, --static-lib, or --proto_format can be defined");
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002080 return 1;
2081 }
2082
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002083 // The default build type.
2084 context.SetPackageType(PackageType::kApp);
2085 context.SetPackageId(kAppPackageId);
2086
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002087 if (shared_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002088 context.SetPackageType(PackageType::kSharedLib);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002089 context.SetPackageId(0x00);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002090 } else if (static_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002091 context.SetPackageType(PackageType::kStaticLib);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002092 options_.output_format = OutputFormat::kProto;
2093 } else if (proto_format_) {
2094 options_.output_format = OutputFormat::kProto;
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002095 }
2096
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002097 if (package_id_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002098 if (context.GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002099 context.GetDiagnostics()->Error(
2100 DiagMessage() << "can't specify --package-id when not building a regular app");
2101 return 1;
2102 }
2103
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002104 const Maybe<uint32_t> maybe_package_id_int = ResourceUtils::ParseInt(package_id_.value());
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002105 if (!maybe_package_id_int) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002106 context.GetDiagnostics()->Error(DiagMessage() << "package ID '" << package_id_.value()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002107 << "' is not a valid integer");
2108 return 1;
2109 }
2110
2111 const uint32_t package_id_int = maybe_package_id_int.value();
Todd Kennedy32512992018-04-25 16:45:59 -07002112 if (package_id_int > std::numeric_limits<uint8_t>::max()
2113 || package_id_int == kFrameworkPackageId
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002114 || (!options_.allow_reserved_package_id && package_id_int < kAppPackageId)) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002115 context.GetDiagnostics()->Error(
2116 DiagMessage() << StringPrintf(
2117 "invalid package ID 0x%02x. Must be in the range 0x7f-0xff.", package_id_int));
2118 return 1;
2119 }
2120 context.SetPackageId(static_cast<uint8_t>(package_id_int));
2121 }
2122
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002123 // Populate the set of extra packages for which to generate R.java.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002124 for (std::string& extra_package : extra_java_packages_) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002125 // A given package can actually be a colon separated list of packages.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002126 for (StringPiece package : util::Split(extra_package, ':')) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002127 options_.extra_java_packages.insert(package.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002128 }
2129 }
2130
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002131 if (product_list_) {
2132 for (StringPiece product : util::Tokenize(product_list_.value(), ',')) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002133 if (product != "" && product != "default") {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002134 options_.products.insert(product.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002135 }
2136 }
2137 }
2138
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002139 std::unique_ptr<IConfigFilter> filter;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002140 if (!configs_.empty()) {
2141 filter = ParseConfigFilterParameters(configs_, context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002142 if (filter == nullptr) {
2143 return 1;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002144 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002145 options_.table_splitter_options.config_filter = filter.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002146 }
2147
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002148 if (preferred_density_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002149 Maybe<uint16_t> density =
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002150 ParseTargetDensityParameter(preferred_density_.value(), context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002151 if (!density) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002152 return 1;
Adam Lesinskic51562c2016-04-28 11:12:38 -07002153 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002154 options_.table_splitter_options.preferred_densities.push_back(density.value());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002155 }
Adam Lesinskic51562c2016-04-28 11:12:38 -07002156
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002157 // Parse the split parameters.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002158 for (const std::string& split_arg : split_args_) {
2159 options_.split_paths.push_back({});
2160 options_.split_constraints.push_back({});
2161 if (!ParseSplitParameter(split_arg, context.GetDiagnostics(), &options_.split_paths.back(),
2162 &options_.split_constraints.back())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002163 return 1;
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002164 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002165 }
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002166
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002167 if (context.GetPackageType() != PackageType::kStaticLib && stable_id_file_path_) {
2168 if (!LoadStableIdMap(context.GetDiagnostics(), stable_id_file_path_.value(),
2169 &options_.stable_id_map)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002170 return 1;
Adam Lesinski64587af2016-02-18 18:33:06 -08002171 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002172 }
Adam Lesinski64587af2016-02-18 18:33:06 -08002173
Izabela Orlowska0faba5f2018-06-01 12:06:31 +01002174 if (no_compress_regex) {
2175 std::string regex = no_compress_regex.value();
2176 if (util::StartsWith(regex, "@")) {
2177 const std::string path = regex.substr(1, regex.size() -1);
2178 std::string error;
2179 if (!file::AppendSetArgsFromFile(path, &options_.extensions_to_not_compress, &error)) {
2180 context.GetDiagnostics()->Error(DiagMessage(path) << error);
2181 return 1;
2182 }
2183 } else {
2184 options_.regex_to_not_compress = GetRegularExpression(no_compress_regex.value());
2185 }
2186 }
2187
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002188 // Populate some default no-compress extensions that are already compressed.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002189 options_.extensions_to_not_compress.insert(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002190 {".jpg", ".jpeg", ".png", ".gif", ".wav", ".mp2", ".mp3", ".ogg",
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002191 ".aac", ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet", ".rtttl",
2192 ".imy", ".xmf", ".mp4", ".m4a", ".m4v", ".3gp", ".3gpp", ".3g2",
2193 ".3gpp2", ".amr", ".awb", ".wma", ".wmv", ".webm", ".mkv"});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002194
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002195 // Turn off auto versioning for static-libs.
Adam Lesinskib522f042017-04-21 16:57:59 -07002196 if (context.GetPackageType() == PackageType::kStaticLib) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002197 options_.no_auto_version = true;
2198 options_.no_version_vectors = true;
2199 options_.no_version_transitions = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002200 }
Adam Lesinskie4bb9eb2016-02-12 22:18:51 -08002201
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002202 Linker cmd(&context, options_);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002203 return cmd.Run(arg_list);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002204}
2205
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002206} // namespace aapt