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 print_security_descriptor win32_print_security_descriptor
54 # include <langinfo.h>
55 # define print_security_descriptor default_print_security_descriptor
56 static inline void set_fd_to_binary_mode(int fd)
61 /* Don't confuse the user by presenting the mounting commands on Windows when
62 * they will never work. However on UNIX-like systems we always present them,
63 * even if WITH_FUSE is not defined at this point, as to not tie the build of
64 * wimlib-imagex to a specific build of wimlib. */
66 # define WIM_MOUNTING_SUPPORTED 0
68 # define WIM_MOUNTING_SUPPORTED 1
71 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
74 is_any_path_separator(tchar c)
76 return c == T('/') || c == T('\\');
79 /* Like basename(), but handles both forward and backwards slashes. */
81 tbasename(tchar *path)
83 tchar *p = tstrchr(path, T('\0'));
88 if (!is_any_path_separator(*--p))
96 if (is_any_path_separator(*--p))
101 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
115 #if WIM_MOUNTING_SUPPORTED
121 #if WIM_MOUNTING_SUPPORTED
128 static void usage(int cmd, FILE *fp);
129 static void usage_all(FILE *fp);
130 static void recommend_man_page(int cmd, FILE *fp);
131 static const tchar *get_cmd_string(int cmd, bool nospace);
133 static int imagex_progress_func(enum wimlib_progress_msg msg,
134 const union wimlib_progress_info *info);
136 static bool imagex_be_quiet = false;
137 static FILE *imagex_info_file;
139 #define imagex_printf(format, ...) \
140 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
143 IMAGEX_ALLOW_OTHER_OPTION,
146 IMAGEX_CHUNK_SIZE_OPTION,
147 IMAGEX_COMMAND_OPTION,
148 IMAGEX_COMMIT_OPTION,
149 IMAGEX_COMPRESS_OPTION,
150 IMAGEX_COMPRESS_SLOW_OPTION,
151 IMAGEX_CONFIG_OPTION,
153 IMAGEX_DELTA_FROM_OPTION,
154 IMAGEX_DEREFERENCE_OPTION,
155 IMAGEX_DEST_DIR_OPTION,
156 IMAGEX_DETAILED_OPTION,
157 IMAGEX_EXTRACT_XML_OPTION,
160 IMAGEX_HEADER_OPTION,
161 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
163 IMAGEX_LOOKUP_TABLE_OPTION,
164 IMAGEX_METADATA_OPTION,
165 IMAGEX_NEW_IMAGE_OPTION,
166 IMAGEX_NOCHECK_OPTION,
167 IMAGEX_NORPFIX_OPTION,
168 IMAGEX_NOT_PIPABLE_OPTION,
169 IMAGEX_NO_ACLS_OPTION,
170 IMAGEX_NO_ATTRIBUTES_OPTION,
171 IMAGEX_NO_REPLACE_OPTION,
172 IMAGEX_NO_WILDCARDS_OPTION,
173 IMAGEX_NULLGLOB_OPTION,
174 IMAGEX_ONE_FILE_ONLY_OPTION,
175 IMAGEX_PACK_CHUNK_SIZE_OPTION,
176 IMAGEX_PACK_COMPRESS_OPTION,
177 IMAGEX_PACK_STREAMS_OPTION,
179 IMAGEX_PIPABLE_OPTION,
180 IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION,
181 IMAGEX_REBUILD_OPTION,
182 IMAGEX_RECOMPRESS_OPTION,
183 IMAGEX_RECURSIVE_OPTION,
185 IMAGEX_RESUME_OPTION,
188 IMAGEX_SOURCE_LIST_OPTION,
189 IMAGEX_STAGING_DIR_OPTION,
190 IMAGEX_STREAMS_INTERFACE_OPTION,
191 IMAGEX_STRICT_ACLS_OPTION,
192 IMAGEX_THREADS_OPTION,
193 IMAGEX_TO_STDOUT_OPTION,
194 IMAGEX_UNIX_DATA_OPTION,
195 IMAGEX_UPDATE_OF_OPTION,
196 IMAGEX_VERBOSE_OPTION,
197 IMAGEX_WIMBOOT_OPTION,
198 IMAGEX_WIMBOOT_CONFIG_OPTION,
202 static const struct option apply_options[] = {
203 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
204 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
205 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
206 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
207 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
208 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
209 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
210 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
211 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
212 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
213 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
215 /* --resume is undocumented for now as it needs improvement. */
216 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
217 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
221 static const struct option capture_or_append_options[] = {
222 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
223 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
224 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
225 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
226 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
227 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
228 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
229 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
230 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
231 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
232 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
233 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
234 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
235 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
236 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
237 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
238 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
239 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
240 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
241 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
242 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
243 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
244 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
245 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
246 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
247 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
248 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
249 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
250 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
251 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
252 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
256 static const struct option delete_options[] = {
257 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
258 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
262 static const struct option dir_options[] = {
263 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
264 {T("detailed"), no_argument, NULL, IMAGEX_DETAILED_OPTION},
265 {T("one-file-only"), no_argument, NULL, IMAGEX_ONE_FILE_ONLY_OPTION},
269 static const struct option export_options[] = {
270 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
271 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
272 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
273 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
274 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
275 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
276 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
277 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
278 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
279 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
280 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
281 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
282 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
283 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
284 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
285 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
286 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
287 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
288 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
292 static const struct option extract_options[] = {
293 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
294 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
295 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
296 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
297 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
298 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
299 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
300 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
301 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
302 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
303 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
304 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_WILDCARDS_OPTION},
305 {T("nullglob"), no_argument, NULL, IMAGEX_NULLGLOB_OPTION},
306 {T("preserve-dir-structure"), no_argument, NULL, IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION},
307 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
311 static const struct option info_options[] = {
312 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
313 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
314 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
315 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
316 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
317 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
318 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
319 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
320 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
324 static const struct option join_options[] = {
325 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
329 static const struct option mount_options[] = {
330 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
331 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
332 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
333 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
334 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
335 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
336 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
340 static const struct option optimize_options[] = {
341 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
342 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
343 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
344 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
345 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
346 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
347 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
348 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
349 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
350 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
351 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
352 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
353 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
354 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
355 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
356 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
357 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
361 static const struct option split_options[] = {
362 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
366 static const struct option unmount_options[] = {
367 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
368 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
369 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
370 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
371 {T("new-image"), no_argument, NULL, IMAGEX_NEW_IMAGE_OPTION},
375 static const struct option update_options[] = {
376 /* Careful: some of the options here set the defaults for update
377 * commands, but the flags given to an actual update command (and not to
378 * `imagex update' itself are also handled in
379 * update_command_add_option(). */
380 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
381 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
382 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
383 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
384 {T("wimboot-config"), required_argument, NULL, IMAGEX_WIMBOOT_CONFIG_OPTION},
386 /* Default delete options */
387 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
388 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
390 /* Global add option */
391 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
393 /* Default add options */
394 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
395 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
396 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
397 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
398 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
399 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
400 {T("no-replace"), no_argument, NULL, IMAGEX_NO_REPLACE_OPTION},
406 # define _format_attribute(type, format_str, args_start) \
407 __attribute__((format(type, format_str, args_start)))
409 # define _format_attribute(type, format_str, args_start)
412 /* Print formatted error message to stderr. */
413 static void _format_attribute(printf, 1, 2)
414 imagex_error(const tchar *format, ...)
417 va_start(va, format);
418 tfputs(T("ERROR: "), stderr);
419 tvfprintf(stderr, format, va);
420 tputc(T('\n'), stderr);
424 /* Print formatted error message to stderr. */
425 static void _format_attribute(printf, 1, 2)
426 imagex_error_with_errno(const tchar *format, ...)
428 int errno_save = errno;
430 va_start(va, format);
431 tfputs(T("ERROR: "), stderr);
432 tvfprintf(stderr, format, va);
433 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
438 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
440 if (image == WIMLIB_NO_IMAGE) {
441 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
442 " Please specify a 1-based image index or "
443 "image name. To list the images\n"
444 " contained in the WIM archive, run\n"
446 " %"TS" \"%"TS"\"\n"),
447 image_name, wim_name,
448 get_cmd_string(CMD_INFO, false), wim_name);
449 return WIMLIB_ERR_INVALID_IMAGE;
455 verify_image_is_single(int image)
457 if (image == WIMLIB_ALL_IMAGES) {
458 imagex_error(T("Cannot specify all images for this action!"));
459 return WIMLIB_ERR_INVALID_IMAGE;
465 verify_image_exists_and_is_single(int image, const tchar *image_name,
466 const tchar *wim_name)
469 ret = verify_image_exists(image, image_name, wim_name);
471 ret = verify_image_is_single(image);
475 /* Parse the argument to --compress */
477 get_compression_type(const tchar *optarg)
479 if (!tstrcasecmp(optarg, T("maximum")) ||
480 !tstrcasecmp(optarg, T("lzx")) ||
481 !tstrcasecmp(optarg, T("max")))
482 return WIMLIB_COMPRESSION_TYPE_LZX;
483 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
484 return WIMLIB_COMPRESSION_TYPE_XPRESS;
485 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
486 return WIMLIB_COMPRESSION_TYPE_LZMS;
487 else if (!tstrcasecmp(optarg, T("none")))
488 return WIMLIB_COMPRESSION_TYPE_NONE;
490 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
491 "\"maximum\", \"fast\", or \"none\"."), optarg);
492 return WIMLIB_COMPRESSION_TYPE_INVALID;
497 set_compress_slow(void)
499 static const struct wimlib_lzx_compressor_params lzx_slow_params = {
501 .size = sizeof(struct wimlib_lzx_compressor_params),
503 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
506 .use_len2_matches = 1,
507 .nice_match_length = 96,
508 .num_optim_passes = 4,
509 .max_search_depth = 100,
510 .max_matches_per_pos = 10,
511 .main_nostat_cost = 15,
512 .len_nostat_cost = 15,
513 .aligned_nostat_cost = 7,
518 static const struct wimlib_lzms_compressor_params lzms_slow_params = {
520 .size = sizeof(struct wimlib_lzms_compressor_params),
522 .min_match_length = 2,
523 .max_match_length = UINT32_MAX,
524 .nice_match_length = 96,
525 .max_search_depth = 100,
526 .max_matches_per_pos = 10,
527 .optim_array_length = 1024,
530 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
531 &lzx_slow_params.hdr);
533 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZMS,
534 &lzms_slow_params.hdr);
538 const tchar **strings;
539 unsigned num_strings;
540 unsigned num_alloc_strings;
543 #define STRING_SET_INITIALIZER \
544 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
546 #define STRING_SET(_strings) \
547 struct string_set _strings = STRING_SET_INITIALIZER
550 string_set_append(struct string_set *set, const tchar *glob)
552 unsigned num_alloc_strings = set->num_alloc_strings;
554 if (set->num_strings == num_alloc_strings) {
555 const tchar **new_strings;
557 num_alloc_strings += 4;
558 new_strings = realloc(set->strings,
559 sizeof(set->strings[0]) * num_alloc_strings);
561 imagex_error(T("Out of memory!"));
564 set->strings = new_strings;
565 set->num_alloc_strings = num_alloc_strings;
567 set->strings[set->num_strings++] = glob;
572 string_set_destroy(struct string_set *set)
578 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
580 return wimlib_reference_resource_files(wim, set->strings,
582 WIMLIB_REF_FLAG_GLOB_ENABLE,
584 imagex_progress_func);
588 do_resource_not_found_warning(const tchar *wimfile,
589 const struct wimlib_wim_info *info,
590 const struct string_set *refglobs)
592 if (info->total_parts > 1) {
593 if (refglobs->num_strings == 0) {
594 imagex_error(T("\"%"TS"\" is part of a split WIM. "
595 "Use --ref to specify the other parts."),
598 imagex_error(T("Perhaps the '--ref' argument did not "
599 "specify all other parts of the split "
603 imagex_error(T("If this is a delta WIM, use the --ref argument "
604 "to specify the WIM(s) on which it is based."));
608 /* Returns the size of a file given its name, or -1 if the file does not exist
609 * or its size cannot be determined. */
611 file_get_size(const tchar *filename)
614 if (tstat(filename, &st) == 0)
621 PARSE_STRING_SUCCESS = 0,
622 PARSE_STRING_FAILURE = 1,
623 PARSE_STRING_NONE = 2,
627 * Parses a string token from an array of characters.
629 * Tokens are either whitespace-delimited, or double or single-quoted.
631 * @line_p: Pointer to the pointer to the line of data. Will be updated
632 * to point past the string token iff the return value is
633 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
636 * @len_p: @len_p initially stores the length of the line of data, which may
637 * be 0, and it will be updated to the number of bytes remaining in
638 * the line iff the return value is PARSE_STRING_SUCCESS.
640 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
641 * parsed string token will be returned here.
643 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
644 * PARSE_STRING_FAILURE if the data was invalid due to a missing
645 * closing quote; or PARSE_STRING_NONE if the line ended before the
646 * beginning of a string token was found.
649 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
652 tchar *line = *line_p;
656 /* Skip leading whitespace */
659 return PARSE_STRING_NONE;
660 if (!istspace(*line) && *line != T('\0'))
666 if (quote_char == T('"') || quote_char == T('\'')) {
671 line = tmemchr(line, quote_char, len);
673 imagex_error(T("Missing closing quote: %"TS), fn - 1);
674 return PARSE_STRING_FAILURE;
677 /* Unquoted string. Go until whitespace. Line is terminated
678 * by '\0', so no need to check 'len'. */
682 } while (!istspace(*line) && *line != T('\0'));
689 return PARSE_STRING_SUCCESS;
692 /* Parses a line of data (not an empty line or comment) in the source list file
693 * format. (See the man page for 'wimlib-imagex capture' for details on this
694 * format and the meaning.)
696 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
697 * len == 0. The data in @line will be modified by this function call.
699 * @len: Length of the line of data.
701 * @source: On success, the capture source and target described by the line is
702 * written into this destination. Note that it will contain pointers
703 * to data in the @line array.
705 * Returns true if the line was valid; false otherwise. */
707 parse_source_list_line(tchar *line, size_t len,
708 struct wimlib_capture_source *source)
712 ret = parse_string(&line, &len, &source->fs_source_path);
713 if (ret != PARSE_STRING_SUCCESS)
715 ret = parse_string(&line, &len, &source->wim_target_path);
716 if (ret == PARSE_STRING_NONE)
717 source->wim_target_path = source->fs_source_path;
718 return ret != PARSE_STRING_FAILURE;
721 /* Returns %true if the given line of length @len > 0 is a comment or empty line
722 * in the source list file format. */
724 is_comment_line(const tchar *line, size_t len)
727 if (*line == T('#') || *line == T(';'))
729 if (!istspace(*line) && *line != T('\0'))
739 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
742 tchar *contents = *contents_p;
743 size_t nchars = *nchars_p;
746 for (i = 0; i < nchars; i++)
747 if (contents[i] == T('\n'))
750 /* Handle last line not terminated by a newline */
751 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
752 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
754 imagex_error(T("Out of memory!"));
757 contents[nchars] = T('\n');
758 *contents_p = contents;
766 /* Parses a file in the source list format. (See the man page for
767 * 'wimlib-imagex capture' for details on this format and the meaning.)
769 * @source_list_contents: Contents of the source list file. Note that this
770 * buffer will be modified to save memory allocations,
771 * and cannot be freed until the returned array of
772 * wimlib_capture_source's has also been freed.
774 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
777 * @nsources_ret: On success, the length of the returned array is
780 * Returns: An array of `struct wimlib_capture_source's that can be passed to
781 * the wimlib_add_image_multisource() function to specify how a WIM image is to
783 static struct wimlib_capture_source *
784 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
785 size_t *nsources_ret)
789 struct wimlib_capture_source *sources;
792 nlines = text_file_count_lines(source_list_contents_p,
793 &source_list_nchars);
797 /* Always allocate at least 1 slot, just in case the implementation of
798 * calloc() returns NULL if 0 bytes are requested. */
799 sources = calloc(nlines ?: 1, sizeof(*sources));
801 imagex_error(T("out of memory"));
804 p = *source_list_contents_p;
806 for (i = 0; i < nlines; i++) {
807 /* XXX: Could use rawmemchr() here instead, but it may not be
808 * available on all platforms. */
809 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
810 size_t len = endp - p + 1;
812 if (!is_comment_line(p, len)) {
813 if (!parse_source_list_line(p, len, &sources[j++])) {
825 /* Reads the contents of a file into memory. */
827 file_get_contents(const tchar *filename, size_t *len_ret)
834 if (tstat(filename, &stbuf) != 0) {
835 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
840 fp = tfopen(filename, T("rb"));
842 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
846 buf = malloc(len ? len : 1);
848 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
849 "contents of file \"%"TS"\""), len, filename);
852 if (fread(buf, 1, len, fp) != len) {
853 imagex_error_with_errno(T("Failed to read %zu bytes from the "
854 "file \"%"TS"\""), len, filename);
868 /* Read standard input until EOF and return the full contents in a malloc()ed
869 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
872 stdin_get_contents(size_t *len_ret)
874 /* stdin can, of course, be a pipe or other non-seekable file, so the
875 * total length of the data cannot be pre-determined */
877 size_t newlen = 1024;
881 char *p = realloc(buf, newlen);
882 size_t bytes_read, bytes_to_read;
884 imagex_error(T("out of memory while reading stdin"));
888 bytes_to_read = newlen - pos;
889 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
891 if (bytes_read != bytes_to_read) {
896 imagex_error_with_errno(T("error reading stdin"));
910 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
913 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
915 *num_tchars_ret = num_bytes;
917 #else /* !__WIN32__ */
918 /* On Windows, translate the text to UTF-16LE */
922 if (num_bytes >= 2 &&
923 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
924 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
926 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
927 * with something that looks like an ASCII character encoded as
928 * a UTF-16LE code unit. Assume the file is encoded as
929 * UTF-16LE. This is not a 100% reliable check. */
930 num_wchars = num_bytes / 2;
931 text_wstr = (wchar_t*)text;
933 /* File does not look like UTF-16LE. Assume it is encoded in
934 * the current Windows code page. I think these are always
935 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
936 * should work as expected. */
937 text_wstr = win32_mbs_to_wcs(text,
942 *num_tchars_ret = num_wchars;
944 #endif /* __WIN32__ */
948 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
953 contents = file_get_contents(filename, &num_bytes);
956 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
960 stdin_get_text_contents(size_t *num_tchars_ret)
965 contents = stdin_get_contents(&num_bytes);
968 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
971 #define TO_PERCENT(numerator, denominator) \
972 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
974 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
975 #define MEBIBYTE_MIN_NBYTES 10000000ULL
976 #define KIBIBYTE_MIN_NBYTES 10000ULL
979 get_unit(uint64_t total_bytes, const tchar **name_ret)
981 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
982 *name_ret = T("GiB");
984 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
985 *name_ret = T("MiB");
987 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
988 *name_ret = T("KiB");
991 *name_ret = T("bytes");
996 static struct wimlib_progress_info_scan last_scan_progress;
999 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1001 uint64_t prev_count, cur_count;
1003 prev_count = last_scan_progress.num_nondirs_scanned +
1004 last_scan_progress.num_dirs_scanned;
1005 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1007 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1008 cur_count % 128 == 0)
1010 unsigned unit_shift;
1011 const tchar *unit_name;
1013 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1014 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1015 "%"PRIu64" directories) "),
1016 scan->num_bytes_scanned >> unit_shift,
1018 scan->num_nondirs_scanned,
1019 scan->num_dirs_scanned);
1020 last_scan_progress = *scan;
1024 /* Progress callback function passed to various wimlib functions. */
1026 imagex_progress_func(enum wimlib_progress_msg msg,
1027 const union wimlib_progress_info *info)
1029 unsigned percent_done;
1030 unsigned unit_shift;
1031 const tchar *unit_name;
1033 if (imagex_be_quiet)
1036 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1038 static bool first = true;
1040 imagex_printf(T("Writing %"TS"-compressed data "
1041 "using %u thread%"TS"\n"),
1042 wimlib_get_compression_type_string(
1043 info->write_streams.compression_type),
1044 info->write_streams.num_threads,
1045 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1049 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1050 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1051 info->write_streams.total_bytes);
1053 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1054 "written (%u%% done)"),
1055 info->write_streams.completed_bytes >> unit_shift,
1057 info->write_streams.total_bytes >> unit_shift,
1060 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1061 imagex_printf(T("\n"));
1063 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1064 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1065 if (WIMLIB_IS_WIM_ROOT_PATH(info->scan.wim_target_path)) {
1066 imagex_printf(T("\n"));
1068 imagex_printf(T(" (loading as WIM path: \"%"TS"\")...\n"),
1069 info->scan.wim_target_path);
1071 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1073 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1074 switch (info->scan.status) {
1075 case WIMLIB_SCAN_DENTRY_OK:
1076 report_scan_progress(&info->scan, false);
1078 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1079 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1081 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1082 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1083 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1085 case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK:
1086 imagex_printf(T("\nWARNING: Ignoring absolute symbolic link "
1087 "with out-of-tree target:\n"
1088 " \"%"TS"\" => \"%"TS"\"\n"
1089 " (Use --norpfix to capture "
1090 "absolute symbolic links as-is)\n"),
1091 info->scan.cur_path, info->scan.symlink_target);
1095 case WIMLIB_PROGRESS_MSG_SCAN_END:
1096 report_scan_progress(&info->scan, true);
1097 imagex_printf(T("\n"));
1099 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1100 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1101 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1102 info->integrity.total_bytes);
1103 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1104 "of %"PRIu64" %"TS" (%u%%) done"),
1105 info->integrity.filename,
1106 info->integrity.completed_bytes >> unit_shift,
1108 info->integrity.total_bytes >> unit_shift,
1111 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1112 imagex_printf(T("\n"));
1114 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1115 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1116 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1117 info->integrity.total_bytes);
1118 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1119 "of %"PRIu64" %"TS" (%u%%) done"),
1120 info->integrity.completed_bytes >> unit_shift,
1122 info->integrity.total_bytes >> unit_shift,
1125 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1126 imagex_printf(T("\n"));
1128 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1129 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1130 "to %"TS" \"%"TS"\"\n"),
1131 info->extract.image,
1132 info->extract.image_name,
1133 info->extract.wimfile_name,
1134 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1135 T("NTFS volume") : T("directory")),
1136 info->extract.target);
1138 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1139 percent_done = TO_PERCENT(info->extract.completed_bytes,
1140 info->extract.total_bytes);
1141 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1142 imagex_printf(T("\rExtracting files: "
1143 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1144 info->extract.completed_bytes >> unit_shift,
1146 info->extract.total_bytes >> unit_shift,
1149 if (info->extract.completed_bytes >= info->extract.total_bytes)
1150 imagex_printf(T("\n"));
1152 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1153 if (info->extract.total_parts != 1) {
1154 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1155 info->extract.part_number,
1156 info->extract.total_parts);
1159 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1160 percent_done = TO_PERCENT(info->split.completed_bytes,
1161 info->split.total_bytes);
1162 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1163 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1164 "%"PRIu64" %"TS" (%u%%) written\n"),
1165 info->split.part_name,
1166 info->split.cur_part_number,
1167 info->split.total_parts,
1168 info->split.completed_bytes >> unit_shift,
1170 info->split.total_bytes >> unit_shift,
1174 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1175 if (info->split.completed_bytes == info->split.total_bytes) {
1176 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1177 info->split.cur_part_number,
1178 info->split.total_parts);
1181 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1182 switch (info->update.command->op) {
1183 case WIMLIB_UPDATE_OP_DELETE:
1184 imagex_printf(T("Deleted WIM path \"%"TS"\"\n"),
1185 info->update.command->delete_.wim_path);
1187 case WIMLIB_UPDATE_OP_RENAME:
1188 imagex_printf(T("Renamed WIM path \"%"TS"\" => \"%"TS"\"\n"),
1189 info->update.command->rename.wim_source_path,
1190 info->update.command->rename.wim_target_path);
1192 case WIMLIB_UPDATE_OP_ADD:
1197 case WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM:
1198 imagex_printf(T("Updating \"%"TS"\" in WIM image\n"),
1199 info->replace.path_in_wim);
1201 case WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE:
1202 imagex_printf(T("\nExtracting \"%"TS"\" as normal file (not WIMBoot pointer)\n"),
1203 info->wimboot_exclude.path_in_wim);
1208 fflush(imagex_info_file);
1213 parse_num_threads(const tchar *optarg)
1216 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1217 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1218 imagex_error(T("Number of threads must be a non-negative integer!"));
1225 static uint32_t parse_chunk_size(const tchar *optarg)
1228 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1229 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1230 imagex_error(T("Chunk size must be a non-negative integer!"));
1239 * Parse an option passed to an update command.
1241 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1244 * @option: Text string for the option (beginning with --)
1246 * @cmd: `struct wimlib_update_command' that is being constructed for
1249 * Returns true if the option was recognized; false if not.
1252 update_command_add_option(int op, const tchar *option,
1253 struct wimlib_update_command *cmd)
1255 bool recognized = true;
1257 case WIMLIB_UPDATE_OP_ADD:
1258 if (!tstrcmp(option, T("--verbose")))
1259 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1260 else if (!tstrcmp(option, T("--unix-data")))
1261 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1262 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1263 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1264 else if (!tstrcmp(option, T("--strict-acls")))
1265 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1266 else if (!tstrcmp(option, T("--dereference")))
1267 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1268 else if (!tstrcmp(option, T("--no-replace")))
1269 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
1273 case WIMLIB_UPDATE_OP_DELETE:
1274 if (!tstrcmp(option, T("--force")))
1275 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1276 else if (!tstrcmp(option, T("--recursive")))
1277 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1288 /* How many nonoption arguments each `imagex update' command expects */
1289 static const unsigned update_command_num_nonoptions[] = {
1290 [WIMLIB_UPDATE_OP_ADD] = 2,
1291 [WIMLIB_UPDATE_OP_DELETE] = 1,
1292 [WIMLIB_UPDATE_OP_RENAME] = 2,
1296 update_command_add_nonoption(int op, const tchar *nonoption,
1297 struct wimlib_update_command *cmd,
1298 unsigned num_nonoptions)
1301 case WIMLIB_UPDATE_OP_ADD:
1302 if (num_nonoptions == 0)
1303 cmd->add.fs_source_path = (tchar*)nonoption;
1305 cmd->add.wim_target_path = (tchar*)nonoption;
1307 case WIMLIB_UPDATE_OP_DELETE:
1308 cmd->delete_.wim_path = (tchar*)nonoption;
1310 case WIMLIB_UPDATE_OP_RENAME:
1311 if (num_nonoptions == 0)
1312 cmd->rename.wim_source_path = (tchar*)nonoption;
1314 cmd->rename.wim_target_path = (tchar*)nonoption;
1320 * Parse a command passed on stdin to `imagex update'.
1322 * @line: Text of the command.
1323 * @len: Length of the line, including a null terminator
1326 * @command: A `struct wimlib_update_command' to fill in from the parsed
1329 * @line_number: Line number of the command, for diagnostics.
1331 * Returns true on success; returns false on parse error.
1334 parse_update_command(tchar *line, size_t len,
1335 struct wimlib_update_command *command,
1339 tchar *command_name;
1341 size_t num_nonoptions;
1343 /* Get the command name ("add", "delete", "rename") */
1344 ret = parse_string(&line, &len, &command_name);
1345 if (ret != PARSE_STRING_SUCCESS)
1348 if (!tstrcasecmp(command_name, T("add"))) {
1349 op = WIMLIB_UPDATE_OP_ADD;
1350 } else if (!tstrcasecmp(command_name, T("delete"))) {
1351 op = WIMLIB_UPDATE_OP_DELETE;
1352 } else if (!tstrcasecmp(command_name, T("rename"))) {
1353 op = WIMLIB_UPDATE_OP_RENAME;
1355 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1356 command_name, line_number);
1361 /* Parse additional options and non-options as needed */
1366 ret = parse_string(&line, &len, &next_string);
1367 if (ret == PARSE_STRING_NONE) /* End of line */
1369 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1371 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1373 if (!update_command_add_option(op, next_string, command))
1375 imagex_error(T("Unrecognized option \"%"TS"\" to "
1376 "update command \"%"TS"\" on line %zu"),
1377 next_string, command_name, line_number);
1383 if (num_nonoptions == update_command_num_nonoptions[op])
1385 imagex_error(T("Unexpected argument \"%"TS"\" in "
1386 "update command on line %zu\n"
1387 " (The \"%"TS"\" command only "
1388 "takes %zu nonoption arguments!)\n"),
1389 next_string, line_number,
1390 command_name, num_nonoptions);
1393 update_command_add_nonoption(op, next_string,
1394 command, num_nonoptions);
1399 if (num_nonoptions != update_command_num_nonoptions[op]) {
1400 imagex_error(T("Not enough arguments to update command "
1401 "\"%"TS"\" on line %zu"), command_name, line_number);
1407 static struct wimlib_update_command *
1408 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1409 size_t *num_cmds_ret)
1413 struct wimlib_update_command *cmds;
1416 nlines = text_file_count_lines(cmd_file_contents_p,
1421 /* Always allocate at least 1 slot, just in case the implementation of
1422 * calloc() returns NULL if 0 bytes are requested. */
1423 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1425 imagex_error(T("out of memory"));
1428 p = *cmd_file_contents_p;
1430 for (i = 0; i < nlines; i++) {
1431 /* XXX: Could use rawmemchr() here instead, but it may not be
1432 * available on all platforms. */
1433 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1434 size_t len = endp - p + 1;
1436 if (!is_comment_line(p, len)) {
1437 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1448 /* Apply one image, or all images, from a WIM file to a directory, OR apply
1449 * one image from a WIM file to an NTFS volume. */
1451 imagex_apply(int argc, tchar **argv, int cmd)
1455 int image = WIMLIB_NO_IMAGE;
1457 struct wimlib_wim_info info;
1459 const tchar *wimfile;
1460 const tchar *target;
1461 const tchar *image_num_or_name = NULL;
1462 int extract_flags = 0;
1464 STRING_SET(refglobs);
1466 for_opt(c, apply_options) {
1468 case IMAGEX_CHECK_OPTION:
1469 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1471 case IMAGEX_VERBOSE_OPTION:
1472 /* No longer does anything. */
1474 case IMAGEX_REF_OPTION:
1475 ret = string_set_append(&refglobs, optarg);
1477 goto out_free_refglobs;
1479 case IMAGEX_UNIX_DATA_OPTION:
1480 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1482 case IMAGEX_NO_ACLS_OPTION:
1483 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1485 case IMAGEX_STRICT_ACLS_OPTION:
1486 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1488 case IMAGEX_NO_ATTRIBUTES_OPTION:
1489 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
1491 case IMAGEX_NORPFIX_OPTION:
1492 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1494 case IMAGEX_RPFIX_OPTION:
1495 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1497 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1498 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1499 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1501 case IMAGEX_RESUME_OPTION:
1502 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1504 case IMAGEX_WIMBOOT_OPTION:
1505 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
1513 if (argc != 2 && argc != 3)
1518 if (!tstrcmp(wimfile, T("-"))) {
1519 /* Attempt to apply pipable WIM from standard input. */
1521 image_num_or_name = NULL;
1524 image_num_or_name = argv[1];
1529 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1530 imagex_progress_func);
1532 goto out_free_refglobs;
1534 wimlib_get_wim_info(wim, &info);
1537 /* Image explicitly specified. */
1538 image_num_or_name = argv[1];
1539 image = wimlib_resolve_image(wim, image_num_or_name);
1540 ret = verify_image_exists(image, image_num_or_name, wimfile);
1542 goto out_wimlib_free;
1545 /* No image specified; default to image 1, but only if the WIM
1546 * contains exactly one image. */
1548 if (info.image_count != 1) {
1549 imagex_error(T("\"%"TS"\" contains %d images; "
1550 "Please select one (or all)."),
1551 wimfile, info.image_count);
1560 if (refglobs.num_strings) {
1562 imagex_error(T("Can't specify --ref when applying from stdin!"));
1564 goto out_wimlib_free;
1566 ret = wim_reference_globs(wim, &refglobs, open_flags);
1568 goto out_wimlib_free;
1573 /* Interpret a regular file or block device target as an NTFS
1577 if (tstat(target, &stbuf)) {
1578 if (errno != ENOENT) {
1579 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1582 goto out_wimlib_free;
1585 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1586 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1592 ret = wimlib_extract_image(wim, image, target, extract_flags,
1593 imagex_progress_func);
1595 set_fd_to_binary_mode(STDIN_FILENO);
1596 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1598 target, extract_flags,
1599 imagex_progress_func);
1602 imagex_printf(T("Done applying WIM image.\n"));
1603 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1605 do_resource_not_found_warning(wimfile, &info, &refglobs);
1607 imagex_error(T( "If you are applying an image "
1608 "from a split pipable WIM,\n"
1609 " make sure you have "
1610 "concatenated together all parts."));
1616 string_set_destroy(&refglobs);
1620 usage(CMD_APPLY, stderr);
1622 goto out_free_refglobs;
1625 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1626 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1627 * the desired image. 'wimlib-imagex append': add a new image to an existing
1630 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1633 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1634 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1635 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1636 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1637 int write_flags = 0;
1638 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1639 uint32_t chunk_size = UINT32_MAX;
1640 uint32_t pack_chunk_size = UINT32_MAX;
1641 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
1642 const tchar *wimfile;
1646 const tchar *flags_element = NULL;
1649 STRING_SET(base_wimfiles);
1650 WIMStruct **base_wims;
1652 WIMStruct *template_wim;
1653 const tchar *template_wimfile = NULL;
1654 const tchar *template_image_name_or_num = NULL;
1655 int template_image = WIMLIB_NO_IMAGE;
1658 unsigned num_threads = 0;
1663 tchar *config_file = NULL;
1665 bool source_list = false;
1666 size_t source_list_nchars = 0;
1667 tchar *source_list_contents;
1668 bool capture_sources_malloced;
1669 struct wimlib_capture_source *capture_sources;
1671 bool name_defaulted;
1672 bool compress_slow = false;
1674 for_opt(c, capture_or_append_options) {
1676 case IMAGEX_BOOT_OPTION:
1677 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1679 case IMAGEX_CHECK_OPTION:
1680 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1681 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1683 case IMAGEX_NOCHECK_OPTION:
1684 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1686 case IMAGEX_CONFIG_OPTION:
1687 config_file = optarg;
1688 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1690 case IMAGEX_COMPRESS_OPTION:
1691 compression_type = get_compression_type(optarg);
1692 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1695 case IMAGEX_COMPRESS_SLOW_OPTION:
1696 compress_slow = true;
1698 case IMAGEX_CHUNK_SIZE_OPTION:
1699 chunk_size = parse_chunk_size(optarg);
1700 if (chunk_size == UINT32_MAX)
1703 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
1704 pack_chunk_size = parse_chunk_size(optarg);
1705 if (pack_chunk_size == UINT32_MAX)
1708 case IMAGEX_PACK_COMPRESS_OPTION:
1709 pack_ctype = get_compression_type(optarg);
1710 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
1713 case IMAGEX_PACK_STREAMS_OPTION:
1714 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1716 case IMAGEX_FLAGS_OPTION:
1717 flags_element = optarg;
1719 case IMAGEX_DEREFERENCE_OPTION:
1720 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1722 case IMAGEX_VERBOSE_OPTION:
1723 /* No longer does anything. */
1725 case IMAGEX_THREADS_OPTION:
1726 num_threads = parse_num_threads(optarg);
1727 if (num_threads == UINT_MAX)
1730 case IMAGEX_REBUILD_OPTION:
1731 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1733 case IMAGEX_UNIX_DATA_OPTION:
1734 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1736 case IMAGEX_SOURCE_LIST_OPTION:
1739 case IMAGEX_NO_ACLS_OPTION:
1740 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1742 case IMAGEX_STRICT_ACLS_OPTION:
1743 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1745 case IMAGEX_RPFIX_OPTION:
1746 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1748 case IMAGEX_NORPFIX_OPTION:
1749 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1751 case IMAGEX_PIPABLE_OPTION:
1752 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1754 case IMAGEX_NOT_PIPABLE_OPTION:
1755 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1757 case IMAGEX_UPDATE_OF_OPTION:
1758 if (template_image_name_or_num) {
1759 imagex_error(T("'--update-of' can only be "
1760 "specified one time!"));
1764 colon = tstrrchr(optarg, T(':'));
1767 template_wimfile = optarg;
1769 template_image_name_or_num = colon + 1;
1771 template_wimfile = NULL;
1772 template_image_name_or_num = optarg;
1776 case IMAGEX_DELTA_FROM_OPTION:
1777 if (cmd != CMD_CAPTURE) {
1778 imagex_error(T("'--delta-from' is only "
1779 "valid for capture!"));
1782 ret = string_set_append(&base_wimfiles, optarg);
1784 goto out_free_base_wimfiles;
1785 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1787 case IMAGEX_WIMBOOT_OPTION:
1788 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_WIMBOOT;
1797 if (argc < 2 || argc > 4)
1803 /* Set default compression type and parameters. */
1806 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1807 /* No compression type specified. Use the default. */
1809 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) {
1810 /* With --wimboot, default to XPRESS compression. */
1811 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
1812 } else if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS) {
1813 /* With --pack-streams or --solid, default to LZMS
1814 * compression. (However, this will not affect packed
1816 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
1818 /* Otherwise, default to LZX compression in fast mode.
1820 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1821 if (!compress_slow && pack_ctype != WIMLIB_COMPRESSION_TYPE_LZX) {
1822 struct wimlib_lzx_compressor_params params = {
1823 .hdr.size = sizeof(params),
1824 .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
1827 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1834 set_compress_slow();
1836 if (!tstrcmp(wimfile, T("-"))) {
1837 /* Writing captured WIM to standard output. */
1839 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1840 imagex_error("Can't write a non-pipable WIM to "
1841 "standard output! Specify --pipable\n"
1842 " if you want to create a pipable WIM "
1843 "(but read the docs first).");
1847 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1849 if (cmd == CMD_APPEND) {
1850 imagex_error(T("Using standard output for append does "
1851 "not make sense."));
1854 wim_fd = STDOUT_FILENO;
1856 imagex_info_file = stderr;
1857 set_fd_to_binary_mode(wim_fd);
1860 /* If template image was specified using --update-of=IMAGE rather
1861 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1862 if (template_image_name_or_num && !template_wimfile) {
1863 if (base_wimfiles.num_strings == 1) {
1864 /* Capturing delta WIM based on single WIM: default to
1866 template_wimfile = base_wimfiles.strings[0];
1867 } else if (cmd == CMD_APPEND) {
1868 /* Appending to WIM: default to WIM being appended to.
1870 template_wimfile = wimfile;
1872 /* Capturing a normal (non-delta) WIM, so the WIM file
1873 * *must* be explicitly specified. */
1874 if (base_wimfiles.num_strings > 1) {
1875 imagex_error(T("For capture of delta WIM "
1876 "based on multiple existing "
1878 " '--update-of' must "
1879 "specify WIMFILE:IMAGE!"));
1881 imagex_error(T("For capture of non-delta WIM, "
1882 "'--update-of' must specify "
1891 name_defaulted = false;
1893 /* Set default name to SOURCE argument, omitting any directory
1894 * prefixes and trailing slashes. This requires making a copy
1895 * of @source. Leave some free characters at the end in case we
1896 * append a number to keep the name unique. */
1897 size_t source_name_len;
1899 source_name_len = tstrlen(source);
1900 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1901 name = tbasename(tstrcpy(source_copy, source));
1902 name_defaulted = true;
1904 /* Image description defaults to NULL if not given. */
1911 /* Set up capture sources in source list mode */
1912 if (source[0] == T('-') && source[1] == T('\0')) {
1913 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1915 source_list_contents = file_get_text_contents(source,
1916 &source_list_nchars);
1918 if (!source_list_contents)
1921 capture_sources = parse_source_list(&source_list_contents,
1924 if (!capture_sources) {
1926 goto out_free_source_list_contents;
1928 capture_sources_malloced = true;
1930 /* Set up capture source in non-source-list mode. */
1931 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1932 capture_sources[0].fs_source_path = source;
1933 capture_sources[0].wim_target_path = WIMLIB_WIM_ROOT_PATH;
1934 capture_sources[0].reserved = 0;
1936 capture_sources_malloced = false;
1937 source_list_contents = NULL;
1940 /* Open the existing WIM, or create a new one. */
1941 if (cmd == CMD_APPEND)
1942 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1943 imagex_progress_func);
1945 ret = wimlib_create_new_wim(compression_type, &wim);
1947 goto out_free_capture_sources;
1949 /* Set chunk size if non-default. */
1950 if (chunk_size != UINT32_MAX) {
1951 ret = wimlib_set_output_chunk_size(wim, chunk_size);
1954 } else if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) &&
1955 compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS) {
1956 ret = wimlib_set_output_chunk_size(wim, 4096);
1960 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
1961 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
1965 if (pack_chunk_size != UINT32_MAX) {
1966 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
1972 /* Detect if source is regular file or block device and set NTFS volume
1977 if (tstat(source, &stbuf) == 0) {
1978 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1979 imagex_printf(T("Capturing WIM image from NTFS "
1980 "filesystem on \"%"TS"\"\n"), source);
1981 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1984 if (errno != ENOENT) {
1985 imagex_error_with_errno(T("Failed to stat "
1986 "\"%"TS"\""), source);
1994 /* If the user did not specify an image name, and the basename of the
1995 * source already exists as an image name in the WIM file, append a
1996 * suffix to make it unique. */
1997 if (cmd == CMD_APPEND && name_defaulted) {
1998 unsigned long conflict_idx;
1999 tchar *name_end = tstrchr(name, T('\0'));
2000 for (conflict_idx = 1;
2001 wimlib_image_name_in_use(wim, name);
2004 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2008 /* If capturing a delta WIM, reference resources from the base WIMs
2009 * before adding the new image. */
2010 if (base_wimfiles.num_strings) {
2011 base_wims = calloc(base_wimfiles.num_strings,
2012 sizeof(base_wims[0]));
2013 if (base_wims == NULL) {
2014 imagex_error(T("Out of memory!"));
2019 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2020 ret = wimlib_open_wim(base_wimfiles.strings[i],
2021 open_flags, &base_wims[i],
2022 imagex_progress_func);
2024 goto out_free_base_wims;
2028 ret = wimlib_reference_resources(wim, base_wims,
2029 base_wimfiles.num_strings, 0);
2031 goto out_free_base_wims;
2033 if (base_wimfiles.num_strings == 1) {
2034 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2035 base_wimfiles.strings[0]);
2037 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2038 base_wimfiles.num_strings);
2045 /* If capturing or appending as an update of an existing (template) image,
2046 * open the WIM if needed and parse the image index. */
2047 if (template_image_name_or_num) {
2050 if (base_wimfiles.num_strings == 1 &&
2051 template_wimfile == base_wimfiles.strings[0]) {
2052 template_wim = base_wims[0];
2053 } else if (template_wimfile == wimfile) {
2056 ret = wimlib_open_wim(template_wimfile, open_flags,
2057 &template_wim, imagex_progress_func);
2059 goto out_free_base_wims;
2062 template_image = wimlib_resolve_image(template_wim,
2063 template_image_name_or_num);
2065 if (template_image_name_or_num[0] == T('-')) {
2068 struct wimlib_wim_info info;
2070 wimlib_get_wim_info(template_wim, &info);
2071 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2072 if (n >= 1 && n <= info.image_count &&
2074 tmp != template_image_name_or_num + 1)
2076 template_image = info.image_count - (n - 1);
2079 ret = verify_image_exists_and_is_single(template_image,
2080 template_image_name_or_num,
2083 goto out_free_template_wim;
2085 template_wim = NULL;
2088 ret = wimlib_add_image_multisource(wim,
2094 imagex_progress_func);
2096 goto out_free_template_wim;
2098 if (desc || flags_element || template_image_name_or_num) {
2099 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2100 * on which the added one is to be based has been specified with
2101 * --update-of. Get the index of the image we just
2102 * added, then use it to call the appropriate functions. */
2103 struct wimlib_wim_info info;
2105 wimlib_get_wim_info(wim, &info);
2108 ret = wimlib_set_image_descripton(wim,
2112 goto out_free_template_wim;
2115 if (flags_element) {
2116 ret = wimlib_set_image_flags(wim, info.image_count,
2119 goto out_free_template_wim;
2122 /* Reference template image if the user provided one. */
2123 if (template_image_name_or_num) {
2124 imagex_printf(T("Using image %d "
2125 "from \"%"TS"\" as template\n"),
2126 template_image, template_wimfile);
2127 ret = wimlib_reference_template_image(wim,
2133 goto out_free_template_wim;
2137 /* Write the new WIM or overwrite the existing WIM with the new image
2139 if (cmd == CMD_APPEND) {
2140 ret = wimlib_overwrite(wim, write_flags, num_threads,
2141 imagex_progress_func);
2142 } else if (wimfile) {
2143 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2144 write_flags, num_threads,
2145 imagex_progress_func);
2147 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2148 write_flags, num_threads,
2149 imagex_progress_func);
2151 out_free_template_wim:
2152 /* template_wim may alias base_wims[0] or wim. */
2153 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2154 template_wim != wim)
2155 wimlib_free(template_wim);
2157 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2158 wimlib_free(base_wims[i]);
2162 out_free_capture_sources:
2163 if (capture_sources_malloced)
2164 free(capture_sources);
2165 out_free_source_list_contents:
2166 free(source_list_contents);
2167 out_free_base_wimfiles:
2168 string_set_destroy(&base_wimfiles);
2175 goto out_free_base_wimfiles;
2178 /* Remove image(s) from a WIM. */
2180 imagex_delete(int argc, tchar **argv, int cmd)
2183 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2184 int write_flags = 0;
2185 const tchar *wimfile;
2186 const tchar *image_num_or_name;
2191 for_opt(c, delete_options) {
2193 case IMAGEX_CHECK_OPTION:
2194 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2195 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2197 case IMAGEX_SOFT_OPTION:
2198 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2209 imagex_error(T("Must specify a WIM file"));
2211 imagex_error(T("Must specify an image"));
2215 image_num_or_name = argv[1];
2217 ret = wimlib_open_wim(wimfile, open_flags, &wim,
2218 imagex_progress_func);
2222 image = wimlib_resolve_image(wim, image_num_or_name);
2224 ret = verify_image_exists(image, image_num_or_name, wimfile);
2226 goto out_wimlib_free;
2228 ret = wimlib_delete_image(wim, image);
2230 imagex_error(T("Failed to delete image from \"%"TS"\""),
2232 goto out_wimlib_free;
2235 ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2237 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2238 "deleted"), wimfile);
2246 usage(CMD_DELETE, stderr);
2251 struct print_dentry_options {
2256 print_dentry_full_path(const struct wimlib_dir_entry *dentry)
2258 tprintf(T("%"TS"\n"), dentry->full_path);
2261 static const struct {
2264 } file_attr_flags[] = {
2265 {WIMLIB_FILE_ATTRIBUTE_READONLY, T("READONLY")},
2266 {WIMLIB_FILE_ATTRIBUTE_HIDDEN, T("HIDDEN")},
2267 {WIMLIB_FILE_ATTRIBUTE_SYSTEM, T("SYSTEM")},
2268 {WIMLIB_FILE_ATTRIBUTE_DIRECTORY, T("DIRECTORY")},
2269 {WIMLIB_FILE_ATTRIBUTE_ARCHIVE, T("ARCHIVE")},
2270 {WIMLIB_FILE_ATTRIBUTE_DEVICE, T("DEVICE")},
2271 {WIMLIB_FILE_ATTRIBUTE_NORMAL, T("NORMAL")},
2272 {WIMLIB_FILE_ATTRIBUTE_TEMPORARY, T("TEMPORARY")},
2273 {WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE, T("SPARSE_FILE")},
2274 {WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT, T("REPARSE_POINT")},
2275 {WIMLIB_FILE_ATTRIBUTE_COMPRESSED, T("COMPRESSED")},
2276 {WIMLIB_FILE_ATTRIBUTE_OFFLINE, T("OFFLINE")},
2277 {WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED, T("NOT_CONTENT_INDEXED")},
2278 {WIMLIB_FILE_ATTRIBUTE_ENCRYPTED, T("ENCRYPTED")},
2279 {WIMLIB_FILE_ATTRIBUTE_VIRTUAL, T("VIRTUAL")},
2282 #define TIMESTR_MAX 100
2285 timespec_to_string(const struct timespec *spec, tchar *buf)
2287 time_t t = spec->tv_sec;
2290 tstrftime(buf, TIMESTR_MAX, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
2291 buf[TIMESTR_MAX - 1] = '\0';
2295 print_time(const tchar *type, const struct timespec *spec)
2297 tchar timestr[TIMESTR_MAX];
2299 timespec_to_string(spec, timestr);
2301 tprintf(T("%-20"TS"= %"TS"\n"), type, timestr);
2304 static void print_byte_field(const uint8_t field[], size_t len)
2307 tprintf(T("%02hhx"), *field++);
2311 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2313 tputs(T("WIM Information:"));
2314 tputs(T("----------------"));
2315 tprintf(T("Path: %"TS"\n"), wimfile);
2316 tprintf(T("GUID: 0x"));
2317 print_byte_field(info->guid, sizeof(info->guid));
2319 tprintf(T("Version: %u\n"), info->wim_version);
2320 tprintf(T("Image Count: %d\n"), info->image_count);
2321 tprintf(T("Compression: %"TS"\n"),
2322 wimlib_get_compression_type_string(info->compression_type));
2323 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2325 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2326 tprintf(T("Boot Index: %d\n"), info->boot_index);
2327 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2328 tprintf(T("Integrity Info: %"TS"\n"),
2329 info->has_integrity_table ? T("yes") : T("no"));
2330 tprintf(T("Relative path junction: %"TS"\n"),
2331 info->has_rpfix ? T("yes") : T("no"));
2332 tprintf(T("Pipable: %"TS"\n"),
2333 info->pipable ? T("yes") : T("no"));
2338 print_resource(const struct wimlib_resource_entry *resource,
2341 tprintf(T("Hash = 0x"));
2342 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2345 if (!resource->is_missing) {
2346 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2347 resource->uncompressed_size);
2348 if (resource->packed) {
2349 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2350 resource->raw_resource_compressed_size);
2352 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2353 resource->raw_resource_offset_in_wim);
2355 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2358 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2359 resource->compressed_size);
2361 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2365 tprintf(T("Part Number = %u\n"), resource->part_number);
2366 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2368 tprintf(T("Flags = "));
2369 if (resource->is_compressed)
2370 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2371 if (resource->is_metadata)
2372 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2373 if (resource->is_free)
2374 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2375 if (resource->is_spanned)
2376 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2377 if (resource->packed)
2378 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2386 print_lookup_table(WIMStruct *wim)
2388 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2392 default_print_security_descriptor(const uint8_t *sd, size_t size)
2394 tprintf(T("Security Descriptor = "));
2395 print_byte_field(sd, size);
2400 print_dentry_detailed(const struct wimlib_dir_entry *dentry)
2404 "----------------------------------------------------------------------------\n"));
2405 tprintf(T("Full Path = \"%"TS"\"\n"), dentry->full_path);
2406 if (dentry->dos_name)
2407 tprintf(T("Short Name = \"%"TS"\"\n"), dentry->dos_name);
2408 tprintf(T("Attributes = 0x%08x\n"), dentry->attributes);
2409 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
2410 if (file_attr_flags[i].flag & dentry->attributes)
2411 tprintf(T(" FILE_ATTRIBUTE_%"TS" is set\n"),
2412 file_attr_flags[i].name);
2414 if (dentry->security_descriptor) {
2415 print_security_descriptor(dentry->security_descriptor,
2416 dentry->security_descriptor_size);
2419 print_time(T("Creation Time"), &dentry->creation_time);
2420 print_time(T("Last Write Time"), &dentry->last_write_time);
2421 print_time(T("Last Access Time"), &dentry->last_access_time);
2424 if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT)
2425 tprintf(T("Reparse Tag = 0x%"PRIx32"\n"), dentry->reparse_tag);
2427 tprintf(T("Link Group ID = 0x%016"PRIx64"\n"), dentry->hard_link_group_id);
2428 tprintf(T("Link Count = %"PRIu32"\n"), dentry->num_links);
2430 if (dentry->unix_mode != 0) {
2431 tprintf(T("UNIX Data = uid:%"PRIu32" gid:%"PRIu32" mode:0%"PRIo32"\n"),
2432 dentry->unix_uid, dentry->unix_gid, dentry->unix_mode);
2435 for (uint32_t i = 0; i <= dentry->num_named_streams; i++) {
2436 if (dentry->streams[i].stream_name) {
2437 tprintf(T("\tData stream \"%"TS"\":\n"),
2438 dentry->streams[i].stream_name);
2440 tprintf(T("\tUnnamed data stream:\n"));
2442 print_resource(&dentry->streams[i].resource, NULL);
2447 print_dentry(const struct wimlib_dir_entry *dentry, void *_options)
2449 const struct print_dentry_options *options = _options;
2450 if (!options->detailed)
2451 print_dentry_full_path(dentry);
2453 print_dentry_detailed(dentry);
2457 /* Print the files contained in an image(s) in a WIM file. */
2459 imagex_dir(int argc, tchar **argv, int cmd)
2461 const tchar *wimfile;
2462 WIMStruct *wim = NULL;
2465 const tchar *path = WIMLIB_WIM_ROOT_PATH;
2467 struct print_dentry_options options = {
2470 int iterate_flags = WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2472 for_opt(c, dir_options) {
2474 case IMAGEX_PATH_OPTION:
2477 case IMAGEX_DETAILED_OPTION:
2478 options.detailed = true;
2480 case IMAGEX_ONE_FILE_ONLY_OPTION:
2481 iterate_flags &= ~WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2491 imagex_error(T("Must specify a WIM file"));
2495 imagex_error(T("Too many arguments"));
2500 ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2505 image = wimlib_resolve_image(wim, argv[1]);
2506 ret = verify_image_exists(image, argv[1], wimfile);
2508 goto out_wimlib_free;
2510 /* No image specified; default to image 1, but only if the WIM
2511 * contains exactly one image. */
2513 struct wimlib_wim_info info;
2515 wimlib_get_wim_info(wim, &info);
2516 if (info.image_count != 1) {
2517 imagex_error(T("\"%"TS"\" contains %d images; Please "
2518 "select one (or all)."),
2519 wimfile, info.image_count);
2526 ret = wimlib_iterate_dir_tree(wim, image, path, iterate_flags,
2527 print_dentry, &options);
2534 usage(CMD_DIR, stderr);
2539 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2542 imagex_export(int argc, tchar **argv, int cmd)
2546 int export_flags = WIMLIB_EXPORT_FLAG_GIFT;
2547 int write_flags = 0;
2548 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2549 const tchar *src_wimfile;
2550 const tchar *src_image_num_or_name;
2551 const tchar *dest_wimfile;
2553 const tchar *dest_name;
2554 const tchar *dest_desc;
2556 struct wimlib_wim_info src_info;
2557 WIMStruct *dest_wim;
2562 STRING_SET(refglobs);
2563 unsigned num_threads = 0;
2564 uint32_t chunk_size = UINT32_MAX;
2565 uint32_t pack_chunk_size = UINT32_MAX;
2566 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
2568 for_opt(c, export_options) {
2570 case IMAGEX_BOOT_OPTION:
2571 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2573 case IMAGEX_CHECK_OPTION:
2574 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2575 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2577 case IMAGEX_NOCHECK_OPTION:
2578 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2580 case IMAGEX_COMPRESS_OPTION:
2581 compression_type = get_compression_type(optarg);
2582 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2585 case IMAGEX_COMPRESS_SLOW_OPTION:
2586 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2587 set_compress_slow();
2589 case IMAGEX_PACK_STREAMS_OPTION:
2590 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2592 case IMAGEX_CHUNK_SIZE_OPTION:
2593 chunk_size = parse_chunk_size(optarg);
2594 if (chunk_size == UINT32_MAX)
2597 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
2598 pack_chunk_size = parse_chunk_size(optarg);
2599 if (pack_chunk_size == UINT32_MAX)
2602 case IMAGEX_PACK_COMPRESS_OPTION:
2603 pack_ctype = get_compression_type(optarg);
2604 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
2607 case IMAGEX_REF_OPTION:
2608 ret = string_set_append(&refglobs, optarg);
2610 goto out_free_refglobs;
2612 case IMAGEX_THREADS_OPTION:
2613 num_threads = parse_num_threads(optarg);
2614 if (num_threads == UINT_MAX)
2617 case IMAGEX_REBUILD_OPTION:
2618 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2620 case IMAGEX_PIPABLE_OPTION:
2621 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2623 case IMAGEX_NOT_PIPABLE_OPTION:
2624 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2626 case IMAGEX_WIMBOOT_OPTION:
2627 export_flags |= WIMLIB_EXPORT_FLAG_WIMBOOT;
2635 if (argc < 3 || argc > 5)
2637 src_wimfile = argv[0];
2638 src_image_num_or_name = argv[1];
2639 dest_wimfile = argv[2];
2640 dest_name = (argc >= 4) ? argv[3] : NULL;
2641 dest_desc = (argc >= 5) ? argv[4] : NULL;
2642 ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2643 imagex_progress_func);
2645 goto out_free_refglobs;
2647 wimlib_get_wim_info(src_wim, &src_info);
2649 /* Determine if the destination is an existing file or not. If so, we
2650 * try to append the exported image(s) to it; otherwise, we create a new
2651 * WIM containing the exported image(s). Furthermore, determine if we
2652 * need to write a pipable WIM directly to standard output. */
2654 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2656 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2657 imagex_error("Can't write a non-pipable WIM to "
2658 "standard output! Specify --pipable\n"
2659 " if you want to create a pipable WIM "
2660 "(but read the docs first).");
2662 goto out_free_src_wim;
2665 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2667 dest_wimfile = NULL;
2668 dest_wim_fd = STDOUT_FILENO;
2669 imagex_info_file = stderr;
2670 set_fd_to_binary_mode(dest_wim_fd);
2673 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2675 /* Destination file exists. */
2677 if (!S_ISREG(stbuf.st_mode)) {
2678 imagex_error(T("\"%"TS"\" is not a regular file"),
2681 goto out_free_src_wim;
2683 ret = wimlib_open_wim(dest_wimfile,
2684 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2685 &dest_wim, imagex_progress_func);
2687 goto out_free_src_wim;
2689 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2690 /* The user specified a compression type, but we're
2691 * exporting to an existing WIM. Make sure the
2692 * specified compression type is the same as the
2693 * compression type of the existing destination WIM. */
2694 struct wimlib_wim_info dest_info;
2696 wimlib_get_wim_info(dest_wim, &dest_info);
2697 if (compression_type != dest_info.compression_type) {
2698 imagex_error(T("Cannot specify a compression type that is "
2699 "not the same as that used in the "
2700 "destination WIM"));
2702 goto out_free_dest_wim;
2708 if (errno != ENOENT) {
2709 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2712 goto out_free_src_wim;
2715 /* dest_wimfile is not an existing file, so create a new WIM. */
2717 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2718 /* The user did not specify a compression type; default
2719 * to that of the source WIM, unless --pack-streams,
2720 * --solid, or --wimboot was specified. */
2722 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2723 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
2724 else if (export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
2725 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
2727 compression_type = src_info.compression_type;
2729 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2731 goto out_free_src_wim;
2733 if ((export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
2734 && compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS)
2736 /* For --wimboot export, use small XPRESS chunks. */
2737 wimlib_set_output_chunk_size(dest_wim, 4096);
2738 } else if (compression_type == src_info.compression_type &&
2739 chunk_size == UINT32_MAX)
2741 /* Use same chunk size if compression type is the same. */
2742 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2746 if (chunk_size != UINT32_MAX) {
2747 /* Set destination chunk size. */
2748 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2750 goto out_free_dest_wim;
2752 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
2753 ret = wimlib_set_output_pack_compression_type(dest_wim, pack_ctype);
2755 goto out_free_dest_wim;
2757 if (pack_chunk_size != UINT32_MAX) {
2758 ret = wimlib_set_output_pack_chunk_size(dest_wim, pack_chunk_size);
2760 goto out_free_dest_wim;
2763 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2764 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2766 goto out_free_dest_wim;
2768 if (refglobs.num_strings) {
2769 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2771 goto out_free_dest_wim;
2774 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2775 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2777 imagex_error(T("--boot specified for all-images export, but source WIM "
2778 "has no bootable image."));
2780 goto out_free_dest_wim;
2783 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2784 dest_desc, export_flags, imagex_progress_func);
2786 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2787 do_resource_not_found_warning(src_wimfile,
2788 &src_info, &refglobs);
2790 goto out_free_dest_wim;
2794 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2795 imagex_progress_func);
2796 else if (dest_wimfile)
2797 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2798 write_flags, num_threads,
2799 imagex_progress_func);
2801 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2802 WIMLIB_ALL_IMAGES, write_flags,
2803 num_threads, imagex_progress_func);
2805 wimlib_free(dest_wim);
2807 wimlib_free(src_wim);
2809 string_set_destroy(&refglobs);
2813 usage(CMD_EXPORT, stderr);
2816 goto out_free_refglobs;
2819 /* Extract files or directories from a WIM image */
2821 imagex_extract(int argc, tchar **argv, int cmd)
2828 const tchar *wimfile;
2829 const tchar *image_num_or_name;
2830 tchar *dest_dir = T(".");
2831 int extract_flags = WIMLIB_EXTRACT_FLAG_NORPFIX |
2832 WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2833 WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2834 int notlist_extract_flags = WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2836 STRING_SET(refglobs);
2838 tchar *root_path = WIMLIB_WIM_ROOT_PATH;
2840 for_opt(c, extract_options) {
2842 case IMAGEX_CHECK_OPTION:
2843 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2845 case IMAGEX_VERBOSE_OPTION:
2846 /* No longer does anything. */
2848 case IMAGEX_REF_OPTION:
2849 ret = string_set_append(&refglobs, optarg);
2851 goto out_free_refglobs;
2853 case IMAGEX_UNIX_DATA_OPTION:
2854 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2856 case IMAGEX_NO_ACLS_OPTION:
2857 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2859 case IMAGEX_STRICT_ACLS_OPTION:
2860 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2862 case IMAGEX_NO_ATTRIBUTES_OPTION:
2863 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
2865 case IMAGEX_DEST_DIR_OPTION:
2868 case IMAGEX_TO_STDOUT_OPTION:
2869 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2870 imagex_info_file = stderr;
2871 imagex_be_quiet = true;
2872 set_fd_to_binary_mode(STDOUT_FILENO);
2874 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2875 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2876 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2878 case IMAGEX_NO_WILDCARDS_OPTION:
2879 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2881 case IMAGEX_NULLGLOB_OPTION:
2882 extract_flags &= ~WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2884 case IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION:
2885 notlist_extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2887 case IMAGEX_WIMBOOT_OPTION:
2888 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
2900 if (!(extract_flags & (WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2901 WIMLIB_EXTRACT_FLAG_STRICT_GLOB)))
2903 imagex_error(T("Can't combine --no-wildcards and --nullglob!"));
2908 image_num_or_name = argv[1];
2913 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2915 goto out_free_refglobs;
2917 image = wimlib_resolve_image(wim, image_num_or_name);
2918 ret = verify_image_exists_and_is_single(image,
2922 goto out_wimlib_free;
2924 if (refglobs.num_strings) {
2925 ret = wim_reference_globs(wim, &refglobs, open_flags);
2927 goto out_wimlib_free;
2933 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2936 while (argc != 0 && ret == 0) {
2940 num_paths < argc && argv[num_paths][0] != T('@');
2945 ret = wimlib_extract_paths(wim, image, dest_dir,
2946 (const tchar **)argv,
2948 extract_flags | notlist_extract_flags,
2949 imagex_progress_func);
2953 ret = wimlib_extract_pathlist(wim, image, dest_dir,
2956 imagex_progress_func);
2963 if (!imagex_be_quiet)
2964 imagex_printf(T("Done extracting files.\n"));
2965 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2966 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2967 "files and directories\n"
2968 " are in the WIM image.\n"),
2969 get_cmd_string(CMD_DIR, false));
2970 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2971 struct wimlib_wim_info info;
2973 wimlib_get_wim_info(wim, &info);
2974 do_resource_not_found_warning(wimfile, &info, &refglobs);
2979 string_set_destroy(&refglobs);
2983 usage(CMD_EXTRACT, stderr);
2986 goto out_free_refglobs;
2989 /* Prints information about a WIM file; also can mark an image as bootable,
2990 * change the name of an image, or change the description of an image. */
2992 imagex_info(int argc, tchar **argv, int cmd)
2997 bool nocheck = false;
2998 bool header = false;
2999 bool lookup_table = false;
3001 bool short_header = true;
3002 const tchar *xml_out_file = NULL;
3003 const tchar *wimfile;
3004 const tchar *image_num_or_name;
3005 const tchar *new_name;
3006 const tchar *new_desc;
3011 struct wimlib_wim_info info;
3013 for_opt(c, info_options) {
3015 case IMAGEX_BOOT_OPTION:
3018 case IMAGEX_CHECK_OPTION:
3021 case IMAGEX_NOCHECK_OPTION:
3024 case IMAGEX_HEADER_OPTION:
3026 short_header = false;
3028 case IMAGEX_LOOKUP_TABLE_OPTION:
3029 lookup_table = true;
3030 short_header = false;
3032 case IMAGEX_XML_OPTION:
3034 short_header = false;
3036 case IMAGEX_EXTRACT_XML_OPTION:
3037 xml_out_file = optarg;
3038 short_header = false;
3040 case IMAGEX_METADATA_OPTION:
3041 imagex_error(T("The --metadata option has been removed. "
3042 "Use 'wimdir --detail' instead."));
3051 if (argc < 1 || argc > 4)
3055 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
3056 new_name = (argc >= 3) ? argv[2] : NULL;
3057 new_desc = (argc >= 4) ? argv[3] : NULL;
3059 if (check && nocheck) {
3060 imagex_error(T("Can't specify both --check and --nocheck"));
3065 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3067 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3071 wimlib_get_wim_info(wim, &info);
3073 image = wimlib_resolve_image(wim, image_num_or_name);
3074 ret = WIMLIB_ERR_INVALID_IMAGE;
3075 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3076 verify_image_exists(image, image_num_or_name, wimfile);
3078 imagex_error(T("If you would like to set the boot "
3079 "index to 0, specify image \"0\" with "
3080 "the --boot flag."));
3082 goto out_wimlib_free;
3085 if (boot && info.image_count == 0) {
3086 imagex_error(T("--boot is meaningless on a WIM with no images"));
3087 goto out_wimlib_free;
3090 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3092 imagex_error(T("Cannot specify the --boot flag "
3093 "without specifying a specific "
3094 "image in a multi-image WIM"));
3095 goto out_wimlib_free;
3098 imagex_error(T("Cannot specify the NEW_NAME "
3099 "without specifying a specific "
3100 "image in a multi-image WIM"));
3101 goto out_wimlib_free;
3105 /* Operations that print information are separated from operations that
3106 * recreate the WIM file. */
3107 if (!new_name && !boot) {
3109 /* Read-only operations */
3111 if (image == WIMLIB_NO_IMAGE) {
3112 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3113 image_num_or_name, wimfile);
3114 goto out_wimlib_free;
3117 if (image == WIMLIB_ALL_IMAGES && short_header)
3118 print_wim_information(wimfile, &info);
3121 wimlib_print_header(wim);
3124 if (info.total_parts != 1) {
3125 tfprintf(stderr, T("Warning: Only showing the lookup table "
3126 "for part %d of a %d-part WIM.\n"),
3127 info.part_number, info.total_parts);
3129 print_lookup_table(wim);
3133 ret = wimlib_extract_xml_data(wim, stdout);
3135 goto out_wimlib_free;
3141 fp = tfopen(xml_out_file, T("wb"));
3143 imagex_error_with_errno(T("Failed to open the "
3144 "file \"%"TS"\" for "
3148 goto out_wimlib_free;
3150 ret = wimlib_extract_xml_data(wim, fp);
3152 imagex_error(T("Failed to close the file "
3158 goto out_wimlib_free;
3162 wimlib_print_available_images(wim, image);
3167 /* Modification operations */
3169 if (image == WIMLIB_ALL_IMAGES)
3172 if (image == WIMLIB_NO_IMAGE && new_name) {
3173 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3174 "when using image 0"), new_name);
3176 goto out_wimlib_free;
3180 if (image == info.boot_index) {
3181 imagex_printf(T("Image %d is already marked as "
3182 "bootable.\n"), image);
3185 imagex_printf(T("Marking image %d as bootable.\n"),
3187 info.boot_index = image;
3188 ret = wimlib_set_wim_info(wim, &info,
3189 WIMLIB_CHANGE_BOOT_INDEX);
3191 goto out_wimlib_free;
3195 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3197 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3201 imagex_printf(T("Changing the name of image %d to "
3202 "\"%"TS"\".\n"), image, new_name);
3203 ret = wimlib_set_image_name(wim, image, new_name);
3205 goto out_wimlib_free;
3209 const tchar *old_desc;
3210 old_desc = wimlib_get_image_description(wim, image);
3211 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3212 imagex_printf(T("The description of image %d is already "
3213 "\"%"TS"\".\n"), image, new_desc);
3216 imagex_printf(T("Changing the description of image %d "
3217 "to \"%"TS"\".\n"), image, new_desc);
3218 ret = wimlib_set_image_descripton(wim, image,
3221 goto out_wimlib_free;
3225 /* Only call wimlib_overwrite() if something actually needs to
3227 if (boot || new_name || new_desc ||
3228 (check && !info.has_integrity_table) ||
3229 (nocheck && info.has_integrity_table))
3231 int write_flags = 0;
3234 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3236 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3237 ret = wimlib_overwrite(wim, write_flags, 1,
3238 imagex_progress_func);
3240 imagex_printf(T("The file \"%"TS"\" was not modified "
3241 "because nothing needed to be done.\n"),
3252 usage(CMD_INFO, stderr);
3258 /* Join split WIMs into one part WIM */
3260 imagex_join(int argc, tchar **argv, int cmd)
3263 int swm_open_flags = 0;
3264 int wim_write_flags = 0;
3265 const tchar *output_path;
3268 for_opt(c, join_options) {
3270 case IMAGEX_CHECK_OPTION:
3271 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3272 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3282 imagex_error(T("Must specify one or more split WIM (.swm) "
3286 output_path = argv[0];
3287 ret = wimlib_join((const tchar * const *)++argv,
3292 imagex_progress_func);
3297 usage(CMD_JOIN, stderr);
3302 #if WIM_MOUNTING_SUPPORTED
3304 /* Mounts a WIM image. */
3306 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3309 int mount_flags = 0;
3311 const tchar *staging_dir = NULL;
3312 const tchar *wimfile;
3315 struct wimlib_wim_info info;
3319 STRING_SET(refglobs);
3321 if (cmd == CMD_MOUNTRW) {
3322 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3323 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3326 for_opt(c, mount_options) {
3328 case IMAGEX_ALLOW_OTHER_OPTION:
3329 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3331 case IMAGEX_CHECK_OPTION:
3332 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3334 case IMAGEX_DEBUG_OPTION:
3335 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3337 case IMAGEX_STREAMS_INTERFACE_OPTION:
3338 if (!tstrcasecmp(optarg, T("none")))
3339 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3340 else if (!tstrcasecmp(optarg, T("xattr")))
3341 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3342 else if (!tstrcasecmp(optarg, T("windows")))
3343 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3345 imagex_error(T("Unknown stream interface \"%"TS"\""),
3350 case IMAGEX_REF_OPTION:
3351 ret = string_set_append(&refglobs, optarg);
3353 goto out_free_refglobs;
3355 case IMAGEX_STAGING_DIR_OPTION:
3356 staging_dir = optarg;
3358 case IMAGEX_UNIX_DATA_OPTION:
3359 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3367 if (argc != 2 && argc != 3)
3372 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3374 goto out_free_refglobs;
3376 wimlib_get_wim_info(wim, &info);
3379 /* Image explicitly specified. */
3380 image = wimlib_resolve_image(wim, argv[1]);
3382 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3386 /* No image specified; default to image 1, but only if the WIM
3387 * contains exactly one image. */
3389 if (info.image_count != 1) {
3390 imagex_error(T("\"%"TS"\" contains %d images; Please "
3391 "select one."), wimfile, info.image_count);
3399 if (refglobs.num_strings) {
3400 ret = wim_reference_globs(wim, &refglobs, open_flags);
3405 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3407 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3409 image, wimfile, dir);
3414 string_set_destroy(&refglobs);
3420 goto out_free_refglobs;
3422 #endif /* WIM_MOUNTING_SUPPORTED */
3424 /* Rebuild a WIM file */
3426 imagex_optimize(int argc, tchar **argv, int cmd)
3429 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3430 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3431 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3432 uint32_t chunk_size = UINT32_MAX;
3433 uint32_t pack_chunk_size = UINT32_MAX;
3434 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
3437 const tchar *wimfile;
3440 unsigned num_threads = 0;
3442 for_opt(c, optimize_options) {
3444 case IMAGEX_CHECK_OPTION:
3445 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3446 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3448 case IMAGEX_NOCHECK_OPTION:
3449 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3451 case IMAGEX_COMPRESS_OPTION:
3452 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3453 compression_type = get_compression_type(optarg);
3454 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3457 case IMAGEX_RECOMPRESS_OPTION:
3458 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3460 case IMAGEX_COMPRESS_SLOW_OPTION:
3461 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3462 set_compress_slow();
3464 case IMAGEX_CHUNK_SIZE_OPTION:
3465 chunk_size = parse_chunk_size(optarg);
3466 if (chunk_size == UINT32_MAX)
3469 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
3470 pack_chunk_size = parse_chunk_size(optarg);
3471 if (pack_chunk_size == UINT32_MAX)
3474 case IMAGEX_PACK_COMPRESS_OPTION:
3475 pack_ctype = get_compression_type(optarg);
3476 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
3479 case IMAGEX_PACK_STREAMS_OPTION:
3480 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3481 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3483 case IMAGEX_THREADS_OPTION:
3484 num_threads = parse_num_threads(optarg);
3485 if (num_threads == UINT_MAX)
3488 case IMAGEX_PIPABLE_OPTION:
3489 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3491 case IMAGEX_NOT_PIPABLE_OPTION:
3492 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3506 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3510 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3511 /* Change compression type. */
3512 ret = wimlib_set_output_compression_type(wim, compression_type);
3514 goto out_wimlib_free;
3517 if (chunk_size != UINT32_MAX) {
3518 /* Change chunk size. */
3519 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3521 goto out_wimlib_free;
3523 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
3524 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
3526 goto out_wimlib_free;
3528 if (pack_chunk_size != UINT32_MAX) {
3529 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
3531 goto out_wimlib_free;
3534 old_size = file_get_size(wimfile);
3535 tprintf(T("\"%"TS"\" original size: "), wimfile);
3537 tputs(T("Unknown"));
3539 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3541 ret = wimlib_overwrite(wim, write_flags, num_threads,
3542 imagex_progress_func);
3544 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3545 goto out_wimlib_free;
3548 new_size = file_get_size(wimfile);
3549 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3551 tputs(T("Unknown"));
3553 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3555 tfputs(T("Space saved: "), stdout);
3556 if (new_size != -1 && old_size != -1) {
3557 tprintf(T("%lld KiB\n"),
3558 ((long long)old_size - (long long)new_size) >> 10);
3560 tputs(T("Unknown"));
3569 usage(CMD_OPTIMIZE, stderr);
3575 /* Split a WIM into a spanned set */
3577 imagex_split(int argc, tchar **argv, int cmd)
3581 int write_flags = 0;
3582 unsigned long part_size;
3587 for_opt(c, split_options) {
3589 case IMAGEX_CHECK_OPTION:
3590 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3591 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3603 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3604 if (tmp == argv[2] || *tmp) {
3605 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3606 imagex_error(T("The part size must be an integer or "
3607 "floating-point number of megabytes."));
3610 ret = wimlib_open_wim(argv[0], open_flags, &wim, imagex_progress_func);
3614 ret = wimlib_split(wim, argv[1], part_size, write_flags, imagex_progress_func);
3620 usage(CMD_SPLIT, stderr);
3626 #if WIM_MOUNTING_SUPPORTED
3627 /* Unmounts a mounted WIM image. */
3629 imagex_unmount(int argc, tchar **argv, int cmd)
3632 int unmount_flags = 0;
3635 for_opt(c, unmount_options) {
3637 case IMAGEX_COMMIT_OPTION:
3638 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3640 case IMAGEX_CHECK_OPTION:
3641 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3643 case IMAGEX_REBUILD_OPTION:
3644 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3646 case IMAGEX_LAZY_OPTION:
3647 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3649 case IMAGEX_NEW_IMAGE_OPTION:
3650 unmount_flags |= WIMLIB_UNMOUNT_FLAG_NEW_IMAGE;
3661 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
3662 if (!(unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)) {
3663 imagex_error(T("--new-image is meaningless "
3664 "without --commit also specified!"));
3667 imagex_printf(T("Committing changes as new image...\n"));
3670 ret = wimlib_unmount_image(argv[0], unmount_flags,
3671 imagex_progress_func);
3673 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3678 usage(CMD_UNMOUNT, stderr);
3683 #endif /* WIM_MOUNTING_SUPPORTED */
3686 * Add, delete, or rename files in a WIM image.
3689 imagex_update(int argc, tchar **argv, int cmd)
3691 const tchar *wimfile;
3695 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3696 int write_flags = 0;
3697 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3698 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3699 WIMLIB_ADD_FLAG_VERBOSE |
3700 WIMLIB_ADD_FLAG_WINCONFIG;
3701 int default_delete_flags = 0;
3702 unsigned num_threads = 0;
3704 tchar *cmd_file_contents;
3705 size_t cmd_file_nchars;
3706 struct wimlib_update_command *cmds;
3708 tchar *command_str = NULL;
3709 tchar *config_file = NULL;
3710 tchar *wimboot_config = NULL;
3712 for_opt(c, update_options) {
3714 /* Generic or write options */
3715 case IMAGEX_THREADS_OPTION:
3716 num_threads = parse_num_threads(optarg);
3717 if (num_threads == UINT_MAX)
3720 case IMAGEX_CHECK_OPTION:
3721 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3722 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3724 case IMAGEX_REBUILD_OPTION:
3725 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3727 case IMAGEX_COMMAND_OPTION:
3729 imagex_error(T("--command may only be specified "
3730 "one time. Please provide\n"
3731 " the update commands "
3732 "on standard input instead."));
3735 command_str = tstrdup(optarg);
3737 imagex_error(T("Out of memory!"));
3741 case IMAGEX_WIMBOOT_CONFIG_OPTION:
3742 wimboot_config = optarg;
3744 /* Default delete options */
3745 case IMAGEX_FORCE_OPTION:
3746 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3748 case IMAGEX_RECURSIVE_OPTION:
3749 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3752 /* Global add option */
3753 case IMAGEX_CONFIG_OPTION:
3754 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3755 config_file = optarg;
3758 /* Default add options */
3759 case IMAGEX_VERBOSE_OPTION:
3760 /* No longer does anything. */
3762 case IMAGEX_DEREFERENCE_OPTION:
3763 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3765 case IMAGEX_UNIX_DATA_OPTION:
3766 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3768 case IMAGEX_NO_ACLS_OPTION:
3769 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3771 case IMAGEX_STRICT_ACLS_OPTION:
3772 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3774 case IMAGEX_NO_REPLACE_OPTION:
3775 default_add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
3784 if (argc != 1 && argc != 2)
3788 ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3790 goto out_free_command_str;
3793 /* Image explicitly specified. */
3794 image = wimlib_resolve_image(wim, argv[1]);
3795 ret = verify_image_exists_and_is_single(image, argv[1],
3798 goto out_wimlib_free;
3800 /* No image specified; default to image 1, but only if the WIM
3801 * contains exactly one image. */
3802 struct wimlib_wim_info info;
3804 wimlib_get_wim_info(wim, &info);
3805 if (info.image_count != 1) {
3806 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3807 wimfile, info.image_count);
3814 /* Read update commands from standard input, or the command string if
3817 cmd_file_contents = NULL;
3818 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3822 goto out_free_cmd_file_contents;
3824 } else if (!wimboot_config) {
3825 if (isatty(STDIN_FILENO)) {
3826 tputs(T("Reading update commands from standard input..."));
3827 recommend_man_page(CMD_UPDATE, stdout);
3829 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3830 if (!cmd_file_contents) {
3832 goto out_wimlib_free;
3835 /* Parse the update commands */
3836 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3840 goto out_free_cmd_file_contents;
3843 cmd_file_contents = NULL;
3848 /* Set default flags and capture config on the update commands */
3849 for (size_t i = 0; i < num_cmds; i++) {
3850 switch (cmds[i].op) {
3851 case WIMLIB_UPDATE_OP_ADD:
3852 cmds[i].add.add_flags |= default_add_flags;
3853 cmds[i].add.config_file = config_file;
3855 case WIMLIB_UPDATE_OP_DELETE:
3856 cmds[i].delete_.delete_flags |= default_delete_flags;
3863 /* Execute the update commands */
3864 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
3865 imagex_progress_func);
3869 if (wimboot_config) {
3870 /* --wimboot-config=FILE is short for an
3871 * "add FILE /Windows/System32/WimBootCompress.ini" command.
3873 struct wimlib_update_command cmd;
3875 cmd.op = WIMLIB_UPDATE_OP_ADD;
3876 cmd.add.fs_source_path = wimboot_config;
3877 cmd.add.wim_target_path = T("/Windows/System32/WimBootCompress.ini");
3878 cmd.add.config_file = NULL;
3879 cmd.add.add_flags = 0;
3881 ret = wimlib_update_image(wim, image, &cmd, 1,
3882 update_flags, imagex_progress_func);
3887 /* Overwrite the updated WIM */
3888 ret = wimlib_overwrite(wim, write_flags, num_threads,
3889 imagex_progress_func);
3892 out_free_cmd_file_contents:
3893 free(cmd_file_contents);
3896 out_free_command_str:
3901 usage(CMD_UPDATE, stderr);
3904 goto out_free_command_str;
3909 struct imagex_command {
3911 int (*func)(int argc, tchar **argv, int cmd);
3914 static const struct imagex_command imagex_commands[] = {
3915 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3916 [CMD_APPLY] = {T("apply"), imagex_apply},
3917 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3918 [CMD_DELETE] = {T("delete"), imagex_delete},
3919 [CMD_DIR ] = {T("dir"), imagex_dir},
3920 [CMD_EXPORT] = {T("export"), imagex_export},
3921 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3922 [CMD_INFO] = {T("info"), imagex_info},
3923 [CMD_JOIN] = {T("join"), imagex_join},
3924 #if WIM_MOUNTING_SUPPORTED
3925 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3926 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3928 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3929 [CMD_SPLIT] = {T("split"), imagex_split},
3930 #if WIM_MOUNTING_SUPPORTED
3931 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3933 [CMD_UPDATE] = {T("update"), imagex_update},
3936 static const tchar *usage_strings[] = {
3939 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3940 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3941 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
3942 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3943 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3944 " [--update-of=[WIMFILE:]IMAGE] [--wimboot]\n"
3948 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3949 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
3950 " [--no-acls] [--strict-acls] [--no-attributes]\n"
3951 " [--rpfix] [--norpfix] [--include-invalid-names]\n"
3952 " [--wimboot] [--unix-data]\n"
3956 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3957 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3958 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3959 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3960 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3961 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
3962 " [--delta-from=WIMFILE] [--wimboot] [--unix-data]\n"
3966 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
3967 " [--check] [--soft]\n"
3971 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH] [--detailed]\n"
3975 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3976 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3977 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3978 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3982 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [(PATH | @LISTFILE)...]\n"
3983 " [--check] [--ref=\"GLOB\"] [--dest-dir=CMD_DIR]\n"
3984 " [--to-stdout] [--no-acls] [--strict-acls]\n"
3985 " [--no-attributes] [--include-invalid-names]\n"
3986 " [--no-wildcards] [--nullglob] [--preserve-dir-structure]\n"
3990 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3991 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
3992 " [--extract-xml FILE] [--header] [--lookup-table]\n"
3996 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
3998 #if WIM_MOUNTING_SUPPORTED
4001 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4002 " [--check] [--streams-interface=INTERFACE]\n"
4003 " [--ref=\"GLOB\"] [--allow-other] [--unix-data]\n"
4007 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4008 " [--check] [--streams-interface=INTERFACE]\n"
4009 " [--staging-dir=CMD_DIR] [--allow-other] [--unix-data]\n"
4014 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
4015 " [--recompress-slow] [--compress=TYPE]\n"
4016 " [--threads=NUM_THREADS]\n"
4020 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
4022 #if WIM_MOUNTING_SUPPORTED
4025 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
4031 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
4032 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
4033 " [DEFAULT_DELETE_OPTIONS] [--command=STRING]\n"
4034 " [--wimboot-config=FILE| [< CMDFILE]\n"
4038 static const tchar *invocation_name;
4039 static int invocation_cmd = CMD_NONE;
4041 static const tchar *get_cmd_string(int cmd, bool nospace)
4043 static tchar buf[50];
4044 if (cmd == CMD_NONE) {
4045 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
4046 } else if (invocation_cmd != CMD_NONE) {
4047 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
4049 const tchar *format;
4052 format = T("%"TS"-%"TS"");
4054 format = T("%"TS" %"TS"");
4055 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
4063 static const tchar *s =
4065 IMAGEX_PROGNAME " (distributed with " PACKAGE " " PACKAGE_VERSION ")\n"
4066 "Copyright (C) 2012, 2013, 2014 Eric Biggers\n"
4067 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
4068 "This is free software: you are free to change and redistribute it.\n"
4069 "There is NO WARRANTY, to the extent permitted by law.\n"
4071 "Report bugs to "PACKAGE_BUGREPORT".\n"
4078 help_or_version(int argc, tchar **argv, int cmd)
4083 for (i = 1; i < argc; i++) {
4085 if (p[0] == T('-') && p[1] == T('-')) {
4087 if (!tstrcmp(p, T("help"))) {
4088 if (cmd == CMD_NONE)
4093 } else if (!tstrcmp(p, T("version"))) {
4102 print_usage_string(int cmd, FILE *fp)
4104 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4108 recommend_man_page(int cmd, FILE *fp)
4110 const tchar *format_str;
4112 format_str = T("Uncommon options are not listed;\n"
4113 "See %"TS".pdf in the doc directory for more details.\n");
4115 format_str = T("Uncommon options are not listed;\n"
4116 "Try `man %"TS"' for more details.\n");
4118 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4122 usage(int cmd, FILE *fp)
4124 tfprintf(fp, T("Usage:\n"));
4125 print_usage_string(cmd, fp);
4126 tfprintf(fp, T("\n"));
4127 recommend_man_page(cmd, fp);
4133 tfprintf(fp, T("Usage:\n"));
4134 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4135 print_usage_string(cmd, fp);
4136 tfprintf(fp, T("\n"));
4138 static const tchar *extra =
4141 " %"TS" --version\n"
4143 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4146 tfprintf(fp, extra, invocation_name, invocation_name);
4147 recommend_man_page(CMD_NONE, fp);
4150 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4151 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4152 * something else), while on Windows the command arguments will be UTF-16LE
4153 * encoded 'wchar_t' strings. */
4156 wmain(int argc, wchar_t **argv, wchar_t **envp)
4158 main(int argc, char **argv)
4165 imagex_info_file = stdout;
4166 invocation_name = tbasename(argv[0]);
4169 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4170 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4174 setlocale(LC_ALL, "");
4175 codeset = nl_langinfo(CODESET);
4176 if (!strstr(codeset, "UTF-8") &&
4177 !strstr(codeset, "UTF8") &&
4178 !strstr(codeset, "utf-8") &&
4179 !strstr(codeset, "utf8"))
4182 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4183 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4184 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4185 " to any value to force wimlib to use UTF-8.\n",
4191 #endif /* !__WIN32__ */
4194 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4195 if (igcase != NULL) {
4196 if (!tstrcmp(igcase, T("no")) ||
4197 !tstrcmp(igcase, T("0")))
4198 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4199 else if (!tstrcmp(igcase, T("yes")) ||
4200 !tstrcmp(igcase, T("1")))
4201 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4204 "WARNING: Ignoring unknown setting of "
4205 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4210 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4212 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4213 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4214 for (int i = 0; i < CMD_MAX; i++) {
4215 if (!tstrcmp(invocation_name + 3,
4216 imagex_commands[i].name))
4225 /* Unless already known from the invocation name, determine which
4226 * command was specified. */
4227 if (cmd == CMD_NONE) {
4229 imagex_error(T("No command specified!\n"));
4233 for (int i = 0; i < CMD_MAX; i++) {
4234 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4239 if (cmd != CMD_NONE) {
4245 /* Handle --help and --version. --help can be either for the program as
4246 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4247 * CMD_NONE). Note: help_or_version() will not return if a --help or
4248 * --version argument was found. */
4249 help_or_version(argc, argv, cmd);
4251 /* Bail if a valid command was not specified. */
4252 if (cmd == CMD_NONE) {
4253 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4258 /* Enable warning and error messages in wimlib to be more user-friendly.
4260 wimlib_set_print_errors(true);
4262 /* Initialize wimlib. */
4263 ret = wimlib_global_init(init_flags);
4265 goto out_check_status;
4267 /* Call the command handler function. */
4268 ret = imagex_commands[cmd].func(argc, argv, cmd);
4270 /* Check for error writing to standard output, especially since for some
4271 * commands, writing to standard output is part of the program's actual
4272 * behavior and not just for informational purposes. */
4273 if (ferror(stdout) || fclose(stdout)) {
4274 imagex_error_with_errno(T("error writing to standard output"));
4279 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4280 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4281 * error code from which an error message can be printed. */
4283 imagex_error(T("Exiting with error code %d:\n"
4285 wimlib_get_error_string(ret));
4286 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4287 imagex_error_with_errno(T("errno"));
4289 /* Make wimlib free any resources it's holding (although this is not
4290 * strictly necessary because the process is ending anyway). */
4291 wimlib_global_cleanup();