+static int
+ref_stream_if_needed(struct wim_dentry *dentry, struct wim_inode *inode,
+ struct wim_inode_stream *strm, struct apply_ctx *ctx)
+{
+ bool need_stream = false;
+ switch (strm->stream_type) {
+ case STREAM_TYPE_DATA:
+ if (stream_is_named(strm)) {
+ /* Named data stream */
+ if (ctx->supported_features.named_data_streams)
+ need_stream = true;
+ } else if (!(inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+ FILE_ATTRIBUTE_ENCRYPTED))
+ && !(inode_is_symlink(inode)
+ && !ctx->supported_features.reparse_points
+ && ctx->supported_features.symlink_reparse_points))
+ {
+ /*
+ * Unnamed data stream. Skip if any of the following is true:
+ *
+ * - file is a directory
+ * - file is encrypted
+ * - backend needs to create the file as UNIX symlink
+ * - backend will extract the stream as externally
+ * backed from the WIM archive itself
+ */
+ if (ctx->apply_ops->will_back_from_wim) {
+ int ret = (*ctx->apply_ops->will_back_from_wim)(dentry, ctx);
+ if (ret > 0) /* Error? */
+ return ret;
+ if (ret < 0) /* Won't externally back? */
+ need_stream = true;
+ } else {
+ need_stream = true;
+ }
+ }
+ break;
+ case STREAM_TYPE_REPARSE_POINT:
+ wimlib_assert(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
+ if (ctx->supported_features.reparse_points ||
+ (inode_is_symlink(inode) &&
+ ctx->supported_features.symlink_reparse_points))
+ need_stream = true;
+ break;
+ case STREAM_TYPE_EFSRPC_RAW_DATA:
+ wimlib_assert(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
+ if (ctx->supported_features.encrypted_directories)
+ need_stream = true;
+ } else {
+ if (ctx->supported_features.encrypted_files)
+ need_stream = true;
+ }
+ break;
+ }
+ if (need_stream)
+ return ref_stream(strm, dentry, ctx);
+ return 0;
+}
+
+static int
+dentry_ref_streams(struct wim_dentry *dentry, struct apply_ctx *ctx)
+{
+ struct wim_inode *inode = dentry->d_inode;
+ for (unsigned i = 0; i < inode->i_num_streams; i++) {
+ int ret = ref_stream_if_needed(dentry, inode,
+ &inode->i_streams[i], ctx);
+ if (ret)
+ return ret;
+ }
+ inode->i_visited = 1;
+ return 0;
+}
+
+/*
+ * Given a list of dentries to be extracted, build the list of blobs that need
+ * to be extracted, and for each blob determine the streams to which that blob
+ * will be extracted.
+ *
+ * This also initializes the extract progress info with byte and blob
+ * information.
+ *
+ * ctx->supported_features must be filled in.
+ */
+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, d_extraction_list_node) {
+ ret = dentry_ref_streams(dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node)
+ dentry->d_inode->i_visited = 0;
+ return 0;
+}
+
+static void
+dentry_list_build_inode_alias_lists(struct list_head *dentry_list)
+{
+ struct wim_dentry *dentry;
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node)
+ dentry->d_inode->i_first_extraction_alias = NULL;
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
+ dentry->d_next_extraction_alias = dentry->d_inode->i_first_extraction_alias;
+ dentry->d_inode->i_first_extraction_alias = dentry;
+ }
+}
+
+static void
+inode_tally_features(const struct wim_inode *inode,
+ struct wim_features *features)
+{
+ if (inode->i_attributes & FILE_ATTRIBUTE_ARCHIVE)
+ features->archive_files++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_HIDDEN)
+ features->hidden_files++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_SYSTEM)
+ features->system_files++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)
+ features->compressed_files++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED) {
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
+ features->encrypted_directories++;
+ else
+ features->encrypted_files++;
+ }
+ if (inode->i_attributes & FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)
+ features->not_context_indexed_files++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE)
+ features->sparse_files++;
+ if (inode_has_named_data_stream(inode))
+ features->named_data_streams++;
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ features->reparse_points++;
+ if (inode_is_symlink(inode))
+ features->symlink_reparse_points++;
+ else
+ features->other_reparse_points++;
+ }
+ if (inode_has_security_descriptor(inode))
+ features->security_descriptors++;
+ if (inode_has_unix_data(inode))
+ features->unix_data++;
+}
+
+/* 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 (dentry_has_short_name(dentry))
+ features->short_names++;
+
+ if (inode->i_visited) {
+ features->hard_links++;
+ } else {
+ inode_tally_features(inode, features);
+ inode->i_visited = 1;
+ }
+}
+
+/* Tally the features necessary to extract the specified dentries. */
+static void
+dentry_list_get_features(struct list_head *dentry_list,
+ struct wim_features *features)
+{
+ struct wim_dentry *dentry;
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node)
+ dentry_tally_features(dentry, features);
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node)
+ dentry->d_inode->i_visited = 0;
+}
+
+static int
+do_feature_check(const struct wim_features *required_features,
+ const struct wim_features *supported_features,
+ int extract_flags)
+{
+ /* Encrypted files. */
+ if (required_features->encrypted_files &&
+ !supported_features->encrypted_files)
+ WARNING("Ignoring EFS-encrypted data of %lu files",
+ required_features->encrypted_files);
+
+ /* Named data streams. */
+ if (required_features->named_data_streams &&
+ !supported_features->named_data_streams)
+ WARNING("Ignoring named data streams of %lu files",
+ required_features->named_data_streams);
+
+ /* 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("Ignoring FILE_ATTRIBUTE_NOT_CONTENT_INDEXED of %lu files",
+ required_features->not_context_indexed_files);
+
+ if (required_features->sparse_files &&
+ !supported_features->sparse_files)
+ WARNING("Ignoring FILE_ATTRIBUTE_SPARSE_FILE of %lu files",
+ required_features->sparse_files);
+
+ if (required_features->encrypted_directories &&
+ !supported_features->encrypted_directories)
+ WARNING("Ignoring FILE_ATTRIBUTE_ENCRYPTED of %lu directories",
+ required_features->encrypted_directories);
+ }
+
+ /* Hard links. */
+ if (required_features->hard_links && !supported_features->hard_links)
+ WARNING("Extracting %lu hard links as independent files",
+ required_features->hard_links);
+
+ /* Symbolic links and reparse points. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS) &&
+ required_features->symlink_reparse_points &&
+ !supported_features->symlink_reparse_points &&
+ !supported_features->reparse_points)
+ {
+ ERROR("Extraction backend does not support symbolic links!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+ if (required_features->reparse_points &&
+ !supported_features->reparse_points)
+ {
+ if (supported_features->symlink_reparse_points) {
+ if (required_features->other_reparse_points) {
+ WARNING("Ignoring reparse data of %lu non-symlink/junction files",
+ required_features->other_reparse_points);
+ }
+ } else {
+ WARNING("Ignoring reparse data of %lu 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("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);
+
+ /* UNIX data. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) &&
+ required_features->unix_data && !supported_features->unix_data)
+ {
+ ERROR("Extraction backend does not support UNIX data!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+
+ if (required_features->unix_data &&
+ !(extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA))
+ {
+ WARNING("Ignoring UNIX metadata of %lu files",
+ required_features->unix_data);
+ }
+
+ /* DOS Names. */
+ if (required_features->short_names &&
+ !supported_features->short_names)
+ {
+ 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);
+ }
+
+ /* Timestamps. */
+ if ((extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) &&
+ !supported_features->timestamps)
+ {
+ ERROR("Extraction backend does not support timestamps!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+
+ return 0;
+}
+
+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
+}
+
+static int
+extract_trees(WIMStruct *wim, struct wim_dentry **trees, size_t num_trees,
+ const tchar *target, int extract_flags)
+{
+ const struct apply_operations *ops;
+ struct apply_ctx *ctx;
+ int ret;
+ LIST_HEAD(dentry_list);
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
+ ret = extract_dentries_to_stdout(trees, num_trees,
+ wim->blob_table);
+ goto out;
+ }
+
+ num_trees = remove_duplicate_trees(trees, num_trees);
+ num_trees = remove_contained_trees(trees, num_trees);
+
+ ops = select_apply_operations(extract_flags);
+
+ if (num_trees > 1 && ops->single_tree_only) {
+ ERROR("Extracting multiple directory trees "
+ "at once is not supported in %s extraction mode!",
+ ops->name);
+ ret = WIMLIB_ERR_UNSUPPORTED;
+ goto out;
+ }
+
+ ctx = CALLOC(1, ops->context_size);
+ if (!ctx) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out;
+ }
+
+ ctx->wim = wim;
+ ctx->target = target;
+ ctx->target_nchars = tstrlen(target);
+ ctx->extract_flags = extract_flags;
+ if (ctx->wim->progfunc) {
+ ctx->progfunc = ctx->wim->progfunc;
+ ctx->progctx = ctx->wim->progctx;
+ ctx->progress.extract.image = wim->current_image;
+ ctx->progress.extract.extract_flags = (extract_flags &
+ WIMLIB_EXTRACT_MASK_PUBLIC);
+ ctx->progress.extract.wimfile_name = wim->filename;
+ ctx->progress.extract.image_name = wimlib_get_image_name(wim,
+ wim->current_image);
+ ctx->progress.extract.target = target;
+ }
+ INIT_LIST_HEAD(&ctx->blob_list);
+ filedes_invalidate(&ctx->tmpfile_fd);
+ ctx->apply_ops = ops;
+
+ ret = (*ops->get_supported_features)(target, &ctx->supported_features);
+ if (ret)
+ goto out_cleanup;
+
+ build_dentry_list(&dentry_list, trees, num_trees,
+ !(extract_flags &
+ WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE));
+
+ dentry_list_get_features(&dentry_list, &ctx->required_features);
+
+ ret = do_feature_check(&ctx->required_features, &ctx->supported_features,
+ ctx->extract_flags);
+ if (ret)
+ goto out_cleanup;
+
+ ret = dentry_list_calculate_extraction_names(&dentry_list, ctx);
+ if (ret)
+ goto out_cleanup;
+
+ if (unlikely(list_empty(&dentry_list))) {
+ WARNING("There is nothing to extract!");
+ goto out_cleanup;
+ }
+
+ ret = dentry_list_resolve_streams(&dentry_list, ctx);
+ if (ret)
+ goto out_cleanup;
+
+ dentry_list_build_inode_alias_lists(&dentry_list);
+
+ ret = dentry_list_ref_streams(&dentry_list, ctx);
+ if (ret)
+ goto out_cleanup;
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_FROM_PIPE) {
+ /* When extracting from a pipe, the number of bytes of data to
+ * extract can't be determined in the normal way (examining the
+ * blob table), since at this point all we have is a set of
+ * SHA-1 message digests of blobs that need to be extracted.
+ * However, we can get a reasonably accurate estimate by taking
+ * <TOTALBYTES> from the corresponding <IMAGE> in the WIM XML
+ * data. This does assume that a full image is being extracted,
+ * but currently there is no API for doing otherwise. (Also,
+ * subtract <HARDLINKBYTES> from this if hard links are
+ * supported by the extraction mode.) */
+ ctx->progress.extract.total_bytes =
+ wim_info_get_image_total_bytes(wim->wim_info,
+ wim->current_image);
+ if (ctx->supported_features.hard_links) {
+ ctx->progress.extract.total_bytes -=
+ wim_info_get_image_hard_link_bytes(wim->wim_info,
+ wim->current_image);
+ }
+ }
+
+ ret = extract_progress(ctx,
+ ((extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE) ?
+ WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN :
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN));
+ if (ret)
+ goto out_cleanup;
+
+ ret = (*ops->extract)(&dentry_list, ctx);
+ if (ret)
+ goto out_cleanup;
+
+ if (ctx->progress.extract.completed_bytes <
+ ctx->progress.extract.total_bytes)
+ {
+ ctx->progress.extract.completed_bytes =
+ ctx->progress.extract.total_bytes;
+ ret = extract_progress(ctx, WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS);
+ if (ret)
+ goto out_cleanup;
+ }
+
+ ret = extract_progress(ctx,
+ ((extract_flags & WIMLIB_EXTRACT_FLAG_IMAGEMODE) ?
+ WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END :
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END));
+out_cleanup:
+ destroy_blob_list(&ctx->blob_list);
+ destroy_dentry_list(&dentry_list);
+ FREE(ctx);
+out:
+ return ret;
+}
+
+static int
+mkdir_if_needed(const tchar *target)
+{
+ if (!tmkdir(target, 0755))
+ return 0;
+
+ if (errno == EEXIST)
+ return 0;
+
+#ifdef __WIN32__
+ /* _wmkdir() fails with EACCES if called on a drive root directory. */
+ if (errno == EACCES)
+ return 0;
+#endif
+
+ ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
+ return WIMLIB_ERR_MKDIR;
+}
+
+/* Make sure the extraction flags make sense, and update them if needed. */
+static int
+check_extract_flags(const WIMStruct *wim, int *extract_flags_p)
+{
+ int extract_flags = *extract_flags_p;
+
+ /* Check for invalid flag combinations */
+
+ if ((extract_flags &
+ (WIMLIB_EXTRACT_FLAG_NO_ACLS |
+ WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) == (WIMLIB_EXTRACT_FLAG_NO_ACLS |
+ WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ if ((extract_flags &
+ (WIMLIB_EXTRACT_FLAG_RPFIX |
+ WIMLIB_EXTRACT_FLAG_NORPFIX)) == (WIMLIB_EXTRACT_FLAG_RPFIX |
+ WIMLIB_EXTRACT_FLAG_NORPFIX))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+#ifndef WITH_NTFS_3G
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
+ ERROR("wimlib was compiled without support for NTFS-3g, so\n"
+ " it cannot apply a WIM image directly to an NTFS volume.");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+#endif
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
+#ifdef __WIN32__
+ if (!wim->filename)
+ return WIMLIB_ERR_NO_FILENAME;
+#else
+ ERROR("WIMBoot extraction is only supported on Windows!");
+ return WIMLIB_ERR_UNSUPPORTED;
+#endif
+ }
+
+ if (extract_flags & (WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K |
+ WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K |
+ WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K |
+ WIMLIB_EXTRACT_FLAG_COMPACT_LZX))
+ {
+ #ifdef __WIN32__
+ int count = 0;
+ count += ((extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K) != 0);
+ count += ((extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K) != 0);
+ count += ((extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K) != 0);
+ count += ((extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_LZX) != 0);
+ if (count != 1) {
+ ERROR("Only one compression format can be specified "
+ "for compact-mode extraction!");
+ return WIMLIB_ERR_INVALID_PARAM;
+ }
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT) {
+ ERROR("Compact-mode extraction and WIMBoot-mode "
+ "extraction are mutually exclusive!");
+ return WIMLIB_ERR_INVALID_PARAM;
+ }
+ #else
+ ERROR("Compact-mode extraction (System Compression) "
+ "is only supported on Windows!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ #endif
+ }
+
+
+ if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
+ WIMLIB_EXTRACT_FLAG_NORPFIX |
+ WIMLIB_EXTRACT_FLAG_IMAGEMODE)) ==
+ WIMLIB_EXTRACT_FLAG_IMAGEMODE)
+ {
+ /* 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;
+ }
+
+ *extract_flags_p = extract_flags;
+ return 0;
+}
+
+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;
+}
+
+/* Append dentries matched by a path which can contain wildcard characters. */
+static int
+append_matched_dentries(WIMStruct *wim, const tchar *orig_pattern,
+ int extract_flags, struct append_dentry_ctx *ctx)
+{
+ const size_t count_before = ctx->num_dentries;
+ tchar *pattern;
+ int ret;
+
+ pattern = canonicalize_wim_path(orig_pattern);
+ if (!pattern)
+ return WIMLIB_ERR_NOMEM;
+ ret = expand_path_pattern(wim_get_current_root_dentry(wim), pattern,
+ append_dentry_cb, ctx);
+ FREE(pattern);
+ if (ret || ctx->num_dentries > count_before)
+ return ret;
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_GLOB) {
+ ERROR("No matches for path pattern \"%"TS"\"", orig_pattern);
+ return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
+ }
+ WARNING("No matches for path pattern \"%"TS"\"", orig_pattern);
+ 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)
+{
+ int ret;
+ 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;
+
+ ret = select_wim_image(wim, image);
+ if (ret)
+ return ret;
+
+ ret = wim_checksum_unhashed_blobs(wim);
+ if (ret)
+ return ret;
+
+ 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;
+ }
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_GLOB_PATHS) {
+
+ struct append_dentry_ctx append_dentry_ctx = {
+ .dentries = NULL,
+ .num_dentries = 0,
+ .num_alloc_dentries = 0,
+ };
+
+ for (size_t i = 0; i < num_paths; i++) {
+ ret = append_matched_dentries(wim, paths[i],
+ extract_flags,
+ &append_dentry_ctx);
+ 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++) {
+
+ tchar *path = canonicalize_wim_path(paths[i]);
+ if (path == NULL) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_free_trees;
+ }
+
+ 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;
+ }
+
+ if (num_trees == 0) {
+ ret = 0;
+ goto out_free_trees;
+ }
+
+ ret = extract_trees(wim, trees, num_trees, target, extract_flags);
+out_free_trees:
+ FREE(trees);
+ return ret;
+}
+
+static int
+extract_single_image(WIMStruct *wim, int image,
+ const tchar *target, int extract_flags)
+{
+ 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);
+}
+
+static const tchar * const filename_forbidden_chars =
+T(
+#ifdef __WIN32__
+"<>:\"/\\|?*"
+#else
+"/"
+#endif
+);
+
+/* This function checks if it is okay to use a WIM image's name as a directory
+ * name. */
+static bool
+image_name_ok_as_dir(const tchar *image_name)
+{
+ return image_name && *image_name &&
+ !tstrpbrk(image_name, filename_forbidden_chars) &&
+ tstrcmp(image_name, T(".")) &&
+ tstrcmp(image_name, T(".."));
+}
+
+/* Extracts all images from the WIM to the directory @target, with the images
+ * placed in subdirectories named by their image names. */
+static int
+extract_all_images(WIMStruct *wim, const tchar *target, int extract_flags)
+{
+ size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
+ size_t output_path_len = tstrlen(target);
+ tchar buf[output_path_len + 1 + image_name_max_len + 1];
+ int ret;
+ int image;
+ const tchar *image_name;
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
+ ERROR("Cannot extract multiple images in NTFS extraction mode.");
+ return WIMLIB_ERR_INVALID_PARAM;
+ }
+
+ 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++) {
+ image_name = wimlib_get_image_name(wim, image);
+ if (image_name_ok_as_dir(image_name)) {
+ tstrcpy(buf + output_path_len + 1, image_name);
+ } else {
+ /* Image name is empty or contains forbidden characters.
+ * Use image number instead. */
+ tsprintf(buf + output_path_len + 1, T("%d"), image);
+ }
+ ret = extract_single_image(wim, image, buf, extract_flags);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+static int
+do_wimlib_extract_image(WIMStruct *wim, int image, const tchar *target,
+ int extract_flags)
+{
+ 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)
+ return extract_all_images(wim, target, extract_flags);
+ else
+ return extract_single_image(wim, image, target, extract_flags);
+}
+
+
+/****************************************************************************
+ * 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)
+{
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ return do_wimlib_extract_paths(wim, image, target, paths, num_paths,
+ extract_flags);
+}
+
+WIMLIBAPI int
+wimlib_extract_pathlist(WIMStruct *wim, int image, const tchar *target,
+ const tchar *path_list_file, int extract_flags)
+{
+ 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);
+ FREE(paths);
+ FREE(mem);
+ return ret;
+}
+
+WIMLIBAPI int
+wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
+ const tchar *image_num_or_name,
+ const tchar *target,
+ int extract_flags,
+ wimlib_progress_func_t progfunc,
+ void *progctx)
+{
+ int ret;
+ WIMStruct *pwm;
+ struct filedes *in_fd;
+ int image;
+ unsigned i;
+
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ /* Read the WIM header from the pipe and get a WIMStruct to represent
+ * the pipable WIM. Caveats: Unlike getting a WIMStruct with
+ * wimlib_open_wim(), getting a WIMStruct in this way will result in an
+ * empty blob table, no XML data read, and no filename set. */
+ ret = open_wim_as_WIMStruct(&pipe_fd, WIMLIB_OPEN_FLAG_FROM_PIPE, &pwm,
+ progfunc, progctx);
+ if (ret)
+ return ret;
+
+ /* Sanity check to make sure this is a pipable WIM. */
+ if (pwm->hdr.magic != PWM_MAGIC) {
+ ERROR("The WIM being read from file descriptor %d "
+ "is not pipable!", pipe_fd);
+ ret = WIMLIB_ERR_NOT_PIPABLE;
+ goto out_wimlib_free;
+ }
+
+ /* Sanity check to make sure the first part of a pipable split WIM is
+ * sent over the pipe first. */
+ if (pwm->hdr.part_number != 1) {
+ ERROR("The first part of the split WIM must be "
+ "sent over the pipe first.");
+ ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
+ goto out_wimlib_free;
+ }
+
+ in_fd = &pwm->in_fd;
+ wimlib_assert(in_fd->offset == WIM_HEADER_DISK_SIZE);
+
+ /* As mentioned, the WIMStruct we created from the pipe does not have
+ * XML data yet. Fix this by reading the extra copy of the XML data
+ * that directly follows the header in pipable WIMs. (Note: see
+ * write_pipable_wim() for more details about the format of pipable
+ * WIMs.) */
+ {
+ u8 hash[SHA1_HASH_SIZE];
+
+ ret = read_pwm_blob_header(pwm, hash,
+ &pwm->hdr.xml_data_reshdr, NULL);
+ if (ret)
+ goto out_wimlib_free;
+
+ if (!(pwm->hdr.xml_data_reshdr.flags & WIM_RESHDR_FLAG_METADATA)) {
+ ERROR("Expected XML data, but found non-metadata resource.");
+ ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
+ goto out_wimlib_free;
+ }
+
+ ret = read_wim_xml_data(pwm);
+ if (ret)
+ goto out_wimlib_free;
+
+ 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_IMAGE_COUNT;
+ goto out_wimlib_free;
+ }
+ }
+
+ /* Get image index (this may use the XML data that was just read to
+ * resolve an image name). */
+ if (image_num_or_name) {
+ image = wimlib_resolve_image(pwm, image_num_or_name);
+ if (image == WIMLIB_NO_IMAGE) {
+ ERROR("\"%"TS"\" is not a valid image in the pipable WIM!",
+ image_num_or_name);
+ 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!");
+ ret = WIMLIB_ERR_INVALID_IMAGE;
+ goto out_wimlib_free;
+ }
+ } else {
+ if (pwm->hdr.image_count != 1) {
+ ERROR("No image was specified, but the pipable WIM "
+ "did not contain exactly 1 image");
+ ret = WIMLIB_ERR_INVALID_IMAGE;
+ goto out_wimlib_free;
+ }
+ image = 1;
+ }
+
+ /* Load the needed metadata resource. */
+ for (i = 1; i <= pwm->hdr.image_count; i++) {
+ struct wim_image_metadata *imd;
+ struct wim_reshdr reshdr;
+ struct wim_resource_descriptor *metadata_rdesc;
+
+ imd = pwm->image_metadata[i - 1];
+
+ ret = WIMLIB_ERR_NOMEM;
+ imd->metadata_blob = new_blob_descriptor();
+ if (!imd->metadata_blob)
+ goto out_wimlib_free;
+
+ imd->metadata_blob->is_metadata = 1;
+
+ ret = read_pwm_blob_header(pwm, imd->metadata_blob->hash,
+ &reshdr, NULL);
+ if (ret)
+ goto out_wimlib_free;
+
+ if (!(reshdr.flags & WIM_RESHDR_FLAG_METADATA)) {
+ ERROR("Expected metadata resource, but found "
+ "non-metadata resource");
+ ret = WIMLIB_ERR_INVALID_PIPABLE_WIM;
+ goto out_wimlib_free;
+ }
+
+ ret = WIMLIB_ERR_NOMEM;
+ metadata_rdesc = MALLOC(sizeof(struct wim_resource_descriptor));
+ if (!metadata_rdesc)
+ goto out_wimlib_free;
+ wim_reshdr_to_desc_and_blob(&reshdr, pwm, metadata_rdesc,
+ imd->metadata_blob);
+
+ if (i == image) {
+ /* Metadata resource is for the image being extracted.
+ * Parse it and save the metadata in memory. */
+ ret = read_metadata_resource(imd);
+ if (ret)
+ goto out_wimlib_free;
+ imd->modified = 1;
+ } else {
+ /* Metadata resource is not for the image being
+ * extracted. Skip over it. */
+ ret = skip_wim_resource(metadata_rdesc);
+ if (ret)
+ goto out_wimlib_free;
+ }
+ }
+ /* Extract the image. */
+ extract_flags |= WIMLIB_EXTRACT_FLAG_FROM_PIPE;
+ ret = do_wimlib_extract_image(pwm, image, target, extract_flags);
+ /* Clean up and return. */
+out_wimlib_free:
+ wimlib_free(pwm);
+ return ret;
+}
+
+
+WIMLIBAPI int
+wimlib_extract_image_from_pipe(int pipe_fd, const tchar *image_num_or_name,
+ const tchar *target, int extract_flags)
+{
+ return wimlib_extract_image_from_pipe_with_progress(pipe_fd,
+ image_num_or_name,
+ target,
+ extract_flags,
+ NULL,
+ NULL);
+}
+
+WIMLIBAPI int
+wimlib_extract_image(WIMStruct *wim, int image, const tchar *target,
+ int extract_flags)
+{
+ if (extract_flags & ~WIMLIB_EXTRACT_MASK_PUBLIC)
+ return WIMLIB_ERR_INVALID_PARAM;
+ return do_wimlib_extract_image(wim, image, target, extract_flags);