wimlib.net Git - wimlib/blob - programs/imagex.c

   1 /*
   2  * imagex.c
   3  *
   4  * Use wimlib to create, modify, extract, mount, unmount, or display information
   5  * about a WIM file
   6  */
   7
   8 /*
   9  * Copyright (C) 2012, 2013 Eric Biggers
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include "config.h" /* Need for PACKAGE_VERSION, etc. */
  27 #endif
  28
  29 #include "wimlib.h"
  30 #include "wimlib_tchar.h"
  31
  32 #include <ctype.h>
  33 #include <errno.h>
  34
  35 #include <inttypes.h>
  36 #include <libgen.h>
  37 #include <limits.h>
  38 #include <stdarg.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <sys/stat.h>
  42 #include <unistd.h>
  43 #include <locale.h>
  44
  45 #ifdef HAVE_ALLOCA_H
  46 #  include <alloca.h>
  47 #endif
  48
  49 #ifdef __WIN32__
  50 #  include "imagex-win32.h"
  51 #  define tbasename     win32_wbasename
  52 #  define tglob         win32_wglob
  53 #  define OS_PREFERRED_PATH_SEPARATOR L'\\'
  54 #  define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
  55 #else /* __WIN32__ */
  56 #  include <glob.h>
  57 #  include <getopt.h>
  58 #  include <langinfo.h>
  59 #  define tbasename     basename
  60 #  define tglob         glob
  61 #  define OS_PREFERRED_PATH_SEPARATOR '/'
  62 #  define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
  63 #endif /* !__WIN32 */
  64
  65
  66 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
  67
  68 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
  69                                 opts, NULL)) != -1)
  70
  71 enum imagex_op_type {
  72         APPEND = 0,
  73         APPLY,
  74         CAPTURE,
  75         DELETE,
  76         DIR,
  77         EXPORT,
  78         EXTRACT,
  79         INFO,
  80         JOIN,
  81         MOUNT,
  82         MOUNTRW,
  83         OPTIMIZE,
  84         SPLIT,
  85         UNMOUNT,
  86         UPDATE,
  87 };
  88
  89 static void usage(int cmd_type);
  90 static void usage_all(void);
  91
  92 static bool imagex_be_quiet = false;
  93
  94
  95 static const tchar *usage_strings[] = {
  96 [APPEND] =
  97 T(
  98 IMAGEX_PROGNAME" append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
  99 "                     [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
 100 "                     [--verbose] [--dereference] [--config=FILE]\n"
 101 "                     [--threads=NUM_THREADS] [--rebuild] [--unix-data]\n"
 102 "                     [--source-list] [--no-acls] [--strict-acls]\n"
 103 "                     [--rpfix] [--norpfix]\n"
 104 ),
 105 [APPLY] =
 106 T(
 107 IMAGEX_PROGNAME" apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
 108 "                    (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
 109 "                    [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
 110 "                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
 111 "                    [--include-invalid-names]\n"
 112 ),
 113 [CAPTURE] =
 114 T(
 115 IMAGEX_PROGNAME" capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
 116 "                      [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
 117 "                      [--flags EDITION_ID] [--verbose] [--dereference]\n"
 118 "                      [--config=FILE] [--threads=NUM_THREADS] [--unix-data]\n"
 119 "                      [--source-list] [--no-acls] [--strict-acls]\n"
 120 "                      [--rpfix] [--norpfix]\n"
 121 ),
 122 [DELETE] =
 123 T(
 124 IMAGEX_PROGNAME" delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n"
 125 ),
 126 [DIR] =
 127 T(
 128 IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
 129 ),
 130 [EXPORT] =
 131 T(
 132 IMAGEX_PROGNAME" export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
 133 "              DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
 134 "              [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
 135 "              [--threads=NUM_THREADS] [--rebuild]\n"
 136 ),
 137 [EXTRACT] =
 138 T(
 139 IMAGEX_PROGNAME" extract WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
 140 "              [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
 141 "              [--no-acls] [--strict-acls] [--to-stdout] [--dest-dir=DIR]\n"
 142 "              [--include-invalid-names]\n"
 143 ),
 144 [INFO] =
 145 T(
 146 IMAGEX_PROGNAME" info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
 147 "                   [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
 148 "                   [--xml] [--extract-xml FILE] [--metadata]\n"
 149 ),
 150 [JOIN] =
 151 T(
 152 IMAGEX_PROGNAME" join [--check] WIMFILE SPLIT_WIM...\n"
 153 ),
 154 [MOUNT] =
 155 T(
 156 IMAGEX_PROGNAME" mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
 157 "                    [--check] [--debug] [--streams-interface=INTERFACE]\n"
 158 "                    [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
 159 ),
 160 [MOUNTRW] =
 161 T(
 162 IMAGEX_PROGNAME" mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
 163 "                      [--check] [--debug] [--streams-interface=INTERFACE]\n"
 164 "                      [--staging-dir=DIR] [--unix-data] [--allow-other]\n"
 165 ),
 166 [OPTIMIZE] =
 167 T(
 168 IMAGEX_PROGNAME" optimize WIMFILE [--check] [--recompress]\n"
 169 "                      [--threads=NUM_THREADS]\n"
 170 ),
 171 [SPLIT] =
 172 T(
 173 IMAGEX_PROGNAME" split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n"
 174 ),
 175 [UNMOUNT] =
 176 T(
 177 IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
 178 ),
 179 [UPDATE] =
 180 T(
 181 IMAGEX_PROGNAME" update WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
 182 "                       [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
 183 "                       [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
 184 ),
 185 };
 186
 187
 188 static void
 189 recommend_man_page(const tchar *cmd_name)
 190 {
 191         const tchar *format_str;
 192 #ifdef __WIN32__
 193         format_str = T("See "IMAGEX_PROGNAME"%"TS"%"TS".pdf in the "
 194                        "doc directory for more details.\n");
 195 #else
 196         format_str = T("Try `man "IMAGEX_PROGNAME"%"TS"%"TS"' "
 197                        "for more details.\n");
 198 #endif
 199         tprintf(format_str, *cmd_name ? T("-") : T(""), cmd_name);
 200 }
 201
 202 enum {
 203         IMAGEX_ALLOW_OTHER_OPTION,
 204         IMAGEX_BOOT_OPTION,
 205         IMAGEX_CHECK_OPTION,
 206         IMAGEX_COMMAND_OPTION,
 207         IMAGEX_COMMIT_OPTION,
 208         IMAGEX_COMPRESS_OPTION,
 209         IMAGEX_CONFIG_OPTION,
 210         IMAGEX_DEBUG_OPTION,
 211         IMAGEX_DEREFERENCE_OPTION,
 212         IMAGEX_DEST_DIR_OPTION,
 213         IMAGEX_EXTRACT_XML_OPTION,
 214         IMAGEX_FLAGS_OPTION,
 215         IMAGEX_FORCE_OPTION,
 216         IMAGEX_HARDLINK_OPTION,
 217         IMAGEX_HEADER_OPTION,
 218         IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
 219         IMAGEX_LAZY_OPTION,
 220         IMAGEX_LOOKUP_TABLE_OPTION,
 221         IMAGEX_METADATA_OPTION,
 222         IMAGEX_NORPFIX_OPTION,
 223         IMAGEX_NO_ACLS_OPTION,
 224         IMAGEX_REBUILD_OPTION,
 225         IMAGEX_RECOMPRESS_OPTION,
 226         IMAGEX_RECURSIVE_OPTION,
 227         IMAGEX_REF_OPTION,
 228         IMAGEX_RPFIX_OPTION,
 229         IMAGEX_SOFT_OPTION,
 230         IMAGEX_SOURCE_LIST_OPTION,
 231         IMAGEX_STAGING_DIR_OPTION,
 232         IMAGEX_STREAMS_INTERFACE_OPTION,
 233         IMAGEX_STRICT_ACLS_OPTION,
 234         IMAGEX_SYMLINK_OPTION,
 235         IMAGEX_THREADS_OPTION,
 236         IMAGEX_TO_STDOUT_OPTION,
 237         IMAGEX_UNIX_DATA_OPTION,
 238         IMAGEX_VERBOSE_OPTION,
 239         IMAGEX_XML_OPTION,
 240 };
 241
 242 static const struct option apply_options[] = {
 243         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
 244         {T("hardlink"),    no_argument,       NULL, IMAGEX_HARDLINK_OPTION},
 245         {T("symlink"),     no_argument,       NULL, IMAGEX_SYMLINK_OPTION},
 246         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
 247         {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
 248         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
 249         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 250         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 251         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
 252         {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
 253         {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
 254         {T("include-invalid-names"), no_argument,       NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
 255         {NULL, 0, NULL, 0},
 256 };
 257 static const struct option capture_or_append_options[] = {
 258         {T("boot"),        no_argument,       NULL, IMAGEX_BOOT_OPTION},
 259         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
 260         {T("compress"),    required_argument, NULL, IMAGEX_COMPRESS_OPTION},
 261         {T("config"),      required_argument, NULL, IMAGEX_CONFIG_OPTION},
 262         {T("dereference"), no_argument,       NULL, IMAGEX_DEREFERENCE_OPTION},
 263         {T("flags"),       required_argument, NULL, IMAGEX_FLAGS_OPTION},
 264         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
 265         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
 266         {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
 267         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
 268         {T("source-list"), no_argument,       NULL, IMAGEX_SOURCE_LIST_OPTION},
 269         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 270         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 271         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
 272         {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
 273         {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
 274         {NULL, 0, NULL, 0},
 275 };
 276 static const struct option delete_options[] = {
 277         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
 278         {T("soft"),  no_argument, NULL, IMAGEX_SOFT_OPTION},
 279         {NULL, 0, NULL, 0},
 280 };
 281
 282 static const struct option export_options[] = {
 283         {T("boot"),       no_argument,       NULL, IMAGEX_BOOT_OPTION},
 284         {T("check"),      no_argument,       NULL, IMAGEX_CHECK_OPTION},
 285         {T("compress"),   required_argument, NULL, IMAGEX_COMPRESS_OPTION},
 286         {T("ref"),        required_argument, NULL, IMAGEX_REF_OPTION},
 287         {T("threads"),    required_argument, NULL, IMAGEX_THREADS_OPTION},
 288         {T("rebuild"),    no_argument,       NULL, IMAGEX_REBUILD_OPTION},
 289         {NULL, 0, NULL, 0},
 290 };
 291
 292 static const struct option extract_options[] = {
 293         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
 294         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
 295         {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
 296         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
 297         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 298         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 299         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
 300         {T("dest-dir"),    required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
 301         {T("to-stdout"),   no_argument,       NULL, IMAGEX_TO_STDOUT_OPTION},
 302         {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
 303         {NULL, 0, NULL, 0},
 304 };
 305
 306 static const struct option info_options[] = {
 307         {T("boot"),         no_argument,       NULL, IMAGEX_BOOT_OPTION},
 308         {T("check"),        no_argument,       NULL, IMAGEX_CHECK_OPTION},
 309         {T("extract-xml"),  required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
 310         {T("header"),       no_argument,       NULL, IMAGEX_HEADER_OPTION},
 311         {T("lookup-table"), no_argument,       NULL, IMAGEX_LOOKUP_TABLE_OPTION},
 312         {T("metadata"),     no_argument,       NULL, IMAGEX_METADATA_OPTION},
 313         {T("xml"),          no_argument,       NULL, IMAGEX_XML_OPTION},
 314         {NULL, 0, NULL, 0},
 315 };
 316
 317 static const struct option join_options[] = {
 318         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
 319         {NULL, 0, NULL, 0},
 320 };
 321
 322 static const struct option mount_options[] = {
 323         {T("check"),             no_argument,       NULL, IMAGEX_CHECK_OPTION},
 324         {T("debug"),             no_argument,       NULL, IMAGEX_DEBUG_OPTION},
 325         {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
 326         {T("ref"),               required_argument, NULL, IMAGEX_REF_OPTION},
 327         {T("staging-dir"),       required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
 328         {T("unix-data"),         no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
 329         {T("allow-other"),       no_argument,       NULL, IMAGEX_ALLOW_OTHER_OPTION},
 330         {NULL, 0, NULL, 0},
 331 };
 332
 333 static const struct option optimize_options[] = {
 334         {T("check"),      no_argument, NULL, IMAGEX_CHECK_OPTION},
 335         {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
 336         {T("threads"),    required_argument, NULL, IMAGEX_THREADS_OPTION},
 337         {NULL, 0, NULL, 0},
 338 };
 339
 340 static const struct option split_options[] = {
 341         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
 342         {NULL, 0, NULL, 0},
 343 };
 344
 345 static const struct option unmount_options[] = {
 346         {T("commit"),  no_argument, NULL, IMAGEX_COMMIT_OPTION},
 347         {T("check"),   no_argument, NULL, IMAGEX_CHECK_OPTION},
 348         {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
 349         {T("lazy"),    no_argument, NULL, IMAGEX_LAZY_OPTION},
 350         {NULL, 0, NULL, 0},
 351 };
 352
 353 static const struct option update_options[] = {
 354         /* Careful: some of the options here set the defaults for update
 355          * commands, but the flags given to an actual update command (and not to
 356          * `imagex update' itself are also handled in
 357          * update_command_add_option().  */
 358         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
 359         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
 360         {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
 361         {T("command"),     required_argument, NULL, IMAGEX_COMMAND_OPTION},
 362
 363         /* Default delete options */
 364         {T("force"),       no_argument,       NULL, IMAGEX_FORCE_OPTION},
 365         {T("recursive"),   no_argument,       NULL, IMAGEX_RECURSIVE_OPTION},
 366
 367         /* Global add option */
 368         {T("config"),      required_argument, NULL, IMAGEX_CONFIG_OPTION},
 369
 370         /* Default add options */
 371         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
 372         {T("dereference"), no_argument,       NULL, IMAGEX_DEREFERENCE_OPTION},
 373         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
 374         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 375         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
 376         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
 377
 378         {NULL, 0, NULL, 0},
 379 };
 380
 381 /* Print formatted error message to stderr. */
 382 static void
 383 imagex_error(const tchar *format, ...)
 384 {
 385         va_list va;
 386         va_start(va, format);
 387         tfputs(T("ERROR: "), stderr);
 388         tvfprintf(stderr, format, va);
 389         tputc(T('\n'), stderr);
 390         va_end(va);
 391 }
 392
 393 /* Print formatted error message to stderr. */
 394 static void
 395 imagex_error_with_errno(const tchar *format, ...)
 396 {
 397         int errno_save = errno;
 398         va_list va;
 399         va_start(va, format);
 400         tfputs(T("ERROR: "), stderr);
 401         tvfprintf(stderr, format, va);
 402         tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
 403         va_end(va);
 404 }
 405
 406 static int
 407 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
 408 {
 409         if (image == WIMLIB_NO_IMAGE) {
 410                 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
 411                              "       Please specify a 1-based image index or "
 412                              "image name.\n"
 413                              "       You may use `"IMAGEX_PROGNAME" info' to list the images "
 414                              "contained in a WIM."),
 415                              image_name, wim_name);
 416                 return -1;
 417         }
 418         return 0;
 419 }
 420
 421 static int
 422 verify_image_is_single(int image)
 423 {
 424         if (image == WIMLIB_ALL_IMAGES) {
 425                 imagex_error(T("Cannot specify all images for this action!"));
 426                 return -1;
 427         }
 428         return 0;
 429 }
 430
 431 static int
 432 verify_image_exists_and_is_single(int image, const tchar *image_name,
 433                                   const tchar *wim_name)
 434 {
 435         int ret;
 436         ret = verify_image_exists(image, image_name, wim_name);
 437         if (ret == 0)
 438                 ret = verify_image_is_single(image);
 439         return ret;
 440 }
 441
 442 /* Parse the argument to --compress */
 443 static int
 444 get_compression_type(const tchar *optarg)
 445 {
 446         if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
 447                 return WIMLIB_COMPRESSION_TYPE_LZX;
 448         else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
 449                 return WIMLIB_COMPRESSION_TYPE_XPRESS;
 450         else if (!tstrcasecmp(optarg, T("none")))
 451                 return WIMLIB_COMPRESSION_TYPE_NONE;
 452         else {
 453                 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
 454                              "\"maximum\", \"fast\", or \"none\"."), optarg);
 455                 return WIMLIB_COMPRESSION_TYPE_INVALID;
 456         }
 457 }
 458
 459 /* Returns the size of a file given its name, or -1 if the file does not exist
 460  * or its size cannot be determined.  */
 461 static off_t
 462 file_get_size(const tchar *filename)
 463 {
 464         struct stat st;
 465         if (tstat(filename, &st) == 0)
 466                 return st.st_size;
 467         else
 468                 return (off_t)-1;
 469 }
 470
 471 tchar pat_ntfs_log[]                  = T("/$ntfs.log");
 472 tchar pat_hiberfil_sys[]              = T("/hiberfil.sys");
 473 tchar pat_pagefile_sys[]              = T("/pagefile.sys");
 474 tchar pat_system_volume_information[] = T("/System Volume Information");
 475 tchar pat_recycler[]                  = T("/RECYCLER");
 476 tchar pat_windows_csc[]               = T("/Windows/CSC");
 477
 478 tchar *default_pats[] = {
 479         pat_ntfs_log,
 480         pat_hiberfil_sys,
 481         pat_pagefile_sys,
 482         pat_system_volume_information,
 483         pat_recycler,
 484         pat_windows_csc,
 485 };
 486
 487 static struct wimlib_capture_config default_capture_config = {
 488         .exclusion_pats = {
 489                 .num_pats = sizeof(default_pats) / sizeof(*default_pats),
 490                 .pats = default_pats,
 491         },
 492 };
 493
 494 enum {
 495         PARSE_STRING_SUCCESS = 0,
 496         PARSE_STRING_FAILURE = 1,
 497         PARSE_STRING_NONE = 2,
 498 };
 499
 500 /*
 501  * Parses a string token from an array of characters.
 502  *
 503  * Tokens are either whitespace-delimited, or double or single-quoted.
 504  *
 505  * @line_p:  Pointer to the pointer to the line of data.  Will be updated
 506  *           to point past the string token iff the return value is
 507  *           PARSE_STRING_SUCCESS.  If *len_p > 0, (*line_p)[*len_p - 1] must
 508  *           be '\0'.
 509  *
 510  * @len_p:   @len_p initially stores the length of the line of data, which may
 511  *           be 0, and it will be updated to the number of bytes remaining in
 512  *           the line iff the return value is PARSE_STRING_SUCCESS.
 513  *
 514  * @fn_ret:  Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
 515  *           parsed string token will be returned here.
 516  *
 517  * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
 518  *          PARSE_STRING_FAILURE if the data was invalid due to a missing
 519  *          closing quote; or PARSE_STRING_NONE if the line ended before the
 520  *          beginning of a string token was found.
 521  */
 522 static int
 523 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
 524 {
 525         size_t len = *len_p;
 526         tchar *line = *line_p;
 527         tchar *fn;
 528         tchar quote_char;
 529
 530         /* Skip leading whitespace */
 531         for (;;) {
 532                 if (len == 0)
 533                         return PARSE_STRING_NONE;
 534                 if (!istspace(*line) && *line != T('\0'))
 535                         break;
 536                 line++;
 537                 len--;
 538         }
 539         quote_char = *line;
 540         if (quote_char == T('"') || quote_char == T('\'')) {
 541                 /* Quoted string */
 542                 line++;
 543                 len--;
 544                 fn = line;
 545                 line = tmemchr(line, quote_char, len);
 546                 if (!line) {
 547                         imagex_error(T("Missing closing quote: %"TS), fn - 1);
 548                         return PARSE_STRING_FAILURE;
 549                 }
 550         } else {
 551                 /* Unquoted string.  Go until whitespace.  Line is terminated
 552                  * by '\0', so no need to check 'len'. */
 553                 fn = line;
 554                 do {
 555                         line++;
 556                 } while (!istspace(*line) && *line != T('\0'));
 557         }
 558         *line = T('\0');
 559         len -= line - fn;
 560         *len_p = len;
 561         *line_p = line;
 562         *fn_ret = fn;
 563         return PARSE_STRING_SUCCESS;
 564 }
 565
 566 /* Parses a line of data (not an empty line or comment) in the source list file
 567  * format.  (See the man page for 'wimlib-imagex capture' for details on this
 568  * format and the meaning.)
 569  *
 570  * @line:  Line of data to be parsed.  line[len - 1] must be '\0', unless
 571  *         len == 0.  The data in @line will be modified by this function call.
 572  *
 573  * @len:   Length of the line of data.
 574  *
 575  * @source:  On success, the capture source and target described by the line is
 576  *           written into this destination.  Note that it will contain pointers
 577  *           to data in the @line array.
 578  *
 579  * Returns true if the line was valid; false otherwise.  */
 580 static bool
 581 parse_source_list_line(tchar *line, size_t len,
 582                        struct wimlib_capture_source *source)
 583 {
 584         /* SOURCE [DEST] */
 585         int ret;
 586         ret = parse_string(&line, &len, &source->fs_source_path);
 587         if (ret != PARSE_STRING_SUCCESS)
 588                 return false;
 589         ret = parse_string(&line, &len, &source->wim_target_path);
 590         if (ret == PARSE_STRING_NONE)
 591                 source->wim_target_path = source->fs_source_path;
 592         return ret != PARSE_STRING_FAILURE;
 593 }
 594
 595 /* Returns %true if the given line of length @len > 0 is a comment or empty line
 596  * in the source list file format. */
 597 static bool
 598 is_comment_line(const tchar *line, size_t len)
 599 {
 600         for (;;) {
 601                 if (*line == T('#'))
 602                         return true;
 603                 if (!istspace(*line) && *line != T('\0'))
 604                         return false;
 605                 ++line;
 606                 --len;
 607                 if (len == 0)
 608                         return true;
 609         }
 610 }
 611
 612 static ssize_t
 613 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
 614 {
 615         ssize_t nlines = 0;
 616         tchar *contents = *contents_p;
 617         size_t nchars = *nchars_p;
 618         size_t i;
 619
 620         for (i = 0; i < nchars; i++)
 621                 if (contents[i] == T('\n'))
 622                         nlines++;
 623
 624         /* Handle last line not terminated by a newline */
 625         if (nchars != 0 && contents[nchars - 1] != T('\n')) {
 626                 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
 627                 if (!contents) {
 628                         imagex_error(T("Out of memory!"));
 629                         return -1;
 630                 }
 631                 contents[nchars] = T('\n');
 632                 *contents_p = contents;
 633                 nchars++;
 634                 nlines++;
 635         }
 636         *nchars_p = nchars;
 637         return nlines;
 638 }
 639
 640 /* Parses a file in the source list format.  (See the man page for
 641  * 'wimlib-imagex capture' for details on this format and the meaning.)
 642  *
 643  * @source_list_contents:  Contents of the source list file.  Note that this
 644  *                         buffer will be modified to save memory allocations,
 645  *                         and cannot be freed until the returned array of
 646  *                         wimlib_capture_source's has also been freed.
 647  *
 648  * @source_list_nbytes:    Number of bytes of data in the @source_list_contents
 649  *                         buffer.
 650  *
 651  * @nsources_ret:          On success, the length of the returned array is
 652  *                         returned here.
 653  *
 654  * Returns:   An array of `struct wimlib_capture_source's that can be passed to
 655  * the wimlib_add_image_multisource() function to specify how a WIM image is to
 656  * be created.  */
 657 static struct wimlib_capture_source *
 658 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
 659                   size_t *nsources_ret)
 660 {
 661         ssize_t nlines;
 662         tchar *p;
 663         struct wimlib_capture_source *sources;
 664         size_t i, j;
 665
 666         nlines = text_file_count_lines(source_list_contents_p,
 667                                        &source_list_nchars);
 668         if (nlines < 0)
 669                 return NULL;
 670
 671         /* Always allocate at least 1 slot, just in case the implementation of
 672          * calloc() returns NULL if 0 bytes are requested. */
 673         sources = calloc(nlines ?: 1, sizeof(*sources));
 674         if (!sources) {
 675                 imagex_error(T("out of memory"));
 676                 return NULL;
 677         }
 678         p = *source_list_contents_p;
 679         j = 0;
 680         for (i = 0; i < nlines; i++) {
 681                 /* XXX: Could use rawmemchr() here instead, but it may not be
 682                  * available on all platforms. */
 683                 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
 684                 size_t len = endp - p + 1;
 685                 *endp = T('\0');
 686                 if (!is_comment_line(p, len)) {
 687                         if (!parse_source_list_line(p, len, &sources[j++])) {
 688                                 free(sources);
 689                                 return NULL;
 690                         }
 691                 }
 692                 p = endp + 1;
 693
 694         }
 695         *nsources_ret = j;
 696         return sources;
 697 }
 698
 699
 700 enum capture_config_section {
 701         CAPTURE_CONFIG_NO_SECTION,
 702         CAPTURE_CONFIG_EXCLUSION_SECTION,
 703         CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
 704         CAPTURE_CONFIG_IGNORE_SECTION,
 705 };
 706
 707 enum {
 708         CAPTURE_CONFIG_INVALID_SECTION,
 709         CAPTURE_CONFIG_CHANGED_SECTION,
 710         CAPTURE_CONFIG_SAME_SECTION,
 711 };
 712
 713 static int
 714 check_config_section(tchar *line, size_t len,
 715                      enum capture_config_section *cur_section)
 716 {
 717         while (istspace(*line))
 718                 line++;
 719
 720         if (*line != T('['))
 721                 return CAPTURE_CONFIG_SAME_SECTION;
 722
 723         line++;
 724         tchar *endbrace = tstrrchr(line, T(']'));
 725         if (!endbrace)
 726                 return CAPTURE_CONFIG_SAME_SECTION;
 727
 728         if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
 729                 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
 730         } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
 731                 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
 732         } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
 733                 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
 734                 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
 735                          "of capture config file\n"),
 736                        stderr);
 737         } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
 738                 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
 739                 tfputs(T("WARNING: Ignoring [AlignmentList] section "
 740                          "of capture config file\n"),
 741                        stderr);
 742         } else {
 743                 imagex_error(T("Invalid capture config file section \"%"TS"\""),
 744                              line - 1);
 745                 return CAPTURE_CONFIG_INVALID_SECTION;
 746         }
 747         return CAPTURE_CONFIG_CHANGED_SECTION;
 748 }
 749
 750
 751 static bool
 752 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
 753                          tchar *pat)
 754 {
 755         if (pat_list->num_pats == pat_list->num_allocated_pats) {
 756                 tchar **pats;
 757                 size_t num_allocated_pats = pat_list->num_pats + 8;
 758
 759                 pats = realloc(pat_list->pats,
 760                                num_allocated_pats * sizeof(pat_list->pats[0]));
 761                 if (!pats) {
 762                         imagex_error(T("Out of memory!"));
 763                         return false;
 764                 }
 765                 pat_list->pats = pats;
 766                 pat_list->num_allocated_pats = num_allocated_pats;
 767         }
 768         pat_list->pats[pat_list->num_pats++] = pat;
 769         return true;
 770 }
 771
 772 static bool
 773 parse_capture_config_line(tchar *line, size_t len,
 774                           enum capture_config_section *cur_section,
 775                           struct wimlib_capture_config *config)
 776 {
 777         tchar *filename;
 778         int ret;
 779
 780         ret = check_config_section(line, len, cur_section);
 781         if (ret == CAPTURE_CONFIG_INVALID_SECTION)
 782                 return false;
 783         if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
 784                 return true;
 785
 786         switch (*cur_section) {
 787         case CAPTURE_CONFIG_NO_SECTION:
 788                 imagex_error(T("Line \"%"TS"\" is not in a section "
 789                                "(such as [ExclusionList]"), line);
 790                 return false;
 791         case CAPTURE_CONFIG_EXCLUSION_SECTION:
 792                 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
 793                         return false;
 794                 return pattern_list_add_pattern(&config->exclusion_pats,
 795                                                 filename);
 796         case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
 797                 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
 798                         return false;
 799                 return pattern_list_add_pattern(&config->exclusion_exception_pats,
 800                                                 filename);
 801         case CAPTURE_CONFIG_IGNORE_SECTION:
 802                 return true;
 803         }
 804         return false;
 805 }
 806
 807 static int
 808 parse_capture_config(tchar **contents_p, size_t nchars,
 809                      struct wimlib_capture_config *config)
 810 {
 811         ssize_t nlines;
 812         tchar *p;
 813         size_t i;
 814         enum capture_config_section cur_section;
 815
 816         memset(config, 0, sizeof(*config));
 817
 818         nlines = text_file_count_lines(contents_p, &nchars);
 819         if (nlines < 0)
 820                 return -1;
 821
 822         cur_section = CAPTURE_CONFIG_NO_SECTION;
 823         p = *contents_p;
 824         for (i = 0; i < nlines; i++) {
 825                 tchar *endp = tmemchr(p, T('\n'), nchars);
 826                 size_t len = endp - p + 1;
 827                 *endp = T('\0');
 828                 if (!is_comment_line(p, len))
 829                         if (!parse_capture_config_line(p, len, &cur_section, config))
 830                                 return -1;
 831                 p = endp + 1;
 832
 833         }
 834         return 0;
 835 }
 836
 837 /* Reads the contents of a file into memory. */
 838 static char *
 839 file_get_contents(const tchar *filename, size_t *len_ret)
 840 {
 841         struct stat stbuf;
 842         void *buf = NULL;
 843         size_t len;
 844         FILE *fp;
 845
 846         if (tstat(filename, &stbuf) != 0) {
 847                 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
 848                 goto out;
 849         }
 850         len = stbuf.st_size;
 851
 852         fp = tfopen(filename, T("rb"));
 853         if (!fp) {
 854                 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
 855                 goto out;
 856         }
 857
 858         buf = malloc(len);
 859         if (!buf) {
 860                 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
 861                                "contents of file \"%"TS"\""), len, filename);
 862                 goto out_fclose;
 863         }
 864         if (fread(buf, 1, len, fp) != len) {
 865                 imagex_error_with_errno(T("Failed to read %zu bytes from the "
 866                                           "file \"%"TS"\""), len, filename);
 867                 goto out_free_buf;
 868         }
 869         *len_ret = len;
 870         goto out_fclose;
 871 out_free_buf:
 872         free(buf);
 873         buf = NULL;
 874 out_fclose:
 875         fclose(fp);
 876 out:
 877         return buf;
 878 }
 879
 880 /* Read standard input until EOF and return the full contents in a malloc()ed
 881  * buffer and the number of bytes of data in @len_ret.  Returns NULL on read
 882  * error. */
 883 static char *
 884 stdin_get_contents(size_t *len_ret)
 885 {
 886         /* stdin can, of course, be a pipe or other non-seekable file, so the
 887          * total length of the data cannot be pre-determined */
 888         char *buf = NULL;
 889         size_t newlen = 1024;
 890         size_t pos = 0;
 891         size_t inc = 1024;
 892         for (;;) {
 893                 char *p = realloc(buf, newlen);
 894                 size_t bytes_read, bytes_to_read;
 895                 if (!p) {
 896                         imagex_error(T("out of memory while reading stdin"));
 897                         break;
 898                 }
 899                 buf = p;
 900                 bytes_to_read = newlen - pos;
 901                 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
 902                 pos += bytes_read;
 903                 if (bytes_read != bytes_to_read) {
 904                         if (feof(stdin)) {
 905                                 *len_ret = pos;
 906                                 return buf;
 907                         } else {
 908                                 imagex_error_with_errno(T("error reading stdin"));
 909                                 break;
 910                         }
 911                 }
 912                 newlen += inc;
 913                 inc *= 3;
 914                 inc /= 2;
 915         }
 916         free(buf);
 917         return NULL;
 918 }
 919
 920
 921 static tchar *
 922 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
 923 {
 924 #ifndef __WIN32__
 925         /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
 926          * */
 927         *num_tchars_ret = num_bytes;
 928         return text;
 929 #else /* !__WIN32__ */
 930         /* On Windows, translate the text to UTF-16LE */
 931         wchar_t *text_wstr;
 932         size_t num_wchars;
 933
 934         if (num_bytes >= 2 &&
 935             ((text[0] == 0xff && text[1] == 0xfe) ||
 936              (text[0] <= 0x7f && text[1] == 0x00)))
 937         {
 938                 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
 939                  * with something that looks like an ASCII character encoded as
 940                  * a UTF-16LE code unit.  Assume the file is encoded as
 941                  * UTF-16LE.  This is not a 100% reliable check. */
 942                 num_wchars = num_bytes / 2;
 943                 text_wstr = (wchar_t*)text;
 944         } else {
 945                 /* File does not look like UTF-16LE.  Assume it is encoded in
 946                  * the current Windows code page.  I think these are always
 947                  * ASCII-compatible, so any so-called "plain-text" (ASCII) files
 948                  * should work as expected. */
 949                 text_wstr = win32_mbs_to_wcs(text,
 950                                              num_bytes,
 951                                              &num_wchars);
 952                 free(text);
 953         }
 954         *num_tchars_ret = num_wchars;
 955         return text_wstr;
 956 #endif /* __WIN32__ */
 957 }
 958
 959 static tchar *
 960 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
 961 {
 962         char *contents;
 963         size_t num_bytes;
 964
 965         contents = file_get_contents(filename, &num_bytes);
 966         if (!contents)
 967                 return NULL;
 968         return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
 969 }
 970
 971 static tchar *
 972 stdin_get_text_contents(size_t *num_tchars_ret)
 973 {
 974         char *contents;
 975         size_t num_bytes;
 976
 977         contents = stdin_get_contents(&num_bytes);
 978         if (!contents)
 979                 return NULL;
 980         return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
 981 }
 982
 983 #define TO_PERCENT(numerator, denominator) \
 984         (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
 985
 986 /* Given an enumerated value for WIM compression type, return a descriptive
 987  * string. */
 988 static const tchar *
 989 get_data_type(int ctype)
 990 {
 991         switch (ctype) {
 992         case WIMLIB_COMPRESSION_TYPE_NONE:
 993                 return T("uncompressed");
 994         case WIMLIB_COMPRESSION_TYPE_LZX:
 995                 return T("LZX-compressed");
 996         case WIMLIB_COMPRESSION_TYPE_XPRESS:
 997                 return T("XPRESS-compressed");
 998         }
 999         return NULL;
1000 }
1001
1002 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1003 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1004 #define KIBIBYTE_MIN_NBYTES 10000ULL
1005
1006 static unsigned
1007 get_unit(uint64_t total_bytes, const tchar **name_ret)
1008 {
1009         if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1010                 *name_ret = T("GiB");
1011                 return 30;
1012         } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1013                 *name_ret = T("MiB");
1014                 return 20;
1015         } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1016                 *name_ret = T("KiB");
1017                 return 10;
1018         } else {
1019                 *name_ret = T("bytes");
1020                 return 0;
1021         }
1022 }
1023
1024 /* Progress callback function passed to various wimlib functions. */
1025 static int
1026 imagex_progress_func(enum wimlib_progress_msg msg,
1027                      const union wimlib_progress_info *info)
1028 {
1029         unsigned percent_done;
1030         unsigned unit_shift;
1031         const tchar *unit_name;
1032         if (imagex_be_quiet)
1033                 return 0;
1034         switch (msg) {
1035         case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1036                 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1037                 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1038                                           info->write_streams.total_bytes);
1039                 if (info->write_streams.completed_streams == 0) {
1040                         const tchar *data_type;
1041
1042                         data_type = get_data_type(info->write_streams.compression_type);
1043                         tprintf(T("Writing %"TS" data using %u thread%"TS"\n"),
1044                                 data_type, info->write_streams.num_threads,
1045                                 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1046                 }
1047                 tprintf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1048                         "written (%u%% done)"),
1049                         info->write_streams.completed_bytes >> unit_shift,
1050                         unit_name,
1051                         info->write_streams.total_bytes >> unit_shift,
1052                         unit_name,
1053                         percent_done);
1054                 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1055                         tputchar(T('\n'));
1056                 break;
1057         case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1058                 tprintf(T("Scanning \"%"TS"\""), info->scan.source);
1059                 if (*info->scan.wim_target_path) {
1060                         tprintf(T(" (loading as WIM path: "
1061                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1062                                info->scan.wim_target_path);
1063                 } else {
1064                         tprintf(T(" (loading as root of WIM image)...\n"));
1065                 }
1066                 break;
1067         case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1068                 if (info->scan.excluded)
1069                         tprintf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1070                 else
1071                         tprintf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1072                 break;
1073         /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
1074                 /*break;*/
1075         case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1076                 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1077                 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1078                                           info->integrity.total_bytes);
1079                 tprintf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1080                         "of %"PRIu64" %"TS" (%u%%) done"),
1081                         info->integrity.filename,
1082                         info->integrity.completed_bytes >> unit_shift,
1083                         unit_name,
1084                         info->integrity.total_bytes >> unit_shift,
1085                         unit_name,
1086                         percent_done);
1087                 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1088                         tputchar(T('\n'));
1089                 break;
1090         case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1091                 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1092                 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1093                                           info->integrity.total_bytes);
1094                 tprintf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1095                           "of %"PRIu64" %"TS" (%u%%) done"),
1096                         info->integrity.completed_bytes >> unit_shift,
1097                         unit_name,
1098                         info->integrity.total_bytes >> unit_shift,
1099                         unit_name,
1100                         percent_done);
1101                 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1102                         tputchar(T('\n'));
1103                 break;
1104         case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1105                 tprintf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1106                           "to %"TS" \"%"TS"\"\n"),
1107                         info->extract.image,
1108                         info->extract.image_name,
1109                         info->extract.wimfile_name,
1110                         ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1111                          T("NTFS volume") : T("directory")),
1112                         info->extract.target);
1113                 break;
1114         case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1115                 tprintf(T("Extracting "
1116                           "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1117                           "in \"%"TS"\" to \"%"TS"\"\n"),
1118                         info->extract.extract_root_wim_source_path,
1119                         info->extract.image,
1120                         info->extract.image_name,
1121                         info->extract.wimfile_name,
1122                         info->extract.target);
1123                 break;
1124         /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
1125                 /*tprintf(T("Applying directory structure to %"TS"\n"),*/
1126                         /*info->extract.target);*/
1127                 /*break;*/
1128         case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1129                 percent_done = TO_PERCENT(info->extract.completed_bytes,
1130                                           info->extract.total_bytes);
1131                 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1132                 tprintf(T("\rExtracting files: "
1133                           "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1134                         info->extract.completed_bytes >> unit_shift,
1135                         unit_name,
1136                         info->extract.total_bytes >> unit_shift,
1137                         unit_name,
1138                         percent_done);
1139                 if (info->extract.completed_bytes >= info->extract.total_bytes)
1140                         tputchar(T('\n'));
1141                 break;
1142         case WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY:
1143                 tprintf(T("%"TS"\n"), info->extract.cur_path);
1144                 break;
1145         case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1146                 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1147                         tprintf(T("Setting timestamps on all extracted files...\n"));
1148                 break;
1149         case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1150                 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1151                         tprintf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1152                                 info->extract.target);
1153                 }
1154                 break;
1155         case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
1156                 percent_done = TO_PERCENT(info->join.completed_bytes,
1157                                           info->join.total_bytes);
1158                 unit_shift = get_unit(info->join.total_bytes, &unit_name);
1159                 tprintf(T("Writing resources from part %u of %u: "
1160                           "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written\n"),
1161                         (info->join.completed_parts == info->join.total_parts) ?
1162                         info->join.completed_parts : info->join.completed_parts + 1,
1163                         info->join.total_parts,
1164                         info->join.completed_bytes >> unit_shift,
1165                         unit_name,
1166                         info->join.total_bytes >> unit_shift,
1167                         unit_name,
1168                         percent_done);
1169                 break;
1170         case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1171                 percent_done = TO_PERCENT(info->split.completed_bytes,
1172                                           info->split.total_bytes);
1173                 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1174                 tprintf(T("Writing \"%"TS"\": %"PRIu64" %"TS" of "
1175                           "%"PRIu64" %"TS" (%u%%) written\n"),
1176                         info->split.part_name,
1177                         info->split.completed_bytes >> unit_shift,
1178                         unit_name,
1179                         info->split.total_bytes >> unit_shift,
1180                         unit_name,
1181                         percent_done);
1182                 break;
1183         case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1184                 if (info->split.completed_bytes == info->split.total_bytes) {
1185                         tprintf(T("Finished writing %u split WIM parts\n"),
1186                                 info->split.cur_part_number);
1187                 }
1188                 break;
1189         case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1190                 switch (info->update.command->op) {
1191                 case WIMLIB_UPDATE_OP_DELETE:
1192                         tprintf(T("Deleted WIM path "
1193                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1194                                 info->update.command->delete.wim_path);
1195                         break;
1196                 case WIMLIB_UPDATE_OP_RENAME:
1197                         tprintf(T("Renamed WIM path "
1198                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1199                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1200                                 info->update.command->rename.wim_source_path,
1201                                 info->update.command->rename.wim_target_path);
1202                         break;
1203                 case WIMLIB_UPDATE_OP_ADD:
1204                 default:
1205                         break;
1206                 }
1207                 break;
1208         default:
1209                 break;
1210         }
1211         fflush(stdout);
1212         return 0;
1213 }
1214
1215 /* Open all the split WIM parts that correspond to a file glob.
1216  *
1217  * @first_part specifies the first part of the split WIM and it may be either
1218  * included or omitted from the glob. */
1219 static int
1220 open_swms_from_glob(const tchar *swm_glob,
1221                     const tchar *first_part,
1222                     int open_flags,
1223                     WIMStruct ***additional_swms_ret,
1224                     unsigned *num_additional_swms_ret)
1225 {
1226         unsigned num_additional_swms = 0;
1227         WIMStruct **additional_swms = NULL;
1228         glob_t globbuf;
1229         int ret;
1230
1231         /* Warning: glob() is replaced in Windows native builds */
1232         ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
1233         if (ret != 0) {
1234                 if (ret == GLOB_NOMATCH) {
1235                         imagex_error(T("Found no files for glob \"%"TS"\""),
1236                                      swm_glob);
1237                 } else {
1238                         imagex_error_with_errno(T("Failed to process glob \"%"TS"\""),
1239                                                 swm_glob);
1240                 }
1241                 ret = -1;
1242                 goto out;
1243         }
1244         num_additional_swms = globbuf.gl_pathc;
1245         additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
1246         if (!additional_swms) {
1247                 imagex_error(T("Out of memory"));
1248                 ret = -1;
1249                 goto out_globfree;
1250         }
1251         unsigned offset = 0;
1252         for (unsigned i = 0; i < num_additional_swms; i++) {
1253                 if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) {
1254                         offset++;
1255                         continue;
1256                 }
1257                 ret = wimlib_open_wim(globbuf.gl_pathv[i],
1258                                       open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
1259                                       &additional_swms[i - offset],
1260                                       imagex_progress_func);
1261                 if (ret != 0)
1262                         goto out_close_swms;
1263         }
1264         *additional_swms_ret = additional_swms;
1265         *num_additional_swms_ret = num_additional_swms - offset;
1266         ret = 0;
1267         goto out_globfree;
1268 out_close_swms:
1269         for (unsigned i = 0; i < num_additional_swms; i++)
1270                 wimlib_free(additional_swms[i]);
1271         free(additional_swms);
1272 out_globfree:
1273         globfree(&globbuf);
1274 out:
1275         return ret;
1276 }
1277
1278
1279 static unsigned
1280 parse_num_threads(const tchar *optarg)
1281 {
1282         tchar *tmp;
1283         unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1284         if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1285                 imagex_error(T("Number of threads must be a non-negative integer!"));
1286                 return UINT_MAX;
1287         } else {
1288                 return ul_nthreads;
1289         }
1290 }
1291
1292 /*
1293  * Parse an option passed to an update command.
1294  *
1295  * @op:         One of WIMLIB_UPDATE_OP_* that indicates the command being
1296  *              parsed.
1297  *
1298  * @option:     Text string for the option (beginning with --)
1299  *
1300  * @cmd:        `struct wimlib_update_command' that is being constructed for
1301  *              this command.
1302  *
1303  * Returns true if the option was recognized; false if not.
1304  */
1305 static bool
1306 update_command_add_option(int op, const tchar *option,
1307                           struct wimlib_update_command *cmd)
1308 {
1309         bool recognized = true;
1310         switch (op) {
1311         case WIMLIB_UPDATE_OP_ADD:
1312                 if (!tstrcmp(option, T("--verbose")))
1313                         cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1314                 else if (!tstrcmp(option, T("--unix-data")))
1315                         cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1316                 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1317                         cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1318                 else if (!tstrcmp(option, T("--strict-acls")))
1319                         cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1320                 else if (!tstrcmp(option, T("--dereference")))
1321                         cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1322                 else
1323                         recognized = false;
1324                 break;
1325         case WIMLIB_UPDATE_OP_DELETE:
1326                 if (!tstrcmp(option, T("--force")))
1327                         cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1328                 else if (!tstrcmp(option, T("--recursive")))
1329                         cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1330                 else
1331                         recognized = false;
1332                 break;
1333         default:
1334                 recognized = false;
1335                 break;
1336         }
1337         return recognized;
1338 }
1339
1340 /* How many nonoption arguments each `imagex update' command expects */
1341 static const unsigned update_command_num_nonoptions[] = {
1342         [WIMLIB_UPDATE_OP_ADD] = 2,
1343         [WIMLIB_UPDATE_OP_DELETE] = 1,
1344         [WIMLIB_UPDATE_OP_RENAME] = 2,
1345 };
1346
1347 static void
1348 update_command_add_nonoption(int op, const tchar *nonoption,
1349                              struct wimlib_update_command *cmd,
1350                              unsigned num_nonoptions)
1351 {
1352         switch (op) {
1353         case WIMLIB_UPDATE_OP_ADD:
1354                 if (num_nonoptions == 0)
1355                         cmd->add.fs_source_path = (tchar*)nonoption;
1356                 else
1357                         cmd->add.wim_target_path = (tchar*)nonoption;
1358                 break;
1359         case WIMLIB_UPDATE_OP_DELETE:
1360                 cmd->delete.wim_path = (tchar*)nonoption;
1361                 break;
1362         case WIMLIB_UPDATE_OP_RENAME:
1363                 if (num_nonoptions == 0)
1364                         cmd->rename.wim_source_path = (tchar*)nonoption;
1365                 else
1366                         cmd->rename.wim_target_path = (tchar*)nonoption;
1367                 break;
1368         }
1369 }
1370
1371 /*
1372  * Parse a command passed on stdin to `imagex update'.
1373  *
1374  * @line:       Text of the command.
1375  * @len:        Length of the line, including a null terminator
1376  *              at line[len - 1].
1377  *
1378  * @command:    A `struct wimlib_update_command' to fill in from the parsed
1379  *              line.
1380  *
1381  * @line_number: Line number of the command, for diagnostics.
1382  *
1383  * Returns true on success; returns false on parse error.
1384  */
1385 static bool
1386 parse_update_command(tchar *line, size_t len,
1387                      struct wimlib_update_command *command,
1388                      size_t line_number)
1389 {
1390         int ret;
1391         tchar *command_name;
1392         int op;
1393         size_t num_nonoptions;
1394
1395         /* Get the command name ("add", "delete", "rename") */
1396         ret = parse_string(&line, &len, &command_name);
1397         if (ret != PARSE_STRING_SUCCESS)
1398                 return false;
1399
1400         if (!tstrcasecmp(command_name, T("add"))) {
1401                 op = WIMLIB_UPDATE_OP_ADD;
1402         } else if (!tstrcasecmp(command_name, T("delete"))) {
1403                 op = WIMLIB_UPDATE_OP_DELETE;
1404         } else if (!tstrcasecmp(command_name, T("rename"))) {
1405                 op = WIMLIB_UPDATE_OP_RENAME;
1406         } else {
1407                 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1408                              command_name, line_number);
1409                 return false;
1410         }
1411         command->op = op;
1412
1413         /* Parse additional options and non-options as needed */
1414         num_nonoptions = 0;
1415         for (;;) {
1416                 tchar *next_string;
1417
1418                 ret = parse_string(&line, &len, &next_string);
1419                 if (ret == PARSE_STRING_NONE) /* End of line */
1420                         break;
1421                 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1422                         return false;
1423                 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1424                         /* Option */
1425                         if (!update_command_add_option(op, next_string, command))
1426                         {
1427                                 imagex_error(T("Unrecognized option \"%"TS"\" to "
1428                                                "update command \"%"TS"\" on line %zu"),
1429                                              next_string, command_name, line_number);
1430
1431                                 return false;
1432                         }
1433                 } else {
1434                         /* Nonoption */
1435                         if (num_nonoptions == update_command_num_nonoptions[op])
1436                         {
1437                                 imagex_error(T("Unexpected argument \"%"TS"\" in "
1438                                                "update command on line %zu\n"
1439                                                "       (The \"%"TS"\" command only "
1440                                                "takes %u nonoption arguments!)\n"),
1441                                              next_string, line_number,
1442                                              command_name, num_nonoptions);
1443                                 return false;
1444                         }
1445                         update_command_add_nonoption(op, next_string,
1446                                                      command, num_nonoptions);
1447                         num_nonoptions++;
1448                 }
1449         }
1450
1451         if (num_nonoptions != update_command_num_nonoptions[op]) {
1452                 imagex_error(T("Not enough arguments to update command "
1453                                "\"%"TS"\" on line %zu"), command_name, line_number);
1454                 return false;
1455         }
1456         return true;
1457 }
1458
1459 static struct wimlib_update_command *
1460 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1461                           size_t *num_cmds_ret)
1462 {
1463         ssize_t nlines;
1464         tchar *p;
1465         struct wimlib_update_command *cmds;
1466         size_t i, j;
1467
1468         nlines = text_file_count_lines(cmd_file_contents_p,
1469                                        &cmd_file_nchars);
1470         if (nlines < 0)
1471                 return NULL;
1472
1473         /* Always allocate at least 1 slot, just in case the implementation of
1474          * calloc() returns NULL if 0 bytes are requested. */
1475         cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1476         if (!cmds) {
1477                 imagex_error(T("out of memory"));
1478                 return NULL;
1479         }
1480         p = *cmd_file_contents_p;
1481         j = 0;
1482         for (i = 0; i < nlines; i++) {
1483                 /* XXX: Could use rawmemchr() here instead, but it may not be
1484                  * available on all platforms. */
1485                 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1486                 size_t len = endp - p + 1;
1487                 *endp = T('\0');
1488                 if (!is_comment_line(p, len)) {
1489                         if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1490                                 free(cmds);
1491                                 return NULL;
1492                         }
1493                 }
1494                 p = endp + 1;
1495         }
1496         *num_cmds_ret = j;
1497         return cmds;
1498 }
1499
1500 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1501  * one image from a WIM file to a NTFS volume. */
1502 static int
1503 imagex_apply(int argc, tchar **argv)
1504 {
1505         int c;
1506         int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1507         int image;
1508         int num_images;
1509         WIMStruct *w;
1510         int ret;
1511         const tchar *wimfile;
1512         const tchar *target;
1513         const tchar *image_num_or_name;
1514         int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1515
1516         const tchar *swm_glob = NULL;
1517         WIMStruct **additional_swms = NULL;
1518         unsigned num_additional_swms = 0;
1519
1520         for_opt(c, apply_options) {
1521                 switch (c) {
1522                 case IMAGEX_CHECK_OPTION:
1523                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1524                         break;
1525                 case IMAGEX_HARDLINK_OPTION:
1526                         extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1527                         break;
1528                 case IMAGEX_SYMLINK_OPTION:
1529                         extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1530                         break;
1531                 case IMAGEX_VERBOSE_OPTION:
1532                         extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1533                         break;
1534                 case IMAGEX_REF_OPTION:
1535                         swm_glob = optarg;
1536                         break;
1537                 case IMAGEX_UNIX_DATA_OPTION:
1538                         extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1539                         break;
1540                 case IMAGEX_NO_ACLS_OPTION:
1541                         extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1542                         break;
1543                 case IMAGEX_STRICT_ACLS_OPTION:
1544                         extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1545                         break;
1546                 case IMAGEX_NORPFIX_OPTION:
1547                         extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1548                         break;
1549                 case IMAGEX_RPFIX_OPTION:
1550                         extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1551                         break;
1552                 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1553                         extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1554                         extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1555                         break;
1556                 default:
1557                         usage(APPLY);
1558                         return -1;
1559                 }
1560         }
1561         argc -= optind;
1562         argv += optind;
1563         if (argc != 2 && argc != 3) {
1564                 usage(APPLY);
1565                 return -1;
1566         }
1567
1568         wimfile = argv[0];
1569         if (argc == 2) {
1570                 image_num_or_name = T("1");
1571                 target = argv[1];
1572         } else {
1573                 image_num_or_name = argv[1];
1574                 target = argv[2];
1575         }
1576
1577         ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func);
1578         if (ret != 0)
1579                 return ret;
1580
1581         image = wimlib_resolve_image(w, image_num_or_name);
1582         ret = verify_image_exists(image, image_num_or_name, wimfile);
1583         if (ret != 0)
1584                 goto out;
1585
1586         num_images = wimlib_get_num_images(w);
1587         if (argc == 2 && num_images != 1) {
1588                 imagex_error(T("\"%"TS"\" contains %d images; Please select one "
1589                                "(or all)."), wimfile, num_images);
1590                 usage(APPLY);
1591                 ret = -1;
1592                 goto out;
1593         }
1594
1595         if (swm_glob) {
1596                 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1597                                           &additional_swms,
1598                                           &num_additional_swms);
1599                 if (ret != 0)
1600                         goto out;
1601         }
1602
1603         struct stat stbuf;
1604
1605         ret = tstat(target, &stbuf);
1606         if (ret == 0) {
1607                 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1608                         extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1609         } else {
1610                 if (errno != ENOENT) {
1611                         imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1612                                                 target);
1613                         ret = -1;
1614                         goto out;
1615                 }
1616         }
1617
1618 #ifdef __WIN32__
1619         win32_acquire_restore_privileges();
1620 #endif
1621         ret = wimlib_extract_image(w, image, target, extract_flags,
1622                                    additional_swms, num_additional_swms,
1623                                    imagex_progress_func);
1624         if (ret == 0)
1625                 tprintf(T("Done applying WIM image.\n"));
1626 #ifdef __WIN32__
1627         win32_release_restore_privileges();
1628 #endif
1629 out:
1630         wimlib_free(w);
1631         if (additional_swms) {
1632                 for (unsigned i = 0; i < num_additional_swms; i++)
1633                         wimlib_free(additional_swms[i]);
1634                 free(additional_swms);
1635         }
1636         return ret;
1637 }
1638
1639 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1640  * directory trees.  'wimlib-imagex capture': create a new WIM file containing
1641  * the desired image.  'wimlib-imagex append': add a new image to an existing
1642  * WIM file. */
1643 static int
1644 imagex_capture_or_append(int argc, tchar **argv)
1645 {
1646         int c;
1647         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1648         int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
1649         int write_flags = 0;
1650         int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
1651         const tchar *wimfile;
1652         const tchar *name;
1653         const tchar *desc;
1654         const tchar *flags_element = NULL;
1655         WIMStruct *w;
1656         int ret;
1657         int cur_image;
1658         int cmd = tstrcmp(argv[0], T("append")) ? CAPTURE : APPEND;
1659         unsigned num_threads = 0;
1660
1661         tchar *source;
1662         size_t source_name_len;
1663         tchar *source_copy;
1664
1665         const tchar *config_file = NULL;
1666         tchar *config_str;
1667         struct wimlib_capture_config *config = NULL;
1668
1669         bool source_list = false;
1670         size_t source_list_nchars;
1671         tchar *source_list_contents;
1672         bool capture_sources_malloced;
1673         struct wimlib_capture_source *capture_sources;
1674         size_t num_sources;
1675         bool name_defaulted;
1676
1677         for_opt(c, capture_or_append_options) {
1678                 switch (c) {
1679                 case IMAGEX_BOOT_OPTION:
1680                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1681                         break;
1682                 case IMAGEX_CHECK_OPTION:
1683                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1684                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1685                         break;
1686                 case IMAGEX_CONFIG_OPTION:
1687                         config_file = optarg;
1688                         break;
1689                 case IMAGEX_COMPRESS_OPTION:
1690                         compression_type = get_compression_type(optarg);
1691                         if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1692                                 return -1;
1693                         break;
1694                 case IMAGEX_FLAGS_OPTION:
1695                         flags_element = optarg;
1696                         break;
1697                 case IMAGEX_DEREFERENCE_OPTION:
1698                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1699                         break;
1700                 case IMAGEX_VERBOSE_OPTION:
1701                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1702                         break;
1703                 case IMAGEX_THREADS_OPTION:
1704                         num_threads = parse_num_threads(optarg);
1705                         if (num_threads == UINT_MAX)
1706                                 return -1;
1707                         break;
1708                 case IMAGEX_REBUILD_OPTION:
1709                         write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1710                         break;
1711                 case IMAGEX_UNIX_DATA_OPTION:
1712                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1713                         break;
1714                 case IMAGEX_SOURCE_LIST_OPTION:
1715                         source_list = true;
1716                         break;
1717                 case IMAGEX_NO_ACLS_OPTION:
1718                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1719                         break;
1720                 case IMAGEX_STRICT_ACLS_OPTION:
1721                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1722                         break;
1723                 case IMAGEX_RPFIX_OPTION:
1724                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1725                         break;
1726                 case IMAGEX_NORPFIX_OPTION:
1727                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1728                         break;
1729                 default:
1730                         usage(cmd);
1731                         return -1;
1732                 }
1733         }
1734         argc -= optind;
1735         argv += optind;
1736
1737         if (argc < 2 || argc > 4) {
1738                 usage(cmd);
1739                 return -1;
1740         }
1741
1742         source = argv[0];
1743         wimfile = argv[1];
1744
1745         if (argc >= 3) {
1746                 name = argv[2];
1747                 name_defaulted = false;
1748         } else {
1749                 /* Set default name to SOURCE argument, omitting any directory
1750                  * prefixes and trailing slashes.  This requires making a copy
1751                  * of @source.  Leave some free characters at the end in case we
1752                  * append a number to keep the name unique. */
1753                 source_name_len = tstrlen(source);
1754                 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1755                 name = tbasename(tstrcpy(source_copy, source));
1756                 name_defaulted = true;
1757         }
1758         /* Image description defaults to NULL if not given. */
1759         desc = (argc >= 4) ? argv[3] : NULL;
1760
1761         if (source_list) {
1762                 /* Set up capture sources in source list mode */
1763                 if (source[0] == T('-') && source[1] == T('\0')) {
1764                         source_list_contents = stdin_get_text_contents(&source_list_nchars);
1765                 } else {
1766                         source_list_contents = file_get_text_contents(source,
1767                                                                       &source_list_nchars);
1768                 }
1769                 if (!source_list_contents)
1770                         return -1;
1771
1772                 capture_sources = parse_source_list(&source_list_contents,
1773                                                     source_list_nchars,
1774                                                     &num_sources);
1775                 if (!capture_sources) {
1776                         ret = -1;
1777                         goto out_free_source_list_contents;
1778                 }
1779                 capture_sources_malloced = true;
1780         } else {
1781                 /* Set up capture source in non-source-list mode (could be
1782                  * either "normal" mode or "NTFS mode"--- see the man page). */
1783                 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1784                 capture_sources[0].fs_source_path = source;
1785                 capture_sources[0].wim_target_path = NULL;
1786                 capture_sources[0].reserved = 0;
1787                 num_sources = 1;
1788                 capture_sources_malloced = false;
1789                 source_list_contents = NULL;
1790         }
1791
1792         if (config_file) {
1793                 size_t config_len;
1794
1795                 config_str = file_get_text_contents(config_file, &config_len);
1796                 if (!config_str) {
1797                         ret = -1;
1798                         goto out_free_capture_sources;
1799                 }
1800
1801                 config = alloca(sizeof(*config));
1802                 ret = parse_capture_config(&config_str, config_len, config);
1803                 if (ret)
1804                         goto out_free_config;
1805         } else {
1806                 config = &default_capture_config;
1807         }
1808
1809         if (cmd == APPEND)
1810                 ret = wimlib_open_wim(wimfile, open_flags, &w,
1811                                       imagex_progress_func);
1812         else
1813                 ret = wimlib_create_new_wim(compression_type, &w);
1814         if (ret)
1815                 goto out_free_config;
1816
1817         if (!source_list) {
1818                 struct stat stbuf;
1819                 ret = tstat(source, &stbuf);
1820                 if (ret == 0) {
1821                         if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1822                                 tprintf(T("Capturing WIM image from NTFS "
1823                                           "filesystem on \"%"TS"\"\n"), source);
1824                                 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1825                         }
1826                 } else {
1827                         if (errno != ENOENT) {
1828                                 imagex_error_with_errno(T("Failed to stat "
1829                                                           "\"%"TS"\""), source);
1830                                 ret = -1;
1831                                 goto out_wimlib_free;
1832                         }
1833                 }
1834         }
1835
1836         if (cmd == APPEND && name_defaulted) {
1837                 /* If the user did not specify an image name, and the basename
1838                  * of the source already exists as an image name in the WIM
1839                  * file, append a suffix to make it unique. */
1840                 unsigned long conflict_idx;
1841                 tchar *name_end = tstrchr(name, T('\0'));
1842                 for (conflict_idx = 1;
1843                      wimlib_image_name_in_use(w, name);
1844                      conflict_idx++)
1845                 {
1846                         tsprintf(name_end, T(" (%lu)"), conflict_idx);
1847                 }
1848         }
1849 #ifdef __WIN32__
1850         win32_acquire_capture_privileges();
1851 #endif
1852
1853         ret = wimlib_add_image_multisource(w,
1854                                            capture_sources,
1855                                            num_sources,
1856                                            name,
1857                                            config,
1858                                            add_image_flags,
1859                                            imagex_progress_func);
1860         if (ret != 0)
1861                 goto out_release_privs;
1862         cur_image = wimlib_get_num_images(w);
1863         if (desc) {
1864                 ret = wimlib_set_image_descripton(w, cur_image, desc);
1865                 if (ret != 0)
1866                         goto out_release_privs;
1867         }
1868         if (flags_element) {
1869                 ret = wimlib_set_image_flags(w, cur_image, flags_element);
1870                 if (ret != 0)
1871                         goto out_release_privs;
1872         }
1873         if (cmd == APPEND) {
1874                 ret = wimlib_overwrite(w, write_flags, num_threads,
1875                                        imagex_progress_func);
1876         } else {
1877                 ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags,
1878                                    num_threads, imagex_progress_func);
1879         }
1880         if (ret != 0)
1881                 imagex_error(T("Failed to write the WIM file \"%"TS"\""),
1882                              wimfile);
1883 out_release_privs:
1884 #ifdef __WIN32__
1885         win32_release_capture_privileges();
1886 #endif
1887 out_wimlib_free:
1888         wimlib_free(w);
1889 out_free_config:
1890         if (config != NULL && config != &default_capture_config) {
1891                 free(config->exclusion_pats.pats);
1892                 free(config->exclusion_exception_pats.pats);
1893                 free(config_str);
1894         }
1895 out_free_capture_sources:
1896         if (capture_sources_malloced)
1897                 free(capture_sources);
1898 out_free_source_list_contents:
1899         free(source_list_contents);
1900         return ret;
1901 }
1902
1903 /* Remove image(s) from a WIM. */
1904 static int
1905 imagex_delete(int argc, tchar **argv)
1906 {
1907         int c;
1908         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1909         int write_flags = 0;
1910         const tchar *wimfile;
1911         const tchar *image_num_or_name;
1912         WIMStruct *w;
1913         int image;
1914         int ret;
1915
1916         for_opt(c, delete_options) {
1917                 switch (c) {
1918                 case IMAGEX_CHECK_OPTION:
1919                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1920                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1921                         break;
1922                 case IMAGEX_SOFT_OPTION:
1923                         write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
1924                         break;
1925                 default:
1926                         usage(DELETE);
1927                         return -1;
1928                 }
1929         }
1930         argc -= optind;
1931         argv += optind;
1932
1933         if (argc != 2) {
1934                 if (argc < 1)
1935                         imagex_error(T("Must specify a WIM file"));
1936                 if (argc < 2)
1937                         imagex_error(T("Must specify an image"));
1938                 usage(DELETE);
1939                 return -1;
1940         }
1941         wimfile = argv[0];
1942         image_num_or_name = argv[1];
1943
1944         ret = wimlib_open_wim(wimfile, open_flags, &w,
1945                               imagex_progress_func);
1946         if (ret != 0)
1947                 return ret;
1948
1949         image = wimlib_resolve_image(w, image_num_or_name);
1950
1951         ret = verify_image_exists(image, image_num_or_name, wimfile);
1952         if (ret != 0)
1953                 goto out;
1954
1955         ret = wimlib_delete_image(w, image);
1956         if (ret != 0) {
1957                 imagex_error(T("Failed to delete image from \"%"TS"\""), wimfile);
1958                 goto out;
1959         }
1960
1961         ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
1962         if (ret != 0) {
1963                 imagex_error(T("Failed to write the file \"%"TS"\" with image "
1964                                "deleted"), wimfile);
1965         }
1966 out:
1967         wimlib_free(w);
1968         return ret;
1969 }
1970
1971 /* Print the files contained in an image(s) in a WIM file. */
1972 static int
1973 imagex_dir(int argc, tchar **argv)
1974 {
1975         const tchar *wimfile;
1976         WIMStruct *w;
1977         int image;
1978         int ret;
1979         int num_images;
1980
1981         if (argc < 2) {
1982                 imagex_error(T("Must specify a WIM file"));
1983                 usage(DIR);
1984                 return -1;
1985         }
1986         if (argc > 3) {
1987                 imagex_error(T("Too many arguments"));
1988                 usage(DIR);
1989                 return -1;
1990         }
1991
1992         wimfile = argv[1];
1993         ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w,
1994                               imagex_progress_func);
1995         if (ret != 0)
1996                 return ret;
1997
1998         if (argc == 3) {
1999                 image = wimlib_resolve_image(w, argv[2]);
2000                 ret = verify_image_exists(image, argv[2], wimfile);
2001                 if (ret != 0)
2002                         goto out;
2003         } else {
2004                 /* Image was not specified.  If the WIM only contains one image,
2005                  * choose that one; otherwise, print an error. */
2006                 num_images = wimlib_get_num_images(w);
2007                 if (num_images != 1) {
2008                         imagex_error(T("\"%"TS"\" contains %d images; Please "
2009                                        "select one."), wimfile, num_images);
2010                         usage(DIR);
2011                         ret = -1;
2012                         goto out;
2013                 }
2014                 image = 1;
2015         }
2016
2017         ret = wimlib_print_files(w, image);
2018 out:
2019         wimlib_free(w);
2020         return ret;
2021 }
2022
2023 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2024  * WIM file. */
2025 static int
2026 imagex_export(int argc, tchar **argv)
2027 {
2028         int c;
2029         int open_flags = 0;
2030         int export_flags = 0;
2031         int write_flags = 0;
2032         int compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
2033         bool compression_type_specified = false;
2034         const tchar *src_wimfile;
2035         const tchar *src_image_num_or_name;
2036         const tchar *dest_wimfile;
2037         const tchar *dest_name;
2038         const tchar *dest_desc;
2039         WIMStruct *src_w = NULL;
2040         WIMStruct *dest_w = NULL;
2041         int ret;
2042         int image;
2043         struct stat stbuf;
2044         bool wim_is_new;
2045         const tchar *swm_glob = NULL;
2046         WIMStruct **additional_swms = NULL;
2047         unsigned num_additional_swms = 0;
2048         unsigned num_threads = 0;
2049
2050         for_opt(c, export_options) {
2051                 switch (c) {
2052                 case IMAGEX_BOOT_OPTION:
2053                         export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2054                         break;
2055                 case IMAGEX_CHECK_OPTION:
2056                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2057                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2058                         break;
2059                 case IMAGEX_COMPRESS_OPTION:
2060                         compression_type = get_compression_type(optarg);
2061                         if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2062                                 return -1;
2063                         compression_type_specified = true;
2064                         break;
2065                 case IMAGEX_REF_OPTION:
2066                         swm_glob = optarg;
2067                         break;
2068                 case IMAGEX_THREADS_OPTION:
2069                         num_threads = parse_num_threads(optarg);
2070                         if (num_threads == UINT_MAX)
2071                                 return -1;
2072                         break;
2073                 case IMAGEX_REBUILD_OPTION:
2074                         write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2075                         break;
2076                 default:
2077                         usage(EXPORT);
2078                         return -1;
2079                 }
2080         }
2081         argc -= optind;
2082         argv += optind;
2083         if (argc < 3 || argc > 5) {
2084                 usage(EXPORT);
2085                 return -1;
2086         }
2087         src_wimfile           = argv[0];
2088         src_image_num_or_name = argv[1];
2089         dest_wimfile          = argv[2];
2090         dest_name             = (argc >= 4) ? argv[3] : NULL;
2091         dest_desc             = (argc >= 5) ? argv[4] : NULL;
2092         ret = wimlib_open_wim(src_wimfile,
2093                               open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w,
2094                               imagex_progress_func);
2095         if (ret != 0)
2096                 return ret;
2097
2098         /* Determine if the destination is an existing file or not.
2099          * If so, we try to append the exported image(s) to it; otherwise, we
2100          * create a new WIM containing the exported image(s). */
2101         if (tstat(dest_wimfile, &stbuf) == 0) {
2102                 int dest_ctype;
2103
2104                 wim_is_new = false;
2105                 /* Destination file exists. */
2106
2107                 if (!S_ISREG(stbuf.st_mode)) {
2108                         imagex_error(T("\"%"TS"\" is not a regular file"),
2109                                      dest_wimfile);
2110                         ret = -1;
2111                         goto out;
2112                 }
2113                 ret = wimlib_open_wim(dest_wimfile, open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2114                                       &dest_w, imagex_progress_func);
2115                 if (ret != 0)
2116                         goto out;
2117
2118                 dest_ctype = wimlib_get_compression_type(dest_w);
2119                 if (compression_type_specified
2120                     && compression_type != dest_ctype)
2121                 {
2122                         imagex_error(T("Cannot specify a compression type that is "
2123                                        "not the same as that used in the "
2124                                        "destination WIM"));
2125                         ret = -1;
2126                         goto out;
2127                 }
2128         } else {
2129                 wim_is_new = true;
2130                 /* dest_wimfile is not an existing file, so create a new WIM. */
2131                 if (!compression_type_specified)
2132                         compression_type = wimlib_get_compression_type(src_w);
2133                 if (errno == ENOENT) {
2134                         ret = wimlib_create_new_wim(compression_type, &dest_w);
2135                         if (ret != 0)
2136                                 goto out;
2137                 } else {
2138                         imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2139                                                 dest_wimfile);
2140                         ret = -1;
2141                         goto out;
2142                 }
2143         }
2144
2145         image = wimlib_resolve_image(src_w, src_image_num_or_name);
2146         ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2147         if (ret != 0)
2148                 goto out;
2149
2150         if (swm_glob) {
2151                 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
2152                                           &additional_swms,
2153                                           &num_additional_swms);
2154                 if (ret != 0)
2155                         goto out;
2156         }
2157
2158         ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
2159                                   export_flags, additional_swms,
2160                                   num_additional_swms, imagex_progress_func);
2161         if (ret != 0)
2162                 goto out;
2163
2164
2165         if (wim_is_new)
2166                 ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES,
2167                                    write_flags, num_threads,
2168                                    imagex_progress_func);
2169         else
2170                 ret = wimlib_overwrite(dest_w, write_flags, num_threads,
2171                                        imagex_progress_func);
2172 out:
2173         wimlib_free(src_w);
2174         wimlib_free(dest_w);
2175         if (additional_swms) {
2176                 for (unsigned i = 0; i < num_additional_swms; i++)
2177                         wimlib_free(additional_swms[i]);
2178                 free(additional_swms);
2179         }
2180         return ret;
2181 }
2182
2183 static bool
2184 is_root_wim_path(const tchar *path)
2185 {
2186         const tchar *p;
2187         for (p = path; *p; p++)
2188                 if (*p != T('\\') && *p != T('/'))
2189                         return false;
2190         return true;
2191 }
2192
2193 static void
2194 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2195                       const tchar *dest_dir)
2196 {
2197         for (size_t i = 0; i < num_cmds; i++)
2198                 if (cmds[i].fs_dest_path != dest_dir)
2199                         free(cmds[i].fs_dest_path);
2200         free(cmds);
2201 }
2202
2203 static struct wimlib_extract_command *
2204 prepare_extract_commands(tchar **paths, unsigned num_paths,
2205                          int extract_flags, tchar *dest_dir,
2206                          size_t *num_cmds_ret)
2207 {
2208         struct wimlib_extract_command *cmds;
2209         size_t num_cmds;
2210         tchar *emptystr = T("");
2211
2212         if (num_paths == 0) {
2213                 num_paths = 1;
2214                 paths = &emptystr;
2215         }
2216         num_cmds = num_paths;
2217         cmds = calloc(num_cmds, sizeof(cmds[0]));
2218         if (!cmds) {
2219                 imagex_error(T("Out of memory!"));
2220                 return NULL;
2221         }
2222
2223         for (size_t i = 0; i < num_cmds; i++) {
2224                 cmds[i].extract_flags = extract_flags;
2225                 cmds[i].wim_source_path = paths[i];
2226                 if (is_root_wim_path(paths[i])) {
2227                         cmds[i].fs_dest_path = dest_dir;
2228                 } else {
2229                         size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2230                         cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2231                         if (!cmds[i].fs_dest_path) {
2232                                 free_extract_commands(cmds, num_cmds, dest_dir);
2233                                 return NULL;
2234                         }
2235                         tsprintf(cmds[i].fs_dest_path, T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2236                                  dest_dir, tbasename(paths[i]));
2237                 }
2238         }
2239         *num_cmds_ret = num_cmds;
2240         return cmds;
2241 }
2242
2243 /* Extract files or directories from a WIM image */
2244 static int
2245 imagex_extract(int argc, tchar **argv)
2246 {
2247         int c;
2248         int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2249         int image;
2250         WIMStruct *wim;
2251         int ret;
2252         const tchar *wimfile;
2253         const tchar *image_num_or_name;
2254         tchar *dest_dir = T(".");
2255         int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2256
2257         const tchar *swm_glob = NULL;
2258         WIMStruct **additional_swms = NULL;
2259         unsigned num_additional_swms = 0;
2260
2261         struct wimlib_extract_command *cmds;
2262         size_t num_cmds;
2263
2264         for_opt(c, extract_options) {
2265                 switch (c) {
2266                 case IMAGEX_CHECK_OPTION:
2267                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2268                         break;
2269                 case IMAGEX_VERBOSE_OPTION:
2270                         extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2271                         break;
2272                 case IMAGEX_REF_OPTION:
2273                         swm_glob = optarg;
2274                         break;
2275                 case IMAGEX_UNIX_DATA_OPTION:
2276                         extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2277                         break;
2278                 case IMAGEX_NO_ACLS_OPTION:
2279                         extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2280                         break;
2281                 case IMAGEX_STRICT_ACLS_OPTION:
2282                         extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2283                         break;
2284                 case IMAGEX_DEST_DIR_OPTION:
2285                         dest_dir = optarg;
2286                         break;
2287                 case IMAGEX_TO_STDOUT_OPTION:
2288                         extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2289                         imagex_be_quiet = true;
2290                         break;
2291                 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2292                         extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2293                         extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2294                         break;
2295                 default:
2296                         goto out_usage;
2297                 }
2298         }
2299         argc -= optind;
2300         argv += optind;
2301
2302         if (argc < 2)
2303                 goto out_usage;
2304
2305         wimfile = argv[0];
2306         image_num_or_name = argv[1];
2307
2308         argc -= 2;
2309         argv += 2;
2310
2311         cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2312                                         &num_cmds);
2313         if (!cmds) {
2314                 ret = -1;
2315                 goto out;
2316         }
2317
2318         ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2319         if (ret)
2320                 goto out_free_cmds;
2321
2322         image = wimlib_resolve_image(wim, image_num_or_name);
2323         ret = verify_image_exists_and_is_single(image,
2324                                                 image_num_or_name,
2325                                                 wimfile);
2326         if (ret)
2327                 goto out_wimlib_free;
2328
2329         if (swm_glob) {
2330                 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2331                                           &additional_swms,
2332                                           &num_additional_swms);
2333                 if (ret)
2334                         goto out_wimlib_free;
2335         }
2336
2337 #ifdef __WIN32__
2338         win32_acquire_restore_privileges();
2339 #endif
2340
2341         ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2342                                    additional_swms, num_additional_swms,
2343                                    imagex_progress_func);
2344         if (ret == 0) {
2345                 if (!imagex_be_quiet)
2346                         tprintf(T("Done extracting files.\n"));
2347         } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2348                 tfprintf(stderr, T("Note: You can use `"IMAGEX_PROGNAME" dir' to see what "
2349                                    "files and directories\n"
2350                                    "      are in the WIM image.\n"));
2351         }
2352 #ifdef __WIN32__
2353         win32_release_restore_privileges();
2354 #endif
2355         if (additional_swms) {
2356                 for (unsigned i = 0; i < num_additional_swms; i++)
2357                         wimlib_free(additional_swms[i]);
2358                 free(additional_swms);
2359         }
2360 out_wimlib_free:
2361         wimlib_free(wim);
2362 out_free_cmds:
2363         free_extract_commands(cmds, num_cmds, dest_dir);
2364 out:
2365         return ret;
2366 out_usage:
2367         usage(EXTRACT);
2368         ret = -1;
2369         goto out;
2370 }
2371
2372 /* Prints information about a WIM file; also can mark an image as bootable,
2373  * change the name of an image, or change the description of an image. */
2374 static int
2375 imagex_info(int argc, tchar **argv)
2376 {
2377         int c;
2378         bool boot         = false;
2379         bool check        = false;
2380         bool header       = false;
2381         bool lookup_table = false;
2382         bool xml          = false;
2383         bool metadata     = false;
2384         bool short_header = true;
2385         const tchar *xml_out_file = NULL;
2386         const tchar *wimfile;
2387         const tchar *image_num_or_name = T("all");
2388         const tchar *new_name = NULL;
2389         const tchar *new_desc = NULL;
2390         WIMStruct *w;
2391         FILE *fp;
2392         int image;
2393         int ret;
2394         int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2395         int part_number;
2396         int total_parts;
2397         int num_images;
2398
2399         for_opt(c, info_options) {
2400                 switch (c) {
2401                 case IMAGEX_BOOT_OPTION:
2402                         boot = true;
2403                         break;
2404                 case IMAGEX_CHECK_OPTION:
2405                         check = true;
2406                         break;
2407                 case IMAGEX_HEADER_OPTION:
2408                         header = true;
2409                         short_header = false;
2410                         break;
2411                 case IMAGEX_LOOKUP_TABLE_OPTION:
2412                         lookup_table = true;
2413                         short_header = false;
2414                         break;
2415                 case IMAGEX_XML_OPTION:
2416                         xml = true;
2417                         short_header = false;
2418                         break;
2419                 case IMAGEX_EXTRACT_XML_OPTION:
2420                         xml_out_file = optarg;
2421                         short_header = false;
2422                         break;
2423                 case IMAGEX_METADATA_OPTION:
2424                         metadata = true;
2425                         short_header = false;
2426                         break;
2427                 default:
2428                         usage(INFO);
2429                         return -1;
2430                 }
2431         }
2432
2433         argc -= optind;
2434         argv += optind;
2435         if (argc == 0 || argc > 4) {
2436                 usage(INFO);
2437                 return -1;
2438         }
2439         wimfile = argv[0];
2440         if (argc > 1) {
2441                 image_num_or_name = argv[1];
2442                 if (argc > 2) {
2443                         new_name = argv[2];
2444                         if (argc > 3) {
2445                                 new_desc = argv[3];
2446                         }
2447                 }
2448         }
2449
2450         if (check)
2451                 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2452
2453         ret = wimlib_open_wim(wimfile, open_flags, &w,
2454                               imagex_progress_func);
2455         if (ret != 0)
2456                 return ret;
2457
2458         part_number = wimlib_get_part_number(w, &total_parts);
2459
2460         image = wimlib_resolve_image(w, image_num_or_name);
2461         if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2462                 imagex_error(T("The image \"%"TS"\" does not exist"),
2463                              image_num_or_name);
2464                 if (boot) {
2465                         imagex_error(T("If you would like to set the boot "
2466                                        "index to 0, specify image \"0\" with "
2467                                        "the --boot flag."));
2468                 }
2469                 ret = WIMLIB_ERR_INVALID_IMAGE;
2470                 goto out;
2471         }
2472
2473         num_images = wimlib_get_num_images(w);
2474
2475         if (num_images == 0) {
2476                 if (boot) {
2477                         imagex_error(T("--boot is meaningless on a WIM with no "
2478                                        "images"));
2479                         ret = WIMLIB_ERR_INVALID_IMAGE;
2480                         goto out;
2481                 }
2482         }
2483
2484         if (image == WIMLIB_ALL_IMAGES && num_images > 1) {
2485                 if (boot) {
2486                         imagex_error(T("Cannot specify the --boot flag "
2487                                        "without specifying a specific "
2488                                        "image in a multi-image WIM"));
2489                         ret = WIMLIB_ERR_INVALID_IMAGE;
2490                         goto out;
2491                 }
2492                 if (new_name) {
2493                         imagex_error(T("Cannot specify the NEW_NAME "
2494                                        "without specifying a specific "
2495                                        "image in a multi-image WIM"));
2496                         ret = WIMLIB_ERR_INVALID_IMAGE;
2497                         goto out;
2498                 }
2499         }
2500
2501         /* Operations that print information are separated from operations that
2502          * recreate the WIM file. */
2503         if (!new_name && !boot) {
2504
2505                 /* Read-only operations */
2506
2507                 if (image == WIMLIB_NO_IMAGE) {
2508                         imagex_error(T("\"%"TS"\" is not a valid image"),
2509                                      image_num_or_name);
2510                         ret = WIMLIB_ERR_INVALID_IMAGE;
2511                         goto out;
2512                 }
2513
2514                 if (image == WIMLIB_ALL_IMAGES && short_header)
2515                         wimlib_print_wim_information(w);
2516
2517                 if (header)
2518                         wimlib_print_header(w);
2519
2520                 if (lookup_table) {
2521                         if (total_parts != 1) {
2522                                 tprintf(T("Warning: Only showing the lookup table "
2523                                           "for part %d of a %d-part WIM.\n"),
2524                                         part_number, total_parts);
2525                         }
2526                         wimlib_print_lookup_table(w);
2527                 }
2528
2529                 if (xml) {
2530                         ret = wimlib_extract_xml_data(w, stdout);
2531                         if (ret != 0)
2532                                 goto out;
2533                 }
2534
2535                 if (xml_out_file) {
2536                         fp = tfopen(xml_out_file, T("wb"));
2537                         if (!fp) {
2538                                 imagex_error_with_errno(T("Failed to open the "
2539                                                           "file \"%"TS"\" for "
2540                                                           "writing "),
2541                                                         xml_out_file);
2542                                 ret = -1;
2543                                 goto out;
2544                         }
2545                         ret = wimlib_extract_xml_data(w, fp);
2546                         if (fclose(fp) != 0) {
2547                                 imagex_error(T("Failed to close the file "
2548                                                "\"%"TS"\""),
2549                                              xml_out_file);
2550                                 ret = -1;
2551                         }
2552
2553                         if (ret != 0)
2554                                 goto out;
2555                 }
2556
2557                 if (short_header)
2558                         wimlib_print_available_images(w, image);
2559
2560                 if (metadata) {
2561                         ret = wimlib_print_metadata(w, image);
2562                         if (ret != 0)
2563                                 goto out;
2564                 }
2565         } else {
2566
2567                 /* Modification operations */
2568
2569                 if (image == WIMLIB_ALL_IMAGES)
2570                         image = 1;
2571
2572                 if (image == WIMLIB_NO_IMAGE && new_name) {
2573                         imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2574                                        "when using image 0"), new_name);
2575                         ret = -1;
2576                         goto out;
2577                 }
2578
2579                 if (boot) {
2580                         if (image == wimlib_get_boot_idx(w)) {
2581                                 tprintf(T("Image %d is already marked as "
2582                                           "bootable.\n"), image);
2583                                 boot = false;
2584                         } else {
2585                                 tprintf(T("Marking image %d as bootable.\n"),
2586                                         image);
2587                                 wimlib_set_boot_idx(w, image);
2588                         }
2589                 }
2590                 if (new_name) {
2591                         if (!tstrcmp(wimlib_get_image_name(w, image), new_name))
2592                         {
2593                                 tprintf(T("Image %d is already named \"%"TS"\".\n"),
2594                                         image, new_name);
2595                                 new_name = NULL;
2596                         } else {
2597                                 tprintf(T("Changing the name of image %d to "
2598                                           "\"%"TS"\".\n"), image, new_name);
2599                                 ret = wimlib_set_image_name(w, image, new_name);
2600                                 if (ret != 0)
2601                                         goto out;
2602                         }
2603                 }
2604                 if (new_desc) {
2605                         const tchar *old_desc;
2606                         old_desc = wimlib_get_image_description(w, image);
2607                         if (old_desc && !tstrcmp(old_desc, new_desc)) {
2608                                 tprintf(T("The description of image %d is already "
2609                                           "\"%"TS"\".\n"), image, new_desc);
2610                                 new_desc = NULL;
2611                         } else {
2612                                 tprintf(T("Changing the description of image %d "
2613                                           "to \"%"TS"\".\n"), image, new_desc);
2614                                 ret = wimlib_set_image_descripton(w, image,
2615                                                                   new_desc);
2616                                 if (ret != 0)
2617                                         goto out;
2618                         }
2619                 }
2620
2621                 /* Only call wimlib_overwrite() if something actually needs to
2622                  * be changed. */
2623                 if (boot || new_name || new_desc ||
2624                     (check && !wimlib_has_integrity_table(w)))
2625                 {
2626                         int write_flags = 0;
2627
2628                         if (check)
2629                                 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2630                         ret = wimlib_overwrite(w, write_flags, 1,
2631                                                imagex_progress_func);
2632                 } else {
2633                         tprintf(T("The file \"%"TS"\" was not modified because nothing "
2634                                   "needed to be done.\n"), wimfile);
2635                         ret = 0;
2636                 }
2637         }
2638 out:
2639         wimlib_free(w);
2640         return ret;
2641 }
2642
2643 /* Join split WIMs into one part WIM */
2644 static int
2645 imagex_join(int argc, tchar **argv)
2646 {
2647         int c;
2648         int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2649         int wim_write_flags = 0;
2650         const tchar *output_path;
2651
2652         for_opt(c, join_options) {
2653                 switch (c) {
2654                 case IMAGEX_CHECK_OPTION:
2655                         swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2656                         wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2657                         break;
2658                 default:
2659                         goto err;
2660                 }
2661         }
2662         argc -= optind;
2663         argv += optind;
2664
2665         if (argc < 2) {
2666                 imagex_error(T("Must specify one or more split WIM (.swm) "
2667                                "parts to join"));
2668                 goto err;
2669         }
2670         output_path = argv[0];
2671         return wimlib_join((const tchar * const *)++argv,
2672                            --argc,
2673                            output_path,
2674                            swm_open_flags,
2675                            wim_write_flags,
2676                            imagex_progress_func);
2677 err:
2678         usage(JOIN);
2679         return -1;
2680 }
2681
2682 /* Mounts an image using a FUSE mount. */
2683 static int
2684 imagex_mount_rw_or_ro(int argc, tchar **argv)
2685 {
2686         int c;
2687         int mount_flags = 0;
2688         int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2689         const tchar *wimfile;
2690         const tchar *dir;
2691         WIMStruct *w;
2692         int image;
2693         int num_images;
2694         int ret;
2695         const tchar *swm_glob = NULL;
2696         WIMStruct **additional_swms = NULL;
2697         unsigned num_additional_swms = 0;
2698         const tchar *staging_dir = NULL;
2699
2700         if (!tstrcmp(argv[0], T("mountrw"))) {
2701                 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
2702                 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2703         }
2704
2705         for_opt(c, mount_options) {
2706                 switch (c) {
2707                 case IMAGEX_ALLOW_OTHER_OPTION:
2708                         mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
2709                         break;
2710                 case IMAGEX_CHECK_OPTION:
2711                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2712                         break;
2713                 case IMAGEX_DEBUG_OPTION:
2714                         mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
2715                         break;
2716                 case IMAGEX_STREAMS_INTERFACE_OPTION:
2717                         if (!tstrcasecmp(optarg, T("none")))
2718                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
2719                         else if (!tstrcasecmp(optarg, T("xattr")))
2720                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2721                         else if (!tstrcasecmp(optarg, T("windows")))
2722                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
2723                         else {
2724                                 imagex_error(T("Unknown stream interface \"%"TS"\""),
2725                                              optarg);
2726                                 goto mount_usage;
2727                         }
2728                         break;
2729                 case IMAGEX_REF_OPTION:
2730                         swm_glob = optarg;
2731                         break;
2732                 case IMAGEX_STAGING_DIR_OPTION:
2733                         staging_dir = optarg;
2734                         break;
2735                 case IMAGEX_UNIX_DATA_OPTION:
2736                         mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
2737                         break;
2738                 default:
2739                         goto mount_usage;
2740                 }
2741         }
2742         argc -= optind;
2743         argv += optind;
2744         if (argc != 2 && argc != 3)
2745                 goto mount_usage;
2746
2747         wimfile = argv[0];
2748
2749         ret = wimlib_open_wim(wimfile, open_flags, &w,
2750                               imagex_progress_func);
2751         if (ret != 0)
2752                 return ret;
2753
2754         if (swm_glob) {
2755                 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2756                                           &additional_swms,
2757                                           &num_additional_swms);
2758                 if (ret != 0)
2759                         goto out;
2760         }
2761
2762         if (argc == 2) {
2763                 image = 1;
2764                 num_images = wimlib_get_num_images(w);
2765                 if (num_images != 1) {
2766                         imagex_error(T("\"%"TS"\" contains %d images; Please "
2767                                        "select one."), wimfile, num_images);
2768                         usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2769                                         ? MOUNTRW : MOUNT);
2770                         ret = -1;
2771                         goto out;
2772                 }
2773                 dir = argv[1];
2774         } else {
2775                 image = wimlib_resolve_image(w, argv[1]);
2776                 dir = argv[2];
2777                 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
2778                 if (ret != 0)
2779                         goto out;
2780         }
2781
2782         ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms,
2783                                  num_additional_swms, staging_dir);
2784         if (ret != 0) {
2785                 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
2786                                "on \"%"TS"\""),
2787                              image, wimfile, dir);
2788
2789         }
2790 out:
2791         wimlib_free(w);
2792         if (additional_swms) {
2793                 for (unsigned i = 0; i < num_additional_swms; i++)
2794                         wimlib_free(additional_swms[i]);
2795                 free(additional_swms);
2796         }
2797         return ret;
2798 mount_usage:
2799         usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2800                         ? MOUNTRW : MOUNT);
2801         return -1;
2802 }
2803
2804 /* Rebuild a WIM file */
2805 static int
2806 imagex_optimize(int argc, tchar **argv)
2807 {
2808         int c;
2809         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2810         int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
2811         int ret;
2812         WIMStruct *w;
2813         const tchar *wimfile;
2814         off_t old_size;
2815         off_t new_size;
2816         unsigned num_threads = 0;
2817
2818         for_opt(c, optimize_options) {
2819                 switch (c) {
2820                 case IMAGEX_CHECK_OPTION:
2821                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2822                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2823                         break;
2824                 case IMAGEX_RECOMPRESS_OPTION:
2825                         write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2826                         break;
2827                 case IMAGEX_THREADS_OPTION:
2828                         num_threads = parse_num_threads(optarg);
2829                         if (num_threads == UINT_MAX)
2830                                 return -1;
2831                         break;
2832                 default:
2833                         usage(OPTIMIZE);
2834                         return -1;
2835                 }
2836         }
2837         argc -= optind;
2838         argv += optind;
2839
2840         if (argc != 1) {
2841                 usage(OPTIMIZE);
2842                 return -1;
2843         }
2844
2845         wimfile = argv[0];
2846
2847         ret = wimlib_open_wim(wimfile, open_flags, &w,
2848                               imagex_progress_func);
2849         if (ret)
2850                 return ret;
2851
2852         old_size = file_get_size(argv[0]);
2853         tprintf(T("\"%"TS"\" original size: "), wimfile);
2854         if (old_size == -1)
2855                 tfputs(T("Unknown\n"), stdout);
2856         else
2857                 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
2858
2859         ret = wimlib_overwrite(w, write_flags, num_threads,
2860                                imagex_progress_func);
2861
2862         if (ret == 0) {
2863                 new_size = file_get_size(argv[0]);
2864                 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
2865                 if (new_size == -1)
2866                         tfputs(T("Unknown\n"), stdout);
2867                 else
2868                         tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
2869
2870                 tfputs(T("Space saved: "), stdout);
2871                 if (new_size != -1 && old_size != -1) {
2872                         tprintf(T("%lld KiB\n"),
2873                                ((long long)old_size - (long long)new_size) >> 10);
2874                 } else {
2875                         tfputs(T("Unknown\n"), stdout);
2876                 }
2877         }
2878
2879         wimlib_free(w);
2880         return ret;
2881 }
2882
2883 /* Split a WIM into a spanned set */
2884 static int
2885 imagex_split(int argc, tchar **argv)
2886 {
2887         int c;
2888         int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2889         int write_flags = 0;
2890         unsigned long part_size;
2891         tchar *tmp;
2892         int ret;
2893         WIMStruct *w;
2894
2895         for_opt(c, split_options) {
2896                 switch (c) {
2897                 case IMAGEX_CHECK_OPTION:
2898                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2899                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2900                         break;
2901                 default:
2902                         usage(SPLIT);
2903                         return -1;
2904                 }
2905         }
2906         argc -= optind;
2907         argv += optind;
2908
2909         if (argc != 3) {
2910                 usage(SPLIT);
2911                 return -1;
2912         }
2913         part_size = tstrtod(argv[2], &tmp) * (1 << 20);
2914         if (tmp == argv[2] || *tmp) {
2915                 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
2916                 imagex_error(T("The part size must be an integer or "
2917                                "floating-point number of megabytes."));
2918                 return -1;
2919         }
2920         ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func);
2921         if (ret != 0)
2922                 return ret;
2923         ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func);
2924         wimlib_free(w);
2925         return ret;
2926 }
2927
2928 /* Unmounts a mounted WIM image. */
2929 static int
2930 imagex_unmount(int argc, tchar **argv)
2931 {
2932         int c;
2933         int unmount_flags = 0;
2934         int ret;
2935
2936         for_opt(c, unmount_options) {
2937                 switch (c) {
2938                 case IMAGEX_COMMIT_OPTION:
2939                         unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
2940                         break;
2941                 case IMAGEX_CHECK_OPTION:
2942                         unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
2943                         break;
2944                 case IMAGEX_REBUILD_OPTION:
2945                         unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
2946                         break;
2947                 case IMAGEX_LAZY_OPTION:
2948                         unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
2949                         break;
2950                 default:
2951                         usage(UNMOUNT);
2952                         return -1;
2953                 }
2954         }
2955         argc -= optind;
2956         argv += optind;
2957         if (argc != 1) {
2958                 usage(UNMOUNT);
2959                 return -1;
2960         }
2961
2962         ret = wimlib_unmount_image(argv[0], unmount_flags,
2963                                    imagex_progress_func);
2964         if (ret != 0)
2965                 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
2966         return ret;
2967 }
2968
2969 /*
2970  * Add, delete, or rename files in a WIM image.
2971  */
2972 static int
2973 imagex_update(int argc, tchar **argv)
2974 {
2975         const tchar *wimfile;
2976         const tchar *image_num_or_name;
2977         int image;
2978         WIMStruct *wim;
2979         int ret;
2980         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2981         int write_flags = 0;
2982         int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
2983         int default_add_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
2984         int default_delete_flags = 0;
2985         unsigned num_threads = 0;
2986         int c;
2987         tchar *cmd_file_contents = NULL;
2988         size_t cmd_file_nchars;
2989         struct wimlib_update_command *cmds;
2990         size_t num_cmds;
2991         int num_images;
2992         tchar *command_str = NULL;
2993
2994         const tchar *config_file = NULL;
2995         tchar *config_str;
2996         struct wimlib_capture_config *config = NULL;
2997
2998         for_opt(c, update_options) {
2999                 switch (c) {
3000                 /* Generic or write options */
3001                 case IMAGEX_THREADS_OPTION:
3002                         num_threads = parse_num_threads(optarg);
3003                         if (num_threads == UINT_MAX) {
3004                                 ret = -1;
3005                                 goto out;
3006                         }
3007                         break;
3008                 case IMAGEX_CHECK_OPTION:
3009                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3010                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3011                         break;
3012                 case IMAGEX_REBUILD_OPTION:
3013                         write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3014                         break;
3015                 case IMAGEX_COMMAND_OPTION:
3016                         if (command_str) {
3017                                 imagex_error(T("--command may only be specified "
3018                                                "one time.  Please provide\n"
3019                                                "       the update commands "
3020                                                "on standard input instead."));
3021                                 ret = -1;
3022                                 goto out;
3023                         }
3024                         command_str = tstrdup(optarg);
3025                         if (!command_str) {
3026                                 imagex_error(T("Out of memory!"));
3027                                 ret = -1;
3028                                 goto out;
3029                         }
3030                         break;
3031                 /* Default delete options */
3032                 case IMAGEX_FORCE_OPTION:
3033                         default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3034                         break;
3035                 case IMAGEX_RECURSIVE_OPTION:
3036                         default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3037                         break;
3038
3039                 /* Global add option */
3040                 case IMAGEX_CONFIG_OPTION:
3041                         config_file = optarg;
3042                         break;
3043
3044                 /* Default add options */
3045                 case IMAGEX_VERBOSE_OPTION:
3046                         default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
3047                         break;
3048                 case IMAGEX_DEREFERENCE_OPTION:
3049                         default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
3050                         break;
3051                 case IMAGEX_UNIX_DATA_OPTION:
3052                         default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
3053                         break;
3054                 case IMAGEX_NO_ACLS_OPTION:
3055                         default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
3056                         break;
3057                 case IMAGEX_STRICT_ACLS_OPTION:
3058                         default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
3059                         break;
3060                 default:
3061                         goto out_usage;
3062                 }
3063         }
3064         argv += optind;
3065         argc -= optind;
3066
3067         if (argc < 1 || argc > 2)
3068                 goto out_usage;
3069         wimfile = argv[0];
3070
3071         ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3072         if (ret)
3073                 goto out;
3074
3075         if (argc == 2)
3076                 image_num_or_name = argv[1];
3077         else
3078                 image_num_or_name = T("1");
3079
3080         image = wimlib_resolve_image(wim, image_num_or_name);
3081
3082         ret = verify_image_exists_and_is_single(image, image_num_or_name,
3083                                                 wimfile);
3084         if (ret)
3085                 goto out_wimlib_free;
3086
3087         num_images = wimlib_get_num_images(wim);
3088         if (argc == 1 && num_images != 1) {
3089                 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3090                              wimfile, num_images);
3091                 usage(UPDATE);
3092                 ret = -1;
3093                 goto out_wimlib_free;
3094         }
3095
3096         /* Parse capture configuration file if specified */
3097         if (config_file) {
3098                 size_t config_len;
3099
3100                 config_str = file_get_text_contents(config_file, &config_len);
3101                 if (!config_str) {
3102                         ret = -1;
3103                         goto out_wimlib_free;
3104                 }
3105
3106                 config = alloca(sizeof(*config));
3107                 ret = parse_capture_config(&config_str, config_len, config);
3108                 if (ret)
3109                         goto out_free_config;
3110         } else {
3111                 config = &default_capture_config;
3112         }
3113
3114         /* Read update commands from standard input, or the command string if
3115          * specified.  */
3116         if (command_str) {
3117                 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3118                                                  &num_cmds);
3119         } else {
3120                 if (isatty(STDIN_FILENO)) {
3121                         tputs(T("Reading update commands from standard input..."));
3122                         recommend_man_page(T("update"));
3123                 }
3124                 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3125                 if (!cmd_file_contents) {
3126                         ret = -1;
3127                         goto out_free_config;
3128                 }
3129
3130                 /* Parse the update commands */
3131                 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3132                                                  &num_cmds);
3133         }
3134         if (!cmds) {
3135                 ret = -1;
3136                 goto out_free_cmd_file_contents;
3137         }
3138
3139         /* Set default flags and capture config on the update commands */
3140         bool have_add_command = false;
3141         for (size_t i = 0; i < num_cmds; i++) {
3142                 switch (cmds[i].op) {
3143                 case WIMLIB_UPDATE_OP_ADD:
3144                         cmds[i].add.add_flags |= default_add_flags;
3145                         cmds[i].add.config = config;
3146                         have_add_command = true;
3147                         break;
3148                 case WIMLIB_UPDATE_OP_DELETE:
3149                         cmds[i].delete.delete_flags |= default_delete_flags;
3150                         break;
3151                 default:
3152                         break;
3153                 }
3154         }
3155
3156 #ifdef __WIN32__
3157         if (have_add_command)
3158                 win32_acquire_capture_privileges();
3159 #endif
3160
3161         /* Execute the update commands */
3162         ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3163                                   imagex_progress_func);
3164         if (ret)
3165                 goto out_release_privs;
3166
3167         /* Overwrite the updated WIM */
3168         ret = wimlib_overwrite(wim, write_flags, num_threads,
3169                                imagex_progress_func);
3170 out_release_privs:
3171 #ifdef __WIN32__
3172         if (have_add_command)
3173                 win32_release_capture_privileges();
3174 #endif
3175         free(cmds);
3176 out_free_cmd_file_contents:
3177         free(cmd_file_contents);
3178 out_free_config:
3179         if (config != NULL && config != &default_capture_config) {
3180                 free(config->exclusion_pats.pats);
3181                 free(config->exclusion_exception_pats.pats);
3182                 free(config_str);
3183         }
3184 out_wimlib_free:
3185         wimlib_free(wim);
3186 out:
3187         free(command_str);
3188         return ret;
3189 out_usage:
3190         usage(UPDATE);
3191         ret = -1;
3192         goto out;
3193 }
3194
3195 struct imagex_command {
3196         const tchar *name;
3197         int (*func)(int , tchar **);
3198         int cmd;
3199 };
3200
3201
3202 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
3203                 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
3204
3205 static const struct imagex_command imagex_commands[] = {
3206         {T("append"),  imagex_capture_or_append, APPEND},
3207         {T("apply"),   imagex_apply,             APPLY},
3208         {T("capture"), imagex_capture_or_append, CAPTURE},
3209         {T("delete"),  imagex_delete,            DELETE},
3210         {T("dir"),     imagex_dir,               DIR},
3211         {T("export"),  imagex_export,            EXPORT},
3212         {T("extract"), imagex_extract,           EXTRACT},
3213         {T("info"),    imagex_info,              INFO},
3214         {T("join"),    imagex_join,              JOIN},
3215         {T("mount"),   imagex_mount_rw_or_ro,    MOUNT},
3216         {T("mountrw"), imagex_mount_rw_or_ro,    MOUNTRW},
3217         {T("optimize"),imagex_optimize,          OPTIMIZE},
3218         {T("split"),   imagex_split,             SPLIT},
3219         {T("unmount"), imagex_unmount,           UNMOUNT},
3220         {T("update"),  imagex_update,            UPDATE},
3221 };
3222
3223 static void
3224 version(void)
3225 {
3226         static const tchar *s =
3227         T(
3228 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3229 "Copyright (C) 2012, 2013 Eric Biggers\n"
3230 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3231 "This is free software: you are free to change and redistribute it.\n"
3232 "There is NO WARRANTY, to the extent permitted by law.\n"
3233 "\n"
3234 "Report bugs to "PACKAGE_BUGREPORT".\n"
3235         );
3236         tfputs(s, stdout);
3237 }
3238
3239
3240 static void
3241 help_or_version(int argc, tchar **argv)
3242 {
3243         int i;
3244         const tchar *p;
3245         const struct imagex_command *cmd;
3246
3247         for (i = 1; i < argc; i++) {
3248                 p = argv[i];
3249                 if (*p == T('-'))
3250                         p++;
3251                 else
3252                         continue;
3253                 if (*p == T('-'))
3254                         p++;
3255                 if (!tstrcmp(p, T("help"))) {
3256                         for_imagex_command(cmd) {
3257                                 if (!tstrcmp(cmd->name, argv[1])) {
3258                                         usage(cmd->cmd);
3259                                         exit(0);
3260                                 }
3261                         }
3262                         usage_all();
3263                         exit(0);
3264                 }
3265                 if (!tstrcmp(p, T("version"))) {
3266                         version();
3267                         exit(0);
3268                 }
3269         }
3270 }
3271
3272
3273 static void
3274 usage(int cmd_type)
3275 {
3276         const struct imagex_command *cmd;
3277         tprintf(T("Usage:\n%"TS), usage_strings[cmd_type]);
3278         for_imagex_command(cmd) {
3279                 if (cmd->cmd == cmd_type) {
3280                         tputc(T('\n'), stdout);
3281                         recommend_man_page(cmd->name);
3282                 }
3283         }
3284 }
3285
3286 static void
3287 usage_all(void)
3288 {
3289         tfputs(T("Usage:\n"), stdout);
3290         for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
3291                 tprintf(T("    %"TS), usage_strings[i]);
3292         static const tchar *extra =
3293         T(
3294 "    "IMAGEX_PROGNAME" --help\n"
3295 "    "IMAGEX_PROGNAME" --version\n"
3296 "\n"
3297 "    The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3298 "\n"
3299         );
3300         tfputs(extra, stdout);
3301         recommend_man_page(T(""));
3302 }
3303
3304 /* Entry point for wimlib's ImageX implementation.  On UNIX the command
3305  * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3306  * something else), while an Windows the command arguments will be UTF-16LE
3307  * encoded 'wchar_t' strings. */
3308 int
3309 #ifdef __WIN32__
3310 wmain(int argc, wchar_t **argv, wchar_t **envp)
3311 #else
3312 main(int argc, char **argv)
3313 #endif
3314 {
3315         const struct imagex_command *cmd;
3316         int ret;
3317         int init_flags = 0;
3318
3319 #ifndef __WIN32__
3320         if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3321                 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3322         } else {
3323                 char *codeset;
3324
3325                 setlocale(LC_ALL, "");
3326                 codeset = nl_langinfo(CODESET);
3327                 if (!strstr(codeset, "UTF-8") &&
3328                     !strstr(codeset, "UTF8") &&
3329                     !strstr(codeset, "utf-8") &&
3330                     !strstr(codeset, "utf8"))
3331                 {
3332                         fputs(
3333 "WARNING: Running "IMAGEX_PROGNAME" in a UTF-8 locale is recommended!\n"
3334 "         Maybe try: `export LANG=en_US.UTF-8'?\n"
3335 "         Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3336 "         to any value to force wimlib to use UTF-8.\n",
3337                         stderr);
3338
3339                 }
3340         }
3341 #endif /* !__WIN32__ */
3342
3343         if (argc < 2) {
3344                 imagex_error(T("No command specified"));
3345                 usage_all();
3346                 ret = 2;
3347                 goto out;
3348         }
3349
3350         /* Handle --help and --version for all commands.  Note that this will
3351          * not return if either of these arguments are present. */
3352         help_or_version(argc, argv);
3353         argc--;
3354         argv++;
3355
3356         /* The user may like to see more informative error messages. */
3357         wimlib_set_print_errors(true);
3358
3359         /* Do any initializations that the library needs */
3360         ret = wimlib_global_init(init_flags);
3361         if (ret)
3362                 goto out_check_status;
3363
3364         /* Search for the function to handle the ImageX subcommand. */
3365         for_imagex_command(cmd) {
3366                 if (!tstrcmp(cmd->name, *argv)) {
3367                         ret = cmd->func(argc, argv);
3368                         goto out_check_write_error;
3369                 }
3370         }
3371
3372         imagex_error(T("Unrecognized command: `%"TS"'"), argv[0]);
3373         usage_all();
3374         ret = 2;
3375         goto out_cleanup;
3376 out_check_write_error:
3377         /* For 'wimlib-imagex info' and 'wimlib-imagex dir', data printed to
3378          * standard output is part of the program's actual behavior and not just
3379          * for informational purposes, so we should set a failure exit status if
3380          * there was a write error. */
3381         if (cmd == &imagex_commands[INFO] || cmd == &imagex_commands[DIR]) {
3382                 if (ferror(stdout) || fclose(stdout)) {
3383                         imagex_error_with_errno(T("error writing to standard output"));
3384                         if (ret == 0)
3385                                 ret = -1;
3386                 }
3387         }
3388 out_check_status:
3389         /* Exit status (ret):  -1 indicates an error found by 'wimlib-imagex'
3390          * outside of the wimlib library code.  0 indicates success.  > 0
3391          * indicates a wimlib error code from which an error message can be
3392          * printed. */
3393         if (ret > 0) {
3394                 imagex_error(T("Exiting with error code %d:\n"
3395                                "       %"TS"."), ret,
3396                              wimlib_get_error_string(ret));
3397                 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3398                         imagex_error_with_errno(T("errno"));
3399         }
3400 out_cleanup:
3401         /* Make the library free any resources it's holding (not strictly
3402          * necessary because the process is ending anyway). */
3403         wimlib_global_cleanup();
3404 out:
3405         return ret;
3406 }