4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012 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/>.
39 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
41 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (char**)argv, "", \
61 static void usage(int cmd_type);
62 static void usage_all();
64 static const char *usage_strings[] = {
66 "imagex append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
67 " [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
68 " [--verbose] [--dereference] [--config=FILE]\n"
69 " [--threads=NUM_THREADS] [--rebuild]\n",
71 "imagex apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
72 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
73 " [--symlink] [--verbose] [--ref=\"GLOB\"]\n",
75 "imagex capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
76 " [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
77 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
78 " [--config=FILE] [--threads=NUM_THREADS]\n",
80 "imagex delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n",
82 "imagex dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
84 "imagex export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
85 " DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
86 " [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
87 " [--threads=NUM_THREADS] [--rebuild]\n",
89 "imagex info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
90 " [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
91 " [--xml] [--extract-xml FILE] [--metadata]\n",
93 "imagex join [--check] WIMFILE SPLIT_WIM...\n",
95 "imagex mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
96 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
97 " [--ref=\"GLOB\"]\n",
99 "imagex mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
100 " [--check] [--debug] [--streams-interface=INTERFACE]\n",
102 "imagex optimize WIMFILE [--check] [--recompress]\n",
104 "imagex split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
106 "imagex unmount DIRECTORY [--commit] [--check]\n",
109 static const struct option common_options[] = {
110 {"help", 0, NULL, 'h'},
111 {"version", 0, NULL, 'v'},
115 static const struct option apply_options[] = {
116 {"check", no_argument, NULL, 'c'},
117 {"hardlink", no_argument, NULL, 'h'},
118 {"symlink", no_argument, NULL, 's'},
119 {"verbose", no_argument, NULL, 'v'},
120 {"ref", required_argument, NULL, 'r'},
123 static const struct option capture_or_append_options[] = {
124 {"boot", no_argument, NULL, 'b'},
125 {"check", no_argument, NULL, 'c'},
126 {"compress", required_argument, NULL, 'x'},
127 {"config", required_argument, NULL, 'C'},
128 {"dereference", no_argument, NULL, 'L'},
129 {"flags", required_argument, NULL, 'f'},
130 {"verbose", no_argument, NULL, 'v'},
131 {"threads", required_argument, NULL, 't'},
132 {"rebuild", no_argument, NULL, 'R'},
135 static const struct option delete_options[] = {
136 {"check", no_argument, NULL, 'c'},
137 {"soft", no_argument, NULL, 's'},
141 static const struct option export_options[] = {
142 {"boot", no_argument, NULL, 'b'},
143 {"check", no_argument, NULL, 'c'},
144 {"compress", required_argument, NULL, 'x'},
145 {"ref", required_argument, NULL, 'r'},
146 {"threads", required_argument, NULL, 't'},
147 {"rebuild", no_argument, NULL, 'R'},
151 static const struct option info_options[] = {
152 {"boot", no_argument, NULL, 'b'},
153 {"check", no_argument, NULL, 'c'},
154 {"extract-xml", required_argument, NULL, 'X'},
155 {"header", no_argument, NULL, 'h'},
156 {"lookup-table", no_argument, NULL, 'l'},
157 {"metadata", no_argument, NULL, 'm'},
158 {"xml", no_argument, NULL, 'x'},
162 static const struct option join_options[] = {
163 {"check", no_argument, NULL, 'c'},
167 static const struct option mount_options[] = {
168 {"check", no_argument, NULL, 'c'},
169 {"debug", no_argument, NULL, 'd'},
170 {"streams-interface", required_argument, NULL, 's'},
171 {"ref", required_argument, NULL, 'r'},
175 static const struct option optimize_options[] = {
176 {"check", no_argument, NULL, 'c'},
177 {"recompress", no_argument, NULL, 'r'},
181 static const struct option split_options[] = {
182 {"check", no_argument, NULL, 'c'},
186 static const struct option unmount_options[] = {
187 {"commit", no_argument, NULL, 'c'},
188 {"check", no_argument, NULL, 'C'},
194 /* Print formatted error message to stderr. */
195 static void imagex_error(const char *format, ...)
198 va_start(va, format);
199 fputs("ERROR: ", stderr);
200 vfprintf(stderr, format, va);
205 /* Print formatted error message to stderr. */
206 static void imagex_error_with_errno(const char *format, ...)
208 int errno_save = errno;
210 va_start(va, format);
211 fputs("ERROR: ", stderr);
212 vfprintf(stderr, format, va);
213 fprintf(stderr, ": %s\n", strerror(errno_save));
217 static int verify_image_exists(int image, const char *image_name,
218 const char *wim_name)
220 if (image == WIMLIB_NO_IMAGE) {
221 imagex_error("\"%s\" is not a valid image in `%s'!\n"
222 " Please specify a 1-based imagex index or "
224 " You may use `imagex info' to list the images "
225 "contained in a WIM.",
226 image_name, wim_name);
232 static int verify_image_is_single(int image)
234 if (image == WIMLIB_ALL_IMAGES) {
235 imagex_error("Cannot specify all images for this action!");
241 static int verify_image_exists_and_is_single(int image, const char *image_name,
242 const char *wim_name)
245 ret = verify_image_exists(image, image_name, wim_name);
247 ret = verify_image_is_single(image);
251 static int get_compression_type(const char *optarg)
253 if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
254 return WIMLIB_COMPRESSION_TYPE_LZX;
255 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
256 return WIMLIB_COMPRESSION_TYPE_XPRESS;
257 else if (strcasecmp(optarg, "none") == 0)
258 return WIMLIB_COMPRESSION_TYPE_NONE;
260 imagex_error("Invalid compression type `%s'! Must be "
261 "\"maximum\", \"fast\", or \"none\".", optarg);
262 return WIMLIB_COMPRESSION_TYPE_INVALID;
266 static off_t file_get_size(const char *filename)
269 if (stat(filename, &st) == 0)
275 static char *file_get_contents(const char *filename, size_t *len_ret)
282 if (stat(filename, &stbuf) != 0) {
283 imagex_error_with_errno("Failed to stat the file `%s'", filename);
288 fp = fopen(filename, "rb");
290 imagex_error_with_errno("Failed to open the file `%s'", filename);
296 imagex_error("Failed to allocate buffer of %zu bytes to hold "
297 "contents of file `%s'", len, filename);
300 if (fread(buf, 1, len, fp) != len) {
301 imagex_error_with_errno("Failed to read %lu bytes from the "
302 "file `%s'", len, filename);
314 static int file_writable(const char *path)
317 ret = access(path, F_OK | W_OK);
319 imagex_error_with_errno("Can't modify `%s'", path);
323 #define TO_PERCENT(numerator, denominator) \
324 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
326 static const char *get_data_type(int ctype)
329 case WIMLIB_COMPRESSION_TYPE_NONE:
330 return "uncompressed";
331 case WIMLIB_COMPRESSION_TYPE_LZX:
332 return "LZX-compressed";
333 case WIMLIB_COMPRESSION_TYPE_XPRESS:
334 return "XPRESS-compressed";
339 static int imagex_progress_func(enum wimlib_progress_msg msg,
340 const union wimlib_progress_info *info)
342 unsigned percent_done;
344 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
345 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
346 info->write_streams.total_bytes);
347 if (info->write_streams.completed_streams == 0) {
348 const char *data_type;
350 data_type = get_data_type(info->write_streams.compression_type);
351 printf("Writing %s data using %u thread%s\n",
352 data_type, info->write_streams.num_threads,
353 (info->write_streams.num_threads == 1) ? "" : "s");
355 printf("\r%"PRIu64" MiB of %"PRIu64" MiB (uncompressed) "
356 "written (%u%% done)",
357 info->write_streams.completed_bytes >> 20,
358 info->write_streams.total_bytes >> 20,
360 if (info->write_streams.completed_bytes == info->write_streams.total_bytes)
363 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
364 printf("Scanning `%s'...\n", info->scan.source);
366 /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
368 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
369 percent_done = TO_PERCENT(info->integrity.completed_bytes,
370 info->integrity.total_bytes);
371 printf("\rVerifying integrity of `%s': %"PRIu64" MiB "
372 "of %"PRIu64" MiB (%u%%) done",
373 info->integrity.filename,
374 info->integrity.completed_bytes >> 20,
375 info->integrity.total_bytes >> 20,
377 if (info->integrity.completed_bytes == info->integrity.total_bytes)
380 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
381 percent_done = TO_PERCENT(info->integrity.completed_bytes,
382 info->integrity.total_bytes);
383 printf("\rCalculating integrity table for WIM: %"PRIu64" MiB "
384 "of %"PRIu64" MiB (%u%%) done",
385 info->integrity.completed_bytes >> 20,
386 info->integrity.total_bytes >> 20,
388 if (info->integrity.completed_bytes == info->integrity.total_bytes)
391 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
392 /*printf("Applying image %d (%s) to `%s'\n",*/
393 /*info->extract.image,*/
394 /*info->extract.image_name,*/
395 /*info->extract.target);*/
397 /*case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:*/
398 /*printf("Done applying image %d!\n",*/
399 /*info->extract.image);*/
401 /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
402 /*printf("Applying directory structure to %s\n",*/
403 /*info->extract.target);*/
405 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
406 percent_done = TO_PERCENT(info->extract.completed_bytes,
407 info->extract.total_bytes);
408 printf("\rExtracting files: "
409 "%"PRIu64" MiB of %"PRIu64" MiB (%u%%) done",
410 info->extract.completed_bytes >> 20,
411 info->extract.total_bytes >> 20,
413 if (info->extract.completed_bytes == info->extract.total_bytes)
416 case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
417 percent_done = TO_PERCENT(info->join.completed_bytes,
418 info->join.total_bytes);
419 printf("Writing resources from part %u of %u: "
420 "%"PRIu64 " MiB of %"PRIu64" MiB (%u%%) written\n",
421 (info->join.completed_parts == info->join.total_parts) ?
422 info->join.completed_parts : info->join.completed_parts + 1,
423 info->join.total_parts,
424 info->join.completed_bytes >> 20,
425 info->join.total_bytes >> 20,
428 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
429 percent_done = TO_PERCENT(info->split.completed_bytes,
430 info->split.total_bytes);
431 printf("Writing `%s': %"PRIu64" MiB of %"PRIu64" MiB (%u%%) written\n",
432 info->split.part_name,
433 info->split.completed_bytes >> 20,
434 info->split.total_bytes >> 20,
437 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
438 if (info->split.completed_bytes == info->split.total_bytes) {
439 printf("Finished writing %u split WIM parts\n",
440 info->split.cur_part_number);
451 static int open_swms_from_glob(const char *swm_glob,
452 const char *first_part,
454 WIMStruct ***additional_swms_ret,
455 unsigned *num_additional_swms_ret)
457 unsigned num_additional_swms = 0;
458 WIMStruct **additional_swms = NULL;
462 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
464 if (ret == GLOB_NOMATCH) {
465 imagex_error("Found no files for glob \"%s\"",
468 imagex_error_with_errno("Failed to process glob "
474 num_additional_swms = globbuf.gl_pathc;
475 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
476 if (!additional_swms) {
477 imagex_error("Out of memory");
482 for (unsigned i = 0; i < num_additional_swms; i++) {
483 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
487 ret = wimlib_open_wim(globbuf.gl_pathv[i],
488 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
489 &additional_swms[i - offset],
490 imagex_progress_func);
494 *additional_swms_ret = additional_swms;
495 *num_additional_swms_ret = num_additional_swms - offset;
499 for (unsigned i = 0; i < num_additional_swms; i++)
500 wimlib_free(additional_swms[i]);
501 free(additional_swms);
509 static unsigned parse_num_threads(const char *optarg)
512 unsigned nthreads = strtoul(optarg, &tmp, 10);
513 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
514 imagex_error("Number of threads must be a non-negative integer!");
522 /* Extract one image, or all images, from a WIM file into a directory. */
523 static int imagex_apply(int argc, const char **argv)
526 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
533 const char *image_num_or_name;
534 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
536 const char *swm_glob = NULL;
537 WIMStruct **additional_swms = NULL;
538 unsigned num_additional_swms = 0;
540 for_opt(c, apply_options) {
543 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
546 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
549 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
552 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
564 if (argc != 2 && argc != 3) {
571 image_num_or_name = "1";
574 image_num_or_name = argv[1];
578 ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func);
582 image = wimlib_resolve_image(w, image_num_or_name);
583 ret = verify_image_exists(image, image_num_or_name, wimfile);
587 num_images = wimlib_get_num_images(w);
588 if (argc == 2 && num_images != 1) {
589 imagex_error("`%s' contains %d images; Please select one "
590 "(or all)", wimfile, num_images);
597 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
599 &num_additional_swms);
607 ret = stat(target, &stbuf);
609 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
610 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
611 printf("Applying `%s' image %d to NTFS volume `%s'\n",
612 wimfile, image, target);
615 if (errno != ENOENT) {
616 imagex_error_with_errno("Failed to stat `%s'", target);
623 ret = wimlib_extract_image(w, image, target, extract_flags,
624 additional_swms, num_additional_swms,
625 imagex_progress_func);
628 if (additional_swms) {
629 for (unsigned i = 0; i < num_additional_swms; i++)
630 wimlib_free(additional_swms[i]);
631 free(additional_swms);
636 static int imagex_capture_or_append(int argc, const char **argv)
640 int add_image_flags = 0;
642 int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
647 const char *flags_element = NULL;
648 const char *config_file = NULL;
649 char *config_str = NULL;
650 size_t config_len = 0;
655 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
656 unsigned num_threads = 0;
658 for_opt(c, capture_or_append_options) {
661 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
664 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
665 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
668 config_file = optarg;
671 compression_type = get_compression_type(optarg);
672 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
676 flags_element = optarg;
679 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
682 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
685 num_threads = parse_num_threads(optarg);
686 if (num_threads == UINT_MAX)
690 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
699 if (argc < 2 || argc > 4) {
706 char source_copy[strlen(source) + 1];
707 memcpy(source_copy, source, strlen(source) + 1);
708 default_name = basename(source_copy);
710 name = (argc >= 3) ? argv[2] : default_name;
711 desc = (argc >= 4) ? argv[3] : NULL;
714 config_str = file_get_contents(config_file, &config_len);
720 ret = wimlib_open_wim(wimfile, open_flags, &w,
721 imagex_progress_func);
723 ret = wimlib_create_new_wim(compression_type, &w);
730 ret = stat(source, &stbuf);
732 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
733 printf("Capturing WIM image from NTFS filesystem on `%s'\n",
735 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
738 if (errno != ENOENT) {
739 imagex_error_with_errno("Failed to stat `%s'", source);
745 ret = wimlib_add_image(w, source, name, config_str, config_len,
746 add_image_flags, imagex_progress_func);
750 cur_image = wimlib_get_num_images(w);
752 ret = wimlib_set_image_descripton(w, cur_image, desc);
757 ret = wimlib_set_image_flags(w, cur_image, flags_element);
762 ret = wimlib_overwrite(w, write_flags, num_threads,
763 imagex_progress_func);
765 ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags,
766 num_threads, imagex_progress_func);
768 if (ret == WIMLIB_ERR_REOPEN)
771 imagex_error("Failed to write the WIM file `%s'", wimfile);
778 /* Remove image(s) from a WIM. */
779 static int imagex_delete(int argc, const char **argv)
785 const char *image_num_or_name;
790 for_opt(c, delete_options) {
793 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
794 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
797 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
809 imagex_error("Must specify a WIM file");
811 imagex_error("Must specify an image");
816 image_num_or_name = argv[1];
818 ret = file_writable(wimfile);
822 ret = wimlib_open_wim(wimfile, open_flags, &w,
823 imagex_progress_func);
827 image = wimlib_resolve_image(w, image_num_or_name);
829 ret = verify_image_exists(image, image_num_or_name, wimfile);
833 ret = wimlib_delete_image(w, image);
835 imagex_error("Failed to delete image from `%s'", wimfile);
839 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
840 if (ret == WIMLIB_ERR_REOPEN)
843 imagex_error("Failed to write the file `%s' with image "
851 /* Print the files contained in an image(s) in a WIM file. */
852 static int imagex_dir(int argc, const char **argv)
861 imagex_error("Must specify a WIM file");
866 imagex_error("Too many arguments");
872 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w,
873 imagex_progress_func);
878 image = wimlib_resolve_image(w, argv[2]);
879 ret = verify_image_exists(image, argv[2], wimfile);
883 /* Image was not specified. If the WIM only contains one image,
884 * choose that one; otherwise, print an error. */
885 num_images = wimlib_get_num_images(w);
886 if (num_images != 1) {
887 imagex_error("The file `%s' contains %d images; Please "
888 "select one.", wimfile, num_images);
896 ret = wimlib_print_files(w, image);
902 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
904 static int imagex_export(int argc, const char **argv)
908 int export_flags = 0;
910 int compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
911 bool compression_type_specified = false;
912 const char *src_wimfile;
913 const char *src_image_num_or_name;
914 const char *dest_wimfile;
915 const char *dest_name;
916 const char *dest_desc;
917 WIMStruct *src_w = NULL;
918 WIMStruct *dest_w = NULL;
923 const char *swm_glob = NULL;
924 WIMStruct **additional_swms = NULL;
925 unsigned num_additional_swms = 0;
926 unsigned num_threads = 0;
928 for_opt(c, export_options) {
931 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
934 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
935 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
938 compression_type = get_compression_type(optarg);
939 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
941 compression_type_specified = true;
947 num_threads = parse_num_threads(optarg);
948 if (num_threads == UINT_MAX)
952 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
961 if (argc < 3 || argc > 5) {
965 src_wimfile = argv[0];
966 src_image_num_or_name = argv[1];
967 dest_wimfile = argv[2];
968 dest_name = (argc >= 4) ? argv[3] : NULL;
969 dest_desc = (argc >= 5) ? argv[4] : NULL;
970 ret = wimlib_open_wim(src_wimfile,
971 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w,
972 imagex_progress_func);
976 /* Determine if the destination is an existing file or not.
977 * If so, we try to append the exported image(s) to it; otherwise, we
978 * create a new WIM containing the exported image(s). */
979 if (stat(dest_wimfile, &stbuf) == 0) {
983 /* Destination file exists. */
984 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
985 imagex_error("`%s' is not a regular file",
990 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w,
991 imagex_progress_func);
995 ret = file_writable(dest_wimfile);
999 dest_ctype = wimlib_get_compression_type(dest_w);
1000 if (compression_type_specified
1001 && compression_type != dest_ctype)
1003 imagex_error("Cannot specify a compression type that is "
1004 "not the same as that used in the "
1009 compression_type = dest_ctype;
1012 /* dest_wimfile is not an existing file, so create a new WIM. */
1013 if (!compression_type_specified)
1014 compression_type = wimlib_get_compression_type(src_w);
1015 if (errno == ENOENT) {
1016 ret = wimlib_create_new_wim(compression_type, &dest_w);
1020 imagex_error_with_errno("Cannot stat file `%s'",
1027 image = wimlib_resolve_image(src_w, src_image_num_or_name);
1028 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
1033 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
1035 &num_additional_swms);
1040 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
1041 export_flags, additional_swms,
1042 num_additional_swms, imagex_progress_func);
1048 ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES,
1049 write_flags, num_threads,
1050 imagex_progress_func);
1052 ret = wimlib_overwrite(dest_w, write_flags, num_threads,
1053 imagex_progress_func);
1055 if (ret == WIMLIB_ERR_REOPEN)
1058 wimlib_free(dest_w);
1059 if (additional_swms) {
1060 for (unsigned i = 0; i < num_additional_swms; i++)
1061 wimlib_free(additional_swms[i]);
1062 free(additional_swms);
1067 /* Prints information about a WIM file; also can mark an image as bootable,
1068 * change the name of an image, or change the description of an image. */
1069 static int imagex_info(int argc, const char **argv)
1074 bool header = false;
1075 bool lookup_table = false;
1077 bool metadata = false;
1078 bool short_header = true;
1079 const char *xml_out_file = NULL;
1080 const char *wimfile;
1081 const char *image_num_or_name = "all";
1082 const char *new_name = NULL;
1083 const char *new_desc = NULL;
1088 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1092 for_opt(c, info_options) {
1102 short_header = false;
1105 lookup_table = true;
1106 short_header = false;
1110 short_header = false;
1113 xml_out_file = optarg;
1114 short_header = false;
1118 short_header = false;
1128 if (argc == 0 || argc > 4) {
1134 image_num_or_name = argv[1];
1144 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1146 ret = wimlib_open_wim(wimfile, open_flags, &w,
1147 imagex_progress_func);
1151 part_number = wimlib_get_part_number(w, &total_parts);
1153 image = wimlib_resolve_image(w, image_num_or_name);
1154 if (image == WIMLIB_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
1155 imagex_error("The image `%s' does not exist",
1158 imagex_error("If you would like to set the boot "
1159 "index to 0, specify image \"0\" with "
1160 "the --boot flag.");
1161 ret = WIMLIB_ERR_INVALID_IMAGE;
1165 if (image == WIMLIB_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1167 imagex_error("Cannot specify the --boot flag "
1168 "without specifying a specific "
1169 "image in a multi-image WIM");
1170 ret = WIMLIB_ERR_INVALID_IMAGE;
1174 imagex_error("Cannot specify the NEW_NAME "
1175 "without specifying a specific "
1176 "image in a multi-image WIM");
1177 ret = WIMLIB_ERR_INVALID_IMAGE;
1182 /* Operations that print information are separated from operations that
1183 * recreate the WIM file. */
1184 if (!new_name && !boot) {
1186 /* Read-only operations */
1188 if (image == WIMLIB_NO_IMAGE) {
1189 imagex_error("`%s' is not a valid image",
1191 ret = WIMLIB_ERR_INVALID_IMAGE;
1195 if (image == WIMLIB_ALL_IMAGES && short_header)
1196 wimlib_print_wim_information(w);
1199 wimlib_print_header(w);
1202 if (total_parts != 1) {
1203 printf("Warning: Only showing the lookup table "
1204 "for part %d of a %d-part WIM.\n",
1205 part_number, total_parts);
1207 wimlib_print_lookup_table(w);
1211 ret = wimlib_extract_xml_data(w, stdout);
1217 fp = fopen(xml_out_file, "wb");
1219 imagex_error_with_errno("Failed to open the "
1225 ret = wimlib_extract_xml_data(w, fp);
1226 if (fclose(fp) != 0) {
1227 imagex_error("Failed to close the file `%s'",
1237 wimlib_print_available_images(w, image);
1240 ret = wimlib_print_metadata(w, image);
1246 /* Modification operations */
1247 if (total_parts != 1) {
1248 imagex_error("Modifying a split WIM is not supported.");
1251 if (image == WIMLIB_ALL_IMAGES)
1254 if (image == WIMLIB_NO_IMAGE && new_name) {
1255 imagex_error("Cannot specify new_name (`%s') when "
1256 "using image 0", new_name);
1261 if (image == wimlib_get_boot_idx(w)) {
1262 printf("Image %d is already marked as "
1263 "bootable.\n", image);
1266 printf("Marking image %d as bootable.\n",
1268 wimlib_set_boot_idx(w, image);
1272 if (strcmp(wimlib_get_image_name(w, image),
1274 printf("Image %d is already named \"%s\".\n",
1278 printf("Changing the name of image %d to "
1279 "\"%s\".\n", image, new_name);
1280 ret = wimlib_set_image_name(w, image, new_name);
1286 const char *old_desc;
1287 old_desc = wimlib_get_image_description(w, image);
1288 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1289 printf("The description of image %d is already "
1290 "\"%s\".\n", image, new_desc);
1293 printf("Changing the description of image %d "
1294 "to \"%s\".\n", image, new_desc);
1295 ret = wimlib_set_image_descripton(w, image,
1302 /* Only call wimlib_overwrite() if something actually needs to
1304 if (boot || new_name || new_desc ||
1305 check != wimlib_has_integrity_table(w)) {
1307 ret = file_writable(wimfile);
1313 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1318 ret = wimlib_overwrite(w, write_flags, 1,
1319 imagex_progress_func);
1320 if (ret == WIMLIB_ERR_REOPEN)
1323 printf("The file `%s' was not modified because nothing "
1324 "needed to be done.\n", wimfile);
1333 /* Join split WIMs into one part WIM */
1334 static int imagex_join(int argc, const char **argv)
1337 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1338 int wim_write_flags = 0;
1339 const char *output_path;
1341 for_opt(c, join_options) {
1344 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1345 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1355 imagex_error("Must specify one or more split WIM (.swm) parts "
1359 output_path = argv[0];
1360 return wimlib_join(++argv, --argc, output_path, swm_open_flags,
1361 wim_write_flags, imagex_progress_func);
1367 /* Mounts an image using a FUSE mount. */
1368 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1371 int mount_flags = 0;
1372 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1373 const char *wimfile;
1379 const char *swm_glob = NULL;
1380 WIMStruct **additional_swms = NULL;
1381 unsigned num_additional_swms = 0;
1383 if (strcmp(argv[0], "mountrw") == 0)
1384 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1386 for_opt(c, mount_options) {
1389 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1392 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1395 if (strcasecmp(optarg, "none") == 0)
1396 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1397 else if (strcasecmp(optarg, "xattr") == 0)
1398 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1399 else if (strcasecmp(optarg, "windows") == 0)
1400 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1402 imagex_error("Unknown stream interface \"%s\"", optarg);
1415 if (argc != 2 && argc != 3)
1420 ret = wimlib_open_wim(wimfile, open_flags, &w,
1421 imagex_progress_func);
1426 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1428 &num_additional_swms);
1435 num_images = wimlib_get_num_images(w);
1436 if (num_images != 1) {
1437 imagex_error("The file `%s' contains %d images; Please "
1438 "select one.", wimfile, num_images);
1439 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1446 image = wimlib_resolve_image(w, argv[1]);
1448 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1453 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1454 ret = file_writable(wimfile);
1459 ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms,
1460 num_additional_swms, NULL);
1462 imagex_error("Failed to mount image %d from `%s' on `%s'",
1463 image, wimfile, dir);
1468 if (additional_swms) {
1469 for (unsigned i = 0; i < num_additional_swms; i++)
1470 wimlib_free(additional_swms[i]);
1471 free(additional_swms);
1475 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1480 static int imagex_optimize(int argc, const char **argv)
1484 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
1487 const char *wimfile;
1491 for_opt(c, optimize_options) {
1494 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1495 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1498 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1515 ret = wimlib_open_wim(wimfile, open_flags, &w,
1516 imagex_progress_func);
1520 old_size = file_get_size(argv[0]);
1521 printf("`%s' original size: ", wimfile);
1525 printf("%"PRIu64" KiB\n", old_size >> 10);
1527 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
1529 new_size = file_get_size(argv[0]);
1530 printf("`%s' optimized size: ", wimfile);
1534 printf("%"PRIu64" KiB\n", new_size >> 10);
1536 fputs("Space saved: ", stdout);
1537 if (new_size != -1 && old_size != -1) {
1538 printf("%lld KiB\n",
1539 ((long long)old_size - (long long)new_size) >> 10);
1548 /* Split a WIM into a spanned set */
1549 static int imagex_split(int argc, const char **argv)
1552 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1553 int write_flags = 0;
1554 unsigned long part_size;
1559 for_opt(c, split_options) {
1562 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1563 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1577 part_size = strtod(argv[2], &tmp) * (1 << 20);
1578 if (tmp == argv[2] || *tmp) {
1579 imagex_error("Invalid part size \"%s\"", argv[2]);
1580 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1583 ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func);
1586 ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func);
1591 /* Unmounts an image. */
1592 static int imagex_unmount(int argc, const char **argv)
1595 int unmount_flags = 0;
1598 for_opt(c, unmount_options) {
1601 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1604 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1618 ret = wimlib_unmount_image(argv[0], unmount_flags,
1619 imagex_progress_func);
1621 imagex_error("Failed to unmount `%s'", argv[0]);
1625 struct imagex_command {
1627 int (*func)(int , const char **);
1632 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1633 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1635 static const struct imagex_command imagex_commands[] = {
1636 {"append", imagex_capture_or_append, APPEND},
1637 {"apply", imagex_apply, APPLY},
1638 {"capture", imagex_capture_or_append, CAPTURE},
1639 {"delete", imagex_delete, DELETE},
1640 {"dir", imagex_dir, DIR},
1641 {"export", imagex_export, EXPORT},
1642 {"info", imagex_info, INFO},
1643 {"join", imagex_join, JOIN},
1644 {"mount", imagex_mount_rw_or_ro, MOUNT},
1645 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1646 {"optimize",imagex_optimize, OPTIMIZE},
1647 {"split", imagex_split, SPLIT},
1648 {"unmount", imagex_unmount, UNMOUNT},
1651 static void version()
1653 static const char *s =
1654 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1655 "Copyright (C) 2012 Eric Biggers\n"
1656 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1657 "This is free software: you are free to change and redistribute it.\n"
1658 "There is NO WARRANTY, to the extent permitted by law.\n"
1660 "Report bugs to "PACKAGE_BUGREPORT".\n";
1665 static void help_or_version(int argc, const char **argv)
1669 const struct imagex_command *cmd;
1671 for (i = 1; i < argc; i++) {
1679 if (strcmp(p, "help") == 0) {
1680 for_imagex_command(cmd) {
1681 if (strcmp(cmd->name, argv[1]) == 0) {
1689 if (strcmp(p, "version") == 0) {
1697 static void usage(int cmd_type)
1699 const struct imagex_command *cmd;
1700 printf("Usage: %s", usage_strings[cmd_type]);
1701 for_imagex_command(cmd) {
1702 if (cmd->cmd == cmd_type)
1703 printf("\nTry `man imagex-%s' for more details.\n",
1708 static void usage_all()
1710 puts("IMAGEX: Usage:");
1711 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1712 printf(" %s", usage_strings[i]);
1713 static const char *extra =
1715 " imagex --version\n"
1717 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1719 " Try `man imagex' for more information.\n"
1721 fputs(extra, stdout);
1725 int main(int argc, const char **argv)
1727 const struct imagex_command *cmd;
1731 imagex_error("No command specified");
1736 help_or_version(argc, argv);
1740 wimlib_set_print_errors(true);
1742 for_imagex_command(cmd) {
1743 if (strcmp(cmd->name, *argv) == 0) {
1744 ret = cmd->func(argc, argv);
1746 imagex_error("Exiting with error code %d:\n"
1748 wimlib_get_error_string(ret));
1749 if (ret == WIMLIB_ERR_NTFS_3G)
1750 imagex_error_with_errno("errno");
1756 imagex_error("Unrecognized command: `%s'", argv[0]);