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},
177 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
181 static const struct option capture_or_append_options[] = {
182 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
183 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
184 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
185 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
186 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
187 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
188 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
189 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
190 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
191 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
192 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
193 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
194 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
195 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
196 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
197 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
198 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
199 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
200 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
201 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
205 static const struct option delete_options[] = {
206 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
207 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
211 static const struct option dir_options[] = {
212 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
216 static const struct option export_options[] = {
217 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
218 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
219 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
220 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
221 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
222 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
223 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
224 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
225 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
226 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
230 static const struct option extract_options[] = {
231 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
232 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
233 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
234 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
235 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
236 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
237 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
238 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
239 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
240 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
244 static const struct option info_options[] = {
245 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
246 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
247 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
248 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
249 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
250 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
251 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
252 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
253 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
257 static const struct option join_options[] = {
258 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
262 static const struct option mount_options[] = {
263 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
264 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
265 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
266 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
267 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
268 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
269 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
273 static const struct option optimize_options[] = {
274 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
275 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
276 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
277 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
278 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
279 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
280 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
284 static const struct option split_options[] = {
285 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
289 static const struct option unmount_options[] = {
290 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
291 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
292 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
293 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
297 static const struct option update_options[] = {
298 /* Careful: some of the options here set the defaults for update
299 * commands, but the flags given to an actual update command (and not to
300 * `imagex update' itself are also handled in
301 * update_command_add_option(). */
302 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
303 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
304 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
305 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
307 /* Default delete options */
308 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
309 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
311 /* Global add option */
312 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
314 /* Default add options */
315 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
316 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
317 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
318 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
319 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
320 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
326 # define _format_attribute(type, format_str, args_start) \
327 __attribute__((format(type, format_str, args_start)))
329 # define _format_attribute(type, format_str, args_start)
332 /* Print formatted error message to stderr. */
333 static void _format_attribute(printf, 1, 2)
334 imagex_error(const tchar *format, ...)
337 va_start(va, format);
338 tfputs(T("ERROR: "), stderr);
339 tvfprintf(stderr, format, va);
340 tputc(T('\n'), stderr);
344 /* Print formatted error message to stderr. */
345 static void _format_attribute(printf, 1, 2)
346 imagex_error_with_errno(const tchar *format, ...)
348 int errno_save = errno;
350 va_start(va, format);
351 tfputs(T("ERROR: "), stderr);
352 tvfprintf(stderr, format, va);
353 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
358 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
360 if (image == WIMLIB_NO_IMAGE) {
361 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
362 " Please specify a 1-based image index or "
364 " You may use `%"TS"' to list the images "
365 "contained in a WIM."),
366 image_name, wim_name, get_cmd_string(CMD_INFO, false));
373 verify_image_is_single(int image)
375 if (image == WIMLIB_ALL_IMAGES) {
376 imagex_error(T("Cannot specify all images for this action!"));
383 verify_image_exists_and_is_single(int image, const tchar *image_name,
384 const tchar *wim_name)
387 ret = verify_image_exists(image, image_name, wim_name);
389 ret = verify_image_is_single(image);
393 /* Parse the argument to --compress */
395 get_compression_type(const tchar *optarg)
397 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
398 return WIMLIB_COMPRESSION_TYPE_LZX;
399 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
400 return WIMLIB_COMPRESSION_TYPE_XPRESS;
401 else if (!tstrcasecmp(optarg, T("none")))
402 return WIMLIB_COMPRESSION_TYPE_NONE;
404 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
405 "\"maximum\", \"fast\", or \"none\"."), optarg);
406 return WIMLIB_COMPRESSION_TYPE_INVALID;
410 /* Returns the size of a file given its name, or -1 if the file does not exist
411 * or its size cannot be determined. */
413 file_get_size(const tchar *filename)
416 if (tstat(filename, &st) == 0)
422 tchar pat_ntfs_log[] = T("/$ntfs.log");
423 tchar pat_hiberfil_sys[] = T("/hiberfil.sys");
424 tchar pat_pagefile_sys[] = T("/pagefile.sys");
425 tchar pat_system_volume_information[] = T("/System Volume Information");
426 tchar pat_recycler[] = T("/RECYCLER");
427 tchar pat_windows_csc[] = T("/Windows/CSC");
429 tchar *default_pats[] = {
433 pat_system_volume_information,
438 static struct wimlib_capture_config default_capture_config = {
440 .num_pats = sizeof(default_pats) / sizeof(default_pats[0]),
441 .pats = default_pats,
446 PARSE_STRING_SUCCESS = 0,
447 PARSE_STRING_FAILURE = 1,
448 PARSE_STRING_NONE = 2,
452 * Parses a string token from an array of characters.
454 * Tokens are either whitespace-delimited, or double or single-quoted.
456 * @line_p: Pointer to the pointer to the line of data. Will be updated
457 * to point past the string token iff the return value is
458 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
461 * @len_p: @len_p initially stores the length of the line of data, which may
462 * be 0, and it will be updated to the number of bytes remaining in
463 * the line iff the return value is PARSE_STRING_SUCCESS.
465 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
466 * parsed string token will be returned here.
468 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
469 * PARSE_STRING_FAILURE if the data was invalid due to a missing
470 * closing quote; or PARSE_STRING_NONE if the line ended before the
471 * beginning of a string token was found.
474 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
477 tchar *line = *line_p;
481 /* Skip leading whitespace */
484 return PARSE_STRING_NONE;
485 if (!istspace(*line) && *line != T('\0'))
491 if (quote_char == T('"') || quote_char == T('\'')) {
496 line = tmemchr(line, quote_char, len);
498 imagex_error(T("Missing closing quote: %"TS), fn - 1);
499 return PARSE_STRING_FAILURE;
502 /* Unquoted string. Go until whitespace. Line is terminated
503 * by '\0', so no need to check 'len'. */
507 } while (!istspace(*line) && *line != T('\0'));
514 return PARSE_STRING_SUCCESS;
517 /* Parses a line of data (not an empty line or comment) in the source list file
518 * format. (See the man page for 'wimlib-imagex capture' for details on this
519 * format and the meaning.)
521 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
522 * len == 0. The data in @line will be modified by this function call.
524 * @len: Length of the line of data.
526 * @source: On success, the capture source and target described by the line is
527 * written into this destination. Note that it will contain pointers
528 * to data in the @line array.
530 * Returns true if the line was valid; false otherwise. */
532 parse_source_list_line(tchar *line, size_t len,
533 struct wimlib_capture_source *source)
537 ret = parse_string(&line, &len, &source->fs_source_path);
538 if (ret != PARSE_STRING_SUCCESS)
540 ret = parse_string(&line, &len, &source->wim_target_path);
541 if (ret == PARSE_STRING_NONE)
542 source->wim_target_path = source->fs_source_path;
543 return ret != PARSE_STRING_FAILURE;
546 /* Returns %true if the given line of length @len > 0 is a comment or empty line
547 * in the source list file format. */
549 is_comment_line(const tchar *line, size_t len)
554 if (!istspace(*line) && *line != T('\0'))
564 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
567 tchar *contents = *contents_p;
568 size_t nchars = *nchars_p;
571 for (i = 0; i < nchars; i++)
572 if (contents[i] == T('\n'))
575 /* Handle last line not terminated by a newline */
576 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
577 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
579 imagex_error(T("Out of memory!"));
582 contents[nchars] = T('\n');
583 *contents_p = contents;
591 /* Parses a file in the source list format. (See the man page for
592 * 'wimlib-imagex capture' for details on this format and the meaning.)
594 * @source_list_contents: Contents of the source list file. Note that this
595 * buffer will be modified to save memory allocations,
596 * and cannot be freed until the returned array of
597 * wimlib_capture_source's has also been freed.
599 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
602 * @nsources_ret: On success, the length of the returned array is
605 * Returns: An array of `struct wimlib_capture_source's that can be passed to
606 * the wimlib_add_image_multisource() function to specify how a WIM image is to
608 static struct wimlib_capture_source *
609 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
610 size_t *nsources_ret)
614 struct wimlib_capture_source *sources;
617 nlines = text_file_count_lines(source_list_contents_p,
618 &source_list_nchars);
622 /* Always allocate at least 1 slot, just in case the implementation of
623 * calloc() returns NULL if 0 bytes are requested. */
624 sources = calloc(nlines ?: 1, sizeof(*sources));
626 imagex_error(T("out of memory"));
629 p = *source_list_contents_p;
631 for (i = 0; i < nlines; i++) {
632 /* XXX: Could use rawmemchr() here instead, but it may not be
633 * available on all platforms. */
634 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
635 size_t len = endp - p + 1;
637 if (!is_comment_line(p, len)) {
638 if (!parse_source_list_line(p, len, &sources[j++])) {
651 enum capture_config_section {
652 CAPTURE_CONFIG_NO_SECTION,
653 CAPTURE_CONFIG_EXCLUSION_SECTION,
654 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
655 CAPTURE_CONFIG_IGNORE_SECTION,
659 CAPTURE_CONFIG_INVALID_SECTION,
660 CAPTURE_CONFIG_CHANGED_SECTION,
661 CAPTURE_CONFIG_SAME_SECTION,
665 check_config_section(tchar *line, size_t len,
666 enum capture_config_section *cur_section)
668 while (istspace(*line))
672 return CAPTURE_CONFIG_SAME_SECTION;
675 tchar *endbrace = tstrrchr(line, T(']'));
677 return CAPTURE_CONFIG_SAME_SECTION;
679 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
680 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
681 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
682 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
683 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
684 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
685 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
686 "of capture config file\n"),
688 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
689 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
690 tfputs(T("WARNING: Ignoring [AlignmentList] section "
691 "of capture config file\n"),
694 imagex_error(T("Invalid capture config file section \"%"TS"\""),
696 return CAPTURE_CONFIG_INVALID_SECTION;
698 return CAPTURE_CONFIG_CHANGED_SECTION;
703 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
706 if (pat_list->num_pats == pat_list->num_allocated_pats) {
708 size_t num_allocated_pats = pat_list->num_pats + 8;
710 pats = realloc(pat_list->pats,
711 num_allocated_pats * sizeof(pat_list->pats[0]));
713 imagex_error(T("Out of memory!"));
716 pat_list->pats = pats;
717 pat_list->num_allocated_pats = num_allocated_pats;
719 pat_list->pats[pat_list->num_pats++] = pat;
724 parse_capture_config_line(tchar *line, size_t len,
725 enum capture_config_section *cur_section,
726 struct wimlib_capture_config *config)
731 ret = check_config_section(line, len, cur_section);
732 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
734 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
737 switch (*cur_section) {
738 case CAPTURE_CONFIG_NO_SECTION:
739 imagex_error(T("Line \"%"TS"\" is not in a section "
740 "(such as [ExclusionList]"), line);
742 case CAPTURE_CONFIG_EXCLUSION_SECTION:
743 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
745 return pattern_list_add_pattern(&config->exclusion_pats,
747 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
748 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
750 return pattern_list_add_pattern(&config->exclusion_exception_pats,
752 case CAPTURE_CONFIG_IGNORE_SECTION:
759 parse_capture_config(tchar **contents_p, size_t nchars,
760 struct wimlib_capture_config *config)
765 enum capture_config_section cur_section;
767 memset(config, 0, sizeof(*config));
769 nlines = text_file_count_lines(contents_p, &nchars);
773 cur_section = CAPTURE_CONFIG_NO_SECTION;
775 for (i = 0; i < nlines; i++) {
776 tchar *endp = tmemchr(p, T('\n'), nchars);
777 size_t len = endp - p + 1;
779 if (!is_comment_line(p, len))
780 if (!parse_capture_config_line(p, len, &cur_section, config))
788 /* Reads the contents of a file into memory. */
790 file_get_contents(const tchar *filename, size_t *len_ret)
797 if (tstat(filename, &stbuf) != 0) {
798 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
803 fp = tfopen(filename, T("rb"));
805 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
809 buf = malloc(len ? len : 1);
811 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
812 "contents of file \"%"TS"\""), len, filename);
815 if (fread(buf, 1, len, fp) != len) {
816 imagex_error_with_errno(T("Failed to read %zu bytes from the "
817 "file \"%"TS"\""), len, filename);
831 /* Read standard input until EOF and return the full contents in a malloc()ed
832 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
835 stdin_get_contents(size_t *len_ret)
837 /* stdin can, of course, be a pipe or other non-seekable file, so the
838 * total length of the data cannot be pre-determined */
840 size_t newlen = 1024;
844 char *p = realloc(buf, newlen);
845 size_t bytes_read, bytes_to_read;
847 imagex_error(T("out of memory while reading stdin"));
851 bytes_to_read = newlen - pos;
852 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
854 if (bytes_read != bytes_to_read) {
859 imagex_error_with_errno(T("error reading stdin"));
873 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
876 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
878 *num_tchars_ret = num_bytes;
880 #else /* !__WIN32__ */
881 /* On Windows, translate the text to UTF-16LE */
885 if (num_bytes >= 2 &&
886 ((text[0] == 0xff && text[1] == 0xfe) ||
887 (text[0] <= 0x7f && text[1] == 0x00)))
889 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
890 * with something that looks like an ASCII character encoded as
891 * a UTF-16LE code unit. Assume the file is encoded as
892 * UTF-16LE. This is not a 100% reliable check. */
893 num_wchars = num_bytes / 2;
894 text_wstr = (wchar_t*)text;
896 /* File does not look like UTF-16LE. Assume it is encoded in
897 * the current Windows code page. I think these are always
898 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
899 * should work as expected. */
900 text_wstr = win32_mbs_to_wcs(text,
905 *num_tchars_ret = num_wchars;
907 #endif /* __WIN32__ */
911 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
916 contents = file_get_contents(filename, &num_bytes);
919 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
923 stdin_get_text_contents(size_t *num_tchars_ret)
928 contents = stdin_get_contents(&num_bytes);
931 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
934 #define TO_PERCENT(numerator, denominator) \
935 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
937 /* Given an enumerated value for WIM compression type, return a descriptive
940 get_data_type(int ctype)
943 case WIMLIB_COMPRESSION_TYPE_NONE:
944 return T("uncompressed");
945 case WIMLIB_COMPRESSION_TYPE_LZX:
946 return T("LZX-compressed");
947 case WIMLIB_COMPRESSION_TYPE_XPRESS:
948 return T("XPRESS-compressed");
953 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
954 #define MEBIBYTE_MIN_NBYTES 10000000ULL
955 #define KIBIBYTE_MIN_NBYTES 10000ULL
958 get_unit(uint64_t total_bytes, const tchar **name_ret)
960 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
961 *name_ret = T("GiB");
963 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
964 *name_ret = T("MiB");
966 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
967 *name_ret = T("KiB");
970 *name_ret = T("bytes");
975 /* Progress callback function passed to various wimlib functions. */
977 imagex_progress_func(enum wimlib_progress_msg msg,
978 const union wimlib_progress_info *info)
980 unsigned percent_done;
982 const tchar *unit_name;
986 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
987 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
988 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
989 info->write_streams.total_bytes);
991 if (info->write_streams.completed_streams == 0) {
992 const tchar *data_type;
994 data_type = get_data_type(info->write_streams.compression_type);
995 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
996 data_type, info->write_streams.num_threads,
997 (info->write_streams.num_threads == 1) ? T("") : T("s"));
999 if (info->write_streams.total_parts <= 1) {
1000 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1001 "written (%u%% done)"),
1002 info->write_streams.completed_bytes >> unit_shift,
1004 info->write_streams.total_bytes >> unit_shift,
1008 imagex_printf(T("\rWriting resources from part %u of %u: "
1009 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1010 (info->write_streams.completed_parts ==
1011 info->write_streams.total_parts) ?
1012 info->write_streams.completed_parts :
1013 info->write_streams.completed_parts + 1,
1014 info->write_streams.total_parts,
1015 info->write_streams.completed_bytes >> unit_shift,
1017 info->write_streams.total_bytes >> unit_shift,
1021 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1022 imagex_printf(T("\n"));
1024 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1025 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1026 if (*info->scan.wim_target_path) {
1027 imagex_printf(T(" (loading as WIM path: "
1028 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1029 info->scan.wim_target_path);
1031 imagex_printf(T(" (loading as root of WIM image)...\n"));
1034 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1035 switch (info->scan.status) {
1036 case WIMLIB_SCAN_DENTRY_OK:
1037 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1039 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1040 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1042 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1043 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1044 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1048 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1049 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1050 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1051 info->integrity.total_bytes);
1052 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1053 "of %"PRIu64" %"TS" (%u%%) done"),
1054 info->integrity.filename,
1055 info->integrity.completed_bytes >> unit_shift,
1057 info->integrity.total_bytes >> unit_shift,
1060 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1061 imagex_printf(T("\n"));
1063 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1064 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1065 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1066 info->integrity.total_bytes);
1067 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1068 "of %"PRIu64" %"TS" (%u%%) done"),
1069 info->integrity.completed_bytes >> unit_shift,
1071 info->integrity.total_bytes >> unit_shift,
1074 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1075 imagex_printf(T("\n"));
1077 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1078 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1079 "to %"TS" \"%"TS"\"\n"),
1080 info->extract.image,
1081 info->extract.image_name,
1082 info->extract.wimfile_name,
1083 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1084 T("NTFS volume") : T("directory")),
1085 info->extract.target);
1087 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1088 imagex_printf(T("Extracting "
1089 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1090 "in \"%"TS"\" to \"%"TS"\"\n"),
1091 info->extract.extract_root_wim_source_path,
1092 info->extract.image,
1093 info->extract.image_name,
1094 info->extract.wimfile_name,
1095 info->extract.target);
1097 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1098 percent_done = TO_PERCENT(info->extract.completed_bytes,
1099 info->extract.total_bytes);
1100 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1101 imagex_printf(T("\rExtracting files: "
1102 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1103 info->extract.completed_bytes >> unit_shift,
1105 info->extract.total_bytes >> unit_shift,
1108 if (info->extract.completed_bytes >= info->extract.total_bytes)
1109 imagex_printf(T("\n"));
1111 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1112 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1113 info->extract.part_number,
1114 info->extract.total_parts);
1116 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1117 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1118 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1120 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1121 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1122 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1123 info->extract.target);
1126 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1127 percent_done = TO_PERCENT(info->split.completed_bytes,
1128 info->split.total_bytes);
1129 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1130 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1131 "%"PRIu64" %"TS" (%u%%) written\n"),
1132 info->split.part_name,
1133 info->split.cur_part_number,
1134 info->split.total_parts,
1135 info->split.completed_bytes >> unit_shift,
1137 info->split.total_bytes >> unit_shift,
1141 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1142 if (info->split.completed_bytes == info->split.total_bytes) {
1143 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1144 info->split.cur_part_number,
1145 info->split.total_parts);
1148 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1149 switch (info->update.command->op) {
1150 case WIMLIB_UPDATE_OP_DELETE:
1151 imagex_printf(T("Deleted WIM path "
1152 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1153 info->update.command->delete.wim_path);
1155 case WIMLIB_UPDATE_OP_RENAME:
1156 imagex_printf(T("Renamed WIM path "
1157 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1158 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1159 info->update.command->rename.wim_source_path,
1160 info->update.command->rename.wim_target_path);
1162 case WIMLIB_UPDATE_OP_ADD:
1170 fflush(imagex_info_file);
1174 /* Open all the split WIM parts that correspond to a file glob.
1176 * @first_part specifies the first part of the split WIM and it may be either
1177 * included or omitted from the glob. */
1179 open_swms_from_glob(const tchar *swm_glob,
1180 const tchar *first_part,
1182 WIMStruct ***additional_swms_ret,
1183 unsigned *num_additional_swms_ret)
1185 unsigned num_additional_swms = 0;
1186 WIMStruct **additional_swms = NULL;
1190 /* Warning: glob() is replaced in Windows native builds */
1191 ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
1193 if (ret == GLOB_NOMATCH) {
1194 imagex_error(T("Found no files for glob \"%"TS"\""),
1197 imagex_error_with_errno(T("Failed to process glob \"%"TS"\""),
1203 num_additional_swms = globbuf.gl_pathc;
1204 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
1205 if (!additional_swms) {
1206 imagex_error(T("Out of memory"));
1210 unsigned offset = 0;
1211 for (unsigned i = 0; i < num_additional_swms; i++) {
1212 if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) {
1216 ret = wimlib_open_wim(globbuf.gl_pathv[i],
1217 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
1218 &additional_swms[i - offset],
1219 imagex_progress_func);
1221 goto out_close_swms;
1223 *additional_swms_ret = additional_swms;
1224 *num_additional_swms_ret = num_additional_swms - offset;
1228 for (unsigned i = 0; i < num_additional_swms; i++)
1229 wimlib_free(additional_swms[i]);
1230 free(additional_swms);
1239 parse_num_threads(const tchar *optarg)
1242 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1243 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1244 imagex_error(T("Number of threads must be a non-negative integer!"));
1252 * Parse an option passed to an update command.
1254 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1257 * @option: Text string for the option (beginning with --)
1259 * @cmd: `struct wimlib_update_command' that is being constructed for
1262 * Returns true if the option was recognized; false if not.
1265 update_command_add_option(int op, const tchar *option,
1266 struct wimlib_update_command *cmd)
1268 bool recognized = true;
1270 case WIMLIB_UPDATE_OP_ADD:
1271 if (!tstrcmp(option, T("--verbose")))
1272 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1273 else if (!tstrcmp(option, T("--unix-data")))
1274 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1275 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1276 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1277 else if (!tstrcmp(option, T("--strict-acls")))
1278 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1279 else if (!tstrcmp(option, T("--dereference")))
1280 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1284 case WIMLIB_UPDATE_OP_DELETE:
1285 if (!tstrcmp(option, T("--force")))
1286 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1287 else if (!tstrcmp(option, T("--recursive")))
1288 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1299 /* How many nonoption arguments each `imagex update' command expects */
1300 static const unsigned update_command_num_nonoptions[] = {
1301 [WIMLIB_UPDATE_OP_ADD] = 2,
1302 [WIMLIB_UPDATE_OP_DELETE] = 1,
1303 [WIMLIB_UPDATE_OP_RENAME] = 2,
1307 update_command_add_nonoption(int op, const tchar *nonoption,
1308 struct wimlib_update_command *cmd,
1309 unsigned num_nonoptions)
1312 case WIMLIB_UPDATE_OP_ADD:
1313 if (num_nonoptions == 0)
1314 cmd->add.fs_source_path = (tchar*)nonoption;
1316 cmd->add.wim_target_path = (tchar*)nonoption;
1318 case WIMLIB_UPDATE_OP_DELETE:
1319 cmd->delete.wim_path = (tchar*)nonoption;
1321 case WIMLIB_UPDATE_OP_RENAME:
1322 if (num_nonoptions == 0)
1323 cmd->rename.wim_source_path = (tchar*)nonoption;
1325 cmd->rename.wim_target_path = (tchar*)nonoption;
1331 * Parse a command passed on stdin to `imagex update'.
1333 * @line: Text of the command.
1334 * @len: Length of the line, including a null terminator
1337 * @command: A `struct wimlib_update_command' to fill in from the parsed
1340 * @line_number: Line number of the command, for diagnostics.
1342 * Returns true on success; returns false on parse error.
1345 parse_update_command(tchar *line, size_t len,
1346 struct wimlib_update_command *command,
1350 tchar *command_name;
1352 size_t num_nonoptions;
1354 /* Get the command name ("add", "delete", "rename") */
1355 ret = parse_string(&line, &len, &command_name);
1356 if (ret != PARSE_STRING_SUCCESS)
1359 if (!tstrcasecmp(command_name, T("add"))) {
1360 op = WIMLIB_UPDATE_OP_ADD;
1361 } else if (!tstrcasecmp(command_name, T("delete"))) {
1362 op = WIMLIB_UPDATE_OP_DELETE;
1363 } else if (!tstrcasecmp(command_name, T("rename"))) {
1364 op = WIMLIB_UPDATE_OP_RENAME;
1366 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1367 command_name, line_number);
1372 /* Parse additional options and non-options as needed */
1377 ret = parse_string(&line, &len, &next_string);
1378 if (ret == PARSE_STRING_NONE) /* End of line */
1380 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1382 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1384 if (!update_command_add_option(op, next_string, command))
1386 imagex_error(T("Unrecognized option \"%"TS"\" to "
1387 "update command \"%"TS"\" on line %zu"),
1388 next_string, command_name, line_number);
1394 if (num_nonoptions == update_command_num_nonoptions[op])
1396 imagex_error(T("Unexpected argument \"%"TS"\" in "
1397 "update command on line %zu\n"
1398 " (The \"%"TS"\" command only "
1399 "takes %zu nonoption arguments!)\n"),
1400 next_string, line_number,
1401 command_name, num_nonoptions);
1404 update_command_add_nonoption(op, next_string,
1405 command, num_nonoptions);
1410 if (num_nonoptions != update_command_num_nonoptions[op]) {
1411 imagex_error(T("Not enough arguments to update command "
1412 "\"%"TS"\" on line %zu"), command_name, line_number);
1418 static struct wimlib_update_command *
1419 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1420 size_t *num_cmds_ret)
1424 struct wimlib_update_command *cmds;
1427 nlines = text_file_count_lines(cmd_file_contents_p,
1432 /* Always allocate at least 1 slot, just in case the implementation of
1433 * calloc() returns NULL if 0 bytes are requested. */
1434 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1436 imagex_error(T("out of memory"));
1439 p = *cmd_file_contents_p;
1441 for (i = 0; i < nlines; i++) {
1442 /* XXX: Could use rawmemchr() here instead, but it may not be
1443 * available on all platforms. */
1444 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1445 size_t len = endp - p + 1;
1447 if (!is_comment_line(p, len)) {
1448 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1459 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1460 * one image from a WIM file to a NTFS volume. */
1462 imagex_apply(int argc, tchar **argv, int cmd)
1465 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1469 const tchar *wimfile;
1470 const tchar *target;
1471 const tchar *image_num_or_name;
1472 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1474 const tchar *swm_glob = NULL;
1475 WIMStruct **additional_swms;
1476 unsigned num_additional_swms;
1478 for_opt(c, apply_options) {
1480 case IMAGEX_CHECK_OPTION:
1481 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1483 case IMAGEX_HARDLINK_OPTION:
1484 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1486 case IMAGEX_SYMLINK_OPTION:
1487 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1489 case IMAGEX_VERBOSE_OPTION:
1490 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1492 case IMAGEX_REF_OPTION:
1495 case IMAGEX_UNIX_DATA_OPTION:
1496 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1498 case IMAGEX_NO_ACLS_OPTION:
1499 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1501 case IMAGEX_STRICT_ACLS_OPTION:
1502 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1504 case IMAGEX_NORPFIX_OPTION:
1505 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1507 case IMAGEX_RPFIX_OPTION:
1508 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1510 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1511 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1512 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1514 case IMAGEX_RESUME_OPTION:
1515 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1523 if (argc != 2 && argc != 3)
1528 if (!tstrcmp(wimfile, T("-"))) {
1529 /* Attempt to apply pipable WIM from standard input. */
1531 image_num_or_name = NULL;
1534 image_num_or_name = argv[1];
1538 num_additional_swms = 0;
1539 additional_swms = NULL;
1541 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1542 imagex_progress_func);
1547 /* Image explicitly specified. */
1548 image_num_or_name = argv[1];
1549 image = wimlib_resolve_image(wim, image_num_or_name);
1550 ret = verify_image_exists(image, image_num_or_name, wimfile);
1552 goto out_wimlib_free;
1555 /* No image specified; default to image 1, but only if the WIM
1556 * contains exactly one image. */
1557 struct wimlib_wim_info info;
1559 wimlib_get_wim_info(wim, &info);
1560 if (info.image_count != 1) {
1561 imagex_error(T("\"%"TS"\" contains %d images; "
1562 "Please select one (or all)."),
1563 wimfile, info.image_count);
1572 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1574 &num_additional_swms);
1576 goto out_wimlib_free;
1578 additional_swms = NULL;
1579 num_additional_swms = 0;
1585 /* Interpret a regular file or block device target as a NTFS
1589 if (tstat(target, &stbuf)) {
1590 if (errno != ENOENT) {
1591 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1597 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1598 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1604 ret = wimlib_extract_image(wim, image, target, extract_flags,
1605 additional_swms, num_additional_swms,
1606 imagex_progress_func);
1608 set_fd_to_binary_mode(STDIN_FILENO);
1609 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1611 target, extract_flags,
1612 imagex_progress_func);
1615 imagex_printf(T("Done applying WIM image.\n"));
1617 for (unsigned i = 0; i < num_additional_swms; i++)
1618 wimlib_free(additional_swms[i]);
1619 free(additional_swms);
1626 usage(CMD_APPLY, stderr);
1631 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1632 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1633 * the desired image. 'wimlib-imagex append': add a new image to an existing
1636 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1639 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1640 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
1641 int write_flags = 0;
1642 int compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1643 const tchar *wimfile;
1647 const tchar *flags_element = NULL;
1650 unsigned num_threads = 0;
1655 const tchar *config_file = NULL;
1657 struct wimlib_capture_config *config;
1659 bool source_list = false;
1660 size_t source_list_nchars;
1661 tchar *source_list_contents;
1662 bool capture_sources_malloced;
1663 struct wimlib_capture_source *capture_sources;
1665 bool name_defaulted;
1667 for_opt(c, capture_or_append_options) {
1669 case IMAGEX_BOOT_OPTION:
1670 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1672 case IMAGEX_CHECK_OPTION:
1673 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1674 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1676 case IMAGEX_NOCHECK_OPTION:
1677 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1679 case IMAGEX_CONFIG_OPTION:
1680 config_file = optarg;
1682 case IMAGEX_COMPRESS_OPTION:
1683 compression_type = get_compression_type(optarg);
1684 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1687 case IMAGEX_FLAGS_OPTION:
1688 flags_element = optarg;
1690 case IMAGEX_DEREFERENCE_OPTION:
1691 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1693 case IMAGEX_VERBOSE_OPTION:
1694 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1696 case IMAGEX_THREADS_OPTION:
1697 num_threads = parse_num_threads(optarg);
1698 if (num_threads == UINT_MAX)
1701 case IMAGEX_REBUILD_OPTION:
1702 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1704 case IMAGEX_UNIX_DATA_OPTION:
1705 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1707 case IMAGEX_SOURCE_LIST_OPTION:
1710 case IMAGEX_NO_ACLS_OPTION:
1711 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1713 case IMAGEX_STRICT_ACLS_OPTION:
1714 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1716 case IMAGEX_RPFIX_OPTION:
1717 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1719 case IMAGEX_NORPFIX_OPTION:
1720 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1722 case IMAGEX_PIPABLE_OPTION:
1723 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1725 case IMAGEX_NOT_PIPABLE_OPTION:
1726 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1735 if (argc < 2 || argc > 4)
1741 if (!tstrcmp(wimfile, T("-"))) {
1743 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1744 imagex_error("Can't write a non-pipable WIM to "
1745 "standard output! Specify --pipable\n"
1746 " if you want to create a pipable WIM "
1747 "(but read the docs first).");
1751 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1753 if (cmd == CMD_APPEND) {
1754 imagex_error(T("Using standard output for append does "
1755 "not make sense."));
1758 wim_fd = STDOUT_FILENO;
1760 imagex_info_file = stderr;
1765 name_defaulted = false;
1767 /* Set default name to SOURCE argument, omitting any directory
1768 * prefixes and trailing slashes. This requires making a copy
1769 * of @source. Leave some free characters at the end in case we
1770 * append a number to keep the name unique. */
1771 size_t source_name_len;
1773 source_name_len = tstrlen(source);
1774 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1775 name = tbasename(tstrcpy(source_copy, source));
1776 name_defaulted = true;
1778 /* Image description defaults to NULL if not given. */
1785 /* Set up capture sources in source list mode */
1786 if (source[0] == T('-') && source[1] == T('\0')) {
1787 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1789 source_list_contents = file_get_text_contents(source,
1790 &source_list_nchars);
1792 if (!source_list_contents)
1795 capture_sources = parse_source_list(&source_list_contents,
1798 if (!capture_sources) {
1800 goto out_free_source_list_contents;
1802 capture_sources_malloced = true;
1804 /* Set up capture source in non-source-list mode (could be
1805 * either "normal" mode or "NTFS mode"--- see the man page). */
1806 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1807 capture_sources[0].fs_source_path = source;
1808 capture_sources[0].wim_target_path = NULL;
1809 capture_sources[0].reserved = 0;
1811 capture_sources_malloced = false;
1812 source_list_contents = NULL;
1818 config_str = file_get_text_contents(config_file, &config_len);
1821 goto out_free_capture_sources;
1824 config = alloca(sizeof(*config));
1825 ret = parse_capture_config(&config_str, config_len, config);
1827 goto out_free_config;
1829 config = &default_capture_config;
1832 if (cmd == CMD_APPEND)
1833 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1834 imagex_progress_func);
1836 ret = wimlib_create_new_wim(compression_type, &wim);
1838 goto out_free_config;
1844 if (tstat(source, &stbuf) == 0) {
1845 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1846 imagex_printf(T("Capturing WIM image from NTFS "
1847 "filesystem on \"%"TS"\"\n"), source);
1848 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1851 if (errno != ENOENT) {
1852 imagex_error_with_errno(T("Failed to stat "
1853 "\"%"TS"\""), source);
1855 goto out_wimlib_free;
1861 if (cmd == CMD_APPEND && name_defaulted) {
1862 /* If the user did not specify an image name, and the basename
1863 * of the source already exists as an image name in the WIM
1864 * file, append a suffix to make it unique. */
1865 unsigned long conflict_idx;
1866 tchar *name_end = tstrchr(name, T('\0'));
1867 for (conflict_idx = 1;
1868 wimlib_image_name_in_use(wim, name);
1871 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1874 ret = wimlib_add_image_multisource(wim,
1880 imagex_progress_func);
1882 goto out_wimlib_free;
1884 if (desc || flags_element) {
1885 /* User provided <DESCRIPTION> or <FLAGS> element. Get the
1886 * index of the image we just added, then use it to call the
1887 * appropriate functions. */
1888 struct wimlib_wim_info info;
1890 wimlib_get_wim_info(wim, &info);
1893 ret = wimlib_set_image_descripton(wim,
1897 goto out_wimlib_free;
1900 if (flags_element) {
1901 ret = wimlib_set_image_flags(wim, info.image_count,
1904 goto out_wimlib_free;
1908 /* Write the new WIM or overwrite the existing WIM with the new image
1910 if (cmd == CMD_APPEND) {
1911 ret = wimlib_overwrite(wim, write_flags, num_threads,
1912 imagex_progress_func);
1913 } else if (wimfile) {
1914 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
1915 write_flags, num_threads,
1916 imagex_progress_func);
1918 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
1919 write_flags, num_threads,
1920 imagex_progress_func);
1925 if (config != &default_capture_config) {
1926 free(config->exclusion_pats.pats);
1927 free(config->exclusion_exception_pats.pats);
1930 out_free_capture_sources:
1931 if (capture_sources_malloced)
1932 free(capture_sources);
1933 out_free_source_list_contents:
1934 free(source_list_contents);
1945 /* Remove image(s) from a WIM. */
1947 imagex_delete(int argc, tchar **argv, int cmd)
1950 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1951 int write_flags = 0;
1952 const tchar *wimfile;
1953 const tchar *image_num_or_name;
1958 for_opt(c, delete_options) {
1960 case IMAGEX_CHECK_OPTION:
1961 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1962 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1964 case IMAGEX_SOFT_OPTION:
1965 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
1976 imagex_error(T("Must specify a WIM file"));
1978 imagex_error(T("Must specify an image"));
1982 image_num_or_name = argv[1];
1984 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1985 imagex_progress_func);
1989 image = wimlib_resolve_image(wim, image_num_or_name);
1991 ret = verify_image_exists(image, image_num_or_name, wimfile);
1993 goto out_wimlib_free;
1995 ret = wimlib_delete_image(wim, image);
1997 imagex_error(T("Failed to delete image from \"%"TS"\""),
1999 goto out_wimlib_free;
2002 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2004 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2005 "deleted"), wimfile);
2013 usage(CMD_DELETE, stderr);
2019 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2021 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2022 return (ret >= 0) ? 0 : -1;
2025 /* Print the files contained in an image(s) in a WIM file. */
2027 imagex_dir(int argc, tchar **argv, int cmd)
2029 const tchar *wimfile;
2030 WIMStruct *wim = NULL;
2033 const tchar *path = T("");
2036 for_opt(c, dir_options) {
2038 case IMAGEX_PATH_OPTION:
2049 imagex_error(T("Must specify a WIM file"));
2053 imagex_error(T("Too many arguments"));
2058 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &wim,
2059 imagex_progress_func);
2064 image = wimlib_resolve_image(wim, argv[1]);
2065 ret = verify_image_exists(image, argv[1], wimfile);
2067 goto out_wimlib_free;
2069 /* No image specified; default to image 1, but only if the WIM
2070 * contains exactly one image. */
2072 struct wimlib_wim_info info;
2074 wimlib_get_wim_info(wim, &info);
2075 if (info.image_count != 1) {
2076 imagex_error(T("\"%"TS"\" contains %d images; Please "
2077 "select one (or all)."),
2078 wimfile, info.image_count);
2085 ret = wimlib_iterate_dir_tree(wim, image, path,
2086 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2087 print_full_path, NULL);
2094 usage(CMD_DIR, stderr);
2099 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2102 imagex_export(int argc, tchar **argv, int cmd)
2106 int export_flags = 0;
2107 int write_flags = 0;
2108 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2109 const tchar *src_wimfile;
2110 const tchar *src_image_num_or_name;
2111 const tchar *dest_wimfile;
2113 const tchar *dest_name;
2114 const tchar *dest_desc;
2116 WIMStruct *dest_wim;
2121 const tchar *swm_glob = NULL;
2122 WIMStruct **additional_swms;
2123 unsigned num_additional_swms;
2124 unsigned num_threads = 0;
2126 for_opt(c, export_options) {
2128 case IMAGEX_BOOT_OPTION:
2129 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2131 case IMAGEX_CHECK_OPTION:
2132 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2133 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2135 case IMAGEX_NOCHECK_OPTION:
2136 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2138 case IMAGEX_COMPRESS_OPTION:
2139 compression_type = get_compression_type(optarg);
2140 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2143 case IMAGEX_REF_OPTION:
2146 case IMAGEX_THREADS_OPTION:
2147 num_threads = parse_num_threads(optarg);
2148 if (num_threads == UINT_MAX)
2151 case IMAGEX_REBUILD_OPTION:
2152 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2154 case IMAGEX_PIPABLE_OPTION:
2155 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2157 case IMAGEX_NOT_PIPABLE_OPTION:
2158 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2166 if (argc < 3 || argc > 5)
2168 src_wimfile = argv[0];
2169 src_image_num_or_name = argv[1];
2170 dest_wimfile = argv[2];
2171 dest_name = (argc >= 4) ? argv[3] : NULL;
2172 dest_desc = (argc >= 5) ? argv[4] : NULL;
2173 ret = wimlib_open_wim(src_wimfile,
2174 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_wim,
2175 imagex_progress_func);
2179 /* Determine if the destination is an existing file or not. If so, we
2180 * try to append the exported image(s) to it; otherwise, we create a new
2181 * WIM containing the exported image(s). Furthermore, determine if we
2182 * need to write a pipable WIM directly to standard output. */
2184 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2186 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2187 imagex_error("Can't write a non-pipable WIM to "
2188 "standard output! Specify --pipable\n"
2189 " if you want to create a pipable WIM "
2190 "(but read the docs first).");
2192 goto out_free_src_wim;
2195 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2197 dest_wimfile = NULL;
2198 dest_wim_fd = STDOUT_FILENO;
2199 imagex_info_file = stderr;
2202 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2204 /* Destination file exists. */
2206 if (!S_ISREG(stbuf.st_mode)) {
2207 imagex_error(T("\"%"TS"\" is not a regular file"),
2210 goto out_free_src_wim;
2212 ret = wimlib_open_wim(dest_wimfile, open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2213 &dest_wim, imagex_progress_func);
2215 goto out_free_src_wim;
2217 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2218 /* The user specified a compression type, but we're
2219 * exporting to an existing WIM. Make sure the
2220 * specified compression type is the same as the
2221 * compression type of the existing destination WIM. */
2222 struct wimlib_wim_info dest_info;
2224 wimlib_get_wim_info(dest_wim, &dest_info);
2225 if (compression_type != dest_info.compression_type) {
2226 imagex_error(T("Cannot specify a compression type that is "
2227 "not the same as that used in the "
2228 "destination WIM"));
2230 goto out_free_dest_wim;
2236 if (errno != ENOENT) {
2237 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2240 goto out_free_src_wim;
2243 /* dest_wimfile is not an existing file, so create a new WIM. */
2245 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2246 /* The user did not specify a compression type; default
2247 * to that of the source WIM. */
2249 struct wimlib_wim_info src_info;
2251 wimlib_get_wim_info(src_wim, &src_info);
2252 compression_type = src_info.compression_type;
2254 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2256 goto out_free_src_wim;
2259 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2260 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2262 goto out_free_dest_wim;
2265 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
2267 &num_additional_swms);
2269 goto out_free_dest_wim;
2271 additional_swms = NULL;
2272 num_additional_swms = 0;
2275 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2276 dest_desc, export_flags, additional_swms,
2277 num_additional_swms, imagex_progress_func);
2282 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2283 imagex_progress_func);
2284 else if (dest_wimfile)
2285 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2286 write_flags, num_threads,
2287 imagex_progress_func);
2289 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2290 WIMLIB_ALL_IMAGES, write_flags,
2291 num_threads, imagex_progress_func);
2293 imagex_error(T("Export failed."));
2295 for (unsigned i = 0; i < num_additional_swms; i++)
2296 wimlib_free(additional_swms[i]);
2297 free(additional_swms);
2299 wimlib_free(dest_wim);
2301 wimlib_free(src_wim);
2306 usage(CMD_EXPORT, stderr);
2313 is_root_wim_path(const tchar *path)
2316 for (p = path; *p; p++)
2317 if (*p != T('\\') && *p != T('/'))
2323 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2324 const tchar *dest_dir)
2326 for (size_t i = 0; i < num_cmds; i++)
2327 if (cmds[i].fs_dest_path != dest_dir)
2328 free(cmds[i].fs_dest_path);
2332 static struct wimlib_extract_command *
2333 prepare_extract_commands(tchar **paths, unsigned num_paths,
2334 int extract_flags, tchar *dest_dir,
2335 size_t *num_cmds_ret)
2337 struct wimlib_extract_command *cmds;
2339 tchar *emptystr = T("");
2341 if (num_paths == 0) {
2345 num_cmds = num_paths;
2346 cmds = calloc(num_cmds, sizeof(cmds[0]));
2348 imagex_error(T("Out of memory!"));
2352 for (size_t i = 0; i < num_cmds; i++) {
2353 cmds[i].extract_flags = extract_flags;
2354 cmds[i].wim_source_path = paths[i];
2355 if (is_root_wim_path(paths[i])) {
2356 cmds[i].fs_dest_path = dest_dir;
2358 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2359 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2360 if (!cmds[i].fs_dest_path) {
2361 free_extract_commands(cmds, num_cmds, dest_dir);
2364 tsprintf(cmds[i].fs_dest_path,
2365 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2366 dest_dir, tbasename(paths[i]));
2369 *num_cmds_ret = num_cmds;
2373 /* Extract files or directories from a WIM image */
2375 imagex_extract(int argc, tchar **argv, int cmd)
2378 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2382 const tchar *wimfile;
2383 const tchar *image_num_or_name;
2384 tchar *dest_dir = T(".");
2385 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2387 const tchar *swm_glob = NULL;
2388 WIMStruct **additional_swms;
2389 unsigned num_additional_swms;
2391 struct wimlib_extract_command *cmds;
2394 for_opt(c, extract_options) {
2396 case IMAGEX_CHECK_OPTION:
2397 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2399 case IMAGEX_VERBOSE_OPTION:
2400 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2402 case IMAGEX_REF_OPTION:
2405 case IMAGEX_UNIX_DATA_OPTION:
2406 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2408 case IMAGEX_NO_ACLS_OPTION:
2409 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2411 case IMAGEX_STRICT_ACLS_OPTION:
2412 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2414 case IMAGEX_DEST_DIR_OPTION:
2417 case IMAGEX_TO_STDOUT_OPTION:
2418 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2419 imagex_info_file = stderr;
2420 imagex_be_quiet = true;
2422 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2423 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2424 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2437 image_num_or_name = argv[1];
2442 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2447 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2451 image = wimlib_resolve_image(wim, image_num_or_name);
2452 ret = verify_image_exists_and_is_single(image,
2456 goto out_wimlib_free;
2459 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2461 &num_additional_swms);
2463 goto out_wimlib_free;
2465 additional_swms = NULL;
2466 num_additional_swms = 0;
2469 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2470 additional_swms, num_additional_swms,
2471 imagex_progress_func);
2473 if (!imagex_be_quiet)
2474 imagex_printf(T("Done extracting files.\n"));
2475 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2476 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2477 "files and directories\n"
2478 " are in the WIM image.\n"),
2479 get_cmd_string(CMD_INFO, false));
2481 for (unsigned i = 0; i < num_additional_swms; i++)
2482 wimlib_free(additional_swms[i]);
2483 free(additional_swms);
2487 free_extract_commands(cmds, num_cmds, dest_dir);
2492 usage(CMD_EXTRACT, stderr);
2498 static void print_byte_field(const uint8_t field[], size_t len)
2501 tprintf(T("%02hhx"), *field++);
2505 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2507 tputs(T("WIM Information:"));
2508 tputs(T("----------------"));
2509 tprintf(T("Path: %"TS"\n"), wimfile);
2510 tprintf(T("GUID: 0x"));
2511 print_byte_field(info->guid, sizeof(info->guid));
2513 tprintf(T("Image Count: %d\n"), info->image_count);
2514 tprintf(T("Compression: %"TS"\n"),
2515 wimlib_get_compression_type_string(info->compression_type));
2516 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2517 tprintf(T("Boot Index: %d\n"), info->boot_index);
2518 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2519 tprintf(T("Integrity Info: %"TS"\n"),
2520 info->has_integrity_table ? T("yes") : T("no"));
2521 tprintf(T("Relative path junction: %"TS"\n"),
2522 info->has_rpfix ? T("yes") : T("no"));
2523 tprintf(T("Pipable: %"TS"\n"),
2524 info->pipable ? T("yes") : T("no"));
2529 print_resource(const struct wimlib_resource_entry *resource,
2533 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2534 resource->uncompressed_size);
2536 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2537 resource->compressed_size);
2539 tprintf(T("Offset = %"PRIu64" bytes\n"),
2543 tprintf(T("Part Number = %u\n"), resource->part_number);
2544 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2546 tprintf(T("Hash = 0x"));
2547 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2550 tprintf(T("Flags = "));
2551 if (resource->is_compressed)
2552 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2553 if (resource->is_metadata)
2554 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2555 if (resource->is_free)
2556 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2557 if (resource->is_spanned)
2558 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2565 print_lookup_table(WIMStruct *wim)
2567 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2570 /* Prints information about a WIM file; also can mark an image as bootable,
2571 * change the name of an image, or change the description of an image. */
2573 imagex_info(int argc, tchar **argv, int cmd)
2578 bool nocheck = false;
2579 bool header = false;
2580 bool lookup_table = false;
2582 bool metadata = false;
2583 bool short_header = true;
2584 const tchar *xml_out_file = NULL;
2585 const tchar *wimfile;
2586 const tchar *image_num_or_name;
2587 const tchar *new_name;
2588 const tchar *new_desc;
2592 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2593 struct wimlib_wim_info info;
2595 for_opt(c, info_options) {
2597 case IMAGEX_BOOT_OPTION:
2600 case IMAGEX_CHECK_OPTION:
2603 case IMAGEX_NOCHECK_OPTION:
2606 case IMAGEX_HEADER_OPTION:
2608 short_header = false;
2610 case IMAGEX_LOOKUP_TABLE_OPTION:
2611 lookup_table = true;
2612 short_header = false;
2614 case IMAGEX_XML_OPTION:
2616 short_header = false;
2618 case IMAGEX_EXTRACT_XML_OPTION:
2619 xml_out_file = optarg;
2620 short_header = false;
2622 case IMAGEX_METADATA_OPTION:
2624 short_header = false;
2633 if (argc < 1 || argc > 4)
2637 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2638 new_name = (argc >= 3) ? argv[2] : NULL;
2639 new_desc = (argc >= 4) ? argv[3] : NULL;
2641 if (check && nocheck) {
2642 imagex_error(T("Can't specify both --check and --nocheck"));
2647 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2649 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2653 wimlib_get_wim_info(wim, &info);
2655 image = wimlib_resolve_image(wim, image_num_or_name);
2656 ret = WIMLIB_ERR_INVALID_IMAGE;
2657 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2658 imagex_error(T("The image \"%"TS"\" does not exist in \"%"TS"\""),
2659 image_num_or_name, wimfile);
2661 imagex_error(T("If you would like to set the boot "
2662 "index to 0, specify image \"0\" with "
2663 "the --boot flag."));
2665 goto out_wimlib_free;
2668 if (boot && info.image_count == 0) {
2669 imagex_error(T("--boot is meaningless on a WIM with no images"));
2670 goto out_wimlib_free;
2673 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2675 imagex_error(T("Cannot specify the --boot flag "
2676 "without specifying a specific "
2677 "image in a multi-image WIM"));
2678 goto out_wimlib_free;
2681 imagex_error(T("Cannot specify the NEW_NAME "
2682 "without specifying a specific "
2683 "image in a multi-image WIM"));
2684 goto out_wimlib_free;
2688 /* Operations that print information are separated from operations that
2689 * recreate the WIM file. */
2690 if (!new_name && !boot) {
2692 /* Read-only operations */
2694 if (image == WIMLIB_NO_IMAGE) {
2695 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2696 image_num_or_name, wimfile);
2697 goto out_wimlib_free;
2700 if (image == WIMLIB_ALL_IMAGES && short_header)
2701 print_wim_information(wimfile, &info);
2704 wimlib_print_header(wim);
2707 if (info.total_parts != 1) {
2708 tfprintf(stderr, T("Warning: Only showing the lookup table "
2709 "for part %d of a %d-part WIM.\n"),
2710 info.part_number, info.total_parts);
2712 print_lookup_table(wim);
2716 ret = wimlib_extract_xml_data(wim, stdout);
2718 goto out_wimlib_free;
2724 fp = tfopen(xml_out_file, T("wb"));
2726 imagex_error_with_errno(T("Failed to open the "
2727 "file \"%"TS"\" for "
2731 goto out_wimlib_free;
2733 ret = wimlib_extract_xml_data(wim, fp);
2735 imagex_error(T("Failed to close the file "
2741 goto out_wimlib_free;
2745 wimlib_print_available_images(wim, image);
2748 ret = wimlib_print_metadata(wim, image);
2750 goto out_wimlib_free;
2755 /* Modification operations */
2757 if (image == WIMLIB_ALL_IMAGES)
2760 if (image == WIMLIB_NO_IMAGE && new_name) {
2761 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2762 "when using image 0"), new_name);
2764 goto out_wimlib_free;
2768 if (image == info.boot_index) {
2769 imagex_printf(T("Image %d is already marked as "
2770 "bootable.\n"), image);
2773 imagex_printf(T("Marking image %d as bootable.\n"),
2775 info.boot_index = image;
2776 ret = wimlib_set_wim_info(wim, &info,
2777 WIMLIB_CHANGE_BOOT_INDEX);
2779 goto out_wimlib_free;
2783 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
2785 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
2789 imagex_printf(T("Changing the name of image %d to "
2790 "\"%"TS"\".\n"), image, new_name);
2791 ret = wimlib_set_image_name(wim, image, new_name);
2793 goto out_wimlib_free;
2797 const tchar *old_desc;
2798 old_desc = wimlib_get_image_description(wim, image);
2799 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2800 imagex_printf(T("The description of image %d is already "
2801 "\"%"TS"\".\n"), image, new_desc);
2804 imagex_printf(T("Changing the description of image %d "
2805 "to \"%"TS"\".\n"), image, new_desc);
2806 ret = wimlib_set_image_descripton(wim, image,
2809 goto out_wimlib_free;
2813 /* Only call wimlib_overwrite() if something actually needs to
2815 if (boot || new_name || new_desc ||
2816 (check && !info.has_integrity_table) ||
2817 (nocheck && info.has_integrity_table))
2819 int write_flags = 0;
2822 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2824 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2825 ret = wimlib_overwrite(wim, write_flags, 1,
2826 imagex_progress_func);
2828 imagex_printf(T("The file \"%"TS"\" was not modified "
2829 "because nothing needed to be done.\n"),
2840 usage(CMD_INFO, stderr);
2846 /* Join split WIMs into one part WIM */
2848 imagex_join(int argc, tchar **argv, int cmd)
2851 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2852 int wim_write_flags = 0;
2853 const tchar *output_path;
2856 for_opt(c, join_options) {
2858 case IMAGEX_CHECK_OPTION:
2859 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2860 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2870 imagex_error(T("Must specify one or more split WIM (.swm) "
2874 output_path = argv[0];
2875 ret = wimlib_join((const tchar * const *)++argv,
2880 imagex_progress_func);
2885 usage(CMD_JOIN, stderr);
2890 #if WIM_MOUNTING_SUPPORTED
2892 /* Mounts a WIM image. */
2894 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
2897 int mount_flags = 0;
2898 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2899 const tchar *swm_glob = NULL;
2900 const tchar *staging_dir = NULL;
2901 const tchar *wimfile;
2906 WIMStruct **additional_swms;
2907 unsigned num_additional_swms;
2909 if (cmd == CMD_MOUNTRW) {
2910 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
2911 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2914 for_opt(c, mount_options) {
2916 case IMAGEX_ALLOW_OTHER_OPTION:
2917 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
2919 case IMAGEX_CHECK_OPTION:
2920 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2922 case IMAGEX_DEBUG_OPTION:
2923 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
2925 case IMAGEX_STREAMS_INTERFACE_OPTION:
2926 if (!tstrcasecmp(optarg, T("none")))
2927 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
2928 else if (!tstrcasecmp(optarg, T("xattr")))
2929 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2930 else if (!tstrcasecmp(optarg, T("windows")))
2931 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
2933 imagex_error(T("Unknown stream interface \"%"TS"\""),
2938 case IMAGEX_REF_OPTION:
2941 case IMAGEX_STAGING_DIR_OPTION:
2942 staging_dir = optarg;
2944 case IMAGEX_UNIX_DATA_OPTION:
2945 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
2953 if (argc != 2 && argc != 3)
2958 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2963 /* Image explicitly specified. */
2964 image = wimlib_resolve_image(wim, argv[1]);
2966 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
2970 /* No image specified; default to image 1, but only if the WIM
2971 * contains exactly one image. */
2972 struct wimlib_wim_info info;
2974 wimlib_get_wim_info(wim, &info);
2975 if (info.image_count != 1) {
2976 imagex_error(T("\"%"TS"\" contains %d images; Please "
2977 "select one."), wimfile, info.image_count);
2986 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2988 &num_additional_swms);
2992 additional_swms = NULL;
2993 num_additional_swms = 0;
2996 ret = wimlib_mount_image(wim, image, dir, mount_flags, additional_swms,
2997 num_additional_swms, staging_dir);
2999 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3001 image, wimfile, dir);
3003 for (unsigned i = 0; i < num_additional_swms; i++)
3004 wimlib_free(additional_swms[i]);
3005 free(additional_swms);
3016 #endif /* WIM_MOUNTING_SUPPORTED */
3018 /* Rebuild a WIM file */
3020 imagex_optimize(int argc, tchar **argv, int cmd)
3023 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3024 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3027 const tchar *wimfile;
3030 unsigned num_threads = 0;
3032 for_opt(c, optimize_options) {
3034 case IMAGEX_CHECK_OPTION:
3035 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3036 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3038 case IMAGEX_NOCHECK_OPTION:
3039 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3041 case IMAGEX_RECOMPRESS_OPTION:
3042 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3044 case IMAGEX_THREADS_OPTION:
3045 num_threads = parse_num_threads(optarg);
3046 if (num_threads == UINT_MAX)
3049 case IMAGEX_PIPABLE_OPTION:
3050 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3052 case IMAGEX_NOT_PIPABLE_OPTION:
3053 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3067 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3071 old_size = file_get_size(wimfile);
3072 tprintf(T("\"%"TS"\" original size: "), wimfile);
3074 tputs(T("Unknown"));
3076 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3078 ret = wimlib_overwrite(wim, write_flags, num_threads,
3079 imagex_progress_func);
3081 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3082 goto out_wimlib_free;
3085 new_size = file_get_size(wimfile);
3086 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3088 tputs(T("Unknown"));
3090 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3092 tfputs(T("Space saved: "), stdout);
3093 if (new_size != -1 && old_size != -1) {
3094 tprintf(T("%lld KiB\n"),
3095 ((long long)old_size - (long long)new_size) >> 10);
3097 tputs(T("Unknown"));
3106 usage(CMD_OPTIMIZE, stderr);
3112 /* Split a WIM into a spanned set */
3114 imagex_split(int argc, tchar **argv, int cmd)
3118 int write_flags = 0;
3119 unsigned long part_size;
3124 for_opt(c, split_options) {
3126 case IMAGEX_CHECK_OPTION:
3127 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3128 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3140 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3141 if (tmp == argv[2] || *tmp) {
3142 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3143 imagex_error(T("The part size must be an integer or "
3144 "floating-point number of megabytes."));
3147 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3151 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3157 usage(CMD_SPLIT, stderr);
3163 #if WIM_MOUNTING_SUPPORTED
3164 /* Unmounts a mounted WIM image. */
3166 imagex_unmount(int argc, tchar **argv, int cmd)
3169 int unmount_flags = 0;
3172 for_opt(c, unmount_options) {
3174 case IMAGEX_COMMIT_OPTION:
3175 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3177 case IMAGEX_CHECK_OPTION:
3178 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3180 case IMAGEX_REBUILD_OPTION:
3181 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3183 case IMAGEX_LAZY_OPTION:
3184 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3195 ret = wimlib_unmount_image(argv[0], unmount_flags,
3196 imagex_progress_func);
3198 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3203 usage(CMD_UNMOUNT, stderr);
3207 #endif /* WIM_MOUNTING_SUPPORTED */
3210 * Add, delete, or rename files in a WIM image.
3213 imagex_update(int argc, tchar **argv, int cmd)
3215 const tchar *wimfile;
3219 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3220 int write_flags = 0;
3221 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3222 int default_add_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
3223 int default_delete_flags = 0;
3224 unsigned num_threads = 0;
3226 tchar *cmd_file_contents;
3227 size_t cmd_file_nchars;
3228 struct wimlib_update_command *cmds;
3230 tchar *command_str = NULL;
3232 const tchar *config_file = NULL;
3234 struct wimlib_capture_config *config;
3236 for_opt(c, update_options) {
3238 /* Generic or write options */
3239 case IMAGEX_THREADS_OPTION:
3240 num_threads = parse_num_threads(optarg);
3241 if (num_threads == UINT_MAX)
3244 case IMAGEX_CHECK_OPTION:
3245 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3246 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3248 case IMAGEX_REBUILD_OPTION:
3249 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3251 case IMAGEX_COMMAND_OPTION:
3253 imagex_error(T("--command may only be specified "
3254 "one time. Please provide\n"
3255 " the update commands "
3256 "on standard input instead."));
3259 command_str = tstrdup(optarg);
3261 imagex_error(T("Out of memory!"));
3265 /* Default delete options */
3266 case IMAGEX_FORCE_OPTION:
3267 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3269 case IMAGEX_RECURSIVE_OPTION:
3270 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3273 /* Global add option */
3274 case IMAGEX_CONFIG_OPTION:
3275 config_file = optarg;
3278 /* Default add options */
3279 case IMAGEX_VERBOSE_OPTION:
3280 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
3282 case IMAGEX_DEREFERENCE_OPTION:
3283 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
3285 case IMAGEX_UNIX_DATA_OPTION:
3286 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
3288 case IMAGEX_NO_ACLS_OPTION:
3289 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
3291 case IMAGEX_STRICT_ACLS_OPTION:
3292 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
3301 if (argc != 1 && argc != 2)
3305 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3307 goto out_free_command_str;
3310 /* Image explicitly specified. */
3311 image = wimlib_resolve_image(wim, argv[1]);
3312 ret = verify_image_exists_and_is_single(image, argv[1],
3315 goto out_wimlib_free;
3317 /* No image specified; default to image 1, but only if the WIM
3318 * contains exactly one image. */
3319 struct wimlib_wim_info info;
3321 wimlib_get_wim_info(wim, &info);
3322 if (info.image_count != 1) {
3323 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3324 wimfile, info.image_count);
3331 /* Parse capture configuration file if specified */
3335 config_str = file_get_text_contents(config_file, &config_len);
3338 goto out_wimlib_free;
3341 config = alloca(sizeof(*config));
3342 ret = parse_capture_config(&config_str, config_len, config);
3344 goto out_free_config;
3346 config = &default_capture_config;
3349 /* Read update commands from standard input, or the command string if
3352 cmd_file_contents = NULL;
3353 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3356 if (isatty(STDIN_FILENO)) {
3357 tputs(T("Reading update commands from standard input..."));
3358 recommend_man_page(CMD_UPDATE, stdout);
3360 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3361 if (!cmd_file_contents) {
3363 goto out_free_config;
3366 /* Parse the update commands */
3367 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3372 goto out_free_cmd_file_contents;
3375 /* Set default flags and capture config on the update commands */
3376 bool have_add_command = false;
3377 for (size_t i = 0; i < num_cmds; i++) {
3378 switch (cmds[i].op) {
3379 case WIMLIB_UPDATE_OP_ADD:
3380 cmds[i].add.add_flags |= default_add_flags;
3381 cmds[i].add.config = config;
3382 have_add_command = true;
3384 case WIMLIB_UPDATE_OP_DELETE:
3385 cmds[i].delete.delete_flags |= default_delete_flags;
3392 /* Execute the update commands */
3393 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3394 imagex_progress_func);
3398 /* Overwrite the updated WIM */
3399 ret = wimlib_overwrite(wim, write_flags, num_threads,
3400 imagex_progress_func);
3403 out_free_cmd_file_contents:
3404 free(cmd_file_contents);
3406 if (config != &default_capture_config) {
3407 free(config->exclusion_pats.pats);
3408 free(config->exclusion_exception_pats.pats);
3413 out_free_command_str:
3418 usage(CMD_UPDATE, stderr);
3421 goto out_free_command_str;
3426 struct imagex_command {
3428 int (*func)(int argc, tchar **argv, int cmd);
3431 static const struct imagex_command imagex_commands[] = {
3432 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3433 [CMD_APPLY] = {T("apply"), imagex_apply},
3434 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3435 [CMD_DELETE] = {T("delete"), imagex_delete},
3436 [CMD_DIR ] = {T("dir"), imagex_dir},
3437 [CMD_EXPORT] = {T("export"), imagex_export},
3438 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3439 [CMD_INFO] = {T("info"), imagex_info},
3440 [CMD_JOIN] = {T("join"), imagex_join},
3441 #if WIM_MOUNTING_SUPPORTED
3442 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3443 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3445 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3446 [CMD_SPLIT] = {T("split"), imagex_split},
3447 #if WIM_MOUNTING_SUPPORTED
3448 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3450 [CMD_UPDATE] = {T("update"), imagex_update},
3453 static const tchar *usage_strings[] = {
3456 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3457 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3458 " [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3459 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3460 " [--rebuild] [--unix-data] [--source-list] [--no-acls]\n"
3461 " [--strict-acls] [--rpfix] [--norpfix] [--pipable]\n"
3462 " [--not-pipable]\n"
3466 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3467 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3468 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3469 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3470 " [--include-invalid-names] [--resume]\n"
3474 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3475 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3476 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3477 " [--verbose] [--dereference] [--config=FILE]\n"
3478 " [--threads=NUM_THREADS] [--unix-data] [--source-list]\n"
3479 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3480 " [--pipable] [--not-pipable]\n"
3484 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3489 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3493 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3494 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3495 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3496 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3497 " [--pipable] [--not-pipable]\n"
3501 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3502 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3503 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3504 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3508 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3509 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3510 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3515 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3517 #if WIM_MOUNTING_SUPPORTED
3520 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3521 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3522 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3526 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3527 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3528 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3533 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3534 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3538 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3540 #if WIM_MOUNTING_SUPPORTED
3543 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3548 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3549 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3550 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3554 static const tchar *invocation_name;
3555 static bool using_cmd_from_invocation_name = false;
3557 static const tchar *get_cmd_string(int cmd, bool nospace)
3560 if (using_cmd_from_invocation_name || cmd == CMD_NONE) {
3561 return invocation_name;
3563 const tchar *format;
3564 static tchar buf[50];
3567 format = T("%"TS"-%"TS"");
3569 format = T("%"TS" %"TS"");
3570 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3578 static const tchar *s =
3580 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3581 "Copyright (C) 2012, 2013 Eric Biggers\n"
3582 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3583 "This is free software: you are free to change and redistribute it.\n"
3584 "There is NO WARRANTY, to the extent permitted by law.\n"
3586 "Report bugs to "PACKAGE_BUGREPORT".\n"
3593 help_or_version(int argc, tchar **argv, int cmd)
3598 for (i = 1; i < argc; i++) {
3600 if (p[0] == T('-') && p[1] == T('-')) {
3602 if (!tstrcmp(p, T("help"))) {
3603 if (cmd == CMD_NONE)
3608 } else if (!tstrcmp(p, T("version"))) {
3617 print_usage_string(int cmd, FILE *fp)
3619 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3623 recommend_man_page(int cmd, FILE *fp)
3625 const tchar *format_str;
3627 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3629 format_str = T("Try `man %"TS"' for more details.\n");
3631 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3635 usage(int cmd, FILE *fp)
3637 tfprintf(fp, T("Usage:\n"));
3638 print_usage_string(cmd, fp);
3639 tfprintf(fp, T("\n"));
3640 recommend_man_page(cmd, fp);
3646 tfprintf(fp, T("Usage:\n"));
3647 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3648 print_usage_string(cmd, fp);
3649 tfprintf(fp, T("\n"));
3651 static const tchar *extra =
3654 " %"TS" --version\n"
3656 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3659 tfprintf(fp, extra, invocation_name, invocation_name);
3660 recommend_man_page(CMD_NONE, fp);
3663 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3664 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3665 * something else), while an Windows the command arguments will be UTF-16LE
3666 * encoded 'wchar_t' strings. */
3669 wmain(int argc, wchar_t **argv, wchar_t **envp)
3671 main(int argc, char **argv)
3678 imagex_info_file = stdout;
3679 invocation_name = tbasename(argv[0]);
3682 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3683 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3687 setlocale(LC_ALL, "");
3688 codeset = nl_langinfo(CODESET);
3689 if (!strstr(codeset, "UTF-8") &&
3690 !strstr(codeset, "UTF8") &&
3691 !strstr(codeset, "utf-8") &&
3692 !strstr(codeset, "utf8"))
3695 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3696 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3697 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3698 " to any value to force wimlib to use UTF-8.\n",
3703 #endif /* !__WIN32__ */
3705 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3707 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3708 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3709 for (int i = 0; i < CMD_MAX; i++) {
3710 if (!tstrcmp(invocation_name + 3,
3711 imagex_commands[i].name))
3713 using_cmd_from_invocation_name = true;
3720 /* Unless already known from the invocation name, determine which
3721 * command was specified. */
3722 if (cmd == CMD_NONE) {
3724 imagex_error(T("No command specified!\n"));
3728 for (int i = 0; i < CMD_MAX; i++) {
3729 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3734 if (cmd != CMD_NONE) {
3740 /* Handle --help and --version. --help can be either for the program as
3741 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3742 * CMD_NONE). Note: help_or_version() will not return if a --help or
3743 * --version argument was found. */
3744 help_or_version(argc, argv, cmd);
3746 /* Bail if a valid command was not specified. */
3747 if (cmd == CMD_NONE) {
3748 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3753 /* Enable warning and error messages in wimlib be more user-friendly.
3755 wimlib_set_print_errors(true);
3757 /* Initialize wimlib. */
3758 ret = wimlib_global_init(init_flags);
3760 goto out_check_status;
3762 /* Call the command handler function. */
3763 ret = imagex_commands[cmd].func(argc, argv, cmd);
3765 /* Check for error writing to standard output, especially since for some
3766 * commands, writing to standard output is part of the program's actual
3767 * behavior and not just for informational purposes. */
3768 if (ferror(stdout) || fclose(stdout)) {
3769 imagex_error_with_errno(T("error writing to standard output"));
3774 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3775 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
3776 * error code from which an error message can be printed. */
3778 imagex_error(T("Exiting with error code %d:\n"
3780 wimlib_get_error_string(ret));
3781 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3782 imagex_error_with_errno(T("errno"));
3784 /* Make wimlib free any resources it's holding (although this is not
3785 * strictly necessary because the process is ending anyway). */
3786 wimlib_global_cleanup();