Main.cpp

   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  */
  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  */
  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 ...]] "
  69         "        [-F apk-file] [-J R-file-dir] \\\n"
  70         "        [--product product1,product2,...] \\\n"
  71         "        [-o] \\\n"
  72         "        [raw-files-dir [raw-files-dir] ...]\n"
  73         "\n"
  74         "   Package the android resources.  It will read assets and resources that are\n"
  75         "   supplied with the -M -A -S or raw-files-dir arguments.  The -J -P -F and -R\n"
  76         "   options control which files are output.\n\n"
  77         , gProgName);
  78     fprintf(stderr,
  79         " %s r[emove] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
  80         "   Delete specified files from Zip-compatible archive.\n\n",
  81         gProgName);
  82     fprintf(stderr,
  83         " %s a[dd] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
  84         "   Add specified files to Zip-compatible archive.\n\n", gProgName);
  85     fprintf(stderr,
  86         " %s v[ersion]\n"
  87         "   Print program version.\n\n", gProgName);
  88     fprintf(stderr,
  89         " Modifiers:\n"
  90         "   -a  print Android-specific data (resources, manifest) when listing\n"
  91         "   -c  specify which configurations to include.  The default is all\n"
  92         "       configurations.  The value of the parameter should be a comma\n"
  93         "       separated list of configuration values.  Locales should be specified\n"
  94         "       as either a language or language-region pair.  Some examples:\n"
  95         "            en\n"
  96         "            port,en\n"
  97         "            port,land,en_US\n"
  98         "       If you put the special locale, zz_ZZ on the list, it will perform\n"
  99         "       pseudolocalization on the default locale, modifying all of the\n"
 100         "       strings so you can look for strings that missed the\n"
 101         "       internationalization process.  For example:\n"
 102         "            port,land,zz_ZZ\n"
 103         "   -d  one or more device assets to include, separated by commas\n"
 104         "   -f  force overwrite of existing files\n"
 105         "   -g  specify a pixel tolerance to force images to grayscale, default 0\n"
 106         "   -j  specify a jar or zip file containing classes to include\n"
 107         "   -k  junk path of file(s) added\n"
 108         "   -m  make package directories under location specified by -J\n"
 109         "   -o  create overlay package (ie only resources; expects <overlay-package> in manifest)\n"
 110 #if 0
 111         "   -p  pseudolocalize the default configuration\n"
 112 #endif
 113         "   -u  update existing packages (add new, replace older, remove deleted files)\n"
 114         "   -v  verbose output\n"
 115         "   -x  create extending (non-application) resource IDs\n"
 116         "   -z  require localization of resource attributes marked with\n"
 117         "       localization=\"suggested\"\n"
 118         "   -A  additional directory in which to find raw asset files\n"
 119         "   -G  A file to output proguard options into.\n"
 120         "   -F  specify the apk file to output\n"
 121         "   -I  add an existing package to base include set\n"
 122         "   -J  specify where to output R.java resource constant definitions\n"
 123         "   -M  specify full path to AndroidManifest.xml to include in zip\n"
 124         "   -P  specify where to output public resource definitions\n"
 125         "   -S  directory in which to find resources.  Multiple directories will be scanned\n"
 126         "       and the first match found (left to right) will take precedence.\n"
 127         "   -0  specifies an additional extension for which such files will not\n"
 128         "       be stored compressed in the .apk.  An empty string means to not\n"
 129         "       compress any files at all.\n"
 130         "   --debug-mode\n"
 131         "       inserts android:debuggable=\"true\" in to the application node of the\n"
 132         "       manifest, making the application debuggable even on production devices.\n"
 133         "   --min-sdk-version\n"
 134         "       inserts android:minSdkVersion in to manifest.  If the version is 7 or\n"
 135         "       higher, the default encoding for resources will be in UTF-8.\n"
 136         "   --target-sdk-version\n"
 137         "       inserts android:targetSdkVersion in to manifest.\n"
 138         "   --max-res-version\n"
 139         "       ignores versioned resource directories above the given value.\n"
 140         "   --values\n"
 141         "       when used with \"dump resources\" also includes resource values.\n"
 142         "   --version-code\n"
 143         "       inserts android:versionCode in to manifest.\n"
 144         "   --version-name\n"
 145         "       inserts android:versionName in to manifest.\n"
 146         "   --custom-package\n"
 147         "       generates R.java into a different package.\n"
 148         "   --auto-add-overlay\n"
 149         "       Automatically add resources that are only in overlays.\n"
 150         "   --rename-manifest-package\n"
 151         "       Rewrite the manifest so that its package name is the package name\n"
 152         "       given here.  Relative class names (for example .Foo) will be\n"
 153         "       changed to absolute names with the old package so that the code\n"
 154         "       does not need to change.\n"
 155         "   --rename-instrumentation-target-package\n"
 156         "       Rewrite the manifest so that all of its instrumentation\n"
 157         "       components target the given package.  Useful when used in\n"
 158         "       conjunction with --rename-manifest-package to fix tests against\n"
 159         "       a package that has been renamed.\n"
 160         "   --product\n"
 161         "       Specifies which variant to choose for strings that have\n"
 162         "       product variants\n"
 163         "   --utf16\n"
 164         "       changes default encoding for resources to UTF-16.  Only useful when API\n"
 165         "       level is set to 7 or higher where the default encoding is UTF-8.\n"
 166         "   --non-constant-id\n"
 167         "       Make the resources ID non constant. This is required to make an R java class\n"
 168         "       that does not contain the final value but is used to make reusable compiled\n"
 169         "       libraries that need to access resources.\n");
 170 }
 171
 172 /*
 173  * Dispatch the command.
 174  */
 175 int handleCommand(Bundle* bundle)
 176 {
 177     //printf("--- command %d (verbose=%d force=%d):\n",
 178     //    bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
 179     //for (int i = 0; i < bundle->getFileSpecCount(); i++)
 180     //    printf("  %d: '%s'\n", i, bundle->getFileSpecEntry(i));
 181
 182     switch (bundle->getCommand()) {
 183     case kCommandVersion:   return doVersion(bundle);
 184     case kCommandList:      return doList(bundle);
 185     case kCommandDump:      return doDump(bundle);
 186     case kCommandAdd:       return doAdd(bundle);
 187     case kCommandRemove:    return doRemove(bundle);
 188     case kCommandPackage:   return doPackage(bundle);
 189     default:
 190         fprintf(stderr, "%s: requested command not yet supported\n", gProgName);
 191         return 1;
 192     }
 193 }
 194
 195 /*
 196  * Parse args.
 197  */
 198 int main(int argc, char* const argv[])
 199 {
 200     char *prog = argv[0];
 201     Bundle bundle;
 202     bool wantUsage = false;
 203     int result = 1;    // pessimistically assume an error.
 204     int tolerance = 0;
 205
 206     /* default to compression */
 207     bundle.setCompressionMethod(ZipEntry::kCompressDeflated);
 208
 209     if (argc < 2) {
 210         wantUsage = true;
 211         goto bail;
 212     }
 213
 214     if (argv[1][0] == 'v')
 215         bundle.setCommand(kCommandVersion);
 216     else if (argv[1][0] == 'd')
 217         bundle.setCommand(kCommandDump);
 218     else if (argv[1][0] == 'l')
 219         bundle.setCommand(kCommandList);
 220     else if (argv[1][0] == 'a')
 221         bundle.setCommand(kCommandAdd);
 222     else if (argv[1][0] == 'r')
 223         bundle.setCommand(kCommandRemove);
 224     else if (argv[1][0] == 'p')
 225         bundle.setCommand(kCommandPackage);
 226     else {
 227         fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]);
 228         wantUsage = true;
 229         goto bail;
 230     }
 231     argc -= 2;
 232     argv += 2;
 233
 234     /*
 235      * Pull out flags.  We support "-fv" and "-f -v".
 236      */
 237     while (argc && argv[0][0] == '-') {
 238         /* flag(s) found */
 239         const char* cp = argv[0] +1;
 240
 241         while (*cp != '\0') {
 242             switch (*cp) {
 243             case 'v':
 244                 bundle.setVerbose(true);
 245                 break;
 246             case 'a':
 247                 bundle.setAndroidList(true);
 248                 break;
 249             case 'c':
 250                 argc--;
 251                 argv++;
 252                 if (!argc) {
 253                     fprintf(stderr, "ERROR: No argument supplied for '-c' option\n");
 254                     wantUsage = true;
 255                     goto bail;
 256                 }
 257                 bundle.addConfigurations(argv[0]);
 258                 break;
 259             case 'f':
 260                 bundle.setForce(true);
 261                 break;
 262             case 'g':
 263                 argc--;
 264                 argv++;
 265                 if (!argc) {
 266                     fprintf(stderr, "ERROR: No argument supplied for '-g' option\n");
 267                     wantUsage = true;
 268                     goto bail;
 269                 }
 270                 tolerance = atoi(argv[0]);
 271                 bundle.setGrayscaleTolerance(tolerance);
 272                 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance);
 273                 break;
 274             case 'k':
 275                 bundle.setJunkPath(true);
 276                 break;
 277             case 'm':
 278                 bundle.setMakePackageDirs(true);
 279                 break;
 280             case 'o':
 281                 bundle.setIsOverlayPackage(true);
 282                 break;
 283 #if 0
 284             case 'p':
 285                 bundle.setPseudolocalize(true);
 286                 break;
 287 #endif
 288             case 'u':
 289                 bundle.setUpdate(true);
 290                 break;
 291             case 'x':
 292                 bundle.setExtending(true);
 293                 break;
 294             case 'z':
 295                 bundle.setRequireLocalization(true);
 296                 break;
 297             case 'j':
 298                 argc--;
 299                 argv++;
 300                 if (!argc) {
 301                     fprintf(stderr, "ERROR: No argument supplied for '-j' option\n");
 302                     wantUsage = true;
 303                     goto bail;
 304                 }
 305                 convertPath(argv[0]);
 306                 bundle.addJarFile(argv[0]);
 307                 break;
 308             case 'A':
 309                 argc--;
 310                 argv++;
 311                 if (!argc) {
 312                     fprintf(stderr, "ERROR: No argument supplied for '-A' option\n");
 313                     wantUsage = true;
 314                     goto bail;
 315                 }
 316                 convertPath(argv[0]);
 317                 bundle.setAssetSourceDir(argv[0]);
 318                 break;
 319             case 'G':
 320                 argc--;
 321                 argv++;
 322                 if (!argc) {
 323                     fprintf(stderr, "ERROR: No argument supplied for '-G' option\n");
 324                     wantUsage = true;
 325                     goto bail;
 326                 }
 327                 convertPath(argv[0]);
 328                 bundle.setProguardFile(argv[0]);
 329                 break;
 330             case 'I':
 331                 argc--;
 332                 argv++;
 333                 if (!argc) {
 334                     fprintf(stderr, "ERROR: No argument supplied for '-I' option\n");
 335                     wantUsage = true;
 336                     goto bail;
 337                 }
 338                 convertPath(argv[0]);
 339                 bundle.addPackageInclude(argv[0]);
 340                 break;
 341             case 'F':
 342                 argc--;
 343                 argv++;
 344                 if (!argc) {
 345                     fprintf(stderr, "ERROR: No argument supplied for '-F' option\n");
 346                     wantUsage = true;
 347                     goto bail;
 348                 }
 349                 convertPath(argv[0]);
 350                 bundle.setOutputAPKFile(argv[0]);
 351                 break;
 352             case 'J':
 353                 argc--;
 354                 argv++;
 355                 if (!argc) {
 356                     fprintf(stderr, "ERROR: No argument supplied for '-J' option\n");
 357                     wantUsage = true;
 358                     goto bail;
 359                 }
 360                 convertPath(argv[0]);
 361                 bundle.setRClassDir(argv[0]);
 362                 break;
 363             case 'M':
 364                 argc--;
 365                 argv++;
 366                 if (!argc) {
 367                     fprintf(stderr, "ERROR: No argument supplied for '-M' option\n");
 368                     wantUsage = true;
 369                     goto bail;
 370                 }
 371                 convertPath(argv[0]);
 372                 bundle.setAndroidManifestFile(argv[0]);
 373                 break;
 374             case 'P':
 375                 argc--;
 376                 argv++;
 377                 if (!argc) {
 378                     fprintf(stderr, "ERROR: No argument supplied for '-P' option\n");
 379                     wantUsage = true;
 380                     goto bail;
 381                 }
 382                 convertPath(argv[0]);
 383                 bundle.setPublicOutputFile(argv[0]);
 384                 break;
 385             case 'S':
 386                 argc--;
 387                 argv++;
 388                 if (!argc) {
 389                     fprintf(stderr, "ERROR: No argument supplied for '-S' option\n");
 390                     wantUsage = true;
 391                     goto bail;
 392                 }
 393                 convertPath(argv[0]);
 394                 bundle.addResourceSourceDir(argv[0]);
 395                 break;
 396             case '0':
 397                 argc--;
 398                 argv++;
 399                 if (!argc) {
 400                     fprintf(stderr, "ERROR: No argument supplied for '-e' option\n");
 401                     wantUsage = true;
 402                     goto bail;
 403                 }
 404                 if (argv[0][0] != 0) {
 405                     bundle.addNoCompressExtension(argv[0]);
 406                 } else {
 407                     bundle.setCompressionMethod(ZipEntry::kCompressStored);
 408                 }
 409                 break;
 410             case '-':
 411                 if (strcmp(cp, "-debug-mode") == 0) {
 412                     bundle.setDebugMode(true);
 413                 } else if (strcmp(cp, "-min-sdk-version") == 0) {
 414                     argc--;
 415                     argv++;
 416                     if (!argc) {
 417                         fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n");
 418                         wantUsage = true;
 419                         goto bail;
 420                     }
 421                     bundle.setMinSdkVersion(argv[0]);
 422                 } else if (strcmp(cp, "-target-sdk-version") == 0) {
 423                     argc--;
 424                     argv++;
 425                     if (!argc) {
 426                         fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n");
 427                         wantUsage = true;
 428                         goto bail;
 429                     }
 430                     bundle.setTargetSdkVersion(argv[0]);
 431                 } else if (strcmp(cp, "-max-sdk-version") == 0) {
 432                     argc--;
 433                     argv++;
 434                     if (!argc) {
 435                         fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n");
 436                         wantUsage = true;
 437                         goto bail;
 438                     }
 439                     bundle.setMaxSdkVersion(argv[0]);
 440                 } else if (strcmp(cp, "-max-res-version") == 0) {
 441                     argc--;
 442                     argv++;
 443                     if (!argc) {
 444                         fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n");
 445                         wantUsage = true;
 446                         goto bail;
 447                     }
 448                     bundle.setMaxResVersion(argv[0]);
 449                 } else if (strcmp(cp, "-version-code") == 0) {
 450                     argc--;
 451                     argv++;
 452                     if (!argc) {
 453                         fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n");
 454                         wantUsage = true;
 455                         goto bail;
 456                     }
 457                     bundle.setVersionCode(argv[0]);
 458                 } else if (strcmp(cp, "-version-name") == 0) {
 459                     argc--;
 460                     argv++;
 461                     if (!argc) {
 462                         fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n");
 463                         wantUsage = true;
 464                         goto bail;
 465                     }
 466                     bundle.setVersionName(argv[0]);
 467                 } else if (strcmp(cp, "-values") == 0) {
 468                     bundle.setValues(true);
 469                 } else if (strcmp(cp, "-custom-package") == 0) {
 470                     argc--;
 471                     argv++;
 472                     if (!argc) {
 473                         fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n");
 474                         wantUsage = true;
 475                         goto bail;
 476                     }
 477                     bundle.setCustomPackage(argv[0]);
 478                 } else if (strcmp(cp, "-utf16") == 0) {
 479                     bundle.setWantUTF16(true);
 480                 } else if (strcmp(cp, "-rename-manifest-package") == 0) {
 481                     argc--;
 482                     argv++;
 483                     if (!argc) {
 484                         fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
 485                         wantUsage = true;
 486                         goto bail;
 487                     }
 488                     bundle.setManifestPackageNameOverride(argv[0]);
 489                 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) {
 490                     argc--;
 491                     argv++;
 492                     if (!argc) {
 493                         fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
 494                         wantUsage = true;
 495                         goto bail;
 496                     }
 497                     bundle.setInstrumentationPackageNameOverride(argv[0]);
 498                 } else if (strcmp(cp, "-auto-add-overlay") == 0) {
 499                     bundle.setAutoAddOverlay(true);
 500                 } else if (strcmp(cp, "-product") == 0) {
 501                     argc--;
 502                     argv++;
 503                     if (!argc) {
 504                         fprintf(stderr, "ERROR: No argument supplied for '--product' option\n");
 505                         wantUsage = true;
 506                         goto bail;
 507                     }
 508                     bundle.setProduct(argv[0]);
 509                 } else if (strcmp(cp, "-non-constant-id") == 0) {
 510                     bundle.setNonConstantId(true);
 511                 } else {
 512                     fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp);
 513                     wantUsage = true;
 514                     goto bail;
 515                 }
 516                 cp += strlen(cp) - 1;
 517                 break;
 518             default:
 519                 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp);
 520                 wantUsage = true;
 521                 goto bail;
 522             }
 523
 524             cp++;
 525         }
 526         argc--;
 527         argv++;
 528     }
 529
 530     /*
 531      * We're past the flags.  The rest all goes straight in.
 532      */
 533     bundle.setFileSpec(argv, argc);
 534
 535     result = handleCommand(&bundle);
 536
 537 bail:
 538     if (wantUsage) {
 539         usage();
 540         result = 2;
 541     }
 542
 543     //printf("--> returning %d\n", result);
 544     return result;
 545 }