4 * Use wimlib to create, modify, extract, mount, unmount, or display information
9 * Copyright (C) 2012 Eric Biggers
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
41 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (char**)argv, "", \
61 static void usage(int cmd_type);
62 static void usage_all();
64 static const char *usage_strings[] = {
66 "imagex append (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
67 " [DESCRIPTION] [--boot] [--check] [--flags EDITION_ID]\n"
68 " [--verbose] [--dereference] [--config=FILE]\n"
69 " [--threads=NUM_THREADS] [--rebuild]\n",
71 "imagex apply WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
72 " (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
73 " [--symlink] [--verbose] [--ref=\"GLOB\"]\n",
75 "imagex capture (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
76 " [DESCRIPTION] [--boot] [--check] [--compress=TYPE]\n"
77 " [--flags EDITION_ID] [--verbose] [--dereference]\n"
78 " [--config=FILE] [--threads=NUM_THREADS]\n",
80 "imagex delete WIMFILE (IMAGE_NUM | IMAGE_NAME | all) [--check] [--soft]\n",
82 "imagex dir WIMFILE (IMAGE_NUM | IMAGE_NAME | all)\n",
84 "imagex export SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
85 " DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
86 " [--boot] [--check] [--compress=TYPE] [--ref=\"GLOB\"]\n"
87 " [--threads=NUM_THREADS] [--rebuild]\n",
89 "imagex info WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
90 " [NEW_DESC] [--boot] [--check] [--header] [--lookup-table]\n"
91 " [--xml] [--extract-xml FILE] [--metadata]\n",
93 "imagex join [--check] WIMFILE SPLIT_WIM...\n",
95 "imagex mount WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
96 " [--check] [--debug] [--streams-interface=INTERFACE]\n"
97 " [--ref=\"GLOB\"]\n",
99 "imagex mountrw WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
100 " [--check] [--debug] [--streams-interface=INTERFACE]\n",
102 "imagex optimize WIMFILE [--check] [--recompress]\n",
104 "imagex split WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n",
106 "imagex unmount DIRECTORY [--commit] [--check]\n",
109 static const struct option common_options[] = {
110 {"help", 0, NULL, 'h'},
111 {"version", 0, NULL, 'v'},
115 static const struct option apply_options[] = {
116 {"check", no_argument, NULL, 'c'},
117 {"hardlink", no_argument, NULL, 'h'},
118 {"symlink", no_argument, NULL, 's'},
119 {"verbose", no_argument, NULL, 'v'},
120 {"ref", required_argument, NULL, 'r'},
123 static const struct option capture_or_append_options[] = {
124 {"boot", no_argument, NULL, 'b'},
125 {"check", no_argument, NULL, 'c'},
126 {"compress", required_argument, NULL, 'x'},
127 {"config", required_argument, NULL, 'C'},
128 {"dereference", no_argument, NULL, 'L'},
129 {"flags", required_argument, NULL, 'f'},
130 {"verbose", no_argument, NULL, 'v'},
131 {"threads", required_argument, NULL, 't'},
132 {"rebuild", no_argument, NULL, 'R'},
135 static const struct option delete_options[] = {
136 {"check", no_argument, NULL, 'c'},
137 {"soft", no_argument, NULL, 's'},
141 static const struct option export_options[] = {
142 {"boot", no_argument, NULL, 'b'},
143 {"check", no_argument, NULL, 'c'},
144 {"compress", required_argument, NULL, 'x'},
145 {"ref", required_argument, NULL, 'r'},
146 {"threads", required_argument, NULL, 't'},
147 {"rebuild", no_argument, NULL, 'R'},
151 static const struct option info_options[] = {
152 {"boot", no_argument, NULL, 'b'},
153 {"check", no_argument, NULL, 'c'},
154 {"extract-xml", required_argument, NULL, 'X'},
155 {"header", no_argument, NULL, 'h'},
156 {"lookup-table", no_argument, NULL, 'l'},
157 {"metadata", no_argument, NULL, 'm'},
158 {"xml", no_argument, NULL, 'x'},
162 static const struct option join_options[] = {
163 {"check", no_argument, NULL, 'c'},
167 static const struct option mount_options[] = {
168 {"check", no_argument, NULL, 'c'},
169 {"debug", no_argument, NULL, 'd'},
170 {"streams-interface", required_argument, NULL, 's'},
171 {"ref", required_argument, NULL, 'r'},
175 static const struct option optimize_options[] = {
176 {"check", no_argument, NULL, 'c'},
177 {"recompress", no_argument, NULL, 'r'},
181 static const struct option split_options[] = {
182 {"check", no_argument, NULL, 'c'},
186 static const struct option unmount_options[] = {
187 {"commit", no_argument, NULL, 'c'},
188 {"check", no_argument, NULL, 'C'},
194 /* Print formatted error message to stderr. */
195 static void imagex_error(const char *format, ...)
198 va_start(va, format);
199 fputs("ERROR: ", stderr);
200 vfprintf(stderr, format, va);
205 /* Print formatted error message to stderr. */
206 static void imagex_error_with_errno(const char *format, ...)
208 int errno_save = errno;
210 va_start(va, format);
211 fputs("ERROR: ", stderr);
212 vfprintf(stderr, format, va);
213 fprintf(stderr, ": %s\n", strerror(errno_save));
217 static int verify_image_exists(int image, const char *image_name,
218 const char *wim_name)
220 if (image == WIMLIB_NO_IMAGE) {
221 imagex_error("\"%s\" is not a valid image in `%s'!\n"
222 " Please specify a 1-based imagex index or "
224 " You may use `imagex info' to list the images "
225 "contained in a WIM.",
226 image_name, wim_name);
232 static int verify_image_is_single(int image)
234 if (image == WIMLIB_ALL_IMAGES) {
235 imagex_error("Cannot specify all images for this action!");
241 static int verify_image_exists_and_is_single(int image, const char *image_name,
242 const char *wim_name)
245 ret = verify_image_exists(image, image_name, wim_name);
247 ret = verify_image_is_single(image);
251 static int get_compression_type(const char *optarg)
253 if (strcasecmp(optarg, "maximum") == 0 || strcasecmp(optarg, "lzx") == 0)
254 return WIMLIB_COMPRESSION_TYPE_LZX;
255 else if (strcasecmp(optarg, "fast") == 0 || strcasecmp(optarg, "xpress") == 0)
256 return WIMLIB_COMPRESSION_TYPE_XPRESS;
257 else if (strcasecmp(optarg, "none") == 0)
258 return WIMLIB_COMPRESSION_TYPE_NONE;
260 imagex_error("Invalid compression type `%s'! Must be "
261 "\"maximum\", \"fast\", or \"none\".", optarg);
262 return WIMLIB_COMPRESSION_TYPE_INVALID;
266 static off_t file_get_size(const char *filename)
269 if (stat(filename, &st) == 0)
275 static char *file_get_contents(const char *filename, size_t *len_ret)
282 if (stat(filename, &stbuf) != 0) {
283 imagex_error_with_errno("Failed to stat the file `%s'", filename);
288 fp = fopen(filename, "rb");
290 imagex_error_with_errno("Failed to open the file `%s'", filename);
296 imagex_error("Failed to allocate buffer of %zu bytes to hold "
297 "contents of file `%s'", len, filename);
300 if (fread(buf, 1, len, fp) != len) {
301 imagex_error_with_errno("Failed to read %lu bytes from the "
302 "file `%s'", len, filename);
314 static int file_writable(const char *path)
317 ret = access(path, F_OK | W_OK);
319 imagex_error_with_errno("Can't modify `%s'", path);
323 #define TO_PERCENT(numerator, denominator) \
324 (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
326 static const char *get_data_type(int ctype)
329 case WIMLIB_COMPRESSION_TYPE_NONE:
330 return "uncompressed";
331 case WIMLIB_COMPRESSION_TYPE_LZX:
332 return "LZX-compressed";
333 case WIMLIB_COMPRESSION_TYPE_XPRESS:
334 return "XPRESS-compressed";
339 static int imagex_progress_func(enum wimlib_progress_msg msg,
340 const union wimlib_progress_info *info)
342 unsigned percent_done;
344 case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
345 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
346 info->write_streams.total_bytes);
347 if (info->write_streams.completed_streams == 0) {
348 const char *data_type;
350 data_type = get_data_type(info->write_streams.compression_type);
351 printf("Writing %s data using %u thread%s\n",
352 data_type, info->write_streams.num_threads,
353 (info->write_streams.num_threads == 1) ? "" : "s");
355 printf("\r%"PRIu64" MiB of %"PRIu64" MiB (uncompressed) "
356 "written (%u%% done)",
357 info->write_streams.completed_bytes >> 20,
358 info->write_streams.total_bytes >> 20,
360 if (info->write_streams.completed_bytes == info->write_streams.total_bytes)
363 case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
364 printf("Scanning `%s'...\n", info->scan.source);
366 case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
367 if (info->scan.excluded)
368 printf("Excluding `%s' from capture\n", info->scan.cur_path);
370 printf("Scanning `%s'\n", info->scan.cur_path);
372 /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
374 case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
375 percent_done = TO_PERCENT(info->integrity.completed_bytes,
376 info->integrity.total_bytes);
377 printf("\rVerifying integrity of `%s': %"PRIu64" MiB "
378 "of %"PRIu64" MiB (%u%%) done",
379 info->integrity.filename,
380 info->integrity.completed_bytes >> 20,
381 info->integrity.total_bytes >> 20,
383 if (info->integrity.completed_bytes == info->integrity.total_bytes)
386 case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
387 percent_done = TO_PERCENT(info->integrity.completed_bytes,
388 info->integrity.total_bytes);
389 printf("\rCalculating integrity table for WIM: %"PRIu64" MiB "
390 "of %"PRIu64" MiB (%u%%) done",
391 info->integrity.completed_bytes >> 20,
392 info->integrity.total_bytes >> 20,
394 if (info->integrity.completed_bytes == info->integrity.total_bytes)
397 case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
398 /*printf("Applying image %d (%s) to `%s'\n",*/
399 /*info->extract.image,*/
400 /*info->extract.image_name,*/
401 /*info->extract.target);*/
403 /*case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:*/
404 /*printf("Done applying image %d!\n",*/
405 /*info->extract.image);*/
407 /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
408 /*printf("Applying directory structure to %s\n",*/
409 /*info->extract.target);*/
411 case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
412 percent_done = TO_PERCENT(info->extract.completed_bytes,
413 info->extract.total_bytes);
414 printf("\rExtracting files: "
415 "%"PRIu64" MiB of %"PRIu64" MiB (%u%%) done",
416 info->extract.completed_bytes >> 20,
417 info->extract.total_bytes >> 20,
419 if (info->extract.completed_bytes == info->extract.total_bytes)
422 case WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY:
423 puts(info->extract.cur_path);
425 case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
426 percent_done = TO_PERCENT(info->join.completed_bytes,
427 info->join.total_bytes);
428 printf("Writing resources from part %u of %u: "
429 "%"PRIu64 " MiB of %"PRIu64" MiB (%u%%) written\n",
430 (info->join.completed_parts == info->join.total_parts) ?
431 info->join.completed_parts : info->join.completed_parts + 1,
432 info->join.total_parts,
433 info->join.completed_bytes >> 20,
434 info->join.total_bytes >> 20,
437 case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
438 percent_done = TO_PERCENT(info->split.completed_bytes,
439 info->split.total_bytes);
440 printf("Writing `%s': %"PRIu64" MiB of %"PRIu64" MiB (%u%%) written\n",
441 info->split.part_name,
442 info->split.completed_bytes >> 20,
443 info->split.total_bytes >> 20,
446 case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
447 if (info->split.completed_bytes == info->split.total_bytes) {
448 printf("Finished writing %u split WIM parts\n",
449 info->split.cur_part_number);
460 static int open_swms_from_glob(const char *swm_glob,
461 const char *first_part,
463 WIMStruct ***additional_swms_ret,
464 unsigned *num_additional_swms_ret)
466 unsigned num_additional_swms = 0;
467 WIMStruct **additional_swms = NULL;
471 ret = glob(swm_glob, GLOB_ERR | GLOB_NOSORT, NULL, &globbuf);
473 if (ret == GLOB_NOMATCH) {
474 imagex_error("Found no files for glob \"%s\"",
477 imagex_error_with_errno("Failed to process glob "
483 num_additional_swms = globbuf.gl_pathc;
484 additional_swms = calloc(num_additional_swms, sizeof(additional_swms[0]));
485 if (!additional_swms) {
486 imagex_error("Out of memory");
491 for (unsigned i = 0; i < num_additional_swms; i++) {
492 if (strcmp(globbuf.gl_pathv[i], first_part) == 0) {
496 ret = wimlib_open_wim(globbuf.gl_pathv[i],
497 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK,
498 &additional_swms[i - offset],
499 imagex_progress_func);
503 *additional_swms_ret = additional_swms;
504 *num_additional_swms_ret = num_additional_swms - offset;
508 for (unsigned i = 0; i < num_additional_swms; i++)
509 wimlib_free(additional_swms[i]);
510 free(additional_swms);
518 static unsigned parse_num_threads(const char *optarg)
521 unsigned nthreads = strtoul(optarg, &tmp, 10);
522 if (nthreads == UINT_MAX || *tmp || tmp == optarg) {
523 imagex_error("Number of threads must be a non-negative integer!");
531 /* Extract one image, or all images, from a WIM file into a directory. */
532 static int imagex_apply(int argc, const char **argv)
535 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
542 const char *image_num_or_name;
543 int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
545 const char *swm_glob = NULL;
546 WIMStruct **additional_swms = NULL;
547 unsigned num_additional_swms = 0;
549 for_opt(c, apply_options) {
552 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
555 extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
558 extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
561 extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
573 if (argc != 2 && argc != 3) {
580 image_num_or_name = "1";
583 image_num_or_name = argv[1];
587 ret = wimlib_open_wim(wimfile, open_flags, &w, imagex_progress_func);
591 image = wimlib_resolve_image(w, image_num_or_name);
592 ret = verify_image_exists(image, image_num_or_name, wimfile);
596 num_images = wimlib_get_num_images(w);
597 if (argc == 2 && num_images != 1) {
598 imagex_error("`%s' contains %d images; Please select one "
599 "(or all)", wimfile, num_images);
606 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
608 &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);
632 ret = wimlib_extract_image(w, image, target, extract_flags,
633 additional_swms, num_additional_swms,
634 imagex_progress_func);
637 if (additional_swms) {
638 for (unsigned i = 0; i < num_additional_swms; i++)
639 wimlib_free(additional_swms[i]);
640 free(additional_swms);
645 static int imagex_capture_or_append(int argc, const char **argv)
649 int add_image_flags = 0;
651 int compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
656 const char *flags_element = NULL;
657 const char *config_file = NULL;
658 char *config_str = NULL;
659 size_t config_len = 0;
664 int cmd = strcmp(argv[0], "append") ? CAPTURE : APPEND;
665 unsigned num_threads = 0;
667 for_opt(c, capture_or_append_options) {
670 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
673 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
674 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
677 config_file = optarg;
680 compression_type = get_compression_type(optarg);
681 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
685 flags_element = optarg;
688 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
691 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
694 num_threads = parse_num_threads(optarg);
695 if (num_threads == UINT_MAX)
699 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
708 if (argc < 2 || argc > 4) {
715 char source_copy[strlen(source) + 1];
716 memcpy(source_copy, source, strlen(source) + 1);
717 default_name = basename(source_copy);
719 name = (argc >= 3) ? argv[2] : default_name;
720 desc = (argc >= 4) ? argv[3] : NULL;
723 config_str = file_get_contents(config_file, &config_len);
729 ret = wimlib_open_wim(wimfile, open_flags, &w,
730 imagex_progress_func);
732 ret = wimlib_create_new_wim(compression_type, &w);
739 ret = stat(source, &stbuf);
741 if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
742 printf("Capturing WIM image from NTFS filesystem on `%s'\n",
744 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
747 if (errno != ENOENT) {
748 imagex_error_with_errno("Failed to stat `%s'", source);
754 ret = wimlib_add_image(w, source, name, config_str, config_len,
755 add_image_flags, imagex_progress_func);
759 cur_image = wimlib_get_num_images(w);
761 ret = wimlib_set_image_descripton(w, cur_image, desc);
766 ret = wimlib_set_image_flags(w, cur_image, flags_element);
771 ret = wimlib_overwrite(w, write_flags, num_threads,
772 imagex_progress_func);
774 ret = wimlib_write(w, wimfile, WIMLIB_ALL_IMAGES, write_flags,
775 num_threads, imagex_progress_func);
777 if (ret == WIMLIB_ERR_REOPEN)
780 imagex_error("Failed to write the WIM file `%s'", wimfile);
787 /* Remove image(s) from a WIM. */
788 static int imagex_delete(int argc, const char **argv)
794 const char *image_num_or_name;
799 for_opt(c, delete_options) {
802 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
803 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
806 write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
818 imagex_error("Must specify a WIM file");
820 imagex_error("Must specify an image");
825 image_num_or_name = argv[1];
827 ret = file_writable(wimfile);
831 ret = wimlib_open_wim(wimfile, open_flags, &w,
832 imagex_progress_func);
836 image = wimlib_resolve_image(w, image_num_or_name);
838 ret = verify_image_exists(image, image_num_or_name, wimfile);
842 ret = wimlib_delete_image(w, image);
844 imagex_error("Failed to delete image from `%s'", wimfile);
848 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
849 if (ret == WIMLIB_ERR_REOPEN)
852 imagex_error("Failed to write the file `%s' with image "
860 /* Print the files contained in an image(s) in a WIM file. */
861 static int imagex_dir(int argc, const char **argv)
870 imagex_error("Must specify a WIM file");
875 imagex_error("Too many arguments");
881 ret = wimlib_open_wim(wimfile, WIMLIB_OPEN_FLAG_SPLIT_OK, &w,
882 imagex_progress_func);
887 image = wimlib_resolve_image(w, argv[2]);
888 ret = verify_image_exists(image, argv[2], wimfile);
892 /* Image was not specified. If the WIM only contains one image,
893 * choose that one; otherwise, print an error. */
894 num_images = wimlib_get_num_images(w);
895 if (num_images != 1) {
896 imagex_error("The file `%s' contains %d images; Please "
897 "select one.", wimfile, num_images);
905 ret = wimlib_print_files(w, image);
911 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
913 static int imagex_export(int argc, const char **argv)
917 int export_flags = 0;
919 int compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
920 bool compression_type_specified = false;
921 const char *src_wimfile;
922 const char *src_image_num_or_name;
923 const char *dest_wimfile;
924 const char *dest_name;
925 const char *dest_desc;
926 WIMStruct *src_w = NULL;
927 WIMStruct *dest_w = NULL;
932 const char *swm_glob = NULL;
933 WIMStruct **additional_swms = NULL;
934 unsigned num_additional_swms = 0;
935 unsigned num_threads = 0;
937 for_opt(c, export_options) {
940 export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
943 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
944 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
947 compression_type = get_compression_type(optarg);
948 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
950 compression_type_specified = true;
956 num_threads = parse_num_threads(optarg);
957 if (num_threads == UINT_MAX)
961 write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
970 if (argc < 3 || argc > 5) {
974 src_wimfile = argv[0];
975 src_image_num_or_name = argv[1];
976 dest_wimfile = argv[2];
977 dest_name = (argc >= 4) ? argv[3] : NULL;
978 dest_desc = (argc >= 5) ? argv[4] : NULL;
979 ret = wimlib_open_wim(src_wimfile,
980 open_flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &src_w,
981 imagex_progress_func);
985 /* Determine if the destination is an existing file or not.
986 * If so, we try to append the exported image(s) to it; otherwise, we
987 * create a new WIM containing the exported image(s). */
988 if (stat(dest_wimfile, &stbuf) == 0) {
992 /* Destination file exists. */
993 if (!S_ISREG(stbuf.st_mode) && !S_ISLNK(stbuf.st_mode)) {
994 imagex_error("`%s' is not a regular file",
999 ret = wimlib_open_wim(dest_wimfile, open_flags, &dest_w,
1000 imagex_progress_func);
1004 ret = file_writable(dest_wimfile);
1008 dest_ctype = wimlib_get_compression_type(dest_w);
1009 if (compression_type_specified
1010 && compression_type != dest_ctype)
1012 imagex_error("Cannot specify a compression type that is "
1013 "not the same as that used in the "
1018 compression_type = dest_ctype;
1021 /* dest_wimfile is not an existing file, so create a new WIM. */
1022 if (!compression_type_specified)
1023 compression_type = wimlib_get_compression_type(src_w);
1024 if (errno == ENOENT) {
1025 ret = wimlib_create_new_wim(compression_type, &dest_w);
1029 imagex_error_with_errno("Cannot stat file `%s'",
1036 image = wimlib_resolve_image(src_w, src_image_num_or_name);
1037 ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
1042 ret = open_swms_from_glob(swm_glob, src_wimfile, open_flags,
1044 &num_additional_swms);
1049 ret = wimlib_export_image(src_w, image, dest_w, dest_name, dest_desc,
1050 export_flags, additional_swms,
1051 num_additional_swms, imagex_progress_func);
1057 ret = wimlib_write(dest_w, dest_wimfile, WIMLIB_ALL_IMAGES,
1058 write_flags, num_threads,
1059 imagex_progress_func);
1061 ret = wimlib_overwrite(dest_w, write_flags, num_threads,
1062 imagex_progress_func);
1064 if (ret == WIMLIB_ERR_REOPEN)
1067 wimlib_free(dest_w);
1068 if (additional_swms) {
1069 for (unsigned i = 0; i < num_additional_swms; i++)
1070 wimlib_free(additional_swms[i]);
1071 free(additional_swms);
1076 /* Prints information about a WIM file; also can mark an image as bootable,
1077 * change the name of an image, or change the description of an image. */
1078 static int imagex_info(int argc, const char **argv)
1083 bool header = false;
1084 bool lookup_table = false;
1086 bool metadata = false;
1087 bool short_header = true;
1088 const char *xml_out_file = NULL;
1089 const char *wimfile;
1090 const char *image_num_or_name = "all";
1091 const char *new_name = NULL;
1092 const char *new_desc = NULL;
1097 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1101 for_opt(c, info_options) {
1111 short_header = false;
1114 lookup_table = true;
1115 short_header = false;
1119 short_header = false;
1122 xml_out_file = optarg;
1123 short_header = false;
1127 short_header = false;
1137 if (argc == 0 || argc > 4) {
1143 image_num_or_name = argv[1];
1153 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1155 ret = wimlib_open_wim(wimfile, open_flags, &w,
1156 imagex_progress_func);
1160 part_number = wimlib_get_part_number(w, &total_parts);
1162 image = wimlib_resolve_image(w, image_num_or_name);
1163 if (image == WIMLIB_NO_IMAGE && strcmp(image_num_or_name, "0") != 0) {
1164 imagex_error("The image `%s' does not exist",
1167 imagex_error("If you would like to set the boot "
1168 "index to 0, specify image \"0\" with "
1169 "the --boot flag.");
1170 ret = WIMLIB_ERR_INVALID_IMAGE;
1174 if (image == WIMLIB_ALL_IMAGES && wimlib_get_num_images(w) > 1) {
1176 imagex_error("Cannot specify the --boot flag "
1177 "without specifying a specific "
1178 "image in a multi-image WIM");
1179 ret = WIMLIB_ERR_INVALID_IMAGE;
1183 imagex_error("Cannot specify the NEW_NAME "
1184 "without specifying a specific "
1185 "image in a multi-image WIM");
1186 ret = WIMLIB_ERR_INVALID_IMAGE;
1191 /* Operations that print information are separated from operations that
1192 * recreate the WIM file. */
1193 if (!new_name && !boot) {
1195 /* Read-only operations */
1197 if (image == WIMLIB_NO_IMAGE) {
1198 imagex_error("`%s' is not a valid image",
1200 ret = WIMLIB_ERR_INVALID_IMAGE;
1204 if (image == WIMLIB_ALL_IMAGES && short_header)
1205 wimlib_print_wim_information(w);
1208 wimlib_print_header(w);
1211 if (total_parts != 1) {
1212 printf("Warning: Only showing the lookup table "
1213 "for part %d of a %d-part WIM.\n",
1214 part_number, total_parts);
1216 wimlib_print_lookup_table(w);
1220 ret = wimlib_extract_xml_data(w, stdout);
1226 fp = fopen(xml_out_file, "wb");
1228 imagex_error_with_errno("Failed to open the "
1234 ret = wimlib_extract_xml_data(w, fp);
1235 if (fclose(fp) != 0) {
1236 imagex_error("Failed to close the file `%s'",
1246 wimlib_print_available_images(w, image);
1249 ret = wimlib_print_metadata(w, image);
1255 /* Modification operations */
1256 if (total_parts != 1) {
1257 imagex_error("Modifying a split WIM is not supported.");
1260 if (image == WIMLIB_ALL_IMAGES)
1263 if (image == WIMLIB_NO_IMAGE && new_name) {
1264 imagex_error("Cannot specify new_name (`%s') when "
1265 "using image 0", new_name);
1270 if (image == wimlib_get_boot_idx(w)) {
1271 printf("Image %d is already marked as "
1272 "bootable.\n", image);
1275 printf("Marking image %d as bootable.\n",
1277 wimlib_set_boot_idx(w, image);
1281 if (strcmp(wimlib_get_image_name(w, image),
1283 printf("Image %d is already named \"%s\".\n",
1287 printf("Changing the name of image %d to "
1288 "\"%s\".\n", image, new_name);
1289 ret = wimlib_set_image_name(w, image, new_name);
1295 const char *old_desc;
1296 old_desc = wimlib_get_image_description(w, image);
1297 if (old_desc && strcmp(old_desc, new_desc) == 0) {
1298 printf("The description of image %d is already "
1299 "\"%s\".\n", image, new_desc);
1302 printf("Changing the description of image %d "
1303 "to \"%s\".\n", image, new_desc);
1304 ret = wimlib_set_image_descripton(w, image,
1311 /* Only call wimlib_overwrite() if something actually needs to
1313 if (boot || new_name || new_desc ||
1314 check != wimlib_has_integrity_table(w)) {
1316 ret = file_writable(wimfile);
1322 write_flags = WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1327 ret = wimlib_overwrite(w, write_flags, 1,
1328 imagex_progress_func);
1329 if (ret == WIMLIB_ERR_REOPEN)
1332 printf("The file `%s' was not modified because nothing "
1333 "needed to be done.\n", wimfile);
1342 /* Join split WIMs into one part WIM */
1343 static int imagex_join(int argc, const char **argv)
1346 int swm_open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1347 int wim_write_flags = 0;
1348 const char *output_path;
1350 for_opt(c, join_options) {
1353 swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1354 wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1364 imagex_error("Must specify one or more split WIM (.swm) parts "
1368 output_path = argv[0];
1369 return wimlib_join(++argv, --argc, output_path, swm_open_flags,
1370 wim_write_flags, imagex_progress_func);
1376 /* Mounts an image using a FUSE mount. */
1377 static int imagex_mount_rw_or_ro(int argc, const char **argv)
1380 int mount_flags = 0;
1381 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1382 const char *wimfile;
1388 const char *swm_glob = NULL;
1389 WIMStruct **additional_swms = NULL;
1390 unsigned num_additional_swms = 0;
1392 if (strcmp(argv[0], "mountrw") == 0)
1393 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
1395 for_opt(c, mount_options) {
1398 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1401 mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
1404 if (strcasecmp(optarg, "none") == 0)
1405 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
1406 else if (strcasecmp(optarg, "xattr") == 0)
1407 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
1408 else if (strcasecmp(optarg, "windows") == 0)
1409 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
1411 imagex_error("Unknown stream interface \"%s\"", optarg);
1424 if (argc != 2 && argc != 3)
1429 ret = wimlib_open_wim(wimfile, open_flags, &w,
1430 imagex_progress_func);
1435 ret = open_swms_from_glob(swm_glob, wimfile, open_flags,
1437 &num_additional_swms);
1444 num_images = wimlib_get_num_images(w);
1445 if (num_images != 1) {
1446 imagex_error("The file `%s' contains %d images; Please "
1447 "select one.", wimfile, num_images);
1448 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1455 image = wimlib_resolve_image(w, argv[1]);
1457 ret = verify_image_exists_and_is_single(image, argv[1], wimfile);
1462 if (mount_flags & WIMLIB_MOUNT_FLAG_READWRITE) {
1463 ret = file_writable(wimfile);
1468 ret = wimlib_mount_image(w, image, dir, mount_flags, additional_swms,
1469 num_additional_swms, NULL);
1471 imagex_error("Failed to mount image %d from `%s' on `%s'",
1472 image, wimfile, dir);
1477 if (additional_swms) {
1478 for (unsigned i = 0; i < num_additional_swms; i++)
1479 wimlib_free(additional_swms[i]);
1480 free(additional_swms);
1484 usage((mount_flags & WIMLIB_MOUNT_FLAG_READWRITE)
1489 static int imagex_optimize(int argc, const char **argv)
1493 int write_flags = WIMLIB_WRITE_FLAG_REBUILD;
1496 const char *wimfile;
1500 for_opt(c, optimize_options) {
1503 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1504 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1507 write_flags |= WIMLIB_WRITE_FLAG_RECOMPRESS;
1524 ret = wimlib_open_wim(wimfile, open_flags, &w,
1525 imagex_progress_func);
1529 old_size = file_get_size(argv[0]);
1530 printf("`%s' original size: ", wimfile);
1534 printf("%"PRIu64" KiB\n", old_size >> 10);
1536 ret = wimlib_overwrite(w, write_flags, 0, imagex_progress_func);
1538 new_size = file_get_size(argv[0]);
1539 printf("`%s' optimized size: ", wimfile);
1543 printf("%"PRIu64" KiB\n", new_size >> 10);
1545 fputs("Space saved: ", stdout);
1546 if (new_size != -1 && old_size != -1) {
1547 printf("%lld KiB\n",
1548 ((long long)old_size - (long long)new_size) >> 10);
1557 /* Split a WIM into a spanned set */
1558 static int imagex_split(int argc, const char **argv)
1561 int open_flags = WIMLIB_OPEN_FLAG_SPLIT_OK;
1562 int write_flags = 0;
1563 unsigned long part_size;
1568 for_opt(c, split_options) {
1571 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1572 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1586 part_size = strtod(argv[2], &tmp) * (1 << 20);
1587 if (tmp == argv[2] || *tmp) {
1588 imagex_error("Invalid part size \"%s\"", argv[2]);
1589 imagex_error("The part size must be an integer or floating-point number of megabytes.");
1592 ret = wimlib_open_wim(argv[0], open_flags, &w, imagex_progress_func);
1595 ret = wimlib_split(w, argv[1], part_size, write_flags, imagex_progress_func);
1600 /* Unmounts an image. */
1601 static int imagex_unmount(int argc, const char **argv)
1604 int unmount_flags = 0;
1607 for_opt(c, unmount_options) {
1610 unmount_flags |= WIMLIB_UNMOUNT_FLAG_COMMIT;
1613 unmount_flags |= WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY;
1627 ret = wimlib_unmount_image(argv[0], unmount_flags,
1628 imagex_progress_func);
1630 imagex_error("Failed to unmount `%s'", argv[0]);
1634 struct imagex_command {
1636 int (*func)(int , const char **);
1641 #define for_imagex_command(p) for (p = &imagex_commands[0]; \
1642 p != &imagex_commands[ARRAY_LEN(imagex_commands)]; p++)
1644 static const struct imagex_command imagex_commands[] = {
1645 {"append", imagex_capture_or_append, APPEND},
1646 {"apply", imagex_apply, APPLY},
1647 {"capture", imagex_capture_or_append, CAPTURE},
1648 {"delete", imagex_delete, DELETE},
1649 {"dir", imagex_dir, DIR},
1650 {"export", imagex_export, EXPORT},
1651 {"info", imagex_info, INFO},
1652 {"join", imagex_join, JOIN},
1653 {"mount", imagex_mount_rw_or_ro, MOUNT},
1654 {"mountrw", imagex_mount_rw_or_ro, MOUNTRW},
1655 {"optimize",imagex_optimize, OPTIMIZE},
1656 {"split", imagex_split, SPLIT},
1657 {"unmount", imagex_unmount, UNMOUNT},
1660 static void version()
1662 static const char *s =
1663 "imagex (" PACKAGE ") " PACKAGE_VERSION "\n"
1664 "Copyright (C) 2012 Eric Biggers\n"
1665 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
1666 "This is free software: you are free to change and redistribute it.\n"
1667 "There is NO WARRANTY, to the extent permitted by law.\n"
1669 "Report bugs to "PACKAGE_BUGREPORT".\n";
1674 static void help_or_version(int argc, const char **argv)
1678 const struct imagex_command *cmd;
1680 for (i = 1; i < argc; i++) {
1688 if (strcmp(p, "help") == 0) {
1689 for_imagex_command(cmd) {
1690 if (strcmp(cmd->name, argv[1]) == 0) {
1698 if (strcmp(p, "version") == 0) {
1706 static void usage(int cmd_type)
1708 const struct imagex_command *cmd;
1709 printf("Usage: %s", usage_strings[cmd_type]);
1710 for_imagex_command(cmd) {
1711 if (cmd->cmd == cmd_type)
1712 printf("\nTry `man imagex-%s' for more details.\n",
1717 static void usage_all()
1719 puts("IMAGEX: Usage:");
1720 for (int i = 0; i < ARRAY_LEN(usage_strings); i++)
1721 printf(" %s", usage_strings[i]);
1722 static const char *extra =
1724 " imagex --version\n"
1726 " The compression TYPE may be \"maximum\", \"fast\", or \"none\".\n"
1728 " Try `man imagex' for more information.\n"
1730 fputs(extra, stdout);
1734 int main(int argc, const char **argv)
1736 const struct imagex_command *cmd;
1740 imagex_error("No command specified");
1745 help_or_version(argc, argv);
1749 wimlib_set_print_errors(true);
1751 for_imagex_command(cmd) {
1752 if (strcmp(cmd->name, *argv) == 0) {
1753 ret = cmd->func(argc, argv);
1755 imagex_error("Exiting with error code %d:\n"
1757 wimlib_get_error_string(ret));
1758 if (ret == WIMLIB_ERR_NTFS_3G)
1759 imagex_error_with_errno("errno");
1765 imagex_error("Unrecognized command: `%s'", argv[0]);