4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012-2016 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"
49 #define WIMLIB_COMPRESSION_TYPE_INVALID (-1)
52 # include "imagex-win32.h"
53 # define print_security_descriptor win32_print_security_descriptor
56 # include <langinfo.h>
57 # define print_security_descriptor default_print_security_descriptor
58 static inline void set_fd_to_binary_mode(int fd)
63 /* Don't confuse the user by presenting the mounting commands on Windows when
64 * they will never work. However on UNIX-like systems we always present them,
65 * even if WITH_FUSE is not defined at this point, as to not tie the build of
66 * wimlib-imagex to a specific build of wimlib. */
68 # define WIM_MOUNTING_SUPPORTED 0
70 # define WIM_MOUNTING_SUPPORTED 1
73 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
76 is_any_path_separator(tchar c)
78 return c == T('/') || c == T('\\');
81 /* Like basename(), but handles both forward and backwards slashes. */
83 tbasename(tchar *path)
85 tchar *p = tstrchr(path, T('\0'));
90 if (!is_any_path_separator(*--p))
98 if (is_any_path_separator(*--p))
103 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
117 #if WIM_MOUNTING_SUPPORTED
123 #if WIM_MOUNTING_SUPPORTED
131 static void usage(int cmd, FILE *fp);
132 static void usage_all(FILE *fp);
133 static void recommend_man_page(int cmd, FILE *fp);
134 static const tchar *get_cmd_string(int cmd, bool nospace);
136 static bool imagex_be_quiet = false;
137 static FILE *imagex_info_file;
139 #define imagex_printf(format, ...) \
140 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
143 IMAGEX_ALLOW_OTHER_OPTION,
147 IMAGEX_CHUNK_SIZE_OPTION,
148 IMAGEX_COMMAND_OPTION,
149 IMAGEX_COMMIT_OPTION,
150 IMAGEX_COMPACT_OPTION,
151 IMAGEX_COMPRESS_OPTION,
152 IMAGEX_COMPRESS_SLOW_OPTION,
153 IMAGEX_CONFIG_OPTION,
155 IMAGEX_DELTA_FROM_OPTION,
156 IMAGEX_DEREFERENCE_OPTION,
157 IMAGEX_DEST_DIR_OPTION,
158 IMAGEX_DETAILED_OPTION,
159 IMAGEX_EXTRACT_XML_OPTION,
162 IMAGEX_HEADER_OPTION,
163 IMAGEX_IMAGE_PROPERTY_OPTION,
164 IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
166 IMAGEX_METADATA_OPTION,
167 IMAGEX_NEW_IMAGE_OPTION,
168 IMAGEX_NOCHECK_OPTION,
169 IMAGEX_NORPFIX_OPTION,
170 IMAGEX_NOT_PIPABLE_OPTION,
171 IMAGEX_NO_ACLS_OPTION,
172 IMAGEX_NO_ATTRIBUTES_OPTION,
173 IMAGEX_NO_GLOBS_OPTION,
174 IMAGEX_NO_REPLACE_OPTION,
175 IMAGEX_NO_SOLID_SORT_OPTION,
176 IMAGEX_NULLGLOB_OPTION,
177 IMAGEX_ONE_FILE_ONLY_OPTION,
179 IMAGEX_PIPABLE_OPTION,
180 IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION,
181 IMAGEX_REBUILD_OPTION,
182 IMAGEX_RECOMPRESS_OPTION,
183 IMAGEX_RECURSIVE_OPTION,
186 IMAGEX_SNAPSHOT_OPTION,
188 IMAGEX_SOLID_CHUNK_SIZE_OPTION,
189 IMAGEX_SOLID_COMPRESS_OPTION,
191 IMAGEX_SOURCE_LIST_OPTION,
192 IMAGEX_STAGING_DIR_OPTION,
193 IMAGEX_STREAMS_INTERFACE_OPTION,
194 IMAGEX_STRICT_ACLS_OPTION,
195 IMAGEX_THREADS_OPTION,
196 IMAGEX_TO_STDOUT_OPTION,
197 IMAGEX_UNIX_DATA_OPTION,
198 IMAGEX_UNSAFE_COMPACT_OPTION,
199 IMAGEX_UPDATE_OF_OPTION,
200 IMAGEX_VERBOSE_OPTION,
201 IMAGEX_WIMBOOT_CONFIG_OPTION,
202 IMAGEX_WIMBOOT_OPTION,
206 static const struct option apply_options[] = {
207 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
208 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
209 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
210 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
211 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
212 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
213 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
214 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
215 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
216 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
217 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
218 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
219 {T("compact"), required_argument, NULL, IMAGEX_COMPACT_OPTION},
223 static const struct option capture_or_append_options[] = {
224 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
225 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
226 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
227 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
228 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
229 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
230 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
231 {T("solid"), no_argument, NULL, IMAGEX_SOLID_OPTION},
232 {T("pack-streams"), no_argument, NULL, IMAGEX_SOLID_OPTION},
233 {T("solid-compress"),required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
234 {T("pack-compress"), required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
235 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
236 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
237 {T("no-solid-sort"), no_argument, NULL, IMAGEX_NO_SOLID_SORT_OPTION},
238 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
239 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
240 {T("flags"), required_argument, NULL, IMAGEX_FLAGS_OPTION},
241 {T("image-property"), required_argument, NULL, IMAGEX_IMAGE_PROPERTY_OPTION},
242 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
243 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
244 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
245 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
246 {T("source-list"), no_argument, NULL, IMAGEX_SOURCE_LIST_OPTION},
247 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
248 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
249 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
250 {T("rpfix"), no_argument, NULL, IMAGEX_RPFIX_OPTION},
251 {T("norpfix"), no_argument, NULL, IMAGEX_NORPFIX_OPTION},
252 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
253 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
254 {T("update-of"), required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
255 {T("delta-from"), required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
256 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
257 {T("unsafe-compact"), no_argument, NULL, IMAGEX_UNSAFE_COMPACT_OPTION},
258 {T("snapshot"), no_argument, NULL, IMAGEX_SNAPSHOT_OPTION},
262 static const struct option delete_options[] = {
263 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
264 {T("soft"), no_argument, NULL, IMAGEX_SOFT_OPTION},
265 {T("unsafe-compact"), no_argument, NULL, IMAGEX_UNSAFE_COMPACT_OPTION},
269 static const struct option dir_options[] = {
270 {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
271 {T("detailed"), no_argument, NULL, IMAGEX_DETAILED_OPTION},
272 {T("one-file-only"), no_argument, NULL, IMAGEX_ONE_FILE_ONLY_OPTION},
273 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
277 static const struct option export_options[] = {
278 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
279 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
280 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
281 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
282 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
283 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
284 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
285 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
286 {T("solid"), no_argument, NULL, IMAGEX_SOLID_OPTION},
287 {T("pack-streams"),no_argument, NULL, IMAGEX_SOLID_OPTION},
288 {T("solid-compress"),required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
289 {T("pack-compress"), required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
290 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
291 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
292 {T("no-solid-sort"), no_argument, NULL, IMAGEX_NO_SOLID_SORT_OPTION},
293 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
294 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
295 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
296 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
297 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
298 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
299 {T("unsafe-compact"), no_argument, NULL, IMAGEX_UNSAFE_COMPACT_OPTION},
303 static const struct option extract_options[] = {
304 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
305 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
306 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
307 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
308 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
309 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
310 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
311 {T("no-attributes"), no_argument, NULL, IMAGEX_NO_ATTRIBUTES_OPTION},
312 {T("dest-dir"), required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
313 {T("to-stdout"), no_argument, NULL, IMAGEX_TO_STDOUT_OPTION},
314 {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
315 {T("no-wildcards"), no_argument, NULL, IMAGEX_NO_GLOBS_OPTION},
316 {T("no-globs"), no_argument, NULL, IMAGEX_NO_GLOBS_OPTION},
317 {T("nullglob"), no_argument, NULL, IMAGEX_NULLGLOB_OPTION},
318 {T("preserve-dir-structure"), no_argument, NULL, IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION},
319 {T("wimboot"), no_argument, NULL, IMAGEX_WIMBOOT_OPTION},
320 {T("compact"), required_argument, NULL, IMAGEX_COMPACT_OPTION},
324 static const struct option info_options[] = {
325 {T("boot"), no_argument, NULL, IMAGEX_BOOT_OPTION},
326 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
327 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
328 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
329 {T("extract-xml"), required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
330 {T("header"), no_argument, NULL, IMAGEX_HEADER_OPTION},
331 {T("lookup-table"), no_argument, NULL, IMAGEX_BLOBS_OPTION},
332 {T("blobs"), no_argument, NULL, IMAGEX_BLOBS_OPTION},
333 {T("metadata"), no_argument, NULL, IMAGEX_METADATA_OPTION},
334 {T("xml"), no_argument, NULL, IMAGEX_XML_OPTION},
335 {T("image-property"), required_argument, NULL, IMAGEX_IMAGE_PROPERTY_OPTION},
339 static const struct option join_options[] = {
340 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
344 static const struct option mount_options[] = {
345 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
346 {T("debug"), no_argument, NULL, IMAGEX_DEBUG_OPTION},
347 {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
348 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
349 {T("staging-dir"), required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
350 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
351 {T("allow-other"), no_argument, NULL, IMAGEX_ALLOW_OTHER_OPTION},
355 static const struct option optimize_options[] = {
356 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
357 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
358 {T("no-check"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
359 {T("compress"), required_argument, NULL, IMAGEX_COMPRESS_OPTION},
360 {T("recompress"), no_argument, NULL, IMAGEX_RECOMPRESS_OPTION},
361 {T("compress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
362 {T("recompress-slow"), no_argument, NULL, IMAGEX_COMPRESS_SLOW_OPTION},
363 {T("chunk-size"), required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
364 {T("solid"), no_argument, NULL, IMAGEX_SOLID_OPTION},
365 {T("pack-streams"),no_argument, NULL, IMAGEX_SOLID_OPTION},
366 {T("solid-compress"),required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
367 {T("pack-compress"), required_argument, NULL, IMAGEX_SOLID_COMPRESS_OPTION},
368 {T("solid-chunk-size"),required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
369 {T("pack-chunk-size"), required_argument, NULL, IMAGEX_SOLID_CHUNK_SIZE_OPTION},
370 {T("no-solid-sort"), no_argument, NULL, IMAGEX_NO_SOLID_SORT_OPTION},
371 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
372 {T("pipable"), no_argument, NULL, IMAGEX_PIPABLE_OPTION},
373 {T("not-pipable"), no_argument, NULL, IMAGEX_NOT_PIPABLE_OPTION},
374 {T("unsafe-compact"), no_argument, NULL, IMAGEX_UNSAFE_COMPACT_OPTION},
378 static const struct option split_options[] = {
379 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
383 static const struct option unmount_options[] = {
384 {T("commit"), no_argument, NULL, IMAGEX_COMMIT_OPTION},
385 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
386 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
387 {T("lazy"), no_argument, NULL, IMAGEX_LAZY_OPTION},
388 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
389 {T("new-image"), no_argument, NULL, IMAGEX_NEW_IMAGE_OPTION},
393 static const struct option update_options[] = {
394 /* Careful: some of the options here set the defaults for update
395 * commands, but the flags given to an actual update command (and not to
396 * `imagex update' itself are also handled in
397 * update_command_add_option(). */
398 {T("threads"), required_argument, NULL, IMAGEX_THREADS_OPTION},
399 {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
400 {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
401 {T("command"), required_argument, NULL, IMAGEX_COMMAND_OPTION},
402 {T("wimboot-config"), required_argument, NULL, IMAGEX_WIMBOOT_CONFIG_OPTION},
404 /* Default delete options */
405 {T("force"), no_argument, NULL, IMAGEX_FORCE_OPTION},
406 {T("recursive"), no_argument, NULL, IMAGEX_RECURSIVE_OPTION},
408 /* Global add option */
409 {T("config"), required_argument, NULL, IMAGEX_CONFIG_OPTION},
411 /* Default add options */
412 {T("verbose"), no_argument, NULL, IMAGEX_VERBOSE_OPTION},
413 {T("dereference"), no_argument, NULL, IMAGEX_DEREFERENCE_OPTION},
414 {T("unix-data"), no_argument, NULL, IMAGEX_UNIX_DATA_OPTION},
415 {T("noacls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
416 {T("no-acls"), no_argument, NULL, IMAGEX_NO_ACLS_OPTION},
417 {T("strict-acls"), no_argument, NULL, IMAGEX_STRICT_ACLS_OPTION},
418 {T("no-replace"), no_argument, NULL, IMAGEX_NO_REPLACE_OPTION},
419 {T("unsafe-compact"), no_argument, NULL, IMAGEX_UNSAFE_COMPACT_OPTION},
424 static const struct option verify_options[] = {
425 {T("ref"), required_argument, NULL, IMAGEX_REF_OPTION},
426 {T("nocheck"), no_argument, NULL, IMAGEX_NOCHECK_OPTION},
432 # define _format_attribute(type, format_str, args_start) \
433 __attribute__((format(type, format_str, args_start)))
435 # define _format_attribute(type, format_str, args_start)
438 /* Print formatted error message to stderr. */
439 static void _format_attribute(printf, 1, 2)
440 imagex_error(const tchar *format, ...)
443 va_start(va, format);
444 tfputs(T("ERROR: "), stderr);
445 tvfprintf(stderr, format, va);
446 tputc(T('\n'), stderr);
450 /* Print formatted error message to stderr. */
451 static void _format_attribute(printf, 1, 2)
452 imagex_error_with_errno(const tchar *format, ...)
454 int errno_save = errno;
456 va_start(va, format);
457 tfputs(T("ERROR: "), stderr);
458 tvfprintf(stderr, format, va);
459 tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
464 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
466 if (image == WIMLIB_NO_IMAGE) {
467 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
468 " Please specify a 1-based image index or "
469 "image name. To list the images\n"
470 " contained in the WIM archive, run\n"
472 " %"TS" \"%"TS"\"\n"),
473 image_name, wim_name,
474 get_cmd_string(CMD_INFO, false), wim_name);
475 return WIMLIB_ERR_INVALID_IMAGE;
481 verify_image_is_single(int image)
483 if (image == WIMLIB_ALL_IMAGES) {
484 imagex_error(T("Cannot specify all images for this action!"));
485 return WIMLIB_ERR_INVALID_IMAGE;
491 verify_image_exists_and_is_single(int image, const tchar *image_name,
492 const tchar *wim_name)
495 ret = verify_image_exists(image, image_name, wim_name);
497 ret = verify_image_is_single(image);
502 print_available_compression_types(FILE *fp)
504 static const tchar *s =
506 "Available compression types:\n"
509 " xpress (alias: \"fast\")\n"
510 " lzx (alias: \"maximum\") (default for capture)\n"
511 " lzms (alias: \"recovery\")\n"
517 /* Parse the argument to --compress or --solid-compress */
519 get_compression_type(tchar *optarg, bool solid)
522 unsigned int compression_level = 0;
525 plevel = tstrchr(optarg, T(':'));
531 ultmp = tstrtoul(plevel, &ptmp, 10);
532 if (ultmp >= UINT_MAX || ultmp == 0 || *ptmp || ptmp == plevel) {
533 imagex_error(T("Compression level must be a positive integer! "
534 "e.g. --compress=lzx:80"));
535 return WIMLIB_COMPRESSION_TYPE_INVALID;
537 compression_level = ultmp;
540 if (!tstrcasecmp(optarg, T("maximum")) ||
541 !tstrcasecmp(optarg, T("lzx")) ||
542 !tstrcasecmp(optarg, T("max"))) {
543 ctype = WIMLIB_COMPRESSION_TYPE_LZX;
544 } else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress"))) {
545 ctype = WIMLIB_COMPRESSION_TYPE_XPRESS;
546 } else if (!tstrcasecmp(optarg, T("recovery"))) {
550 "Warning: use of '--compress=recovery' is discouraged because it behaves\n"
551 " differently from DISM. Instead, you typically want to use '--solid' to\n"
552 " create a solid LZMS-compressed WIM or \"ESD file\", similar to DISM's\n"
553 " /compress:recovery. But if you really want *non-solid* LZMS compression,\n"
554 " then you may suppress this warning by specifying '--compress=lzms' instead\n"
555 " of '--compress=recovery'.\n"));
557 ctype = WIMLIB_COMPRESSION_TYPE_LZMS;
558 } else if (!tstrcasecmp(optarg, T("lzms"))) {
559 ctype = WIMLIB_COMPRESSION_TYPE_LZMS;
560 } else if (!tstrcasecmp(optarg, T("none"))) {
561 ctype = WIMLIB_COMPRESSION_TYPE_NONE;
563 imagex_error(T("Invalid compression type \"%"TS"\"!"), optarg);
564 print_available_compression_types(stderr);
565 return WIMLIB_COMPRESSION_TYPE_INVALID;
568 if (compression_level != 0)
569 wimlib_set_default_compression_level(ctype, compression_level);
573 /* Parse the argument to --compact */
575 set_compact_mode(const tchar *arg, int *extract_flags)
578 if (!tstrcasecmp(arg, T("xpress4k")))
579 flag = WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K;
580 else if (!tstrcasecmp(arg, T("xpress8k")))
581 flag = WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K;
582 else if (!tstrcasecmp(arg, T("xpress16k")))
583 flag = WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K;
584 else if (!tstrcasecmp(arg, T("lzx")))
585 flag = WIMLIB_EXTRACT_FLAG_COMPACT_LZX;
588 *extract_flags |= flag;
593 "\"%"TS"\" is not a recognized System Compression format. The options are:"
595 " --compact=xpress4k\n"
596 " --compact=xpress8k\n"
597 " --compact=xpress16k\n"
605 set_compress_slow(void)
608 fprintf(stderr, "WARNING: the '--compress-slow' option is deprecated.\n"
609 " Use the '--compress=TYPE:LEVEL' option instead.\n");
611 wimlib_set_default_compression_level(-1, 100);
616 unsigned num_strings;
617 unsigned num_alloc_strings;
620 #define STRING_SET_INITIALIZER \
621 { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
623 #define STRING_SET(_strings) \
624 struct string_set _strings = STRING_SET_INITIALIZER
627 string_set_append(struct string_set *set, tchar *glob)
629 unsigned num_alloc_strings = set->num_alloc_strings;
631 if (set->num_strings == num_alloc_strings) {
634 num_alloc_strings += 4;
635 new_strings = realloc(set->strings,
636 sizeof(set->strings[0]) * num_alloc_strings);
638 imagex_error(T("Out of memory!"));
641 set->strings = new_strings;
642 set->num_alloc_strings = num_alloc_strings;
644 set->strings[set->num_strings++] = glob;
649 string_set_destroy(struct string_set *set)
655 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
657 return wimlib_reference_resource_files(wim, (const tchar **)set->strings,
659 WIMLIB_REF_FLAG_GLOB_ENABLE,
664 append_image_property_argument(struct string_set *image_properties)
666 if (!tstrchr(optarg, '=')) {
667 imagex_error(T("'--image-property' argument "
668 "must be in the form NAME=VALUE"));
671 return string_set_append(image_properties, optarg);
675 apply_image_properties(struct string_set *image_properties,
676 WIMStruct *wim, int image, bool *any_changes_ret)
678 bool any_changes = false;
679 for (unsigned i = 0; i < image_properties->num_strings; i++) {
681 const tchar *current_value;
684 name = image_properties->strings[i];
685 value = tstrchr(name, '=');
688 current_value = wimlib_get_image_property(wim, image, name);
689 if (current_value && !tstrcmp(current_value, value)) {
690 imagex_printf(T("The %"TS" property of image %d "
691 "already has value \"%"TS"\".\n"),
694 imagex_printf(T("Setting the %"TS" property of image "
695 "%d to \"%"TS"\".\n"),
697 ret = wimlib_set_image_property(wim, image, name, value);
704 *any_changes_ret = any_changes;
709 do_resource_not_found_warning(const tchar *wimfile,
710 const struct wimlib_wim_info *info,
711 const struct string_set *refglobs)
713 if (info->total_parts > 1) {
714 if (refglobs->num_strings == 0) {
715 imagex_error(T("\"%"TS"\" is part of a split WIM. "
716 "Use --ref to specify the other parts."),
719 imagex_error(T("Perhaps the '--ref' argument did not "
720 "specify all other parts of the split "
724 imagex_error(T("If this is a delta WIM, use the --ref argument "
725 "to specify the WIM(s) on which it is based."));
730 do_metadata_not_found_warning(const tchar *wimfile,
731 const struct wimlib_wim_info *info)
733 if (info->part_number != 1) {
734 imagex_error(T("\"%"TS"\" is not the first part of the split WIM.\n"
735 " You must specify the first part."),
740 /* Returns the size of a file given its name, or -1 if the file does not exist
741 * or its size cannot be determined. */
743 file_get_size(const tchar *filename)
746 if (tstat(filename, &st) == 0)
753 PARSE_STRING_SUCCESS = 0,
754 PARSE_STRING_FAILURE = 1,
755 PARSE_STRING_NONE = 2,
759 * Parses a string token from an array of characters.
761 * Tokens are either whitespace-delimited, or double or single-quoted.
763 * @line_p: Pointer to the pointer to the line of data. Will be updated
764 * to point past the string token iff the return value is
765 * PARSE_STRING_SUCCESS. If *len_p > 0, (*line_p)[*len_p - 1] must
768 * @len_p: @len_p initially stores the length of the line of data, which may
769 * be 0, and it will be updated to the number of bytes remaining in
770 * the line iff the return value is PARSE_STRING_SUCCESS.
772 * @fn_ret: Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
773 * parsed string token will be returned here.
775 * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
776 * PARSE_STRING_FAILURE if the data was invalid due to a missing
777 * closing quote; or PARSE_STRING_NONE if the line ended before the
778 * beginning of a string token was found.
781 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
784 tchar *line = *line_p;
788 /* Skip leading whitespace */
791 return PARSE_STRING_NONE;
792 if (!istspace(*line) && *line != T('\0'))
798 if (quote_char == T('"') || quote_char == T('\'')) {
803 line = tmemchr(line, quote_char, len);
805 imagex_error(T("Missing closing quote: %"TS), fn - 1);
806 return PARSE_STRING_FAILURE;
809 /* Unquoted string. Go until whitespace. Line is terminated
810 * by '\0', so no need to check 'len'. */
814 } while (!istspace(*line) && *line != T('\0'));
821 return PARSE_STRING_SUCCESS;
824 /* Parses a line of data (not an empty line or comment) in the source list file
825 * format. (See the man page for 'wimlib-imagex capture' for details on this
826 * format and the meaning.)
828 * @line: Line of data to be parsed. line[len - 1] must be '\0', unless
829 * len == 0. The data in @line will be modified by this function call.
831 * @len: Length of the line of data.
833 * @source: On success, the capture source and target described by the line is
834 * written into this destination. Note that it will contain pointers
835 * to data in the @line array.
837 * Returns true if the line was valid; false otherwise. */
839 parse_source_list_line(tchar *line, size_t len,
840 struct wimlib_capture_source *source)
844 ret = parse_string(&line, &len, &source->fs_source_path);
845 if (ret != PARSE_STRING_SUCCESS)
847 ret = parse_string(&line, &len, &source->wim_target_path);
848 if (ret == PARSE_STRING_NONE)
849 source->wim_target_path = source->fs_source_path;
850 return ret != PARSE_STRING_FAILURE;
853 /* Returns %true if the given line of length @len > 0 is a comment or empty line
854 * in the source list file format. */
856 is_comment_line(const tchar *line, size_t len)
859 if (*line == T('#') || *line == T(';'))
861 if (!istspace(*line) && *line != T('\0'))
871 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
874 tchar *contents = *contents_p;
875 size_t nchars = *nchars_p;
878 for (i = 0; i < nchars; i++)
879 if (contents[i] == T('\n'))
882 /* Handle last line not terminated by a newline */
883 if (nchars != 0 && contents[nchars - 1] != T('\n')) {
884 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
886 imagex_error(T("Out of memory!"));
889 contents[nchars] = T('\n');
890 *contents_p = contents;
898 /* Parses a file in the source list format. (See the man page for
899 * 'wimlib-imagex capture' for details on this format and the meaning.)
901 * @source_list_contents: Contents of the source list file. Note that this
902 * buffer will be modified to save memory allocations,
903 * and cannot be freed until the returned array of
904 * wimlib_capture_source's has also been freed.
906 * @source_list_nbytes: Number of bytes of data in the @source_list_contents
909 * @nsources_ret: On success, the length of the returned array is
912 * Returns: An array of `struct wimlib_capture_source's that can be passed to
913 * the wimlib_add_image_multisource() function to specify how a WIM image is to
915 static struct wimlib_capture_source *
916 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
917 size_t *nsources_ret)
921 struct wimlib_capture_source *sources;
924 nlines = text_file_count_lines(source_list_contents_p,
925 &source_list_nchars);
929 /* Always allocate at least 1 slot, just in case the implementation of
930 * calloc() returns NULL if 0 bytes are requested. */
931 sources = calloc(nlines ?: 1, sizeof(*sources));
933 imagex_error(T("out of memory"));
936 p = *source_list_contents_p;
938 for (i = 0; i < nlines; i++) {
939 /* XXX: Could use rawmemchr() here instead, but it may not be
940 * available on all platforms. */
941 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
942 size_t len = endp - p + 1;
944 if (!is_comment_line(p, len)) {
945 if (!parse_source_list_line(p, len, &sources[j++])) {
957 /* Reads the contents of a file into memory. */
959 file_get_contents(const tchar *filename, size_t *len_ret)
966 if (tstat(filename, &stbuf) != 0) {
967 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
972 fp = tfopen(filename, T("rb"));
974 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
978 buf = malloc(len ? len : 1);
980 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
981 "contents of file \"%"TS"\""), len, filename);
984 if (fread(buf, 1, len, fp) != len) {
985 imagex_error_with_errno(T("Failed to read %zu bytes from the "
986 "file \"%"TS"\""), len, filename);
1000 /* Read standard input until EOF and return the full contents in a malloc()ed
1001 * buffer and the number of bytes of data in @len_ret. Returns NULL on read
1004 stdin_get_contents(size_t *len_ret)
1006 /* stdin can, of course, be a pipe or other non-seekable file, so the
1007 * total length of the data cannot be pre-determined */
1009 size_t newlen = 1024;
1013 char *p = realloc(buf, newlen);
1014 size_t bytes_read, bytes_to_read;
1016 imagex_error(T("out of memory while reading stdin"));
1020 bytes_to_read = newlen - pos;
1021 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
1023 if (bytes_read != bytes_to_read) {
1028 imagex_error_with_errno(T("error reading stdin"));
1042 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
1045 /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
1047 *num_tchars_ret = num_bytes;
1049 #else /* !__WIN32__ */
1050 /* On Windows, translate the text to UTF-16LE */
1054 if (num_bytes >= 2 &&
1055 (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
1056 ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
1058 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
1059 * with something that looks like an ASCII character encoded as
1060 * a UTF-16LE code unit. Assume the file is encoded as
1061 * UTF-16LE. This is not a 100% reliable check. */
1062 num_wchars = num_bytes / 2;
1063 text_wstr = (wchar_t*)text;
1065 /* File does not look like UTF-16LE. Assume it is encoded in
1066 * the current Windows code page. I think these are always
1067 * ASCII-compatible, so any so-called "plain-text" (ASCII) files
1068 * should work as expected. */
1069 text_wstr = win32_mbs_to_wcs(text,
1074 *num_tchars_ret = num_wchars;
1076 #endif /* __WIN32__ */
1080 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1085 contents = file_get_contents(filename, &num_bytes);
1088 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1092 stdin_get_text_contents(size_t *num_tchars_ret)
1097 contents = stdin_get_contents(&num_bytes);
1100 return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1103 #define TO_PERCENT(numerator, denominator) \
1104 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1106 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1107 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1108 #define KIBIBYTE_MIN_NBYTES 10000ULL
1111 get_unit(uint64_t total_bytes, const tchar **name_ret)
1113 if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1114 *name_ret = T("GiB");
1116 } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1117 *name_ret = T("MiB");
1119 } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1120 *name_ret = T("KiB");
1123 *name_ret = T("bytes");
1128 static struct wimlib_progress_info_scan last_scan_progress;
1131 report_scan_progress(const struct wimlib_progress_info_scan *scan, bool done)
1133 uint64_t prev_count, cur_count;
1135 prev_count = last_scan_progress.num_nondirs_scanned +
1136 last_scan_progress.num_dirs_scanned;
1137 cur_count = scan->num_nondirs_scanned + scan->num_dirs_scanned;
1139 if (done || prev_count == 0 || cur_count >= prev_count + 100 ||
1140 cur_count % 128 == 0)
1142 unsigned unit_shift;
1143 const tchar *unit_name;
1145 unit_shift = get_unit(scan->num_bytes_scanned, &unit_name);
1146 imagex_printf(T("\r%"PRIu64" %"TS" scanned (%"PRIu64" files, "
1147 "%"PRIu64" directories) "),
1148 scan->num_bytes_scanned >> unit_shift,
1150 scan->num_nondirs_scanned,
1151 scan->num_dirs_scanned);
1152 last_scan_progress = *scan;
1155 /* Progress callback function passed to various wimlib functions. */
1156 static enum wimlib_progress_status
1157 imagex_progress_func(enum wimlib_progress_msg msg,
1158 union wimlib_progress_info *info,
1159 void *_ignored_context)
1161 unsigned percent_done;
1162 unsigned unit_shift;
1163 const tchar *unit_name;
1165 if (imagex_be_quiet)
1166 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1168 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1170 static bool started;
1172 if (info->write_streams.compression_type != WIMLIB_COMPRESSION_TYPE_NONE) {
1173 imagex_printf(T("Using %"TS" compression "
1174 "with %u thread%"TS"\n"),
1175 wimlib_get_compression_type_string(
1176 info->write_streams.compression_type),
1177 info->write_streams.num_threads,
1178 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1183 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1184 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1185 info->write_streams.total_bytes);
1187 imagex_printf(T("\rArchiving file data: %"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1188 info->write_streams.completed_bytes >> unit_shift,
1190 info->write_streams.total_bytes >> unit_shift,
1193 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1194 imagex_printf(T("\n"));
1196 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1197 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1198 if (WIMLIB_IS_WIM_ROOT_PATH(info->scan.wim_target_path)) {
1199 imagex_printf(T("\n"));
1201 imagex_printf(T(" (loading as WIM path: \"%"TS"\")...\n"),
1202 info->scan.wim_target_path);
1204 memset(&last_scan_progress, 0, sizeof(last_scan_progress));
1206 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1207 switch (info->scan.status) {
1208 case WIMLIB_SCAN_DENTRY_OK:
1209 report_scan_progress(&info->scan, false);
1211 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1212 imagex_printf(T("\nExcluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1214 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1215 imagex_printf(T("\nWARNING: Excluding unsupported file or directory\n"
1216 " \"%"TS"\" from capture\n"), info->scan.cur_path);
1218 case WIMLIB_SCAN_DENTRY_FIXED_SYMLINK:
1219 /* Symlink fixups are enabled by default. This is
1220 * mainly intended for Windows, which for some reason
1221 * uses absolute junctions (with drive letters!) in the
1222 * default installation. On UNIX-like systems, warn the
1223 * user when fixing the target of an absolute symbolic
1224 * link, so they know to disable this if they want. */
1226 imagex_printf(T("\nWARNING: Adjusted target of "
1227 "absolute symbolic link \"%"TS"\"\n"
1228 " (Use --norpfix to capture "
1229 "absolute symbolic links as-is)\n"),
1230 info->scan.cur_path);
1237 case WIMLIB_PROGRESS_MSG_SCAN_END:
1238 report_scan_progress(&info->scan, true);
1239 imagex_printf(T("\n"));
1241 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1242 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1243 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1244 info->integrity.total_bytes);
1245 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1246 "of %"PRIu64" %"TS" (%u%%) done"),
1247 info->integrity.filename,
1248 info->integrity.completed_bytes >> unit_shift,
1250 info->integrity.total_bytes >> unit_shift,
1253 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1254 imagex_printf(T("\n"));
1256 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1257 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1258 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1259 info->integrity.total_bytes);
1260 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1261 "of %"PRIu64" %"TS" (%u%%) done"),
1262 info->integrity.completed_bytes >> unit_shift,
1264 info->integrity.total_bytes >> unit_shift,
1267 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1268 imagex_printf(T("\n"));
1270 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1271 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1272 "to %"TS" \"%"TS"\"\n"),
1273 info->extract.image,
1274 info->extract.image_name,
1275 info->extract.wimfile_name,
1276 ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1277 T("NTFS volume") : T("directory")),
1278 info->extract.target);
1280 case WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE:
1281 if (info->extract.end_file_count >= 2000) {
1282 percent_done = TO_PERCENT(info->extract.current_file_count,
1283 info->extract.end_file_count);
1284 imagex_printf(T("\rCreating files: %"PRIu64" of %"PRIu64" (%u%%) done"),
1285 info->extract.current_file_count,
1286 info->extract.end_file_count, percent_done);
1287 if (info->extract.current_file_count == info->extract.end_file_count)
1288 imagex_printf(T("\n"));
1291 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1292 percent_done = TO_PERCENT(info->extract.completed_bytes,
1293 info->extract.total_bytes);
1294 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1295 imagex_printf(T("\rExtracting file data: "
1296 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1297 info->extract.completed_bytes >> unit_shift,
1299 info->extract.total_bytes >> unit_shift,
1302 if (info->extract.completed_bytes >= info->extract.total_bytes)
1303 imagex_printf(T("\n"));
1305 case WIMLIB_PROGRESS_MSG_EXTRACT_METADATA:
1306 if (info->extract.end_file_count >= 2000) {
1307 percent_done = TO_PERCENT(info->extract.current_file_count,
1308 info->extract.end_file_count);
1309 imagex_printf(T("\rApplying metadata to files: %"PRIu64" of %"PRIu64" (%u%%) done"),
1310 info->extract.current_file_count,
1311 info->extract.end_file_count, percent_done);
1312 if (info->extract.current_file_count == info->extract.end_file_count)
1313 imagex_printf(T("\n"));
1316 case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1317 if (info->extract.total_parts != 1) {
1318 imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1319 info->extract.part_number,
1320 info->extract.total_parts);
1323 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1324 percent_done = TO_PERCENT(info->split.completed_bytes,
1325 info->split.total_bytes);
1326 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1327 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1328 "%"PRIu64" %"TS" (%u%%) written\n"),
1329 info->split.part_name,
1330 info->split.cur_part_number,
1331 info->split.total_parts,
1332 info->split.completed_bytes >> unit_shift,
1334 info->split.total_bytes >> unit_shift,
1338 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1339 if (info->split.completed_bytes == info->split.total_bytes) {
1340 imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1341 info->split.cur_part_number,
1342 info->split.total_parts);
1345 case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1346 switch (info->update.command->op) {
1347 case WIMLIB_UPDATE_OP_DELETE:
1348 imagex_printf(T("Deleted WIM path \"%"TS"\"\n"),
1349 info->update.command->delete_.wim_path);
1351 case WIMLIB_UPDATE_OP_RENAME:
1352 imagex_printf(T("Renamed WIM path \"%"TS"\" => \"%"TS"\"\n"),
1353 info->update.command->rename.wim_source_path,
1354 info->update.command->rename.wim_target_path);
1356 case WIMLIB_UPDATE_OP_ADD:
1361 case WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM:
1362 imagex_printf(T("Updating \"%"TS"\" in WIM image\n"),
1363 info->replace.path_in_wim);
1365 case WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE:
1366 imagex_printf(T("\nExtracting \"%"TS"\" as normal file (not WIMBoot pointer)\n"),
1367 info->wimboot_exclude.path_in_wim);
1369 case WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN:
1370 if (info->unmount.mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1371 if (info->unmount.unmount_flags & WIMLIB_UNMOUNT_FLAG_COMMIT) {
1372 imagex_printf(T("Committing changes to %"TS" (image %d)\n"),
1373 info->unmount.mounted_wim,
1374 info->unmount.mounted_image);
1376 imagex_printf(T("Discarding changes to %"TS" (image %d)\n"),
1377 info->unmount.mounted_wim,
1378 info->unmount.mounted_image);
1379 imagex_printf(T("\t(Use --commit to keep changes.)\n"));
1383 case WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE:
1384 imagex_printf(T("Verifying metadata for image %"PRIu32" of %"PRIu32"\n"),
1385 info->verify_image.current_image,
1386 info->verify_image.total_images);
1388 case WIMLIB_PROGRESS_MSG_VERIFY_STREAMS:
1389 percent_done = TO_PERCENT(info->verify_streams.completed_bytes,
1390 info->verify_streams.total_bytes);
1391 unit_shift = get_unit(info->verify_streams.total_bytes, &unit_name);
1392 imagex_printf(T("\rVerifying file data: "
1393 "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1394 info->verify_streams.completed_bytes >> unit_shift,
1396 info->verify_streams.total_bytes >> unit_shift,
1399 if (info->verify_streams.completed_bytes == info->verify_streams.total_bytes)
1400 imagex_printf(T("\n"));
1405 fflush(imagex_info_file);
1406 return WIMLIB_PROGRESS_STATUS_CONTINUE;
1410 parse_num_threads(const tchar *optarg)
1413 unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1414 if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1415 imagex_error(T("Number of threads must be a non-negative integer!"));
1423 parse_chunk_size(const tchar *optarg)
1426 uint64_t chunk_size = tstrtoul(optarg, &tmp, 10);
1427 if (chunk_size == 0) {
1428 imagex_error(T("Invalid chunk size specification; must be a positive integer\n"
1429 " with optional K, M, or G suffix"));
1433 if (*tmp == T('k') || *tmp == T('K')) {
1436 } else if (*tmp == T('m') || *tmp == T('M')) {
1439 } else if (*tmp == T('g') || *tmp == T('G')) {
1443 if (*tmp && !(*tmp == T('i') && *(tmp + 1) == T('B'))) {
1444 imagex_error(T("Invalid chunk size specification; suffix must be K, M, or G"));
1448 if (chunk_size >= UINT32_MAX) {
1449 imagex_error(T("Invalid chunk size specification; the value is too large!"));
1457 * Parse an option passed to an update command.
1459 * @op: One of WIMLIB_UPDATE_OP_* that indicates the command being
1462 * @option: Text string for the option (beginning with --)
1464 * @cmd: `struct wimlib_update_command' that is being constructed for
1467 * Returns true if the option was recognized; false if not.
1470 update_command_add_option(int op, const tchar *option,
1471 struct wimlib_update_command *cmd)
1473 bool recognized = true;
1475 case WIMLIB_UPDATE_OP_ADD:
1476 if (!tstrcmp(option, T("--verbose")))
1477 cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1478 else if (!tstrcmp(option, T("--unix-data")))
1479 cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1480 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1481 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1482 else if (!tstrcmp(option, T("--strict-acls")))
1483 cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1484 else if (!tstrcmp(option, T("--dereference")))
1485 cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1486 else if (!tstrcmp(option, T("--no-replace")))
1487 cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_REPLACE;
1491 case WIMLIB_UPDATE_OP_DELETE:
1492 if (!tstrcmp(option, T("--force")))
1493 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1494 else if (!tstrcmp(option, T("--recursive")))
1495 cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1506 /* How many nonoption arguments each `imagex update' command expects */
1507 static const unsigned update_command_num_nonoptions[] = {
1508 [WIMLIB_UPDATE_OP_ADD] = 2,
1509 [WIMLIB_UPDATE_OP_DELETE] = 1,
1510 [WIMLIB_UPDATE_OP_RENAME] = 2,
1514 update_command_add_nonoption(int op, const tchar *nonoption,
1515 struct wimlib_update_command *cmd,
1516 unsigned num_nonoptions)
1519 case WIMLIB_UPDATE_OP_ADD:
1520 if (num_nonoptions == 0)
1521 cmd->add.fs_source_path = (tchar*)nonoption;
1523 cmd->add.wim_target_path = (tchar*)nonoption;
1525 case WIMLIB_UPDATE_OP_DELETE:
1526 cmd->delete_.wim_path = (tchar*)nonoption;
1528 case WIMLIB_UPDATE_OP_RENAME:
1529 if (num_nonoptions == 0)
1530 cmd->rename.wim_source_path = (tchar*)nonoption;
1532 cmd->rename.wim_target_path = (tchar*)nonoption;
1538 * Parse a command passed on stdin to `imagex update'.
1540 * @line: Text of the command.
1541 * @len: Length of the line, including a null terminator
1544 * @command: A `struct wimlib_update_command' to fill in from the parsed
1547 * @line_number: Line number of the command, for diagnostics.
1549 * Returns true on success; returns false on parse error.
1552 parse_update_command(tchar *line, size_t len,
1553 struct wimlib_update_command *command,
1557 tchar *command_name;
1559 size_t num_nonoptions;
1561 /* Get the command name ("add", "delete", "rename") */
1562 ret = parse_string(&line, &len, &command_name);
1563 if (ret != PARSE_STRING_SUCCESS)
1566 if (!tstrcasecmp(command_name, T("add"))) {
1567 op = WIMLIB_UPDATE_OP_ADD;
1568 } else if (!tstrcasecmp(command_name, T("delete"))) {
1569 op = WIMLIB_UPDATE_OP_DELETE;
1570 } else if (!tstrcasecmp(command_name, T("rename"))) {
1571 op = WIMLIB_UPDATE_OP_RENAME;
1573 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1574 command_name, line_number);
1579 /* Parse additional options and non-options as needed */
1584 ret = parse_string(&line, &len, &next_string);
1585 if (ret == PARSE_STRING_NONE) /* End of line */
1587 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1589 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1591 if (!update_command_add_option(op, next_string, command))
1593 imagex_error(T("Unrecognized option \"%"TS"\" to "
1594 "update command \"%"TS"\" on line %zu"),
1595 next_string, command_name, line_number);
1601 if (num_nonoptions == update_command_num_nonoptions[op])
1603 imagex_error(T("Unexpected argument \"%"TS"\" in "
1604 "update command on line %zu\n"
1605 " (The \"%"TS"\" command only "
1606 "takes %zu nonoption arguments!)\n"),
1607 next_string, line_number,
1608 command_name, num_nonoptions);
1611 update_command_add_nonoption(op, next_string,
1612 command, num_nonoptions);
1617 if (num_nonoptions != update_command_num_nonoptions[op]) {
1618 imagex_error(T("Not enough arguments to update command "
1619 "\"%"TS"\" on line %zu"), command_name, line_number);
1625 static struct wimlib_update_command *
1626 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1627 size_t *num_cmds_ret)
1631 struct wimlib_update_command *cmds;
1634 nlines = text_file_count_lines(cmd_file_contents_p,
1639 /* Always allocate at least 1 slot, just in case the implementation of
1640 * calloc() returns NULL if 0 bytes are requested. */
1641 cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1643 imagex_error(T("out of memory"));
1646 p = *cmd_file_contents_p;
1648 for (i = 0; i < nlines; i++) {
1649 /* XXX: Could use rawmemchr() here instead, but it may not be
1650 * available on all platforms. */
1651 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1652 size_t len = endp - p + 1;
1654 if (!is_comment_line(p, len)) {
1655 if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1666 /* Apply one image, or all images, from a WIM file to a directory, OR apply
1667 * one image from a WIM file to an NTFS volume. */
1669 imagex_apply(int argc, tchar **argv, int cmd)
1673 int image = WIMLIB_NO_IMAGE;
1675 struct wimlib_wim_info info;
1677 const tchar *wimfile;
1678 const tchar *target;
1679 const tchar *image_num_or_name = NULL;
1680 int extract_flags = 0;
1682 STRING_SET(refglobs);
1684 for_opt(c, apply_options) {
1686 case IMAGEX_CHECK_OPTION:
1687 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1689 case IMAGEX_VERBOSE_OPTION:
1690 /* No longer does anything. */
1692 case IMAGEX_REF_OPTION:
1693 ret = string_set_append(&refglobs, optarg);
1695 goto out_free_refglobs;
1697 case IMAGEX_UNIX_DATA_OPTION:
1698 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1700 case IMAGEX_NO_ACLS_OPTION:
1701 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1703 case IMAGEX_STRICT_ACLS_OPTION:
1704 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1706 case IMAGEX_NO_ATTRIBUTES_OPTION:
1707 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
1709 case IMAGEX_NORPFIX_OPTION:
1710 extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1712 case IMAGEX_RPFIX_OPTION:
1713 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1715 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1716 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1717 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1719 case IMAGEX_WIMBOOT_OPTION:
1720 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
1722 case IMAGEX_COMPACT_OPTION:
1723 ret = set_compact_mode(optarg, &extract_flags);
1725 goto out_free_refglobs;
1733 if (argc != 2 && argc != 3)
1738 if (!tstrcmp(wimfile, T("-"))) {
1739 /* Attempt to apply pipable WIM from standard input. */
1741 image_num_or_name = NULL;
1744 image_num_or_name = argv[1];
1749 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
1750 imagex_progress_func, NULL);
1752 goto out_free_refglobs;
1754 wimlib_get_wim_info(wim, &info);
1757 /* Image explicitly specified. */
1758 image_num_or_name = argv[1];
1759 image = wimlib_resolve_image(wim, image_num_or_name);
1760 ret = verify_image_exists(image, image_num_or_name, wimfile);
1762 goto out_wimlib_free;
1765 /* No image specified; default to image 1, but only if the WIM
1766 * contains exactly one image. */
1768 if (info.image_count != 1) {
1769 imagex_error(T("\"%"TS"\" contains %d images; "
1770 "Please select one (or all)."),
1771 wimfile, info.image_count);
1780 if (refglobs.num_strings) {
1782 imagex_error(T("Can't specify --ref when applying from stdin!"));
1784 goto out_wimlib_free;
1786 ret = wim_reference_globs(wim, &refglobs, open_flags);
1788 goto out_wimlib_free;
1793 /* Interpret a regular file or block device target as an NTFS
1797 if (tstat(target, &stbuf)) {
1798 if (errno != ENOENT) {
1799 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1802 goto out_wimlib_free;
1805 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1806 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1812 ret = wimlib_extract_image(wim, image, target, extract_flags);
1814 set_fd_to_binary_mode(STDIN_FILENO);
1815 ret = wimlib_extract_image_from_pipe_with_progress(
1820 imagex_progress_func,
1824 imagex_printf(T("Done applying WIM image.\n"));
1825 } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1827 do_resource_not_found_warning(wimfile, &info, &refglobs);
1829 imagex_error(T( "If you are applying an image "
1830 "from a split pipable WIM,\n"
1831 " make sure you have "
1832 "concatenated together all parts."));
1834 } else if (ret == WIMLIB_ERR_METADATA_NOT_FOUND && wim) {
1835 do_metadata_not_found_warning(wimfile, &info);
1840 string_set_destroy(&refglobs);
1844 usage(CMD_APPLY, stderr);
1846 goto out_free_refglobs;
1849 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1850 * directory trees. 'wimlib-imagex capture': create a new WIM file containing
1851 * the desired image. 'wimlib-imagex append': add a new image to an existing
1854 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1858 int add_flags = WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
1859 WIMLIB_ADD_FLAG_WINCONFIG |
1860 WIMLIB_ADD_FLAG_VERBOSE;
1861 int write_flags = 0;
1862 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1863 uint32_t chunk_size = UINT32_MAX;
1864 uint32_t solid_chunk_size = UINT32_MAX;
1865 int solid_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
1866 const tchar *wimfile;
1869 STRING_SET(image_properties);
1872 STRING_SET(base_wimfiles);
1873 WIMStruct **base_wims;
1875 WIMStruct *template_wim;
1876 const tchar *template_wimfile = NULL;
1877 const tchar *template_image_name_or_num = NULL;
1878 int template_image = WIMLIB_NO_IMAGE;
1881 unsigned num_threads = 0;
1886 tchar *config_file = NULL;
1888 bool source_list = false;
1889 size_t source_list_nchars = 0;
1890 tchar *source_list_contents;
1891 bool capture_sources_malloced;
1892 struct wimlib_capture_source *capture_sources;
1894 bool name_defaulted;
1896 for_opt(c, capture_or_append_options) {
1898 case IMAGEX_BOOT_OPTION:
1899 add_flags |= WIMLIB_ADD_FLAG_BOOT;
1901 case IMAGEX_CHECK_OPTION:
1902 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1903 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1905 case IMAGEX_NOCHECK_OPTION:
1906 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1908 case IMAGEX_CONFIG_OPTION:
1909 config_file = optarg;
1910 add_flags &= ~WIMLIB_ADD_FLAG_WINCONFIG;
1912 case IMAGEX_COMPRESS_OPTION:
1913 compression_type = get_compression_type(optarg, false);
1914 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1917 case IMAGEX_COMPRESS_SLOW_OPTION:
1918 set_compress_slow();
1920 case IMAGEX_CHUNK_SIZE_OPTION:
1921 chunk_size = parse_chunk_size(optarg);
1922 if (chunk_size == UINT32_MAX)
1925 case IMAGEX_SOLID_CHUNK_SIZE_OPTION:
1926 solid_chunk_size = parse_chunk_size(optarg);
1927 if (solid_chunk_size == UINT32_MAX)
1930 case IMAGEX_SOLID_COMPRESS_OPTION:
1931 solid_ctype = get_compression_type(optarg, true);
1932 if (solid_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
1935 case IMAGEX_SOLID_OPTION:
1936 write_flags |= WIMLIB_WRITE_FLAG_SOLID;
1938 case IMAGEX_NO_SOLID_SORT_OPTION:
1939 write_flags |= WIMLIB_WRITE_FLAG_NO_SOLID_SORT;
1941 case IMAGEX_FLAGS_OPTION: {
1942 tchar *p = alloca((6 + tstrlen(optarg) + 1) * sizeof(tchar));
1943 tsprintf(p, T("FLAGS=%"TS), optarg);
1944 ret = string_set_append(&image_properties, p);
1949 case IMAGEX_IMAGE_PROPERTY_OPTION:
1950 ret = append_image_property_argument(&image_properties);
1954 case IMAGEX_DEREFERENCE_OPTION:
1955 add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1957 case IMAGEX_VERBOSE_OPTION:
1958 /* No longer does anything. */
1960 case IMAGEX_THREADS_OPTION:
1961 num_threads = parse_num_threads(optarg);
1962 if (num_threads == UINT_MAX)
1965 case IMAGEX_REBUILD_OPTION:
1966 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1968 case IMAGEX_UNIX_DATA_OPTION:
1969 add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1971 case IMAGEX_SOURCE_LIST_OPTION:
1974 case IMAGEX_NO_ACLS_OPTION:
1975 add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1977 case IMAGEX_STRICT_ACLS_OPTION:
1978 add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1980 case IMAGEX_RPFIX_OPTION:
1981 add_flags |= WIMLIB_ADD_FLAG_RPFIX;
1983 case IMAGEX_NORPFIX_OPTION:
1984 add_flags |= WIMLIB_ADD_FLAG_NORPFIX;
1986 case IMAGEX_PIPABLE_OPTION:
1987 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1989 case IMAGEX_NOT_PIPABLE_OPTION:
1990 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1992 case IMAGEX_UPDATE_OF_OPTION:
1993 if (template_image_name_or_num) {
1994 imagex_error(T("'--update-of' can only be "
1995 "specified one time!"));
1999 colon = tstrrchr(optarg, T(':'));
2002 template_wimfile = optarg;
2004 template_image_name_or_num = colon + 1;
2006 template_wimfile = NULL;
2007 template_image_name_or_num = optarg;
2011 case IMAGEX_DELTA_FROM_OPTION:
2012 if (cmd != CMD_CAPTURE) {
2013 imagex_error(T("'--delta-from' is only "
2014 "valid for capture!"));
2017 ret = string_set_append(&base_wimfiles, optarg);
2020 write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
2022 case IMAGEX_WIMBOOT_OPTION:
2023 add_flags |= WIMLIB_ADD_FLAG_WIMBOOT;
2025 case IMAGEX_UNSAFE_COMPACT_OPTION:
2026 if (cmd != CMD_APPEND) {
2027 imagex_error(T("'--unsafe-compact' is only "
2028 "valid for append!"));
2031 write_flags |= WIMLIB_WRITE_FLAG_UNSAFE_COMPACT;
2033 case IMAGEX_SNAPSHOT_OPTION:
2034 add_flags |= WIMLIB_ADD_FLAG_SNAPSHOT;
2043 if (argc < 2 || argc > 4)
2049 /* Set default compression type and parameters. */
2052 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2053 /* No compression type specified. Use the default. */
2055 if (add_flags & WIMLIB_ADD_FLAG_WIMBOOT) {
2056 /* With --wimboot, default to XPRESS compression. */
2057 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
2058 } else if (write_flags & WIMLIB_WRITE_FLAG_SOLID) {
2059 /* With --solid, default to LZMS compression. (However,
2060 * this will not affect solid resources!) */
2061 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
2063 /* Otherwise, default to LZX compression. */
2064 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
2068 if (!tstrcmp(wimfile, T("-"))) {
2069 /* Writing captured WIM to standard output. */
2071 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2072 imagex_error("Can't write a non-pipable WIM to "
2073 "standard output! Specify --pipable\n"
2074 " if you want to create a pipable WIM "
2075 "(but read the docs first).");
2079 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2081 if (cmd == CMD_APPEND) {
2082 imagex_error(T("Using standard output for append does "
2083 "not make sense."));
2086 wim_fd = STDOUT_FILENO;
2088 imagex_info_file = stderr;
2089 set_fd_to_binary_mode(wim_fd);
2092 /* If template image was specified using --update-of=IMAGE rather
2093 * than --update-of=WIMFILE:IMAGE, set the default WIMFILE. */
2094 if (template_image_name_or_num && !template_wimfile) {
2095 if (base_wimfiles.num_strings == 1) {
2096 /* Capturing delta WIM based on single WIM: default to
2098 template_wimfile = base_wimfiles.strings[0];
2099 } else if (cmd == CMD_APPEND) {
2100 /* Appending to WIM: default to WIM being appended to.
2102 template_wimfile = wimfile;
2104 /* Capturing a normal (non-delta) WIM, so the WIM file
2105 * *must* be explicitly specified. */
2106 if (base_wimfiles.num_strings > 1) {
2107 imagex_error(T("For capture of delta WIM "
2108 "based on multiple existing "
2110 " '--update-of' must "
2111 "specify WIMFILE:IMAGE!"));
2113 imagex_error(T("For capture of non-delta WIM, "
2114 "'--update-of' must specify "
2123 name_defaulted = false;
2125 /* Set default name to SOURCE argument, omitting any directory
2126 * prefixes and trailing slashes. This requires making a copy
2127 * of @source. Leave some free characters at the end in case we
2128 * append a number to keep the name unique. */
2129 size_t source_name_len;
2131 source_name_len = tstrlen(source);
2132 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
2133 name = tbasename(tstrcpy(source_copy, source));
2134 name_defaulted = true;
2137 /* Image description (if given). */
2139 tchar *p = alloca((12 + tstrlen(argv[3]) + 1) * sizeof(tchar));
2140 tsprintf(p, T("DESCRIPTION=%"TS), argv[3]);
2141 ret = string_set_append(&image_properties, p);
2147 /* Set up capture sources in source list mode */
2148 if (source[0] == T('-') && source[1] == T('\0')) {
2149 source_list_contents = stdin_get_text_contents(&source_list_nchars);
2151 source_list_contents = file_get_text_contents(source,
2152 &source_list_nchars);
2154 if (!source_list_contents)
2157 capture_sources = parse_source_list(&source_list_contents,
2160 if (!capture_sources) {
2162 goto out_free_source_list_contents;
2164 capture_sources_malloced = true;
2166 /* Set up capture source in non-source-list mode. */
2167 capture_sources = alloca(sizeof(struct wimlib_capture_source));
2168 capture_sources[0].fs_source_path = source;
2169 capture_sources[0].wim_target_path = WIMLIB_WIM_ROOT_PATH;
2170 capture_sources[0].reserved = 0;
2172 capture_sources_malloced = false;
2173 source_list_contents = NULL;
2176 /* Open the existing WIM, or create a new one. */
2177 if (cmd == CMD_APPEND) {
2178 ret = wimlib_open_wim_with_progress(wimfile,
2179 open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2181 imagex_progress_func,
2184 goto out_free_capture_sources;
2186 ret = wimlib_create_new_wim(compression_type, &wim);
2188 goto out_free_capture_sources;
2189 wimlib_register_progress_function(wim, imagex_progress_func, NULL);
2192 /* Set chunk size if non-default. */
2193 if (chunk_size != UINT32_MAX) {
2194 ret = wimlib_set_output_chunk_size(wim, chunk_size);
2197 } else if ((add_flags & WIMLIB_ADD_FLAG_WIMBOOT)) {
2199 int ctype = compression_type;
2201 if (cmd == CMD_APPEND) {
2202 struct wimlib_wim_info info;
2203 wimlib_get_wim_info(wim, &info);
2204 ctype = info.compression_type;
2207 if (ctype == WIMLIB_COMPRESSION_TYPE_XPRESS) {
2208 ret = wimlib_set_output_chunk_size(wim, 4096);
2213 if (solid_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
2214 ret = wimlib_set_output_pack_compression_type(wim, solid_ctype);
2218 if (solid_chunk_size != UINT32_MAX) {
2219 ret = wimlib_set_output_pack_chunk_size(wim, solid_chunk_size);
2225 /* Detect if source is regular file or block device and set NTFS volume
2230 if (tstat(source, &stbuf) == 0) {
2231 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
2232 imagex_printf(T("Capturing WIM image from NTFS "
2233 "filesystem on \"%"TS"\"\n"), source);
2234 add_flags |= WIMLIB_ADD_FLAG_NTFS;
2237 if (errno != ENOENT) {
2238 imagex_error_with_errno(T("Failed to stat "
2239 "\"%"TS"\""), source);
2247 /* If the user did not specify an image name, and the basename of the
2248 * source already exists as an image name in the WIM file, append a
2249 * suffix to make it unique. */
2250 if (cmd == CMD_APPEND && name_defaulted) {
2251 unsigned long conflict_idx;
2252 tchar *name_end = tstrchr(name, T('\0'));
2253 for (conflict_idx = 1;
2254 wimlib_image_name_in_use(wim, name);
2257 tsprintf(name_end, T(" (%lu)"), conflict_idx);
2261 /* If capturing a delta WIM, reference resources from the base WIMs
2262 * before adding the new image. */
2263 if (base_wimfiles.num_strings) {
2264 base_wims = calloc(base_wimfiles.num_strings,
2265 sizeof(base_wims[0]));
2266 if (base_wims == NULL) {
2267 imagex_error(T("Out of memory!"));
2272 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2273 ret = wimlib_open_wim_with_progress(
2274 base_wimfiles.strings[i], open_flags,
2275 &base_wims[i], imagex_progress_func, NULL);
2277 goto out_free_base_wims;
2281 ret = wimlib_reference_resources(wim, base_wims,
2282 base_wimfiles.num_strings, 0);
2284 goto out_free_base_wims;
2286 if (base_wimfiles.num_strings == 1) {
2287 imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2288 base_wimfiles.strings[0]);
2290 imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2291 base_wimfiles.num_strings);
2298 /* If capturing or appending as an update of an existing (template) image,
2299 * open the WIM if needed and parse the image index. */
2300 if (template_image_name_or_num) {
2303 if (base_wimfiles.num_strings == 1 &&
2304 template_wimfile == base_wimfiles.strings[0]) {
2305 template_wim = base_wims[0];
2306 } else if (template_wimfile == wimfile) {
2309 ret = wimlib_open_wim_with_progress(template_wimfile,
2312 imagex_progress_func,
2315 goto out_free_base_wims;
2318 template_image = wimlib_resolve_image(template_wim,
2319 template_image_name_or_num);
2321 if (template_image_name_or_num[0] == T('-')) {
2324 struct wimlib_wim_info info;
2326 wimlib_get_wim_info(template_wim, &info);
2327 n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2328 if (n >= 1 && n <= info.image_count &&
2330 tmp != template_image_name_or_num + 1)
2332 template_image = info.image_count - (n - 1);
2335 ret = verify_image_exists_and_is_single(template_image,
2336 template_image_name_or_num,
2339 goto out_free_template_wim;
2341 template_wim = NULL;
2344 ret = wimlib_add_image_multisource(wim,
2351 goto out_free_template_wim;
2353 if (image_properties.num_strings || template_image_name_or_num) {
2354 /* User asked to set additional image properties, or an image on
2355 * which the added one is to be based has been specified with
2357 struct wimlib_wim_info info;
2359 wimlib_get_wim_info(wim, &info);
2361 ret = apply_image_properties(&image_properties, wim,
2362 info.image_count, NULL);
2364 goto out_free_template_wim;
2366 /* Reference template image if the user provided one. */
2367 if (template_image_name_or_num) {
2368 imagex_printf(T("Using image %d "
2369 "from \"%"TS"\" as template\n"),
2370 template_image, template_wimfile);
2371 ret = wimlib_reference_template_image(wim,
2377 goto out_free_template_wim;
2381 /* Write the new WIM or overwrite the existing WIM with the new image
2383 if (cmd == CMD_APPEND) {
2384 ret = wimlib_overwrite(wim, write_flags, num_threads);
2385 } else if (wimfile) {
2386 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2387 write_flags, num_threads);
2389 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2390 write_flags, num_threads);
2392 out_free_template_wim:
2393 /* template_wim may alias base_wims[0] or wim. */
2394 if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2395 template_wim != wim)
2396 wimlib_free(template_wim);
2398 for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2399 wimlib_free(base_wims[i]);
2403 out_free_capture_sources:
2404 if (capture_sources_malloced)
2405 free(capture_sources);
2406 out_free_source_list_contents:
2407 free(source_list_contents);
2409 string_set_destroy(&image_properties);
2410 string_set_destroy(&base_wimfiles);
2420 /* Remove image(s) from a WIM. */
2422 imagex_delete(int argc, tchar **argv, int cmd)
2425 int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2426 int write_flags = 0;
2427 const tchar *wimfile;
2428 const tchar *image_num_or_name;
2433 for_opt(c, delete_options) {
2435 case IMAGEX_CHECK_OPTION:
2436 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2437 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2439 case IMAGEX_SOFT_OPTION:
2440 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2442 case IMAGEX_UNSAFE_COMPACT_OPTION:
2443 write_flags |= WIMLIB_WRITE_FLAG_UNSAFE_COMPACT;
2454 imagex_error(T("Must specify a WIM file"));
2456 imagex_error(T("Must specify an image"));
2460 image_num_or_name = argv[1];
2462 ret = wimlib_open_wim_with_progress(wimfile, open_flags, &wim,
2463 imagex_progress_func, NULL);
2467 image = wimlib_resolve_image(wim, image_num_or_name);
2469 ret = verify_image_exists(image, image_num_or_name, wimfile);
2471 goto out_wimlib_free;
2473 ret = wimlib_delete_image(wim, image);
2475 imagex_error(T("Failed to delete image from \"%"TS"\""),
2477 goto out_wimlib_free;
2480 ret = wimlib_overwrite(wim, write_flags, 0);
2482 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2483 "deleted"), wimfile);
2491 usage(CMD_DELETE, stderr);
2496 struct print_dentry_options {
2501 print_dentry_full_path(const struct wimlib_dir_entry *dentry)
2503 tprintf(T("%"TS"\n"), dentry->full_path);
2506 static const struct {
2509 } file_attr_flags[] = {
2510 {WIMLIB_FILE_ATTRIBUTE_READONLY, T("READONLY")},
2511 {WIMLIB_FILE_ATTRIBUTE_HIDDEN, T("HIDDEN")},
2512 {WIMLIB_FILE_ATTRIBUTE_SYSTEM, T("SYSTEM")},
2513 {WIMLIB_FILE_ATTRIBUTE_DIRECTORY, T("DIRECTORY")},
2514 {WIMLIB_FILE_ATTRIBUTE_ARCHIVE, T("ARCHIVE")},
2515 {WIMLIB_FILE_ATTRIBUTE_DEVICE, T("DEVICE")},
2516 {WIMLIB_FILE_ATTRIBUTE_NORMAL, T("NORMAL")},
2517 {WIMLIB_FILE_ATTRIBUTE_TEMPORARY, T("TEMPORARY")},
2518 {WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE, T("SPARSE_FILE")},
2519 {WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT, T("REPARSE_POINT")},
2520 {WIMLIB_FILE_ATTRIBUTE_COMPRESSED, T("COMPRESSED")},
2521 {WIMLIB_FILE_ATTRIBUTE_OFFLINE, T("OFFLINE")},
2522 {WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED, T("NOT_CONTENT_INDEXED")},
2523 {WIMLIB_FILE_ATTRIBUTE_ENCRYPTED, T("ENCRYPTED")},
2524 {WIMLIB_FILE_ATTRIBUTE_VIRTUAL, T("VIRTUAL")},
2527 #define TIMESTR_MAX 100
2530 timespec_to_string(const struct timespec *spec, tchar *buf)
2532 time_t t = spec->tv_sec;
2535 tstrftime(buf, TIMESTR_MAX, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
2536 buf[TIMESTR_MAX - 1] = '\0';
2540 print_time(const tchar *type, const struct timespec *spec)
2542 tchar timestr[TIMESTR_MAX];
2544 timespec_to_string(spec, timestr);
2546 tprintf(T("%-20"TS"= %"TS"\n"), type, timestr);
2549 static void print_byte_field(const uint8_t field[], size_t len)
2552 tprintf(T("%02hhx"), *field++);
2556 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2558 tchar attr_string[256];
2561 tputs(T("WIM Information:"));
2562 tputs(T("----------------"));
2563 tprintf(T("Path: %"TS"\n"), wimfile);
2564 tprintf(T("GUID: 0x"));
2565 print_byte_field(info->guid, sizeof(info->guid));
2567 tprintf(T("Version: %u\n"), info->wim_version);
2568 tprintf(T("Image Count: %d\n"), info->image_count);
2569 tprintf(T("Compression: %"TS"\n"),
2570 wimlib_get_compression_type_string(info->compression_type));
2571 tprintf(T("Chunk Size: %"PRIu32" bytes\n"),
2573 tprintf(T("Part Number: %d/%d\n"), info->part_number, info->total_parts);
2574 tprintf(T("Boot Index: %d\n"), info->boot_index);
2575 tprintf(T("Size: %"PRIu64" bytes\n"), info->total_bytes);
2577 attr_string[0] = T('\0');
2580 tstrcat(attr_string, T("Pipable, "));
2582 if (info->has_integrity_table)
2583 tstrcat(attr_string, T("Integrity info, "));
2585 if (info->has_rpfix)
2586 tstrcat(attr_string, T("Relative path junction, "));
2588 if (info->resource_only)
2589 tstrcat(attr_string, T("Resource only, "));
2591 if (info->metadata_only)
2592 tstrcat(attr_string, T("Metadata only, "));
2594 if (info->is_marked_readonly)
2595 tstrcat(attr_string, T("Readonly, "));
2597 p = tstrchr(attr_string, T('\0'));
2598 if (p >= &attr_string[2] && p[-1] == T(' ') && p[-2] == T(','))
2601 tprintf(T("Attributes: %"TS"\n\n"), attr_string);
2605 print_resource(const struct wimlib_resource_entry *resource,
2608 tprintf(T("Hash = 0x"));
2609 print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2612 if (!resource->is_missing) {
2613 tprintf(T("Uncompressed size = %"PRIu64" bytes\n"),
2614 resource->uncompressed_size);
2615 if (resource->packed) {
2616 tprintf(T("Solid resource = %"PRIu64" => %"PRIu64" "
2617 "bytes @ offset %"PRIu64"\n"),
2618 resource->raw_resource_uncompressed_size,
2619 resource->raw_resource_compressed_size,
2620 resource->raw_resource_offset_in_wim);
2622 tprintf(T("Solid offset = %"PRIu64" bytes\n"),
2625 tprintf(T("Compressed size = %"PRIu64" bytes\n"),
2626 resource->compressed_size);
2628 tprintf(T("Offset in WIM = %"PRIu64" bytes\n"),
2632 tprintf(T("Part Number = %u\n"), resource->part_number);
2633 tprintf(T("Reference Count = %u\n"), resource->reference_count);
2635 tprintf(T("Flags = "));
2636 if (resource->is_compressed)
2637 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED "));
2638 if (resource->is_metadata)
2639 tprintf(T("WIM_RESHDR_FLAG_METADATA "));
2640 if (resource->is_free)
2641 tprintf(T("WIM_RESHDR_FLAG_FREE "));
2642 if (resource->is_spanned)
2643 tprintf(T("WIM_RESHDR_FLAG_SPANNED "));
2644 if (resource->packed)
2645 tprintf(T("WIM_RESHDR_FLAG_SOLID "));
2653 print_blobs(WIMStruct *wim)
2655 wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2659 default_print_security_descriptor(const uint8_t *sd, size_t size)
2661 tprintf(T("Security Descriptor = "));
2662 print_byte_field(sd, size);
2667 print_dentry_detailed(const struct wimlib_dir_entry *dentry)
2671 "----------------------------------------------------------------------------\n"));
2672 tprintf(T("Full Path = \"%"TS"\"\n"), dentry->full_path);
2673 if (dentry->dos_name)
2674 tprintf(T("Short Name = \"%"TS"\"\n"), dentry->dos_name);
2675 tprintf(T("Attributes = 0x%08x\n"), dentry->attributes);
2676 for (size_t i = 0; i < ARRAY_LEN(file_attr_flags); i++)
2677 if (file_attr_flags[i].flag & dentry->attributes)
2678 tprintf(T(" FILE_ATTRIBUTE_%"TS" is set\n"),
2679 file_attr_flags[i].name);
2681 if (dentry->security_descriptor) {
2682 print_security_descriptor(dentry->security_descriptor,
2683 dentry->security_descriptor_size);
2686 print_time(T("Creation Time"), &dentry->creation_time);
2687 print_time(T("Last Write Time"), &dentry->last_write_time);
2688 print_time(T("Last Access Time"), &dentry->last_access_time);
2691 if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT)
2692 tprintf(T("Reparse Tag = 0x%"PRIx32"\n"), dentry->reparse_tag);
2694 tprintf(T("Link Group ID = 0x%016"PRIx64"\n"), dentry->hard_link_group_id);
2695 tprintf(T("Link Count = %"PRIu32"\n"), dentry->num_links);
2697 if (dentry->unix_mode != 0) {
2698 tprintf(T("UNIX Data = uid:%"PRIu32" gid:%"PRIu32" "
2699 "mode:0%"PRIo32" rdev:0x%"PRIx32"\n"),
2700 dentry->unix_uid, dentry->unix_gid,
2701 dentry->unix_mode, dentry->unix_rdev);
2704 for (uint32_t i = 0; i <= dentry->num_named_streams; i++) {
2705 if (dentry->streams[i].stream_name) {
2706 tprintf(T("\tNamed data stream \"%"TS"\":\n"),
2707 dentry->streams[i].stream_name);
2708 } else if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_ENCRYPTED) {
2709 tprintf(T("\tRaw encrypted data stream:\n"));
2710 } else if (dentry->attributes & WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT) {
2711 tprintf(T("\tReparse point stream:\n"));
2713 tprintf(T("\tUnnamed data stream:\n"));
2715 print_resource(&dentry->streams[i].resource, NULL);
2720 print_dentry(const struct wimlib_dir_entry *dentry, void *_options)
2722 const struct print_dentry_options *options = _options;
2723 if (!options->detailed)
2724 print_dentry_full_path(dentry);
2726 print_dentry_detailed(dentry);
2730 /* Print the files contained in an image(s) in a WIM file. */
2732 imagex_dir(int argc, tchar **argv, int cmd)
2734 const tchar *wimfile;
2735 WIMStruct *wim = NULL;
2738 const tchar *path = WIMLIB_WIM_ROOT_PATH;
2740 struct print_dentry_options options = {
2743 int iterate_flags = WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2745 STRING_SET(refglobs);
2747 for_opt(c, dir_options) {
2749 case IMAGEX_PATH_OPTION:
2752 case IMAGEX_DETAILED_OPTION:
2753 options.detailed = true;
2755 case IMAGEX_ONE_FILE_ONLY_OPTION:
2756 iterate_flags &= ~WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE;
2758 case IMAGEX_REF_OPTION:
2759 ret = string_set_append(&refglobs, optarg);
2761 goto out_free_refglobs;
2771 imagex_error(T("Must specify a WIM file"));
2775 imagex_error(T("Too many arguments"));
2780 ret = wimlib_open_wim_with_progress(wimfile, 0, &wim,
2781 imagex_progress_func, NULL);
2783 goto out_free_refglobs;
2786 image = wimlib_resolve_image(wim, argv[1]);
2787 ret = verify_image_exists(image, argv[1], wimfile);
2789 goto out_wimlib_free;
2791 /* No image specified; default to image 1, but only if the WIM
2792 * contains exactly one image. */
2794 struct wimlib_wim_info info;
2796 wimlib_get_wim_info(wim, &info);
2797 if (info.image_count != 1) {
2798 imagex_error(T("\"%"TS"\" contains %d images; Please "
2799 "select one (or all)."),
2800 wimfile, info.image_count);
2807 if (refglobs.num_strings) {
2808 ret = wim_reference_globs(wim, &refglobs, 0);
2810 goto out_wimlib_free;
2813 ret = wimlib_iterate_dir_tree(wim, image, path, iterate_flags,
2814 print_dentry, &options);
2815 if (ret == WIMLIB_ERR_METADATA_NOT_FOUND) {
2816 struct wimlib_wim_info info;
2818 wimlib_get_wim_info(wim, &info);
2819 do_metadata_not_found_warning(wimfile, &info);
2824 string_set_destroy(&refglobs);
2828 usage(CMD_DIR, stderr);
2830 goto out_free_refglobs;
2833 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2836 imagex_export(int argc, tchar **argv, int cmd)
2840 int export_flags = WIMLIB_EXPORT_FLAG_GIFT;
2841 int write_flags = 0;
2842 int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2843 const tchar *src_wimfile;
2844 const tchar *src_image_num_or_name;
2845 const tchar *dest_wimfile;
2847 const tchar *dest_name;
2848 const tchar *dest_desc;
2850 struct wimlib_wim_info src_info;
2851 WIMStruct *dest_wim;
2856 STRING_SET(refglobs);
2857 unsigned num_threads = 0;
2858 uint32_t chunk_size = UINT32_MAX;
2859 uint32_t solid_chunk_size = UINT32_MAX;
2860 int solid_ctype = WIMLIB_COMPRESSION_TYPE_INVALID;
2862 for_opt(c, export_options) {
2864 case IMAGEX_BOOT_OPTION:
2865 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2867 case IMAGEX_CHECK_OPTION:
2868 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2869 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2871 case IMAGEX_NOCHECK_OPTION:
2872 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2874 case IMAGEX_COMPRESS_OPTION:
2875 compression_type = get_compression_type(optarg, false);
2876 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2879 case IMAGEX_COMPRESS_SLOW_OPTION:
2880 set_compress_slow();
2881 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2883 case IMAGEX_RECOMPRESS_OPTION:
2884 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
2886 case IMAGEX_SOLID_OPTION:
2887 write_flags |= WIMLIB_WRITE_FLAG_SOLID;
2889 case IMAGEX_NO_SOLID_SORT_OPTION:
2890 write_flags |= WIMLIB_WRITE_FLAG_NO_SOLID_SORT;
2892 case IMAGEX_CHUNK_SIZE_OPTION:
2893 chunk_size = parse_chunk_size(optarg);
2894 if (chunk_size == UINT32_MAX)
2897 case IMAGEX_SOLID_CHUNK_SIZE_OPTION:
2898 solid_chunk_size = parse_chunk_size(optarg);
2899 if (solid_chunk_size == UINT32_MAX)
2902 case IMAGEX_SOLID_COMPRESS_OPTION:
2903 solid_ctype = get_compression_type(optarg, true);
2904 if (solid_ctype == WIMLIB_COMPRESSION_TYPE_INVALID)
2907 case IMAGEX_REF_OPTION:
2908 ret = string_set_append(&refglobs, optarg);
2910 goto out_free_refglobs;
2912 case IMAGEX_THREADS_OPTION:
2913 num_threads = parse_num_threads(optarg);
2914 if (num_threads == UINT_MAX)
2917 case IMAGEX_REBUILD_OPTION:
2918 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2920 case IMAGEX_PIPABLE_OPTION:
2921 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2923 case IMAGEX_NOT_PIPABLE_OPTION:
2924 write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2926 case IMAGEX_WIMBOOT_OPTION:
2927 export_flags |= WIMLIB_EXPORT_FLAG_WIMBOOT;
2929 case IMAGEX_UNSAFE_COMPACT_OPTION:
2930 write_flags |= WIMLIB_WRITE_FLAG_UNSAFE_COMPACT;
2938 if (argc < 3 || argc > 5)
2940 src_wimfile = argv[0];
2941 src_image_num_or_name = argv[1];
2942 dest_wimfile = argv[2];
2943 dest_name = (argc >= 4) ? argv[3] : NULL;
2944 dest_desc = (argc >= 5) ? argv[4] : NULL;
2945 ret = wimlib_open_wim_with_progress(src_wimfile, open_flags, &src_wim,
2946 imagex_progress_func, NULL);
2948 goto out_free_refglobs;
2950 wimlib_get_wim_info(src_wim, &src_info);
2952 /* Determine if the destination is an existing file or not. If so, we
2953 * try to append the exported image(s) to it; otherwise, we create a new
2954 * WIM containing the exported image(s). Furthermore, determine if we
2955 * need to write a pipable WIM directly to standard output. */
2957 if (tstrcmp(dest_wimfile, T("-")) == 0) {
2959 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2960 imagex_error("Can't write a non-pipable WIM to "
2961 "standard output! Specify --pipable\n"
2962 " if you want to create a pipable WIM "
2963 "(but read the docs first).");
2965 goto out_free_src_wim;
2968 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2970 dest_wimfile = NULL;
2971 dest_wim_fd = STDOUT_FILENO;
2972 imagex_info_file = stderr;
2973 set_fd_to_binary_mode(dest_wim_fd);
2976 if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2978 /* Destination file exists. */
2980 if (!S_ISREG(stbuf.st_mode)) {
2981 imagex_error(T("\"%"TS"\" is not a regular file"),
2984 goto out_free_src_wim;
2986 ret = wimlib_open_wim_with_progress(dest_wimfile,
2988 WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2990 imagex_progress_func,
2993 goto out_free_src_wim;
2995 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2996 /* The user specified a compression type, but we're
2997 * exporting to an existing WIM. Make sure the
2998 * specified compression type is the same as the
2999 * compression type of the existing destination WIM. */
3000 struct wimlib_wim_info dest_info;
3002 wimlib_get_wim_info(dest_wim, &dest_info);
3003 if (compression_type != dest_info.compression_type) {
3004 imagex_error(T("Cannot specify a compression type that is "
3005 "not the same as that used in the "
3006 "destination WIM"));
3008 goto out_free_dest_wim;
3014 if (errno != ENOENT) {
3015 imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
3018 goto out_free_src_wim;
3021 if (write_flags & WIMLIB_WRITE_FLAG_UNSAFE_COMPACT) {
3022 imagex_error(T("'--unsafe-compact' is only valid when "
3023 "exporting to an existing WIM file!"));
3025 goto out_free_src_wim;
3028 /* dest_wimfile is not an existing file, so create a new WIM. */
3030 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
3031 /* The user did not specify a compression type; default
3032 * to that of the source WIM, unless --solid or
3033 * --wimboot was specified. */
3035 if (write_flags & WIMLIB_WRITE_FLAG_SOLID)
3036 compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
3037 else if (export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
3038 compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
3040 compression_type = src_info.compression_type;
3042 ret = wimlib_create_new_wim(compression_type, &dest_wim);
3044 goto out_free_src_wim;
3046 wimlib_register_progress_function(dest_wim,
3047 imagex_progress_func, NULL);
3049 if ((export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT)
3050 && compression_type == WIMLIB_COMPRESSION_TYPE_XPRESS)
3052 /* For --wimboot export, use small XPRESS chunks. */
3053 wimlib_set_output_chunk_size(dest_wim, 4096);
3054 } else if (compression_type == src_info.compression_type &&
3055 chunk_size == UINT32_MAX)
3057 /* Use same chunk size if compression type is the same. */
3058 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
3062 if (chunk_size != UINT32_MAX) {
3063 /* Set destination chunk size. */
3064 ret = wimlib_set_output_chunk_size(dest_wim, chunk_size);
3066 goto out_free_dest_wim;
3068 if (solid_ctype != WIMLIB_COMPRESSION_TYPE_INVALID) {
3069 ret = wimlib_set_output_pack_compression_type(dest_wim, solid_ctype);
3071 goto out_free_dest_wim;
3073 if (solid_chunk_size != UINT32_MAX) {
3074 ret = wimlib_set_output_pack_chunk_size(dest_wim, solid_chunk_size);
3076 goto out_free_dest_wim;
3079 image = wimlib_resolve_image(src_wim, src_image_num_or_name);
3080 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
3082 goto out_free_dest_wim;
3084 if (refglobs.num_strings) {
3085 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
3087 goto out_free_dest_wim;
3090 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
3091 image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
3093 imagex_error(T("--boot specified for all-images export, but source WIM "
3094 "has no bootable image."));
3096 goto out_free_dest_wim;
3099 ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
3100 dest_desc, export_flags);
3102 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
3103 do_resource_not_found_warning(src_wimfile,
3104 &src_info, &refglobs);
3105 } else if (ret == WIMLIB_ERR_METADATA_NOT_FOUND) {
3106 do_metadata_not_found_warning(src_wimfile, &src_info);
3108 goto out_free_dest_wim;
3112 ret = wimlib_overwrite(dest_wim, write_flags, num_threads);
3113 else if (dest_wimfile)
3114 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
3115 write_flags, num_threads);
3117 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
3118 WIMLIB_ALL_IMAGES, write_flags,
3121 wimlib_free(dest_wim);
3123 wimlib_free(src_wim);
3125 string_set_destroy(&refglobs);
3129 usage(CMD_EXPORT, stderr);
3132 goto out_free_refglobs;
3135 /* Extract files or directories from a WIM image */
3137 imagex_extract(int argc, tchar **argv, int cmd)
3144 const tchar *wimfile;
3145 const tchar *image_num_or_name;
3146 tchar *dest_dir = T(".");
3147 int extract_flags = WIMLIB_EXTRACT_FLAG_NORPFIX |
3148 WIMLIB_EXTRACT_FLAG_GLOB_PATHS |
3149 WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
3150 int notlist_extract_flags = WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
3152 STRING_SET(refglobs);
3154 tchar *root_path = WIMLIB_WIM_ROOT_PATH;
3156 for_opt(c, extract_options) {
3158 case IMAGEX_CHECK_OPTION:
3159 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3161 case IMAGEX_VERBOSE_OPTION:
3162 /* No longer does anything. */
3164 case IMAGEX_REF_OPTION:
3165 ret = string_set_append(&refglobs, optarg);
3167 goto out_free_refglobs;
3169 case IMAGEX_UNIX_DATA_OPTION:
3170 extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
3172 case IMAGEX_NO_ACLS_OPTION:
3173 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
3175 case IMAGEX_STRICT_ACLS_OPTION:
3176 extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
3178 case IMAGEX_NO_ATTRIBUTES_OPTION:
3179 extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES;
3181 case IMAGEX_DEST_DIR_OPTION:
3184 case IMAGEX_TO_STDOUT_OPTION:
3185 extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
3186 imagex_info_file = stderr;
3187 imagex_be_quiet = true;
3188 set_fd_to_binary_mode(STDOUT_FILENO);
3190 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
3191 extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
3192 extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
3194 case IMAGEX_NO_GLOBS_OPTION:
3195 extract_flags &= ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS;
3197 case IMAGEX_NULLGLOB_OPTION:
3198 extract_flags &= ~WIMLIB_EXTRACT_FLAG_STRICT_GLOB;
3200 case IMAGEX_PRESERVE_DIR_STRUCTURE_OPTION:
3201 notlist_extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE;
3203 case IMAGEX_WIMBOOT_OPTION:
3204 extract_flags |= WIMLIB_EXTRACT_FLAG_WIMBOOT;
3206 case IMAGEX_COMPACT_OPTION:
3207 ret = set_compact_mode(optarg, &extract_flags);
3209 goto out_free_refglobs;