]> wimlib.net Git - wimlib/blobdiff - programs/imagex.c
Initial support for resuming extraction from split pipable WIMs
[wimlib] / programs / imagex.c
index 7433347b69c30257592057aae24fb2e29ec90fe2..977f21be48c2cb714e8d3191f0b9a0400c0e6823 100644 (file)
@@ -65,12 +65,22 @@ static inline void set_fd_to_binary_mode(int fd)
 }
 #endif /* !__WIN32 */
 
+/* Don't confuse the user by presenting the mounting commands on Windows when
+ * they will never work.  However on UNIX-like systems we always present them,
+ * even if WITH_FUSE is not defined at this point, as to not tie the build of
+ * wimlib-imagex to a specific build of wimlib.  */
+#ifdef __WIN32__
+#  define WIM_MOUNTING_SUPPORTED 0
+#else
+#  define WIM_MOUNTING_SUPPORTED 1
+#endif
 
 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
 
 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
                                opts, NULL)) != -1)
 
+
 enum {
        CMD_NONE = -1,
        CMD_APPEND = 0,
@@ -82,11 +92,15 @@ enum {
        CMD_EXTRACT,
        CMD_INFO,
        CMD_JOIN,
+#if WIM_MOUNTING_SUPPORTED
        CMD_MOUNT,
        CMD_MOUNTRW,
+#endif
        CMD_OPTIMIZE,
        CMD_SPLIT,
+#if WIM_MOUNTING_SUPPORTED
        CMD_UNMOUNT,
+#endif
        CMD_UPDATE,
        CMD_MAX,
 };
@@ -132,6 +146,7 @@ enum {
        IMAGEX_RECOMPRESS_OPTION,
        IMAGEX_RECURSIVE_OPTION,
        IMAGEX_REF_OPTION,
+       IMAGEX_RESUME_OPTION,
        IMAGEX_RPFIX_OPTION,
        IMAGEX_SOFT_OPTION,
        IMAGEX_SOURCE_LIST_OPTION,
@@ -159,6 +174,7 @@ static const struct option apply_options[] = {
        {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
        {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
        {T("include-invalid-names"), no_argument,       NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
+       {T("resume"),      no_argument,       NULL, IMAGEX_RESUME_OPTION},
        {NULL, 0, NULL, 0},
 };
 
@@ -971,6 +987,7 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
                percent_done = TO_PERCENT(info->write_streams.completed_bytes,
                                          info->write_streams.total_bytes);
+
                if (info->write_streams.completed_streams == 0) {
                        const tchar *data_type;
 
@@ -979,13 +996,28 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                                data_type, info->write_streams.num_threads,
                                (info->write_streams.num_threads == 1) ? T("") : T("s"));
                }
-               imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
-                       "written (%u%% done)"),
-                       info->write_streams.completed_bytes >> unit_shift,
-                       unit_name,
-                       info->write_streams.total_bytes >> unit_shift,
-                       unit_name,
-                       percent_done);
+               if (info->write_streams.total_parts <= 1) {
+                       imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
+                               "written (%u%% done)"),
+                               info->write_streams.completed_bytes >> unit_shift,
+                               unit_name,
+                               info->write_streams.total_bytes >> unit_shift,
+                               unit_name,
+                               percent_done);
+               } else {
+                       imagex_printf(T("\rWriting resources from part %u of %u: "
+                                 "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
+                               (info->write_streams.completed_parts ==
+                                       info->write_streams.total_parts) ?
+                                               info->write_streams.completed_parts :
+                                               info->write_streams.completed_parts + 1,
+                               info->write_streams.total_parts,
+                               info->write_streams.completed_bytes >> unit_shift,
+                               unit_name,
+                               info->write_streams.total_bytes >> unit_shift,
+                               unit_name,
+                               percent_done);
+               }
                if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
                        imagex_printf(T("\n"));
                break;
@@ -1005,8 +1037,6 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                else
                        imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
                break;
-       /*case WIMLIB_PROGRESS_MSG_SCAN_END:*/
-               /*break;*/
        case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
                unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
                percent_done = TO_PERCENT(info->integrity.completed_bytes,
@@ -1056,10 +1086,6 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                        info->extract.wimfile_name,
                        info->extract.target);
                break;
-       /*case WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN:*/
-               /*imagex_printf(T("Applying directory structure to %"TS"\n"),*/
-                       /*info->extract.target);*/
-               /*break;*/
        case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
                percent_done = TO_PERCENT(info->extract.completed_bytes,
                                          info->extract.total_bytes);
@@ -1084,21 +1110,6 @@ imagex_progress_func(enum wimlib_progress_msg msg,
                                info->extract.target);
                }
                break;
-       case WIMLIB_PROGRESS_MSG_JOIN_STREAMS:
-               percent_done = TO_PERCENT(info->join.completed_bytes,
-                                         info->join.total_bytes);
-               unit_shift = get_unit(info->join.total_bytes, &unit_name);
-               imagex_printf(T("Writing resources from part %u of %u: "
-                         "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written\n"),
-                       (info->join.completed_parts == info->join.total_parts) ?
-                       info->join.completed_parts : info->join.completed_parts + 1,
-                       info->join.total_parts,
-                       info->join.completed_bytes >> unit_shift,
-                       unit_name,
-                       info->join.total_bytes >> unit_shift,
-                       unit_name,
-                       percent_done);
-               break;
        case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
                percent_done = TO_PERCENT(info->split.completed_bytes,
                                          info->split.total_bytes);
@@ -1487,6 +1498,9 @@ imagex_apply(int argc, tchar **argv, int cmd)
                        extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
                        extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
                        break;
+               case IMAGEX_RESUME_OPTION:
+                       extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
+                       break;
                default:
                        goto out_usage;
                }
@@ -1500,14 +1514,13 @@ imagex_apply(int argc, tchar **argv, int cmd)
 
        if (!tstrcmp(wimfile, T("-"))) {
                /* Attempt to apply pipable WIM from standard input.  */
-               if (argc < 3) {
-                       imagex_error(T("Imagex index or name must be explicitly "
-                                      "specified when applying pipable WIM on "
-                                      "standard input."));
-                       goto out_usage;
+               if (argc == 2) {
+                       image_num_or_name = NULL;
+                       target = argv[1];
+               } else {
+                       image_num_or_name = argv[1];
+                       target = argv[2];
                }
-               image_num_or_name = argv[1];
-               target = argv[2];
                wim = NULL;
                num_additional_swms = 0;
                additional_swms = NULL;
@@ -1574,9 +1587,6 @@ imagex_apply(int argc, tchar **argv, int cmd)
        }
 #endif
 
-#ifdef __WIN32__
-       win32_acquire_restore_privileges();
-#endif
        if (wim) {
                ret = wimlib_extract_image(wim, image, target, extract_flags,
                                           additional_swms, num_additional_swms,
@@ -1590,9 +1600,6 @@ imagex_apply(int argc, tchar **argv, int cmd)
        }
        if (ret == 0)
                imagex_printf(T("Done applying WIM image.\n"));
-#ifdef __WIN32__
-       win32_release_restore_privileges();
-#endif
 out_free_swms:
        for (unsigned i = 0; i < num_additional_swms; i++)
                wimlib_free(additional_swms[i]);
@@ -1851,10 +1858,6 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
                        tsprintf(name_end, T(" (%lu)"), conflict_idx);
                }
        }
-#ifdef __WIN32__
-       win32_acquire_capture_privileges();
-#endif
-
        ret = wimlib_add_image_multisource(wim,
                                           capture_sources,
                                           num_sources,
@@ -1863,7 +1866,7 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
                                           add_image_flags,
                                           imagex_progress_func);
        if (ret)
-               goto out_release_privs;
+               goto out_wimlib_free;
 
        if (desc || flags_element) {
                /* User provided <DESCRIPTION> or <FLAGS> element.  Get the
@@ -1878,14 +1881,14 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
                                                          info.image_count,
                                                          desc);
                        if (ret)
-                               goto out_release_privs;
+                               goto out_wimlib_free;
                }
 
                if (flags_element) {
                        ret = wimlib_set_image_flags(wim, info.image_count,
                                                     flags_element);
                        if (ret)
-                               goto out_release_privs;
+                               goto out_wimlib_free;
                }
        }
 
@@ -1903,10 +1906,6 @@ imagex_capture_or_append(int argc, tchar **argv, int cmd)
                                         write_flags, num_threads,
                                         imagex_progress_func);
        }
-out_release_privs:
-#ifdef __WIN32__
-       win32_release_capture_privileges();
-#endif
 out_wimlib_free:
        wimlib_free(wim);
 out_free_config:
@@ -2454,10 +2453,6 @@ imagex_extract(int argc, tchar **argv, int cmd)
                num_additional_swms = 0;
        }
 
-#ifdef __WIN32__
-       win32_acquire_restore_privileges();
-#endif
-
        ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
                                   additional_swms, num_additional_swms,
                                   imagex_progress_func);
@@ -2470,9 +2465,6 @@ imagex_extract(int argc, tchar **argv, int cmd)
                                   "      are in the WIM image.\n"),
                                get_cmd_string(CMD_INFO, false));
        }
-#ifdef __WIN32__
-       win32_release_restore_privileges();
-#endif
        for (unsigned i = 0; i < num_additional_swms; i++)
                wimlib_free(additional_swms[i]);
        free(additional_swms);
@@ -2882,7 +2874,9 @@ out_usage:
        goto out;
 }
 
-/* Mounts an image using a FUSE mount. */
+#if WIM_MOUNTING_SUPPORTED
+
+/* Mounts a WIM image.  */
 static int
 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
 {
@@ -3006,6 +3000,7 @@ out_usage:
        ret = -1;
        goto out;
 }
+#endif /* WIM_MOUNTING_SUPPORTED */
 
 /* Rebuild a WIM file */
 static int
@@ -3152,6 +3147,7 @@ out_err:
        goto out;
 }
 
+#if WIM_MOUNTING_SUPPORTED
 /* Unmounts a mounted WIM image. */
 static int
 imagex_unmount(int argc, tchar **argv, int cmd)
@@ -3195,6 +3191,7 @@ out_usage:
        ret = -1;
        goto out;
 }
+#endif /* WIM_MOUNTING_SUPPORTED */
 
 /*
  * Add, delete, or rename files in a WIM image.
@@ -3379,25 +3376,16 @@ imagex_update(int argc, tchar **argv, int cmd)
                }
        }
 
-#ifdef __WIN32__
-       if (have_add_command)
-               win32_acquire_capture_privileges();
-#endif
-
        /* Execute the update commands */
        ret = wimlib_update_image(wim, image, cmds, num_cmds, update_flags,
                                  imagex_progress_func);
        if (ret)
-               goto out_release_privs;
+               goto out_free_cmds;
 
        /* Overwrite the updated WIM */
        ret = wimlib_overwrite(wim, write_flags, num_threads,
                               imagex_progress_func);
-out_release_privs:
-#ifdef __WIN32__
-       if (have_add_command)
-               win32_release_capture_privileges();
-#endif
+out_free_cmds:
        free(cmds);
 out_free_cmd_file_contents:
        free(cmd_file_contents);
@@ -3437,39 +3425,43 @@ static const struct imagex_command imagex_commands[] = {
        [CMD_EXTRACT]  = {T("extract"),  imagex_extract},
        [CMD_INFO]     = {T("info"),     imagex_info},
        [CMD_JOIN]     = {T("join"),     imagex_join},
+#if WIM_MOUNTING_SUPPORTED
        [CMD_MOUNT]    = {T("mount"),    imagex_mount_rw_or_ro},
        [CMD_MOUNTRW]  = {T("mountrw"),  imagex_mount_rw_or_ro},
+#endif
        [CMD_OPTIMIZE] = {T("optimize"), imagex_optimize},
        [CMD_SPLIT]    = {T("split"),    imagex_split},
+#if WIM_MOUNTING_SUPPORTED
        [CMD_UNMOUNT]  = {T("unmount"),  imagex_unmount},
+#endif
        [CMD_UPDATE]   = {T("update"),   imagex_update},
 };
 
 static const tchar *usage_strings[] = {
 [CMD_APPEND] =
 T(
-"    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
-"                    [DESCRIPTION] [--boot] [--check] [--nocheck]\n"
-"                    [--flags EDITION_ID] [--verbose] [--dereference]\n"
-"                    [--config=FILE] [--threads=NUM_THREADS] [--rebuild]\n"
-"                    [--unix-data] [--source-list] [--no-acls]\n"
+"    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
+"                    [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
+"                    [--nocheck] [--flags EDITION_ID] [--verbose]\n"
+"                    [--dereference] [--config=FILE] [--threads=NUM_THREADS]\n"
+"                    [--rebuild] [--unix-data] [--source-list] [--no-acls]\n"
 "                    [--strict-acls] [--rpfix] [--norpfix] [--pipable]\n"
 "                    [--not-pipable]\n"
 ),
 [CMD_APPLY] =
 T(
-"    %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME | all]\n"
+"    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME | all)]\n"
 "                    (DIRECTORY | NTFS_VOLUME) [--check] [--hardlink]\n"
 "                    [--symlink] [--verbose] [--ref=\"GLOB\"] [--unix-data]\n"
 "                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
-"                    [--include-invalid-names]\n"
+"                    [--include-invalid-names] [--resume]\n"
 ),
 [CMD_CAPTURE] =
 T(
-"    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE [IMAGE_NAME]\n"
-"                    [DESCRIPTION] [--boot] [--check] [--nocheck]\n"
-"                    [--compress=TYPE] [--flags EDITION_ID] [--verbose]\n"
-"                    [--dereference] [--config=FILE]\n"
+"    %"TS" (DIRECTORY | NTFS_VOLUME) WIMFILE\n"
+"                   [IMAGE_NAME [IMAGE_DESCRIPTION]] [--boot] [--check]\n"
+"                    [--nocheck] [--compress=TYPE] [--flags EDITION_ID]\n"
+"                    [--verbose] [--dereference] [--config=FILE]\n"
 "                    [--threads=NUM_THREADS] [--unix-data] [--source-list]\n"
 "                    [--no-acls] [--strict-acls] [--rpfix] [--norpfix]\n"
 "                    [--pipable] [--not-pipable]\n"
@@ -3486,7 +3478,7 @@ T(
 [CMD_EXPORT] =
 T(
 "    %"TS" SRC_WIMFILE (SRC_IMAGE_NUM | SRC_IMAGE_NAME | all ) \n"
-"                    DEST_WIMFILE [DEST_IMAGE_NAME] [DEST_IMAGE_DESCRIPTION]\n"
+"                    DEST_WIMFILE [DEST_IMAGE_NAME [DEST_IMAGE_DESCRIPTION]]\n"
 "                    [--boot] [--check] [--nocheck] [--compress=TYPE]\n"
 "                    [--ref=\"GLOB\"] [--threads=NUM_THREADS] [--rebuild]\n"
 "                    [--pipable] [--not-pipable]\n"
@@ -3495,32 +3487,34 @@ T(
 T(
 "    %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) [PATH...]\n"
 "                    [--check] [--ref=\"GLOB\"] [--verbose] [--unix-data]\n"
-"                    [--no-acls] [--strict-acls] [--to-stdout] [--dest-dir=CMD_DIR]\n"
-"                    [--include-invalid-names]\n"
+"                    [--no-acls] [--strict-acls] [--to-stdout]\n"
+"                    [--dest-dir=CMD_DIR] [--include-invalid-names]\n"
 ),
 [CMD_INFO] =
 T(
-"    %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [NEW_NAME]\n"
-"                    [NEW_DESC] [--boot] [--check] [--nocheck] [--header]\n"
+"    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME) [NEW_NAME\n"
+"                    [NEW_DESC]]] [--boot] [--check] [--nocheck] [--header]\n"
 "                    [--lookup-table] [--xml] [--extract-xml FILE]\n"
 "                    [--metadata]\n"
 ),
 [CMD_JOIN] =
 T(
-"    %"TS" [--check] WIMFILE SPLIT_WIM...\n"
+"    %"TS" OUT_WIMFILE SPLIT_WIM_PART... [--check]\n"
 ),
+#if WIM_MOUNTING_SUPPORTED
 [CMD_MOUNT] =
 T(
-"    %"TS" WIMFILE (IMAGE_NUM | IMAGE_NAME) DIRECTORY\n"
+"    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
 "                    [--check] [--debug] [--streams-interface=INTERFACE]\n"
 "                    [--ref=\"GLOB\"] [--unix-data] [--allow-other]\n"
 ),
 [CMD_MOUNTRW] =
 T(
-"    %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] DIRECTORY\n"
+"    %"TS" WIMFILE [(IMAGE_NUM | IMAGE_NAME)] DIRECTORY\n"
 "                    [--check] [--debug] [--streams-interface=INTERFACE]\n"
 "                    [--staging-dir=CMD_DIR] [--unix-data] [--allow-other]\n"
 ),
+#endif
 [CMD_OPTIMIZE] =
 T(
 "    %"TS" WIMFILE [--check] [--nocheck] [--recompress]\n"
@@ -3528,12 +3522,14 @@ T(
 ),
 [CMD_SPLIT] =
 T(
-"    %"TS" WIMFILE SPLIT_WIMFILE PART_SIZE_MB [--check]\n"
+"    %"TS" WIMFILE SPLIT_WIM_PART_1 PART_SIZE_MB [--check]\n"
 ),
+#if WIM_MOUNTING_SUPPORTED
 [CMD_UNMOUNT] =
 T(
 "    %"TS" DIRECTORY [--commit] [--check] [--rebuild] [--lazy]\n"
 ),
+#endif
 [CMD_UPDATE] =
 T(
 "    %"TS" WIMFILE [IMAGE_NUM | IMAGE_NAME] [--check] [--rebuild]\n"
@@ -3566,9 +3562,9 @@ static const tchar *get_cmd_string(int cmd, bool nospace)
 static void
 version(void)
 {
-       static const tchar *format =
+       static const tchar *s =
        T(
-"%"TS" (" PACKAGE ") " PACKAGE_VERSION "\n"
+IMAGEX_PROGNAME " (" PACKAGE ") " PACKAGE_VERSION "\n"
 "Copyright (C) 2012, 2013 Eric Biggers\n"
 "License GPLv3+; GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n"
 "This is free software: you are free to change and redistribute it.\n"
@@ -3576,7 +3572,7 @@ version(void)
 "\n"
 "Report bugs to "PACKAGE_BUGREPORT".\n"
        );
-       tprintf(format, invocation_name);
+       tfputs(s, stdout);
 }
 
 
@@ -3667,7 +3663,7 @@ main(int argc, char **argv)
        int cmd;
 
        imagex_info_file = stdout;
-       invocation_name = basename(argv[0]);
+       invocation_name = tbasename(argv[0]);
 
 #ifndef __WIN32__
        if (getenv("WIMLIB_IMAGEX_USE_UTF8")) {
@@ -3708,8 +3704,8 @@ main(int argc, char **argv)
                }
        }
 
-       /* Unless already known from the invocation name, search for the
-        * function to handle the specified subcommand.  */
+       /* Unless already known from the invocation name, determine which
+        * command was specified.  */
        if (cmd == CMD_NONE) {
                if (argc < 2) {
                        imagex_error(T("No command specified!\n"));
@@ -3728,20 +3724,24 @@ main(int argc, char **argv)
                }
        }
 
-       /* Handle --help and --version for all commands.  Note that this will
-        * not return if either of these arguments are present. */
+       /* Handle --help and --version.  --help can be either for the program as
+        * a whole (cmd == CMD_NONE) or just for a specific command (cmd !=
+        * CMD_NONE).  Note: help_or_version() will not return if a --help or
+        * --version argument was found.  */
        help_or_version(argc, argv, cmd);
 
+       /* Bail if a valid command was not specified.  */
        if (cmd == CMD_NONE) {
                imagex_error(T("Unrecognized command: `%"TS"'\n"), argv[1]);
                usage_all(stderr);
                exit(2);
        }
 
-       /* The user may like to see more informative error messages.  */
+       /* Enable warning and error messages in wimlib be more user-friendly.
+        * */
        wimlib_set_print_errors(true);
 
-       /* Initialize the library.  */
+       /* Initialize wimlib.  */
        ret = wimlib_global_init(init_flags);
        if (ret)
                goto out_check_status;
@@ -3759,9 +3759,8 @@ main(int argc, char **argv)
        }
 out_check_status:
        /* Exit status (ret):  -1 indicates an error found by 'wimlib-imagex'
-        * outside of the wimlib library code.  0 indicates success.  > 0
-        * indicates a wimlib error code from which an error message can be
-        * printed.  */
+        * itself (not by wimlib).  0 indicates success.  > 0 indicates a wimlib
+        * error code from which an error message can be printed.  */
        if (ret > 0) {
                imagex_error(T("Exiting with error code %d:\n"
                               "       %"TS"."), ret,
@@ -3769,8 +3768,8 @@ out_check_status:
                if (ret == WIMLIB_ERR_NTFS_3G && errno != 0)
                        imagex_error_with_errno(T("errno"));
        }
-       /* Make the library free any resources it's holding (not strictly
-        * necessary because the process is ending anyway).  */
+       /* Make wimlib free any resources it's holding (although this is not
+        * strictly necessary because the process is ending anyway).  */
        wimlib_global_cleanup();
        return ret;
 }