/*
* Copyright (C) 2012, 2013 Eric Biggers
*
- * wimlib - Library for working with WIM files
- *
* This file is part of wimlib, a library for working with WIM files.
*
* wimlib is free software; you can redistribute it and/or modify it under the
* along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
-#include "config.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include "wimlib/error.h"
+#include "wimlib/dentry.h"
+#include "wimlib/encoding.h"
+#include "wimlib/file_io.h"
+#include "wimlib/integrity.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
+#ifdef WITH_NTFS_3G
+# include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
+#endif
+#include "wimlib/security.h"
+#include "wimlib/wim.h"
+#include "wimlib/xml.h"
+#include "wimlib/compressor_ops.h"
+#include "wimlib/decompressor_ops.h"
+#include "wimlib/version.h"
#ifdef __WIN32__
-# include <windows.h>
-# ifdef ERROR
-# undef ERROR
-# endif
+# include "wimlib/win32.h" /* for realpath() replacement */
#endif
-#include <limits.h>
-#include <stdlib.h>
-#include <stdarg.h>
#include <errno.h>
-
-#include "dentry.h"
-#include <unistd.h>
#include <fcntl.h>
-
-#ifdef WITH_NTFS_3G
-#include <time.h>
-#include <ntfs-3g/volume.h>
+#ifndef __WIN32__
+# include <langinfo.h>
#endif
+#include <limits.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <unistd.h>
-#include "wimlib_internal.h"
-#include "buffer_io.h"
-#include "lookup_table.h"
-#include "xml.h"
-
-#ifdef __WIN32__
-static char *realpath(const char *path, char *resolved_path)
+static int
+wim_default_pack_compression_type(void)
{
- DWORD ret;
- wimlib_assert(resolved_path == NULL);
-
- ret = GetFullPathNameA(path, 0, NULL, NULL);
- if (!ret)
- goto fail_win32;
+ return WIMLIB_COMPRESSION_TYPE_LZMS;
+}
- resolved_path = MALLOC(ret + 1);
- if (!resolved_path)
- goto fail;
- ret = GetFullPathNameA(path, ret, resolved_path, NULL);
- if (!ret) {
- free(resolved_path);
- goto fail_win32;
+static u32
+wim_default_pack_chunk_size(int ctype) {
+ switch (ctype) {
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ return 1U << 26; /* 67108864 */
+ default:
+ return 1U << 15; /* 32768 */
}
- return resolved_path;
-fail_win32:
- win32_error(GetLastError());
-fail:
- return NULL;
}
-#endif
-static int image_print_metadata(WIMStruct *w)
+static WIMStruct *
+new_wim_struct(void)
{
- DEBUG("Printing metadata for image %d", w->current_image);
- print_security_data(wim_security_data(w));
- return for_dentry_in_tree(wim_root_dentry(w), print_dentry,
- w->lookup_table);
+ WIMStruct *wim = CALLOC(1, sizeof(WIMStruct));
+ if (wim) {
+ filedes_invalidate(&wim->in_fd);
+ filedes_invalidate(&wim->out_fd);
+ wim->out_pack_compression_type = wim_default_pack_compression_type();
+ wim->out_pack_chunk_size = wim_default_pack_chunk_size(
+ wim->out_pack_compression_type);
+ INIT_LIST_HEAD(&wim->subwims);
+ }
+ return wim;
}
-
-static int image_print_files(WIMStruct *w)
+/* Determine if the chunk size is valid for the specified compression type. */
+static bool
+wim_chunk_size_valid(u32 chunk_size, int ctype)
{
- return for_dentry_in_tree(wim_root_dentry(w), print_dentry_full_path,
- NULL);
+ u32 order;
+
+ /* Chunk size is meaningless for uncompressed WIMs --- any value is
+ * okay. */
+ if (ctype == WIMLIB_COMPRESSION_TYPE_NONE)
+ return true;
+
+ /* Chunk size must be power of 2. */
+ if (chunk_size == 0)
+ return false;
+ order = bsr32(chunk_size);
+ if (chunk_size != 1U << order)
+ return false;
+
+ /* Order Size
+ * ===== ====
+ * 15 32768
+ * 16 65536
+ * 17 131072
+ * 18 262144
+ * 19 524288
+ * 20 1048576
+ * 21 2097152
+ * 22 4194304
+ * 23 8388608
+ * 24 16777216
+ * 25 33554432
+ * 26 67108864
+ */
+
+ /* See the documentation for the --chunk-size option of `wimlib-imagex
+ * capture' for information about allowed chunk sizes. */
+ switch (ctype) {
+ case WIMLIB_COMPRESSION_TYPE_LZX:
+ return order >= 15 && order <= 21;
+
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
+ return order >= 12 && order <= 26;
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ return order >= 15 && order <= 30;
+ }
+ return false;
}
-static WIMStruct *new_wim_struct()
+/* Return the default chunk size to use for the specified compression type.
+ *
+ * See notes above in wim_chunk_size_valid(). */
+static u32
+wim_default_chunk_size(int ctype)
{
- WIMStruct *w = CALLOC(1, sizeof(WIMStruct));
-#ifdef WITH_FUSE
- if (pthread_mutex_init(&w->fp_tab_mutex, NULL) != 0) {
- ERROR_WITH_ERRNO("Failed to initialize mutex");
- FREE(w);
- w = NULL;
+ switch (ctype) {
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ return 1U << 17; /* 131072 */
+ default:
+ return 1U << 15; /* 32768 */
}
-#endif
- return w;
-
}
/*
- * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES, @visitor
- * is called on the WIM once for each image, with each image selected as the
- * current image in turn. If @image is a certain image, @visitor is called on
- * the WIM only once, with that image selected.
+ * Calls a function on images in the WIM. If @image is WIMLIB_ALL_IMAGES,
+ * @visitor is called on the WIM once for each image, with each image selected
+ * as the current image in turn. If @image is a certain image, @visitor is
+ * called on the WIM only once, with that image selected.
*/
-int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *))
+int
+for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *))
{
int ret;
int start;
if (image == WIMLIB_ALL_IMAGES) {
start = 1;
- end = w->hdr.image_count;
- } else if (image >= 1 && image <= w->hdr.image_count) {
+ end = wim->hdr.image_count;
+ } else if (image >= 1 && image <= wim->hdr.image_count) {
start = image;
end = image;
} else {
return WIMLIB_ERR_INVALID_IMAGE;
}
for (i = start; i <= end; i++) {
- ret = select_wim_image(w, i);
+ ret = select_wim_image(wim, i);
if (ret != 0)
return ret;
- ret = visitor(w);
+ ret = visitor(wim);
if (ret != 0)
return ret;
}
return 0;
}
-static int sort_image_metadata_by_position(const void *p1, const void *p2)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_create_new_wim(int ctype, WIMStruct **wim_ret)
{
- const struct wim_image_metadata *imd1 = p1;
- const struct wim_image_metadata *imd2 = p2;
- u64 offset1 = imd1->metadata_lte->resource_entry.offset;
- u64 offset2 = imd2->metadata_lte->resource_entry.offset;
- if (offset1 < offset2)
- return -1;
- else if (offset1 > offset2)
- return 1;
- else
- return 0;
-}
-
-/*
- * If @lte points to a metadata resource, append it to the list of metadata
- * resources in the WIMStruct. Otherwise, do nothing.
- */
-static int append_metadata_resource_entry(struct wim_lookup_table_entry *lte,
- void *wim_p)
-{
- WIMStruct *w = wim_p;
- int ret = 0;
-
- if (lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
- if (w->current_image == w->hdr.image_count) {
- ERROR("The WIM header says there are %u images in the WIM,\n"
- " but we found more metadata resources than this",
- w->hdr.image_count);
- ret = WIMLIB_ERR_IMAGE_COUNT;
- } else {
- DEBUG("Found metadata resource for image %u at "
- "offset %"PRIu64".",
- w->current_image + 1,
- lte->resource_entry.offset);
- w->image_metadata[
- w->current_image++].metadata_lte = lte;
- }
- }
- return ret;
-}
-
-/* Returns the compression type given in the flags of a WIM header. */
-static int wim_hdr_flags_compression_type(int wim_hdr_flags)
-{
- if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESSION) {
- if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_LZX)
- return WIMLIB_COMPRESSION_TYPE_LZX;
- else if (wim_hdr_flags & WIM_HDR_FLAG_COMPRESS_XPRESS)
- return WIMLIB_COMPRESSION_TYPE_XPRESS;
- else
- return WIMLIB_COMPRESSION_TYPE_INVALID;
- } else {
- return WIMLIB_COMPRESSION_TYPE_NONE;
- }
-}
-
-/*
- * Creates a WIMStruct for a new WIM file.
- */
-WIMLIBAPI int wimlib_create_new_wim(int ctype, WIMStruct **w_ret)
-{
- WIMStruct *w;
+ WIMStruct *wim;
struct wim_lookup_table *table;
int ret;
- DEBUG("Creating new WIM with %s compression.",
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+
+ DEBUG("Creating new WIM with %"TS" compression.",
wimlib_get_compression_type_string(ctype));
/* Allocate the WIMStruct. */
- w = new_wim_struct();
- if (!w)
+ wim = new_wim_struct();
+ if (wim == NULL)
return WIMLIB_ERR_NOMEM;
- ret = init_header(&w->hdr, ctype);
- if (ret != 0)
+ ret = init_wim_header(&wim->hdr, ctype, wim_default_chunk_size(ctype));
+ if (ret)
goto out_free;
table = new_lookup_table(9001);
- if (!table) {
+ if (table == NULL) {
ret = WIMLIB_ERR_NOMEM;
goto out_free;
}
- w->lookup_table = table;
- *w_ret = w;
+ wim->lookup_table = table;
+ wim->refcnts_ok = 1;
+ wim->compression_type = ctype;
+ wim->out_compression_type = ctype;
+ wim->chunk_size = wim->hdr.chunk_size;
+ wim->out_chunk_size = wim->hdr.chunk_size;
+ *wim_ret = wim;
return 0;
out_free:
- FREE(w);
+ FREE(wim);
return ret;
}
-WIMLIBAPI int wimlib_get_num_images(const WIMStruct *w)
+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)
{
- return w->hdr.image_count;
+ 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;
}
-int select_wim_image(WIMStruct *w, int image)
+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 image.
+ *
+ * @wim
+ * The WIMStruct for the WIM.
+ * @image
+ * The 1-based index of the image in the WIM to select.
+ *
+ * On success, 0 will be returned, wim->current_image will be set to
+ * @image, and wim_get_current_image_metadata() can be used to retrieve
+ * metadata information for the image.
+ *
+ * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
+ * or another error code will be returned.
+ */
+int
+select_wim_image(WIMStruct *wim, int image)
{
struct wim_image_metadata *imd;
int ret;
return WIMLIB_ERR_INVALID_IMAGE;
}
- if (image == w->current_image)
+ if (image == wim->current_image)
return 0;
- if (image < 1 || image > w->hdr.image_count) {
+ if (image < 1 || image > wim->hdr.image_count) {
ERROR("Cannot select image %d: There are only %u images",
- image, w->hdr.image_count);
+ image, wim->hdr.image_count);
return WIMLIB_ERR_INVALID_IMAGE;
}
- /* If a valid image is currently selected, it can be freed if it is not
- * modified. */
- if (w->current_image != WIMLIB_NO_IMAGE) {
- imd = wim_get_current_image_metadata(w);
+ if (!wim_has_metadata(wim)) {
+ ERROR("\"%"TS"\" does not contain metadata resources!", wim->filename);
+ if (wim->hdr.part_number != 1)
+ ERROR("Specify the first part of the split WIM instead.");
+ return WIMLIB_ERR_METADATA_NOT_FOUND;
+ }
+
+ /* 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) {
- DEBUG("Freeing image %u", w->current_image);
- destroy_image_metadata(imd, NULL);
- imd->root_dentry = NULL;
- imd->security_data = NULL;
- INIT_HLIST_HEAD(&imd->inode_list);
+ wimlib_assert(list_empty(&imd->unhashed_streams));
+ DEBUG("Freeing image %u", wim->current_image);
+ destroy_image_metadata(imd, NULL, false);
}
}
- w->current_image = image;
- imd = &w->image_metadata[image - 1];
- if (imd->root_dentry) {
+ wim->current_image = image;
+ imd = wim_get_current_image_metadata(wim);
+ 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, stdout);
- #endif
- ret = read_metadata_resource(w, imd);
+ ret = read_metadata_resource(wim, imd);
if (ret)
- w->current_image = WIMLIB_NO_IMAGE;
+ wim->current_image = WIMLIB_NO_IMAGE;
}
return ret;
}
-/* Returns the compression type of the WIM file. */
-WIMLIBAPI int wimlib_get_compression_type(const WIMStruct *w)
-{
- return wim_hdr_flags_compression_type(w->hdr.flags);
-}
-
-WIMLIBAPI const char *wimlib_get_compression_type_string(int ctype)
+/* API function documented in wimlib.h */
+WIMLIBAPI const tchar *
+wimlib_get_compression_type_string(int ctype)
{
switch (ctype) {
case WIMLIB_COMPRESSION_TYPE_NONE:
- return "None";
+ return T("None");
case WIMLIB_COMPRESSION_TYPE_LZX:
- return "LZX";
+ return T("LZX");
case WIMLIB_COMPRESSION_TYPE_XPRESS:
- return "XPRESS";
+ return T("XPRESS");
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ return T("LZMS");
default:
- return "Invalid";
+ return T("Invalid");
}
}
-/*
- * Returns the number of an image in the WIM file, given a string that is either
- * the number of the image, or the name of the image. The images are numbered
- * starting at 1.
- */
-WIMLIBAPI int wimlib_resolve_image(WIMStruct *w, const char *image_name_or_num)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_resolve_image(WIMStruct *wim, const tchar *image_name_or_num)
{
- char *p;
- int image;
+ tchar *p;
+ long image;
int i;
if (!image_name_or_num || !*image_name_or_num)
return WIMLIB_NO_IMAGE;
- if (strcmp(image_name_or_num, "all") == 0
- || strcmp(image_name_or_num, "*") == 0)
+ if (!tstrcasecmp(image_name_or_num, T("all"))
+ || !tstrcasecmp(image_name_or_num, T("*")))
return WIMLIB_ALL_IMAGES;
- image = strtol(image_name_or_num, &p, 10);
- if (p != image_name_or_num && *p == '\0' && image > 0) {
- if (image > w->hdr.image_count)
+ image = tstrtol(image_name_or_num, &p, 10);
+ if (p != image_name_or_num && *p == T('\0') && image > 0) {
+ if (image > wim->hdr.image_count)
return WIMLIB_NO_IMAGE;
return image;
} else {
- for (i = 1; i <= w->hdr.image_count; i++) {
- if (strcmp(image_name_or_num,
- wimlib_get_image_name(w, i)) == 0)
+ for (i = 1; i <= wim->hdr.image_count; i++) {
+ if (!tstrcmp(image_name_or_num,
+ wimlib_get_image_name(wim, i)))
return i;
}
return WIMLIB_NO_IMAGE;
}
}
-
-/* Prints some basic information about a WIM file. */
-WIMLIBAPI void wimlib_print_wim_information(const WIMStruct *w)
-{
- const struct wim_header *hdr;
-
- hdr = &w->hdr;
- puts("WIM Information:");
- puts("----------------");
- printf("Path: %s\n", w->filename);
- fputs ("GUID: 0x", stdout);
- print_byte_field(hdr->guid, WIM_GID_LEN);
- putchar('\n');
- printf("Image Count: %d\n", hdr->image_count);
- printf("Compression: %s\n", wimlib_get_compression_type_string(
- wimlib_get_compression_type(w)));
- printf("Part Number: %d/%d\n", hdr->part_number, hdr->total_parts);
- printf("Boot Index: %d\n", hdr->boot_idx);
- printf("Size: %"PRIu64" bytes\n",
- wim_info_get_total_bytes(w->wim_info));
- printf("Integrity Info: %s\n", (w->hdr.integrity.offset != 0) ? "yes" : "no");
- putchar('\n');
-}
-
-WIMLIBAPI bool wimlib_has_integrity_table(const WIMStruct *w)
-{
- return w->hdr.integrity.size != 0;
-}
-
-WIMLIBAPI void wimlib_print_available_images(const WIMStruct *w, int image)
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_print_available_images(const WIMStruct *wim, int image)
{
int first;
int last;
int i;
int n;
if (image == WIMLIB_ALL_IMAGES) {
- n = printf("Available Images:\n");
+ n = tprintf(T("Available Images:\n"));
first = 1;
- last = w->hdr.image_count;
- } else if (image >= 1 && image <= w->hdr.image_count) {
- n = printf("Information for Image %d\n", image);
+ last = wim->hdr.image_count;
+ } else if (image >= 1 && image <= wim->hdr.image_count) {
+ n = tprintf(T("Information for Image %d\n"), image);
first = image;
last = image;
} else {
- printf("wimlib_print_available_images(): Invalid image %d",
- image);
+ tprintf(T("wimlib_print_available_images(): Invalid image %d"),
+ image);
return;
}
for (i = 0; i < n - 1; i++)
- putchar('-');
- putchar('\n');
+ tputchar(T('-'));
+ tputchar(T('\n'));
for (i = first; i <= last; i++)
- print_image_info(w->wim_info, i);
+ print_image_info(wim->wim_info, i);
}
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info)
+{
+ memset(info, 0, sizeof(struct wimlib_wim_info));
+ memcpy(info->guid, wim->hdr.guid, WIMLIB_GUID_LEN);
+ info->image_count = wim->hdr.image_count;
+ info->boot_index = wim->hdr.boot_idx;
+ info->wim_version = wim->hdr.wim_version;
+ info->chunk_size = wim->chunk_size;
+ info->part_number = wim->hdr.part_number;
+ info->total_parts = wim->hdr.total_parts;
+ info->compression_type = wim->compression_type;
+ info->total_bytes = wim_info_get_total_bytes(wim->wim_info);
+ info->has_integrity_table = wim_has_integrity_table(wim);
+ info->opened_from_file = (wim->filename != NULL);
+ info->is_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) ||
+ (wim->hdr.total_parts != 1) ||
+ (wim->filename && taccess(wim->filename, W_OK));
+ info->has_rpfix = (wim->hdr.flags & WIM_HDR_FLAG_RP_FIX) != 0;
+ info->is_marked_readonly = (wim->hdr.flags & WIM_HDR_FLAG_READONLY) != 0;
+ info->write_in_progress = (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) != 0;
+ info->metadata_only = (wim->hdr.flags & WIM_HDR_FLAG_METADATA_ONLY) != 0;
+ info->resource_only = (wim->hdr.flags & WIM_HDR_FLAG_RESOURCE_ONLY) != 0;
+ info->spanned = (wim->hdr.flags & WIM_HDR_FLAG_SPANNED) != 0;
+ info->pipable = wim_is_pipable(wim);
+ return 0;
+}
-/* Prints the metadata for the specified image, which may be WIMLIB_ALL_IMAGES, but
- * not WIMLIB_NO_IMAGE. */
-WIMLIBAPI int wimlib_print_metadata(WIMStruct *w, int image)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
{
- if (w->hdr.part_number != 1) {
- ERROR("Cannot show the metadata from part %hu of a %hu-part split WIM!",
- w->hdr.part_number, w->hdr.total_parts);
- ERROR("Select the first part of the split WIM to see the metadata.");
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
+ 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;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
+ }
+
+ if ((which & ~WIMLIB_CHANGE_READONLY_FLAG) == 0)
+ return 0;
+
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+
+ 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) {
+ ERROR("%u is not 0 or a valid image in the WIM to mark as bootable",
+ info->boot_index);
+ return WIMLIB_ERR_INVALID_IMAGE;
+ }
+ wim->hdr.boot_idx = info->boot_index;
+ }
+
+ if (which & WIMLIB_CHANGE_RPFIX_FLAG) {
+ if (info->has_rpfix)
+ wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
+ else
+ wim->hdr.flags &= ~WIM_HDR_FLAG_RP_FIX;
}
- return for_image(w, image, image_print_metadata);
+ return 0;
}
-WIMLIBAPI int wimlib_print_files(WIMStruct *w, int image)
+static int
+set_out_ctype(int ctype, u8 *out_ctype_p)
{
- if (w->hdr.part_number != 1) {
- ERROR("Cannot list the files from part %hu of a %hu-part split WIM!",
- w->hdr.part_number, w->hdr.total_parts);
- ERROR("Select the first part of the split WIM if you'd like to list the files.");
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
+ switch (ctype) {
+ case WIMLIB_COMPRESSION_TYPE_NONE:
+ case WIMLIB_COMPRESSION_TYPE_LZX:
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
+ case WIMLIB_COMPRESSION_TYPE_LZMS:
+ *out_ctype_p = ctype;
+ return 0;
}
- return for_image(w, image, image_print_files);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
}
-/* Sets the index of the bootable image. */
-WIMLIBAPI int wimlib_set_boot_idx(WIMStruct *w, int boot_idx)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_compression_type(WIMStruct *wim, int ctype)
{
- if (w->hdr.total_parts != 1) {
- ERROR("Cannot modify the boot index of a split WIM!");
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
- }
- if (boot_idx < 0 || boot_idx > w->hdr.image_count)
- return WIMLIB_ERR_INVALID_IMAGE;
- w->hdr.boot_idx = boot_idx;
+ int ret = set_out_ctype(ctype, &wim->out_compression_type);
+ if (ret)
+ return ret;
- if (boot_idx == 0) {
- memset(&w->hdr.boot_metadata_res_entry, 0,
- sizeof(struct resource_entry));
- } else {
- memcpy(&w->hdr.boot_metadata_res_entry,
- &w->image_metadata[
- boot_idx - 1].metadata_lte->resource_entry,
- sizeof(struct resource_entry));
+ /* Reset the chunk size if it's no longer valid. */
+ if (!wim_chunk_size_valid(wim->out_chunk_size, ctype))
+ wim->out_chunk_size = wim_default_chunk_size(ctype);
+ return 0;
+}
+
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype)
+{
+ int ret = set_out_ctype(ctype, &wim->out_pack_compression_type);
+ if (ret)
+ return ret;
+
+ /* Reset the chunk size if it's no longer valid. */
+ if (!wim_chunk_size_valid(wim->out_pack_chunk_size, ctype))
+ wim->out_pack_chunk_size = wim_default_pack_chunk_size(ctype);
+ return 0;
+}
+
+static int
+set_out_chunk_size(u32 chunk_size, int ctype, u32 *out_chunk_size_p)
+{
+ if (!wim_chunk_size_valid(chunk_size, ctype)) {
+ ERROR("Invalid chunk size (%"PRIu32" bytes) "
+ "for compression type %"TS"!",
+ chunk_size,
+ wimlib_get_compression_type_string(ctype));
+ return WIMLIB_ERR_INVALID_CHUNK_SIZE;
}
+ *out_chunk_size_p = chunk_size;
return 0;
}
-WIMLIBAPI int wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size)
{
- if (total_parts_ret)
- *total_parts_ret = w->hdr.total_parts;
- return w->hdr.part_number;
+ if (chunk_size == 0) {
+ wim->out_chunk_size =
+ wim_default_chunk_size(wim->out_compression_type);
+ return 0;
+ }
+
+ return set_out_chunk_size(chunk_size,
+ wim->out_compression_type,
+ &wim->out_chunk_size);
}
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size)
+{
+ if (chunk_size == 0) {
+ wim->out_pack_chunk_size =
+ wim_default_pack_chunk_size(wim->out_pack_compression_type);
+ return 0;
+ }
+
+ return set_out_chunk_size(chunk_size,
+ wim->out_pack_compression_type,
+ &wim->out_pack_chunk_size);
+}
-WIMLIBAPI int wimlib_get_boot_idx(const WIMStruct *w)
+WIMLIBAPI void
+wimlib_register_progress_function(WIMStruct *wim,
+ wimlib_progress_func_t progfunc,
+ void *progctx)
{
- return w->hdr.boot_idx;
+ wim->progfunc = progfunc;
+ wim->progctx = progctx;
+}
+
+static int
+open_wim_file(const tchar *filename, struct filedes *fd_ret)
+{
+ int raw_fd;
+
+ raw_fd = topen(filename, O_RDONLY | O_BINARY);
+ if (raw_fd < 0) {
+ ERROR_WITH_ERRNO("Can't open \"%"TS"\" read-only", filename);
+ return WIMLIB_ERR_OPEN;
+ }
+ filedes_init(fd_ret, raw_fd);
+ return 0;
}
/*
* Begins the reading of a WIM file; opens the file and reads its header and
* lookup table, and optionally checks the integrity.
*/
-static int begin_read(WIMStruct *w, const char *in_wim_path, int open_flags,
- wimlib_progress_func_t progress_func)
+static int
+begin_read(WIMStruct *wim, const void *wim_filename_or_fd, int open_flags)
{
int ret;
int xml_num_images;
+ const tchar *wimfile;
- DEBUG("Reading the WIM file `%s'", in_wim_path);
+ if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
+ wimfile = NULL;
+ filedes_init(&wim->in_fd, *(const int*)wim_filename_or_fd);
+ wim->in_fd.is_pipe = 1;
+ } else {
+ wimfile = wim_filename_or_fd;
+ ret = open_wim_file(wimfile, &wim->in_fd);
+ if (ret)
+ return ret;
- w->fp = fopen(in_wim_path, "rb");
- if (!w->fp) {
- ERROR_WITH_ERRNO("Failed to open `%s' for reading",
- in_wim_path);
- return WIMLIB_ERR_OPEN;
+ /* The absolute path to the WIM is requested so that
+ * wimlib_overwrite() still works even if the process changes
+ * its working directory. This actually happens if a WIM is
+ * mounted read-write, since the FUSE thread changes directory
+ * to "/", and it needs to be able to find the WIM file again.
+ *
+ * This will break if the full path to the WIM changes in the
+ * intervening time...
+ *
+ * Warning: in Windows native builds, realpath() calls the
+ * replacement function in win32_replacements.c.
+ */
+ wim->filename = realpath(wimfile, NULL);
+ if (wim->filename == NULL) {
+ ERROR_WITH_ERRNO("Failed to resolve WIM filename");
+ if (errno == ENOMEM)
+ return WIMLIB_ERR_NOMEM;
+ else
+ return WIMLIB_ERR_OPEN;
+ }
}
- /* The absolute path to the WIM is requested so that wimlib_overwrite()
- * still works even if the process changes its working directory. This
- * actually happens if a WIM is mounted read-write, since the FUSE
- * thread changes directory to "/", and it needs to be able to find the
- * WIM file again.
- *
- * This will break if the full path to the WIM changes in the
- * intervening time...
- */
- w->filename = realpath(in_wim_path, NULL);
- if (!w->filename) {
- ERROR_WITH_ERRNO("Failed to resolve WIM filename");
- if (errno == ENOMEM)
- return WIMLIB_ERR_NOMEM;
- else
- return WIMLIB_ERR_OPEN;
+ ret = read_wim_header(wim, &wim->hdr);
+ if (ret)
+ return ret;
+
+ if (wim->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
+ WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS flag is set in the header of\n"
+ " \"%"TS"\". It may be being changed by another process,\n"
+ " or a process may have crashed while writing the WIM.",
+ wimfile);
}
- ret = read_header(w->fp, &w->hdr, open_flags);
- if (ret != 0)
- return ret;
+ if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+ }
- DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
+ if ((open_flags & WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT) &&
+ (wim->hdr.total_parts != 1))
+ return WIMLIB_ERR_IS_SPLIT_WIM;
+
+ DEBUG("According to header, WIM contains %u images", wim->hdr.image_count);
/* If the boot index is invalid, print a warning and set it to 0 */
- if (w->hdr.boot_idx > w->hdr.image_count) {
- WARNING("In `%s', image %u is marked as bootable, "
+ if (wim->hdr.boot_idx > wim->hdr.image_count) {
+ WARNING("In `%"TS"', image %u is marked as bootable, "
"but there are only %u images in the WIM",
- in_wim_path, w->hdr.boot_idx, w->hdr.image_count);
- w->hdr.boot_idx = 0;
+ wimfile, wim->hdr.boot_idx, wim->hdr.image_count);
+ wim->hdr.boot_idx = 0;
}
- if (wimlib_get_compression_type(w) == WIMLIB_COMPRESSION_TYPE_INVALID) {
- ERROR("Invalid compression type (WIM header flags = 0x%x)",
- w->hdr.flags);
- return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ /* Check and cache the compression type */
+ 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 |
+ 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;
+ } else {
+ ERROR("The compression flag is set on \"%"TS"\", but "
+ "a flag for a recognized format is not",
+ wimfile);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ } else {
+ wim->compression_type = WIMLIB_COMPRESSION_TYPE_NONE;
+ }
+ wim->out_compression_type = wim->compression_type;
+
+ /* Check and cache the chunk size. */
+ wim->chunk_size = wim->hdr.chunk_size;
+ wim->out_chunk_size = wim->chunk_size;
+ if (!wim_chunk_size_valid(wim->chunk_size, wim->compression_type)) {
+ ERROR("Invalid chunk size (%"PRIu32" bytes) "
+ "for compression type %"TS"!",
+ wim->chunk_size,
+ wimlib_get_compression_type_string(wim->compression_type));
+ return WIMLIB_ERR_INVALID_CHUNK_SIZE;
}
if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
- ret = check_wim_integrity(w, progress_func);
+ ret = check_wim_integrity(wim);
if (ret == WIM_INTEGRITY_NONEXISTENT) {
- WARNING("No integrity information for `%s'; skipping "
- "integrity check.", in_wim_path);
+ WARNING("No integrity information for `%"TS"'; skipping "
+ "integrity check.", wimfile);
} else if (ret == WIM_INTEGRITY_NOT_OK) {
ERROR("WIM is not intact! (Failed integrity check)");
return WIMLIB_ERR_INTEGRITY;
}
}
- ret = read_lookup_table(w);
- if (ret != 0)
- return ret;
-
- if (w->hdr.image_count != 0) {
- w->image_metadata = CALLOC(w->hdr.image_count,
- sizeof(struct wim_image_metadata));
-
- if (!w->image_metadata) {
- ERROR("Failed to allocate memory for %u image metadata structures",
- w->hdr.image_count);
+ if (wim->hdr.image_count != 0 && wim->hdr.part_number == 1) {
+ wim->image_metadata = new_image_metadata_array(wim->hdr.image_count);
+ if (wim->image_metadata == NULL)
return WIMLIB_ERR_NOMEM;
- }
}
- w->current_image = 0;
- DEBUG("Looking for metadata resources in the lookup table.");
+ if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE) {
+ wim->lookup_table = new_lookup_table(9001);
+ if (wim->lookup_table == NULL)
+ return WIMLIB_ERR_NOMEM;
+ } else {
- /* Find the images in the WIM by searching the lookup table. */
- ret = for_lookup_table_entry(w->lookup_table,
- append_metadata_resource_entry, w);
+ ret = read_wim_xml_data(wim);
+ if (ret)
+ return ret;
- if (ret != 0)
- return ret;
+ xml_num_images = wim_info_get_num_images(wim->wim_info);
+ if (xml_num_images != wim->hdr.image_count) {
+ ERROR("In the file `%"TS"', there are %u <IMAGE> elements "
+ "in the XML data,", wimfile, xml_num_images);
+ ERROR("but %u images in the WIM! There must be exactly one "
+ "<IMAGE> element per image.", wim->hdr.image_count);
+ return WIMLIB_ERR_IMAGE_COUNT;
+ }
- /* Make sure all the expected images were found. (We already have
- * returned WIMLIB_ERR_IMAGE_COUNT if *extra* images were found) */
- if (w->current_image != w->hdr.image_count &&
- w->hdr.part_number == 1)
- {
- ERROR("Only found %d images in WIM, but expected %u",
- w->current_image, w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
+ ret = read_wim_lookup_table(wim);
+ if (ret)
+ return ret;
+
+ DEBUG("Done beginning read of WIM file `%"TS"'.", wimfile);
}
+ return 0;
+}
- /* Sort images by the position of their metadata resources. I'm
- * assuming that is what determines the other of the images in the WIM
- * file, rather than their order in the lookup table, which is random
- * because of hashing. */
- qsort(w->image_metadata, w->current_image,
- sizeof(struct wim_image_metadata), sort_image_metadata_by_position);
+int
+open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
+ WIMStruct **wim_ret,
+ wimlib_progress_func_t progfunc, void *progctx)
+{
+ WIMStruct *wim;
+ int ret;
- w->current_image = WIMLIB_NO_IMAGE;
+ if (open_flags & WIMLIB_OPEN_FLAG_FROM_PIPE)
+ DEBUG("Opening pipable WIM from file descriptor %d.", *(const int*)wim_filename_or_fd);
+ else
+ DEBUG("Opening WIM file \"%"TS"\"", (const tchar*)wim_filename_or_fd);
- /* Read the XML data. */
- ret = read_xml_data(w->fp, &w->hdr.xml_res_entry,
- &w->xml_data, &w->wim_info);
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
- if (ret != 0)
- return ret;
+ if (wim_ret == NULL)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ wim = new_wim_struct();
+ if (wim == NULL)
+ return WIMLIB_ERR_NOMEM;
+
+ wim->progfunc = progfunc;
+ wim->progctx = progctx;
- xml_num_images = wim_info_get_num_images(w->wim_info);
- if (xml_num_images != w->hdr.image_count) {
- ERROR("In the file `%s', there are %u <IMAGE> elements "
- "in the XML data,", in_wim_path, xml_num_images);
- ERROR("but %u images in the WIM! There must be exactly one "
- "<IMAGE> element per image.", w->hdr.image_count);
- return WIMLIB_ERR_IMAGE_COUNT;
+ ret = begin_read(wim, wim_filename_or_fd, open_flags);
+ if (ret) {
+ wimlib_free(wim);
+ return ret;
}
- DEBUG("Done beginning read of WIM file `%s'.", in_wim_path);
+ DEBUG("Successfully opened WIM and created WIMStruct.");
+ *wim_ret = wim;
return 0;
}
-
-/*
- * Opens a WIM file and creates a WIMStruct for it.
- */
-WIMLIBAPI int wimlib_open_wim(const char *wim_file, int open_flags,
- WIMStruct **w_ret,
- wimlib_progress_func_t progress_func)
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_open_wim_with_progress(const tchar *wimfile, int open_flags,
+ WIMStruct **wim_ret,
+ wimlib_progress_func_t progfunc, void *progctx)
{
- WIMStruct *w;
- int ret;
-
- if (!wim_file || !w_ret)
+ if (open_flags & ~(WIMLIB_OPEN_FLAG_CHECK_INTEGRITY |
+ WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT |
+ WIMLIB_OPEN_FLAG_WRITE_ACCESS))
return WIMLIB_ERR_INVALID_PARAM;
- w = new_wim_struct();
- if (!w)
- return WIMLIB_ERR_NOMEM;
+ return open_wim_as_WIMStruct(wimfile, open_flags, wim_ret,
+ progfunc, progctx);
+}
- ret = begin_read(w, wim_file, open_flags, progress_func);
- if (ret == 0)
- *w_ret = w;
- else
- wimlib_free(w);
- return ret;
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_open_wim(const tchar *wimfile, int open_flags, WIMStruct **wim_ret)
+{
+ return wimlib_open_wim_with_progress(wimfile, open_flags, wim_ret,
+ NULL, NULL);
}
-void destroy_image_metadata(struct wim_image_metadata *imd,
- struct wim_lookup_table *table)
+/* Checksum all streams that are unhashed (other than the metadata streams),
+ * merging them into the lookup table as needed. This is a no-op unless the
+ * library has previously used to add or mount an image using the same
+ * WIMStruct. */
+int
+wim_checksum_unhashed_streams(WIMStruct *wim)
{
- free_dentry_tree(imd->root_dentry, table);
- free_security_data(imd->security_data);
+ int ret;
- /* Get rid of the lookup table entry for this image's metadata resource
- * */
- if (table) {
- lookup_table_unlink(table, imd->metadata_lte);
- free_lookup_table_entry(imd->metadata_lte);
+ if (!wim_has_metadata(wim))
+ return 0;
+ for (int i = 0; i < wim->hdr.image_count; i++) {
+ struct wim_lookup_table_entry *lte, *tmp;
+ struct wim_image_metadata *imd = wim->image_metadata[i];
+ image_for_each_unhashed_stream_safe(lte, tmp, imd) {
+ struct wim_lookup_table_entry *new_lte;
+ ret = hash_unhashed_stream(lte, wim->lookup_table, &new_lte);
+ if (ret)
+ return ret;
+ if (new_lte != lte)
+ free_lookup_table_entry(lte);
+ }
}
+ return 0;
}
-/* Frees the memory for the WIMStruct, including all internal memory; also
- * closes all files associated with the WIMStruct. */
-WIMLIBAPI void wimlib_free(WIMStruct *w)
+/*
+ * can_modify_wim - Check if a given WIM is writeable. This is only the case if
+ * it meets the following three conditions:
+ *
+ * 1. Write access is allowed to the underlying file (if any) at the filesystem level.
+ * 2. The WIM is not part of a spanned set.
+ * 3. The WIM_HDR_FLAG_READONLY flag is not set in the WIM header.
+ *
+ * Return value is 0 if writable; WIMLIB_ERR_WIM_IS_READONLY otherwise.
+ */
+int
+can_modify_wim(WIMStruct *wim)
{
- DEBUG("Freeing WIMStruct");
+ if (wim->filename) {
+ if (taccess(wim->filename, W_OK)) {
+ ERROR_WITH_ERRNO("Can't modify \"%"TS"\"", wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ }
+ if (wim->hdr.total_parts != 1) {
+ ERROR("Cannot modify \"%"TS"\": is part of a split WIM",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ if (wim->hdr.flags & WIM_HDR_FLAG_READONLY) {
+ ERROR("Cannot modify \"%"TS"\": is marked read-only",
+ wim->filename);
+ return WIMLIB_ERR_WIM_IS_READONLY;
+ }
+ return 0;
+}
- if (!w)
+/*
+ * can_delete_from_wim - Check if files or images can be deleted from a given
+ * WIM file.
+ *
+ * This theoretically should be exactly the same as can_modify_wim(), but
+ * unfortunately, due to bugs in Microsoft's software that generate incorrect
+ * reference counts for some WIM resources, we need to run expensive
+ * verifications to make sure the reference counts are correct on all WIM
+ * resources. Otherwise we might delete a WIM resource whose reference count
+ * has fallen to 0, but is actually still referenced somewhere.
+ */
+int
+can_delete_from_wim(WIMStruct *wim)
+{
+ int ret;
+
+ ret = can_modify_wim(wim);
+ if (ret)
+ return ret;
+ if (!wim->refcnts_ok) {
+ ret = wim_recalculate_refcnts(wim);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_free(WIMStruct *wim)
+{
+ if (wim == NULL)
return;
- if (w->fp)
- fclose(w->fp);
- if (w->out_fp)
- fclose(w->out_fp);
-
-#ifdef WITH_FUSE
- if (w->fp_tab) {
- for (size_t i = 0; i < w->num_allocated_fps; i++)
- if (w->fp_tab[i])
- fclose(w->fp_tab[i]);
- FREE(w->fp_tab);
- }
- pthread_mutex_destroy(&w->fp_tab_mutex);
-#endif
- free_lookup_table(w->lookup_table);
+ DEBUG("Freeing WIMStruct (filename=\"%"TS"\", image_count=%u)",
+ wim->filename, wim->hdr.image_count);
- FREE(w->filename);
- FREE(w->xml_data);
- free_wim_info(w->wim_info);
- if (w->image_metadata) {
- for (unsigned i = 0; i < w->hdr.image_count; i++)
- destroy_image_metadata(&w->image_metadata[i], NULL);
- FREE(w->image_metadata);
+ while (!list_empty(&wim->subwims)) {
+ WIMStruct *subwim;
+
+ subwim = list_entry(wim->subwims.next, WIMStruct, subwim_node);
+ list_del(&subwim->subwim_node);
+ DEBUG("Freeing subwim.");
+ wimlib_free(subwim);
}
-#ifdef WITH_NTFS_3G
- if (w->ntfs_vol) {
- DEBUG("Unmounting NTFS volume");
- ntfs_umount(w->ntfs_vol, FALSE);
+
+ if (filedes_valid(&wim->in_fd))
+ filedes_close(&wim->in_fd);
+ if (filedes_valid(&wim->out_fd))
+ filedes_close(&wim->out_fd);
+
+ free_lookup_table(wim->lookup_table);
+
+ wimlib_free_decompressor(wim->decompressor);
+
+ FREE(wim->filename);
+ free_wim_info(wim->wim_info);
+ if (wim->image_metadata) {
+ for (unsigned i = 0; i < wim->hdr.image_count; i++)
+ put_image_metadata(wim->image_metadata[i], NULL);
+ FREE(wim->image_metadata);
}
+ FREE(wim);
+}
+
+static bool
+test_locale_ctype_utf8(void)
+{
+#ifdef __WIN32__
+ return false;
+#else
+ char *ctype = nl_langinfo(CODESET);
+
+ return (!strstr(ctype, "UTF-8") ||
+ !strstr(ctype, "UTF8") ||
+ !strstr(ctype, "utf8") ||
+ !strstr(ctype, "utf-8"));
#endif
- FREE(w);
- DEBUG("Freed WIMStruct");
}
-/* Get global memory allocations out of the way. Not strictly necessary in
- * single-threaded programs like 'imagex'. */
-WIMLIBAPI int wimlib_global_init()
+/* API function documented in wimlib.h */
+WIMLIBAPI u32
+wimlib_get_version(void)
+{
+ return WIMLIB_VERSION_CODE;
+}
+
+static bool lib_initialized = false;
+
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_global_init(int init_flags)
{
+ if (lib_initialized)
+ 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();
- return iconv_global_init();
+ if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
+ wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
+ #ifdef WITH_NTFS_3G
+ if (!wimlib_mbs_is_utf8)
+ libntfs3g_global_init();
+ #endif
+ }
+#ifdef __WIN32__
+ {
+ int ret = win32_global_init(init_flags);
+ if (ret)
+ return ret;
+ }
+#endif
+ iconv_global_init();
+ init_upcase();
+ if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE)
+ default_ignore_case = false;
+ else if (init_flags & WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE)
+ default_ignore_case = true;
+ lib_initialized = true;
+ return 0;
}
-/* Free global memory allocations. Not strictly necessary if the process using
- * wimlib is just about to exit (as is the case for 'imagex'). */
-WIMLIBAPI void wimlib_global_cleanup()
+/* API function documented in wimlib.h */
+WIMLIBAPI void
+wimlib_global_cleanup(void)
{
+ if (!lib_initialized)
+ return;
libxml_global_cleanup();
iconv_global_cleanup();
+#ifdef __WIN32__
+ win32_global_cleanup();
+#endif
+ cleanup_decompressor_params();
+ cleanup_compressor_params();
+ lib_initialized = false;
}
git://wimlib.net / wimlib / blobdiff