]> wimlib.net Git - wimlib/blobdiff - src/wim.c
Update progress functions
[wimlib] / src / wim.c
index f118e793086774c289eddd9bbf607b0f5caefd9e..ff4ac29be3e53b7c3d981924ee8f452be0b1dcdc 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
@@ -40,6 +40,7 @@
 #include "wimlib/xml.h"
 #include "wimlib/compressor_ops.h"
 #include "wimlib/decompressor_ops.h"
+#include "wimlib/version.h"
 
 #ifdef __WIN32__
 #  include "wimlib/win32.h" /* for realpath() replacement */
 #include <stdlib.h>
 #include <unistd.h>
 
-static int
-image_print_metadata(WIMStruct *wim)
-{
-       DEBUG("Printing metadata for image %d", wim->current_image);
-       print_wim_security_data(wim_security_data(wim));
-       return for_dentry_in_tree(wim_root_dentry(wim), print_dentry,
-                                 wim->lookup_table);
-}
-
 static int
 wim_default_pack_compression_type(void)
 {
@@ -138,8 +130,9 @@ wim_chunk_size_valid(u32 chunk_size, int ctype)
                return order >= 15 && order <= 21;
 
        case WIMLIB_COMPRESSION_TYPE_XPRESS:
+               return order >= 12 && order <= 26;
        case WIMLIB_COMPRESSION_TYPE_LZMS:
-               return order >= 15 && order <= 26;
+               return order >= 15 && order <= 30;
        }
        return false;
 }
@@ -232,6 +225,111 @@ out_free:
        return ret;
 }
 
+static void
+destroy_image_metadata(struct wim_image_metadata *imd,
+                      struct wim_lookup_table *table,
+                      bool free_metadata_lte)
+{
+       free_dentry_tree(imd->root_dentry, table);
+       imd->root_dentry = NULL;
+       free_wim_security_data(imd->security_data);
+       imd->security_data = NULL;
+
+       if (free_metadata_lte) {
+               free_lookup_table_entry(imd->metadata_lte);
+               imd->metadata_lte = NULL;
+       }
+       if (table == NULL) {
+               struct wim_lookup_table_entry *lte, *tmp;
+               list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
+                       free_lookup_table_entry(lte);
+       }
+       INIT_LIST_HEAD(&imd->unhashed_streams);
+       INIT_LIST_HEAD(&imd->inode_list);
+#ifdef WITH_NTFS_3G
+       if (imd->ntfs_vol) {
+               do_ntfs_umount(imd->ntfs_vol);
+               imd->ntfs_vol = NULL;
+       }
+#endif
+}
+
+void
+put_image_metadata(struct wim_image_metadata *imd,
+                  struct wim_lookup_table *table)
+{
+       if (imd && --imd->refcnt == 0) {
+               destroy_image_metadata(imd, table, true);
+               FREE(imd);
+       }
+}
+
+/* Appends the specified image metadata structure to the array of image metadata
+ * for a WIM, and increments the image count. */
+int
+append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
+{
+       struct wim_image_metadata **imd_array;
+
+       DEBUG("Reallocating image metadata array for image_count = %u",
+             wim->hdr.image_count + 1);
+       imd_array = REALLOC(wim->image_metadata,
+                           sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
+
+       if (imd_array == NULL)
+               return WIMLIB_ERR_NOMEM;
+       wim->image_metadata = imd_array;
+       imd_array[wim->hdr.image_count++] = imd;
+       return 0;
+}
+
+struct wim_image_metadata *
+new_image_metadata(void)
+{
+       struct wim_image_metadata *imd;
+
+       imd = CALLOC(1, sizeof(*imd));
+       if (imd) {
+               imd->refcnt = 1;
+               INIT_LIST_HEAD(&imd->inode_list);
+               INIT_LIST_HEAD(&imd->unhashed_streams);
+               DEBUG("Created new image metadata (refcnt=1)");
+       } else {
+               ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
+       }
+       return imd;
+}
+
+static struct wim_image_metadata **
+new_image_metadata_array(unsigned num_images)
+{
+       struct wim_image_metadata **imd_array;
+
+       DEBUG("Creating new image metadata array for %u images",
+             num_images);
+
+       imd_array = CALLOC(num_images, sizeof(imd_array[0]));
+
+       if (imd_array == NULL) {
+               ERROR("Failed to allocate memory for %u image metadata structures",
+                     num_images);
+               return NULL;
+       }
+       for (unsigned i = 0; i < num_images; i++) {
+               imd_array[i] = new_image_metadata();
+               if (imd_array[i] == NULL) {
+                       for (unsigned j = 0; j < i; j++)
+                               put_image_metadata(imd_array[j], NULL);
+                       FREE(imd_array);
+                       return NULL;
+               }
+       }
+       return imd_array;
+}
+
+
+/* Load the metadata for the specified WIM image into memory and set it as the
+ * WIMStruct's currently selected WIM image.  */
 int
 select_wim_image(WIMStruct *wim, int image)
 {
@@ -261,8 +359,8 @@ select_wim_image(WIMStruct *wim, int image)
                return WIMLIB_ERR_METADATA_NOT_FOUND;
        }
 
-       /* If a valid image is currently selected, it can be freed if it is not
-        * modified.  */
+       /* If a valid image is currently selected, its metadata can be freed if
+        * it has not been modified.  */
        if (wim->current_image != WIMLIB_NO_IMAGE) {
                imd = wim_get_current_image_metadata(wim);
                if (!imd->modified) {
@@ -276,11 +374,6 @@ select_wim_image(WIMStruct *wim, int image)
        if (imd->root_dentry || imd->modified) {
                ret = 0;
        } else {
-               #ifdef ENABLE_DEBUG
-               DEBUG("Reading metadata resource specified by the following "
-                     "lookup table entry:");
-               print_lookup_table_entry(imd->metadata_lte, stderr);
-               #endif
                ret = read_metadata_resource(wim, imd);
                if (ret)
                        wim->current_image = WIMLIB_NO_IMAGE;
@@ -364,14 +457,6 @@ wimlib_print_available_images(const WIMStruct *wim, int image)
                print_image_info(wim->wim_info, i);
 }
 
-
-/* API function documented in wimlib.h  */
-WIMLIBAPI int
-wimlib_print_metadata(WIMStruct *wim, int image)
-{
-       return for_image(wim, image, image_print_metadata);
-}
-
 /* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
@@ -407,6 +492,12 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
 {
        int ret;
 
+       if (which & ~(WIMLIB_CHANGE_READONLY_FLAG |
+                     WIMLIB_CHANGE_GUID |
+                     WIMLIB_CHANGE_BOOT_INDEX |
+                     WIMLIB_CHANGE_RPFIX_FLAG))
+               return WIMLIB_ERR_INVALID_PARAM;
+
        if (which & WIMLIB_CHANGE_READONLY_FLAG) {
                if (info->is_marked_readonly)
                        wim->hdr.flags |= WIM_HDR_FLAG_READONLY;
@@ -421,10 +512,8 @@ wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int whic
        if (ret)
                return ret;
 
-       if (which & WIMLIB_CHANGE_GUID) {
-               memcpy(wim->hdr.guid, info->guid, WIM_GID_LEN);
-               wim->guid_set_explicitly = 1;
-       }
+       if (which & WIMLIB_CHANGE_GUID)
+               memcpy(wim->hdr.guid, info->guid, WIM_GUID_LEN);
 
        if (which & WIMLIB_CHANGE_BOOT_INDEX) {
                if (info->boot_index > wim->hdr.image_count) {
@@ -469,7 +558,7 @@ wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
                return ret;
 
        /* Reset the chunk size if it's no longer valid.  */
-       if (!wim_chunk_size_valid(ctype, wim->out_chunk_size))
+       if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
                wim->out_chunk_size = wim_default_chunk_size(ctype);
        return 0;
 }
@@ -483,7 +572,7 @@ wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
                return ret;
 
        /* Reset the chunk size if it's no longer valid.  */
-       if (!wim_chunk_size_valid(ctype, wim->out_pack_chunk_size))
+       if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
                wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
        return 0;
 }
@@ -533,6 +622,15 @@ wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
                                  &wim->out_pack_chunk_size);
 }
 
+WIMLIBAPI void
+wimlib_register_progress_function(WIMStruct *wim,
+                                 wimlib_progress_func_t progfunc,
+                                 void *progctx)
+{
+       wim->progfunc = progfunc;
+       wim->progctx = progctx;
+}
+
 static int
 open_wim_file(const tchar *filename, struct filedes *fd_ret)
 {
@@ -552,8 +650,7 @@ open_wim_file(const tchar *filename, struct filedes *fd_ret)
  * lookup table, and optionally checks the integrity.
  */
 static int
-begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
-          int open_flags, wimlib_progress_func_t progress_func)
+begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
 {
        int ret;
        int xml_num_images;
@@ -626,7 +723,8 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
        if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
                if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
                        wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
-               } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
+               } else if (wim->hdr.flags & (WIM_HDR_FLAG_COMPRESS_XPRESS |
+                                            WIM_HDR_FLAG_COMPRESS_XPRESS_2)) {
                        wim->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
                } else if (wim->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZMS) {
                        wim->compression_type = WIMLIB_COMPRESSION_TYPE_LZMS;
@@ -653,7 +751,7 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
        }
 
        if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
-               ret = check_wim_integrity(wim, progress_func);
+               ret = check_wim_integrity(wim);
                if (ret == WIM_INTEGRITY_NONEXISTENT) {
                        WARNING("No integrity information for `%"TS"'; skipping "
                                "integrity check.", wimfile);
@@ -701,7 +799,8 @@ begin_read(WIMStruct *wim, const void *wim_filename_or_fd,
 
 int
 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
-                     WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
+                     WIMStruct **wim_ret,
+                     wimlib_progress_func_t progfunc, void *progctx)
 {
        WIMStruct *wim;
        int ret;
@@ -720,7 +819,10 @@ open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
        if (wim == NULL)
                return WIMLIB_ERR_NOMEM;
 
-       ret = begin_read(wim, wim_filename_or_fd, open_flags, progress_func);
+       wim->progfunc = progfunc;
+       wim->progctx = progctx;
+
+       ret = begin_read(wim, wim_filename_or_fd, open_flags);
        if (ret) {
                wimlib_free(wim);
                return ret;
@@ -733,115 +835,25 @@ open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
 
 /* API function documented in wimlib.h  */
 WIMLIBAPI int
-wimlib_open_wim(const tchar *wimfile, int open_flags,
-               WIMStruct **wim_ret, wimlib_progress_func_t progress_func)
-{
-       open_flags &= WIMLIB_OPEN_MASK_PUBLIC;
-       return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
-                                    progress_func);
-}
-
-void
-destroy_image_metadata(struct wim_image_metadata *imd,
-                      struct wim_lookup_table *table,
-                      bool free_metadata_lte)
-{
-       free_dentry_tree(imd->root_dentry, table);
-       imd->root_dentry = NULL;
-       free_wim_security_data(imd->security_data);
-       imd->security_data = NULL;
-
-       if (free_metadata_lte) {
-               free_lookup_table_entry(imd->metadata_lte);
-               imd->metadata_lte = NULL;
-       }
-       if (table == NULL) {
-               struct wim_lookup_table_entry *lte, *tmp;
-               list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
-                       free_lookup_table_entry(lte);
-       }
-       INIT_LIST_HEAD(&imd->unhashed_streams);
-       INIT_LIST_HEAD(&imd->inode_list);
-#ifdef WITH_NTFS_3G
-       if (imd->ntfs_vol) {
-               do_ntfs_umount(imd->ntfs_vol);
-               imd->ntfs_vol = NULL;
-       }
-#endif
-}
-
-void
-put_image_metadata(struct wim_image_metadata *imd,
-                  struct wim_lookup_table *table)
-{
-       if (imd && --imd->refcnt == 0) {
-               destroy_image_metadata(imd, table, true);
-               FREE(imd);
-       }
-}
-
-/* Appends the specified image metadata structure to the array of image metadata
- * for a WIM, and increments the image count. */
-int
-append_image_metadata(WIMStruct *wim, struct wim_image_metadata *imd)
-{
-       struct wim_image_metadata **imd_array;
-
-       DEBUG("Reallocating image metadata array for image_count = %u",
-             wim->hdr.image_count + 1);
-       imd_array = REALLOC(wim->image_metadata,
-                           sizeof(wim->image_metadata[0]) * (wim->hdr.image_count + 1));
-
-       if (imd_array == NULL)
-               return WIMLIB_ERR_NOMEM;
-       wim->image_metadata = imd_array;
-       imd_array[wim->hdr.image_count++] = imd;
-       return 0;
-}
-
-
-struct wim_image_metadata *
-new_image_metadata(void)
+wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
+                             WIMStruct **wim_ret,
+                             wimlib_progress_func_t progfunc, void *progctx)
 {
-       struct wim_image_metadata *imd;
+       if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+                          WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+                          WIMLIB_OPEN_FLAG_WRITE_ACCESS))
+               return WIMLIB_ERR_INVALID_PARAM;
 
-       imd = CALLOC(1, sizeof(*imd));
-       if (imd) {
-               imd->refcnt = 1;
-               INIT_LIST_HEAD(&imd->inode_list);
-               INIT_LIST_HEAD(&imd->unhashed_streams);
-               DEBUG("Created new image metadata (refcnt=1)");
-       } else {
-               ERROR_WITH_ERRNO("Failed to allocate new image metadata structure");
-       }
-       return imd;
+       return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
+                                    progfunc, progctx);
 }
 
-struct wim_image_metadata **
-new_image_metadata_array(unsigned num_images)
+/* API function documented in wimlib.h  */
+WIMLIBAPI int
+wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
 {
-       struct wim_image_metadata **imd_array;
-
-       DEBUG("Creating new image metadata array for %u images",
-             num_images);
-
-       imd_array = CALLOC(num_images, sizeof(imd_array[0]));
-
-       if (imd_array == NULL) {
-               ERROR("Failed to allocate memory for %u image metadata structures",
-                     num_images);
-               return NULL;
-       }
-       for (unsigned i = 0; i < num_images; i++) {
-               imd_array[i] = new_image_metadata();
-               if (imd_array[i] == NULL) {
-                       for (unsigned j = 0; j < i; j++)
-                               put_image_metadata(imd_array[j], NULL);
-                       FREE(imd_array);
-                       return NULL;
-               }
-       }
-       return imd_array;
+       return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
+                                            NULL, NULL);
 }
 
 /* Checksum all streams that are unhashed (other than the metadata streams),
@@ -982,6 +994,13 @@ test_locale_ctype_utf8(void)
 #endif
 }
 
+/* API function documented in wimlib.h  */
+WIMLIBAPI u32
+wimlib_get_version(void)
+{
+       return WIMLIB_VERSION_CODE;
+}
+
 /* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_global_init(int init_flags)
@@ -990,6 +1009,15 @@ wimlib_global_init(int init_flags)
 
        if (already_inited)
                return 0;
+
+       if (init_flags & ~(WIMLIB_INIT_FLAG_ASSUME_UTF8 |
+                          WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES |
+                          WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE |
+                          WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE))
+               return WIMLIB_ERR_INVALID_PARAM;
+
        libxml_global_init();
        if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
                wimlib_mbs_is_utf8 = test_locale_ctype_utf8();