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("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
286 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
287 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
288 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
289 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
290 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
291 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
295 static const struct option split_options[] = {
296 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
300 static const struct option unmount_options[] = {
301 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
302 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
303 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
304 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
308 static const struct option update_options[] = {
309 /* Careful: some of the options here set the defaults for update
310 * commands, but the flags given to an actual update command (and not to
311 * `imagex update' itself are also handled in
312 * update_command_add_option(). */
313 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
314 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
315 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
316 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
318 /* Default delete options */
319 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
320 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
322 /* Global add option */
323 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
325 /* Default add options */
326 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
327 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
328 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
329 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
330 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
331 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
337 # define _format_attribute(type, format_str, args_start) \
338 __attribute__((format(type, format_str, args_start)))
340 # define _format_attribute(type, format_str, args_start)
343 /* Print formatted error message to stderr. */
344 static void _format_attribute(printf, 1, 2)
345 imagex_error(const tchar *format, ...)
348 va_start(va, format);
349 tfputs(T("ERROR: "), stderr);
350 tvfprintf(stderr, format, va);
351 tputc(T('\n'), stderr);
355 /* Print formatted error message to stderr. */
356 static void _format_attribute(printf, 1, 2)
357 imagex_error_with_errno(const tchar *format, ...)
359 int errno_save = errno;
361 va_start(va, format);
362 tfputs(T("ERROR: "), stderr);
363 tvfprintf(stderr, format, va);
364 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
369 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
371 if (image == WIMLIB_NO_IMAGE) {
372 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
373 " Please specify a 1-based image index or "
374 "image name. To list the images\n"
375 " contained in the WIM archive, run\n"
377 " %"TS" \"%"TS"\"\n"),
378 image_name, wim_name,
379 get_cmd_string(CMD_INFO, false), wim_name);
380 return WIMLIB_ERR_INVALID_IMAGE;
386 verify_image_is_single(int image)
388 if (image == WIMLIB_ALL_IMAGES) {
389 imagex_error(T("Cannot specify all images for this action!"));
390 return WIMLIB_ERR_INVALID_IMAGE;
396 verify_image_exists_and_is_single(int image, const tchar *image_name,
397 const tchar *wim_name)
400 ret = verify_image_exists(image, image_name, wim_name);
402 ret = verify_image_is_single(image);
406 /* Parse the argument to --compress */
408 get_compression_type(const tchar *optarg)
410 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
411 return WIMLIB_COMPRESSION_TYPE_LZX;
412 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
413 return WIMLIB_COMPRESSION_TYPE_XPRESS;
414 else if (!tstrcasecmp(optarg, T("none")))
415 return WIMLIB_COMPRESSION_TYPE_NONE;
417 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
418 "\"maximum\", \"fast\", or \"none\"."), optarg);
419 return WIMLIB_COMPRESSION_TYPE_INVALID;
424 set_compress_slow(void)
427 static const struct wimlib_lzx_params slow_params = {
428 .size_of_this = sizeof(struct wimlib_lzx_params),
429 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
432 .use_len2_matches = 1,
433 .num_fast_bytes = 96,
434 .num_optim_passes = 4,
435 .max_search_depth = 100,
436 .max_matches_per_pos = 10,
437 .main_nostat_cost = 15,
438 .len_nostat_cost = 15,
439 .aligned_nostat_cost = 7,
443 ret = wimlib_lzx_set_default_params(&slow_params);
445 imagex_error(T("Couldn't set slow compression parameters.!"));
450 const tchar **strings;
451 unsigned num_strings;
452 unsigned num_alloc_strings;
455 #define STRING_SET_INITIALIZER \
456 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
458 #define STRING_SET(_strings) \
459 struct string_set _strings = STRING_SET_INITIALIZER
462 string_set_append(struct string_set *set, const tchar *glob)
464 unsigned num_alloc_strings = set->num_alloc_strings;
466 if (set->num_strings == num_alloc_strings) {
467 const tchar **new_strings;
469 num_alloc_strings += 4;
470 new_strings = realloc(set->strings,
471 sizeof(set->strings[0]) * num_alloc_strings);
473 imagex_error(T("Out of memory!"));
476 set->strings = new_strings;
477 set->num_alloc_strings = num_alloc_strings;
479 set->strings[set->num_strings++] = glob;
484 string_set_destroy(struct string_set *set)
490 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
492 return wimlib_reference_resource_files(wim, set->strings,
494 WIMLIB_REF_FLAG_GLOB_ENABLE,
496 imagex_progress_func);
500 do_resource_not_found_warning(const tchar *wimfile,
501 const struct wimlib_wim_info *info,
502 const struct string_set *refglobs)
504 if (info->total_parts > 1) {
505 if (refglobs->num_strings == 0) {
506 imagex_error(T("\"%"TS"\" is part of a split WIM. "
507 "Use --ref to specify the other parts."),
510 imagex_error(T("Perhaps the '--ref' argument did not "
511 "specify all other parts of the split "
515 imagex_error(T("If this is a delta WIM, use the --ref argument "
516 "to specify the WIM(s) on which it is based."));
520 /* Returns the size of a file given its name, or -1 if the file does not exist
521 * or its size cannot be determined. */
523 file_get_size(const tchar *filename)
526 if (tstat(filename, &st) == 0)
533 PARSE_STRING_SUCCESS = 0,
534 PARSE_STRING_FAILURE = 1,
535 PARSE_STRING_NONE = 2,
539 * Parses a string token from an array of characters.
541 * Tokens are either whitespace-delimited, or double or single-quoted.
543 * @line_p: Pointer to the pointer to the line of data. Will be updated
544 * to point past the string token iff the return value is
545 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
548 * @len_p: @len_p initially stores the length of the line of data, which may
549 * be 0, and it will be updated to the number of bytes remaining in
550 * the line iff the return value is PARSE_STRING_SUCCESS.
552 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
553 * parsed string token will be returned here.
555 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
556 * PARSE_STRING_FAILURE if the data was invalid due to a missing
557 * closing quote; or PARSE_STRING_NONE if the line ended before the
558 * beginning of a string token was found.
561 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
564 tchar *line = *line_p;
568 /* Skip leading whitespace */
571 return PARSE_STRING_NONE;
572 if (!istspace(*line) && *line != T('\0'))
578 if (quote_char == T('"') || quote_char == T('\'')) {
583 line = tmemchr(line, quote_char, len);
585 imagex_error(T("Missing closing quote: %"TS), fn - 1);
586 return PARSE_STRING_FAILURE;
589 /* Unquoted string. Go until whitespace. Line is terminated
590 * by '\0', so no need to check 'len'. */
594 } while (!istspace(*line) && *line != T('\0'));
601 return PARSE_STRING_SUCCESS;
604 /* Parses a line of data (not an empty line or comment) in the source list file
605 * format. (See the man page for 'wimlib-imagex capture' for details on this
606 * format and the meaning.)
608 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
609 * len == 0. The data in @line will be modified by this function call.
611 * @len: Length of the line of data.
613 * @source: On success, the capture source and target described by the line is
614 * written into this destination. Note that it will contain pointers
615 * to data in the @line array.
617 * Returns true if the line was valid; false otherwise. */
619 parse_source_list_line(tchar *line, size_t len,
620 struct wimlib_capture_source *source)
624 ret = parse_string(&line, &len, &source->fs_source_path);
625 if (ret != PARSE_STRING_SUCCESS)
627 ret = parse_string(&line, &len, &source->wim_target_path);
628 if (ret == PARSE_STRING_NONE)
629 source->wim_target_path = source->fs_source_path;
630 return ret != PARSE_STRING_FAILURE;
633 /* Returns %true if the given line of length @len > 0 is a comment or empty line
634 * in the source list file format. */
636 is_comment_line(const tchar *line, size_t len)
641 if (!istspace(*line) && *line != T('\0'))
651 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
654 tchar *contents = *contents_p;
655 size_t nchars = *nchars_p;
658 for (i = 0; i < nchars; i++)
659 if (contents[i] == T('\n'))
662 /* Handle last line not terminated by a newline */
663 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
664 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
666 imagex_error(T("Out of memory!"));
669 contents[nchars] = T('\n');
670 *contents_p = contents;
678 /* Parses a file in the source list format. (See the man page for
679 * 'wimlib-imagex capture' for details on this format and the meaning.)
681 * @source_list_contents: Contents of the source list file. Note that this
682 * buffer will be modified to save memory allocations,
683 * and cannot be freed until the returned array of
684 * wimlib_capture_source's has also been freed.
686 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
689 * @nsources_ret: On success, the length of the returned array is
692 * Returns: An array of `struct wimlib_capture_source's that can be passed to
693 * the wimlib_add_image_multisource() function to specify how a WIM image is to
695 static struct wimlib_capture_source *
696 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
697 size_t *nsources_ret)
701 struct wimlib_capture_source *sources;
704 nlines = text_file_count_lines(source_list_contents_p,
705 &source_list_nchars);
709 /* Always allocate at least 1 slot, just in case the implementation of
710 * calloc() returns NULL if 0 bytes are requested. */
711 sources = calloc(nlines ?: 1, sizeof(*sources));
713 imagex_error(T("out of memory"));
716 p = *source_list_contents_p;
718 for (i = 0; i < nlines; i++) {
719 /* XXX: Could use rawmemchr() here instead, but it may not be
720 * available on all platforms. */
721 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
722 size_t len = endp - p + 1;
724 if (!is_comment_line(p, len)) {
725 if (!parse_source_list_line(p, len, &sources[j++])) {
738 enum capture_config_section {
739 CAPTURE_CONFIG_NO_SECTION,
740 CAPTURE_CONFIG_EXCLUSION_SECTION,
741 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
742 CAPTURE_CONFIG_IGNORE_SECTION,
746 CAPTURE_CONFIG_INVALID_SECTION,
747 CAPTURE_CONFIG_CHANGED_SECTION,
748 CAPTURE_CONFIG_SAME_SECTION,
752 check_config_section(tchar *line, size_t len,
753 enum capture_config_section *cur_section)
755 while (istspace(*line))
759 return CAPTURE_CONFIG_SAME_SECTION;
762 tchar *endbrace = tstrrchr(line, T(']'));
764 return CAPTURE_CONFIG_SAME_SECTION;
766 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
767 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
768 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
769 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
770 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
771 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
772 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
773 "of capture config file\n"),
775 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
776 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
777 tfputs(T("WARNING: Ignoring [AlignmentList] section "
778 "of capture config file\n"),
781 imagex_error(T("Invalid capture config file section \"%"TS"\""),
783 return CAPTURE_CONFIG_INVALID_SECTION;
785 return CAPTURE_CONFIG_CHANGED_SECTION;
790 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
793 if (pat_list->num_pats == pat_list->num_allocated_pats) {
795 size_t num_allocated_pats = pat_list->num_pats + 8;
797 pats = realloc(pat_list->pats,
798 num_allocated_pats * sizeof(pat_list->pats[0]));
800 imagex_error(T("Out of memory!"));
803 pat_list->pats = pats;
804 pat_list->num_allocated_pats = num_allocated_pats;
806 pat_list->pats[pat_list->num_pats++] = pat;
811 parse_capture_config_line(tchar *line, size_t len,
812 enum capture_config_section *cur_section,
813 struct wimlib_capture_config *config)
818 ret = check_config_section(line, len, cur_section);
819 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
821 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
824 switch (*cur_section) {
825 case CAPTURE_CONFIG_NO_SECTION:
826 imagex_error(T("Line \"%"TS"\" is not in a section "
827 "(such as [ExclusionList]"), line);
829 case CAPTURE_CONFIG_EXCLUSION_SECTION:
830 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
832 return pattern_list_add_pattern(&config->exclusion_pats,
834 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
835 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
837 return pattern_list_add_pattern(&config->exclusion_exception_pats,
839 case CAPTURE_CONFIG_IGNORE_SECTION:
846 parse_capture_config(tchar **contents_p, size_t nchars,
847 struct wimlib_capture_config *config)
852 enum capture_config_section cur_section;
854 memset(config, 0, sizeof(*config));
856 nlines = text_file_count_lines(contents_p, &nchars);
860 cur_section = CAPTURE_CONFIG_NO_SECTION;
862 for (i = 0; i < nlines; i++) {
863 tchar *endp = tmemchr(p, T('\n'), nchars);
864 size_t len = endp - p + 1;
866 if (!is_comment_line(p, len))
867 if (!parse_capture_config_line(p, len, &cur_section, config))
875 /* Reads the contents of a file into memory. */
877 file_get_contents(const tchar *filename, size_t *len_ret)
884 if (tstat(filename, &stbuf) != 0) {
885 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
890 fp = tfopen(filename, T("rb"));
892 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
896 buf = malloc(len ? len : 1);
898 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
899 "contents of file \"%"TS"\""), len, filename);
902 if (fread(buf, 1, len, fp) != len) {
903 imagex_error_with_errno(T("Failed to read %zu bytes from the "
904 "file \"%"TS"\""), len, filename);
918 /* Read standard input until EOF and return the full contents in a malloc()ed
919 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
922 stdin_get_contents(size_t *len_ret)
924 /* stdin can, of course, be a pipe or other non-seekable file, so the
925 * total length of the data cannot be pre-determined */
927 size_t newlen = 1024;
931 char *p = realloc(buf, newlen);
932 size_t bytes_read, bytes_to_read;
934 imagex_error(T("out of memory while reading stdin"));
938 bytes_to_read = newlen - pos;
939 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
941 if (bytes_read != bytes_to_read) {
946 imagex_error_with_errno(T("error reading stdin"));
960 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
963 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
965 *num_tchars_ret = num_bytes;
967 #else /* !__WIN32__ */
968 /* On Windows, translate the text to UTF-16LE */
972 if (num_bytes >= 2 &&
973 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
974 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
976 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
977 * with something that looks like an ASCII character encoded as
978 * a UTF-16LE code unit. Assume the file is encoded as
979 * UTF-16LE. This is not a 100% reliable check. */
980 num_wchars = num_bytes / 2;
981 text_wstr = (wchar_t*)text;
983 /* File does not look like UTF-16LE. Assume it is encoded in
984 * the current Windows code page. I think these are always
985 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
986 * should work as expected. */
987 text_wstr = win32_mbs_to_wcs(text,
992 *num_tchars_ret = num_wchars;
994 #endif /* __WIN32__ */
998 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1003 contents = file_get_contents(filename, &num_bytes);
1006 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1010 stdin_get_text_contents(size_t *num_tchars_ret)
1015 contents = stdin_get_contents(&num_bytes);
1018 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1021 #define TO_PERCENT(numerator, denominator) \
1022 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1024 /* Given an enumerated value for WIM compression type, return a descriptive
1026 static const tchar *
1027 get_data_type(int ctype)
1030 case WIMLIB_COMPRESSION_TYPE_NONE:
1031 return T("uncompressed");
1032 case WIMLIB_COMPRESSION_TYPE_LZX:
1033 return T("LZX-compressed");
1034 case WIMLIB_COMPRESSION_TYPE_XPRESS:
1035 return T("XPRESS-compressed");
1040 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1041 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1042 #define KIBIBYTE_MIN_NBYTES 10000ULL
1045 get_unit(uint64_t total_bytes, const tchar **name_ret)
1047 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1048 *name_ret = T("GiB");
1050 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1051 *name_ret = T("MiB");
1053 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1054 *name_ret = T("KiB");
1057 *name_ret = T("bytes");
1062 /* Progress callback function passed to various wimlib functions. */
1064 imagex_progress_func(enum wimlib_progress_msg msg,
1065 const union wimlib_progress_info *info)
1067 unsigned percent_done;
1068 unsigned unit_shift;
1069 const tchar *unit_name;
1070 if (imagex_be_quiet)
1073 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1074 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1075 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1076 info->write_streams.total_bytes);
1078 if (info->write_streams.completed_streams == 0) {
1079 const tchar *data_type;
1081 data_type = get_data_type(info->write_streams.compression_type);
1082 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
1083 data_type, info->write_streams.num_threads,
1084 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1086 if (info->write_streams.total_parts <= 1) {
1087 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1088 "written (%u%% done)"),
1089 info->write_streams.completed_bytes >> unit_shift,
1091 info->write_streams.total_bytes >> unit_shift,
1095 imagex_printf(T("\rWriting resources from part %u of %u: "
1096 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1097 (info->write_streams.completed_parts ==
1098 info->write_streams.total_parts) ?
1099 info->write_streams.completed_parts :
1100 info->write_streams.completed_parts + 1,
1101 info->write_streams.total_parts,
1102 info->write_streams.completed_bytes >> unit_shift,
1104 info->write_streams.total_bytes >> unit_shift,
1108 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1109 imagex_printf(T("\n"));
1111 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1112 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1113 if (*info->scan.wim_target_path) {
1114 imagex_printf(T(" (loading as WIM path: "
1115 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1116 info->scan.wim_target_path);
1118 imagex_printf(T(" (loading as root of WIM image)...\n"));
1121 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1122 switch (info->scan.status) {
1123 case WIMLIB_SCAN_DENTRY_OK:
1124 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1126 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1127 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1129 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1130 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1131 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1135 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1136 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1137 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1138 info->integrity.total_bytes);
1139 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1140 "of %"PRIu64" %"TS" (%u%%) done"),
1141 info->integrity.filename,
1142 info->integrity.completed_bytes >> unit_shift,
1144 info->integrity.total_bytes >> unit_shift,
1147 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1148 imagex_printf(T("\n"));
1150 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1151 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1152 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1153 info->integrity.total_bytes);
1154 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1155 "of %"PRIu64" %"TS" (%u%%) done"),
1156 info->integrity.completed_bytes >> unit_shift,
1158 info->integrity.total_bytes >> unit_shift,
1161 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1162 imagex_printf(T("\n"));
1164 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1165 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1166 "to %"TS" \"%"TS"\"\n"),
1167 info->extract.image,
1168 info->extract.image_name,
1169 info->extract.wimfile_name,
1170 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1171 T("NTFS volume") : T("directory")),
1172 info->extract.target);
1174 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1175 imagex_printf(T("Extracting "
1176 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1177 "in \"%"TS"\" to \"%"TS"\"\n"),
1178 info->extract.extract_root_wim_source_path,
1179 info->extract.image,
1180 info->extract.image_name,
1181 info->extract.wimfile_name,
1182 info->extract.target);
1184 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1185 percent_done = TO_PERCENT(info->extract.completed_bytes,
1186 info->extract.total_bytes);
1187 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1188 imagex_printf(T("\rExtracting files: "
1189 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1190 info->extract.completed_bytes >> unit_shift,
1192 info->extract.total_bytes >> unit_shift,
1195 if (info->extract.completed_bytes >= info->extract.total_bytes)
1196 imagex_printf(T("\n"));
1198 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1199 if (info->extract.total_parts != 1) {
1200 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1201 info->extract.part_number,
1202 info->extract.total_parts);
1205 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1206 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1207 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1209 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1210 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1211 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1212 info->extract.target);
1215 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1216 percent_done = TO_PERCENT(info->split.completed_bytes,
1217 info->split.total_bytes);
1218 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1219 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1220 "%"PRIu64" %"TS" (%u%%) written\n"),
1221 info->split.part_name,
1222 info->split.cur_part_number,
1223 info->split.total_parts,
1224 info->split.completed_bytes >> unit_shift,
1226 info->split.total_bytes >> unit_shift,
1230 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1231 if (info->split.completed_bytes == info->split.total_bytes) {
1232 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1233 info->split.cur_part_number,
1234 info->split.total_parts);
1237 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1238 switch (info->update.command->op) {
1239 case WIMLIB_UPDATE_OP_DELETE:
1240 imagex_printf(T("Deleted WIM path "
1241 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1242 info->update.command->delete_.wim_path);
1244 case WIMLIB_UPDATE_OP_RENAME:
1245 imagex_printf(T("Renamed WIM path "
1246 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1247 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1248 info->update.command->rename.wim_source_path,
1249 info->update.command->rename.wim_target_path);
1251 case WIMLIB_UPDATE_OP_ADD:
1259 fflush(imagex_info_file);
1264 parse_num_threads(const tchar *optarg)
1267 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1268 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1269 imagex_error(T("Number of threads must be a non-negative integer!"));
1277 * Parse an option passed to an update command.
1279 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1282 * @option: Text string for the option (beginning with --)
1284 * @cmd: `struct wimlib_update_command' that is being constructed for
1287 * Returns true if the option was recognized; false if not.
1290 update_command_add_option(int op, const tchar *option,
1291 struct wimlib_update_command *cmd)
1293 bool recognized = true;
1295 case WIMLIB_UPDATE_OP_ADD:
1296 if (!tstrcmp(option, T("--verbose")))
1297 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1298 else if (!tstrcmp(option, T("--unix-data")))
1299 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1300 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1301 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1302 else if (!tstrcmp(option, T("--strict-acls")))
1303 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1304 else if (!tstrcmp(option, T("--dereference")))
1305 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1309 case WIMLIB_UPDATE_OP_DELETE:
1310 if (!tstrcmp(option, T("--force")))
1311 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1312 else if (!tstrcmp(option, T("--recursive")))
1313 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1324 /* How many nonoption arguments each `imagex update' command expects */
1325 static const unsigned update_command_num_nonoptions[] = {
1326 [WIMLIB_UPDATE_OP_ADD] = 2,
1327 [WIMLIB_UPDATE_OP_DELETE] = 1,
1328 [WIMLIB_UPDATE_OP_RENAME] = 2,
1332 update_command_add_nonoption(int op, const tchar *nonoption,
1333 struct wimlib_update_command *cmd,
1334 unsigned num_nonoptions)
1337 case WIMLIB_UPDATE_OP_ADD:
1338 if (num_nonoptions == 0)
1339 cmd->add.fs_source_path = (tchar*)nonoption;
1341 cmd->add.wim_target_path = (tchar*)nonoption;
1343 case WIMLIB_UPDATE_OP_DELETE:
1344 cmd->delete_.wim_path = (tchar*)nonoption;
1346 case WIMLIB_UPDATE_OP_RENAME:
1347 if (num_nonoptions == 0)
1348 cmd->rename.wim_source_path = (tchar*)nonoption;
1350 cmd->rename.wim_target_path = (tchar*)nonoption;
1356 * Parse a command passed on stdin to `imagex update'.
1358 * @line: Text of the command.
1359 * @len: Length of the line, including a null terminator
1362 * @command: A `struct wimlib_update_command' to fill in from the parsed
1365 * @line_number: Line number of the command, for diagnostics.
1367 * Returns true on success; returns false on parse error.
1370 parse_update_command(tchar *line, size_t len,
1371 struct wimlib_update_command *command,
1375 tchar *command_name;
1377 size_t num_nonoptions;
1379 /* Get the command name ("add", "delete", "rename") */
1380 ret = parse_string(&line, &len, &command_name);
1381 if (ret != PARSE_STRING_SUCCESS)
1384 if (!tstrcasecmp(command_name, T("add"))) {
1385 op = WIMLIB_UPDATE_OP_ADD;
1386 } else if (!tstrcasecmp(command_name, T("delete"))) {
1387 op = WIMLIB_UPDATE_OP_DELETE;
1388 } else if (!tstrcasecmp(command_name, T("rename"))) {
1389 op = WIMLIB_UPDATE_OP_RENAME;
1391 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1392 command_name, line_number);
1397 /* Parse additional options and non-options as needed */
1402 ret = parse_string(&line, &len, &next_string);
1403 if (ret == PARSE_STRING_NONE) /* End of line */
1405 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1407 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1409 if (!update_command_add_option(op, next_string, command))
1411 imagex_error(T("Unrecognized option \"%"TS"\" to "
1412 "update command \"%"TS"\" on line %zu"),
1413 next_string, command_name, line_number);
1419 if (num_nonoptions == update_command_num_nonoptions[op])
1421 imagex_error(T("Unexpected argument \"%"TS"\" in "
1422 "update command on line %zu\n"
1423 " (The \"%"TS"\" command only "
1424 "takes %zu nonoption arguments!)\n"),
1425 next_string, line_number,
1426 command_name, num_nonoptions);
1429 update_command_add_nonoption(op, next_string,
1430 command, num_nonoptions);
1435 if (num_nonoptions != update_command_num_nonoptions[op]) {
1436 imagex_error(T("Not enough arguments to update command "
1437 "\"%"TS"\" on line %zu"), command_name, line_number);
1443 static struct wimlib_update_command *
1444 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1445 size_t *num_cmds_ret)
1449 struct wimlib_update_command *cmds;
1452 nlines = text_file_count_lines(cmd_file_contents_p,
1457 /* Always allocate at least 1 slot, just in case the implementation of
1458 * calloc() returns NULL if 0 bytes are requested. */
1459 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1461 imagex_error(T("out of memory"));
1464 p = *cmd_file_contents_p;
1466 for (i = 0; i < nlines; i++) {
1467 /* XXX: Could use rawmemchr() here instead, but it may not be
1468 * available on all platforms. */
1469 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1470 size_t len = endp - p + 1;
1472 if (!is_comment_line(p, len)) {
1473 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1484 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1485 * one image from a WIM file to a NTFS volume. */
1487 imagex_apply(int argc, tchar **argv, int cmd)
1491 int image = WIMLIB_NO_IMAGE;
1493 struct wimlib_wim_info info;
1495 const tchar *wimfile;
1496 const tchar *target;
1497 const tchar *image_num_or_name = NULL;
1498 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1500 STRING_SET(refglobs);
1502 for_opt(c, apply_options) {
1504 case IMAGEX_CHECK_OPTION:
1505 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1507 case IMAGEX_HARDLINK_OPTION:
1508 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1510 case IMAGEX_SYMLINK_OPTION:
1511 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1513 case IMAGEX_VERBOSE_OPTION:
1514 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1516 case IMAGEX_REF_OPTION:
1517 ret = string_set_append(&refglobs, optarg);
1519 goto out_free_refglobs;
1521 case IMAGEX_UNIX_DATA_OPTION:
1522 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1524 case IMAGEX_NO_ACLS_OPTION:
1525 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1527 case IMAGEX_STRICT_ACLS_OPTION:
1528 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1530 case IMAGEX_NORPFIX_OPTION:
1531 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1533 case IMAGEX_RPFIX_OPTION:
1534 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1536 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1537 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1538 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1540 case IMAGEX_RESUME_OPTION:
1541 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1549 if (argc != 2 && argc != 3)
1554 if (!tstrcmp(wimfile, T("-"))) {
1555 /* Attempt to apply pipable WIM from standard input. */
1557 image_num_or_name = NULL;
1560 image_num_or_name = argv[1];
1565 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1566 imagex_progress_func);
1568 goto out_free_refglobs;
1570 wimlib_get_wim_info(wim, &info);
1573 /* Image explicitly specified. */
1574 image_num_or_name = argv[1];
1575 image = wimlib_resolve_image(wim, image_num_or_name);
1576 ret = verify_image_exists(image, image_num_or_name, wimfile);
1578 goto out_wimlib_free;
1581 /* No image specified; default to image 1, but only if the WIM
1582 * contains exactly one image. */
1584 if (info.image_count != 1) {
1585 imagex_error(T("\"%"TS"\" contains %d images; "
1586 "Please select one (or all)."),
1587 wimfile, info.image_count);
1596 if (refglobs.num_strings) {
1598 imagex_error(T("Can't specify --ref when applying from stdin!"));
1600 goto out_wimlib_free;
1602 ret = wim_reference_globs(wim, &refglobs, open_flags);
1604 goto out_wimlib_free;
1609 /* Interpret a regular file or block device target as a NTFS
1613 if (tstat(target, &stbuf)) {
1614 if (errno != ENOENT) {
1615 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1618 goto out_wimlib_free;
1621 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1622 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1628 ret = wimlib_extract_image(wim, image, target, extract_flags,
1629 imagex_progress_func);
1631 set_fd_to_binary_mode(STDIN_FILENO);
1632 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1634 target, extract_flags,
1635 imagex_progress_func);
1638 imagex_printf(T("Done applying WIM image.\n"));
1639 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1641 do_resource_not_found_warning(wimfile, &info, &refglobs);
1643 imagex_error(T( "If you are applying an image "
1644 "from a split pipable WIM,\n"
1645 " make sure you have "
1646 "concatenated together all parts."));
1652 string_set_destroy(&refglobs);
1656 usage(CMD_APPLY, stderr);
1658 goto out_free_refglobs;
1661 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1662 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1663 * the desired image. 'wimlib-imagex append': add a new image to an existing
1666 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1669 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1670 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1671 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1672 int write_flags = 0;
1673 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1674 const tchar *wimfile;
1678 const tchar *flags_element = NULL;
1681 STRING_SET(base_wimfiles);
1682 WIMStruct **base_wims;
1684 WIMStruct *template_wim;
1685 const tchar *template_wimfile = NULL;
1686 const tchar *template_image_name_or_num = NULL;
1687 int template_image = WIMLIB_NO_IMAGE;
1690 unsigned num_threads = 0;
1695 const tchar *config_file = NULL;
1697 struct wimlib_capture_config *config;
1699 bool source_list = false;
1700 size_t source_list_nchars = 0;
1701 tchar *source_list_contents;
1702 bool capture_sources_malloced;
1703 struct wimlib_capture_source *capture_sources;
1705 bool name_defaulted;
1707 for_opt(c, capture_or_append_options) {
1709 case IMAGEX_BOOT_OPTION:
1710 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1712 case IMAGEX_CHECK_OPTION:
1713 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1714 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1716 case IMAGEX_NOCHECK_OPTION:
1717 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1719 case IMAGEX_CONFIG_OPTION:
1720 config_file = optarg;
1721 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1723 case IMAGEX_COMPRESS_OPTION:
1724 compression_type = get_compression_type(optarg);
1725 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1728 case IMAGEX_COMPRESS_SLOW_OPTION:
1729 ret = set_compress_slow();
1732 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1734 case IMAGEX_FLAGS_OPTION:
1735 flags_element = optarg;
1737 case IMAGEX_DEREFERENCE_OPTION:
1738 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1740 case IMAGEX_VERBOSE_OPTION:
1741 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1743 case IMAGEX_THREADS_OPTION:
1744 num_threads = parse_num_threads(optarg);
1745 if (num_threads == UINT_MAX)
1748 case IMAGEX_REBUILD_OPTION:
1749 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1751 case IMAGEX_UNIX_DATA_OPTION:
1752 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1754 case IMAGEX_SOURCE_LIST_OPTION:
1757 case IMAGEX_NO_ACLS_OPTION:
1758 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1760 case IMAGEX_STRICT_ACLS_OPTION:
1761 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1763 case IMAGEX_RPFIX_OPTION:
1764 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1766 case IMAGEX_NORPFIX_OPTION:
1767 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1769 case IMAGEX_PIPABLE_OPTION:
1770 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1772 case IMAGEX_NOT_PIPABLE_OPTION:
1773 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1775 case IMAGEX_UPDATE_OF_OPTION:
1776 if (template_image_name_or_num) {
1777 imagex_error(T("'--update-of' can only be "
1778 "specified one time!"));
1782 colon = tstrrchr(optarg, T(':'));
1785 template_wimfile = optarg;
1787 template_image_name_or_num = colon + 1;
1789 template_wimfile = NULL;
1790 template_image_name_or_num = optarg;
1794 case IMAGEX_DELTA_FROM_OPTION:
1795 if (cmd != CMD_CAPTURE) {
1796 imagex_error(T("'--delta-from' is only "
1797 "valid for capture!"));
1800 ret = string_set_append(&base_wimfiles, optarg);
1802 goto out_free_base_wimfiles;
1803 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1812 if (argc < 2 || argc > 4)
1818 /* Set default compression type. */
1819 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1820 struct wimlib_lzx_params params;
1821 memset(¶ms, 0, sizeof(params));
1822 params.size_of_this = sizeof(params);
1823 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1824 params.use_defaults = 1;
1826 wimlib_lzx_set_default_params(¶ms);
1827 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1830 if (!tstrcmp(wimfile, T("-"))) {
1831 /* Writing captured WIM to standard output. */
1833 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1834 imagex_error("Can't write a non-pipable WIM to "
1835 "standard output! Specify --pipable\n"
1836 " if you want to create a pipable WIM "
1837 "(but read the docs first).");
1841 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1843 if (cmd == CMD_APPEND) {
1844 imagex_error(T("Using standard output for append does "
1845 "not make sense."));
1848 wim_fd = STDOUT_FILENO;
1850 imagex_info_file = stderr;
1851 set_fd_to_binary_mode(wim_fd);
1854 /* If template image was specified using --update-of=IMAGE rather
1855 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1856 if (template_image_name_or_num && !template_wimfile) {
1857 if (base_wimfiles.num_strings == 1) {
1858 /* Capturing delta WIM based on single WIM: default to
1860 template_wimfile = base_wimfiles.strings[0];
1861 } else if (cmd == CMD_APPEND) {
1862 /* Appending to WIM: default to WIM being appended to.
1864 template_wimfile = wimfile;
1866 /* Capturing a normal (non-delta) WIM, so the WIM file
1867 * *must* be explicitly specified. */
1868 if (base_wimfiles.num_strings > 1) {
1869 imagex_error(T("For capture of delta WIM "
1870 "based on multiple existing "
1872 " '--update-of' must "
1873 "specify WIMFILE:IMAGE!"));
1875 imagex_error(T("For capture of non-delta WIM, "
1876 "'--update-of' must specify "
1885 name_defaulted = false;
1887 /* Set default name to SOURCE argument, omitting any directory
1888 * prefixes and trailing slashes. This requires making a copy
1889 * of @source. Leave some free characters at the end in case we
1890 * append a number to keep the name unique. */
1891 size_t source_name_len;
1893 source_name_len = tstrlen(source);
1894 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1895 name = tbasename(tstrcpy(source_copy, source));
1896 name_defaulted = true;
1898 /* Image description defaults to NULL if not given. */
1905 /* Set up capture sources in source list mode */
1906 if (source[0] == T('-') && source[1] == T('\0')) {
1907 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1909 source_list_contents = file_get_text_contents(source,
1910 &source_list_nchars);
1912 if (!source_list_contents)
1915 capture_sources = parse_source_list(&source_list_contents,
1918 if (!capture_sources) {
1920 goto out_free_source_list_contents;
1922 capture_sources_malloced = true;
1924 /* Set up capture source in non-source-list mode. */
1925 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1926 capture_sources[0].fs_source_path = source;
1927 capture_sources[0].wim_target_path = NULL;
1928 capture_sources[0].reserved = 0;
1930 capture_sources_malloced = false;
1931 source_list_contents = NULL;
1935 /* Read and parse capture configuration file. */
1938 config_str = file_get_text_contents(config_file, &config_len);
1941 goto out_free_capture_sources;
1944 config = alloca(sizeof(*config));
1945 ret = parse_capture_config(&config_str, config_len, config);
1947 goto out_free_config;
1949 /* No capture configuration file specified; use default
1950 * configuration for capturing Windows operating systems. */
1952 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1955 /* Open the existing WIM, or create a new one. */
1956 if (cmd == CMD_APPEND)
1957 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1958 imagex_progress_func);
1960 ret = wimlib_create_new_wim(compression_type, &wim);
1962 goto out_free_config;
1965 /* Detect if source is regular file or block device and set NTFS volume
1970 if (tstat(source, &stbuf) == 0) {
1971 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1972 imagex_printf(T("Capturing WIM image from NTFS "
1973 "filesystem on \"%"TS"\"\n"), source);
1974 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1977 if (errno != ENOENT) {
1978 imagex_error_with_errno(T("Failed to stat "
1979 "\"%"TS"\""), source);
1987 /* If the user did not specify an image name, and the basename of the
1988 * source already exists as an image name in the WIM file, append a
1989 * suffix to make it unique. */
1990 if (cmd == CMD_APPEND && name_defaulted) {
1991 unsigned long conflict_idx;
1992 tchar *name_end = tstrchr(name, T('\0'));
1993 for (conflict_idx = 1;
1994 wimlib_image_name_in_use(wim, name);
1997 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2001 /* If capturing a delta WIM, reference resources from the base WIMs
2002 * before adding the new image. */
2003 if (base_wimfiles.num_strings) {
2004 base_wims = calloc(base_wimfiles.num_strings,
2005 sizeof(base_wims[0]));
2006 if (base_wims == NULL) {
2007 imagex_error(T("Out of memory!"));
2012 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2013 ret = wimlib_open_wim(base_wimfiles.strings[i],
2014 open_flags, &base_wims[i],
2015 imagex_progress_func);
2017 goto out_free_base_wims;
2021 ret = wimlib_reference_resources(wim, base_wims,
2022 base_wimfiles.num_strings, 0);
2024 goto out_free_base_wims;
2026 if (base_wimfiles.num_strings == 1) {
2027 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2028 base_wimfiles.strings[0]);
2030 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2031 base_wimfiles.num_strings);
2038 /* If capturing or appending as an update of an existing (template) image,
2039 * open the WIM if needed and parse the image index. */
2040 if (template_image_name_or_num) {
2043 if (base_wimfiles.num_strings == 1 &&
2044 template_wimfile == base_wimfiles.strings[0]) {
2045 template_wim = base_wims[0];
2046 } else if (template_wimfile == wimfile) {
2049 ret = wimlib_open_wim(template_wimfile, open_flags,
2050 &template_wim, imagex_progress_func);
2052 goto out_free_base_wims;
2055 template_image = wimlib_resolve_image(template_wim,
2056 template_image_name_or_num);
2058 if (template_image_name_or_num[0] == T('-')) {
2061 struct wimlib_wim_info info;
2063 wimlib_get_wim_info(template_wim, &info);
2064 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2065 if (n >= 1 && n <= info.image_count &&
2067 tmp != template_image_name_or_num + 1)
2069 template_image = info.image_count - (n - 1);
2072 ret = verify_image_exists_and_is_single(template_image,
2073 template_image_name_or_num,
2076 goto out_free_template_wim;
2078 template_wim = NULL;
2081 ret = wimlib_add_image_multisource(wim,
2087 imagex_progress_func);
2089 goto out_free_template_wim;
2091 if (desc || flags_element || template_image_name_or_num) {
2092 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2093 * on which the added one is to be based has been specified with
2094 * --update-of. Get the index of the image we just
2095 * added, then use it to call the appropriate functions. */
2096 struct wimlib_wim_info info;
2098 wimlib_get_wim_info(wim, &info);
2101 ret = wimlib_set_image_descripton(wim,
2105 goto out_free_template_wim;
2108 if (flags_element) {
2109 ret = wimlib_set_image_flags(wim, info.image_count,
2112 goto out_free_template_wim;
2115 /* Reference template image if the user provided one. */
2116 if (template_image_name_or_num) {
2117 imagex_printf(T("Using image %d "
2118 "from \"%"TS"\" as template\n"),
2119 template_image, template_wimfile);
2120 ret = wimlib_reference_template_image(wim,
2126 goto out_free_template_wim;
2130 /* Write the new WIM or overwrite the existing WIM with the new image
2132 if (cmd == CMD_APPEND) {
2133 ret = wimlib_overwrite(wim, write_flags, num_threads,
2134 imagex_progress_func);
2135 } else if (wimfile) {
2136 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2137 write_flags, num_threads,
2138 imagex_progress_func);
2140 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2141 write_flags, num_threads,
2142 imagex_progress_func);
2144 out_free_template_wim:
2145 /* template_wim may alias base_wims[0] or wim. */
2146 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2147 template_wim != wim)
2148 wimlib_free(template_wim);
2150 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2151 wimlib_free(base_wims[i]);
2157 free(config->exclusion_pats.pats);
2158 free(config->exclusion_exception_pats.pats);
2161 out_free_capture_sources:
2162 if (capture_sources_malloced)
2163 free(capture_sources);
2164 out_free_source_list_contents:
2165 free(source_list_contents);
2166 out_free_base_wimfiles:
2167 string_set_destroy(&base_wimfiles);
2174 goto out_free_base_wimfiles;
2177 /* Remove image(s) from a WIM. */
2179 imagex_delete(int argc, tchar **argv, int cmd)
2182 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2183 int write_flags = 0;
2184 const tchar *wimfile;
2185 const tchar *image_num_or_name;
2190 for_opt(c, delete_options) {
2192 case IMAGEX_CHECK_OPTION:
2193 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2194 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2196 case IMAGEX_SOFT_OPTION:
2197 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2208 imagex_error(T("Must specify a WIM file"));
2210 imagex_error(T("Must specify an image"));
2214 image_num_or_name = argv[1];
2216 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2217 imagex_progress_func);
2221 image = wimlib_resolve_image(wim, image_num_or_name);
2223 ret = verify_image_exists(image, image_num_or_name, wimfile);
2225 goto out_wimlib_free;
2227 ret = wimlib_delete_image(wim, image);
2229 imagex_error(T("Failed to delete image from \"%"TS"\""),
2231 goto out_wimlib_free;
2234 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2236 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2237 "deleted"), wimfile);
2245 usage(CMD_DELETE, stderr);
2251 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2253 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2254 return (ret >= 0) ? 0 : -1;
2257 /* Print the files contained in an image(s) in a WIM file. */
2259 imagex_dir(int argc, tchar **argv, int cmd)
2261 const tchar *wimfile;
2262 WIMStruct *wim = NULL;
2265 const tchar *path = T("");
2268 for_opt(c, dir_options) {
2270 case IMAGEX_PATH_OPTION:
2281 imagex_error(T("Must specify a WIM file"));
2285 imagex_error(T("Too many arguments"));
2290 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2295 image = wimlib_resolve_image(wim, argv[1]);
2296 ret = verify_image_exists(image, argv[1], wimfile);
2298 goto out_wimlib_free;
2300 /* No image specified; default to image 1, but only if the WIM
2301 * contains exactly one image. */
2303 struct wimlib_wim_info info;
2305 wimlib_get_wim_info(wim, &info);
2306 if (info.image_count != 1) {
2307 imagex_error(T("\"%"TS"\" contains %d images; Please "
2308 "select one (or all)."),
2309 wimfile, info.image_count);
2316 ret = wimlib_iterate_dir_tree(wim, image, path,
2317 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2318 print_full_path, NULL);
2325 usage(CMD_DIR, stderr);
2330 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2333 imagex_export(int argc, tchar **argv, int cmd)
2337 int export_flags = 0;
2338 int write_flags = 0;
2339 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2340 const tchar *src_wimfile;
2341 const tchar *src_image_num_or_name;
2342 const tchar *dest_wimfile;
2344 const tchar *dest_name;
2345 const tchar *dest_desc;
2347 struct wimlib_wim_info src_info;
2348 WIMStruct *dest_wim;
2353 STRING_SET(refglobs);
2354 unsigned num_threads = 0;
2356 for_opt(c, export_options) {
2358 case IMAGEX_BOOT_OPTION:
2359 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2361 case IMAGEX_CHECK_OPTION:
2362 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2363 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2365 case IMAGEX_NOCHECK_OPTION:
2366 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2368 case IMAGEX_COMPRESS_OPTION:
2369 compression_type = get_compression_type(optarg);
2370 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2373 case IMAGEX_REF_OPTION:
2374 ret = string_set_append(&refglobs, optarg);
2376 goto out_free_refglobs;
2378 case IMAGEX_THREADS_OPTION:
2379 num_threads = parse_num_threads(optarg);
2380 if (num_threads == UINT_MAX)
2383 case IMAGEX_REBUILD_OPTION:
2384 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2386 case IMAGEX_PIPABLE_OPTION:
2387 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2389 case IMAGEX_NOT_PIPABLE_OPTION:
2390 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2398 if (argc < 3 || argc > 5)
2400 src_wimfile = argv[0];
2401 src_image_num_or_name = argv[1];
2402 dest_wimfile = argv[2];
2403 dest_name = (argc >= 4) ? argv[3] : NULL;
2404 dest_desc = (argc >= 5) ? argv[4] : NULL;
2405 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2406 imagex_progress_func);
2408 goto out_free_refglobs;
2410 wimlib_get_wim_info(src_wim, &src_info);
2412 /* Determine if the destination is an existing file or not. If so, we
2413 * try to append the exported image(s) to it; otherwise, we create a new
2414 * WIM containing the exported image(s). Furthermore, determine if we
2415 * need to write a pipable WIM directly to standard output. */
2417 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2419 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2420 imagex_error("Can't write a non-pipable WIM to "
2421 "standard output! Specify --pipable\n"
2422 " if you want to create a pipable WIM "
2423 "(but read the docs first).");
2425 goto out_free_src_wim;
2428 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2430 dest_wimfile = NULL;
2431 dest_wim_fd = STDOUT_FILENO;
2432 imagex_info_file = stderr;
2433 set_fd_to_binary_mode(dest_wim_fd);
2436 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2438 /* Destination file exists. */
2440 if (!S_ISREG(stbuf.st_mode)) {
2441 imagex_error(T("\"%"TS"\" is not a regular file"),
2444 goto out_free_src_wim;
2446 ret = wimlib_open_wim(dest_wimfile,
2447 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2448 &dest_wim, imagex_progress_func);
2450 goto out_free_src_wim;
2452 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2453 /* The user specified a compression type, but we're
2454 * exporting to an existing WIM. Make sure the
2455 * specified compression type is the same as the
2456 * compression type of the existing destination WIM. */
2457 struct wimlib_wim_info dest_info;
2459 wimlib_get_wim_info(dest_wim, &dest_info);
2460 if (compression_type != dest_info.compression_type) {
2461 imagex_error(T("Cannot specify a compression type that is "
2462 "not the same as that used in the "
2463 "destination WIM"));
2465 goto out_free_dest_wim;
2471 if (errno != ENOENT) {
2472 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2475 goto out_free_src_wim;
2478 /* dest_wimfile is not an existing file, so create a new WIM. */
2480 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2481 /* The user did not specify a compression type; default
2482 * to that of the source WIM. */
2484 compression_type = src_info.compression_type;
2486 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2488 goto out_free_src_wim;
2491 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2492 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2494 goto out_free_dest_wim;
2496 if (refglobs.num_strings) {
2497 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2499 goto out_free_dest_wim;
2502 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2503 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2505 imagex_error(T("--boot specified for all-images export, but source WIM "
2506 "has no bootable image."));
2508 goto out_free_dest_wim;
2511 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2512 dest_desc, export_flags, imagex_progress_func);
2514 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2515 do_resource_not_found_warning(src_wimfile,
2516 &src_info, &refglobs);
2518 goto out_free_dest_wim;
2522 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2523 imagex_progress_func);
2524 else if (dest_wimfile)
2525 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2526 write_flags, num_threads,
2527 imagex_progress_func);
2529 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2530 WIMLIB_ALL_IMAGES, write_flags,
2531 num_threads, imagex_progress_func);
2533 wimlib_free(dest_wim);
2535 wimlib_free(src_wim);
2537 string_set_destroy(&refglobs);
2541 usage(CMD_EXPORT, stderr);
2544 goto out_free_refglobs;
2548 is_root_wim_path(const tchar *path)
2551 for (p = path; *p; p++)
2552 if (*p != T('\\') && *p != T('/'))
2558 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2559 const tchar *dest_dir)
2561 for (size_t i = 0; i < num_cmds; i++)
2562 if (cmds[i].fs_dest_path != dest_dir)
2563 free(cmds[i].fs_dest_path);
2567 static struct wimlib_extract_command *
2568 prepare_extract_commands(tchar **paths, unsigned num_paths,
2569 int extract_flags, tchar *dest_dir,
2570 size_t *num_cmds_ret)
2572 struct wimlib_extract_command *cmds;
2574 tchar *emptystr = T("");
2576 if (num_paths == 0) {
2580 num_cmds = num_paths;
2581 cmds = calloc(num_cmds, sizeof(cmds[0]));
2583 imagex_error(T("Out of memory!"));
2587 for (size_t i = 0; i < num_cmds; i++) {
2588 cmds[i].extract_flags = extract_flags;
2589 cmds[i].wim_source_path = paths[i];
2590 if (is_root_wim_path(paths[i])) {
2591 cmds[i].fs_dest_path = dest_dir;
2593 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2594 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2595 if (!cmds[i].fs_dest_path) {
2596 free_extract_commands(cmds, num_cmds, dest_dir);
2599 tsprintf(cmds[i].fs_dest_path,
2600 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2601 dest_dir, tbasename(paths[i]));
2604 *num_cmds_ret = num_cmds;
2608 /* Extract files or directories from a WIM image */
2610 imagex_extract(int argc, tchar **argv, int cmd)
2617 const tchar *wimfile;
2618 const tchar *image_num_or_name;
2619 tchar *dest_dir = T(".");
2620 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2622 STRING_SET(refglobs);
2624 struct wimlib_extract_command *cmds;
2627 for_opt(c, extract_options) {
2629 case IMAGEX_CHECK_OPTION:
2630 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2632 case IMAGEX_VERBOSE_OPTION:
2633 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2635 case IMAGEX_REF_OPTION:
2636 ret = string_set_append(&refglobs, optarg);
2638 goto out_free_refglobs;
2640 case IMAGEX_UNIX_DATA_OPTION:
2641 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2643 case IMAGEX_NO_ACLS_OPTION:
2644 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2646 case IMAGEX_STRICT_ACLS_OPTION:
2647 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2649 case IMAGEX_DEST_DIR_OPTION:
2652 case IMAGEX_TO_STDOUT_OPTION:
2653 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2654 imagex_info_file = stderr;
2655 imagex_be_quiet = true;
2657 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2658 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2659 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2672 image_num_or_name = argv[1];
2677 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2682 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2686 image = wimlib_resolve_image(wim, image_num_or_name);
2687 ret = verify_image_exists_and_is_single(image,
2691 goto out_wimlib_free;
2693 if (refglobs.num_strings) {
2694 ret = wim_reference_globs(wim, &refglobs, open_flags);
2696 goto out_wimlib_free;
2699 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2700 imagex_progress_func);
2702 if (!imagex_be_quiet)
2703 imagex_printf(T("Done extracting files.\n"));
2704 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2705 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2706 "files and directories\n"
2707 " are in the WIM image.\n"),
2708 get_cmd_string(CMD_INFO, false));
2709 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2710 struct wimlib_wim_info info;
2712 wimlib_get_wim_info(wim, &info);
2713 do_resource_not_found_warning(wimfile, &info, &refglobs);
2718 free_extract_commands(cmds, num_cmds, dest_dir);
2720 string_set_destroy(&refglobs);
2724 usage(CMD_EXTRACT, stderr);
2727 goto out_free_refglobs;
2730 static void print_byte_field(const uint8_t field[], size_t len)
2733 tprintf(T("%02hhx"), *field++);
2737 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2739 tputs(T("WIM Information:"));
2740 tputs(T("----------------"));
2741 tprintf(T("Path: %"TS"\n"), wimfile);
2742 tprintf(T("GUID: 0x"));
2743 print_byte_field(info->guid, sizeof(info->guid));
2745 tprintf(T("Image Count: %d\n"), info->image_count);
2746 tprintf(T("Compression: %"TS"\n"),
2747 wimlib_get_compression_type_string(info->compression_type));
2748 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2749 tprintf(T("Boot Index: %d\n"), info->boot_index);
2750 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2751 tprintf(T("Integrity Info: %"TS"\n"),
2752 info->has_integrity_table ? T("yes") : T("no"));
2753 tprintf(T("Relative path junction: %"TS"\n"),
2754 info->has_rpfix ? T("yes") : T("no"));
2755 tprintf(T("Pipable: %"TS"\n"),
2756 info->pipable ? T("yes") : T("no"));
2761 print_resource(const struct wimlib_resource_entry *resource,
2765 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2766 resource->uncompressed_size);
2768 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2769 resource->compressed_size);
2771 tprintf(T("Offset = %"PRIu64" bytes\n"),
2775 tprintf(T("Part Number = %u\n"), resource->part_number);
2776 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2778 tprintf(T("Hash = 0x"));
2779 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2782 tprintf(T("Flags = "));
2783 if (resource->is_compressed)
2784 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2785 if (resource->is_metadata)
2786 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2787 if (resource->is_free)
2788 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2789 if (resource->is_spanned)
2790 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2797 print_lookup_table(WIMStruct *wim)
2799 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2802 /* Prints information about a WIM file; also can mark an image as bootable,
2803 * change the name of an image, or change the description of an image. */
2805 imagex_info(int argc, tchar **argv, int cmd)
2810 bool nocheck = false;
2811 bool header = false;
2812 bool lookup_table = false;
2814 bool metadata = false;
2815 bool short_header = true;
2816 const tchar *xml_out_file = NULL;
2817 const tchar *wimfile;
2818 const tchar *image_num_or_name;
2819 const tchar *new_name;
2820 const tchar *new_desc;
2825 struct wimlib_wim_info info;
2827 for_opt(c, info_options) {
2829 case IMAGEX_BOOT_OPTION:
2832 case IMAGEX_CHECK_OPTION:
2835 case IMAGEX_NOCHECK_OPTION:
2838 case IMAGEX_HEADER_OPTION:
2840 short_header = false;
2842 case IMAGEX_LOOKUP_TABLE_OPTION:
2843 lookup_table = true;
2844 short_header = false;
2846 case IMAGEX_XML_OPTION:
2848 short_header = false;
2850 case IMAGEX_EXTRACT_XML_OPTION:
2851 xml_out_file = optarg;
2852 short_header = false;
2854 case IMAGEX_METADATA_OPTION:
2856 short_header = false;
2865 if (argc < 1 || argc > 4)
2869 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2870 new_name = (argc >= 3) ? argv[2] : NULL;
2871 new_desc = (argc >= 4) ? argv[3] : NULL;
2873 if (check && nocheck) {
2874 imagex_error(T("Can't specify both --check and --nocheck"));
2879 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2881 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2885 wimlib_get_wim_info(wim, &info);
2887 image = wimlib_resolve_image(wim, image_num_or_name);
2888 ret = WIMLIB_ERR_INVALID_IMAGE;
2889 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2890 verify_image_exists(image, image_num_or_name, wimfile);
2892 imagex_error(T("If you would like to set the boot "
2893 "index to 0, specify image \"0\" with "
2894 "the --boot flag."));
2896 goto out_wimlib_free;
2899 if (boot && info.image_count == 0) {
2900 imagex_error(T("--boot is meaningless on a WIM with no images"));
2901 goto out_wimlib_free;
2904 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2906 imagex_error(T("Cannot specify the --boot flag "
2907 "without specifying a specific "
2908 "image in a multi-image WIM"));
2909 goto out_wimlib_free;
2912 imagex_error(T("Cannot specify the NEW_NAME "
2913 "without specifying a specific "
2914 "image in a multi-image WIM"));
2915 goto out_wimlib_free;
2919 /* Operations that print information are separated from operations that
2920 * recreate the WIM file. */
2921 if (!new_name && !boot) {
2923 /* Read-only operations */
2925 if (image == WIMLIB_NO_IMAGE) {
2926 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2927 image_num_or_name, wimfile);
2928 goto out_wimlib_free;
2931 if (image == WIMLIB_ALL_IMAGES && short_header)
2932 print_wim_information(wimfile, &info);
2935 wimlib_print_header(wim);
2938 if (info.total_parts != 1) {
2939 tfprintf(stderr, T("Warning: Only showing the lookup table "
2940 "for part %d of a %d-part WIM.\n"),
2941 info.part_number, info.total_parts);
2943 print_lookup_table(wim);
2947 ret = wimlib_extract_xml_data(wim, stdout);
2949 goto out_wimlib_free;
2955 fp = tfopen(xml_out_file, T("wb"));
2957 imagex_error_with_errno(T("Failed to open the "
2958 "file \"%"TS"\" for "
2962 goto out_wimlib_free;
2964 ret = wimlib_extract_xml_data(wim, fp);
2966 imagex_error(T("Failed to close the file "
2972 goto out_wimlib_free;
2976 wimlib_print_available_images(wim, image);
2979 ret = wimlib_print_metadata(wim, image);
2981 goto out_wimlib_free;
2986 /* Modification operations */
2988 if (image == WIMLIB_ALL_IMAGES)
2991 if (image == WIMLIB_NO_IMAGE && new_name) {
2992 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2993 "when using image 0"), new_name);
2995 goto out_wimlib_free;
2999 if (image == info.boot_index) {
3000 imagex_printf(T("Image %d is already marked as "
3001 "bootable.\n"), image);
3004 imagex_printf(T("Marking image %d as bootable.\n"),
3006 info.boot_index = image;
3007 ret = wimlib_set_wim_info(wim, &info,
3008 WIMLIB_CHANGE_BOOT_INDEX);
3010 goto out_wimlib_free;
3014 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3016 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3020 imagex_printf(T("Changing the name of image %d to "
3021 "\"%"TS"\".\n"), image, new_name);
3022 ret = wimlib_set_image_name(wim, image, new_name);
3024 goto out_wimlib_free;
3028 const tchar *old_desc;
3029 old_desc = wimlib_get_image_description(wim, image);
3030 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3031 imagex_printf(T("The description of image %d is already "
3032 "\"%"TS"\".\n"), image, new_desc);
3035 imagex_printf(T("Changing the description of image %d "
3036 "to \"%"TS"\".\n"), image, new_desc);
3037 ret = wimlib_set_image_descripton(wim, image,
3040 goto out_wimlib_free;
3044 /* Only call wimlib_overwrite() if something actually needs to
3046 if (boot || new_name || new_desc ||
3047 (check && !info.has_integrity_table) ||
3048 (nocheck && info.has_integrity_table))
3050 int write_flags = 0;
3053 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3055 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3056 ret = wimlib_overwrite(wim, write_flags, 1,
3057 imagex_progress_func);
3059 imagex_printf(T("The file \"%"TS"\" was not modified "
3060 "because nothing needed to be done.\n"),
3071 usage(CMD_INFO, stderr);
3077 /* Join split WIMs into one part WIM */
3079 imagex_join(int argc, tchar **argv, int cmd)
3082 int swm_open_flags = 0;
3083 int wim_write_flags = 0;
3084 const tchar *output_path;
3087 for_opt(c, join_options) {
3089 case IMAGEX_CHECK_OPTION:
3090 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3091 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3101 imagex_error(T("Must specify one or more split WIM (.swm) "
3105 output_path = argv[0];
3106 ret = wimlib_join((const tchar * const *)++argv,
3111 imagex_progress_func);
3116 usage(CMD_JOIN, stderr);
3121 #if WIM_MOUNTING_SUPPORTED
3123 /* Mounts a WIM image. */
3125 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3128 int mount_flags = 0;
3130 const tchar *staging_dir = NULL;
3131 const tchar *wimfile;
3134 struct wimlib_wim_info info;
3138 STRING_SET(refglobs);
3140 if (cmd == CMD_MOUNTRW) {
3141 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3142 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3145 for_opt(c, mount_options) {
3147 case IMAGEX_ALLOW_OTHER_OPTION:
3148 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3150 case IMAGEX_CHECK_OPTION:
3151 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3153 case IMAGEX_DEBUG_OPTION:
3154 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3156 case IMAGEX_STREAMS_INTERFACE_OPTION:
3157 if (!tstrcasecmp(optarg, T("none")))
3158 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3159 else if (!tstrcasecmp(optarg, T("xattr")))
3160 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3161 else if (!tstrcasecmp(optarg, T("windows")))
3162 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3164 imagex_error(T("Unknown stream interface \"%"TS"\""),
3169 case IMAGEX_REF_OPTION:
3170 ret = string_set_append(&refglobs, optarg);
3172 goto out_free_refglobs;
3174 case IMAGEX_STAGING_DIR_OPTION:
3175 staging_dir = optarg;
3177 case IMAGEX_UNIX_DATA_OPTION:
3178 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3186 if (argc != 2 && argc != 3)
3191 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3193 goto out_free_refglobs;
3195 wimlib_get_wim_info(wim, &info);
3198 /* Image explicitly specified. */
3199 image = wimlib_resolve_image(wim, argv[1]);
3201 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3205 /* No image specified; default to image 1, but only if the WIM
3206 * contains exactly one image. */
3208 if (info.image_count != 1) {
3209 imagex_error(T("\"%"TS"\" contains %d images; Please "
3210 "select one."), wimfile, info.image_count);
3218 if (refglobs.num_strings) {
3219 ret = wim_reference_globs(wim, &refglobs, open_flags);
3224 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3226 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3228 image, wimfile, dir);
3233 string_set_destroy(&refglobs);
3239 goto out_free_refglobs;
3241 #endif /* WIM_MOUNTING_SUPPORTED */
3243 /* Rebuild a WIM file */
3245 imagex_optimize(int argc, tchar **argv, int cmd)
3248 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3249 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3250 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3253 const tchar *wimfile;
3256 unsigned num_threads = 0;
3258 for_opt(c, optimize_options) {
3260 case IMAGEX_CHECK_OPTION:
3261 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3262 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3264 case IMAGEX_NOCHECK_OPTION:
3265 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3267 case IMAGEX_COMPRESS_OPTION:
3268 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3269 compression_type = get_compression_type(optarg);
3270 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3273 case IMAGEX_RECOMPRESS_OPTION:
3274 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3276 case IMAGEX_COMPRESS_SLOW_OPTION:
3277 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3278 ret = set_compress_slow();
3282 case IMAGEX_THREADS_OPTION:
3283 num_threads = parse_num_threads(optarg);
3284 if (num_threads == UINT_MAX)
3287 case IMAGEX_PIPABLE_OPTION:
3288 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3290 case IMAGEX_NOT_PIPABLE_OPTION:
3291 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3305 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3309 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3310 ret = wimlib_set_output_compression_type(wim, compression_type);
3312 goto out_wimlib_free;
3315 old_size = file_get_size(wimfile);
3316 tprintf(T("\"%"TS"\" original size: "), wimfile);
3318 tputs(T("Unknown"));
3320 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3322 ret = wimlib_overwrite(wim, write_flags, num_threads,
3323 imagex_progress_func);
3325 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3326 goto out_wimlib_free;
3329 new_size = file_get_size(wimfile);
3330 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3332 tputs(T("Unknown"));
3334 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3336 tfputs(T("Space saved: "), stdout);
3337 if (new_size != -1 && old_size != -1) {
3338 tprintf(T("%lld KiB\n"),
3339 ((long long)old_size - (long long)new_size) >> 10);
3341 tputs(T("Unknown"));
3350 usage(CMD_OPTIMIZE, stderr);
3356 /* Split a WIM into a spanned set */
3358 imagex_split(int argc, tchar **argv, int cmd)
3362 int write_flags = 0;
3363 unsigned long part_size;
3368 for_opt(c, split_options) {
3370 case IMAGEX_CHECK_OPTION:
3371 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3372 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3384 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3385 if (tmp == argv[2] || *tmp) {
3386 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3387 imagex_error(T("The part size must be an integer or "
3388 "floating-point number of megabytes."));
3391 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3395 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3401 usage(CMD_SPLIT, stderr);
3407 #if WIM_MOUNTING_SUPPORTED
3408 /* Unmounts a mounted WIM image. */
3410 imagex_unmount(int argc, tchar **argv, int cmd)
3413 int unmount_flags = 0;
3416 for_opt(c, unmount_options) {
3418 case IMAGEX_COMMIT_OPTION:
3419 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3421 case IMAGEX_CHECK_OPTION:
3422 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3424 case IMAGEX_REBUILD_OPTION:
3425 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3427 case IMAGEX_LAZY_OPTION:
3428 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3439 ret = wimlib_unmount_image(argv[0], unmount_flags,
3440 imagex_progress_func);
3442 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3447 usage(CMD_UNMOUNT, stderr);
3451 #endif /* WIM_MOUNTING_SUPPORTED */
3454 * Add, delete, or rename files in a WIM image.
3457 imagex_update(int argc, tchar **argv, int cmd)
3459 const tchar *wimfile;
3463 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3464 int write_flags = 0;
3465 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3466 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
3467 int default_delete_flags = 0;
3468 unsigned num_threads = 0;
3470 tchar *cmd_file_contents;
3471 size_t cmd_file_nchars;
3472 struct wimlib_update_command *cmds;
3474 tchar *command_str = NULL;
3476 const tchar *config_file = NULL;
3478 struct wimlib_capture_config *config;
3480 for_opt(c, update_options) {
3482 /* Generic or write options */
3483 case IMAGEX_THREADS_OPTION:
3484 num_threads = parse_num_threads(optarg);
3485 if (num_threads == UINT_MAX)
3488 case IMAGEX_CHECK_OPTION:
3489 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3490 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3492 case IMAGEX_REBUILD_OPTION:
3493 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3495 case IMAGEX_COMMAND_OPTION:
3497 imagex_error(T("--command may only be specified "
3498 "one time. Please provide\n"
3499 " the update commands "
3500 "on standard input instead."));
3503 command_str = tstrdup(optarg);
3505 imagex_error(T("Out of memory!"));
3509 /* Default delete options */
3510 case IMAGEX_FORCE_OPTION:
3511 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3513 case IMAGEX_RECURSIVE_OPTION:
3514 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3517 /* Global add option */
3518 case IMAGEX_CONFIG_OPTION:
3519 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3520 config_file = optarg;
3523 /* Default add options */
3524 case IMAGEX_VERBOSE_OPTION:
3525 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3527 case IMAGEX_DEREFERENCE_OPTION:
3528 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3530 case IMAGEX_UNIX_DATA_OPTION:
3531 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3533 case IMAGEX_NO_ACLS_OPTION:
3534 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3536 case IMAGEX_STRICT_ACLS_OPTION:
3537 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3546 if (argc != 1 && argc != 2)
3550 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3552 goto out_free_command_str;
3555 /* Image explicitly specified. */
3556 image = wimlib_resolve_image(wim, argv[1]);
3557 ret = verify_image_exists_and_is_single(image, argv[1],
3560 goto out_wimlib_free;
3562 /* No image specified; default to image 1, but only if the WIM
3563 * contains exactly one image. */
3564 struct wimlib_wim_info info;
3566 wimlib_get_wim_info(wim, &info);
3567 if (info.image_count != 1) {
3568 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3569 wimfile, info.image_count);
3576 /* Parse capture configuration file if specified */
3580 config_str = file_get_text_contents(config_file, &config_len);
3583 goto out_wimlib_free;
3586 config = alloca(sizeof(*config));
3587 ret = parse_capture_config(&config_str, config_len, config);
3589 goto out_free_config;
3592 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3595 /* Read update commands from standard input, or the command string if
3598 cmd_file_contents = NULL;
3599 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3602 if (isatty(STDIN_FILENO)) {
3603 tputs(T("Reading update commands from standard input..."));
3604 recommend_man_page(CMD_UPDATE, stdout);
3606 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3607 if (!cmd_file_contents) {
3609 goto out_free_config;
3612 /* Parse the update commands */
3613 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3618 goto out_free_cmd_file_contents;
3621 /* Set default flags and capture config on the update commands */
3622 for (size_t i = 0; i < num_cmds; i++) {
3623 switch (cmds[i].op) {
3624 case WIMLIB_UPDATE_OP_ADD:
3625 cmds[i].add.add_flags |= default_add_flags;
3626 cmds[i].add.config = config;
3628 case WIMLIB_UPDATE_OP_DELETE:
3629 cmds[i].delete_.delete_flags |= default_delete_flags;
3636 /* Execute the update commands */
3637 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3638 imagex_progress_func);
3642 /* Overwrite the updated WIM */
3643 ret = wimlib_overwrite(wim, write_flags, num_threads,
3644 imagex_progress_func);
3647 out_free_cmd_file_contents:
3648 free(cmd_file_contents);
3651 free(config->exclusion_pats.pats);
3652 free(config->exclusion_exception_pats.pats);
3657 out_free_command_str:
3662 usage(CMD_UPDATE, stderr);
3665 goto out_free_command_str;
3670 struct imagex_command {
3672 int (*func)(int argc, tchar **argv, int cmd);
3675 static const struct imagex_command imagex_commands[] = {
3676 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3677 [CMD_APPLY] = {T("apply"), imagex_apply},
3678 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3679 [CMD_DELETE] = {T("delete"), imagex_delete},
3680 [CMD_DIR ] = {T("dir"), imagex_dir},
3681 [CMD_EXPORT] = {T("export"), imagex_export},
3682 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3683 [CMD_INFO] = {T("info"), imagex_info},
3684 [CMD_JOIN] = {T("join"), imagex_join},
3685 #if WIM_MOUNTING_SUPPORTED
3686 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3687 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3689 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3690 [CMD_SPLIT] = {T("split"), imagex_split},
3691 #if WIM_MOUNTING_SUPPORTED
3692 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3694 [CMD_UPDATE] = {T("update"), imagex_update},
3697 static const tchar *usage_strings[] = {
3700 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3701 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3702 " [--check] [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3703 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3704 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3705 " [--norpfix] [--unix-data] [--pipable]\n"
3706 " [--update-of=[WIMFILE:]IMAGE]\n"
3710 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3711 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3712 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3713 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3714 " [--include-invalid-names]\n"
3718 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3719 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3720 " [--check] [--nocheck] [--compress=TYPE]\n"
3721 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
3722 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3723 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3724 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3725 " [--delta-from=WIMFILE]\n"
3729 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3734 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3738 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3739 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3740 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3741 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3742 " [--pipable] [--not-pipable]\n"
3746 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3747 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3748 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3749 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3753 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3754 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3755 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3760 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3762 #if WIM_MOUNTING_SUPPORTED
3765 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3766 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3767 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3771 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3772 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3773 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3778 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3779 " [--recompress-slow] [--compress=TYPE]\n"
3780 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3784 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3786 #if WIM_MOUNTING_SUPPORTED
3789 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3794 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3795 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3796 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3800 static const tchar *invocation_name;
3801 static int invocation_cmd = CMD_NONE;
3803 static const tchar *get_cmd_string(int cmd, bool nospace)
3805 static tchar buf[50];
3806 if (cmd == CMD_NONE) {
3807 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3808 } else if (invocation_cmd != CMD_NONE) {
3809 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3811 const tchar *format;
3814 format = T("%"TS"-%"TS"");
3816 format = T("%"TS" %"TS"");
3817 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3825 static const tchar *s =
3827 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3828 "Copyright (C) 2012, 2013 Eric Biggers\n"
3829 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3830 "This is free software: you are free to change and redistribute it.\n"
3831 "There is NO WARRANTY, to the extent permitted by law.\n"
3833 "Report bugs to "PACKAGE_BUGREPORT".\n"
3840 help_or_version(int argc, tchar **argv, int cmd)
3845 for (i = 1; i < argc; i++) {
3847 if (p[0] == T('-') && p[1] == T('-')) {
3849 if (!tstrcmp(p, T("help"))) {
3850 if (cmd == CMD_NONE)
3855 } else if (!tstrcmp(p, T("version"))) {
3864 print_usage_string(int cmd, FILE *fp)
3866 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3870 recommend_man_page(int cmd, FILE *fp)
3872 const tchar *format_str;
3874 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3876 format_str = T("Try `man %"TS"' for more details.\n");
3878 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3882 usage(int cmd, FILE *fp)
3884 tfprintf(fp, T("Usage:\n"));
3885 print_usage_string(cmd, fp);
3886 tfprintf(fp, T("\n"));
3887 recommend_man_page(cmd, fp);
3893 tfprintf(fp, T("Usage:\n"));
3894 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3895 print_usage_string(cmd, fp);
3896 tfprintf(fp, T("\n"));
3898 static const tchar *extra =
3901 " %"TS" --version\n"
3903 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3906 tfprintf(fp, extra, invocation_name, invocation_name);
3907 recommend_man_page(CMD_NONE, fp);
3910 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3911 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3912 * something else), while an Windows the command arguments will be UTF-16LE
3913 * encoded 'wchar_t' strings. */
3916 wmain(int argc, wchar_t **argv, wchar_t **envp)
3918 main(int argc, char **argv)
3925 imagex_info_file = stdout;
3926 invocation_name = tbasename(argv[0]);
3929 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3930 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3934 setlocale(LC_ALL, "");
3935 codeset = nl_langinfo(CODESET);
3936 if (!strstr(codeset, "UTF-8") &&
3937 !strstr(codeset, "UTF8") &&
3938 !strstr(codeset, "utf-8") &&
3939 !strstr(codeset, "utf8"))
3942 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3943 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3944 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3945 " to any value to force wimlib to use UTF-8.\n",
3950 #endif /* !__WIN32__ */
3952 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3954 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3955 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3956 for (int i = 0; i < CMD_MAX; i++) {
3957 if (!tstrcmp(invocation_name + 3,
3958 imagex_commands[i].name))
3967 /* Unless already known from the invocation name, determine which
3968 * command was specified. */
3969 if (cmd == CMD_NONE) {
3971 imagex_error(T("No command specified!\n"));
3975 for (int i = 0; i < CMD_MAX; i++) {
3976 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3981 if (cmd != CMD_NONE) {
3987 /* Handle --help and --version. --help can be either for the program as
3988 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3989 * CMD_NONE). Note: help_or_version() will not return if a --help or
3990 * --version argument was found. */
3991 help_or_version(argc, argv, cmd);
3993 /* Bail if a valid command was not specified. */
3994 if (cmd == CMD_NONE) {
3995 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4000 /* Enable warning and error messages in wimlib be more user-friendly.
4002 wimlib_set_print_errors(true);
4004 /* Initialize wimlib. */
4005 ret = wimlib_global_init(init_flags);
4007 goto out_check_status;
4009 /* Call the command handler function. */
4010 ret = imagex_commands[cmd].func(argc, argv, cmd);
4012 /* Check for error writing to standard output, especially since for some
4013 * commands, writing to standard output is part of the program's actual
4014 * behavior and not just for informational purposes. */
4015 if (ferror(stdout) || fclose(stdout)) {
4016 imagex_error_with_errno(T("error writing to standard output"));
4021 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4022 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4023 * error code from which an error message can be printed. */
4025 imagex_error(T("Exiting with error code %d:\n"
4027 wimlib_get_error_string(ret));
4028 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4029 imagex_error_with_errno(T("errno"));
4031 /* Make wimlib free any resources it's holding (although this is not
4032 * strictly necessary because the process is ending anyway). */
4033 wimlib_global_cleanup();