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]\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]\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'},
140 static const struct option export_options[] = {
141 {"boot", no_argument, NULL, 'b'},
142 {"check", no_argument, NULL, 'c'},
143 {"compress", required_argument, NULL, 'x'},
144 {"ref", required_argument, NULL, 'r'},
145 {"threads", required_argument, NULL, 't'},
146 {"rebuild", no_argument, NULL, 'R'},
150 static const struct option info_options[] = {
151 {"boot", no_argument, NULL, 'b'},
152 {"check", no_argument, NULL, 'c'},
153 {"extract-xml", required_argument, NULL, 'X'},
154 {"header", no_argument, NULL, 'h'},
155 {"lookup-table", no_argument, NULL, 'l'},
156 {"metadata", no_argument, NULL, 'm'},
157 {"xml", no_argument, NULL, 'x'},
161 static const struct option join_options[] = {
162 {"check", no_argument, NULL, 'c'},
166 static const struct option mount_options[] = {
167 {"check", no_argument, NULL, 'c'},
168 {"debug", no_argument, NULL, 'd'},
169 {"streams-interface", required_argument, NULL, 's'},
170 {"ref", required_argument, NULL, 'r'},
174 static const struct option optimize_options[] = {
175 {"check", no_argument, NULL, 'c'},
179 static const struct option split_options[] = {
180 {"check", no_argument, NULL, 'c'},
184 static const struct option unmount_options[] = {
185 {"commit", no_argument, NULL, 'c'},
186 {"check", no_argument, NULL, 'C'},
192 /* Print formatted error message to stderr. */
193 static void imagex_error(const char *format, ...)
196 va_start(va, format);
197 fputs("ERROR: ", stderr);
198 vfprintf(stderr, format, va);
203 /* Print formatted error message to stderr. */
204 static void imagex_error_with_errno(const char *format, ...)
206 int errno_save = errno;
208 va_start(va, format);
209 fputs("ERROR: ", stderr);
210 vfprintf(stderr, format, va);
211 fprintf(stderr, ": %s\n", strerror(errno_save));
215 static int verify_image_exists(int image, const char *image_name,
216 const char *wim_name)
218 if (image == WIM_NO_IMAGE) {
219 imagex_error("\"%s\" is not a valid image in `%s'!\n"
220 " Please specify a 1-based imagex index or "
222 " You may use `imagex info' to list the images "
223 "contained in a WIM.",
224 image_name, wim_name);
230 static int verify_image_is_single(int image)
232 if (image == WIM_ALL_IMAGES) {
233 imagex_error("Cannot specify all images for this action!");
239 static int verify_image_exists_and_is_single(int image, const char *image_name,
240 const char *wim_name)
243 ret = verify_image_exists(image, image_name, wim_name);
245 ret = verify_image_is_single(image);
249 static int get_compression_type(const char *optarg)
251 if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
252 return WIM_COMPRESSION_TYPE_LZX;
253 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
254 return WIM_COMPRESSION_TYPE_XPRESS;
255 else if (strcasecmp(optarg, "none") == 0)
256 return WIM_COMPRESSION_TYPE_NONE;
258 imagex_error("Invalid compression type `%s'! Must be "
259 "\"maximum\", \"fast\", or \"none\".", optarg);
260 return WIM_COMPRESSION_TYPE_INVALID;
264 static off_t file_get_size(const char *filename)
267 if (stat(filename, &st) == 0)
273 static char *file_get_contents(const char *filename, size_t *len_ret)
280 if (stat(filename, &stbuf) != 0) {
281 imagex_error_with_errno("Failed to stat the file `%s'", filename);
286 fp = fopen(filename, "rb");
288 imagex_error_with_errno("Failed to open the file `%s'", filename);
294 imagex_error("Failed to allocate buffer of %zu bytes to hold "
295 "contents of file `%s'", len, filename);
298 if (fread(buf, 1, len, fp) != len) {
299 imagex_error_with_errno("Failed to read %lu bytes from the "
300 "file `%s'", len, filename);
312 static int file_writable(const char *path)
315 ret = access(path, F_OK | W_OK);
317 imagex_error_with_errno("Can't modify `%s'", path);
321 static int open_swms_from_glob(const char *swm_glob,
322 const char *first_part,
324 WIMStruct ***additional_swms_ret,
325 unsigned *num_additional_swms_ret)
327 unsigned num_additional_swms = 0;
328 WIMStruct **additional_swms = NULL;
332 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
334 if (ret == GLOB_NOMATCH) {
335 imagex_error("Found no files for glob \"%s\"",
338 imagex_error_with_errno("Failed to process glob "
344 num_additional_swms = globbuf.gl_pathc;
345 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
346 if (!additional_swms) {
347 imagex_error("Out of memory");
352 for (unsigned i = 0; i < num_additional_swms; i++) {
353 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
357 ret = wimlib_open_wim(globbuf.gl_pathv[i],
358 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
359 &additional_swms[i - offset]);
363 *additional_swms_ret = additional_swms;
364 *num_additional_swms_ret = num_additional_swms - offset;
368 for (unsigned i = 0; i < num_additional_swms; i++)
369 wimlib_free(additional_swms[i]);
370 free(additional_swms);
378 static unsigned parse_num_threads(const char *optarg)
381 unsigned nthreads = strtoul(optarg, &tmp, 10);
382 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
383 imagex_error("Number of threads must be a non-negative integer!");
391 /* Extract one image, or all images, from a WIM file into a directory. */
392 static int imagex_apply(int argc, const char **argv)
395 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
396 WIMLIB_OPEN_FLAG_SPLIT_OK;
403 const char *image_num_or_name;
404 int extract_flags = 0;
406 const char *swm_glob = NULL;
407 WIMStruct **additional_swms = NULL;
408 unsigned num_additional_swms = 0;
410 for_opt(c, apply_options) {
413 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
416 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
419 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
422 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
434 if (argc != 2 && argc != 3) {
441 image_num_or_name = "1";
444 image_num_or_name = argv[1];
448 ret = wimlib_open_wim(wimfile, open_flags, &w);
452 image = wimlib_resolve_image(w, image_num_or_name);
453 ret = verify_image_exists(image, image_num_or_name, wimfile);
457 num_images = wimlib_get_num_images(w);
458 if (argc == 2 && num_images != 1) {
459 imagex_error("`%s' contains %d images; Please select one "
460 "(or all)", wimfile, num_images);
467 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
469 &num_additional_swms);
477 ret = stat(dir, &stbuf);
479 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
480 const char *ntfs_device = dir;
481 printf("Applying image %d of `%s' to NTFS filesystem on `%s'\n",
482 image, wimfile, ntfs_device);
483 ret = wimlib_apply_image_to_ntfs_volume(w, image,
487 num_additional_swms);
491 if (errno != ENOENT) {
492 imagex_error_with_errno("Failed to stat `%s'", dir);
499 ret = wimlib_extract_image(w, image, dir, extract_flags,
500 additional_swms, num_additional_swms);
503 if (additional_swms) {
504 for (unsigned i = 0; i < num_additional_swms; i++)
505 wimlib_free(additional_swms[i]);
506 free(additional_swms);
511 static int imagex_capture_or_append(int argc, const char **argv)
514 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
515 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS;
516 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
517 int compression_type = WIM_COMPRESSION_TYPE_XPRESS;
522 const char *flags_element = NULL;
523 const char *config_file = NULL;
524 char *config_str = NULL;
525 size_t config_len = 0;
530 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
531 unsigned num_threads = 0;
533 for_opt(c, capture_or_append_options) {
536 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
539 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
540 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
543 config_file = optarg;
546 compression_type = get_compression_type(optarg);
547 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
551 flags_element = optarg;
554 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
557 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
558 write_flags |= WIMLIB_WRITE_FLAG_VERBOSE;
561 num_threads = parse_num_threads(optarg);
562 if (num_threads == UINT_MAX)
566 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
575 if (argc < 2 || argc > 4) {
582 char dir_copy[strlen(dir) + 1];
583 memcpy(dir_copy, dir, strlen(dir) + 1);
584 default_name = basename(dir_copy);
586 name = (argc >= 3) ? argv[2] : default_name;
587 desc = (argc >= 4) ? argv[3] : NULL;
590 config_str = file_get_contents(config_file, &config_len);
596 ret = wimlib_open_wim(wimfile, open_flags, &w);
598 ret = wimlib_create_new_wim(compression_type, &w);
605 ret = stat(dir, &stbuf);
607 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
608 const char *ntfs_device = dir;
609 printf("Capturing WIM image NTFS filesystem on `%s'\n",
611 ret = wimlib_add_image_from_ntfs_volume(w, ntfs_device,
619 if (errno != ENOENT) {
620 imagex_error_with_errno("Failed to stat `%s'", dir);
626 ret = wimlib_add_image(w, dir, name, config_str, config_len,
632 cur_image = wimlib_get_num_images(w);
634 ret = wimlib_set_image_descripton(w, cur_image, desc);
639 ret = wimlib_set_image_flags(w, cur_image, flags_element);
644 ret = wimlib_overwrite(w, write_flags, num_threads);
646 ret = wimlib_write(w, wimfile, WIM_ALL_IMAGES, write_flags,
649 if (ret == WIMLIB_ERR_REOPEN)
652 imagex_error("Failed to write the WIM file `%s'", wimfile);
659 /* Remove image(s) from a WIM. */
660 static int imagex_delete(int argc, const char **argv)
663 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
664 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
666 const char *image_num_or_name;
671 for_opt(c, delete_options) {
674 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
675 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
687 imagex_error("Must specify a WIM file");
689 imagex_error("Must specify an image");
694 image_num_or_name = argv[1];
696 ret = file_writable(wimfile);
700 ret = wimlib_open_wim(wimfile, open_flags, &w);
704 image = wimlib_resolve_image(w, image_num_or_name);
706 ret = verify_image_exists(image, image_num_or_name, wimfile);
710 ret = wimlib_delete_image(w, image);
712 imagex_error("Failed to delete image from `%s'", wimfile);
716 ret = wimlib_overwrite(w, write_flags, 0);
717 if (ret == WIMLIB_ERR_REOPEN)
720 imagex_error("Failed to write the file `%s' with image "
728 /* Print the files contained in an image(s) in a WIM file. */
729 static int imagex_dir(int argc, const char **argv)
738 imagex_error("Must specify a WIM file");
743 imagex_error("Too many arguments");
749 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w);
754 image = wimlib_resolve_image(w, argv[2]);
755 ret = verify_image_exists(image, argv[2], wimfile);
759 /* Image was not specified. If the WIM only contains one image,
760 * choose that one; otherwise, print an error. */
761 num_images = wimlib_get_num_images(w);
762 if (num_images != 1) {
763 imagex_error("The file `%s' contains %d images; Please "
764 "select one.", wimfile, num_images);
772 ret = wimlib_print_files(w, image);
778 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
780 static int imagex_export(int argc, const char **argv)
783 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
784 int export_flags = 0;
785 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
786 int compression_type;
787 bool compression_type_specified = false;
788 const char *src_wimfile;
789 const char *src_image_num_or_name;
790 const char *dest_wimfile;
791 const char *dest_name;
792 const char *dest_desc;
793 WIMStruct *src_w = NULL;
794 WIMStruct *dest_w = NULL;
799 const char *swm_glob = NULL;
800 WIMStruct **additional_swms = NULL;
801 unsigned num_additional_swms = 0;
802 unsigned num_threads = 0;
804 for_opt(c, export_options) {
807 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
810 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
811 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
814 compression_type = get_compression_type(optarg);
815 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
817 compression_type_specified = true;
823 num_threads = parse_num_threads(optarg);
824 if (num_threads == UINT_MAX)
828 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
837 if (argc < 3 || argc > 5) {
841 src_wimfile = argv[0];
842 src_image_num_or_name = argv[1];
843 dest_wimfile = argv[2];
844 dest_name = (argc >= 4) ? argv[3] : NULL;
845 dest_desc = (argc >= 5) ? argv[4] : NULL;
846 ret = wimlib_open_wim(src_wimfile,
847 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w);
851 /* Determine if the destination is an existing file or not.
852 * If so, we try to append the exported image(s) to it; otherwise, we
853 * create a new WIM containing the exported image(s). */
854 if (stat(dest_wimfile, &stbuf) == 0) {
858 /* Destination file exists. */
859 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
860 imagex_error("`%s' is not a regular file",
865 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w);
869 ret = file_writable(dest_wimfile);
873 dest_ctype = wimlib_get_compression_type(dest_w);
874 if (compression_type_specified
875 && compression_type != dest_ctype)
877 imagex_error("Cannot specify a compression type that is "
878 "not the same as that used in the "
883 compression_type = dest_ctype;
886 /* dest_wimfile is not an existing file, so create a new WIM. */
887 if (!compression_type_specified)
888 compression_type = wimlib_get_compression_type(src_w);
889 if (errno == ENOENT) {
890 ret = wimlib_create_new_wim(compression_type, &dest_w);
894 imagex_error_with_errno("Cannot stat file `%s'",
901 image = wimlib_resolve_image(src_w, src_image_num_or_name);
902 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
907 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
909 &num_additional_swms);
914 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
915 export_flags, additional_swms,
916 num_additional_swms);
922 ret = wimlib_write(dest_w, dest_wimfile, WIM_ALL_IMAGES,
923 write_flags, num_threads);
925 ret = wimlib_overwrite(dest_w, write_flags, num_threads);
927 if (ret == WIMLIB_ERR_REOPEN)
931 if (additional_swms) {
932 for (unsigned i = 0; i < num_additional_swms; i++)
933 wimlib_free(additional_swms[i]);
934 free(additional_swms);
939 /* Prints information about a WIM file; also can mark an image as bootable,
940 * change the name of an image, or change the description of an image. */
941 static int imagex_info(int argc, const char **argv)
947 bool lookup_table = false;
949 bool metadata = false;
950 bool short_header = true;
951 const char *xml_out_file = NULL;
953 const char *image_num_or_name = "all";
954 const char *new_name = NULL;
955 const char *new_desc = NULL;
960 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
961 WIMLIB_OPEN_FLAG_SPLIT_OK;
965 for_opt(c, info_options) {
975 short_header = false;
979 short_header = false;
983 short_header = false;
986 xml_out_file = optarg;
987 short_header = false;
991 short_header = false;
1001 if (argc == 0 || argc > 4) {
1007 image_num_or_name = argv[1];
1017 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1019 ret = wimlib_open_wim(wimfile, open_flags, &w);
1023 part_number = wimlib_get_part_number(w, &total_parts);
1025 image = wimlib_resolve_image(w, image_num_or_name);
1026 if (image == WIM_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
1027 imagex_error("The image `%s' does not exist",
1030 imagex_error("If you would like to set the boot "
1031 "index to 0, specify image \"0\" with "
1032 "the --boot flag.");
1033 ret = WIMLIB_ERR_INVALID_IMAGE;
1037 if (image == WIM_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1039 imagex_error("Cannot specify the --boot flag "
1040 "without specifying a specific "
1041 "image in a multi-image WIM");
1042 ret = WIMLIB_ERR_INVALID_IMAGE;
1046 imagex_error("Cannot specify the NEW_NAME "
1047 "without specifying a specific "
1048 "image in a multi-image WIM");
1049 ret = WIMLIB_ERR_INVALID_IMAGE;
1054 /* Operations that print information are separated from operations that
1055 * recreate the WIM file. */
1056 if (!new_name && !boot) {
1058 /* Read-only operations */
1060 if (image == WIM_NO_IMAGE) {
1061 imagex_error("`%s' is not a valid image",
1063 ret = WIMLIB_ERR_INVALID_IMAGE;
1067 if (image == WIM_ALL_IMAGES && short_header)
1068 wimlib_print_wim_information(w);
1071 wimlib_print_header(w);
1074 if (total_parts != 1) {
1075 printf("Warning: Only showing the lookup table "
1076 "for part %d of a %d-part WIM.\n",
1077 part_number, total_parts);
1079 wimlib_print_lookup_table(w);
1083 ret = wimlib_extract_xml_data(w, stdout);
1089 fp = fopen(xml_out_file, "wb");
1091 imagex_error_with_errno("Failed to open the "
1097 ret = wimlib_extract_xml_data(w, fp);
1098 if (fclose(fp) != 0) {
1099 imagex_error("Failed to close the file `%s'",
1109 wimlib_print_available_images(w, image);
1112 ret = wimlib_print_metadata(w, image);
1118 /* Modification operations */
1119 if (total_parts != 1) {
1120 imagex_error("Modifying a split WIM is not supported.");
1123 if (image == WIM_ALL_IMAGES)
1126 if (image == WIM_NO_IMAGE && new_name) {
1127 imagex_error("Cannot specify new_name (`%s') when "
1128 "using image 0", new_name);
1133 if (image == wimlib_get_boot_idx(w)) {
1134 printf("Image %d is already marked as "
1135 "bootable.\n", image);
1138 printf("Marking image %d as bootable.\n",
1140 wimlib_set_boot_idx(w, image);
1144 if (strcmp(wimlib_get_image_name(w, image),
1146 printf("Image %d is already named \"%s\".\n",
1150 printf("Changing the name of image %d to "
1151 "\"%s\".\n", image, new_name);
1152 ret = wimlib_set_image_name(w, image, new_name);
1158 const char *old_desc;
1159 old_desc = wimlib_get_image_description(w, image);
1160 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1161 printf("The description of image %d is already "
1162 "\"%s\".\n", image, new_desc);
1165 printf("Changing the description of image %d "
1166 "to \"%s\".\n", image, new_desc);
1167 ret = wimlib_set_image_descripton(w, image,
1174 /* Only call wimlib_overwrite() if something actually needs to
1176 if (boot || new_name || new_desc ||
1177 check != wimlib_has_integrity_table(w)) {
1179 ret = file_writable(wimfile);
1185 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
1186 WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
1191 ret = wimlib_overwrite(w, write_flags, 1);
1192 if (ret == WIMLIB_ERR_REOPEN)
1195 printf("The file `%s' was not modified because nothing "
1196 "needed to be done.\n", wimfile);
1205 /* Join split WIMs into one part WIM */
1206 static int imagex_join(int argc, const char **argv)
1209 int flags = WIMLIB_OPEN_FLAG_SPLIT_OK | WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1210 const char *output_path;
1212 for_opt(c, join_options) {
1215 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1225 imagex_error("Must specify at least one split WIM (.swm) parts "
1229 output_path = argv[0];
1230 return wimlib_join(++argv, --argc, output_path, flags);
1236 /* Mounts an image using a FUSE mount. */
1237 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1240 int mount_flags = 0;
1241 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
1242 WIMLIB_OPEN_FLAG_SPLIT_OK;
1243 const char *wimfile;
1249 const char *swm_glob = NULL;
1250 WIMStruct **additional_swms = NULL;
1251 unsigned num_additional_swms = 0;
1253 if (strcmp(argv[0], "mountrw") == 0)
1254 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1256 for_opt(c, mount_options) {
1259 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1262 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1265 if (strcasecmp(optarg, "none") == 0)
1266 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1267 else if (strcasecmp(optarg, "xattr") == 0)
1268 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1269 else if (strcasecmp(optarg, "windows") == 0)
1270 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1272 imagex_error("Unknown stream interface \"%s\"", optarg);
1285 if (argc != 2 && argc != 3)
1290 ret = wimlib_open_wim(wimfile, open_flags, &w);
1295 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1297 &num_additional_swms);
1304 num_images = wimlib_get_num_images(w);
1305 if (num_images != 1) {
1306 imagex_error("The file `%s' contains %d images; Please "
1307 "select one.", wimfile, num_images);
1308 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1315 image = wimlib_resolve_image(w, argv[1]);
1317 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1322 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1323 ret = file_writable(wimfile);
1328 ret = wimlib_mount(w, image, dir, mount_flags, additional_swms,
1329 num_additional_swms);
1331 imagex_error("Failed to mount image %d from `%s' on `%s'",
1332 image, wimfile, dir);
1337 if (additional_swms) {
1338 for (unsigned i = 0; i < num_additional_swms; i++)
1339 wimlib_free(additional_swms[i]);
1340 free(additional_swms);
1344 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1349 static int imagex_optimize(int argc, const char **argv)
1352 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1353 int write_flags = WIMLIB_WRITE_FLAG_REBUILD |
1354 WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
1357 const char *wimfile;
1361 for_opt(c, optimize_options) {
1364 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1365 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1382 ret = wimlib_open_wim(wimfile, open_flags, &w);
1386 old_size = file_get_size(argv[0]);
1387 printf("`%s' original size: ", wimfile);
1391 printf("%"PRIu64" KiB\n", old_size >> 10);
1393 ret = wimlib_overwrite(w, write_flags, 0);
1395 new_size = file_get_size(argv[0]);
1396 printf("`%s' optimized size: ", wimfile);
1400 printf("%"PRIu64" KiB\n", new_size >> 10);
1402 fputs("Space saved: ", stdout);
1403 if (new_size != -1 && old_size != -1) {
1404 printf("%lld KiB\n",
1405 ((long long)old_size - (long long)new_size) >> 10);
1414 /* Split a WIM into a spanned set */
1415 static int imagex_split(int argc, const char **argv)
1418 int flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1419 unsigned long part_size;
1422 for_opt(c, split_options) {
1425 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1439 part_size = strtod(argv[2], &tmp) * (1 << 20);
1440 if (tmp == argv[2] || *tmp) {
1441 imagex_error("Invalid part size \"%s\"", argv[2]);
1442 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1445 return wimlib_split(argv[0], argv[1], part_size, flags);
1448 /* Unmounts an image. */
1449 static int imagex_unmount(int argc, const char **argv)
1452 int unmount_flags = 0;
1455 for_opt(c, unmount_options) {
1458 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1461 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1475 ret = wimlib_unmount(argv[0], unmount_flags);
1477 imagex_error("Failed to unmount `%s'", argv[0]);
1481 struct imagex_command {
1483 int (*func)(int , const char **);
1488 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1489 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1491 static const struct imagex_command imagex_commands[] = {
1492 {"append", imagex_capture_or_append, APPEND},
1493 {"apply", imagex_apply, APPLY},
1494 {"capture", imagex_capture_or_append, CAPTURE},
1495 {"delete", imagex_delete, DELETE},
1496 {"dir", imagex_dir, DIR},
1497 {"export", imagex_export, EXPORT},
1498 {"info", imagex_info, INFO},
1499 {"join", imagex_join, JOIN},
1500 {"mount", imagex_mount_rw_or_ro, MOUNT},
1501 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1502 {"optimize",imagex_optimize, OPTIMIZE},
1503 {"split", imagex_split, SPLIT},
1504 {"unmount", imagex_unmount, UNMOUNT},
1507 static void version()
1509 static const char *s =
1510 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1511 "Copyright (C) 2012 Eric Biggers\n"
1512 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1513 "This is free software: you are free to change and redistribute it.\n"
1514 "There is NO WARRANTY, to the extent permitted by law.\n"
1516 "Report bugs to "PACKAGE_BUGREPORT".\n";
1521 static void help_or_version(int argc, const char **argv)
1525 const struct imagex_command *cmd;
1527 for (i = 1; i < argc; i++) {
1535 if (strcmp(p, "help") == 0) {
1536 for_imagex_command(cmd) {
1537 if (strcmp(cmd->name, argv[1]) == 0) {
1545 if (strcmp(p, "version") == 0) {
1553 static void usage(int cmd_type)
1555 const struct imagex_command *cmd;
1556 printf("Usage: %s", usage_strings[cmd_type]);
1557 for_imagex_command(cmd) {
1558 if (cmd->cmd == cmd_type)
1559 printf("\nTry `man imagex-%s' for more details.\n",
1564 static void usage_all()
1566 puts("IMAGEX: Usage:");
1567 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1568 printf(" %s", usage_strings[i]);
1569 static const char *extra =
1571 " imagex --version\n"
1573 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1575 " Try `man imagex' for more information.\n"
1577 fputs(extra, stdout);
1581 int main(int argc, const char **argv)
1583 const struct imagex_command *cmd;
1587 imagex_error("No command specified");
1592 help_or_version(argc, argv);
1596 wimlib_set_print_errors(true);
1598 for_imagex_command(cmd) {
1599 if (strcmp(cmd->name, *argv) == 0) {
1600 ret = cmd->func(argc, argv);
1602 imagex_error("Exiting with error code %d:\n"
1604 wimlib_get_error_string(ret));
1605 if (ret == WIMLIB_ERR_NTFS_3G)
1606 imagex_error_with_errno("errno");
1612 imagex_error("Unrecognized command: `%s'", argv[0]);