blob: 26770d1f281c02c636b788caf4f72a85bed2b93d [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"
Adam Lesinskid5083f62017-01-16 15:07:21 -080030#include "androidfw/StringPiece.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070031
Adam Lesinski1ab598f2015-08-14 14:26:04 -070032#include "AppInfo.h"
33#include "Debug.h"
Adam Lesinski8780eb62017-10-31 17:44:39 -070034#include "LoadedApk.h"
Adam Lesinski6a008172016-02-02 17:02:58 -080035#include "Locale.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"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070062#include "link/TableMerger.h"
Adam Lesinskic744ae82017-05-17 19:28:38 -070063#include "link/XmlCompatVersioner.h"
Adam Lesinskid48944a2017-02-21 14:22:30 -080064#include "optimize/ResourceDeduper.h"
65#include "optimize/VersionCollapser.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070066#include "process/IResourceTableConsumer.h"
67#include "process/SymbolTable.h"
Adam Lesinski355f2852016-02-13 20:26:45 -080068#include "split/TableSplitter.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070069#include "util/Files.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080070#include "xml/XmlDom.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070071
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070072using ::aapt::io::FileInputStream;
73using ::android::StringPiece;
74using ::android::base::StringPrintf;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070075
Adam Lesinski1ab598f2015-08-14 14:26:04 -070076namespace aapt {
77
Adam Lesinski64587af2016-02-18 18:33:06 -080078class LinkContext : public IAaptContext {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070079 public:
Chris Warrington820d72a2017-04-27 15:27:01 +010080 LinkContext(IDiagnostics* diagnostics)
81 : diagnostics_(diagnostics), name_mangler_({}), symbols_(&name_mangler_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -070082 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070083
Adam Lesinskib522f042017-04-21 16:57:59 -070084 PackageType GetPackageType() override {
85 return package_type_;
86 }
87
88 void SetPackageType(PackageType type) {
89 package_type_ = type;
90 }
91
Adam Lesinskid0f492d2017-04-03 18:12:45 -070092 IDiagnostics* GetDiagnostics() override {
Chris Warrington820d72a2017-04-27 15:27:01 +010093 return diagnostics_;
Adam Lesinskid0f492d2017-04-03 18:12:45 -070094 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070095
Adam Lesinskid0f492d2017-04-03 18:12:45 -070096 NameMangler* GetNameMangler() override {
97 return &name_mangler_;
98 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070099
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700100 void SetNameManglerPolicy(const NameManglerPolicy& policy) {
101 name_mangler_ = NameMangler(policy);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700102 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800103
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700104 const std::string& GetCompilationPackage() override {
105 return compilation_package_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700106 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700107
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700108 void SetCompilationPackage(const StringPiece& package_name) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800109 compilation_package_ = package_name.to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700110 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800111
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700112 uint8_t GetPackageId() override {
113 return package_id_;
114 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700115
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700116 void SetPackageId(uint8_t id) {
117 package_id_ = id;
118 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800119
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700120 SymbolTable* GetExternalSymbols() override {
121 return &symbols_;
122 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800123
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700124 bool IsVerbose() override {
125 return verbose_;
126 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800127
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700128 void SetVerbose(bool val) {
129 verbose_ = val;
130 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800131
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700132 int GetMinSdkVersion() override {
133 return min_sdk_version_;
134 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700135
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700136 void SetMinSdkVersion(int minSdk) {
137 min_sdk_version_ = minSdk;
138 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700139
Chris Warrington481f0272018-02-06 14:03:39 +0000140 bool IsAutoNamespace() override {
141 return auto_namespace_;
142 }
143
144 void SetAutoNamespace(bool val) {
145 auto_namespace_ = val;
146 }
147
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700148 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700149 DISALLOW_COPY_AND_ASSIGN(LinkContext);
150
Adam Lesinskib522f042017-04-21 16:57:59 -0700151 PackageType package_type_ = PackageType::kApp;
Chris Warrington820d72a2017-04-27 15:27:01 +0100152 IDiagnostics* diagnostics_;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700153 NameMangler name_mangler_;
154 std::string compilation_package_;
155 uint8_t package_id_ = 0x0;
156 SymbolTable symbols_;
157 bool verbose_ = false;
158 int min_sdk_version_ = 0;
Chris Warrington481f0272018-02-06 14:03:39 +0000159 bool auto_namespace_ = false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700160};
161
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700162// A custom delegate that generates compatible pre-O IDs for use with feature splits.
163// Feature splits use package IDs > 7f, which in Java (since Java doesn't have unsigned ints)
164// is interpreted as a negative number. Some verification was wrongly assuming negative values
165// were invalid.
166//
167// This delegate will attempt to masquerade any '@id/' references with ID 0xPPTTEEEE,
168// where PP > 7f, as 0x7fPPEEEE. Any potential overlapping is verified and an error occurs if such
169// an overlap exists.
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800170//
171// See b/37498913.
Adam Lesinski1e4b0e52017-04-27 15:01:10 -0700172class FeatureSplitSymbolTableDelegate : public DefaultSymbolTableDelegate {
173 public:
174 FeatureSplitSymbolTableDelegate(IAaptContext* context) : context_(context) {
175 }
176
177 virtual ~FeatureSplitSymbolTableDelegate() = default;
178
179 virtual std::unique_ptr<SymbolTable::Symbol> FindByName(
180 const ResourceName& name,
181 const std::vector<std::unique_ptr<ISymbolSource>>& sources) override {
182 std::unique_ptr<SymbolTable::Symbol> symbol =
183 DefaultSymbolTableDelegate::FindByName(name, sources);
184 if (symbol == nullptr) {
185 return {};
186 }
187
188 // Check to see if this is an 'id' with the target package.
189 if (name.type == ResourceType::kId && symbol->id) {
190 ResourceId* id = &symbol->id.value();
191 if (id->package_id() > kAppPackageId) {
192 // Rewrite the resource ID to be compatible pre-O.
193 ResourceId rewritten_id(kAppPackageId, id->package_id(), id->entry_id());
194
195 // Check that this doesn't overlap another resource.
196 if (DefaultSymbolTableDelegate::FindById(rewritten_id, sources) != nullptr) {
197 // The ID overlaps, so log a message (since this is a weird failure) and fail.
198 context_->GetDiagnostics()->Error(DiagMessage() << "Failed to rewrite " << name
199 << " for pre-O feature split support");
200 return {};
201 }
202
203 if (context_->IsVerbose()) {
204 context_->GetDiagnostics()->Note(DiagMessage() << "rewriting " << name << " (" << *id
205 << ") -> (" << rewritten_id << ")");
206 }
207
208 *id = rewritten_id;
209 }
210 }
211 return symbol;
212 }
213
214 private:
215 DISALLOW_COPY_AND_ASSIGN(FeatureSplitSymbolTableDelegate);
216
217 IAaptContext* context_;
218};
219
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700220static bool FlattenXml(IAaptContext* context, const xml::XmlResource& xml_res,
221 const StringPiece& path, bool keep_raw_values, bool utf16,
222 OutputFormat format, IArchiveWriter* writer) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700223 if (context->IsVerbose()) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700224 context->GetDiagnostics()->Note(DiagMessage(path) << "writing to archive (keep_raw_values="
225 << (keep_raw_values ? "true" : "false")
226 << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700227 }
228
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700229 switch (format) {
230 case OutputFormat::kApk: {
231 BigBuffer buffer(1024);
232 XmlFlattenerOptions options = {};
233 options.keep_raw_values = keep_raw_values;
234 options.use_utf16 = utf16;
235 XmlFlattener flattener(&buffer, options);
236 if (!flattener.Consume(context, &xml_res)) {
237 return false;
238 }
239
240 io::BigBufferInputStream input_stream(&buffer);
241 return io::CopyInputStreamToArchive(context, &input_stream, path.to_string(),
242 ArchiveEntry::kCompress, writer);
243 } break;
244
245 case OutputFormat::kProto: {
246 pb::XmlNode pb_node;
247 SerializeXmlResourceToPb(xml_res, &pb_node);
248 return io::CopyProtoToArchive(context, &pb_node, path.to_string(), ArchiveEntry::kCompress,
249 writer);
250 } break;
251 }
252 return false;
Adam Lesinski355f2852016-02-13 20:26:45 -0800253}
254
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700255// Inflates an XML file from the source path.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700256static std::unique_ptr<xml::XmlResource> LoadXml(const std::string& path, IDiagnostics* diag) {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700257 FileInputStream fin(path);
258 if (fin.HadError()) {
259 diag->Error(DiagMessage(path) << "failed to load XML file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700260 return {};
261 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700262 return xml::Inflate(&fin, diag, Source(path));
Adam Lesinski355f2852016-02-13 20:26:45 -0800263}
264
Adam Lesinski355f2852016-02-13 20:26:45 -0800265struct ResourceFileFlattenerOptions {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700266 bool no_auto_version = false;
267 bool no_version_vectors = false;
Yuichi Araki4d35cca2017-01-18 20:42:17 +0900268 bool no_version_transitions = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700269 bool no_xml_namespaces = false;
270 bool keep_raw_values = false;
271 bool do_not_compress_anything = false;
272 bool update_proguard_spec = false;
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700273 OutputFormat output_format = OutputFormat::kApk;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700274 std::unordered_set<std::string> extensions_to_not_compress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800275};
276
Adam Lesinskic744ae82017-05-17 19:28:38 -0700277// A sampling of public framework resource IDs.
278struct R {
279 struct attr {
280 enum : uint32_t {
281 paddingLeft = 0x010100d6u,
282 paddingRight = 0x010100d8u,
283 paddingHorizontal = 0x0101053du,
284
285 paddingTop = 0x010100d7u,
286 paddingBottom = 0x010100d9u,
287 paddingVertical = 0x0101053eu,
288
289 layout_marginLeft = 0x010100f7u,
290 layout_marginRight = 0x010100f9u,
291 layout_marginHorizontal = 0x0101053bu,
292
293 layout_marginTop = 0x010100f8u,
294 layout_marginBottom = 0x010100fau,
295 layout_marginVertical = 0x0101053cu,
296 };
297 };
298};
299
Adam Lesinski355f2852016-02-13 20:26:45 -0800300class ResourceFileFlattener {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700301 public:
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700302 ResourceFileFlattener(const ResourceFileFlattenerOptions& options, IAaptContext* context,
Adam Lesinskic744ae82017-05-17 19:28:38 -0700303 proguard::KeepSet* keep_set);
Adam Lesinski355f2852016-02-13 20:26:45 -0800304
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700305 bool Flatten(ResourceTable* table, IArchiveWriter* archive_writer);
Adam Lesinski355f2852016-02-13 20:26:45 -0800306
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700307 private:
308 struct FileOperation {
309 ConfigDescription config;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700310
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700311 // The entry this file came from.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700312 ResourceEntry* entry;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700313
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700314 // The file to copy as-is.
Adam Lesinskibb94f322017-07-12 07:41:55 -0700315 io::IFile* file_to_copy;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700316
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700317 // The XML to process and flatten.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700318 std::unique_ptr<xml::XmlResource> xml_to_flatten;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700319
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700320 // The destination to write this file to.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700321 std::string dst_path;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700322 };
Adam Lesinski355f2852016-02-13 20:26:45 -0800323
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700324 uint32_t GetCompressionFlags(const StringPiece& str);
Adam Lesinski355f2852016-02-13 20:26:45 -0800325
Adam Lesinskic744ae82017-05-17 19:28:38 -0700326 std::vector<std::unique_ptr<xml::XmlResource>> LinkAndVersionXmlFile(ResourceTable* table,
327 FileOperation* file_op);
Adam Lesinski355f2852016-02-13 20:26:45 -0800328
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700329 ResourceFileFlattenerOptions options_;
330 IAaptContext* context_;
331 proguard::KeepSet* keep_set_;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700332 XmlCompatVersioner::Rules rules_;
Adam Lesinski355f2852016-02-13 20:26:45 -0800333};
334
Adam Lesinskic744ae82017-05-17 19:28:38 -0700335ResourceFileFlattener::ResourceFileFlattener(const ResourceFileFlattenerOptions& options,
336 IAaptContext* context, proguard::KeepSet* keep_set)
337 : options_(options), context_(context), keep_set_(keep_set) {
338 SymbolTable* symm = context_->GetExternalSymbols();
339
340 // Build up the rules for degrading newer attributes to older ones.
341 // NOTE(adamlesinski): These rules are hardcoded right now, but they should be
342 // generated from the attribute definitions themselves (b/62028956).
343 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingHorizontal)) {
344 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800345 {"paddingLeft", R::attr::paddingLeft, Attribute(android::ResTable_map::TYPE_DIMENSION)},
346 {"paddingRight", R::attr::paddingRight, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700347 };
348 rules_[R::attr::paddingHorizontal] =
349 util::make_unique<DegradeToManyRule>(std::move(replacements));
350 }
351
352 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::paddingVertical)) {
353 std::vector<ReplacementAttr> replacements{
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800354 {"paddingTop", R::attr::paddingTop, Attribute(android::ResTable_map::TYPE_DIMENSION)},
355 {"paddingBottom", R::attr::paddingBottom, Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700356 };
357 rules_[R::attr::paddingVertical] =
358 util::make_unique<DegradeToManyRule>(std::move(replacements));
359 }
360
361 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginHorizontal)) {
362 std::vector<ReplacementAttr> replacements{
363 {"layout_marginLeft", R::attr::layout_marginLeft,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800364 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700365 {"layout_marginRight", R::attr::layout_marginRight,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800366 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700367 };
368 rules_[R::attr::layout_marginHorizontal] =
369 util::make_unique<DegradeToManyRule>(std::move(replacements));
370 }
371
372 if (const SymbolTable::Symbol* s = symm->FindById(R::attr::layout_marginVertical)) {
373 std::vector<ReplacementAttr> replacements{
374 {"layout_marginTop", R::attr::layout_marginTop,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800375 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700376 {"layout_marginBottom", R::attr::layout_marginBottom,
Adam Lesinski73bff1e2017-12-08 16:06:10 -0800377 Attribute(android::ResTable_map::TYPE_DIMENSION)},
Adam Lesinskic744ae82017-05-17 19:28:38 -0700378 };
379 rules_[R::attr::layout_marginVertical] =
380 util::make_unique<DegradeToManyRule>(std::move(replacements));
381 }
382}
383
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700384uint32_t ResourceFileFlattener::GetCompressionFlags(const StringPiece& str) {
385 if (options_.do_not_compress_anything) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700386 return 0;
387 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800388
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700389 for (const std::string& extension : options_.extensions_to_not_compress) {
390 if (util::EndsWith(str, extension)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700391 return 0;
Adam Lesinski355f2852016-02-13 20:26:45 -0800392 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700393 }
394 return ArchiveEntry::kCompress;
Adam Lesinski355f2852016-02-13 20:26:45 -0800395}
396
Adam Lesinskibb94f322017-07-12 07:41:55 -0700397static bool IsTransitionElement(const std::string& name) {
398 return name == "fade" || name == "changeBounds" || name == "slide" || name == "explode" ||
399 name == "changeImageTransform" || name == "changeTransform" ||
400 name == "changeClipBounds" || name == "autoTransition" || name == "recolor" ||
401 name == "changeScroll" || name == "transitionSet" || name == "transition" ||
402 name == "transitionManager";
403}
404
405static bool IsVectorElement(const std::string& name) {
406 return name == "vector" || name == "animated-vector" || name == "pathInterpolator" ||
Nick Butchere78a8162018-01-09 15:24:21 +0000407 name == "objectAnimator" || name == "gradient" || name == "animated-selector";
Adam Lesinskibb94f322017-07-12 07:41:55 -0700408}
409
Adam Lesinskic744ae82017-05-17 19:28:38 -0700410template <typename T>
411std::vector<T> make_singleton_vec(T&& val) {
412 std::vector<T> vec;
413 vec.emplace_back(std::forward<T>(val));
414 return vec;
415}
416
417std::vector<std::unique_ptr<xml::XmlResource>> ResourceFileFlattener::LinkAndVersionXmlFile(
418 ResourceTable* table, FileOperation* file_op) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700419 xml::XmlResource* doc = file_op->xml_to_flatten.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700420 const Source& src = doc->file.source;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700421
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700422 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700423 context_->GetDiagnostics()->Note(DiagMessage()
424 << "linking " << src.path << " (" << doc->file.name << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700425 }
426
Adam Lesinski00451162017-10-03 07:44:08 -0700427 // First, strip out any tools namespace attributes. AAPT stripped them out early, which means
428 // that existing projects have out-of-date references which pass compilation.
429 xml::StripAndroidStudioAttributes(doc->root.get());
430
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700431 XmlReferenceLinker xml_linker;
432 if (!xml_linker.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700433 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700434 }
435
Ryan Mitchell9a2f6e62018-05-23 14:23:18 -0700436 if (options_.update_proguard_spec && !proguard::CollectProguardRules(context_, doc, keep_set_)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700437 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700438 }
439
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700440 if (options_.no_xml_namespaces) {
441 XmlNamespaceRemover namespace_remover;
442 if (!namespace_remover.Consume(context_, doc)) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700443 return {};
Adam Lesinski355f2852016-02-13 20:26:45 -0800444 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700445 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800446
Adam Lesinskibb94f322017-07-12 07:41:55 -0700447 if (options_.no_auto_version) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700448 return make_singleton_vec(std::move(file_op->xml_to_flatten));
449 }
Alexandria Cornwalla7cc3f12016-08-16 13:33:32 -0700450
Adam Lesinskibb94f322017-07-12 07:41:55 -0700451 if (options_.no_version_vectors || options_.no_version_transitions) {
452 // Skip this if it is a vector or animated-vector.
Adam Lesinski6b372992017-08-09 10:54:23 -0700453 xml::Element* el = doc->root.get();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700454 if (el && el->namespace_uri.empty()) {
455 if ((options_.no_version_vectors && IsVectorElement(el->name)) ||
456 (options_.no_version_transitions && IsTransitionElement(el->name))) {
457 return make_singleton_vec(std::move(file_op->xml_to_flatten));
458 }
459 }
460 }
461
Adam Lesinskic744ae82017-05-17 19:28:38 -0700462 const ConfigDescription& config = file_op->config;
463 ResourceEntry* entry = file_op->entry;
464
465 XmlCompatVersioner xml_compat_versioner(&rules_);
466 const util::Range<ApiVersion> api_range{config.sdkVersion,
467 FindNextApiVersionForConfig(entry, config)};
468 return xml_compat_versioner.Process(context_, doc, api_range);
Adam Lesinski355f2852016-02-13 20:26:45 -0800469}
470
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800471ResourceFile::Type XmlFileTypeForOutputFormat(OutputFormat format) {
472 switch (format) {
473 case OutputFormat::kApk:
474 return ResourceFile::Type::kBinaryXml;
475 case OutputFormat::kProto:
476 return ResourceFile::Type::kProtoXml;
477 }
478 LOG_ALWAYS_FATAL("unreachable");
479 return ResourceFile::Type::kUnknown;
480}
481
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700482bool ResourceFileFlattener::Flatten(ResourceTable* table, IArchiveWriter* archive_writer) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700483 bool error = false;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700484 std::map<std::pair<ConfigDescription, StringPiece>, FileOperation> config_sorted_files;
Adam Lesinski355f2852016-02-13 20:26:45 -0800485
Adam Koskidc21dea2017-07-21 10:55:27 -0700486 proguard::CollectResourceReferences(context_, table, keep_set_);
487
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700488 for (auto& pkg : table->packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700489 CHECK(!pkg->name.empty()) << "Packages must have names when being linked";
490
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700491 for (auto& type : pkg->types) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700492 // Sort by config and name, so that we get better locality in the zip file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700493 config_sorted_files.clear();
Adam Lesinskibb94f322017-07-12 07:41:55 -0700494 std::queue<FileOperation> file_operations;
Adam Lesinski355f2852016-02-13 20:26:45 -0800495
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700496 // Populate the queue with all files in the ResourceTable.
497 for (auto& entry : type->entries) {
Adam Lesinskibb94f322017-07-12 07:41:55 -0700498 for (auto& config_value : entry->values) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700499 // WARNING! Do not insert or remove any resources while executing in this scope. It will
500 // corrupt the iteration order.
501
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700502 FileReference* file_ref = ValueCast<FileReference>(config_value->value.get());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700503 if (!file_ref) {
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700504 continue;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700505 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700506
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700507 io::IFile* file = file_ref->file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700508 if (!file) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700509 context_->GetDiagnostics()->Error(DiagMessage(file_ref->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700510 << "file not found");
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700511 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700512 }
513
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700514 FileOperation file_op;
515 file_op.entry = entry.get();
516 file_op.dst_path = *file_ref->path;
517 file_op.config = config_value->config;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700518 file_op.file_to_copy = file;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700519
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700520 if (type->type != ResourceType::kRaw &&
Adam Lesinski00451162017-10-03 07:44:08 -0700521 (file_ref->type == ResourceFile::Type::kBinaryXml ||
522 file_ref->type == ResourceFile::Type::kProtoXml)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700523 std::unique_ptr<io::IData> data = file->OpenAsData();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700524 if (!data) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700525 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700526 << "failed to open file");
527 return false;
528 }
529
Adam Lesinski00451162017-10-03 07:44:08 -0700530 if (file_ref->type == ResourceFile::Type::kProtoXml) {
531 pb::XmlNode pb_xml_node;
532 if (!pb_xml_node.ParseFromArray(data->data(), static_cast<int>(data->size()))) {
533 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700534 << "failed to parse proto XML");
Adam Lesinski00451162017-10-03 07:44:08 -0700535 return false;
536 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700537
Adam Lesinski00451162017-10-03 07:44:08 -0700538 std::string error;
539 file_op.xml_to_flatten = DeserializeXmlResourceFromPb(pb_xml_node, &error);
540 if (file_op.xml_to_flatten == nullptr) {
541 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
Adam Lesinski8780eb62017-10-31 17:44:39 -0700542 << "failed to deserialize proto XML: " << error);
Adam Lesinski00451162017-10-03 07:44:08 -0700543 return false;
544 }
545 } else {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700546 std::string error_str;
547 file_op.xml_to_flatten = xml::Inflate(data->data(), data->size(), &error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700548 if (file_op.xml_to_flatten == nullptr) {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700549 context_->GetDiagnostics()->Error(DiagMessage(file->GetSource())
550 << "failed to parse binary XML: " << error_str);
Adam Lesinski00451162017-10-03 07:44:08 -0700551 return false;
552 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700553 }
554
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800555 // Update the type that this file will be written as.
556 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
557
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700558 file_op.xml_to_flatten->file.config = config_value->config;
559 file_op.xml_to_flatten->file.source = file_ref->GetSource();
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700560 file_op.xml_to_flatten->file.name = ResourceName(pkg->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700561 }
Adam Lesinskic744ae82017-05-17 19:28:38 -0700562
563 // NOTE(adamlesinski): Explicitly construct a StringPiece here, or
564 // else we end up copying the string in the std::make_pair() method,
565 // then creating a StringPiece from the copy, which would cause us
566 // to end up referencing garbage in the map.
567 const StringPiece entry_name(entry->name);
568 config_sorted_files[std::make_pair(config_value->config, entry_name)] =
569 std::move(file_op);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700570 }
571 }
572
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700573 // Now flatten the sorted values.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700574 for (auto& map_entry : config_sorted_files) {
575 const ConfigDescription& config = map_entry.first.first;
Adam Lesinskic744ae82017-05-17 19:28:38 -0700576 FileOperation& file_op = map_entry.second;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700577
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700578 if (file_op.xml_to_flatten) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700579 std::vector<std::unique_ptr<xml::XmlResource>> versioned_docs =
580 LinkAndVersionXmlFile(table, &file_op);
Adam Lesinskic0a5e1e2017-08-07 11:56:32 -0700581 if (versioned_docs.empty()) {
582 error = true;
583 continue;
584 }
585
Adam Lesinskic744ae82017-05-17 19:28:38 -0700586 for (std::unique_ptr<xml::XmlResource>& doc : versioned_docs) {
587 std::string dst_path = file_op.dst_path;
588 if (doc->file.config != file_op.config) {
589 // Only add the new versioned configurations.
590 if (context_->IsVerbose()) {
591 context_->GetDiagnostics()->Note(DiagMessage(doc->file.source)
592 << "auto-versioning resource from config '"
593 << config << "' -> '" << doc->file.config << "'");
594 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700595
Adam Lesinskia65bbdf2018-02-15 12:39:44 -0800596 const ResourceFile& file = doc->file;
597 dst_path = ResourceUtils::BuildResourceFileName(file, context_->GetNameMangler());
598
599 std::unique_ptr<FileReference> file_ref =
600 util::make_unique<FileReference>(table->string_pool.MakeRef(dst_path));
601 file_ref->SetSource(doc->file.source);
602 // Update the output format of this XML file.
603 file_ref->type = XmlFileTypeForOutputFormat(options_.output_format);
604 if (!table->AddResourceMangled(file.name, file.config, {}, std::move(file_ref),
605 context_->GetDiagnostics())) {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700606 return false;
607 }
608 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -0700609
610 error |= !FlattenXml(context_, *doc, dst_path, options_.keep_raw_values,
611 false /*utf16*/, options_.output_format, archive_writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700612 }
613 } else {
Adam Lesinskic744ae82017-05-17 19:28:38 -0700614 error |= !io::CopyFileToArchive(context_, file_op.file_to_copy, file_op.dst_path,
615 GetCompressionFlags(file_op.dst_path), archive_writer);
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700616 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700617 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700618 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700619 }
620 return !error;
621}
622
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700623static bool WriteStableIdMapToPath(IDiagnostics* diag,
624 const std::unordered_map<ResourceName, ResourceId>& id_map,
625 const std::string& id_map_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800626 io::FileOutputStream fout(id_map_path);
627 if (fout.HadError()) {
628 diag->Error(DiagMessage(id_map_path) << "failed to open: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700629 return false;
630 }
631
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800632 text::Printer printer(&fout);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700633 for (const auto& entry : id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700634 const ResourceName& name = entry.first;
635 const ResourceId& id = entry.second;
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800636 printer.Print(name.to_string());
637 printer.Print(" = ");
638 printer.Println(id.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700639 }
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800640 fout.Flush();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700641
Adam Lesinskia693c4a2017-11-09 11:29:39 -0800642 if (fout.HadError()) {
643 diag->Error(DiagMessage(id_map_path) << "failed writing to file: " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700644 return false;
645 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700646 return true;
647}
648
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700649static bool LoadStableIdMap(IDiagnostics* diag, const std::string& path,
650 std::unordered_map<ResourceName, ResourceId>* out_id_map) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700651 std::string content;
Adam Lesinski2354b562017-05-26 16:31:38 -0700652 if (!android::base::ReadFileToString(path, &content, true /*follow_symlinks*/)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700653 diag->Error(DiagMessage(path) << "failed reading stable ID file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700654 return false;
655 }
656
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700657 out_id_map->clear();
658 size_t line_no = 0;
659 for (StringPiece line : util::Tokenize(content, '\n')) {
660 line_no++;
661 line = util::TrimWhitespace(line);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700662 if (line.empty()) {
663 continue;
664 }
665
666 auto iter = std::find(line.begin(), line.end(), '=');
667 if (iter == line.end()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700668 diag->Error(DiagMessage(Source(path, line_no)) << "missing '='");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700669 return false;
670 }
671
672 ResourceNameRef name;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700673 StringPiece res_name_str =
674 util::TrimWhitespace(line.substr(0, std::distance(line.begin(), iter)));
675 if (!ResourceUtils::ParseResourceName(res_name_str, &name)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700676 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource name '" << res_name_str
677 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700678 return false;
679 }
680
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700681 const size_t res_id_start_idx = std::distance(line.begin(), iter) + 1;
682 const size_t res_id_str_len = line.size() - res_id_start_idx;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700683 StringPiece res_id_str = util::TrimWhitespace(line.substr(res_id_start_idx, res_id_str_len));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700684
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700685 Maybe<ResourceId> maybe_id = ResourceUtils::ParseResourceId(res_id_str);
686 if (!maybe_id) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700687 diag->Error(DiagMessage(Source(path, line_no)) << "invalid resource ID '" << res_id_str
688 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700689 return false;
690 }
691
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700692 (*out_id_map)[name.ToResourceName()] = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700693 }
694 return true;
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700695}
696
Adam Lesinskic6284372017-12-04 13:46:23 -0800697static int32_t FindFrameworkAssetManagerCookie(const android::AssetManager& assets) {
698 using namespace android;
699
700 // Find the system package (0x01). AAPT always generates attributes with the type 0x01, so
701 // we're looking for the first attribute resource in the system package.
702 const ResTable& table = assets.getResources(true);
703 Res_value val;
704 ssize_t idx = table.getResource(0x01010000, &val, true);
705 if (idx != NO_ERROR) {
706 // Try as a bag.
707 const ResTable::bag_entry* entry;
708 ssize_t cnt = table.lockBag(0x01010000, &entry);
709 if (cnt >= 0) {
710 idx = entry->stringBlock;
711 }
712 table.unlockBag(entry);
713 }
714
715 if (idx < 0) {
716 return 0;
717 }
718 return table.getTableCookie(idx);
719}
720
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700721class Linker {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700722 public:
Ryan Mitchell833a1a62018-07-10 13:51:36 -0700723 Linker(LinkContext* context, const LinkOptions& options)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700724 : options_(options),
725 context_(context),
726 final_table_(),
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700727 file_collection_(util::make_unique<io::FileCollection>()) {
728 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700729
Adam Lesinskic6284372017-12-04 13:46:23 -0800730 void ExtractCompileSdkVersions(android::AssetManager* assets) {
731 using namespace android;
732
733 int32_t cookie = FindFrameworkAssetManagerCookie(*assets);
734 if (cookie == 0) {
735 // No Framework assets loaded. Not a failure.
736 return;
737 }
738
739 std::unique_ptr<Asset> manifest(
740 assets->openNonAsset(cookie, kAndroidManifestPath, Asset::AccessMode::ACCESS_BUFFER));
741 if (manifest == nullptr) {
742 // No errors.
743 return;
744 }
745
746 std::string error;
747 std::unique_ptr<xml::XmlResource> manifest_xml =
748 xml::Inflate(manifest->getBuffer(true /*wordAligned*/), manifest->getLength(), &error);
749 if (manifest_xml == nullptr) {
750 // No errors.
751 return;
752 }
753
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700754 if (!options_.manifest_fixer_options.compile_sdk_version) {
755 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionCode");
756 if (attr != nullptr) {
757 Maybe<std::string>& compile_sdk_version = options_.manifest_fixer_options.compile_sdk_version;
758 if (BinaryPrimitive* prim = ValueCast<BinaryPrimitive>(attr->compiled_value.get())) {
759 switch (prim->value.dataType) {
760 case Res_value::TYPE_INT_DEC:
761 compile_sdk_version = StringPrintf("%" PRId32, static_cast<int32_t>(prim->value.data));
762 break;
763 case Res_value::TYPE_INT_HEX:
764 compile_sdk_version = StringPrintf("%" PRIx32, prim->value.data);
765 break;
766 default:
767 break;
768 }
769 } else if (String* str = ValueCast<String>(attr->compiled_value.get())) {
770 compile_sdk_version = *str->value;
771 } else {
772 compile_sdk_version = attr->value;
Adam Lesinskic6284372017-12-04 13:46:23 -0800773 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800774 }
775 }
776
Todd Kennedy9f6dec12018-04-20 12:29:29 -0700777 if (!options_.manifest_fixer_options.compile_sdk_version_codename) {
778 xml::Attribute* attr = manifest_xml->root->FindAttribute(xml::kSchemaAndroid, "versionName");
779 if (attr != nullptr) {
780 Maybe<std::string>& compile_sdk_version_codename =
781 options_.manifest_fixer_options.compile_sdk_version_codename;
782 if (String* str = ValueCast<String>(attr->compiled_value.get())) {
783 compile_sdk_version_codename = *str->value;
784 } else {
785 compile_sdk_version_codename = attr->value;
786 }
Adam Lesinskic6284372017-12-04 13:46:23 -0800787 }
788 }
789 }
790
Adam Lesinski8780eb62017-10-31 17:44:39 -0700791 // Creates a SymbolTable that loads symbols from the various APKs.
Adam Lesinskic6284372017-12-04 13:46:23 -0800792 // Pre-condition: context_->GetCompilationPackage() needs to be set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700793 bool LoadSymbolsFromIncludePaths() {
Adam Lesinski8780eb62017-10-31 17:44:39 -0700794 auto asset_source = util::make_unique<AssetManagerSymbolSource>();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700795 for (const std::string& path : options_.include_paths) {
796 if (context_->IsVerbose()) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700797 context_->GetDiagnostics()->Note(DiagMessage() << "including " << path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700798 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700799
Adam Lesinski8780eb62017-10-31 17:44:39 -0700800 std::string error;
801 auto zip_collection = io::ZipFileCollection::Create(path, &error);
802 if (zip_collection == nullptr) {
803 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open APK: " << error);
804 return false;
805 }
806
807 if (zip_collection->FindFile(kProtoResourceTablePath) != nullptr) {
808 // Load this as a static library include.
809 std::unique_ptr<LoadedApk> static_apk = LoadedApk::LoadProtoApkFromFileCollection(
810 Source(path), std::move(zip_collection), context_->GetDiagnostics());
811 if (static_apk == nullptr) {
812 return false;
813 }
814
Adam Lesinskib522f042017-04-21 16:57:59 -0700815 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800816 // Can't include static libraries when not building a static library (they have no IDs
817 // assigned).
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700818 context_->GetDiagnostics()->Error(
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800819 DiagMessage(path) << "can't include static library when not building a static lib");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700820 return false;
821 }
822
Adam Lesinski8780eb62017-10-31 17:44:39 -0700823 ResourceTable* table = static_apk->GetResourceTable();
824
825 // If we are using --no-static-lib-packages, we need to rename the package of this table to
826 // our compilation package.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700827 if (options_.no_static_lib_packages) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800828 // Since package names can differ, and multiple packages can exist in a ResourceTable,
829 // we place the requirement that all static libraries are built with the package
830 // ID 0x7f. So if one is not found, this is an error.
Adam Lesinski8780eb62017-10-31 17:44:39 -0700831 if (ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700832 pkg->name = context_->GetCompilationPackage();
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800833 } else {
834 context_->GetDiagnostics()->Error(DiagMessage(path)
835 << "no package with ID 0x7f found in static library");
836 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700837 }
838 }
839
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700840 context_->GetExternalSymbols()->AppendSource(
Adam Lesinski8780eb62017-10-31 17:44:39 -0700841 util::make_unique<ResourceTableSymbolSource>(table));
842 static_library_includes_.push_back(std::move(static_apk));
843 } else {
844 if (!asset_source->AddAssetPath(path)) {
845 context_->GetDiagnostics()->Error(DiagMessage()
846 << "failed to load include path " << path);
847 return false;
848 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700849 }
850 }
851
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800852 // Capture the shared libraries so that the final resource table can be properly flattened
853 // with support for shared libraries.
854 for (auto& entry : asset_source->GetAssignedPackageIds()) {
Todd Kennedy32512992018-04-25 16:45:59 -0700855 if (entry.first == kAppPackageId) {
Adam Lesinski490595a2017-11-07 17:08:07 -0800856 // Capture the included base feature package.
857 included_feature_base_ = entry.second;
Adam Lesinskic6284372017-12-04 13:46:23 -0800858 } else if (entry.first == kFrameworkPackageId) {
859 // Try to embed which version of the framework we're compiling against.
860 // First check if we should use compileSdkVersion at all. Otherwise compilation may fail
861 // when linking our synthesized 'android:compileSdkVersion' attribute.
862 std::unique_ptr<SymbolTable::Symbol> symbol = asset_source->FindByName(
863 ResourceName("android", ResourceType::kAttr, "compileSdkVersion"));
864 if (symbol != nullptr && symbol->is_public) {
865 // The symbol is present and public, extract the android:versionName and
866 // android:versionCode from the framework AndroidManifest.xml.
867 ExtractCompileSdkVersions(asset_source->GetAssetManager());
868 }
Todd Kennedy32512992018-04-25 16:45:59 -0700869 } else if (asset_source->IsPackageDynamic(entry.first)) {
870 final_table_.included_packages_[entry.first] = entry.second;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800871 }
872 }
873
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700874 context_->GetExternalSymbols()->AppendSource(std::move(asset_source));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700875 return true;
876 }
877
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800878 Maybe<AppInfo> ExtractAppInfoFromManifest(xml::XmlResource* xml_res, IDiagnostics* diag) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700879 // Make sure the first element is <manifest> with package attribute.
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800880 xml::Element* manifest_el = xml::FindRootElement(xml_res->root.get());
881 if (manifest_el == nullptr) {
882 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700883 }
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800884
885 AppInfo app_info;
886
887 if (!manifest_el->namespace_uri.empty() || manifest_el->name != "manifest") {
888 diag->Error(DiagMessage(xml_res->file.source) << "root tag must be <manifest>");
889 return {};
890 }
891
892 xml::Attribute* package_attr = manifest_el->FindAttribute({}, "package");
893 if (!package_attr) {
894 diag->Error(DiagMessage(xml_res->file.source)
895 << "<manifest> must have a 'package' attribute");
896 return {};
897 }
898 app_info.package = package_attr->value;
899
900 if (xml::Attribute* version_code_attr =
901 manifest_el->FindAttribute(xml::kSchemaAndroid, "versionCode")) {
902 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(version_code_attr->value);
903 if (!maybe_code) {
904 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
905 << "invalid android:versionCode '" << version_code_attr->value << "'");
906 return {};
907 }
908 app_info.version_code = maybe_code.value();
909 }
910
911 if (xml::Attribute* revision_code_attr =
912 manifest_el->FindAttribute(xml::kSchemaAndroid, "revisionCode")) {
913 Maybe<uint32_t> maybe_code = ResourceUtils::ParseInt(revision_code_attr->value);
914 if (!maybe_code) {
915 diag->Error(DiagMessage(xml_res->file.source.WithLine(manifest_el->line_number))
916 << "invalid android:revisionCode '" << revision_code_attr->value << "'");
917 return {};
918 }
919 app_info.revision_code = maybe_code.value();
920 }
921
922 if (xml::Attribute* split_name_attr = manifest_el->FindAttribute({}, "split")) {
923 if (!split_name_attr->value.empty()) {
924 app_info.split_name = split_name_attr->value;
925 }
926 }
927
928 if (xml::Element* uses_sdk_el = manifest_el->FindChild({}, "uses-sdk")) {
929 if (xml::Attribute* min_sdk =
930 uses_sdk_el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion")) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700931 app_info.min_sdk_version = ResourceUtils::ParseSdkVersion(min_sdk->value);
Adam Lesinskib0c47ef2017-03-06 20:05:57 -0800932 }
933 }
934 return app_info;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700935 }
936
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700937 // Precondition: ResourceTable doesn't have any IDs assigned yet, nor is it linked.
938 // Postcondition: ResourceTable has only one package left. All others are
939 // stripped, or there is an error and false is returned.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700940 bool VerifyNoExternalPackages() {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700941 auto is_ext_package_func = [&](const std::unique_ptr<ResourceTablePackage>& pkg) -> bool {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700942 return context_->GetCompilationPackage() != pkg->name || !pkg->id ||
943 pkg->id.value() != context_->GetPackageId();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700944 };
945
946 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700947 for (const auto& package : final_table_.packages) {
948 if (is_ext_package_func(package)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700949 // We have a package that is not related to the one we're building!
950 for (const auto& type : package->types) {
951 for (const auto& entry : type->entries) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700952 ResourceNameRef res_name(package->name, type->type, entry->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700953
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700954 for (const auto& config_value : entry->values) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700955 // Special case the occurrence of an ID that is being generated
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700956 // for the 'android' package. This is due to legacy reasons.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700957 if (ValueCast<Id>(config_value->value.get()) && package->name == "android") {
958 context_->GetDiagnostics()->Warn(DiagMessage(config_value->value->GetSource())
959 << "generated id '" << res_name
960 << "' for external package '" << package->name
961 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700962 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700963 context_->GetDiagnostics()->Error(DiagMessage(config_value->value->GetSource())
964 << "defined resource '" << res_name
965 << "' for external package '" << package->name
966 << "'");
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700967 error = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700968 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700969 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700970 }
971 }
972 }
973 }
974
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700975 auto new_end_iter = std::remove_if(final_table_.packages.begin(), final_table_.packages.end(),
976 is_ext_package_func);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700977 final_table_.packages.erase(new_end_iter, final_table_.packages.end());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700978 return !error;
979 }
980
981 /**
982 * Returns true if no IDs have been set, false otherwise.
983 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700984 bool VerifyNoIdsSet() {
985 for (const auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700986 for (const auto& type : package->types) {
987 if (type->id) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800988 context_->GetDiagnostics()->Error(DiagMessage() << "type " << type->type << " has ID "
989 << StringPrintf("%02x", type->id.value())
990 << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700991 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700992 }
993
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700994 for (const auto& entry : type->entries) {
995 if (entry->id) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700996 ResourceNameRef res_name(package->name, type->type, entry->name);
997 context_->GetDiagnostics()->Error(
Adam Lesinskif34b6f42017-03-03 16:33:26 -0800998 DiagMessage() << "entry " << res_name << " has ID "
999 << StringPrintf("%02x", entry->id.value()) << " assigned");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001000 return false;
1001 }
1002 }
1003 }
1004 }
1005 return true;
1006 }
1007
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001008 std::unique_ptr<IArchiveWriter> MakeArchiveWriter(const StringPiece& out) {
1009 if (options_.output_to_directory) {
1010 return CreateDirectoryArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001011 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001012 return CreateZipFileArchiveWriter(context_->GetDiagnostics(), out);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001013 }
1014 }
1015
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001016 bool FlattenTable(ResourceTable* table, OutputFormat format, IArchiveWriter* writer) {
1017 switch (format) {
1018 case OutputFormat::kApk: {
1019 BigBuffer buffer(1024);
1020 TableFlattener flattener(options_.table_flattener_options, &buffer);
1021 if (!flattener.Consume(context_, table)) {
1022 context_->GetDiagnostics()->Error(DiagMessage() << "failed to flatten resource table");
1023 return false;
1024 }
1025
1026 io::BigBufferInputStream input_stream(&buffer);
1027 return io::CopyInputStreamToArchive(context_, &input_stream, kApkResourceTablePath,
1028 ArchiveEntry::kAlign, writer);
1029 } break;
1030
1031 case OutputFormat::kProto: {
1032 pb::ResourceTable pb_table;
Ryan Mitchella15c2a82018-03-26 11:05:31 -07001033 SerializeTableToPb(*table, &pb_table, context_->GetDiagnostics());
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001034 return io::CopyProtoToArchive(context_, &pb_table, kProtoResourceTablePath,
1035 ArchiveEntry::kCompress, writer);
1036 } break;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001037 }
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001038 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001039 }
1040
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001041 bool WriteJavaFile(ResourceTable* table, const StringPiece& package_name_to_generate,
Adam Lesinski418763f2017-04-11 17:36:53 -07001042 const StringPiece& out_package, const JavaClassGeneratorOptions& java_options,
Chih-Hung Hsieh4dc58122017-08-03 16:28:10 -07001043 const Maybe<std::string>& out_text_symbols_path = {}) {
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001044 if (!options_.generate_java_class_path && !out_text_symbols_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001045 return true;
1046 }
1047
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001048 std::string out_path;
1049 std::unique_ptr<io::FileOutputStream> fout;
1050 if (options_.generate_java_class_path) {
1051 out_path = options_.generate_java_class_path.value();
1052 file::AppendPath(&out_path, file::PackageToPath(out_package));
1053 if (!file::mkdirs(out_path)) {
1054 context_->GetDiagnostics()->Error(DiagMessage()
1055 << "failed to create directory '" << out_path << "'");
1056 return false;
1057 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001058
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001059 file::AppendPath(&out_path, "R.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001060
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001061 fout = util::make_unique<io::FileOutputStream>(out_path);
1062 if (fout->HadError()) {
1063 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1064 << "': " << fout->GetError());
1065 return false;
1066 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001067 }
1068
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001069 std::unique_ptr<io::FileOutputStream> fout_text;
Adam Lesinski418763f2017-04-11 17:36:53 -07001070 if (out_text_symbols_path) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001071 fout_text = util::make_unique<io::FileOutputStream>(out_text_symbols_path.value());
1072 if (fout_text->HadError()) {
1073 context_->GetDiagnostics()->Error(DiagMessage()
1074 << "failed writing to '" << out_text_symbols_path.value()
1075 << "': " << fout_text->GetError());
Adam Lesinski418763f2017-04-11 17:36:53 -07001076 return false;
1077 }
1078 }
1079
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001080 JavaClassGenerator generator(context_, table, java_options);
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001081 if (!generator.Generate(package_name_to_generate, out_package, fout.get(), fout_text.get())) {
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001082 context_->GetDiagnostics()->Error(DiagMessage(out_path) << generator.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001083 return false;
1084 }
1085
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001086 return true;
1087 }
1088
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001089 bool GenerateJavaClasses() {
1090 // The set of packages whose R class to call in the main classes onResourcesLoaded callback.
1091 std::vector<std::string> packages_to_callback;
1092
1093 JavaClassGeneratorOptions template_options;
1094 template_options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1095 template_options.javadoc_annotations = options_.javadoc_annotations;
1096
1097 if (context_->GetPackageType() == PackageType::kStaticLib || options_.generate_non_final_ids) {
1098 template_options.use_final = false;
1099 }
1100
1101 if (context_->GetPackageType() == PackageType::kSharedLib) {
1102 template_options.use_final = false;
1103 template_options.rewrite_callback_options = OnResourcesLoadedCallbackOptions{};
1104 }
1105
1106 const StringPiece actual_package = context_->GetCompilationPackage();
1107 StringPiece output_package = context_->GetCompilationPackage();
1108 if (options_.custom_java_package) {
1109 // Override the output java package to the custom one.
1110 output_package = options_.custom_java_package.value();
1111 }
1112
1113 // Generate the private symbols if required.
1114 if (options_.private_symbols) {
1115 packages_to_callback.push_back(options_.private_symbols.value());
1116
1117 // If we defined a private symbols package, we only emit Public symbols
1118 // to the original package, and private and public symbols to the private package.
1119 JavaClassGeneratorOptions options = template_options;
1120 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate;
1121 if (!WriteJavaFile(&final_table_, actual_package, options_.private_symbols.value(),
1122 options)) {
1123 return false;
1124 }
1125 }
1126
1127 // Generate copies of the original package R class but with different package names.
1128 // This is to support non-namespaced builds.
1129 for (const std::string& extra_package : options_.extra_java_packages) {
1130 packages_to_callback.push_back(extra_package);
1131
1132 JavaClassGeneratorOptions options = template_options;
1133 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1134 if (!WriteJavaFile(&final_table_, actual_package, extra_package, options)) {
1135 return false;
1136 }
1137 }
1138
1139 // Generate R classes for each package that was merged (static library).
1140 // Use the actual package's resources only.
1141 for (const std::string& package : table_merger_->merged_packages()) {
1142 packages_to_callback.push_back(package);
1143
1144 JavaClassGeneratorOptions options = template_options;
1145 options.types = JavaClassGeneratorOptions::SymbolTypes::kAll;
1146 if (!WriteJavaFile(&final_table_, package, package, options)) {
1147 return false;
1148 }
1149 }
1150
1151 // Generate the main public R class.
1152 JavaClassGeneratorOptions options = template_options;
1153
1154 // Only generate public symbols if we have a private package.
1155 if (options_.private_symbols) {
1156 options.types = JavaClassGeneratorOptions::SymbolTypes::kPublic;
1157 }
1158
1159 if (options.rewrite_callback_options) {
1160 options.rewrite_callback_options.value().packages_to_callback =
1161 std::move(packages_to_callback);
1162 }
1163
1164 if (!WriteJavaFile(&final_table_, actual_package, output_package, options,
1165 options_.generate_text_symbols_path)) {
1166 return false;
1167 }
1168
1169 return true;
1170 }
1171
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001172 bool WriteManifestJavaFile(xml::XmlResource* manifest_xml) {
1173 if (!options_.generate_java_class_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001174 return true;
1175 }
1176
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001177 std::unique_ptr<ClassDefinition> manifest_class =
1178 GenerateManifestClass(context_->GetDiagnostics(), manifest_xml);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001179
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001180 if (!manifest_class) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001181 // Something bad happened, but we already logged it, so exit.
1182 return false;
1183 }
1184
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001185 if (manifest_class->empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001186 // Empty Manifest class, no need to generate it.
1187 return true;
1188 }
1189
1190 // Add any JavaDoc annotations to the generated class.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001191 for (const std::string& annotation : options_.javadoc_annotations) {
1192 std::string proper_annotation = "@";
1193 proper_annotation += annotation;
1194 manifest_class->GetCommentBuilder()->AppendComment(proper_annotation);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001195 }
1196
Adam Lesinski0d81f702017-06-27 15:51:09 -07001197 const std::string package_utf8 =
1198 options_.custom_java_package.value_or_default(context_->GetCompilationPackage());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001199
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001200 std::string out_path = options_.generate_java_class_path.value();
1201 file::AppendPath(&out_path, file::PackageToPath(package_utf8));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001202
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001203 if (!file::mkdirs(out_path)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001204 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create directory '" << out_path
1205 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001206 return false;
1207 }
1208
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001209 file::AppendPath(&out_path, "Manifest.java");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001210
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001211 io::FileOutputStream fout(out_path);
1212 if (fout.HadError()) {
1213 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1214 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001215 return false;
1216 }
1217
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001218 ClassDefinition::WriteJavaFile(manifest_class.get(), package_utf8, true, &fout);
1219 fout.Flush();
1220
1221 if (fout.HadError()) {
1222 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1223 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001224 return false;
1225 }
1226 return true;
1227 }
1228
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001229 bool WriteProguardFile(const Maybe<std::string>& out, const proguard::KeepSet& keep_set) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001230 if (!out) {
1231 return true;
1232 }
1233
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001234 const std::string& out_path = out.value();
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001235 io::FileOutputStream fout(out_path);
1236 if (fout.HadError()) {
1237 context_->GetDiagnostics()->Error(DiagMessage() << "failed to open '" << out_path
1238 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001239 return false;
1240 }
1241
Adam Lesinskia693c4a2017-11-09 11:29:39 -08001242 proguard::WriteKeepSet(keep_set, &fout);
1243 fout.Flush();
1244
1245 if (fout.HadError()) {
1246 context_->GetDiagnostics()->Error(DiagMessage() << "failed writing to '" << out_path
1247 << "': " << fout.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001248 return false;
1249 }
1250 return true;
1251 }
1252
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001253 bool MergeStaticLibrary(const std::string& input, bool override) {
1254 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001255 context_->GetDiagnostics()->Note(DiagMessage() << "merging static library " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001256 }
1257
Adam Lesinski8780eb62017-10-31 17:44:39 -07001258 std::unique_ptr<LoadedApk> apk = LoadedApk::LoadApkFromPath(input, context_->GetDiagnostics());
1259 if (apk == nullptr) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001260 context_->GetDiagnostics()->Error(DiagMessage(input) << "invalid static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001261 return false;
1262 }
1263
Adam Lesinski8780eb62017-10-31 17:44:39 -07001264 ResourceTable* table = apk->GetResourceTable();
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001265 ResourceTablePackage* pkg = table->FindPackageById(kAppPackageId);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001266 if (!pkg) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001267 context_->GetDiagnostics()->Error(DiagMessage(input) << "static library has no package");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001268 return false;
1269 }
1270
1271 bool result;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001272 if (options_.no_static_lib_packages) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001273 // Merge all resources as if they were in the compilation package. This is the old behavior
1274 // of aapt.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001275
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001276 // Add the package to the set of --extra-packages so we emit an R.java for each library
1277 // package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001278 if (!pkg->name.empty()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001279 options_.extra_java_packages.insert(pkg->name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001280 }
1281
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001282 // Clear the package name, so as to make the resources look like they are coming from the
1283 // local package.
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001284 pkg->name = "";
Adam Lesinski8780eb62017-10-31 17:44:39 -07001285 result = table_merger_->Merge(Source(input), table, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001286
1287 } else {
1288 // This is the proper way to merge libraries, where the package name is
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001289 // preserved and resource names are mangled.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001290 result = table_merger_->MergeAndMangle(Source(input), pkg->name, table);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001291 }
1292
1293 if (!result) {
1294 return false;
1295 }
1296
1297 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinski8780eb62017-10-31 17:44:39 -07001298 merged_apks_.push_back(std::move(apk));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001299 return true;
1300 }
1301
Adam Lesinski2427dce2017-11-30 15:10:28 -08001302 bool MergeExportedSymbols(const Source& source,
1303 const std::vector<SourcedResourceName>& exported_symbols) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001304 // Add the exports of this file to the table.
Adam Lesinski2427dce2017-11-30 15:10:28 -08001305 for (const SourcedResourceName& exported_symbol : exported_symbols) {
Adam Lesinski00451162017-10-03 07:44:08 -07001306 ResourceName res_name = exported_symbol.name;
1307 if (res_name.package.empty()) {
1308 res_name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001309 }
1310
Adam Lesinski00451162017-10-03 07:44:08 -07001311 Maybe<ResourceName> mangled_name = context_->GetNameMangler()->MangleName(res_name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001312 if (mangled_name) {
1313 res_name = mangled_name.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001314 }
1315
1316 std::unique_ptr<Id> id = util::make_unique<Id>();
Adam Lesinski2427dce2017-11-30 15:10:28 -08001317 id->SetSource(source.WithLine(exported_symbol.line));
Adam Lesinski71be7052017-12-12 16:48:07 -08001318 bool result =
1319 final_table_.AddResourceMangled(res_name, ConfigDescription::DefaultConfig(),
1320 std::string(), std::move(id), context_->GetDiagnostics());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001321 if (!result) {
1322 return false;
1323 }
1324 }
1325 return true;
1326 }
1327
Adam Lesinski2427dce2017-11-30 15:10:28 -08001328 bool MergeCompiledFile(const ResourceFile& compiled_file, io::IFile* file, bool override) {
1329 if (context_->IsVerbose()) {
1330 context_->GetDiagnostics()->Note(DiagMessage()
1331 << "merging '" << compiled_file.name
1332 << "' from compiled file " << compiled_file.source);
1333 }
1334
1335 if (!table_merger_->MergeFile(compiled_file, override, file)) {
1336 return false;
1337 }
1338 return MergeExportedSymbols(compiled_file.source, compiled_file.exported_symbols);
1339 }
1340
Adam Lesinski00451162017-10-03 07:44:08 -07001341 // Takes a path to load as a ZIP file and merges the files within into the master ResourceTable.
1342 // If override is true, conflicting resources are allowed to override each other, in order of last
1343 // seen.
1344 // An io::IFileCollection is created from the ZIP file and added to the set of
1345 // io::IFileCollections that are open.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001346 bool MergeArchive(const std::string& input, bool override) {
1347 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001348 context_->GetDiagnostics()->Note(DiagMessage() << "merging archive " << input);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001349 }
1350
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001351 std::string error_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001352 std::unique_ptr<io::ZipFileCollection> collection =
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001353 io::ZipFileCollection::Create(input, &error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001354 if (!collection) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001355 context_->GetDiagnostics()->Error(DiagMessage(input) << error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001356 return false;
1357 }
1358
1359 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001360 for (auto iter = collection->Iterator(); iter->HasNext();) {
1361 if (!MergeFile(iter->Next(), override)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001362 error = true;
1363 }
1364 }
1365
1366 // Make sure to move the collection into the set of IFileCollections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001367 collections_.push_back(std::move(collection));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001368 return !error;
1369 }
1370
Adam Lesinski00451162017-10-03 07:44:08 -07001371 // Takes a path to load and merge into the master ResourceTable. If override is true,
1372 // conflicting resources are allowed to override each other, in order of last seen.
1373 // If the file path ends with .flata, .jar, .jack, or .zip the file is treated
1374 // as ZIP archive and the files within are merged individually.
1375 // Otherwise the file is processed on its own.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001376 bool MergePath(const std::string& path, bool override) {
1377 if (util::EndsWith(path, ".flata") || util::EndsWith(path, ".jar") ||
1378 util::EndsWith(path, ".jack") || util::EndsWith(path, ".zip")) {
1379 return MergeArchive(path, override);
1380 } else if (util::EndsWith(path, ".apk")) {
1381 return MergeStaticLibrary(path, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001382 }
1383
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001384 io::IFile* file = file_collection_->InsertFile(path);
1385 return MergeFile(file, override);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001386 }
1387
Adam Lesinski00451162017-10-03 07:44:08 -07001388 // Takes an AAPT Container file (.apc/.flat) to load and merge into the master ResourceTable.
1389 // If override is true, conflicting resources are allowed to override each other, in order of last
1390 // seen.
1391 // All other file types are ignored. This is because these files could be coming from a zip,
1392 // where we could have other files like classes.dex.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001393 bool MergeFile(io::IFile* file, bool override) {
1394 const Source& src = file->GetSource();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001395
Adam Lesinski00451162017-10-03 07:44:08 -07001396 if (util::EndsWith(src.path, ".xml") || util::EndsWith(src.path, ".png")) {
Adam Lesinski6a396c12016-10-20 14:38:23 -07001397 // Since AAPT compiles these file types and appends .flat to them, seeing
1398 // their raw extensions is a sign that they weren't compiled.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001399 const StringPiece file_type = util::EndsWith(src.path, ".xml") ? "XML" : "PNG";
1400 context_->GetDiagnostics()->Error(DiagMessage(src) << "uncompiled " << file_type
1401 << " file passed as argument. Must be "
1402 "compiled first into .flat file.");
Adam Lesinski6a396c12016-10-20 14:38:23 -07001403 return false;
Adam Lesinski00451162017-10-03 07:44:08 -07001404 } else if (!util::EndsWith(src.path, ".apc") && !util::EndsWith(src.path, ".flat")) {
1405 if (context_->IsVerbose()) {
1406 context_->GetDiagnostics()->Warn(DiagMessage(src) << "ignoring unrecognized file");
1407 return true;
1408 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001409 }
1410
Adam Lesinski00451162017-10-03 07:44:08 -07001411 std::unique_ptr<io::InputStream> input_stream = file->OpenInputStream();
1412 if (input_stream == nullptr) {
1413 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to open file");
1414 return false;
1415 }
1416
1417 if (input_stream->HadError()) {
1418 context_->GetDiagnostics()->Error(DiagMessage(src)
1419 << "failed to open file: " << input_stream->GetError());
1420 return false;
1421 }
1422
1423 ContainerReaderEntry* entry;
1424 ContainerReader reader(input_stream.get());
Mohamed Heikal10844322018-02-07 15:17:38 -05001425
1426 if (reader.HadError()) {
1427 context_->GetDiagnostics()->Error(DiagMessage(src)
1428 << "failed to read file: " << reader.GetError());
1429 return false;
1430 }
1431
Adam Lesinski00451162017-10-03 07:44:08 -07001432 while ((entry = reader.Next()) != nullptr) {
1433 if (entry->Type() == ContainerEntryType::kResTable) {
1434 pb::ResourceTable pb_table;
1435 if (!entry->GetResTable(&pb_table)) {
1436 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to read resource table: "
1437 << entry->GetError());
1438 return false;
1439 }
1440
1441 ResourceTable table;
1442 std::string error;
Adam Lesinski8780eb62017-10-31 17:44:39 -07001443 if (!DeserializeTableFromPb(pb_table, nullptr /*files*/, &table, &error)) {
Adam Lesinski00451162017-10-03 07:44:08 -07001444 context_->GetDiagnostics()->Error(DiagMessage(src)
1445 << "failed to deserialize resource table: " << error);
1446 return false;
1447 }
1448
1449 if (!table_merger_->Merge(src, &table, override)) {
1450 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to merge resource table");
1451 return false;
1452 }
1453 } else if (entry->Type() == ContainerEntryType::kResFile) {
1454 pb::internal::CompiledFile pb_compiled_file;
1455 off64_t offset;
1456 size_t len;
1457 if (!entry->GetResFileOffsets(&pb_compiled_file, &offset, &len)) {
1458 context_->GetDiagnostics()->Error(DiagMessage(src) << "failed to get resource file: "
1459 << entry->GetError());
1460 return false;
1461 }
1462
1463 ResourceFile resource_file;
1464 std::string error;
1465 if (!DeserializeCompiledFileFromPb(pb_compiled_file, &resource_file, &error)) {
1466 context_->GetDiagnostics()->Error(DiagMessage(src)
1467 << "failed to read compiled header: " << error);
1468 return false;
1469 }
1470
1471 if (!MergeCompiledFile(resource_file, file->CreateFileSegment(offset, len), override)) {
1472 return false;
1473 }
1474 }
1475 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001476 return true;
1477 }
1478
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001479 bool CopyAssetsDirsToApk(IArchiveWriter* writer) {
1480 std::map<std::string, std::unique_ptr<io::RegularFile>> merged_assets;
1481 for (const std::string& assets_dir : options_.assets_dirs) {
1482 Maybe<std::vector<std::string>> files =
1483 file::FindFiles(assets_dir, context_->GetDiagnostics(), nullptr);
1484 if (!files) {
1485 return false;
1486 }
1487
1488 for (const std::string& file : files.value()) {
1489 std::string full_key = "assets/" + file;
1490 std::string full_path = assets_dir;
1491 file::AppendPath(&full_path, file);
1492
1493 auto iter = merged_assets.find(full_key);
1494 if (iter == merged_assets.end()) {
1495 merged_assets.emplace(std::move(full_key),
1496 util::make_unique<io::RegularFile>(Source(std::move(full_path))));
1497 } else if (context_->IsVerbose()) {
1498 context_->GetDiagnostics()->Warn(DiagMessage(iter->second->GetSource())
1499 << "asset file overrides '" << full_path << "'");
1500 }
1501 }
1502 }
1503
1504 for (auto& entry : merged_assets) {
1505 uint32_t compression_flags = ArchiveEntry::kCompress;
1506 std::string extension = file::GetExtension(entry.first).to_string();
1507 if (options_.extensions_to_not_compress.count(extension) > 0) {
1508 compression_flags = 0u;
1509 }
1510
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001511 if (!io::CopyFileToArchive(context_, entry.second.get(), entry.first, compression_flags,
1512 writer)) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001513 return false;
1514 }
1515 }
1516 return true;
1517 }
1518
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001519 // Writes the AndroidManifest, ResourceTable, and all XML files referenced by the ResourceTable
1520 // to the IArchiveWriter.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001521 bool WriteApk(IArchiveWriter* writer, proguard::KeepSet* keep_set, xml::XmlResource* manifest,
1522 ResourceTable* table) {
Adam Lesinskib522f042017-04-21 16:57:59 -07001523 const bool keep_raw_values = context_->GetPackageType() == PackageType::kStaticLib;
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001524 bool result = FlattenXml(context_, *manifest, "AndroidManifest.xml", keep_raw_values,
1525 true /*utf16*/, options_.output_format, writer);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001526 if (!result) {
1527 return false;
1528 }
1529
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001530 ResourceFileFlattenerOptions file_flattener_options;
1531 file_flattener_options.keep_raw_values = keep_raw_values;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001532 file_flattener_options.do_not_compress_anything = options_.do_not_compress_anything;
1533 file_flattener_options.extensions_to_not_compress = options_.extensions_to_not_compress;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001534 file_flattener_options.no_auto_version = options_.no_auto_version;
1535 file_flattener_options.no_version_vectors = options_.no_version_vectors;
Yuichi Araki4d35cca2017-01-18 20:42:17 +09001536 file_flattener_options.no_version_transitions = options_.no_version_transitions;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001537 file_flattener_options.no_xml_namespaces = options_.no_xml_namespaces;
1538 file_flattener_options.update_proguard_spec =
1539 static_cast<bool>(options_.generate_proguard_rules_path);
Adam Lesinskie59f0d82017-10-13 09:36:53 -07001540 file_flattener_options.output_format = options_.output_format;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001541
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001542 ResourceFileFlattener file_flattener(file_flattener_options, context_, keep_set);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001543
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001544 if (!file_flattener.Flatten(table, writer)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001545 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking file resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001546 return false;
1547 }
1548
Adam Lesinski490595a2017-11-07 17:08:07 -08001549 // Hack to fix b/68820737.
1550 // We need to modify the ResourceTable's package name, but that should NOT affect
1551 // anything else being generated, which includes the Java classes.
1552 // If required, the package name is modifed before flattening, and then modified back
1553 // to its original name.
1554 ResourceTablePackage* package_to_rewrite = nullptr;
Todd Kennedy32512992018-04-25 16:45:59 -07001555 // Pre-O, the platform treats negative resource IDs [those with a package ID of 0x80
1556 // or higher] as invalid. In order to work around this limitation, we allow the use
1557 // of traditionally reserved resource IDs [those between 0x02 and 0x7E]. Allow the
1558 // definition of what a valid "split" package ID is to account for this.
1559 const bool isSplitPackage = (options_.allow_reserved_package_id &&
1560 context_->GetPackageId() != kAppPackageId &&
1561 context_->GetPackageId() != kFrameworkPackageId)
1562 || (!options_.allow_reserved_package_id && context_->GetPackageId() > kAppPackageId);
1563 if (isSplitPackage &&
Adam Lesinski490595a2017-11-07 17:08:07 -08001564 included_feature_base_ == make_value(context_->GetCompilationPackage())) {
1565 // The base APK is included, and this is a feature split. If the base package is
1566 // the same as this package, then we are building an old style Android Instant Apps feature
1567 // split and must apply this workaround to avoid requiring namespaces support.
1568 package_to_rewrite = table->FindPackage(context_->GetCompilationPackage());
1569 if (package_to_rewrite != nullptr) {
1570 CHECK_EQ(1u, table->packages.size()) << "can't change name of package when > 1 package";
1571
1572 std::string new_package_name =
1573 StringPrintf("%s.%s", package_to_rewrite->name.c_str(),
1574 app_info_.split_name.value_or_default("feature").c_str());
1575
1576 if (context_->IsVerbose()) {
1577 context_->GetDiagnostics()->Note(
1578 DiagMessage() << "rewriting resource package name for feature split to '"
1579 << new_package_name << "'");
1580 }
1581 package_to_rewrite->name = new_package_name;
1582 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001583 }
Adam Lesinski490595a2017-11-07 17:08:07 -08001584
1585 bool success = FlattenTable(table, options_.output_format, writer);
1586
1587 if (package_to_rewrite != nullptr) {
1588 // Change the name back.
1589 package_to_rewrite->name = context_->GetCompilationPackage();
1590 if (package_to_rewrite->id) {
1591 table->included_packages_.erase(package_to_rewrite->id.value());
1592 }
1593 }
1594
1595 if (!success) {
1596 context_->GetDiagnostics()->Error(DiagMessage() << "failed to write resource table");
1597 }
1598 return success;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001599 }
1600
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001601 int Run(const std::vector<std::string>& input_files) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001602 // Load the AndroidManifest.xml
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001603 std::unique_ptr<xml::XmlResource> manifest_xml =
1604 LoadXml(options_.manifest_path, context_->GetDiagnostics());
1605 if (!manifest_xml) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001606 return 1;
1607 }
1608
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001609 // First extract the Package name without modifying it (via --rename-manifest-package).
1610 if (Maybe<AppInfo> maybe_app_info =
1611 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001612 const AppInfo& app_info = maybe_app_info.value();
1613 context_->SetCompilationPackage(app_info.package);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001614 }
1615
Adam Lesinskic6284372017-12-04 13:46:23 -08001616 // Now that the compilation package is set, load the dependencies. This will also extract
1617 // the Android framework's versionCode and versionName, if they exist.
1618 if (!LoadSymbolsFromIncludePaths()) {
1619 return 1;
1620 }
1621
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001622 ManifestFixer manifest_fixer(options_.manifest_fixer_options);
1623 if (!manifest_fixer.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001624 return 1;
1625 }
1626
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001627 Maybe<AppInfo> maybe_app_info =
1628 ExtractAppInfoFromManifest(manifest_xml.get(), context_->GetDiagnostics());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001629 if (!maybe_app_info) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001630 return 1;
1631 }
1632
Adam Lesinski490595a2017-11-07 17:08:07 -08001633 app_info_ = maybe_app_info.value();
1634 context_->SetMinSdkVersion(app_info_.min_sdk_version.value_or_default(0));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001635
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001636 context_->SetNameManglerPolicy(NameManglerPolicy{context_->GetCompilationPackage()});
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001637
1638 // Override the package ID when it is "android".
1639 if (context_->GetCompilationPackage() == "android") {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001640 context_->SetPackageId(0x01);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001641
1642 // Verify we're building a regular app.
Adam Lesinskib522f042017-04-21 16:57:59 -07001643 if (context_->GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001644 context_->GetDiagnostics()->Error(
1645 DiagMessage() << "package 'android' can only be built as a regular app");
1646 return 1;
1647 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001648 }
1649
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001650 TableMergerOptions table_merger_options;
1651 table_merger_options.auto_add_overlay = options_.auto_add_overlay;
Izabela Orlowskad51efe82018-04-24 18:18:29 +01001652 table_merger_options.strict_visibility = options_.strict_visibility;
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001653 table_merger_ = util::make_unique<TableMerger>(context_, &final_table_, table_merger_options);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001654
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001655 if (context_->IsVerbose()) {
1656 context_->GetDiagnostics()->Note(DiagMessage()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08001657 << StringPrintf("linking package '%s' using package ID %02x",
1658 context_->GetCompilationPackage().data(),
1659 context_->GetPackageId()));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001660 }
1661
Adam Lesinski2427dce2017-11-30 15:10:28 -08001662 // Extract symbols from AndroidManifest.xml, since this isn't merged like the other XML files
1663 // in res/**/*.
1664 {
1665 XmlIdCollector collector;
1666 if (!collector.Consume(context_, manifest_xml.get())) {
1667 return false;
1668 }
1669
1670 if (!MergeExportedSymbols(manifest_xml->file.source, manifest_xml->file.exported_symbols)) {
1671 return false;
1672 }
1673 }
1674
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001675 for (const std::string& input : input_files) {
1676 if (!MergePath(input, false)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001677 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing input");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001678 return 1;
1679 }
1680 }
1681
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001682 for (const std::string& input : options_.overlay_files) {
1683 if (!MergePath(input, true)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001684 context_->GetDiagnostics()->Error(DiagMessage() << "failed parsing overlays");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001685 return 1;
1686 }
1687 }
1688
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001689 if (!VerifyNoExternalPackages()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001690 return 1;
1691 }
1692
Adam Lesinskib522f042017-04-21 16:57:59 -07001693 if (context_->GetPackageType() != PackageType::kStaticLib) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001694 PrivateAttributeMover mover;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001695 if (!mover.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001696 context_->GetDiagnostics()->Error(DiagMessage() << "failed moving private attributes");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001697 return 1;
1698 }
1699
1700 // Assign IDs if we are building a regular app.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001701 IdAssigner id_assigner(&options_.stable_id_map);
1702 if (!id_assigner.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001703 context_->GetDiagnostics()->Error(DiagMessage() << "failed assigning IDs");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001704 return 1;
1705 }
1706
1707 // Now grab each ID and emit it as a file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001708 if (options_.resource_id_map_path) {
1709 for (auto& package : final_table_.packages) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001710 for (auto& type : package->types) {
1711 for (auto& entry : type->entries) {
1712 ResourceName name(package->name, type->type, entry->name);
1713 // The IDs are guaranteed to exist.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001714 options_.stable_id_map[std::move(name)] =
1715 ResourceId(package->id.value(), type->id.value(), entry->id.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001716 }
1717 }
1718 }
1719
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001720 if (!WriteStableIdMapToPath(context_->GetDiagnostics(), options_.stable_id_map,
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001721 options_.resource_id_map_path.value())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001722 return 1;
1723 }
1724 }
1725 } else {
1726 // Static libs are merged with other apps, and ID collisions are bad, so
1727 // verify that
1728 // no IDs have been set.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001729 if (!VerifyNoIdsSet()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001730 return 1;
1731 }
1732 }
1733
1734 // Add the names to mangle based on our source merge earlier.
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001735 context_->SetNameManglerPolicy(
1736 NameManglerPolicy{context_->GetCompilationPackage(), table_merger_->merged_packages()});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001737
1738 // Add our table to the symbol table.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001739 context_->GetExternalSymbols()->PrependSource(
1740 util::make_unique<ResourceTableSymbolSource>(&final_table_));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001741
Adam Lesinski1e4b0e52017-04-27 15:01:10 -07001742 // Workaround for pre-O runtime that would treat negative resource IDs
1743 // (any ID with a package ID > 7f) as invalid. Intercept any ID (PPTTEEEE) with PP > 0x7f
1744 // and type == 'id', and return the ID 0x7fPPEEEE. IDs don't need to be real resources, they
1745 // are just identifiers.
1746 if (context_->GetMinSdkVersion() < SDK_O && context_->GetPackageType() == PackageType::kApp) {
1747 if (context_->IsVerbose()) {
1748 context_->GetDiagnostics()->Note(DiagMessage()
1749 << "enabling pre-O feature split ID rewriting");
1750 }
1751 context_->GetExternalSymbols()->SetDelegate(
1752 util::make_unique<FeatureSplitSymbolTableDelegate>(context_));
1753 }
1754
Adam Lesinski34a16872018-02-23 16:18:10 -08001755 // Before we process anything, remove the resources whose default values don't exist.
1756 // We want to force any references to these to fail the build.
1757 if (!NoDefaultResourceRemover{}.Consume(context_, &final_table_)) {
1758 context_->GetDiagnostics()->Error(DiagMessage()
1759 << "failed removing resources with no defaults");
1760 return 1;
1761 }
1762
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001763 ReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001764 if (!linker.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001765 context_->GetDiagnostics()->Error(DiagMessage() << "failed linking references");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001766 return 1;
1767 }
1768
Adam Lesinskib522f042017-04-21 16:57:59 -07001769 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001770 if (!options_.products.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001771 context_->GetDiagnostics()->Warn(DiagMessage()
1772 << "can't select products when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001773 }
1774 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001775 ProductFilter product_filter(options_.products);
1776 if (!product_filter.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001777 context_->GetDiagnostics()->Error(DiagMessage() << "failed stripping products");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001778 return 1;
1779 }
1780 }
1781
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001782 if (!options_.no_auto_version) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001783 AutoVersioner versioner;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001784 if (!versioner.Consume(context_, &final_table_)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001785 context_->GetDiagnostics()->Error(DiagMessage() << "failed versioning styles");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001786 return 1;
1787 }
1788 }
1789
Adam Lesinskib522f042017-04-21 16:57:59 -07001790 if (context_->GetPackageType() != PackageType::kStaticLib && context_->GetMinSdkVersion() > 0) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001791 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001792 context_->GetDiagnostics()->Note(DiagMessage()
1793 << "collapsing resource versions for minimum SDK "
1794 << context_->GetMinSdkVersion());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001795 }
1796
1797 VersionCollapser collapser;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001798 if (!collapser.Consume(context_, &final_table_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001799 return 1;
1800 }
1801 }
1802
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001803 if (!options_.no_resource_deduping) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001804 ResourceDeduper deduper;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001805 if (!deduper.Consume(context_, &final_table_)) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001806 context_->GetDiagnostics()->Error(DiagMessage() << "failed deduping resources");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001807 return 1;
1808 }
1809 }
1810
Adam Koskidc21dea2017-07-21 10:55:27 -07001811 proguard::KeepSet proguard_keep_set =
1812 proguard::KeepSet(options_.generate_conditional_proguard_rules);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001813 proguard::KeepSet proguard_main_dex_keep_set;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001814
Adam Lesinskib522f042017-04-21 16:57:59 -07001815 if (context_->GetPackageType() == PackageType::kStaticLib) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001816 if (options_.table_splitter_options.config_filter != nullptr ||
Pierre Lecesne672384b2017-02-06 10:29:02 +00001817 !options_.table_splitter_options.preferred_densities.empty()) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001818 context_->GetDiagnostics()->Warn(DiagMessage()
1819 << "can't strip resources when building static library");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001820 }
1821 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001822 // Adjust the SplitConstraints so that their SDK version is stripped if it is less than or
1823 // equal to the minSdk.
1824 options_.split_constraints =
1825 AdjustSplitConstraintsForMinSdk(context_->GetMinSdkVersion(), options_.split_constraints);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001826
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001827 TableSplitter table_splitter(options_.split_constraints, options_.table_splitter_options);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001828 if (!table_splitter.VerifySplitConstraints(context_)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001829 return 1;
1830 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001831 table_splitter.SplitTable(&final_table_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001832
1833 // Now we need to write out the Split APKs.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001834 auto path_iter = options_.split_paths.begin();
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001835 auto split_constraints_iter = options_.split_constraints.begin();
1836 for (std::unique_ptr<ResourceTable>& split_table : table_splitter.splits()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001837 if (context_->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001838 context_->GetDiagnostics()->Note(DiagMessage(*path_iter)
1839 << "generating split with configurations '"
1840 << util::Joiner(split_constraints_iter->configs, ", ")
1841 << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001842 }
1843
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001844 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(*path_iter);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001845 if (!archive_writer) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001846 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001847 return 1;
1848 }
1849
1850 // Generate an AndroidManifest.xml for each split.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001851 std::unique_ptr<xml::XmlResource> split_manifest =
Adam Lesinski490595a2017-11-07 17:08:07 -08001852 GenerateSplitManifest(app_info_, *split_constraints_iter);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001853
1854 XmlReferenceLinker linker;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001855 if (!linker.Consume(context_, split_manifest.get())) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001856 context_->GetDiagnostics()->Error(DiagMessage()
1857 << "failed to create Split AndroidManifest.xml");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001858 return 1;
1859 }
1860
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001861 if (!WriteApk(archive_writer.get(), &proguard_keep_set, split_manifest.get(),
1862 split_table.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001863 return 1;
1864 }
1865
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001866 ++path_iter;
1867 ++split_constraints_iter;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001868 }
1869 }
1870
1871 // Start writing the base APK.
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001872 std::unique_ptr<IArchiveWriter> archive_writer = MakeArchiveWriter(options_.output_path);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001873 if (!archive_writer) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001874 context_->GetDiagnostics()->Error(DiagMessage() << "failed to create archive");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001875 return 1;
1876 }
1877
1878 bool error = false;
1879 {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001880 // AndroidManifest.xml has no resource name, but the CallSite is built from the name
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001881 // (aka, which package the AndroidManifest.xml is coming from).
1882 // So we give it a package name so it can see local resources.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001883 manifest_xml->file.name.package = context_->GetCompilationPackage();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001884
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001885 XmlReferenceLinker manifest_linker;
1886 if (manifest_linker.Consume(context_, manifest_xml.get())) {
1887 if (options_.generate_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001888 !proguard::CollectProguardRulesForManifest(manifest_xml.get(), &proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001889 error = true;
1890 }
1891
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001892 if (options_.generate_main_dex_proguard_rules_path &&
Adam Koskidc21dea2017-07-21 10:55:27 -07001893 !proguard::CollectProguardRulesForManifest(manifest_xml.get(),
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001894 &proguard_main_dex_keep_set, true)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001895 error = true;
Alexandria Cornwall637b4822016-08-11 09:53:16 -07001896 }
1897
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001898 if (options_.generate_java_class_path) {
1899 if (!WriteManifestJavaFile(manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001900 error = true;
1901 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001902 }
1903
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001904 if (options_.no_xml_namespaces) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001905 // PackageParser will fail if URIs are removed from
1906 // AndroidManifest.xml.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001907 XmlNamespaceRemover namespace_remover(true /* keepUris */);
1908 if (!namespace_remover.Consume(context_, manifest_xml.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001909 error = true;
1910 }
Rohit Agrawale49bb302016-04-22 12:27:55 -07001911 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001912 } else {
1913 error = true;
1914 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001915 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001916
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001917 if (error) {
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001918 context_->GetDiagnostics()->Error(DiagMessage() << "failed processing manifest");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001919 return 1;
1920 }
Adam Lesinskia6fe3452015-12-09 15:20:52 -08001921
Adam Lesinskib39ad7c2017-03-13 11:40:48 -07001922 if (!WriteApk(archive_writer.get(), &proguard_keep_set, manifest_xml.get(), &final_table_)) {
1923 return 1;
1924 }
1925
1926 if (!CopyAssetsDirsToApk(archive_writer.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001927 return 1;
1928 }
Adam Lesinskifb48d292015-11-07 15:52:13 -08001929
Izabela Orlowska23a6e1e2017-12-05 14:52:07 +00001930 if (options_.generate_java_class_path || options_.generate_text_symbols_path) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001931 if (!GenerateJavaClasses()) {
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001932 return 1;
1933 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001934 }
1935
Adam Lesinskib5dc4bd2017-02-22 19:29:29 -08001936 if (!WriteProguardFile(options_.generate_proguard_rules_path, proguard_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001937 return 1;
1938 }
1939
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001940 if (!WriteProguardFile(options_.generate_main_dex_proguard_rules_path,
1941 proguard_main_dex_keep_set)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001942 return 1;
1943 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001944 return 0;
1945 }
1946
1947 private:
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001948 LinkOptions options_;
1949 LinkContext* context_;
1950 ResourceTable final_table_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001951
Adam Lesinski490595a2017-11-07 17:08:07 -08001952 AppInfo app_info_;
1953
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001954 std::unique_ptr<TableMerger> table_merger_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001955
1956 // A pointer to the FileCollection representing the filesystem (not archives).
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001957 std::unique_ptr<io::FileCollection> file_collection_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001958
Adam Lesinski8780eb62017-10-31 17:44:39 -07001959 // A vector of IFileCollections. This is mainly here to retain ownership of the
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001960 // collections.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001961 std::vector<std::unique_ptr<io::IFileCollection>> collections_;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001962
Adam Lesinski8780eb62017-10-31 17:44:39 -07001963 // The set of merged APKs. This is mainly here to retain ownership of the APKs.
1964 std::vector<std::unique_ptr<LoadedApk>> merged_apks_;
1965
1966 // The set of included APKs (not merged). This is mainly here to retain ownership of the APKs.
1967 std::vector<std::unique_ptr<LoadedApk>> static_library_includes_;
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -08001968
1969 // The set of shared libraries being used, mapping their assigned package ID to package name.
1970 std::map<size_t, std::string> shared_libs_;
Adam Lesinski490595a2017-11-07 17:08:07 -08001971
1972 // The package name of the base application, if it is included.
1973 Maybe<std::string> included_feature_base_;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001974};
1975
Ryan Mitchell833a1a62018-07-10 13:51:36 -07001976int LinkCommand::Action(const std::vector<std::string>& args) {
1977 LinkContext context(diag_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001978
Adam Lesinskid0f492d2017-04-03 18:12:45 -07001979 // Expand all argument-files passed into the command line. These start with '@'.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001980 std::vector<std::string> arg_list;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07001981 for (const std::string& arg : args) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001982 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001983 const std::string path = arg.substr(1, arg.size() - 1);
1984 std::string error;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001985 if (!file::AppendArgsFromFile(path, &arg_list, &error)) {
1986 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001987 return 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001988 }
1989 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001990 arg_list.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001991 }
1992 }
1993
1994 // Expand all argument-files passed to -R.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07001995 for (const std::string& arg : overlay_arg_list_) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001996 if (util::StartsWith(arg, "@")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001997 const std::string path = arg.substr(1, arg.size() - 1);
1998 std::string error;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07001999 if (!file::AppendArgsFromFile(path, &options_.overlay_files, &error)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002000 context.GetDiagnostics()->Error(DiagMessage(path) << error);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002001 return 1;
2002 }
2003 } else {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002004 options_.overlay_files.push_back(arg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002005 }
2006 }
2007
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002008 if (verbose_) {
2009 context.SetVerbose(verbose_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002010 }
2011
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002012 if (int{shared_lib_} + int{static_lib_} + int{proto_format_} > 1) {
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002013 context.GetDiagnostics()->Error(
2014 DiagMessage()
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002015 << "only one of --shared-lib, --static-lib, or --proto_format can be defined");
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002016 return 1;
2017 }
2018
Adam Lesinskie59f0d82017-10-13 09:36:53 -07002019 // The default build type.
2020 context.SetPackageType(PackageType::kApp);
2021 context.SetPackageId(kAppPackageId);
2022
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002023 if (shared_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002024 context.SetPackageType(PackageType::kSharedLib);
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002025 context.SetPackageId(0x00);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002026 } else if (static_lib_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002027 context.SetPackageType(PackageType::kStaticLib);
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002028 options_.output_format = OutputFormat::kProto;
2029 } else if (proto_format_) {
2030 options_.output_format = OutputFormat::kProto;
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002031 }
2032
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002033 if (options_.auto_namespace_static_lib) {
2034 if (!static_lib_) {
Chris Warrington481f0272018-02-06 14:03:39 +00002035 context.GetDiagnostics()->Error(
2036 DiagMessage() << "--auto-namespace-static-lib can only be used with --static-lib");
2037 return 1;
2038 }
2039 context.SetAutoNamespace(true);
2040 }
2041
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002042 if (package_id_) {
Adam Lesinskib522f042017-04-21 16:57:59 -07002043 if (context.GetPackageType() != PackageType::kApp) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002044 context.GetDiagnostics()->Error(
2045 DiagMessage() << "can't specify --package-id when not building a regular app");
2046 return 1;
2047 }
2048
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002049 const Maybe<uint32_t> maybe_package_id_int = ResourceUtils::ParseInt(package_id_.value());
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002050 if (!maybe_package_id_int) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002051 context.GetDiagnostics()->Error(DiagMessage() << "package ID '" << package_id_.value()
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002052 << "' is not a valid integer");
2053 return 1;
2054 }
2055
2056 const uint32_t package_id_int = maybe_package_id_int.value();
Todd Kennedy32512992018-04-25 16:45:59 -07002057 if (package_id_int > std::numeric_limits<uint8_t>::max()
2058 || package_id_int == kFrameworkPackageId
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002059 || (!options_.allow_reserved_package_id && package_id_int < kAppPackageId)) {
Adam Lesinskif34b6f42017-03-03 16:33:26 -08002060 context.GetDiagnostics()->Error(
2061 DiagMessage() << StringPrintf(
2062 "invalid package ID 0x%02x. Must be in the range 0x7f-0xff.", package_id_int));
2063 return 1;
2064 }
2065 context.SetPackageId(static_cast<uint8_t>(package_id_int));
2066 }
2067
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002068 // Populate the set of extra packages for which to generate R.java.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002069 for (std::string& extra_package : extra_java_packages_) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002070 // A given package can actually be a colon separated list of packages.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002071 for (StringPiece package : util::Split(extra_package, ':')) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002072 options_.extra_java_packages.insert(package.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002073 }
2074 }
2075
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002076 if (product_list_) {
2077 for (StringPiece product : util::Tokenize(product_list_.value(), ',')) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002078 if (product != "" && product != "default") {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002079 options_.products.insert(product.to_string());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002080 }
2081 }
2082 }
2083
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002084 std::unique_ptr<IConfigFilter> filter;
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002085 if (!configs_.empty()) {
2086 filter = ParseConfigFilterParameters(configs_, context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002087 if (filter == nullptr) {
2088 return 1;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002089 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002090 options_.table_splitter_options.config_filter = filter.get();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002091 }
2092
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002093 if (preferred_density_) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002094 Maybe<uint16_t> density =
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002095 ParseTargetDensityParameter(preferred_density_.value(), context.GetDiagnostics());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002096 if (!density) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002097 return 1;
Adam Lesinskic51562c2016-04-28 11:12:38 -07002098 }
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002099 options_.table_splitter_options.preferred_densities.push_back(density.value());
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002100 }
Adam Lesinskic51562c2016-04-28 11:12:38 -07002101
Adam Lesinskid0f492d2017-04-03 18:12:45 -07002102 // Parse the split parameters.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002103 for (const std::string& split_arg : split_args_) {
2104 options_.split_paths.push_back({});
2105 options_.split_constraints.push_back({});
2106 if (!ParseSplitParameter(split_arg, context.GetDiagnostics(), &options_.split_paths.back(),
2107 &options_.split_constraints.back())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002108 return 1;
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002109 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002110 }
Adam Lesinski1e21ff02016-06-24 14:57:58 -07002111
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002112 if (context.GetPackageType() != PackageType::kStaticLib && stable_id_file_path_) {
2113 if (!LoadStableIdMap(context.GetDiagnostics(), stable_id_file_path_.value(),
2114 &options_.stable_id_map)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002115 return 1;
Adam Lesinski64587af2016-02-18 18:33:06 -08002116 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002117 }
Adam Lesinski64587af2016-02-18 18:33:06 -08002118
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002119 // Populate some default no-compress extensions that are already compressed.
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002120 options_.extensions_to_not_compress.insert(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002121 {".jpg", ".jpeg", ".png", ".gif", ".wav", ".mp2", ".mp3", ".ogg",
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002122 ".aac", ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet", ".rtttl",
2123 ".imy", ".xmf", ".mp4", ".m4a", ".m4v", ".3gp", ".3gpp", ".3g2",
2124 ".3gpp2", ".amr", ".awb", ".wma", ".wmv", ".webm", ".mkv"});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002125
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002126 // Turn off auto versioning for static-libs.
Adam Lesinskib522f042017-04-21 16:57:59 -07002127 if (context.GetPackageType() == PackageType::kStaticLib) {
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002128 options_.no_auto_version = true;
2129 options_.no_version_vectors = true;
2130 options_.no_version_transitions = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002131 }
Adam Lesinskie4bb9eb2016-02-12 22:18:51 -08002132
Ryan Mitchell833a1a62018-07-10 13:51:36 -07002133 Linker cmd(&context, options_);
Adam Lesinskice5e56e2016-10-21 17:56:45 -07002134 return cmd.Run(arg_list);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07002135}
2136
Adam Lesinskicacb28f2016-10-19 12:18:14 -07002137} // namespace aapt