4 * Support for extracting WIM images, or files or directories contained in a WIM
9 * Copyright (C) 2012, 2013 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_files(), and wimlib_extract_image_from_pipe(). Internally,
30 * all end up calling extract_tree() zero or more times to extract a tree of
31 * files from the currently selected WIM image to the specified target directory
34 * Although wimlib supports multiple extraction modes/backends (NTFS-3g, UNIX,
35 * Win32), this file does not itself have code to extract files or directories
36 * to any specific target; instead, it handles generic functionality and relies
37 * on lower-level callback functions declared in `struct apply_operations' to do
38 * the actual extraction.
45 #include "wimlib/apply.h"
46 #include "wimlib/dentry.h"
47 #include "wimlib/encoding.h"
48 #include "wimlib/endianness.h"
49 #include "wimlib/error.h"
50 #include "wimlib/lookup_table.h"
51 #include "wimlib/metadata.h"
52 #include "wimlib/paths.h"
53 #include "wimlib/reparse.h"
54 #include "wimlib/resource.h"
55 #include "wimlib/security.h"
57 # include "wimlib/win32.h" /* for realpath() equivalent */
59 #include "wimlib/xml.h"
60 #include "wimlib/wim.h"
68 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
69 #define WIMLIB_EXTRACT_FLAG_FROM_PIPE 0x40000000
70 #define WIMLIB_EXTRACT_MASK_PUBLIC 0x3fffffff
72 /* Given a WIM dentry in the tree to be extracted, resolve all streams in the
73 * corresponding inode and set 'out_refcnt' in each to 0. */
75 dentry_resolve_and_zero_lte_refcnt(struct wim_dentry *dentry, void *_ctx)
77 struct apply_ctx *ctx = _ctx;
78 struct wim_inode *inode = dentry->d_inode;
79 struct wim_lookup_table_entry *lte;
83 if (dentry->extraction_skipped)
86 /* Special case: when extracting from a pipe, the WIM lookup table is
87 * initially empty, so "resolving" an inode's streams is initially not
88 * possible. However, we still need to keep track of which streams,
89 * identified by SHA1 message digests, need to be extracted, so we
90 * "resolve" the inode's streams anyway by allocating new entries. */
91 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
93 ret = inode_resolve_ltes(inode, ctx->wim->lookup_table, force);
96 for (unsigned i = 0; i <= inode->i_num_ads; i++) {
97 lte = inode_stream_lte_resolved(inode, i);
105 is_linked_extraction(const struct apply_ctx *ctx)
107 return 0 != (ctx->extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
108 WIMLIB_EXTRACT_FLAG_SYMLINK));
112 can_extract_named_data_streams(const struct apply_ctx *ctx)
114 return ctx->supported_features.named_data_streams &&
115 !is_linked_extraction(ctx);
119 ref_stream_to_extract(struct wim_lookup_table_entry *lte,
120 struct wim_dentry *dentry, struct apply_ctx *ctx)
125 /* Tally the size only for each extraction of the stream (not hard
127 if (!(dentry->d_inode->i_visited &&
128 ctx->supported_features.hard_links) &&
129 (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
130 lte->extracted_file == NULL)))
132 ctx->progress.extract.total_bytes += lte->size;
133 ctx->progress.extract.num_streams++;
136 /* Add stream to the extraction_list only one time, even if it's going
137 * to be extracted to multiple locations. */
138 if (lte->out_refcnt == 0) {
139 list_add_tail(<e->extraction_list, &ctx->stream_list);
140 ctx->num_streams_remaining++;
143 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
144 struct wim_dentry **lte_dentries;
146 /* Append dentry to this stream's array of dentries referencing
147 * it. Use inline array to avoid memory allocation until the
148 * number of dentries becomes too large. */
149 if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
150 lte_dentries = lte->inline_lte_dentries;
152 struct wim_dentry **prev_lte_dentries;
153 size_t alloc_lte_dentries;
155 if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
156 prev_lte_dentries = NULL;
157 alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
159 prev_lte_dentries = lte->lte_dentries;
160 alloc_lte_dentries = lte->alloc_lte_dentries;
163 if (lte->out_refcnt == alloc_lte_dentries) {
164 alloc_lte_dentries *= 2;
165 lte_dentries = REALLOC(prev_lte_dentries,
167 sizeof(lte_dentries[0]));
169 return WIMLIB_ERR_NOMEM;
170 if (prev_lte_dentries == NULL) {
172 lte->inline_lte_dentries,
173 sizeof(lte->inline_lte_dentries));
175 lte->lte_dentries = lte_dentries;
176 lte->alloc_lte_dentries = alloc_lte_dentries;
178 lte_dentries = lte->lte_dentries;
180 lte_dentries[lte->out_refcnt] = dentry;
186 /* Given a WIM dentry in the tree to be extracted, iterate through streams that
187 * need to be extracted. For each one, add it to the list of streams to be
188 * extracted (ctx->stream_list) if not already done so, and also update the
189 * progress information (ctx->progress) with the stream. Furthermore, if doing
190 * a sequential extraction, build a mapping from each the stream to the dentries
193 * This uses the i_visited member of the inodes (assumed to be 0 initially). */
195 dentry_add_streams_to_extract(struct wim_dentry *dentry, void *_ctx)
197 struct apply_ctx *ctx = _ctx;
198 struct wim_inode *inode = dentry->d_inode;
201 /* Don't process dentries marked as skipped. */
202 if (dentry->extraction_skipped)
205 /* The unnamed data stream will always be extracted, except in an
207 if (!inode_is_encrypted_directory(inode)) {
208 ret = ref_stream_to_extract(inode_unnamed_lte_resolved(inode),
214 /* Named data streams will be extracted only if supported in the current
215 * extraction mode and volume, and to avoid complications, if not doing
216 * a linked extraction. */
217 if (can_extract_named_data_streams(ctx)) {
218 for (u16 i = 0; i < inode->i_num_ads; i++) {
219 if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
221 ret = ref_stream_to_extract(inode->i_ads_entries[i].lte,
227 inode->i_visited = 1;
231 /* Inform library user of progress of stream extraction following the successful
232 * extraction of a copy of the stream specified by @lte. */
234 update_extract_progress(struct apply_ctx *ctx,
235 const struct wim_lookup_table_entry *lte)
237 wimlib_progress_func_t progress_func = ctx->progress_func;
238 union wimlib_progress_info *progress = &ctx->progress;
240 progress->extract.completed_bytes += lte->size;
242 progress->extract.completed_bytes >= ctx->next_progress)
244 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, progress);
245 if (progress->extract.completed_bytes >=
246 progress->extract.total_bytes)
248 ctx->next_progress = ~0ULL;
250 ctx->next_progress += progress->extract.total_bytes / 128;
251 if (ctx->next_progress > progress->extract.total_bytes)
252 ctx->next_progress = progress->extract.total_bytes;
258 /* Extract a symbolic link (not directly as reparse data), handling fixing up
259 * the target of absolute symbolic links and updating the extract progress.
261 * @inode must specify the WIM inode for a symbolic link or junction reparse
264 * @lte_override overrides the resource used as the reparse data for the
267 extract_symlink(const tchar *path, struct apply_ctx *ctx,
268 struct wim_inode *inode,
269 struct wim_lookup_table_entry *lte_override)
271 ssize_t bufsize = ctx->ops->path_max;
272 tchar target[bufsize];
278 /* If absolute symbolic link fixups requested, reserve space in the link
279 * target buffer for the absolute path of the target directory. */
280 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
282 buf += ctx->realtarget_nchars;
283 bufsize -= ctx->realtarget_nchars;
286 /* Translate the WIM inode's reparse data into the link target. */
287 sret = wim_inode_readlink(inode, buf, bufsize - 1, lte_override);
290 return WIMLIB_ERR_READLINK;
294 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
297 /* Fix absolute symbolic link target to point into the
298 * actual extraction destination. */
299 tmemcpy(target, ctx->realtarget, ctx->realtarget_nchars);
300 fixed_target = target;
302 /* Keep same link target. */
306 /* Call into the apply_operations to create the symbolic link. */
307 DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
309 ret = ctx->ops->create_symlink(fixed_target, path, ctx);
311 ERROR_WITH_ERRNO("Failed to create symlink "
312 "\"%"TS"\" => \"%"TS"\"", path, fixed_target);
316 /* Account for reparse data consumed. */
317 update_extract_progress(ctx,
318 (lte_override ? lte_override :
319 inode_unnamed_lte_resolved(inode)));
322 #endif /* !__WIN32__ */
324 /* Create a file, directory, or symbolic link. */
326 extract_inode(const tchar *path, struct apply_ctx *ctx, struct wim_inode *inode)
331 if (ctx->supported_features.symlink_reparse_points &&
332 !ctx->supported_features.reparse_points &&
333 inode_is_symlink(inode))
335 ret = extract_symlink(path, ctx, inode, NULL);
337 #endif /* !__WIN32__ */
338 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
339 ret = ctx->ops->create_directory(path, ctx, &inode->extract_cookie);
341 ERROR_WITH_ERRNO("Failed to create the directory "
344 } else if ((inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
345 ctx->ops->extract_encrypted_stream_creates_file &&
346 ctx->supported_features.encrypted_files) {
347 ret = ctx->ops->extract_encrypted_stream(
348 path, inode_unnamed_lte_resolved(inode), ctx);
350 ERROR_WITH_ERRNO("Failed to create and extract "
351 "encrypted file \"%"TS"\"", path);
354 ret = ctx->ops->create_file(path, ctx, &inode->extract_cookie);
356 ERROR_WITH_ERRNO("Failed to create the file "
364 extract_hardlink(const tchar *oldpath, const tchar *newpath,
365 struct apply_ctx *ctx)
369 DEBUG("Creating hardlink \"%"TS"\" => \"%"TS"\"", newpath, oldpath);
370 ret = ctx->ops->create_hardlink(oldpath, newpath, ctx);
372 ERROR_WITH_ERRNO("Failed to create hardlink "
373 "\"%"TS"\" => \"%"TS"\"",
381 try_extract_rpfix(u8 *rpbuf,
383 const wchar_t *extract_root_realpath,
384 unsigned extract_root_realpath_nchars)
386 struct reparse_data rpdata;
388 size_t target_nchars;
389 size_t stripped_nchars;
390 wchar_t *stripped_target;
391 wchar_t stripped_target_nchars;
394 utf16lechar *new_target;
395 utf16lechar *new_print_name;
396 size_t new_target_nchars;
397 size_t new_print_name_nchars;
400 ret = parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata);
404 if (extract_root_realpath[0] == L'\0' ||
405 extract_root_realpath[1] != L':' ||
406 extract_root_realpath[2] != L'\\')
407 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
409 ret = parse_substitute_name(rpdata.substitute_name,
410 rpdata.substitute_name_nbytes,
414 stripped_nchars = ret;
415 target = rpdata.substitute_name;
416 target_nchars = rpdata.substitute_name_nbytes / sizeof(utf16lechar);
417 stripped_target = target + stripped_nchars;
418 stripped_target_nchars = target_nchars - stripped_nchars;
420 new_target = alloca((6 + extract_root_realpath_nchars +
421 stripped_target_nchars) * sizeof(utf16lechar));
424 if (stripped_nchars == 6) {
425 /* Include \??\ prefix if it was present before */
426 p = wmempcpy(p, L"\\??\\", 4);
429 /* Print name excludes the \??\ if present. */
431 if (stripped_nchars != 0) {
432 /* Get drive letter from real path to extract root, if a drive
433 * letter was present before. */
434 *p++ = extract_root_realpath[0];
435 *p++ = extract_root_realpath[1];
437 /* Copy the rest of the extract root */
438 p = wmempcpy(p, extract_root_realpath + 2, extract_root_realpath_nchars - 2);
440 /* Append the stripped target */
441 p = wmempcpy(p, stripped_target, stripped_target_nchars);
442 new_target_nchars = p - new_target;
443 new_print_name_nchars = p - new_print_name;
445 if (new_target_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE ||
446 new_print_name_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE)
447 return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED;
449 rpdata.substitute_name = new_target;
450 rpdata.substitute_name_nbytes = new_target_nchars * sizeof(utf16lechar);
451 rpdata.print_name = new_print_name;
452 rpdata.print_name_nbytes = new_print_name_nchars * sizeof(utf16lechar);
453 return make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
455 #endif /* __WIN32__ */
457 /* Set reparse data on extracted file or directory that has
458 * FILE_ATTRIBUTE_REPARSE_POINT set. */
460 extract_reparse_data(const tchar *path, struct apply_ctx *ctx,
461 struct wim_inode *inode,
462 struct wim_lookup_table_entry *lte_override)
465 u8 rpbuf[REPARSE_POINT_MAX_SIZE];
468 ret = wim_inode_get_reparse_data(inode, rpbuf, &rpbuflen, lte_override);
473 /* Fix up target of absolute symbolic link or junction points so
474 * that they point into the actual extraction target. */
475 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
476 (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
477 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) &&
478 !inode->i_not_rpfixed)
480 ret = try_extract_rpfix(rpbuf, &rpbuflen, ctx->realtarget,
481 ctx->realtarget_nchars);
482 if (ret && !(ctx->extract_flags &
483 WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
485 WARNING("Reparse point fixup of \"%"TS"\" "
494 ret = ctx->ops->set_reparse_data(path, rpbuf, rpbuflen, ctx);
496 /* On Windows, the SeCreateSymbolicLink privilege is required to create
497 * symbolic links. To be more friendly towards non-Administrator users,
498 * we merely warn the user if symbolic links cannot be created due to
499 * insufficient permissions or privileges, unless
500 * WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was provided. */
502 if (ret && inode_is_symlink(inode) &&
503 (errno == EACCES || errno == EPERM) &&
504 !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS))
506 WARNING("Can't set reparse data on \"%"TS"\": "
508 " You may be trying to "
509 "extract a symbolic link without the\n"
510 " SeCreateSymbolicLink privilege, "
511 "which by default non-Administrator\n"
512 " accounts do not have.",
520 /* Account for reparse data consumed. */
521 update_extract_progress(ctx,
522 (lte_override ? lte_override :
523 inode_unnamed_lte_resolved(inode)));
527 ERROR_WITH_ERRNO("Failed to set reparse data on \"%"TS"\"", path);
532 * Extract zero or more streams to a file.
534 * This function operates slightly differently depending on whether @lte_spec is
535 * NULL or not. When @lte_spec is NULL, the behavior is to extract the default
536 * file contents (unnamed stream), and, if named data streams are supported in
537 * the extract mode and volume, any named data streams. When @lte_spec is NULL,
538 * the behavior is to extract only all copies of the stream @lte_spec, and in
539 * addition use @lte_spec to set the reparse data or create the symbolic link if
543 * Path to file to extract (as can be passed to apply_operations
548 * WIM dentry that corresponds to the file being extracted.
550 * If non-NULL, specifies the lookup table entry for a stream to extract,
551 * and only that stream will be extracted (although there may be more than
552 * one instance of it).
554 * Used only if @lte_spec != NULL; it is passed to the extraction functions
555 * rather than @lte_spec, allowing the location of the stream to be
556 * overridden. (This is used when the WIM is being read from a nonseekable
557 * file, such as a pipe, when streams need to be used more than once; each
558 * such stream is extracted to a temporary file.)
561 extract_streams(const tchar *path, struct apply_ctx *ctx,
562 struct wim_dentry *dentry,
563 struct wim_lookup_table_entry *lte_spec,
564 struct wim_lookup_table_entry *lte_override)
566 struct wim_inode *inode = dentry->d_inode;
567 struct wim_lookup_table_entry *lte;
568 file_spec_t file_spec;
571 if (dentry->was_hardlinked)
578 for (unsigned i = 0; i < SHA1_HASH_SIZE; i++)
579 p += sprintf(p, "%02x", lte_override->hash[i]);
580 DEBUG("Extracting stream SHA1=%s to \"%"TS"\"",
581 sha1_str, path, inode->i_ino);
583 DEBUG("Extracting streams to \"%"TS"\"", path, inode->i_ino);
587 if (ctx->ops->uses_cookies)
588 file_spec.cookie = inode->extract_cookie;
590 file_spec.path = path;
592 /* Unnamed data stream. */
593 lte = inode_unnamed_lte_resolved(inode);
594 if (lte && (!lte_spec || lte == lte_spec)) {
597 if (!(inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
598 FILE_ATTRIBUTE_REPARSE_POINT)))
600 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED &&
601 ctx->supported_features.encrypted_files) {
602 if (!ctx->ops->extract_encrypted_stream_creates_file) {
603 ret = ctx->ops->extract_encrypted_stream(
609 ret = ctx->ops->extract_unnamed_stream(
610 file_spec, lte, ctx);
614 update_extract_progress(ctx, lte);
616 else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
619 if (ctx->supported_features.reparse_points)
620 ret = extract_reparse_data(path, ctx, inode, lte);
622 else if ((inode_is_symlink(inode) &&
623 ctx->supported_features.symlink_reparse_points))
624 ret = extract_symlink(path, ctx, inode, lte);
631 /* Named data streams. */
632 if (can_extract_named_data_streams(ctx)) {
633 for (u16 i = 0; i < inode->i_num_ads; i++) {
634 struct wim_ads_entry *entry = &inode->i_ads_entries[i];
636 if (!ads_entry_is_named_stream(entry))
641 if (lte_spec && lte_spec != lte)
645 ret = ctx->ops->extract_named_stream(file_spec, entry->stream_name,
646 entry->stream_name_nbytes / 2,
650 update_extract_progress(ctx, lte);
656 ERROR_WITH_ERRNO("Failed to extract data of \"%"TS"\"", path);
660 /* Set attributes on an extracted file or directory if supported by the
661 * extraction mode. */
663 extract_file_attributes(const tchar *path, struct apply_ctx *ctx,
664 struct wim_dentry *dentry, unsigned pass)
668 if (ctx->ops->set_file_attributes &&
669 !(dentry == ctx->extract_root && ctx->root_dentry_is_special)) {
670 u32 attributes = dentry->d_inode->i_attributes;
672 /* Clear unsupported attributes. */
673 attributes &= ctx->supported_attributes_mask;
675 if ((attributes & FILE_ATTRIBUTE_DIRECTORY &&
676 !ctx->supported_features.encrypted_directories) ||
677 (!(attributes & FILE_ATTRIBUTE_DIRECTORY) &&
678 !ctx->supported_features.encrypted_files))
680 attributes &= ~FILE_ATTRIBUTE_ENCRYPTED;
684 attributes = FILE_ATTRIBUTE_NORMAL;
686 ret = ctx->ops->set_file_attributes(path, attributes, ctx, pass);
688 ERROR_WITH_ERRNO("Failed to set attributes on "
697 /* Set or remove the short (DOS) name on an extracted file or directory if
698 * supported by the extraction mode. Since DOS names are unimportant and it's
699 * easy to run into problems setting them on Windows (SetFileShortName()
700 * requires SE_RESTORE privilege, which only the Administrator can request, and
701 * also requires DELETE access to the file), failure is ignored unless
702 * WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is set. */
704 extract_short_name(const tchar *path, struct apply_ctx *ctx,
705 struct wim_dentry *dentry)
709 /* The root of the dentry tree being extracted may not be extracted to
710 * its original name, so its short name should be ignored. */
711 if (dentry == ctx->extract_root)
714 if (ctx->supported_features.short_names) {
715 ret = ctx->ops->set_short_name(path,
717 dentry->short_name_nbytes / 2,
719 if (ret && (ctx->extract_flags &
720 WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES))
722 ERROR_WITH_ERRNO("Failed to set short name of "
730 /* Set security descriptor, UNIX data, or neither on an extracted file, taking
731 * into account the current extraction mode and flags. */
733 extract_security(const tchar *path, struct apply_ctx *ctx,
734 struct wim_dentry *dentry)
737 struct wim_inode *inode = dentry->d_inode;
739 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
742 if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
746 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) {
747 struct wimlib_unix_data data;
749 ret = inode_get_unix_data(inode, &data, NULL);
753 ret = ctx->ops->set_unix_data(path, &data, ctx);
755 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
756 ERROR_WITH_ERRNO("Failed to set UNIX owner, "
757 "group, and/or mode on "
761 WARNING_WITH_ERRNO("Failed to set UNIX owner, "
762 "group, and/or/mode on "
768 #endif /* __WIN32__ */
769 if (ctx->supported_features.security_descriptors &&
770 inode->i_security_id != -1)
772 const struct wim_security_data *sd;
776 sd = wim_const_security_data(ctx->wim);
777 desc = sd->descriptors[inode->i_security_id];
778 desc_size = sd->sizes[inode->i_security_id];
780 ret = ctx->ops->set_security_descriptor(path, desc,
783 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
784 ERROR_WITH_ERRNO("Failed to set security "
785 "descriptor on \"%"TS"\"", path);
789 if (errno != EACCES) {
790 WARNING_WITH_ERRNO("Failed to set "
791 "security descriptor "
792 "on \"%"TS"\"", path);
795 ctx->no_security_descriptors++;
802 /* Set timestamps on an extracted file. Failure is warning-only unless
803 * WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS is set. */
805 extract_timestamps(const tchar *path, struct apply_ctx *ctx,
806 struct wim_dentry *dentry)
808 struct wim_inode *inode = dentry->d_inode;
811 if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
814 if (ctx->ops->set_timestamps) {
815 ret = ctx->ops->set_timestamps(path,
816 inode->i_creation_time,
817 inode->i_last_write_time,
818 inode->i_last_access_time,
821 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) {
822 ERROR_WITH_ERRNO("Failed to set timestamps "
823 "on \"%"TS"\"", path);
826 WARNING_WITH_ERRNO("Failed to set timestamps "
827 "on \"%"TS"\"", path);
834 /* Check whether the extraction of a dentry should be skipped completely. */
836 dentry_is_supported(struct wim_dentry *dentry,
837 const struct wim_features *supported_features)
839 struct wim_inode *inode = dentry->d_inode;
841 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
842 return supported_features->reparse_points ||
843 (inode_is_symlink(inode) &&
844 supported_features->symlink_reparse_points);
846 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
847 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
848 return supported_features->encrypted_directories != 0;
850 return supported_features->encrypted_files != 0;
855 /* Given a WIM dentry to extract, build the path to which to extract it, in the
856 * format understood by the callbacks in the apply_operations being used.
858 * Write the resulting path into @path, which must have room for at least
859 * ctx->ops->max_path characters including the null-terminator.
861 * Return %true if successful; %false if this WIM dentry doesn't actually need
862 * to be extracted or if the calculated path exceeds ctx->ops->max_path
865 * This function clobbers the tmp_list member of @dentry and its ancestors up
866 * until the extraction root. */
868 build_extraction_path(tchar path[], struct wim_dentry *dentry,
869 struct apply_ctx *ctx)
872 LIST_HEAD(ancestor_list);
874 const tchar *target_prefix;
875 size_t target_prefix_nchars;
876 struct wim_dentry *d;
878 if (dentry->extraction_skipped)
881 path_nchars = ctx->ops->path_prefix_nchars;
883 if (ctx->ops->requires_realtarget_in_paths) {
884 target_prefix = ctx->realtarget;
885 target_prefix_nchars = ctx->realtarget_nchars;
886 } else if (ctx->ops->requires_target_in_paths) {
887 target_prefix = ctx->target;
888 target_prefix_nchars = ctx->target_nchars;
890 target_prefix = NULL;
891 target_prefix_nchars = 0;
893 path_nchars += target_prefix_nchars;
895 for (d = dentry; d != ctx->extract_root; d = d->parent) {
896 path_nchars += d->extraction_name_nchars + 1;
897 list_add(&d->tmp_list, &ancestor_list);
900 path_nchars++; /* null terminator */
902 if (path_nchars > ctx->ops->path_max) {
903 WARNING("\"%"TS"\": Path too long to extract",
904 dentry_full_path(dentry));
908 p = tmempcpy(p, ctx->ops->path_prefix, ctx->ops->path_prefix_nchars);
909 p = tmempcpy(p, target_prefix, target_prefix_nchars);
910 list_for_each_entry(d, &ancestor_list, tmp_list) {
911 *p++ = ctx->ops->path_separator;
912 p = tmempcpy(p, d->extraction_name, d->extraction_name_nchars);
915 wimlib_assert(p - path == path_nchars);
920 get_num_path_components(const tchar *path, tchar path_separator)
922 unsigned num_components = 0;
924 /* Ignore drive letter. */
925 if (path[0] != L'\0' && path[1] == L':')
930 while (*path == path_separator)
934 while (*path && *path != path_separator)
937 return num_components;
941 extract_multiimage_symlink(const tchar *oldpath, const tchar *newpath,
942 struct apply_ctx *ctx, struct wim_dentry *dentry)
944 size_t num_raw_path_components;
945 const struct wim_dentry *d;
946 size_t num_target_path_components;
951 num_raw_path_components = 0;
952 for (d = dentry; d != ctx->extract_root; d = d->parent)
953 num_raw_path_components++;
955 if (ctx->ops->requires_realtarget_in_paths)
956 num_target_path_components = get_num_path_components(ctx->realtarget,
957 ctx->ops->path_separator);
958 else if (ctx->ops->requires_target_in_paths)
959 num_target_path_components = get_num_path_components(ctx->target,
960 ctx->ops->path_separator);
962 num_target_path_components = 0;
964 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) {
965 wimlib_assert(num_target_path_components > 0);
966 num_raw_path_components++;
967 num_target_path_components--;
970 p_old = oldpath + ctx->ops->path_prefix_nchars;
972 if (p_old[0] != L'\0' && p_old[1] == ':')
975 while (*p_old == ctx->ops->path_separator)
977 while (--num_target_path_components) {
978 while (*p_old != ctx->ops->path_separator)
980 while (*p_old == ctx->ops->path_separator)
984 tchar symlink_target[tstrlen(p_old) + 3 * num_raw_path_components + 1];
986 p = &symlink_target[0];
987 while (num_raw_path_components--) {
990 *p++ = ctx->ops->path_separator;
993 DEBUG("Creating symlink \"%"TS"\" => \"%"TS"\"",
994 newpath, symlink_target);
995 ret = ctx->ops->create_symlink(symlink_target, newpath, ctx);
997 ERROR_WITH_ERRNO("Failed to create symlink "
998 "\"%"TS"\" => \"%"TS"\"",
999 newpath, symlink_target);
1004 /* Create the "skeleton" of an extracted file or directory. Don't yet extract
1005 * data streams, reparse data (including symbolic links), timestamps, and
1006 * security descriptors. Basically, everything that doesn't require reading
1007 * non-metadata resources from the WIM file and isn't delayed until the final
1010 do_dentry_extract_skeleton(tchar path[], struct wim_dentry *dentry,
1011 struct apply_ctx *ctx)
1013 struct wim_inode *inode = dentry->d_inode;
1015 const tchar *oldpath;
1017 if (unlikely(is_linked_extraction(ctx))) {
1018 struct wim_lookup_table_entry *unnamed_lte;
1020 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
1021 if (unnamed_lte && unnamed_lte->extracted_file) {
1022 oldpath = unnamed_lte->extracted_file;
1023 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK)
1030 /* Create hard link if this dentry corresponds to an already-extracted
1032 if (inode->i_extracted_file) {
1033 oldpath = inode->i_extracted_file;
1037 /* Skip symlinks unless they can be extracted as reparse points rather
1038 * than created directly. */
1039 if (inode_is_symlink(inode) && !ctx->supported_features.reparse_points)
1042 /* Create this file or directory unless it's the extraction root, which
1043 * was already created if necessary. */
1044 if (dentry != ctx->extract_root) {
1045 ret = extract_inode(path, ctx, inode);
1050 /* Create empty named data streams. */
1051 if (can_extract_named_data_streams(ctx)) {
1052 for (u16 i = 0; i < inode->i_num_ads; i++) {
1053 file_spec_t file_spec;
1054 struct wim_ads_entry *entry = &inode->i_ads_entries[i];
1056 if (!ads_entry_is_named_stream(entry))
1060 if (ctx->ops->uses_cookies)
1061 file_spec.cookie = inode->extract_cookie;
1063 file_spec.path = path;
1064 ret = ctx->ops->extract_named_stream(file_spec,
1066 entry->stream_name_nbytes / 2,
1069 ERROR_WITH_ERRNO("\"%"TS"\": failed to create "
1070 "empty named data stream",
1077 /* Set file attributes (if supported). */
1078 ret = extract_file_attributes(path, ctx, dentry, 0);
1082 /* Set or remove file short name (if supported). */
1083 ret = extract_short_name(path, ctx, dentry);
1087 /* If inode has multiple links and hard links are supported in this
1088 * extraction mode and volume, save the path to the extracted file in
1089 * case it's needed to create a hard link. */
1090 if (unlikely(is_linked_extraction(ctx))) {
1091 struct wim_lookup_table_entry *unnamed_lte;
1093 unnamed_lte = inode_unnamed_lte_resolved(dentry->d_inode);
1095 unnamed_lte->extracted_file = TSTRDUP(path);
1096 if (!unnamed_lte->extracted_file)
1097 return WIMLIB_ERR_NOMEM;
1099 } else if (inode->i_nlink > 1 && ctx->supported_features.hard_links) {
1100 inode->i_extracted_file = TSTRDUP(path);
1101 if (!inode->i_extracted_file)
1102 return WIMLIB_ERR_NOMEM;
1107 ret = extract_multiimage_symlink(oldpath, path, ctx, dentry);
1110 dentry->was_hardlinked = 1;
1114 ret = extract_hardlink(oldpath, path, ctx);
1117 dentry->was_hardlinked = 1;
1121 /* This is a wrapper around do_dentry_extract_skeleton() that handles building
1122 * the path, doing short name reordering. This is also idempotent; dentries
1123 * already processed have skeleton_extracted set and no action is taken. See
1124 * apply_operations.requires_short_name_reordering for more details about short
1125 * name reordering. */
1127 dentry_extract_skeleton(struct wim_dentry *dentry, void *_ctx)
1129 struct apply_ctx *ctx = _ctx;
1130 tchar path[ctx->ops->path_max];
1131 struct wim_dentry *orig_dentry;
1132 struct wim_dentry *other_dentry;
1135 if (dentry->skeleton_extracted)
1139 if (ctx->supported_features.short_names
1140 && ctx->ops->requires_short_name_reordering
1141 && !dentry_has_short_name(dentry)
1142 && !dentry->d_inode->i_dos_name_extracted)
1144 inode_for_each_dentry(other_dentry, dentry->d_inode) {
1145 if (dentry_has_short_name(other_dentry)
1146 && !other_dentry->skeleton_extracted
1147 && other_dentry->in_extraction_tree)
1149 DEBUG("Creating %"TS" before %"TS" "
1150 "to guarantee correct DOS name extraction",
1151 dentry_full_path(other_dentry),
1152 dentry_full_path(dentry));
1153 orig_dentry = dentry;
1154 dentry = other_dentry;
1160 if (!build_extraction_path(path, dentry, ctx))
1162 ret = do_dentry_extract_skeleton(path, dentry, ctx);
1166 dentry->skeleton_extracted = 1;
1169 dentry = orig_dentry;
1173 dentry->d_inode->i_dos_name_extracted = 1;
1178 dentry_extract_dir_skeleton(struct wim_dentry *dentry, void *_ctx)
1180 if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1181 return dentry_extract_skeleton(dentry, _ctx);
1185 /* Create a file or directory, then immediately extract all streams. This
1186 * assumes that WIMLIB_EXTRACT_FLAG_SEQUENTIAL is not specified, since the WIM
1187 * may not be read sequentially by this function. */
1189 dentry_extract(struct wim_dentry *dentry, void *_ctx)
1191 struct apply_ctx *ctx = _ctx;
1192 tchar path[ctx->ops->path_max];
1195 ret = dentry_extract_skeleton(dentry, ctx);
1199 if (!build_extraction_path(path, dentry, ctx))
1202 return extract_streams(path, ctx, dentry, NULL, NULL);
1205 /* Extract all instances of the stream @lte that are being extracted in this
1206 * call of extract_tree(). @can_seek specifies whether the WIM file descriptor
1207 * is seekable or not (e.g. is a pipe). If not and the stream needs to be
1208 * extracted multiple times, it is extracted to a temporary file first.
1210 * This is intended for use with sequential extraction of a WIM image
1211 * (WIMLIB_EXTRACT_FLAG_SEQUENTIAL specified). */
1213 extract_stream_instances(struct wim_lookup_table_entry *lte,
1214 struct apply_ctx *ctx, bool can_seek)
1216 struct wim_dentry **lte_dentries;
1217 struct wim_lookup_table_entry *lte_tmp = NULL;
1218 struct wim_lookup_table_entry *lte_override;
1219 tchar *stream_tmp_filename = NULL;
1220 tchar path[ctx->ops->path_max];
1224 if (lte->out_refcnt <= ARRAY_LEN(lte->inline_lte_dentries))
1225 lte_dentries = lte->inline_lte_dentries;
1227 lte_dentries = lte->lte_dentries;
1229 if (likely(can_seek || lte->out_refcnt < 2)) {
1232 /* Need to extract stream to temporary file. */
1236 stream_tmp_filename = ttempnam(NULL, T("wimlib"));
1237 if (!stream_tmp_filename) {
1238 ERROR_WITH_ERRNO("Failed to create temporary filename");
1239 ret = WIMLIB_ERR_OPEN;
1243 lte_tmp = memdup(lte, sizeof(struct wim_lookup_table_entry));
1245 ret = WIMLIB_ERR_NOMEM;
1246 goto out_free_stream_tmp_filename;
1248 lte_tmp->resource_location = RESOURCE_IN_FILE_ON_DISK;
1249 lte_tmp->file_on_disk = stream_tmp_filename;
1250 lte_override = lte_tmp;
1252 raw_fd = topen(stream_tmp_filename,
1253 O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0600);
1255 ERROR_WITH_ERRNO("Failed to open temporary file");
1256 ret = WIMLIB_ERR_OPEN;
1257 goto out_free_lte_tmp;
1259 filedes_init(&fd, raw_fd);
1260 ret = extract_stream_to_fd(lte, &fd, lte->size);
1261 if (filedes_close(&fd) && !ret)
1262 ret = WIMLIB_ERR_WRITE;
1264 goto out_unlink_stream_tmp_file;
1267 /* Extract all instances of the stream, reading either from the stream
1268 * in the WIM file or from the temporary file containing the stream.
1269 * dentry->tmp_flag is used to ensure that each dentry is processed only
1270 * once regardless of how many times this stream appears in the streams
1271 * of the corresponding inode. */
1272 for (i = 0; i < lte->out_refcnt; i++) {
1273 struct wim_dentry *dentry = lte_dentries[i];
1275 if (dentry->tmp_flag)
1277 if (!build_extraction_path(path, dentry, ctx))
1279 ret = extract_streams(path, ctx, dentry,
1282 goto out_clear_tmp_flags;
1283 dentry->tmp_flag = 1;
1286 out_clear_tmp_flags:
1287 for (i = 0; i < lte->out_refcnt; i++)
1288 lte_dentries[i]->tmp_flag = 0;
1289 out_unlink_stream_tmp_file:
1290 if (stream_tmp_filename)
1291 tunlink(stream_tmp_filename);
1294 out_free_stream_tmp_filename:
1295 FREE(stream_tmp_filename);
1300 /* Extracts a list of streams (ctx.stream_list), assuming that the directory
1301 * structure and empty files were already created. This relies on the
1302 * per-`struct wim_lookup_table_entry' list of dentries that reference each
1303 * stream that was constructed earlier. Streams are extracted exactly in the
1304 * order of the stream list; however, unless the WIM's file descriptor is
1305 * detected to be non-seekable, streams may be read from the WIM file more than
1306 * one time if multiple copies need to be extracted. */
1308 extract_stream_list(struct apply_ctx *ctx)
1310 struct wim_lookup_table_entry *lte;
1314 can_seek = (lseek(ctx->wim->in_fd.fd, 0, SEEK_CUR) != -1);
1315 list_for_each_entry(lte, &ctx->stream_list, extraction_list) {
1316 ret = extract_stream_instances(lte, ctx, can_seek);
1323 #define PWM_ALLOW_WIM_HDR 0x00001
1324 #define PWM_SILENT_EOF 0x00002
1326 /* Read the header from a stream in a pipable WIM. */
1328 read_pwm_stream_header(WIMStruct *pwm, struct wim_lookup_table_entry *lte,
1329 struct wim_resource_spec *rspec,
1330 int flags, struct wim_header_disk *hdr_ret)
1333 struct pwm_stream_hdr stream_hdr;
1334 struct wim_header_disk pwm_hdr;
1336 struct wim_reshdr reshdr;
1339 ret = full_read(&pwm->in_fd, &buf.stream_hdr, sizeof(buf.stream_hdr));
1343 if ((flags & PWM_ALLOW_WIM_HDR) && buf.stream_hdr.magic == PWM_MAGIC) {
1344 BUILD_BUG_ON(sizeof(buf.pwm_hdr) < sizeof(buf.stream_hdr));
1345 ret = full_read(&pwm->in_fd, &buf.stream_hdr + 1,
1346 sizeof(buf.pwm_hdr) - sizeof(buf.stream_hdr));
1350 lte->resource_location = RESOURCE_NONEXISTENT;
1351 memcpy(hdr_ret, &buf.pwm_hdr, sizeof(buf.pwm_hdr));
1355 if (buf.stream_hdr.magic != PWM_STREAM_MAGIC) {
1356 ERROR("Data read on pipe is invalid (expected stream header).");
1357 return WIMLIB_ERR_INVALID_PIPABLE_WIM;
1360 copy_hash(lte->hash, buf.stream_hdr.hash);
1362 reshdr.size_in_wim = 0;
1363 reshdr.flags = le32_to_cpu(buf.stream_hdr.flags);
1364 reshdr.offset_in_wim = pwm->in_fd.offset;
1365 reshdr.uncompressed_size = le64_to_cpu(buf.stream_hdr.uncompressed_size);
1366 wim_res_hdr_to_spec(&reshdr, pwm, rspec);
1367 lte_bind_wim_resource_spec(lte, rspec);
1368 lte->flags = rspec->flags;
1369 lte->size = rspec->uncompressed_size;
1370 lte->offset_in_res = 0;
1374 if (ret != WIMLIB_ERR_UNEXPECTED_END_OF_FILE || !(flags & PWM_SILENT_EOF))
1375 ERROR_WITH_ERRNO("Error reading pipable WIM from pipe");
1380 skip_pwm_chunk_cb(const void *chunk, size_t chunk_size, void *_ctx)
1385 /* Skip over an unneeded stream in a pipable WIM being read from a pipe. */
1387 skip_pwm_stream(struct wim_lookup_table_entry *lte)
1389 return read_partial_wim_resource(lte,
1392 lte_cchunk_size(lte),
1394 WIMLIB_READ_RESOURCE_FLAG_RAW_CHUNKS,
1399 extract_streams_from_pipe(struct apply_ctx *ctx)
1401 struct wim_lookup_table_entry *found_lte;
1402 struct wim_resource_spec *rspec;
1403 struct wim_lookup_table_entry *needed_lte;
1404 struct wim_lookup_table *lookup_table;
1405 struct wim_header_disk pwm_hdr;
1409 ret = WIMLIB_ERR_NOMEM;
1410 found_lte = new_lookup_table_entry();
1411 if (found_lte == NULL)
1414 rspec = MALLOC(sizeof(struct wim_resource_spec));
1416 goto out_free_found_lte;
1418 lookup_table = ctx->wim->lookup_table;
1419 pwm_flags = PWM_ALLOW_WIM_HDR;
1420 if ((ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1421 pwm_flags |= PWM_SILENT_EOF;
1422 memcpy(ctx->progress.extract.guid, ctx->wim->hdr.guid, WIM_GID_LEN);
1423 ctx->progress.extract.part_number = ctx->wim->hdr.part_number;
1424 ctx->progress.extract.total_parts = ctx->wim->hdr.total_parts;
1425 if (ctx->progress_func)
1426 ctx->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1428 while (ctx->num_streams_remaining) {
1429 if (found_lte->resource_location != RESOURCE_NONEXISTENT)
1430 lte_unbind_wim_resource_spec(found_lte);
1431 ret = read_pwm_stream_header(ctx->wim, found_lte, rspec,
1432 pwm_flags, &pwm_hdr);
1434 if (ret == WIMLIB_ERR_UNEXPECTED_END_OF_FILE &&
1435 (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_RESUME))
1439 goto out_free_found_lte;
1442 if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
1443 && !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
1444 && (needed_lte = lookup_resource(lookup_table, found_lte->hash))
1445 && (needed_lte->out_refcnt))
1447 lte_unbind_wim_resource_spec(found_lte);
1448 lte_bind_wim_resource_spec(needed_lte, rspec);
1449 needed_lte->offset_in_res = found_lte->offset_in_res;
1450 needed_lte->flags = found_lte->flags;
1451 needed_lte->size = found_lte->size;
1452 ret = extract_stream_instances(needed_lte, ctx, false);
1453 lte_unbind_wim_resource_spec(needed_lte);
1456 goto out_free_found_lte;
1457 ctx->num_streams_remaining--;
1458 } else if (found_lte->resource_location != RESOURCE_NONEXISTENT) {
1459 ret = skip_pwm_stream(found_lte);
1461 goto out_free_found_lte;
1463 u16 part_number = le16_to_cpu(pwm_hdr.part_number);
1464 u16 total_parts = le16_to_cpu(pwm_hdr.total_parts);
1466 if (part_number != ctx->progress.extract.part_number ||
1467 total_parts != ctx->progress.extract.total_parts ||
1468 memcmp(pwm_hdr.guid, ctx->progress.extract.guid,
1471 ctx->progress.extract.part_number = part_number;
1472 ctx->progress.extract.total_parts = total_parts;
1473 memcpy(ctx->progress.extract.guid,
1474 pwm_hdr.guid, WIM_GID_LEN);
1475 if (ctx->progress_func) {
1477 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
1486 if (found_lte->resource_location != RESOURCE_IN_WIM)
1488 free_lookup_table_entry(found_lte);
1497 /* Finish extracting a file, directory, or symbolic link by setting file
1498 * security and timestamps. */
1500 dentry_extract_final(struct wim_dentry *dentry, void *_ctx)
1502 struct apply_ctx *ctx = _ctx;
1504 tchar path[ctx->ops->path_max];
1506 if (!build_extraction_path(path, dentry, ctx))
1509 ret = extract_security(path, ctx, dentry);
1513 if (ctx->ops->requires_final_set_attributes_pass) {
1514 /* Set file attributes (if supported). */
1515 ret = extract_file_attributes(path, ctx, dentry, 1);
1520 return extract_timestamps(path, ctx, dentry);
1524 * Extract a WIM dentry to standard output.
1526 * This obviously doesn't make sense in all cases. We return an error if the
1527 * dentry does not correspond to a regular file. Otherwise we extract the
1528 * unnamed data stream only.
1531 extract_dentry_to_stdout(struct wim_dentry *dentry)
1534 if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
1535 FILE_ATTRIBUTE_DIRECTORY))
1537 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
1538 "extracted to standard output", dentry_full_path(dentry));
1539 ret = WIMLIB_ERR_NOT_A_REGULAR_FILE;
1541 struct wim_lookup_table_entry *lte;
1543 lte = inode_unnamed_lte_resolved(dentry->d_inode);
1545 struct filedes _stdout;
1546 filedes_init(&_stdout, STDOUT_FILENO);
1547 ret = extract_stream_to_fd(lte, &_stdout, lte->size);
1554 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
1556 static const utf16lechar replacement_char = cpu_to_le16('?');
1560 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
1566 for (i = 0; i < num_chars; i++) {
1569 case cpu_to_le16('\\'):
1570 case cpu_to_le16(':'):
1571 case cpu_to_le16('*'):
1572 case cpu_to_le16('?'):
1573 case cpu_to_le16('"'):
1574 case cpu_to_le16('<'):
1575 case cpu_to_le16('>'):
1576 case cpu_to_le16('|'):
1578 case cpu_to_le16('/'):
1579 case cpu_to_le16('\0'):
1581 name[i] = replacement_char;
1588 if (name[num_chars - 1] == cpu_to_le16(' ') ||
1589 name[num_chars - 1] == cpu_to_le16('.'))
1592 name[num_chars - 1] = replacement_char;
1601 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
1603 const utf16lechar *file_name = dentry->file_name;
1604 return file_name != NULL &&
1605 file_name[0] == cpu_to_le16('.') &&
1606 (file_name[1] == cpu_to_le16('\0') ||
1607 (file_name[1] == cpu_to_le16('.') &&
1608 file_name[2] == cpu_to_le16('\0')));
1612 dentry_mark_skipped(struct wim_dentry *dentry, void *_ignore)
1614 dentry->extraction_skipped = 1;
1619 * dentry_calculate_extraction_path-
1621 * Calculate the actual filename component at which a WIM dentry will be
1622 * extracted, handling invalid filenames "properly".
1624 * dentry->extraction_name usually will be set the same as dentry->file_name (on
1625 * UNIX, converted into the platform's multibyte encoding). However, if the
1626 * file name contains characters that are not valid on the current platform or
1627 * has some other format that is not valid, leave dentry->extraction_name as
1628 * NULL and set dentry->extraction_skipped to indicate that this dentry should
1629 * not be extracted, unless the appropriate flag
1630 * WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES is set in the extract flags, in
1631 * which case a substitute filename will be created and set instead.
1633 * Conflicts with case-insensitive names on Windows are handled similarly; see
1637 dentry_calculate_extraction_path(struct wim_dentry *dentry, void *_args)
1639 struct apply_ctx *ctx = _args;
1642 dentry->in_extraction_tree = 1;
1644 if (dentry == ctx->extract_root || dentry->extraction_skipped)
1647 if (!dentry_is_supported(dentry, &ctx->supported_features))
1650 if (dentry_is_dot_or_dotdot(dentry)) {
1651 /* WIM files shouldn't contain . or .. entries. But if they are
1652 * there, don't attempt to extract them. */
1653 WARNING("Skipping extraction of unexpected . or .. file "
1654 "\"%"TS"\"", dentry_full_path(dentry));
1659 if (!ctx->ops->supports_case_sensitive_filenames)
1661 struct wim_dentry *other;
1662 list_for_each_entry(other, &dentry->case_insensitive_conflict_list,
1663 case_insensitive_conflict_list)
1665 if (ctx->extract_flags &
1666 WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
1667 WARNING("\"%"TS"\" has the same "
1668 "case-insensitive name as "
1669 "\"%"TS"\"; extracting "
1670 "dummy name instead",
1671 dentry_full_path(dentry),
1672 dentry_full_path(other));
1675 WARNING("Not extracting \"%"TS"\": "
1676 "has same case-insensitive "
1677 "name as \"%"TS"\"",
1678 dentry_full_path(dentry),
1679 dentry_full_path(other));
1684 #else /* __WIN32__ */
1685 wimlib_assert(ctx->ops->supports_case_sensitive_filenames);
1686 #endif /* !__WIN32__ */
1688 if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
1690 dentry->extraction_name = dentry->file_name;
1691 dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
1694 return utf16le_to_tstr(dentry->file_name,
1695 dentry->file_name_nbytes,
1696 &dentry->extraction_name,
1697 &dentry->extraction_name_nchars);
1700 if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
1702 WARNING("\"%"TS"\" has an invalid filename "
1703 "that is not supported on this platform; "
1704 "extracting dummy name instead",
1705 dentry_full_path(dentry));
1708 WARNING("Not extracting \"%"TS"\": has an invalid filename "
1709 "that is not supported on this platform",
1710 dentry_full_path(dentry));
1717 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
1719 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
1720 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
1723 size_t tchar_nchars;
1725 tchar_name = utf16_name_copy;
1726 tchar_nchars = dentry->file_name_nbytes / 2;
1728 ret = utf16le_to_tstr(utf16_name_copy,
1729 dentry->file_name_nbytes,
1730 &tchar_name, &tchar_nchars);
1734 size_t fixed_name_num_chars = tchar_nchars;
1735 tchar fixed_name[tchar_nchars + 50];
1737 tmemcpy(fixed_name, tchar_name, tchar_nchars);
1738 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
1739 T(" (invalid filename #%lu)"),
1740 ++ctx->invalid_sequence);
1744 dentry->extraction_name = memdup(fixed_name,
1745 2 * fixed_name_num_chars + 2);
1746 if (!dentry->extraction_name)
1747 return WIMLIB_ERR_NOMEM;
1748 dentry->extraction_name_nchars = fixed_name_num_chars;
1753 for_dentry_in_tree(dentry, dentry_mark_skipped, NULL);
1757 /* Clean up dentry and inode structure after extraction. */
1759 dentry_reset_needs_extraction(struct wim_dentry *dentry, void *_ignore)
1761 struct wim_inode *inode = dentry->d_inode;
1763 dentry->in_extraction_tree = 0;
1764 dentry->extraction_skipped = 0;
1765 dentry->was_hardlinked = 0;
1766 dentry->skeleton_extracted = 0;
1767 inode->i_visited = 0;
1768 FREE(inode->i_extracted_file);
1769 inode->i_extracted_file = NULL;
1770 inode->i_dos_name_extracted = 0;
1771 if ((void*)dentry->extraction_name != (void*)dentry->file_name)
1772 FREE(dentry->extraction_name);
1773 dentry->extraction_name = NULL;
1777 /* Tally features necessary to extract a dentry and the corresponding inode. */
1779 dentry_tally_features(struct wim_dentry *dentry, void *_features)
1781 struct wim_features *features = _features;
1782 struct wim_inode *inode = dentry->d_inode;
1784 if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
1785 features->archive_files++;
1786 if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
1787 features->hidden_files++;
1788 if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
1789 features->system_files++;
1790 if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
1791 features->compressed_files++;
1792 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
1793 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1794 features->encrypted_directories++;
1796 features->encrypted_files++;
1798 if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
1799 features->not_context_indexed_files++;
1800 if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
1801 features->sparse_files++;
1802 if (inode_has_named_stream(inode))
1803 features->named_data_streams++;
1804 if (inode->i_visited)
1805 features->hard_links++;
1806 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1807 features->reparse_points++;
1808 if (inode_is_symlink(inode))
1809 features->symlink_reparse_points++;
1811 features->other_reparse_points++;
1813 if (inode->i_security_id != -1)
1814 features->security_descriptors++;
1815 if (dentry->short_name_nbytes)
1816 features->short_names++;
1817 if (inode_has_unix_data(inode))
1818 features->unix_data++;
1819 inode->i_visited = 1;
1823 /* Tally the features necessary to extract a dentry tree. */
1825 dentry_tree_get_features(struct wim_dentry *root, struct wim_features *features)
1827 memset(features, 0, sizeof(struct wim_features));
1828 for_dentry_in_tree(root, dentry_tally_features, features);
1829 dentry_tree_clear_inode_visited(root);
1833 compute_supported_attributes_mask(const struct wim_features *supported_features)
1837 if (!supported_features->archive_files)
1838 mask &= ~FILE_ATTRIBUTE_ARCHIVE;
1840 if (!supported_features->hidden_files)
1841 mask &= ~FILE_ATTRIBUTE_HIDDEN;
1843 if (!supported_features->system_files)
1844 mask &= ~FILE_ATTRIBUTE_SYSTEM;
1846 if (!supported_features->not_context_indexed_files)
1847 mask &= ~FILE_ATTRIBUTE_NOT_CONTENT_INDEXED;
1849 if (!supported_features->compressed_files)
1850 mask &= ~FILE_ATTRIBUTE_COMPRESSED;
1852 if (!supported_features->sparse_files)
1853 mask &= ~FILE_ATTRIBUTE_SPARSE_FILE;
1855 if (!supported_features->reparse_points)
1856 mask &= ~FILE_ATTRIBUTE_REPARSE_POINT;
1862 do_feature_check(const struct wim_features *required_features,
1863 const struct wim_features *supported_features,
1865 const struct apply_operations *ops,
1866 const tchar *wim_source_path)
1869 const tchar *mode = T("this extraction mode");
1871 if (wim_source_path[0] == '\0')
1872 loc = T("the WIM image");
1874 loc = wim_source_path;
1876 /* We're an archive program, so theoretically we can do what we want
1877 * with FILE_ATTRIBUTE_ARCHIVE (which is a dumb flag anyway). Don't
1878 * bother the user about it. */
1880 if (required_features->archive_files && !supported_features->archive_files)
1883 "%lu files in %"TS" are marked as archived, but this attribute\n"
1884 " is not supported in %"TS".",
1885 required_features->archive_files, loc, mode);
1889 if (required_features->hidden_files && !supported_features->hidden_files)
1892 "%lu files in %"TS" are marked as hidden, but this\n"
1893 " attribute is not supported in %"TS".",
1894 required_features->hidden_files, loc, mode);
1897 if (required_features->system_files && !supported_features->system_files)
1900 "%lu files in %"TS" are marked as system files,\n"
1901 " but this attribute is not supported in %"TS".",
1902 required_features->system_files, loc, mode);
1905 if (required_features->compressed_files && !supported_features->compressed_files)
1908 "%lu files in %"TS" are marked as being transparently\n"
1909 " compressed, but transparent compression is not supported in\n"
1910 " %"TS". These files will be extracted as uncompressed.",
1911 required_features->compressed_files, loc, mode);
1914 if (required_features->encrypted_files && !supported_features->encrypted_files)
1917 "%lu files in %"TS" are marked as being encrypted,\n"
1918 " but encryption is not supported in %"TS". These files\n"
1919 " will not be extracted.",
1920 required_features->encrypted_files, loc, mode);
1923 if (required_features->encrypted_directories &&
1924 !supported_features->encrypted_directories)
1927 "%lu directories in %"TS" are marked as being encrypted,\n"
1928 " but encryption is not supported in %"TS".\n"
1929 " These directories will be extracted as unencrypted.",
1930 required_features->encrypted_directories, loc, mode);
1933 if (required_features->not_context_indexed_files &&
1934 !supported_features->not_context_indexed_files)
1937 "%lu files in %"TS" are marked as not content indexed,\n"
1938 " but this attribute is not supported in %"TS".",
1939 required_features->not_context_indexed_files, loc, mode);
1942 if (required_features->sparse_files && !supported_features->sparse_files)
1945 "%lu files in %"TS" are marked as sparse, but creating\n"
1946 " sparse files is not supported in %"TS". These files\n"
1947 " will be extracted as non-sparse.",
1948 required_features->sparse_files, loc, mode);
1951 if (required_features->named_data_streams &&
1952 !supported_features->named_data_streams)
1955 "%lu files in %"TS" contain one or more alternate (named)\n"
1956 " data streams, which are not supported in %"TS".\n"
1957 " Alternate data streams will NOT be extracted.",
1958 required_features->named_data_streams, loc, mode);
1961 if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
1962 WIMLIB_EXTRACT_FLAG_SYMLINK)) &&
1963 required_features->named_data_streams &&
1964 supported_features->named_data_streams)
1967 "%lu files in %"TS" contain one or more alternate (named)\n"
1968 " data streams, which are not supported in linked extraction mode.\n"
1969 " Alternate data streams will NOT be extracted.",
1970 required_features->named_data_streams, loc);
1973 if (required_features->hard_links && !supported_features->hard_links)
1976 "%lu files in %"TS" are hard links, but hard links are\n"
1977 " not supported in %"TS". Hard links will be extracted as\n"
1978 " duplicate copies of the linked files.",
1979 required_features->hard_links, loc, mode);
1982 if (required_features->reparse_points && !supported_features->reparse_points)
1984 if (supported_features->symlink_reparse_points) {
1985 if (required_features->other_reparse_points) {
1987 "%lu files in %"TS" are reparse points that are neither\n"
1988 " symbolic links nor junction points and are not supported in\n"
1989 " %"TS". These reparse points will not be extracted.",
1990 required_features->other_reparse_points, loc,
1995 "%lu files in %"TS" are reparse points, which are\n"
1996 " not supported in %"TS" and will not be extracted.",
1997 required_features->reparse_points, loc, mode);
2001 if (required_features->security_descriptors &&
2002 !supported_features->security_descriptors)
2005 "%lu files in %"TS" have Windows NT security descriptors,\n"
2006 " but extracting security descriptors is not supported in\n"
2007 " %"TS". No security descriptors will be extracted.",
2008 required_features->security_descriptors, loc, mode);
2011 if (required_features->short_names && !supported_features->short_names)
2014 "%lu files in %"TS" have short (DOS) names, but\n"
2015 " extracting short names is not supported in %"TS".\n"
2016 " Short names will not be extracted.\n",
2017 required_features->short_names, loc, mode);
2020 if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
2021 required_features->unix_data && !supported_features->unix_data)
2023 ERROR("Extracting UNIX data is not supported in %"TS, mode);
2024 return WIMLIB_ERR_UNSUPPORTED;
2026 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) &&
2027 required_features->short_names && !supported_features->short_names)
2029 ERROR("Extracting short names is not supported in %"TS"", mode);
2030 return WIMLIB_ERR_UNSUPPORTED;
2032 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
2033 !ops->set_timestamps)
2035 ERROR("Extracting timestamps is not supported in %"TS"", mode);
2036 return WIMLIB_ERR_UNSUPPORTED;
2038 if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
2039 WIMLIB_EXTRACT_FLAG_UNIX_DATA))
2040 == WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
2041 required_features->security_descriptors &&
2042 !supported_features->security_descriptors)
2044 ERROR("Extracting security descriptors is not supported in %"TS, mode);
2045 return WIMLIB_ERR_UNSUPPORTED;
2048 if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
2049 !supported_features->hard_links)
2051 ERROR("Hard link extraction mode requested, but "
2052 "%"TS" does not support hard links!", mode);
2053 return WIMLIB_ERR_UNSUPPORTED;
2056 if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
2057 required_features->symlink_reparse_points &&
2058 !(supported_features->symlink_reparse_points ||
2059 supported_features->reparse_points))
2061 ERROR("Extracting symbolic links is not supported in %"TS, mode);
2062 return WIMLIB_ERR_UNSUPPORTED;
2065 if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
2066 !supported_features->symlink_reparse_points)
2068 ERROR("Symbolic link extraction mode requested, but "
2069 "%"TS" does not support symbolic "
2071 return WIMLIB_ERR_UNSUPPORTED;
2077 do_extract_warnings(struct apply_ctx *ctx)
2079 if (ctx->partial_security_descriptors == 0 &&
2080 ctx->no_security_descriptors == 0)
2083 WARNING("Extraction to \"%"TS"\" complete, but with one or more warnings:",
2085 if (ctx->partial_security_descriptors != 0) {
2086 WARNING("- Could only partially set the security descriptor\n"
2087 " on %lu files or directories.",
2088 ctx->partial_security_descriptors);
2090 if (ctx->no_security_descriptors != 0) {
2091 WARNING("- Could not set security descriptor at all\n"
2092 " on %lu files or directories.",
2093 ctx->no_security_descriptors);
2096 WARNING("To fully restore all security descriptors, run the program\n"
2097 " with Administrator rights.");
2102 * extract_tree - Extract a file or directory tree from the currently selected
2105 * @wim: WIMStruct for the WIM file, with the desired image selected
2106 * (as wim->current_image).
2109 * "Canonical" (i.e. no leading or trailing slashes, path
2110 * separators WIM_PATH_SEPARATOR) path inside the WIM image to
2111 * extract. An empty string means the full image.
2114 * Filesystem path to extract the file or directory tree to.
2115 * (Or, with WIMLIB_EXTRACT_FLAG_NTFS: the name of a NTFS volume.)
2118 * WIMLIB_EXTRACT_FLAG_*. Also, the private flag
2119 * WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being
2120 * called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as
2124 * If non-NULL, progress function for the extraction. The messages
2125 * that may be sent in this function are:
2127 * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or
2128 * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
2129 * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN;
2130 * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END;
2131 * WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY;
2132 * WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS;
2133 * WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS;
2134 * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or
2135 * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2137 * Returns 0 on success; a positive WIMLIB_ERR_* code on failure.
2140 extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target,
2141 int extract_flags, wimlib_progress_func_t progress_func)
2143 struct wim_dentry *root;
2144 struct wim_features required_features;
2145 struct apply_ctx ctx;
2147 struct wim_lookup_table_entry *lte;
2149 /* Start initializing the apply_ctx. */
2150 memset(&ctx, 0, sizeof(struct apply_ctx));
2152 ctx.extract_flags = extract_flags;
2153 ctx.target = target;
2154 ctx.target_nchars = tstrlen(target);
2155 ctx.progress_func = progress_func;
2156 if (progress_func) {
2157 ctx.progress.extract.wimfile_name = wim->filename;
2158 ctx.progress.extract.image = wim->current_image;
2159 ctx.progress.extract.extract_flags = (extract_flags &
2160 WIMLIB_EXTRACT_MASK_PUBLIC);
2161 ctx.progress.extract.image_name = wimlib_get_image_name(wim,
2162 wim->current_image);
2163 ctx.progress.extract.extract_root_wim_source_path = wim_source_path;
2164 ctx.progress.extract.target = target;
2166 INIT_LIST_HEAD(&ctx.stream_list);
2168 /* Translate the path to extract into the corresponding
2169 * `struct wim_dentry', which will be the root of the
2170 * "dentry tree" to extract. */
2171 root = get_dentry(wim, wim_source_path);
2173 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
2174 wim_source_path, wim->current_image);
2175 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
2179 ctx.extract_root = root;
2181 /* Select the appropriate apply_operations based on the
2182 * platform and extract_flags. */
2184 ctx.ops = &win32_apply_ops;
2186 ctx.ops = &unix_apply_ops;
2190 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
2191 ctx.ops = &ntfs_3g_apply_ops;
2194 /* Call the start_extract() callback. This gives the apply_operations
2195 * implementation a chance to do any setup needed to access the volume.
2196 * Furthermore, it's expected to set the supported features of this
2197 * extraction mode (ctx.supported_features), which are determined at
2198 * runtime as they may vary depending on the actual volume. These
2199 * features are then compared with the actual features extracting this
2200 * dentry tree requires. Some mismatches will merely produce warnings
2201 * and the unsupported data will be ignored; others will produce errors.
2203 ret = ctx.ops->start_extract(target, &ctx);
2207 dentry_tree_get_features(root, &required_features);
2208 ret = do_feature_check(&required_features, &ctx.supported_features,
2209 extract_flags, ctx.ops, wim_source_path);
2211 goto out_finish_or_abort_extract;
2213 ctx.supported_attributes_mask =
2214 compute_supported_attributes_mask(&ctx.supported_features);
2216 /* Figure out whether the root dentry is being extracted to the root of
2217 * a volume and therefore needs to be treated "specially", for example
2218 * not being explicitly created and not having attributes set. */
2219 if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
2220 ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
2222 /* Calculate the actual filename component of each extracted dentry. In
2223 * the process, set the dentry->extraction_skipped flag on dentries that
2224 * are being skipped for some reason (e.g. invalid filename). */
2225 ret = for_dentry_in_tree(root, dentry_calculate_extraction_path, &ctx);
2227 goto out_dentry_reset_needs_extraction;
2229 /* Build the list of the streams that need to be extracted and
2230 * initialize ctx.progress.extract with stream information. */
2231 ret = for_dentry_in_tree(ctx.extract_root,
2232 dentry_resolve_and_zero_lte_refcnt, &ctx);
2234 goto out_dentry_reset_needs_extraction;
2236 ret = for_dentry_in_tree(ctx.extract_root,
2237 dentry_add_streams_to_extract, &ctx);
2239 goto out_teardown_stream_list;
2241 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2242 /* When extracting from a pipe, the number of bytes of data to
2243 * extract can't be determined in the normal way (examining the
2244 * lookup table), since at this point all we have is a set of
2245 * SHA1 message digests of streams that need to be extracted.
2246 * However, we can get a reasonably accurate estimate by taking
2247 * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
2248 * data. This does assume that a full image is being extracted,
2249 * but currently there is no API for doing otherwise. (Also,
2250 * subtract <HARDLINKBYTES> from this if hard links are
2251 * supported by the extraction mode.) */
2252 ctx.progress.extract.total_bytes =
2253 wim_info_get_image_total_bytes(wim->wim_info,
2254 wim->current_image);
2255 if (ctx.supported_features.hard_links) {
2256 ctx.progress.extract.total_bytes -=
2257 wim_info_get_image_hard_link_bytes(wim->wim_info,
2258 wim->current_image);
2262 /* Handle the special case of extracting a file to standard
2263 * output. In that case, "root" should be a single file, not a
2264 * directory tree. (If not, extract_dentry_to_stdout() will
2265 * return an error.) */
2266 if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
2267 ret = extract_dentry_to_stdout(root);
2268 goto out_teardown_stream_list;
2271 /* If a sequential extraction was specified, sort the streams to be
2272 * extracted by their position in the WIM file so that the WIM file can
2273 * be read sequentially. */
2274 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SEQUENTIAL |
2275 WIMLIB_EXTRACT_FLAG_FROM_PIPE))
2276 == WIMLIB_EXTRACT_FLAG_SEQUENTIAL)
2278 ret = sort_stream_list_by_sequential_order(
2280 offsetof(struct wim_lookup_table_entry,
2283 goto out_teardown_stream_list;
2286 if (ctx.ops->realpath_works_on_nonexisting_files &&
2287 ((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
2288 ctx.ops->requires_realtarget_in_paths))
2290 ctx.realtarget = realpath(target, NULL);
2291 if (!ctx.realtarget) {
2292 ret = WIMLIB_ERR_NOMEM;
2293 goto out_teardown_stream_list;
2295 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2298 if (progress_func) {
2299 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN :
2300 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
2304 if (!ctx.root_dentry_is_special)
2306 tchar path[ctx.ops->path_max];
2307 if (build_extraction_path(path, root, &ctx))
2309 ret = extract_inode(path, &ctx, root->d_inode);
2311 goto out_free_realtarget;
2315 /* If we need to fix up the targets of absolute symbolic links
2316 * (WIMLIB_EXTRACT_FLAG_RPFIX) or the extraction mode requires paths to
2317 * be absolute, use realpath() (or its replacement on Windows) to get
2318 * the absolute path to the extraction target. Note that this requires
2319 * the target directory to exist, unless
2320 * realpath_works_on_nonexisting_files is set in the apply_operations.
2322 if (!ctx.realtarget &&
2323 (((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) &&
2324 required_features.symlink_reparse_points) ||
2325 ctx.ops->requires_realtarget_in_paths))
2327 ctx.realtarget = realpath(target, NULL);
2328 if (!ctx.realtarget) {
2329 ret = WIMLIB_ERR_NOMEM;
2330 goto out_free_realtarget;
2332 ctx.realtarget_nchars = tstrlen(ctx.realtarget);
2335 if (ctx.ops->requires_short_name_reordering) {
2336 ret = for_dentry_in_tree(root, dentry_extract_dir_skeleton,
2339 goto out_free_realtarget;
2342 /* Finally, the important part: extract the tree of files. */
2343 if (extract_flags & (WIMLIB_EXTRACT_FLAG_SEQUENTIAL |
2344 WIMLIB_EXTRACT_FLAG_FROM_PIPE)) {
2345 /* Sequential extraction requested, so two passes are needed
2346 * (one for directory structure, one for streams.) */
2348 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2351 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
2352 ret = for_dentry_in_tree(root, dentry_extract_skeleton, &ctx);
2354 goto out_free_realtarget;
2357 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2359 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
2360 ret = extract_streams_from_pipe(&ctx);
2362 ret = extract_stream_list(&ctx);
2364 goto out_free_realtarget;
2366 /* Sequential extraction was not requested, so we can make do
2367 * with one pass where we both create the files and extract
2370 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
2372 ret = for_dentry_in_tree(root, dentry_extract, &ctx);
2374 goto out_free_realtarget;
2376 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
2380 /* If the total number of bytes to extract was miscalculated, just jump
2381 * to the calculated number in order to avoid confusing the progress
2382 * function. This should only occur when extracting from a pipe. */
2383 if (ctx.progress.extract.completed_bytes != ctx.progress.extract.total_bytes)
2385 DEBUG("Calculated %"PRIu64" bytes to extract, but actually "
2386 "extracted %"PRIu64,
2387 ctx.progress.extract.total_bytes,
2388 ctx.progress.extract.completed_bytes);
2390 if (progress_func &&
2391 ctx.progress.extract.completed_bytes < ctx.progress.extract.total_bytes)
2393 ctx.progress.extract.completed_bytes = ctx.progress.extract.total_bytes;
2394 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &ctx.progress);
2397 /* Apply security descriptors and timestamps. This is done at the end,
2398 * and in a depth-first manner, to prevent timestamps from getting
2399 * changed by subsequent extract operations and to minimize the chance
2400 * of the restored security descriptors getting in our way. */
2402 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
2404 ret = for_dentry_in_tree_depth(root, dentry_extract_final, &ctx);
2406 goto out_free_realtarget;
2408 if (progress_func) {
2409 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END :
2410 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
2414 do_extract_warnings(&ctx);
2417 out_free_realtarget:
2418 FREE(ctx.realtarget);
2419 out_teardown_stream_list:
2420 /* Free memory allocated as part of the mapping from each
2421 * wim_lookup_table_entry to the dentries that reference it. */
2422 if (ctx.extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL)
2423 list_for_each_entry(lte, &ctx.stream_list, extraction_list)
2424 if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
2425 FREE(lte->lte_dentries);
2426 out_dentry_reset_needs_extraction:
2427 for_dentry_in_tree(root, dentry_reset_needs_extraction, NULL);
2428 out_finish_or_abort_extract:
2430 if (ctx.ops->abort_extract)
2431 ctx.ops->abort_extract(&ctx);
2433 if (ctx.ops->finish_extract)
2434 ret = ctx.ops->finish_extract(&ctx);
2440 /* Validates a single wimlib_extract_command, mostly checking to make sure the
2441 * extract flags make sense. */
2443 check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
2447 /* Empty destination path? */
2448 if (cmd->fs_dest_path[0] == T('\0'))
2449 return WIMLIB_ERR_INVALID_PARAM;
2451 extract_flags = cmd->extract_flags;
2453 /* Check for invalid flag combinations */
2454 if ((extract_flags &
2455 (WIMLIB_EXTRACT_FLAG_SYMLINK |
2456 WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
2457 WIMLIB_EXTRACT_FLAG_HARDLINK))
2458 return WIMLIB_ERR_INVALID_PARAM;
2460 if ((extract_flags &
2461 (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2462 WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
2463 WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2464 return WIMLIB_ERR_INVALID_PARAM;
2466 if ((extract_flags &
2467 (WIMLIB_EXTRACT_FLAG_RPFIX |
2468 WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
2469 WIMLIB_EXTRACT_FLAG_NORPFIX))
2470 return WIMLIB_ERR_INVALID_PARAM;
2472 if ((extract_flags &
2473 (WIMLIB_EXTRACT_FLAG_RESUME |
2474 WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
2475 return WIMLIB_ERR_INVALID_PARAM;
2477 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2478 #ifndef WITH_NTFS_3G
2479 ERROR("wimlib was compiled without support for NTFS-3g, so\n"
2480 " we cannot apply a WIM image directly to a NTFS volume.");
2481 return WIMLIB_ERR_UNSUPPORTED;
2485 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
2486 WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0)
2488 /* Do reparse point fixups by default if the WIM header says
2489 * they are enabled and we are extracting a full image. */
2490 if (wim_header_flags & WIM_HDR_FLAG_RP_FIX)
2491 extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
2494 /* TODO: Since UNIX data entries are stored in the file resources, in a
2495 * completely sequential extraction they may come up before the
2496 * corresponding file or symbolic link data. This needs to be handled
2498 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2499 WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2500 == (WIMLIB_EXTRACT_FLAG_UNIX_DATA |
2501 WIMLIB_EXTRACT_FLAG_SEQUENTIAL))
2503 if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
2504 WARNING("Setting UNIX file/owner group may "
2505 "be impossible on some\n"
2507 "when applying from a pipe.");
2509 extract_flags &= ~WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2510 WARNING("Disabling sequential extraction for "
2515 cmd->extract_flags = extract_flags;
2520 /* Internal function to execute extraction commands for a WIM image. The paths
2521 * in the extract commands are expected to be already "canonicalized". */
2523 do_wimlib_extract_files(WIMStruct *wim,
2525 struct wimlib_extract_command *cmds,
2527 wimlib_progress_func_t progress_func)
2530 bool found_link_cmd = false;
2531 bool found_nolink_cmd = false;
2533 /* Select the image from which we are extracting files */
2534 ret = select_wim_image(wim, image);
2538 /* Make sure there are no streams in the WIM that have not been
2539 * checksummed yet. */
2540 ret = wim_checksum_unhashed_streams(wim);
2544 /* Check for problems with the extraction commands */
2545 for (size_t i = 0; i < num_cmds; i++) {
2546 ret = check_extract_command(&cmds[i], wim->hdr.flags);
2549 if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2550 WIMLIB_EXTRACT_FLAG_HARDLINK)) {
2551 found_link_cmd = true;
2553 found_nolink_cmd = true;
2555 if (found_link_cmd && found_nolink_cmd) {
2556 ERROR("Symlink or hardlink extraction mode must "
2557 "be set on all extraction commands");
2558 return WIMLIB_ERR_INVALID_PARAM;
2562 /* Execute the extraction commands */
2563 for (size_t i = 0; i < num_cmds; i++) {
2564 ret = extract_tree(wim,
2565 cmds[i].wim_source_path,
2566 cmds[i].fs_dest_path,
2567 cmds[i].extract_flags,
2575 /* API function documented in wimlib.h */
2577 wimlib_extract_files(WIMStruct *wim,
2579 const struct wimlib_extract_command *cmds,
2581 int default_extract_flags,
2582 wimlib_progress_func_t progress_func)
2585 struct wimlib_extract_command *cmds_copy;
2588 default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2593 cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
2595 return WIMLIB_ERR_NOMEM;
2597 for (size_t i = 0; i < num_cmds; i++) {
2598 cmds_copy[i].extract_flags = (default_extract_flags |
2599 cmds[i].extract_flags)
2600 & WIMLIB_EXTRACT_MASK_PUBLIC;
2601 all_flags |= cmds_copy[i].extract_flags;
2603 cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path);
2604 if (!cmds_copy[i].wim_source_path) {
2605 ret = WIMLIB_ERR_NOMEM;
2606 goto out_free_cmds_copy;
2609 cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path);
2610 if (!cmds_copy[i].fs_dest_path) {
2611 ret = WIMLIB_ERR_NOMEM;
2612 goto out_free_cmds_copy;
2616 ret = do_wimlib_extract_files(wim, image,
2617 cmds_copy, num_cmds,
2620 if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2621 WIMLIB_EXTRACT_FLAG_HARDLINK))
2623 for_lookup_table_entry(wim->lookup_table,
2624 lte_free_extracted_file, NULL);
2627 for (size_t i = 0; i < num_cmds; i++) {
2628 FREE(cmds_copy[i].wim_source_path);
2629 FREE(cmds_copy[i].fs_dest_path);
2636 * Extracts an image from a WIM file.
2638 * @wim: WIMStruct for the WIM file.
2640 * @image: Number of the single image to extract.
2642 * @target: Directory or NTFS volume to extract the image to.
2644 * @extract_flags: Bitwise or of WIMLIB_EXTRACT_FLAG_*.
2646 * @progress_func: If non-NULL, a progress function to be called
2649 * Returns 0 on success; nonzero on failure.
2652 extract_single_image(WIMStruct *wim, int image,
2653 const tchar *target, int extract_flags,
2654 wimlib_progress_func_t progress_func)
2657 tchar *target_copy = canonicalize_fs_path(target);
2658 if (target_copy == NULL)
2659 return WIMLIB_ERR_NOMEM;
2660 struct wimlib_extract_command cmd = {
2661 .wim_source_path = T(""),
2662 .fs_dest_path = target_copy,
2663 .extract_flags = extract_flags,
2665 ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func);
2670 static const tchar * const filename_forbidden_chars =
2679 /* This function checks if it is okay to use a WIM image's name as a directory
2682 image_name_ok_as_dir(const tchar *image_name)
2684 return image_name && *image_name &&
2685 !tstrpbrk(image_name, filename_forbidden_chars) &&
2686 tstrcmp(image_name, T(".")) &&
2687 tstrcmp(image_name, T(".."));
2690 /* Extracts all images from the WIM to the directory @target, with the images
2691 * placed in subdirectories named by their image names. */
2693 extract_all_images(WIMStruct *wim,
2694 const tchar *target,
2696 wimlib_progress_func_t progress_func)
2698 size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
2699 size_t output_path_len = tstrlen(target);
2700 tchar buf[output_path_len + 1 + image_name_max_len + 1];
2703 const tchar *image_name;
2706 extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
2708 if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
2709 ERROR("Cannot extract multiple images in NTFS extraction mode.");
2710 return WIMLIB_ERR_INVALID_PARAM;
2713 if (tstat(target, &stbuf)) {
2714 if (errno == ENOENT) {
2715 if (tmkdir(target, 0755)) {
2716 ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
2717 return WIMLIB_ERR_MKDIR;
2720 ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
2721 return WIMLIB_ERR_STAT;
2723 } else if (!S_ISDIR(stbuf.st_mode)) {
2724 ERROR("\"%"TS"\" is not a directory", target);
2725 return WIMLIB_ERR_NOTDIR;
2728 tmemcpy(buf, target, output_path_len);
2729 buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
2730 for (image = 1; image <= wim->hdr.image_count; image++) {
2731 image_name = wimlib_get_image_name(wim, image);
2732 if (image_name_ok_as_dir(image_name)) {
2733 tstrcpy(buf + output_path_len + 1, image_name);
2735 /* Image name is empty or contains forbidden characters.
2736 * Use image number instead. */
2737 tsprintf(buf + output_path_len + 1, T("%d"), image);
2739 ret = extract_single_image(wim, image, buf, extract_flags,
2748 do_wimlib_extract_image(WIMStruct *wim,
2750 const tchar *target,
2752 wimlib_progress_func_t progress_func)
2756 if (image == WIMLIB_ALL_IMAGES) {
2757 ret = extract_all_images(wim, target, extract_flags,
2760 ret = extract_single_image(wim, image, target, extract_flags,
2764 if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
2765 WIMLIB_EXTRACT_FLAG_HARDLINK))
2767 for_lookup_table_entry(wim->lookup_table,
2768 lte_free_extracted_file,
2774 /* API function documented in wimlib.h */
2776 wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
2777 const tchar *target, int extract_flags,
2778 wimlib_progress_func_t progress_func)
2782 struct filedes *in_fd;
2786 extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2788 if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
2789 return WIMLIB_ERR_INVALID_PARAM;
2791 extract_flags |= WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
2793 /* Read the WIM header from the pipe and get a WIMStruct to represent
2794 * the pipable WIM. Caveats: Unlike getting a WIMStruct with
2795 * wimlib_open_wim(), getting a WIMStruct in this way will result in
2796 * an empty lookup table, no XML data read, and no filename set. */
2797 ret = open_wim_as_WIMStruct(&pipe_fd,
2798 WIMLIB_OPEN_FLAG_FROM_PIPE,
2799 &pwm, progress_func);
2803 /* Sanity check to make sure this is a pipable WIM. */
2804 if (pwm->hdr.magic != PWM_MAGIC) {
2805 ERROR("The WIM being read from file descriptor %d "
2806 "is not pipable!", pipe_fd);
2807 ret = WIMLIB_ERR_NOT_PIPABLE;
2808 goto out_wimlib_free;
2811 /* Sanity check to make sure the first part of a pipable split WIM is
2812 * sent over the pipe first. */
2813 if (pwm->hdr.part_number != 1) {
2814 ERROR("The first part of the split WIM must be "
2815 "sent over the pipe first.");
2816 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2817 goto out_wimlib_free;
2820 in_fd = &pwm->in_fd;
2821 wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
2823 /* As mentioned, the WIMStruct we created from the pipe does not have
2824 * XML data yet. Fix this by reading the extra copy of the XML data
2825 * that directly follows the header in pipable WIMs. (Note: see
2826 * write_pipable_wim() for more details about the format of pipable
2829 struct wim_lookup_table_entry xml_lte;
2830 struct wim_resource_spec xml_rspec;
2831 ret = read_pwm_stream_header(pwm, &xml_lte, &xml_rspec, 0, NULL);
2833 goto out_wimlib_free;
2835 if (!(xml_lte.flags & WIM_RESHDR_FLAG_METADATA))
2837 ERROR("Expected XML data, but found non-metadata "
2839 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2840 goto out_wimlib_free;
2843 wim_res_spec_to_hdr(&xml_rspec, &pwm->hdr.xml_data_reshdr);
2845 ret = read_wim_xml_data(pwm);
2847 goto out_wimlib_free;
2849 if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
2850 ERROR("Image count in XML data is not the same as in WIM header.");
2851 ret = WIMLIB_ERR_XML;
2852 goto out_wimlib_free;
2856 /* Get image index (this may use the XML data that was just read to
2857 * resolve an image name). */
2858 if (image_num_or_name) {
2859 image = wimlib_resolve_image(pwm, image_num_or_name);
2860 if (image == WIMLIB_NO_IMAGE) {
2861 ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
2863 ret = WIMLIB_ERR_INVALID_IMAGE;
2864 goto out_wimlib_free;
2865 } else if (image == WIMLIB_ALL_IMAGES) {
2866 ERROR("Applying all images from a pipe is not supported.");
2867 ret = WIMLIB_ERR_INVALID_IMAGE;
2868 goto out_wimlib_free;
2871 if (pwm->hdr.image_count != 1) {
2872 ERROR("No image was specified, but the pipable WIM "
2873 "did not contain exactly 1 image");
2874 ret = WIMLIB_ERR_INVALID_IMAGE;
2875 goto out_wimlib_free;
2880 /* Load the needed metadata resource. */
2881 for (i = 1; i <= pwm->hdr.image_count; i++) {
2882 struct wim_lookup_table_entry *metadata_lte;
2883 struct wim_image_metadata *imd;
2884 struct wim_resource_spec *metadata_rspec;
2886 metadata_lte = new_lookup_table_entry();
2887 if (metadata_lte == NULL) {
2888 ret = WIMLIB_ERR_NOMEM;
2889 goto out_wimlib_free;
2891 metadata_rspec = MALLOC(sizeof(struct wim_resource_spec));
2892 if (metadata_rspec == NULL) {
2893 ret = WIMLIB_ERR_NOMEM;
2894 free_lookup_table_entry(metadata_lte);
2895 goto out_wimlib_free;
2898 ret = read_pwm_stream_header(pwm, metadata_lte, metadata_rspec, 0, NULL);
2899 imd = pwm->image_metadata[i - 1];
2900 imd->metadata_lte = metadata_lte;
2902 FREE(metadata_rspec);
2903 goto out_wimlib_free;
2906 if (!(metadata_lte->flags & WIM_RESHDR_FLAG_METADATA)) {
2907 ERROR("Expected metadata resource, but found "
2908 "non-metadata stream.");
2909 ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
2910 goto out_wimlib_free;
2914 /* Metadata resource is for the images being extracted.
2915 * Parse it and save the metadata in memory. */
2916 ret = read_metadata_resource(pwm, imd);
2918 goto out_wimlib_free;
2921 /* Metadata resource is not for the image being
2922 * extracted. Skip over it. */
2923 ret = skip_pwm_stream(metadata_lte);
2925 goto out_wimlib_free;
2928 /* Extract the image. */
2929 extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
2930 ret = do_wimlib_extract_image(pwm, image, target,
2931 extract_flags, progress_func);
2932 /* Clean up and return. */
2938 /* API function documented in wimlib.h */
2940 wimlib_extract_image(WIMStruct *wim,
2942 const tchar *target,
2944 wimlib_progress_func_t progress_func)
2946 extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
2947 return do_wimlib_extract_image(wim, image, target, extract_flags,