wimoptimize: Add --no-pack-streams option
[wimlib] / programs / imagex.c
1 /*
2  * imagex.c
3  *
4  * Use wimlib to create, modify, extract, mount, unmount, or display information
5  * about a WIM file
6  */
7
8 /*
9  * Copyright (C) 2012, 2013 Eric Biggers
10  *
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.
15  *
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.
20  *
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/>.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 #  include "config.h" /* Need for PACKAGE_VERSION, etc. */
27 #endif
28
29 #include "wimlib.h"
30 #include "wimlib_tchar.h"
31
32 #include <ctype.h>
33 #include <errno.h>
34
35 #include <inttypes.h>
36 #include <libgen.h>
37 #include <limits.h>
38 #include <stdarg.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <sys/stat.h>
42 #include <unistd.h>
43 #include <locale.h>
44
45 #ifdef HAVE_ALLOCA_H
46 #  include <alloca.h>
47 #endif
48
49 #ifdef __WIN32__
50 #  include "imagex-win32.h"
51 #  define tbasename     win32_wbasename
52 #  define OS_PREFERRED_PATH_SEPARATOR L'\\'
53 #  define OS_PREFERRED_PATH_SEPARATOR_STRING L"\\"
54 #else /* __WIN32__ */
55 #  include <glob.h>
56 #  include <getopt.h>
57 #  include <langinfo.h>
58 #  define tbasename     basename
59 #  define OS_PREFERRED_PATH_SEPARATOR '/'
60 #  define OS_PREFERRED_PATH_SEPARATOR_STRING "/"
61 static inline void set_fd_to_binary_mode(int fd)
62 {
63 }
64 #endif /* !__WIN32 */
65
66 /* Don't confuse the user by presenting the mounting commands on Windows when
67  * they will never work.  However on UNIX-like systems we always present them,
68  * even if WITH_FUSE is not defined at this point, as to not tie the build of
69  * wimlib-imagex to a specific build of wimlib.  */
70 #ifdef __WIN32__
71 #  define WIM_MOUNTING_SUPPORTED 0
72 #else
73 #  define WIM_MOUNTING_SUPPORTED 1
74 #endif
75
76 #define ARRAY_LEN(array) (sizeof(array) / sizeof(array[0]))
77
78 #define for_opt(c, opts) while ((c = getopt_long_only(argc, (tchar**)argv, T(""), \
79                                 opts, NULL)) != -1)
80
81 enum {
82         CMD_NONE = -1,
83         CMD_APPEND = 0,
84         CMD_APPLY,
85         CMD_CAPTURE,
86         CMD_DELETE,
87         CMD_DIR,
88         CMD_EXPORT,
89         CMD_EXTRACT,
90         CMD_INFO,
91         CMD_JOIN,
92 #if WIM_MOUNTING_SUPPORTED
93         CMD_MOUNT,
94         CMD_MOUNTRW,
95 #endif
96         CMD_OPTIMIZE,
97         CMD_SPLIT,
98 #if WIM_MOUNTING_SUPPORTED
99         CMD_UNMOUNT,
100 #endif
101         CMD_UPDATE,
102         CMD_MAX,
103 };
104
105 static void usage(int cmd, FILE *fp);
106 static void usage_all(FILE *fp);
107 static void recommend_man_page(int cmd, FILE *fp);
108 static const tchar *get_cmd_string(int cmd, bool nospace);
109
110 static int imagex_progress_func(enum wimlib_progress_msg msg,
111                                 const union wimlib_progress_info *info);
112
113 static bool imagex_be_quiet = false;
114 static FILE *imagex_info_file;
115
116 #define imagex_printf(format, ...) \
117                 tfprintf(imagex_info_file, format, ##__VA_ARGS__)
118
119 enum {
120         IMAGEX_ALLOW_OTHER_OPTION,
121         IMAGEX_BOOT_OPTION,
122         IMAGEX_CHECK_OPTION,
123         IMAGEX_CHUNK_SIZE_OPTION,
124         IMAGEX_COMMAND_OPTION,
125         IMAGEX_COMMIT_OPTION,
126         IMAGEX_COMPRESS_OPTION,
127         IMAGEX_COMPRESS_SLOW_OPTION,
128         IMAGEX_CONFIG_OPTION,
129         IMAGEX_DEBUG_OPTION,
130         IMAGEX_DELTA_FROM_OPTION,
131         IMAGEX_DEREFERENCE_OPTION,
132         IMAGEX_DEST_DIR_OPTION,
133         IMAGEX_EXTRACT_XML_OPTION,
134         IMAGEX_FLAGS_OPTION,
135         IMAGEX_FORCE_OPTION,
136         IMAGEX_HARDLINK_OPTION,
137         IMAGEX_HEADER_OPTION,
138         IMAGEX_INCLUDE_INVALID_NAMES_OPTION,
139         IMAGEX_LAZY_OPTION,
140         IMAGEX_LOOKUP_TABLE_OPTION,
141         IMAGEX_METADATA_OPTION,
142         IMAGEX_NORPFIX_OPTION,
143         IMAGEX_NOCHECK_OPTION,
144         IMAGEX_NO_ACLS_OPTION,
145         IMAGEX_NO_PACK_STREAMS_OPTION,
146         IMAGEX_NOT_PIPABLE_OPTION,
147         IMAGEX_PACK_STREAMS_OPTION,
148         IMAGEX_PATH_OPTION,
149         IMAGEX_PIPABLE_OPTION,
150         IMAGEX_REBUILD_OPTION,
151         IMAGEX_RECOMPRESS_OPTION,
152         IMAGEX_RECURSIVE_OPTION,
153         IMAGEX_REF_OPTION,
154         IMAGEX_RESUME_OPTION,
155         IMAGEX_RPFIX_OPTION,
156         IMAGEX_SOFT_OPTION,
157         IMAGEX_SOURCE_LIST_OPTION,
158         IMAGEX_STAGING_DIR_OPTION,
159         IMAGEX_STREAMS_INTERFACE_OPTION,
160         IMAGEX_STRICT_ACLS_OPTION,
161         IMAGEX_SYMLINK_OPTION,
162         IMAGEX_THREADS_OPTION,
163         IMAGEX_TO_STDOUT_OPTION,
164         IMAGEX_UNIX_DATA_OPTION,
165         IMAGEX_UPDATE_OF_OPTION,
166         IMAGEX_VERBOSE_OPTION,
167         IMAGEX_XML_OPTION,
168 };
169
170 static const struct option apply_options[] = {
171         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
172         {T("hardlink"),    no_argument,       NULL, IMAGEX_HARDLINK_OPTION},
173         {T("symlink"),     no_argument,       NULL, IMAGEX_SYMLINK_OPTION},
174         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
175         {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
176         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
177         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
178         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
179         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
180         {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
181         {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
182         {T("include-invalid-names"), no_argument,       NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
183
184         /* --resume is undocumented for now as it needs improvement.  */
185         {T("resume"),      no_argument,       NULL, IMAGEX_RESUME_OPTION},
186         {NULL, 0, NULL, 0},
187 };
188
189 static const struct option capture_or_append_options[] = {
190         {T("boot"),        no_argument,       NULL, IMAGEX_BOOT_OPTION},
191         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
192         {T("no-check"),    no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
193         {T("nocheck"),     no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
194         {T("compress"),    required_argument, NULL, IMAGEX_COMPRESS_OPTION},
195         {T("compress-slow"), no_argument,     NULL, IMAGEX_COMPRESS_SLOW_OPTION},
196         {T("chunk-size"),  required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
197         {T("pack-streams"), no_argument,      NULL, IMAGEX_PACK_STREAMS_OPTION},
198         {T("config"),      required_argument, NULL, IMAGEX_CONFIG_OPTION},
199         {T("dereference"), no_argument,       NULL, IMAGEX_DEREFERENCE_OPTION},
200         {T("flags"),       required_argument, NULL, IMAGEX_FLAGS_OPTION},
201         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
202         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
203         {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
204         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
205         {T("source-list"), no_argument,       NULL, IMAGEX_SOURCE_LIST_OPTION},
206         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
207         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
208         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
209         {T("rpfix"),       no_argument,       NULL, IMAGEX_RPFIX_OPTION},
210         {T("norpfix"),     no_argument,       NULL, IMAGEX_NORPFIX_OPTION},
211         {T("pipable"),     no_argument,       NULL, IMAGEX_PIPABLE_OPTION},
212         {T("not-pipable"), no_argument,       NULL, IMAGEX_NOT_PIPABLE_OPTION},
213         {T("update-of"),   required_argument, NULL, IMAGEX_UPDATE_OF_OPTION},
214         {T("delta-from"),  required_argument, NULL, IMAGEX_DELTA_FROM_OPTION},
215         {NULL, 0, NULL, 0},
216 };
217
218 static const struct option delete_options[] = {
219         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
220         {T("soft"),  no_argument, NULL, IMAGEX_SOFT_OPTION},
221         {NULL, 0, NULL, 0},
222 };
223
224 static const struct option dir_options[] = {
225         {T("path"), required_argument, NULL, IMAGEX_PATH_OPTION},
226         {NULL, 0, NULL, 0},
227 };
228
229 static const struct option export_options[] = {
230         {T("boot"),        no_argument,       NULL, IMAGEX_BOOT_OPTION},
231         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
232         {T("nocheck"),     no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
233         {T("no-check"),    no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
234         {T("compress"),    required_argument, NULL, IMAGEX_COMPRESS_OPTION},
235         {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
236         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
237         {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
238         {T("pipable"),     no_argument,       NULL, IMAGEX_PIPABLE_OPTION},
239         {T("not-pipable"), no_argument,       NULL, IMAGEX_NOT_PIPABLE_OPTION},
240         {NULL, 0, NULL, 0},
241 };
242
243 static const struct option extract_options[] = {
244         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
245         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
246         {T("ref"),         required_argument, NULL, IMAGEX_REF_OPTION},
247         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
248         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
249         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
250         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
251         {T("dest-dir"),    required_argument, NULL, IMAGEX_DEST_DIR_OPTION},
252         {T("to-stdout"),   no_argument,       NULL, IMAGEX_TO_STDOUT_OPTION},
253         {T("include-invalid-names"), no_argument, NULL, IMAGEX_INCLUDE_INVALID_NAMES_OPTION},
254         {NULL, 0, NULL, 0},
255 };
256
257 static const struct option info_options[] = {
258         {T("boot"),         no_argument,       NULL, IMAGEX_BOOT_OPTION},
259         {T("check"),        no_argument,       NULL, IMAGEX_CHECK_OPTION},
260         {T("nocheck"),      no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
261         {T("no-check"),     no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
262         {T("extract-xml"),  required_argument, NULL, IMAGEX_EXTRACT_XML_OPTION},
263         {T("header"),       no_argument,       NULL, IMAGEX_HEADER_OPTION},
264         {T("lookup-table"), no_argument,       NULL, IMAGEX_LOOKUP_TABLE_OPTION},
265         {T("metadata"),     no_argument,       NULL, IMAGEX_METADATA_OPTION},
266         {T("xml"),          no_argument,       NULL, IMAGEX_XML_OPTION},
267         {NULL, 0, NULL, 0},
268 };
269
270 static const struct option join_options[] = {
271         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
272         {NULL, 0, NULL, 0},
273 };
274
275 static const struct option mount_options[] = {
276         {T("check"),             no_argument,       NULL, IMAGEX_CHECK_OPTION},
277         {T("debug"),             no_argument,       NULL, IMAGEX_DEBUG_OPTION},
278         {T("streams-interface"), required_argument, NULL, IMAGEX_STREAMS_INTERFACE_OPTION},
279         {T("ref"),               required_argument, NULL, IMAGEX_REF_OPTION},
280         {T("staging-dir"),       required_argument, NULL, IMAGEX_STAGING_DIR_OPTION},
281         {T("unix-data"),         no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
282         {T("allow-other"),       no_argument,       NULL, IMAGEX_ALLOW_OTHER_OPTION},
283         {NULL, 0, NULL, 0},
284 };
285
286 static const struct option optimize_options[] = {
287         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
288         {T("nocheck"),     no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
289         {T("no-check"),    no_argument,       NULL, IMAGEX_NOCHECK_OPTION},
290         {T("compress"),    required_argument, NULL, IMAGEX_COMPRESS_OPTION},
291         {T("recompress"),  no_argument,       NULL, IMAGEX_RECOMPRESS_OPTION},
292         {T("compress-slow"), no_argument,     NULL, IMAGEX_COMPRESS_SLOW_OPTION},
293         {T("recompress-slow"), no_argument,     NULL, IMAGEX_COMPRESS_SLOW_OPTION},
294         {T("chunk-size"),  required_argument, NULL, IMAGEX_CHUNK_SIZE_OPTION},
295         {T("pack-streams"),no_argument,       NULL, IMAGEX_PACK_STREAMS_OPTION},
296         {T("no-pack-streams"), no_argument,   NULL, IMAGEX_NO_PACK_STREAMS_OPTION},
297         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
298         {T("pipable"),     no_argument,       NULL, IMAGEX_PIPABLE_OPTION},
299         {T("not-pipable"), no_argument,       NULL, IMAGEX_NOT_PIPABLE_OPTION},
300         {NULL, 0, NULL, 0},
301 };
302
303 static const struct option split_options[] = {
304         {T("check"), no_argument, NULL, IMAGEX_CHECK_OPTION},
305         {NULL, 0, NULL, 0},
306 };
307
308 static const struct option unmount_options[] = {
309         {T("commit"),  no_argument, NULL, IMAGEX_COMMIT_OPTION},
310         {T("check"),   no_argument, NULL, IMAGEX_CHECK_OPTION},
311         {T("rebuild"), no_argument, NULL, IMAGEX_REBUILD_OPTION},
312         {T("lazy"),    no_argument, NULL, IMAGEX_LAZY_OPTION},
313         {NULL, 0, NULL, 0},
314 };
315
316 static const struct option update_options[] = {
317         /* Careful: some of the options here set the defaults for update
318          * commands, but the flags given to an actual update command (and not to
319          * `imagex update' itself are also handled in
320          * update_command_add_option().  */
321         {T("threads"),     required_argument, NULL, IMAGEX_THREADS_OPTION},
322         {T("check"),       no_argument,       NULL, IMAGEX_CHECK_OPTION},
323         {T("rebuild"),     no_argument,       NULL, IMAGEX_REBUILD_OPTION},
324         {T("command"),     required_argument, NULL, IMAGEX_COMMAND_OPTION},
325
326         /* Default delete options */
327         {T("force"),       no_argument,       NULL, IMAGEX_FORCE_OPTION},
328         {T("recursive"),   no_argument,       NULL, IMAGEX_RECURSIVE_OPTION},
329
330         /* Global add option */
331         {T("config"),      required_argument, NULL, IMAGEX_CONFIG_OPTION},
332
333         /* Default add options */
334         {T("verbose"),     no_argument,       NULL, IMAGEX_VERBOSE_OPTION},
335         {T("dereference"), no_argument,       NULL, IMAGEX_DEREFERENCE_OPTION},
336         {T("unix-data"),   no_argument,       NULL, IMAGEX_UNIX_DATA_OPTION},
337         {T("noacls"),      no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
338         {T("no-acls"),     no_argument,       NULL, IMAGEX_NO_ACLS_OPTION},
339         {T("strict-acls"), no_argument,       NULL, IMAGEX_STRICT_ACLS_OPTION},
340
341         {NULL, 0, NULL, 0},
342 };
343
344 #if 0
345 #       define _format_attribute(type, format_str, args_start) \
346                         __attribute__((format(type, format_str, args_start)))
347 #else
348 #       define _format_attribute(type, format_str, args_start)
349 #endif
350
351 /* Print formatted error message to stderr. */
352 static void _format_attribute(printf, 1, 2)
353 imagex_error(const tchar *format, ...)
354 {
355         va_list va;
356         va_start(va, format);
357         tfputs(T("ERROR: "), stderr);
358         tvfprintf(stderr, format, va);
359         tputc(T('\n'), stderr);
360         va_end(va);
361 }
362
363 /* Print formatted error message to stderr. */
364 static void _format_attribute(printf, 1, 2)
365 imagex_error_with_errno(const tchar *format, ...)
366 {
367         int errno_save = errno;
368         va_list va;
369         va_start(va, format);
370         tfputs(T("ERROR: "), stderr);
371         tvfprintf(stderr, format, va);
372         tfprintf(stderr, T(": %"TS"\n"), tstrerror(errno_save));
373         va_end(va);
374 }
375
376 static int
377 verify_image_exists(int image, const tchar *image_name, const tchar *wim_name)
378 {
379         if (image == WIMLIB_NO_IMAGE) {
380                 imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\"!\n"
381                              "       Please specify a 1-based image index or "
382                              "image name.  To list the images\n"
383                              "       contained in the WIM archive, run\n"
384                              "\n"
385                              "           %"TS" \"%"TS"\"\n"),
386                              image_name, wim_name,
387                              get_cmd_string(CMD_INFO, false), wim_name);
388                 return WIMLIB_ERR_INVALID_IMAGE;
389         }
390         return 0;
391 }
392
393 static int
394 verify_image_is_single(int image)
395 {
396         if (image == WIMLIB_ALL_IMAGES) {
397                 imagex_error(T("Cannot specify all images for this action!"));
398                 return WIMLIB_ERR_INVALID_IMAGE;
399         }
400         return 0;
401 }
402
403 static int
404 verify_image_exists_and_is_single(int image, const tchar *image_name,
405                                   const tchar *wim_name)
406 {
407         int ret;
408         ret = verify_image_exists(image, image_name, wim_name);
409         if (ret == 0)
410                 ret = verify_image_is_single(image);
411         return ret;
412 }
413
414 /* Parse the argument to --compress */
415 static int
416 get_compression_type(const tchar *optarg)
417 {
418         if (!tstrcasecmp(optarg, T("maximum")) || !tstrcasecmp(optarg, T("lzx")))
419                 return WIMLIB_COMPRESSION_TYPE_LZX;
420         else if (!tstrcasecmp(optarg, T("fast")) || !tstrcasecmp(optarg, T("xpress")))
421                 return WIMLIB_COMPRESSION_TYPE_XPRESS;
422         else if (!tstrcasecmp(optarg, T("recovery")) || !tstrcasecmp(optarg, T("lzms")))
423                 return WIMLIB_COMPRESSION_TYPE_LZMS;
424         else if (!tstrcasecmp(optarg, T("none")))
425                 return WIMLIB_COMPRESSION_TYPE_NONE;
426         else {
427                 imagex_error(T("Invalid compression type \"%"TS"\"! Must be "
428                              "\"maximum\", \"fast\", or \"none\"."), optarg);
429                 return WIMLIB_COMPRESSION_TYPE_INVALID;
430         }
431 }
432
433 static int
434 set_compress_slow(void)
435 {
436         int ret;
437         static const struct wimlib_lzx_params slow_params = {
438                 .size_of_this = sizeof(struct wimlib_lzx_params),
439                 .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
440                 .alg_params = {
441                         .slow = {
442                                 .use_len2_matches = 1,
443                                 .num_fast_bytes = 96,
444                                 .num_optim_passes = 4,
445                                 .max_search_depth = 100,
446                                 .max_matches_per_pos = 10,
447                                 .main_nostat_cost = 15,
448                                 .len_nostat_cost = 15,
449                                 .aligned_nostat_cost = 7,
450                         },
451                 },
452         };
453         ret = wimlib_lzx_set_default_params(&slow_params);
454         if (ret)
455                 imagex_error(T("Couldn't set slow compression parameters.!"));
456         return ret;
457 }
458
459 struct string_set {
460         const tchar **strings;
461         unsigned num_strings;
462         unsigned num_alloc_strings;
463 };
464
465 #define STRING_SET_INITIALIZER \
466         { .strings = NULL, .num_strings = 0, .num_alloc_strings = 0, }
467
468 #define STRING_SET(_strings) \
469         struct string_set _strings = STRING_SET_INITIALIZER
470
471 static int
472 string_set_append(struct string_set *set, const tchar *glob)
473 {
474         unsigned num_alloc_strings = set->num_alloc_strings;
475
476         if (set->num_strings == num_alloc_strings) {
477                 const tchar **new_strings;
478
479                 num_alloc_strings += 4;
480                 new_strings = realloc(set->strings,
481                                       sizeof(set->strings[0]) * num_alloc_strings);
482                 if (!new_strings) {
483                         imagex_error(T("Out of memory!"));
484                         return -1;
485                 }
486                 set->strings = new_strings;
487                 set->num_alloc_strings = num_alloc_strings;
488         }
489         set->strings[set->num_strings++] = glob;
490         return 0;
491 }
492
493 static void
494 string_set_destroy(struct string_set *set)
495 {
496         free(set->strings);
497 }
498
499 static int
500 wim_reference_globs(WIMStruct *wim, struct string_set *set, int open_flags)
501 {
502         return wimlib_reference_resource_files(wim, set->strings,
503                                                set->num_strings,
504                                                WIMLIB_REF_FLAG_GLOB_ENABLE,
505                                                open_flags,
506                                                imagex_progress_func);
507 }
508
509 static void
510 do_resource_not_found_warning(const tchar *wimfile,
511                               const struct wimlib_wim_info *info,
512                               const struct string_set *refglobs)
513 {
514         if (info->total_parts > 1) {
515                 if (refglobs->num_strings == 0) {
516                         imagex_error(T("\"%"TS"\" is part of a split WIM. "
517                                        "Use --ref to specify the other parts."),
518                                      wimfile);
519                 } else {
520                         imagex_error(T("Perhaps the '--ref' argument did not "
521                                        "specify all other parts of the split "
522                                        "WIM?"));
523                 }
524         } else {
525                 imagex_error(T("If this is a delta WIM, use the --ref argument "
526                                "to specify the WIM(s) on which it is based."));
527         }
528 }
529
530 /* Returns the size of a file given its name, or -1 if the file does not exist
531  * or its size cannot be determined.  */
532 static off_t
533 file_get_size(const tchar *filename)
534 {
535         struct stat st;
536         if (tstat(filename, &st) == 0)
537                 return st.st_size;
538         else
539                 return (off_t)-1;
540 }
541
542 enum {
543         PARSE_STRING_SUCCESS = 0,
544         PARSE_STRING_FAILURE = 1,
545         PARSE_STRING_NONE = 2,
546 };
547
548 /*
549  * Parses a string token from an array of characters.
550  *
551  * Tokens are either whitespace-delimited, or double or single-quoted.
552  *
553  * @line_p:  Pointer to the pointer to the line of data.  Will be updated
554  *           to point past the string token iff the return value is
555  *           PARSE_STRING_SUCCESS.  If *len_p > 0, (*line_p)[*len_p - 1] must
556  *           be '\0'.
557  *
558  * @len_p:   @len_p initially stores the length of the line of data, which may
559  *           be 0, and it will be updated to the number of bytes remaining in
560  *           the line iff the return value is PARSE_STRING_SUCCESS.
561  *
562  * @fn_ret:  Iff the return value is PARSE_STRING_SUCCESS, a pointer to the
563  *           parsed string token will be returned here.
564  *
565  * Returns: PARSE_STRING_SUCCESS if a string token was successfully parsed; or
566  *          PARSE_STRING_FAILURE if the data was invalid due to a missing
567  *          closing quote; or PARSE_STRING_NONE if the line ended before the
568  *          beginning of a string token was found.
569  */
570 static int
571 parse_string(tchar **line_p, size_t *len_p, tchar **fn_ret)
572 {
573         size_t len = *len_p;
574         tchar *line = *line_p;
575         tchar *fn;
576         tchar quote_char;
577
578         /* Skip leading whitespace */
579         for (;;) {
580                 if (len == 0)
581                         return PARSE_STRING_NONE;
582                 if (!istspace(*line) && *line != T('\0'))
583                         break;
584                 line++;
585                 len--;
586         }
587         quote_char = *line;
588         if (quote_char == T('"') || quote_char == T('\'')) {
589                 /* Quoted string */
590                 line++;
591                 len--;
592                 fn = line;
593                 line = tmemchr(line, quote_char, len);
594                 if (!line) {
595                         imagex_error(T("Missing closing quote: %"TS), fn - 1);
596                         return PARSE_STRING_FAILURE;
597                 }
598         } else {
599                 /* Unquoted string.  Go until whitespace.  Line is terminated
600                  * by '\0', so no need to check 'len'. */
601                 fn = line;
602                 do {
603                         line++;
604                 } while (!istspace(*line) && *line != T('\0'));
605         }
606         *line = T('\0');
607         len -= line - fn;
608         *len_p = len;
609         *line_p = line;
610         *fn_ret = fn;
611         return PARSE_STRING_SUCCESS;
612 }
613
614 /* Parses a line of data (not an empty line or comment) in the source list file
615  * format.  (See the man page for 'wimlib-imagex capture' for details on this
616  * format and the meaning.)
617  *
618  * @line:  Line of data to be parsed.  line[len - 1] must be '\0', unless
619  *         len == 0.  The data in @line will be modified by this function call.
620  *
621  * @len:   Length of the line of data.
622  *
623  * @source:  On success, the capture source and target described by the line is
624  *           written into this destination.  Note that it will contain pointers
625  *           to data in the @line array.
626  *
627  * Returns true if the line was valid; false otherwise.  */
628 static bool
629 parse_source_list_line(tchar *line, size_t len,
630                        struct wimlib_capture_source *source)
631 {
632         /* SOURCE [DEST] */
633         int ret;
634         ret = parse_string(&line, &len, &source->fs_source_path);
635         if (ret != PARSE_STRING_SUCCESS)
636                 return false;
637         ret = parse_string(&line, &len, &source->wim_target_path);
638         if (ret == PARSE_STRING_NONE)
639                 source->wim_target_path = source->fs_source_path;
640         return ret != PARSE_STRING_FAILURE;
641 }
642
643 /* Returns %true if the given line of length @len > 0 is a comment or empty line
644  * in the source list file format. */
645 static bool
646 is_comment_line(const tchar *line, size_t len)
647 {
648         for (;;) {
649                 if (*line == T('#'))
650                         return true;
651                 if (!istspace(*line) && *line != T('\0'))
652                         return false;
653                 ++line;
654                 --len;
655                 if (len == 0)
656                         return true;
657         }
658 }
659
660 static ssize_t
661 text_file_count_lines(tchar **contents_p, size_t *nchars_p)
662 {
663         ssize_t nlines = 0;
664         tchar *contents = *contents_p;
665         size_t nchars = *nchars_p;
666         size_t i;
667
668         for (i = 0; i < nchars; i++)
669                 if (contents[i] == T('\n'))
670                         nlines++;
671
672         /* Handle last line not terminated by a newline */
673         if (nchars != 0 && contents[nchars - 1] != T('\n')) {
674                 contents = realloc(contents, (nchars + 1) * sizeof(tchar));
675                 if (!contents) {
676                         imagex_error(T("Out of memory!"));
677                         return -1;
678                 }
679                 contents[nchars] = T('\n');
680                 *contents_p = contents;
681                 nchars++;
682                 nlines++;
683         }
684         *nchars_p = nchars;
685         return nlines;
686 }
687
688 /* Parses a file in the source list format.  (See the man page for
689  * 'wimlib-imagex capture' for details on this format and the meaning.)
690  *
691  * @source_list_contents:  Contents of the source list file.  Note that this
692  *                         buffer will be modified to save memory allocations,
693  *                         and cannot be freed until the returned array of
694  *                         wimlib_capture_source's has also been freed.
695  *
696  * @source_list_nbytes:    Number of bytes of data in the @source_list_contents
697  *                         buffer.
698  *
699  * @nsources_ret:          On success, the length of the returned array is
700  *                         returned here.
701  *
702  * Returns:   An array of `struct wimlib_capture_source's that can be passed to
703  * the wimlib_add_image_multisource() function to specify how a WIM image is to
704  * be created.  */
705 static struct wimlib_capture_source *
706 parse_source_list(tchar **source_list_contents_p, size_t source_list_nchars,
707                   size_t *nsources_ret)
708 {
709         ssize_t nlines;
710         tchar *p;
711         struct wimlib_capture_source *sources;
712         size_t i, j;
713
714         nlines = text_file_count_lines(source_list_contents_p,
715                                        &source_list_nchars);
716         if (nlines < 0)
717                 return NULL;
718
719         /* Always allocate at least 1 slot, just in case the implementation of
720          * calloc() returns NULL if 0 bytes are requested. */
721         sources = calloc(nlines ?: 1, sizeof(*sources));
722         if (!sources) {
723                 imagex_error(T("out of memory"));
724                 return NULL;
725         }
726         p = *source_list_contents_p;
727         j = 0;
728         for (i = 0; i < nlines; i++) {
729                 /* XXX: Could use rawmemchr() here instead, but it may not be
730                  * available on all platforms. */
731                 tchar *endp = tmemchr(p, T('\n'), source_list_nchars);
732                 size_t len = endp - p + 1;
733                 *endp = T('\0');
734                 if (!is_comment_line(p, len)) {
735                         if (!parse_source_list_line(p, len, &sources[j++])) {
736                                 free(sources);
737                                 return NULL;
738                         }
739                 }
740                 p = endp + 1;
741
742         }
743         *nsources_ret = j;
744         return sources;
745 }
746
747
748 enum capture_config_section {
749         CAPTURE_CONFIG_NO_SECTION,
750         CAPTURE_CONFIG_EXCLUSION_SECTION,
751         CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION,
752         CAPTURE_CONFIG_IGNORE_SECTION,
753 };
754
755 enum {
756         CAPTURE_CONFIG_INVALID_SECTION,
757         CAPTURE_CONFIG_CHANGED_SECTION,
758         CAPTURE_CONFIG_SAME_SECTION,
759 };
760
761 static int
762 check_config_section(tchar *line, size_t len,
763                      enum capture_config_section *cur_section)
764 {
765         while (istspace(*line))
766                 line++;
767
768         if (*line != T('['))
769                 return CAPTURE_CONFIG_SAME_SECTION;
770
771         line++;
772         tchar *endbrace = tstrrchr(line, T(']'));
773         if (!endbrace)
774                 return CAPTURE_CONFIG_SAME_SECTION;
775
776         if (!tmemcmp(line, T("ExclusionList"), endbrace - line)) {
777                 *cur_section = CAPTURE_CONFIG_EXCLUSION_SECTION;
778         } else if (!tmemcmp(line, T("ExclusionException"), endbrace - line)) {
779                 *cur_section = CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION;
780         } else if (!tmemcmp(line, T("CompressionExclusionList"), endbrace - line)) {
781                 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
782                 tfputs(T("WARNING: Ignoring [CompressionExclusionList] section "
783                          "of capture config file\n"),
784                        stderr);
785         } else if (!tmemcmp(line, T("AlignmentList"), endbrace - line)) {
786                 *cur_section = CAPTURE_CONFIG_IGNORE_SECTION;
787                 tfputs(T("WARNING: Ignoring [AlignmentList] section "
788                          "of capture config file\n"),
789                        stderr);
790         } else {
791                 imagex_error(T("Invalid capture config file section \"%"TS"\""),
792                              line - 1);
793                 return CAPTURE_CONFIG_INVALID_SECTION;
794         }
795         return CAPTURE_CONFIG_CHANGED_SECTION;
796 }
797
798
799 static bool
800 pattern_list_add_pattern(struct wimlib_pattern_list *pat_list,
801                          tchar *pat)
802 {
803         if (pat_list->num_pats == pat_list->num_allocated_pats) {
804                 tchar **pats;
805                 size_t num_allocated_pats = pat_list->num_pats + 8;
806
807                 pats = realloc(pat_list->pats,
808                                num_allocated_pats * sizeof(pat_list->pats[0]));
809                 if (!pats) {
810                         imagex_error(T("Out of memory!"));
811                         return false;
812                 }
813                 pat_list->pats = pats;
814                 pat_list->num_allocated_pats = num_allocated_pats;
815         }
816         pat_list->pats[pat_list->num_pats++] = pat;
817         return true;
818 }
819
820 static bool
821 parse_capture_config_line(tchar *line, size_t len,
822                           enum capture_config_section *cur_section,
823                           struct wimlib_capture_config *config)
824 {
825         tchar *filename;
826         int ret;
827
828         ret = check_config_section(line, len, cur_section);
829         if (ret == CAPTURE_CONFIG_INVALID_SECTION)
830                 return false;
831         if (ret == CAPTURE_CONFIG_CHANGED_SECTION)
832                 return true;
833
834         switch (*cur_section) {
835         case CAPTURE_CONFIG_NO_SECTION:
836                 imagex_error(T("Line \"%"TS"\" is not in a section "
837                                "(such as [ExclusionList]"), line);
838                 return false;
839         case CAPTURE_CONFIG_EXCLUSION_SECTION:
840                 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
841                         return false;
842                 return pattern_list_add_pattern(&config->exclusion_pats,
843                                                 filename);
844         case CAPTURE_CONFIG_EXCLUSION_EXCEPTION_SECTION:
845                 if (parse_string(&line, &len, &filename) != PARSE_STRING_SUCCESS)
846                         return false;
847                 return pattern_list_add_pattern(&config->exclusion_exception_pats,
848                                                 filename);
849         case CAPTURE_CONFIG_IGNORE_SECTION:
850                 return true;
851         }
852         return false;
853 }
854
855 static int
856 parse_capture_config(tchar **contents_p, size_t nchars,
857                      struct wimlib_capture_config *config)
858 {
859         ssize_t nlines;
860         tchar *p;
861         size_t i;
862         enum capture_config_section cur_section;
863
864         memset(config, 0, sizeof(*config));
865
866         nlines = text_file_count_lines(contents_p, &nchars);
867         if (nlines < 0)
868                 return -1;
869
870         cur_section = CAPTURE_CONFIG_NO_SECTION;
871         p = *contents_p;
872         for (i = 0; i < nlines; i++) {
873                 tchar *endp = tmemchr(p, T('\n'), nchars);
874                 size_t len = endp - p + 1;
875                 *endp = T('\0');
876                 if (!is_comment_line(p, len))
877                         if (!parse_capture_config_line(p, len, &cur_section, config))
878                                 return -1;
879                 p = endp + 1;
880
881         }
882         return 0;
883 }
884
885 /* Reads the contents of a file into memory. */
886 static char *
887 file_get_contents(const tchar *filename, size_t *len_ret)
888 {
889         struct stat stbuf;
890         void *buf = NULL;
891         size_t len;
892         FILE *fp;
893
894         if (tstat(filename, &stbuf) != 0) {
895                 imagex_error_with_errno(T("Failed to stat the file \"%"TS"\""), filename);
896                 goto out;
897         }
898         len = stbuf.st_size;
899
900         fp = tfopen(filename, T("rb"));
901         if (!fp) {
902                 imagex_error_with_errno(T("Failed to open the file \"%"TS"\""), filename);
903                 goto out;
904         }
905
906         buf = malloc(len ? len : 1);
907         if (!buf) {
908                 imagex_error(T("Failed to allocate buffer of %zu bytes to hold "
909                                "contents of file \"%"TS"\""), len, filename);
910                 goto out_fclose;
911         }
912         if (fread(buf, 1, len, fp) != len) {
913                 imagex_error_with_errno(T("Failed to read %zu bytes from the "
914                                           "file \"%"TS"\""), len, filename);
915                 goto out_free_buf;
916         }
917         *len_ret = len;
918         goto out_fclose;
919 out_free_buf:
920         free(buf);
921         buf = NULL;
922 out_fclose:
923         fclose(fp);
924 out:
925         return buf;
926 }
927
928 /* Read standard input until EOF and return the full contents in a malloc()ed
929  * buffer and the number of bytes of data in @len_ret.  Returns NULL on read
930  * error. */
931 static char *
932 stdin_get_contents(size_t *len_ret)
933 {
934         /* stdin can, of course, be a pipe or other non-seekable file, so the
935          * total length of the data cannot be pre-determined */
936         char *buf = NULL;
937         size_t newlen = 1024;
938         size_t pos = 0;
939         size_t inc = 1024;
940         for (;;) {
941                 char *p = realloc(buf, newlen);
942                 size_t bytes_read, bytes_to_read;
943                 if (!p) {
944                         imagex_error(T("out of memory while reading stdin"));
945                         break;
946                 }
947                 buf = p;
948                 bytes_to_read = newlen - pos;
949                 bytes_read = fread(&buf[pos], 1, bytes_to_read, stdin);
950                 pos += bytes_read;
951                 if (bytes_read != bytes_to_read) {
952                         if (feof(stdin)) {
953                                 *len_ret = pos;
954                                 return buf;
955                         } else {
956                                 imagex_error_with_errno(T("error reading stdin"));
957                                 break;
958                         }
959                 }
960                 newlen += inc;
961                 inc *= 3;
962                 inc /= 2;
963         }
964         free(buf);
965         return NULL;
966 }
967
968
969 static tchar *
970 translate_text_to_tstr(char *text, size_t num_bytes, size_t *num_tchars_ret)
971 {
972 #ifndef __WIN32__
973         /* On non-Windows, assume an ASCII-compatible encoding, such as UTF-8.
974          * */
975         *num_tchars_ret = num_bytes;
976         return text;
977 #else /* !__WIN32__ */
978         /* On Windows, translate the text to UTF-16LE */
979         wchar_t *text_wstr;
980         size_t num_wchars;
981
982         if (num_bytes >= 2 &&
983             (((unsigned char)text[0] == 0xff && (unsigned char)text[1] == 0xfe) ||
984              ((unsigned char)text[0] <= 0x7f && (unsigned char)text[1] == 0x00)))
985         {
986                 /* File begins with 0xfeff, the BOM for UTF-16LE, or it begins
987                  * with something that looks like an ASCII character encoded as
988                  * a UTF-16LE code unit.  Assume the file is encoded as
989                  * UTF-16LE.  This is not a 100% reliable check. */
990                 num_wchars = num_bytes / 2;
991                 text_wstr = (wchar_t*)text;
992         } else {
993                 /* File does not look like UTF-16LE.  Assume it is encoded in
994                  * the current Windows code page.  I think these are always
995                  * ASCII-compatible, so any so-called "plain-text" (ASCII) files
996                  * should work as expected. */
997                 text_wstr = win32_mbs_to_wcs(text,
998                                              num_bytes,
999                                              &num_wchars);
1000                 free(text);
1001         }
1002         *num_tchars_ret = num_wchars;
1003         return text_wstr;
1004 #endif /* __WIN32__ */
1005 }
1006
1007 static tchar *
1008 file_get_text_contents(const tchar *filename, size_t *num_tchars_ret)
1009 {
1010         char *contents;
1011         size_t num_bytes;
1012
1013         contents = file_get_contents(filename, &num_bytes);
1014         if (!contents)
1015                 return NULL;
1016         return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1017 }
1018
1019 static tchar *
1020 stdin_get_text_contents(size_t *num_tchars_ret)
1021 {
1022         char *contents;
1023         size_t num_bytes;
1024
1025         contents = stdin_get_contents(&num_bytes);
1026         if (!contents)
1027                 return NULL;
1028         return translate_text_to_tstr(contents, num_bytes, num_tchars_ret);
1029 }
1030
1031 #define TO_PERCENT(numerator, denominator) \
1032         (((denominator) == 0) ? 0 : ((numerator) * 100 / (denominator)))
1033
1034 #define GIBIBYTE_MIN_NBYTES 10000000000ULL
1035 #define MEBIBYTE_MIN_NBYTES 10000000ULL
1036 #define KIBIBYTE_MIN_NBYTES 10000ULL
1037
1038 static unsigned
1039 get_unit(uint64_t total_bytes, const tchar **name_ret)
1040 {
1041         if (total_bytes >= GIBIBYTE_MIN_NBYTES) {
1042                 *name_ret = T("GiB");
1043                 return 30;
1044         } else if (total_bytes >= MEBIBYTE_MIN_NBYTES) {
1045                 *name_ret = T("MiB");
1046                 return 20;
1047         } else if (total_bytes >= KIBIBYTE_MIN_NBYTES) {
1048                 *name_ret = T("KiB");
1049                 return 10;
1050         } else {
1051                 *name_ret = T("bytes");
1052                 return 0;
1053         }
1054 }
1055
1056 /* Progress callback function passed to various wimlib functions. */
1057 static int
1058 imagex_progress_func(enum wimlib_progress_msg msg,
1059                      const union wimlib_progress_info *info)
1060 {
1061         unsigned percent_done;
1062         unsigned unit_shift;
1063         const tchar *unit_name;
1064         if (imagex_be_quiet)
1065                 return 0;
1066         switch (msg) {
1067         case WIMLIB_PROGRESS_MSG_WRITE_STREAMS:
1068                 unit_shift = get_unit(info->write_streams.total_bytes, &unit_name);
1069                 percent_done = TO_PERCENT(info->write_streams.completed_bytes,
1070                                           info->write_streams.total_bytes);
1071
1072                 if (info->write_streams.completed_streams == 0) {
1073                         imagex_printf(T("Writing %"TS"-compressed data using %u thread%"TS"\n"),
1074                                 wimlib_get_compression_type_string(info->write_streams.compression_type),
1075                                 info->write_streams.num_threads,
1076                                 (info->write_streams.num_threads == 1) ? T("") : T("s"));
1077                 }
1078                 if (info->write_streams.total_parts <= 1) {
1079                         imagex_printf(T("\r%"PRIu64" %"TS" of %"PRIu64" %"TS" (uncompressed) "
1080                                 "written (%u%% done)"),
1081                                 info->write_streams.completed_bytes >> unit_shift,
1082                                 unit_name,
1083                                 info->write_streams.total_bytes >> unit_shift,
1084                                 unit_name,
1085                                 percent_done);
1086                 } else {
1087                         imagex_printf(T("\rWriting resources from part %u of %u: "
1088                                   "%"PRIu64 " %"TS" of %"PRIu64" %"TS" (%u%%) written"),
1089                                 (info->write_streams.completed_parts ==
1090                                         info->write_streams.total_parts) ?
1091                                                 info->write_streams.completed_parts :
1092                                                 info->write_streams.completed_parts + 1,
1093                                 info->write_streams.total_parts,
1094                                 info->write_streams.completed_bytes >> unit_shift,
1095                                 unit_name,
1096                                 info->write_streams.total_bytes >> unit_shift,
1097                                 unit_name,
1098                                 percent_done);
1099                 }
1100                 if (info->write_streams.completed_bytes >= info->write_streams.total_bytes)
1101                         imagex_printf(T("\n"));
1102                 break;
1103         case WIMLIB_PROGRESS_MSG_SCAN_BEGIN:
1104                 imagex_printf(T("Scanning \"%"TS"\""), info->scan.source);
1105                 if (*info->scan.wim_target_path) {
1106                         imagex_printf(T(" (loading as WIM path: "
1107                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\")...\n"),
1108                                info->scan.wim_target_path);
1109                 } else {
1110                         imagex_printf(T(" (loading as root of WIM image)...\n"));
1111                 }
1112                 break;
1113         case WIMLIB_PROGRESS_MSG_SCAN_DENTRY:
1114                 switch (info->scan.status) {
1115                 case WIMLIB_SCAN_DENTRY_OK:
1116                         imagex_printf(T("Scanning \"%"TS"\"\n"), info->scan.cur_path);
1117                         break;
1118                 case WIMLIB_SCAN_DENTRY_EXCLUDED:
1119                         imagex_printf(T("Excluding \"%"TS"\" from capture\n"), info->scan.cur_path);
1120                         break;
1121                 case WIMLIB_SCAN_DENTRY_UNSUPPORTED:
1122                         imagex_printf(T("WARNING: Excluding unsupported file or directory\n"
1123                                         "         \"%"TS"\" from capture\n"), info->scan.cur_path);
1124                         break;
1125                 }
1126                 break;
1127         case WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY:
1128                 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1129                 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1130                                           info->integrity.total_bytes);
1131                 imagex_printf(T("\rVerifying integrity of \"%"TS"\": %"PRIu64" %"TS" "
1132                         "of %"PRIu64" %"TS" (%u%%) done"),
1133                         info->integrity.filename,
1134                         info->integrity.completed_bytes >> unit_shift,
1135                         unit_name,
1136                         info->integrity.total_bytes >> unit_shift,
1137                         unit_name,
1138                         percent_done);
1139                 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1140                         imagex_printf(T("\n"));
1141                 break;
1142         case WIMLIB_PROGRESS_MSG_CALC_INTEGRITY:
1143                 unit_shift = get_unit(info->integrity.total_bytes, &unit_name);
1144                 percent_done = TO_PERCENT(info->integrity.completed_bytes,
1145                                           info->integrity.total_bytes);
1146                 imagex_printf(T("\rCalculating integrity table for WIM: %"PRIu64" %"TS" "
1147                           "of %"PRIu64" %"TS" (%u%%) done"),
1148                         info->integrity.completed_bytes >> unit_shift,
1149                         unit_name,
1150                         info->integrity.total_bytes >> unit_shift,
1151                         unit_name,
1152                         percent_done);
1153                 if (info->integrity.completed_bytes == info->integrity.total_bytes)
1154                         imagex_printf(T("\n"));
1155                 break;
1156         case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN:
1157                 imagex_printf(T("Applying image %d (\"%"TS"\") from \"%"TS"\" "
1158                           "to %"TS" \"%"TS"\"\n"),
1159                         info->extract.image,
1160                         info->extract.image_name,
1161                         info->extract.wimfile_name,
1162                         ((info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) ?
1163                          T("NTFS volume") : T("directory")),
1164                         info->extract.target);
1165                 break;
1166         case WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN:
1167                 imagex_printf(T("Extracting "
1168                           "\""WIMLIB_WIM_PATH_SEPARATOR_STRING"%"TS"\" from image %d (\"%"TS"\") "
1169                           "in \"%"TS"\" to \"%"TS"\"\n"),
1170                         info->extract.extract_root_wim_source_path,
1171                         info->extract.image,
1172                         info->extract.image_name,
1173                         info->extract.wimfile_name,
1174                         info->extract.target);
1175                 break;
1176         case WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS:
1177                 percent_done = TO_PERCENT(info->extract.completed_bytes,
1178                                           info->extract.total_bytes);
1179                 unit_shift = get_unit(info->extract.total_bytes, &unit_name);
1180                 imagex_printf(T("\rExtracting files: "
1181                           "%"PRIu64" %"TS" of %"PRIu64" %"TS" (%u%%) done"),
1182                         info->extract.completed_bytes >> unit_shift,
1183                         unit_name,
1184                         info->extract.total_bytes >> unit_shift,
1185                         unit_name,
1186                         percent_done);
1187                 if (info->extract.completed_bytes >= info->extract.total_bytes)
1188                         imagex_printf(T("\n"));
1189                 break;
1190         case WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN:
1191                 if (info->extract.total_parts != 1) {
1192                         imagex_printf(T("\nReading split pipable WIM part %u of %u\n"),
1193                                       info->extract.part_number,
1194                                       info->extract.total_parts);
1195                 }
1196                 break;
1197         case WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS:
1198                 if (info->extract.extract_root_wim_source_path[0] == T('\0'))
1199                         imagex_printf(T("Setting timestamps on all extracted files...\n"));
1200                 break;
1201         case WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END:
1202                 if (info->extract.extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
1203                         imagex_printf(T("Unmounting NTFS volume \"%"TS"\"...\n"),
1204                                 info->extract.target);
1205                 }
1206                 break;
1207         case WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART:
1208                 percent_done = TO_PERCENT(info->split.completed_bytes,
1209                                           info->split.total_bytes);
1210                 unit_shift = get_unit(info->split.total_bytes, &unit_name);
1211                 imagex_printf(T("Writing \"%"TS"\" (part %u of %u): %"PRIu64" %"TS" of "
1212                           "%"PRIu64" %"TS" (%u%%) written\n"),
1213                         info->split.part_name,
1214                         info->split.cur_part_number,
1215                         info->split.total_parts,
1216                         info->split.completed_bytes >> unit_shift,
1217                         unit_name,
1218                         info->split.total_bytes >> unit_shift,
1219                         unit_name,
1220                         percent_done);
1221                 break;
1222         case WIMLIB_PROGRESS_MSG_SPLIT_END_PART:
1223                 if (info->split.completed_bytes == info->split.total_bytes) {
1224                         imagex_printf(T("Finished writing split WIM part %u of %u\n"),
1225                                 info->split.cur_part_number,
1226                                 info->split.total_parts);
1227                 }
1228                 break;
1229         case WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND:
1230                 switch (info->update.command->op) {
1231                 case WIMLIB_UPDATE_OP_DELETE:
1232                         imagex_printf(T("Deleted WIM path "
1233                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1234                                 info->update.command->delete_.wim_path);
1235                         break;
1236                 case WIMLIB_UPDATE_OP_RENAME:
1237                         imagex_printf(T("Renamed WIM path "
1238                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\" => "
1239                                   "\""WIMLIB_WIM_PATH_SEPARATOR_STRING "%"TS"\"\n"),
1240                                 info->update.command->rename.wim_source_path,
1241                                 info->update.command->rename.wim_target_path);
1242                         break;
1243                 case WIMLIB_UPDATE_OP_ADD:
1244                 default:
1245                         break;
1246                 }
1247                 break;
1248         default:
1249                 break;
1250         }
1251         fflush(imagex_info_file);
1252         return 0;
1253 }
1254
1255 static unsigned
1256 parse_num_threads(const tchar *optarg)
1257 {
1258         tchar *tmp;
1259         unsigned long ul_nthreads = tstrtoul(optarg, &tmp, 10);
1260         if (ul_nthreads >= UINT_MAX || *tmp || tmp == optarg) {
1261                 imagex_error(T("Number of threads must be a non-negative integer!"));
1262                 return UINT_MAX;
1263         } else {
1264                 return ul_nthreads;
1265         }
1266 }
1267
1268 static uint32_t parse_chunk_size(const tchar *optarg)
1269 {
1270        tchar *tmp;
1271        unsigned long chunk_size = tstrtoul(optarg, &tmp, 10);
1272        if (chunk_size >= UINT32_MAX || *tmp || tmp == optarg) {
1273                imagex_error(T("Chunk size must be a non-negative integer!"));
1274                return UINT32_MAX;
1275        } else {
1276                return chunk_size;
1277        }
1278 }
1279
1280
1281 /*
1282  * Parse an option passed to an update command.
1283  *
1284  * @op:         One of WIMLIB_UPDATE_OP_* that indicates the command being
1285  *              parsed.
1286  *
1287  * @option:     Text string for the option (beginning with --)
1288  *
1289  * @cmd:        `struct wimlib_update_command' that is being constructed for
1290  *              this command.
1291  *
1292  * Returns true if the option was recognized; false if not.
1293  */
1294 static bool
1295 update_command_add_option(int op, const tchar *option,
1296                           struct wimlib_update_command *cmd)
1297 {
1298         bool recognized = true;
1299         switch (op) {
1300         case WIMLIB_UPDATE_OP_ADD:
1301                 if (!tstrcmp(option, T("--verbose")))
1302                         cmd->add.add_flags |= WIMLIB_ADD_FLAG_VERBOSE;
1303                 else if (!tstrcmp(option, T("--unix-data")))
1304                         cmd->add.add_flags |= WIMLIB_ADD_FLAG_UNIX_DATA;
1305                 else if (!tstrcmp(option, T("--no-acls")) || !tstrcmp(option, T("--noacls")))
1306                         cmd->add.add_flags |= WIMLIB_ADD_FLAG_NO_ACLS;
1307                 else if (!tstrcmp(option, T("--strict-acls")))
1308                         cmd->add.add_flags |= WIMLIB_ADD_FLAG_STRICT_ACLS;
1309                 else if (!tstrcmp(option, T("--dereference")))
1310                         cmd->add.add_flags |= WIMLIB_ADD_FLAG_DEREFERENCE;
1311                 else
1312                         recognized = false;
1313                 break;
1314         case WIMLIB_UPDATE_OP_DELETE:
1315                 if (!tstrcmp(option, T("--force")))
1316                         cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_FORCE;
1317                 else if (!tstrcmp(option, T("--recursive")))
1318                         cmd->delete_.delete_flags |= WIMLIB_DELETE_FLAG_RECURSIVE;
1319                 else
1320                         recognized = false;
1321                 break;
1322         default:
1323                 recognized = false;
1324                 break;
1325         }
1326         return recognized;
1327 }
1328
1329 /* How many nonoption arguments each `imagex update' command expects */
1330 static const unsigned update_command_num_nonoptions[] = {
1331         [WIMLIB_UPDATE_OP_ADD] = 2,
1332         [WIMLIB_UPDATE_OP_DELETE] = 1,
1333         [WIMLIB_UPDATE_OP_RENAME] = 2,
1334 };
1335
1336 static void
1337 update_command_add_nonoption(int op, const tchar *nonoption,
1338                              struct wimlib_update_command *cmd,
1339                              unsigned num_nonoptions)
1340 {
1341         switch (op) {
1342         case WIMLIB_UPDATE_OP_ADD:
1343                 if (num_nonoptions == 0)
1344                         cmd->add.fs_source_path = (tchar*)nonoption;
1345                 else
1346                         cmd->add.wim_target_path = (tchar*)nonoption;
1347                 break;
1348         case WIMLIB_UPDATE_OP_DELETE:
1349                 cmd->delete_.wim_path = (tchar*)nonoption;
1350                 break;
1351         case WIMLIB_UPDATE_OP_RENAME:
1352                 if (num_nonoptions == 0)
1353                         cmd->rename.wim_source_path = (tchar*)nonoption;
1354                 else
1355                         cmd->rename.wim_target_path = (tchar*)nonoption;
1356                 break;
1357         }
1358 }
1359
1360 /*
1361  * Parse a command passed on stdin to `imagex update'.
1362  *
1363  * @line:       Text of the command.
1364  * @len:        Length of the line, including a null terminator
1365  *              at line[len - 1].
1366  *
1367  * @command:    A `struct wimlib_update_command' to fill in from the parsed
1368  *              line.
1369  *
1370  * @line_number: Line number of the command, for diagnostics.
1371  *
1372  * Returns true on success; returns false on parse error.
1373  */
1374 static bool
1375 parse_update_command(tchar *line, size_t len,
1376                      struct wimlib_update_command *command,
1377                      size_t line_number)
1378 {
1379         int ret;
1380         tchar *command_name;
1381         int op;
1382         size_t num_nonoptions;
1383
1384         /* Get the command name ("add", "delete", "rename") */
1385         ret = parse_string(&line, &len, &command_name);
1386         if (ret != PARSE_STRING_SUCCESS)
1387                 return false;
1388
1389         if (!tstrcasecmp(command_name, T("add"))) {
1390                 op = WIMLIB_UPDATE_OP_ADD;
1391         } else if (!tstrcasecmp(command_name, T("delete"))) {
1392                 op = WIMLIB_UPDATE_OP_DELETE;
1393         } else if (!tstrcasecmp(command_name, T("rename"))) {
1394                 op = WIMLIB_UPDATE_OP_RENAME;
1395         } else {
1396                 imagex_error(T("Unknown update command \"%"TS"\" on line %zu"),
1397                              command_name, line_number);
1398                 return false;
1399         }
1400         command->op = op;
1401
1402         /* Parse additional options and non-options as needed */
1403         num_nonoptions = 0;
1404         for (;;) {
1405                 tchar *next_string;
1406
1407                 ret = parse_string(&line, &len, &next_string);
1408                 if (ret == PARSE_STRING_NONE) /* End of line */
1409                         break;
1410                 else if (ret != PARSE_STRING_SUCCESS) /* Parse failure */
1411                         return false;
1412                 if (next_string[0] == T('-') && next_string[1] == T('-')) {
1413                         /* Option */
1414                         if (!update_command_add_option(op, next_string, command))
1415                         {
1416                                 imagex_error(T("Unrecognized option \"%"TS"\" to "
1417                                                "update command \"%"TS"\" on line %zu"),
1418                                              next_string, command_name, line_number);
1419
1420                                 return false;
1421                         }
1422                 } else {
1423                         /* Nonoption */
1424                         if (num_nonoptions == update_command_num_nonoptions[op])
1425                         {
1426                                 imagex_error(T("Unexpected argument \"%"TS"\" in "
1427                                                "update command on line %zu\n"
1428                                                "       (The \"%"TS"\" command only "
1429                                                "takes %zu nonoption arguments!)\n"),
1430                                              next_string, line_number,
1431                                              command_name, num_nonoptions);
1432                                 return false;
1433                         }
1434                         update_command_add_nonoption(op, next_string,
1435                                                      command, num_nonoptions);
1436                         num_nonoptions++;
1437                 }
1438         }
1439
1440         if (num_nonoptions != update_command_num_nonoptions[op]) {
1441                 imagex_error(T("Not enough arguments to update command "
1442                                "\"%"TS"\" on line %zu"), command_name, line_number);
1443                 return false;
1444         }
1445         return true;
1446 }
1447
1448 static struct wimlib_update_command *
1449 parse_update_command_file(tchar **cmd_file_contents_p, size_t cmd_file_nchars,
1450                           size_t *num_cmds_ret)
1451 {
1452         ssize_t nlines;
1453         tchar *p;
1454         struct wimlib_update_command *cmds;
1455         size_t i, j;
1456
1457         nlines = text_file_count_lines(cmd_file_contents_p,
1458                                        &cmd_file_nchars);
1459         if (nlines < 0)
1460                 return NULL;
1461
1462         /* Always allocate at least 1 slot, just in case the implementation of
1463          * calloc() returns NULL if 0 bytes are requested. */
1464         cmds = calloc(nlines ?: 1, sizeof(struct wimlib_update_command));
1465         if (!cmds) {
1466                 imagex_error(T("out of memory"));
1467                 return NULL;
1468         }
1469         p = *cmd_file_contents_p;
1470         j = 0;
1471         for (i = 0; i < nlines; i++) {
1472                 /* XXX: Could use rawmemchr() here instead, but it may not be
1473                  * available on all platforms. */
1474                 tchar *endp = tmemchr(p, T('\n'), cmd_file_nchars);
1475                 size_t len = endp - p + 1;
1476                 *endp = T('\0');
1477                 if (!is_comment_line(p, len)) {
1478                         if (!parse_update_command(p, len, &cmds[j++], i + 1)) {
1479                                 free(cmds);
1480                                 return NULL;
1481                         }
1482                 }
1483                 p = endp + 1;
1484         }
1485         *num_cmds_ret = j;
1486         return cmds;
1487 }
1488
1489 /* Apply one image, or all images, from a WIM file into a directory, OR apply
1490  * one image from a WIM file to a NTFS volume.  */
1491 static int
1492 imagex_apply(int argc, tchar **argv, int cmd)
1493 {
1494         int c;
1495         int open_flags = 0;
1496         int image = WIMLIB_NO_IMAGE;
1497         WIMStruct *wim;
1498         struct wimlib_wim_info info;
1499         int ret;
1500         const tchar *wimfile;
1501         const tchar *target;
1502         const tchar *image_num_or_name = NULL;
1503         int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
1504
1505         STRING_SET(refglobs);
1506
1507         for_opt(c, apply_options) {
1508                 switch (c) {
1509                 case IMAGEX_CHECK_OPTION:
1510                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1511                         break;
1512                 case IMAGEX_HARDLINK_OPTION:
1513                         extract_flags |= WIMLIB_EXTRACT_FLAG_HARDLINK;
1514                         break;
1515                 case IMAGEX_SYMLINK_OPTION:
1516                         extract_flags |= WIMLIB_EXTRACT_FLAG_SYMLINK;
1517                         break;
1518                 case IMAGEX_VERBOSE_OPTION:
1519                         extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
1520                         break;
1521                 case IMAGEX_REF_OPTION:
1522                         ret = string_set_append(&refglobs, optarg);
1523                         if (ret)
1524                                 goto out_free_refglobs;
1525                         break;
1526                 case IMAGEX_UNIX_DATA_OPTION:
1527                         extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
1528                         break;
1529                 case IMAGEX_NO_ACLS_OPTION:
1530                         extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
1531                         break;
1532                 case IMAGEX_STRICT_ACLS_OPTION:
1533                         extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
1534                         break;
1535                 case IMAGEX_NORPFIX_OPTION:
1536                         extract_flags |= WIMLIB_EXTRACT_FLAG_NORPFIX;
1537                         break;
1538                 case IMAGEX_RPFIX_OPTION:
1539                         extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
1540                         break;
1541                 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
1542                         extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
1543                         extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
1544                         break;
1545                 case IMAGEX_RESUME_OPTION:
1546                         extract_flags |= WIMLIB_EXTRACT_FLAG_RESUME;
1547                         break;
1548                 default:
1549                         goto out_usage;
1550                 }
1551         }
1552         argc -= optind;
1553         argv += optind;
1554         if (argc != 2 && argc != 3)
1555                 goto out_usage;
1556
1557         wimfile = argv[0];
1558
1559         if (!tstrcmp(wimfile, T("-"))) {
1560                 /* Attempt to apply pipable WIM from standard input.  */
1561                 if (argc == 2) {
1562                         image_num_or_name = NULL;
1563                         target = argv[1];
1564                 } else {
1565                         image_num_or_name = argv[1];
1566                         target = argv[2];
1567                 }
1568                 wim = NULL;
1569         } else {
1570                 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1571                                       imagex_progress_func);
1572                 if (ret)
1573                         goto out_free_refglobs;
1574
1575                 wimlib_get_wim_info(wim, &info);
1576
1577                 if (argc >= 3) {
1578                         /* Image explicitly specified.  */
1579                         image_num_or_name = argv[1];
1580                         image = wimlib_resolve_image(wim, image_num_or_name);
1581                         ret = verify_image_exists(image, image_num_or_name, wimfile);
1582                         if (ret)
1583                                 goto out_wimlib_free;
1584                         target = argv[2];
1585                 } else {
1586                         /* No image specified; default to image 1, but only if the WIM
1587                          * contains exactly one image.  */
1588
1589                         if (info.image_count != 1) {
1590                                 imagex_error(T("\"%"TS"\" contains %d images; "
1591                                                "Please select one (or all)."),
1592                                              wimfile, info.image_count);
1593                                 wimlib_free(wim);
1594                                 goto out_usage;
1595                         }
1596                         image = 1;
1597                         target = argv[1];
1598                 }
1599         }
1600
1601         if (refglobs.num_strings) {
1602                 if (wim == NULL) {
1603                         imagex_error(T("Can't specify --ref when applying from stdin!"));
1604                         ret = -1;
1605                         goto out_wimlib_free;
1606                 }
1607                 ret = wim_reference_globs(wim, &refglobs, open_flags);
1608                 if (ret)
1609                         goto out_wimlib_free;
1610         }
1611
1612 #ifndef __WIN32__
1613         {
1614                 /* Interpret a regular file or block device target as a NTFS
1615                  * volume.  */
1616                 struct stat stbuf;
1617
1618                 if (tstat(target, &stbuf)) {
1619                         if (errno != ENOENT) {
1620                                 imagex_error_with_errno(T("Failed to stat \"%"TS"\""),
1621                                                         target);
1622                                 ret = -1;
1623                                 goto out_wimlib_free;
1624                         }
1625                 } else {
1626                         if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode))
1627                                 extract_flags |= WIMLIB_EXTRACT_FLAG_NTFS;
1628                 }
1629         }
1630 #endif
1631
1632         if (wim) {
1633                 ret = wimlib_extract_image(wim, image, target, extract_flags,
1634                                            imagex_progress_func);
1635         } else {
1636                 set_fd_to_binary_mode(STDIN_FILENO);
1637                 ret = wimlib_extract_image_from_pipe(STDIN_FILENO,
1638                                                      image_num_or_name,
1639                                                      target, extract_flags,
1640                                                      imagex_progress_func);
1641         }
1642         if (ret == 0) {
1643                 imagex_printf(T("Done applying WIM image.\n"));
1644         } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
1645                 if (wim) {
1646                         do_resource_not_found_warning(wimfile, &info, &refglobs);
1647                 } else {
1648                         imagex_error(T(        "If you are applying an image "
1649                                                "from a split pipable WIM,\n"
1650                                        "       make sure you have "
1651                                        "concatenated together all parts."));
1652                 }
1653         }
1654 out_wimlib_free:
1655         wimlib_free(wim);
1656 out_free_refglobs:
1657         string_set_destroy(&refglobs);
1658         return ret;
1659
1660 out_usage:
1661         usage(CMD_APPLY, stderr);
1662         ret = -1;
1663         goto out_free_refglobs;
1664 }
1665
1666 /* Create a WIM image from a directory tree, NTFS volume, or multiple files or
1667  * directory trees.  'wimlib-imagex capture': create a new WIM file containing
1668  * the desired image.  'wimlib-imagex append': add a new image to an existing
1669  * WIM file. */
1670 static int
1671 imagex_capture_or_append(int argc, tchar **argv, int cmd)
1672 {
1673         int c;
1674         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
1675         int add_image_flags = WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE |
1676                               WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1677         int write_flags = 0;
1678         int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
1679         uint32_t chunk_size = UINT32_MAX;
1680         const tchar *wimfile;
1681         int wim_fd;
1682         const tchar *name;
1683         const tchar *desc;
1684         const tchar *flags_element = NULL;
1685
1686         WIMStruct *wim;
1687         STRING_SET(base_wimfiles);
1688         WIMStruct **base_wims;
1689
1690         WIMStruct *template_wim;
1691         const tchar *template_wimfile = NULL;
1692         const tchar *template_image_name_or_num = NULL;
1693         int template_image = WIMLIB_NO_IMAGE;
1694
1695         int ret;
1696         unsigned num_threads = 0;
1697
1698         tchar *source;
1699         tchar *source_copy;
1700
1701         const tchar *config_file = NULL;
1702         tchar *config_str;
1703         struct wimlib_capture_config *config;
1704
1705         bool source_list = false;
1706         size_t source_list_nchars = 0;
1707         tchar *source_list_contents;
1708         bool capture_sources_malloced;
1709         struct wimlib_capture_source *capture_sources;
1710         size_t num_sources;
1711         bool name_defaulted;
1712
1713         for_opt(c, capture_or_append_options) {
1714                 switch (c) {
1715                 case IMAGEX_BOOT_OPTION:
1716                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_BOOT;
1717                         break;
1718                 case IMAGEX_CHECK_OPTION:
1719                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
1720                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
1721                         break;
1722                 case IMAGEX_NOCHECK_OPTION:
1723                         write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
1724                         break;
1725                 case IMAGEX_CONFIG_OPTION:
1726                         config_file = optarg;
1727                         add_image_flags &= ~WIMLIB_ADD_IMAGE_FLAG_WINCONFIG;
1728                         break;
1729                 case IMAGEX_COMPRESS_OPTION:
1730                         compression_type = get_compression_type(optarg);
1731                         if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
1732                                 goto out_err;
1733                         break;
1734                 case IMAGEX_COMPRESS_SLOW_OPTION:
1735                         ret = set_compress_slow();
1736                         if (ret)
1737                                 goto out_err;
1738                         compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1739                         break;
1740                 case IMAGEX_CHUNK_SIZE_OPTION:
1741                         chunk_size = parse_chunk_size(optarg);
1742                         if (chunk_size == UINT32_MAX)
1743                                 goto out_err;
1744                         break;
1745                 case IMAGEX_PACK_STREAMS_OPTION:
1746                         write_flags |= WIMLIB_WRITE_FLAG_PACK_STREAMS;
1747                         break;
1748                 case IMAGEX_FLAGS_OPTION:
1749                         flags_element = optarg;
1750                         break;
1751                 case IMAGEX_DEREFERENCE_OPTION:
1752                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE;
1753                         break;
1754                 case IMAGEX_VERBOSE_OPTION:
1755                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_VERBOSE;
1756                         break;
1757                 case IMAGEX_THREADS_OPTION:
1758                         num_threads = parse_num_threads(optarg);
1759                         if (num_threads == UINT_MAX)
1760                                 goto out_err;
1761                         break;
1762                 case IMAGEX_REBUILD_OPTION:
1763                         write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
1764                         break;
1765                 case IMAGEX_UNIX_DATA_OPTION:
1766                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA;
1767                         break;
1768                 case IMAGEX_SOURCE_LIST_OPTION:
1769                         source_list = true;
1770                         break;
1771                 case IMAGEX_NO_ACLS_OPTION:
1772                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NO_ACLS;
1773                         break;
1774                 case IMAGEX_STRICT_ACLS_OPTION:
1775                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS;
1776                         break;
1777                 case IMAGEX_RPFIX_OPTION:
1778                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
1779                         break;
1780                 case IMAGEX_NORPFIX_OPTION:
1781                         add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NORPFIX;
1782                         break;
1783                 case IMAGEX_PIPABLE_OPTION:
1784                         write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1785                         break;
1786                 case IMAGEX_NOT_PIPABLE_OPTION:
1787                         write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
1788                         break;
1789                 case IMAGEX_UPDATE_OF_OPTION:
1790                         if (template_image_name_or_num) {
1791                                 imagex_error(T("'--update-of' can only be "
1792                                                "specified one time!"));
1793                                 goto out_err;
1794                         } else {
1795                                 tchar *colon;
1796                                 colon = tstrrchr(optarg, T(':'));
1797
1798                                 if (colon) {
1799                                         template_wimfile = optarg;
1800                                         *colon = T('\0');
1801                                         template_image_name_or_num = colon + 1;
1802                                 } else {
1803                                         template_wimfile = NULL;
1804                                         template_image_name_or_num = optarg;
1805                                 }
1806                         }
1807                         break;
1808                 case IMAGEX_DELTA_FROM_OPTION:
1809                         if (cmd != CMD_CAPTURE) {
1810                                 imagex_error(T("'--delta-from' is only "
1811                                                "valid for capture!"));
1812                                 goto out_usage;
1813                         }
1814                         ret = string_set_append(&base_wimfiles, optarg);
1815                         if (ret)
1816                                 goto out_free_base_wimfiles;
1817                         write_flags |= WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS;
1818                         break;
1819                 default:
1820                         goto out_usage;
1821                 }
1822         }
1823         argc -= optind;
1824         argv += optind;
1825
1826         if (argc < 2 || argc > 4)
1827                 goto out_usage;
1828
1829         source = argv[0];
1830         wimfile = argv[1];
1831
1832         /* Set default compression type.  */
1833         if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
1834                 struct wimlib_lzx_params params;
1835                 memset(&params, 0, sizeof(params));
1836                 params.size_of_this = sizeof(params);
1837                 params.algorithm = WIMLIB_LZX_ALGORITHM_FAST;
1838                 params.use_defaults = 1;
1839
1840                 wimlib_lzx_set_default_params(&params);
1841                 compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
1842         }
1843
1844         if (!tstrcmp(wimfile, T("-"))) {
1845                 /* Writing captured WIM to standard output.  */
1846         #if 0
1847                 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
1848                         imagex_error("Can't write a non-pipable WIM to "
1849                                      "standard output!  Specify --pipable\n"
1850                                      "       if you want to create a pipable WIM "
1851                                      "(but read the docs first).");
1852                         goto out_err;
1853                 }
1854         #else
1855                 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
1856         #endif
1857                 if (cmd == CMD_APPEND) {
1858                         imagex_error(T("Using standard output for append does "
1859                                        "not make sense."));
1860                         goto out_err;
1861                 }
1862                 wim_fd = STDOUT_FILENO;
1863                 wimfile = NULL;
1864                 imagex_info_file = stderr;
1865                 set_fd_to_binary_mode(wim_fd);
1866         }
1867
1868         /* If template image was specified using --update-of=IMAGE rather
1869          * than --update-of=WIMFILE:IMAGE, set the default WIMFILE.  */
1870         if (template_image_name_or_num && !template_wimfile) {
1871                 if (base_wimfiles.num_strings == 1) {
1872                         /* Capturing delta WIM based on single WIM:  default to
1873                          * base WIM.  */
1874                         template_wimfile = base_wimfiles.strings[0];
1875                 } else if (cmd == CMD_APPEND) {
1876                         /* Appending to WIM:  default to WIM being appended to.
1877                          */
1878                         template_wimfile = wimfile;
1879                 } else {
1880                         /* Capturing a normal (non-delta) WIM, so the WIM file
1881                          * *must* be explicitly specified.  */
1882                         if (base_wimfiles.num_strings > 1) {
1883                                 imagex_error(T("For capture of delta WIM "
1884                                                "based on multiple existing "
1885                                                "WIMs,\n"
1886                                                "      '--update-of' must "
1887                                                "specify WIMFILE:IMAGE!"));
1888                         } else {
1889                                 imagex_error(T("For capture of non-delta WIM, "
1890                                                "'--update-of' must specify "
1891                                                "WIMFILE:IMAGE!"));
1892                         }
1893                         goto out_usage;
1894                 }
1895         }
1896
1897         if (argc >= 3) {
1898                 name = argv[2];
1899                 name_defaulted = false;
1900         } else {
1901                 /* Set default name to SOURCE argument, omitting any directory
1902                  * prefixes and trailing slashes.  This requires making a copy
1903                  * of @source.  Leave some free characters at the end in case we
1904                  * append a number to keep the name unique. */
1905                 size_t source_name_len;
1906
1907                 source_name_len = tstrlen(source);
1908                 source_copy = alloca((source_name_len + 1 + 25) * sizeof(tchar));
1909                 name = tbasename(tstrcpy(source_copy, source));
1910                 name_defaulted = true;
1911         }
1912         /* Image description defaults to NULL if not given. */
1913         if (argc >= 4)
1914                 desc = argv[3];
1915         else
1916                 desc = NULL;
1917
1918         if (source_list) {
1919                 /* Set up capture sources in source list mode */
1920                 if (source[0] == T('-') && source[1] == T('\0')) {
1921                         source_list_contents = stdin_get_text_contents(&source_list_nchars);
1922                 } else {
1923                         source_list_contents = file_get_text_contents(source,
1924                                                                       &source_list_nchars);
1925                 }
1926                 if (!source_list_contents)
1927                         goto out_err;
1928
1929                 capture_sources = parse_source_list(&source_list_contents,
1930                                                     source_list_nchars,
1931                                                     &num_sources);
1932                 if (!capture_sources) {
1933                         ret = -1;
1934                         goto out_free_source_list_contents;
1935                 }
1936                 capture_sources_malloced = true;
1937         } else {
1938                 /* Set up capture source in non-source-list mode.  */
1939                 capture_sources = alloca(sizeof(struct wimlib_capture_source));
1940                 capture_sources[0].fs_source_path = source;
1941                 capture_sources[0].wim_target_path = NULL;
1942                 capture_sources[0].reserved = 0;
1943                 num_sources = 1;
1944                 capture_sources_malloced = false;
1945                 source_list_contents = NULL;
1946         }
1947
1948         if (config_file) {
1949                 /* Read and parse capture configuration file.  */
1950                 size_t config_len;
1951
1952                 config_str = file_get_text_contents(config_file, &config_len);
1953                 if (!config_str) {
1954                         ret = -1;
1955                         goto out_free_capture_sources;
1956                 }
1957
1958                 config = alloca(sizeof(*config));
1959                 ret = parse_capture_config(&config_str, config_len, config);
1960                 if (ret)
1961                         goto out_free_config;
1962         } else {
1963                 /* No capture configuration file specified; use default
1964                  * configuration for capturing Windows operating systems.  */
1965                 config = NULL;
1966                 add_image_flags |= WIMLIB_ADD_FLAG_WINCONFIG;
1967         }
1968
1969         /* Open the existing WIM, or create a new one.  */
1970         if (cmd == CMD_APPEND)
1971                 ret = wimlib_open_wim(wimfile, open_flags, &wim,
1972                                       imagex_progress_func);
1973         else
1974                 ret = wimlib_create_new_wim(compression_type, &wim);
1975         if (ret)
1976                 goto out_free_config;
1977
1978         /* Set chunk size if non-default.  */
1979         if (chunk_size != UINT32_MAX) {
1980                 ret = wimlib_set_output_chunk_size(wim, chunk_size);
1981                 if (ret)
1982                         goto out_free_wim;
1983         }
1984
1985 #ifndef __WIN32__
1986         /* Detect if source is regular file or block device and set NTFS volume
1987          * capture mode.  */
1988         if (!source_list) {
1989                 struct stat stbuf;
1990
1991                 if (tstat(source, &stbuf) == 0) {
1992                         if (S_ISBLK(stbuf.st_mode) || S_ISREG(stbuf.st_mode)) {
1993                                 imagex_printf(T("Capturing WIM image from NTFS "
1994                                           "filesystem on \"%"TS"\"\n"), source);
1995                                 add_image_flags |= WIMLIB_ADD_IMAGE_FLAG_NTFS;
1996                         }
1997                 } else {
1998                         if (errno != ENOENT) {
1999                                 imagex_error_with_errno(T("Failed to stat "
2000                                                           "\"%"TS"\""), source);
2001                                 ret = -1;
2002                                 goto out_free_wim;
2003                         }
2004                 }
2005         }
2006 #endif
2007
2008         /* If the user did not specify an image name, and the basename of the
2009          * source already exists as an image name in the WIM file, append a
2010          * suffix to make it unique. */
2011         if (cmd == CMD_APPEND && name_defaulted) {
2012                 unsigned long conflict_idx;
2013                 tchar *name_end = tstrchr(name, T('\0'));
2014                 for (conflict_idx = 1;
2015                      wimlib_image_name_in_use(wim, name);
2016                      conflict_idx++)
2017                 {
2018                         tsprintf(name_end, T(" (%lu)"), conflict_idx);
2019                 }
2020         }
2021
2022         /* If capturing a delta WIM, reference resources from the base WIMs
2023          * before adding the new image.  */
2024         if (base_wimfiles.num_strings) {
2025                 base_wims = calloc(base_wimfiles.num_strings,
2026                                    sizeof(base_wims[0]));
2027                 if (base_wims == NULL) {
2028                         imagex_error(T("Out of memory!"));
2029                         ret = -1;
2030                         goto out_free_wim;
2031                 }
2032
2033                 for (size_t i = 0; i < base_wimfiles.num_strings; i++) {
2034                         ret = wimlib_open_wim(base_wimfiles.strings[i],
2035                                               open_flags, &base_wims[i],
2036                                               imagex_progress_func);
2037                         if (ret)
2038                                 goto out_free_base_wims;
2039
2040                 }
2041
2042                 ret = wimlib_reference_resources(wim, base_wims,
2043                                                  base_wimfiles.num_strings, 0);
2044                 if (ret)
2045                         goto out_free_base_wims;
2046
2047                 if (base_wimfiles.num_strings == 1) {
2048                         imagex_printf(T("Capturing delta WIM based on \"%"TS"\"\n"),
2049                                       base_wimfiles.strings[0]);
2050                 } else {
2051                         imagex_printf(T("Capturing delta WIM based on %u WIMs\n"),
2052                                       base_wimfiles.num_strings);
2053                 }
2054
2055         } else {
2056                 base_wims = NULL;
2057         }
2058
2059         /* If capturing or appending as an update of an existing (template) image,
2060          * open the WIM if needed and parse the image index.  */
2061         if (template_image_name_or_num) {
2062
2063
2064                 if (base_wimfiles.num_strings == 1 &&
2065                     template_wimfile == base_wimfiles.strings[0]) {
2066                         template_wim = base_wims[0];
2067                 } else if (template_wimfile == wimfile) {
2068                         template_wim = wim;
2069                 } else {
2070                         ret = wimlib_open_wim(template_wimfile, open_flags,
2071                                               &template_wim, imagex_progress_func);
2072                         if (ret)
2073                                 goto out_free_base_wims;
2074                 }
2075
2076                 template_image = wimlib_resolve_image(template_wim,
2077                                                       template_image_name_or_num);
2078
2079                 if (template_image_name_or_num[0] == T('-')) {
2080                         tchar *tmp;
2081                         unsigned long n;
2082                         struct wimlib_wim_info info;
2083
2084                         wimlib_get_wim_info(template_wim, &info);
2085                         n = tstrtoul(template_image_name_or_num + 1, &tmp, 10);
2086                         if (n >= 1 && n <= info.image_count &&
2087                             *tmp == T('\0') &&
2088                             tmp != template_image_name_or_num + 1)
2089                         {
2090                                 template_image = info.image_count - (n - 1);
2091                         }
2092                 }
2093                 ret = verify_image_exists_and_is_single(template_image,
2094                                                         template_image_name_or_num,
2095                                                         template_wimfile);
2096                 if (ret)
2097                         goto out_free_template_wim;
2098         } else {
2099                 template_wim = NULL;
2100         }
2101
2102         ret = wimlib_add_image_multisource(wim,
2103                                            capture_sources,
2104                                            num_sources,
2105                                            name,
2106                                            config,
2107                                            add_image_flags,
2108                                            imagex_progress_func);
2109         if (ret)
2110                 goto out_free_template_wim;
2111
2112         if (desc || flags_element || template_image_name_or_num) {
2113                 /* User provided <DESCRIPTION> or <FLAGS> element, or an image
2114                  * on which the added one is to be based has been specified with
2115                  * --update-of.  Get the index of the image we just
2116                  *  added, then use it to call the appropriate functions.  */
2117                 struct wimlib_wim_info info;
2118
2119                 wimlib_get_wim_info(wim, &info);
2120
2121                 if (desc) {
2122                         ret = wimlib_set_image_descripton(wim,
2123                                                           info.image_count,
2124                                                           desc);
2125                         if (ret)
2126                                 goto out_free_template_wim;
2127                 }
2128
2129                 if (flags_element) {
2130                         ret = wimlib_set_image_flags(wim, info.image_count,
2131                                                      flags_element);
2132                         if (ret)
2133                                 goto out_free_template_wim;
2134                 }
2135
2136                 /* Reference template image if the user provided one.  */
2137                 if (template_image_name_or_num) {
2138                         imagex_printf(T("Using image %d "
2139                                         "from \"%"TS"\" as template\n"),
2140                                         template_image, template_wimfile);
2141                         ret = wimlib_reference_template_image(wim,
2142                                                               info.image_count,
2143                                                               template_wim,
2144                                                               template_image,
2145                                                               0, NULL);
2146                         if (ret)
2147                                 goto out_free_template_wim;
2148                 }
2149         }
2150
2151         /* Write the new WIM or overwrite the existing WIM with the new image
2152          * appended.  */
2153         if (cmd == CMD_APPEND) {
2154                 ret = wimlib_overwrite(wim, write_flags, num_threads,
2155                                        imagex_progress_func);
2156         } else if (wimfile) {
2157                 ret = wimlib_write(wim, wimfile, WIMLIB_ALL_IMAGES,
2158                                    write_flags, num_threads,
2159                                    imagex_progress_func);
2160         } else {
2161                 ret = wimlib_write_to_fd(wim, wim_fd, WIMLIB_ALL_IMAGES,
2162                                          write_flags, num_threads,
2163                                          imagex_progress_func);
2164         }
2165 out_free_template_wim:
2166         /* template_wim may alias base_wims[0] or wim.  */
2167         if ((base_wimfiles.num_strings != 1 || template_wim != base_wims[0]) &&
2168             template_wim != wim)
2169                 wimlib_free(template_wim);
2170 out_free_base_wims:
2171         for (size_t i = 0; i < base_wimfiles.num_strings; i++)
2172                 wimlib_free(base_wims[i]);
2173         free(base_wims);
2174 out_free_wim:
2175         wimlib_free(wim);
2176 out_free_config:
2177         if (config) {
2178                 free(config->exclusion_pats.pats);
2179                 free(config->exclusion_exception_pats.pats);
2180                 free(config_str);
2181         }
2182 out_free_capture_sources:
2183         if (capture_sources_malloced)
2184                 free(capture_sources);
2185 out_free_source_list_contents:
2186         free(source_list_contents);
2187 out_free_base_wimfiles:
2188         string_set_destroy(&base_wimfiles);
2189         return ret;
2190
2191 out_usage:
2192         usage(cmd, stderr);
2193 out_err:
2194         ret = -1;
2195         goto out_free_base_wimfiles;
2196 }
2197
2198 /* Remove image(s) from a WIM. */
2199 static int
2200 imagex_delete(int argc, tchar **argv, int cmd)
2201 {
2202         int c;
2203         int open_flags = WIMLIB_OPEN_FLAG_WRITE_ACCESS;
2204         int write_flags = 0;
2205         const tchar *wimfile;
2206         const tchar *image_num_or_name;
2207         WIMStruct *wim;
2208         int image;
2209         int ret;
2210
2211         for_opt(c, delete_options) {
2212                 switch (c) {
2213                 case IMAGEX_CHECK_OPTION:
2214                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2215                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2216                         break;
2217                 case IMAGEX_SOFT_OPTION:
2218                         write_flags |= WIMLIB_WRITE_FLAG_SOFT_DELETE;
2219                         break;
2220                 default:
2221                         goto out_usage;
2222                 }
2223         }
2224         argc -= optind;
2225         argv += optind;
2226
2227         if (argc != 2) {
2228                 if (argc < 1)
2229                         imagex_error(T("Must specify a WIM file"));
2230                 if (argc < 2)
2231                         imagex_error(T("Must specify an image"));
2232                 goto out_usage;
2233         }
2234         wimfile = argv[0];
2235         image_num_or_name = argv[1];
2236
2237         ret = wimlib_open_wim(wimfile, open_flags, &wim,
2238                               imagex_progress_func);
2239         if (ret)
2240                 goto out;
2241
2242         image = wimlib_resolve_image(wim, image_num_or_name);
2243
2244         ret = verify_image_exists(image, image_num_or_name, wimfile);
2245         if (ret)
2246                 goto out_wimlib_free;
2247
2248         ret = wimlib_delete_image(wim, image);
2249         if (ret) {
2250                 imagex_error(T("Failed to delete image from \"%"TS"\""),
2251                              wimfile);
2252                 goto out_wimlib_free;
2253         }
2254
2255         ret = wimlib_overwrite(wim, write_flags, 0, imagex_progress_func);
2256         if (ret) {
2257                 imagex_error(T("Failed to write the file \"%"TS"\" with image "
2258                                "deleted"), wimfile);
2259         }
2260 out_wimlib_free:
2261         wimlib_free(wim);
2262 out:
2263         return ret;
2264
2265 out_usage:
2266         usage(CMD_DELETE, stderr);
2267         ret = -1;
2268         goto out;
2269 }
2270
2271 static int
2272 print_full_path(const struct wimlib_dir_entry *wdentry, void *_ignore)
2273 {
2274         int ret = tprintf(T("%"TS"\n"), wdentry->full_path);
2275         return (ret >= 0) ? 0 : -1;
2276 }
2277
2278 /* Print the files contained in an image(s) in a WIM file. */
2279 static int
2280 imagex_dir(int argc, tchar **argv, int cmd)
2281 {
2282         const tchar *wimfile;
2283         WIMStruct *wim = NULL;
2284         int image;
2285         int ret;
2286         const tchar *path = T("");
2287         int c;
2288
2289         for_opt(c, dir_options) {
2290                 switch (c) {
2291                 case IMAGEX_PATH_OPTION:
2292                         path = optarg;
2293                         break;
2294                 default:
2295                         goto out_usage;
2296                 }
2297         }
2298         argc -= optind;
2299         argv += optind;
2300
2301         if (argc < 1) {
2302                 imagex_error(T("Must specify a WIM file"));
2303                 goto out_usage;
2304         }
2305         if (argc > 2) {
2306                 imagex_error(T("Too many arguments"));
2307                 goto out_usage;
2308         }
2309
2310         wimfile = argv[0];
2311         ret = wimlib_open_wim(wimfile, 0, &wim, imagex_progress_func);
2312         if (ret)
2313                 goto out;
2314
2315         if (argc >= 2) {
2316                 image = wimlib_resolve_image(wim, argv[1]);
2317                 ret = verify_image_exists(image, argv[1], wimfile);
2318                 if (ret)
2319                         goto out_wimlib_free;
2320         } else {
2321                 /* No image specified; default to image 1, but only if the WIM
2322                  * contains exactly one image.  */
2323
2324                 struct wimlib_wim_info info;
2325
2326                 wimlib_get_wim_info(wim, &info);
2327                 if (info.image_count != 1) {
2328                         imagex_error(T("\"%"TS"\" contains %d images; Please "
2329                                        "select one (or all)."),
2330                                      wimfile, info.image_count);
2331                         wimlib_free(wim);
2332                         goto out_usage;
2333                 }
2334                 image = 1;
2335         }
2336
2337         ret = wimlib_iterate_dir_tree(wim, image, path,
2338                                       WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE,
2339                                       print_full_path, NULL);
2340 out_wimlib_free:
2341         wimlib_free(wim);
2342 out:
2343         return ret;
2344
2345 out_usage:
2346         usage(CMD_DIR, stderr);
2347         ret = -1;
2348         goto out;
2349 }
2350
2351 /* Exports one, or all, images from a WIM file to a new WIM file or an existing
2352  * WIM file. */
2353 static int
2354 imagex_export(int argc, tchar **argv, int cmd)
2355 {
2356         int c;
2357         int open_flags = 0;
2358         int export_flags = 0;
2359         int write_flags = 0;
2360         int compression_type = WIMLIB_COMPRESSION_TYPE_INVALID;
2361         const tchar *src_wimfile;
2362         const tchar *src_image_num_or_name;
2363         const tchar *dest_wimfile;
2364         int dest_wim_fd;
2365         const tchar *dest_name;
2366         const tchar *dest_desc;
2367         WIMStruct *src_wim;
2368         struct wimlib_wim_info src_info;
2369         WIMStruct *dest_wim;
2370         int ret;
2371         int image;
2372         struct stat stbuf;
2373         bool wim_is_new;
2374         STRING_SET(refglobs);
2375         unsigned num_threads = 0;
2376
2377         for_opt(c, export_options) {
2378                 switch (c) {
2379                 case IMAGEX_BOOT_OPTION:
2380                         export_flags |= WIMLIB_EXPORT_FLAG_BOOT;
2381                         break;
2382                 case IMAGEX_CHECK_OPTION:
2383                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2384                         write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
2385                         break;
2386                 case IMAGEX_NOCHECK_OPTION:
2387                         write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
2388                         break;
2389                 case IMAGEX_COMPRESS_OPTION:
2390                         compression_type = get_compression_type(optarg);
2391                         if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID)
2392                                 goto out_err;
2393                         break;
2394                 case IMAGEX_REF_OPTION:
2395                         ret = string_set_append(&refglobs, optarg);
2396                         if (ret)
2397                                 goto out_free_refglobs;
2398                         break;
2399                 case IMAGEX_THREADS_OPTION:
2400                         num_threads = parse_num_threads(optarg);
2401                         if (num_threads == UINT_MAX)
2402                                 goto out_err;
2403                         break;
2404                 case IMAGEX_REBUILD_OPTION:
2405                         write_flags |= WIMLIB_WRITE_FLAG_REBUILD;
2406                         break;
2407                 case IMAGEX_PIPABLE_OPTION:
2408                         write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2409                         break;
2410                 case IMAGEX_NOT_PIPABLE_OPTION:
2411                         write_flags |= WIMLIB_WRITE_FLAG_NOT_PIPABLE;
2412                         break;
2413                 default:
2414                         goto out_usage;
2415                 }
2416         }
2417         argc -= optind;
2418         argv += optind;
2419         if (argc < 3 || argc > 5)
2420                 goto out_usage;
2421         src_wimfile           = argv[0];
2422         src_image_num_or_name = argv[1];
2423         dest_wimfile          = argv[2];
2424         dest_name             = (argc >= 4) ? argv[3] : NULL;
2425         dest_desc             = (argc >= 5) ? argv[4] : NULL;
2426         ret = wimlib_open_wim(src_wimfile, open_flags, &src_wim,
2427                               imagex_progress_func);
2428         if (ret)
2429                 goto out_free_refglobs;
2430
2431         wimlib_get_wim_info(src_wim, &src_info);
2432
2433         /* Determine if the destination is an existing file or not.  If so, we
2434          * try to append the exported image(s) to it; otherwise, we create a new
2435          * WIM containing the exported image(s).  Furthermore, determine if we
2436          * need to write a pipable WIM directly to standard output.  */
2437
2438         if (tstrcmp(dest_wimfile, T("-")) == 0) {
2439         #if 0
2440                 if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
2441                         imagex_error("Can't write a non-pipable WIM to "
2442                                      "standard output!  Specify --pipable\n"
2443                                      "       if you want to create a pipable WIM "
2444                                      "(but read the docs first).");
2445                         ret = -1;
2446                         goto out_free_src_wim;
2447                 }
2448         #else
2449                 write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
2450         #endif
2451                 dest_wimfile = NULL;
2452                 dest_wim_fd = STDOUT_FILENO;
2453                 imagex_info_file = stderr;
2454                 set_fd_to_binary_mode(dest_wim_fd);
2455         }
2456         errno = ENOENT;
2457         if (dest_wimfile != NULL && tstat(dest_wimfile, &stbuf) == 0) {
2458                 wim_is_new = false;
2459                 /* Destination file exists. */
2460
2461                 if (!S_ISREG(stbuf.st_mode)) {
2462                         imagex_error(T("\"%"TS"\" is not a regular file"),
2463                                      dest_wimfile);
2464                         ret = -1;
2465                         goto out_free_src_wim;
2466                 }
2467                 ret = wimlib_open_wim(dest_wimfile,
2468                                       open_flags | WIMLIB_OPEN_FLAG_WRITE_ACCESS,
2469                                       &dest_wim, imagex_progress_func);
2470                 if (ret)
2471                         goto out_free_src_wim;
2472
2473                 if (compression_type != WIMLIB_COMPRESSION_TYPE_INVALID) {
2474                         /* The user specified a compression type, but we're
2475                          * exporting to an existing WIM.  Make sure the
2476                          * specified compression type is the same as the
2477                          * compression type of the existing destination WIM. */
2478                         struct wimlib_wim_info dest_info;
2479
2480                         wimlib_get_wim_info(dest_wim, &dest_info);
2481                         if (compression_type != dest_info.compression_type) {
2482                                 imagex_error(T("Cannot specify a compression type that is "
2483                                                "not the same as that used in the "
2484                                                "destination WIM"));
2485                                 ret = -1;
2486                                 goto out_free_dest_wim;
2487                         }
2488                 }
2489         } else {
2490                 wim_is_new = true;
2491
2492                 if (errno != ENOENT) {
2493                         imagex_error_with_errno(T("Cannot stat file \"%"TS"\""),
2494                                                 dest_wimfile);
2495                         ret = -1;
2496                         goto out_free_src_wim;
2497                 }
2498
2499                 /* dest_wimfile is not an existing file, so create a new WIM. */
2500
2501                 if (compression_type == WIMLIB_COMPRESSION_TYPE_INVALID) {
2502                         /* The user did not specify a compression type; default
2503                          * to that of the source WIM.  */
2504
2505                         compression_type = src_info.compression_type;
2506                 }
2507                 ret = wimlib_create_new_wim(compression_type, &dest_wim);
2508                 if (ret)
2509                         goto out_free_src_wim;
2510
2511                 wimlib_set_output_chunk_size(dest_wim, src_info.chunk_size);
2512         }
2513
2514         image = wimlib_resolve_image(src_wim, src_image_num_or_name);
2515         ret = verify_image_exists(image, src_image_num_or_name, src_wimfile);
2516         if (ret)
2517                 goto out_free_dest_wim;
2518
2519         if (refglobs.num_strings) {
2520                 ret = wim_reference_globs(src_wim, &refglobs, open_flags);
2521                 if (ret)
2522                         goto out_free_dest_wim;
2523         }
2524
2525         if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
2526             image == WIMLIB_ALL_IMAGES && src_info.boot_index == 0)
2527         {
2528                 imagex_error(T("--boot specified for all-images export, but source WIM "
2529                                "has no bootable image."));
2530                 ret = -1;
2531                 goto out_free_dest_wim;
2532         }
2533
2534         ret = wimlib_export_image(src_wim, image, dest_wim, dest_name,
2535                                   dest_desc, export_flags, imagex_progress_func);
2536         if (ret) {
2537                 if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2538                         do_resource_not_found_warning(src_wimfile,
2539                                                       &src_info, &refglobs);
2540                 }
2541                 goto out_free_dest_wim;
2542         }
2543
2544         if (!wim_is_new)
2545                 ret = wimlib_overwrite(dest_wim, write_flags, num_threads,
2546                                        imagex_progress_func);
2547         else if (dest_wimfile)
2548                 ret = wimlib_write(dest_wim, dest_wimfile, WIMLIB_ALL_IMAGES,
2549                                    write_flags, num_threads,
2550                                    imagex_progress_func);
2551         else
2552                 ret = wimlib_write_to_fd(dest_wim, dest_wim_fd,
2553                                          WIMLIB_ALL_IMAGES, write_flags,
2554                                          num_threads, imagex_progress_func);
2555 out_free_dest_wim:
2556         wimlib_free(dest_wim);
2557 out_free_src_wim:
2558         wimlib_free(src_wim);
2559 out_free_refglobs:
2560         string_set_destroy(&refglobs);
2561         return ret;
2562
2563 out_usage:
2564         usage(CMD_EXPORT, stderr);
2565 out_err:
2566         ret = -1;
2567         goto out_free_refglobs;
2568 }
2569
2570 static bool
2571 is_root_wim_path(const tchar *path)
2572 {
2573         const tchar *p;
2574         for (p = path; *p; p++)
2575                 if (*p != T('\\') && *p != T('/'))
2576                         return false;
2577         return true;
2578 }
2579
2580 static void
2581 free_extract_commands(struct wimlib_extract_command *cmds, size_t num_cmds,
2582                       const tchar *dest_dir)
2583 {
2584         for (size_t i = 0; i < num_cmds; i++)
2585                 if (cmds[i].fs_dest_path != dest_dir)
2586                         free(cmds[i].fs_dest_path);
2587         free(cmds);
2588 }
2589
2590 static struct wimlib_extract_command *
2591 prepare_extract_commands(tchar **paths, unsigned num_paths,
2592                          int extract_flags, tchar *dest_dir,
2593                          size_t *num_cmds_ret)
2594 {
2595         struct wimlib_extract_command *cmds;
2596         size_t num_cmds;
2597         tchar *emptystr = T("");
2598
2599         if (num_paths == 0) {
2600                 num_paths = 1;
2601                 paths = &emptystr;
2602         }
2603         num_cmds = num_paths;
2604         cmds = calloc(num_cmds, sizeof(cmds[0]));
2605         if (!cmds) {
2606                 imagex_error(T("Out of memory!"));
2607                 return NULL;
2608         }
2609
2610         for (size_t i = 0; i < num_cmds; i++) {
2611                 cmds[i].extract_flags = extract_flags;
2612                 cmds[i].wim_source_path = paths[i];
2613                 if (is_root_wim_path(paths[i])) {
2614                         cmds[i].fs_dest_path = dest_dir;
2615                 } else {
2616                         size_t len = tstrlen(dest_dir) + 1 + tstrlen(paths[i]);
2617                         cmds[i].fs_dest_path = malloc((len + 1) * sizeof(tchar));
2618                         if (!cmds[i].fs_dest_path) {
2619                                 free_extract_commands(cmds, num_cmds, dest_dir);
2620                                 return NULL;
2621                         }
2622                         tsprintf(cmds[i].fs_dest_path,
2623                                  T("%"TS""OS_PREFERRED_PATH_SEPARATOR_STRING"%"TS),
2624                                  dest_dir, tbasename(paths[i]));
2625                 }
2626         }
2627         *num_cmds_ret = num_cmds;
2628         return cmds;
2629 }
2630
2631 /* Extract files or directories from a WIM image */
2632 static int
2633 imagex_extract(int argc, tchar **argv, int cmd)
2634 {
2635         int c;
2636         int open_flags = 0;
2637         int image;
2638         WIMStruct *wim;
2639         int ret;
2640         const tchar *wimfile;
2641         const tchar *image_num_or_name;
2642         tchar *dest_dir = T(".");
2643         int extract_flags = WIMLIB_EXTRACT_FLAG_SEQUENTIAL | WIMLIB_EXTRACT_FLAG_NORPFIX;
2644
2645         STRING_SET(refglobs);
2646
2647         struct wimlib_extract_command *cmds;
2648         size_t num_cmds;
2649
2650         for_opt(c, extract_options) {
2651                 switch (c) {
2652                 case IMAGEX_CHECK_OPTION:
2653                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2654                         break;
2655                 case IMAGEX_VERBOSE_OPTION:
2656                         extract_flags |= WIMLIB_EXTRACT_FLAG_VERBOSE;
2657                         break;
2658                 case IMAGEX_REF_OPTION:
2659                         ret = string_set_append(&refglobs, optarg);
2660                         if (ret)
2661                                 goto out_free_refglobs;
2662                         break;
2663                 case IMAGEX_UNIX_DATA_OPTION:
2664                         extract_flags |= WIMLIB_EXTRACT_FLAG_UNIX_DATA;
2665                         break;
2666                 case IMAGEX_NO_ACLS_OPTION:
2667                         extract_flags |= WIMLIB_EXTRACT_FLAG_NO_ACLS;
2668                         break;
2669                 case IMAGEX_STRICT_ACLS_OPTION:
2670                         extract_flags |= WIMLIB_EXTRACT_FLAG_STRICT_ACLS;
2671                         break;
2672                 case IMAGEX_DEST_DIR_OPTION:
2673                         dest_dir = optarg;
2674                         break;
2675                 case IMAGEX_TO_STDOUT_OPTION:
2676                         extract_flags |= WIMLIB_EXTRACT_FLAG_TO_STDOUT;
2677                         imagex_info_file = stderr;
2678                         imagex_be_quiet = true;
2679                         break;
2680                 case IMAGEX_INCLUDE_INVALID_NAMES_OPTION:
2681                         extract_flags |= WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES;
2682                         extract_flags |= WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS;
2683                         break;
2684                 default:
2685                         goto out_usage;
2686                 }
2687         }
2688         argc -= optind;
2689         argv += optind;
2690
2691         if (argc < 2)
2692                 goto out_usage;
2693
2694         wimfile = argv[0];
2695         image_num_or_name = argv[1];
2696
2697         argc -= 2;
2698         argv += 2;
2699
2700         cmds = prepare_extract_commands(argv, argc, extract_flags, dest_dir,
2701                                         &num_cmds);
2702         if (!cmds)
2703                 goto out_err;
2704
2705         ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2706         if (ret)
2707                 goto out_free_cmds;
2708
2709         image = wimlib_resolve_image(wim, image_num_or_name);
2710         ret = verify_image_exists_and_is_single(image,
2711                                                 image_num_or_name,
2712                                                 wimfile);
2713         if (ret)
2714                 goto out_wimlib_free;
2715
2716         if (refglobs.num_strings) {
2717                 ret = wim_reference_globs(wim, &refglobs, open_flags);
2718                 if (ret)
2719                         goto out_wimlib_free;
2720         }
2721
2722         ret = wimlib_extract_files(wim, image, cmds, num_cmds, 0,
2723                                    imagex_progress_func);
2724         if (ret == 0) {
2725                 if (!imagex_be_quiet)
2726                         imagex_printf(T("Done extracting files.\n"));
2727         } else if (ret == WIMLIB_ERR_PATH_DOES_NOT_EXIST) {
2728                 tfprintf(stderr, T("Note: You can use `%"TS"' to see what "
2729                                    "files and directories\n"
2730                                    "      are in the WIM image.\n"),
2731                                 get_cmd_string(CMD_INFO, false));
2732         } else if (ret == WIMLIB_ERR_RESOURCE_NOT_FOUND) {
2733                 struct wimlib_wim_info info;
2734
2735                 wimlib_get_wim_info(wim, &info);
2736                 do_resource_not_found_warning(wimfile, &info, &refglobs);
2737         }
2738 out_wimlib_free:
2739         wimlib_free(wim);
2740 out_free_cmds:
2741         free_extract_commands(cmds, num_cmds, dest_dir);
2742 out_free_refglobs:
2743         string_set_destroy(&refglobs);
2744         return ret;
2745
2746 out_usage:
2747         usage(CMD_EXTRACT, stderr);
2748 out_err:
2749         ret = -1;
2750         goto out_free_refglobs;
2751 }
2752
2753 static void print_byte_field(const uint8_t field[], size_t len)
2754 {
2755         while (len--)
2756                 tprintf(T("%02hhx"), *field++);
2757 }
2758
2759 static void
2760 print_wim_information(const tchar *wimfile, const struct wimlib_wim_info *info)
2761 {
2762         tputs(T("WIM Information:"));
2763         tputs(T("----------------"));
2764         tprintf(T("Path:           %"TS"\n"), wimfile);
2765         tprintf(T("GUID:           0x"));
2766         print_byte_field(info->guid, sizeof(info->guid));
2767         tputchar(T('\n'));
2768         tprintf(T("Version:        %u\n"), info->wim_version);
2769         tprintf(T("Image Count:    %d\n"), info->image_count);
2770         tprintf(T("Compression:    %"TS"\n"),
2771                 wimlib_get_compression_type_string(info->compression_type));
2772         tprintf(T("Chunk Size:     %"PRIu32" bytes\n"),
2773                 info->chunk_size);
2774         tprintf(T("Part Number:    %d/%d\n"), info->part_number, info->total_parts);
2775         tprintf(T("Boot Index:     %d\n"), info->boot_index);
2776         tprintf(T("Size:           %"PRIu64" bytes\n"), info->total_bytes);
2777         tprintf(T("Integrity Info: %"TS"\n"),
2778                 info->has_integrity_table ? T("yes") : T("no"));
2779         tprintf(T("Relative path junction: %"TS"\n"),
2780                 info->has_rpfix ? T("yes") : T("no"));
2781         tprintf(T("Pipable:        %"TS"\n"),
2782                 info->pipable ? T("yes") : T("no"));
2783         tputchar(T('\n'));
2784 }
2785
2786 static int
2787 print_resource(const struct wimlib_resource_entry *resource,
2788                void *_ignore)
2789 {
2790         tprintf(T("Uncompressed size     = %"PRIu64" bytes\n"),
2791                 resource->uncompressed_size);
2792         if (resource->packed) {
2793                 tprintf(T("Raw compressed size   = %"PRIu64" bytes\n"),
2794                         resource->raw_resource_compressed_size);
2795
2796                 tprintf(T("Raw offset in WIM     = %"PRIu64" bytes\n"),
2797                         resource->raw_resource_offset_in_wim);
2798
2799                 tprintf(T("Offset in raw         = %"PRIu64" bytes\n"),
2800                         resource->offset);
2801         } else {
2802                 tprintf(T("Compressed size       = %"PRIu64" bytes\n"),
2803                         resource->compressed_size);
2804
2805                 tprintf(T("Offset in WIM         = %"PRIu64" bytes\n"),
2806                         resource->offset);
2807         }
2808
2809         tprintf(T("Part Number           = %u\n"), resource->part_number);
2810         tprintf(T("Reference Count       = %u\n"), resource->reference_count);
2811
2812         tprintf(T("Hash                  = 0x"));
2813         print_byte_field(resource->sha1_hash, sizeof(resource->sha1_hash));
2814         tputchar(T('\n'));
2815
2816         tprintf(T("Flags                 = "));
2817         if (resource->is_compressed)
2818                 tprintf(T("WIM_RESHDR_FLAG_COMPRESSED  "));
2819         if (resource->is_metadata)
2820                 tprintf(T("WIM_RESHDR_FLAG_METADATA  "));
2821         if (resource->is_free)
2822                 tprintf(T("WIM_RESHDR_FLAG_FREE  "));
2823         if (resource->is_spanned)
2824                 tprintf(T("WIM_RESHDR_FLAG_SPANNED  "));
2825         if (resource->packed)
2826                 tprintf(T("WIM_RESHDR_FLAG_PACKED_STREAMS  "));
2827         tputchar(T('\n'));
2828         tputchar(T('\n'));
2829         return 0;
2830 }
2831
2832 static void
2833 print_lookup_table(WIMStruct *wim)
2834 {
2835         wimlib_iterate_lookup_table(wim, 0, print_resource, NULL);
2836 }
2837
2838 /* Prints information about a WIM file; also can mark an image as bootable,
2839  * change the name of an image, or change the description of an image. */
2840 static int
2841 imagex_info(int argc, tchar **argv, int cmd)
2842 {
2843         int c;
2844         bool boot         = false;
2845         bool check        = false;
2846         bool nocheck      = false;
2847         bool header       = false;
2848         bool lookup_table = false;
2849         bool xml          = false;
2850         bool metadata     = false;
2851         bool short_header = true;
2852         const tchar *xml_out_file = NULL;
2853         const tchar *wimfile;
2854         const tchar *image_num_or_name;
2855         const tchar *new_name;
2856         const tchar *new_desc;
2857         WIMStruct *wim;
2858         int image;
2859         int ret;
2860         int open_flags = 0;
2861         struct wimlib_wim_info info;
2862
2863         for_opt(c, info_options) {
2864                 switch (c) {
2865                 case IMAGEX_BOOT_OPTION:
2866                         boot = true;
2867                         break;
2868                 case IMAGEX_CHECK_OPTION:
2869                         check = true;
2870                         break;
2871                 case IMAGEX_NOCHECK_OPTION:
2872                         nocheck = true;
2873                         break;
2874                 case IMAGEX_HEADER_OPTION:
2875                         header = true;
2876                         short_header = false;
2877                         break;
2878                 case IMAGEX_LOOKUP_TABLE_OPTION:
2879                         lookup_table = true;
2880                         short_header = false;
2881                         break;
2882                 case IMAGEX_XML_OPTION:
2883                         xml = true;
2884                         short_header = false;
2885                         break;
2886                 case IMAGEX_EXTRACT_XML_OPTION:
2887                         xml_out_file = optarg;
2888                         short_header = false;
2889                         break;
2890                 case IMAGEX_METADATA_OPTION:
2891                         metadata = true;
2892                         short_header = false;
2893                         break;
2894                 default:
2895                         goto out_usage;
2896                 }
2897         }
2898
2899         argc -= optind;
2900         argv += optind;
2901         if (argc < 1 || argc > 4)
2902                 goto out_usage;
2903
2904         wimfile           = argv[0];
2905         image_num_or_name = (argc >= 2) ? argv[1] : T("all");
2906         new_name          = (argc >= 3) ? argv[2] : NULL;
2907         new_desc          = (argc >= 4) ? argv[3] : NULL;
2908
2909         if (check && nocheck) {
2910                 imagex_error(T("Can't specify both --check and --nocheck"));
2911                 goto out_err;
2912         }
2913
2914         if (check)
2915                 open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
2916
2917         ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
2918         if (ret)
2919                 goto out;
2920
2921         wimlib_get_wim_info(wim, &info);
2922
2923         image = wimlib_resolve_image(wim, image_num_or_name);
2924         ret = WIMLIB_ERR_INVALID_IMAGE;
2925         if (image == WIMLIB_NO_IMAGE && tstrcmp(image_num_or_name, T("0"))) {
2926                 verify_image_exists(image, image_num_or_name, wimfile);
2927                 if (boot) {
2928                         imagex_error(T("If you would like to set the boot "
2929                                        "index to 0, specify image \"0\" with "
2930                                        "the --boot flag."));
2931                 }
2932                 goto out_wimlib_free;
2933         }
2934
2935         if (boot && info.image_count == 0) {
2936                 imagex_error(T("--boot is meaningless on a WIM with no images"));
2937                 goto out_wimlib_free;
2938         }
2939
2940         if (image == WIMLIB_ALL_IMAGES && info.image_count > 1) {
2941                 if (boot) {
2942                         imagex_error(T("Cannot specify the --boot flag "
2943                                        "without specifying a specific "
2944                                        "image in a multi-image WIM"));
2945                         goto out_wimlib_free;
2946                 }
2947                 if (new_name) {
2948                         imagex_error(T("Cannot specify the NEW_NAME "
2949                                        "without specifying a specific "
2950                                        "image in a multi-image WIM"));
2951                         goto out_wimlib_free;
2952                 }
2953         }
2954
2955         /* Operations that print information are separated from operations that
2956          * recreate the WIM file. */
2957         if (!new_name && !boot) {
2958
2959                 /* Read-only operations */
2960
2961                 if (image == WIMLIB_NO_IMAGE) {
2962                         imagex_error(T("\"%"TS"\" is not a valid image in \"%"TS"\""),
2963                                      image_num_or_name, wimfile);
2964                         goto out_wimlib_free;
2965                 }
2966
2967                 if (image == WIMLIB_ALL_IMAGES && short_header)
2968                         print_wim_information(wimfile, &info);
2969
2970                 if (header)
2971                         wimlib_print_header(wim);
2972
2973                 if (lookup_table) {
2974                         if (info.total_parts != 1) {
2975                                 tfprintf(stderr, T("Warning: Only showing the lookup table "
2976                                                    "for part %d of a %d-part WIM.\n"),
2977                                          info.part_number, info.total_parts);
2978                         }
2979                         print_lookup_table(wim);
2980                 }
2981
2982                 if (xml) {
2983                         ret = wimlib_extract_xml_data(wim, stdout);
2984                         if (ret)
2985                                 goto out_wimlib_free;
2986                 }
2987
2988                 if (xml_out_file) {
2989                         FILE *fp;
2990
2991                         fp = tfopen(xml_out_file, T("wb"));
2992                         if (!fp) {
2993                                 imagex_error_with_errno(T("Failed to open the "
2994                                                           "file \"%"TS"\" for "
2995                                                           "writing"),
2996                                                         xml_out_file);
2997                                 ret = -1;
2998                                 goto out_wimlib_free;
2999                         }
3000                         ret = wimlib_extract_xml_data(wim, fp);
3001                         if (fclose(fp)) {
3002                                 imagex_error(T("Failed to close the file "
3003                                                "\"%"TS"\""),
3004                                              xml_out_file);
3005                                 ret = -1;
3006                         }
3007                         if (ret)
3008                                 goto out_wimlib_free;
3009                 }
3010
3011                 if (short_header)
3012                         wimlib_print_available_images(wim, image);
3013
3014                 if (metadata) {
3015                         ret = wimlib_print_metadata(wim, image);
3016                         if (ret)
3017                                 goto out_wimlib_free;
3018                 }
3019                 ret = 0;
3020         } else {
3021
3022                 /* Modification operations */
3023
3024                 if (image == WIMLIB_ALL_IMAGES)
3025                         image = 1;
3026
3027                 if (image == WIMLIB_NO_IMAGE && new_name) {
3028                         imagex_error(T("Cannot specify new_name (\"%"TS"\") "
3029                                        "when using image 0"), new_name);
3030                         ret = -1;
3031                         goto out_wimlib_free;
3032                 }
3033
3034                 if (boot) {
3035                         if (image == info.boot_index) {
3036                                 imagex_printf(T("Image %d is already marked as "
3037                                           "bootable.\n"), image);
3038                                 boot = false;
3039                         } else {
3040                                 imagex_printf(T("Marking image %d as bootable.\n"),
3041                                         image);
3042                                 info.boot_index = image;
3043                                 ret = wimlib_set_wim_info(wim, &info,
3044                                                           WIMLIB_CHANGE_BOOT_INDEX);
3045                                 if (ret)
3046                                         goto out_wimlib_free;
3047                         }
3048                 }
3049                 if (new_name) {
3050                         if (!tstrcmp(wimlib_get_image_name(wim, image), new_name))
3051                         {
3052                                 imagex_printf(T("Image %d is already named \"%"TS"\".\n"),
3053                                         image, new_name);
3054                                 new_name = NULL;
3055                         } else {
3056                                 imagex_printf(T("Changing the name of image %d to "
3057                                           "\"%"TS"\".\n"), image, new_name);
3058                                 ret = wimlib_set_image_name(wim, image, new_name);
3059                                 if (ret)
3060                                         goto out_wimlib_free;
3061                         }
3062                 }
3063                 if (new_desc) {
3064                         const tchar *old_desc;
3065                         old_desc = wimlib_get_image_description(wim, image);
3066                         if (old_desc && !tstrcmp(old_desc, new_desc)) {
3067                                 imagex_printf(T("The description of image %d is already "
3068                                           "\"%"TS"\".\n"), image, new_desc);
3069                                 new_desc = NULL;
3070                         } else {
3071                                 imagex_printf(T("Changing the description of image %d "
3072                                           "to \"%"TS"\".\n"), image, new_desc);
3073                                 ret = wimlib_set_image_descripton(wim, image,
3074                                                                   new_desc);
3075                                 if (ret)
3076                                         goto out_wimlib_free;
3077                         }
3078                 }
3079
3080                 /* Only call wimlib_overwrite() if something actually needs to
3081                  * be changed.  */
3082                 if (boot || new_name || new_desc ||
3083                     (check && !info.has_integrity_table) ||
3084                     (nocheck && info.has_integrity_table))
3085                 {
3086                         int write_flags = 0;
3087
3088                         if (check)
3089                                 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3090                         if (nocheck)
3091                                 write_flags |= WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY;
3092                         ret = wimlib_overwrite(wim, write_flags, 1,
3093                                                imagex_progress_func);
3094                 } else {
3095                         imagex_printf(T("The file \"%"TS"\" was not modified "
3096                                         "because nothing needed to be done.\n"),
3097                                       wimfile);
3098                         ret = 0;
3099                 }
3100         }
3101 out_wimlib_free:
3102         wimlib_free(wim);
3103 out:
3104         return ret;
3105
3106 out_usage:
3107         usage(CMD_INFO, stderr);
3108 out_err:
3109         ret = -1;
3110         goto out;
3111 }
3112
3113 /* Join split WIMs into one part WIM */
3114 static int
3115 imagex_join(int argc, tchar **argv, int cmd)
3116 {
3117         int c;
3118         int swm_open_flags = 0;
3119         int wim_write_flags = 0;
3120         const tchar *output_path;
3121         int ret;
3122
3123         for_opt(c, join_options) {
3124                 switch (c) {
3125                 case IMAGEX_CHECK_OPTION:
3126                         swm_open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3127                         wim_write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
3128                         break;
3129                 default:
3130                         goto out_usage;
3131                 }
3132         }
3133         argc -= optind;
3134         argv += optind;
3135
3136         if (argc < 2) {
3137                 imagex_error(T("Must specify one or more split WIM (.swm) "
3138                                "parts to join"));
3139                 goto out_usage;
3140         }
3141         output_path = argv[0];
3142         ret = wimlib_join((const tchar * const *)++argv,
3143                           --argc,
3144                           output_path,
3145                           swm_open_flags,
3146                           wim_write_flags,
3147                           imagex_progress_func);
3148 out:
3149         return ret;
3150
3151 out_usage:
3152         usage(CMD_JOIN, stderr);
3153         ret = -1;
3154         goto out;
3155 }
3156
3157 #if WIM_MOUNTING_SUPPORTED
3158
3159 /* Mounts a WIM image.  */
3160 static int
3161 imagex_mount_rw_or_ro(int argc, tchar **argv, int cmd)
3162 {
3163         int c;
3164         int mount_flags = 0;
3165         int open_flags = 0;
3166         const tchar *staging_dir = NULL;
3167         const tchar *wimfile;
3168         const tchar *dir;
3169         WIMStruct *wim;
3170         struct wimlib_wim_info info;
3171         int image;
3172         int ret;
3173
3174         STRING_SET(refglobs);
3175
3176         if (cmd == CMD_MOUNTRW) {
3177                 mount_flags |= WIMLIB_MOUNT_FLAG_READWRITE;
3178                 open_flags |= WIMLIB_OPEN_FLAG_WRITE_ACCESS;
3179         }
3180
3181         for_opt(c, mount_options) {
3182                 switch (c) {
3183                 case IMAGEX_ALLOW_OTHER_OPTION:
3184                         mount_flags |= WIMLIB_MOUNT_FLAG_ALLOW_OTHER;
3185                         break;
3186                 case IMAGEX_CHECK_OPTION:
3187                         open_flags |= WIMLIB_OPEN_FLAG_CHECK_INTEGRITY;
3188                         break;
3189                 case IMAGEX_DEBUG_OPTION:
3190                         mount_flags |= WIMLIB_MOUNT_FLAG_DEBUG;
3191                         break;
3192                 case IMAGEX_STREAMS_INTERFACE_OPTION:
3193                         if (!tstrcasecmp(optarg, T("none")))
3194                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE;
3195                         else if (!tstrcasecmp(optarg, T("xattr")))
3196                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR;
3197                         else if (!tstrcasecmp(optarg, T("windows")))
3198                                 mount_flags |= WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS;
3199                         else {
3200                                 imagex_error(T("Unknown stream interface \"%"TS"\""),
3201                                              optarg);
3202                                 goto out_usage;
3203                         }
3204                         break;
3205                 case IMAGEX_REF_OPTION:
3206                         ret = string_set_append(&refglobs, optarg);
3207                         if (ret)
3208                                 goto out_free_refglobs;
3209                         break;
3210                 case IMAGEX_STAGING_DIR_OPTION:
3211                         staging_dir = optarg;
3212                         break;
3213                 case IMAGEX_UNIX_DATA_OPTION:
3214                         mount_flags |= WIMLIB_MOUNT_FLAG_UNIX_DATA;
3215                         break;
3216                 default:
3217                         goto out_usage;
3218                 }
3219         }
3220         argc -= optind;
3221         argv += optind;
3222         if (argc != 2 && argc != 3)
3223                 goto out_usage;
3224
3225         wimfile = argv[0];
3226
3227         ret = wimlib_open_wim(wimfile, open_flags, &wim, imagex_progress_func);
3228         if (ret)
3229                 goto out_free_refglobs;