X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=c4635e89e5470c85b1118d5111fb76aeef8eb917;hp=974fba7f61529d2ef0af86ac5e9362375c6d1573;hb=794ecd09fc527e3328e469c14e563d42a7a70a39;hpb=fc8276d0a3efb3df5f7512b3fa9499eb1b3449eb diff --git a/src/wimlib.h b/src/wimlib.h index 974fba7f..c4635e89 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.4.0. 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 --without-ntfs-3g flag. * * To extract an image from a WIM file, call wimlib_extract_image(). You may @@ -250,10 +250,10 @@ #define WIMLIB_MAJOR_VERSION 1 /** Minor version of the library (for example, the 2 in 1.2.5). */ -#define WIMLIB_MINOR_VERSION 3 +#define WIMLIB_MINOR_VERSION 4 /** Patch version of the library (for example, the 5 in 1.2.5). */ -#define WIMLIB_PATCH_VERSION 2 +#define WIMLIB_PATCH_VERSION 0 /** * 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. */ @@ -335,7 +345,7 @@ enum wimlib_progress_msg { /** A directory or file is being scanned. @a info will point to * ::wimlib_progress_info.scan, and its @a cur_path member will be - * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE + * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE * is passed to wimlib_add_image(). */ WIMLIB_PROGRESS_MSG_SCAN_DENTRY, @@ -431,6 +441,7 @@ union wimlib_progress_info { * ::WIMLIB_COMPRESSION_TYPE_LZX. */ int compression_type; + /** Library internal use only. */ uint64_t _private; } write_streams; @@ -496,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. */ @@ -641,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; @@ -649,59 +665,97 @@ struct wimlib_capture_config { /***************************** - * WIMLIB_ADD_IMAGE_FLAG_* * + * WIMLIB_ADD_FLAG_* *****************************/ /** Directly capture a NTFS volume rather than a generic directory. This flag - * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or - * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */ -#define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001 + * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or + * ::WIMLIB_ADD_FLAG_UNIX_DATA. */ +#define WIMLIB_ADD_FLAG_NTFS 0x00000001 /** Follow symlinks; archive and dump the files they point to. Cannot be used - * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */ -#define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002 + * with ::WIMLIB_ADD_FLAG_NTFS. */ +#define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002 /** Call the progress function with the message * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to * be scanned. */ -#define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004 +#define WIMLIB_ADD_FLAG_VERBOSE 0x00000004 /** Mark the image being added as the bootable image of the WIM. */ -#define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008 +#define WIMLIB_ADD_FLAG_BOOT 0x00000008 /** Store the UNIX owner, group, and mode. This is done by adding a special * alternate data stream to each regular file, symbolic link, and directory to * contain this information. Please note that this flag is for convenience * only; Microsoft's @a imagex.exe will not understand this special information. - * This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */ -#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010 + * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */ +#define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010 /** Do not capture security descriptors. Only has an effect in NTFS capture * mode, or in Win32 native builds. */ -#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020 +#define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020 /** Fail immediately if the full security descriptor of any file or directory * cannot be accessed. Only has an effect in Win32 native builds. The default * behavior without this flag is to first try omitting the SACL from the * security descriptor, then to try omitting the security descriptor entirely. * */ -#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS 0x00000040 +#define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040 /** Call the progress function with the message * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from * capture. This is a subset of the messages provided by - * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */ -#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE 0x00000080 + * ::WIMLIB_ADD_FLAG_VERBOSE. */ +#define WIMLIB_ADD_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_FLAG_RPFIX 0x00000100 + +/** Don't do reparse point fixups. The default behavior is described in the + * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */ +#define WIMLIB_ADD_FLAG_NORPFIX 0x00000200 + +#define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS +#define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE +#define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE +#define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT +#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA +#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS +#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS +#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE +#define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX +#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX /****************************** - * WIMLIB_EXPORT_FLAG_* * + * WIMLIB_DELETE_FLAG_* + ******************************/ + +/** Do not issue an error if the path to delete does not exist. */ +#define WIMLIB_DELETE_FLAG_FORCE 0x00000001 + +/** Delete the 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_* ******************************/ /** See documentation for wimlib_export_image(). */ #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001 /****************************** - * WIMLIB_EXTRACT_FLAG_* * + * WIMLIB_EXTRACT_FLAG_* ******************************/ /** Extract the image directly to a NTFS volume rather than a generic directory. @@ -725,7 +779,7 @@ struct wimlib_capture_config { /** Read the WIM file sequentially while extracting the image. */ #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010 -/** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. +/** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */ #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020 @@ -740,8 +794,22 @@ struct wimlib_capture_config { * not have permission to set the desired one. */ #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080 +/* Extract equivalent to ::WIMLIB_ADD_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_* * + * WIMLIB_MOUNT_FLAG_* ******************************/ /** Mount the WIM image read-write rather than the default of read-only. */ @@ -762,7 +830,7 @@ struct wimlib_capture_config { #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010 /** Use UNIX file owners, groups, and modes if available in the WIM (see - * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */ + * ::WIMLIB_ADD_FLAG_UNIX_DATA). */ #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020 /** Allow other users to see the mounted filesystem. (this passes the @c @@ -770,7 +838,7 @@ struct wimlib_capture_config { #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040 /****************************** - * WIMLIB_OPEN_FLAG_* * + * WIMLIB_OPEN_FLAG_* ******************************/ /** Verify the WIM contents against the WIM's integrity table, if present. */ @@ -780,7 +848,7 @@ struct wimlib_capture_config { #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002 /****************************** - * WIMLIB_UNMOUNT_FLAG_* * + * WIMLIB_UNMOUNT_FLAG_* ******************************/ /** Include an integrity table in the WIM after it's been unmounted. Ignored @@ -798,7 +866,7 @@ struct wimlib_capture_config { #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008 /****************************** - * WIMLIB_WRITE_FLAG_* * + * WIMLIB_WRITE_FLAG_* ******************************/ /** Include an integrity table in the new WIM file. */ @@ -827,67 +895,85 @@ struct wimlib_capture_config { * deleting an image in this way. */ #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010 +/****************************** + * WIMLIB_INIT_FLAG_* + ******************************/ -#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 -enum { - WIMLIB_DELETE_TREE_FLAG_FORCE = 0x1, - WIMLIB_DELETE_TREE_FLAG_RECURSIVE = 0x2, - WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR = 0x4, -}; +/** Specification of an update to perform on a WIM image. */ +struct wimlib_update_command { -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, -}; + /** The specific type of update to perform. */ + enum wimlib_update_op { + /** Add a new file or directory tree to the WIM image in a + * certain location. */ + WIMLIB_UPDATE_OP_ADD = 0, -enum wimlib_modify_op { - WIMLIB_MODIFY_OP_DELETE_TREE, - WIMLIB_MODIFY_OP_ADD_TREE, - WIMLIB_MODIFY_OP_MOVE_TREE, -}; + /** Delete a file or directory tree from the WIM image. */ + WIMLIB_UPDATE_OP_DELETE, -struct wimlib_modify_command { - enum wimlib_modify_op op; + /** Rename a file or directory tree in the WIM image. */ + WIMLIB_UPDATE_OP_RENAME, + } 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; + /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */ + struct wimlib_add_command { + /** Filesystem path to the file or directory tree to + * add. */ + wimlib_tchar *fs_source_path; + /** Path, specified from the root of the WIM image, at + * which to add the file or directory tree within the + * WIM image. */ + wimlib_tchar *wim_target_path; + + /** Configuration for excluded files. @c NULL means + * exclude no files. */ + struct wimlib_capture_config *config; + + /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */ + int add_flags; + } add; + /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */ + struct wimlib_delete_command { + /** Path, specified from the root of the WIM image, for + * the file or directory tree within the WIM image to be + * deleted. */ + wimlib_tchar *wim_path; + /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */ + int delete_flags; + } delete; + /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */ + struct wimlib_rename_command { + /** Path, specified from the root of the WIM image, for + * the source file or directory tree within the WIM + * image. */ + wimlib_tchar *wim_source_path; + /** Path, specified from the root of the WIM image, for + * the destination file or directory tree within the WIM + * image. */ + wimlib_tchar *wim_target_path; + /** Reserved; set to 0. */ + 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. @@ -895,9 +981,6 @@ struct wimlib_modify_command { * See the documentation for each wimlib function to see specifically what error * codes can be returned by a given function, and what they mean. */ -/* Note: these are currently in alphabetic order, but new error codes should be - * added at the end to maintain a compatible ABI, except when it's being broken - * anyway. */ enum wimlib_error_code { WIMLIB_ERR_SUCCESS = 0, WIMLIB_ERR_ALREADY_LOCKED, @@ -911,6 +994,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, @@ -924,6 +1008,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, @@ -945,6 +1030,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, @@ -954,31 +1040,63 @@ 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, + WIMLIB_ERR_NOTEMPTY, }; -/** 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-NULL, 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 * about the "normal" capture mode versus the NTFS capture mode (entered by - * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS). + * providing the flag ::WIMLIB_ADD_FLAG_NTFS). * * Note that @b no changes are committed to the underlying WIM file (if * any) until wimlib_write() or wimlib_overwrite() is called. @@ -990,13 +1108,14 @@ enum wimlib_error_code { * A path to a directory or unmounted NTFS volume that will be captured as * a WIM image. * @param name - * The name to give the image. This must be non-@c NULL. + * The name to give the image. It must be nonempty and must specify a name + * that does not yet exist in @a wim. * @param config * Capture configuration that specifies files, directories, or path globs * to exclude from being captured. If @c NULL, a dummy configuration where * no paths are treated specially is used. - * @param add_image_flags - * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. + * @param add_flags + * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG. * @param progress_func * If non-NULL, a function that will be called periodically with the * progress of the current operation. @@ -1005,52 +1124,18 @@ enum wimlib_error_code { * discarded so that it appears to be in the same state as when this function * was called. * - * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION - * There is already an image named @a name in @a wim. - * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG - * @a config was not @c NULL and did not specify a valid image capture - * configuration. - * @retval ::WIMLIB_ERR_INVALID_PARAM - * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string. - * @retval ::WIMLIB_ERR_NOMEM - * Failed to allocate needed memory. - * @retval ::WIMLIB_ERR_NOTDIR - * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was - * not specified in @a add_image_flags). - * @retval ::WIMLIB_ERR_NTFS_3G - * An error was returned from a libntfs-3g function when the NTFS volume - * was being opened, scanned, or closed (only if - * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags). - * @retval ::WIMLIB_ERR_OPEN - * Failed to open a file or directory in the directory tree rooted at @a - * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a - * add_image_flags). - * @retval ::WIMLIB_ERR_READ - * Failed to read a file in the directory tree rooted at @a source (only if - * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags). - * @retval ::WIMLIB_ERR_SPECIAL_FILE - * The directory tree rooted at @a source contains a special file that is - * not a directory, regular file, or symbolic link. This currently can - * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a - * add_image_flags, but it may be returned for unsupported NTFS files in - * the future. - * @retval ::WIMLIB_ERR_STAT - * Failed obtain the metadata for a file or directory in the directory tree - * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not - * specified in @a add_image_flags). - * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED - * @a wim is part of a split WIM. Adding an image to a split WIM is - * unsupported. - * @retval ::WIMLIB_ERR_UNSUPPORTED - * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but - * wimlib was configured with the @c --without-ntfs-3g flag. + * This function is implemented by calling wimlib_add_empty_image(), then + * calling wimlib_update_image() with a single "add" command, so any error code + * returned by wimlib_add_empty_image() may be returned, as well as any error + * codes returned by wimlib_update_image() other than ones documented as only + * being returned specifically by an update involving delete or rename commands. */ extern int wimlib_add_image(WIMStruct *wim, const wimlib_tchar *source, const wimlib_tchar *name, - struct wimlib_capture_config *config, - int add_image_flags, + const struct wimlib_capture_config *config, + int add_flags, wimlib_progress_func_t progress_func); /** This function is equivalent to wimlib_add_image() except it allows for @@ -1060,28 +1145,23 @@ wimlib_add_image(WIMStruct *wim, * same as wimlib_add_image(). See the documentation for wimlib-imagex * capture 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 * trying to overlay multiple conflicting files to the same location in the WIM * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if - * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there + * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there * was not exactly one capture source with the target being the root directory. * (In this respect, there is no advantage to using * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting * NTFS mode.) */ extern int -wimlib_add_image_multisource(WIMStruct *w, - struct wimlib_capture_source *sources, +wimlib_add_image_multisource(WIMStruct *wim, + const struct wimlib_capture_source *sources, size_t num_sources, const wimlib_tchar *name, - struct wimlib_capture_config *config, - int add_image_flags, + const struct wimlib_capture_config *config, + int add_flags, wimlib_progress_func_t progress_func); /** @@ -1166,16 +1246,9 @@ wimlib_delete_image(WIMStruct *wim, int image); * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will * have references back to @a src_wim. * - * Previous versions of this function left @a dest_wim in an indeterminate state - * on failure. This is no longer the case; all changes to @a dest_wim made by - * this function are rolled back on failure. - * - * Previous versions of this function did not allow exporting an image that had - * been added by wimlib_add_image(). This is no longer the case; you may now - * export an image regardless of how it was added. + * If this function fails, all changes to @a dest_wim are rolled back. * - * Regardless of whether this function succeeds or fails, no changes are made to - * @a src_wim. + * No changes shall be made to @a src_wim by this function. * * Please note that no changes are committed to the underlying WIM file of @a * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called. @@ -1270,6 +1343,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. @@ -1561,17 +1706,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. @@ -1935,6 +2087,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 @@ -1962,11 +2118,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, @@ -2384,6 +2535,116 @@ wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags, wimlib_progress_func_t progress_func); +/** + * Update a WIM image by adding, deleting, and/or renaming files or directories. + * + * @param wim + * Pointer to the ::WIMStruct for the WIM file to update. + * @param image + * The 1-based index of the image in the WIM to update. It cannot be + * ::WIMLIB_ALL_IMAGES. + * @param cmds + * An array of ::wimlib_update_command's that specify the update operations + * to perform. + * @param num_cmds + * Number of commands in @a cmds. + * @param update_flags + * Reserved; must be 0. + * @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. On failure, some but not all of the + * update commands may have been executed. No individual update command will + * have been partially executed. Possible error codes include: + * + * @retval ::WIMLIB_ERR_DECOMPRESSION + * Failed to decompress the metadata resource from @a image in @a wim. + * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG + * The capture configuration structure specified for an add command was + * invalid. + * @retval ::WIMLIB_ERR_INVALID_DENTRY + * A directory entry for @a image in @a wim is invalid. + * @retval ::WIMLIB_ERR_INVALID_IMAGE + * @a image did not specify a single, existing image in @a wim. + * @retval ::WIMLIB_ERR_INVALID_OVERLAY + * Attempted to perform an add command that conflicted with previously + * existing files in the WIM when an overlay was attempted. + * @retval ::WIMLIB_ERR_INVALID_PARAM + * An unknown operation type was specified in the update commands; or, + * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set + * in the @a add_flags, but the same image had previously already been + * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and + * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add + * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were + * specified in the @a add_flags for an add command in which @a + * wim_target_path was not the root directory of the WIM image. + * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA + * (Windows only): While executing an add command, tried to capture a + * reparse point with invalid data. + * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE + * The metadata resource for @a image in @a wim is invalid. + * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA + * The security data for image @a image in @a wim is invalid. + * @retval ::WIMLIB_ERR_IS_DIRECTORY + * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was + * for a WIM path that corresponded to a directory; or, a rename command + * attempted to rename a directory to a non-directory. + * @retval ::WIMLIB_ERR_NOMEM + * Failed to allocate needed memory. + * @retval ::WIMLIB_ERR_NOTDIR + * A rename command attempted to rename a directory to a non-directory; or, + * an add command was executed that attempted to set the root of the WIM + * image as a non-directory. + * @retval ::WIMLIB_ERR_NOTEMPTY + * A rename command attempted to rename a directory to a non-empty + * directory. + * @retval ::WIMLIB_ERR_NTFS_3G + * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an + * error occurred while reading data from the NTFS volume using libntfs-3g. + * @retval ::WIMLIB_ERR_OPEN + * Failed to open a file to be captured while executing an add command. + * @retval ::WIMLIB_ERR_OPENDIR + * Failed to open a file to be captured while executing an add command. + * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST + * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a + * WIM path that did not exist; or, a component of the path of the source + * or destination of a rename command was used as a directory but was not, + * in fact, a directory. + * @retval ::WIMLIB_ERR_READ + * Failed to read the metadata resource for @a image in @a wim; or, while + * executing an add command, failed to read data from a file or directory + * to be captured. + * @retval ::WIMLIB_ERR_READLINK + * While executing an add command, failed to read the target of a symbolic + * link or junction point. + * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED + * (Windows only) Failed to perform a reparse point fixup because of + * problems with the data of a reparse point. + * @retval ::WIMLIB_ERR_SPECIAL_FILE + * While executing an add command, attempted to capture a file that was not + * a supported file type, such as a regular file, directory, symbolic link, + * or (on Windows) a reparse point. + * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED + * @a wim is part of a split WIM. Updating a split WIM is unsupported. + * @retval ::WIMLIB_ERR_STAT + * While executing an add command, failed to get attributes for a file or + * directory. + * @retval ::WIMLIB_ERR_UNSUPPORTED + * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update + * command, but wimlib was configured with the @c --without-ntfs-3g flag; + * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA + * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a + * add_flags for an update command. + */ +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. *