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