* ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
+ /** A file or directory tree within a WIM image (not the full image) is
+ * about to be extracted. @a info will point to
+ * ::wimlib_progress_info.extract. */
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
+
/** The directory structure of the WIM image is about to be extracted.
* @a info will point to ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
* ::wimlib_progress_info.extract. */
WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
+ /** A file or directory tree within a WIM image (not the full image) has
+ * been successfully extracted. @a info will point to
+ * ::wimlib_progress_info.extract. */
+ WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
+
/** The directory or NTFS volume is about to be scanned to build a tree
* of WIM dentries in-memory. @a info will point to
* ::wimlib_progress_info.scan. */
* special cases (hard links, symbolic links, and alternate data
* streams.) */
uint64_t num_streams;
+
+ /** Path to the root dentry within the WIM for the tree that is
+ * being extracted. Will be the empty string when extracting a
+ * full image. */
+ const wimlib_tchar *extract_root_wim_source_path;
} extract;
/** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
/* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
* fixups on, so absolute symbolic links or junction points will be fixed to be
* absolute relative to the actual extraction root. Done by default if
- * WIM_HDR_FLAG_RP_FIX is set in the WIM header. */
+ * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
+ * specified when extracting a full image. */
#define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
/** Force reparse-point fixups on extraction off, regardless of the state of the
* WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
#define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
+/** Extract files to standard output rather than to the filesystem. */
+#define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
+
/******************************
* WIMLIB_MOUNT_FLAG_* *
******************************/
* locale's character encoding. */
#define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
-
-#if 0
-/****************************************************************
- * Definition of struct wimlib_modify_command, with various flags
- ****************************************************************/
-
-enum {
- WIMLIB_MOVE_TREE_FLAG_OVERWRITE_ALL = 0x1,
- WIMLIB_MOVE_TREE_FLAG_OVERWRITE_NONDIRECTORIES = 0x2,
- WIMLIB_MOVE_TREE_FLAG_OVERWRITE_EMPTY_DIRECTORIES = 0x4,
- WIMLIB_MOVE_TREE_FLAG_OVERWRITE_DIRECTORIES = 0x8,
-};
-
-enum {
- WIMLIB_DELETE_TREE_FLAG_FORCE = 0x1,
- WIMLIB_DELETE_TREE_FLAG_RECURSIVE = 0x2,
- WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR = 0x4,
-};
-
-enum {
- WIMLIB_ADD_TREE_FLAG_DEREFERENCE = 0x1,
- WIMLIB_ADD_TREE_FLAG_VERBOSE = 0x2,
- WIMLIB_ADD_TREE_FLAG_UNIX_DATA = 0x4,
- WIMLIB_ADD_TREE_FLAG_NOACLS = 0x8,
- WIMLIB_ADD_TREE_FLAG_NTFS_VOLUME = 0x01,
- WIMLIB_ADD_TREE_FLAG_OVERLAY = 0x02,
- WIMLIB_ADD_TREE_FLAG_MAKE_NECESSARY_DIRS = 0x04,
-};
-
-enum wimlib_modify_op {
- WIMLIB_MODIFY_OP_DELETE_TREE,
- WIMLIB_MODIFY_OP_ADD_TREE,
- WIMLIB_MODIFY_OP_MOVE_TREE,
-};
-
-struct wimlib_modify_command {
- enum wimlib_modify_op op;
+/** XXX */
+struct wimlib_update_command {
+ enum {
+ WIMLIB_UPDATE_OP_ADD,
+ WIMLIB_UPDATE_OP_DELETE,
+ WIMLIB_UPDATE_OP_MOVE,
+ } op;
union {
- struct wimlib_modify_command_delete_tree {
- int delete_tree_flags;
- const wimlib_tchar *tree_wim_path;
- unsigned long reserved;
- } delete_tree;
-
- struct wimlib_modify_command_add_tree {
- int add_tree_flags;
+ struct {
const wimlib_tchar *fs_source_path;
const wimlib_tchar *wim_target_path;
- unsigned long reserved;
- } add_tree;
-
- struct wimlib_modify_command_move_tree {
- int move_tree_flags;
+ const struct wimlib_capture_config *config;
+ int add_flags;
+ } add;
+ struct {
+ const wimlib_tchar *path_in_wim;
+ int delete_flags;
+ } delete;
+ struct {
const wimlib_tchar *wim_source_path;
const wimlib_tchar *wim_target_path;
- unsigned long reserved;
- } move_tree;
+ int rename_flags;
+ } rename;
};
};
-#endif
+/** Specification of a file or directory tree to extract from a WIM image. */
+struct wimlib_extract_command {
+ /** Path to file or directory tree within the WIM image to extract. It
+ * must be provided as an absolute path from the root of the WIM image.
+ * The path separators may be either forward slashes or backslashes. */
+ wimlib_tchar *wim_source_path;
+
+ /** Filesystem path to extract the file or directory tree to. */
+ wimlib_tchar *fs_dest_path;
+
+ /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
+ int extract_flags;
+};
/**
* Possible values of the error code returned by many functions in wimlib.
WIMLIB_ERR_ICONV_NOT_AVAILABLE,
WIMLIB_ERR_IMAGE_COUNT,
WIMLIB_ERR_IMAGE_NAME_COLLISION,
+ WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
WIMLIB_ERR_INTEGRITY,
WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
WIMLIB_ERR_INVALID_CHUNK_SIZE,
WIMLIB_ERR_INVALID_OVERLAY,
WIMLIB_ERR_INVALID_PARAM,
WIMLIB_ERR_INVALID_PART_NUMBER,
+ WIMLIB_ERR_INVALID_REPARSE_DATA,
WIMLIB_ERR_INVALID_RESOURCE_HASH,
WIMLIB_ERR_INVALID_RESOURCE_SIZE,
WIMLIB_ERR_INVALID_SECURITY_DATA,
WIMLIB_ERR_READLINK,
WIMLIB_ERR_RENAME,
WIMLIB_ERR_REOPEN,
+ WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
WIMLIB_ERR_RESOURCE_ORDER,
WIMLIB_ERR_SPECIAL_FILE,
WIMLIB_ERR_SPLIT_INVALID,
WIMLIB_ERR_VOLUME_LACKS_FEATURES,
WIMLIB_ERR_WRITE,
WIMLIB_ERR_XML,
+ WIMLIB_ERR_PATH_DOES_NOT_EXIST,
+ WIMLIB_ERR_NOT_A_REGULAR_FILE,
};
/**
* Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
*
- * The directory tree of NTFS volume is read immediately for the purpose of
- * constructing a directory entry tree in-memory. Also, all files are read to
- * calculate their SHA1 message digests. However, because the directory tree
- * may contain a very large amount of data, the files themselves are not read
- * into memory permanently, and instead references to their paths saved. The
- * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
+ * The directory tree or NTFS volume is scanned immediately to load the dentry
+ * tree into memory, and file attributes and symbolic links are read. However,
+ * actual file data is not read until wimlib_write() or wimlib_overwrite() is
* called.
*
* See the manual page for the @b wimlib-imagex program for more information
unsigned num_additional_swms,
wimlib_progress_func_t progress_func);
+/**
+ * Extract zero or more files or directory trees from a WIM image.
+ *
+ * This generalizes the single-image extraction functionality of
+ * wimlib_extract_image() to allow extracting only the specified subsets of the
+ * image.
+ *
+ * @param wim
+ * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
+ * split WIM.
+ *
+ * @param image
+ * The 1-based number of the image in @a wim from which the files or
+ * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
+ *
+ * @param default_extract_flags
+ * Default extraction flags; the behavior shall be as if these flags had
+ * been specified in the ::wimlib_extract_command.extract_flags member in
+ * each extraction command, in combination with any flags already present.
+ *
+ * @param cmds
+ * An array of ::wimlib_extract_command structures that specifies the
+ * extractions to perform.
+ *
+ * @param num_cmds
+ * Number of commands in the @a cmds array.
+ *
+ * @param additional_swms
+ * Array of pointers to the ::WIMStruct for each additional part in the
+ * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
+ * need to be in any particular order, but they must include all parts of
+ * the split WIM other than the first part, which must be provided in the
+ * @a wim parameter.
+ *
+ * @param num_additional_swms
+ * Number of additional WIM parts provided in the @a additional_swms array.
+ * This number should be one less than the total number of parts in the
+ * split WIM. Set to 0 if the WIM is a standalone WIM.
+ *
+ * @param progress_func
+ * If non-NULL, a function that will be called periodically with the
+ * progress of the current operation.
+ *
+ * @return 0 on success; nonzero on error. The possible error codes include
+ * those documented as returned by wimlib_extract_image() as well as the
+ * following additional error codes:
+ *
+ * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
+ * The ::wimlib_extract_command.wim_source_path member in one of the
+ * extract commands did not exist in the WIM.
+ * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
+ * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
+ * in which ::wimlib_extract_command.wim_source_path existed but was not a
+ * regular file or directory.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
+ * specified for some commands but not all; or
+ * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
+ * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
+ * for a command in which ::wimlib_extract_command.wim_source_path did not
+ * specify the root directory of the WIM image.
+ */
+extern int
+wimlib_extract_files(WIMStruct *wim,
+ int image,
+ int default_extract_flags,
+ const struct wimlib_extract_command *cmds,
+ size_t num_cmds,
+ WIMStruct **additional_swms,
+ unsigned num_additional_swms,
+ wimlib_progress_func_t progress_func);
+
/**
* Extracts an image, or all images, from a standalone or split WIM file to a
* directory or a NTFS volume.
* and while abnormal termination of the program will result in extra data
* appended to the original WIM, it should still be a valid WIM.
*
+ * If this function completes successfully, no functions should be called on @a
+ * wim other than wimlib_free(). You must use wimlib_open_wim() to read the WIM
+ * file anew.
+ *
* @param wim
* Pointer to the ::WIMStruct for the WIM file to write. There may have
* been in-memory changes made to it, which are then reflected in the
* @retval ::WIMLIB_ERR_RENAME
* The temporary file that the WIM was written to could not be renamed to
* the original filename of @a wim.
- * @retval ::WIMLIB_ERR_REOPEN
- * The WIM was overwritten successfully, but it could not be re-opened
- * read-only. Therefore, the resources in the WIM can no longer be
- * accessed, so this limits the functions that can be called on @a wim
- * before calling wimlib_free().
*/
extern int
wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,