4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 # include "config.h" /* Need for PACKAGE_VERSION, etc. */
30 #include "wimlib_tchar.h"
50 # include "imagex-win32.h"
51 # define tbasename win32_wbasename
52 # define OS_PREFERRED_PATH_SEPARATOR L'\\'
53 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
57 # include <langinfo.h>
58 # define tbasename basename
59 # define OS_PREFERRED_PATH_SEPARATOR '/'
60 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
61 static inline void set_fd_to_binary_mode(int fd)
66 /* Don't confuse the user by presenting the mounting commands on Windows when
67 * they will never work. However on UNIX-like systems we always present them,
68 * even if WITH_FUSE is not defined at this point, as to not tie the build of
69 * wimlib-imagex to a specific build of wimlib. */
71 # define WIM_MOUNTING_SUPPORTED 0
73 # define WIM_MOUNTING_SUPPORTED 1
76 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
92 #if WIM_MOUNTING_SUPPORTED
98 #if WIM_MOUNTING_SUPPORTED
105 static void usage(int cmd, FILE *fp);
106 static void usage_all(FILE *fp);
107 static void recommend_man_page(int cmd, FILE *fp);
108 static const tchar *get_cmd_string(int cmd, bool nospace);
110 static int imagex_progress_func(enum wimlib_progress_msg msg,
111 const union wimlib_progress_info *info);
113 static bool imagex_be_quiet = false;
114 static FILE *imagex_info_file;
116 #define imagex_printf(format, ...) \
117 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
120 IMAGEX_ALLOW_OTHER_OPTION,
123 IMAGEX_COMMAND_OPTION,
124 IMAGEX_COMMIT_OPTION,
125 IMAGEX_COMPRESS_OPTION,
126 IMAGEX_CONFIG_OPTION,
128 IMAGEX_DELTA_FROM_OPTION,
129 IMAGEX_DEREFERENCE_OPTION,
130 IMAGEX_DEST_DIR_OPTION,
131 IMAGEX_EXTRACT_XML_OPTION,
134 IMAGEX_HARDLINK_OPTION,
135 IMAGEX_HEADER_OPTION,
136 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
138 IMAGEX_LOOKUP_TABLE_OPTION,
139 IMAGEX_METADATA_OPTION,
140 IMAGEX_NORPFIX_OPTION,
141 IMAGEX_NOCHECK_OPTION,
142 IMAGEX_NO_ACLS_OPTION,
143 IMAGEX_NOT_PIPABLE_OPTION,
145 IMAGEX_PIPABLE_OPTION,
146 IMAGEX_REBUILD_OPTION,
147 IMAGEX_RECOMPRESS_OPTION,
148 IMAGEX_RECURSIVE_OPTION,
150 IMAGEX_RESUME_OPTION,
153 IMAGEX_SOURCE_LIST_OPTION,
154 IMAGEX_STAGING_DIR_OPTION,
155 IMAGEX_STREAMS_INTERFACE_OPTION,
156 IMAGEX_STRICT_ACLS_OPTION,
157 IMAGEX_SYMLINK_OPTION,
158 IMAGEX_THREADS_OPTION,
159 IMAGEX_TO_STDOUT_OPTION,
160 IMAGEX_UNIX_DATA_OPTION,
161 IMAGEX_UPDATE_OF_OPTION,
162 IMAGEX_VERBOSE_OPTION,
166 static const struct option apply_options[] = {
167 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
168 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
169 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
170 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
171 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
172 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
173 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
174 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
175 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
176 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
177 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
178 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
180 /* --resume is undocumented for now as it needs improvement. */
181 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
185 static const struct option capture_or_append_options[] = {
186 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
187 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
188 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
189 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
190 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
191 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
192 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
193 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
194 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
195 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
196 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
197 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
198 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
199 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
200 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
201 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
202 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
203 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
204 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
205 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
206 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
207 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
211 static const struct option delete_options[] = {
212 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
213 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
217 static const struct option dir_options[] = {
218 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
222 static const struct option export_options[] = {
223 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
224 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
225 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
226 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
227 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
228 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
229 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
230 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
231 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
232 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
236 static const struct option extract_options[] = {
237 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
238 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
239 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
240 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
241 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
242 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
243 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
244 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
245 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
246 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
250 static const struct option info_options[] = {
251 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
252 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
253 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
254 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
255 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
256 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
257 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
258 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
259 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
263 static const struct option join_options[] = {
264 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
268 static const struct option mount_options[] = {
269 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
270 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
271 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
272 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
273 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
274 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
275 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
279 static const struct option optimize_options[] = {
280 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
281 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
282 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
283 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
284 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
285 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
286 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
290 static const struct option split_options[] = {
291 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
295 static const struct option unmount_options[] = {
296 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
297 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
298 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
299 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
303 static const struct option update_options[] = {
304 /* Careful: some of the options here set the defaults for update
305 * commands, but the flags given to an actual update command (and not to
306 * `imagex update' itself are also handled in
307 * update_command_add_option(). */
308 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
309 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
310 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
311 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
313 /* Default delete options */
314 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
315 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
317 /* Global add option */
318 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
320 /* Default add options */
321 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
322 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
323 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
324 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
325 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
326 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
332 # define _format_attribute(type, format_str, args_start) \
333 __attribute__((format(type, format_str, args_start)))
335 # define _format_attribute(type, format_str, args_start)
338 /* Print formatted error message to stderr. */
339 static void _format_attribute(printf, 1, 2)
340 imagex_error(const tchar *format, ...)
343 va_start(va, format);
344 tfputs(T("ERROR: "), stderr);
345 tvfprintf(stderr, format, va);
346 tputc(T('\n'), stderr);
350 /* Print formatted error message to stderr. */
351 static void _format_attribute(printf, 1, 2)
352 imagex_error_with_errno(const tchar *format, ...)
354 int errno_save = errno;
356 va_start(va, format);
357 tfputs(T("ERROR: "), stderr);
358 tvfprintf(stderr, format, va);
359 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
364 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
366 if (image == WIMLIB_NO_IMAGE) {
367 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
368 " Please specify a 1-based image index or "
369 "image name. To list the images\n"
370 " contained in the WIM archive, run\n"
372 " %"TS" \"%"TS"\"\n"),
373 image_name, wim_name,
374 get_cmd_string(CMD_INFO, false), wim_name);
375 return WIMLIB_ERR_INVALID_IMAGE;
381 verify_image_is_single(int image)
383 if (image == WIMLIB_ALL_IMAGES) {
384 imagex_error(T("Cannot specify all images for this action!"));
385 return WIMLIB_ERR_INVALID_IMAGE;
391 verify_image_exists_and_is_single(int image, const tchar *image_name,
392 const tchar *wim_name)
395 ret = verify_image_exists(image, image_name, wim_name);
397 ret = verify_image_is_single(image);
401 /* Parse the argument to --compress */
403 get_compression_type(const tchar *optarg)
405 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
406 return WIMLIB_COMPRESSION_TYPE_LZX;
407 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
408 return WIMLIB_COMPRESSION_TYPE_XPRESS;
409 else if (!tstrcasecmp(optarg, T("none")))
410 return WIMLIB_COMPRESSION_TYPE_NONE;
412 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
413 "\"maximum\", \"fast\", or \"none\"."), optarg);
414 return WIMLIB_COMPRESSION_TYPE_INVALID;
421 unsigned num_alloc_globs;
424 #define REFGLOB_SET_INITIALIZER \
425 { .globs = NULL, .num_globs = 0, .num_alloc_globs = 0, }
427 #define REFGLOB_SET(_refglobs) \
428 struct refglob_set _refglobs = REFGLOB_SET_INITIALIZER
431 refglob_set_append(struct refglob_set *set, const tchar *glob)
433 unsigned num_alloc_globs = set->num_alloc_globs;
435 if (set->num_globs == num_alloc_globs) {
436 const tchar **new_globs;
438 num_alloc_globs += 4;
439 new_globs = realloc(set->globs, sizeof(set->globs[0]) * num_alloc_globs);
441 imagex_error(T("Out of memory!"));
444 set->globs = new_globs;
445 set->num_alloc_globs = num_alloc_globs;
447 set->globs[set->num_globs++] = glob;
452 wim_reference_globs(WIMStruct *wim, struct refglob_set *set, int open_flags)
454 return wimlib_reference_resource_files(wim, set->globs, set->num_globs,
455 WIMLIB_REF_FLAG_GLOB_ENABLE,
457 imagex_progress_func);
461 refglob_set_destroy(struct refglob_set *set)
467 do_resource_not_found_warning(const tchar *wimfile,
468 const struct wimlib_wim_info *info,
469 const struct refglob_set *refglobs)
471 if (info->total_parts > 1) {
472 if (refglobs->num_globs == 0) {
473 imagex_error(T("\"%"TS"\" is part of a split WIM. "
474 "Use --ref to specify the other parts."),
477 imagex_error(T("Perhaps the '--ref' argument did not "
478 "specify all other parts of the split "
482 imagex_error(T("If this is a delta WIM, use the --ref argument "
483 "to specify the WIM on which it is based."));
487 /* Returns the size of a file given its name, or -1 if the file does not exist
488 * or its size cannot be determined. */
490 file_get_size(const tchar *filename)
493 if (tstat(filename, &st) == 0)
500 PARSE_STRING_SUCCESS = 0,
501 PARSE_STRING_FAILURE = 1,
502 PARSE_STRING_NONE = 2,
506 * Parses a string token from an array of characters.
508 * Tokens are either whitespace-delimited, or double or single-quoted.
510 * @line_p: Pointer to the pointer to the line of data. Will be updated
511 * to point past the string token iff the return value is
512 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
515 * @len_p: @len_p initially stores the length of the line of data, which may
516 * be 0, and it will be updated to the number of bytes remaining in
517 * the line iff the return value is PARSE_STRING_SUCCESS.
519 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
520 * parsed string token will be returned here.
522 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
523 * PARSE_STRING_FAILURE if the data was invalid due to a missing
524 * closing quote; or PARSE_STRING_NONE if the line ended before the
525 * beginning of a string token was found.
528 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
531 tchar *line = *line_p;
535 /* Skip leading whitespace */
538 return PARSE_STRING_NONE;
539 if (!istspace(*line) && *line != T('\0'))
545 if (quote_char == T('"') || quote_char == T('\'')) {
550 line = tmemchr(line, quote_char, len);
552 imagex_error(T("Missing closing quote: %"TS), fn - 1);
553 return PARSE_STRING_FAILURE;
556 /* Unquoted string. Go until whitespace. Line is terminated
557 * by '\0', so no need to check 'len'. */
561 } while (!istspace(*line) && *line != T('\0'));
568 return PARSE_STRING_SUCCESS;
571 /* Parses a line of data (not an empty line or comment) in the source list file
572 * format. (See the man page for 'wimlib-imagex capture' for details on this
573 * format and the meaning.)
575 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
576 * len == 0. The data in @line will be modified by this function call.
578 * @len: Length of the line of data.
580 * @source: On success, the capture source and target described by the line is
581 * written into this destination. Note that it will contain pointers
582 * to data in the @line array.
584 * Returns true if the line was valid; false otherwise. */
586 parse_source_list_line(tchar *line, size_t len,
587 struct wimlib_capture_source *source)
591 ret = parse_string(&line, &len, &source->fs_source_path);
592 if (ret != PARSE_STRING_SUCCESS)
594 ret = parse_string(&line, &len, &source->wim_target_path);
595 if (ret == PARSE_STRING_NONE)
596 source->wim_target_path = source->fs_source_path;
597 return ret != PARSE_STRING_FAILURE;
600 /* Returns %true if the given line of length @len > 0 is a comment or empty line
601 * in the source list file format. */
603 is_comment_line(const tchar *line, size_t len)
608 if (!istspace(*line) && *line != T('\0'))
618 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
621 tchar *contents = *contents_p;
622 size_t nchars = *nchars_p;
625 for (i = 0; i < nchars; i++)
626 if (contents[i] == T('\n'))
629 /* Handle last line not terminated by a newline */
630 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
631 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
633 imagex_error(T("Out of memory!"));
636 contents[nchars] = T('\n');
637 *contents_p = contents;
645 /* Parses a file in the source list format. (See the man page for
646 * 'wimlib-imagex capture' for details on this format and the meaning.)
648 * @source_list_contents: Contents of the source list file. Note that this
649 * buffer will be modified to save memory allocations,
650 * and cannot be freed until the returned array of
651 * wimlib_capture_source's has also been freed.
653 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
656 * @nsources_ret: On success, the length of the returned array is
659 * Returns: An array of `struct wimlib_capture_source's that can be passed to
660 * the wimlib_add_image_multisource() function to specify how a WIM image is to
662 static struct wimlib_capture_source *
663 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
664 size_t *nsources_ret)
668 struct wimlib_capture_source *sources;
671 nlines = text_file_count_lines(source_list_contents_p,
672 &source_list_nchars);
676 /* Always allocate at least 1 slot, just in case the implementation of
677 * calloc() returns NULL if 0 bytes are requested. */
678 sources = calloc(nlines ?: 1, sizeof(*sources));
680 imagex_error(T("out of memory"));
683 p = *source_list_contents_p;
685 for (i = 0; i < nlines; i++) {
686 /* XXX: Could use rawmemchr() here instead, but it may not be
687 * available on all platforms. */
688 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
689 size_t len = endp - p + 1;
691 if (!is_comment_line(p, len)) {
692 if (!parse_source_list_line(p, len, &sources[j++])) {
705 enum capture_config_section {
706 CAPTURE_CONFIG_NO_SECTION,
707 CAPTURE_CONFIG_EXCLUSION_SECTION,
708 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
709 CAPTURE_CONFIG_IGNORE_SECTION,
713 CAPTURE_CONFIG_INVALID_SECTION,
714 CAPTURE_CONFIG_CHANGED_SECTION,
715 CAPTURE_CONFIG_SAME_SECTION,
719 check_config_section(tchar *line, size_t len,
720 enum capture_config_section *cur_section)
722 while (istspace(*line))
726 return CAPTURE_CONFIG_SAME_SECTION;
729 tchar *endbrace = tstrrchr(line, T(']'));
731 return CAPTURE_CONFIG_SAME_SECTION;
733 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
734 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
735 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
736 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
737 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
738 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
739 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
740 "of capture config file\n"),
742 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
743 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
744 tfputs(T("WARNING: Ignoring [AlignmentList] section "
745 "of capture config file\n"),
748 imagex_error(T("Invalid capture config file section \"%"TS"\""),
750 return CAPTURE_CONFIG_INVALID_SECTION;
752 return CAPTURE_CONFIG_CHANGED_SECTION;
757 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
760 if (pat_list->num_pats == pat_list->num_allocated_pats) {
762 size_t num_allocated_pats = pat_list->num_pats + 8;
764 pats = realloc(pat_list->pats,
765 num_allocated_pats * sizeof(pat_list->pats[0]));
767 imagex_error(T("Out of memory!"));
770 pat_list->pats = pats;
771 pat_list->num_allocated_pats = num_allocated_pats;
773 pat_list->pats[pat_list->num_pats++] = pat;
778 parse_capture_config_line(tchar *line, size_t len,
779 enum capture_config_section *cur_section,
780 struct wimlib_capture_config *config)
785 ret = check_config_section(line, len, cur_section);
786 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
788 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
791 switch (*cur_section) {
792 case CAPTURE_CONFIG_NO_SECTION:
793 imagex_error(T("Line \"%"TS"\" is not in a section "
794 "(such as [ExclusionList]"), line);
796 case CAPTURE_CONFIG_EXCLUSION_SECTION:
797 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
799 return pattern_list_add_pattern(&config->exclusion_pats,
801 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
802 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
804 return pattern_list_add_pattern(&config->exclusion_exception_pats,
806 case CAPTURE_CONFIG_IGNORE_SECTION:
813 parse_capture_config(tchar **contents_p, size_t nchars,
814 struct wimlib_capture_config *config)
819 enum capture_config_section cur_section;
821 memset(config, 0, sizeof(*config));
823 nlines = text_file_count_lines(contents_p, &nchars);
827 cur_section = CAPTURE_CONFIG_NO_SECTION;
829 for (i = 0; i < nlines; i++) {
830 tchar *endp = tmemchr(p, T('\n'), nchars);
831 size_t len = endp - p + 1;
833 if (!is_comment_line(p, len))
834 if (!parse_capture_config_line(p, len, &cur_section, config))
842 /* Reads the contents of a file into memory. */
844 file_get_contents(const tchar *filename, size_t *len_ret)
851 if (tstat(filename, &stbuf) != 0) {
852 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
857 fp = tfopen(filename, T("rb"));
859 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
863 buf = malloc(len ? len : 1);
865 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
866 "contents of file \"%"TS"\""), len, filename);
869 if (fread(buf, 1, len, fp) != len) {
870 imagex_error_with_errno(T("Failed to read %zu bytes from the "
871 "file \"%"TS"\""), len, filename);
885 /* Read standard input until EOF and return the full contents in a malloc()ed
886 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
889 stdin_get_contents(size_t *len_ret)
891 /* stdin can, of course, be a pipe or other non-seekable file, so the
892 * total length of the data cannot be pre-determined */
894 size_t newlen = 1024;
898 char *p = realloc(buf, newlen);
899 size_t bytes_read, bytes_to_read;
901 imagex_error(T("out of memory while reading stdin"));
905 bytes_to_read = newlen - pos;
906 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
908 if (bytes_read != bytes_to_read) {
913 imagex_error_with_errno(T("error reading stdin"));
927 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
930 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
932 *num_tchars_ret = num_bytes;
934 #else /* !__WIN32__ */
935 /* On Windows, translate the text to UTF-16LE */
939 if (num_bytes >= 2 &&
940 ((text[0] == 0xff && text[1] == 0xfe) ||
941 (text[0] <= 0x7f && text[1] == 0x00)))
943 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
944 * with something that looks like an ASCII character encoded as
945 * a UTF-16LE code unit. Assume the file is encoded as
946 * UTF-16LE. This is not a 100% reliable check. */
947 num_wchars = num_bytes / 2;
948 text_wstr = (wchar_t*)text;
950 /* File does not look like UTF-16LE. Assume it is encoded in
951 * the current Windows code page. I think these are always
952 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
953 * should work as expected. */
954 text_wstr = win32_mbs_to_wcs(text,
959 *num_tchars_ret = num_wchars;
961 #endif /* __WIN32__ */
965 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
970 contents = file_get_contents(filename, &num_bytes);
973 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
977 stdin_get_text_contents(size_t *num_tchars_ret)
982 contents = stdin_get_contents(&num_bytes);
985 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
988 #define TO_PERCENT(numerator, denominator) \
989 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
991 /* Given an enumerated value for WIM compression type, return a descriptive
994 get_data_type(int ctype)
997 case WIMLIB_COMPRESSION_TYPE_NONE:
998 return T("uncompressed");
999 case WIMLIB_COMPRESSION_TYPE_LZX:
1000 return T("LZX-compressed");
1001 case WIMLIB_COMPRESSION_TYPE_XPRESS:
1002 return T("XPRESS-compressed");
1007 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1008 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1009 #define KIBIBYTE_MIN_NBYTES 10000ULL
1012 get_unit(uint64_t total_bytes, const tchar **name_ret)
1014 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1015 *name_ret = T("GiB");
1017 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1018 *name_ret = T("MiB");
1020 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1021 *name_ret = T("KiB");
1024 *name_ret = T("bytes");
1029 /* Progress callback function passed to various wimlib functions. */
1031 imagex_progress_func(enum wimlib_progress_msg msg,
1032 const union wimlib_progress_info *info)
1034 unsigned percent_done;
1035 unsigned unit_shift;
1036 const tchar *unit_name;
1037 if (imagex_be_quiet)
1040 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1041 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1042 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1043 info->write_streams.total_bytes);
1045 if (info->write_streams.completed_streams == 0) {
1046 const tchar *data_type;
1048 data_type = get_data_type(info->write_streams.compression_type);
1049 imagex_printf(T("Writing %"TS" data using %u thread%"TS"\n"),
1050 data_type, info->write_streams.num_threads,
1051 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1053 if (info->write_streams.total_parts <= 1) {
1054 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1055 "written (%u%% done)"),
1056 info->write_streams.completed_bytes >> unit_shift,
1058 info->write_streams.total_bytes >> unit_shift,
1062 imagex_printf(T("\rWriting resources from part %u of %u: "
1063 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1064 (info->write_streams.completed_parts ==
1065 info->write_streams.total_parts) ?
1066 info->write_streams.completed_parts :
1067 info->write_streams.completed_parts + 1,
1068 info->write_streams.total_parts,
1069 info->write_streams.completed_bytes >> unit_shift,
1071 info->write_streams.total_bytes >> unit_shift,
1075 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1076 imagex_printf(T("\n"));
1078 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1079 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1080 if (*info->scan.wim_target_path) {
1081 imagex_printf(T(" (loading as WIM path: "
1082 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1083 info->scan.wim_target_path);
1085 imagex_printf(T(" (loading as root of WIM image)...\n"));
1088 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1089 switch (info->scan.status) {
1090 case WIMLIB_SCAN_DENTRY_OK:
1091 imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1093 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1094 imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1096 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1097 imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1098 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1102 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1103 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1104 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1105 info->integrity.total_bytes);
1106 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1107 "of %"PRIu64" %"TS" (%u%%) done"),
1108 info->integrity.filename,
1109 info->integrity.completed_bytes >> unit_shift,
1111 info->integrity.total_bytes >> unit_shift,
1114 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1115 imagex_printf(T("\n"));
1117 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1118 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1119 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1120 info->integrity.total_bytes);
1121 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1122 "of %"PRIu64" %"TS" (%u%%) done"),
1123 info->integrity.completed_bytes >> unit_shift,
1125 info->integrity.total_bytes >> unit_shift,
1128 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1129 imagex_printf(T("\n"));
1131 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1132 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1133 "to %"TS" \"%"TS"\"\n"),
1134 info->extract.image,
1135 info->extract.image_name,
1136 info->extract.wimfile_name,
1137 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1138 T("NTFS volume") : T("directory")),
1139 info->extract.target);
1141 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1142 imagex_printf(T("Extracting "
1143 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1144 "in \"%"TS"\" to \"%"TS"\"\n"),
1145 info->extract.extract_root_wim_source_path,
1146 info->extract.image,
1147 info->extract.image_name,
1148 info->extract.wimfile_name,
1149 info->extract.target);
1151 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1152 percent_done = TO_PERCENT(info->extract.completed_bytes,
1153 info->extract.total_bytes);
1154 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1155 imagex_printf(T("\rExtracting files: "
1156 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1157 info->extract.completed_bytes >> unit_shift,
1159 info->extract.total_bytes >> unit_shift,
1162 if (info->extract.completed_bytes >= info->extract.total_bytes)
1163 imagex_printf(T("\n"));
1165 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1166 if (info->extract.total_parts != 1) {
1167 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1168 info->extract.part_number,
1169 info->extract.total_parts);
1172 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1173 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1174 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1176 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1177 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1178 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1179 info->extract.target);
1182 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1183 percent_done = TO_PERCENT(info->split.completed_bytes,
1184 info->split.total_bytes);
1185 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1186 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1187 "%"PRIu64" %"TS" (%u%%) written\n"),
1188 info->split.part_name,
1189 info->split.cur_part_number,
1190 info->split.total_parts,
1191 info->split.completed_bytes >> unit_shift,
1193 info->split.total_bytes >> unit_shift,
1197 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1198 if (info->split.completed_bytes == info->split.total_bytes) {
1199 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1200 info->split.cur_part_number,
1201 info->split.total_parts);
1204 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1205 switch (info->update.command->op) {
1206 case WIMLIB_UPDATE_OP_DELETE:
1207 imagex_printf(T("Deleted WIM path "
1208 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1209 info->update.command->delete_.wim_path);
1211 case WIMLIB_UPDATE_OP_RENAME:
1212 imagex_printf(T("Renamed WIM path "
1213 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1214 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1215 info->update.command->rename.wim_source_path,
1216 info->update.command->rename.wim_target_path);
1218 case WIMLIB_UPDATE_OP_ADD:
1226 fflush(imagex_info_file);
1231 parse_num_threads(const tchar *optarg)
1234 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1235 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1236 imagex_error(T("Number of threads must be a non-negative integer!"));
1244 * Parse an option passed to an update command.
1246 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1249 * @option: Text string for the option (beginning with --)
1251 * @cmd: `struct wimlib_update_command' that is being constructed for
1254 * Returns true if the option was recognized; false if not.
1257 update_command_add_option(int op, const tchar *option,
1258 struct wimlib_update_command *cmd)
1260 bool recognized = true;
1262 case WIMLIB_UPDATE_OP_ADD:
1263 if (!tstrcmp(option, T("--verbose")))
1264 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1265 else if (!tstrcmp(option, T("--unix-data")))
1266 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1267 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1268 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1269 else if (!tstrcmp(option, T("--strict-acls")))
1270 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1271 else if (!tstrcmp(option, T("--dereference")))
1272 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1276 case WIMLIB_UPDATE_OP_DELETE:
1277 if (!tstrcmp(option, T("--force")))
1278 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1279 else if (!tstrcmp(option, T("--recursive")))
1280 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1291 /* How many nonoption arguments each `imagex update' command expects */
1292 static const unsigned update_command_num_nonoptions[] = {
1293 [WIMLIB_UPDATE_OP_ADD] = 2,
1294 [WIMLIB_UPDATE_OP_DELETE] = 1,
1295 [WIMLIB_UPDATE_OP_RENAME] = 2,
1299 update_command_add_nonoption(int op, const tchar *nonoption,
1300 struct wimlib_update_command *cmd,
1301 unsigned num_nonoptions)
1304 case WIMLIB_UPDATE_OP_ADD:
1305 if (num_nonoptions == 0)
1306 cmd->add.fs_source_path = (tchar*)nonoption;
1308 cmd->add.wim_target_path = (tchar*)nonoption;
1310 case WIMLIB_UPDATE_OP_DELETE:
1311 cmd->delete_.wim_path = (tchar*)nonoption;
1313 case WIMLIB_UPDATE_OP_RENAME:
1314 if (num_nonoptions == 0)
1315 cmd->rename.wim_source_path = (tchar*)nonoption;
1317 cmd->rename.wim_target_path = (tchar*)nonoption;
1323 * Parse a command passed on stdin to `imagex update'.
1325 * @line: Text of the command.
1326 * @len: Length of the line, including a null terminator
1329 * @command: A `struct wimlib_update_command' to fill in from the parsed
1332 * @line_number: Line number of the command, for diagnostics.
1334 * Returns true on success; returns false on parse error.
1337 parse_update_command(tchar *line, size_t len,
1338 struct wimlib_update_command *command,
1342 tchar *command_name;
1344 size_t num_nonoptions;
1346 /* Get the command name ("add", "delete", "rename") */
1347 ret = parse_string(&line, &len, &command_name);
1348 if (ret != PARSE_STRING_SUCCESS)
1351 if (!tstrcasecmp(command_name, T("add"))) {
1352 op = WIMLIB_UPDATE_OP_ADD;
1353 } else if (!tstrcasecmp(command_name, T("delete"))) {
1354 op = WIMLIB_UPDATE_OP_DELETE;
1355 } else if (!tstrcasecmp(command_name, T("rename"))) {
1356 op = WIMLIB_UPDATE_OP_RENAME;
1358 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1359 command_name, line_number);
1364 /* Parse additional options and non-options as needed */
1369 ret = parse_string(&line, &len, &next_string);
1370 if (ret == PARSE_STRING_NONE) /* End of line */
1372 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1374 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1376 if (!update_command_add_option(op, next_string, command))
1378 imagex_error(T("Unrecognized option \"%"TS"\" to "
1379 "update command \"%"TS"\" on line %zu"),
1380 next_string, command_name, line_number);
1386 if (num_nonoptions == update_command_num_nonoptions[op])
1388 imagex_error(T("Unexpected argument \"%"TS"\" in "
1389 "update command on line %zu\n"
1390 " (The \"%"TS"\" command only "
1391 "takes %zu nonoption arguments!)\n"),
1392 next_string, line_number,
1393 command_name, num_nonoptions);
1396 update_command_add_nonoption(op, next_string,
1397 command, num_nonoptions);
1402 if (num_nonoptions != update_command_num_nonoptions[op]) {
1403 imagex_error(T("Not enough arguments to update command "
1404 "\"%"TS"\" on line %zu"), command_name, line_number);
1410 static struct wimlib_update_command *
1411 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1412 size_t *num_cmds_ret)
1416 struct wimlib_update_command *cmds;
1419 nlines = text_file_count_lines(cmd_file_contents_p,
1424 /* Always allocate at least 1 slot, just in case the implementation of
1425 * calloc() returns NULL if 0 bytes are requested. */
1426 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1428 imagex_error(T("out of memory"));
1431 p = *cmd_file_contents_p;
1433 for (i = 0; i < nlines; i++) {
1434 /* XXX: Could use rawmemchr() here instead, but it may not be
1435 * available on all platforms. */
1436 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1437 size_t len = endp - p + 1;
1439 if (!is_comment_line(p, len)) {
1440 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1451 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1452 * one image from a WIM file to a NTFS volume. */
1454 imagex_apply(int argc, tchar **argv, int cmd)
1457 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1458 int image = WIMLIB_NO_IMAGE;
1460 struct wimlib_wim_info info;
1462 const tchar *wimfile;
1463 const tchar *target;
1464 const tchar *image_num_or_name = NULL;
1465 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1467 REFGLOB_SET(refglobs);
1469 for_opt(c, apply_options) {
1471 case IMAGEX_CHECK_OPTION:
1472 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1474 case IMAGEX_HARDLINK_OPTION:
1475 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1477 case IMAGEX_SYMLINK_OPTION:
1478 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1480 case IMAGEX_VERBOSE_OPTION:
1481 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1483 case IMAGEX_REF_OPTION:
1484 ret = refglob_set_append(&refglobs, optarg);
1486 goto out_free_refglobs;
1488 case IMAGEX_UNIX_DATA_OPTION:
1489 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1491 case IMAGEX_NO_ACLS_OPTION:
1492 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1494 case IMAGEX_STRICT_ACLS_OPTION:
1495 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1497 case IMAGEX_NORPFIX_OPTION:
1498 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1500 case IMAGEX_RPFIX_OPTION:
1501 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1503 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1504 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1505 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1507 case IMAGEX_RESUME_OPTION:
1508 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1516 if (argc != 2 && argc != 3)
1521 if (!tstrcmp(wimfile, T("-"))) {
1522 /* Attempt to apply pipable WIM from standard input. */
1524 image_num_or_name = NULL;
1527 image_num_or_name = argv[1];
1532 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1533 imagex_progress_func);
1535 goto out_free_refglobs;
1537 wimlib_get_wim_info(wim, &info);
1540 /* Image explicitly specified. */
1541 image_num_or_name = argv[1];
1542 image = wimlib_resolve_image(wim, image_num_or_name);
1543 ret = verify_image_exists(image, image_num_or_name, wimfile);
1545 goto out_wimlib_free;
1548 /* No image specified; default to image 1, but only if the WIM
1549 * contains exactly one image. */
1551 if (info.image_count != 1) {
1552 imagex_error(T("\"%"TS"\" contains %d images; "
1553 "Please select one (or all)."),
1554 wimfile, info.image_count);
1563 if (refglobs.num_globs) {
1565 imagex_error(T("Can't specify --ref when applying from stdin!"));
1567 goto out_wimlib_free;
1569 ret = wim_reference_globs(wim, &refglobs, open_flags);
1571 goto out_wimlib_free;
1576 /* Interpret a regular file or block device target as a NTFS
1580 if (tstat(target, &stbuf)) {
1581 if (errno != ENOENT) {
1582 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1585 goto out_wimlib_free;
1588 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1589 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1595 ret = wimlib_extract_image(wim, image, target, extract_flags,
1596 imagex_progress_func);
1598 set_fd_to_binary_mode(STDIN_FILENO);
1599 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1601 target, extract_flags,
1602 imagex_progress_func);
1605 imagex_printf(T("Done applying WIM image.\n"));
1606 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1608 do_resource_not_found_warning(wimfile, &info, &refglobs);
1610 imagex_error(T( "If you are applying an image "
1611 "from a split pipable WIM,\n"
1612 " make sure you have "
1613 "concatenated together all parts."));
1619 refglob_set_destroy(&refglobs);
1623 usage(CMD_APPLY, stderr);
1625 goto out_free_refglobs;
1628 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1629 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1630 * the desired image. 'wimlib-imagex append': add a new image to an existing
1633 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1636 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1637 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1638 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1639 int write_flags = 0;
1640 int compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1641 const tchar *wimfile;
1645 const tchar *flags_element = NULL;
1648 WIMStruct *base_wim;
1649 const tchar *base_wimfile = NULL;
1650 WIMStruct *template_wim;
1651 const tchar *template_wimfile = NULL;
1652 const tchar *template_image_name_or_num = NULL;
1653 int template_image = WIMLIB_NO_IMAGE;
1656 unsigned num_threads = 0;
1661 const tchar *config_file = NULL;
1663 struct wimlib_capture_config *config;
1665 bool source_list = false;
1666 size_t source_list_nchars = 0;
1667 tchar *source_list_contents;
1668 bool capture_sources_malloced;
1669 struct wimlib_capture_source *capture_sources;
1671 bool name_defaulted;
1673 for_opt(c, capture_or_append_options) {
1675 case IMAGEX_BOOT_OPTION:
1676 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1678 case IMAGEX_CHECK_OPTION:
1679 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1680 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1682 case IMAGEX_NOCHECK_OPTION:
1683 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1685 case IMAGEX_CONFIG_OPTION:
1686 config_file = optarg;
1687 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1689 case IMAGEX_COMPRESS_OPTION:
1690 compression_type = get_compression_type(optarg);
1691 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1694 case IMAGEX_FLAGS_OPTION:
1695 flags_element = optarg;
1697 case IMAGEX_DEREFERENCE_OPTION:
1698 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1700 case IMAGEX_VERBOSE_OPTION:
1701 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1703 case IMAGEX_THREADS_OPTION:
1704 num_threads = parse_num_threads(optarg);
1705 if (num_threads == UINT_MAX)
1708 case IMAGEX_REBUILD_OPTION:
1709 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1711 case IMAGEX_UNIX_DATA_OPTION:
1712 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1714 case IMAGEX_SOURCE_LIST_OPTION:
1717 case IMAGEX_NO_ACLS_OPTION:
1718 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1720 case IMAGEX_STRICT_ACLS_OPTION:
1721 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1723 case IMAGEX_RPFIX_OPTION:
1724 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1726 case IMAGEX_NORPFIX_OPTION:
1727 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1729 case IMAGEX_PIPABLE_OPTION:
1730 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1732 case IMAGEX_NOT_PIPABLE_OPTION:
1733 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1735 case IMAGEX_UPDATE_OF_OPTION:
1736 if (template_image_name_or_num) {
1737 imagex_error(T("'--update-of' can only be "
1738 "specified one time!"));
1742 colon = tstrrchr(optarg, T(':'));
1745 template_wimfile = optarg;
1747 template_image_name_or_num = colon + 1;
1749 template_wimfile = NULL;
1750 template_image_name_or_num = optarg;
1754 case IMAGEX_DELTA_FROM_OPTION:
1755 if (cmd != CMD_CAPTURE) {
1756 imagex_error(T("'--delta-from' is only "
1757 "valid for capture!"));
1761 imagex_error(T("'--delta-from' can only be "
1762 "specified one time!"));
1765 base_wimfile = optarg;
1766 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1775 if (argc < 2 || argc > 4)
1781 if (!tstrcmp(wimfile, T("-"))) {
1782 /* Writing captured WIM to standard output. */
1784 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1785 imagex_error("Can't write a non-pipable WIM to "
1786 "standard output! Specify --pipable\n"
1787 " if you want to create a pipable WIM "
1788 "(but read the docs first).");
1792 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1794 if (cmd == CMD_APPEND) {
1795 imagex_error(T("Using standard output for append does "
1796 "not make sense."));
1799 wim_fd = STDOUT_FILENO;
1801 imagex_info_file = stderr;
1802 set_fd_to_binary_mode(wim_fd);
1805 /* If template image was specified using --update-of=IMAGE rather
1806 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1807 if (template_image_name_or_num && !template_wimfile) {
1809 /* Capturing delta WIM: default to base WIM. */
1810 template_wimfile = base_wimfile;
1811 } else if (cmd == CMD_APPEND) {
1812 /* Appending to WIM: default to WIM being appended to.
1814 template_wimfile = wimfile;
1816 /* Capturing a normal (non-delta) WIM, so the WIM file
1817 * *must* be explicitly specified. */
1818 imagex_error(T("For capture of non-delta WIM, "
1819 "'--update-of' must specify "
1827 name_defaulted = false;
1829 /* Set default name to SOURCE argument, omitting any directory
1830 * prefixes and trailing slashes. This requires making a copy
1831 * of @source. Leave some free characters at the end in case we
1832 * append a number to keep the name unique. */
1833 size_t source_name_len;
1835 source_name_len = tstrlen(source);
1836 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1837 name = tbasename(tstrcpy(source_copy, source));
1838 name_defaulted = true;
1840 /* Image description defaults to NULL if not given. */
1847 /* Set up capture sources in source list mode */
1848 if (source[0] == T('-') && source[1] == T('\0')) {
1849 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1851 source_list_contents = file_get_text_contents(source,
1852 &source_list_nchars);
1854 if (!source_list_contents)
1857 capture_sources = parse_source_list(&source_list_contents,
1860 if (!capture_sources) {
1862 goto out_free_source_list_contents;
1864 capture_sources_malloced = true;
1866 /* Set up capture source in non-source-list mode. */
1867 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1868 capture_sources[0].fs_source_path = source;
1869 capture_sources[0].wim_target_path = NULL;
1870 capture_sources[0].reserved = 0;
1872 capture_sources_malloced = false;
1873 source_list_contents = NULL;
1877 /* Read and parse capture configuration file. */
1880 config_str = file_get_text_contents(config_file, &config_len);
1883 goto out_free_capture_sources;
1886 config = alloca(sizeof(*config));
1887 ret = parse_capture_config(&config_str, config_len, config);
1889 goto out_free_config;
1891 /* No capture configuration file specified; use default
1892 * configuration for capturing Windows operating systems. */
1894 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1897 /* Open the existing WIM, or create a new one. */
1898 if (cmd == CMD_APPEND)
1899 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1900 imagex_progress_func);
1902 ret = wimlib_create_new_wim(compression_type, &wim);
1904 goto out_free_config;
1907 /* Detect if source is regular file or block device and set NTFS volume
1912 if (tstat(source, &stbuf) == 0) {
1913 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1914 imagex_printf(T("Capturing WIM image from NTFS "
1915 "filesystem on \"%"TS"\"\n"), source);
1916 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1919 if (errno != ENOENT) {
1920 imagex_error_with_errno(T("Failed to stat "
1921 "\"%"TS"\""), source);
1929 /* If the user did not specify an image name, and the basename of the
1930 * source already exists as an image name in the WIM file, append a
1931 * suffix to make it unique. */
1932 if (cmd == CMD_APPEND && name_defaulted) {
1933 unsigned long conflict_idx;
1934 tchar *name_end = tstrchr(name, T('\0'));
1935 for (conflict_idx = 1;
1936 wimlib_image_name_in_use(wim, name);
1939 tsprintf(name_end, T(" (%lu)"), conflict_idx);
1943 /* If capturing a delta WIM, reference resources from the base WIM
1944 * before adding the new image. */
1946 ret = wimlib_open_wim(base_wimfile, open_flags,
1947 &base_wim, imagex_progress_func);
1951 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
1954 ret = wimlib_reference_resources(wim, &base_wim, 1, 0);
1956 goto out_free_base_wim;
1961 /* If capturing or appending as an update of an existing (template) image,
1962 * open the WIM if needed and parse the image index. */
1963 if (template_image_name_or_num) {
1966 if (template_wimfile == base_wimfile) {
1967 template_wim = base_wim;
1968 } else if (template_wimfile == wimfile) {
1971 ret = wimlib_open_wim(template_wimfile, open_flags,
1972 &template_wim, imagex_progress_func);
1974 goto out_free_base_wim;
1977 template_image = wimlib_resolve_image(template_wim,
1978 template_image_name_or_num);
1980 if (template_image_name_or_num[0] == T('-')) {
1983 struct wimlib_wim_info info;
1985 wimlib_get_wim_info(wim, &info);
1986 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
1987 if (n >= 1 && n <= info.image_count &&
1989 tmp != template_image_name_or_num + 1)
1991 template_image = info.image_count - (n - 1);
1994 ret = verify_image_exists_and_is_single(template_image,
1995 template_image_name_or_num,
1998 goto out_free_template_wim;
2000 template_wim = NULL;
2003 ret = wimlib_add_image_multisource(wim,
2009 imagex_progress_func);
2011 goto out_free_template_wim;
2013 if (desc || flags_element || template_image_name_or_num) {
2014 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2015 * on which the added one is to be based has been specified with
2016 * --update-of. Get the index of the image we just
2017 * added, then use it to call the appropriate functions. */
2018 struct wimlib_wim_info info;
2020 wimlib_get_wim_info(wim, &info);
2023 ret = wimlib_set_image_descripton(wim,
2027 goto out_free_template_wim;
2030 if (flags_element) {
2031 ret = wimlib_set_image_flags(wim, info.image_count,
2034 goto out_free_template_wim;
2037 /* Reference template image if the user provided one. */
2038 if (template_image_name_or_num) {
2039 imagex_printf(T("Using image %d "
2040 "from \"%"TS"\" as template\n"),
2041 template_image, template_wimfile);
2042 ret = wimlib_reference_template_image(wim,
2048 goto out_free_template_wim;
2052 /* Write the new WIM or overwrite the existing WIM with the new image
2054 if (cmd == CMD_APPEND) {
2055 ret = wimlib_overwrite(wim, write_flags, num_threads,
2056 imagex_progress_func);
2057 } else if (wimfile) {
2058 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2059 write_flags, num_threads,
2060 imagex_progress_func);
2062 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2063 write_flags, num_threads,
2064 imagex_progress_func);
2066 out_free_template_wim:
2067 /* template_wim may alias base_wim or wim. */
2068 if (template_wim != base_wim && template_wim != wim)
2069 wimlib_free(template_wim);
2071 wimlib_free(base_wim);
2076 free(config->exclusion_pats.pats);
2077 free(config->exclusion_exception_pats.pats);
2080 out_free_capture_sources:
2081 if (capture_sources_malloced)
2082 free(capture_sources);
2083 out_free_source_list_contents:
2084 free(source_list_contents);
2095 /* Remove image(s) from a WIM. */
2097 imagex_delete(int argc, tchar **argv, int cmd)
2100 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2101 int write_flags = 0;
2102 const tchar *wimfile;
2103 const tchar *image_num_or_name;
2108 for_opt(c, delete_options) {
2110 case IMAGEX_CHECK_OPTION:
2111 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2112 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2114 case IMAGEX_SOFT_OPTION:
2115 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2126 imagex_error(T("Must specify a WIM file"));
2128 imagex_error(T("Must specify an image"));
2132 image_num_or_name = argv[1];
2134 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2135 imagex_progress_func);
2139 image = wimlib_resolve_image(wim, image_num_or_name);
2141 ret = verify_image_exists(image, image_num_or_name, wimfile);
2143 goto out_wimlib_free;
2145 ret = wimlib_delete_image(wim, image);
2147 imagex_error(T("Failed to delete image from \"%"TS"\""),
2149 goto out_wimlib_free;
2152 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2154 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2155 "deleted"), wimfile);
2163 usage(CMD_DELETE, stderr);
2169 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2171 int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2172 return (ret >= 0) ? 0 : -1;
2175 /* Print the files contained in an image(s) in a WIM file. */
2177 imagex_dir(int argc, tchar **argv, int cmd)
2179 const tchar *wimfile;
2180 WIMStruct *wim = NULL;
2183 const tchar *path = T("");
2186 for_opt(c, dir_options) {
2188 case IMAGEX_PATH_OPTION:
2199 imagex_error(T("Must specify a WIM file"));
2203 imagex_error(T("Too many arguments"));
2208 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &wim,
2209 imagex_progress_func);
2214 image = wimlib_resolve_image(wim, argv[1]);
2215 ret = verify_image_exists(image, argv[1], wimfile);
2217 goto out_wimlib_free;
2219 /* No image specified; default to image 1, but only if the WIM
2220 * contains exactly one image. */
2222 struct wimlib_wim_info info;
2224 wimlib_get_wim_info(wim, &info);
2225 if (info.image_count != 1) {
2226 imagex_error(T("\"%"TS"\" contains %d images; Please "
2227 "select one (or all)."),
2228 wimfile, info.image_count);
2235 ret = wimlib_iterate_dir_tree(wim, image, path,
2236 WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2237 print_full_path, NULL);
2244 usage(CMD_DIR, stderr);
2249 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2252 imagex_export(int argc, tchar **argv, int cmd)
2256 int export_flags = 0;
2257 int write_flags = 0;
2258 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2259 const tchar *src_wimfile;
2260 const tchar *src_image_num_or_name;
2261 const tchar *dest_wimfile;
2263 const tchar *dest_name;
2264 const tchar *dest_desc;
2266 struct wimlib_wim_info src_info;
2267 WIMStruct *dest_wim;
2272 REFGLOB_SET(refglobs);
2273 unsigned num_threads = 0;
2275 for_opt(c, export_options) {
2277 case IMAGEX_BOOT_OPTION:
2278 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2280 case IMAGEX_CHECK_OPTION:
2281 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2282 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2284 case IMAGEX_NOCHECK_OPTION:
2285 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2287 case IMAGEX_COMPRESS_OPTION:
2288 compression_type = get_compression_type(optarg);
2289 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2292 case IMAGEX_REF_OPTION:
2293 ret = refglob_set_append(&refglobs, optarg);
2295 goto out_free_refglobs;
2297 case IMAGEX_THREADS_OPTION:
2298 num_threads = parse_num_threads(optarg);
2299 if (num_threads == UINT_MAX)
2302 case IMAGEX_REBUILD_OPTION:
2303 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2305 case IMAGEX_PIPABLE_OPTION:
2306 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2308 case IMAGEX_NOT_PIPABLE_OPTION:
2309 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2317 if (argc < 3 || argc > 5)
2319 src_wimfile = argv[0];
2320 src_image_num_or_name = argv[1];
2321 dest_wimfile = argv[2];
2322 dest_name = (argc >= 4) ? argv[3] : NULL;
2323 dest_desc = (argc >= 5) ? argv[4] : NULL;
2324 ret = wimlib_open_wim(src_wimfile,
2325 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_wim,
2326 imagex_progress_func);
2328 goto out_free_refglobs;
2330 wimlib_get_wim_info(src_wim, &src_info);
2332 /* Determine if the destination is an existing file or not. If so, we
2333 * try to append the exported image(s) to it; otherwise, we create a new
2334 * WIM containing the exported image(s). Furthermore, determine if we
2335 * need to write a pipable WIM directly to standard output. */
2337 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2339 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2340 imagex_error("Can't write a non-pipable WIM to "
2341 "standard output! Specify --pipable\n"
2342 " if you want to create a pipable WIM "
2343 "(but read the docs first).");
2345 goto out_free_src_wim;
2348 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2350 dest_wimfile = NULL;
2351 dest_wim_fd = STDOUT_FILENO;
2352 imagex_info_file = stderr;
2353 set_fd_to_binary_mode(dest_wim_fd);
2356 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2358 /* Destination file exists. */
2360 if (!S_ISREG(stbuf.st_mode)) {
2361 imagex_error(T("\"%"TS"\" is not a regular file"),
2364 goto out_free_src_wim;
2366 ret = wimlib_open_wim(dest_wimfile, open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2367 &dest_wim, imagex_progress_func);
2369 goto out_free_src_wim;
2371 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2372 /* The user specified a compression type, but we're
2373 * exporting to an existing WIM. Make sure the
2374 * specified compression type is the same as the
2375 * compression type of the existing destination WIM. */
2376 struct wimlib_wim_info dest_info;
2378 wimlib_get_wim_info(dest_wim, &dest_info);
2379 if (compression_type != dest_info.compression_type) {
2380 imagex_error(T("Cannot specify a compression type that is "
2381 "not the same as that used in the "
2382 "destination WIM"));
2384 goto out_free_dest_wim;
2390 if (errno != ENOENT) {
2391 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2394 goto out_free_src_wim;
2397 /* dest_wimfile is not an existing file, so create a new WIM. */
2399 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2400 /* The user did not specify a compression type; default
2401 * to that of the source WIM. */
2403 compression_type = src_info.compression_type;
2405 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2407 goto out_free_src_wim;
2410 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2411 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2413 goto out_free_dest_wim;
2415 if (refglobs.num_globs) {
2416 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2418 goto out_free_dest_wim;
2421 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2422 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2424 imagex_error(T("--boot specified for all-images export, but source WIM "
2425 "has no bootable image."));
2427 goto out_free_dest_wim;
2430 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2431 dest_desc, export_flags, imagex_progress_func);
2433 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2434 do_resource_not_found_warning(src_wimfile,
2435 &src_info, &refglobs);
2437 goto out_free_dest_wim;
2441 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2442 imagex_progress_func);
2443 else if (dest_wimfile)
2444 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2445 write_flags, num_threads,
2446 imagex_progress_func);
2448 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2449 WIMLIB_ALL_IMAGES, write_flags,
2450 num_threads, imagex_progress_func);
2452 wimlib_free(dest_wim);
2454 wimlib_free(src_wim);
2456 refglob_set_destroy(&refglobs);
2460 usage(CMD_EXPORT, stderr);
2463 goto out_free_refglobs;
2467 is_root_wim_path(const tchar *path)
2470 for (p = path; *p; p++)
2471 if (*p != T('\\') && *p != T('/'))
2477 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2478 const tchar *dest_dir)
2480 for (size_t i = 0; i < num_cmds; i++)
2481 if (cmds[i].fs_dest_path != dest_dir)
2482 free(cmds[i].fs_dest_path);
2486 static struct wimlib_extract_command *
2487 prepare_extract_commands(tchar **paths, unsigned num_paths,
2488 int extract_flags, tchar *dest_dir,
2489 size_t *num_cmds_ret)
2491 struct wimlib_extract_command *cmds;
2493 tchar *emptystr = T("");
2495 if (num_paths == 0) {
2499 num_cmds = num_paths;
2500 cmds = calloc(num_cmds, sizeof(cmds[0]));
2502 imagex_error(T("Out of memory!"));
2506 for (size_t i = 0; i < num_cmds; i++) {
2507 cmds[i].extract_flags = extract_flags;
2508 cmds[i].wim_source_path = paths[i];
2509 if (is_root_wim_path(paths[i])) {
2510 cmds[i].fs_dest_path = dest_dir;
2512 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2513 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2514 if (!cmds[i].fs_dest_path) {
2515 free_extract_commands(cmds, num_cmds, dest_dir);
2518 tsprintf(cmds[i].fs_dest_path,
2519 T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2520 dest_dir, tbasename(paths[i]));
2523 *num_cmds_ret = num_cmds;
2527 /* Extract files or directories from a WIM image */
2529 imagex_extract(int argc, tchar **argv, int cmd)
2532 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2536 const tchar *wimfile;
2537 const tchar *image_num_or_name;
2538 tchar *dest_dir = T(".");
2539 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2541 REFGLOB_SET(refglobs);
2543 struct wimlib_extract_command *cmds;
2546 for_opt(c, extract_options) {
2548 case IMAGEX_CHECK_OPTION:
2549 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2551 case IMAGEX_VERBOSE_OPTION:
2552 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2554 case IMAGEX_REF_OPTION:
2555 ret = refglob_set_append(&refglobs, optarg);
2557 goto out_free_refglobs;
2559 case IMAGEX_UNIX_DATA_OPTION:
2560 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2562 case IMAGEX_NO_ACLS_OPTION:
2563 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2565 case IMAGEX_STRICT_ACLS_OPTION:
2566 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2568 case IMAGEX_DEST_DIR_OPTION:
2571 case IMAGEX_TO_STDOUT_OPTION:
2572 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2573 imagex_info_file = stderr;
2574 imagex_be_quiet = true;
2576 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2577 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2578 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2591 image_num_or_name = argv[1];
2596 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2601 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2605 image = wimlib_resolve_image(wim, image_num_or_name);
2606 ret = verify_image_exists_and_is_single(image,
2610 goto out_wimlib_free;
2612 if (refglobs.num_globs) {
2613 ret = wim_reference_globs(wim, &refglobs, open_flags);
2615 goto out_wimlib_free;
2618 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2619 imagex_progress_func);
2621 if (!imagex_be_quiet)
2622 imagex_printf(T("Done extracting files.\n"));
2623 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2624 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2625 "files and directories\n"
2626 " are in the WIM image.\n"),
2627 get_cmd_string(CMD_INFO, false));
2628 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2629 struct wimlib_wim_info info;
2631 wimlib_get_wim_info(wim, &info);
2632 do_resource_not_found_warning(wimfile, &info, &refglobs);
2637 free_extract_commands(cmds, num_cmds, dest_dir);
2639 refglob_set_destroy(&refglobs);
2643 usage(CMD_EXTRACT, stderr);
2646 goto out_free_refglobs;
2649 static void print_byte_field(const uint8_t field[], size_t len)
2652 tprintf(T("%02hhx"), *field++);
2656 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2658 tputs(T("WIM Information:"));
2659 tputs(T("----------------"));
2660 tprintf(T("Path: %"TS"\n"), wimfile);
2661 tprintf(T("GUID: 0x"));
2662 print_byte_field(info->guid, sizeof(info->guid));
2664 tprintf(T("Image Count: %d\n"), info->image_count);
2665 tprintf(T("Compression: %"TS"\n"),
2666 wimlib_get_compression_type_string(info->compression_type));
2667 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2668 tprintf(T("Boot Index: %d\n"), info->boot_index);
2669 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2670 tprintf(T("Integrity Info: %"TS"\n"),
2671 info->has_integrity_table ? T("yes") : T("no"));
2672 tprintf(T("Relative path junction: %"TS"\n"),
2673 info->has_rpfix ? T("yes") : T("no"));
2674 tprintf(T("Pipable: %"TS"\n"),
2675 info->pipable ? T("yes") : T("no"));
2680 print_resource(const struct wimlib_resource_entry *resource,
2684 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2685 resource->uncompressed_size);
2687 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2688 resource->compressed_size);
2690 tprintf(T("Offset = %"PRIu64" bytes\n"),
2694 tprintf(T("Part Number = %u\n"), resource->part_number);
2695 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2697 tprintf(T("Hash = 0x"));
2698 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2701 tprintf(T("Flags = "));
2702 if (resource->is_compressed)
2703 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2704 if (resource->is_metadata)
2705 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2706 if (resource->is_free)
2707 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2708 if (resource->is_spanned)
2709 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2716 print_lookup_table(WIMStruct *wim)
2718 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2721 /* Prints information about a WIM file; also can mark an image as bootable,
2722 * change the name of an image, or change the description of an image. */
2724 imagex_info(int argc, tchar **argv, int cmd)
2729 bool nocheck = false;
2730 bool header = false;
2731 bool lookup_table = false;
2733 bool metadata = false;
2734 bool short_header = true;
2735 const tchar *xml_out_file = NULL;
2736 const tchar *wimfile;
2737 const tchar *image_num_or_name;
2738 const tchar *new_name;
2739 const tchar *new_desc;
2743 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2744 struct wimlib_wim_info info;
2746 for_opt(c, info_options) {
2748 case IMAGEX_BOOT_OPTION:
2751 case IMAGEX_CHECK_OPTION:
2754 case IMAGEX_NOCHECK_OPTION:
2757 case IMAGEX_HEADER_OPTION:
2759 short_header = false;
2761 case IMAGEX_LOOKUP_TABLE_OPTION:
2762 lookup_table = true;
2763 short_header = false;
2765 case IMAGEX_XML_OPTION:
2767 short_header = false;
2769 case IMAGEX_EXTRACT_XML_OPTION:
2770 xml_out_file = optarg;
2771 short_header = false;
2773 case IMAGEX_METADATA_OPTION:
2775 short_header = false;
2784 if (argc < 1 || argc > 4)
2788 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2789 new_name = (argc >= 3) ? argv[2] : NULL;
2790 new_desc = (argc >= 4) ? argv[3] : NULL;
2792 if (check && nocheck) {
2793 imagex_error(T("Can't specify both --check and --nocheck"));
2798 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2800 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2804 wimlib_get_wim_info(wim, &info);
2806 image = wimlib_resolve_image(wim, image_num_or_name);
2807 ret = WIMLIB_ERR_INVALID_IMAGE;
2808 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2809 verify_image_exists(image, image_num_or_name, wimfile);
2811 imagex_error(T("If you would like to set the boot "
2812 "index to 0, specify image \"0\" with "
2813 "the --boot flag."));
2815 goto out_wimlib_free;
2818 if (boot && info.image_count == 0) {
2819 imagex_error(T("--boot is meaningless on a WIM with no images"));
2820 goto out_wimlib_free;
2823 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2825 imagex_error(T("Cannot specify the --boot flag "
2826 "without specifying a specific "
2827 "image in a multi-image WIM"));
2828 goto out_wimlib_free;
2831 imagex_error(T("Cannot specify the NEW_NAME "
2832 "without specifying a specific "
2833 "image in a multi-image WIM"));
2834 goto out_wimlib_free;
2838 /* Operations that print information are separated from operations that
2839 * recreate the WIM file. */
2840 if (!new_name && !boot) {
2842 /* Read-only operations */
2844 if (image == WIMLIB_NO_IMAGE) {
2845 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2846 image_num_or_name, wimfile);
2847 goto out_wimlib_free;
2850 if (image == WIMLIB_ALL_IMAGES && short_header)
2851 print_wim_information(wimfile, &info);
2854 wimlib_print_header(wim);
2857 if (info.total_parts != 1) {
2858 tfprintf(stderr, T("Warning: Only showing the lookup table "
2859 "for part %d of a %d-part WIM.\n"),
2860 info.part_number, info.total_parts);
2862 print_lookup_table(wim);
2866 ret = wimlib_extract_xml_data(wim, stdout);
2868 goto out_wimlib_free;
2874 fp = tfopen(xml_out_file, T("wb"));
2876 imagex_error_with_errno(T("Failed to open the "
2877 "file \"%"TS"\" for "
2881 goto out_wimlib_free;
2883 ret = wimlib_extract_xml_data(wim, fp);
2885 imagex_error(T("Failed to close the file "
2891 goto out_wimlib_free;
2895 wimlib_print_available_images(wim, image);
2898 ret = wimlib_print_metadata(wim, image);
2900 goto out_wimlib_free;
2905 /* Modification operations */
2907 if (image == WIMLIB_ALL_IMAGES)
2910 if (image == WIMLIB_NO_IMAGE && new_name) {
2911 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2912 "when using image 0"), new_name);
2914 goto out_wimlib_free;
2918 if (image == info.boot_index) {
2919 imagex_printf(T("Image %d is already marked as "
2920 "bootable.\n"), image);
2923 imagex_printf(T("Marking image %d as bootable.\n"),
2925 info.boot_index = image;
2926 ret = wimlib_set_wim_info(wim, &info,
2927 WIMLIB_CHANGE_BOOT_INDEX);
2929 goto out_wimlib_free;
2933 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
2935 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
2939 imagex_printf(T("Changing the name of image %d to "
2940 "\"%"TS"\".\n"), image, new_name);
2941 ret = wimlib_set_image_name(wim, image, new_name);
2943 goto out_wimlib_free;
2947 const tchar *old_desc;
2948 old_desc = wimlib_get_image_description(wim, image);
2949 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2950 imagex_printf(T("The description of image %d is already "
2951 "\"%"TS"\".\n"), image, new_desc);
2954 imagex_printf(T("Changing the description of image %d "
2955 "to \"%"TS"\".\n"), image, new_desc);
2956 ret = wimlib_set_image_descripton(wim, image,
2959 goto out_wimlib_free;
2963 /* Only call wimlib_overwrite() if something actually needs to
2965 if (boot || new_name || new_desc ||
2966 (check && !info.has_integrity_table) ||
2967 (nocheck && info.has_integrity_table))
2969 int write_flags = 0;
2972 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2974 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2975 ret = wimlib_overwrite(wim, write_flags, 1,
2976 imagex_progress_func);
2978 imagex_printf(T("The file \"%"TS"\" was not modified "
2979 "because nothing needed to be done.\n"),
2990 usage(CMD_INFO, stderr);
2996 /* Join split WIMs into one part WIM */
2998 imagex_join(int argc, tchar **argv, int cmd)
3001 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
3002 int wim_write_flags = 0;
3003 const tchar *output_path;
3006 for_opt(c, join_options) {
3008 case IMAGEX_CHECK_OPTION:
3009 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3010 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3020 imagex_error(T("Must specify one or more split WIM (.swm) "
3024 output_path = argv[0];
3025 ret = wimlib_join((const tchar * const *)++argv,
3030 imagex_progress_func);
3035 usage(CMD_JOIN, stderr);
3040 #if WIM_MOUNTING_SUPPORTED
3042 /* Mounts a WIM image. */
3044 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3047 int mount_flags = 0;
3048 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
3049 const tchar *staging_dir = NULL;
3050 const tchar *wimfile;
3053 struct wimlib_wim_info info;
3057 REFGLOB_SET(refglobs);
3059 if (cmd == CMD_MOUNTRW) {
3060 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3061 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3064 for_opt(c, mount_options) {
3066 case IMAGEX_ALLOW_OTHER_OPTION:
3067 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3069 case IMAGEX_CHECK_OPTION:
3070 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3072 case IMAGEX_DEBUG_OPTION:
3073 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3075 case IMAGEX_STREAMS_INTERFACE_OPTION:
3076 if (!tstrcasecmp(optarg, T("none")))
3077 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3078 else if (!tstrcasecmp(optarg, T("xattr")))
3079 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3080 else if (!tstrcasecmp(optarg, T("windows")))
3081 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3083 imagex_error(T("Unknown stream interface \"%"TS"\""),
3088 case IMAGEX_REF_OPTION:
3089 ret = refglob_set_append(&refglobs, optarg);
3091 goto out_free_refglobs;
3093 case IMAGEX_STAGING_DIR_OPTION:
3094 staging_dir = optarg;
3096 case IMAGEX_UNIX_DATA_OPTION:
3097 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3105 if (argc != 2 && argc != 3)
3110 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3112 goto out_free_refglobs;
3114 wimlib_get_wim_info(wim, &info);
3117 /* Image explicitly specified. */
3118 image = wimlib_resolve_image(wim, argv[1]);
3120 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3124 /* No image specified; default to image 1, but only if the WIM
3125 * contains exactly one image. */
3127 if (info.image_count != 1) {
3128 imagex_error(T("\"%"TS"\" contains %d images; Please "
3129 "select one."), wimfile, info.image_count);
3137 if (refglobs.num_globs) {
3138 ret = wim_reference_globs(wim, &refglobs, open_flags);
3143 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3145 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3147 image, wimfile, dir);
3152 refglob_set_destroy(&refglobs);
3158 goto out_free_refglobs;
3160 #endif /* WIM_MOUNTING_SUPPORTED */
3162 /* Rebuild a WIM file */
3164 imagex_optimize(int argc, tchar **argv, int cmd)
3167 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3168 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3171 const tchar *wimfile;
3174 unsigned num_threads = 0;
3176 for_opt(c, optimize_options) {
3178 case IMAGEX_CHECK_OPTION:
3179 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3180 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3182 case IMAGEX_NOCHECK_OPTION:
3183 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3185 case IMAGEX_RECOMPRESS_OPTION:
3186 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3188 case IMAGEX_THREADS_OPTION:
3189 num_threads = parse_num_threads(optarg);
3190 if (num_threads == UINT_MAX)
3193 case IMAGEX_PIPABLE_OPTION:
3194 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3196 case IMAGEX_NOT_PIPABLE_OPTION:
3197 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3211 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3215 old_size = file_get_size(wimfile);
3216 tprintf(T("\"%"TS"\" original size: "), wimfile);
3218 tputs(T("Unknown"));
3220 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3222 ret = wimlib_overwrite(wim, write_flags, num_threads,
3223 imagex_progress_func);
3225 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3226 goto out_wimlib_free;
3229 new_size = file_get_size(wimfile);
3230 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3232 tputs(T("Unknown"));
3234 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3236 tfputs(T("Space saved: "), stdout);
3237 if (new_size != -1 && old_size != -1) {
3238 tprintf(T("%lld KiB\n"),
3239 ((long long)old_size - (long long)new_size) >> 10);
3241 tputs(T("Unknown"));
3250 usage(CMD_OPTIMIZE, stderr);
3256 /* Split a WIM into a spanned set */
3258 imagex_split(int argc, tchar **argv, int cmd)
3262 int write_flags = 0;
3263 unsigned long part_size;
3268 for_opt(c, split_options) {
3270 case IMAGEX_CHECK_OPTION:
3271 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3272 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3284 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3285 if (tmp == argv[2] || *tmp) {
3286 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3287 imagex_error(T("The part size must be an integer or "
3288 "floating-point number of megabytes."));
3291 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3295 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3301 usage(CMD_SPLIT, stderr);
3307 #if WIM_MOUNTING_SUPPORTED
3308 /* Unmounts a mounted WIM image. */
3310 imagex_unmount(int argc, tchar **argv, int cmd)
3313 int unmount_flags = 0;
3316 for_opt(c, unmount_options) {
3318 case IMAGEX_COMMIT_OPTION:
3319 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3321 case IMAGEX_CHECK_OPTION:
3322 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3324 case IMAGEX_REBUILD_OPTION:
3325 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3327 case IMAGEX_LAZY_OPTION:
3328 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3339 ret = wimlib_unmount_image(argv[0], unmount_flags,
3340 imagex_progress_func);
3342 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3347 usage(CMD_UNMOUNT, stderr);
3351 #endif /* WIM_MOUNTING_SUPPORTED */
3354 * Add, delete, or rename files in a WIM image.
3357 imagex_update(int argc, tchar **argv, int cmd)
3359 const tchar *wimfile;
3363 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3364 int write_flags = 0;
3365 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3366 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
3367 int default_delete_flags = 0;
3368 unsigned num_threads = 0;
3370 tchar *cmd_file_contents;
3371 size_t cmd_file_nchars;
3372 struct wimlib_update_command *cmds;
3374 tchar *command_str = NULL;
3376 const tchar *config_file = NULL;
3378 struct wimlib_capture_config *config;
3380 for_opt(c, update_options) {
3382 /* Generic or write options */
3383 case IMAGEX_THREADS_OPTION:
3384 num_threads = parse_num_threads(optarg);
3385 if (num_threads == UINT_MAX)
3388 case IMAGEX_CHECK_OPTION:
3389 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3390 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3392 case IMAGEX_REBUILD_OPTION:
3393 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3395 case IMAGEX_COMMAND_OPTION:
3397 imagex_error(T("--command may only be specified "
3398 "one time. Please provide\n"
3399 " the update commands "
3400 "on standard input instead."));
3403 command_str = tstrdup(optarg);
3405 imagex_error(T("Out of memory!"));
3409 /* Default delete options */
3410 case IMAGEX_FORCE_OPTION:
3411 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3413 case IMAGEX_RECURSIVE_OPTION:
3414 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3417 /* Global add option */
3418 case IMAGEX_CONFIG_OPTION:
3419 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3420 config_file = optarg;
3423 /* Default add options */
3424 case IMAGEX_VERBOSE_OPTION:
3425 default_add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
3427 case IMAGEX_DEREFERENCE_OPTION:
3428 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3430 case IMAGEX_UNIX_DATA_OPTION:
3431 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3433 case IMAGEX_NO_ACLS_OPTION:
3434 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3436 case IMAGEX_STRICT_ACLS_OPTION:
3437 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3446 if (argc != 1 && argc != 2)
3450 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3452 goto out_free_command_str;
3455 /* Image explicitly specified. */
3456 image = wimlib_resolve_image(wim, argv[1]);
3457 ret = verify_image_exists_and_is_single(image, argv[1],
3460 goto out_wimlib_free;
3462 /* No image specified; default to image 1, but only if the WIM
3463 * contains exactly one image. */
3464 struct wimlib_wim_info info;
3466 wimlib_get_wim_info(wim, &info);
3467 if (info.image_count != 1) {
3468 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3469 wimfile, info.image_count);
3476 /* Parse capture configuration file if specified */
3480 config_str = file_get_text_contents(config_file, &config_len);
3483 goto out_wimlib_free;
3486 config = alloca(sizeof(*config));
3487 ret = parse_capture_config(&config_str, config_len, config);
3489 goto out_free_config;
3492 default_add_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
3495 /* Read update commands from standard input, or the command string if
3498 cmd_file_contents = NULL;
3499 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3502 if (isatty(STDIN_FILENO)) {
3503 tputs(T("Reading update commands from standard input..."));
3504 recommend_man_page(CMD_UPDATE, stdout);
3506 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3507 if (!cmd_file_contents) {
3509 goto out_free_config;
3512 /* Parse the update commands */
3513 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3518 goto out_free_cmd_file_contents;
3521 /* Set default flags and capture config on the update commands */
3522 for (size_t i = 0; i < num_cmds; i++) {
3523 switch (cmds[i].op) {
3524 case WIMLIB_UPDATE_OP_ADD:
3525 cmds[i].add.add_flags |= default_add_flags;
3526 cmds[i].add.config = config;
3528 case WIMLIB_UPDATE_OP_DELETE:
3529 cmds[i].delete_.delete_flags |= default_delete_flags;
3536 /* Execute the update commands */
3537 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3538 imagex_progress_func);
3542 /* Overwrite the updated WIM */
3543 ret = wimlib_overwrite(wim, write_flags, num_threads,
3544 imagex_progress_func);
3547 out_free_cmd_file_contents:
3548 free(cmd_file_contents);
3551 free(config->exclusion_pats.pats);
3552 free(config->exclusion_exception_pats.pats);
3557 out_free_command_str:
3562 usage(CMD_UPDATE, stderr);
3565 goto out_free_command_str;
3570 struct imagex_command {
3572 int (*func)(int argc, tchar **argv, int cmd);
3575 static const struct imagex_command imagex_commands[] = {
3576 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3577 [CMD_APPLY] = {T("apply"), imagex_apply},
3578 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3579 [CMD_DELETE] = {T("delete"), imagex_delete},
3580 [CMD_DIR ] = {T("dir"), imagex_dir},
3581 [CMD_EXPORT] = {T("export"), imagex_export},
3582 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3583 [CMD_INFO] = {T("info"), imagex_info},
3584 [CMD_JOIN] = {T("join"), imagex_join},
3585 #if WIM_MOUNTING_SUPPORTED
3586 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3587 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3589 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3590 [CMD_SPLIT] = {T("split"), imagex_split},
3591 #if WIM_MOUNTING_SUPPORTED
3592 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3594 [CMD_UPDATE] = {T("update"), imagex_update},
3597 static const tchar *usage_strings[] = {
3600 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3601 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3602 " [--nocheck] [--flags EDITION_ID] [--verbose]\n"
3603 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3604 " [--rebuild] [--unix-data] [--source-list] [--no-acls]\n"
3605 " [--strict-acls] [--rpfix] [--norpfix] [--pipable]\n"
3606 " [--not-pipable] [--update-of=[WIMFILE:]IMAGE]\n"
3610 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3611 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
3612 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
3613 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3614 " [--include-invalid-names]\n"
3618 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3619 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3620 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3621 " [--verbose] [--dereference] [--config=FILE]\n"
3622 " [--threads=NUM_THREADS] [--unix-data] [--source-list]\n"
3623 " [--no-acls] [--strict-acls] [--norpfix] [--pipable]\n"
3624 " [--update-of=[WIMFILE:]IMAGE] [--delta-from=WIMFILE]\n"
3628 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n"
3633 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH]\n"
3637 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3638 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3639 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3640 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3641 " [--pipable] [--not-pipable]\n"
3645 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
3646 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
3647 " [--no-acls] [--strict-acls] [--to-stdout]\n"
3648 " [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
3652 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3653 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
3654 " [--lookup-table] [--xml] [--extract-xml FILE]\n"
3659 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3661 #if WIM_MOUNTING_SUPPORTED
3664 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3665 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3666 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
3670 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3671 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
3672 " [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
3677 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3678 " [--threads=NUM_THREADS] [--pipable] [--not-pipable]\n"
3682 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
3684 #if WIM_MOUNTING_SUPPORTED
3687 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
3692 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
3693 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
3694 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
3698 static const tchar *invocation_name;
3699 static int invocation_cmd = CMD_NONE;
3701 static const tchar *get_cmd_string(int cmd, bool nospace)
3703 static tchar buf[50];
3704 if (cmd == CMD_NONE) {
3705 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
3706 } else if (invocation_cmd != CMD_NONE) {
3707 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
3709 const tchar *format;
3712 format = T("%"TS"-%"TS"");
3714 format = T("%"TS" %"TS"");
3715 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
3723 static const tchar *s =
3725 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3726 "Copyright (C) 2012, 2013 Eric Biggers\n"
3727 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3728 "This is free software: you are free to change and redistribute it.\n"
3729 "There is NO WARRANTY, to the extent permitted by law.\n"
3731 "Report bugs to "PACKAGE_BUGREPORT".\n"
3738 help_or_version(int argc, tchar **argv, int cmd)
3743 for (i = 1; i < argc; i++) {
3745 if (p[0] == T('-') && p[1] == T('-')) {
3747 if (!tstrcmp(p, T("help"))) {
3748 if (cmd == CMD_NONE)
3753 } else if (!tstrcmp(p, T("version"))) {
3762 print_usage_string(int cmd, FILE *fp)
3764 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
3768 recommend_man_page(int cmd, FILE *fp)
3770 const tchar *format_str;
3772 format_str = T("See %"TS".pdf in the doc directory for more details.\n");
3774 format_str = T("Try `man %"TS"' for more details.\n");
3776 tfprintf(fp, format_str, get_cmd_string(cmd, true));
3780 usage(int cmd, FILE *fp)
3782 tfprintf(fp, T("Usage:\n"));
3783 print_usage_string(cmd, fp);
3784 tfprintf(fp, T("\n"));
3785 recommend_man_page(cmd, fp);
3791 tfprintf(fp, T("Usage:\n"));
3792 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
3793 print_usage_string(cmd, fp);
3794 tfprintf(fp, T("\n"));
3796 static const tchar *extra =
3799 " %"TS" --version\n"
3801 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3804 tfprintf(fp, extra, invocation_name, invocation_name);
3805 recommend_man_page(CMD_NONE, fp);
3808 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3809 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3810 * something else), while an Windows the command arguments will be UTF-16LE
3811 * encoded 'wchar_t' strings. */
3814 wmain(int argc, wchar_t **argv, wchar_t **envp)
3816 main(int argc, char **argv)
3823 imagex_info_file = stdout;
3824 invocation_name = tbasename(argv[0]);
3827 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3828 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3832 setlocale(LC_ALL, "");
3833 codeset = nl_langinfo(CODESET);
3834 if (!strstr(codeset, "UTF-8") &&
3835 !strstr(codeset, "UTF8") &&
3836 !strstr(codeset, "utf-8") &&
3837 !strstr(codeset, "utf8"))
3840 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
3841 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3842 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3843 " to any value to force wimlib to use UTF-8.\n",
3848 #endif /* !__WIN32__ */
3850 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
3852 if (!tstrncmp(invocation_name, T("wim"), 3) &&
3853 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
3854 for (int i = 0; i < CMD_MAX; i++) {
3855 if (!tstrcmp(invocation_name + 3,
3856 imagex_commands[i].name))
3865 /* Unless already known from the invocation name, determine which
3866 * command was specified. */
3867 if (cmd == CMD_NONE) {
3869 imagex_error(T("No command specified!\n"));
3873 for (int i = 0; i < CMD_MAX; i++) {
3874 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
3879 if (cmd != CMD_NONE) {
3885 /* Handle --help and --version. --help can be either for the program as
3886 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
3887 * CMD_NONE). Note: help_or_version() will not return if a --help or
3888 * --version argument was found. */
3889 help_or_version(argc, argv, cmd);
3891 /* Bail if a valid command was not specified. */
3892 if (cmd == CMD_NONE) {
3893 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
3898 /* Enable warning and error messages in wimlib be more user-friendly.
3900 wimlib_set_print_errors(true);
3902 /* Initialize wimlib. */
3903 ret = wimlib_global_init(init_flags);
3905 goto out_check_status;
3907 /* Call the command handler function. */
3908 ret = imagex_commands[cmd].func(argc, argv, cmd);
3910 /* Check for error writing to standard output, especially since for some
3911 * commands, writing to standard output is part of the program's actual
3912 * behavior and not just for informational purposes. */
3913 if (ferror(stdout) || fclose(stdout)) {
3914 imagex_error_with_errno(T("error writing to standard output"));
3919 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3920 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
3921 * error code from which an error message can be printed. */
3923 imagex_error(T("Exiting with error code %d:\n"
3925 wimlib_get_error_string(ret));
3926 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3927 imagex_error_with_errno(T("errno"));
3929 /* Make wimlib free any resources it's holding (although this is not
3930 * strictly necessary because the process is ending anyway). */
3931 wimlib_global_cleanup();