/*
- * xml.c
- *
- * Deals with the XML information in WIM files. Uses the C library libxml2.
+ * xml.c - deals with the XML information in WIM files
*/
/*
- * Copyright (C) 2012 Eric Biggers
- *
- * This file is part of wimlib, a library for working with WIM files.
+ * Copyright 2012-2023 Eric Biggers
*
- * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 3 of the License, or (at your option)
- * any later version.
+ * This file is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option) any
+ * later version.
*
- * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * This file is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see https://www.gnu.org/licenses/.
*/
-#include "wimlib_internal.h"
-#include "dentry.h"
-#include "xml.h"
-#include "timestamp.h"
-#include "lookup_table.h"
-#include <string.h>
-#include <time.h>
-#include <libxml/parser.h>
-#include <libxml/tree.h>
-#include <libxml/xmlwriter.h>
-
-/* Structures used to form an in-memory representation of the XML data (other
- * than the raw parse tree from libxml). */
-
-struct windows_version {
- u64 major;
- u64 minor;
- u64 build;
- u64 sp_build;
- u64 sp_level;
-};
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-struct windows_info {
- u64 arch;
- char *product_name;
- char *edition_id;
- char *installation_type;
- char *hal;
- char *product_type;
- char *product_suite;
- char **languages;
- char *default_language;
- u64 num_languages;
- char *system_root;
- bool windows_version_exists;
- struct windows_version windows_version;
-};
+#include <stdlib.h>
+#include <string.h>
-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;
- struct windows_info windows_info;
- char *name;
- char *description;
- char *display_name;
- char *display_description;
- union {
- char *flags;
- struct lookup_table *lookup_table;
- };
-};
+#include "wimlib/blob_table.h"
+#include "wimlib/dentry.h"
+#include "wimlib/encoding.h"
+#include "wimlib/error.h"
+#include "wimlib/file_io.h"
+#include "wimlib/metadata.h"
+#include "wimlib/resource.h"
+#include "wimlib/timestamp.h"
+#include "wimlib/xml.h"
+#include "wimlib/xmlproc.h"
+#include "wimlib/write.h"
+/*
+ * A wrapper around a WIM file's XML document. The XML document contains
+ * metadata about each image in the WIM file as well as metadata about the WIM
+ * file itself.
+ */
+struct wim_xml_info {
-/* Returns a statically allocated string that is a string representation of the
- * architecture number. */
-static const char *get_arch(int arch)
-{
- static char buf[20];
- switch (arch) {
- case 0:
- return "x86";
- case 6:
- return "ia64";
- case 9:
- return "x86_64";
- /* XXX Are there other arch values? */
- default:
- snprintf(buf, sizeof(buf), "%d (unknown)", arch);
- return buf;
- }
-}
+ /* The XML document in tree form */
+ struct xml_node *root;
+ /* A malloc()ed array containing a pointer to the IMAGE element for each
+ * WIM image. The image with 1-based index 'i' is at index 'i - 1' in
+ * this array. Note: these pointers are cached values, since they could
+ * also be found by searching the document. */
+ struct xml_node **images;
-/* Iterate through the children of an xmlNode. */
-#define for_node_child(parent, child) \
- for (child = parent->children; child != NULL; child = child->next)
+ /* The number of WIM images (the length of 'images') */
+ int image_count;
+};
-/* Utility functions for xmlNodes */
-static inline bool node_is_element(xmlNode *node)
+static u64
+parse_number(const tchar *str, int base)
{
- return node->type == XML_ELEMENT_NODE;
-}
+ tchar *end;
+ unsigned long long v;
-static inline bool node_is_text(xmlNode *node)
-{
- return node->type == XML_TEXT_NODE;
+ if (!str)
+ return 0;
+ v = tstrtoull(str, &end, base);
+ if (end == str || *end || v >= UINT64_MAX)
+ return 0;
+ return v;
}
-static inline bool node_is_attribute(xmlNode *node)
+/*
+ * Retrieve an unsigned integer from the contents of the specified element,
+ * decoding it using the specified base. If the element has no contents or does
+ * not contain a valid number, returns 0.
+ */
+static u64
+xml_element_get_number(const struct xml_node *element, int base)
{
- return node->type == XML_ATTRIBUTE_NODE;
+ return parse_number(xml_element_get_text(element), base);
}
-static inline bool node_name_is(xmlNode *node, const char *name)
+/*
+ * Retrieve the timestamp from a time element. This element should have child
+ * elements HIGHPART and LOWPART; these elements will be used to construct a
+ * Windows-style timestamp.
+ */
+static u64
+xml_element_get_timestamp(const struct xml_node *element)
{
- /* For now, both upper case and lower case element names are accepted. */
- return strcasecmp((const char *)node->name, name) == 0;
-}
+ u64 timestamp = 0;
+ const struct xml_node *child;
-/* Finds the text node that is a child of an element node and returns its
- * content converted to a 64-bit unsigned integer. Returns 0 if no text node is
- * found. */
-static u64 node_get_u64(const xmlNode *u64_node)
-{
- xmlNode *child;
- for_node_child(u64_node, child)
- if (node_is_text(child))
- return strtoull((const char *)child->content, NULL, 10);
- return 0;
+ xml_node_for_each_child(element, child) {
+ if (xml_node_is_element(child, T("HIGHPART")))
+ timestamp |= xml_element_get_number(child, 16) << 32;
+ else if (xml_node_is_element(child, T("LOWPART")))
+ timestamp |= xml_element_get_number(child, 16);
+ }
+ return timestamp;
}
-/* Like node_get_u64(), but expects a number in base 16. */
-static u64 node_get_hex_u64(const xmlNode *u64_node)
+/* Create a new timestamp element and optionally link it into a tree. */
+static struct xml_node *
+xml_new_element_with_timestamp(struct xml_node *parent, const tchar *name,
+ u64 timestamp)
{
- xmlNode *child;
- for_node_child(u64_node, child)
- if (node_is_text(child))
- return strtoull(child->content, NULL, 16);
- return 0;
-}
+ struct xml_node *element;
+ tchar buf[32];
-static int node_get_string(const xmlNode *string_node, char **str)
-{
- xmlNode *child;
- char *p = NULL;
-
- for_node_child(string_node, child) {
- if (node_is_text(child) && child->content) {
- p = STRDUP(child->content);
- if (!p) {
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
- }
- break;
- }
- }
- *str = p;
- return 0;
-}
+ element = xml_new_element(NULL, name);
+ if (!element)
+ goto err;
-/* Returns the timestamp from a time node. It has child elements <HIGHPART> and
- * <LOWPART> that are then used to construct a 64-bit timestamp. */
-static u64 node_get_timestamp(const xmlNode *time_node)
-{
- u32 high_part = 0;
- u32 low_part = 0;
- xmlNode *child;
- for_node_child(time_node, child) {
- if (!node_is_element(child))
- continue;
- if (node_name_is(child, "HIGHPART"))
- high_part = node_get_hex_u64(child);
- else if (node_name_is(child, "LOWPART"))
- low_part = node_get_hex_u64(child);
- }
- return (u64)low_part | ((u64)high_part << 32);
-}
+ tsprintf(buf, T("0x%08"PRIX32), (u32)(timestamp >> 32));
+ if (!xml_new_element_with_text(element, T("HIGHPART"), buf))
+ goto err;
-/* 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;
- if (index_1 < index_2)
- return -1;
- else if (index_1 > index_2)
- return 1;
- else
- return 0;
-}
+ tsprintf(buf, T("0x%08"PRIX32), (u32)timestamp);
+ if (!xml_new_element_with_text(element, T("LOWPART"), buf))
+ goto err;
+ if (parent)
+ xml_add_child(parent, element);
+ return element;
-/* 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++)
- FREE(windows_info->languages[i]);
- FREE(windows_info->languages);
- FREE(windows_info->default_language);
- FREE(windows_info->system_root);
+err:
+ xml_free_node(element);
+ return NULL;
}
-/* Frees memory allocated inside a struct image_info structure. */
-static void destroy_image_info(struct image_info *image_info)
+/* Create a new number element and optionally link it into a tree. */
+static struct xml_node *
+xml_new_element_with_u64(struct xml_node *parent, const tchar *name, u64 value)
{
- FREE(image_info->name);
- FREE(image_info->description);
- FREE(image_info->flags);
- FREE(image_info->display_name);
- FREE(image_info->display_description);
- destroy_windows_info(&image_info->windows_info);
- memset(image_info, 0, sizeof(struct image_info));
-}
+ tchar buf[32];
-void free_wim_info(struct wim_info *info)
-{
- uint i;
- if (info) {
- if (info->images) {
- for (i = 0; i < info->num_images; i++)
- destroy_image_info(&info->images[i]);
- FREE(info->images);
- }
- FREE(info);
- }
+ tsprintf(buf, T("%"PRIu64), value);
+ return xml_new_element_with_text(parent, name, buf);
}
-/* Reads the information from a <VERSION> element inside the <WINDOWS> element.
- * */
-static void xml_read_windows_version(const xmlNode *version_node,
- struct windows_version* windows_version)
+static bool
+parse_index(tchar **pp, u32 *index_ret)
{
- xmlNode *child;
- for_node_child(version_node, child) {
- if (!node_is_element(child))
- continue;
- if (node_name_is(child, "MAJOR"))
- windows_version->major = node_get_u64(child);
- else if (node_name_is(child, "MINOR"))
- windows_version->minor = node_get_u64(child);
- else if (node_name_is(child, "BUILD"))
- 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"))
- windows_version->sp_level = node_get_u64(child);
+ tchar *p = *pp;
+ u32 index = 0;
+
+ *p++ = '\0'; /* overwrite '[' */
+ while (*p >= '0' && *p <= '9') {
+ u32 n = (index * 10) + (*p++ - '0');
+ if (n < index)
+ return false;
+ index = n;
}
+ if (index == 0)
+ return false;
+ if (*p != ']')
+ return false;
+ p++;
+ if (*p != '/' && *p != '\0')
+ return false;
+
+ *pp = p;
+ *index_ret = index;
+ return true;
}
-/* Reads the information from a <LANGUAGE> element inside a <WINDOWS> element.
- * */
-static int xml_read_languages(const xmlNode *languages_node,
- char ***languages_ret,
- u64 *num_languages_ret,
- char **default_language_ret)
+static int
+do_xml_path_walk(struct xml_node *element, const tchar *path, bool create,
+ struct xml_node **result_ret)
{
- xmlNode *child;
- uint i;
- uint num_languages;
- 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++;
+ size_t n = tstrlen(path) + 1;
+ tchar buf[n];
+ tchar *p;
+ tchar c;
- languages = CALLOC(num_languages, sizeof(char*));
- if (!languages) {
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
- }
-
- *languages_ret = languages;
- *num_languages_ret = num_languages;
+ *result_ret = NULL;
- 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++]);
- else if (node_name_is(child, "DEFAULT"))
- ret = node_get_string(child, default_language_ret);
- if (ret != 0)
- return ret;
- }
- return ret;
-}
+ if (!element)
+ return 0;
-/* Reads the information from a <WINDOWS> element inside an <IMAGE> element. */
-static int xml_read_windows_info(const xmlNode *windows_node,
- struct windows_info *windows_info)
-{
- xmlNode *child;
- int ret = 0;
+ /* Copy the path to a temporary buffer. */
+ tmemcpy(buf, path, n);
+ p = buf;
- for_node_child(windows_node, child) {
- if (!node_is_element(child))
- continue;
- if (node_name_is(child, "ARCH")) {
- windows_info->arch = node_get_u64(child);
- } else if (node_name_is(child, "PRODUCTNAME")) {
- ret = node_get_string(child,
- &windows_info->product_name);
- } else if (node_name_is(child, "EDITIONID")) {
- ret = node_get_string(child,
- &windows_info->edition_id);
- } else if (node_name_is(child, "INSTALLATIONTYPE")) {
- ret = node_get_string(child,
- &windows_info->installation_type);
- } else if (node_name_is(child, "PRODUCTTYPE")) {
- ret = node_get_string(child,
- &windows_info->product_type);
- } else if (node_name_is(child, "PRODUCTSUITE")) {
- ret = node_get_string(child,
- &windows_info->product_suite);
- } else if (node_name_is(child, "LANGUAGES")) {
- ret = xml_read_languages(child,
- &windows_info->languages,
- &windows_info->num_languages,
- &windows_info->default_language);
- } else if (node_name_is(child, "VERSION")) {
- xml_read_windows_version(child,
- &windows_info->windows_version);
- windows_info->windows_version_exists = true;
- } else if (node_name_is(child, "SYSTEMROOT")) {
- ret = node_get_string(child, &windows_info->system_root);
- } else if (node_name_is(child, "HAL")) {
- ret = node_get_string(child, &windows_info->hal);
- }
+ if (*p == '/')
+ goto bad_syntax;
+ c = *p;
- if (ret != 0)
- return ret;
- }
- return ret;
-}
+ while (c != '\0') {
+ const tchar *name;
+ struct xml_node *child;
+ u32 index = 1;
-/* Reads the information from an <IMAGE> element. */
-static int xml_read_image_info(xmlNode *image_node,
- struct image_info *image_info)
-{
- xmlNode *child;
- xmlChar *index_prop;
- int ret;
+ /* We have another path component. */
- index_prop = xmlGetProp(image_node, "INDEX");
- if (index_prop) {
- char *tmp;
- image_info->index = strtoul(index_prop, &tmp, 10);
- FREE(index_prop);
- } else {
- image_info->index = 0;
- }
+ /* Parse the element name. */
+ name = p;
+ while (*p != '/' && *p != '\0' && *p != '[')
+ p++;
+ if (p == name) /* empty name? */
+ goto bad_syntax;
- ret = 0;
- for_node_child(image_node, child) {
- if (!node_is_element(child))
- continue;
- if (node_name_is(child, "DIRCOUNT"))
- image_info->dir_count = node_get_u64(child);
- else if (node_name_is(child, "FILECOUNT"))
- image_info->file_count = node_get_u64(child);
- else if (node_name_is(child, "TOTALBYTES"))
- image_info->total_bytes = node_get_u64(child);
- else if (node_name_is(child, "HARDLINKBYTES"))
- image_info->hard_link_bytes = node_get_u64(child);
- else if (node_name_is(child, "CREATIONTIME"))
- image_info->creation_time = node_get_timestamp(child);
- else if (node_name_is(child, "LASTMODIFICATIONTIME"))
- image_info->last_modification_time = node_get_timestamp(child);
- else if (node_name_is(child, "WINDOWS")) {
- DEBUG("Found <WINDOWS> tag");
- ret = xml_read_windows_info(child,
- &image_info->windows_info);
- image_info->windows_info_exists = true;
- } else if (node_name_is(child, "NAME")) {
- ret = node_get_string(child, &image_info->name);
- } else if (node_name_is(child, "DESCRIPTION")) {
- ret = node_get_string(child, &image_info->description);
- } else if (node_name_is(child, "FLAGS")) {
- ret = node_get_string(child, &image_info->flags);
- } else if (node_name_is(child, "DISPLAYNAME")) {
- ret = node_get_string(child, &image_info->display_name);
- } else if (node_name_is(child, "DISPLAYDESCRIPTION")) {
- ret = node_get_string(child, &image_info->display_description);
- }
- if (ret != 0)
- 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");
- return WIMLIB_ERR_NOMEM;
- }
- image_info->name[0] = '\0';
- }
- return ret;
-}
+ /* Handle a bracketed index, if one was specified. */
+ if (*p == '[' && !parse_index(&p, &index))
+ goto bad_syntax;
-/* Reads the information from a <WIM> element, which should be the root element
- * of the XML tree. */
-static int xml_read_wim_info(const xmlNode *wim_node,
- struct wim_info **wim_info_ret)
-{
- struct wim_info *wim_info;
- xmlNode *child;
- int ret;
- uint num_images;
- struct image_info *cur_image_info;
+ c = *p;
+ *p = '\0';
- wim_info = CALLOC(1, sizeof(struct wim_info));
- if (!wim_info) {
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
- }
+ /* Look for a matching child. */
+ xml_node_for_each_child(element, child)
+ if (xml_node_is_element(child, name) && !--index)
+ goto next_step;
- /* 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"))
- num_images++;
+ /* No child matched the path. If create=false, the lookup
+ * failed. If create=true, create the needed element. */
+ if (!create)
+ return 0;
- if (num_images == 0)
- goto done;
+ /* We can't create an element at index 'n' if indices 1...n-1
+ * didn't already exist. */
+ if (index != 1)
+ return WIMLIB_ERR_INVALID_PARAM;
- /* 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 <IMAGE> 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);
- }
+ child = xml_new_element(element, name);
+ if (!child)
+ return WIMLIB_ERR_NOMEM;
+ next_step:
+ /* Continue to the next path component, if there is one. */
+ element = child;
+ p++;
}
- /* 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;
+ *result_ret = element;
return 0;
-err:
- free_wim_info(wim_info);
- return ret;
+
+bad_syntax:
+ ERROR("The XML path \"%"TS"\" has invalid syntax.", path);
+ return WIMLIB_ERR_INVALID_PARAM;
}
-/* Prints the information contained in a struct windows_info structure. */
-static void print_windows_info(const struct windows_info *windows_info)
+/* Retrieve the XML element, if any, at the specified 'path'. This supports a
+ * simple filesystem-like syntax. If the element was found, returns a pointer
+ * to it; otherwise returns NULL. */
+static struct xml_node *
+xml_get_element_by_path(struct xml_node *root, const tchar *path)
{
- uint i;
- const struct windows_version *windows_version;
-
- printf("Architecture: %s\n", get_arch(windows_info->arch));
+ struct xml_node *element;
- if (windows_info->product_name)
- printf("Product Name: %s\n",
- windows_info->product_name);
-
- if (windows_info->edition_id)
- printf("Edition ID: %s\n",
- windows_info->edition_id);
-
- if (windows_info->installation_type)
- printf("Installation Type: %s\n",
- windows_info->installation_type);
-
- if (windows_info->hal)
- printf("HAL: %s\n", windows_info->hal);
+ do_xml_path_walk(root, path, false, &element);
+ return element;
+}
- if (windows_info->product_type)
- printf("Product Type: %s\n",
- windows_info->product_type);
+/*
+ * Similar to xml_get_element_by_path(), but creates the element and any
+ * requisite ancestor elements as needed. If successful, 0 is returned and
+ * *element_ret is set to a pointer to the resulting element. If unsuccessful,
+ * an error code is returned and *element_ret is set to NULL.
+ */
+static int
+xml_ensure_element_by_path(struct xml_node *root, const tchar *path,
+ struct xml_node **element_ret)
+{
+ return do_xml_path_walk(root, path, true, element_ret);
+}
- 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++) {
- fputs(windows_info->languages[i], stdout);
- putchar(' ');
- }
- putchar('\n');
- if (windows_info->default_language)
- printf("Default Language: %s\n",
- windows_info->default_language);
- if (windows_info->system_root)
- printf("System Root: %s\n",
- windows_info->system_root);
- if (windows_info->windows_version_exists) {
- windows_version = &windows_info->windows_version;
- printf("Major Version: %"PRIu64"\n",
- windows_version->major);
- printf("Minor Version: %"PRIu64"\n",
- windows_version->minor);
- printf("Build: %"PRIu64"\n",
- windows_version->build);
- printf("Service Pack Build: %"PRIu64"\n",
- windows_version->sp_build);
- printf("Service Pack Level: %"PRIu64"\n",
- windows_version->sp_level);
- }
+static u64
+xml_get_number_by_path(struct xml_node *root, const tchar *path)
+{
+ return xml_element_get_number(xml_get_element_by_path(root, path), 10);
}
+static u64
+xml_get_timestamp_by_path(struct xml_node *root, const tchar *path)
+{
+ return xml_element_get_timestamp(xml_get_element_by_path(root, path));
+}
-/* Writes the information contained in a struct windows_version structure to the XML
- * document being constructed in memory. This is the <VERSION> element inside
- * the <WINDOWS> element. */
-static int xml_write_windows_version(xmlTextWriter *writer,
- const struct windows_version *version)
+static const tchar *
+xml_get_text_by_path(struct xml_node *root, const tchar *path)
{
- int rc;
- rc = xmlTextWriterStartElement(writer, "VERSION");
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "MAJOR", "%"PRIu64,
- version->major);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "MINOR", "%"PRIu64,
- version->minor);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "BUILD", "%"PRIu64,
- version->build);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "SPBUILD", "%"PRIu64,
- version->sp_build);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "SPLEVEL", "%"PRIu64,
- version->sp_level);
- if (rc < 0)
- return rc;
-
- return xmlTextWriterEndElement(writer); /* </VERSION> */
+ return xml_element_get_text(xml_get_element_by_path(root, path));
}
-/* Writes the information contained in a struct windows_info structure to the XML
- * document being constructed in memory. This is the <WINDOWS> element. */
-static int xml_write_windows_info(xmlTextWriter *writer,
- const struct windows_info *windows_info)
+/*
+ * Create/replace (if text is not NULL and not empty) or remove (if text is NULL
+ * or empty) an element containing text.
+ */
+static int
+xml_set_text_by_path(struct xml_node *root, const tchar *path,
+ const tchar *text)
{
- int rc;
- rc = xmlTextWriterStartElement(writer, "WINDOWS");
- if (rc < 0)
- return rc;
-
-
- rc = xmlTextWriterWriteFormatElement(writer, "ARCH", "%"PRIu64,
- windows_info->arch);
- if (rc < 0)
- return rc;
-
- if (windows_info->product_name) {
- rc = xmlTextWriterWriteElement(writer, "PRODUCTNAME",
- windows_info->product_name);
- if (rc < 0)
- return rc;
- }
+ int ret;
+ struct xml_node *element;
- if (windows_info->edition_id) {
- rc = xmlTextWriterWriteElement(writer, "EDITIONID",
- windows_info->edition_id);
- if (rc < 0)
- return rc;
+ if (text && *text) {
+ /* Create or replace */
+ ret = xml_ensure_element_by_path(root, path, &element);
+ if (ret)
+ return ret;
+ return xml_element_set_text(element, text);
+ } else {
+ /* Remove */
+ xml_free_node(xml_get_element_by_path(root, path));
+ return 0;
}
+}
- if (windows_info->installation_type) {
- rc = xmlTextWriterWriteElement(writer, "INSTALLATIONTYPE",
- windows_info->installation_type);
- if (rc < 0)
- return rc;
- }
+/* Unlink and return the node which represents the INDEX attribute of the
+ * specified IMAGE element. */
+static struct xml_node *
+unlink_index_attribute(struct xml_node *image_node)
+{
+ struct xml_node *attr = xml_get_attrib(image_node, T("INDEX"));
- if (windows_info->hal) {
- rc = xmlTextWriterWriteElement(writer, "HAL",
- windows_info->hal);
- if (rc < 0)
- return rc;
- }
+ xml_unlink_node(attr);
+ return attr;
+}
- if (windows_info->system_root) {
- rc = xmlTextWriterWriteElement(writer, "SYSTEMROOT",
- windows_info->system_root);
- if (rc < 0)
- return rc;
- }
+/* Compute the total uncompressed size of the streams of the specified inode. */
+static u64
+inode_sum_stream_sizes(const struct wim_inode *inode,
+ const struct blob_table *blob_table)
+{
+ u64 total_size = 0;
- if (windows_info->product_type) {
- rc = xmlTextWriterWriteElement(writer, "PRODUCTTYPE",
- windows_info->product_type);
- if (rc < 0)
- return rc;
- }
+ for (unsigned i = 0; i < inode->i_num_streams; i++) {
+ const struct blob_descriptor *blob;
- if (windows_info->product_suite) {
- rc = xmlTextWriterWriteElement(writer, "PRODUCTSUITE",
- windows_info->product_suite);
- if (rc < 0)
- return rc;
+ blob = stream_blob(&inode->i_streams[i], blob_table);
+ if (blob)
+ total_size += blob->size;
}
+ return total_size;
+}
- if (windows_info->num_languages) {
- rc = xmlTextWriterStartElement(writer, "LANGUAGES");
- if (rc < 0)
- return rc;
+static int
+append_image_node(struct wim_xml_info *info, struct xml_node *image_node)
+{
+ tchar buf[32];
+ struct xml_node **images;
+ int ret;
- for (int i = 0; i < windows_info->num_languages; i++) {
- rc = xmlTextWriterWriteElement(writer, "LANGUAGE",
- windows_info->languages[i]);
- if (rc < 0)
- return rc;
- }
- rc = xmlTextWriterWriteElement(writer, "DEFAULT",
- windows_info->default_language);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterEndElement(writer); /* </LANGUAGES> */
- if (rc < 0)
- return rc;
- }
+ /* Limit exceeded? */
+ if (unlikely(info->image_count >= MAX_IMAGES))
+ return WIMLIB_ERR_IMAGE_COUNT;
- if (windows_info->windows_version_exists) {
- rc = xml_write_windows_version(writer, &windows_info->windows_version);
- if (rc < 0)
- return rc;
- }
+ /* Set the INDEX attribute. */
+ tsprintf(buf, T("%d"), info->image_count + 1);
+ ret = xml_set_attrib(image_node, T("INDEX"), buf);
+ if (ret)
+ return ret;
- return xmlTextWriterEndElement(writer); /* </WINDOWS> */
-}
+ /* Append the IMAGE element to the 'images' array. */
+ images = REALLOC(info->images,
+ (info->image_count + 1) * sizeof(info->images[0]));
+ if (unlikely(!images))
+ return WIMLIB_ERR_NOMEM;
+ info->images = images;
+ images[info->image_count++] = image_node;
-/* Writes a time element to the XML document being constructed in memory. */
-static int xml_write_time(xmlTextWriter *writer, const char *element_name,
- u64 time)
-{
- int rc;
- rc = xmlTextWriterStartElement(writer, element_name);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "HIGHPART",
- "0x%"PRIX32, (u32)(time >> 32));
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "LOWPART",
- "0x%"PRIX32, (u32)time);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterEndElement(writer); /* </@element_name> */
- if (rc < 0)
- return rc;
+ /* Add the IMAGE element to the document. */
+ xml_add_child(info->root, image_node);
return 0;
}
+/*----------------------------------------------------------------------------*
+ * Functions for internal library use *
+ *----------------------------------------------------------------------------*/
-/* Writes an <IMAGE> element to the XML document. */
-static int xml_write_image_info(xmlTextWriter *writer,
- const struct image_info *image_info)
+/* Allocate an empty 'struct wim_xml_info', containing no images. */
+struct wim_xml_info *
+xml_new_info_struct(void)
{
- int rc;
- rc = xmlTextWriterStartElement(writer, "IMAGE");
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatAttribute(writer, "INDEX", "%"PRIu64,
- image_info->index);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "DIRCOUNT", "%"PRIu64,
- image_info->dir_count);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "FILECOUNT", "%"PRIu64,
- image_info->file_count);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "TOTALBYTES", "%"PRIu64,
- image_info->total_bytes);
- if (rc < 0)
- return rc;
-
- rc = xmlTextWriterWriteFormatElement(writer, "HARDLINKBYTES", "%"PRIu64,
- image_info->hard_link_bytes);
- if (rc < 0)
- return rc;
-
- 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);
- if (rc < 0)
- return rc;
-
- if (image_info->windows_info_exists) {
- rc = xml_write_windows_info(writer, &image_info->windows_info);
- if (rc < 0)
- return rc;
- } else {
- DEBUG("<WINDOWS> tag does not exist.");
- }
+ struct wim_xml_info *info = CALLOC(1, sizeof(*info));
- if (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);
- if (rc < 0)
- return rc;
- }
- if (image_info->display_name) {
- rc = xmlTextWriterWriteElement(writer, "DISPLAYNAME",
- image_info->display_name);
- if (rc < 0)
- return rc;
- }
- if (image_info->display_description) {
- rc = xmlTextWriterWriteElement(writer, "DISPLAYDESCRIPTION",
- image_info->display_description);
- if (rc < 0)
- return rc;
+ if (!info)
+ return NULL;
+
+ info->root = xml_new_element(NULL, T("WIM"));
+ if (!info->root) {
+ FREE(info);
+ return NULL;
}
+ return info;
+}
- if (image_info->flags) {
- rc = xmlTextWriterWriteElement(writer, "FLAGS",
- image_info->flags);
- if (rc < 0)
- return rc;
+/* Free a 'struct wim_xml_info'. */
+void
+xml_free_info_struct(struct wim_xml_info *info)
+{
+ if (info) {
+ xml_free_node(info->root);
+ FREE(info->images);
+ FREE(info);
}
+}
- return xmlTextWriterEndElement(writer); /* </IMAGE> */
+/* Retrieve the number of images for which there exist IMAGE elements in the XML
+ * document. */
+int
+xml_get_image_count(const struct wim_xml_info *info)
+{
+ return info->image_count;
}
+/* Retrieve the TOTALBYTES value for the WIM file, or 0 if this value is
+ * unavailable. */
+u64
+xml_get_total_bytes(const struct wim_xml_info *info)
+{
+ return xml_get_number_by_path(info->root, T("TOTALBYTES"));
+}
+/* Retrieve the TOTALBYTES value for the specified image, or 0 if this value is
+ * unavailable. */
+u64
+xml_get_image_total_bytes(const struct wim_xml_info *info, int image)
+{
+ return xml_get_number_by_path(info->images[image - 1], T("TOTALBYTES"));
+}
-/* Makes space for another image in the XML information and return a pointer to
- * it.*/
-static struct image_info *add_image_info_struct(struct wim_info *wim_info)
+/* Retrieve the HARDLINKBYTES value for the specified image, or 0 if this value
+ * is unavailable. */
+u64
+xml_get_image_hard_link_bytes(const struct wim_xml_info *info, int image)
{
- struct image_info *images;
+ return xml_get_number_by_path(info->images[image - 1],
+ T("HARDLINKBYTES"));
+}
- images = CALLOC(wim_info->num_images + 1, sizeof(struct image_info));
- if (!images)
- return NULL;
- memcpy(images, wim_info->images,
- wim_info->num_images * sizeof(struct image_info));
- FREE(wim_info->images);
- wim_info->images = images;
- wim_info->num_images++;
- return &images[wim_info->num_images - 1];
+/* Retrieve the WIMBOOT value for the specified image, or false if this value is
+ * unavailable. */
+bool
+xml_get_wimboot(const struct wim_xml_info *info, int image)
+{
+ return xml_get_number_by_path(info->images[image - 1], T("WIMBOOT"));
}
-static int clone_windows_info(const struct windows_info *old,
- struct windows_info *new)
+/* Retrieve the Windows build number for the specified image, or 0 if this
+ * information is not available. */
+u64
+xml_get_windows_build_number(const struct wim_xml_info *info, int image)
{
- uint i;
+ return xml_get_number_by_path(info->images[image - 1],
+ T("WINDOWS/VERSION/BUILD"));
+}
- 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)))
- return WIMLIB_ERR_NOMEM;
- if (old->installation_type && !(new->installation_type =
- STRDUP(old->installation_type)))
- return WIMLIB_ERR_NOMEM;
- if (old->hal && !(new->hal = STRDUP(old->hal)))
- return WIMLIB_ERR_NOMEM;
- if (old->product_type && !(new->product_type = STRDUP(old->product_type)))
- return WIMLIB_ERR_NOMEM;
- if (old->product_suite && !(new->product_suite = STRDUP(old->product_suite)))
- return WIMLIB_ERR_NOMEM;
+/* Set the WIMBOOT value for the specified image. */
+int
+xml_set_wimboot(struct wim_xml_info *info, int image)
+{
+ return xml_set_text_by_path(info->images[image - 1],
+ T("WIMBOOT"), T("1"));
+}
- if (old->languages) {
- new->languages = CALLOC(old->num_languages, sizeof(char*));
- if (!new->languages)
- return WIMLIB_ERR_NOMEM;
- new->num_languages = old->num_languages;
- for (i = 0; i < new->num_languages; i++) {
- if (!old->languages[i])
- continue;
- new->languages[i] = STRDUP(old->languages[i]);
- if (!new->languages[i])
- return WIMLIB_ERR_NOMEM;
- }
- }
- if (old->default_language &&
- !(new->default_language = STRDUP(old->default_language)))
- return WIMLIB_ERR_NOMEM;
- if (old->system_root && !(new->system_root = STRDUP(old->system_root)))
+/*
+ * Update the DIRCOUNT, FILECOUNT, TOTALBYTES, HARDLINKBYTES, and
+ * LASTMODIFICATIONTIME elements for the specified WIM image.
+ *
+ * Note: since these stats are likely to be used for display purposes only, we
+ * no longer attempt to duplicate WIMGAPI's weird bugs when calculating them.
+ */
+int
+xml_update_image_info(WIMStruct *wim, int image)
+{
+ const struct wim_image_metadata *imd = wim->image_metadata[image - 1];
+ struct xml_node *image_node = wim->xml_info->images[image - 1];
+ const struct wim_inode *inode;
+ u64 dir_count = 0;
+ u64 file_count = 0;
+ u64 total_bytes = 0;
+ u64 hard_link_bytes = 0;
+ u64 size;
+ struct xml_node *dircount_node;
+ struct xml_node *filecount_node;
+ struct xml_node *totalbytes_node;
+ struct xml_node *hardlinkbytes_node;
+ struct xml_node *lastmodificationtime_node;
+
+ image_for_each_inode(inode, imd) {
+ if (inode_is_directory(inode))
+ dir_count += inode->i_nlink;
+ else
+ file_count += inode->i_nlink;
+ size = inode_sum_stream_sizes(inode, wim->blob_table);
+ total_bytes += size * inode->i_nlink;
+ hard_link_bytes += size * (inode->i_nlink - 1);
+ }
+
+ dircount_node = xml_new_element_with_u64(NULL, T("DIRCOUNT"),
+ dir_count);
+ filecount_node = xml_new_element_with_u64(NULL, T("FILECOUNT"),
+ file_count);
+ totalbytes_node = xml_new_element_with_u64(NULL, T("TOTALBYTES"),
+ total_bytes);
+ hardlinkbytes_node = xml_new_element_with_u64(NULL, T("HARDLINKBYTES"),
+ hard_link_bytes);
+ lastmodificationtime_node = xml_new_element_with_timestamp(NULL,
+ T("LASTMODIFICATIONTIME"), now_as_wim_timestamp());
+
+ if (unlikely(!dircount_node || !filecount_node || !totalbytes_node ||
+ !hardlinkbytes_node || !lastmodificationtime_node)) {
+ xml_free_node(dircount_node);
+ xml_free_node(filecount_node);
+ xml_free_node(totalbytes_node);
+ xml_free_node(hardlinkbytes_node);
+ xml_free_node(lastmodificationtime_node);
return WIMLIB_ERR_NOMEM;
- if (old->windows_version_exists) {
- new->windows_version_exists = true;
- memcpy(&new->windows_version, &old->windows_version,
- sizeof(old->windows_version));
}
+
+ xml_replace_child(image_node, dircount_node);
+ xml_replace_child(image_node, filecount_node);
+ xml_replace_child(image_node, totalbytes_node);
+ xml_replace_child(image_node, hardlinkbytes_node);
+ xml_replace_child(image_node, lastmodificationtime_node);
return 0;
}
-static int clone_image_info(const struct image_info *old, struct image_info *new)
+/* Add an image to the XML information. */
+int
+xml_add_image(struct wim_xml_info *info, const tchar *name)
{
- new->dir_count = old->dir_count;
- new->file_count = old->file_count;
- new->total_bytes = old->total_bytes;
- new->hard_link_bytes = old->hard_link_bytes;
- new->creation_time = old->creation_time;
- new->last_modification_time = old->last_modification_time;
-
- if (!(new->name = STRDUP(old->name)))
- return WIMLIB_ERR_NOMEM;
-
- if (old->description)
- if (!(new->description = STRDUP(old->description)))
- return WIMLIB_ERR_NOMEM;
-
- if (old->display_name)
- if (!(new->display_name = STRDUP(old->display_name)))
- return WIMLIB_ERR_NOMEM;
-
- if (old->display_description)
- if (!(new->display_description = STRDUP(old->display_description)))
- return WIMLIB_ERR_NOMEM;
-
- if (old->flags)
- if (!(new->flags = STRDUP(old->flags)))
- return WIMLIB_ERR_NOMEM;
+ const u64 now = now_as_wim_timestamp();
+ struct xml_node *image_node;
+ int ret;
- if (old->windows_info_exists) {
- new->windows_info_exists = true;
- return clone_windows_info(&old->windows_info,
- &new->windows_info);
+ if (name && !xml_legal_value(name)) {
+ ERROR("Name of new image contains illegal characters");
+ return WIMLIB_ERR_INVALID_PARAM;
}
+
+ ret = WIMLIB_ERR_NOMEM;
+ image_node = xml_new_element(NULL, T("IMAGE"));
+ if (!image_node)
+ goto err;
+ if (name && *name &&
+ !xml_new_element_with_text(image_node, T("NAME"), name))
+ goto err;
+ if (!xml_new_element_with_u64(image_node, T("DIRCOUNT"), 0))
+ goto err;
+ if (!xml_new_element_with_u64(image_node, T("FILECOUNT"), 0))
+ goto err;
+ if (!xml_new_element_with_u64(image_node, T("TOTALBYTES"), 0))
+ goto err;
+ if (!xml_new_element_with_u64(image_node, T("HARDLINKBYTES"), 0))
+ goto err;
+ if (!xml_new_element_with_timestamp(image_node, T("CREATIONTIME"), now))
+ goto err;
+ if (!xml_new_element_with_timestamp(image_node,
+ T("LASTMODIFICATIONTIME"), now))
+ goto err;
+ ret = append_image_node(info, image_node);
+ if (ret)
+ goto err;
return 0;
+
+err:
+ xml_free_node(image_node);
+ return ret;
}
-/* Copies the XML information for an image between WIM files.
- *
- * @dest_image_name and @dest_image_description are ignored if they are NULL;
- * otherwise, they are used to override the image name and/or image description
- * from the XML data in the source WIM file.
+/*
+ * Make a copy of the XML information for the image with index @src_image in the
+ * @src_info XML document and append it to the @dest_info XML document.
*
- * On failure, WIMLIB_ERR_NOMEM is returned and no changes are made. Otherwise,
- * 0 is returned and the WIM information at *new_wim_info_p is modified.
+ * In the process, change the image's name and description to the values
+ * specified by @dest_image_name and @dest_image_description. Either or both
+ * may be NULL, which indicates that the corresponding element will not be
+ * included in the destination image.
*/
-int xml_export_image(const struct wim_info *old_wim_info,
- int image,
- struct wim_info **new_wim_info_p,
- const char *dest_image_name,
- const char *dest_image_description)
+int
+xml_export_image(const struct wim_xml_info *src_info, int src_image,
+ struct wim_xml_info *dest_info, const tchar *dest_image_name,
+ const tchar *dest_image_description, bool wimboot)
{
- struct wim_info *new_wim_info;
- struct image_info *image_info;
+ struct xml_node *dest_node;
int ret;
- DEBUG("Copying XML data between WIM files for source image %d.", image);
-
- wimlib_assert(image >= 1 && image <= old_wim_info->num_images);
-
- if (*new_wim_info_p) {
- new_wim_info = *new_wim_info_p;
- } else {
- new_wim_info = CALLOC(1, sizeof(struct wim_info));
- if (!new_wim_info)
- goto err;
+ if (dest_image_name && !xml_legal_value(dest_image_name)) {
+ ERROR("Destination image name contains illegal characters");
+ return WIMLIB_ERR_INVALID_PARAM;
+ }
+ if (dest_image_description &&
+ !xml_legal_value(dest_image_description)) {
+ ERROR("Destination image description contains illegal characters");
+ return WIMLIB_ERR_INVALID_PARAM;
}
- image_info = add_image_info_struct(new_wim_info);
- if (!image_info)
+ ret = WIMLIB_ERR_NOMEM;
+ dest_node = xml_clone_tree(src_info->images[src_image - 1]);
+ if (!dest_node)
goto err;
- ret = clone_image_info(&old_wim_info->images[image - 1], image_info);
- if (ret != 0)
+ ret = xml_set_text_by_path(dest_node, T("NAME"), dest_image_name);
+ if (ret)
goto err;
- image_info->index = new_wim_info->num_images;
+ ret = xml_set_text_by_path(dest_node, T("DESCRIPTION"),
+ dest_image_description);
+ if (ret)
+ goto err;
- if (dest_image_name) {
- FREE(image_info->name);
- image_info->name = STRDUP(dest_image_name);
- if (!image_info->name)
- goto err;
- }
- if (dest_image_description) {
- FREE(image_info->description);
- image_info->description = STRDUP(dest_image_description);
- if (!image_info->description)
+ if (wimboot) {
+ ret = xml_set_text_by_path(dest_node, T("WIMBOOT"), T("1"));
+ if (ret)
goto err;
}
- *new_wim_info_p = new_wim_info;
+
+ ret = append_image_node(dest_info, dest_node);
+ if (ret)
+ goto err;
return 0;
+
err:
- ERROR("Out of memory");
- free_wim_info(new_wim_info);
- return WIMLIB_ERR_NOMEM;
+ xml_free_node(dest_node);
+ return ret;
}
-/* Removes an image from the XML information. */
-void xml_delete_image(struct wim_info **wim_info_p, int image)
+/* Remove the specified image from the XML document. */
+void
+xml_delete_image(struct wim_xml_info *info, int image)
{
- struct wim_info *wim_info;
- int i;
-
- DEBUG("Deleting image %d from the XML data.", image);
+ struct xml_node *next_image;
+ struct xml_node *index_attr, *next_index_attr;
- wim_info = *wim_info_p;
+ /* Free the IMAGE element for the deleted image. Then, shift all
+ * higher-indexed IMAGE elements down by 1, in the process re-assigning
+ * their INDEX attributes. */
- wimlib_assert(wim_info);
- wimlib_assert(image >= 1 && image <= wim_info->num_images);
+ next_image = info->images[image - 1];
+ next_index_attr = unlink_index_attribute(next_image);
+ xml_free_node(next_image);
- 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--;
+ while (image < info->image_count) {
+ index_attr = next_index_attr;
+ next_image = info->images[image];
+ next_index_attr = unlink_index_attribute(next_image);
+ xml_add_child(next_image, index_attr);
+ info->images[image - 1] = next_image;
+ image++;
}
- if (--wim_info->num_images == 0) {
- free_wim_info(wim_info);
- *wim_info_p = NULL;
- }
+ xml_free_node(next_index_attr);
+ info->image_count--;
}
-size_t xml_get_max_image_name_len(const WIMStruct *w)
+/* Architecture constants are from w64 mingw winnt.h */
+#define PROCESSOR_ARCHITECTURE_INTEL 0
+#define PROCESSOR_ARCHITECTURE_MIPS 1
+#define PROCESSOR_ARCHITECTURE_ALPHA 2
+#define PROCESSOR_ARCHITECTURE_PPC 3
+#define PROCESSOR_ARCHITECTURE_SHX 4
+#define PROCESSOR_ARCHITECTURE_ARM 5
+#define PROCESSOR_ARCHITECTURE_IA64 6
+#define PROCESSOR_ARCHITECTURE_ALPHA64 7
+#define PROCESSOR_ARCHITECTURE_MSIL 8
+#define PROCESSOR_ARCHITECTURE_AMD64 9
+#define PROCESSOR_ARCHITECTURE_IA32_ON_WIN64 10
+#define PROCESSOR_ARCHITECTURE_ARM64 12
+
+static const tchar *
+describe_arch(u64 arch)
{
- 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;
-}
+ static const tchar * const descriptions[] = {
+ [PROCESSOR_ARCHITECTURE_INTEL] = T("x86"),
+ [PROCESSOR_ARCHITECTURE_MIPS] = T("MIPS"),
+ [PROCESSOR_ARCHITECTURE_ARM] = T("ARM"),
+ [PROCESSOR_ARCHITECTURE_IA64] = T("ia64"),
+ [PROCESSOR_ARCHITECTURE_AMD64] = T("x86_64"),
+ [PROCESSOR_ARCHITECTURE_ARM64] = T("ARM64"),
+ };
-#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
-void xml_set_memory_allocator(void *(*malloc_func)(size_t),
- void (*free_func)(void *),
- void *(*realloc_func)(void *, size_t))
-{
- xmlMemSetup(free_func, malloc_func, realloc_func, STRDUP);
+ if (arch < ARRAY_LEN(descriptions) && descriptions[arch] != NULL)
+ return descriptions[arch];
+
+ return T("unknown");
}
-#endif
-static int calculate_dentry_statistics(struct dentry *dentry, void *arg)
+/* Print information from the WINDOWS element, if present. */
+static void
+print_windows_info(struct xml_node *image_node)
{
- 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;
-
- /* Update directory count and file count.
- *
- * Each dentry counts as either a file or a directory, but not both.
- * The root directory is an exception: it is not counted at all.
- *
- * Symbolic links and junction points (and presumably other reparse
- * points) count as regular files. This is despite the fact that
- * junction points have FILE_ATTRIBUTE_DIRECTORY set.
- */
- if (dentry_is_root(dentry))
- return 0;
+ struct xml_node *windows_node;
+ struct xml_node *langs_node;
+ struct xml_node *version_node;
+ const tchar *text;
- if (inode_is_directory(inode))
- info->dir_count++;
- else
- info->file_count++;
-
- /*
- * Update total bytes and hard link bytes.
- *
- * Unfortunately there are some inconsistencies/bugs in the way this is
- * done.
- *
- * If there are no alternate data streams in the image, the "total
- * bytes" is the sum of the size of the un-named data stream of each
- * inode times the link count of that inode. In other words, it would
- * be the total number of bytes of regular files you would have if you
- * extracted the full image without any hard-links. The "hard link
- * bytes" is equal to the "total bytes" minus the size of the un-named
- * data stream of each inode. In other words, the "hard link bytes"
- * counts the size of the un-named data stream for all the links to each
- * inode except the first one.
- *
- * Reparse points and directories don't seem to be counted in either the
- * total bytes or the hard link bytes.
- *
- * And now we get to the most confusing part, the alternate data
- * streams. They are not counted in the "total bytes". However, if the
- * link count of an inode with alternate data streams is 2 or greater,
- * the size of all the alternate data streams is included in the "hard
- * link bytes", and this size is multiplied by the link count (NOT one
- * less than the link count).
- */
- lte = inode_unnamed_lte(inode, info->lookup_table);
- if (lte) {
- info->total_bytes += wim_resource_size(lte);
- if (!dentry_is_first_in_inode(dentry))
- info->hard_link_bytes += wim_resource_size(lte);
- }
+ windows_node = xml_get_element_by_path(image_node, T("WINDOWS"));
+ if (!windows_node)
+ return;
+
+ tprintf(T("Architecture: %"TS"\n"),
+ describe_arch(xml_get_number_by_path(windows_node, T("ARCH"))));
+
+ text = xml_get_text_by_path(windows_node, T("PRODUCTNAME"));
+ if (text)
+ tprintf(T("Product Name: %"TS"\n"), text);
+
+ text = xml_get_text_by_path(windows_node, T("EDITIONID"));
+ if (text)
+ tprintf(T("Edition ID: %"TS"\n"), text);
- 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) {
- lte = inode_stream_lte(inode, i + 1, lookup_table);
- if (lte) {
- info->hard_link_bytes += inode->link_count *
- wim_resource_size(lte);
- }
- }
+ text = xml_get_text_by_path(windows_node, T("INSTALLATIONTYPE"));
+ if (text)
+ tprintf(T("Installation Type: %"TS"\n"), text);
+
+ text = xml_get_text_by_path(windows_node, T("HAL"));
+ if (text)
+ tprintf(T("HAL: %"TS"\n"), text);
+
+ text = xml_get_text_by_path(windows_node, T("PRODUCTTYPE"));
+ if (text)
+ tprintf(T("Product Type: %"TS"\n"), text);
+
+ text = xml_get_text_by_path(windows_node, T("PRODUCTSUITE"));
+ if (text)
+ tprintf(T("Product Suite: %"TS"\n"), text);
+
+ langs_node = xml_get_element_by_path(windows_node, T("LANGUAGES"));
+ if (langs_node) {
+ struct xml_node *lang_node;
+
+ tprintf(T("Languages: "));
+ xml_node_for_each_child(langs_node, lang_node) {
+ if (!xml_node_is_element(lang_node, T("LANGUAGE")))
+ continue;
+ text = xml_element_get_text(lang_node);
+ if (!text)
+ continue;
+ tprintf(T("%"TS" "), text);
}
+ tputchar(T('\n'));
+
+ text = xml_get_text_by_path(langs_node, T("DEFAULT"));
+ if (text)
+ tprintf(T("Default Language: %"TS"\n"), text);
+ }
+
+ text = xml_get_text_by_path(windows_node, T("SYSTEMROOT"));
+ if (text)
+ tprintf(T("System Root: %"TS"\n"), text);
+
+ version_node = xml_get_element_by_path(windows_node, T("VERSION"));
+ if (version_node) {
+ tprintf(T("Major Version: %"PRIu64"\n"),
+ xml_get_number_by_path(version_node, T("MAJOR")));
+ tprintf(T("Minor Version: %"PRIu64"\n"),
+ xml_get_number_by_path(version_node, T("MINOR")));
+ tprintf(T("Build: %"PRIu64"\n"),
+ xml_get_number_by_path(version_node, T("BUILD")));
+ tprintf(T("Service Pack Build: %"PRIu64"\n"),
+ xml_get_number_by_path(version_node, T("SPBUILD")));
+ tprintf(T("Service Pack Level: %"PRIu64"\n"),
+ xml_get_number_by_path(version_node, T("SPLEVEL")));
}
- return 0;
}
-void xml_update_image_info(WIMStruct *w, int image)
+/* Prints information about the specified image. */
+void
+xml_print_image_info(struct wim_xml_info *info, int image)
{
- struct image_info *image_info;
- char *flags_save;
+ struct xml_node * const image_node = info->images[image - 1];
+ const tchar *text;
+ tchar timebuf[64];
- DEBUG("Updating the image info for image %d", image);
+ tprintf(T("Index: %d\n"), image);
- image_info = &w->wim_info->images[image - 1];
+ /* Always print the Name and Description, even if the corresponding XML
+ * elements are not present. */
+ text = xml_get_text_by_path(image_node, T("NAME"));
+ tprintf(T("Name: %"TS"\n"), text ? text : T(""));
+ text = xml_get_text_by_path(image_node, T("DESCRIPTION"));
+ tprintf(T("Description: %"TS"\n"), text ? text : T(""));
- image_info->file_count = 0;
- image_info->dir_count = 0;
- image_info->total_bytes = 0;
- image_info->hard_link_bytes = 0;
+ text = xml_get_text_by_path(image_node, T("DISPLAYNAME"));
+ if (text)
+ tprintf(T("Display Name: %"TS"\n"), text);
- flags_save = image_info->flags;
- image_info->lookup_table = w->lookup_table;
+ text = xml_get_text_by_path(image_node, T("DISPLAYDESCRIPTION"));
+ if (text)
+ tprintf(T("Display Description: %"TS"\n"), text);
- for_dentry_in_tree(w->image_metadata[image - 1].root_dentry,
- calculate_dentry_statistics,
- image_info);
+ tprintf(T("Directory Count: %"PRIu64"\n"),
+ xml_get_number_by_path(image_node, T("DIRCOUNT")));
- image_info->lookup_table = NULL;
- image_info->flags = flags_save;
- image_info->last_modification_time = get_wim_timestamp();
-}
+ tprintf(T("File Count: %"PRIu64"\n"),
+ xml_get_number_by_path(image_node, T("FILECOUNT")));
-/* Adds an image to the XML information. */
-int xml_add_image(WIMStruct *w, const char *name)
-{
- struct wim_info *wim_info;
- struct image_info *image_info;
+ tprintf(T("Total Bytes: %"PRIu64"\n"),
+ xml_get_number_by_path(image_node, T("TOTALBYTES")));
- wimlib_assert(name);
+ tprintf(T("Hard Link Bytes: %"PRIu64"\n"),
+ xml_get_number_by_path(image_node, T("HARDLINKBYTES")));
- DEBUG("Adding image: name = %s", name);
+ wim_timestamp_to_str(xml_get_timestamp_by_path(image_node,
+ T("CREATIONTIME")),
+ timebuf, ARRAY_LEN(timebuf));
+ tprintf(T("Creation Time: %"TS"\n"), timebuf);
- /* 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");
- return WIMLIB_ERR_NOMEM;
- }
- }
+ wim_timestamp_to_str(xml_get_timestamp_by_path(image_node,
+ T("LASTMODIFICATIONTIME")),
+ timebuf, ARRAY_LEN(timebuf));
+ tprintf(T("Last Modification Time: %"TS"\n"), timebuf);
- image_info = add_image_info_struct(wim_info);
- if (!image_info)
- goto out_free_wim_info;
+ print_windows_info(image_node);
- if (!(image_info->name = STRDUP(name)))
- goto out_destroy_image_info;
+ text = xml_get_text_by_path(image_node, T("FLAGS"));
+ if (text)
+ tprintf(T("Flags: %"TS"\n"), text);
- w->wim_info = wim_info;
- image_info->index = wim_info->num_images;
- image_info->creation_time = get_wim_timestamp();
- xml_update_image_info(w, image_info->index);
- return 0;
+ tprintf(T("WIMBoot compatible: %"TS"\n"),
+ xml_get_number_by_path(image_node, T("WIMBOOT")) ?
+ T("yes") : T("no"));
-out_destroy_image_info:
- destroy_image_info(image_info);
- wim_info->num_images--;
-out_free_wim_info:
- if (wim_info != w->wim_info)
- FREE(wim_info);
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
+ tputchar('\n');
}
-/* Prints information about the specified image from struct wim_info structure.
- * */
-void print_image_info(const struct wim_info *wim_info, int image)
+/*----------------------------------------------------------------------------*
+ * Reading and writing the XML data *
+ *----------------------------------------------------------------------------*/
+
+static int
+image_element_get_index(struct xml_node *element)
{
- const struct image_info *image_info;
- const char *desc;
- time_t time;
- char *p;
-
- wimlib_assert(image >= 1 && image <= wim_info->num_images);
-
- image_info = &wim_info->images[image - 1];
-
- printf("Index: %"PRIu64"\n", image_info->index);
- printf("Name: %s\n", image_info->name);
-
- /* Always print the Description: part even if there is no
- * description. */
- if (image_info->description)
- desc = image_info->description;
- else
- desc = "";
- printf("Description: %s\n", desc);
-
- if (image_info->display_name)
- printf("Display Name: %s\n",
- image_info->display_name);
-
- if (image_info->display_description)
- printf("Display Description: %s\n",
- image_info->display_description);
-
- printf("Directory Count: %"PRIu64"\n", image_info->dir_count);
- printf("File Count: %"PRIu64"\n", image_info->file_count);
- 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);
-
- 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);
- if (image_info->windows_info_exists)
- print_windows_info(&image_info->windows_info);
- if (image_info->flags)
- printf("Flags: %s\n", image_info->flags);
- putchar('\n');
+ struct xml_node *attrib = xml_get_attrib(element, T("INDEX"));
+
+ if (!attrib)
+ return 0;
+ return min(INT_MAX, parse_number(attrib->value, 10));
}
-/*
- * Reads the XML data from a WIM file.
- */
-int read_xml_data(FILE *fp, const struct resource_entry *res,
- u8 **xml_data_ret, struct wim_info **info_ret)
+/* Prepare the 'images' array from the XML document tree. */
+static int
+setup_images(struct wim_xml_info *info, struct xml_node *root)
{
- u8 *xml_data;
- xmlDoc *doc;
- xmlNode *root;
+ struct xml_node *child;
+ int index;
+ int max_index = 0;
int ret;
- DEBUG("XML data is %"PRIu64" bytes at offset %"PRIu64"",
- (u64)res->size, res->offset);
-
- if (resource_is_compressed(res)) {
- 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");
- ret = WIMLIB_ERR_XML;
- goto out_cleanup_parser;
- }
-
- xml_data = MALLOC(res->size + 2);
- if (!xml_data) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_cleanup_parser;
+ xml_node_for_each_child(root, child) {
+ if (!xml_node_is_element(child, T("IMAGE")))
+ continue;
+ index = image_element_get_index(child);
+ if (unlikely(index < 1 || info->image_count >= MAX_IMAGES))
+ goto err_indices;
+ max_index = max(max_index, index);
+ info->image_count++;
+ }
+ if (unlikely(max_index != info->image_count))
+ goto err_indices;
+ ret = WIMLIB_ERR_NOMEM;
+ info->images = CALLOC(info->image_count, sizeof(info->images[0]));
+ if (unlikely(!info->images))
+ goto err;
+ xml_node_for_each_child(root, child) {
+ if (!xml_node_is_element(child, T("IMAGE")))
+ continue;
+ index = image_element_get_index(child);
+ if (unlikely(info->images[index - 1]))
+ goto err_indices;
+ info->images[index - 1] = child;
}
- ret = read_uncompressed_resource(fp, res->offset, res->size, xml_data);
- if (ret != 0)
- goto out_free_xml_data;
+ return 0;
- xml_data[res->size] = 0;
- xml_data[res->size + 1] = 0;
+err_indices:
+ ERROR("The WIM file's XML document does not contain exactly one IMAGE "
+ "element per image!");
+ ret = WIMLIB_ERR_XML;
+err:
+ FREE(info->images);
+ return ret;
+}
- DEBUG("Parsing XML using libxml2 to create XML tree.");
+static int
+parse_wim_xml_document(const utf16lechar *raw_doc, size_t raw_doc_size,
+ struct xml_node **root_ret)
+{
+ tchar *doc;
+ int ret;
- doc = xmlReadMemory(xml_data, res->size, "noname.xml", "UTF-16", 0);
+ ret = utf16le_to_tstr(raw_doc, raw_doc_size, &doc, NULL);
+ if (ret)
+ return ret;
+ ret = xml_parse_document(doc, root_ret);
+ FREE(doc);
+ return ret;
+}
+/* Reads the XML data from a WIM file. */
+int
+read_wim_xml_data(WIMStruct *wim)
+{
+ struct wim_xml_info *info;
+ void *raw_doc;
+ size_t raw_doc_size;
+ struct xml_node *root;
+ int ret;
- if (!doc) {
- ERROR("Failed to parse XML data");
- ret = WIMLIB_ERR_XML;
- goto out_free_xml_data;
- }
+ /* Allocate the 'struct wim_xml_info'. */
+ ret = WIMLIB_ERR_NOMEM;
+ info = CALLOC(1, sizeof(*info));
+ if (!info)
+ goto err;
- DEBUG("Constructing WIM information structure from XML tree.");
+ /* Read the raw UTF-16LE XML document. */
+ ret = wimlib_get_xml_data(wim, &raw_doc, &raw_doc_size);
+ if (ret)
+ goto err;
- root = xmlDocGetRootElement(doc);
- if (!root) {
- ERROR("Empty XML document");
- ret = WIMLIB_ERR_XML;
- goto out_free_doc;
+ /* Parse the document, creating the document tree. */
+ ret = parse_wim_xml_document(raw_doc, raw_doc_size, &info->root);
+ FREE(raw_doc);
+ raw_doc = NULL;
+ if (ret) {
+ if (ret != WIMLIB_ERR_NOMEM)
+ ret = WIMLIB_ERR_XML;
+ ERROR("Unable to parse the WIM file's XML document!");
+ goto err;
}
+ root = info->root;
- if (!node_is_element(root) || !node_name_is(root, "WIM")) {
- ERROR("Expected <WIM> for the root XML element (found <%s>)",
- root->name);
+ /* Verify the root element. */
+ if (!xml_node_is_element(root, T("WIM"))) {
+ ERROR("The WIM file's XML document has an unexpected format!");
ret = WIMLIB_ERR_XML;
- goto out_free_doc;
+ goto err;
}
- ret = xml_read_wim_info(root, info_ret);
- if (ret != 0)
- goto out_free_doc;
+ /* Verify the WIM file is not encrypted. */
+ if (xml_get_element_by_path(root, T("ESD/ENCRYPTED"))) {
+ ret = WIMLIB_ERR_WIM_IS_ENCRYPTED;
+ goto err;
+ }
- DEBUG("Freeing XML tree.");
+ /* Validate the image elements and set up the images[] array. */
+ ret = setup_images(info, root);
+ if (ret)
+ goto err;
- xmlFreeDoc(doc);
- xmlCleanupParser();
- *xml_data_ret = xml_data;
+ /* Success! */
+ wim->xml_info = info;
return 0;
-out_free_doc:
- xmlFreeDoc(doc);
-out_free_xml_data:
- FREE(xml_data);
-out_cleanup_parser:
- xmlCleanupParser();
+
+err:
+ xml_free_info_struct(info);
return ret;
}
-#define CHECK_RET ({ if (ret < 0) { \
- ERROR("Error writing XML data"); \
- ret = WIMLIB_ERR_WRITE; \
- goto out_free_text_writer; \
- } })
-
-/*
- * Writes XML data to a WIM file.
- *
- * If @total_bytes is non-zero, it specifies what to write to the TOTALBYTES
- * element in the XML data. If zero, TOTALBYTES is given the default value of
- * the offset of the XML data.
- */
-int write_xml_data(const struct wim_info *wim_info, int image, FILE *out,
- u64 total_bytes, struct resource_entry *out_res_entry)
+/* Swap the INDEX attributes of two IMAGE elements. */
+static void
+swap_index_attributes(struct xml_node *image_element_1,
+ struct xml_node *image_element_2)
{
- xmlBuffer *buf;
- 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;
-
- wimlib_assert(image == WIM_ALL_IMAGES ||
- (wim_info != NULL && image >= 1 &&
- image <= wim_info->num_images));
-
- start_offset = ftello(out);
- if (start_offset == -1)
- return WIMLIB_ERR_WRITE;
-
- /* The contents of the <TOTALBYTES> element in the XML data, under the
- * <WIM> element not the <IMAGE> 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;
- }
+ struct xml_node *attr_1, *attr_2;
- DEBUG("Creating XML buffer and text writer.");
- buf = xmlBufferCreate();
- if (!buf) {
- ERROR("Failed to allocate XML buffer");
- ret = WIMLIB_ERR_NOMEM;
- goto out;
- }
- writer = xmlNewTextWriterMemory(buf, 0);
- if (!writer) {
- ERROR("Failed to allocate XML writer");
- ret = WIMLIB_ERR_NOMEM;
- goto out_buffer_free;
+ if (image_element_1 != image_element_2) {
+ attr_1 = unlink_index_attribute(image_element_1);
+ attr_2 = unlink_index_attribute(image_element_2);
+ xml_add_child(image_element_1, attr_2);
+ xml_add_child(image_element_2, attr_1);
}
+}
- /* 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 <WIM> element");
- ret = xmlTextWriterStartElement(writer, "WIM");
- CHECK_RET;
-
- ret = xmlTextWriterWriteFormatElement(writer, "TOTALBYTES", "%"PRIu64,
- total_bytes);
- CHECK_RET;
-
- if (wim_info != NULL) {
- DEBUG("Writing %d <IMAGE> elements", (int)wim_info->num_images);
- for (int i = 1; i <= (int)wim_info->num_images; i++) {
- if (image != WIM_ALL_IMAGES && i != image)
- continue;
- DEBUG("Writing <IMAGE> element for image %d", i);
- ret = xml_write_image_info(writer, &wim_info->images[i - 1]);
- CHECK_RET;
- }
+static int
+prepare_document_for_write(struct wim_xml_info *info, int image, u64 total_bytes,
+ struct xml_node **orig_totalbytes_element_ret)
+{
+ struct xml_node *totalbytes_element = NULL;
+
+ /* Allocate the new TOTALBYTES element if needed. */
+ if (total_bytes != WIM_TOTALBYTES_USE_EXISTING &&
+ total_bytes != WIM_TOTALBYTES_OMIT) {
+ totalbytes_element = xml_new_element_with_u64(
+ NULL, T("TOTALBYTES"), total_bytes);
+ if (!totalbytes_element)
+ return WIMLIB_ERR_NOMEM;
}
- ret = xmlTextWriterEndElement(writer);
- CHECK_RET;
+ /* Adjust the IMAGE elements if needed. */
+ if (image != WIMLIB_ALL_IMAGES) {
+ /* We're writing a single image only. Temporarily unlink all
+ * other IMAGE elements from the document. */
+ for (int i = 0; i < info->image_count; i++)
+ if (i + 1 != image)
+ xml_unlink_node(info->images[i]);
- ret = xmlTextWriterEndDocument(writer);
- CHECK_RET;
-
- 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);
+ /* Temporarily set the INDEX attribute of the needed IMAGE
+ * element to 1. */
+ swap_index_attributes(info->images[0], info->images[image - 1]);
+ }
- DEBUG("XML UTF-8 length = %zu", len);
+ /* Adjust (add, change, or remove) the TOTALBYTES element if needed. */
+ *orig_totalbytes_element_ret = NULL;
+ if (total_bytes != WIM_TOTALBYTES_USE_EXISTING) {
+ /* Unlink the previous TOTALBYTES element, if any. */
+ *orig_totalbytes_element_ret = xml_get_element_by_path(
+ info->root, T("TOTALBYTES"));
+ if (*orig_totalbytes_element_ret)
+ xml_unlink_node(*orig_totalbytes_element_ret);
- utf16_str = utf8_to_utf16(content, len, &utf16_len);
- if (!utf16_str) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_text_writer;
+ /* Link in the new TOTALBYTES element, if any. */
+ if (totalbytes_element)
+ xml_add_child(info->root, totalbytes_element);
}
+ return 0;
+}
- DEBUG("XML UTF-16 length = %zu", utf16_len);
+static void
+restore_document_after_write(struct wim_xml_info *info, int image,
+ struct xml_node *orig_totalbytes_element)
+{
+ /* Restore the IMAGE elements if needed. */
+ if (image != WIMLIB_ALL_IMAGES) {
+ /* We wrote a single image only. Re-link all other IMAGE
+ * elements to the document. */
+ for (int i = 0; i < info->image_count; i++)
+ if (i + 1 != image)
+ xml_add_child(info->root, info->images[i]);
- 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;
+ /* Restore the original INDEX attributes. */
+ swap_index_attributes(info->images[0], info->images[image - 1]);
}
- DEBUG("Cleaning up.");
+ /* Restore the original TOTALBYTES element if needed. */
+ if (orig_totalbytes_element)
+ xml_replace_child(info->root, orig_totalbytes_element);
+}
- end_offset = ftello(out);
- if (end_offset == -1) {
- ret = WIMLIB_ERR_WRITE;
- goto out_free_utf16_str;
- }
+/*
+ * Writes the XML data to a WIM file.
+ *
+ * 'image' specifies the image(s) to include in the XML data. Normally it is
+ * WIMLIB_ALL_IMAGES, but it can also be a 1-based image index.
+ *
+ * 'total_bytes' is the number to use in the top-level TOTALBYTES element, or
+ * WIM_TOTALBYTES_USE_EXISTING to use the existing value from the XML document
+ * (if any), or WIM_TOTALBYTES_OMIT to omit the TOTALBYTES element entirely.
+ */
+int
+write_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
+ struct wim_reshdr *out_reshdr, int write_resource_flags)
+{
+ struct wim_xml_info *info = wim->xml_info;
+ int ret;
+ struct xml_node *orig_totalbytes_element;
+ struct xml_out_buf buf = {};
+ const utf16lechar *raw_doc;
+ size_t raw_doc_size;
+
+ /* Make any needed temporary changes to the document. */
+ ret = prepare_document_for_write(info, image, total_bytes,
+ &orig_totalbytes_element);
+ if (ret)
+ goto out;
- 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(writer);
-out_buffer_free:
- xmlBufferFree(buf);
+ ret = xml_write_document(info->root, &buf);
+ if (ret)
+ goto out_restore_document;
+
+ ret = tstr_get_utf16le_and_len(buf.buf, &raw_doc, &raw_doc_size);
+ if (ret)
+ goto out_restore_document;
+
+ /* Write the XML data uncompressed. Although wimlib can handle
+ * compressed XML data, some other WIM software cannot. */
+ ret = write_wim_resource_from_buffer(raw_doc, raw_doc_size,
+ true,
+ &wim->out_fd,
+ WIMLIB_COMPRESSION_TYPE_NONE,
+ 0,
+ out_reshdr,
+ NULL,
+ write_resource_flags);
+ tstr_put_utf16le(raw_doc);
+out_restore_document:
+ /* Revert any temporary changes we made to the document. */
+ restore_document_after_write(info, image, orig_totalbytes_element);
+ FREE(buf.buf);
out:
return ret;
}
-/* Returns the name of the specified image. */
-WIMLIBAPI const char *wimlib_get_image_name(const WIMStruct *w, int image)
+/*----------------------------------------------------------------------------*
+ * Library API functions *
+ *----------------------------------------------------------------------------*/
+
+WIMLIBAPI int
+wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret)
{
- DEBUG("Getting the name of image %d", image);
- if (image < 1 || image > w->hdr.image_count)
- return NULL;
+ const struct wim_reshdr *xml_reshdr;
+
+ if (wim->filename == NULL && filedes_is_seekable(&wim->in_fd))
+ return WIMLIB_ERR_NO_FILENAME;
+
+ if (buf_ret == NULL || bufsize_ret == NULL)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ xml_reshdr = &wim->hdr.xml_data_reshdr;
- return w->wim_info->images[image - 1].name;
+ *bufsize_ret = xml_reshdr->uncompressed_size;
+ return wim_reshdr_to_data(xml_reshdr, wim, buf_ret);
}
-/* Returns the description of the specified image. */
-WIMLIBAPI const char *wimlib_get_image_description(const WIMStruct *w,
- int image)
+WIMLIBAPI int
+wimlib_extract_xml_data(WIMStruct *wim, FILE *fp)
{
- DEBUG("Getting the description of image %d", image);
- if (image < 1 || image > w->hdr.image_count)
- return NULL;
+ int ret;
+ void *buf;
+ size_t bufsize;
+
+ ret = wimlib_get_xml_data(wim, &buf, &bufsize);
+ if (ret)
+ return ret;
- return w->wim_info->images[image - 1].description;
+ if (fwrite(buf, 1, bufsize, fp) != bufsize) {
+ ERROR_WITH_ERRNO("Failed to extract XML data");
+ ret = WIMLIB_ERR_WRITE;
+ }
+ FREE(buf);
+ return ret;
}
-/* 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)
+static bool
+image_name_in_use(const WIMStruct *wim, const tchar *name, int excluded_image)
{
- int i;
+ const struct wim_xml_info *info = wim->xml_info;
+ const tchar *existing_name;
- DEBUG("Checking to see if the image name `%s' is already in use", name);
- if (!name || !w->wim_info)
+ /* Any number of images can have "no name". */
+ if (!name || !*name)
return false;
- for (i = 1; i <= w->wim_info->num_images; i++)
- if (strcmp(w->wim_info->images[i - 1].name, name) == 0)
- return true;
+ /* Check for images that have the specified name. */
+ for (int i = 0; i < info->image_count; i++) {
+ if (i + 1 == excluded_image)
+ continue;
+ existing_name = xml_get_text_by_path(info->images[i],
+ T("NAME"));
+ if (existing_name && !tstrcmp(existing_name, name))
+ return true;
+ }
return false;
}
-WIMLIBAPI int wimlib_extract_xml_data(WIMStruct *w, FILE *fp)
+WIMLIBAPI bool
+wimlib_image_name_in_use(const WIMStruct *wim, const tchar *name)
{
- DEBUG("Extracting the XML data.");
- 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");
- return WIMLIB_ERR_WRITE;
- }
- return 0;
+ return image_name_in_use(wim, name, WIMLIB_NO_IMAGE);
}
-/* Sets the name of an image in the WIM. */
-WIMLIBAPI int wimlib_set_image_name(WIMStruct *w, int image, const char *name)
+WIMLIBAPI const tchar *
+wimlib_get_image_name(const WIMStruct *wim, int image)
{
- char *p;
- int i;
+ const struct wim_xml_info *info = wim->xml_info;
+ const tchar *name;
- DEBUG("Setting the name of image %d to %s", image, name);
+ if (image < 1 || image > info->image_count)
+ return NULL;
+ name = wimlib_get_image_property(wim, image, T("NAME"));
+ return name ? name : T("");
+}
- if (!w)
- return WIMLIB_ERR_INVALID_PARAM;
+WIMLIBAPI const tchar *
+wimlib_get_image_description(const WIMStruct *wim, int image)
+{
+ return wimlib_get_image_property(wim, image, T("DESCRIPTION"));
+}
- 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;
- }
+WIMLIBAPI const tchar *
+wimlib_get_image_property(const WIMStruct *wim, int image,
+ const tchar *property_name)
+{
+ const struct wim_xml_info *info = wim->xml_info;
- for (i = 1; i <= w->hdr.image_count; i++) {
- if (i == image)
- continue;
- if (strcmp(w->wim_info->images[i - 1].name, name) == 0) {
- ERROR("The name `%s' is already used for image %d",
- name, i);
- return WIMLIB_ERR_IMAGE_NAME_COLLISION;
- }
- }
+ if (!property_name || !*property_name)
+ return NULL;
+ if (image < 1 || image > info->image_count)
+ return NULL;
+ return xml_get_text_by_path(info->images[image - 1], property_name);
+}
- p = STRDUP(name);
- if (!p) {
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
- }
- FREE(w->wim_info->images[image - 1].name);
- w->wim_info->images[image - 1].name = p;
- return 0;
+WIMLIBAPI int
+wimlib_set_image_name(WIMStruct *wim, int image, const tchar *name)
+{
+ return wimlib_set_image_property(wim, image, T("NAME"), name);
}
-/* Sets the description of an image in the WIM. */
-WIMLIBAPI int wimlib_set_image_descripton(WIMStruct *w, int image,
- const char *description)
+WIMLIBAPI int
+wimlib_set_image_descripton(WIMStruct *wim, int image, const tchar *description)
{
- char *p;
+ return wimlib_set_image_property(wim, image, T("DESCRIPTION"),
+ description);
+}
+
+WIMLIBAPI int
+wimlib_set_image_flags(WIMStruct *wim, int image, const tchar *flags)
+{
+ return wimlib_set_image_property(wim, image, T("FLAGS"), flags);
+}
- DEBUG("Setting the description of image %d to %s", image, description);
+WIMLIBAPI int
+wimlib_set_image_property(WIMStruct *wim, int image, const tchar *property_name,
+ const tchar *property_value)
+{
+ struct wim_xml_info *info = wim->xml_info;
- if (!w)
+ if (!property_name || !*property_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;
+ if (!xml_legal_path(property_name)) {
+ ERROR("Property name '%"TS"' is illegal in XML", property_name);
+ return WIMLIB_ERR_INVALID_PARAM;
}
- if (description) {
- p = STRDUP(description);
- if (!p) {
- ERROR("Out of memory");
- return WIMLIB_ERR_NOMEM;
- }
- } else {
- p = NULL;
+
+ if (property_value && !xml_legal_value(property_value)) {
+ WARNING("Value of property '%"TS"' contains illegal characters",
+ property_name);
+ return WIMLIB_ERR_INVALID_PARAM;
}
- FREE(w->wim_info->images[image - 1].description);
- w->wim_info->images[image - 1].description = p;
- return 0;
-}
-WIMLIBAPI int wimlib_set_image_flags(WIMStruct *w, int image,
- const char *flags)
-{
- char *p;
+ if (image < 1 || image > info->image_count)
+ return WIMLIB_ERR_INVALID_IMAGE;
- DEBUG("Setting the flags of image %d to %s", image, flags);
+ if (!tstrcmp(property_name, T("NAME")) &&
+ image_name_in_use(wim, property_value, image))
+ return WIMLIB_ERR_IMAGE_NAME_COLLISION;
- 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");
- return WIMLIB_ERR_NOMEM;
- }
- } else {
- p = NULL;
- }
- FREE(w->wim_info->images[image - 1].flags);
- w->wim_info->images[image - 1].flags = p;
- return 0;
+ return xml_set_text_by_path(info->images[image - 1], property_name,
+ property_value);
}
git://wimlib.net / wimlib / blobdiff