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_WILDCARDS_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_STRICT_WILDCARDS_OPTION,
162 IMAGEX_SYMLINK_OPTION,
163 IMAGEX_THREADS_OPTION,
164 IMAGEX_TO_STDOUT_OPTION,
165 IMAGEX_UNIX_DATA_OPTION,
166 IMAGEX_UPDATE_OF_OPTION,
167 IMAGEX_VERBOSE_OPTION,
171 static const struct option apply_options[] = {
172 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
173 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
174 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
175 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
176 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
177 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
178 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
179 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
180 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
181 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
182 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
183 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
185 /* --resume is undocumented for now as it needs improvement. */
186 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
190 static const struct option capture_or_append_options[] = {
191 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
192 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
193 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
194 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
195 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
196 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
197 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
198 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
199 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
200 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
201 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
202 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
203 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
204 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
205 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
206 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
207 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
208 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
209 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
210 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
211 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
212 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
213 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
214 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
215 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
219 static const struct option delete_options[] = {
220 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
221 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
225 static const struct option dir_options[] = {
226 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
230 static const struct option export_options[] = {
231 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
232 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
233 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
234 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
235 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
236 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
237 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
238 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
239 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
240 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
241 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
242 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
246 static const struct option extract_options[] = {
247 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
248 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
249 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
250 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
251 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
252 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
253 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
254 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
255 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
256 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
257 {T("strict-wildcards"), no_argument, NULL, IMAGEX_STRICT_WILDCARDS_OPTION},
258 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_WILDCARDS_OPTION},
262 static const struct option info_options[] = {
263 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
264 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
265 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
266 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
267 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
268 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
269 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
270 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
271 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
275 static const struct option join_options[] = {
276 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
280 static const struct option mount_options[] = {
281 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
282 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
283 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
284 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
285 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
286 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
287 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
291 static const struct option optimize_options[] = {
292 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
293 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
294 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
295 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
296 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
297 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
298 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
299 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
300 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
301 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
302 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
303 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
307 static const struct option split_options[] = {
308 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
312 static const struct option unmount_options[] = {
313 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
314 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
315 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
316 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
320 static const struct option update_options[] = {
321 /* Careful: some of the options here set the defaults for update
322 * commands, but the flags given to an actual update command (and not to
323 * `imagex update' itself are also handled in
324 * update_command_add_option(). */
325 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
326 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
327 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
328 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
330 /* Default delete options */
331 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
332 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
334 /* Global add option */
335 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
337 /* Default add options */
338 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
339 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
340 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
341 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
342 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
343 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
349 # define _format_attribute(type, format_str, args_start) \
350 __attribute__((format(type, format_str, args_start)))
352 # define _format_attribute(type, format_str, args_start)
355 /* Print formatted error message to stderr. */
356 static void _format_attribute(printf, 1, 2)
357 imagex_error(const tchar *format, ...)
360 va_start(va, format);
361 tfputs(T("ERROR: "), stderr);
362 tvfprintf(stderr, format, va);
363 tputc(T('\n'), stderr);
367 /* Print formatted error message to stderr. */
368 static void _format_attribute(printf, 1, 2)
369 imagex_error_with_errno(const tchar *format, ...)
371 int errno_save = errno;
373 va_start(va, format);
374 tfputs(T("ERROR: "), stderr);
375 tvfprintf(stderr, format, va);
376 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
381 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
383 if (image == WIMLIB_NO_IMAGE) {
384 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
385 " Please specify a 1-based image index or "
386 "image name. To list the images\n"
387 " contained in the WIM archive, run\n"
389 " %"TS" \"%"TS"\"\n"),
390 image_name, wim_name,
391 get_cmd_string(CMD_INFO, false), wim_name);
392 return WIMLIB_ERR_INVALID_IMAGE;
398 verify_image_is_single(int image)
400 if (image == WIMLIB_ALL_IMAGES) {
401 imagex_error(T("Cannot specify all images for this action!"));
402 return WIMLIB_ERR_INVALID_IMAGE;
408 verify_image_exists_and_is_single(int image, const tchar *image_name,
409 const tchar *wim_name)
412 ret = verify_image_exists(image, image_name, wim_name);
414 ret = verify_image_is_single(image);
418 /* Parse the argument to --compress */
420 get_compression_type(const tchar *optarg)
422 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
423 return WIMLIB_COMPRESSION_TYPE_LZX;
424 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
425 return WIMLIB_COMPRESSION_TYPE_XPRESS;
426 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
427 return WIMLIB_COMPRESSION_TYPE_LZMS;
428 else if (!tstrcasecmp(optarg, T("none")))
429 return WIMLIB_COMPRESSION_TYPE_NONE;
431 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
432 "\"maximum\", \"fast\", or \"none\"."), optarg);
433 return WIMLIB_COMPRESSION_TYPE_INVALID;
438 set_compress_slow(void)
441 static const struct wimlib_lzx_compressor_params slow_params = {
443 .size = sizeof(struct wimlib_lzx_compressor_params),
445 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
448 .use_len2_matches = 1,
449 .num_fast_bytes = 96,
450 .num_optim_passes = 4,
451 .max_search_depth = 100,
452 .max_matches_per_pos = 10,
453 .main_nostat_cost = 15,
454 .len_nostat_cost = 15,
455 .aligned_nostat_cost = 7,
459 ret = wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
462 imagex_error(T("Couldn't set slow compression parameters.!"));
467 const tchar **strings;
468 unsigned num_strings;
469 unsigned num_alloc_strings;
472 #define STRING_SET_INITIALIZER \
473 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
475 #define STRING_SET(_strings) \
476 struct string_set _strings = STRING_SET_INITIALIZER
479 string_set_append(struct string_set *set, const tchar *glob)
481 unsigned num_alloc_strings = set->num_alloc_strings;
483 if (set->num_strings == num_alloc_strings) {
484 const tchar **new_strings;
486 num_alloc_strings += 4;
487 new_strings = realloc(set->strings,
488 sizeof(set->strings[0]) * num_alloc_strings);
490 imagex_error(T("Out of memory!"));
493 set->strings = new_strings;
494 set->num_alloc_strings = num_alloc_strings;
496 set->strings[set->num_strings++] = glob;
501 string_set_destroy(struct string_set *set)
507 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
509 return wimlib_reference_resource_files(wim, set->strings,
511 WIMLIB_REF_FLAG_GLOB_ENABLE,
513 imagex_progress_func);
517 do_resource_not_found_warning(const tchar *wimfile,
518 const struct wimlib_wim_info *info,
519 const struct string_set *refglobs)
521 if (info->total_parts > 1) {
522 if (refglobs->num_strings == 0) {
523 imagex_error(T("\"%"TS"\" is part of a split WIM. "
524 "Use --ref to specify the other parts."),
527 imagex_error(T("Perhaps the '--ref' argument did not "
528 "specify all other parts of the split "
532 imagex_error(T("If this is a delta WIM, use the --ref argument "
533 "to specify the WIM(s) on which it is based."));
537 /* Returns the size of a file given its name, or -1 if the file does not exist
538 * or its size cannot be determined. */
540 file_get_size(const tchar *filename)
543 if (tstat(filename, &st) == 0)
550 PARSE_STRING_SUCCESS = 0,
551 PARSE_STRING_FAILURE = 1,
552 PARSE_STRING_NONE = 2,
556 * Parses a string token from an array of characters.
558 * Tokens are either whitespace-delimited, or double or single-quoted.
560 * @line_p: Pointer to the pointer to the line of data. Will be updated
561 * to point past the string token iff the return value is
562 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
565 * @len_p: @len_p initially stores the length of the line of data, which may
566 * be 0, and it will be updated to the number of bytes remaining in
567 * the line iff the return value is PARSE_STRING_SUCCESS.
569 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
570 * parsed string token will be returned here.
572 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
573 * PARSE_STRING_FAILURE if the data was invalid due to a missing
574 * closing quote; or PARSE_STRING_NONE if the line ended before the
575 * beginning of a string token was found.
578 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
581 tchar *line = *line_p;
585 /* Skip leading whitespace */
588 return PARSE_STRING_NONE;
589 if (!istspace(*line) && *line != T('\0'))
595 if (quote_char == T('"') || quote_char == T('\'')) {
600 line = tmemchr(line, quote_char, len);
602 imagex_error(T("Missing closing quote: %"TS), fn - 1);
603 return PARSE_STRING_FAILURE;
606 /* Unquoted string. Go until whitespace. Line is terminated
607 * by '\0', so no need to check 'len'. */
611 } while (!istspace(*line) && *line != T('\0'));
618 return PARSE_STRING_SUCCESS;
621 /* Parses a line of data (not an empty line or comment) in the source list file
622 * format. (See the man page for 'wimlib-imagex capture' for details on this
623 * format and the meaning.)
625 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
626 * len == 0. The data in @line will be modified by this function call.
628 * @len: Length of the line of data.
630 * @source: On success, the capture source and target described by the line is
631 * written into this destination. Note that it will contain pointers
632 * to data in the @line array.
634 * Returns true if the line was valid; false otherwise. */
636 parse_source_list_line(tchar *line, size_t len,
637 struct wimlib_capture_source *source)
641 ret = parse_string(&line, &len, &source->fs_source_path);
642 if (ret != PARSE_STRING_SUCCESS)
644 ret = parse_string(&line, &len, &source->wim_target_path);
645 if (ret == PARSE_STRING_NONE)
646 source->wim_target_path = source->fs_source_path;
647 return ret != PARSE_STRING_FAILURE;
650 /* Returns %true if the given line of length @len > 0 is a comment or empty line
651 * in the source list file format. */
653 is_comment_line(const tchar *line, size_t len)
658 if (!istspace(*line) && *line != T('\0'))
668 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
671 tchar *contents = *contents_p;
672 size_t nchars = *nchars_p;
675 for (i = 0; i < nchars; i++)
676 if (contents[i] == T('\n'))
679 /* Handle last line not terminated by a newline */
680 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
681 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
683 imagex_error(T("Out of memory!"));
686 contents[nchars] = T('\n');
687 *contents_p = contents;
695 /* Parses a file in the source list format. (See the man page for
696 * 'wimlib-imagex capture' for details on this format and the meaning.)
698 * @source_list_contents: Contents of the source list file. Note that this
699 * buffer will be modified to save memory allocations,
700 * and cannot be freed until the returned array of
701 * wimlib_capture_source's has also been freed.
703 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
706 * @nsources_ret: On success, the length of the returned array is
709 * Returns: An array of `struct wimlib_capture_source's that can be passed to
710 * the wimlib_add_image_multisource() function to specify how a WIM image is to
712 static struct wimlib_capture_source *
713 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
714 size_t *nsources_ret)
718 struct wimlib_capture_source *sources;
721 nlines = text_file_count_lines(source_list_contents_p,
722 &source_list_nchars);
726 /* Always allocate at least 1 slot, just in case the implementation of
727 * calloc() returns NULL if 0 bytes are requested. */
728 sources = calloc(nlines ?: 1, sizeof(*sources));
730 imagex_error(T("out of memory"));
733 p = *source_list_contents_p;
735 for (i = 0; i < nlines; i++) {
736 /* XXX: Could use rawmemchr() here instead, but it may not be
737 * available on all platforms. */
738 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
739 size_t len = endp - p + 1;
741 if (!is_comment_line(p, len)) {
742 if (!parse_source_list_line(p, len, &sources[j++])) {
755 enum capture_config_section {
756 CAPTURE_CONFIG_NO_SECTION,
757 CAPTURE_CONFIG_EXCLUSION_SECTION,
758 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
759 CAPTURE_CONFIG_IGNORE_SECTION,
763 CAPTURE_CONFIG_INVALID_SECTION,
764 CAPTURE_CONFIG_CHANGED_SECTION,
765 CAPTURE_CONFIG_SAME_SECTION,
769 check_config_section(tchar *line, size_t len,
770 enum capture_config_section *cur_section)
772 while (istspace(*line))
776 return CAPTURE_CONFIG_SAME_SECTION;
779 tchar *endbrace = tstrrchr(line, T(']'));
781 return CAPTURE_CONFIG_SAME_SECTION;
783 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
784 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
785 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
786 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
787 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
788 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
789 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
790 "of capture config file\n"),
792 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
793 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
794 tfputs(T("WARNING: Ignoring [AlignmentList] section "
795 "of capture config file\n"),
798 imagex_error(T("Invalid capture config file section \"%"TS"\""),
800 return CAPTURE_CONFIG_INVALID_SECTION;
802 return CAPTURE_CONFIG_CHANGED_SECTION;
807 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
810 if (pat_list->num_pats == pat_list->num_allocated_pats) {
812 size_t num_allocated_pats = pat_list->num_pats + 8;
814 pats = realloc(pat_list->pats,
815 num_allocated_pats * sizeof(pat_list->pats[0]));
817 imagex_error(T("Out of memory!"));
820 pat_list->pats = pats;
821 pat_list->num_allocated_pats = num_allocated_pats;
823 pat_list->pats[pat_list->num_pats++] = pat;
828 parse_capture_config_line(tchar *line, size_t len,
829 enum capture_config_section *cur_section,
830 struct wimlib_capture_config *config)
835 ret = check_config_section(line, len, cur_section);
836 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
838 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
841 switch (*cur_section) {
842 case CAPTURE_CONFIG_NO_SECTION:
843 imagex_error(T("Line \"%"TS"\" is not in a section "
844 "(such as [ExclusionList]"), line);
846 case CAPTURE_CONFIG_EXCLUSION_SECTION:
847 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
849 return pattern_list_add_pattern(&config->exclusion_pats,
851 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
852 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
854 return pattern_list_add_pattern(&config->exclusion_exception_pats,
856 case CAPTURE_CONFIG_IGNORE_SECTION:
863 parse_capture_config(tchar **contents_p, size_t nchars,
864 struct wimlib_capture_config *config)
869 enum capture_config_section cur_section;
871 memset(config, 0, sizeof(*config));
873 nlines = text_file_count_lines(contents_p, &nchars);
877 cur_section = CAPTURE_CONFIG_NO_SECTION;
879 for (i = 0; i < nlines; i++) {
880 tchar *endp = tmemchr(p, T('\n'), nchars);
881 size_t len = endp - p + 1;
883 if (!is_comment_line(p, len))
884 if (!parse_capture_config_line(p, len, &cur_section, config))
892 /* Reads the contents of a file into memory. */
894 file_get_contents(const tchar *filename, size_t *len_ret)
901 if (tstat(filename, &stbuf) != 0) {
902 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
907 fp = tfopen(filename, T("rb"));
909 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
913 buf = malloc(len ? len : 1);
915 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
916 "contents of file \"%"TS"\""), len, filename);
919 if (fread(buf, 1, len, fp) != len) {
920 imagex_error_with_errno(T("Failed to read %zu bytes from the "
921 "file \"%"TS"\""), len, filename);
935 /* Read standard input until EOF and return the full contents in a malloc()ed
936 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
939 stdin_get_contents(size_t *len_ret)
941 /* stdin can, of course, be a pipe or other non-seekable file, so the
942 * total length of the data cannot be pre-determined */
944 size_t newlen = 1024;
948 char *p = realloc(buf, newlen);
949 size_t bytes_read, bytes_to_read;
951 imagex_error(T("out of memory while reading stdin"));
955 bytes_to_read = newlen - pos;
956 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
958 if (bytes_read != bytes_to_read) {
963 imagex_error_with_errno(T("error reading stdin"));
977 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
980 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
982 *num_tchars_ret = num_bytes;
984 #else /* !__WIN32__ */
985 /* On Windows, translate the text to UTF-16LE */
989 if (num_bytes >= 2 &&
990 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
991 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
993 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
994 * with something that looks like an ASCII character encoded as
995 * a UTF-16LE code unit. Assume the file is encoded as
996 * UTF-16LE. This is not a 100% reliable check. */
997 num_wchars = num_bytes / 2;
998 text_wstr = (wchar_t*)text;
1000 /* File does not look like UTF-16LE. Assume it is encoded in
1001 * the current Windows code page. I think these are always
1002 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
1003 * should work as expected. */
1004 text_wstr = win32_mbs_to_wcs(text,
1009 *num_tchars_ret = num_wchars;
1011 #endif /* __WIN32__ */
1015 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1020 contents = file_get_contents(filename, &num_bytes);
1023 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1027 stdin_get_text_contents(size_t *num_tchars_ret)
1032 contents = stdin_get_contents(&num_bytes);
1035 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1038 #define TO_PERCENT(numerator, denominator) \
1039 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1041 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1042 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1043 #define KIBIBYTE_MIN_NBYTES 10000ULL
1046 get_unit(uint64_t total_bytes, const tchar **name_ret)
1048 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1049 *name_ret = T("GiB");
1051 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1052 *name_ret = T("MiB");
1054 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1055 *name_ret = T("KiB");
1058 *name_ret = T("bytes");
1063 static struct wimlib_progress_info_scan last_scan_progress;
1066 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1068 uint64_t prev_count, cur_count;
1070 prev_count = last_scan_progress.num_nondirs_scanned +
1071 last_scan_progress.num_dirs_scanned;
1072 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1074 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1075 cur_count % 128 == 0)
1077 unsigned unit_shift;
1078 const tchar *unit_name;
1080 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1081 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1082 "%"PRIu64" directories)"),
1083 scan->num_bytes_scanned >> unit_shift,
1085 scan->num_nondirs_scanned,
1086 scan->num_dirs_scanned);
1087 last_scan_progress = *scan;
1091 /* Progress callback function passed to various wimlib functions. */
1093 imagex_progress_func(enum wimlib_progress_msg msg,
1094 const union wimlib_progress_info *info)
1096 unsigned percent_done;
1097 unsigned unit_shift;
1098 const tchar *unit_name;
1100 if (imagex_be_quiet)
1103 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1104 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1105 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1106 info->write_streams.total_bytes);
1108 if (info->write_streams.completed_streams == 0) {
1109 imagex_printf(T("Writing %"TS"-compressed data using %u thread%"TS"\n"),
1110 wimlib_get_compression_type_string(info->write_streams.compression_type),
1111 info->write_streams.num_threads,
1112 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1114 if (info->write_streams.total_parts <= 1) {
1115 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1116 "written (%u%% done)"),
1117 info->write_streams.completed_bytes >> unit_shift,
1119 info->write_streams.total_bytes >> unit_shift,
1123 imagex_printf(T("\rWriting resources from part %u of %u: "
1124 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1125 (info->write_streams.completed_parts ==
1126 info->write_streams.total_parts) ?
1127 info->write_streams.completed_parts :
1128 info->write_streams.completed_parts + 1,
1129 info->write_streams.total_parts,
1130 info->write_streams.completed_bytes >> unit_shift,
1132 info->write_streams.total_bytes >> unit_shift,
1136 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1137 imagex_printf(T("\n"));
1139 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1140 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1141 if (*info->scan.wim_target_path) {
1142 imagex_printf(T(" (loading as WIM path: "
1143 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1144 info->scan.wim_target_path);
1146 imagex_printf(T("\n"));
1148 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1150 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1151 switch (info->scan.status) {
1152 case WIMLIB_SCAN_DENTRY_OK:
1153 report_scan_progress(&info->scan, false);
1155 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1156 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1158 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1159 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1160 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1164 case WIMLIB_PROGRESS_MSG_SCAN_END:
1165 report_scan_progress(&info->scan, true);
1166 imagex_printf(T("\n"));
1168 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1169 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1170 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1171 info->integrity.total_bytes);
1172 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1173 "of %"PRIu64" %"TS" (%u%%) done"),
1174 info->integrity.filename,
1175 info->integrity.completed_bytes >> unit_shift,
1177 info->integrity.total_bytes >> unit_shift,
1180 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1181 imagex_printf(T("\n"));
1183 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1184 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1185 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1186 info->integrity.total_bytes);
1187 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1188 "of %"PRIu64" %"TS" (%u%%) done"),
1189 info->integrity.completed_bytes >> unit_shift,
1191 info->integrity.total_bytes >> unit_shift,
1194 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1195 imagex_printf(T("\n"));
1197 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1198 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1199 "to %"TS" \"%"TS"\"\n"),
1200 info->extract.image,
1201 info->extract.image_name,
1202 info->extract.wimfile_name,
1203 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1204 T("NTFS volume") : T("directory")),
1205 info->extract.target);
1207 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1208 imagex_printf(T("Extracting "
1209 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1210 "in \"%"TS"\" to \"%"TS"\"\n"),
1211 info->extract.extract_root_wim_source_path,
1212 info->extract.image,
1213 info->extract.image_name,
1214 info->extract.wimfile_name,
1215 info->extract.target);
1217 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1218 percent_done = TO_PERCENT(info->extract.completed_bytes,
1219 info->extract.total_bytes);
1220 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1221 imagex_printf(T("\rExtracting files: "
1222 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1223 info->extract.completed_bytes >> unit_shift,
1225 info->extract.total_bytes >> unit_shift,
1228 if (info->extract.completed_bytes >= info->extract.total_bytes)
1229 imagex_printf(T("\n"));
1231 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1232 if (info->extract.total_parts != 1) {
1233 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1234 info->extract.part_number,
1235 info->extract.total_parts);
1238 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1239 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1240 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1242 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1243 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1244 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1245 info->extract.target);
1248 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1249 percent_done = TO_PERCENT(info->split.completed_bytes,
1250 info->split.total_bytes);
1251 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1252 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1253 "%"PRIu64" %"TS" (%u%%) written\n"),
1254 info->split.part_name,
1255 info->split.cur_part_number,
1256 info->split.total_parts,
1257 info->split.completed_bytes >> unit_shift,
1259 info->split.total_bytes >> unit_shift,
1263 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1264 if (info->split.completed_bytes == info->split.total_bytes) {
1265 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1266 info->split.cur_part_number,
1267 info->split.total_parts);
1270 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1271 switch (info->update.command->op) {
1272 case WIMLIB_UPDATE_OP_DELETE:
1273 imagex_printf(T("Deleted WIM path "
1274 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1275 info->update.command->delete_.wim_path);
1277 case WIMLIB_UPDATE_OP_RENAME:
1278 imagex_printf(T("Renamed WIM path "
1279 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1280 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1281 info->update.command->rename.wim_source_path,
1282 info->update.command->rename.wim_target_path);
1284 case WIMLIB_UPDATE_OP_ADD:
1292 fflush(imagex_info_file);
1297 parse_num_threads(const tchar *optarg)
1300 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1301 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1302 imagex_error(T("Number of threads must be a non-negative integer!"));
1309 static uint32_t parse_chunk_size(const tchar *optarg)
1312 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1313 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1314 imagex_error(T("Chunk size must be a non-negative integer!"));
1323 * Parse an option passed to an update command.
1325 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1328 * @option: Text string for the option (beginning with --)
1330 * @cmd: `struct wimlib_update_command' that is being constructed for
1333 * Returns true if the option was recognized; false if not.
1336 update_command_add_option(int op, const tchar *option,
1337 struct wimlib_update_command *cmd)
1339 bool recognized = true;
1341 case WIMLIB_UPDATE_OP_ADD:
1342 if (!tstrcmp(option, T("--verbose")))
1343 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1344 else if (!tstrcmp(option, T("--unix-data")))
1345 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1346 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1347 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1348 else if (!tstrcmp(option, T("--strict-acls")))
1349 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1350 else if (!tstrcmp(option, T("--dereference")))
1351 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1355 case WIMLIB_UPDATE_OP_DELETE:
1356 if (!tstrcmp(option, T("--force")))
1357 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1358 else if (!tstrcmp(option, T("--recursive")))
1359 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1370 /* How many nonoption arguments each `imagex update' command expects */
1371 static const unsigned update_command_num_nonoptions[] = {
1372 [WIMLIB_UPDATE_OP_ADD] = 2,
1373 [WIMLIB_UPDATE_OP_DELETE] = 1,
1374 [WIMLIB_UPDATE_OP_RENAME] = 2,
1378 update_command_add_nonoption(int op, const tchar *nonoption,
1379 struct wimlib_update_command *cmd,
1380 unsigned num_nonoptions)
1383 case WIMLIB_UPDATE_OP_ADD:
1384 if (num_nonoptions == 0)
1385 cmd->add.fs_source_path = (tchar*)nonoption;
1387 cmd->add.wim_target_path = (tchar*)nonoption;
1389 case WIMLIB_UPDATE_OP_DELETE:
1390 cmd->delete_.wim_path = (tchar*)nonoption;
1392 case WIMLIB_UPDATE_OP_RENAME:
1393 if (num_nonoptions == 0)
1394 cmd->rename.wim_source_path = (tchar*)nonoption;
1396 cmd->rename.wim_target_path = (tchar*)nonoption;
1402 * Parse a command passed on stdin to `imagex update'.
1404 * @line: Text of the command.
1405 * @len: Length of the line, including a null terminator
1408 * @command: A `struct wimlib_update_command' to fill in from the parsed
1411 * @line_number: Line number of the command, for diagnostics.
1413 * Returns true on success; returns false on parse error.
1416 parse_update_command(tchar *line, size_t len,
1417 struct wimlib_update_command *command,
1421 tchar *command_name;
1423 size_t num_nonoptions;
1425 /* Get the command name ("add", "delete", "rename") */
1426 ret = parse_string(&line, &len, &command_name);
1427 if (ret != PARSE_STRING_SUCCESS)
1430 if (!tstrcasecmp(command_name, T("add"))) {
1431 op = WIMLIB_UPDATE_OP_ADD;
1432 } else if (!tstrcasecmp(command_name, T("delete"))) {
1433 op = WIMLIB_UPDATE_OP_DELETE;
1434 } else if (!tstrcasecmp(command_name, T("rename"))) {
1435 op = WIMLIB_UPDATE_OP_RENAME;
1437 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1438 command_name, line_number);
1443 /* Parse additional options and non-options as needed */
1448 ret = parse_string(&line, &len, &next_string);
1449 if (ret == PARSE_STRING_NONE) /* End of line */
1451 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1453 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1455 if (!update_command_add_option(op, next_string, command))
1457 imagex_error(T("Unrecognized option \"%"TS"\" to "
1458 "update command \"%"TS"\" on line %zu"),
1459 next_string, command_name, line_number);
1465 if (num_nonoptions == update_command_num_nonoptions[op])
1467 imagex_error(T("Unexpected argument \"%"TS"\" in "
1468 "update command on line %zu\n"
1469 " (The \"%"TS"\" command only "
1470 "takes %zu nonoption arguments!)\n"),
1471 next_string, line_number,
1472 command_name, num_nonoptions);
1475 update_command_add_nonoption(op, next_string,
1476 command, num_nonoptions);
1481 if (num_nonoptions != update_command_num_nonoptions[op]) {
1482 imagex_error(T("Not enough arguments to update command "
1483 "\"%"TS"\" on line %zu"), command_name, line_number);
1489 static struct wimlib_update_command *
1490 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1491 size_t *num_cmds_ret)
1495 struct wimlib_update_command *cmds;
1498 nlines = text_file_count_lines(cmd_file_contents_p,
1503 /* Always allocate at least 1 slot, just in case the implementation of
1504 * calloc() returns NULL if 0 bytes are requested. */
1505 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1507 imagex_error(T("out of memory"));
1510 p = *cmd_file_contents_p;
1512 for (i = 0; i < nlines; i++) {
1513 /* XXX: Could use rawmemchr() here instead, but it may not be
1514 * available on all platforms. */
1515 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1516 size_t len = endp - p + 1;
1518 if (!is_comment_line(p, len)) {
1519 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1530 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1531 * one image from a WIM file to a NTFS volume. */
1533 imagex_apply(int argc, tchar **argv, int cmd)
1537 int image = WIMLIB_NO_IMAGE;
1539 struct wimlib_wim_info info;
1541 const tchar *wimfile;
1542 const tchar *target;
1543 const tchar *image_num_or_name = NULL;
1544 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1546 STRING_SET(refglobs);
1548 for_opt(c, apply_options) {
1550 case IMAGEX_CHECK_OPTION:
1551 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1553 case IMAGEX_HARDLINK_OPTION:
1554 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1556 case IMAGEX_SYMLINK_OPTION:
1557 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1559 case IMAGEX_VERBOSE_OPTION:
1560 /* No longer does anything. */
1562 case IMAGEX_REF_OPTION:
1563 ret = string_set_append(&refglobs, optarg);
1565 goto out_free_refglobs;
1567 case IMAGEX_UNIX_DATA_OPTION:
1568 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1570 case IMAGEX_NO_ACLS_OPTION:
1571 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1573 case IMAGEX_STRICT_ACLS_OPTION:
1574 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1576 case IMAGEX_NORPFIX_OPTION:
1577 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1579 case IMAGEX_RPFIX_OPTION:
1580 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1582 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1583 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1584 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1586 case IMAGEX_RESUME_OPTION:
1587 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1595 if (argc != 2 && argc != 3)
1600 if (!tstrcmp(wimfile, T("-"))) {
1601 /* Attempt to apply pipable WIM from standard input. */
1603 image_num_or_name = NULL;
1606 image_num_or_name = argv[1];
1611 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1612 imagex_progress_func);
1614 goto out_free_refglobs;
1616 wimlib_get_wim_info(wim, &info);
1619 /* Image explicitly specified. */
1620 image_num_or_name = argv[1];
1621 image = wimlib_resolve_image(wim, image_num_or_name);
1622 ret = verify_image_exists(image, image_num_or_name, wimfile);
1624 goto out_wimlib_free;
1627 /* No image specified; default to image 1, but only if the WIM
1628 * contains exactly one image. */
1630 if (info.image_count != 1) {
1631 imagex_error(T("\"%"TS"\" contains %d images; "
1632 "Please select one (or all)."),
1633 wimfile, info.image_count);
1642 if (refglobs.num_strings) {
1644 imagex_error(T("Can't specify --ref when applying from stdin!"));
1646 goto out_wimlib_free;
1648 ret = wim_reference_globs(wim, &refglobs, open_flags);
1650 goto out_wimlib_free;
1655 /* Interpret a regular file or block device target as a NTFS
1659 if (tstat(target, &stbuf)) {
1660 if (errno != ENOENT) {
1661 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1664 goto out_wimlib_free;
1667 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1668 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1674 ret = wimlib_extract_image(wim, image, target, extract_flags,
1675 imagex_progress_func);
1677 set_fd_to_binary_mode(STDIN_FILENO);
1678 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1680 target, extract_flags,
1681 imagex_progress_func);
1684 imagex_printf(T("Done applying WIM image.\n"));
1685 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1687 do_resource_not_found_warning(wimfile, &info, &refglobs);
1689 imagex_error(T( "If you are applying an image "
1690 "from a split pipable WIM,\n"
1691 " make sure you have "
1692 "concatenated together all parts."));
1698 string_set_destroy(&refglobs);
1702 usage(CMD_APPLY, stderr);
1704 goto out_free_refglobs;
1707 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1708 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1709 * the desired image. 'wimlib-imagex append': add a new image to an existing
1712 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1715 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1716 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1717 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1718 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1719 int write_flags = 0;
1720 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1721 uint32_t chunk_size = UINT32_MAX;
1722 const tchar *wimfile;
1726 const tchar *flags_element = NULL;
1729 STRING_SET(base_wimfiles);
1730 WIMStruct **base_wims;
1732 WIMStruct *template_wim;
1733 const tchar *template_wimfile = NULL;
1734 const tchar *template_image_name_or_num = NULL;
1735 int template_image = WIMLIB_NO_IMAGE;
1738 unsigned num_threads = 0;
1743 const tchar *config_file = NULL;
1745 struct wimlib_capture_config *config;
1747 bool source_list = false;
1748 size_t source_list_nchars = 0;
1749 tchar *source_list_contents;
1750 bool capture_sources_malloced;
1751 struct wimlib_capture_source *capture_sources;
1753 bool name_defaulted;
1755 for_opt(c, capture_or_append_options) {
1757 case IMAGEX_BOOT_OPTION:
1758 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1760 case IMAGEX_CHECK_OPTION:
1761 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1762 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1764 case IMAGEX_NOCHECK_OPTION:
1765 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1767 case IMAGEX_CONFIG_OPTION:
1768 config_file = optarg;
1769 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1771 case IMAGEX_COMPRESS_OPTION:
1772 compression_type = get_compression_type(optarg);
1773 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1776 case IMAGEX_COMPRESS_SLOW_OPTION:
1777 ret = set_compress_slow();
1780 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1782 case IMAGEX_CHUNK_SIZE_OPTION:
1783 chunk_size = parse_chunk_size(optarg);
1784 if (chunk_size == UINT32_MAX)
1787 case IMAGEX_PACK_STREAMS_OPTION:
1788 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1790 case IMAGEX_FLAGS_OPTION:
1791 flags_element = optarg;
1793 case IMAGEX_DEREFERENCE_OPTION:
1794 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1796 case IMAGEX_VERBOSE_OPTION:
1797 /* No longer does anything. */
1799 case IMAGEX_THREADS_OPTION:
1800 num_threads = parse_num_threads(optarg);
1801 if (num_threads == UINT_MAX)
1804 case IMAGEX_REBUILD_OPTION:
1805 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1807 case IMAGEX_UNIX_DATA_OPTION:
1808 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1810 case IMAGEX_SOURCE_LIST_OPTION:
1813 case IMAGEX_NO_ACLS_OPTION:
1814 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1816 case IMAGEX_STRICT_ACLS_OPTION:
1817 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1819 case IMAGEX_RPFIX_OPTION:
1820 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1822 case IMAGEX_NORPFIX_OPTION:
1823 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1825 case IMAGEX_PIPABLE_OPTION:
1826 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1828 case IMAGEX_NOT_PIPABLE_OPTION:
1829 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1831 case IMAGEX_UPDATE_OF_OPTION:
1832 if (template_image_name_or_num) {
1833 imagex_error(T("'--update-of' can only be "
1834 "specified one time!"));
1838 colon = tstrrchr(optarg, T(':'));
1841 template_wimfile = optarg;
1843 template_image_name_or_num = colon + 1;
1845 template_wimfile = NULL;
1846 template_image_name_or_num = optarg;
1850 case IMAGEX_DELTA_FROM_OPTION:
1851 if (cmd != CMD_CAPTURE) {
1852 imagex_error(T("'--delta-from' is only "
1853 "valid for capture!"));
1856 ret = string_set_append(&base_wimfiles, optarg);
1858 goto out_free_base_wimfiles;
1859 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1868 if (argc < 2 || argc > 4)
1874 /* Set default compression type. */
1875 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1876 struct wimlib_lzx_compressor_params params;
1877 memset(¶ms, 0, sizeof(params));
1878 params.hdr.size = sizeof(params);
1879 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1880 params.use_defaults = 1;
1882 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1884 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1887 if (!tstrcmp(wimfile, T("-"))) {
1888 /* Writing captured WIM to standard output. */
1890 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1891 imagex_error("Can't write a non-pipable WIM to "
1892 "standard output! Specify --pipable\n"
1893 " if you want to create a pipable WIM "
1894 "(but read the docs first).");
1898 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1900 if (cmd == CMD_APPEND) {
1901 imagex_error(T("Using standard output for append does "
1902 "not make sense."));
1905 wim_fd = STDOUT_FILENO;
1907 imagex_info_file = stderr;
1908 set_fd_to_binary_mode(wim_fd);
1911 /* If template image was specified using --update-of=IMAGE rather
1912 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1913 if (template_image_name_or_num && !template_wimfile) {
1914 if (base_wimfiles.num_strings == 1) {
1915 /* Capturing delta WIM based on single WIM: default to
1917 template_wimfile = base_wimfiles.strings[0];
1918 } else if (cmd == CMD_APPEND) {
1919 /* Appending to WIM: default to WIM being appended to.
1921 template_wimfile = wimfile;
1923 /* Capturing a normal (non-delta) WIM, so the WIM file
1924 * *must* be explicitly specified. */
1925 if (base_wimfiles.num_strings > 1) {
1926 imagex_error(T("For capture of delta WIM "
1927 "based on multiple existing "
1929 " '--update-of' must "
1930 "specify WIMFILE:IMAGE!"));
1932 imagex_error(T("For capture of non-delta WIM, "
1933 "'--update-of' must specify "
1942 name_defaulted = false;
1944 /* Set default name to SOURCE argument, omitting any directory
1945 * prefixes and trailing slashes. This requires making a copy
1946 * of @source. Leave some free characters at the end in case we
1947 * append a number to keep the name unique. */
1948 size_t source_name_len;
1950 source_name_len = tstrlen(source);
1951 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1952 name = tbasename(tstrcpy(source_copy, source));
1953 name_defaulted = true;
1955 /* Image description defaults to NULL if not given. */
1962 /* Set up capture sources in source list mode */
1963 if (source[0] == T('-') && source[1] == T('\0')) {
1964 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1966 source_list_contents = file_get_text_contents(source,
1967 &source_list_nchars);
1969 if (!source_list_contents)
1972 capture_sources = parse_source_list(&source_list_contents,
1975 if (!capture_sources) {
1977 goto out_free_source_list_contents;
1979 capture_sources_malloced = true;
1981 /* Set up capture source in non-source-list mode. */
1982 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1983 capture_sources[0].fs_source_path = source;
1984 capture_sources[0].wim_target_path = NULL;
1985 capture_sources[0].reserved = 0;
1987 capture_sources_malloced = false;
1988 source_list_contents = NULL;
1992 /* Read and parse capture configuration file. */
1995 config_str = file_get_text_contents(config_file, &config_len);
1998 goto out_free_capture_sources;
2001 config = alloca(sizeof(*config));
2002 ret = parse_capture_config(&config_str, config_len, config);
2004 goto out_free_config;
2006 /* No capture configuration file specified; use default
2007 * configuration for capturing Windows operating systems. */
2009 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
2012 /* Open the existing WIM, or create a new one. */
2013 if (cmd == CMD_APPEND)
2014 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2015 imagex_progress_func);
2017 ret = wimlib_create_new_wim(compression_type, &wim);
2019 goto out_free_config;
2021 /* Set chunk size if non-default. */
2022 if (chunk_size != UINT32_MAX) {
2023 ret = wimlib_set_output_chunk_size(wim, chunk_size);
2029 /* Detect if source is regular file or block device and set NTFS volume
2034 if (tstat(source, &stbuf) == 0) {
2035 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2036 imagex_printf(T("Capturing WIM image from NTFS "
2037 "filesystem on \"%"TS"\"\n"), source);
2038 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
2041 if (errno != ENOENT) {
2042 imagex_error_with_errno(T("Failed to stat "
2043 "\"%"TS"\""), source);
2051 /* If the user did not specify an image name, and the basename of the
2052 * source already exists as an image name in the WIM file, append a
2053 * suffix to make it unique. */
2054 if (cmd == CMD_APPEND && name_defaulted) {
2055 unsigned long conflict_idx;
2056 tchar *name_end = tstrchr(name, T('\0'));
2057 for (conflict_idx = 1;
2058 wimlib_image_name_in_use(wim, name);
2061 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2065 /* If capturing a delta WIM, reference resources from the base WIMs
2066 * before adding the new image. */
2067 if (base_wimfiles.num_strings) {
2068 base_wims = calloc(base_wimfiles.num_strings,
2069 sizeof(base_wims[0]));
2070 if (base_wims == NULL) {
2071 imagex_error(T("Out of memory!"));
2076 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2077 ret = wimlib_open_wim(base_wimfiles.strings[i],
2078 open_flags, &base_wims[i],
2079 imagex_progress_func);
2081 goto out_free_base_wims;
2085 ret = wimlib_reference_resources(wim, base_wims,
2086 base_wimfiles.num_strings, 0);
2088 goto out_free_base_wims;
2090 if (base_wimfiles.num_strings == 1) {
2091 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2092 base_wimfiles.strings[0]);
2094 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2095 base_wimfiles.num_strings);
2102 /* If capturing or appending as an update of an existing (template) image,
2103 * open the WIM if needed and parse the image index. */
2104 if (template_image_name_or_num) {
2107 if (base_wimfiles.num_strings == 1 &&
2108 template_wimfile == base_wimfiles.strings[0]) {
2109 template_wim = base_wims[0];
2110 } else if (template_wimfile == wimfile) {
2113 ret = wimlib_open_wim(template_wimfile, open_flags,
2114 &template_wim, imagex_progress_func);
2116 goto out_free_base_wims;
2119 template_image = wimlib_resolve_image(template_wim,
2120 template_image_name_or_num);
2122 if (template_image_name_or_num[0] == T('-')) {
2125 struct wimlib_wim_info info;
2127 wimlib_get_wim_info(template_wim, &info);
2128 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2129 if (n >= 1 && n <= info.image_count &&
2131 tmp != template_image_name_or_num + 1)
2133 template_image = info.image_count - (n - 1);
2136 ret = verify_image_exists_and_is_single(template_image,
2137 template_image_name_or_num,
2140 goto out_free_template_wim;
2142 template_wim = NULL;
2145 ret = wimlib_add_image_multisource(wim,
2151 imagex_progress_func);
2153 goto out_free_template_wim;
2155 if (desc || flags_element || template_image_name_or_num) {
2156 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2157 * on which the added one is to be based has been specified with
2158 * --update-of. Get the index of the image we just
2159 * added, then use it to call the appropriate functions. */
2160 struct wimlib_wim_info info;
2162 wimlib_get_wim_info(wim, &info);
2165 ret = wimlib_set_image_descripton(wim,
2169 goto out_free_template_wim;
2172 if (flags_element) {
2173 ret = wimlib_set_image_flags(wim, info.image_count,
2176 goto out_free_template_wim;
2179 /* Reference template image if the user provided one. */
2180 if (template_image_name_or_num) {
2181 imagex_printf(T("Using image %d "
2182 "from \"%"TS"\" as template\n"),
2183 template_image, template_wimfile);
2184 ret = wimlib_reference_template_image(wim,
2190 goto out_free_template_wim;
2194 /* Write the new WIM or overwrite the existing WIM with the new image
2196 if (cmd == CMD_APPEND) {
2197 ret = wimlib_overwrite(wim, write_flags, num_threads,
2198 imagex_progress_func);
2199 } else if (wimfile) {
2200 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2201 write_flags, num_threads,
2202 imagex_progress_func);
2204 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2205 write_flags, num_threads,
2206 imagex_progress_func);
2208 out_free_template_wim:
2209 /* template_wim may alias base_wims[0] or wim. */
2210 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2211 template_wim != wim)
2212 wimlib_free(template_wim);
2214 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2215 wimlib_free(base_wims[i]);
2221 free(config->exclusion_pats.pats);
2222 free(config->exclusion_exception_pats.pats);
2225 out_free_capture_sources:
2226 if (capture_sources_malloced)
2227 free(capture_sources);
2228 out_free_source_list_contents:
2229 free(source_list_contents);
2230 out_free_base_wimfiles:
2231 string_set_destroy(&base_wimfiles);
2238 goto out_free_base_wimfiles;
2241 /* Remove image(s) from a WIM. */
2243 imagex_delete(int argc, tchar **argv, int cmd)
2246 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2247 int write_flags = 0;
2248 const tchar *wimfile;
2249 const tchar *image_num_or_name;
2254 for_opt(c, delete_options) {
2256 case IMAGEX_CHECK_OPTION:
2257 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2258 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2260 case IMAGEX_SOFT_OPTION:
2261 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2272 imagex_error(T("Must specify a WIM file"));
2274 imagex_error(T("Must specify an image"));
2278 image_num_or_name = argv[1];
2280 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2281 imagex_progress_func);
2285 image = wimlib_resolve_image(wim, image_num_or_name);
2287 ret = verify_image_exists(image, image_num_or_name, wimfile);
2289 goto out_wimlib_free;
2291 ret = wimlib_delete_image(wim, image);
2293 imagex_error(T("Failed to delete image from \"%"TS"\""),
2295 goto out_wimlib_free;
2298 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2300 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2301 "deleted"), wimfile);
2309 usage(CMD_DELETE, stderr);
2315 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2317 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2318 return (ret >= 0) ? 0 : -1;
2321 /* Print the files contained in an image(s) in a WIM file. */
2323 imagex_dir(int argc, tchar **argv, int cmd)
2325 const tchar *wimfile;
2326 WIMStruct *wim = NULL;
2329 const tchar *path = T("");
2332 for_opt(c, dir_options) {
2334 case IMAGEX_PATH_OPTION:
2345 imagex_error(T("Must specify a WIM file"));
2349 imagex_error(T("Too many arguments"));
2354 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2359 image = wimlib_resolve_image(wim, argv[1]);
2360 ret = verify_image_exists(image, argv[1], wimfile);
2362 goto out_wimlib_free;
2364 /* No image specified; default to image 1, but only if the WIM
2365 * contains exactly one image. */
2367 struct wimlib_wim_info info;
2369 wimlib_get_wim_info(wim, &info);
2370 if (info.image_count != 1) {
2371 imagex_error(T("\"%"TS"\" contains %d images; Please "
2372 "select one (or all)."),
2373 wimfile, info.image_count);
2380 ret = wimlib_iterate_dir_tree(wim, image, path,
2381 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2382 print_full_path, NULL);
2389 usage(CMD_DIR, stderr);
2394 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2397 imagex_export(int argc, tchar **argv, int cmd)
2401 int export_flags = 0;
2402 int write_flags = 0;
2403 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2404 const tchar *src_wimfile;
2405 const tchar *src_image_num_or_name;
2406 const tchar *dest_wimfile;
2408 const tchar *dest_name;
2409 const tchar *dest_desc;
2411 struct wimlib_wim_info src_info;
2412 WIMStruct *dest_wim;
2417 STRING_SET(refglobs);
2418 unsigned num_threads = 0;
2419 uint32_t chunk_size = UINT32_MAX;
2421 for_opt(c, export_options) {
2423 case IMAGEX_BOOT_OPTION:
2424 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2426 case IMAGEX_CHECK_OPTION:
2427 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2428 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2430 case IMAGEX_NOCHECK_OPTION:
2431 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2433 case IMAGEX_COMPRESS_OPTION:
2434 compression_type = get_compression_type(optarg);
2435 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2438 case IMAGEX_PACK_STREAMS_OPTION:
2439 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2441 case IMAGEX_CHUNK_SIZE_OPTION:
2442 chunk_size = parse_chunk_size(optarg);
2443 if (chunk_size == UINT32_MAX)
2446 case IMAGEX_REF_OPTION:
2447 ret = string_set_append(&refglobs, optarg);
2449 goto out_free_refglobs;
2451 case IMAGEX_THREADS_OPTION:
2452 num_threads = parse_num_threads(optarg);
2453 if (num_threads == UINT_MAX)
2456 case IMAGEX_REBUILD_OPTION:
2457 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2459 case IMAGEX_PIPABLE_OPTION:
2460 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2462 case IMAGEX_NOT_PIPABLE_OPTION:
2463 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2471 if (argc < 3 || argc > 5)
2473 src_wimfile = argv[0];
2474 src_image_num_or_name = argv[1];
2475 dest_wimfile = argv[2];
2476 dest_name = (argc >= 4) ? argv[3] : NULL;
2477 dest_desc = (argc >= 5) ? argv[4] : NULL;
2478 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2479 imagex_progress_func);
2481 goto out_free_refglobs;
2483 wimlib_get_wim_info(src_wim, &src_info);
2485 /* Determine if the destination is an existing file or not. If so, we
2486 * try to append the exported image(s) to it; otherwise, we create a new
2487 * WIM containing the exported image(s). Furthermore, determine if we
2488 * need to write a pipable WIM directly to standard output. */
2490 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2492 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2493 imagex_error("Can't write a non-pipable WIM to "
2494 "standard output! Specify --pipable\n"
2495 " if you want to create a pipable WIM "
2496 "(but read the docs first).");
2498 goto out_free_src_wim;
2501 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2503 dest_wimfile = NULL;
2504 dest_wim_fd = STDOUT_FILENO;
2505 imagex_info_file = stderr;
2506 set_fd_to_binary_mode(dest_wim_fd);
2509 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2511 /* Destination file exists. */
2513 if (!S_ISREG(stbuf.st_mode)) {
2514 imagex_error(T("\"%"TS"\" is not a regular file"),
2517 goto out_free_src_wim;
2519 ret = wimlib_open_wim(dest_wimfile,
2520 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2521 &dest_wim, imagex_progress_func);
2523 goto out_free_src_wim;
2525 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2526 /* The user specified a compression type, but we're
2527 * exporting to an existing WIM. Make sure the
2528 * specified compression type is the same as the
2529 * compression type of the existing destination WIM. */
2530 struct wimlib_wim_info dest_info;
2532 wimlib_get_wim_info(dest_wim, &dest_info);
2533 if (compression_type != dest_info.compression_type) {
2534 imagex_error(T("Cannot specify a compression type that is "
2535 "not the same as that used in the "
2536 "destination WIM"));
2538 goto out_free_dest_wim;
2544 if (errno != ENOENT) {
2545 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2548 goto out_free_src_wim;
2551 /* dest_wimfile is not an existing file, so create a new WIM. */
2553 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2554 /* The user did not specify a compression type; default
2555 * to that of the source WIM. */
2557 compression_type = src_info.compression_type;
2559 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2561 goto out_free_src_wim;
2563 /* Use same chunk size if compression type is the same. */
2564 if (compression_type == src_info.compression_type &&
2565 chunk_size == UINT32_MAX)
2566 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2569 if (chunk_size != UINT32_MAX) {
2570 /* Set destination chunk size. */
2571 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2573 goto out_free_dest_wim;
2576 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2577 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2579 goto out_free_dest_wim;
2581 if (refglobs.num_strings) {
2582 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2584 goto out_free_dest_wim;
2587 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2588 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2590 imagex_error(T("--boot specified for all-images export, but source WIM "
2591 "has no bootable image."));
2593 goto out_free_dest_wim;
2596 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2597 dest_desc, export_flags, imagex_progress_func);
2599 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2600 do_resource_not_found_warning(src_wimfile,
2601 &src_info, &refglobs);
2603 goto out_free_dest_wim;
2607 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2608 imagex_progress_func);
2609 else if (dest_wimfile)
2610 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2611 write_flags, num_threads,
2612 imagex_progress_func);
2614 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2615 WIMLIB_ALL_IMAGES, write_flags,
2616 num_threads, imagex_progress_func);
2618 wimlib_free(dest_wim);
2620 wimlib_free(src_wim);
2622 string_set_destroy(&refglobs);
2626 usage(CMD_EXPORT, stderr);
2629 goto out_free_refglobs;
2633 is_root_wim_path(const tchar *path)
2636 for (p = path; *p; p++)
2637 if (*p != T('\\') && *p != T('/'))
2643 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2644 const tchar *dest_dir)
2646 for (size_t i = 0; i < num_cmds; i++)
2647 if (cmds[i].fs_dest_path != dest_dir)
2648 free(cmds[i].fs_dest_path);
2652 static struct wimlib_extract_command *
2653 prepare_extract_commands(tchar **paths, unsigned num_paths,
2654 int extract_flags, tchar *dest_dir,
2655 size_t *num_cmds_ret)
2657 struct wimlib_extract_command *cmds;
2659 tchar *emptystr = T("");
2661 if (num_paths == 0) {
2665 num_cmds = num_paths;
2666 cmds = calloc(num_cmds, sizeof(cmds[0]));
2668 imagex_error(T("Out of memory!"));
2672 for (size_t i = 0; i < num_cmds; i++) {
2673 cmds[i].extract_flags = extract_flags;
2674 cmds[i].wim_source_path = paths[i];
2675 if (is_root_wim_path(paths[i])) {
2676 cmds[i].fs_dest_path = dest_dir;
2678 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2679 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2680 if (!cmds[i].fs_dest_path) {
2681 free_extract_commands(cmds, num_cmds, dest_dir);
2684 tsprintf(cmds[i].fs_dest_path,
2685 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2686 dest_dir, tbasename(paths[i]));
2689 *num_cmds_ret = num_cmds;
2693 /* Extract files or directories from a WIM image */
2695 imagex_extract(int argc, tchar **argv, int cmd)
2702 const tchar *wimfile;
2703 const tchar *image_num_or_name;
2704 const tchar *pathlist;
2705 tchar *dest_dir = T(".");
2706 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2707 int listfile_extract_flags = WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2709 STRING_SET(refglobs);
2711 struct wimlib_extract_command *cmds;
2714 for_opt(c, extract_options) {
2716 case IMAGEX_CHECK_OPTION:
2717 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2719 case IMAGEX_VERBOSE_OPTION:
2720 /* No longer does anything. */
2722 case IMAGEX_REF_OPTION:
2723 ret = string_set_append(&refglobs, optarg);
2725 goto out_free_refglobs;
2727 case IMAGEX_UNIX_DATA_OPTION:
2728 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2730 case IMAGEX_NO_ACLS_OPTION:
2731 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2733 case IMAGEX_STRICT_ACLS_OPTION:
2734 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2736 case IMAGEX_DEST_DIR_OPTION:
2739 case IMAGEX_TO_STDOUT_OPTION:
2740 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2741 imagex_info_file = stderr;
2742 imagex_be_quiet = true;
2744 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2745 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2746 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2748 case IMAGEX_NO_WILDCARDS_OPTION:
2749 listfile_extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2751 case IMAGEX_STRICT_WILDCARDS_OPTION:
2752 listfile_extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2765 image_num_or_name = argv[1];
2770 if (argc == 1 && argv[0][0] == T('@')) {
2771 pathlist = argv[0] + 1;
2775 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2782 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2786 image = wimlib_resolve_image(wim, image_num_or_name);
2787 ret = verify_image_exists_and_is_single(image,
2791 goto out_wimlib_free;
2793 if (refglobs.num_strings) {
2794 ret = wim_reference_globs(wim, &refglobs, open_flags);
2796 goto out_wimlib_free;
2800 if (ret == 0 && cmds != NULL) {
2801 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2802 imagex_progress_func);
2804 if (ret == 0 && pathlist != NULL) {
2805 ret = wimlib_extract_pathlist(wim, image, dest_dir,
2807 extract_flags | listfile_extract_flags,
2808 imagex_progress_func);
2811 if (!imagex_be_quiet)
2812 imagex_printf(T("Done extracting files.\n"));
2813 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2814 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2815 "files and directories\n"
2816 " are in the WIM image.\n"),
2817 get_cmd_string(CMD_DIR, false));
2818 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2819 struct wimlib_wim_info info;
2821 wimlib_get_wim_info(wim, &info);
2822 do_resource_not_found_warning(wimfile, &info, &refglobs);
2827 free_extract_commands(cmds, num_cmds, dest_dir);
2829 string_set_destroy(&refglobs);
2833 usage(CMD_EXTRACT, stderr);
2836 goto out_free_refglobs;
2839 static void print_byte_field(const uint8_t field[], size_t len)
2842 tprintf(T("%02hhx"), *field++);
2846 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2848 tputs(T("WIM Information:"));
2849 tputs(T("----------------"));
2850 tprintf(T("Path: %"TS"\n"), wimfile);
2851 tprintf(T("GUID: 0x"));
2852 print_byte_field(info->guid, sizeof(info->guid));
2854 tprintf(T("Version: %u\n"), info->wim_version);
2855 tprintf(T("Image Count: %d\n"), info->image_count);
2856 tprintf(T("Compression: %"TS"\n"),
2857 wimlib_get_compression_type_string(info->compression_type));
2858 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2860 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2861 tprintf(T("Boot Index: %d\n"), info->boot_index);
2862 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2863 tprintf(T("Integrity Info: %"TS"\n"),
2864 info->has_integrity_table ? T("yes") : T("no"));
2865 tprintf(T("Relative path junction: %"TS"\n"),
2866 info->has_rpfix ? T("yes") : T("no"));
2867 tprintf(T("Pipable: %"TS"\n"),
2868 info->pipable ? T("yes") : T("no"));
2873 print_resource(const struct wimlib_resource_entry *resource,
2876 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2877 resource->uncompressed_size);
2878 if (resource->packed) {
2879 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2880 resource->raw_resource_compressed_size);
2882 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2883 resource->raw_resource_offset_in_wim);
2885 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2888 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2889 resource->compressed_size);
2891 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2895 tprintf(T("Part Number = %u\n"), resource->part_number);
2896 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2898 tprintf(T("Hash = 0x"));
2899 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2902 tprintf(T("Flags = "));
2903 if (resource->is_compressed)
2904 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2905 if (resource->is_metadata)
2906 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2907 if (resource->is_free)
2908 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2909 if (resource->is_spanned)
2910 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2911 if (resource->packed)
2912 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2919 print_lookup_table(WIMStruct *wim)
2921 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2924 /* Prints information about a WIM file; also can mark an image as bootable,
2925 * change the name of an image, or change the description of an image. */
2927 imagex_info(int argc, tchar **argv, int cmd)
2932 bool nocheck = false;
2933 bool header = false;
2934 bool lookup_table = false;
2936 bool metadata = false;
2937 bool short_header = true;
2938 const tchar *xml_out_file = NULL;
2939 const tchar *wimfile;
2940 const tchar *image_num_or_name;
2941 const tchar *new_name;
2942 const tchar *new_desc;
2947 struct wimlib_wim_info info;
2949 for_opt(c, info_options) {
2951 case IMAGEX_BOOT_OPTION:
2954 case IMAGEX_CHECK_OPTION:
2957 case IMAGEX_NOCHECK_OPTION:
2960 case IMAGEX_HEADER_OPTION:
2962 short_header = false;
2964 case IMAGEX_LOOKUP_TABLE_OPTION:
2965 lookup_table = true;
2966 short_header = false;
2968 case IMAGEX_XML_OPTION:
2970 short_header = false;
2972 case IMAGEX_EXTRACT_XML_OPTION:
2973 xml_out_file = optarg;
2974 short_header = false;
2976 case IMAGEX_METADATA_OPTION:
2978 short_header = false;
2987 if (argc < 1 || argc > 4)
2991 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2992 new_name = (argc >= 3) ? argv[2] : NULL;
2993 new_desc = (argc >= 4) ? argv[3] : NULL;
2995 if (check && nocheck) {
2996 imagex_error(T("Can't specify both --check and --nocheck"));
3001 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3003 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3007 wimlib_get_wim_info(wim, &info);
3009 image = wimlib_resolve_image(wim, image_num_or_name);
3010 ret = WIMLIB_ERR_INVALID_IMAGE;
3011 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3012 verify_image_exists(image, image_num_or_name, wimfile);
3014 imagex_error(T("If you would like to set the boot "
3015 "index to 0, specify image \"0\" with "
3016 "the --boot flag."));
3018 goto out_wimlib_free;
3021 if (boot && info.image_count == 0) {
3022 imagex_error(T("--boot is meaningless on a WIM with no images"));
3023 goto out_wimlib_free;
3026 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3028 imagex_error(T("Cannot specify the --boot flag "
3029 "without specifying a specific "
3030 "image in a multi-image WIM"));
3031 goto out_wimlib_free;
3034 imagex_error(T("Cannot specify the NEW_NAME "
3035 "without specifying a specific "
3036 "image in a multi-image WIM"));
3037 goto out_wimlib_free;
3041 /* Operations that print information are separated from operations that
3042 * recreate the WIM file. */
3043 if (!new_name && !boot) {
3045 /* Read-only operations */
3047 if (image == WIMLIB_NO_IMAGE) {
3048 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3049 image_num_or_name, wimfile);
3050 goto out_wimlib_free;
3053 if (image == WIMLIB_ALL_IMAGES && short_header)
3054 print_wim_information(wimfile, &info);
3057 wimlib_print_header(wim);
3060 if (info.total_parts != 1) {
3061 tfprintf(stderr, T("Warning: Only showing the lookup table "
3062 "for part %d of a %d-part WIM.\n"),
3063 info.part_number, info.total_parts);
3065 print_lookup_table(wim);
3069 ret = wimlib_extract_xml_data(wim, stdout);
3071 goto out_wimlib_free;
3077 fp = tfopen(xml_out_file, T("wb"));
3079 imagex_error_with_errno(T("Failed to open the "
3080 "file \"%"TS"\" for "
3084 goto out_wimlib_free;
3086 ret = wimlib_extract_xml_data(wim, fp);
3088 imagex_error(T("Failed to close the file "
3094 goto out_wimlib_free;
3098 wimlib_print_available_images(wim, image);
3101 ret = wimlib_print_metadata(wim, image);
3103 goto out_wimlib_free;
3108 /* Modification operations */
3110 if (image == WIMLIB_ALL_IMAGES)
3113 if (image == WIMLIB_NO_IMAGE && new_name) {
3114 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3115 "when using image 0"), new_name);
3117 goto out_wimlib_free;
3121 if (image == info.boot_index) {
3122 imagex_printf(T("Image %d is already marked as "
3123 "bootable.\n"), image);
3126 imagex_printf(T("Marking image %d as bootable.\n"),
3128 info.boot_index = image;
3129 ret = wimlib_set_wim_info(wim, &info,
3130 WIMLIB_CHANGE_BOOT_INDEX);
3132 goto out_wimlib_free;
3136 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3138 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3142 imagex_printf(T("Changing the name of image %d to "
3143 "\"%"TS"\".\n"), image, new_name);
3144 ret = wimlib_set_image_name(wim, image, new_name);
3146 goto out_wimlib_free;
3150 const tchar *old_desc;
3151 old_desc = wimlib_get_image_description(wim, image);
3152 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3153 imagex_printf(T("The description of image %d is already "
3154 "\"%"TS"\".\n"), image, new_desc);
3157 imagex_printf(T("Changing the description of image %d "
3158 "to \"%"TS"\".\n"), image, new_desc);
3159 ret = wimlib_set_image_descripton(wim, image,
3162 goto out_wimlib_free;
3166 /* Only call wimlib_overwrite() if something actually needs to
3168 if (boot || new_name || new_desc ||
3169 (check && !info.has_integrity_table) ||
3170 (nocheck && info.has_integrity_table))
3172 int write_flags = 0;
3175 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3177 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3178 ret = wimlib_overwrite(wim, write_flags, 1,
3179 imagex_progress_func);
3181 imagex_printf(T("The file \"%"TS"\" was not modified "
3182 "because nothing needed to be done.\n"),
3193 usage(CMD_INFO, stderr);
3199 /* Join split WIMs into one part WIM */
3201 imagex_join(int argc, tchar **argv, int cmd)
3204 int swm_open_flags = 0;
3205 int wim_write_flags = 0;
3206 const tchar *output_path;
3209 for_opt(c, join_options) {
3211 case IMAGEX_CHECK_OPTION:
3212 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3213 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3223 imagex_error(T("Must specify one or more split WIM (.swm) "
3227 output_path = argv[0];
3228 ret = wimlib_join((const tchar * const *)++argv,
3233 imagex_progress_func);
3238 usage(CMD_JOIN, stderr);
3243 #if WIM_MOUNTING_SUPPORTED
3245 /* Mounts a WIM image. */
3247 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3250 int mount_flags = 0;
3252 const tchar *staging_dir = NULL;
3253 const tchar *wimfile;
3256 struct wimlib_wim_info info;
3260 STRING_SET(refglobs);
3262 if (cmd == CMD_MOUNTRW) {
3263 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3264 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3267 for_opt(c, mount_options) {
3269 case IMAGEX_ALLOW_OTHER_OPTION:
3270 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3272 case IMAGEX_CHECK_OPTION:
3273 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3275 case IMAGEX_DEBUG_OPTION:
3276 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3278 case IMAGEX_STREAMS_INTERFACE_OPTION:
3279 if (!tstrcasecmp(optarg, T("none")))
3280 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3281 else if (!tstrcasecmp(optarg, T("xattr")))
3282 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3283 else if (!tstrcasecmp(optarg, T("windows")))
3284 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3286 imagex_error(T("Unknown stream interface \"%"TS"\""),
3291 case IMAGEX_REF_OPTION:
3292 ret = string_set_append(&refglobs, optarg);
3294 goto out_free_refglobs;
3296 case IMAGEX_STAGING_DIR_OPTION:
3297 staging_dir = optarg;
3299 case IMAGEX_UNIX_DATA_OPTION:
3300 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3308 if (argc != 2 && argc != 3)
3313 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3315 goto out_free_refglobs;
3317 wimlib_get_wim_info(wim, &info);
3320 /* Image explicitly specified. */
3321 image = wimlib_resolve_image(wim, argv[1]);
3323 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3327 /* No image specified; default to image 1, but only if the WIM
3328 * contains exactly one image. */
3330 if (info.image_count != 1) {
3331 imagex_error(T("\"%"TS"\" contains %d images; Please "
3332 "select one."), wimfile, info.image_count);
3340 if (refglobs.num_strings) {
3341 ret = wim_reference_globs(wim, &refglobs, open_flags);
3346 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3348 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3350 image, wimfile, dir);
3355 string_set_destroy(&refglobs);
3361 goto out_free_refglobs;
3363 #endif /* WIM_MOUNTING_SUPPORTED */
3365 /* Rebuild a WIM file */
3367 imagex_optimize(int argc, tchar **argv, int cmd)
3370 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3371 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3372 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3373 uint32_t chunk_size = UINT32_MAX;
3376 const tchar *wimfile;
3379 unsigned num_threads = 0;
3381 for_opt(c, optimize_options) {
3383 case IMAGEX_CHECK_OPTION:
3384 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3385 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3387 case IMAGEX_NOCHECK_OPTION:
3388 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3390 case IMAGEX_COMPRESS_OPTION:
3391 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3392 compression_type = get_compression_type(optarg);
3393 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3396 case IMAGEX_RECOMPRESS_OPTION:
3397 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3399 case IMAGEX_COMPRESS_SLOW_OPTION:
3400 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3401 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
3402 ret = set_compress_slow();
3406 case IMAGEX_CHUNK_SIZE_OPTION:
3407 chunk_size = parse_chunk_size(optarg);
3408 if (chunk_size == UINT32_MAX)
3411 case IMAGEX_PACK_STREAMS_OPTION:
3412 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3413 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3415 case IMAGEX_THREADS_OPTION:
3416 num_threads = parse_num_threads(optarg);
3417 if (num_threads == UINT_MAX)
3420 case IMAGEX_PIPABLE_OPTION:
3421 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3423 case IMAGEX_NOT_PIPABLE_OPTION:
3424 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3438 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3442 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3443 /* Change compression type. */
3444 ret = wimlib_set_output_compression_type(wim, compression_type);
3446 goto out_wimlib_free;
3449 if (chunk_size != UINT32_MAX) {
3450 /* Change chunk size. */
3451 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3453 goto out_wimlib_free;
3456 old_size = file_get_size(wimfile);
3457 tprintf(T("\"%"TS"\" original size: "), wimfile);
3459 tputs(T("Unknown"));
3461 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3463 ret = wimlib_overwrite(wim, write_flags, num_threads,
3464 imagex_progress_func);
3466 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3467 goto out_wimlib_free;
3470 new_size = file_get_size(wimfile);
3471 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3473 tputs(T("Unknown"));
3475 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3477 tfputs(T("Space saved: "), stdout);
3478 if (new_size != -1 && old_size != -1) {
3479 tprintf(T("%lld KiB\n"),
3480 ((long long)old_size - (long long)new_size) >> 10);
3482 tputs(T("Unknown"));
3491 usage(CMD_OPTIMIZE, stderr);
3497 /* Split a WIM into a spanned set */
3499 imagex_split(int argc, tchar **argv, int cmd)
3503 int write_flags = 0;
3504 unsigned long part_size;
3509 for_opt(c, split_options) {
3511 case IMAGEX_CHECK_OPTION:
3512 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3513 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3525 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3526 if (tmp == argv[2] || *tmp) {
3527 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3528 imagex_error(T("The part size must be an integer or "
3529 "floating-point number of megabytes."));
3532 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3536 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3542 usage(CMD_SPLIT, stderr);
3548 #if WIM_MOUNTING_SUPPORTED
3549 /* Unmounts a mounted WIM image. */
3551 imagex_unmount(int argc, tchar **argv, int cmd)
3554 int unmount_flags = 0;
3557 for_opt(c, unmount_options) {
3559 case IMAGEX_COMMIT_OPTION:
3560 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3562 case IMAGEX_CHECK_OPTION:
3563 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3565 case IMAGEX_REBUILD_OPTION:
3566 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3568 case IMAGEX_LAZY_OPTION:
3569 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3580 ret = wimlib_unmount_image(argv[0], unmount_flags,
3581 imagex_progress_func);
3583 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3588 usage(CMD_UNMOUNT, stderr);
3592 #endif /* WIM_MOUNTING_SUPPORTED */
3595 * Add, delete, or rename files in a WIM image.
3598 imagex_update(int argc, tchar **argv, int cmd)
3600 const tchar *wimfile;
3604 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3605 int write_flags = 0;
3606 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3607 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3608 WIMLIB_ADD_FLAG_VERBOSE;
3609 int default_delete_flags = 0;
3610 unsigned num_threads = 0;
3612 tchar *cmd_file_contents;
3613 size_t cmd_file_nchars;
3614 struct wimlib_update_command *cmds;
3616 tchar *command_str = NULL;
3618 const tchar *config_file = NULL;
3620 struct wimlib_capture_config *config;
3622 for_opt(c, update_options) {
3624 /* Generic or write options */
3625 case IMAGEX_THREADS_OPTION:
3626 num_threads = parse_num_threads(optarg);
3627 if (num_threads == UINT_MAX)
3630 case IMAGEX_CHECK_OPTION:
3631 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3632 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3634 case IMAGEX_REBUILD_OPTION:
3635 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3637 case IMAGEX_COMMAND_OPTION:
3639 imagex_error(T("--command may only be specified "
3640 "one time. Please provide\n"
3641 " the update commands "
3642 "on standard input instead."));
3645 command_str = tstrdup(optarg);
3647 imagex_error(T("Out of memory!"));
3651 /* Default delete options */
3652 case IMAGEX_FORCE_OPTION:
3653 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3655 case IMAGEX_RECURSIVE_OPTION:
3656 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3659 /* Global add option */
3660 case IMAGEX_CONFIG_OPTION:
3661 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3662 config_file = optarg;
3665 /* Default add options */
3666 case IMAGEX_VERBOSE_OPTION:
3667 /* No longer does anything. */
3669 case IMAGEX_DEREFERENCE_OPTION:
3670 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3672 case IMAGEX_UNIX_DATA_OPTION:
3673 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3675 case IMAGEX_NO_ACLS_OPTION:
3676 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3678 case IMAGEX_STRICT_ACLS_OPTION:
3679 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3688 if (argc != 1 && argc != 2)
3692 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3694 goto out_free_command_str;
3697 /* Image explicitly specified. */
3698 image = wimlib_resolve_image(wim, argv[1]);
3699 ret = verify_image_exists_and_is_single(image, argv[1],
3702 goto out_wimlib_free;
3704 /* No image specified; default to image 1, but only if the WIM
3705 * contains exactly one image. */
3706 struct wimlib_wim_info info;
3708 wimlib_get_wim_info(wim, &info);
3709 if (info.image_count != 1) {
3710 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3711 wimfile, info.image_count);
3718 /* Parse capture configuration file if specified */
3722 config_str = file_get_text_contents(config_file, &config_len);
3725 goto out_wimlib_free;
3728 config = alloca(sizeof(*config));
3729 ret = parse_capture_config(&config_str, config_len, config);
3731 goto out_free_config;
3734 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3737 /* Read update commands from standard input, or the command string if
3740 cmd_file_contents = NULL;
3741 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3744 if (isatty(STDIN_FILENO)) {
3745 tputs(T("Reading update commands from standard input..."));
3746 recommend_man_page(CMD_UPDATE, stdout);
3748 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3749 if (!cmd_file_contents) {
3751 goto out_free_config;
3754 /* Parse the update commands */
3755 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3760 goto out_free_cmd_file_contents;
3763 /* Set default flags and capture config on the update commands */
3764 for (size_t i = 0; i < num_cmds; i++) {
3765 switch (cmds[i].op) {
3766 case WIMLIB_UPDATE_OP_ADD:
3767 cmds[i].add.add_flags |= default_add_flags;
3768 cmds[i].add.config = config;
3770 case WIMLIB_UPDATE_OP_DELETE:
3771 cmds[i].delete_.delete_flags |= default_delete_flags;
3778 /* Execute the update commands */
3779 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3780 imagex_progress_func);
3784 /* Overwrite the updated WIM */
3785 ret = wimlib_overwrite(wim, write_flags, num_threads,
3786 imagex_progress_func);
3789 out_free_cmd_file_contents:
3790 free(cmd_file_contents);
3793 free(config->exclusion_pats.pats);
3794 free(config->exclusion_exception_pats.pats);
3799 out_free_command_str:
3804 usage(CMD_UPDATE, stderr);
3807 goto out_free_command_str;
3812 struct imagex_command {
3814 int (*func)(int argc, tchar **argv, int cmd);
3817 static const struct imagex_command imagex_commands[] = {
3818 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3819 [CMD_APPLY] = {T("apply"), imagex_apply},
3820 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3821 [CMD_DELETE] = {T("delete"), imagex_delete},
3822 [CMD_DIR ] = {T("dir"), imagex_dir},
3823 [CMD_EXPORT] = {T("export"), imagex_export},
3824 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3825 [CMD_INFO] = {T("info"), imagex_info},
3826 [CMD_JOIN] = {T("join"), imagex_join},
3827 #if WIM_MOUNTING_SUPPORTED
3828 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3829 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3831 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3832 [CMD_SPLIT] = {T("split"), imagex_split},
3833 #if WIM_MOUNTING_SUPPORTED
3834 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3836 [CMD_UPDATE] = {T("update"), imagex_update},
3839 static const tchar *usage_strings[] = {
3842 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3843 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3844 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
3845 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3846 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3847 " [--update-of=[WIMFILE:]IMAGE]\n"
3851 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3852 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
3853 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3854 " [--hardlink] [--symlink] [--include-invalid-names]\n"
3858 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3859 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3860 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3861 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3862 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3863 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
3864 " [--delta-from=WIMFILE]\n"
3868 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
3869 " [--check] [--soft]\n"
3873 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3877 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3878 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3879 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3880 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3884 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3885 " [--check] [--ref=\"GLOB\"] [--no-acls] [--strict-acls]\n"
3886 " [--to-stdout] [--dest-dir=CMD_DIR]\n"
3887 " [--include-invalid-names]\n"
3891 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3892 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
3893 " [--extract-xml FILE] [--header] [--lookup-table]\n"
3897 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3899 #if WIM_MOUNTING_SUPPORTED
3902 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3903 " [--check] [--streams-interface=INTERFACE]\n"
3904 " [--ref=\"GLOB\"] [--allow-other]\n"
3908 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3909 " [--check] [--streams-interface=INTERFACE]\n"
3910 " [--staging-dir=CMD_DIR] [--allow-other]\n"
3915 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3916 " [--recompress-slow] [--compress=TYPE]\n"
3917 " [--threads=NUM_THREADS]\n"
3921 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3923 #if WIM_MOUNTING_SUPPORTED
3926 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3931 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3932 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3933 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3937 static const tchar *invocation_name;
3938 static int invocation_cmd = CMD_NONE;
3940 static const tchar *get_cmd_string(int cmd, bool nospace)
3942 static tchar buf[50];
3943 if (cmd == CMD_NONE) {
3944 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3945 } else if (invocation_cmd != CMD_NONE) {
3946 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3948 const tchar *format;
3951 format = T("%"TS"-%"TS"");
3953 format = T("%"TS" %"TS"");
3954 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3962 static const tchar *s =
3964 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3965 "Copyright (C) 2012, 2013 Eric Biggers\n"
3966 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3967 "This is free software: you are free to change and redistribute it.\n"
3968 "There is NO WARRANTY, to the extent permitted by law.\n"
3970 "Report bugs to "PACKAGE_BUGREPORT".\n"
3977 help_or_version(int argc, tchar **argv, int cmd)
3982 for (i = 1; i < argc; i++) {
3984 if (p[0] == T('-') && p[1] == T('-')) {
3986 if (!tstrcmp(p, T("help"))) {
3987 if (cmd == CMD_NONE)
3992 } else if (!tstrcmp(p, T("version"))) {
4001 print_usage_string(int cmd, FILE *fp)
4003 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4007 recommend_man_page(int cmd, FILE *fp)
4009 const tchar *format_str;
4011 format_str = T("Uncommon options are not listed;\n"
4012 "See %"TS".pdf in the doc directory for more details.\n");
4014 format_str = T("Uncommon options are not listed;\n"
4015 "Try `man %"TS"' for more details.\n");
4017 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4021 usage(int cmd, FILE *fp)
4023 tfprintf(fp, T("Usage:\n"));
4024 print_usage_string(cmd, fp);
4025 tfprintf(fp, T("\n"));
4026 recommend_man_page(cmd, fp);
4032 tfprintf(fp, T("Usage:\n"));
4033 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4034 print_usage_string(cmd, fp);
4035 tfprintf(fp, T("\n"));
4037 static const tchar *extra =
4040 " %"TS" --version\n"
4042 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4045 tfprintf(fp, extra, invocation_name, invocation_name);
4046 recommend_man_page(CMD_NONE, fp);
4049 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4050 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4051 * something else), while an Windows the command arguments will be UTF-16LE
4052 * encoded 'wchar_t' strings. */
4055 wmain(int argc, wchar_t **argv, wchar_t **envp)
4057 main(int argc, char **argv)
4064 imagex_info_file = stdout;
4065 invocation_name = tbasename(argv[0]);
4068 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4069 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4073 setlocale(LC_ALL, "");
4074 codeset = nl_langinfo(CODESET);
4075 if (!strstr(codeset, "UTF-8") &&
4076 !strstr(codeset, "UTF8") &&
4077 !strstr(codeset, "utf-8") &&
4078 !strstr(codeset, "utf8"))
4081 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4082 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4083 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4084 " to any value to force wimlib to use UTF-8.\n",
4090 #endif /* !__WIN32__ */
4093 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4094 if (igcase != NULL) {
4095 if (!tstrcmp(igcase, T("no")) ||
4096 !tstrcmp(igcase, T("0")))
4097 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4098 else if (!tstrcmp(igcase, T("yes")) ||
4099 !tstrcmp(igcase, T("1")))
4100 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4103 "WARNING: Ignoring unknown setting of "
4104 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4109 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4111 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4112 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4113 for (int i = 0; i < CMD_MAX; i++) {
4114 if (!tstrcmp(invocation_name + 3,
4115 imagex_commands[i].name))
4124 /* Unless already known from the invocation name, determine which
4125 * command was specified. */
4126 if (cmd == CMD_NONE) {
4128 imagex_error(T("No command specified!\n"));
4132 for (int i = 0; i < CMD_MAX; i++) {
4133 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4138 if (cmd != CMD_NONE) {
4144 /* Handle --help and --version. --help can be either for the program as
4145 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4146 * CMD_NONE). Note: help_or_version() will not return if a --help or
4147 * --version argument was found. */
4148 help_or_version(argc, argv, cmd);
4150 /* Bail if a valid command was not specified. */
4151 if (cmd == CMD_NONE) {
4152 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4157 /* Enable warning and error messages in wimlib be more user-friendly.
4159 wimlib_set_print_errors(true);
4161 /* Initialize wimlib. */
4162 ret = wimlib_global_init(init_flags);
4164 goto out_check_status;
4166 /* Call the command handler function. */
4167 ret = imagex_commands[cmd].func(argc, argv, cmd);
4169 /* Check for error writing to standard output, especially since for some
4170 * commands, writing to standard output is part of the program's actual
4171 * behavior and not just for informational purposes. */
4172 if (ferror(stdout) || fclose(stdout)) {
4173 imagex_error_with_errno(T("error writing to standard output"));
4178 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4179 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4180 * error code from which an error message can be printed. */
4182 imagex_error(T("Exiting with error code %d:\n"
4184 wimlib_get_error_string(ret));
4185 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4186 imagex_error_with_errno(T("errno"));
4188 /* Make wimlib free any resources it's holding (although this is not
4189 * strictly necessary because the process is ending anyway). */
4190 wimlib_global_cleanup();