create_temporary_file(): Fix use-after-free
[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, void *_ctx)
1312 {
1313         struct apply_ctx *ctx = _ctx;
1314         int ret;
1315
1316         if (!need_tmpfile_to_extract(lte, is_partial_res)) {
1317                 DEBUG("Temporary file not needed "
1318                       "for stream (size=%"PRIu64")", lte->size);
1319                 ret = extract_stream_instances(lte, lte, ctx);
1320                 if (ret)
1321                         return ret;
1322
1323                 /* Negative return value here means the function was successful,
1324                  * but the consume_chunk and end_chunk callbacks need not be
1325                  * called.  */
1326                 return -1;
1327         }
1328
1329         DEBUG("Temporary file needed for stream (size=%"PRIu64")", lte->size);
1330         return create_temporary_file(&ctx->tmpfile_fd, &ctx->tmpfile_name);
1331 }
1332
1333 static int
1334 end_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
1335                               int status, void *_ctx)
1336 {
1337         struct apply_ctx *ctx = _ctx;
1338         struct wim_lookup_table_entry lte_override;
1339         int ret;
1340         int errno_save = errno;
1341
1342         ret = filedes_close(&ctx->tmpfile_fd);
1343
1344         if (status) {
1345                 ret = status;
1346                 errno = errno_save;
1347                 goto out_delete_tmpfile;
1348         }
1349
1350         if (ret) {
1351                 ERROR_WITH_ERRNO("Error writing temporary file %"TS, ctx->tmpfile_name);
1352                 ret = WIMLIB_ERR_WRITE;
1353                 goto out_delete_tmpfile;
1354         }
1355
1356         /* Now that a full stream has been extracted to a temporary file,
1357          * extract all instances of it to the actual target.  */
1358
1359         memcpy(&lte_override, lte, sizeof(struct wim_lookup_table_entry));
1360         lte_override.resource_location = RESOURCE_IN_FILE_ON_DISK;
1361         lte_override.file_on_disk = ctx->tmpfile_name;
1362
1363         ret = extract_stream_instances(lte, &lte_override, ctx);
1364
1365 out_delete_tmpfile:
1366         errno_save = errno;
1367         tunlink(ctx->tmpfile_name);
1368         FREE(ctx->tmpfile_name);
1369         errno = errno_save;
1370         return ret;
1371 }
1372
1373 /* Extracts a list of streams (ctx.stream_list), assuming that the directory
1374  * structure and empty files were already created.  This relies on the
1375  * per-`struct wim_lookup_table_entry' list of dentries that reference each
1376  * stream that was constructed earlier.  */
1377 static int
1378 extract_stream_list(struct apply_ctx *ctx)
1379 {
1380         if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
1381                 /* Sequential extraction: read the streams in the order in which
1382                  * they appear in the WIM file.  */
1383                 struct read_stream_list_callbacks cbs = {
1384                         .begin_stream           = begin_extract_stream_to_tmpfile,
1385                         .begin_stream_ctx       = ctx,
1386                         .consume_chunk          = extract_chunk_to_fd,
1387                         .consume_chunk_ctx      = &ctx->tmpfile_fd,
1388                         .end_stream             = end_extract_stream_to_tmpfile,
1389                         .end_stream_ctx         = ctx,
1390                 };
1391                 return read_stream_list(&ctx->stream_list,
1392                                         offsetof(struct wim_lookup_table_entry, extraction_list),
1393                                         0, &cbs);
1394         } else {
1395                 /* Extract the streams in unsorted order.  */
1396                 struct wim_lookup_table_entry *lte;
1397                 int ret;
1398
1399                 list_for_each_entry(lte, &ctx->stream_list, extraction_list) {
1400                         ret = extract_stream_instances(lte, lte, ctx);
1401                         if (ret)
1402                                 return ret;
1403                 }
1404                 return 0;
1405         }
1406 }
1407
1408 #define PWM_ALLOW_WIM_HDR 0x00001
1409 #define PWM_SILENT_EOF    0x00002
1410
1411 /* Read the header from a stream in a pipable WIM.  */
1412 static int
1413 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
1414                        struct wim_resource_spec *rspec,
1415                        int flags, struct wim_header_disk *hdr_ret)
1416 {
1417         union {
1418                 struct pwm_stream_hdr stream_hdr;
1419                 struct wim_header_disk pwm_hdr;
1420         } buf;
1421         struct wim_reshdr reshdr;
1422         int ret;
1423
1424         ret = full_read(&pwm->in_fd, &buf.stream_hdr, sizeof(buf.stream_hdr));
1425         if (ret)
1426                 goto read_error;
1427
1428         if ((flags & PWM_ALLOW_WIM_HDR) && buf.stream_hdr.magic == PWM_MAGIC) {
1429                 BUILD_BUG_ON(sizeof(buf.pwm_hdr) < sizeof(buf.stream_hdr));
1430                 ret = full_read(&pwm->in_fd, &buf.stream_hdr + 1,
1431                                 sizeof(buf.pwm_hdr) - sizeof(buf.stream_hdr));
1432
1433                 if (ret)
1434                         goto read_error;
1435                 lte->resource_location = RESOURCE_NONEXISTENT;
1436                 memcpy(hdr_ret, &buf.pwm_hdr, sizeof(buf.pwm_hdr));
1437                 return 0;
1438         }
1439
1440         if (buf.stream_hdr.magic != PWM_STREAM_MAGIC) {
1441                 ERROR("Data read on pipe is invalid (expected stream header).");
1442                 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1443         }
1444
1445         copy_hash(lte->hash, buf.stream_hdr.hash);
1446
1447         reshdr.size_in_wim = 0;
1448         reshdr.flags = le32_to_cpu(buf.stream_hdr.flags);
1449         reshdr.offset_in_wim = pwm->in_fd.offset;
1450         reshdr.uncompressed_size = le64_to_cpu(buf.stream_hdr.uncompressed_size);
1451         wim_res_hdr_to_spec(&reshdr, pwm, rspec);
1452         lte_bind_wim_resource_spec(lte, rspec);
1453         lte->flags = rspec->flags;
1454         lte->size = rspec->uncompressed_size;
1455         lte->offset_in_res = 0;
1456         return 0;
1457
1458 read_error:
1459         if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
1460                 ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
1461         return ret;
1462 }
1463
1464 static int
1465 extract_streams_from_pipe(struct apply_ctx *ctx)
1466 {
1467         struct wim_lookup_table_entry *found_lte;
1468         struct wim_resource_spec *rspec;
1469         struct wim_lookup_table_entry *needed_lte;
1470         struct wim_lookup_table *lookup_table;
1471         struct wim_header_disk pwm_hdr;
1472         int ret;
1473         int pwm_flags;
1474
1475         ret = WIMLIB_ERR_NOMEM;
1476         found_lte = new_lookup_table_entry();
1477         if (found_lte == NULL)
1478                 goto out;
1479
1480         rspec = MALLOC(sizeof(struct wim_resource_spec));
1481         if (rspec == NULL)
1482                 goto out_free_found_lte;
1483
1484         lookup_table = ctx->wim->lookup_table;
1485         pwm_flags = PWM_ALLOW_WIM_HDR;
1486         if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1487                 pwm_flags |= PWM_SILENT_EOF;
1488         memcpy(ctx->progress.extract.guid, ctx->wim->hdr.guid, WIM_GID_LEN);
1489         ctx->progress.extract.part_number = ctx->wim->hdr.part_number;
1490         ctx->progress.extract.total_parts = ctx->wim->hdr.total_parts;
1491         if (ctx->progress_func)
1492                 ctx->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1493                                    &ctx->progress);
1494         while (ctx->num_streams_remaining) {
1495                 if (found_lte->resource_location != RESOURCE_NONEXISTENT)
1496                         lte_unbind_wim_resource_spec(found_lte);
1497                 ret = read_pwm_stream_header(ctx->wim, found_lte, rspec,
1498                                              pwm_flags, &pwm_hdr);
1499                 if (ret) {
1500                         if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
1501                             (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1502                         {
1503                                 goto resume_done;
1504                         }
1505                         goto out_free_found_lte;
1506                 }
1507
1508                 if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
1509                     && !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
1510                     && (needed_lte = lookup_resource(lookup_table, found_lte->hash))
1511                     && (needed_lte->out_refcnt))
1512                 {
1513                         char *tmpfile_name = NULL;
1514                         struct wim_lookup_table_entry *lte_override;
1515                         struct wim_lookup_table_entry tmpfile_lte;
1516
1517                         needed_lte->offset_in_res = found_lte->offset_in_res;
1518                         needed_lte->flags = found_lte->flags;
1519                         needed_lte->size = found_lte->size;
1520
1521                         lte_unbind_wim_resource_spec(found_lte);
1522                         lte_bind_wim_resource_spec(needed_lte, rspec);
1523
1524                         if (needed_lte->out_refcnt > 1) {
1525
1526                                 struct filedes tmpfile_fd;
1527
1528                                 /* Extract stream to temporary file.  */
1529                                 ret = create_temporary_file(&tmpfile_fd, &tmpfile_name);
1530                                 if (ret)
1531                                         goto out_free_found_lte;
1532
1533                                 ret = extract_stream_to_fd(needed_lte, &tmpfile_fd,
1534                                                            needed_lte->size);
1535                                 if (ret) {
1536                                         filedes_close(&tmpfile_fd);
1537                                         goto delete_tmpfile;
1538                                 }
1539
1540                                 if (filedes_close(&tmpfile_fd)) {
1541                                         ERROR_WITH_ERRNO("Error writing to temporary "
1542                                                          "file \"%"TS"\"", tmpfile_name);
1543                                         ret = WIMLIB_ERR_WRITE;
1544                                         goto delete_tmpfile;
1545                                 }
1546                                 memcpy(&tmpfile_lte, needed_lte,
1547                                        sizeof(struct wim_lookup_table_entry));
1548                                 tmpfile_lte.resource_location = RESOURCE_IN_FILE_ON_DISK;
1549                                 tmpfile_lte.file_on_disk = tmpfile_name;
1550                                 lte_override = &tmpfile_lte;
1551                         } else {
1552                                 lte_override = needed_lte;
1553                         }
1554
1555                         ret = extract_stream_instances(needed_lte, lte_override, ctx);
1556                 delete_tmpfile:
1557                         lte_unbind_wim_resource_spec(needed_lte);
1558                         if (tmpfile_name) {
1559                                 tunlink(tmpfile_name);
1560                                 FREE(tmpfile_name);
1561                         }
1562                         if (ret)
1563                                 goto out_free_found_lte;
1564                         ctx->num_streams_remaining--;
1565                 } else if (found_lte->resource_location != RESOURCE_NONEXISTENT) {
1566                         ret = skip_wim_stream(found_lte);
1567                         if (ret)
1568                                 goto out_free_found_lte;
1569                 } else {
1570                         u16 part_number = le16_to_cpu(pwm_hdr.part_number);
1571                         u16 total_parts = le16_to_cpu(pwm_hdr.total_parts);
1572
1573                         if (part_number != ctx->progress.extract.part_number ||
1574                             total_parts != ctx->progress.extract.total_parts ||
1575                             memcmp(pwm_hdr.guid, ctx->progress.extract.guid,
1576                                    WIM_GID_LEN))
1577                         {
1578                                 ctx->progress.extract.part_number = part_number;
1579                                 ctx->progress.extract.total_parts = total_parts;
1580                                 memcpy(ctx->progress.extract.guid,
1581                                        pwm_hdr.guid, WIM_GID_LEN);
1582                                 if (ctx->progress_func) {
1583                                         ctx->progress_func(
1584                                                 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1585                                                            &ctx->progress);
1586                                 }
1587
1588                         }
1589                 }
1590         }
1591         ret = 0;
1592 out_free_found_lte:
1593         if (found_lte->resource_location != RESOURCE_IN_WIM)
1594                 FREE(rspec);
1595         free_lookup_table_entry(found_lte);
1596 out:
1597         return ret;
1598
1599 resume_done:
1600         /* TODO */
1601         return 0;
1602 }
1603
1604 /* Finish extracting a file, directory, or symbolic link by setting file
1605  * security and timestamps.  */
1606 static int
1607 dentry_extract_final(struct wim_dentry *dentry, void *_ctx)
1608 {
1609         struct apply_ctx *ctx = _ctx;
1610         int ret;
1611         tchar path[ctx->ops->path_max];
1612
1613         if (!build_extraction_path(path, dentry, ctx))
1614                 return 0;
1615
1616         ret = extract_security(path, ctx, dentry);
1617         if (ret)
1618                 return ret;
1619
1620         if (ctx->ops->requires_final_set_attributes_pass) {
1621                 /* Set file attributes (if supported).  */
1622                 ret = extract_file_attributes(path, ctx, dentry, 1);
1623                 if (ret)
1624                         return ret;
1625         }
1626
1627         return extract_timestamps(path, ctx, dentry);
1628 }
1629
1630 /*
1631  * Extract a WIM dentry to standard output.
1632  *
1633  * This obviously doesn't make sense in all cases.  We return an error if the
1634  * dentry does not correspond to a regular file.  Otherwise we extract the
1635  * unnamed data stream only.
1636  */
1637 static int
1638 extract_dentry_to_stdout(struct wim_dentry *dentry)
1639 {
1640         int ret = 0;
1641         if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
1642                                              FILE_ATTRIBUTE_DIRECTORY))
1643         {
1644                 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
1645                       "extracted to standard output", dentry_full_path(dentry));
1646                 ret = WIMLIB_ERR_NOT_A_REGULAR_FILE;
1647         } else {
1648                 struct wim_lookup_table_entry *lte;
1649
1650                 lte = inode_unnamed_lte_resolved(dentry->d_inode);
1651                 if (lte) {
1652                         struct filedes _stdout;
1653                         filedes_init(&_stdout, STDOUT_FILENO);
1654                         ret = extract_stream_to_fd(lte, &_stdout, lte->size);
1655                 }
1656         }
1657         return ret;
1658 }
1659
1660 #ifdef __WIN32__
1661 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
1662 #else
1663 static const utf16lechar replacement_char = cpu_to_le16('?');
1664 #endif
1665
1666 static bool
1667 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
1668 {
1669         size_t i;
1670
1671         if (num_chars == 0)
1672                 return true;
1673         for (i = 0; i < num_chars; i++) {
1674                 switch (name[i]) {
1675         #ifdef __WIN32__
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                 case cpu_to_le16('>'):
1683                 case cpu_to_le16('|'):
1684         #endif
1685                 case cpu_to_le16('/'):
1686                 case cpu_to_le16('\0'):
1687                         if (fix)
1688                                 name[i] = replacement_char;
1689                         else
1690                                 return false;
1691                 }
1692         }
1693
1694 #ifdef __WIN32__
1695         if (name[num_chars - 1] == cpu_to_le16(' ') ||
1696             name[num_chars - 1] == cpu_to_le16('.'))
1697         {
1698                 if (fix)
1699                         name[num_chars - 1] = replacement_char;
1700                 else
1701                         return false;
1702         }
1703 #endif
1704         return true;
1705 }
1706
1707 static bool
1708 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1709 {
1710         const utf16lechar *file_name = dentry->file_name;
1711         return file_name != NULL &&
1712                 file_name[0] == cpu_to_le16('.') &&
1713                 (file_name[1] == cpu_to_le16('\0') ||
1714                  (file_name[1] == cpu_to_le16('.') &&
1715                   file_name[2] == cpu_to_le16('\0')));
1716 }
1717
1718 static int
1719 dentry_mark_skipped(struct wim_dentry *dentry, void *_ignore)
1720 {
1721         dentry->extraction_skipped = 1;
1722         return 0;
1723 }
1724
1725 /*
1726  * dentry_calculate_extraction_path-
1727  *
1728  * Calculate the actual filename component at which a WIM dentry will be
1729  * extracted, handling invalid filenames "properly".
1730  *
1731  * dentry->extraction_name usually will be set the same as dentry->file_name (on
1732  * UNIX, converted into the platform's multibyte encoding).  However, if the
1733  * file name contains characters that are not valid on the current platform or
1734  * has some other format that is not valid, leave dentry->extraction_name as
1735  * NULL and set dentry->extraction_skipped to indicate that this dentry should
1736  * not be extracted, unless the appropriate flag
1737  * WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES is set in the extract flags, in
1738  * which case a substitute filename will be created and set instead.
1739  *
1740  * Conflicts with case-insensitive names on Windows are handled similarly; see
1741  * below.
1742  */
1743 static int
1744 dentry_calculate_extraction_path(struct wim_dentry *dentry, void *_args)
1745 {
1746         struct apply_ctx *ctx = _args;
1747         int ret;
1748
1749         dentry->in_extraction_tree = 1;
1750
1751         if (dentry == ctx->extract_root || dentry->extraction_skipped)
1752                 return 0;
1753
1754         if (!dentry_is_supported(dentry, &ctx->supported_features))
1755                 goto skip_dentry;
1756
1757         if (dentry_is_dot_or_dotdot(dentry)) {
1758                 /* WIM files shouldn't contain . or .. entries.  But if they are
1759                  * there, don't attempt to extract them. */
1760                 WARNING("Skipping extraction of unexpected . or .. file "
1761                         "\"%"TS"\"", dentry_full_path(dentry));
1762                 goto skip_dentry;
1763         }
1764
1765 #ifdef __WIN32__
1766         if (!ctx->ops->supports_case_sensitive_filenames)
1767         {
1768                 struct wim_dentry *other;
1769                 list_for_each_entry(other, &dentry->case_insensitive_conflict_list,
1770                                     case_insensitive_conflict_list)
1771                 {
1772                         if (ctx->extract_flags &
1773                             WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
1774                                 WARNING("\"%"TS"\" has the same "
1775                                         "case-insensitive name as "
1776                                         "\"%"TS"\"; extracting "
1777                                         "dummy name instead",
1778                                         dentry_full_path(dentry),
1779                                         dentry_full_path(other));
1780                                 goto out_replace;
1781                         } else {
1782                                 WARNING("Not extracting \"%"TS"\": "
1783                                         "has same case-insensitive "
1784                                         "name as \"%"TS"\"",
1785                                         dentry_full_path(dentry),
1786                                         dentry_full_path(other));
1787                                 goto skip_dentry;
1788                         }
1789                 }
1790         }
1791 #else   /* __WIN32__ */
1792         wimlib_assert(ctx->ops->supports_case_sensitive_filenames);
1793 #endif  /* !__WIN32__ */
1794
1795         if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
1796 #ifdef __WIN32__
1797                 dentry->extraction_name = dentry->file_name;
1798                 dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
1799                 return 0;
1800 #else
1801                 return utf16le_to_tstr(dentry->file_name,
1802                                        dentry->file_name_nbytes,
1803                                        &dentry->extraction_name,
1804                                        &dentry->extraction_name_nchars);
1805 #endif
1806         } else {
1807                 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
1808                 {
1809                         WARNING("\"%"TS"\" has an invalid filename "
1810                                 "that is not supported on this platform; "
1811                                 "extracting dummy name instead",
1812                                 dentry_full_path(dentry));
1813                         goto out_replace;
1814                 } else {
1815                         WARNING("Not extracting \"%"TS"\": has an invalid filename "
1816                                 "that is not supported on this platform",
1817                                 dentry_full_path(dentry));
1818                         goto skip_dentry;
1819                 }
1820         }
1821
1822 out_replace:
1823         {
1824                 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
1825
1826                 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
1827                 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
1828
1829                 tchar *tchar_name;
1830                 size_t tchar_nchars;
1831         #ifdef __WIN32__
1832                 tchar_name = utf16_name_copy;
1833                 tchar_nchars = dentry->file_name_nbytes / 2;
1834         #else
1835                 ret = utf16le_to_tstr(utf16_name_copy,
1836                                       dentry->file_name_nbytes,
1837                                       &tchar_name, &tchar_nchars);
1838                 if (ret)
1839                         return ret;
1840         #endif
1841                 size_t fixed_name_num_chars = tchar_nchars;
1842                 tchar fixed_name[tchar_nchars + 50];
1843
1844                 tmemcpy(fixed_name, tchar_name, tchar_nchars);
1845                 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
1846                                                  T(" (invalid filename #%lu)"),
1847                                                  ++ctx->invalid_sequence);
1848         #ifndef __WIN32__
1849                 FREE(tchar_name);
1850         #endif
1851                 dentry->extraction_name = memdup(fixed_name,
1852                                                  2 * fixed_name_num_chars + 2);
1853                 if (!dentry->extraction_name)
1854                         return WIMLIB_ERR_NOMEM;
1855                 dentry->extraction_name_nchars = fixed_name_num_chars;
1856         }
1857         return 0;
1858
1859 skip_dentry:
1860         for_dentry_in_tree(dentry, dentry_mark_skipped, NULL);
1861         return 0;
1862 }
1863
1864 /* Clean up dentry and inode structure after extraction.  */
1865 static int
1866 dentry_reset_needs_extraction(struct wim_dentry *dentry, void *_ignore)
1867 {
1868         struct wim_inode *inode = dentry->d_inode;
1869
1870         dentry->in_extraction_tree = 0;
1871         dentry->extraction_skipped = 0;
1872         dentry->was_hardlinked = 0;
1873         dentry->skeleton_extracted = 0;
1874         inode->i_visited = 0;
1875         FREE(inode->i_extracted_file);
1876         inode->i_extracted_file = NULL;
1877         inode->i_dos_name_extracted = 0;
1878         if ((void*)dentry->extraction_name != (void*)dentry->file_name)
1879                 FREE(dentry->extraction_name);
1880         dentry->extraction_name = NULL;
1881         return 0;
1882 }
1883
1884 /* Tally features necessary to extract a dentry and the corresponding inode.  */
1885 static int
1886 dentry_tally_features(struct wim_dentry *dentry, void *_features)
1887 {
1888         struct wim_features *features = _features;
1889         struct wim_inode *inode = dentry->d_inode;
1890
1891         if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
1892                 features->archive_files++;
1893         if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
1894                 features->hidden_files++;
1895         if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
1896                 features->system_files++;
1897         if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
1898                 features->compressed_files++;
1899         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
1900                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1901                         features->encrypted_directories++;
1902                 else
1903                         features->encrypted_files++;
1904         }
1905         if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
1906                 features->not_context_indexed_files++;
1907         if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
1908                 features->sparse_files++;
1909         if (inode_has_named_stream(inode))
1910                 features->named_data_streams++;
1911         if (inode->i_visited)
1912                 features->hard_links++;
1913         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1914                 features->reparse_points++;
1915                 if (inode_is_symlink(inode))
1916                         features->symlink_reparse_points++;
1917                 else
1918                         features->other_reparse_points++;
1919         }
1920         if (inode->i_security_id != -1)
1921                 features->security_descriptors++;
1922         if (dentry->short_name_nbytes)
1923                 features->short_names++;
1924         if (inode_has_unix_data(inode))
1925                 features->unix_data++;
1926         inode->i_visited = 1;
1927         return 0;
1928 }
1929
1930 /* Tally the features necessary to extract a dentry tree.  */
1931 static void
1932 dentry_tree_get_features(struct wim_dentry *root, struct wim_features *features)
1933 {
1934         memset(features, 0, sizeof(struct wim_features));
1935         for_dentry_in_tree(root, dentry_tally_features, features);
1936         dentry_tree_clear_inode_visited(root);
1937 }
1938
1939 static u32
1940 compute_supported_attributes_mask(const struct wim_features *supported_features)
1941 {
1942         u32 mask = ~(u32)0;
1943
1944         if (!supported_features->archive_files)
1945                 mask &= ~FILE_ATTRIBUTE_ARCHIVE;
1946
1947         if (!supported_features->hidden_files)
1948                 mask &= ~FILE_ATTRIBUTE_HIDDEN;
1949
1950         if (!supported_features->system_files)
1951                 mask &= ~FILE_ATTRIBUTE_SYSTEM;
1952
1953         if (!supported_features->not_context_indexed_files)
1954                 mask &= ~FILE_ATTRIBUTE_NOT_CONTENT_INDEXED;
1955
1956         if (!supported_features->compressed_files)
1957                 mask &= ~FILE_ATTRIBUTE_COMPRESSED;
1958
1959         if (!supported_features->sparse_files)
1960                 mask &= ~FILE_ATTRIBUTE_SPARSE_FILE;
1961
1962         if (!supported_features->reparse_points)
1963                 mask &= ~FILE_ATTRIBUTE_REPARSE_POINT;
1964
1965         return mask;
1966 }
1967
1968 static int
1969 do_feature_check(const struct wim_features *required_features,
1970                  const struct wim_features *supported_features,
1971                  int extract_flags,
1972                  const struct apply_operations *ops,
1973                  const tchar *wim_source_path)
1974 {
1975         const tchar *loc;
1976         const tchar *mode = T("this extraction mode");
1977
1978         if (wim_source_path[0] == '\0')
1979                 loc = T("the WIM image");
1980         else
1981                 loc = wim_source_path;
1982
1983         /* We're an archive program, so theoretically we can do what we want
1984          * with FILE_ATTRIBUTE_ARCHIVE (which is a dumb flag anyway).  Don't
1985          * bother the user about it.  */
1986 #if 0
1987         if (required_features->archive_files && !supported_features->archive_files)
1988         {
1989                 WARNING(
1990           "%lu files in %"TS" are marked as archived, but this attribute\n"
1991 "          is not supported in %"TS".",
1992                         required_features->archive_files, loc, mode);
1993         }
1994 #endif
1995
1996         if (required_features->hidden_files && !supported_features->hidden_files)
1997         {
1998                 WARNING(
1999           "%lu files in %"TS" are marked as hidden, but this\n"
2000 "          attribute is not supported in %"TS".",
2001                         required_features->hidden_files, loc, mode);
2002         }
2003
2004         if (required_features->system_files && !supported_features->system_files)
2005         {
2006                 WARNING(
2007           "%lu files in %"TS" are marked as system files,\n"
2008 "          but this attribute is not supported in %"TS".",
2009                         required_features->system_files, loc, mode);
2010         }
2011
2012         if (required_features->compressed_files && !supported_features->compressed_files)
2013         {
2014                 WARNING(
2015           "%lu files in %"TS" are marked as being transparently\n"
2016 "          compressed, but transparent compression is not supported in\n"
2017 "          %"TS".  These files will be extracted as uncompressed.",
2018                         required_features->compressed_files, loc, mode);
2019         }
2020
2021         if (required_features->encrypted_files && !supported_features->encrypted_files)
2022         {
2023                 WARNING(
2024           "%lu files in %"TS" are marked as being encrypted,\n"
2025 "           but encryption is not supported in %"TS".  These files\n"
2026 "           will not be extracted.",
2027                         required_features->encrypted_files, loc, mode);
2028         }
2029
2030         if (required_features->encrypted_directories &&
2031             !supported_features->encrypted_directories)
2032         {
2033                 WARNING(
2034           "%lu directories in %"TS" are marked as being encrypted,\n"
2035 "           but encryption is not supported in %"TS".\n"
2036 "           These directories will be extracted as unencrypted.",
2037                         required_features->encrypted_directories, loc, mode);
2038         }
2039
2040         if (required_features->not_context_indexed_files &&
2041             !supported_features->not_context_indexed_files)
2042         {
2043                 WARNING(
2044           "%lu files in %"TS" are marked as not content indexed,\n"
2045 "          but this attribute is not supported in %"TS".",
2046                         required_features->not_context_indexed_files, loc, mode);
2047         }
2048
2049         if (required_features->sparse_files && !supported_features->sparse_files)
2050         {
2051                 WARNING(
2052           "%lu files in %"TS" are marked as sparse, but creating\n"
2053 "           sparse files is not supported in %"TS".  These files\n"
2054 "           will be extracted as non-sparse.",
2055                         required_features->sparse_files, loc, mode);
2056         }
2057
2058         if (required_features->named_data_streams &&
2059             !supported_features->named_data_streams)
2060         {
2061                 WARNING(
2062           "%lu files in %"TS" contain one or more alternate (named)\n"
2063 "          data streams, which are not supported in %"TS".\n"
2064 "          Alternate data streams will NOT be extracted.",
2065                         required_features->named_data_streams, loc, mode);
2066         }
2067
2068         if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
2069                                       WIMLIB_EXTRACT_FLAG_SYMLINK)) &&
2070             required_features->named_data_streams &&
2071             supported_features->named_data_streams)
2072         {
2073                 WARNING(
2074           "%lu files in %"TS" contain one or more alternate (named)\n"
2075 "          data streams, which are not supported in linked extraction mode.\n"
2076 "          Alternate data streams will NOT be extracted.",
2077                         required_features->named_data_streams, loc);
2078         }
2079
2080         if (required_features->hard_links && !supported_features->hard_links)
2081         {
2082                 WARNING(
2083           "%lu files in %"TS" are hard links, but hard links are\n"
2084 "          not supported in %"TS".  Hard links will be extracted as\n"
2085 "          duplicate copies of the linked files.",
2086                         required_features->hard_links, loc, mode);
2087         }
2088
2089         if (required_features->reparse_points && !supported_features->reparse_points)
2090         {
2091                 if (supported_features->symlink_reparse_points) {
2092                         if (required_features->other_reparse_points) {
2093                                 WARNING(
2094           "%lu files in %"TS" are reparse points that are neither\n"
2095 "          symbolic links nor junction points and are not supported in\n"
2096 "          %"TS".  These reparse points will not be extracted.",
2097                                         required_features->other_reparse_points, loc,
2098                                         mode);
2099                         }
2100                 } else {
2101                         WARNING(
2102           "%lu files in %"TS" are reparse points, which are\n"
2103 "          not supported in %"TS" and will not be extracted.",
2104                                 required_features->reparse_points, loc, mode);
2105                 }
2106         }
2107
2108         if (required_features->security_descriptors &&
2109             !supported_features->security_descriptors)
2110         {
2111                 WARNING(
2112           "%lu files in %"TS" have Windows NT security descriptors,\n"
2113 "          but extracting security descriptors is not supported in\n"
2114 "          %"TS".  No security descriptors will be extracted.",
2115                         required_features->security_descriptors, loc, mode);
2116         }
2117
2118         if (required_features->short_names && !supported_features->short_names)
2119         {
2120                 WARNING(
2121           "%lu files in %"TS" have short (DOS) names, but\n"
2122 "          extracting short names is not supported in %"TS".\n"
2123 "          Short names will not be extracted.\n",
2124                         required_features->short_names, loc, mode);
2125         }
2126
2127         if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
2128             required_features->unix_data && !supported_features->unix_data)
2129         {
2130                 ERROR("Extracting UNIX data is not supported in %"TS, mode);
2131                 return WIMLIB_ERR_UNSUPPORTED;
2132         }
2133         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) &&
2134             required_features->short_names && !supported_features->short_names)
2135         {
2136                 ERROR("Extracting short names is not supported in %"TS"", mode);
2137                 return WIMLIB_ERR_UNSUPPORTED;
2138         }
2139         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
2140             !ops->set_timestamps)
2141         {
2142                 ERROR("Extracting timestamps is not supported in %"TS"", mode);
2143                 return WIMLIB_ERR_UNSUPPORTED;
2144         }
2145         if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
2146                                WIMLIB_EXTRACT_FLAG_UNIX_DATA))
2147              == WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
2148             required_features->security_descriptors &&
2149             !supported_features->security_descriptors)
2150         {
2151                 ERROR("Extracting security descriptors is not supported in %"TS, mode);
2152                 return WIMLIB_ERR_UNSUPPORTED;
2153         }
2154
2155         if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
2156             !supported_features->hard_links)
2157         {
2158                 ERROR("Hard link extraction mode requested, but "
2159                       "%"TS" does not support hard links!", mode);
2160                 return WIMLIB_ERR_UNSUPPORTED;
2161         }
2162
2163         if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
2164             required_features->symlink_reparse_points &&
2165             !(supported_features->symlink_reparse_points ||
2166               supported_features->reparse_points))
2167         {
2168                 ERROR("Extracting symbolic links is not supported in %"TS, mode);
2169                 return WIMLIB_ERR_UNSUPPORTED;
2170         }
2171
2172         if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
2173             !supported_features->symlink_reparse_points)
2174         {
2175                 ERROR("Symbolic link extraction mode requested, but "
2176                       "%"TS" does not support symbolic "
2177                       "links!", mode);
2178                 return WIMLIB_ERR_UNSUPPORTED;
2179         }
2180         return 0;
2181 }
2182
2183 static void
2184 do_extract_warnings(struct apply_ctx *ctx)
2185 {
2186         if (ctx->partial_security_descriptors == 0 &&
2187             ctx->no_security_descriptors == 0)
2188                 return;
2189
2190         WARNING("Extraction to \"%"TS"\" complete, but with one or more warnings:",
2191                 ctx->target);
2192         if (ctx->partial_security_descriptors != 0) {
2193                 WARNING("- Could only partially set the security descriptor\n"
2194                         "            on %lu files or directories.",
2195                         ctx->partial_security_descriptors);
2196         }
2197         if (ctx->no_security_descriptors != 0) {
2198                 WARNING("- Could not set security descriptor at all\n"
2199                         "            on %lu files or directories.",
2200                         ctx->no_security_descriptors);
2201         }
2202 #ifdef __WIN32__
2203         WARNING("To fully restore all security descriptors, run the program\n"
2204                 "          with Administrator rights.");
2205 #endif
2206 }
2207
2208 /*
2209  * extract_tree - Extract a file or directory tree from the currently selected
2210  *                WIM image.
2211  *
2212  * @wim:        WIMStruct for the WIM file, with the desired image selected
2213  *              (as wim->current_image).
2214  *
2215  * @wim_source_path:
2216  *              "Canonical" (i.e. no leading or trailing slashes, path
2217  *              separators WIM_PATH_SEPARATOR) path inside the WIM image to
2218  *              extract.  An empty string means the full image.
2219  *
2220  * @target:
2221  *              Filesystem path to extract the file or directory tree to.
2222  *              (Or, with WIMLIB_EXTRACT_FLAG_NTFS: the name of a NTFS volume.)
2223  *
2224  * @extract_flags:
2225  *              WIMLIB_EXTRACT_FLAG_*.  Also, the private flag
2226  *              WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being
2227  *              called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as
2228  *              the image.
2229  *
2230  * @progress_func:
2231  *              If non-NULL, progress function for the extraction.  The messages
2232  *              that may be sent in this function are:
2233  *
2234  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or
2235  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
2236  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN;
2237  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END;
2238  *              WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY;
2239  *              WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS;
2240  *              WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS;
2241  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or
2242  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2243  *
2244  * Returns 0 on success; a positive WIMLIB_ERR_* code on failure.
2245  */
2246 static int
2247 extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target,
2248              int extract_flags, wimlib_progress_func_t progress_func)
2249 {
2250         struct wim_dentry *root;
2251         struct wim_features required_features;
2252         struct apply_ctx ctx;
2253         int ret;
2254         struct wim_lookup_table_entry *lte;
2255
2256         /* Start initializing the apply_ctx.  */
2257         memset(&ctx, 0, sizeof(struct apply_ctx));
2258         ctx.wim = wim;
2259         ctx.extract_flags = extract_flags;
2260         ctx.target = target;
2261         ctx.target_nchars = tstrlen(target);
2262         ctx.progress_func = progress_func;
2263         if (progress_func) {
2264                 ctx.progress.extract.wimfile_name = wim->filename;
2265                 ctx.progress.extract.image = wim->current_image;
2266                 ctx.progress.extract.extract_flags = (extract_flags &
2267                                                       WIMLIB_EXTRACT_MASK_PUBLIC);
2268                 ctx.progress.extract.image_name = wimlib_get_image_name(wim,
2269                                                                         wim->current_image);
2270                 ctx.progress.extract.extract_root_wim_source_path = wim_source_path;
2271                 ctx.progress.extract.target = target;
2272         }
2273         INIT_LIST_HEAD(&ctx.stream_list);
2274
2275         /* Translate the path to extract into the corresponding
2276          * `struct wim_dentry', which will be the root of the
2277          * "dentry tree" to extract.  */
2278         root = get_dentry(wim, wim_source_path);
2279         if (!root) {
2280                 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
2281                       wim_source_path, wim->current_image);
2282                 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
2283                 goto out;
2284         }
2285
2286         ctx.extract_root = root;
2287
2288         /* Select the appropriate apply_operations based on the
2289          * platform and extract_flags.  */
2290 #ifdef __WIN32__
2291         ctx.ops = &win32_apply_ops;
2292 #else
2293         ctx.ops = &unix_apply_ops;
2294 #endif
2295
2296 #ifdef WITH_NTFS_3G
2297         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
2298                 ctx.ops = &ntfs_3g_apply_ops;
2299 #endif
2300
2301         /* Call the start_extract() callback.  This gives the apply_operations
2302          * implementation a chance to do any setup needed to access the volume.
2303          * Furthermore, it's expected to set the supported features of this
2304          * extraction mode (ctx.supported_features), which are determined at
2305          * runtime as they may vary depending on the actual volume.  These
2306          * features are then compared with the actual features extracting this
2307          * dentry tree requires.  Some mismatches will merely produce warnings
2308          * and the unsupported data will be ignored; others will produce errors.
2309          */
2310         ret = ctx.ops->start_extract(target, &ctx);
2311         if (ret)
2312                 goto out;
2313
2314         dentry_tree_get_features(root, &required_features);
2315         ret = do_feature_check(&required_features, &ctx.supported_features,
2316                                extract_flags, ctx.ops, wim_source_path);
2317         if (ret)
2318                 goto out_finish_or_abort_extract;
2319
2320         ctx.supported_attributes_mask =
2321                 compute_supported_attributes_mask(&ctx.supported_features);
2322
2323         /* Figure out whether the root dentry is being extracted to the root of
2324          * a volume and therefore needs to be treated "specially", for example
2325          * not being explicitly created and not having attributes set.  */
2326         if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
2327                 ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
2328
2329         /* Calculate the actual filename component of each extracted dentry.  In
2330          * the process, set the dentry->extraction_skipped flag on dentries that
2331          * are being skipped for some reason (e.g. invalid filename).  */
2332         ret = for_dentry_in_tree(root, dentry_calculate_extraction_path, &ctx);
2333         if (ret)
2334                 goto out_dentry_reset_needs_extraction;
2335
2336         /* Build the list of the streams that need to be extracted and
2337          * initialize ctx.progress.extract with stream information.  */
2338         ret = for_dentry_in_tree(ctx.extract_root,
2339                                  dentry_resolve_and_zero_lte_refcnt, &ctx);
2340         if (ret)
2341                 goto out_dentry_reset_needs_extraction;
2342
2343         ret = for_dentry_in_tree(ctx.extract_root,
2344                                  dentry_add_streams_to_extract, &ctx);
2345         if (ret)
2346                 goto out_teardown_stream_list;
2347
2348         if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2349                 /* When extracting from a pipe, the number of bytes of data to
2350                  * extract can't be determined in the normal way (examining the
2351                  * lookup table), since at this point all we have is a set of
2352                  * SHA1 message digests of streams that need to be extracted.
2353                  * However, we can get a reasonably accurate estimate by taking
2354                  * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
2355                  * data.  This does assume that a full image is being extracted,
2356                  * but currently there is no API for doing otherwise.  (Also,
2357                  * subtract <HARDLINKBYTES> from this if hard links are
2358                  * supported by the extraction mode.)  */
2359                 ctx.progress.extract.total_bytes =
2360                         wim_info_get_image_total_bytes(wim->wim_info,
2361                                                        wim->current_image);
2362                 if (ctx.supported_features.hard_links) {
2363                         ctx.progress.extract.total_bytes -=
2364                                 wim_info_get_image_hard_link_bytes(wim->wim_info,
2365                                                                    wim->current_image);
2366                 }
2367         }
2368
2369         /* Handle the special case of extracting a file to standard
2370          * output.  In that case, "root" should be a single file, not a
2371          * directory tree.  (If not, extract_dentry_to_stdout() will
2372          * return an error.)  */
2373         if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
2374                 ret = extract_dentry_to_stdout(root);
2375                 goto out_teardown_stream_list;
2376         }
2377
2378         if (ctx.ops->realpath_works_on_nonexisting_files &&
2379             ((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
2380              ctx.ops->requires_realtarget_in_paths))
2381         {
2382                 ctx.realtarget = realpath(target, NULL);
2383                 if (!ctx.realtarget) {
2384                         ret = WIMLIB_ERR_NOMEM;
2385                         goto out_teardown_stream_list;
2386                 }
2387                 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2388         }
2389
2390         if (progress_func) {
2391                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN :
2392                                                  WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
2393                               &ctx.progress);
2394         }
2395
2396         if (!ctx.root_dentry_is_special)
2397         {
2398                 tchar path[ctx.ops->path_max];
2399                 if (build_extraction_path(path, root, &ctx))
2400                 {
2401                         ret = extract_inode(path, &ctx, root->d_inode);
2402                         if (ret)
2403                                 goto out_free_realtarget;
2404                 }
2405         }
2406
2407         /* If we need to fix up the targets of absolute symbolic links
2408          * (WIMLIB_EXTRACT_FLAG_RPFIX) or the extraction mode requires paths to
2409          * be absolute, use realpath() (or its replacement on Windows) to get
2410          * the absolute path to the extraction target.  Note that this requires
2411          * the target directory to exist, unless
2412          * realpath_works_on_nonexisting_files is set in the apply_operations.
2413          * */
2414         if (!ctx.realtarget &&
2415             (((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
2416               required_features.symlink_reparse_points) ||
2417              ctx.ops->requires_realtarget_in_paths))
2418         {
2419                 ctx.realtarget = realpath(target, NULL);
2420                 if (!ctx.realtarget) {
2421                         ret = WIMLIB_ERR_NOMEM;
2422                         goto out_free_realtarget;
2423                 }
2424                 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2425         }
2426
2427         if (ctx.ops->requires_short_name_reordering) {
2428                 ret = for_dentry_in_tree(root, dentry_extract_dir_skeleton,
2429                                          &ctx);
2430                 if (ret)
2431                         goto out_free_realtarget;
2432         }
2433
2434         /* Finally, the important part: extract the tree of files.  */
2435         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SEQUENTIAL |
2436                              WIMLIB_EXTRACT_FLAG_FROM_PIPE)) {
2437                 /* Sequential extraction requested, so two passes are needed
2438                  * (one for directory structure, one for streams.)  */
2439                 if (progress_func)
2440                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2441                                       &ctx.progress);
2442
2443                 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
2444                         ret = for_dentry_in_tree(root, dentry_extract_skeleton, &ctx);
2445                         if (ret)
2446                                 goto out_free_realtarget;
2447                 }
2448                 if (progress_func)
2449                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2450                                       &ctx.progress);
2451                 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
2452                         ret = extract_streams_from_pipe(&ctx);
2453                 else
2454                         ret = extract_stream_list(&ctx);
2455                 if (ret)
2456                         goto out_free_realtarget;
2457         } else {
2458                 /* Sequential extraction was not requested, so we can make do
2459                  * with one pass where we both create the files and extract
2460                  * streams.   */
2461                 if (progress_func)
2462                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2463                                       &ctx.progress);
2464                 ret = for_dentry_in_tree(root, dentry_extract, &ctx);
2465                 if (ret)
2466                         goto out_free_realtarget;
2467                 if (progress_func)
2468                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2469                                       &ctx.progress);
2470         }
2471
2472         /* If the total number of bytes to extract was miscalculated, just jump
2473          * to the calculated number in order to avoid confusing the progress
2474          * function.  This should only occur when extracting from a pipe.  */
2475         if (ctx.progress.extract.completed_bytes != ctx.progress.extract.total_bytes)
2476         {
2477                 DEBUG("Calculated %"PRIu64" bytes to extract, but actually "
2478                       "extracted %"PRIu64,
2479                       ctx.progress.extract.total_bytes,
2480                       ctx.progress.extract.completed_bytes);
2481         }
2482         if (progress_func &&
2483             ctx.progress.extract.completed_bytes < ctx.progress.extract.total_bytes)
2484         {
2485                 ctx.progress.extract.completed_bytes = ctx.progress.extract.total_bytes;
2486                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &ctx.progress);
2487         }
2488
2489         /* Apply security descriptors and timestamps.  This is done at the end,
2490          * and in a depth-first manner, to prevent timestamps from getting
2491          * changed by subsequent extract operations and to minimize the chance
2492          * of the restored security descriptors getting in our way.  */
2493         if (progress_func)
2494                 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
2495                               &ctx.progress);
2496         ret = for_dentry_in_tree_depth(root, dentry_extract_final, &ctx);
2497         if (ret)
2498                 goto out_free_realtarget;
2499
2500         if (progress_func) {
2501                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END :
2502                               WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
2503                               &ctx.progress);
2504         }
2505
2506         do_extract_warnings(&ctx);
2507
2508         ret = 0;
2509 out_free_realtarget:
2510         FREE(ctx.realtarget);
2511 out_teardown_stream_list:
2512         /* Free memory allocated as part of the mapping from each
2513          * wim_lookup_table_entry to the dentries that reference it.  */
2514         if (ctx.extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL)
2515                 list_for_each_entry(lte, &ctx.stream_list, extraction_list)
2516                         if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
2517                                 FREE(lte->lte_dentries);
2518 out_dentry_reset_needs_extraction:
2519         for_dentry_in_tree(root, dentry_reset_needs_extraction, NULL);
2520 out_finish_or_abort_extract:
2521         if (ret) {
2522                 if (ctx.ops->abort_extract)
2523                         ctx.ops->abort_extract(&ctx);
2524         } else {
2525                 if (ctx.ops->finish_extract)
2526                         ret = ctx.ops->finish_extract(&ctx);
2527         }
2528 out:
2529         return ret;
2530 }
2531
2532 /* Validates a single wimlib_extract_command, mostly checking to make sure the
2533  * extract flags make sense. */
2534 static int
2535 check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
2536 {
2537         int extract_flags;
2538
2539         /* Empty destination path? */
2540         if (cmd->fs_dest_path[0] == T('\0'))
2541                 return WIMLIB_ERR_INVALID_PARAM;
2542
2543         extract_flags = cmd->extract_flags;
2544
2545         /* Check for invalid flag combinations  */
2546         if ((extract_flags &
2547              (WIMLIB_EXTRACT_FLAG_SYMLINK |
2548               WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
2549                                                  WIMLIB_EXTRACT_FLAG_HARDLINK))
2550                 return WIMLIB_ERR_INVALID_PARAM;
2551
2552         if ((extract_flags &
2553              (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2554               WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2555                                                     WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2556                 return WIMLIB_ERR_INVALID_PARAM;
2557
2558         if ((extract_flags &
2559              (WIMLIB_EXTRACT_FLAG_RPFIX |
2560               WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
2561                                                 WIMLIB_EXTRACT_FLAG_NORPFIX))
2562                 return WIMLIB_ERR_INVALID_PARAM;
2563
2564         if ((extract_flags &
2565              (WIMLIB_EXTRACT_FLAG_RESUME |
2566               WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
2567                 return WIMLIB_ERR_INVALID_PARAM;
2568
2569         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2570 #ifndef WITH_NTFS_3G
2571                 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
2572                       "        we cannot apply a WIM image directly to a NTFS volume.");
2573                 return WIMLIB_ERR_UNSUPPORTED;
2574 #endif
2575         }
2576
2577         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
2578                               WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0)
2579         {
2580                 /* Do reparse point fixups by default if the WIM header says
2581                  * they are enabled and we are extracting a full image. */
2582                 if (wim_header_flags & WIM_HDR_FLAG_RP_FIX)
2583                         extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
2584         }
2585
2586         /* TODO: Since UNIX data entries are stored in the file resources, in a
2587          * completely sequential extraction they may come up before the
2588          * corresponding file or symbolic link data.  This needs to be handled
2589          * better.  */
2590         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2591                               WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2592                                     == (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2593                                         WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2594         {
2595                 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2596                         WARNING("Setting UNIX file/owner group may "
2597                                 "be impossible on some\n"
2598                                 "          symbolic links "
2599                                 "when applying from a pipe.");
2600                 } else {
2601                         extract_flags &= ~WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2602                         WARNING("Disabling sequential extraction for "
2603                                 "UNIX data mode");
2604                 }
2605         }
2606
2607         cmd->extract_flags = extract_flags;
2608         return 0;
2609 }
2610
2611
2612 /* Internal function to execute extraction commands for a WIM image.  The paths
2613  * in the extract commands are expected to be already "canonicalized".  */
2614 static int
2615 do_wimlib_extract_files(WIMStruct *wim,
2616                         int image,
2617                         struct wimlib_extract_command *cmds,
2618                         size_t num_cmds,
2619                         wimlib_progress_func_t progress_func)
2620 {
2621         int ret;
2622         bool found_link_cmd = false;
2623         bool found_nolink_cmd = false;
2624
2625         /* Select the image from which we are extracting files */
2626         ret = select_wim_image(wim, image);
2627         if (ret)
2628                 return ret;
2629
2630         /* Make sure there are no streams in the WIM that have not been
2631          * checksummed yet.  */
2632         ret = wim_checksum_unhashed_streams(wim);
2633         if (ret)
2634                 return ret;
2635
2636         /* Check for problems with the extraction commands */
2637         for (size_t i = 0; i < num_cmds; i++) {
2638                 ret = check_extract_command(&cmds[i], wim->hdr.flags);
2639                 if (ret)
2640                         return ret;
2641                 if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2642                                              WIMLIB_EXTRACT_FLAG_HARDLINK)) {
2643                         found_link_cmd = true;
2644                 } else {
2645                         found_nolink_cmd = true;
2646                 }
2647                 if (found_link_cmd && found_nolink_cmd) {
2648                         ERROR("Symlink or hardlink extraction mode must "
2649                               "be set on all extraction commands");
2650                         return WIMLIB_ERR_INVALID_PARAM;
2651                 }
2652         }
2653
2654         /* Execute the extraction commands */
2655         for (size_t i = 0; i < num_cmds; i++) {
2656                 ret = extract_tree(wim,
2657                                    cmds[i].wim_source_path,
2658                                    cmds[i].fs_dest_path,
2659                                    cmds[i].extract_flags,
2660                                    progress_func);
2661                 if (ret)
2662                         return ret;
2663         }
2664         return 0;
2665 }
2666
2667 /* API function documented in wimlib.h  */
2668 WIMLIBAPI int
2669 wimlib_extract_files(WIMStruct *wim,
2670                      int image,
2671                      const struct wimlib_extract_command *cmds,
2672                      size_t num_cmds,
2673                      int default_extract_flags,
2674                      wimlib_progress_func_t progress_func)
2675 {
2676         int ret;
2677         struct wimlib_extract_command *cmds_copy;
2678         int all_flags = 0;
2679
2680         default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2681
2682         if (num_cmds == 0)
2683                 return 0;
2684
2685         cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
2686         if (!cmds_copy)
2687                 return WIMLIB_ERR_NOMEM;
2688
2689         for (size_t i = 0; i < num_cmds; i++) {
2690                 cmds_copy[i].extract_flags = (default_extract_flags |
2691                                                  cmds[i].extract_flags)
2692                                                 & WIMLIB_EXTRACT_MASK_PUBLIC;
2693                 all_flags |= cmds_copy[i].extract_flags;
2694
2695                 cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path);
2696                 if (!cmds_copy[i].wim_source_path) {
2697                         ret = WIMLIB_ERR_NOMEM;
2698                         goto out_free_cmds_copy;
2699                 }
2700
2701                 cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path);
2702                 if (!cmds_copy[i].fs_dest_path) {
2703                         ret = WIMLIB_ERR_NOMEM;
2704                         goto out_free_cmds_copy;
2705                 }
2706
2707         }
2708         ret = do_wimlib_extract_files(wim, image,
2709                                       cmds_copy, num_cmds,
2710                                       progress_func);
2711
2712         if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2713                          WIMLIB_EXTRACT_FLAG_HARDLINK))
2714         {
2715                 for_lookup_table_entry(wim->lookup_table,
2716                                        lte_free_extracted_file, NULL);
2717         }
2718 out_free_cmds_copy:
2719         for (size_t i = 0; i < num_cmds; i++) {
2720                 FREE(cmds_copy[i].wim_source_path);
2721                 FREE(cmds_copy[i].fs_dest_path);
2722         }
2723         FREE(cmds_copy);
2724         return ret;
2725 }
2726
2727 /*
2728  * Extracts an image from a WIM file.
2729  *
2730  * @wim:                WIMStruct for the WIM file.
2731  *
2732  * @image:              Number of the single image to extract.
2733  *
2734  * @target:             Directory or NTFS volume to extract the image to.
2735  *
2736  * @extract_flags:      Bitwise or of WIMLIB_EXTRACT_FLAG_*.
2737  *
2738  * @progress_func:      If non-NULL, a progress function to be called
2739  *                      periodically.
2740  *
2741  * Returns 0 on success; nonzero on failure.
2742  */
2743 static int
2744 extract_single_image(WIMStruct *wim, int image,
2745                      const tchar *target, int extract_flags,
2746                      wimlib_progress_func_t progress_func)
2747 {
2748         int ret;
2749         tchar *target_copy = canonicalize_fs_path(target);
2750         if (target_copy == NULL)
2751                 return WIMLIB_ERR_NOMEM;
2752         struct wimlib_extract_command cmd = {
2753                 .wim_source_path = T(""),
2754                 .fs_dest_path = target_copy,
2755                 .extract_flags = extract_flags,
2756         };
2757         ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func);
2758         FREE(target_copy);
2759         return ret;
2760 }
2761
2762 static const tchar * const filename_forbidden_chars =
2763 T(
2764 #ifdef __WIN32__
2765 "<>:\"/\\|?*"
2766 #else
2767 "/"
2768 #endif
2769 );
2770
2771 /* This function checks if it is okay to use a WIM image's name as a directory
2772  * name.  */
2773 static bool
2774 image_name_ok_as_dir(const tchar *image_name)
2775 {
2776         return image_name && *image_name &&
2777                 !tstrpbrk(image_name, filename_forbidden_chars) &&
2778                 tstrcmp(image_name, T(".")) &&
2779                 tstrcmp(image_name, T(".."));
2780 }
2781
2782 /* Extracts all images from the WIM to the directory @target, with the images
2783  * placed in subdirectories named by their image names. */
2784 static int
2785 extract_all_images(WIMStruct *wim,
2786                    const tchar *target,
2787                    int extract_flags,
2788                    wimlib_progress_func_t progress_func)
2789 {
2790         size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
2791         size_t output_path_len = tstrlen(target);
2792         tchar buf[output_path_len + 1 + image_name_max_len + 1];
2793         int ret;
2794         int image;
2795         const tchar *image_name;
2796         struct stat stbuf;
2797
2798         extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
2799
2800         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2801                 ERROR("Cannot extract multiple images in NTFS extraction mode.");
2802                 return WIMLIB_ERR_INVALID_PARAM;
2803         }
2804
2805         if (tstat(target, &stbuf)) {
2806                 if (errno == ENOENT) {
2807                         if (tmkdir(target, 0755)) {
2808                                 ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
2809                                 return WIMLIB_ERR_MKDIR;
2810                         }
2811                 } else {
2812                         ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
2813                         return WIMLIB_ERR_STAT;
2814                 }
2815         } else if (!S_ISDIR(stbuf.st_mode)) {
2816                 ERROR("\"%"TS"\" is not a directory", target);
2817                 return WIMLIB_ERR_NOTDIR;
2818         }
2819
2820         tmemcpy(buf, target, output_path_len);
2821         buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
2822         for (image = 1; image <= wim->hdr.image_count; image++) {
2823                 image_name = wimlib_get_image_name(wim, image);
2824                 if (image_name_ok_as_dir(image_name)) {
2825                         tstrcpy(buf + output_path_len + 1, image_name);
2826                 } else {
2827                         /* Image name is empty or contains forbidden characters.
2828                          * Use image number instead. */
2829                         tsprintf(buf + output_path_len + 1, T("%d"), image);
2830                 }
2831                 ret = extract_single_image(wim, image, buf, extract_flags,
2832                                            progress_func);
2833                 if (ret)
2834                         return ret;
2835         }
2836         return 0;
2837 }
2838
2839 static int
2840 do_wimlib_extract_image(WIMStruct *wim,
2841                         int image,
2842                         const tchar *target,
2843                         int extract_flags,
2844                         wimlib_progress_func_t progress_func)
2845 {
2846         int ret;
2847
2848         if (image == WIMLIB_ALL_IMAGES) {
2849                 ret = extract_all_images(wim, target, extract_flags,
2850                                          progress_func);
2851         } else {
2852                 ret = extract_single_image(wim, image, target, extract_flags,
2853                                            progress_func);
2854         }
2855
2856         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2857                              WIMLIB_EXTRACT_FLAG_HARDLINK))
2858         {
2859                 for_lookup_table_entry(wim->lookup_table,
2860                                        lte_free_extracted_file,
2861                                        NULL);
2862         }
2863         return ret;
2864 }
2865
2866 /* API function documented in wimlib.h  */
2867 WIMLIBAPI int
2868 wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
2869                                const tchar *target, int extract_flags,
2870                                wimlib_progress_func_t progress_func)
2871 {
2872         int ret;
2873         WIMStruct *pwm;
2874         struct filedes *in_fd;
2875         int image;
2876         unsigned i;
2877
2878         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2879
2880         if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
2881                 return WIMLIB_ERR_INVALID_PARAM;
2882
2883         extract_flags |= WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2884
2885         /* Read the WIM header from the pipe and get a WIMStruct to represent
2886          * the pipable WIM.  Caveats:  Unlike getting a WIMStruct with
2887          * wimlib_open_wim(), getting a WIMStruct in this way will result in
2888          * an empty lookup table, no XML data read, and no filename set.  */
2889         ret = open_wim_as_WIMStruct(&pipe_fd,
2890                                     WIMLIB_OPEN_FLAG_FROM_PIPE,
2891                                     &pwm, progress_func);
2892         if (ret)
2893                 return ret;
2894
2895         /* Sanity check to make sure this is a pipable WIM.  */
2896         if (pwm->hdr.magic != PWM_MAGIC) {
2897                 ERROR("The WIM being read from file descriptor %d "
2898                       "is not pipable!", pipe_fd);
2899                 ret = WIMLIB_ERR_NOT_PIPABLE;
2900                 goto out_wimlib_free;
2901         }
2902
2903         /* Sanity check to make sure the first part of a pipable split WIM is
2904          * sent over the pipe first.  */
2905         if (pwm->hdr.part_number != 1) {
2906                 ERROR("The first part of the split WIM must be "
2907                       "sent over the pipe first.");
2908                 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2909                 goto out_wimlib_free;
2910         }
2911
2912         in_fd = &pwm->in_fd;
2913         wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
2914
2915         /* As mentioned, the WIMStruct we created from the pipe does not have
2916          * XML data yet.  Fix this by reading the extra copy of the XML data
2917          * that directly follows the header in pipable WIMs.  (Note: see
2918          * write_pipable_wim() for more details about the format of pipable
2919          * WIMs.)  */
2920         {
2921                 struct wim_lookup_table_entry xml_lte;
2922                 struct wim_resource_spec xml_rspec;
2923                 ret = read_pwm_stream_header(pwm, &xml_lte, &xml_rspec, 0, NULL);
2924                 if (ret)
2925                         goto out_wimlib_free;
2926
2927                 if (!(xml_lte.flags & WIM_RESHDR_FLAG_METADATA))
2928                 {
2929                         ERROR("Expected XML data, but found non-metadata "
2930                               "stream.");
2931                         ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2932                         goto out_wimlib_free;
2933                 }
2934
2935                 wim_res_spec_to_hdr(&xml_rspec, &pwm->hdr.xml_data_reshdr);
2936
2937                 ret = read_wim_xml_data(pwm);
2938                 if (ret)
2939                         goto out_wimlib_free;
2940
2941                 if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
2942                         ERROR("Image count in XML data is not the same as in WIM header.");
2943                         ret = WIMLIB_ERR_XML;
2944                         goto out_wimlib_free;
2945                 }
2946         }
2947
2948         /* Get image index (this may use the XML data that was just read to
2949          * resolve an image name).  */
2950         if (image_num_or_name) {
2951                 image = wimlib_resolve_image(pwm, image_num_or_name);
2952                 if (image == WIMLIB_NO_IMAGE) {
2953                         ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
2954                               image_num_or_name);
2955                         ret = WIMLIB_ERR_INVALID_IMAGE;
2956                         goto out_wimlib_free;
2957                 } else if (image == WIMLIB_ALL_IMAGES) {
2958                         ERROR("Applying all images from a pipe is not supported.");
2959                         ret = WIMLIB_ERR_INVALID_IMAGE;
2960                         goto out_wimlib_free;
2961                 }
2962         } else {
2963                 if (pwm->hdr.image_count != 1) {
2964                         ERROR("No image was specified, but the pipable WIM "
2965                               "did not contain exactly 1 image");
2966                         ret = WIMLIB_ERR_INVALID_IMAGE;
2967                         goto out_wimlib_free;
2968                 }
2969                 image = 1;
2970         }
2971
2972         /* Load the needed metadata resource.  */
2973         for (i = 1; i <= pwm->hdr.image_count; i++) {
2974                 struct wim_lookup_table_entry *metadata_lte;
2975                 struct wim_image_metadata *imd;
2976                 struct wim_resource_spec *metadata_rspec;
2977
2978                 metadata_lte = new_lookup_table_entry();
2979                 if (metadata_lte == NULL) {
2980                         ret = WIMLIB_ERR_NOMEM;
2981                         goto out_wimlib_free;
2982                 }
2983                 metadata_rspec = MALLOC(sizeof(struct wim_resource_spec));
2984                 if (metadata_rspec == NULL) {
2985                         ret = WIMLIB_ERR_NOMEM;
2986                         free_lookup_table_entry(metadata_lte);
2987                         goto out_wimlib_free;
2988                 }
2989
2990                 ret = read_pwm_stream_header(pwm, metadata_lte, metadata_rspec, 0, NULL);
2991                 imd = pwm->image_metadata[i - 1];
2992                 imd->metadata_lte = metadata_lte;
2993                 if (ret) {
2994                         FREE(metadata_rspec);
2995                         goto out_wimlib_free;
2996                 }
2997
2998                 if (!(metadata_lte->flags & WIM_RESHDR_FLAG_METADATA)) {
2999                         ERROR("Expected metadata resource, but found "
3000                               "non-metadata stream.");
3001                         ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3002                         goto out_wimlib_free;
3003                 }
3004
3005                 if (i == image) {
3006                         /* Metadata resource is for the images being extracted.
3007                          * Parse it and save the metadata in memory.  */
3008                         ret = read_metadata_resource(pwm, imd);
3009                         if (ret)
3010                                 goto out_wimlib_free;
3011                         imd->modified = 1;
3012                 } else {
3013                         /* Metadata resource is not for the image being
3014                          * extracted.  Skip over it.  */
3015                         ret = skip_wim_stream(metadata_lte);
3016                         if (ret)
3017                                 goto out_wimlib_free;
3018                 }
3019         }
3020         /* Extract the image.  */
3021         extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
3022         ret = do_wimlib_extract_image(pwm, image, target,
3023                                       extract_flags, progress_func);
3024         /* Clean up and return.  */
3025 out_wimlib_free:
3026         wimlib_free(pwm);
3027         return ret;
3028 }
3029
3030 /* API function documented in wimlib.h  */
3031 WIMLIBAPI int
3032 wimlib_extract_image(WIMStruct *wim,
3033                      int image,
3034                      const tchar *target,
3035                      int extract_flags,
3036                      wimlib_progress_func_t progress_func)
3037 {
3038         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
3039         return do_wimlib_extract_image(wim, image, target, extract_flags,
3040                                        progress_func);
3041 }