return 0;
}
-/* 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.
*/
struct wim_lookup_table *table;
int ret;
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
+
DEBUG("Creating new WIM with %"TS" compression.",
wimlib_get_compression_type_string(ctype));
goto out_free;
}
w->lookup_table = table;
+ w->refcnts_ok = 1;
+ w->compression_type = ctype;
*w_ret = w;
return 0;
out_free:
return ret;
}
-WIMLIBAPI int
-wimlib_get_num_images(const WIMStruct *w)
-{
- return w->hdr.image_count;
-}
-
int
select_wim_image(WIMStruct *w, int image)
{
}
-/* 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 tchar *
wimlib_get_compression_type_string(int ctype)
{
/* Prints some basic information about a WIM file. */
WIMLIBAPI void
-wimlib_print_wim_information(const WIMStruct *w)
+wimlib_print_wim_information(const WIMStruct *wim)
{
- const struct wim_header *hdr;
+ struct wimlib_wim_info info;
+
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
- hdr = &w->hdr;
tputs(T("WIM Information:"));
tputs(T("----------------"));
- tprintf(T("Path: %"TS"\n"), w->filename);
+ tprintf(T("Path: %"TS"\n"), wim->filename);
tfputs(T("GUID: 0x"), stdout);
- print_byte_field(hdr->guid, WIM_GID_LEN, stdout);
+ print_byte_field(info.guid, WIM_GID_LEN, stdout);
tputchar(T('\n'));
- tprintf(T("Image Count: %d\n"), hdr->image_count);
+ tprintf(T("Image Count: %d\n"), info.image_count);
tprintf(T("Compression: %"TS"\n"),
- wimlib_get_compression_type_string(wimlib_get_compression_type(w)));
- tprintf(T("Part Number: %d/%d\n"), hdr->part_number, hdr->total_parts);
- tprintf(T("Boot Index: %d\n"), hdr->boot_idx);
- tprintf(T("Size: %"PRIu64" bytes\n"),
- wim_info_get_total_bytes(w->wim_info));
+ wimlib_get_compression_type_string(info.compression_type));
+ tprintf(T("Part Number: %d/%d\n"), info.part_number, info.total_parts);
+ tprintf(T("Boot Index: %d\n"), info.boot_index);
+ tprintf(T("Size: %"PRIu64" bytes\n"), info.total_bytes);
tprintf(T("Integrity Info: %"TS"\n"),
- (w->hdr.integrity.offset != 0) ? T("yes") : T("no"));
+ info.has_integrity_table ? T("yes") : T("no"));
tprintf(T("Relative path junction: %"TS"\n"),
- (hdr->flags & WIM_HDR_FLAG_RP_FIX) ? T("yes") : T("no"));
+ info.has_rpfix ? T("yes") : T("no"));
tputchar(T('\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)
{
return for_image(w, image, image_print_files);
}
-/* Sets the index of the bootable image. */
WIMLIBAPI int
-wimlib_set_boot_idx(WIMStruct *wim, int boot_idx)
+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_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;
+ if (wim->wim_info)
+ info->total_bytes = wim->wim_info->total_bytes;
+ else
+ info->total_bytes = 0;
+ info->has_integrity_table = wim->hdr.integrity.offset != 0;
+ 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;
+ return 0;
+}
+
+
+/* Deprecated */
+WIMLIBAPI int
+wimlib_get_boot_idx(const WIMStruct *wim)
{
- int ret;
+ struct wimlib_wim_info info;
- ret = can_modify_wim(wim);
- if (ret)
- return ret;
- if (boot_idx < 0 || boot_idx > wim->hdr.image_count)
- return WIMLIB_ERR_INVALID_IMAGE;
- wim->hdr.boot_idx = boot_idx;
- return 0;
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
+ return info.boot_index;
}
+/* Deprecated */
WIMLIBAPI int
-wimlib_get_part_number(const WIMStruct *w, int *total_parts_ret)
+wimlib_get_compression_type(const WIMStruct *wim)
{
+ struct wimlib_wim_info info;
+
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
+ return info.compression_type;
+}
+
+/* Deprecated */
+WIMLIBAPI int
+wimlib_get_num_images(const WIMStruct *wim)
+{
+ struct wimlib_wim_info info;
+
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
+ return info.image_count;
+}
+
+/* Deprecated */
+WIMLIBAPI int
+wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret)
+{
+ struct wimlib_wim_info info;
+
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
if (total_parts_ret)
- *total_parts_ret = w->hdr.total_parts;
- return w->hdr.part_number;
+ *total_parts_ret = info.total_parts;
+ return info.part_number;
}
+/* Deprecated */
+WIMLIBAPI bool
+wimlib_has_integrity_table(const WIMStruct *wim)
+{
+ struct wimlib_wim_info info;
+
+ wimlib_get_wim_info((WIMStruct*)wim, &info);
+ return info.has_integrity_table;
+}
WIMLIBAPI int
-wimlib_get_boot_idx(const WIMStruct *w)
+wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info, int which)
{
- return w->hdr.boot_idx;
+ int ret;
+
+ 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_GID_LEN);
+
+ if (which & WIMLIB_CHANGE_BOOT_INDEX) {
+ if (info->boot_index < 0 || 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 0;
+}
+
+/* Deprecated */
+WIMLIBAPI int
+wimlib_set_boot_idx(WIMStruct *wim, int boot_idx)
+{
+ struct wimlib_wim_info info;
+
+ info.boot_index = boot_idx;
+ return wimlib_set_wim_info(wim, &info, WIMLIB_CHANGE_BOOT_INDEX);
}
static int
return WIMLIB_ERR_OPEN;
}
- ret = read_header(w->filename, w->in_fd, &w->hdr, open_flags);
+ ret = read_header(w->filename, w->in_fd, &w->hdr);
if (ret)
return ret;
+ if (w->hdr.flags & WIM_HDR_FLAG_WRITE_IN_PROGRESS) {
+ WARNING("The WIM_HDR_FLAG_WRITE_IN_PROGRESS is set in the header of \"%"TS"\".\n"
+ " It may be being changed by another process, or a process\n"
+ " may have crashed while writing the WIM.", in_wim_path);
+ }
+
+ if (open_flags & WIMLIB_OPEN_FLAG_WRITE_ACCESS) {
+ ret = can_modify_wim(w);
+ if (ret)
+ return ret;
+ }
+
+ if (w->hdr.total_parts != 1 && !(open_flags & WIMLIB_OPEN_FLAG_SPLIT_OK)) {
+ ERROR("\"%"TS"\": This WIM is part %u of a %u-part WIM",
+ in_wim_path, w->hdr.part_number, w->hdr.total_parts);
+ return WIMLIB_ERR_SPLIT_UNSUPPORTED;
+ }
+
DEBUG("According to header, WIM contains %u images", w->hdr.image_count);
/* If the boot index is invalid, print a warning and set it to 0 */
w->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 (w->hdr.flags & WIM_HDR_FLAG_COMPRESSION) {
+ if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_LZX) {
+ if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
+ ERROR("Multiple compression flags are set in \"%"TS"\"",
+ in_wim_path);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ w->compression_type = WIMLIB_COMPRESSION_TYPE_LZX;
+ } else if (w->hdr.flags & WIM_HDR_FLAG_COMPRESS_XPRESS) {
+ w->compression_type = WIMLIB_COMPRESSION_TYPE_XPRESS;
+ } else {
+ ERROR("The compression flag is set on \"%"TS"\", but "
+ "neither the XPRESS nor LZX flag is set",
+ in_wim_path);
+ return WIMLIB_ERR_INVALID_COMPRESSION_TYPE;
+ }
+ } else {
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_NONE != 0);
}
if (open_flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY) {
*/
WIMLIBAPI int
wimlib_open_wim(const tchar *wim_file, int open_flags,
- WIMStruct **w_ret,
+ WIMStruct **wim_ret,
wimlib_progress_func_t progress_func)
{
- WIMStruct *w;
+ WIMStruct *wim;
int ret;
- if (!wim_file || !w_ret)
- return WIMLIB_ERR_INVALID_PARAM;
+ wimlib_global_init(WIMLIB_INIT_FLAG_ASSUME_UTF8);
- w = new_wim_struct();
- if (!w)
- return WIMLIB_ERR_NOMEM;
+ ret = WIMLIB_ERR_INVALID_PARAM;
+ if (!wim_file || !wim_ret)
+ goto out;
- ret = begin_read(w, wim_file, open_flags, progress_func);
- if (ret == 0)
- *w_ret = w;
- else
- wimlib_free(w);
+ ret = WIMLIB_ERR_NOMEM;
+ wim = new_wim_struct();
+ if (!wim)
+ goto out;
+
+ ret = begin_read(wim, wim_file, open_flags, progress_func);
+ if (ret)
+ goto out_wimlib_free;
+
+ ret = 0;
+ *wim_ret = wim;
+ goto out;
+out_wimlib_free:
+ wimlib_free(wim);
+out:
return ret;
}
return 0;
}
+/*
+ * 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)
{
+ 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 spanned set",
wim->filename);
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
+ 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_MARKED_READONLY;
+ return WIMLIB_ERR_WIM_IS_READONLY;
}
return 0;
}
+/*
+ * 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 == 0 && !wim->all_images_verified)
- ret = wim_run_full_verifications(wim);
- return ret;
+ if (ret)
+ return ret;
+ if (!wim->refcnts_ok)
+ wim_recalculate_refcnts(wim);
+ return 0;
}
/* Frees the memory for the WIMStruct, including all internal memory; also
WIMLIBAPI int
wimlib_global_init(int init_flags)
{
+ static bool already_inited = false;
+
+ if (already_inited)
+ return 0;
libxml_global_init();
if (!(init_flags & WIMLIB_INIT_FLAG_ASSUME_UTF8)) {
wimlib_mbs_is_utf8 = test_locale_ctype_utf8();
#ifdef __WIN32__
win32_global_init();
#endif
+ already_inited = true;
return 0;
}
git://wimlib.net / wimlib / blobdiff