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         "   --extra-packages\n"
 149         "       generate R.java for libraries. Separate libraries with ';'.\n"
 150         "   --auto-add-overlay\n"
 151         "       Automatically add resources that are only in overlays.\n"
 152         "   --rename-manifest-package\n"
 153         "       Rewrite the manifest so that its package name is the package name\n"
 154         "       given here.  Relative class names (for example .Foo) will be\n"
 155         "       changed to absolute names with the old package so that the code\n"
 156         "       does not need to change.\n"
 157         "   --rename-instrumentation-target-package\n"
 158         "       Rewrite the manifest so that all of its instrumentation\n"
 159         "       components target the given package.  Useful when used in\n"
 160         "       conjunction with --rename-manifest-package to fix tests against\n"
 161         "       a package that has been renamed.\n"
 162         "   --product\n"
 163         "       Specifies which variant to choose for strings that have\n"
 164         "       product variants\n"
 165         "   --utf16\n"
 166         "       changes default encoding for resources to UTF-16.  Only useful when API\n"
 167         "       level is set to 7 or higher where the default encoding is UTF-8.\n"
 168         "   --non-constant-id\n"
 169         "       Make the resources ID non constant. This is required to make an R java class\n"
 170         "       that does not contain the final value but is used to make reusable compiled\n"
 171         "       libraries that need to access resources.\n");
 172 }
 173
 174 /*
 175  * Dispatch the command.
 176  */
 177 int handleCommand(Bundle* bundle)
 178 {
 179     //printf("--- command %d (verbose=%d force=%d):\n",
 180     //    bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
 181     //for (int i = 0; i < bundle->getFileSpecCount(); i++)
 182     //    printf("  %d: '%s'\n", i, bundle->getFileSpecEntry(i));
 183
 184     switch (bundle->getCommand()) {
 185     case kCommandVersion:   return doVersion(bundle);
 186     case kCommandList:      return doList(bundle);
 187     case kCommandDump:      return doDump(bundle);
 188     case kCommandAdd:       return doAdd(bundle);
 189     case kCommandRemove:    return doRemove(bundle);
 190     case kCommandPackage:   return doPackage(bundle);
 191     default:
 192         fprintf(stderr, "%s: requested command not yet supported\n", gProgName);
 193         return 1;
 194     }
 195 }
 196
 197 /*
 198  * Parse args.
 199  */
 200 int main(int argc, char* const argv[])
 201 {
 202     char *prog = argv[0];
 203     Bundle bundle;
 204     bool wantUsage = false;
 205     int result = 1;    // pessimistically assume an error.
 206     int tolerance = 0;
 207
 208     /* default to compression */
 209     bundle.setCompressionMethod(ZipEntry::kCompressDeflated);
 210
 211     if (argc < 2) {
 212         wantUsage = true;
 213         goto bail;
 214     }
 215
 216     if (argv[1][0] == 'v')
 217         bundle.setCommand(kCommandVersion);
 218     else if (argv[1][0] == 'd')
 219         bundle.setCommand(kCommandDump);
 220     else if (argv[1][0] == 'l')
 221         bundle.setCommand(kCommandList);
 222     else if (argv[1][0] == 'a')
 223         bundle.setCommand(kCommandAdd);
 224     else if (argv[1][0] == 'r')
 225         bundle.setCommand(kCommandRemove);
 226     else if (argv[1][0] == 'p')
 227         bundle.setCommand(kCommandPackage);
 228     else {
 229         fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]);
 230         wantUsage = true;
 231         goto bail;
 232     }
 233     argc -= 2;
 234     argv += 2;
 235
 236     /*
 237      * Pull out flags.  We support "-fv" and "-f -v".
 238      */
 239     while (argc && argv[0][0] == '-') {
 240         /* flag(s) found */
 241         const char* cp = argv[0] +1;
 242
 243         while (*cp != '\0') {
 244             switch (*cp) {
 245             case 'v':
 246                 bundle.setVerbose(true);
 247                 break;
 248             case 'a':
 249                 bundle.setAndroidList(true);
 250                 break;
 251             case 'c':
 252                 argc--;
 253                 argv++;
 254                 if (!argc) {
 255                     fprintf(stderr, "ERROR: No argument supplied for '-c' option\n");
 256                     wantUsage = true;
 257                     goto bail;
 258                 }
 259                 bundle.addConfigurations(argv[0]);
 260                 break;
 261             case 'f':
 262                 bundle.setForce(true);
 263                 break;
 264             case 'g':
 265                 argc--;
 266                 argv++;
 267                 if (!argc) {
 268                     fprintf(stderr, "ERROR: No argument supplied for '-g' option\n");
 269                     wantUsage = true;
 270                     goto bail;
 271                 }
 272                 tolerance = atoi(argv[0]);
 273                 bundle.setGrayscaleTolerance(tolerance);
 274                 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance);
 275                 break;
 276             case 'k':
 277                 bundle.setJunkPath(true);
 278                 break;
 279             case 'm':
 280                 bundle.setMakePackageDirs(true);
 281                 break;
 282             case 'o':
 283                 bundle.setIsOverlayPackage(true);
 284                 break;
 285 #if 0
 286             case 'p':
 287                 bundle.setPseudolocalize(true);
 288                 break;
 289 #endif
 290             case 'u':
 291                 bundle.setUpdate(true);
 292                 break;
 293             case 'x':
 294                 bundle.setExtending(true);
 295                 break;
 296             case 'z':
 297                 bundle.setRequireLocalization(true);
 298                 break;
 299             case 'j':
 300                 argc--;
 301                 argv++;
 302                 if (!argc) {
 303                     fprintf(stderr, "ERROR: No argument supplied for '-j' option\n");
 304                     wantUsage = true;
 305                     goto bail;
 306                 }
 307                 convertPath(argv[0]);
 308                 bundle.addJarFile(argv[0]);
 309                 break;
 310             case 'A':
 311                 argc--;
 312                 argv++;
 313                 if (!argc) {
 314                     fprintf(stderr, "ERROR: No argument supplied for '-A' option\n");
 315                     wantUsage = true;
 316                     goto bail;
 317                 }
 318                 convertPath(argv[0]);
 319                 bundle.setAssetSourceDir(argv[0]);
 320                 break;
 321             case 'G':
 322                 argc--;
 323                 argv++;
 324                 if (!argc) {
 325                     fprintf(stderr, "ERROR: No argument supplied for '-G' option\n");
 326                     wantUsage = true;
 327                     goto bail;
 328                 }
 329                 convertPath(argv[0]);
 330                 bundle.setProguardFile(argv[0]);
 331                 break;
 332             case 'I':
 333                 argc--;
 334                 argv++;
 335                 if (!argc) {
 336                     fprintf(stderr, "ERROR: No argument supplied for '-I' option\n");
 337                     wantUsage = true;
 338                     goto bail;
 339                 }
 340                 convertPath(argv[0]);
 341                 bundle.addPackageInclude(argv[0]);
 342                 break;
 343             case 'F':
 344                 argc--;
 345                 argv++;
 346                 if (!argc) {
 347                     fprintf(stderr, "ERROR: No argument supplied for '-F' option\n");
 348                     wantUsage = true;
 349                     goto bail;
 350                 }
 351                 convertPath(argv[0]);
 352                 bundle.setOutputAPKFile(argv[0]);
 353                 break;
 354             case 'J':
 355                 argc--;
 356                 argv++;
 357                 if (!argc) {
 358                     fprintf(stderr, "ERROR: No argument supplied for '-J' option\n");
 359                     wantUsage = true;
 360                     goto bail;
 361                 }
 362                 convertPath(argv[0]);
 363                 bundle.setRClassDir(argv[0]);
 364                 break;
 365             case 'M':
 366                 argc--;
 367                 argv++;
 368                 if (!argc) {
 369                     fprintf(stderr, "ERROR: No argument supplied for '-M' option\n");
 370                     wantUsage = true;
 371                     goto bail;
 372                 }
 373                 convertPath(argv[0]);
 374                 bundle.setAndroidManifestFile(argv[0]);
 375                 break;
 376             case 'P':
 377                 argc--;
 378                 argv++;
 379                 if (!argc) {
 380                     fprintf(stderr, "ERROR: No argument supplied for '-P' option\n");
 381                     wantUsage = true;
 382                     goto bail;
 383                 }
 384                 convertPath(argv[0]);
 385                 bundle.setPublicOutputFile(argv[0]);
 386                 break;
 387             case 'S':
 388                 argc--;
 389                 argv++;
 390                 if (!argc) {
 391                     fprintf(stderr, "ERROR: No argument supplied for '-S' option\n");
 392                     wantUsage = true;
 393                     goto bail;
 394                 }
 395                 convertPath(argv[0]);
 396                 bundle.addResourceSourceDir(argv[0]);
 397                 break;
 398             case '0':
 399                 argc--;
 400                 argv++;
 401                 if (!argc) {
 402                     fprintf(stderr, "ERROR: No argument supplied for '-e' option\n");
 403                     wantUsage = true;
 404                     goto bail;
 405                 }
 406                 if (argv[0][0] != 0) {
 407                     bundle.addNoCompressExtension(argv[0]);
 408                 } else {
 409                     bundle.setCompressionMethod(ZipEntry::kCompressStored);
 410                 }
 411                 break;
 412             case '-':
 413                 if (strcmp(cp, "-debug-mode") == 0) {
 414                     bundle.setDebugMode(true);
 415                 } else if (strcmp(cp, "-min-sdk-version") == 0) {
 416                     argc--;
 417                     argv++;
 418                     if (!argc) {
 419                         fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n");
 420                         wantUsage = true;
 421                         goto bail;
 422                     }
 423                     bundle.setMinSdkVersion(argv[0]);
 424                 } else if (strcmp(cp, "-target-sdk-version") == 0) {
 425                     argc--;
 426                     argv++;
 427                     if (!argc) {
 428                         fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n");
 429                         wantUsage = true;
 430                         goto bail;
 431                     }
 432                     bundle.setTargetSdkVersion(argv[0]);
 433                 } else if (strcmp(cp, "-max-sdk-version") == 0) {
 434                     argc--;
 435                     argv++;
 436                     if (!argc) {
 437                         fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n");
 438                         wantUsage = true;
 439                         goto bail;
 440                     }
 441                     bundle.setMaxSdkVersion(argv[0]);
 442                 } else if (strcmp(cp, "-max-res-version") == 0) {
 443                     argc--;
 444                     argv++;
 445                     if (!argc) {
 446                         fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n");
 447                         wantUsage = true;
 448                         goto bail;
 449                     }
 450                     bundle.setMaxResVersion(argv[0]);
 451                 } else if (strcmp(cp, "-version-code") == 0) {
 452                     argc--;
 453                     argv++;
 454                     if (!argc) {
 455                         fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n");
 456                         wantUsage = true;
 457                         goto bail;
 458                     }
 459                     bundle.setVersionCode(argv[0]);
 460                 } else if (strcmp(cp, "-version-name") == 0) {
 461                     argc--;
 462                     argv++;
 463                     if (!argc) {
 464                         fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n");
 465                         wantUsage = true;
 466                         goto bail;
 467                     }
 468                     bundle.setVersionName(argv[0]);
 469                 } else if (strcmp(cp, "-values") == 0) {
 470                     bundle.setValues(true);
 471                 } else if (strcmp(cp, "-custom-package") == 0) {
 472                     argc--;
 473                     argv++;
 474                     if (!argc) {
 475                         fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n");
 476                         wantUsage = true;
 477                         goto bail;
 478                     }
 479                     bundle.setCustomPackage(argv[0]);
 480                 } else if (strcmp(cp, "-extra-packages") == 0) {
 481                     argc--;
 482                     argv++;
 483                     if (!argc) {
 484                         fprintf(stderr, "ERROR: No argument supplied for '--extra-packages' option\n");
 485                         wantUsage = true;
 486                         goto bail;
 487                     }
 488                     bundle.setExtraPackages(argv[0]);
 489                 } else if (strcmp(cp, "-utf16") == 0) {
 490                     bundle.setWantUTF16(true);
 491                 } else if (strcmp(cp, "-rename-manifest-package") == 0) {
 492                     argc--;
 493                     argv++;
 494                     if (!argc) {
 495                         fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
 496                         wantUsage = true;
 497                         goto bail;
 498                     }
 499                     bundle.setManifestPackageNameOverride(argv[0]);
 500                 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) {
 501                     argc--;
 502                     argv++;
 503                     if (!argc) {
 504                         fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
 505                         wantUsage = true;
 506                         goto bail;
 507                     }
 508                     bundle.setInstrumentationPackageNameOverride(argv[0]);
 509                 } else if (strcmp(cp, "-auto-add-overlay") == 0) {
 510                     bundle.setAutoAddOverlay(true);
 511                 } else if (strcmp(cp, "-product") == 0) {
 512                     argc--;
 513                     argv++;
 514                     if (!argc) {
 515                         fprintf(stderr, "ERROR: No argument supplied for '--product' option\n");
 516                         wantUsage = true;
 517                         goto bail;
 518                     }
 519                     bundle.setProduct(argv[0]);
 520                 } else if (strcmp(cp, "-non-constant-id") == 0) {
 521                     bundle.setNonConstantId(true);
 522                 } else {
 523                     fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp);
 524                     wantUsage = true;
 525                     goto bail;
 526                 }
 527                 cp += strlen(cp) - 1;
 528                 break;
 529             default:
 530                 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp);
 531                 wantUsage = true;
 532                 goto bail;
 533             }
 534
 535             cp++;
 536         }
 537         argc--;
 538         argv++;
 539     }
 540
 541     /*
 542      * We're past the flags.  The rest all goes straight in.
 543      */
 544     bundle.setFileSpec(argv, argc);
 545
 546     result = handleCommand(&bundle);
 547
 548 bail:
 549     if (wantUsage) {
 550         usage();
 551         result = 2;
 552     }
 553
 554     //printf("--> returning %d\n", result);
 555     return result;
 556 }