1 //
2 // Copyright 2006 The Android Open Source Project
3 //
4 // Android Asset Packaging Tool main entry point.
5 //
6 #include "Main.h"
7 #include "Bundle.h"
8
9 #include <utils/Log.h>
10 #include <utils/threads.h>
11 #include <utils/List.h>
12 #include <utils/Errors.h>
13
14 #include <stdlib.h>
15 #include <getopt.h>
16 #include <assert.h>
17
18 using namespace android;
19
20 static const char* gProgName = "aapt";
21
22 /*
23 * When running under Cygwin on Windows, this will convert slash-based
24 * paths into back-slash-based ones. Otherwise the ApptAssets file comparisons
25 * fail later as they use back-slash separators under Windows.
26 *
27 * This operates in-place on the path string.
28 */
convertPath(char * path)29 void convertPath(char *path) {
30 if (path != NULL && OS_PATH_SEPARATOR != '/') {
31 for (; *path; path++) {
32 if (*path == '/') {
33 *path = OS_PATH_SEPARATOR;
34 }
35 }
36 }
37 }
38
39 /*
40 * Print usage info.
41 */
usage(void)42 void usage(void)
43 {
44 fprintf(stderr, "Android Asset Packaging Tool\n\n");
45 fprintf(stderr, "Usage:\n");
46 fprintf(stderr,
47 " %s l[ist] [-v] [-a] file.{zip,jar,apk}\n"
48 " List contents of Zip-compatible archive.\n\n", gProgName);
49 fprintf(stderr,
50 " %s d[ump] [--values] WHAT file.{apk} [asset [asset ...]]\n"
51 " badging Print the label and icon for the app declared in APK.\n"
52 " permissions Print the permissions from the APK.\n"
53 " resources Print the resource table from the APK.\n"
54 " configurations Print the configurations in the APK.\n"
55 " xmltree Print the compiled xmls in the given assets.\n"
56 " xmlstrings Print the strings of the given compiled xml assets.\n\n", gProgName);
57 fprintf(stderr,
58 " %s p[ackage] [-d][-f][-m][-u][-v][-x][-z][-M AndroidManifest.xml] \\\n"
59 " [-0 extension [-0 extension ...]] [-g tolerance] [-j jarfile] \\\n"
60 " [--debug-mode] [--min-sdk-version VAL] [--target-sdk-version VAL] \\\n"
61 " [--app-version VAL] [--app-version-name TEXT] [--custom-package VAL] \\\n"
62 " [--rename-manifest-package PACKAGE] \\\n"
63 " [--rename-instrumentation-target-package PACKAGE] \\\n"
64 " [--utf16] [--auto-add-overlay] \\\n"
65 " [--max-res-version VAL] \\\n"
66 " [-I base-package [-I base-package ...]] \\\n"
67 " [-A asset-source-dir] [-G class-list-file] [-P public-definitions-file] \\\n"
68 " [-S resource-sources [-S resource-sources ...]] \\\n"
69 " [-F apk-file] [-J R-file-dir] \\\n"
70 " [--product product1,product2,...] \\\n"
71 " [-c CONFIGS] [--preferred-configurations CONFIGS] \\\n"
72 " [-o] \\\n"
73 " [raw-files-dir [raw-files-dir] ...]\n"
74 "\n"
75 " Package the android resources. It will read assets and resources that are\n"
76 " supplied with the -M -A -S or raw-files-dir arguments. The -J -P -F and -R\n"
77 " options control which files are output.\n\n"
78 , gProgName);
79 fprintf(stderr,
80 " %s r[emove] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
81 " Delete specified files from Zip-compatible archive.\n\n",
82 gProgName);
83 fprintf(stderr,
84 " %s a[dd] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
85 " Add specified files to Zip-compatible archive.\n\n", gProgName);
86 fprintf(stderr,
87 " %s c[runch] [-v] -S resource-sources ... -C output-folder ...\n"
88 " Do PNG preprocessing and store the results in output folder.\n\n", gProgName);
89 fprintf(stderr,
90 " %s v[ersion]\n"
91 " Print program version.\n\n", gProgName);
92 fprintf(stderr,
93 " Modifiers:\n"
94 " -a print Android-specific data (resources, manifest) when listing\n"
95 " -c specify which configurations to include. The default is all\n"
96 " configurations. The value of the parameter should be a comma\n"
97 " separated list of configuration values. Locales should be specified\n"
98 " as either a language or language-region pair. Some examples:\n"
99 " en\n"
100 " port,en\n"
101 " port,land,en_US\n"
102 " If you put the special locale, zz_ZZ on the list, it will perform\n"
103 " pseudolocalization on the default locale, modifying all of the\n"
104 " strings so you can look for strings that missed the\n"
105 " internationalization process. For example:\n"
106 " port,land,zz_ZZ\n"
107 " -d one or more device assets to include, separated by commas\n"
108 " -f force overwrite of existing files\n"
109 " -g specify a pixel tolerance to force images to grayscale, default 0\n"
110 " -j specify a jar or zip file containing classes to include\n"
111 " -k junk path of file(s) added\n"
112 " -m make package directories under location specified by -J\n"
113 " -o create overlay package (ie only resources; expects <overlay-package> in manifest)\n"
114 #if 0
115 " -p pseudolocalize the default configuration\n"
116 #endif
117 " -u update existing packages (add new, replace older, remove deleted files)\n"
118 " -v verbose output\n"
119 " -x create extending (non-application) resource IDs\n"
120 " -z require localization of resource attributes marked with\n"
121 " localization=\"suggested\"\n"
122 " -A additional directory in which to find raw asset files\n"
123 " -G A file to output proguard options into.\n"
124 " -F specify the apk file to output\n"
125 " -I add an existing package to base include set\n"
126 " -J specify where to output R.java resource constant definitions\n"
127 " -M specify full path to AndroidManifest.xml to include in zip\n"
128 " -P specify where to output public resource definitions\n"
129 " -S directory in which to find resources. Multiple directories will be scanned\n"
130 " and the first match found (left to right) will take precedence.\n"
131 " -0 specifies an additional extension for which such files will not\n"
132 " be stored compressed in the .apk. An empty string means to not\n"
133 " compress any files at all.\n"
134 " --debug-mode\n"
135 " inserts android:debuggable=\"true\" in to the application node of the\n"
136 " manifest, making the application debuggable even on production devices.\n"
137 " --min-sdk-version\n"
138 " inserts android:minSdkVersion in to manifest. If the version is 7 or\n"
139 " higher, the default encoding for resources will be in UTF-8.\n"
140 " --target-sdk-version\n"
141 " inserts android:targetSdkVersion in to manifest.\n"
142 " --max-res-version\n"
143 " ignores versioned resource directories above the given value.\n"
144 " --values\n"
145 " when used with \"dump resources\" also includes resource values.\n"
146 " --version-code\n"
147 " inserts android:versionCode in to manifest.\n"
148 " --version-name\n"
149 " inserts android:versionName in to manifest.\n"
150 " --custom-package\n"
151 " generates R.java into a different package.\n"
152 " --extra-packages\n"
153 " generate R.java for libraries. Separate libraries with ':'.\n"
154 " --generate-dependencies\n"
155 " generate dependency files in the same directories for R.java and resource package\n"
156 " --auto-add-overlay\n"
157 " Automatically add resources that are only in overlays.\n"
158 " --preferred-configurations\n"
159 " Like the -c option for filtering out unneeded configurations, but\n"
160 " only expresses a preference. If there is no resource available with\n"
161 " the preferred configuration then it will not be stripped.\n"
162 " --rename-manifest-package\n"
163 " Rewrite the manifest so that its package name is the package name\n"
164 " given here. Relative class names (for example .Foo) will be\n"
165 " changed to absolute names with the old package so that the code\n"
166 " does not need to change.\n"
167 " --rename-instrumentation-target-package\n"
168 " Rewrite the manifest so that all of its instrumentation\n"
169 " components target the given package. Useful when used in\n"
170 " conjunction with --rename-manifest-package to fix tests against\n"
171 " a package that has been renamed.\n"
172 " --product\n"
173 " Specifies which variant to choose for strings that have\n"
174 " product variants\n"
175 " --utf16\n"
176 " changes default encoding for resources to UTF-16. Only useful when API\n"
177 " level is set to 7 or higher where the default encoding is UTF-8.\n"
178 " --non-constant-id\n"
179 " Make the resources ID non constant. This is required to make an R java class\n"
180 " that does not contain the final value but is used to make reusable compiled\n"
181 " libraries that need to access resources.\n"
182 " --ignore-assets\n"
183 " Assets to be ignored. Default pattern is:\n"
184 " %s\n",
185 gDefaultIgnoreAssets);
186 }
187
188 /*
189 * Dispatch the command.
190 */
handleCommand(Bundle * bundle)191 int handleCommand(Bundle* bundle)
192 {
193 //printf("--- command %d (verbose=%d force=%d):\n",
194 // bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
195 //for (int i = 0; i < bundle->getFileSpecCount(); i++)
196 // printf(" %d: '%s'\n", i, bundle->getFileSpecEntry(i));
197
198 switch (bundle->getCommand()) {
199 case kCommandVersion: return doVersion(bundle);
200 case kCommandList: return doList(bundle);
201 case kCommandDump: return doDump(bundle);
202 case kCommandAdd: return doAdd(bundle);
203 case kCommandRemove: return doRemove(bundle);
204 case kCommandPackage: return doPackage(bundle);
205 case kCommandCrunch: return doCrunch(bundle);
206 default:
207 fprintf(stderr, "%s: requested command not yet supported\n", gProgName);
208 return 1;
209 }
210 }
211
212 /*
213 * Parse args.
214 */
main(int argc,char * const argv[])215 int main(int argc, char* const argv[])
216 {
217 char *prog = argv[0];
218 Bundle bundle;
219 bool wantUsage = false;
220 int result = 1; // pessimistically assume an error.
221 int tolerance = 0;
222
223 /* default to compression */
224 bundle.setCompressionMethod(ZipEntry::kCompressDeflated);
225
226 if (argc < 2) {
227 wantUsage = true;
228 goto bail;
229 }
230
231 if (argv[1][0] == 'v')
232 bundle.setCommand(kCommandVersion);
233 else if (argv[1][0] == 'd')
234 bundle.setCommand(kCommandDump);
235 else if (argv[1][0] == 'l')
236 bundle.setCommand(kCommandList);
237 else if (argv[1][0] == 'a')
238 bundle.setCommand(kCommandAdd);
239 else if (argv[1][0] == 'r')
240 bundle.setCommand(kCommandRemove);
241 else if (argv[1][0] == 'p')
242 bundle.setCommand(kCommandPackage);
243 else if (argv[1][0] == 'c')
244 bundle.setCommand(kCommandCrunch);
245 else {
246 fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]);
247 wantUsage = true;
248 goto bail;
249 }
250 argc -= 2;
251 argv += 2;
252
253 /*
254 * Pull out flags. We support "-fv" and "-f -v".
255 */
256 while (argc && argv[0][0] == '-') {
257 /* flag(s) found */
258 const char* cp = argv[0] +1;
259
260 while (*cp != '\0') {
261 switch (*cp) {
262 case 'v':
263 bundle.setVerbose(true);
264 break;
265 case 'a':
266 bundle.setAndroidList(true);
267 break;
268 case 'c':
269 argc--;
270 argv++;
271 if (!argc) {
272 fprintf(stderr, "ERROR: No argument supplied for '-c' option\n");
273 wantUsage = true;
274 goto bail;
275 }
276 bundle.addConfigurations(argv[0]);
277 break;
278 case 'f':
279 bundle.setForce(true);
280 break;
281 case 'g':
282 argc--;
283 argv++;
284 if (!argc) {
285 fprintf(stderr, "ERROR: No argument supplied for '-g' option\n");
286 wantUsage = true;
287 goto bail;
288 }
289 tolerance = atoi(argv[0]);
290 bundle.setGrayscaleTolerance(tolerance);
291 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance);
292 break;
293 case 'k':
294 bundle.setJunkPath(true);
295 break;
296 case 'm':
297 bundle.setMakePackageDirs(true);
298 break;
299 case 'o':
300 bundle.setIsOverlayPackage(true);
301 break;
302 #if 0
303 case 'p':
304 bundle.setPseudolocalize(true);
305 break;
306 #endif
307 case 'u':
308 bundle.setUpdate(true);
309 break;
310 case 'x':
311 bundle.setExtending(true);
312 break;
313 case 'z':
314 bundle.setRequireLocalization(true);
315 break;
316 case 'j':
317 argc--;
318 argv++;
319 if (!argc) {
320 fprintf(stderr, "ERROR: No argument supplied for '-j' option\n");
321 wantUsage = true;
322 goto bail;
323 }
324 convertPath(argv[0]);
325 bundle.addJarFile(argv[0]);
326 break;
327 case 'A':
328 argc--;
329 argv++;
330 if (!argc) {
331 fprintf(stderr, "ERROR: No argument supplied for '-A' option\n");
332 wantUsage = true;
333 goto bail;
334 }
335 convertPath(argv[0]);
336 bundle.setAssetSourceDir(argv[0]);
337 break;
338 case 'G':
339 argc--;
340 argv++;
341 if (!argc) {
342 fprintf(stderr, "ERROR: No argument supplied for '-G' option\n");
343 wantUsage = true;
344 goto bail;
345 }
346 convertPath(argv[0]);
347 bundle.setProguardFile(argv[0]);
348 break;
349 case 'I':
350 argc--;
351 argv++;
352 if (!argc) {
353 fprintf(stderr, "ERROR: No argument supplied for '-I' option\n");
354 wantUsage = true;
355 goto bail;
356 }
357 convertPath(argv[0]);
358 bundle.addPackageInclude(argv[0]);
359 break;
360 case 'F':
361 argc--;
362 argv++;
363 if (!argc) {
364 fprintf(stderr, "ERROR: No argument supplied for '-F' option\n");
365 wantUsage = true;
366 goto bail;
367 }
368 convertPath(argv[0]);
369 bundle.setOutputAPKFile(argv[0]);
370 break;
371 case 'J':
372 argc--;
373 argv++;
374 if (!argc) {
375 fprintf(stderr, "ERROR: No argument supplied for '-J' option\n");
376 wantUsage = true;
377 goto bail;
378 }
379 convertPath(argv[0]);
380 bundle.setRClassDir(argv[0]);
381 break;
382 case 'M':
383 argc--;
384 argv++;
385 if (!argc) {
386 fprintf(stderr, "ERROR: No argument supplied for '-M' option\n");
387 wantUsage = true;
388 goto bail;
389 }
390 convertPath(argv[0]);
391 bundle.setAndroidManifestFile(argv[0]);
392 break;
393 case 'P':
394 argc--;
395 argv++;
396 if (!argc) {
397 fprintf(stderr, "ERROR: No argument supplied for '-P' option\n");
398 wantUsage = true;
399 goto bail;
400 }
401 convertPath(argv[0]);
402 bundle.setPublicOutputFile(argv[0]);
403 break;
404 case 'S':
405 argc--;
406 argv++;
407 if (!argc) {
408 fprintf(stderr, "ERROR: No argument supplied for '-S' option\n");
409 wantUsage = true;
410 goto bail;
411 }
412 convertPath(argv[0]);
413 bundle.addResourceSourceDir(argv[0]);
414 break;
415 case 'C':
416 argc--;
417 argv++;
418 if (!argc) {
419 fprintf(stderr, "ERROR: No argument supplied for '-C' option\n");
420 wantUsage = true;
421 goto bail;
422 }
423 convertPath(argv[0]);
424 bundle.setCrunchedOutputDir(argv[0]);
425 break;
426 case '0':
427 argc--;
428 argv++;
429 if (!argc) {
430 fprintf(stderr, "ERROR: No argument supplied for '-e' option\n");
431 wantUsage = true;
432 goto bail;
433 }
434 if (argv[0][0] != 0) {
435 bundle.addNoCompressExtension(argv[0]);
436 } else {
437 bundle.setCompressionMethod(ZipEntry::kCompressStored);
438 }
439 break;
440 case '-':
441 if (strcmp(cp, "-debug-mode") == 0) {
442 bundle.setDebugMode(true);
443 } else if (strcmp(cp, "-min-sdk-version") == 0) {
444 argc--;
445 argv++;
446 if (!argc) {
447 fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n");
448 wantUsage = true;
449 goto bail;
450 }
451 bundle.setMinSdkVersion(argv[0]);
452 } else if (strcmp(cp, "-target-sdk-version") == 0) {
453 argc--;
454 argv++;
455 if (!argc) {
456 fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n");
457 wantUsage = true;
458 goto bail;
459 }
460 bundle.setTargetSdkVersion(argv[0]);
461 } else if (strcmp(cp, "-max-sdk-version") == 0) {
462 argc--;
463 argv++;
464 if (!argc) {
465 fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n");
466 wantUsage = true;
467 goto bail;
468 }
469 bundle.setMaxSdkVersion(argv[0]);
470 } else if (strcmp(cp, "-max-res-version") == 0) {
471 argc--;
472 argv++;
473 if (!argc) {
474 fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n");
475 wantUsage = true;
476 goto bail;
477 }
478 bundle.setMaxResVersion(argv[0]);
479 } else if (strcmp(cp, "-version-code") == 0) {
480 argc--;
481 argv++;
482 if (!argc) {
483 fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n");
484 wantUsage = true;
485 goto bail;
486 }
487 bundle.setVersionCode(argv[0]);
488 } else if (strcmp(cp, "-version-name") == 0) {
489 argc--;
490 argv++;
491 if (!argc) {
492 fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n");
493 wantUsage = true;
494 goto bail;
495 }
496 bundle.setVersionName(argv[0]);
497 } else if (strcmp(cp, "-values") == 0) {
498 bundle.setValues(true);
499 } else if (strcmp(cp, "-custom-package") == 0) {
500 argc--;
501 argv++;
502 if (!argc) {
503 fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n");
504 wantUsage = true;
505 goto bail;
506 }
507 bundle.setCustomPackage(argv[0]);
508 } else if (strcmp(cp, "-extra-packages") == 0) {
509 argc--;
510 argv++;
511 if (!argc) {
512 fprintf(stderr, "ERROR: No argument supplied for '--extra-packages' option\n");
513 wantUsage = true;
514 goto bail;
515 }
516 bundle.setExtraPackages(argv[0]);
517 } else if (strcmp(cp, "-generate-dependencies") == 0) {
518 bundle.setGenDependencies(true);
519 } else if (strcmp(cp, "-utf16") == 0) {
520 bundle.setWantUTF16(true);
521 } else if (strcmp(cp, "-preferred-configurations") == 0) {
522 argc--;
523 argv++;
524 if (!argc) {
525 fprintf(stderr, "ERROR: No argument supplied for '--preferred-configurations' option\n");
526 wantUsage = true;
527 goto bail;
528 }
529 bundle.addPreferredConfigurations(argv[0]);
530 } else if (strcmp(cp, "-rename-manifest-package") == 0) {
531 argc--;
532 argv++;
533 if (!argc) {
534 fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
535 wantUsage = true;
536 goto bail;
537 }
538 bundle.setManifestPackageNameOverride(argv[0]);
539 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) {
540 argc--;
541 argv++;
542 if (!argc) {
543 fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
544 wantUsage = true;
545 goto bail;
546 }
547 bundle.setInstrumentationPackageNameOverride(argv[0]);
548 } else if (strcmp(cp, "-auto-add-overlay") == 0) {
549 bundle.setAutoAddOverlay(true);
550 } else if (strcmp(cp, "-product") == 0) {
551 argc--;
552 argv++;
553 if (!argc) {
554 fprintf(stderr, "ERROR: No argument supplied for '--product' option\n");
555 wantUsage = true;
556 goto bail;
557 }
558 bundle.setProduct(argv[0]);
559 } else if (strcmp(cp, "-non-constant-id") == 0) {
560 bundle.setNonConstantId(true);
561 } else if (strcmp(cp, "-no-crunch") == 0) {
562 bundle.setUseCrunchCache(true);
563 } else if (strcmp(cp, "-ignore-assets") == 0) {
564 argc--;
565 argv++;
566 if (!argc) {
567 fprintf(stderr, "ERROR: No argument supplied for '--ignore-assets' option\n");
568 wantUsage = true;
569 goto bail;
570 }
571 gUserIgnoreAssets = argv[0];
572 } else {
573 fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp);
574 wantUsage = true;
575 goto bail;
576 }
577 cp += strlen(cp) - 1;
578 break;
579 default:
580 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp);
581 wantUsage = true;
582 goto bail;
583 }
584
585 cp++;
586 }
587 argc--;
588 argv++;
589 }
590
591 /*
592 * We're past the flags. The rest all goes straight in.
593 */
594 bundle.setFileSpec(argv, argc);
595
596 result = handleCommand(&bundle);
597
598 bail:
599 if (wantUsage) {
600 usage();
601 result = 2;
602 }
603
604 //printf("--> returning %d\n", result);
605 return result;
606 }
607