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