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 bool imagex_be_quiet = false;
134 static FILE *imagex_info_file;
136 #define imagex_printf(format, ...) \
137 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
140 IMAGEX_ALLOW_OTHER_OPTION,
143 IMAGEX_CHUNK_SIZE_OPTION,
144 IMAGEX_COMMAND_OPTION,
145 IMAGEX_COMMIT_OPTION,
146 IMAGEX_COMPRESS_OPTION,
147 IMAGEX_COMPRESS_SLOW_OPTION,
148 IMAGEX_CONFIG_OPTION,
150 IMAGEX_DELTA_FROM_OPTION,
151 IMAGEX_DEREFERENCE_OPTION,
152 IMAGEX_DEST_DIR_OPTION,
153 IMAGEX_DETAILED_OPTION,
154 IMAGEX_EXTRACT_XML_OPTION,
157 IMAGEX_HEADER_OPTION,
158 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
160 IMAGEX_LOOKUP_TABLE_OPTION,
161 IMAGEX_METADATA_OPTION,
162 IMAGEX_NEW_IMAGE_OPTION,
163 IMAGEX_NOCHECK_OPTION,
164 IMAGEX_NORPFIX_OPTION,
165 IMAGEX_NOT_PIPABLE_OPTION,
166 IMAGEX_NO_ACLS_OPTION,
167 IMAGEX_NO_ATTRIBUTES_OPTION,
168 IMAGEX_NO_REPLACE_OPTION,
169 IMAGEX_NO_WILDCARDS_OPTION,
170 IMAGEX_NULLGLOB_OPTION,
171 IMAGEX_ONE_FILE_ONLY_OPTION,
172 IMAGEX_PACK_CHUNK_SIZE_OPTION,
173 IMAGEX_PACK_COMPRESS_OPTION,
174 IMAGEX_PACK_STREAMS_OPTION,
176 IMAGEX_PIPABLE_OPTION,
177 IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION,
178 IMAGEX_REBUILD_OPTION,
179 IMAGEX_RECOMPRESS_OPTION,
180 IMAGEX_RECURSIVE_OPTION,
182 IMAGEX_RESUME_OPTION,
185 IMAGEX_SOURCE_LIST_OPTION,
186 IMAGEX_STAGING_DIR_OPTION,
187 IMAGEX_STREAMS_INTERFACE_OPTION,
188 IMAGEX_STRICT_ACLS_OPTION,
189 IMAGEX_THREADS_OPTION,
190 IMAGEX_TO_STDOUT_OPTION,
191 IMAGEX_UNIX_DATA_OPTION,
192 IMAGEX_UPDATE_OF_OPTION,
193 IMAGEX_VERBOSE_OPTION,
194 IMAGEX_WIMBOOT_OPTION,
195 IMAGEX_WIMBOOT_CONFIG_OPTION,
199 static const struct option apply_options[] = {
200 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
201 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
202 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
203 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
204 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
205 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
206 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
207 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
208 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
209 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
210 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
212 /* --resume is undocumented for now as it needs improvement. */
213 {T("resume"), no_argument, NULL, IMAGEX_RESUME_OPTION},
214 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
218 static const struct option capture_or_append_options[] = {
219 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
220 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
221 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
222 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
223 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
224 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
225 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
226 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
227 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
228 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
229 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
230 {T("pack-streams"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
231 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
232 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
233 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
234 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
235 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
236 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
237 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
238 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
239 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
240 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
241 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
242 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
243 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
244 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
245 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
246 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
247 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
248 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
249 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
253 static const struct option delete_options[] = {
254 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
255 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
259 static const struct option dir_options[] = {
260 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
261 {T("detailed"), no_argument, NULL, IMAGEX_DETAILED_OPTION},
262 {T("one-file-only"), no_argument, NULL, IMAGEX_ONE_FILE_ONLY_OPTION},
266 static const struct option export_options[] = {
267 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
268 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
269 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
270 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
271 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
272 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
273 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
274 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
275 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
276 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
277 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
278 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
279 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
280 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
281 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
282 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
283 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
284 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
285 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
289 static const struct option extract_options[] = {
290 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
291 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
292 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
293 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
294 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
295 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
296 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
297 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
298 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
299 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
300 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
301 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_WILDCARDS_OPTION},
302 {T("nullglob"), no_argument, NULL, IMAGEX_NULLGLOB_OPTION},
303 {T("preserve-dir-structure"), no_argument, NULL, IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION},
304 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
308 static const struct option info_options[] = {
309 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
310 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
311 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
312 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
313 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
314 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
315 {T("lookup-table"), no_argument, NULL, IMAGEX_LOOKUP_TABLE_OPTION},
316 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
317 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
321 static const struct option join_options[] = {
322 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
326 static const struct option mount_options[] = {
327 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
328 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
329 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
330 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
331 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
332 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
333 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
337 static const struct option optimize_options[] = {
338 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
339 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
340 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
341 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
342 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
343 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
344 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
345 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
346 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
347 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_PACK_CHUNK_SIZE_OPTION},
348 {T("pack-compress"), required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
349 {T("solid-compress"),required_argument, NULL, IMAGEX_PACK_COMPRESS_OPTION},
350 {T("pack-streams"),no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
351 {T("solid"), no_argument, NULL, IMAGEX_PACK_STREAMS_OPTION},
352 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
353 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
354 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
358 static const struct option split_options[] = {
359 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
363 static const struct option unmount_options[] = {
364 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
365 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
366 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
367 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
368 {T("new-image"), no_argument, NULL, IMAGEX_NEW_IMAGE_OPTION},
372 static const struct option update_options[] = {
373 /* Careful: some of the options here set the defaults for update
374 * commands, but the flags given to an actual update command (and not to
375 * `imagex update' itself are also handled in
376 * update_command_add_option(). */
377 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
378 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
379 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
380 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
381 {T("wimboot-config"), required_argument, NULL, IMAGEX_WIMBOOT_CONFIG_OPTION},
383 /* Default delete options */
384 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
385 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
387 /* Global add option */
388 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
390 /* Default add options */
391 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
392 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
393 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
394 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
395 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
396 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
397 {T("no-replace"), no_argument, NULL, IMAGEX_NO_REPLACE_OPTION},
403 # define _format_attribute(type, format_str, args_start) \
404 __attribute__((format(type, format_str, args_start)))
406 # define _format_attribute(type, format_str, args_start)
409 /* Print formatted error message to stderr. */
410 static void _format_attribute(printf, 1, 2)
411 imagex_error(const tchar *format, ...)
414 va_start(va, format);
415 tfputs(T("ERROR: "), stderr);
416 tvfprintf(stderr, format, va);
417 tputc(T('\n'), stderr);
421 /* Print formatted error message to stderr. */
422 static void _format_attribute(printf, 1, 2)
423 imagex_error_with_errno(const tchar *format, ...)
425 int errno_save = errno;
427 va_start(va, format);
428 tfputs(T("ERROR: "), stderr);
429 tvfprintf(stderr, format, va);
430 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
435 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
437 if (image == WIMLIB_NO_IMAGE) {
438 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
439 " Please specify a 1-based image index or "
440 "image name. To list the images\n"
441 " contained in the WIM archive, run\n"
443 " %"TS" \"%"TS"\"\n"),
444 image_name, wim_name,
445 get_cmd_string(CMD_INFO, false), wim_name);
446 return WIMLIB_ERR_INVALID_IMAGE;
452 verify_image_is_single(int image)
454 if (image == WIMLIB_ALL_IMAGES) {
455 imagex_error(T("Cannot specify all images for this action!"));
456 return WIMLIB_ERR_INVALID_IMAGE;
462 verify_image_exists_and_is_single(int image, const tchar *image_name,
463 const tchar *wim_name)
466 ret = verify_image_exists(image, image_name, wim_name);
468 ret = verify_image_is_single(image);
472 /* Parse the argument to --compress */
474 get_compression_type(const tchar *optarg)
476 if (!tstrcasecmp(optarg, T("maximum")) ||
477 !tstrcasecmp(optarg, T("lzx")) ||
478 !tstrcasecmp(optarg, T("max")))
479 return WIMLIB_COMPRESSION_TYPE_LZX;
480 else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
481 return WIMLIB_COMPRESSION_TYPE_XPRESS;
482 else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
483 return WIMLIB_COMPRESSION_TYPE_LZMS;
484 else if (!tstrcasecmp(optarg, T("none")))
485 return WIMLIB_COMPRESSION_TYPE_NONE;
487 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
488 "\"maximum\", \"fast\", or \"none\"."), optarg);
489 return WIMLIB_COMPRESSION_TYPE_INVALID;
494 set_compress_slow(void)
496 static const struct wimlib_lzx_compressor_params lzx_slow_params = {
498 .size = sizeof(struct wimlib_lzx_compressor_params),
500 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
503 .use_len2_matches = 1,
504 .nice_match_length = 96,
505 .num_optim_passes = 4,
506 .max_search_depth = 100,
507 .max_matches_per_pos = 10,
508 .main_nostat_cost = 15,
509 .len_nostat_cost = 15,
510 .aligned_nostat_cost = 7,
515 static const struct wimlib_lzms_compressor_params lzms_slow_params = {
517 .size = sizeof(struct wimlib_lzms_compressor_params),
519 .min_match_length = 2,
520 .max_match_length = UINT32_MAX,
521 .nice_match_length = 96,
522 .max_search_depth = 100,
523 .max_matches_per_pos = 10,
524 .optim_array_length = 1024,
527 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
528 &lzx_slow_params.hdr);
530 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZMS,
531 &lzms_slow_params.hdr);
535 const tchar **strings;
536 unsigned num_strings;
537 unsigned num_alloc_strings;
540 #define STRING_SET_INITIALIZER \
541 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
543 #define STRING_SET(_strings) \
544 struct string_set _strings = STRING_SET_INITIALIZER
547 string_set_append(struct string_set *set, const tchar *glob)
549 unsigned num_alloc_strings = set->num_alloc_strings;
551 if (set->num_strings == num_alloc_strings) {
552 const tchar **new_strings;
554 num_alloc_strings += 4;
555 new_strings = realloc(set->strings,
556 sizeof(set->strings[0]) * num_alloc_strings);
558 imagex_error(T("Out of memory!"));
561 set->strings = new_strings;
562 set->num_alloc_strings = num_alloc_strings;
564 set->strings[set->num_strings++] = glob;
569 string_set_destroy(struct string_set *set)
575 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
577 return wimlib_reference_resource_files(wim, set->strings,
579 WIMLIB_REF_FLAG_GLOB_ENABLE,
584 do_resource_not_found_warning(const tchar *wimfile,
585 const struct wimlib_wim_info *info,
586 const struct string_set *refglobs)
588 if (info->total_parts > 1) {
589 if (refglobs->num_strings == 0) {
590 imagex_error(T("\"%"TS"\" is part of a split WIM. "
591 "Use --ref to specify the other parts."),
594 imagex_error(T("Perhaps the '--ref' argument did not "
595 "specify all other parts of the split "
599 imagex_error(T("If this is a delta WIM, use the --ref argument "
600 "to specify the WIM(s) on which it is based."));
604 /* Returns the size of a file given its name, or -1 if the file does not exist
605 * or its size cannot be determined. */
607 file_get_size(const tchar *filename)
610 if (tstat(filename, &st) == 0)
617 PARSE_STRING_SUCCESS = 0,
618 PARSE_STRING_FAILURE = 1,
619 PARSE_STRING_NONE = 2,
623 * Parses a string token from an array of characters.
625 * Tokens are either whitespace-delimited, or double or single-quoted.
627 * @line_p: Pointer to the pointer to the line of data. Will be updated
628 * to point past the string token iff the return value is
629 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
632 * @len_p: @len_p initially stores the length of the line of data, which may
633 * be 0, and it will be updated to the number of bytes remaining in
634 * the line iff the return value is PARSE_STRING_SUCCESS.
636 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
637 * parsed string token will be returned here.
639 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
640 * PARSE_STRING_FAILURE if the data was invalid due to a missing
641 * closing quote; or PARSE_STRING_NONE if the line ended before the
642 * beginning of a string token was found.
645 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
648 tchar *line = *line_p;
652 /* Skip leading whitespace */
655 return PARSE_STRING_NONE;
656 if (!istspace(*line) && *line != T('\0'))
662 if (quote_char == T('"') || quote_char == T('\'')) {
667 line = tmemchr(line, quote_char, len);
669 imagex_error(T("Missing closing quote: %"TS), fn - 1);
670 return PARSE_STRING_FAILURE;
673 /* Unquoted string. Go until whitespace. Line is terminated
674 * by '\0', so no need to check 'len'. */
678 } while (!istspace(*line) && *line != T('\0'));
685 return PARSE_STRING_SUCCESS;
688 /* Parses a line of data (not an empty line or comment) in the source list file
689 * format. (See the man page for 'wimlib-imagex capture' for details on this
690 * format and the meaning.)
692 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
693 * len == 0. The data in @line will be modified by this function call.
695 * @len: Length of the line of data.
697 * @source: On success, the capture source and target described by the line is
698 * written into this destination. Note that it will contain pointers
699 * to data in the @line array.
701 * Returns true if the line was valid; false otherwise. */
703 parse_source_list_line(tchar *line, size_t len,
704 struct wimlib_capture_source *source)
708 ret = parse_string(&line, &len, &source->fs_source_path);
709 if (ret != PARSE_STRING_SUCCESS)
711 ret = parse_string(&line, &len, &source->wim_target_path);
712 if (ret == PARSE_STRING_NONE)
713 source->wim_target_path = source->fs_source_path;
714 return ret != PARSE_STRING_FAILURE;
717 /* Returns %true if the given line of length @len > 0 is a comment or empty line
718 * in the source list file format. */
720 is_comment_line(const tchar *line, size_t len)
723 if (*line == T('#') || *line == T(';'))
725 if (!istspace(*line) && *line != T('\0'))
735 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
738 tchar *contents = *contents_p;
739 size_t nchars = *nchars_p;
742 for (i = 0; i < nchars; i++)
743 if (contents[i] == T('\n'))
746 /* Handle last line not terminated by a newline */
747 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
748 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
750 imagex_error(T("Out of memory!"));
753 contents[nchars] = T('\n');
754 *contents_p = contents;
762 /* Parses a file in the source list format. (See the man page for
763 * 'wimlib-imagex capture' for details on this format and the meaning.)
765 * @source_list_contents: Contents of the source list file. Note that this
766 * buffer will be modified to save memory allocations,
767 * and cannot be freed until the returned array of
768 * wimlib_capture_source's has also been freed.
770 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
773 * @nsources_ret: On success, the length of the returned array is
776 * Returns: An array of `struct wimlib_capture_source's that can be passed to
777 * the wimlib_add_image_multisource() function to specify how a WIM image is to
779 static struct wimlib_capture_source *
780 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
781 size_t *nsources_ret)
785 struct wimlib_capture_source *sources;
788 nlines = text_file_count_lines(source_list_contents_p,
789 &source_list_nchars);
793 /* Always allocate at least 1 slot, just in case the implementation of
794 * calloc() returns NULL if 0 bytes are requested. */
795 sources = calloc(nlines ?: 1, sizeof(*sources));
797 imagex_error(T("out of memory"));
800 p = *source_list_contents_p;
802 for (i = 0; i < nlines; i++) {
803 /* XXX: Could use rawmemchr() here instead, but it may not be
804 * available on all platforms. */
805 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
806 size_t len = endp - p + 1;
808 if (!is_comment_line(p, len)) {
809 if (!parse_source_list_line(p, len, &sources[j++])) {
821 /* Reads the contents of a file into memory. */
823 file_get_contents(const tchar *filename, size_t *len_ret)
830 if (tstat(filename, &stbuf) != 0) {
831 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
836 fp = tfopen(filename, T("rb"));
838 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
842 buf = malloc(len ? len : 1);
844 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
845 "contents of file \"%"TS"\""), len, filename);
848 if (fread(buf, 1, len, fp) != len) {
849 imagex_error_with_errno(T("Failed to read %zu bytes from the "
850 "file \"%"TS"\""), len, filename);
864 /* Read standard input until EOF and return the full contents in a malloc()ed
865 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
868 stdin_get_contents(size_t *len_ret)
870 /* stdin can, of course, be a pipe or other non-seekable file, so the
871 * total length of the data cannot be pre-determined */
873 size_t newlen = 1024;
877 char *p = realloc(buf, newlen);
878 size_t bytes_read, bytes_to_read;
880 imagex_error(T("out of memory while reading stdin"));
884 bytes_to_read = newlen - pos;
885 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
887 if (bytes_read != bytes_to_read) {
892 imagex_error_with_errno(T("error reading stdin"));
906 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
909 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
911 *num_tchars_ret = num_bytes;
913 #else /* !__WIN32__ */
914 /* On Windows, translate the text to UTF-16LE */
918 if (num_bytes >= 2 &&
919 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
920 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
922 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
923 * with something that looks like an ASCII character encoded as
924 * a UTF-16LE code unit. Assume the file is encoded as
925 * UTF-16LE. This is not a 100% reliable check. */
926 num_wchars = num_bytes / 2;
927 text_wstr = (wchar_t*)text;
929 /* File does not look like UTF-16LE. Assume it is encoded in
930 * the current Windows code page. I think these are always
931 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
932 * should work as expected. */
933 text_wstr = win32_mbs_to_wcs(text,
938 *num_tchars_ret = num_wchars;
940 #endif /* __WIN32__ */
944 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
949 contents = file_get_contents(filename, &num_bytes);
952 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
956 stdin_get_text_contents(size_t *num_tchars_ret)
961 contents = stdin_get_contents(&num_bytes);
964 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
967 #define TO_PERCENT(numerator, denominator) \
968 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
970 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
971 #define MEBIBYTE_MIN_NBYTES 10000000ULL
972 #define KIBIBYTE_MIN_NBYTES 10000ULL
975 get_unit(uint64_t total_bytes, const tchar **name_ret)
977 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
978 *name_ret = T("GiB");
980 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
981 *name_ret = T("MiB");
983 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
984 *name_ret = T("KiB");
987 *name_ret = T("bytes");
992 static struct wimlib_progress_info_scan last_scan_progress;
995 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
997 uint64_t prev_count, cur_count;
999 prev_count = last_scan_progress.num_nondirs_scanned +
1000 last_scan_progress.num_dirs_scanned;
1001 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1003 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1004 cur_count % 128 == 0)
1006 unsigned unit_shift;
1007 const tchar *unit_name;
1009 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1010 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1011 "%"PRIu64" directories) "),
1012 scan->num_bytes_scanned >> unit_shift,
1014 scan->num_nondirs_scanned,
1015 scan->num_dirs_scanned);
1016 last_scan_progress = *scan;
1019 /* Progress callback function passed to various wimlib functions. */
1020 static enum wimlib_progress_status
1021 imagex_progress_func(enum wimlib_progress_msg msg,
1022 union wimlib_progress_info *info,
1023 void *_ignored_context)
1025 unsigned percent_done;
1026 unsigned unit_shift;
1027 const tchar *unit_name;
1029 if (imagex_be_quiet)
1030 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1032 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1034 static bool first = true;
1036 imagex_printf(T("Writing %"TS"-compressed data "
1037 "using %u thread%"TS"\n"),
1038 wimlib_get_compression_type_string(
1039 info->write_streams.compression_type),
1040 info->write_streams.num_threads,
1041 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1045 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1046 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1047 info->write_streams.total_bytes);
1049 imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1050 "written (%u%% done)"),
1051 info->write_streams.completed_bytes >> unit_shift,
1053 info->write_streams.total_bytes >> unit_shift,
1056 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1057 imagex_printf(T("\n"));
1059 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1060 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1061 if (WIMLIB_IS_WIM_ROOT_PATH(info->scan.wim_target_path)) {
1062 imagex_printf(T("\n"));
1064 imagex_printf(T(" (loading as WIM path: \"%"TS"\")...\n"),
1065 info->scan.wim_target_path);
1067 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1069 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1070 switch (info->scan.status) {
1071 case WIMLIB_SCAN_DENTRY_OK:
1072 report_scan_progress(&info->scan, false);
1074 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1075 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1077 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1078 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1079 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1081 case WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK:
1082 imagex_printf(T("\nWARNING: Ignoring absolute symbolic link "
1083 "with out-of-tree target:\n"
1084 " \"%"TS"\" => \"%"TS"\"\n"
1085 " (Use --norpfix to capture "
1086 "absolute symbolic links as-is)\n"),
1087 info->scan.cur_path, info->scan.symlink_target);
1091 case WIMLIB_PROGRESS_MSG_SCAN_END:
1092 report_scan_progress(&info->scan, true);
1093 imagex_printf(T("\n"));
1095 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1096 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1097 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1098 info->integrity.total_bytes);
1099 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1100 "of %"PRIu64" %"TS" (%u%%) done"),
1101 info->integrity.filename,
1102 info->integrity.completed_bytes >> unit_shift,
1104 info->integrity.total_bytes >> unit_shift,
1107 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1108 imagex_printf(T("\n"));
1110 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1111 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1112 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1113 info->integrity.total_bytes);
1114 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1115 "of %"PRIu64" %"TS" (%u%%) done"),
1116 info->integrity.completed_bytes >> unit_shift,
1118 info->integrity.total_bytes >> unit_shift,
1121 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1122 imagex_printf(T("\n"));
1124 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1125 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1126 "to %"TS" \"%"TS"\"\n"),
1127 info->extract.image,
1128 info->extract.image_name,
1129 info->extract.wimfile_name,
1130 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1131 T("NTFS volume") : T("directory")),
1132 info->extract.target);
1134 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1135 percent_done = TO_PERCENT(info->extract.completed_bytes,
1136 info->extract.total_bytes);
1137 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1138 imagex_printf(T("\rExtracting files: "
1139 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1140 info->extract.completed_bytes >> unit_shift,
1142 info->extract.total_bytes >> unit_shift,
1145 if (info->extract.completed_bytes >= info->extract.total_bytes)
1146 imagex_printf(T("\n"));
1148 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1149 if (info->extract.total_parts != 1) {
1150 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1151 info->extract.part_number,
1152 info->extract.total_parts);
1155 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1156 percent_done = TO_PERCENT(info->split.completed_bytes,
1157 info->split.total_bytes);
1158 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1159 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1160 "%"PRIu64" %"TS" (%u%%) written\n"),
1161 info->split.part_name,
1162 info->split.cur_part_number,
1163 info->split.total_parts,
1164 info->split.completed_bytes >> unit_shift,
1166 info->split.total_bytes >> unit_shift,
1170 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1171 if (info->split.completed_bytes == info->split.total_bytes) {
1172 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1173 info->split.cur_part_number,
1174 info->split.total_parts);
1177 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1178 switch (info->update.command->op) {
1179 case WIMLIB_UPDATE_OP_DELETE:
1180 imagex_printf(T("Deleted WIM path \"%"TS"\"\n"),
1181 info->update.command->delete_.wim_path);
1183 case WIMLIB_UPDATE_OP_RENAME:
1184 imagex_printf(T("Renamed WIM path \"%"TS"\" => \"%"TS"\"\n"),
1185 info->update.command->rename.wim_source_path,
1186 info->update.command->rename.wim_target_path);
1188 case WIMLIB_UPDATE_OP_ADD:
1193 case WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM:
1194 imagex_printf(T("Updating \"%"TS"\" in WIM image\n"),
1195 info->replace.path_in_wim);
1197 case WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE:
1198 imagex_printf(T("\nExtracting \"%"TS"\" as normal file (not WIMBoot pointer)\n"),
1199 info->wimboot_exclude.path_in_wim);
1204 fflush(imagex_info_file);
1205 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1209 parse_num_threads(const tchar *optarg)
1212 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1213 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1214 imagex_error(T("Number of threads must be a non-negative integer!"));
1221 static uint32_t parse_chunk_size(const tchar *optarg)
1224 unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1225 if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1226 imagex_error(T("Chunk size must be a non-negative integer!"));
1235 * Parse an option passed to an update command.
1237 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1240 * @option: Text string for the option (beginning with --)
1242 * @cmd: `struct wimlib_update_command' that is being constructed for
1245 * Returns true if the option was recognized; false if not.
1248 update_command_add_option(int op, const tchar *option,
1249 struct wimlib_update_command *cmd)
1251 bool recognized = true;
1253 case WIMLIB_UPDATE_OP_ADD:
1254 if (!tstrcmp(option, T("--verbose")))
1255 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1256 else if (!tstrcmp(option, T("--unix-data")))
1257 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1258 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1259 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1260 else if (!tstrcmp(option, T("--strict-acls")))
1261 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1262 else if (!tstrcmp(option, T("--dereference")))
1263 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1264 else if (!tstrcmp(option, T("--no-replace")))
1265 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
1269 case WIMLIB_UPDATE_OP_DELETE:
1270 if (!tstrcmp(option, T("--force")))
1271 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1272 else if (!tstrcmp(option, T("--recursive")))
1273 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1284 /* How many nonoption arguments each `imagex update' command expects */
1285 static const unsigned update_command_num_nonoptions[] = {
1286 [WIMLIB_UPDATE_OP_ADD] = 2,
1287 [WIMLIB_UPDATE_OP_DELETE] = 1,
1288 [WIMLIB_UPDATE_OP_RENAME] = 2,
1292 update_command_add_nonoption(int op, const tchar *nonoption,
1293 struct wimlib_update_command *cmd,
1294 unsigned num_nonoptions)
1297 case WIMLIB_UPDATE_OP_ADD:
1298 if (num_nonoptions == 0)
1299 cmd->add.fs_source_path = (tchar*)nonoption;
1301 cmd->add.wim_target_path = (tchar*)nonoption;
1303 case WIMLIB_UPDATE_OP_DELETE:
1304 cmd->delete_.wim_path = (tchar*)nonoption;
1306 case WIMLIB_UPDATE_OP_RENAME:
1307 if (num_nonoptions == 0)
1308 cmd->rename.wim_source_path = (tchar*)nonoption;
1310 cmd->rename.wim_target_path = (tchar*)nonoption;
1316 * Parse a command passed on stdin to `imagex update'.
1318 * @line: Text of the command.
1319 * @len: Length of the line, including a null terminator
1322 * @command: A `struct wimlib_update_command' to fill in from the parsed
1325 * @line_number: Line number of the command, for diagnostics.
1327 * Returns true on success; returns false on parse error.
1330 parse_update_command(tchar *line, size_t len,
1331 struct wimlib_update_command *command,
1335 tchar *command_name;
1337 size_t num_nonoptions;
1339 /* Get the command name ("add", "delete", "rename") */
1340 ret = parse_string(&line, &len, &command_name);
1341 if (ret != PARSE_STRING_SUCCESS)
1344 if (!tstrcasecmp(command_name, T("add"))) {
1345 op = WIMLIB_UPDATE_OP_ADD;
1346 } else if (!tstrcasecmp(command_name, T("delete"))) {
1347 op = WIMLIB_UPDATE_OP_DELETE;
1348 } else if (!tstrcasecmp(command_name, T("rename"))) {
1349 op = WIMLIB_UPDATE_OP_RENAME;
1351 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1352 command_name, line_number);
1357 /* Parse additional options and non-options as needed */
1362 ret = parse_string(&line, &len, &next_string);
1363 if (ret == PARSE_STRING_NONE) /* End of line */
1365 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1367 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1369 if (!update_command_add_option(op, next_string, command))
1371 imagex_error(T("Unrecognized option \"%"TS"\" to "
1372 "update command \"%"TS"\" on line %zu"),
1373 next_string, command_name, line_number);
1379 if (num_nonoptions == update_command_num_nonoptions[op])
1381 imagex_error(T("Unexpected argument \"%"TS"\" in "
1382 "update command on line %zu\n"
1383 " (The \"%"TS"\" command only "
1384 "takes %zu nonoption arguments!)\n"),
1385 next_string, line_number,
1386 command_name, num_nonoptions);
1389 update_command_add_nonoption(op, next_string,
1390 command, num_nonoptions);
1395 if (num_nonoptions != update_command_num_nonoptions[op]) {
1396 imagex_error(T("Not enough arguments to update command "
1397 "\"%"TS"\" on line %zu"), command_name, line_number);
1403 static struct wimlib_update_command *
1404 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1405 size_t *num_cmds_ret)
1409 struct wimlib_update_command *cmds;
1412 nlines = text_file_count_lines(cmd_file_contents_p,
1417 /* Always allocate at least 1 slot, just in case the implementation of
1418 * calloc() returns NULL if 0 bytes are requested. */
1419 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1421 imagex_error(T("out of memory"));
1424 p = *cmd_file_contents_p;
1426 for (i = 0; i < nlines; i++) {
1427 /* XXX: Could use rawmemchr() here instead, but it may not be
1428 * available on all platforms. */
1429 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1430 size_t len = endp - p + 1;
1432 if (!is_comment_line(p, len)) {
1433 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1444 /* Apply one image, or all images, from a WIM file to a directory, OR apply
1445 * one image from a WIM file to an NTFS volume. */
1447 imagex_apply(int argc, tchar **argv, int cmd)
1451 int image = WIMLIB_NO_IMAGE;
1453 struct wimlib_wim_info info;
1455 const tchar *wimfile;
1456 const tchar *target;
1457 const tchar *image_num_or_name = NULL;
1458 int extract_flags = 0;
1460 STRING_SET(refglobs);
1462 for_opt(c, apply_options) {
1464 case IMAGEX_CHECK_OPTION:
1465 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1467 case IMAGEX_VERBOSE_OPTION:
1468 /* No longer does anything. */
1470 case IMAGEX_REF_OPTION:
1471 ret = string_set_append(&refglobs, optarg);
1473 goto out_free_refglobs;
1475 case IMAGEX_UNIX_DATA_OPTION:
1476 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1478 case IMAGEX_NO_ACLS_OPTION:
1479 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1481 case IMAGEX_STRICT_ACLS_OPTION:
1482 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1484 case IMAGEX_NO_ATTRIBUTES_OPTION:
1485 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
1487 case IMAGEX_NORPFIX_OPTION:
1488 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1490 case IMAGEX_RPFIX_OPTION:
1491 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1493 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1494 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1495 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1497 case IMAGEX_RESUME_OPTION:
1498 extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1500 case IMAGEX_WIMBOOT_OPTION:
1501 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
1509 if (argc != 2 && argc != 3)
1514 if (!tstrcmp(wimfile, T("-"))) {
1515 /* Attempt to apply pipable WIM from standard input. */
1517 image_num_or_name = NULL;
1520 image_num_or_name = argv[1];
1525 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
1526 imagex_progress_func, NULL);
1528 goto out_free_refglobs;
1530 wimlib_get_wim_info(wim, &info);
1533 /* Image explicitly specified. */
1534 image_num_or_name = argv[1];
1535 image = wimlib_resolve_image(wim, image_num_or_name);
1536 ret = verify_image_exists(image, image_num_or_name, wimfile);
1538 goto out_wimlib_free;
1541 /* No image specified; default to image 1, but only if the WIM
1542 * contains exactly one image. */
1544 if (info.image_count != 1) {
1545 imagex_error(T("\"%"TS"\" contains %d images; "
1546 "Please select one (or all)."),
1547 wimfile, info.image_count);
1556 if (refglobs.num_strings) {
1558 imagex_error(T("Can't specify --ref when applying from stdin!"));
1560 goto out_wimlib_free;
1562 ret = wim_reference_globs(wim, &refglobs, open_flags);
1564 goto out_wimlib_free;
1569 /* Interpret a regular file or block device target as an NTFS
1573 if (tstat(target, &stbuf)) {
1574 if (errno != ENOENT) {
1575 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1578 goto out_wimlib_free;
1581 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1582 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1588 ret = wimlib_extract_image(wim, image, target, extract_flags);
1590 set_fd_to_binary_mode(STDIN_FILENO);
1591 ret = wimlib_extract_image_from_pipe_with_progress(
1596 imagex_progress_func,
1600 imagex_printf(T("Done applying WIM image.\n"));
1601 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1603 do_resource_not_found_warning(wimfile, &info, &refglobs);
1605 imagex_error(T( "If you are applying an image "
1606 "from a split pipable WIM,\n"
1607 " make sure you have "
1608 "concatenated together all parts."));
1614 string_set_destroy(&refglobs);
1618 usage(CMD_APPLY, stderr);
1620 goto out_free_refglobs;
1623 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1624 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1625 * the desired image. 'wimlib-imagex append': add a new image to an existing
1628 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1631 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1632 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1633 WIMLIB_ADD_IMAGE_FLAG_WINCONFIG |
1634 WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1635 int write_flags = 0;
1636 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1637 uint32_t chunk_size = UINT32_MAX;
1638 uint32_t pack_chunk_size = UINT32_MAX;
1639 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
1640 const tchar *wimfile;
1644 const tchar *flags_element = NULL;
1647 STRING_SET(base_wimfiles);
1648 WIMStruct **base_wims;
1650 WIMStruct *template_wim;
1651 const tchar *template_wimfile = NULL;
1652 const tchar *template_image_name_or_num = NULL;
1653 int template_image = WIMLIB_NO_IMAGE;
1656 unsigned num_threads = 0;
1661 tchar *config_file = NULL;
1663 bool source_list = false;
1664 size_t source_list_nchars = 0;
1665 tchar *source_list_contents;
1666 bool capture_sources_malloced;
1667 struct wimlib_capture_source *capture_sources;
1669 bool name_defaulted;
1670 bool compress_slow = false;
1672 for_opt(c, capture_or_append_options) {
1674 case IMAGEX_BOOT_OPTION:
1675 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1677 case IMAGEX_CHECK_OPTION:
1678 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1679 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1681 case IMAGEX_NOCHECK_OPTION:
1682 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1684 case IMAGEX_CONFIG_OPTION:
1685 config_file = optarg;
1686 add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1688 case IMAGEX_COMPRESS_OPTION:
1689 compression_type = get_compression_type(optarg);
1690 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1693 case IMAGEX_COMPRESS_SLOW_OPTION:
1694 compress_slow = true;
1696 case IMAGEX_CHUNK_SIZE_OPTION:
1697 chunk_size = parse_chunk_size(optarg);
1698 if (chunk_size == UINT32_MAX)
1701 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
1702 pack_chunk_size = parse_chunk_size(optarg);
1703 if (pack_chunk_size == UINT32_MAX)
1706 case IMAGEX_PACK_COMPRESS_OPTION:
1707 pack_ctype = get_compression_type(optarg);
1708 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
1711 case IMAGEX_PACK_STREAMS_OPTION:
1712 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1714 case IMAGEX_FLAGS_OPTION:
1715 flags_element = optarg;
1717 case IMAGEX_DEREFERENCE_OPTION:
1718 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1720 case IMAGEX_VERBOSE_OPTION:
1721 /* No longer does anything. */
1723 case IMAGEX_THREADS_OPTION:
1724 num_threads = parse_num_threads(optarg);
1725 if (num_threads == UINT_MAX)
1728 case IMAGEX_REBUILD_OPTION:
1729 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1731 case IMAGEX_UNIX_DATA_OPTION:
1732 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1734 case IMAGEX_SOURCE_LIST_OPTION:
1737 case IMAGEX_NO_ACLS_OPTION:
1738 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1740 case IMAGEX_STRICT_ACLS_OPTION:
1741 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1743 case IMAGEX_RPFIX_OPTION:
1744 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1746 case IMAGEX_NORPFIX_OPTION:
1747 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1749 case IMAGEX_PIPABLE_OPTION:
1750 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1752 case IMAGEX_NOT_PIPABLE_OPTION:
1753 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1755 case IMAGEX_UPDATE_OF_OPTION:
1756 if (template_image_name_or_num) {
1757 imagex_error(T("'--update-of' can only be "
1758 "specified one time!"));
1762 colon = tstrrchr(optarg, T(':'));
1765 template_wimfile = optarg;
1767 template_image_name_or_num = colon + 1;
1769 template_wimfile = NULL;
1770 template_image_name_or_num = optarg;
1774 case IMAGEX_DELTA_FROM_OPTION:
1775 if (cmd != CMD_CAPTURE) {
1776 imagex_error(T("'--delta-from' is only "
1777 "valid for capture!"));
1780 ret = string_set_append(&base_wimfiles, optarg);
1782 goto out_free_base_wimfiles;
1783 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1785 case IMAGEX_WIMBOOT_OPTION:
1786 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_WIMBOOT;
1795 if (argc < 2 || argc > 4)
1801 /* Set default compression type and parameters. */
1804 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1805 /* No compression type specified. Use the default. */
1807 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) {
1808 /* With --wimboot, default to XPRESS compression. */
1809 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
1810 } else if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS) {
1811 /* With --pack-streams or --solid, default to LZMS
1812 * compression. (However, this will not affect packed
1814 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
1816 /* Otherwise, default to LZX compression in fast mode.
1818 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1819 if (!compress_slow && pack_ctype != WIMLIB_COMPRESSION_TYPE_LZX) {
1820 struct wimlib_lzx_compressor_params params = {
1821 .hdr.size = sizeof(params),
1822 .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
1825 wimlib_set_default_compressor_params(WIMLIB_COMPRESSION_TYPE_LZX,
1832 set_compress_slow();
1834 if (!tstrcmp(wimfile, T("-"))) {
1835 /* Writing captured WIM to standard output. */
1837 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1838 imagex_error("Can't write a non-pipable WIM to "
1839 "standard output! Specify --pipable\n"
1840 " if you want to create a pipable WIM "
1841 "(but read the docs first).");
1845 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1847 if (cmd == CMD_APPEND) {
1848 imagex_error(T("Using standard output for append does "
1849 "not make sense."));
1852 wim_fd = STDOUT_FILENO;
1854 imagex_info_file = stderr;
1855 set_fd_to_binary_mode(wim_fd);
1858 /* If template image was specified using --update-of=IMAGE rather
1859 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
1860 if (template_image_name_or_num && !template_wimfile) {
1861 if (base_wimfiles.num_strings == 1) {
1862 /* Capturing delta WIM based on single WIM: default to
1864 template_wimfile = base_wimfiles.strings[0];
1865 } else if (cmd == CMD_APPEND) {
1866 /* Appending to WIM: default to WIM being appended to.
1868 template_wimfile = wimfile;
1870 /* Capturing a normal (non-delta) WIM, so the WIM file
1871 * *must* be explicitly specified. */
1872 if (base_wimfiles.num_strings > 1) {
1873 imagex_error(T("For capture of delta WIM "
1874 "based on multiple existing "
1876 " '--update-of' must "
1877 "specify WIMFILE:IMAGE!"));
1879 imagex_error(T("For capture of non-delta WIM, "
1880 "'--update-of' must specify "
1889 name_defaulted = false;
1891 /* Set default name to SOURCE argument, omitting any directory
1892 * prefixes and trailing slashes. This requires making a copy
1893 * of @source. Leave some free characters at the end in case we
1894 * append a number to keep the name unique. */
1895 size_t source_name_len;
1897 source_name_len = tstrlen(source);
1898 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1899 name = tbasename(tstrcpy(source_copy, source));
1900 name_defaulted = true;
1902 /* Image description defaults to NULL if not given. */
1909 /* Set up capture sources in source list mode */
1910 if (source[0] == T('-') && source[1] == T('\0')) {
1911 source_list_contents = stdin_get_text_contents(&source_list_nchars);
1913 source_list_contents = file_get_text_contents(source,
1914 &source_list_nchars);
1916 if (!source_list_contents)
1919 capture_sources = parse_source_list(&source_list_contents,
1922 if (!capture_sources) {
1924 goto out_free_source_list_contents;
1926 capture_sources_malloced = true;
1928 /* Set up capture source in non-source-list mode. */
1929 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1930 capture_sources[0].fs_source_path = source;
1931 capture_sources[0].wim_target_path = WIMLIB_WIM_ROOT_PATH;
1932 capture_sources[0].reserved = 0;
1934 capture_sources_malloced = false;
1935 source_list_contents = NULL;
1938 /* Open the existing WIM, or create a new one. */
1939 if (cmd == CMD_APPEND) {
1940 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
1941 imagex_progress_func, NULL);
1943 goto out_free_capture_sources;
1945 ret = wimlib_create_new_wim(compression_type, &wim);
1947 goto out_free_capture_sources;
1948 wimlib_register_progress_function(wim, imagex_progress_func, NULL);
1951 /* Set chunk size if non-default. */
1952 if (chunk_size != UINT32_MAX) {
1953 ret = wimlib_set_output_chunk_size(wim, chunk_size);
1956 } else if ((add_image_flags & WIMLIB_ADD_IMAGE_FLAG_WIMBOOT) &&
1957 compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS) {
1958 ret = wimlib_set_output_chunk_size(wim, 4096);
1962 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
1963 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
1967 if (pack_chunk_size != UINT32_MAX) {
1968 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
1974 /* Detect if source is regular file or block device and set NTFS volume
1979 if (tstat(source, &stbuf) == 0) {
1980 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1981 imagex_printf(T("Capturing WIM image from NTFS "
1982 "filesystem on \"%"TS"\"\n"), source);
1983 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1986 if (errno != ENOENT) {
1987 imagex_error_with_errno(T("Failed to stat "
1988 "\"%"TS"\""), source);
1996 /* If the user did not specify an image name, and the basename of the
1997 * source already exists as an image name in the WIM file, append a
1998 * suffix to make it unique. */
1999 if (cmd == CMD_APPEND && name_defaulted) {
2000 unsigned long conflict_idx;
2001 tchar *name_end = tstrchr(name, T('\0'));
2002 for (conflict_idx = 1;
2003 wimlib_image_name_in_use(wim, name);
2006 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2010 /* If capturing a delta WIM, reference resources from the base WIMs
2011 * before adding the new image. */
2012 if (base_wimfiles.num_strings) {
2013 base_wims = calloc(base_wimfiles.num_strings,
2014 sizeof(base_wims[0]));
2015 if (base_wims == NULL) {
2016 imagex_error(T("Out of memory!"));
2021 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2022 ret = wimlib_open_wim_with_progress(
2023 base_wimfiles.strings[i],
2024 open_flags, &base_wims[i],
2025 imagex_progress_func, NULL);
2027 goto out_free_base_wims;
2031 ret = wimlib_reference_resources(wim, base_wims,
2032 base_wimfiles.num_strings, 0);
2034 goto out_free_base_wims;
2036 if (base_wimfiles.num_strings == 1) {
2037 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2038 base_wimfiles.strings[0]);
2040 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2041 base_wimfiles.num_strings);
2048 /* If capturing or appending as an update of an existing (template) image,
2049 * open the WIM if needed and parse the image index. */
2050 if (template_image_name_or_num) {
2053 if (base_wimfiles.num_strings == 1 &&
2054 template_wimfile == base_wimfiles.strings[0]) {
2055 template_wim = base_wims[0];
2056 } else if (template_wimfile == wimfile) {
2059 ret = wimlib_open_wim_with_progress(template_wimfile,
2062 imagex_progress_func,
2065 goto out_free_base_wims;
2068 template_image = wimlib_resolve_image(template_wim,
2069 template_image_name_or_num);
2071 if (template_image_name_or_num[0] == T('-')) {
2074 struct wimlib_wim_info info;
2076 wimlib_get_wim_info(template_wim, &info);
2077 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2078 if (n >= 1 && n <= info.image_count &&
2080 tmp != template_image_name_or_num + 1)
2082 template_image = info.image_count - (n - 1);
2085 ret = verify_image_exists_and_is_single(template_image,
2086 template_image_name_or_num,
2089 goto out_free_template_wim;
2091 template_wim = NULL;
2094 ret = wimlib_add_image_multisource(wim,
2101 goto out_free_template_wim;
2103 if (desc || flags_element || template_image_name_or_num) {
2104 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2105 * on which the added one is to be based has been specified with
2106 * --update-of. Get the index of the image we just
2107 * added, then use it to call the appropriate functions. */
2108 struct wimlib_wim_info info;
2110 wimlib_get_wim_info(wim, &info);
2113 ret = wimlib_set_image_descripton(wim,
2117 goto out_free_template_wim;
2120 if (flags_element) {
2121 ret = wimlib_set_image_flags(wim, info.image_count,
2124 goto out_free_template_wim;
2127 /* Reference template image if the user provided one. */
2128 if (template_image_name_or_num) {
2129 imagex_printf(T("Using image %d "
2130 "from \"%"TS"\" as template\n"),
2131 template_image, template_wimfile);
2132 ret = wimlib_reference_template_image(wim,
2138 goto out_free_template_wim;
2142 /* Write the new WIM or overwrite the existing WIM with the new image
2144 if (cmd == CMD_APPEND) {
2145 ret = wimlib_overwrite(wim, write_flags, num_threads);
2146 } else if (wimfile) {
2147 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2148 write_flags, num_threads);
2150 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2151 write_flags, num_threads);
2153 out_free_template_wim:
2154 /* template_wim may alias base_wims[0] or wim. */
2155 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2156 template_wim != wim)
2157 wimlib_free(template_wim);
2159 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2160 wimlib_free(base_wims[i]);
2164 out_free_capture_sources:
2165 if (capture_sources_malloced)
2166 free(capture_sources);
2167 out_free_source_list_contents:
2168 free(source_list_contents);
2169 out_free_base_wimfiles:
2170 string_set_destroy(&base_wimfiles);
2177 goto out_free_base_wimfiles;
2180 /* Remove image(s) from a WIM. */
2182 imagex_delete(int argc, tchar **argv, int cmd)
2185 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2186 int write_flags = 0;
2187 const tchar *wimfile;
2188 const tchar *image_num_or_name;
2193 for_opt(c, delete_options) {
2195 case IMAGEX_CHECK_OPTION:
2196 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2197 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2199 case IMAGEX_SOFT_OPTION:
2200 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2211 imagex_error(T("Must specify a WIM file"));
2213 imagex_error(T("Must specify an image"));
2217 image_num_or_name = argv[1];
2219 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
2220 imagex_progress_func, NULL);
2224 image = wimlib_resolve_image(wim, image_num_or_name);
2226 ret = verify_image_exists(image, image_num_or_name, wimfile);
2228 goto out_wimlib_free;
2230 ret = wimlib_delete_image(wim, image);
2232 imagex_error(T("Failed to delete image from \"%"TS"\""),
2234 goto out_wimlib_free;
2237 ret = wimlib_overwrite(wim, write_flags, 0);
2239 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2240 "deleted"), wimfile);
2248 usage(CMD_DELETE, stderr);
2253 struct print_dentry_options {
2258 print_dentry_full_path(const struct wimlib_dir_entry *dentry)
2260 tprintf(T("%"TS"\n"), dentry->full_path);
2263 static const struct {
2266 } file_attr_flags[] = {
2267 {WIMLIB_FILE_ATTRIBUTE_READONLY, T("READONLY")},
2268 {WIMLIB_FILE_ATTRIBUTE_HIDDEN, T("HIDDEN")},
2269 {WIMLIB_FILE_ATTRIBUTE_SYSTEM, T("SYSTEM")},
2270 {WIMLIB_FILE_ATTRIBUTE_DIRECTORY, T("DIRECTORY")},
2271 {WIMLIB_FILE_ATTRIBUTE_ARCHIVE, T("ARCHIVE")},
2272 {WIMLIB_FILE_ATTRIBUTE_DEVICE, T("DEVICE")},
2273 {WIMLIB_FILE_ATTRIBUTE_NORMAL, T("NORMAL")},
2274 {WIMLIB_FILE_ATTRIBUTE_TEMPORARY, T("TEMPORARY")},
2275 {WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE, T("SPARSE_FILE")},
2276 {WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT, T("REPARSE_POINT")},
2277 {WIMLIB_FILE_ATTRIBUTE_COMPRESSED, T("COMPRESSED")},
2278 {WIMLIB_FILE_ATTRIBUTE_OFFLINE, T("OFFLINE")},
2279 {WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED, T("NOT_CONTENT_INDEXED")},
2280 {WIMLIB_FILE_ATTRIBUTE_ENCRYPTED, T("ENCRYPTED")},
2281 {WIMLIB_FILE_ATTRIBUTE_VIRTUAL, T("VIRTUAL")},
2284 #define TIMESTR_MAX 100
2287 timespec_to_string(const struct timespec *spec, tchar *buf)
2289 time_t t = spec->tv_sec;
2292 tstrftime(buf, TIMESTR_MAX, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
2293 buf[TIMESTR_MAX - 1] = '\0';
2297 print_time(const tchar *type, const struct timespec *spec)
2299 tchar timestr[TIMESTR_MAX];
2301 timespec_to_string(spec, timestr);
2303 tprintf(T("%-20"TS"= %"TS"\n"), type, timestr);
2306 static void print_byte_field(const uint8_t field[], size_t len)
2309 tprintf(T("%02hhx"), *field++);
2313 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2315 tputs(T("WIM Information:"));
2316 tputs(T("----------------"));
2317 tprintf(T("Path: %"TS"\n"), wimfile);
2318 tprintf(T("GUID: 0x"));
2319 print_byte_field(info->guid, sizeof(info->guid));
2321 tprintf(T("Version: %u\n"), info->wim_version);
2322 tprintf(T("Image Count: %d\n"), info->image_count);
2323 tprintf(T("Compression: %"TS"\n"),
2324 wimlib_get_compression_type_string(info->compression_type));
2325 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2327 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2328 tprintf(T("Boot Index: %d\n"), info->boot_index);
2329 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2330 tprintf(T("Integrity Info: %"TS"\n"),
2331 info->has_integrity_table ? T("yes") : T("no"));
2332 tprintf(T("Relative path junction: %"TS"\n"),
2333 info->has_rpfix ? T("yes") : T("no"));
2334 tprintf(T("Pipable: %"TS"\n"),
2335 info->pipable ? T("yes") : T("no"));
2340 print_resource(const struct wimlib_resource_entry *resource,
2343 tprintf(T("Hash = 0x"));
2344 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2347 if (!resource->is_missing) {
2348 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2349 resource->uncompressed_size);
2350 if (resource->packed) {
2351 tprintf(T("Raw compressed size = %"PRIu64" bytes\n"),
2352 resource->raw_resource_compressed_size);
2354 tprintf(T("Raw offset in WIM = %"PRIu64" bytes\n"),
2355 resource->raw_resource_offset_in_wim);
2357 tprintf(T("Offset in raw = %"PRIu64" bytes\n"),
2360 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2361 resource->compressed_size);
2363 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2367 tprintf(T("Part Number = %u\n"), resource->part_number);
2368 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2370 tprintf(T("Flags = "));
2371 if (resource->is_compressed)
2372 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2373 if (resource->is_metadata)
2374 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2375 if (resource->is_free)
2376 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2377 if (resource->is_spanned)
2378 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2379 if (resource->packed)
2380 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS "));
2388 print_lookup_table(WIMStruct *wim)
2390 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2394 default_print_security_descriptor(const uint8_t *sd, size_t size)
2396 tprintf(T("Security Descriptor = "));
2397 print_byte_field(sd, size);
2402 print_dentry_detailed(const struct wimlib_dir_entry *dentry)
2406 "----------------------------------------------------------------------------\n"));
2407 tprintf(T("Full Path = \"%"TS"\"\n"), dentry->full_path);
2408 if (dentry->dos_name)
2409 tprintf(T("Short Name = \"%"TS"\"\n"), dentry->dos_name);
2410 tprintf(T("Attributes = 0x%08x\n"), dentry->attributes);
2411 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
2412 if (file_attr_flags[i].flag & dentry->attributes)
2413 tprintf(T(" FILE_ATTRIBUTE_%"TS" is set\n"),
2414 file_attr_flags[i].name);
2416 if (dentry->security_descriptor) {
2417 print_security_descriptor(dentry->security_descriptor,
2418 dentry->security_descriptor_size);
2421 print_time(T("Creation Time"), &dentry->creation_time);
2422 print_time(T("Last Write Time"), &dentry->last_write_time);
2423 print_time(T("Last Access Time"), &dentry->last_access_time);
2426 if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT)
2427 tprintf(T("Reparse Tag = 0x%"PRIx32"\n"), dentry->reparse_tag);
2429 tprintf(T("Link Group ID = 0x%016"PRIx64"\n"), dentry->hard_link_group_id);
2430 tprintf(T("Link Count = %"PRIu32"\n"), dentry->num_links);
2432 if (dentry->unix_mode != 0) {
2433 tprintf(T("UNIX Data = uid:%"PRIu32" gid:%"PRIu32" mode:0%"PRIo32"\n"),
2434 dentry->unix_uid, dentry->unix_gid, dentry->unix_mode);
2437 for (uint32_t i = 0; i <= dentry->num_named_streams; i++) {
2438 if (dentry->streams[i].stream_name) {
2439 tprintf(T("\tData stream \"%"TS"\":\n"),
2440 dentry->streams[i].stream_name);
2442 tprintf(T("\tUnnamed data stream:\n"));
2444 print_resource(&dentry->streams[i].resource, NULL);
2449 print_dentry(const struct wimlib_dir_entry *dentry, void *_options)
2451 const struct print_dentry_options *options = _options;
2452 if (!options->detailed)
2453 print_dentry_full_path(dentry);
2455 print_dentry_detailed(dentry);
2459 /* Print the files contained in an image(s) in a WIM file. */
2461 imagex_dir(int argc, tchar **argv, int cmd)
2463 const tchar *wimfile;
2464 WIMStruct *wim = NULL;
2467 const tchar *path = WIMLIB_WIM_ROOT_PATH;
2469 struct print_dentry_options options = {
2472 int iterate_flags = WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2474 for_opt(c, dir_options) {
2476 case IMAGEX_PATH_OPTION:
2479 case IMAGEX_DETAILED_OPTION:
2480 options.detailed = true;
2482 case IMAGEX_ONE_FILE_ONLY_OPTION:
2483 iterate_flags &= ~WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2493 imagex_error(T("Must specify a WIM file"));
2497 imagex_error(T("Too many arguments"));
2502 ret = wimlib_open_wim_with_progress(wimfile, 0, &wim,
2503 imagex_progress_func, NULL);
2508 image = wimlib_resolve_image(wim, argv[1]);
2509 ret = verify_image_exists(image, argv[1], wimfile);
2511 goto out_wimlib_free;
2513 /* No image specified; default to image 1, but only if the WIM
2514 * contains exactly one image. */
2516 struct wimlib_wim_info info;
2518 wimlib_get_wim_info(wim, &info);
2519 if (info.image_count != 1) {
2520 imagex_error(T("\"%"TS"\" contains %d images; Please "
2521 "select one (or all)."),
2522 wimfile, info.image_count);
2529 ret = wimlib_iterate_dir_tree(wim, image, path, iterate_flags,
2530 print_dentry, &options);
2537 usage(CMD_DIR, stderr);
2542 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2545 imagex_export(int argc, tchar **argv, int cmd)
2549 int export_flags = WIMLIB_EXPORT_FLAG_GIFT;
2550 int write_flags = 0;
2551 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2552 const tchar *src_wimfile;
2553 const tchar *src_image_num_or_name;
2554 const tchar *dest_wimfile;
2556 const tchar *dest_name;
2557 const tchar *dest_desc;
2559 struct wimlib_wim_info src_info;
2560 WIMStruct *dest_wim;
2565 STRING_SET(refglobs);
2566 unsigned num_threads = 0;
2567 uint32_t chunk_size = UINT32_MAX;
2568 uint32_t pack_chunk_size = UINT32_MAX;
2569 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
2571 for_opt(c, export_options) {
2573 case IMAGEX_BOOT_OPTION:
2574 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2576 case IMAGEX_CHECK_OPTION:
2577 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2578 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2580 case IMAGEX_NOCHECK_OPTION:
2581 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2583 case IMAGEX_COMPRESS_OPTION:
2584 compression_type = get_compression_type(optarg);
2585 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2588 case IMAGEX_COMPRESS_SLOW_OPTION:
2589 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2590 set_compress_slow();
2592 case IMAGEX_PACK_STREAMS_OPTION:
2593 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
2595 case IMAGEX_CHUNK_SIZE_OPTION:
2596 chunk_size = parse_chunk_size(optarg);
2597 if (chunk_size == UINT32_MAX)
2600 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
2601 pack_chunk_size = parse_chunk_size(optarg);
2602 if (pack_chunk_size == UINT32_MAX)
2605 case IMAGEX_PACK_COMPRESS_OPTION:
2606 pack_ctype = get_compression_type(optarg);
2607 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
2610 case IMAGEX_REF_OPTION:
2611 ret = string_set_append(&refglobs, optarg);
2613 goto out_free_refglobs;
2615 case IMAGEX_THREADS_OPTION:
2616 num_threads = parse_num_threads(optarg);
2617 if (num_threads == UINT_MAX)
2620 case IMAGEX_REBUILD_OPTION:
2621 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2623 case IMAGEX_PIPABLE_OPTION:
2624 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2626 case IMAGEX_NOT_PIPABLE_OPTION:
2627 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2629 case IMAGEX_WIMBOOT_OPTION:
2630 export_flags |= WIMLIB_EXPORT_FLAG_WIMBOOT;
2638 if (argc < 3 || argc > 5)
2640 src_wimfile = argv[0];
2641 src_image_num_or_name = argv[1];
2642 dest_wimfile = argv[2];
2643 dest_name = (argc >= 4) ? argv[3] : NULL;
2644 dest_desc = (argc >= 5) ? argv[4] : NULL;
2645 ret = wimlib_open_wim_with_progress(src_wimfile, open_flags, &src_wim,
2646 imagex_progress_func, NULL);
2648 goto out_free_refglobs;
2650 wimlib_get_wim_info(src_wim, &src_info);
2652 /* Determine if the destination is an existing file or not. If so, we
2653 * try to append the exported image(s) to it; otherwise, we create a new
2654 * WIM containing the exported image(s). Furthermore, determine if we
2655 * need to write a pipable WIM directly to standard output. */
2657 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2659 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2660 imagex_error("Can't write a non-pipable WIM to "
2661 "standard output! Specify --pipable\n"
2662 " if you want to create a pipable WIM "
2663 "(but read the docs first).");
2665 goto out_free_src_wim;
2668 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2670 dest_wimfile = NULL;
2671 dest_wim_fd = STDOUT_FILENO;
2672 imagex_info_file = stderr;
2673 set_fd_to_binary_mode(dest_wim_fd);
2676 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2678 /* Destination file exists. */
2680 if (!S_ISREG(stbuf.st_mode)) {
2681 imagex_error(T("\"%"TS"\" is not a regular file"),
2684 goto out_free_src_wim;
2686 ret = wimlib_open_wim_with_progress(dest_wimfile,
2688 WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2690 imagex_progress_func,
2693 goto out_free_src_wim;
2695 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2696 /* The user specified a compression type, but we're
2697 * exporting to an existing WIM. Make sure the
2698 * specified compression type is the same as the
2699 * compression type of the existing destination WIM. */
2700 struct wimlib_wim_info dest_info;
2702 wimlib_get_wim_info(dest_wim, &dest_info);
2703 if (compression_type != dest_info.compression_type) {
2704 imagex_error(T("Cannot specify a compression type that is "
2705 "not the same as that used in the "
2706 "destination WIM"));
2708 goto out_free_dest_wim;
2714 if (errno != ENOENT) {
2715 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2718 goto out_free_src_wim;
2721 /* dest_wimfile is not an existing file, so create a new WIM. */
2723 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2724 /* The user did not specify a compression type; default
2725 * to that of the source WIM, unless --pack-streams,
2726 * --solid, or --wimboot was specified. */
2728 if (write_flags & WIMLIB_WRITE_FLAG_PACK_STREAMS)
2729 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
2730 else if (export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
2731 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
2733 compression_type = src_info.compression_type;
2735 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2737 goto out_free_src_wim;
2739 wimlib_register_progress_function(dest_wim,
2740 imagex_progress_func, NULL);
2742 if ((export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
2743 && compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS)
2745 /* For --wimboot export, use small XPRESS chunks. */
2746 wimlib_set_output_chunk_size(dest_wim, 4096);
2747 } else if (compression_type == src_info.compression_type &&
2748 chunk_size == UINT32_MAX)
2750 /* Use same chunk size if compression type is the same. */
2751 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2755 if (chunk_size != UINT32_MAX) {
2756 /* Set destination chunk size. */
2757 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
2759 goto out_free_dest_wim;
2761 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
2762 ret = wimlib_set_output_pack_compression_type(dest_wim, pack_ctype);
2764 goto out_free_dest_wim;
2766 if (pack_chunk_size != UINT32_MAX) {
2767 ret = wimlib_set_output_pack_chunk_size(dest_wim, pack_chunk_size);
2769 goto out_free_dest_wim;
2772 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2773 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2775 goto out_free_dest_wim;
2777 if (refglobs.num_strings) {
2778 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2780 goto out_free_dest_wim;
2783 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2784 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2786 imagex_error(T("--boot specified for all-images export, but source WIM "
2787 "has no bootable image."));
2789 goto out_free_dest_wim;
2792 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2793 dest_desc, export_flags);
2795 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2796 do_resource_not_found_warning(src_wimfile,
2797 &src_info, &refglobs);
2799 goto out_free_dest_wim;
2803 ret = wimlib_overwrite(dest_wim, write_flags, num_threads);
2804 else if (dest_wimfile)
2805 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2806 write_flags, num_threads);
2808 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2809 WIMLIB_ALL_IMAGES, write_flags,
2812 wimlib_free(dest_wim);
2814 wimlib_free(src_wim);
2816 string_set_destroy(&refglobs);
2820 usage(CMD_EXPORT, stderr);
2823 goto out_free_refglobs;
2826 /* Extract files or directories from a WIM image */
2828 imagex_extract(int argc, tchar **argv, int cmd)
2835 const tchar *wimfile;
2836 const tchar *image_num_or_name;
2837 tchar *dest_dir = T(".");
2838 int extract_flags = WIMLIB_EXTRACT_FLAG_NORPFIX |
2839 WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2840 WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2841 int notlist_extract_flags = WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2843 STRING_SET(refglobs);
2845 tchar *root_path = WIMLIB_WIM_ROOT_PATH;
2847 for_opt(c, extract_options) {
2849 case IMAGEX_CHECK_OPTION:
2850 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2852 case IMAGEX_VERBOSE_OPTION:
2853 /* No longer does anything. */
2855 case IMAGEX_REF_OPTION:
2856 ret = string_set_append(&refglobs, optarg);
2858 goto out_free_refglobs;
2860 case IMAGEX_UNIX_DATA_OPTION:
2861 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2863 case IMAGEX_NO_ACLS_OPTION:
2864 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2866 case IMAGEX_STRICT_ACLS_OPTION:
2867 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2869 case IMAGEX_NO_ATTRIBUTES_OPTION:
2870 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
2872 case IMAGEX_DEST_DIR_OPTION:
2875 case IMAGEX_TO_STDOUT_OPTION:
2876 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2877 imagex_info_file = stderr;
2878 imagex_be_quiet = true;
2879 set_fd_to_binary_mode(STDOUT_FILENO);
2881 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2882 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2883 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2885 case IMAGEX_NO_WILDCARDS_OPTION:
2886 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2888 case IMAGEX_NULLGLOB_OPTION:
2889 extract_flags &= ~WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
2891 case IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION:
2892 notlist_extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
2894 case IMAGEX_WIMBOOT_OPTION:
2895 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
2907 if (!(extract_flags & (WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
2908 WIMLIB_EXTRACT_FLAG_STRICT_GLOB)))
2910 imagex_error(T("Can't combine --no-wildcards and --nullglob!"));
2915 image_num_or_name = argv[1];
2920 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
2921 imagex_progress_func, NULL);
2923 goto out_free_refglobs;
2925 image = wimlib_resolve_image(wim, image_num_or_name);
2926 ret = verify_image_exists_and_is_single(image,
2930 goto out_wimlib_free;
2932 if (refglobs.num_strings) {
2933 ret = wim_reference_globs(wim, &refglobs, open_flags);
2935 goto out_wimlib_free;
2941 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
2944 while (argc != 0 && ret == 0) {
2948 num_paths < argc && argv[num_paths][0] != T('@');
2953 ret = wimlib_extract_paths(wim, image, dest_dir,
2954 (const tchar **)argv,
2956 extract_flags | notlist_extract_flags);
2960 ret = wimlib_extract_pathlist(wim, image, dest_dir,
2969 if (!imagex_be_quiet)
2970 imagex_printf(T("Done extracting files.\n"));
2971 } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2972 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2973 "files and directories\n"
2974 " are in the WIM image.\n"),
2975 get_cmd_string(CMD_DIR, false));
2976 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2977 struct wimlib_wim_info info;
2979 wimlib_get_wim_info(wim, &info);
2980 do_resource_not_found_warning(wimfile, &info, &refglobs);
2985 string_set_destroy(&refglobs);
2989 usage(CMD_EXTRACT, stderr);
2992 goto out_free_refglobs;
2995 /* Prints information about a WIM file; also can mark an image as bootable,
2996 * change the name of an image, or change the description of an image. */
2998 imagex_info(int argc, tchar **argv, int cmd)
3003 bool nocheck = false;
3004 bool header = false;
3005 bool lookup_table = false;
3007 bool short_header = true;
3008 const tchar *xml_out_file = NULL;
3009 const tchar *wimfile;
3010 const tchar *image_num_or_name;
3011 const tchar *new_name;
3012 const tchar *new_desc;
3017 struct wimlib_wim_info info;
3019 for_opt(c, info_options) {
3021 case IMAGEX_BOOT_OPTION:
3024 case IMAGEX_CHECK_OPTION:
3027 case IMAGEX_NOCHECK_OPTION:
3030 case IMAGEX_HEADER_OPTION:
3032 short_header = false;
3034 case IMAGEX_LOOKUP_TABLE_OPTION:
3035 lookup_table = true;
3036 short_header = false;
3038 case IMAGEX_XML_OPTION:
3040 short_header = false;
3042 case IMAGEX_EXTRACT_XML_OPTION:
3043 xml_out_file = optarg;
3044 short_header = false;
3046 case IMAGEX_METADATA_OPTION:
3047 imagex_error(T("The --metadata option has been removed. "
3048 "Use 'wimdir --detail' instead."));
3057 if (argc < 1 || argc > 4)
3061 image_num_or_name = (argc >= 2) ? argv[1] : T("all");
3062 new_name = (argc >= 3) ? argv[2] : NULL;
3063 new_desc = (argc >= 4) ? argv[3] : NULL;
3065 if (check && nocheck) {
3066 imagex_error(T("Can't specify both --check and --nocheck"));
3071 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3073 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
3074 imagex_progress_func, NULL);
3078 wimlib_get_wim_info(wim, &info);
3080 image = wimlib_resolve_image(wim, image_num_or_name);
3081 ret = WIMLIB_ERR_INVALID_IMAGE;
3082 if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
3083 verify_image_exists(image, image_num_or_name, wimfile);
3085 imagex_error(T("If you would like to set the boot "
3086 "index to 0, specify image \"0\" with "
3087 "the --boot flag."));
3089 goto out_wimlib_free;
3092 if (boot && info.image_count == 0) {
3093 imagex_error(T("--boot is meaningless on a WIM with no images"));
3094 goto out_wimlib_free;
3097 if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
3099 imagex_error(T("Cannot specify the --boot flag "
3100 "without specifying a specific "
3101 "image in a multi-image WIM"));
3102 goto out_wimlib_free;
3105 imagex_error(T("Cannot specify the NEW_NAME "
3106 "without specifying a specific "
3107 "image in a multi-image WIM"));
3108 goto out_wimlib_free;
3112 /* Operations that print information are separated from operations that
3113 * recreate the WIM file. */
3114 if (!new_name && !boot) {
3116 /* Read-only operations */
3118 if (image == WIMLIB_NO_IMAGE) {
3119 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
3120 image_num_or_name, wimfile);
3121 goto out_wimlib_free;
3124 if (image == WIMLIB_ALL_IMAGES && short_header)
3125 print_wim_information(wimfile, &info);
3128 wimlib_print_header(wim);
3131 if (info.total_parts != 1) {
3132 tfprintf(stderr, T("Warning: Only showing the lookup table "
3133 "for part %d of a %d-part WIM.\n"),
3134 info.part_number, info.total_parts);
3136 print_lookup_table(wim);
3140 ret = wimlib_extract_xml_data(wim, stdout);
3142 goto out_wimlib_free;
3148 fp = tfopen(xml_out_file, T("wb"));
3150 imagex_error_with_errno(T("Failed to open the "
3151 "file \"%"TS"\" for "
3155 goto out_wimlib_free;
3157 ret = wimlib_extract_xml_data(wim, fp);
3159 imagex_error(T("Failed to close the file "
3165 goto out_wimlib_free;
3169 wimlib_print_available_images(wim, image);
3174 /* Modification operations */
3176 if (image == WIMLIB_ALL_IMAGES)
3179 if (image == WIMLIB_NO_IMAGE && new_name) {
3180 imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3181 "when using image 0"), new_name);
3183 goto out_wimlib_free;
3187 if (image == info.boot_index) {
3188 imagex_printf(T("Image %d is already marked as "
3189 "bootable.\n"), image);
3192 imagex_printf(T("Marking image %d as bootable.\n"),
3194 info.boot_index = image;
3195 ret = wimlib_set_wim_info(wim, &info,
3196 WIMLIB_CHANGE_BOOT_INDEX);
3198 goto out_wimlib_free;
3202 if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3204 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3208 imagex_printf(T("Changing the name of image %d to "
3209 "\"%"TS"\".\n"), image, new_name);
3210 ret = wimlib_set_image_name(wim, image, new_name);
3212 goto out_wimlib_free;
3216 const tchar *old_desc;
3217 old_desc = wimlib_get_image_description(wim, image);
3218 if (old_desc && !tstrcmp(old_desc, new_desc)) {
3219 imagex_printf(T("The description of image %d is already "
3220 "\"%"TS"\".\n"), image, new_desc);
3223 imagex_printf(T("Changing the description of image %d "
3224 "to \"%"TS"\".\n"), image, new_desc);
3225 ret = wimlib_set_image_descripton(wim, image,
3228 goto out_wimlib_free;
3232 /* Only call wimlib_overwrite() if something actually needs to
3234 if (boot || new_name || new_desc ||
3235 (check && !info.has_integrity_table) ||
3236 (nocheck && info.has_integrity_table))
3238 int write_flags = 0;
3241 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3243 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3244 ret = wimlib_overwrite(wim, write_flags, 1);
3246 imagex_printf(T("The file \"%"TS"\" was not modified "
3247 "because nothing needed to be done.\n"),
3258 usage(CMD_INFO, stderr);
3264 /* Join split WIMs into one part WIM */
3266 imagex_join(int argc, tchar **argv, int cmd)
3269 int swm_open_flags = 0;
3270 int wim_write_flags = 0;
3271 const tchar *output_path;
3274 for_opt(c, join_options) {
3276 case IMAGEX_CHECK_OPTION:
3277 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3278 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3288 imagex_error(T("Must specify one or more split WIM (.swm) "
3292 output_path = argv[0];
3293 ret = wimlib_join_with_progress((const tchar * const *)++argv,
3298 imagex_progress_func,
3304 usage(CMD_JOIN, stderr);
3309 #if WIM_MOUNTING_SUPPORTED
3311 /* Mounts a WIM image. */
3313 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3316 int mount_flags = 0;
3318 const tchar *staging_dir = NULL;
3319 const tchar *wimfile;
3322 struct wimlib_wim_info info;
3326 STRING_SET(refglobs);
3328 if (cmd == CMD_MOUNTRW) {
3329 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3330 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3333 for_opt(c, mount_options) {
3335 case IMAGEX_ALLOW_OTHER_OPTION:
3336 mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3338 case IMAGEX_CHECK_OPTION:
3339 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3341 case IMAGEX_DEBUG_OPTION:
3342 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3344 case IMAGEX_STREAMS_INTERFACE_OPTION:
3345 if (!tstrcasecmp(optarg, T("none")))
3346 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3347 else if (!tstrcasecmp(optarg, T("xattr")))
3348 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3349 else if (!tstrcasecmp(optarg, T("windows")))
3350 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3352 imagex_error(T("Unknown stream interface \"%"TS"\""),
3357 case IMAGEX_REF_OPTION:
3358 ret = string_set_append(&refglobs, optarg);
3360 goto out_free_refglobs;
3362 case IMAGEX_STAGING_DIR_OPTION:
3363 staging_dir = optarg;
3365 case IMAGEX_UNIX_DATA_OPTION:
3366 mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3374 if (argc != 2 && argc != 3)
3379 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
3380 imagex_progress_func, NULL);
3382 goto out_free_refglobs;
3384 wimlib_get_wim_info(wim, &info);
3387 /* Image explicitly specified. */
3388 image = wimlib_resolve_image(wim, argv[1]);
3390 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
3394 /* No image specified; default to image 1, but only if the WIM
3395 * contains exactly one image. */
3397 if (info.image_count != 1) {
3398 imagex_error(T("\"%"TS"\" contains %d images; Please "
3399 "select one."), wimfile, info.image_count);
3407 if (refglobs.num_strings) {
3408 ret = wim_reference_globs(wim, &refglobs, open_flags);
3413 ret = wimlib_mount_image(wim, image, dir, mount_flags, staging_dir);
3415 imagex_error(T("Failed to mount image %d from \"%"TS"\" "
3417 image, wimfile, dir);
3422 string_set_destroy(&refglobs);
3428 goto out_free_refglobs;
3430 #endif /* WIM_MOUNTING_SUPPORTED */
3432 /* Rebuild a WIM file */
3434 imagex_optimize(int argc, tchar **argv, int cmd)
3437 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3438 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
3439 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
3440 uint32_t chunk_size = UINT32_MAX;
3441 uint32_t pack_chunk_size = UINT32_MAX;
3442 int pack_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
3445 const tchar *wimfile;
3448 unsigned num_threads = 0;
3450 for_opt(c, optimize_options) {
3452 case IMAGEX_CHECK_OPTION:
3453 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3454 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3456 case IMAGEX_NOCHECK_OPTION:
3457 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3459 case IMAGEX_COMPRESS_OPTION:
3460 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3461 compression_type = get_compression_type(optarg);
3462 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
3465 case IMAGEX_RECOMPRESS_OPTION:
3466 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3468 case IMAGEX_COMPRESS_SLOW_OPTION:
3469 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3470 set_compress_slow();
3472 case IMAGEX_CHUNK_SIZE_OPTION:
3473 chunk_size = parse_chunk_size(optarg);
3474 if (chunk_size == UINT32_MAX)
3477 case IMAGEX_PACK_CHUNK_SIZE_OPTION:
3478 pack_chunk_size = parse_chunk_size(optarg);
3479 if (pack_chunk_size == UINT32_MAX)
3482 case IMAGEX_PACK_COMPRESS_OPTION:
3483 pack_ctype = get_compression_type(optarg);
3484 if (pack_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
3487 case IMAGEX_PACK_STREAMS_OPTION:
3488 write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
3489 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
3491 case IMAGEX_THREADS_OPTION:
3492 num_threads = parse_num_threads(optarg);
3493 if (num_threads == UINT_MAX)
3496 case IMAGEX_PIPABLE_OPTION:
3497 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
3499 case IMAGEX_NOT_PIPABLE_OPTION:
3500 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
3514 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
3515 imagex_progress_func, NULL);
3519 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
3520 /* Change compression type. */
3521 ret = wimlib_set_output_compression_type(wim, compression_type);
3523 goto out_wimlib_free;
3526 if (chunk_size != UINT32_MAX) {
3527 /* Change chunk size. */
3528 ret = wimlib_set_output_chunk_size(wim, chunk_size);
3530 goto out_wimlib_free;
3532 if (pack_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
3533 ret = wimlib_set_output_pack_compression_type(wim, pack_ctype);
3535 goto out_wimlib_free;
3537 if (pack_chunk_size != UINT32_MAX) {
3538 ret = wimlib_set_output_pack_chunk_size(wim, pack_chunk_size);
3540 goto out_wimlib_free;
3543 old_size = file_get_size(wimfile);
3544 tprintf(T("\"%"TS"\" original size: "), wimfile);
3546 tputs(T("Unknown"));
3548 tprintf(T("%"PRIu64" KiB\n"), old_size >> 10);
3550 ret = wimlib_overwrite(wim, write_flags, num_threads);
3552 imagex_error(T("Optimization of \"%"TS"\" failed."), wimfile);
3553 goto out_wimlib_free;
3556 new_size = file_get_size(wimfile);
3557 tprintf(T("\"%"TS"\" optimized size: "), wimfile);
3559 tputs(T("Unknown"));
3561 tprintf(T("%"PRIu64" KiB\n"), new_size >> 10);
3563 tfputs(T("Space saved: "), stdout);
3564 if (new_size != -1 && old_size != -1) {
3565 tprintf(T("%lld KiB\n"),
3566 ((long long)old_size - (long long)new_size) >> 10);
3568 tputs(T("Unknown"));
3577 usage(CMD_OPTIMIZE, stderr);
3583 /* Split a WIM into a spanned set */
3585 imagex_split(int argc, tchar **argv, int cmd)
3589 int write_flags = 0;
3590 unsigned long part_size;
3595 for_opt(c, split_options) {
3597 case IMAGEX_CHECK_OPTION:
3598 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3599 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3611 part_size = tstrtod(argv[2], &tmp) * (1 << 20);
3612 if (tmp == argv[2] || *tmp) {
3613 imagex_error(T("Invalid part size \"%"TS"\""), argv[2]);
3614 imagex_error(T("The part size must be an integer or "
3615 "floating-point number of megabytes."));
3618 ret = wimlib_open_wim_with_progress(argv[0], open_flags, &wim,
3619 imagex_progress_func, NULL);
3623 ret = wimlib_split(wim, argv[1], part_size, write_flags);
3629 usage(CMD_SPLIT, stderr);
3635 #if WIM_MOUNTING_SUPPORTED
3636 /* Unmounts a mounted WIM image. */
3638 imagex_unmount(int argc, tchar **argv, int cmd)
3641 int unmount_flags = 0;
3644 for_opt(c, unmount_options) {
3646 case IMAGEX_COMMIT_OPTION:
3647 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
3649 case IMAGEX_CHECK_OPTION:
3650 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
3652 case IMAGEX_REBUILD_OPTION:
3653 unmount_flags |= WIMLIB_UNMOUNT_FLAG_REBUILD;
3655 case IMAGEX_LAZY_OPTION:
3656 unmount_flags |= WIMLIB_UNMOUNT_FLAG_LAZY;
3658 case IMAGEX_NEW_IMAGE_OPTION:
3659 unmount_flags |= WIMLIB_UNMOUNT_FLAG_NEW_IMAGE;
3670 if (unmount_flags & WIMLIB_UNMOUNT_FLAG_NEW_IMAGE) {
3671 if (!(unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT)) {
3672 imagex_error(T("--new-image is meaningless "
3673 "without --commit also specified!"));
3676 imagex_printf(T("Committing changes as new image...\n"));
3679 ret = wimlib_unmount_image_with_progress(argv[0], unmount_flags,
3680 imagex_progress_func, NULL);
3682 imagex_error(T("Failed to unmount \"%"TS"\""), argv[0]);
3687 usage(CMD_UNMOUNT, stderr);
3692 #endif /* WIM_MOUNTING_SUPPORTED */
3695 * Add, delete, or rename files in a WIM image.
3698 imagex_update(int argc, tchar **argv, int cmd)
3700 const tchar *wimfile;
3704 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3705 int write_flags = 0;
3706 int update_flags = WIMLIB_UPDATE_FLAG_SEND_PROGRESS;
3707 int default_add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
3708 WIMLIB_ADD_FLAG_VERBOSE |
3709 WIMLIB_ADD_FLAG_WINCONFIG;
3710 int default_delete_flags = 0;
3711 unsigned num_threads = 0;
3713 tchar *cmd_file_contents;
3714 size_t cmd_file_nchars;
3715 struct wimlib_update_command *cmds;
3717 tchar *command_str = NULL;
3718 tchar *config_file = NULL;
3719 tchar *wimboot_config = NULL;
3721 for_opt(c, update_options) {
3723 /* Generic or write options */
3724 case IMAGEX_THREADS_OPTION:
3725 num_threads = parse_num_threads(optarg);
3726 if (num_threads == UINT_MAX)
3729 case IMAGEX_CHECK_OPTION:
3730 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3731 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3733 case IMAGEX_REBUILD_OPTION:
3734 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
3736 case IMAGEX_COMMAND_OPTION:
3738 imagex_error(T("--command may only be specified "
3739 "one time. Please provide\n"
3740 " the update commands "
3741 "on standard input instead."));
3744 command_str = tstrdup(optarg);
3746 imagex_error(T("Out of memory!"));
3750 case IMAGEX_WIMBOOT_CONFIG_OPTION:
3751 wimboot_config = optarg;
3753 /* Default delete options */
3754 case IMAGEX_FORCE_OPTION:
3755 default_delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
3757 case IMAGEX_RECURSIVE_OPTION:
3758 default_delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
3761 /* Global add option */
3762 case IMAGEX_CONFIG_OPTION:
3763 default_add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
3764 config_file = optarg;
3767 /* Default add options */
3768 case IMAGEX_VERBOSE_OPTION:
3769 /* No longer does anything. */
3771 case IMAGEX_DEREFERENCE_OPTION:
3772 default_add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
3774 case IMAGEX_UNIX_DATA_OPTION:
3775 default_add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
3777 case IMAGEX_NO_ACLS_OPTION:
3778 default_add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
3780 case IMAGEX_STRICT_ACLS_OPTION:
3781 default_add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
3783 case IMAGEX_NO_REPLACE_OPTION:
3784 default_add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
3793 if (argc != 1 && argc != 2)
3797 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
3798 imagex_progress_func, NULL);
3800 goto out_free_command_str;
3803 /* Image explicitly specified. */
3804 image = wimlib_resolve_image(wim, argv[1]);
3805 ret = verify_image_exists_and_is_single(image, argv[1],
3808 goto out_wimlib_free;
3810 /* No image specified; default to image 1, but only if the WIM
3811 * contains exactly one image. */
3812 struct wimlib_wim_info info;
3814 wimlib_get_wim_info(wim, &info);
3815 if (info.image_count != 1) {
3816 imagex_error(T("\"%"TS"\" contains %d images; Please select one."),
3817 wimfile, info.image_count);
3824 /* Read update commands from standard input, or the command string if
3827 cmd_file_contents = NULL;
3828 cmds = parse_update_command_file(&command_str, tstrlen(command_str),
3832 goto out_free_cmd_file_contents;
3834 } else if (!wimboot_config) {
3835 if (isatty(STDIN_FILENO)) {
3836 tputs(T("Reading update commands from standard input..."));
3837 recommend_man_page(CMD_UPDATE, stdout);
3839 cmd_file_contents = stdin_get_text_contents(&cmd_file_nchars);
3840 if (!cmd_file_contents) {
3842 goto out_wimlib_free;
3845 /* Parse the update commands */
3846 cmds = parse_update_command_file(&cmd_file_contents, cmd_file_nchars,
3850 goto out_free_cmd_file_contents;
3853 cmd_file_contents = NULL;
3858 /* Set default flags and capture config on the update commands */
3859 for (size_t i = 0; i < num_cmds; i++) {
3860 switch (cmds[i].op) {
3861 case WIMLIB_UPDATE_OP_ADD:
3862 cmds[i].add.add_flags |= default_add_flags;
3863 cmds[i].add.config_file = config_file;
3865 case WIMLIB_UPDATE_OP_DELETE:
3866 cmds[i].delete_.delete_flags |= default_delete_flags;
3873 /* Execute the update commands */
3874 ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags);
3878 if (wimboot_config) {
3879 /* --wimboot-config=FILE is short for an
3880 * "add FILE /Windows/System32/WimBootCompress.ini" command.
3882 struct wimlib_update_command cmd;
3884 cmd.op = WIMLIB_UPDATE_OP_ADD;
3885 cmd.add.fs_source_path = wimboot_config;
3886 cmd.add.wim_target_path = T("/Windows/System32/WimBootCompress.ini");
3887 cmd.add.config_file = NULL;
3888 cmd.add.add_flags = 0;
3890 ret = wimlib_update_image(wim, image, &cmd, 1, update_flags);
3895 /* Overwrite the updated WIM */
3896 ret = wimlib_overwrite(wim, write_flags, num_threads);
3899 out_free_cmd_file_contents:
3900 free(cmd_file_contents);
3903 out_free_command_str:
3908 usage(CMD_UPDATE, stderr);
3911 goto out_free_command_str;
3916 struct imagex_command {
3918 int (*func)(int argc, tchar **argv, int cmd);
3921 static const struct imagex_command imagex_commands[] = {
3922 [CMD_APPEND] = {T("append"), imagex_capture_or_append},
3923 [CMD_APPLY] = {T("apply"), imagex_apply},
3924 [CMD_CAPTURE] = {T("capture"), imagex_capture_or_append},
3925 [CMD_DELETE] = {T("delete"), imagex_delete},
3926 [CMD_DIR ] = {T("dir"), imagex_dir},
3927 [CMD_EXPORT] = {T("export"), imagex_export},
3928 [CMD_EXTRACT] = {T("extract"), imagex_extract},
3929 [CMD_INFO] = {T("info"), imagex_info},
3930 [CMD_JOIN] = {T("join"), imagex_join},
3931 #if WIM_MOUNTING_SUPPORTED
3932 [CMD_MOUNT] = {T("mount"), imagex_mount_rw_or_ro},
3933 [CMD_MOUNTRW] = {T("mountrw"), imagex_mount_rw_or_ro},
3935 [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
3936 [CMD_SPLIT] = {T("split"), imagex_split},
3937 #if WIM_MOUNTING_SUPPORTED
3938 [CMD_UNMOUNT] = {T("unmount"), imagex_unmount},
3940 [CMD_UPDATE] = {T("update"), imagex_update},
3943 static const tchar *usage_strings[] = {
3946 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3947 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3948 " [--nocheck] [--flags EDITION_ID] [--dereference]\n"
3949 " [--config=FILE] [--threads=NUM_THREADS] [--source-list]\n"
3950 " [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
3951 " [--update-of=[WIMFILE:]IMAGE] [--wimboot]\n"
3955 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
3956 " (DIRECTORY | NTFS_VOLUME) [--check] [--ref=\"GLOB\"]\n"
3957 " [--no-acls] [--strict-acls] [--no-attributes]\n"
3958 " [--rpfix] [--norpfix] [--include-invalid-names]\n"
3959 " [--wimboot] [--unix-data]\n"
3963 " %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
3964 " [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
3965 " [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
3966 " [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
3967 " [--source-list] [--no-acls] [--strict-acls] [--rpfix]\n"
3968 " [--norpfix] [--update-of=[WIMFILE:]IMAGE]\n"
3969 " [--delta-from=WIMFILE] [--wimboot] [--unix-data]\n"
3973 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n"
3974 " [--check] [--soft]\n"
3978 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--path=PATH] [--detailed]\n"
3982 " %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
3983 " DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
3984 " [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
3985 " [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
3989 " %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [(PATH | @LISTFILE)...]\n"
3990 " [--check] [--ref=\"GLOB\"] [--dest-dir=CMD_DIR]\n"
3991 " [--to-stdout] [--no-acls] [--strict-acls]\n"
3992 " [--no-attributes] [--include-invalid-names]\n"
3993 " [--no-wildcards] [--nullglob] [--preserve-dir-structure]\n"
3997 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
3998 " [NEW_DESC]]] [--boot] [--check] [--nocheck] [--xml]\n"
3999 " [--extract-xml FILE] [--header] [--lookup-table]\n"
4003 " %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
4005 #if WIM_MOUNTING_SUPPORTED
4008 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4009 " [--check] [--streams-interface=INTERFACE]\n"
4010 " [--ref=\"GLOB\"] [--allow-other] [--unix-data]\n"
4014 " %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
4015 " [--check] [--streams-interface=INTERFACE]\n"
4016 " [--staging-dir=CMD_DIR] [--allow-other] [--unix-data]\n"
4021 " %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
4022 " [--recompress-slow] [--compress=TYPE]\n"
4023 " [--threads=NUM_THREADS]\n"
4027 " %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
4029 #if WIM_MOUNTING_SUPPORTED
4032 " %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
4038 " %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
4039 " [--threads=NUM_THREADS] [DEFAULT_ADD_OPTIONS]\n"
4040 " [DEFAULT_DELETE_OPTIONS] [--command=STRING]\n"
4041 " [--wimboot-config=FILE| [< CMDFILE]\n"
4045 static const tchar *invocation_name;
4046 static int invocation_cmd = CMD_NONE;
4048 static const tchar *get_cmd_string(int cmd, bool nospace)
4050 static tchar buf[50];
4051 if (cmd == CMD_NONE) {
4052 tsprintf(buf, T("%"TS), T(IMAGEX_PROGNAME));
4053 } else if (invocation_cmd != CMD_NONE) {
4054 tsprintf(buf, T("wim%"TS), imagex_commands[cmd].name);
4056 const tchar *format;
4059 format = T("%"TS"-%"TS"");
4061 format = T("%"TS" %"TS"");
4062 tsprintf(buf, format, invocation_name, imagex_commands[cmd].name);
4070 static const tchar *s =
4072 IMAGEX_PROGNAME " (distributed with " PACKAGE " " PACKAGE_VERSION ")\n"
4073 "Copyright (C) 2012, 2013, 2014 Eric Biggers\n"
4074 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
4075 "This is free software: you are free to change and redistribute it.\n"
4076 "There is NO WARRANTY, to the extent permitted by law.\n"
4078 "Report bugs to "PACKAGE_BUGREPORT".\n"
4085 help_or_version(int argc, tchar **argv, int cmd)
4090 for (i = 1; i < argc; i++) {
4092 if (p[0] == T('-') && p[1] == T('-')) {
4094 if (!tstrcmp(p, T("help"))) {
4095 if (cmd == CMD_NONE)
4100 } else if (!tstrcmp(p, T("version"))) {
4109 print_usage_string(int cmd, FILE *fp)
4111 tfprintf(fp, usage_strings[cmd], get_cmd_string(cmd, false));
4115 recommend_man_page(int cmd, FILE *fp)
4117 const tchar *format_str;
4119 format_str = T("Uncommon options are not listed;\n"
4120 "See %"TS".pdf in the doc directory for more details.\n");
4122 format_str = T("Uncommon options are not listed;\n"
4123 "Try `man %"TS"' for more details.\n");
4125 tfprintf(fp, format_str, get_cmd_string(cmd, true));
4129 usage(int cmd, FILE *fp)
4131 tfprintf(fp, T("Usage:\n"));
4132 print_usage_string(cmd, fp);
4133 tfprintf(fp, T("\n"));
4134 recommend_man_page(cmd, fp);
4140 tfprintf(fp, T("Usage:\n"));
4141 for (int cmd = 0; cmd < CMD_MAX; cmd++) {
4142 print_usage_string(cmd, fp);
4143 tfprintf(fp, T("\n"));
4145 static const tchar *extra =
4148 " %"TS" --version\n"
4150 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
4153 tfprintf(fp, extra, invocation_name, invocation_name);
4154 recommend_man_page(CMD_NONE, fp);
4157 /* Entry point for wimlib's ImageX implementation. On UNIX the command
4158 * arguments will just be 'char' strings (ideally UTF-8 encoded, but could be
4159 * something else), while on Windows the command arguments will be UTF-16LE
4160 * encoded 'wchar_t' strings. */
4163 wmain(int argc, wchar_t **argv, wchar_t **envp)
4165 main(int argc, char **argv)
4172 imagex_info_file = stdout;
4173 invocation_name = tbasename(argv[0]);
4176 if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
4177 init_flags |= WIMLIB_INIT_FLAG_ASSUME_UTF8;
4181 setlocale(LC_ALL, "");
4182 codeset = nl_langinfo(CODESET);
4183 if (!strstr(codeset, "UTF-8") &&
4184 !strstr(codeset, "UTF8") &&
4185 !strstr(codeset, "utf-8") &&
4186 !strstr(codeset, "utf8"))
4189 "WARNING: Running %"TS" in a UTF-8 locale is recommended!\n"
4190 " Maybe try: `export LANG=en_US.UTF-8'?\n"
4191 " Alternatively, set the environmental variable WIMLIB_IMAGEX_USE_UTF8\n"
4192 " to any value to force wimlib to use UTF-8.\n",
4198 #endif /* !__WIN32__ */
4201 tchar *igcase = tgetenv(T("WIMLIB_IMAGEX_IGNORE_CASE"));
4202 if (igcase != NULL) {
4203 if (!tstrcmp(igcase, T("no")) ||
4204 !tstrcmp(igcase, T("0")))
4205 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE;
4206 else if (!tstrcmp(igcase, T("yes")) ||
4207 !tstrcmp(igcase, T("1")))
4208 init_flags |= WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE;
4211 "WARNING: Ignoring unknown setting of "
4212 "WIMLIB_IMAGEX_IGNORE_CASE\n");
4217 /* Allow being invoked as wimCOMMAND (e.g. wimapply). */
4219 if (!tstrncmp(invocation_name, T("wim"), 3) &&
4220 tstrcmp(invocation_name, T(IMAGEX_PROGNAME))) {
4221 for (int i = 0; i < CMD_MAX; i++) {
4222 if (!tstrcmp(invocation_name + 3,
4223 imagex_commands[i].name))
4232 /* Unless already known from the invocation name, determine which
4233 * command was specified. */
4234 if (cmd == CMD_NONE) {
4236 imagex_error(T("No command specified!\n"));
4240 for (int i = 0; i < CMD_MAX; i++) {
4241 if (!tstrcmp(argv[1], imagex_commands[i].name)) {
4246 if (cmd != CMD_NONE) {
4252 /* Handle --help and --version. --help can be either for the program as
4253 * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
4254 * CMD_NONE). Note: help_or_version() will not return if a --help or
4255 * --version argument was found. */
4256 help_or_version(argc, argv, cmd);
4258 /* Bail if a valid command was not specified. */
4259 if (cmd == CMD_NONE) {
4260 imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
4265 /* Enable warning and error messages in wimlib to be more user-friendly.
4267 wimlib_set_print_errors(true);
4269 /* Initialize wimlib. */
4270 ret = wimlib_global_init(init_flags);
4272 goto out_check_status;
4274 /* Call the command handler function. */
4275 ret = imagex_commands[cmd].func(argc, argv, cmd);
4277 /* Check for error writing to standard output, especially since for some
4278 * commands, writing to standard output is part of the program's actual
4279 * behavior and not just for informational purposes. */
4280 if (ferror(stdout) || fclose(stdout)) {
4281 imagex_error_with_errno(T("error writing to standard output"));
4286 /* Exit status (ret): -1 indicates an error found by 'wimlib-imagex'
4287 * itself (not by wimlib). 0 indicates success. > 0 indicates a wimlib
4288 * error code from which an error message can be printed. */
4290 imagex_error(T("Exiting with error code %d:\n"
4292 wimlib_get_error_string(ret));
4293 if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
4294 imagex_error_with_errno(T("errno"));
4296 /* Make wimlib free any resources it's holding (although this is not
4297 * strictly necessary because the process is ending anyway). */
4298 wimlib_global_cleanup();