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/>.
38 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
40 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (char**)argv, "", \
59 static void usage(int cmd_type);
60 static void usage_all();
62 static const char *usage_strings[] = {
64 "imagex append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
65 " [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
66 " [--verbose] [--dereference] [--config=FILE]\n"
67 " [--threads=NUM_THREADS]\n",
69 "imagex apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
70 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
71 " [--symlink] [--verbose] [--ref=\"GLOB\"]\n",
73 "imagex capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
74 " [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
75 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
76 " [--config=FILE] [--threads=NUM_THREADS]\n",
78 "imagex delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check]\n",
80 "imagex dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
82 "imagex export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
83 " DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
84 " [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
85 " [--threads=NUM_THREADS]\n",
87 "imagex info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
88 " [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
89 " [--xml] [--extract-xml FILE] [--metadata]\n",
91 "imagex join [--check] WIMFILE SPLIT_WIM...\n",
93 "imagex mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
94 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
95 " [--ref=\"GLOB\"]\n",
97 "imagex mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
98 " [--check] [--debug] [--streams-interface=INTERFACE]\n",
100 "imagex split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
102 "imagex unmount DIRECTORY [--commit] [--check]\n",
105 static const struct option common_options[] = {
106 {"help", 0, NULL, 'h'},
107 {"version", 0, NULL, 'v'},
111 static const struct option apply_options[] = {
112 {"check", no_argument, NULL, 'c'},
113 {"hardlink", no_argument, NULL, 'h'},
114 {"symlink", no_argument, NULL, 's'},
115 {"verbose", no_argument, NULL, 'v'},
116 {"ref", required_argument, NULL, 'r'},
119 static const struct option capture_or_append_options[] = {
120 {"boot", no_argument, NULL, 'b'},
121 {"check", no_argument, NULL, 'c'},
122 {"compress", required_argument, NULL, 'x'},
123 {"config", required_argument, NULL, 'C'},
124 {"dereference", no_argument, NULL, 'L'},
125 {"flags", required_argument, NULL, 'f'},
126 {"verbose", no_argument, NULL, 'v'},
127 {"threads", required_argument, NULL, 't'},
130 static const struct option delete_options[] = {
131 {"check", no_argument, NULL, 'c'},
135 static const struct option export_options[] = {
136 {"boot", no_argument, NULL, 'b'},
137 {"check", no_argument, NULL, 'c'},
138 {"compress", required_argument, NULL, 'x'},
139 {"ref", required_argument, NULL, 'r'},
140 {"threads", required_argument, NULL, 't'},
144 static const struct option info_options[] = {
145 {"boot", no_argument, NULL, 'b'},
146 {"check", no_argument, NULL, 'c'},
147 {"extract-xml", required_argument, NULL, 'X'},
148 {"header", no_argument, NULL, 'h'},
149 {"lookup-table", no_argument, NULL, 'l'},
150 {"metadata", no_argument, NULL, 'm'},
151 {"xml", no_argument, NULL, 'x'},
155 static const struct option join_options[] = {
156 {"check", no_argument, NULL, 'c'},
160 static const struct option mount_options[] = {
161 {"check", no_argument, NULL, 'c'},
162 {"debug", no_argument, NULL, 'd'},
163 {"streams-interface", required_argument, NULL, 's'},
164 {"ref", required_argument, NULL, 'r'},
168 static const struct option split_options[] = {
169 {"check", no_argument, NULL, 'c'},
173 static const struct option unmount_options[] = {
174 {"commit", no_argument, NULL, 'c'},
175 {"check", no_argument, NULL, 'C'},
181 /* Print formatted error message to stderr. */
182 static void imagex_error(const char *format, ...)
185 va_start(va, format);
186 fputs("ERROR: ", stderr);
187 vfprintf(stderr, format, va);
192 /* Print formatted error message to stderr. */
193 static void imagex_error_with_errno(const char *format, ...)
195 int errno_save = errno;
197 va_start(va, format);
198 fputs("ERROR: ", stderr);
199 vfprintf(stderr, format, va);
200 fprintf(stderr, ": %s\n", strerror(errno_save));
204 static int verify_image_exists(int image, const char *image_name,
205 const char *wim_name)
207 if (image == WIM_NO_IMAGE) {
208 imagex_error("\"%s\" is not a valid image in `%s'!\n"
209 " Please specify a 1-based imagex index or "
211 " You may use `imagex info' to list the images "
212 "contained in a WIM.",
213 image_name, wim_name);
219 static int verify_image_is_single(int image)
221 if (image == WIM_ALL_IMAGES) {
222 imagex_error("Cannot specify all images for this action!");
228 static int verify_image_exists_and_is_single(int image, const char *image_name,
229 const char *wim_name)
232 ret = verify_image_exists(image, image_name, wim_name);
234 ret = verify_image_is_single(image);
238 static int get_compression_type(const char *optarg)
240 if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
241 return WIM_COMPRESSION_TYPE_LZX;
242 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
243 return WIM_COMPRESSION_TYPE_XPRESS;
244 else if (strcasecmp(optarg, "none") == 0)
245 return WIM_COMPRESSION_TYPE_NONE;
247 imagex_error("Invalid compression type `%s'! Must be "
248 "\"maximum\", \"fast\", or \"none\".", optarg);
249 return WIM_COMPRESSION_TYPE_INVALID;
253 static char *file_get_contents(const char *filename, size_t *len_ret)
260 if (stat(filename, &stbuf) != 0) {
261 imagex_error_with_errno("Failed to stat the file `%s'", filename);
266 fp = fopen(filename, "rb");
268 imagex_error_with_errno("Failed to open the file `%s'", filename);
274 imagex_error("Failed to allocate buffer of %zu bytes to hold "
275 "contents of file `%s'", len, filename);
278 if (fread(buf, 1, len, fp) != len) {
279 imagex_error_with_errno("Failed to read %lu bytes from the "
280 "file `%s'", len, filename);
292 static int file_writable(const char *path)
295 ret = access(path, F_OK | W_OK);
297 imagex_error_with_errno("Can't modify `%s'", path);
301 static int open_swms_from_glob(const char *swm_glob,
302 const char *first_part,
304 WIMStruct ***additional_swms_ret,
305 unsigned *num_additional_swms_ret)
307 unsigned num_additional_swms = 0;
308 WIMStruct **additional_swms = NULL;
312 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
314 if (ret == GLOB_NOMATCH) {
315 imagex_error("Found no files for glob \"%s\"",
318 imagex_error_with_errno("Failed to process glob "
324 num_additional_swms = globbuf.gl_pathc;
325 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
326 if (!additional_swms) {
327 imagex_error("Out of memory");
332 for (unsigned i = 0; i < num_additional_swms; i++) {
333 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
337 ret = wimlib_open_wim(globbuf.gl_pathv[i],
338 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
339 &additional_swms[i - offset]);
343 *additional_swms_ret = additional_swms;
344 *num_additional_swms_ret = num_additional_swms - offset;
348 for (unsigned i = 0; i < num_additional_swms; i++)
349 wimlib_free(additional_swms[i]);
350 free(additional_swms);
358 static unsigned parse_num_threads(const char *optarg)
361 unsigned nthreads = strtoul(optarg, &tmp, 10);
362 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
363 imagex_error("Number of threads must be a non-negative integer!");
371 /* Extract one image, or all images, from a WIM file into a directory. */
372 static int imagex_apply(int argc, const char **argv)
375 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
376 WIMLIB_OPEN_FLAG_SPLIT_OK;
383 const char *image_num_or_name;
384 int extract_flags = 0;
386 const char *swm_glob = NULL;
387 WIMStruct **additional_swms = NULL;
388 unsigned num_additional_swms = 0;
390 for_opt(c, apply_options) {
393 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
396 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
399 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
402 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
414 if (argc != 2 && argc != 3) {
421 image_num_or_name = "1";
424 image_num_or_name = argv[1];
428 ret = wimlib_open_wim(wimfile, open_flags, &w);
432 image = wimlib_resolve_image(w, image_num_or_name);
433 ret = verify_image_exists(image, image_num_or_name, wimfile);
437 num_images = wimlib_get_num_images(w);
438 if (argc == 2 && num_images != 1) {
439 imagex_error("`%s' contains %d images; Please select one "
440 "(or all)", wimfile, num_images);
447 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
449 &num_additional_swms);
457 ret = stat(dir, &stbuf);
459 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
460 const char *ntfs_device = dir;
461 printf("Applying image %d of `%s' to NTFS filesystem on `%s'\n",
462 image, wimfile, ntfs_device);
463 ret = wimlib_apply_image_to_ntfs_volume(w, image,
467 num_additional_swms);
471 if (errno != ENOENT) {
472 imagex_error_with_errno("Failed to stat `%s'", dir);
479 ret = wimlib_extract_image(w, image, dir, extract_flags,
480 additional_swms, num_additional_swms);
483 if (additional_swms) {
484 for (unsigned i = 0; i < num_additional_swms; i++)
485 wimlib_free(additional_swms[i]);
486 free(additional_swms);
491 static int imagex_capture_or_append(int argc, const char **argv)
494 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
495 int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS;
496 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
497 int compression_type = WIM_COMPRESSION_TYPE_XPRESS;
502 const char *flags_element = NULL;
503 const char *config_file = NULL;
504 char *config_str = NULL;
505 size_t config_len = 0;
510 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
511 unsigned num_threads = 0;
513 for_opt(c, capture_or_append_options) {
516 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
519 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
520 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
523 config_file = optarg;
526 compression_type = get_compression_type(optarg);
527 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
531 flags_element = optarg;
534 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
537 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
538 write_flags |= WIMLIB_WRITE_FLAG_VERBOSE;
541 num_threads = parse_num_threads(optarg);
542 if (num_threads == UINT_MAX)
552 if (argc < 2 || argc > 4) {
559 char dir_copy[strlen(dir) + 1];
560 memcpy(dir_copy, dir, strlen(dir) + 1);
561 default_name = basename(dir_copy);
563 name = (argc >= 3) ? argv[2] : default_name;
564 desc = (argc >= 4) ? argv[3] : NULL;
567 config_str = file_get_contents(config_file, &config_len);
573 ret = wimlib_open_wim(wimfile, open_flags, &w);
575 ret = wimlib_create_new_wim(compression_type, &w);
582 ret = stat(dir, &stbuf);
584 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
585 const char *ntfs_device = dir;
586 printf("Capturing WIM image NTFS filesystem on `%s'\n",
588 ret = wimlib_add_image_from_ntfs_volume(w, ntfs_device,
596 if (errno != ENOENT) {
597 imagex_error_with_errno("Failed to stat `%s'", dir);
603 ret = wimlib_add_image(w, dir, name, config_str, config_len,
609 cur_image = wimlib_get_num_images(w);
611 ret = wimlib_set_image_descripton(w, cur_image, desc);
616 ret = wimlib_set_image_flags(w, cur_image, flags_element);
621 ret = wimlib_overwrite(w, write_flags, num_threads);
623 ret = wimlib_write(w, wimfile, WIM_ALL_IMAGES, write_flags,
627 imagex_error("Failed to write the WIM file `%s'", wimfile);
634 /* Remove image(s) from a WIM. */
635 static int imagex_delete(int argc, const char **argv)
638 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
639 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
641 const char *image_num_or_name;
646 for_opt(c, delete_options) {
649 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
650 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
662 imagex_error("Must specify a WIM file");
664 imagex_error("Must specify an image");
669 image_num_or_name = argv[1];
671 ret = file_writable(wimfile);
675 ret = wimlib_open_wim(wimfile, open_flags, &w);
679 image = wimlib_resolve_image(w, image_num_or_name);
681 ret = verify_image_exists(image, image_num_or_name, wimfile);
685 ret = wimlib_delete_image(w, image);
687 imagex_error("Failed to delete image from `%s'", wimfile);
691 ret = wimlib_overwrite(w, write_flags, 0);
693 imagex_error("Failed to write the file `%s' with image "
701 /* Print the files contained in an image(s) in a WIM file. */
702 static int imagex_dir(int argc, const char **argv)
711 imagex_error("Must specify a WIM file");
716 imagex_error("Too many arguments");
722 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w);
727 image = wimlib_resolve_image(w, argv[2]);
728 ret = verify_image_exists(image, argv[2], wimfile);
732 /* Image was not specified. If the WIM only contains one image,
733 * choose that one; otherwise, print an error. */
734 num_images = wimlib_get_num_images(w);
735 if (num_images != 1) {
736 imagex_error("The file `%s' contains %d images; Please "
737 "select one.", wimfile, num_images);
745 ret = wimlib_print_files(w, image);
751 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
753 static int imagex_export(int argc, const char **argv)
756 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
757 int export_flags = 0;
758 int write_flags = WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
759 int compression_type;
760 bool compression_type_specified = false;
761 const char *src_wimfile;
762 const char *src_image_num_or_name;
763 const char *dest_wimfile;
764 const char *dest_name;
765 const char *dest_desc;
766 WIMStruct *src_w = NULL;
767 WIMStruct *dest_w = NULL;
772 const char *swm_glob = NULL;
773 WIMStruct **additional_swms = NULL;
774 unsigned num_additional_swms = 0;
775 unsigned num_threads = 0;
777 for_opt(c, export_options) {
780 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
783 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
784 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
787 compression_type = get_compression_type(optarg);
788 if (compression_type == WIM_COMPRESSION_TYPE_INVALID)
790 compression_type_specified = true;
796 num_threads = parse_num_threads(optarg);
797 if (num_threads == UINT_MAX)
807 if (argc < 3 || argc > 5) {
811 src_wimfile = argv[0];
812 src_image_num_or_name = argv[1];
813 dest_wimfile = argv[2];
814 dest_name = (argc >= 4) ? argv[3] : NULL;
815 dest_desc = (argc >= 5) ? argv[4] : NULL;
816 ret = wimlib_open_wim(src_wimfile,
817 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w);
821 /* Determine if the destination is an existing file or not.
822 * If so, we try to append the exported image(s) to it; otherwise, we
823 * create a new WIM containing the exported image(s). */
824 if (stat(dest_wimfile, &stbuf) == 0) {
828 /* Destination file exists. */
829 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
830 imagex_error("`%s' is not a regular file",
835 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w);
839 ret = file_writable(dest_wimfile);
843 dest_ctype = wimlib_get_compression_type(dest_w);
844 if (compression_type_specified
845 && compression_type != dest_ctype)
847 imagex_error("Cannot specify a compression type that is "
848 "not the same as that used in the "
853 compression_type = dest_ctype;
856 /* dest_wimfile is not an existing file, so create a new WIM. */
857 if (!compression_type_specified)
858 compression_type = wimlib_get_compression_type(src_w);
859 if (errno == ENOENT) {
860 ret = wimlib_create_new_wim(compression_type, &dest_w);
864 imagex_error_with_errno("Cannot stat file `%s'",
871 image = wimlib_resolve_image(src_w, src_image_num_or_name);
872 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
877 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
879 &num_additional_swms);
884 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
885 export_flags, additional_swms,
886 num_additional_swms);
892 ret = wimlib_write(dest_w, dest_wimfile, WIM_ALL_IMAGES,
893 write_flags, num_threads);
895 ret = wimlib_overwrite(dest_w, write_flags, num_threads);
899 if (additional_swms) {
900 for (unsigned i = 0; i < num_additional_swms; i++)
901 wimlib_free(additional_swms[i]);
902 free(additional_swms);
907 /* Prints information about a WIM file; also can mark an image as bootable,
908 * change the name of an image, or change the description of an image. */
909 static int imagex_info(int argc, const char **argv)
915 bool lookup_table = false;
917 bool metadata = false;
918 bool short_header = true;
919 const char *xml_out_file = NULL;
921 const char *image_num_or_name = "all";
922 const char *new_name = NULL;
923 const char *new_desc = NULL;
928 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
929 WIMLIB_OPEN_FLAG_SPLIT_OK;
933 for_opt(c, info_options) {
943 short_header = false;
947 short_header = false;
951 short_header = false;
954 xml_out_file = optarg;
955 short_header = false;
959 short_header = false;
969 if (argc == 0 || argc > 4) {
975 image_num_or_name = argv[1];
985 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
987 ret = wimlib_open_wim(wimfile, open_flags, &w);
991 part_number = wimlib_get_part_number(w, &total_parts);
993 image = wimlib_resolve_image(w, image_num_or_name);
994 if (image == WIM_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
995 imagex_error("The image `%s' does not exist",
998 imagex_error("If you would like to set the boot "
999 "index to 0, specify image \"0\" with "
1000 "the --boot flag.");
1001 ret = WIMLIB_ERR_INVALID_IMAGE;
1005 if (image == WIM_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1007 imagex_error("Cannot specify the --boot flag "
1008 "without specifying a specific "
1009 "image in a multi-image WIM");
1010 ret = WIMLIB_ERR_INVALID_IMAGE;
1014 imagex_error("Cannot specify the NEW_NAME "
1015 "without specifying a specific "
1016 "image in a multi-image WIM");
1017 ret = WIMLIB_ERR_INVALID_IMAGE;
1022 /* Operations that print information are separated from operations that
1023 * recreate the WIM file. */
1024 if (!new_name && !boot) {
1026 /* Read-only operations */
1028 if (image == WIM_NO_IMAGE) {
1029 imagex_error("`%s' is not a valid image",
1031 ret = WIMLIB_ERR_INVALID_IMAGE;
1035 if (image == WIM_ALL_IMAGES && short_header)
1036 wimlib_print_wim_information(w);
1039 wimlib_print_header(w);
1042 if (total_parts != 1) {
1043 printf("Warning: Only showing the lookup table "
1044 "for part %d of a %d-part WIM.\n",
1045 part_number, total_parts);
1047 wimlib_print_lookup_table(w);
1051 ret = wimlib_extract_xml_data(w, stdout);
1057 fp = fopen(xml_out_file, "wb");
1059 imagex_error_with_errno("Failed to open the "
1065 ret = wimlib_extract_xml_data(w, fp);
1066 if (fclose(fp) != 0) {
1067 imagex_error("Failed to close the file `%s'",
1077 wimlib_print_available_images(w, image);
1080 ret = wimlib_print_metadata(w, image);
1086 /* Modification operations */
1087 if (total_parts != 1) {
1088 imagex_error("Modifying a split WIM is not supported.");
1091 if (image == WIM_ALL_IMAGES)
1094 if (image == WIM_NO_IMAGE && new_name) {
1095 imagex_error("Cannot specify new_name (`%s') when "
1096 "using image 0", new_name);
1101 if (image == wimlib_get_boot_idx(w)) {
1102 printf("Image %d is already marked as "
1103 "bootable.\n", image);
1106 printf("Marking image %d as bootable.\n",
1108 wimlib_set_boot_idx(w, image);
1112 if (strcmp(wimlib_get_image_name(w, image),
1114 printf("Image %d is already named \"%s\".\n",
1118 printf("Changing the name of image %d to "
1119 "\"%s\".\n", image, new_name);
1120 ret = wimlib_set_image_name(w, image, new_name);
1126 const char *old_desc;
1127 old_desc = wimlib_get_image_description(w, image);
1128 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1129 printf("The description of image %d is already "
1130 "\"%s\".\n", image, new_desc);
1133 printf("Changing the description of image %d "
1134 "to \"%s\".\n", image, new_desc);
1135 ret = wimlib_set_image_descripton(w, image,
1142 /* Only call wimlib_overwrite_xml_and_header() if something
1143 * actually needs to be changed. */
1144 if (boot || new_name || new_desc ||
1145 check != wimlib_has_integrity_table(w)) {
1147 ret = file_writable(wimfile);
1151 ret = wimlib_overwrite_xml_and_header(w, check ?
1152 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
1153 WIMLIB_WRITE_FLAG_SHOW_PROGRESS : 0);
1155 printf("The file `%s' was not modified because nothing "
1156 "needed to be done.\n", wimfile);
1165 /* Join split WIMs into one part WIM */
1166 static int imagex_join(int argc, const char **argv)
1169 int flags = WIMLIB_OPEN_FLAG_SPLIT_OK | WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1170 const char *output_path;
1172 for_opt(c, join_options) {
1175 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1185 imagex_error("Must specify at least one split WIM (.swm) parts "
1189 output_path = argv[0];
1190 return wimlib_join(++argv, --argc, output_path, flags);
1196 /* Mounts an image using a FUSE mount. */
1197 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1200 int mount_flags = 0;
1201 int open_flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS |
1202 WIMLIB_OPEN_FLAG_SPLIT_OK;
1203 const char *wimfile;
1209 const char *swm_glob = NULL;
1210 WIMStruct **additional_swms = NULL;
1211 unsigned num_additional_swms = 0;
1213 if (strcmp(argv[0], "mountrw") == 0)
1214 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1216 for_opt(c, mount_options) {
1219 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1222 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1225 if (strcasecmp(optarg, "none") == 0)
1226 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1227 else if (strcasecmp(optarg, "xattr") == 0)
1228 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1229 else if (strcasecmp(optarg, "windows") == 0)
1230 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1232 imagex_error("Unknown stream interface \"%s\"", optarg);
1245 if (argc != 2 && argc != 3)
1250 ret = wimlib_open_wim(wimfile, open_flags, &w);
1255 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1257 &num_additional_swms);
1264 num_images = wimlib_get_num_images(w);
1265 if (num_images != 1) {
1266 imagex_error("The file `%s' contains %d images; Please "
1267 "select one.", wimfile, num_images);
1268 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1275 image = wimlib_resolve_image(w, argv[1]);
1277 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1282 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1283 ret = file_writable(wimfile);
1288 ret = wimlib_mount(w, image, dir, mount_flags, additional_swms,
1289 num_additional_swms);
1291 imagex_error("Failed to mount image %d from `%s' on `%s'",
1292 image, wimfile, dir);
1297 if (additional_swms) {
1298 for (unsigned i = 0; i < num_additional_swms; i++)
1299 wimlib_free(additional_swms[i]);
1300 free(additional_swms);
1304 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1309 /* Split a WIM into a spanned set */
1310 static int imagex_split(int argc, const char **argv)
1313 int flags = WIMLIB_OPEN_FLAG_SHOW_PROGRESS;
1314 unsigned long part_size;
1317 for_opt(c, split_options) {
1320 flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1334 part_size = strtod(argv[2], &tmp) * (1 << 20);
1335 if (tmp == argv[2] || *tmp) {
1336 imagex_error("Invalid part size \"%s\"", argv[2]);
1337 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1340 return wimlib_split(argv[0], argv[1], part_size, flags);
1343 /* Unmounts an image. */
1344 static int imagex_unmount(int argc, const char **argv)
1347 int unmount_flags = 0;
1350 for_opt(c, unmount_options) {
1353 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1356 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1370 ret = wimlib_unmount(argv[0], unmount_flags);
1372 imagex_error("Failed to unmount `%s'", argv[0]);
1376 struct imagex_command {
1378 int (*func)(int , const char **);
1383 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1384 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1386 static const struct imagex_command imagex_commands[] = {
1387 {"append", imagex_capture_or_append, APPEND},
1388 {"apply", imagex_apply, APPLY},
1389 {"capture", imagex_capture_or_append, CAPTURE},
1390 {"delete", imagex_delete, DELETE},
1391 {"dir", imagex_dir, DIR},
1392 {"export", imagex_export, EXPORT},
1393 {"info", imagex_info, INFO},
1394 {"join", imagex_join, JOIN},
1395 {"mount", imagex_mount_rw_or_ro, MOUNT},
1396 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1397 {"split", imagex_split, SPLIT},
1398 {"unmount", imagex_unmount, UNMOUNT},
1401 static void version()
1403 static const char *s =
1404 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1405 "Copyright (C) 2012 Eric Biggers\n"
1406 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1407 "This is free software: you are free to change and redistribute it.\n"
1408 "There is NO WARRANTY, to the extent permitted by law.\n"
1410 "Report bugs to "PACKAGE_BUGREPORT".\n";
1415 static void help_or_version(int argc, const char **argv)
1419 const struct imagex_command *cmd;
1421 for (i = 1; i < argc; i++) {
1429 if (strcmp(p, "help") == 0) {
1430 for_imagex_command(cmd) {
1431 if (strcmp(cmd->name, argv[1]) == 0) {
1439 if (strcmp(p, "version") == 0) {
1447 static void usage(int cmd_type)
1449 const struct imagex_command *cmd;
1450 printf("Usage: %s", usage_strings[cmd_type]);
1451 for_imagex_command(cmd) {
1452 if (cmd->cmd == cmd_type)
1453 printf("\nTry `man imagex-%s' for more details.\n",
1458 static void usage_all()
1460 puts("IMAGEX: Usage:");
1461 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1462 printf(" %s", usage_strings[i]);
1463 static const char *extra =
1465 " imagex --version\n"
1467 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1469 " Try `man imagex' for more information.\n"
1471 fputs(extra, stdout);
1475 int main(int argc, const char **argv)
1477 const struct imagex_command *cmd;
1481 imagex_error("No command specified");
1486 help_or_version(argc, argv);
1490 wimlib_set_print_errors(true);
1492 for_imagex_command(cmd) {
1493 if (strcmp(cmd->name, *argv) == 0) {
1494 ret = cmd->func(argc, argv);
1496 imagex_error("Exiting with error code %d:\n"
1498 wimlib_get_error_string(ret));
1499 if (ret == WIMLIB_ERR_NTFS_3G)
1500 imagex_error_with_errno("errno");
1506 imagex_error("Unrecognized command: `%s'", argv[0]);