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