X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fxml.c;h=9b161c2838616f0d5261e18a0e69fd5eca345f82;hp=09f567e368a8933502354847ae8e5016ac3e4519;hb=fd17faf910041fb68e3e025c7f45712d05a23533;hpb=9b9a502863318d6208da2818b1d522346e5eee9e diff --git a/src/xml.c b/src/xml.c index 09f567e3..9b161c28 100644 --- a/src/xml.c +++ b/src/xml.c @@ -23,16 +23,18 @@ * along with wimlib; if not, see http://www.gnu.org/licenses/. */ -#include "wimlib_internal.h" #include "dentry.h" -#include "xml.h" -#include "timestamp.h" #include "lookup_table.h" +#include "timestamp.h" +#include "wimlib_internal.h" +#include "xml.h" + #include -#include #include #include #include +#include +#include /* Structures used to form an in-memory representation of the XML data (other * than the raw parse tree from libxml). */ @@ -55,29 +57,29 @@ struct windows_info { char *product_suite; char **languages; char *default_language; - u64 num_languages; + size_t num_languages; char *system_root; bool windows_version_exists; struct windows_version windows_version; }; struct image_info { - u64 index; - u64 dir_count; - u64 file_count; - u64 total_bytes; - u64 hard_link_bytes; - u64 creation_time; - u64 last_modification_time; - bool windows_info_exists; + int index; + bool windows_info_exists; + u64 dir_count; + u64 file_count; + u64 total_bytes; + u64 hard_link_bytes; + u64 creation_time; + u64 last_modification_time; struct windows_info windows_info; char *name; char *description; - char *display_name; - char *display_description; + char *display_name; + char *display_description; union { - char *flags; - struct lookup_table *lookup_table; + char *flags; + struct wim_lookup_table *lookup_table; }; }; @@ -117,11 +119,6 @@ static inline bool node_is_text(xmlNode *node) return node->type == XML_TEXT_NODE; } -static inline bool node_is_attribute(xmlNode *node) -{ - return node->type == XML_ATTRIBUTE_NODE; -} - static inline bool node_name_is(xmlNode *node, const char *name) { /* For now, both upper case and lower case element names are accepted. */ @@ -158,10 +155,8 @@ static int node_get_string(const xmlNode *string_node, char **str) for_node_child(string_node, child) { if (node_is_text(child) && child->content) { p = STRDUP(child->content); - if (!p) { - ERROR("Out of memory"); + if (!p) return WIMLIB_ERR_NOMEM; - } break; } } @@ -190,8 +185,8 @@ static u64 node_get_timestamp(const xmlNode *time_node) /* Used to sort an array of struct image_infos by their image indices. */ static int sort_by_index(const void *p1, const void *p2) { - u64 index_1 = ((struct image_info*)p1)->index; - u64 index_2 = ((struct image_info*)p1)->index; + int index_1 = ((const struct image_info*)p1)->index; + int index_2 = ((const struct image_info*)p2)->index; if (index_1 < index_2) return -1; else if (index_1 > index_2) @@ -204,15 +199,13 @@ static int sort_by_index(const void *p1, const void *p2) /* Frees memory allocated inside a struct windows_info structure. */ static void destroy_windows_info(struct windows_info *windows_info) { - uint i; - FREE(windows_info->product_name); FREE(windows_info->edition_id); FREE(windows_info->installation_type); FREE(windows_info->hal); FREE(windows_info->product_type); FREE(windows_info->product_suite); - for (i = 0; i < windows_info->num_languages; i++) + for (size_t i = 0; i < windows_info->num_languages; i++) FREE(windows_info->languages[i]); FREE(windows_info->languages); FREE(windows_info->default_language); @@ -233,10 +226,9 @@ static void destroy_image_info(struct image_info *image_info) void free_wim_info(struct wim_info *info) { - uint i; if (info) { if (info->images) { - for (i = 0; i < info->num_images; i++) + for (int i = 0; i < info->num_images; i++) destroy_image_info(&info->images[i]); FREE(info->images); } @@ -254,11 +246,11 @@ static void xml_read_windows_version(const xmlNode *version_node, if (!node_is_element(child)) continue; if (node_name_is(child, "MAJOR")) - windows_version->major = node_get_u64(child); + windows_version->major = node_get_u64(child); else if (node_name_is(child, "MINOR")) - windows_version->minor = node_get_u64(child); + windows_version->minor = node_get_u64(child); else if (node_name_is(child, "BUILD")) - windows_version->build = node_get_u64(child); + windows_version->build = node_get_u64(child); else if (node_name_is(child, "SPBUILD")) windows_version->sp_build = node_get_u64(child); else if (node_name_is(child, "SPLEVEL")) @@ -270,40 +262,35 @@ static void xml_read_windows_version(const xmlNode *version_node, * */ static int xml_read_languages(const xmlNode *languages_node, char ***languages_ret, - u64 *num_languages_ret, + size_t *num_languages_ret, char **default_language_ret) { xmlNode *child; - uint i; - uint num_languages; + size_t num_languages = 0; char **languages; int ret; - num_languages = 0; for_node_child(languages_node, child) if (node_is_element(child) && node_name_is(child, "LANGUAGE")) num_languages++; - languages = CALLOC(num_languages, sizeof(char*)); - if (!languages) { - ERROR("Out of memory"); + languages = CALLOC(num_languages, sizeof(languages[0])); + if (!languages) return WIMLIB_ERR_NOMEM; - } *languages_ret = languages; *num_languages_ret = num_languages; - i = 0; ret = 0; for_node_child(languages_node, child) { if (!node_is_element(child)) continue; if (node_name_is(child, "LANGUAGE")) - ret = node_get_string(child, &languages[i++]); + ret = node_get_string(child, languages++); else if (node_name_is(child, "DEFAULT")) ret = node_get_string(child, default_language_ret); if (ret != 0) - return ret; + break; } return ret; } @@ -349,7 +336,6 @@ static int xml_read_windows_info(const xmlNode *windows_node, } else if (node_name_is(child, "HAL")) { ret = node_get_string(child, &windows_info->hal); } - if (ret != 0) return ret; } @@ -366,11 +352,10 @@ static int xml_read_image_info(xmlNode *image_node, index_prop = xmlGetProp(image_node, "INDEX"); if (index_prop) { - char *tmp; - image_info->index = strtoul(index_prop, &tmp, 10); + image_info->index = atoi(index_prop); FREE(index_prop); } else { - image_info->index = 0; + image_info->index = 1; } ret = 0; @@ -409,14 +394,13 @@ static int xml_read_image_info(xmlNode *image_node, return ret; } if (!image_info->name) { - WARNING("Image with index %"PRIu64" has no name", - image_info->index); - image_info->name = MALLOC(1); - if (!image_info->name) { - ERROR("Out of memory"); + char *empty_name; + WARNING("Image with index %d has no name", image_info->index); + empty_name = MALLOC(1); + if (!empty_name) return WIMLIB_ERR_NOMEM; - } - image_info->name[0] = '\0'; + *empty_name = '\0'; + image_info->name = empty_name; } return ret; } @@ -429,50 +413,63 @@ static int xml_read_wim_info(const xmlNode *wim_node, struct wim_info *wim_info; xmlNode *child; int ret; - uint num_images; - struct image_info *cur_image_info; + int num_images; + int i; wim_info = CALLOC(1, sizeof(struct wim_info)); - if (!wim_info) { - ERROR("Out of memory"); + if (!wim_info) return WIMLIB_ERR_NOMEM; - } /* Count how many images there are. */ num_images = 0; - for_node_child(wim_node, child) - if (node_is_element(child) && node_name_is(child, "IMAGE")) + for_node_child(wim_node, child) { + if (node_is_element(child) && node_name_is(child, "IMAGE")) { + if (num_images == INT_MAX) { + return WIMLIB_ERR_IMAGE_COUNT; + } num_images++; + } + } - if (num_images == 0) - goto done; + if (num_images > 0) { + /* Allocate the array of struct image_infos and fill them in. */ + wim_info->images = CALLOC(num_images, sizeof(wim_info->images[0])); + if (!wim_info->images) { + ret = WIMLIB_ERR_NOMEM; + goto err; + } + wim_info->num_images = num_images; + i = 0; + for_node_child(wim_node, child) { + if (!node_is_element(child)) + continue; + if (node_name_is(child, "IMAGE")) { + DEBUG("Found tag"); + ret = xml_read_image_info(child, + &wim_info->images[i]); + if (ret != 0) + goto err; + i++; + } else if (node_name_is(child, "TOTALBYTES")) { + wim_info->total_bytes = node_get_u64(child); + } + } - /* Allocate the array of struct image_infos and fill them in. */ - wim_info->images = CALLOC(num_images, sizeof(wim_info->images[0])); - if (!wim_info->images) { - ret = WIMLIB_ERR_NOMEM; - ERROR("Out of memory!"); - goto err; - } - wim_info->num_images = num_images; - cur_image_info = wim_info->images; - for_node_child(wim_node, child) { - if (!node_is_element(child)) - continue; - if (node_name_is(child, "IMAGE")) { - DEBUG("Found tag"); - ret = xml_read_image_info(child, cur_image_info++); - if (ret != 0) - goto err; - } else if (node_name_is(child, "TOTALBYTES")) { - wim_info->total_bytes = node_get_u64(child); + /* Sort the array of image info by image index. */ + qsort(wim_info->images, num_images, + sizeof(struct image_info), sort_by_index); + + /* Make sure the image indices make sense */ + for (i = 0; i < num_images; i++) { + if (wim_info->images[i].index != i + 1) { + ERROR("WIM images are not indexed [1...%d] " + "in XML data as expected", + num_images); + return WIMLIB_ERR_IMAGE_COUNT; + } } - } - /* Sort the array of struct image_infos by image index. */ - qsort(wim_info->images, wim_info->num_images, - sizeof(struct image_info), sort_by_index); -done: + } *wim_info_ret = wim_info; return 0; err: @@ -480,10 +477,9 @@ err: return ret; } -/* Prints the information contained in a struct windows_info structure. */ +/* Prints the information contained in a `struct windows_info'. */ static void print_windows_info(const struct windows_info *windows_info) { - uint i; const struct windows_version *windows_version; printf("Architecture: %s\n", get_arch(windows_info->arch)); @@ -501,7 +497,8 @@ static void print_windows_info(const struct windows_info *windows_info) windows_info->installation_type); if (windows_info->hal) - printf("HAL: %s\n", windows_info->hal); + printf("HAL: %s\n", + windows_info->hal); if (windows_info->product_type) printf("Product Type: %s\n", @@ -510,8 +507,9 @@ static void print_windows_info(const struct windows_info *windows_info) if (windows_info->product_suite) printf("Product Suite: %s\n", windows_info->product_suite); + printf("Languages: "); - for (i = 0; i < windows_info->num_languages; i++) { + for (size_t i = 0; i < windows_info->num_languages; i++) { fputs(windows_info->languages[i], stdout); putchar(' '); } @@ -525,22 +523,22 @@ static void print_windows_info(const struct windows_info *windows_info) if (windows_info->windows_version_exists) { windows_version = &windows_info->windows_version; printf("Major Version: %"PRIu64"\n", - windows_version->major); + windows_version->major); printf("Minor Version: %"PRIu64"\n", - windows_version->minor); + windows_version->minor); printf("Build: %"PRIu64"\n", - windows_version->build); + windows_version->build); printf("Service Pack Build: %"PRIu64"\n", - windows_version->sp_build); + windows_version->sp_build); printf("Service Pack Level: %"PRIu64"\n", - windows_version->sp_level); + windows_version->sp_level); } } -/* Writes the information contained in a struct windows_version structure to the XML - * document being constructed in memory. This is the element inside - * the element. */ +/* Writes the information contained in a `struct windows_version' to the XML + * document being written. This is the element inside the + * element. */ static int xml_write_windows_version(xmlTextWriter *writer, const struct windows_version *version) { @@ -550,35 +548,35 @@ static int xml_write_windows_version(xmlTextWriter *writer, return rc; rc = xmlTextWriterWriteFormatElement(writer, "MAJOR", "%"PRIu64, - version->major); + version->major); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "MINOR", "%"PRIu64, - version->minor); + version->minor); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "BUILD", "%"PRIu64, - version->build); + version->build); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "SPBUILD", "%"PRIu64, - version->sp_build); + version->sp_build); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "SPLEVEL", "%"PRIu64, - version->sp_level); + version->sp_level); if (rc < 0) return rc; return xmlTextWriterEndElement(writer); /* */ } -/* Writes the information contained in a struct windows_info structure to the XML - * document being constructed in memory. This is the element. */ +/* Writes the information contained in a `struct windows_info' to the XML + * document being written. This is the element. */ static int xml_write_windows_info(xmlTextWriter *writer, const struct windows_info *windows_info) { @@ -587,59 +585,51 @@ static int xml_write_windows_info(xmlTextWriter *writer, if (rc < 0) return rc; - rc = xmlTextWriterWriteFormatElement(writer, "ARCH", "%"PRIu64, - windows_info->arch); + windows_info->arch); if (rc < 0) return rc; if (windows_info->product_name) { rc = xmlTextWriterWriteElement(writer, "PRODUCTNAME", - windows_info->product_name); + windows_info->product_name); if (rc < 0) return rc; } if (windows_info->edition_id) { rc = xmlTextWriterWriteElement(writer, "EDITIONID", - windows_info->edition_id); + windows_info->edition_id); if (rc < 0) return rc; } if (windows_info->installation_type) { rc = xmlTextWriterWriteElement(writer, "INSTALLATIONTYPE", - windows_info->installation_type); + windows_info->installation_type); if (rc < 0) return rc; } if (windows_info->hal) { rc = xmlTextWriterWriteElement(writer, "HAL", - windows_info->hal); + windows_info->hal); if (rc < 0) return rc; } - if (windows_info->system_root) { - rc = xmlTextWriterWriteElement(writer, "SYSTEMROOT", - windows_info->system_root); - if (rc < 0) - return rc; - } - if (windows_info->product_type) { rc = xmlTextWriterWriteElement(writer, "PRODUCTTYPE", - windows_info->product_type); + windows_info->product_type); if (rc < 0) return rc; } if (windows_info->product_suite) { rc = xmlTextWriterWriteElement(writer, "PRODUCTSUITE", - windows_info->product_suite); - if (rc < 0) - return rc; + windows_info->product_suite); + if (rc < 0) + return rc; } if (windows_info->num_languages) { @@ -647,14 +637,14 @@ static int xml_write_windows_info(xmlTextWriter *writer, if (rc < 0) return rc; - for (int i = 0; i < windows_info->num_languages; i++) { + for (size_t i = 0; i < windows_info->num_languages; i++) { rc = xmlTextWriterWriteElement(writer, "LANGUAGE", - windows_info->languages[i]); + windows_info->languages[i]); if (rc < 0) return rc; } rc = xmlTextWriterWriteElement(writer, "DEFAULT", - windows_info->default_language); + windows_info->default_language); if (rc < 0) return rc; @@ -669,6 +659,13 @@ static int xml_write_windows_info(xmlTextWriter *writer, return rc; } + if (windows_info->system_root) { + rc = xmlTextWriterWriteElement(writer, "SYSTEMROOT", + windows_info->system_root); + if (rc < 0) + return rc; + } + return xmlTextWriterEndElement(writer); /* */ } @@ -682,12 +679,12 @@ static int xml_write_time(xmlTextWriter *writer, const char *element_name, return rc; rc = xmlTextWriterWriteFormatElement(writer, "HIGHPART", - "0x%"PRIX32, (u32)(time >> 32)); + "0x%08"PRIX32, (u32)(time >> 32)); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "LOWPART", - "0x%"PRIX32, (u32)time); + "0x%08"PRIX32, (u32)time); if (rc < 0) return rc; @@ -697,7 +694,6 @@ static int xml_write_time(xmlTextWriter *writer, const char *element_name, return 0; } - /* Writes an element to the XML document. */ static int xml_write_image_info(xmlTextWriter *writer, const struct image_info *image_info) @@ -707,38 +703,37 @@ static int xml_write_image_info(xmlTextWriter *writer, if (rc < 0) return rc; - rc = xmlTextWriterWriteFormatAttribute(writer, "INDEX", "%"PRIu64, - image_info->index); + rc = xmlTextWriterWriteFormatAttribute(writer, "INDEX", "%d", + image_info->index); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "DIRCOUNT", "%"PRIu64, - image_info->dir_count); + image_info->dir_count); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "FILECOUNT", "%"PRIu64, - image_info->file_count); + image_info->file_count); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "TOTALBYTES", "%"PRIu64, - image_info->total_bytes); + image_info->total_bytes); if (rc < 0) return rc; rc = xmlTextWriterWriteFormatElement(writer, "HARDLINKBYTES", "%"PRIu64, - image_info->hard_link_bytes); + image_info->hard_link_bytes); if (rc < 0) return rc; - rc = xml_write_time(writer, "CREATIONTIME", - image_info->creation_time); + rc = xml_write_time(writer, "CREATIONTIME", image_info->creation_time); if (rc < 0) return rc; rc = xml_write_time(writer, "LASTMODIFICATIONTIME", - image_info->last_modification_time); + image_info->last_modification_time); if (rc < 0) return rc; @@ -746,37 +741,37 @@ static int xml_write_image_info(xmlTextWriter *writer, rc = xml_write_windows_info(writer, &image_info->windows_info); if (rc < 0) return rc; - } else { - DEBUG(" tag does not exist."); } if (image_info->name) { - rc = xmlTextWriterWriteElement(writer, "NAME", image_info->name); + rc = xmlTextWriterWriteElement(writer, "NAME", + image_info->name); if (rc < 0) return rc; } + if (image_info->description) { rc = xmlTextWriterWriteElement(writer, "DESCRIPTION", - image_info->description); + image_info->description); if (rc < 0) return rc; } if (image_info->display_name) { rc = xmlTextWriterWriteElement(writer, "DISPLAYNAME", - image_info->display_name); + image_info->display_name); if (rc < 0) return rc; } if (image_info->display_description) { rc = xmlTextWriterWriteElement(writer, "DISPLAYDESCRIPTION", - image_info->display_description); + image_info->display_description); if (rc < 0) return rc; } if (image_info->flags) { rc = xmlTextWriterWriteElement(writer, "FLAGS", - image_info->flags); + image_info->flags); if (rc < 0) return rc; } @@ -806,8 +801,6 @@ static struct image_info *add_image_info_struct(struct wim_info *wim_info) static int clone_windows_info(const struct windows_info *old, struct windows_info *new) { - uint i; - if (old->product_name && !(new->product_name = STRDUP(old->product_name))) return WIMLIB_ERR_NOMEM; if (old->edition_id && !(new->edition_id = STRDUP(old->edition_id))) @@ -827,7 +820,7 @@ static int clone_windows_info(const struct windows_info *old, if (!new->languages) return WIMLIB_ERR_NOMEM; new->num_languages = old->num_languages; - for (i = 0; i < new->num_languages; i++) { + for (size_t i = 0; i < new->num_languages; i++) { if (!old->languages[i]) continue; new->languages[i] = STRDUP(old->languages[i]); @@ -905,6 +898,7 @@ int xml_export_image(const struct wim_info *old_wim_info, DEBUG("Copying XML data between WIM files for source image %d.", image); + wimlib_assert(old_wim_info != NULL); wimlib_assert(image >= 1 && image <= old_wim_info->num_images); if (*new_wim_info_p) { @@ -921,7 +915,7 @@ int xml_export_image(const struct wim_info *old_wim_info, ret = clone_image_info(&old_wim_info->images[image - 1], image_info); if (ret != 0) - goto err; + goto err_destroy_image_info; image_info->index = new_wim_info->num_images; @@ -929,19 +923,21 @@ int xml_export_image(const struct wim_info *old_wim_info, FREE(image_info->name); image_info->name = STRDUP(dest_image_name); if (!image_info->name) - goto err; + goto err_destroy_image_info; } if (dest_image_description) { FREE(image_info->description); image_info->description = STRDUP(dest_image_description); if (!image_info->description) - goto err; + goto err_destroy_image_info; } *new_wim_info_p = new_wim_info; return 0; +err_destroy_image_info: + destroy_image_info(image_info); err: - ERROR("Out of memory"); - free_wim_info(new_wim_info); + if (new_wim_info != *new_wim_info_p) + free_wim_info(new_wim_info); return WIMLIB_ERR_NOMEM; } @@ -949,37 +945,38 @@ err: void xml_delete_image(struct wim_info **wim_info_p, int image) { struct wim_info *wim_info; - int i; DEBUG("Deleting image %d from the XML data.", image); wim_info = *wim_info_p; - wimlib_assert(wim_info); - wimlib_assert(image >= 1 && image <= wim_info->num_images); - destroy_image_info(&wim_info->images[image - 1]); - for (i = image - 1; i < wim_info->num_images - 1; i++) { - memcpy(&wim_info->images[i], &wim_info->images[i + 1], - sizeof(struct image_info)); - wim_info->images[i].index--; - } + memmove(&wim_info->images[image - 1], + &wim_info->images[image], + (wim_info->num_images - image) * sizeof(struct image_info)); if (--wim_info->num_images == 0) { free_wim_info(wim_info); *wim_info_p = NULL; + } else { + for (int i = image - 1; i < wim_info->num_images; i++) + wim_info->images[i].index--; } } size_t xml_get_max_image_name_len(const WIMStruct *w) { - size_t len = 0; - uint i; - uint num_images = w->wim_info->num_images; - for (i = 0; i < num_images; i++) - len = max(len, strlen(w->wim_info->images[i].name)); - return len; + size_t max_len = 0; + if (w->wim_info) { + size_t len; + for (int i = 0; i < w->wim_info->num_images; i++) { + len = strlen(w->wim_info->images[i].name); + if (len > max_len) + max_len = len; + } + } + return max_len; } #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR @@ -991,12 +988,12 @@ void xml_set_memory_allocator(void *(*malloc_func)(size_t), } #endif -static int calculate_dentry_statistics(struct dentry *dentry, void *arg) +static int calculate_dentry_statistics(struct wim_dentry *dentry, void *arg) { struct image_info *info = arg; - struct lookup_table *lookup_table = info->lookup_table; - const struct inode *inode = dentry->d_inode; - struct lookup_table_entry *lte; + struct wim_lookup_table *lookup_table = info->lookup_table; + const struct wim_inode *inode = dentry->d_inode; + struct wim_lookup_table_entry *lte; /* Update directory count and file count. * @@ -1048,12 +1045,12 @@ static int calculate_dentry_statistics(struct dentry *dentry, void *arg) info->hard_link_bytes += wim_resource_size(lte); } - if (inode->link_count >= 2 && dentry_is_first_in_inode(dentry)) { - for (unsigned i = 0; i < inode->num_ads; i++) { - if (inode->ads_entries[i].stream_name_len) { + if (inode->i_nlink >= 2 && dentry_is_first_in_inode(dentry)) { + for (unsigned i = 0; i < inode->i_num_ads; i++) { + if (inode->i_ads_entries[i].stream_name_len) { lte = inode_stream_lte(inode, i + 1, lookup_table); if (lte) { - info->hard_link_bytes += inode->link_count * + info->hard_link_bytes += inode->i_nlink * wim_resource_size(lte); } } @@ -1062,6 +1059,13 @@ static int calculate_dentry_statistics(struct dentry *dentry, void *arg) return 0; } +/* + * Calculate what to put in the , , , and + * elements of each . + * + * Please note there is no official documentation for exactly how this is done. + * But, see calculate_dentry_statistics(). + */ void xml_update_image_info(WIMStruct *w, int image) { struct image_info *image_info; @@ -1078,12 +1082,9 @@ void xml_update_image_info(WIMStruct *w, int image) flags_save = image_info->flags; image_info->lookup_table = w->lookup_table; - for_dentry_in_tree(w->image_metadata[image - 1].root_dentry, calculate_dentry_statistics, image_info); - - image_info->lookup_table = NULL; image_info->flags = flags_save; image_info->last_modification_time = get_wim_timestamp(); } @@ -1094,22 +1095,16 @@ int xml_add_image(WIMStruct *w, const char *name) struct wim_info *wim_info; struct image_info *image_info; - wimlib_assert(name); - - DEBUG("Adding image: name = %s", name); + wimlib_assert(name != NULL); /* If this is the first image, allocate the struct wim_info. Otherwise * use the existing struct wim_info. */ if (w->wim_info) { wim_info = w->wim_info; } else { - DEBUG("Allocing struct wim_info with 1 image"); wim_info = CALLOC(1, sizeof(struct wim_info)); - if (!wim_info) { - ERROR("Could not allocate WIM information struct--- " - "out of memory"); + if (!wim_info) return WIMLIB_ERR_NOMEM; - } } image_info = add_image_info_struct(wim_info); @@ -1131,7 +1126,6 @@ out_destroy_image_info: out_free_wim_info: if (wim_info != w->wim_info) FREE(wim_info); - ERROR("Out of memory"); return WIMLIB_ERR_NOMEM; } @@ -1141,14 +1135,13 @@ void print_image_info(const struct wim_info *wim_info, int image) { const struct image_info *image_info; const char *desc; - time_t time; - char *p; + char buf[50]; wimlib_assert(image >= 1 && image <= wim_info->num_images); image_info = &wim_info->images[image - 1]; - printf("Index: %"PRIu64"\n", image_info->index); + printf("Index: %d\n", image_info->index); printf("Name: %s\n", image_info->name); /* Always print the Description: part even if there is no @@ -1172,17 +1165,11 @@ void print_image_info(const struct wim_info *wim_info, int image) printf("Total Bytes: %"PRIu64"\n", image_info->total_bytes); printf("Hard Link Bytes: %"PRIu64"\n", image_info->hard_link_bytes); - time = wim_timestamp_to_unix(image_info->creation_time); - p = asctime(gmtime(&time)); - *(strrchr(p, '\n')) = '\0'; - - printf("Creation Time: %s UTC\n", p); + wim_timestamp_to_str(image_info->creation_time, buf, sizeof(buf)); + printf("Creation Time: %s\n", buf); - time = wim_timestamp_to_unix(image_info->last_modification_time); - p = asctime(gmtime(&time)); - *(strrchr(p, '\n')) = '\0'; - - printf("Last Modification Time: %s UTC\n", p); + wim_timestamp_to_str(image_info->creation_time, buf, sizeof(buf)); + printf("Last Modification Time: %s\n", buf); if (image_info->windows_info_exists) print_windows_info(&image_info->windows_info); if (image_info->flags) @@ -1193,7 +1180,7 @@ void print_image_info(const struct wim_info *wim_info, int image) /* * Reads the XML data from a WIM file. */ -int read_xml_data(FILE *fp, const struct resource_entry *res, +int read_xml_data(FILE *fp, const struct resource_entry *res_entry, u8 **xml_data_ret, struct wim_info **info_ret) { u8 *xml_data; @@ -1202,35 +1189,39 @@ int read_xml_data(FILE *fp, const struct resource_entry *res, int ret; DEBUG("XML data is %"PRIu64" bytes at offset %"PRIu64"", - (u64)res->size, res->offset); + (u64)res_entry->size, res_entry->offset); - if (resource_is_compressed(res)) { + if (resource_is_compressed(res_entry)) { ERROR("XML data is supposed to be uncompressed"); ret = WIMLIB_ERR_XML; goto out_cleanup_parser; } - if (res->size < 2) { - ERROR("XML data must be at least 2 bytes"); + + if (res_entry->size < 2) { + ERROR("XML data must be at least 2 bytes long"); ret = WIMLIB_ERR_XML; goto out_cleanup_parser; } - xml_data = MALLOC(res->size + 2); + xml_data = MALLOC(res_entry->size + 2); if (!xml_data) { ret = WIMLIB_ERR_NOMEM; goto out_cleanup_parser; } - ret = read_uncompressed_resource(fp, res->offset, res->size, xml_data); + + ret = read_uncompressed_resource(fp, res_entry->offset, + res_entry->size, xml_data); if (ret != 0) goto out_free_xml_data; - xml_data[res->size] = 0; - xml_data[res->size + 1] = 0; - - DEBUG("Parsing XML using libxml2 to create XML tree."); + /* Null-terminate just in case */ + xml_data[res_entry->size] = 0; + xml_data[res_entry->size + 1] = 0; - doc = xmlReadMemory(xml_data, res->size, "noname.xml", "UTF-16", 0); + DEBUG("Parsing XML using libxml2 to create XML tree"); + doc = xmlReadMemory(xml_data, res_entry->size, + "noname.xml", "UTF-16", 0); if (!doc) { ERROR("Failed to parse XML data"); @@ -1242,7 +1233,7 @@ int read_xml_data(FILE *fp, const struct resource_entry *res, root = xmlDocGetRootElement(doc); if (!root) { - ERROR("Empty XML document"); + ERROR("WIM XML data is an empty XML document"); ret = WIMLIB_ERR_XML; goto out_free_doc; } @@ -1260,10 +1251,8 @@ int read_xml_data(FILE *fp, const struct resource_entry *res, DEBUG("Freeing XML tree."); - xmlFreeDoc(doc); - xmlCleanupParser(); *xml_data_ret = xml_data; - return 0; + xml_data = NULL; out_free_doc: xmlFreeDoc(doc); out_free_xml_data: @@ -1289,15 +1278,12 @@ out_cleanup_parser: int write_xml_data(const struct wim_info *wim_info, int image, FILE *out, u64 total_bytes, struct resource_entry *out_res_entry) { - xmlBuffer *buf; + xmlCharEncodingHandler *encoding_handler; + xmlOutputBuffer *out_buffer; xmlTextWriter *writer; - char *utf16_str; int ret; - const xmlChar *content; - size_t len; - size_t utf16_len; - size_t bytes_written; - off_t start_offset, end_offset; + off_t start_offset; + off_t end_offset; wimlib_assert(image == WIMLIB_ALL_IMAGES || (wim_info != NULL && image >= 1 && @@ -1307,42 +1293,55 @@ int write_xml_data(const struct wim_info *wim_info, int image, FILE *out, if (start_offset == -1) return WIMLIB_ERR_WRITE; + DEBUG("Writing XML data for image %d at offset %"PRIu64, + image, start_offset); + + /* 2 bytes endianness marker for UTF-16LE. This is _required_ for WIM + * XML data. */ + if ((putc(0xff, out)) == EOF || (putc(0xfe, out) == EOF)) { + ERROR_WITH_ERRNO("Error writing XML data"); + return WIMLIB_ERR_WRITE; + } + /* The contents of the element in the XML data, under the - * element not the element, is (for non-spit WIMs) the - * size of the WIM file excluding the XML data and integrity table, - * which is the current offset, since the XML data goes at the end of - * the WIM file before the integrity table. */ - if (total_bytes == 0) { - total_bytes = ftello(out); - if (total_bytes == (u64)-1) - return WIMLIB_ERR_WRITE; + * element (not the element), is for non-split WIMs the + * size of the WIM file excluding the XML data and integrity table. + * This should be equal to the current position in the output stream, + * since the XML data and integrity table are the last elements of the + * WIM. + * + * For split WIMs, takes into account the entire WIM, not + * just the current part. In that case, @total_bytes should be passed + * in to this function. */ + if (total_bytes == 0) + total_bytes = start_offset; + + xmlInitCharEncodingHandlers(); + + /* The encoding of the XML data must be UTF-16LE. */ + encoding_handler = xmlGetCharEncodingHandler(XML_CHAR_ENCODING_UTF16LE); + if (!encoding_handler) { + ERROR("Failed to get XML character encoding handler for UTF-16LE"); + ret = WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE; + goto out_cleanup_char_encoding_handlers; } - DEBUG("Creating XML buffer and text writer."); - buf = xmlBufferCreate(); - if (!buf) { - ERROR("Failed to allocate XML buffer"); + out_buffer = xmlOutputBufferCreateFile(out, encoding_handler); + if (!out_buffer) { + ERROR("Failed to allocate xmlOutputBuffer"); ret = WIMLIB_ERR_NOMEM; - goto out; + goto out_cleanup_char_encoding_handlers; } - writer = xmlNewTextWriterMemory(buf, 0); + + writer = xmlNewTextWriter(out_buffer); if (!writer) { - ERROR("Failed to allocate XML writer"); + ERROR("Failed to allocate xmlTextWriter"); ret = WIMLIB_ERR_NOMEM; - goto out_buffer_free; + goto out_output_buffer_close; } - /* XXX */ - /* M$'s WIM files do not have XML declarations, so do not write one. - * I'm not sure how we can force the document to be written in UTF-16 - * without calling xmlTextWriterStartDocument(), though, so currently it - * is composed in a buffer UTF-8, then converted to UTF-16. */ -#if 0 - ret = xmlTextWriterStartDocument(writer, NULL, "UTF-16", NULL); - CHECK_RET; -#endif - DEBUG("Writing element"); + ret = xmlTextWriterStartElement(writer, "WIM"); CHECK_RET; @@ -1351,11 +1350,16 @@ int write_xml_data(const struct wim_info *wim_info, int image, FILE *out, CHECK_RET; if (wim_info != NULL) { - DEBUG("Writing %d elements", (int)wim_info->num_images); - for (int i = 1; i <= (int)wim_info->num_images; i++) { - if (image != WIMLIB_ALL_IMAGES && i != image) - continue; - DEBUG("Writing element for image %d", i); + int first, last; + if (image == WIMLIB_ALL_IMAGES) { + first = 1; + last = wim_info->num_images; + } else { + first = image; + last = image; + } + DEBUG("Writing %d elements", last - first + 1); + for (int i = first; i <= last; i++) { ret = xml_write_image_info(writer, &wim_info->images[i - 1]); CHECK_RET; } @@ -1367,62 +1371,43 @@ int write_xml_data(const struct wim_info *wim_info, int image, FILE *out, ret = xmlTextWriterEndDocument(writer); CHECK_RET; + DEBUG("Ended XML document"); + + /* Call xmlFreeTextWriter() before ftello() because the former will + * flush the file stream. */ xmlFreeTextWriter(writer); writer = NULL; - DEBUG("Done composing XML document. Now converting to UTF-16 and " - "writing it to the output file."); - - content = xmlBufferContent(buf); - len = xmlBufferLength(buf); - - DEBUG("XML UTF-8 length = %zu", len); - - utf16_str = utf8_to_utf16(content, len, &utf16_len); - if (!utf16_str) { - ret = WIMLIB_ERR_NOMEM; - goto out_free_text_writer; - } - - DEBUG("XML UTF-16 length = %zu", utf16_len); - - if ((putc(0xff, out)) == EOF || (putc(0xfe, out) == EOF) || - ((bytes_written = fwrite(utf16_str, 1, utf16_len, out)) - != utf16_len)) { - ERROR_WITH_ERRNO("Error writing XML data"); - ret = WIMLIB_ERR_WRITE; - goto out_free_utf16_str; - } - - DEBUG("Cleaning up."); end_offset = ftello(out); if (end_offset == -1) { ret = WIMLIB_ERR_WRITE; - goto out_free_utf16_str; + } else { + ret = 0; + out_res_entry->offset = start_offset; + out_res_entry->size = end_offset - start_offset; + out_res_entry->original_size = end_offset - start_offset; + out_res_entry->flags = WIM_RESHDR_FLAG_METADATA; } - - out_res_entry->offset = start_offset; - out_res_entry->size = end_offset - start_offset; - out_res_entry->original_size = end_offset - start_offset; - out_res_entry->flags = WIM_RESHDR_FLAG_METADATA; - ret = 0; -out_free_utf16_str: - FREE(utf16_str); out_free_text_writer: + /* xmlFreeTextWriter will free the attached xmlOutputBuffer. */ xmlFreeTextWriter(writer); -out_buffer_free: - xmlBufferFree(buf); + out_buffer = NULL; +out_output_buffer_close: + if (out_buffer != NULL) + xmlOutputBufferClose(out_buffer); +out_cleanup_char_encoding_handlers: + xmlCleanupCharEncodingHandlers(); out: + if (ret == 0) + DEBUG("Successfully wrote XML data"); return ret; } /* Returns the name of the specified image. */ WIMLIBAPI const char *wimlib_get_image_name(const WIMStruct *w, int image) { - DEBUG("Getting the name of image %d", image); if (image < 1 || image > w->hdr.image_count) return NULL; - return w->wim_info->images[image - 1].name; } @@ -1430,31 +1415,27 @@ WIMLIBAPI const char *wimlib_get_image_name(const WIMStruct *w, int image) WIMLIBAPI const char *wimlib_get_image_description(const WIMStruct *w, int image) { - DEBUG("Getting the description of image %d", image); if (image < 1 || image > w->hdr.image_count) return NULL; - return w->wim_info->images[image - 1].description; } /* Determines if an image name is already used by some image in the WIM. */ WIMLIBAPI bool wimlib_image_name_in_use(const WIMStruct *w, const char *name) { - int i; - - DEBUG("Checking to see if the image name `%s' is already in use", name); - if (!name || !w->wim_info) + if (!name || !*name) return false; - for (i = 1; i <= w->wim_info->num_images; i++) + for (int i = 1; i <= w->hdr.image_count; i++) if (strcmp(w->wim_info->images[i - 1].name, name) == 0) return true; - return false; } +/* Extracts the raw XML data to a file stream. */ WIMLIBAPI int wimlib_extract_xml_data(WIMStruct *w, FILE *fp) { - DEBUG("Extracting the XML data."); + if (!w->xml_data) + return WIMLIB_ERR_INVALID_PARAM; if (fwrite(w->xml_data, 1, w->hdr.xml_res_entry.size, fp) != w->hdr.xml_res_entry.size) { ERROR_WITH_ERRNO("Failed to extract XML data"); @@ -1471,13 +1452,11 @@ WIMLIBAPI int wimlib_set_image_name(WIMStruct *w, int image, const char *name) DEBUG("Setting the name of image %d to %s", image, name); - if (!w) - return WIMLIB_ERR_INVALID_PARAM; - if (!name || !*name) { ERROR("Must specify a non-empty string for the image name"); return WIMLIB_ERR_INVALID_PARAM; } + if (image < 1 || image > w->hdr.image_count) { ERROR("%d is not a valid image", image); return WIMLIB_ERR_INVALID_IMAGE; @@ -1494,10 +1473,9 @@ WIMLIBAPI int wimlib_set_image_name(WIMStruct *w, int image, const char *name) } p = STRDUP(name); - if (!p) { - ERROR("Out of memory"); + if (!p) return WIMLIB_ERR_NOMEM; - } + FREE(w->wim_info->images[image - 1].name); w->wim_info->images[image - 1].name = p; return 0; @@ -1509,21 +1487,14 @@ WIMLIBAPI int wimlib_set_image_descripton(WIMStruct *w, int image, { char *p; - DEBUG("Setting the description of image %d to %s", image, description); - - if (!w) - return WIMLIB_ERR_INVALID_PARAM; - if (image < 1 || image > w->hdr.image_count) { ERROR("%d is not a valid image", image); return WIMLIB_ERR_INVALID_IMAGE; } if (description) { p = STRDUP(description); - if (!p) { - ERROR("Out of memory"); + if (!p) return WIMLIB_ERR_NOMEM; - } } else { p = NULL; } @@ -1532,23 +1503,20 @@ WIMLIBAPI int wimlib_set_image_descripton(WIMStruct *w, int image, return 0; } +/* Set the element of a WIM image */ WIMLIBAPI int wimlib_set_image_flags(WIMStruct *w, int image, const char *flags) { char *p; - DEBUG("Setting the flags of image %d to %s", image, flags); - if (image < 1 || image > w->hdr.image_count) { ERROR("%d is not a valid image", image); return WIMLIB_ERR_INVALID_IMAGE; } if (flags) { p = STRDUP(flags); - if (!p) { - ERROR("Out of memory"); + if (!p) return WIMLIB_ERR_NOMEM; - } } else { p = NULL; }