4 * Support for extracting WIM images, or files or directories contained in a WIM
9 * Copyright (C) 2012, 2013, 2014 Eric Biggers
11 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
28 * This file provides the API functions wimlib_extract_image(),
29 * wimlib_extract_image_from_pipe(), wimlib_extract_paths(), and
30 * wimlib_extract_pathlist(). Internally, all end up calling
31 * do_wimlib_extract_paths() and extract_trees().
33 * Although wimlib supports multiple extraction modes/backends (NTFS-3g, UNIX,
34 * Win32), this file does not itself have code to extract files or directories
35 * to any specific target; instead, it handles generic functionality and relies
36 * on lower-level callback functions declared in `struct apply_operations' to do
37 * the actual extraction.
44 #include "wimlib/apply.h"
45 #include "wimlib/dentry.h"
46 #include "wimlib/encoding.h"
47 #include "wimlib/endianness.h"
48 #include "wimlib/error.h"
49 #include "wimlib/lookup_table.h"
50 #include "wimlib/metadata.h"
51 #include "wimlib/pathlist.h"
52 #include "wimlib/paths.h"
53 #include "wimlib/reparse.h"
54 #include "wimlib/resource.h"
55 #include "wimlib/security.h"
57 # include "wimlib/win32.h" /* for realpath() equivalent */
59 #include "wimlib/xml.h"
60 #include "wimlib/wildcard.h"
61 #include "wimlib/wim.h"
69 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
70 #define WIMLIB_EXTRACT_FLAG_FROM_PIPE 0x40000000
71 #define WIMLIB_EXTRACT_FLAG_IMAGEMODE 0x20000000
73 /* Keep in sync with wimlib.h */
74 #define WIMLIB_EXTRACT_MASK_PUBLIC \
75 (WIMLIB_EXTRACT_FLAG_NTFS | \
76 WIMLIB_EXTRACT_FLAG_HARDLINK | \
77 WIMLIB_EXTRACT_FLAG_SYMLINK | \
78 WIMLIB_EXTRACT_FLAG_VERBOSE | \
79 WIMLIB_EXTRACT_FLAG_SEQUENTIAL | \
80 WIMLIB_EXTRACT_FLAG_UNIX_DATA | \
81 WIMLIB_EXTRACT_FLAG_NO_ACLS | \
82 WIMLIB_EXTRACT_FLAG_STRICT_ACLS | \
83 WIMLIB_EXTRACT_FLAG_RPFIX | \
84 WIMLIB_EXTRACT_FLAG_NORPFIX | \
85 WIMLIB_EXTRACT_FLAG_TO_STDOUT | \
86 WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES | \
87 WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS | \
88 WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS | \
89 WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES | \
90 WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS | \
91 WIMLIB_EXTRACT_FLAG_RESUME | \
92 WIMLIB_EXTRACT_FLAG_FILE_ORDER | \
93 WIMLIB_EXTRACT_FLAG_GLOB_PATHS | \
94 WIMLIB_EXTRACT_FLAG_STRICT_GLOB | \
95 WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES | \
96 WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE | \
97 WIMLIB_EXTRACT_FLAG_WIMBOOT)
100 dentry_in_list(const struct wim_dentry *dentry)
102 return dentry->extraction_list.next != NULL;
106 is_linked_extraction(const struct apply_ctx *ctx)
108 return 0 != (ctx->extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
109 WIMLIB_EXTRACT_FLAG_SYMLINK));
113 can_extract_named_data_streams(const struct apply_ctx *ctx)
115 return ctx->supported_features.named_data_streams &&
116 !is_linked_extraction(ctx);
118 /* Inform library user of progress of stream extraction following the successful
119 * extraction of a copy of the stream specified by @lte. */
121 update_extract_progress(struct apply_ctx *ctx,
122 const struct wim_lookup_table_entry *lte)
124 wimlib_progress_func_t progress_func = ctx->progress_func;
125 union wimlib_progress_info *progress = &ctx->progress;
127 progress->extract.completed_bytes += lte->size;
129 progress->extract.completed_bytes >= ctx->next_progress)
131 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, progress);
132 if (progress->extract.completed_bytes >=
133 progress->extract.total_bytes)
135 ctx->next_progress = ~0ULL;
137 ctx->next_progress += progress->extract.total_bytes / 128;
138 if (ctx->next_progress > progress->extract.total_bytes)
139 ctx->next_progress = progress->extract.total_bytes;
145 /* Extract a symbolic link (not directly as reparse data), handling fixing up
146 * the target of absolute symbolic links and updating the extract progress.
148 * @inode must specify the WIM inode for a symbolic link or junction reparse
151 * @lte_override overrides the resource used as the reparse data for the
154 extract_symlink(const tchar *path, struct apply_ctx *ctx,
155 struct wim_inode *inode,
156 struct wim_lookup_table_entry *lte_override)
158 ssize_t bufsize = ctx->ops->path_max;
159 tchar target[bufsize];
165 /* If absolute symbolic link fixups requested, reserve space in the link
166 * target buffer for the absolute path of the target directory. */
167 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
169 buf += ctx->realtarget_nchars;
170 bufsize -= ctx->realtarget_nchars;
173 /* Translate the WIM inode's reparse data into the link target. */
174 sret = wim_inode_readlink(inode, buf, bufsize - 1, lte_override);
177 return WIMLIB_ERR_READLINK;
181 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
184 /* Fix absolute symbolic link target to point into the
185 * actual extraction destination. */
186 tmemcpy(target, ctx->realtarget, ctx->realtarget_nchars);
187 fixed_target = target;
189 /* Keep same link target. */
193 /* Call into the apply_operations to create the symbolic link. */
194 DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
196 ret = ctx->ops->create_symlink(fixed_target, path, ctx);
198 ERROR_WITH_ERRNO("Failed to create symlink "
199 "\"%"TS"\" => \"%"TS"\"", path, fixed_target);
203 /* Account for reparse data consumed. */
204 update_extract_progress(ctx,
205 (lte_override ? lte_override :
206 inode_unnamed_lte_resolved(inode)));
209 #endif /* !__WIN32__ */
211 /* Create a file, directory, or symbolic link. */
213 extract_inode(const tchar *path, struct apply_ctx *ctx, struct wim_inode *inode)
218 if (ctx->supported_features.symlink_reparse_points &&
219 !ctx->supported_features.reparse_points &&
220 inode_is_symlink(inode))
222 ret = extract_symlink(path, ctx, inode, NULL);
224 #endif /* !__WIN32__ */
225 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
226 ret = ctx->ops->create_directory(path, ctx, &inode->extract_cookie);
228 ERROR_WITH_ERRNO("Failed to create the directory "
231 } else if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
232 ctx->ops->extract_encrypted_stream_creates_file &&
233 ctx->supported_features.encrypted_files) {
234 ret = ctx->ops->extract_encrypted_stream(
235 path, inode_unnamed_lte_resolved(inode), ctx);
237 ERROR_WITH_ERRNO("Failed to create and extract "
238 "encrypted file \"%"TS"\"", path);
241 ret = ctx->ops->create_file(path, ctx, &inode->extract_cookie);
243 ERROR_WITH_ERRNO("Failed to create the file "
251 extract_hardlink(const tchar *oldpath, const tchar *newpath,
252 struct apply_ctx *ctx)
256 DEBUG("Creating hardlink \"%"TS"\" => \"%"TS"\"", newpath, oldpath);
257 ret = ctx->ops->create_hardlink(oldpath, newpath, ctx);
259 ERROR_WITH_ERRNO("Failed to create hardlink "
260 "\"%"TS"\" => \"%"TS"\"",
268 try_extract_rpfix(u8 *rpbuf,
270 const wchar_t *extract_root_realpath,
271 unsigned extract_root_realpath_nchars)
273 struct reparse_data rpdata;
275 size_t target_nchars;
276 size_t stripped_nchars;
277 wchar_t *stripped_target;
278 wchar_t stripped_target_nchars;
281 utf16lechar *new_target;
282 utf16lechar *new_print_name;
283 size_t new_target_nchars;
284 size_t new_print_name_nchars;
287 ret = parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata);
291 if (extract_root_realpath[0] == L'\0' ||
292 extract_root_realpath[1] != L':' ||
293 extract_root_realpath[2] != L'\\')
294 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
296 ret = parse_substitute_name(rpdata.substitute_name,
297 rpdata.substitute_name_nbytes,
301 stripped_nchars = ret;
302 target = rpdata.substitute_name;
303 target_nchars = rpdata.substitute_name_nbytes / sizeof(utf16lechar);
304 stripped_target = target + stripped_nchars;
305 stripped_target_nchars = target_nchars - stripped_nchars;
307 new_target = alloca((6 + extract_root_realpath_nchars +
308 stripped_target_nchars) * sizeof(utf16lechar));
311 if (stripped_nchars == 6) {
312 /* Include \??\ prefix if it was present before */
313 p = wmempcpy(p, L"\\??\\", 4);
316 /* Print name excludes the \??\ if present. */
318 if (stripped_nchars != 0) {
319 /* Get drive letter from real path to extract root, if a drive
320 * letter was present before. */
321 *p++ = extract_root_realpath[0];
322 *p++ = extract_root_realpath[1];
324 /* Copy the rest of the extract root */
325 p = wmempcpy(p, extract_root_realpath + 2, extract_root_realpath_nchars - 2);
327 /* Append the stripped target */
328 p = wmempcpy(p, stripped_target, stripped_target_nchars);
329 new_target_nchars = p - new_target;
330 new_print_name_nchars = p - new_print_name;
332 if (new_target_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE ||
333 new_print_name_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE)
334 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
336 rpdata.substitute_name = new_target;
337 rpdata.substitute_name_nbytes = new_target_nchars * sizeof(utf16lechar);
338 rpdata.print_name = new_print_name;
339 rpdata.print_name_nbytes = new_print_name_nchars * sizeof(utf16lechar);
340 return make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
342 #endif /* __WIN32__ */
344 /* Set reparse data on extracted file or directory that has
345 * FILE_ATTRIBUTE_REPARSE_POINT set. */
347 extract_reparse_data(const tchar *path, struct apply_ctx *ctx,
348 struct wim_inode *inode,
349 struct wim_lookup_table_entry *lte_override)
352 u8 rpbuf[REPARSE_POINT_MAX_SIZE];
355 ret = wim_inode_get_reparse_data(inode, rpbuf, &rpbuflen, lte_override);
360 /* Fix up target of absolute symbolic link or junction points so
361 * that they point into the actual extraction target. */
362 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
363 (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
364 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) &&
365 !inode->i_not_rpfixed)
367 ret = try_extract_rpfix(rpbuf, &rpbuflen, ctx->realtarget,
368 ctx->realtarget_nchars);
369 if (ret && !(ctx->extract_flags &
370 WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
372 WARNING("Reparse point fixup of \"%"TS"\" "
381 ret = ctx->ops->set_reparse_data(path, rpbuf, rpbuflen, ctx);
383 /* On Windows, the SeCreateSymbolicLink privilege is required to create
384 * symbolic links. To be more friendly towards non-Administrator users,
385 * we merely warn the user if symbolic links cannot be created due to
386 * insufficient permissions or privileges, unless
387 * WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was provided. */
389 if (ret && inode_is_symlink(inode) &&
390 (errno == EACCES || errno == EPERM) &&
391 !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
393 WARNING("Can't set reparse data on \"%"TS"\": "
395 " You may be trying to "
396 "extract a symbolic link without the\n"
397 " SeCreateSymbolicLink privilege, "
398 "which by default non-Administrator\n"
399 " accounts do not have.",
407 /* Account for reparse data consumed. */
408 update_extract_progress(ctx,
409 (lte_override ? lte_override :
410 inode_unnamed_lte_resolved(inode)));
414 ERROR_WITH_ERRNO("Failed to set reparse data on \"%"TS"\"", path);
419 * Extract zero or more streams to a file.
421 * This function operates slightly differently depending on whether @lte_spec is
422 * NULL or not. When @lte_spec is NULL, the behavior is to extract the default
423 * file contents (unnamed stream), and, if named data streams are supported in
424 * the extract mode and volume, any named data streams. When @lte_spec is not
425 * NULL, the behavior is to extract only all copies of the stream @lte_spec, and
426 * in addition use @lte_spec to set the reparse data or create the symbolic link
430 * Path to file to extract (as can be passed to apply_operations
435 * WIM dentry that corresponds to the file being extracted.
437 * If non-NULL, specifies the lookup table entry for a stream to extract,
438 * and only that stream will be extracted (although there may be more than
439 * one instance of it).
441 * Used only if @lte_spec != NULL; it is passed to the extraction functions
442 * rather than @lte_spec, allowing the location of the stream to be
443 * overridden. (This is used when the WIM is being read from a nonseekable
444 * file, such as a pipe, when streams need to be used more than once; each
445 * such stream is extracted to a temporary file.)
448 extract_streams(const tchar *path, struct apply_ctx *ctx,
449 struct wim_dentry *dentry,
450 struct wim_lookup_table_entry *lte_spec,
451 struct wim_lookup_table_entry *lte_override)
453 struct wim_inode *inode = dentry->d_inode;
454 struct wim_lookup_table_entry *lte;
455 file_spec_t file_spec;
458 if (dentry->was_linked)
465 for (unsigned i = 0; i < SHA1_HASH_SIZE; i++)
466 p += sprintf(p, "%02x", lte_override->hash[i]);
467 DEBUG("Extracting stream SHA1=%s to \"%"TS"\"",
468 sha1_str, path, inode->i_ino);
470 DEBUG("Extracting streams to \"%"TS"\"", path, inode->i_ino);
474 if (ctx->ops->uses_cookies)
475 file_spec.cookie = inode->extract_cookie;
477 file_spec.path = path;
479 /* Unnamed data stream. */
480 lte = inode_unnamed_lte_resolved(inode);
481 if (lte && (!lte_spec || lte == lte_spec)) {
484 if (!(inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
485 FILE_ATTRIBUTE_REPARSE_POINT)))
487 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED &&
488 ctx->supported_features.encrypted_files) {
489 if (!ctx->ops->extract_encrypted_stream_creates_file) {
490 ret = ctx->ops->extract_encrypted_stream(
496 ret = ctx->ops->extract_unnamed_stream(
502 update_extract_progress(ctx, lte);
504 else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
507 if (ctx->supported_features.reparse_points)
508 ret = extract_reparse_data(path, ctx, inode, lte);
510 else if ((inode_is_symlink(inode) &&
511 ctx->supported_features.symlink_reparse_points))
512 ret = extract_symlink(path, ctx, inode, lte);
519 /* Named data streams. */
520 if (can_extract_named_data_streams(ctx)) {
521 for (u16 i = 0; i < inode->i_num_ads; i++) {
522 struct wim_ads_entry *entry = &inode->i_ads_entries[i];
524 if (!ads_entry_is_named_stream(entry))
529 if (lte_spec && lte_spec != lte)
533 ret = ctx->ops->extract_named_stream(file_spec, entry->stream_name,
534 entry->stream_name_nbytes / 2,
538 update_extract_progress(ctx, lte);
544 ERROR_WITH_ERRNO("Failed to extract data of \"%"TS"\"", path);
548 /* Set attributes on an extracted file or directory if supported by the
549 * extraction mode. */
551 extract_file_attributes(const tchar *path, struct apply_ctx *ctx,
552 struct wim_dentry *dentry, unsigned pass)
556 if (ctx->ops->set_file_attributes &&
557 !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) &&
558 !(dentry == ctx->target_dentry && ctx->root_dentry_is_special)) {
559 u32 attributes = dentry->d_inode->i_attributes;
561 /* Clear unsupported attributes. */
562 attributes &= ctx->supported_attributes_mask;
564 if ((attributes & FILE_ATTRIBUTE_DIRECTORY &&
565 !ctx->supported_features.encrypted_directories) ||
566 (!(attributes & FILE_ATTRIBUTE_DIRECTORY) &&
567 !ctx->supported_features.encrypted_files))
569 attributes &= ~FILE_ATTRIBUTE_ENCRYPTED;
573 attributes = FILE_ATTRIBUTE_NORMAL;
575 ret = ctx->ops->set_file_attributes(path, attributes, ctx, pass);
577 ERROR_WITH_ERRNO("Failed to set attributes on "
586 /* Set or remove the short (DOS) name on an extracted file or directory if
587 * supported by the extraction mode. Since DOS names are unimportant and it's
588 * easy to run into problems setting them on Windows (SetFileShortName()
589 * requires SE_RESTORE privilege, which only the Administrator can request, and
590 * also requires DELETE access to the file), failure is ignored unless
591 * WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is set. */
593 extract_short_name(const tchar *path, struct apply_ctx *ctx,
594 struct wim_dentry *dentry)
598 /* The root of the dentry tree being extracted may not be extracted to
599 * its original name, so its short name should be ignored. */
600 if (dentry == ctx->target_dentry)
603 if (ctx->supported_features.short_names) {
604 ret = ctx->ops->set_short_name(path,
606 dentry->short_name_nbytes / 2,
608 if (ret && (ctx->extract_flags &
609 WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES))
611 ERROR_WITH_ERRNO("Failed to set short name of "
619 /* Set security descriptor, UNIX data, or neither on an extracted file, taking
620 * into account the current extraction mode and flags. */
622 extract_security(const tchar *path, struct apply_ctx *ctx,
623 struct wim_dentry *dentry)
626 struct wim_inode *inode = dentry->d_inode;
628 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
631 if ((ctx->target_dentry == dentry) && ctx->root_dentry_is_special)
635 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) {
636 struct wimlib_unix_data data;
638 ret = inode_get_unix_data(inode, &data, NULL);
642 ret = ctx->ops->set_unix_data(path, &data, ctx);
644 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
645 ERROR_WITH_ERRNO("Failed to set UNIX owner, "
646 "group, and/or mode on "
650 WARNING_WITH_ERRNO("Failed to set UNIX owner, "
651 "group, and/or/mode on "
657 #endif /* __WIN32__ */
658 if (ctx->supported_features.security_descriptors &&
659 inode->i_security_id != -1)
661 const struct wim_security_data *sd;
665 sd = wim_const_security_data(ctx->wim);
666 desc = sd->descriptors[inode->i_security_id];
667 desc_size = sd->sizes[inode->i_security_id];
669 ret = ctx->ops->set_security_descriptor(path, desc,
672 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
673 ERROR_WITH_ERRNO("Failed to set security "
674 "descriptor on \"%"TS"\"", path);
678 if (errno != EACCES) {
679 WARNING_WITH_ERRNO("Failed to set "
680 "security descriptor "
681 "on \"%"TS"\"", path);
684 ctx->no_security_descriptors++;
691 /* Set timestamps on an extracted file. Failure is warning-only unless
692 * WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS is set. */
694 extract_timestamps(const tchar *path, struct apply_ctx *ctx,
695 struct wim_dentry *dentry)
697 struct wim_inode *inode = dentry->d_inode;
700 if ((ctx->target_dentry == dentry) && ctx->root_dentry_is_special)
703 if (ctx->ops->set_timestamps) {
704 ret = ctx->ops->set_timestamps(path,
705 inode->i_creation_time,
706 inode->i_last_write_time,
707 inode->i_last_access_time,
710 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) {
711 ERROR_WITH_ERRNO("Failed to set timestamps "
712 "on \"%"TS"\"", path);
715 WARNING_WITH_ERRNO("Failed to set timestamps "
716 "on \"%"TS"\"", path);
723 /* Check whether the extraction of a dentry should be skipped completely. */
725 dentry_is_supported(struct wim_dentry *dentry,
726 const struct wim_features *supported_features)
728 struct wim_inode *inode = dentry->d_inode;
730 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
731 return supported_features->reparse_points ||
732 (inode_is_symlink(inode) &&
733 supported_features->symlink_reparse_points);
735 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
736 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
737 return supported_features->encrypted_directories != 0;
739 return supported_features->encrypted_files != 0;
744 /* Given a WIM dentry to extract, build the path to which to extract it, in the
745 * format understood by the callbacks in the apply_operations being used.
747 * Write the resulting path into @path, which must have room for at least
748 * ctx->ops->path_max characters.
750 * Return %true if successful; %false if this WIM dentry doesn't actually need
751 * to be extracted or if the calculated path exceeds ctx->ops->max_path
754 * This function clobbers the tmp_list member of @dentry and its ancestors up
755 * until the extraction root. */
757 build_extraction_path(tchar path[], struct wim_dentry *dentry,
758 const struct apply_ctx *ctx)
761 LIST_HEAD(ancestor_list);
763 const tchar *target_prefix;
764 size_t target_prefix_nchars;
765 struct wim_dentry *d;
767 path_nchars = ctx->ops->path_prefix_nchars;
769 if (ctx->ops->requires_realtarget_in_paths) {
770 target_prefix = ctx->realtarget;
771 target_prefix_nchars = ctx->realtarget_nchars;
772 } else if (ctx->ops->requires_target_in_paths) {
773 target_prefix = ctx->target;
774 target_prefix_nchars = ctx->target_nchars;
776 target_prefix = NULL;
777 target_prefix_nchars = 0;
779 path_nchars += target_prefix_nchars;
781 for (d = dentry; d != ctx->target_dentry; d = d->parent) {
782 if (!dentry_in_list(d))
785 path_nchars += d->extraction_name_nchars + 1;
786 list_add(&d->tmp_list, &ancestor_list);
789 path_nchars++; /* null terminator */
791 if (path_nchars > ctx->ops->path_max) {
792 WARNING("\"%"TS"\": Path too long to extract",
793 dentry_full_path(dentry));
797 p = tmempcpy(p, ctx->ops->path_prefix, ctx->ops->path_prefix_nchars);
798 p = tmempcpy(p, target_prefix, target_prefix_nchars);
799 list_for_each_entry(d, &ancestor_list, tmp_list) {
800 *p++ = ctx->ops->path_separator;
801 p = tmempcpy(p, d->extraction_name, d->extraction_name_nchars);
804 wimlib_assert(p - path == path_nchars);
809 get_num_path_components(const tchar *path, tchar path_separator)
811 unsigned num_components = 0;
813 /* Ignore drive letter. */
814 if (path[0] != L'\0' && path[1] == L':')
819 while (*path == path_separator)
823 while (*path && *path != path_separator)
826 return num_components;
830 extract_multiimage_symlink(const tchar *oldpath, const tchar *newpath,
831 struct apply_ctx *ctx, struct wim_dentry *dentry)
833 size_t num_raw_path_components;
834 const struct wim_dentry *d;
835 size_t num_target_path_components;
840 num_raw_path_components = 0;
841 for (d = dentry; d != ctx->target_dentry; d = d->parent)
842 num_raw_path_components++;
844 if (ctx->ops->requires_realtarget_in_paths)
845 num_target_path_components = get_num_path_components(ctx->realtarget,
846 ctx->ops->path_separator);
847 else if (ctx->ops->requires_target_in_paths)
848 num_target_path_components = get_num_path_components(ctx->target,
849 ctx->ops->path_separator);
851 num_target_path_components = 0;
853 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) {
854 wimlib_assert(num_target_path_components > 0);
855 num_raw_path_components++;
856 num_target_path_components--;
859 p_old = oldpath + ctx->ops->path_prefix_nchars;
861 if (p_old[0] != L'\0' && p_old[1] == ':')
864 while (*p_old == ctx->ops->path_separator)
866 while (--num_target_path_components) {
867 while (*p_old != ctx->ops->path_separator)
869 while (*p_old == ctx->ops->path_separator)
873 tchar symlink_target[tstrlen(p_old) + 3 * num_raw_path_components + 1];
875 p = &symlink_target[0];
876 while (num_raw_path_components--) {
879 *p++ = ctx->ops->path_separator;
882 DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
883 newpath, symlink_target);
884 ret = ctx->ops->create_symlink(symlink_target, newpath, ctx);
886 ERROR_WITH_ERRNO("Failed to create symlink "
887 "\"%"TS"\" => \"%"TS"\"",
888 newpath, symlink_target);
893 /* Create the "skeleton" of an extracted file or directory. Don't yet extract
894 * data streams, reparse data (including symbolic links), timestamps, and
895 * security descriptors. Basically, everything that doesn't require reading
896 * non-metadata resources from the WIM file and isn't delayed until the final
899 do_dentry_extract_skeleton(tchar path[], struct wim_dentry *dentry,
900 struct apply_ctx *ctx)
902 struct wim_inode *inode = dentry->d_inode;
904 const tchar *oldpath;
906 if (unlikely(is_linked_extraction(ctx))) {
907 struct wim_lookup_table_entry *unnamed_lte;
909 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
910 if (unnamed_lte && unnamed_lte->extracted_file) {
911 oldpath = unnamed_lte->extracted_file;
912 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK)
919 /* Create hard link if this dentry corresponds to an already-extracted
921 if (inode->i_extracted_file) {
922 oldpath = inode->i_extracted_file;
926 /* Skip symlinks unless they can be extracted as reparse points rather
927 * than created directly. */
928 if (inode_is_symlink(inode) && !ctx->supported_features.reparse_points)
931 /* Create this file or directory unless it's the extraction root, which
932 * was already created if necessary. */
933 if (dentry != ctx->target_dentry) {
934 ret = extract_inode(path, ctx, inode);
939 /* Create empty named data streams. */
940 if (can_extract_named_data_streams(ctx)) {
941 for (u16 i = 0; i < inode->i_num_ads; i++) {
942 file_spec_t file_spec;
943 struct wim_ads_entry *entry = &inode->i_ads_entries[i];
945 if (!ads_entry_is_named_stream(entry))
949 if (ctx->ops->uses_cookies)
950 file_spec.cookie = inode->extract_cookie;
952 file_spec.path = path;
953 ret = ctx->ops->extract_named_stream(file_spec,
955 entry->stream_name_nbytes / 2,
958 ERROR_WITH_ERRNO("\"%"TS"\": failed to create "
959 "empty named data stream",
966 /* Set file attributes (if supported). */
967 ret = extract_file_attributes(path, ctx, dentry, 0);
971 /* Set or remove file short name (if supported). */
972 ret = extract_short_name(path, ctx, dentry);
976 /* If inode has multiple links and hard links are supported in this
977 * extraction mode and volume, save the path to the extracted file in
978 * case it's needed to create a hard link. */
979 if (unlikely(is_linked_extraction(ctx))) {
980 struct wim_lookup_table_entry *unnamed_lte;
982 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
984 unnamed_lte->extracted_file = TSTRDUP(path);
985 if (!unnamed_lte->extracted_file)
986 return WIMLIB_ERR_NOMEM;
988 } else if (inode->i_nlink > 1 && ctx->supported_features.hard_links) {
989 inode->i_extracted_file = TSTRDUP(path);
990 if (!inode->i_extracted_file)
991 return WIMLIB_ERR_NOMEM;
996 ret = extract_multiimage_symlink(oldpath, path, ctx, dentry);
999 dentry->was_linked = 1;
1003 ret = extract_hardlink(oldpath, path, ctx);
1006 dentry->was_linked = 1;
1010 /* This is a wrapper around do_dentry_extract_skeleton() that handles building
1011 * the path, doing short name reordering. This is also idempotent; dentries
1012 * already processed have skeleton_extracted set and no action is taken. See
1013 * apply_operations.requires_short_name_reordering for more details about short
1014 * name reordering. */
1016 dentry_extract_skeleton(struct wim_dentry *dentry, struct apply_ctx *ctx)
1018 tchar path[ctx->ops->path_max];
1019 struct wim_dentry *orig_dentry;
1020 struct wim_dentry *other_dentry;
1023 if (dentry->skeleton_extracted)
1027 if (ctx->supported_features.short_names
1028 && ctx->ops->requires_short_name_reordering
1029 && !dentry_has_short_name(dentry)
1030 && !dentry->d_inode->i_dos_name_extracted)
1032 inode_for_each_dentry(other_dentry, dentry->d_inode) {
1033 if (dentry_has_short_name(other_dentry)
1034 && !other_dentry->skeleton_extracted
1035 && dentry_in_list(other_dentry))
1037 DEBUG("Creating %"TS" before %"TS" "
1038 "to guarantee correct DOS name extraction",
1039 dentry_full_path(other_dentry),
1040 dentry_full_path(dentry));
1041 orig_dentry = dentry;
1042 dentry = other_dentry;
1048 if (!build_extraction_path(path, dentry, ctx))
1050 ret = do_dentry_extract_skeleton(path, dentry, ctx);
1054 dentry->skeleton_extracted = 1;
1057 dentry = orig_dentry;
1061 dentry->d_inode->i_dos_name_extracted = 1;
1065 /* Create a file or directory, then immediately extract all streams. The WIM
1066 * may not be read sequentially by this function. */
1068 dentry_extract(struct wim_dentry *dentry, struct apply_ctx *ctx)
1070 tchar path[ctx->ops->path_max];
1073 ret = dentry_extract_skeleton(dentry, ctx);
1077 if (!build_extraction_path(path, dentry, ctx))
1080 return extract_streams(path, ctx, dentry, NULL, NULL);
1083 /* Finish extracting a file, directory, or symbolic link by setting file
1084 * security and timestamps. */
1086 dentry_extract_final(struct wim_dentry *dentry, struct apply_ctx *ctx)
1089 tchar path[ctx->ops->path_max];
1091 if (!build_extraction_path(path, dentry, ctx))
1094 ret = extract_security(path, ctx, dentry);
1098 if (ctx->ops->requires_final_set_attributes_pass) {
1099 /* Set file attributes (if supported). */
1100 ret = extract_file_attributes(path, ctx, dentry, 1);
1105 return extract_timestamps(path, ctx, dentry);
1109 extract_structure(struct list_head *dentry_list, struct apply_ctx *ctx)
1111 struct wim_dentry *dentry;
1114 list_for_each_entry(dentry, dentry_list, extraction_list) {
1115 ret = dentry_extract_skeleton(dentry, ctx);
1123 extract_dir_structure(struct list_head *dentry_list, struct apply_ctx *ctx)
1125 struct wim_dentry *dentry;
1128 list_for_each_entry(dentry, dentry_list, extraction_list) {
1129 if (dentry_is_directory(dentry)) {
1130 ret = dentry_extract_skeleton(dentry, ctx);
1139 extract_dentries(struct list_head *dentry_list, struct apply_ctx *ctx)
1141 struct wim_dentry *dentry;
1144 list_for_each_entry(dentry, dentry_list, extraction_list) {
1145 ret = dentry_extract(dentry, ctx);
1153 extract_final_metadata(struct list_head *dentry_list, struct apply_ctx *ctx)
1155 struct wim_dentry *dentry;
1158 list_for_each_entry_reverse(dentry, dentry_list, extraction_list) {
1159 ret = dentry_extract_final(dentry, ctx);
1166 /* Creates a temporary file opened for writing. The open file descriptor is
1167 * returned in @fd_ret and its name is returned in @name_ret (dynamically
1170 create_temporary_file(struct filedes *fd_ret, tchar **name_ret)
1176 name = ttempnam(NULL, T("wimlib"));
1178 ERROR_WITH_ERRNO("Failed to create temporary filename");
1179 return WIMLIB_ERR_NOMEM;
1182 raw_fd = topen(name, O_WRONLY | O_CREAT | O_EXCL | O_BINARY, 0600);
1185 if (errno == EEXIST) {
1189 ERROR_WITH_ERRNO("Failed to open temporary file \"%"TS"\"", name);
1191 return WIMLIB_ERR_OPEN;
1194 filedes_init(fd_ret, raw_fd);
1199 /* Extract all instances of the stream @lte that are being extracted in this
1200 * call of extract_tree(), but actually read the stream data from @lte_override.
1203 extract_stream_instances(struct wim_lookup_table_entry *lte,
1204 struct wim_lookup_table_entry *lte_override,
1205 struct apply_ctx *ctx)
1207 struct wim_dentry **lte_dentries;
1208 tchar path[ctx->ops->path_max];
1212 if (lte->out_refcnt <= ARRAY_LEN(lte->inline_lte_dentries))
1213 lte_dentries = lte->inline_lte_dentries;
1215 lte_dentries = lte->lte_dentries;
1217 for (i = 0; i < lte->out_refcnt; i++) {
1218 struct wim_dentry *dentry = lte_dentries[i];
1220 if (dentry->tmp_flag)
1222 if (!build_extraction_path(path, dentry, ctx))
1224 ret = extract_streams(path, ctx, dentry, lte, lte_override);
1226 goto out_clear_tmp_flags;
1227 dentry->tmp_flag = 1;
1230 out_clear_tmp_flags:
1231 for (i = 0; i < lte->out_refcnt; i++)
1232 lte_dentries[i]->tmp_flag = 0;
1236 /* Determine whether the specified stream needs to be extracted to a temporary
1239 * @lte->out_refcnt specifies the number of instances of this stream that must
1242 * @is_partial_res is %true if this stream is just one of multiple in a single
1243 * WIM resource being extracted. */
1245 need_tmpfile_to_extract(struct wim_lookup_table_entry *lte,
1246 bool is_partial_res)
1248 /* Temporary file is always required when reading a partial resource,
1249 * since in that case we retrieve all the contained streams in one pass.
1254 /* Otherwise we don't need a temporary file if only a single instance of
1255 * the stream is needed. */
1256 if (lte->out_refcnt == 1)
1259 wimlib_assert(lte->out_refcnt >= 2);
1261 /* We also don't need a temporary file if random access to the stream is
1263 if (lte->resource_location != RESOURCE_IN_WIM ||
1264 filedes_is_seekable(<e->rspec->wim->in_fd))
1271 begin_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
1272 bool is_partial_res,
1275 struct apply_ctx *ctx = _ctx;
1278 if (!need_tmpfile_to_extract(lte, is_partial_res)) {
1279 DEBUG("Temporary file not needed "
1280 "for stream (size=%"PRIu64")", lte->size);
1281 ret = extract_stream_instances(lte, lte, ctx);
1285 return BEGIN_STREAM_STATUS_SKIP_STREAM;
1288 DEBUG("Temporary file needed for stream (size=%"PRIu64")", lte->size);
1289 return create_temporary_file(&ctx->tmpfile_fd, &ctx->tmpfile_name);
1293 end_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
1294 int status, void *_ctx)
1296 struct apply_ctx *ctx = _ctx;
1297 struct wim_lookup_table_entry lte_override;
1299 int errno_save = errno;
1301 ret = filedes_close(&ctx->tmpfile_fd);
1306 goto out_delete_tmpfile;
1310 ERROR_WITH_ERRNO("Error writing temporary file %"TS, ctx->tmpfile_name);
1311 ret = WIMLIB_ERR_WRITE;
1312 goto out_delete_tmpfile;
1315 /* Now that a full stream has been extracted to a temporary file,
1316 * extract all instances of it to the actual target. */
1318 memcpy(<e_override, lte, sizeof(struct wim_lookup_table_entry));
1319 lte_override.resource_location = RESOURCE_IN_FILE_ON_DISK;
1320 lte_override.file_on_disk = ctx->tmpfile_name;
1322 ret = extract_stream_instances(lte, <e_override, ctx);
1326 tunlink(ctx->tmpfile_name);
1327 FREE(ctx->tmpfile_name);
1332 /* Extracts a list of streams (ctx.stream_list), assuming that the directory
1333 * structure and empty files were already created. This relies on the
1334 * per-`struct wim_lookup_table_entry' list of dentries that reference each
1335 * stream that was constructed earlier. */
1337 extract_stream_list(struct apply_ctx *ctx)
1339 struct read_stream_list_callbacks cbs = {
1340 .begin_stream = begin_extract_stream_to_tmpfile,
1341 .begin_stream_ctx = ctx,
1342 .consume_chunk = extract_chunk_to_fd,
1343 .consume_chunk_ctx = &ctx->tmpfile_fd,
1344 .end_stream = end_extract_stream_to_tmpfile,
1345 .end_stream_ctx = ctx,
1347 return read_stream_list(&ctx->stream_list,
1348 offsetof(struct wim_lookup_table_entry, extraction_list),
1349 &cbs, VERIFY_STREAM_HASHES);
1352 #define PWM_ALLOW_WIM_HDR 0x00001
1353 #define PWM_SILENT_EOF 0x00002
1355 /* Read the header from a stream in a pipable WIM. */
1357 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
1358 struct wim_resource_spec *rspec,
1359 int flags, struct wim_header_disk *hdr_ret)
1362 struct pwm_stream_hdr stream_hdr;
1363 struct wim_header_disk pwm_hdr;
1365 struct wim_reshdr reshdr;
1368 ret = full_read(&pwm->in_fd, &buf.stream_hdr, sizeof(buf.stream_hdr));
1372 if ((flags & PWM_ALLOW_WIM_HDR) && buf.stream_hdr.magic == PWM_MAGIC) {
1373 BUILD_BUG_ON(sizeof(buf.pwm_hdr) < sizeof(buf.stream_hdr));
1374 ret = full_read(&pwm->in_fd, &buf.stream_hdr + 1,
1375 sizeof(buf.pwm_hdr) - sizeof(buf.stream_hdr));
1379 lte->resource_location = RESOURCE_NONEXISTENT;
1380 memcpy(hdr_ret, &buf.pwm_hdr, sizeof(buf.pwm_hdr));
1384 if (le64_to_cpu(buf.stream_hdr.magic) != PWM_STREAM_MAGIC) {
1385 ERROR("Data read on pipe is invalid (expected stream header).");
1386 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1389 copy_hash(lte->hash, buf.stream_hdr.hash);
1391 reshdr.size_in_wim = 0;
1392 reshdr.flags = le32_to_cpu(buf.stream_hdr.flags);
1393 reshdr.offset_in_wim = pwm->in_fd.offset;
1394 reshdr.uncompressed_size = le64_to_cpu(buf.stream_hdr.uncompressed_size);
1395 wim_res_hdr_to_spec(&reshdr, pwm, rspec);
1396 lte_bind_wim_resource_spec(lte, rspec);
1397 lte->flags = rspec->flags;
1398 lte->size = rspec->uncompressed_size;
1399 lte->offset_in_res = 0;
1403 if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
1404 ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
1409 extract_streams_from_pipe(struct apply_ctx *ctx)
1411 struct wim_lookup_table_entry *found_lte;
1412 struct wim_resource_spec *rspec;
1413 struct wim_lookup_table_entry *needed_lte;
1414 struct wim_lookup_table *lookup_table;
1415 struct wim_header_disk pwm_hdr;
1419 ret = WIMLIB_ERR_NOMEM;
1420 found_lte = new_lookup_table_entry();
1421 if (found_lte == NULL)
1424 rspec = MALLOC(sizeof(struct wim_resource_spec));
1426 goto out_free_found_lte;
1428 lookup_table = ctx->wim->lookup_table;
1429 pwm_flags = PWM_ALLOW_WIM_HDR;
1430 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1431 pwm_flags |= PWM_SILENT_EOF;
1432 memcpy(ctx->progress.extract.guid, ctx->wim->hdr.guid, WIM_GID_LEN);
1433 ctx->progress.extract.part_number = ctx->wim->hdr.part_number;
1434 ctx->progress.extract.total_parts = ctx->wim->hdr.total_parts;
1435 if (ctx->progress_func)
1436 ctx->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1438 while (ctx->num_streams_remaining) {
1439 if (found_lte->resource_location != RESOURCE_NONEXISTENT)
1440 lte_unbind_wim_resource_spec(found_lte);
1441 ret = read_pwm_stream_header(ctx->wim, found_lte, rspec,
1442 pwm_flags, &pwm_hdr);
1444 if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
1445 (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1449 goto out_free_found_lte;
1452 if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
1453 && !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
1454 && (needed_lte = lookup_stream(lookup_table, found_lte->hash))
1455 && (needed_lte->out_refcnt))
1457 tchar *tmpfile_name = NULL;
1458 struct wim_lookup_table_entry *lte_override;
1459 struct wim_lookup_table_entry tmpfile_lte;
1461 needed_lte->offset_in_res = found_lte->offset_in_res;
1462 needed_lte->flags = found_lte->flags;
1463 needed_lte->size = found_lte->size;
1465 lte_unbind_wim_resource_spec(found_lte);
1466 lte_bind_wim_resource_spec(needed_lte, rspec);
1468 if (needed_lte->out_refcnt > 1) {
1470 struct filedes tmpfile_fd;
1472 /* Extract stream to temporary file. */
1473 ret = create_temporary_file(&tmpfile_fd, &tmpfile_name);
1475 lte_unbind_wim_resource_spec(needed_lte);
1476 goto out_free_found_lte;
1479 ret = extract_full_stream_to_fd(needed_lte,
1482 filedes_close(&tmpfile_fd);
1483 goto delete_tmpfile;
1486 if (filedes_close(&tmpfile_fd)) {
1487 ERROR_WITH_ERRNO("Error writing to temporary "
1488 "file \"%"TS"\"", tmpfile_name);
1489 ret = WIMLIB_ERR_WRITE;
1490 goto delete_tmpfile;
1492 memcpy(&tmpfile_lte, needed_lte,
1493 sizeof(struct wim_lookup_table_entry));
1494 tmpfile_lte.resource_location = RESOURCE_IN_FILE_ON_DISK;
1495 tmpfile_lte.file_on_disk = tmpfile_name;
1496 lte_override = &tmpfile_lte;
1498 lte_override = needed_lte;
1501 ret = extract_stream_instances(needed_lte, lte_override, ctx);
1503 lte_unbind_wim_resource_spec(needed_lte);
1505 tunlink(tmpfile_name);
1509 goto out_free_found_lte;
1510 ctx->num_streams_remaining--;
1511 } else if (found_lte->resource_location != RESOURCE_NONEXISTENT) {
1512 ret = skip_wim_stream(found_lte);
1514 goto out_free_found_lte;
1516 u16 part_number = le16_to_cpu(pwm_hdr.part_number);
1517 u16 total_parts = le16_to_cpu(pwm_hdr.total_parts);
1519 if (part_number != ctx->progress.extract.part_number ||
1520 total_parts != ctx->progress.extract.total_parts ||
1521 memcmp(pwm_hdr.guid, ctx->progress.extract.guid,
1524 ctx->progress.extract.part_number = part_number;
1525 ctx->progress.extract.total_parts = total_parts;
1526 memcpy(ctx->progress.extract.guid,
1527 pwm_hdr.guid, WIM_GID_LEN);
1528 if (ctx->progress_func) {
1530 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1539 if (found_lte->resource_location != RESOURCE_IN_WIM)
1541 free_lookup_table_entry(found_lte);
1550 /* Extract a WIM dentry to standard output.
1552 * This obviously doesn't make sense in all cases. We return an error if the
1553 * dentry does not correspond to a regular file. Otherwise we extract the
1554 * unnamed data stream only. */
1556 extract_dentry_to_stdout(struct wim_dentry *dentry,
1557 const struct wim_lookup_table *lookup_table)
1559 struct wim_inode *inode = dentry->d_inode;
1560 struct wim_lookup_table_entry *lte;
1561 struct filedes _stdout;
1563 if (inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
1564 FILE_ATTRIBUTE_DIRECTORY))
1566 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
1567 "extracted to standard output", dentry_full_path(dentry));
1568 return WIMLIB_ERR_NOT_A_REGULAR_FILE;
1571 lte = inode_unnamed_lte(inode, lookup_table);
1573 const u8 *hash = inode_unnamed_stream_hash(inode);
1574 if (!is_zero_hash(hash))
1575 return stream_not_found_error(inode, hash);
1579 filedes_init(&_stdout, STDOUT_FILENO);
1580 return extract_full_stream_to_fd(lte, &_stdout);
1584 extract_dentries_to_stdout(struct wim_dentry **dentries, size_t num_dentries,
1585 const struct wim_lookup_table *lookup_table)
1587 for (size_t i = 0; i < num_dentries; i++) {
1588 int ret = extract_dentry_to_stdout(dentries[i], lookup_table);
1595 /**********************************************************************/
1598 * Removes duplicate dentries from the array.
1600 * Returns the new number of dentries, packed at the front of the array.
1603 remove_duplicate_trees(struct wim_dentry **trees, size_t num_trees)
1606 for (i = 0; i < num_trees; i++) {
1607 if (!trees[i]->tmp_flag) {
1608 /* Found distinct dentry. */
1609 trees[i]->tmp_flag = 1;
1610 trees[j++] = trees[i];
1613 for (i = 0; i < j; i++)
1614 trees[i]->tmp_flag = 0;
1619 * Remove dentries that are descendants of other dentries in the array.
1621 * Returns the new number of dentries, packed at the front of the array.
1624 remove_contained_trees(struct wim_dentry **trees, size_t num_trees)
1627 for (i = 0; i < num_trees; i++)
1628 trees[i]->tmp_flag = 1;
1629 for (i = 0; i < num_trees; i++) {
1630 struct wim_dentry *d = trees[i];
1631 while (!dentry_is_root(d)) {
1634 goto tree_contained;
1636 trees[j++] = trees[i];
1640 trees[i]->tmp_flag = 0;
1643 for (i = 0; i < j; i++)
1644 trees[i]->tmp_flag = 0;
1649 dentry_append_to_list(struct wim_dentry *dentry, void *_dentry_list)
1651 struct list_head *dentry_list = _dentry_list;
1652 list_add_tail(&dentry->extraction_list, dentry_list);
1657 dentry_reset_extraction_list_node(struct wim_dentry *dentry)
1659 dentry->extraction_list = (struct list_head){NULL, NULL};
1663 dentry_delete_from_list(struct wim_dentry *dentry, void *_ignore)
1665 list_del(&dentry->extraction_list);
1666 dentry_reset_extraction_list_node(dentry);
1671 * Build the preliminary list of dentries to be extracted.
1673 * The list maintains the invariant that if d1 and d2 are in the list and d1 is
1674 * an ancestor of d2, then d1 appears before d2 in the list.
1677 build_dentry_list(struct list_head *dentry_list, struct wim_dentry **trees,
1678 size_t num_trees, bool add_ancestors)
1680 INIT_LIST_HEAD(dentry_list);
1682 /* Add the trees recursively. */
1683 for (size_t i = 0; i < num_trees; i++)
1684 for_dentry_in_tree(trees[i], dentry_append_to_list, dentry_list);
1686 /* If requested, add ancestors of the trees. */
1687 if (add_ancestors) {
1688 for (size_t i = 0; i < num_trees; i++) {
1689 struct wim_dentry *dentry = trees[i];
1690 struct wim_dentry *ancestor;
1691 struct list_head *place_after;
1693 if (dentry_is_root(dentry))
1696 place_after = dentry_list;
1699 ancestor = ancestor->parent;
1700 if (dentry_in_list(ancestor)) {
1701 place_after = &ancestor->extraction_list;
1704 } while (!dentry_is_root(ancestor));
1708 ancestor = ancestor->parent;
1709 if (dentry_in_list(ancestor))
1711 list_add(&ancestor->extraction_list, place_after);
1712 } while (!dentry_is_root(ancestor));
1717 static const struct apply_operations *
1718 select_apply_operations(int extract_flags)
1721 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
1722 return &ntfs_3g_apply_ops;
1725 return &win32_apply_ops;
1727 return &unix_apply_ops;
1732 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
1734 static const utf16lechar replacement_char = cpu_to_le16('?');
1738 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
1744 for (i = 0; i < num_chars; i++) {
1747 case cpu_to_le16('\\'):
1748 case cpu_to_le16(':'):
1749 case cpu_to_le16('*'):
1750 case cpu_to_le16('?'):
1751 case cpu_to_le16('"'):
1752 case cpu_to_le16('<'):
1753 case cpu_to_le16('>'):
1754 case cpu_to_le16('|'):
1756 case cpu_to_le16('/'):
1757 case cpu_to_le16('\0'):
1759 name[i] = replacement_char;
1766 if (name[num_chars - 1] == cpu_to_le16(' ') ||
1767 name[num_chars - 1] == cpu_to_le16('.'))
1770 name[num_chars - 1] = replacement_char;
1779 dentry_calculate_extraction_name(struct wim_dentry *dentry,
1780 struct apply_ctx *ctx)
1784 if (dentry == ctx->target_dentry)
1787 if (!dentry_is_supported(dentry, &ctx->supported_features))
1790 if (!ctx->ops->supports_case_sensitive_filenames)
1792 struct wim_dentry *other;
1793 list_for_each_entry(other, &dentry->d_ci_conflict_list,
1796 if (dentry_in_list(other)) {
1797 if (ctx->extract_flags &
1798 WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
1799 WARNING("\"%"TS"\" has the same "
1800 "case-insensitive name as "
1801 "\"%"TS"\"; extracting "
1802 "dummy name instead",
1803 dentry_full_path(dentry),
1804 dentry_full_path(other));
1807 WARNING("Not extracting \"%"TS"\": "
1808 "has same case-insensitive "
1809 "name as \"%"TS"\"",
1810 dentry_full_path(dentry),
1811 dentry_full_path(other));
1818 if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
1819 #if TCHAR_IS_UTF16LE
1820 dentry->extraction_name = dentry->file_name;
1821 dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
1824 return utf16le_to_tstr(dentry->file_name,
1825 dentry->file_name_nbytes,
1826 &dentry->extraction_name,
1827 &dentry->extraction_name_nchars);
1830 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
1832 WARNING("\"%"TS"\" has an invalid filename "
1833 "that is not supported on this platform; "
1834 "extracting dummy name instead",
1835 dentry_full_path(dentry));
1838 WARNING("Not extracting \"%"TS"\": has an invalid filename "
1839 "that is not supported on this platform",
1840 dentry_full_path(dentry));
1847 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
1849 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
1850 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
1853 size_t tchar_nchars;
1854 #if TCHAR_IS_UTF16LE
1855 tchar_name = utf16_name_copy;
1856 tchar_nchars = dentry->file_name_nbytes / 2;
1858 ret = utf16le_to_tstr(utf16_name_copy,
1859 dentry->file_name_nbytes,
1860 &tchar_name, &tchar_nchars);
1864 size_t fixed_name_num_chars = tchar_nchars;
1865 tchar fixed_name[tchar_nchars + 50];
1867 tmemcpy(fixed_name, tchar_name, tchar_nchars);
1868 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
1869 T(" (invalid filename #%lu)"),
1870 ++ctx->invalid_sequence);
1871 #if !TCHAR_IS_UTF16LE
1874 dentry->extraction_name = memdup(fixed_name,
1875 2 * fixed_name_num_chars + 2);
1876 if (!dentry->extraction_name)
1877 return WIMLIB_ERR_NOMEM;
1878 dentry->extraction_name_nchars = fixed_name_num_chars;
1883 for_dentry_in_tree(dentry, dentry_delete_from_list, NULL);
1888 * Calculate the actual filename component at which each WIM dentry will be
1889 * extracted, with special handling for dentries that are unsupported by the
1890 * extraction backend or have invalid names.
1892 * Note: this has a dependency on start_extract() being called because
1893 * ctx.supported_features must be filled in in order to determine whether each
1894 * dentry is supported.
1896 * Possible error codes: WIMLIB_ERR_NOMEM, WIMLIB_ERR_INVALID_UTF16_STRING
1899 dentry_list_calculate_extraction_names(struct list_head *dentry_list,
1900 struct apply_ctx *ctx)
1902 struct list_head *prev, *cur;
1904 /* Can't use list_for_each_entry() because a call to
1905 * dentry_calculate_extraction_name() may delete the current dentry and
1906 * its children from the list. */
1910 struct wim_dentry *dentry;
1914 if (cur == dentry_list)
1917 dentry = list_entry(cur, struct wim_dentry, extraction_list);
1919 ret = dentry_calculate_extraction_name(dentry, ctx);
1923 if (prev->next == cur)
1926 ; /* Current dentry and its children (which follow in
1927 the list) were deleted. prev stays the same. */
1933 dentry_resolve_streams(struct wim_dentry *dentry, int extract_flags,
1934 struct wim_lookup_table *lookup_table)
1936 struct wim_inode *inode = dentry->d_inode;
1937 struct wim_lookup_table_entry *lte;
1941 /* Special case: when extracting from a pipe, the WIM lookup table is
1942 * initially empty, so "resolving" an inode's streams is initially not
1943 * possible. However, we still need to keep track of which streams,
1944 * identified by SHA1 message digests, need to be extracted, so we
1945 * "resolve" the inode's streams anyway by allocating new entries. */
1946 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
1948 ret = inode_resolve_streams(inode, lookup_table, force);
1951 for (u32 i = 0; i <= inode->i_num_ads; i++) {
1952 lte = inode_stream_lte_resolved(inode, i);
1954 lte->out_refcnt = 0;
1960 * For each dentry to be extracted, resolve all streams in the corresponding
1961 * inode and set 'out_refcnt' in each to 0.
1963 * Possible error codes: WIMLIB_ERR_RESOURCE_NOT_FOUND, WIMLIB_ERR_NOMEM.
1966 dentry_list_resolve_streams(struct list_head *dentry_list,
1967 struct apply_ctx *ctx)
1969 struct wim_dentry *dentry;
1972 list_for_each_entry(dentry, dentry_list, extraction_list) {
1973 ret = dentry_resolve_streams(dentry,
1975 ctx->wim->lookup_table);
1983 ref_stream(struct wim_lookup_table_entry *lte,
1984 struct wim_dentry *dentry, struct apply_ctx *ctx)
1989 /* Tally the size only for each extraction of the stream (not hard
1991 if (!(dentry->d_inode->i_visited &&
1992 ctx->supported_features.hard_links) &&
1993 (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
1994 lte->extracted_file == NULL)))
1996 ctx->progress.extract.total_bytes += lte->size;
1997 ctx->progress.extract.num_streams++;
2000 /* Add stream to the dentry_list only one time, even if it's going
2001 * to be extracted to multiple locations. */
2002 if (lte->out_refcnt == 0) {
2003 list_add_tail(<e->extraction_list, &ctx->stream_list);
2004 ctx->num_streams_remaining++;
2007 if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
2008 struct wim_dentry **lte_dentries;
2010 /* Append dentry to this stream's array of dentries referencing
2011 * it. Use inline array to avoid memory allocation until the
2012 * number of dentries becomes too large. */
2013 if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
2014 lte_dentries = lte->inline_lte_dentries;
2016 struct wim_dentry **prev_lte_dentries;
2017 size_t alloc_lte_dentries;
2019 if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
2020 prev_lte_dentries = NULL;
2021 alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
2023 prev_lte_dentries = lte->lte_dentries;
2024 alloc_lte_dentries = lte->alloc_lte_dentries;
2027 if (lte->out_refcnt == alloc_lte_dentries) {
2028 alloc_lte_dentries *= 2;
2029 lte_dentries = REALLOC(prev_lte_dentries,
2030 alloc_lte_dentries *
2031 sizeof(lte_dentries[0]));
2032 if (lte_dentries == NULL)
2033 return WIMLIB_ERR_NOMEM;
2034 if (prev_lte_dentries == NULL) {
2035 memcpy(lte_dentries,
2036 lte->inline_lte_dentries,
2037 sizeof(lte->inline_lte_dentries));
2039 lte->lte_dentries = lte_dentries;
2040 lte->alloc_lte_dentries = alloc_lte_dentries;
2042 lte_dentries = lte->lte_dentries;
2044 lte_dentries[lte->out_refcnt] = dentry;
2051 dentry_ref_streams(struct wim_dentry *dentry, struct apply_ctx *ctx)
2053 struct wim_inode *inode = dentry->d_inode;
2056 /* The unnamed data stream will always be extracted, except in an
2058 if (!inode_is_encrypted_directory(inode)) {
2059 ret = ref_stream(inode_unnamed_lte_resolved(inode),
2065 /* Named data streams will be extracted only if supported in the current
2066 * extraction mode and volume, and to avoid complications, if not doing
2067 * a linked extraction. */
2068 if (can_extract_named_data_streams(ctx)) {
2069 for (u16 i = 0; i < inode->i_num_ads; i++) {
2070 if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
2072 ret = ref_stream(inode->i_ads_entries[i].lte,
2078 inode->i_visited = 1;
2083 * For each dentry to be extracted, iterate through the data streams of the
2084 * corresponding inode. For each such stream that is not to be ignored due to
2085 * the supported features or extraction flags, add it to the list of streams to
2086 * be extracted (ctx->stream_list) if not already done so.
2088 * Also, if doing a sequential extraction, build a mapping from each stream to
2089 * the dentries referencing it.
2091 * This also initializes the extract progress info with byte and stream
2094 * Note: This has a dependency on start_extract being called because
2095 * ctx.supported_features must be filled in in order to determine whether named
2096 * data streams are supported.
2098 * Note: this uses the i_visited member of the inodes (assumed to be 0
2099 * initially), but does not reset it.
2101 * Possible error codes: WIMLIB_ERR_NOMEM.
2104 dentry_list_ref_streams(struct list_head *dentry_list, struct apply_ctx *ctx)
2106 struct wim_dentry *dentry;
2109 list_for_each_entry(dentry, dentry_list, extraction_list) {
2110 ret = dentry_ref_streams(dentry, ctx);
2117 /* Tally features necessary to extract a dentry and the corresponding inode. */
2119 dentry_tally_features(struct wim_dentry *dentry, struct wim_features *features)
2121 struct wim_inode *inode = dentry->d_inode;
2123 if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
2124 features->archive_files++;
2125 if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
2126 features->hidden_files++;
2127 if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
2128 features->system_files++;
2129 if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
2130 features->compressed_files++;
2131 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
2132 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2133 features->encrypted_directories++;
2135 features->encrypted_files++;
2137 if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
2138 features->not_context_indexed_files++;
2139 if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
2140 features->sparse_files++;
2141 if (inode_has_named_stream(inode))
2142 features->named_data_streams++;
2143 if (inode->i_visited)
2144 features->hard_links++;
2145 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
2146 features->reparse_points++;
2147 if (inode_is_symlink(inode))
2148 features->symlink_reparse_points++;
2150 features->other_reparse_points++;
2152 if (inode->i_security_id != -1)
2153 features->security_descriptors++;
2154 if (dentry->short_name_nbytes)
2155 features->short_names++;
2156 if (inode_has_unix_data(inode))
2157 features->unix_data++;
2158 inode->i_visited = 1;
2161 /* Tally the features necessary to extract the specified dentries. */
2163 dentry_list_get_features(struct list_head *dentry_list,
2164 struct wim_features *features)
2166 struct wim_dentry *dentry;
2168 memset(features, 0, sizeof(struct wim_features));
2170 list_for_each_entry(dentry, dentry_list, extraction_list)
2171 dentry_tally_features(dentry, features);
2173 list_for_each_entry(dentry, dentry_list, extraction_list)
2174 dentry->d_inode->i_visited = 0;
2178 compute_supported_attributes_mask(const struct wim_features *supported_features)
2180 u32 mask = (u32)~0UL;
2182 if (!supported_features->archive_files)
2183 mask &= ~FILE_ATTRIBUTE_ARCHIVE;
2185 if (!supported_features->hidden_files)
2186 mask &= ~FILE_ATTRIBUTE_HIDDEN;
2188 if (!supported_features->system_files)
2189 mask &= ~FILE_ATTRIBUTE_SYSTEM;
2191 if (!supported_features->not_context_indexed_files)
2192 mask &= ~FILE_ATTRIBUTE_NOT_CONTENT_INDEXED;
2194 if (!supported_features->compressed_files)
2195 mask &= ~FILE_ATTRIBUTE_COMPRESSED;
2197 if (!supported_features->sparse_files)
2198 mask &= ~FILE_ATTRIBUTE_SPARSE_FILE;
2200 if (!supported_features->reparse_points)
2201 mask &= ~FILE_ATTRIBUTE_REPARSE_POINT;
2207 do_feature_check(const struct wim_features *required_features,
2208 const struct wim_features *supported_features,
2209 int extract_flags, const struct apply_operations *ops)
2211 /* File attributes. */
2212 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
2213 /* Note: Don't bother the user about FILE_ATTRIBUTE_ARCHIVE.
2214 * We're an archive program, so theoretically we can do what we
2217 if (required_features->hidden_files &&
2218 !supported_features->hidden_files)
2219 WARNING("Ignoring FILE_ATTRIBUTE_HIDDEN of %lu files",
2220 required_features->hidden_files);
2222 if (required_features->system_files &&
2223 !supported_features->system_files)
2224 WARNING("Ignoring FILE_ATTRIBUTE_SYSTEM of %lu files",
2225 required_features->system_files);
2227 if (required_features->compressed_files &&
2228 !supported_features->compressed_files)
2229 WARNING("Ignoring FILE_ATTRIBUTE_COMPRESSED of %lu files",
2230 required_features->compressed_files);
2232 if (required_features->not_context_indexed_files &&
2233 !supported_features->not_context_indexed_files)
2234 WARNING("Ignoring FILE_ATTRIBUTE_NOT_CONTENT_INDEXED of %lu files",
2235 required_features->not_context_indexed_files);
2237 if (required_features->sparse_files &&
2238 !supported_features->sparse_files)
2239 WARNING("Ignoring FILE_ATTRIBUTE_SPARSE_FILE of %lu files",
2240 required_features->sparse_files);
2242 if (required_features->encrypted_directories &&
2243 !supported_features->encrypted_directories)
2244 WARNING("Ignoring FILE_ATTRIBUTE_ENCRYPTED of %lu directories",
2245 required_features->encrypted_directories);
2248 /* Encrypted files. */
2249 if (required_features->encrypted_files &&
2250 !supported_features->encrypted_files)
2251 WARNING("Ignoring %lu encrypted files",
2252 required_features->encrypted_files);
2254 /* Named data streams. */
2255 if (required_features->named_data_streams &&
2256 (!supported_features->named_data_streams ||
2257 (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2258 WIMLIB_EXTRACT_FLAG_HARDLINK))))
2259 WARNING("Ignoring named data streams of %lu files",
2260 required_features->named_data_streams);
2263 if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
2264 !supported_features->hard_links)
2266 ERROR("Extraction backend does not support hard links!");
2267 return WIMLIB_ERR_UNSUPPORTED;
2269 if (required_features->hard_links && !supported_features->hard_links)
2270 WARNING("Extracting %lu hard links as independent files",
2271 required_features->hard_links);
2273 /* Symbolic links and reparse points. */
2274 if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
2275 !supported_features->symlink_reparse_points)
2277 ERROR("Extraction backend does not support symbolic links!");
2278 return WIMLIB_ERR_UNSUPPORTED;
2280 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
2281 required_features->symlink_reparse_points &&
2282 !supported_features->symlink_reparse_points &&
2283 !supported_features->reparse_points)
2285 ERROR("Extraction backend does not support symbolic links!");
2286 return WIMLIB_ERR_UNSUPPORTED;
2288 if (required_features->reparse_points &&
2289 !supported_features->reparse_points)
2291 if (supported_features->symlink_reparse_points) {
2292 if (required_features->other_reparse_points) {
2293 WARNING("Ignoring %lu non-symlink/junction "
2294 "reparse point files",
2295 required_features->other_reparse_points);
2298 WARNING("Ignoring %lu reparse point files",
2299 required_features->reparse_points);
2303 /* Security descriptors. */
2304 if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
2305 WIMLIB_EXTRACT_FLAG_UNIX_DATA))
2306 == WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
2307 required_features->security_descriptors &&
2308 !supported_features->security_descriptors)
2310 ERROR("Extraction backend does not support security descriptors!");
2311 return WIMLIB_ERR_UNSUPPORTED;
2313 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) &&
2314 required_features->security_descriptors &&
2315 !supported_features->security_descriptors)
2316 WARNING("Ignoring Windows NT security descriptors of %lu files",
2317 required_features->security_descriptors);
2320 if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
2321 required_features->unix_data && !supported_features->unix_data)
2323 ERROR("Extraction backend does not support UNIX data!");
2324 return WIMLIB_ERR_UNSUPPORTED;
2328 if (required_features->short_names &&
2329 !supported_features->short_names)
2331 if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) {
2332 ERROR("Extraction backend does not support DOS names!");
2333 return WIMLIB_ERR_UNSUPPORTED;
2335 WARNING("Ignoring DOS names of %lu files",
2336 required_features->short_names);
2340 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
2341 !ops->set_timestamps)
2343 ERROR("Extraction backend does not support timestamps!");
2344 return WIMLIB_ERR_UNSUPPORTED;
2351 do_extract_warnings(struct apply_ctx *ctx)
2353 if (ctx->partial_security_descriptors == 0 &&
2354 ctx->no_security_descriptors == 0)
2357 WARNING("Extraction to \"%"TS"\" complete, but with one or more warnings:",
2359 if (ctx->partial_security_descriptors != 0) {
2360 WARNING("- Could only partially set the security descriptor\n"
2361 " on %lu files or directories.",
2362 ctx->partial_security_descriptors);
2364 if (ctx->no_security_descriptors != 0) {
2365 WARNING("- Could not set security descriptor at all\n"
2366 " on %lu files or directories.",
2367 ctx->no_security_descriptors);
2370 WARNING("To fully restore all security descriptors, run the program\n"
2371 " with Administrator rights.");
2376 destroy_dentry_list(struct list_head *dentry_list)
2378 struct wim_dentry *dentry, *tmp;
2379 struct wim_inode *inode;
2381 list_for_each_entry_safe(dentry, tmp, dentry_list, extraction_list) {
2382 inode = dentry->d_inode;
2383 dentry_reset_extraction_list_node(dentry);
2384 dentry->was_linked = 0;
2385 dentry->skeleton_extracted = 0;
2386 inode->i_visited = 0;
2387 FREE(inode->i_extracted_file);
2388 inode->i_extracted_file = NULL;
2389 inode->i_dos_name_extracted = 0;
2390 if ((void*)dentry->extraction_name != (void*)dentry->file_name)
2391 FREE(dentry->extraction_name);
2392 dentry->extraction_name = NULL;
2397 destroy_stream_list(struct list_head *stream_list)
2399 struct wim_lookup_table_entry *lte;
2401 list_for_each_entry(lte, stream_list, extraction_list)
2402 if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
2403 FREE(lte->lte_dentries);
2407 extract_trees(WIMStruct *wim, struct wim_dentry **trees, size_t num_trees,
2408 const tchar *target, int extract_flags,
2409 wimlib_progress_func_t progress_func)
2412 struct apply_ctx ctx;
2413 struct list_head dentry_list;
2414 struct wim_features required_features;
2416 /* Handle stdout extraction as a separate case. */
2417 if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
2418 return extract_dentries_to_stdout(trees, num_trees,
2421 /* Start initializing the apply_ctx. */
2422 memset(&ctx, 0, sizeof(struct apply_ctx));
2424 ctx.extract_flags = extract_flags;
2425 ctx.target = target;
2426 ctx.target_nchars = tstrlen(target);
2427 ctx.progress_func = progress_func;
2428 if (progress_func) {
2429 ctx.progress.extract.wimfile_name = wim->filename;
2430 ctx.progress.extract.image = wim->current_image;
2431 ctx.progress.extract.extract_flags = (extract_flags &
2432 WIMLIB_EXTRACT_MASK_PUBLIC);
2433 ctx.progress.extract.image_name = wimlib_get_image_name(wim,
2434 wim->current_image);
2435 ctx.progress.extract.target = target;
2438 ctx.target_dentry = wim_root_dentry(wim);
2439 /* Note: ctx.target_dentry represents the dentry that gets extracted to
2440 * @target. There may be none, in which case it gets set to the image
2441 * root and never matches any of the dentries actually being extracted.
2444 num_trees = remove_duplicate_trees(trees, num_trees);
2446 /* All trees are now distinct. */
2448 num_trees = remove_contained_trees(trees, num_trees);
2450 /* All trees are now distinct and non-overlapping. */
2452 /* Build list of dentries to be extracted. */
2453 build_dentry_list(&dentry_list, trees, num_trees,
2454 !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE));
2456 /* Select the appropriate apply_operations based on the platform and
2458 ctx.ops = select_apply_operations(extract_flags);
2460 /* Figure out whether the root dentry is being extracted to the root of
2461 * a volume and therefore needs to be treated "specially", for example
2462 * not being explicitly created and not having attributes set. */
2463 if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
2464 ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
2466 /* Call the start_extract() callback. This gives the apply_operations
2467 * implementation a chance to do any setup needed to access the volume.
2468 * Furthermore, start_extract() is expected to set the supported
2469 * features of this extraction mode (ctx.supported_features), which are
2470 * determined at runtime as they may vary depending on the actual
2472 ret = ctx.ops->start_extract(target, &ctx);
2474 goto out_destroy_dentry_list;
2476 /* Get and check the features required to extract the dentries. */
2477 dentry_list_get_features(&dentry_list, &required_features);
2478 ret = do_feature_check(&required_features, &ctx.supported_features,
2479 extract_flags, ctx.ops);
2481 goto out_finish_or_abort_extract;
2483 ctx.supported_attributes_mask =
2484 compute_supported_attributes_mask(&ctx.supported_features);
2486 /* Calculate extraction name for each dentry and remove subtrees that
2487 * can't be extracted due to naming problems. */
2488 ret = dentry_list_calculate_extraction_names(&dentry_list, &ctx);
2490 goto out_finish_or_abort_extract;
2492 /* Build list of streams to extract. */
2493 ret = dentry_list_resolve_streams(&dentry_list, &ctx);
2495 goto out_finish_or_abort_extract;
2496 INIT_LIST_HEAD(&ctx.stream_list);
2497 ret = dentry_list_ref_streams(&dentry_list, &ctx);
2499 goto out_destroy_stream_list;
2501 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2502 /* When extracting from a pipe, the number of bytes of data to
2503 * extract can't be determined in the normal way (examining the
2504 * lookup table), since at this point all we have is a set of
2505 * SHA1 message digests of streams that need to be extracted.
2506 * However, we can get a reasonably accurate estimate by taking
2507 * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
2508 * data. This does assume that a full image is being extracted,
2509 * but currently there is no API for doing otherwise. (Also,
2510 * subtract <HARDLINKBYTES> from this if hard links are
2511 * supported by the extraction mode.) */
2512 ctx.progress.extract.total_bytes =
2513 wim_info_get_image_total_bytes(wim->wim_info,
2514 wim->current_image);
2515 if (ctx.supported_features.hard_links) {
2516 ctx.progress.extract.total_bytes -=
2517 wim_info_get_image_hard_link_bytes(wim->wim_info,
2518 wim->current_image);
2522 if (ctx.ops->realpath_works_on_nonexisting_files &&
2523 ((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
2524 ctx.ops->requires_realtarget_in_paths))
2526 ctx.realtarget = realpath(target, NULL);
2527 if (!ctx.realtarget) {
2528 ret = WIMLIB_ERR_NOMEM;
2529 goto out_destroy_stream_list;
2531 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2534 if (progress_func) {
2536 if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2537 msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
2539 msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN;
2540 progress_func(msg, &ctx.progress);
2543 if (!ctx.root_dentry_is_special) {
2544 tchar path[ctx.ops->path_max];
2545 if (build_extraction_path(path, ctx.target_dentry, &ctx)) {
2546 ret = extract_inode(path, &ctx, ctx.target_dentry->d_inode);
2548 goto out_free_realtarget;
2552 /* If we need to fix up the targets of absolute symbolic links
2553 * (WIMLIB_EXTRACT_FLAG_RPFIX) or the extraction mode requires paths to
2554 * be absolute, use realpath() (or its replacement on Windows) to get
2555 * the absolute path to the extraction target. Note that this requires
2556 * the target directory to exist, unless
2557 * realpath_works_on_nonexisting_files is set in the apply_operations.
2559 if (!ctx.realtarget &&
2560 (((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
2561 required_features.symlink_reparse_points) ||
2562 ctx.ops->requires_realtarget_in_paths))
2564 ctx.realtarget = realpath(target, NULL);
2565 if (!ctx.realtarget) {
2566 ret = WIMLIB_ERR_NOMEM;
2567 goto out_free_realtarget;
2569 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2572 if (ctx.ops->requires_short_name_reordering) {
2574 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2576 ret = extract_dir_structure(&dentry_list, &ctx);
2578 goto out_free_realtarget;
2581 /* Finally, the important part: extract the tree of files. */
2582 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
2583 /* Sequential extraction requested, so two passes are needed
2584 * (one for file structure, one for streams.) */
2585 if (progress_func && !ctx.ops->requires_short_name_reordering)
2586 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2589 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
2590 ret = extract_structure(&dentry_list, &ctx);
2592 goto out_free_realtarget;
2595 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2597 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
2598 ret = extract_streams_from_pipe(&ctx);
2600 ret = extract_stream_list(&ctx);
2602 goto out_free_realtarget;
2604 /* Sequential extraction was not requested, so we can make do
2605 * with one pass where we both create the files and extract
2607 if (progress_func && !ctx.ops->requires_short_name_reordering)
2608 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2610 ret = extract_dentries(&dentry_list, &ctx);
2612 goto out_free_realtarget;
2614 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2618 /* If the total number of bytes to extract was miscalculated, just jump
2619 * to the calculated number in order to avoid confusing the progress
2620 * function. This should only occur when extracting from a pipe. */
2621 if (ctx.progress.extract.completed_bytes != ctx.progress.extract.total_bytes)
2623 DEBUG("Calculated %"PRIu64" bytes to extract, but actually "
2624 "extracted %"PRIu64,
2625 ctx.progress.extract.total_bytes,
2626 ctx.progress.extract.completed_bytes);
2628 if (progress_func &&
2629 ctx.progress.extract.completed_bytes < ctx.progress.extract.total_bytes)
2631 ctx.progress.extract.completed_bytes = ctx.progress.extract.total_bytes;
2632 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &ctx.progress);
2635 /* Apply security descriptors and timestamps. This is done at the end,
2636 * and in a depth-first manner, to prevent timestamps from getting
2637 * changed by subsequent extract operations and to minimize the chance
2638 * of the restored security descriptors getting in our way. */
2640 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
2642 ret = extract_final_metadata(&dentry_list, &ctx);
2644 goto out_free_realtarget;
2646 if (progress_func) {
2648 if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2649 msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END;
2651 msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END;
2652 progress_func(msg, &ctx.progress);
2654 do_extract_warnings(&ctx);
2656 out_free_realtarget:
2657 FREE(ctx.realtarget);
2658 out_destroy_stream_list:
2659 if (!(ctx.extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER))
2660 destroy_stream_list(&ctx.stream_list);
2661 out_finish_or_abort_extract:
2663 if (ctx.ops->abort_extract)
2664 ctx.ops->abort_extract(&ctx);
2666 if (ctx.ops->finish_extract)
2667 ret = ctx.ops->finish_extract(&ctx);
2669 out_destroy_dentry_list:
2670 destroy_dentry_list(&dentry_list);
2675 mkdir_if_needed(const tchar *target)
2678 if (tstat(target, &stbuf)) {
2679 if (errno == ENOENT) {
2680 if (tmkdir(target, 0755)) {
2681 ERROR_WITH_ERRNO("Failed to create directory "
2682 "\"%"TS"\"", target);
2683 return WIMLIB_ERR_MKDIR;
2686 ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
2687 return WIMLIB_ERR_STAT;
2689 } else if (!S_ISDIR(stbuf.st_mode)) {
2690 ERROR("\"%"TS"\" is not a directory", target);
2691 return WIMLIB_ERR_NOTDIR;
2696 /* Make sure the extraction flags make sense, and update them if needed. */
2698 check_extract_flags(const WIMStruct *wim, int *extract_flags_p)
2700 int extract_flags = *extract_flags_p;
2702 /* Check for invalid flag combinations */
2703 if ((extract_flags &
2704 (WIMLIB_EXTRACT_FLAG_SYMLINK |
2705 WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
2706 WIMLIB_EXTRACT_FLAG_HARDLINK))
2707 return WIMLIB_ERR_INVALID_PARAM;
2709 if ((extract_flags &
2710 (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2711 WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2712 WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2713 return WIMLIB_ERR_INVALID_PARAM;
2715 if ((extract_flags &
2716 (WIMLIB_EXTRACT_FLAG_RPFIX |
2717 WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
2718 WIMLIB_EXTRACT_FLAG_NORPFIX))
2719 return WIMLIB_ERR_INVALID_PARAM;
2721 if ((extract_flags &
2722 (WIMLIB_EXTRACT_FLAG_RESUME |
2723 WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
2724 return WIMLIB_ERR_INVALID_PARAM;
2726 #ifndef WITH_NTFS_3G
2727 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2728 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
2729 " it cannot apply a WIM image directly to a NTFS volume.");
2730 return WIMLIB_ERR_UNSUPPORTED;
2735 if (extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
2736 ERROR("WIMBoot extraction is only supported on Windows!");
2737 return WIMLIB_ERR_UNSUPPORTED;
2741 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
2742 WIMLIB_EXTRACT_FLAG_NORPFIX |
2743 WIMLIB_EXTRACT_FLAG_IMAGEMODE)) ==
2744 WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2746 /* For full-image extraction, do reparse point fixups by default
2747 * if the WIM header says they are enabled. */
2748 if (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
2749 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
2752 /* TODO: Since UNIX data entries are stored in the file resources, in a
2753 * completely sequential extraction they may come up before the
2754 * corresponding file or symbolic link data. This needs to be handled
2756 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2757 WIMLIB_EXTRACT_FLAG_FILE_ORDER))
2758 == WIMLIB_EXTRACT_FLAG_UNIX_DATA)
2760 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2761 WARNING("Setting UNIX file/owner group may "
2762 "be impossible on some\n"
2764 "when applying from a pipe.");
2766 extract_flags |= WIMLIB_EXTRACT_FLAG_FILE_ORDER;
2767 WARNING("Disabling sequential extraction for "
2772 *extract_flags_p = extract_flags;
2777 get_wildcard_flags(int extract_flags)
2779 u32 wildcard_flags = 0;
2781 if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_GLOB)
2782 wildcard_flags |= WILDCARD_FLAG_ERROR_IF_NO_MATCH;
2784 wildcard_flags |= WILDCARD_FLAG_WARN_IF_NO_MATCH;
2786 if (default_ignore_case)
2787 wildcard_flags |= WILDCARD_FLAG_CASE_INSENSITIVE;
2789 return wildcard_flags;
2792 struct append_dentry_ctx {
2793 struct wim_dentry **dentries;
2794 size_t num_dentries;
2795 size_t num_alloc_dentries;
2799 append_dentry_cb(struct wim_dentry *dentry, void *_ctx)
2801 struct append_dentry_ctx *ctx = _ctx;
2803 if (ctx->num_dentries == ctx->num_alloc_dentries) {
2804 struct wim_dentry **new_dentries;
2807 new_length = max(ctx->num_alloc_dentries + 8,
2808 ctx->num_alloc_dentries * 3 / 2);
2809 new_dentries = REALLOC(ctx->dentries,
2810 new_length * sizeof(ctx->dentries[0]));
2811 if (new_dentries == NULL)
2812 return WIMLIB_ERR_NOMEM;
2813 ctx->dentries = new_dentries;
2814 ctx->num_alloc_dentries = new_length;
2816 ctx->dentries[ctx->num_dentries++] = dentry;
2821 do_wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
2822 const tchar * const *paths, size_t num_paths,
2823 int extract_flags, wimlib_progress_func_t progress_func)
2826 struct wim_dentry **trees;
2829 if (wim == NULL || target == NULL || target[0] == T('\0') ||
2830 (num_paths != 0 && paths == NULL))
2831 return WIMLIB_ERR_INVALID_PARAM;
2833 ret = check_extract_flags(wim, &extract_flags);
2837 ret = select_wim_image(wim, image);
2841 ret = wim_checksum_unhashed_streams(wim);
2845 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_NTFS |
2846 WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE)) ==
2847 (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE))
2849 ret = mkdir_if_needed(target);
2854 if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS) {
2856 struct append_dentry_ctx append_dentry_ctx = {
2859 .num_alloc_dentries = 0,
2862 u32 wildcard_flags = get_wildcard_flags(extract_flags);
2864 for (size_t i = 0; i < num_paths; i++) {
2865 tchar *path = canonicalize_wim_path(paths[i]);
2867 ret = WIMLIB_ERR_NOMEM;
2868 trees = append_dentry_ctx.dentries;
2869 goto out_free_trees;
2871 ret = expand_wildcard(wim, path,
2877 trees = append_dentry_ctx.dentries;
2878 goto out_free_trees;
2881 trees = append_dentry_ctx.dentries;
2882 num_trees = append_dentry_ctx.num_dentries;
2884 trees = MALLOC(num_paths * sizeof(trees[0]));
2886 return WIMLIB_ERR_NOMEM;
2888 for (size_t i = 0; i < num_paths; i++) {
2890 tchar *path = canonicalize_wim_path(paths[i]);
2892 ret = WIMLIB_ERR_NOMEM;
2893 goto out_free_trees;
2896 trees[i] = get_dentry(wim, path,
2897 WIMLIB_CASE_PLATFORM_DEFAULT);
2899 if (trees[i] == NULL) {
2900 ERROR("Path \"%"TS"\" does not exist "
2902 paths[i], wim->current_image);
2903 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
2904 goto out_free_trees;
2907 num_trees = num_paths;
2910 if (num_trees == 0) {
2912 goto out_free_trees;
2915 ret = extract_trees(wim, trees, num_trees,
2916 target, extract_flags, progress_func);
2923 extract_single_image(WIMStruct *wim, int image,
2924 const tchar *target, int extract_flags,
2925 wimlib_progress_func_t progress_func)
2927 const tchar *path = WIMLIB_WIM_ROOT_PATH;
2928 extract_flags |= WIMLIB_EXTRACT_FLAG_IMAGEMODE;
2929 return do_wimlib_extract_paths(wim, image, target, &path, 1,
2930 extract_flags, progress_func);
2933 static const tchar * const filename_forbidden_chars =
2942 /* This function checks if it is okay to use a WIM image's name as a directory
2945 image_name_ok_as_dir(const tchar *image_name)
2947 return image_name && *image_name &&
2948 !tstrpbrk(image_name, filename_forbidden_chars) &&
2949 tstrcmp(image_name, T(".")) &&
2950 tstrcmp(image_name, T(".."));
2953 /* Extracts all images from the WIM to the directory @target, with the images
2954 * placed in subdirectories named by their image names. */
2956 extract_all_images(WIMStruct *wim,
2957 const tchar *target,
2959 wimlib_progress_func_t progress_func)
2961 size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
2962 size_t output_path_len = tstrlen(target);
2963 tchar buf[output_path_len + 1 + image_name_max_len + 1];
2966 const tchar *image_name;
2968 extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
2970 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2971 ERROR("Cannot extract multiple images in NTFS extraction mode.");
2972 return WIMLIB_ERR_INVALID_PARAM;
2975 ret = mkdir_if_needed(target);
2978 tmemcpy(buf, target, output_path_len);
2979 buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
2980 for (image = 1; image <= wim->hdr.image_count; image++) {
2981 image_name = wimlib_get_image_name(wim, image);
2982 if (image_name_ok_as_dir(image_name)) {
2983 tstrcpy(buf + output_path_len + 1, image_name);
2985 /* Image name is empty or contains forbidden characters.
2986 * Use image number instead. */
2987 tsprintf(buf + output_path_len + 1, T("%d"), image);
2989 ret = extract_single_image(wim, image, buf, extract_flags,
2998 clear_lte_extracted_file(WIMStruct *wim, int extract_flags)
3000 if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
3001 WIMLIB_EXTRACT_FLAG_HARDLINK)))
3002 for_lookup_table_entry(wim->lookup_table,
3003 lte_free_extracted_file, NULL);
3007 do_wimlib_extract_image(WIMStruct *wim,
3009 const tchar *target,
3011 wimlib_progress_func_t progress_func)
3015 if (extract_flags & (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE |
3016 WIMLIB_EXTRACT_FLAG_TO_STDOUT |
3017 WIMLIB_EXTRACT_FLAG_GLOB_PATHS))
3018 return WIMLIB_ERR_INVALID_PARAM;
3020 if (image == WIMLIB_ALL_IMAGES)
3021 ret = extract_all_images(wim, target, extract_flags,
3024 ret = extract_single_image(wim, image, target, extract_flags,
3027 clear_lte_extracted_file(wim, extract_flags);
3032 /****************************************************************************
3034 ****************************************************************************/
3037 wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
3038 const tchar * const *paths, size_t num_paths,
3039 int extract_flags, wimlib_progress_func_t progress_func)
3043 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3044 return WIMLIB_ERR_INVALID_PARAM;
3046 ret = do_wimlib_extract_paths(wim, image, target, paths, num_paths,
3047 extract_flags, progress_func);
3048 clear_lte_extracted_file(wim, extract_flags);
3053 wimlib_extract_pathlist(WIMStruct *wim, int image, const tchar *target,
3054 const tchar *path_list_file, int extract_flags,
3055 wimlib_progress_func_t progress_func)
3062 ret = read_path_list_file(path_list_file, &paths, &num_paths, &mem);
3064 ERROR("Failed to read path list file \"%"TS"\"",
3069 ret = wimlib_extract_paths(wim, image, target,
3070 (const tchar * const *)paths, num_paths,
3071 extract_flags, progress_func);
3078 wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
3079 const tchar *target, int extract_flags,
3080 wimlib_progress_func_t progress_func)
3084 struct filedes *in_fd;
3088 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3089 return WIMLIB_ERR_INVALID_PARAM;
3091 if (extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)
3092 return WIMLIB_ERR_INVALID_PARAM;
3094 /* Read the WIM header from the pipe and get a WIMStruct to represent
3095 * the pipable WIM. Caveats: Unlike getting a WIMStruct with
3096 * wimlib_open_wim(), getting a WIMStruct in this way will result in
3097 * an empty lookup table, no XML data read, and no filename set. */
3098 ret = open_wim_as_WIMStruct(&pipe_fd,
3099 WIMLIB_OPEN_FLAG_FROM_PIPE,
3100 &pwm, progress_func);
3104 /* Sanity check to make sure this is a pipable WIM. */
3105 if (pwm->hdr.magic != PWM_MAGIC) {
3106 ERROR("The WIM being read from file descriptor %d "
3107 "is not pipable!", pipe_fd);
3108 ret = WIMLIB_ERR_NOT_PIPABLE;
3109 goto out_wimlib_free;
3112 /* Sanity check to make sure the first part of a pipable split WIM is
3113 * sent over the pipe first. */
3114 if (pwm->hdr.part_number != 1) {
3115 ERROR("The first part of the split WIM must be "
3116 "sent over the pipe first.");
3117 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3118 goto out_wimlib_free;
3121 in_fd = &pwm->in_fd;
3122 wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
3124 /* As mentioned, the WIMStruct we created from the pipe does not have
3125 * XML data yet. Fix this by reading the extra copy of the XML data
3126 * that directly follows the header in pipable WIMs. (Note: see
3127 * write_pipable_wim() for more details about the format of pipable
3130 struct wim_lookup_table_entry xml_lte;
3131 struct wim_resource_spec xml_rspec;
3132 ret = read_pwm_stream_header(pwm, &xml_lte, &xml_rspec, 0, NULL);
3134 goto out_wimlib_free;
3136 if (!(xml_lte.flags & WIM_RESHDR_FLAG_METADATA))
3138 ERROR("Expected XML data, but found non-metadata "
3140 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3141 goto out_wimlib_free;
3144 wim_res_spec_to_hdr(&xml_rspec, &pwm->hdr.xml_data_reshdr);
3146 ret = read_wim_xml_data(pwm);
3148 goto out_wimlib_free;
3150 if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
3151 ERROR("Image count in XML data is not the same as in WIM header.");
3152 ret = WIMLIB_ERR_IMAGE_COUNT;
3153 goto out_wimlib_free;
3157 /* Get image index (this may use the XML data that was just read to
3158 * resolve an image name). */
3159 if (image_num_or_name) {
3160 image = wimlib_resolve_image(pwm, image_num_or_name);
3161 if (image == WIMLIB_NO_IMAGE) {
3162 ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
3164 ret = WIMLIB_ERR_INVALID_IMAGE;
3165 goto out_wimlib_free;
3166 } else if (image == WIMLIB_ALL_IMAGES) {
3167 ERROR("Applying all images from a pipe is not supported!");
3168 ret = WIMLIB_ERR_INVALID_IMAGE;
3169 goto out_wimlib_free;
3172 if (pwm->hdr.image_count != 1) {
3173 ERROR("No image was specified, but the pipable WIM "
3174 "did not contain exactly 1 image");
3175 ret = WIMLIB_ERR_INVALID_IMAGE;
3176 goto out_wimlib_free;
3181 /* Load the needed metadata resource. */
3182 for (i = 1; i <= pwm->hdr.image_count; i++) {
3183 struct wim_lookup_table_entry *metadata_lte;
3184 struct wim_image_metadata *imd;
3185 struct wim_resource_spec *metadata_rspec;
3187 metadata_lte = new_lookup_table_entry();
3188 if (metadata_lte == NULL) {
3189 ret = WIMLIB_ERR_NOMEM;
3190 goto out_wimlib_free;
3192 metadata_rspec = MALLOC(sizeof(struct wim_resource_spec));
3193 if (metadata_rspec == NULL) {
3194 ret = WIMLIB_ERR_NOMEM;
3195 free_lookup_table_entry(metadata_lte);
3196 goto out_wimlib_free;
3199 ret = read_pwm_stream_header(pwm, metadata_lte, metadata_rspec, 0, NULL);
3200 imd = pwm->image_metadata[i - 1];
3201 imd->metadata_lte = metadata_lte;
3203 FREE(metadata_rspec);
3204 goto out_wimlib_free;
3207 if (!(metadata_lte->flags & WIM_RESHDR_FLAG_METADATA)) {
3208 ERROR("Expected metadata resource, but found "
3209 "non-metadata stream.");
3210 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3211 goto out_wimlib_free;
3215 /* Metadata resource is for the image being extracted.
3216 * Parse it and save the metadata in memory. */
3217 ret = read_metadata_resource(pwm, imd);
3219 goto out_wimlib_free;
3222 /* Metadata resource is not for the image being
3223 * extracted. Skip over it. */
3224 ret = skip_wim_stream(metadata_lte);
3226 goto out_wimlib_free;
3229 /* Extract the image. */
3230 extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
3231 ret = do_wimlib_extract_image(pwm, image, target,
3232 extract_flags, progress_func);
3233 /* Clean up and return. */
3240 wimlib_extract_image(WIMStruct *wim, int image, const tchar *target,
3241 int extract_flags, wimlib_progress_func_t progress_func)
3243 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3244 return WIMLIB_ERR_INVALID_PARAM;
3245 return do_wimlib_extract_image(wim, image, target, extract_flags,