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