X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=a50c0eded2226d029c62a2342362aef602e86f24;hp=08d74b25c5cc2a0b95361eb15455f5a14c112465;hb=603da5edd9d878b6ffeb11508a18356e5c324aaf;hpb=3f9b53a4a214a254bb27ed30994faf2a0fd12375

diff --git a/src/wimlib.h b/src/wimlib.h
index 08d74b25..a50c0ede 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -31,7 +31,7 @@
  *
  * \section intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.3.2.  If you
+ * This is the documentation for the library interface of wimlib 1.3.3.  If you
  * have installed wimlib and want to know how to use the @b wimlib-imagex
  * program, please see the man pages instead.  Also: the actual project page
  * where you can download the source code for the library is at <a
@@ -253,7 +253,7 @@
 #define WIMLIB_MINOR_VERSION 3
 
 /** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 2
+#define WIMLIB_PATCH_VERSION 3
 
 /**
  * Opaque structure that represents a WIM file.  This is an in-memory structure
@@ -302,6 +302,11 @@ enum wimlib_progress_msg {
 	 * ::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,
@@ -328,6 +333,11 @@ enum wimlib_progress_msg {
 	 * ::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. */
@@ -497,6 +507,11 @@ union wimlib_progress_info {
 		 * 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. */
@@ -642,7 +657,7 @@ struct wimlib_capture_config {
 	struct wimlib_pattern_list reserved2;
 
 	/** Library internal use only. */
-	wimlib_tchar *_prefix;
+	const wimlib_tchar *_prefix;
 
 	/** Library internal use only. */
 	size_t _prefix_num_tchars;
@@ -694,6 +709,29 @@ struct wimlib_capture_config {
  * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE		0x00000080
 
+/** Reparse-point fixups:  Modify absolute symbolic links (or junction points,
+ * in the case of Windows) that point inside the directory being captured to
+ * instead be absolute relative to the directory being captured, rather than the
+ * current root; also exclude absolute symbolic links that point outside the
+ * directory tree being captured.
+ *
+ * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
+ * the WIM header or if this is the first image being added.
+ * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
+ * reparse point fixups enabled and currently cannot be unset. */
+#define WIMLIB_ADD_IMAGE_FLAG_RPFIX			0x00000100
+
+/** Don't do reparse point fixups.  The default behavior is described in the
+ * documentation for ::WIMLIB_ADD_IMAGE_FLAG_RPFIX. */
+#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX			0x00000200
+
+/** Do not issue an error if the path to delete does not exist. */
+#define WIMLIB_DELETE_FLAG_FORCE			0x00000001
+
+/** Delete a file or directory tree recursively; if not specified, an error is
+ * issued if the path to delete is a directory. */
+#define WIMLIB_DELETE_FLAG_RECURSIVE			0x00000002
+
 /******************************
  * WIMLIB_EXPORT_FLAG_* *
  ******************************/
@@ -741,6 +779,20 @@ struct wimlib_capture_config {
  * not have permission to set the desired one. */
 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS			0x00000080
 
+/* 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.  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_*        *
  ******************************/
@@ -828,68 +880,50 @@ struct wimlib_capture_config {
  * deleting an image in this way. */
 #define WIMLIB_WRITE_FLAG_SOFT_DELETE			0x00000010
 
-
-#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,
+/** Assume that strings are represented in UTF-8, even if this is not the
+ * locale's character encoding. */
+#define WIMLIB_INIT_FLAG_ASSUME_UTF8			0x00000001
+
+/** XXX */
+struct wimlib_update_command {
+	enum {
+		WIMLIB_UPDATE_OP_ADD = 0,
+		WIMLIB_UPDATE_OP_DELETE,
+		WIMLIB_UPDATE_OP_RENAME,
+	} op;
+	union {
+		struct {
+			wimlib_tchar *fs_source_path;
+			wimlib_tchar *wim_target_path;
+			struct wimlib_capture_config *config;
+			int add_flags;
+		} add;
+		struct {
+			wimlib_tchar *wim_path;
+			int delete_flags;
+		} delete;
+		struct {
+			wimlib_tchar *wim_source_path;
+			wimlib_tchar *wim_target_path;
+			int rename_flags;
+		} rename;
+	};
 };
 
-enum {
-	WIMLIB_DELETE_TREE_FLAG_FORCE			= 0x1,
-	WIMLIB_DELETE_TREE_FLAG_RECURSIVE		= 0x2,
-	WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR	= 0x4,
-};
+/** 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;
 
-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,
-};
+	/** Filesystem path to extract the file or directory tree to. */
+	wimlib_tchar *fs_dest_path;
 
-enum wimlib_modify_op {
-	WIMLIB_MODIFY_OP_DELETE_TREE,
-	WIMLIB_MODIFY_OP_ADD_TREE,
-	WIMLIB_MODIFY_OP_MOVE_TREE,
+	/** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
+	int extract_flags;
 };
 
-struct wimlib_modify_command {
-	enum wimlib_modify_op 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;
-			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 wimlib_tchar *wim_source_path;
-			const wimlib_tchar *wim_target_path;
-			unsigned long reserved;
-		} move_tree;
-	};
-};
-#endif
-
-
 /**
  * Possible values of the error code returned by many functions in wimlib.
  *
@@ -912,6 +946,7 @@ enum wimlib_error_code {
 	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,
@@ -925,6 +960,7 @@ enum wimlib_error_code {
 	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,
@@ -946,6 +982,7 @@ enum wimlib_error_code {
 	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,
@@ -955,26 +992,57 @@ enum wimlib_error_code {
 	WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
 	WIMLIB_ERR_UNKNOWN_VERSION,
 	WIMLIB_ERR_UNSUPPORTED,
+	WIMLIB_ERR_VOLUME_LACKS_FEATURES,
 	WIMLIB_ERR_WRITE,
 	WIMLIB_ERR_XML,
+	WIMLIB_ERR_PATH_DOES_NOT_EXIST,
+	WIMLIB_ERR_NOT_A_REGULAR_FILE,
+	WIMLIB_ERR_IS_DIRECTORY,
 };
 
 
-/** Used to indicate that no WIM image or an invalid WIM image. */
+/** Used to indicate no WIM image or an invalid WIM image. */
 #define WIMLIB_NO_IMAGE		0
 
 /** Used to specify all images in the WIM. */
 #define WIMLIB_ALL_IMAGES	(-1)
 
+/**
+ * Appends an empty image to a WIM file.  This empty image will initially
+ * contain no files or directories, although if written without further
+ * modifications, a root directory will be created automatically for it.
+ *
+ * @param wim
+ *	Pointer to the ::WIMStruct for the WIM file to which the image is to be
+ *	added.
+ * @param name
+ *	Name to give the new image.
+ * @param new_idx_ret
+ *	If non-<code>NULL</code>, the index of the newly added image is returned
+ *	in this location.
+ *
+ * @return 0 on success; nonzero on failure.  The possible error codes are:
+ *
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ *	@a name was @c NULL or an empty string.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ *	@a wim is part of a split WIM.
+ * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
+ *	There is already an image in @a wim named @a name.
+ * @retval ::WIMLIB_ERR_NOMEM
+ *	Failed to allocate the memory needed to add the new image.
+ */
+extern int
+wimlib_add_empty_image(WIMStruct *wim,
+		       const wimlib_tchar *name,
+		       int *new_idx_ret);
+
 /**
  * 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
@@ -1050,7 +1118,7 @@ extern int
 wimlib_add_image(WIMStruct *wim,
 		 const wimlib_tchar *source,
 		 const wimlib_tchar *name,
-		 struct wimlib_capture_config *config,
+		 const struct wimlib_capture_config *config,
 		 int add_image_flags,
 		 wimlib_progress_func_t progress_func);
 
@@ -1061,11 +1129,6 @@ wimlib_add_image(WIMStruct *wim,
  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
  * capture</b> for full details on how this mode works.
  *
- * Additional note:  @a sources is not a @c const parameter and you cannot
- * assume that its contents are valid after this function returns.  You must
- * save pointers to the strings in these structures if you need to free them
- * later, and/or save copies if needed.
- *
  * In addition to the error codes that wimlib_add_image() can return,
  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
  * when trying to overlay a non-directory on a directory or when otherwise
@@ -1078,10 +1141,10 @@ wimlib_add_image(WIMStruct *wim,
  * NTFS mode.) */
 extern int
 wimlib_add_image_multisource(WIMStruct *w,
-			     struct wimlib_capture_source *sources,
+			     const struct wimlib_capture_source *sources,
 			     size_t num_sources,
 			     const wimlib_tchar *name,
-			     struct wimlib_capture_config *config,
+			     const struct wimlib_capture_config *config,
 			     int add_image_flags,
 			     wimlib_progress_func_t progress_func);
 
@@ -1271,6 +1334,78 @@ wimlib_export_image(WIMStruct *src_wim, int src_image,
 		    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.
@@ -1562,17 +1697,24 @@ wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
  * threads, then you must call this function serially first.
  *
  * Since wimlib 1.3.0, you must call this function if the character encoding of
- * the current locale is not UTF-8.
+ * the current locale is not UTF-8 and you do not want wimlib to assume a UTF-8
+ * encoding.
  *
  * Since wimlib 1.3.2, you must call this function if using the Windows-native
  * build of the library so that certain functions can be dynamically loaded from
  * system DLLs.
  *
- * This function currently always returns 0, but it may return other error codes
- * in future releases.
+ * Since wimlib 1.3.3, this function takes the @a init_flags parameter.
+ *
+ * @param init_flags
+ * 	::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume that all input
+ * 	data, including filenames, are in UTF-8, and that UTF-8 data can be
+ * 	directly printed to the console.
+ *
+ * @return 0; other error codes may be returned in future releases.
  */
 extern int
-wimlib_global_init();
+wimlib_global_init(int init_flags);
 
 /**
  * Since wimlib 1.2.6:  Cleanup function for wimlib.  This is not re-entrant.
@@ -1936,6 +2078,10 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * 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
@@ -1963,11 +2109,6 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * @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,
@@ -2385,6 +2526,15 @@ wimlib_unmount_image(const wimlib_tchar *dir,
 		     int unmount_flags,
 		     wimlib_progress_func_t progress_func);
 
+/** XXX */
+extern int
+wimlib_update_image(WIMStruct *wim,
+		    int image,
+		    const struct wimlib_update_command *cmds,
+		    size_t num_cmds,
+		    int update_flags,
+		    wimlib_progress_func_t progress_func);
+
 /**
  * Writes a standalone WIM to a file.
  *