X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=programs%2Fimagex.c;h=5d7aa233236443b34d9526d7bcce689b3eb4e43e;hb=fad9af236d169e5d02577ebddc91239c0d6024b0;hp=4735f1aa2dd6614e0a0998dfdca27c19ab83c886;hpb=161d3898359e3feb8c96ae220b376ef33c72a1d6;p=wimlib diff --git a/programs/imagex.c b/programs/imagex.c index 4735f1aa..5d7aa233 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 */ @@ -80,7 +87,7 @@ enum imagex_op_type { }; static void usage(int cmd_type); -static void usage_all(); +static void usage_all(void); static bool imagex_be_quiet = false; @@ -101,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( @@ -131,6 +139,7 @@ T( 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( @@ -165,25 +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 [--check] [--rebuild]\n" -" [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n" -" [DEFAULT_DELETE_OPTIONS] [< CMDFILE]\n" -" ... where each CMD is:\n" -" add [--unix-data] [--no-acls] [--strict-acls] [--dereference]\n" -" [--verbose] FILE_OR_DIRECTORY DEST_WIM_PATH\n" -" delete [--force] [--recursive] WIM_PATH\n" -" rename SRC_PATH_IN_WIM DEST_PATH_IN_WIM\n" +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, @@ -195,6 +215,8 @@ enum { 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, @@ -229,6 +251,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[] = { @@ -276,6 +299,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}, }; @@ -322,21 +346,35 @@ 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_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}, }; @@ -454,36 +492,35 @@ static struct wimlib_capture_config default_capture_config = { }; 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; @@ -493,7 +530,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++; @@ -501,17 +538,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 { @@ -523,7 +560,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 @@ -546,13 +583,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 @@ -752,12 +789,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); @@ -882,8 +919,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. @@ -975,16 +1011,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) { @@ -995,10 +1056,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')); @@ -1006,7 +1069,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")); @@ -1021,24 +1085,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')); @@ -1054,7 +1124,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, @@ -1069,10 +1140,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')); @@ -1093,23 +1167,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: @@ -1118,6 +1198,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; } @@ -1202,6 +1301,19 @@ 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) @@ -1209,7 +1321,9 @@ update_command_add_option(int op, const tchar *option, bool recognized = true; switch (op) { case WIMLIB_UPDATE_OP_ADD: - if (!tstrcmp(option, T("--unix-data"))) + 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; @@ -1228,20 +1342,21 @@ update_command_add_option(int op, const tchar *option, else recognized = false; break; - case WIMLIB_UPDATE_OP_RENAME: + 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 bool +static void update_command_add_nonoption(int op, const tchar *nonoption, struct wimlib_update_command *cmd, unsigned num_nonoptions) @@ -1263,9 +1378,22 @@ update_command_add_nonoption(int op, const tchar *nonoption, cmd->rename.wim_target_path = (tchar*)nonoption; break; } - return true; } +/* + * 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, @@ -1276,8 +1404,9 @@ parse_update_command(tchar *line, size_t len, int op; size_t num_nonoptions; - ret = parse_filename(&line, &len, &command_name); - if (ret != PARSE_FILENAME_SUCCESS) + /* 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"))) { @@ -1292,25 +1421,29 @@ parse_update_command(tchar *line, size_t len, return false; } command->op = op; + + /* Parse additional options and non-options as needed */ num_nonoptions = 0; for (;;) { tchar *next_string; - ret = parse_filename(&line, &len, &next_string); - if (ret == PARSE_FILENAME_NONE) + ret = parse_string(&line, &len, &next_string); + if (ret == PARSE_STRING_NONE) /* End of line */ break; - else if (ret != PARSE_FILENAME_SUCCESS) + 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 on line %zu"), - next_string, line_number); + "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 " @@ -1321,9 +1454,8 @@ parse_update_command(tchar *line, size_t len, command_name, num_nonoptions); return false; } - if (!update_command_add_nonoption(op, next_string, - command, num_nonoptions)) - return false; + update_command_add_nonoption(op, next_string, + command, num_nonoptions); num_nonoptions++; } } @@ -1429,6 +1561,10 @@ 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; @@ -1462,7 +1598,7 @@ imagex_apply(int argc, tchar **argv) 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); + "(or all)."), wimfile, num_images); usage(APPLY); ret = -1; goto out; @@ -1548,6 +1684,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) { @@ -1619,13 +1756,16 @@ imagex_capture_or_append(int argc, tchar **argv) 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. */ 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; @@ -1704,6 +1844,20 @@ imagex_capture_or_append(int argc, tchar **argv) } } } + + 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(w, name); + conflict_idx++) + { + tsprintf(name_end, T(" (%lu)"), conflict_idx); + } + } #ifdef __WIN32__ win32_acquire_capture_privileges(); #endif @@ -1871,7 +2025,7 @@ imagex_dir(int argc, tchar **argv) * 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 " + imagex_error(T("\"%"TS"\" contains %d images; Please " "select one."), wimfile, num_images); usage(DIR); ret = -1; @@ -2073,18 +2227,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!")); @@ -2093,18 +2248,18 @@ 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; @@ -2159,20 +2314,20 @@ imagex_extract(int argc, tchar **argv) 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]; @@ -2209,7 +2364,7 @@ imagex_extract(int argc, tchar **argv) 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) { @@ -2234,6 +2389,10 @@ out_free_cmds: free_extract_commands(cmds, num_cmds, dest_dir); out: return ret; +out_usage: + usage(EXTRACT); + ret = -1; + goto out; } /* Prints information about a WIM file; also can mark an image as bootable, @@ -2641,7 +2800,7 @@ imagex_mount_rw_or_ro(int argc, tchar **argv) image = 1; num_images = wimlib_get_num_images(w); if (num_images != 1) { - imagex_error(T("The file \"%"TS"\" contains %d images; Please " + imagex_error(T("\"%"TS"\" contains %d images; Please " "select one."), wimfile, num_images); usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) ? MOUNTRW : MOUNT); @@ -2728,9 +2887,13 @@ imagex_optimize(int argc, tchar **argv) wimfile = argv[0]; + ret = file_writable(wimfile); + if (ret) + return ret; + ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func); - if (ret != 0) + if (ret) return ret; old_size = file_get_size(argv[0]); @@ -2828,6 +2991,9 @@ imagex_unmount(int argc, tchar **argv) 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; @@ -2847,6 +3013,9 @@ imagex_unmount(int argc, tchar **argv) return ret; } +/* + * Add, delete, or rename files in a WIM image. + */ static int imagex_update(int argc, tchar **argv) { @@ -2856,16 +3025,18 @@ imagex_update(int argc, tchar **argv) WIMStruct *wim; int ret; int open_flags = 0; - int write_flags = WIMLIB_WRITE_FLAG_SOFT_DELETE; - int update_flags = 0; - int default_add_flags = 0; + 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; + tchar *cmd_file_contents = NULL; size_t cmd_file_nchars; struct wimlib_update_command *cmds; size_t num_cmds; + int num_images; + tchar *command_str = NULL; const tchar *config_file = NULL; tchar *config_str; @@ -2873,6 +3044,7 @@ imagex_update(int argc, tchar **argv) 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) { @@ -2887,15 +3059,39 @@ imagex_update(int argc, tchar **argv) 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.")); + ret = -1; + goto out; + } + command_str = tstrdup(optarg); + if (!command_str) { + imagex_error(T("Out of memory!")); + ret = -1; + goto out; + } + 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; @@ -2918,6 +3114,11 @@ imagex_update(int argc, tchar **argv) if (argc < 1 || argc > 2) goto out_usage; wimfile = argv[0]; + + ret = file_writable(wimfile); + if (ret) + goto out; + ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func); if (ret) goto out; @@ -2934,6 +3135,16 @@ imagex_update(int argc, tchar **argv) if (ret) goto out_wimlib_free; + num_images = wimlib_get_num_images(wim); + if (argc == 1 && num_images != 1) { + imagex_error(T("\"%"TS"\" contains %d images; Please select one."), + wimfile, num_images); + usage(UPDATE); + ret = -1; + goto out_wimlib_free; + } + + /* Parse capture configuration file if specified */ if (config_file) { size_t config_len; @@ -2951,19 +3162,32 @@ imagex_update(int argc, tchar **argv) config = &default_capture_config; } - cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars); - if (!cmd_file_contents) { - ret = -1; - goto out_free_config; - } + /* Read update commands from standard input, or the command string if + * specified. */ + if (command_str) { + 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; + } - cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars, - &num_cmds); + /* 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: @@ -2978,14 +3202,23 @@ imagex_update(int argc, tchar **argv) } } +#ifdef __WIN32__ + 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_free_cmds; + goto out_release_privs; + /* Overwrite the updated WIM */ ret = wimlib_overwrite(wim, write_flags, num_threads, imagex_progress_func); -out_free_cmds: +out_release_privs: +#ifdef __WIN32__ + win32_release_capture_privileges(); +#endif free(cmds); out_free_cmd_file_contents: free(cmd_file_contents); @@ -2998,6 +3231,7 @@ out_free_config: out_wimlib_free: wimlib_free(wim); out: + free(command_str); return ret; out_usage: usage(UPDATE); @@ -3034,7 +3268,7 @@ static const struct imagex_command imagex_commands[] = { }; static void -version() +version(void) { static const tchar *s = T( @@ -3090,14 +3324,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++) @@ -3109,9 +3343,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