X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=programs%2Fimagex.c;h=a9e6fa63bac0718cb0f0a764f5f5dd96ffd95b80;hp=b78fa325abd37488f4954947c15771fe1ac68171;hb=5eaadbe09039fd336b265423682a6ce322c45c6e;hpb=c6a1140e085f633273fcf47a6462bd9382ce118a diff --git a/programs/imagex.c b/programs/imagex.c index b78fa325..a9e6fa63 100644 --- a/programs/imagex.c +++ b/programs/imagex.c @@ -22,7 +22,10 @@ * along with this program. If not, see . */ -#include "config.h" +#ifdef HAVE_CONFIG_H +# include "config.h" /* Need for PACKAGE_VERSION, etc. */ +#endif + #include "wimlib.h" #include "wimlib_tchar.h" @@ -40,141 +43,116 @@ #include #ifdef HAVE_ALLOCA_H -#include +# include #endif #ifdef __WIN32__ # include "imagex-win32.h" # define tbasename win32_wbasename -# define tglob win32_wglob +# define OS_PREFERRED_PATH_SEPARATOR L'\\' +# define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\" #else /* __WIN32__ */ # include # include # include # define tbasename basename -# define tglob glob +# define OS_PREFERRED_PATH_SEPARATOR '/' +# define OS_PREFERRED_PATH_SEPARATOR_STRING "/" +static inline void set_fd_to_binary_mode(int fd) +{ +} #endif /* !__WIN32 */ +/* Don't confuse the user by presenting the mounting commands on Windows when + * they will never work. However on UNIX-like systems we always present them, + * even if WITH_FUSE is not defined at this point, as to not tie the build of + * wimlib-imagex to a specific build of wimlib. */ +#ifdef __WIN32__ +# define WIM_MOUNTING_SUPPORTED 0 +#else +# define WIM_MOUNTING_SUPPORTED 1 +#endif #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0])) #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \ opts, NULL)) != -1) -enum imagex_op_type { - APPEND = 0, - APPLY, - CAPTURE, - DELETE, - DIR, - EXPORT, - INFO, - JOIN, - MOUNT, - MOUNTRW, - OPTIMIZE, - SPLIT, - UNMOUNT, +enum { + CMD_NONE = -1, + CMD_APPEND = 0, + CMD_APPLY, + CMD_CAPTURE, + CMD_DELETE, + CMD_DIR, + CMD_EXPORT, + CMD_EXTRACT, + CMD_INFO, + CMD_JOIN, +#if WIM_MOUNTING_SUPPORTED + CMD_MOUNT, + CMD_MOUNTRW, +#endif + CMD_OPTIMIZE, + CMD_SPLIT, +#if WIM_MOUNTING_SUPPORTED + CMD_UNMOUNT, +#endif + CMD_UPDATE, + CMD_MAX, }; -static void usage(int cmd_type); -static void usage_all(); +static void usage(int cmd, FILE *fp); +static void usage_all(FILE *fp); +static void recommend_man_page(int cmd, FILE *fp); +static const tchar *get_cmd_string(int cmd, bool nospace); +static int imagex_progress_func(enum wimlib_progress_msg msg, + const union wimlib_progress_info *info); -static const tchar *usage_strings[] = { -[APPEND] = -T( -IMAGEX_PROGNAME" append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n" -" [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n" -" [--verbose] [--dereference] [--config=FILE]\n" -" [--threads=NUM_THREADS] [--rebuild] [--unix-data]\n" -" [--source-list] [--no-acls] [--strict-acls]\n" -), -[APPLY] = -T( -IMAGEX_PROGNAME" apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n" -" (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n" -" [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n" -" [--no-acls] [--strict-acls]\n" -), -[CAPTURE] = -T( -IMAGEX_PROGNAME" capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n" -" [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n" -" [--flags EDITION_ID] [--verbose] [--dereference]\n" -" [--config=FILE] [--threads=NUM_THREADS] [--unix-data]\n" -" [--source-list] [--no-acls] [--strict-acls]\n" -), -[DELETE] = -T( -IMAGEX_PROGNAME" delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n" -), -[DIR] = -T( -IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n" -), -[EXPORT] = -T( -IMAGEX_PROGNAME" export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n" -" DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n" -" [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n" -" [--threads=NUM_THREADS] [--rebuild]\n" -), -[INFO] = -T( -IMAGEX_PROGNAME" info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n" -" [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n" -" [--xml] [--extract-xml FILE] [--metadata]\n" -), -[JOIN] = -T( -IMAGEX_PROGNAME" join [--check] WIMFILE SPLIT_WIM...\n" -), -[MOUNT] = -T( -IMAGEX_PROGNAME" mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n" -" [--check] [--debug] [--streams-interface=INTERFACE]\n" -" [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n" -), -[MOUNTRW] = -T( -IMAGEX_PROGNAME" mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n" -" [--check] [--debug] [--streams-interface=INTERFACE]\n" -" [--staging-dir=DIR] [--unix-data] [--allow-other]\n" -), -[OPTIMIZE] = -T( -IMAGEX_PROGNAME" optimize WIMFILE [--check] [--recompress]\n" -), -[SPLIT] = -T( -IMAGEX_PROGNAME" split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n" -), -[UNMOUNT] = -T( -IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild]\n" -), -}; +static bool imagex_be_quiet = false; +static FILE *imagex_info_file; + +#define imagex_printf(format, ...) \ + tfprintf(imagex_info_file, format, ##__VA_ARGS__) enum { IMAGEX_ALLOW_OTHER_OPTION, IMAGEX_BOOT_OPTION, IMAGEX_CHECK_OPTION, + IMAGEX_CHUNK_SIZE_OPTION, + IMAGEX_COMMAND_OPTION, IMAGEX_COMMIT_OPTION, IMAGEX_COMPRESS_OPTION, + IMAGEX_COMPRESS_SLOW_OPTION, IMAGEX_CONFIG_OPTION, IMAGEX_DEBUG_OPTION, + IMAGEX_DELTA_FROM_OPTION, IMAGEX_DEREFERENCE_OPTION, + IMAGEX_DEST_DIR_OPTION, IMAGEX_EXTRACT_XML_OPTION, IMAGEX_FLAGS_OPTION, + IMAGEX_FORCE_OPTION, IMAGEX_HARDLINK_OPTION, IMAGEX_HEADER_OPTION, + IMAGEX_INCLUDE_INVALID_NAMES_OPTION, + IMAGEX_LAZY_OPTION, IMAGEX_LOOKUP_TABLE_OPTION, IMAGEX_METADATA_OPTION, + IMAGEX_NORPFIX_OPTION, + IMAGEX_NOCHECK_OPTION, IMAGEX_NO_ACLS_OPTION, - IMAGEX_REBULID_OPTION, + IMAGEX_NO_PACK_STREAMS_OPTION, + IMAGEX_NOT_PIPABLE_OPTION, + IMAGEX_PACK_STREAMS_OPTION, + IMAGEX_PATH_OPTION, + IMAGEX_PIPABLE_OPTION, + IMAGEX_REBUILD_OPTION, IMAGEX_RECOMPRESS_OPTION, + IMAGEX_RECURSIVE_OPTION, IMAGEX_REF_OPTION, + IMAGEX_RESUME_OPTION, + IMAGEX_RPFIX_OPTION, IMAGEX_SOFT_OPTION, IMAGEX_SOURCE_LIST_OPTION, IMAGEX_STAGING_DIR_OPTION, @@ -182,7 +160,9 @@ enum { IMAGEX_STRICT_ACLS_OPTION, IMAGEX_SYMLINK_OPTION, IMAGEX_THREADS_OPTION, + IMAGEX_TO_STDOUT_OPTION, IMAGEX_UNIX_DATA_OPTION, + IMAGEX_UPDATE_OF_OPTION, IMAGEX_VERBOSE_OPTION, IMAGEX_XML_OPTION, }; @@ -197,44 +177,88 @@ static const struct option apply_options[] = { {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION}, + {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION}, + {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION}, + {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION}, + + /* --resume is undocumented for now as it needs improvement. */ + {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION}, {NULL, 0, NULL, 0}, }; + static const struct option capture_or_append_options[] = { {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION}, {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION}, + {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION}, + {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION}, + {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION}, {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION}, {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION}, {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION}, {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION}, {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION}, - {T("rebuild"), no_argument, NULL, IMAGEX_REBULID_OPTION}, + {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION}, {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION}, {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION}, {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION}, + {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION}, + {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION}, + {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION}, + {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION}, + {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION}, + {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION}, {NULL, 0, NULL, 0}, }; + static const struct option delete_options[] = { {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION}, {NULL, 0, NULL, 0}, }; +static const struct option dir_options[] = { + {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION}, + {NULL, 0, NULL, 0}, +}; + static const struct option export_options[] = { - {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION}, - {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, - {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION}, - {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION}, - {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION}, - {T("rebuild"), no_argument, NULL, IMAGEX_REBULID_OPTION}, + {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION}, + {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION}, + {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION}, + {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION}, + {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION}, + {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION}, + {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION}, + {NULL, 0, NULL, 0}, +}; + +static const struct option extract_options[] = { + {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION}, + {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION}, + {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION}, + {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, + {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, + {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION}, + {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION}, + {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION}, + {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION}, {NULL, 0, NULL, 0}, }; static const struct option info_options[] = { {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION}, {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION}, {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION}, {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION}, @@ -260,8 +284,19 @@ static const struct option mount_options[] = { }; static const struct option optimize_options[] = { - {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, - {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION}, + {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION}, + {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION}, + {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION}, + {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION}, + {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION}, + {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION}, + {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION}, + {T("no-pack-streams"), no_argument, NULL, IMAGEX_NO_PACK_STREAMS_OPTION}, + {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION}, + {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION}, + {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION}, {NULL, 0, NULL, 0}, }; @@ -273,14 +308,48 @@ static const struct option split_options[] = { static const struct option unmount_options[] = { {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION}, {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, - {T("rebuild"), no_argument, NULL, IMAGEX_REBULID_OPTION}, + {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION}, + {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION}, {NULL, 0, NULL, 0}, }; +static const struct option update_options[] = { + /* Careful: some of the options here set the defaults for update + * commands, but the flags given to an actual update command (and not to + * `imagex update' itself are also handled in + * update_command_add_option(). */ + {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION}, + {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION}, + {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION}, + {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION}, + + /* Default delete options */ + {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION}, + {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION}, + + /* Global add option */ + {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION}, + + /* Default add options */ + {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION}, + {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION}, + {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION}, + {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, + {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION}, + {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION}, + + {NULL, 0, NULL, 0}, +}; +#if 0 +# define _format_attribute(type, format_str, args_start) \ + __attribute__((format(type, format_str, args_start))) +#else +# define _format_attribute(type, format_str, args_start) +#endif /* Print formatted error message to stderr. */ -static void +static void _format_attribute(printf, 1, 2) imagex_error(const tchar *format, ...) { va_list va; @@ -292,7 +361,7 @@ imagex_error(const tchar *format, ...) } /* Print formatted error message to stderr. */ -static void +static void _format_attribute(printf, 1, 2) imagex_error_with_errno(const tchar *format, ...) { int errno_save = errno; @@ -310,11 +379,13 @@ verify_image_exists(int image, const tchar *image_name, const tchar *wim_name) if (image == WIMLIB_NO_IMAGE) { imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n" " Please specify a 1-based image index or " - "image name.\n" - " You may use `"IMAGEX_PROGNAME" info' to list the images " - "contained in a WIM."), - image_name, wim_name); - return -1; + "image name. To list the images\n" + " contained in the WIM archive, run\n" + "\n" + " %"TS" \"%"TS"\"\n"), + image_name, wim_name, + get_cmd_string(CMD_INFO, false), wim_name); + return WIMLIB_ERR_INVALID_IMAGE; } return 0; } @@ -324,7 +395,7 @@ verify_image_is_single(int image) { if (image == WIMLIB_ALL_IMAGES) { imagex_error(T("Cannot specify all images for this action!")); - return -1; + return WIMLIB_ERR_INVALID_IMAGE; } return 0; } @@ -348,6 +419,8 @@ get_compression_type(const tchar *optarg) return WIMLIB_COMPRESSION_TYPE_LZX; else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress"))) return WIMLIB_COMPRESSION_TYPE_XPRESS; + else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms"))) + return WIMLIB_COMPRESSION_TYPE_LZMS; else if (!tstrcasecmp(optarg, T("none"))) return WIMLIB_COMPRESSION_TYPE_NONE; else { @@ -357,6 +430,103 @@ get_compression_type(const tchar *optarg) } } +static int +set_compress_slow(void) +{ + int ret; + static const struct wimlib_lzx_params slow_params = { + .size_of_this = sizeof(struct wimlib_lzx_params), + .algorithm = WIMLIB_LZX_ALGORITHM_SLOW, + .alg_params = { + .slow = { + .use_len2_matches = 1, + .num_fast_bytes = 96, + .num_optim_passes = 4, + .max_search_depth = 100, + .max_matches_per_pos = 10, + .main_nostat_cost = 15, + .len_nostat_cost = 15, + .aligned_nostat_cost = 7, + }, + }, + }; + ret = wimlib_lzx_set_default_params(&slow_params); + if (ret) + imagex_error(T("Couldn't set slow compression parameters.!")); + return ret; +} + +struct string_set { + const tchar **strings; + unsigned num_strings; + unsigned num_alloc_strings; +}; + +#define STRING_SET_INITIALIZER \ + { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, } + +#define STRING_SET(_strings) \ + struct string_set _strings = STRING_SET_INITIALIZER + +static int +string_set_append(struct string_set *set, const tchar *glob) +{ + unsigned num_alloc_strings = set->num_alloc_strings; + + if (set->num_strings == num_alloc_strings) { + const tchar **new_strings; + + num_alloc_strings += 4; + new_strings = realloc(set->strings, + sizeof(set->strings[0]) * num_alloc_strings); + if (!new_strings) { + imagex_error(T("Out of memory!")); + return -1; + } + set->strings = new_strings; + set->num_alloc_strings = num_alloc_strings; + } + set->strings[set->num_strings++] = glob; + return 0; +} + +static void +string_set_destroy(struct string_set *set) +{ + free(set->strings); +} + +static int +wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags) +{ + return wimlib_reference_resource_files(wim, set->strings, + set->num_strings, + WIMLIB_REF_FLAG_GLOB_ENABLE, + open_flags, + imagex_progress_func); +} + +static void +do_resource_not_found_warning(const tchar *wimfile, + const struct wimlib_wim_info *info, + const struct string_set *refglobs) +{ + if (info->total_parts > 1) { + if (refglobs->num_strings == 0) { + imagex_error(T("\"%"TS"\" is part of a split WIM. " + "Use --ref to specify the other parts."), + wimfile); + } else { + imagex_error(T("Perhaps the '--ref' argument did not " + "specify all other parts of the split " + "WIM?")); + } + } else { + imagex_error(T("If this is a delta WIM, use the --ref argument " + "to specify the WIM(s) on which it is based.")); + } +} + /* Returns the size of a file given its name, or -1 if the file does not exist * or its size cannot be determined. */ static off_t @@ -369,60 +539,36 @@ file_get_size(const tchar *filename) return (off_t)-1; } -tchar pat_ntfs_log[] = T("/$ntfs.log"); -tchar pat_hiberfil_sys[] = T("/hiberfil.sys"); -tchar pat_pagefile_sys[] = T("/pagefile.sys"); -tchar pat_system_volume_information[] = T("/System Volume Information"); -tchar pat_recycler[] = T("/RECYCLER"); -tchar pat_windows_csc[] = T("/Windows/CSC"); - -tchar *default_pats[] = { - pat_ntfs_log, - pat_hiberfil_sys, - pat_pagefile_sys, - pat_system_volume_information, - pat_recycler, - pat_windows_csc, -}; - -static struct wimlib_capture_config default_capture_config = { - .exclusion_pats = { - .num_pats = sizeof(default_pats) / sizeof(*default_pats), - .pats = default_pats, - }, -}; - enum { - PARSE_FILENAME_SUCCESS = 0, - PARSE_FILENAME_FAILURE = 1, - PARSE_FILENAME_NONE = 2, + PARSE_STRING_SUCCESS = 0, + PARSE_STRING_FAILURE = 1, + PARSE_STRING_NONE = 2, }; /* - * Parses a filename in the source list file format. (See the man page for - * 'wimlib-imagex capture' for details on this format and the meaning.) - * Accepted formats for filenames are an unquoted string (whitespace-delimited), - * or a double or single-quoted string. + * Parses a string token from an array of characters. + * + * Tokens are either whitespace-delimited, or double or single-quoted. * * @line_p: Pointer to the pointer to the line of data. Will be updated - * to point past the filename iff the return value is - * PARSE_FILENAME_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must + * to point past the string token iff the return value is + * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must * be '\0'. * * @len_p: @len_p initially stores the length of the line of data, which may * be 0, and it will be updated to the number of bytes remaining in - * the line iff the return value is PARSE_FILENAME_SUCCESS. + * the line iff the return value is PARSE_STRING_SUCCESS. * - * @fn_ret: Iff the return value is PARSE_FILENAME_SUCCESS, a pointer to the - * parsed filename will be returned here. + * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the + * parsed string token will be returned here. * - * Returns: PARSE_FILENAME_SUCCESS if a filename was successfully parsed; or - * PARSE_FILENAME_FAILURE if the data was invalid due to a missing - * closing quote; or PARSE_FILENAME_NONE if the line ended before the - * beginning of a filename was found. + * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or + * PARSE_STRING_FAILURE if the data was invalid due to a missing + * closing quote; or PARSE_STRING_NONE if the line ended before the + * beginning of a string token was found. */ static int -parse_filename(tchar **line_p, size_t *len_p, tchar **fn_ret) +parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret) { size_t len = *len_p; tchar *line = *line_p; @@ -432,7 +578,7 @@ parse_filename(tchar **line_p, size_t *len_p, tchar **fn_ret) /* Skip leading whitespace */ for (;;) { if (len == 0) - return PARSE_FILENAME_NONE; + return PARSE_STRING_NONE; if (!istspace(*line) && *line != T('\0')) break; line++; @@ -440,17 +586,17 @@ parse_filename(tchar **line_p, size_t *len_p, tchar **fn_ret) } quote_char = *line; if (quote_char == T('"') || quote_char == T('\'')) { - /* Quoted filename */ + /* Quoted string */ line++; len--; fn = line; line = tmemchr(line, quote_char, len); if (!line) { imagex_error(T("Missing closing quote: %"TS), fn - 1); - return PARSE_FILENAME_FAILURE; + return PARSE_STRING_FAILURE; } } else { - /* Unquoted filename. Go until whitespace. Line is terminated + /* Unquoted string. Go until whitespace. Line is terminated * by '\0', so no need to check 'len'. */ fn = line; do { @@ -462,7 +608,7 @@ parse_filename(tchar **line_p, size_t *len_p, tchar **fn_ret) *len_p = len; *line_p = line; *fn_ret = fn; - return PARSE_FILENAME_SUCCESS; + return PARSE_STRING_SUCCESS; } /* Parses a line of data (not an empty line or comment) in the source list file @@ -485,13 +631,13 @@ parse_source_list_line(tchar *line, size_t len, { /* SOURCE [DEST] */ int ret; - ret = parse_filename(&line, &len, &source->fs_source_path); - if (ret != PARSE_FILENAME_SUCCESS) + ret = parse_string(&line, &len, &source->fs_source_path); + if (ret != PARSE_STRING_SUCCESS) return false; - ret = parse_filename(&line, &len, &source->wim_target_path); - if (ret == PARSE_FILENAME_NONE) + ret = parse_string(&line, &len, &source->wim_target_path); + if (ret == PARSE_STRING_NONE) source->wim_target_path = source->fs_source_path; - return ret != PARSE_FILENAME_FAILURE; + return ret != PARSE_STRING_FAILURE; } /* Returns %true if the given line of length @len > 0 is a comment or empty line @@ -691,12 +837,12 @@ parse_capture_config_line(tchar *line, size_t len, "(such as [ExclusionList]"), line); return false; case CAPTURE_CONFIG_EXCLUSION_SECTION: - if (parse_filename(&line, &len, &filename) != PARSE_FILENAME_SUCCESS) + if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS) return false; return pattern_list_add_pattern(&config->exclusion_pats, filename); case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION: - if (parse_filename(&line, &len, &filename) != PARSE_FILENAME_SUCCESS) + if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS) return false; return pattern_list_add_pattern(&config->exclusion_exception_pats, filename); @@ -757,7 +903,7 @@ file_get_contents(const tchar *filename, size_t *len_ret) goto out; } - buf = malloc(len); + buf = malloc(len ? len : 1); if (!buf) { imagex_error(T("Failed to allocate buffer of %zu bytes to hold " "contents of file \"%"TS"\""), len, filename); @@ -821,8 +967,7 @@ stdin_get_contents(size_t *len_ret) static tchar * -translate_text_to_tstr(char *text, size_t num_bytes, - size_t *num_tchars_ret) +translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret) { #ifndef __WIN32__ /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8. @@ -835,8 +980,8 @@ translate_text_to_tstr(char *text, size_t num_bytes, size_t num_wchars; if (num_bytes >= 2 && - ((text[0] == 0xff && text[1] == 0xfe) || - (text[0] <= 0x7f && text[1] == 0x00))) + (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) || + ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00))) { /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins * with something that looks like an ASCII character encoded as @@ -883,35 +1028,29 @@ stdin_get_text_contents(size_t *num_tchars_ret) return translate_text_to_tstr(contents, num_bytes, num_tchars_ret); } -/* Return 0 if a path names a file to which the current user has write access; - * -1 otherwise (and print an error message). */ -static int -file_writable(const tchar *path) -{ - int ret; - ret = taccess(path, W_OK); - if (ret != 0) - imagex_error_with_errno(T("Can't modify \"%"TS"\""), path); - return ret; -} - #define TO_PERCENT(numerator, denominator) \ (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator))) -/* Given an enumerated value for WIM compression type, return a descriptive - * string. */ -static const tchar * -get_data_type(int ctype) +#define GIBIBYTE_MIN_NBYTES 10000000000ULL +#define MEBIBYTE_MIN_NBYTES 10000000ULL +#define KIBIBYTE_MIN_NBYTES 10000ULL + +static unsigned +get_unit(uint64_t total_bytes, const tchar **name_ret) { - switch (ctype) { - case WIMLIB_COMPRESSION_TYPE_NONE: - return T("uncompressed"); - case WIMLIB_COMPRESSION_TYPE_LZX: - return T("LZX-compressed"); - case WIMLIB_COMPRESSION_TYPE_XPRESS: - return T("XPRESS-compressed"); + if (total_bytes >= GIBIBYTE_MIN_NBYTES) { + *name_ret = T("GiB"); + return 30; + } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) { + *name_ret = T("MiB"); + return 20; + } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) { + *name_ret = T("KiB"); + return 10; + } else { + *name_ret = T("bytes"); + return 0; } - return NULL; } /* Progress callback function passed to various wimlib functions. */ @@ -920,68 +1059,102 @@ imagex_progress_func(enum wimlib_progress_msg msg, const union wimlib_progress_info *info) { unsigned percent_done; + unsigned unit_shift; + const tchar *unit_name; + if (imagex_be_quiet) + return 0; switch (msg) { case WIMLIB_PROGRESS_MSG_WRITE_STREAMS: + unit_shift = get_unit(info->write_streams.total_bytes, &unit_name); percent_done = TO_PERCENT(info->write_streams.completed_bytes, info->write_streams.total_bytes); - if (info->write_streams.completed_streams == 0) { - const tchar *data_type; - data_type = get_data_type(info->write_streams.compression_type); - tprintf(T("Writing %"TS" data using %u thread%"TS"\n"), - data_type, info->write_streams.num_threads, + if (info->write_streams.completed_streams == 0) { + imagex_printf(T("Writing %"TS"-compressed data using %u thread%"TS"\n"), + wimlib_get_compression_type_string(info->write_streams.compression_type), + info->write_streams.num_threads, (info->write_streams.num_threads == 1) ? T("") : T("s")); } - tprintf(T("\r%"PRIu64" MiB of %"PRIu64" MiB (uncompressed) " - "written (%u%% done)"), - info->write_streams.completed_bytes >> 20, - info->write_streams.total_bytes >> 20, - percent_done); + if (info->write_streams.total_parts <= 1) { + imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) " + "written (%u%% done)"), + info->write_streams.completed_bytes >> unit_shift, + unit_name, + info->write_streams.total_bytes >> unit_shift, + unit_name, + percent_done); + } else { + imagex_printf(T("\rWriting resources from part %u of %u: " + "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"), + (info->write_streams.completed_parts == + info->write_streams.total_parts) ? + info->write_streams.completed_parts : + info->write_streams.completed_parts + 1, + info->write_streams.total_parts, + info->write_streams.completed_bytes >> unit_shift, + unit_name, + info->write_streams.total_bytes >> unit_shift, + unit_name, + percent_done); + } if (info->write_streams.completed_bytes >= info->write_streams.total_bytes) - tputchar(T('\n')); + imagex_printf(T("\n")); break; case WIMLIB_PROGRESS_MSG_SCAN_BEGIN: - tprintf(T("Scanning \"%"TS"\""), info->scan.source); + imagex_printf(T("Scanning \"%"TS"\""), info->scan.source); if (*info->scan.wim_target_path) { - tprintf(T(" (loading as WIM path: \"/%"TS"\")...\n"), + imagex_printf(T(" (loading as WIM path: " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"), info->scan.wim_target_path); } else { - tprintf(T(" (loading as root of WIM image)...\n")); + imagex_printf(T(" (loading as root of WIM image)...\n")); } break; case WIMLIB_PROGRESS_MSG_SCAN_DENTRY: - if (info->scan.excluded) - tprintf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path); - else - tprintf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path); + switch (info->scan.status) { + case WIMLIB_SCAN_DENTRY_OK: + imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path); + break; + case WIMLIB_SCAN_DENTRY_EXCLUDED: + imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path); + break; + case WIMLIB_SCAN_DENTRY_UNSUPPORTED: + imagex_printf(T("WARNING: Excluding unsupported file or directory\n" + " \"%"TS"\" from capture\n"), info->scan.cur_path); + break; + } break; - /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/ - /*break;*/ case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY: + unit_shift = get_unit(info->integrity.total_bytes, &unit_name); percent_done = TO_PERCENT(info->integrity.completed_bytes, info->integrity.total_bytes); - tprintf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" MiB " - "of %"PRIu64" MiB (%u%%) done"), + imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" " + "of %"PRIu64" %"TS" (%u%%) done"), info->integrity.filename, - info->integrity.completed_bytes >> 20, - info->integrity.total_bytes >> 20, + info->integrity.completed_bytes >> unit_shift, + unit_name, + info->integrity.total_bytes >> unit_shift, + unit_name, percent_done); if (info->integrity.completed_bytes == info->integrity.total_bytes) - tputchar(T('\n')); + imagex_printf(T("\n")); break; case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY: + unit_shift = get_unit(info->integrity.total_bytes, &unit_name); percent_done = TO_PERCENT(info->integrity.completed_bytes, info->integrity.total_bytes); - tprintf(T("\rCalculating integrity table for WIM: %"PRIu64" MiB " - "of %"PRIu64" MiB (%u%%) done"), - info->integrity.completed_bytes >> 20, - info->integrity.total_bytes >> 20, + imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" " + "of %"PRIu64" %"TS" (%u%%) done"), + info->integrity.completed_bytes >> unit_shift, + unit_name, + info->integrity.total_bytes >> unit_shift, + unit_name, percent_done); if (info->integrity.completed_bytes == info->integrity.total_bytes) - tputchar(T('\n')); + imagex_printf(T("\n")); break; case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN: - tprintf(T("Applying image %d (%"TS") from \"%"TS"\" " + imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" " "to %"TS" \"%"TS"\"\n"), info->extract.image, info->extract.image_name, @@ -990,132 +1163,95 @@ imagex_progress_func(enum wimlib_progress_msg msg, T("NTFS volume") : T("directory")), info->extract.target); break; - /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/ - /*tprintf(T("Applying directory structure to %"TS"\n"),*/ - /*info->extract.target);*/ - /*break;*/ + case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN: + imagex_printf(T("Extracting " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") " + "in \"%"TS"\" to \"%"TS"\"\n"), + info->extract.extract_root_wim_source_path, + info->extract.image, + info->extract.image_name, + info->extract.wimfile_name, + info->extract.target); + break; case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS: percent_done = TO_PERCENT(info->extract.completed_bytes, info->extract.total_bytes); - tprintf(T("\rExtracting files: " - "%"PRIu64" MiB of %"PRIu64" MiB (%u%%) done"), - info->extract.completed_bytes >> 20, - info->extract.total_bytes >> 20, + unit_shift = get_unit(info->extract.total_bytes, &unit_name); + imagex_printf(T("\rExtracting files: " + "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"), + info->extract.completed_bytes >> unit_shift, + unit_name, + info->extract.total_bytes >> unit_shift, + unit_name, percent_done); if (info->extract.completed_bytes >= info->extract.total_bytes) - tputchar(T('\n')); + imagex_printf(T("\n")); break; - case WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY: - tprintf(T("%"TS"\n"), info->extract.cur_path); + case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN: + if (info->extract.total_parts != 1) { + imagex_printf(T("\nReading split pipable WIM part %u of %u\n"), + info->extract.part_number, + info->extract.total_parts); + } break; case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS: - tprintf(T("Setting timestamps on all extracted files...\n")); + if (info->extract.extract_root_wim_source_path[0] == T('\0')) + imagex_printf(T("Setting timestamps on all extracted files...\n")); break; case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END: if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { - tprintf(T("Unmounting NTFS volume \"%"TS"\"...\n"), + imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"), info->extract.target); } break; - case WIMLIB_PROGRESS_MSG_JOIN_STREAMS: - percent_done = TO_PERCENT(info->join.completed_bytes, - info->join.total_bytes); - tprintf(T("Writing resources from part %u of %u: " - "%"PRIu64 " MiB of %"PRIu64" MiB (%u%%) written\n"), - (info->join.completed_parts == info->join.total_parts) ? - info->join.completed_parts : info->join.completed_parts + 1, - info->join.total_parts, - info->join.completed_bytes >> 20, - info->join.total_bytes >> 20, - percent_done); - break; case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART: percent_done = TO_PERCENT(info->split.completed_bytes, info->split.total_bytes); - tprintf(T("Writing \"%"TS"\": %"PRIu64" MiB of " - "%"PRIu64" MiB (%u%%) written\n"), + unit_shift = get_unit(info->split.total_bytes, &unit_name); + imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of " + "%"PRIu64" %"TS" (%u%%) written\n"), info->split.part_name, - info->split.completed_bytes >> 20, - info->split.total_bytes >> 20, + info->split.cur_part_number, + info->split.total_parts, + info->split.completed_bytes >> unit_shift, + unit_name, + info->split.total_bytes >> unit_shift, + unit_name, percent_done); break; case WIMLIB_PROGRESS_MSG_SPLIT_END_PART: if (info->split.completed_bytes == info->split.total_bytes) { - tprintf(T("Finished writing %u split WIM parts\n"), - info->split.cur_part_number); + imagex_printf(T("Finished writing split WIM part %u of %u\n"), + info->split.cur_part_number, + info->split.total_parts); + } + break; + case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND: + switch (info->update.command->op) { + case WIMLIB_UPDATE_OP_DELETE: + imagex_printf(T("Deleted WIM path " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"), + info->update.command->delete_.wim_path); + break; + case WIMLIB_UPDATE_OP_RENAME: + imagex_printf(T("Renamed WIM path " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"), + info->update.command->rename.wim_source_path, + info->update.command->rename.wim_target_path); + break; + case WIMLIB_UPDATE_OP_ADD: + default: + break; } break; default: break; } - fflush(stdout); + fflush(imagex_info_file); return 0; } -/* Open all the split WIM parts that correspond to a file glob. - * - * @first_part specifies the first part of the split WIM and it may be either - * included or omitted from the glob. */ -static int -open_swms_from_glob(const tchar *swm_glob, - const tchar *first_part, - int open_flags, - WIMStruct ***additional_swms_ret, - unsigned *num_additional_swms_ret) -{ - unsigned num_additional_swms = 0; - WIMStruct **additional_swms = NULL; - glob_t globbuf; - int ret; - - /* Warning: glob() is replaced in Windows native builds */ - ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf); - if (ret != 0) { - if (ret == GLOB_NOMATCH) { - imagex_error(T("Found no files for glob \"%"TS"\""), - swm_glob); - } else { - imagex_error_with_errno(T("Failed to process glob \"%"TS"\""), - swm_glob); - } - ret = -1; - goto out; - } - num_additional_swms = globbuf.gl_pathc; - additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0])); - if (!additional_swms) { - imagex_error(T("Out of memory")); - ret = -1; - goto out_globfree; - } - unsigned offset = 0; - for (unsigned i = 0; i < num_additional_swms; i++) { - if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) { - offset++; - continue; - } - ret = wimlib_open_wim(globbuf.gl_pathv[i], - open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, - &additional_swms[i - offset], - imagex_progress_func); - if (ret != 0) - goto out_close_swms; - } - *additional_swms_ret = additional_swms; - *num_additional_swms_ret = num_additional_swms - offset; - ret = 0; - goto out_globfree; -out_close_swms: - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); -out_globfree: - globfree(&globbuf); -out: - return ret; -} - - static unsigned parse_num_threads(const tchar *optarg) { @@ -1129,134 +1265,402 @@ parse_num_threads(const tchar *optarg) } } - -/* Apply one image, or all images, from a WIM file into a directory, OR apply - * one image from a WIM file to a NTFS volume. */ -static int -imagex_apply(int argc, tchar **argv) +static uint32_t parse_chunk_size(const tchar *optarg) { - int c; - int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; - int image; - int num_images; - WIMStruct *w; - int ret; - const tchar *wimfile; - const tchar *target; - const tchar *image_num_or_name; - int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL; - - const tchar *swm_glob = NULL; - WIMStruct **additional_swms = NULL; - unsigned num_additional_swms = 0; + tchar *tmp; + unsigned long chunk_size = tstrtoul(optarg, &tmp, 10); + if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) { + imagex_error(T("Chunk size must be a non-negative integer!")); + return UINT32_MAX; + } else { + return chunk_size; + } +} - for_opt(c, apply_options) { - switch (c) { - case IMAGEX_CHECK_OPTION: - open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; - break; - case IMAGEX_HARDLINK_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK; - break; - case IMAGEX_SYMLINK_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK; - break; - case IMAGEX_VERBOSE_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE; - break; - case IMAGEX_REF_OPTION: - swm_glob = optarg; - break; - case IMAGEX_UNIX_DATA_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA; - break; - case IMAGEX_NO_ACLS_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS; - break; - case IMAGEX_STRICT_ACLS_OPTION: - extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS; - break; - default: - usage(APPLY); - return -1; - } - } - argc -= optind; - argv += optind; - if (argc != 2 && argc != 3) { - usage(APPLY); - return -1; - } - wimfile = argv[0]; - if (argc == 2) { - image_num_or_name = T("1"); - target = argv[1]; - } else { - image_num_or_name = argv[1]; - target = argv[2]; +/* + * Parse an option passed to an update command. + * + * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being + * parsed. + * + * @option: Text string for the option (beginning with --) + * + * @cmd: `struct wimlib_update_command' that is being constructed for + * this command. + * + * Returns true if the option was recognized; false if not. + */ +static bool +update_command_add_option(int op, const tchar *option, + struct wimlib_update_command *cmd) +{ + bool recognized = true; + switch (op) { + case WIMLIB_UPDATE_OP_ADD: + if (!tstrcmp(option, T("--verbose"))) + cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE; + else if (!tstrcmp(option, T("--unix-data"))) + cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA; + else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls"))) + cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS; + else if (!tstrcmp(option, T("--strict-acls"))) + cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS; + else if (!tstrcmp(option, T("--dereference"))) + cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE; + else + recognized = false; + break; + case WIMLIB_UPDATE_OP_DELETE: + if (!tstrcmp(option, T("--force"))) + cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE; + else if (!tstrcmp(option, T("--recursive"))) + cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE; + else + recognized = false; + break; + default: + recognized = false; + break; } + return recognized; +} - ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func); - if (ret != 0) - return ret; - - image = wimlib_resolve_image(w, image_num_or_name); - ret = verify_image_exists(image, image_num_or_name, wimfile); - if (ret != 0) - goto out; +/* How many nonoption arguments each `imagex update' command expects */ +static const unsigned update_command_num_nonoptions[] = { + [WIMLIB_UPDATE_OP_ADD] = 2, + [WIMLIB_UPDATE_OP_DELETE] = 1, + [WIMLIB_UPDATE_OP_RENAME] = 2, +}; - num_images = wimlib_get_num_images(w); - if (argc == 2 && num_images != 1) { - imagex_error(T("\"%"TS"\" contains %d images; Please select one " - "(or all)"), wimfile, num_images); - usage(APPLY); - ret = -1; - goto out; - } +static void +update_command_add_nonoption(int op, const tchar *nonoption, + struct wimlib_update_command *cmd, + unsigned num_nonoptions) +{ + switch (op) { + case WIMLIB_UPDATE_OP_ADD: + if (num_nonoptions == 0) + cmd->add.fs_source_path = (tchar*)nonoption; + else + cmd->add.wim_target_path = (tchar*)nonoption; + break; + case WIMLIB_UPDATE_OP_DELETE: + cmd->delete_.wim_path = (tchar*)nonoption; + break; + case WIMLIB_UPDATE_OP_RENAME: + if (num_nonoptions == 0) + cmd->rename.wim_source_path = (tchar*)nonoption; + else + cmd->rename.wim_target_path = (tchar*)nonoption; + break; + } +} + +/* + * Parse a command passed on stdin to `imagex update'. + * + * @line: Text of the command. + * @len: Length of the line, including a null terminator + * at line[len - 1]. + * + * @command: A `struct wimlib_update_command' to fill in from the parsed + * line. + * + * @line_number: Line number of the command, for diagnostics. + * + * Returns true on success; returns false on parse error. + */ +static bool +parse_update_command(tchar *line, size_t len, + struct wimlib_update_command *command, + size_t line_number) +{ + int ret; + tchar *command_name; + int op; + size_t num_nonoptions; + + /* Get the command name ("add", "delete", "rename") */ + ret = parse_string(&line, &len, &command_name); + if (ret != PARSE_STRING_SUCCESS) + return false; - if (swm_glob) { - ret = open_swms_from_glob(swm_glob, wimfile, open_flags, - &additional_swms, - &num_additional_swms); - if (ret != 0) - goto out; + if (!tstrcasecmp(command_name, T("add"))) { + op = WIMLIB_UPDATE_OP_ADD; + } else if (!tstrcasecmp(command_name, T("delete"))) { + op = WIMLIB_UPDATE_OP_DELETE; + } else if (!tstrcasecmp(command_name, T("rename"))) { + op = WIMLIB_UPDATE_OP_RENAME; + } else { + imagex_error(T("Unknown update command \"%"TS"\" on line %zu"), + command_name, line_number); + return false; } + command->op = op; - struct stat stbuf; + /* Parse additional options and non-options as needed */ + num_nonoptions = 0; + for (;;) { + tchar *next_string; - ret = tstat(target, &stbuf); - if (ret == 0) { - if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) - extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS; + ret = parse_string(&line, &len, &next_string); + if (ret == PARSE_STRING_NONE) /* End of line */ + break; + else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */ + return false; + if (next_string[0] == T('-') && next_string[1] == T('-')) { + /* Option */ + if (!update_command_add_option(op, next_string, command)) + { + imagex_error(T("Unrecognized option \"%"TS"\" to " + "update command \"%"TS"\" on line %zu"), + next_string, command_name, line_number); + + return false; + } + } else { + /* Nonoption */ + if (num_nonoptions == update_command_num_nonoptions[op]) + { + imagex_error(T("Unexpected argument \"%"TS"\" in " + "update command on line %zu\n" + " (The \"%"TS"\" command only " + "takes %zu nonoption arguments!)\n"), + next_string, line_number, + command_name, num_nonoptions); + return false; + } + update_command_add_nonoption(op, next_string, + command, num_nonoptions); + num_nonoptions++; + } + } + + if (num_nonoptions != update_command_num_nonoptions[op]) { + imagex_error(T("Not enough arguments to update command " + "\"%"TS"\" on line %zu"), command_name, line_number); + return false; + } + return true; +} + +static struct wimlib_update_command * +parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars, + size_t *num_cmds_ret) +{ + ssize_t nlines; + tchar *p; + struct wimlib_update_command *cmds; + size_t i, j; + + nlines = text_file_count_lines(cmd_file_contents_p, + &cmd_file_nchars); + if (nlines < 0) + return NULL; + + /* Always allocate at least 1 slot, just in case the implementation of + * calloc() returns NULL if 0 bytes are requested. */ + cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command)); + if (!cmds) { + imagex_error(T("out of memory")); + return NULL; + } + p = *cmd_file_contents_p; + j = 0; + for (i = 0; i < nlines; i++) { + /* XXX: Could use rawmemchr() here instead, but it may not be + * available on all platforms. */ + tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars); + size_t len = endp - p + 1; + *endp = T('\0'); + if (!is_comment_line(p, len)) { + if (!parse_update_command(p, len, &cmds[j++], i + 1)) { + free(cmds); + return NULL; + } + } + p = endp + 1; + } + *num_cmds_ret = j; + return cmds; +} + +/* Apply one image, or all images, from a WIM file into a directory, OR apply + * one image from a WIM file to a NTFS volume. */ +static int +imagex_apply(int argc, tchar **argv, int cmd) +{ + int c; + int open_flags = 0; + int image = WIMLIB_NO_IMAGE; + WIMStruct *wim; + struct wimlib_wim_info info; + int ret; + const tchar *wimfile; + const tchar *target; + const tchar *image_num_or_name = NULL; + int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL; + + STRING_SET(refglobs); + + for_opt(c, apply_options) { + switch (c) { + case IMAGEX_CHECK_OPTION: + open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; + break; + case IMAGEX_HARDLINK_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK; + break; + case IMAGEX_SYMLINK_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK; + break; + case IMAGEX_VERBOSE_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE; + break; + case IMAGEX_REF_OPTION: + ret = string_set_append(&refglobs, optarg); + if (ret) + goto out_free_refglobs; + break; + case IMAGEX_UNIX_DATA_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA; + break; + case IMAGEX_NO_ACLS_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS; + break; + case IMAGEX_STRICT_ACLS_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS; + break; + case IMAGEX_NORPFIX_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX; + break; + case IMAGEX_RPFIX_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX; + break; + case IMAGEX_INCLUDE_INVALID_NAMES_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES; + extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS; + break; + case IMAGEX_RESUME_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME; + break; + default: + goto out_usage; + } + } + argc -= optind; + argv += optind; + if (argc != 2 && argc != 3) + goto out_usage; + + wimfile = argv[0]; + + if (!tstrcmp(wimfile, T("-"))) { + /* Attempt to apply pipable WIM from standard input. */ + if (argc == 2) { + image_num_or_name = NULL; + target = argv[1]; + } else { + image_num_or_name = argv[1]; + target = argv[2]; + } + wim = NULL; } else { - if (errno != ENOENT) { - imagex_error_with_errno(T("Failed to stat \"%"TS"\""), - target); + ret = wimlib_open_wim(wimfile, open_flags, &wim, + imagex_progress_func); + if (ret) + goto out_free_refglobs; + + wimlib_get_wim_info(wim, &info); + + if (argc >= 3) { + /* Image explicitly specified. */ + image_num_or_name = argv[1]; + image = wimlib_resolve_image(wim, image_num_or_name); + ret = verify_image_exists(image, image_num_or_name, wimfile); + if (ret) + goto out_wimlib_free; + target = argv[2]; + } else { + /* No image specified; default to image 1, but only if the WIM + * contains exactly one image. */ + + if (info.image_count != 1) { + imagex_error(T("\"%"TS"\" contains %d images; " + "Please select one (or all)."), + wimfile, info.image_count); + wimlib_free(wim); + goto out_usage; + } + image = 1; + target = argv[1]; + } + } + + if (refglobs.num_strings) { + if (wim == NULL) { + imagex_error(T("Can't specify --ref when applying from stdin!")); ret = -1; - goto out; + goto out_wimlib_free; } + ret = wim_reference_globs(wim, &refglobs, open_flags); + if (ret) + goto out_wimlib_free; } -#ifdef __WIN32__ - win32_acquire_restore_privileges(); -#endif - ret = wimlib_extract_image(w, image, target, extract_flags, - additional_swms, num_additional_swms, - imagex_progress_func); - if (ret == 0) - tprintf(T("Done applying WIM image.\n")); -#ifdef __WIN32__ - win32_release_restore_privileges(); +#ifndef __WIN32__ + { + /* Interpret a regular file or block device target as a NTFS + * volume. */ + struct stat stbuf; + + if (tstat(target, &stbuf)) { + if (errno != ENOENT) { + imagex_error_with_errno(T("Failed to stat \"%"TS"\""), + target); + ret = -1; + goto out_wimlib_free; + } + } else { + if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) + extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS; + } + } #endif -out: - wimlib_free(w); - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); + + if (wim) { + ret = wimlib_extract_image(wim, image, target, extract_flags, + imagex_progress_func); + } else { + set_fd_to_binary_mode(STDIN_FILENO); + ret = wimlib_extract_image_from_pipe(STDIN_FILENO, + image_num_or_name, + target, extract_flags, + imagex_progress_func); + } + if (ret == 0) { + imagex_printf(T("Done applying WIM image.\n")); + } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) { + if (wim) { + do_resource_not_found_warning(wimfile, &info, &refglobs); + } else { + imagex_error(T( "If you are applying an image " + "from a split pipable WIM,\n" + " make sure you have " + "concatenated together all parts.")); + } } +out_wimlib_free: + wimlib_free(wim); +out_free_refglobs: + string_set_destroy(&refglobs); return ret; + +out_usage: + usage(CMD_APPLY, stderr); + ret = -1; + goto out_free_refglobs; } /* Create a WIM image from a directory tree, NTFS volume, or multiple files or @@ -1264,37 +1668,47 @@ out: * the desired image. 'wimlib-imagex append': add a new image to an existing * WIM file. */ static int -imagex_capture_or_append(int argc, tchar **argv) +imagex_capture_or_append(int argc, tchar **argv, int cmd) { int c; - int open_flags = 0; - int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; + int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE | + WIMLIB_ADD_IMAGE_FLAG_WINCONFIG; int write_flags = 0; - int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS; + int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID; + uint32_t chunk_size = UINT32_MAX; const tchar *wimfile; + int wim_fd; const tchar *name; const tchar *desc; const tchar *flags_element = NULL; - WIMStruct *w; + + WIMStruct *wim; + STRING_SET(base_wimfiles); + WIMStruct **base_wims; + + WIMStruct *template_wim; + const tchar *template_wimfile = NULL; + const tchar *template_image_name_or_num = NULL; + int template_image = WIMLIB_NO_IMAGE; + int ret; - int cur_image; - int cmd = tstrcmp(argv[0], T("append")) ? CAPTURE : APPEND; unsigned num_threads = 0; tchar *source; - size_t source_name_len; tchar *source_copy; const tchar *config_file = NULL; tchar *config_str; - struct wimlib_capture_config *config = NULL; + struct wimlib_capture_config *config; bool source_list = false; - size_t source_list_nchars; + size_t source_list_nchars = 0; tchar *source_list_contents; bool capture_sources_malloced; struct wimlib_capture_source *capture_sources; size_t num_sources; + bool name_defaulted; for_opt(c, capture_or_append_options) { switch (c) { @@ -1305,13 +1719,31 @@ imagex_capture_or_append(int argc, tchar **argv) open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; + case IMAGEX_NOCHECK_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY; + break; case IMAGEX_CONFIG_OPTION: config_file = optarg; + add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG; break; case IMAGEX_COMPRESS_OPTION: compression_type = get_compression_type(optarg); if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) - return -1; + goto out_err; + break; + case IMAGEX_COMPRESS_SLOW_OPTION: + ret = set_compress_slow(); + if (ret) + goto out_err; + compression_type = WIMLIB_COMPRESSION_TYPE_LZX; + break; + case IMAGEX_CHUNK_SIZE_OPTION: + chunk_size = parse_chunk_size(optarg); + if (chunk_size == UINT32_MAX) + goto out_err; + break; + case IMAGEX_PACK_STREAMS_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS; break; case IMAGEX_FLAGS_OPTION: flags_element = optarg; @@ -1325,9 +1757,9 @@ imagex_capture_or_append(int argc, tchar **argv) case IMAGEX_THREADS_OPTION: num_threads = parse_num_threads(optarg); if (num_threads == UINT_MAX) - return -1; + goto out_err; break; - case IMAGEX_REBULID_OPTION: + case IMAGEX_REBUILD_OPTION: write_flags |= WIMLIB_WRITE_FLAG_REBUILD; break; case IMAGEX_UNIX_DATA_OPTION: @@ -1342,34 +1774,146 @@ imagex_capture_or_append(int argc, tchar **argv) case IMAGEX_STRICT_ACLS_OPTION: add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS; break; + case IMAGEX_RPFIX_OPTION: + add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX; + break; + case IMAGEX_NORPFIX_OPTION: + add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX; + break; + case IMAGEX_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_PIPABLE; + break; + case IMAGEX_NOT_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE; + break; + case IMAGEX_UPDATE_OF_OPTION: + if (template_image_name_or_num) { + imagex_error(T("'--update-of' can only be " + "specified one time!")); + goto out_err; + } else { + tchar *colon; + colon = tstrrchr(optarg, T(':')); + + if (colon) { + template_wimfile = optarg; + *colon = T('\0'); + template_image_name_or_num = colon + 1; + } else { + template_wimfile = NULL; + template_image_name_or_num = optarg; + } + } + break; + case IMAGEX_DELTA_FROM_OPTION: + if (cmd != CMD_CAPTURE) { + imagex_error(T("'--delta-from' is only " + "valid for capture!")); + goto out_usage; + } + ret = string_set_append(&base_wimfiles, optarg); + if (ret) + goto out_free_base_wimfiles; + write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS; + break; default: - usage(cmd); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc < 2 || argc > 4) { - usage(cmd); - return -1; - } + if (argc < 2 || argc > 4) + goto out_usage; source = argv[0]; wimfile = argv[1]; + /* Set default compression type. */ + if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) { + struct wimlib_lzx_params params; + memset(¶ms, 0, sizeof(params)); + params.size_of_this = sizeof(params); + params.algorithm = WIMLIB_LZX_ALGORITHM_FAST; + params.use_defaults = 1; + + wimlib_lzx_set_default_params(¶ms); + compression_type = WIMLIB_COMPRESSION_TYPE_LZX; + } + + if (!tstrcmp(wimfile, T("-"))) { + /* Writing captured WIM to standard output. */ + #if 0 + if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) { + imagex_error("Can't write a non-pipable WIM to " + "standard output! Specify --pipable\n" + " if you want to create a pipable WIM " + "(but read the docs first)."); + goto out_err; + } + #else + write_flags |= WIMLIB_WRITE_FLAG_PIPABLE; + #endif + if (cmd == CMD_APPEND) { + imagex_error(T("Using standard output for append does " + "not make sense.")); + goto out_err; + } + wim_fd = STDOUT_FILENO; + wimfile = NULL; + imagex_info_file = stderr; + set_fd_to_binary_mode(wim_fd); + } + + /* If template image was specified using --update-of=IMAGE rather + * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */ + if (template_image_name_or_num && !template_wimfile) { + if (base_wimfiles.num_strings == 1) { + /* Capturing delta WIM based on single WIM: default to + * base WIM. */ + template_wimfile = base_wimfiles.strings[0]; + } else if (cmd == CMD_APPEND) { + /* Appending to WIM: default to WIM being appended to. + */ + template_wimfile = wimfile; + } else { + /* Capturing a normal (non-delta) WIM, so the WIM file + * *must* be explicitly specified. */ + if (base_wimfiles.num_strings > 1) { + imagex_error(T("For capture of delta WIM " + "based on multiple existing " + "WIMs,\n" + " '--update-of' must " + "specify WIMFILE:IMAGE!")); + } else { + imagex_error(T("For capture of non-delta WIM, " + "'--update-of' must specify " + "WIMFILE:IMAGE!")); + } + goto out_usage; + } + } + if (argc >= 3) { name = argv[2]; + name_defaulted = false; } else { /* Set default name to SOURCE argument, omitting any directory * prefixes and trailing slashes. This requires making a copy - * of @source. */ + * of @source. Leave some free characters at the end in case we + * append a number to keep the name unique. */ + size_t source_name_len; + source_name_len = tstrlen(source); - source_copy = alloca((source_name_len + 1) * sizeof(tchar)); + source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar)); name = tbasename(tstrcpy(source_copy, source)); + name_defaulted = true; } /* Image description defaults to NULL if not given. */ - desc = (argc >= 4) ? argv[3] : NULL; + if (argc >= 4) + desc = argv[3]; + else + desc = NULL; if (source_list) { /* Set up capture sources in source list mode */ @@ -1380,7 +1924,7 @@ imagex_capture_or_append(int argc, tchar **argv) &source_list_nchars); } if (!source_list_contents) - return -1; + goto out_err; capture_sources = parse_source_list(&source_list_contents, source_list_nchars, @@ -1391,8 +1935,7 @@ imagex_capture_or_append(int argc, tchar **argv) } capture_sources_malloced = true; } else { - /* Set up capture source in non-source-list mode (could be - * either "normal" mode or "NTFS mode"--- see the man page). */ + /* Set up capture source in non-source-list mode. */ capture_sources = alloca(sizeof(struct wimlib_capture_source)); capture_sources[0].fs_source_path = source; capture_sources[0].wim_target_path = NULL; @@ -1403,6 +1946,7 @@ imagex_capture_or_append(int argc, tchar **argv) } if (config_file) { + /* Read and parse capture configuration file. */ size_t config_len; config_str = file_get_text_contents(config_file, &config_len); @@ -1416,23 +1960,37 @@ imagex_capture_or_append(int argc, tchar **argv) if (ret) goto out_free_config; } else { - config = &default_capture_config; + /* No capture configuration file specified; use default + * configuration for capturing Windows operating systems. */ + config = NULL; + add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG; } - if (cmd == APPEND) - ret = wimlib_open_wim(wimfile, open_flags, &w, + /* Open the existing WIM, or create a new one. */ + if (cmd == CMD_APPEND) + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); else - ret = wimlib_create_new_wim(compression_type, &w); + ret = wimlib_create_new_wim(compression_type, &wim); if (ret) goto out_free_config; + /* Set chunk size if non-default. */ + if (chunk_size != UINT32_MAX) { + ret = wimlib_set_output_chunk_size(wim, chunk_size); + if (ret) + goto out_free_wim; + } + +#ifndef __WIN32__ + /* Detect if source is regular file or block device and set NTFS volume + * capture mode. */ if (!source_list) { struct stat stbuf; - ret = tstat(source, &stbuf); - if (ret == 0) { + + if (tstat(source, &stbuf) == 0) { if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) { - tprintf(T("Capturing WIM image from NTFS " + imagex_printf(T("Capturing WIM image from NTFS " "filesystem on \"%"TS"\"\n"), source); add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS; } @@ -1441,54 +1999,182 @@ imagex_capture_or_append(int argc, tchar **argv) imagex_error_with_errno(T("Failed to stat " "\"%"TS"\""), source); ret = -1; - goto out_wimlib_free; + goto out_free_wim; } } } -#ifdef __WIN32__ - win32_acquire_capture_privileges(); #endif - ret = wimlib_add_image_multisource(w, + /* If the user did not specify an image name, and the basename of the + * source already exists as an image name in the WIM file, append a + * suffix to make it unique. */ + if (cmd == CMD_APPEND && name_defaulted) { + unsigned long conflict_idx; + tchar *name_end = tstrchr(name, T('\0')); + for (conflict_idx = 1; + wimlib_image_name_in_use(wim, name); + conflict_idx++) + { + tsprintf(name_end, T(" (%lu)"), conflict_idx); + } + } + + /* If capturing a delta WIM, reference resources from the base WIMs + * before adding the new image. */ + if (base_wimfiles.num_strings) { + base_wims = calloc(base_wimfiles.num_strings, + sizeof(base_wims[0])); + if (base_wims == NULL) { + imagex_error(T("Out of memory!")); + ret = -1; + goto out_free_wim; + } + + for (size_t i = 0; i < base_wimfiles.num_strings; i++) { + ret = wimlib_open_wim(base_wimfiles.strings[i], + open_flags, &base_wims[i], + imagex_progress_func); + if (ret) + goto out_free_base_wims; + + } + + ret = wimlib_reference_resources(wim, base_wims, + base_wimfiles.num_strings, 0); + if (ret) + goto out_free_base_wims; + + if (base_wimfiles.num_strings == 1) { + imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"), + base_wimfiles.strings[0]); + } else { + imagex_printf(T("Capturing delta WIM based on %u WIMs\n"), + base_wimfiles.num_strings); + } + + } else { + base_wims = NULL; + } + + /* If capturing or appending as an update of an existing (template) image, + * open the WIM if needed and parse the image index. */ + if (template_image_name_or_num) { + + + if (base_wimfiles.num_strings == 1 && + template_wimfile == base_wimfiles.strings[0]) { + template_wim = base_wims[0]; + } else if (template_wimfile == wimfile) { + template_wim = wim; + } else { + ret = wimlib_open_wim(template_wimfile, open_flags, + &template_wim, imagex_progress_func); + if (ret) + goto out_free_base_wims; + } + + template_image = wimlib_resolve_image(template_wim, + template_image_name_or_num); + + if (template_image_name_or_num[0] == T('-')) { + tchar *tmp; + unsigned long n; + struct wimlib_wim_info info; + + wimlib_get_wim_info(template_wim, &info); + n = tstrtoul(template_image_name_or_num + 1, &tmp, 10); + if (n >= 1 && n <= info.image_count && + *tmp == T('\0') && + tmp != template_image_name_or_num + 1) + { + template_image = info.image_count - (n - 1); + } + } + ret = verify_image_exists_and_is_single(template_image, + template_image_name_or_num, + template_wimfile); + if (ret) + goto out_free_template_wim; + } else { + template_wim = NULL; + } + + ret = wimlib_add_image_multisource(wim, capture_sources, num_sources, name, config, add_image_flags, imagex_progress_func); - if (ret != 0) - goto out_release_privs; - cur_image = wimlib_get_num_images(w); - if (desc) { - ret = wimlib_set_image_descripton(w, cur_image, desc); - if (ret != 0) - goto out_release_privs; - } - if (flags_element) { - ret = wimlib_set_image_flags(w, cur_image, flags_element); - if (ret != 0) - goto out_release_privs; - } - if (cmd == APPEND) { - ret = wimlib_overwrite(w, write_flags, num_threads, + if (ret) + goto out_free_template_wim; + + if (desc || flags_element || template_image_name_or_num) { + /* User provided or element, or an image + * on which the added one is to be based has been specified with + * --update-of. Get the index of the image we just + * added, then use it to call the appropriate functions. */ + struct wimlib_wim_info info; + + wimlib_get_wim_info(wim, &info); + + if (desc) { + ret = wimlib_set_image_descripton(wim, + info.image_count, + desc); + if (ret) + goto out_free_template_wim; + } + + if (flags_element) { + ret = wimlib_set_image_flags(wim, info.image_count, + flags_element); + if (ret) + goto out_free_template_wim; + } + + /* Reference template image if the user provided one. */ + if (template_image_name_or_num) { + imagex_printf(T("Using image %d " + "from \"%"TS"\" as template\n"), + template_image, template_wimfile); + ret = wimlib_reference_template_image(wim, + info.image_count, + template_wim, + template_image, + 0, NULL); + if (ret) + goto out_free_template_wim; + } + } + + /* Write the new WIM or overwrite the existing WIM with the new image + * appended. */ + if (cmd == CMD_APPEND) { + ret = wimlib_overwrite(wim, write_flags, num_threads, imagex_progress_func); + } else if (wimfile) { + ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES, + write_flags, num_threads, + imagex_progress_func); } else { - ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags, - num_threads, imagex_progress_func); - } - if (ret == WIMLIB_ERR_REOPEN) - ret = 0; - if (ret != 0) - imagex_error(T("Failed to write the WIM file \"%"TS"\""), - wimfile); -out_release_privs: -#ifdef __WIN32__ - win32_release_capture_privileges(); -#endif -out_wimlib_free: - wimlib_free(w); + ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES, + write_flags, num_threads, + imagex_progress_func); + } +out_free_template_wim: + /* template_wim may alias base_wims[0] or wim. */ + if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) && + template_wim != wim) + wimlib_free(template_wim); +out_free_base_wims: + for (size_t i = 0; i < base_wimfiles.num_strings; i++) + wimlib_free(base_wims[i]); + free(base_wims); +out_free_wim: + wimlib_free(wim); out_free_config: - if (config != NULL && config != &default_capture_config) { + if (config) { free(config->exclusion_pats.pats); free(config->exclusion_exception_pats.pats); free(config_str); @@ -1498,19 +2184,27 @@ out_free_capture_sources: free(capture_sources); out_free_source_list_contents: free(source_list_contents); +out_free_base_wimfiles: + string_set_destroy(&base_wimfiles); return ret; + +out_usage: + usage(cmd, stderr); +out_err: + ret = -1; + goto out_free_base_wimfiles; } /* Remove image(s) from a WIM. */ static int -imagex_delete(int argc, tchar **argv) +imagex_delete(int argc, tchar **argv, int cmd) { int c; - int open_flags = 0; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; int write_flags = 0; const tchar *wimfile; const tchar *image_num_or_name; - WIMStruct *w; + WIMStruct *wim; int image; int ret; @@ -1524,8 +2218,7 @@ imagex_delete(int argc, tchar **argv) write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE; break; default: - usage(DELETE); - return -1; + goto out_usage; } } argc -= optind; @@ -1536,122 +2229,149 @@ imagex_delete(int argc, tchar **argv) imagex_error(T("Must specify a WIM file")); if (argc < 2) imagex_error(T("Must specify an image")); - usage(DELETE); - return -1; + goto out_usage; } wimfile = argv[0]; image_num_or_name = argv[1]; - ret = file_writable(wimfile); - if (ret != 0) - return ret; - - ret = wimlib_open_wim(wimfile, open_flags, &w, + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); - if (ret != 0) - return ret; + if (ret) + goto out; - image = wimlib_resolve_image(w, image_num_or_name); + image = wimlib_resolve_image(wim, image_num_or_name); ret = verify_image_exists(image, image_num_or_name, wimfile); - if (ret != 0) - goto out; + if (ret) + goto out_wimlib_free; - ret = wimlib_delete_image(w, image); - if (ret != 0) { - imagex_error(T("Failed to delete image from \"%"TS"\""), wimfile); - goto out; + ret = wimlib_delete_image(wim, image); + if (ret) { + imagex_error(T("Failed to delete image from \"%"TS"\""), + wimfile); + goto out_wimlib_free; } - ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func); - if (ret == WIMLIB_ERR_REOPEN) - ret = 0; - if (ret != 0) { + ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func); + if (ret) { imagex_error(T("Failed to write the file \"%"TS"\" with image " "deleted"), wimfile); } +out_wimlib_free: + wimlib_free(wim); out: - wimlib_free(w); return ret; + +out_usage: + usage(CMD_DELETE, stderr); + ret = -1; + goto out; +} + +static int +print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore) +{ + int ret = tprintf(T("%"TS"\n"), wdentry->full_path); + return (ret >= 0) ? 0 : -1; } /* Print the files contained in an image(s) in a WIM file. */ static int -imagex_dir(int argc, tchar **argv) +imagex_dir(int argc, tchar **argv, int cmd) { const tchar *wimfile; - WIMStruct *w; + WIMStruct *wim = NULL; int image; int ret; - int num_images; + const tchar *path = T(""); + int c; - if (argc < 2) { + for_opt(c, dir_options) { + switch (c) { + case IMAGEX_PATH_OPTION: + path = optarg; + break; + default: + goto out_usage; + } + } + argc -= optind; + argv += optind; + + if (argc < 1) { imagex_error(T("Must specify a WIM file")); - usage(DIR); - return -1; + goto out_usage; } - if (argc > 3) { + if (argc > 2) { imagex_error(T("Too many arguments")); - usage(DIR); - return -1; + goto out_usage; } - wimfile = argv[1]; - ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w, - imagex_progress_func); - if (ret != 0) - return ret; - - if (argc == 3) { - image = wimlib_resolve_image(w, argv[2]); - ret = verify_image_exists(image, argv[2], wimfile); - if (ret != 0) - goto out; + wimfile = argv[0]; + ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func); + if (ret) + goto out; + + if (argc >= 2) { + image = wimlib_resolve_image(wim, argv[1]); + ret = verify_image_exists(image, argv[1], wimfile); + if (ret) + goto out_wimlib_free; } else { - /* Image was not specified. If the WIM only contains one image, - * choose that one; otherwise, print an error. */ - num_images = wimlib_get_num_images(w); - if (num_images != 1) { - imagex_error(T("The file \"%"TS"\" contains %d images; Please " - "select one."), wimfile, num_images); - usage(DIR); - ret = -1; - goto out; + /* No image specified; default to image 1, but only if the WIM + * contains exactly one image. */ + + struct wimlib_wim_info info; + + wimlib_get_wim_info(wim, &info); + if (info.image_count != 1) { + imagex_error(T("\"%"TS"\" contains %d images; Please " + "select one (or all)."), + wimfile, info.image_count); + wimlib_free(wim); + goto out_usage; } image = 1; } - ret = wimlib_print_files(w, image); + ret = wimlib_iterate_dir_tree(wim, image, path, + WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE, + print_full_path, NULL); +out_wimlib_free: + wimlib_free(wim); out: - wimlib_free(w); return ret; + +out_usage: + usage(CMD_DIR, stderr); + ret = -1; + goto out; } /* Exports one, or all, images from a WIM file to a new WIM file or an existing * WIM file. */ static int -imagex_export(int argc, tchar **argv) +imagex_export(int argc, tchar **argv, int cmd) { int c; int open_flags = 0; int export_flags = 0; int write_flags = 0; - int compression_type = WIMLIB_COMPRESSION_TYPE_NONE; - bool compression_type_specified = false; + int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID; const tchar *src_wimfile; const tchar *src_image_num_or_name; const tchar *dest_wimfile; + int dest_wim_fd; const tchar *dest_name; const tchar *dest_desc; - WIMStruct *src_w = NULL; - WIMStruct *dest_w = NULL; + WIMStruct *src_wim; + struct wimlib_wim_info src_info; + WIMStruct *dest_wim; int ret; int image; struct stat stbuf; bool wim_is_new; - const tchar *swm_glob = NULL; - WIMStruct **additional_swms = NULL; - unsigned num_additional_swms = 0; + STRING_SET(refglobs); unsigned num_threads = 0; for_opt(c, export_options) { @@ -1663,51 +2383,78 @@ imagex_export(int argc, tchar **argv) open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; + case IMAGEX_NOCHECK_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY; + break; case IMAGEX_COMPRESS_OPTION: compression_type = get_compression_type(optarg); if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) - return -1; - compression_type_specified = true; + goto out_err; break; case IMAGEX_REF_OPTION: - swm_glob = optarg; + ret = string_set_append(&refglobs, optarg); + if (ret) + goto out_free_refglobs; break; case IMAGEX_THREADS_OPTION: num_threads = parse_num_threads(optarg); if (num_threads == UINT_MAX) - return -1; + goto out_err; break; - case IMAGEX_REBULID_OPTION: + case IMAGEX_REBUILD_OPTION: write_flags |= WIMLIB_WRITE_FLAG_REBUILD; break; + case IMAGEX_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_PIPABLE; + break; + case IMAGEX_NOT_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE; + break; default: - usage(EXPORT); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc < 3 || argc > 5) { - usage(EXPORT); - return -1; - } + if (argc < 3 || argc > 5) + goto out_usage; src_wimfile = argv[0]; src_image_num_or_name = argv[1]; dest_wimfile = argv[2]; dest_name = (argc >= 4) ? argv[3] : NULL; dest_desc = (argc >= 5) ? argv[4] : NULL; - ret = wimlib_open_wim(src_wimfile, - open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w, + ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim, imagex_progress_func); - if (ret != 0) - return ret; - - /* Determine if the destination is an existing file or not. - * If so, we try to append the exported image(s) to it; otherwise, we - * create a new WIM containing the exported image(s). */ - if (tstat(dest_wimfile, &stbuf) == 0) { - int dest_ctype; - + if (ret) + goto out_free_refglobs; + + wimlib_get_wim_info(src_wim, &src_info); + + /* Determine if the destination is an existing file or not. If so, we + * try to append the exported image(s) to it; otherwise, we create a new + * WIM containing the exported image(s). Furthermore, determine if we + * need to write a pipable WIM directly to standard output. */ + + if (tstrcmp(dest_wimfile, T("-")) == 0) { + #if 0 + if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) { + imagex_error("Can't write a non-pipable WIM to " + "standard output! Specify --pipable\n" + " if you want to create a pipable WIM " + "(but read the docs first)."); + ret = -1; + goto out_free_src_wim; + } + #else + write_flags |= WIMLIB_WRITE_FLAG_PIPABLE; + #endif + dest_wimfile = NULL; + dest_wim_fd = STDOUT_FILENO; + imagex_info_file = stderr; + set_fd_to_binary_mode(dest_wim_fd); + } + errno = ENOENT; + if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) { wim_is_new = false; /* Destination file exists. */ @@ -1715,92 +2462,388 @@ imagex_export(int argc, tchar **argv) imagex_error(T("\"%"TS"\" is not a regular file"), dest_wimfile); ret = -1; - goto out; + goto out_free_src_wim; } - ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w, - imagex_progress_func); - if (ret != 0) - goto out; - - ret = file_writable(dest_wimfile); - if (ret != 0) - goto out; - - dest_ctype = wimlib_get_compression_type(dest_w); - if (compression_type_specified - && compression_type != dest_ctype) - { - imagex_error(T("Cannot specify a compression type that is " - "not the same as that used in the " - "destination WIM")); - ret = -1; - goto out; + ret = wimlib_open_wim(dest_wimfile, + open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS, + &dest_wim, imagex_progress_func); + if (ret) + goto out_free_src_wim; + + if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) { + /* The user specified a compression type, but we're + * exporting to an existing WIM. Make sure the + * specified compression type is the same as the + * compression type of the existing destination WIM. */ + struct wimlib_wim_info dest_info; + + wimlib_get_wim_info(dest_wim, &dest_info); + if (compression_type != dest_info.compression_type) { + imagex_error(T("Cannot specify a compression type that is " + "not the same as that used in the " + "destination WIM")); + ret = -1; + goto out_free_dest_wim; + } } } else { wim_is_new = true; - /* dest_wimfile is not an existing file, so create a new WIM. */ - if (!compression_type_specified) - compression_type = wimlib_get_compression_type(src_w); - if (errno == ENOENT) { - ret = wimlib_create_new_wim(compression_type, &dest_w); - if (ret != 0) - goto out; - } else { + + if (errno != ENOENT) { imagex_error_with_errno(T("Cannot stat file \"%"TS"\""), dest_wimfile); ret = -1; - goto out; + goto out_free_src_wim; + } + + /* dest_wimfile is not an existing file, so create a new WIM. */ + + if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) { + /* The user did not specify a compression type; default + * to that of the source WIM. */ + + compression_type = src_info.compression_type; } + ret = wimlib_create_new_wim(compression_type, &dest_wim); + if (ret) + goto out_free_src_wim; + + wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size); } - image = wimlib_resolve_image(src_w, src_image_num_or_name); + image = wimlib_resolve_image(src_wim, src_image_num_or_name); ret = verify_image_exists(image, src_image_num_or_name, src_wimfile); - if (ret != 0) - goto out; + if (ret) + goto out_free_dest_wim; - if (swm_glob) { - ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags, - &additional_swms, - &num_additional_swms); - if (ret != 0) - goto out; + if (refglobs.num_strings) { + ret = wim_reference_globs(src_wim, &refglobs, open_flags); + if (ret) + goto out_free_dest_wim; } - ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc, - export_flags, additional_swms, - num_additional_swms, imagex_progress_func); - if (ret != 0) - goto out; + if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) && + image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0) + { + imagex_error(T("--boot specified for all-images export, but source WIM " + "has no bootable image.")); + ret = -1; + goto out_free_dest_wim; + } + ret = wimlib_export_image(src_wim, image, dest_wim, dest_name, + dest_desc, export_flags, imagex_progress_func); + if (ret) { + if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) { + do_resource_not_found_warning(src_wimfile, + &src_info, &refglobs); + } + goto out_free_dest_wim; + } - if (wim_is_new) - ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES, + if (!wim_is_new) + ret = wimlib_overwrite(dest_wim, write_flags, num_threads, + imagex_progress_func); + else if (dest_wimfile) + ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES, write_flags, num_threads, imagex_progress_func); else - ret = wimlib_overwrite(dest_w, write_flags, num_threads, - imagex_progress_func); -out: - if (ret == WIMLIB_ERR_REOPEN) - ret = 0; - wimlib_free(src_w); - wimlib_free(dest_w); - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); + ret = wimlib_write_to_fd(dest_wim, dest_wim_fd, + WIMLIB_ALL_IMAGES, write_flags, + num_threads, imagex_progress_func); +out_free_dest_wim: + wimlib_free(dest_wim); +out_free_src_wim: + wimlib_free(src_wim); +out_free_refglobs: + string_set_destroy(&refglobs); + return ret; + +out_usage: + usage(CMD_EXPORT, stderr); +out_err: + ret = -1; + goto out_free_refglobs; +} + +static bool +is_root_wim_path(const tchar *path) +{ + const tchar *p; + for (p = path; *p; p++) + if (*p != T('\\') && *p != T('/')) + return false; + return true; +} + +static void +free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds, + const tchar *dest_dir) +{ + for (size_t i = 0; i < num_cmds; i++) + if (cmds[i].fs_dest_path != dest_dir) + free(cmds[i].fs_dest_path); + free(cmds); +} + +static struct wimlib_extract_command * +prepare_extract_commands(tchar **paths, unsigned num_paths, + int extract_flags, tchar *dest_dir, + size_t *num_cmds_ret) +{ + struct wimlib_extract_command *cmds; + size_t num_cmds; + tchar *emptystr = T(""); + + if (num_paths == 0) { + num_paths = 1; + paths = &emptystr; + } + num_cmds = num_paths; + cmds = calloc(num_cmds, sizeof(cmds[0])); + if (!cmds) { + imagex_error(T("Out of memory!")); + return NULL; } + + for (size_t i = 0; i < num_cmds; i++) { + cmds[i].extract_flags = extract_flags; + cmds[i].wim_source_path = paths[i]; + if (is_root_wim_path(paths[i])) { + cmds[i].fs_dest_path = dest_dir; + } else { + size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]); + cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar)); + if (!cmds[i].fs_dest_path) { + free_extract_commands(cmds, num_cmds, dest_dir); + return NULL; + } + tsprintf(cmds[i].fs_dest_path, + T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS), + dest_dir, tbasename(paths[i])); + } + } + *num_cmds_ret = num_cmds; + return cmds; +} + +/* Extract files or directories from a WIM image */ +static int +imagex_extract(int argc, tchar **argv, int cmd) +{ + int c; + int open_flags = 0; + int image; + WIMStruct *wim; + int ret; + const tchar *wimfile; + const tchar *image_num_or_name; + tchar *dest_dir = T("."); + int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX; + + STRING_SET(refglobs); + + struct wimlib_extract_command *cmds; + size_t num_cmds; + + for_opt(c, extract_options) { + switch (c) { + case IMAGEX_CHECK_OPTION: + open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; + break; + case IMAGEX_VERBOSE_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE; + break; + case IMAGEX_REF_OPTION: + ret = string_set_append(&refglobs, optarg); + if (ret) + goto out_free_refglobs; + break; + case IMAGEX_UNIX_DATA_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA; + break; + case IMAGEX_NO_ACLS_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS; + break; + case IMAGEX_STRICT_ACLS_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS; + break; + case IMAGEX_DEST_DIR_OPTION: + dest_dir = optarg; + break; + case IMAGEX_TO_STDOUT_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT; + imagex_info_file = stderr; + imagex_be_quiet = true; + break; + case IMAGEX_INCLUDE_INVALID_NAMES_OPTION: + extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES; + extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS; + break; + default: + goto out_usage; + } + } + argc -= optind; + argv += optind; + + if (argc < 2) + goto out_usage; + + wimfile = argv[0]; + image_num_or_name = argv[1]; + + argc -= 2; + argv += 2; + + cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir, + &num_cmds); + if (!cmds) + goto out_err; + + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) + goto out_free_cmds; + + image = wimlib_resolve_image(wim, image_num_or_name); + ret = verify_image_exists_and_is_single(image, + image_num_or_name, + wimfile); + if (ret) + goto out_wimlib_free; + + if (refglobs.num_strings) { + ret = wim_reference_globs(wim, &refglobs, open_flags); + if (ret) + goto out_wimlib_free; + } + + ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0, + imagex_progress_func); + if (ret == 0) { + if (!imagex_be_quiet) + imagex_printf(T("Done extracting files.\n")); + } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) { + tfprintf(stderr, T("Note: You can use `%"TS"' to see what " + "files and directories\n" + " are in the WIM image.\n"), + get_cmd_string(CMD_INFO, false)); + } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) { + struct wimlib_wim_info info; + + wimlib_get_wim_info(wim, &info); + do_resource_not_found_warning(wimfile, &info, &refglobs); + } +out_wimlib_free: + wimlib_free(wim); +out_free_cmds: + free_extract_commands(cmds, num_cmds, dest_dir); +out_free_refglobs: + string_set_destroy(&refglobs); return ret; + +out_usage: + usage(CMD_EXTRACT, stderr); +out_err: + ret = -1; + goto out_free_refglobs; +} + +static void print_byte_field(const uint8_t field[], size_t len) +{ + while (len--) + tprintf(T("%02hhx"), *field++); +} + +static void +print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info) +{ + tputs(T("WIM Information:")); + tputs(T("----------------")); + tprintf(T("Path: %"TS"\n"), wimfile); + tprintf(T("GUID: 0x")); + print_byte_field(info->guid, sizeof(info->guid)); + tputchar(T('\n')); + tprintf(T("Version: %u\n"), info->wim_version); + tprintf(T("Image Count: %d\n"), info->image_count); + tprintf(T("Compression: %"TS"\n"), + wimlib_get_compression_type_string(info->compression_type)); + tprintf(T("Chunk Size: %"PRIu32" bytes\n"), + info->chunk_size); + tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts); + tprintf(T("Boot Index: %d\n"), info->boot_index); + tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes); + tprintf(T("Integrity Info: %"TS"\n"), + info->has_integrity_table ? T("yes") : T("no")); + tprintf(T("Relative path junction: %"TS"\n"), + info->has_rpfix ? T("yes") : T("no")); + tprintf(T("Pipable: %"TS"\n"), + info->pipable ? T("yes") : T("no")); + tputchar(T('\n')); +} + +static int +print_resource(const struct wimlib_resource_entry *resource, + void *_ignore) +{ + tprintf(T("Uncompressed size = %"PRIu64" bytes\n"), + resource->uncompressed_size); + if (resource->packed) { + tprintf(T("Raw compressed size = %"PRIu64" bytes\n"), + resource->raw_resource_compressed_size); + + tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"), + resource->raw_resource_offset_in_wim); + + tprintf(T("Offset in raw = %"PRIu64" bytes\n"), + resource->offset); + } else { + tprintf(T("Compressed size = %"PRIu64" bytes\n"), + resource->compressed_size); + + tprintf(T("Offset in WIM = %"PRIu64" bytes\n"), + resource->offset); + } + + tprintf(T("Part Number = %u\n"), resource->part_number); + tprintf(T("Reference Count = %u\n"), resource->reference_count); + + tprintf(T("Hash = 0x")); + print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash)); + tputchar(T('\n')); + + tprintf(T("Flags = ")); + if (resource->is_compressed) + tprintf(T("WIM_RESHDR_FLAG_COMPRESSED ")); + if (resource->is_metadata) + tprintf(T("WIM_RESHDR_FLAG_METADATA ")); + if (resource->is_free) + tprintf(T("WIM_RESHDR_FLAG_FREE ")); + if (resource->is_spanned) + tprintf(T("WIM_RESHDR_FLAG_SPANNED ")); + if (resource->packed) + tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS ")); + tputchar(T('\n')); + tputchar(T('\n')); + return 0; +} + +static void +print_lookup_table(WIMStruct *wim) +{ + wimlib_iterate_lookup_table(wim, 0, print_resource, NULL); } /* Prints information about a WIM file; also can mark an image as bootable, * change the name of an image, or change the description of an image. */ static int -imagex_info(int argc, tchar **argv) +imagex_info(int argc, tchar **argv, int cmd) { int c; bool boot = false; bool check = false; + bool nocheck = false; bool header = false; bool lookup_table = false; bool xml = false; @@ -1808,17 +2851,14 @@ imagex_info(int argc, tchar **argv) bool short_header = true; const tchar *xml_out_file = NULL; const tchar *wimfile; - const tchar *image_num_or_name = T("all"); - const tchar *new_name = NULL; - const tchar *new_desc = NULL; - WIMStruct *w; - FILE *fp; + const tchar *image_num_or_name; + const tchar *new_name; + const tchar *new_desc; + WIMStruct *wim; int image; int ret; - int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; - int part_number; - int total_parts; - int num_images; + int open_flags = 0; + struct wimlib_wim_info info; for_opt(c, info_options) { switch (c) { @@ -1828,6 +2868,9 @@ imagex_info(int argc, tchar **argv) case IMAGEX_CHECK_OPTION: check = true; break; + case IMAGEX_NOCHECK_OPTION: + nocheck = true; + break; case IMAGEX_HEADER_OPTION: header = true; short_header = false; @@ -1849,76 +2892,63 @@ imagex_info(int argc, tchar **argv) short_header = false; break; default: - usage(INFO); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc == 0 || argc > 4) { - usage(INFO); - return -1; - } - wimfile = argv[0]; - if (argc > 1) { - image_num_or_name = argv[1]; - if (argc > 2) { - new_name = argv[2]; - if (argc > 3) { - new_desc = argv[3]; - } - } + if (argc < 1 || argc > 4) + goto out_usage; + + wimfile = argv[0]; + image_num_or_name = (argc >= 2) ? argv[1] : T("all"); + new_name = (argc >= 3) ? argv[2] : NULL; + new_desc = (argc >= 4) ? argv[3] : NULL; + + if (check && nocheck) { + imagex_error(T("Can't specify both --check and --nocheck")); + goto out_err; } if (check) open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; - ret = wimlib_open_wim(wimfile, open_flags, &w, - imagex_progress_func); - if (ret != 0) - return ret; + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) + goto out; - part_number = wimlib_get_part_number(w, &total_parts); + wimlib_get_wim_info(wim, &info); - image = wimlib_resolve_image(w, image_num_or_name); + image = wimlib_resolve_image(wim, image_num_or_name); + ret = WIMLIB_ERR_INVALID_IMAGE; if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) { - imagex_error(T("The image \"%"TS"\" does not exist"), - image_num_or_name); + verify_image_exists(image, image_num_or_name, wimfile); if (boot) { imagex_error(T("If you would like to set the boot " "index to 0, specify image \"0\" with " "the --boot flag.")); } - ret = WIMLIB_ERR_INVALID_IMAGE; - goto out; + goto out_wimlib_free; } - num_images = wimlib_get_num_images(w); - - if (num_images == 0) { - if (boot) { - imagex_error(T("--boot is meaningless on a WIM with no " - "images")); - ret = WIMLIB_ERR_INVALID_IMAGE; - goto out; - } + if (boot && info.image_count == 0) { + imagex_error(T("--boot is meaningless on a WIM with no images")); + goto out_wimlib_free; } - if (image == WIMLIB_ALL_IMAGES && num_images > 1) { + if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) { if (boot) { imagex_error(T("Cannot specify the --boot flag " "without specifying a specific " "image in a multi-image WIM")); - ret = WIMLIB_ERR_INVALID_IMAGE; - goto out; + goto out_wimlib_free; } if (new_name) { imagex_error(T("Cannot specify the NEW_NAME " "without specifying a specific " "image in a multi-image WIM")); - ret = WIMLIB_ERR_INVALID_IMAGE; - goto out; + goto out_wimlib_free; } } @@ -1929,71 +2959,68 @@ imagex_info(int argc, tchar **argv) /* Read-only operations */ if (image == WIMLIB_NO_IMAGE) { - imagex_error(T("\"%"TS"\" is not a valid image"), - image_num_or_name); - ret = WIMLIB_ERR_INVALID_IMAGE; - goto out; + imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""), + image_num_or_name, wimfile); + goto out_wimlib_free; } if (image == WIMLIB_ALL_IMAGES && short_header) - wimlib_print_wim_information(w); + print_wim_information(wimfile, &info); if (header) - wimlib_print_header(w); + wimlib_print_header(wim); if (lookup_table) { - if (total_parts != 1) { - tprintf(T("Warning: Only showing the lookup table " - "for part %d of a %d-part WIM.\n"), - part_number, total_parts); + if (info.total_parts != 1) { + tfprintf(stderr, T("Warning: Only showing the lookup table " + "for part %d of a %d-part WIM.\n"), + info.part_number, info.total_parts); } - wimlib_print_lookup_table(w); + print_lookup_table(wim); } if (xml) { - ret = wimlib_extract_xml_data(w, stdout); - if (ret != 0) - goto out; + ret = wimlib_extract_xml_data(wim, stdout); + if (ret) + goto out_wimlib_free; } if (xml_out_file) { + FILE *fp; + fp = tfopen(xml_out_file, T("wb")); if (!fp) { imagex_error_with_errno(T("Failed to open the " "file \"%"TS"\" for " - "writing "), + "writing"), xml_out_file); ret = -1; - goto out; + goto out_wimlib_free; } - ret = wimlib_extract_xml_data(w, fp); - if (fclose(fp) != 0) { + ret = wimlib_extract_xml_data(wim, fp); + if (fclose(fp)) { imagex_error(T("Failed to close the file " "\"%"TS"\""), xml_out_file); ret = -1; } - - if (ret != 0) - goto out; + if (ret) + goto out_wimlib_free; } if (short_header) - wimlib_print_available_images(w, image); + wimlib_print_available_images(wim, image); if (metadata) { - ret = wimlib_print_metadata(w, image); - if (ret != 0) - goto out; + ret = wimlib_print_metadata(wim, image); + if (ret) + goto out_wimlib_free; } + ret = 0; } else { /* Modification operations */ - if (total_parts != 1) { - imagex_error(T("Modifying a split WIM is not supported.")); - ret = -1; - goto out; - } + if (image == WIMLIB_ALL_IMAGES) image = 1; @@ -2001,90 +3028,97 @@ imagex_info(int argc, tchar **argv) imagex_error(T("Cannot specify new_name (\"%"TS"\") " "when using image 0"), new_name); ret = -1; - goto out; + goto out_wimlib_free; } if (boot) { - if (image == wimlib_get_boot_idx(w)) { - tprintf(T("Image %d is already marked as " + if (image == info.boot_index) { + imagex_printf(T("Image %d is already marked as " "bootable.\n"), image); boot = false; } else { - tprintf(T("Marking image %d as bootable.\n"), + imagex_printf(T("Marking image %d as bootable.\n"), image); - wimlib_set_boot_idx(w, image); + info.boot_index = image; + ret = wimlib_set_wim_info(wim, &info, + WIMLIB_CHANGE_BOOT_INDEX); + if (ret) + goto out_wimlib_free; } } if (new_name) { - if (!tstrcmp(wimlib_get_image_name(w, image), new_name)) + if (!tstrcmp(wimlib_get_image_name(wim, image), new_name)) { - tprintf(T("Image %d is already named \"%"TS"\".\n"), + imagex_printf(T("Image %d is already named \"%"TS"\".\n"), image, new_name); new_name = NULL; } else { - tprintf(T("Changing the name of image %d to " + imagex_printf(T("Changing the name of image %d to " "\"%"TS"\".\n"), image, new_name); - ret = wimlib_set_image_name(w, image, new_name); - if (ret != 0) - goto out; + ret = wimlib_set_image_name(wim, image, new_name); + if (ret) + goto out_wimlib_free; } } if (new_desc) { const tchar *old_desc; - old_desc = wimlib_get_image_description(w, image); + old_desc = wimlib_get_image_description(wim, image); if (old_desc && !tstrcmp(old_desc, new_desc)) { - tprintf(T("The description of image %d is already " + imagex_printf(T("The description of image %d is already " "\"%"TS"\".\n"), image, new_desc); new_desc = NULL; } else { - tprintf(T("Changing the description of image %d " + imagex_printf(T("Changing the description of image %d " "to \"%"TS"\".\n"), image, new_desc); - ret = wimlib_set_image_descripton(w, image, + ret = wimlib_set_image_descripton(wim, image, new_desc); - if (ret != 0) - goto out; + if (ret) + goto out_wimlib_free; } } /* Only call wimlib_overwrite() if something actually needs to - * be changed. */ + * be changed. */ if (boot || new_name || new_desc || - (check && !wimlib_has_integrity_table(w))) + (check && !info.has_integrity_table) || + (nocheck && info.has_integrity_table)) { - int write_flags; - - ret = file_writable(wimfile); - if (ret != 0) - return ret; + int write_flags = 0; if (check) - write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; - else - write_flags = 0; - - ret = wimlib_overwrite(w, write_flags, 1, + write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; + if (nocheck) + write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY; + ret = wimlib_overwrite(wim, write_flags, 1, imagex_progress_func); - if (ret == WIMLIB_ERR_REOPEN) - ret = 0; } else { - tprintf(T("The file \"%"TS"\" was not modified because nothing " - "needed to be done.\n"), wimfile); + imagex_printf(T("The file \"%"TS"\" was not modified " + "because nothing needed to be done.\n"), + wimfile); ret = 0; } } +out_wimlib_free: + wimlib_free(wim); out: - wimlib_free(w); return ret; + +out_usage: + usage(CMD_INFO, stderr); +out_err: + ret = -1; + goto out; } /* Join split WIMs into one part WIM */ static int -imagex_join(int argc, tchar **argv) +imagex_join(int argc, tchar **argv, int cmd) { int c; - int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; + int swm_open_flags = 0; int wim_write_flags = 0; const tchar *output_path; + int ret; for_opt(c, join_options) { switch (c) { @@ -2093,7 +3127,7 @@ imagex_join(int argc, tchar **argv) wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; default: - goto err; + goto out_usage; } } argc -= optind; @@ -2102,40 +3136,47 @@ imagex_join(int argc, tchar **argv) if (argc < 2) { imagex_error(T("Must specify one or more split WIM (.swm) " "parts to join")); - goto err; + goto out_usage; } output_path = argv[0]; - return wimlib_join((const tchar * const *)++argv, - --argc, - output_path, - swm_open_flags, - wim_write_flags, - imagex_progress_func); -err: - usage(JOIN); - return -1; -} - -/* Mounts an image using a FUSE mount. */ + ret = wimlib_join((const tchar * const *)++argv, + --argc, + output_path, + swm_open_flags, + wim_write_flags, + imagex_progress_func); +out: + return ret; + +out_usage: + usage(CMD_JOIN, stderr); + ret = -1; + goto out; +} + +#if WIM_MOUNTING_SUPPORTED + +/* Mounts a WIM image. */ static int -imagex_mount_rw_or_ro(int argc, tchar **argv) +imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd) { int c; int mount_flags = 0; - int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; + int open_flags = 0; + const tchar *staging_dir = NULL; const tchar *wimfile; const tchar *dir; - WIMStruct *w; + WIMStruct *wim; + struct wimlib_wim_info info; int image; - int num_images; int ret; - const tchar *swm_glob = NULL; - WIMStruct **additional_swms = NULL; - unsigned num_additional_swms = 0; - const tchar *staging_dir = NULL; - if (!tstrcmp(argv[0], T("mountrw"))) + STRING_SET(refglobs); + + if (cmd == CMD_MOUNTRW) { mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE; + open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS; + } for_opt(c, mount_options) { switch (c) { @@ -2158,11 +3199,13 @@ imagex_mount_rw_or_ro(int argc, tchar **argv) else { imagex_error(T("Unknown stream interface \"%"TS"\""), optarg); - goto mount_usage; + goto out_usage; } break; case IMAGEX_REF_OPTION: - swm_glob = optarg; + ret = string_set_append(&refglobs, optarg); + if (ret) + goto out_free_refglobs; break; case IMAGEX_STAGING_DIR_OPTION: staging_dir = optarg; @@ -2171,89 +3214,83 @@ imagex_mount_rw_or_ro(int argc, tchar **argv) mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA; break; default: - goto mount_usage; + goto out_usage; } } argc -= optind; argv += optind; if (argc != 2 && argc != 3) - goto mount_usage; + goto out_usage; wimfile = argv[0]; - ret = wimlib_open_wim(wimfile, open_flags, &w, - imagex_progress_func); - if (ret != 0) - return ret; + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) + goto out_free_refglobs; - if (swm_glob) { - ret = open_swms_from_glob(swm_glob, wimfile, open_flags, - &additional_swms, - &num_additional_swms); - if (ret != 0) - goto out; - } + wimlib_get_wim_info(wim, &info); - if (argc == 2) { - image = 1; - num_images = wimlib_get_num_images(w); - if (num_images != 1) { - imagex_error(T("The file \"%"TS"\" contains %d images; Please " - "select one."), wimfile, num_images); - usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) - ? MOUNTRW : MOUNT); - ret = -1; - goto out; - } - dir = argv[1]; - } else { - image = wimlib_resolve_image(w, argv[1]); + if (argc >= 3) { + /* Image explicitly specified. */ + image = wimlib_resolve_image(wim, argv[1]); dir = argv[2]; ret = verify_image_exists_and_is_single(image, argv[1], wimfile); - if (ret != 0) - goto out; + if (ret) + goto out_free_wim; + } else { + /* No image specified; default to image 1, but only if the WIM + * contains exactly one image. */ + + if (info.image_count != 1) { + imagex_error(T("\"%"TS"\" contains %d images; Please " + "select one."), wimfile, info.image_count); + wimlib_free(wim); + goto out_usage; + } + image = 1; + dir = argv[1]; } - if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) { - ret = file_writable(wimfile); - if (ret != 0) - goto out; + if (refglobs.num_strings) { + ret = wim_reference_globs(wim, &refglobs, open_flags); + if (ret) + goto out_free_wim; } - ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms, - num_additional_swms, staging_dir); - if (ret != 0) { + ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir); + if (ret) { imagex_error(T("Failed to mount image %d from \"%"TS"\" " "on \"%"TS"\""), image, wimfile, dir); - - } -out: - wimlib_free(w); - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); } +out_free_wim: + wimlib_free(wim); +out_free_refglobs: + string_set_destroy(&refglobs); return ret; -mount_usage: - usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) - ? MOUNTRW : MOUNT); - return -1; + +out_usage: + usage(cmd, stderr); + ret = -1; + goto out_free_refglobs; } +#endif /* WIM_MOUNTING_SUPPORTED */ /* Rebuild a WIM file */ static int -imagex_optimize(int argc, tchar **argv) +imagex_optimize(int argc, tchar **argv, int cmd) { int c; - int open_flags = 0; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; int write_flags = WIMLIB_WRITE_FLAG_REBUILD; + int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID; + uint32_t chunk_size = UINT32_MAX; int ret; - WIMStruct *w; + WIMStruct *wim; const tchar *wimfile; off_t old_size; off_t new_size; + unsigned num_threads = 0; for_opt(c, optimize_options) { switch (c) { @@ -2261,70 +3298,130 @@ imagex_optimize(int argc, tchar **argv) open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; + case IMAGEX_NOCHECK_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY; + break; + case IMAGEX_COMPRESS_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS; + compression_type = get_compression_type(optarg); + if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) + goto out_err; + break; case IMAGEX_RECOMPRESS_OPTION: write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS; break; + case IMAGEX_COMPRESS_SLOW_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS; + compression_type = WIMLIB_COMPRESSION_TYPE_LZX; + ret = set_compress_slow(); + if (ret) + goto out_err; + break; + case IMAGEX_CHUNK_SIZE_OPTION: + chunk_size = parse_chunk_size(optarg); + if (chunk_size == UINT32_MAX) + goto out_err; + break; + case IMAGEX_PACK_STREAMS_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS; + write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS; + break; + case IMAGEX_NO_PACK_STREAMS_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NO_PACK_STREAMS; + break; + case IMAGEX_THREADS_OPTION: + num_threads = parse_num_threads(optarg); + if (num_threads == UINT_MAX) + goto out_err; + break; + case IMAGEX_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_PIPABLE; + break; + case IMAGEX_NOT_PIPABLE_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE; + break; default: - usage(OPTIMIZE); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc != 1) { - usage(OPTIMIZE); - return -1; - } + if (argc != 1) + goto out_usage; wimfile = argv[0]; - ret = wimlib_open_wim(wimfile, open_flags, &w, - imagex_progress_func); - if (ret != 0) - return ret; + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) + goto out; + + if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) { + /* Change compression type. */ + ret = wimlib_set_output_compression_type(wim, compression_type); + if (ret) + goto out_wimlib_free; + } + + if (chunk_size != UINT32_MAX) { + /* Change chunk size. */ + ret = wimlib_set_output_chunk_size(wim, chunk_size); + if (ret) + goto out_wimlib_free; + } - old_size = file_get_size(argv[0]); + old_size = file_get_size(wimfile); tprintf(T("\"%"TS"\" original size: "), wimfile); if (old_size == -1) - tfputs(T("Unknown\n"), stdout); + tputs(T("Unknown")); else tprintf(T("%"PRIu64" KiB\n"), old_size >> 10); - ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func); + ret = wimlib_overwrite(wim, write_flags, num_threads, + imagex_progress_func); + if (ret) { + imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile); + goto out_wimlib_free; + } - if (ret == 0) { - new_size = file_get_size(argv[0]); - tprintf(T("\"%"TS"\" optimized size: "), wimfile); - if (new_size == -1) - tfputs(T("Unknown\n"), stdout); - else - tprintf(T("%"PRIu64" KiB\n"), new_size >> 10); + new_size = file_get_size(wimfile); + tprintf(T("\"%"TS"\" optimized size: "), wimfile); + if (new_size == -1) + tputs(T("Unknown")); + else + tprintf(T("%"PRIu64" KiB\n"), new_size >> 10); - tfputs(T("Space saved: "), stdout); - if (new_size != -1 && old_size != -1) { - tprintf(T("%lld KiB\n"), - ((long long)old_size - (long long)new_size) >> 10); - } else { - tfputs(T("Unknown\n"), stdout); - } + tfputs(T("Space saved: "), stdout); + if (new_size != -1 && old_size != -1) { + tprintf(T("%lld KiB\n"), + ((long long)old_size - (long long)new_size) >> 10); + } else { + tputs(T("Unknown")); } - - wimlib_free(w); + ret = 0; +out_wimlib_free: + wimlib_free(wim); +out: return ret; + +out_usage: + usage(CMD_OPTIMIZE, stderr); +out_err: + ret = -1; + goto out; } /* Split a WIM into a spanned set */ static int -imagex_split(int argc, tchar **argv) +imagex_split(int argc, tchar **argv, int cmd) { int c; - int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; + int open_flags = 0; int write_flags = 0; unsigned long part_size; tchar *tmp; int ret; - WIMStruct *w; + WIMStruct *wim; for_opt(c, split_options) { switch (c) { @@ -2333,35 +3430,42 @@ imagex_split(int argc, tchar **argv) write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; default: - usage(SPLIT); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc != 3) { - usage(SPLIT); - return -1; - } + if (argc != 3) + goto out_usage; + part_size = tstrtod(argv[2], &tmp) * (1 << 20); if (tmp == argv[2] || *tmp) { imagex_error(T("Invalid part size \"%"TS"\""), argv[2]); imagex_error(T("The part size must be an integer or " "floating-point number of megabytes.")); - return -1; + goto out_err; } - ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func); - if (ret != 0) - return ret; - ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func); - wimlib_free(w); + ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func); + if (ret) + goto out; + + ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func); + wimlib_free(wim); +out: return ret; + +out_usage: + usage(CMD_SPLIT, stderr); +out_err: + ret = -1; + goto out; } +#if WIM_MOUNTING_SUPPORTED /* Unmounts a mounted WIM image. */ static int -imagex_unmount(int argc, tchar **argv) +imagex_unmount(int argc, tchar **argv, int cmd) { int c; int unmount_flags = 0; @@ -2375,56 +3479,406 @@ imagex_unmount(int argc, tchar **argv) case IMAGEX_CHECK_OPTION: unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY; break; - case IMAGEX_REBULID_OPTION: + case IMAGEX_REBUILD_OPTION: unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD; break; + case IMAGEX_LAZY_OPTION: + unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY; + break; default: - usage(UNMOUNT); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc != 1) { - usage(UNMOUNT); - return -1; - } + if (argc != 1) + goto out_usage; ret = wimlib_unmount_image(argv[0], unmount_flags, imagex_progress_func); - if (ret != 0) + if (ret) imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]); +out: return ret; + +out_usage: + usage(CMD_UNMOUNT, stderr); + ret = -1; + goto out; } +#endif /* WIM_MOUNTING_SUPPORTED */ + +/* + * Add, delete, or rename files in a WIM image. + */ +static int +imagex_update(int argc, tchar **argv, int cmd) +{ + const tchar *wimfile; + int image; + WIMStruct *wim; + int ret; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; + int write_flags = 0; + int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS; + int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE; + int default_delete_flags = 0; + unsigned num_threads = 0; + int c; + tchar *cmd_file_contents; + size_t cmd_file_nchars; + struct wimlib_update_command *cmds; + size_t num_cmds; + tchar *command_str = NULL; + + const tchar *config_file = NULL; + tchar *config_str; + struct wimlib_capture_config *config; + + for_opt(c, update_options) { + switch (c) { + /* Generic or write options */ + case IMAGEX_THREADS_OPTION: + num_threads = parse_num_threads(optarg); + if (num_threads == UINT_MAX) + goto out_err; + break; + case IMAGEX_CHECK_OPTION: + open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY; + write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; + break; + case IMAGEX_REBUILD_OPTION: + write_flags |= WIMLIB_WRITE_FLAG_REBUILD; + break; + case IMAGEX_COMMAND_OPTION: + if (command_str) { + imagex_error(T("--command may only be specified " + "one time. Please provide\n" + " the update commands " + "on standard input instead.")); + goto out_err; + } + command_str = tstrdup(optarg); + if (!command_str) { + imagex_error(T("Out of memory!")); + goto out_err; + } + break; + /* Default delete options */ + case IMAGEX_FORCE_OPTION: + default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE; + break; + case IMAGEX_RECURSIVE_OPTION: + default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE; + break; + + /* Global add option */ + case IMAGEX_CONFIG_OPTION: + default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG; + config_file = optarg; + break; + + /* Default add options */ + case IMAGEX_VERBOSE_OPTION: + default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE; + break; + case IMAGEX_DEREFERENCE_OPTION: + default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE; + break; + case IMAGEX_UNIX_DATA_OPTION: + default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA; + break; + case IMAGEX_NO_ACLS_OPTION: + default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS; + break; + case IMAGEX_STRICT_ACLS_OPTION: + default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS; + break; + default: + goto out_usage; + } + } + argv += optind; + argc -= optind; + + if (argc != 1 && argc != 2) + goto out_usage; + wimfile = argv[0]; + + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) + goto out_free_command_str; + + if (argc >= 2) { + /* Image explicitly specified. */ + image = wimlib_resolve_image(wim, argv[1]); + ret = verify_image_exists_and_is_single(image, argv[1], + wimfile); + if (ret) + goto out_wimlib_free; + } else { + /* No image specified; default to image 1, but only if the WIM + * contains exactly one image. */ + struct wimlib_wim_info info; + + wimlib_get_wim_info(wim, &info); + if (info.image_count != 1) { + imagex_error(T("\"%"TS"\" contains %d images; Please select one."), + wimfile, info.image_count); + wimlib_free(wim); + goto out_usage; + } + image = 1; + } + + /* Parse capture configuration file if specified */ + if (config_file) { + size_t config_len; + + config_str = file_get_text_contents(config_file, &config_len); + if (!config_str) { + ret = -1; + goto out_wimlib_free; + } + + config = alloca(sizeof(*config)); + ret = parse_capture_config(&config_str, config_len, config); + if (ret) + goto out_free_config; + } else { + config = NULL; + default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG; + } + + /* Read update commands from standard input, or the command string if + * specified. */ + if (command_str) { + cmd_file_contents = NULL; + cmds = parse_update_command_file(&command_str, tstrlen(command_str), + &num_cmds); + } else { + if (isatty(STDIN_FILENO)) { + tputs(T("Reading update commands from standard input...")); + recommend_man_page(CMD_UPDATE, stdout); + } + cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars); + if (!cmd_file_contents) { + ret = -1; + goto out_free_config; + } + + /* Parse the update commands */ + cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars, + &num_cmds); + } + if (!cmds) { + ret = -1; + goto out_free_cmd_file_contents; + } + + /* Set default flags and capture config on the update commands */ + for (size_t i = 0; i < num_cmds; i++) { + switch (cmds[i].op) { + case WIMLIB_UPDATE_OP_ADD: + cmds[i].add.add_flags |= default_add_flags; + cmds[i].add.config = config; + break; + case WIMLIB_UPDATE_OP_DELETE: + cmds[i].delete_.delete_flags |= default_delete_flags; + break; + default: + break; + } + } + + /* Execute the update commands */ + ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags, + imagex_progress_func); + if (ret) + goto out_free_cmds; + + /* Overwrite the updated WIM */ + ret = wimlib_overwrite(wim, write_flags, num_threads, + imagex_progress_func); +out_free_cmds: + free(cmds); +out_free_cmd_file_contents: + free(cmd_file_contents); +out_free_config: + if (config) { + free(config->exclusion_pats.pats); + free(config->exclusion_exception_pats.pats); + free(config_str); + } +out_wimlib_free: + wimlib_free(wim); +out_free_command_str: + free(command_str); + return ret; + +out_usage: + usage(CMD_UPDATE, stderr); +out_err: + ret = -1; + goto out_free_command_str; +} + + struct imagex_command { const tchar *name; - int (*func)(int , tchar **); - int cmd; + int (*func)(int argc, tchar **argv, int cmd); }; - -#define for_imagex_command(p) for (p = &imagex_commands[0]; \ - p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++) - static const struct imagex_command imagex_commands[] = { - {T("append"), imagex_capture_or_append, APPEND}, - {T("apply"), imagex_apply, APPLY}, - {T("capture"), imagex_capture_or_append, CAPTURE}, - {T("delete"), imagex_delete, DELETE}, - {T("dir"), imagex_dir, DIR}, - {T("export"), imagex_export, EXPORT}, - {T("info"), imagex_info, INFO}, - {T("join"), imagex_join, JOIN}, - {T("mount"), imagex_mount_rw_or_ro, MOUNT}, - {T("mountrw"), imagex_mount_rw_or_ro, MOUNTRW}, - {T("optimize"),imagex_optimize, OPTIMIZE}, - {T("split"), imagex_split, SPLIT}, - {T("unmount"), imagex_unmount, UNMOUNT}, + [CMD_APPEND] = {T("append"), imagex_capture_or_append}, + [CMD_APPLY] = {T("apply"), imagex_apply}, + [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append}, + [CMD_DELETE] = {T("delete"), imagex_delete}, + [CMD_DIR ] = {T("dir"), imagex_dir}, + [CMD_EXPORT] = {T("export"), imagex_export}, + [CMD_EXTRACT] = {T("extract"), imagex_extract}, + [CMD_INFO] = {T("info"), imagex_info}, + [CMD_JOIN] = {T("join"), imagex_join}, +#if WIM_MOUNTING_SUPPORTED + [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro}, + [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro}, +#endif + [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize}, + [CMD_SPLIT] = {T("split"), imagex_split}, +#if WIM_MOUNTING_SUPPORTED + [CMD_UNMOUNT] = {T("unmount"), imagex_unmount}, +#endif + [CMD_UPDATE] = {T("update"), imagex_update}, +}; + +static const tchar *usage_strings[] = { +[CMD_APPEND] = +T( +" %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n" +" [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n" +" [--check] [--nocheck] [--flags EDITION_ID] [--verbose]\n" +" [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n" +" [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n" +" [--norpfix] [--unix-data] [--pipable]\n" +" [--update-of=[WIMFILE:]IMAGE]\n" +), +[CMD_APPLY] = +T( +" %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n" +" (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n" +" [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n" +" [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n" +" [--include-invalid-names]\n" +), +[CMD_CAPTURE] = +T( +" %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n" +" [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n" +" [--check] [--nocheck] [--compress=TYPE]\n" +" [--flags EDITION_ID] [--verbose] [--dereference]\n" +" [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n" +" [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n" +" [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n" +" [--delta-from=WIMFILE]\n" +), +[CMD_DELETE] = +T( +" %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n" +" [--soft]\n" +), +[CMD_DIR] = +T( +" %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n" +), +[CMD_EXPORT] = +T( +" %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n" +" DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n" +" [--boot] [--check] [--nocheck] [--compress=TYPE]\n" +" [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n" +" [--pipable] [--not-pipable]\n" +), +[CMD_EXTRACT] = +T( +" %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n" +" [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n" +" [--no-acls] [--strict-acls] [--to-stdout]\n" +" [--dest-dir=CMD_DIR] [--include-invalid-names]\n" +), +[CMD_INFO] = +T( +" %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n" +" [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n" +" [--lookup-table] [--xml] [--extract-xml FILE]\n" +" [--metadata]\n" +), +[CMD_JOIN] = +T( +" %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n" +), +#if WIM_MOUNTING_SUPPORTED +[CMD_MOUNT] = +T( +" %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n" +" [--check] [--debug] [--streams-interface=INTERFACE]\n" +" [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n" +), +[CMD_MOUNTRW] = +T( +" %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n" +" [--check] [--debug] [--streams-interface=INTERFACE]\n" +" [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n" +), +#endif +[CMD_OPTIMIZE] = +T( +" %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n" +" [--recompress-slow] [--compress=TYPE]\n" +" [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n" +), +[CMD_SPLIT] = +T( +" %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n" +), +#if WIM_MOUNTING_SUPPORTED +[CMD_UNMOUNT] = +T( +" %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n" +), +#endif +[CMD_UPDATE] = +T( +" %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n" +" [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n" +" [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n" +), }; +static const tchar *invocation_name; +static int invocation_cmd = CMD_NONE; + +static const tchar *get_cmd_string(int cmd, bool nospace) +{ + static tchar buf[50]; + if (cmd == CMD_NONE) { + tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME)); + } else if (invocation_cmd != CMD_NONE) { + tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name); + } else { + const tchar *format; + + if (nospace) + format = T("%"TS"-%"TS""); + else + format = T("%"TS" %"TS""); + tsprintf(buf, format, invocation_name, imagex_commands[cmd].name); + } + return buf; +} + static void -version() +version(void) { static const tchar *s = T( @@ -2441,67 +3895,74 @@ IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n" static void -help_or_version(int argc, tchar **argv) +help_or_version(int argc, tchar **argv, int cmd) { int i; const tchar *p; - const struct imagex_command *cmd; for (i = 1; i < argc; i++) { p = argv[i]; - if (*p == T('-')) - p++; - else - continue; - if (*p == T('-')) - p++; - if (!tstrcmp(p, T("help"))) { - for_imagex_command(cmd) { - if (!tstrcmp(cmd->name, argv[1])) { - usage(cmd->cmd); - exit(0); - } + if (p[0] == T('-') && p[1] == T('-')) { + p += 2; + if (!tstrcmp(p, T("help"))) { + if (cmd == CMD_NONE) + usage_all(stdout); + else + usage(cmd, stdout); + exit(0); + } else if (!tstrcmp(p, T("version"))) { + version(); + exit(0); } - usage_all(); - exit(0); - } - if (!tstrcmp(p, T("version"))) { - version(); - exit(0); } } } +static void +print_usage_string(int cmd, FILE *fp) +{ + tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false)); +} static void -usage(int cmd_type) +recommend_man_page(int cmd, FILE *fp) { - const struct imagex_command *cmd; - tprintf(T("Usage:\n%"TS), usage_strings[cmd_type]); - for_imagex_command(cmd) { - if (cmd->cmd == cmd_type) { - tprintf(T("\nTry `man "IMAGEX_PROGNAME"-%"TS"' " - "for more details.\n"), cmd->name); - } - } + const tchar *format_str; +#ifdef __WIN32__ + format_str = T("See %"TS".pdf in the doc directory for more details.\n"); +#else + format_str = T("Try `man %"TS"' for more details.\n"); +#endif + tfprintf(fp, format_str, get_cmd_string(cmd, true)); } static void -usage_all() +usage(int cmd, FILE *fp) { - tfputs(T("Usage:\n"), stdout); - for (int i = 0; i < ARRAY_LEN(usage_strings); i++) - tprintf(T(" %"TS), usage_strings[i]); + tfprintf(fp, T("Usage:\n")); + print_usage_string(cmd, fp); + tfprintf(fp, T("\n")); + recommend_man_page(cmd, fp); +} + +static void +usage_all(FILE *fp) +{ + tfprintf(fp, T("Usage:\n")); + for (int cmd = 0; cmd < CMD_MAX; cmd++) { + print_usage_string(cmd, fp); + tfprintf(fp, T("\n")); + } static const tchar *extra = T( -" "IMAGEX_PROGNAME" --help\n" -" "IMAGEX_PROGNAME" --version\n" +" %"TS" --help\n" +" %"TS" --version\n" "\n" " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n" "\n" -" Try `man "IMAGEX_PROGNAME"' for more information.\n" ); - tfputs(extra, stdout); + tfprintf(fp, extra, invocation_name, invocation_name); + recommend_man_page(CMD_NONE, fp); } /* Entry point for wimlib's ImageX implementation. On UNIX the command @@ -2515,76 +3976,109 @@ wmain(int argc, wchar_t **argv, wchar_t **envp) main(int argc, char **argv) #endif { - const struct imagex_command *cmd; int ret; + int init_flags = 0; + int cmd; + + imagex_info_file = stdout; + invocation_name = tbasename(argv[0]); #ifndef __WIN32__ - setlocale(LC_ALL, ""); - { - char *codeset = nl_langinfo(CODESET); + if (getenv("WIMLIB_IMAGEX_USE_UTF8")) { + init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8; + } else { + char *codeset; + + setlocale(LC_ALL, ""); + codeset = nl_langinfo(CODESET); if (!strstr(codeset, "UTF-8") && !strstr(codeset, "UTF8") && !strstr(codeset, "utf-8") && !strstr(codeset, "utf8")) { - fputs( -"WARNING: Running "IMAGEX_PROGNAME" in a UTF-8 locale is recommended!\n" -" (Maybe try: `export LANG=en_US.UTF-8'?\n", stderr); + fprintf(stderr, +"WARNING: Running %"TS" in a UTF-8 locale is recommended!\n" +" Maybe try: `export LANG=en_US.UTF-8'?\n" +" Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n" +" to any value to force wimlib to use UTF-8.\n", + invocation_name); } } #endif /* !__WIN32__ */ - if (argc < 2) { - imagex_error(T("No command specified")); - usage_all(); - ret = 2; - goto out; + /* Allow being invoked as wimCOMMAND (e.g. wimapply). */ + cmd = CMD_NONE; + if (!tstrncmp(invocation_name, T("wim"), 3) && + tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) { + for (int i = 0; i < CMD_MAX; i++) { + if (!tstrcmp(invocation_name + 3, + imagex_commands[i].name)) + { + invocation_cmd = i; + cmd = i; + break; + } + } } - /* Handle --help and --version for all commands. Note that this will - * not return if either of these arguments are present. */ - help_or_version(argc, argv); - argc--; - argv++; + /* Unless already known from the invocation name, determine which + * command was specified. */ + if (cmd == CMD_NONE) { + if (argc < 2) { + imagex_error(T("No command specified!\n")); + usage_all(stderr); + exit(2); + } + for (int i = 0; i < CMD_MAX; i++) { + if (!tstrcmp(argv[1], imagex_commands[i].name)) { + cmd = i; + break; + } + } + if (cmd != CMD_NONE) { + argc--; + argv++; + } + } - /* The user may like to see more informative error messages. */ + /* Handle --help and --version. --help can be either for the program as + * a whole (cmd == CMD_NONE) or just for a specific command (cmd != + * CMD_NONE). Note: help_or_version() will not return if a --help or + * --version argument was found. */ + help_or_version(argc, argv, cmd); + + /* Bail if a valid command was not specified. */ + if (cmd == CMD_NONE) { + imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]); + usage_all(stderr); + exit(2); + } + + /* Enable warning and error messages in wimlib be more user-friendly. + * */ wimlib_set_print_errors(true); - /* Do any initializations that the library needs */ - ret = wimlib_global_init(); + /* Initialize wimlib. */ + ret = wimlib_global_init(init_flags); if (ret) goto out_check_status; - /* Search for the function to handle the ImageX subcommand. */ - for_imagex_command(cmd) { - if (!tstrcmp(cmd->name, *argv)) { - ret = cmd->func(argc, argv); - goto out_check_write_error; - } - } - - imagex_error(T("Unrecognized command: `%"TS"'"), argv[0]); - usage_all(); - ret = 2; - goto out_cleanup; -out_check_write_error: - /* For 'wimlib-imagex info' and 'wimlib-imagex dir', data printed to - * standard output is part of the program's actual behavior and not just - * for informational purposes, so we should set a failure exit status if - * there was a write error. */ - if (cmd == &imagex_commands[INFO] || cmd == &imagex_commands[DIR]) { - if (ferror(stdout) || fclose(stdout)) { - imagex_error_with_errno(T("error writing to standard output")); - if (ret == 0) - ret = -1; - } + /* Call the command handler function. */ + ret = imagex_commands[cmd].func(argc, argv, cmd); + + /* Check for error writing to standard output, especially since for some + * commands, writing to standard output is part of the program's actual + * behavior and not just for informational purposes. */ + if (ferror(stdout) || fclose(stdout)) { + imagex_error_with_errno(T("error writing to standard output")); + if (ret == 0) + ret = -1; } out_check_status: /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex' - * outside of the wimlib library code. 0 indicates success. > 0 - * indicates a wimlib error code from which an error message can be - * printed. */ + * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib + * error code from which an error message can be printed. */ if (ret > 0) { imagex_error(T("Exiting with error code %d:\n" " %"TS"."), ret, @@ -2592,10 +4086,8 @@ out_check_status: if (ret == WIMLIB_ERR_NTFS_3G && errno != 0) imagex_error_with_errno(T("errno")); } -out_cleanup: - /* Make the library free any resources it's holding (not strictly - * necessary because the process is ending anyway). */ + /* Make wimlib free any resources it's holding (although this is not + * strictly necessary because the process is ending anyway). */ wimlib_global_cleanup(); -out: return ret; }