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 == WIM_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 == WIM_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 WIM_COMPRESSION_TYPE_LZX;
255 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
256 return WIM_COMPRESSION_TYPE_XPRESS;
257 else if (strcasecmp(optarg, "none") == 0)
258 return WIM_COMPRESSION_TYPE_NONE;
260 imagex_error("Invalid compression type `%s'! Must be "
261 "\"maximum\", \"fast\", or \"none\".", optarg);
262 return WIM_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 static int open_swms_from_glob(const char *swm_glob,
324 const char *first_part,
326 WIMStruct ***additional_swms_ret,
327 unsigned *num_additional_swms_ret)
329 unsigned num_additional_swms = 0;
330 WIMStruct **additional_swms = NULL;
334 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
336 if (ret == GLOB_NOMATCH) {
337 imagex_error("Found no files for glob \"%s\"",
340 imagex_error_with_errno("Failed to process glob "
346 num_additional_swms = globbuf.gl_pathc;
347 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
348 if (!additional_swms) {
349 imagex_error("Out of memory");
354 for (unsigned i = 0; i < num_additional_swms; i++) {
355 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
359 ret = wimlib_open_wim(globbuf.gl_pathv[i],
360 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
361 &additional_swms[i - offset]);
365 *additional_swms_ret = additional_swms;
366 *num_additional_swms_ret = num_additional_swms - offset;
370 for (unsigned i = 0; i < num_additional_swms; i++)
371 wimlib_free(additional_swms[i]);
372 free(additional_swms);
380 static unsigned parse_num_threads(const char *optarg)
383 unsigned nthreads = strtoul(optarg, &tmp, 10);
384 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
385 imagex_error("Number of threads must be a non-negative integer!");
393 /* Extract one image, or all images, from a WIM file into a directory. */
394 static int imagex_apply(int argc, const char **argv)
397 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
398 WIMLIB_OPEN_FLAG_SPLIT_OK;
405 const char *image_num_or_name;
406 int extract_flags = 0;
408 const char *swm_glob = NULL;
409 WIMStruct **additional_swms = NULL;
410 unsigned num_additional_swms = 0;
412 for_opt(c, apply_options) {
415 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
418 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
421 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
424 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
436 if (argc != 2 && argc != 3) {
443 image_num_or_name = "1";
446 image_num_or_name = argv[1];
450 ret = wimlib_open_wim(wimfile, open_flags, &w);
454 image = wimlib_resolve_image(w, image_num_or_name);
455 ret = verify_image_exists(image, image_num_or_name, wimfile);
459 num_images = wimlib_get_num_images(w);
460 if (argc == 2 && num_images != 1) {
461 imagex_error("`%s' contains %d images; Please select one "
462 "(or all)", wimfile, num_images);
469 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
471 &num_additional_swms);
479 ret = stat(dir, &stbuf);
481 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
482 const char *ntfs_device = dir;
483 printf("Applying image %d of `%s' to NTFS filesystem on `%s'\n",
484 image, wimfile, ntfs_device);
485 ret = wimlib_apply_image_to_ntfs_volume(w, image,
489 num_additional_swms);
493 if (errno != ENOENT) {
494 imagex_error_with_errno("Failed to stat `%s'", dir);
501 ret = wimlib_extract_image(w, image, dir, extract_flags,
502 additional_swms, num_additional_swms);
505 if (additional_swms) {
506 for (unsigned i = 0; i < num_additional_swms; i++)
507 wimlib_free(additional_swms[i]);
508 free(additional_swms);
513 static int imagex_capture_or_append(int argc, const char **argv)
516 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
517 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS;
518 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
519 int compression_type = WIM_COMPRESSION_TYPE_XPRESS;
524 const char *flags_element = NULL;
525 const char *config_file = NULL;
526 char *config_str = NULL;
527 size_t config_len = 0;
532 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
533 unsigned num_threads = 0;
535 for_opt(c, capture_or_append_options) {
538 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
541 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
542 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
545 config_file = optarg;
548 compression_type = get_compression_type(optarg);
549 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
553 flags_element = optarg;
556 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
559 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
560 write_flags |= WIMLIB_WRITE_FLAG_VERBOSE;
563 num_threads = parse_num_threads(optarg);
564 if (num_threads == UINT_MAX)
568 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
577 if (argc < 2 || argc > 4) {
584 char dir_copy[strlen(dir) + 1];
585 memcpy(dir_copy, dir, strlen(dir) + 1);
586 default_name = basename(dir_copy);
588 name = (argc >= 3) ? argv[2] : default_name;
589 desc = (argc >= 4) ? argv[3] : NULL;
592 config_str = file_get_contents(config_file, &config_len);
598 ret = wimlib_open_wim(wimfile, open_flags, &w);
600 ret = wimlib_create_new_wim(compression_type, &w);
607 ret = stat(dir, &stbuf);
609 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
610 const char *ntfs_device = dir;
611 printf("Capturing WIM image NTFS filesystem on `%s'\n",
613 ret = wimlib_add_image_from_ntfs_volume(w, ntfs_device,
621 if (errno != ENOENT) {
622 imagex_error_with_errno("Failed to stat `%s'", dir);
628 ret = wimlib_add_image(w, dir, name, config_str, config_len,
634 cur_image = wimlib_get_num_images(w);
636 ret = wimlib_set_image_descripton(w, cur_image, desc);
641 ret = wimlib_set_image_flags(w, cur_image, flags_element);
646 ret = wimlib_overwrite(w, write_flags, num_threads);
648 ret = wimlib_write(w, wimfile, WIM_ALL_IMAGES, write_flags,
651 if (ret == WIMLIB_ERR_REOPEN)
654 imagex_error("Failed to write the WIM file `%s'", wimfile);
661 /* Remove image(s) from a WIM. */
662 static int imagex_delete(int argc, const char **argv)
665 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
666 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
668 const char *image_num_or_name;
673 for_opt(c, delete_options) {
676 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
677 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
680 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
692 imagex_error("Must specify a WIM file");
694 imagex_error("Must specify an image");
699 image_num_or_name = argv[1];
701 ret = file_writable(wimfile);
705 ret = wimlib_open_wim(wimfile, open_flags, &w);
709 image = wimlib_resolve_image(w, image_num_or_name);
711 ret = verify_image_exists(image, image_num_or_name, wimfile);
715 ret = wimlib_delete_image(w, image);
717 imagex_error("Failed to delete image from `%s'", wimfile);
721 ret = wimlib_overwrite(w, write_flags, 0);
722 if (ret == WIMLIB_ERR_REOPEN)
725 imagex_error("Failed to write the file `%s' with image "
733 /* Print the files contained in an image(s) in a WIM file. */
734 static int imagex_dir(int argc, const char **argv)
743 imagex_error("Must specify a WIM file");
748 imagex_error("Too many arguments");
754 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w);
759 image = wimlib_resolve_image(w, argv[2]);
760 ret = verify_image_exists(image, argv[2], wimfile);
764 /* Image was not specified. If the WIM only contains one image,
765 * choose that one; otherwise, print an error. */
766 num_images = wimlib_get_num_images(w);
767 if (num_images != 1) {
768 imagex_error("The file `%s' contains %d images; Please "
769 "select one.", wimfile, num_images);
777 ret = wimlib_print_files(w, image);
783 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
785 static int imagex_export(int argc, const char **argv)
788 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
789 int export_flags = 0;
790 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
791 int compression_type;
792 bool compression_type_specified = false;
793 const char *src_wimfile;
794 const char *src_image_num_or_name;
795 const char *dest_wimfile;
796 const char *dest_name;
797 const char *dest_desc;
798 WIMStruct *src_w = NULL;
799 WIMStruct *dest_w = NULL;
804 const char *swm_glob = NULL;
805 WIMStruct **additional_swms = NULL;
806 unsigned num_additional_swms = 0;
807 unsigned num_threads = 0;
809 for_opt(c, export_options) {
812 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
815 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
816 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
819 compression_type = get_compression_type(optarg);
820 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
822 compression_type_specified = true;
828 num_threads = parse_num_threads(optarg);
829 if (num_threads == UINT_MAX)
833 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
842 if (argc < 3 || argc > 5) {
846 src_wimfile = argv[0];
847 src_image_num_or_name = argv[1];
848 dest_wimfile = argv[2];
849 dest_name = (argc >= 4) ? argv[3] : NULL;
850 dest_desc = (argc >= 5) ? argv[4] : NULL;
851 ret = wimlib_open_wim(src_wimfile,
852 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w);
856 /* Determine if the destination is an existing file or not.
857 * If so, we try to append the exported image(s) to it; otherwise, we
858 * create a new WIM containing the exported image(s). */
859 if (stat(dest_wimfile, &stbuf) == 0) {
863 /* Destination file exists. */
864 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
865 imagex_error("`%s' is not a regular file",
870 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w);
874 ret = file_writable(dest_wimfile);
878 dest_ctype = wimlib_get_compression_type(dest_w);
879 if (compression_type_specified
880 && compression_type != dest_ctype)
882 imagex_error("Cannot specify a compression type that is "
883 "not the same as that used in the "
888 compression_type = dest_ctype;
891 /* dest_wimfile is not an existing file, so create a new WIM. */
892 if (!compression_type_specified)
893 compression_type = wimlib_get_compression_type(src_w);
894 if (errno == ENOENT) {
895 ret = wimlib_create_new_wim(compression_type, &dest_w);
899 imagex_error_with_errno("Cannot stat file `%s'",
906 image = wimlib_resolve_image(src_w, src_image_num_or_name);
907 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
912 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
914 &num_additional_swms);
919 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
920 export_flags, additional_swms,
921 num_additional_swms);
927 ret = wimlib_write(dest_w, dest_wimfile, WIM_ALL_IMAGES,
928 write_flags, num_threads);
930 ret = wimlib_overwrite(dest_w, write_flags, num_threads);
932 if (ret == WIMLIB_ERR_REOPEN)
936 if (additional_swms) {
937 for (unsigned i = 0; i < num_additional_swms; i++)
938 wimlib_free(additional_swms[i]);
939 free(additional_swms);
944 /* Prints information about a WIM file; also can mark an image as bootable,
945 * change the name of an image, or change the description of an image. */
946 static int imagex_info(int argc, const char **argv)
952 bool lookup_table = false;
954 bool metadata = false;
955 bool short_header = true;
956 const char *xml_out_file = NULL;
958 const char *image_num_or_name = "all";
959 const char *new_name = NULL;
960 const char *new_desc = NULL;
965 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
966 WIMLIB_OPEN_FLAG_SPLIT_OK;
970 for_opt(c, info_options) {
980 short_header = false;
984 short_header = false;
988 short_header = false;
991 xml_out_file = optarg;
992 short_header = false;
996 short_header = false;
1006 if (argc == 0 || argc > 4) {
1012 image_num_or_name = argv[1];
1022 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1024 ret = wimlib_open_wim(wimfile, open_flags, &w);
1028 part_number = wimlib_get_part_number(w, &total_parts);
1030 image = wimlib_resolve_image(w, image_num_or_name);
1031 if (image == WIM_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
1032 imagex_error("The image `%s' does not exist",
1035 imagex_error("If you would like to set the boot "
1036 "index to 0, specify image \"0\" with "
1037 "the --boot flag.");
1038 ret = WIMLIB_ERR_INVALID_IMAGE;
1042 if (image == WIM_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1044 imagex_error("Cannot specify the --boot flag "
1045 "without specifying a specific "
1046 "image in a multi-image WIM");
1047 ret = WIMLIB_ERR_INVALID_IMAGE;
1051 imagex_error("Cannot specify the NEW_NAME "
1052 "without specifying a specific "
1053 "image in a multi-image WIM");
1054 ret = WIMLIB_ERR_INVALID_IMAGE;
1059 /* Operations that print information are separated from operations that
1060 * recreate the WIM file. */
1061 if (!new_name && !boot) {
1063 /* Read-only operations */
1065 if (image == WIM_NO_IMAGE) {
1066 imagex_error("`%s' is not a valid image",
1068 ret = WIMLIB_ERR_INVALID_IMAGE;
1072 if (image == WIM_ALL_IMAGES && short_header)
1073 wimlib_print_wim_information(w);
1076 wimlib_print_header(w);
1079 if (total_parts != 1) {
1080 printf("Warning: Only showing the lookup table "
1081 "for part %d of a %d-part WIM.\n",
1082 part_number, total_parts);
1084 wimlib_print_lookup_table(w);
1088 ret = wimlib_extract_xml_data(w, stdout);
1094 fp = fopen(xml_out_file, "wb");
1096 imagex_error_with_errno("Failed to open the "
1102 ret = wimlib_extract_xml_data(w, fp);
1103 if (fclose(fp) != 0) {
1104 imagex_error("Failed to close the file `%s'",
1114 wimlib_print_available_images(w, image);
1117 ret = wimlib_print_metadata(w, image);
1123 /* Modification operations */
1124 if (total_parts != 1) {
1125 imagex_error("Modifying a split WIM is not supported.");
1128 if (image == WIM_ALL_IMAGES)
1131 if (image == WIM_NO_IMAGE && new_name) {
1132 imagex_error("Cannot specify new_name (`%s') when "
1133 "using image 0", new_name);
1138 if (image == wimlib_get_boot_idx(w)) {
1139 printf("Image %d is already marked as "
1140 "bootable.\n", image);
1143 printf("Marking image %d as bootable.\n",
1145 wimlib_set_boot_idx(w, image);
1149 if (strcmp(wimlib_get_image_name(w, image),
1151 printf("Image %d is already named \"%s\".\n",
1155 printf("Changing the name of image %d to "
1156 "\"%s\".\n", image, new_name);
1157 ret = wimlib_set_image_name(w, image, new_name);
1163 const char *old_desc;
1164 old_desc = wimlib_get_image_description(w, image);
1165 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1166 printf("The description of image %d is already "
1167 "\"%s\".\n", image, new_desc);
1170 printf("Changing the description of image %d "
1171 "to \"%s\".\n", image, new_desc);
1172 ret = wimlib_set_image_descripton(w, image,
1179 /* Only call wimlib_overwrite() if something actually needs to
1181 if (boot || new_name || new_desc ||
1182 check != wimlib_has_integrity_table(w)) {
1184 ret = file_writable(wimfile);
1190 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
1191 WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
1196 ret = wimlib_overwrite(w, write_flags, 1);
1197 if (ret == WIMLIB_ERR_REOPEN)
1200 printf("The file `%s' was not modified because nothing "
1201 "needed to be done.\n", wimfile);
1210 /* Join split WIMs into one part WIM */
1211 static int imagex_join(int argc, const char **argv)
1214 int flags = WIMLIB_OPEN_FLAG_SPLIT_OK | WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1215 const char *output_path;
1217 for_opt(c, join_options) {
1220 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1230 imagex_error("Must specify at least one split WIM (.swm) parts "
1234 output_path = argv[0];
1235 return wimlib_join(++argv, --argc, output_path, flags);
1241 /* Mounts an image using a FUSE mount. */
1242 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1245 int mount_flags = 0;
1246 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
1247 WIMLIB_OPEN_FLAG_SPLIT_OK;
1248 const char *wimfile;
1254 const char *swm_glob = NULL;
1255 WIMStruct **additional_swms = NULL;
1256 unsigned num_additional_swms = 0;
1258 if (strcmp(argv[0], "mountrw") == 0)
1259 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1261 for_opt(c, mount_options) {
1264 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1267 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1270 if (strcasecmp(optarg, "none") == 0)
1271 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1272 else if (strcasecmp(optarg, "xattr") == 0)
1273 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1274 else if (strcasecmp(optarg, "windows") == 0)
1275 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1277 imagex_error("Unknown stream interface \"%s\"", optarg);
1290 if (argc != 2 && argc != 3)
1295 ret = wimlib_open_wim(wimfile, open_flags, &w);
1300 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1302 &num_additional_swms);
1309 num_images = wimlib_get_num_images(w);
1310 if (num_images != 1) {
1311 imagex_error("The file `%s' contains %d images; Please "
1312 "select one.", wimfile, num_images);
1313 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1320 image = wimlib_resolve_image(w, argv[1]);
1322 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1327 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1328 ret = file_writable(wimfile);
1333 ret = wimlib_mount(w, image, dir, mount_flags, additional_swms,
1334 num_additional_swms);
1336 imagex_error("Failed to mount image %d from `%s' on `%s'",
1337 image, wimfile, dir);
1342 if (additional_swms) {
1343 for (unsigned i = 0; i < num_additional_swms; i++)
1344 wimlib_free(additional_swms[i]);
1345 free(additional_swms);
1349 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1354 static int imagex_optimize(int argc, const char **argv)
1357 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1358 int write_flags = WIMLIB_WRITE_FLAG_REBUILD |
1359 WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
1362 const char *wimfile;
1366 for_opt(c, optimize_options) {
1369 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1370 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1373 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1390 ret = wimlib_open_wim(wimfile, open_flags, &w);
1394 old_size = file_get_size(argv[0]);
1395 printf("`%s' original size: ", wimfile);
1399 printf("%"PRIu64" KiB\n", old_size >> 10);
1401 ret = wimlib_overwrite(w, write_flags, 0);
1403 new_size = file_get_size(argv[0]);
1404 printf("`%s' optimized size: ", wimfile);
1408 printf("%"PRIu64" KiB\n", new_size >> 10);
1410 fputs("Space saved: ", stdout);
1411 if (new_size != -1 && old_size != -1) {
1412 printf("%lld KiB\n",
1413 ((long long)old_size - (long long)new_size) >> 10);
1422 /* Split a WIM into a spanned set */
1423 static int imagex_split(int argc, const char **argv)
1426 int flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1427 unsigned long part_size;
1430 for_opt(c, split_options) {
1433 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1447 part_size = strtod(argv[2], &tmp) * (1 << 20);
1448 if (tmp == argv[2] || *tmp) {
1449 imagex_error("Invalid part size \"%s\"", argv[2]);
1450 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1453 return wimlib_split(argv[0], argv[1], part_size, flags);
1456 /* Unmounts an image. */
1457 static int imagex_unmount(int argc, const char **argv)
1460 int unmount_flags = 0;
1463 for_opt(c, unmount_options) {
1466 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1469 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1483 ret = wimlib_unmount(argv[0], unmount_flags);
1485 imagex_error("Failed to unmount `%s'", argv[0]);
1489 struct imagex_command {
1491 int (*func)(int , const char **);
1496 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1497 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1499 static const struct imagex_command imagex_commands[] = {
1500 {"append", imagex_capture_or_append, APPEND},
1501 {"apply", imagex_apply, APPLY},
1502 {"capture", imagex_capture_or_append, CAPTURE},
1503 {"delete", imagex_delete, DELETE},
1504 {"dir", imagex_dir, DIR},
1505 {"export", imagex_export, EXPORT},
1506 {"info", imagex_info, INFO},
1507 {"join", imagex_join, JOIN},
1508 {"mount", imagex_mount_rw_or_ro, MOUNT},
1509 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1510 {"optimize",imagex_optimize, OPTIMIZE},
1511 {"split", imagex_split, SPLIT},
1512 {"unmount", imagex_unmount, UNMOUNT},
1515 static void version()
1517 static const char *s =
1518 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1519 "Copyright (C) 2012 Eric Biggers\n"
1520 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1521 "This is free software: you are free to change and redistribute it.\n"
1522 "There is NO WARRANTY, to the extent permitted by law.\n"
1524 "Report bugs to "PACKAGE_BUGREPORT".\n";
1529 static void help_or_version(int argc, const char **argv)
1533 const struct imagex_command *cmd;
1535 for (i = 1; i < argc; i++) {
1543 if (strcmp(p, "help") == 0) {
1544 for_imagex_command(cmd) {
1545 if (strcmp(cmd->name, argv[1]) == 0) {
1553 if (strcmp(p, "version") == 0) {
1561 static void usage(int cmd_type)
1563 const struct imagex_command *cmd;
1564 printf("Usage: %s", usage_strings[cmd_type]);
1565 for_imagex_command(cmd) {
1566 if (cmd->cmd == cmd_type)
1567 printf("\nTry `man imagex-%s' for more details.\n",
1572 static void usage_all()
1574 puts("IMAGEX: Usage:");
1575 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1576 printf(" %s", usage_strings[i]);
1577 static const char *extra =
1579 " imagex --version\n"
1581 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1583 " Try `man imagex' for more information.\n"
1585 fputs(extra, stdout);
1589 int main(int argc, const char **argv)
1591 const struct imagex_command *cmd;
1595 imagex_error("No command specified");
1600 help_or_version(argc, argv);
1604 wimlib_set_print_errors(true);
1606 for_imagex_command(cmd) {
1607 if (strcmp(cmd->name, *argv) == 0) {
1608 ret = cmd->func(argc, argv);
1610 imagex_error("Exiting with error code %d:\n"
1612 wimlib_get_error_string(ret));
1613 if (ret == WIMLIB_ERR_NTFS_3G)
1614 imagex_error_with_errno("errno");
1620 imagex_error("Unrecognized command: `%s'", argv[0]);