X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=programs%2Fimagex.c;h=0439869d225d98491f5d0e3f825633fb2c824ab5;hp=071f3749d3a6e17fecc19a00aa8bd3ec7baeb33c;hb=11a80b08ffd289172eb530aa1b24cbf92604f4bc;hpb=fb964811a120ad28cac62a9a3343def5bf474f03 diff --git a/programs/imagex.c b/programs/imagex.c index 071f3749..0439869d 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,19 +43,23 @@ #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 "/" #endif /* !__WIN32 */ @@ -76,10 +83,13 @@ enum imagex_op_type { OPTIMIZE, SPLIT, UNMOUNT, + UPDATE, }; static void usage(int cmd_type); -static void usage_all(); +static void usage_all(void); + +static bool imagex_be_quiet = false; static const tchar *usage_strings[] = { @@ -98,6 +108,7 @@ 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] [--rpfix] [--norpfix]\n" +" [--include-invalid-names]\n" ), [CAPTURE] = T( @@ -114,7 +125,7 @@ IMAGEX_PROGNAME" delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft ), [DIR] = T( -IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n" +IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n" ), [EXPORT] = T( @@ -125,9 +136,10 @@ IMAGEX_PROGNAME" export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n" ), [EXTRACT] = T( -IMAGEX_PROGNAME" extract SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME) [PATH...]\n" -" [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data] [--no-acls]\n" -" [--strict-acls] [--to-stdout] [--dest-dir=DIR]\n" +IMAGEX_PROGNAME" extract WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n" +" [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n" +" [--no-acls] [--strict-acls] [--to-stdout] [--dest-dir=DIR]\n" +" [--include-invalid-names]\n" ), [INFO] = T( @@ -162,14 +174,36 @@ IMAGEX_PROGNAME" split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n" ), [UNMOUNT] = T( -IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild]\n" +IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n" +), +[UPDATE] = +T( +IMAGEX_PROGNAME" update WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n" +" [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n" +" [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n" ), }; + +static void +recommend_man_page(const tchar *cmd_name) +{ + const tchar *format_str; +#ifdef __WIN32__ + format_str = T("See "IMAGEX_PROGNAME"%"TS"%"TS".pdf in the " + "doc directory for more details.\n"); +#else + format_str = T("Try `man "IMAGEX_PROGNAME"%"TS"%"TS"' " + "for more details.\n"); +#endif + tprintf(format_str, *cmd_name ? T("-") : T(""), cmd_name); +} + enum { IMAGEX_ALLOW_OTHER_OPTION, IMAGEX_BOOT_OPTION, IMAGEX_CHECK_OPTION, + IMAGEX_COMMAND_OPTION, IMAGEX_COMMIT_OPTION, IMAGEX_COMPRESS_OPTION, IMAGEX_CONFIG_OPTION, @@ -178,14 +212,19 @@ enum { 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_NO_ACLS_OPTION, - IMAGEX_REBULID_OPTION, + IMAGEX_PATH_OPTION, + IMAGEX_REBUILD_OPTION, IMAGEX_RECOMPRESS_OPTION, + IMAGEX_RECURSIVE_OPTION, IMAGEX_REF_OPTION, IMAGEX_RPFIX_OPTION, IMAGEX_SOFT_OPTION, @@ -213,6 +252,7 @@ static const struct option apply_options[] = { {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}, {NULL, 0, NULL, 0}, }; static const struct option capture_or_append_options[] = { @@ -224,7 +264,7 @@ static const struct option capture_or_append_options[] = { {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}, @@ -240,13 +280,18 @@ static const struct option delete_options[] = { {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("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION}, {NULL, 0, NULL, 0}, }; @@ -260,6 +305,7 @@ static const struct option extract_options[] = { {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}, }; @@ -305,14 +351,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}, +}; + +#ifdef __GNUC__ +# 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; @@ -324,7 +404,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; @@ -419,42 +499,41 @@ tchar *default_pats[] = { static struct wimlib_capture_config default_capture_config = { .exclusion_pats = { - .num_pats = sizeof(default_pats) / sizeof(*default_pats), + .num_pats = sizeof(default_pats) / sizeof(default_pats[0]), .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; @@ -464,7 +543,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++; @@ -472,17 +551,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 { @@ -494,7 +573,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 @@ -517,13 +596,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 @@ -723,12 +802,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); @@ -789,7 +868,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); @@ -853,8 +932,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. @@ -915,18 +993,6 @@ 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))) @@ -946,14 +1012,41 @@ get_data_type(int ctype) return NULL; } +#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) +{ + 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; + } +} + /* Progress callback function passed to various wimlib functions. */ static int 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) { @@ -964,10 +1057,12 @@ imagex_progress_func(enum wimlib_progress_msg msg, data_type, info->write_streams.num_threads, (info->write_streams.num_threads == 1) ? T("") : T("s")); } - tprintf(T("\r%"PRIu64" MiB of %"PRIu64" MiB (uncompressed) " + tprintf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) " "written (%u%% done)"), - info->write_streams.completed_bytes >> 20, - info->write_streams.total_bytes >> 20, + 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')); @@ -975,7 +1070,8 @@ imagex_progress_func(enum wimlib_progress_msg msg, case WIMLIB_PROGRESS_MSG_SCAN_BEGIN: tprintf(T("Scanning \"%"TS"\""), info->scan.source); if (*info->scan.wim_target_path) { - tprintf(T(" (loading as WIM path: \"/%"TS"\")...\n"), + tprintf(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")); @@ -990,24 +1086,30 @@ imagex_progress_func(enum wimlib_progress_msg msg, /*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"), + tprintf(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')); 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, + tprintf(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')); @@ -1023,7 +1125,8 @@ imagex_progress_func(enum wimlib_progress_msg msg, info->extract.target); break; case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN: - tprintf(T("Extracting \"%"TS"\" from image %d (\"%"TS"\") " + tprintf(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, @@ -1038,10 +1141,13 @@ imagex_progress_func(enum wimlib_progress_msg msg, case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS: percent_done = TO_PERCENT(info->extract.completed_bytes, info->extract.total_bytes); + unit_shift = get_unit(info->extract.total_bytes, &unit_name); tprintf(T("\rExtracting files: " - "%"PRIu64" MiB of %"PRIu64" MiB (%u%%) done"), - info->extract.completed_bytes >> 20, - info->extract.total_bytes >> 20, + "%"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')); @@ -1062,23 +1168,29 @@ imagex_progress_func(enum wimlib_progress_msg msg, case WIMLIB_PROGRESS_MSG_JOIN_STREAMS: percent_done = TO_PERCENT(info->join.completed_bytes, info->join.total_bytes); + unit_shift = get_unit(info->join.total_bytes, &unit_name); tprintf(T("Writing resources from part %u of %u: " - "%"PRIu64 " MiB of %"PRIu64" MiB (%u%%) written\n"), + "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%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, + info->join.completed_bytes >> unit_shift, + unit_name, + info->join.total_bytes >> unit_shift, + unit_name, 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); + tprintf(T("Writing \"%"TS"\": %"PRIu64" %"TS" of " + "%"PRIu64" %"TS" (%u%%) written\n"), info->split.part_name, - info->split.completed_bytes >> 20, - info->split.total_bytes >> 20, + 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: @@ -1087,6 +1199,25 @@ imagex_progress_func(enum wimlib_progress_msg msg, info->split.cur_part_number); } break; + case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND: + switch (info->update.command->op) { + case WIMLIB_UPDATE_OP_DELETE: + tprintf(T("Deleted WIM path " + "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"), + info->update.command->delete.wim_path); + break; + case WIMLIB_UPDATE_OP_RENAME: + tprintf(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; } @@ -1112,7 +1243,7 @@ open_swms_from_glob(const tchar *swm_glob, /* Warning: glob() is replaced in Windows native builds */ ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf); - if (ret != 0) { + if (ret) { if (ret == GLOB_NOMATCH) { imagex_error(T("Found no files for glob \"%"TS"\""), swm_glob); @@ -1140,7 +1271,7 @@ open_swms_from_glob(const tchar *swm_glob, open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &additional_swms[i - offset], imagex_progress_func); - if (ret != 0) + if (ret) goto out_close_swms; } *additional_swms_ret = additional_swms; @@ -1171,6 +1302,213 @@ parse_num_threads(const tchar *optarg) } } +/* + * 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_IMAGE_FLAG_VERBOSE; + else if (!tstrcmp(option, T("--unix-data"))) + cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA; + else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls"))) + cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS; + else if (!tstrcmp(option, T("--strict-acls"))) + cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS; + else if (!tstrcmp(option, T("--dereference"))) + cmd->add.add_flags |= WIMLIB_ADD_IMAGE_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; +} + +/* 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, +}; + +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 (!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; + + /* Parse additional options and non-options as needed */ + num_nonoptions = 0; + for (;;) { + tchar *next_string; + + 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. */ @@ -1180,17 +1518,15 @@ imagex_apply(int argc, tchar **argv) int c; int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; int image; - int num_images; - WIMStruct *w; + WIMStruct *wim; 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; + WIMStruct **additional_swms; + unsigned num_additional_swms; for_opt(c, apply_options) { switch (c) { @@ -1224,72 +1560,85 @@ imagex_apply(int argc, tchar **argv) 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; default: - usage(APPLY); - return -1; + goto out_usage; } } argc -= optind; argv += optind; - if (argc != 2 && argc != 3) { - usage(APPLY); - return -1; - } + if (argc != 2 && argc != 3) + goto out_usage; 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]; - } - - 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) + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); + if (ret) goto out; - 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; + if (argc >= 3) { + /* Image explicitly specified. */ + image = wimlib_resolve_image(wim, argv[1]); + ret = verify_image_exists(image, argv[1], 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. */ + 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; + target = argv[1]; } if (swm_glob) { ret = open_swms_from_glob(swm_glob, wimfile, open_flags, &additional_swms, &num_additional_swms); - if (ret != 0) - goto out; + if (ret) + goto out_wimlib_free; + } else { + additional_swms = NULL; + num_additional_swms = 0; } - struct stat stbuf; - ret = tstat(target, &stbuf); - if (ret == 0) { - if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) - extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS; - } else { - if (errno != ENOENT) { - imagex_error_with_errno(T("Failed to stat \"%"TS"\""), - target); - ret = -1; - goto out; +#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_free_swms; + } + } else { + if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) + extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS; } } +#endif #ifdef __WIN32__ win32_acquire_restore_privileges(); #endif - ret = wimlib_extract_image(w, image, target, extract_flags, + ret = wimlib_extract_image(wim, image, target, extract_flags, additional_swms, num_additional_swms, imagex_progress_func); if (ret == 0) @@ -1297,14 +1646,19 @@ imagex_apply(int argc, tchar **argv) #ifdef __WIN32__ win32_release_restore_privileges(); #endif +out_free_swms: + for (unsigned i = 0; i < num_additional_swms; i++) + wimlib_free(additional_swms[i]); + free(additional_swms); +out_wimlib_free: + wimlib_free(wim); out: - wimlib_free(w); - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); - } return ret; + +out_usage: + usage(APPLY); + ret = -1; + goto out; } /* Create a WIM image from a directory tree, NTFS volume, or multiple files or @@ -1315,7 +1669,7 @@ static int imagex_capture_or_append(int argc, tchar **argv) { int c; - int open_flags = 0; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE; int write_flags = 0; int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS; @@ -1323,19 +1677,17 @@ imagex_capture_or_append(int argc, tchar **argv) const tchar *name; const tchar *desc; const tchar *flags_element = NULL; - WIMStruct *w; + WIMStruct *wim; 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; @@ -1343,6 +1695,7 @@ imagex_capture_or_append(int argc, tchar **argv) 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) { @@ -1359,7 +1712,7 @@ imagex_capture_or_append(int argc, tchar **argv) 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_FLAGS_OPTION: flags_element = optarg; @@ -1373,9 +1726,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: @@ -1397,33 +1750,38 @@ imagex_capture_or_append(int argc, tchar **argv) add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX; 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]; 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 */ @@ -1434,7 +1792,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, @@ -1474,17 +1832,18 @@ imagex_capture_or_append(int argc, tchar **argv) } if (cmd == APPEND) - ret = wimlib_open_wim(wimfile, open_flags, &w, + 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; +#ifndef __WIN32__ 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 " "filesystem on \"%"TS"\"\n"), source); @@ -1499,40 +1858,67 @@ imagex_capture_or_append(int argc, tchar **argv) } } } +#endif + + if (cmd == APPEND && name_defaulted) { + /* 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. */ + 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); + } + } #ifdef __WIN32__ win32_acquire_capture_privileges(); #endif - ret = wimlib_add_image_multisource(w, + ret = wimlib_add_image_multisource(wim, capture_sources, num_sources, name, config, add_image_flags, imagex_progress_func); - if (ret != 0) + if (ret) 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 (desc || flags_element) { + /* User provided or element. 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_release_privs; + } + + if (flags_element) { + ret = wimlib_set_image_flags(wim, info.image_count, + flags_element); + if (ret) + goto out_release_privs; + } } + if (cmd == APPEND) { - ret = wimlib_overwrite(w, write_flags, num_threads, + ret = wimlib_overwrite(wim, write_flags, num_threads, imagex_progress_func); } else { - ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags, + ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES, write_flags, num_threads, imagex_progress_func); } - if (ret == WIMLIB_ERR_REOPEN) - ret = 0; - if (ret != 0) + if (ret) imagex_error(T("Failed to write the WIM file \"%"TS"\""), wimfile); out_release_privs: @@ -1540,9 +1926,9 @@ out_release_privs: win32_release_capture_privileges(); #endif out_wimlib_free: - wimlib_free(w); + wimlib_free(wim); out_free_config: - if (config != NULL && config != &default_capture_config) { + if (config != &default_capture_config) { free(config->exclusion_pats.pats); free(config->exclusion_exception_pats.pats); free(config_str); @@ -1552,7 +1938,14 @@ out_free_capture_sources: free(capture_sources); out_free_source_list_contents: free(source_list_contents); +out: return ret; + +out_usage: + usage(cmd); +out_err: + ret = -1; + goto out; } /* Remove image(s) from a WIM. */ @@ -1560,11 +1953,11 @@ static int imagex_delete(int argc, tchar **argv) { 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; @@ -1578,8 +1971,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; @@ -1590,43 +1982,50 @@ 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(DELETE); + 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. */ @@ -1634,51 +2033,73 @@ static int imagex_dir(int argc, tchar **argv) { const tchar *wimfile; - WIMStruct *w; + WIMStruct *wim = NULL; int image; int ret; - int num_images; + const tchar *path = T(""); + int c; - if (argc < 2) { - imagex_error(T("Must specify a WIM file")); - usage(DIR); - return -1; - } - if (argc > 3) { - imagex_error(T("Too many arguments")); - usage(DIR); - return -1; + for_opt(c, dir_options) { + switch (c) { + case IMAGEX_PATH_OPTION: + path = optarg; + break; + default: + goto out_usage; + } } + argc -= optind; + argv += optind; - wimfile = argv[1]; - ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w, + if (argc < 1) { + imagex_error(T("Must specify a WIM file")); + goto out_usage; + } + if (argc > 2) { + imagex_error(T("Too many arguments")); + goto out_usage; + } + + wimfile = argv[0]; + ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &wim, 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; + 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(DIR); + ret = -1; + goto out; } /* Exports one, or all, images from a WIM file to a new WIM file or an existing @@ -1690,22 +2111,21 @@ imagex_export(int argc, tchar **argv) 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; const tchar *dest_name; const tchar *dest_desc; - WIMStruct *src_w = NULL; - WIMStruct *dest_w = NULL; + WIMStruct *src_wim; + 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; + WIMStruct **additional_swms; + unsigned num_additional_swms; unsigned num_threads = 0; for_opt(c, export_options) { @@ -1720,8 +2140,7 @@ imagex_export(int argc, tchar **argv) 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; @@ -1729,39 +2148,34 @@ imagex_export(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; 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, + open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_wim, imagex_progress_func); - if (ret != 0) - return ret; + if (ret) + goto out; /* 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; - wim_is_new = false; /* Destination file exists. */ @@ -1769,82 +2183,100 @@ 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. */ + + struct wimlib_wim_info src_info; + + wimlib_get_wim_info(src_wim, &src_info); + compression_type = src_info.compression_type; + } + ret = wimlib_create_new_wim(compression_type, &dest_wim); + if (ret) + goto out_free_src_wim; } - 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 (ret) + goto out_free_dest_wim; + } else { + additional_swms = NULL; + num_additional_swms = 0; } - ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc, - export_flags, additional_swms, + ret = wimlib_export_image(src_wim, image, dest_wim, dest_name, + dest_desc, export_flags, additional_swms, num_additional_swms, imagex_progress_func); - if (ret != 0) - goto out; - + if (ret) + goto out_free_swms; if (wim_is_new) - ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES, + 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, + ret = wimlib_overwrite(dest_wim, write_flags, num_threads, imagex_progress_func); +out_free_swms: + for (unsigned i = 0; i < num_additional_swms; i++) + wimlib_free(additional_swms[i]); + free(additional_swms); +out_free_dest_wim: + wimlib_free(dest_wim); +out_free_src_wim: + wimlib_free(src_wim); 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); - } return ret; + +out_usage: + usage(EXPORT); +out_err: + ret = -1; + goto out; } static bool @@ -1868,18 +2300,19 @@ free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds, } static struct wimlib_extract_command * -prepare_extract_commands(tchar **argv, int argc, int extract_flags, - tchar *dest_dir, size_t *num_cmds_ret) +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 (argc == 0) { - argc = 1; - argv = &emptystr; + if (num_paths == 0) { + num_paths = 1; + paths = &emptystr; } - num_cmds = argc; + num_cmds = num_paths; cmds = calloc(num_cmds, sizeof(cmds[0])); if (!cmds) { imagex_error(T("Out of memory!")); @@ -1888,18 +2321,19 @@ prepare_extract_commands(tchar **argv, int argc, int extract_flags, for (size_t i = 0; i < num_cmds; i++) { cmds[i].extract_flags = extract_flags; - cmds[i].wim_source_path = argv[i]; - if (is_root_wim_path(argv[i])) { + 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(argv[i]); + 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"/%"TS), dest_dir, - tbasename(argv[i])); + tsprintf(cmds[i].fs_dest_path, + T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS), + dest_dir, tbasename(paths[i])); } } *num_cmds_ret = num_cmds; @@ -1918,11 +2352,11 @@ imagex_extract(int argc, tchar **argv) const tchar *wimfile; const tchar *image_num_or_name; tchar *dest_dir = T("."); - int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL; + int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX; const tchar *swm_glob = NULL; - WIMStruct **additional_swms = NULL; - unsigned num_additional_swms = 0; + WIMStruct **additional_swms; + unsigned num_additional_swms; struct wimlib_extract_command *cmds; size_t num_cmds; @@ -1952,21 +2386,22 @@ imagex_extract(int argc, tchar **argv) break; case IMAGEX_TO_STDOUT_OPTION: extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT; + 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: - usage(EXTRACT); - ret = -1; - goto out; + goto out_usage; } } argc -= optind; argv += optind; - if (argc < 2) { - usage(EXTRACT); - ret = -1; - goto out; - } + if (argc < 2) + goto out_usage; + wimfile = argv[0]; image_num_or_name = argv[1]; @@ -1975,10 +2410,8 @@ imagex_extract(int argc, tchar **argv) cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir, &num_cmds); - if (!cmds) { - ret = -1; - goto out; - } + if (!cmds) + goto out_err; ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); if (ret) @@ -1997,31 +2430,114 @@ imagex_extract(int argc, tchar **argv) &num_additional_swms); if (ret) goto out_wimlib_free; + } else { + additional_swms = NULL; + num_additional_swms = 0; } #ifdef __WIN32__ win32_acquire_restore_privileges(); #endif - ret = wimlib_extract_files(wim, image, 0, cmds, num_cmds, + ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0, additional_swms, num_additional_swms, imagex_progress_func); - if (ret == 0) - tprintf(T("Done extracting files.\n")); + if (ret == 0) { + if (!imagex_be_quiet) + tprintf(T("Done extracting files.\n")); + } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) { + tfprintf(stderr, T("Note: You can use `"IMAGEX_PROGNAME" dir' to see what " + "files and directories\n" + " are in the WIM image.\n")); + } #ifdef __WIN32__ win32_release_restore_privileges(); #endif - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); - } + for (unsigned i = 0; i < num_additional_swms; i++) + wimlib_free(additional_swms[i]); + free(additional_swms); out_wimlib_free: wimlib_free(wim); out_free_cmds: free_extract_commands(cmds, num_cmds, dest_dir); out: return ret; + +out_usage: + usage(EXTRACT); +out_err: + ret = -1; + goto out; +} + +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("Image Count: %d\n"), info->image_count); + tprintf(T("Compression: %"TS"\n"), + wimlib_get_compression_type_string(info->compression_type)); + 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")); + 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); + + tprintf(T("Compressed size = %"PRIu64" bytes\n"), + resource->compressed_size); + + tprintf(T("Offset = %"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 ")); + 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, @@ -2039,17 +2555,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; + struct wimlib_wim_info info; for_opt(c, info_options) { switch (c) { @@ -2080,76 +2593,59 @@ 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) 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); + imagex_error(T("The image \"%"TS"\" does not exist in \"%"TS"\""), + 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; } } @@ -2160,71 +2656,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; @@ -2232,22 +2725,26 @@ 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)) { + if (image == info.boot_index) { tprintf(T("Image %d is already marked as " "bootable.\n"), image); boot = false; } else { tprintf(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"), image, new_name); @@ -2255,14 +2752,14 @@ imagex_info(int argc, tchar **argv) } else { tprintf(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 " "\"%"TS"\".\n"), image, new_desc); @@ -2270,42 +2767,39 @@ imagex_info(int argc, tchar **argv) } else { tprintf(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. */ if (boot || new_name || new_desc || - (check && !wimlib_has_integrity_table(w))) + (check && !info.has_integrity_table)) { - int write_flags; - - ret = file_writable(wimfile); - if (ret != 0) - goto out; + 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; + 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); ret = 0; } } +out_wimlib_free: + wimlib_free(wim); out: - wimlib_free(w); return ret; + +out_usage: + usage(INFO); + ret = -1; + goto out; } /* Join split WIMs into one part WIM */ @@ -2316,6 +2810,7 @@ imagex_join(int argc, tchar **argv) int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; int wim_write_flags = 0; const tchar *output_path; + int ret; for_opt(c, join_options) { switch (c) { @@ -2324,7 +2819,7 @@ imagex_join(int argc, tchar **argv) wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY; break; default: - goto err; + goto out_usage; } } argc -= optind; @@ -2333,18 +2828,22 @@ 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: + 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(JOIN); - return -1; + ret = -1; + goto out; } /* Mounts an image using a FUSE mount. */ @@ -2354,19 +2853,20 @@ imagex_mount_rw_or_ro(int argc, tchar **argv) int c; int mount_flags = 0; int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK; + const tchar *swm_glob = NULL; + const tchar *staging_dir = NULL; const tchar *wimfile; const tchar *dir; - WIMStruct *w; + WIMStruct *wim; 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; + WIMStruct **additional_swms; + unsigned num_additional_swms; - if (!tstrcmp(argv[0], T("mountrw"))) + if (!tstrcmp(argv[0], T("mountrw"))) { mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE; + open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS; + } for_opt(c, mount_options) { switch (c) { @@ -2389,7 +2889,7 @@ 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: @@ -2402,75 +2902,74 @@ 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; + + 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) + goto out_free_wim; + } 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; + dir = argv[1]; + } if (swm_glob) { ret = open_swms_from_glob(swm_glob, wimfile, open_flags, &additional_swms, &num_additional_swms); - if (ret != 0) - goto out; - } - - 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]; + if (ret) + goto out_free_wim; } else { - image = wimlib_resolve_image(w, argv[1]); - dir = argv[2]; - ret = verify_image_exists_and_is_single(image, argv[1], wimfile); - if (ret != 0) - goto out; - } - - if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) { - ret = file_writable(wimfile); - if (ret != 0) - goto out; + additional_swms = NULL; + num_additional_swms = 0; } - ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms, + ret = wimlib_mount_image(wim, image, dir, mount_flags, additional_swms, num_additional_swms, staging_dir); - if (ret != 0) { + if (ret) { imagex_error(T("Failed to mount image %d from \"%"TS"\" " "on \"%"TS"\""), image, wimfile, dir); - } + for (unsigned i = 0; i < num_additional_swms; i++) + wimlib_free(additional_swms[i]); + free(additional_swms); +out_free_wim: + wimlib_free(wim); out: - wimlib_free(w); - if (additional_swms) { - for (unsigned i = 0; i < num_additional_swms; i++) - wimlib_free(additional_swms[i]); - free(additional_swms); - } return ret; -mount_usage: + +out_usage: usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) ? MOUNTRW : MOUNT); - return -1; + ret = -1; + goto out; } /* Rebuild a WIM file */ @@ -2478,10 +2977,10 @@ static int imagex_optimize(int argc, tchar **argv) { int c; - int open_flags = 0; + int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS; int write_flags = WIMLIB_WRITE_FLAG_REBUILD; int ret; - WIMStruct *w; + WIMStruct *wim; const tchar *wimfile; off_t old_size; off_t new_size; @@ -2499,57 +2998,61 @@ imagex_optimize(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; 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; - 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, num_threads, + ret = wimlib_overwrite(wim, write_flags, num_threads, imagex_progress_func); + if (ret) + 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(OPTIMIZE); +out_err: + ret = -1; + goto out; } /* Split a WIM into a spanned set */ @@ -2557,12 +3060,12 @@ static int imagex_split(int argc, tchar **argv) { 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) { @@ -2571,30 +3074,36 @@ 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(SPLIT); +out_err: + ret = -1; + goto out; } /* Unmounts a mounted WIM image. */ @@ -2613,26 +3122,256 @@ 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(UNMOUNT); + ret = -1; + goto out; +} + +/* + * Add, delete, or rename files in a WIM image. + */ +static int +imagex_update(int argc, tchar **argv) +{ + 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_IMAGE_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: + config_file = optarg; + break; + + /* Default add options */ + case IMAGEX_VERBOSE_OPTION: + default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE; + break; + case IMAGEX_DEREFERENCE_OPTION: + default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE; + break; + case IMAGEX_UNIX_DATA_OPTION: + default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA; + break; + case IMAGEX_NO_ACLS_OPTION: + default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS; + break; + case IMAGEX_STRICT_ACLS_OPTION: + default_add_flags |= WIMLIB_ADD_IMAGE_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 = &default_capture_config; + } + + /* 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(T("update")); + } + 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 */ + bool have_add_command = false; + 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; + have_add_command = true; + break; + case WIMLIB_UPDATE_OP_DELETE: + cmds[i].delete.delete_flags |= default_delete_flags; + break; + default: + break; + } + } + +#ifdef __WIN32__ + if (have_add_command) + win32_acquire_capture_privileges(); +#endif + + /* Execute the update commands */ + ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags, + imagex_progress_func); + if (ret) + goto out_release_privs; + + /* Overwrite the updated WIM */ + ret = wimlib_overwrite(wim, write_flags, num_threads, + imagex_progress_func); +out_release_privs: +#ifdef __WIN32__ + if (have_add_command) + win32_release_capture_privileges(); +#endif + free(cmds); +out_free_cmd_file_contents: + free(cmd_file_contents); +out_free_config: + if (config != &default_capture_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(UPDATE); +out_err: + ret = -1; + goto out_free_command_str; } struct imagex_command { @@ -2660,10 +3399,11 @@ static const struct imagex_command imagex_commands[] = { {T("optimize"),imagex_optimize, OPTIMIZE}, {T("split"), imagex_split, SPLIT}, {T("unmount"), imagex_unmount, UNMOUNT}, + {T("update"), imagex_update, UPDATE}, }; static void -version() +version(void) { static const tchar *s = T( @@ -2719,14 +3459,14 @@ usage(int cmd_type) 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); + tputc(T('\n'), stdout); + recommend_man_page(cmd->name); } } } static void -usage_all() +usage_all(void) { tfputs(T("Usage:\n"), stdout); for (int i = 0; i < ARRAY_LEN(usage_strings); i++) @@ -2738,9 +3478,9 @@ usage_all() "\n" " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n" "\n" -" Try `man "IMAGEX_PROGNAME"' for more information.\n" ); tfputs(extra, stdout); + recommend_man_page(T("")); } /* Entry point for wimlib's ImageX implementation. On UNIX the command