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 tglob win32_wglob
53 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
54 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
58 # include <langinfo.h>
59 # define tbasename basename
61 # define OS_PREFERRED_PATH_SEPARATOR '/'
62 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
63 static inline void set_fd_to_binary_mode(int fd)
68 /* Don't confuse the user by presenting the mounting commands on Windows when
69 * they will never work. However on UNIX-like systems we always present them,
70 * even if WITH_FUSE is not defined at this point, as to not tie the build of
71 * wimlib-imagex to a specific build of wimlib. */
73 # define WIM_MOUNTING_SUPPORTED 0
75 # define WIM_MOUNTING_SUPPORTED 1
78 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
80 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
95 #if WIM_MOUNTING_SUPPORTED
101 #if WIM_MOUNTING_SUPPORTED
108 static void usage(int cmd, FILE *fp);
109 static void usage_all(FILE *fp);
110 static void recommend_man_page(int cmd, FILE *fp);
111 static const tchar *get_cmd_string(int cmd, bool nospace);
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_CONFIG_OPTION,
128 IMAGEX_DEREFERENCE_OPTION,
129 IMAGEX_DEST_DIR_OPTION,
130 IMAGEX_EXTRACT_XML_OPTION,
133 IMAGEX_HARDLINK_OPTION,
134 IMAGEX_HEADER_OPTION,
135 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
137 IMAGEX_LOOKUP_TABLE_OPTION,
138 IMAGEX_METADATA_OPTION,
139 IMAGEX_NORPFIX_OPTION,
140 IMAGEX_NOCHECK_OPTION,
141 IMAGEX_NO_ACLS_OPTION,
142 IMAGEX_NOT_PIPABLE_OPTION,
144 IMAGEX_PIPABLE_OPTION,
145 IMAGEX_REBUILD_OPTION,
146 IMAGEX_RECOMPRESS_OPTION,
147 IMAGEX_RECURSIVE_OPTION,
151 IMAGEX_SOURCE_LIST_OPTION,
152 IMAGEX_STAGING_DIR_OPTION,
153 IMAGEX_STREAMS_INTERFACE_OPTION,
154 IMAGEX_STRICT_ACLS_OPTION,
155 IMAGEX_SYMLINK_OPTION,
156 IMAGEX_THREADS_OPTION,
157 IMAGEX_TO_STDOUT_OPTION,
158 IMAGEX_UNIX_DATA_OPTION,
159 IMAGEX_VERBOSE_OPTION,
163 static const struct option apply_options[] = {
164 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
165 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
166 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
167 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
168 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
169 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
170 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
171 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
172 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
173 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
174 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
175 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
179 static const struct option capture_or_append_options[] = {
180 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
181 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
182 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
183 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
184 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
185 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
186 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
187 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
188 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
189 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
190 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
191 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
192 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
193 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
194 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
195 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
196 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
197 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
198 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
199 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
203 static const struct option delete_options[] = {
204 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
205 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
209 static const struct option dir_options[] = {
210 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
214 static const struct option export_options[] = {
215 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
216 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
217 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
218 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
219 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
220 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
221 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
222 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
223 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
224 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
228 static const struct option extract_options[] = {
229 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
230 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
231 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
232 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
233 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
234 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
235 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
236 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
237 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
238 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
242 static const struct option info_options[] = {
243 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
244 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
245 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
246 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
247 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
248 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
249 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
250 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
251 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
255 static const struct option join_options[] = {
256 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
260 static const struct option mount_options[] = {
261 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
262 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
263 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
264 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
265 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
266 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
267 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
271 static const struct option optimize_options[] = {
272 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
273 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
274 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
275 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
276 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
277 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
278 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
282 static const struct option split_options[] = {
283 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
287 static const struct option unmount_options[] = {
288 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
289 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
290 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
291 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
295 static const struct option update_options[] = {
296 /* Careful: some of the options here set the defaults for update
297 * commands, but the flags given to an actual update command (and not to
298 * `imagex update' itself are also handled in
299 * update_command_add_option(). */
300 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
301 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
302 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
303 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
305 /* Default delete options */
306 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
307 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
309 /* Global add option */
310 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
312 /* Default add options */
313 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
314 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
315 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
316 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
317 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
318 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
324 # define _format_attribute(type, format_str, args_start) \
325 __attribute__((format(type, format_str, args_start)))
327 # define _format_attribute(type, format_str, args_start)
330 /* Print formatted error message to stderr. */
331 static void _format_attribute(printf, 1, 2)
332 imagex_error(const tchar *format, ...)
335 va_start(va, format);
336 tfputs(T("ERROR: "), stderr);
337 tvfprintf(stderr, format, va);
338 tputc(T('\n'), stderr);
342 /* Print formatted error message to stderr. */
343 static void _format_attribute(printf, 1, 2)
344 imagex_error_with_errno(const tchar *format, ...)
346 int errno_save = errno;
348 va_start(va, format);
349 tfputs(T("ERROR: "), stderr);
350 tvfprintf(stderr, format, va);
351 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
356 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
358 if (image == WIMLIB_NO_IMAGE) {
359 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
360 " Please specify a 1-based image index or "
362 " You may use `%"TS"' to list the images "
363 "contained in a WIM."),
364 image_name, wim_name, get_cmd_string(CMD_INFO, false));
371 verify_image_is_single(int image)
373 if (image == WIMLIB_ALL_IMAGES) {
374 imagex_error(T("Cannot specify all images for this action!"));
381 verify_image_exists_and_is_single(int image, const tchar *image_name,
382 const tchar *wim_name)
385 ret = verify_image_exists(image, image_name, wim_name);
387 ret = verify_image_is_single(image);
391 /* Parse the argument to --compress */
393 get_compression_type(const tchar *optarg)
395 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
396 return WIMLIB_COMPRESSION_TYPE_LZX;
397 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
398 return WIMLIB_COMPRESSION_TYPE_XPRESS;
399 else if (!tstrcasecmp(optarg, T("none")))
400 return WIMLIB_COMPRESSION_TYPE_NONE;
402 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
403 "\"maximum\", \"fast\", or \"none\"."), optarg);
404 return WIMLIB_COMPRESSION_TYPE_INVALID;
408 /* Returns the size of a file given its name, or -1 if the file does not exist
409 * or its size cannot be determined. */
411 file_get_size(const tchar *filename)
414 if (tstat(filename, &st) == 0)
420 tchar pat_ntfs_log[] = T("/$ntfs.log");
421 tchar pat_hiberfil_sys[] = T("/hiberfil.sys");
422 tchar pat_pagefile_sys[] = T("/pagefile.sys");
423 tchar pat_system_volume_information[] = T("/System Volume Information");
424 tchar pat_recycler[] = T("/RECYCLER");
425 tchar pat_windows_csc[] = T("/Windows/CSC");
427 tchar *default_pats[] = {
431 pat_system_volume_information,
436 static struct wimlib_capture_config default_capture_config = {
438 .num_pats = sizeof(default_pats) / sizeof(default_pats[0]),
439 .pats = default_pats,
444 PARSE_STRING_SUCCESS = 0,
445 PARSE_STRING_FAILURE = 1,
446 PARSE_STRING_NONE = 2,
450 * Parses a string token from an array of characters.
452 * Tokens are either whitespace-delimited, or double or single-quoted.
454 * @line_p: Pointer to the pointer to the line of data. Will be updated
455 * to point past the string token iff the return value is
456 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
459 * @len_p: @len_p initially stores the length of the line of data, which may
460 * be 0, and it will be updated to the number of bytes remaining in
461 * the line iff the return value is PARSE_STRING_SUCCESS.
463 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
464 * parsed string token will be returned here.
466 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
467 * PARSE_STRING_FAILURE if the data was invalid due to a missing
468 * closing quote; or PARSE_STRING_NONE if the line ended before the
469 * beginning of a string token was found.
472 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
475 tchar *line = *line_p;
479 /* Skip leading whitespace */
482 return PARSE_STRING_NONE;
483 if (!istspace(*line) && *line != T('\0'))
489 if (quote_char == T('"') || quote_char == T('\'')) {
494 line = tmemchr(line, quote_char, len);
496 imagex_error(T("Missing closing quote: %"TS), fn - 1);
497 return PARSE_STRING_FAILURE;
500 /* Unquoted string. Go until whitespace. Line is terminated
501 * by '\0', so no need to check 'len'. */
505 } while (!istspace(*line) && *line != T('\0'));
512 return PARSE_STRING_SUCCESS;
515 /* Parses a line of data (not an empty line or comment) in the source list file
516 * format. (See the man page for 'wimlib-imagex capture' for details on this
517 * format and the meaning.)
519 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
520 * len == 0. The data in @line will be modified by this function call.
522 * @len: Length of the line of data.
524 * @source: On success, the capture source and target described by the line is
525 * written into this destination. Note that it will contain pointers
526 * to data in the @line array.
528 * Returns true if the line was valid; false otherwise. */
530 parse_source_list_line(tchar *line, size_t len,
531 struct wimlib_capture_source *source)
535 ret = parse_string(&line, &len, &source->fs_source_path);
536 if (ret != PARSE_STRING_SUCCESS)
538 ret = parse_string(&line, &len, &source->wim_target_path);
539 if (ret == PARSE_STRING_NONE)
540 source->wim_target_path = source->fs_source_path;
541 return ret != PARSE_STRING_FAILURE;
544 /* Returns %true if the given line of length @len > 0 is a comment or empty line
545 * in the source list file format. */
547 is_comment_line(const tchar *line, size_t len)
552 if (!istspace(*line) && *line != T('\0'))
562 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
565 tchar *contents = *contents_p;
566 size_t nchars = *nchars_p;
569 for (i = 0; i < nchars; i++)
570 if (contents[i] == T('\n'))
573 /* Handle last line not terminated by a newline */
574 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
575 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
577 imagex_error(T("Out of memory!"));
580 contents[nchars] = T('\n');
581 *contents_p = contents;
589 /* Parses a file in the source list format. (See the man page for
590 * 'wimlib-imagex capture' for details on this format and the meaning.)
592 * @source_list_contents: Contents of the source list file. Note that this
593 * buffer will be modified to save memory allocations,
594 * and cannot be freed until the returned array of
595 * wimlib_capture_source's has also been freed.
597 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
600 * @nsources_ret: On success, the length of the returned array is
603 * Returns: An array of `struct wimlib_capture_source's that can be passed to
604 * the wimlib_add_image_multisource() function to specify how a WIM image is to
606 static struct wimlib_capture_source *
607 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
608 size_t *nsources_ret)
612 struct wimlib_capture_source *sources;
615 nlines = text_file_count_lines(source_list_contents_p,
616 &source_list_nchars);
620 /* Always allocate at least 1 slot, just in case the implementation of
621 * calloc() returns NULL if 0 bytes are requested. */
622 sources = calloc(nlines ?: 1, sizeof(*sources));
624 imagex_error(T("out of memory"));
627 p = *source_list_contents_p;
629 for (i = 0; i < nlines; i++) {
630 /* XXX: Could use rawmemchr() here instead, but it may not be
631 * available on all platforms. */
632 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
633 size_t len = endp - p + 1;
635 if (!is_comment_line(p, len)) {
636 if (!parse_source_list_line(p, len, &sources[j++])) {
649 enum capture_config_section {
650 CAPTURE_CONFIG_NO_SECTION,
651 CAPTURE_CONFIG_EXCLUSION_SECTION,
652 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
653 CAPTURE_CONFIG_IGNORE_SECTION,
657 CAPTURE_CONFIG_INVALID_SECTION,
658 CAPTURE_CONFIG_CHANGED_SECTION,
659 CAPTURE_CONFIG_SAME_SECTION,
663 check_config_section(tchar *line, size_t len,
664 enum capture_config_section *cur_section)
666 while (istspace(*line))
670 return CAPTURE_CONFIG_SAME_SECTION;
673 tchar *endbrace = tstrrchr(line, T(']'));
675 return CAPTURE_CONFIG_SAME_SECTION;
677 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
678 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
679 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
680 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
681 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
682 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
683 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
684 "of capture config file\n"),
686 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
687 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
688 tfputs(T("WARNING: Ignoring [AlignmentList] section "
689 "of capture config file\n"),
692 imagex_error(T("Invalid capture config file section \"%"TS"\""),
694 return CAPTURE_CONFIG_INVALID_SECTION;
696 return CAPTURE_CONFIG_CHANGED_SECTION;
701 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
704 if (pat_list->num_pats == pat_list->num_allocated_pats) {
706 size_t num_allocated_pats = pat_list->num_pats + 8;
708 pats = realloc(pat_list->pats,
709 num_allocated_pats * sizeof(pat_list->pats[0]));
711 imagex_error(T("Out of memory!"));
714 pat_list->pats = pats;
715 pat_list->num_allocated_pats = num_allocated_pats;
717 pat_list->pats[pat_list->num_pats++] = pat;
722 parse_capture_config_line(tchar *line, size_t len,
723 enum capture_config_section *cur_section,
724 struct wimlib_capture_config *config)
729 ret = check_config_section(line, len, cur_section);
730 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
732 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
735 switch (*cur_section) {
736 case CAPTURE_CONFIG_NO_SECTION:
737 imagex_error(T("Line \"%"TS"\" is not in a section "
738 "(such as [ExclusionList]"), line);
740 case CAPTURE_CONFIG_EXCLUSION_SECTION:
741 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
743 return pattern_list_add_pattern(&config->exclusion_pats,
745 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
746 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
748 return pattern_list_add_pattern(&config->exclusion_exception_pats,
750 case CAPTURE_CONFIG_IGNORE_SECTION:
757 parse_capture_config(tchar **contents_p, size_t nchars,
758 struct wimlib_capture_config *config)
763 enum capture_config_section cur_section;
765 memset(config, 0, sizeof(*config));
767 nlines = text_file_count_lines(contents_p, &nchars);
771 cur_section = CAPTURE_CONFIG_NO_SECTION;
773 for (i = 0; i < nlines; i++) {
774 tchar *endp = tmemchr(p, T('\n'), nchars);
775 size_t len = endp - p + 1;
777 if (!is_comment_line(p, len))
778 if (!parse_capture_config_line(p, len, &cur_section, config))
786 /* Reads the contents of a file into memory. */
788 file_get_contents(const tchar *filename, size_t *len_ret)
795 if (tstat(filename, &stbuf) != 0) {
796 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
801 fp = tfopen(filename, T("rb"));
803 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
807 buf = malloc(len ? len : 1);
809 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
810 "contents of file \"%"TS"\""), len, filename);
813 if (fread(buf, 1, len, fp) != len) {
814 imagex_error_with_errno(T("Failed to read %zu bytes from the "
815 "file \"%"TS"\""), len, filename);
829 /* Read standard input until EOF and return the full contents in a malloc()ed
830 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
833 stdin_get_contents(size_t *len_ret)
835 /* stdin can, of course, be a pipe or other non-seekable file, so the
836 * total length of the data cannot be pre-determined */
838 size_t newlen = 1024;
842 char *p = realloc(buf, newlen);
843 size_t bytes_read, bytes_to_read;
845 imagex_error(T("out of memory while reading stdin"));
849 bytes_to_read = newlen - pos;
850 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
852 if (bytes_read != bytes_to_read) {
857 imagex_error_with_errno(T("error reading stdin"));
871 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
874 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
876 *num_tchars_ret = num_bytes;
878 #else /* !__WIN32__ */
879 /* On Windows, translate the text to UTF-16LE */
883 if (num_bytes >= 2 &&
884 ((text[0] == 0xff && text[1] == 0xfe) ||
885 (text[0] <= 0x7f && text[1] == 0x00)))
887 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
888 * with something that looks like an ASCII character encoded as
889 * a UTF-16LE code unit. Assume the file is encoded as
890 * UTF-16LE. This is not a 100% reliable check. */
891 num_wchars = num_bytes / 2;
892 text_wstr = (wchar_t*)text;
894 /* File does not look like UTF-16LE. Assume it is encoded in
895 * the current Windows code page. I think these are always
896 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
897 * should work as expected. */
898 text_wstr = win32_mbs_to_wcs(text,
903 *num_tchars_ret = num_wchars;
905 #endif /* __WIN32__ */
909 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
914 contents = file_get_contents(filename, &num_bytes);
917 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
921 stdin_get_text_contents(size_t *num_tchars_ret)
926 contents = stdin_get_contents(&num_bytes);
929 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
932 #define TO_PERCENT(numerator, denominator) \
933 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
935 /* Given an enumerated value for WIM compression type, return a descriptive
938 get_data_type(int ctype)
941 case WIMLIB_COMPRESSION_TYPE_NONE:
942 return T("uncompressed");
943 case WIMLIB_COMPRESSION_TYPE_LZX:
944 return T("LZX-compressed");
945 case WIMLIB_COMPRESSION_TYPE_XPRESS:
946 return T("XPRESS-compressed");
951 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
952 #define MEBIBYTE_MIN_NBYTES 10000000ULL
953 #define KIBIBYTE_MIN_NBYTES 10000ULL
956 get_unit(uint64_t total_bytes, const tchar **name_ret)
958 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
959 *name_ret = T("GiB");
961 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
962 *name_ret = T("MiB");
964 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
965 *name_ret = T("KiB");
968 *name_ret = T("bytes");
973 /* Progress callback function passed to various wimlib functions. */
975 imagex_progress_func(enum wimlib_progress_msg msg,
976 const union wimlib_progress_info *info)
978 unsigned percent_done;
980 const tchar *unit_name;
984 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
985 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
986 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
987 info->write_streams.total_bytes);
988 if (info->write_streams.completed_streams == 0) {
989 const tchar *data_type;
991 data_type = get_data_type(info->write_streams.compression_type);
992 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
993 data_type, info->write_streams.num_threads,
994 (info->write_streams.num_threads == 1) ? T("") : T("s"));
996 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
997 "written (%u%% done)"),
998 info->write_streams.completed_bytes >> unit_shift,
1000 info->write_streams.total_bytes >> unit_shift,
1003 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1004 imagex_printf(T("\n"));
1006 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1007 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1008 if (*info->scan.wim_target_path) {
1009 imagex_printf(T(" (loading as WIM path: "
1010 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1011 info->scan.wim_target_path);
1013 imagex_printf(T(" (loading as root of WIM image)...\n"));
1016 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1017 if (info->scan.excluded)
1018 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1020 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1022 /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
1024 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1025 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1026 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1027 info->integrity.total_bytes);
1028 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1029 "of %"PRIu64" %"TS" (%u%%) done"),
1030 info->integrity.filename,
1031 info->integrity.completed_bytes >> unit_shift,
1033 info->integrity.total_bytes >> unit_shift,
1036 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1037 imagex_printf(T("\n"));
1039 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1040 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1041 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1042 info->integrity.total_bytes);
1043 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1044 "of %"PRIu64" %"TS" (%u%%) done"),
1045 info->integrity.completed_bytes >> unit_shift,
1047 info->integrity.total_bytes >> unit_shift,
1050 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1051 imagex_printf(T("\n"));
1053 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1054 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1055 "to %"TS" \"%"TS"\"\n"),
1056 info->extract.image,
1057 info->extract.image_name,
1058 info->extract.wimfile_name,
1059 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1060 T("NTFS volume") : T("directory")),
1061 info->extract.target);
1063 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1064 imagex_printf(T("Extracting "
1065 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1066 "in \"%"TS"\" to \"%"TS"\"\n"),
1067 info->extract.extract_root_wim_source_path,
1068 info->extract.image,
1069 info->extract.image_name,
1070 info->extract.wimfile_name,
1071 info->extract.target);
1073 /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
1074 /*imagex_printf(T("Applying directory structure to %"TS"\n"),*/
1075 /*info->extract.target);*/
1077 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1078 percent_done = TO_PERCENT(info->extract.completed_bytes,
1079 info->extract.total_bytes);
1080 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1081 imagex_printf(T("\rExtracting files: "
1082 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1083 info->extract.completed_bytes >> unit_shift,
1085 info->extract.total_bytes >> unit_shift,
1088 if (info->extract.completed_bytes >= info->extract.total_bytes)
1089 imagex_printf(T("\n"));
1091 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1092 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1093 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1095 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1096 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1097 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1098 info->extract.target);
1101 case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
1102 percent_done = TO_PERCENT(info->join.completed_bytes,
1103 info->join.total_bytes);
1104 unit_shift = get_unit(info->join.total_bytes, &unit_name);
1105 imagex_printf(T("Writing resources from part %u of %u: "
1106 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written\n"),
1107 (info->join.completed_parts == info->join.total_parts) ?
1108 info->join.completed_parts : info->join.completed_parts + 1,
1109 info->join.total_parts,
1110 info->join.completed_bytes >> unit_shift,
1112 info->join.total_bytes >> unit_shift,
1116 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1117 percent_done = TO_PERCENT(info->split.completed_bytes,
1118 info->split.total_bytes);
1119 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1120 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1121 "%"PRIu64" %"TS" (%u%%) written\n"),
1122 info->split.part_name,
1123 info->split.cur_part_number,
1124 info->split.total_parts,
1125 info->split.completed_bytes >> unit_shift,
1127 info->split.total_bytes >> unit_shift,
1131 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1132 if (info->split.completed_bytes == info->split.total_bytes) {
1133 imagex_printf(T("Finished writing part %u of %u WIM parts\n"),
1134 info->split.cur_part_number,
1135 info->split.total_parts);
1138 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1139 switch (info->update.command->op) {
1140 case WIMLIB_UPDATE_OP_DELETE:
1141 imagex_printf(T("Deleted WIM path "
1142 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1143 info->update.command->delete.wim_path);
1145 case WIMLIB_UPDATE_OP_RENAME:
1146 imagex_printf(T("Renamed WIM path "
1147 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1148 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1149 info->update.command->rename.wim_source_path,
1150 info->update.command->rename.wim_target_path);
1152 case WIMLIB_UPDATE_OP_ADD:
1160 fflush(imagex_info_file);
1164 /* Open all the split WIM parts that correspond to a file glob.
1166 * @first_part specifies the first part of the split WIM and it may be either
1167 * included or omitted from the glob. */
1169 open_swms_from_glob(const tchar *swm_glob,
1170 const tchar *first_part,
1172 WIMStruct ***additional_swms_ret,
1173 unsigned *num_additional_swms_ret)
1175 unsigned num_additional_swms = 0;
1176 WIMStruct **additional_swms = NULL;
1180 /* Warning: glob() is replaced in Windows native builds */
1181 ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
1183 if (ret == GLOB_NOMATCH) {
1184 imagex_error(T("Found no files for glob \"%"TS"\""),
1187 imagex_error_with_errno(T("Failed to process glob \"%"TS"\""),
1193 num_additional_swms = globbuf.gl_pathc;
1194 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
1195 if (!additional_swms) {
1196 imagex_error(T("Out of memory"));
1200 unsigned offset = 0;
1201 for (unsigned i = 0; i < num_additional_swms; i++) {
1202 if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) {
1206 ret = wimlib_open_wim(globbuf.gl_pathv[i],
1207 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
1208 &additional_swms[i - offset],
1209 imagex_progress_func);
1211 goto out_close_swms;
1213 *additional_swms_ret = additional_swms;
1214 *num_additional_swms_ret = num_additional_swms - offset;
1218 for (unsigned i = 0; i < num_additional_swms; i++)
1219 wimlib_free(additional_swms[i]);
1220 free(additional_swms);
1229 parse_num_threads(const tchar *optarg)
1232 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1233 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1234 imagex_error(T("Number of threads must be a non-negative integer!"));
1242 * Parse an option passed to an update command.
1244 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1247 * @option: Text string for the option (beginning with --)
1249 * @cmd: `struct wimlib_update_command' that is being constructed for
1252 * Returns true if the option was recognized; false if not.
1255 update_command_add_option(int op, const tchar *option,
1256 struct wimlib_update_command *cmd)
1258 bool recognized = true;
1260 case WIMLIB_UPDATE_OP_ADD:
1261 if (!tstrcmp(option, T("--verbose")))
1262 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1263 else if (!tstrcmp(option, T("--unix-data")))
1264 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1265 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1266 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1267 else if (!tstrcmp(option, T("--strict-acls")))
1268 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1269 else if (!tstrcmp(option, T("--dereference")))
1270 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1274 case WIMLIB_UPDATE_OP_DELETE:
1275 if (!tstrcmp(option, T("--force")))
1276 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1277 else if (!tstrcmp(option, T("--recursive")))
1278 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1289 /* How many nonoption arguments each `imagex update' command expects */
1290 static const unsigned update_command_num_nonoptions[] = {
1291 [WIMLIB_UPDATE_OP_ADD] = 2,
1292 [WIMLIB_UPDATE_OP_DELETE] = 1,
1293 [WIMLIB_UPDATE_OP_RENAME] = 2,
1297 update_command_add_nonoption(int op, const tchar *nonoption,
1298 struct wimlib_update_command *cmd,
1299 unsigned num_nonoptions)
1302 case WIMLIB_UPDATE_OP_ADD:
1303 if (num_nonoptions == 0)
1304 cmd->add.fs_source_path = (tchar*)nonoption;
1306 cmd->add.wim_target_path = (tchar*)nonoption;
1308 case WIMLIB_UPDATE_OP_DELETE:
1309 cmd->delete.wim_path = (tchar*)nonoption;
1311 case WIMLIB_UPDATE_OP_RENAME:
1312 if (num_nonoptions == 0)
1313 cmd->rename.wim_source_path = (tchar*)nonoption;
1315 cmd->rename.wim_target_path = (tchar*)nonoption;
1321 * Parse a command passed on stdin to `imagex update'.
1323 * @line: Text of the command.
1324 * @len: Length of the line, including a null terminator
1327 * @command: A `struct wimlib_update_command' to fill in from the parsed
1330 * @line_number: Line number of the command, for diagnostics.
1332 * Returns true on success; returns false on parse error.
1335 parse_update_command(tchar *line, size_t len,
1336 struct wimlib_update_command *command,
1340 tchar *command_name;
1342 size_t num_nonoptions;
1344 /* Get the command name ("add", "delete", "rename") */
1345 ret = parse_string(&line, &len, &command_name);
1346 if (ret != PARSE_STRING_SUCCESS)
1349 if (!tstrcasecmp(command_name, T("add"))) {
1350 op = WIMLIB_UPDATE_OP_ADD;
1351 } else if (!tstrcasecmp(command_name, T("delete"))) {
1352 op = WIMLIB_UPDATE_OP_DELETE;
1353 } else if (!tstrcasecmp(command_name, T("rename"))) {
1354 op = WIMLIB_UPDATE_OP_RENAME;
1356 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1357 command_name, line_number);
1362 /* Parse additional options and non-options as needed */
1367 ret = parse_string(&line, &len, &next_string);
1368 if (ret == PARSE_STRING_NONE) /* End of line */
1370 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1372 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1374 if (!update_command_add_option(op, next_string, command))
1376 imagex_error(T("Unrecognized option \"%"TS"\" to "
1377 "update command \"%"TS"\" on line %zu"),
1378 next_string, command_name, line_number);
1384 if (num_nonoptions == update_command_num_nonoptions[op])
1386 imagex_error(T("Unexpected argument \"%"TS"\" in "
1387 "update command on line %zu\n"
1388 " (The \"%"TS"\" command only "
1389 "takes %zu nonoption arguments!)\n"),
1390 next_string, line_number,
1391 command_name, num_nonoptions);
1394 update_command_add_nonoption(op, next_string,
1395 command, num_nonoptions);
1400 if (num_nonoptions != update_command_num_nonoptions[op]) {
1401 imagex_error(T("Not enough arguments to update command "
1402 "\"%"TS"\" on line %zu"), command_name, line_number);
1408 static struct wimlib_update_command *
1409 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1410 size_t *num_cmds_ret)
1414 struct wimlib_update_command *cmds;
1417 nlines = text_file_count_lines(cmd_file_contents_p,
1422 /* Always allocate at least 1 slot, just in case the implementation of
1423 * calloc() returns NULL if 0 bytes are requested. */
1424 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1426 imagex_error(T("out of memory"));
1429 p = *cmd_file_contents_p;
1431 for (i = 0; i < nlines; i++) {
1432 /* XXX: Could use rawmemchr() here instead, but it may not be
1433 * available on all platforms. */
1434 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1435 size_t len = endp - p + 1;
1437 if (!is_comment_line(p, len)) {
1438 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1449 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1450 * one image from a WIM file to a NTFS volume. */
1452 imagex_apply(int argc, tchar **argv, int cmd)
1455 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1459 const tchar *wimfile;
1460 const tchar *target;
1461 const tchar *image_num_or_name;
1462 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1464 const tchar *swm_glob = NULL;
1465 WIMStruct **additional_swms;
1466 unsigned num_additional_swms;
1468 for_opt(c, apply_options) {
1470 case IMAGEX_CHECK_OPTION:
1471 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1473 case IMAGEX_HARDLINK_OPTION:
1474 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1476 case IMAGEX_SYMLINK_OPTION:
1477 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1479 case IMAGEX_VERBOSE_OPTION:
1480 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1482 case IMAGEX_REF_OPTION:
1485 case IMAGEX_UNIX_DATA_OPTION:
1486 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1488 case IMAGEX_NO_ACLS_OPTION:
1489 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1491 case IMAGEX_STRICT_ACLS_OPTION:
1492 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1494 case IMAGEX_NORPFIX_OPTION:
1495 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1497 case IMAGEX_RPFIX_OPTION:
1498 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1500 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1501 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1502 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1510 if (argc != 2 && argc != 3)
1515 if (!tstrcmp(wimfile, T("-"))) {
1516 /* Attempt to apply pipable WIM from standard input. */
1518 image_num_or_name = NULL;
1521 image_num_or_name = argv[1];
1525 num_additional_swms = 0;
1526 additional_swms = NULL;
1528 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1529 imagex_progress_func);
1534 /* Image explicitly specified. */
1535 image_num_or_name = argv[1];
1536 image = wimlib_resolve_image(wim, image_num_or_name);
1537 ret = verify_image_exists(image, image_num_or_name, wimfile);
1539 goto out_wimlib_free;
1542 /* No image specified; default to image 1, but only if the WIM
1543 * contains exactly one image. */
1544 struct wimlib_wim_info info;
1546 wimlib_get_wim_info(wim, &info);
1547 if (info.image_count != 1) {
1548 imagex_error(T("\"%"TS"\" contains %d images; "
1549 "Please select one (or all)."),
1550 wimfile, info.image_count);
1559 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1561 &num_additional_swms);
1563 goto out_wimlib_free;
1565 additional_swms = NULL;
1566 num_additional_swms = 0;
1572 /* Interpret a regular file or block device target as a NTFS
1576 if (tstat(target, &stbuf)) {
1577 if (errno != ENOENT) {
1578 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1584 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1585 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1591 win32_acquire_restore_privileges();
1594 ret = wimlib_extract_image(wim, image, target, extract_flags,
1595 additional_swms, num_additional_swms,
1596 imagex_progress_func);
1598 set_fd_to_binary_mode(STDIN_FILENO);
1599 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1601 target, extract_flags,
1602 imagex_progress_func);
1605 imagex_printf(T("Done applying WIM image.\n"));
1607 win32_release_restore_privileges();
1610 for (unsigned i = 0; i < num_additional_swms; i++)
1611 wimlib_free(additional_swms[i]);
1612 free(additional_swms);
1619 usage(CMD_APPLY, stderr);
1624 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1625 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1626 * the desired image. 'wimlib-imagex append': add a new image to an existing
1629 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1632 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1633 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
1634 int write_flags = 0;
1635 int compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1636 const tchar *wimfile;
1640 const tchar *flags_element = NULL;
1643 unsigned num_threads = 0;
1648 const tchar *config_file = NULL;
1650 struct wimlib_capture_config *config;
1652 bool source_list = false;
1653 size_t source_list_nchars;
1654 tchar *source_list_contents;
1655 bool capture_sources_malloced;
1656 struct wimlib_capture_source *capture_sources;
1658 bool name_defaulted;
1660 for_opt(c, capture_or_append_options) {
1662 case IMAGEX_BOOT_OPTION:
1663 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1665 case IMAGEX_CHECK_OPTION:
1666 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1667 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1669 case IMAGEX_NOCHECK_OPTION:
1670 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1672 case IMAGEX_CONFIG_OPTION:
1673 config_file = optarg;
1675 case IMAGEX_COMPRESS_OPTION:
1676 compression_type = get_compression_type(optarg);
1677 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1680 case IMAGEX_FLAGS_OPTION:
1681 flags_element = optarg;
1683 case IMAGEX_DEREFERENCE_OPTION:
1684 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1686 case IMAGEX_VERBOSE_OPTION:
1687 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1689 case IMAGEX_THREADS_OPTION:
1690 num_threads = parse_num_threads(optarg);
1691 if (num_threads == UINT_MAX)
1694 case IMAGEX_REBUILD_OPTION:
1695 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1697 case IMAGEX_UNIX_DATA_OPTION:
1698 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1700 case IMAGEX_SOURCE_LIST_OPTION:
1703 case IMAGEX_NO_ACLS_OPTION:
1704 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1706 case IMAGEX_STRICT_ACLS_OPTION:
1707 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1709 case IMAGEX_RPFIX_OPTION:
1710 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1712 case IMAGEX_NORPFIX_OPTION:
1713 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1715 case IMAGEX_PIPABLE_OPTION:
1716 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1718 case IMAGEX_NOT_PIPABLE_OPTION:
1719 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1728 if (argc < 2 || argc > 4)
1734 if (!tstrcmp(wimfile, T("-"))) {
1736 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1737 imagex_error("Can't write a non-pipable WIM to "
1738 "standard output! Specify --pipable\n"
1739 " if you want to create a pipable WIM "
1740 "(but read the docs first).");
1744 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1746 if (cmd == CMD_APPEND) {
1747 imagex_error(T("Using standard output for append does "
1748 "not make sense."));
1751 wim_fd = STDOUT_FILENO;
1753 imagex_info_file = stderr;
1758 name_defaulted = false;
1760 /* Set default name to SOURCE argument, omitting any directory
1761 * prefixes and trailing slashes. This requires making a copy
1762 * of @source. Leave some free characters at the end in case we
1763 * append a number to keep the name unique. */
1764 size_t source_name_len;
1766 source_name_len = tstrlen(source);
1767 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1768 name = tbasename(tstrcpy(source_copy, source));
1769 name_defaulted = true;
1771 /* Image description defaults to NULL if not given. */
1778 /* Set up capture sources in source list mode */
1779 if (source[0] == T('-') && source[1] == T('\0')) {
1780 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1782 source_list_contents = file_get_text_contents(source,
1783 &source_list_nchars);
1785 if (!source_list_contents)
1788 capture_sources = parse_source_list(&source_list_contents,
1791 if (!capture_sources) {
1793 goto out_free_source_list_contents;
1795 capture_sources_malloced = true;
1797 /* Set up capture source in non-source-list mode (could be
1798 * either "normal" mode or "NTFS mode"--- see the man page). */
1799 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1800 capture_sources[0].fs_source_path = source;
1801 capture_sources[0].wim_target_path = NULL;
1802 capture_sources[0].reserved = 0;
1804 capture_sources_malloced = false;
1805 source_list_contents = NULL;
1811 config_str = file_get_text_contents(config_file, &config_len);
1814 goto out_free_capture_sources;
1817 config = alloca(sizeof(*config));
1818 ret = parse_capture_config(&config_str, config_len, config);
1820 goto out_free_config;
1822 config = &default_capture_config;
1825 if (cmd == CMD_APPEND)
1826 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1827 imagex_progress_func);
1829 ret = wimlib_create_new_wim(compression_type, &wim);
1831 goto out_free_config;
1837 if (tstat(source, &stbuf) == 0) {
1838 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1839 imagex_printf(T("Capturing WIM image from NTFS "
1840 "filesystem on \"%"TS"\"\n"), source);
1841 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1844 if (errno != ENOENT) {
1845 imagex_error_with_errno(T("Failed to stat "
1846 "\"%"TS"\""), source);
1848 goto out_wimlib_free;
1854 if (cmd == CMD_APPEND && name_defaulted) {
1855 /* If the user did not specify an image name, and the basename
1856 * of the source already exists as an image name in the WIM
1857 * file, append a suffix to make it unique. */
1858 unsigned long conflict_idx;
1859 tchar *name_end = tstrchr(name, T('\0'));
1860 for (conflict_idx = 1;
1861 wimlib_image_name_in_use(wim, name);
1864 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1868 win32_acquire_capture_privileges();
1871 ret = wimlib_add_image_multisource(wim,
1877 imagex_progress_func);
1879 goto out_release_privs;
1881 if (desc || flags_element) {
1882 /* User provided <DESCRIPTION> or <FLAGS> element. Get the
1883 * index of the image we just added, then use it to call the
1884 * appropriate functions. */
1885 struct wimlib_wim_info info;
1887 wimlib_get_wim_info(wim, &info);
1890 ret = wimlib_set_image_descripton(wim,
1894 goto out_release_privs;
1897 if (flags_element) {
1898 ret = wimlib_set_image_flags(wim, info.image_count,
1901 goto out_release_privs;
1905 /* Write the new WIM or overwrite the existing WIM with the new image
1907 if (cmd == CMD_APPEND) {
1908 ret = wimlib_overwrite(wim, write_flags, num_threads,
1909 imagex_progress_func);
1910 } else if (wimfile) {
1911 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
1912 write_flags, num_threads,
1913 imagex_progress_func);
1915 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
1916 write_flags, num_threads,
1917 imagex_progress_func);
1921 win32_release_capture_privileges();
1926 if (config != &default_capture_config) {
1927 free(config->exclusion_pats.pats);
1928 free(config->exclusion_exception_pats.pats);
1931 out_free_capture_sources:
1932 if (capture_sources_malloced)
1933 free(capture_sources);
1934 out_free_source_list_contents:
1935 free(source_list_contents);
1946 /* Remove image(s) from a WIM. */
1948 imagex_delete(int argc, tchar **argv, int cmd)
1951 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1952 int write_flags = 0;
1953 const tchar *wimfile;
1954 const tchar *image_num_or_name;
1959 for_opt(c, delete_options) {
1961 case IMAGEX_CHECK_OPTION:
1962 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1963 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1965 case IMAGEX_SOFT_OPTION:
1966 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
1977 imagex_error(T("Must specify a WIM file"));
1979 imagex_error(T("Must specify an image"));
1983 image_num_or_name = argv[1];
1985 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1986 imagex_progress_func);
1990 image = wimlib_resolve_image(wim, image_num_or_name);
1992 ret = verify_image_exists(image, image_num_or_name, wimfile);
1994 goto out_wimlib_free;
1996 ret = wimlib_delete_image(wim, image);
1998 imagex_error(T("Failed to delete image from \"%"TS"\""),
2000 goto out_wimlib_free;
2003 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2005 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2006 "deleted"), wimfile);
2014 usage(CMD_DELETE, stderr);
2020 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2022 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2023 return (ret >= 0) ? 0 : -1;
2026 /* Print the files contained in an image(s) in a WIM file. */
2028 imagex_dir(int argc, tchar **argv, int cmd)
2030 const tchar *wimfile;
2031 WIMStruct *wim = NULL;
2034 const tchar *path = T("");
2037 for_opt(c, dir_options) {
2039 case IMAGEX_PATH_OPTION:
2050 imagex_error(T("Must specify a WIM file"));
2054 imagex_error(T("Too many arguments"));
2059 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &wim,
2060 imagex_progress_func);
2065 image = wimlib_resolve_image(wim, argv[1]);
2066 ret = verify_image_exists(image, argv[1], wimfile);
2068 goto out_wimlib_free;
2070 /* No image specified; default to image 1, but only if the WIM
2071 * contains exactly one image. */
2073 struct wimlib_wim_info info;
2075 wimlib_get_wim_info(wim, &info);
2076 if (info.image_count != 1) {
2077 imagex_error(T("\"%"TS"\" contains %d images; Please "
2078 "select one (or all)."),
2079 wimfile, info.image_count);
2086 ret = wimlib_iterate_dir_tree(wim, image, path,
2087 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2088 print_full_path, NULL);
2095 usage(CMD_DIR, stderr);
2100 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2103 imagex_export(int argc, tchar **argv, int cmd)
2107 int export_flags = 0;
2108 int write_flags = 0;
2109 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2110 const tchar *src_wimfile;
2111 const tchar *src_image_num_or_name;
2112 const tchar *dest_wimfile;
2114 const tchar *dest_name;
2115 const tchar *dest_desc;
2117 WIMStruct *dest_wim;
2122 const tchar *swm_glob = NULL;
2123 WIMStruct **additional_swms;
2124 unsigned num_additional_swms;
2125 unsigned num_threads = 0;
2127 for_opt(c, export_options) {
2129 case IMAGEX_BOOT_OPTION:
2130 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2132 case IMAGEX_CHECK_OPTION:
2133 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2134 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2136 case IMAGEX_NOCHECK_OPTION:
2137 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2139 case IMAGEX_COMPRESS_OPTION:
2140 compression_type = get_compression_type(optarg);
2141 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2144 case IMAGEX_REF_OPTION:
2147 case IMAGEX_THREADS_OPTION:
2148 num_threads = parse_num_threads(optarg);
2149 if (num_threads == UINT_MAX)
2152 case IMAGEX_REBUILD_OPTION:
2153 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2155 case IMAGEX_PIPABLE_OPTION:
2156 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2158 case IMAGEX_NOT_PIPABLE_OPTION:
2159 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2167 if (argc < 3 || argc > 5)
2169 src_wimfile = argv[0];
2170 src_image_num_or_name = argv[1];
2171 dest_wimfile = argv[2];
2172 dest_name = (argc >= 4) ? argv[3] : NULL;
2173 dest_desc = (argc >= 5) ? argv[4] : NULL;
2174 ret = wimlib_open_wim(src_wimfile,
2175 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_wim,
2176 imagex_progress_func);
2180 /* Determine if the destination is an existing file or not. If so, we
2181 * try to append the exported image(s) to it; otherwise, we create a new
2182 * WIM containing the exported image(s). Furthermore, determine if we
2183 * need to write a pipable WIM directly to standard output. */
2185 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2187 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2188 imagex_error("Can't write a non-pipable WIM to "
2189 "standard output! Specify --pipable\n"
2190 " if you want to create a pipable WIM "
2191 "(but read the docs first).");
2193 goto out_free_src_wim;
2196 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2198 dest_wimfile = NULL;
2199 dest_wim_fd = STDOUT_FILENO;
2200 imagex_info_file = stderr;
2203 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2205 /* Destination file exists. */
2207 if (!S_ISREG(stbuf.st_mode)) {
2208 imagex_error(T("\"%"TS"\" is not a regular file"),
2211 goto out_free_src_wim;
2213 ret = wimlib_open_wim(dest_wimfile, open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2214 &dest_wim, imagex_progress_func);
2216 goto out_free_src_wim;
2218 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2219 /* The user specified a compression type, but we're
2220 * exporting to an existing WIM. Make sure the
2221 * specified compression type is the same as the
2222 * compression type of the existing destination WIM. */
2223 struct wimlib_wim_info dest_info;
2225 wimlib_get_wim_info(dest_wim, &dest_info);
2226 if (compression_type != dest_info.compression_type) {
2227 imagex_error(T("Cannot specify a compression type that is "
2228 "not the same as that used in the "
2229 "destination WIM"));
2231 goto out_free_dest_wim;
2237 if (errno != ENOENT) {
2238 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2241 goto out_free_src_wim;
2244 /* dest_wimfile is not an existing file, so create a new WIM. */
2246 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2247 /* The user did not specify a compression type; default
2248 * to that of the source WIM. */
2250 struct wimlib_wim_info src_info;
2252 wimlib_get_wim_info(src_wim, &src_info);
2253 compression_type = src_info.compression_type;
2255 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2257 goto out_free_src_wim;
2260 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2261 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2263 goto out_free_dest_wim;
2266 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
2268 &num_additional_swms);
2270 goto out_free_dest_wim;
2272 additional_swms = NULL;
2273 num_additional_swms = 0;
2276 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2277 dest_desc, export_flags, additional_swms,
2278 num_additional_swms, imagex_progress_func);
2283 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2284 imagex_progress_func);
2285 else if (dest_wimfile)
2286 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2287 write_flags, num_threads,
2288 imagex_progress_func);
2290 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2291 WIMLIB_ALL_IMAGES, write_flags,
2292 num_threads, imagex_progress_func);
2294 imagex_error(T("Export failed."));
2296 for (unsigned i = 0; i < num_additional_swms; i++)
2297 wimlib_free(additional_swms[i]);
2298 free(additional_swms);
2300 wimlib_free(dest_wim);
2302 wimlib_free(src_wim);
2307 usage(CMD_EXPORT, stderr);
2314 is_root_wim_path(const tchar *path)
2317 for (p = path; *p; p++)
2318 if (*p != T('\\') && *p != T('/'))
2324 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2325 const tchar *dest_dir)
2327 for (size_t i = 0; i < num_cmds; i++)
2328 if (cmds[i].fs_dest_path != dest_dir)
2329 free(cmds[i].fs_dest_path);
2333 static struct wimlib_extract_command *
2334 prepare_extract_commands(tchar **paths, unsigned num_paths,
2335 int extract_flags, tchar *dest_dir,
2336 size_t *num_cmds_ret)
2338 struct wimlib_extract_command *cmds;
2340 tchar *emptystr = T("");
2342 if (num_paths == 0) {
2346 num_cmds = num_paths;
2347 cmds = calloc(num_cmds, sizeof(cmds[0]));
2349 imagex_error(T("Out of memory!"));
2353 for (size_t i = 0; i < num_cmds; i++) {
2354 cmds[i].extract_flags = extract_flags;
2355 cmds[i].wim_source_path = paths[i];
2356 if (is_root_wim_path(paths[i])) {
2357 cmds[i].fs_dest_path = dest_dir;
2359 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2360 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2361 if (!cmds[i].fs_dest_path) {
2362 free_extract_commands(cmds, num_cmds, dest_dir);
2365 tsprintf(cmds[i].fs_dest_path,
2366 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2367 dest_dir, tbasename(paths[i]));
2370 *num_cmds_ret = num_cmds;
2374 /* Extract files or directories from a WIM image */
2376 imagex_extract(int argc, tchar **argv, int cmd)
2379 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2383 const tchar *wimfile;
2384 const tchar *image_num_or_name;
2385 tchar *dest_dir = T(".");
2386 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2388 const tchar *swm_glob = NULL;
2389 WIMStruct **additional_swms;
2390 unsigned num_additional_swms;
2392 struct wimlib_extract_command *cmds;
2395 for_opt(c, extract_options) {
2397 case IMAGEX_CHECK_OPTION:
2398 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2400 case IMAGEX_VERBOSE_OPTION:
2401 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2403 case IMAGEX_REF_OPTION:
2406 case IMAGEX_UNIX_DATA_OPTION:
2407 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2409 case IMAGEX_NO_ACLS_OPTION:
2410 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2412 case IMAGEX_STRICT_ACLS_OPTION:
2413 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2415 case IMAGEX_DEST_DIR_OPTION:
2418 case IMAGEX_TO_STDOUT_OPTION:
2419 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2420 imagex_info_file = stderr;
2421 imagex_be_quiet = true;
2423 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2424 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2425 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2438 image_num_or_name = argv[1];
2443 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2448 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2452 image = wimlib_resolve_image(wim, image_num_or_name);
2453 ret = verify_image_exists_and_is_single(image,
2457 goto out_wimlib_free;
2460 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2462 &num_additional_swms);
2464 goto out_wimlib_free;
2466 additional_swms = NULL;
2467 num_additional_swms = 0;
2471 win32_acquire_restore_privileges();
2474 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2475 additional_swms, num_additional_swms,
2476 imagex_progress_func);
2478 if (!imagex_be_quiet)
2479 imagex_printf(T("Done extracting files.\n"));
2480 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2481 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2482 "files and directories\n"
2483 " are in the WIM image.\n"),
2484 get_cmd_string(CMD_INFO, false));
2487 win32_release_restore_privileges();
2489 for (unsigned i = 0; i < num_additional_swms; i++)
2490 wimlib_free(additional_swms[i]);
2491 free(additional_swms);
2495 free_extract_commands(cmds, num_cmds, dest_dir);
2500 usage(CMD_EXTRACT, stderr);
2506 static void print_byte_field(const uint8_t field[], size_t len)
2509 tprintf(T("%02hhx"), *field++);
2513 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2515 tputs(T("WIM Information:"));
2516 tputs(T("----------------"));
2517 tprintf(T("Path: %"TS"\n"), wimfile);
2518 tprintf(T("GUID: 0x"));
2519 print_byte_field(info->guid, sizeof(info->guid));
2521 tprintf(T("Image Count: %d\n"), info->image_count);
2522 tprintf(T("Compression: %"TS"\n"),
2523 wimlib_get_compression_type_string(info->compression_type));
2524 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2525 tprintf(T("Boot Index: %d\n"), info->boot_index);
2526 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2527 tprintf(T("Integrity Info: %"TS"\n"),
2528 info->has_integrity_table ? T("yes") : T("no"));
2529 tprintf(T("Relative path junction: %"TS"\n"),
2530 info->has_rpfix ? T("yes") : T("no"));
2531 tprintf(T("Pipable: %"TS"\n"),
2532 info->pipable ? T("yes") : T("no"));
2537 print_resource(const struct wimlib_resource_entry *resource,
2541 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2542 resource->uncompressed_size);
2544 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2545 resource->compressed_size);
2547 tprintf(T("Offset = %"PRIu64" bytes\n"),
2551 tprintf(T("Part Number = %u\n"), resource->part_number);
2552 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2554 tprintf(T("Hash = 0x"));
2555 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2558 tprintf(T("Flags = "));
2559 if (resource->is_compressed)
2560 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2561 if (resource->is_metadata)
2562 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2563 if (resource->is_free)
2564 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2565 if (resource->is_spanned)
2566 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2573 print_lookup_table(WIMStruct *wim)
2575 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2578 /* Prints information about a WIM file; also can mark an image as bootable,
2579 * change the name of an image, or change the description of an image. */
2581 imagex_info(int argc, tchar **argv, int cmd)
2586 bool nocheck = false;
2587 bool header = false;
2588 bool lookup_table = false;
2590 bool metadata = false;
2591 bool short_header = true;
2592 const tchar *xml_out_file = NULL;
2593 const tchar *wimfile;
2594 const tchar *image_num_or_name;
2595 const tchar *new_name;
2596 const tchar *new_desc;
2600 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2601 struct wimlib_wim_info info;
2603 for_opt(c, info_options) {
2605 case IMAGEX_BOOT_OPTION:
2608 case IMAGEX_CHECK_OPTION:
2611 case IMAGEX_NOCHECK_OPTION:
2614 case IMAGEX_HEADER_OPTION:
2616 short_header = false;
2618 case IMAGEX_LOOKUP_TABLE_OPTION:
2619 lookup_table = true;
2620 short_header = false;
2622 case IMAGEX_XML_OPTION:
2624 short_header = false;
2626 case IMAGEX_EXTRACT_XML_OPTION:
2627 xml_out_file = optarg;
2628 short_header = false;
2630 case IMAGEX_METADATA_OPTION:
2632 short_header = false;
2641 if (argc < 1 || argc > 4)
2645 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2646 new_name = (argc >= 3) ? argv[2] : NULL;
2647 new_desc = (argc >= 4) ? argv[3] : NULL;
2649 if (check && nocheck) {
2650 imagex_error(T("Can't specify both --check and --nocheck"));
2655 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2657 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2661 wimlib_get_wim_info(wim, &info);
2663 image = wimlib_resolve_image(wim, image_num_or_name);
2664 ret = WIMLIB_ERR_INVALID_IMAGE;
2665 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2666 imagex_error(T("The image \"%"TS"\" does not exist in \"%"TS"\""),
2667 image_num_or_name, wimfile);
2669 imagex_error(T("If you would like to set the boot "
2670 "index to 0, specify image \"0\" with "
2671 "the --boot flag."));
2673 goto out_wimlib_free;
2676 if (boot && info.image_count == 0) {
2677 imagex_error(T("--boot is meaningless on a WIM with no images"));
2678 goto out_wimlib_free;
2681 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2683 imagex_error(T("Cannot specify the --boot flag "
2684 "without specifying a specific "
2685 "image in a multi-image WIM"));
2686 goto out_wimlib_free;
2689 imagex_error(T("Cannot specify the NEW_NAME "
2690 "without specifying a specific "
2691 "image in a multi-image WIM"));
2692 goto out_wimlib_free;
2696 /* Operations that print information are separated from operations that
2697 * recreate the WIM file. */
2698 if (!new_name && !boot) {
2700 /* Read-only operations */
2702 if (image == WIMLIB_NO_IMAGE) {
2703 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2704 image_num_or_name, wimfile);
2705 goto out_wimlib_free;
2708 if (image == WIMLIB_ALL_IMAGES && short_header)
2709 print_wim_information(wimfile, &info);
2712 wimlib_print_header(wim);
2715 if (info.total_parts != 1) {
2716 tfprintf(stderr, T("Warning: Only showing the lookup table "
2717 "for part %d of a %d-part WIM.\n"),
2718 info.part_number, info.total_parts);
2720 print_lookup_table(wim);
2724 ret = wimlib_extract_xml_data(wim, stdout);
2726 goto out_wimlib_free;
2732 fp = tfopen(xml_out_file, T("wb"));
2734 imagex_error_with_errno(T("Failed to open the "
2735 "file \"%"TS"\" for "
2739 goto out_wimlib_free;
2741 ret = wimlib_extract_xml_data(wim, fp);
2743 imagex_error(T("Failed to close the file "
2749 goto out_wimlib_free;
2753 wimlib_print_available_images(wim, image);
2756 ret = wimlib_print_metadata(wim, image);
2758 goto out_wimlib_free;
2763 /* Modification operations */
2765 if (image == WIMLIB_ALL_IMAGES)
2768 if (image == WIMLIB_NO_IMAGE && new_name) {
2769 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2770 "when using image 0"), new_name);
2772 goto out_wimlib_free;
2776 if (image == info.boot_index) {
2777 imagex_printf(T("Image %d is already marked as "
2778 "bootable.\n"), image);
2781 imagex_printf(T("Marking image %d as bootable.\n"),
2783 info.boot_index = image;
2784 ret = wimlib_set_wim_info(wim, &info,
2785 WIMLIB_CHANGE_BOOT_INDEX);
2787 goto out_wimlib_free;
2791 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
2793 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
2797 imagex_printf(T("Changing the name of image %d to "
2798 "\"%"TS"\".\n"), image, new_name);
2799 ret = wimlib_set_image_name(wim, image, new_name);
2801 goto out_wimlib_free;
2805 const tchar *old_desc;
2806 old_desc = wimlib_get_image_description(wim, image);
2807 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2808 imagex_printf(T("The description of image %d is already "
2809 "\"%"TS"\".\n"), image, new_desc);
2812 imagex_printf(T("Changing the description of image %d "
2813 "to \"%"TS"\".\n"), image, new_desc);
2814 ret = wimlib_set_image_descripton(wim, image,
2817 goto out_wimlib_free;
2821 /* Only call wimlib_overwrite() if something actually needs to
2823 if (boot || new_name || new_desc ||
2824 (check && !info.has_integrity_table) ||
2825 (nocheck && info.has_integrity_table))
2827 int write_flags = 0;
2830 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2832 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2833 ret = wimlib_overwrite(wim, write_flags, 1,
2834 imagex_progress_func);
2836 imagex_printf(T("The file \"%"TS"\" was not modified "
2837 "because nothing needed to be done.\n"),
2848 usage(CMD_INFO, stderr);
2854 /* Join split WIMs into one part WIM */
2856 imagex_join(int argc, tchar **argv, int cmd)
2859 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2860 int wim_write_flags = 0;
2861 const tchar *output_path;
2864 for_opt(c, join_options) {
2866 case IMAGEX_CHECK_OPTION:
2867 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2868 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2878 imagex_error(T("Must specify one or more split WIM (.swm) "
2882 output_path = argv[0];
2883 ret = wimlib_join((const tchar * const *)++argv,
2888 imagex_progress_func);
2893 usage(CMD_JOIN, stderr);
2898 #if WIM_MOUNTING_SUPPORTED
2900 /* Mounts a WIM image. */
2902 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
2905 int mount_flags = 0;
2906 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2907 const tchar *swm_glob = NULL;
2908 const tchar *staging_dir = NULL;
2909 const tchar *wimfile;
2914 WIMStruct **additional_swms;
2915 unsigned num_additional_swms;
2917 if (cmd == CMD_MOUNTRW) {
2918 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
2919 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2922 for_opt(c, mount_options) {
2924 case IMAGEX_ALLOW_OTHER_OPTION:
2925 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
2927 case IMAGEX_CHECK_OPTION:
2928 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2930 case IMAGEX_DEBUG_OPTION:
2931 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
2933 case IMAGEX_STREAMS_INTERFACE_OPTION:
2934 if (!tstrcasecmp(optarg, T("none")))
2935 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
2936 else if (!tstrcasecmp(optarg, T("xattr")))
2937 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2938 else if (!tstrcasecmp(optarg, T("windows")))
2939 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
2941 imagex_error(T("Unknown stream interface \"%"TS"\""),
2946 case IMAGEX_REF_OPTION:
2949 case IMAGEX_STAGING_DIR_OPTION:
2950 staging_dir = optarg;
2952 case IMAGEX_UNIX_DATA_OPTION:
2953 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
2961 if (argc != 2 && argc != 3)
2966 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2971 /* Image explicitly specified. */
2972 image = wimlib_resolve_image(wim, argv[1]);
2974 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
2978 /* No image specified; default to image 1, but only if the WIM
2979 * contains exactly one image. */
2980 struct wimlib_wim_info info;
2982 wimlib_get_wim_info(wim, &info);
2983 if (info.image_count != 1) {
2984 imagex_error(T("\"%"TS"\" contains %d images; Please "
2985 "select one."), wimfile, info.image_count);
2994 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2996 &num_additional_swms);
3000 additional_swms = NULL;
3001 num_additional_swms = 0;
3004 ret = wimlib_mount_image(wim, image, dir, mount_flags, additional_swms,
3005 num_additional_swms, staging_dir);
3007 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3009 image, wimfile, dir);
3011 for (unsigned i = 0; i < num_additional_swms; i++)
3012 wimlib_free(additional_swms[i]);
3013 free(additional_swms);
3024 #endif /* WIM_MOUNTING_SUPPORTED */
3026 /* Rebuild a WIM file */
3028 imagex_optimize(int argc, tchar **argv, int cmd)
3031 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3032 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3035 const tchar *wimfile;
3038 unsigned num_threads = 0;
3040 for_opt(c, optimize_options) {
3042 case IMAGEX_CHECK_OPTION:
3043 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3044 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3046 case IMAGEX_NOCHECK_OPTION:
3047 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3049 case IMAGEX_RECOMPRESS_OPTION:
3050 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3052 case IMAGEX_THREADS_OPTION:
3053 num_threads = parse_num_threads(optarg);
3054 if (num_threads == UINT_MAX)
3057 case IMAGEX_PIPABLE_OPTION:
3058 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3060 case IMAGEX_NOT_PIPABLE_OPTION:
3061 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3075 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3079 old_size = file_get_size(wimfile);
3080 tprintf(T("\"%"TS"\" original size: "), wimfile);
3082 tputs(T("Unknown"));
3084 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3086 ret = wimlib_overwrite(wim, write_flags, num_threads,
3087 imagex_progress_func);
3089 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3090 goto out_wimlib_free;
3093 new_size = file_get_size(wimfile);
3094 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3096 tputs(T("Unknown"));
3098 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3100 tfputs(T("Space saved: "), stdout);
3101 if (new_size != -1 && old_size != -1) {
3102 tprintf(T("%lld KiB\n"),
3103 ((long long)old_size - (long long)new_size) >> 10);
3105 tputs(T("Unknown"));
3114 usage(CMD_OPTIMIZE, stderr);
3120 /* Split a WIM into a spanned set */
3122 imagex_split(int argc, tchar **argv, int cmd)
3126 int write_flags = 0;
3127 unsigned long part_size;
3132 for_opt(c, split_options) {
3134 case IMAGEX_CHECK_OPTION:
3135 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3136 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3148 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3149 if (tmp == argv[2] || *tmp) {
3150 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3151 imagex_error(T("The part size must be an integer or "
3152 "floating-point number of megabytes."));
3155 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3159 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3165 usage(CMD_SPLIT, stderr);
3171 #if WIM_MOUNTING_SUPPORTED
3172 /* Unmounts a mounted WIM image. */
3174 imagex_unmount(int argc, tchar **argv, int cmd)
3177 int unmount_flags = 0;
3180 for_opt(c, unmount_options) {
3182 case IMAGEX_COMMIT_OPTION:
3183 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3185 case IMAGEX_CHECK_OPTION:
3186 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3188 case IMAGEX_REBUILD_OPTION:
3189 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3191 case IMAGEX_LAZY_OPTION:
3192 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3203 ret = wimlib_unmount_image(argv[0], unmount_flags,
3204 imagex_progress_func);
3206 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3211 usage(CMD_UNMOUNT, stderr);
3215 #endif /* WIM_MOUNTING_SUPPORTED */
3218 * Add, delete, or rename files in a WIM image.
3221 imagex_update(int argc, tchar **argv, int cmd)
3223 const tchar *wimfile;
3227 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3228 int write_flags = 0;
3229 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3230 int default_add_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
3231 int default_delete_flags = 0;
3232 unsigned num_threads = 0;
3234 tchar *cmd_file_contents;
3235 size_t cmd_file_nchars;
3236 struct wimlib_update_command *cmds;
3238 tchar *command_str = NULL;
3240 const tchar *config_file = NULL;
3242 struct wimlib_capture_config *config;
3244 for_opt(c, update_options) {
3246 /* Generic or write options */
3247 case IMAGEX_THREADS_OPTION:
3248 num_threads = parse_num_threads(optarg);
3249 if (num_threads == UINT_MAX)
3252 case IMAGEX_CHECK_OPTION:
3253 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3254 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3256 case IMAGEX_REBUILD_OPTION:
3257 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3259 case IMAGEX_COMMAND_OPTION:
3261 imagex_error(T("--command may only be specified "
3262 "one time. Please provide\n"
3263 " the update commands "
3264 "on standard input instead."));
3267 command_str = tstrdup(optarg);
3269 imagex_error(T("Out of memory!"));
3273 /* Default delete options */
3274 case IMAGEX_FORCE_OPTION:
3275 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3277 case IMAGEX_RECURSIVE_OPTION:
3278 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3281 /* Global add option */
3282 case IMAGEX_CONFIG_OPTION:
3283 config_file = optarg;
3286 /* Default add options */
3287 case IMAGEX_VERBOSE_OPTION:
3288 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
3290 case IMAGEX_DEREFERENCE_OPTION:
3291 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
3293 case IMAGEX_UNIX_DATA_OPTION:
3294 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
3296 case IMAGEX_NO_ACLS_OPTION:
3297 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
3299 case IMAGEX_STRICT_ACLS_OPTION:
3300 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
3309 if (argc != 1 && argc != 2)
3313 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3315 goto out_free_command_str;
3318 /* Image explicitly specified. */
3319 image = wimlib_resolve_image(wim, argv[1]);
3320 ret = verify_image_exists_and_is_single(image, argv[1],
3323 goto out_wimlib_free;
3325 /* No image specified; default to image 1, but only if the WIM
3326 * contains exactly one image. */
3327 struct wimlib_wim_info info;
3329 wimlib_get_wim_info(wim, &info);
3330 if (info.image_count != 1) {
3331 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3332 wimfile, info.image_count);
3339 /* Parse capture configuration file if specified */
3343 config_str = file_get_text_contents(config_file, &config_len);
3346 goto out_wimlib_free;
3349 config = alloca(sizeof(*config));
3350 ret = parse_capture_config(&config_str, config_len, config);
3352 goto out_free_config;
3354 config = &default_capture_config;
3357 /* Read update commands from standard input, or the command string if
3360 cmd_file_contents = NULL;
3361 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3364 if (isatty(STDIN_FILENO)) {
3365 tputs(T("Reading update commands from standard input..."));
3366 recommend_man_page(CMD_UPDATE, stdout);
3368 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3369 if (!cmd_file_contents) {
3371 goto out_free_config;
3374 /* Parse the update commands */
3375 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3380 goto out_free_cmd_file_contents;
3383 /* Set default flags and capture config on the update commands */
3384 bool have_add_command = false;
3385 for (size_t i = 0; i < num_cmds; i++) {
3386 switch (cmds[i].op) {
3387 case WIMLIB_UPDATE_OP_ADD:
3388 cmds[i].add.add_flags |= default_add_flags;
3389 cmds[i].add.config = config;
3390 have_add_command = true;
3392 case WIMLIB_UPDATE_OP_DELETE:
3393 cmds[i].delete.delete_flags |= default_delete_flags;
3401 if (have_add_command)
3402 win32_acquire_capture_privileges();
3405 /* Execute the update commands */
3406 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3407 imagex_progress_func);
3409 goto out_release_privs;
3411 /* Overwrite the updated WIM */
3412 ret = wimlib_overwrite(wim, write_flags, num_threads,
3413 imagex_progress_func);
3416 if (have_add_command)
3417 win32_release_capture_privileges();
3420 out_free_cmd_file_contents:
3421 free(cmd_file_contents);
3423 if (config != &default_capture_config) {
3424 free(config->exclusion_pats.pats);
3425 free(config->exclusion_exception_pats.pats);
3430 out_free_command_str:
3435 usage(CMD_UPDATE, stderr);
3438 goto out_free_command_str;
3443 struct imagex_command {
3445 int (*func)(int argc, tchar **argv, int cmd);
3448 static const struct imagex_command imagex_commands[] = {
3449 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3450 [CMD_APPLY] = {T("apply"), imagex_apply},
3451 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3452 [CMD_DELETE] = {T("delete"), imagex_delete},
3453 [CMD_DIR ] = {T("dir"), imagex_dir},
3454 [CMD_EXPORT] = {T("export"), imagex_export},
3455 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3456 [CMD_INFO] = {T("info"), imagex_info},
3457 [CMD_JOIN] = {T("join"), imagex_join},
3458 #if WIM_MOUNTING_SUPPORTED
3459 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3460 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3462 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3463 [CMD_SPLIT] = {T("split"), imagex_split},
3464 #if WIM_MOUNTING_SUPPORTED
3465 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3467 [CMD_UPDATE] = {T("update"), imagex_update},
3470 static const tchar *usage_strings[] = {
3473 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3474 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3475 " [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3476 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3477 " [--rebuild] [--unix-data] [--source-list] [--no-acls]\n"
3478 " [--strict-acls] [--rpfix] [--norpfix] [--pipable]\n"
3479 " [--not-pipable]\n"
3483 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3484 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3485 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3486 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3487 " [--include-invalid-names]\n"
3491 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3492 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3493 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3494 " [--verbose] [--dereference] [--config=FILE]\n"
3495 " [--threads=NUM_THREADS] [--unix-data] [--source-list]\n"
3496 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3497 " [--pipable] [--not-pipable]\n"
3501 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3506 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3510 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3511 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3512 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3513 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3514 " [--pipable] [--not-pipable]\n"
3518 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3519 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3520 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3521 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3525 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3526 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3527 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3532 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3534 #if WIM_MOUNTING_SUPPORTED
3537 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3538 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3539 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3543 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3544 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3545 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3550 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3551 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3555 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3557 #if WIM_MOUNTING_SUPPORTED
3560 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3565 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3566 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3567 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3571 static const tchar *invocation_name;
3572 static bool using_cmd_from_invocation_name = false;
3574 static const tchar *get_cmd_string(int cmd, bool nospace)
3577 if (using_cmd_from_invocation_name || cmd == CMD_NONE) {
3578 return invocation_name;
3580 const tchar *format;
3581 static tchar buf[50];
3584 format = T("%"TS"-%"TS"");
3586 format = T("%"TS" %"TS"");
3587 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3595 static const tchar *format =
3597 "%"TS" (" PACKAGE ") " PACKAGE_VERSION "\n"
3598 "Copyright (C) 2012, 2013 Eric Biggers\n"
3599 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3600 "This is free software: you are free to change and redistribute it.\n"
3601 "There is NO WARRANTY, to the extent permitted by law.\n"
3603 "Report bugs to "PACKAGE_BUGREPORT".\n"
3605 tprintf(format, invocation_name);
3610 help_or_version(int argc, tchar **argv, int cmd)
3615 for (i = 1; i < argc; i++) {
3617 if (p[0] == T('-') && p[1] == T('-')) {
3619 if (!tstrcmp(p, T("help"))) {
3620 if (cmd == CMD_NONE)
3625 } else if (!tstrcmp(p, T("version"))) {
3634 print_usage_string(int cmd, FILE *fp)
3636 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3640 recommend_man_page(int cmd, FILE *fp)
3642 const tchar *format_str;
3644 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3646 format_str = T("Try `man %"TS"' for more details.\n");
3648 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3652 usage(int cmd, FILE *fp)
3654 tfprintf(fp, T("Usage:\n"));
3655 print_usage_string(cmd, fp);
3656 tfprintf(fp, T("\n"));
3657 recommend_man_page(cmd, fp);
3663 tfprintf(fp, T("Usage:\n"));
3664 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3665 print_usage_string(cmd, fp);
3666 tfprintf(fp, T("\n"));
3668 static const tchar *extra =
3671 " %"TS" --version\n"
3673 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3676 tfprintf(fp, extra, invocation_name, invocation_name);
3677 recommend_man_page(CMD_NONE, fp);
3680 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3681 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3682 * something else), while an Windows the command arguments will be UTF-16LE
3683 * encoded 'wchar_t' strings. */
3686 wmain(int argc, wchar_t **argv, wchar_t **envp)
3688 main(int argc, char **argv)
3695 imagex_info_file = stdout;
3696 invocation_name = tbasename(argv[0]);
3699 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3700 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3704 setlocale(LC_ALL, "");
3705 codeset = nl_langinfo(CODESET);
3706 if (!strstr(codeset, "UTF-8") &&
3707 !strstr(codeset, "UTF8") &&
3708 !strstr(codeset, "utf-8") &&
3709 !strstr(codeset, "utf8"))
3712 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3713 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3714 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3715 " to any value to force wimlib to use UTF-8.\n",
3720 #endif /* !__WIN32__ */
3722 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3724 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3725 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3726 for (int i = 0; i < CMD_MAX; i++) {
3727 if (!tstrcmp(invocation_name + 3,
3728 imagex_commands[i].name))
3730 using_cmd_from_invocation_name = true;
3737 /* Unless already known from the invocation name, determine which
3738 * command was specified. */
3739 if (cmd == CMD_NONE) {
3741 imagex_error(T("No command specified!\n"));
3745 for (int i = 0; i < CMD_MAX; i++) {
3746 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3751 if (cmd != CMD_NONE) {
3757 /* Handle --help and --version. --help can be either for the program as
3758 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3759 * CMD_NONE). Note: help_or_version() will not return if a --help or
3760 * --version argument was found. */
3761 help_or_version(argc, argv, cmd);
3763 /* Bail if a valid command was not specified. */
3764 if (cmd == CMD_NONE) {
3765 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3770 /* Enable warning and error messages in wimlib be more user-friendly.
3772 wimlib_set_print_errors(true);
3774 /* Initialize wimlib. */
3775 ret = wimlib_global_init(init_flags);
3777 goto out_check_status;
3779 /* Call the command handler function. */
3780 ret = imagex_commands[cmd].func(argc, argv, cmd);
3782 /* Check for error writing to standard output, especially since for some
3783 * commands, writing to standard output is part of the program's actual
3784 * behavior and not just for informational purposes. */
3785 if (ferror(stdout) || fclose(stdout)) {
3786 imagex_error_with_errno(T("error writing to standard output"));
3791 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3792 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
3793 * error code from which an error message can be printed. */
3795 imagex_error(T("Exiting with error code %d:\n"
3797 wimlib_get_error_string(ret));
3798 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3799 imagex_error_with_errno(T("errno"));
3801 /* Make wimlib free any resources it's holding (although this is not
3802 * strictly necessary because the process is ending anyway). */
3803 wimlib_global_cleanup();