4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 # include "config.h" /* Need for PACKAGE_VERSION, etc. */
30 #include "wimlib_tchar.h"
50 # include "imagex-win32.h"
51 # define tbasename win32_wbasename
52 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
53 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
57 # include <langinfo.h>
58 # define tbasename basename
59 # define OS_PREFERRED_PATH_SEPARATOR '/'
60 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
61 static inline void set_fd_to_binary_mode(int fd)
66 /* Don't confuse the user by presenting the mounting commands on Windows when
67 * they will never work. However on UNIX-like systems we always present them,
68 * even if WITH_FUSE is not defined at this point, as to not tie the build of
69 * wimlib-imagex to a specific build of wimlib. */
71 # define WIM_MOUNTING_SUPPORTED 0
73 # define WIM_MOUNTING_SUPPORTED 1
76 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
92 #if WIM_MOUNTING_SUPPORTED
98 #if WIM_MOUNTING_SUPPORTED
105 static void usage(int cmd, FILE *fp);
106 static void usage_all(FILE *fp);
107 static void recommend_man_page(int cmd, FILE *fp);
108 static const tchar *get_cmd_string(int cmd, bool nospace);
110 static int imagex_progress_func(enum wimlib_progress_msg msg,
111 const union wimlib_progress_info *info);
113 static bool imagex_be_quiet = false;
114 static FILE *imagex_info_file;
116 #define imagex_printf(format, ...) \
117 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
120 IMAGEX_ALLOW_OTHER_OPTION,
123 IMAGEX_CHUNK_SIZE_OPTION,
124 IMAGEX_COMMAND_OPTION,
125 IMAGEX_COMMIT_OPTION,
126 IMAGEX_COMPRESS_OPTION,
127 IMAGEX_COMPRESS_SLOW_OPTION,
128 IMAGEX_CONFIG_OPTION,
130 IMAGEX_DELTA_FROM_OPTION,
131 IMAGEX_DEREFERENCE_OPTION,
132 IMAGEX_DEST_DIR_OPTION,
133 IMAGEX_EXTRACT_XML_OPTION,
136 IMAGEX_HARDLINK_OPTION,
137 IMAGEX_HEADER_OPTION,
138 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
140 IMAGEX_LOOKUP_TABLE_OPTION,
141 IMAGEX_METADATA_OPTION,
142 IMAGEX_NORPFIX_OPTION,
143 IMAGEX_NOCHECK_OPTION,
144 IMAGEX_NO_ACLS_OPTION,
145 IMAGEX_NO_PACK_STREAMS_OPTION,
146 IMAGEX_NOT_PIPABLE_OPTION,
147 IMAGEX_PACK_STREAMS_OPTION,
149 IMAGEX_PIPABLE_OPTION,
150 IMAGEX_REBUILD_OPTION,
151 IMAGEX_RECOMPRESS_OPTION,
152 IMAGEX_RECURSIVE_OPTION,
154 IMAGEX_RESUME_OPTION,
157 IMAGEX_SOURCE_LIST_OPTION,
158 IMAGEX_STAGING_DIR_OPTION,
159 IMAGEX_STREAMS_INTERFACE_OPTION,
160 IMAGEX_STRICT_ACLS_OPTION,
161 IMAGEX_SYMLINK_OPTION,
162 IMAGEX_THREADS_OPTION,
163 IMAGEX_TO_STDOUT_OPTION,
164 IMAGEX_UNIX_DATA_OPTION,
165 IMAGEX_UPDATE_OF_OPTION,
166 IMAGEX_VERBOSE_OPTION,
170 static const struct option apply_options[] = {
171 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
172 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
173 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
174 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
175 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
176 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
177 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
178 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
179 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
180 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
181 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
182 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
184 /* --resume is undocumented for now as it needs improvement. */
185 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
189 static const struct option capture_or_append_options[] = {
190 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
191 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
192 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
193 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
194 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
195 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
196 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
197 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
198 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
199 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
200 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
201 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
202 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
203 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
204 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
205 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
206 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
207 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
208 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
209 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
210 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
211 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
212 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
213 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
214 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
218 static const struct option delete_options[] = {
219 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
220 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
224 static const struct option dir_options[] = {
225 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
229 static const struct option export_options[] = {
230 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
231 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
232 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
233 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
234 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
235 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
236 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
237 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
238 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
239 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
243 static const struct option extract_options[] = {
244 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
245 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
246 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
247 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
248 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
249 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
250 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
251 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
252 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
253 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
257 static const struct option info_options[] = {
258 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
259 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
260 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
261 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
262 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
263 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
264 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
265 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
266 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
270 static const struct option join_options[] = {
271 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
275 static const struct option mount_options[] = {
276 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
277 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
278 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
279 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
280 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
281 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
282 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
286 static const struct option optimize_options[] = {
287 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
288 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
289 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
290 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
291 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
292 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
293 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
294 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
295 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
296 {T("no-pack-streams"), no_argument, NULL, IMAGEX_NO_PACK_STREAMS_OPTION},
297 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
298 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
299 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
303 static const struct option split_options[] = {
304 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
308 static const struct option unmount_options[] = {
309 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
310 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
311 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
312 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
316 static const struct option update_options[] = {
317 /* Careful: some of the options here set the defaults for update
318 * commands, but the flags given to an actual update command (and not to
319 * `imagex update' itself are also handled in
320 * update_command_add_option(). */
321 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
322 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
323 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
324 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
326 /* Default delete options */
327 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
328 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
330 /* Global add option */
331 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
333 /* Default add options */
334 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
335 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
336 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
337 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
338 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
339 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
345 # define _format_attribute(type, format_str, args_start) \
346 __attribute__((format(type, format_str, args_start)))
348 # define _format_attribute(type, format_str, args_start)
351 /* Print formatted error message to stderr. */
352 static void _format_attribute(printf, 1, 2)
353 imagex_error(const tchar *format, ...)
356 va_start(va, format);
357 tfputs(T("ERROR: "), stderr);
358 tvfprintf(stderr, format, va);
359 tputc(T('\n'), stderr);
363 /* Print formatted error message to stderr. */
364 static void _format_attribute(printf, 1, 2)
365 imagex_error_with_errno(const tchar *format, ...)
367 int errno_save = errno;
369 va_start(va, format);
370 tfputs(T("ERROR: "), stderr);
371 tvfprintf(stderr, format, va);
372 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
377 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
379 if (image == WIMLIB_NO_IMAGE) {
380 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
381 " Please specify a 1-based image index or "
382 "image name. To list the images\n"
383 " contained in the WIM archive, run\n"
385 " %"TS" \"%"TS"\"\n"),
386 image_name, wim_name,
387 get_cmd_string(CMD_INFO, false), wim_name);
388 return WIMLIB_ERR_INVALID_IMAGE;
394 verify_image_is_single(int image)
396 if (image == WIMLIB_ALL_IMAGES) {
397 imagex_error(T("Cannot specify all images for this action!"));
398 return WIMLIB_ERR_INVALID_IMAGE;
404 verify_image_exists_and_is_single(int image, const tchar *image_name,
405 const tchar *wim_name)
408 ret = verify_image_exists(image, image_name, wim_name);
410 ret = verify_image_is_single(image);
414 /* Parse the argument to --compress */
416 get_compression_type(const tchar *optarg)
418 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
419 return WIMLIB_COMPRESSION_TYPE_LZX;
420 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
421 return WIMLIB_COMPRESSION_TYPE_XPRESS;
422 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
423 return WIMLIB_COMPRESSION_TYPE_LZMS;
424 else if (!tstrcasecmp(optarg, T("none")))
425 return WIMLIB_COMPRESSION_TYPE_NONE;
427 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
428 "\"maximum\", \"fast\", or \"none\"."), optarg);
429 return WIMLIB_COMPRESSION_TYPE_INVALID;
434 set_compress_slow(void)
437 static const struct wimlib_lzx_params slow_params = {
438 .size_of_this = sizeof(struct wimlib_lzx_params),
439 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
442 .use_len2_matches = 1,
443 .num_fast_bytes = 96,
444 .num_optim_passes = 4,
445 .max_search_depth = 100,
446 .max_matches_per_pos = 10,
447 .main_nostat_cost = 15,
448 .len_nostat_cost = 15,
449 .aligned_nostat_cost = 7,
453 ret = wimlib_lzx_set_default_params(&slow_params);
455 imagex_error(T("Couldn't set slow compression parameters.!"));
460 const tchar **strings;
461 unsigned num_strings;
462 unsigned num_alloc_strings;
465 #define STRING_SET_INITIALIZER \
466 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
468 #define STRING_SET(_strings) \
469 struct string_set _strings = STRING_SET_INITIALIZER
472 string_set_append(struct string_set *set, const tchar *glob)
474 unsigned num_alloc_strings = set->num_alloc_strings;
476 if (set->num_strings == num_alloc_strings) {
477 const tchar **new_strings;
479 num_alloc_strings += 4;
480 new_strings = realloc(set->strings,
481 sizeof(set->strings[0]) * num_alloc_strings);
483 imagex_error(T("Out of memory!"));
486 set->strings = new_strings;
487 set->num_alloc_strings = num_alloc_strings;
489 set->strings[set->num_strings++] = glob;
494 string_set_destroy(struct string_set *set)
500 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
502 return wimlib_reference_resource_files(wim, set->strings,
504 WIMLIB_REF_FLAG_GLOB_ENABLE,
506 imagex_progress_func);
510 do_resource_not_found_warning(const tchar *wimfile,
511 const struct wimlib_wim_info *info,
512 const struct string_set *refglobs)
514 if (info->total_parts > 1) {
515 if (refglobs->num_strings == 0) {
516 imagex_error(T("\"%"TS"\" is part of a split WIM. "
517 "Use --ref to specify the other parts."),
520 imagex_error(T("Perhaps the '--ref' argument did not "
521 "specify all other parts of the split "
525 imagex_error(T("If this is a delta WIM, use the --ref argument "
526 "to specify the WIM(s) on which it is based."));
530 /* Returns the size of a file given its name, or -1 if the file does not exist
531 * or its size cannot be determined. */
533 file_get_size(const tchar *filename)
536 if (tstat(filename, &st) == 0)
543 PARSE_STRING_SUCCESS = 0,
544 PARSE_STRING_FAILURE = 1,
545 PARSE_STRING_NONE = 2,
549 * Parses a string token from an array of characters.
551 * Tokens are either whitespace-delimited, or double or single-quoted.
553 * @line_p: Pointer to the pointer to the line of data. Will be updated
554 * to point past the string token iff the return value is
555 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
558 * @len_p: @len_p initially stores the length of the line of data, which may
559 * be 0, and it will be updated to the number of bytes remaining in
560 * the line iff the return value is PARSE_STRING_SUCCESS.
562 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
563 * parsed string token will be returned here.
565 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
566 * PARSE_STRING_FAILURE if the data was invalid due to a missing
567 * closing quote; or PARSE_STRING_NONE if the line ended before the
568 * beginning of a string token was found.
571 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
574 tchar *line = *line_p;
578 /* Skip leading whitespace */
581 return PARSE_STRING_NONE;
582 if (!istspace(*line) && *line != T('\0'))
588 if (quote_char == T('"') || quote_char == T('\'')) {
593 line = tmemchr(line, quote_char, len);
595 imagex_error(T("Missing closing quote: %"TS), fn - 1);
596 return PARSE_STRING_FAILURE;
599 /* Unquoted string. Go until whitespace. Line is terminated
600 * by '\0', so no need to check 'len'. */
604 } while (!istspace(*line) && *line != T('\0'));
611 return PARSE_STRING_SUCCESS;
614 /* Parses a line of data (not an empty line or comment) in the source list file
615 * format. (See the man page for 'wimlib-imagex capture' for details on this
616 * format and the meaning.)
618 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
619 * len == 0. The data in @line will be modified by this function call.
621 * @len: Length of the line of data.
623 * @source: On success, the capture source and target described by the line is
624 * written into this destination. Note that it will contain pointers
625 * to data in the @line array.
627 * Returns true if the line was valid; false otherwise. */
629 parse_source_list_line(tchar *line, size_t len,
630 struct wimlib_capture_source *source)
634 ret = parse_string(&line, &len, &source->fs_source_path);
635 if (ret != PARSE_STRING_SUCCESS)
637 ret = parse_string(&line, &len, &source->wim_target_path);
638 if (ret == PARSE_STRING_NONE)
639 source->wim_target_path = source->fs_source_path;
640 return ret != PARSE_STRING_FAILURE;
643 /* Returns %true if the given line of length @len > 0 is a comment or empty line
644 * in the source list file format. */
646 is_comment_line(const tchar *line, size_t len)
651 if (!istspace(*line) && *line != T('\0'))
661 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
664 tchar *contents = *contents_p;
665 size_t nchars = *nchars_p;
668 for (i = 0; i < nchars; i++)
669 if (contents[i] == T('\n'))
672 /* Handle last line not terminated by a newline */
673 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
674 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
676 imagex_error(T("Out of memory!"));
679 contents[nchars] = T('\n');
680 *contents_p = contents;
688 /* Parses a file in the source list format. (See the man page for
689 * 'wimlib-imagex capture' for details on this format and the meaning.)
691 * @source_list_contents: Contents of the source list file. Note that this
692 * buffer will be modified to save memory allocations,
693 * and cannot be freed until the returned array of
694 * wimlib_capture_source's has also been freed.
696 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
699 * @nsources_ret: On success, the length of the returned array is
702 * Returns: An array of `struct wimlib_capture_source's that can be passed to
703 * the wimlib_add_image_multisource() function to specify how a WIM image is to
705 static struct wimlib_capture_source *
706 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
707 size_t *nsources_ret)
711 struct wimlib_capture_source *sources;
714 nlines = text_file_count_lines(source_list_contents_p,
715 &source_list_nchars);
719 /* Always allocate at least 1 slot, just in case the implementation of
720 * calloc() returns NULL if 0 bytes are requested. */
721 sources = calloc(nlines ?: 1, sizeof(*sources));
723 imagex_error(T("out of memory"));
726 p = *source_list_contents_p;
728 for (i = 0; i < nlines; i++) {
729 /* XXX: Could use rawmemchr() here instead, but it may not be
730 * available on all platforms. */
731 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
732 size_t len = endp - p + 1;
734 if (!is_comment_line(p, len)) {
735 if (!parse_source_list_line(p, len, &sources[j++])) {
748 enum capture_config_section {
749 CAPTURE_CONFIG_NO_SECTION,
750 CAPTURE_CONFIG_EXCLUSION_SECTION,
751 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
752 CAPTURE_CONFIG_IGNORE_SECTION,
756 CAPTURE_CONFIG_INVALID_SECTION,
757 CAPTURE_CONFIG_CHANGED_SECTION,
758 CAPTURE_CONFIG_SAME_SECTION,
762 check_config_section(tchar *line, size_t len,
763 enum capture_config_section *cur_section)
765 while (istspace(*line))
769 return CAPTURE_CONFIG_SAME_SECTION;
772 tchar *endbrace = tstrrchr(line, T(']'));
774 return CAPTURE_CONFIG_SAME_SECTION;
776 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
777 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
778 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
779 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
780 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
781 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
782 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
783 "of capture config file\n"),
785 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
786 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
787 tfputs(T("WARNING: Ignoring [AlignmentList] section "
788 "of capture config file\n"),
791 imagex_error(T("Invalid capture config file section \"%"TS"\""),
793 return CAPTURE_CONFIG_INVALID_SECTION;
795 return CAPTURE_CONFIG_CHANGED_SECTION;
800 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
803 if (pat_list->num_pats == pat_list->num_allocated_pats) {
805 size_t num_allocated_pats = pat_list->num_pats + 8;
807 pats = realloc(pat_list->pats,
808 num_allocated_pats * sizeof(pat_list->pats[0]));
810 imagex_error(T("Out of memory!"));
813 pat_list->pats = pats;
814 pat_list->num_allocated_pats = num_allocated_pats;
816 pat_list->pats[pat_list->num_pats++] = pat;
821 parse_capture_config_line(tchar *line, size_t len,
822 enum capture_config_section *cur_section,
823 struct wimlib_capture_config *config)
828 ret = check_config_section(line, len, cur_section);
829 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
831 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
834 switch (*cur_section) {
835 case CAPTURE_CONFIG_NO_SECTION:
836 imagex_error(T("Line \"%"TS"\" is not in a section "
837 "(such as [ExclusionList]"), line);
839 case CAPTURE_CONFIG_EXCLUSION_SECTION:
840 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
842 return pattern_list_add_pattern(&config->exclusion_pats,
844 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
845 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
847 return pattern_list_add_pattern(&config->exclusion_exception_pats,
849 case CAPTURE_CONFIG_IGNORE_SECTION:
856 parse_capture_config(tchar **contents_p, size_t nchars,
857 struct wimlib_capture_config *config)
862 enum capture_config_section cur_section;
864 memset(config, 0, sizeof(*config));
866 nlines = text_file_count_lines(contents_p, &nchars);
870 cur_section = CAPTURE_CONFIG_NO_SECTION;
872 for (i = 0; i < nlines; i++) {
873 tchar *endp = tmemchr(p, T('\n'), nchars);
874 size_t len = endp - p + 1;
876 if (!is_comment_line(p, len))
877 if (!parse_capture_config_line(p, len, &cur_section, config))
885 /* Reads the contents of a file into memory. */
887 file_get_contents(const tchar *filename, size_t *len_ret)
894 if (tstat(filename, &stbuf) != 0) {
895 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
900 fp = tfopen(filename, T("rb"));
902 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
906 buf = malloc(len ? len : 1);
908 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
909 "contents of file \"%"TS"\""), len, filename);
912 if (fread(buf, 1, len, fp) != len) {
913 imagex_error_with_errno(T("Failed to read %zu bytes from the "
914 "file \"%"TS"\""), len, filename);
928 /* Read standard input until EOF and return the full contents in a malloc()ed
929 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
932 stdin_get_contents(size_t *len_ret)
934 /* stdin can, of course, be a pipe or other non-seekable file, so the
935 * total length of the data cannot be pre-determined */
937 size_t newlen = 1024;
941 char *p = realloc(buf, newlen);
942 size_t bytes_read, bytes_to_read;
944 imagex_error(T("out of memory while reading stdin"));
948 bytes_to_read = newlen - pos;
949 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
951 if (bytes_read != bytes_to_read) {
956 imagex_error_with_errno(T("error reading stdin"));
970 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
973 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
975 *num_tchars_ret = num_bytes;
977 #else /* !__WIN32__ */
978 /* On Windows, translate the text to UTF-16LE */
982 if (num_bytes >= 2 &&
983 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
984 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
986 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
987 * with something that looks like an ASCII character encoded as
988 * a UTF-16LE code unit. Assume the file is encoded as
989 * UTF-16LE. This is not a 100% reliable check. */
990 num_wchars = num_bytes / 2;
991 text_wstr = (wchar_t*)text;
993 /* File does not look like UTF-16LE. Assume it is encoded in
994 * the current Windows code page. I think these are always
995 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
996 * should work as expected. */
997 text_wstr = win32_mbs_to_wcs(text,
1002 *num_tchars_ret = num_wchars;
1004 #endif /* __WIN32__ */
1008 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1013 contents = file_get_contents(filename, &num_bytes);
1016 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1020 stdin_get_text_contents(size_t *num_tchars_ret)
1025 contents = stdin_get_contents(&num_bytes);
1028 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1031 #define TO_PERCENT(numerator, denominator) \
1032 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1034 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1035 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1036 #define KIBIBYTE_MIN_NBYTES 10000ULL
1039 get_unit(uint64_t total_bytes, const tchar **name_ret)
1041 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1042 *name_ret = T("GiB");
1044 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1045 *name_ret = T("MiB");
1047 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1048 *name_ret = T("KiB");
1051 *name_ret = T("bytes");
1056 static struct wimlib_progress_info_scan last_scan_progress;
1059 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1061 uint64_t prev_count, cur_count;
1063 prev_count = last_scan_progress.num_nondirs_scanned +
1064 last_scan_progress.num_dirs_scanned;
1065 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1067 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1068 cur_count % 128 == 0)
1070 unsigned unit_shift;
1071 const tchar *unit_name;
1073 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1074 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1075 "%"PRIu64" directories)"),
1076 scan->num_bytes_scanned >> unit_shift,
1078 scan->num_nondirs_scanned,
1079 scan->num_dirs_scanned);
1080 last_scan_progress = *scan;
1084 /* Progress callback function passed to various wimlib functions. */
1086 imagex_progress_func(enum wimlib_progress_msg msg,
1087 const union wimlib_progress_info *info)
1089 unsigned percent_done;
1090 unsigned unit_shift;
1091 const tchar *unit_name;
1093 if (imagex_be_quiet)
1096 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1097 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1098 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1099 info->write_streams.total_bytes);
1101 if (info->write_streams.completed_streams == 0) {
1102 imagex_printf(T("Writing %"TS"-compressed data using %u thread%"TS"\n"),
1103 wimlib_get_compression_type_string(info->write_streams.compression_type),
1104 info->write_streams.num_threads,
1105 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1107 if (info->write_streams.total_parts <= 1) {
1108 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1109 "written (%u%% done)"),
1110 info->write_streams.completed_bytes >> unit_shift,
1112 info->write_streams.total_bytes >> unit_shift,
1116 imagex_printf(T("\rWriting resources from part %u of %u: "
1117 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1118 (info->write_streams.completed_parts ==
1119 info->write_streams.total_parts) ?
1120 info->write_streams.completed_parts :
1121 info->write_streams.completed_parts + 1,
1122 info->write_streams.total_parts,
1123 info->write_streams.completed_bytes >> unit_shift,
1125 info->write_streams.total_bytes >> unit_shift,
1129 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1130 imagex_printf(T("\n"));
1132 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1133 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1134 if (*info->scan.wim_target_path) {
1135 imagex_printf(T(" (loading as WIM path: "
1136 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1137 info->scan.wim_target_path);
1139 imagex_printf(T("\n"));
1141 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1143 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1144 switch (info->scan.status) {
1145 case WIMLIB_SCAN_DENTRY_OK:
1146 report_scan_progress(&info->scan, false);
1148 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1149 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1151 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1152 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1153 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1157 case WIMLIB_PROGRESS_MSG_SCAN_END:
1158 report_scan_progress(&info->scan, true);
1159 imagex_printf(T("\n"));
1161 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1162 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1163 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1164 info->integrity.total_bytes);
1165 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1166 "of %"PRIu64" %"TS" (%u%%) done"),
1167 info->integrity.filename,
1168 info->integrity.completed_bytes >> unit_shift,
1170 info->integrity.total_bytes >> unit_shift,
1173 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1174 imagex_printf(T("\n"));
1176 case WIMLIB_PROGRESS_MSG_CALC_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("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1181 "of %"PRIu64" %"TS" (%u%%) done"),
1182 info->integrity.completed_bytes >> unit_shift,
1184 info->integrity.total_bytes >> unit_shift,
1187 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1188 imagex_printf(T("\n"));
1190 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1191 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1192 "to %"TS" \"%"TS"\"\n"),
1193 info->extract.image,
1194 info->extract.image_name,
1195 info->extract.wimfile_name,
1196 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1197 T("NTFS volume") : T("directory")),
1198 info->extract.target);
1200 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1201 imagex_printf(T("Extracting "
1202 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1203 "in \"%"TS"\" to \"%"TS"\"\n"),
1204 info->extract.extract_root_wim_source_path,
1205 info->extract.image,
1206 info->extract.image_name,
1207 info->extract.wimfile_name,
1208 info->extract.target);
1210 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1211 percent_done = TO_PERCENT(info->extract.completed_bytes,
1212 info->extract.total_bytes);
1213 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1214 imagex_printf(T("\rExtracting files: "
1215 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1216 info->extract.completed_bytes >> unit_shift,
1218 info->extract.total_bytes >> unit_shift,
1221 if (info->extract.completed_bytes >= info->extract.total_bytes)
1222 imagex_printf(T("\n"));
1224 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1225 if (info->extract.total_parts != 1) {
1226 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1227 info->extract.part_number,
1228 info->extract.total_parts);
1231 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1232 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1233 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1235 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1236 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1237 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1238 info->extract.target);
1241 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1242 percent_done = TO_PERCENT(info->split.completed_bytes,
1243 info->split.total_bytes);
1244 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1245 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1246 "%"PRIu64" %"TS" (%u%%) written\n"),
1247 info->split.part_name,
1248 info->split.cur_part_number,
1249 info->split.total_parts,
1250 info->split.completed_bytes >> unit_shift,
1252 info->split.total_bytes >> unit_shift,
1256 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1257 if (info->split.completed_bytes == info->split.total_bytes) {
1258 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1259 info->split.cur_part_number,
1260 info->split.total_parts);
1263 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1264 switch (info->update.command->op) {
1265 case WIMLIB_UPDATE_OP_DELETE:
1266 imagex_printf(T("Deleted WIM path "
1267 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1268 info->update.command->delete_.wim_path);
1270 case WIMLIB_UPDATE_OP_RENAME:
1271 imagex_printf(T("Renamed WIM path "
1272 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1273 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1274 info->update.command->rename.wim_source_path,
1275 info->update.command->rename.wim_target_path);
1277 case WIMLIB_UPDATE_OP_ADD:
1285 fflush(imagex_info_file);
1290 parse_num_threads(const tchar *optarg)
1293 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1294 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1295 imagex_error(T("Number of threads must be a non-negative integer!"));
1302 static uint32_t parse_chunk_size(const tchar *optarg)
1305 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1306 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1307 imagex_error(T("Chunk size must be a non-negative integer!"));
1316 * Parse an option passed to an update command.
1318 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1321 * @option: Text string for the option (beginning with --)
1323 * @cmd: `struct wimlib_update_command' that is being constructed for
1326 * Returns true if the option was recognized; false if not.
1329 update_command_add_option(int op, const tchar *option,
1330 struct wimlib_update_command *cmd)
1332 bool recognized = true;
1334 case WIMLIB_UPDATE_OP_ADD:
1335 if (!tstrcmp(option, T("--verbose")))
1336 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1337 else if (!tstrcmp(option, T("--unix-data")))
1338 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1339 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1340 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1341 else if (!tstrcmp(option, T("--strict-acls")))
1342 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1343 else if (!tstrcmp(option, T("--dereference")))
1344 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1348 case WIMLIB_UPDATE_OP_DELETE:
1349 if (!tstrcmp(option, T("--force")))
1350 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1351 else if (!tstrcmp(option, T("--recursive")))
1352 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1363 /* How many nonoption arguments each `imagex update' command expects */
1364 static const unsigned update_command_num_nonoptions[] = {
1365 [WIMLIB_UPDATE_OP_ADD] = 2,
1366 [WIMLIB_UPDATE_OP_DELETE] = 1,
1367 [WIMLIB_UPDATE_OP_RENAME] = 2,
1371 update_command_add_nonoption(int op, const tchar *nonoption,
1372 struct wimlib_update_command *cmd,
1373 unsigned num_nonoptions)
1376 case WIMLIB_UPDATE_OP_ADD:
1377 if (num_nonoptions == 0)
1378 cmd->add.fs_source_path = (tchar*)nonoption;
1380 cmd->add.wim_target_path = (tchar*)nonoption;
1382 case WIMLIB_UPDATE_OP_DELETE:
1383 cmd->delete_.wim_path = (tchar*)nonoption;
1385 case WIMLIB_UPDATE_OP_RENAME:
1386 if (num_nonoptions == 0)
1387 cmd->rename.wim_source_path = (tchar*)nonoption;
1389 cmd->rename.wim_target_path = (tchar*)nonoption;
1395 * Parse a command passed on stdin to `imagex update'.
1397 * @line: Text of the command.
1398 * @len: Length of the line, including a null terminator
1401 * @command: A `struct wimlib_update_command' to fill in from the parsed
1404 * @line_number: Line number of the command, for diagnostics.
1406 * Returns true on success; returns false on parse error.
1409 parse_update_command(tchar *line, size_t len,
1410 struct wimlib_update_command *command,
1414 tchar *command_name;
1416 size_t num_nonoptions;
1418 /* Get the command name ("add", "delete", "rename") */
1419 ret = parse_string(&line, &len, &command_name);
1420 if (ret != PARSE_STRING_SUCCESS)
1423 if (!tstrcasecmp(command_name, T("add"))) {
1424 op = WIMLIB_UPDATE_OP_ADD;
1425 } else if (!tstrcasecmp(command_name, T("delete"))) {
1426 op = WIMLIB_UPDATE_OP_DELETE;
1427 } else if (!tstrcasecmp(command_name, T("rename"))) {
1428 op = WIMLIB_UPDATE_OP_RENAME;
1430 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1431 command_name, line_number);
1436 /* Parse additional options and non-options as needed */
1441 ret = parse_string(&line, &len, &next_string);
1442 if (ret == PARSE_STRING_NONE) /* End of line */
1444 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1446 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1448 if (!update_command_add_option(op, next_string, command))
1450 imagex_error(T("Unrecognized option \"%"TS"\" to "
1451 "update command \"%"TS"\" on line %zu"),
1452 next_string, command_name, line_number);
1458 if (num_nonoptions == update_command_num_nonoptions[op])
1460 imagex_error(T("Unexpected argument \"%"TS"\" in "
1461 "update command on line %zu\n"
1462 " (The \"%"TS"\" command only "
1463 "takes %zu nonoption arguments!)\n"),
1464 next_string, line_number,
1465 command_name, num_nonoptions);
1468 update_command_add_nonoption(op, next_string,
1469 command, num_nonoptions);
1474 if (num_nonoptions != update_command_num_nonoptions[op]) {
1475 imagex_error(T("Not enough arguments to update command "
1476 "\"%"TS"\" on line %zu"), command_name, line_number);
1482 static struct wimlib_update_command *
1483 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1484 size_t *num_cmds_ret)
1488 struct wimlib_update_command *cmds;
1491 nlines = text_file_count_lines(cmd_file_contents_p,
1496 /* Always allocate at least 1 slot, just in case the implementation of
1497 * calloc() returns NULL if 0 bytes are requested. */
1498 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1500 imagex_error(T("out of memory"));
1503 p = *cmd_file_contents_p;
1505 for (i = 0; i < nlines; i++) {
1506 /* XXX: Could use rawmemchr() here instead, but it may not be
1507 * available on all platforms. */
1508 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1509 size_t len = endp - p + 1;
1511 if (!is_comment_line(p, len)) {
1512 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1523 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1524 * one image from a WIM file to a NTFS volume. */
1526 imagex_apply(int argc, tchar **argv, int cmd)
1530 int image = WIMLIB_NO_IMAGE;
1532 struct wimlib_wim_info info;
1534 const tchar *wimfile;
1535 const tchar *target;
1536 const tchar *image_num_or_name = NULL;
1537 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1539 STRING_SET(refglobs);
1541 for_opt(c, apply_options) {
1543 case IMAGEX_CHECK_OPTION:
1544 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1546 case IMAGEX_HARDLINK_OPTION:
1547 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1549 case IMAGEX_SYMLINK_OPTION:
1550 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1552 case IMAGEX_VERBOSE_OPTION:
1553 /* No longer does anything. */
1555 case IMAGEX_REF_OPTION:
1556 ret = string_set_append(&refglobs, optarg);
1558 goto out_free_refglobs;
1560 case IMAGEX_UNIX_DATA_OPTION:
1561 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1563 case IMAGEX_NO_ACLS_OPTION:
1564 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1566 case IMAGEX_STRICT_ACLS_OPTION:
1567 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1569 case IMAGEX_NORPFIX_OPTION:
1570 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1572 case IMAGEX_RPFIX_OPTION:
1573 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1575 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1576 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1577 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1579 case IMAGEX_RESUME_OPTION:
1580 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1588 if (argc != 2 && argc != 3)
1593 if (!tstrcmp(wimfile, T("-"))) {
1594 /* Attempt to apply pipable WIM from standard input. */
1596 image_num_or_name = NULL;
1599 image_num_or_name = argv[1];
1604 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1605 imagex_progress_func);
1607 goto out_free_refglobs;
1609 wimlib_get_wim_info(wim, &info);
1612 /* Image explicitly specified. */
1613 image_num_or_name = argv[1];
1614 image = wimlib_resolve_image(wim, image_num_or_name);
1615 ret = verify_image_exists(image, image_num_or_name, wimfile);
1617 goto out_wimlib_free;
1620 /* No image specified; default to image 1, but only if the WIM
1621 * contains exactly one image. */
1623 if (info.image_count != 1) {
1624 imagex_error(T("\"%"TS"\" contains %d images; "
1625 "Please select one (or all)."),
1626 wimfile, info.image_count);
1635 if (refglobs.num_strings) {
1637 imagex_error(T("Can't specify --ref when applying from stdin!"));
1639 goto out_wimlib_free;
1641 ret = wim_reference_globs(wim, &refglobs, open_flags);
1643 goto out_wimlib_free;
1648 /* Interpret a regular file or block device target as a NTFS
1652 if (tstat(target, &stbuf)) {
1653 if (errno != ENOENT) {
1654 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1657 goto out_wimlib_free;
1660 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1661 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1667 ret = wimlib_extract_image(wim, image, target, extract_flags,
1668 imagex_progress_func);
1670 set_fd_to_binary_mode(STDIN_FILENO);
1671 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1673 target, extract_flags,
1674 imagex_progress_func);
1677 imagex_printf(T("Done applying WIM image.\n"));
1678 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1680 do_resource_not_found_warning(wimfile, &info, &refglobs);
1682 imagex_error(T( "If you are applying an image "
1683 "from a split pipable WIM,\n"
1684 " make sure you have "
1685 "concatenated together all parts."));
1691 string_set_destroy(&refglobs);
1695 usage(CMD_APPLY, stderr);
1697 goto out_free_refglobs;
1700 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1701 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1702 * the desired image. 'wimlib-imagex append': add a new image to an existing
1705 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1708 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1709 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1710 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1711 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1712 int write_flags = 0;
1713 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1714 uint32_t chunk_size = UINT32_MAX;
1715 const tchar *wimfile;
1719 const tchar *flags_element = NULL;
1722 STRING_SET(base_wimfiles);
1723 WIMStruct **base_wims;
1725 WIMStruct *template_wim;
1726 const tchar *template_wimfile = NULL;
1727 const tchar *template_image_name_or_num = NULL;
1728 int template_image = WIMLIB_NO_IMAGE;
1731 unsigned num_threads = 0;
1736 const tchar *config_file = NULL;
1738 struct wimlib_capture_config *config;
1740 bool source_list = false;
1741 size_t source_list_nchars = 0;
1742 tchar *source_list_contents;
1743 bool capture_sources_malloced;
1744 struct wimlib_capture_source *capture_sources;
1746 bool name_defaulted;
1748 for_opt(c, capture_or_append_options) {
1750 case IMAGEX_BOOT_OPTION:
1751 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1753 case IMAGEX_CHECK_OPTION:
1754 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1755 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1757 case IMAGEX_NOCHECK_OPTION:
1758 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1760 case IMAGEX_CONFIG_OPTION:
1761 config_file = optarg;
1762 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1764 case IMAGEX_COMPRESS_OPTION:
1765 compression_type = get_compression_type(optarg);
1766 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1769 case IMAGEX_COMPRESS_SLOW_OPTION:
1770 ret = set_compress_slow();
1773 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1775 case IMAGEX_CHUNK_SIZE_OPTION:
1776 chunk_size = parse_chunk_size(optarg);
1777 if (chunk_size == UINT32_MAX)
1780 case IMAGEX_PACK_STREAMS_OPTION:
1781 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1783 case IMAGEX_FLAGS_OPTION:
1784 flags_element = optarg;
1786 case IMAGEX_DEREFERENCE_OPTION:
1787 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1789 case IMAGEX_VERBOSE_OPTION:
1790 /* No longer does anything. */
1792 case IMAGEX_THREADS_OPTION:
1793 num_threads = parse_num_threads(optarg);
1794 if (num_threads == UINT_MAX)
1797 case IMAGEX_REBUILD_OPTION:
1798 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1800 case IMAGEX_UNIX_DATA_OPTION:
1801 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1803 case IMAGEX_SOURCE_LIST_OPTION:
1806 case IMAGEX_NO_ACLS_OPTION:
1807 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1809 case IMAGEX_STRICT_ACLS_OPTION:
1810 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1812 case IMAGEX_RPFIX_OPTION:
1813 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1815 case IMAGEX_NORPFIX_OPTION:
1816 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1818 case IMAGEX_PIPABLE_OPTION:
1819 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1821 case IMAGEX_NOT_PIPABLE_OPTION:
1822 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1824 case IMAGEX_UPDATE_OF_OPTION:
1825 if (template_image_name_or_num) {
1826 imagex_error(T("'--update-of' can only be "
1827 "specified one time!"));
1831 colon = tstrrchr(optarg, T(':'));
1834 template_wimfile = optarg;
1836 template_image_name_or_num = colon + 1;
1838 template_wimfile = NULL;
1839 template_image_name_or_num = optarg;
1843 case IMAGEX_DELTA_FROM_OPTION:
1844 if (cmd != CMD_CAPTURE) {
1845 imagex_error(T("'--delta-from' is only "
1846 "valid for capture!"));
1849 ret = string_set_append(&base_wimfiles, optarg);
1851 goto out_free_base_wimfiles;
1852 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1861 if (argc < 2 || argc > 4)
1867 /* Set default compression type. */
1868 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1869 struct wimlib_lzx_params params;
1870 memset(¶ms, 0, sizeof(params));
1871 params.size_of_this = sizeof(params);
1872 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1873 params.use_defaults = 1;
1875 wimlib_lzx_set_default_params(¶ms);
1876 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1879 if (!tstrcmp(wimfile, T("-"))) {
1880 /* Writing captured WIM to standard output. */
1882 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1883 imagex_error("Can't write a non-pipable WIM to "
1884 "standard output! Specify --pipable\n"
1885 " if you want to create a pipable WIM "
1886 "(but read the docs first).");
1890 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1892 if (cmd == CMD_APPEND) {
1893 imagex_error(T("Using standard output for append does "
1894 "not make sense."));
1897 wim_fd = STDOUT_FILENO;
1899 imagex_info_file = stderr;
1900 set_fd_to_binary_mode(wim_fd);
1903 /* If template image was specified using --update-of=IMAGE rather
1904 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1905 if (template_image_name_or_num && !template_wimfile) {
1906 if (base_wimfiles.num_strings == 1) {
1907 /* Capturing delta WIM based on single WIM: default to
1909 template_wimfile = base_wimfiles.strings[0];
1910 } else if (cmd == CMD_APPEND) {
1911 /* Appending to WIM: default to WIM being appended to.
1913 template_wimfile = wimfile;
1915 /* Capturing a normal (non-delta) WIM, so the WIM file
1916 * *must* be explicitly specified. */
1917 if (base_wimfiles.num_strings > 1) {
1918 imagex_error(T("For capture of delta WIM "
1919 "based on multiple existing "
1921 " '--update-of' must "
1922 "specify WIMFILE:IMAGE!"));
1924 imagex_error(T("For capture of non-delta WIM, "
1925 "'--update-of' must specify "
1934 name_defaulted = false;
1936 /* Set default name to SOURCE argument, omitting any directory
1937 * prefixes and trailing slashes. This requires making a copy
1938 * of @source. Leave some free characters at the end in case we
1939 * append a number to keep the name unique. */
1940 size_t source_name_len;
1942 source_name_len = tstrlen(source);
1943 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1944 name = tbasename(tstrcpy(source_copy, source));
1945 name_defaulted = true;
1947 /* Image description defaults to NULL if not given. */
1954 /* Set up capture sources in source list mode */
1955 if (source[0] == T('-') && source[1] == T('\0')) {
1956 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1958 source_list_contents = file_get_text_contents(source,
1959 &source_list_nchars);
1961 if (!source_list_contents)
1964 capture_sources = parse_source_list(&source_list_contents,
1967 if (!capture_sources) {
1969 goto out_free_source_list_contents;
1971 capture_sources_malloced = true;
1973 /* Set up capture source in non-source-list mode. */
1974 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1975 capture_sources[0].fs_source_path = source;
1976 capture_sources[0].wim_target_path = NULL;
1977 capture_sources[0].reserved = 0;
1979 capture_sources_malloced = false;
1980 source_list_contents = NULL;
1984 /* Read and parse capture configuration file. */
1987 config_str = file_get_text_contents(config_file, &config_len);
1990 goto out_free_capture_sources;
1993 config = alloca(sizeof(*config));
1994 ret = parse_capture_config(&config_str, config_len, config);
1996 goto out_free_config;
1998 /* No capture configuration file specified; use default
1999 * configuration for capturing Windows operating systems. */
2001 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
2004 /* Open the existing WIM, or create a new one. */
2005 if (cmd == CMD_APPEND)
2006 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2007 imagex_progress_func);
2009 ret = wimlib_create_new_wim(compression_type, &wim);
2011 goto out_free_config;
2013 /* Set chunk size if non-default. */
2014 if (chunk_size != UINT32_MAX) {
2015 ret = wimlib_set_output_chunk_size(wim, chunk_size);
2021 /* Detect if source is regular file or block device and set NTFS volume
2026 if (tstat(source, &stbuf) == 0) {
2027 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2028 imagex_printf(T("Capturing WIM image from NTFS "
2029 "filesystem on \"%"TS"\"\n"), source);
2030 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
2033 if (errno != ENOENT) {
2034 imagex_error_with_errno(T("Failed to stat "
2035 "\"%"TS"\""), source);
2043 /* If the user did not specify an image name, and the basename of the
2044 * source already exists as an image name in the WIM file, append a
2045 * suffix to make it unique. */
2046 if (cmd == CMD_APPEND && name_defaulted) {
2047 unsigned long conflict_idx;
2048 tchar *name_end = tstrchr(name, T('\0'));
2049 for (conflict_idx = 1;
2050 wimlib_image_name_in_use(wim, name);
2053 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2057 /* If capturing a delta WIM, reference resources from the base WIMs
2058 * before adding the new image. */
2059 if (base_wimfiles.num_strings) {
2060 base_wims = calloc(base_wimfiles.num_strings,
2061 sizeof(base_wims[0]));
2062 if (base_wims == NULL) {
2063 imagex_error(T("Out of memory!"));
2068 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2069 ret = wimlib_open_wim(base_wimfiles.strings[i],
2070 open_flags, &base_wims[i],
2071 imagex_progress_func);
2073 goto out_free_base_wims;
2077 ret = wimlib_reference_resources(wim, base_wims,
2078 base_wimfiles.num_strings, 0);
2080 goto out_free_base_wims;
2082 if (base_wimfiles.num_strings == 1) {
2083 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2084 base_wimfiles.strings[0]);
2086 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2087 base_wimfiles.num_strings);
2094 /* If capturing or appending as an update of an existing (template) image,
2095 * open the WIM if needed and parse the image index. */
2096 if (template_image_name_or_num) {
2099 if (base_wimfiles.num_strings == 1 &&
2100 template_wimfile == base_wimfiles.strings[0]) {
2101 template_wim = base_wims[0];
2102 } else if (template_wimfile == wimfile) {
2105 ret = wimlib_open_wim(template_wimfile, open_flags,
2106 &template_wim, imagex_progress_func);
2108 goto out_free_base_wims;
2111 template_image = wimlib_resolve_image(template_wim,
2112 template_image_name_or_num);
2114 if (template_image_name_or_num[0] == T('-')) {
2117 struct wimlib_wim_info info;
2119 wimlib_get_wim_info(template_wim, &info);
2120 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2121 if (n >= 1 && n <= info.image_count &&
2123 tmp != template_image_name_or_num + 1)
2125 template_image = info.image_count - (n - 1);
2128 ret = verify_image_exists_and_is_single(template_image,
2129 template_image_name_or_num,
2132 goto out_free_template_wim;
2134 template_wim = NULL;
2137 ret = wimlib_add_image_multisource(wim,
2143 imagex_progress_func);
2145 goto out_free_template_wim;
2147 if (desc || flags_element || template_image_name_or_num) {
2148 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2149 * on which the added one is to be based has been specified with
2150 * --update-of. Get the index of the image we just
2151 * added, then use it to call the appropriate functions. */
2152 struct wimlib_wim_info info;
2154 wimlib_get_wim_info(wim, &info);
2157 ret = wimlib_set_image_descripton(wim,
2161 goto out_free_template_wim;
2164 if (flags_element) {
2165 ret = wimlib_set_image_flags(wim, info.image_count,
2168 goto out_free_template_wim;
2171 /* Reference template image if the user provided one. */
2172 if (template_image_name_or_num) {
2173 imagex_printf(T("Using image %d "
2174 "from \"%"TS"\" as template\n"),
2175 template_image, template_wimfile);
2176 ret = wimlib_reference_template_image(wim,
2182 goto out_free_template_wim;
2186 /* Write the new WIM or overwrite the existing WIM with the new image
2188 if (cmd == CMD_APPEND) {
2189 ret = wimlib_overwrite(wim, write_flags, num_threads,
2190 imagex_progress_func);
2191 } else if (wimfile) {
2192 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2193 write_flags, num_threads,
2194 imagex_progress_func);
2196 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2197 write_flags, num_threads,
2198 imagex_progress_func);
2200 out_free_template_wim:
2201 /* template_wim may alias base_wims[0] or wim. */
2202 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2203 template_wim != wim)
2204 wimlib_free(template_wim);
2206 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2207 wimlib_free(base_wims[i]);
2213 free(config->exclusion_pats.pats);
2214 free(config->exclusion_exception_pats.pats);
2217 out_free_capture_sources:
2218 if (capture_sources_malloced)
2219 free(capture_sources);
2220 out_free_source_list_contents:
2221 free(source_list_contents);
2222 out_free_base_wimfiles:
2223 string_set_destroy(&base_wimfiles);
2230 goto out_free_base_wimfiles;
2233 /* Remove image(s) from a WIM. */
2235 imagex_delete(int argc, tchar **argv, int cmd)
2238 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2239 int write_flags = 0;
2240 const tchar *wimfile;
2241 const tchar *image_num_or_name;
2246 for_opt(c, delete_options) {
2248 case IMAGEX_CHECK_OPTION:
2249 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2250 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2252 case IMAGEX_SOFT_OPTION:
2253 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2264 imagex_error(T("Must specify a WIM file"));
2266 imagex_error(T("Must specify an image"));
2270 image_num_or_name = argv[1];
2272 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2273 imagex_progress_func);
2277 image = wimlib_resolve_image(wim, image_num_or_name);
2279 ret = verify_image_exists(image, image_num_or_name, wimfile);
2281 goto out_wimlib_free;
2283 ret = wimlib_delete_image(wim, image);
2285 imagex_error(T("Failed to delete image from \"%"TS"\""),
2287 goto out_wimlib_free;
2290 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2292 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2293 "deleted"), wimfile);
2301 usage(CMD_DELETE, stderr);
2307 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2309 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2310 return (ret >= 0) ? 0 : -1;
2313 /* Print the files contained in an image(s) in a WIM file. */
2315 imagex_dir(int argc, tchar **argv, int cmd)
2317 const tchar *wimfile;
2318 WIMStruct *wim = NULL;
2321 const tchar *path = T("");
2324 for_opt(c, dir_options) {
2326 case IMAGEX_PATH_OPTION:
2337 imagex_error(T("Must specify a WIM file"));
2341 imagex_error(T("Too many arguments"));
2346 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2351 image = wimlib_resolve_image(wim, argv[1]);
2352 ret = verify_image_exists(image, argv[1], wimfile);
2354 goto out_wimlib_free;
2356 /* No image specified; default to image 1, but only if the WIM
2357 * contains exactly one image. */
2359 struct wimlib_wim_info info;
2361 wimlib_get_wim_info(wim, &info);
2362 if (info.image_count != 1) {
2363 imagex_error(T("\"%"TS"\" contains %d images; Please "
2364 "select one (or all)."),
2365 wimfile, info.image_count);
2372 ret = wimlib_iterate_dir_tree(wim, image, path,
2373 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2374 print_full_path, NULL);
2381 usage(CMD_DIR, stderr);
2386 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2389 imagex_export(int argc, tchar **argv, int cmd)
2393 int export_flags = 0;
2394 int write_flags = 0;
2395 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2396 const tchar *src_wimfile;
2397 const tchar *src_image_num_or_name;
2398 const tchar *dest_wimfile;
2400 const tchar *dest_name;
2401 const tchar *dest_desc;
2403 struct wimlib_wim_info src_info;
2404 WIMStruct *dest_wim;
2409 STRING_SET(refglobs);
2410 unsigned num_threads = 0;
2412 for_opt(c, export_options) {
2414 case IMAGEX_BOOT_OPTION:
2415 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2417 case IMAGEX_CHECK_OPTION:
2418 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2419 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2421 case IMAGEX_NOCHECK_OPTION:
2422 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2424 case IMAGEX_COMPRESS_OPTION:
2425 compression_type = get_compression_type(optarg);
2426 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2429 case IMAGEX_REF_OPTION:
2430 ret = string_set_append(&refglobs, optarg);
2432 goto out_free_refglobs;
2434 case IMAGEX_THREADS_OPTION:
2435 num_threads = parse_num_threads(optarg);
2436 if (num_threads == UINT_MAX)
2439 case IMAGEX_REBUILD_OPTION:
2440 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2442 case IMAGEX_PIPABLE_OPTION:
2443 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2445 case IMAGEX_NOT_PIPABLE_OPTION:
2446 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2454 if (argc < 3 || argc > 5)
2456 src_wimfile = argv[0];
2457 src_image_num_or_name = argv[1];
2458 dest_wimfile = argv[2];
2459 dest_name = (argc >= 4) ? argv[3] : NULL;
2460 dest_desc = (argc >= 5) ? argv[4] : NULL;
2461 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2462 imagex_progress_func);
2464 goto out_free_refglobs;
2466 wimlib_get_wim_info(src_wim, &src_info);
2468 /* Determine if the destination is an existing file or not. If so, we
2469 * try to append the exported image(s) to it; otherwise, we create a new
2470 * WIM containing the exported image(s). Furthermore, determine if we
2471 * need to write a pipable WIM directly to standard output. */
2473 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2475 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2476 imagex_error("Can't write a non-pipable WIM to "
2477 "standard output! Specify --pipable\n"
2478 " if you want to create a pipable WIM "
2479 "(but read the docs first).");
2481 goto out_free_src_wim;
2484 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2486 dest_wimfile = NULL;
2487 dest_wim_fd = STDOUT_FILENO;
2488 imagex_info_file = stderr;
2489 set_fd_to_binary_mode(dest_wim_fd);
2492 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2494 /* Destination file exists. */
2496 if (!S_ISREG(stbuf.st_mode)) {
2497 imagex_error(T("\"%"TS"\" is not a regular file"),
2500 goto out_free_src_wim;
2502 ret = wimlib_open_wim(dest_wimfile,
2503 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2504 &dest_wim, imagex_progress_func);
2506 goto out_free_src_wim;
2508 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2509 /* The user specified a compression type, but we're
2510 * exporting to an existing WIM. Make sure the
2511 * specified compression type is the same as the
2512 * compression type of the existing destination WIM. */
2513 struct wimlib_wim_info dest_info;
2515 wimlib_get_wim_info(dest_wim, &dest_info);
2516 if (compression_type != dest_info.compression_type) {
2517 imagex_error(T("Cannot specify a compression type that is "
2518 "not the same as that used in the "
2519 "destination WIM"));
2521 goto out_free_dest_wim;
2527 if (errno != ENOENT) {
2528 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2531 goto out_free_src_wim;
2534 /* dest_wimfile is not an existing file, so create a new WIM. */
2536 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2537 /* The user did not specify a compression type; default
2538 * to that of the source WIM. */
2540 compression_type = src_info.compression_type;
2542 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2544 goto out_free_src_wim;
2546 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2549 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2550 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2552 goto out_free_dest_wim;
2554 if (refglobs.num_strings) {
2555 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2557 goto out_free_dest_wim;
2560 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2561 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2563 imagex_error(T("--boot specified for all-images export, but source WIM "
2564 "has no bootable image."));
2566 goto out_free_dest_wim;
2569 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2570 dest_desc, export_flags, imagex_progress_func);
2572 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2573 do_resource_not_found_warning(src_wimfile,
2574 &src_info, &refglobs);
2576 goto out_free_dest_wim;
2580 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2581 imagex_progress_func);
2582 else if (dest_wimfile)
2583 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2584 write_flags, num_threads,
2585 imagex_progress_func);
2587 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2588 WIMLIB_ALL_IMAGES, write_flags,
2589 num_threads, imagex_progress_func);
2591 wimlib_free(dest_wim);
2593 wimlib_free(src_wim);
2595 string_set_destroy(&refglobs);
2599 usage(CMD_EXPORT, stderr);
2602 goto out_free_refglobs;
2606 is_root_wim_path(const tchar *path)
2609 for (p = path; *p; p++)
2610 if (*p != T('\\') && *p != T('/'))
2616 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2617 const tchar *dest_dir)
2619 for (size_t i = 0; i < num_cmds; i++)
2620 if (cmds[i].fs_dest_path != dest_dir)
2621 free(cmds[i].fs_dest_path);
2625 static struct wimlib_extract_command *
2626 prepare_extract_commands(tchar **paths, unsigned num_paths,
2627 int extract_flags, tchar *dest_dir,
2628 size_t *num_cmds_ret)
2630 struct wimlib_extract_command *cmds;
2632 tchar *emptystr = T("");
2634 if (num_paths == 0) {
2638 num_cmds = num_paths;
2639 cmds = calloc(num_cmds, sizeof(cmds[0]));
2641 imagex_error(T("Out of memory!"));
2645 for (size_t i = 0; i < num_cmds; i++) {
2646 cmds[i].extract_flags = extract_flags;
2647 cmds[i].wim_source_path = paths[i];
2648 if (is_root_wim_path(paths[i])) {
2649 cmds[i].fs_dest_path = dest_dir;
2651 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2652 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2653 if (!cmds[i].fs_dest_path) {
2654 free_extract_commands(cmds, num_cmds, dest_dir);
2657 tsprintf(cmds[i].fs_dest_path,
2658 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2659 dest_dir, tbasename(paths[i]));
2662 *num_cmds_ret = num_cmds;
2666 /* Extract files or directories from a WIM image */
2668 imagex_extract(int argc, tchar **argv, int cmd)
2675 const tchar *wimfile;
2676 const tchar *image_num_or_name;
2677 tchar *dest_dir = T(".");
2678 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2680 STRING_SET(refglobs);
2682 struct wimlib_extract_command *cmds;
2685 for_opt(c, extract_options) {
2687 case IMAGEX_CHECK_OPTION:
2688 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2690 case IMAGEX_VERBOSE_OPTION:
2691 /* No longer does anything. */
2693 case IMAGEX_REF_OPTION:
2694 ret = string_set_append(&refglobs, optarg);
2696 goto out_free_refglobs;
2698 case IMAGEX_UNIX_DATA_OPTION:
2699 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2701 case IMAGEX_NO_ACLS_OPTION:
2702 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2704 case IMAGEX_STRICT_ACLS_OPTION:
2705 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2707 case IMAGEX_DEST_DIR_OPTION:
2710 case IMAGEX_TO_STDOUT_OPTION:
2711 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2712 imagex_info_file = stderr;
2713 imagex_be_quiet = true;
2715 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2716 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2717 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2730 image_num_or_name = argv[1];
2735 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2740 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2744 image = wimlib_resolve_image(wim, image_num_or_name);
2745 ret = verify_image_exists_and_is_single(image,
2749 goto out_wimlib_free;
2751 if (refglobs.num_strings) {
2752 ret = wim_reference_globs(wim, &refglobs, open_flags);
2754 goto out_wimlib_free;
2757 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2758 imagex_progress_func);
2760 if (!imagex_be_quiet)
2761 imagex_printf(T("Done extracting files.\n"));
2762 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2763 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2764 "files and directories\n"
2765 " are in the WIM image.\n"),
2766 get_cmd_string(CMD_INFO, false));
2767 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2768 struct wimlib_wim_info info;
2770 wimlib_get_wim_info(wim, &info);
2771 do_resource_not_found_warning(wimfile, &info, &refglobs);
2776 free_extract_commands(cmds, num_cmds, dest_dir);
2778 string_set_destroy(&refglobs);
2782 usage(CMD_EXTRACT, stderr);
2785 goto out_free_refglobs;
2788 static void print_byte_field(const uint8_t field[], size_t len)
2791 tprintf(T("%02hhx"), *field++);
2795 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2797 tputs(T("WIM Information:"));
2798 tputs(T("----------------"));
2799 tprintf(T("Path: %"TS"\n"), wimfile);
2800 tprintf(T("GUID: 0x"));
2801 print_byte_field(info->guid, sizeof(info->guid));
2803 tprintf(T("Version: %u\n"), info->wim_version);
2804 tprintf(T("Image Count: %d\n"), info->image_count);
2805 tprintf(T("Compression: %"TS"\n"),
2806 wimlib_get_compression_type_string(info->compression_type));
2807 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2809 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2810 tprintf(T("Boot Index: %d\n"), info->boot_index);
2811 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2812 tprintf(T("Integrity Info: %"TS"\n"),
2813 info->has_integrity_table ? T("yes") : T("no"));
2814 tprintf(T("Relative path junction: %"TS"\n"),
2815 info->has_rpfix ? T("yes") : T("no"));
2816 tprintf(T("Pipable: %"TS"\n"),
2817 info->pipable ? T("yes") : T("no"));
2822 print_resource(const struct wimlib_resource_entry *resource,
2825 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2826 resource->uncompressed_size);
2827 if (resource->packed) {
2828 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2829 resource->raw_resource_compressed_size);
2831 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2832 resource->raw_resource_offset_in_wim);
2834 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2837 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2838 resource->compressed_size);
2840 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2844 tprintf(T("Part Number = %u\n"), resource->part_number);
2845 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2847 tprintf(T("Hash = 0x"));
2848 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2851 tprintf(T("Flags = "));
2852 if (resource->is_compressed)
2853 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2854 if (resource->is_metadata)
2855 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2856 if (resource->is_free)
2857 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2858 if (resource->is_spanned)
2859 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2860 if (resource->packed)
2861 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2868 print_lookup_table(WIMStruct *wim)
2870 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2873 /* Prints information about a WIM file; also can mark an image as bootable,
2874 * change the name of an image, or change the description of an image. */
2876 imagex_info(int argc, tchar **argv, int cmd)
2881 bool nocheck = false;
2882 bool header = false;
2883 bool lookup_table = false;
2885 bool metadata = false;
2886 bool short_header = true;
2887 const tchar *xml_out_file = NULL;
2888 const tchar *wimfile;
2889 const tchar *image_num_or_name;
2890 const tchar *new_name;
2891 const tchar *new_desc;
2896 struct wimlib_wim_info info;
2898 for_opt(c, info_options) {
2900 case IMAGEX_BOOT_OPTION:
2903 case IMAGEX_CHECK_OPTION:
2906 case IMAGEX_NOCHECK_OPTION:
2909 case IMAGEX_HEADER_OPTION:
2911 short_header = false;
2913 case IMAGEX_LOOKUP_TABLE_OPTION:
2914 lookup_table = true;
2915 short_header = false;
2917 case IMAGEX_XML_OPTION:
2919 short_header = false;
2921 case IMAGEX_EXTRACT_XML_OPTION:
2922 xml_out_file = optarg;
2923 short_header = false;
2925 case IMAGEX_METADATA_OPTION:
2927 short_header = false;
2936 if (argc < 1 || argc > 4)
2940 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2941 new_name = (argc >= 3) ? argv[2] : NULL;
2942 new_desc = (argc >= 4) ? argv[3] : NULL;
2944 if (check && nocheck) {
2945 imagex_error(T("Can't specify both --check and --nocheck"));
2950 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2952 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2956 wimlib_get_wim_info(wim, &info);
2958 image = wimlib_resolve_image(wim, image_num_or_name);
2959 ret = WIMLIB_ERR_INVALID_IMAGE;
2960 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2961 verify_image_exists(image, image_num_or_name, wimfile);
2963 imagex_error(T("If you would like to set the boot "
2964 "index to 0, specify image \"0\" with "
2965 "the --boot flag."));
2967 goto out_wimlib_free;
2970 if (boot && info.image_count == 0) {
2971 imagex_error(T("--boot is meaningless on a WIM with no images"));
2972 goto out_wimlib_free;
2975 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2977 imagex_error(T("Cannot specify the --boot flag "
2978 "without specifying a specific "
2979 "image in a multi-image WIM"));
2980 goto out_wimlib_free;
2983 imagex_error(T("Cannot specify the NEW_NAME "
2984 "without specifying a specific "
2985 "image in a multi-image WIM"));
2986 goto out_wimlib_free;
2990 /* Operations that print information are separated from operations that
2991 * recreate the WIM file. */
2992 if (!new_name && !boot) {
2994 /* Read-only operations */
2996 if (image == WIMLIB_NO_IMAGE) {
2997 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2998 image_num_or_name, wimfile);
2999 goto out_wimlib_free;
3002 if (image == WIMLIB_ALL_IMAGES && short_header)
3003 print_wim_information(wimfile, &info);
3006 wimlib_print_header(wim);
3009 if (info.total_parts != 1) {
3010 tfprintf(stderr, T("Warning: Only showing the lookup table "
3011 "for part %d of a %d-part WIM.\n"),
3012 info.part_number, info.total_parts);
3014 print_lookup_table(wim);
3018 ret = wimlib_extract_xml_data(wim, stdout);
3020 goto out_wimlib_free;
3026 fp = tfopen(xml_out_file, T("wb"));
3028 imagex_error_with_errno(T("Failed to open the "
3029 "file \"%"TS"\" for "
3033 goto out_wimlib_free;
3035 ret = wimlib_extract_xml_data(wim, fp);
3037 imagex_error(T("Failed to close the file "
3043 goto out_wimlib_free;
3047 wimlib_print_available_images(wim, image);
3050 ret = wimlib_print_metadata(wim, image);
3052 goto out_wimlib_free;
3057 /* Modification operations */
3059 if (image == WIMLIB_ALL_IMAGES)
3062 if (image == WIMLIB_NO_IMAGE && new_name) {
3063 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3064 "when using image 0"), new_name);
3066 goto out_wimlib_free;
3070 if (image == info.boot_index) {
3071 imagex_printf(T("Image %d is already marked as "
3072 "bootable.\n"), image);
3075 imagex_printf(T("Marking image %d as bootable.\n"),
3077 info.boot_index = image;
3078 ret = wimlib_set_wim_info(wim, &info,
3079 WIMLIB_CHANGE_BOOT_INDEX);
3081 goto out_wimlib_free;
3085 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3087 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3091 imagex_printf(T("Changing the name of image %d to "
3092 "\"%"TS"\".\n"), image, new_name);
3093 ret = wimlib_set_image_name(wim, image, new_name);
3095 goto out_wimlib_free;
3099 const tchar *old_desc;
3100 old_desc = wimlib_get_image_description(wim, image);
3101 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3102 imagex_printf(T("The description of image %d is already "
3103 "\"%"TS"\".\n"), image, new_desc);
3106 imagex_printf(T("Changing the description of image %d "
3107 "to \"%"TS"\".\n"), image, new_desc);
3108 ret = wimlib_set_image_descripton(wim, image,
3111 goto out_wimlib_free;
3115 /* Only call wimlib_overwrite() if something actually needs to
3117 if (boot || new_name || new_desc ||
3118 (check && !info.has_integrity_table) ||
3119 (nocheck && info.has_integrity_table))
3121 int write_flags = 0;
3124 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3126 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3127 ret = wimlib_overwrite(wim, write_flags, 1,
3128 imagex_progress_func);
3130 imagex_printf(T("The file \"%"TS"\" was not modified "
3131 "because nothing needed to be done.\n"),
3142 usage(CMD_INFO, stderr);
3148 /* Join split WIMs into one part WIM */
3150 imagex_join(int argc, tchar **argv, int cmd)
3153 int swm_open_flags = 0;
3154 int wim_write_flags = 0;
3155 const tchar *output_path;
3158 for_opt(c, join_options) {
3160 case IMAGEX_CHECK_OPTION:
3161 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3162 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3172 imagex_error(T("Must specify one or more split WIM (.swm) "
3176 output_path = argv[0];
3177 ret = wimlib_join((const tchar * const *)++argv,
3182 imagex_progress_func);
3187 usage(CMD_JOIN, stderr);
3192 #if WIM_MOUNTING_SUPPORTED
3194 /* Mounts a WIM image. */
3196 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3199 int mount_flags = 0;
3201 const tchar *staging_dir = NULL;
3202 const tchar *wimfile;
3205 struct wimlib_wim_info info;
3209 STRING_SET(refglobs);
3211 if (cmd == CMD_MOUNTRW) {
3212 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3213 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3216 for_opt(c, mount_options) {
3218 case IMAGEX_ALLOW_OTHER_OPTION:
3219 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3221 case IMAGEX_CHECK_OPTION:
3222 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3224 case IMAGEX_DEBUG_OPTION:
3225 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3227 case IMAGEX_STREAMS_INTERFACE_OPTION:
3228 if (!tstrcasecmp(optarg, T("none")))
3229 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3230 else if (!tstrcasecmp(optarg, T("xattr")))
3231 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3232 else if (!tstrcasecmp(optarg, T("windows")))
3233 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3235 imagex_error(T("Unknown stream interface \"%"TS"\""),
3240 case IMAGEX_REF_OPTION:
3241 ret = string_set_append(&refglobs, optarg);
3243 goto out_free_refglobs;
3245 case IMAGEX_STAGING_DIR_OPTION:
3246 staging_dir = optarg;
3248 case IMAGEX_UNIX_DATA_OPTION:
3249 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3257 if (argc != 2 && argc != 3)
3262 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3264 goto out_free_refglobs;
3266 wimlib_get_wim_info(wim, &info);
3269 /* Image explicitly specified. */
3270 image = wimlib_resolve_image(wim, argv[1]);
3272 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3276 /* No image specified; default to image 1, but only if the WIM
3277 * contains exactly one image. */
3279 if (info.image_count != 1) {
3280 imagex_error(T("\"%"TS"\" contains %d images; Please "
3281 "select one."), wimfile, info.image_count);
3289 if (refglobs.num_strings) {
3290 ret = wim_reference_globs(wim, &refglobs, open_flags);
3295 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3297 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3299 image, wimfile, dir);
3304 string_set_destroy(&refglobs);
3310 goto out_free_refglobs;
3312 #endif /* WIM_MOUNTING_SUPPORTED */
3314 /* Rebuild a WIM file */
3316 imagex_optimize(int argc, tchar **argv, int cmd)
3319 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3320 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3321 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3322 uint32_t chunk_size = UINT32_MAX;
3325 const tchar *wimfile;
3328 unsigned num_threads = 0;
3330 for_opt(c, optimize_options) {
3332 case IMAGEX_CHECK_OPTION:
3333 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3334 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3336 case IMAGEX_NOCHECK_OPTION:
3337 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3339 case IMAGEX_COMPRESS_OPTION:
3340 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3341 compression_type = get_compression_type(optarg);
3342 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3345 case IMAGEX_RECOMPRESS_OPTION:
3346 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3348 case IMAGEX_COMPRESS_SLOW_OPTION:
3349 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3350 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
3351 ret = set_compress_slow();
3355 case IMAGEX_CHUNK_SIZE_OPTION:
3356 chunk_size = parse_chunk_size(optarg);
3357 if (chunk_size == UINT32_MAX)
3360 case IMAGEX_PACK_STREAMS_OPTION:
3361 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3362 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3364 case IMAGEX_NO_PACK_STREAMS_OPTION:
3365 write_flags |= WIMLIB_WRITE_FLAG_NO_PACK_STREAMS;
3367 case IMAGEX_THREADS_OPTION:
3368 num_threads = parse_num_threads(optarg);
3369 if (num_threads == UINT_MAX)
3372 case IMAGEX_PIPABLE_OPTION:
3373 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3375 case IMAGEX_NOT_PIPABLE_OPTION:
3376 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3390 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3394 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3395 /* Change compression type. */
3396 ret = wimlib_set_output_compression_type(wim, compression_type);
3398 goto out_wimlib_free;
3401 if (chunk_size != UINT32_MAX) {
3402 /* Change chunk size. */
3403 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3405 goto out_wimlib_free;
3408 old_size = file_get_size(wimfile);
3409 tprintf(T("\"%"TS"\" original size: "), wimfile);
3411 tputs(T("Unknown"));
3413 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3415 ret = wimlib_overwrite(wim, write_flags, num_threads,
3416 imagex_progress_func);
3418 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3419 goto out_wimlib_free;
3422 new_size = file_get_size(wimfile);
3423 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3425 tputs(T("Unknown"));
3427 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3429 tfputs(T("Space saved: "), stdout);
3430 if (new_size != -1 && old_size != -1) {
3431 tprintf(T("%lld KiB\n"),
3432 ((long long)old_size - (long long)new_size) >> 10);
3434 tputs(T("Unknown"));
3443 usage(CMD_OPTIMIZE, stderr);
3449 /* Split a WIM into a spanned set */
3451 imagex_split(int argc, tchar **argv, int cmd)
3455 int write_flags = 0;
3456 unsigned long part_size;
3461 for_opt(c, split_options) {
3463 case IMAGEX_CHECK_OPTION:
3464 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3465 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3477 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3478 if (tmp == argv[2] || *tmp) {
3479 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3480 imagex_error(T("The part size must be an integer or "
3481 "floating-point number of megabytes."));
3484 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3488 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3494 usage(CMD_SPLIT, stderr);
3500 #if WIM_MOUNTING_SUPPORTED
3501 /* Unmounts a mounted WIM image. */
3503 imagex_unmount(int argc, tchar **argv, int cmd)
3506 int unmount_flags = 0;
3509 for_opt(c, unmount_options) {
3511 case IMAGEX_COMMIT_OPTION:
3512 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3514 case IMAGEX_CHECK_OPTION:
3515 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3517 case IMAGEX_REBUILD_OPTION:
3518 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3520 case IMAGEX_LAZY_OPTION:
3521 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3532 ret = wimlib_unmount_image(argv[0], unmount_flags,
3533 imagex_progress_func);
3535 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3540 usage(CMD_UNMOUNT, stderr);
3544 #endif /* WIM_MOUNTING_SUPPORTED */
3547 * Add, delete, or rename files in a WIM image.
3550 imagex_update(int argc, tchar **argv, int cmd)
3552 const tchar *wimfile;
3556 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3557 int write_flags = 0;
3558 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3559 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3560 WIMLIB_ADD_FLAG_VERBOSE;
3561 int default_delete_flags = 0;
3562 unsigned num_threads = 0;
3564 tchar *cmd_file_contents;
3565 size_t cmd_file_nchars;
3566 struct wimlib_update_command *cmds;
3568 tchar *command_str = NULL;
3570 const tchar *config_file = NULL;
3572 struct wimlib_capture_config *config;
3574 for_opt(c, update_options) {
3576 /* Generic or write options */
3577 case IMAGEX_THREADS_OPTION:
3578 num_threads = parse_num_threads(optarg);
3579 if (num_threads == UINT_MAX)
3582 case IMAGEX_CHECK_OPTION:
3583 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3584 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3586 case IMAGEX_REBUILD_OPTION:
3587 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3589 case IMAGEX_COMMAND_OPTION:
3591 imagex_error(T("--command may only be specified "
3592 "one time. Please provide\n"
3593 " the update commands "
3594 "on standard input instead."));
3597 command_str = tstrdup(optarg);
3599 imagex_error(T("Out of memory!"));
3603 /* Default delete options */
3604 case IMAGEX_FORCE_OPTION:
3605 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3607 case IMAGEX_RECURSIVE_OPTION:
3608 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3611 /* Global add option */
3612 case IMAGEX_CONFIG_OPTION:
3613 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3614 config_file = optarg;
3617 /* Default add options */
3618 case IMAGEX_VERBOSE_OPTION:
3619 /* No longer does anything. */
3621 case IMAGEX_DEREFERENCE_OPTION:
3622 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3624 case IMAGEX_UNIX_DATA_OPTION:
3625 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3627 case IMAGEX_NO_ACLS_OPTION:
3628 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3630 case IMAGEX_STRICT_ACLS_OPTION:
3631 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3640 if (argc != 1 && argc != 2)
3644 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3646 goto out_free_command_str;
3649 /* Image explicitly specified. */
3650 image = wimlib_resolve_image(wim, argv[1]);
3651 ret = verify_image_exists_and_is_single(image, argv[1],
3654 goto out_wimlib_free;
3656 /* No image specified; default to image 1, but only if the WIM
3657 * contains exactly one image. */
3658 struct wimlib_wim_info info;
3660 wimlib_get_wim_info(wim, &info);
3661 if (info.image_count != 1) {
3662 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3663 wimfile, info.image_count);
3670 /* Parse capture configuration file if specified */
3674 config_str = file_get_text_contents(config_file, &config_len);
3677 goto out_wimlib_free;
3680 config = alloca(sizeof(*config));
3681 ret = parse_capture_config(&config_str, config_len, config);
3683 goto out_free_config;
3686 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3689 /* Read update commands from standard input, or the command string if
3692 cmd_file_contents = NULL;
3693 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3696 if (isatty(STDIN_FILENO)) {
3697 tputs(T("Reading update commands from standard input..."));
3698 recommend_man_page(CMD_UPDATE, stdout);
3700 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3701 if (!cmd_file_contents) {
3703 goto out_free_config;
3706 /* Parse the update commands */
3707 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3712 goto out_free_cmd_file_contents;
3715 /* Set default flags and capture config on the update commands */
3716 for (size_t i = 0; i < num_cmds; i++) {
3717 switch (cmds[i].op) {
3718 case WIMLIB_UPDATE_OP_ADD:
3719 cmds[i].add.add_flags |= default_add_flags;
3720 cmds[i].add.config = config;
3722 case WIMLIB_UPDATE_OP_DELETE:
3723 cmds[i].delete_.delete_flags |= default_delete_flags;
3730 /* Execute the update commands */
3731 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3732 imagex_progress_func);
3736 /* Overwrite the updated WIM */
3737 ret = wimlib_overwrite(wim, write_flags, num_threads,
3738 imagex_progress_func);
3741 out_free_cmd_file_contents:
3742 free(cmd_file_contents);
3745 free(config->exclusion_pats.pats);
3746 free(config->exclusion_exception_pats.pats);
3751 out_free_command_str:
3756 usage(CMD_UPDATE, stderr);
3759 goto out_free_command_str;
3764 struct imagex_command {
3766 int (*func)(int argc, tchar **argv, int cmd);
3769 static const struct imagex_command imagex_commands[] = {
3770 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3771 [CMD_APPLY] = {T("apply"), imagex_apply},
3772 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3773 [CMD_DELETE] = {T("delete"), imagex_delete},
3774 [CMD_DIR ] = {T("dir"), imagex_dir},
3775 [CMD_EXPORT] = {T("export"), imagex_export},
3776 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3777 [CMD_INFO] = {T("info"), imagex_info},
3778 [CMD_JOIN] = {T("join"), imagex_join},
3779 #if WIM_MOUNTING_SUPPORTED
3780 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3781 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3783 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3784 [CMD_SPLIT] = {T("split"), imagex_split},
3785 #if WIM_MOUNTING_SUPPORTED
3786 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3788 [CMD_UPDATE] = {T("update"), imagex_update},
3791 static const tchar *usage_strings[] = {
3794 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3795 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3796 " [--check] [--nocheck] [--flags EDITION_ID]\n"
3797 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3798 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3799 " [--norpfix] [--unix-data] [--pipable]\n"
3800 " [--update-of=[WIMFILE:]IMAGE]\n"
3804 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3805 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3806 " [--symlink] [--ref=\"GLOB\"] [--unix-data]\n"
3807 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3808 " [--include-invalid-names]\n"
3812 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3813 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3814 " [--check] [--nocheck] [--compress=TYPE]\n"
3815 " [--flags EDITION_ID] [--dereference]\n"
3816 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3817 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3818 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3819 " [--delta-from=WIMFILE]\n"
3823 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3828 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3832 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3833 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3834 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3835 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3836 " [--pipable] [--not-pipable]\n"
3840 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3841 " [--check] [--ref=\"GLOB\"] [--unix-data]\n"
3842 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3843 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3847 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3848 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3849 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3854 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3856 #if WIM_MOUNTING_SUPPORTED
3859 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3860 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3861 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3865 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3866 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3867 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3872 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3873 " [--recompress-slow] [--compress=TYPE]\n"
3874 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3878 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3880 #if WIM_MOUNTING_SUPPORTED
3883 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3888 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3889 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3890 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3894 static const tchar *invocation_name;
3895 static int invocation_cmd = CMD_NONE;
3897 static const tchar *get_cmd_string(int cmd, bool nospace)
3899 static tchar buf[50];
3900 if (cmd == CMD_NONE) {
3901 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3902 } else if (invocation_cmd != CMD_NONE) {
3903 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3905 const tchar *format;
3908 format = T("%"TS"-%"TS"");
3910 format = T("%"TS" %"TS"");
3911 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3919 static const tchar *s =
3921 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3922 "Copyright (C) 2012, 2013 Eric Biggers\n"
3923 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3924 "This is free software: you are free to change and redistribute it.\n"
3925 "There is NO WARRANTY, to the extent permitted by law.\n"
3927 "Report bugs to "PACKAGE_BUGREPORT".\n"
3934 help_or_version(int argc, tchar **argv, int cmd)
3939 for (i = 1; i < argc; i++) {
3941 if (p[0] == T('-') && p[1] == T('-')) {
3943 if (!tstrcmp(p, T("help"))) {
3944 if (cmd == CMD_NONE)
3949 } else if (!tstrcmp(p, T("version"))) {
3958 print_usage_string(int cmd, FILE *fp)
3960 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3964 recommend_man_page(int cmd, FILE *fp)
3966 const tchar *format_str;
3968 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3970 format_str = T("Try `man %"TS"' for more details.\n");
3972 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3976 usage(int cmd, FILE *fp)
3978 tfprintf(fp, T("Usage:\n"));
3979 print_usage_string(cmd, fp);
3980 tfprintf(fp, T("\n"));
3981 recommend_man_page(cmd, fp);
3987 tfprintf(fp, T("Usage:\n"));
3988 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3989 print_usage_string(cmd, fp);
3990 tfprintf(fp, T("\n"));
3992 static const tchar *extra =
3995 " %"TS" --version\n"
3997 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4000 tfprintf(fp, extra, invocation_name, invocation_name);
4001 recommend_man_page(CMD_NONE, fp);
4004 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4005 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4006 * something else), while an Windows the command arguments will be UTF-16LE
4007 * encoded 'wchar_t' strings. */
4010 wmain(int argc, wchar_t **argv, wchar_t **envp)
4012 main(int argc, char **argv)
4019 imagex_info_file = stdout;
4020 invocation_name = tbasename(argv[0]);
4023 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4024 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4028 setlocale(LC_ALL, "");
4029 codeset = nl_langinfo(CODESET);
4030 if (!strstr(codeset, "UTF-8") &&
4031 !strstr(codeset, "UTF8") &&
4032 !strstr(codeset, "utf-8") &&
4033 !strstr(codeset, "utf8"))
4036 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4037 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4038 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4039 " to any value to force wimlib to use UTF-8.\n",
4044 #endif /* !__WIN32__ */
4046 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4048 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4049 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4050 for (int i = 0; i < CMD_MAX; i++) {
4051 if (!tstrcmp(invocation_name + 3,
4052 imagex_commands[i].name))
4061 /* Unless already known from the invocation name, determine which
4062 * command was specified. */
4063 if (cmd == CMD_NONE) {
4065 imagex_error(T("No command specified!\n"));
4069 for (int i = 0; i < CMD_MAX; i++) {
4070 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4075 if (cmd != CMD_NONE) {
4081 /* Handle --help and --version. --help can be either for the program as
4082 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4083 * CMD_NONE). Note: help_or_version() will not return if a --help or
4084 * --version argument was found. */
4085 help_or_version(argc, argv, cmd);
4087 /* Bail if a valid command was not specified. */
4088 if (cmd == CMD_NONE) {
4089 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4094 /* Enable warning and error messages in wimlib be more user-friendly.
4096 wimlib_set_print_errors(true);
4098 /* Initialize wimlib. */
4099 ret = wimlib_global_init(init_flags);
4101 goto out_check_status;
4103 /* Call the command handler function. */
4104 ret = imagex_commands[cmd].func(argc, argv, cmd);
4106 /* Check for error writing to standard output, especially since for some
4107 * commands, writing to standard output is part of the program's actual
4108 * behavior and not just for informational purposes. */
4109 if (ferror(stdout) || fclose(stdout)) {
4110 imagex_error_with_errno(T("error writing to standard output"));
4115 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4116 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4117 * error code from which an error message can be printed. */
4119 imagex_error(T("Exiting with error code %d:\n"
4121 wimlib_get_error_string(ret));
4122 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4123 imagex_error_with_errno(T("errno"));
4125 /* Make wimlib free any resources it's holding (although this is not
4126 * strictly necessary because the process is ending anyway). */
4127 wimlib_global_cleanup();