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 tbasename win32_wbasename
52 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
53 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
57 # include <langinfo.h>
58 # define tbasename basename
59 # define OS_PREFERRED_PATH_SEPARATOR '/'
60 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
61 static inline void set_fd_to_binary_mode(int fd)
66 /* Don't confuse the user by presenting the mounting commands on Windows when
67 * they will never work. However on UNIX-like systems we always present them,
68 * even if WITH_FUSE is not defined at this point, as to not tie the build of
69 * wimlib-imagex to a specific build of wimlib. */
71 # define WIM_MOUNTING_SUPPORTED 0
73 # define WIM_MOUNTING_SUPPORTED 1
76 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
92 #if WIM_MOUNTING_SUPPORTED
98 #if WIM_MOUNTING_SUPPORTED
105 static void usage(int cmd, FILE *fp);
106 static void usage_all(FILE *fp);
107 static void recommend_man_page(int cmd, FILE *fp);
108 static const tchar *get_cmd_string(int cmd, bool nospace);
110 static int imagex_progress_func(enum wimlib_progress_msg msg,
111 const union wimlib_progress_info *info);
113 static bool imagex_be_quiet = false;
114 static FILE *imagex_info_file;
116 #define imagex_printf(format, ...) \
117 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
120 IMAGEX_ALLOW_OTHER_OPTION,
123 IMAGEX_CHUNK_SIZE_OPTION,
124 IMAGEX_COMMAND_OPTION,
125 IMAGEX_COMMIT_OPTION,
126 IMAGEX_COMPRESS_OPTION,
127 IMAGEX_COMPRESS_SLOW_OPTION,
128 IMAGEX_CONFIG_OPTION,
130 IMAGEX_DELTA_FROM_OPTION,
131 IMAGEX_DEREFERENCE_OPTION,
132 IMAGEX_DEST_DIR_OPTION,
133 IMAGEX_EXTRACT_XML_OPTION,
136 IMAGEX_HARDLINK_OPTION,
137 IMAGEX_HEADER_OPTION,
138 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
140 IMAGEX_LOOKUP_TABLE_OPTION,
141 IMAGEX_METADATA_OPTION,
142 IMAGEX_NORPFIX_OPTION,
143 IMAGEX_NOCHECK_OPTION,
144 IMAGEX_NO_ACLS_OPTION,
145 IMAGEX_NO_PACK_STREAMS_OPTION,
146 IMAGEX_NOT_PIPABLE_OPTION,
147 IMAGEX_PACK_STREAMS_OPTION,
149 IMAGEX_PIPABLE_OPTION,
150 IMAGEX_REBUILD_OPTION,
151 IMAGEX_RECOMPRESS_OPTION,
152 IMAGEX_RECURSIVE_OPTION,
154 IMAGEX_RESUME_OPTION,
157 IMAGEX_SOURCE_LIST_OPTION,
158 IMAGEX_STAGING_DIR_OPTION,
159 IMAGEX_STREAMS_INTERFACE_OPTION,
160 IMAGEX_STRICT_ACLS_OPTION,
161 IMAGEX_SYMLINK_OPTION,
162 IMAGEX_THREADS_OPTION,
163 IMAGEX_TO_STDOUT_OPTION,
164 IMAGEX_UNIX_DATA_OPTION,
165 IMAGEX_UPDATE_OF_OPTION,
166 IMAGEX_VERBOSE_OPTION,
170 static const struct option apply_options[] = {
171 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
172 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
173 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
174 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
175 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
176 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
177 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
178 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
179 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
180 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
181 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
182 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
184 /* --resume is undocumented for now as it needs improvement. */
185 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
189 static const struct option capture_or_append_options[] = {
190 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
191 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
192 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
193 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
194 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
195 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
196 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
197 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
198 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
199 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
200 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
201 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
202 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
203 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
204 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
205 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
206 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
207 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
208 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
209 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
210 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
211 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
212 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
213 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
214 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
218 static const struct option delete_options[] = {
219 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
220 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
224 static const struct option dir_options[] = {
225 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
229 static const struct option export_options[] = {
230 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
231 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
232 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
233 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
234 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
235 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
236 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
237 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
238 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
239 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
243 static const struct option extract_options[] = {
244 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
245 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
246 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
247 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
248 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
249 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
250 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
251 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
252 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
253 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
257 static const struct option info_options[] = {
258 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
259 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
260 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
261 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
262 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
263 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
264 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
265 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
266 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
270 static const struct option join_options[] = {
271 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
275 static const struct option mount_options[] = {
276 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
277 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
278 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
279 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
280 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
281 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
282 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
286 static const struct option optimize_options[] = {
287 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
288 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
289 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
290 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
291 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
292 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
293 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
294 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
295 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
296 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
297 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
298 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
302 static const struct option split_options[] = {
303 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
307 static const struct option unmount_options[] = {
308 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
309 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
310 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
311 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
315 static const struct option update_options[] = {
316 /* Careful: some of the options here set the defaults for update
317 * commands, but the flags given to an actual update command (and not to
318 * `imagex update' itself are also handled in
319 * update_command_add_option(). */
320 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
321 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
322 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
323 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
325 /* Default delete options */
326 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
327 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
329 /* Global add option */
330 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
332 /* Default add options */
333 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
334 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
335 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
336 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
337 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
338 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
344 # define _format_attribute(type, format_str, args_start) \
345 __attribute__((format(type, format_str, args_start)))
347 # define _format_attribute(type, format_str, args_start)
350 /* Print formatted error message to stderr. */
351 static void _format_attribute(printf, 1, 2)
352 imagex_error(const tchar *format, ...)
355 va_start(va, format);
356 tfputs(T("ERROR: "), stderr);
357 tvfprintf(stderr, format, va);
358 tputc(T('\n'), stderr);
362 /* Print formatted error message to stderr. */
363 static void _format_attribute(printf, 1, 2)
364 imagex_error_with_errno(const tchar *format, ...)
366 int errno_save = errno;
368 va_start(va, format);
369 tfputs(T("ERROR: "), stderr);
370 tvfprintf(stderr, format, va);
371 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
376 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
378 if (image == WIMLIB_NO_IMAGE) {
379 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
380 " Please specify a 1-based image index or "
381 "image name. To list the images\n"
382 " contained in the WIM archive, run\n"
384 " %"TS" \"%"TS"\"\n"),
385 image_name, wim_name,
386 get_cmd_string(CMD_INFO, false), wim_name);
387 return WIMLIB_ERR_INVALID_IMAGE;
393 verify_image_is_single(int image)
395 if (image == WIMLIB_ALL_IMAGES) {
396 imagex_error(T("Cannot specify all images for this action!"));
397 return WIMLIB_ERR_INVALID_IMAGE;
403 verify_image_exists_and_is_single(int image, const tchar *image_name,
404 const tchar *wim_name)
407 ret = verify_image_exists(image, image_name, wim_name);
409 ret = verify_image_is_single(image);
413 /* Parse the argument to --compress */
415 get_compression_type(const tchar *optarg)
417 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
418 return WIMLIB_COMPRESSION_TYPE_LZX;
419 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
420 return WIMLIB_COMPRESSION_TYPE_XPRESS;
421 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
422 return WIMLIB_COMPRESSION_TYPE_LZMS;
423 else if (!tstrcasecmp(optarg, T("none")))
424 return WIMLIB_COMPRESSION_TYPE_NONE;
426 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
427 "\"maximum\", \"fast\", or \"none\"."), optarg);
428 return WIMLIB_COMPRESSION_TYPE_INVALID;
433 set_compress_slow(void)
436 static const struct wimlib_lzx_params slow_params = {
437 .size_of_this = sizeof(struct wimlib_lzx_params),
438 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
441 .use_len2_matches = 1,
442 .num_fast_bytes = 96,
443 .num_optim_passes = 4,
444 .max_search_depth = 100,
445 .max_matches_per_pos = 10,
446 .main_nostat_cost = 15,
447 .len_nostat_cost = 15,
448 .aligned_nostat_cost = 7,
452 ret = wimlib_lzx_set_default_params(&slow_params);
454 imagex_error(T("Couldn't set slow compression parameters.!"));
459 const tchar **strings;
460 unsigned num_strings;
461 unsigned num_alloc_strings;
464 #define STRING_SET_INITIALIZER \
465 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
467 #define STRING_SET(_strings) \
468 struct string_set _strings = STRING_SET_INITIALIZER
471 string_set_append(struct string_set *set, const tchar *glob)
473 unsigned num_alloc_strings = set->num_alloc_strings;
475 if (set->num_strings == num_alloc_strings) {
476 const tchar **new_strings;
478 num_alloc_strings += 4;
479 new_strings = realloc(set->strings,
480 sizeof(set->strings[0]) * num_alloc_strings);
482 imagex_error(T("Out of memory!"));
485 set->strings = new_strings;
486 set->num_alloc_strings = num_alloc_strings;
488 set->strings[set->num_strings++] = glob;
493 string_set_destroy(struct string_set *set)
499 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
501 return wimlib_reference_resource_files(wim, set->strings,
503 WIMLIB_REF_FLAG_GLOB_ENABLE,
505 imagex_progress_func);
509 do_resource_not_found_warning(const tchar *wimfile,
510 const struct wimlib_wim_info *info,
511 const struct string_set *refglobs)
513 if (info->total_parts > 1) {
514 if (refglobs->num_strings == 0) {
515 imagex_error(T("\"%"TS"\" is part of a split WIM. "
516 "Use --ref to specify the other parts."),
519 imagex_error(T("Perhaps the '--ref' argument did not "
520 "specify all other parts of the split "
524 imagex_error(T("If this is a delta WIM, use the --ref argument "
525 "to specify the WIM(s) on which it is based."));
529 /* Returns the size of a file given its name, or -1 if the file does not exist
530 * or its size cannot be determined. */
532 file_get_size(const tchar *filename)
535 if (tstat(filename, &st) == 0)
542 PARSE_STRING_SUCCESS = 0,
543 PARSE_STRING_FAILURE = 1,
544 PARSE_STRING_NONE = 2,
548 * Parses a string token from an array of characters.
550 * Tokens are either whitespace-delimited, or double or single-quoted.
552 * @line_p: Pointer to the pointer to the line of data. Will be updated
553 * to point past the string token iff the return value is
554 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
557 * @len_p: @len_p initially stores the length of the line of data, which may
558 * be 0, and it will be updated to the number of bytes remaining in
559 * the line iff the return value is PARSE_STRING_SUCCESS.
561 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
562 * parsed string token will be returned here.
564 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
565 * PARSE_STRING_FAILURE if the data was invalid due to a missing
566 * closing quote; or PARSE_STRING_NONE if the line ended before the
567 * beginning of a string token was found.
570 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
573 tchar *line = *line_p;
577 /* Skip leading whitespace */
580 return PARSE_STRING_NONE;
581 if (!istspace(*line) && *line != T('\0'))
587 if (quote_char == T('"') || quote_char == T('\'')) {
592 line = tmemchr(line, quote_char, len);
594 imagex_error(T("Missing closing quote: %"TS), fn - 1);
595 return PARSE_STRING_FAILURE;
598 /* Unquoted string. Go until whitespace. Line is terminated
599 * by '\0', so no need to check 'len'. */
603 } while (!istspace(*line) && *line != T('\0'));
610 return PARSE_STRING_SUCCESS;
613 /* Parses a line of data (not an empty line or comment) in the source list file
614 * format. (See the man page for 'wimlib-imagex capture' for details on this
615 * format and the meaning.)
617 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
618 * len == 0. The data in @line will be modified by this function call.
620 * @len: Length of the line of data.
622 * @source: On success, the capture source and target described by the line is
623 * written into this destination. Note that it will contain pointers
624 * to data in the @line array.
626 * Returns true if the line was valid; false otherwise. */
628 parse_source_list_line(tchar *line, size_t len,
629 struct wimlib_capture_source *source)
633 ret = parse_string(&line, &len, &source->fs_source_path);
634 if (ret != PARSE_STRING_SUCCESS)
636 ret = parse_string(&line, &len, &source->wim_target_path);
637 if (ret == PARSE_STRING_NONE)
638 source->wim_target_path = source->fs_source_path;
639 return ret != PARSE_STRING_FAILURE;
642 /* Returns %true if the given line of length @len > 0 is a comment or empty line
643 * in the source list file format. */
645 is_comment_line(const tchar *line, size_t len)
650 if (!istspace(*line) && *line != T('\0'))
660 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
663 tchar *contents = *contents_p;
664 size_t nchars = *nchars_p;
667 for (i = 0; i < nchars; i++)
668 if (contents[i] == T('\n'))
671 /* Handle last line not terminated by a newline */
672 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
673 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
675 imagex_error(T("Out of memory!"));
678 contents[nchars] = T('\n');
679 *contents_p = contents;
687 /* Parses a file in the source list format. (See the man page for
688 * 'wimlib-imagex capture' for details on this format and the meaning.)
690 * @source_list_contents: Contents of the source list file. Note that this
691 * buffer will be modified to save memory allocations,
692 * and cannot be freed until the returned array of
693 * wimlib_capture_source's has also been freed.
695 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
698 * @nsources_ret: On success, the length of the returned array is
701 * Returns: An array of `struct wimlib_capture_source's that can be passed to
702 * the wimlib_add_image_multisource() function to specify how a WIM image is to
704 static struct wimlib_capture_source *
705 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
706 size_t *nsources_ret)
710 struct wimlib_capture_source *sources;
713 nlines = text_file_count_lines(source_list_contents_p,
714 &source_list_nchars);
718 /* Always allocate at least 1 slot, just in case the implementation of
719 * calloc() returns NULL if 0 bytes are requested. */
720 sources = calloc(nlines ?: 1, sizeof(*sources));
722 imagex_error(T("out of memory"));
725 p = *source_list_contents_p;
727 for (i = 0; i < nlines; i++) {
728 /* XXX: Could use rawmemchr() here instead, but it may not be
729 * available on all platforms. */
730 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
731 size_t len = endp - p + 1;
733 if (!is_comment_line(p, len)) {
734 if (!parse_source_list_line(p, len, &sources[j++])) {
747 enum capture_config_section {
748 CAPTURE_CONFIG_NO_SECTION,
749 CAPTURE_CONFIG_EXCLUSION_SECTION,
750 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
751 CAPTURE_CONFIG_IGNORE_SECTION,
755 CAPTURE_CONFIG_INVALID_SECTION,
756 CAPTURE_CONFIG_CHANGED_SECTION,
757 CAPTURE_CONFIG_SAME_SECTION,
761 check_config_section(tchar *line, size_t len,
762 enum capture_config_section *cur_section)
764 while (istspace(*line))
768 return CAPTURE_CONFIG_SAME_SECTION;
771 tchar *endbrace = tstrrchr(line, T(']'));
773 return CAPTURE_CONFIG_SAME_SECTION;
775 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
776 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
777 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
778 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
779 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
780 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
781 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
782 "of capture config file\n"),
784 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
785 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
786 tfputs(T("WARNING: Ignoring [AlignmentList] section "
787 "of capture config file\n"),
790 imagex_error(T("Invalid capture config file section \"%"TS"\""),
792 return CAPTURE_CONFIG_INVALID_SECTION;
794 return CAPTURE_CONFIG_CHANGED_SECTION;
799 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
802 if (pat_list->num_pats == pat_list->num_allocated_pats) {
804 size_t num_allocated_pats = pat_list->num_pats + 8;
806 pats = realloc(pat_list->pats,
807 num_allocated_pats * sizeof(pat_list->pats[0]));
809 imagex_error(T("Out of memory!"));
812 pat_list->pats = pats;
813 pat_list->num_allocated_pats = num_allocated_pats;
815 pat_list->pats[pat_list->num_pats++] = pat;
820 parse_capture_config_line(tchar *line, size_t len,
821 enum capture_config_section *cur_section,
822 struct wimlib_capture_config *config)
827 ret = check_config_section(line, len, cur_section);
828 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
830 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
833 switch (*cur_section) {
834 case CAPTURE_CONFIG_NO_SECTION:
835 imagex_error(T("Line \"%"TS"\" is not in a section "
836 "(such as [ExclusionList]"), line);
838 case CAPTURE_CONFIG_EXCLUSION_SECTION:
839 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
841 return pattern_list_add_pattern(&config->exclusion_pats,
843 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
844 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
846 return pattern_list_add_pattern(&config->exclusion_exception_pats,
848 case CAPTURE_CONFIG_IGNORE_SECTION:
855 parse_capture_config(tchar **contents_p, size_t nchars,
856 struct wimlib_capture_config *config)
861 enum capture_config_section cur_section;
863 memset(config, 0, sizeof(*config));
865 nlines = text_file_count_lines(contents_p, &nchars);
869 cur_section = CAPTURE_CONFIG_NO_SECTION;
871 for (i = 0; i < nlines; i++) {
872 tchar *endp = tmemchr(p, T('\n'), nchars);
873 size_t len = endp - p + 1;
875 if (!is_comment_line(p, len))
876 if (!parse_capture_config_line(p, len, &cur_section, config))
884 /* Reads the contents of a file into memory. */
886 file_get_contents(const tchar *filename, size_t *len_ret)
893 if (tstat(filename, &stbuf) != 0) {
894 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
899 fp = tfopen(filename, T("rb"));
901 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
905 buf = malloc(len ? len : 1);
907 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
908 "contents of file \"%"TS"\""), len, filename);
911 if (fread(buf, 1, len, fp) != len) {
912 imagex_error_with_errno(T("Failed to read %zu bytes from the "
913 "file \"%"TS"\""), len, filename);
927 /* Read standard input until EOF and return the full contents in a malloc()ed
928 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
931 stdin_get_contents(size_t *len_ret)
933 /* stdin can, of course, be a pipe or other non-seekable file, so the
934 * total length of the data cannot be pre-determined */
936 size_t newlen = 1024;
940 char *p = realloc(buf, newlen);
941 size_t bytes_read, bytes_to_read;
943 imagex_error(T("out of memory while reading stdin"));
947 bytes_to_read = newlen - pos;
948 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
950 if (bytes_read != bytes_to_read) {
955 imagex_error_with_errno(T("error reading stdin"));
969 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
972 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
974 *num_tchars_ret = num_bytes;
976 #else /* !__WIN32__ */
977 /* On Windows, translate the text to UTF-16LE */
981 if (num_bytes >= 2 &&
982 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
983 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
985 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
986 * with something that looks like an ASCII character encoded as
987 * a UTF-16LE code unit. Assume the file is encoded as
988 * UTF-16LE. This is not a 100% reliable check. */
989 num_wchars = num_bytes / 2;
990 text_wstr = (wchar_t*)text;
992 /* File does not look like UTF-16LE. Assume it is encoded in
993 * the current Windows code page. I think these are always
994 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
995 * should work as expected. */
996 text_wstr = win32_mbs_to_wcs(text,
1001 *num_tchars_ret = num_wchars;
1003 #endif /* __WIN32__ */
1007 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1012 contents = file_get_contents(filename, &num_bytes);
1015 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1019 stdin_get_text_contents(size_t *num_tchars_ret)
1024 contents = stdin_get_contents(&num_bytes);
1027 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1030 #define TO_PERCENT(numerator, denominator) \
1031 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1033 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1034 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1035 #define KIBIBYTE_MIN_NBYTES 10000ULL
1038 get_unit(uint64_t total_bytes, const tchar **name_ret)
1040 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1041 *name_ret = T("GiB");
1043 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1044 *name_ret = T("MiB");
1046 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1047 *name_ret = T("KiB");
1050 *name_ret = T("bytes");
1055 /* Progress callback function passed to various wimlib functions. */
1057 imagex_progress_func(enum wimlib_progress_msg msg,
1058 const union wimlib_progress_info *info)
1060 unsigned percent_done;
1061 unsigned unit_shift;
1062 const tchar *unit_name;
1063 if (imagex_be_quiet)
1066 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1067 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1068 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1069 info->write_streams.total_bytes);
1071 if (info->write_streams.completed_streams == 0) {
1072 imagex_printf(T("Writing %"TS"-compressed data using %u thread%"TS"\n"),
1073 wimlib_get_compression_type_string(info->write_streams.compression_type),
1074 info->write_streams.num_threads,
1075 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1077 if (info->write_streams.total_parts <= 1) {
1078 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1079 "written (%u%% done)"),
1080 info->write_streams.completed_bytes >> unit_shift,
1082 info->write_streams.total_bytes >> unit_shift,
1086 imagex_printf(T("\rWriting resources from part %u of %u: "
1087 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1088 (info->write_streams.completed_parts ==
1089 info->write_streams.total_parts) ?
1090 info->write_streams.completed_parts :
1091 info->write_streams.completed_parts + 1,
1092 info->write_streams.total_parts,
1093 info->write_streams.completed_bytes >> unit_shift,
1095 info->write_streams.total_bytes >> unit_shift,
1099 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1100 imagex_printf(T("\n"));
1102 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1103 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1104 if (*info->scan.wim_target_path) {
1105 imagex_printf(T(" (loading as WIM path: "
1106 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1107 info->scan.wim_target_path);
1109 imagex_printf(T(" (loading as root of WIM image)...\n"));
1112 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1113 switch (info->scan.status) {
1114 case WIMLIB_SCAN_DENTRY_OK:
1115 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1117 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1118 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1120 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1121 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1122 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1126 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1127 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1128 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1129 info->integrity.total_bytes);
1130 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1131 "of %"PRIu64" %"TS" (%u%%) done"),
1132 info->integrity.filename,
1133 info->integrity.completed_bytes >> unit_shift,
1135 info->integrity.total_bytes >> unit_shift,
1138 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1139 imagex_printf(T("\n"));
1141 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1142 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1143 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1144 info->integrity.total_bytes);
1145 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1146 "of %"PRIu64" %"TS" (%u%%) done"),
1147 info->integrity.completed_bytes >> unit_shift,
1149 info->integrity.total_bytes >> unit_shift,
1152 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1153 imagex_printf(T("\n"));
1155 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1156 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1157 "to %"TS" \"%"TS"\"\n"),
1158 info->extract.image,
1159 info->extract.image_name,
1160 info->extract.wimfile_name,
1161 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1162 T("NTFS volume") : T("directory")),
1163 info->extract.target);
1165 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1166 imagex_printf(T("Extracting "
1167 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1168 "in \"%"TS"\" to \"%"TS"\"\n"),
1169 info->extract.extract_root_wim_source_path,
1170 info->extract.image,
1171 info->extract.image_name,
1172 info->extract.wimfile_name,
1173 info->extract.target);
1175 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1176 percent_done = TO_PERCENT(info->extract.completed_bytes,
1177 info->extract.total_bytes);
1178 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1179 imagex_printf(T("\rExtracting files: "
1180 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1181 info->extract.completed_bytes >> unit_shift,
1183 info->extract.total_bytes >> unit_shift,
1186 if (info->extract.completed_bytes >= info->extract.total_bytes)
1187 imagex_printf(T("\n"));
1189 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1190 if (info->extract.total_parts != 1) {
1191 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1192 info->extract.part_number,
1193 info->extract.total_parts);
1196 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1197 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1198 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1200 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1201 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1202 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1203 info->extract.target);
1206 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1207 percent_done = TO_PERCENT(info->split.completed_bytes,
1208 info->split.total_bytes);
1209 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1210 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1211 "%"PRIu64" %"TS" (%u%%) written\n"),
1212 info->split.part_name,
1213 info->split.cur_part_number,
1214 info->split.total_parts,
1215 info->split.completed_bytes >> unit_shift,
1217 info->split.total_bytes >> unit_shift,
1221 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1222 if (info->split.completed_bytes == info->split.total_bytes) {
1223 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1224 info->split.cur_part_number,
1225 info->split.total_parts);
1228 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1229 switch (info->update.command->op) {
1230 case WIMLIB_UPDATE_OP_DELETE:
1231 imagex_printf(T("Deleted WIM path "
1232 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1233 info->update.command->delete_.wim_path);
1235 case WIMLIB_UPDATE_OP_RENAME:
1236 imagex_printf(T("Renamed WIM path "
1237 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1238 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1239 info->update.command->rename.wim_source_path,
1240 info->update.command->rename.wim_target_path);
1242 case WIMLIB_UPDATE_OP_ADD:
1250 fflush(imagex_info_file);
1255 parse_num_threads(const tchar *optarg)
1258 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1259 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1260 imagex_error(T("Number of threads must be a non-negative integer!"));
1267 static uint32_t parse_chunk_size(const tchar *optarg)
1270 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1271 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1272 imagex_error(T("Chunk size must be a non-negative integer!"));
1281 * Parse an option passed to an update command.
1283 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1286 * @option: Text string for the option (beginning with --)
1288 * @cmd: `struct wimlib_update_command' that is being constructed for
1291 * Returns true if the option was recognized; false if not.
1294 update_command_add_option(int op, const tchar *option,
1295 struct wimlib_update_command *cmd)
1297 bool recognized = true;
1299 case WIMLIB_UPDATE_OP_ADD:
1300 if (!tstrcmp(option, T("--verbose")))
1301 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1302 else if (!tstrcmp(option, T("--unix-data")))
1303 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1304 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1305 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1306 else if (!tstrcmp(option, T("--strict-acls")))
1307 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1308 else if (!tstrcmp(option, T("--dereference")))
1309 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1313 case WIMLIB_UPDATE_OP_DELETE:
1314 if (!tstrcmp(option, T("--force")))
1315 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1316 else if (!tstrcmp(option, T("--recursive")))
1317 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1328 /* How many nonoption arguments each `imagex update' command expects */
1329 static const unsigned update_command_num_nonoptions[] = {
1330 [WIMLIB_UPDATE_OP_ADD] = 2,
1331 [WIMLIB_UPDATE_OP_DELETE] = 1,
1332 [WIMLIB_UPDATE_OP_RENAME] = 2,
1336 update_command_add_nonoption(int op, const tchar *nonoption,
1337 struct wimlib_update_command *cmd,
1338 unsigned num_nonoptions)
1341 case WIMLIB_UPDATE_OP_ADD:
1342 if (num_nonoptions == 0)
1343 cmd->add.fs_source_path = (tchar*)nonoption;
1345 cmd->add.wim_target_path = (tchar*)nonoption;
1347 case WIMLIB_UPDATE_OP_DELETE:
1348 cmd->delete_.wim_path = (tchar*)nonoption;
1350 case WIMLIB_UPDATE_OP_RENAME:
1351 if (num_nonoptions == 0)
1352 cmd->rename.wim_source_path = (tchar*)nonoption;
1354 cmd->rename.wim_target_path = (tchar*)nonoption;
1360 * Parse a command passed on stdin to `imagex update'.
1362 * @line: Text of the command.
1363 * @len: Length of the line, including a null terminator
1366 * @command: A `struct wimlib_update_command' to fill in from the parsed
1369 * @line_number: Line number of the command, for diagnostics.
1371 * Returns true on success; returns false on parse error.
1374 parse_update_command(tchar *line, size_t len,
1375 struct wimlib_update_command *command,
1379 tchar *command_name;
1381 size_t num_nonoptions;
1383 /* Get the command name ("add", "delete", "rename") */
1384 ret = parse_string(&line, &len, &command_name);
1385 if (ret != PARSE_STRING_SUCCESS)
1388 if (!tstrcasecmp(command_name, T("add"))) {
1389 op = WIMLIB_UPDATE_OP_ADD;
1390 } else if (!tstrcasecmp(command_name, T("delete"))) {
1391 op = WIMLIB_UPDATE_OP_DELETE;
1392 } else if (!tstrcasecmp(command_name, T("rename"))) {
1393 op = WIMLIB_UPDATE_OP_RENAME;
1395 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1396 command_name, line_number);
1401 /* Parse additional options and non-options as needed */
1406 ret = parse_string(&line, &len, &next_string);
1407 if (ret == PARSE_STRING_NONE) /* End of line */
1409 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1411 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1413 if (!update_command_add_option(op, next_string, command))
1415 imagex_error(T("Unrecognized option \"%"TS"\" to "
1416 "update command \"%"TS"\" on line %zu"),
1417 next_string, command_name, line_number);
1423 if (num_nonoptions == update_command_num_nonoptions[op])
1425 imagex_error(T("Unexpected argument \"%"TS"\" in "
1426 "update command on line %zu\n"
1427 " (The \"%"TS"\" command only "
1428 "takes %zu nonoption arguments!)\n"),
1429 next_string, line_number,
1430 command_name, num_nonoptions);
1433 update_command_add_nonoption(op, next_string,
1434 command, num_nonoptions);
1439 if (num_nonoptions != update_command_num_nonoptions[op]) {
1440 imagex_error(T("Not enough arguments to update command "
1441 "\"%"TS"\" on line %zu"), command_name, line_number);
1447 static struct wimlib_update_command *
1448 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1449 size_t *num_cmds_ret)
1453 struct wimlib_update_command *cmds;
1456 nlines = text_file_count_lines(cmd_file_contents_p,
1461 /* Always allocate at least 1 slot, just in case the implementation of
1462 * calloc() returns NULL if 0 bytes are requested. */
1463 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1465 imagex_error(T("out of memory"));
1468 p = *cmd_file_contents_p;
1470 for (i = 0; i < nlines; i++) {
1471 /* XXX: Could use rawmemchr() here instead, but it may not be
1472 * available on all platforms. */
1473 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1474 size_t len = endp - p + 1;
1476 if (!is_comment_line(p, len)) {
1477 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1488 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1489 * one image from a WIM file to a NTFS volume. */
1491 imagex_apply(int argc, tchar **argv, int cmd)
1495 int image = WIMLIB_NO_IMAGE;
1497 struct wimlib_wim_info info;
1499 const tchar *wimfile;
1500 const tchar *target;
1501 const tchar *image_num_or_name = NULL;
1502 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1504 STRING_SET(refglobs);
1506 for_opt(c, apply_options) {
1508 case IMAGEX_CHECK_OPTION:
1509 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1511 case IMAGEX_HARDLINK_OPTION:
1512 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1514 case IMAGEX_SYMLINK_OPTION:
1515 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1517 case IMAGEX_VERBOSE_OPTION:
1518 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1520 case IMAGEX_REF_OPTION:
1521 ret = string_set_append(&refglobs, optarg);
1523 goto out_free_refglobs;
1525 case IMAGEX_UNIX_DATA_OPTION:
1526 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1528 case IMAGEX_NO_ACLS_OPTION:
1529 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1531 case IMAGEX_STRICT_ACLS_OPTION:
1532 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1534 case IMAGEX_NORPFIX_OPTION:
1535 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1537 case IMAGEX_RPFIX_OPTION:
1538 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1540 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1541 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1542 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1544 case IMAGEX_RESUME_OPTION:
1545 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1553 if (argc != 2 && argc != 3)
1558 if (!tstrcmp(wimfile, T("-"))) {
1559 /* Attempt to apply pipable WIM from standard input. */
1561 image_num_or_name = NULL;
1564 image_num_or_name = argv[1];
1569 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1570 imagex_progress_func);
1572 goto out_free_refglobs;
1574 wimlib_get_wim_info(wim, &info);
1577 /* Image explicitly specified. */
1578 image_num_or_name = argv[1];
1579 image = wimlib_resolve_image(wim, image_num_or_name);
1580 ret = verify_image_exists(image, image_num_or_name, wimfile);
1582 goto out_wimlib_free;
1585 /* No image specified; default to image 1, but only if the WIM
1586 * contains exactly one image. */
1588 if (info.image_count != 1) {
1589 imagex_error(T("\"%"TS"\" contains %d images; "
1590 "Please select one (or all)."),
1591 wimfile, info.image_count);
1600 if (refglobs.num_strings) {
1602 imagex_error(T("Can't specify --ref when applying from stdin!"));
1604 goto out_wimlib_free;
1606 ret = wim_reference_globs(wim, &refglobs, open_flags);
1608 goto out_wimlib_free;
1613 /* Interpret a regular file or block device target as a NTFS
1617 if (tstat(target, &stbuf)) {
1618 if (errno != ENOENT) {
1619 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1622 goto out_wimlib_free;
1625 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1626 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1632 ret = wimlib_extract_image(wim, image, target, extract_flags,
1633 imagex_progress_func);
1635 set_fd_to_binary_mode(STDIN_FILENO);
1636 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1638 target, extract_flags,
1639 imagex_progress_func);
1642 imagex_printf(T("Done applying WIM image.\n"));
1643 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1645 do_resource_not_found_warning(wimfile, &info, &refglobs);
1647 imagex_error(T( "If you are applying an image "
1648 "from a split pipable WIM,\n"
1649 " make sure you have "
1650 "concatenated together all parts."));
1656 string_set_destroy(&refglobs);
1660 usage(CMD_APPLY, stderr);
1662 goto out_free_refglobs;
1665 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1666 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1667 * the desired image. 'wimlib-imagex append': add a new image to an existing
1670 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1673 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1674 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1675 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1676 int write_flags = 0;
1677 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1678 uint32_t chunk_size = UINT32_MAX;
1679 const tchar *wimfile;
1683 const tchar *flags_element = NULL;
1686 STRING_SET(base_wimfiles);
1687 WIMStruct **base_wims;
1689 WIMStruct *template_wim;
1690 const tchar *template_wimfile = NULL;
1691 const tchar *template_image_name_or_num = NULL;
1692 int template_image = WIMLIB_NO_IMAGE;
1695 unsigned num_threads = 0;
1700 const tchar *config_file = NULL;
1702 struct wimlib_capture_config *config;
1704 bool source_list = false;
1705 size_t source_list_nchars = 0;
1706 tchar *source_list_contents;
1707 bool capture_sources_malloced;
1708 struct wimlib_capture_source *capture_sources;
1710 bool name_defaulted;
1712 for_opt(c, capture_or_append_options) {
1714 case IMAGEX_BOOT_OPTION:
1715 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1717 case IMAGEX_CHECK_OPTION:
1718 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1719 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1721 case IMAGEX_NOCHECK_OPTION:
1722 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1724 case IMAGEX_CONFIG_OPTION:
1725 config_file = optarg;
1726 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1728 case IMAGEX_COMPRESS_OPTION:
1729 compression_type = get_compression_type(optarg);
1730 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1733 case IMAGEX_COMPRESS_SLOW_OPTION:
1734 ret = set_compress_slow();
1737 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1739 case IMAGEX_CHUNK_SIZE_OPTION:
1740 chunk_size = parse_chunk_size(optarg);
1741 if (chunk_size == UINT32_MAX)
1744 case IMAGEX_PACK_STREAMS_OPTION:
1745 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1747 case IMAGEX_FLAGS_OPTION:
1748 flags_element = optarg;
1750 case IMAGEX_DEREFERENCE_OPTION:
1751 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1753 case IMAGEX_VERBOSE_OPTION:
1754 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1756 case IMAGEX_THREADS_OPTION:
1757 num_threads = parse_num_threads(optarg);
1758 if (num_threads == UINT_MAX)
1761 case IMAGEX_REBUILD_OPTION:
1762 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1764 case IMAGEX_UNIX_DATA_OPTION:
1765 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1767 case IMAGEX_SOURCE_LIST_OPTION:
1770 case IMAGEX_NO_ACLS_OPTION:
1771 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1773 case IMAGEX_STRICT_ACLS_OPTION:
1774 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1776 case IMAGEX_RPFIX_OPTION:
1777 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1779 case IMAGEX_NORPFIX_OPTION:
1780 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1782 case IMAGEX_PIPABLE_OPTION:
1783 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1785 case IMAGEX_NOT_PIPABLE_OPTION:
1786 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1788 case IMAGEX_UPDATE_OF_OPTION:
1789 if (template_image_name_or_num) {
1790 imagex_error(T("'--update-of' can only be "
1791 "specified one time!"));
1795 colon = tstrrchr(optarg, T(':'));
1798 template_wimfile = optarg;
1800 template_image_name_or_num = colon + 1;
1802 template_wimfile = NULL;
1803 template_image_name_or_num = optarg;
1807 case IMAGEX_DELTA_FROM_OPTION:
1808 if (cmd != CMD_CAPTURE) {
1809 imagex_error(T("'--delta-from' is only "
1810 "valid for capture!"));
1813 ret = string_set_append(&base_wimfiles, optarg);
1815 goto out_free_base_wimfiles;
1816 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1825 if (argc < 2 || argc > 4)
1831 /* Set default compression type. */
1832 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1833 struct wimlib_lzx_params params;
1834 memset(¶ms, 0, sizeof(params));
1835 params.size_of_this = sizeof(params);
1836 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1837 params.use_defaults = 1;
1839 wimlib_lzx_set_default_params(¶ms);
1840 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1843 if (!tstrcmp(wimfile, T("-"))) {
1844 /* Writing captured WIM to standard output. */
1846 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1847 imagex_error("Can't write a non-pipable WIM to "
1848 "standard output! Specify --pipable\n"
1849 " if you want to create a pipable WIM "
1850 "(but read the docs first).");
1854 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1856 if (cmd == CMD_APPEND) {
1857 imagex_error(T("Using standard output for append does "
1858 "not make sense."));
1861 wim_fd = STDOUT_FILENO;
1863 imagex_info_file = stderr;
1864 set_fd_to_binary_mode(wim_fd);
1867 /* If template image was specified using --update-of=IMAGE rather
1868 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1869 if (template_image_name_or_num && !template_wimfile) {
1870 if (base_wimfiles.num_strings == 1) {
1871 /* Capturing delta WIM based on single WIM: default to
1873 template_wimfile = base_wimfiles.strings[0];
1874 } else if (cmd == CMD_APPEND) {
1875 /* Appending to WIM: default to WIM being appended to.
1877 template_wimfile = wimfile;
1879 /* Capturing a normal (non-delta) WIM, so the WIM file
1880 * *must* be explicitly specified. */
1881 if (base_wimfiles.num_strings > 1) {
1882 imagex_error(T("For capture of delta WIM "
1883 "based on multiple existing "
1885 " '--update-of' must "
1886 "specify WIMFILE:IMAGE!"));
1888 imagex_error(T("For capture of non-delta WIM, "
1889 "'--update-of' must specify "
1898 name_defaulted = false;
1900 /* Set default name to SOURCE argument, omitting any directory
1901 * prefixes and trailing slashes. This requires making a copy
1902 * of @source. Leave some free characters at the end in case we
1903 * append a number to keep the name unique. */
1904 size_t source_name_len;
1906 source_name_len = tstrlen(source);
1907 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1908 name = tbasename(tstrcpy(source_copy, source));
1909 name_defaulted = true;
1911 /* Image description defaults to NULL if not given. */
1918 /* Set up capture sources in source list mode */
1919 if (source[0] == T('-') && source[1] == T('\0')) {
1920 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1922 source_list_contents = file_get_text_contents(source,
1923 &source_list_nchars);
1925 if (!source_list_contents)
1928 capture_sources = parse_source_list(&source_list_contents,
1931 if (!capture_sources) {
1933 goto out_free_source_list_contents;
1935 capture_sources_malloced = true;
1937 /* Set up capture source in non-source-list mode. */
1938 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1939 capture_sources[0].fs_source_path = source;
1940 capture_sources[0].wim_target_path = NULL;
1941 capture_sources[0].reserved = 0;
1943 capture_sources_malloced = false;
1944 source_list_contents = NULL;
1948 /* Read and parse capture configuration file. */
1951 config_str = file_get_text_contents(config_file, &config_len);
1954 goto out_free_capture_sources;
1957 config = alloca(sizeof(*config));
1958 ret = parse_capture_config(&config_str, config_len, config);
1960 goto out_free_config;
1962 /* No capture configuration file specified; use default
1963 * configuration for capturing Windows operating systems. */
1965 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1968 /* Open the existing WIM, or create a new one. */
1969 if (cmd == CMD_APPEND)
1970 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1971 imagex_progress_func);
1973 ret = wimlib_create_new_wim(compression_type, &wim);
1975 goto out_free_config;
1977 /* Set chunk size if non-default. */
1978 if (chunk_size != UINT32_MAX) {
1979 ret = wimlib_set_output_chunk_size(wim, chunk_size);
1985 /* Detect if source is regular file or block device and set NTFS volume
1990 if (tstat(source, &stbuf) == 0) {
1991 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1992 imagex_printf(T("Capturing WIM image from NTFS "
1993 "filesystem on \"%"TS"\"\n"), source);
1994 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1997 if (errno != ENOENT) {
1998 imagex_error_with_errno(T("Failed to stat "
1999 "\"%"TS"\""), source);
2007 /* If the user did not specify an image name, and the basename of the
2008 * source already exists as an image name in the WIM file, append a
2009 * suffix to make it unique. */
2010 if (cmd == CMD_APPEND && name_defaulted) {
2011 unsigned long conflict_idx;
2012 tchar *name_end = tstrchr(name, T('\0'));
2013 for (conflict_idx = 1;
2014 wimlib_image_name_in_use(wim, name);
2017 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2021 /* If capturing a delta WIM, reference resources from the base WIMs
2022 * before adding the new image. */
2023 if (base_wimfiles.num_strings) {
2024 base_wims = calloc(base_wimfiles.num_strings,
2025 sizeof(base_wims[0]));
2026 if (base_wims == NULL) {
2027 imagex_error(T("Out of memory!"));
2032 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2033 ret = wimlib_open_wim(base_wimfiles.strings[i],
2034 open_flags, &base_wims[i],
2035 imagex_progress_func);
2037 goto out_free_base_wims;
2041 ret = wimlib_reference_resources(wim, base_wims,
2042 base_wimfiles.num_strings, 0);
2044 goto out_free_base_wims;
2046 if (base_wimfiles.num_strings == 1) {
2047 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2048 base_wimfiles.strings[0]);
2050 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2051 base_wimfiles.num_strings);
2058 /* If capturing or appending as an update of an existing (template) image,
2059 * open the WIM if needed and parse the image index. */
2060 if (template_image_name_or_num) {
2063 if (base_wimfiles.num_strings == 1 &&
2064 template_wimfile == base_wimfiles.strings[0]) {
2065 template_wim = base_wims[0];
2066 } else if (template_wimfile == wimfile) {
2069 ret = wimlib_open_wim(template_wimfile, open_flags,
2070 &template_wim, imagex_progress_func);
2072 goto out_free_base_wims;
2075 template_image = wimlib_resolve_image(template_wim,
2076 template_image_name_or_num);
2078 if (template_image_name_or_num[0] == T('-')) {
2081 struct wimlib_wim_info info;
2083 wimlib_get_wim_info(template_wim, &info);
2084 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2085 if (n >= 1 && n <= info.image_count &&
2087 tmp != template_image_name_or_num + 1)
2089 template_image = info.image_count - (n - 1);
2092 ret = verify_image_exists_and_is_single(template_image,
2093 template_image_name_or_num,
2096 goto out_free_template_wim;
2098 template_wim = NULL;
2101 ret = wimlib_add_image_multisource(wim,
2107 imagex_progress_func);
2109 goto out_free_template_wim;
2111 if (desc || flags_element || template_image_name_or_num) {
2112 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2113 * on which the added one is to be based has been specified with
2114 * --update-of. Get the index of the image we just
2115 * added, then use it to call the appropriate functions. */
2116 struct wimlib_wim_info info;
2118 wimlib_get_wim_info(wim, &info);
2121 ret = wimlib_set_image_descripton(wim,
2125 goto out_free_template_wim;
2128 if (flags_element) {
2129 ret = wimlib_set_image_flags(wim, info.image_count,
2132 goto out_free_template_wim;
2135 /* Reference template image if the user provided one. */
2136 if (template_image_name_or_num) {
2137 imagex_printf(T("Using image %d "
2138 "from \"%"TS"\" as template\n"),
2139 template_image, template_wimfile);
2140 ret = wimlib_reference_template_image(wim,
2146 goto out_free_template_wim;
2150 /* Write the new WIM or overwrite the existing WIM with the new image
2152 if (cmd == CMD_APPEND) {
2153 ret = wimlib_overwrite(wim, write_flags, num_threads,
2154 imagex_progress_func);
2155 } else if (wimfile) {
2156 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2157 write_flags, num_threads,
2158 imagex_progress_func);
2160 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2161 write_flags, num_threads,
2162 imagex_progress_func);
2164 out_free_template_wim:
2165 /* template_wim may alias base_wims[0] or wim. */
2166 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2167 template_wim != wim)
2168 wimlib_free(template_wim);
2170 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2171 wimlib_free(base_wims[i]);
2177 free(config->exclusion_pats.pats);
2178 free(config->exclusion_exception_pats.pats);
2181 out_free_capture_sources:
2182 if (capture_sources_malloced)
2183 free(capture_sources);
2184 out_free_source_list_contents:
2185 free(source_list_contents);
2186 out_free_base_wimfiles:
2187 string_set_destroy(&base_wimfiles);
2194 goto out_free_base_wimfiles;
2197 /* Remove image(s) from a WIM. */
2199 imagex_delete(int argc, tchar **argv, int cmd)
2202 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2203 int write_flags = 0;
2204 const tchar *wimfile;
2205 const tchar *image_num_or_name;
2210 for_opt(c, delete_options) {
2212 case IMAGEX_CHECK_OPTION:
2213 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2214 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2216 case IMAGEX_SOFT_OPTION:
2217 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2228 imagex_error(T("Must specify a WIM file"));
2230 imagex_error(T("Must specify an image"));
2234 image_num_or_name = argv[1];
2236 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2237 imagex_progress_func);
2241 image = wimlib_resolve_image(wim, image_num_or_name);
2243 ret = verify_image_exists(image, image_num_or_name, wimfile);
2245 goto out_wimlib_free;
2247 ret = wimlib_delete_image(wim, image);
2249 imagex_error(T("Failed to delete image from \"%"TS"\""),
2251 goto out_wimlib_free;
2254 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2256 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2257 "deleted"), wimfile);
2265 usage(CMD_DELETE, stderr);
2271 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2273 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2274 return (ret >= 0) ? 0 : -1;
2277 /* Print the files contained in an image(s) in a WIM file. */
2279 imagex_dir(int argc, tchar **argv, int cmd)
2281 const tchar *wimfile;
2282 WIMStruct *wim = NULL;
2285 const tchar *path = T("");
2288 for_opt(c, dir_options) {
2290 case IMAGEX_PATH_OPTION:
2301 imagex_error(T("Must specify a WIM file"));
2305 imagex_error(T("Too many arguments"));
2310 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2315 image = wimlib_resolve_image(wim, argv[1]);
2316 ret = verify_image_exists(image, argv[1], wimfile);
2318 goto out_wimlib_free;
2320 /* No image specified; default to image 1, but only if the WIM
2321 * contains exactly one image. */
2323 struct wimlib_wim_info info;
2325 wimlib_get_wim_info(wim, &info);
2326 if (info.image_count != 1) {
2327 imagex_error(T("\"%"TS"\" contains %d images; Please "
2328 "select one (or all)."),
2329 wimfile, info.image_count);
2336 ret = wimlib_iterate_dir_tree(wim, image, path,
2337 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2338 print_full_path, NULL);
2345 usage(CMD_DIR, stderr);
2350 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2353 imagex_export(int argc, tchar **argv, int cmd)
2357 int export_flags = 0;
2358 int write_flags = 0;
2359 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2360 const tchar *src_wimfile;
2361 const tchar *src_image_num_or_name;
2362 const tchar *dest_wimfile;
2364 const tchar *dest_name;
2365 const tchar *dest_desc;
2367 struct wimlib_wim_info src_info;
2368 WIMStruct *dest_wim;
2373 STRING_SET(refglobs);
2374 unsigned num_threads = 0;
2376 for_opt(c, export_options) {
2378 case IMAGEX_BOOT_OPTION:
2379 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2381 case IMAGEX_CHECK_OPTION:
2382 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2383 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2385 case IMAGEX_NOCHECK_OPTION:
2386 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2388 case IMAGEX_COMPRESS_OPTION:
2389 compression_type = get_compression_type(optarg);
2390 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2393 case IMAGEX_REF_OPTION:
2394 ret = string_set_append(&refglobs, optarg);
2396 goto out_free_refglobs;
2398 case IMAGEX_THREADS_OPTION:
2399 num_threads = parse_num_threads(optarg);
2400 if (num_threads == UINT_MAX)
2403 case IMAGEX_REBUILD_OPTION:
2404 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2406 case IMAGEX_PIPABLE_OPTION:
2407 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2409 case IMAGEX_NOT_PIPABLE_OPTION:
2410 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2418 if (argc < 3 || argc > 5)
2420 src_wimfile = argv[0];
2421 src_image_num_or_name = argv[1];
2422 dest_wimfile = argv[2];
2423 dest_name = (argc >= 4) ? argv[3] : NULL;
2424 dest_desc = (argc >= 5) ? argv[4] : NULL;
2425 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2426 imagex_progress_func);
2428 goto out_free_refglobs;
2430 wimlib_get_wim_info(src_wim, &src_info);
2432 /* Determine if the destination is an existing file or not. If so, we
2433 * try to append the exported image(s) to it; otherwise, we create a new
2434 * WIM containing the exported image(s). Furthermore, determine if we
2435 * need to write a pipable WIM directly to standard output. */
2437 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2439 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2440 imagex_error("Can't write a non-pipable WIM to "
2441 "standard output! Specify --pipable\n"
2442 " if you want to create a pipable WIM "
2443 "(but read the docs first).");
2445 goto out_free_src_wim;
2448 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2450 dest_wimfile = NULL;
2451 dest_wim_fd = STDOUT_FILENO;
2452 imagex_info_file = stderr;
2453 set_fd_to_binary_mode(dest_wim_fd);
2456 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2458 /* Destination file exists. */
2460 if (!S_ISREG(stbuf.st_mode)) {
2461 imagex_error(T("\"%"TS"\" is not a regular file"),
2464 goto out_free_src_wim;
2466 ret = wimlib_open_wim(dest_wimfile,
2467 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2468 &dest_wim, imagex_progress_func);
2470 goto out_free_src_wim;
2472 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2473 /* The user specified a compression type, but we're
2474 * exporting to an existing WIM. Make sure the
2475 * specified compression type is the same as the
2476 * compression type of the existing destination WIM. */
2477 struct wimlib_wim_info dest_info;
2479 wimlib_get_wim_info(dest_wim, &dest_info);
2480 if (compression_type != dest_info.compression_type) {
2481 imagex_error(T("Cannot specify a compression type that is "
2482 "not the same as that used in the "
2483 "destination WIM"));
2485 goto out_free_dest_wim;
2491 if (errno != ENOENT) {
2492 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2495 goto out_free_src_wim;
2498 /* dest_wimfile is not an existing file, so create a new WIM. */
2500 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2501 /* The user did not specify a compression type; default
2502 * to that of the source WIM. */
2504 compression_type = src_info.compression_type;
2506 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2508 goto out_free_src_wim;
2510 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2513 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2514 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2516 goto out_free_dest_wim;
2518 if (refglobs.num_strings) {
2519 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2521 goto out_free_dest_wim;
2524 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2525 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2527 imagex_error(T("--boot specified for all-images export, but source WIM "
2528 "has no bootable image."));
2530 goto out_free_dest_wim;
2533 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2534 dest_desc, export_flags, imagex_progress_func);
2536 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2537 do_resource_not_found_warning(src_wimfile,
2538 &src_info, &refglobs);
2540 goto out_free_dest_wim;
2544 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2545 imagex_progress_func);
2546 else if (dest_wimfile)
2547 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2548 write_flags, num_threads,
2549 imagex_progress_func);
2551 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2552 WIMLIB_ALL_IMAGES, write_flags,
2553 num_threads, imagex_progress_func);
2555 wimlib_free(dest_wim);
2557 wimlib_free(src_wim);
2559 string_set_destroy(&refglobs);
2563 usage(CMD_EXPORT, stderr);
2566 goto out_free_refglobs;
2570 is_root_wim_path(const tchar *path)
2573 for (p = path; *p; p++)
2574 if (*p != T('\\') && *p != T('/'))
2580 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2581 const tchar *dest_dir)
2583 for (size_t i = 0; i < num_cmds; i++)
2584 if (cmds[i].fs_dest_path != dest_dir)
2585 free(cmds[i].fs_dest_path);
2589 static struct wimlib_extract_command *
2590 prepare_extract_commands(tchar **paths, unsigned num_paths,
2591 int extract_flags, tchar *dest_dir,
2592 size_t *num_cmds_ret)
2594 struct wimlib_extract_command *cmds;
2596 tchar *emptystr = T("");
2598 if (num_paths == 0) {
2602 num_cmds = num_paths;
2603 cmds = calloc(num_cmds, sizeof(cmds[0]));
2605 imagex_error(T("Out of memory!"));
2609 for (size_t i = 0; i < num_cmds; i++) {
2610 cmds[i].extract_flags = extract_flags;
2611 cmds[i].wim_source_path = paths[i];
2612 if (is_root_wim_path(paths[i])) {
2613 cmds[i].fs_dest_path = dest_dir;
2615 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2616 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2617 if (!cmds[i].fs_dest_path) {
2618 free_extract_commands(cmds, num_cmds, dest_dir);
2621 tsprintf(cmds[i].fs_dest_path,
2622 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2623 dest_dir, tbasename(paths[i]));
2626 *num_cmds_ret = num_cmds;
2630 /* Extract files or directories from a WIM image */
2632 imagex_extract(int argc, tchar **argv, int cmd)
2639 const tchar *wimfile;
2640 const tchar *image_num_or_name;
2641 tchar *dest_dir = T(".");
2642 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2644 STRING_SET(refglobs);
2646 struct wimlib_extract_command *cmds;
2649 for_opt(c, extract_options) {
2651 case IMAGEX_CHECK_OPTION:
2652 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2654 case IMAGEX_VERBOSE_OPTION:
2655 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2657 case IMAGEX_REF_OPTION:
2658 ret = string_set_append(&refglobs, optarg);
2660 goto out_free_refglobs;
2662 case IMAGEX_UNIX_DATA_OPTION:
2663 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2665 case IMAGEX_NO_ACLS_OPTION:
2666 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2668 case IMAGEX_STRICT_ACLS_OPTION:
2669 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2671 case IMAGEX_DEST_DIR_OPTION:
2674 case IMAGEX_TO_STDOUT_OPTION:
2675 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2676 imagex_info_file = stderr;
2677 imagex_be_quiet = true;
2679 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2680 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2681 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2694 image_num_or_name = argv[1];
2699 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2704 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2708 image = wimlib_resolve_image(wim, image_num_or_name);
2709 ret = verify_image_exists_and_is_single(image,
2713 goto out_wimlib_free;
2715 if (refglobs.num_strings) {
2716 ret = wim_reference_globs(wim, &refglobs, open_flags);
2718 goto out_wimlib_free;
2721 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2722 imagex_progress_func);
2724 if (!imagex_be_quiet)
2725 imagex_printf(T("Done extracting files.\n"));
2726 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2727 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2728 "files and directories\n"
2729 " are in the WIM image.\n"),
2730 get_cmd_string(CMD_INFO, false));
2731 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2732 struct wimlib_wim_info info;
2734 wimlib_get_wim_info(wim, &info);
2735 do_resource_not_found_warning(wimfile, &info, &refglobs);
2740 free_extract_commands(cmds, num_cmds, dest_dir);
2742 string_set_destroy(&refglobs);
2746 usage(CMD_EXTRACT, stderr);
2749 goto out_free_refglobs;
2752 static void print_byte_field(const uint8_t field[], size_t len)
2755 tprintf(T("%02hhx"), *field++);
2759 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2761 tputs(T("WIM Information:"));
2762 tputs(T("----------------"));
2763 tprintf(T("Path: %"TS"\n"), wimfile);
2764 tprintf(T("GUID: 0x"));
2765 print_byte_field(info->guid, sizeof(info->guid));
2767 tprintf(T("Version: %u\n"), info->wim_version);
2768 tprintf(T("Image Count: %d\n"), info->image_count);
2769 tprintf(T("Compression: %"TS"\n"),
2770 wimlib_get_compression_type_string(info->compression_type));
2771 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2773 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2774 tprintf(T("Boot Index: %d\n"), info->boot_index);
2775 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2776 tprintf(T("Integrity Info: %"TS"\n"),
2777 info->has_integrity_table ? T("yes") : T("no"));
2778 tprintf(T("Relative path junction: %"TS"\n"),
2779 info->has_rpfix ? T("yes") : T("no"));
2780 tprintf(T("Pipable: %"TS"\n"),
2781 info->pipable ? T("yes") : T("no"));
2786 print_resource(const struct wimlib_resource_entry *resource,
2789 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2790 resource->uncompressed_size);
2791 if (resource->packed) {
2792 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2793 resource->raw_resource_compressed_size);
2795 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2796 resource->raw_resource_offset_in_wim);
2798 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2801 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2802 resource->compressed_size);
2804 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2808 tprintf(T("Part Number = %u\n"), resource->part_number);
2809 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2811 tprintf(T("Hash = 0x"));
2812 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2815 tprintf(T("Flags = "));
2816 if (resource->is_compressed)
2817 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2818 if (resource->is_metadata)
2819 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2820 if (resource->is_free)
2821 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2822 if (resource->is_spanned)
2823 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2824 if (resource->packed)
2825 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2832 print_lookup_table(WIMStruct *wim)
2834 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2837 /* Prints information about a WIM file; also can mark an image as bootable,
2838 * change the name of an image, or change the description of an image. */
2840 imagex_info(int argc, tchar **argv, int cmd)
2845 bool nocheck = false;
2846 bool header = false;
2847 bool lookup_table = false;
2849 bool metadata = false;
2850 bool short_header = true;
2851 const tchar *xml_out_file = NULL;
2852 const tchar *wimfile;
2853 const tchar *image_num_or_name;
2854 const tchar *new_name;
2855 const tchar *new_desc;
2860 struct wimlib_wim_info info;
2862 for_opt(c, info_options) {
2864 case IMAGEX_BOOT_OPTION:
2867 case IMAGEX_CHECK_OPTION:
2870 case IMAGEX_NOCHECK_OPTION:
2873 case IMAGEX_HEADER_OPTION:
2875 short_header = false;
2877 case IMAGEX_LOOKUP_TABLE_OPTION:
2878 lookup_table = true;
2879 short_header = false;
2881 case IMAGEX_XML_OPTION:
2883 short_header = false;
2885 case IMAGEX_EXTRACT_XML_OPTION:
2886 xml_out_file = optarg;
2887 short_header = false;
2889 case IMAGEX_METADATA_OPTION:
2891 short_header = false;
2900 if (argc < 1 || argc > 4)
2904 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2905 new_name = (argc >= 3) ? argv[2] : NULL;
2906 new_desc = (argc >= 4) ? argv[3] : NULL;
2908 if (check && nocheck) {
2909 imagex_error(T("Can't specify both --check and --nocheck"));
2914 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2916 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2920 wimlib_get_wim_info(wim, &info);
2922 image = wimlib_resolve_image(wim, image_num_or_name);
2923 ret = WIMLIB_ERR_INVALID_IMAGE;
2924 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2925 verify_image_exists(image, image_num_or_name, wimfile);
2927 imagex_error(T("If you would like to set the boot "
2928 "index to 0, specify image \"0\" with "
2929 "the --boot flag."));
2931 goto out_wimlib_free;
2934 if (boot && info.image_count == 0) {
2935 imagex_error(T("--boot is meaningless on a WIM with no images"));
2936 goto out_wimlib_free;
2939 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2941 imagex_error(T("Cannot specify the --boot flag "
2942 "without specifying a specific "
2943 "image in a multi-image WIM"));
2944 goto out_wimlib_free;
2947 imagex_error(T("Cannot specify the NEW_NAME "
2948 "without specifying a specific "
2949 "image in a multi-image WIM"));
2950 goto out_wimlib_free;
2954 /* Operations that print information are separated from operations that
2955 * recreate the WIM file. */
2956 if (!new_name && !boot) {
2958 /* Read-only operations */
2960 if (image == WIMLIB_NO_IMAGE) {
2961 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2962 image_num_or_name, wimfile);
2963 goto out_wimlib_free;
2966 if (image == WIMLIB_ALL_IMAGES && short_header)
2967 print_wim_information(wimfile, &info);
2970 wimlib_print_header(wim);
2973 if (info.total_parts != 1) {
2974 tfprintf(stderr, T("Warning: Only showing the lookup table "
2975 "for part %d of a %d-part WIM.\n"),
2976 info.part_number, info.total_parts);
2978 print_lookup_table(wim);
2982 ret = wimlib_extract_xml_data(wim, stdout);
2984 goto out_wimlib_free;
2990 fp = tfopen(xml_out_file, T("wb"));
2992 imagex_error_with_errno(T("Failed to open the "
2993 "file \"%"TS"\" for "
2997 goto out_wimlib_free;
2999 ret = wimlib_extract_xml_data(wim, fp);
3001 imagex_error(T("Failed to close the file "
3007 goto out_wimlib_free;
3011 wimlib_print_available_images(wim, image);
3014 ret = wimlib_print_metadata(wim, image);
3016 goto out_wimlib_free;
3021 /* Modification operations */
3023 if (image == WIMLIB_ALL_IMAGES)
3026 if (image == WIMLIB_NO_IMAGE && new_name) {
3027 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3028 "when using image 0"), new_name);
3030 goto out_wimlib_free;
3034 if (image == info.boot_index) {
3035 imagex_printf(T("Image %d is already marked as "
3036 "bootable.\n"), image);
3039 imagex_printf(T("Marking image %d as bootable.\n"),
3041 info.boot_index = image;
3042 ret = wimlib_set_wim_info(wim, &info,
3043 WIMLIB_CHANGE_BOOT_INDEX);
3045 goto out_wimlib_free;
3049 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3051 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3055 imagex_printf(T("Changing the name of image %d to "
3056 "\"%"TS"\".\n"), image, new_name);
3057 ret = wimlib_set_image_name(wim, image, new_name);
3059 goto out_wimlib_free;
3063 const tchar *old_desc;
3064 old_desc = wimlib_get_image_description(wim, image);
3065 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3066 imagex_printf(T("The description of image %d is already "
3067 "\"%"TS"\".\n"), image, new_desc);
3070 imagex_printf(T("Changing the description of image %d "
3071 "to \"%"TS"\".\n"), image, new_desc);
3072 ret = wimlib_set_image_descripton(wim, image,
3075 goto out_wimlib_free;
3079 /* Only call wimlib_overwrite() if something actually needs to
3081 if (boot || new_name || new_desc ||
3082 (check && !info.has_integrity_table) ||
3083 (nocheck && info.has_integrity_table))
3085 int write_flags = 0;
3088 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3090 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3091 ret = wimlib_overwrite(wim, write_flags, 1,
3092 imagex_progress_func);
3094 imagex_printf(T("The file \"%"TS"\" was not modified "
3095 "because nothing needed to be done.\n"),
3106 usage(CMD_INFO, stderr);
3112 /* Join split WIMs into one part WIM */
3114 imagex_join(int argc, tchar **argv, int cmd)
3117 int swm_open_flags = 0;
3118 int wim_write_flags = 0;
3119 const tchar *output_path;
3122 for_opt(c, join_options) {
3124 case IMAGEX_CHECK_OPTION:
3125 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3126 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3136 imagex_error(T("Must specify one or more split WIM (.swm) "
3140 output_path = argv[0];
3141 ret = wimlib_join((const tchar * const *)++argv,
3146 imagex_progress_func);
3151 usage(CMD_JOIN, stderr);
3156 #if WIM_MOUNTING_SUPPORTED
3158 /* Mounts a WIM image. */
3160 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3163 int mount_flags = 0;
3165 const tchar *staging_dir = NULL;
3166 const tchar *wimfile;
3169 struct wimlib_wim_info info;
3173 STRING_SET(refglobs);
3175 if (cmd == CMD_MOUNTRW) {
3176 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3177 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3180 for_opt(c, mount_options) {
3182 case IMAGEX_ALLOW_OTHER_OPTION:
3183 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3185 case IMAGEX_CHECK_OPTION:
3186 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3188 case IMAGEX_DEBUG_OPTION:
3189 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3191 case IMAGEX_STREAMS_INTERFACE_OPTION:
3192 if (!tstrcasecmp(optarg, T("none")))
3193 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3194 else if (!tstrcasecmp(optarg, T("xattr")))
3195 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3196 else if (!tstrcasecmp(optarg, T("windows")))
3197 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3199 imagex_error(T("Unknown stream interface \"%"TS"\""),
3204 case IMAGEX_REF_OPTION:
3205 ret = string_set_append(&refglobs, optarg);
3207 goto out_free_refglobs;
3209 case IMAGEX_STAGING_DIR_OPTION:
3210 staging_dir = optarg;
3212 case IMAGEX_UNIX_DATA_OPTION:
3213 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3221 if (argc != 2 && argc != 3)
3226 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3228 goto out_free_refglobs;
3230 wimlib_get_wim_info(wim, &info);
3233 /* Image explicitly specified. */
3234 image = wimlib_resolve_image(wim, argv[1]);
3236 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3240 /* No image specified; default to image 1, but only if the WIM
3241 * contains exactly one image. */
3243 if (info.image_count != 1) {
3244 imagex_error(T("\"%"TS"\" contains %d images; Please "
3245 "select one."), wimfile, info.image_count);
3253 if (refglobs.num_strings) {
3254 ret = wim_reference_globs(wim, &refglobs, open_flags);
3259 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3261 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3263 image, wimfile, dir);
3268 string_set_destroy(&refglobs);
3274 goto out_free_refglobs;
3276 #endif /* WIM_MOUNTING_SUPPORTED */
3278 /* Rebuild a WIM file */
3280 imagex_optimize(int argc, tchar **argv, int cmd)
3283 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3284 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3285 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3286 uint32_t chunk_size = UINT32_MAX;
3289 const tchar *wimfile;
3292 unsigned num_threads = 0;
3294 for_opt(c, optimize_options) {
3296 case IMAGEX_CHECK_OPTION:
3297 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3298 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3300 case IMAGEX_NOCHECK_OPTION:
3301 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3303 case IMAGEX_COMPRESS_OPTION:
3304 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3305 compression_type = get_compression_type(optarg);
3306 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3309 case IMAGEX_RECOMPRESS_OPTION:
3310 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3312 case IMAGEX_COMPRESS_SLOW_OPTION:
3313 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3314 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
3315 ret = set_compress_slow();
3319 case IMAGEX_CHUNK_SIZE_OPTION:
3320 chunk_size = parse_chunk_size(optarg);
3321 if (chunk_size == UINT32_MAX)
3324 case IMAGEX_PACK_STREAMS_OPTION:
3325 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3326 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3328 case IMAGEX_THREADS_OPTION:
3329 num_threads = parse_num_threads(optarg);
3330 if (num_threads == UINT_MAX)
3333 case IMAGEX_PIPABLE_OPTION:
3334 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3336 case IMAGEX_NOT_PIPABLE_OPTION:
3337 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3351 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3355 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3356 /* Change compression type. */
3357 ret = wimlib_set_output_compression_type(wim, compression_type);
3359 goto out_wimlib_free;
3362 if (chunk_size != UINT32_MAX) {
3363 /* Change chunk size. */
3364 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3366 goto out_wimlib_free;
3369 old_size = file_get_size(wimfile);
3370 tprintf(T("\"%"TS"\" original size: "), wimfile);
3372 tputs(T("Unknown"));
3374 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3376 ret = wimlib_overwrite(wim, write_flags, num_threads,
3377 imagex_progress_func);
3379 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3380 goto out_wimlib_free;
3383 new_size = file_get_size(wimfile);
3384 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3386 tputs(T("Unknown"));
3388 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3390 tfputs(T("Space saved: "), stdout);
3391 if (new_size != -1 && old_size != -1) {
3392 tprintf(T("%lld KiB\n"),
3393 ((long long)old_size - (long long)new_size) >> 10);
3395 tputs(T("Unknown"));
3404 usage(CMD_OPTIMIZE, stderr);
3410 /* Split a WIM into a spanned set */
3412 imagex_split(int argc, tchar **argv, int cmd)
3416 int write_flags = 0;
3417 unsigned long part_size;
3422 for_opt(c, split_options) {
3424 case IMAGEX_CHECK_OPTION:
3425 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3426 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3438 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3439 if (tmp == argv[2] || *tmp) {
3440 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3441 imagex_error(T("The part size must be an integer or "
3442 "floating-point number of megabytes."));
3445 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3449 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3455 usage(CMD_SPLIT, stderr);
3461 #if WIM_MOUNTING_SUPPORTED
3462 /* Unmounts a mounted WIM image. */
3464 imagex_unmount(int argc, tchar **argv, int cmd)
3467 int unmount_flags = 0;
3470 for_opt(c, unmount_options) {
3472 case IMAGEX_COMMIT_OPTION:
3473 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3475 case IMAGEX_CHECK_OPTION:
3476 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3478 case IMAGEX_REBUILD_OPTION:
3479 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3481 case IMAGEX_LAZY_OPTION:
3482 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3493 ret = wimlib_unmount_image(argv[0], unmount_flags,
3494 imagex_progress_func);
3496 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3501 usage(CMD_UNMOUNT, stderr);
3505 #endif /* WIM_MOUNTING_SUPPORTED */
3508 * Add, delete, or rename files in a WIM image.
3511 imagex_update(int argc, tchar **argv, int cmd)
3513 const tchar *wimfile;
3517 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3518 int write_flags = 0;
3519 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3520 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
3521 int default_delete_flags = 0;
3522 unsigned num_threads = 0;
3524 tchar *cmd_file_contents;
3525 size_t cmd_file_nchars;
3526 struct wimlib_update_command *cmds;
3528 tchar *command_str = NULL;
3530 const tchar *config_file = NULL;
3532 struct wimlib_capture_config *config;
3534 for_opt(c, update_options) {
3536 /* Generic or write options */
3537 case IMAGEX_THREADS_OPTION:
3538 num_threads = parse_num_threads(optarg);
3539 if (num_threads == UINT_MAX)
3542 case IMAGEX_CHECK_OPTION:
3543 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3544 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3546 case IMAGEX_REBUILD_OPTION:
3547 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3549 case IMAGEX_COMMAND_OPTION:
3551 imagex_error(T("--command may only be specified "
3552 "one time. Please provide\n"
3553 " the update commands "
3554 "on standard input instead."));
3557 command_str = tstrdup(optarg);
3559 imagex_error(T("Out of memory!"));
3563 /* Default delete options */
3564 case IMAGEX_FORCE_OPTION:
3565 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3567 case IMAGEX_RECURSIVE_OPTION:
3568 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3571 /* Global add option */
3572 case IMAGEX_CONFIG_OPTION:
3573 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3574 config_file = optarg;
3577 /* Default add options */
3578 case IMAGEX_VERBOSE_OPTION:
3579 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3581 case IMAGEX_DEREFERENCE_OPTION:
3582 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3584 case IMAGEX_UNIX_DATA_OPTION:
3585 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3587 case IMAGEX_NO_ACLS_OPTION:
3588 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3590 case IMAGEX_STRICT_ACLS_OPTION:
3591 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3600 if (argc != 1 && argc != 2)
3604 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3606 goto out_free_command_str;
3609 /* Image explicitly specified. */
3610 image = wimlib_resolve_image(wim, argv[1]);
3611 ret = verify_image_exists_and_is_single(image, argv[1],
3614 goto out_wimlib_free;
3616 /* No image specified; default to image 1, but only if the WIM
3617 * contains exactly one image. */
3618 struct wimlib_wim_info info;
3620 wimlib_get_wim_info(wim, &info);
3621 if (info.image_count != 1) {
3622 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3623 wimfile, info.image_count);
3630 /* Parse capture configuration file if specified */
3634 config_str = file_get_text_contents(config_file, &config_len);
3637 goto out_wimlib_free;
3640 config = alloca(sizeof(*config));
3641 ret = parse_capture_config(&config_str, config_len, config);
3643 goto out_free_config;
3646 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3649 /* Read update commands from standard input, or the command string if
3652 cmd_file_contents = NULL;
3653 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3656 if (isatty(STDIN_FILENO)) {
3657 tputs(T("Reading update commands from standard input..."));
3658 recommend_man_page(CMD_UPDATE, stdout);
3660 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3661 if (!cmd_file_contents) {
3663 goto out_free_config;
3666 /* Parse the update commands */
3667 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3672 goto out_free_cmd_file_contents;
3675 /* Set default flags and capture config on the update commands */
3676 for (size_t i = 0; i < num_cmds; i++) {
3677 switch (cmds[i].op) {
3678 case WIMLIB_UPDATE_OP_ADD:
3679 cmds[i].add.add_flags |= default_add_flags;
3680 cmds[i].add.config = config;
3682 case WIMLIB_UPDATE_OP_DELETE:
3683 cmds[i].delete_.delete_flags |= default_delete_flags;
3690 /* Execute the update commands */
3691 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3692 imagex_progress_func);
3696 /* Overwrite the updated WIM */
3697 ret = wimlib_overwrite(wim, write_flags, num_threads,
3698 imagex_progress_func);
3701 out_free_cmd_file_contents:
3702 free(cmd_file_contents);
3705 free(config->exclusion_pats.pats);
3706 free(config->exclusion_exception_pats.pats);
3711 out_free_command_str:
3716 usage(CMD_UPDATE, stderr);
3719 goto out_free_command_str;
3724 struct imagex_command {
3726 int (*func)(int argc, tchar **argv, int cmd);
3729 static const struct imagex_command imagex_commands[] = {
3730 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3731 [CMD_APPLY] = {T("apply"), imagex_apply},
3732 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3733 [CMD_DELETE] = {T("delete"), imagex_delete},
3734 [CMD_DIR ] = {T("dir"), imagex_dir},
3735 [CMD_EXPORT] = {T("export"), imagex_export},
3736 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3737 [CMD_INFO] = {T("info"), imagex_info},
3738 [CMD_JOIN] = {T("join"), imagex_join},
3739 #if WIM_MOUNTING_SUPPORTED
3740 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3741 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3743 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3744 [CMD_SPLIT] = {T("split"), imagex_split},
3745 #if WIM_MOUNTING_SUPPORTED
3746 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3748 [CMD_UPDATE] = {T("update"), imagex_update},
3751 static const tchar *usage_strings[] = {
3754 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3755 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3756 " [--check] [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3757 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3758 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3759 " [--norpfix] [--unix-data] [--pipable]\n"
3760 " [--update-of=[WIMFILE:]IMAGE]\n"
3764 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3765 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3766 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3767 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3768 " [--include-invalid-names]\n"
3772 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3773 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3774 " [--check] [--nocheck] [--compress=TYPE]\n"
3775 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
3776 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3777 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3778 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3779 " [--delta-from=WIMFILE]\n"
3783 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3788 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3792 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3793 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3794 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3795 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3796 " [--pipable] [--not-pipable]\n"
3800 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3801 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3802 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3803 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3807 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3808 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3809 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3814 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3816 #if WIM_MOUNTING_SUPPORTED
3819 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3820 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3821 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3825 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3826 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3827 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3832 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3833 " [--recompress-slow] [--compress=TYPE]\n"
3834 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3838 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3840 #if WIM_MOUNTING_SUPPORTED
3843 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3848 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3849 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3850 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3854 static const tchar *invocation_name;
3855 static int invocation_cmd = CMD_NONE;
3857 static const tchar *get_cmd_string(int cmd, bool nospace)
3859 static tchar buf[50];
3860 if (cmd == CMD_NONE) {
3861 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3862 } else if (invocation_cmd != CMD_NONE) {
3863 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3865 const tchar *format;
3868 format = T("%"TS"-%"TS"");
3870 format = T("%"TS" %"TS"");
3871 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3879 static const tchar *s =
3881 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3882 "Copyright (C) 2012, 2013 Eric Biggers\n"
3883 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3884 "This is free software: you are free to change and redistribute it.\n"
3885 "There is NO WARRANTY, to the extent permitted by law.\n"
3887 "Report bugs to "PACKAGE_BUGREPORT".\n"
3894 help_or_version(int argc, tchar **argv, int cmd)
3899 for (i = 1; i < argc; i++) {
3901 if (p[0] == T('-') && p[1] == T('-')) {
3903 if (!tstrcmp(p, T("help"))) {
3904 if (cmd == CMD_NONE)
3909 } else if (!tstrcmp(p, T("version"))) {
3918 print_usage_string(int cmd, FILE *fp)
3920 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3924 recommend_man_page(int cmd, FILE *fp)
3926 const tchar *format_str;
3928 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3930 format_str = T("Try `man %"TS"' for more details.\n");
3932 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3936 usage(int cmd, FILE *fp)
3938 tfprintf(fp, T("Usage:\n"));
3939 print_usage_string(cmd, fp);
3940 tfprintf(fp, T("\n"));
3941 recommend_man_page(cmd, fp);
3947 tfprintf(fp, T("Usage:\n"));
3948 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3949 print_usage_string(cmd, fp);
3950 tfprintf(fp, T("\n"));
3952 static const tchar *extra =
3955 " %"TS" --version\n"
3957 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3960 tfprintf(fp, extra, invocation_name, invocation_name);
3961 recommend_man_page(CMD_NONE, fp);
3964 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3965 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3966 * something else), while an Windows the command arguments will be UTF-16LE
3967 * encoded 'wchar_t' strings. */
3970 wmain(int argc, wchar_t **argv, wchar_t **envp)
3972 main(int argc, char **argv)
3979 imagex_info_file = stdout;
3980 invocation_name = tbasename(argv[0]);
3983 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3984 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3988 setlocale(LC_ALL, "");
3989 codeset = nl_langinfo(CODESET);
3990 if (!strstr(codeset, "UTF-8") &&
3991 !strstr(codeset, "UTF8") &&
3992 !strstr(codeset, "utf-8") &&
3993 !strstr(codeset, "utf8"))
3996 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3997 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3998 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3999 " to any value to force wimlib to use UTF-8.\n",
4004 #endif /* !__WIN32__ */
4006 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4008 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4009 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4010 for (int i = 0; i < CMD_MAX; i++) {
4011 if (!tstrcmp(invocation_name + 3,
4012 imagex_commands[i].name))
4021 /* Unless already known from the invocation name, determine which
4022 * command was specified. */
4023 if (cmd == CMD_NONE) {
4025 imagex_error(T("No command specified!\n"));
4029 for (int i = 0; i < CMD_MAX; i++) {
4030 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4035 if (cmd != CMD_NONE) {
4041 /* Handle --help and --version. --help can be either for the program as
4042 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4043 * CMD_NONE). Note: help_or_version() will not return if a --help or
4044 * --version argument was found. */
4045 help_or_version(argc, argv, cmd);
4047 /* Bail if a valid command was not specified. */
4048 if (cmd == CMD_NONE) {
4049 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4054 /* Enable warning and error messages in wimlib be more user-friendly.
4056 wimlib_set_print_errors(true);
4058 /* Initialize wimlib. */
4059 ret = wimlib_global_init(init_flags);
4061 goto out_check_status;
4063 /* Call the command handler function. */
4064 ret = imagex_commands[cmd].func(argc, argv, cmd);
4066 /* Check for error writing to standard output, especially since for some
4067 * commands, writing to standard output is part of the program's actual
4068 * behavior and not just for informational purposes. */
4069 if (ferror(stdout) || fclose(stdout)) {
4070 imagex_error_with_errno(T("error writing to standard output"));
4075 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4076 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4077 * error code from which an error message can be printed. */
4079 imagex_error(T("Exiting with error code %d:\n"
4081 wimlib_get_error_string(ret));
4082 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4083 imagex_error_with_errno(T("errno"));
4085 /* Make wimlib free any resources it's holding (although this is not
4086 * strictly necessary because the process is ending anyway). */
4087 wimlib_global_cleanup();