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 struct wim_security_data *sd;
665 sd = wim_get_current_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)
1177 name = ttempnam(NULL, T("wimlib"));
1179 ERROR_WITH_ERRNO("Failed to create temporary filename");
1180 return WIMLIB_ERR_NOMEM;
1183 open_flags = O_WRONLY | O_CREAT | O_EXCL | O_BINARY;
1185 open_flags |= _O_SHORT_LIVED;
1187 raw_fd = topen(name, open_flags, 0600);
1190 if (errno == EEXIST) {
1194 ERROR_WITH_ERRNO("Failed to open temporary file \"%"TS"\"", name);
1196 return WIMLIB_ERR_OPEN;
1199 filedes_init(fd_ret, raw_fd);
1204 /* Extract all instances of the stream @lte that are being extracted in this
1205 * call of extract_tree(), but actually read the stream data from @lte_override.
1208 extract_stream_instances(struct wim_lookup_table_entry *lte,
1209 struct wim_lookup_table_entry *lte_override,
1210 struct apply_ctx *ctx)
1212 struct wim_dentry **lte_dentries;
1213 tchar path[ctx->ops->path_max];
1217 if (lte->out_refcnt <= ARRAY_LEN(lte->inline_lte_dentries))
1218 lte_dentries = lte->inline_lte_dentries;
1220 lte_dentries = lte->lte_dentries;
1222 for (i = 0; i < lte->out_refcnt; i++) {
1223 struct wim_dentry *dentry = lte_dentries[i];
1225 if (dentry->tmp_flag)
1227 if (!build_extraction_path(path, dentry, ctx))
1229 ret = extract_streams(path, ctx, dentry, lte, lte_override);
1231 goto out_clear_tmp_flags;
1232 dentry->tmp_flag = 1;
1235 out_clear_tmp_flags:
1236 for (i = 0; i < lte->out_refcnt; i++)
1237 lte_dentries[i]->tmp_flag = 0;
1241 /* Determine whether the specified stream needs to be extracted to a temporary
1244 * @lte->out_refcnt specifies the number of instances of this stream that must
1247 * @is_partial_res is %true if this stream is just one of multiple in a single
1248 * WIM resource being extracted. */
1250 need_tmpfile_to_extract(struct wim_lookup_table_entry *lte,
1251 bool is_partial_res)
1253 /* Temporary file is always required when reading a partial resource,
1254 * since in that case we retrieve all the contained streams in one pass.
1259 /* Otherwise we don't need a temporary file if only a single instance of
1260 * the stream is needed. */
1261 if (lte->out_refcnt == 1)
1264 wimlib_assert(lte->out_refcnt >= 2);
1266 /* We also don't need a temporary file if random access to the stream is
1268 if (lte->resource_location != RESOURCE_IN_WIM ||
1269 filedes_is_seekable(<e->rspec->wim->in_fd))
1276 begin_extract_stream(struct wim_lookup_table_entry *lte,
1277 u32 flags, void *_ctx)
1279 struct apply_ctx *ctx = _ctx;
1282 if (flags & BEGIN_STREAM_FLAG_WHOLE_STREAM) {
1283 DEBUG("Whole stream (size=%"PRIu64") will be read into memory",
1285 ctx->cur_stream = lte;
1286 filedes_invalidate(&ctx->tmpfile_fd);
1290 if (!need_tmpfile_to_extract(lte,
1291 (flags & BEGIN_STREAM_FLAG_PARTIAL_RESOURCE)))
1293 DEBUG("Temporary file not needed "
1294 "for stream (size=%"PRIu64")", lte->size);
1295 ret = extract_stream_instances(lte, lte, ctx);
1299 return BEGIN_STREAM_STATUS_SKIP_STREAM;
1302 DEBUG("Temporary file needed for stream (size=%"PRIu64")", lte->size);
1303 return create_temporary_file(&ctx->tmpfile_fd, &ctx->tmpfile_name);
1307 extract_chunk(const void *chunk, size_t size, void *_ctx)
1309 struct apply_ctx *ctx = _ctx;
1312 if (filedes_valid(&ctx->tmpfile_fd)) {
1313 ret = full_write(&ctx->tmpfile_fd, chunk, size);
1315 ERROR_WITH_ERRNO("Error writing to file descriptor");
1317 struct wim_lookup_table_entry lte_override;
1319 memcpy(<e_override, ctx->cur_stream,
1320 sizeof(struct wim_lookup_table_entry));
1322 lte_override.resource_location = RESOURCE_IN_ATTACHED_BUFFER;
1323 lte_override.size = size;
1324 lte_override.attached_buffer = (void *)chunk;
1326 ret = extract_stream_instances(ctx->cur_stream, <e_override, ctx);
1332 end_extract_stream(struct wim_lookup_table_entry *lte,
1333 int status, void *_ctx)
1335 struct apply_ctx *ctx = _ctx;
1336 struct wim_lookup_table_entry lte_override;
1338 int errno_save = errno;
1340 if (!filedes_valid(&ctx->tmpfile_fd))
1343 ret = filedes_close(&ctx->tmpfile_fd);
1348 goto out_delete_tmpfile;
1352 ERROR_WITH_ERRNO("Error writing temporary file %"TS, ctx->tmpfile_name);
1353 ret = WIMLIB_ERR_WRITE;
1354 goto out_delete_tmpfile;
1357 /* Now that a full stream has been extracted to a temporary file,
1358 * extract all instances of it to the actual target. */
1360 memcpy(<e_override, lte, sizeof(struct wim_lookup_table_entry));
1361 lte_override.resource_location = RESOURCE_IN_FILE_ON_DISK;
1362 lte_override.file_on_disk = ctx->tmpfile_name;
1364 ret = extract_stream_instances(lte, <e_override, ctx);
1368 tunlink(ctx->tmpfile_name);
1369 FREE(ctx->tmpfile_name);
1374 /* Extracts a list of streams (ctx.stream_list), assuming that the directory
1375 * structure and empty files were already created. This relies on the
1376 * per-`struct wim_lookup_table_entry' list of dentries that reference each
1377 * stream that was constructed earlier. */
1379 extract_stream_list(struct apply_ctx *ctx)
1381 struct read_stream_list_callbacks cbs = {
1382 .begin_stream = begin_extract_stream,
1383 .begin_stream_ctx = ctx,
1384 .consume_chunk = extract_chunk,
1385 .consume_chunk_ctx = ctx,
1386 .end_stream = end_extract_stream,
1387 .end_stream_ctx = ctx,
1389 return read_stream_list(&ctx->stream_list,
1390 offsetof(struct wim_lookup_table_entry, extraction_list),
1391 &cbs, VERIFY_STREAM_HASHES);
1394 #define PWM_ALLOW_WIM_HDR 0x00001
1395 #define PWM_SILENT_EOF 0x00002
1397 /* Read the header from a stream in a pipable WIM. */
1399 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
1400 struct wim_resource_spec *rspec,
1401 int flags, struct wim_header_disk *hdr_ret)
1404 struct pwm_stream_hdr stream_hdr;
1405 struct wim_header_disk pwm_hdr;
1407 struct wim_reshdr reshdr;
1410 ret = full_read(&pwm->in_fd, &buf.stream_hdr, sizeof(buf.stream_hdr));
1414 if ((flags & PWM_ALLOW_WIM_HDR) && buf.stream_hdr.magic == PWM_MAGIC) {
1415 BUILD_BUG_ON(sizeof(buf.pwm_hdr) < sizeof(buf.stream_hdr));
1416 ret = full_read(&pwm->in_fd, &buf.stream_hdr + 1,
1417 sizeof(buf.pwm_hdr) - sizeof(buf.stream_hdr));
1421 lte->resource_location = RESOURCE_NONEXISTENT;
1422 memcpy(hdr_ret, &buf.pwm_hdr, sizeof(buf.pwm_hdr));
1426 if (le64_to_cpu(buf.stream_hdr.magic) != PWM_STREAM_MAGIC) {
1427 ERROR("Data read on pipe is invalid (expected stream header).");
1428 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1431 copy_hash(lte->hash, buf.stream_hdr.hash);
1433 reshdr.size_in_wim = 0;
1434 reshdr.flags = le32_to_cpu(buf.stream_hdr.flags);
1435 reshdr.offset_in_wim = pwm->in_fd.offset;
1436 reshdr.uncompressed_size = le64_to_cpu(buf.stream_hdr.uncompressed_size);
1437 wim_res_hdr_to_spec(&reshdr, pwm, rspec);
1438 lte_bind_wim_resource_spec(lte, rspec);
1439 lte->flags = rspec->flags;
1440 lte->size = rspec->uncompressed_size;
1441 lte->offset_in_res = 0;
1445 if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
1446 ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
1451 extract_streams_from_pipe(struct apply_ctx *ctx)
1453 struct wim_lookup_table_entry *found_lte;
1454 struct wim_resource_spec *rspec;
1455 struct wim_lookup_table_entry *needed_lte;
1456 struct wim_lookup_table *lookup_table;
1457 struct wim_header_disk pwm_hdr;
1461 ret = WIMLIB_ERR_NOMEM;
1462 found_lte = new_lookup_table_entry();
1463 if (found_lte == NULL)
1466 rspec = MALLOC(sizeof(struct wim_resource_spec));
1468 goto out_free_found_lte;
1470 lookup_table = ctx->wim->lookup_table;
1471 pwm_flags = PWM_ALLOW_WIM_HDR;
1472 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1473 pwm_flags |= PWM_SILENT_EOF;
1474 memcpy(ctx->progress.extract.guid, ctx->wim->hdr.guid, WIM_GUID_LEN);
1475 ctx->progress.extract.part_number = ctx->wim->hdr.part_number;
1476 ctx->progress.extract.total_parts = ctx->wim->hdr.total_parts;
1477 if (ctx->progress_func)
1478 ctx->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1480 while (ctx->num_streams_remaining) {
1481 if (found_lte->resource_location != RESOURCE_NONEXISTENT)
1482 lte_unbind_wim_resource_spec(found_lte);
1483 ret = read_pwm_stream_header(ctx->wim, found_lte, rspec,
1484 pwm_flags, &pwm_hdr);
1486 if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
1487 (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1491 goto out_free_found_lte;
1494 if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
1495 && !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
1496 && (needed_lte = lookup_stream(lookup_table, found_lte->hash))
1497 && (needed_lte->out_refcnt))
1499 tchar *tmpfile_name = NULL;
1500 struct wim_lookup_table_entry *lte_override;
1501 struct wim_lookup_table_entry tmpfile_lte;
1503 needed_lte->offset_in_res = found_lte->offset_in_res;
1504 needed_lte->flags = found_lte->flags;
1505 needed_lte->size = found_lte->size;
1507 lte_unbind_wim_resource_spec(found_lte);
1508 lte_bind_wim_resource_spec(needed_lte, rspec);
1510 if (needed_lte->out_refcnt > 1) {
1512 struct filedes tmpfile_fd;
1514 /* Extract stream to temporary file. */
1515 ret = create_temporary_file(&tmpfile_fd, &tmpfile_name);
1517 lte_unbind_wim_resource_spec(needed_lte);
1518 goto out_free_found_lte;
1521 ret = extract_full_stream_to_fd(needed_lte,
1524 filedes_close(&tmpfile_fd);
1525 goto delete_tmpfile;
1528 if (filedes_close(&tmpfile_fd)) {
1529 ERROR_WITH_ERRNO("Error writing to temporary "
1530 "file \"%"TS"\"", tmpfile_name);
1531 ret = WIMLIB_ERR_WRITE;
1532 goto delete_tmpfile;
1534 memcpy(&tmpfile_lte, needed_lte,
1535 sizeof(struct wim_lookup_table_entry));
1536 tmpfile_lte.resource_location = RESOURCE_IN_FILE_ON_DISK;
1537 tmpfile_lte.file_on_disk = tmpfile_name;
1538 lte_override = &tmpfile_lte;
1540 lte_override = needed_lte;
1543 ret = extract_stream_instances(needed_lte, lte_override, ctx);
1545 lte_unbind_wim_resource_spec(needed_lte);
1547 tunlink(tmpfile_name);
1551 goto out_free_found_lte;
1552 ctx->num_streams_remaining--;
1553 } else if (found_lte->resource_location != RESOURCE_NONEXISTENT) {
1554 ret = skip_wim_stream(found_lte);
1556 goto out_free_found_lte;
1558 u16 part_number = le16_to_cpu(pwm_hdr.part_number);
1559 u16 total_parts = le16_to_cpu(pwm_hdr.total_parts);
1561 if (part_number != ctx->progress.extract.part_number ||
1562 total_parts != ctx->progress.extract.total_parts ||
1563 memcmp(pwm_hdr.guid, ctx->progress.extract.guid,
1566 ctx->progress.extract.part_number = part_number;
1567 ctx->progress.extract.total_parts = total_parts;
1568 memcpy(ctx->progress.extract.guid,
1569 pwm_hdr.guid, WIM_GUID_LEN);
1570 if (ctx->progress_func) {
1572 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1581 if (found_lte->resource_location != RESOURCE_IN_WIM)
1583 free_lookup_table_entry(found_lte);
1592 /* Extract a WIM dentry to standard output.
1594 * This obviously doesn't make sense in all cases. We return an error if the
1595 * dentry does not correspond to a regular file. Otherwise we extract the
1596 * unnamed data stream only. */
1598 extract_dentry_to_stdout(struct wim_dentry *dentry,
1599 const struct wim_lookup_table *lookup_table)
1601 struct wim_inode *inode = dentry->d_inode;
1602 struct wim_lookup_table_entry *lte;
1603 struct filedes _stdout;
1605 if (inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
1606 FILE_ATTRIBUTE_DIRECTORY))
1608 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
1609 "extracted to standard output", dentry_full_path(dentry));
1610 return WIMLIB_ERR_NOT_A_REGULAR_FILE;
1613 lte = inode_unnamed_lte(inode, lookup_table);
1615 const u8 *hash = inode_unnamed_stream_hash(inode);
1616 if (!is_zero_hash(hash))
1617 return stream_not_found_error(inode, hash);
1621 filedes_init(&_stdout, STDOUT_FILENO);
1622 return extract_full_stream_to_fd(lte, &_stdout);
1626 extract_dentries_to_stdout(struct wim_dentry **dentries, size_t num_dentries,
1627 const struct wim_lookup_table *lookup_table)
1629 for (size_t i = 0; i < num_dentries; i++) {
1630 int ret = extract_dentry_to_stdout(dentries[i], lookup_table);
1637 /**********************************************************************/
1640 * Removes duplicate dentries from the array.
1642 * Returns the new number of dentries, packed at the front of the array.
1645 remove_duplicate_trees(struct wim_dentry **trees, size_t num_trees)
1648 for (i = 0; i < num_trees; i++) {
1649 if (!trees[i]->tmp_flag) {
1650 /* Found distinct dentry. */
1651 trees[i]->tmp_flag = 1;
1652 trees[j++] = trees[i];
1655 for (i = 0; i < j; i++)
1656 trees[i]->tmp_flag = 0;
1661 * Remove dentries that are descendants of other dentries in the array.
1663 * Returns the new number of dentries, packed at the front of the array.
1666 remove_contained_trees(struct wim_dentry **trees, size_t num_trees)
1669 for (i = 0; i < num_trees; i++)
1670 trees[i]->tmp_flag = 1;
1671 for (i = 0; i < num_trees; i++) {
1672 struct wim_dentry *d = trees[i];
1673 while (!dentry_is_root(d)) {
1676 goto tree_contained;
1678 trees[j++] = trees[i];
1682 trees[i]->tmp_flag = 0;
1685 for (i = 0; i < j; i++)
1686 trees[i]->tmp_flag = 0;
1691 dentry_append_to_list(struct wim_dentry *dentry, void *_dentry_list)
1693 struct list_head *dentry_list = _dentry_list;
1694 list_add_tail(&dentry->extraction_list, dentry_list);
1699 dentry_reset_extraction_list_node(struct wim_dentry *dentry)
1701 dentry->extraction_list = (struct list_head){NULL, NULL};
1705 dentry_delete_from_list(struct wim_dentry *dentry, void *_ignore)
1707 list_del(&dentry->extraction_list);
1708 dentry_reset_extraction_list_node(dentry);
1713 * Build the preliminary list of dentries to be extracted.
1715 * The list maintains the invariant that if d1 and d2 are in the list and d1 is
1716 * an ancestor of d2, then d1 appears before d2 in the list.
1719 build_dentry_list(struct list_head *dentry_list, struct wim_dentry **trees,
1720 size_t num_trees, bool add_ancestors)
1722 INIT_LIST_HEAD(dentry_list);
1724 /* Add the trees recursively. */
1725 for (size_t i = 0; i < num_trees; i++)
1726 for_dentry_in_tree(trees[i], dentry_append_to_list, dentry_list);
1728 /* If requested, add ancestors of the trees. */
1729 if (add_ancestors) {
1730 for (size_t i = 0; i < num_trees; i++) {
1731 struct wim_dentry *dentry = trees[i];
1732 struct wim_dentry *ancestor;
1733 struct list_head *place_after;
1735 if (dentry_is_root(dentry))
1738 place_after = dentry_list;
1741 ancestor = ancestor->parent;
1742 if (dentry_in_list(ancestor)) {
1743 place_after = &ancestor->extraction_list;
1746 } while (!dentry_is_root(ancestor));
1750 ancestor = ancestor->parent;
1751 if (dentry_in_list(ancestor))
1753 list_add(&ancestor->extraction_list, place_after);
1754 } while (!dentry_is_root(ancestor));
1759 static const struct apply_operations *
1760 select_apply_operations(int extract_flags)
1763 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
1764 return &ntfs_3g_apply_ops;
1767 return &win32_apply_ops;
1769 return &unix_apply_ops;
1774 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
1776 static const utf16lechar replacement_char = cpu_to_le16('?');
1780 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
1786 for (i = 0; i < num_chars; i++) {
1789 case cpu_to_le16('\\'):
1790 case cpu_to_le16(':'):
1791 case cpu_to_le16('*'):
1792 case cpu_to_le16('?'):
1793 case cpu_to_le16('"'):
1794 case cpu_to_le16('<'):
1795 case cpu_to_le16('>'):
1796 case cpu_to_le16('|'):
1798 case cpu_to_le16('/'):
1799 case cpu_to_le16('\0'):
1801 name[i] = replacement_char;
1808 if (name[num_chars - 1] == cpu_to_le16(' ') ||
1809 name[num_chars - 1] == cpu_to_le16('.'))
1812 name[num_chars - 1] = replacement_char;
1821 dentry_calculate_extraction_name(struct wim_dentry *dentry,
1822 struct apply_ctx *ctx)
1826 if (dentry == ctx->target_dentry)
1829 if (!dentry_is_supported(dentry, &ctx->supported_features))
1832 if (!ctx->ops->supports_case_sensitive_filenames)
1834 struct wim_dentry *other;
1835 list_for_each_entry(other, &dentry->d_ci_conflict_list,
1838 if (dentry_in_list(other)) {
1839 if (ctx->extract_flags &
1840 WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
1841 WARNING("\"%"TS"\" has the same "
1842 "case-insensitive name as "
1843 "\"%"TS"\"; extracting "
1844 "dummy name instead",
1845 dentry_full_path(dentry),
1846 dentry_full_path(other));
1849 WARNING("Not extracting \"%"TS"\": "
1850 "has same case-insensitive "
1851 "name as \"%"TS"\"",
1852 dentry_full_path(dentry),
1853 dentry_full_path(other));
1860 if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
1861 ret = utf16le_get_tstr(dentry->file_name,
1862 dentry->file_name_nbytes,
1863 (const tchar **)&dentry->extraction_name,
1864 &dentry->extraction_name_nchars);
1865 dentry->extraction_name_nchars /= sizeof(tchar);
1868 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
1870 WARNING("\"%"TS"\" has an invalid filename "
1871 "that is not supported on this platform; "
1872 "extracting dummy name instead",
1873 dentry_full_path(dentry));
1876 WARNING("Not extracting \"%"TS"\": has an invalid filename "
1877 "that is not supported on this platform",
1878 dentry_full_path(dentry));
1885 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
1887 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
1888 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
1890 const tchar *tchar_name;
1891 size_t tchar_nchars;
1893 ret = utf16le_get_tstr(utf16_name_copy,
1894 dentry->file_name_nbytes,
1895 &tchar_name, &tchar_nchars);
1899 tchar_nchars /= sizeof(tchar);
1901 size_t fixed_name_num_chars = tchar_nchars;
1902 tchar fixed_name[tchar_nchars + 50];
1904 tmemcpy(fixed_name, tchar_name, tchar_nchars);
1905 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
1906 T(" (invalid filename #%lu)"),
1907 ++ctx->invalid_sequence);
1909 utf16le_put_tstr(tchar_name);
1911 dentry->extraction_name = memdup(fixed_name,
1912 2 * fixed_name_num_chars + 2);
1913 if (!dentry->extraction_name)
1914 return WIMLIB_ERR_NOMEM;
1915 dentry->extraction_name_nchars = fixed_name_num_chars;
1920 for_dentry_in_tree(dentry, dentry_delete_from_list, NULL);
1925 * Calculate the actual filename component at which each WIM dentry will be
1926 * extracted, with special handling for dentries that are unsupported by the
1927 * extraction backend or have invalid names.
1929 * Note: this has a dependency on start_extract() being called because
1930 * ctx.supported_features must be filled in in order to determine whether each
1931 * dentry is supported.
1933 * Possible error codes: WIMLIB_ERR_NOMEM, WIMLIB_ERR_INVALID_UTF16_STRING
1936 dentry_list_calculate_extraction_names(struct list_head *dentry_list,
1937 struct apply_ctx *ctx)
1939 struct list_head *prev, *cur;
1941 /* Can't use list_for_each_entry() because a call to
1942 * dentry_calculate_extraction_name() may delete the current dentry and
1943 * its children from the list. */
1947 struct wim_dentry *dentry;
1951 if (cur == dentry_list)
1954 dentry = list_entry(cur, struct wim_dentry, extraction_list);
1956 ret = dentry_calculate_extraction_name(dentry, ctx);
1960 if (prev->next == cur)
1963 ; /* Current dentry and its children (which follow in
1964 the list) were deleted. prev stays the same. */
1970 dentry_resolve_streams(struct wim_dentry *dentry, int extract_flags,
1971 struct wim_lookup_table *lookup_table)
1973 struct wim_inode *inode = dentry->d_inode;
1974 struct wim_lookup_table_entry *lte;
1978 /* Special case: when extracting from a pipe, the WIM lookup table is
1979 * initially empty, so "resolving" an inode's streams is initially not
1980 * possible. However, we still need to keep track of which streams,
1981 * identified by SHA1 message digests, need to be extracted, so we
1982 * "resolve" the inode's streams anyway by allocating new entries. */
1983 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
1985 ret = inode_resolve_streams(inode, lookup_table, force);
1988 for (u32 i = 0; i <= inode->i_num_ads; i++) {
1989 lte = inode_stream_lte_resolved(inode, i);
1991 lte->out_refcnt = 0;
1997 * For each dentry to be extracted, resolve all streams in the corresponding
1998 * inode and set 'out_refcnt' in each to 0.
2000 * Possible error codes: WIMLIB_ERR_RESOURCE_NOT_FOUND, WIMLIB_ERR_NOMEM.
2003 dentry_list_resolve_streams(struct list_head *dentry_list,
2004 struct apply_ctx *ctx)
2006 struct wim_dentry *dentry;
2009 list_for_each_entry(dentry, dentry_list, extraction_list) {
2010 ret = dentry_resolve_streams(dentry,
2012 ctx->wim->lookup_table);
2020 ref_stream(struct wim_lookup_table_entry *lte,
2021 struct wim_dentry *dentry, struct apply_ctx *ctx)
2026 /* Tally the size only for each extraction of the stream (not hard
2028 if (!(dentry->d_inode->i_visited &&
2029 ctx->supported_features.hard_links) &&
2030 (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
2031 lte->extracted_file == NULL)))
2033 ctx->progress.extract.total_bytes += lte->size;
2034 ctx->progress.extract.num_streams++;
2037 /* Add stream to the dentry_list only one time, even if it's going
2038 * to be extracted to multiple locations. */
2039 if (lte->out_refcnt == 0) {
2040 list_add_tail(<e->extraction_list, &ctx->stream_list);
2041 ctx->num_streams_remaining++;
2044 if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
2045 struct wim_dentry **lte_dentries;
2047 /* Append dentry to this stream's array of dentries referencing
2048 * it. Use inline array to avoid memory allocation until the
2049 * number of dentries becomes too large. */
2050 if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
2051 lte_dentries = lte->inline_lte_dentries;
2053 struct wim_dentry **prev_lte_dentries;
2054 size_t alloc_lte_dentries;
2056 if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
2057 prev_lte_dentries = NULL;
2058 alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
2060 prev_lte_dentries = lte->lte_dentries;
2061 alloc_lte_dentries = lte->alloc_lte_dentries;
2064 if (lte->out_refcnt == alloc_lte_dentries) {
2065 alloc_lte_dentries *= 2;
2066 lte_dentries = REALLOC(prev_lte_dentries,
2067 alloc_lte_dentries *
2068 sizeof(lte_dentries[0]));
2069 if (lte_dentries == NULL)
2070 return WIMLIB_ERR_NOMEM;
2071 if (prev_lte_dentries == NULL) {
2072 memcpy(lte_dentries,
2073 lte->inline_lte_dentries,
2074 sizeof(lte->inline_lte_dentries));
2076 lte->lte_dentries = lte_dentries;
2077 lte->alloc_lte_dentries = alloc_lte_dentries;
2079 lte_dentries = lte->lte_dentries;
2081 lte_dentries[lte->out_refcnt] = dentry;
2088 dentry_ref_streams(struct wim_dentry *dentry, struct apply_ctx *ctx)
2090 struct wim_inode *inode = dentry->d_inode;
2093 /* The unnamed data stream will always be extracted, except in an
2095 if (!inode_is_encrypted_directory(inode)) {
2096 ret = ref_stream(inode_unnamed_lte_resolved(inode),
2102 /* Named data streams will be extracted only if supported in the current
2103 * extraction mode and volume, and to avoid complications, if not doing
2104 * a linked extraction. */
2105 if (can_extract_named_data_streams(ctx)) {
2106 for (u16 i = 0; i < inode->i_num_ads; i++) {
2107 if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
2109 ret = ref_stream(inode->i_ads_entries[i].lte,
2115 inode->i_visited = 1;
2120 * For each dentry to be extracted, iterate through the data streams of the
2121 * corresponding inode. For each such stream that is not to be ignored due to
2122 * the supported features or extraction flags, add it to the list of streams to
2123 * be extracted (ctx->stream_list) if not already done so.
2125 * Also, if doing a sequential extraction, build a mapping from each stream to
2126 * the dentries referencing it.
2128 * This also initializes the extract progress info with byte and stream
2131 * Note: This has a dependency on start_extract being called because
2132 * ctx.supported_features must be filled in in order to determine whether named
2133 * data streams are supported.
2135 * Note: this uses the i_visited member of the inodes (assumed to be 0
2136 * initially), but does not reset it.
2138 * Possible error codes: WIMLIB_ERR_NOMEM.
2141 dentry_list_ref_streams(struct list_head *dentry_list, struct apply_ctx *ctx)
2143 struct wim_dentry *dentry;
2146 list_for_each_entry(dentry, dentry_list, extraction_list) {
2147 ret = dentry_ref_streams(dentry, ctx);
2154 /* Tally features necessary to extract a dentry and the corresponding inode. */
2156 dentry_tally_features(struct wim_dentry *dentry, struct wim_features *features)
2158 struct wim_inode *inode = dentry->d_inode;
2160 if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
2161 features->archive_files++;
2162 if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
2163 features->hidden_files++;
2164 if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
2165 features->system_files++;
2166 if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
2167 features->compressed_files++;
2168 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
2169 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2170 features->encrypted_directories++;
2172 features->encrypted_files++;
2174 if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
2175 features->not_context_indexed_files++;
2176 if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
2177 features->sparse_files++;
2178 if (inode_has_named_stream(inode))
2179 features->named_data_streams++;
2180 if (inode->i_visited)
2181 features->hard_links++;
2182 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
2183 features->reparse_points++;
2184 if (inode_is_symlink(inode))
2185 features->symlink_reparse_points++;
2187 features->other_reparse_points++;
2189 if (inode->i_security_id != -1)
2190 features->security_descriptors++;
2191 if (dentry->short_name_nbytes)
2192 features->short_names++;
2193 if (inode_has_unix_data(inode))
2194 features->unix_data++;
2195 inode->i_visited = 1;
2198 /* Tally the features necessary to extract the specified dentries. */
2200 dentry_list_get_features(struct list_head *dentry_list,
2201 struct wim_features *features)
2203 struct wim_dentry *dentry;
2205 memset(features, 0, sizeof(struct wim_features));
2207 list_for_each_entry(dentry, dentry_list, extraction_list)
2208 dentry_tally_features(dentry, features);
2210 list_for_each_entry(dentry, dentry_list, extraction_list)
2211 dentry->d_inode->i_visited = 0;
2215 compute_supported_attributes_mask(const struct wim_features *supported_features)
2217 u32 mask = (u32)~0UL;
2219 if (!supported_features->archive_files)
2220 mask &= ~FILE_ATTRIBUTE_ARCHIVE;
2222 if (!supported_features->hidden_files)
2223 mask &= ~FILE_ATTRIBUTE_HIDDEN;
2225 if (!supported_features->system_files)
2226 mask &= ~FILE_ATTRIBUTE_SYSTEM;
2228 if (!supported_features->not_context_indexed_files)
2229 mask &= ~FILE_ATTRIBUTE_NOT_CONTENT_INDEXED;
2231 if (!supported_features->compressed_files)
2232 mask &= ~FILE_ATTRIBUTE_COMPRESSED;
2234 if (!supported_features->sparse_files)
2235 mask &= ~FILE_ATTRIBUTE_SPARSE_FILE;
2237 if (!supported_features->reparse_points)
2238 mask &= ~FILE_ATTRIBUTE_REPARSE_POINT;
2244 do_feature_check(const struct wim_features *required_features,
2245 const struct wim_features *supported_features,
2246 int extract_flags, const struct apply_operations *ops)
2248 /* File attributes. */
2249 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
2250 /* Note: Don't bother the user about FILE_ATTRIBUTE_ARCHIVE.
2251 * We're an archive program, so theoretically we can do what we
2254 if (required_features->hidden_files &&
2255 !supported_features->hidden_files)
2256 WARNING("Ignoring FILE_ATTRIBUTE_HIDDEN of %lu files",
2257 required_features->hidden_files);
2259 if (required_features->system_files &&
2260 !supported_features->system_files)
2261 WARNING("Ignoring FILE_ATTRIBUTE_SYSTEM of %lu files",
2262 required_features->system_files);
2264 if (required_features->compressed_files &&
2265 !supported_features->compressed_files)
2266 WARNING("Ignoring FILE_ATTRIBUTE_COMPRESSED of %lu files",
2267 required_features->compressed_files);
2269 if (required_features->not_context_indexed_files &&
2270 !supported_features->not_context_indexed_files)
2271 WARNING("Ignoring FILE_ATTRIBUTE_NOT_CONTENT_INDEXED of %lu files",
2272 required_features->not_context_indexed_files);
2274 if (required_features->sparse_files &&
2275 !supported_features->sparse_files)
2276 WARNING("Ignoring FILE_ATTRIBUTE_SPARSE_FILE of %lu files",
2277 required_features->sparse_files);
2279 if (required_features->encrypted_directories &&
2280 !supported_features->encrypted_directories)
2281 WARNING("Ignoring FILE_ATTRIBUTE_ENCRYPTED of %lu directories",
2282 required_features->encrypted_directories);
2285 /* Encrypted files. */
2286 if (required_features->encrypted_files &&
2287 !supported_features->encrypted_files)
2288 WARNING("Ignoring %lu encrypted files",
2289 required_features->encrypted_files);
2291 /* Named data streams. */
2292 if (required_features->named_data_streams &&
2293 (!supported_features->named_data_streams ||
2294 (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2295 WIMLIB_EXTRACT_FLAG_HARDLINK))))
2296 WARNING("Ignoring named data streams of %lu files",
2297 required_features->named_data_streams);
2300 if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
2301 !supported_features->hard_links)
2303 ERROR("Extraction backend does not support hard links!");
2304 return WIMLIB_ERR_UNSUPPORTED;
2306 if (required_features->hard_links && !supported_features->hard_links)
2307 WARNING("Extracting %lu hard links as independent files",
2308 required_features->hard_links);
2310 /* Symbolic links and reparse points. */
2311 if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
2312 !supported_features->symlink_reparse_points)
2314 ERROR("Extraction backend does not support symbolic links!");
2315 return WIMLIB_ERR_UNSUPPORTED;
2317 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
2318 required_features->symlink_reparse_points &&
2319 !supported_features->symlink_reparse_points &&
2320 !supported_features->reparse_points)
2322 ERROR("Extraction backend does not support symbolic links!");
2323 return WIMLIB_ERR_UNSUPPORTED;
2325 if (required_features->reparse_points &&
2326 !supported_features->reparse_points)
2328 if (supported_features->symlink_reparse_points) {
2329 if (required_features->other_reparse_points) {
2330 WARNING("Ignoring %lu non-symlink/junction "
2331 "reparse point files",
2332 required_features->other_reparse_points);
2335 WARNING("Ignoring %lu reparse point files",
2336 required_features->reparse_points);
2340 /* Security descriptors. */
2341 if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
2342 WIMLIB_EXTRACT_FLAG_UNIX_DATA))
2343 == WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
2344 required_features->security_descriptors &&
2345 !supported_features->security_descriptors)
2347 ERROR("Extraction backend does not support security descriptors!");
2348 return WIMLIB_ERR_UNSUPPORTED;
2350 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) &&
2351 required_features->security_descriptors &&
2352 !supported_features->security_descriptors)
2353 WARNING("Ignoring Windows NT security descriptors of %lu files",
2354 required_features->security_descriptors);
2357 if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
2358 required_features->unix_data && !supported_features->unix_data)
2360 ERROR("Extraction backend does not support UNIX data!");
2361 return WIMLIB_ERR_UNSUPPORTED;
2365 if (required_features->short_names &&
2366 !supported_features->short_names)
2368 if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) {
2369 ERROR("Extraction backend does not support DOS names!");
2370 return WIMLIB_ERR_UNSUPPORTED;
2372 WARNING("Ignoring DOS names of %lu files",
2373 required_features->short_names);
2377 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
2378 !ops->set_timestamps)
2380 ERROR("Extraction backend does not support timestamps!");
2381 return WIMLIB_ERR_UNSUPPORTED;
2388 do_extract_warnings(struct apply_ctx *ctx)
2390 if (ctx->partial_security_descriptors == 0 &&
2391 ctx->no_security_descriptors == 0)
2394 WARNING("Extraction to \"%"TS"\" complete, but with one or more warnings:",
2396 if (ctx->partial_security_descriptors != 0) {
2397 WARNING("- Could only partially set the security descriptor\n"
2398 " on %lu files or directories.",
2399 ctx->partial_security_descriptors);
2401 if (ctx->no_security_descriptors != 0) {
2402 WARNING("- Could not set security descriptor at all\n"
2403 " on %lu files or directories.",
2404 ctx->no_security_descriptors);
2407 WARNING("To fully restore all security descriptors, run the program\n"
2408 " with Administrator rights.");
2413 destroy_dentry_list(struct list_head *dentry_list)
2415 struct wim_dentry *dentry, *tmp;
2416 struct wim_inode *inode;
2418 list_for_each_entry_safe(dentry, tmp, dentry_list, extraction_list) {
2419 inode = dentry->d_inode;
2420 dentry_reset_extraction_list_node(dentry);
2421 dentry->was_linked = 0;
2422 dentry->skeleton_extracted = 0;
2423 inode->i_visited = 0;
2424 FREE(inode->i_extracted_file);
2425 inode->i_extracted_file = NULL;
2426 inode->i_dos_name_extracted = 0;
2427 if ((void*)dentry->extraction_name != (void*)dentry->file_name)
2428 FREE(dentry->extraction_name);
2429 dentry->extraction_name = NULL;
2434 destroy_stream_list(struct list_head *stream_list)
2436 struct wim_lookup_table_entry *lte;
2438 list_for_each_entry(lte, stream_list, extraction_list)
2439 if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
2440 FREE(lte->lte_dentries);
2444 extract_trees(WIMStruct *wim, struct wim_dentry **trees, size_t num_trees,
2445 const tchar *target, int extract_flags,
2446 wimlib_progress_func_t progress_func)
2449 struct apply_ctx ctx;
2450 struct list_head dentry_list;
2451 struct wim_features required_features;
2453 /* Handle stdout extraction as a separate case. */
2454 if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
2455 return extract_dentries_to_stdout(trees, num_trees,
2458 /* Start initializing the apply_ctx. */
2459 memset(&ctx, 0, sizeof(struct apply_ctx));
2461 ctx.extract_flags = extract_flags;
2462 ctx.target = target;
2463 ctx.target_nchars = tstrlen(target);
2464 ctx.progress_func = progress_func;
2465 if (progress_func) {
2466 ctx.progress.extract.wimfile_name = wim->filename;
2467 ctx.progress.extract.image = wim->current_image;
2468 ctx.progress.extract.extract_flags = (extract_flags &
2469 WIMLIB_EXTRACT_MASK_PUBLIC);
2470 ctx.progress.extract.image_name = wimlib_get_image_name(wim,
2471 wim->current_image);
2472 ctx.progress.extract.target = target;
2475 ctx.target_dentry = wim_get_current_root_dentry(wim);
2476 /* Note: ctx.target_dentry represents the dentry that gets extracted to
2477 * @target. There may be none, in which case it gets set to the image
2478 * root and never matches any of the dentries actually being extracted.
2481 num_trees = remove_duplicate_trees(trees, num_trees);
2483 /* All trees are now distinct. */
2485 num_trees = remove_contained_trees(trees, num_trees);
2487 /* All trees are now distinct and non-overlapping. */
2489 /* Build list of dentries to be extracted. */
2490 build_dentry_list(&dentry_list, trees, num_trees,
2491 !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE));
2493 /* Select the appropriate apply_operations based on the platform and
2495 ctx.ops = select_apply_operations(extract_flags);
2497 /* Figure out whether the root dentry is being extracted to the root of
2498 * a volume and therefore needs to be treated "specially", for example
2499 * not being explicitly created and not having attributes set. */
2500 if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
2501 ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
2503 /* Call the start_extract() callback. This gives the apply_operations
2504 * implementation a chance to do any setup needed to access the volume.
2505 * Furthermore, start_extract() is expected to set the supported
2506 * features of this extraction mode (ctx.supported_features), which are
2507 * determined at runtime as they may vary depending on the actual
2509 ret = ctx.ops->start_extract(target, &ctx);
2511 goto out_destroy_dentry_list;
2513 /* Get and check the features required to extract the dentries. */
2514 dentry_list_get_features(&dentry_list, &required_features);
2515 ret = do_feature_check(&required_features, &ctx.supported_features,
2516 extract_flags, ctx.ops);
2518 goto out_finish_or_abort_extract;
2520 ctx.supported_attributes_mask =
2521 compute_supported_attributes_mask(&ctx.supported_features);
2523 /* Calculate extraction name for each dentry and remove subtrees that
2524 * can't be extracted due to naming problems. */
2525 ret = dentry_list_calculate_extraction_names(&dentry_list, &ctx);
2527 goto out_finish_or_abort_extract;
2529 /* Build list of streams to extract. */
2530 ret = dentry_list_resolve_streams(&dentry_list, &ctx);
2532 goto out_finish_or_abort_extract;
2533 INIT_LIST_HEAD(&ctx.stream_list);
2534 ret = dentry_list_ref_streams(&dentry_list, &ctx);
2536 goto out_destroy_stream_list;
2538 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2539 /* When extracting from a pipe, the number of bytes of data to
2540 * extract can't be determined in the normal way (examining the
2541 * lookup table), since at this point all we have is a set of
2542 * SHA1 message digests of streams that need to be extracted.
2543 * However, we can get a reasonably accurate estimate by taking
2544 * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
2545 * data. This does assume that a full image is being extracted,
2546 * but currently there is no API for doing otherwise. (Also,
2547 * subtract <HARDLINKBYTES> from this if hard links are
2548 * supported by the extraction mode.) */
2549 ctx.progress.extract.total_bytes =
2550 wim_info_get_image_total_bytes(wim->wim_info,
2551 wim->current_image);
2552 if (ctx.supported_features.hard_links) {
2553 ctx.progress.extract.total_bytes -=
2554 wim_info_get_image_hard_link_bytes(wim->wim_info,
2555 wim->current_image);
2559 if (ctx.ops->realpath_works_on_nonexisting_files &&
2560 ((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
2561 ctx.ops->requires_realtarget_in_paths))
2563 ctx.realtarget = realpath(target, NULL);
2564 if (!ctx.realtarget) {
2565 ret = WIMLIB_ERR_NOMEM;
2566 goto out_destroy_stream_list;
2568 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2570 /* Strip trailing slashes. If we don't do this, we may create a
2571 * path with multiple consecutive backslashes, which for some
2572 * reason causes Windows to report that the file cannot be found.
2574 while (ctx.realtarget_nchars >= 2
2575 && ctx.realtarget[ctx.realtarget_nchars - 1] == L'\\'
2576 && ctx.realtarget[ctx.realtarget_nchars - 2] != L':')
2578 ctx.realtarget[--ctx.realtarget_nchars] = L'\0';
2583 if (progress_func) {
2585 if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2586 msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
2588 msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN;
2589 progress_func(msg, &ctx.progress);
2592 if (!ctx.root_dentry_is_special) {
2593 tchar path[ctx.ops->path_max];
2594 if (build_extraction_path(path, ctx.target_dentry, &ctx)) {
2595 ret = extract_inode(path, &ctx, ctx.target_dentry->d_inode);
2597 goto out_free_realtarget;
2601 /* If we need to fix up the targets of absolute symbolic links
2602 * (WIMLIB_EXTRACT_FLAG_RPFIX) or the extraction mode requires paths to
2603 * be absolute, use realpath() (or its replacement on Windows) to get
2604 * the absolute path to the extraction target. Note that this requires
2605 * the target directory to exist, unless
2606 * realpath_works_on_nonexisting_files is set in the apply_operations.
2608 if (!ctx.realtarget &&
2609 (((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
2610 required_features.symlink_reparse_points) ||
2611 ctx.ops->requires_realtarget_in_paths))
2613 ctx.realtarget = realpath(target, NULL);
2614 if (!ctx.realtarget) {
2615 ret = WIMLIB_ERR_NOMEM;
2616 goto out_free_realtarget;
2618 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2621 if (ctx.ops->requires_short_name_reordering) {
2623 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2625 ret = extract_dir_structure(&dentry_list, &ctx);
2627 goto out_free_realtarget;
2630 /* Finally, the important part: extract the tree of files. */
2631 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
2632 /* Sequential extraction requested, so two passes are needed
2633 * (one for file structure, one for streams.) */
2634 if (progress_func && !ctx.ops->requires_short_name_reordering)
2635 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2638 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
2639 ret = extract_structure(&dentry_list, &ctx);
2641 goto out_free_realtarget;
2644 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2646 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
2647 ret = extract_streams_from_pipe(&ctx);
2649 ret = extract_stream_list(&ctx);
2651 goto out_free_realtarget;
2653 /* Sequential extraction was not requested, so we can make do
2654 * with one pass where we both create the files and extract
2656 if (progress_func && !ctx.ops->requires_short_name_reordering)
2657 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2659 ret = extract_dentries(&dentry_list, &ctx);
2661 goto out_free_realtarget;
2663 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2667 /* If the total number of bytes to extract was miscalculated, just jump
2668 * to the calculated number in order to avoid confusing the progress
2669 * function. This should only occur when extracting from a pipe. */
2670 if (ctx.progress.extract.completed_bytes != ctx.progress.extract.total_bytes)
2672 DEBUG("Calculated %"PRIu64" bytes to extract, but actually "
2673 "extracted %"PRIu64,
2674 ctx.progress.extract.total_bytes,
2675 ctx.progress.extract.completed_bytes);
2677 if (progress_func &&
2678 ctx.progress.extract.completed_bytes < ctx.progress.extract.total_bytes)
2680 ctx.progress.extract.completed_bytes = ctx.progress.extract.total_bytes;
2681 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &ctx.progress);
2684 /* Apply security descriptors and timestamps. This is done at the end,
2685 * and in a depth-first manner, to prevent timestamps from getting
2686 * changed by subsequent extract operations and to minimize the chance
2687 * of the restored security descriptors getting in our way. */
2689 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
2691 ret = extract_final_metadata(&dentry_list, &ctx);
2693 goto out_free_realtarget;
2695 if (progress_func) {
2697 if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2698 msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END;
2700 msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END;
2701 progress_func(msg, &ctx.progress);
2703 do_extract_warnings(&ctx);
2705 out_free_realtarget:
2706 FREE(ctx.realtarget);
2707 out_destroy_stream_list:
2708 if (!(ctx.extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER))
2709 destroy_stream_list(&ctx.stream_list);
2710 out_finish_or_abort_extract:
2712 if (ctx.ops->abort_extract)
2713 ctx.ops->abort_extract(&ctx);
2715 if (ctx.ops->finish_extract)
2716 ret = ctx.ops->finish_extract(&ctx);
2718 out_destroy_dentry_list:
2719 destroy_dentry_list(&dentry_list);
2724 mkdir_if_needed(const tchar *target)
2727 if (tstat(target, &stbuf)) {
2728 if (errno == ENOENT) {
2729 if (tmkdir(target, 0755)) {
2730 ERROR_WITH_ERRNO("Failed to create directory "
2731 "\"%"TS"\"", target);
2732 return WIMLIB_ERR_MKDIR;
2735 ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
2736 return WIMLIB_ERR_STAT;
2738 } else if (!S_ISDIR(stbuf.st_mode)) {
2739 ERROR("\"%"TS"\" is not a directory", target);
2740 return WIMLIB_ERR_NOTDIR;
2745 /* Make sure the extraction flags make sense, and update them if needed. */
2747 check_extract_flags(const WIMStruct *wim, int *extract_flags_p)
2749 int extract_flags = *extract_flags_p;
2751 /* Check for invalid flag combinations */
2752 if ((extract_flags &
2753 (WIMLIB_EXTRACT_FLAG_SYMLINK |
2754 WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
2755 WIMLIB_EXTRACT_FLAG_HARDLINK))
2756 return WIMLIB_ERR_INVALID_PARAM;
2758 if ((extract_flags &
2759 (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2760 WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2761 WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2762 return WIMLIB_ERR_INVALID_PARAM;
2764 if ((extract_flags &
2765 (WIMLIB_EXTRACT_FLAG_RPFIX |
2766 WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
2767 WIMLIB_EXTRACT_FLAG_NORPFIX))
2768 return WIMLIB_ERR_INVALID_PARAM;
2770 if ((extract_flags &
2771 (WIMLIB_EXTRACT_FLAG_RESUME |
2772 WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
2773 return WIMLIB_ERR_INVALID_PARAM;
2775 #ifndef WITH_NTFS_3G
2776 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2777 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
2778 " it cannot apply a WIM image directly to an NTFS volume.");
2779 return WIMLIB_ERR_UNSUPPORTED;
2784 if (extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
2785 ERROR("WIMBoot extraction is only supported on Windows!");
2786 return WIMLIB_ERR_UNSUPPORTED;
2790 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
2791 WIMLIB_EXTRACT_FLAG_NORPFIX |
2792 WIMLIB_EXTRACT_FLAG_IMAGEMODE)) ==
2793 WIMLIB_EXTRACT_FLAG_IMAGEMODE)
2795 /* For full-image extraction, do reparse point fixups by default
2796 * if the WIM header says they are enabled. */
2797 if (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
2798 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
2801 /* TODO: Since UNIX data entries are stored in the file resources, in a
2802 * completely sequential extraction they may come up before the
2803 * corresponding file or symbolic link data. This needs to be handled
2805 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2806 WIMLIB_EXTRACT_FLAG_FILE_ORDER))
2807 == WIMLIB_EXTRACT_FLAG_UNIX_DATA)
2809 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2810 WARNING("Setting UNIX file/owner group may "
2811 "be impossible on some\n"
2813 "when applying from a pipe.");
2815 extract_flags |= WIMLIB_EXTRACT_FLAG_FILE_ORDER;
2816 WARNING("Disabling sequential extraction for "
2821 *extract_flags_p = extract_flags;
2826 get_wildcard_flags(int extract_flags)
2828 u32 wildcard_flags = 0;
2830 if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_GLOB)
2831 wildcard_flags |= WILDCARD_FLAG_ERROR_IF_NO_MATCH;
2833 wildcard_flags |= WILDCARD_FLAG_WARN_IF_NO_MATCH;
2835 if (default_ignore_case)
2836 wildcard_flags |= WILDCARD_FLAG_CASE_INSENSITIVE;
2838 return wildcard_flags;
2841 struct append_dentry_ctx {
2842 struct wim_dentry **dentries;
2843 size_t num_dentries;
2844 size_t num_alloc_dentries;
2848 append_dentry_cb(struct wim_dentry *dentry, void *_ctx)
2850 struct append_dentry_ctx *ctx = _ctx;
2852 if (ctx->num_dentries == ctx->num_alloc_dentries) {
2853 struct wim_dentry **new_dentries;
2856 new_length = max(ctx->num_alloc_dentries + 8,
2857 ctx->num_alloc_dentries * 3 / 2);
2858 new_dentries = REALLOC(ctx->dentries,
2859 new_length * sizeof(ctx->dentries[0]));
2860 if (new_dentries == NULL)
2861 return WIMLIB_ERR_NOMEM;
2862 ctx->dentries = new_dentries;
2863 ctx->num_alloc_dentries = new_length;
2865 ctx->dentries[ctx->num_dentries++] = dentry;
2870 do_wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
2871 const tchar * const *paths, size_t num_paths,
2872 int extract_flags, wimlib_progress_func_t progress_func)
2875 struct wim_dentry **trees;
2878 if (wim == NULL || target == NULL || target[0] == T('\0') ||
2879 (num_paths != 0 && paths == NULL))
2880 return WIMLIB_ERR_INVALID_PARAM;
2882 ret = check_extract_flags(wim, &extract_flags);
2886 ret = select_wim_image(wim, image);
2890 ret = wim_checksum_unhashed_streams(wim);
2894 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_NTFS |
2895 WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE)) ==
2896 (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE))
2898 ret = mkdir_if_needed(target);
2903 if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS) {
2905 struct append_dentry_ctx append_dentry_ctx = {
2908 .num_alloc_dentries = 0,
2911 u32 wildcard_flags = get_wildcard_flags(extract_flags);
2913 for (size_t i = 0; i < num_paths; i++) {
2914 tchar *path = canonicalize_wim_path(paths[i]);
2916 ret = WIMLIB_ERR_NOMEM;
2917 trees = append_dentry_ctx.dentries;
2918 goto out_free_trees;
2920 ret = expand_wildcard(wim, path,
2926 trees = append_dentry_ctx.dentries;
2927 goto out_free_trees;
2930 trees = append_dentry_ctx.dentries;
2931 num_trees = append_dentry_ctx.num_dentries;
2933 trees = MALLOC(num_paths * sizeof(trees[0]));
2935 return WIMLIB_ERR_NOMEM;
2937 for (size_t i = 0; i < num_paths; i++) {
2939 tchar *path = canonicalize_wim_path(paths[i]);
2941 ret = WIMLIB_ERR_NOMEM;
2942 goto out_free_trees;
2945 trees[i] = get_dentry(wim, path,
2946 WIMLIB_CASE_PLATFORM_DEFAULT);
2948 if (trees[i] == NULL) {
2949 ERROR("Path \"%"TS"\" does not exist "
2951 paths[i], wim->current_image);
2952 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
2953 goto out_free_trees;
2956 num_trees = num_paths;
2959 if (num_trees == 0) {
2961 goto out_free_trees;
2964 ret = extract_trees(wim, trees, num_trees,
2965 target, extract_flags, progress_func);
2972 extract_single_image(WIMStruct *wim, int image,
2973 const tchar *target, int extract_flags,
2974 wimlib_progress_func_t progress_func)
2976 const tchar *path = WIMLIB_WIM_ROOT_PATH;
2977 extract_flags |= WIMLIB_EXTRACT_FLAG_IMAGEMODE;
2978 return do_wimlib_extract_paths(wim, image, target, &path, 1,
2979 extract_flags, progress_func);
2982 static const tchar * const filename_forbidden_chars =
2991 /* This function checks if it is okay to use a WIM image's name as a directory
2994 image_name_ok_as_dir(const tchar *image_name)
2996 return image_name && *image_name &&
2997 !tstrpbrk(image_name, filename_forbidden_chars) &&
2998 tstrcmp(image_name, T(".")) &&
2999 tstrcmp(image_name, T(".."));
3002 /* Extracts all images from the WIM to the directory @target, with the images
3003 * placed in subdirectories named by their image names. */
3005 extract_all_images(WIMStruct *wim,
3006 const tchar *target,
3008 wimlib_progress_func_t progress_func)
3010 size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
3011 size_t output_path_len = tstrlen(target);
3012 tchar buf[output_path_len + 1 + image_name_max_len + 1];
3015 const tchar *image_name;
3017 extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
3019 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
3020 ERROR("Cannot extract multiple images in NTFS extraction mode.");
3021 return WIMLIB_ERR_INVALID_PARAM;
3024 ret = mkdir_if_needed(target);
3027 tmemcpy(buf, target, output_path_len);
3028 buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
3029 for (image = 1; image <= wim->hdr.image_count; image++) {
3030 image_name = wimlib_get_image_name(wim, image);
3031 if (image_name_ok_as_dir(image_name)) {
3032 tstrcpy(buf + output_path_len + 1, image_name);
3034 /* Image name is empty or contains forbidden characters.
3035 * Use image number instead. */
3036 tsprintf(buf + output_path_len + 1, T("%d"), image);
3038 ret = extract_single_image(wim, image, buf, extract_flags,
3047 clear_lte_extracted_file(WIMStruct *wim, int extract_flags)
3049 if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
3050 WIMLIB_EXTRACT_FLAG_HARDLINK)))
3051 for_lookup_table_entry(wim->lookup_table,
3052 lte_free_extracted_file, NULL);
3056 do_wimlib_extract_image(WIMStruct *wim,
3058 const tchar *target,
3060 wimlib_progress_func_t progress_func)
3064 if (extract_flags & (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE |
3065 WIMLIB_EXTRACT_FLAG_TO_STDOUT |
3066 WIMLIB_EXTRACT_FLAG_GLOB_PATHS))
3067 return WIMLIB_ERR_INVALID_PARAM;
3069 if (image == WIMLIB_ALL_IMAGES)
3070 ret = extract_all_images(wim, target, extract_flags,
3073 ret = extract_single_image(wim, image, target, extract_flags,
3076 clear_lte_extracted_file(wim, extract_flags);
3081 /****************************************************************************
3083 ****************************************************************************/
3086 wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
3087 const tchar * const *paths, size_t num_paths,
3088 int extract_flags, wimlib_progress_func_t progress_func)
3092 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3093 return WIMLIB_ERR_INVALID_PARAM;
3095 ret = do_wimlib_extract_paths(wim, image, target, paths, num_paths,
3096 extract_flags, progress_func);
3097 clear_lte_extracted_file(wim, extract_flags);
3102 wimlib_extract_pathlist(WIMStruct *wim, int image, const tchar *target,
3103 const tchar *path_list_file, int extract_flags,
3104 wimlib_progress_func_t progress_func)
3111 ret = read_path_list_file(path_list_file, &paths, &num_paths, &mem);
3113 ERROR("Failed to read path list file \"%"TS"\"",
3118 ret = wimlib_extract_paths(wim, image, target,
3119 (const tchar * const *)paths, num_paths,
3120 extract_flags, progress_func);
3127 wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
3128 const tchar *target, int extract_flags,
3129 wimlib_progress_func_t progress_func)
3133 struct filedes *in_fd;
3137 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3138 return WIMLIB_ERR_INVALID_PARAM;
3140 if (extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)
3141 return WIMLIB_ERR_INVALID_PARAM;
3143 /* Read the WIM header from the pipe and get a WIMStruct to represent
3144 * the pipable WIM. Caveats: Unlike getting a WIMStruct with
3145 * wimlib_open_wim(), getting a WIMStruct in this way will result in
3146 * an empty lookup table, no XML data read, and no filename set. */
3147 ret = open_wim_as_WIMStruct(&pipe_fd,
3148 WIMLIB_OPEN_FLAG_FROM_PIPE,
3149 &pwm, progress_func);
3153 /* Sanity check to make sure this is a pipable WIM. */
3154 if (pwm->hdr.magic != PWM_MAGIC) {
3155 ERROR("The WIM being read from file descriptor %d "
3156 "is not pipable!", pipe_fd);
3157 ret = WIMLIB_ERR_NOT_PIPABLE;
3158 goto out_wimlib_free;
3161 /* Sanity check to make sure the first part of a pipable split WIM is
3162 * sent over the pipe first. */
3163 if (pwm->hdr.part_number != 1) {
3164 ERROR("The first part of the split WIM must be "
3165 "sent over the pipe first.");
3166 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3167 goto out_wimlib_free;
3170 in_fd = &pwm->in_fd;
3171 wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
3173 /* As mentioned, the WIMStruct we created from the pipe does not have
3174 * XML data yet. Fix this by reading the extra copy of the XML data
3175 * that directly follows the header in pipable WIMs. (Note: see
3176 * write_pipable_wim() for more details about the format of pipable
3179 struct wim_lookup_table_entry xml_lte;
3180 struct wim_resource_spec xml_rspec;
3181 ret = read_pwm_stream_header(pwm, &xml_lte, &xml_rspec, 0, NULL);
3183 goto out_wimlib_free;
3185 if (!(xml_lte.flags & WIM_RESHDR_FLAG_METADATA))
3187 ERROR("Expected XML data, but found non-metadata "
3189 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3190 goto out_wimlib_free;
3193 wim_res_spec_to_hdr(&xml_rspec, &pwm->hdr.xml_data_reshdr);
3195 ret = read_wim_xml_data(pwm);
3197 goto out_wimlib_free;
3199 if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
3200 ERROR("Image count in XML data is not the same as in WIM header.");
3201 ret = WIMLIB_ERR_IMAGE_COUNT;
3202 goto out_wimlib_free;
3206 /* Get image index (this may use the XML data that was just read to
3207 * resolve an image name). */
3208 if (image_num_or_name) {
3209 image = wimlib_resolve_image(pwm, image_num_or_name);
3210 if (image == WIMLIB_NO_IMAGE) {
3211 ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
3213 ret = WIMLIB_ERR_INVALID_IMAGE;
3214 goto out_wimlib_free;
3215 } else if (image == WIMLIB_ALL_IMAGES) {
3216 ERROR("Applying all images from a pipe is not supported!");
3217 ret = WIMLIB_ERR_INVALID_IMAGE;
3218 goto out_wimlib_free;
3221 if (pwm->hdr.image_count != 1) {
3222 ERROR("No image was specified, but the pipable WIM "
3223 "did not contain exactly 1 image");
3224 ret = WIMLIB_ERR_INVALID_IMAGE;
3225 goto out_wimlib_free;
3230 /* Load the needed metadata resource. */
3231 for (i = 1; i <= pwm->hdr.image_count; i++) {
3232 struct wim_lookup_table_entry *metadata_lte;
3233 struct wim_image_metadata *imd;
3234 struct wim_resource_spec *metadata_rspec;
3236 metadata_lte = new_lookup_table_entry();
3237 if (metadata_lte == NULL) {
3238 ret = WIMLIB_ERR_NOMEM;
3239 goto out_wimlib_free;
3241 metadata_rspec = MALLOC(sizeof(struct wim_resource_spec));
3242 if (metadata_rspec == NULL) {
3243 ret = WIMLIB_ERR_NOMEM;
3244 free_lookup_table_entry(metadata_lte);
3245 goto out_wimlib_free;
3248 ret = read_pwm_stream_header(pwm, metadata_lte, metadata_rspec, 0, NULL);
3249 imd = pwm->image_metadata[i - 1];
3250 imd->metadata_lte = metadata_lte;
3252 FREE(metadata_rspec);
3253 goto out_wimlib_free;
3256 if (!(metadata_lte->flags & WIM_RESHDR_FLAG_METADATA)) {
3257 ERROR("Expected metadata resource, but found "
3258 "non-metadata stream.");
3259 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
3260 goto out_wimlib_free;
3264 /* Metadata resource is for the image being extracted.
3265 * Parse it and save the metadata in memory. */
3266 ret = read_metadata_resource(pwm, imd);
3268 goto out_wimlib_free;
3271 /* Metadata resource is not for the image being
3272 * extracted. Skip over it. */
3273 ret = skip_wim_stream(metadata_lte);
3275 goto out_wimlib_free;
3278 /* Extract the image. */
3279 extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
3280 ret = do_wimlib_extract_image(pwm, image, target,
3281 extract_flags, progress_func);
3282 /* Clean up and return. */
3289 wimlib_extract_image(WIMStruct *wim, int image, const tchar *target,
3290 int extract_flags, wimlib_progress_func_t progress_func)
3292 if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
3293 return WIMLIB_ERR_INVALID_PARAM;
3294 return do_wimlib_extract_image(wim, image, target, extract_flags,