4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 # include "config.h" /* Need for PACKAGE_VERSION, etc. */
30 #include "wimlib_tchar.h"
50 # include "imagex-win32.h"
51 # define tbasename win32_wbasename
52 # define tglob win32_wglob
56 # include <langinfo.h>
57 # define tbasename basename
62 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
64 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
85 static void usage(int cmd_type);
86 static void usage_all(void);
88 static bool imagex_be_quiet = false;
91 static const tchar *usage_strings[] = {
94 IMAGEX_PROGNAME" append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
95 " [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
96 " [--verbose] [--dereference] [--config=FILE]\n"
97 " [--threads=NUM_THREADS] [--rebuild] [--unix-data]\n"
98 " [--source-list] [--no-acls] [--strict-acls]\n"
99 " [--rpfix] [--norpfix]\n"
103 IMAGEX_PROGNAME" apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
104 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
105 " [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
106 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
107 " [--including-invalid-names]\n"
111 IMAGEX_PROGNAME" capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
112 " [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
113 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
114 " [--config=FILE] [--threads=NUM_THREADS] [--unix-data]\n"
115 " [--source-list] [--no-acls] [--strict-acls]\n"
116 " [--rpfix] [--norpfix]\n"
120 IMAGEX_PROGNAME" delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n"
124 IMAGEX_PROGNAME" dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
128 IMAGEX_PROGNAME" export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
129 " DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
130 " [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
131 " [--threads=NUM_THREADS] [--rebuild]\n"
135 IMAGEX_PROGNAME" extract WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
136 " [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
137 " [--no-acls] [--strict-acls] [--to-stdout] [--dest-dir=DIR]\n"
138 " [--including-invalid-names]\n"
142 IMAGEX_PROGNAME" info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
143 " [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
144 " [--xml] [--extract-xml FILE] [--metadata]\n"
148 IMAGEX_PROGNAME" join [--check] WIMFILE SPLIT_WIM...\n"
152 IMAGEX_PROGNAME" mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
153 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
154 " [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
158 IMAGEX_PROGNAME" mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
159 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
160 " [--staging-dir=DIR] [--unix-data] [--allow-other]\n"
164 IMAGEX_PROGNAME" optimize WIMFILE [--check] [--recompress]\n"
165 " [--threads=NUM_THREADS]\n"
169 IMAGEX_PROGNAME" split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n"
173 IMAGEX_PROGNAME" unmount DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
177 IMAGEX_PROGNAME" update WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
178 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
179 " [DEFAULT_DELETE_OPTIONS] < CMDFILE\n"
185 recommend_man_page(const tchar *cmd_name)
187 const tchar *format_str;
189 format_str = T("See "IMAGEX_PROGNAME"%"TS"%"TS".pdf in the "
190 "doc directory for more details.\n");
192 format_str = T("Try `man "IMAGEX_PROGNAME"%"TS"%"TS"' "
193 "for more details.\n");
195 tprintf(format_str, *cmd_name ? T("-") : T(""), cmd_name);
199 IMAGEX_ALLOW_OTHER_OPTION,
202 IMAGEX_COMMIT_OPTION,
203 IMAGEX_COMPRESS_OPTION,
204 IMAGEX_CONFIG_OPTION,
206 IMAGEX_DEREFERENCE_OPTION,
207 IMAGEX_DEST_DIR_OPTION,
208 IMAGEX_EXTRACT_XML_OPTION,
211 IMAGEX_HARDLINK_OPTION,
212 IMAGEX_HEADER_OPTION,
213 IMAGEX_INCLUDING_INVALID_NAMES_OPTION,
215 IMAGEX_LOOKUP_TABLE_OPTION,
216 IMAGEX_METADATA_OPTION,
217 IMAGEX_NORPFIX_OPTION,
218 IMAGEX_NO_ACLS_OPTION,
219 IMAGEX_REBUILD_OPTION,
220 IMAGEX_RECOMPRESS_OPTION,
221 IMAGEX_RECURSIVE_OPTION,
225 IMAGEX_SOURCE_LIST_OPTION,
226 IMAGEX_STAGING_DIR_OPTION,
227 IMAGEX_STREAMS_INTERFACE_OPTION,
228 IMAGEX_STRICT_ACLS_OPTION,
229 IMAGEX_SYMLINK_OPTION,
230 IMAGEX_THREADS_OPTION,
231 IMAGEX_TO_STDOUT_OPTION,
232 IMAGEX_UNIX_DATA_OPTION,
233 IMAGEX_VERBOSE_OPTION,
237 static const struct option apply_options[] = {
238 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
239 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
240 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
241 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
242 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
243 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
244 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
245 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
246 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
247 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
248 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
249 {T("including-invalid-names"), no_argument, NULL, IMAGEX_INCLUDING_INVALID_NAMES_OPTION},
252 static const struct option capture_or_append_options[] = {
253 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
254 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
255 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
256 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
257 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
258 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
259 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
260 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
261 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
262 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
263 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
264 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
265 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
266 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
267 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
268 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
271 static const struct option delete_options[] = {
272 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
273 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
277 static const struct option export_options[] = {
278 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
279 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
280 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
281 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
282 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
283 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
287 static const struct option extract_options[] = {
288 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
289 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
290 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
291 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
292 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
293 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
294 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
295 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
296 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
297 {T("including-invalid-names"), no_argument, NULL, IMAGEX_INCLUDING_INVALID_NAMES_OPTION},
301 static const struct option info_options[] = {
302 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
303 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
304 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
305 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
306 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
307 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
308 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
312 static const struct option join_options[] = {
313 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
317 static const struct option mount_options[] = {
318 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
319 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
320 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
321 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
322 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
323 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
324 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
328 static const struct option optimize_options[] = {
329 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
330 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
331 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
335 static const struct option split_options[] = {
336 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
340 static const struct option unmount_options[] = {
341 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
342 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
343 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
344 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
348 static const struct option update_options[] = {
349 /* Careful: some of the options here set the defaults for update
350 * commands, but the flags given to an actual update command (and not to
351 * `imagex update' itself are also handled in
352 * update_command_add_option(). */
353 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
354 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
355 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
357 /* Default delete options */
358 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
359 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
361 /* Global add option */
362 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
364 /* Default add options */
365 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
366 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
367 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
368 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
369 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
370 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
374 /* Print formatted error message to stderr. */
376 imagex_error(const tchar *format, ...)
379 va_start(va, format);
380 tfputs(T("ERROR: "), stderr);
381 tvfprintf(stderr, format, va);
382 tputc(T('\n'), stderr);
386 /* Print formatted error message to stderr. */
388 imagex_error_with_errno(const tchar *format, ...)
390 int errno_save = errno;
392 va_start(va, format);
393 tfputs(T("ERROR: "), stderr);
394 tvfprintf(stderr, format, va);
395 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
400 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
402 if (image == WIMLIB_NO_IMAGE) {
403 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
404 " Please specify a 1-based image index or "
406 " You may use `"IMAGEX_PROGNAME" info' to list the images "
407 "contained in a WIM."),
408 image_name, wim_name);
415 verify_image_is_single(int image)
417 if (image == WIMLIB_ALL_IMAGES) {
418 imagex_error(T("Cannot specify all images for this action!"));
425 verify_image_exists_and_is_single(int image, const tchar *image_name,
426 const tchar *wim_name)
429 ret = verify_image_exists(image, image_name, wim_name);
431 ret = verify_image_is_single(image);
435 /* Parse the argument to --compress */
437 get_compression_type(const tchar *optarg)
439 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
440 return WIMLIB_COMPRESSION_TYPE_LZX;
441 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
442 return WIMLIB_COMPRESSION_TYPE_XPRESS;
443 else if (!tstrcasecmp(optarg, T("none")))
444 return WIMLIB_COMPRESSION_TYPE_NONE;
446 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
447 "\"maximum\", \"fast\", or \"none\"."), optarg);
448 return WIMLIB_COMPRESSION_TYPE_INVALID;
452 /* Returns the size of a file given its name, or -1 if the file does not exist
453 * or its size cannot be determined. */
455 file_get_size(const tchar *filename)
458 if (tstat(filename, &st) == 0)
464 tchar pat_ntfs_log[] = T("/$ntfs.log");
465 tchar pat_hiberfil_sys[] = T("/hiberfil.sys");
466 tchar pat_pagefile_sys[] = T("/pagefile.sys");
467 tchar pat_system_volume_information[] = T("/System Volume Information");
468 tchar pat_recycler[] = T("/RECYCLER");
469 tchar pat_windows_csc[] = T("/Windows/CSC");
471 tchar *default_pats[] = {
475 pat_system_volume_information,
480 static struct wimlib_capture_config default_capture_config = {
482 .num_pats = sizeof(default_pats) / sizeof(*default_pats),
483 .pats = default_pats,
488 PARSE_STRING_SUCCESS = 0,
489 PARSE_STRING_FAILURE = 1,
490 PARSE_STRING_NONE = 2,
494 * Parses a string token from an array of characters.
496 * Tokens are either whitespace-delimited, or double or single-quoted.
498 * @line_p: Pointer to the pointer to the line of data. Will be updated
499 * to point past the string token iff the return value is
500 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
503 * @len_p: @len_p initially stores the length of the line of data, which may
504 * be 0, and it will be updated to the number of bytes remaining in
505 * the line iff the return value is PARSE_STRING_SUCCESS.
507 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
508 * parsed string token will be returned here.
510 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
511 * PARSE_STRING_FAILURE if the data was invalid due to a missing
512 * closing quote; or PARSE_STRING_NONE if the line ended before the
513 * beginning of a string token was found.
516 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
519 tchar *line = *line_p;
523 /* Skip leading whitespace */
526 return PARSE_STRING_NONE;
527 if (!istspace(*line) && *line != T('\0'))
533 if (quote_char == T('"') || quote_char == T('\'')) {
538 line = tmemchr(line, quote_char, len);
540 imagex_error(T("Missing closing quote: %"TS), fn - 1);
541 return PARSE_STRING_FAILURE;
544 /* Unquoted string. Go until whitespace. Line is terminated
545 * by '\0', so no need to check 'len'. */
549 } while (!istspace(*line) && *line != T('\0'));
556 return PARSE_STRING_SUCCESS;
559 /* Parses a line of data (not an empty line or comment) in the source list file
560 * format. (See the man page for 'wimlib-imagex capture' for details on this
561 * format and the meaning.)
563 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
564 * len == 0. The data in @line will be modified by this function call.
566 * @len: Length of the line of data.
568 * @source: On success, the capture source and target described by the line is
569 * written into this destination. Note that it will contain pointers
570 * to data in the @line array.
572 * Returns true if the line was valid; false otherwise. */
574 parse_source_list_line(tchar *line, size_t len,
575 struct wimlib_capture_source *source)
579 ret = parse_string(&line, &len, &source->fs_source_path);
580 if (ret != PARSE_STRING_SUCCESS)
582 ret = parse_string(&line, &len, &source->wim_target_path);
583 if (ret == PARSE_STRING_NONE)
584 source->wim_target_path = source->fs_source_path;
585 return ret != PARSE_STRING_FAILURE;
588 /* Returns %true if the given line of length @len > 0 is a comment or empty line
589 * in the source list file format. */
591 is_comment_line(const tchar *line, size_t len)
596 if (!istspace(*line) && *line != T('\0'))
606 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
609 tchar *contents = *contents_p;
610 size_t nchars = *nchars_p;
613 for (i = 0; i < nchars; i++)
614 if (contents[i] == T('\n'))
617 /* Handle last line not terminated by a newline */
618 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
619 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
621 imagex_error(T("Out of memory!"));
624 contents[nchars] = T('\n');
625 *contents_p = contents;
633 /* Parses a file in the source list format. (See the man page for
634 * 'wimlib-imagex capture' for details on this format and the meaning.)
636 * @source_list_contents: Contents of the source list file. Note that this
637 * buffer will be modified to save memory allocations,
638 * and cannot be freed until the returned array of
639 * wimlib_capture_source's has also been freed.
641 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
644 * @nsources_ret: On success, the length of the returned array is
647 * Returns: An array of `struct wimlib_capture_source's that can be passed to
648 * the wimlib_add_image_multisource() function to specify how a WIM image is to
650 static struct wimlib_capture_source *
651 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
652 size_t *nsources_ret)
656 struct wimlib_capture_source *sources;
659 nlines = text_file_count_lines(source_list_contents_p,
660 &source_list_nchars);
664 /* Always allocate at least 1 slot, just in case the implementation of
665 * calloc() returns NULL if 0 bytes are requested. */
666 sources = calloc(nlines ?: 1, sizeof(*sources));
668 imagex_error(T("out of memory"));
671 p = *source_list_contents_p;
673 for (i = 0; i < nlines; i++) {
674 /* XXX: Could use rawmemchr() here instead, but it may not be
675 * available on all platforms. */
676 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
677 size_t len = endp - p + 1;
679 if (!is_comment_line(p, len)) {
680 if (!parse_source_list_line(p, len, &sources[j++])) {
693 enum capture_config_section {
694 CAPTURE_CONFIG_NO_SECTION,
695 CAPTURE_CONFIG_EXCLUSION_SECTION,
696 CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
697 CAPTURE_CONFIG_IGNORE_SECTION,
701 CAPTURE_CONFIG_INVALID_SECTION,
702 CAPTURE_CONFIG_CHANGED_SECTION,
703 CAPTURE_CONFIG_SAME_SECTION,
707 check_config_section(tchar *line, size_t len,
708 enum capture_config_section *cur_section)
710 while (istspace(*line))
714 return CAPTURE_CONFIG_SAME_SECTION;
717 tchar *endbrace = tstrrchr(line, T(']'));
719 return CAPTURE_CONFIG_SAME_SECTION;
721 if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
722 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
723 } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
724 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
725 } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
726 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
727 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
728 "of capture config file\n"),
730 } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
731 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
732 tfputs(T("WARNING: Ignoring [AlignmentList] section "
733 "of capture config file\n"),
736 imagex_error(T("Invalid capture config file section \"%"TS"\""),
738 return CAPTURE_CONFIG_INVALID_SECTION;
740 return CAPTURE_CONFIG_CHANGED_SECTION;
745 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
748 if (pat_list->num_pats == pat_list->num_allocated_pats) {
750 size_t num_allocated_pats = pat_list->num_pats + 8;
752 pats = realloc(pat_list->pats,
753 num_allocated_pats * sizeof(pat_list->pats[0]));
755 imagex_error(T("Out of memory!"));
758 pat_list->pats = pats;
759 pat_list->num_allocated_pats = num_allocated_pats;
761 pat_list->pats[pat_list->num_pats++] = pat;
766 parse_capture_config_line(tchar *line, size_t len,
767 enum capture_config_section *cur_section,
768 struct wimlib_capture_config *config)
773 ret = check_config_section(line, len, cur_section);
774 if (ret == CAPTURE_CONFIG_INVALID_SECTION)
776 if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
779 switch (*cur_section) {
780 case CAPTURE_CONFIG_NO_SECTION:
781 imagex_error(T("Line \"%"TS"\" is not in a section "
782 "(such as [ExclusionList]"), line);
784 case CAPTURE_CONFIG_EXCLUSION_SECTION:
785 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
787 return pattern_list_add_pattern(&config->exclusion_pats,
789 case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
790 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
792 return pattern_list_add_pattern(&config->exclusion_exception_pats,
794 case CAPTURE_CONFIG_IGNORE_SECTION:
801 parse_capture_config(tchar **contents_p, size_t nchars,
802 struct wimlib_capture_config *config)
807 enum capture_config_section cur_section;
809 memset(config, 0, sizeof(*config));
811 nlines = text_file_count_lines(contents_p, &nchars);
815 cur_section = CAPTURE_CONFIG_NO_SECTION;
817 for (i = 0; i < nlines; i++) {
818 tchar *endp = tmemchr(p, T('\n'), nchars);
819 size_t len = endp - p + 1;
821 if (!is_comment_line(p, len))
822 if (!parse_capture_config_line(p, len, &cur_section, config))
830 /* Reads the contents of a file into memory. */
832 file_get_contents(const tchar *filename, size_t *len_ret)
839 if (tstat(filename, &stbuf) != 0) {
840 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
845 fp = tfopen(filename, T("rb"));
847 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
853 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
854 "contents of file \"%"TS"\""), len, filename);
857 if (fread(buf, 1, len, fp) != len) {
858 imagex_error_with_errno(T("Failed to read %zu bytes from the "
859 "file \"%"TS"\""), len, filename);
873 /* Read standard input until EOF and return the full contents in a malloc()ed
874 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
877 stdin_get_contents(size_t *len_ret)
879 /* stdin can, of course, be a pipe or other non-seekable file, so the
880 * total length of the data cannot be pre-determined */
882 size_t newlen = 1024;
886 char *p = realloc(buf, newlen);
887 size_t bytes_read, bytes_to_read;
889 imagex_error(T("out of memory while reading stdin"));
893 bytes_to_read = newlen - pos;
894 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
896 if (bytes_read != bytes_to_read) {
901 imagex_error_with_errno(T("error reading stdin"));
915 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
918 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
920 *num_tchars_ret = num_bytes;
922 #else /* !__WIN32__ */
923 /* On Windows, translate the text to UTF-16LE */
927 if (num_bytes >= 2 &&
928 ((text[0] == 0xff && text[1] == 0xfe) ||
929 (text[0] <= 0x7f && text[1] == 0x00)))
931 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
932 * with something that looks like an ASCII character encoded as
933 * a UTF-16LE code unit. Assume the file is encoded as
934 * UTF-16LE. This is not a 100% reliable check. */
935 num_wchars = num_bytes / 2;
936 text_wstr = (wchar_t*)text;
938 /* File does not look like UTF-16LE. Assume it is encoded in
939 * the current Windows code page. I think these are always
940 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
941 * should work as expected. */
942 text_wstr = win32_mbs_to_wcs(text,
947 *num_tchars_ret = num_wchars;
949 #endif /* __WIN32__ */
953 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
958 contents = file_get_contents(filename, &num_bytes);
961 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
965 stdin_get_text_contents(size_t *num_tchars_ret)
970 contents = stdin_get_contents(&num_bytes);
973 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
976 /* Return 0 if a path names a file to which the current user has write access;
977 * -1 otherwise (and print an error message). */
979 file_writable(const tchar *path)
982 ret = taccess(path, W_OK);
984 imagex_error_with_errno(T("Can't modify \"%"TS"\""), path);
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);
1044 if (info->write_streams.completed_streams == 0) {
1045 const tchar *data_type;
1047 data_type = get_data_type(info->write_streams.compression_type);
1048 tprintf(T("Writing %"TS" data using %u thread%"TS"\n"),
1049 data_type, info->write_streams.num_threads,
1050 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1052 tprintf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1053 "written (%u%% done)"),
1054 info->write_streams.completed_bytes >> unit_shift,
1056 info->write_streams.total_bytes >> unit_shift,
1059 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1062 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1063 tprintf(T("Scanning \"%"TS"\""), info->scan.source);
1064 if (*info->scan.wim_target_path) {
1065 tprintf(T(" (loading as WIM path: \"/%"TS"\")...\n"),
1066 info->scan.wim_target_path);
1068 tprintf(T(" (loading as root of WIM image)...\n"));
1071 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1072 if (info->scan.excluded)
1073 tprintf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1075 tprintf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1077 /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
1079 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1080 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1081 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1082 info->integrity.total_bytes);
1083 tprintf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" "TS" "
1084 "of %"PRIu64" "TS" (%u%%) done"),
1085 info->integrity.filename,
1086 info->integrity.completed_bytes >> unit_shift,
1088 info->integrity.total_bytes >> unit_shift,
1091 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1094 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1095 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1096 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1097 info->integrity.total_bytes);
1098 tprintf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1099 "of %"PRIu64" %"TS" (%u%%) done"),
1100 info->integrity.completed_bytes >> unit_shift,
1102 info->integrity.total_bytes >> unit_shift,
1105 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1108 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1109 tprintf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1110 "to %"TS" \"%"TS"\"\n"),
1111 info->extract.image,
1112 info->extract.image_name,
1113 info->extract.wimfile_name,
1114 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1115 T("NTFS volume") : T("directory")),
1116 info->extract.target);
1118 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1119 tprintf(T("Extracting \"%"TS"\" from image %d (\"%"TS"\") "
1120 "in \"%"TS"\" to \"%"TS"\"\n"),
1121 info->extract.extract_root_wim_source_path,
1122 info->extract.image,
1123 info->extract.image_name,
1124 info->extract.wimfile_name,
1125 info->extract.target);
1127 /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
1128 /*tprintf(T("Applying directory structure to %"TS"\n"),*/
1129 /*info->extract.target);*/
1131 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1132 percent_done = TO_PERCENT(info->extract.completed_bytes,
1133 info->extract.total_bytes);
1134 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1135 tprintf(T("\rExtracting files: "
1136 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1137 info->extract.completed_bytes >> unit_shift,
1139 info->extract.total_bytes >> unit_shift,
1142 if (info->extract.completed_bytes >= info->extract.total_bytes)
1145 case WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY:
1146 tprintf(T("%"TS"\n"), info->extract.cur_path);
1148 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1149 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1150 tprintf(T("Setting timestamps on all extracted files...\n"));
1152 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1153 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1154 tprintf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1155 info->extract.target);
1158 case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
1159 percent_done = TO_PERCENT(info->join.completed_bytes,
1160 info->join.total_bytes);
1161 unit_shift = get_unit(info->join.total_bytes, &unit_name);
1162 tprintf(T("Writing resources from part %u of %u: "
1163 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written\n"),
1164 (info->join.completed_parts == info->join.total_parts) ?
1165 info->join.completed_parts : info->join.completed_parts + 1,
1166 info->join.total_parts,
1167 info->join.completed_bytes >> unit_shift,
1169 info->join.total_bytes >> unit_shift,
1173 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1174 percent_done = TO_PERCENT(info->split.completed_bytes,
1175 info->split.total_bytes);
1176 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1177 tprintf(T("Writing \"%"TS"\": %"PRIu64" %"TS" of "
1178 "%"PRIu64" %"TS" (%u%%) written\n"),
1179 info->split.part_name,
1180 info->split.completed_bytes >> unit_shift,
1182 info->split.total_bytes >> unit_shift,
1186 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1187 if (info->split.completed_bytes == info->split.total_bytes) {
1188 tprintf(T("Finished writing %u split WIM parts\n"),
1189 info->split.cur_part_number);
1199 /* Open all the split WIM parts that correspond to a file glob.
1201 * @first_part specifies the first part of the split WIM and it may be either
1202 * included or omitted from the glob. */
1204 open_swms_from_glob(const tchar *swm_glob,
1205 const tchar *first_part,
1207 WIMStruct ***additional_swms_ret,
1208 unsigned *num_additional_swms_ret)
1210 unsigned num_additional_swms = 0;
1211 WIMStruct **additional_swms = NULL;
1215 /* Warning: glob() is replaced in Windows native builds */
1216 ret = tglob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
1218 if (ret == GLOB_NOMATCH) {
1219 imagex_error(T("Found no files for glob \"%"TS"\""),
1222 imagex_error_with_errno(T("Failed to process glob \"%"TS"\""),
1228 num_additional_swms = globbuf.gl_pathc;
1229 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
1230 if (!additional_swms) {
1231 imagex_error(T("Out of memory"));
1235 unsigned offset = 0;
1236 for (unsigned i = 0; i < num_additional_swms; i++) {
1237 if (tstrcmp(globbuf.gl_pathv[i], first_part) == 0) {
1241 ret = wimlib_open_wim(globbuf.gl_pathv[i],
1242 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
1243 &additional_swms[i - offset],
1244 imagex_progress_func);
1246 goto out_close_swms;
1248 *additional_swms_ret = additional_swms;
1249 *num_additional_swms_ret = num_additional_swms - offset;
1253 for (unsigned i = 0; i < num_additional_swms; i++)
1254 wimlib_free(additional_swms[i]);
1255 free(additional_swms);
1264 parse_num_threads(const tchar *optarg)
1267 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1268 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1269 imagex_error(T("Number of threads must be a non-negative integer!"));
1277 * Parse an option passed to an update command.
1279 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1282 * @option: Text string for the option (beginning with --)
1284 * @cmd: `struct wimlib_update_command' that is being constructed for
1287 * Returns true if the option was recognized; false if not.
1290 update_command_add_option(int op, const tchar *option,
1291 struct wimlib_update_command *cmd)
1293 bool recognized = true;
1295 case WIMLIB_UPDATE_OP_ADD:
1296 if (!tstrcmp(option, T("--verbose")))
1297 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1298 else if (!tstrcmp(option, T("--unix-data")))
1299 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1300 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1301 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1302 else if (!tstrcmp(option, T("--strict-acls")))
1303 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1304 else if (!tstrcmp(option, T("--dereference")))
1305 cmd->add.add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1309 case WIMLIB_UPDATE_OP_DELETE:
1310 if (!tstrcmp(option, T("--force")))
1311 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1312 else if (!tstrcmp(option, T("--recursive")))
1313 cmd->delete.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1324 /* How many nonoption arguments each `imagex update' command expects */
1325 static const unsigned update_command_num_nonoptions[] = {
1326 [WIMLIB_UPDATE_OP_ADD] = 2,
1327 [WIMLIB_UPDATE_OP_DELETE] = 1,
1328 [WIMLIB_UPDATE_OP_RENAME] = 2,
1332 update_command_add_nonoption(int op, const tchar *nonoption,
1333 struct wimlib_update_command *cmd,
1334 unsigned num_nonoptions)
1337 case WIMLIB_UPDATE_OP_ADD:
1338 if (num_nonoptions == 0)
1339 cmd->add.fs_source_path = (tchar*)nonoption;
1341 cmd->add.wim_target_path = (tchar*)nonoption;
1343 case WIMLIB_UPDATE_OP_DELETE:
1344 cmd->delete.wim_path = (tchar*)nonoption;
1346 case WIMLIB_UPDATE_OP_RENAME:
1347 if (num_nonoptions == 0)
1348 cmd->rename.wim_source_path = (tchar*)nonoption;
1350 cmd->rename.wim_target_path = (tchar*)nonoption;
1356 * Parse a command passed on stdin to `imagex update'.
1358 * @line: Text of the command.
1359 * @len: Length of the line, including a null terminator
1362 * @command: A `struct wimlib_update_command' to fill in from the parsed
1365 * @line_number: Line number of the command, for diagnostics.
1367 * Returns true on success; returns false on parse error.
1370 parse_update_command(tchar *line, size_t len,
1371 struct wimlib_update_command *command,
1375 tchar *command_name;
1377 size_t num_nonoptions;
1379 /* Get the command name ("add", "delete", "rename") */
1380 ret = parse_string(&line, &len, &command_name);
1381 if (ret != PARSE_STRING_SUCCESS)
1384 if (!tstrcasecmp(command_name, T("add"))) {
1385 op = WIMLIB_UPDATE_OP_ADD;
1386 } else if (!tstrcasecmp(command_name, T("delete"))) {
1387 op = WIMLIB_UPDATE_OP_DELETE;
1388 } else if (!tstrcasecmp(command_name, T("rename"))) {
1389 op = WIMLIB_UPDATE_OP_RENAME;
1391 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1392 command_name, line_number);
1397 /* Parse additional options and non-options as needed */
1402 ret = parse_string(&line, &len, &next_string);
1403 if (ret == PARSE_STRING_NONE) /* End of line */
1405 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1407 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1409 if (!update_command_add_option(op, next_string, command))
1411 imagex_error(T("Unrecognized option \"%"TS"\" to "
1412 "update command \"%"TS"\" on line %zu"),
1413 next_string, command_name, line_number);
1419 if (num_nonoptions == update_command_num_nonoptions[op])
1421 imagex_error(T("Unexpected argument \"%"TS"\" in "
1422 "update command on line %zu\n"
1423 " (The \"%"TS"\" command only "
1424 "takes %u nonoption arguments!)\n"),
1425 next_string, line_number,
1426 command_name, num_nonoptions);
1429 update_command_add_nonoption(op, next_string,
1430 command, num_nonoptions);
1435 if (num_nonoptions != update_command_num_nonoptions[op]) {
1436 imagex_error(T("Not enough arguments to update command "
1437 "\"%"TS"\" on line %zu"), command_name, line_number);
1443 static struct wimlib_update_command *
1444 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1445 size_t *num_cmds_ret)
1449 struct wimlib_update_command *cmds;
1452 nlines = text_file_count_lines(cmd_file_contents_p,
1457 /* Always allocate at least 1 slot, just in case the implementation of
1458 * calloc() returns NULL if 0 bytes are requested. */
1459 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1461 imagex_error(T("out of memory"));
1464 p = *cmd_file_contents_p;
1466 for (i = 0; i < nlines; i++) {
1467 /* XXX: Could use rawmemchr() here instead, but it may not be
1468 * available on all platforms. */
1469 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1470 size_t len = endp - p + 1;
1472 if (!is_comment_line(p, len)) {
1473 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1484 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1485 * one image from a WIM file to a NTFS volume. */
1487 imagex_apply(int argc, tchar **argv)
1490 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1495 const tchar *wimfile;
1496 const tchar *target;
1497 const tchar *image_num_or_name;
1498 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1500 const tchar *swm_glob = NULL;
1501 WIMStruct **additional_swms = NULL;
1502 unsigned num_additional_swms = 0;
1504 for_opt(c, apply_options) {
1506 case IMAGEX_CHECK_OPTION:
1507 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1509 case IMAGEX_HARDLINK_OPTION:
1510 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1512 case IMAGEX_SYMLINK_OPTION:
1513 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1515 case IMAGEX_VERBOSE_OPTION:
1516 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1518 case IMAGEX_REF_OPTION:
1521 case IMAGEX_UNIX_DATA_OPTION:
1522 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1524 case IMAGEX_NO_ACLS_OPTION:
1525 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1527 case IMAGEX_STRICT_ACLS_OPTION:
1528 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1530 case IMAGEX_NORPFIX_OPTION:
1531 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1533 case IMAGEX_RPFIX_OPTION:
1534 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1536 case IMAGEX_INCLUDING_INVALID_NAMES_OPTION:
1537 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1538 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1547 if (argc != 2 && argc != 3) {
1554 image_num_or_name = T("1");
1557 image_num_or_name = argv[1];
1561 ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func);
1565 image = wimlib_resolve_image(w, image_num_or_name);
1566 ret = verify_image_exists(image, image_num_or_name, wimfile);
1570 num_images = wimlib_get_num_images(w);
1571 if (argc == 2 && num_images != 1) {
1572 imagex_error(T("\"%"TS"\" contains %d images; Please select one "
1573 "(or all)."), wimfile, num_images);
1580 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1582 &num_additional_swms);
1589 ret = tstat(target, &stbuf);
1591 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1592 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1594 if (errno != ENOENT) {
1595 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1603 win32_acquire_restore_privileges();
1605 ret = wimlib_extract_image(w, image, target, extract_flags,
1606 additional_swms, num_additional_swms,
1607 imagex_progress_func);
1609 tprintf(T("Done applying WIM image.\n"));
1611 win32_release_restore_privileges();
1615 if (additional_swms) {
1616 for (unsigned i = 0; i < num_additional_swms; i++)
1617 wimlib_free(additional_swms[i]);
1618 free(additional_swms);
1623 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1624 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1625 * the desired image. 'wimlib-imagex append': add a new image to an existing
1628 imagex_capture_or_append(int argc, tchar **argv)
1632 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
1633 int write_flags = 0;
1634 int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
1635 const tchar *wimfile;
1638 const tchar *flags_element = NULL;
1642 int cmd = tstrcmp(argv[0], T("append")) ? CAPTURE : APPEND;
1643 unsigned num_threads = 0;
1646 size_t source_name_len;
1649 const tchar *config_file = NULL;
1651 struct wimlib_capture_config *config = NULL;
1653 bool source_list = false;
1654 size_t source_list_nchars;
1655 tchar *source_list_contents;
1656 bool capture_sources_malloced;
1657 struct wimlib_capture_source *capture_sources;
1660 for_opt(c, capture_or_append_options) {
1662 case IMAGEX_BOOT_OPTION:
1663 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1665 case IMAGEX_CHECK_OPTION:
1666 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1667 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1669 case IMAGEX_CONFIG_OPTION:
1670 config_file = optarg;
1672 case IMAGEX_COMPRESS_OPTION:
1673 compression_type = get_compression_type(optarg);
1674 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1677 case IMAGEX_FLAGS_OPTION:
1678 flags_element = optarg;
1680 case IMAGEX_DEREFERENCE_OPTION:
1681 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1683 case IMAGEX_VERBOSE_OPTION:
1684 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1686 case IMAGEX_THREADS_OPTION:
1687 num_threads = parse_num_threads(optarg);
1688 if (num_threads == UINT_MAX)
1691 case IMAGEX_REBUILD_OPTION:
1692 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1694 case IMAGEX_UNIX_DATA_OPTION:
1695 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1697 case IMAGEX_SOURCE_LIST_OPTION:
1700 case IMAGEX_NO_ACLS_OPTION:
1701 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1703 case IMAGEX_STRICT_ACLS_OPTION:
1704 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1706 case IMAGEX_RPFIX_OPTION:
1707 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1709 case IMAGEX_NORPFIX_OPTION:
1710 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1720 if (argc < 2 || argc > 4) {
1731 /* Set default name to SOURCE argument, omitting any directory
1732 * prefixes and trailing slashes. This requires making a copy
1734 source_name_len = tstrlen(source);
1735 source_copy = alloca((source_name_len + 1) * sizeof(tchar));
1736 name = tbasename(tstrcpy(source_copy, source));
1738 /* Image description defaults to NULL if not given. */
1739 desc = (argc >= 4) ? argv[3] : NULL;
1742 /* Set up capture sources in source list mode */
1743 if (source[0] == T('-') && source[1] == T('\0')) {
1744 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1746 source_list_contents = file_get_text_contents(source,
1747 &source_list_nchars);
1749 if (!source_list_contents)
1752 capture_sources = parse_source_list(&source_list_contents,
1755 if (!capture_sources) {
1757 goto out_free_source_list_contents;
1759 capture_sources_malloced = true;
1761 /* Set up capture source in non-source-list mode (could be
1762 * either "normal" mode or "NTFS mode"--- see the man page). */
1763 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1764 capture_sources[0].fs_source_path = source;
1765 capture_sources[0].wim_target_path = NULL;
1766 capture_sources[0].reserved = 0;
1768 capture_sources_malloced = false;
1769 source_list_contents = NULL;
1775 config_str = file_get_text_contents(config_file, &config_len);
1778 goto out_free_capture_sources;
1781 config = alloca(sizeof(*config));
1782 ret = parse_capture_config(&config_str, config_len, config);
1784 goto out_free_config;
1786 config = &default_capture_config;
1790 ret = wimlib_open_wim(wimfile, open_flags, &w,
1791 imagex_progress_func);
1793 ret = wimlib_create_new_wim(compression_type, &w);
1795 goto out_free_config;
1799 ret = tstat(source, &stbuf);
1801 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1802 tprintf(T("Capturing WIM image from NTFS "
1803 "filesystem on \"%"TS"\"\n"), source);
1804 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1807 if (errno != ENOENT) {
1808 imagex_error_with_errno(T("Failed to stat "
1809 "\"%"TS"\""), source);
1811 goto out_wimlib_free;
1816 win32_acquire_capture_privileges();
1819 ret = wimlib_add_image_multisource(w,
1825 imagex_progress_func);
1827 goto out_release_privs;
1828 cur_image = wimlib_get_num_images(w);
1830 ret = wimlib_set_image_descripton(w, cur_image, desc);
1832 goto out_release_privs;
1834 if (flags_element) {
1835 ret = wimlib_set_image_flags(w, cur_image, flags_element);
1837 goto out_release_privs;
1839 if (cmd == APPEND) {
1840 ret = wimlib_overwrite(w, write_flags, num_threads,
1841 imagex_progress_func);
1843 ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags,
1844 num_threads, imagex_progress_func);
1846 if (ret == WIMLIB_ERR_REOPEN)
1849 imagex_error(T("Failed to write the WIM file \"%"TS"\""),
1853 win32_release_capture_privileges();
1858 if (config != NULL && config != &default_capture_config) {
1859 free(config->exclusion_pats.pats);
1860 free(config->exclusion_exception_pats.pats);
1863 out_free_capture_sources:
1864 if (capture_sources_malloced)
1865 free(capture_sources);
1866 out_free_source_list_contents:
1867 free(source_list_contents);
1871 /* Remove image(s) from a WIM. */
1873 imagex_delete(int argc, tchar **argv)
1877 int write_flags = 0;
1878 const tchar *wimfile;
1879 const tchar *image_num_or_name;
1884 for_opt(c, delete_options) {
1886 case IMAGEX_CHECK_OPTION:
1887 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1888 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1890 case IMAGEX_SOFT_OPTION:
1891 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
1903 imagex_error(T("Must specify a WIM file"));
1905 imagex_error(T("Must specify an image"));
1910 image_num_or_name = argv[1];
1912 ret = file_writable(wimfile);
1916 ret = wimlib_open_wim(wimfile, open_flags, &w,
1917 imagex_progress_func);
1921 image = wimlib_resolve_image(w, image_num_or_name);
1923 ret = verify_image_exists(image, image_num_or_name, wimfile);
1927 ret = wimlib_delete_image(w, image);
1929 imagex_error(T("Failed to delete image from \"%"TS"\""), wimfile);
1933 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
1934 if (ret == WIMLIB_ERR_REOPEN)
1937 imagex_error(T("Failed to write the file \"%"TS"\" with image "
1938 "deleted"), wimfile);
1945 /* Print the files contained in an image(s) in a WIM file. */
1947 imagex_dir(int argc, tchar **argv)
1949 const tchar *wimfile;
1956 imagex_error(T("Must specify a WIM file"));
1961 imagex_error(T("Too many arguments"));
1967 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w,
1968 imagex_progress_func);
1973 image = wimlib_resolve_image(w, argv[2]);
1974 ret = verify_image_exists(image, argv[2], wimfile);
1978 /* Image was not specified. If the WIM only contains one image,
1979 * choose that one; otherwise, print an error. */
1980 num_images = wimlib_get_num_images(w);
1981 if (num_images != 1) {
1982 imagex_error(T("\"%"TS"\" contains %d images; Please "
1983 "select one."), wimfile, num_images);
1991 ret = wimlib_print_files(w, image);
1997 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2000 imagex_export(int argc, tchar **argv)
2004 int export_flags = 0;
2005 int write_flags = 0;
2006 int compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
2007 bool compression_type_specified = false;
2008 const tchar *src_wimfile;
2009 const tchar *src_image_num_or_name;
2010 const tchar *dest_wimfile;
2011 const tchar *dest_name;
2012 const tchar *dest_desc;
2013 WIMStruct *src_w = NULL;
2014 WIMStruct *dest_w = NULL;
2019 const tchar *swm_glob = NULL;
2020 WIMStruct **additional_swms = NULL;
2021 unsigned num_additional_swms = 0;
2022 unsigned num_threads = 0;
2024 for_opt(c, export_options) {
2026 case IMAGEX_BOOT_OPTION:
2027 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2029 case IMAGEX_CHECK_OPTION:
2030 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2031 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2033 case IMAGEX_COMPRESS_OPTION:
2034 compression_type = get_compression_type(optarg);
2035 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2037 compression_type_specified = true;
2039 case IMAGEX_REF_OPTION:
2042 case IMAGEX_THREADS_OPTION:
2043 num_threads = parse_num_threads(optarg);
2044 if (num_threads == UINT_MAX)
2047 case IMAGEX_REBUILD_OPTION:
2048 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2057 if (argc < 3 || argc > 5) {
2061 src_wimfile = argv[0];
2062 src_image_num_or_name = argv[1];
2063 dest_wimfile = argv[2];
2064 dest_name = (argc >= 4) ? argv[3] : NULL;
2065 dest_desc = (argc >= 5) ? argv[4] : NULL;
2066 ret = wimlib_open_wim(src_wimfile,
2067 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w,
2068 imagex_progress_func);
2072 /* Determine if the destination is an existing file or not.
2073 * If so, we try to append the exported image(s) to it; otherwise, we
2074 * create a new WIM containing the exported image(s). */
2075 if (tstat(dest_wimfile, &stbuf) == 0) {
2079 /* Destination file exists. */
2081 if (!S_ISREG(stbuf.st_mode)) {
2082 imagex_error(T("\"%"TS"\" is not a regular file"),
2087 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w,
2088 imagex_progress_func);
2092 ret = file_writable(dest_wimfile);
2096 dest_ctype = wimlib_get_compression_type(dest_w);
2097 if (compression_type_specified
2098 && compression_type != dest_ctype)
2100 imagex_error(T("Cannot specify a compression type that is "
2101 "not the same as that used in the "
2102 "destination WIM"));
2108 /* dest_wimfile is not an existing file, so create a new WIM. */
2109 if (!compression_type_specified)
2110 compression_type = wimlib_get_compression_type(src_w);
2111 if (errno == ENOENT) {
2112 ret = wimlib_create_new_wim(compression_type, &dest_w);
2116 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2123 image = wimlib_resolve_image(src_w, src_image_num_or_name);
2124 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2129 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
2131 &num_additional_swms);
2136 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
2137 export_flags, additional_swms,
2138 num_additional_swms, imagex_progress_func);
2144 ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES,
2145 write_flags, num_threads,
2146 imagex_progress_func);
2148 ret = wimlib_overwrite(dest_w, write_flags, num_threads,
2149 imagex_progress_func);
2151 if (ret == WIMLIB_ERR_REOPEN)
2154 wimlib_free(dest_w);
2155 if (additional_swms) {
2156 for (unsigned i = 0; i < num_additional_swms; i++)
2157 wimlib_free(additional_swms[i]);
2158 free(additional_swms);
2164 is_root_wim_path(const tchar *path)
2167 for (p = path; *p; p++)
2168 if (*p != T('\\') && *p != T('/'))
2174 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2175 const tchar *dest_dir)
2177 for (size_t i = 0; i < num_cmds; i++)
2178 if (cmds[i].fs_dest_path != dest_dir)
2179 free(cmds[i].fs_dest_path);
2183 static struct wimlib_extract_command *
2184 prepare_extract_commands(tchar **paths, unsigned num_paths,
2185 int extract_flags, tchar *dest_dir,
2186 size_t *num_cmds_ret)
2188 struct wimlib_extract_command *cmds;
2190 tchar *emptystr = T("");
2192 if (num_paths == 0) {
2196 num_cmds = num_paths;
2197 cmds = calloc(num_cmds, sizeof(cmds[0]));
2199 imagex_error(T("Out of memory!"));
2203 for (size_t i = 0; i < num_cmds; i++) {
2204 cmds[i].extract_flags = extract_flags;
2205 cmds[i].wim_source_path = paths[i];
2206 if (is_root_wim_path(paths[i])) {
2207 cmds[i].fs_dest_path = dest_dir;
2209 size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2210 cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2211 if (!cmds[i].fs_dest_path) {
2212 free_extract_commands(cmds, num_cmds, dest_dir);
2215 tsprintf(cmds[i].fs_dest_path, T("%"TS"/%"TS), dest_dir,
2216 tbasename(paths[i]));
2219 *num_cmds_ret = num_cmds;
2223 /* Extract files or directories from a WIM image */
2225 imagex_extract(int argc, tchar **argv)
2228 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2232 const tchar *wimfile;
2233 const tchar *image_num_or_name;
2234 tchar *dest_dir = T(".");
2235 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2237 const tchar *swm_glob = NULL;
2238 WIMStruct **additional_swms = NULL;
2239 unsigned num_additional_swms = 0;
2241 struct wimlib_extract_command *cmds;
2244 for_opt(c, extract_options) {
2246 case IMAGEX_CHECK_OPTION:
2247 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2249 case IMAGEX_VERBOSE_OPTION:
2250 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2252 case IMAGEX_REF_OPTION:
2255 case IMAGEX_UNIX_DATA_OPTION:
2256 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2258 case IMAGEX_NO_ACLS_OPTION:
2259 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2261 case IMAGEX_STRICT_ACLS_OPTION:
2262 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2264 case IMAGEX_DEST_DIR_OPTION:
2267 case IMAGEX_TO_STDOUT_OPTION:
2268 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2269 imagex_be_quiet = true;
2271 case IMAGEX_INCLUDING_INVALID_NAMES_OPTION:
2272 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2273 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2286 image_num_or_name = argv[1];
2291 cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2298 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2302 image = wimlib_resolve_image(wim, image_num_or_name);
2303 ret = verify_image_exists_and_is_single(image,
2307 goto out_wimlib_free;
2310 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2312 &num_additional_swms);
2314 goto out_wimlib_free;
2318 win32_acquire_restore_privileges();
2321 ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2322 additional_swms, num_additional_swms,
2323 imagex_progress_func);
2325 if (!imagex_be_quiet)
2326 tprintf(T("Done extracting files.\n"));
2327 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2328 tfprintf(stderr, T("Note: You can use `"IMAGEX_PROGNAME" dir' to see what "
2329 "files and directories\n"
2330 " are in the WIM image.\n"));
2333 win32_release_restore_privileges();
2335 if (additional_swms) {
2336 for (unsigned i = 0; i < num_additional_swms; i++)
2337 wimlib_free(additional_swms[i]);
2338 free(additional_swms);
2343 free_extract_commands(cmds, num_cmds, dest_dir);
2352 /* Prints information about a WIM file; also can mark an image as bootable,
2353 * change the name of an image, or change the description of an image. */
2355 imagex_info(int argc, tchar **argv)
2360 bool header = false;
2361 bool lookup_table = false;
2363 bool metadata = false;
2364 bool short_header = true;
2365 const tchar *xml_out_file = NULL;
2366 const tchar *wimfile;
2367 const tchar *image_num_or_name = T("all");
2368 const tchar *new_name = NULL;
2369 const tchar *new_desc = NULL;
2374 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2379 for_opt(c, info_options) {
2381 case IMAGEX_BOOT_OPTION:
2384 case IMAGEX_CHECK_OPTION:
2387 case IMAGEX_HEADER_OPTION:
2389 short_header = false;
2391 case IMAGEX_LOOKUP_TABLE_OPTION:
2392 lookup_table = true;
2393 short_header = false;
2395 case IMAGEX_XML_OPTION:
2397 short_header = false;
2399 case IMAGEX_EXTRACT_XML_OPTION:
2400 xml_out_file = optarg;
2401 short_header = false;
2403 case IMAGEX_METADATA_OPTION:
2405 short_header = false;
2415 if (argc == 0 || argc > 4) {
2421 image_num_or_name = argv[1];
2431 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2433 ret = wimlib_open_wim(wimfile, open_flags, &w,
2434 imagex_progress_func);
2438 part_number = wimlib_get_part_number(w, &total_parts);
2440 image = wimlib_resolve_image(w, image_num_or_name);
2441 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2442 imagex_error(T("The image \"%"TS"\" does not exist"),
2445 imagex_error(T("If you would like to set the boot "
2446 "index to 0, specify image \"0\" with "
2447 "the --boot flag."));
2449 ret = WIMLIB_ERR_INVALID_IMAGE;
2453 num_images = wimlib_get_num_images(w);
2455 if (num_images == 0) {
2457 imagex_error(T("--boot is meaningless on a WIM with no "
2459 ret = WIMLIB_ERR_INVALID_IMAGE;
2464 if (image == WIMLIB_ALL_IMAGES && num_images > 1) {
2466 imagex_error(T("Cannot specify the --boot flag "
2467 "without specifying a specific "
2468 "image in a multi-image WIM"));
2469 ret = WIMLIB_ERR_INVALID_IMAGE;
2473 imagex_error(T("Cannot specify the NEW_NAME "
2474 "without specifying a specific "
2475 "image in a multi-image WIM"));
2476 ret = WIMLIB_ERR_INVALID_IMAGE;
2481 /* Operations that print information are separated from operations that
2482 * recreate the WIM file. */
2483 if (!new_name && !boot) {
2485 /* Read-only operations */
2487 if (image == WIMLIB_NO_IMAGE) {
2488 imagex_error(T("\"%"TS"\" is not a valid image"),
2490 ret = WIMLIB_ERR_INVALID_IMAGE;
2494 if (image == WIMLIB_ALL_IMAGES && short_header)
2495 wimlib_print_wim_information(w);
2498 wimlib_print_header(w);
2501 if (total_parts != 1) {
2502 tprintf(T("Warning: Only showing the lookup table "
2503 "for part %d of a %d-part WIM.\n"),
2504 part_number, total_parts);
2506 wimlib_print_lookup_table(w);
2510 ret = wimlib_extract_xml_data(w, stdout);
2516 fp = tfopen(xml_out_file, T("wb"));
2518 imagex_error_with_errno(T("Failed to open the "
2519 "file \"%"TS"\" for "
2525 ret = wimlib_extract_xml_data(w, fp);
2526 if (fclose(fp) != 0) {
2527 imagex_error(T("Failed to close the file "
2538 wimlib_print_available_images(w, image);
2541 ret = wimlib_print_metadata(w, image);
2547 /* Modification operations */
2548 if (total_parts != 1) {
2549 imagex_error(T("Modifying a split WIM is not supported."));
2553 if (image == WIMLIB_ALL_IMAGES)
2556 if (image == WIMLIB_NO_IMAGE && new_name) {
2557 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
2558 "when using image 0"), new_name);
2564 if (image == wimlib_get_boot_idx(w)) {
2565 tprintf(T("Image %d is already marked as "
2566 "bootable.\n"), image);
2569 tprintf(T("Marking image %d as bootable.\n"),
2571 wimlib_set_boot_idx(w, image);
2575 if (!tstrcmp(wimlib_get_image_name(w, image), new_name))
2577 tprintf(T("Image %d is already named \"%"TS"\".\n"),
2581 tprintf(T("Changing the name of image %d to "
2582 "\"%"TS"\".\n"), image, new_name);
2583 ret = wimlib_set_image_name(w, image, new_name);
2589 const tchar *old_desc;
2590 old_desc = wimlib_get_image_description(w, image);
2591 if (old_desc && !tstrcmp(old_desc, new_desc)) {
2592 tprintf(T("The description of image %d is already "
2593 "\"%"TS"\".\n"), image, new_desc);
2596 tprintf(T("Changing the description of image %d "
2597 "to \"%"TS"\".\n"), image, new_desc);
2598 ret = wimlib_set_image_descripton(w, image,
2605 /* Only call wimlib_overwrite() if something actually needs to
2607 if (boot || new_name || new_desc ||
2608 (check && !wimlib_has_integrity_table(w)))
2612 ret = file_writable(wimfile);
2617 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2621 ret = wimlib_overwrite(w, write_flags, 1,
2622 imagex_progress_func);
2623 if (ret == WIMLIB_ERR_REOPEN)
2626 tprintf(T("The file \"%"TS"\" was not modified because nothing "
2627 "needed to be done.\n"), wimfile);
2636 /* Join split WIMs into one part WIM */
2638 imagex_join(int argc, tchar **argv)
2641 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2642 int wim_write_flags = 0;
2643 const tchar *output_path;
2645 for_opt(c, join_options) {
2647 case IMAGEX_CHECK_OPTION:
2648 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2649 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2659 imagex_error(T("Must specify one or more split WIM (.swm) "
2663 output_path = argv[0];
2664 return wimlib_join((const tchar * const *)++argv,
2669 imagex_progress_func);
2675 /* Mounts an image using a FUSE mount. */
2677 imagex_mount_rw_or_ro(int argc, tchar **argv)
2680 int mount_flags = 0;
2681 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2682 const tchar *wimfile;
2688 const tchar *swm_glob = NULL;
2689 WIMStruct **additional_swms = NULL;
2690 unsigned num_additional_swms = 0;
2691 const tchar *staging_dir = NULL;
2693 if (!tstrcmp(argv[0], T("mountrw")))
2694 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
2696 for_opt(c, mount_options) {
2698 case IMAGEX_ALLOW_OTHER_OPTION:
2699 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
2701 case IMAGEX_CHECK_OPTION:
2702 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2704 case IMAGEX_DEBUG_OPTION:
2705 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
2707 case IMAGEX_STREAMS_INTERFACE_OPTION:
2708 if (!tstrcasecmp(optarg, T("none")))
2709 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
2710 else if (!tstrcasecmp(optarg, T("xattr")))
2711 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
2712 else if (!tstrcasecmp(optarg, T("windows")))
2713 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
2715 imagex_error(T("Unknown stream interface \"%"TS"\""),
2720 case IMAGEX_REF_OPTION:
2723 case IMAGEX_STAGING_DIR_OPTION:
2724 staging_dir = optarg;
2726 case IMAGEX_UNIX_DATA_OPTION:
2727 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
2735 if (argc != 2 && argc != 3)
2740 ret = wimlib_open_wim(wimfile, open_flags, &w,
2741 imagex_progress_func);
2746 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
2748 &num_additional_swms);
2755 num_images = wimlib_get_num_images(w);
2756 if (num_images != 1) {
2757 imagex_error(T("\"%"TS"\" contains %d images; Please "
2758 "select one."), wimfile, num_images);
2759 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2766 image = wimlib_resolve_image(w, argv[1]);
2768 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
2773 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
2774 ret = file_writable(wimfile);
2779 ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms,
2780 num_additional_swms, staging_dir);
2782 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
2784 image, wimfile, dir);
2789 if (additional_swms) {
2790 for (unsigned i = 0; i < num_additional_swms; i++)
2791 wimlib_free(additional_swms[i]);
2792 free(additional_swms);
2796 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
2801 /* Rebuild a WIM file */
2803 imagex_optimize(int argc, tchar **argv)
2807 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
2810 const tchar *wimfile;
2813 unsigned num_threads = 0;
2815 for_opt(c, optimize_options) {
2817 case IMAGEX_CHECK_OPTION:
2818 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2819 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2821 case IMAGEX_RECOMPRESS_OPTION:
2822 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2824 case IMAGEX_THREADS_OPTION:
2825 num_threads = parse_num_threads(optarg);
2826 if (num_threads == UINT_MAX)
2844 ret = file_writable(wimfile);
2848 ret = wimlib_open_wim(wimfile, open_flags, &w,
2849 imagex_progress_func);
2853 old_size = file_get_size(argv[0]);
2854 tprintf(T("\"%"TS"\" original size: "), wimfile);
2856 tfputs(T("Unknown\n"), stdout);
2858 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
2860 ret = wimlib_overwrite(w, write_flags, num_threads,
2861 imagex_progress_func);
2864 new_size = file_get_size(argv[0]);
2865 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
2867 tfputs(T("Unknown\n"), stdout);
2869 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
2871 tfputs(T("Space saved: "), stdout);
2872 if (new_size != -1 && old_size != -1) {
2873 tprintf(T("%lld KiB\n"),
2874 ((long long)old_size - (long long)new_size) >> 10);
2876 tfputs(T("Unknown\n"), stdout);
2884 /* Split a WIM into a spanned set */
2886 imagex_split(int argc, tchar **argv)
2889 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
2890 int write_flags = 0;
2891 unsigned long part_size;
2896 for_opt(c, split_options) {
2898 case IMAGEX_CHECK_OPTION:
2899 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2900 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2914 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
2915 if (tmp == argv[2] || *tmp) {
2916 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
2917 imagex_error(T("The part size must be an integer or "
2918 "floating-point number of megabytes."));
2921 ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func);
2924 ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func);
2929 /* Unmounts a mounted WIM image. */
2931 imagex_unmount(int argc, tchar **argv)
2934 int unmount_flags = 0;
2937 for_opt(c, unmount_options) {
2939 case IMAGEX_COMMIT_OPTION:
2940 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
2942 case IMAGEX_CHECK_OPTION:
2943 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
2945 case IMAGEX_REBUILD_OPTION:
2946 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
2948 case IMAGEX_LAZY_OPTION:
2949 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
2963 ret = wimlib_unmount_image(argv[0], unmount_flags,
2964 imagex_progress_func);
2966 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
2971 * Add, delete, or rename files in a WIM image.
2974 imagex_update(int argc, tchar **argv)
2976 const tchar *wimfile;
2977 const tchar *image_num_or_name;
2982 int write_flags = 0;
2983 int update_flags = 0;
2984 int default_add_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
2985 int default_delete_flags = 0;
2986 unsigned num_threads = 0;
2988 tchar *cmd_file_contents;
2989 size_t cmd_file_nchars;
2990 struct wimlib_update_command *cmds;
2994 const tchar *config_file = NULL;
2996 struct wimlib_capture_config *config = NULL;
2998 for_opt(c, update_options) {
3000 /* Generic or write options */
3001 case IMAGEX_THREADS_OPTION:
3002 num_threads = parse_num_threads(optarg);
3003 if (num_threads == UINT_MAX) {
3008 case IMAGEX_CHECK_OPTION:
3009 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3010 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3012 case IMAGEX_REBUILD_OPTION:
3013 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3016 /* Default delete options */
3017 case IMAGEX_FORCE_OPTION:
3018 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3020 case IMAGEX_RECURSIVE_OPTION:
3021 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3024 /* Global add option */
3025 case IMAGEX_CONFIG_OPTION:
3026 config_file = optarg;
3029 /* Default add options */
3030 case IMAGEX_VERBOSE_OPTION:
3031 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
3033 case IMAGEX_DEREFERENCE_OPTION:
3034 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
3036 case IMAGEX_UNIX_DATA_OPTION:
3037 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
3039 case IMAGEX_NO_ACLS_OPTION:
3040 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
3042 case IMAGEX_STRICT_ACLS_OPTION:
3043 default_add_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
3052 if (argc < 1 || argc > 2)
3056 ret = file_writable(wimfile);
3060 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3065 image_num_or_name = argv[1];
3067 image_num_or_name = T("1");
3069 image = wimlib_resolve_image(wim, image_num_or_name);
3071 ret = verify_image_exists_and_is_single(image, image_num_or_name,
3074 goto out_wimlib_free;
3076 num_images = wimlib_get_num_images(wim);
3077 if (argc == 1 && num_images != 1) {
3078 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3079 wimfile, num_images);
3082 goto out_wimlib_free;
3085 /* Parse capture configuration file if specified */
3089 config_str = file_get_text_contents(config_file, &config_len);
3092 goto out_wimlib_free;
3095 config = alloca(sizeof(*config));
3096 ret = parse_capture_config(&config_str, config_len, config);
3098 goto out_free_config;
3100 config = &default_capture_config;
3103 /* Read update commands from standard input */
3104 if (isatty(STDIN_FILENO)) {
3105 tputs(T("Reading update commands from standard input..."));
3106 recommend_man_page(T("update"));
3108 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3109 if (!cmd_file_contents) {
3111 goto out_free_config;
3114 /* Parse the update commands */
3115 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3119 goto out_free_cmd_file_contents;
3122 /* Set default flags and capture config on the update commands */
3123 for (size_t i = 0; i < num_cmds; i++) {
3124 switch (cmds[i].op) {
3125 case WIMLIB_UPDATE_OP_ADD:
3126 cmds[i].add.add_flags |= default_add_flags;
3127 cmds[i].add.config = config;
3129 case WIMLIB_UPDATE_OP_DELETE:
3130 cmds[i].delete.delete_flags |= default_delete_flags;
3138 win32_acquire_capture_privileges();
3141 /* Execute the update commands */
3142 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3143 imagex_progress_func);
3145 goto out_release_privs;
3147 /* Overwrite the updated WIM */
3148 ret = wimlib_overwrite(wim, write_flags, num_threads,
3149 imagex_progress_func);
3152 win32_release_capture_privileges();
3156 out_free_cmd_file_contents:
3157 free(cmd_file_contents);
3159 if (config != NULL && config != &default_capture_config) {
3160 free(config->exclusion_pats.pats);
3161 free(config->exclusion_exception_pats.pats);
3174 struct imagex_command {
3176 int (*func)(int , tchar **);
3181 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
3182 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
3184 static const struct imagex_command imagex_commands[] = {
3185 {T("append"), imagex_capture_or_append, APPEND},
3186 {T("apply"), imagex_apply, APPLY},
3187 {T("capture"), imagex_capture_or_append, CAPTURE},
3188 {T("delete"), imagex_delete, DELETE},
3189 {T("dir"), imagex_dir, DIR},
3190 {T("export"), imagex_export, EXPORT},
3191 {T("extract"), imagex_extract, EXTRACT},
3192 {T("info"), imagex_info, INFO},
3193 {T("join"), imagex_join, JOIN},
3194 {T("mount"), imagex_mount_rw_or_ro, MOUNT},
3195 {T("mountrw"), imagex_mount_rw_or_ro, MOUNTRW},
3196 {T("optimize"),imagex_optimize, OPTIMIZE},
3197 {T("split"), imagex_split, SPLIT},
3198 {T("unmount"), imagex_unmount, UNMOUNT},
3199 {T("update"), imagex_update, UPDATE},
3205 static const tchar *s =
3207 IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
3208 "Copyright (C) 2012, 2013 Eric Biggers\n"
3209 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
3210 "This is free software: you are free to change and redistribute it.\n"
3211 "There is NO WARRANTY, to the extent permitted by law.\n"
3213 "Report bugs to "PACKAGE_BUGREPORT".\n"
3220 help_or_version(int argc, tchar **argv)
3224 const struct imagex_command *cmd;
3226 for (i = 1; i < argc; i++) {
3234 if (!tstrcmp(p, T("help"))) {
3235 for_imagex_command(cmd) {
3236 if (!tstrcmp(cmd->name, argv[1])) {
3244 if (!tstrcmp(p, T("version"))) {
3255 const struct imagex_command *cmd;
3256 tprintf(T("Usage:\n%"TS), usage_strings[cmd_type]);
3257 for_imagex_command(cmd) {
3258 if (cmd->cmd == cmd_type) {
3259 tputc(T('\n'), stdout);
3260 recommend_man_page(cmd->name);
3268 tfputs(T("Usage:\n"), stdout);
3269 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
3270 tprintf(T(" %"TS), usage_strings[i]);
3271 static const tchar *extra =
3273 " "IMAGEX_PROGNAME" --help\n"
3274 " "IMAGEX_PROGNAME" --version\n"
3276 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
3279 tfputs(extra, stdout);
3280 recommend_man_page(T(""));
3283 /* Entry point for wimlib's ImageX implementation. On UNIX the command
3284 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
3285 * something else), while an Windows the command arguments will be UTF-16LE
3286 * encoded 'wchar_t' strings. */
3289 wmain(int argc, wchar_t **argv, wchar_t **envp)
3291 main(int argc, char **argv)
3294 const struct imagex_command *cmd;
3299 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
3300 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
3304 setlocale(LC_ALL, "");
3305 codeset = nl_langinfo(CODESET);
3306 if (!strstr(codeset, "UTF-8") &&
3307 !strstr(codeset, "UTF8") &&
3308 !strstr(codeset, "utf-8") &&
3309 !strstr(codeset, "utf8"))
3312 "WARNING: Running "IMAGEX_PROGNAME" in a UTF-8 locale is recommended!\n"
3313 " Maybe try: `export LANG=en_US.UTF-8'?\n"
3314 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
3315 " to any value to force wimlib to use UTF-8.\n",
3320 #endif /* !__WIN32__ */
3323 imagex_error(T("No command specified"));
3329 /* Handle --help and --version for all commands. Note that this will
3330 * not return if either of these arguments are present. */
3331 help_or_version(argc, argv);
3335 /* The user may like to see more informative error messages. */
3336 wimlib_set_print_errors(true);
3338 /* Do any initializations that the library needs */
3339 ret = wimlib_global_init(init_flags);
3341 goto out_check_status;
3343 /* Search for the function to handle the ImageX subcommand. */
3344 for_imagex_command(cmd) {
3345 if (!tstrcmp(cmd->name, *argv)) {
3346 ret = cmd->func(argc, argv);
3347 goto out_check_write_error;
3351 imagex_error(T("Unrecognized command: `%"TS"'"), argv[0]);
3355 out_check_write_error:
3356 /* For 'wimlib-imagex info' and 'wimlib-imagex dir', data printed to
3357 * standard output is part of the program's actual behavior and not just
3358 * for informational purposes, so we should set a failure exit status if
3359 * there was a write error. */
3360 if (cmd == &imagex_commands[INFO] || cmd == &imagex_commands[DIR]) {
3361 if (ferror(stdout) || fclose(stdout)) {
3362 imagex_error_with_errno(T("error writing to standard output"));
3368 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
3369 * outside of the wimlib library code. 0 indicates success. > 0
3370 * indicates a wimlib error code from which an error message can be
3373 imagex_error(T("Exiting with error code %d:\n"
3375 wimlib_get_error_string(ret));
3376 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
3377 imagex_error_with_errno(T("errno"));
3380 /* Make the library free any resources it's holding (not strictly
3381 * necessary because the process is ending anyway). */
3382 wimlib_global_cleanup();