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