*/
/*
- * Copyright (C) 2012, 2013 Eric Biggers
+ * Copyright (C) 2012, 2013, 2014 Eric Biggers
*
* This file is part of wimlib, a library for working with WIM files.
*
/*
* This file provides the API functions wimlib_extract_image(),
- * wimlib_extract_files(), and wimlib_extract_image_from_pipe(). Internally,
- * all end up calling extract_tree() zero or more times to extract a tree of
- * files from the currently selected WIM image to the specified target directory
- * or NTFS volume.
+ * wimlib_extract_image_from_pipe(), wimlib_extract_paths(), and
+ * wimlib_extract_pathlist(). Internally, all end up calling
+ * do_wimlib_extract_paths() and extract_trees().
*
* Although wimlib supports multiple extraction modes/backends (NTFS-3g, UNIX,
* Win32), this file does not itself have code to extract files or directories
#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
#define WIMLIB_EXTRACT_FLAG_FROM_PIPE 0x40000000
-#define WIMLIB_EXTRACT_FLAG_PATHMODE 0x20000000
-#define WIMLIB_EXTRACT_MASK_PUBLIC 0x1fffffff
+#define WIMLIB_EXTRACT_FLAG_IMAGEMODE 0x20000000
+
+/* Keep in sync with wimlib.h */
+#define WIMLIB_EXTRACT_MASK_PUBLIC \
+ (WIMLIB_EXTRACT_FLAG_NTFS | \
+ WIMLIB_EXTRACT_FLAG_HARDLINK | \
+ WIMLIB_EXTRACT_FLAG_SYMLINK | \
+ WIMLIB_EXTRACT_FLAG_VERBOSE | \
+ WIMLIB_EXTRACT_FLAG_SEQUENTIAL | \
+ WIMLIB_EXTRACT_FLAG_UNIX_DATA | \
+ WIMLIB_EXTRACT_FLAG_NO_ACLS | \
+ WIMLIB_EXTRACT_FLAG_STRICT_ACLS | \
+ WIMLIB_EXTRACT_FLAG_RPFIX | \
+ WIMLIB_EXTRACT_FLAG_NORPFIX | \
+ WIMLIB_EXTRACT_FLAG_TO_STDOUT | \
+ WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES | \
+ WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS | \
+ WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS | \
+ WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES | \
+ WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS | \
+ WIMLIB_EXTRACT_FLAG_RESUME | \
+ WIMLIB_EXTRACT_FLAG_FILE_ORDER | \
+ WIMLIB_EXTRACT_FLAG_GLOB_PATHS | \
+ WIMLIB_EXTRACT_FLAG_STRICT_GLOB | \
+ WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES | \
+ WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE | \
+ WIMLIB_EXTRACT_FLAG_WIMBOOT)
-/* Given a WIM dentry in the tree to be extracted, resolve all streams in the
- * corresponding inode and set 'out_refcnt' in each to 0. */
-static int
-dentry_resolve_and_zero_lte_refcnt(struct wim_dentry *dentry, void *_ctx)
+static bool
+dentry_in_list(const struct wim_dentry *dentry)
{
- struct apply_ctx *ctx = _ctx;
- struct wim_inode *inode = dentry->d_inode;
- struct wim_lookup_table_entry *lte;
- int ret;
- bool force = false;
-
- if (dentry->extraction_skipped)
- return 0;
-
- /* Special case: when extracting from a pipe, the WIM lookup table is
- * initially empty, so "resolving" an inode's streams is initially not
- * possible. However, we still need to keep track of which streams,
- * identified by SHA1 message digests, need to be extracted, so we
- * "resolve" the inode's streams anyway by allocating new entries. */
- if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
- force = true;
- ret = inode_resolve_ltes(inode, ctx->wim->lookup_table, force);
- if (ret)
- return ret;
- for (unsigned i = 0; i <= inode->i_num_ads; i++) {
- lte = inode_stream_lte_resolved(inode, i);
- if (lte)
- lte->out_refcnt = 0;
- }
- return 0;
+ return dentry->extraction_list.next != NULL;
}
static inline bool
return ctx->supported_features.named_data_streams &&
!is_linked_extraction(ctx);
}
-
-static int
-ref_stream_to_extract(struct wim_lookup_table_entry *lte,
- struct wim_dentry *dentry, struct apply_ctx *ctx)
-{
- if (!lte)
- return 0;
-
- /* Tally the size only for each extraction of the stream (not hard
- * links). */
- if (!(dentry->d_inode->i_visited &&
- ctx->supported_features.hard_links) &&
- (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
- lte->extracted_file == NULL)))
- {
- ctx->progress.extract.total_bytes += lte->size;
- ctx->progress.extract.num_streams++;
- }
-
- /* Add stream to the extraction_list only one time, even if it's going
- * to be extracted to multiple locations. */
- if (lte->out_refcnt == 0) {
- list_add_tail(<e->extraction_list, &ctx->stream_list);
- ctx->num_streams_remaining++;
- }
-
- if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
- struct wim_dentry **lte_dentries;
-
- /* Append dentry to this stream's array of dentries referencing
- * it. Use inline array to avoid memory allocation until the
- * number of dentries becomes too large. */
- if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
- lte_dentries = lte->inline_lte_dentries;
- } else {
- struct wim_dentry **prev_lte_dentries;
- size_t alloc_lte_dentries;
-
- if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
- prev_lte_dentries = NULL;
- alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
- } else {
- prev_lte_dentries = lte->lte_dentries;
- alloc_lte_dentries = lte->alloc_lte_dentries;
- }
-
- if (lte->out_refcnt == alloc_lte_dentries) {
- alloc_lte_dentries *= 2;
- lte_dentries = REALLOC(prev_lte_dentries,
- alloc_lte_dentries *
- sizeof(lte_dentries[0]));
- if (lte_dentries == NULL)
- return WIMLIB_ERR_NOMEM;
- if (prev_lte_dentries == NULL) {
- memcpy(lte_dentries,
- lte->inline_lte_dentries,
- sizeof(lte->inline_lte_dentries));
- }
- lte->lte_dentries = lte_dentries;
- lte->alloc_lte_dentries = alloc_lte_dentries;
- }
- lte_dentries = lte->lte_dentries;
- }
- lte_dentries[lte->out_refcnt] = dentry;
- }
- lte->out_refcnt++;
- return 0;
-}
-
-/* Given a WIM dentry in the tree to be extracted, iterate through streams that
- * need to be extracted. For each one, add it to the list of streams to be
- * extracted (ctx->stream_list) if not already done so, and also update the
- * progress information (ctx->progress) with the stream. Furthermore, if doing
- * a sequential extraction, build a mapping from each the stream to the dentries
- * referencing it.
- *
- * This uses the i_visited member of the inodes (assumed to be 0 initially). */
-static int
-dentry_add_streams_to_extract(struct wim_dentry *dentry, void *_ctx)
-{
- struct apply_ctx *ctx = _ctx;
- struct wim_inode *inode = dentry->d_inode;
- int ret;
-
- /* Don't process dentries marked as skipped. */
- if (dentry->extraction_skipped)
- return 0;
-
- /* The unnamed data stream will always be extracted, except in an
- * unlikely case. */
- if (!inode_is_encrypted_directory(inode)) {
- ret = ref_stream_to_extract(inode_unnamed_lte_resolved(inode),
- dentry, ctx);
- if (ret)
- return ret;
- }
-
- /* Named data streams will be extracted only if supported in the current
- * extraction mode and volume, and to avoid complications, if not doing
- * a linked extraction. */
- if (can_extract_named_data_streams(ctx)) {
- for (u16 i = 0; i < inode->i_num_ads; i++) {
- if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
- continue;
- ret = ref_stream_to_extract(inode->i_ads_entries[i].lte,
- dentry, ctx);
- if (ret)
- return ret;
- }
- }
- inode->i_visited = 1;
- return 0;
-}
-
/* Inform library user of progress of stream extraction following the successful
* extraction of a copy of the stream specified by @lte. */
static void
file_spec_t file_spec;
int ret;
- if (dentry->was_hardlinked)
+ if (dentry->was_linked)
return 0;
#ifdef ENABLE_DEBUG
}
} else {
ret = ctx->ops->extract_unnamed_stream(
- file_spec, lte, ctx);
+ file_spec, lte, ctx,
+ dentry);
if (ret)
goto error;
}
int ret;
if (ctx->ops->set_file_attributes &&
- !(dentry == ctx->extract_root && ctx->root_dentry_is_special)) {
+ !(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) &&
+ !(dentry == ctx->target_dentry && ctx->root_dentry_is_special)) {
u32 attributes = dentry->d_inode->i_attributes;
/* Clear unsupported attributes. */
/* The root of the dentry tree being extracted may not be extracted to
* its original name, so its short name should be ignored. */
- if (dentry == ctx->extract_root)
+ if (dentry == ctx->target_dentry)
return 0;
if (ctx->supported_features.short_names) {
if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
return 0;
- if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
+ if ((ctx->target_dentry == dentry) && ctx->root_dentry_is_special)
return 0;
#ifndef __WIN32__
struct wim_inode *inode = dentry->d_inode;
int ret;
- if ((ctx->extract_root == dentry) && ctx->root_dentry_is_special)
+ if ((ctx->target_dentry == dentry) && ctx->root_dentry_is_special)
return 0;
if (ctx->ops->set_timestamps) {
* format understood by the callbacks in the apply_operations being used.
*
* Write the resulting path into @path, which must have room for at least
- * ctx->ops->max_path characters including the null-terminator.
+ * ctx->ops->path_max characters.
*
* Return %true if successful; %false if this WIM dentry doesn't actually need
* to be extracted or if the calculated path exceeds ctx->ops->max_path
* until the extraction root. */
static bool
build_extraction_path(tchar path[], struct wim_dentry *dentry,
- struct apply_ctx *ctx)
+ const struct apply_ctx *ctx)
{
size_t path_nchars;
LIST_HEAD(ancestor_list);
size_t target_prefix_nchars;
struct wim_dentry *d;
- if (dentry->extraction_skipped)
- return false;
-
path_nchars = ctx->ops->path_prefix_nchars;
if (ctx->ops->requires_realtarget_in_paths) {
}
path_nchars += target_prefix_nchars;
- for (d = dentry; d != ctx->extract_root; d = d->parent) {
+ for (d = dentry; d != ctx->target_dentry; d = d->parent) {
+ if (!dentry_in_list(d))
+ break;
+
path_nchars += d->extraction_name_nchars + 1;
list_add(&d->tmp_list, &ancestor_list);
}
int ret;
num_raw_path_components = 0;
- for (d = dentry; d != ctx->extract_root; d = d->parent)
+ for (d = dentry; d != ctx->target_dentry; d = d->parent)
num_raw_path_components++;
if (ctx->ops->requires_realtarget_in_paths)
/* Create this file or directory unless it's the extraction root, which
* was already created if necessary. */
- if (dentry != ctx->extract_root) {
+ if (dentry != ctx->target_dentry) {
ret = extract_inode(path, ctx, inode);
if (ret)
return ret;
ret = extract_multiimage_symlink(oldpath, path, ctx, dentry);
if (ret)
return ret;
- dentry->was_hardlinked = 1;
+ dentry->was_linked = 1;
return 0;
hardlink:
ret = extract_hardlink(oldpath, path, ctx);
if (ret)
return ret;
- dentry->was_hardlinked = 1;
+ dentry->was_linked = 1;
return 0;
}
* apply_operations.requires_short_name_reordering for more details about short
* name reordering. */
static int
-dentry_extract_skeleton(struct wim_dentry *dentry, void *_ctx)
+dentry_extract_skeleton(struct wim_dentry *dentry, struct apply_ctx *ctx)
{
- struct apply_ctx *ctx = _ctx;
tchar path[ctx->ops->path_max];
struct wim_dentry *orig_dentry;
struct wim_dentry *other_dentry;
inode_for_each_dentry(other_dentry, dentry->d_inode) {
if (dentry_has_short_name(other_dentry)
&& !other_dentry->skeleton_extracted
- && other_dentry->in_extraction_tree)
+ && dentry_in_list(other_dentry))
{
DEBUG("Creating %"TS" before %"TS" "
"to guarantee correct DOS name extraction",
return 0;
}
-static int
-dentry_extract_dir_skeleton(struct wim_dentry *dentry, void *_ctx)
-{
- if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
- return dentry_extract_skeleton(dentry, _ctx);
- return 0;
-}
-
/* Create a file or directory, then immediately extract all streams. The WIM
* may not be read sequentially by this function. */
static int
-dentry_extract(struct wim_dentry *dentry, void *_ctx)
+dentry_extract(struct wim_dentry *dentry, struct apply_ctx *ctx)
{
- struct apply_ctx *ctx = _ctx;
tchar path[ctx->ops->path_max];
int ret;
return extract_streams(path, ctx, dentry, NULL, NULL);
}
+/* Finish extracting a file, directory, or symbolic link by setting file
+ * security and timestamps. */
+static int
+dentry_extract_final(struct wim_dentry *dentry, struct apply_ctx *ctx)
+{
+ int ret;
+ tchar path[ctx->ops->path_max];
+
+ if (!build_extraction_path(path, dentry, ctx))
+ return 0;
+
+ ret = extract_security(path, ctx, dentry);
+ if (ret)
+ return ret;
+
+ if (ctx->ops->requires_final_set_attributes_pass) {
+ /* Set file attributes (if supported). */
+ ret = extract_file_attributes(path, ctx, dentry, 1);
+ if (ret)
+ return ret;
+ }
+
+ return extract_timestamps(path, ctx, dentry);
+}
+
+static int
+extract_structure(struct list_head *dentry_list, struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, extraction_list) {
+ ret = dentry_extract_skeleton(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+static int
+extract_dir_structure(struct list_head *dentry_list, struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, extraction_list) {
+ if (dentry_is_directory(dentry)) {
+ ret = dentry_extract_skeleton(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ }
+ return 0;
+}
+
+static int
+extract_dentries(struct list_head *dentry_list, struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, extraction_list) {
+ ret = dentry_extract(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+static int
+extract_final_metadata(struct list_head *dentry_list, struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry_reverse(dentry, dentry_list, extraction_list) {
+ ret = dentry_extract_final(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
/* Creates a temporary file opened for writing. The open file descriptor is
* returned in @fd_ret and its name is returned in @name_ret (dynamically
* allocated). */
{
tchar *name;
int raw_fd;
+ int open_flags;
retry:
name = ttempnam(NULL, T("wimlib"));
return WIMLIB_ERR_NOMEM;
}
- raw_fd = topen(name, O_WRONLY | O_CREAT | O_EXCL | O_BINARY, 0600);
+ open_flags = O_WRONLY | O_CREAT | O_EXCL | O_BINARY;
+#ifdef __WIN32__
+ open_flags |= _O_SHORT_LIVED;
+#endif
+ raw_fd = topen(name, open_flags, 0600);
if (raw_fd < 0) {
if (errno == EEXIST) {
}
static int
-begin_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
- bool is_partial_res,
- void *_ctx)
+begin_extract_stream(struct wim_lookup_table_entry *lte,
+ u32 flags, void *_ctx)
{
struct apply_ctx *ctx = _ctx;
int ret;
- if (!need_tmpfile_to_extract(lte, is_partial_res)) {
+ if (flags & BEGIN_STREAM_FLAG_WHOLE_STREAM) {
+ DEBUG("Whole stream (size=%"PRIu64") will be read into memory",
+ lte->size);
+ ctx->cur_stream = lte;
+ filedes_invalidate(&ctx->tmpfile_fd);
+ return 0;
+ }
+
+ if (!need_tmpfile_to_extract(lte,
+ (flags & BEGIN_STREAM_FLAG_PARTIAL_RESOURCE)))
+ {
DEBUG("Temporary file not needed "
"for stream (size=%"PRIu64")", lte->size);
ret = extract_stream_instances(lte, lte, ctx);
}
static int
-end_extract_stream_to_tmpfile(struct wim_lookup_table_entry *lte,
- int status, void *_ctx)
+extract_chunk(const void *chunk, size_t size, void *_ctx)
+{
+ struct apply_ctx *ctx = _ctx;
+ int ret;
+
+ if (filedes_valid(&ctx->tmpfile_fd)) {
+ ret = full_write(&ctx->tmpfile_fd, chunk, size);
+ if (ret)
+ ERROR_WITH_ERRNO("Error writing to file descriptor");
+ } else {
+ struct wim_lookup_table_entry lte_override;
+
+ memcpy(<e_override, ctx->cur_stream,
+ sizeof(struct wim_lookup_table_entry));
+
+ lte_override.resource_location = RESOURCE_IN_ATTACHED_BUFFER;
+ lte_override.size = size;
+ lte_override.attached_buffer = (void *)chunk;
+
+ ret = extract_stream_instances(ctx->cur_stream, <e_override, ctx);
+ }
+ return ret;
+}
+
+static int
+end_extract_stream(struct wim_lookup_table_entry *lte,
+ int status, void *_ctx)
{
struct apply_ctx *ctx = _ctx;
struct wim_lookup_table_entry lte_override;
int ret;
int errno_save = errno;
+ if (!filedes_valid(&ctx->tmpfile_fd))
+ return status;
+
ret = filedes_close(&ctx->tmpfile_fd);
if (status) {
static int
extract_stream_list(struct apply_ctx *ctx)
{
- if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
- /* Sequential extraction: read the streams in the order in which
- * they appear in the WIM file. */
- struct read_stream_list_callbacks cbs = {
- .begin_stream = begin_extract_stream_to_tmpfile,
- .begin_stream_ctx = ctx,
- .consume_chunk = extract_chunk_to_fd,
- .consume_chunk_ctx = &ctx->tmpfile_fd,
- .end_stream = end_extract_stream_to_tmpfile,
- .end_stream_ctx = ctx,
- };
- return read_stream_list(&ctx->stream_list,
- offsetof(struct wim_lookup_table_entry, extraction_list),
- &cbs, VERIFY_STREAM_HASHES);
- } else {
- /* Extract the streams in unsorted order. */
- struct wim_lookup_table_entry *lte;
- int ret;
-
- list_for_each_entry(lte, &ctx->stream_list, extraction_list) {
- ret = extract_stream_instances(lte, lte, ctx);
- if (ret)
- return ret;
- }
- return 0;
- }
+ struct read_stream_list_callbacks cbs = {
+ .begin_stream = begin_extract_stream,
+ .begin_stream_ctx = ctx,
+ .consume_chunk = extract_chunk,
+ .consume_chunk_ctx = ctx,
+ .end_stream = end_extract_stream,
+ .end_stream_ctx = ctx,
+ };
+ return read_stream_list(&ctx->stream_list,
+ offsetof(struct wim_lookup_table_entry, extraction_list),
+ &cbs, VERIFY_STREAM_HASHES);
}
#define PWM_ALLOW_WIM_HDR 0x00001
if ((found_lte->resource_location != RESOURCE_NONEXISTENT)
&& !(found_lte->flags & WIM_RESHDR_FLAG_METADATA)
- && (needed_lte = lookup_resource(lookup_table, found_lte->hash))
+ && (needed_lte = lookup_stream(lookup_table, found_lte->hash))
&& (needed_lte->out_refcnt))
{
tchar *tmpfile_name = NULL;
/* Extract stream to temporary file. */
ret = create_temporary_file(&tmpfile_fd, &tmpfile_name);
- if (ret)
+ if (ret) {
+ lte_unbind_wim_resource_spec(needed_lte);
goto out_free_found_lte;
+ }
ret = extract_full_stream_to_fd(needed_lte,
&tmpfile_fd);
return 0;
}
-/* Finish extracting a file, directory, or symbolic link by setting file
- * security and timestamps. */
+/* Extract a WIM dentry to standard output.
+ *
+ * This obviously doesn't make sense in all cases. We return an error if the
+ * dentry does not correspond to a regular file. Otherwise we extract the
+ * unnamed data stream only. */
static int
-dentry_extract_final(struct wim_dentry *dentry, void *_ctx)
+extract_dentry_to_stdout(struct wim_dentry *dentry,
+ const struct wim_lookup_table *lookup_table)
{
- struct apply_ctx *ctx = _ctx;
- int ret;
- tchar path[ctx->ops->path_max];
+ struct wim_inode *inode = dentry->d_inode;
+ struct wim_lookup_table_entry *lte;
+ struct filedes _stdout;
- if (!build_extraction_path(path, dentry, ctx))
+ if (inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
+ FILE_ATTRIBUTE_DIRECTORY))
+ {
+ ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
+ "extracted to standard output", dentry_full_path(dentry));
+ return WIMLIB_ERR_NOT_A_REGULAR_FILE;
+ }
+
+ lte = inode_unnamed_lte(inode, lookup_table);
+ if (!lte) {
+ const u8 *hash = inode_unnamed_stream_hash(inode);
+ if (!is_zero_hash(hash))
+ return stream_not_found_error(inode, hash);
return 0;
+ }
- ret = extract_security(path, ctx, dentry);
- if (ret)
- return ret;
+ filedes_init(&_stdout, STDOUT_FILENO);
+ return extract_full_stream_to_fd(lte, &_stdout);
+}
- if (ctx->ops->requires_final_set_attributes_pass) {
- /* Set file attributes (if supported). */
- ret = extract_file_attributes(path, ctx, dentry, 1);
+static int
+extract_dentries_to_stdout(struct wim_dentry **dentries, size_t num_dentries,
+ const struct wim_lookup_table *lookup_table)
+{
+ for (size_t i = 0; i < num_dentries; i++) {
+ int ret = extract_dentry_to_stdout(dentries[i], lookup_table);
if (ret)
return ret;
}
+ return 0;
+}
- return extract_timestamps(path, ctx, dentry);
+/**********************************************************************/
+
+/*
+ * Removes duplicate dentries from the array.
+ *
+ * Returns the new number of dentries, packed at the front of the array.
+ */
+static size_t
+remove_duplicate_trees(struct wim_dentry **trees, size_t num_trees)
+{
+ size_t i, j = 0;
+ for (i = 0; i < num_trees; i++) {
+ if (!trees[i]->tmp_flag) {
+ /* Found distinct dentry. */
+ trees[i]->tmp_flag = 1;
+ trees[j++] = trees[i];
+ }
+ }
+ for (i = 0; i < j; i++)
+ trees[i]->tmp_flag = 0;
+ return j;
}
/*
- * Extract a WIM dentry to standard output.
+ * Remove dentries that are descendants of other dentries in the array.
*
- * This obviously doesn't make sense in all cases. We return an error if the
- * dentry does not correspond to a regular file. Otherwise we extract the
- * unnamed data stream only.
+ * Returns the new number of dentries, packed at the front of the array.
*/
+static size_t
+remove_contained_trees(struct wim_dentry **trees, size_t num_trees)
+{
+ size_t i, j = 0;
+ for (i = 0; i < num_trees; i++)
+ trees[i]->tmp_flag = 1;
+ for (i = 0; i < num_trees; i++) {
+ struct wim_dentry *d = trees[i];
+ while (!dentry_is_root(d)) {
+ d = d->parent;
+ if (d->tmp_flag)
+ goto tree_contained;
+ }
+ trees[j++] = trees[i];
+ continue;
+
+ tree_contained:
+ trees[i]->tmp_flag = 0;
+ }
+
+ for (i = 0; i < j; i++)
+ trees[i]->tmp_flag = 0;
+ return j;
+}
+
static int
-extract_dentry_to_stdout(struct wim_dentry *dentry)
+dentry_append_to_list(struct wim_dentry *dentry, void *_dentry_list)
{
- int ret = 0;
- if (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
- FILE_ATTRIBUTE_DIRECTORY))
- {
- ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
- "extracted to standard output", dentry_full_path(dentry));
- ret = WIMLIB_ERR_NOT_A_REGULAR_FILE;
- } else {
- struct wim_lookup_table_entry *lte;
+ struct list_head *dentry_list = _dentry_list;
+ list_add_tail(&dentry->extraction_list, dentry_list);
+ return 0;
+}
+
+static void
+dentry_reset_extraction_list_node(struct wim_dentry *dentry)
+{
+ dentry->extraction_list = (struct list_head){NULL, NULL};
+}
+
+static int
+dentry_delete_from_list(struct wim_dentry *dentry, void *_ignore)
+{
+ list_del(&dentry->extraction_list);
+ dentry_reset_extraction_list_node(dentry);
+ return 0;
+}
- lte = inode_unnamed_lte_resolved(dentry->d_inode);
- if (lte) {
- struct filedes _stdout;
- filedes_init(&_stdout, STDOUT_FILENO);
- ret = extract_full_stream_to_fd(lte, &_stdout);
+/*
+ * Build the preliminary list of dentries to be extracted.
+ *
+ * The list maintains the invariant that if d1 and d2 are in the list and d1 is
+ * an ancestor of d2, then d1 appears before d2 in the list.
+ */
+static void
+build_dentry_list(struct list_head *dentry_list, struct wim_dentry **trees,
+ size_t num_trees, bool add_ancestors)
+{
+ INIT_LIST_HEAD(dentry_list);
+
+ /* Add the trees recursively. */
+ for (size_t i = 0; i < num_trees; i++)
+ for_dentry_in_tree(trees[i], dentry_append_to_list, dentry_list);
+
+ /* If requested, add ancestors of the trees. */
+ if (add_ancestors) {
+ for (size_t i = 0; i < num_trees; i++) {
+ struct wim_dentry *dentry = trees[i];
+ struct wim_dentry *ancestor;
+ struct list_head *place_after;
+
+ if (dentry_is_root(dentry))
+ continue;
+
+ place_after = dentry_list;
+ ancestor = dentry;
+ do {
+ ancestor = ancestor->parent;
+ if (dentry_in_list(ancestor)) {
+ place_after = &ancestor->extraction_list;
+ break;
+ }
+ } while (!dentry_is_root(ancestor));
+
+ ancestor = dentry;
+ do {
+ ancestor = ancestor->parent;
+ if (dentry_in_list(ancestor))
+ break;
+ list_add(&ancestor->extraction_list, place_after);
+ } while (!dentry_is_root(ancestor));
}
}
- return ret;
+}
+
+static const struct apply_operations *
+select_apply_operations(int extract_flags)
+{
+#ifdef WITH_NTFS_3G
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
+ return &ntfs_3g_apply_ops;
+#endif
+#ifdef __WIN32__
+ return &win32_apply_ops;
+#else
+ return &unix_apply_ops;
+#endif
}
#ifdef __WIN32__
return true;
}
-static bool
-dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
-{
- const utf16lechar *file_name = dentry->file_name;
- return file_name != NULL &&
- file_name[0] == cpu_to_le16('.') &&
- (file_name[1] == cpu_to_le16('\0') ||
- (file_name[1] == cpu_to_le16('.') &&
- file_name[2] == cpu_to_le16('\0')));
-}
-
-static int
-dentry_mark_skipped(struct wim_dentry *dentry, void *_ignore)
-{
- dentry->extraction_skipped = 1;
- return 0;
-}
-
-/*
- * dentry_calculate_extraction_path-
- *
- * Calculate the actual filename component at which a WIM dentry will be
- * extracted, handling invalid filenames "properly".
- *
- * dentry->extraction_name usually will be set the same as dentry->file_name (on
- * UNIX, converted into the platform's multibyte encoding). However, if the
- * file name contains characters that are not valid on the current platform or
- * has some other format that is not valid, leave dentry->extraction_name as
- * NULL and set dentry->extraction_skipped to indicate that this dentry should
- * not be extracted, unless the appropriate flag
- * WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES is set in the extract flags, in
- * which case a substitute filename will be created and set instead.
- *
- * Conflicts with case-insensitive names on Windows are handled similarly; see
- * below.
- */
static int
-dentry_calculate_extraction_path(struct wim_dentry *dentry, void *_args)
+dentry_calculate_extraction_name(struct wim_dentry *dentry,
+ struct apply_ctx *ctx)
{
- struct apply_ctx *ctx = _args;
int ret;
- if (dentry == ctx->extract_root || dentry->extraction_skipped)
+ if (dentry == ctx->target_dentry)
return 0;
if (!dentry_is_supported(dentry, &ctx->supported_features))
goto skip_dentry;
- if (dentry_is_dot_or_dotdot(dentry)) {
- /* WIM files shouldn't contain . or .. entries. But if they are
- * there, don't attempt to extract them. */
- WARNING("Skipping extraction of unexpected . or .. file "
- "\"%"TS"\"", dentry_full_path(dentry));
- goto skip_dentry;
- }
-
if (!ctx->ops->supports_case_sensitive_filenames)
{
struct wim_dentry *other;
- list_for_each_entry(other, &dentry->case_insensitive_conflict_list,
- case_insensitive_conflict_list)
+ list_for_each_entry(other, &dentry->d_ci_conflict_list,
+ d_ci_conflict_list)
{
- if (!other->extraction_skipped) {
+ if (dentry_in_list(other)) {
if (ctx->extract_flags &
WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS) {
WARNING("\"%"TS"\" has the same "
}
if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
-#if TCHAR_IS_UTF16LE
- dentry->extraction_name = dentry->file_name;
- dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
- return 0;
-#else
- return utf16le_to_tstr(dentry->file_name,
+ ret = utf16le_get_tstr(dentry->file_name,
dentry->file_name_nbytes,
- &dentry->extraction_name,
+ (const tchar **)&dentry->extraction_name,
&dentry->extraction_name_nchars);
-#endif
+ dentry->extraction_name_nchars /= sizeof(tchar);
+ return ret;
} else {
if (ctx->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
{
memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
- tchar *tchar_name;
+ const tchar *tchar_name;
size_t tchar_nchars;
- #if TCHAR_IS_UTF16LE
- tchar_name = utf16_name_copy;
- tchar_nchars = dentry->file_name_nbytes / 2;
- #else
- ret = utf16le_to_tstr(utf16_name_copy,
- dentry->file_name_nbytes,
- &tchar_name, &tchar_nchars);
+
+ ret = utf16le_get_tstr(utf16_name_copy,
+ dentry->file_name_nbytes,
+ &tchar_name, &tchar_nchars);
if (ret)
return ret;
- #endif
+
+ tchar_nchars /= sizeof(tchar);
+
size_t fixed_name_num_chars = tchar_nchars;
tchar fixed_name[tchar_nchars + 50];
fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
T(" (invalid filename #%lu)"),
++ctx->invalid_sequence);
- #if !TCHAR_IS_UTF16LE
- FREE(tchar_name);
- #endif
+
+ utf16le_put_tstr(tchar_name);
+
dentry->extraction_name = memdup(fixed_name,
2 * fixed_name_num_chars + 2);
if (!dentry->extraction_name)
return 0;
skip_dentry:
- for_dentry_in_tree(dentry, dentry_mark_skipped, NULL);
+ for_dentry_in_tree(dentry, dentry_delete_from_list, NULL);
return 0;
}
-/* Clean up dentry and inode structure after extraction. */
+/*
+ * Calculate the actual filename component at which each WIM dentry will be
+ * extracted, with special handling for dentries that are unsupported by the
+ * extraction backend or have invalid names.
+ *
+ * Note: this has a dependency on start_extract() being called because
+ * ctx.supported_features must be filled in in order to determine whether each
+ * dentry is supported.
+ *
+ * Possible error codes: WIMLIB_ERR_NOMEM, WIMLIB_ERR_INVALID_UTF16_STRING
+ */
static int
-dentry_reset_needs_extraction(struct wim_dentry *dentry, void *_ignore)
+dentry_list_calculate_extraction_names(struct list_head *dentry_list,
+ struct apply_ctx *ctx)
{
- struct wim_inode *inode = dentry->d_inode;
+ struct list_head *prev, *cur;
+
+ /* Can't use list_for_each_entry() because a call to
+ * dentry_calculate_extraction_name() may delete the current dentry and
+ * its children from the list. */
- dentry->in_extraction_tree = 0;
- dentry->extraction_skipped = 0;
- dentry->was_hardlinked = 0;
- dentry->skeleton_extracted = 0;
- inode->i_visited = 0;
- FREE(inode->i_extracted_file);
- inode->i_extracted_file = NULL;
- inode->i_dos_name_extracted = 0;
- if ((void*)dentry->extraction_name != (void*)dentry->file_name)
- FREE(dentry->extraction_name);
- dentry->extraction_name = NULL;
+ prev = dentry_list;
+ for (;;) {
+ struct wim_dentry *dentry;
+ int ret;
+
+ cur = prev->next;
+ if (cur == dentry_list)
+ break;
+
+ dentry = list_entry(cur, struct wim_dentry, extraction_list);
+
+ ret = dentry_calculate_extraction_name(dentry, ctx);
+ if (ret)
+ return ret;
+
+ if (prev->next == cur)
+ prev = cur;
+ else
+ ; /* Current dentry and its children (which follow in
+ the list) were deleted. prev stays the same. */
+ }
return 0;
}
-/* Tally features necessary to extract a dentry and the corresponding inode. */
static int
-dentry_tally_features(struct wim_dentry *dentry, void *_features)
+dentry_resolve_streams(struct wim_dentry *dentry, int extract_flags,
+ struct wim_lookup_table *lookup_table)
{
- struct wim_features *features = _features;
struct wim_inode *inode = dentry->d_inode;
+ struct wim_lookup_table_entry *lte;
+ int ret;
+ bool force = false;
+
+ /* Special case: when extracting from a pipe, the WIM lookup table is
+ * initially empty, so "resolving" an inode's streams is initially not
+ * possible. However, we still need to keep track of which streams,
+ * identified by SHA1 message digests, need to be extracted, so we
+ * "resolve" the inode's streams anyway by allocating new entries. */
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE)
+ force = true;
+ ret = inode_resolve_streams(inode, lookup_table, force);
+ if (ret)
+ return ret;
+ for (u32 i = 0; i <= inode->i_num_ads; i++) {
+ lte = inode_stream_lte_resolved(inode, i);
+ if (lte)
+ lte->out_refcnt = 0;
+ }
+ return 0;
+}
+
+/*
+ * For each dentry to be extracted, resolve all streams in the corresponding
+ * inode and set 'out_refcnt' in each to 0.
+ *
+ * Possible error codes: WIMLIB_ERR_RESOURCE_NOT_FOUND, WIMLIB_ERR_NOMEM.
+ */
+static int
+dentry_list_resolve_streams(struct list_head *dentry_list,
+ struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
- if (dentry->extraction_skipped)
+ list_for_each_entry(dentry, dentry_list, extraction_list) {
+ ret = dentry_resolve_streams(dentry,
+ ctx->extract_flags,
+ ctx->wim->lookup_table);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+static int
+ref_stream(struct wim_lookup_table_entry *lte,
+ struct wim_dentry *dentry, struct apply_ctx *ctx)
+{
+ if (!lte)
return 0;
+ /* Tally the size only for each extraction of the stream (not hard
+ * links). */
+ if (!(dentry->d_inode->i_visited &&
+ ctx->supported_features.hard_links) &&
+ (!is_linked_extraction(ctx) || (lte->out_refcnt == 0 &&
+ lte->extracted_file == NULL)))
+ {
+ ctx->progress.extract.total_bytes += lte->size;
+ ctx->progress.extract.num_streams++;
+ }
+
+ /* Add stream to the dentry_list only one time, even if it's going
+ * to be extracted to multiple locations. */
+ if (lte->out_refcnt == 0) {
+ list_add_tail(<e->extraction_list, &ctx->stream_list);
+ ctx->num_streams_remaining++;
+ }
+
+ if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
+ struct wim_dentry **lte_dentries;
+
+ /* Append dentry to this stream's array of dentries referencing
+ * it. Use inline array to avoid memory allocation until the
+ * number of dentries becomes too large. */
+ if (lte->out_refcnt < ARRAY_LEN(lte->inline_lte_dentries)) {
+ lte_dentries = lte->inline_lte_dentries;
+ } else {
+ struct wim_dentry **prev_lte_dentries;
+ size_t alloc_lte_dentries;
+
+ if (lte->out_refcnt == ARRAY_LEN(lte->inline_lte_dentries)) {
+ prev_lte_dentries = NULL;
+ alloc_lte_dentries = ARRAY_LEN(lte->inline_lte_dentries);
+ } else {
+ prev_lte_dentries = lte->lte_dentries;
+ alloc_lte_dentries = lte->alloc_lte_dentries;
+ }
+
+ if (lte->out_refcnt == alloc_lte_dentries) {
+ alloc_lte_dentries *= 2;
+ lte_dentries = REALLOC(prev_lte_dentries,
+ alloc_lte_dentries *
+ sizeof(lte_dentries[0]));
+ if (lte_dentries == NULL)
+ return WIMLIB_ERR_NOMEM;
+ if (prev_lte_dentries == NULL) {
+ memcpy(lte_dentries,
+ lte->inline_lte_dentries,
+ sizeof(lte->inline_lte_dentries));
+ }
+ lte->lte_dentries = lte_dentries;
+ lte->alloc_lte_dentries = alloc_lte_dentries;
+ }
+ lte_dentries = lte->lte_dentries;
+ }
+ lte_dentries[lte->out_refcnt] = dentry;
+ }
+ lte->out_refcnt++;
+ return 0;
+}
+
+static int
+dentry_ref_streams(struct wim_dentry *dentry, struct apply_ctx *ctx)
+{
+ struct wim_inode *inode = dentry->d_inode;
+ int ret;
+
+ /* The unnamed data stream will always be extracted, except in an
+ * unlikely case. */
+ if (!inode_is_encrypted_directory(inode)) {
+ ret = ref_stream(inode_unnamed_lte_resolved(inode),
+ dentry, ctx);
+ if (ret)
+ return ret;
+ }
+
+ /* Named data streams will be extracted only if supported in the current
+ * extraction mode and volume, and to avoid complications, if not doing
+ * a linked extraction. */
+ if (can_extract_named_data_streams(ctx)) {
+ for (u16 i = 0; i < inode->i_num_ads; i++) {
+ if (!ads_entry_is_named_stream(&inode->i_ads_entries[i]))
+ continue;
+ ret = ref_stream(inode->i_ads_entries[i].lte,
+ dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ }
+ inode->i_visited = 1;
+ return 0;
+}
+
+/*
+ * For each dentry to be extracted, iterate through the data streams of the
+ * corresponding inode. For each such stream that is not to be ignored due to
+ * the supported features or extraction flags, add it to the list of streams to
+ * be extracted (ctx->stream_list) if not already done so.
+ *
+ * Also, if doing a sequential extraction, build a mapping from each stream to
+ * the dentries referencing it.
+ *
+ * This also initializes the extract progress info with byte and stream
+ * information.
+ *
+ * Note: This has a dependency on start_extract being called because
+ * ctx.supported_features must be filled in in order to determine whether named
+ * data streams are supported.
+ *
+ * Note: this uses the i_visited member of the inodes (assumed to be 0
+ * initially), but does not reset it.
+ *
+ * Possible error codes: WIMLIB_ERR_NOMEM.
+ */
+static int
+dentry_list_ref_streams(struct list_head *dentry_list, struct apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, extraction_list) {
+ ret = dentry_ref_streams(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+/* Tally features necessary to extract a dentry and the corresponding inode. */
+static void
+dentry_tally_features(struct wim_dentry *dentry, struct wim_features *features)
+{
+ struct wim_inode *inode = dentry->d_inode;
+
if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
features->archive_files++;
if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
if (inode_has_unix_data(inode))
features->unix_data++;
inode->i_visited = 1;
- return 0;
}
-/* Tally the features necessary to extract a dentry tree. */
+/* Tally the features necessary to extract the specified dentries. */
static void
-dentry_tree_get_features(struct wim_dentry *root, struct wim_features *features)
+dentry_list_get_features(struct list_head *dentry_list,
+ struct wim_features *features)
{
+ struct wim_dentry *dentry;
+
memset(features, 0, sizeof(struct wim_features));
- for_dentry_in_tree(root, dentry_tally_features, features);
- dentry_tree_clear_inode_visited(root);
+
+ list_for_each_entry(dentry, dentry_list, extraction_list)
+ dentry_tally_features(dentry, features);
+
+ list_for_each_entry(dentry, dentry_list, extraction_list)
+ dentry->d_inode->i_visited = 0;
}
static u32
compute_supported_attributes_mask(const struct wim_features *supported_features)
{
- u32 mask = ~(u32)0;
+ u32 mask = (u32)~0UL;
if (!supported_features->archive_files)
mask &= ~FILE_ATTRIBUTE_ARCHIVE;
static int
do_feature_check(const struct wim_features *required_features,
const struct wim_features *supported_features,
- int extract_flags,
- const struct apply_operations *ops,
- const tchar *wim_source_path,
- bool warn)
+ int extract_flags, const struct apply_operations *ops)
{
- const tchar *loc;
- const tchar *mode = T("this extraction mode");
-
- if (wim_source_path[0] == '\0')
- loc = T("the WIM image");
- else
- loc = wim_source_path;
-
- if (warn) {
- /* We're an archive program, so theoretically we can do what we want
- * with FILE_ATTRIBUTE_ARCHIVE (which is a dumb flag anyway). Don't
- * bother the user about it. */
-#if 0
- if (required_features->archive_files && !supported_features->archive_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as archived, but this attribute\n"
- " is not supported in %"TS".",
- required_features->archive_files, loc, mode);
- }
-#endif
-
- if (required_features->hidden_files && !supported_features->hidden_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as hidden, but this\n"
- " attribute is not supported in %"TS".",
- required_features->hidden_files, loc, mode);
- }
-
- if (required_features->system_files && !supported_features->system_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as system files,\n"
- " but this attribute is not supported in %"TS".",
- required_features->system_files, loc, mode);
- }
-
- if (required_features->compressed_files && !supported_features->compressed_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as being transparently\n"
- " compressed, but transparent compression is not supported in\n"
- " %"TS". These files will be extracted as uncompressed.",
- required_features->compressed_files, loc, mode);
- }
-
- if (required_features->encrypted_files && !supported_features->encrypted_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as being encrypted,\n"
- " but encryption is not supported in %"TS". These files\n"
- " will not be extracted.",
- required_features->encrypted_files, loc, mode);
- }
-
- if (required_features->encrypted_directories &&
- !supported_features->encrypted_directories)
- {
- WARNING(
- "%lu directories in %"TS" are marked as being encrypted,\n"
- " but encryption is not supported in %"TS".\n"
- " These directories will be extracted as unencrypted.",
- required_features->encrypted_directories, loc, mode);
- }
+ /* File attributes. */
+ if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
+ /* Note: Don't bother the user about FILE_ATTRIBUTE_ARCHIVE.
+ * We're an archive program, so theoretically we can do what we
+ * want with it. */
+
+ if (required_features->hidden_files &&
+ !supported_features->hidden_files)
+ WARNING("Ignoring FILE_ATTRIBUTE_HIDDEN of %lu files",
+ required_features->hidden_files);
+
+ if (required_features->system_files &&
+ !supported_features->system_files)
+ WARNING("Ignoring FILE_ATTRIBUTE_SYSTEM of %lu files",
+ required_features->system_files);
+
+ if (required_features->compressed_files &&
+ !supported_features->compressed_files)
+ WARNING("Ignoring FILE_ATTRIBUTE_COMPRESSED of %lu files",
+ required_features->compressed_files);
if (required_features->not_context_indexed_files &&
!supported_features->not_context_indexed_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as not content indexed,\n"
- " but this attribute is not supported in %"TS".",
- required_features->not_context_indexed_files, loc, mode);
- }
-
- if (required_features->sparse_files && !supported_features->sparse_files)
- {
- WARNING(
- "%lu files in %"TS" are marked as sparse, but creating\n"
- " sparse files is not supported in %"TS". These files\n"
- " will be extracted as non-sparse.",
- required_features->sparse_files, loc, mode);
- }
+ WARNING("Ignoring FILE_ATTRIBUTE_NOT_CONTENT_INDEXED of %lu files",
+ required_features->not_context_indexed_files);
- if (required_features->named_data_streams &&
- !supported_features->named_data_streams)
- {
- WARNING(
- "%lu files in %"TS" contain one or more alternate (named)\n"
- " data streams, which are not supported in %"TS".\n"
- " Alternate data streams will NOT be extracted.",
- required_features->named_data_streams, loc, mode);
- }
+ if (required_features->sparse_files &&
+ !supported_features->sparse_files)
+ WARNING("Ignoring FILE_ATTRIBUTE_SPARSE_FILE of %lu files",
+ required_features->sparse_files);
- if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_HARDLINK |
- WIMLIB_EXTRACT_FLAG_SYMLINK)) &&
- required_features->named_data_streams &&
- supported_features->named_data_streams)
- {
- WARNING(
- "%lu files in %"TS" contain one or more alternate (named)\n"
- " data streams, which are not supported in linked extraction mode.\n"
- " Alternate data streams will NOT be extracted.",
- required_features->named_data_streams, loc);
- }
-
- if (required_features->hard_links && !supported_features->hard_links)
- {
- WARNING(
- "%lu files in %"TS" are hard links, but hard links are\n"
- " not supported in %"TS". Hard links will be extracted as\n"
- " duplicate copies of the linked files.",
- required_features->hard_links, loc, mode);
- }
-
- if (required_features->reparse_points && !supported_features->reparse_points)
- {
- if (supported_features->symlink_reparse_points) {
- if (required_features->other_reparse_points) {
- WARNING(
- "%lu files in %"TS" are reparse points that are neither\n"
- " symbolic links nor junction points and are not supported in\n"
- " %"TS". These reparse points will not be extracted.",
- required_features->other_reparse_points, loc,
- mode);
- }
- } else {
- WARNING(
- "%lu files in %"TS" are reparse points, which are\n"
- " not supported in %"TS" and will not be extracted.",
- required_features->reparse_points, loc, mode);
- }
- }
+ if (required_features->encrypted_directories &&
+ !supported_features->encrypted_directories)
+ WARNING("Ignoring FILE_ATTRIBUTE_ENCRYPTED of %lu directories",
+ required_features->encrypted_directories);
+ }
- if (required_features->security_descriptors &&
- !supported_features->security_descriptors)
- {
- WARNING(
- "%lu files in %"TS" have Windows NT security descriptors,\n"
- " but extracting security descriptors is not supported in\n"
- " %"TS". No security descriptors will be extracted.",
- required_features->security_descriptors, loc, mode);
- }
+ /* Encrypted files. */
+ if (required_features->encrypted_files &&
+ !supported_features->encrypted_files)
+ WARNING("Ignoring %lu encrypted files",
+ required_features->encrypted_files);
- if (required_features->short_names && !supported_features->short_names)
- {
- WARNING(
- "%lu files in %"TS" have short (DOS) names, but\n"
- " extracting short names is not supported in %"TS".\n"
- " Short names will not be extracted.\n",
- required_features->short_names, loc, mode);
- }
+ /* Named data streams. */
+ if (required_features->named_data_streams &&
+ (!supported_features->named_data_streams ||
+ (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
+ WIMLIB_EXTRACT_FLAG_HARDLINK))))
+ WARNING("Ignoring named data streams of %lu files",
+ required_features->named_data_streams);
+
+ /* Hard links. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
+ !supported_features->hard_links)
+ {
+ ERROR("Extraction backend does not support hard links!");
+ return WIMLIB_ERR_UNSUPPORTED;
}
+ if (required_features->hard_links && !supported_features->hard_links)
+ WARNING("Extracting %lu hard links as independent files",
+ required_features->hard_links);
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
- required_features->unix_data && !supported_features->unix_data)
+ /* Symbolic links and reparse points. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
+ !supported_features->symlink_reparse_points)
{
- ERROR("Extracting UNIX data is not supported in %"TS, mode);
+ ERROR("Extraction backend does not support symbolic links!");
return WIMLIB_ERR_UNSUPPORTED;
}
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) &&
- required_features->short_names && !supported_features->short_names)
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
+ required_features->symlink_reparse_points &&
+ !supported_features->symlink_reparse_points &&
+ !supported_features->reparse_points)
{
- ERROR("Extracting short names is not supported in %"TS"", mode);
+ ERROR("Extraction backend does not support symbolic links!");
return WIMLIB_ERR_UNSUPPORTED;
}
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
- !ops->set_timestamps)
+ if (required_features->reparse_points &&
+ !supported_features->reparse_points)
{
- ERROR("Extracting timestamps is not supported in %"TS"", mode);
- return WIMLIB_ERR_UNSUPPORTED;
+ if (supported_features->symlink_reparse_points) {
+ if (required_features->other_reparse_points) {
+ WARNING("Ignoring %lu non-symlink/junction "
+ "reparse point files",
+ required_features->other_reparse_points);
+ }
+ } else {
+ WARNING("Ignoring %lu reparse point files",
+ required_features->reparse_points);
+ }
}
+
+ /* Security descriptors. */
if (((extract_flags & (WIMLIB_EXTRACT_FLAG_STRICT_ACLS |
WIMLIB_EXTRACT_FLAG_UNIX_DATA))
== WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
required_features->security_descriptors &&
!supported_features->security_descriptors)
{
- ERROR("Extracting security descriptors is not supported in %"TS, mode);
+ ERROR("Extraction backend does not support security descriptors!");
return WIMLIB_ERR_UNSUPPORTED;
}
+ if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) &&
+ required_features->security_descriptors &&
+ !supported_features->security_descriptors)
+ WARNING("Ignoring Windows NT security descriptors of %lu files",
+ required_features->security_descriptors);
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) &&
- !supported_features->hard_links)
+ /* UNIX data. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
+ required_features->unix_data && !supported_features->unix_data)
{
- ERROR("Hard link extraction mode requested, but "
- "%"TS" does not support hard links!", mode);
+ ERROR("Extraction backend does not support UNIX data!");
return WIMLIB_ERR_UNSUPPORTED;
}
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
- required_features->symlink_reparse_points &&
- !(supported_features->symlink_reparse_points ||
- supported_features->reparse_points))
+ /* DOS Names. */
+ if (required_features->short_names &&
+ !supported_features->short_names)
{
- ERROR("Extracting symbolic links is not supported in %"TS, mode);
- return WIMLIB_ERR_UNSUPPORTED;
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES) {
+ ERROR("Extraction backend does not support DOS names!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+ WARNING("Ignoring DOS names of %lu files",
+ required_features->short_names);
}
- if ((extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK) &&
- !supported_features->symlink_reparse_points)
+ /* Timestamps. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
+ !ops->set_timestamps)
{
- ERROR("Symbolic link extraction mode requested, but "
- "%"TS" does not support symbolic "
- "links!", mode);
+ ERROR("Extraction backend does not support timestamps!");
return WIMLIB_ERR_UNSUPPORTED;
}
+
return 0;
}
#endif
}
-static int
-dentry_set_skipped(struct wim_dentry *dentry, void *_ignore)
+static void
+destroy_dentry_list(struct list_head *dentry_list)
{
- dentry->in_extraction_tree = 1;
- dentry->extraction_skipped = 1;
- return 0;
+ struct wim_dentry *dentry, *tmp;
+ struct wim_inode *inode;
+
+ list_for_each_entry_safe(dentry, tmp, dentry_list, extraction_list) {
+ inode = dentry->d_inode;
+ dentry_reset_extraction_list_node(dentry);
+ dentry->was_linked = 0;
+ dentry->skeleton_extracted = 0;
+ inode->i_visited = 0;
+ FREE(inode->i_extracted_file);
+ inode->i_extracted_file = NULL;
+ inode->i_dos_name_extracted = 0;
+ if ((void*)dentry->extraction_name != (void*)dentry->file_name)
+ FREE(dentry->extraction_name);
+ dentry->extraction_name = NULL;
+ }
}
-static int
-dentry_set_not_skipped(struct wim_dentry *dentry, void *_ignore)
+static void
+destroy_stream_list(struct list_head *stream_list)
{
- dentry->in_extraction_tree = 1;
- dentry->extraction_skipped = 0;
- return 0;
+ struct wim_lookup_table_entry *lte;
+
+ list_for_each_entry(lte, stream_list, extraction_list)
+ if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
+ FREE(lte->lte_dentries);
}
static int
extract_trees(WIMStruct *wim, struct wim_dentry **trees, size_t num_trees,
- const tchar *wim_source_path, const tchar *target,
- int extract_flags, wimlib_progress_func_t progress_func)
+ const tchar *target, int extract_flags,
+ wimlib_progress_func_t progress_func)
{
- struct wim_features required_features;
- struct apply_ctx ctx;
int ret;
- struct wim_lookup_table_entry *lte;
-
- wimlib_assert(num_trees != 0);
- wimlib_assert(target != NULL);
+ struct apply_ctx ctx;
+ struct list_head dentry_list;
+ struct wim_features required_features;
- if (num_trees > 1)
- wimlib_assert((extract_flags & WIMLIB_EXTRACT_FLAG_PATHMODE));
+ /* Handle stdout extraction as a separate case. */
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
+ return extract_dentries_to_stdout(trees, num_trees,
+ wim->lookup_table);
/* Start initializing the apply_ctx. */
memset(&ctx, 0, sizeof(struct apply_ctx));
WIMLIB_EXTRACT_MASK_PUBLIC);
ctx.progress.extract.image_name = wimlib_get_image_name(wim,
wim->current_image);
- ctx.progress.extract.extract_root_wim_source_path = wim_source_path;
ctx.progress.extract.target = target;
}
- INIT_LIST_HEAD(&ctx.stream_list);
- if (extract_flags & WIMLIB_EXTRACT_FLAG_PATHMODE) {
- /* Path mode --- there may be multiple trees, and targets are
- * set relative to the root of the image.
- *
- * Consider all dentries to be in the extraction tree, but
- * assume all to be skipped unless in one of the subtrees being
- * extracted or one of the ancestors of the subtrees up to the
- * image root. */
- ctx.extract_root = wim_root_dentry(wim);
- for_dentry_in_tree(ctx.extract_root, dentry_set_skipped, NULL);
+ ctx.target_dentry = wim_root_dentry(wim);
+ /* Note: ctx.target_dentry represents the dentry that gets extracted to
+ * @target. There may be none, in which case it gets set to the image
+ * root and never matches any of the dentries actually being extracted.
+ */
- for (size_t i = 0; i < num_trees; i++) {
- struct wim_dentry *d;
+ num_trees = remove_duplicate_trees(trees, num_trees);
- for_dentry_in_tree(trees[i], dentry_set_not_skipped, NULL);
- d = trees[i];
- while (d != ctx.extract_root) {
- d = d->parent;
- dentry_set_not_skipped(d, NULL);
- }
- }
- } else {
- ctx.extract_root = trees[0];
- for_dentry_in_tree(ctx.extract_root, dentry_set_not_skipped, NULL);
- }
+ /* All trees are now distinct. */
- /* Select the appropriate apply_operations based on the
- * platform and extract_flags. */
-#ifdef __WIN32__
- ctx.ops = &win32_apply_ops;
-#else
- ctx.ops = &unix_apply_ops;
-#endif
+ num_trees = remove_contained_trees(trees, num_trees);
-#ifdef WITH_NTFS_3G
- if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
- ctx.ops = &ntfs_3g_apply_ops;
-#endif
+ /* All trees are now distinct and non-overlapping. */
+
+ /* Build list of dentries to be extracted. */
+ build_dentry_list(&dentry_list, trees, num_trees,
+ !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE));
+
+ /* Select the appropriate apply_operations based on the platform and
+ * extract_flags. */
+ ctx.ops = select_apply_operations(extract_flags);
+
+ /* Figure out whether the root dentry is being extracted to the root of
+ * a volume and therefore needs to be treated "specially", for example
+ * not being explicitly created and not having attributes set. */
+ if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
+ ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
/* Call the start_extract() callback. This gives the apply_operations
* implementation a chance to do any setup needed to access the volume.
- * Furthermore, it's expected to set the supported features of this
- * extraction mode (ctx.supported_features), which are determined at
- * runtime as they may vary depending on the actual volume. These
- * features are then compared with the actual features extracting this
- * dentry tree requires. Some mismatches will merely produce warnings
- * and the unsupported data will be ignored; others will produce errors.
- */
+ * Furthermore, start_extract() is expected to set the supported
+ * features of this extraction mode (ctx.supported_features), which are
+ * determined at runtime as they may vary depending on the actual
+ * volume. */
ret = ctx.ops->start_extract(target, &ctx);
if (ret)
- goto out_dentry_reset_needs_extraction;
+ goto out_destroy_dentry_list;
- /* Get and check the features required to extract the dentry tree. */
- dentry_tree_get_features(ctx.extract_root, &required_features);
+ /* Get and check the features required to extract the dentries. */
+ dentry_list_get_features(&dentry_list, &required_features);
ret = do_feature_check(&required_features, &ctx.supported_features,
- extract_flags, ctx.ops,
- wim_source_path,
- !(extract_flags & WIMLIB_EXTRACT_FLAG_PATHMODE));
+ extract_flags, ctx.ops);
if (ret)
goto out_finish_or_abort_extract;
ctx.supported_attributes_mask =
compute_supported_attributes_mask(&ctx.supported_features);
- /* Figure out whether the root dentry is being extracted to the root of
- * a volume and therefore needs to be treated "specially", for example
- * not being explicitly created and not having attributes set. */
- if (ctx.ops->target_is_root && ctx.ops->root_directory_is_special)
- ctx.root_dentry_is_special = ctx.ops->target_is_root(target);
-
- /* Calculate the actual filename component of each extracted dentry. In
- * the process, set the dentry->extraction_skipped flag on dentries that
- * are being skipped because of filename or supported features problems. */
- ret = for_dentry_in_tree(ctx.extract_root,
- dentry_calculate_extraction_path, &ctx);
+ /* Calculate extraction name for each dentry and remove subtrees that
+ * can't be extracted due to naming problems. */
+ ret = dentry_list_calculate_extraction_names(&dentry_list, &ctx);
if (ret)
- goto out_dentry_reset_needs_extraction;
+ goto out_finish_or_abort_extract;
- /* Build the list of the streams that need to be extracted and
- * initialize ctx.progress.extract with stream information. */
- ret = for_dentry_in_tree(ctx.extract_root,
- dentry_resolve_and_zero_lte_refcnt, &ctx);
+ /* Build list of streams to extract. */
+ ret = dentry_list_resolve_streams(&dentry_list, &ctx);
if (ret)
- goto out_dentry_reset_needs_extraction;
-
- ret = for_dentry_in_tree(ctx.extract_root,
- dentry_add_streams_to_extract, &ctx);
+ goto out_finish_or_abort_extract;
+ INIT_LIST_HEAD(&ctx.stream_list);
+ ret = dentry_list_ref_streams(&dentry_list, &ctx);
if (ret)
- goto out_teardown_stream_list;
+ goto out_destroy_stream_list;
if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
/* When extracting from a pipe, the number of bytes of data to
}
}
- /* Handle the special case of extracting a file to standard
- * output. In that case, "root" should be a single file, not a
- * directory tree. (If not, extract_dentry_to_stdout() will
- * return an error.) */
- if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
- ret = extract_dentry_to_stdout(ctx.extract_root);
- goto out_teardown_stream_list;
- }
-
if (ctx.ops->realpath_works_on_nonexisting_files &&
((extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) ||
ctx.ops->requires_realtarget_in_paths))
ctx.realtarget = realpath(target, NULL);
if (!ctx.realtarget) {
ret = WIMLIB_ERR_NOMEM;
- goto out_teardown_stream_list;
+ goto out_destroy_stream_list;
}
ctx.realtarget_nchars = tstrlen(ctx.realtarget);
+ #ifdef __WIN32__
+ /* Strip trailing slashes. If we don't do this, we may create a
+ * path with multiple consecutive backslashes, which for some
+ * reason causes Windows to report that the file cannot be found.
+ */
+ while (ctx.realtarget_nchars >= 2
+ && ctx.realtarget[ctx.realtarget_nchars - 1] == L'\\'
+ && ctx.realtarget[ctx.realtarget_nchars - 2] != L':')
+ {
+ ctx.realtarget[--ctx.realtarget_nchars] = L'\0';
+ }
+ #endif
}
if (progress_func) {
int msg;
- if (*wim_source_path || (extract_flags & WIMLIB_EXTRACT_FLAG_PATHMODE))
- msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN;
- else
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
+ else
+ msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN;
progress_func(msg, &ctx.progress);
}
- if (!ctx.root_dentry_is_special)
- {
+ if (!ctx.root_dentry_is_special) {
tchar path[ctx.ops->path_max];
- if (build_extraction_path(path, ctx.extract_root, &ctx))
- {
- ret = extract_inode(path, &ctx, ctx.extract_root->d_inode);
+ if (build_extraction_path(path, ctx.target_dentry, &ctx)) {
+ ret = extract_inode(path, &ctx, ctx.target_dentry->d_inode);
if (ret)
goto out_free_realtarget;
}
}
if (ctx.ops->requires_short_name_reordering) {
- ret = for_dentry_in_tree(ctx.extract_root, dentry_extract_dir_skeleton,
- &ctx);
+ if (progress_func)
+ progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
+ &ctx.progress);
+ ret = extract_dir_structure(&dentry_list, &ctx);
if (ret)
goto out_free_realtarget;
}
/* Finally, the important part: extract the tree of files. */
if (!(extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)) {
/* Sequential extraction requested, so two passes are needed
- * (one for directory structure, one for streams.) */
- if (progress_func)
+ * (one for file structure, one for streams.) */
+ if (progress_func && !ctx.ops->requires_short_name_reordering)
progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
&ctx.progress);
if (!(extract_flags & WIMLIB_EXTRACT_FLAG_RESUME)) {
- ret = for_dentry_in_tree(ctx.extract_root, dentry_extract_skeleton, &ctx);
+ ret = extract_structure(&dentry_list, &ctx);
if (ret)
goto out_free_realtarget;
}
/* Sequential extraction was not requested, so we can make do
* with one pass where we both create the files and extract
* streams. */
- if (progress_func)
+ if (progress_func && !ctx.ops->requires_short_name_reordering)
progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
&ctx.progress);
- ret = for_dentry_in_tree(ctx.extract_root, dentry_extract, &ctx);
+ ret = extract_dentries(&dentry_list, &ctx);
if (ret)
goto out_free_realtarget;
if (progress_func)
if (progress_func)
progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
&ctx.progress);
- ret = for_dentry_in_tree_depth(ctx.extract_root, dentry_extract_final, &ctx);
+ ret = extract_final_metadata(&dentry_list, &ctx);
if (ret)
goto out_free_realtarget;
if (progress_func) {
- progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END :
- WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
- &ctx.progress);
+ int msg;
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE)
+ msg = WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END;
+ else
+ msg = WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END;
+ progress_func(msg, &ctx.progress);
}
-
do_extract_warnings(&ctx);
-
ret = 0;
out_free_realtarget:
FREE(ctx.realtarget);
-out_teardown_stream_list:
- /* Free memory allocated as part of the mapping from each
- * wim_lookup_table_entry to the dentries that reference it. */
+out_destroy_stream_list:
if (!(ctx.extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER))
- list_for_each_entry(lte, &ctx.stream_list, extraction_list)
- if (lte->out_refcnt > ARRAY_LEN(lte->inline_lte_dentries))
- FREE(lte->lte_dentries);
+ destroy_stream_list(&ctx.stream_list);
out_finish_or_abort_extract:
if (ret) {
if (ctx.ops->abort_extract)
if (ctx.ops->finish_extract)
ret = ctx.ops->finish_extract(&ctx);
}
-out_dentry_reset_needs_extraction:
- for_dentry_in_tree(ctx.extract_root, dentry_reset_needs_extraction, NULL);
+out_destroy_dentry_list:
+ destroy_dentry_list(&dentry_list);
return ret;
}
-/*
- * extract_tree - Extract a file or directory tree from the currently selected
- * WIM image.
- *
- * @wim: WIMStruct for the WIM file, with the desired image selected
- * (as wim->current_image).
- *
- * @wim_source_path:
- * "Canonical" (i.e. no leading or trailing slashes, path
- * separators WIM_PATH_SEPARATOR) path inside the WIM image to
- * extract. An empty string means the full image.
- *
- * @target:
- * Filesystem path to extract the file or directory tree to.
- * (Or, with WIMLIB_EXTRACT_FLAG_NTFS: the name of a NTFS volume.)
- *
- * @extract_flags:
- * WIMLIB_EXTRACT_FLAG_*. Also, the private flag
- * WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being
- * called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as
- * the image.
- *
- * @progress_func:
- * If non-NULL, progress function for the extraction. The messages
- * that may be sent in this function are:
- *
- * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or
- * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
- * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN;
- * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END;
- * WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY;
- * WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS;
- * WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS;
- * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or
- * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
- *
- * Returns 0 on success; a positive WIMLIB_ERR_* code on failure.
- */
static int
-extract_tree(WIMStruct *wim, const tchar *wim_source_path,
- const tchar *target, int extract_flags,
- wimlib_progress_func_t progress_func)
+mkdir_if_needed(const tchar *target)
{
- struct wim_dentry *root;
-
- root = get_dentry(wim, wim_source_path, WIMLIB_CASE_PLATFORM_DEFAULT);
-
- if (root == NULL) {
- ERROR("Path \"%"TS"\" does not exist in WIM image %d",
- wim_source_path, wim->current_image);
- return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
+ struct stat stbuf;
+ if (tstat(target, &stbuf)) {
+ if (errno == ENOENT) {
+ if (tmkdir(target, 0755)) {
+ ERROR_WITH_ERRNO("Failed to create directory "
+ "\"%"TS"\"", target);
+ return WIMLIB_ERR_MKDIR;
+ }
+ } else {
+ ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
+ return WIMLIB_ERR_STAT;
+ }
+ } else if (!S_ISDIR(stbuf.st_mode)) {
+ ERROR("\"%"TS"\" is not a directory", target);
+ return WIMLIB_ERR_NOTDIR;
}
- return extract_trees(wim, &root, 1, wim_source_path,
- target, extract_flags, progress_func);
+ return 0;
}
-/* Validates a single wimlib_extract_command, mostly checking to make sure the
- * extract flags make sense. */
+/* Make sure the extraction flags make sense, and update them if needed. */
static int
-check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
+check_extract_flags(const WIMStruct *wim, int *extract_flags_p)
{
- int extract_flags;
-
- /* Empty destination path? */
- if (cmd->fs_dest_path[0] == T('\0'))
- return WIMLIB_ERR_INVALID_PARAM;
-
- extract_flags = cmd->extract_flags;
+ int extract_flags = *extract_flags_p;
/* Check for invalid flag combinations */
if ((extract_flags &
WIMLIB_EXTRACT_FLAG_HARDLINK))
return WIMLIB_ERR_INVALID_PARAM;
- if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS)
- return WIMLIB_ERR_INVALID_PARAM;
-
if ((extract_flags &
(WIMLIB_EXTRACT_FLAG_NO_ACLS |
WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
WIMLIB_EXTRACT_FLAG_FROM_PIPE)) == WIMLIB_EXTRACT_FLAG_RESUME)
return WIMLIB_ERR_INVALID_PARAM;
- if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
#ifndef WITH_NTFS_3G
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
ERROR("wimlib was compiled without support for NTFS-3g, so\n"
- " we cannot apply a WIM image directly to a NTFS volume.");
+ " it cannot apply a WIM image directly to a NTFS volume.");
return WIMLIB_ERR_UNSUPPORTED;
+ }
#endif
+
+#ifndef __WIN32__
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
+ ERROR("WIMBoot extraction is only supported on Windows!");
+ return WIMLIB_ERR_UNSUPPORTED;
}
+#endif
if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
- WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0)
+ WIMLIB_EXTRACT_FLAG_NORPFIX |
+ WIMLIB_EXTRACT_FLAG_IMAGEMODE)) ==
+ WIMLIB_EXTRACT_FLAG_IMAGEMODE)
{
- /* Do reparse point fixups by default if the WIM header says
- * they are enabled and we are extracting a full image. */
- if (wim_header_flags & WIM_HDR_FLAG_RP_FIX)
+ /* For full-image extraction, do reparse point fixups by default
+ * if the WIM header says they are enabled. */
+ if (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
}
}
}
- cmd->extract_flags = extract_flags;
+ *extract_flags_p = extract_flags;
return 0;
}
+static u32
+get_wildcard_flags(int extract_flags)
+{
+ u32 wildcard_flags = 0;
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_GLOB)
+ wildcard_flags |= WILDCARD_FLAG_ERROR_IF_NO_MATCH;
+ else
+ wildcard_flags |= WILDCARD_FLAG_WARN_IF_NO_MATCH;
+
+ if (default_ignore_case)
+ wildcard_flags |= WILDCARD_FLAG_CASE_INSENSITIVE;
+
+ return wildcard_flags;
+}
+
+struct append_dentry_ctx {
+ struct wim_dentry **dentries;
+ size_t num_dentries;
+ size_t num_alloc_dentries;
+};
-/* Internal function to execute extraction commands for a WIM image. The paths
- * in the extract commands are expected to be already "canonicalized". */
static int
-do_wimlib_extract_files(WIMStruct *wim,
- int image,
- struct wimlib_extract_command *cmds,
- size_t num_cmds,
- wimlib_progress_func_t progress_func)
+append_dentry_cb(struct wim_dentry *dentry, void *_ctx)
+{
+ struct append_dentry_ctx *ctx = _ctx;
+
+ if (ctx->num_dentries == ctx->num_alloc_dentries) {
+ struct wim_dentry **new_dentries;
+ size_t new_length;
+
+ new_length = max(ctx->num_alloc_dentries + 8,
+ ctx->num_alloc_dentries * 3 / 2);
+ new_dentries = REALLOC(ctx->dentries,
+ new_length * sizeof(ctx->dentries[0]));
+ if (new_dentries == NULL)
+ return WIMLIB_ERR_NOMEM;
+ ctx->dentries = new_dentries;
+ ctx->num_alloc_dentries = new_length;
+ }
+ ctx->dentries[ctx->num_dentries++] = dentry;
+ return 0;
+}
+
+static int
+do_wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
+ const tchar * const *paths, size_t num_paths,
+ int extract_flags, wimlib_progress_func_t progress_func)
{
int ret;
- bool found_link_cmd = false;
- bool found_nolink_cmd = false;
+ struct wim_dentry **trees;
+ size_t num_trees;
+
+ if (wim == NULL || target == NULL || target[0] == T('\0') ||
+ (num_paths != 0 && paths == NULL))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ ret = check_extract_flags(wim, &extract_flags);
+ if (ret)
+ return ret;
- /* Select the image from which we are extracting files */
ret = select_wim_image(wim, image);
if (ret)
return ret;
- /* Make sure there are no streams in the WIM that have not been
- * checksummed yet. */
ret = wim_checksum_unhashed_streams(wim);
if (ret)
return ret;
- /* Check for problems with the extraction commands */
- for (size_t i = 0; i < num_cmds; i++) {
- ret = check_extract_command(&cmds[i], wim->hdr.flags);
- if (ret)
- return ret;
- if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
- WIMLIB_EXTRACT_FLAG_HARDLINK)) {
- found_link_cmd = true;
- } else {
- found_nolink_cmd = true;
- }
- if (found_link_cmd && found_nolink_cmd) {
- ERROR("Symlink or hardlink extraction mode must "
- "be set on all extraction commands");
- return WIMLIB_ERR_INVALID_PARAM;
- }
- }
-
- /* Execute the extraction commands */
- for (size_t i = 0; i < num_cmds; i++) {
- ret = extract_tree(wim,
- cmds[i].wim_source_path,
- cmds[i].fs_dest_path,
- cmds[i].extract_flags,
- progress_func);
+ if ((extract_flags & (WIMLIB_EXTRACT_FLAG_NTFS |
+ WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE)) ==
+ (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE))
+ {
+ ret = mkdir_if_needed(target);
if (ret)
return ret;
}
- return 0;
-}
-/* API function documented in wimlib.h */
-WIMLIBAPI int
-wimlib_extract_files(WIMStruct *wim,
- int image,
- const struct wimlib_extract_command *cmds,
- size_t num_cmds,
- int default_extract_flags,
- wimlib_progress_func_t progress_func)
-{
- int ret;
- struct wimlib_extract_command *cmds_copy;
- int all_flags = 0;
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS) {
- default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
+ struct append_dentry_ctx append_dentry_ctx = {
+ .dentries = NULL,
+ .num_dentries = 0,
+ .num_alloc_dentries = 0,
+ };
- if (num_cmds == 0)
- return 0;
+ u32 wildcard_flags = get_wildcard_flags(extract_flags);
- cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
- if (!cmds_copy)
- return WIMLIB_ERR_NOMEM;
+ for (size_t i = 0; i < num_paths; i++) {
+ tchar *path = canonicalize_wim_path(paths[i]);
+ if (path == NULL) {
+ ret = WIMLIB_ERR_NOMEM;
+ trees = append_dentry_ctx.dentries;
+ goto out_free_trees;
+ }
+ ret = expand_wildcard(wim, path,
+ append_dentry_cb,
+ &append_dentry_ctx,
+ wildcard_flags);
+ FREE(path);
+ if (ret) {
+ trees = append_dentry_ctx.dentries;
+ goto out_free_trees;
+ }
+ }
+ trees = append_dentry_ctx.dentries;
+ num_trees = append_dentry_ctx.num_dentries;
+ } else {
+ trees = MALLOC(num_paths * sizeof(trees[0]));
+ if (trees == NULL)
+ return WIMLIB_ERR_NOMEM;
- for (size_t i = 0; i < num_cmds; i++) {
- cmds_copy[i].extract_flags = (default_extract_flags |
- cmds[i].extract_flags)
- & WIMLIB_EXTRACT_MASK_PUBLIC;
- all_flags |= cmds_copy[i].extract_flags;
+ for (size_t i = 0; i < num_paths; i++) {
- cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path);
- if (!cmds_copy[i].wim_source_path) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_cmds_copy;
- }
+ tchar *path = canonicalize_wim_path(paths[i]);
+ if (path == NULL) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_free_trees;
+ }
- cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path);
- if (!cmds_copy[i].fs_dest_path) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_cmds_copy;
+ trees[i] = get_dentry(wim, path,
+ WIMLIB_CASE_PLATFORM_DEFAULT);
+ FREE(path);
+ if (trees[i] == NULL) {
+ ERROR("Path \"%"TS"\" does not exist "
+ "in WIM image %d",
+ paths[i], wim->current_image);
+ ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
+ goto out_free_trees;
+ }
}
-
+ num_trees = num_paths;
}
- ret = do_wimlib_extract_files(wim, image,
- cmds_copy, num_cmds,
- progress_func);
- if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
- WIMLIB_EXTRACT_FLAG_HARDLINK))
- {
- for_lookup_table_entry(wim->lookup_table,
- lte_free_extracted_file, NULL);
- }
-out_free_cmds_copy:
- for (size_t i = 0; i < num_cmds; i++) {
- FREE(cmds_copy[i].wim_source_path);
- FREE(cmds_copy[i].fs_dest_path);
+ if (num_trees == 0) {
+ ret = 0;
+ goto out_free_trees;
}
- FREE(cmds_copy);
+
+ ret = extract_trees(wim, trees, num_trees,
+ target, extract_flags, progress_func);
+out_free_trees:
+ FREE(trees);
return ret;
}
-/*
- * Extracts an image from a WIM file.
- *
- * @wim: WIMStruct for the WIM file.
- *
- * @image: Number of the single image to extract.
- *
- * @target: Directory or NTFS volume to extract the image to.
- *
- * @extract_flags: Bitwise or of WIMLIB_EXTRACT_FLAG_*.
- *
- * @progress_func: If non-NULL, a progress function to be called
- * periodically.
- *
- * Returns 0 on success; nonzero on failure.
- */
static int
extract_single_image(WIMStruct *wim, int image,
const tchar *target, int extract_flags,
wimlib_progress_func_t progress_func)
{
- int ret;
- tchar *target_copy = canonicalize_fs_path(target);
- if (target_copy == NULL)
- return WIMLIB_ERR_NOMEM;
- struct wimlib_extract_command cmd = {
- .wim_source_path = T(""),
- .fs_dest_path = target_copy,
- .extract_flags = extract_flags,
- };
- ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func);
- FREE(target_copy);
- return ret;
+ const tchar *path = WIMLIB_WIM_ROOT_PATH;
+ extract_flags |= WIMLIB_EXTRACT_FLAG_IMAGEMODE;
+ return do_wimlib_extract_paths(wim, image, target, &path, 1,
+ extract_flags, progress_func);
}
static const tchar * const filename_forbidden_chars =
int ret;
int image;
const tchar *image_name;
- struct stat stbuf;
extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
return WIMLIB_ERR_INVALID_PARAM;
}
- if (tstat(target, &stbuf)) {
- if (errno == ENOENT) {
- if (tmkdir(target, 0755)) {
- ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
- return WIMLIB_ERR_MKDIR;
- }
- } else {
- ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
- return WIMLIB_ERR_STAT;
- }
- } else if (!S_ISDIR(stbuf.st_mode)) {
- ERROR("\"%"TS"\" is not a directory", target);
- return WIMLIB_ERR_NOTDIR;
- }
-
+ ret = mkdir_if_needed(target);
+ if (ret)
+ return ret;
tmemcpy(buf, target, output_path_len);
buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
for (image = 1; image <= wim->hdr.image_count; image++) {
return 0;
}
+static void
+clear_lte_extracted_file(WIMStruct *wim, int extract_flags)
+{
+ if (unlikely(extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
+ WIMLIB_EXTRACT_FLAG_HARDLINK)))
+ for_lookup_table_entry(wim->lookup_table,
+ lte_free_extracted_file, NULL);
+}
+
static int
do_wimlib_extract_image(WIMStruct *wim,
int image,
{
int ret;
- if (image == WIMLIB_ALL_IMAGES) {
+ if (extract_flags & (WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE |
+ WIMLIB_EXTRACT_FLAG_TO_STDOUT |
+ WIMLIB_EXTRACT_FLAG_GLOB_PATHS))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ if (image == WIMLIB_ALL_IMAGES)
ret = extract_all_images(wim, target, extract_flags,
progress_func);
- } else {
+ else
ret = extract_single_image(wim, image, target, extract_flags,
progress_func);
- }
- if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
- WIMLIB_EXTRACT_FLAG_HARDLINK))
- {
- for_lookup_table_entry(wim->lookup_table,
- lte_free_extracted_file,
- NULL);
+ clear_lte_extracted_file(wim, extract_flags);
+ return ret;
+}
+
+
+/****************************************************************************
+ * Extraction API *
+ ****************************************************************************/
+
+WIMLIBAPI int
+wimlib_extract_paths(WIMStruct *wim, int image, const tchar *target,
+ const tchar * const *paths, size_t num_paths,
+ int extract_flags, wimlib_progress_func_t progress_func)
+{
+ int ret;
+
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ ret = do_wimlib_extract_paths(wim, image, target, paths, num_paths,
+ extract_flags, progress_func);
+ clear_lte_extracted_file(wim, extract_flags);
+ return ret;
+}
+
+WIMLIBAPI int
+wimlib_extract_pathlist(WIMStruct *wim, int image, const tchar *target,
+ const tchar *path_list_file, int extract_flags,
+ wimlib_progress_func_t progress_func)
+{
+ int ret;
+ tchar **paths;
+ size_t num_paths;
+ void *mem;
+
+ ret = read_path_list_file(path_list_file, &paths, &num_paths, &mem);
+ if (ret) {
+ ERROR("Failed to read path list file \"%"TS"\"",
+ path_list_file);
+ return ret;
}
+
+ ret = wimlib_extract_paths(wim, image, target,
+ (const tchar * const *)paths, num_paths,
+ extract_flags, progress_func);
+ FREE(paths);
+ FREE(mem);
return ret;
}
-/* API function documented in wimlib.h */
WIMLIBAPI int
wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
const tchar *target, int extract_flags,
int image;
unsigned i;
- extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
- if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT)
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_FILE_ORDER)
return WIMLIB_ERR_INVALID_PARAM;
/* Read the WIM header from the pipe and get a WIMStruct to represent
if (wim_info_get_num_images(pwm->wim_info) != pwm->hdr.image_count) {
ERROR("Image count in XML data is not the same as in WIM header.");
- ret = WIMLIB_ERR_XML;
+ ret = WIMLIB_ERR_IMAGE_COUNT;
goto out_wimlib_free;
}
}
ret = WIMLIB_ERR_INVALID_IMAGE;
goto out_wimlib_free;
} else if (image == WIMLIB_ALL_IMAGES) {
- ERROR("Applying all images from a pipe is not supported.");
+ ERROR("Applying all images from a pipe is not supported!");
ret = WIMLIB_ERR_INVALID_IMAGE;
goto out_wimlib_free;
}
}
if (i == image) {
- /* Metadata resource is for the images being extracted.
+ /* Metadata resource is for the image being extracted.
* Parse it and save the metadata in memory. */
ret = read_metadata_resource(pwm, imd);
if (ret)
return ret;
}
-/* API function documented in wimlib.h */
WIMLIBAPI int
-wimlib_extract_image(WIMStruct *wim,
- int image,
- const tchar *target,
- int extract_flags,
- wimlib_progress_func_t progress_func)
+wimlib_extract_image(WIMStruct *wim, int image, const tchar *target,
+ int extract_flags, wimlib_progress_func_t progress_func)
{
- extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
return do_wimlib_extract_image(wim, image, target, extract_flags,
progress_func);
}
-
-/* API function documented in wimlib.h */
-WIMLIBAPI int
-wimlib_extract_pathlist(WIMStruct *wim, int image,
- const tchar *target,
- const tchar *path_list_file,
- int extract_flags,
- wimlib_progress_func_t progress_func)
-{
- int ret;
- tchar **paths;
- size_t num_paths;
- void *mem;
-
- ret = read_path_list_file(path_list_file, &paths, &num_paths, &mem);
- if (ret)
- return ret;
-
- ret = wimlib_extract_paths(wim, image, target,
- (const tchar * const *)paths, num_paths,
- extract_flags, progress_func);
- FREE(paths);
- FREE(mem);
- return ret;
-}
-
-struct append_dentry_ctx {
- struct wim_dentry **dentries;
- size_t num_dentries;
- size_t num_alloc_dentries;
-};
-
-static int
-append_dentry_cb(struct wim_dentry *dentry, void *_ctx)
-{
- struct append_dentry_ctx *ctx = _ctx;
-
- if (ctx->num_dentries == ctx->num_alloc_dentries) {
- struct wim_dentry **new_dentries;
- size_t new_length;
-
- new_length = max(ctx->num_alloc_dentries + 8,
- ctx->num_alloc_dentries * 3 / 2);
- new_dentries = REALLOC(ctx->dentries,
- new_length * sizeof(ctx->dentries[0]));
- if (new_dentries == NULL)
- return WIMLIB_ERR_NOMEM;
- ctx->dentries = new_dentries;
- ctx->num_alloc_dentries = new_length;
- }
- ctx->dentries[ctx->num_dentries++] = dentry;
- return 0;
-}
-
-/* API function documented in wimlib.h */
-WIMLIBAPI int
-wimlib_extract_paths(WIMStruct *wim,
- int image,
- const tchar *target,
- const tchar * const *paths,
- size_t num_paths,
- int extract_flags,
- wimlib_progress_func_t progress_func)
-{
- int ret;
- struct append_dentry_ctx append_dentry_ctx = {
- .dentries = NULL,
- .num_dentries = 0,
- .num_alloc_dentries = 0,
- };
- struct wim_dentry **trees;
- size_t num_trees;
-
- extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
-
- if (target == NULL || (num_paths != 0 && paths == NULL))
- return WIMLIB_ERR_INVALID_PARAM;
-
- ret = select_wim_image(wim, image);
- if (ret)
- return ret;
-
- if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS) {
- u32 wildcard_flags = 0;
-
- if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_GLOB)
- wildcard_flags |= WILDCARD_FLAG_ERROR_IF_NO_MATCH;
- else
- wildcard_flags |= WILDCARD_FLAG_WARN_IF_NO_MATCH;
-
- if (default_ignore_case)
- wildcard_flags |= WILDCARD_FLAG_CASE_INSENSITIVE;
-
- for (size_t i = 0; i < num_paths; i++) {
- ret = expand_wildcard(wim, paths[i],
- append_dentry_cb,
- &append_dentry_ctx,
- wildcard_flags);
- if (ret) {
- trees = append_dentry_ctx.dentries;
- goto out_free_trees;
- }
- }
- trees = append_dentry_ctx.dentries;
- num_trees = append_dentry_ctx.num_dentries;
- } else {
- trees = MALLOC(num_paths * sizeof(trees[0]));
- if (trees == NULL)
- return WIMLIB_ERR_NOMEM;
-
- for (size_t i = 0; i < num_paths; i++) {
- trees[i] = get_dentry(wim, paths[i],
- WIMLIB_CASE_PLATFORM_DEFAULT);
- if (trees[i] == NULL) {
- ERROR("Path \"%"TS"\" does not exist "
- "in WIM image %d",
- paths[i], wim->current_image);
- ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
- goto out_free_trees;
- }
- }
- num_trees = num_paths;
- }
-
- if (num_trees == 0) {
- ret = 0;
- goto out_free_trees;
- }
-
- ret = extract_trees(wim, trees, num_trees,
- T(""), target,
- ((extract_flags &
- ~WIMLIB_EXTRACT_FLAG_GLOB_PATHS)
- | WIMLIB_EXTRACT_FLAG_PATHMODE),
- progress_func);
-out_free_trees:
- FREE(trees);
- return ret;
-}
git://wimlib.net / wimlib / blobdiff