4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012, 2013, 2014 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 OS_PREFERRED_PATH_SEPARATOR L'\\'
52 # define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
53 # define print_security_descriptor win32_print_security_descriptor
56 # include <langinfo.h>
57 # define OS_PREFERRED_PATH_SEPARATOR '/'
58 # define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
59 # define print_security_descriptor default_print_security_descriptor
60 static inline void set_fd_to_binary_mode(int fd)
65 /* Don't confuse the user by presenting the mounting commands on Windows when
66 * they will never work. However on UNIX-like systems we always present them,
67 * even if WITH_FUSE is not defined at this point, as to not tie the build of
68 * wimlib-imagex to a specific build of wimlib. */
70 # define WIM_MOUNTING_SUPPORTED 0
72 # define WIM_MOUNTING_SUPPORTED 1
75 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
78 is_any_path_separator(tchar c)
80 return c == T('/') || c == T('\\');
83 /* Like basename(), but handles both forward and backwards slashes. */
85 tbasename(tchar *path)
87 tchar *p = tstrchr(path, T('\0'));
92 if (!is_any_path_separator(*--p))
100 if (is_any_path_separator(*--p))
105 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
119 #if WIM_MOUNTING_SUPPORTED
125 #if WIM_MOUNTING_SUPPORTED
132 static void usage(int cmd, FILE *fp);
133 static void usage_all(FILE *fp);
134 static void recommend_man_page(int cmd, FILE *fp);
135 static const tchar *get_cmd_string(int cmd, bool nospace);
137 static int imagex_progress_func(enum wimlib_progress_msg msg,
138 const union wimlib_progress_info *info);
140 static bool imagex_be_quiet = false;
141 static FILE *imagex_info_file;
143 #define imagex_printf(format, ...) \
144 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
147 IMAGEX_ALLOW_OTHER_OPTION,
150 IMAGEX_CHUNK_SIZE_OPTION,
151 IMAGEX_COMMAND_OPTION,
152 IMAGEX_COMMIT_OPTION,
153 IMAGEX_COMPRESS_OPTION,
154 IMAGEX_COMPRESS_SLOW_OPTION,
155 IMAGEX_CONFIG_OPTION,
157 IMAGEX_DELTA_FROM_OPTION,
158 IMAGEX_DEREFERENCE_OPTION,
159 IMAGEX_DEST_DIR_OPTION,
160 IMAGEX_DETAILED_OPTION,
161 IMAGEX_EXTRACT_XML_OPTION,
164 IMAGEX_HARDLINK_OPTION,
165 IMAGEX_HEADER_OPTION,
166 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
168 IMAGEX_LOOKUP_TABLE_OPTION,
169 IMAGEX_METADATA_OPTION,
170 IMAGEX_NEW_IMAGE_OPTION,
171 IMAGEX_NOCHECK_OPTION,
172 IMAGEX_NORPFIX_OPTION,
173 IMAGEX_NOT_PIPABLE_OPTION,
174 IMAGEX_NO_ACLS_OPTION,
175 IMAGEX_NO_ATTRIBUTES_OPTION,
176 IMAGEX_NO_REPLACE_OPTION,
177 IMAGEX_NO_WILDCARDS_OPTION,
178 IMAGEX_NULLGLOB_OPTION,
179 IMAGEX_ONE_FILE_ONLY_OPTION,
180 IMAGEX_PACK_CHUNK_SIZE_OPTION,
181 IMAGEX_PACK_COMPRESS_OPTION,
182 IMAGEX_PACK_STREAMS_OPTION,
184 IMAGEX_PIPABLE_OPTION,
185 IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION,
186 IMAGEX_REBUILD_OPTION,
187 IMAGEX_RECOMPRESS_OPTION,
188 IMAGEX_RECURSIVE_OPTION,
190 IMAGEX_RESUME_OPTION,
193 IMAGEX_SOURCE_LIST_OPTION,
194 IMAGEX_STAGING_DIR_OPTION,
195 IMAGEX_STREAMS_INTERFACE_OPTION,
196 IMAGEX_STRICT_ACLS_OPTION,
197 IMAGEX_SYMLINK_OPTION,
198 IMAGEX_THREADS_OPTION,
199 IMAGEX_TO_STDOUT_OPTION,
200 IMAGEX_UNIX_DATA_OPTION,
201 IMAGEX_UPDATE_OF_OPTION,
202 IMAGEX_VERBOSE_OPTION,
203 IMAGEX_WIMBOOT_OPTION,
207 static const struct option apply_options[] = {
208 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
209 {T("hardlink"), no_argument, NULL, IMAGEX_HARDLINK_OPTION},
210 {T("symlink"), no_argument, NULL, IMAGEX_SYMLINK_OPTION},
211 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
212 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
213 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
214 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
215 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
216 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
217 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
218 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
219 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
220 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
222 /* --resume is undocumented for now as it needs improvement. */
223 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
224 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
228 static const struct option capture_or_append_options[] = {
229 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
230 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
231 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
232 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
233 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
234 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
235 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
236 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
237 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
238 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
239 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
240 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
241 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
242 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
243 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
244 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
245 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
246 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
247 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
248 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
249 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
250 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
251 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
252 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
253 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
254 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
255 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
256 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
257 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
258 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
259 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
263 static const struct option delete_options[] = {
264 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
265 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
269 static const struct option dir_options[] = {
270 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
271 {T("detailed"), no_argument, NULL, IMAGEX_DETAILED_OPTION},
272 {T("one-file-only"), no_argument, NULL, IMAGEX_ONE_FILE_ONLY_OPTION},
276 static const struct option export_options[] = {
277 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
278 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
279 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
280 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
281 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
282 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
283 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
284 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
285 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
286 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
287 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
288 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
289 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
290 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
291 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
292 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
293 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
294 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
298 static const struct option extract_options[] = {
299 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
300 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
301 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
302 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
303 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
304 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
305 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
306 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
307 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
308 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
309 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
310 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_WILDCARDS_OPTION},
311 {T("nullglob"), no_argument, NULL, IMAGEX_NULLGLOB_OPTION},
312 {T("preserve-dir-structure"), no_argument, NULL, IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION},
313 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
317 static const struct option info_options[] = {
318 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
319 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
320 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
321 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
322 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
323 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
324 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
325 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
326 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
330 static const struct option join_options[] = {
331 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
335 static const struct option mount_options[] = {
336 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
337 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
338 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
339 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
340 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
341 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
342 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
346 static const struct option optimize_options[] = {
347 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
348 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
349 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
350 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
351 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
352 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
353 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
354 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
355 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
356 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
357 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
358 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
359 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
360 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
361 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
362 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
363 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
367 static const struct option split_options[] = {
368 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
372 static const struct option unmount_options[] = {
373 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
374 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
375 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
376 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
377 {T("new-image"), no_argument, NULL, IMAGEX_NEW_IMAGE_OPTION},
381 static const struct option update_options[] = {
382 /* Careful: some of the options here set the defaults for update
383 * commands, but the flags given to an actual update command (and not to
384 * `imagex update' itself are also handled in
385 * update_command_add_option(). */
386 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
387 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
388 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
389 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
391 /* Default delete options */
392 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
393 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
395 /* Global add option */
396 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
398 /* Default add options */
399 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
400 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
401 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
402 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
403 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
404 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
405 {T("no-replace"), no_argument, NULL, IMAGEX_NO_REPLACE_OPTION},
411 # define _format_attribute(type, format_str, args_start) \
412 __attribute__((format(type, format_str, args_start)))
414 # define _format_attribute(type, format_str, args_start)
417 /* Print formatted error message to stderr. */
418 static void _format_attribute(printf, 1, 2)
419 imagex_error(const tchar *format, ...)
422 va_start(va, format);
423 tfputs(T("ERROR: "), stderr);
424 tvfprintf(stderr, format, va);
425 tputc(T('\n'), stderr);
429 /* Print formatted error message to stderr. */
430 static void _format_attribute(printf, 1, 2)
431 imagex_error_with_errno(const tchar *format, ...)
433 int errno_save = errno;
435 va_start(va, format);
436 tfputs(T("ERROR: "), stderr);
437 tvfprintf(stderr, format, va);
438 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
443 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
445 if (image == WIMLIB_NO_IMAGE) {
446 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
447 " Please specify a 1-based image index or "
448 "image name. To list the images\n"
449 " contained in the WIM archive, run\n"
451 " %"TS" \"%"TS"\"\n"),
452 image_name, wim_name,
453 get_cmd_string(CMD_INFO, false), wim_name);
454 return WIMLIB_ERR_INVALID_IMAGE;
460 verify_image_is_single(int image)
462 if (image == WIMLIB_ALL_IMAGES) {
463 imagex_error(T("Cannot specify all images for this action!"));
464 return WIMLIB_ERR_INVALID_IMAGE;
470 verify_image_exists_and_is_single(int image, const tchar *image_name,
471 const tchar *wim_name)
474 ret = verify_image_exists(image, image_name, wim_name);
476 ret = verify_image_is_single(image);
480 /* Parse the argument to --compress */
482 get_compression_type(const tchar *optarg)
484 if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
485 return WIMLIB_COMPRESSION_TYPE_LZX;
486 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
487 return WIMLIB_COMPRESSION_TYPE_XPRESS;
488 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
489 return WIMLIB_COMPRESSION_TYPE_LZMS;
490 else if (!tstrcasecmp(optarg, T("none")))
491 return WIMLIB_COMPRESSION_TYPE_NONE;
493 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
494 "\"maximum\", \"fast\", or \"none\"."), optarg);
495 return WIMLIB_COMPRESSION_TYPE_INVALID;
500 set_compress_slow(void)
502 static const struct wimlib_lzx_compressor_params lzx_slow_params = {
504 .size = sizeof(struct wimlib_lzx_compressor_params),
506 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
509 .use_len2_matches = 1,
510 .nice_match_length = 96,
511 .num_optim_passes = 4,
512 .max_search_depth = 100,
513 .max_matches_per_pos = 10,
514 .main_nostat_cost = 15,
515 .len_nostat_cost = 15,
516 .aligned_nostat_cost = 7,
521 static const struct wimlib_lzms_compressor_params lzms_slow_params = {
523 .size = sizeof(struct wimlib_lzms_compressor_params),
525 .min_match_length = 2,
526 .max_match_length = UINT32_MAX,
527 .nice_match_length = 96,
528 .max_search_depth = 100,
529 .max_matches_per_pos = 10,
530 .optim_array_length = 1024,
533 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
534 &lzx_slow_params.hdr);
536 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZMS,
537 &lzms_slow_params.hdr);
541 const tchar **strings;
542 unsigned num_strings;
543 unsigned num_alloc_strings;
546 #define STRING_SET_INITIALIZER \
547 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
549 #define STRING_SET(_strings) \
550 struct string_set _strings = STRING_SET_INITIALIZER
553 string_set_append(struct string_set *set, const tchar *glob)
555 unsigned num_alloc_strings = set->num_alloc_strings;
557 if (set->num_strings == num_alloc_strings) {
558 const tchar **new_strings;
560 num_alloc_strings += 4;
561 new_strings = realloc(set->strings,
562 sizeof(set->strings[0]) * num_alloc_strings);
564 imagex_error(T("Out of memory!"));
567 set->strings = new_strings;
568 set->num_alloc_strings = num_alloc_strings;
570 set->strings[set->num_strings++] = glob;
575 string_set_destroy(struct string_set *set)
581 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
583 return wimlib_reference_resource_files(wim, set->strings,
585 WIMLIB_REF_FLAG_GLOB_ENABLE,
587 imagex_progress_func);
591 do_resource_not_found_warning(const tchar *wimfile,
592 const struct wimlib_wim_info *info,
593 const struct string_set *refglobs)
595 if (info->total_parts > 1) {
596 if (refglobs->num_strings == 0) {
597 imagex_error(T("\"%"TS"\" is part of a split WIM. "
598 "Use --ref to specify the other parts."),
601 imagex_error(T("Perhaps the '--ref' argument did not "
602 "specify all other parts of the split "
606 imagex_error(T("If this is a delta WIM, use the --ref argument "
607 "to specify the WIM(s) on which it is based."));
611 /* Returns the size of a file given its name, or -1 if the file does not exist
612 * or its size cannot be determined. */
614 file_get_size(const tchar *filename)
617 if (tstat(filename, &st) == 0)
624 PARSE_STRING_SUCCESS = 0,
625 PARSE_STRING_FAILURE = 1,
626 PARSE_STRING_NONE = 2,
630 * Parses a string token from an array of characters.
632 * Tokens are either whitespace-delimited, or double or single-quoted.
634 * @line_p: Pointer to the pointer to the line of data. Will be updated
635 * to point past the string token iff the return value is
636 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
639 * @len_p: @len_p initially stores the length of the line of data, which may
640 * be 0, and it will be updated to the number of bytes remaining in
641 * the line iff the return value is PARSE_STRING_SUCCESS.
643 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
644 * parsed string token will be returned here.
646 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
647 * PARSE_STRING_FAILURE if the data was invalid due to a missing
648 * closing quote; or PARSE_STRING_NONE if the line ended before the
649 * beginning of a string token was found.
652 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
655 tchar *line = *line_p;
659 /* Skip leading whitespace */
662 return PARSE_STRING_NONE;
663 if (!istspace(*line) && *line != T('\0'))
669 if (quote_char == T('"') || quote_char == T('\'')) {
674 line = tmemchr(line, quote_char, len);
676 imagex_error(T("Missing closing quote: %"TS), fn - 1);
677 return PARSE_STRING_FAILURE;
680 /* Unquoted string. Go until whitespace. Line is terminated
681 * by '\0', so no need to check 'len'. */
685 } while (!istspace(*line) && *line != T('\0'));
692 return PARSE_STRING_SUCCESS;
695 /* Parses a line of data (not an empty line or comment) in the source list file
696 * format. (See the man page for 'wimlib-imagex capture' for details on this
697 * format and the meaning.)
699 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
700 * len == 0. The data in @line will be modified by this function call.
702 * @len: Length of the line of data.
704 * @source: On success, the capture source and target described by the line is
705 * written into this destination. Note that it will contain pointers
706 * to data in the @line array.
708 * Returns true if the line was valid; false otherwise. */
710 parse_source_list_line(tchar *line, size_t len,
711 struct wimlib_capture_source *source)
715 ret = parse_string(&line, &len, &source->fs_source_path);
716 if (ret != PARSE_STRING_SUCCESS)
718 ret = parse_string(&line, &len, &source->wim_target_path);
719 if (ret == PARSE_STRING_NONE)
720 source->wim_target_path = source->fs_source_path;
721 return ret != PARSE_STRING_FAILURE;
724 /* Returns %true if the given line of length @len > 0 is a comment or empty line
725 * in the source list file format. */
727 is_comment_line(const tchar *line, size_t len)
730 if (*line == T('#') || *line == T(';'))
732 if (!istspace(*line) && *line != T('\0'))
742 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
745 tchar *contents = *contents_p;
746 size_t nchars = *nchars_p;
749 for (i = 0; i < nchars; i++)
750 if (contents[i] == T('\n'))
753 /* Handle last line not terminated by a newline */
754 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
755 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
757 imagex_error(T("Out of memory!"));
760 contents[nchars] = T('\n');
761 *contents_p = contents;
769 /* Parses a file in the source list format. (See the man page for
770 * 'wimlib-imagex capture' for details on this format and the meaning.)
772 * @source_list_contents: Contents of the source list file. Note that this
773 * buffer will be modified to save memory allocations,
774 * and cannot be freed until the returned array of
775 * wimlib_capture_source's has also been freed.
777 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
780 * @nsources_ret: On success, the length of the returned array is
783 * Returns: An array of `struct wimlib_capture_source's that can be passed to
784 * the wimlib_add_image_multisource() function to specify how a WIM image is to
786 static struct wimlib_capture_source *
787 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
788 size_t *nsources_ret)
792 struct wimlib_capture_source *sources;
795 nlines = text_file_count_lines(source_list_contents_p,
796 &source_list_nchars);
800 /* Always allocate at least 1 slot, just in case the implementation of
801 * calloc() returns NULL if 0 bytes are requested. */
802 sources = calloc(nlines ?: 1, sizeof(*sources));
804 imagex_error(T("out of memory"));
807 p = *source_list_contents_p;
809 for (i = 0; i < nlines; i++) {
810 /* XXX: Could use rawmemchr() here instead, but it may not be
811 * available on all platforms. */
812 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
813 size_t len = endp - p + 1;
815 if (!is_comment_line(p, len)) {
816 if (!parse_source_list_line(p, len, &sources[j++])) {
828 /* Reads the contents of a file into memory. */
830 file_get_contents(const tchar *filename, size_t *len_ret)
837 if (tstat(filename, &stbuf) != 0) {
838 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
843 fp = tfopen(filename, T("rb"));
845 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
849 buf = malloc(len ? len : 1);
851 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
852 "contents of file \"%"TS"\""), len, filename);
855 if (fread(buf, 1, len, fp) != len) {
856 imagex_error_with_errno(T("Failed to read %zu bytes from the "
857 "file \"%"TS"\""), len, filename);
871 /* Read standard input until EOF and return the full contents in a malloc()ed
872 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
875 stdin_get_contents(size_t *len_ret)
877 /* stdin can, of course, be a pipe or other non-seekable file, so the
878 * total length of the data cannot be pre-determined */
880 size_t newlen = 1024;
884 char *p = realloc(buf, newlen);
885 size_t bytes_read, bytes_to_read;
887 imagex_error(T("out of memory while reading stdin"));
891 bytes_to_read = newlen - pos;
892 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
894 if (bytes_read != bytes_to_read) {
899 imagex_error_with_errno(T("error reading stdin"));
913 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
916 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
918 *num_tchars_ret = num_bytes;
920 #else /* !__WIN32__ */
921 /* On Windows, translate the text to UTF-16LE */
925 if (num_bytes >= 2 &&
926 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
927 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
929 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
930 * with something that looks like an ASCII character encoded as
931 * a UTF-16LE code unit. Assume the file is encoded as
932 * UTF-16LE. This is not a 100% reliable check. */
933 num_wchars = num_bytes / 2;
934 text_wstr = (wchar_t*)text;
936 /* File does not look like UTF-16LE. Assume it is encoded in
937 * the current Windows code page. I think these are always
938 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
939 * should work as expected. */
940 text_wstr = win32_mbs_to_wcs(text,
945 *num_tchars_ret = num_wchars;
947 #endif /* __WIN32__ */
951 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
956 contents = file_get_contents(filename, &num_bytes);
959 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
963 stdin_get_text_contents(size_t *num_tchars_ret)
968 contents = stdin_get_contents(&num_bytes);
971 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
974 #define TO_PERCENT(numerator, denominator) \
975 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
977 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
978 #define MEBIBYTE_MIN_NBYTES 10000000ULL
979 #define KIBIBYTE_MIN_NBYTES 10000ULL
982 get_unit(uint64_t total_bytes, const tchar **name_ret)
984 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
985 *name_ret = T("GiB");
987 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
988 *name_ret = T("MiB");
990 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
991 *name_ret = T("KiB");
994 *name_ret = T("bytes");
999 static struct wimlib_progress_info_scan last_scan_progress;
1002 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1004 uint64_t prev_count, cur_count;
1006 prev_count = last_scan_progress.num_nondirs_scanned +
1007 last_scan_progress.num_dirs_scanned;
1008 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1010 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1011 cur_count % 128 == 0)
1013 unsigned unit_shift;
1014 const tchar *unit_name;
1016 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1017 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1018 "%"PRIu64" directories) "),
1019 scan->num_bytes_scanned >> unit_shift,
1021 scan->num_nondirs_scanned,
1022 scan->num_dirs_scanned);
1023 last_scan_progress = *scan;
1027 /* Progress callback function passed to various wimlib functions. */
1029 imagex_progress_func(enum wimlib_progress_msg msg,
1030 const union wimlib_progress_info *info)
1032 unsigned percent_done;
1033 unsigned unit_shift;
1034 const tchar *unit_name;
1036 if (imagex_be_quiet)
1039 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1041 static bool first = true;
1043 imagex_printf(T("Writing %"TS"-compressed data "
1044 "using %u thread%"TS"\n"),
1045 wimlib_get_compression_type_string(
1046 info->write_streams.compression_type),
1047 info->write_streams.num_threads,
1048 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1052 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1053 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1054 info->write_streams.total_bytes);
1056 if (info->write_streams.total_parts <= 1) {
1057 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1058 "written (%u%% done)"),
1059 info->write_streams.completed_bytes >> unit_shift,
1061 info->write_streams.total_bytes >> unit_shift,
1065 imagex_printf(T("\rWriting resources from part %u of %u: "
1066 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1067 (info->write_streams.completed_parts ==
1068 info->write_streams.total_parts) ?
1069 info->write_streams.completed_parts :
1070 info->write_streams.completed_parts + 1,
1071 info->write_streams.total_parts,
1072 info->write_streams.completed_bytes >> unit_shift,
1074 info->write_streams.total_bytes >> unit_shift,
1078 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1079 imagex_printf(T("\n"));
1081 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1082 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1083 if (*info->scan.wim_target_path) {
1084 imagex_printf(T(" (loading as WIM path: "
1085 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1086 info->scan.wim_target_path);
1088 imagex_printf(T("\n"));
1090 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1092 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1093 switch (info->scan.status) {
1094 case WIMLIB_SCAN_DENTRY_OK:
1095 report_scan_progress(&info->scan, false);
1097 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1098 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1100 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1101 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1102 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1104 case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK:
1105 imagex_printf(T("\nWARNING: Ignoring absolute symbolic link "
1106 "with out-of-tree target:\n"
1107 " \"%"TS"\" => \"%"TS"\"\n"
1108 " (Use --norpfix to capture "
1109 "absolute symbolic links as-is)\n"),
1110 info->scan.cur_path, info->scan.symlink_target);
1114 case WIMLIB_PROGRESS_MSG_SCAN_END:
1115 report_scan_progress(&info->scan, true);
1116 imagex_printf(T("\n"));
1118 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1119 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1120 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1121 info->integrity.total_bytes);
1122 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1123 "of %"PRIu64" %"TS" (%u%%) done"),
1124 info->integrity.filename,
1125 info->integrity.completed_bytes >> unit_shift,
1127 info->integrity.total_bytes >> unit_shift,
1130 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1131 imagex_printf(T("\n"));
1133 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1134 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1135 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1136 info->integrity.total_bytes);
1137 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1138 "of %"PRIu64" %"TS" (%u%%) done"),
1139 info->integrity.completed_bytes >> unit_shift,
1141 info->integrity.total_bytes >> unit_shift,
1144 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1145 imagex_printf(T("\n"));
1147 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1148 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1149 "to %"TS" \"%"TS"\"\n"),
1150 info->extract.image,
1151 info->extract.image_name,
1152 info->extract.wimfile_name,
1153 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1154 T("NTFS volume") : T("directory")),
1155 info->extract.target);
1157 case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1158 if (info->extract.extract_root_wim_source_path[0]) {
1159 imagex_printf(T("Extracting \"%"TS"\" from image %d "
1160 "(\"%"TS"\") in \"%"TS"\" to \"%"TS"\"\n"),
1161 info->extract.extract_root_wim_source_path,
1162 info->extract.image,
1163 info->extract.image_name,
1164 info->extract.wimfile_name,
1165 info->extract.target);
1168 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1169 percent_done = TO_PERCENT(info->extract.completed_bytes,
1170 info->extract.total_bytes);
1171 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1172 imagex_printf(T("\rExtracting files: "
1173 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1174 info->extract.completed_bytes >> unit_shift,
1176 info->extract.total_bytes >> unit_shift,
1179 if (info->extract.completed_bytes >= info->extract.total_bytes)
1180 imagex_printf(T("\n"));
1182 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1183 if (info->extract.total_parts != 1) {
1184 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1185 info->extract.part_number,
1186 info->extract.total_parts);
1189 case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1190 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1191 imagex_printf(T("Setting timestamps on all extracted files...\n"));
1193 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1194 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1195 imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1196 info->extract.target);
1199 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1200 percent_done = TO_PERCENT(info->split.completed_bytes,
1201 info->split.total_bytes);
1202 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1203 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1204 "%"PRIu64" %"TS" (%u%%) written\n"),
1205 info->split.part_name,
1206 info->split.cur_part_number,
1207 info->split.total_parts,
1208 info->split.completed_bytes >> unit_shift,
1210 info->split.total_bytes >> unit_shift,
1214 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1215 if (info->split.completed_bytes == info->split.total_bytes) {
1216 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1217 info->split.cur_part_number,
1218 info->split.total_parts);
1221 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1222 switch (info->update.command->op) {
1223 case WIMLIB_UPDATE_OP_DELETE:
1224 imagex_printf(T("Deleted WIM path "
1225 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1226 info->update.command->delete_.wim_path);
1228 case WIMLIB_UPDATE_OP_RENAME:
1229 imagex_printf(T("Renamed WIM path "
1230 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1231 "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1232 info->update.command->rename.wim_source_path,
1233 info->update.command->rename.wim_target_path);
1235 case WIMLIB_UPDATE_OP_ADD:
1240 case WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM:
1241 imagex_printf(T("Updating \"%"TS"\" in WIM image\n"),
1242 info->replace.path_in_wim);
1247 fflush(imagex_info_file);
1252 parse_num_threads(const tchar *optarg)
1255 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1256 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1257 imagex_error(T("Number of threads must be a non-negative integer!"));
1264 static uint32_t parse_chunk_size(const tchar *optarg)
1267 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1268 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1269 imagex_error(T("Chunk size must be a non-negative integer!"));
1278 * Parse an option passed to an update command.
1280 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1283 * @option: Text string for the option (beginning with --)
1285 * @cmd: `struct wimlib_update_command' that is being constructed for
1288 * Returns true if the option was recognized; false if not.
1291 update_command_add_option(int op, const tchar *option,
1292 struct wimlib_update_command *cmd)
1294 bool recognized = true;
1296 case WIMLIB_UPDATE_OP_ADD:
1297 if (!tstrcmp(option, T("--verbose")))
1298 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1299 else if (!tstrcmp(option, T("--unix-data")))
1300 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1301 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1302 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1303 else if (!tstrcmp(option, T("--strict-acls")))
1304 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1305 else if (!tstrcmp(option, T("--dereference")))
1306 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1307 else if (!tstrcmp(option, T("--no-replace")))
1308 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
1312 case WIMLIB_UPDATE_OP_DELETE:
1313 if (!tstrcmp(option, T("--force")))
1314 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1315 else if (!tstrcmp(option, T("--recursive")))
1316 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1327 /* How many nonoption arguments each `imagex update' command expects */
1328 static const unsigned update_command_num_nonoptions[] = {
1329 [WIMLIB_UPDATE_OP_ADD] = 2,
1330 [WIMLIB_UPDATE_OP_DELETE] = 1,
1331 [WIMLIB_UPDATE_OP_RENAME] = 2,
1335 update_command_add_nonoption(int op, const tchar *nonoption,
1336 struct wimlib_update_command *cmd,
1337 unsigned num_nonoptions)
1340 case WIMLIB_UPDATE_OP_ADD:
1341 if (num_nonoptions == 0)
1342 cmd->add.fs_source_path = (tchar*)nonoption;
1344 cmd->add.wim_target_path = (tchar*)nonoption;
1346 case WIMLIB_UPDATE_OP_DELETE:
1347 cmd->delete_.wim_path = (tchar*)nonoption;
1349 case WIMLIB_UPDATE_OP_RENAME:
1350 if (num_nonoptions == 0)
1351 cmd->rename.wim_source_path = (tchar*)nonoption;
1353 cmd->rename.wim_target_path = (tchar*)nonoption;
1359 * Parse a command passed on stdin to `imagex update'.
1361 * @line: Text of the command.
1362 * @len: Length of the line, including a null terminator
1365 * @command: A `struct wimlib_update_command' to fill in from the parsed
1368 * @line_number: Line number of the command, for diagnostics.
1370 * Returns true on success; returns false on parse error.
1373 parse_update_command(tchar *line, size_t len,
1374 struct wimlib_update_command *command,
1378 tchar *command_name;
1380 size_t num_nonoptions;
1382 /* Get the command name ("add", "delete", "rename") */
1383 ret = parse_string(&line, &len, &command_name);
1384 if (ret != PARSE_STRING_SUCCESS)
1387 if (!tstrcasecmp(command_name, T("add"))) {
1388 op = WIMLIB_UPDATE_OP_ADD;
1389 } else if (!tstrcasecmp(command_name, T("delete"))) {
1390 op = WIMLIB_UPDATE_OP_DELETE;
1391 } else if (!tstrcasecmp(command_name, T("rename"))) {
1392 op = WIMLIB_UPDATE_OP_RENAME;
1394 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1395 command_name, line_number);
1400 /* Parse additional options and non-options as needed */
1405 ret = parse_string(&line, &len, &next_string);
1406 if (ret == PARSE_STRING_NONE) /* End of line */
1408 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1410 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1412 if (!update_command_add_option(op, next_string, command))
1414 imagex_error(T("Unrecognized option \"%"TS"\" to "
1415 "update command \"%"TS"\" on line %zu"),
1416 next_string, command_name, line_number);
1422 if (num_nonoptions == update_command_num_nonoptions[op])
1424 imagex_error(T("Unexpected argument \"%"TS"\" in "
1425 "update command on line %zu\n"
1426 " (The \"%"TS"\" command only "
1427 "takes %zu nonoption arguments!)\n"),
1428 next_string, line_number,
1429 command_name, num_nonoptions);
1432 update_command_add_nonoption(op, next_string,
1433 command, num_nonoptions);
1438 if (num_nonoptions != update_command_num_nonoptions[op]) {
1439 imagex_error(T("Not enough arguments to update command "
1440 "\"%"TS"\" on line %zu"), command_name, line_number);
1446 static struct wimlib_update_command *
1447 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1448 size_t *num_cmds_ret)
1452 struct wimlib_update_command *cmds;
1455 nlines = text_file_count_lines(cmd_file_contents_p,
1460 /* Always allocate at least 1 slot, just in case the implementation of
1461 * calloc() returns NULL if 0 bytes are requested. */
1462 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1464 imagex_error(T("out of memory"));
1467 p = *cmd_file_contents_p;
1469 for (i = 0; i < nlines; i++) {
1470 /* XXX: Could use rawmemchr() here instead, but it may not be
1471 * available on all platforms. */
1472 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1473 size_t len = endp - p + 1;
1475 if (!is_comment_line(p, len)) {
1476 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1487 /* Apply one image, or all images, from a WIM file to a directory, OR apply
1488 * one image from a WIM file to a NTFS volume. */
1490 imagex_apply(int argc, tchar **argv, int cmd)
1494 int image = WIMLIB_NO_IMAGE;
1496 struct wimlib_wim_info info;
1498 const tchar *wimfile;
1499 const tchar *target;
1500 const tchar *image_num_or_name = NULL;
1501 int extract_flags = 0;
1503 STRING_SET(refglobs);
1505 for_opt(c, apply_options) {
1507 case IMAGEX_CHECK_OPTION:
1508 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1510 case IMAGEX_HARDLINK_OPTION:
1511 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1513 case IMAGEX_SYMLINK_OPTION:
1514 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1516 case IMAGEX_VERBOSE_OPTION:
1517 /* No longer does anything. */
1519 case IMAGEX_REF_OPTION:
1520 ret = string_set_append(&refglobs, optarg);
1522 goto out_free_refglobs;
1524 case IMAGEX_UNIX_DATA_OPTION:
1525 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1527 case IMAGEX_NO_ACLS_OPTION:
1528 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1530 case IMAGEX_STRICT_ACLS_OPTION:
1531 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1533 case IMAGEX_NO_ATTRIBUTES_OPTION:
1534 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
1536 case IMAGEX_NORPFIX_OPTION:
1537 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1539 case IMAGEX_RPFIX_OPTION:
1540 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1542 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1543 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1544 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1546 case IMAGEX_RESUME_OPTION:
1547 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1549 case IMAGEX_WIMBOOT_OPTION:
1550 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
1558 if (argc != 2 && argc != 3)
1563 if (!tstrcmp(wimfile, T("-"))) {
1564 /* Attempt to apply pipable WIM from standard input. */
1566 image_num_or_name = NULL;
1569 image_num_or_name = argv[1];
1574 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1575 imagex_progress_func);
1577 goto out_free_refglobs;
1579 wimlib_get_wim_info(wim, &info);
1582 /* Image explicitly specified. */
1583 image_num_or_name = argv[1];
1584 image = wimlib_resolve_image(wim, image_num_or_name);
1585 ret = verify_image_exists(image, image_num_or_name, wimfile);
1587 goto out_wimlib_free;
1590 /* No image specified; default to image 1, but only if the WIM
1591 * contains exactly one image. */
1593 if (info.image_count != 1) {
1594 imagex_error(T("\"%"TS"\" contains %d images; "
1595 "Please select one (or all)."),
1596 wimfile, info.image_count);
1605 if (refglobs.num_strings) {
1607 imagex_error(T("Can't specify --ref when applying from stdin!"));
1609 goto out_wimlib_free;
1611 ret = wim_reference_globs(wim, &refglobs, open_flags);
1613 goto out_wimlib_free;
1618 /* Interpret a regular file or block device target as a NTFS
1622 if (tstat(target, &stbuf)) {
1623 if (errno != ENOENT) {
1624 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1627 goto out_wimlib_free;
1630 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1631 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1637 ret = wimlib_extract_image(wim, image, target, extract_flags,
1638 imagex_progress_func);
1640 set_fd_to_binary_mode(STDIN_FILENO);
1641 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1643 target, extract_flags,
1644 imagex_progress_func);
1647 imagex_printf(T("Done applying WIM image.\n"));
1648 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1650 do_resource_not_found_warning(wimfile, &info, &refglobs);
1652 imagex_error(T( "If you are applying an image "
1653 "from a split pipable WIM,\n"
1654 " make sure you have "
1655 "concatenated together all parts."));
1661 string_set_destroy(&refglobs);
1665 usage(CMD_APPLY, stderr);
1667 goto out_free_refglobs;
1670 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1671 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1672 * the desired image. 'wimlib-imagex append': add a new image to an existing
1675 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1678 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1679 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1680 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1681 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1682 int write_flags = 0;
1683 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1684 uint32_t chunk_size = UINT32_MAX;
1685 uint32_t pack_chunk_size = UINT32_MAX;
1686 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
1687 const tchar *wimfile;
1691 const tchar *flags_element = NULL;
1694 STRING_SET(base_wimfiles);
1695 WIMStruct **base_wims;
1697 WIMStruct *template_wim;
1698 const tchar *template_wimfile = NULL;
1699 const tchar *template_image_name_or_num = NULL;
1700 int template_image = WIMLIB_NO_IMAGE;
1703 unsigned num_threads = 0;
1708 tchar *config_file = NULL;
1710 bool source_list = false;
1711 size_t source_list_nchars = 0;
1712 tchar *source_list_contents;
1713 bool capture_sources_malloced;
1714 struct wimlib_capture_source *capture_sources;
1716 bool name_defaulted;
1717 bool compress_slow = false;
1719 for_opt(c, capture_or_append_options) {
1721 case IMAGEX_BOOT_OPTION:
1722 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1724 case IMAGEX_CHECK_OPTION:
1725 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1726 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1728 case IMAGEX_NOCHECK_OPTION:
1729 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1731 case IMAGEX_CONFIG_OPTION:
1732 config_file = optarg;
1733 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1735 case IMAGEX_COMPRESS_OPTION:
1736 compression_type = get_compression_type(optarg);
1737 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1740 case IMAGEX_COMPRESS_SLOW_OPTION:
1741 compress_slow = true;
1743 case IMAGEX_CHUNK_SIZE_OPTION:
1744 chunk_size = parse_chunk_size(optarg);
1745 if (chunk_size == UINT32_MAX)
1748 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
1749 pack_chunk_size = parse_chunk_size(optarg);
1750 if (pack_chunk_size == UINT32_MAX)
1753 case IMAGEX_PACK_COMPRESS_OPTION:
1754 pack_ctype = get_compression_type(optarg);
1755 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
1758 case IMAGEX_PACK_STREAMS_OPTION:
1759 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1761 case IMAGEX_FLAGS_OPTION:
1762 flags_element = optarg;
1764 case IMAGEX_DEREFERENCE_OPTION:
1765 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1767 case IMAGEX_VERBOSE_OPTION:
1768 /* No longer does anything. */
1770 case IMAGEX_THREADS_OPTION:
1771 num_threads = parse_num_threads(optarg);
1772 if (num_threads == UINT_MAX)
1775 case IMAGEX_REBUILD_OPTION:
1776 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1778 case IMAGEX_UNIX_DATA_OPTION:
1779 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1781 case IMAGEX_SOURCE_LIST_OPTION:
1784 case IMAGEX_NO_ACLS_OPTION:
1785 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1787 case IMAGEX_STRICT_ACLS_OPTION:
1788 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1790 case IMAGEX_RPFIX_OPTION:
1791 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1793 case IMAGEX_NORPFIX_OPTION:
1794 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1796 case IMAGEX_PIPABLE_OPTION:
1797 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1799 case IMAGEX_NOT_PIPABLE_OPTION:
1800 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1802 case IMAGEX_UPDATE_OF_OPTION:
1803 if (template_image_name_or_num) {
1804 imagex_error(T("'--update-of' can only be "
1805 "specified one time!"));
1809 colon = tstrrchr(optarg, T(':'));
1812 template_wimfile = optarg;
1814 template_image_name_or_num = colon + 1;
1816 template_wimfile = NULL;
1817 template_image_name_or_num = optarg;
1821 case IMAGEX_DELTA_FROM_OPTION:
1822 if (cmd != CMD_CAPTURE) {
1823 imagex_error(T("'--delta-from' is only "
1824 "valid for capture!"));
1827 ret = string_set_append(&base_wimfiles, optarg);
1829 goto out_free_base_wimfiles;
1830 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1832 case IMAGEX_WIMBOOT_OPTION:
1833 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_WIMBOOT;
1842 if (argc < 2 || argc > 4)
1848 /* Set default compression type and parameters. */
1851 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1852 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) {
1853 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
1855 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1856 if (!compress_slow && pack_ctype != WIMLIB_COMPRESSION_TYPE_LZX) {
1857 struct wimlib_lzx_compressor_params params = {
1858 .hdr.size = sizeof(params),
1859 .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
1862 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1869 set_compress_slow();
1871 if (!tstrcmp(wimfile, T("-"))) {
1872 /* Writing captured WIM to standard output. */
1874 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1875 imagex_error("Can't write a non-pipable WIM to "
1876 "standard output! Specify --pipable\n"
1877 " if you want to create a pipable WIM "
1878 "(but read the docs first).");
1882 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1884 if (cmd == CMD_APPEND) {
1885 imagex_error(T("Using standard output for append does "
1886 "not make sense."));
1889 wim_fd = STDOUT_FILENO;
1891 imagex_info_file = stderr;
1892 set_fd_to_binary_mode(wim_fd);
1895 /* If template image was specified using --update-of=IMAGE rather
1896 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1897 if (template_image_name_or_num && !template_wimfile) {
1898 if (base_wimfiles.num_strings == 1) {
1899 /* Capturing delta WIM based on single WIM: default to
1901 template_wimfile = base_wimfiles.strings[0];
1902 } else if (cmd == CMD_APPEND) {
1903 /* Appending to WIM: default to WIM being appended to.
1905 template_wimfile = wimfile;
1907 /* Capturing a normal (non-delta) WIM, so the WIM file
1908 * *must* be explicitly specified. */
1909 if (base_wimfiles.num_strings > 1) {
1910 imagex_error(T("For capture of delta WIM "
1911 "based on multiple existing "
1913 " '--update-of' must "
1914 "specify WIMFILE:IMAGE!"));
1916 imagex_error(T("For capture of non-delta WIM, "
1917 "'--update-of' must specify "
1926 name_defaulted = false;
1928 /* Set default name to SOURCE argument, omitting any directory
1929 * prefixes and trailing slashes. This requires making a copy
1930 * of @source. Leave some free characters at the end in case we
1931 * append a number to keep the name unique. */
1932 size_t source_name_len;
1934 source_name_len = tstrlen(source);
1935 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1936 name = tbasename(tstrcpy(source_copy, source));
1937 name_defaulted = true;
1939 /* Image description defaults to NULL if not given. */
1946 /* Set up capture sources in source list mode */
1947 if (source[0] == T('-') && source[1] == T('\0')) {
1948 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1950 source_list_contents = file_get_text_contents(source,
1951 &source_list_nchars);
1953 if (!source_list_contents)
1956 capture_sources = parse_source_list(&source_list_contents,
1959 if (!capture_sources) {
1961 goto out_free_source_list_contents;
1963 capture_sources_malloced = true;
1965 /* Set up capture source in non-source-list mode. */
1966 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1967 capture_sources[0].fs_source_path = source;
1968 capture_sources[0].wim_target_path = NULL;
1969 capture_sources[0].reserved = 0;
1971 capture_sources_malloced = false;
1972 source_list_contents = NULL;
1975 /* Open the existing WIM, or create a new one. */
1976 if (cmd == CMD_APPEND)
1977 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1978 imagex_progress_func);
1980 ret = wimlib_create_new_wim(compression_type, &wim);
1982 goto out_free_capture_sources;
1984 /* Set chunk size if non-default. */
1985 if (chunk_size != UINT32_MAX) {
1986 ret = wimlib_set_output_chunk_size(wim, chunk_size);
1989 } else if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) &&
1990 compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS) {
1991 ret = wimlib_set_output_chunk_size(wim, 4096);
1995 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
1996 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
2000 if (pack_chunk_size != UINT32_MAX) {
2001 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
2007 /* Detect if source is regular file or block device and set NTFS volume
2012 if (tstat(source, &stbuf) == 0) {
2013 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2014 imagex_printf(T("Capturing WIM image from NTFS "
2015 "filesystem on \"%"TS"\"\n"), source);
2016 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
2019 if (errno != ENOENT) {
2020 imagex_error_with_errno(T("Failed to stat "
2021 "\"%"TS"\""), source);
2029 /* If the user did not specify an image name, and the basename of the
2030 * source already exists as an image name in the WIM file, append a
2031 * suffix to make it unique. */
2032 if (cmd == CMD_APPEND && name_defaulted) {
2033 unsigned long conflict_idx;
2034 tchar *name_end = tstrchr(name, T('\0'));
2035 for (conflict_idx = 1;
2036 wimlib_image_name_in_use(wim, name);
2039 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2043 /* If capturing a delta WIM, reference resources from the base WIMs
2044 * before adding the new image. */
2045 if (base_wimfiles.num_strings) {
2046 base_wims = calloc(base_wimfiles.num_strings,
2047 sizeof(base_wims[0]));
2048 if (base_wims == NULL) {
2049 imagex_error(T("Out of memory!"));
2054 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2055 ret = wimlib_open_wim(base_wimfiles.strings[i],
2056 open_flags, &base_wims[i],
2057 imagex_progress_func);
2059 goto out_free_base_wims;
2063 ret = wimlib_reference_resources(wim, base_wims,
2064 base_wimfiles.num_strings, 0);
2066 goto out_free_base_wims;
2068 if (base_wimfiles.num_strings == 1) {
2069 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2070 base_wimfiles.strings[0]);
2072 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2073 base_wimfiles.num_strings);
2080 /* If capturing or appending as an update of an existing (template) image,
2081 * open the WIM if needed and parse the image index. */
2082 if (template_image_name_or_num) {
2085 if (base_wimfiles.num_strings == 1 &&
2086 template_wimfile == base_wimfiles.strings[0]) {
2087 template_wim = base_wims[0];
2088 } else if (template_wimfile == wimfile) {
2091 ret = wimlib_open_wim(template_wimfile, open_flags,
2092 &template_wim, imagex_progress_func);
2094 goto out_free_base_wims;
2097 template_image = wimlib_resolve_image(template_wim,
2098 template_image_name_or_num);
2100 if (template_image_name_or_num[0] == T('-')) {
2103 struct wimlib_wim_info info;
2105 wimlib_get_wim_info(template_wim, &info);
2106 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2107 if (n >= 1 && n <= info.image_count &&
2109 tmp != template_image_name_or_num + 1)
2111 template_image = info.image_count - (n - 1);
2114 ret = verify_image_exists_and_is_single(template_image,
2115 template_image_name_or_num,
2118 goto out_free_template_wim;
2120 template_wim = NULL;
2123 ret = wimlib_add_image_multisource(wim,
2129 imagex_progress_func);
2131 goto out_free_template_wim;
2133 if (desc || flags_element || template_image_name_or_num) {
2134 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2135 * on which the added one is to be based has been specified with
2136 * --update-of. Get the index of the image we just
2137 * added, then use it to call the appropriate functions. */
2138 struct wimlib_wim_info info;
2140 wimlib_get_wim_info(wim, &info);
2143 ret = wimlib_set_image_descripton(wim,
2147 goto out_free_template_wim;
2150 if (flags_element) {
2151 ret = wimlib_set_image_flags(wim, info.image_count,
2154 goto out_free_template_wim;
2157 /* Reference template image if the user provided one. */
2158 if (template_image_name_or_num) {
2159 imagex_printf(T("Using image %d "
2160 "from \"%"TS"\" as template\n"),
2161 template_image, template_wimfile);
2162 ret = wimlib_reference_template_image(wim,
2168 goto out_free_template_wim;
2172 /* Write the new WIM or overwrite the existing WIM with the new image
2174 if (cmd == CMD_APPEND) {
2175 ret = wimlib_overwrite(wim, write_flags, num_threads,
2176 imagex_progress_func);
2177 } else if (wimfile) {
2178 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2179 write_flags, num_threads,
2180 imagex_progress_func);
2182 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2183 write_flags, num_threads,
2184 imagex_progress_func);
2186 out_free_template_wim:
2187 /* template_wim may alias base_wims[0] or wim. */
2188 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2189 template_wim != wim)
2190 wimlib_free(template_wim);
2192 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2193 wimlib_free(base_wims[i]);
2197 out_free_capture_sources:
2198 if (capture_sources_malloced)
2199 free(capture_sources);
2200 out_free_source_list_contents:
2201 free(source_list_contents);
2202 out_free_base_wimfiles:
2203 string_set_destroy(&base_wimfiles);
2210 goto out_free_base_wimfiles;
2213 /* Remove image(s) from a WIM. */
2215 imagex_delete(int argc, tchar **argv, int cmd)
2218 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2219 int write_flags = 0;
2220 const tchar *wimfile;
2221 const tchar *image_num_or_name;
2226 for_opt(c, delete_options) {
2228 case IMAGEX_CHECK_OPTION:
2229 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2230 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2232 case IMAGEX_SOFT_OPTION:
2233 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2244 imagex_error(T("Must specify a WIM file"));
2246 imagex_error(T("Must specify an image"));
2250 image_num_or_name = argv[1];
2252 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2253 imagex_progress_func);
2257 image = wimlib_resolve_image(wim, image_num_or_name);
2259 ret = verify_image_exists(image, image_num_or_name, wimfile);
2261 goto out_wimlib_free;
2263 ret = wimlib_delete_image(wim, image);
2265 imagex_error(T("Failed to delete image from \"%"TS"\""),
2267 goto out_wimlib_free;
2270 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2272 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2273 "deleted"), wimfile);
2281 usage(CMD_DELETE, stderr);
2286 struct print_dentry_options {
2291 print_dentry_full_path(const struct wimlib_dir_entry *dentry)
2293 tprintf(T("%"TS"\n"), dentry->full_path);
2296 static const struct {
2299 } file_attr_flags[] = {
2300 {WIMLIB_FILE_ATTRIBUTE_READONLY, T("READONLY")},
2301 {WIMLIB_FILE_ATTRIBUTE_HIDDEN, T("HIDDEN")},
2302 {WIMLIB_FILE_ATTRIBUTE_SYSTEM, T("SYSTEM")},
2303 {WIMLIB_FILE_ATTRIBUTE_DIRECTORY, T("DIRECTORY")},
2304 {WIMLIB_FILE_ATTRIBUTE_ARCHIVE, T("ARCHIVE")},
2305 {WIMLIB_FILE_ATTRIBUTE_DEVICE, T("DEVICE")},
2306 {WIMLIB_FILE_ATTRIBUTE_NORMAL, T("NORMAL")},
2307 {WIMLIB_FILE_ATTRIBUTE_TEMPORARY, T("TEMPORARY")},
2308 {WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE, T("SPARSE_FILE")},
2309 {WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT, T("REPARSE_POINT")},
2310 {WIMLIB_FILE_ATTRIBUTE_COMPRESSED, T("COMPRESSED")},
2311 {WIMLIB_FILE_ATTRIBUTE_OFFLINE, T("OFFLINE")},
2312 {WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED, T("NOT_CONTENT_INDEXED")},
2313 {WIMLIB_FILE_ATTRIBUTE_ENCRYPTED, T("ENCRYPTED")},
2314 {WIMLIB_FILE_ATTRIBUTE_VIRTUAL, T("VIRTUAL")},
2317 #define TIMESTR_MAX 100
2320 timespec_to_string(const struct timespec *spec, tchar *buf)
2322 time_t t = spec->tv_sec;
2325 tstrftime(buf, TIMESTR_MAX, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
2326 buf[TIMESTR_MAX - 1] = '\0';
2330 print_time(const tchar *type, const struct timespec *spec)
2332 tchar timestr[TIMESTR_MAX];
2334 timespec_to_string(spec, timestr);
2336 tprintf(T("%-20"TS"= %"TS"\n"), type, timestr);
2339 static void print_byte_field(const uint8_t field[], size_t len)
2342 tprintf(T("%02hhx"), *field++);
2346 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2348 tputs(T("WIM Information:"));
2349 tputs(T("----------------"));
2350 tprintf(T("Path: %"TS"\n"), wimfile);
2351 tprintf(T("GUID: 0x"));
2352 print_byte_field(info->guid, sizeof(info->guid));
2354 tprintf(T("Version: %u\n"), info->wim_version);
2355 tprintf(T("Image Count: %d\n"), info->image_count);
2356 tprintf(T("Compression: %"TS"\n"),
2357 wimlib_get_compression_type_string(info->compression_type));
2358 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2360 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2361 tprintf(T("Boot Index: %d\n"), info->boot_index);
2362 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2363 tprintf(T("Integrity Info: %"TS"\n"),
2364 info->has_integrity_table ? T("yes") : T("no"));
2365 tprintf(T("Relative path junction: %"TS"\n"),
2366 info->has_rpfix ? T("yes") : T("no"));
2367 tprintf(T("Pipable: %"TS"\n"),
2368 info->pipable ? T("yes") : T("no"));
2373 print_resource(const struct wimlib_resource_entry *resource,
2376 tprintf(T("Hash = 0x"));
2377 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2380 if (!resource->is_missing) {
2381 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2382 resource->uncompressed_size);
2383 if (resource->packed) {
2384 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2385 resource->raw_resource_compressed_size);
2387 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2388 resource->raw_resource_offset_in_wim);
2390 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2393 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2394 resource->compressed_size);
2396 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2400 tprintf(T("Part Number = %u\n"), resource->part_number);
2401 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2403 tprintf(T("Flags = "));
2404 if (resource->is_compressed)
2405 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2406 if (resource->is_metadata)
2407 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2408 if (resource->is_free)
2409 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2410 if (resource->is_spanned)
2411 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2412 if (resource->packed)
2413 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2421 print_lookup_table(WIMStruct *wim)
2423 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2427 default_print_security_descriptor(const uint8_t *sd, size_t size)
2429 tprintf(T("Security Descriptor = "));
2430 print_byte_field(sd, size);
2435 print_dentry_detailed(const struct wimlib_dir_entry *dentry)
2439 "----------------------------------------------------------------------------\n"));
2440 tprintf(T("Full Path = \"%"TS"\"\n"), dentry->full_path);
2441 if (dentry->dos_name)
2442 tprintf(T("Short Name = \"%"TS"\"\n"), dentry->dos_name);
2443 tprintf(T("Attributes = 0x%08x\n"), dentry->attributes);
2444 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
2445 if (file_attr_flags[i].flag & dentry->attributes)
2446 tprintf(T(" FILE_ATTRIBUTE_%"TS" is set\n"),
2447 file_attr_flags[i].name);
2449 if (dentry->security_descriptor) {
2450 print_security_descriptor(dentry->security_descriptor,
2451 dentry->security_descriptor_size);
2454 print_time(T("Creation Time"), &dentry->creation_time);
2455 print_time(T("Last Write Time"), &dentry->last_write_time);
2456 print_time(T("Last Access Time"), &dentry->last_access_time);
2459 if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT)
2460 tprintf(T("Reparse Tag = 0x%"PRIx32"\n"), dentry->reparse_tag);
2462 tprintf(T("Link Group ID = 0x%016"PRIx64"\n"), dentry->hard_link_group_id);
2463 tprintf(T("Link Count = %"PRIu32"\n"), dentry->num_links);
2465 for (uint32_t i = 0; i <= dentry->num_named_streams; i++) {
2466 if (dentry->streams[i].stream_name) {
2467 tprintf(T("\tData stream \"%"TS"\":\n"),
2468 dentry->streams[i].stream_name);
2470 tprintf(T("\tUnnamed data stream:\n"));
2472 print_resource(&dentry->streams[i].resource, NULL);
2477 print_dentry(const struct wimlib_dir_entry *dentry, void *_options)
2479 const struct print_dentry_options *options = _options;
2480 if (!options->detailed)
2481 print_dentry_full_path(dentry);
2483 print_dentry_detailed(dentry);
2487 /* Print the files contained in an image(s) in a WIM file. */
2489 imagex_dir(int argc, tchar **argv, int cmd)
2491 const tchar *wimfile;
2492 WIMStruct *wim = NULL;
2495 const tchar *path = T("");
2497 struct print_dentry_options options = {
2500 int iterate_flags = WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2502 for_opt(c, dir_options) {
2504 case IMAGEX_PATH_OPTION:
2507 case IMAGEX_DETAILED_OPTION:
2508 options.detailed = true;
2510 case IMAGEX_ONE_FILE_ONLY_OPTION:
2511 iterate_flags &= ~WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2521 imagex_error(T("Must specify a WIM file"));
2525 imagex_error(T("Too many arguments"));
2530 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2535 image = wimlib_resolve_image(wim, argv[1]);
2536 ret = verify_image_exists(image, argv[1], wimfile);
2538 goto out_wimlib_free;
2540 /* No image specified; default to image 1, but only if the WIM
2541 * contains exactly one image. */
2543 struct wimlib_wim_info info;
2545 wimlib_get_wim_info(wim, &info);
2546 if (info.image_count != 1) {
2547 imagex_error(T("\"%"TS"\" contains %d images; Please "
2548 "select one (or all)."),
2549 wimfile, info.image_count);
2556 ret = wimlib_iterate_dir_tree(wim, image, path, iterate_flags,
2557 print_dentry, &options);
2564 usage(CMD_DIR, stderr);
2569 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2572 imagex_export(int argc, tchar **argv, int cmd)
2576 int export_flags = 0;
2577 int write_flags = 0;
2578 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2579 const tchar *src_wimfile;
2580 const tchar *src_image_num_or_name;
2581 const tchar *dest_wimfile;
2583 const tchar *dest_name;
2584 const tchar *dest_desc;
2586 struct wimlib_wim_info src_info;
2587 WIMStruct *dest_wim;
2592 STRING_SET(refglobs);
2593 unsigned num_threads = 0;
2594 uint32_t chunk_size = UINT32_MAX;
2595 uint32_t pack_chunk_size = UINT32_MAX;
2596 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
2598 for_opt(c, export_options) {
2600 case IMAGEX_BOOT_OPTION:
2601 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2603 case IMAGEX_CHECK_OPTION:
2604 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2605 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2607 case IMAGEX_NOCHECK_OPTION:
2608 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2610 case IMAGEX_COMPRESS_OPTION:
2611 compression_type = get_compression_type(optarg);
2612 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2615 case IMAGEX_COMPRESS_SLOW_OPTION:
2616 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2617 set_compress_slow();
2619 case IMAGEX_PACK_STREAMS_OPTION:
2620 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2622 case IMAGEX_CHUNK_SIZE_OPTION:
2623 chunk_size = parse_chunk_size(optarg);
2624 if (chunk_size == UINT32_MAX)
2627 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
2628 pack_chunk_size = parse_chunk_size(optarg);
2629 if (pack_chunk_size == UINT32_MAX)
2632 case IMAGEX_PACK_COMPRESS_OPTION:
2633 pack_ctype = get_compression_type(optarg);
2634 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
2637 case IMAGEX_REF_OPTION:
2638 ret = string_set_append(&refglobs, optarg);
2640 goto out_free_refglobs;
2642 case IMAGEX_THREADS_OPTION:
2643 num_threads = parse_num_threads(optarg);
2644 if (num_threads == UINT_MAX)
2647 case IMAGEX_REBUILD_OPTION:
2648 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2650 case IMAGEX_PIPABLE_OPTION:
2651 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2653 case IMAGEX_NOT_PIPABLE_OPTION:
2654 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2662 if (argc < 3 || argc > 5)
2664 src_wimfile = argv[0];
2665 src_image_num_or_name = argv[1];
2666 dest_wimfile = argv[2];
2667 dest_name = (argc >= 4) ? argv[3] : NULL;
2668 dest_desc = (argc >= 5) ? argv[4] : NULL;
2669 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2670 imagex_progress_func);
2672 goto out_free_refglobs;
2674 wimlib_get_wim_info(src_wim, &src_info);
2676 /* Determine if the destination is an existing file or not. If so, we
2677 * try to append the exported image(s) to it; otherwise, we create a new
2678 * WIM containing the exported image(s). Furthermore, determine if we
2679 * need to write a pipable WIM directly to standard output. */
2681 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2683 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2684 imagex_error("Can't write a non-pipable WIM to "
2685 "standard output! Specify --pipable\n"
2686 " if you want to create a pipable WIM "
2687 "(but read the docs first).");
2689 goto out_free_src_wim;
2692 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2694 dest_wimfile = NULL;
2695 dest_wim_fd = STDOUT_FILENO;
2696 imagex_info_file = stderr;
2697 set_fd_to_binary_mode(dest_wim_fd);
2700 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2702 /* Destination file exists. */
2704 if (!S_ISREG(stbuf.st_mode)) {
2705 imagex_error(T("\"%"TS"\" is not a regular file"),
2708 goto out_free_src_wim;
2710 ret = wimlib_open_wim(dest_wimfile,
2711 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2712 &dest_wim, imagex_progress_func);
2714 goto out_free_src_wim;
2716 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2717 /* The user specified a compression type, but we're
2718 * exporting to an existing WIM. Make sure the
2719 * specified compression type is the same as the
2720 * compression type of the existing destination WIM. */
2721 struct wimlib_wim_info dest_info;
2723 wimlib_get_wim_info(dest_wim, &dest_info);
2724 if (compression_type != dest_info.compression_type) {
2725 imagex_error(T("Cannot specify a compression type that is "
2726 "not the same as that used in the "
2727 "destination WIM"));
2729 goto out_free_dest_wim;
2735 if (errno != ENOENT) {
2736 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2739 goto out_free_src_wim;
2742 /* dest_wimfile is not an existing file, so create a new WIM. */
2744 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2745 /* The user did not specify a compression type; default
2746 * to that of the source WIM. */
2748 compression_type = src_info.compression_type;
2750 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2752 goto out_free_src_wim;
2754 /* Use same chunk size if compression type is the same. */
2755 if (compression_type == src_info.compression_type &&
2756 chunk_size == UINT32_MAX)
2757 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2760 if (chunk_size != UINT32_MAX) {
2761 /* Set destination chunk size. */
2762 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2764 goto out_free_dest_wim;
2766 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
2767 ret = wimlib_set_output_pack_compression_type(dest_wim, pack_ctype);
2769 goto out_free_dest_wim;
2771 if (pack_chunk_size != UINT32_MAX) {
2772 ret = wimlib_set_output_pack_chunk_size(dest_wim, pack_chunk_size);
2774 goto out_free_dest_wim;
2777 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2778 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2780 goto out_free_dest_wim;
2782 if (refglobs.num_strings) {
2783 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2785 goto out_free_dest_wim;
2788 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2789 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2791 imagex_error(T("--boot specified for all-images export, but source WIM "
2792 "has no bootable image."));
2794 goto out_free_dest_wim;
2797 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2798 dest_desc, export_flags, imagex_progress_func);
2800 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2801 do_resource_not_found_warning(src_wimfile,
2802 &src_info, &refglobs);
2804 goto out_free_dest_wim;
2808 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2809 imagex_progress_func);
2810 else if (dest_wimfile)
2811 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2812 write_flags, num_threads,
2813 imagex_progress_func);
2815 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2816 WIMLIB_ALL_IMAGES, write_flags,
2817 num_threads, imagex_progress_func);
2819 wimlib_free(dest_wim);
2821 wimlib_free(src_wim);
2823 string_set_destroy(&refglobs);
2827 usage(CMD_EXPORT, stderr);
2830 goto out_free_refglobs;
2833 /* Extract files or directories from a WIM image */
2835 imagex_extract(int argc, tchar **argv, int cmd)
2842 const tchar *wimfile;
2843 const tchar *image_num_or_name;
2844 tchar *dest_dir = T(".");
2845 int extract_flags = WIMLIB_EXTRACT_FLAG_NORPFIX |
2846 WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2847 WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2848 int notlist_extract_flags = WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2850 STRING_SET(refglobs);
2852 tchar *root_path = T("");
2854 for_opt(c, extract_options) {
2856 case IMAGEX_CHECK_OPTION:
2857 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2859 case IMAGEX_VERBOSE_OPTION:
2860 /* No longer does anything. */
2862 case IMAGEX_REF_OPTION:
2863 ret = string_set_append(&refglobs, optarg);
2865 goto out_free_refglobs;
2867 case IMAGEX_UNIX_DATA_OPTION:
2868 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2870 case IMAGEX_NO_ACLS_OPTION:
2871 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2873 case IMAGEX_STRICT_ACLS_OPTION:
2874 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2876 case IMAGEX_NO_ATTRIBUTES_OPTION:
2877 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
2879 case IMAGEX_DEST_DIR_OPTION:
2882 case IMAGEX_TO_STDOUT_OPTION:
2883 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2884 imagex_info_file = stderr;
2885 imagex_be_quiet = true;
2887 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2888 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2889 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2891 case IMAGEX_NO_WILDCARDS_OPTION:
2892 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2894 case IMAGEX_NULLGLOB_OPTION:
2895 extract_flags &= ~WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2897 case IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION:
2898 notlist_extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2900 case IMAGEX_WIMBOOT_OPTION:
2901 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
2913 if (!(extract_flags & (WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2914 WIMLIB_EXTRACT_FLAG_STRICT_GLOB)))
2916 imagex_error(T("Can't combine --no-wildcards and --nullglob!"));
2921 image_num_or_name = argv[1];
2926 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2928 goto out_free_refglobs;
2930 image = wimlib_resolve_image(wim, image_num_or_name);
2931 ret = verify_image_exists_and_is_single(image,
2935 goto out_wimlib_free;
2937 if (refglobs.num_strings) {
2938 ret = wim_reference_globs(wim, &refglobs, open_flags);
2940 goto out_wimlib_free;
2946 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2949 while (argc != 0 && ret == 0) {
2953 num_paths < argc && argv[num_paths][0] != T('@');
2958 ret = wimlib_extract_paths(wim, image, dest_dir,
2959 (const tchar **)argv,
2961 extract_flags | notlist_extract_flags,
2962 imagex_progress_func);
2966 ret = wimlib_extract_pathlist(wim, image, dest_dir,
2969 imagex_progress_func);
2976 if (!imagex_be_quiet)
2977 imagex_printf(T("Done extracting files.\n"));
2978 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2979 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2980 "files and directories\n"
2981 " are in the WIM image.\n"),
2982 get_cmd_string(CMD_DIR, false));
2983 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2984 struct wimlib_wim_info info;
2986 wimlib_get_wim_info(wim, &info);
2987 do_resource_not_found_warning(wimfile, &info, &refglobs);
2992 string_set_destroy(&refglobs);
2996 usage(CMD_EXTRACT, stderr);
2999 goto out_free_refglobs;
3002 /* Prints information about a WIM file; also can mark an image as bootable,
3003 * change the name of an image, or change the description of an image. */
3005 imagex_info(int argc, tchar **argv, int cmd)
3010 bool nocheck = false;
3011 bool header = false;
3012 bool lookup_table = false;
3014 bool short_header = true;
3015 const tchar *xml_out_file = NULL;
3016 const tchar *wimfile;
3017 const tchar *image_num_or_name;
3018 const tchar *new_name;
3019 const tchar *new_desc;
3024 struct wimlib_wim_info info;
3026 for_opt(c, info_options) {
3028 case IMAGEX_BOOT_OPTION:
3031 case IMAGEX_CHECK_OPTION:
3034 case IMAGEX_NOCHECK_OPTION:
3037 case IMAGEX_HEADER_OPTION:
3039 short_header = false;
3041 case IMAGEX_LOOKUP_TABLE_OPTION:
3042 lookup_table = true;
3043 short_header = false;
3045 case IMAGEX_XML_OPTION:
3047 short_header = false;
3049 case IMAGEX_EXTRACT_XML_OPTION:
3050 xml_out_file = optarg;
3051 short_header = false;
3053 case IMAGEX_METADATA_OPTION:
3054 imagex_error(T("The --metadata option has been removed. "
3055 "Use 'wimdir --detail' instead."));
3064 if (argc < 1 || argc > 4)
3068 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
3069 new_name = (argc >= 3) ? argv[2] : NULL;
3070 new_desc = (argc >= 4) ? argv[3] : NULL;
3072 if (check && nocheck) {
3073 imagex_error(T("Can't specify both --check and --nocheck"));
3078 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3080 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3084 wimlib_get_wim_info(wim, &info);
3086 image = wimlib_resolve_image(wim, image_num_or_name);
3087 ret = WIMLIB_ERR_INVALID_IMAGE;
3088 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3089 verify_image_exists(image, image_num_or_name, wimfile);
3091 imagex_error(T("If you would like to set the boot "
3092 "index to 0, specify image \"0\" with "
3093 "the --boot flag."));
3095 goto out_wimlib_free;
3098 if (boot && info.image_count == 0) {
3099 imagex_error(T("--boot is meaningless on a WIM with no images"));
3100 goto out_wimlib_free;
3103 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3105 imagex_error(T("Cannot specify the --boot flag "
3106 "without specifying a specific "
3107 "image in a multi-image WIM"));
3108 goto out_wimlib_free;
3111 imagex_error(T("Cannot specify the NEW_NAME "
3112 "without specifying a specific "
3113 "image in a multi-image WIM"));
3114 goto out_wimlib_free;
3118 /* Operations that print information are separated from operations that
3119 * recreate the WIM file. */
3120 if (!new_name && !boot) {
3122 /* Read-only operations */
3124 if (image == WIMLIB_NO_IMAGE) {
3125 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3126 image_num_or_name, wimfile);
3127 goto out_wimlib_free;
3130 if (image == WIMLIB_ALL_IMAGES && short_header)
3131 print_wim_information(wimfile, &info);
3134 wimlib_print_header(wim);
3137 if (info.total_parts != 1) {
3138 tfprintf(stderr, T("Warning: Only showing the lookup table "
3139 "for part %d of a %d-part WIM.\n"),
3140 info.part_number, info.total_parts);
3142 print_lookup_table(wim);
3146 ret = wimlib_extract_xml_data(wim, stdout);
3148 goto out_wimlib_free;
3154 fp = tfopen(xml_out_file, T("wb"));
3156 imagex_error_with_errno(T("Failed to open the "
3157 "file \"%"TS"\" for "
3161 goto out_wimlib_free;
3163 ret = wimlib_extract_xml_data(wim, fp);
3165 imagex_error(T("Failed to close the file "
3171 goto out_wimlib_free;
3175 wimlib_print_available_images(wim, image);
3180 /* Modification operations */
3182 if (image == WIMLIB_ALL_IMAGES)
3185 if (image == WIMLIB_NO_IMAGE && new_name) {
3186 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3187 "when using image 0"), new_name);
3189 goto out_wimlib_free;
3193 if (image == info.boot_index) {
3194 imagex_printf(T("Image %d is already marked as "
3195 "bootable.\n"), image);
3198 imagex_printf(T("Marking image %d as bootable.\n"),
3200 info.boot_index = image;
3201 ret = wimlib_set_wim_info(wim, &info,
3202 WIMLIB_CHANGE_BOOT_INDEX);
3204 goto out_wimlib_free;
3208 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3210 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3214 imagex_printf(T("Changing the name of image %d to "
3215 "\"%"TS"\".\n"), image, new_name);
3216 ret = wimlib_set_image_name(wim, image, new_name);
3218 goto out_wimlib_free;
3222 const tchar *old_desc;
3223 old_desc = wimlib_get_image_description(wim, image);
3224 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3225 imagex_printf(T("The description of image %d is already "
3226 "\"%"TS"\".\n"), image, new_desc);
3229 imagex_printf(T("Changing the description of image %d "
3230 "to \"%"TS"\".\n"), image, new_desc);
3231 ret = wimlib_set_image_descripton(wim, image,
3234 goto out_wimlib_free;
3238 /* Only call wimlib_overwrite() if something actually needs to
3240 if (boot || new_name || new_desc ||
3241 (check && !info.has_integrity_table) ||
3242 (nocheck && info.has_integrity_table))
3244 int write_flags = 0;
3247 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3249 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3250 ret = wimlib_overwrite(wim, write_flags, 1,
3251 imagex_progress_func);
3253 imagex_printf(T("The file \"%"TS"\" was not modified "
3254 "because nothing needed to be done.\n"),
3265 usage(CMD_INFO, stderr);
3271 /* Join split WIMs into one part WIM */
3273 imagex_join(int argc, tchar **argv, int cmd)
3276 int swm_open_flags = 0;
3277 int wim_write_flags = 0;
3278 const tchar *output_path;
3281 for_opt(c, join_options) {
3283 case IMAGEX_CHECK_OPTION:
3284 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3285 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3295 imagex_error(T("Must specify one or more split WIM (.swm) "
3299 output_path = argv[0];
3300 ret = wimlib_join((const tchar * const *)++argv,
3305 imagex_progress_func);
3310 usage(CMD_JOIN, stderr);
3315 #if WIM_MOUNTING_SUPPORTED
3317 /* Mounts a WIM image. */
3319 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3322 int mount_flags = 0;
3324 const tchar *staging_dir = NULL;
3325 const tchar *wimfile;
3328 struct wimlib_wim_info info;
3332 STRING_SET(refglobs);
3334 if (cmd == CMD_MOUNTRW) {
3335 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3336 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3339 for_opt(c, mount_options) {
3341 case IMAGEX_ALLOW_OTHER_OPTION:
3342 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3344 case IMAGEX_CHECK_OPTION:
3345 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3347 case IMAGEX_DEBUG_OPTION:
3348 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3350 case IMAGEX_STREAMS_INTERFACE_OPTION:
3351 if (!tstrcasecmp(optarg, T("none")))
3352 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3353 else if (!tstrcasecmp(optarg, T("xattr")))
3354 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3355 else if (!tstrcasecmp(optarg, T("windows")))
3356 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3358 imagex_error(T("Unknown stream interface \"%"TS"\""),
3363 case IMAGEX_REF_OPTION:
3364 ret = string_set_append(&refglobs, optarg);
3366 goto out_free_refglobs;
3368 case IMAGEX_STAGING_DIR_OPTION:
3369 staging_dir = optarg;
3371 case IMAGEX_UNIX_DATA_OPTION:
3372 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3380 if (argc != 2 && argc != 3)
3385 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3387 goto out_free_refglobs;
3389 wimlib_get_wim_info(wim, &info);
3392 /* Image explicitly specified. */
3393 image = wimlib_resolve_image(wim, argv[1]);
3395 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3399 /* No image specified; default to image 1, but only if the WIM
3400 * contains exactly one image. */
3402 if (info.image_count != 1) {
3403 imagex_error(T("\"%"TS"\" contains %d images; Please "
3404 "select one."), wimfile, info.image_count);
3412 if (refglobs.num_strings) {
3413 ret = wim_reference_globs(wim, &refglobs, open_flags);
3418 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3420 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3422 image, wimfile, dir);
3427 string_set_destroy(&refglobs);
3433 goto out_free_refglobs;
3435 #endif /* WIM_MOUNTING_SUPPORTED */
3437 /* Rebuild a WIM file */
3439 imagex_optimize(int argc, tchar **argv, int cmd)
3442 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3443 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3444 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3445 uint32_t chunk_size = UINT32_MAX;
3446 uint32_t pack_chunk_size = UINT32_MAX;
3447 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
3450 const tchar *wimfile;
3453 unsigned num_threads = 0;
3455 for_opt(c, optimize_options) {
3457 case IMAGEX_CHECK_OPTION:
3458 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3459 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3461 case IMAGEX_NOCHECK_OPTION:
3462 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3464 case IMAGEX_COMPRESS_OPTION:
3465 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3466 compression_type = get_compression_type(optarg);
3467 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3470 case IMAGEX_RECOMPRESS_OPTION:
3471 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3473 case IMAGEX_COMPRESS_SLOW_OPTION:
3474 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3475 set_compress_slow();
3477 case IMAGEX_CHUNK_SIZE_OPTION:
3478 chunk_size = parse_chunk_size(optarg);
3479 if (chunk_size == UINT32_MAX)
3482 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
3483 pack_chunk_size = parse_chunk_size(optarg);
3484 if (pack_chunk_size == UINT32_MAX)
3487 case IMAGEX_PACK_COMPRESS_OPTION:
3488 pack_ctype = get_compression_type(optarg);
3489 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
3492 case IMAGEX_PACK_STREAMS_OPTION:
3493 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3494 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3496 case IMAGEX_THREADS_OPTION:
3497 num_threads = parse_num_threads(optarg);
3498 if (num_threads == UINT_MAX)
3501 case IMAGEX_PIPABLE_OPTION:
3502 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3504 case IMAGEX_NOT_PIPABLE_OPTION:
3505 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3519 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3523 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3524 /* Change compression type. */
3525 ret = wimlib_set_output_compression_type(wim, compression_type);
3527 goto out_wimlib_free;
3530 if (chunk_size != UINT32_MAX) {
3531 /* Change chunk size. */
3532 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3534 goto out_wimlib_free;
3536 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
3537 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
3539 goto out_wimlib_free;
3541 if (pack_chunk_size != UINT32_MAX) {
3542 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
3544 goto out_wimlib_free;
3547 old_size = file_get_size(wimfile);
3548 tprintf(T("\"%"TS"\" original size: "), wimfile);
3550 tputs(T("Unknown"));
3552 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3554 ret = wimlib_overwrite(wim, write_flags, num_threads,
3555 imagex_progress_func);
3557 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3558 goto out_wimlib_free;
3561 new_size = file_get_size(wimfile);
3562 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3564 tputs(T("Unknown"));
3566 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3568 tfputs(T("Space saved: "), stdout);
3569 if (new_size != -1 && old_size != -1) {
3570 tprintf(T("%lld KiB\n"),
3571 ((long long)old_size - (long long)new_size) >> 10);
3573 tputs(T("Unknown"));
3582 usage(CMD_OPTIMIZE, stderr);
3588 /* Split a WIM into a spanned set */
3590 imagex_split(int argc, tchar **argv, int cmd)
3594 int write_flags = 0;
3595 unsigned long part_size;
3600 for_opt(c, split_options) {
3602 case IMAGEX_CHECK_OPTION:
3603 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3604 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3616 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3617 if (tmp == argv[2] || *tmp) {
3618 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3619 imagex_error(T("The part size must be an integer or "
3620 "floating-point number of megabytes."));
3623 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3627 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3633 usage(CMD_SPLIT, stderr);
3639 #if WIM_MOUNTING_SUPPORTED
3640 /* Unmounts a mounted WIM image. */
3642 imagex_unmount(int argc, tchar **argv, int cmd)
3645 int unmount_flags = 0;
3648 for_opt(c, unmount_options) {
3650 case IMAGEX_COMMIT_OPTION:
3651 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3653 case IMAGEX_CHECK_OPTION:
3654 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3656 case IMAGEX_REBUILD_OPTION:
3657 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3659 case IMAGEX_LAZY_OPTION:
3660 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3662 case IMAGEX_NEW_IMAGE_OPTION:
3663 unmount_flags |= WIMLIB_UNMOUNT_FLAG_NEW_IMAGE;
3674 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
3675 if (!(unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)) {
3676 imagex_error(T("--new-image is meaningless "
3677 "without --commit also specified!"));
3680 imagex_printf(T("Committing changes as new image...\n"));
3683 ret = wimlib_unmount_image(argv[0], unmount_flags,
3684 imagex_progress_func);
3686 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3691 usage(CMD_UNMOUNT, stderr);
3696 #endif /* WIM_MOUNTING_SUPPORTED */
3699 * Add, delete, or rename files in a WIM image.
3702 imagex_update(int argc, tchar **argv, int cmd)
3704 const tchar *wimfile;
3708 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3709 int write_flags = 0;
3710 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3711 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3712 WIMLIB_ADD_FLAG_VERBOSE |
3713 WIMLIB_ADD_FLAG_WINCONFIG;
3714 int default_delete_flags = 0;
3715 unsigned num_threads = 0;
3717 tchar *cmd_file_contents;
3718 size_t cmd_file_nchars;
3719 struct wimlib_update_command *cmds;
3721 tchar *command_str = NULL;
3722 tchar *config_file = NULL;
3724 for_opt(c, update_options) {
3726 /* Generic or write options */
3727 case IMAGEX_THREADS_OPTION:
3728 num_threads = parse_num_threads(optarg);
3729 if (num_threads == UINT_MAX)
3732 case IMAGEX_CHECK_OPTION:
3733 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3734 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3736 case IMAGEX_REBUILD_OPTION:
3737 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3739 case IMAGEX_COMMAND_OPTION:
3741 imagex_error(T("--command may only be specified "
3742 "one time. Please provide\n"
3743 " the update commands "
3744 "on standard input instead."));
3747 command_str = tstrdup(optarg);
3749 imagex_error(T("Out of memory!"));
3753 /* Default delete options */
3754 case IMAGEX_FORCE_OPTION:
3755 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3757 case IMAGEX_RECURSIVE_OPTION:
3758 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3761 /* Global add option */
3762 case IMAGEX_CONFIG_OPTION:
3763 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3764 config_file = optarg;
3767 /* Default add options */
3768 case IMAGEX_VERBOSE_OPTION:
3769 /* No longer does anything. */
3771 case IMAGEX_DEREFERENCE_OPTION:
3772 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3774 case IMAGEX_UNIX_DATA_OPTION:
3775 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3777 case IMAGEX_NO_ACLS_OPTION:
3778 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3780 case IMAGEX_STRICT_ACLS_OPTION:
3781 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3783 case IMAGEX_NO_REPLACE_OPTION:
3784 default_add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
3793 if (argc != 1 && argc != 2)
3797 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3799 goto out_free_command_str;
3802 /* Image explicitly specified. */
3803 image = wimlib_resolve_image(wim, argv[1]);
3804 ret = verify_image_exists_and_is_single(image, argv[1],
3807 goto out_wimlib_free;
3809 /* No image specified; default to image 1, but only if the WIM
3810 * contains exactly one image. */
3811 struct wimlib_wim_info info;
3813 wimlib_get_wim_info(wim, &info);
3814 if (info.image_count != 1) {
3815 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3816 wimfile, info.image_count);
3823 /* Read update commands from standard input, or the command string if
3826 cmd_file_contents = NULL;
3827 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3830 if (isatty(STDIN_FILENO)) {
3831 tputs(T("Reading update commands from standard input..."));
3832 recommend_man_page(CMD_UPDATE, stdout);
3834 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3835 if (!cmd_file_contents) {
3837 goto out_wimlib_free;
3840 /* Parse the update commands */
3841 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3846 goto out_free_cmd_file_contents;
3849 /* Set default flags and capture config on the update commands */
3850 for (size_t i = 0; i < num_cmds; i++) {
3851 switch (cmds[i].op) {
3852 case WIMLIB_UPDATE_OP_ADD:
3853 cmds[i].add.add_flags |= default_add_flags;
3854 cmds[i].add.config_file = config_file;
3856 case WIMLIB_UPDATE_OP_DELETE:
3857 cmds[i].delete_.delete_flags |= default_delete_flags;
3864 /* Execute the update commands */
3865 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3866 imagex_progress_func);
3870 /* Overwrite the updated WIM */
3871 ret = wimlib_overwrite(wim, write_flags, num_threads,
3872 imagex_progress_func);
3875 out_free_cmd_file_contents:
3876 free(cmd_file_contents);
3879 out_free_command_str:
3884 usage(CMD_UPDATE, stderr);
3887 goto out_free_command_str;
3892 struct imagex_command {
3894 int (*func)(int argc, tchar **argv, int cmd);
3897 static const struct imagex_command imagex_commands[] = {
3898 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3899 [CMD_APPLY] = {T("apply"), imagex_apply},
3900 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3901 [CMD_DELETE] = {T("delete"), imagex_delete},
3902 [CMD_DIR ] = {T("dir"), imagex_dir},
3903 [CMD_EXPORT] = {T("export"), imagex_export},
3904 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3905 [CMD_INFO] = {T("info"), imagex_info},
3906 [CMD_JOIN] = {T("join"), imagex_join},
3907 #if WIM_MOUNTING_SUPPORTED
3908 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3909 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3911 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3912 [CMD_SPLIT] = {T("split"), imagex_split},
3913 #if WIM_MOUNTING_SUPPORTED
3914 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3916 [CMD_UPDATE] = {T("update"), imagex_update},
3919 static const tchar *usage_strings[] = {
3922 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3923 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3924 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
3925 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3926 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3927 " [--update-of=[WIMFILE:]IMAGE]\n"
3931 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3932 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
3933 " [--no-acls] [--strict-acls] [--no-attributes]\n"
3934 " [--rpfix] [--norpfix] [--hardlink] [--symlink]\n"
3935 " [--include-invalid-names]\n"
3939 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3940 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3941 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3942 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3943 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3944 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
3945 " [--delta-from=WIMFILE]\n"
3949 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
3950 " [--check] [--soft]\n"
3954 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH] [--detailed]\n"
3958 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3959 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3960 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3961 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3965 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [(PATH | @LISTFILE)...]\n"
3966 " [--check] [--ref=\"GLOB\"] [--dest-dir=CMD_DIR]\n"
3967 " [--to-stdout] [--no-acls] [--strict-acls]\n"
3968 " [--no-attributes] [--include-invalid-names]\n"
3969 " [--no-wildcards] [--nullglob] [--preserve-dir-structure]\n"
3973 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3974 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
3975 " [--extract-xml FILE] [--header] [--lookup-table]\n"
3979 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3981 #if WIM_MOUNTING_SUPPORTED
3984 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3985 " [--check] [--streams-interface=INTERFACE]\n"
3986 " [--ref=\"GLOB\"] [--allow-other]\n"
3990 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
3991 " [--check] [--streams-interface=INTERFACE]\n"
3992 " [--staging-dir=CMD_DIR] [--allow-other]\n"
3997 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
3998 " [--recompress-slow] [--compress=TYPE]\n"
3999 " [--threads=NUM_THREADS]\n"
4003 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
4005 #if WIM_MOUNTING_SUPPORTED
4008 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
4014 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
4015 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
4016 " [DEFAULT_DELETE_OPTIONS] [--command=STRING] [< CMDFILE]\n"
4020 static const tchar *invocation_name;
4021 static int invocation_cmd = CMD_NONE;
4023 static const tchar *get_cmd_string(int cmd, bool nospace)
4025 static tchar buf[50];
4026 if (cmd == CMD_NONE) {
4027 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
4028 } else if (invocation_cmd != CMD_NONE) {
4029 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
4031 const tchar *format;
4034 format = T("%"TS"-%"TS"");
4036 format = T("%"TS" %"TS"");
4037 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
4045 static const tchar *s =
4047 IMAGEX_PROGNAME " (distributed with " PACKAGE " " PACKAGE_VERSION ")\n"
4048 "Copyright (C) 2012, 2013, 2014 Eric Biggers\n"
4049 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
4050 "This is free software: you are free to change and redistribute it.\n"
4051 "There is NO WARRANTY, to the extent permitted by law.\n"
4053 "Report bugs to "PACKAGE_BUGREPORT".\n"
4060 help_or_version(int argc, tchar **argv, int cmd)
4065 for (i = 1; i < argc; i++) {
4067 if (p[0] == T('-') && p[1] == T('-')) {
4069 if (!tstrcmp(p, T("help"))) {
4070 if (cmd == CMD_NONE)
4075 } else if (!tstrcmp(p, T("version"))) {
4084 print_usage_string(int cmd, FILE *fp)
4086 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4090 recommend_man_page(int cmd, FILE *fp)
4092 const tchar *format_str;
4094 format_str = T("Uncommon options are not listed;\n"
4095 "See %"TS".pdf in the doc directory for more details.\n");
4097 format_str = T("Uncommon options are not listed;\n"
4098 "Try `man %"TS"' for more details.\n");
4100 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4104 usage(int cmd, FILE *fp)
4106 tfprintf(fp, T("Usage:\n"));
4107 print_usage_string(cmd, fp);
4108 tfprintf(fp, T("\n"));
4109 recommend_man_page(cmd, fp);
4115 tfprintf(fp, T("Usage:\n"));
4116 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4117 print_usage_string(cmd, fp);
4118 tfprintf(fp, T("\n"));
4120 static const tchar *extra =
4123 " %"TS" --version\n"
4125 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4128 tfprintf(fp, extra, invocation_name, invocation_name);
4129 recommend_man_page(CMD_NONE, fp);
4132 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4133 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4134 * something else), while an Windows the command arguments will be UTF-16LE
4135 * encoded 'wchar_t' strings. */
4138 wmain(int argc, wchar_t **argv, wchar_t **envp)
4140 main(int argc, char **argv)
4147 imagex_info_file = stdout;
4148 invocation_name = tbasename(argv[0]);
4151 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4152 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4156 setlocale(LC_ALL, "");
4157 codeset = nl_langinfo(CODESET);
4158 if (!strstr(codeset, "UTF-8") &&
4159 !strstr(codeset, "UTF8") &&
4160 !strstr(codeset, "utf-8") &&
4161 !strstr(codeset, "utf8"))
4164 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4165 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4166 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4167 " to any value to force wimlib to use UTF-8.\n",
4173 #endif /* !__WIN32__ */
4176 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4177 if (igcase != NULL) {
4178 if (!tstrcmp(igcase, T("no")) ||
4179 !tstrcmp(igcase, T("0")))
4180 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4181 else if (!tstrcmp(igcase, T("yes")) ||
4182 !tstrcmp(igcase, T("1")))
4183 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4186 "WARNING: Ignoring unknown setting of "
4187 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4192 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4194 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4195 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4196 for (int i = 0; i < CMD_MAX; i++) {
4197 if (!tstrcmp(invocation_name + 3,
4198 imagex_commands[i].name))
4207 /* Unless already known from the invocation name, determine which
4208 * command was specified. */
4209 if (cmd == CMD_NONE) {
4211 imagex_error(T("No command specified!\n"));
4215 for (int i = 0; i < CMD_MAX; i++) {
4216 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4221 if (cmd != CMD_NONE) {
4227 /* Handle --help and --version. --help can be either for the program as
4228 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4229 * CMD_NONE). Note: help_or_version() will not return if a --help or
4230 * --version argument was found. */
4231 help_or_version(argc, argv, cmd);
4233 /* Bail if a valid command was not specified. */
4234 if (cmd == CMD_NONE) {
4235 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4240 /* Enable warning and error messages in wimlib to be more user-friendly.
4242 wimlib_set_print_errors(true);
4244 /* Initialize wimlib. */
4245 ret = wimlib_global_init(init_flags);
4247 goto out_check_status;
4249 /* Call the command handler function. */
4250 ret = imagex_commands[cmd].func(argc, argv, cmd);
4252 /* Check for error writing to standard output, especially since for some
4253 * commands, writing to standard output is part of the program's actual
4254 * behavior and not just for informational purposes. */
4255 if (ferror(stdout) || fclose(stdout)) {
4256 imagex_error_with_errno(T("error writing to standard output"));
4261 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4262 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4263 * error code from which an error message can be printed. */
4265 imagex_error(T("Exiting with error code %d:\n"
4267 wimlib_get_error_string(ret));
4268 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4269 imagex_error_with_errno(T("errno"));
4271 /* Make wimlib free any resources it's holding (although this is not
4272 * strictly necessary because the process is ending anyway). */
4273 wimlib_global_cleanup();