4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 # include "config.h" /* Need for PACKAGE_VERSION, etc. */
30 #include "wimlib_tchar.h"
50 # include "imagex-win32.h"
51 # define tbasename win32_wbasename
52 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
53 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
57 # include <langinfo.h>
58 # define tbasename basename
59 # define OS_PREFERRED_PATH_SEPARATOR '/'
60 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
61 static inline void set_fd_to_binary_mode(int fd)
66 /* Don't confuse the user by presenting the mounting commands on Windows when
67 * they will never work. However on UNIX-like systems we always present them,
68 * even if WITH_FUSE is not defined at this point, as to not tie the build of
69 * wimlib-imagex to a specific build of wimlib. */
71 # define WIM_MOUNTING_SUPPORTED 0
73 # define WIM_MOUNTING_SUPPORTED 1
76 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
92 #if WIM_MOUNTING_SUPPORTED
98 #if WIM_MOUNTING_SUPPORTED
105 static void usage(int cmd, FILE *fp);
106 static void usage_all(FILE *fp);
107 static void recommend_man_page(int cmd, FILE *fp);
108 static const tchar *get_cmd_string(int cmd, bool nospace);
110 static int imagex_progress_func(enum wimlib_progress_msg msg,
111 const union wimlib_progress_info *info);
113 static bool imagex_be_quiet = false;
114 static FILE *imagex_info_file;
116 #define imagex_printf(format, ...) \
117 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
120 IMAGEX_ALLOW_OTHER_OPTION,
123 IMAGEX_COMMAND_OPTION,
124 IMAGEX_COMMIT_OPTION,
125 IMAGEX_COMPRESS_OPTION,
126 IMAGEX_COMPRESS_SLOW_OPTION,
127 IMAGEX_CONFIG_OPTION,
129 IMAGEX_DELTA_FROM_OPTION,
130 IMAGEX_DEREFERENCE_OPTION,
131 IMAGEX_DEST_DIR_OPTION,
132 IMAGEX_EXTRACT_XML_OPTION,
135 IMAGEX_HARDLINK_OPTION,
136 IMAGEX_HEADER_OPTION,
137 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
139 IMAGEX_LOOKUP_TABLE_OPTION,
140 IMAGEX_METADATA_OPTION,
141 IMAGEX_NORPFIX_OPTION,
142 IMAGEX_NOCHECK_OPTION,
143 IMAGEX_NO_ACLS_OPTION,
144 IMAGEX_NOT_PIPABLE_OPTION,
146 IMAGEX_PIPABLE_OPTION,
147 IMAGEX_REBUILD_OPTION,
148 IMAGEX_RECOMPRESS_OPTION,
149 IMAGEX_RECURSIVE_OPTION,
151 IMAGEX_RESUME_OPTION,
154 IMAGEX_SOURCE_LIST_OPTION,
155 IMAGEX_STAGING_DIR_OPTION,
156 IMAGEX_STREAMS_INTERFACE_OPTION,
157 IMAGEX_STRICT_ACLS_OPTION,
158 IMAGEX_SYMLINK_OPTION,
159 IMAGEX_THREADS_OPTION,
160 IMAGEX_TO_STDOUT_OPTION,
161 IMAGEX_UNIX_DATA_OPTION,
162 IMAGEX_UPDATE_OF_OPTION,
163 IMAGEX_VERBOSE_OPTION,
167 static const struct option apply_options[] = {
168 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
169 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
170 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
171 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
172 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
173 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
174 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
175 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
176 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
177 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
178 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
179 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
181 /* --resume is undocumented for now as it needs improvement. */
182 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
186 static const struct option capture_or_append_options[] = {
187 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
188 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
189 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
190 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
191 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
192 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
193 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
194 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
195 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
196 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
197 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
198 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
199 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
200 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
201 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
202 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
203 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
204 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
205 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
206 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
207 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
208 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
209 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
213 static const struct option delete_options[] = {
214 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
215 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
219 static const struct option dir_options[] = {
220 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
224 static const struct option export_options[] = {
225 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
226 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
227 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
228 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
229 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
230 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
231 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
232 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
233 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
234 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
238 static const struct option extract_options[] = {
239 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
240 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
241 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
242 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
243 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
244 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
245 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
246 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
247 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
248 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
252 static const struct option info_options[] = {
253 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
254 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
255 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
256 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
257 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
258 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
259 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
260 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
261 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
265 static const struct option join_options[] = {
266 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
270 static const struct option mount_options[] = {
271 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
272 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
273 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
274 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
275 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
276 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
277 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
281 static const struct option optimize_options[] = {
282 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
283 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
284 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
285 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
286 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
287 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
288 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
289 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
293 static const struct option split_options[] = {
294 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
298 static const struct option unmount_options[] = {
299 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
300 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
301 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
302 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
306 static const struct option update_options[] = {
307 /* Careful: some of the options here set the defaults for update
308 * commands, but the flags given to an actual update command (and not to
309 * `imagex update' itself are also handled in
310 * update_command_add_option(). */
311 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
312 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
313 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
314 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
316 /* Default delete options */
317 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
318 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
320 /* Global add option */
321 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
323 /* Default add options */
324 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
325 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
326 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
327 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
328 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
329 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
335 # define _format_attribute(type, format_str, args_start) \
336 __attribute__((format(type, format_str, args_start)))
338 # define _format_attribute(type, format_str, args_start)
341 /* Print formatted error message to stderr. */
342 static void _format_attribute(printf, 1, 2)
343 imagex_error(const tchar *format, ...)
346 va_start(va, format);
347 tfputs(T("ERROR: "), stderr);
348 tvfprintf(stderr, format, va);
349 tputc(T('\n'), stderr);
353 /* Print formatted error message to stderr. */
354 static void _format_attribute(printf, 1, 2)
355 imagex_error_with_errno(const tchar *format, ...)
357 int errno_save = errno;
359 va_start(va, format);
360 tfputs(T("ERROR: "), stderr);
361 tvfprintf(stderr, format, va);
362 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
367 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
369 if (image == WIMLIB_NO_IMAGE) {
370 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
371 " Please specify a 1-based image index or "
372 "image name. To list the images\n"
373 " contained in the WIM archive, run\n"
375 " %"TS" \"%"TS"\"\n"),
376 image_name, wim_name,
377 get_cmd_string(CMD_INFO, false), wim_name);
378 return WIMLIB_ERR_INVALID_IMAGE;
384 verify_image_is_single(int image)
386 if (image == WIMLIB_ALL_IMAGES) {
387 imagex_error(T("Cannot specify all images for this action!"));
388 return WIMLIB_ERR_INVALID_IMAGE;
394 verify_image_exists_and_is_single(int image, const tchar *image_name,
395 const tchar *wim_name)
398 ret = verify_image_exists(image, image_name, wim_name);
400 ret = verify_image_is_single(image);
404 /* Parse the argument to --compress */
406 get_compression_type(const tchar *optarg)
408 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
409 return WIMLIB_COMPRESSION_TYPE_LZX;
410 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
411 return WIMLIB_COMPRESSION_TYPE_XPRESS;
412 else if (!tstrcasecmp(optarg, T("none")))
413 return WIMLIB_COMPRESSION_TYPE_NONE;
415 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
416 "\"maximum\", \"fast\", or \"none\"."), optarg);
417 return WIMLIB_COMPRESSION_TYPE_INVALID;
422 const tchar **strings;
423 unsigned num_strings;
424 unsigned num_alloc_strings;
427 #define STRING_SET_INITIALIZER \
428 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
430 #define STRING_SET(_strings) \
431 struct string_set _strings = STRING_SET_INITIALIZER
434 string_set_append(struct string_set *set, const tchar *glob)
436 unsigned num_alloc_strings = set->num_alloc_strings;
438 if (set->num_strings == num_alloc_strings) {
439 const tchar **new_strings;
441 num_alloc_strings += 4;
442 new_strings = realloc(set->strings,
443 sizeof(set->strings[0]) * num_alloc_strings);
445 imagex_error(T("Out of memory!"));
448 set->strings = new_strings;
449 set->num_alloc_strings = num_alloc_strings;
451 set->strings[set->num_strings++] = glob;
456 string_set_destroy(struct string_set *set)
462 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
464 return wimlib_reference_resource_files(wim, set->strings,
466 WIMLIB_REF_FLAG_GLOB_ENABLE,
468 imagex_progress_func);
472 do_resource_not_found_warning(const tchar *wimfile,
473 const struct wimlib_wim_info *info,
474 const struct string_set *refglobs)
476 if (info->total_parts > 1) {
477 if (refglobs->num_strings == 0) {
478 imagex_error(T("\"%"TS"\" is part of a split WIM. "
479 "Use --ref to specify the other parts."),
482 imagex_error(T("Perhaps the '--ref' argument did not "
483 "specify all other parts of the split "
487 imagex_error(T("If this is a delta WIM, use the --ref argument "
488 "to specify the WIM(s) on which it is based."));
492 /* Returns the size of a file given its name, or -1 if the file does not exist
493 * or its size cannot be determined. */
495 file_get_size(const tchar *filename)
498 if (tstat(filename, &st) == 0)
505 PARSE_STRING_SUCCESS = 0,
506 PARSE_STRING_FAILURE = 1,
507 PARSE_STRING_NONE = 2,
511 * Parses a string token from an array of characters.
513 * Tokens are either whitespace-delimited, or double or single-quoted.
515 * @line_p: Pointer to the pointer to the line of data. Will be updated
516 * to point past the string token iff the return value is
517 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
520 * @len_p: @len_p initially stores the length of the line of data, which may
521 * be 0, and it will be updated to the number of bytes remaining in
522 * the line iff the return value is PARSE_STRING_SUCCESS.
524 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
525 * parsed string token will be returned here.
527 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
528 * PARSE_STRING_FAILURE if the data was invalid due to a missing
529 * closing quote; or PARSE_STRING_NONE if the line ended before the
530 * beginning of a string token was found.
533 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
536 tchar *line = *line_p;
540 /* Skip leading whitespace */
543 return PARSE_STRING_NONE;
544 if (!istspace(*line) && *line != T('\0'))
550 if (quote_char == T('"') || quote_char == T('\'')) {
555 line = tmemchr(line, quote_char, len);
557 imagex_error(T("Missing closing quote: %"TS), fn - 1);
558 return PARSE_STRING_FAILURE;
561 /* Unquoted string. Go until whitespace. Line is terminated
562 * by '\0', so no need to check 'len'. */
566 } while (!istspace(*line) && *line != T('\0'));
573 return PARSE_STRING_SUCCESS;
576 /* Parses a line of data (not an empty line or comment) in the source list file
577 * format. (See the man page for 'wimlib-imagex capture' for details on this
578 * format and the meaning.)
580 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
581 * len == 0. The data in @line will be modified by this function call.
583 * @len: Length of the line of data.
585 * @source: On success, the capture source and target described by the line is
586 * written into this destination. Note that it will contain pointers
587 * to data in the @line array.
589 * Returns true if the line was valid; false otherwise. */
591 parse_source_list_line(tchar *line, size_t len,
592 struct wimlib_capture_source *source)
596 ret = parse_string(&line, &len, &source->fs_source_path);
597 if (ret != PARSE_STRING_SUCCESS)
599 ret = parse_string(&line, &len, &source->wim_target_path);
600 if (ret == PARSE_STRING_NONE)
601 source->wim_target_path = source->fs_source_path;
602 return ret != PARSE_STRING_FAILURE;
605 /* Returns %true if the given line of length @len > 0 is a comment or empty line
606 * in the source list file format. */
608 is_comment_line(const tchar *line, size_t len)
613 if (!istspace(*line) && *line != T('\0'))
623 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
626 tchar *contents = *contents_p;
627 size_t nchars = *nchars_p;
630 for (i = 0; i < nchars; i++)
631 if (contents[i] == T('\n'))
634 /* Handle last line not terminated by a newline */
635 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
636 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
638 imagex_error(T("Out of memory!"));
641 contents[nchars] = T('\n');
642 *contents_p = contents;
650 /* Parses a file in the source list format. (See the man page for
651 * 'wimlib-imagex capture' for details on this format and the meaning.)
653 * @source_list_contents: Contents of the source list file. Note that this
654 * buffer will be modified to save memory allocations,
655 * and cannot be freed until the returned array of
656 * wimlib_capture_source's has also been freed.
658 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
661 * @nsources_ret: On success, the length of the returned array is
664 * Returns: An array of `struct wimlib_capture_source's that can be passed to
665 * the wimlib_add_image_multisource() function to specify how a WIM image is to
667 static struct wimlib_capture_source *
668 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
669 size_t *nsources_ret)
673 struct wimlib_capture_source *sources;
676 nlines = text_file_count_lines(source_list_contents_p,
677 &source_list_nchars);
681 /* Always allocate at least 1 slot, just in case the implementation of
682 * calloc() returns NULL if 0 bytes are requested. */
683 sources = calloc(nlines ?: 1, sizeof(*sources));
685 imagex_error(T("out of memory"));
688 p = *source_list_contents_p;
690 for (i = 0; i < nlines; i++) {
691 /* XXX: Could use rawmemchr() here instead, but it may not be
692 * available on all platforms. */
693 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
694 size_t len = endp - p + 1;
696 if (!is_comment_line(p, len)) {
697 if (!parse_source_list_line(p, len, &sources[j++])) {
710 enum capture_config_section {
711 CAPTURE_CONFIG_NO_SECTION,
712 CAPTURE_CONFIG_EXCLUSION_SECTION,
713 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
714 CAPTURE_CONFIG_IGNORE_SECTION,
718 CAPTURE_CONFIG_INVALID_SECTION,
719 CAPTURE_CONFIG_CHANGED_SECTION,
720 CAPTURE_CONFIG_SAME_SECTION,
724 check_config_section(tchar *line, size_t len,
725 enum capture_config_section *cur_section)
727 while (istspace(*line))
731 return CAPTURE_CONFIG_SAME_SECTION;
734 tchar *endbrace = tstrrchr(line, T(']'));
736 return CAPTURE_CONFIG_SAME_SECTION;
738 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
739 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
740 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
741 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
742 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
743 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
744 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
745 "of capture config file\n"),
747 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
748 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
749 tfputs(T("WARNING: Ignoring [AlignmentList] section "
750 "of capture config file\n"),
753 imagex_error(T("Invalid capture config file section \"%"TS"\""),
755 return CAPTURE_CONFIG_INVALID_SECTION;
757 return CAPTURE_CONFIG_CHANGED_SECTION;
762 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
765 if (pat_list->num_pats == pat_list->num_allocated_pats) {
767 size_t num_allocated_pats = pat_list->num_pats + 8;
769 pats = realloc(pat_list->pats,
770 num_allocated_pats * sizeof(pat_list->pats[0]));
772 imagex_error(T("Out of memory!"));
775 pat_list->pats = pats;
776 pat_list->num_allocated_pats = num_allocated_pats;
778 pat_list->pats[pat_list->num_pats++] = pat;
783 parse_capture_config_line(tchar *line, size_t len,
784 enum capture_config_section *cur_section,
785 struct wimlib_capture_config *config)
790 ret = check_config_section(line, len, cur_section);
791 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
793 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
796 switch (*cur_section) {
797 case CAPTURE_CONFIG_NO_SECTION:
798 imagex_error(T("Line \"%"TS"\" is not in a section "
799 "(such as [ExclusionList]"), line);
801 case CAPTURE_CONFIG_EXCLUSION_SECTION:
802 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
804 return pattern_list_add_pattern(&config->exclusion_pats,
806 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
807 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
809 return pattern_list_add_pattern(&config->exclusion_exception_pats,
811 case CAPTURE_CONFIG_IGNORE_SECTION:
818 parse_capture_config(tchar **contents_p, size_t nchars,
819 struct wimlib_capture_config *config)
824 enum capture_config_section cur_section;
826 memset(config, 0, sizeof(*config));
828 nlines = text_file_count_lines(contents_p, &nchars);
832 cur_section = CAPTURE_CONFIG_NO_SECTION;
834 for (i = 0; i < nlines; i++) {
835 tchar *endp = tmemchr(p, T('\n'), nchars);
836 size_t len = endp - p + 1;
838 if (!is_comment_line(p, len))
839 if (!parse_capture_config_line(p, len, &cur_section, config))
847 /* Reads the contents of a file into memory. */
849 file_get_contents(const tchar *filename, size_t *len_ret)
856 if (tstat(filename, &stbuf) != 0) {
857 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
862 fp = tfopen(filename, T("rb"));
864 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
868 buf = malloc(len ? len : 1);
870 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
871 "contents of file \"%"TS"\""), len, filename);
874 if (fread(buf, 1, len, fp) != len) {
875 imagex_error_with_errno(T("Failed to read %zu bytes from the "
876 "file \"%"TS"\""), len, filename);
890 /* Read standard input until EOF and return the full contents in a malloc()ed
891 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
894 stdin_get_contents(size_t *len_ret)
896 /* stdin can, of course, be a pipe or other non-seekable file, so the
897 * total length of the data cannot be pre-determined */
899 size_t newlen = 1024;
903 char *p = realloc(buf, newlen);
904 size_t bytes_read, bytes_to_read;
906 imagex_error(T("out of memory while reading stdin"));
910 bytes_to_read = newlen - pos;
911 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
913 if (bytes_read != bytes_to_read) {
918 imagex_error_with_errno(T("error reading stdin"));
932 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
935 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
937 *num_tchars_ret = num_bytes;
939 #else /* !__WIN32__ */
940 /* On Windows, translate the text to UTF-16LE */
944 if (num_bytes >= 2 &&
945 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
946 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
948 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
949 * with something that looks like an ASCII character encoded as
950 * a UTF-16LE code unit. Assume the file is encoded as
951 * UTF-16LE. This is not a 100% reliable check. */
952 num_wchars = num_bytes / 2;
953 text_wstr = (wchar_t*)text;
955 /* File does not look like UTF-16LE. Assume it is encoded in
956 * the current Windows code page. I think these are always
957 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
958 * should work as expected. */
959 text_wstr = win32_mbs_to_wcs(text,
964 *num_tchars_ret = num_wchars;
966 #endif /* __WIN32__ */
970 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
975 contents = file_get_contents(filename, &num_bytes);
978 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
982 stdin_get_text_contents(size_t *num_tchars_ret)
987 contents = stdin_get_contents(&num_bytes);
990 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
993 #define TO_PERCENT(numerator, denominator) \
994 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
996 /* Given an enumerated value for WIM compression type, return a descriptive
999 get_data_type(int ctype)
1002 case WIMLIB_COMPRESSION_TYPE_NONE:
1003 return T("uncompressed");
1004 case WIMLIB_COMPRESSION_TYPE_LZX:
1005 return T("LZX-compressed");
1006 case WIMLIB_COMPRESSION_TYPE_XPRESS:
1007 return T("XPRESS-compressed");
1012 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1013 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1014 #define KIBIBYTE_MIN_NBYTES 10000ULL
1017 get_unit(uint64_t total_bytes, const tchar **name_ret)
1019 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1020 *name_ret = T("GiB");
1022 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1023 *name_ret = T("MiB");
1025 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1026 *name_ret = T("KiB");
1029 *name_ret = T("bytes");
1034 /* Progress callback function passed to various wimlib functions. */
1036 imagex_progress_func(enum wimlib_progress_msg msg,
1037 const union wimlib_progress_info *info)
1039 unsigned percent_done;
1040 unsigned unit_shift;
1041 const tchar *unit_name;
1042 if (imagex_be_quiet)
1045 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1046 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1047 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1048 info->write_streams.total_bytes);
1050 if (info->write_streams.completed_streams == 0) {
1051 const tchar *data_type;
1053 data_type = get_data_type(info->write_streams.compression_type);
1054 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
1055 data_type, info->write_streams.num_threads,
1056 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1058 if (info->write_streams.total_parts <= 1) {
1059 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1060 "written (%u%% done)"),
1061 info->write_streams.completed_bytes >> unit_shift,
1063 info->write_streams.total_bytes >> unit_shift,
1067 imagex_printf(T("\rWriting resources from part %u of %u: "
1068 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1069 (info->write_streams.completed_parts ==
1070 info->write_streams.total_parts) ?
1071 info->write_streams.completed_parts :
1072 info->write_streams.completed_parts + 1,
1073 info->write_streams.total_parts,
1074 info->write_streams.completed_bytes >> unit_shift,
1076 info->write_streams.total_bytes >> unit_shift,
1080 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1081 imagex_printf(T("\n"));
1083 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1084 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1085 if (*info->scan.wim_target_path) {
1086 imagex_printf(T(" (loading as WIM path: "
1087 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1088 info->scan.wim_target_path);
1090 imagex_printf(T(" (loading as root of WIM image)...\n"));
1093 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1094 switch (info->scan.status) {
1095 case WIMLIB_SCAN_DENTRY_OK:
1096 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1098 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1099 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1101 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1102 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1103 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1107 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1108 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1109 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1110 info->integrity.total_bytes);
1111 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1112 "of %"PRIu64" %"TS" (%u%%) done"),
1113 info->integrity.filename,
1114 info->integrity.completed_bytes >> unit_shift,
1116 info->integrity.total_bytes >> unit_shift,
1119 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1120 imagex_printf(T("\n"));
1122 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1123 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1124 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1125 info->integrity.total_bytes);
1126 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1127 "of %"PRIu64" %"TS" (%u%%) done"),
1128 info->integrity.completed_bytes >> unit_shift,
1130 info->integrity.total_bytes >> unit_shift,
1133 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1134 imagex_printf(T("\n"));
1136 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1137 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1138 "to %"TS" \"%"TS"\"\n"),
1139 info->extract.image,
1140 info->extract.image_name,
1141 info->extract.wimfile_name,
1142 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1143 T("NTFS volume") : T("directory")),
1144 info->extract.target);
1146 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1147 imagex_printf(T("Extracting "
1148 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1149 "in \"%"TS"\" to \"%"TS"\"\n"),
1150 info->extract.extract_root_wim_source_path,
1151 info->extract.image,
1152 info->extract.image_name,
1153 info->extract.wimfile_name,
1154 info->extract.target);
1156 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1157 percent_done = TO_PERCENT(info->extract.completed_bytes,
1158 info->extract.total_bytes);
1159 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1160 imagex_printf(T("\rExtracting files: "
1161 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1162 info->extract.completed_bytes >> unit_shift,
1164 info->extract.total_bytes >> unit_shift,
1167 if (info->extract.completed_bytes >= info->extract.total_bytes)
1168 imagex_printf(T("\n"));
1170 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1171 if (info->extract.total_parts != 1) {
1172 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1173 info->extract.part_number,
1174 info->extract.total_parts);
1177 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1178 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1179 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1181 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1182 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1183 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1184 info->extract.target);
1187 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1188 percent_done = TO_PERCENT(info->split.completed_bytes,
1189 info->split.total_bytes);
1190 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1191 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1192 "%"PRIu64" %"TS" (%u%%) written\n"),
1193 info->split.part_name,
1194 info->split.cur_part_number,
1195 info->split.total_parts,
1196 info->split.completed_bytes >> unit_shift,
1198 info->split.total_bytes >> unit_shift,
1202 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1203 if (info->split.completed_bytes == info->split.total_bytes) {
1204 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1205 info->split.cur_part_number,
1206 info->split.total_parts);
1209 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1210 switch (info->update.command->op) {
1211 case WIMLIB_UPDATE_OP_DELETE:
1212 imagex_printf(T("Deleted WIM path "
1213 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1214 info->update.command->delete_.wim_path);
1216 case WIMLIB_UPDATE_OP_RENAME:
1217 imagex_printf(T("Renamed WIM path "
1218 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1219 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1220 info->update.command->rename.wim_source_path,
1221 info->update.command->rename.wim_target_path);
1223 case WIMLIB_UPDATE_OP_ADD:
1231 fflush(imagex_info_file);
1236 parse_num_threads(const tchar *optarg)
1239 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1240 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1241 imagex_error(T("Number of threads must be a non-negative integer!"));
1249 * Parse an option passed to an update command.
1251 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1254 * @option: Text string for the option (beginning with --)
1256 * @cmd: `struct wimlib_update_command' that is being constructed for
1259 * Returns true if the option was recognized; false if not.
1262 update_command_add_option(int op, const tchar *option,
1263 struct wimlib_update_command *cmd)
1265 bool recognized = true;
1267 case WIMLIB_UPDATE_OP_ADD:
1268 if (!tstrcmp(option, T("--verbose")))
1269 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1270 else if (!tstrcmp(option, T("--unix-data")))
1271 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1272 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1273 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1274 else if (!tstrcmp(option, T("--strict-acls")))
1275 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1276 else if (!tstrcmp(option, T("--dereference")))
1277 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1281 case WIMLIB_UPDATE_OP_DELETE:
1282 if (!tstrcmp(option, T("--force")))
1283 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1284 else if (!tstrcmp(option, T("--recursive")))
1285 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1296 /* How many nonoption arguments each `imagex update' command expects */
1297 static const unsigned update_command_num_nonoptions[] = {
1298 [WIMLIB_UPDATE_OP_ADD] = 2,
1299 [WIMLIB_UPDATE_OP_DELETE] = 1,
1300 [WIMLIB_UPDATE_OP_RENAME] = 2,
1304 update_command_add_nonoption(int op, const tchar *nonoption,
1305 struct wimlib_update_command *cmd,
1306 unsigned num_nonoptions)
1309 case WIMLIB_UPDATE_OP_ADD:
1310 if (num_nonoptions == 0)
1311 cmd->add.fs_source_path = (tchar*)nonoption;
1313 cmd->add.wim_target_path = (tchar*)nonoption;
1315 case WIMLIB_UPDATE_OP_DELETE:
1316 cmd->delete_.wim_path = (tchar*)nonoption;
1318 case WIMLIB_UPDATE_OP_RENAME:
1319 if (num_nonoptions == 0)
1320 cmd->rename.wim_source_path = (tchar*)nonoption;
1322 cmd->rename.wim_target_path = (tchar*)nonoption;
1328 * Parse a command passed on stdin to `imagex update'.
1330 * @line: Text of the command.
1331 * @len: Length of the line, including a null terminator
1334 * @command: A `struct wimlib_update_command' to fill in from the parsed
1337 * @line_number: Line number of the command, for diagnostics.
1339 * Returns true on success; returns false on parse error.
1342 parse_update_command(tchar *line, size_t len,
1343 struct wimlib_update_command *command,
1347 tchar *command_name;
1349 size_t num_nonoptions;
1351 /* Get the command name ("add", "delete", "rename") */
1352 ret = parse_string(&line, &len, &command_name);
1353 if (ret != PARSE_STRING_SUCCESS)
1356 if (!tstrcasecmp(command_name, T("add"))) {
1357 op = WIMLIB_UPDATE_OP_ADD;
1358 } else if (!tstrcasecmp(command_name, T("delete"))) {
1359 op = WIMLIB_UPDATE_OP_DELETE;
1360 } else if (!tstrcasecmp(command_name, T("rename"))) {
1361 op = WIMLIB_UPDATE_OP_RENAME;
1363 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1364 command_name, line_number);
1369 /* Parse additional options and non-options as needed */
1374 ret = parse_string(&line, &len, &next_string);
1375 if (ret == PARSE_STRING_NONE) /* End of line */
1377 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1379 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1381 if (!update_command_add_option(op, next_string, command))
1383 imagex_error(T("Unrecognized option \"%"TS"\" to "
1384 "update command \"%"TS"\" on line %zu"),
1385 next_string, command_name, line_number);
1391 if (num_nonoptions == update_command_num_nonoptions[op])
1393 imagex_error(T("Unexpected argument \"%"TS"\" in "
1394 "update command on line %zu\n"
1395 " (The \"%"TS"\" command only "
1396 "takes %zu nonoption arguments!)\n"),
1397 next_string, line_number,
1398 command_name, num_nonoptions);
1401 update_command_add_nonoption(op, next_string,
1402 command, num_nonoptions);
1407 if (num_nonoptions != update_command_num_nonoptions[op]) {
1408 imagex_error(T("Not enough arguments to update command "
1409 "\"%"TS"\" on line %zu"), command_name, line_number);
1415 static struct wimlib_update_command *
1416 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1417 size_t *num_cmds_ret)
1421 struct wimlib_update_command *cmds;
1424 nlines = text_file_count_lines(cmd_file_contents_p,
1429 /* Always allocate at least 1 slot, just in case the implementation of
1430 * calloc() returns NULL if 0 bytes are requested. */
1431 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1433 imagex_error(T("out of memory"));
1436 p = *cmd_file_contents_p;
1438 for (i = 0; i < nlines; i++) {
1439 /* XXX: Could use rawmemchr() here instead, but it may not be
1440 * available on all platforms. */
1441 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1442 size_t len = endp - p + 1;
1444 if (!is_comment_line(p, len)) {
1445 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1456 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1457 * one image from a WIM file to a NTFS volume. */
1459 imagex_apply(int argc, tchar **argv, int cmd)
1463 int image = WIMLIB_NO_IMAGE;
1465 struct wimlib_wim_info info;
1467 const tchar *wimfile;
1468 const tchar *target;
1469 const tchar *image_num_or_name = NULL;
1470 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1472 STRING_SET(refglobs);
1474 for_opt(c, apply_options) {
1476 case IMAGEX_CHECK_OPTION:
1477 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1479 case IMAGEX_HARDLINK_OPTION:
1480 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1482 case IMAGEX_SYMLINK_OPTION:
1483 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1485 case IMAGEX_VERBOSE_OPTION:
1486 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1488 case IMAGEX_REF_OPTION:
1489 ret = string_set_append(&refglobs, optarg);
1491 goto out_free_refglobs;
1493 case IMAGEX_UNIX_DATA_OPTION:
1494 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1496 case IMAGEX_NO_ACLS_OPTION:
1497 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1499 case IMAGEX_STRICT_ACLS_OPTION:
1500 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1502 case IMAGEX_NORPFIX_OPTION:
1503 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1505 case IMAGEX_RPFIX_OPTION:
1506 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1508 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1509 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1510 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1512 case IMAGEX_RESUME_OPTION:
1513 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1521 if (argc != 2 && argc != 3)
1526 if (!tstrcmp(wimfile, T("-"))) {
1527 /* Attempt to apply pipable WIM from standard input. */
1529 image_num_or_name = NULL;
1532 image_num_or_name = argv[1];
1537 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1538 imagex_progress_func);
1540 goto out_free_refglobs;
1542 wimlib_get_wim_info(wim, &info);
1545 /* Image explicitly specified. */
1546 image_num_or_name = argv[1];
1547 image = wimlib_resolve_image(wim, image_num_or_name);
1548 ret = verify_image_exists(image, image_num_or_name, wimfile);
1550 goto out_wimlib_free;
1553 /* No image specified; default to image 1, but only if the WIM
1554 * contains exactly one image. */
1556 if (info.image_count != 1) {
1557 imagex_error(T("\"%"TS"\" contains %d images; "
1558 "Please select one (or all)."),
1559 wimfile, info.image_count);
1568 if (refglobs.num_strings) {
1570 imagex_error(T("Can't specify --ref when applying from stdin!"));
1572 goto out_wimlib_free;
1574 ret = wim_reference_globs(wim, &refglobs, open_flags);
1576 goto out_wimlib_free;
1581 /* Interpret a regular file or block device target as a NTFS
1585 if (tstat(target, &stbuf)) {
1586 if (errno != ENOENT) {
1587 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1590 goto out_wimlib_free;
1593 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1594 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1600 ret = wimlib_extract_image(wim, image, target, extract_flags,
1601 imagex_progress_func);
1603 set_fd_to_binary_mode(STDIN_FILENO);
1604 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1606 target, extract_flags,
1607 imagex_progress_func);
1610 imagex_printf(T("Done applying WIM image.\n"));
1611 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1613 do_resource_not_found_warning(wimfile, &info, &refglobs);
1615 imagex_error(T( "If you are applying an image "
1616 "from a split pipable WIM,\n"
1617 " make sure you have "
1618 "concatenated together all parts."));
1624 string_set_destroy(&refglobs);
1628 usage(CMD_APPLY, stderr);
1630 goto out_free_refglobs;
1633 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1634 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1635 * the desired image. 'wimlib-imagex append': add a new image to an existing
1638 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1641 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1642 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1643 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1644 int write_flags = 0;
1645 int compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1646 const tchar *wimfile;
1650 const tchar *flags_element = NULL;
1653 STRING_SET(base_wimfiles);
1654 WIMStruct **base_wims;
1656 WIMStruct *template_wim;
1657 const tchar *template_wimfile = NULL;
1658 const tchar *template_image_name_or_num = NULL;
1659 int template_image = WIMLIB_NO_IMAGE;
1662 unsigned num_threads = 0;
1667 const tchar *config_file = NULL;
1669 struct wimlib_capture_config *config;
1671 bool source_list = false;
1672 size_t source_list_nchars = 0;
1673 tchar *source_list_contents;
1674 bool capture_sources_malloced;
1675 struct wimlib_capture_source *capture_sources;
1677 bool name_defaulted;
1679 for_opt(c, capture_or_append_options) {
1681 case IMAGEX_BOOT_OPTION:
1682 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1684 case IMAGEX_CHECK_OPTION:
1685 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1686 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1688 case IMAGEX_NOCHECK_OPTION:
1689 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1691 case IMAGEX_CONFIG_OPTION:
1692 config_file = optarg;
1693 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1695 case IMAGEX_COMPRESS_OPTION:
1696 compression_type = get_compression_type(optarg);
1697 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1700 case IMAGEX_COMPRESS_SLOW_OPTION:
1701 write_flags |= WIMLIB_WRITE_FLAG_COMPRESS_SLOW;
1703 case IMAGEX_FLAGS_OPTION:
1704 flags_element = optarg;
1706 case IMAGEX_DEREFERENCE_OPTION:
1707 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1709 case IMAGEX_VERBOSE_OPTION:
1710 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1712 case IMAGEX_THREADS_OPTION:
1713 num_threads = parse_num_threads(optarg);
1714 if (num_threads == UINT_MAX)
1717 case IMAGEX_REBUILD_OPTION:
1718 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1720 case IMAGEX_UNIX_DATA_OPTION:
1721 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1723 case IMAGEX_SOURCE_LIST_OPTION:
1726 case IMAGEX_NO_ACLS_OPTION:
1727 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1729 case IMAGEX_STRICT_ACLS_OPTION:
1730 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1732 case IMAGEX_RPFIX_OPTION:
1733 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1735 case IMAGEX_NORPFIX_OPTION:
1736 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1738 case IMAGEX_PIPABLE_OPTION:
1739 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1741 case IMAGEX_NOT_PIPABLE_OPTION:
1742 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1744 case IMAGEX_UPDATE_OF_OPTION:
1745 if (template_image_name_or_num) {
1746 imagex_error(T("'--update-of' can only be "
1747 "specified one time!"));
1751 colon = tstrrchr(optarg, T(':'));
1754 template_wimfile = optarg;
1756 template_image_name_or_num = colon + 1;
1758 template_wimfile = NULL;
1759 template_image_name_or_num = optarg;
1763 case IMAGEX_DELTA_FROM_OPTION:
1764 if (cmd != CMD_CAPTURE) {
1765 imagex_error(T("'--delta-from' is only "
1766 "valid for capture!"));
1769 ret = string_set_append(&base_wimfiles, optarg);
1771 goto out_free_base_wimfiles;
1772 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1781 if (argc < 2 || argc > 4)
1787 if (!tstrcmp(wimfile, T("-"))) {
1788 /* Writing captured WIM to standard output. */
1790 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1791 imagex_error("Can't write a non-pipable WIM to "
1792 "standard output! Specify --pipable\n"
1793 " if you want to create a pipable WIM "
1794 "(but read the docs first).");
1798 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1800 if (cmd == CMD_APPEND) {
1801 imagex_error(T("Using standard output for append does "
1802 "not make sense."));
1805 wim_fd = STDOUT_FILENO;
1807 imagex_info_file = stderr;
1808 set_fd_to_binary_mode(wim_fd);
1811 /* If template image was specified using --update-of=IMAGE rather
1812 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1813 if (template_image_name_or_num && !template_wimfile) {
1814 if (base_wimfiles.num_strings == 1) {
1815 /* Capturing delta WIM based on single WIM: default to
1817 template_wimfile = base_wimfiles.strings[0];
1818 } else if (cmd == CMD_APPEND) {
1819 /* Appending to WIM: default to WIM being appended to.
1821 template_wimfile = wimfile;
1823 /* Capturing a normal (non-delta) WIM, so the WIM file
1824 * *must* be explicitly specified. */
1825 if (base_wimfiles.num_strings > 1) {
1826 imagex_error(T("For capture of delta WIM "
1827 "based on multiple existing "
1829 " '--update-of' must "
1830 "specify WIMFILE:IMAGE!"));
1832 imagex_error(T("For capture of non-delta WIM, "
1833 "'--update-of' must specify "
1842 name_defaulted = false;
1844 /* Set default name to SOURCE argument, omitting any directory
1845 * prefixes and trailing slashes. This requires making a copy
1846 * of @source. Leave some free characters at the end in case we
1847 * append a number to keep the name unique. */
1848 size_t source_name_len;
1850 source_name_len = tstrlen(source);
1851 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1852 name = tbasename(tstrcpy(source_copy, source));
1853 name_defaulted = true;
1855 /* Image description defaults to NULL if not given. */
1862 /* Set up capture sources in source list mode */
1863 if (source[0] == T('-') && source[1] == T('\0')) {
1864 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1866 source_list_contents = file_get_text_contents(source,
1867 &source_list_nchars);
1869 if (!source_list_contents)
1872 capture_sources = parse_source_list(&source_list_contents,
1875 if (!capture_sources) {
1877 goto out_free_source_list_contents;
1879 capture_sources_malloced = true;
1881 /* Set up capture source in non-source-list mode. */
1882 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1883 capture_sources[0].fs_source_path = source;
1884 capture_sources[0].wim_target_path = NULL;
1885 capture_sources[0].reserved = 0;
1887 capture_sources_malloced = false;
1888 source_list_contents = NULL;
1892 /* Read and parse capture configuration file. */
1895 config_str = file_get_text_contents(config_file, &config_len);
1898 goto out_free_capture_sources;
1901 config = alloca(sizeof(*config));
1902 ret = parse_capture_config(&config_str, config_len, config);
1904 goto out_free_config;
1906 /* No capture configuration file specified; use default
1907 * configuration for capturing Windows operating systems. */
1909 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1912 /* Open the existing WIM, or create a new one. */
1913 if (cmd == CMD_APPEND)
1914 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1915 imagex_progress_func);
1917 ret = wimlib_create_new_wim(compression_type, &wim);
1919 goto out_free_config;
1922 /* Detect if source is regular file or block device and set NTFS volume
1927 if (tstat(source, &stbuf) == 0) {
1928 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1929 imagex_printf(T("Capturing WIM image from NTFS "
1930 "filesystem on \"%"TS"\"\n"), source);
1931 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1934 if (errno != ENOENT) {
1935 imagex_error_with_errno(T("Failed to stat "
1936 "\"%"TS"\""), source);
1944 /* If the user did not specify an image name, and the basename of the
1945 * source already exists as an image name in the WIM file, append a
1946 * suffix to make it unique. */
1947 if (cmd == CMD_APPEND && name_defaulted) {
1948 unsigned long conflict_idx;
1949 tchar *name_end = tstrchr(name, T('\0'));
1950 for (conflict_idx = 1;
1951 wimlib_image_name_in_use(wim, name);
1954 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1958 /* If capturing a delta WIM, reference resources from the base WIMs
1959 * before adding the new image. */
1960 if (base_wimfiles.num_strings) {
1961 base_wims = calloc(base_wimfiles.num_strings,
1962 sizeof(base_wims[0]));
1963 if (base_wims == NULL) {
1964 imagex_error(T("Out of memory!"));
1969 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
1970 ret = wimlib_open_wim(base_wimfiles.strings[i],
1971 open_flags, &base_wims[i],
1972 imagex_progress_func);
1974 goto out_free_base_wims;
1978 ret = wimlib_reference_resources(wim, base_wims,
1979 base_wimfiles.num_strings, 0);
1981 goto out_free_base_wims;
1983 if (base_wimfiles.num_strings == 1) {
1984 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
1985 base_wimfiles.strings[0]);
1987 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
1988 base_wimfiles.num_strings);
1995 /* If capturing or appending as an update of an existing (template) image,
1996 * open the WIM if needed and parse the image index. */
1997 if (template_image_name_or_num) {
2000 if (base_wimfiles.num_strings == 1 &&
2001 template_wimfile == base_wimfiles.strings[0]) {
2002 template_wim = base_wims[0];
2003 } else if (template_wimfile == wimfile) {
2006 ret = wimlib_open_wim(template_wimfile, open_flags,
2007 &template_wim, imagex_progress_func);
2009 goto out_free_base_wims;
2012 template_image = wimlib_resolve_image(template_wim,
2013 template_image_name_or_num);
2015 if (template_image_name_or_num[0] == T('-')) {
2018 struct wimlib_wim_info info;
2020 wimlib_get_wim_info(template_wim, &info);
2021 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2022 if (n >= 1 && n <= info.image_count &&
2024 tmp != template_image_name_or_num + 1)
2026 template_image = info.image_count - (n - 1);
2029 ret = verify_image_exists_and_is_single(template_image,
2030 template_image_name_or_num,
2033 goto out_free_template_wim;
2035 template_wim = NULL;
2038 ret = wimlib_add_image_multisource(wim,
2044 imagex_progress_func);
2046 goto out_free_template_wim;
2048 if (desc || flags_element || template_image_name_or_num) {
2049 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2050 * on which the added one is to be based has been specified with
2051 * --update-of. Get the index of the image we just
2052 * added, then use it to call the appropriate functions. */
2053 struct wimlib_wim_info info;
2055 wimlib_get_wim_info(wim, &info);
2058 ret = wimlib_set_image_descripton(wim,
2062 goto out_free_template_wim;
2065 if (flags_element) {
2066 ret = wimlib_set_image_flags(wim, info.image_count,
2069 goto out_free_template_wim;
2072 /* Reference template image if the user provided one. */
2073 if (template_image_name_or_num) {
2074 imagex_printf(T("Using image %d "
2075 "from \"%"TS"\" as template\n"),
2076 template_image, template_wimfile);
2077 ret = wimlib_reference_template_image(wim,
2083 goto out_free_template_wim;
2087 /* Write the new WIM or overwrite the existing WIM with the new image
2089 if (cmd == CMD_APPEND) {
2090 ret = wimlib_overwrite(wim, write_flags, num_threads,
2091 imagex_progress_func);
2092 } else if (wimfile) {
2093 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2094 write_flags, num_threads,
2095 imagex_progress_func);
2097 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2098 write_flags, num_threads,
2099 imagex_progress_func);
2101 out_free_template_wim:
2102 /* template_wim may alias base_wims[0] or wim. */
2103 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2104 template_wim != wim)
2105 wimlib_free(template_wim);
2107 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2108 wimlib_free(base_wims[i]);
2114 free(config->exclusion_pats.pats);
2115 free(config->exclusion_exception_pats.pats);
2118 out_free_capture_sources:
2119 if (capture_sources_malloced)
2120 free(capture_sources);
2121 out_free_source_list_contents:
2122 free(source_list_contents);
2123 out_free_base_wimfiles:
2124 string_set_destroy(&base_wimfiles);
2131 goto out_free_base_wimfiles;
2134 /* Remove image(s) from a WIM. */
2136 imagex_delete(int argc, tchar **argv, int cmd)
2139 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2140 int write_flags = 0;
2141 const tchar *wimfile;
2142 const tchar *image_num_or_name;
2147 for_opt(c, delete_options) {
2149 case IMAGEX_CHECK_OPTION:
2150 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2151 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2153 case IMAGEX_SOFT_OPTION:
2154 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2165 imagex_error(T("Must specify a WIM file"));
2167 imagex_error(T("Must specify an image"));
2171 image_num_or_name = argv[1];
2173 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2174 imagex_progress_func);
2178 image = wimlib_resolve_image(wim, image_num_or_name);
2180 ret = verify_image_exists(image, image_num_or_name, wimfile);
2182 goto out_wimlib_free;
2184 ret = wimlib_delete_image(wim, image);
2186 imagex_error(T("Failed to delete image from \"%"TS"\""),
2188 goto out_wimlib_free;
2191 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2193 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2194 "deleted"), wimfile);
2202 usage(CMD_DELETE, stderr);
2208 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2210 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2211 return (ret >= 0) ? 0 : -1;
2214 /* Print the files contained in an image(s) in a WIM file. */
2216 imagex_dir(int argc, tchar **argv, int cmd)
2218 const tchar *wimfile;
2219 WIMStruct *wim = NULL;
2222 const tchar *path = T("");
2225 for_opt(c, dir_options) {
2227 case IMAGEX_PATH_OPTION:
2238 imagex_error(T("Must specify a WIM file"));
2242 imagex_error(T("Too many arguments"));
2247 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2252 image = wimlib_resolve_image(wim, argv[1]);
2253 ret = verify_image_exists(image, argv[1], wimfile);
2255 goto out_wimlib_free;
2257 /* No image specified; default to image 1, but only if the WIM
2258 * contains exactly one image. */
2260 struct wimlib_wim_info info;
2262 wimlib_get_wim_info(wim, &info);
2263 if (info.image_count != 1) {
2264 imagex_error(T("\"%"TS"\" contains %d images; Please "
2265 "select one (or all)."),
2266 wimfile, info.image_count);
2273 ret = wimlib_iterate_dir_tree(wim, image, path,
2274 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2275 print_full_path, NULL);
2282 usage(CMD_DIR, stderr);
2287 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2290 imagex_export(int argc, tchar **argv, int cmd)
2294 int export_flags = 0;
2295 int write_flags = 0;
2296 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2297 const tchar *src_wimfile;
2298 const tchar *src_image_num_or_name;
2299 const tchar *dest_wimfile;
2301 const tchar *dest_name;
2302 const tchar *dest_desc;
2304 struct wimlib_wim_info src_info;
2305 WIMStruct *dest_wim;
2310 STRING_SET(refglobs);
2311 unsigned num_threads = 0;
2313 for_opt(c, export_options) {
2315 case IMAGEX_BOOT_OPTION:
2316 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2318 case IMAGEX_CHECK_OPTION:
2319 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2320 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2322 case IMAGEX_NOCHECK_OPTION:
2323 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2325 case IMAGEX_COMPRESS_OPTION:
2326 compression_type = get_compression_type(optarg);
2327 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2330 case IMAGEX_REF_OPTION:
2331 ret = string_set_append(&refglobs, optarg);
2333 goto out_free_refglobs;
2335 case IMAGEX_THREADS_OPTION:
2336 num_threads = parse_num_threads(optarg);
2337 if (num_threads == UINT_MAX)
2340 case IMAGEX_REBUILD_OPTION:
2341 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2343 case IMAGEX_PIPABLE_OPTION:
2344 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2346 case IMAGEX_NOT_PIPABLE_OPTION:
2347 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2355 if (argc < 3 || argc > 5)
2357 src_wimfile = argv[0];
2358 src_image_num_or_name = argv[1];
2359 dest_wimfile = argv[2];
2360 dest_name = (argc >= 4) ? argv[3] : NULL;
2361 dest_desc = (argc >= 5) ? argv[4] : NULL;
2362 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2363 imagex_progress_func);
2365 goto out_free_refglobs;
2367 wimlib_get_wim_info(src_wim, &src_info);
2369 /* Determine if the destination is an existing file or not. If so, we
2370 * try to append the exported image(s) to it; otherwise, we create a new
2371 * WIM containing the exported image(s). Furthermore, determine if we
2372 * need to write a pipable WIM directly to standard output. */
2374 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2376 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2377 imagex_error("Can't write a non-pipable WIM to "
2378 "standard output! Specify --pipable\n"
2379 " if you want to create a pipable WIM "
2380 "(but read the docs first).");
2382 goto out_free_src_wim;
2385 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2387 dest_wimfile = NULL;
2388 dest_wim_fd = STDOUT_FILENO;
2389 imagex_info_file = stderr;
2390 set_fd_to_binary_mode(dest_wim_fd);
2393 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2395 /* Destination file exists. */
2397 if (!S_ISREG(stbuf.st_mode)) {
2398 imagex_error(T("\"%"TS"\" is not a regular file"),
2401 goto out_free_src_wim;
2403 ret = wimlib_open_wim(dest_wimfile,
2404 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2405 &dest_wim, imagex_progress_func);
2407 goto out_free_src_wim;
2409 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2410 /* The user specified a compression type, but we're
2411 * exporting to an existing WIM. Make sure the
2412 * specified compression type is the same as the
2413 * compression type of the existing destination WIM. */
2414 struct wimlib_wim_info dest_info;
2416 wimlib_get_wim_info(dest_wim, &dest_info);
2417 if (compression_type != dest_info.compression_type) {
2418 imagex_error(T("Cannot specify a compression type that is "
2419 "not the same as that used in the "
2420 "destination WIM"));
2422 goto out_free_dest_wim;
2428 if (errno != ENOENT) {
2429 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2432 goto out_free_src_wim;
2435 /* dest_wimfile is not an existing file, so create a new WIM. */
2437 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2438 /* The user did not specify a compression type; default
2439 * to that of the source WIM. */
2441 compression_type = src_info.compression_type;
2443 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2445 goto out_free_src_wim;
2448 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2449 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2451 goto out_free_dest_wim;
2453 if (refglobs.num_strings) {
2454 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2456 goto out_free_dest_wim;
2459 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2460 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2462 imagex_error(T("--boot specified for all-images export, but source WIM "
2463 "has no bootable image."));
2465 goto out_free_dest_wim;
2468 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2469 dest_desc, export_flags, imagex_progress_func);
2471 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2472 do_resource_not_found_warning(src_wimfile,
2473 &src_info, &refglobs);
2475 goto out_free_dest_wim;
2479 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2480 imagex_progress_func);
2481 else if (dest_wimfile)
2482 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2483 write_flags, num_threads,
2484 imagex_progress_func);
2486 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2487 WIMLIB_ALL_IMAGES, write_flags,
2488 num_threads, imagex_progress_func);
2490 wimlib_free(dest_wim);
2492 wimlib_free(src_wim);
2494 string_set_destroy(&refglobs);
2498 usage(CMD_EXPORT, stderr);
2501 goto out_free_refglobs;
2505 is_root_wim_path(const tchar *path)
2508 for (p = path; *p; p++)
2509 if (*p != T('\\') && *p != T('/'))
2515 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2516 const tchar *dest_dir)
2518 for (size_t i = 0; i < num_cmds; i++)
2519 if (cmds[i].fs_dest_path != dest_dir)
2520 free(cmds[i].fs_dest_path);
2524 static struct wimlib_extract_command *
2525 prepare_extract_commands(tchar **paths, unsigned num_paths,
2526 int extract_flags, tchar *dest_dir,
2527 size_t *num_cmds_ret)
2529 struct wimlib_extract_command *cmds;
2531 tchar *emptystr = T("");
2533 if (num_paths == 0) {
2537 num_cmds = num_paths;
2538 cmds = calloc(num_cmds, sizeof(cmds[0]));
2540 imagex_error(T("Out of memory!"));
2544 for (size_t i = 0; i < num_cmds; i++) {
2545 cmds[i].extract_flags = extract_flags;
2546 cmds[i].wim_source_path = paths[i];
2547 if (is_root_wim_path(paths[i])) {
2548 cmds[i].fs_dest_path = dest_dir;
2550 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2551 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2552 if (!cmds[i].fs_dest_path) {
2553 free_extract_commands(cmds, num_cmds, dest_dir);
2556 tsprintf(cmds[i].fs_dest_path,
2557 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2558 dest_dir, tbasename(paths[i]));
2561 *num_cmds_ret = num_cmds;
2565 /* Extract files or directories from a WIM image */
2567 imagex_extract(int argc, tchar **argv, int cmd)
2574 const tchar *wimfile;
2575 const tchar *image_num_or_name;
2576 tchar *dest_dir = T(".");
2577 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2579 STRING_SET(refglobs);
2581 struct wimlib_extract_command *cmds;
2584 for_opt(c, extract_options) {
2586 case IMAGEX_CHECK_OPTION:
2587 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2589 case IMAGEX_VERBOSE_OPTION:
2590 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2592 case IMAGEX_REF_OPTION:
2593 ret = string_set_append(&refglobs, optarg);
2595 goto out_free_refglobs;
2597 case IMAGEX_UNIX_DATA_OPTION:
2598 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2600 case IMAGEX_NO_ACLS_OPTION:
2601 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2603 case IMAGEX_STRICT_ACLS_OPTION:
2604 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2606 case IMAGEX_DEST_DIR_OPTION:
2609 case IMAGEX_TO_STDOUT_OPTION:
2610 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2611 imagex_info_file = stderr;
2612 imagex_be_quiet = true;
2614 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2615 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2616 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2629 image_num_or_name = argv[1];
2634 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2639 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2643 image = wimlib_resolve_image(wim, image_num_or_name);
2644 ret = verify_image_exists_and_is_single(image,
2648 goto out_wimlib_free;
2650 if (refglobs.num_strings) {
2651 ret = wim_reference_globs(wim, &refglobs, open_flags);
2653 goto out_wimlib_free;
2656 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2657 imagex_progress_func);
2659 if (!imagex_be_quiet)
2660 imagex_printf(T("Done extracting files.\n"));
2661 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2662 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2663 "files and directories\n"
2664 " are in the WIM image.\n"),
2665 get_cmd_string(CMD_INFO, false));
2666 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2667 struct wimlib_wim_info info;
2669 wimlib_get_wim_info(wim, &info);
2670 do_resource_not_found_warning(wimfile, &info, &refglobs);
2675 free_extract_commands(cmds, num_cmds, dest_dir);
2677 string_set_destroy(&refglobs);
2681 usage(CMD_EXTRACT, stderr);
2684 goto out_free_refglobs;
2687 static void print_byte_field(const uint8_t field[], size_t len)
2690 tprintf(T("%02hhx"), *field++);
2694 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2696 tputs(T("WIM Information:"));
2697 tputs(T("----------------"));
2698 tprintf(T("Path: %"TS"\n"), wimfile);
2699 tprintf(T("GUID: 0x"));
2700 print_byte_field(info->guid, sizeof(info->guid));
2702 tprintf(T("Image Count: %d\n"), info->image_count);
2703 tprintf(T("Compression: %"TS"\n"),
2704 wimlib_get_compression_type_string(info->compression_type));
2705 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2706 tprintf(T("Boot Index: %d\n"), info->boot_index);
2707 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2708 tprintf(T("Integrity Info: %"TS"\n"),
2709 info->has_integrity_table ? T("yes") : T("no"));
2710 tprintf(T("Relative path junction: %"TS"\n"),
2711 info->has_rpfix ? T("yes") : T("no"));
2712 tprintf(T("Pipable: %"TS"\n"),
2713 info->pipable ? T("yes") : T("no"));
2718 print_resource(const struct wimlib_resource_entry *resource,
2722 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2723 resource->uncompressed_size);
2725 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2726 resource->compressed_size);
2728 tprintf(T("Offset = %"PRIu64" bytes\n"),
2732 tprintf(T("Part Number = %u\n"), resource->part_number);
2733 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2735 tprintf(T("Hash = 0x"));
2736 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2739 tprintf(T("Flags = "));
2740 if (resource->is_compressed)
2741 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2742 if (resource->is_metadata)
2743 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2744 if (resource->is_free)
2745 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2746 if (resource->is_spanned)
2747 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2754 print_lookup_table(WIMStruct *wim)
2756 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2759 /* Prints information about a WIM file; also can mark an image as bootable,
2760 * change the name of an image, or change the description of an image. */
2762 imagex_info(int argc, tchar **argv, int cmd)
2767 bool nocheck = false;
2768 bool header = false;
2769 bool lookup_table = false;
2771 bool metadata = false;
2772 bool short_header = true;
2773 const tchar *xml_out_file = NULL;
2774 const tchar *wimfile;
2775 const tchar *image_num_or_name;
2776 const tchar *new_name;
2777 const tchar *new_desc;
2782 struct wimlib_wim_info info;
2784 for_opt(c, info_options) {
2786 case IMAGEX_BOOT_OPTION:
2789 case IMAGEX_CHECK_OPTION:
2792 case IMAGEX_NOCHECK_OPTION:
2795 case IMAGEX_HEADER_OPTION:
2797 short_header = false;
2799 case IMAGEX_LOOKUP_TABLE_OPTION:
2800 lookup_table = true;
2801 short_header = false;
2803 case IMAGEX_XML_OPTION:
2805 short_header = false;
2807 case IMAGEX_EXTRACT_XML_OPTION:
2808 xml_out_file = optarg;
2809 short_header = false;
2811 case IMAGEX_METADATA_OPTION:
2813 short_header = false;
2822 if (argc < 1 || argc > 4)
2826 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2827 new_name = (argc >= 3) ? argv[2] : NULL;
2828 new_desc = (argc >= 4) ? argv[3] : NULL;
2830 if (check && nocheck) {
2831 imagex_error(T("Can't specify both --check and --nocheck"));
2836 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2838 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2842 wimlib_get_wim_info(wim, &info);
2844 image = wimlib_resolve_image(wim, image_num_or_name);
2845 ret = WIMLIB_ERR_INVALID_IMAGE;
2846 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2847 verify_image_exists(image, image_num_or_name, wimfile);
2849 imagex_error(T("If you would like to set the boot "
2850 "index to 0, specify image \"0\" with "
2851 "the --boot flag."));
2853 goto out_wimlib_free;
2856 if (boot && info.image_count == 0) {
2857 imagex_error(T("--boot is meaningless on a WIM with no images"));
2858 goto out_wimlib_free;
2861 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2863 imagex_error(T("Cannot specify the --boot flag "
2864 "without specifying a specific "
2865 "image in a multi-image WIM"));
2866 goto out_wimlib_free;
2869 imagex_error(T("Cannot specify the NEW_NAME "
2870 "without specifying a specific "
2871 "image in a multi-image WIM"));
2872 goto out_wimlib_free;
2876 /* Operations that print information are separated from operations that
2877 * recreate the WIM file. */
2878 if (!new_name && !boot) {
2880 /* Read-only operations */
2882 if (image == WIMLIB_NO_IMAGE) {
2883 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2884 image_num_or_name, wimfile);
2885 goto out_wimlib_free;
2888 if (image == WIMLIB_ALL_IMAGES && short_header)
2889 print_wim_information(wimfile, &info);
2892 wimlib_print_header(wim);
2895 if (info.total_parts != 1) {
2896 tfprintf(stderr, T("Warning: Only showing the lookup table "
2897 "for part %d of a %d-part WIM.\n"),
2898 info.part_number, info.total_parts);
2900 print_lookup_table(wim);
2904 ret = wimlib_extract_xml_data(wim, stdout);
2906 goto out_wimlib_free;
2912 fp = tfopen(xml_out_file, T("wb"));
2914 imagex_error_with_errno(T("Failed to open the "
2915 "file \"%"TS"\" for "
2919 goto out_wimlib_free;
2921 ret = wimlib_extract_xml_data(wim, fp);
2923 imagex_error(T("Failed to close the file "
2929 goto out_wimlib_free;
2933 wimlib_print_available_images(wim, image);
2936 ret = wimlib_print_metadata(wim, image);
2938 goto out_wimlib_free;
2943 /* Modification operations */
2945 if (image == WIMLIB_ALL_IMAGES)
2948 if (image == WIMLIB_NO_IMAGE && new_name) {
2949 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2950 "when using image 0"), new_name);
2952 goto out_wimlib_free;
2956 if (image == info.boot_index) {
2957 imagex_printf(T("Image %d is already marked as "
2958 "bootable.\n"), image);
2961 imagex_printf(T("Marking image %d as bootable.\n"),
2963 info.boot_index = image;
2964 ret = wimlib_set_wim_info(wim, &info,
2965 WIMLIB_CHANGE_BOOT_INDEX);
2967 goto out_wimlib_free;
2971 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
2973 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
2977 imagex_printf(T("Changing the name of image %d to "
2978 "\"%"TS"\".\n"), image, new_name);
2979 ret = wimlib_set_image_name(wim, image, new_name);
2981 goto out_wimlib_free;
2985 const tchar *old_desc;
2986 old_desc = wimlib_get_image_description(wim, image);
2987 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2988 imagex_printf(T("The description of image %d is already "
2989 "\"%"TS"\".\n"), image, new_desc);
2992 imagex_printf(T("Changing the description of image %d "
2993 "to \"%"TS"\".\n"), image, new_desc);
2994 ret = wimlib_set_image_descripton(wim, image,
2997 goto out_wimlib_free;
3001 /* Only call wimlib_overwrite() if something actually needs to
3003 if (boot || new_name || new_desc ||
3004 (check && !info.has_integrity_table) ||
3005 (nocheck && info.has_integrity_table))
3007 int write_flags = 0;
3010 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3012 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3013 ret = wimlib_overwrite(wim, write_flags, 1,
3014 imagex_progress_func);
3016 imagex_printf(T("The file \"%"TS"\" was not modified "
3017 "because nothing needed to be done.\n"),
3028 usage(CMD_INFO, stderr);
3034 /* Join split WIMs into one part WIM */
3036 imagex_join(int argc, tchar **argv, int cmd)
3039 int swm_open_flags = 0;
3040 int wim_write_flags = 0;
3041 const tchar *output_path;
3044 for_opt(c, join_options) {
3046 case IMAGEX_CHECK_OPTION:
3047 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3048 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3058 imagex_error(T("Must specify one or more split WIM (.swm) "
3062 output_path = argv[0];
3063 ret = wimlib_join((const tchar * const *)++argv,
3068 imagex_progress_func);
3073 usage(CMD_JOIN, stderr);
3078 #if WIM_MOUNTING_SUPPORTED
3080 /* Mounts a WIM image. */
3082 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3085 int mount_flags = 0;
3087 const tchar *staging_dir = NULL;
3088 const tchar *wimfile;
3091 struct wimlib_wim_info info;
3095 STRING_SET(refglobs);
3097 if (cmd == CMD_MOUNTRW) {
3098 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3099 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3102 for_opt(c, mount_options) {
3104 case IMAGEX_ALLOW_OTHER_OPTION:
3105 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3107 case IMAGEX_CHECK_OPTION:
3108 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3110 case IMAGEX_DEBUG_OPTION:
3111 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3113 case IMAGEX_STREAMS_INTERFACE_OPTION:
3114 if (!tstrcasecmp(optarg, T("none")))
3115 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3116 else if (!tstrcasecmp(optarg, T("xattr")))
3117 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3118 else if (!tstrcasecmp(optarg, T("windows")))
3119 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3121 imagex_error(T("Unknown stream interface \"%"TS"\""),
3126 case IMAGEX_REF_OPTION:
3127 ret = string_set_append(&refglobs, optarg);
3129 goto out_free_refglobs;
3131 case IMAGEX_STAGING_DIR_OPTION:
3132 staging_dir = optarg;
3134 case IMAGEX_UNIX_DATA_OPTION:
3135 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3143 if (argc != 2 && argc != 3)
3148 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3150 goto out_free_refglobs;
3152 wimlib_get_wim_info(wim, &info);
3155 /* Image explicitly specified. */
3156 image = wimlib_resolve_image(wim, argv[1]);
3158 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3162 /* No image specified; default to image 1, but only if the WIM
3163 * contains exactly one image. */
3165 if (info.image_count != 1) {
3166 imagex_error(T("\"%"TS"\" contains %d images; Please "
3167 "select one."), wimfile, info.image_count);
3175 if (refglobs.num_strings) {
3176 ret = wim_reference_globs(wim, &refglobs, open_flags);
3181 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3183 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3185 image, wimfile, dir);
3190 string_set_destroy(&refglobs);
3196 goto out_free_refglobs;
3198 #endif /* WIM_MOUNTING_SUPPORTED */
3200 /* Rebuild a WIM file */
3202 imagex_optimize(int argc, tchar **argv, int cmd)
3205 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3206 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3209 const tchar *wimfile;
3212 unsigned num_threads = 0;
3214 for_opt(c, optimize_options) {
3216 case IMAGEX_CHECK_OPTION:
3217 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3218 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3220 case IMAGEX_NOCHECK_OPTION:
3221 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3223 case IMAGEX_RECOMPRESS_OPTION:
3224 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3226 case IMAGEX_COMPRESS_SLOW_OPTION:
3227 write_flags |= WIMLIB_WRITE_FLAG_COMPRESS_SLOW;
3229 case IMAGEX_THREADS_OPTION:
3230 num_threads = parse_num_threads(optarg);
3231 if (num_threads == UINT_MAX)
3234 case IMAGEX_PIPABLE_OPTION:
3235 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3237 case IMAGEX_NOT_PIPABLE_OPTION:
3238 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3252 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3256 old_size = file_get_size(wimfile);
3257 tprintf(T("\"%"TS"\" original size: "), wimfile);
3259 tputs(T("Unknown"));
3261 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3263 ret = wimlib_overwrite(wim, write_flags, num_threads,
3264 imagex_progress_func);
3266 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3267 goto out_wimlib_free;
3270 new_size = file_get_size(wimfile);
3271 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3273 tputs(T("Unknown"));
3275 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3277 tfputs(T("Space saved: "), stdout);
3278 if (new_size != -1 && old_size != -1) {
3279 tprintf(T("%lld KiB\n"),
3280 ((long long)old_size - (long long)new_size) >> 10);
3282 tputs(T("Unknown"));
3291 usage(CMD_OPTIMIZE, stderr);
3297 /* Split a WIM into a spanned set */
3299 imagex_split(int argc, tchar **argv, int cmd)
3303 int write_flags = 0;
3304 unsigned long part_size;
3309 for_opt(c, split_options) {
3311 case IMAGEX_CHECK_OPTION:
3312 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3313 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3325 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3326 if (tmp == argv[2] || *tmp) {
3327 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3328 imagex_error(T("The part size must be an integer or "
3329 "floating-point number of megabytes."));
3332 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3336 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3342 usage(CMD_SPLIT, stderr);
3348 #if WIM_MOUNTING_SUPPORTED
3349 /* Unmounts a mounted WIM image. */
3351 imagex_unmount(int argc, tchar **argv, int cmd)
3354 int unmount_flags = 0;
3357 for_opt(c, unmount_options) {
3359 case IMAGEX_COMMIT_OPTION:
3360 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3362 case IMAGEX_CHECK_OPTION:
3363 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3365 case IMAGEX_REBUILD_OPTION:
3366 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3368 case IMAGEX_LAZY_OPTION:
3369 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3380 ret = wimlib_unmount_image(argv[0], unmount_flags,
3381 imagex_progress_func);
3383 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3388 usage(CMD_UNMOUNT, stderr);
3392 #endif /* WIM_MOUNTING_SUPPORTED */
3395 * Add, delete, or rename files in a WIM image.
3398 imagex_update(int argc, tchar **argv, int cmd)
3400 const tchar *wimfile;
3404 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3405 int write_flags = 0;
3406 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3407 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
3408 int default_delete_flags = 0;
3409 unsigned num_threads = 0;
3411 tchar *cmd_file_contents;
3412 size_t cmd_file_nchars;
3413 struct wimlib_update_command *cmds;
3415 tchar *command_str = NULL;
3417 const tchar *config_file = NULL;
3419 struct wimlib_capture_config *config;
3421 for_opt(c, update_options) {
3423 /* Generic or write options */
3424 case IMAGEX_THREADS_OPTION:
3425 num_threads = parse_num_threads(optarg);
3426 if (num_threads == UINT_MAX)
3429 case IMAGEX_CHECK_OPTION:
3430 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3431 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3433 case IMAGEX_REBUILD_OPTION:
3434 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3436 case IMAGEX_COMMAND_OPTION:
3438 imagex_error(T("--command may only be specified "
3439 "one time. Please provide\n"
3440 " the update commands "
3441 "on standard input instead."));
3444 command_str = tstrdup(optarg);
3446 imagex_error(T("Out of memory!"));
3450 /* Default delete options */
3451 case IMAGEX_FORCE_OPTION:
3452 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3454 case IMAGEX_RECURSIVE_OPTION:
3455 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3458 /* Global add option */
3459 case IMAGEX_CONFIG_OPTION:
3460 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3461 config_file = optarg;
3464 /* Default add options */
3465 case IMAGEX_VERBOSE_OPTION:
3466 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3468 case IMAGEX_DEREFERENCE_OPTION:
3469 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3471 case IMAGEX_UNIX_DATA_OPTION:
3472 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3474 case IMAGEX_NO_ACLS_OPTION:
3475 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3477 case IMAGEX_STRICT_ACLS_OPTION:
3478 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3487 if (argc != 1 && argc != 2)
3491 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3493 goto out_free_command_str;
3496 /* Image explicitly specified. */
3497 image = wimlib_resolve_image(wim, argv[1]);
3498 ret = verify_image_exists_and_is_single(image, argv[1],
3501 goto out_wimlib_free;
3503 /* No image specified; default to image 1, but only if the WIM
3504 * contains exactly one image. */
3505 struct wimlib_wim_info info;
3507 wimlib_get_wim_info(wim, &info);
3508 if (info.image_count != 1) {
3509 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3510 wimfile, info.image_count);
3517 /* Parse capture configuration file if specified */
3521 config_str = file_get_text_contents(config_file, &config_len);
3524 goto out_wimlib_free;
3527 config = alloca(sizeof(*config));
3528 ret = parse_capture_config(&config_str, config_len, config);
3530 goto out_free_config;
3533 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3536 /* Read update commands from standard input, or the command string if
3539 cmd_file_contents = NULL;
3540 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3543 if (isatty(STDIN_FILENO)) {
3544 tputs(T("Reading update commands from standard input..."));
3545 recommend_man_page(CMD_UPDATE, stdout);
3547 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3548 if (!cmd_file_contents) {
3550 goto out_free_config;
3553 /* Parse the update commands */
3554 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3559 goto out_free_cmd_file_contents;
3562 /* Set default flags and capture config on the update commands */
3563 for (size_t i = 0; i < num_cmds; i++) {
3564 switch (cmds[i].op) {
3565 case WIMLIB_UPDATE_OP_ADD:
3566 cmds[i].add.add_flags |= default_add_flags;
3567 cmds[i].add.config = config;
3569 case WIMLIB_UPDATE_OP_DELETE:
3570 cmds[i].delete_.delete_flags |= default_delete_flags;
3577 /* Execute the update commands */
3578 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3579 imagex_progress_func);
3583 /* Overwrite the updated WIM */
3584 ret = wimlib_overwrite(wim, write_flags, num_threads,
3585 imagex_progress_func);
3588 out_free_cmd_file_contents:
3589 free(cmd_file_contents);
3592 free(config->exclusion_pats.pats);
3593 free(config->exclusion_exception_pats.pats);
3598 out_free_command_str:
3603 usage(CMD_UPDATE, stderr);
3606 goto out_free_command_str;
3611 struct imagex_command {
3613 int (*func)(int argc, tchar **argv, int cmd);
3616 static const struct imagex_command imagex_commands[] = {
3617 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3618 [CMD_APPLY] = {T("apply"), imagex_apply},
3619 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3620 [CMD_DELETE] = {T("delete"), imagex_delete},
3621 [CMD_DIR ] = {T("dir"), imagex_dir},
3622 [CMD_EXPORT] = {T("export"), imagex_export},
3623 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3624 [CMD_INFO] = {T("info"), imagex_info},
3625 [CMD_JOIN] = {T("join"), imagex_join},
3626 #if WIM_MOUNTING_SUPPORTED
3627 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3628 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3630 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3631 [CMD_SPLIT] = {T("split"), imagex_split},
3632 #if WIM_MOUNTING_SUPPORTED
3633 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3635 [CMD_UPDATE] = {T("update"), imagex_update},
3638 static const tchar *usage_strings[] = {
3641 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3642 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3643 " [--check] [--nocheck] [--compress-slow]\n"
3644 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
3645 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3646 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3647 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3651 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3652 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3653 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3654 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3655 " [--include-invalid-names]\n"
3659 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3660 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot]\n"
3661 " [--check] [--nocheck] [--compress=TYPE] [--compress-slow]\n"
3662 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
3663 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3664 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3665 " [--unix-data] [--pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3666 " [--delta-from=WIMFILE]\n"
3670 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3675 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3679 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3680 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3681 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3682 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3683 " [--pipable] [--not-pipable]\n"
3687 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3688 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3689 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3690 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3694 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3695 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3696 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3701 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3703 #if WIM_MOUNTING_SUPPORTED
3706 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3707 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3708 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3712 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3713 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3714 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3719 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3720 " [--compress-slow] [--threads=NUM_THREADS]\n"
3721 " [--pipable] [--not-pipable]\n"
3725 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3727 #if WIM_MOUNTING_SUPPORTED
3730 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3735 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3736 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3737 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3741 static const tchar *invocation_name;
3742 static int invocation_cmd = CMD_NONE;
3744 static const tchar *get_cmd_string(int cmd, bool nospace)
3746 static tchar buf[50];
3747 if (cmd == CMD_NONE) {
3748 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3749 } else if (invocation_cmd != CMD_NONE) {
3750 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3752 const tchar *format;
3755 format = T("%"TS"-%"TS"");
3757 format = T("%"TS" %"TS"");
3758 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3766 static const tchar *s =
3768 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3769 "Copyright (C) 2012, 2013 Eric Biggers\n"
3770 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3771 "This is free software: you are free to change and redistribute it.\n"
3772 "There is NO WARRANTY, to the extent permitted by law.\n"
3774 "Report bugs to "PACKAGE_BUGREPORT".\n"
3781 help_or_version(int argc, tchar **argv, int cmd)
3786 for (i = 1; i < argc; i++) {
3788 if (p[0] == T('-') && p[1] == T('-')) {
3790 if (!tstrcmp(p, T("help"))) {
3791 if (cmd == CMD_NONE)
3796 } else if (!tstrcmp(p, T("version"))) {
3805 print_usage_string(int cmd, FILE *fp)
3807 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3811 recommend_man_page(int cmd, FILE *fp)
3813 const tchar *format_str;
3815 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3817 format_str = T("Try `man %"TS"' for more details.\n");
3819 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3823 usage(int cmd, FILE *fp)
3825 tfprintf(fp, T("Usage:\n"));
3826 print_usage_string(cmd, fp);
3827 tfprintf(fp, T("\n"));
3828 recommend_man_page(cmd, fp);
3834 tfprintf(fp, T("Usage:\n"));
3835 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3836 print_usage_string(cmd, fp);
3837 tfprintf(fp, T("\n"));
3839 static const tchar *extra =
3842 " %"TS" --version\n"
3844 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3847 tfprintf(fp, extra, invocation_name, invocation_name);
3848 recommend_man_page(CMD_NONE, fp);
3851 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3852 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3853 * something else), while an Windows the command arguments will be UTF-16LE
3854 * encoded 'wchar_t' strings. */
3857 wmain(int argc, wchar_t **argv, wchar_t **envp)
3859 main(int argc, char **argv)
3866 imagex_info_file = stdout;
3867 invocation_name = tbasename(argv[0]);
3870 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3871 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3875 setlocale(LC_ALL, "");
3876 codeset = nl_langinfo(CODESET);
3877 if (!strstr(codeset, "UTF-8") &&
3878 !strstr(codeset, "UTF8") &&
3879 !strstr(codeset, "utf-8") &&
3880 !strstr(codeset, "utf8"))
3883 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3884 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3885 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3886 " to any value to force wimlib to use UTF-8.\n",
3891 #endif /* !__WIN32__ */
3893 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3895 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3896 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3897 for (int i = 0; i < CMD_MAX; i++) {
3898 if (!tstrcmp(invocation_name + 3,
3899 imagex_commands[i].name))
3908 /* Unless already known from the invocation name, determine which
3909 * command was specified. */
3910 if (cmd == CMD_NONE) {
3912 imagex_error(T("No command specified!\n"));
3916 for (int i = 0; i < CMD_MAX; i++) {
3917 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3922 if (cmd != CMD_NONE) {
3928 /* Handle --help and --version. --help can be either for the program as
3929 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3930 * CMD_NONE). Note: help_or_version() will not return if a --help or
3931 * --version argument was found. */
3932 help_or_version(argc, argv, cmd);
3934 /* Bail if a valid command was not specified. */
3935 if (cmd == CMD_NONE) {
3936 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3941 /* Enable warning and error messages in wimlib be more user-friendly.
3943 wimlib_set_print_errors(true);
3945 /* Initialize wimlib. */
3946 ret = wimlib_global_init(init_flags);
3948 goto out_check_status;
3950 /* Call the command handler function. */
3951 ret = imagex_commands[cmd].func(argc, argv, cmd);
3953 /* Check for error writing to standard output, especially since for some
3954 * commands, writing to standard output is part of the program's actual
3955 * behavior and not just for informational purposes. */
3956 if (ferror(stdout) || fclose(stdout)) {
3957 imagex_error_with_errno(T("error writing to standard output"));
3962 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3963 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
3964 * error code from which an error message can be printed. */
3966 imagex_error(T("Exiting with error code %d:\n"
3968 wimlib_get_error_string(ret));
3969 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3970 imagex_error_with_errno(T("errno"));
3972 /* Make wimlib free any resources it's holding (although this is not
3973 * strictly necessary because the process is ending anyway). */
3974 wimlib_global_cleanup();