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_COMMAND_OPTION,
124 IMAGEX_COMMIT_OPTION,
125 IMAGEX_COMPRESS_OPTION,
126 IMAGEX_COMPRESS_SLOW_OPTION,
127 IMAGEX_CONFIG_OPTION,
129 IMAGEX_DELTA_FROM_OPTION,
130 IMAGEX_DEREFERENCE_OPTION,
131 IMAGEX_DEST_DIR_OPTION,
132 IMAGEX_EXTRACT_XML_OPTION,
135 IMAGEX_HARDLINK_OPTION,
136 IMAGEX_HEADER_OPTION,
137 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
139 IMAGEX_LOOKUP_TABLE_OPTION,
140 IMAGEX_METADATA_OPTION,
141 IMAGEX_NORPFIX_OPTION,
142 IMAGEX_NOCHECK_OPTION,
143 IMAGEX_NO_ACLS_OPTION,
144 IMAGEX_NOT_PIPABLE_OPTION,
146 IMAGEX_PIPABLE_OPTION,
147 IMAGEX_REBUILD_OPTION,
148 IMAGEX_RECOMPRESS_OPTION,
149 IMAGEX_RECURSIVE_OPTION,
151 IMAGEX_RESUME_OPTION,
154 IMAGEX_SOURCE_LIST_OPTION,
155 IMAGEX_STAGING_DIR_OPTION,
156 IMAGEX_STREAMS_INTERFACE_OPTION,
157 IMAGEX_STRICT_ACLS_OPTION,
158 IMAGEX_SYMLINK_OPTION,
159 IMAGEX_THREADS_OPTION,
160 IMAGEX_TO_STDOUT_OPTION,
161 IMAGEX_UNIX_DATA_OPTION,
162 IMAGEX_UPDATE_OF_OPTION,
163 IMAGEX_VERBOSE_OPTION,
167 static const struct option apply_options[] = {
168 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
169 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
170 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
171 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
172 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
173 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
174 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
175 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
176 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
177 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
178 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
179 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
181 /* --resume is undocumented for now as it needs improvement. */
182 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
186 static const struct option capture_or_append_options[] = {
187 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
188 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
189 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
190 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
191 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
192 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
193 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
194 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
195 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
196 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
197 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
198 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
199 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
200 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
201 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
202 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
203 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
204 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
205 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
206 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
207 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
208 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
209 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
213 static const struct option delete_options[] = {
214 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
215 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
219 static const struct option dir_options[] = {
220 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
224 static const struct option export_options[] = {
225 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
226 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
227 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
228 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
229 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
230 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
231 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
232 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
233 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
234 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
238 static const struct option extract_options[] = {
239 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
240 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
241 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
242 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
243 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
244 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
245 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
246 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
247 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
248 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
252 static const struct option info_options[] = {
253 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
254 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
255 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
256 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
257 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
258 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
259 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
260 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
261 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
265 static const struct option join_options[] = {
266 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
270 static const struct option mount_options[] = {
271 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
272 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
273 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
274 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
275 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
276 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
277 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
281 static const struct option optimize_options[] = {
282 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
283 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
284 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
285 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
286 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
287 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
288 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
289 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
290 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
294 static const struct option split_options[] = {
295 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
299 static const struct option unmount_options[] = {
300 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
301 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
302 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
303 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
307 static const struct option update_options[] = {
308 /* Careful: some of the options here set the defaults for update
309 * commands, but the flags given to an actual update command (and not to
310 * `imagex update' itself are also handled in
311 * update_command_add_option(). */
312 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
313 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
314 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
315 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
317 /* Default delete options */
318 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
319 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
321 /* Global add option */
322 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
324 /* Default add options */
325 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
326 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
327 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
328 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
329 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
330 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
336 # define _format_attribute(type, format_str, args_start) \
337 __attribute__((format(type, format_str, args_start)))
339 # define _format_attribute(type, format_str, args_start)
342 /* Print formatted error message to stderr. */
343 static void _format_attribute(printf, 1, 2)
344 imagex_error(const tchar *format, ...)
347 va_start(va, format);
348 tfputs(T("ERROR: "), stderr);
349 tvfprintf(stderr, format, va);
350 tputc(T('\n'), stderr);
354 /* Print formatted error message to stderr. */
355 static void _format_attribute(printf, 1, 2)
356 imagex_error_with_errno(const tchar *format, ...)
358 int errno_save = errno;
360 va_start(va, format);
361 tfputs(T("ERROR: "), stderr);
362 tvfprintf(stderr, format, va);
363 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
368 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
370 if (image == WIMLIB_NO_IMAGE) {
371 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
372 " Please specify a 1-based image index or "
373 "image name. To list the images\n"
374 " contained in the WIM archive, run\n"
376 " %"TS" \"%"TS"\"\n"),
377 image_name, wim_name,
378 get_cmd_string(CMD_INFO, false), wim_name);
379 return WIMLIB_ERR_INVALID_IMAGE;
385 verify_image_is_single(int image)
387 if (image == WIMLIB_ALL_IMAGES) {
388 imagex_error(T("Cannot specify all images for this action!"));
389 return WIMLIB_ERR_INVALID_IMAGE;
395 verify_image_exists_and_is_single(int image, const tchar *image_name,
396 const tchar *wim_name)
399 ret = verify_image_exists(image, image_name, wim_name);
401 ret = verify_image_is_single(image);
405 /* Parse the argument to --compress */
407 get_compression_type(const tchar *optarg)
409 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
410 return WIMLIB_COMPRESSION_TYPE_LZX;
411 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
412 return WIMLIB_COMPRESSION_TYPE_XPRESS;
413 else if (!tstrcasecmp(optarg, T("none")))
414 return WIMLIB_COMPRESSION_TYPE_NONE;
416 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
417 "\"maximum\", \"fast\", or \"none\"."), optarg);
418 return WIMLIB_COMPRESSION_TYPE_INVALID;
423 set_compress_slow(void)
425 static const struct wimlib_lzx_params slow_params = {
426 .size_of_this = sizeof(struct wimlib_lzx_params),
427 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
430 .use_len2_matches = 1,
431 .num_fast_bytes = 96,
432 .num_optim_passes = 4,
433 .max_search_depth = 100,
434 .max_matches_per_pos = 10,
435 .main_nostat_cost = 15,
436 .len_nostat_cost = 15,
437 .aligned_nostat_cost = 7,
441 if (wimlib_lzx_set_default_params(&slow_params))
442 imagex_error(T("Couldn't set slow compression parameters.!"));
446 const tchar **strings;
447 unsigned num_strings;
448 unsigned num_alloc_strings;
451 #define STRING_SET_INITIALIZER \
452 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
454 #define STRING_SET(_strings) \
455 struct string_set _strings = STRING_SET_INITIALIZER
458 string_set_append(struct string_set *set, const tchar *glob)
460 unsigned num_alloc_strings = set->num_alloc_strings;
462 if (set->num_strings == num_alloc_strings) {
463 const tchar **new_strings;
465 num_alloc_strings += 4;
466 new_strings = realloc(set->strings,
467 sizeof(set->strings[0]) * num_alloc_strings);
469 imagex_error(T("Out of memory!"));
472 set->strings = new_strings;
473 set->num_alloc_strings = num_alloc_strings;
475 set->strings[set->num_strings++] = glob;
480 string_set_destroy(struct string_set *set)
486 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
488 return wimlib_reference_resource_files(wim, set->strings,
490 WIMLIB_REF_FLAG_GLOB_ENABLE,
492 imagex_progress_func);
496 do_resource_not_found_warning(const tchar *wimfile,
497 const struct wimlib_wim_info *info,
498 const struct string_set *refglobs)
500 if (info->total_parts > 1) {
501 if (refglobs->num_strings == 0) {
502 imagex_error(T("\"%"TS"\" is part of a split WIM. "
503 "Use --ref to specify the other parts."),
506 imagex_error(T("Perhaps the '--ref' argument did not "
507 "specify all other parts of the split "
511 imagex_error(T("If this is a delta WIM, use the --ref argument "
512 "to specify the WIM(s) on which it is based."));
516 /* Returns the size of a file given its name, or -1 if the file does not exist
517 * or its size cannot be determined. */
519 file_get_size(const tchar *filename)
522 if (tstat(filename, &st) == 0)
529 PARSE_STRING_SUCCESS = 0,
530 PARSE_STRING_FAILURE = 1,
531 PARSE_STRING_NONE = 2,
535 * Parses a string token from an array of characters.
537 * Tokens are either whitespace-delimited, or double or single-quoted.
539 * @line_p: Pointer to the pointer to the line of data. Will be updated
540 * to point past the string token iff the return value is
541 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
544 * @len_p: @len_p initially stores the length of the line of data, which may
545 * be 0, and it will be updated to the number of bytes remaining in
546 * the line iff the return value is PARSE_STRING_SUCCESS.
548 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
549 * parsed string token will be returned here.
551 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
552 * PARSE_STRING_FAILURE if the data was invalid due to a missing
553 * closing quote; or PARSE_STRING_NONE if the line ended before the
554 * beginning of a string token was found.
557 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
560 tchar *line = *line_p;
564 /* Skip leading whitespace */
567 return PARSE_STRING_NONE;
568 if (!istspace(*line) && *line != T('\0'))
574 if (quote_char == T('"') || quote_char == T('\'')) {
579 line = tmemchr(line, quote_char, len);
581 imagex_error(T("Missing closing quote: %"TS), fn - 1);
582 return PARSE_STRING_FAILURE;
585 /* Unquoted string. Go until whitespace. Line is terminated
586 * by '\0', so no need to check 'len'. */
590 } while (!istspace(*line) && *line != T('\0'));
597 return PARSE_STRING_SUCCESS;
600 /* Parses a line of data (not an empty line or comment) in the source list file
601 * format. (See the man page for 'wimlib-imagex capture' for details on this
602 * format and the meaning.)
604 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
605 * len == 0. The data in @line will be modified by this function call.
607 * @len: Length of the line of data.
609 * @source: On success, the capture source and target described by the line is
610 * written into this destination. Note that it will contain pointers
611 * to data in the @line array.
613 * Returns true if the line was valid; false otherwise. */
615 parse_source_list_line(tchar *line, size_t len,
616 struct wimlib_capture_source *source)
620 ret = parse_string(&line, &len, &source->fs_source_path);
621 if (ret != PARSE_STRING_SUCCESS)
623 ret = parse_string(&line, &len, &source->wim_target_path);
624 if (ret == PARSE_STRING_NONE)
625 source->wim_target_path = source->fs_source_path;
626 return ret != PARSE_STRING_FAILURE;
629 /* Returns %true if the given line of length @len > 0 is a comment or empty line
630 * in the source list file format. */
632 is_comment_line(const tchar *line, size_t len)
637 if (!istspace(*line) && *line != T('\0'))
647 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
650 tchar *contents = *contents_p;
651 size_t nchars = *nchars_p;
654 for (i = 0; i < nchars; i++)
655 if (contents[i] == T('\n'))
658 /* Handle last line not terminated by a newline */
659 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
660 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
662 imagex_error(T("Out of memory!"));
665 contents[nchars] = T('\n');
666 *contents_p = contents;
674 /* Parses a file in the source list format. (See the man page for
675 * 'wimlib-imagex capture' for details on this format and the meaning.)
677 * @source_list_contents: Contents of the source list file. Note that this
678 * buffer will be modified to save memory allocations,
679 * and cannot be freed until the returned array of
680 * wimlib_capture_source's has also been freed.
682 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
685 * @nsources_ret: On success, the length of the returned array is
688 * Returns: An array of `struct wimlib_capture_source's that can be passed to
689 * the wimlib_add_image_multisource() function to specify how a WIM image is to
691 static struct wimlib_capture_source *
692 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
693 size_t *nsources_ret)
697 struct wimlib_capture_source *sources;
700 nlines = text_file_count_lines(source_list_contents_p,
701 &source_list_nchars);
705 /* Always allocate at least 1 slot, just in case the implementation of
706 * calloc() returns NULL if 0 bytes are requested. */
707 sources = calloc(nlines ?: 1, sizeof(*sources));
709 imagex_error(T("out of memory"));
712 p = *source_list_contents_p;
714 for (i = 0; i < nlines; i++) {
715 /* XXX: Could use rawmemchr() here instead, but it may not be
716 * available on all platforms. */
717 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
718 size_t len = endp - p + 1;
720 if (!is_comment_line(p, len)) {
721 if (!parse_source_list_line(p, len, &sources[j++])) {
734 enum capture_config_section {
735 CAPTURE_CONFIG_NO_SECTION,
736 CAPTURE_CONFIG_EXCLUSION_SECTION,
737 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
738 CAPTURE_CONFIG_IGNORE_SECTION,
742 CAPTURE_CONFIG_INVALID_SECTION,
743 CAPTURE_CONFIG_CHANGED_SECTION,
744 CAPTURE_CONFIG_SAME_SECTION,
748 check_config_section(tchar *line, size_t len,
749 enum capture_config_section *cur_section)
751 while (istspace(*line))
755 return CAPTURE_CONFIG_SAME_SECTION;
758 tchar *endbrace = tstrrchr(line, T(']'));
760 return CAPTURE_CONFIG_SAME_SECTION;
762 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
763 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
764 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
765 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
766 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
767 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
768 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
769 "of capture config file\n"),
771 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
772 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
773 tfputs(T("WARNING: Ignoring [AlignmentList] section "
774 "of capture config file\n"),
777 imagex_error(T("Invalid capture config file section \"%"TS"\""),
779 return CAPTURE_CONFIG_INVALID_SECTION;
781 return CAPTURE_CONFIG_CHANGED_SECTION;
786 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
789 if (pat_list->num_pats == pat_list->num_allocated_pats) {
791 size_t num_allocated_pats = pat_list->num_pats + 8;
793 pats = realloc(pat_list->pats,
794 num_allocated_pats * sizeof(pat_list->pats[0]));
796 imagex_error(T("Out of memory!"));
799 pat_list->pats = pats;
800 pat_list->num_allocated_pats = num_allocated_pats;
802 pat_list->pats[pat_list->num_pats++] = pat;
807 parse_capture_config_line(tchar *line, size_t len,
808 enum capture_config_section *cur_section,
809 struct wimlib_capture_config *config)
814 ret = check_config_section(line, len, cur_section);
815 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
817 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
820 switch (*cur_section) {
821 case CAPTURE_CONFIG_NO_SECTION:
822 imagex_error(T("Line \"%"TS"\" is not in a section "
823 "(such as [ExclusionList]"), line);
825 case CAPTURE_CONFIG_EXCLUSION_SECTION:
826 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
828 return pattern_list_add_pattern(&config->exclusion_pats,
830 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
831 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
833 return pattern_list_add_pattern(&config->exclusion_exception_pats,
835 case CAPTURE_CONFIG_IGNORE_SECTION:
842 parse_capture_config(tchar **contents_p, size_t nchars,
843 struct wimlib_capture_config *config)
848 enum capture_config_section cur_section;
850 memset(config, 0, sizeof(*config));
852 nlines = text_file_count_lines(contents_p, &nchars);
856 cur_section = CAPTURE_CONFIG_NO_SECTION;
858 for (i = 0; i < nlines; i++) {
859 tchar *endp = tmemchr(p, T('\n'), nchars);
860 size_t len = endp - p + 1;
862 if (!is_comment_line(p, len))
863 if (!parse_capture_config_line(p, len, &cur_section, config))
871 /* Reads the contents of a file into memory. */
873 file_get_contents(const tchar *filename, size_t *len_ret)
880 if (tstat(filename, &stbuf) != 0) {
881 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
886 fp = tfopen(filename, T("rb"));
888 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
892 buf = malloc(len ? len : 1);
894 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
895 "contents of file \"%"TS"\""), len, filename);
898 if (fread(buf, 1, len, fp) != len) {
899 imagex_error_with_errno(T("Failed to read %zu bytes from the "
900 "file \"%"TS"\""), len, filename);
914 /* Read standard input until EOF and return the full contents in a malloc()ed
915 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
918 stdin_get_contents(size_t *len_ret)
920 /* stdin can, of course, be a pipe or other non-seekable file, so the
921 * total length of the data cannot be pre-determined */
923 size_t newlen = 1024;
927 char *p = realloc(buf, newlen);
928 size_t bytes_read, bytes_to_read;
930 imagex_error(T("out of memory while reading stdin"));
934 bytes_to_read = newlen - pos;
935 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
937 if (bytes_read != bytes_to_read) {
942 imagex_error_with_errno(T("error reading stdin"));
956 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
959 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
961 *num_tchars_ret = num_bytes;
963 #else /* !__WIN32__ */
964 /* On Windows, translate the text to UTF-16LE */
968 if (num_bytes >= 2 &&
969 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
970 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
972 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
973 * with something that looks like an ASCII character encoded as
974 * a UTF-16LE code unit. Assume the file is encoded as
975 * UTF-16LE. This is not a 100% reliable check. */
976 num_wchars = num_bytes / 2;
977 text_wstr = (wchar_t*)text;
979 /* File does not look like UTF-16LE. Assume it is encoded in
980 * the current Windows code page. I think these are always
981 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
982 * should work as expected. */
983 text_wstr = win32_mbs_to_wcs(text,
988 *num_tchars_ret = num_wchars;
990 #endif /* __WIN32__ */
994 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
999 contents = file_get_contents(filename, &num_bytes);
1002 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1006 stdin_get_text_contents(size_t *num_tchars_ret)
1011 contents = stdin_get_contents(&num_bytes);
1014 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1017 #define TO_PERCENT(numerator, denominator) \
1018 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1020 /* Given an enumerated value for WIM compression type, return a descriptive
1022 static const tchar *
1023 get_data_type(int ctype)
1026 case WIMLIB_COMPRESSION_TYPE_NONE:
1027 return T("uncompressed");
1028 case WIMLIB_COMPRESSION_TYPE_LZX:
1029 return T("LZX-compressed");
1030 case WIMLIB_COMPRESSION_TYPE_XPRESS:
1031 return T("XPRESS-compressed");
1036 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1037 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1038 #define KIBIBYTE_MIN_NBYTES 10000ULL
1041 get_unit(uint64_t total_bytes, const tchar **name_ret)
1043 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1044 *name_ret = T("GiB");
1046 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1047 *name_ret = T("MiB");
1049 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1050 *name_ret = T("KiB");
1053 *name_ret = T("bytes");
1058 /* Progress callback function passed to various wimlib functions. */
1060 imagex_progress_func(enum wimlib_progress_msg msg,
1061 const union wimlib_progress_info *info)
1063 unsigned percent_done;
1064 unsigned unit_shift;
1065 const tchar *unit_name;
1066 if (imagex_be_quiet)
1069 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1070 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1071 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1072 info->write_streams.total_bytes);
1074 if (info->write_streams.completed_streams == 0) {
1075 const tchar *data_type;
1077 data_type = get_data_type(info->write_streams.compression_type);
1078 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
1079 data_type, info->write_streams.num_threads,
1080 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1082 if (info->write_streams.total_parts <= 1) {
1083 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1084 "written (%u%% done)"),
1085 info->write_streams.completed_bytes >> unit_shift,
1087 info->write_streams.total_bytes >> unit_shift,
1091 imagex_printf(T("\rWriting resources from part %u of %u: "
1092 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1093 (info->write_streams.completed_parts ==
1094 info->write_streams.total_parts) ?
1095 info->write_streams.completed_parts :
1096 info->write_streams.completed_parts + 1,
1097 info->write_streams.total_parts,
1098 info->write_streams.completed_bytes >> unit_shift,
1100 info->write_streams.total_bytes >> unit_shift,
1104 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1105 imagex_printf(T("\n"));
1107 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1108 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1109 if (*info->scan.wim_target_path) {
1110 imagex_printf(T(" (loading as WIM path: "
1111 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1112 info->scan.wim_target_path);
1114 imagex_printf(T(" (loading as root of WIM image)...\n"));
1117 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1118 switch (info->scan.status) {
1119 case WIMLIB_SCAN_DENTRY_OK:
1120 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1122 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1123 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1125 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1126 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1127 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1131 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1132 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1133 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1134 info->integrity.total_bytes);
1135 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1136 "of %"PRIu64" %"TS" (%u%%) done"),
1137 info->integrity.filename,
1138 info->integrity.completed_bytes >> unit_shift,
1140 info->integrity.total_bytes >> unit_shift,
1143 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1144 imagex_printf(T("\n"));
1146 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1147 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1148 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1149 info->integrity.total_bytes);
1150 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1151 "of %"PRIu64" %"TS" (%u%%) done"),
1152 info->integrity.completed_bytes >> unit_shift,
1154 info->integrity.total_bytes >> unit_shift,
1157 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1158 imagex_printf(T("\n"));
1160 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1161 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1162 "to %"TS" \"%"TS"\"\n"),
1163 info->extract.image,
1164 info->extract.image_name,
1165 info->extract.wimfile_name,
1166 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1167 T("NTFS volume") : T("directory")),
1168 info->extract.target);
1170 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1171 imagex_printf(T("Extracting "
1172 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1173 "in \"%"TS"\" to \"%"TS"\"\n"),
1174 info->extract.extract_root_wim_source_path,
1175 info->extract.image,
1176 info->extract.image_name,
1177 info->extract.wimfile_name,
1178 info->extract.target);
1180 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1181 percent_done = TO_PERCENT(info->extract.completed_bytes,
1182 info->extract.total_bytes);
1183 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1184 imagex_printf(T("\rExtracting files: "
1185 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1186 info->extract.completed_bytes >> unit_shift,
1188 info->extract.total_bytes >> unit_shift,
1191 if (info->extract.completed_bytes >= info->extract.total_bytes)
1192 imagex_printf(T("\n"));
1194 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1195 if (info->extract.total_parts != 1) {
1196 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1197 info->extract.part_number,
1198 info->extract.total_parts);
1201 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1202 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1203 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1205 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1206 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1207 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1208 info->extract.target);
1211 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1212 percent_done = TO_PERCENT(info->split.completed_bytes,
1213 info->split.total_bytes);
1214 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1215 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1216 "%"PRIu64" %"TS" (%u%%) written\n"),
1217 info->split.part_name,
1218 info->split.cur_part_number,
1219 info->split.total_parts,
1220 info->split.completed_bytes >> unit_shift,
1222 info->split.total_bytes >> unit_shift,
1226 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1227 if (info->split.completed_bytes == info->split.total_bytes) {
1228 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1229 info->split.cur_part_number,
1230 info->split.total_parts);
1233 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1234 switch (info->update.command->op) {
1235 case WIMLIB_UPDATE_OP_DELETE:
1236 imagex_printf(T("Deleted WIM path "
1237 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1238 info->update.command->delete_.wim_path);
1240 case WIMLIB_UPDATE_OP_RENAME:
1241 imagex_printf(T("Renamed WIM path "
1242 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1243 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1244 info->update.command->rename.wim_source_path,
1245 info->update.command->rename.wim_target_path);
1247 case WIMLIB_UPDATE_OP_ADD:
1255 fflush(imagex_info_file);
1260 parse_num_threads(const tchar *optarg)
1263 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1264 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1265 imagex_error(T("Number of threads must be a non-negative integer!"));
1273 * Parse an option passed to an update command.
1275 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1278 * @option: Text string for the option (beginning with --)
1280 * @cmd: `struct wimlib_update_command' that is being constructed for
1283 * Returns true if the option was recognized; false if not.
1286 update_command_add_option(int op, const tchar *option,
1287 struct wimlib_update_command *cmd)
1289 bool recognized = true;
1291 case WIMLIB_UPDATE_OP_ADD:
1292 if (!tstrcmp(option, T("--verbose")))
1293 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1294 else if (!tstrcmp(option, T("--unix-data")))
1295 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1296 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1297 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1298 else if (!tstrcmp(option, T("--strict-acls")))
1299 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1300 else if (!tstrcmp(option, T("--dereference")))
1301 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1305 case WIMLIB_UPDATE_OP_DELETE:
1306 if (!tstrcmp(option, T("--force")))
1307 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1308 else if (!tstrcmp(option, T("--recursive")))
1309 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1320 /* How many nonoption arguments each `imagex update' command expects */
1321 static const unsigned update_command_num_nonoptions[] = {
1322 [WIMLIB_UPDATE_OP_ADD] = 2,
1323 [WIMLIB_UPDATE_OP_DELETE] = 1,
1324 [WIMLIB_UPDATE_OP_RENAME] = 2,
1328 update_command_add_nonoption(int op, const tchar *nonoption,
1329 struct wimlib_update_command *cmd,
1330 unsigned num_nonoptions)
1333 case WIMLIB_UPDATE_OP_ADD:
1334 if (num_nonoptions == 0)
1335 cmd->add.fs_source_path = (tchar*)nonoption;
1337 cmd->add.wim_target_path = (tchar*)nonoption;
1339 case WIMLIB_UPDATE_OP_DELETE:
1340 cmd->delete_.wim_path = (tchar*)nonoption;
1342 case WIMLIB_UPDATE_OP_RENAME:
1343 if (num_nonoptions == 0)
1344 cmd->rename.wim_source_path = (tchar*)nonoption;
1346 cmd->rename.wim_target_path = (tchar*)nonoption;
1352 * Parse a command passed on stdin to `imagex update'.
1354 * @line: Text of the command.
1355 * @len: Length of the line, including a null terminator
1358 * @command: A `struct wimlib_update_command' to fill in from the parsed
1361 * @line_number: Line number of the command, for diagnostics.
1363 * Returns true on success; returns false on parse error.
1366 parse_update_command(tchar *line, size_t len,
1367 struct wimlib_update_command *command,
1371 tchar *command_name;
1373 size_t num_nonoptions;
1375 /* Get the command name ("add", "delete", "rename") */
1376 ret = parse_string(&line, &len, &command_name);
1377 if (ret != PARSE_STRING_SUCCESS)
1380 if (!tstrcasecmp(command_name, T("add"))) {
1381 op = WIMLIB_UPDATE_OP_ADD;
1382 } else if (!tstrcasecmp(command_name, T("delete"))) {
1383 op = WIMLIB_UPDATE_OP_DELETE;
1384 } else if (!tstrcasecmp(command_name, T("rename"))) {
1385 op = WIMLIB_UPDATE_OP_RENAME;
1387 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1388 command_name, line_number);
1393 /* Parse additional options and non-options as needed */
1398 ret = parse_string(&line, &len, &next_string);
1399 if (ret == PARSE_STRING_NONE) /* End of line */
1401 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1403 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1405 if (!update_command_add_option(op, next_string, command))
1407 imagex_error(T("Unrecognized option \"%"TS"\" to "
1408 "update command \"%"TS"\" on line %zu"),
1409 next_string, command_name, line_number);
1415 if (num_nonoptions == update_command_num_nonoptions[op])
1417 imagex_error(T("Unexpected argument \"%"TS"\" in "
1418 "update command on line %zu\n"
1419 " (The \"%"TS"\" command only "
1420 "takes %zu nonoption arguments!)\n"),
1421 next_string, line_number,
1422 command_name, num_nonoptions);
1425 update_command_add_nonoption(op, next_string,
1426 command, num_nonoptions);
1431 if (num_nonoptions != update_command_num_nonoptions[op]) {
1432 imagex_error(T("Not enough arguments to update command "
1433 "\"%"TS"\" on line %zu"), command_name, line_number);
1439 static struct wimlib_update_command *
1440 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1441 size_t *num_cmds_ret)
1445 struct wimlib_update_command *cmds;
1448 nlines = text_file_count_lines(cmd_file_contents_p,
1453 /* Always allocate at least 1 slot, just in case the implementation of
1454 * calloc() returns NULL if 0 bytes are requested. */
1455 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1457 imagex_error(T("out of memory"));
1460 p = *cmd_file_contents_p;
1462 for (i = 0; i < nlines; i++) {
1463 /* XXX: Could use rawmemchr() here instead, but it may not be
1464 * available on all platforms. */
1465 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1466 size_t len = endp - p + 1;
1468 if (!is_comment_line(p, len)) {
1469 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1480 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1481 * one image from a WIM file to a NTFS volume. */
1483 imagex_apply(int argc, tchar **argv, int cmd)
1487 int image = WIMLIB_NO_IMAGE;
1489 struct wimlib_wim_info info;
1491 const tchar *wimfile;
1492 const tchar *target;
1493 const tchar *image_num_or_name = NULL;
1494 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1496 STRING_SET(refglobs);
1498 for_opt(c, apply_options) {
1500 case IMAGEX_CHECK_OPTION:
1501 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1503 case IMAGEX_HARDLINK_OPTION:
1504 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1506 case IMAGEX_SYMLINK_OPTION:
1507 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1509 case IMAGEX_VERBOSE_OPTION:
1510 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1512 case IMAGEX_REF_OPTION:
1513 ret = string_set_append(&refglobs, optarg);
1515 goto out_free_refglobs;
1517 case IMAGEX_UNIX_DATA_OPTION:
1518 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1520 case IMAGEX_NO_ACLS_OPTION:
1521 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1523 case IMAGEX_STRICT_ACLS_OPTION:
1524 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1526 case IMAGEX_NORPFIX_OPTION:
1527 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1529 case IMAGEX_RPFIX_OPTION:
1530 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1532 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1533 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1534 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1536 case IMAGEX_RESUME_OPTION:
1537 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1545 if (argc != 2 && argc != 3)
1550 if (!tstrcmp(wimfile, T("-"))) {
1551 /* Attempt to apply pipable WIM from standard input. */
1553 image_num_or_name = NULL;
1556 image_num_or_name = argv[1];
1561 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1562 imagex_progress_func);
1564 goto out_free_refglobs;
1566 wimlib_get_wim_info(wim, &info);
1569 /* Image explicitly specified. */
1570 image_num_or_name = argv[1];
1571 image = wimlib_resolve_image(wim, image_num_or_name);
1572 ret = verify_image_exists(image, image_num_or_name, wimfile);
1574 goto out_wimlib_free;
1577 /* No image specified; default to image 1, but only if the WIM
1578 * contains exactly one image. */
1580 if (info.image_count != 1) {
1581 imagex_error(T("\"%"TS"\" contains %d images; "
1582 "Please select one (or all)."),
1583 wimfile, info.image_count);
1592 if (refglobs.num_strings) {
1594 imagex_error(T("Can't specify --ref when applying from stdin!"));
1596 goto out_wimlib_free;
1598 ret = wim_reference_globs(wim, &refglobs, open_flags);
1600 goto out_wimlib_free;
1605 /* Interpret a regular file or block device target as a NTFS
1609 if (tstat(target, &stbuf)) {
1610 if (errno != ENOENT) {
1611 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1614 goto out_wimlib_free;
1617 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1618 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1624 ret = wimlib_extract_image(wim, image, target, extract_flags,
1625 imagex_progress_func);
1627 set_fd_to_binary_mode(STDIN_FILENO);
1628 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1630 target, extract_flags,
1631 imagex_progress_func);
1634 imagex_printf(T("Done applying WIM image.\n"));
1635 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1637 do_resource_not_found_warning(wimfile, &info, &refglobs);
1639 imagex_error(T( "If you are applying an image "
1640 "from a split pipable WIM,\n"
1641 " make sure you have "
1642 "concatenated together all parts."));
1648 string_set_destroy(&refglobs);
1652 usage(CMD_APPLY, stderr);
1654 goto out_free_refglobs;
1657 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1658 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1659 * the desired image. 'wimlib-imagex append': add a new image to an existing
1662 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1665 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1666 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1667 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1668 int write_flags = 0;
1669 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1670 const tchar *wimfile;
1674 const tchar *flags_element = NULL;
1677 STRING_SET(base_wimfiles);
1678 WIMStruct **base_wims;
1680 WIMStruct *template_wim;
1681 const tchar *template_wimfile = NULL;
1682 const tchar *template_image_name_or_num = NULL;
1683 int template_image = WIMLIB_NO_IMAGE;
1686 unsigned num_threads = 0;
1691 const tchar *config_file = NULL;
1693 struct wimlib_capture_config *config;
1695 bool source_list = false;
1696 size_t source_list_nchars = 0;
1697 tchar *source_list_contents;
1698 bool capture_sources_malloced;
1699 struct wimlib_capture_source *capture_sources;
1701 bool name_defaulted;
1703 for_opt(c, capture_or_append_options) {
1705 case IMAGEX_BOOT_OPTION:
1706 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1708 case IMAGEX_CHECK_OPTION:
1709 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1710 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1712 case IMAGEX_NOCHECK_OPTION:
1713 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1715 case IMAGEX_CONFIG_OPTION:
1716 config_file = optarg;
1717 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1719 case IMAGEX_COMPRESS_OPTION:
1720 compression_type = get_compression_type(optarg);
1721 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1724 case IMAGEX_COMPRESS_SLOW_OPTION:
1725 set_compress_slow();
1727 case IMAGEX_FLAGS_OPTION:
1728 flags_element = optarg;
1730 case IMAGEX_DEREFERENCE_OPTION:
1731 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1733 case IMAGEX_VERBOSE_OPTION:
1734 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1736 case IMAGEX_THREADS_OPTION:
1737 num_threads = parse_num_threads(optarg);
1738 if (num_threads == UINT_MAX)
1741 case IMAGEX_REBUILD_OPTION:
1742 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1744 case IMAGEX_UNIX_DATA_OPTION:
1745 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1747 case IMAGEX_SOURCE_LIST_OPTION:
1750 case IMAGEX_NO_ACLS_OPTION:
1751 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1753 case IMAGEX_STRICT_ACLS_OPTION:
1754 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1756 case IMAGEX_RPFIX_OPTION:
1757 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1759 case IMAGEX_NORPFIX_OPTION:
1760 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1762 case IMAGEX_PIPABLE_OPTION:
1763 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1765 case IMAGEX_NOT_PIPABLE_OPTION:
1766 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1768 case IMAGEX_UPDATE_OF_OPTION:
1769 if (template_image_name_or_num) {
1770 imagex_error(T("'--update-of' can only be "
1771 "specified one time!"));
1775 colon = tstrrchr(optarg, T(':'));
1778 template_wimfile = optarg;
1780 template_image_name_or_num = colon + 1;
1782 template_wimfile = NULL;
1783 template_image_name_or_num = optarg;
1787 case IMAGEX_DELTA_FROM_OPTION:
1788 if (cmd != CMD_CAPTURE) {
1789 imagex_error(T("'--delta-from' is only "
1790 "valid for capture!"));
1793 ret = string_set_append(&base_wimfiles, optarg);
1795 goto out_free_base_wimfiles;
1796 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1805 if (argc < 2 || argc > 4)
1811 /* Set default compression type. */
1812 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1813 struct wimlib_lzx_params params;
1814 memset(¶ms, 0, sizeof(params));
1815 params.size_of_this = sizeof(params);
1816 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1817 params.use_defaults = 1;
1819 wimlib_lzx_set_default_params(¶ms);
1820 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1823 if (!tstrcmp(wimfile, T("-"))) {
1824 /* Writing captured WIM to standard output. */
1826 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1827 imagex_error("Can't write a non-pipable WIM to "
1828 "standard output! Specify --pipable\n"
1829 " if you want to create a pipable WIM "
1830 "(but read the docs first).");
1834 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1836 if (cmd == CMD_APPEND) {
1837 imagex_error(T("Using standard output for append does "
1838 "not make sense."));
1841 wim_fd = STDOUT_FILENO;
1843 imagex_info_file = stderr;
1844 set_fd_to_binary_mode(wim_fd);
1847 /* If template image was specified using --update-of=IMAGE rather
1848 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1849 if (template_image_name_or_num && !template_wimfile) {
1850 if (base_wimfiles.num_strings == 1) {
1851 /* Capturing delta WIM based on single WIM: default to
1853 template_wimfile = base_wimfiles.strings[0];
1854 } else if (cmd == CMD_APPEND) {
1855 /* Appending to WIM: default to WIM being appended to.
1857 template_wimfile = wimfile;
1859 /* Capturing a normal (non-delta) WIM, so the WIM file
1860 * *must* be explicitly specified. */
1861 if (base_wimfiles.num_strings > 1) {
1862 imagex_error(T("For capture of delta WIM "
1863 "based on multiple existing "
1865 " '--update-of' must "
1866 "specify WIMFILE:IMAGE!"));
1868 imagex_error(T("For capture of non-delta WIM, "
1869 "'--update-of' must specify "
1878 name_defaulted = false;
1880 /* Set default name to SOURCE argument, omitting any directory
1881 * prefixes and trailing slashes. This requires making a copy
1882 * of @source. Leave some free characters at the end in case we
1883 * append a number to keep the name unique. */
1884 size_t source_name_len;
1886 source_name_len = tstrlen(source);
1887 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1888 name = tbasename(tstrcpy(source_copy, source));
1889 name_defaulted = true;
1891 /* Image description defaults to NULL if not given. */
1898 /* Set up capture sources in source list mode */
1899 if (source[0] == T('-') && source[1] == T('\0')) {
1900 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1902 source_list_contents = file_get_text_contents(source,
1903 &source_list_nchars);
1905 if (!source_list_contents)
1908 capture_sources = parse_source_list(&source_list_contents,
1911 if (!capture_sources) {
1913 goto out_free_source_list_contents;
1915 capture_sources_malloced = true;
1917 /* Set up capture source in non-source-list mode. */
1918 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1919 capture_sources[0].fs_source_path = source;
1920 capture_sources[0].wim_target_path = NULL;
1921 capture_sources[0].reserved = 0;
1923 capture_sources_malloced = false;
1924 source_list_contents = NULL;
1928 /* Read and parse capture configuration file. */
1931 config_str = file_get_text_contents(config_file, &config_len);
1934 goto out_free_capture_sources;
1937 config = alloca(sizeof(*config));
1938 ret = parse_capture_config(&config_str, config_len, config);
1940 goto out_free_config;
1942 /* No capture configuration file specified; use default
1943 * configuration for capturing Windows operating systems. */
1945 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1948 /* Open the existing WIM, or create a new one. */
1949 if (cmd == CMD_APPEND)
1950 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1951 imagex_progress_func);
1953 ret = wimlib_create_new_wim(compression_type, &wim);
1955 goto out_free_config;
1958 /* Detect if source is regular file or block device and set NTFS volume
1963 if (tstat(source, &stbuf) == 0) {
1964 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1965 imagex_printf(T("Capturing WIM image from NTFS "
1966 "filesystem on \"%"TS"\"\n"), source);
1967 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1970 if (errno != ENOENT) {
1971 imagex_error_with_errno(T("Failed to stat "
1972 "\"%"TS"\""), source);
1980 /* If the user did not specify an image name, and the basename of the
1981 * source already exists as an image name in the WIM file, append a
1982 * suffix to make it unique. */
1983 if (cmd == CMD_APPEND && name_defaulted) {
1984 unsigned long conflict_idx;
1985 tchar *name_end = tstrchr(name, T('\0'));
1986 for (conflict_idx = 1;
1987 wimlib_image_name_in_use(wim, name);
1990 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1994 /* If capturing a delta WIM, reference resources from the base WIMs
1995 * before adding the new image. */
1996 if (base_wimfiles.num_strings) {
1997 base_wims = calloc(base_wimfiles.num_strings,
1998 sizeof(base_wims[0]));
1999 if (base_wims == NULL) {
2000 imagex_error(T("Out of memory!"));
2005 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2006 ret = wimlib_open_wim(base_wimfiles.strings[i],
2007 open_flags, &base_wims[i],
2008 imagex_progress_func);
2010 goto out_free_base_wims;
2014 ret = wimlib_reference_resources(wim, base_wims,
2015 base_wimfiles.num_strings, 0);
2017 goto out_free_base_wims;
2019 if (base_wimfiles.num_strings == 1) {
2020 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2021 base_wimfiles.strings[0]);
2023 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2024 base_wimfiles.num_strings);
2031 /* If capturing or appending as an update of an existing (template) image,
2032 * open the WIM if needed and parse the image index. */
2033 if (template_image_name_or_num) {
2036 if (base_wimfiles.num_strings == 1 &&
2037 template_wimfile == base_wimfiles.strings[0]) {
2038 template_wim = base_wims[0];
2039 } else if (template_wimfile == wimfile) {
2042 ret = wimlib_open_wim(template_wimfile, open_flags,
2043 &template_wim, imagex_progress_func);
2045 goto out_free_base_wims;
2048 template_image = wimlib_resolve_image(template_wim,
2049 template_image_name_or_num);
2051 if (template_image_name_or_num[0] == T('-')) {
2054 struct wimlib_wim_info info;
2056 wimlib_get_wim_info(template_wim, &info);
2057 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2058 if (n >= 1 && n <= info.image_count &&
2060 tmp != template_image_name_or_num + 1)
2062 template_image = info.image_count - (n - 1);
2065 ret = verify_image_exists_and_is_single(template_image,
2066 template_image_name_or_num,
2069 goto out_free_template_wim;
2071 template_wim = NULL;
2074 ret = wimlib_add_image_multisource(wim,
2080 imagex_progress_func);
2082 goto out_free_template_wim;
2084 if (desc || flags_element || template_image_name_or_num) {
2085 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2086 * on which the added one is to be based has been specified with
2087 * --update-of. Get the index of the image we just
2088 * added, then use it to call the appropriate functions. */
2089 struct wimlib_wim_info info;
2091 wimlib_get_wim_info(wim, &info);
2094 ret = wimlib_set_image_descripton(wim,
2098 goto out_free_template_wim;
2101 if (flags_element) {
2102 ret = wimlib_set_image_flags(wim, info.image_count,
2105 goto out_free_template_wim;
2108 /* Reference template image if the user provided one. */
2109 if (template_image_name_or_num) {
2110 imagex_printf(T("Using image %d "
2111 "from \"%"TS"\" as template\n"),
2112 template_image, template_wimfile);
2113 ret = wimlib_reference_template_image(wim,
2119 goto out_free_template_wim;
2123 /* Write the new WIM or overwrite the existing WIM with the new image
2125 if (cmd == CMD_APPEND) {
2126 ret = wimlib_overwrite(wim, write_flags, num_threads,
2127 imagex_progress_func);
2128 } else if (wimfile) {
2129 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2130 write_flags, num_threads,
2131 imagex_progress_func);
2133 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2134 write_flags, num_threads,
2135 imagex_progress_func);
2137 out_free_template_wim:
2138 /* template_wim may alias base_wims[0] or wim. */
2139 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2140 template_wim != wim)
2141 wimlib_free(template_wim);
2143 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2144 wimlib_free(base_wims[i]);
2150 free(config->exclusion_pats.pats);
2151 free(config->exclusion_exception_pats.pats);
2154 out_free_capture_sources:
2155 if (capture_sources_malloced)
2156 free(capture_sources);
2157 out_free_source_list_contents:
2158 free(source_list_contents);
2159 out_free_base_wimfiles:
2160 string_set_destroy(&base_wimfiles);
2167 goto out_free_base_wimfiles;
2170 /* Remove image(s) from a WIM. */
2172 imagex_delete(int argc, tchar **argv, int cmd)
2175 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2176 int write_flags = 0;
2177 const tchar *wimfile;
2178 const tchar *image_num_or_name;
2183 for_opt(c, delete_options) {
2185 case IMAGEX_CHECK_OPTION:
2186 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2187 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2189 case IMAGEX_SOFT_OPTION:
2190 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2201 imagex_error(T("Must specify a WIM file"));
2203 imagex_error(T("Must specify an image"));
2207 image_num_or_name = argv[1];
2209 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2210 imagex_progress_func);
2214 image = wimlib_resolve_image(wim, image_num_or_name);
2216 ret = verify_image_exists(image, image_num_or_name, wimfile);
2218 goto out_wimlib_free;
2220 ret = wimlib_delete_image(wim, image);
2222 imagex_error(T("Failed to delete image from \"%"TS"\""),
2224 goto out_wimlib_free;
2227 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2229 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2230 "deleted"), wimfile);
2238 usage(CMD_DELETE, stderr);
2244 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2246 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2247 return (ret >= 0) ? 0 : -1;
2250 /* Print the files contained in an image(s) in a WIM file. */
2252 imagex_dir(int argc, tchar **argv, int cmd)
2254 const tchar *wimfile;
2255 WIMStruct *wim = NULL;
2258 const tchar *path = T("");
2261 for_opt(c, dir_options) {
2263 case IMAGEX_PATH_OPTION:
2274 imagex_error(T("Must specify a WIM file"));
2278 imagex_error(T("Too many arguments"));
2283 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2288 image = wimlib_resolve_image(wim, argv[1]);
2289 ret = verify_image_exists(image, argv[1], wimfile);
2291 goto out_wimlib_free;
2293 /* No image specified; default to image 1, but only if the WIM
2294 * contains exactly one image. */
2296 struct wimlib_wim_info info;
2298 wimlib_get_wim_info(wim, &info);
2299 if (info.image_count != 1) {
2300 imagex_error(T("\"%"TS"\" contains %d images; Please "
2301 "select one (or all)."),
2302 wimfile, info.image_count);
2309 ret = wimlib_iterate_dir_tree(wim, image, path,
2310 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2311 print_full_path, NULL);
2318 usage(CMD_DIR, stderr);
2323 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2326 imagex_export(int argc, tchar **argv, int cmd)
2330 int export_flags = 0;
2331 int write_flags = 0;
2332 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2333 const tchar *src_wimfile;
2334 const tchar *src_image_num_or_name;
2335 const tchar *dest_wimfile;
2337 const tchar *dest_name;
2338 const tchar *dest_desc;
2340 struct wimlib_wim_info src_info;
2341 WIMStruct *dest_wim;
2346 STRING_SET(refglobs);
2347 unsigned num_threads = 0;
2349 for_opt(c, export_options) {
2351 case IMAGEX_BOOT_OPTION:
2352 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2354 case IMAGEX_CHECK_OPTION:
2355 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2356 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2358 case IMAGEX_NOCHECK_OPTION:
2359 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2361 case IMAGEX_COMPRESS_OPTION:
2362 compression_type = get_compression_type(optarg);
2363 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2366 case IMAGEX_REF_OPTION:
2367 ret = string_set_append(&refglobs, optarg);
2369 goto out_free_refglobs;
2371 case IMAGEX_THREADS_OPTION:
2372 num_threads = parse_num_threads(optarg);
2373 if (num_threads == UINT_MAX)
2376 case IMAGEX_REBUILD_OPTION:
2377 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2379 case IMAGEX_PIPABLE_OPTION:
2380 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2382 case IMAGEX_NOT_PIPABLE_OPTION:
2383 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2391 if (argc < 3 || argc > 5)
2393 src_wimfile = argv[0];
2394 src_image_num_or_name = argv[1];
2395 dest_wimfile = argv[2];
2396 dest_name = (argc >= 4) ? argv[3] : NULL;
2397 dest_desc = (argc >= 5) ? argv[4] : NULL;
2398 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2399 imagex_progress_func);
2401 goto out_free_refglobs;
2403 wimlib_get_wim_info(src_wim, &src_info);
2405 /* Determine if the destination is an existing file or not. If so, we
2406 * try to append the exported image(s) to it; otherwise, we create a new
2407 * WIM containing the exported image(s). Furthermore, determine if we
2408 * need to write a pipable WIM directly to standard output. */
2410 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2412 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2413 imagex_error("Can't write a non-pipable WIM to "
2414 "standard output! Specify --pipable\n"
2415 " if you want to create a pipable WIM "
2416 "(but read the docs first).");
2418 goto out_free_src_wim;
2421 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2423 dest_wimfile = NULL;
2424 dest_wim_fd = STDOUT_FILENO;
2425 imagex_info_file = stderr;
2426 set_fd_to_binary_mode(dest_wim_fd);
2429 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2431 /* Destination file exists. */
2433 if (!S_ISREG(stbuf.st_mode)) {
2434 imagex_error(T("\"%"TS"\" is not a regular file"),
2437 goto out_free_src_wim;
2439 ret = wimlib_open_wim(dest_wimfile,
2440 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2441 &dest_wim, imagex_progress_func);
2443 goto out_free_src_wim;
2445 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2446 /* The user specified a compression type, but we're
2447 * exporting to an existing WIM. Make sure the
2448 * specified compression type is the same as the
2449 * compression type of the existing destination WIM. */
2450 struct wimlib_wim_info dest_info;
2452 wimlib_get_wim_info(dest_wim, &dest_info);
2453 if (compression_type != dest_info.compression_type) {
2454 imagex_error(T("Cannot specify a compression type that is "
2455 "not the same as that used in the "
2456 "destination WIM"));
2458 goto out_free_dest_wim;
2464 if (errno != ENOENT) {
2465 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2468 goto out_free_src_wim;
2471 /* dest_wimfile is not an existing file, so create a new WIM. */
2473 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2474 /* The user did not specify a compression type; default
2475 * to that of the source WIM. */
2477 compression_type = src_info.compression_type;
2479 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2481 goto out_free_src_wim;
2484 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2485 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2487 goto out_free_dest_wim;
2489 if (refglobs.num_strings) {
2490 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2492 goto out_free_dest_wim;
2495 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2496 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2498 imagex_error(T("--boot specified for all-images export, but source WIM "
2499 "has no bootable image."));
2501 goto out_free_dest_wim;
2504 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2505 dest_desc, export_flags, imagex_progress_func);
2507 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2508 do_resource_not_found_warning(src_wimfile,
2509 &src_info, &refglobs);
2511 goto out_free_dest_wim;
2515 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2516 imagex_progress_func);
2517 else if (dest_wimfile)
2518 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2519 write_flags, num_threads,
2520 imagex_progress_func);
2522 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2523 WIMLIB_ALL_IMAGES, write_flags,
2524 num_threads, imagex_progress_func);
2526 wimlib_free(dest_wim);
2528 wimlib_free(src_wim);
2530 string_set_destroy(&refglobs);
2534 usage(CMD_EXPORT, stderr);
2537 goto out_free_refglobs;
2541 is_root_wim_path(const tchar *path)
2544 for (p = path; *p; p++)
2545 if (*p != T('\\') && *p != T('/'))
2551 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2552 const tchar *dest_dir)
2554 for (size_t i = 0; i < num_cmds; i++)
2555 if (cmds[i].fs_dest_path != dest_dir)
2556 free(cmds[i].fs_dest_path);
2560 static struct wimlib_extract_command *
2561 prepare_extract_commands(tchar **paths, unsigned num_paths,
2562 int extract_flags, tchar *dest_dir,
2563 size_t *num_cmds_ret)
2565 struct wimlib_extract_command *cmds;
2567 tchar *emptystr = T("");
2569 if (num_paths == 0) {
2573 num_cmds = num_paths;
2574 cmds = calloc(num_cmds, sizeof(cmds[0]));
2576 imagex_error(T("Out of memory!"));
2580 for (size_t i = 0; i < num_cmds; i++) {
2581 cmds[i].extract_flags = extract_flags;
2582 cmds[i].wim_source_path = paths[i];
2583 if (is_root_wim_path(paths[i])) {
2584 cmds[i].fs_dest_path = dest_dir;
2586 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2587 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2588 if (!cmds[i].fs_dest_path) {
2589 free_extract_commands(cmds, num_cmds, dest_dir);
2592 tsprintf(cmds[i].fs_dest_path,
2593 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2594 dest_dir, tbasename(paths[i]));
2597 *num_cmds_ret = num_cmds;
2601 /* Extract files or directories from a WIM image */
2603 imagex_extract(int argc, tchar **argv, int cmd)
2610 const tchar *wimfile;
2611 const tchar *image_num_or_name;
2612 tchar *dest_dir = T(".");
2613 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2615 STRING_SET(refglobs);
2617 struct wimlib_extract_command *cmds;
2620 for_opt(c, extract_options) {
2622 case IMAGEX_CHECK_OPTION:
2623 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2625 case IMAGEX_VERBOSE_OPTION:
2626 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2628 case IMAGEX_REF_OPTION:
2629 ret = string_set_append(&refglobs, optarg);
2631 goto out_free_refglobs;
2633 case IMAGEX_UNIX_DATA_OPTION:
2634 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2636 case IMAGEX_NO_ACLS_OPTION:
2637 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2639 case IMAGEX_STRICT_ACLS_OPTION:
2640 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2642 case IMAGEX_DEST_DIR_OPTION:
2645 case IMAGEX_TO_STDOUT_OPTION:
2646 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2647 imagex_info_file = stderr;
2648 imagex_be_quiet = true;
2650 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2651 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2652 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2665 image_num_or_name = argv[1];
2670 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2675 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2679 image = wimlib_resolve_image(wim, image_num_or_name);
2680 ret = verify_image_exists_and_is_single(image,
2684 goto out_wimlib_free;
2686 if (refglobs.num_strings) {
2687 ret = wim_reference_globs(wim, &refglobs, open_flags);
2689 goto out_wimlib_free;
2692 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2693 imagex_progress_func);
2695 if (!imagex_be_quiet)
2696 imagex_printf(T("Done extracting files.\n"));
2697 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2698 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2699 "files and directories\n"
2700 " are in the WIM image.\n"),
2701 get_cmd_string(CMD_INFO, false));
2702 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2703 struct wimlib_wim_info info;
2705 wimlib_get_wim_info(wim, &info);
2706 do_resource_not_found_warning(wimfile, &info, &refglobs);
2711 free_extract_commands(cmds, num_cmds, dest_dir);
2713 string_set_destroy(&refglobs);
2717 usage(CMD_EXTRACT, stderr);
2720 goto out_free_refglobs;
2723 static void print_byte_field(const uint8_t field[], size_t len)
2726 tprintf(T("%02hhx"), *field++);
2730 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2732 tputs(T("WIM Information:"));
2733 tputs(T("----------------"));
2734 tprintf(T("Path: %"TS"\n"), wimfile);
2735 tprintf(T("GUID: 0x"));
2736 print_byte_field(info->guid, sizeof(info->guid));
2738 tprintf(T("Image Count: %d\n"), info->image_count);
2739 tprintf(T("Compression: %"TS"\n"),
2740 wimlib_get_compression_type_string(info->compression_type));
2741 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2742 tprintf(T("Boot Index: %d\n"), info->boot_index);
2743 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2744 tprintf(T("Integrity Info: %"TS"\n"),
2745 info->has_integrity_table ? T("yes") : T("no"));
2746 tprintf(T("Relative path junction: %"TS"\n"),
2747 info->has_rpfix ? T("yes") : T("no"));
2748 tprintf(T("Pipable: %"TS"\n"),
2749 info->pipable ? T("yes") : T("no"));
2754 print_resource(const struct wimlib_resource_entry *resource,
2758 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2759 resource->uncompressed_size);
2761 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2762 resource->compressed_size);
2764 tprintf(T("Offset = %"PRIu64" bytes\n"),
2768 tprintf(T("Part Number = %u\n"), resource->part_number);
2769 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2771 tprintf(T("Hash = 0x"));
2772 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2775 tprintf(T("Flags = "));
2776 if (resource->is_compressed)
2777 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2778 if (resource->is_metadata)
2779 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2780 if (resource->is_free)
2781 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2782 if (resource->is_spanned)
2783 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2790 print_lookup_table(WIMStruct *wim)
2792 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2795 /* Prints information about a WIM file; also can mark an image as bootable,
2796 * change the name of an image, or change the description of an image. */
2798 imagex_info(int argc, tchar **argv, int cmd)
2803 bool nocheck = false;
2804 bool header = false;
2805 bool lookup_table = false;
2807 bool metadata = false;
2808 bool short_header = true;
2809 const tchar *xml_out_file = NULL;
2810 const tchar *wimfile;
2811 const tchar *image_num_or_name;
2812 const tchar *new_name;
2813 const tchar *new_desc;
2818 struct wimlib_wim_info info;
2820 for_opt(c, info_options) {
2822 case IMAGEX_BOOT_OPTION:
2825 case IMAGEX_CHECK_OPTION:
2828 case IMAGEX_NOCHECK_OPTION:
2831 case IMAGEX_HEADER_OPTION:
2833 short_header = false;
2835 case IMAGEX_LOOKUP_TABLE_OPTION:
2836 lookup_table = true;
2837 short_header = false;
2839 case IMAGEX_XML_OPTION:
2841 short_header = false;
2843 case IMAGEX_EXTRACT_XML_OPTION:
2844 xml_out_file = optarg;
2845 short_header = false;
2847 case IMAGEX_METADATA_OPTION:
2849 short_header = false;
2858 if (argc < 1 || argc > 4)
2862 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2863 new_name = (argc >= 3) ? argv[2] : NULL;
2864 new_desc = (argc >= 4) ? argv[3] : NULL;
2866 if (check && nocheck) {
2867 imagex_error(T("Can't specify both --check and --nocheck"));
2872 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2874 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2878 wimlib_get_wim_info(wim, &info);
2880 image = wimlib_resolve_image(wim, image_num_or_name);
2881 ret = WIMLIB_ERR_INVALID_IMAGE;
2882 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2883 verify_image_exists(image, image_num_or_name, wimfile);
2885 imagex_error(T("If you would like to set the boot "
2886 "index to 0, specify image \"0\" with "
2887 "the --boot flag."));
2889 goto out_wimlib_free;
2892 if (boot && info.image_count == 0) {
2893 imagex_error(T("--boot is meaningless on a WIM with no images"));
2894 goto out_wimlib_free;
2897 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2899 imagex_error(T("Cannot specify the --boot flag "
2900 "without specifying a specific "
2901 "image in a multi-image WIM"));
2902 goto out_wimlib_free;
2905 imagex_error(T("Cannot specify the NEW_NAME "
2906 "without specifying a specific "
2907 "image in a multi-image WIM"));
2908 goto out_wimlib_free;
2912 /* Operations that print information are separated from operations that
2913 * recreate the WIM file. */
2914 if (!new_name && !boot) {
2916 /* Read-only operations */
2918 if (image == WIMLIB_NO_IMAGE) {
2919 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2920 image_num_or_name, wimfile);
2921 goto out_wimlib_free;
2924 if (image == WIMLIB_ALL_IMAGES && short_header)
2925 print_wim_information(wimfile, &info);
2928 wimlib_print_header(wim);
2931 if (info.total_parts != 1) {
2932 tfprintf(stderr, T("Warning: Only showing the lookup table "
2933 "for part %d of a %d-part WIM.\n"),
2934 info.part_number, info.total_parts);
2936 print_lookup_table(wim);
2940 ret = wimlib_extract_xml_data(wim, stdout);
2942 goto out_wimlib_free;
2948 fp = tfopen(xml_out_file, T("wb"));
2950 imagex_error_with_errno(T("Failed to open the "
2951 "file \"%"TS"\" for "
2955 goto out_wimlib_free;
2957 ret = wimlib_extract_xml_data(wim, fp);
2959 imagex_error(T("Failed to close the file "
2965 goto out_wimlib_free;
2969 wimlib_print_available_images(wim, image);
2972 ret = wimlib_print_metadata(wim, image);
2974 goto out_wimlib_free;
2979 /* Modification operations */
2981 if (image == WIMLIB_ALL_IMAGES)
2984 if (image == WIMLIB_NO_IMAGE && new_name) {
2985 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2986 "when using image 0"), new_name);
2988 goto out_wimlib_free;
2992 if (image == info.boot_index) {
2993 imagex_printf(T("Image %d is already marked as "
2994 "bootable.\n"), image);
2997 imagex_printf(T("Marking image %d as bootable.\n"),
2999 info.boot_index = image;
3000 ret = wimlib_set_wim_info(wim, &info,
3001 WIMLIB_CHANGE_BOOT_INDEX);
3003 goto out_wimlib_free;
3007 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3009 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3013 imagex_printf(T("Changing the name of image %d to "
3014 "\"%"TS"\".\n"), image, new_name);
3015 ret = wimlib_set_image_name(wim, image, new_name);
3017 goto out_wimlib_free;
3021 const tchar *old_desc;
3022 old_desc = wimlib_get_image_description(wim, image);
3023 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3024 imagex_printf(T("The description of image %d is already "
3025 "\"%"TS"\".\n"), image, new_desc);
3028 imagex_printf(T("Changing the description of image %d "
3029 "to \"%"TS"\".\n"), image, new_desc);
3030 ret = wimlib_set_image_descripton(wim, image,
3033 goto out_wimlib_free;
3037 /* Only call wimlib_overwrite() if something actually needs to
3039 if (boot || new_name || new_desc ||
3040 (check && !info.has_integrity_table) ||
3041 (nocheck && info.has_integrity_table))
3043 int write_flags = 0;
3046 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3048 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3049 ret = wimlib_overwrite(wim, write_flags, 1,
3050 imagex_progress_func);
3052 imagex_printf(T("The file \"%"TS"\" was not modified "
3053 "because nothing needed to be done.\n"),
3064 usage(CMD_INFO, stderr);
3070 /* Join split WIMs into one part WIM */
3072 imagex_join(int argc, tchar **argv, int cmd)
3075 int swm_open_flags = 0;
3076 int wim_write_flags = 0;
3077 const tchar *output_path;
3080 for_opt(c, join_options) {
3082 case IMAGEX_CHECK_OPTION:
3083 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3084 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3094 imagex_error(T("Must specify one or more split WIM (.swm) "
3098 output_path = argv[0];
3099 ret = wimlib_join((const tchar * const *)++argv,
3104 imagex_progress_func);
3109 usage(CMD_JOIN, stderr);
3114 #if WIM_MOUNTING_SUPPORTED
3116 /* Mounts a WIM image. */
3118 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3121 int mount_flags = 0;
3123 const tchar *staging_dir = NULL;
3124 const tchar *wimfile;
3127 struct wimlib_wim_info info;
3131 STRING_SET(refglobs);
3133 if (cmd == CMD_MOUNTRW) {
3134 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3135 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3138 for_opt(c, mount_options) {
3140 case IMAGEX_ALLOW_OTHER_OPTION:
3141 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3143 case IMAGEX_CHECK_OPTION:
3144 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3146 case IMAGEX_DEBUG_OPTION:
3147 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3149 case IMAGEX_STREAMS_INTERFACE_OPTION:
3150 if (!tstrcasecmp(optarg, T("none")))
3151 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3152 else if (!tstrcasecmp(optarg, T("xattr")))
3153 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3154 else if (!tstrcasecmp(optarg, T("windows")))
3155 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3157 imagex_error(T("Unknown stream interface \"%"TS"\""),
3162 case IMAGEX_REF_OPTION:
3163 ret = string_set_append(&refglobs, optarg);
3165 goto out_free_refglobs;
3167 case IMAGEX_STAGING_DIR_OPTION:
3168 staging_dir = optarg;
3170 case IMAGEX_UNIX_DATA_OPTION:
3171 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3179 if (argc != 2 && argc != 3)
3184 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3186 goto out_free_refglobs;
3188 wimlib_get_wim_info(wim, &info);
3191 /* Image explicitly specified. */
3192 image = wimlib_resolve_image(wim, argv[1]);
3194 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3198 /* No image specified; default to image 1, but only if the WIM
3199 * contains exactly one image. */
3201 if (info.image_count != 1) {
3202 imagex_error(T("\"%"TS"\" contains %d images; Please "
3203 "select one."), wimfile, info.image_count);
3211 if (refglobs.num_strings) {
3212 ret = wim_reference_globs(wim, &refglobs, open_flags);
3217 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3219 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3221 image, wimfile, dir);
3226 string_set_destroy(&refglobs);
3232 goto out_free_refglobs;
3234 #endif /* WIM_MOUNTING_SUPPORTED */
3236 /* Rebuild a WIM file */
3238 imagex_optimize(int argc, tchar **argv, int cmd)
3241 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3242 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3245 const tchar *wimfile;
3248 unsigned num_threads = 0;
3250 for_opt(c, optimize_options) {
3252 case IMAGEX_CHECK_OPTION:
3253 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3254 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3256 case IMAGEX_NOCHECK_OPTION:
3257 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3259 case IMAGEX_RECOMPRESS_OPTION:
3260 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3262 case IMAGEX_COMPRESS_SLOW_OPTION:
3263 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3264 set_compress_slow();
3266 case IMAGEX_THREADS_OPTION:
3267 num_threads = parse_num_threads(optarg);
3268 if (num_threads == UINT_MAX)
3271 case IMAGEX_PIPABLE_OPTION:
3272 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3274 case IMAGEX_NOT_PIPABLE_OPTION:
3275 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3289 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3293 old_size = file_get_size(wimfile);
3294 tprintf(T("\"%"TS"\" original size: "), wimfile);
3296 tputs(T("Unknown"));
3298 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3300 ret = wimlib_overwrite(wim, write_flags, num_threads,
3301 imagex_progress_func);
3303 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3304 goto out_wimlib_free;
3307 new_size = file_get_size(wimfile);
3308 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3310 tputs(T("Unknown"));
3312 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3314 tfputs(T("Space saved: "), stdout);
3315 if (new_size != -1 && old_size != -1) {
3316 tprintf(T("%lld KiB\n"),
3317 ((long long)old_size - (long long)new_size) >> 10);
3319 tputs(T("Unknown"));
3328 usage(CMD_OPTIMIZE, stderr);
3334 /* Split a WIM into a spanned set */
3336 imagex_split(int argc, tchar **argv, int cmd)
3340 int write_flags = 0;
3341 unsigned long part_size;
3346 for_opt(c, split_options) {
3348 case IMAGEX_CHECK_OPTION:
3349 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3350 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3362 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3363 if (tmp == argv[2] || *tmp) {
3364 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3365 imagex_error(T("The part size must be an integer or "
3366 "floating-point number of megabytes."));
3369 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3373 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3379 usage(CMD_SPLIT, stderr);
3385 #if WIM_MOUNTING_SUPPORTED
3386 /* Unmounts a mounted WIM image. */
3388 imagex_unmount(int argc, tchar **argv, int cmd)
3391 int unmount_flags = 0;
3394 for_opt(c, unmount_options) {
3396 case IMAGEX_COMMIT_OPTION:
3397 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3399 case IMAGEX_CHECK_OPTION:
3400 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3402 case IMAGEX_REBUILD_OPTION:
3403 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3405 case IMAGEX_LAZY_OPTION:
3406 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3417 ret = wimlib_unmount_image(argv[0], unmount_flags,
3418 imagex_progress_func);
3420 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3425 usage(CMD_UNMOUNT, stderr);
3429 #endif /* WIM_MOUNTING_SUPPORTED */
3432 * Add, delete, or rename files in a WIM image.
3435 imagex_update(int argc, tchar **argv, int cmd)
3437 const tchar *wimfile;
3441 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3442 int write_flags = 0;
3443 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3444 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
3445 int default_delete_flags = 0;
3446 unsigned num_threads = 0;
3448 tchar *cmd_file_contents;
3449 size_t cmd_file_nchars;
3450 struct wimlib_update_command *cmds;
3452 tchar *command_str = NULL;
3454 const tchar *config_file = NULL;
3456 struct wimlib_capture_config *config;
3458 for_opt(c, update_options) {
3460 /* Generic or write options */
3461 case IMAGEX_THREADS_OPTION:
3462 num_threads = parse_num_threads(optarg);
3463 if (num_threads == UINT_MAX)
3466 case IMAGEX_CHECK_OPTION:
3467 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3468 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3470 case IMAGEX_REBUILD_OPTION:
3471 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3473 case IMAGEX_COMMAND_OPTION:
3475 imagex_error(T("--command may only be specified "
3476 "one time. Please provide\n"
3477 " the update commands "
3478 "on standard input instead."));
3481 command_str = tstrdup(optarg);
3483 imagex_error(T("Out of memory!"));
3487 /* Default delete options */
3488 case IMAGEX_FORCE_OPTION:
3489 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3491 case IMAGEX_RECURSIVE_OPTION:
3492 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3495 /* Global add option */
3496 case IMAGEX_CONFIG_OPTION:
3497 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3498 config_file = optarg;
3501 /* Default add options */
3502 case IMAGEX_VERBOSE_OPTION:
3503 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3505 case IMAGEX_DEREFERENCE_OPTION:
3506 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3508 case IMAGEX_UNIX_DATA_OPTION:
3509 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3511 case IMAGEX_NO_ACLS_OPTION:
3512 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3514 case IMAGEX_STRICT_ACLS_OPTION:
3515 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3524 if (argc != 1 && argc != 2)
3528 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3530 goto out_free_command_str;
3533 /* Image explicitly specified. */
3534 image = wimlib_resolve_image(wim, argv[1]);
3535 ret = verify_image_exists_and_is_single(image, argv[1],
3538 goto out_wimlib_free;
3540 /* No image specified; default to image 1, but only if the WIM
3541 * contains exactly one image. */
3542 struct wimlib_wim_info info;
3544 wimlib_get_wim_info(wim, &info);
3545 if (info.image_count != 1) {
3546 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3547 wimfile, info.image_count);
3554 /* Parse capture configuration file if specified */
3558 config_str = file_get_text_contents(config_file, &config_len);
3561 goto out_wimlib_free;
3564 config = alloca(sizeof(*config));
3565 ret = parse_capture_config(&config_str, config_len, config);
3567 goto out_free_config;
3570 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3573 /* Read update commands from standard input, or the command string if
3576 cmd_file_contents = NULL;
3577 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3580 if (isatty(STDIN_FILENO)) {
3581 tputs(T("Reading update commands from standard input..."));
3582 recommend_man_page(CMD_UPDATE, stdout);
3584 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3585 if (!cmd_file_contents) {
3587 goto out_free_config;
3590 /* Parse the update commands */
3591 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3596 goto out_free_cmd_file_contents;
3599 /* Set default flags and capture config on the update commands */
3600 for (size_t i = 0; i < num_cmds; i++) {
3601 switch (cmds[i].op) {
3602 case WIMLIB_UPDATE_OP_ADD:
3603 cmds[i].add.add_flags |= default_add_flags;
3604 cmds[i].add.config = config;
3606 case WIMLIB_UPDATE_OP_DELETE:
3607 cmds[i].delete_.delete_flags |= default_delete_flags;
3614 /* Execute the update commands */
3615 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3616 imagex_progress_func);
3620 /* Overwrite the updated WIM */
3621 ret = wimlib_overwrite(wim, write_flags, num_threads,
3622 imagex_progress_func);
3625 out_free_cmd_file_contents:
3626 free(cmd_file_contents);
3629 free(config->exclusion_pats.pats);
3630 free(config->exclusion_exception_pats.pats);
3635 out_free_command_str:
3640 usage(CMD_UPDATE, stderr);
3643 goto out_free_command_str;
3648 struct imagex_command {
3650 int (*func)(int argc, tchar **argv, int cmd);
3653 static const struct imagex_command imagex_commands[] = {
3654 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3655 [CMD_APPLY] = {T("apply"), imagex_apply},
3656 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3657 [CMD_DELETE] = {T("delete"), imagex_delete},
3658 [CMD_DIR ] = {T("dir"), imagex_dir},
3659 [CMD_EXPORT] = {T("export"), imagex_export},
3660 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3661 [CMD_INFO] = {T("info"), imagex_info},
3662 [CMD_JOIN] = {T("join"), imagex_join},
3663 #if WIM_MOUNTING_SUPPORTED
3664 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3665 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3667 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3668 [CMD_SPLIT] = {T("split"), imagex_split},
3669 #if WIM_MOUNTING_SUPPORTED
3670 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3672 [CMD_UPDATE] = {T("update"), imagex_update},
3675 static const tchar *usage_strings[] = {
3678 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3679 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3680 " [--check] [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3681 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3682 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3683 " [--norpfix] [--unix-data] [--pipable]\n"
3684 " [--update-of=[WIMFILE:]IMAGE]\n"
3688 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3689 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3690 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3691 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3692 " [--include-invalid-names]\n"
3696 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3697 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3698 " [--check] [--nocheck] [--compress=TYPE]\n"
3699 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
3700 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3701 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3702 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3703 " [--delta-from=WIMFILE]\n"
3707 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3712 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3716 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3717 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3718 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3719 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3720 " [--pipable] [--not-pipable]\n"
3724 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3725 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3726 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3727 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3731 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3732 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3733 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3738 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3740 #if WIM_MOUNTING_SUPPORTED
3743 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3744 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3745 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3749 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3750 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3751 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3756 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3757 " [--recompress-slow] [--threads=NUM_THREADS] [--pipable]\n"
3758 " [--not-pipable]\n"
3762 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3764 #if WIM_MOUNTING_SUPPORTED
3767 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3772 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3773 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3774 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3778 static const tchar *invocation_name;
3779 static int invocation_cmd = CMD_NONE;
3781 static const tchar *get_cmd_string(int cmd, bool nospace)
3783 static tchar buf[50];
3784 if (cmd == CMD_NONE) {
3785 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3786 } else if (invocation_cmd != CMD_NONE) {
3787 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3789 const tchar *format;
3792 format = T("%"TS"-%"TS"");
3794 format = T("%"TS" %"TS"");
3795 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3803 static const tchar *s =
3805 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3806 "Copyright (C) 2012, 2013 Eric Biggers\n"
3807 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3808 "This is free software: you are free to change and redistribute it.\n"
3809 "There is NO WARRANTY, to the extent permitted by law.\n"
3811 "Report bugs to "PACKAGE_BUGREPORT".\n"
3818 help_or_version(int argc, tchar **argv, int cmd)
3823 for (i = 1; i < argc; i++) {
3825 if (p[0] == T('-') && p[1] == T('-')) {
3827 if (!tstrcmp(p, T("help"))) {
3828 if (cmd == CMD_NONE)
3833 } else if (!tstrcmp(p, T("version"))) {
3842 print_usage_string(int cmd, FILE *fp)
3844 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3848 recommend_man_page(int cmd, FILE *fp)
3850 const tchar *format_str;
3852 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3854 format_str = T("Try `man %"TS"' for more details.\n");
3856 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3860 usage(int cmd, FILE *fp)
3862 tfprintf(fp, T("Usage:\n"));
3863 print_usage_string(cmd, fp);
3864 tfprintf(fp, T("\n"));
3865 recommend_man_page(cmd, fp);
3871 tfprintf(fp, T("Usage:\n"));
3872 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3873 print_usage_string(cmd, fp);
3874 tfprintf(fp, T("\n"));
3876 static const tchar *extra =
3879 " %"TS" --version\n"
3881 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3884 tfprintf(fp, extra, invocation_name, invocation_name);
3885 recommend_man_page(CMD_NONE, fp);
3888 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3889 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3890 * something else), while an Windows the command arguments will be UTF-16LE
3891 * encoded 'wchar_t' strings. */
3894 wmain(int argc, wchar_t **argv, wchar_t **envp)
3896 main(int argc, char **argv)
3903 imagex_info_file = stdout;
3904 invocation_name = tbasename(argv[0]);
3907 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3908 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3912 setlocale(LC_ALL, "");
3913 codeset = nl_langinfo(CODESET);
3914 if (!strstr(codeset, "UTF-8") &&
3915 !strstr(codeset, "UTF8") &&
3916 !strstr(codeset, "utf-8") &&
3917 !strstr(codeset, "utf8"))
3920 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3921 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3922 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3923 " to any value to force wimlib to use UTF-8.\n",
3928 #endif /* !__WIN32__ */
3930 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3932 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3933 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3934 for (int i = 0; i < CMD_MAX; i++) {
3935 if (!tstrcmp(invocation_name + 3,
3936 imagex_commands[i].name))
3945 /* Unless already known from the invocation name, determine which
3946 * command was specified. */
3947 if (cmd == CMD_NONE) {
3949 imagex_error(T("No command specified!\n"));
3953 for (int i = 0; i < CMD_MAX; i++) {
3954 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3959 if (cmd != CMD_NONE) {
3965 /* Handle --help and --version. --help can be either for the program as
3966 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3967 * CMD_NONE). Note: help_or_version() will not return if a --help or
3968 * --version argument was found. */
3969 help_or_version(argc, argv, cmd);
3971 /* Bail if a valid command was not specified. */
3972 if (cmd == CMD_NONE) {
3973 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3978 /* Enable warning and error messages in wimlib be more user-friendly.
3980 wimlib_set_print_errors(true);
3982 /* Initialize wimlib. */
3983 ret = wimlib_global_init(init_flags);
3985 goto out_check_status;
3987 /* Call the command handler function. */
3988 ret = imagex_commands[cmd].func(argc, argv, cmd);
3990 /* Check for error writing to standard output, especially since for some
3991 * commands, writing to standard output is part of the program's actual
3992 * behavior and not just for informational purposes. */
3993 if (ferror(stdout) || fclose(stdout)) {
3994 imagex_error_with_errno(T("error writing to standard output"));
3999 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4000 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4001 * error code from which an error message can be printed. */
4003 imagex_error(T("Exiting with error code %d:\n"
4005 wimlib_get_error_string(ret));
4006 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4007 imagex_error_with_errno(T("errno"));
4009 /* Make wimlib free any resources it's holding (although this is not
4010 * strictly necessary because the process is ending anyway). */
4011 wimlib_global_cleanup();