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,
149 IMAGEX_RESUME_OPTION,
152 IMAGEX_SOURCE_LIST_OPTION,
153 IMAGEX_STAGING_DIR_OPTION,
154 IMAGEX_STREAMS_INTERFACE_OPTION,
155 IMAGEX_STRICT_ACLS_OPTION,
156 IMAGEX_SYMLINK_OPTION,
157 IMAGEX_THREADS_OPTION,
158 IMAGEX_TO_STDOUT_OPTION,
159 IMAGEX_UNIX_DATA_OPTION,
160 IMAGEX_VERBOSE_OPTION,
164 static const struct option apply_options[] = {
165 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
166 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
167 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
168 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
169 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
170 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
171 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
172 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
173 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
174 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
175 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
176 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
178 /* --resume is undocumented for now as it needs improvement. */
179 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
183 static const struct option capture_or_append_options[] = {
184 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
185 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
186 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
187 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
188 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
189 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
190 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
191 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
192 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
193 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
194 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
195 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
196 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
197 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
198 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
199 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
200 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
201 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
202 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
203 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
207 static const struct option delete_options[] = {
208 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
209 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
213 static const struct option dir_options[] = {
214 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
218 static const struct option export_options[] = {
219 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
220 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
221 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
222 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
223 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
224 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
225 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
226 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
227 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
228 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
232 static const struct option extract_options[] = {
233 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
234 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
235 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
236 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
237 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
238 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
239 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
240 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
241 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
242 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
246 static const struct option info_options[] = {
247 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
248 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
249 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
250 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
251 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
252 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
253 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
254 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
255 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
259 static const struct option join_options[] = {
260 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
264 static const struct option mount_options[] = {
265 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
266 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
267 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
268 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
269 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
270 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
271 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
275 static const struct option optimize_options[] = {
276 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
277 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
278 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
279 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
280 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
281 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
282 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
286 static const struct option split_options[] = {
287 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
291 static const struct option unmount_options[] = {
292 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
293 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
294 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
295 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
299 static const struct option update_options[] = {
300 /* Careful: some of the options here set the defaults for update
301 * commands, but the flags given to an actual update command (and not to
302 * `imagex update' itself are also handled in
303 * update_command_add_option(). */
304 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
305 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
306 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
307 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
309 /* Default delete options */
310 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
311 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
313 /* Global add option */
314 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
316 /* Default add options */
317 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
318 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
319 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
320 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
321 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
322 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
328 # define _format_attribute(type, format_str, args_start) \
329 __attribute__((format(type, format_str, args_start)))
331 # define _format_attribute(type, format_str, args_start)
334 /* Print formatted error message to stderr. */
335 static void _format_attribute(printf, 1, 2)
336 imagex_error(const tchar *format, ...)
339 va_start(va, format);
340 tfputs(T("ERROR: "), stderr);
341 tvfprintf(stderr, format, va);
342 tputc(T('\n'), stderr);
346 /* Print formatted error message to stderr. */
347 static void _format_attribute(printf, 1, 2)
348 imagex_error_with_errno(const tchar *format, ...)
350 int errno_save = errno;
352 va_start(va, format);
353 tfputs(T("ERROR: "), stderr);
354 tvfprintf(stderr, format, va);
355 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
360 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
362 if (image == WIMLIB_NO_IMAGE) {
363 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
364 " Please specify a 1-based image index or "
366 " You may use `%"TS"' to list the images "
367 "contained in a WIM."),
368 image_name, wim_name, get_cmd_string(CMD_INFO, false));
375 verify_image_is_single(int image)
377 if (image == WIMLIB_ALL_IMAGES) {
378 imagex_error(T("Cannot specify all images for this action!"));
385 verify_image_exists_and_is_single(int image, const tchar *image_name,
386 const tchar *wim_name)
389 ret = verify_image_exists(image, image_name, wim_name);
391 ret = verify_image_is_single(image);
395 /* Parse the argument to --compress */
397 get_compression_type(const tchar *optarg)
399 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
400 return WIMLIB_COMPRESSION_TYPE_LZX;
401 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
402 return WIMLIB_COMPRESSION_TYPE_XPRESS;
403 else if (!tstrcasecmp(optarg, T("none")))
404 return WIMLIB_COMPRESSION_TYPE_NONE;
406 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
407 "\"maximum\", \"fast\", or \"none\"."), optarg);
408 return WIMLIB_COMPRESSION_TYPE_INVALID;
412 /* Returns the size of a file given its name, or -1 if the file does not exist
413 * or its size cannot be determined. */
415 file_get_size(const tchar *filename)
418 if (tstat(filename, &st) == 0)
425 PARSE_STRING_SUCCESS = 0,
426 PARSE_STRING_FAILURE = 1,
427 PARSE_STRING_NONE = 2,
431 * Parses a string token from an array of characters.
433 * Tokens are either whitespace-delimited, or double or single-quoted.
435 * @line_p: Pointer to the pointer to the line of data. Will be updated
436 * to point past the string token iff the return value is
437 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
440 * @len_p: @len_p initially stores the length of the line of data, which may
441 * be 0, and it will be updated to the number of bytes remaining in
442 * the line iff the return value is PARSE_STRING_SUCCESS.
444 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
445 * parsed string token will be returned here.
447 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
448 * PARSE_STRING_FAILURE if the data was invalid due to a missing
449 * closing quote; or PARSE_STRING_NONE if the line ended before the
450 * beginning of a string token was found.
453 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
456 tchar *line = *line_p;
460 /* Skip leading whitespace */
463 return PARSE_STRING_NONE;
464 if (!istspace(*line) && *line != T('\0'))
470 if (quote_char == T('"') || quote_char == T('\'')) {
475 line = tmemchr(line, quote_char, len);
477 imagex_error(T("Missing closing quote: %"TS), fn - 1);
478 return PARSE_STRING_FAILURE;
481 /* Unquoted string. Go until whitespace. Line is terminated
482 * by '\0', so no need to check 'len'. */
486 } while (!istspace(*line) && *line != T('\0'));
493 return PARSE_STRING_SUCCESS;
496 /* Parses a line of data (not an empty line or comment) in the source list file
497 * format. (See the man page for 'wimlib-imagex capture' for details on this
498 * format and the meaning.)
500 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
501 * len == 0. The data in @line will be modified by this function call.
503 * @len: Length of the line of data.
505 * @source: On success, the capture source and target described by the line is
506 * written into this destination. Note that it will contain pointers
507 * to data in the @line array.
509 * Returns true if the line was valid; false otherwise. */
511 parse_source_list_line(tchar *line, size_t len,
512 struct wimlib_capture_source *source)
516 ret = parse_string(&line, &len, &source->fs_source_path);
517 if (ret != PARSE_STRING_SUCCESS)
519 ret = parse_string(&line, &len, &source->wim_target_path);
520 if (ret == PARSE_STRING_NONE)
521 source->wim_target_path = source->fs_source_path;
522 return ret != PARSE_STRING_FAILURE;
525 /* Returns %true if the given line of length @len > 0 is a comment or empty line
526 * in the source list file format. */
528 is_comment_line(const tchar *line, size_t len)
533 if (!istspace(*line) && *line != T('\0'))
543 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
546 tchar *contents = *contents_p;
547 size_t nchars = *nchars_p;
550 for (i = 0; i < nchars; i++)
551 if (contents[i] == T('\n'))
554 /* Handle last line not terminated by a newline */
555 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
556 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
558 imagex_error(T("Out of memory!"));
561 contents[nchars] = T('\n');
562 *contents_p = contents;
570 /* Parses a file in the source list format. (See the man page for
571 * 'wimlib-imagex capture' for details on this format and the meaning.)
573 * @source_list_contents: Contents of the source list file. Note that this
574 * buffer will be modified to save memory allocations,
575 * and cannot be freed until the returned array of
576 * wimlib_capture_source's has also been freed.
578 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
581 * @nsources_ret: On success, the length of the returned array is
584 * Returns: An array of `struct wimlib_capture_source's that can be passed to
585 * the wimlib_add_image_multisource() function to specify how a WIM image is to
587 static struct wimlib_capture_source *
588 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
589 size_t *nsources_ret)
593 struct wimlib_capture_source *sources;
596 nlines = text_file_count_lines(source_list_contents_p,
597 &source_list_nchars);
601 /* Always allocate at least 1 slot, just in case the implementation of
602 * calloc() returns NULL if 0 bytes are requested. */
603 sources = calloc(nlines ?: 1, sizeof(*sources));
605 imagex_error(T("out of memory"));
608 p = *source_list_contents_p;
610 for (i = 0; i < nlines; i++) {
611 /* XXX: Could use rawmemchr() here instead, but it may not be
612 * available on all platforms. */
613 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
614 size_t len = endp - p + 1;
616 if (!is_comment_line(p, len)) {
617 if (!parse_source_list_line(p, len, &sources[j++])) {
630 enum capture_config_section {
631 CAPTURE_CONFIG_NO_SECTION,
632 CAPTURE_CONFIG_EXCLUSION_SECTION,
633 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
634 CAPTURE_CONFIG_IGNORE_SECTION,
638 CAPTURE_CONFIG_INVALID_SECTION,
639 CAPTURE_CONFIG_CHANGED_SECTION,
640 CAPTURE_CONFIG_SAME_SECTION,
644 check_config_section(tchar *line, size_t len,
645 enum capture_config_section *cur_section)
647 while (istspace(*line))
651 return CAPTURE_CONFIG_SAME_SECTION;
654 tchar *endbrace = tstrrchr(line, T(']'));
656 return CAPTURE_CONFIG_SAME_SECTION;
658 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
659 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
660 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
661 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
662 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
663 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
664 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
665 "of capture config file\n"),
667 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
668 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
669 tfputs(T("WARNING: Ignoring [AlignmentList] section "
670 "of capture config file\n"),
673 imagex_error(T("Invalid capture config file section \"%"TS"\""),
675 return CAPTURE_CONFIG_INVALID_SECTION;
677 return CAPTURE_CONFIG_CHANGED_SECTION;
682 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
685 if (pat_list->num_pats == pat_list->num_allocated_pats) {
687 size_t num_allocated_pats = pat_list->num_pats + 8;
689 pats = realloc(pat_list->pats,
690 num_allocated_pats * sizeof(pat_list->pats[0]));
692 imagex_error(T("Out of memory!"));
695 pat_list->pats = pats;
696 pat_list->num_allocated_pats = num_allocated_pats;
698 pat_list->pats[pat_list->num_pats++] = pat;
703 parse_capture_config_line(tchar *line, size_t len,
704 enum capture_config_section *cur_section,
705 struct wimlib_capture_config *config)
710 ret = check_config_section(line, len, cur_section);
711 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
713 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
716 switch (*cur_section) {
717 case CAPTURE_CONFIG_NO_SECTION:
718 imagex_error(T("Line \"%"TS"\" is not in a section "
719 "(such as [ExclusionList]"), line);
721 case CAPTURE_CONFIG_EXCLUSION_SECTION:
722 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
724 return pattern_list_add_pattern(&config->exclusion_pats,
726 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
727 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
729 return pattern_list_add_pattern(&config->exclusion_exception_pats,
731 case CAPTURE_CONFIG_IGNORE_SECTION:
738 parse_capture_config(tchar **contents_p, size_t nchars,
739 struct wimlib_capture_config *config)
744 enum capture_config_section cur_section;
746 memset(config, 0, sizeof(*config));
748 nlines = text_file_count_lines(contents_p, &nchars);
752 cur_section = CAPTURE_CONFIG_NO_SECTION;
754 for (i = 0; i < nlines; i++) {
755 tchar *endp = tmemchr(p, T('\n'), nchars);
756 size_t len = endp - p + 1;
758 if (!is_comment_line(p, len))
759 if (!parse_capture_config_line(p, len, &cur_section, config))
767 /* Reads the contents of a file into memory. */
769 file_get_contents(const tchar *filename, size_t *len_ret)
776 if (tstat(filename, &stbuf) != 0) {
777 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
782 fp = tfopen(filename, T("rb"));
784 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
788 buf = malloc(len ? len : 1);
790 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
791 "contents of file \"%"TS"\""), len, filename);
794 if (fread(buf, 1, len, fp) != len) {
795 imagex_error_with_errno(T("Failed to read %zu bytes from the "
796 "file \"%"TS"\""), len, filename);
810 /* Read standard input until EOF and return the full contents in a malloc()ed
811 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
814 stdin_get_contents(size_t *len_ret)
816 /* stdin can, of course, be a pipe or other non-seekable file, so the
817 * total length of the data cannot be pre-determined */
819 size_t newlen = 1024;
823 char *p = realloc(buf, newlen);
824 size_t bytes_read, bytes_to_read;
826 imagex_error(T("out of memory while reading stdin"));
830 bytes_to_read = newlen - pos;
831 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
833 if (bytes_read != bytes_to_read) {
838 imagex_error_with_errno(T("error reading stdin"));
852 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
855 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
857 *num_tchars_ret = num_bytes;
859 #else /* !__WIN32__ */
860 /* On Windows, translate the text to UTF-16LE */
864 if (num_bytes >= 2 &&
865 ((text[0] == 0xff && text[1] == 0xfe) ||
866 (text[0] <= 0x7f && text[1] == 0x00)))
868 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
869 * with something that looks like an ASCII character encoded as
870 * a UTF-16LE code unit. Assume the file is encoded as
871 * UTF-16LE. This is not a 100% reliable check. */
872 num_wchars = num_bytes / 2;
873 text_wstr = (wchar_t*)text;
875 /* File does not look like UTF-16LE. Assume it is encoded in
876 * the current Windows code page. I think these are always
877 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
878 * should work as expected. */
879 text_wstr = win32_mbs_to_wcs(text,
884 *num_tchars_ret = num_wchars;
886 #endif /* __WIN32__ */
890 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
895 contents = file_get_contents(filename, &num_bytes);
898 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
902 stdin_get_text_contents(size_t *num_tchars_ret)
907 contents = stdin_get_contents(&num_bytes);
910 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
913 #define TO_PERCENT(numerator, denominator) \
914 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
916 /* Given an enumerated value for WIM compression type, return a descriptive
919 get_data_type(int ctype)
922 case WIMLIB_COMPRESSION_TYPE_NONE:
923 return T("uncompressed");
924 case WIMLIB_COMPRESSION_TYPE_LZX:
925 return T("LZX-compressed");
926 case WIMLIB_COMPRESSION_TYPE_XPRESS:
927 return T("XPRESS-compressed");
932 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
933 #define MEBIBYTE_MIN_NBYTES 10000000ULL
934 #define KIBIBYTE_MIN_NBYTES 10000ULL
937 get_unit(uint64_t total_bytes, const tchar **name_ret)
939 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
940 *name_ret = T("GiB");
942 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
943 *name_ret = T("MiB");
945 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
946 *name_ret = T("KiB");
949 *name_ret = T("bytes");
954 /* Progress callback function passed to various wimlib functions. */
956 imagex_progress_func(enum wimlib_progress_msg msg,
957 const union wimlib_progress_info *info)
959 unsigned percent_done;
961 const tchar *unit_name;
965 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
966 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
967 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
968 info->write_streams.total_bytes);
970 if (info->write_streams.completed_streams == 0) {
971 const tchar *data_type;
973 data_type = get_data_type(info->write_streams.compression_type);
974 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
975 data_type, info->write_streams.num_threads,
976 (info->write_streams.num_threads == 1) ? T("") : T("s"));
978 if (info->write_streams.total_parts <= 1) {
979 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
980 "written (%u%% done)"),
981 info->write_streams.completed_bytes >> unit_shift,
983 info->write_streams.total_bytes >> unit_shift,
987 imagex_printf(T("\rWriting resources from part %u of %u: "
988 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
989 (info->write_streams.completed_parts ==
990 info->write_streams.total_parts) ?
991 info->write_streams.completed_parts :
992 info->write_streams.completed_parts + 1,
993 info->write_streams.total_parts,
994 info->write_streams.completed_bytes >> unit_shift,
996 info->write_streams.total_bytes >> unit_shift,
1000 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1001 imagex_printf(T("\n"));
1003 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1004 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1005 if (*info->scan.wim_target_path) {
1006 imagex_printf(T(" (loading as WIM path: "
1007 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1008 info->scan.wim_target_path);
1010 imagex_printf(T(" (loading as root of WIM image)...\n"));
1013 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1014 switch (info->scan.status) {
1015 case WIMLIB_SCAN_DENTRY_OK:
1016 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1018 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1019 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1021 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1022 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1023 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1027 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1028 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1029 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1030 info->integrity.total_bytes);
1031 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1032 "of %"PRIu64" %"TS" (%u%%) done"),
1033 info->integrity.filename,
1034 info->integrity.completed_bytes >> unit_shift,
1036 info->integrity.total_bytes >> unit_shift,
1039 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1040 imagex_printf(T("\n"));
1042 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1043 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1044 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1045 info->integrity.total_bytes);
1046 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1047 "of %"PRIu64" %"TS" (%u%%) done"),
1048 info->integrity.completed_bytes >> unit_shift,
1050 info->integrity.total_bytes >> unit_shift,
1053 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1054 imagex_printf(T("\n"));
1056 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1057 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1058 "to %"TS" \"%"TS"\"\n"),
1059 info->extract.image,
1060 info->extract.image_name,
1061 info->extract.wimfile_name,
1062 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1063 T("NTFS volume") : T("directory")),
1064 info->extract.target);
1066 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1067 imagex_printf(T("Extracting "
1068 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1069 "in \"%"TS"\" to \"%"TS"\"\n"),
1070 info->extract.extract_root_wim_source_path,
1071 info->extract.image,
1072 info->extract.image_name,
1073 info->extract.wimfile_name,
1074 info->extract.target);
1076 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1077 percent_done = TO_PERCENT(info->extract.completed_bytes,
1078 info->extract.total_bytes);
1079 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1080 imagex_printf(T("\rExtracting files: "
1081 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1082 info->extract.completed_bytes >> unit_shift,
1084 info->extract.total_bytes >> unit_shift,
1087 if (info->extract.completed_bytes >= info->extract.total_bytes)
1088 imagex_printf(T("\n"));
1090 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1091 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1092 info->extract.part_number,
1093 info->extract.total_parts);
1095 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1096 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1097 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1099 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1100 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1101 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1102 info->extract.target);
1105 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1106 percent_done = TO_PERCENT(info->split.completed_bytes,
1107 info->split.total_bytes);
1108 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1109 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1110 "%"PRIu64" %"TS" (%u%%) written\n"),
1111 info->split.part_name,
1112 info->split.cur_part_number,
1113 info->split.total_parts,
1114 info->split.completed_bytes >> unit_shift,
1116 info->split.total_bytes >> unit_shift,
1120 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1121 if (info->split.completed_bytes == info->split.total_bytes) {
1122 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1123 info->split.cur_part_number,
1124 info->split.total_parts);
1127 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1128 switch (info->update.command->op) {
1129 case WIMLIB_UPDATE_OP_DELETE:
1130 imagex_printf(T("Deleted WIM path "
1131 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1132 info->update.command->delete.wim_path);
1134 case WIMLIB_UPDATE_OP_RENAME:
1135 imagex_printf(T("Renamed WIM path "
1136 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1137 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1138 info->update.command->rename.wim_source_path,
1139 info->update.command->rename.wim_target_path);
1141 case WIMLIB_UPDATE_OP_ADD:
1149 fflush(imagex_info_file);
1153 /* Open all the split WIM parts that correspond to a file glob.
1155 * @first_part specifies the first part of the split WIM and it may be either
1156 * included or omitted from the glob. */
1158 open_swms_from_glob(const tchar *swm_glob,
1159 const tchar *first_part,
1161 WIMStruct ***additional_swms_ret,
1162 unsigned *num_additional_swms_ret)
1164 unsigned num_additional_swms = 0;
1165 WIMStruct **additional_swms = NULL;
1169 /* Warning: glob() is replaced in Windows native builds */
1170 ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
1172 if (ret == GLOB_NOMATCH) {
1173 imagex_error(T("Found no files for glob \"%"TS"\""),
1176 imagex_error_with_errno(T("Failed to process glob \"%"TS"\""),
1182 num_additional_swms = globbuf.gl_pathc;
1183 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
1184 if (!additional_swms) {
1185 imagex_error(T("Out of memory"));
1189 unsigned offset = 0;
1190 for (unsigned i = 0; i < num_additional_swms; i++) {
1191 if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) {
1195 ret = wimlib_open_wim(globbuf.gl_pathv[i],
1196 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
1197 &additional_swms[i - offset],
1198 imagex_progress_func);
1200 goto out_close_swms;
1202 *additional_swms_ret = additional_swms;
1203 *num_additional_swms_ret = num_additional_swms - offset;
1207 for (unsigned i = 0; i < num_additional_swms; i++)
1208 wimlib_free(additional_swms[i]);
1209 free(additional_swms);
1218 parse_num_threads(const tchar *optarg)
1221 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1222 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1223 imagex_error(T("Number of threads must be a non-negative integer!"));
1231 * Parse an option passed to an update command.
1233 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1236 * @option: Text string for the option (beginning with --)
1238 * @cmd: `struct wimlib_update_command' that is being constructed for
1241 * Returns true if the option was recognized; false if not.
1244 update_command_add_option(int op, const tchar *option,
1245 struct wimlib_update_command *cmd)
1247 bool recognized = true;
1249 case WIMLIB_UPDATE_OP_ADD:
1250 if (!tstrcmp(option, T("--verbose")))
1251 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1252 else if (!tstrcmp(option, T("--unix-data")))
1253 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1254 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1255 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1256 else if (!tstrcmp(option, T("--strict-acls")))
1257 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1258 else if (!tstrcmp(option, T("--dereference")))
1259 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1263 case WIMLIB_UPDATE_OP_DELETE:
1264 if (!tstrcmp(option, T("--force")))
1265 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1266 else if (!tstrcmp(option, T("--recursive")))
1267 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1278 /* How many nonoption arguments each `imagex update' command expects */
1279 static const unsigned update_command_num_nonoptions[] = {
1280 [WIMLIB_UPDATE_OP_ADD] = 2,
1281 [WIMLIB_UPDATE_OP_DELETE] = 1,
1282 [WIMLIB_UPDATE_OP_RENAME] = 2,
1286 update_command_add_nonoption(int op, const tchar *nonoption,
1287 struct wimlib_update_command *cmd,
1288 unsigned num_nonoptions)
1291 case WIMLIB_UPDATE_OP_ADD:
1292 if (num_nonoptions == 0)
1293 cmd->add.fs_source_path = (tchar*)nonoption;
1295 cmd->add.wim_target_path = (tchar*)nonoption;
1297 case WIMLIB_UPDATE_OP_DELETE:
1298 cmd->delete.wim_path = (tchar*)nonoption;
1300 case WIMLIB_UPDATE_OP_RENAME:
1301 if (num_nonoptions == 0)
1302 cmd->rename.wim_source_path = (tchar*)nonoption;
1304 cmd->rename.wim_target_path = (tchar*)nonoption;
1310 * Parse a command passed on stdin to `imagex update'.
1312 * @line: Text of the command.
1313 * @len: Length of the line, including a null terminator
1316 * @command: A `struct wimlib_update_command' to fill in from the parsed
1319 * @line_number: Line number of the command, for diagnostics.
1321 * Returns true on success; returns false on parse error.
1324 parse_update_command(tchar *line, size_t len,
1325 struct wimlib_update_command *command,
1329 tchar *command_name;
1331 size_t num_nonoptions;
1333 /* Get the command name ("add", "delete", "rename") */
1334 ret = parse_string(&line, &len, &command_name);
1335 if (ret != PARSE_STRING_SUCCESS)
1338 if (!tstrcasecmp(command_name, T("add"))) {
1339 op = WIMLIB_UPDATE_OP_ADD;
1340 } else if (!tstrcasecmp(command_name, T("delete"))) {
1341 op = WIMLIB_UPDATE_OP_DELETE;
1342 } else if (!tstrcasecmp(command_name, T("rename"))) {
1343 op = WIMLIB_UPDATE_OP_RENAME;
1345 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1346 command_name, line_number);
1351 /* Parse additional options and non-options as needed */
1356 ret = parse_string(&line, &len, &next_string);
1357 if (ret == PARSE_STRING_NONE) /* End of line */
1359 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1361 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1363 if (!update_command_add_option(op, next_string, command))
1365 imagex_error(T("Unrecognized option \"%"TS"\" to "
1366 "update command \"%"TS"\" on line %zu"),
1367 next_string, command_name, line_number);
1373 if (num_nonoptions == update_command_num_nonoptions[op])
1375 imagex_error(T("Unexpected argument \"%"TS"\" in "
1376 "update command on line %zu\n"
1377 " (The \"%"TS"\" command only "
1378 "takes %zu nonoption arguments!)\n"),
1379 next_string, line_number,
1380 command_name, num_nonoptions);
1383 update_command_add_nonoption(op, next_string,
1384 command, num_nonoptions);
1389 if (num_nonoptions != update_command_num_nonoptions[op]) {
1390 imagex_error(T("Not enough arguments to update command "
1391 "\"%"TS"\" on line %zu"), command_name, line_number);
1397 static struct wimlib_update_command *
1398 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1399 size_t *num_cmds_ret)
1403 struct wimlib_update_command *cmds;
1406 nlines = text_file_count_lines(cmd_file_contents_p,
1411 /* Always allocate at least 1 slot, just in case the implementation of
1412 * calloc() returns NULL if 0 bytes are requested. */
1413 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1415 imagex_error(T("out of memory"));
1418 p = *cmd_file_contents_p;
1420 for (i = 0; i < nlines; i++) {
1421 /* XXX: Could use rawmemchr() here instead, but it may not be
1422 * available on all platforms. */
1423 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1424 size_t len = endp - p + 1;
1426 if (!is_comment_line(p, len)) {
1427 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1438 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1439 * one image from a WIM file to a NTFS volume. */
1441 imagex_apply(int argc, tchar **argv, int cmd)
1444 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1448 const tchar *wimfile;
1449 const tchar *target;
1450 const tchar *image_num_or_name;
1451 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1453 const tchar *swm_glob = NULL;
1454 WIMStruct **additional_swms;
1455 unsigned num_additional_swms;
1457 for_opt(c, apply_options) {
1459 case IMAGEX_CHECK_OPTION:
1460 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1462 case IMAGEX_HARDLINK_OPTION:
1463 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1465 case IMAGEX_SYMLINK_OPTION:
1466 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1468 case IMAGEX_VERBOSE_OPTION:
1469 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1471 case IMAGEX_REF_OPTION:
1474 case IMAGEX_UNIX_DATA_OPTION:
1475 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1477 case IMAGEX_NO_ACLS_OPTION:
1478 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1480 case IMAGEX_STRICT_ACLS_OPTION:
1481 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1483 case IMAGEX_NORPFIX_OPTION:
1484 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1486 case IMAGEX_RPFIX_OPTION:
1487 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1489 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1490 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1491 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1493 case IMAGEX_RESUME_OPTION:
1494 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1502 if (argc != 2 && argc != 3)
1507 if (!tstrcmp(wimfile, T("-"))) {
1508 /* Attempt to apply pipable WIM from standard input. */
1510 image_num_or_name = NULL;
1513 image_num_or_name = argv[1];
1517 num_additional_swms = 0;
1518 additional_swms = NULL;
1520 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1521 imagex_progress_func);
1526 /* Image explicitly specified. */
1527 image_num_or_name = argv[1];
1528 image = wimlib_resolve_image(wim, image_num_or_name);
1529 ret = verify_image_exists(image, image_num_or_name, wimfile);
1531 goto out_wimlib_free;
1534 /* No image specified; default to image 1, but only if the WIM
1535 * contains exactly one image. */
1536 struct wimlib_wim_info info;
1538 wimlib_get_wim_info(wim, &info);
1539 if (info.image_count != 1) {
1540 imagex_error(T("\"%"TS"\" contains %d images; "
1541 "Please select one (or all)."),
1542 wimfile, info.image_count);
1551 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1553 &num_additional_swms);
1555 goto out_wimlib_free;
1557 additional_swms = NULL;
1558 num_additional_swms = 0;
1564 /* Interpret a regular file or block device target as a NTFS
1568 if (tstat(target, &stbuf)) {
1569 if (errno != ENOENT) {
1570 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1576 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1577 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1583 ret = wimlib_extract_image(wim, image, target, extract_flags,
1584 additional_swms, num_additional_swms,
1585 imagex_progress_func);
1587 set_fd_to_binary_mode(STDIN_FILENO);
1588 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1590 target, extract_flags,
1591 imagex_progress_func);
1594 imagex_printf(T("Done applying WIM image.\n"));
1596 for (unsigned i = 0; i < num_additional_swms; i++)
1597 wimlib_free(additional_swms[i]);
1598 free(additional_swms);
1605 usage(CMD_APPLY, stderr);
1610 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1611 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1612 * the desired image. 'wimlib-imagex append': add a new image to an existing
1615 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1618 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1619 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1620 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1621 int write_flags = 0;
1622 int compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1623 const tchar *wimfile;
1627 const tchar *flags_element = NULL;
1630 unsigned num_threads = 0;
1635 const tchar *config_file = NULL;
1637 struct wimlib_capture_config *config;
1639 bool source_list = false;
1640 size_t source_list_nchars;
1641 tchar *source_list_contents;
1642 bool capture_sources_malloced;
1643 struct wimlib_capture_source *capture_sources;
1645 bool name_defaulted;
1647 for_opt(c, capture_or_append_options) {
1649 case IMAGEX_BOOT_OPTION:
1650 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1652 case IMAGEX_CHECK_OPTION:
1653 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1654 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1656 case IMAGEX_NOCHECK_OPTION:
1657 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1659 case IMAGEX_CONFIG_OPTION:
1660 config_file = optarg;
1661 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1663 case IMAGEX_COMPRESS_OPTION:
1664 compression_type = get_compression_type(optarg);
1665 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1668 case IMAGEX_FLAGS_OPTION:
1669 flags_element = optarg;
1671 case IMAGEX_DEREFERENCE_OPTION:
1672 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1674 case IMAGEX_VERBOSE_OPTION:
1675 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1677 case IMAGEX_THREADS_OPTION:
1678 num_threads = parse_num_threads(optarg);
1679 if (num_threads == UINT_MAX)
1682 case IMAGEX_REBUILD_OPTION:
1683 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1685 case IMAGEX_UNIX_DATA_OPTION:
1686 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1688 case IMAGEX_SOURCE_LIST_OPTION:
1691 case IMAGEX_NO_ACLS_OPTION:
1692 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1694 case IMAGEX_STRICT_ACLS_OPTION:
1695 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1697 case IMAGEX_RPFIX_OPTION:
1698 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1700 case IMAGEX_NORPFIX_OPTION:
1701 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1703 case IMAGEX_PIPABLE_OPTION:
1704 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1706 case IMAGEX_NOT_PIPABLE_OPTION:
1707 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1716 if (argc < 2 || argc > 4)
1722 if (!tstrcmp(wimfile, T("-"))) {
1723 /* Writing captured WIM to standard output. */
1725 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1726 imagex_error("Can't write a non-pipable WIM to "
1727 "standard output! Specify --pipable\n"
1728 " if you want to create a pipable WIM "
1729 "(but read the docs first).");
1733 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1735 if (cmd == CMD_APPEND) {
1736 imagex_error(T("Using standard output for append does "
1737 "not make sense."));
1740 wim_fd = STDOUT_FILENO;
1742 imagex_info_file = stderr;
1743 set_fd_to_binary_mode(wim_fd);
1748 name_defaulted = false;
1750 /* Set default name to SOURCE argument, omitting any directory
1751 * prefixes and trailing slashes. This requires making a copy
1752 * of @source. Leave some free characters at the end in case we
1753 * append a number to keep the name unique. */
1754 size_t source_name_len;
1756 source_name_len = tstrlen(source);
1757 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1758 name = tbasename(tstrcpy(source_copy, source));
1759 name_defaulted = true;
1761 /* Image description defaults to NULL if not given. */
1768 /* Set up capture sources in source list mode */
1769 if (source[0] == T('-') && source[1] == T('\0')) {
1770 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1772 source_list_contents = file_get_text_contents(source,
1773 &source_list_nchars);
1775 if (!source_list_contents)
1778 capture_sources = parse_source_list(&source_list_contents,
1781 if (!capture_sources) {
1783 goto out_free_source_list_contents;
1785 capture_sources_malloced = true;
1787 /* Set up capture source in non-source-list mode (could be
1788 * either "normal" mode or "NTFS mode"--- see the man page). */
1789 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1790 capture_sources[0].fs_source_path = source;
1791 capture_sources[0].wim_target_path = NULL;
1792 capture_sources[0].reserved = 0;
1794 capture_sources_malloced = false;
1795 source_list_contents = NULL;
1801 config_str = file_get_text_contents(config_file, &config_len);
1804 goto out_free_capture_sources;
1807 config = alloca(sizeof(*config));
1808 ret = parse_capture_config(&config_str, config_len, config);
1810 goto out_free_config;
1815 if (cmd == CMD_APPEND)
1816 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1817 imagex_progress_func);
1819 ret = wimlib_create_new_wim(compression_type, &wim);
1821 goto out_free_config;
1827 if (tstat(source, &stbuf) == 0) {
1828 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1829 imagex_printf(T("Capturing WIM image from NTFS "
1830 "filesystem on \"%"TS"\"\n"), source);
1831 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1834 if (errno != ENOENT) {
1835 imagex_error_with_errno(T("Failed to stat "
1836 "\"%"TS"\""), source);
1838 goto out_wimlib_free;
1844 if (cmd == CMD_APPEND && name_defaulted) {
1845 /* If the user did not specify an image name, and the basename
1846 * of the source already exists as an image name in the WIM
1847 * file, append a suffix to make it unique. */
1848 unsigned long conflict_idx;
1849 tchar *name_end = tstrchr(name, T('\0'));
1850 for (conflict_idx = 1;
1851 wimlib_image_name_in_use(wim, name);
1854 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1857 ret = wimlib_add_image_multisource(wim,
1863 imagex_progress_func);
1865 goto out_wimlib_free;
1867 if (desc || flags_element) {
1868 /* User provided <DESCRIPTION> or <FLAGS> element. Get the
1869 * index of the image we just added, then use it to call the
1870 * appropriate functions. */
1871 struct wimlib_wim_info info;
1873 wimlib_get_wim_info(wim, &info);
1876 ret = wimlib_set_image_descripton(wim,
1880 goto out_wimlib_free;
1883 if (flags_element) {
1884 ret = wimlib_set_image_flags(wim, info.image_count,
1887 goto out_wimlib_free;
1891 /* Write the new WIM or overwrite the existing WIM with the new image
1893 if (cmd == CMD_APPEND) {
1894 ret = wimlib_overwrite(wim, write_flags, num_threads,
1895 imagex_progress_func);
1896 } else if (wimfile) {
1897 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
1898 write_flags, num_threads,
1899 imagex_progress_func);
1901 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
1902 write_flags, num_threads,
1903 imagex_progress_func);
1909 free(config->exclusion_pats.pats);
1910 free(config->exclusion_exception_pats.pats);
1913 out_free_capture_sources:
1914 if (capture_sources_malloced)
1915 free(capture_sources);
1916 out_free_source_list_contents:
1917 free(source_list_contents);
1928 /* Remove image(s) from a WIM. */
1930 imagex_delete(int argc, tchar **argv, int cmd)
1933 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1934 int write_flags = 0;
1935 const tchar *wimfile;
1936 const tchar *image_num_or_name;
1941 for_opt(c, delete_options) {
1943 case IMAGEX_CHECK_OPTION:
1944 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1945 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1947 case IMAGEX_SOFT_OPTION:
1948 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
1959 imagex_error(T("Must specify a WIM file"));
1961 imagex_error(T("Must specify an image"));
1965 image_num_or_name = argv[1];
1967 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1968 imagex_progress_func);
1972 image = wimlib_resolve_image(wim, image_num_or_name);
1974 ret = verify_image_exists(image, image_num_or_name, wimfile);
1976 goto out_wimlib_free;
1978 ret = wimlib_delete_image(wim, image);
1980 imagex_error(T("Failed to delete image from \"%"TS"\""),
1982 goto out_wimlib_free;
1985 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
1987 imagex_error(T("Failed to write the file \"%"TS"\" with image "
1988 "deleted"), wimfile);
1996 usage(CMD_DELETE, stderr);
2002 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2004 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2005 return (ret >= 0) ? 0 : -1;
2008 /* Print the files contained in an image(s) in a WIM file. */
2010 imagex_dir(int argc, tchar **argv, int cmd)
2012 const tchar *wimfile;
2013 WIMStruct *wim = NULL;
2016 const tchar *path = T("");
2019 for_opt(c, dir_options) {
2021 case IMAGEX_PATH_OPTION:
2032 imagex_error(T("Must specify a WIM file"));
2036 imagex_error(T("Too many arguments"));
2041 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &wim,
2042 imagex_progress_func);
2047 image = wimlib_resolve_image(wim, argv[1]);
2048 ret = verify_image_exists(image, argv[1], wimfile);
2050 goto out_wimlib_free;
2052 /* No image specified; default to image 1, but only if the WIM
2053 * contains exactly one image. */
2055 struct wimlib_wim_info info;
2057 wimlib_get_wim_info(wim, &info);
2058 if (info.image_count != 1) {
2059 imagex_error(T("\"%"TS"\" contains %d images; Please "
2060 "select one (or all)."),
2061 wimfile, info.image_count);
2068 ret = wimlib_iterate_dir_tree(wim, image, path,
2069 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2070 print_full_path, NULL);
2077 usage(CMD_DIR, stderr);
2082 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2085 imagex_export(int argc, tchar **argv, int cmd)
2089 int export_flags = 0;
2090 int write_flags = 0;
2091 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2092 const tchar *src_wimfile;
2093 const tchar *src_image_num_or_name;
2094 const tchar *dest_wimfile;
2096 const tchar *dest_name;
2097 const tchar *dest_desc;
2099 WIMStruct *dest_wim;
2104 const tchar *swm_glob = NULL;
2105 WIMStruct **additional_swms;
2106 unsigned num_additional_swms;
2107 unsigned num_threads = 0;
2109 for_opt(c, export_options) {
2111 case IMAGEX_BOOT_OPTION:
2112 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2114 case IMAGEX_CHECK_OPTION:
2115 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2116 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2118 case IMAGEX_NOCHECK_OPTION:
2119 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2121 case IMAGEX_COMPRESS_OPTION:
2122 compression_type = get_compression_type(optarg);
2123 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2126 case IMAGEX_REF_OPTION:
2129 case IMAGEX_THREADS_OPTION:
2130 num_threads = parse_num_threads(optarg);
2131 if (num_threads == UINT_MAX)
2134 case IMAGEX_REBUILD_OPTION:
2135 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2137 case IMAGEX_PIPABLE_OPTION:
2138 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2140 case IMAGEX_NOT_PIPABLE_OPTION:
2141 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2149 if (argc < 3 || argc > 5)
2151 src_wimfile = argv[0];
2152 src_image_num_or_name = argv[1];
2153 dest_wimfile = argv[2];
2154 dest_name = (argc >= 4) ? argv[3] : NULL;
2155 dest_desc = (argc >= 5) ? argv[4] : NULL;
2156 ret = wimlib_open_wim(src_wimfile,
2157 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_wim,
2158 imagex_progress_func);
2162 /* Determine if the destination is an existing file or not. If so, we
2163 * try to append the exported image(s) to it; otherwise, we create a new
2164 * WIM containing the exported image(s). Furthermore, determine if we
2165 * need to write a pipable WIM directly to standard output. */
2167 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2169 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2170 imagex_error("Can't write a non-pipable WIM to "
2171 "standard output! Specify --pipable\n"
2172 " if you want to create a pipable WIM "
2173 "(but read the docs first).");
2175 goto out_free_src_wim;
2178 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2180 dest_wimfile = NULL;
2181 dest_wim_fd = STDOUT_FILENO;
2182 imagex_info_file = stderr;
2183 set_fd_to_binary_mode(dest_wim_fd);
2186 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2188 /* Destination file exists. */
2190 if (!S_ISREG(stbuf.st_mode)) {
2191 imagex_error(T("\"%"TS"\" is not a regular file"),
2194 goto out_free_src_wim;
2196 ret = wimlib_open_wim(dest_wimfile, open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2197 &dest_wim, imagex_progress_func);
2199 goto out_free_src_wim;
2201 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2202 /* The user specified a compression type, but we're
2203 * exporting to an existing WIM. Make sure the
2204 * specified compression type is the same as the
2205 * compression type of the existing destination WIM. */
2206 struct wimlib_wim_info dest_info;
2208 wimlib_get_wim_info(dest_wim, &dest_info);
2209 if (compression_type != dest_info.compression_type) {
2210 imagex_error(T("Cannot specify a compression type that is "
2211 "not the same as that used in the "
2212 "destination WIM"));
2214 goto out_free_dest_wim;
2220 if (errno != ENOENT) {
2221 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2224 goto out_free_src_wim;
2227 /* dest_wimfile is not an existing file, so create a new WIM. */
2229 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2230 /* The user did not specify a compression type; default
2231 * to that of the source WIM. */
2233 struct wimlib_wim_info src_info;
2235 wimlib_get_wim_info(src_wim, &src_info);
2236 compression_type = src_info.compression_type;
2238 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2240 goto out_free_src_wim;
2243 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2244 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2246 goto out_free_dest_wim;
2249 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
2251 &num_additional_swms);
2253 goto out_free_dest_wim;
2255 additional_swms = NULL;
2256 num_additional_swms = 0;
2259 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2260 dest_desc, export_flags, additional_swms,
2261 num_additional_swms, imagex_progress_func);
2266 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2267 imagex_progress_func);
2268 else if (dest_wimfile)
2269 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2270 write_flags, num_threads,
2271 imagex_progress_func);
2273 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2274 WIMLIB_ALL_IMAGES, write_flags,
2275 num_threads, imagex_progress_func);
2277 imagex_error(T("Export failed."));
2279 for (unsigned i = 0; i < num_additional_swms; i++)
2280 wimlib_free(additional_swms[i]);
2281 free(additional_swms);
2283 wimlib_free(dest_wim);
2285 wimlib_free(src_wim);
2290 usage(CMD_EXPORT, stderr);
2297 is_root_wim_path(const tchar *path)
2300 for (p = path; *p; p++)
2301 if (*p != T('\\') && *p != T('/'))
2307 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2308 const tchar *dest_dir)
2310 for (size_t i = 0; i < num_cmds; i++)
2311 if (cmds[i].fs_dest_path != dest_dir)
2312 free(cmds[i].fs_dest_path);
2316 static struct wimlib_extract_command *
2317 prepare_extract_commands(tchar **paths, unsigned num_paths,
2318 int extract_flags, tchar *dest_dir,
2319 size_t *num_cmds_ret)
2321 struct wimlib_extract_command *cmds;
2323 tchar *emptystr = T("");
2325 if (num_paths == 0) {
2329 num_cmds = num_paths;
2330 cmds = calloc(num_cmds, sizeof(cmds[0]));
2332 imagex_error(T("Out of memory!"));
2336 for (size_t i = 0; i < num_cmds; i++) {
2337 cmds[i].extract_flags = extract_flags;
2338 cmds[i].wim_source_path = paths[i];
2339 if (is_root_wim_path(paths[i])) {
2340 cmds[i].fs_dest_path = dest_dir;
2342 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2343 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2344 if (!cmds[i].fs_dest_path) {
2345 free_extract_commands(cmds, num_cmds, dest_dir);
2348 tsprintf(cmds[i].fs_dest_path,
2349 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2350 dest_dir, tbasename(paths[i]));
2353 *num_cmds_ret = num_cmds;
2357 /* Extract files or directories from a WIM image */
2359 imagex_extract(int argc, tchar **argv, int cmd)
2362 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2366 const tchar *wimfile;
2367 const tchar *image_num_or_name;
2368 tchar *dest_dir = T(".");
2369 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2371 const tchar *swm_glob = NULL;
2372 WIMStruct **additional_swms;
2373 unsigned num_additional_swms;
2375 struct wimlib_extract_command *cmds;
2378 for_opt(c, extract_options) {
2380 case IMAGEX_CHECK_OPTION:
2381 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2383 case IMAGEX_VERBOSE_OPTION:
2384 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2386 case IMAGEX_REF_OPTION:
2389 case IMAGEX_UNIX_DATA_OPTION:
2390 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2392 case IMAGEX_NO_ACLS_OPTION:
2393 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2395 case IMAGEX_STRICT_ACLS_OPTION:
2396 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2398 case IMAGEX_DEST_DIR_OPTION:
2401 case IMAGEX_TO_STDOUT_OPTION:
2402 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2403 imagex_info_file = stderr;
2404 imagex_be_quiet = true;
2406 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2407 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2408 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2421 image_num_or_name = argv[1];
2426 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2431 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2435 image = wimlib_resolve_image(wim, image_num_or_name);
2436 ret = verify_image_exists_and_is_single(image,
2440 goto out_wimlib_free;
2443 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2445 &num_additional_swms);
2447 goto out_wimlib_free;
2449 additional_swms = NULL;
2450 num_additional_swms = 0;
2453 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2454 additional_swms, num_additional_swms,
2455 imagex_progress_func);
2457 if (!imagex_be_quiet)
2458 imagex_printf(T("Done extracting files.\n"));
2459 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2460 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2461 "files and directories\n"
2462 " are in the WIM image.\n"),
2463 get_cmd_string(CMD_INFO, false));
2465 for (unsigned i = 0; i < num_additional_swms; i++)
2466 wimlib_free(additional_swms[i]);
2467 free(additional_swms);
2471 free_extract_commands(cmds, num_cmds, dest_dir);
2476 usage(CMD_EXTRACT, stderr);
2482 static void print_byte_field(const uint8_t field[], size_t len)
2485 tprintf(T("%02hhx"), *field++);
2489 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2491 tputs(T("WIM Information:"));
2492 tputs(T("----------------"));
2493 tprintf(T("Path: %"TS"\n"), wimfile);
2494 tprintf(T("GUID: 0x"));
2495 print_byte_field(info->guid, sizeof(info->guid));
2497 tprintf(T("Image Count: %d\n"), info->image_count);
2498 tprintf(T("Compression: %"TS"\n"),
2499 wimlib_get_compression_type_string(info->compression_type));
2500 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2501 tprintf(T("Boot Index: %d\n"), info->boot_index);
2502 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2503 tprintf(T("Integrity Info: %"TS"\n"),
2504 info->has_integrity_table ? T("yes") : T("no"));
2505 tprintf(T("Relative path junction: %"TS"\n"),
2506 info->has_rpfix ? T("yes") : T("no"));
2507 tprintf(T("Pipable: %"TS"\n"),
2508 info->pipable ? T("yes") : T("no"));
2513 print_resource(const struct wimlib_resource_entry *resource,
2517 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2518 resource->uncompressed_size);
2520 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2521 resource->compressed_size);
2523 tprintf(T("Offset = %"PRIu64" bytes\n"),
2527 tprintf(T("Part Number = %u\n"), resource->part_number);
2528 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2530 tprintf(T("Hash = 0x"));
2531 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2534 tprintf(T("Flags = "));
2535 if (resource->is_compressed)
2536 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2537 if (resource->is_metadata)
2538 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2539 if (resource->is_free)
2540 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2541 if (resource->is_spanned)
2542 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2549 print_lookup_table(WIMStruct *wim)
2551 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2554 /* Prints information about a WIM file; also can mark an image as bootable,
2555 * change the name of an image, or change the description of an image. */
2557 imagex_info(int argc, tchar **argv, int cmd)
2562 bool nocheck = false;
2563 bool header = false;
2564 bool lookup_table = false;
2566 bool metadata = false;
2567 bool short_header = true;
2568 const tchar *xml_out_file = NULL;
2569 const tchar *wimfile;
2570 const tchar *image_num_or_name;
2571 const tchar *new_name;
2572 const tchar *new_desc;
2576 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2577 struct wimlib_wim_info info;
2579 for_opt(c, info_options) {
2581 case IMAGEX_BOOT_OPTION:
2584 case IMAGEX_CHECK_OPTION:
2587 case IMAGEX_NOCHECK_OPTION:
2590 case IMAGEX_HEADER_OPTION:
2592 short_header = false;
2594 case IMAGEX_LOOKUP_TABLE_OPTION:
2595 lookup_table = true;
2596 short_header = false;
2598 case IMAGEX_XML_OPTION:
2600 short_header = false;
2602 case IMAGEX_EXTRACT_XML_OPTION:
2603 xml_out_file = optarg;
2604 short_header = false;
2606 case IMAGEX_METADATA_OPTION:
2608 short_header = false;
2617 if (argc < 1 || argc > 4)
2621 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2622 new_name = (argc >= 3) ? argv[2] : NULL;
2623 new_desc = (argc >= 4) ? argv[3] : NULL;
2625 if (check && nocheck) {
2626 imagex_error(T("Can't specify both --check and --nocheck"));
2631 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2633 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2637 wimlib_get_wim_info(wim, &info);
2639 image = wimlib_resolve_image(wim, image_num_or_name);
2640 ret = WIMLIB_ERR_INVALID_IMAGE;
2641 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2642 imagex_error(T("The image \"%"TS"\" does not exist in \"%"TS"\""),
2643 image_num_or_name, wimfile);
2645 imagex_error(T("If you would like to set the boot "
2646 "index to 0, specify image \"0\" with "
2647 "the --boot flag."));
2649 goto out_wimlib_free;
2652 if (boot && info.image_count == 0) {
2653 imagex_error(T("--boot is meaningless on a WIM with no images"));
2654 goto out_wimlib_free;
2657 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2659 imagex_error(T("Cannot specify the --boot flag "
2660 "without specifying a specific "
2661 "image in a multi-image WIM"));
2662 goto out_wimlib_free;
2665 imagex_error(T("Cannot specify the NEW_NAME "
2666 "without specifying a specific "
2667 "image in a multi-image WIM"));
2668 goto out_wimlib_free;
2672 /* Operations that print information are separated from operations that
2673 * recreate the WIM file. */
2674 if (!new_name && !boot) {
2676 /* Read-only operations */
2678 if (image == WIMLIB_NO_IMAGE) {
2679 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2680 image_num_or_name, wimfile);
2681 goto out_wimlib_free;
2684 if (image == WIMLIB_ALL_IMAGES && short_header)
2685 print_wim_information(wimfile, &info);
2688 wimlib_print_header(wim);
2691 if (info.total_parts != 1) {
2692 tfprintf(stderr, T("Warning: Only showing the lookup table "
2693 "for part %d of a %d-part WIM.\n"),
2694 info.part_number, info.total_parts);
2696 print_lookup_table(wim);
2700 ret = wimlib_extract_xml_data(wim, stdout);
2702 goto out_wimlib_free;
2708 fp = tfopen(xml_out_file, T("wb"));
2710 imagex_error_with_errno(T("Failed to open the "
2711 "file \"%"TS"\" for "
2715 goto out_wimlib_free;
2717 ret = wimlib_extract_xml_data(wim, fp);
2719 imagex_error(T("Failed to close the file "
2725 goto out_wimlib_free;
2729 wimlib_print_available_images(wim, image);
2732 ret = wimlib_print_metadata(wim, image);
2734 goto out_wimlib_free;
2739 /* Modification operations */
2741 if (image == WIMLIB_ALL_IMAGES)
2744 if (image == WIMLIB_NO_IMAGE && new_name) {
2745 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2746 "when using image 0"), new_name);
2748 goto out_wimlib_free;
2752 if (image == info.boot_index) {
2753 imagex_printf(T("Image %d is already marked as "
2754 "bootable.\n"), image);
2757 imagex_printf(T("Marking image %d as bootable.\n"),
2759 info.boot_index = image;
2760 ret = wimlib_set_wim_info(wim, &info,
2761 WIMLIB_CHANGE_BOOT_INDEX);
2763 goto out_wimlib_free;
2767 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
2769 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
2773 imagex_printf(T("Changing the name of image %d to "
2774 "\"%"TS"\".\n"), image, new_name);
2775 ret = wimlib_set_image_name(wim, image, new_name);
2777 goto out_wimlib_free;
2781 const tchar *old_desc;
2782 old_desc = wimlib_get_image_description(wim, image);
2783 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2784 imagex_printf(T("The description of image %d is already "
2785 "\"%"TS"\".\n"), image, new_desc);
2788 imagex_printf(T("Changing the description of image %d "
2789 "to \"%"TS"\".\n"), image, new_desc);
2790 ret = wimlib_set_image_descripton(wim, image,
2793 goto out_wimlib_free;
2797 /* Only call wimlib_overwrite() if something actually needs to
2799 if (boot || new_name || new_desc ||
2800 (check && !info.has_integrity_table) ||
2801 (nocheck && info.has_integrity_table))
2803 int write_flags = 0;
2806 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2808 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2809 ret = wimlib_overwrite(wim, write_flags, 1,
2810 imagex_progress_func);
2812 imagex_printf(T("The file \"%"TS"\" was not modified "
2813 "because nothing needed to be done.\n"),
2824 usage(CMD_INFO, stderr);
2830 /* Join split WIMs into one part WIM */
2832 imagex_join(int argc, tchar **argv, int cmd)
2835 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2836 int wim_write_flags = 0;
2837 const tchar *output_path;
2840 for_opt(c, join_options) {
2842 case IMAGEX_CHECK_OPTION:
2843 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2844 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2854 imagex_error(T("Must specify one or more split WIM (.swm) "
2858 output_path = argv[0];
2859 ret = wimlib_join((const tchar * const *)++argv,
2864 imagex_progress_func);
2869 usage(CMD_JOIN, stderr);
2874 #if WIM_MOUNTING_SUPPORTED
2876 /* Mounts a WIM image. */
2878 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
2881 int mount_flags = 0;
2882 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2883 const tchar *swm_glob = NULL;
2884 const tchar *staging_dir = NULL;
2885 const tchar *wimfile;
2890 WIMStruct **additional_swms;
2891 unsigned num_additional_swms;
2893 if (cmd == CMD_MOUNTRW) {
2894 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
2895 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2898 for_opt(c, mount_options) {
2900 case IMAGEX_ALLOW_OTHER_OPTION:
2901 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
2903 case IMAGEX_CHECK_OPTION:
2904 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2906 case IMAGEX_DEBUG_OPTION:
2907 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
2909 case IMAGEX_STREAMS_INTERFACE_OPTION:
2910 if (!tstrcasecmp(optarg, T("none")))
2911 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
2912 else if (!tstrcasecmp(optarg, T("xattr")))
2913 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2914 else if (!tstrcasecmp(optarg, T("windows")))
2915 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
2917 imagex_error(T("Unknown stream interface \"%"TS"\""),
2922 case IMAGEX_REF_OPTION:
2925 case IMAGEX_STAGING_DIR_OPTION:
2926 staging_dir = optarg;
2928 case IMAGEX_UNIX_DATA_OPTION:
2929 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
2937 if (argc != 2 && argc != 3)
2942 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2947 /* Image explicitly specified. */
2948 image = wimlib_resolve_image(wim, argv[1]);
2950 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
2954 /* No image specified; default to image 1, but only if the WIM
2955 * contains exactly one image. */
2956 struct wimlib_wim_info info;
2958 wimlib_get_wim_info(wim, &info);
2959 if (info.image_count != 1) {
2960 imagex_error(T("\"%"TS"\" contains %d images; Please "
2961 "select one."), wimfile, info.image_count);
2970 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2972 &num_additional_swms);
2976 additional_swms = NULL;
2977 num_additional_swms = 0;
2980 ret = wimlib_mount_image(wim, image, dir, mount_flags, additional_swms,
2981 num_additional_swms, staging_dir);
2983 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
2985 image, wimfile, dir);
2987 for (unsigned i = 0; i < num_additional_swms; i++)
2988 wimlib_free(additional_swms[i]);
2989 free(additional_swms);
3000 #endif /* WIM_MOUNTING_SUPPORTED */
3002 /* Rebuild a WIM file */
3004 imagex_optimize(int argc, tchar **argv, int cmd)
3007 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3008 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3011 const tchar *wimfile;
3014 unsigned num_threads = 0;
3016 for_opt(c, optimize_options) {
3018 case IMAGEX_CHECK_OPTION:
3019 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3020 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3022 case IMAGEX_NOCHECK_OPTION:
3023 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3025 case IMAGEX_RECOMPRESS_OPTION:
3026 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3028 case IMAGEX_THREADS_OPTION:
3029 num_threads = parse_num_threads(optarg);
3030 if (num_threads == UINT_MAX)
3033 case IMAGEX_PIPABLE_OPTION:
3034 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3036 case IMAGEX_NOT_PIPABLE_OPTION:
3037 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3051 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3055 old_size = file_get_size(wimfile);
3056 tprintf(T("\"%"TS"\" original size: "), wimfile);
3058 tputs(T("Unknown"));
3060 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3062 ret = wimlib_overwrite(wim, write_flags, num_threads,
3063 imagex_progress_func);
3065 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3066 goto out_wimlib_free;
3069 new_size = file_get_size(wimfile);
3070 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3072 tputs(T("Unknown"));
3074 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3076 tfputs(T("Space saved: "), stdout);
3077 if (new_size != -1 && old_size != -1) {
3078 tprintf(T("%lld KiB\n"),
3079 ((long long)old_size - (long long)new_size) >> 10);
3081 tputs(T("Unknown"));
3090 usage(CMD_OPTIMIZE, stderr);
3096 /* Split a WIM into a spanned set */
3098 imagex_split(int argc, tchar **argv, int cmd)
3102 int write_flags = 0;
3103 unsigned long part_size;
3108 for_opt(c, split_options) {
3110 case IMAGEX_CHECK_OPTION:
3111 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3112 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3124 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3125 if (tmp == argv[2] || *tmp) {
3126 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3127 imagex_error(T("The part size must be an integer or "
3128 "floating-point number of megabytes."));
3131 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3135 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3141 usage(CMD_SPLIT, stderr);
3147 #if WIM_MOUNTING_SUPPORTED
3148 /* Unmounts a mounted WIM image. */
3150 imagex_unmount(int argc, tchar **argv, int cmd)
3153 int unmount_flags = 0;
3156 for_opt(c, unmount_options) {
3158 case IMAGEX_COMMIT_OPTION:
3159 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3161 case IMAGEX_CHECK_OPTION:
3162 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3164 case IMAGEX_REBUILD_OPTION:
3165 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3167 case IMAGEX_LAZY_OPTION:
3168 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3179 ret = wimlib_unmount_image(argv[0], unmount_flags,
3180 imagex_progress_func);
3182 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3187 usage(CMD_UNMOUNT, stderr);
3191 #endif /* WIM_MOUNTING_SUPPORTED */
3194 * Add, delete, or rename files in a WIM image.
3197 imagex_update(int argc, tchar **argv, int cmd)
3199 const tchar *wimfile;
3203 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3204 int write_flags = 0;
3205 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3206 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3207 WIMLIB_ADD_FLAG_WINCONFIG;
3208 int default_delete_flags = 0;
3209 unsigned num_threads = 0;
3211 tchar *cmd_file_contents;
3212 size_t cmd_file_nchars;
3213 struct wimlib_update_command *cmds;
3215 tchar *command_str = NULL;
3217 const tchar *config_file = NULL;
3219 struct wimlib_capture_config *config;
3221 for_opt(c, update_options) {
3223 /* Generic or write options */
3224 case IMAGEX_THREADS_OPTION:
3225 num_threads = parse_num_threads(optarg);
3226 if (num_threads == UINT_MAX)
3229 case IMAGEX_CHECK_OPTION:
3230 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3231 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3233 case IMAGEX_REBUILD_OPTION:
3234 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3236 case IMAGEX_COMMAND_OPTION:
3238 imagex_error(T("--command may only be specified "
3239 "one time. Please provide\n"
3240 " the update commands "
3241 "on standard input instead."));
3244 command_str = tstrdup(optarg);
3246 imagex_error(T("Out of memory!"));
3250 /* Default delete options */
3251 case IMAGEX_FORCE_OPTION:
3252 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3254 case IMAGEX_RECURSIVE_OPTION:
3255 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3258 /* Global add option */
3259 case IMAGEX_CONFIG_OPTION:
3260 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3261 config_file = optarg;
3264 /* Default add options */
3265 case IMAGEX_VERBOSE_OPTION:
3266 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3268 case IMAGEX_DEREFERENCE_OPTION:
3269 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3271 case IMAGEX_UNIX_DATA_OPTION:
3272 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3274 case IMAGEX_NO_ACLS_OPTION:
3275 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3277 case IMAGEX_STRICT_ACLS_OPTION:
3278 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3287 if (argc != 1 && argc != 2)
3291 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3293 goto out_free_command_str;
3296 /* Image explicitly specified. */
3297 image = wimlib_resolve_image(wim, argv[1]);
3298 ret = verify_image_exists_and_is_single(image, argv[1],
3301 goto out_wimlib_free;
3303 /* No image specified; default to image 1, but only if the WIM
3304 * contains exactly one image. */
3305 struct wimlib_wim_info info;
3307 wimlib_get_wim_info(wim, &info);
3308 if (info.image_count != 1) {
3309 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3310 wimfile, info.image_count);
3317 /* Parse capture configuration file if specified */
3321 config_str = file_get_text_contents(config_file, &config_len);
3324 goto out_wimlib_free;
3327 config = alloca(sizeof(*config));
3328 ret = parse_capture_config(&config_str, config_len, config);
3330 goto out_free_config;
3335 /* Read update commands from standard input, or the command string if
3338 cmd_file_contents = NULL;
3339 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3342 if (isatty(STDIN_FILENO)) {
3343 tputs(T("Reading update commands from standard input..."));
3344 recommend_man_page(CMD_UPDATE, stdout);
3346 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3347 if (!cmd_file_contents) {
3349 goto out_free_config;
3352 /* Parse the update commands */
3353 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3358 goto out_free_cmd_file_contents;
3361 /* Set default flags and capture config on the update commands */
3362 for (size_t i = 0; i < num_cmds; i++) {
3363 switch (cmds[i].op) {
3364 case WIMLIB_UPDATE_OP_ADD:
3365 cmds[i].add.add_flags |= default_add_flags;
3366 cmds[i].add.config = config;
3368 case WIMLIB_UPDATE_OP_DELETE:
3369 cmds[i].delete.delete_flags |= default_delete_flags;
3376 /* Execute the update commands */
3377 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3378 imagex_progress_func);
3382 /* Overwrite the updated WIM */
3383 ret = wimlib_overwrite(wim, write_flags, num_threads,
3384 imagex_progress_func);
3387 out_free_cmd_file_contents:
3388 free(cmd_file_contents);
3391 free(config->exclusion_pats.pats);
3392 free(config->exclusion_exception_pats.pats);
3397 out_free_command_str:
3402 usage(CMD_UPDATE, stderr);
3405 goto out_free_command_str;
3410 struct imagex_command {
3412 int (*func)(int argc, tchar **argv, int cmd);
3415 static const struct imagex_command imagex_commands[] = {
3416 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3417 [CMD_APPLY] = {T("apply"), imagex_apply},
3418 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3419 [CMD_DELETE] = {T("delete"), imagex_delete},
3420 [CMD_DIR ] = {T("dir"), imagex_dir},
3421 [CMD_EXPORT] = {T("export"), imagex_export},
3422 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3423 [CMD_INFO] = {T("info"), imagex_info},
3424 [CMD_JOIN] = {T("join"), imagex_join},
3425 #if WIM_MOUNTING_SUPPORTED
3426 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3427 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3429 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3430 [CMD_SPLIT] = {T("split"), imagex_split},
3431 #if WIM_MOUNTING_SUPPORTED
3432 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3434 [CMD_UPDATE] = {T("update"), imagex_update},
3437 static const tchar *usage_strings[] = {
3440 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3441 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3442 " [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3443 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3444 " [--rebuild] [--unix-data] [--source-list] [--no-acls]\n"
3445 " [--strict-acls] [--rpfix] [--norpfix] [--pipable]\n"
3446 " [--not-pipable]\n"
3450 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3451 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3452 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3453 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3454 " [--include-invalid-names]\n"
3458 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3459 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3460 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3461 " [--verbose] [--dereference] [--config=FILE]\n"
3462 " [--threads=NUM_THREADS] [--unix-data] [--source-list]\n"
3463 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3464 " [--pipable] [--not-pipable]\n"
3468 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3473 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3477 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3478 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3479 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3480 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3481 " [--pipable] [--not-pipable]\n"
3485 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3486 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3487 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3488 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3492 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3493 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3494 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3499 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3501 #if WIM_MOUNTING_SUPPORTED
3504 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3505 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3506 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3510 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3511 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3512 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3517 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3518 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3522 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3524 #if WIM_MOUNTING_SUPPORTED
3527 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3532 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3533 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3534 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3538 static const tchar *invocation_name;
3539 static bool using_cmd_from_invocation_name = false;
3541 static const tchar *get_cmd_string(int cmd, bool nospace)
3544 if (using_cmd_from_invocation_name || cmd == CMD_NONE) {
3545 return invocation_name;
3547 const tchar *format;
3548 static tchar buf[50];
3551 format = T("%"TS"-%"TS"");
3553 format = T("%"TS" %"TS"");
3554 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3562 static const tchar *s =
3564 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3565 "Copyright (C) 2012, 2013 Eric Biggers\n"
3566 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3567 "This is free software: you are free to change and redistribute it.\n"
3568 "There is NO WARRANTY, to the extent permitted by law.\n"
3570 "Report bugs to "PACKAGE_BUGREPORT".\n"
3577 help_or_version(int argc, tchar **argv, int cmd)
3582 for (i = 1; i < argc; i++) {
3584 if (p[0] == T('-') && p[1] == T('-')) {
3586 if (!tstrcmp(p, T("help"))) {
3587 if (cmd == CMD_NONE)
3592 } else if (!tstrcmp(p, T("version"))) {
3601 print_usage_string(int cmd, FILE *fp)
3603 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3607 recommend_man_page(int cmd, FILE *fp)
3609 const tchar *format_str;
3611 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3613 format_str = T("Try `man %"TS"' for more details.\n");
3615 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3619 usage(int cmd, FILE *fp)
3621 tfprintf(fp, T("Usage:\n"));
3622 print_usage_string(cmd, fp);
3623 tfprintf(fp, T("\n"));
3624 recommend_man_page(cmd, fp);
3630 tfprintf(fp, T("Usage:\n"));
3631 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3632 print_usage_string(cmd, fp);
3633 tfprintf(fp, T("\n"));
3635 static const tchar *extra =
3638 " %"TS" --version\n"
3640 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3643 tfprintf(fp, extra, invocation_name, invocation_name);
3644 recommend_man_page(CMD_NONE, fp);
3647 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3648 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3649 * something else), while an Windows the command arguments will be UTF-16LE
3650 * encoded 'wchar_t' strings. */
3653 wmain(int argc, wchar_t **argv, wchar_t **envp)
3655 main(int argc, char **argv)
3662 imagex_info_file = stdout;
3663 invocation_name = tbasename(argv[0]);
3666 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3667 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3671 setlocale(LC_ALL, "");
3672 codeset = nl_langinfo(CODESET);
3673 if (!strstr(codeset, "UTF-8") &&
3674 !strstr(codeset, "UTF8") &&
3675 !strstr(codeset, "utf-8") &&
3676 !strstr(codeset, "utf8"))
3679 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3680 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3681 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3682 " to any value to force wimlib to use UTF-8.\n",
3687 #endif /* !__WIN32__ */
3689 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3691 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3692 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3693 for (int i = 0; i < CMD_MAX; i++) {
3694 if (!tstrcmp(invocation_name + 3,
3695 imagex_commands[i].name))
3697 using_cmd_from_invocation_name = true;
3704 /* Unless already known from the invocation name, determine which
3705 * command was specified. */
3706 if (cmd == CMD_NONE) {
3708 imagex_error(T("No command specified!\n"));
3712 for (int i = 0; i < CMD_MAX; i++) {
3713 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3718 if (cmd != CMD_NONE) {
3724 /* Handle --help and --version. --help can be either for the program as
3725 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3726 * CMD_NONE). Note: help_or_version() will not return if a --help or
3727 * --version argument was found. */
3728 help_or_version(argc, argv, cmd);
3730 /* Bail if a valid command was not specified. */
3731 if (cmd == CMD_NONE) {
3732 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3737 /* Enable warning and error messages in wimlib be more user-friendly.
3739 wimlib_set_print_errors(true);
3741 /* Initialize wimlib. */
3742 ret = wimlib_global_init(init_flags);
3744 goto out_check_status;
3746 /* Call the command handler function. */
3747 ret = imagex_commands[cmd].func(argc, argv, cmd);
3749 /* Check for error writing to standard output, especially since for some
3750 * commands, writing to standard output is part of the program's actual
3751 * behavior and not just for informational purposes. */
3752 if (ferror(stdout) || fclose(stdout)) {
3753 imagex_error_with_errno(T("error writing to standard output"));
3758 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3759 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
3760 * error code from which an error message can be printed. */
3762 imagex_error(T("Exiting with error code %d:\n"
3764 wimlib_get_error_string(ret));
3765 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3766 imagex_error_with_errno(T("errno"));
3768 /* Make wimlib free any resources it's holding (although this is not
3769 * strictly necessary because the process is ending anyway). */
3770 wimlib_global_cleanup();