Cleanup
[wimlib] / src / extract.c
1 /*
2  * extract.c
3  *
4  * Support for extracting WIM images, or files or directories contained in a WIM
5  * image.
6  */
7
8 /*
9  * Copyright (C) 2012, 2013 Eric Biggers
10  *
11  * This file is part of wimlib, a library for working with WIM files.
12  *
13  * wimlib is free software; you can redistribute it and/or modify it under the
14  * terms of the GNU General Public License as published by the Free
15  * Software Foundation; either version 3 of the License, or (at your option)
16  * any later version.
17  *
18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
21  * details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
25  */
26
27 /*
28  * This file provides the API functions wimlib_extract_image(),
29  * wimlib_extract_files(), and wimlib_extract_image_from_pipe().  Internally,
30  * all end up calling extract_tree() zero or more times to extract a tree of
31  * files from the currently selected WIM image to the specified target directory
32  * or NTFS volume.
33  *
34  * Although wimlib supports multiple extraction modes/backends (NTFS-3g, UNIX,
35  * Win32), this file does not itself have code to extract files or directories
36  * to any specific target; instead, it handles generic functionality and relies
37  * on lower-level callback functions declared in `struct apply_operations' to do
38  * the actual extraction.
39  */
40
41 #ifdef HAVE_CONFIG_H
42 #  include "config.h"
43 #endif
44
45 #include "wimlib/apply.h"
46 #include "wimlib/dentry.h"
47 #include "wimlib/encoding.h"
48 #include "wimlib/endianness.h"
49 #include "wimlib/error.h"
50 #include "wimlib/lookup_table.h"
51 #include "wimlib/metadata.h"
52 #include "wimlib/paths.h"
53 #include "wimlib/reparse.h"
54 #include "wimlib/resource.h"
55 #include "wimlib/security.h"
56 #ifdef __WIN32__
57 #  include "wimlib/win32.h" /* for realpath() equivalent */
58 #endif
59 #include "wimlib/xml.h"
60 #include "wimlib/wim.h"
61
62 #include <errno.h>
63 #include <fcntl.h>
64 #include <stdlib.h>
65 #include <sys/stat.h>
66 #include <unistd.h>
67
68 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
69 #define WIMLIB_EXTRACT_FLAG_FROM_PIPE   0x40000000
70 #define WIMLIB_EXTRACT_MASK_PUBLIC      0x3fffffff
71
72 /* Given a WIM dentry in the tree to be extracted, resolve all streams in the
73  * corresponding inode and set 'out_refcnt' in each to 0.  */
74 static int
75 dentry_resolve_and_zero_lte_refcnt(struct wim_dentry *dentry, void *_ctx)
76 {
77         struct apply_ctx *ctx = _ctx;
78         struct wim_inode *inode = dentry->d_inode;
79         struct wim_lookup_table_entry *lte;
80         int ret;
81         bool force = false;
82
83         if (dentry->extraction_skipped)
84                 return 0;
85
86         /* Special case:  when extracting from a pipe, the WIM lookup table is
87          * initially empty, so "resolving" an inode's streams is initially not
88          * possible.  However, we still need to keep track of which streams,
89          * identified by SHA1 message digests, need to be extracted, so we
90          * "resolve" the inode's streams anyway by allocating new entries.  */
91         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
92                 force = true;
93         ret = inode_resolve_ltes(inode, ctx->wim->lookup_table, force);
94         if (ret)
95                 return ret;
96         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
97                 lte = inode_stream_lte_resolved(inode, i);
98                 if (lte)
99                         lte->out_refcnt = 0;
100         }
101         return 0;
102 }
103
104 static inline bool
105 is_linked_extraction(const struct apply_ctx *ctx)
106 {
107         return 0 != (ctx->extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
108                                            WIMLIB_EXTRACT_FLAG_SYMLINK));
109 }
110
111 static inline bool
112 can_extract_named_data_streams(const struct apply_ctx *ctx)
113 {
114         return ctx->supported_features.named_data_streams &&
115                 !is_linked_extraction(ctx);
116 }
117
118 static int
119 ref_stream_to_extract(struct wim_lookup_table_entry *lte,
120                       struct wim_dentry *dentry, struct apply_ctx *ctx)
121 {
122         if (!lte)
123                 return 0;
124
125         /* Tally the size only for each extraction of the stream (not hard
126          * links).  */
127         if (!(dentry->d_inode->i_visited &&
128               ctx->supported_features.hard_links) &&
129             (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
130                                             lte->extracted_file == NULL)))
131         {
132                 ctx->progress.extract.total_bytes += lte->size;
133                 ctx->progress.extract.num_streams++;
134         }
135
136         /* Add stream to the extraction_list only one time, even if it's going
137          * to be extracted to multiple locations.  */
138         if (lte->out_refcnt == 0) {
139                 list_add_tail(&lte->extraction_list, &ctx->stream_list);
140                 ctx->num_streams_remaining++;
141         }
142
143         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
144                 struct wim_dentry **lte_dentries;
145
146                 /* Append dentry to this stream's array of dentries referencing
147                  * it.  Use inline array to avoid memory allocation until the
148                  * number of dentries becomes too large.  */
149                 if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
150                         lte_dentries = lte->inline_lte_dentries;
151                 } else {
152                         struct wim_dentry **prev_lte_dentries;
153                         size_t alloc_lte_dentries;
154
155                         if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
156                                 prev_lte_dentries = NULL;
157                                 alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
158                         } else {
159                                 prev_lte_dentries = lte->lte_dentries;
160                                 alloc_lte_dentries = lte->alloc_lte_dentries;
161                         }
162
163                         if (lte->out_refcnt == alloc_lte_dentries) {
164                                 alloc_lte_dentries *= 2;
165                                 lte_dentries = REALLOC(prev_lte_dentries,
166                                                        alloc_lte_dentries *
167                                                         sizeof(lte_dentries[0]));
168                                 if (lte_dentries == NULL)
169                                         return WIMLIB_ERR_NOMEM;
170                                 if (prev_lte_dentries == NULL) {
171                                         memcpy(lte_dentries,
172                                                lte->inline_lte_dentries,
173                                                sizeof(lte->inline_lte_dentries));
174                                 }
175                                 lte->lte_dentries = lte_dentries;
176                                 lte->alloc_lte_dentries = alloc_lte_dentries;
177                         }
178                         lte_dentries = lte->lte_dentries;
179                 }
180                 lte_dentries[lte->out_refcnt] = dentry;
181         }
182         lte->out_refcnt++;
183         return 0;
184 }
185
186 /* Given a WIM dentry in the tree to be extracted, iterate through streams that
187  * need to be extracted.  For each one, add it to the list of streams to be
188  * extracted (ctx->stream_list) if not already done so, and also update the
189  * progress information (ctx->progress) with the stream.  Furthermore, if doing
190  * a sequential extraction, build a mapping from each the stream to the dentries
191  * referencing it.
192  *
193  * This uses the i_visited member of the inodes (assumed to be 0 initially).  */
194 static int
195 dentry_add_streams_to_extract(struct wim_dentry *dentry, void *_ctx)
196 {
197         struct apply_ctx *ctx = _ctx;
198         struct wim_inode *inode = dentry->d_inode;
199         int ret;
200
201         /* Don't process dentries marked as skipped.  */
202         if (dentry->extraction_skipped)
203                 return 0;
204
205         /* The unnamed data stream will always be extracted, except in an
206          * unlikely case.  */
207         if (!inode_is_encrypted_directory(inode)) {
208                 ret = ref_stream_to_extract(inode_unnamed_lte_resolved(inode),
209                                             dentry, ctx);
210                 if (ret)
211                         return ret;
212         }
213
214         /* Named data streams will be extracted only if supported in the current
215          * extraction mode and volume, and to avoid complications, if not doing
216          * a linked extraction.  */
217         if (can_extract_named_data_streams(ctx)) {
218                 for (u16 i = 0; i < inode->i_num_ads; i++) {
219                         if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
220                                 continue;
221                         ret = ref_stream_to_extract(inode->i_ads_entries[i].lte,
222                                                     dentry, ctx);
223                         if (ret)
224                                 return ret;
225                 }
226         }
227         inode->i_visited = 1;
228         return 0;
229 }
230
231 /* Inform library user of progress of stream extraction following the successful
232  * extraction of a copy of the stream specified by @lte.  */
233 static void
234 update_extract_progress(struct apply_ctx *ctx,
235                         const struct wim_lookup_table_entry *lte)
236 {
237         wimlib_progress_func_t progress_func = ctx->progress_func;
238         union wimlib_progress_info *progress = &ctx->progress;
239
240         progress->extract.completed_bytes += lte->size;
241         if (progress_func &&
242             progress->extract.completed_bytes >= ctx->next_progress)
243         {
244                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, progress);
245                 if (progress->extract.completed_bytes >=
246                     progress->extract.total_bytes)
247                 {
248                         ctx->next_progress = ~0ULL;
249                 } else {
250                         ctx->next_progress += progress->extract.total_bytes / 128;
251                         if (ctx->next_progress > progress->extract.total_bytes)
252                                 ctx->next_progress = progress->extract.total_bytes;
253                 }
254         }
255 }
256
257 #ifndef __WIN32__
258 /* Extract a symbolic link (not directly as reparse data), handling fixing up
259  * the target of absolute symbolic links and updating the extract progress.
260  *
261  * @inode must specify the WIM inode for a symbolic link or junction reparse
262  * point.
263  *
264  * @lte_override overrides the resource used as the reparse data for the
265  * symbolic link.  */
266 static int
267 extract_symlink(const tchar *path, struct apply_ctx *ctx,
268                 struct wim_inode *inode,
269                 struct wim_lookup_table_entry *lte_override)
270 {
271         ssize_t bufsize = ctx->ops->path_max;
272         tchar target[bufsize];
273         tchar *buf = target;
274         tchar *fixed_target;
275         ssize_t sret;
276         int ret;
277
278         /* If absolute symbolic link fixups requested, reserve space in the link
279          * target buffer for the absolute path of the target directory.  */
280         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
281         {
282                 buf += ctx->realtarget_nchars;
283                 bufsize -= ctx->realtarget_nchars;
284         }
285
286         /* Translate the WIM inode's reparse data into the link target.  */
287         sret = wim_inode_readlink(inode, buf, bufsize - 1, lte_override);
288         if (sret < 0) {
289                 errno = -sret;
290                 return WIMLIB_ERR_READLINK;
291         }
292         buf[sret] = '\0';
293
294         if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
295             buf[0] == '/')
296         {
297                 /* Fix absolute symbolic link target to point into the
298                  * actual extraction destination.  */
299                 tmemcpy(target, ctx->realtarget, ctx->realtarget_nchars);
300                 fixed_target = target;
301         } else {
302                 /* Keep same link target.  */
303                 fixed_target = buf;
304         }
305
306         /* Call into the apply_operations to create the symbolic link.  */
307         DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
308               path, fixed_target);
309         ret = ctx->ops->create_symlink(fixed_target, path, ctx);
310         if (ret) {
311                 ERROR_WITH_ERRNO("Failed to create symlink "
312                                  "\"%"TS"\" => \"%"TS"\"", path, fixed_target);
313                 return ret;
314         }
315
316         /* Account for reparse data consumed.  */
317         update_extract_progress(ctx,
318                                 (lte_override ? lte_override :
319                                       inode_unnamed_lte_resolved(inode)));
320         return 0;
321 }
322 #endif /* !__WIN32__ */
323
324 /* Create a file, directory, or symbolic link.  */
325 static int
326 extract_inode(const tchar *path, struct apply_ctx *ctx, struct wim_inode *inode)
327 {
328         int ret;
329
330 #ifndef __WIN32__
331         if (ctx->supported_features.symlink_reparse_points &&
332             !ctx->supported_features.reparse_points &&
333             inode_is_symlink(inode))
334         {
335                 ret = extract_symlink(path, ctx, inode, NULL);
336         } else
337 #endif /* !__WIN32__ */
338         if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
339                 ret = ctx->ops->create_directory(path, ctx, &inode->extract_cookie);
340                 if (ret) {
341                         ERROR_WITH_ERRNO("Failed to create the directory "
342                                          "\"%"TS"\"", path);
343                 }
344         } else if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
345                     ctx->ops->extract_encrypted_stream_creates_file &&
346                     ctx->supported_features.encrypted_files) {
347                 ret = ctx->ops->extract_encrypted_stream(
348                                 path, inode_unnamed_lte_resolved(inode), ctx);
349                 if (ret) {
350                         ERROR_WITH_ERRNO("Failed to create and extract "
351                                          "encrypted file \"%"TS"\"", path);
352                 }
353         } else {
354                 ret = ctx->ops->create_file(path, ctx, &inode->extract_cookie);
355                 if (ret) {
356                         ERROR_WITH_ERRNO("Failed to create the file "
357                                          "\"%"TS"\"", path);
358                 }
359         }
360         return ret;
361 }
362
363 static int
364 extract_hardlink(const tchar *oldpath, const tchar *newpath,
365                  struct apply_ctx *ctx)
366 {
367         int ret;
368
369         DEBUG("Creating hardlink \"%"TS"\" => \"%"TS"\"", newpath, oldpath);
370         ret = ctx->ops->create_hardlink(oldpath, newpath, ctx);
371         if (ret) {
372                 ERROR_WITH_ERRNO("Failed to create hardlink "
373                                  "\"%"TS"\" => \"%"TS"\"",
374                                  newpath, oldpath);
375         }
376         return ret;
377 }
378
379 #ifdef __WIN32__
380 static int
381 try_extract_rpfix(u8 *rpbuf,
382                   u16 *rpbuflen_p,
383                   const wchar_t *extract_root_realpath,
384                   unsigned extract_root_realpath_nchars)
385 {
386         struct reparse_data rpdata;
387         wchar_t *target;
388         size_t target_nchars;
389         size_t stripped_nchars;
390         wchar_t *stripped_target;
391         wchar_t stripped_target_nchars;
392         int ret;
393
394         utf16lechar *new_target;
395         utf16lechar *new_print_name;
396         size_t new_target_nchars;
397         size_t new_print_name_nchars;
398         utf16lechar *p;
399
400         ret = parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata);
401         if (ret)
402                 return ret;
403
404         if (extract_root_realpath[0] == L'\0' ||
405             extract_root_realpath[1] != L':' ||
406             extract_root_realpath[2] != L'\\')
407                 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
408
409         ret = parse_substitute_name(rpdata.substitute_name,
410                                     rpdata.substitute_name_nbytes,
411                                     rpdata.rptag);
412         if (ret < 0)
413                 return 0;
414         stripped_nchars = ret;
415         target = rpdata.substitute_name;
416         target_nchars = rpdata.substitute_name_nbytes / sizeof(utf16lechar);
417         stripped_target = target + stripped_nchars;
418         stripped_target_nchars = target_nchars - stripped_nchars;
419
420         new_target = alloca((6 + extract_root_realpath_nchars +
421                              stripped_target_nchars) * sizeof(utf16lechar));
422
423         p = new_target;
424         if (stripped_nchars == 6) {
425                 /* Include \??\ prefix if it was present before */
426                 p = wmempcpy(p, L"\\??\\", 4);
427         }
428
429         /* Print name excludes the \??\ if present. */
430         new_print_name = p;
431         if (stripped_nchars != 0) {
432                 /* Get drive letter from real path to extract root, if a drive
433                  * letter was present before. */
434                 *p++ = extract_root_realpath[0];
435                 *p++ = extract_root_realpath[1];
436         }
437         /* Copy the rest of the extract root */
438         p = wmempcpy(p, extract_root_realpath + 2, extract_root_realpath_nchars - 2);
439
440         /* Append the stripped target */
441         p = wmempcpy(p, stripped_target, stripped_target_nchars);
442         new_target_nchars = p - new_target;
443         new_print_name_nchars = p - new_print_name;
444
445         if (new_target_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE ||
446             new_print_name_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE)
447                 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
448
449         rpdata.substitute_name = new_target;
450         rpdata.substitute_name_nbytes = new_target_nchars * sizeof(utf16lechar);
451         rpdata.print_name = new_print_name;
452         rpdata.print_name_nbytes = new_print_name_nchars * sizeof(utf16lechar);
453         return make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
454 }
455 #endif /* __WIN32__ */
456
457 /* Set reparse data on extracted file or directory that has
458  * FILE_ATTRIBUTE_REPARSE_POINT set.  */
459 static int
460 extract_reparse_data(const tchar *path, struct apply_ctx *ctx,
461                      struct wim_inode *inode,
462                      struct wim_lookup_table_entry *lte_override)
463 {
464         int ret;
465         u8 rpbuf[REPARSE_POINT_MAX_SIZE];
466         u16 rpbuflen;
467
468         ret = wim_inode_get_reparse_data(inode, rpbuf, &rpbuflen, lte_override);
469         if (ret)
470                 goto error;
471
472 #ifdef __WIN32__
473         /* Fix up target of absolute symbolic link or junction points so
474          * that they point into the actual extraction target.  */
475         if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
476             (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
477              inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) &&
478             !inode->i_not_rpfixed)
479         {
480                 ret = try_extract_rpfix(rpbuf, &rpbuflen, ctx->realtarget,
481                                         ctx->realtarget_nchars);
482                 if (ret && !(ctx->extract_flags &
483                              WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
484                 {
485                         WARNING("Reparse point fixup of \"%"TS"\" "
486                                 "failed", path);
487                         ret = 0;
488                 }
489                 if (ret)
490                         goto error;
491         }
492 #endif
493
494         ret = ctx->ops->set_reparse_data(path, rpbuf, rpbuflen, ctx);
495
496         /* On Windows, the SeCreateSymbolicLink privilege is required to create
497          * symbolic links.  To be more friendly towards non-Administrator users,
498          * we merely warn the user if symbolic links cannot be created due to
499          * insufficient permissions or privileges, unless
500          * WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was provided.  */
501 #ifdef __WIN32__
502         if (ret && inode_is_symlink(inode) &&
503             (errno == EACCES || errno == EPERM) &&
504             !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
505         {
506                 WARNING("Can't set reparse data on \"%"TS"\": "
507                         "Access denied!\n"
508                         "          You may be trying to "
509                         "extract a symbolic link without the\n"
510                         "          SeCreateSymbolicLink privilege, "
511                         "which by default non-Administrator\n"
512                         "          accounts do not have.",
513                         path);
514                 ret = 0;
515         }
516 #endif
517         if (ret)
518                 goto error;
519
520         /* Account for reparse data consumed.  */
521         update_extract_progress(ctx,
522                                 (lte_override ? lte_override :
523                                       inode_unnamed_lte_resolved(inode)));
524         return 0;
525
526 error:
527         ERROR_WITH_ERRNO("Failed to set reparse data on \"%"TS"\"", path);
528         return ret;
529 }
530
531 /*
532  * Extract zero or more streams to a file.
533  *
534  * This function operates slightly differently depending on whether @lte_spec is
535  * NULL or not.  When @lte_spec is NULL, the behavior is to extract the default
536  * file contents (unnamed stream), and, if named data streams are supported in
537  * the extract mode and volume, any named data streams.  When @lte_spec is NULL,
538  * the behavior is to extract only all copies of the stream @lte_spec, and in
539  * addition use @lte_spec to set the reparse data or create the symbolic link if
540  * appropriate.
541  *
542  * @path
543  *      Path to file to extract (as can be passed to apply_operations
544  *      functions).
545  * @ctx
546  *      Apply context.
547  * @dentry
548  *      WIM dentry that corresponds to the file being extracted.
549  * @lte_spec
550  *      If non-NULL, specifies the lookup table entry for a stream to extract,
551  *      and only that stream will be extracted (although there may be more than
552  *      one instance of it).
553  * @lte_override
554  *      Used only if @lte_spec != NULL; it is passed to the extraction functions
555  *      rather than @lte_spec, allowing the location of the stream to be
556  *      overridden.  (This is used when the WIM is being read from a nonseekable
557  *      file, such as a pipe, when streams need to be used more than once; each
558  *      such stream is extracted to a temporary file.)
559  */
560 static int
561 extract_streams(const tchar *path, struct apply_ctx *ctx,
562                 struct wim_dentry *dentry,
563                 struct wim_lookup_table_entry *lte_spec,
564                 struct wim_lookup_table_entry *lte_override)
565 {
566         struct wim_inode *inode = dentry->d_inode;
567         struct wim_lookup_table_entry *lte;
568         file_spec_t file_spec;
569         int ret;
570
571         if (dentry->was_hardlinked)
572                 return 0;
573
574 #ifdef ENABLE_DEBUG
575         if (lte_spec) {
576                 char sha1_str[100];
577                 char *p = sha1_str;
578                 for (unsigned i = 0; i < SHA1_HASH_SIZE; i++)
579                         p += sprintf(p, "%02x", lte_override->hash[i]);
580                 DEBUG("Extracting stream SHA1=%s to \"%"TS"\"",
581                       sha1_str, path, inode->i_ino);
582         } else {
583                 DEBUG("Extracting streams to \"%"TS"\"", path, inode->i_ino);
584         }
585 #endif
586
587         if (ctx->ops->uses_cookies)
588                 file_spec.cookie = inode->extract_cookie;
589         else
590                 file_spec.path = path;
591
592         /* Unnamed data stream.  */
593         lte = inode_unnamed_lte_resolved(inode);
594         if (lte && (!lte_spec || lte == lte_spec)) {
595                 if (lte_spec)
596                         lte = lte_override;
597                 if (!(inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
598                                              FILE_ATTRIBUTE_REPARSE_POINT)))
599                 {
600                         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED &&
601                             ctx->supported_features.encrypted_files) {
602                                 if (!ctx->ops->extract_encrypted_stream_creates_file) {
603                                         ret = ctx->ops->extract_encrypted_stream(
604                                                                 path, lte, ctx);
605                                         if (ret)
606                                                 goto error;
607                                 }
608                         } else {
609                                 ret = ctx->ops->extract_unnamed_stream(
610                                                         file_spec, lte, ctx);
611                                 if (ret)
612                                         goto error;
613                         }
614                         update_extract_progress(ctx, lte);
615                 }
616                 else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
617                 {
618                         ret = 0;
619                         if (ctx->supported_features.reparse_points)
620                                 ret = extract_reparse_data(path, ctx, inode, lte);
621                 #ifndef __WIN32__
622                         else if ((inode_is_symlink(inode) &&
623                                   ctx->supported_features.symlink_reparse_points))
624                                 ret = extract_symlink(path, ctx, inode, lte);
625                 #endif
626                         if (ret)
627                                 return ret;
628                 }
629         }
630
631         /* Named data streams.  */
632         if (can_extract_named_data_streams(ctx)) {
633                 for (u16 i = 0; i < inode->i_num_ads; i++) {
634                         struct wim_ads_entry *entry = &inode->i_ads_entries[i];
635
636                         if (!ads_entry_is_named_stream(entry))
637                                 continue;
638                         lte = entry->lte;
639                         if (!lte)
640                                 continue;
641                         if (lte_spec && lte_spec != lte)
642                                 continue;
643                         if (lte_spec)
644                                 lte = lte_override;
645                         ret = ctx->ops->extract_named_stream(file_spec, entry->stream_name,
646                                                              entry->stream_name_nbytes / 2,
647                                                              lte, ctx);
648                         if (ret)
649                                 goto error;
650                         update_extract_progress(ctx, lte);
651                 }
652         }
653         return 0;
654
655 error:
656         ERROR_WITH_ERRNO("Failed to extract data of \"%"TS"\"", path);
657         return ret;
658 }
659
660 /* Set attributes on an extracted file or directory if supported by the
661  * extraction mode.  */
662 static int
663 extract_file_attributes(const tchar *path, struct apply_ctx *ctx,
664                         struct wim_dentry *dentry, unsigned pass)
665 {
666         int ret;
667
668         if (ctx->ops->set_file_attributes &&
669             !(dentry == ctx->extract_root && ctx->root_dentry_is_special)) {
670                 u32 attributes = dentry->d_inode->i_attributes;
671
672                 /* Clear unsupported attributes.  */
673                 attributes &= ctx->supported_attributes_mask;
674
675                 if ((attributes & FILE_ATTRIBUTE_DIRECTORY &&
676                      !ctx->supported_features.encrypted_directories) ||
677                     (!(attributes & FILE_ATTRIBUTE_DIRECTORY) &&
678                      !ctx->supported_features.encrypted_files))
679                 {
680                         attributes &= ~FILE_ATTRIBUTE_ENCRYPTED;
681                 }
682
683                 if (attributes == 0)
684                         attributes = FILE_ATTRIBUTE_NORMAL;
685
686                 ret = ctx->ops->set_file_attributes(path, attributes, ctx, pass);
687                 if (ret) {
688                         ERROR_WITH_ERRNO("Failed to set attributes on "
689                                          "\"%"TS"\"", path);
690                         return ret;
691                 }
692         }
693         return 0;
694 }
695
696
697 /* Set or remove the short (DOS) name on an extracted file or directory if
698  * supported by the extraction mode.  Since DOS names are unimportant and it's
699  * easy to run into problems setting them on Windows (SetFileShortName()
700  * requires SE_RESTORE privilege, which only the Administrator can request, and
701  * also requires DELETE access to the file), failure is ignored unless
702  * WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is set.  */
703 static int
704 extract_short_name(const tchar *path, struct apply_ctx *ctx,
705                    struct wim_dentry *dentry)
706 {
707         int ret;
708
709         /* The root of the dentry tree being extracted may not be extracted to
710          * its original name, so its short name should be ignored.  */
711         if (dentry == ctx->extract_root)
712                 return 0;
713
714         if (ctx->supported_features.short_names) {
715                 ret = ctx->ops->set_short_name(path,
716                                                dentry->short_name,
717                                                dentry->short_name_nbytes / 2,
718                                                ctx);
719                 if (ret && (ctx->extract_flags &
720                             WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES))
721                 {
722                         ERROR_WITH_ERRNO("Failed to set short name of "
723                                          "\"%"TS"\"", path);
724                         return ret;
725                 }
726         }
727         return 0;
728 }
729
730 /* Set security descriptor, UNIX data, or neither on an extracted file, taking
731  * into account the current extraction mode and flags.  */
732 static int
733 extract_security(const tchar *path, struct apply_ctx *ctx,
734                  struct wim_dentry *dentry)
735 {
736         int ret;
737         struct wim_inode *inode = dentry->d_inode;
738
739         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
740                 return 0;
741
742         if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
743                 return 0;
744
745 #ifndef __WIN32__
746         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) {
747                 struct wimlib_unix_data data;
748
749                 ret = inode_get_unix_data(inode, &data, NULL);
750                 if (ret < 0)
751                         ret = 0;
752                 else if (ret == 0)
753                         ret = ctx->ops->set_unix_data(path, &data, ctx);
754                 if (ret) {
755                         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
756                                 ERROR_WITH_ERRNO("Failed to set UNIX owner, "
757                                                  "group, and/or mode on "
758                                                  "\"%"TS"\"", path);
759                                 return ret;
760                         } else {
761                                 WARNING_WITH_ERRNO("Failed to set UNIX owner, "
762                                                    "group, and/or/mode on "
763                                                    "\"%"TS"\"", path);
764                         }
765                 }
766         }
767         else
768 #endif /* __WIN32__ */
769         if (ctx->supported_features.security_descriptors &&
770             inode->i_security_id != -1)
771         {
772                 const struct wim_security_data *sd;
773                 const u8 *desc;
774                 size_t desc_size;
775
776                 sd = wim_const_security_data(ctx->wim);
777                 desc = sd->descriptors[inode->i_security_id];
778                 desc_size = sd->sizes[inode->i_security_id];
779
780                 ret = ctx->ops->set_security_descriptor(path, desc,
781                                                         desc_size, ctx);
782                 if (ret) {
783                         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
784                                 ERROR_WITH_ERRNO("Failed to set security "
785                                                  "descriptor on \"%"TS"\"", path);
786                                 return ret;
787                         } else {
788                         #if 0
789                                 if (errno != EACCES) {
790                                         WARNING_WITH_ERRNO("Failed to set "
791                                                            "security descriptor "
792                                                            "on \"%"TS"\"", path);
793                                 }
794                         #endif
795                                 ctx->no_security_descriptors++;
796                         }
797                 }
798         }
799         return 0;
800 }
801
802 /* Set timestamps on an extracted file.  Failure is warning-only unless
803  * WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS is set.  */
804 static int
805 extract_timestamps(const tchar *path, struct apply_ctx *ctx,
806                    struct wim_dentry *dentry)
807 {
808         struct wim_inode *inode = dentry->d_inode;
809         int ret;
810
811         if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
812                 return 0;
813
814         if (ctx->ops->set_timestamps) {
815                 ret = ctx->ops->set_timestamps(path,
816                                                inode->i_creation_time,
817                                                inode->i_last_write_time,
818                                                inode->i_last_access_time,
819                                                ctx);
820                 if (ret) {
821                         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) {
822                                 ERROR_WITH_ERRNO("Failed to set timestamps "
823                                                  "on \"%"TS"\"", path);
824                                 return ret;
825                         } else {
826                                 WARNING_WITH_ERRNO("Failed to set timestamps "
827                                                    "on \"%"TS"\"", path);
828                         }
829                 }
830         }
831         return 0;
832 }
833
834 /* Check whether the extraction of a dentry should be skipped completely.  */
835 static bool
836 dentry_is_supported(struct wim_dentry *dentry,
837                     const struct wim_features *supported_features)
838 {
839         struct wim_inode *inode = dentry->d_inode;
840
841         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
842                 return supported_features->reparse_points ||
843                         (inode_is_symlink(inode) &&
844                          supported_features->symlink_reparse_points);
845         }
846         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
847                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
848                         return supported_features->encrypted_directories != 0;
849                 else
850                         return supported_features->encrypted_files != 0;
851         }
852         return true;
853 }
854
855 /* Given a WIM dentry to extract, build the path to which to extract it, in the
856  * format understood by the callbacks in the apply_operations being used.
857  *
858  * Write the resulting path into @path, which must have room for at least
859  * ctx->ops->max_path characters including the null-terminator.
860  *
861  * Return %true if successful; %false if this WIM dentry doesn't actually need
862  * to be extracted or if the calculated path exceeds ctx->ops->max_path
863  * characters.
864  *
865  * This function clobbers the tmp_list member of @dentry and its ancestors up
866  * until the extraction root.  */
867 static bool
868 build_extraction_path(tchar path[], struct wim_dentry *dentry,
869                       struct apply_ctx *ctx)
870 {
871         size_t path_nchars;
872         LIST_HEAD(ancestor_list);
873         tchar *p = path;
874         const tchar *target_prefix;
875         size_t target_prefix_nchars;
876         struct wim_dentry *d;
877
878         if (dentry->extraction_skipped)
879                 return false;
880
881         path_nchars = ctx->ops->path_prefix_nchars;
882
883         if (ctx->ops->requires_realtarget_in_paths) {
884                 target_prefix        = ctx->realtarget;
885                 target_prefix_nchars = ctx->realtarget_nchars;
886         } else if (ctx->ops->requires_target_in_paths) {
887                 target_prefix        = ctx->target;
888                 target_prefix_nchars = ctx->target_nchars;
889         } else {
890                 target_prefix        = NULL;
891                 target_prefix_nchars = 0;
892         }
893         path_nchars += target_prefix_nchars;
894
895         for (d = dentry; d != ctx->extract_root; d = d->parent) {
896                 path_nchars += d->extraction_name_nchars + 1;
897                 list_add(&d->tmp_list, &ancestor_list);
898         }
899
900         path_nchars++; /* null terminator */
901
902         if (path_nchars > ctx->ops->path_max) {
903                 WARNING("\"%"TS"\": Path too long to extract",
904                         dentry_full_path(dentry));
905                 return false;
906         }
907
908         p = tmempcpy(p, ctx->ops->path_prefix, ctx->ops->path_prefix_nchars);
909         p = tmempcpy(p, target_prefix, target_prefix_nchars);
910         list_for_each_entry(d, &ancestor_list, tmp_list) {
911                 *p++ = ctx->ops->path_separator;
912                 p = tmempcpy(p, d->extraction_name, d->extraction_name_nchars);
913         }
914         *p++ = T('\0');
915         wimlib_assert(p - path == path_nchars);
916         return true;
917 }
918
919 static unsigned
920 get_num_path_components(const tchar *path, tchar path_separator)
921 {
922         unsigned num_components = 0;
923 #ifdef __WIN32__
924         /* Ignore drive letter.  */
925         if (path[0] != L'\0' && path[1] == L':')
926                 path += 2;
927 #endif
928
929         while (*path) {
930                 while (*path == path_separator)
931                         path++;
932                 if (*path)
933                         num_components++;
934                 while (*path && *path != path_separator)
935                         path++;
936         }
937         return num_components;
938 }
939
940 static int
941 extract_multiimage_symlink(const tchar *oldpath, const tchar *newpath,
942                            struct apply_ctx *ctx, struct wim_dentry *dentry)
943 {
944         size_t num_raw_path_components;
945         const struct wim_dentry *d;
946         size_t num_target_path_components;
947         tchar *p;
948         const tchar *p_old;
949         int ret;
950
951         num_raw_path_components = 0;
952         for (d = dentry; d != ctx->extract_root; d = d->parent)
953                 num_raw_path_components++;
954
955         if (ctx->ops->requires_realtarget_in_paths)
956                 num_target_path_components = get_num_path_components(ctx->realtarget,
957                                                                      ctx->ops->path_separator);
958         else if (ctx->ops->requires_target_in_paths)
959                 num_target_path_components = get_num_path_components(ctx->target,
960                                                                      ctx->ops->path_separator);
961         else
962                 num_target_path_components = 0;
963
964         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) {
965                 wimlib_assert(num_target_path_components > 0);
966                 num_raw_path_components++;
967                 num_target_path_components--;
968         }
969
970         p_old = oldpath + ctx->ops->path_prefix_nchars;
971 #ifdef __WIN32__
972         if (p_old[0] != L'\0' && p_old[1] == ':')
973                 p_old += 2;
974 #endif
975         while (*p_old == ctx->ops->path_separator)
976                 p_old++;
977         while (--num_target_path_components) {
978                 while (*p_old != ctx->ops->path_separator)
979                         p_old++;
980                 while (*p_old == ctx->ops->path_separator)
981                         p_old++;
982         }
983
984         tchar symlink_target[tstrlen(p_old) + 3 * num_raw_path_components + 1];
985
986         p = &symlink_target[0];
987         while (num_raw_path_components--) {
988                 *p++ = '.';
989                 *p++ = '.';
990                 *p++ = ctx->ops->path_separator;
991         }
992         tstrcpy(p, p_old);
993         DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
994               newpath, symlink_target);
995         ret = ctx->ops->create_symlink(symlink_target, newpath, ctx);
996         if (ret) {
997                 ERROR_WITH_ERRNO("Failed to create symlink "
998                                  "\"%"TS"\" => \"%"TS"\"",
999                                  newpath, symlink_target);
1000         }
1001         return ret;
1002 }
1003
1004 /* Create the "skeleton" of an extracted file or directory.  Don't yet extract
1005  * data streams, reparse data (including symbolic links), timestamps, and
1006  * security descriptors.  Basically, everything that doesn't require reading
1007  * non-metadata resources from the WIM file and isn't delayed until the final
1008  * pass.  */
1009 static int
1010 do_dentry_extract_skeleton(tchar path[], struct wim_dentry *dentry,
1011                            struct apply_ctx *ctx)
1012 {
1013         struct wim_inode *inode = dentry->d_inode;
1014         int ret;
1015         const tchar *oldpath;
1016
1017         if (unlikely(is_linked_extraction(ctx))) {
1018                 struct wim_lookup_table_entry *unnamed_lte;
1019
1020                 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
1021                 if (unnamed_lte && unnamed_lte->extracted_file) {
1022                         oldpath = unnamed_lte->extracted_file;
1023                         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK)
1024                                 goto hardlink;
1025                         else
1026                                 goto symlink;
1027                 }
1028         }
1029
1030         /* Create hard link if this dentry corresponds to an already-extracted
1031          * inode.  */
1032         if (inode->i_extracted_file) {
1033                 oldpath = inode->i_extracted_file;
1034                 goto hardlink;
1035         }
1036
1037         /* Skip symlinks unless they can be extracted as reparse points rather
1038          * than created directly.  */
1039         if (inode_is_symlink(inode) && !ctx->supported_features.reparse_points)
1040                 return 0;
1041
1042         /* Create this file or directory unless it's the extraction root, which
1043          * was already created if necessary.  */
1044         if (dentry != ctx->extract_root) {
1045                 ret = extract_inode(path, ctx, inode);
1046                 if (ret)
1047                         return ret;
1048         }
1049
1050         /* Create empty named data streams.  */
1051         if (can_extract_named_data_streams(ctx)) {
1052                 for (u16 i = 0; i < inode->i_num_ads; i++) {
1053                         file_spec_t file_spec;
1054                         struct wim_ads_entry *entry = &inode->i_ads_entries[i];
1055
1056                         if (!ads_entry_is_named_stream(entry))
1057                                 continue;
1058                         if (entry->lte)
1059                                 continue;
1060                         if (ctx->ops->uses_cookies)
1061                                 file_spec.cookie = inode->extract_cookie;
1062                         else
1063                                 file_spec.path = path;
1064                         ret = ctx->ops->extract_named_stream(file_spec,
1065                                                              entry->stream_name,
1066                                                              entry->stream_name_nbytes / 2,
1067                                                              entry->lte, ctx);
1068                         if (ret) {
1069                                 ERROR_WITH_ERRNO("\"%"TS"\": failed to create "
1070                                                  "empty named data stream",
1071                                                  path);
1072                                 return ret;
1073                         }
1074                 }
1075         }
1076
1077         /* Set file attributes (if supported).  */
1078         ret = extract_file_attributes(path, ctx, dentry, 0);
1079         if (ret)
1080                 return ret;
1081
1082         /* Set or remove file short name (if supported).  */
1083         ret = extract_short_name(path, ctx, dentry);
1084         if (ret)
1085                 return ret;
1086
1087         /* If inode has multiple links and hard links are supported in this
1088          * extraction mode and volume, save the path to the extracted file in
1089          * case it's needed to create a hard link.  */
1090         if (unlikely(is_linked_extraction(ctx))) {
1091                 struct wim_lookup_table_entry *unnamed_lte;
1092
1093                 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
1094                 if (unnamed_lte) {
1095                         unnamed_lte->extracted_file = TSTRDUP(path);
1096                         if (!unnamed_lte->extracted_file)
1097                                 return WIMLIB_ERR_NOMEM;
1098                 }
1099         } else if (inode->i_nlink > 1 && ctx->supported_features.hard_links) {
1100                 inode->i_extracted_file = TSTRDUP(path);
1101                 if (!inode->i_extracted_file)
1102                         return WIMLIB_ERR_NOMEM;
1103         }
1104         return 0;
1105
1106 symlink:
1107         ret = extract_multiimage_symlink(oldpath, path, ctx, dentry);
1108         if (ret)
1109                 return ret;
1110         dentry->was_hardlinked = 1;
1111         return 0;
1112
1113 hardlink:
1114         ret = extract_hardlink(oldpath, path, ctx);
1115         if (ret)
1116                 return ret;
1117         dentry->was_hardlinked = 1;
1118         return 0;
1119 }
1120
1121 /* This is a wrapper around do_dentry_extract_skeleton() that handles building
1122  * the path, doing short name reordering.  This is also idempotent; dentries
1123  * already processed have skeleton_extracted set and no action is taken.  See
1124  * apply_operations.requires_short_name_reordering for more details about short
1125  * name reordering.  */
1126 static int
1127 dentry_extract_skeleton(struct wim_dentry *dentry, void *_ctx)
1128 {
1129         struct apply_ctx *ctx = _ctx;
1130         tchar path[ctx->ops->path_max];
1131         struct wim_dentry *orig_dentry;
1132         struct wim_dentry *other_dentry;
1133         int ret;
1134
1135         if (dentry->skeleton_extracted)
1136                 return 0;
1137
1138         orig_dentry = NULL;
1139         if (ctx->supported_features.short_names
1140             && ctx->ops->requires_short_name_reordering
1141             && !dentry_has_short_name(dentry)
1142             && !dentry->d_inode->i_dos_name_extracted)
1143         {
1144                 inode_for_each_dentry(other_dentry, dentry->d_inode) {
1145                         if (dentry_has_short_name(other_dentry)
1146                             && !other_dentry->skeleton_extracted
1147                             && other_dentry->in_extraction_tree)
1148                         {
1149                                 DEBUG("Creating %"TS" before %"TS" "
1150                                       "to guarantee correct DOS name extraction",
1151                                       dentry_full_path(other_dentry),
1152                                       dentry_full_path(dentry));
1153                                 orig_dentry = dentry;
1154                                 dentry = other_dentry;
1155                                 break;
1156                         }
1157                 }
1158         }
1159 again:
1160         if (!build_extraction_path(path, dentry, ctx))
1161                 return 0;
1162         ret = do_dentry_extract_skeleton(path, dentry, ctx);
1163         if (ret)
1164                 return ret;
1165
1166         dentry->skeleton_extracted = 1;
1167
1168         if (orig_dentry) {
1169                 dentry = orig_dentry;
1170                 orig_dentry = NULL;
1171                 goto again;
1172         }
1173         dentry->d_inode->i_dos_name_extracted = 1;
1174         return 0;
1175 }
1176
1177 static int
1178 dentry_extract_dir_skeleton(struct wim_dentry *dentry, void *_ctx)
1179 {
1180         if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1181                 return dentry_extract_skeleton(dentry, _ctx);
1182         return 0;
1183 }
1184
1185 /* Create a file or directory, then immediately extract all streams.  This
1186  * assumes that WIMLIB_EXTRACT_FLAG_SEQUENTIAL is not specified, since the WIM
1187  * may not be read sequentially by this function.  */
1188 static int
1189 dentry_extract(struct wim_dentry *dentry, void *_ctx)
1190 {
1191         struct apply_ctx *ctx = _ctx;
1192         tchar path[ctx->ops->path_max];
1193         int ret;
1194
1195         ret = dentry_extract_skeleton(dentry, ctx);
1196         if (ret)
1197                 return ret;
1198
1199         if (!build_extraction_path(path, dentry, ctx))
1200                 return 0;
1201
1202         return extract_streams(path, ctx, dentry, NULL, NULL);
1203 }
1204
1205 /* Creates a temporary file opened for writing.  The open file descriptor is
1206  * returned in @fd_ret and its name is returned in @name_ret (dynamically
1207  * allocated).  */
1208 static int
1209 create_temporary_file(struct filedes *fd_ret, tchar **name_ret)
1210 {
1211         tchar *name;
1212         int raw_fd;
1213
1214 retry:
1215         name = ttempnam(NULL, T("wimlib"));
1216         if (name == NULL) {
1217                 ERROR_WITH_ERRNO("Failed to create temporary filename");
1218                 return WIMLIB_ERR_NOMEM;
1219         }
1220
1221         raw_fd = topen(name, O_WRONLY | O_CREAT | O_EXCL | O_BINARY, 0600);
1222
1223         if (raw_fd < 0) {
1224                 if (errno == EEXIST) {
1225                         FREE(name);
1226                         goto retry;
1227                 }
1228                 ERROR_WITH_ERRNO("Failed to open temporary file \"%"TS"\"", name);
1229                 FREE(name);
1230                 return WIMLIB_ERR_OPEN;
1231         }
1232
1233         filedes_init(fd_ret, raw_fd);
1234         *name_ret = name;
1235         return 0;
1236 }
1237
1238 /* Extract all instances of the stream @lte that are being extracted in this
1239  * call of extract_tree(), but actually read the stream data from @lte_override.
1240  */
1241 static int
1242 extract_stream_instances(struct wim_lookup_table_entry *lte,
1243                          struct wim_lookup_table_entry *lte_override,
1244                          struct apply_ctx *ctx)
1245 {
1246         struct wim_dentry **lte_dentries;
1247         tchar path[ctx->ops->path_max];
1248         size_t i;
1249         int ret;
1250
1251         if (lte->out_refcnt <= ARRAY_LEN(lte->inline_lte_dentries))
1252                 lte_dentries = lte->inline_lte_dentries;
1253         else
1254                 lte_dentries = lte->lte_dentries;
1255
1256         for (i = 0; i < lte->out_refcnt; i++) {
1257                 struct wim_dentry *dentry = lte_dentries[i];
1258
1259                 if (dentry->tmp_flag)
1260                         continue;
1261                 if (!build_extraction_path(path, dentry, ctx))
1262                         continue;
1263                 ret = extract_streams(path, ctx, dentry, lte, lte_override);
1264                 if (ret)
1265                         goto out_clear_tmp_flags;
1266                 dentry->tmp_flag = 1;
1267         }
1268         ret = 0;
1269 out_clear_tmp_flags:
1270         for (i = 0; i < lte->out_refcnt; i++)
1271                 lte_dentries[i]->tmp_flag = 0;
1272         return ret;
1273 }
1274
1275 /* Determine whether the specified stream needs to be extracted to a temporary
1276  * file or not.
1277  *
1278  * @lte->out_refcnt specifies the number of instances of this stream that must
1279  * be extracted.
1280  *
1281  * @is_partial_res is %true if this stream is just one of multiple in a single
1282  * WIM resource being extracted.  */
1283 static bool
1284 need_tmpfile_to_extract(struct wim_lookup_table_entry *lte,
1285                         bool is_partial_res)
1286 {
1287         /* Temporary file is always required when reading a partial resource,
1288          * since in that case we retrieve all the contained streams in one pass.
1289          * */
1290         if (is_partial_res)
1291                 return true;
1292
1293         /* Otherwise we don't need a temporary file if only a single instance of
1294          * the stream is needed.  */
1295         if (lte->out_refcnt == 1)
1296                 return false;
1297
1298         wimlib_assert(lte->out_refcnt >= 2);
1299
1300         /* We also don't need a temporary file if random access to the stream is
1301          * allowed.  */
1302         if (lte->resource_location != RESOURCE_IN_WIM ||
1303             filedes_is_seekable(&lte->rspec->wim->in_fd))
1304                 return false;
1305
1306         return true;
1307 }
1308
1309 static int
1310 begin_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
1311                                 bool is_partial_res,
1312                                 void *_ctx)
1313 {
1314         struct apply_ctx *ctx = _ctx;
1315         int ret;
1316
1317         if (!need_tmpfile_to_extract(lte, is_partial_res)) {
1318                 DEBUG("Temporary file not needed "
1319                       "for stream (size=%"PRIu64")", lte->size);
1320                 ret = extract_stream_instances(lte, lte, ctx);
1321                 if (ret)
1322                         return ret;
1323
1324                 return BEGIN_STREAM_STATUS_SKIP_STREAM;
1325         }
1326
1327         DEBUG("Temporary file needed for stream (size=%"PRIu64")", lte->size);
1328         return create_temporary_file(&ctx->tmpfile_fd, &ctx->tmpfile_name);
1329 }
1330
1331 static int
1332 end_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
1333                               int status, void *_ctx)
1334 {
1335         struct apply_ctx *ctx = _ctx;
1336         struct wim_lookup_table_entry lte_override;
1337         int ret;
1338         int errno_save = errno;
1339
1340         ret = filedes_close(&ctx->tmpfile_fd);
1341
1342         if (status) {
1343                 ret = status;
1344                 errno = errno_save;
1345                 goto out_delete_tmpfile;
1346         }
1347
1348         if (ret) {
1349                 ERROR_WITH_ERRNO("Error writing temporary file %"TS, ctx->tmpfile_name);
1350                 ret = WIMLIB_ERR_WRITE;
1351                 goto out_delete_tmpfile;
1352         }
1353
1354         /* Now that a full stream has been extracted to a temporary file,
1355          * extract all instances of it to the actual target.  */
1356
1357         memcpy(&lte_override, lte, sizeof(struct wim_lookup_table_entry));
1358         lte_override.resource_location = RESOURCE_IN_FILE_ON_DISK;
1359         lte_override.file_on_disk = ctx->tmpfile_name;
1360
1361         ret = extract_stream_instances(lte, &lte_override, ctx);
1362
1363 out_delete_tmpfile:
1364         errno_save = errno;
1365         tunlink(ctx->tmpfile_name);
1366         FREE(ctx->tmpfile_name);
1367         errno = errno_save;
1368         return ret;
1369 }
1370
1371 /* Extracts a list of streams (ctx.stream_list), assuming that the directory
1372  * structure and empty files were already created.  This relies on the
1373  * per-`struct wim_lookup_table_entry' list of dentries that reference each
1374  * stream that was constructed earlier.  */
1375 static int
1376 extract_stream_list(struct apply_ctx *ctx)
1377 {
1378         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
1379                 /* Sequential extraction: read the streams in the order in which
1380                  * they appear in the WIM file.  */
1381                 struct read_stream_list_callbacks cbs = {
1382                         .begin_stream           = begin_extract_stream_to_tmpfile,
1383                         .begin_stream_ctx       = ctx,
1384                         .consume_chunk          = extract_chunk_to_fd,
1385                         .consume_chunk_ctx      = &ctx->tmpfile_fd,
1386                         .end_stream             = end_extract_stream_to_tmpfile,
1387                         .end_stream_ctx         = ctx,
1388                 };
1389                 return read_stream_list(&ctx->stream_list,
1390                                         offsetof(struct wim_lookup_table_entry, extraction_list),
1391                                         &cbs, VERIFY_STREAM_HASHES);
1392         } else {
1393                 /* Extract the streams in unsorted order.  */
1394                 struct wim_lookup_table_entry *lte;
1395                 int ret;
1396
1397                 list_for_each_entry(lte, &ctx->stream_list, extraction_list) {
1398                         ret = extract_stream_instances(lte, lte, ctx);
1399                         if (ret)
1400                                 return ret;
1401                 }
1402                 return 0;
1403         }
1404 }
1405
1406 #define PWM_ALLOW_WIM_HDR 0x00001
1407 #define PWM_SILENT_EOF    0x00002
1408
1409 /* Read the header from a stream in a pipable WIM.  */
1410 static int
1411 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
1412                        struct wim_resource_spec *rspec,
1413                        int flags, struct wim_header_disk *hdr_ret)
1414 {
1415         union {
1416                 struct pwm_stream_hdr stream_hdr;
1417                 struct wim_header_disk pwm_hdr;
1418         } buf;
1419         struct wim_reshdr reshdr;
1420         int ret;
1421
1422         ret = full_read(&pwm->in_fd, &buf.stream_hdr, sizeof(buf.stream_hdr));
1423         if (ret)
1424                 goto read_error;
1425
1426         if ((flags & PWM_ALLOW_WIM_HDR) && buf.stream_hdr.magic == PWM_MAGIC) {
1427                 BUILD_BUG_ON(sizeof(buf.pwm_hdr) < sizeof(buf.stream_hdr));
1428                 ret = full_read(&pwm->in_fd, &buf.stream_hdr + 1,
1429                                 sizeof(buf.pwm_hdr) - sizeof(buf.stream_hdr));
1430
1431                 if (ret)
1432                         goto read_error;
1433                 lte->resource_location = RESOURCE_NONEXISTENT;
1434                 memcpy(hdr_ret, &buf.pwm_hdr, sizeof(buf.pwm_hdr));
1435                 return 0;
1436         }
1437
1438         if (le64_to_cpu(buf.stream_hdr.magic) != PWM_STREAM_MAGIC) {
1439                 ERROR("Data read on pipe is invalid (expected stream header).");
1440                 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1441         }
1442
1443         copy_hash(lte->hash, buf.stream_hdr.hash);
1444
1445         reshdr.size_in_wim = 0;
1446         reshdr.flags = le32_to_cpu(buf.stream_hdr.flags);
1447         reshdr.offset_in_wim = pwm->in_fd.offset;
1448         reshdr.uncompressed_size = le64_to_cpu(buf.stream_hdr.uncompressed_size);
1449         wim_res_hdr_to_spec(&reshdr, pwm, rspec);
1450         lte_bind_wim_resource_spec(lte, rspec);
1451         lte->flags = rspec->flags;
1452         lte->size = rspec->uncompressed_size;
1453         lte->offset_in_res = 0;
1454         return 0;
1455
1456 read_error:
1457         if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
1458                 ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
1459         return ret;
1460 }
1461
1462 static int
1463 extract_streams_from_pipe(struct apply_ctx *ctx)
1464 {
1465         struct wim_lookup_table_entry *found_lte;
1466         struct wim_resource_spec *rspec;
1467         struct wim_lookup_table_entry *needed_lte;
1468         struct wim_lookup_table *lookup_table;
1469         struct wim_header_disk pwm_hdr;
1470         int ret;
1471         int pwm_flags;
1472
1473         ret = WIMLIB_ERR_NOMEM;
1474         found_lte = new_lookup_table_entry();
1475         if (found_lte == NULL)
1476                 goto out;
1477
1478         rspec = MALLOC(sizeof(struct wim_resource_spec));
1479         if (rspec == NULL)
1480                 goto out_free_found_lte;
1481
1482         lookup_table = ctx->wim->lookup_table;
1483         pwm_flags = PWM_ALLOW_WIM_HDR;
1484         if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1485                 pwm_flags |= PWM_SILENT_EOF;
1486         memcpy(ctx->progress.extract.guid, ctx->wim->hdr.guid, WIM_GID_LEN);
1487         ctx->progress.extract.part_number = ctx->wim->hdr.part_number;
1488         ctx->progress.extract.total_parts = ctx->wim->hdr.total_parts;
1489         if (ctx->progress_func)
1490                 ctx->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1491                                    &ctx->progress);
1492         while (ctx->num_streams_remaining) {
1493                 if (found_lte->resource_location != RESOURCE_NONEXISTENT)
1494                         lte_unbind_wim_resource_spec(found_lte);
1495                 ret = read_pwm_stream_header(ctx->wim, found_lte, rspec,
1496                                              pwm_flags, &pwm_hdr);
1497                 if (ret) {
1498                         if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
1499                             (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1500                         {
1501                                 goto resume_done;
1502                         }
1503                         goto out_free_found_lte;
1504                 }
1505
1506                 if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
1507                     && !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
1508                     && (needed_lte = lookup_resource(lookup_table, found_lte->hash))
1509                     && (needed_lte->out_refcnt))
1510                 {
1511                         tchar *tmpfile_name = NULL;
1512                         struct wim_lookup_table_entry *lte_override;
1513                         struct wim_lookup_table_entry tmpfile_lte;
1514
1515                         needed_lte->offset_in_res = found_lte->offset_in_res;
1516                         needed_lte->flags = found_lte->flags;
1517                         needed_lte->size = found_lte->size;
1518
1519                         lte_unbind_wim_resource_spec(found_lte);
1520                         lte_bind_wim_resource_spec(needed_lte, rspec);
1521
1522                         if (needed_lte->out_refcnt > 1) {
1523
1524                                 struct filedes tmpfile_fd;
1525
1526                                 /* Extract stream to temporary file.  */
1527                                 ret = create_temporary_file(&tmpfile_fd, &tmpfile_name);
1528                                 if (ret)
1529                                         goto out_free_found_lte;
1530
1531                                 ret = extract_stream_to_fd(needed_lte, &tmpfile_fd,
1532                                                            needed_lte->size);
1533                                 if (ret) {
1534                                         filedes_close(&tmpfile_fd);
1535                                         goto delete_tmpfile;
1536                                 }
1537
1538                                 if (filedes_close(&tmpfile_fd)) {
1539                                         ERROR_WITH_ERRNO("Error writing to temporary "
1540                                                          "file \"%"TS"\"", tmpfile_name);
1541                                         ret = WIMLIB_ERR_WRITE;
1542                                         goto delete_tmpfile;
1543                                 }
1544                                 memcpy(&tmpfile_lte, needed_lte,
1545                                        sizeof(struct wim_lookup_table_entry));
1546                                 tmpfile_lte.resource_location = RESOURCE_IN_FILE_ON_DISK;
1547                                 tmpfile_lte.file_on_disk = tmpfile_name;
1548                                 lte_override = &tmpfile_lte;
1549                         } else {
1550                                 lte_override = needed_lte;
1551                         }
1552
1553                         ret = extract_stream_instances(needed_lte, lte_override, ctx);
1554                 delete_tmpfile:
1555                         lte_unbind_wim_resource_spec(needed_lte);
1556                         if (tmpfile_name) {
1557                                 tunlink(tmpfile_name);
1558                                 FREE(tmpfile_name);
1559                         }
1560                         if (ret)
1561                                 goto out_free_found_lte;
1562                         ctx->num_streams_remaining--;
1563                 } else if (found_lte->resource_location != RESOURCE_NONEXISTENT) {
1564                         ret = skip_wim_stream(found_lte);
1565                         if (ret)
1566                                 goto out_free_found_lte;
1567                 } else {
1568                         u16 part_number = le16_to_cpu(pwm_hdr.part_number);
1569                         u16 total_parts = le16_to_cpu(pwm_hdr.total_parts);
1570
1571                         if (part_number != ctx->progress.extract.part_number ||
1572                             total_parts != ctx->progress.extract.total_parts ||
1573                             memcmp(pwm_hdr.guid, ctx->progress.extract.guid,
1574                                    WIM_GID_LEN))
1575                         {
1576                                 ctx->progress.extract.part_number = part_number;
1577                                 ctx->progress.extract.total_parts = total_parts;
1578                                 memcpy(ctx->progress.extract.guid,
1579                                        pwm_hdr.guid, WIM_GID_LEN);
1580                                 if (ctx->progress_func) {
1581                                         ctx->progress_func(
1582                                                 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1583                                                            &ctx->progress);
1584                                 }
1585
1586                         }
1587                 }
1588         }
1589         ret = 0;
1590 out_free_found_lte:
1591         if (found_lte->resource_location != RESOURCE_IN_WIM)
1592                 FREE(rspec);
1593         free_lookup_table_entry(found_lte);
1594 out:
1595         return ret;
1596
1597 resume_done:
1598         /* TODO */
1599         return 0;
1600 }
1601
1602 /* Finish extracting a file, directory, or symbolic link by setting file
1603  * security and timestamps.  */
1604 static int
1605 dentry_extract_final(struct wim_dentry *dentry, void *_ctx)
1606 {
1607         struct apply_ctx *ctx = _ctx;
1608         int ret;
1609         tchar path[ctx->ops->path_max];
1610
1611         if (!build_extraction_path(path, dentry, ctx))
1612                 return 0;
1613
1614         ret = extract_security(path, ctx, dentry);
1615         if (ret)
1616                 return ret;
1617
1618         if (ctx->ops->requires_final_set_attributes_pass) {
1619                 /* Set file attributes (if supported).  */
1620                 ret = extract_file_attributes(path, ctx, dentry, 1);
1621                 if (ret)
1622                         return ret;
1623         }
1624
1625         return extract_timestamps(path, ctx, dentry);
1626 }
1627
1628 /*
1629  * Extract a WIM dentry to standard output.
1630  *
1631  * This obviously doesn't make sense in all cases.  We return an error if the
1632  * dentry does not correspond to a regular file.  Otherwise we extract the
1633  * unnamed data stream only.
1634  */
1635 static int
1636 extract_dentry_to_stdout(struct wim_dentry *dentry)
1637 {
1638         int ret = 0;
1639         if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
1640                                              FILE_ATTRIBUTE_DIRECTORY))
1641         {
1642                 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
1643                       "extracted to standard output", dentry_full_path(dentry));
1644                 ret = WIMLIB_ERR_NOT_A_REGULAR_FILE;
1645         } else {
1646                 struct wim_lookup_table_entry *lte;
1647
1648                 lte = inode_unnamed_lte_resolved(dentry->d_inode);
1649                 if (lte) {
1650                         struct filedes _stdout;
1651                         filedes_init(&_stdout, STDOUT_FILENO);
1652                         ret = extract_stream_to_fd(lte, &_stdout, lte->size);
1653                 }
1654         }
1655         return ret;
1656 }
1657
1658 #ifdef __WIN32__
1659 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
1660 #else
1661 static const utf16lechar replacement_char = cpu_to_le16('?');
1662 #endif
1663
1664 static bool
1665 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
1666 {
1667         size_t i;
1668
1669         if (num_chars == 0)
1670                 return true;
1671         for (i = 0; i < num_chars; i++) {
1672                 switch (name[i]) {
1673         #ifdef __WIN32__
1674                 case cpu_to_le16('\\'):
1675                 case cpu_to_le16(':'):
1676                 case cpu_to_le16('*'):
1677                 case cpu_to_le16('?'):
1678                 case cpu_to_le16('"'):
1679                 case cpu_to_le16('<'):
1680                 case cpu_to_le16('>'):
1681                 case cpu_to_le16('|'):
1682         #endif
1683                 case cpu_to_le16('/'):
1684                 case cpu_to_le16('\0'):
1685                         if (fix)
1686                                 name[i] = replacement_char;
1687                         else
1688                                 return false;
1689                 }
1690         }
1691
1692 #ifdef __WIN32__
1693         if (name[num_chars - 1] == cpu_to_le16(' ') ||
1694             name[num_chars - 1] == cpu_to_le16('.'))
1695         {
1696                 if (fix)
1697                         name[num_chars - 1] = replacement_char;
1698                 else
1699                         return false;
1700         }
1701 #endif
1702         return true;
1703 }
1704
1705 static bool
1706 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1707 {
1708         const utf16lechar *file_name = dentry->file_name;
1709         return file_name != NULL &&
1710                 file_name[0] == cpu_to_le16('.') &&
1711                 (file_name[1] == cpu_to_le16('\0') ||
1712                  (file_name[1] == cpu_to_le16('.') &&
1713                   file_name[2] == cpu_to_le16('\0')));
1714 }
1715
1716 static int
1717 dentry_mark_skipped(struct wim_dentry *dentry, void *_ignore)
1718 {
1719         dentry->extraction_skipped = 1;
1720         return 0;
1721 }
1722
1723 /*
1724  * dentry_calculate_extraction_path-
1725  *
1726  * Calculate the actual filename component at which a WIM dentry will be
1727  * extracted, handling invalid filenames "properly".
1728  *
1729  * dentry->extraction_name usually will be set the same as dentry->file_name (on
1730  * UNIX, converted into the platform's multibyte encoding).  However, if the
1731  * file name contains characters that are not valid on the current platform or
1732  * has some other format that is not valid, leave dentry->extraction_name as
1733  * NULL and set dentry->extraction_skipped to indicate that this dentry should
1734  * not be extracted, unless the appropriate flag
1735  * WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES is set in the extract flags, in
1736  * which case a substitute filename will be created and set instead.
1737  *
1738  * Conflicts with case-insensitive names on Windows are handled similarly; see
1739  * below.
1740  */
1741 static int
1742 dentry_calculate_extraction_path(struct wim_dentry *dentry, void *_args)
1743 {
1744         struct apply_ctx *ctx = _args;
1745         int ret;
1746
1747         dentry->in_extraction_tree = 1;
1748
1749         if (dentry == ctx->extract_root || dentry->extraction_skipped)
1750                 return 0;
1751
1752         if (!dentry_is_supported(dentry, &ctx->supported_features))
1753                 goto skip_dentry;
1754
1755         if (dentry_is_dot_or_dotdot(dentry)) {
1756                 /* WIM files shouldn't contain . or .. entries.  But if they are
1757                  * there, don't attempt to extract them. */
1758                 WARNING("Skipping extraction of unexpected . or .. file "
1759                         "\"%"TS"\"", dentry_full_path(dentry));
1760                 goto skip_dentry;
1761         }
1762
1763 #ifdef __WIN32__
1764         if (!ctx->ops->supports_case_sensitive_filenames)
1765         {
1766                 struct wim_dentry *other;
1767                 list_for_each_entry(other, &dentry->case_insensitive_conflict_list,
1768                                     case_insensitive_conflict_list)
1769                 {
1770                         if (ctx->extract_flags &
1771                             WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
1772                                 WARNING("\"%"TS"\" has the same "
1773                                         "case-insensitive name as "
1774                                         "\"%"TS"\"; extracting "
1775                                         "dummy name instead",
1776                                         dentry_full_path(dentry),
1777                                         dentry_full_path(other));
1778                                 goto out_replace;
1779                         } else {
1780                                 WARNING("Not extracting \"%"TS"\": "
1781                                         "has same case-insensitive "
1782                                         "name as \"%"TS"\"",
1783                                         dentry_full_path(dentry),
1784                                         dentry_full_path(other));
1785                                 goto skip_dentry;
1786                         }
1787                 }
1788         }
1789 #else   /* __WIN32__ */
1790         wimlib_assert(ctx->ops->supports_case_sensitive_filenames);
1791 #endif  /* !__WIN32__ */
1792
1793         if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
1794 #ifdef __WIN32__
1795                 dentry->extraction_name = dentry->file_name;
1796                 dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
1797                 return 0;
1798 #else
1799                 return utf16le_to_tstr(dentry->file_name,
1800                                        dentry->file_name_nbytes,
1801                                        &dentry->extraction_name,
1802                                        &dentry->extraction_name_nchars);
1803 #endif
1804         } else {
1805                 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
1806                 {
1807                         WARNING("\"%"TS"\" has an invalid filename "
1808                                 "that is not supported on this platform; "
1809                                 "extracting dummy name instead",
1810                                 dentry_full_path(dentry));
1811                         goto out_replace;
1812                 } else {
1813                         WARNING("Not extracting \"%"TS"\": has an invalid filename "
1814                                 "that is not supported on this platform",
1815                                 dentry_full_path(dentry));
1816                         goto skip_dentry;
1817                 }
1818         }
1819
1820 out_replace:
1821         {
1822                 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
1823
1824                 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
1825                 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
1826
1827                 tchar *tchar_name;
1828                 size_t tchar_nchars;
1829         #ifdef __WIN32__
1830                 tchar_name = utf16_name_copy;
1831                 tchar_nchars = dentry->file_name_nbytes / 2;
1832         #else
1833                 ret = utf16le_to_tstr(utf16_name_copy,
1834                                       dentry->file_name_nbytes,
1835                                       &tchar_name, &tchar_nchars);
1836                 if (ret)
1837                         return ret;
1838         #endif
1839                 size_t fixed_name_num_chars = tchar_nchars;
1840                 tchar fixed_name[tchar_nchars + 50];
1841
1842                 tmemcpy(fixed_name, tchar_name, tchar_nchars);
1843                 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
1844                                                  T(" (invalid filename #%lu)"),
1845                                                  ++ctx->invalid_sequence);
1846         #ifndef __WIN32__
1847                 FREE(tchar_name);
1848         #endif
1849                 dentry->extraction_name = memdup(fixed_name,
1850                                                  2 * fixed_name_num_chars + 2);
1851                 if (!dentry->extraction_name)
1852                         return WIMLIB_ERR_NOMEM;
1853                 dentry->extraction_name_nchars = fixed_name_num_chars;
1854         }
1855         return 0;
1856
1857 skip_dentry:
1858         for_dentry_in_tree(dentry, dentry_mark_skipped, NULL);
1859         return 0;
1860 }
1861
1862 /* Clean up dentry and inode structure after extraction.  */
1863 static int
1864 dentry_reset_needs_extraction(struct wim_dentry *dentry, void *_ignore)
1865 {
1866         struct wim_inode *inode = dentry->d_inode;
1867
1868         dentry->in_extraction_tree = 0;
1869         dentry->extraction_skipped = 0;
1870         dentry->was_hardlinked = 0;
1871         dentry->skeleton_extracted = 0;
1872         inode->i_visited = 0;
1873         FREE(inode->i_extracted_file);
1874         inode->i_extracted_file = NULL;
1875         inode->i_dos_name_extracted = 0;
1876         if ((void*)dentry->extraction_name != (void*)dentry->file_name)
1877                 FREE(dentry->extraction_name);
1878         dentry->extraction_name = NULL;
1879         return 0;
1880 }
1881
1882 /* Tally features necessary to extract a dentry and the corresponding inode.  */
1883 static int
1884 dentry_tally_features(struct wim_dentry *dentry, void *_features)
1885 {
1886         struct wim_features *features = _features;
1887         struct wim_inode *inode = dentry->d_inode;
1888
1889         if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
1890                 features->archive_files++;
1891         if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
1892                 features->hidden_files++;
1893         if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
1894                 features->system_files++;
1895         if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
1896                 features->compressed_files++;
1897         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
1898                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1899                         features->encrypted_directories++;
1900                 else
1901                         features->encrypted_files++;
1902         }
1903         if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
1904                 features->not_context_indexed_files++;
1905         if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
1906                 features->sparse_files++;
1907         if (inode_has_named_stream(inode))
1908                 features->named_data_streams++;
1909         if (inode->i_visited)
1910                 features->hard_links++;
1911         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1912                 features->reparse_points++;
1913                 if (inode_is_symlink(inode))
1914                         features->symlink_reparse_points++;
1915                 else
1916                         features->other_reparse_points++;
1917         }
1918         if (inode->i_security_id != -1)
1919                 features->security_descriptors++;
1920         if (dentry->short_name_nbytes)
1921                 features->short_names++;
1922         if (inode_has_unix_data(inode))
1923                 features->unix_data++;
1924         inode->i_visited = 1;
1925         return 0;
1926 }
1927
1928 /* Tally the features necessary to extract a dentry tree.  */
1929 static void
1930 dentry_tree_get_features(struct wim_dentry *root, struct wim_features *features)
1931 {
1932         memset(features, 0, sizeof(struct wim_features));
1933         for_dentry_in_tree(root, dentry_tally_features, features);
1934         dentry_tree_clear_inode_visited(root);
1935 }
1936
1937 static u32
1938 compute_supported_attributes_mask(const struct wim_features *supported_features)
1939 {
1940         u32 mask = ~(u32)0;
1941
1942         if (!supported_features->archive_files)
1943                 mask &= ~FILE_ATTRIBUTE_ARCHIVE;
1944
1945         if (!supported_features->hidden_files)
1946                 mask &= ~FILE_ATTRIBUTE_HIDDEN;
1947
1948         if (!supported_features->system_files)
1949                 mask &= ~FILE_ATTRIBUTE_SYSTEM;
1950
1951         if (!supported_features->not_context_indexed_files)
1952                 mask &= ~FILE_ATTRIBUTE_NOT_CONTENT_INDEXED;
1953
1954         if (!supported_features->compressed_files)
1955                 mask &= ~FILE_ATTRIBUTE_COMPRESSED;
1956
1957         if (!supported_features->sparse_files)
1958                 mask &= ~FILE_ATTRIBUTE_SPARSE_FILE;
1959
1960         if (!supported_features->reparse_points)
1961                 mask &= ~FILE_ATTRIBUTE_REPARSE_POINT;
1962
1963         return mask;
1964 }
1965
1966 static int
1967 do_feature_check(const struct wim_features *required_features,
1968                  const struct wim_features *supported_features,
1969                  int extract_flags,
1970                  const struct apply_operations *ops,
1971                  const tchar *wim_source_path)
1972 {
1973         const tchar *loc;
1974         const tchar *mode = T("this extraction mode");
1975
1976         if (wim_source_path[0] == '\0')
1977                 loc = T("the WIM image");
1978         else
1979                 loc = wim_source_path;
1980
1981         /* We're an archive program, so theoretically we can do what we want
1982          * with FILE_ATTRIBUTE_ARCHIVE (which is a dumb flag anyway).  Don't
1983          * bother the user about it.  */
1984 #if 0
1985         if (required_features->archive_files && !supported_features->archive_files)
1986         {
1987                 WARNING(
1988           "%lu files in %"TS" are marked as archived, but this attribute\n"
1989 "          is not supported in %"TS".",
1990                         required_features->archive_files, loc, mode);
1991         }
1992 #endif
1993
1994         if (required_features->hidden_files && !supported_features->hidden_files)
1995         {
1996                 WARNING(
1997           "%lu files in %"TS" are marked as hidden, but this\n"
1998 "          attribute is not supported in %"TS".",
1999                         required_features->hidden_files, loc, mode);
2000         }
2001
2002         if (required_features->system_files && !supported_features->system_files)
2003         {
2004                 WARNING(
2005           "%lu files in %"TS" are marked as system files,\n"
2006 "          but this attribute is not supported in %"TS".",
2007                         required_features->system_files, loc, mode);
2008         }
2009
2010         if (required_features->compressed_files && !supported_features->compressed_files)
2011         {
2012                 WARNING(
2013           "%lu files in %"TS" are marked as being transparently\n"
2014 "          compressed, but transparent compression is not supported in\n"
2015 "          %"TS".  These files will be extracted as uncompressed.",
2016                         required_features->compressed_files, loc, mode);
2017         }
2018
2019         if (required_features->encrypted_files && !supported_features->encrypted_files)
2020         {
2021                 WARNING(
2022           "%lu files in %"TS" are marked as being encrypted,\n"
2023 "           but encryption is not supported in %"TS".  These files\n"
2024 "           will not be extracted.",
2025                         required_features->encrypted_files, loc, mode);
2026         }
2027
2028         if (required_features->encrypted_directories &&
2029             !supported_features->encrypted_directories)
2030         {
2031                 WARNING(
2032           "%lu directories in %"TS" are marked as being encrypted,\n"
2033 "           but encryption is not supported in %"TS".\n"
2034 "           These directories will be extracted as unencrypted.",
2035                         required_features->encrypted_directories, loc, mode);
2036         }
2037
2038         if (required_features->not_context_indexed_files &&
2039             !supported_features->not_context_indexed_files)
2040         {
2041                 WARNING(
2042           "%lu files in %"TS" are marked as not content indexed,\n"
2043 "          but this attribute is not supported in %"TS".",
2044                         required_features->not_context_indexed_files, loc, mode);
2045         }
2046
2047         if (required_features->sparse_files && !supported_features->sparse_files)
2048         {
2049                 WARNING(
2050           "%lu files in %"TS" are marked as sparse, but creating\n"
2051 "           sparse files is not supported in %"TS".  These files\n"
2052 "           will be extracted as non-sparse.",
2053                         required_features->sparse_files, loc, mode);
2054         }
2055
2056         if (required_features->named_data_streams &&
2057             !supported_features->named_data_streams)
2058         {
2059                 WARNING(
2060           "%lu files in %"TS" contain one or more alternate (named)\n"
2061 "          data streams, which are not supported in %"TS".\n"
2062 "          Alternate data streams will NOT be extracted.",
2063                         required_features->named_data_streams, loc, mode);
2064         }
2065
2066         if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
2067                                       WIMLIB_EXTRACT_FLAG_SYMLINK)) &&
2068             required_features->named_data_streams &&
2069             supported_features->named_data_streams)
2070         {
2071                 WARNING(
2072           "%lu files in %"TS" contain one or more alternate (named)\n"
2073 "          data streams, which are not supported in linked extraction mode.\n"
2074 "          Alternate data streams will NOT be extracted.",
2075                         required_features->named_data_streams, loc);
2076         }
2077
2078         if (required_features->hard_links && !supported_features->hard_links)
2079         {
2080                 WARNING(
2081           "%lu files in %"TS" are hard links, but hard links are\n"
2082 "          not supported in %"TS".  Hard links will be extracted as\n"
2083 "          duplicate copies of the linked files.",
2084                         required_features->hard_links, loc, mode);
2085         }
2086
2087         if (required_features->reparse_points && !supported_features->reparse_points)
2088         {
2089                 if (supported_features->symlink_reparse_points) {
2090                         if (required_features->other_reparse_points) {
2091                                 WARNING(
2092           "%lu files in %"TS" are reparse points that are neither\n"
2093 "          symbolic links nor junction points and are not supported in\n"
2094 "          %"TS".  These reparse points will not be extracted.",
2095                                         required_features->other_reparse_points, loc,
2096                                         mode);
2097                         }
2098                 } else {
2099                         WARNING(
2100           "%lu files in %"TS" are reparse points, which are\n"
2101 "          not supported in %"TS" and will not be extracted.",
2102                                 required_features->reparse_points, loc, mode);
2103                 }
2104         }
2105
2106         if (required_features->security_descriptors &&
2107             !supported_features->security_descriptors)
2108         {
2109                 WARNING(
2110           "%lu files in %"TS" have Windows NT security descriptors,\n"
2111 "          but extracting security descriptors is not supported in\n"
2112 "          %"TS".  No security descriptors will be extracted.",
2113                         required_features->security_descriptors, loc, mode);
2114         }
2115
2116         if (required_features->short_names && !supported_features->short_names)
2117         {
2118                 WARNING(
2119           "%lu files in %"TS" have short (DOS) names, but\n"
2120 "          extracting short names is not supported in %"TS".\n"
2121 "          Short names will not be extracted.\n",
2122                         required_features->short_names, loc, mode);
2123         }
2124
2125         if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
2126             required_features->unix_data && !supported_features->unix_data)
2127         {
2128                 ERROR("Extracting UNIX data is not supported in %"TS, mode);
2129                 return WIMLIB_ERR_UNSUPPORTED;
2130         }
2131         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) &&
2132             required_features->short_names && !supported_features->short_names)
2133         {
2134                 ERROR("Extracting short names is not supported in %"TS"", mode);
2135                 return WIMLIB_ERR_UNSUPPORTED;
2136         }
2137         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
2138             !ops->set_timestamps)
2139         {
2140                 ERROR("Extracting timestamps is not supported in %"TS"", mode);
2141                 return WIMLIB_ERR_UNSUPPORTED;
2142         }
2143         if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
2144                                WIMLIB_EXTRACT_FLAG_UNIX_DATA))
2145              == WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
2146             required_features->security_descriptors &&
2147             !supported_features->security_descriptors)
2148         {
2149                 ERROR("Extracting security descriptors is not supported in %"TS, mode);
2150                 return WIMLIB_ERR_UNSUPPORTED;
2151         }
2152
2153         if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
2154             !supported_features->hard_links)
2155         {
2156                 ERROR("Hard link extraction mode requested, but "
2157                       "%"TS" does not support hard links!", mode);
2158                 return WIMLIB_ERR_UNSUPPORTED;
2159         }
2160
2161         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
2162             required_features->symlink_reparse_points &&
2163             !(supported_features->symlink_reparse_points ||
2164               supported_features->reparse_points))
2165         {
2166                 ERROR("Extracting symbolic links is not supported in %"TS, mode);
2167                 return WIMLIB_ERR_UNSUPPORTED;
2168         }
2169
2170         if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
2171             !supported_features->symlink_reparse_points)
2172         {
2173                 ERROR("Symbolic link extraction mode requested, but "
2174                       "%"TS" does not support symbolic "
2175                       "links!", mode);
2176                 return WIMLIB_ERR_UNSUPPORTED;
2177         }
2178         return 0;
2179 }
2180
2181 static void
2182 do_extract_warnings(struct apply_ctx *ctx)
2183 {
2184         if (ctx->partial_security_descriptors == 0 &&
2185             ctx->no_security_descriptors == 0)
2186                 return;
2187
2188         WARNING("Extraction to \"%"TS"\" complete, but with one or more warnings:",
2189                 ctx->target);
2190         if (ctx->partial_security_descriptors != 0) {
2191                 WARNING("- Could only partially set the security descriptor\n"
2192                         "            on %lu files or directories.",
2193                         ctx->partial_security_descriptors);
2194         }
2195         if (ctx->no_security_descriptors != 0) {
2196                 WARNING("- Could not set security descriptor at all\n"
2197                         "            on %lu files or directories.",
2198                         ctx->no_security_descriptors);
2199         }
2200 #ifdef __WIN32__
2201         WARNING("To fully restore all security descriptors, run the program\n"
2202                 "          with Administrator rights.");
2203 #endif
2204 }
2205
2206 /*
2207  * extract_tree - Extract a file or directory tree from the currently selected
2208  *                WIM image.
2209  *
2210  * @wim:        WIMStruct for the WIM file, with the desired image selected
2211  *              (as wim->current_image).
2212  *
2213  * @wim_source_path:
2214  *              "Canonical" (i.e. no leading or trailing slashes, path
2215  *              separators WIM_PATH_SEPARATOR) path inside the WIM image to
2216  *              extract.  An empty string means the full image.
2217  *
2218  * @target:
2219  *              Filesystem path to extract the file or directory tree to.
2220  *              (Or, with WIMLIB_EXTRACT_FLAG_NTFS: the name of a NTFS volume.)
2221  *
2222  * @extract_flags:
2223  *              WIMLIB_EXTRACT_FLAG_*.  Also, the private flag
2224  *              WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being
2225  *              called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as
2226  *              the image.
2227  *
2228  * @progress_func:
2229  *              If non-NULL, progress function for the extraction.  The messages
2230  *              that may be sent in this function are:
2231  *
2232  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or
2233  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
2234  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN;
2235  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END;
2236  *              WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY;
2237  *              WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS;
2238  *              WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS;
2239  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or
2240  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2241  *
2242  * Returns 0 on success; a positive WIMLIB_ERR_* code on failure.
2243  */
2244 static int
2245 extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target,
2246              int extract_flags, wimlib_progress_func_t progress_func)
2247 {
2248         struct wim_dentry *root;
2249         struct wim_features required_features;
2250         struct apply_ctx ctx;
2251         int ret;
2252         struct wim_lookup_table_entry *lte;
2253
2254         /* Start initializing the apply_ctx.  */
2255         memset(&ctx, 0, sizeof(struct apply_ctx));
2256         ctx.wim = wim;
2257         ctx.extract_flags = extract_flags;
2258         ctx.target = target;
2259         ctx.target_nchars = tstrlen(target);
2260         ctx.progress_func = progress_func;
2261         if (progress_func) {
2262                 ctx.progress.extract.wimfile_name = wim->filename;
2263                 ctx.progress.extract.image = wim->current_image;
2264                 ctx.progress.extract.extract_flags = (extract_flags &
2265                                                       WIMLIB_EXTRACT_MASK_PUBLIC);
2266                 ctx.progress.extract.image_name = wimlib_get_image_name(wim,
2267                                                                         wim->current_image);
2268                 ctx.progress.extract.extract_root_wim_source_path = wim_source_path;
2269                 ctx.progress.extract.target = target;
2270         }
2271         INIT_LIST_HEAD(&ctx.stream_list);
2272
2273         /* Translate the path to extract into the corresponding
2274          * `struct wim_dentry', which will be the root of the
2275          * "dentry tree" to extract.  */
2276         root = get_dentry(wim, wim_source_path);
2277         if (!root) {
2278                 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
2279                       wim_source_path, wim->current_image);
2280                 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
2281                 goto out;
2282         }
2283
2284         ctx.extract_root = root;
2285
2286         /* Select the appropriate apply_operations based on the
2287          * platform and extract_flags.  */
2288 #ifdef __WIN32__
2289         ctx.ops = &win32_apply_ops;
2290 #else
2291         ctx.ops = &unix_apply_ops;
2292 #endif
2293
2294 #ifdef WITH_NTFS_3G
2295         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
2296                 ctx.ops = &ntfs_3g_apply_ops;
2297 #endif
2298
2299         /* Call the start_extract() callback.  This gives the apply_operations
2300          * implementation a chance to do any setup needed to access the volume.
2301          * Furthermore, it's expected to set the supported features of this
2302          * extraction mode (ctx.supported_features), which are determined at
2303          * runtime as they may vary depending on the actual volume.  These
2304          * features are then compared with the actual features extracting this
2305          * dentry tree requires.  Some mismatches will merely produce warnings
2306          * and the unsupported data will be ignored; others will produce errors.
2307          */
2308         ret = ctx.ops->start_extract(target, &ctx);
2309         if (ret)
2310                 goto out;
2311
2312         dentry_tree_get_features(root, &required_features);
2313         ret = do_feature_check(&required_features, &ctx.supported_features,
2314                                extract_flags, ctx.ops, wim_source_path);
2315         if (ret)
2316                 goto out_finish_or_abort_extract;
2317
2318         ctx.supported_attributes_mask =
2319                 compute_supported_attributes_mask(&ctx.supported_features);
2320
2321         /* Figure out whether the root dentry is being extracted to the root of
2322          * a volume and therefore needs to be treated "specially", for example
2323          * not being explicitly created and not having attributes set.  */
2324         if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
2325                 ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
2326
2327         /* Calculate the actual filename component of each extracted dentry.  In
2328          * the process, set the dentry->extraction_skipped flag on dentries that
2329          * are being skipped for some reason (e.g. invalid filename).  */
2330         ret = for_dentry_in_tree(root, dentry_calculate_extraction_path, &ctx);
2331         if (ret)
2332                 goto out_dentry_reset_needs_extraction;
2333
2334         /* Build the list of the streams that need to be extracted and
2335          * initialize ctx.progress.extract with stream information.  */
2336         ret = for_dentry_in_tree(ctx.extract_root,
2337                                  dentry_resolve_and_zero_lte_refcnt, &ctx);
2338         if (ret)
2339                 goto out_dentry_reset_needs_extraction;
2340
2341         ret = for_dentry_in_tree(ctx.extract_root,
2342                                  dentry_add_streams_to_extract, &ctx);
2343         if (ret)
2344                 goto out_teardown_stream_list;
2345
2346         if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2347                 /* When extracting from a pipe, the number of bytes of data to
2348                  * extract can't be determined in the normal way (examining the
2349                  * lookup table), since at this point all we have is a set of
2350                  * SHA1 message digests of streams that need to be extracted.
2351                  * However, we can get a reasonably accurate estimate by taking
2352                  * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
2353                  * data.  This does assume that a full image is being extracted,
2354                  * but currently there is no API for doing otherwise.  (Also,
2355                  * subtract <HARDLINKBYTES> from this if hard links are
2356                  * supported by the extraction mode.)  */
2357                 ctx.progress.extract.total_bytes =
2358                         wim_info_get_image_total_bytes(wim->wim_info,
2359                                                        wim->current_image);
2360                 if (ctx.supported_features.hard_links) {
2361                         ctx.progress.extract.total_bytes -=
2362                                 wim_info_get_image_hard_link_bytes(wim->wim_info,
2363                                                                    wim->current_image);
2364                 }
2365         }
2366
2367         /* Handle the special case of extracting a file to standard
2368          * output.  In that case, "root" should be a single file, not a
2369          * directory tree.  (If not, extract_dentry_to_stdout() will
2370          * return an error.)  */
2371         if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
2372                 ret = extract_dentry_to_stdout(root);
2373                 goto out_teardown_stream_list;
2374         }
2375
2376         if (ctx.ops->realpath_works_on_nonexisting_files &&
2377             ((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
2378              ctx.ops->requires_realtarget_in_paths))
2379         {
2380                 ctx.realtarget = realpath(target, NULL);
2381                 if (!ctx.realtarget) {
2382                         ret = WIMLIB_ERR_NOMEM;
2383                         goto out_teardown_stream_list;
2384                 }
2385                 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2386         }
2387
2388         if (progress_func) {
2389                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN :
2390                                                  WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
2391                               &ctx.progress);
2392         }
2393
2394         if (!ctx.root_dentry_is_special)
2395         {
2396                 tchar path[ctx.ops->path_max];
2397                 if (build_extraction_path(path, root, &ctx))
2398                 {
2399                         ret = extract_inode(path, &ctx, root->d_inode);
2400                         if (ret)
2401                                 goto out_free_realtarget;
2402                 }
2403         }
2404
2405         /* If we need to fix up the targets of absolute symbolic links
2406          * (WIMLIB_EXTRACT_FLAG_RPFIX) or the extraction mode requires paths to
2407          * be absolute, use realpath() (or its replacement on Windows) to get
2408          * the absolute path to the extraction target.  Note that this requires
2409          * the target directory to exist, unless
2410          * realpath_works_on_nonexisting_files is set in the apply_operations.
2411          * */
2412         if (!ctx.realtarget &&
2413             (((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
2414               required_features.symlink_reparse_points) ||
2415              ctx.ops->requires_realtarget_in_paths))
2416         {
2417                 ctx.realtarget = realpath(target, NULL);
2418                 if (!ctx.realtarget) {
2419                         ret = WIMLIB_ERR_NOMEM;
2420                         goto out_free_realtarget;
2421                 }
2422                 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2423         }
2424
2425         if (ctx.ops->requires_short_name_reordering) {
2426                 ret = for_dentry_in_tree(root, dentry_extract_dir_skeleton,
2427                                          &ctx);
2428                 if (ret)
2429                         goto out_free_realtarget;
2430         }
2431
2432         /* Finally, the important part: extract the tree of files.  */
2433         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SEQUENTIAL |
2434                              WIMLIB_EXTRACT_FLAG_FROM_PIPE)) {
2435                 /* Sequential extraction requested, so two passes are needed
2436                  * (one for directory structure, one for streams.)  */
2437                 if (progress_func)
2438                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2439                                       &ctx.progress);
2440
2441                 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
2442                         ret = for_dentry_in_tree(root, dentry_extract_skeleton, &ctx);
2443                         if (ret)
2444                                 goto out_free_realtarget;
2445                 }
2446                 if (progress_func)
2447                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2448                                       &ctx.progress);
2449                 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
2450                         ret = extract_streams_from_pipe(&ctx);
2451                 else
2452                         ret = extract_stream_list(&ctx);
2453                 if (ret)
2454                         goto out_free_realtarget;
2455         } else {
2456                 /* Sequential extraction was not requested, so we can make do
2457                  * with one pass where we both create the files and extract
2458                  * streams.   */
2459                 if (progress_func)
2460                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2461                                       &ctx.progress);
2462                 ret = for_dentry_in_tree(root, dentry_extract, &ctx);
2463                 if (ret)
2464                         goto out_free_realtarget;
2465                 if (progress_func)
2466                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2467                                       &ctx.progress);
2468         }
2469
2470         /* If the total number of bytes to extract was miscalculated, just jump
2471          * to the calculated number in order to avoid confusing the progress
2472          * function.  This should only occur when extracting from a pipe.  */
2473         if (ctx.progress.extract.completed_bytes != ctx.progress.extract.total_bytes)
2474         {
2475                 DEBUG("Calculated %"PRIu64" bytes to extract, but actually "
2476                       "extracted %"PRIu64,
2477                       ctx.progress.extract.total_bytes,
2478                       ctx.progress.extract.completed_bytes);
2479         }
2480         if (progress_func &&
2481             ctx.progress.extract.completed_bytes < ctx.progress.extract.total_bytes)
2482         {
2483                 ctx.progress.extract.completed_bytes = ctx.progress.extract.total_bytes;
2484                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &ctx.progress);
2485         }
2486
2487         /* Apply security descriptors and timestamps.  This is done at the end,
2488          * and in a depth-first manner, to prevent timestamps from getting
2489          * changed by subsequent extract operations and to minimize the chance
2490          * of the restored security descriptors getting in our way.  */
2491         if (progress_func)
2492                 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
2493                               &ctx.progress);
2494         ret = for_dentry_in_tree_depth(root, dentry_extract_final, &ctx);
2495         if (ret)
2496                 goto out_free_realtarget;
2497
2498         if (progress_func) {
2499                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END :
2500                               WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
2501                               &ctx.progress);
2502         }
2503
2504         do_extract_warnings(&ctx);
2505
2506         ret = 0;
2507 out_free_realtarget:
2508         FREE(ctx.realtarget);
2509 out_teardown_stream_list:
2510         /* Free memory allocated as part of the mapping from each
2511          * wim_lookup_table_entry to the dentries that reference it.  */
2512         if (ctx.extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL)
2513                 list_for_each_entry(lte, &ctx.stream_list, extraction_list)
2514                         if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
2515                                 FREE(lte->lte_dentries);
2516 out_dentry_reset_needs_extraction:
2517         for_dentry_in_tree(root, dentry_reset_needs_extraction, NULL);
2518 out_finish_or_abort_extract:
2519         if (ret) {
2520                 if (ctx.ops->abort_extract)
2521                         ctx.ops->abort_extract(&ctx);
2522         } else {
2523                 if (ctx.ops->finish_extract)
2524                         ret = ctx.ops->finish_extract(&ctx);
2525         }
2526 out:
2527         return ret;
2528 }
2529
2530 /* Validates a single wimlib_extract_command, mostly checking to make sure the
2531  * extract flags make sense. */
2532 static int
2533 check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
2534 {
2535         int extract_flags;
2536
2537         /* Empty destination path? */
2538         if (cmd->fs_dest_path[0] == T('\0'))
2539                 return WIMLIB_ERR_INVALID_PARAM;
2540
2541         extract_flags = cmd->extract_flags;
2542
2543         /* Check for invalid flag combinations  */
2544         if ((extract_flags &
2545              (WIMLIB_EXTRACT_FLAG_SYMLINK |
2546               WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
2547                                                  WIMLIB_EXTRACT_FLAG_HARDLINK))
2548                 return WIMLIB_ERR_INVALID_PARAM;
2549
2550         if ((extract_flags &
2551              (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2552               WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2553                                                     WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2554                 return WIMLIB_ERR_INVALID_PARAM;
2555
2556         if ((extract_flags &
2557              (WIMLIB_EXTRACT_FLAG_RPFIX |
2558               WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
2559                                                 WIMLIB_EXTRACT_FLAG_NORPFIX))
2560                 return WIMLIB_ERR_INVALID_PARAM;
2561
2562         if ((extract_flags &
2563              (WIMLIB_EXTRACT_FLAG_RESUME |
2564               WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
2565                 return WIMLIB_ERR_INVALID_PARAM;
2566
2567         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2568 #ifndef WITH_NTFS_3G
2569                 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
2570                       "        we cannot apply a WIM image directly to a NTFS volume.");
2571                 return WIMLIB_ERR_UNSUPPORTED;
2572 #endif
2573         }
2574
2575         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
2576                               WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0)
2577         {
2578                 /* Do reparse point fixups by default if the WIM header says
2579                  * they are enabled and we are extracting a full image. */
2580                 if (wim_header_flags & WIM_HDR_FLAG_RP_FIX)
2581                         extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
2582         }
2583
2584         /* TODO: Since UNIX data entries are stored in the file resources, in a
2585          * completely sequential extraction they may come up before the
2586          * corresponding file or symbolic link data.  This needs to be handled
2587          * better.  */
2588         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2589                               WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2590                                     == (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2591                                         WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2592         {
2593                 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2594                         WARNING("Setting UNIX file/owner group may "
2595                                 "be impossible on some\n"
2596                                 "          symbolic links "
2597                                 "when applying from a pipe.");
2598                 } else {
2599                         extract_flags &= ~WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2600                         WARNING("Disabling sequential extraction for "
2601                                 "UNIX data mode");
2602                 }
2603         }
2604
2605         cmd->extract_flags = extract_flags;
2606         return 0;
2607 }
2608
2609
2610 /* Internal function to execute extraction commands for a WIM image.  The paths
2611  * in the extract commands are expected to be already "canonicalized".  */
2612 static int
2613 do_wimlib_extract_files(WIMStruct *wim,
2614                         int image,
2615                         struct wimlib_extract_command *cmds,
2616                         size_t num_cmds,
2617                         wimlib_progress_func_t progress_func)
2618 {
2619         int ret;
2620         bool found_link_cmd = false;
2621         bool found_nolink_cmd = false;
2622
2623         /* Select the image from which we are extracting files */
2624         ret = select_wim_image(wim, image);
2625         if (ret)
2626                 return ret;
2627
2628         /* Make sure there are no streams in the WIM that have not been
2629          * checksummed yet.  */
2630         ret = wim_checksum_unhashed_streams(wim);
2631         if (ret)
2632                 return ret;
2633
2634         /* Check for problems with the extraction commands */
2635         for (size_t i = 0; i < num_cmds; i++) {
2636                 ret = check_extract_command(&cmds[i], wim->hdr.flags);
2637                 if (ret)
2638                         return ret;
2639                 if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2640                                              WIMLIB_EXTRACT_FLAG_HARDLINK)) {
2641                         found_link_cmd = true;
2642                 } else {
2643                         found_nolink_cmd = true;
2644                 }
2645                 if (found_link_cmd && found_nolink_cmd) {
2646                         ERROR("Symlink or hardlink extraction mode must "
2647                               "be set on all extraction commands");
2648                         return WIMLIB_ERR_INVALID_PARAM;
2649                 }
2650         }
2651
2652         /* Execute the extraction commands */
2653         for (size_t i = 0; i < num_cmds; i++) {
2654                 ret = extract_tree(wim,
2655                                    cmds[i].wim_source_path,
2656                                    cmds[i].fs_dest_path,
2657                                    cmds[i].extract_flags,
2658                                    progress_func);
2659                 if (ret)
2660                         return ret;
2661         }
2662         return 0;
2663 }
2664
2665 /* API function documented in wimlib.h  */
2666 WIMLIBAPI int
2667 wimlib_extract_files(WIMStruct *wim,
2668                      int image,
2669                      const struct wimlib_extract_command *cmds,
2670                      size_t num_cmds,
2671                      int default_extract_flags,
2672                      wimlib_progress_func_t progress_func)
2673 {
2674         int ret;
2675         struct wimlib_extract_command *cmds_copy;
2676         int all_flags = 0;
2677
2678         default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2679
2680         if (num_cmds == 0)
2681                 return 0;
2682
2683         cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
2684         if (!cmds_copy)
2685                 return WIMLIB_ERR_NOMEM;
2686
2687         for (size_t i = 0; i < num_cmds; i++) {
2688                 cmds_copy[i].extract_flags = (default_extract_flags |
2689                                                  cmds[i].extract_flags)
2690                                                 & WIMLIB_EXTRACT_MASK_PUBLIC;
2691                 all_flags |= cmds_copy[i].extract_flags;
2692
2693                 cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path);
2694                 if (!cmds_copy[i].wim_source_path) {
2695                         ret = WIMLIB_ERR_NOMEM;
2696                         goto out_free_cmds_copy;
2697                 }
2698
2699                 cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path);
2700                 if (!cmds_copy[i].fs_dest_path) {
2701                         ret = WIMLIB_ERR_NOMEM;
2702                         goto out_free_cmds_copy;
2703                 }
2704
2705         }
2706         ret = do_wimlib_extract_files(wim, image,
2707                                       cmds_copy, num_cmds,
2708                                       progress_func);
2709
2710         if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2711                          WIMLIB_EXTRACT_FLAG_HARDLINK))
2712         {
2713                 for_lookup_table_entry(wim->lookup_table,
2714                                        lte_free_extracted_file, NULL);
2715         }
2716 out_free_cmds_copy:
2717         for (size_t i = 0; i < num_cmds; i++) {
2718                 FREE(cmds_copy[i].wim_source_path);
2719                 FREE(cmds_copy[i].fs_dest_path);
2720         }
2721         FREE(cmds_copy);
2722         return ret;
2723 }
2724
2725 /*
2726  * Extracts an image from a WIM file.
2727  *
2728  * @wim:                WIMStruct for the WIM file.
2729  *
2730  * @image:              Number of the single image to extract.
2731  *
2732  * @target:             Directory or NTFS volume to extract the image to.
2733  *
2734  * @extract_flags:      Bitwise or of WIMLIB_EXTRACT_FLAG_*.
2735  *
2736  * @progress_func:      If non-NULL, a progress function to be called
2737  *                      periodically.
2738  *
2739  * Returns 0 on success; nonzero on failure.
2740  */
2741 static int
2742 extract_single_image(WIMStruct *wim, int image,
2743                      const tchar *target, int extract_flags,
2744                      wimlib_progress_func_t progress_func)
2745 {
2746         int ret;
2747         tchar *target_copy = canonicalize_fs_path(target);
2748         if (target_copy == NULL)
2749                 return WIMLIB_ERR_NOMEM;
2750         struct wimlib_extract_command cmd = {
2751                 .wim_source_path = T(""),
2752                 .fs_dest_path = target_copy,
2753                 .extract_flags = extract_flags,
2754         };
2755         ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func);
2756         FREE(target_copy);
2757         return ret;
2758 }
2759
2760 static const tchar * const filename_forbidden_chars =
2761 T(
2762 #ifdef __WIN32__
2763 "<>:\"/\\|?*"
2764 #else
2765 "/"
2766 #endif
2767 );
2768
2769 /* This function checks if it is okay to use a WIM image's name as a directory
2770  * name.  */
2771 static bool
2772 image_name_ok_as_dir(const tchar *image_name)
2773 {
2774         return image_name && *image_name &&
2775                 !tstrpbrk(image_name, filename_forbidden_chars) &&
2776                 tstrcmp(image_name, T(".")) &&
2777                 tstrcmp(image_name, T(".."));
2778 }
2779
2780 /* Extracts all images from the WIM to the directory @target, with the images
2781  * placed in subdirectories named by their image names. */
2782 static int
2783 extract_all_images(WIMStruct *wim,
2784                    const tchar *target,
2785                    int extract_flags,
2786                    wimlib_progress_func_t progress_func)
2787 {
2788         size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
2789         size_t output_path_len = tstrlen(target);
2790         tchar buf[output_path_len + 1 + image_name_max_len + 1];
2791         int ret;
2792         int image;
2793         const tchar *image_name;
2794         struct stat stbuf;
2795
2796         extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
2797
2798         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2799                 ERROR("Cannot extract multiple images in NTFS extraction mode.");
2800                 return WIMLIB_ERR_INVALID_PARAM;
2801         }
2802
2803         if (tstat(target, &stbuf)) {
2804                 if (errno == ENOENT) {
2805                         if (tmkdir(target, 0755)) {
2806                                 ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
2807                                 return WIMLIB_ERR_MKDIR;
2808                         }
2809                 } else {
2810                         ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
2811                         return WIMLIB_ERR_STAT;
2812                 }
2813         } else if (!S_ISDIR(stbuf.st_mode)) {
2814                 ERROR("\"%"TS"\" is not a directory", target);
2815                 return WIMLIB_ERR_NOTDIR;
2816         }
2817
2818         tmemcpy(buf, target, output_path_len);
2819         buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
2820         for (image = 1; image <= wim->hdr.image_count; image++) {
2821                 image_name = wimlib_get_image_name(wim, image);
2822                 if (image_name_ok_as_dir(image_name)) {
2823                         tstrcpy(buf + output_path_len + 1, image_name);
2824                 } else {
2825                         /* Image name is empty or contains forbidden characters.
2826                          * Use image number instead. */
2827                         tsprintf(buf + output_path_len + 1, T("%d"), image);
2828                 }
2829                 ret = extract_single_image(wim, image, buf, extract_flags,
2830                                            progress_func);
2831                 if (ret)
2832                         return ret;
2833         }
2834         return 0;
2835 }
2836
2837 static int
2838 do_wimlib_extract_image(WIMStruct *wim,
2839                         int image,
2840                         const tchar *target,
2841                         int extract_flags,
2842                         wimlib_progress_func_t progress_func)
2843 {
2844         int ret;
2845
2846         if (image == WIMLIB_ALL_IMAGES) {
2847                 ret = extract_all_images(wim, target, extract_flags,
2848                                          progress_func);
2849         } else {
2850                 ret = extract_single_image(wim, image, target, extract_flags,
2851                                            progress_func);
2852         }
2853
2854         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2855                              WIMLIB_EXTRACT_FLAG_HARDLINK))
2856         {
2857                 for_lookup_table_entry(wim->lookup_table,
2858                                        lte_free_extracted_file,
2859                                        NULL);
2860         }
2861         return ret;
2862 }
2863
2864 /* API function documented in wimlib.h  */
2865 WIMLIBAPI int
2866 wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
2867                                const tchar *target, int extract_flags,
2868                                wimlib_progress_func_t progress_func)
2869 {
2870         int ret;
2871         WIMStruct *pwm;
2872         struct filedes *in_fd;
2873         int image;
2874         unsigned i;
2875
2876         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2877
2878         if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
2879                 return WIMLIB_ERR_INVALID_PARAM;
2880
2881         extract_flags |= WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2882
2883         /* Read the WIM header from the pipe and get a WIMStruct to represent
2884          * the pipable WIM.  Caveats:  Unlike getting a WIMStruct with
2885          * wimlib_open_wim(), getting a WIMStruct in this way will result in
2886          * an empty lookup table, no XML data read, and no filename set.  */
2887         ret = open_wim_as_WIMStruct(&pipe_fd,
2888                                     WIMLIB_OPEN_FLAG_FROM_PIPE,
2889                                     &pwm, progress_func);
2890         if (ret)
2891                 return ret;
2892
2893         /* Sanity check to make sure this is a pipable WIM.  */
2894         if (pwm->hdr.magic != PWM_MAGIC) {
2895                 ERROR("The WIM being read from file descriptor %d "
2896                       "is not pipable!", pipe_fd);
2897                 ret = WIMLIB_ERR_NOT_PIPABLE;
2898                 goto out_wimlib_free;
2899         }
2900
2901         /* Sanity check to make sure the first part of a pipable split WIM is
2902          * sent over the pipe first.  */
2903         if (pwm->hdr.part_number != 1) {
2904                 ERROR("The first part of the split WIM must be "
2905                       "sent over the pipe first.");
2906                 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2907                 goto out_wimlib_free;
2908         }
2909
2910         in_fd = &pwm->in_fd;
2911         wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
2912
2913         /* As mentioned, the WIMStruct we created from the pipe does not have
2914          * XML data yet.  Fix this by reading the extra copy of the XML data
2915          * that directly follows the header in pipable WIMs.  (Note: see
2916          * write_pipable_wim() for more details about the format of pipable
2917          * WIMs.)  */
2918         {
2919                 struct wim_lookup_table_entry xml_lte;
2920                 struct wim_resource_spec xml_rspec;
2921                 ret = read_pwm_stream_header(pwm, &xml_lte, &xml_rspec, 0, NULL);
2922                 if (ret)
2923                         goto out_wimlib_free;
2924
2925                 if (!(xml_lte.flags & WIM_RESHDR_FLAG_METADATA))
2926                 {
2927                         ERROR("Expected XML data, but found non-metadata "
2928                               "stream.");
2929                         ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2930                         goto out_wimlib_free;
2931                 }
2932
2933                 wim_res_spec_to_hdr(&xml_rspec, &pwm->hdr.xml_data_reshdr);
2934
2935                 ret = read_wim_xml_data(pwm);
2936                 if (ret)
2937                         goto out_wimlib_free;
2938
2939                 if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
2940                         ERROR("Image count in XML data is not the same as in WIM header.");
2941                         ret = WIMLIB_ERR_XML;
2942                         goto out_wimlib_free;
2943                 }
2944         }
2945
2946         /* Get image index (this may use the XML data that was just read to
2947          * resolve an image name).  */
2948         if (image_num_or_name) {
2949                 image = wimlib_resolve_image(pwm, image_num_or_name);
2950                 if (image == WIMLIB_NO_IMAGE) {
2951                         ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
2952                               image_num_or_name);
2953                         ret = WIMLIB_ERR_INVALID_IMAGE;
2954                         goto out_wimlib_free;
2955                 } else if (image == WIMLIB_ALL_IMAGES) {
2956                         ERROR("Applying all images from a pipe is not supported.");
2957                         ret = WIMLIB_ERR_INVALID_IMAGE;
2958                         goto out_wimlib_free;
2959                 }
2960         } else {
2961                 if (pwm->hdr.image_count != 1) {
2962                         ERROR("No image was specified, but the pipable WIM "
2963                               "did not contain exactly 1 image");
2964                         ret = WIMLIB_ERR_INVALID_IMAGE;
2965                         goto out_wimlib_free;
2966                 }
2967                 image = 1;
2968         }
2969
2970         /* Load the needed metadata resource.  */
2971         for (i = 1; i <= pwm->hdr.image_count; i++) {
2972                 struct wim_lookup_table_entry *metadata_lte;
2973                 struct wim_image_metadata *imd;
2974                 struct wim_resource_spec *metadata_rspec;
2975
2976                 metadata_lte = new_lookup_table_entry();
2977                 if (metadata_lte == NULL) {
2978                         ret = WIMLIB_ERR_NOMEM;
2979                         goto out_wimlib_free;
2980                 }
2981                 metadata_rspec = MALLOC(sizeof(struct wim_resource_spec));
2982                 if (metadata_rspec == NULL) {
2983                         ret = WIMLIB_ERR_NOMEM;
2984                         free_lookup_table_entry(metadata_lte);
2985                         goto out_wimlib_free;
2986                 }
2987
2988                 ret = read_pwm_stream_header(pwm, metadata_lte, metadata_rspec, 0, NULL);
2989                 imd = pwm->image_metadata[i - 1];
2990                 imd->metadata_lte = metadata_lte;
2991                 if (ret) {
2992                         FREE(metadata_rspec);
2993                         goto out_wimlib_free;
2994                 }
2995
2996                 if (!(metadata_lte->flags & WIM_RESHDR_FLAG_METADATA)) {
2997                         ERROR("Expected metadata resource, but found "
2998                               "non-metadata stream.");
2999                         ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3000                         goto out_wimlib_free;
3001                 }
3002
3003                 if (i == image) {
3004                         /* Metadata resource is for the images being extracted.
3005                          * Parse it and save the metadata in memory.  */
3006                         ret = read_metadata_resource(pwm, imd);
3007                         if (ret)
3008                                 goto out_wimlib_free;
3009                         imd->modified = 1;
3010                 } else {
3011                         /* Metadata resource is not for the image being
3012                          * extracted.  Skip over it.  */
3013                         ret = skip_wim_stream(metadata_lte);
3014                         if (ret)
3015                                 goto out_wimlib_free;
3016                 }
3017         }
3018         /* Extract the image.  */
3019         extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
3020         ret = do_wimlib_extract_image(pwm, image, target,
3021                                       extract_flags, progress_func);
3022         /* Clean up and return.  */
3023 out_wimlib_free:
3024         wimlib_free(pwm);
3025         return ret;
3026 }
3027
3028 /* API function documented in wimlib.h  */
3029 WIMLIBAPI int
3030 wimlib_extract_image(WIMStruct *wim,
3031                      int image,
3032                      const tchar *target,
3033                      int extract_flags,
3034                      wimlib_progress_func_t progress_func)
3035 {
3036         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
3037         return do_wimlib_extract_image(wim, image, target, extract_flags,
3038                                        progress_func);
3039 }