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);
1162 case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK:
1163 imagex_printf(T("\nWARNING: Ignoring absolute symbolic link "
1164 "with out-of-tree target:\n"
1165 " \"%"TS"\" => \"%"TS"\"\n"
1166 " (Use --norpfix to capture "
1167 "absolute symbolic links as-is)\n"),
1168 info->scan.cur_path, info->scan.symlink_target);
1172 case WIMLIB_PROGRESS_MSG_SCAN_END:
1173 report_scan_progress(&info->scan, true);
1174 imagex_printf(T("\n"));
1176 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1177 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1178 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1179 info->integrity.total_bytes);
1180 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1181 "of %"PRIu64" %"TS" (%u%%) done"),
1182 info->integrity.filename,
1183 info->integrity.completed_bytes >> unit_shift,
1185 info->integrity.total_bytes >> unit_shift,
1188 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1189 imagex_printf(T("\n"));
1191 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1192 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1193 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1194 info->integrity.total_bytes);
1195 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1196 "of %"PRIu64" %"TS" (%u%%) done"),
1197 info->integrity.completed_bytes >> unit_shift,
1199 info->integrity.total_bytes >> unit_shift,
1202 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1203 imagex_printf(T("\n"));
1205 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1206 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1207 "to %"TS" \"%"TS"\"\n"),
1208 info->extract.image,
1209 info->extract.image_name,
1210 info->extract.wimfile_name,
1211 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1212 T("NTFS volume") : T("directory")),
1213 info->extract.target);
1215 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1216 if (info->extract.extract_root_wim_source_path[0] != T('\0')) {
1217 imagex_printf(T("Extracting "
1218 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" "
1219 "from image %d (\"%"TS"\") "
1220 "in \"%"TS"\" to \"%"TS"\"\n"),
1221 info->extract.extract_root_wim_source_path,
1222 info->extract.image,
1223 info->extract.image_name,
1224 info->extract.wimfile_name,
1225 info->extract.target);
1228 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1229 percent_done = TO_PERCENT(info->extract.completed_bytes,
1230 info->extract.total_bytes);
1231 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1232 imagex_printf(T("\rExtracting files: "
1233 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1234 info->extract.completed_bytes >> unit_shift,
1236 info->extract.total_bytes >> unit_shift,
1239 if (info->extract.completed_bytes >= info->extract.total_bytes)
1240 imagex_printf(T("\n"));
1242 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1243 if (info->extract.total_parts != 1) {
1244 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1245 info->extract.part_number,
1246 info->extract.total_parts);
1249 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1250 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1251 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1253 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1254 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1255 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1256 info->extract.target);
1259 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1260 percent_done = TO_PERCENT(info->split.completed_bytes,
1261 info->split.total_bytes);
1262 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1263 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1264 "%"PRIu64" %"TS" (%u%%) written\n"),
1265 info->split.part_name,
1266 info->split.cur_part_number,
1267 info->split.total_parts,
1268 info->split.completed_bytes >> unit_shift,
1270 info->split.total_bytes >> unit_shift,
1274 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1275 if (info->split.completed_bytes == info->split.total_bytes) {
1276 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1277 info->split.cur_part_number,
1278 info->split.total_parts);
1281 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1282 switch (info->update.command->op) {
1283 case WIMLIB_UPDATE_OP_DELETE:
1284 imagex_printf(T("Deleted WIM path "
1285 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1286 info->update.command->delete_.wim_path);
1288 case WIMLIB_UPDATE_OP_RENAME:
1289 imagex_printf(T("Renamed WIM path "
1290 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1291 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1292 info->update.command->rename.wim_source_path,
1293 info->update.command->rename.wim_target_path);
1295 case WIMLIB_UPDATE_OP_ADD:
1303 fflush(imagex_info_file);
1308 parse_num_threads(const tchar *optarg)
1311 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1312 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1313 imagex_error(T("Number of threads must be a non-negative integer!"));
1320 static uint32_t parse_chunk_size(const tchar *optarg)
1323 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1324 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1325 imagex_error(T("Chunk size must be a non-negative integer!"));
1334 * Parse an option passed to an update command.
1336 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1339 * @option: Text string for the option (beginning with --)
1341 * @cmd: `struct wimlib_update_command' that is being constructed for
1344 * Returns true if the option was recognized; false if not.
1347 update_command_add_option(int op, const tchar *option,
1348 struct wimlib_update_command *cmd)
1350 bool recognized = true;
1352 case WIMLIB_UPDATE_OP_ADD:
1353 if (!tstrcmp(option, T("--verbose")))
1354 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1355 else if (!tstrcmp(option, T("--unix-data")))
1356 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1357 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1358 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1359 else if (!tstrcmp(option, T("--strict-acls")))
1360 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1361 else if (!tstrcmp(option, T("--dereference")))
1362 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1366 case WIMLIB_UPDATE_OP_DELETE:
1367 if (!tstrcmp(option, T("--force")))
1368 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1369 else if (!tstrcmp(option, T("--recursive")))
1370 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1381 /* How many nonoption arguments each `imagex update' command expects */
1382 static const unsigned update_command_num_nonoptions[] = {
1383 [WIMLIB_UPDATE_OP_ADD] = 2,
1384 [WIMLIB_UPDATE_OP_DELETE] = 1,
1385 [WIMLIB_UPDATE_OP_RENAME] = 2,
1389 update_command_add_nonoption(int op, const tchar *nonoption,
1390 struct wimlib_update_command *cmd,
1391 unsigned num_nonoptions)
1394 case WIMLIB_UPDATE_OP_ADD:
1395 if (num_nonoptions == 0)
1396 cmd->add.fs_source_path = (tchar*)nonoption;
1398 cmd->add.wim_target_path = (tchar*)nonoption;
1400 case WIMLIB_UPDATE_OP_DELETE:
1401 cmd->delete_.wim_path = (tchar*)nonoption;
1403 case WIMLIB_UPDATE_OP_RENAME:
1404 if (num_nonoptions == 0)
1405 cmd->rename.wim_source_path = (tchar*)nonoption;
1407 cmd->rename.wim_target_path = (tchar*)nonoption;
1413 * Parse a command passed on stdin to `imagex update'.
1415 * @line: Text of the command.
1416 * @len: Length of the line, including a null terminator
1419 * @command: A `struct wimlib_update_command' to fill in from the parsed
1422 * @line_number: Line number of the command, for diagnostics.
1424 * Returns true on success; returns false on parse error.
1427 parse_update_command(tchar *line, size_t len,
1428 struct wimlib_update_command *command,
1432 tchar *command_name;
1434 size_t num_nonoptions;
1436 /* Get the command name ("add", "delete", "rename") */
1437 ret = parse_string(&line, &len, &command_name);
1438 if (ret != PARSE_STRING_SUCCESS)
1441 if (!tstrcasecmp(command_name, T("add"))) {
1442 op = WIMLIB_UPDATE_OP_ADD;
1443 } else if (!tstrcasecmp(command_name, T("delete"))) {
1444 op = WIMLIB_UPDATE_OP_DELETE;
1445 } else if (!tstrcasecmp(command_name, T("rename"))) {
1446 op = WIMLIB_UPDATE_OP_RENAME;
1448 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1449 command_name, line_number);
1454 /* Parse additional options and non-options as needed */
1459 ret = parse_string(&line, &len, &next_string);
1460 if (ret == PARSE_STRING_NONE) /* End of line */
1462 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1464 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1466 if (!update_command_add_option(op, next_string, command))
1468 imagex_error(T("Unrecognized option \"%"TS"\" to "
1469 "update command \"%"TS"\" on line %zu"),
1470 next_string, command_name, line_number);
1476 if (num_nonoptions == update_command_num_nonoptions[op])
1478 imagex_error(T("Unexpected argument \"%"TS"\" in "
1479 "update command on line %zu\n"
1480 " (The \"%"TS"\" command only "
1481 "takes %zu nonoption arguments!)\n"),
1482 next_string, line_number,
1483 command_name, num_nonoptions);
1486 update_command_add_nonoption(op, next_string,
1487 command, num_nonoptions);
1492 if (num_nonoptions != update_command_num_nonoptions[op]) {
1493 imagex_error(T("Not enough arguments to update command "
1494 "\"%"TS"\" on line %zu"), command_name, line_number);
1500 static struct wimlib_update_command *
1501 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1502 size_t *num_cmds_ret)
1506 struct wimlib_update_command *cmds;
1509 nlines = text_file_count_lines(cmd_file_contents_p,
1514 /* Always allocate at least 1 slot, just in case the implementation of
1515 * calloc() returns NULL if 0 bytes are requested. */
1516 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1518 imagex_error(T("out of memory"));
1521 p = *cmd_file_contents_p;
1523 for (i = 0; i < nlines; i++) {
1524 /* XXX: Could use rawmemchr() here instead, but it may not be
1525 * available on all platforms. */
1526 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1527 size_t len = endp - p + 1;
1529 if (!is_comment_line(p, len)) {
1530 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1541 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1542 * one image from a WIM file to a NTFS volume. */
1544 imagex_apply(int argc, tchar **argv, int cmd)
1548 int image = WIMLIB_NO_IMAGE;
1550 struct wimlib_wim_info info;
1552 const tchar *wimfile;
1553 const tchar *target;
1554 const tchar *image_num_or_name = NULL;
1555 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1557 STRING_SET(refglobs);
1559 for_opt(c, apply_options) {
1561 case IMAGEX_CHECK_OPTION:
1562 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1564 case IMAGEX_HARDLINK_OPTION:
1565 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1567 case IMAGEX_SYMLINK_OPTION:
1568 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1570 case IMAGEX_VERBOSE_OPTION:
1571 /* No longer does anything. */
1573 case IMAGEX_REF_OPTION:
1574 ret = string_set_append(&refglobs, optarg);
1576 goto out_free_refglobs;
1578 case IMAGEX_UNIX_DATA_OPTION:
1579 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1581 case IMAGEX_NO_ACLS_OPTION:
1582 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1584 case IMAGEX_STRICT_ACLS_OPTION:
1585 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1587 case IMAGEX_NORPFIX_OPTION:
1588 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1590 case IMAGEX_RPFIX_OPTION:
1591 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1593 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1594 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1595 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1597 case IMAGEX_RESUME_OPTION:
1598 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1606 if (argc != 2 && argc != 3)
1611 if (!tstrcmp(wimfile, T("-"))) {
1612 /* Attempt to apply pipable WIM from standard input. */
1614 image_num_or_name = NULL;
1617 image_num_or_name = argv[1];
1622 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1623 imagex_progress_func);
1625 goto out_free_refglobs;
1627 wimlib_get_wim_info(wim, &info);
1630 /* Image explicitly specified. */
1631 image_num_or_name = argv[1];
1632 image = wimlib_resolve_image(wim, image_num_or_name);
1633 ret = verify_image_exists(image, image_num_or_name, wimfile);
1635 goto out_wimlib_free;
1638 /* No image specified; default to image 1, but only if the WIM
1639 * contains exactly one image. */
1641 if (info.image_count != 1) {
1642 imagex_error(T("\"%"TS"\" contains %d images; "
1643 "Please select one (or all)."),
1644 wimfile, info.image_count);
1653 if (refglobs.num_strings) {
1655 imagex_error(T("Can't specify --ref when applying from stdin!"));
1657 goto out_wimlib_free;
1659 ret = wim_reference_globs(wim, &refglobs, open_flags);
1661 goto out_wimlib_free;
1666 /* Interpret a regular file or block device target as a NTFS
1670 if (tstat(target, &stbuf)) {
1671 if (errno != ENOENT) {
1672 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1675 goto out_wimlib_free;
1678 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1679 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1685 ret = wimlib_extract_image(wim, image, target, extract_flags,
1686 imagex_progress_func);
1688 set_fd_to_binary_mode(STDIN_FILENO);
1689 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1691 target, extract_flags,
1692 imagex_progress_func);
1695 imagex_printf(T("Done applying WIM image.\n"));
1696 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1698 do_resource_not_found_warning(wimfile, &info, &refglobs);
1700 imagex_error(T( "If you are applying an image "
1701 "from a split pipable WIM,\n"
1702 " make sure you have "
1703 "concatenated together all parts."));
1709 string_set_destroy(&refglobs);
1713 usage(CMD_APPLY, stderr);
1715 goto out_free_refglobs;
1718 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1719 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1720 * the desired image. 'wimlib-imagex append': add a new image to an existing
1723 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1726 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1727 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1728 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1729 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1730 int write_flags = 0;
1731 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1732 uint32_t chunk_size = UINT32_MAX;
1733 const tchar *wimfile;
1737 const tchar *flags_element = NULL;
1740 STRING_SET(base_wimfiles);
1741 WIMStruct **base_wims;
1743 WIMStruct *template_wim;
1744 const tchar *template_wimfile = NULL;
1745 const tchar *template_image_name_or_num = NULL;
1746 int template_image = WIMLIB_NO_IMAGE;
1749 unsigned num_threads = 0;
1754 const tchar *config_file = NULL;
1756 struct wimlib_capture_config *config;
1758 bool source_list = false;
1759 size_t source_list_nchars = 0;
1760 tchar *source_list_contents;
1761 bool capture_sources_malloced;
1762 struct wimlib_capture_source *capture_sources;
1764 bool name_defaulted;
1766 for_opt(c, capture_or_append_options) {
1768 case IMAGEX_BOOT_OPTION:
1769 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1771 case IMAGEX_CHECK_OPTION:
1772 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1773 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1775 case IMAGEX_NOCHECK_OPTION:
1776 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1778 case IMAGEX_CONFIG_OPTION:
1779 config_file = optarg;
1780 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1782 case IMAGEX_COMPRESS_OPTION:
1783 compression_type = get_compression_type(optarg);
1784 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1787 case IMAGEX_COMPRESS_SLOW_OPTION:
1788 ret = set_compress_slow();
1791 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1793 case IMAGEX_CHUNK_SIZE_OPTION:
1794 chunk_size = parse_chunk_size(optarg);
1795 if (chunk_size == UINT32_MAX)
1798 case IMAGEX_PACK_STREAMS_OPTION:
1799 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1801 case IMAGEX_FLAGS_OPTION:
1802 flags_element = optarg;
1804 case IMAGEX_DEREFERENCE_OPTION:
1805 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1807 case IMAGEX_VERBOSE_OPTION:
1808 /* No longer does anything. */
1810 case IMAGEX_THREADS_OPTION:
1811 num_threads = parse_num_threads(optarg);
1812 if (num_threads == UINT_MAX)
1815 case IMAGEX_REBUILD_OPTION:
1816 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1818 case IMAGEX_UNIX_DATA_OPTION:
1819 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1821 case IMAGEX_SOURCE_LIST_OPTION:
1824 case IMAGEX_NO_ACLS_OPTION:
1825 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1827 case IMAGEX_STRICT_ACLS_OPTION:
1828 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1830 case IMAGEX_RPFIX_OPTION:
1831 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1833 case IMAGEX_NORPFIX_OPTION:
1834 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1836 case IMAGEX_PIPABLE_OPTION:
1837 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1839 case IMAGEX_NOT_PIPABLE_OPTION:
1840 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1842 case IMAGEX_UPDATE_OF_OPTION:
1843 if (template_image_name_or_num) {
1844 imagex_error(T("'--update-of' can only be "
1845 "specified one time!"));
1849 colon = tstrrchr(optarg, T(':'));
1852 template_wimfile = optarg;
1854 template_image_name_or_num = colon + 1;
1856 template_wimfile = NULL;
1857 template_image_name_or_num = optarg;
1861 case IMAGEX_DELTA_FROM_OPTION:
1862 if (cmd != CMD_CAPTURE) {
1863 imagex_error(T("'--delta-from' is only "
1864 "valid for capture!"));
1867 ret = string_set_append(&base_wimfiles, optarg);
1869 goto out_free_base_wimfiles;
1870 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1879 if (argc < 2 || argc > 4)
1885 /* Set default compression type. */
1886 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1887 struct wimlib_lzx_compressor_params params;
1888 memset(¶ms, 0, sizeof(params));
1889 params.hdr.size = sizeof(params);
1890 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1891 params.use_defaults = 1;
1893 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1895 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1898 if (!tstrcmp(wimfile, T("-"))) {
1899 /* Writing captured WIM to standard output. */
1901 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1902 imagex_error("Can't write a non-pipable WIM to "
1903 "standard output! Specify --pipable\n"
1904 " if you want to create a pipable WIM "
1905 "(but read the docs first).");
1909 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1911 if (cmd == CMD_APPEND) {
1912 imagex_error(T("Using standard output for append does "
1913 "not make sense."));
1916 wim_fd = STDOUT_FILENO;
1918 imagex_info_file = stderr;
1919 set_fd_to_binary_mode(wim_fd);
1922 /* If template image was specified using --update-of=IMAGE rather
1923 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1924 if (template_image_name_or_num && !template_wimfile) {
1925 if (base_wimfiles.num_strings == 1) {
1926 /* Capturing delta WIM based on single WIM: default to
1928 template_wimfile = base_wimfiles.strings[0];
1929 } else if (cmd == CMD_APPEND) {
1930 /* Appending to WIM: default to WIM being appended to.
1932 template_wimfile = wimfile;
1934 /* Capturing a normal (non-delta) WIM, so the WIM file
1935 * *must* be explicitly specified. */
1936 if (base_wimfiles.num_strings > 1) {
1937 imagex_error(T("For capture of delta WIM "
1938 "based on multiple existing "
1940 " '--update-of' must "
1941 "specify WIMFILE:IMAGE!"));
1943 imagex_error(T("For capture of non-delta WIM, "
1944 "'--update-of' must specify "
1953 name_defaulted = false;
1955 /* Set default name to SOURCE argument, omitting any directory
1956 * prefixes and trailing slashes. This requires making a copy
1957 * of @source. Leave some free characters at the end in case we
1958 * append a number to keep the name unique. */
1959 size_t source_name_len;
1961 source_name_len = tstrlen(source);
1962 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1963 name = tbasename(tstrcpy(source_copy, source));
1964 name_defaulted = true;
1966 /* Image description defaults to NULL if not given. */
1973 /* Set up capture sources in source list mode */
1974 if (source[0] == T('-') && source[1] == T('\0')) {
1975 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1977 source_list_contents = file_get_text_contents(source,
1978 &source_list_nchars);
1980 if (!source_list_contents)
1983 capture_sources = parse_source_list(&source_list_contents,
1986 if (!capture_sources) {
1988 goto out_free_source_list_contents;
1990 capture_sources_malloced = true;
1992 /* Set up capture source in non-source-list mode. */
1993 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1994 capture_sources[0].fs_source_path = source;
1995 capture_sources[0].wim_target_path = NULL;
1996 capture_sources[0].reserved = 0;
1998 capture_sources_malloced = false;
1999 source_list_contents = NULL;
2003 /* Read and parse capture configuration file. */
2006 config_str = file_get_text_contents(config_file, &config_len);
2009 goto out_free_capture_sources;
2012 config = alloca(sizeof(*config));
2013 ret = parse_capture_config(&config_str, config_len, config);
2015 goto out_free_config;
2017 /* No capture configuration file specified; use default
2018 * configuration for capturing Windows operating systems. */
2020 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
2023 /* Open the existing WIM, or create a new one. */
2024 if (cmd == CMD_APPEND)
2025 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2026 imagex_progress_func);
2028 ret = wimlib_create_new_wim(compression_type, &wim);
2030 goto out_free_config;
2032 /* Set chunk size if non-default. */
2033 if (chunk_size != UINT32_MAX) {
2034 ret = wimlib_set_output_chunk_size(wim, chunk_size);
2040 /* Detect if source is regular file or block device and set NTFS volume
2045 if (tstat(source, &stbuf) == 0) {
2046 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2047 imagex_printf(T("Capturing WIM image from NTFS "
2048 "filesystem on \"%"TS"\"\n"), source);
2049 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
2052 if (errno != ENOENT) {
2053 imagex_error_with_errno(T("Failed to stat "
2054 "\"%"TS"\""), source);
2062 /* If the user did not specify an image name, and the basename of the
2063 * source already exists as an image name in the WIM file, append a
2064 * suffix to make it unique. */
2065 if (cmd == CMD_APPEND && name_defaulted) {
2066 unsigned long conflict_idx;
2067 tchar *name_end = tstrchr(name, T('\0'));
2068 for (conflict_idx = 1;
2069 wimlib_image_name_in_use(wim, name);
2072 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2076 /* If capturing a delta WIM, reference resources from the base WIMs
2077 * before adding the new image. */
2078 if (base_wimfiles.num_strings) {
2079 base_wims = calloc(base_wimfiles.num_strings,
2080 sizeof(base_wims[0]));
2081 if (base_wims == NULL) {
2082 imagex_error(T("Out of memory!"));
2087 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2088 ret = wimlib_open_wim(base_wimfiles.strings[i],
2089 open_flags, &base_wims[i],
2090 imagex_progress_func);
2092 goto out_free_base_wims;
2096 ret = wimlib_reference_resources(wim, base_wims,
2097 base_wimfiles.num_strings, 0);
2099 goto out_free_base_wims;
2101 if (base_wimfiles.num_strings == 1) {
2102 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2103 base_wimfiles.strings[0]);
2105 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2106 base_wimfiles.num_strings);
2113 /* If capturing or appending as an update of an existing (template) image,
2114 * open the WIM if needed and parse the image index. */
2115 if (template_image_name_or_num) {
2118 if (base_wimfiles.num_strings == 1 &&
2119 template_wimfile == base_wimfiles.strings[0]) {
2120 template_wim = base_wims[0];
2121 } else if (template_wimfile == wimfile) {
2124 ret = wimlib_open_wim(template_wimfile, open_flags,
2125 &template_wim, imagex_progress_func);
2127 goto out_free_base_wims;
2130 template_image = wimlib_resolve_image(template_wim,
2131 template_image_name_or_num);
2133 if (template_image_name_or_num[0] == T('-')) {
2136 struct wimlib_wim_info info;
2138 wimlib_get_wim_info(template_wim, &info);
2139 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2140 if (n >= 1 && n <= info.image_count &&
2142 tmp != template_image_name_or_num + 1)
2144 template_image = info.image_count - (n - 1);
2147 ret = verify_image_exists_and_is_single(template_image,
2148 template_image_name_or_num,
2151 goto out_free_template_wim;
2153 template_wim = NULL;
2156 ret = wimlib_add_image_multisource(wim,
2162 imagex_progress_func);
2164 goto out_free_template_wim;
2166 if (desc || flags_element || template_image_name_or_num) {
2167 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2168 * on which the added one is to be based has been specified with
2169 * --update-of. Get the index of the image we just
2170 * added, then use it to call the appropriate functions. */
2171 struct wimlib_wim_info info;
2173 wimlib_get_wim_info(wim, &info);
2176 ret = wimlib_set_image_descripton(wim,
2180 goto out_free_template_wim;
2183 if (flags_element) {
2184 ret = wimlib_set_image_flags(wim, info.image_count,
2187 goto out_free_template_wim;
2190 /* Reference template image if the user provided one. */
2191 if (template_image_name_or_num) {
2192 imagex_printf(T("Using image %d "
2193 "from \"%"TS"\" as template\n"),
2194 template_image, template_wimfile);
2195 ret = wimlib_reference_template_image(wim,
2201 goto out_free_template_wim;
2205 /* Write the new WIM or overwrite the existing WIM with the new image
2207 if (cmd == CMD_APPEND) {
2208 ret = wimlib_overwrite(wim, write_flags, num_threads,
2209 imagex_progress_func);
2210 } else if (wimfile) {
2211 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2212 write_flags, num_threads,
2213 imagex_progress_func);
2215 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2216 write_flags, num_threads,
2217 imagex_progress_func);
2219 out_free_template_wim:
2220 /* template_wim may alias base_wims[0] or wim. */
2221 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2222 template_wim != wim)
2223 wimlib_free(template_wim);
2225 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2226 wimlib_free(base_wims[i]);
2232 free(config->exclusion_pats.pats);
2233 free(config->exclusion_exception_pats.pats);
2236 out_free_capture_sources:
2237 if (capture_sources_malloced)
2238 free(capture_sources);
2239 out_free_source_list_contents:
2240 free(source_list_contents);
2241 out_free_base_wimfiles:
2242 string_set_destroy(&base_wimfiles);
2249 goto out_free_base_wimfiles;
2252 /* Remove image(s) from a WIM. */
2254 imagex_delete(int argc, tchar **argv, int cmd)
2257 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2258 int write_flags = 0;
2259 const tchar *wimfile;
2260 const tchar *image_num_or_name;
2265 for_opt(c, delete_options) {
2267 case IMAGEX_CHECK_OPTION:
2268 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2269 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2271 case IMAGEX_SOFT_OPTION:
2272 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2283 imagex_error(T("Must specify a WIM file"));
2285 imagex_error(T("Must specify an image"));
2289 image_num_or_name = argv[1];
2291 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2292 imagex_progress_func);
2296 image = wimlib_resolve_image(wim, image_num_or_name);
2298 ret = verify_image_exists(image, image_num_or_name, wimfile);
2300 goto out_wimlib_free;
2302 ret = wimlib_delete_image(wim, image);
2304 imagex_error(T("Failed to delete image from \"%"TS"\""),
2306 goto out_wimlib_free;
2309 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2311 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2312 "deleted"), wimfile);
2320 usage(CMD_DELETE, stderr);
2326 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2328 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2329 return (ret >= 0) ? 0 : -1;
2332 /* Print the files contained in an image(s) in a WIM file. */
2334 imagex_dir(int argc, tchar **argv, int cmd)
2336 const tchar *wimfile;
2337 WIMStruct *wim = NULL;
2340 const tchar *path = T("");
2343 for_opt(c, dir_options) {
2345 case IMAGEX_PATH_OPTION:
2356 imagex_error(T("Must specify a WIM file"));
2360 imagex_error(T("Too many arguments"));
2365 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2370 image = wimlib_resolve_image(wim, argv[1]);
2371 ret = verify_image_exists(image, argv[1], wimfile);
2373 goto out_wimlib_free;
2375 /* No image specified; default to image 1, but only if the WIM
2376 * contains exactly one image. */
2378 struct wimlib_wim_info info;
2380 wimlib_get_wim_info(wim, &info);
2381 if (info.image_count != 1) {
2382 imagex_error(T("\"%"TS"\" contains %d images; Please "
2383 "select one (or all)."),
2384 wimfile, info.image_count);
2391 ret = wimlib_iterate_dir_tree(wim, image, path,
2392 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2393 print_full_path, NULL);
2400 usage(CMD_DIR, stderr);
2405 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2408 imagex_export(int argc, tchar **argv, int cmd)
2412 int export_flags = 0;
2413 int write_flags = 0;
2414 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2415 const tchar *src_wimfile;
2416 const tchar *src_image_num_or_name;
2417 const tchar *dest_wimfile;
2419 const tchar *dest_name;
2420 const tchar *dest_desc;
2422 struct wimlib_wim_info src_info;
2423 WIMStruct *dest_wim;
2428 STRING_SET(refglobs);
2429 unsigned num_threads = 0;
2430 uint32_t chunk_size = UINT32_MAX;
2432 for_opt(c, export_options) {
2434 case IMAGEX_BOOT_OPTION:
2435 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2437 case IMAGEX_CHECK_OPTION:
2438 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2439 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2441 case IMAGEX_NOCHECK_OPTION:
2442 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2444 case IMAGEX_COMPRESS_OPTION:
2445 compression_type = get_compression_type(optarg);
2446 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2449 case IMAGEX_PACK_STREAMS_OPTION:
2450 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2452 case IMAGEX_CHUNK_SIZE_OPTION:
2453 chunk_size = parse_chunk_size(optarg);
2454 if (chunk_size == UINT32_MAX)
2457 case IMAGEX_REF_OPTION:
2458 ret = string_set_append(&refglobs, optarg);
2460 goto out_free_refglobs;
2462 case IMAGEX_THREADS_OPTION:
2463 num_threads = parse_num_threads(optarg);
2464 if (num_threads == UINT_MAX)
2467 case IMAGEX_REBUILD_OPTION:
2468 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2470 case IMAGEX_PIPABLE_OPTION:
2471 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2473 case IMAGEX_NOT_PIPABLE_OPTION:
2474 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2482 if (argc < 3 || argc > 5)
2484 src_wimfile = argv[0];
2485 src_image_num_or_name = argv[1];
2486 dest_wimfile = argv[2];
2487 dest_name = (argc >= 4) ? argv[3] : NULL;
2488 dest_desc = (argc >= 5) ? argv[4] : NULL;
2489 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2490 imagex_progress_func);
2492 goto out_free_refglobs;
2494 wimlib_get_wim_info(src_wim, &src_info);
2496 /* Determine if the destination is an existing file or not. If so, we
2497 * try to append the exported image(s) to it; otherwise, we create a new
2498 * WIM containing the exported image(s). Furthermore, determine if we
2499 * need to write a pipable WIM directly to standard output. */
2501 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2503 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2504 imagex_error("Can't write a non-pipable WIM to "
2505 "standard output! Specify --pipable\n"
2506 " if you want to create a pipable WIM "
2507 "(but read the docs first).");
2509 goto out_free_src_wim;
2512 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2514 dest_wimfile = NULL;
2515 dest_wim_fd = STDOUT_FILENO;
2516 imagex_info_file = stderr;
2517 set_fd_to_binary_mode(dest_wim_fd);
2520 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2522 /* Destination file exists. */
2524 if (!S_ISREG(stbuf.st_mode)) {
2525 imagex_error(T("\"%"TS"\" is not a regular file"),
2528 goto out_free_src_wim;
2530 ret = wimlib_open_wim(dest_wimfile,
2531 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2532 &dest_wim, imagex_progress_func);
2534 goto out_free_src_wim;
2536 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2537 /* The user specified a compression type, but we're
2538 * exporting to an existing WIM. Make sure the
2539 * specified compression type is the same as the
2540 * compression type of the existing destination WIM. */
2541 struct wimlib_wim_info dest_info;
2543 wimlib_get_wim_info(dest_wim, &dest_info);
2544 if (compression_type != dest_info.compression_type) {
2545 imagex_error(T("Cannot specify a compression type that is "
2546 "not the same as that used in the "
2547 "destination WIM"));
2549 goto out_free_dest_wim;
2555 if (errno != ENOENT) {
2556 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2559 goto out_free_src_wim;
2562 /* dest_wimfile is not an existing file, so create a new WIM. */
2564 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2565 /* The user did not specify a compression type; default
2566 * to that of the source WIM. */
2568 compression_type = src_info.compression_type;
2570 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2572 goto out_free_src_wim;
2574 /* Use same chunk size if compression type is the same. */
2575 if (compression_type == src_info.compression_type &&
2576 chunk_size == UINT32_MAX)
2577 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2580 if (chunk_size != UINT32_MAX) {
2581 /* Set destination chunk size. */
2582 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2584 goto out_free_dest_wim;
2587 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2588 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2590 goto out_free_dest_wim;
2592 if (refglobs.num_strings) {
2593 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2595 goto out_free_dest_wim;
2598 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2599 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2601 imagex_error(T("--boot specified for all-images export, but source WIM "
2602 "has no bootable image."));
2604 goto out_free_dest_wim;
2607 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2608 dest_desc, export_flags, imagex_progress_func);
2610 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2611 do_resource_not_found_warning(src_wimfile,
2612 &src_info, &refglobs);
2614 goto out_free_dest_wim;
2618 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2619 imagex_progress_func);
2620 else if (dest_wimfile)
2621 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2622 write_flags, num_threads,
2623 imagex_progress_func);
2625 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2626 WIMLIB_ALL_IMAGES, write_flags,
2627 num_threads, imagex_progress_func);
2629 wimlib_free(dest_wim);
2631 wimlib_free(src_wim);
2633 string_set_destroy(&refglobs);
2637 usage(CMD_EXPORT, stderr);
2640 goto out_free_refglobs;
2644 is_root_wim_path(const tchar *path)
2647 for (p = path; *p; p++)
2648 if (*p != T('\\') && *p != T('/'))
2654 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2655 const tchar *dest_dir)
2657 for (size_t i = 0; i < num_cmds; i++)
2658 if (cmds[i].fs_dest_path != dest_dir)
2659 free(cmds[i].fs_dest_path);
2663 static struct wimlib_extract_command *
2664 prepare_extract_commands(tchar **paths, unsigned num_paths,
2665 int extract_flags, tchar *dest_dir,
2666 size_t *num_cmds_ret)
2668 struct wimlib_extract_command *cmds;
2670 tchar *emptystr = T("");
2672 if (num_paths == 0) {
2676 num_cmds = num_paths;
2677 cmds = calloc(num_cmds, sizeof(cmds[0]));
2679 imagex_error(T("Out of memory!"));
2683 for (size_t i = 0; i < num_cmds; i++) {
2684 cmds[i].extract_flags = extract_flags;
2685 cmds[i].wim_source_path = paths[i];
2686 if (is_root_wim_path(paths[i])) {
2687 cmds[i].fs_dest_path = dest_dir;
2689 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2690 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2691 if (!cmds[i].fs_dest_path) {
2692 free_extract_commands(cmds, num_cmds, dest_dir);
2695 tsprintf(cmds[i].fs_dest_path,
2696 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2697 dest_dir, tbasename(paths[i]));
2700 *num_cmds_ret = num_cmds;
2704 /* Extract files or directories from a WIM image */
2706 imagex_extract(int argc, tchar **argv, int cmd)
2713 const tchar *wimfile;
2714 const tchar *image_num_or_name;
2715 const tchar *pathlist;
2716 tchar *dest_dir = T(".");
2717 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2718 int listfile_extract_flags = WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2720 STRING_SET(refglobs);
2722 struct wimlib_extract_command *cmds;
2725 for_opt(c, extract_options) {
2727 case IMAGEX_CHECK_OPTION:
2728 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2730 case IMAGEX_VERBOSE_OPTION:
2731 /* No longer does anything. */
2733 case IMAGEX_REF_OPTION:
2734 ret = string_set_append(&refglobs, optarg);
2736 goto out_free_refglobs;
2738 case IMAGEX_UNIX_DATA_OPTION:
2739 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2741 case IMAGEX_NO_ACLS_OPTION:
2742 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2744 case IMAGEX_STRICT_ACLS_OPTION:
2745 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2747 case IMAGEX_DEST_DIR_OPTION:
2750 case IMAGEX_TO_STDOUT_OPTION:
2751 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2752 imagex_info_file = stderr;
2753 imagex_be_quiet = true;
2755 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2756 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2757 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2759 case IMAGEX_NO_WILDCARDS_OPTION:
2760 listfile_extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2762 case IMAGEX_STRICT_WILDCARDS_OPTION:
2763 listfile_extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2776 image_num_or_name = argv[1];
2781 if (argc == 1 && argv[0][0] == T('@')) {
2782 pathlist = argv[0] + 1;
2786 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2793 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2797 image = wimlib_resolve_image(wim, image_num_or_name);
2798 ret = verify_image_exists_and_is_single(image,
2802 goto out_wimlib_free;
2804 if (refglobs.num_strings) {
2805 ret = wim_reference_globs(wim, &refglobs, open_flags);
2807 goto out_wimlib_free;
2811 if (ret == 0 && cmds != NULL) {
2812 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2813 imagex_progress_func);
2815 if (ret == 0 && pathlist != NULL) {
2816 ret = wimlib_extract_pathlist(wim, image, dest_dir,
2818 extract_flags | listfile_extract_flags,
2819 imagex_progress_func);
2822 if (!imagex_be_quiet)
2823 imagex_printf(T("Done extracting files.\n"));
2824 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2825 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2826 "files and directories\n"
2827 " are in the WIM image.\n"),
2828 get_cmd_string(CMD_DIR, false));
2829 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2830 struct wimlib_wim_info info;
2832 wimlib_get_wim_info(wim, &info);
2833 do_resource_not_found_warning(wimfile, &info, &refglobs);
2838 free_extract_commands(cmds, num_cmds, dest_dir);
2840 string_set_destroy(&refglobs);
2844 usage(CMD_EXTRACT, stderr);
2847 goto out_free_refglobs;
2850 static void print_byte_field(const uint8_t field[], size_t len)
2853 tprintf(T("%02hhx"), *field++);
2857 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2859 tputs(T("WIM Information:"));
2860 tputs(T("----------------"));
2861 tprintf(T("Path: %"TS"\n"), wimfile);
2862 tprintf(T("GUID: 0x"));
2863 print_byte_field(info->guid, sizeof(info->guid));
2865 tprintf(T("Version: %u\n"), info->wim_version);
2866 tprintf(T("Image Count: %d\n"), info->image_count);
2867 tprintf(T("Compression: %"TS"\n"),
2868 wimlib_get_compression_type_string(info->compression_type));
2869 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2871 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2872 tprintf(T("Boot Index: %d\n"), info->boot_index);
2873 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2874 tprintf(T("Integrity Info: %"TS"\n"),
2875 info->has_integrity_table ? T("yes") : T("no"));
2876 tprintf(T("Relative path junction: %"TS"\n"),
2877 info->has_rpfix ? T("yes") : T("no"));
2878 tprintf(T("Pipable: %"TS"\n"),
2879 info->pipable ? T("yes") : T("no"));
2884 print_resource(const struct wimlib_resource_entry *resource,
2887 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2888 resource->uncompressed_size);
2889 if (resource->packed) {
2890 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2891 resource->raw_resource_compressed_size);
2893 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2894 resource->raw_resource_offset_in_wim);
2896 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2899 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2900 resource->compressed_size);
2902 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2906 tprintf(T("Part Number = %u\n"), resource->part_number);
2907 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2909 tprintf(T("Hash = 0x"));
2910 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2913 tprintf(T("Flags = "));
2914 if (resource->is_compressed)
2915 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2916 if (resource->is_metadata)
2917 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2918 if (resource->is_free)
2919 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2920 if (resource->is_spanned)
2921 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2922 if (resource->packed)
2923 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2930 print_lookup_table(WIMStruct *wim)
2932 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2935 /* Prints information about a WIM file; also can mark an image as bootable,
2936 * change the name of an image, or change the description of an image. */
2938 imagex_info(int argc, tchar **argv, int cmd)
2943 bool nocheck = false;
2944 bool header = false;
2945 bool lookup_table = false;
2947 bool metadata = false;
2948 bool short_header = true;
2949 const tchar *xml_out_file = NULL;
2950 const tchar *wimfile;
2951 const tchar *image_num_or_name;
2952 const tchar *new_name;
2953 const tchar *new_desc;
2958 struct wimlib_wim_info info;
2960 for_opt(c, info_options) {
2962 case IMAGEX_BOOT_OPTION:
2965 case IMAGEX_CHECK_OPTION:
2968 case IMAGEX_NOCHECK_OPTION:
2971 case IMAGEX_HEADER_OPTION:
2973 short_header = false;
2975 case IMAGEX_LOOKUP_TABLE_OPTION:
2976 lookup_table = true;
2977 short_header = false;
2979 case IMAGEX_XML_OPTION:
2981 short_header = false;
2983 case IMAGEX_EXTRACT_XML_OPTION:
2984 xml_out_file = optarg;
2985 short_header = false;
2987 case IMAGEX_METADATA_OPTION:
2989 short_header = false;
2998 if (argc < 1 || argc > 4)
3002 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
3003 new_name = (argc >= 3) ? argv[2] : NULL;
3004 new_desc = (argc >= 4) ? argv[3] : NULL;
3006 if (check && nocheck) {
3007 imagex_error(T("Can't specify both --check and --nocheck"));
3012 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3014 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3018 wimlib_get_wim_info(wim, &info);
3020 image = wimlib_resolve_image(wim, image_num_or_name);
3021 ret = WIMLIB_ERR_INVALID_IMAGE;
3022 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3023 verify_image_exists(image, image_num_or_name, wimfile);
3025 imagex_error(T("If you would like to set the boot "
3026 "index to 0, specify image \"0\" with "
3027 "the --boot flag."));
3029 goto out_wimlib_free;
3032 if (boot && info.image_count == 0) {
3033 imagex_error(T("--boot is meaningless on a WIM with no images"));
3034 goto out_wimlib_free;
3037 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3039 imagex_error(T("Cannot specify the --boot flag "
3040 "without specifying a specific "
3041 "image in a multi-image WIM"));
3042 goto out_wimlib_free;
3045 imagex_error(T("Cannot specify the NEW_NAME "
3046 "without specifying a specific "
3047 "image in a multi-image WIM"));
3048 goto out_wimlib_free;
3052 /* Operations that print information are separated from operations that
3053 * recreate the WIM file. */
3054 if (!new_name && !boot) {
3056 /* Read-only operations */
3058 if (image == WIMLIB_NO_IMAGE) {
3059 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3060 image_num_or_name, wimfile);
3061 goto out_wimlib_free;
3064 if (image == WIMLIB_ALL_IMAGES && short_header)
3065 print_wim_information(wimfile, &info);
3068 wimlib_print_header(wim);
3071 if (info.total_parts != 1) {
3072 tfprintf(stderr, T("Warning: Only showing the lookup table "
3073 "for part %d of a %d-part WIM.\n"),
3074 info.part_number, info.total_parts);
3076 print_lookup_table(wim);
3080 ret = wimlib_extract_xml_data(wim, stdout);
3082 goto out_wimlib_free;
3088 fp = tfopen(xml_out_file, T("wb"));
3090 imagex_error_with_errno(T("Failed to open the "
3091 "file \"%"TS"\" for "
3095 goto out_wimlib_free;
3097 ret = wimlib_extract_xml_data(wim, fp);
3099 imagex_error(T("Failed to close the file "
3105 goto out_wimlib_free;
3109 wimlib_print_available_images(wim, image);
3112 ret = wimlib_print_metadata(wim, image);
3114 goto out_wimlib_free;
3119 /* Modification operations */
3121 if (image == WIMLIB_ALL_IMAGES)
3124 if (image == WIMLIB_NO_IMAGE && new_name) {
3125 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3126 "when using image 0"), new_name);
3128 goto out_wimlib_free;
3132 if (image == info.boot_index) {
3133 imagex_printf(T("Image %d is already marked as "
3134 "bootable.\n"), image);
3137 imagex_printf(T("Marking image %d as bootable.\n"),
3139 info.boot_index = image;
3140 ret = wimlib_set_wim_info(wim, &info,
3141 WIMLIB_CHANGE_BOOT_INDEX);
3143 goto out_wimlib_free;
3147 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3149 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3153 imagex_printf(T("Changing the name of image %d to "
3154 "\"%"TS"\".\n"), image, new_name);
3155 ret = wimlib_set_image_name(wim, image, new_name);
3157 goto out_wimlib_free;
3161 const tchar *old_desc;
3162 old_desc = wimlib_get_image_description(wim, image);
3163 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3164 imagex_printf(T("The description of image %d is already "
3165 "\"%"TS"\".\n"), image, new_desc);
3168 imagex_printf(T("Changing the description of image %d "
3169 "to \"%"TS"\".\n"), image, new_desc);
3170 ret = wimlib_set_image_descripton(wim, image,
3173 goto out_wimlib_free;
3177 /* Only call wimlib_overwrite() if something actually needs to
3179 if (boot || new_name || new_desc ||
3180 (check && !info.has_integrity_table) ||
3181 (nocheck && info.has_integrity_table))
3183 int write_flags = 0;
3186 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3188 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3189 ret = wimlib_overwrite(wim, write_flags, 1,
3190 imagex_progress_func);
3192 imagex_printf(T("The file \"%"TS"\" was not modified "
3193 "because nothing needed to be done.\n"),
3204 usage(CMD_INFO, stderr);
3210 /* Join split WIMs into one part WIM */
3212 imagex_join(int argc, tchar **argv, int cmd)
3215 int swm_open_flags = 0;
3216 int wim_write_flags = 0;
3217 const tchar *output_path;
3220 for_opt(c, join_options) {
3222 case IMAGEX_CHECK_OPTION:
3223 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3224 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3234 imagex_error(T("Must specify one or more split WIM (.swm) "
3238 output_path = argv[0];
3239 ret = wimlib_join((const tchar * const *)++argv,
3244 imagex_progress_func);
3249 usage(CMD_JOIN, stderr);
3254 #if WIM_MOUNTING_SUPPORTED
3256 /* Mounts a WIM image. */
3258 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3261 int mount_flags = 0;
3263 const tchar *staging_dir = NULL;
3264 const tchar *wimfile;
3267 struct wimlib_wim_info info;
3271 STRING_SET(refglobs);
3273 if (cmd == CMD_MOUNTRW) {
3274 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3275 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3278 for_opt(c, mount_options) {
3280 case IMAGEX_ALLOW_OTHER_OPTION:
3281 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3283 case IMAGEX_CHECK_OPTION:
3284 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3286 case IMAGEX_DEBUG_OPTION:
3287 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3289 case IMAGEX_STREAMS_INTERFACE_OPTION:
3290 if (!tstrcasecmp(optarg, T("none")))
3291 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3292 else if (!tstrcasecmp(optarg, T("xattr")))
3293 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3294 else if (!tstrcasecmp(optarg, T("windows")))
3295 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3297 imagex_error(T("Unknown stream interface \"%"TS"\""),
3302 case IMAGEX_REF_OPTION:
3303 ret = string_set_append(&refglobs, optarg);
3305 goto out_free_refglobs;
3307 case IMAGEX_STAGING_DIR_OPTION:
3308 staging_dir = optarg;
3310 case IMAGEX_UNIX_DATA_OPTION:
3311 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3319 if (argc != 2 && argc != 3)
3324 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3326 goto out_free_refglobs;
3328 wimlib_get_wim_info(wim, &info);
3331 /* Image explicitly specified. */
3332 image = wimlib_resolve_image(wim, argv[1]);
3334 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3338 /* No image specified; default to image 1, but only if the WIM
3339 * contains exactly one image. */
3341 if (info.image_count != 1) {
3342 imagex_error(T("\"%"TS"\" contains %d images; Please "
3343 "select one."), wimfile, info.image_count);
3351 if (refglobs.num_strings) {
3352 ret = wim_reference_globs(wim, &refglobs, open_flags);
3357 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3359 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3361 image, wimfile, dir);
3366 string_set_destroy(&refglobs);
3372 goto out_free_refglobs;
3374 #endif /* WIM_MOUNTING_SUPPORTED */
3376 /* Rebuild a WIM file */
3378 imagex_optimize(int argc, tchar **argv, int cmd)
3381 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3382 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3383 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3384 uint32_t chunk_size = UINT32_MAX;
3387 const tchar *wimfile;
3390 unsigned num_threads = 0;
3392 for_opt(c, optimize_options) {
3394 case IMAGEX_CHECK_OPTION:
3395 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3396 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3398 case IMAGEX_NOCHECK_OPTION:
3399 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3401 case IMAGEX_COMPRESS_OPTION:
3402 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3403 compression_type = get_compression_type(optarg);
3404 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3407 case IMAGEX_RECOMPRESS_OPTION:
3408 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3410 case IMAGEX_COMPRESS_SLOW_OPTION:
3411 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3412 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
3413 ret = set_compress_slow();
3417 case IMAGEX_CHUNK_SIZE_OPTION:
3418 chunk_size = parse_chunk_size(optarg);
3419 if (chunk_size == UINT32_MAX)
3422 case IMAGEX_PACK_STREAMS_OPTION:
3423 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3424 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3426 case IMAGEX_THREADS_OPTION:
3427 num_threads = parse_num_threads(optarg);
3428 if (num_threads == UINT_MAX)
3431 case IMAGEX_PIPABLE_OPTION:
3432 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3434 case IMAGEX_NOT_PIPABLE_OPTION:
3435 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3449 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3453 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3454 /* Change compression type. */
3455 ret = wimlib_set_output_compression_type(wim, compression_type);
3457 goto out_wimlib_free;
3460 if (chunk_size != UINT32_MAX) {
3461 /* Change chunk size. */
3462 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3464 goto out_wimlib_free;
3467 old_size = file_get_size(wimfile);
3468 tprintf(T("\"%"TS"\" original size: "), wimfile);
3470 tputs(T("Unknown"));
3472 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3474 ret = wimlib_overwrite(wim, write_flags, num_threads,
3475 imagex_progress_func);
3477 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3478 goto out_wimlib_free;
3481 new_size = file_get_size(wimfile);
3482 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3484 tputs(T("Unknown"));
3486 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3488 tfputs(T("Space saved: "), stdout);
3489 if (new_size != -1 && old_size != -1) {
3490 tprintf(T("%lld KiB\n"),
3491 ((long long)old_size - (long long)new_size) >> 10);
3493 tputs(T("Unknown"));
3502 usage(CMD_OPTIMIZE, stderr);
3508 /* Split a WIM into a spanned set */
3510 imagex_split(int argc, tchar **argv, int cmd)
3514 int write_flags = 0;
3515 unsigned long part_size;
3520 for_opt(c, split_options) {
3522 case IMAGEX_CHECK_OPTION:
3523 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3524 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3536 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3537 if (tmp == argv[2] || *tmp) {
3538 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3539 imagex_error(T("The part size must be an integer or "
3540 "floating-point number of megabytes."));
3543 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3547 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3553 usage(CMD_SPLIT, stderr);
3559 #if WIM_MOUNTING_SUPPORTED
3560 /* Unmounts a mounted WIM image. */
3562 imagex_unmount(int argc, tchar **argv, int cmd)
3565 int unmount_flags = 0;
3568 for_opt(c, unmount_options) {
3570 case IMAGEX_COMMIT_OPTION:
3571 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3573 case IMAGEX_CHECK_OPTION:
3574 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3576 case IMAGEX_REBUILD_OPTION:
3577 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3579 case IMAGEX_LAZY_OPTION:
3580 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3591 ret = wimlib_unmount_image(argv[0], unmount_flags,
3592 imagex_progress_func);
3594 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3599 usage(CMD_UNMOUNT, stderr);
3603 #endif /* WIM_MOUNTING_SUPPORTED */
3606 * Add, delete, or rename files in a WIM image.
3609 imagex_update(int argc, tchar **argv, int cmd)
3611 const tchar *wimfile;
3615 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3616 int write_flags = 0;
3617 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3618 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3619 WIMLIB_ADD_FLAG_VERBOSE;
3620 int default_delete_flags = 0;
3621 unsigned num_threads = 0;
3623 tchar *cmd_file_contents;
3624 size_t cmd_file_nchars;
3625 struct wimlib_update_command *cmds;
3627 tchar *command_str = NULL;
3629 const tchar *config_file = NULL;
3631 struct wimlib_capture_config *config;
3633 for_opt(c, update_options) {
3635 /* Generic or write options */
3636 case IMAGEX_THREADS_OPTION:
3637 num_threads = parse_num_threads(optarg);
3638 if (num_threads == UINT_MAX)
3641 case IMAGEX_CHECK_OPTION:
3642 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3643 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3645 case IMAGEX_REBUILD_OPTION:
3646 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3648 case IMAGEX_COMMAND_OPTION:
3650 imagex_error(T("--command may only be specified "
3651 "one time. Please provide\n"
3652 " the update commands "
3653 "on standard input instead."));
3656 command_str = tstrdup(optarg);
3658 imagex_error(T("Out of memory!"));
3662 /* Default delete options */
3663 case IMAGEX_FORCE_OPTION:
3664 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3666 case IMAGEX_RECURSIVE_OPTION:
3667 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3670 /* Global add option */
3671 case IMAGEX_CONFIG_OPTION:
3672 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3673 config_file = optarg;
3676 /* Default add options */
3677 case IMAGEX_VERBOSE_OPTION:
3678 /* No longer does anything. */
3680 case IMAGEX_DEREFERENCE_OPTION:
3681 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3683 case IMAGEX_UNIX_DATA_OPTION:
3684 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3686 case IMAGEX_NO_ACLS_OPTION:
3687 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3689 case IMAGEX_STRICT_ACLS_OPTION:
3690 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3699 if (argc != 1 && argc != 2)
3703 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3705 goto out_free_command_str;
3708 /* Image explicitly specified. */
3709 image = wimlib_resolve_image(wim, argv[1]);
3710 ret = verify_image_exists_and_is_single(image, argv[1],
3713 goto out_wimlib_free;
3715 /* No image specified; default to image 1, but only if the WIM
3716 * contains exactly one image. */
3717 struct wimlib_wim_info info;
3719 wimlib_get_wim_info(wim, &info);
3720 if (info.image_count != 1) {
3721 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3722 wimfile, info.image_count);
3729 /* Parse capture configuration file if specified */
3733 config_str = file_get_text_contents(config_file, &config_len);
3736 goto out_wimlib_free;
3739 config = alloca(sizeof(*config));
3740 ret = parse_capture_config(&config_str, config_len, config);
3742 goto out_free_config;
3745 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3748 /* Read update commands from standard input, or the command string if
3751 cmd_file_contents = NULL;
3752 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3755 if (isatty(STDIN_FILENO)) {
3756 tputs(T("Reading update commands from standard input..."));
3757 recommend_man_page(CMD_UPDATE, stdout);
3759 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3760 if (!cmd_file_contents) {
3762 goto out_free_config;
3765 /* Parse the update commands */
3766 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3771 goto out_free_cmd_file_contents;
3774 /* Set default flags and capture config on the update commands */
3775 for (size_t i = 0; i < num_cmds; i++) {
3776 switch (cmds[i].op) {
3777 case WIMLIB_UPDATE_OP_ADD:
3778 cmds[i].add.add_flags |= default_add_flags;
3779 cmds[i].add.config = config;
3781 case WIMLIB_UPDATE_OP_DELETE:
3782 cmds[i].delete_.delete_flags |= default_delete_flags;
3789 /* Execute the update commands */
3790 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3791 imagex_progress_func);
3795 /* Overwrite the updated WIM */
3796 ret = wimlib_overwrite(wim, write_flags, num_threads,
3797 imagex_progress_func);
3800 out_free_cmd_file_contents:
3801 free(cmd_file_contents);
3804 free(config->exclusion_pats.pats);
3805 free(config->exclusion_exception_pats.pats);
3810 out_free_command_str:
3815 usage(CMD_UPDATE, stderr);
3818 goto out_free_command_str;
3823 struct imagex_command {
3825 int (*func)(int argc, tchar **argv, int cmd);
3828 static const struct imagex_command imagex_commands[] = {
3829 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3830 [CMD_APPLY] = {T("apply"), imagex_apply},
3831 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3832 [CMD_DELETE] = {T("delete"), imagex_delete},
3833 [CMD_DIR ] = {T("dir"), imagex_dir},
3834 [CMD_EXPORT] = {T("export"), imagex_export},
3835 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3836 [CMD_INFO] = {T("info"), imagex_info},
3837 [CMD_JOIN] = {T("join"), imagex_join},
3838 #if WIM_MOUNTING_SUPPORTED
3839 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3840 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3842 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3843 [CMD_SPLIT] = {T("split"), imagex_split},
3844 #if WIM_MOUNTING_SUPPORTED
3845 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3847 [CMD_UPDATE] = {T("update"), imagex_update},
3850 static const tchar *usage_strings[] = {
3853 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3854 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3855 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
3856 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3857 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3858 " [--update-of=[WIMFILE:]IMAGE]\n"
3862 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3863 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
3864 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3865 " [--hardlink] [--symlink] [--include-invalid-names]\n"
3869 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3870 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3871 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3872 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3873 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3874 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
3875 " [--delta-from=WIMFILE]\n"
3879 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
3880 " [--check] [--soft]\n"
3884 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3888 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3889 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3890 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3891 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3895 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) ([PATH...] | @LISTFILE)\n"
3896 " [--check] [--ref=\"GLOB\"] [--no-acls] [--strict-acls]\n"
3897 " [--to-stdout] [--dest-dir=CMD_DIR]\n"
3898 " [--include-invalid-names]\n"
3902 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3903 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
3904 " [--extract-xml FILE] [--header] [--lookup-table]\n"
3908 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3910 #if WIM_MOUNTING_SUPPORTED
3913 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3914 " [--check] [--streams-interface=INTERFACE]\n"
3915 " [--ref=\"GLOB\"] [--allow-other]\n"
3919 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3920 " [--check] [--streams-interface=INTERFACE]\n"
3921 " [--staging-dir=CMD_DIR] [--allow-other]\n"
3926 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3927 " [--recompress-slow] [--compress=TYPE]\n"
3928 " [--threads=NUM_THREADS]\n"
3932 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3934 #if WIM_MOUNTING_SUPPORTED
3937 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3942 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3943 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3944 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3948 static const tchar *invocation_name;
3949 static int invocation_cmd = CMD_NONE;
3951 static const tchar *get_cmd_string(int cmd, bool nospace)
3953 static tchar buf[50];
3954 if (cmd == CMD_NONE) {
3955 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3956 } else if (invocation_cmd != CMD_NONE) {
3957 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3959 const tchar *format;
3962 format = T("%"TS"-%"TS"");
3964 format = T("%"TS" %"TS"");
3965 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3973 static const tchar *s =
3975 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3976 "Copyright (C) 2012, 2013 Eric Biggers\n"
3977 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3978 "This is free software: you are free to change and redistribute it.\n"
3979 "There is NO WARRANTY, to the extent permitted by law.\n"
3981 "Report bugs to "PACKAGE_BUGREPORT".\n"
3988 help_or_version(int argc, tchar **argv, int cmd)
3993 for (i = 1; i < argc; i++) {
3995 if (p[0] == T('-') && p[1] == T('-')) {
3997 if (!tstrcmp(p, T("help"))) {
3998 if (cmd == CMD_NONE)
4003 } else if (!tstrcmp(p, T("version"))) {
4012 print_usage_string(int cmd, FILE *fp)
4014 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4018 recommend_man_page(int cmd, FILE *fp)
4020 const tchar *format_str;
4022 format_str = T("Uncommon options are not listed;\n"
4023 "See %"TS".pdf in the doc directory for more details.\n");
4025 format_str = T("Uncommon options are not listed;\n"
4026 "Try `man %"TS"' for more details.\n");
4028 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4032 usage(int cmd, FILE *fp)
4034 tfprintf(fp, T("Usage:\n"));
4035 print_usage_string(cmd, fp);
4036 tfprintf(fp, T("\n"));
4037 recommend_man_page(cmd, fp);
4043 tfprintf(fp, T("Usage:\n"));
4044 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4045 print_usage_string(cmd, fp);
4046 tfprintf(fp, T("\n"));
4048 static const tchar *extra =
4051 " %"TS" --version\n"
4053 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4056 tfprintf(fp, extra, invocation_name, invocation_name);
4057 recommend_man_page(CMD_NONE, fp);
4060 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4061 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4062 * something else), while an Windows the command arguments will be UTF-16LE
4063 * encoded 'wchar_t' strings. */
4066 wmain(int argc, wchar_t **argv, wchar_t **envp)
4068 main(int argc, char **argv)
4075 imagex_info_file = stdout;
4076 invocation_name = tbasename(argv[0]);
4079 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4080 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4084 setlocale(LC_ALL, "");
4085 codeset = nl_langinfo(CODESET);
4086 if (!strstr(codeset, "UTF-8") &&
4087 !strstr(codeset, "UTF8") &&
4088 !strstr(codeset, "utf-8") &&
4089 !strstr(codeset, "utf8"))
4092 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4093 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4094 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4095 " to any value to force wimlib to use UTF-8.\n",
4101 #endif /* !__WIN32__ */
4104 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4105 if (igcase != NULL) {
4106 if (!tstrcmp(igcase, T("no")) ||
4107 !tstrcmp(igcase, T("0")))
4108 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4109 else if (!tstrcmp(igcase, T("yes")) ||
4110 !tstrcmp(igcase, T("1")))
4111 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4114 "WARNING: Ignoring unknown setting of "
4115 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4120 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4122 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4123 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4124 for (int i = 0; i < CMD_MAX; i++) {
4125 if (!tstrcmp(invocation_name + 3,
4126 imagex_commands[i].name))
4135 /* Unless already known from the invocation name, determine which
4136 * command was specified. */
4137 if (cmd == CMD_NONE) {
4139 imagex_error(T("No command specified!\n"));
4143 for (int i = 0; i < CMD_MAX; i++) {
4144 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4149 if (cmd != CMD_NONE) {
4155 /* Handle --help and --version. --help can be either for the program as
4156 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4157 * CMD_NONE). Note: help_or_version() will not return if a --help or
4158 * --version argument was found. */
4159 help_or_version(argc, argv, cmd);
4161 /* Bail if a valid command was not specified. */
4162 if (cmd == CMD_NONE) {
4163 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4168 /* Enable warning and error messages in wimlib be more user-friendly.
4170 wimlib_set_print_errors(true);
4172 /* Initialize wimlib. */
4173 ret = wimlib_global_init(init_flags);
4175 goto out_check_status;
4177 /* Call the command handler function. */
4178 ret = imagex_commands[cmd].func(argc, argv, cmd);
4180 /* Check for error writing to standard output, especially since for some
4181 * commands, writing to standard output is part of the program's actual
4182 * behavior and not just for informational purposes. */
4183 if (ferror(stdout) || fclose(stdout)) {
4184 imagex_error_with_errno(T("error writing to standard output"));
4189 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4190 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4191 * error code from which an error message can be printed. */
4193 imagex_error(T("Exiting with error code %d:\n"
4195 wimlib_get_error_string(ret));
4196 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4197 imagex_error_with_errno(T("errno"));
4199 /* Make wimlib free any resources it's holding (although this is not
4200 * strictly necessary because the process is ending anyway). */
4201 wimlib_global_cleanup();