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/>.
41 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
43 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (char**)argv, "", \
62 static void usage(int cmd_type);
63 static void usage_all();
65 static const char *usage_strings[] = {
67 "imagex append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
68 " [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
69 " [--verbose] [--dereference] [--config=FILE]\n"
70 " [--threads=NUM_THREADS] [--rebuild]\n",
72 "imagex apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
73 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
74 " [--symlink] [--verbose] [--ref=\"GLOB\"]\n",
76 "imagex capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
77 " [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
78 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
79 " [--config=FILE] [--threads=NUM_THREADS]\n",
81 "imagex delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n",
83 "imagex dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
85 "imagex export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
86 " DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
87 " [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
88 " [--threads=NUM_THREADS] [--rebuild]\n",
90 "imagex info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
91 " [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
92 " [--xml] [--extract-xml FILE] [--metadata]\n",
94 "imagex join [--check] WIMFILE SPLIT_WIM...\n",
96 "imagex mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
97 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
98 " [--ref=\"GLOB\"]\n",
100 "imagex mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
101 " [--check] [--debug] [--streams-interface=INTERFACE]\n",
103 "imagex optimize WIMFILE [--check] [--recompress]\n",
105 "imagex split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
107 "imagex unmount DIRECTORY [--commit] [--check]\n",
110 static const struct option common_options[] = {
111 {"help", 0, NULL, 'h'},
112 {"version", 0, NULL, 'v'},
116 static const struct option apply_options[] = {
117 {"check", no_argument, NULL, 'c'},
118 {"hardlink", no_argument, NULL, 'h'},
119 {"symlink", no_argument, NULL, 's'},
120 {"verbose", no_argument, NULL, 'v'},
121 {"ref", required_argument, NULL, 'r'},
124 static const struct option capture_or_append_options[] = {
125 {"boot", no_argument, NULL, 'b'},
126 {"check", no_argument, NULL, 'c'},
127 {"compress", required_argument, NULL, 'x'},
128 {"config", required_argument, NULL, 'C'},
129 {"dereference", no_argument, NULL, 'L'},
130 {"flags", required_argument, NULL, 'f'},
131 {"verbose", no_argument, NULL, 'v'},
132 {"threads", required_argument, NULL, 't'},
133 {"rebuild", no_argument, NULL, 'R'},
136 static const struct option delete_options[] = {
137 {"check", no_argument, NULL, 'c'},
138 {"soft", no_argument, NULL, 's'},
142 static const struct option export_options[] = {
143 {"boot", no_argument, NULL, 'b'},
144 {"check", no_argument, NULL, 'c'},
145 {"compress", required_argument, NULL, 'x'},
146 {"ref", required_argument, NULL, 'r'},
147 {"threads", required_argument, NULL, 't'},
148 {"rebuild", no_argument, NULL, 'R'},
152 static const struct option info_options[] = {
153 {"boot", no_argument, NULL, 'b'},
154 {"check", no_argument, NULL, 'c'},
155 {"extract-xml", required_argument, NULL, 'X'},
156 {"header", no_argument, NULL, 'h'},
157 {"lookup-table", no_argument, NULL, 'l'},
158 {"metadata", no_argument, NULL, 'm'},
159 {"xml", no_argument, NULL, 'x'},
163 static const struct option join_options[] = {
164 {"check", no_argument, NULL, 'c'},
168 static const struct option mount_options[] = {
169 {"check", no_argument, NULL, 'c'},
170 {"debug", no_argument, NULL, 'd'},
171 {"streams-interface", required_argument, NULL, 's'},
172 {"ref", required_argument, NULL, 'r'},
176 static const struct option optimize_options[] = {
177 {"check", no_argument, NULL, 'c'},
178 {"recompress", no_argument, NULL, 'r'},
182 static const struct option split_options[] = {
183 {"check", no_argument, NULL, 'c'},
187 static const struct option unmount_options[] = {
188 {"commit", no_argument, NULL, 'c'},
189 {"check", no_argument, NULL, 'C'},
195 /* Print formatted error message to stderr. */
196 static void imagex_error(const char *format, ...)
199 va_start(va, format);
200 fputs("ERROR: ", stderr);
201 vfprintf(stderr, format, va);
206 /* Print formatted error message to stderr. */
207 static void imagex_error_with_errno(const char *format, ...)
209 int errno_save = errno;
211 va_start(va, format);
212 fputs("ERROR: ", stderr);
213 vfprintf(stderr, format, va);
214 fprintf(stderr, ": %s\n", strerror(errno_save));
218 static int verify_image_exists(int image, const char *image_name,
219 const char *wim_name)
221 if (image == WIMLIB_NO_IMAGE) {
222 imagex_error("\"%s\" is not a valid image in `%s'!\n"
223 " Please specify a 1-based imagex index or "
225 " You may use `imagex info' to list the images "
226 "contained in a WIM.",
227 image_name, wim_name);
233 static int verify_image_is_single(int image)
235 if (image == WIMLIB_ALL_IMAGES) {
236 imagex_error("Cannot specify all images for this action!");
242 static int verify_image_exists_and_is_single(int image, const char *image_name,
243 const char *wim_name)
246 ret = verify_image_exists(image, image_name, wim_name);
248 ret = verify_image_is_single(image);
252 static int get_compression_type(const char *optarg)
254 if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
255 return WIMLIB_COMPRESSION_TYPE_LZX;
256 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
257 return WIMLIB_COMPRESSION_TYPE_XPRESS;
258 else if (strcasecmp(optarg, "none") == 0)
259 return WIMLIB_COMPRESSION_TYPE_NONE;
261 imagex_error("Invalid compression type `%s'! Must be "
262 "\"maximum\", \"fast\", or \"none\".", optarg);
263 return WIMLIB_COMPRESSION_TYPE_INVALID;
267 static off_t file_get_size(const char *filename)
270 if (stat(filename, &st) == 0)
276 static char *file_get_contents(const char *filename, size_t *len_ret)
283 if (stat(filename, &stbuf) != 0) {
284 imagex_error_with_errno("Failed to stat the file `%s'", filename);
289 fp = fopen(filename, "rb");
291 imagex_error_with_errno("Failed to open the file `%s'", filename);
297 imagex_error("Failed to allocate buffer of %zu bytes to hold "
298 "contents of file `%s'", len, filename);
301 if (fread(buf, 1, len, fp) != len) {
302 imagex_error_with_errno("Failed to read %lu bytes from the "
303 "file `%s'", len, filename);
315 static int file_writable(const char *path)
318 ret = access(path, F_OK | W_OK);
320 imagex_error_with_errno("Can't modify `%s'", path);
324 #define TO_PERCENT(numerator, denominator) \
325 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
327 static const char *get_data_type(int ctype)
330 case WIMLIB_COMPRESSION_TYPE_NONE:
331 return "uncompressed";
332 case WIMLIB_COMPRESSION_TYPE_LZX:
333 return "LZX-compressed";
334 case WIMLIB_COMPRESSION_TYPE_XPRESS:
335 return "XPRESS-compressed";
340 static int imagex_progress_func(enum wimlib_progress_msg msg,
341 const union wimlib_progress_info *info)
343 unsigned percent_done;
345 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
346 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
347 info->write_streams.total_bytes);
348 if (info->write_streams.completed_streams == 0) {
349 const char *data_type;
351 data_type = get_data_type(info->write_streams.compression_type);
352 printf("Writing %s data using %u thread%s\n",
353 data_type, info->write_streams.num_threads,
354 (info->write_streams.num_threads == 1) ? "" : "s");
356 printf("\r%"PRIu64" MiB of %"PRIu64" MiB (uncompressed) "
357 "written (%u%% done)",
358 info->write_streams.completed_bytes >> 20,
359 info->write_streams.total_bytes >> 20,
361 if (info->write_streams.completed_bytes == info->write_streams.total_bytes)
364 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
365 printf("Scanning `%s'...\n", info->scan.source);
367 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
368 if (info->scan.excluded)
369 printf("Excluding `%s' from capture\n", info->scan.cur_path);
371 printf("Scanning `%s'\n", info->scan.cur_path);
373 /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
375 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
376 percent_done = TO_PERCENT(info->integrity.completed_bytes,
377 info->integrity.total_bytes);
378 printf("\rVerifying integrity of `%s': %"PRIu64" MiB "
379 "of %"PRIu64" MiB (%u%%) done",
380 info->integrity.filename,
381 info->integrity.completed_bytes >> 20,
382 info->integrity.total_bytes >> 20,
384 if (info->integrity.completed_bytes == info->integrity.total_bytes)
387 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
388 percent_done = TO_PERCENT(info->integrity.completed_bytes,
389 info->integrity.total_bytes);
390 printf("\rCalculating integrity table for WIM: %"PRIu64" MiB "
391 "of %"PRIu64" MiB (%u%%) done",
392 info->integrity.completed_bytes >> 20,
393 info->integrity.total_bytes >> 20,
395 if (info->integrity.completed_bytes == info->integrity.total_bytes)
398 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
399 /*printf("Applying image %d (%s) to `%s'\n",*/
400 /*info->extract.image,*/
401 /*info->extract.image_name,*/
402 /*info->extract.target);*/
404 /*case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:*/
405 /*printf("Done applying image %d!\n",*/
406 /*info->extract.image);*/
408 /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
409 /*printf("Applying directory structure to %s\n",*/
410 /*info->extract.target);*/
412 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
413 percent_done = TO_PERCENT(info->extract.completed_bytes,
414 info->extract.total_bytes);
415 printf("\rExtracting files: "
416 "%"PRIu64" MiB of %"PRIu64" MiB (%u%%) done",
417 info->extract.completed_bytes >> 20,
418 info->extract.total_bytes >> 20,
420 if (info->extract.completed_bytes == info->extract.total_bytes)
423 case WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY:
424 puts(info->extract.cur_path);
426 case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
427 percent_done = TO_PERCENT(info->join.completed_bytes,
428 info->join.total_bytes);
429 printf("Writing resources from part %u of %u: "
430 "%"PRIu64 " MiB of %"PRIu64" MiB (%u%%) written\n",
431 (info->join.completed_parts == info->join.total_parts) ?
432 info->join.completed_parts : info->join.completed_parts + 1,
433 info->join.total_parts,
434 info->join.completed_bytes >> 20,
435 info->join.total_bytes >> 20,
438 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
439 percent_done = TO_PERCENT(info->split.completed_bytes,
440 info->split.total_bytes);
441 printf("Writing `%s': %"PRIu64" MiB of %"PRIu64" MiB (%u%%) written\n",
442 info->split.part_name,
443 info->split.completed_bytes >> 20,
444 info->split.total_bytes >> 20,
447 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
448 if (info->split.completed_bytes == info->split.total_bytes) {
449 printf("Finished writing %u split WIM parts\n",
450 info->split.cur_part_number);
461 static int open_swms_from_glob(const char *swm_glob,
462 const char *first_part,
464 WIMStruct ***additional_swms_ret,
465 unsigned *num_additional_swms_ret)
467 unsigned num_additional_swms = 0;
468 WIMStruct **additional_swms = NULL;
472 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
474 if (ret == GLOB_NOMATCH) {
475 imagex_error("Found no files for glob \"%s\"",
478 imagex_error_with_errno("Failed to process glob "
484 num_additional_swms = globbuf.gl_pathc;
485 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
486 if (!additional_swms) {
487 imagex_error("Out of memory");
492 for (unsigned i = 0; i < num_additional_swms; i++) {
493 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
497 ret = wimlib_open_wim(globbuf.gl_pathv[i],
498 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
499 &additional_swms[i - offset],
500 imagex_progress_func);
504 *additional_swms_ret = additional_swms;
505 *num_additional_swms_ret = num_additional_swms - offset;
509 for (unsigned i = 0; i < num_additional_swms; i++)
510 wimlib_free(additional_swms[i]);
511 free(additional_swms);
519 static unsigned parse_num_threads(const char *optarg)
522 unsigned nthreads = strtoul(optarg, &tmp, 10);
523 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
524 imagex_error("Number of threads must be a non-negative integer!");
532 /* Extract one image, or all images, from a WIM file into a directory. */
533 static int imagex_apply(int argc, const char **argv)
536 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
543 const char *image_num_or_name;
544 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
546 const char *swm_glob = NULL;
547 WIMStruct **additional_swms = NULL;
548 unsigned num_additional_swms = 0;
550 for_opt(c, apply_options) {
553 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
556 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
559 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
562 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
574 if (argc != 2 && argc != 3) {
581 image_num_or_name = "1";
584 image_num_or_name = argv[1];
588 ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func);
592 image = wimlib_resolve_image(w, image_num_or_name);
593 ret = verify_image_exists(image, image_num_or_name, wimfile);
597 num_images = wimlib_get_num_images(w);
598 if (argc == 2 && num_images != 1) {
599 imagex_error("`%s' contains %d images; Please select one "
600 "(or all)", wimfile, num_images);
607 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
609 &num_additional_swms);
616 ret = stat(target, &stbuf);
618 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
619 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
620 printf("Applying `%s' image %d to NTFS volume `%s'\n",
621 wimfile, image, target);
624 if (errno != ENOENT) {
625 imagex_error_with_errno("Failed to stat `%s'", target);
631 ret = wimlib_extract_image(w, image, target, extract_flags,
632 additional_swms, num_additional_swms,
633 imagex_progress_func);
636 if (additional_swms) {
637 for (unsigned i = 0; i < num_additional_swms; i++)
638 wimlib_free(additional_swms[i]);
639 free(additional_swms);
644 static int imagex_capture_or_append(int argc, const char **argv)
648 int add_image_flags = 0;
650 int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
655 const char *flags_element = NULL;
656 const char *config_file = NULL;
657 char *config_str = NULL;
658 size_t config_len = 0;
663 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
664 unsigned num_threads = 0;
666 for_opt(c, capture_or_append_options) {
669 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
672 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
673 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
676 config_file = optarg;
679 compression_type = get_compression_type(optarg);
680 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
684 flags_element = optarg;
687 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
690 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
693 num_threads = parse_num_threads(optarg);
694 if (num_threads == UINT_MAX)
698 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
707 if (argc < 2 || argc > 4) {
714 char source_copy[strlen(source) + 1];
715 memcpy(source_copy, source, strlen(source) + 1);
716 default_name = basename(source_copy);
718 name = (argc >= 3) ? argv[2] : default_name;
719 desc = (argc >= 4) ? argv[3] : NULL;
722 config_str = file_get_contents(config_file, &config_len);
728 ret = wimlib_open_wim(wimfile, open_flags, &w,
729 imagex_progress_func);
731 ret = wimlib_create_new_wim(compression_type, &w);
737 ret = stat(source, &stbuf);
739 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
740 printf("Capturing WIM image from NTFS filesystem on `%s'\n",
742 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
745 if (errno != ENOENT) {
746 imagex_error_with_errno("Failed to stat `%s'", source);
752 ret = wimlib_add_image(w, source, name, config_str, config_len,
753 add_image_flags, imagex_progress_func);
757 cur_image = wimlib_get_num_images(w);
759 ret = wimlib_set_image_descripton(w, cur_image, desc);
764 ret = wimlib_set_image_flags(w, cur_image, flags_element);
769 ret = wimlib_overwrite(w, write_flags, num_threads,
770 imagex_progress_func);
772 ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags,
773 num_threads, imagex_progress_func);
775 if (ret == WIMLIB_ERR_REOPEN)
778 imagex_error("Failed to write the WIM file `%s'", wimfile);
785 /* Remove image(s) from a WIM. */
786 static int imagex_delete(int argc, const char **argv)
792 const char *image_num_or_name;
797 for_opt(c, delete_options) {
800 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
801 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
804 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
816 imagex_error("Must specify a WIM file");
818 imagex_error("Must specify an image");
823 image_num_or_name = argv[1];
825 ret = file_writable(wimfile);
829 ret = wimlib_open_wim(wimfile, open_flags, &w,
830 imagex_progress_func);
834 image = wimlib_resolve_image(w, image_num_or_name);
836 ret = verify_image_exists(image, image_num_or_name, wimfile);
840 ret = wimlib_delete_image(w, image);
842 imagex_error("Failed to delete image from `%s'", wimfile);
846 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
847 if (ret == WIMLIB_ERR_REOPEN)
850 imagex_error("Failed to write the file `%s' with image "
858 /* Print the files contained in an image(s) in a WIM file. */
859 static int imagex_dir(int argc, const char **argv)
868 imagex_error("Must specify a WIM file");
873 imagex_error("Too many arguments");
879 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w,
880 imagex_progress_func);
885 image = wimlib_resolve_image(w, argv[2]);
886 ret = verify_image_exists(image, argv[2], wimfile);
890 /* Image was not specified. If the WIM only contains one image,
891 * choose that one; otherwise, print an error. */
892 num_images = wimlib_get_num_images(w);
893 if (num_images != 1) {
894 imagex_error("The file `%s' contains %d images; Please "
895 "select one.", wimfile, num_images);
903 ret = wimlib_print_files(w, image);
909 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
911 static int imagex_export(int argc, const char **argv)
915 int export_flags = 0;
917 int compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
918 bool compression_type_specified = false;
919 const char *src_wimfile;
920 const char *src_image_num_or_name;
921 const char *dest_wimfile;
922 const char *dest_name;
923 const char *dest_desc;
924 WIMStruct *src_w = NULL;
925 WIMStruct *dest_w = NULL;
930 const char *swm_glob = NULL;
931 WIMStruct **additional_swms = NULL;
932 unsigned num_additional_swms = 0;
933 unsigned num_threads = 0;
935 for_opt(c, export_options) {
938 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
941 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
942 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
945 compression_type = get_compression_type(optarg);
946 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
948 compression_type_specified = true;
954 num_threads = parse_num_threads(optarg);
955 if (num_threads == UINT_MAX)
959 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
968 if (argc < 3 || argc > 5) {
972 src_wimfile = argv[0];
973 src_image_num_or_name = argv[1];
974 dest_wimfile = argv[2];
975 dest_name = (argc >= 4) ? argv[3] : NULL;
976 dest_desc = (argc >= 5) ? argv[4] : NULL;
977 ret = wimlib_open_wim(src_wimfile,
978 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w,
979 imagex_progress_func);
983 /* Determine if the destination is an existing file or not.
984 * If so, we try to append the exported image(s) to it; otherwise, we
985 * create a new WIM containing the exported image(s). */
986 if (stat(dest_wimfile, &stbuf) == 0) {
990 /* Destination file exists. */
991 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
992 imagex_error("`%s' is not a regular file",
997 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w,
998 imagex_progress_func);
1002 ret = file_writable(dest_wimfile);
1006 dest_ctype = wimlib_get_compression_type(dest_w);
1007 if (compression_type_specified
1008 && compression_type != dest_ctype)
1010 imagex_error("Cannot specify a compression type that is "
1011 "not the same as that used in the "
1016 compression_type = dest_ctype;
1019 /* dest_wimfile is not an existing file, so create a new WIM. */
1020 if (!compression_type_specified)
1021 compression_type = wimlib_get_compression_type(src_w);
1022 if (errno == ENOENT) {
1023 ret = wimlib_create_new_wim(compression_type, &dest_w);
1027 imagex_error_with_errno("Cannot stat file `%s'",
1034 image = wimlib_resolve_image(src_w, src_image_num_or_name);
1035 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
1040 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
1042 &num_additional_swms);
1047 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
1048 export_flags, additional_swms,
1049 num_additional_swms, imagex_progress_func);
1055 ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES,
1056 write_flags, num_threads,
1057 imagex_progress_func);
1059 ret = wimlib_overwrite(dest_w, write_flags, num_threads,
1060 imagex_progress_func);
1062 if (ret == WIMLIB_ERR_REOPEN)
1065 wimlib_free(dest_w);
1066 if (additional_swms) {
1067 for (unsigned i = 0; i < num_additional_swms; i++)
1068 wimlib_free(additional_swms[i]);
1069 free(additional_swms);
1074 /* Prints information about a WIM file; also can mark an image as bootable,
1075 * change the name of an image, or change the description of an image. */
1076 static int imagex_info(int argc, const char **argv)
1081 bool header = false;
1082 bool lookup_table = false;
1084 bool metadata = false;
1085 bool short_header = true;
1086 const char *xml_out_file = NULL;
1087 const char *wimfile;
1088 const char *image_num_or_name = "all";
1089 const char *new_name = NULL;
1090 const char *new_desc = NULL;
1095 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1099 for_opt(c, info_options) {
1109 short_header = false;
1112 lookup_table = true;
1113 short_header = false;
1117 short_header = false;
1120 xml_out_file = optarg;
1121 short_header = false;
1125 short_header = false;
1135 if (argc == 0 || argc > 4) {
1141 image_num_or_name = argv[1];
1151 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1153 ret = wimlib_open_wim(wimfile, open_flags, &w,
1154 imagex_progress_func);
1158 part_number = wimlib_get_part_number(w, &total_parts);
1160 image = wimlib_resolve_image(w, image_num_or_name);
1161 if (image == WIMLIB_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
1162 imagex_error("The image `%s' does not exist",
1165 imagex_error("If you would like to set the boot "
1166 "index to 0, specify image \"0\" with "
1167 "the --boot flag.");
1168 ret = WIMLIB_ERR_INVALID_IMAGE;
1172 if (image == WIMLIB_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1174 imagex_error("Cannot specify the --boot flag "
1175 "without specifying a specific "
1176 "image in a multi-image WIM");
1177 ret = WIMLIB_ERR_INVALID_IMAGE;
1181 imagex_error("Cannot specify the NEW_NAME "
1182 "without specifying a specific "
1183 "image in a multi-image WIM");
1184 ret = WIMLIB_ERR_INVALID_IMAGE;
1189 /* Operations that print information are separated from operations that
1190 * recreate the WIM file. */
1191 if (!new_name && !boot) {
1193 /* Read-only operations */
1195 if (image == WIMLIB_NO_IMAGE) {
1196 imagex_error("`%s' is not a valid image",
1198 ret = WIMLIB_ERR_INVALID_IMAGE;
1202 if (image == WIMLIB_ALL_IMAGES && short_header)
1203 wimlib_print_wim_information(w);
1206 wimlib_print_header(w);
1209 if (total_parts != 1) {
1210 printf("Warning: Only showing the lookup table "
1211 "for part %d of a %d-part WIM.\n",
1212 part_number, total_parts);
1214 wimlib_print_lookup_table(w);
1218 ret = wimlib_extract_xml_data(w, stdout);
1224 fp = fopen(xml_out_file, "wb");
1226 imagex_error_with_errno("Failed to open the "
1232 ret = wimlib_extract_xml_data(w, fp);
1233 if (fclose(fp) != 0) {
1234 imagex_error("Failed to close the file `%s'",
1244 wimlib_print_available_images(w, image);
1247 ret = wimlib_print_metadata(w, image);
1253 /* Modification operations */
1254 if (total_parts != 1) {
1255 imagex_error("Modifying a split WIM is not supported.");
1258 if (image == WIMLIB_ALL_IMAGES)
1261 if (image == WIMLIB_NO_IMAGE && new_name) {
1262 imagex_error("Cannot specify new_name (`%s') when "
1263 "using image 0", new_name);
1268 if (image == wimlib_get_boot_idx(w)) {
1269 printf("Image %d is already marked as "
1270 "bootable.\n", image);
1273 printf("Marking image %d as bootable.\n",
1275 wimlib_set_boot_idx(w, image);
1279 if (strcmp(wimlib_get_image_name(w, image),
1281 printf("Image %d is already named \"%s\".\n",
1285 printf("Changing the name of image %d to "
1286 "\"%s\".\n", image, new_name);
1287 ret = wimlib_set_image_name(w, image, new_name);
1293 const char *old_desc;
1294 old_desc = wimlib_get_image_description(w, image);
1295 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1296 printf("The description of image %d is already "
1297 "\"%s\".\n", image, new_desc);
1300 printf("Changing the description of image %d "
1301 "to \"%s\".\n", image, new_desc);
1302 ret = wimlib_set_image_descripton(w, image,
1309 /* Only call wimlib_overwrite() if something actually needs to
1311 if (boot || new_name || new_desc ||
1312 check != wimlib_has_integrity_table(w)) {
1314 ret = file_writable(wimfile);
1320 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1325 ret = wimlib_overwrite(w, write_flags, 1,
1326 imagex_progress_func);
1327 if (ret == WIMLIB_ERR_REOPEN)
1330 printf("The file `%s' was not modified because nothing "
1331 "needed to be done.\n", wimfile);
1340 /* Join split WIMs into one part WIM */
1341 static int imagex_join(int argc, const char **argv)
1344 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1345 int wim_write_flags = 0;
1346 const char *output_path;
1348 for_opt(c, join_options) {
1351 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1352 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1362 imagex_error("Must specify one or more split WIM (.swm) parts "
1366 output_path = argv[0];
1367 return wimlib_join(++argv, --argc, output_path, swm_open_flags,
1368 wim_write_flags, imagex_progress_func);
1374 /* Mounts an image using a FUSE mount. */
1375 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1378 int mount_flags = 0;
1379 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1380 const char *wimfile;
1386 const char *swm_glob = NULL;
1387 WIMStruct **additional_swms = NULL;
1388 unsigned num_additional_swms = 0;
1390 if (strcmp(argv[0], "mountrw") == 0)
1391 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1393 for_opt(c, mount_options) {
1396 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1399 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1402 if (strcasecmp(optarg, "none") == 0)
1403 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1404 else if (strcasecmp(optarg, "xattr") == 0)
1405 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1406 else if (strcasecmp(optarg, "windows") == 0)
1407 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1409 imagex_error("Unknown stream interface \"%s\"", optarg);
1422 if (argc != 2 && argc != 3)
1427 ret = wimlib_open_wim(wimfile, open_flags, &w,
1428 imagex_progress_func);
1433 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1435 &num_additional_swms);
1442 num_images = wimlib_get_num_images(w);
1443 if (num_images != 1) {
1444 imagex_error("The file `%s' contains %d images; Please "
1445 "select one.", wimfile, num_images);
1446 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1453 image = wimlib_resolve_image(w, argv[1]);
1455 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1460 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1461 ret = file_writable(wimfile);
1466 ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms,
1467 num_additional_swms, NULL);
1469 imagex_error("Failed to mount image %d from `%s' on `%s'",
1470 image, wimfile, dir);
1475 if (additional_swms) {
1476 for (unsigned i = 0; i < num_additional_swms; i++)
1477 wimlib_free(additional_swms[i]);
1478 free(additional_swms);
1482 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1487 static int imagex_optimize(int argc, const char **argv)
1491 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
1494 const char *wimfile;
1498 for_opt(c, optimize_options) {
1501 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1502 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1505 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1522 ret = wimlib_open_wim(wimfile, open_flags, &w,
1523 imagex_progress_func);
1527 old_size = file_get_size(argv[0]);
1528 printf("`%s' original size: ", wimfile);
1532 printf("%"PRIu64" KiB\n", old_size >> 10);
1534 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
1536 new_size = file_get_size(argv[0]);
1537 printf("`%s' optimized size: ", wimfile);
1541 printf("%"PRIu64" KiB\n", new_size >> 10);
1543 fputs("Space saved: ", stdout);
1544 if (new_size != -1 && old_size != -1) {
1545 printf("%lld KiB\n",
1546 ((long long)old_size - (long long)new_size) >> 10);
1555 /* Split a WIM into a spanned set */
1556 static int imagex_split(int argc, const char **argv)
1559 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1560 int write_flags = 0;
1561 unsigned long part_size;
1566 for_opt(c, split_options) {
1569 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1570 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1584 part_size = strtod(argv[2], &tmp) * (1 << 20);
1585 if (tmp == argv[2] || *tmp) {
1586 imagex_error("Invalid part size \"%s\"", argv[2]);
1587 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1590 ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func);
1593 ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func);
1598 /* Unmounts an image. */
1599 static int imagex_unmount(int argc, const char **argv)
1602 int unmount_flags = 0;
1605 for_opt(c, unmount_options) {
1608 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1611 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1625 ret = wimlib_unmount_image(argv[0], unmount_flags,
1626 imagex_progress_func);
1628 imagex_error("Failed to unmount `%s'", argv[0]);
1632 struct imagex_command {
1634 int (*func)(int , const char **);
1639 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1640 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1642 static const struct imagex_command imagex_commands[] = {
1643 {"append", imagex_capture_or_append, APPEND},
1644 {"apply", imagex_apply, APPLY},
1645 {"capture", imagex_capture_or_append, CAPTURE},
1646 {"delete", imagex_delete, DELETE},
1647 {"dir", imagex_dir, DIR},
1648 {"export", imagex_export, EXPORT},
1649 {"info", imagex_info, INFO},
1650 {"join", imagex_join, JOIN},
1651 {"mount", imagex_mount_rw_or_ro, MOUNT},
1652 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1653 {"optimize",imagex_optimize, OPTIMIZE},
1654 {"split", imagex_split, SPLIT},
1655 {"unmount", imagex_unmount, UNMOUNT},
1658 static void version()
1660 static const char *s =
1661 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1662 "Copyright (C) 2012 Eric Biggers\n"
1663 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1664 "This is free software: you are free to change and redistribute it.\n"
1665 "There is NO WARRANTY, to the extent permitted by law.\n"
1667 "Report bugs to "PACKAGE_BUGREPORT".\n";
1672 static void help_or_version(int argc, const char **argv)
1676 const struct imagex_command *cmd;
1678 for (i = 1; i < argc; i++) {
1686 if (strcmp(p, "help") == 0) {
1687 for_imagex_command(cmd) {
1688 if (strcmp(cmd->name, argv[1]) == 0) {
1696 if (strcmp(p, "version") == 0) {
1704 static void usage(int cmd_type)
1706 const struct imagex_command *cmd;
1707 printf("Usage: %s", usage_strings[cmd_type]);
1708 for_imagex_command(cmd) {
1709 if (cmd->cmd == cmd_type)
1710 printf("\nTry `man imagex-%s' for more details.\n",
1715 static void usage_all()
1717 puts("IMAGEX: Usage:");
1718 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1719 printf(" %s", usage_strings[i]);
1720 static const char *extra =
1722 " imagex --version\n"
1724 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1726 " Try `man imagex' for more information.\n"
1728 fputs(extra, stdout);
1732 int main(int argc, const char **argv)
1734 const struct imagex_command *cmd;
1738 imagex_error("No command specified");
1743 help_or_version(argc, argv);
1747 wimlib_set_print_errors(true);
1749 for_imagex_command(cmd) {
1750 if (strcmp(cmd->name, *argv) == 0) {
1751 ret = cmd->func(argc, argv);
1753 imagex_error("Exiting with error code %d:\n"
1755 wimlib_get_error_string(ret));
1756 if (ret == WIMLIB_ERR_NTFS_3G)
1757 imagex_error_with_errno("errno");
1763 imagex_error("Unrecognized command: `%s'", argv[0]);