4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 # include "config.h" /* Need for PACKAGE_VERSION, etc. */
30 #include "wimlib_tchar.h"
50 # include "imagex-win32.h"
51 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
52 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
53 # define print_security_descriptor win32_print_security_descriptor
56 # include <langinfo.h>
57 # define OS_PREFERRED_PATH_SEPARATOR '/'
58 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
59 # define print_security_descriptor default_print_security_descriptor
60 static inline void set_fd_to_binary_mode(int fd)
65 /* Don't confuse the user by presenting the mounting commands on Windows when
66 * they will never work. However on UNIX-like systems we always present them,
67 * even if WITH_FUSE is not defined at this point, as to not tie the build of
68 * wimlib-imagex to a specific build of wimlib. */
70 # define WIM_MOUNTING_SUPPORTED 0
72 # define WIM_MOUNTING_SUPPORTED 1
75 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 is_any_path_separator(tchar c)
80 return c == T('/') || c == T('\\');
83 /* Like basename(), but handles both forward and backwards slashes. */
85 tbasename(tchar *path)
87 tchar *p = tstrchr(path, T('\0'));
92 if (!is_any_path_separator(*--p))
100 if (is_any_path_separator(*--p))
105 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
119 #if WIM_MOUNTING_SUPPORTED
125 #if WIM_MOUNTING_SUPPORTED
132 static void usage(int cmd, FILE *fp);
133 static void usage_all(FILE *fp);
134 static void recommend_man_page(int cmd, FILE *fp);
135 static const tchar *get_cmd_string(int cmd, bool nospace);
137 static int imagex_progress_func(enum wimlib_progress_msg msg,
138 const union wimlib_progress_info *info);
140 static bool imagex_be_quiet = false;
141 static FILE *imagex_info_file;
143 #define imagex_printf(format, ...) \
144 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
147 IMAGEX_ALLOW_OTHER_OPTION,
150 IMAGEX_CHUNK_SIZE_OPTION,
151 IMAGEX_COMMAND_OPTION,
152 IMAGEX_COMMIT_OPTION,
153 IMAGEX_COMPRESS_OPTION,
154 IMAGEX_COMPRESS_SLOW_OPTION,
155 IMAGEX_CONFIG_OPTION,
157 IMAGEX_DELTA_FROM_OPTION,
158 IMAGEX_DEREFERENCE_OPTION,
159 IMAGEX_DEST_DIR_OPTION,
160 IMAGEX_DETAILED_OPTION,
161 IMAGEX_EXTRACT_XML_OPTION,
164 IMAGEX_HARDLINK_OPTION,
165 IMAGEX_HEADER_OPTION,
166 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
168 IMAGEX_LOOKUP_TABLE_OPTION,
169 IMAGEX_METADATA_OPTION,
170 IMAGEX_NOCHECK_OPTION,
171 IMAGEX_NORPFIX_OPTION,
172 IMAGEX_NOT_PIPABLE_OPTION,
173 IMAGEX_NO_ACLS_OPTION,
174 IMAGEX_NO_ATTRIBUTES_OPTION,
175 IMAGEX_NO_WILDCARDS_OPTION,
176 IMAGEX_NULLGLOB_OPTION,
177 IMAGEX_ONE_FILE_ONLY_OPTION,
178 IMAGEX_PACK_CHUNK_SIZE_OPTION,
179 IMAGEX_PACK_STREAMS_OPTION,
181 IMAGEX_PIPABLE_OPTION,
182 IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION,
183 IMAGEX_REBUILD_OPTION,
184 IMAGEX_RECOMPRESS_OPTION,
185 IMAGEX_RECURSIVE_OPTION,
187 IMAGEX_RESUME_OPTION,
190 IMAGEX_SOURCE_LIST_OPTION,
191 IMAGEX_STAGING_DIR_OPTION,
192 IMAGEX_STREAMS_INTERFACE_OPTION,
193 IMAGEX_STRICT_ACLS_OPTION,
194 IMAGEX_SYMLINK_OPTION,
195 IMAGEX_THREADS_OPTION,
196 IMAGEX_TO_STDOUT_OPTION,
197 IMAGEX_UNIX_DATA_OPTION,
198 IMAGEX_UPDATE_OF_OPTION,
199 IMAGEX_VERBOSE_OPTION,
203 static const struct option apply_options[] = {
204 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
205 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
206 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
207 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
208 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
209 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
210 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
211 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
212 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
213 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
214 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
215 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
216 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
218 /* --resume is undocumented for now as it needs improvement. */
219 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
223 static const struct option capture_or_append_options[] = {
224 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
225 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
226 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
227 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
228 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
229 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
230 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
231 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
232 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
233 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
234 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
235 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
236 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
237 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
238 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
239 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
240 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
241 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
242 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
243 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
244 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
245 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
246 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
247 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
248 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
249 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
250 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
251 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
255 static const struct option delete_options[] = {
256 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
257 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
261 static const struct option dir_options[] = {
262 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
263 {T("detailed"), no_argument, NULL, IMAGEX_DETAILED_OPTION},
264 {T("one-file-only"), no_argument, NULL, IMAGEX_ONE_FILE_ONLY_OPTION},
268 static const struct option export_options[] = {
269 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
270 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
271 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
272 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
273 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
274 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
275 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
276 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
277 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
278 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
279 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
280 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
281 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
282 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
283 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
284 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
288 static const struct option extract_options[] = {
289 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
290 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
291 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
292 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
293 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
294 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
295 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
296 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
297 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
298 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
299 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
300 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_WILDCARDS_OPTION},
301 {T("nullglob"), no_argument, NULL, IMAGEX_NULLGLOB_OPTION},
302 {T("preserve-dir-structure"), no_argument, NULL, IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION},
306 static const struct option info_options[] = {
307 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
308 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
309 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
310 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
311 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
312 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
313 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
314 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
315 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
319 static const struct option join_options[] = {
320 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
324 static const struct option mount_options[] = {
325 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
326 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
327 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
328 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
329 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
330 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
331 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
335 static const struct option optimize_options[] = {
336 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
337 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
338 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
339 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
340 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
341 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
342 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
343 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
344 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
345 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
346 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
347 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
348 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
349 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
350 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
354 static const struct option split_options[] = {
355 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
359 static const struct option unmount_options[] = {
360 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
361 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
362 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
363 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
367 static const struct option update_options[] = {
368 /* Careful: some of the options here set the defaults for update
369 * commands, but the flags given to an actual update command (and not to
370 * `imagex update' itself are also handled in
371 * update_command_add_option(). */
372 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
373 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
374 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
375 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
377 /* Default delete options */
378 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
379 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
381 /* Global add option */
382 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
384 /* Default add options */
385 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
386 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
387 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
388 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
389 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
390 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
396 # define _format_attribute(type, format_str, args_start) \
397 __attribute__((format(type, format_str, args_start)))
399 # define _format_attribute(type, format_str, args_start)
402 /* Print formatted error message to stderr. */
403 static void _format_attribute(printf, 1, 2)
404 imagex_error(const tchar *format, ...)
407 va_start(va, format);
408 tfputs(T("ERROR: "), stderr);
409 tvfprintf(stderr, format, va);
410 tputc(T('\n'), stderr);
414 /* Print formatted error message to stderr. */
415 static void _format_attribute(printf, 1, 2)
416 imagex_error_with_errno(const tchar *format, ...)
418 int errno_save = errno;
420 va_start(va, format);
421 tfputs(T("ERROR: "), stderr);
422 tvfprintf(stderr, format, va);
423 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
428 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
430 if (image == WIMLIB_NO_IMAGE) {
431 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
432 " Please specify a 1-based image index or "
433 "image name. To list the images\n"
434 " contained in the WIM archive, run\n"
436 " %"TS" \"%"TS"\"\n"),
437 image_name, wim_name,
438 get_cmd_string(CMD_INFO, false), wim_name);
439 return WIMLIB_ERR_INVALID_IMAGE;
445 verify_image_is_single(int image)
447 if (image == WIMLIB_ALL_IMAGES) {
448 imagex_error(T("Cannot specify all images for this action!"));
449 return WIMLIB_ERR_INVALID_IMAGE;
455 verify_image_exists_and_is_single(int image, const tchar *image_name,
456 const tchar *wim_name)
459 ret = verify_image_exists(image, image_name, wim_name);
461 ret = verify_image_is_single(image);
465 /* Parse the argument to --compress */
467 get_compression_type(const tchar *optarg)
469 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
470 return WIMLIB_COMPRESSION_TYPE_LZX;
471 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
472 return WIMLIB_COMPRESSION_TYPE_XPRESS;
473 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
474 return WIMLIB_COMPRESSION_TYPE_LZMS;
475 else if (!tstrcasecmp(optarg, T("none")))
476 return WIMLIB_COMPRESSION_TYPE_NONE;
478 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
479 "\"maximum\", \"fast\", or \"none\"."), optarg);
480 return WIMLIB_COMPRESSION_TYPE_INVALID;
485 set_compress_slow(void)
487 static const struct wimlib_lzx_compressor_params lzx_slow_params = {
489 .size = sizeof(struct wimlib_lzx_compressor_params),
491 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
494 .use_len2_matches = 1,
495 .nice_match_length = 96,
496 .num_optim_passes = 4,
497 .max_search_depth = 100,
498 .max_matches_per_pos = 10,
499 .main_nostat_cost = 15,
500 .len_nostat_cost = 15,
501 .aligned_nostat_cost = 7,
506 static const struct wimlib_lzms_compressor_params lzms_slow_params = {
508 .size = sizeof(struct wimlib_lzms_compressor_params),
510 .min_match_length = 2,
511 .max_match_length = UINT32_MAX,
512 .nice_match_length = 96,
513 .max_search_depth = 100,
514 .max_matches_per_pos = 10,
515 .optim_array_length = 1024,
518 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
519 &lzx_slow_params.hdr);
521 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZMS,
522 &lzms_slow_params.hdr);
526 const tchar **strings;
527 unsigned num_strings;
528 unsigned num_alloc_strings;
531 #define STRING_SET_INITIALIZER \
532 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
534 #define STRING_SET(_strings) \
535 struct string_set _strings = STRING_SET_INITIALIZER
538 string_set_append(struct string_set *set, const tchar *glob)
540 unsigned num_alloc_strings = set->num_alloc_strings;
542 if (set->num_strings == num_alloc_strings) {
543 const tchar **new_strings;
545 num_alloc_strings += 4;
546 new_strings = realloc(set->strings,
547 sizeof(set->strings[0]) * num_alloc_strings);
549 imagex_error(T("Out of memory!"));
552 set->strings = new_strings;
553 set->num_alloc_strings = num_alloc_strings;
555 set->strings[set->num_strings++] = glob;
560 string_set_destroy(struct string_set *set)
566 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
568 return wimlib_reference_resource_files(wim, set->strings,
570 WIMLIB_REF_FLAG_GLOB_ENABLE,
572 imagex_progress_func);
576 do_resource_not_found_warning(const tchar *wimfile,
577 const struct wimlib_wim_info *info,
578 const struct string_set *refglobs)
580 if (info->total_parts > 1) {
581 if (refglobs->num_strings == 0) {
582 imagex_error(T("\"%"TS"\" is part of a split WIM. "
583 "Use --ref to specify the other parts."),
586 imagex_error(T("Perhaps the '--ref' argument did not "
587 "specify all other parts of the split "
591 imagex_error(T("If this is a delta WIM, use the --ref argument "
592 "to specify the WIM(s) on which it is based."));
596 /* Returns the size of a file given its name, or -1 if the file does not exist
597 * or its size cannot be determined. */
599 file_get_size(const tchar *filename)
602 if (tstat(filename, &st) == 0)
609 PARSE_STRING_SUCCESS = 0,
610 PARSE_STRING_FAILURE = 1,
611 PARSE_STRING_NONE = 2,
615 * Parses a string token from an array of characters.
617 * Tokens are either whitespace-delimited, or double or single-quoted.
619 * @line_p: Pointer to the pointer to the line of data. Will be updated
620 * to point past the string token iff the return value is
621 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
624 * @len_p: @len_p initially stores the length of the line of data, which may
625 * be 0, and it will be updated to the number of bytes remaining in
626 * the line iff the return value is PARSE_STRING_SUCCESS.
628 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
629 * parsed string token will be returned here.
631 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
632 * PARSE_STRING_FAILURE if the data was invalid due to a missing
633 * closing quote; or PARSE_STRING_NONE if the line ended before the
634 * beginning of a string token was found.
637 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
640 tchar *line = *line_p;
644 /* Skip leading whitespace */
647 return PARSE_STRING_NONE;
648 if (!istspace(*line) && *line != T('\0'))
654 if (quote_char == T('"') || quote_char == T('\'')) {
659 line = tmemchr(line, quote_char, len);
661 imagex_error(T("Missing closing quote: %"TS), fn - 1);
662 return PARSE_STRING_FAILURE;
665 /* Unquoted string. Go until whitespace. Line is terminated
666 * by '\0', so no need to check 'len'. */
670 } while (!istspace(*line) && *line != T('\0'));
677 return PARSE_STRING_SUCCESS;
680 /* Parses a line of data (not an empty line or comment) in the source list file
681 * format. (See the man page for 'wimlib-imagex capture' for details on this
682 * format and the meaning.)
684 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
685 * len == 0. The data in @line will be modified by this function call.
687 * @len: Length of the line of data.
689 * @source: On success, the capture source and target described by the line is
690 * written into this destination. Note that it will contain pointers
691 * to data in the @line array.
693 * Returns true if the line was valid; false otherwise. */
695 parse_source_list_line(tchar *line, size_t len,
696 struct wimlib_capture_source *source)
700 ret = parse_string(&line, &len, &source->fs_source_path);
701 if (ret != PARSE_STRING_SUCCESS)
703 ret = parse_string(&line, &len, &source->wim_target_path);
704 if (ret == PARSE_STRING_NONE)
705 source->wim_target_path = source->fs_source_path;
706 return ret != PARSE_STRING_FAILURE;
709 /* Returns %true if the given line of length @len > 0 is a comment or empty line
710 * in the source list file format. */
712 is_comment_line(const tchar *line, size_t len)
717 if (!istspace(*line) && *line != T('\0'))
727 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
730 tchar *contents = *contents_p;
731 size_t nchars = *nchars_p;
734 for (i = 0; i < nchars; i++)
735 if (contents[i] == T('\n'))
738 /* Handle last line not terminated by a newline */
739 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
740 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
742 imagex_error(T("Out of memory!"));
745 contents[nchars] = T('\n');
746 *contents_p = contents;
754 /* Parses a file in the source list format. (See the man page for
755 * 'wimlib-imagex capture' for details on this format and the meaning.)
757 * @source_list_contents: Contents of the source list file. Note that this
758 * buffer will be modified to save memory allocations,
759 * and cannot be freed until the returned array of
760 * wimlib_capture_source's has also been freed.
762 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
765 * @nsources_ret: On success, the length of the returned array is
768 * Returns: An array of `struct wimlib_capture_source's that can be passed to
769 * the wimlib_add_image_multisource() function to specify how a WIM image is to
771 static struct wimlib_capture_source *
772 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
773 size_t *nsources_ret)
777 struct wimlib_capture_source *sources;
780 nlines = text_file_count_lines(source_list_contents_p,
781 &source_list_nchars);
785 /* Always allocate at least 1 slot, just in case the implementation of
786 * calloc() returns NULL if 0 bytes are requested. */
787 sources = calloc(nlines ?: 1, sizeof(*sources));
789 imagex_error(T("out of memory"));
792 p = *source_list_contents_p;
794 for (i = 0; i < nlines; i++) {
795 /* XXX: Could use rawmemchr() here instead, but it may not be
796 * available on all platforms. */
797 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
798 size_t len = endp - p + 1;
800 if (!is_comment_line(p, len)) {
801 if (!parse_source_list_line(p, len, &sources[j++])) {
814 enum capture_config_section {
815 CAPTURE_CONFIG_NO_SECTION,
816 CAPTURE_CONFIG_EXCLUSION_SECTION,
817 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
818 CAPTURE_CONFIG_IGNORE_SECTION,
822 CAPTURE_CONFIG_INVALID_SECTION,
823 CAPTURE_CONFIG_CHANGED_SECTION,
824 CAPTURE_CONFIG_SAME_SECTION,
828 check_config_section(tchar *line, size_t len,
829 enum capture_config_section *cur_section)
831 while (istspace(*line))
835 return CAPTURE_CONFIG_SAME_SECTION;
838 tchar *endbrace = tstrrchr(line, T(']'));
840 return CAPTURE_CONFIG_SAME_SECTION;
842 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
843 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
844 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
845 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
846 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
847 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
848 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
849 "of capture config file\n"),
851 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
852 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
853 tfputs(T("WARNING: Ignoring [AlignmentList] section "
854 "of capture config file\n"),
857 imagex_error(T("Invalid capture config file section \"%"TS"\""),
859 return CAPTURE_CONFIG_INVALID_SECTION;
861 return CAPTURE_CONFIG_CHANGED_SECTION;
866 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
869 if (pat_list->num_pats == pat_list->num_allocated_pats) {
871 size_t num_allocated_pats = pat_list->num_pats + 8;
873 pats = realloc(pat_list->pats,
874 num_allocated_pats * sizeof(pat_list->pats[0]));
876 imagex_error(T("Out of memory!"));
879 pat_list->pats = pats;
880 pat_list->num_allocated_pats = num_allocated_pats;
882 pat_list->pats[pat_list->num_pats++] = pat;
887 parse_capture_config_line(tchar *line, size_t len,
888 enum capture_config_section *cur_section,
889 struct wimlib_capture_config *config)
894 ret = check_config_section(line, len, cur_section);
895 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
897 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
900 switch (*cur_section) {
901 case CAPTURE_CONFIG_NO_SECTION:
902 imagex_error(T("Line \"%"TS"\" is not in a section "
903 "(such as [ExclusionList]"), line);
905 case CAPTURE_CONFIG_EXCLUSION_SECTION:
906 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
908 return pattern_list_add_pattern(&config->exclusion_pats,
910 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
911 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
913 return pattern_list_add_pattern(&config->exclusion_exception_pats,
915 case CAPTURE_CONFIG_IGNORE_SECTION:
922 parse_capture_config(tchar **contents_p, size_t nchars,
923 struct wimlib_capture_config *config)
928 enum capture_config_section cur_section;
930 memset(config, 0, sizeof(*config));
932 nlines = text_file_count_lines(contents_p, &nchars);
936 cur_section = CAPTURE_CONFIG_NO_SECTION;
938 for (i = 0; i < nlines; i++) {
939 tchar *endp = tmemchr(p, T('\n'), nchars);
940 size_t len = endp - p + 1;
942 if (!is_comment_line(p, len))
943 if (!parse_capture_config_line(p, len, &cur_section, config))
951 /* Reads the contents of a file into memory. */
953 file_get_contents(const tchar *filename, size_t *len_ret)
960 if (tstat(filename, &stbuf) != 0) {
961 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
966 fp = tfopen(filename, T("rb"));
968 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
972 buf = malloc(len ? len : 1);
974 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
975 "contents of file \"%"TS"\""), len, filename);
978 if (fread(buf, 1, len, fp) != len) {
979 imagex_error_with_errno(T("Failed to read %zu bytes from the "
980 "file \"%"TS"\""), len, filename);
994 /* Read standard input until EOF and return the full contents in a malloc()ed
995 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
998 stdin_get_contents(size_t *len_ret)
1000 /* stdin can, of course, be a pipe or other non-seekable file, so the
1001 * total length of the data cannot be pre-determined */
1003 size_t newlen = 1024;
1007 char *p = realloc(buf, newlen);
1008 size_t bytes_read, bytes_to_read;
1010 imagex_error(T("out of memory while reading stdin"));
1014 bytes_to_read = newlen - pos;
1015 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
1017 if (bytes_read != bytes_to_read) {
1022 imagex_error_with_errno(T("error reading stdin"));
1036 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
1039 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
1041 *num_tchars_ret = num_bytes;
1043 #else /* !__WIN32__ */
1044 /* On Windows, translate the text to UTF-16LE */
1048 if (num_bytes >= 2 &&
1049 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
1050 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
1052 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
1053 * with something that looks like an ASCII character encoded as
1054 * a UTF-16LE code unit. Assume the file is encoded as
1055 * UTF-16LE. This is not a 100% reliable check. */
1056 num_wchars = num_bytes / 2;
1057 text_wstr = (wchar_t*)text;
1059 /* File does not look like UTF-16LE. Assume it is encoded in
1060 * the current Windows code page. I think these are always
1061 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
1062 * should work as expected. */
1063 text_wstr = win32_mbs_to_wcs(text,
1068 *num_tchars_ret = num_wchars;
1070 #endif /* __WIN32__ */
1074 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1079 contents = file_get_contents(filename, &num_bytes);
1082 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1086 stdin_get_text_contents(size_t *num_tchars_ret)
1091 contents = stdin_get_contents(&num_bytes);
1094 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1097 #define TO_PERCENT(numerator, denominator) \
1098 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1100 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1101 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1102 #define KIBIBYTE_MIN_NBYTES 10000ULL
1105 get_unit(uint64_t total_bytes, const tchar **name_ret)
1107 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1108 *name_ret = T("GiB");
1110 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1111 *name_ret = T("MiB");
1113 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1114 *name_ret = T("KiB");
1117 *name_ret = T("bytes");
1122 static struct wimlib_progress_info_scan last_scan_progress;
1125 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1127 uint64_t prev_count, cur_count;
1129 prev_count = last_scan_progress.num_nondirs_scanned +
1130 last_scan_progress.num_dirs_scanned;
1131 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1133 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1134 cur_count % 128 == 0)
1136 unsigned unit_shift;
1137 const tchar *unit_name;
1139 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1140 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1141 "%"PRIu64" directories) "),
1142 scan->num_bytes_scanned >> unit_shift,
1144 scan->num_nondirs_scanned,
1145 scan->num_dirs_scanned);
1146 last_scan_progress = *scan;
1150 /* Progress callback function passed to various wimlib functions. */
1152 imagex_progress_func(enum wimlib_progress_msg msg,
1153 const union wimlib_progress_info *info)
1155 unsigned percent_done;
1156 unsigned unit_shift;
1157 const tchar *unit_name;
1159 if (imagex_be_quiet)
1162 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1164 static bool first = true;
1166 imagex_printf(T("Writing %"TS"-compressed data "
1167 "using %u thread%"TS"\n"),
1168 wimlib_get_compression_type_string(
1169 info->write_streams.compression_type),
1170 info->write_streams.num_threads,
1171 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1175 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1176 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1177 info->write_streams.total_bytes);
1179 if (info->write_streams.total_parts <= 1) {
1180 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1181 "written (%u%% done)"),
1182 info->write_streams.completed_bytes >> unit_shift,
1184 info->write_streams.total_bytes >> unit_shift,
1188 imagex_printf(T("\rWriting resources from part %u of %u: "
1189 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1190 (info->write_streams.completed_parts ==
1191 info->write_streams.total_parts) ?
1192 info->write_streams.completed_parts :
1193 info->write_streams.completed_parts + 1,
1194 info->write_streams.total_parts,
1195 info->write_streams.completed_bytes >> unit_shift,
1197 info->write_streams.total_bytes >> unit_shift,
1201 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1202 imagex_printf(T("\n"));
1204 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1205 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1206 if (*info->scan.wim_target_path) {
1207 imagex_printf(T(" (loading as WIM path: "
1208 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1209 info->scan.wim_target_path);
1211 imagex_printf(T("\n"));
1213 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1215 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1216 switch (info->scan.status) {
1217 case WIMLIB_SCAN_DENTRY_OK:
1218 report_scan_progress(&info->scan, false);
1220 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1221 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1223 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1224 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1225 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1227 case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK:
1228 imagex_printf(T("\nWARNING: Ignoring absolute symbolic link "
1229 "with out-of-tree target:\n"
1230 " \"%"TS"\" => \"%"TS"\"\n"
1231 " (Use --norpfix to capture "
1232 "absolute symbolic links as-is)\n"),
1233 info->scan.cur_path, info->scan.symlink_target);
1237 case WIMLIB_PROGRESS_MSG_SCAN_END:
1238 report_scan_progress(&info->scan, true);
1239 imagex_printf(T("\n"));
1241 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1242 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1243 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1244 info->integrity.total_bytes);
1245 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1246 "of %"PRIu64" %"TS" (%u%%) done"),
1247 info->integrity.filename,
1248 info->integrity.completed_bytes >> unit_shift,
1250 info->integrity.total_bytes >> unit_shift,
1253 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1254 imagex_printf(T("\n"));
1256 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1257 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1258 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1259 info->integrity.total_bytes);
1260 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1261 "of %"PRIu64" %"TS" (%u%%) done"),
1262 info->integrity.completed_bytes >> unit_shift,
1264 info->integrity.total_bytes >> unit_shift,
1267 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1268 imagex_printf(T("\n"));
1270 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1271 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1272 "to %"TS" \"%"TS"\"\n"),
1273 info->extract.image,
1274 info->extract.image_name,
1275 info->extract.wimfile_name,
1276 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1277 T("NTFS volume") : T("directory")),
1278 info->extract.target);
1280 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1281 if (info->extract.extract_root_wim_source_path[0]) {
1282 imagex_printf(T("Extracting \"%"TS"\" from image %d "
1283 "(\"%"TS"\") in \"%"TS"\" to \"%"TS"\"\n"),
1284 info->extract.extract_root_wim_source_path,
1285 info->extract.image,
1286 info->extract.image_name,
1287 info->extract.wimfile_name,
1288 info->extract.target);
1291 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1292 percent_done = TO_PERCENT(info->extract.completed_bytes,
1293 info->extract.total_bytes);
1294 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1295 imagex_printf(T("\rExtracting files: "
1296 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1297 info->extract.completed_bytes >> unit_shift,
1299 info->extract.total_bytes >> unit_shift,
1302 if (info->extract.completed_bytes >= info->extract.total_bytes)
1303 imagex_printf(T("\n"));
1305 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1306 if (info->extract.total_parts != 1) {
1307 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1308 info->extract.part_number,
1309 info->extract.total_parts);
1312 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1313 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1314 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1316 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1317 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1318 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1319 info->extract.target);
1322 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1323 percent_done = TO_PERCENT(info->split.completed_bytes,
1324 info->split.total_bytes);
1325 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1326 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1327 "%"PRIu64" %"TS" (%u%%) written\n"),
1328 info->split.part_name,
1329 info->split.cur_part_number,
1330 info->split.total_parts,
1331 info->split.completed_bytes >> unit_shift,
1333 info->split.total_bytes >> unit_shift,
1337 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1338 if (info->split.completed_bytes == info->split.total_bytes) {
1339 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1340 info->split.cur_part_number,
1341 info->split.total_parts);
1344 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1345 switch (info->update.command->op) {
1346 case WIMLIB_UPDATE_OP_DELETE:
1347 imagex_printf(T("Deleted WIM path "
1348 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1349 info->update.command->delete_.wim_path);
1351 case WIMLIB_UPDATE_OP_RENAME:
1352 imagex_printf(T("Renamed WIM path "
1353 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1354 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1355 info->update.command->rename.wim_source_path,
1356 info->update.command->rename.wim_target_path);
1358 case WIMLIB_UPDATE_OP_ADD:
1366 fflush(imagex_info_file);
1371 parse_num_threads(const tchar *optarg)
1374 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1375 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1376 imagex_error(T("Number of threads must be a non-negative integer!"));
1383 static uint32_t parse_chunk_size(const tchar *optarg)
1386 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1387 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1388 imagex_error(T("Chunk size must be a non-negative integer!"));
1397 * Parse an option passed to an update command.
1399 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1402 * @option: Text string for the option (beginning with --)
1404 * @cmd: `struct wimlib_update_command' that is being constructed for
1407 * Returns true if the option was recognized; false if not.
1410 update_command_add_option(int op, const tchar *option,
1411 struct wimlib_update_command *cmd)
1413 bool recognized = true;
1415 case WIMLIB_UPDATE_OP_ADD:
1416 if (!tstrcmp(option, T("--verbose")))
1417 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1418 else if (!tstrcmp(option, T("--unix-data")))
1419 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1420 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1421 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1422 else if (!tstrcmp(option, T("--strict-acls")))
1423 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1424 else if (!tstrcmp(option, T("--dereference")))
1425 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1429 case WIMLIB_UPDATE_OP_DELETE:
1430 if (!tstrcmp(option, T("--force")))
1431 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1432 else if (!tstrcmp(option, T("--recursive")))
1433 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1444 /* How many nonoption arguments each `imagex update' command expects */
1445 static const unsigned update_command_num_nonoptions[] = {
1446 [WIMLIB_UPDATE_OP_ADD] = 2,
1447 [WIMLIB_UPDATE_OP_DELETE] = 1,
1448 [WIMLIB_UPDATE_OP_RENAME] = 2,
1452 update_command_add_nonoption(int op, const tchar *nonoption,
1453 struct wimlib_update_command *cmd,
1454 unsigned num_nonoptions)
1457 case WIMLIB_UPDATE_OP_ADD:
1458 if (num_nonoptions == 0)
1459 cmd->add.fs_source_path = (tchar*)nonoption;
1461 cmd->add.wim_target_path = (tchar*)nonoption;
1463 case WIMLIB_UPDATE_OP_DELETE:
1464 cmd->delete_.wim_path = (tchar*)nonoption;
1466 case WIMLIB_UPDATE_OP_RENAME:
1467 if (num_nonoptions == 0)
1468 cmd->rename.wim_source_path = (tchar*)nonoption;
1470 cmd->rename.wim_target_path = (tchar*)nonoption;
1476 * Parse a command passed on stdin to `imagex update'.
1478 * @line: Text of the command.
1479 * @len: Length of the line, including a null terminator
1482 * @command: A `struct wimlib_update_command' to fill in from the parsed
1485 * @line_number: Line number of the command, for diagnostics.
1487 * Returns true on success; returns false on parse error.
1490 parse_update_command(tchar *line, size_t len,
1491 struct wimlib_update_command *command,
1495 tchar *command_name;
1497 size_t num_nonoptions;
1499 /* Get the command name ("add", "delete", "rename") */
1500 ret = parse_string(&line, &len, &command_name);
1501 if (ret != PARSE_STRING_SUCCESS)
1504 if (!tstrcasecmp(command_name, T("add"))) {
1505 op = WIMLIB_UPDATE_OP_ADD;
1506 } else if (!tstrcasecmp(command_name, T("delete"))) {
1507 op = WIMLIB_UPDATE_OP_DELETE;
1508 } else if (!tstrcasecmp(command_name, T("rename"))) {
1509 op = WIMLIB_UPDATE_OP_RENAME;
1511 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1512 command_name, line_number);
1517 /* Parse additional options and non-options as needed */
1522 ret = parse_string(&line, &len, &next_string);
1523 if (ret == PARSE_STRING_NONE) /* End of line */
1525 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1527 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1529 if (!update_command_add_option(op, next_string, command))
1531 imagex_error(T("Unrecognized option \"%"TS"\" to "
1532 "update command \"%"TS"\" on line %zu"),
1533 next_string, command_name, line_number);
1539 if (num_nonoptions == update_command_num_nonoptions[op])
1541 imagex_error(T("Unexpected argument \"%"TS"\" in "
1542 "update command on line %zu\n"
1543 " (The \"%"TS"\" command only "
1544 "takes %zu nonoption arguments!)\n"),
1545 next_string, line_number,
1546 command_name, num_nonoptions);
1549 update_command_add_nonoption(op, next_string,
1550 command, num_nonoptions);
1555 if (num_nonoptions != update_command_num_nonoptions[op]) {
1556 imagex_error(T("Not enough arguments to update command "
1557 "\"%"TS"\" on line %zu"), command_name, line_number);
1563 static struct wimlib_update_command *
1564 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1565 size_t *num_cmds_ret)
1569 struct wimlib_update_command *cmds;
1572 nlines = text_file_count_lines(cmd_file_contents_p,
1577 /* Always allocate at least 1 slot, just in case the implementation of
1578 * calloc() returns NULL if 0 bytes are requested. */
1579 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1581 imagex_error(T("out of memory"));
1584 p = *cmd_file_contents_p;
1586 for (i = 0; i < nlines; i++) {
1587 /* XXX: Could use rawmemchr() here instead, but it may not be
1588 * available on all platforms. */
1589 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1590 size_t len = endp - p + 1;
1592 if (!is_comment_line(p, len)) {
1593 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1604 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1605 * one image from a WIM file to a NTFS volume. */
1607 imagex_apply(int argc, tchar **argv, int cmd)
1611 int image = WIMLIB_NO_IMAGE;
1613 struct wimlib_wim_info info;
1615 const tchar *wimfile;
1616 const tchar *target;
1617 const tchar *image_num_or_name = NULL;
1618 int extract_flags = 0;
1620 STRING_SET(refglobs);
1622 for_opt(c, apply_options) {
1624 case IMAGEX_CHECK_OPTION:
1625 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1627 case IMAGEX_HARDLINK_OPTION:
1628 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1630 case IMAGEX_SYMLINK_OPTION:
1631 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1633 case IMAGEX_VERBOSE_OPTION:
1634 /* No longer does anything. */
1636 case IMAGEX_REF_OPTION:
1637 ret = string_set_append(&refglobs, optarg);
1639 goto out_free_refglobs;
1641 case IMAGEX_UNIX_DATA_OPTION:
1642 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1644 case IMAGEX_NO_ACLS_OPTION:
1645 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1647 case IMAGEX_STRICT_ACLS_OPTION:
1648 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1650 case IMAGEX_NO_ATTRIBUTES_OPTION:
1651 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
1653 case IMAGEX_NORPFIX_OPTION:
1654 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1656 case IMAGEX_RPFIX_OPTION:
1657 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1659 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1660 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1661 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1663 case IMAGEX_RESUME_OPTION:
1664 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1672 if (argc != 2 && argc != 3)
1677 if (!tstrcmp(wimfile, T("-"))) {
1678 /* Attempt to apply pipable WIM from standard input. */
1680 image_num_or_name = NULL;
1683 image_num_or_name = argv[1];
1688 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1689 imagex_progress_func);
1691 goto out_free_refglobs;
1693 wimlib_get_wim_info(wim, &info);
1696 /* Image explicitly specified. */
1697 image_num_or_name = argv[1];
1698 image = wimlib_resolve_image(wim, image_num_or_name);
1699 ret = verify_image_exists(image, image_num_or_name, wimfile);
1701 goto out_wimlib_free;
1704 /* No image specified; default to image 1, but only if the WIM
1705 * contains exactly one image. */
1707 if (info.image_count != 1) {
1708 imagex_error(T("\"%"TS"\" contains %d images; "
1709 "Please select one (or all)."),
1710 wimfile, info.image_count);
1719 if (refglobs.num_strings) {
1721 imagex_error(T("Can't specify --ref when applying from stdin!"));
1723 goto out_wimlib_free;
1725 ret = wim_reference_globs(wim, &refglobs, open_flags);
1727 goto out_wimlib_free;
1732 /* Interpret a regular file or block device target as a NTFS
1736 if (tstat(target, &stbuf)) {
1737 if (errno != ENOENT) {
1738 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1741 goto out_wimlib_free;
1744 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1745 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1751 ret = wimlib_extract_image(wim, image, target, extract_flags,
1752 imagex_progress_func);
1754 set_fd_to_binary_mode(STDIN_FILENO);
1755 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1757 target, extract_flags,
1758 imagex_progress_func);
1761 imagex_printf(T("Done applying WIM image.\n"));
1762 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1764 do_resource_not_found_warning(wimfile, &info, &refglobs);
1766 imagex_error(T( "If you are applying an image "
1767 "from a split pipable WIM,\n"
1768 " make sure you have "
1769 "concatenated together all parts."));
1775 string_set_destroy(&refglobs);
1779 usage(CMD_APPLY, stderr);
1781 goto out_free_refglobs;
1784 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1785 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1786 * the desired image. 'wimlib-imagex append': add a new image to an existing
1789 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1792 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1793 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1794 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1795 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1796 int write_flags = 0;
1797 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1798 uint32_t chunk_size = UINT32_MAX;
1799 uint32_t pack_chunk_size = UINT32_MAX;
1800 const tchar *wimfile;
1804 const tchar *flags_element = NULL;
1807 STRING_SET(base_wimfiles);
1808 WIMStruct **base_wims;
1810 WIMStruct *template_wim;
1811 const tchar *template_wimfile = NULL;
1812 const tchar *template_image_name_or_num = NULL;
1813 int template_image = WIMLIB_NO_IMAGE;
1816 unsigned num_threads = 0;
1821 const tchar *config_file = NULL;
1823 struct wimlib_capture_config *config;
1825 bool source_list = false;
1826 size_t source_list_nchars = 0;
1827 tchar *source_list_contents;
1828 bool capture_sources_malloced;
1829 struct wimlib_capture_source *capture_sources;
1831 bool name_defaulted;
1832 bool compress_slow = false;
1834 for_opt(c, capture_or_append_options) {
1836 case IMAGEX_BOOT_OPTION:
1837 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1839 case IMAGEX_CHECK_OPTION:
1840 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1841 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1843 case IMAGEX_NOCHECK_OPTION:
1844 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1846 case IMAGEX_CONFIG_OPTION:
1847 config_file = optarg;
1848 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1850 case IMAGEX_COMPRESS_OPTION:
1851 compression_type = get_compression_type(optarg);
1852 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1855 case IMAGEX_COMPRESS_SLOW_OPTION:
1856 compress_slow = true;
1858 case IMAGEX_CHUNK_SIZE_OPTION:
1859 chunk_size = parse_chunk_size(optarg);
1860 if (chunk_size == UINT32_MAX)
1863 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
1864 pack_chunk_size = parse_chunk_size(optarg);
1865 if (pack_chunk_size == UINT32_MAX)
1868 case IMAGEX_PACK_STREAMS_OPTION:
1869 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1871 case IMAGEX_FLAGS_OPTION:
1872 flags_element = optarg;
1874 case IMAGEX_DEREFERENCE_OPTION:
1875 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1877 case IMAGEX_VERBOSE_OPTION:
1878 /* No longer does anything. */
1880 case IMAGEX_THREADS_OPTION:
1881 num_threads = parse_num_threads(optarg);
1882 if (num_threads == UINT_MAX)
1885 case IMAGEX_REBUILD_OPTION:
1886 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1888 case IMAGEX_UNIX_DATA_OPTION:
1889 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1891 case IMAGEX_SOURCE_LIST_OPTION:
1894 case IMAGEX_NO_ACLS_OPTION:
1895 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1897 case IMAGEX_STRICT_ACLS_OPTION:
1898 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1900 case IMAGEX_RPFIX_OPTION:
1901 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1903 case IMAGEX_NORPFIX_OPTION:
1904 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1906 case IMAGEX_PIPABLE_OPTION:
1907 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1909 case IMAGEX_NOT_PIPABLE_OPTION:
1910 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1912 case IMAGEX_UPDATE_OF_OPTION:
1913 if (template_image_name_or_num) {
1914 imagex_error(T("'--update-of' can only be "
1915 "specified one time!"));
1919 colon = tstrrchr(optarg, T(':'));
1922 template_wimfile = optarg;
1924 template_image_name_or_num = colon + 1;
1926 template_wimfile = NULL;
1927 template_image_name_or_num = optarg;
1931 case IMAGEX_DELTA_FROM_OPTION:
1932 if (cmd != CMD_CAPTURE) {
1933 imagex_error(T("'--delta-from' is only "
1934 "valid for capture!"));
1937 ret = string_set_append(&base_wimfiles, optarg);
1939 goto out_free_base_wimfiles;
1940 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1949 if (argc < 2 || argc > 4)
1955 /* Set default compression type and parameters. */
1958 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1959 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1961 if (!compress_slow) {
1962 struct wimlib_lzx_compressor_params params = {
1963 .hdr.size = sizeof(params),
1964 .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
1967 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1973 set_compress_slow();
1975 if (!tstrcmp(wimfile, T("-"))) {
1976 /* Writing captured WIM to standard output. */
1978 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1979 imagex_error("Can't write a non-pipable WIM to "
1980 "standard output! Specify --pipable\n"
1981 " if you want to create a pipable WIM "
1982 "(but read the docs first).");
1986 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1988 if (cmd == CMD_APPEND) {
1989 imagex_error(T("Using standard output for append does "
1990 "not make sense."));
1993 wim_fd = STDOUT_FILENO;
1995 imagex_info_file = stderr;
1996 set_fd_to_binary_mode(wim_fd);
1999 /* If template image was specified using --update-of=IMAGE rather
2000 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
2001 if (template_image_name_or_num && !template_wimfile) {
2002 if (base_wimfiles.num_strings == 1) {
2003 /* Capturing delta WIM based on single WIM: default to
2005 template_wimfile = base_wimfiles.strings[0];
2006 } else if (cmd == CMD_APPEND) {
2007 /* Appending to WIM: default to WIM being appended to.
2009 template_wimfile = wimfile;
2011 /* Capturing a normal (non-delta) WIM, so the WIM file
2012 * *must* be explicitly specified. */
2013 if (base_wimfiles.num_strings > 1) {
2014 imagex_error(T("For capture of delta WIM "
2015 "based on multiple existing "
2017 " '--update-of' must "
2018 "specify WIMFILE:IMAGE!"));
2020 imagex_error(T("For capture of non-delta WIM, "
2021 "'--update-of' must specify "
2030 name_defaulted = false;
2032 /* Set default name to SOURCE argument, omitting any directory
2033 * prefixes and trailing slashes. This requires making a copy
2034 * of @source. Leave some free characters at the end in case we
2035 * append a number to keep the name unique. */
2036 size_t source_name_len;
2038 source_name_len = tstrlen(source);
2039 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
2040 name = tbasename(tstrcpy(source_copy, source));
2041 name_defaulted = true;
2043 /* Image description defaults to NULL if not given. */
2050 /* Set up capture sources in source list mode */
2051 if (source[0] == T('-') && source[1] == T('\0')) {
2052 source_list_contents = stdin_get_text_contents(&source_list_nchars);
2054 source_list_contents = file_get_text_contents(source,
2055 &source_list_nchars);
2057 if (!source_list_contents)
2060 capture_sources = parse_source_list(&source_list_contents,
2063 if (!capture_sources) {
2065 goto out_free_source_list_contents;
2067 capture_sources_malloced = true;
2069 /* Set up capture source in non-source-list mode. */
2070 capture_sources = alloca(sizeof(struct wimlib_capture_source));
2071 capture_sources[0].fs_source_path = source;
2072 capture_sources[0].wim_target_path = NULL;
2073 capture_sources[0].reserved = 0;
2075 capture_sources_malloced = false;
2076 source_list_contents = NULL;
2080 /* Read and parse capture configuration file. */
2083 config_str = file_get_text_contents(config_file, &config_len);
2086 goto out_free_capture_sources;
2089 config = alloca(sizeof(*config));
2090 ret = parse_capture_config(&config_str, config_len, config);
2092 goto out_free_config;
2094 /* No capture configuration file specified; use default
2095 * configuration for capturing Windows operating systems. */
2097 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
2100 /* Open the existing WIM, or create a new one. */
2101 if (cmd == CMD_APPEND)
2102 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2103 imagex_progress_func);
2105 ret = wimlib_create_new_wim(compression_type, &wim);
2107 goto out_free_config;
2109 /* Set chunk size if non-default. */
2110 if (chunk_size != UINT32_MAX) {
2111 ret = wimlib_set_output_chunk_size(wim, chunk_size);
2115 if (pack_chunk_size != UINT32_MAX) {
2116 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
2122 /* Detect if source is regular file or block device and set NTFS volume
2127 if (tstat(source, &stbuf) == 0) {
2128 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2129 imagex_printf(T("Capturing WIM image from NTFS "
2130 "filesystem on \"%"TS"\"\n"), source);
2131 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
2134 if (errno != ENOENT) {
2135 imagex_error_with_errno(T("Failed to stat "
2136 "\"%"TS"\""), source);
2144 /* If the user did not specify an image name, and the basename of the
2145 * source already exists as an image name in the WIM file, append a
2146 * suffix to make it unique. */
2147 if (cmd == CMD_APPEND && name_defaulted) {
2148 unsigned long conflict_idx;
2149 tchar *name_end = tstrchr(name, T('\0'));
2150 for (conflict_idx = 1;
2151 wimlib_image_name_in_use(wim, name);
2154 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2158 /* If capturing a delta WIM, reference resources from the base WIMs
2159 * before adding the new image. */
2160 if (base_wimfiles.num_strings) {
2161 base_wims = calloc(base_wimfiles.num_strings,
2162 sizeof(base_wims[0]));
2163 if (base_wims == NULL) {
2164 imagex_error(T("Out of memory!"));
2169 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2170 ret = wimlib_open_wim(base_wimfiles.strings[i],
2171 open_flags, &base_wims[i],
2172 imagex_progress_func);
2174 goto out_free_base_wims;
2178 ret = wimlib_reference_resources(wim, base_wims,
2179 base_wimfiles.num_strings, 0);
2181 goto out_free_base_wims;
2183 if (base_wimfiles.num_strings == 1) {
2184 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2185 base_wimfiles.strings[0]);
2187 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2188 base_wimfiles.num_strings);
2195 /* If capturing or appending as an update of an existing (template) image,
2196 * open the WIM if needed and parse the image index. */
2197 if (template_image_name_or_num) {
2200 if (base_wimfiles.num_strings == 1 &&
2201 template_wimfile == base_wimfiles.strings[0]) {
2202 template_wim = base_wims[0];
2203 } else if (template_wimfile == wimfile) {
2206 ret = wimlib_open_wim(template_wimfile, open_flags,
2207 &template_wim, imagex_progress_func);
2209 goto out_free_base_wims;
2212 template_image = wimlib_resolve_image(template_wim,
2213 template_image_name_or_num);
2215 if (template_image_name_or_num[0] == T('-')) {
2218 struct wimlib_wim_info info;
2220 wimlib_get_wim_info(template_wim, &info);
2221 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2222 if (n >= 1 && n <= info.image_count &&
2224 tmp != template_image_name_or_num + 1)
2226 template_image = info.image_count - (n - 1);
2229 ret = verify_image_exists_and_is_single(template_image,
2230 template_image_name_or_num,
2233 goto out_free_template_wim;
2235 template_wim = NULL;
2238 ret = wimlib_add_image_multisource(wim,
2244 imagex_progress_func);
2246 goto out_free_template_wim;
2248 if (desc || flags_element || template_image_name_or_num) {
2249 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2250 * on which the added one is to be based has been specified with
2251 * --update-of. Get the index of the image we just
2252 * added, then use it to call the appropriate functions. */
2253 struct wimlib_wim_info info;
2255 wimlib_get_wim_info(wim, &info);
2258 ret = wimlib_set_image_descripton(wim,
2262 goto out_free_template_wim;
2265 if (flags_element) {
2266 ret = wimlib_set_image_flags(wim, info.image_count,
2269 goto out_free_template_wim;
2272 /* Reference template image if the user provided one. */
2273 if (template_image_name_or_num) {
2274 imagex_printf(T("Using image %d "
2275 "from \"%"TS"\" as template\n"),
2276 template_image, template_wimfile);
2277 ret = wimlib_reference_template_image(wim,
2283 goto out_free_template_wim;
2287 /* Write the new WIM or overwrite the existing WIM with the new image
2289 if (cmd == CMD_APPEND) {
2290 ret = wimlib_overwrite(wim, write_flags, num_threads,
2291 imagex_progress_func);
2292 } else if (wimfile) {
2293 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2294 write_flags, num_threads,
2295 imagex_progress_func);
2297 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2298 write_flags, num_threads,
2299 imagex_progress_func);
2301 out_free_template_wim:
2302 /* template_wim may alias base_wims[0] or wim. */
2303 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2304 template_wim != wim)
2305 wimlib_free(template_wim);
2307 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2308 wimlib_free(base_wims[i]);
2314 free(config->exclusion_pats.pats);
2315 free(config->exclusion_exception_pats.pats);
2318 out_free_capture_sources:
2319 if (capture_sources_malloced)
2320 free(capture_sources);
2321 out_free_source_list_contents:
2322 free(source_list_contents);
2323 out_free_base_wimfiles:
2324 string_set_destroy(&base_wimfiles);
2331 goto out_free_base_wimfiles;
2334 /* Remove image(s) from a WIM. */
2336 imagex_delete(int argc, tchar **argv, int cmd)
2339 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2340 int write_flags = 0;
2341 const tchar *wimfile;
2342 const tchar *image_num_or_name;
2347 for_opt(c, delete_options) {
2349 case IMAGEX_CHECK_OPTION:
2350 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2351 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2353 case IMAGEX_SOFT_OPTION:
2354 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2365 imagex_error(T("Must specify a WIM file"));
2367 imagex_error(T("Must specify an image"));
2371 image_num_or_name = argv[1];
2373 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2374 imagex_progress_func);
2378 image = wimlib_resolve_image(wim, image_num_or_name);
2380 ret = verify_image_exists(image, image_num_or_name, wimfile);
2382 goto out_wimlib_free;
2384 ret = wimlib_delete_image(wim, image);
2386 imagex_error(T("Failed to delete image from \"%"TS"\""),
2388 goto out_wimlib_free;
2391 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2393 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2394 "deleted"), wimfile);
2402 usage(CMD_DELETE, stderr);
2407 struct print_dentry_options {
2412 print_dentry_full_path(const struct wimlib_dir_entry *dentry)
2414 tprintf(T("%"TS"\n"), dentry->full_path);
2417 static const struct {
2420 } file_attr_flags[] = {
2421 {WIMLIB_FILE_ATTRIBUTE_READONLY, T("READONLY")},
2422 {WIMLIB_FILE_ATTRIBUTE_HIDDEN, T("HIDDEN")},
2423 {WIMLIB_FILE_ATTRIBUTE_SYSTEM, T("SYSTEM")},
2424 {WIMLIB_FILE_ATTRIBUTE_DIRECTORY, T("DIRECTORY")},
2425 {WIMLIB_FILE_ATTRIBUTE_ARCHIVE, T("ARCHIVE")},
2426 {WIMLIB_FILE_ATTRIBUTE_DEVICE, T("DEVICE")},
2427 {WIMLIB_FILE_ATTRIBUTE_NORMAL, T("NORMAL")},
2428 {WIMLIB_FILE_ATTRIBUTE_TEMPORARY, T("TEMPORARY")},
2429 {WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE, T("SPARSE_FILE")},
2430 {WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT, T("REPARSE_POINT")},
2431 {WIMLIB_FILE_ATTRIBUTE_COMPRESSED, T("COMPRESSED")},
2432 {WIMLIB_FILE_ATTRIBUTE_OFFLINE, T("OFFLINE")},
2433 {WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED, T("NOT_CONTENT_INDEXED")},
2434 {WIMLIB_FILE_ATTRIBUTE_ENCRYPTED, T("ENCRYPTED")},
2435 {WIMLIB_FILE_ATTRIBUTE_VIRTUAL, T("VIRTUAL")},
2438 #define TIMESTR_MAX 100
2441 timespec_to_string(const struct timespec *spec, tchar *buf)
2443 time_t t = spec->tv_sec;
2446 tstrftime(buf, TIMESTR_MAX, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
2447 buf[TIMESTR_MAX - 1] = '\0';
2451 print_time(const tchar *type, const struct timespec *spec)
2453 tchar timestr[TIMESTR_MAX];
2455 timespec_to_string(spec, timestr);
2457 tprintf(T("%-20"TS"= %"TS"\n"), type, timestr);
2460 static void print_byte_field(const uint8_t field[], size_t len)
2463 tprintf(T("%02hhx"), *field++);
2467 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2469 tputs(T("WIM Information:"));
2470 tputs(T("----------------"));
2471 tprintf(T("Path: %"TS"\n"), wimfile);
2472 tprintf(T("GUID: 0x"));
2473 print_byte_field(info->guid, sizeof(info->guid));
2475 tprintf(T("Version: %u\n"), info->wim_version);
2476 tprintf(T("Image Count: %d\n"), info->image_count);
2477 tprintf(T("Compression: %"TS"\n"),
2478 wimlib_get_compression_type_string(info->compression_type));
2479 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2481 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2482 tprintf(T("Boot Index: %d\n"), info->boot_index);
2483 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2484 tprintf(T("Integrity Info: %"TS"\n"),
2485 info->has_integrity_table ? T("yes") : T("no"));
2486 tprintf(T("Relative path junction: %"TS"\n"),
2487 info->has_rpfix ? T("yes") : T("no"));
2488 tprintf(T("Pipable: %"TS"\n"),
2489 info->pipable ? T("yes") : T("no"));
2494 print_resource(const struct wimlib_resource_entry *resource,
2497 tprintf(T("Hash = 0x"));
2498 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2501 if (!resource->is_missing) {
2502 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2503 resource->uncompressed_size);
2504 if (resource->packed) {
2505 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2506 resource->raw_resource_compressed_size);
2508 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2509 resource->raw_resource_offset_in_wim);
2511 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2514 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2515 resource->compressed_size);
2517 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2521 tprintf(T("Part Number = %u\n"), resource->part_number);
2522 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2524 tprintf(T("Flags = "));
2525 if (resource->is_compressed)
2526 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2527 if (resource->is_metadata)
2528 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2529 if (resource->is_free)
2530 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2531 if (resource->is_spanned)
2532 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2533 if (resource->packed)
2534 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2542 print_lookup_table(WIMStruct *wim)
2544 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2548 default_print_security_descriptor(const uint8_t *sd, size_t size)
2550 tprintf(T("Security Descriptor = "));
2551 print_byte_field(sd, size);
2556 print_dentry_detailed(const struct wimlib_dir_entry *dentry)
2560 "----------------------------------------------------------------------------\n"));
2561 tprintf(T("Full Path = \"%"TS"\"\n"), dentry->full_path);
2562 if (dentry->dos_name)
2563 tprintf(T("Short Name = \"%"TS"\"\n"), dentry->dos_name);
2564 tprintf(T("Attributes = 0x%08x\n"), dentry->attributes);
2565 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
2566 if (file_attr_flags[i].flag & dentry->attributes)
2567 tprintf(T(" FILE_ATTRIBUTE_%"TS" is set\n"),
2568 file_attr_flags[i].name);
2570 if (dentry->security_descriptor) {
2571 print_security_descriptor(dentry->security_descriptor,
2572 dentry->security_descriptor_size);
2575 print_time(T("Creation Time"), &dentry->creation_time);
2576 print_time(T("Last Write Time"), &dentry->last_write_time);
2577 print_time(T("Last Access Time"), &dentry->last_access_time);
2580 if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT)
2581 tprintf(T("Reparse Tag = 0x%"PRIx32"\n"), dentry->reparse_tag);
2583 tprintf(T("Link Group ID = 0x%016"PRIx64"\n"), dentry->hard_link_group_id);
2584 tprintf(T("Link Count = %"PRIu32"\n"), dentry->num_links);
2586 for (uint32_t i = 0; i <= dentry->num_named_streams; i++) {
2587 if (dentry->streams[i].stream_name) {
2588 tprintf(T("\tData stream \"%"TS"\":\n"),
2589 dentry->streams[i].stream_name);
2591 tprintf(T("\tUnnamed data stream:\n"));
2593 print_resource(&dentry->streams[i].resource, NULL);
2598 print_dentry(const struct wimlib_dir_entry *dentry, void *_options)
2600 const struct print_dentry_options *options = _options;
2601 if (!options->detailed)
2602 print_dentry_full_path(dentry);
2604 print_dentry_detailed(dentry);
2608 /* Print the files contained in an image(s) in a WIM file. */
2610 imagex_dir(int argc, tchar **argv, int cmd)
2612 const tchar *wimfile;
2613 WIMStruct *wim = NULL;
2616 const tchar *path = T("");
2618 struct print_dentry_options options = {
2621 int iterate_flags = WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2623 for_opt(c, dir_options) {
2625 case IMAGEX_PATH_OPTION:
2628 case IMAGEX_DETAILED_OPTION:
2629 options.detailed = true;
2631 case IMAGEX_ONE_FILE_ONLY_OPTION:
2632 iterate_flags &= ~WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2642 imagex_error(T("Must specify a WIM file"));
2646 imagex_error(T("Too many arguments"));
2651 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2656 image = wimlib_resolve_image(wim, argv[1]);
2657 ret = verify_image_exists(image, argv[1], wimfile);
2659 goto out_wimlib_free;
2661 /* No image specified; default to image 1, but only if the WIM
2662 * contains exactly one image. */
2664 struct wimlib_wim_info info;
2666 wimlib_get_wim_info(wim, &info);
2667 if (info.image_count != 1) {
2668 imagex_error(T("\"%"TS"\" contains %d images; Please "
2669 "select one (or all)."),
2670 wimfile, info.image_count);
2677 ret = wimlib_iterate_dir_tree(wim, image, path, iterate_flags,
2678 print_dentry, &options);
2685 usage(CMD_DIR, stderr);
2690 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2693 imagex_export(int argc, tchar **argv, int cmd)
2697 int export_flags = 0;
2698 int write_flags = 0;
2699 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2700 const tchar *src_wimfile;
2701 const tchar *src_image_num_or_name;
2702 const tchar *dest_wimfile;
2704 const tchar *dest_name;
2705 const tchar *dest_desc;
2707 struct wimlib_wim_info src_info;
2708 WIMStruct *dest_wim;
2713 STRING_SET(refglobs);
2714 unsigned num_threads = 0;
2715 uint32_t chunk_size = UINT32_MAX;
2716 uint32_t pack_chunk_size = UINT32_MAX;
2718 for_opt(c, export_options) {
2720 case IMAGEX_BOOT_OPTION:
2721 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2723 case IMAGEX_CHECK_OPTION:
2724 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2725 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2727 case IMAGEX_NOCHECK_OPTION:
2728 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2730 case IMAGEX_COMPRESS_OPTION:
2731 compression_type = get_compression_type(optarg);
2732 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2735 case IMAGEX_COMPRESS_SLOW_OPTION:
2736 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2737 set_compress_slow();
2739 case IMAGEX_PACK_STREAMS_OPTION:
2740 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2742 case IMAGEX_CHUNK_SIZE_OPTION:
2743 chunk_size = parse_chunk_size(optarg);
2744 if (chunk_size == UINT32_MAX)
2747 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
2748 pack_chunk_size = parse_chunk_size(optarg);
2749 if (pack_chunk_size == UINT32_MAX)
2752 case IMAGEX_REF_OPTION:
2753 ret = string_set_append(&refglobs, optarg);
2755 goto out_free_refglobs;
2757 case IMAGEX_THREADS_OPTION:
2758 num_threads = parse_num_threads(optarg);
2759 if (num_threads == UINT_MAX)
2762 case IMAGEX_REBUILD_OPTION:
2763 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2765 case IMAGEX_PIPABLE_OPTION:
2766 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2768 case IMAGEX_NOT_PIPABLE_OPTION:
2769 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2777 if (argc < 3 || argc > 5)
2779 src_wimfile = argv[0];
2780 src_image_num_or_name = argv[1];
2781 dest_wimfile = argv[2];
2782 dest_name = (argc >= 4) ? argv[3] : NULL;
2783 dest_desc = (argc >= 5) ? argv[4] : NULL;
2784 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2785 imagex_progress_func);
2787 goto out_free_refglobs;
2789 wimlib_get_wim_info(src_wim, &src_info);
2791 /* Determine if the destination is an existing file or not. If so, we
2792 * try to append the exported image(s) to it; otherwise, we create a new
2793 * WIM containing the exported image(s). Furthermore, determine if we
2794 * need to write a pipable WIM directly to standard output. */
2796 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2798 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2799 imagex_error("Can't write a non-pipable WIM to "
2800 "standard output! Specify --pipable\n"
2801 " if you want to create a pipable WIM "
2802 "(but read the docs first).");
2804 goto out_free_src_wim;
2807 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2809 dest_wimfile = NULL;
2810 dest_wim_fd = STDOUT_FILENO;
2811 imagex_info_file = stderr;
2812 set_fd_to_binary_mode(dest_wim_fd);
2815 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2817 /* Destination file exists. */
2819 if (!S_ISREG(stbuf.st_mode)) {
2820 imagex_error(T("\"%"TS"\" is not a regular file"),
2823 goto out_free_src_wim;
2825 ret = wimlib_open_wim(dest_wimfile,
2826 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2827 &dest_wim, imagex_progress_func);
2829 goto out_free_src_wim;
2831 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2832 /* The user specified a compression type, but we're
2833 * exporting to an existing WIM. Make sure the
2834 * specified compression type is the same as the
2835 * compression type of the existing destination WIM. */
2836 struct wimlib_wim_info dest_info;
2838 wimlib_get_wim_info(dest_wim, &dest_info);
2839 if (compression_type != dest_info.compression_type) {
2840 imagex_error(T("Cannot specify a compression type that is "
2841 "not the same as that used in the "
2842 "destination WIM"));
2844 goto out_free_dest_wim;
2850 if (errno != ENOENT) {
2851 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2854 goto out_free_src_wim;
2857 /* dest_wimfile is not an existing file, so create a new WIM. */
2859 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2860 /* The user did not specify a compression type; default
2861 * to that of the source WIM. */
2863 compression_type = src_info.compression_type;
2865 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2867 goto out_free_src_wim;
2869 /* Use same chunk size if compression type is the same. */
2870 if (compression_type == src_info.compression_type &&
2871 chunk_size == UINT32_MAX)
2872 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2875 if (chunk_size != UINT32_MAX) {
2876 /* Set destination chunk size. */
2877 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2879 goto out_free_dest_wim;
2881 if (pack_chunk_size != UINT32_MAX) {
2882 ret = wimlib_set_output_pack_chunk_size(dest_wim, pack_chunk_size);
2884 goto out_free_dest_wim;
2887 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2888 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2890 goto out_free_dest_wim;
2892 if (refglobs.num_strings) {
2893 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2895 goto out_free_dest_wim;
2898 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2899 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2901 imagex_error(T("--boot specified for all-images export, but source WIM "
2902 "has no bootable image."));
2904 goto out_free_dest_wim;
2907 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2908 dest_desc, export_flags, imagex_progress_func);
2910 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2911 do_resource_not_found_warning(src_wimfile,
2912 &src_info, &refglobs);
2914 goto out_free_dest_wim;
2918 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2919 imagex_progress_func);
2920 else if (dest_wimfile)
2921 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2922 write_flags, num_threads,
2923 imagex_progress_func);
2925 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2926 WIMLIB_ALL_IMAGES, write_flags,
2927 num_threads, imagex_progress_func);
2929 wimlib_free(dest_wim);
2931 wimlib_free(src_wim);
2933 string_set_destroy(&refglobs);
2937 usage(CMD_EXPORT, stderr);
2940 goto out_free_refglobs;
2943 /* Extract files or directories from a WIM image */
2945 imagex_extract(int argc, tchar **argv, int cmd)
2952 const tchar *wimfile;
2953 const tchar *image_num_or_name;
2954 tchar *dest_dir = T(".");
2955 int extract_flags = WIMLIB_EXTRACT_FLAG_NORPFIX |
2956 WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2957 WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2958 int notlist_extract_flags = WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2960 STRING_SET(refglobs);
2962 tchar *root_path = T("");
2964 for_opt(c, extract_options) {
2966 case IMAGEX_CHECK_OPTION:
2967 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2969 case IMAGEX_VERBOSE_OPTION:
2970 /* No longer does anything. */
2972 case IMAGEX_REF_OPTION:
2973 ret = string_set_append(&refglobs, optarg);
2975 goto out_free_refglobs;
2977 case IMAGEX_UNIX_DATA_OPTION:
2978 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2980 case IMAGEX_NO_ACLS_OPTION:
2981 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2983 case IMAGEX_STRICT_ACLS_OPTION:
2984 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2986 case IMAGEX_NO_ATTRIBUTES_OPTION:
2987 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
2989 case IMAGEX_DEST_DIR_OPTION:
2992 case IMAGEX_TO_STDOUT_OPTION:
2993 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2994 imagex_info_file = stderr;
2995 imagex_be_quiet = true;
2997 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2998 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2999 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
3001 case IMAGEX_NO_WILDCARDS_OPTION:
3002 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
3004 case IMAGEX_NULLGLOB_OPTION:
3005 extract_flags &= ~WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
3007 case IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION:
3008 notlist_extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
3020 if (!(extract_flags & (WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
3021 WIMLIB_EXTRACT_FLAG_STRICT_GLOB)))
3023 imagex_error(T("Can't combine --no-wildcards and --nullglob!"));
3028 image_num_or_name = argv[1];
3033 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3035 goto out_free_refglobs;
3037 image = wimlib_resolve_image(wim, image_num_or_name);
3038 ret = verify_image_exists_and_is_single(image,
3042 goto out_wimlib_free;
3044 if (refglobs.num_strings) {
3045 ret = wim_reference_globs(wim, &refglobs, open_flags);
3047 goto out_wimlib_free;
3053 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
3056 while (argc != 0 && ret == 0) {
3060 num_paths < argc && argv[num_paths][0] != T('@');
3065 ret = wimlib_extract_paths(wim, image, dest_dir,
3066 (const tchar **)argv,
3068 extract_flags | notlist_extract_flags,
3069 imagex_progress_func);
3073 ret = wimlib_extract_pathlist(wim, image, dest_dir,
3076 imagex_progress_func);
3083 if (!imagex_be_quiet)
3084 imagex_printf(T("Done extracting files.\n"));
3085 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
3086 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
3087 "files and directories\n"
3088 " are in the WIM image.\n"),
3089 get_cmd_string(CMD_DIR, false));
3090 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
3091 struct wimlib_wim_info info;
3093 wimlib_get_wim_info(wim, &info);
3094 do_resource_not_found_warning(wimfile, &info, &refglobs);
3099 string_set_destroy(&refglobs);
3103 usage(CMD_EXTRACT, stderr);
3106 goto out_free_refglobs;
3109 /* Prints information about a WIM file; also can mark an image as bootable,
3110 * change the name of an image, or change the description of an image. */
3112 imagex_info(int argc, tchar **argv, int cmd)
3117 bool nocheck = false;
3118 bool header = false;
3119 bool lookup_table = false;
3121 bool short_header = true;
3122 const tchar *xml_out_file = NULL;
3123 const tchar *wimfile;
3124 const tchar *image_num_or_name;
3125 const tchar *new_name;
3126 const tchar *new_desc;
3131 struct wimlib_wim_info info;
3133 for_opt(c, info_options) {
3135 case IMAGEX_BOOT_OPTION:
3138 case IMAGEX_CHECK_OPTION:
3141 case IMAGEX_NOCHECK_OPTION:
3144 case IMAGEX_HEADER_OPTION:
3146 short_header = false;
3148 case IMAGEX_LOOKUP_TABLE_OPTION:
3149 lookup_table = true;
3150 short_header = false;
3152 case IMAGEX_XML_OPTION:
3154 short_header = false;
3156 case IMAGEX_EXTRACT_XML_OPTION:
3157 xml_out_file = optarg;
3158 short_header = false;
3160 case IMAGEX_METADATA_OPTION:
3161 imagex_error(T("The --metadata option has been removed. "
3162 "Use 'wimdir --detail' instead."));
3171 if (argc < 1 || argc > 4)
3175 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
3176 new_name = (argc >= 3) ? argv[2] : NULL;
3177 new_desc = (argc >= 4) ? argv[3] : NULL;
3179 if (check && nocheck) {
3180 imagex_error(T("Can't specify both --check and --nocheck"));
3185 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3187 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3191 wimlib_get_wim_info(wim, &info);
3193 image = wimlib_resolve_image(wim, image_num_or_name);
3194 ret = WIMLIB_ERR_INVALID_IMAGE;
3195 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3196 verify_image_exists(image, image_num_or_name, wimfile);
3198 imagex_error(T("If you would like to set the boot "
3199 "index to 0, specify image \"0\" with "
3200 "the --boot flag."));
3202 goto out_wimlib_free;
3205 if (boot && info.image_count == 0) {
3206 imagex_error(T("--boot is meaningless on a WIM with no images"));
3207 goto out_wimlib_free;
3210 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3212 imagex_error(T("Cannot specify the --boot flag "
3213 "without specifying a specific "
3214 "image in a multi-image WIM"));
3215 goto out_wimlib_free;
3218 imagex_error(T("Cannot specify the NEW_NAME "
3219 "without specifying a specific "
3220 "image in a multi-image WIM"));
3221 goto out_wimlib_free;
3225 /* Operations that print information are separated from operations that
3226 * recreate the WIM file. */
3227 if (!new_name && !boot) {
3229 /* Read-only operations */
3231 if (image == WIMLIB_NO_IMAGE) {
3232 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3233 image_num_or_name, wimfile);
3234 goto out_wimlib_free;
3237 if (image == WIMLIB_ALL_IMAGES && short_header)
3238 print_wim_information(wimfile, &info);
3241 wimlib_print_header(wim);
3244 if (info.total_parts != 1) {
3245 tfprintf(stderr, T("Warning: Only showing the lookup table "
3246 "for part %d of a %d-part WIM.\n"),
3247 info.part_number, info.total_parts);
3249 print_lookup_table(wim);
3253 ret = wimlib_extract_xml_data(wim, stdout);
3255 goto out_wimlib_free;
3261 fp = tfopen(xml_out_file, T("wb"));
3263 imagex_error_with_errno(T("Failed to open the "
3264 "file \"%"TS"\" for "
3268 goto out_wimlib_free;
3270 ret = wimlib_extract_xml_data(wim, fp);
3272 imagex_error(T("Failed to close the file "
3278 goto out_wimlib_free;
3282 wimlib_print_available_images(wim, image);
3287 /* Modification operations */
3289 if (image == WIMLIB_ALL_IMAGES)
3292 if (image == WIMLIB_NO_IMAGE && new_name) {
3293 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3294 "when using image 0"), new_name);
3296 goto out_wimlib_free;
3300 if (image == info.boot_index) {
3301 imagex_printf(T("Image %d is already marked as "
3302 "bootable.\n"), image);
3305 imagex_printf(T("Marking image %d as bootable.\n"),
3307 info.boot_index = image;
3308 ret = wimlib_set_wim_info(wim, &info,
3309 WIMLIB_CHANGE_BOOT_INDEX);
3311 goto out_wimlib_free;
3315 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3317 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3321 imagex_printf(T("Changing the name of image %d to "
3322 "\"%"TS"\".\n"), image, new_name);
3323 ret = wimlib_set_image_name(wim, image, new_name);
3325 goto out_wimlib_free;
3329 const tchar *old_desc;
3330 old_desc = wimlib_get_image_description(wim, image);
3331 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3332 imagex_printf(T("The description of image %d is already "
3333 "\"%"TS"\".\n"), image, new_desc);
3336 imagex_printf(T("Changing the description of image %d "
3337 "to \"%"TS"\".\n"), image, new_desc);
3338 ret = wimlib_set_image_descripton(wim, image,
3341 goto out_wimlib_free;
3345 /* Only call wimlib_overwrite() if something actually needs to
3347 if (boot || new_name || new_desc ||
3348 (check && !info.has_integrity_table) ||
3349 (nocheck && info.has_integrity_table))
3351 int write_flags = 0;
3354 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3356 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3357 ret = wimlib_overwrite(wim, write_flags, 1,
3358 imagex_progress_func);
3360 imagex_printf(T("The file \"%"TS"\" was not modified "
3361 "because nothing needed to be done.\n"),
3372 usage(CMD_INFO, stderr);
3378 /* Join split WIMs into one part WIM */
3380 imagex_join(int argc, tchar **argv, int cmd)
3383 int swm_open_flags = 0;
3384 int wim_write_flags = 0;
3385 const tchar *output_path;
3388 for_opt(c, join_options) {
3390 case IMAGEX_CHECK_OPTION:
3391 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3392 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3402 imagex_error(T("Must specify one or more split WIM (.swm) "
3406 output_path = argv[0];
3407 ret = wimlib_join((const tchar * const *)++argv,
3412 imagex_progress_func);
3417 usage(CMD_JOIN, stderr);
3422 #if WIM_MOUNTING_SUPPORTED
3424 /* Mounts a WIM image. */
3426 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3429 int mount_flags = 0;
3431 const tchar *staging_dir = NULL;
3432 const tchar *wimfile;
3435 struct wimlib_wim_info info;
3439 STRING_SET(refglobs);
3441 if (cmd == CMD_MOUNTRW) {
3442 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3443 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3446 for_opt(c, mount_options) {
3448 case IMAGEX_ALLOW_OTHER_OPTION:
3449 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3451 case IMAGEX_CHECK_OPTION:
3452 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3454 case IMAGEX_DEBUG_OPTION:
3455 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3457 case IMAGEX_STREAMS_INTERFACE_OPTION:
3458 if (!tstrcasecmp(optarg, T("none")))
3459 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3460 else if (!tstrcasecmp(optarg, T("xattr")))
3461 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3462 else if (!tstrcasecmp(optarg, T("windows")))
3463 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3465 imagex_error(T("Unknown stream interface \"%"TS"\""),
3470 case IMAGEX_REF_OPTION:
3471 ret = string_set_append(&refglobs, optarg);
3473 goto out_free_refglobs;
3475 case IMAGEX_STAGING_DIR_OPTION:
3476 staging_dir = optarg;
3478 case IMAGEX_UNIX_DATA_OPTION:
3479 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3487 if (argc != 2 && argc != 3)
3492 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3494 goto out_free_refglobs;
3496 wimlib_get_wim_info(wim, &info);
3499 /* Image explicitly specified. */
3500 image = wimlib_resolve_image(wim, argv[1]);
3502 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3506 /* No image specified; default to image 1, but only if the WIM
3507 * contains exactly one image. */
3509 if (info.image_count != 1) {
3510 imagex_error(T("\"%"TS"\" contains %d images; Please "
3511 "select one."), wimfile, info.image_count);
3519 if (refglobs.num_strings) {
3520 ret = wim_reference_globs(wim, &refglobs, open_flags);
3525 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3527 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3529 image, wimfile, dir);
3534 string_set_destroy(&refglobs);
3540 goto out_free_refglobs;
3542 #endif /* WIM_MOUNTING_SUPPORTED */
3544 /* Rebuild a WIM file */
3546 imagex_optimize(int argc, tchar **argv, int cmd)
3549 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3550 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3551 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3552 uint32_t chunk_size = UINT32_MAX;
3553 uint32_t pack_chunk_size = UINT32_MAX;
3556 const tchar *wimfile;
3559 unsigned num_threads = 0;
3561 for_opt(c, optimize_options) {
3563 case IMAGEX_CHECK_OPTION:
3564 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3565 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3567 case IMAGEX_NOCHECK_OPTION:
3568 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3570 case IMAGEX_COMPRESS_OPTION:
3571 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3572 compression_type = get_compression_type(optarg);
3573 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3576 case IMAGEX_RECOMPRESS_OPTION:
3577 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3579 case IMAGEX_COMPRESS_SLOW_OPTION:
3580 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3581 set_compress_slow();
3583 case IMAGEX_CHUNK_SIZE_OPTION:
3584 chunk_size = parse_chunk_size(optarg);
3585 if (chunk_size == UINT32_MAX)
3588 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
3589 pack_chunk_size = parse_chunk_size(optarg);
3590 if (pack_chunk_size == UINT32_MAX)
3593 case IMAGEX_PACK_STREAMS_OPTION:
3594 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3595 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3597 case IMAGEX_THREADS_OPTION:
3598 num_threads = parse_num_threads(optarg);
3599 if (num_threads == UINT_MAX)
3602 case IMAGEX_PIPABLE_OPTION:
3603 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3605 case IMAGEX_NOT_PIPABLE_OPTION:
3606 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3620 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3624 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3625 /* Change compression type. */
3626 ret = wimlib_set_output_compression_type(wim, compression_type);
3628 goto out_wimlib_free;
3631 if (chunk_size != UINT32_MAX) {
3632 /* Change chunk size. */
3633 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3635 goto out_wimlib_free;
3637 if (pack_chunk_size != UINT32_MAX) {
3638 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
3640 goto out_wimlib_free;
3643 old_size = file_get_size(wimfile);
3644 tprintf(T("\"%"TS"\" original size: "), wimfile);
3646 tputs(T("Unknown"));
3648 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3650 ret = wimlib_overwrite(wim, write_flags, num_threads,
3651 imagex_progress_func);
3653 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3654 goto out_wimlib_free;
3657 new_size = file_get_size(wimfile);
3658 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3660 tputs(T("Unknown"));
3662 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3664 tfputs(T("Space saved: "), stdout);
3665 if (new_size != -1 && old_size != -1) {
3666 tprintf(T("%lld KiB\n"),
3667 ((long long)old_size - (long long)new_size) >> 10);
3669 tputs(T("Unknown"));
3678 usage(CMD_OPTIMIZE, stderr);
3684 /* Split a WIM into a spanned set */
3686 imagex_split(int argc, tchar **argv, int cmd)
3690 int write_flags = 0;
3691 unsigned long part_size;
3696 for_opt(c, split_options) {
3698 case IMAGEX_CHECK_OPTION:
3699 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3700 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3712 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3713 if (tmp == argv[2] || *tmp) {
3714 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3715 imagex_error(T("The part size must be an integer or "
3716 "floating-point number of megabytes."));
3719 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3723 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3729 usage(CMD_SPLIT, stderr);
3735 #if WIM_MOUNTING_SUPPORTED
3736 /* Unmounts a mounted WIM image. */
3738 imagex_unmount(int argc, tchar **argv, int cmd)
3741 int unmount_flags = 0;
3744 for_opt(c, unmount_options) {
3746 case IMAGEX_COMMIT_OPTION:
3747 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3749 case IMAGEX_CHECK_OPTION:
3750 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3752 case IMAGEX_REBUILD_OPTION:
3753 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3755 case IMAGEX_LAZY_OPTION:
3756 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3767 ret = wimlib_unmount_image(argv[0], unmount_flags,
3768 imagex_progress_func);
3770 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3775 usage(CMD_UNMOUNT, stderr);
3779 #endif /* WIM_MOUNTING_SUPPORTED */
3782 * Add, delete, or rename files in a WIM image.
3785 imagex_update(int argc, tchar **argv, int cmd)
3787 const tchar *wimfile;
3791 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3792 int write_flags = 0;
3793 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3794 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3795 WIMLIB_ADD_FLAG_VERBOSE;
3796 int default_delete_flags = 0;
3797 unsigned num_threads = 0;
3799 tchar *cmd_file_contents;
3800 size_t cmd_file_nchars;
3801 struct wimlib_update_command *cmds;
3803 tchar *command_str = NULL;
3805 const tchar *config_file = NULL;
3807 struct wimlib_capture_config *config;
3809 for_opt(c, update_options) {
3811 /* Generic or write options */
3812 case IMAGEX_THREADS_OPTION:
3813 num_threads = parse_num_threads(optarg);
3814 if (num_threads == UINT_MAX)
3817 case IMAGEX_CHECK_OPTION:
3818 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3819 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3821 case IMAGEX_REBUILD_OPTION:
3822 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3824 case IMAGEX_COMMAND_OPTION:
3826 imagex_error(T("--command may only be specified "
3827 "one time. Please provide\n"
3828 " the update commands "
3829 "on standard input instead."));
3832 command_str = tstrdup(optarg);
3834 imagex_error(T("Out of memory!"));
3838 /* Default delete options */
3839 case IMAGEX_FORCE_OPTION:
3840 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3842 case IMAGEX_RECURSIVE_OPTION:
3843 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3846 /* Global add option */
3847 case IMAGEX_CONFIG_OPTION:
3848 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3849 config_file = optarg;
3852 /* Default add options */
3853 case IMAGEX_VERBOSE_OPTION:
3854 /* No longer does anything. */
3856 case IMAGEX_DEREFERENCE_OPTION:
3857 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3859 case IMAGEX_UNIX_DATA_OPTION:
3860 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3862 case IMAGEX_NO_ACLS_OPTION:
3863 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3865 case IMAGEX_STRICT_ACLS_OPTION:
3866 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3875 if (argc != 1 && argc != 2)
3879 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3881 goto out_free_command_str;
3884 /* Image explicitly specified. */
3885 image = wimlib_resolve_image(wim, argv[1]);
3886 ret = verify_image_exists_and_is_single(image, argv[1],
3889 goto out_wimlib_free;
3891 /* No image specified; default to image 1, but only if the WIM
3892 * contains exactly one image. */
3893 struct wimlib_wim_info info;
3895 wimlib_get_wim_info(wim, &info);
3896 if (info.image_count != 1) {
3897 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3898 wimfile, info.image_count);
3905 /* Parse capture configuration file if specified */
3909 config_str = file_get_text_contents(config_file, &config_len);
3912 goto out_wimlib_free;
3915 config = alloca(sizeof(*config));
3916 ret = parse_capture_config(&config_str, config_len, config);
3918 goto out_free_config;
3921 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3924 /* Read update commands from standard input, or the command string if
3927 cmd_file_contents = NULL;
3928 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3931 if (isatty(STDIN_FILENO)) {
3932 tputs(T("Reading update commands from standard input..."));
3933 recommend_man_page(CMD_UPDATE, stdout);
3935 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3936 if (!cmd_file_contents) {
3938 goto out_free_config;
3941 /* Parse the update commands */
3942 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3947 goto out_free_cmd_file_contents;
3950 /* Set default flags and capture config on the update commands */
3951 for (size_t i = 0; i < num_cmds; i++) {
3952 switch (cmds[i].op) {
3953 case WIMLIB_UPDATE_OP_ADD:
3954 cmds[i].add.add_flags |= default_add_flags;
3955 cmds[i].add.config = config;
3957 case WIMLIB_UPDATE_OP_DELETE:
3958 cmds[i].delete_.delete_flags |= default_delete_flags;
3965 /* Execute the update commands */
3966 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3967 imagex_progress_func);
3971 /* Overwrite the updated WIM */
3972 ret = wimlib_overwrite(wim, write_flags, num_threads,
3973 imagex_progress_func);
3976 out_free_cmd_file_contents:
3977 free(cmd_file_contents);
3980 free(config->exclusion_pats.pats);
3981 free(config->exclusion_exception_pats.pats);
3986 out_free_command_str:
3991 usage(CMD_UPDATE, stderr);
3994 goto out_free_command_str;
3999 struct imagex_command {
4001 int (*func)(int argc, tchar **argv, int cmd);
4004 static const struct imagex_command imagex_commands[] = {
4005 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
4006 [CMD_APPLY] = {T("apply"), imagex_apply},
4007 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
4008 [CMD_DELETE] = {T("delete"), imagex_delete},
4009 [CMD_DIR ] = {T("dir"), imagex_dir},
4010 [CMD_EXPORT] = {T("export"), imagex_export},
4011 [CMD_EXTRACT] = {T("extract"), imagex_extract},
4012 [CMD_INFO] = {T("info"), imagex_info},
4013 [CMD_JOIN] = {T("join"), imagex_join},
4014 #if WIM_MOUNTING_SUPPORTED
4015 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
4016 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
4018 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
4019 [CMD_SPLIT] = {T("split"), imagex_split},
4020 #if WIM_MOUNTING_SUPPORTED
4021 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
4023 [CMD_UPDATE] = {T("update"), imagex_update},
4026 static const tchar *usage_strings[] = {
4029 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
4030 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
4031 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
4032 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
4033 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
4034 " [--update-of=[WIMFILE:]IMAGE]\n"
4038 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
4039 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
4040 " [--no-acls] [--strict-acls] [--no-attributes]\n"
4041 " [--rpfix] [--norpfix] [--hardlink] [--symlink]\n"
4042 " [--include-invalid-names]\n"
4046 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
4047 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
4048 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
4049 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
4050 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
4051 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
4052 " [--delta-from=WIMFILE]\n"
4056 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
4057 " [--check] [--soft]\n"
4061 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH] [--detailed]\n"
4065 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
4066 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
4067 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
4068 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
4072 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [(PATH | @LISTFILE)...]\n"
4073 " [--check] [--ref=\"GLOB\"] [--dest-dir=CMD_DIR]\n"
4074 " [--to-stdout] [--no-acls] [--strict-acls]\n"
4075 " [--no-attributes] [--include-invalid-names]\n"
4076 " [--no-wildcards] [--nullglob] [--preserve-dir-structure]\n"
4080 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
4081 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
4082 " [--extract-xml FILE] [--header] [--lookup-table]\n"
4086 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
4088 #if WIM_MOUNTING_SUPPORTED
4091 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4092 " [--check] [--streams-interface=INTERFACE]\n"
4093 " [--ref=\"GLOB\"] [--allow-other]\n"
4097 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4098 " [--check] [--streams-interface=INTERFACE]\n"
4099 " [--staging-dir=CMD_DIR] [--allow-other]\n"
4104 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
4105 " [--recompress-slow] [--compress=TYPE]\n"
4106 " [--threads=NUM_THREADS]\n"
4110 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
4112 #if WIM_MOUNTING_SUPPORTED
4115 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
4120 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
4121 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
4122 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
4126 static const tchar *invocation_name;
4127 static int invocation_cmd = CMD_NONE;
4129 static const tchar *get_cmd_string(int cmd, bool nospace)
4131 static tchar buf[50];
4132 if (cmd == CMD_NONE) {
4133 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
4134 } else if (invocation_cmd != CMD_NONE) {
4135 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
4137 const tchar *format;
4140 format = T("%"TS"-%"TS"");
4142 format = T("%"TS" %"TS"");
4143 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
4151 static const tchar *s =
4153 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
4154 "Copyright (C) 2012, 2013 Eric Biggers\n"
4155 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
4156 "This is free software: you are free to change and redistribute it.\n"
4157 "There is NO WARRANTY, to the extent permitted by law.\n"
4159 "Report bugs to "PACKAGE_BUGREPORT".\n"
4166 help_or_version(int argc, tchar **argv, int cmd)
4171 for (i = 1; i < argc; i++) {
4173 if (p[0] == T('-') && p[1] == T('-')) {
4175 if (!tstrcmp(p, T("help"))) {
4176 if (cmd == CMD_NONE)
4181 } else if (!tstrcmp(p, T("version"))) {
4190 print_usage_string(int cmd, FILE *fp)
4192 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4196 recommend_man_page(int cmd, FILE *fp)
4198 const tchar *format_str;
4200 format_str = T("Uncommon options are not listed;\n"
4201 "See %"TS".pdf in the doc directory for more details.\n");
4203 format_str = T("Uncommon options are not listed;\n"
4204 "Try `man %"TS"' for more details.\n");
4206 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4210 usage(int cmd, FILE *fp)
4212 tfprintf(fp, T("Usage:\n"));
4213 print_usage_string(cmd, fp);
4214 tfprintf(fp, T("\n"));
4215 recommend_man_page(cmd, fp);
4221 tfprintf(fp, T("Usage:\n"));
4222 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4223 print_usage_string(cmd, fp);
4224 tfprintf(fp, T("\n"));
4226 static const tchar *extra =
4229 " %"TS" --version\n"
4231 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4234 tfprintf(fp, extra, invocation_name, invocation_name);
4235 recommend_man_page(CMD_NONE, fp);
4238 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4239 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4240 * something else), while an Windows the command arguments will be UTF-16LE
4241 * encoded 'wchar_t' strings. */
4244 wmain(int argc, wchar_t **argv, wchar_t **envp)
4246 main(int argc, char **argv)
4253 imagex_info_file = stdout;
4254 invocation_name = tbasename(argv[0]);
4257 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4258 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4262 setlocale(LC_ALL, "");
4263 codeset = nl_langinfo(CODESET);
4264 if (!strstr(codeset, "UTF-8") &&
4265 !strstr(codeset, "UTF8") &&
4266 !strstr(codeset, "utf-8") &&
4267 !strstr(codeset, "utf8"))
4270 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4271 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4272 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4273 " to any value to force wimlib to use UTF-8.\n",
4279 #endif /* !__WIN32__ */
4282 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4283 if (igcase != NULL) {
4284 if (!tstrcmp(igcase, T("no")) ||
4285 !tstrcmp(igcase, T("0")))
4286 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4287 else if (!tstrcmp(igcase, T("yes")) ||
4288 !tstrcmp(igcase, T("1")))
4289 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4292 "WARNING: Ignoring unknown setting of "
4293 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4298 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4300 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4301 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4302 for (int i = 0; i < CMD_MAX; i++) {
4303 if (!tstrcmp(invocation_name + 3,
4304 imagex_commands[i].name))
4313 /* Unless already known from the invocation name, determine which
4314 * command was specified. */
4315 if (cmd == CMD_NONE) {
4317 imagex_error(T("No command specified!\n"));
4321 for (int i = 0; i < CMD_MAX; i++) {
4322 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4327 if (cmd != CMD_NONE) {
4333 /* Handle --help and --version. --help can be either for the program as
4334 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4335 * CMD_NONE). Note: help_or_version() will not return if a --help or
4336 * --version argument was found. */
4337 help_or_version(argc, argv, cmd);
4339 /* Bail if a valid command was not specified. */
4340 if (cmd == CMD_NONE) {
4341 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4346 /* Enable warning and error messages in wimlib be more user-friendly.
4348 wimlib_set_print_errors(true);
4350 /* Initialize wimlib. */
4351 ret = wimlib_global_init(init_flags);
4353 goto out_check_status;
4355 /* Call the command handler function. */
4356 ret = imagex_commands[cmd].func(argc, argv, cmd);
4358 /* Check for error writing to standard output, especially since for some
4359 * commands, writing to standard output is part of the program's actual
4360 * behavior and not just for informational purposes. */
4361 if (ferror(stdout) || fclose(stdout)) {
4362 imagex_error_with_errno(T("error writing to standard output"));
4367 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4368 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4369 * error code from which an error message can be printed. */
4371 imagex_error(T("Exiting with error code %d:\n"
4373 wimlib_get_error_string(ret));
4374 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4375 imagex_error_with_errno(T("errno"));
4377 /* Make wimlib free any resources it's holding (although this is not
4378 * strictly necessary because the process is ending anyway). */
4379 wimlib_global_cleanup();