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