]> wimlib.net Git - wimlib/blobdiff - src/xml.c
xml.c: Minor cleanup
[wimlib] / src / xml.c
index 419dfd8a82e8d5af38f057e7e0a337787a91c14f..87927ed7e2d03622468b57ecd3d34c103ff20465 100644 (file)
--- a/src/xml.c
+++ b/src/xml.c
@@ -36,6 +36,7 @@
 #include "wimlib/resource.h"
 #include "wimlib/timestamp.h"
 #include "wimlib/xml.h"
+#include "wimlib/write.h"
 
 #include <libxml/encoding.h>
 #include <libxml/parser.h>
@@ -61,6 +62,7 @@ struct windows_info {
        tchar   *product_name;
        tchar   *edition_id;
        tchar   *installation_type;
+       tchar   *pkeyconfigversion;
        tchar   *hal;
        tchar   *product_type;
        tchar   *product_suite;
@@ -87,6 +89,10 @@ struct image_info {
        tchar *display_name;
        tchar *display_description;
        tchar *flags;
+       bool wimboot;
+
+       /* Note: must update clone_image_info() if adding new fields here  */
+
        struct wim_lookup_table *lookup_table; /* temporary field */
 };
 
@@ -132,42 +138,80 @@ windows_info_xml_string_specs[] = {
 u64
 wim_info_get_total_bytes(const struct wim_info *info)
 {
-       if (!info)
+       if (info)
+               return info->total_bytes;
+       else
                return 0;
-       return info->total_bytes;
 }
 
 u64
 wim_info_get_image_hard_link_bytes(const struct wim_info *info, int image)
 {
-       return info->images[image - 1].hard_link_bytes;
+       if (info)
+               return info->images[image - 1].hard_link_bytes;
+       else
+               return 0;
 }
 
 u64
 wim_info_get_image_total_bytes(const struct wim_info *info, int image)
 {
-       return info->images[image - 1].total_bytes;
+       if (info)
+               return info->images[image - 1].total_bytes;
+       else
+               return 0;
 }
 
 unsigned
 wim_info_get_num_images(const struct wim_info *info)
 {
-       return info->num_images;
+       if (info)
+               return info->num_images;
+       else
+               return 0;
+}
+
+void
+wim_info_set_wimboot(struct wim_info *info, int image, bool value)
+{
+       info->images[image - 1].wimboot = value;
+}
+
+bool
+wim_info_get_wimboot(const struct wim_info *info, int image)
+{
+       return info->images[image - 1].wimboot;
 }
 
+/* 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
+
 /* Returns a statically allocated string that is a string representation of the
  * architecture number. */
 static const tchar *
 get_arch(int arch)
 {
        switch (arch) {
-       case 0:
+       case PROCESSOR_ARCHITECTURE_INTEL:
                return T("x86");
-       case 6:
+       case PROCESSOR_ARCHITECTURE_MIPS:
+               return T("MIPS");
+       case PROCESSOR_ARCHITECTURE_ARM:
+               return T("ARM");
+       case PROCESSOR_ARCHITECTURE_IA64:
                return T("ia64");
-       case 9:
+       case PROCESSOR_ARCHITECTURE_AMD64:
                return T("x86_64");
-       /* XXX Are there other arch values? */
        default:
                return T("unknown");
        }
@@ -228,18 +272,13 @@ static int
 node_get_string(const xmlNode *string_node, tchar **tstr_ret)
 {
        xmlNode *child;
-       tchar *tstr = NULL;
-       int ret;
 
-       for_node_child(string_node, child) {
-               if (node_is_text(child) && child->content) {
-                       ret = utf8_to_tstr_simple(child->content, &tstr);
-                       if (ret)
-                               return ret;
-                       break;
-               }
-       }
-       *tstr_ret = tstr;
+       if (*tstr_ret)
+               return 0;
+
+       for_node_child(string_node, child)
+               if (node_is_text(child) && child->content)
+                       return utf8_to_tstr_simple(child->content, tstr_ret);
        return 0;
 }
 
@@ -287,6 +326,7 @@ destroy_windows_info(struct windows_info *windows_info)
        FREE(windows_info->hal);
        FREE(windows_info->product_type);
        FREE(windows_info->product_suite);
+       FREE(windows_info->pkeyconfigversion);
        for (size_t i = 0; i < windows_info->num_languages; i++)
                FREE(windows_info->languages[i]);
        FREE(windows_info->languages);
@@ -422,7 +462,19 @@ xml_read_windows_info(const xmlNode *windows_node,
                        ret = node_get_string(child, &windows_info->system_root);
                } else if (node_name_is(child, "HAL")) {
                        ret = node_get_string(child, &windows_info->hal);
+               } else if (node_name_is(child, "SERVICINGDATA")) {
+                       xmlNode *grandchild;
+
+                       for_node_child(child, grandchild) {
+                               if (node_is_element(grandchild) &&
+                                   node_name_is(grandchild, "PKEYCONFIGVERSION"))
+                               {
+                                       ret = node_get_string(grandchild,
+                                                             &windows_info->pkeyconfigversion);
+                               }
+                       }
                }
+
                if (ret != 0)
                        return ret;
        }
@@ -462,7 +514,6 @@ xml_read_image_info(xmlNode *image_node, struct image_info *image_info)
                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;
@@ -476,13 +527,16 @@ xml_read_image_info(xmlNode *image_node, struct image_info *image_info)
                        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);
+               } else if (node_name_is(child, "WIMBOOT")) {
+                       if (node_get_u64(child) == 1) {
+                               image_info->wimboot = true;
+                       }
                }
                if (ret != 0)
                        return ret;
        }
        if (!image_info->name) {
                tchar *empty_name;
-               /*WARNING("Image with index %d has no name", image_info->index);*/
                empty_name = MALLOC(sizeof(tchar));
                if (!empty_name)
                        return WIMLIB_ERR_NOMEM;
@@ -511,8 +565,9 @@ xml_read_wim_info(const xmlNode *wim_node, struct wim_info **wim_info_ret)
        num_images = 0;
        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;
+                       if (unlikely(num_images == MAX_IMAGES)) {
+                               ret = WIMLIB_ERR_IMAGE_COUNT;
+                               goto err;
                        }
                        num_images++;
                }
@@ -531,7 +586,6 @@ xml_read_wim_info(const xmlNode *wim_node, struct wim_info **wim_info_ret)
                        if (!node_is_element(child))
                                continue;
                        if (node_name_is(child, "IMAGE")) {
-                               DEBUG("Found <IMAGE> tag");
                                ret = xml_read_image_info(child,
                                                          &wim_info->images[i]);
                                if (ret != 0)
@@ -539,6 +593,16 @@ xml_read_wim_info(const xmlNode *wim_node, struct wim_info **wim_info_ret)
                                i++;
                        } else if (node_name_is(child, "TOTALBYTES")) {
                                wim_info->total_bytes = node_get_u64(child);
+                       } else if (node_name_is(child, "ESD")) {
+                               xmlNode *esdchild;
+                               for_node_child(child, esdchild) {
+                                       if (node_is_element(esdchild) &&
+                                           node_name_is(esdchild, "ENCRYPTED"))
+                                       {
+                                               ret = WIMLIB_ERR_WIM_IS_ENCRYPTED;
+                                               goto err;
+                                       }
+                               }
                        }
                }
 
@@ -552,7 +616,8 @@ xml_read_wim_info(const xmlNode *wim_node, struct wim_info **wim_info_ret)
                                ERROR("WIM images are not indexed [1...%d] "
                                      "in XML data as expected",
                                      num_images);
-                               return WIMLIB_ERR_IMAGE_COUNT;
+                               ret = WIMLIB_ERR_IMAGE_COUNT;
+                               goto err;
                        }
                }
 
@@ -564,10 +629,7 @@ err:
        return ret;
 }
 
-/* Prints the information contained in a `struct windows_info'.
- *
- * Warning: any strings printed here are in UTF-8 encoding.  If the locale
- * character encoding is not UTF-8, the printed strings may be garbled. */
+/* Prints the information contained in a `struct windows_info'.  */
 static void
 print_windows_info(const struct windows_info *windows_info)
 {
@@ -663,7 +725,7 @@ xml_write_strings_from_specs(xmlTextWriter *writer,
        for (size_t i = 0; i < num_specs; i++) {
                int rc = xml_write_string(writer, specs[i].name,
                                      *(const tchar * const *)
-                                       (struct_with_strings + specs[i].offset));
+                                       (struct_with_strings + specs[i].offset));
                if (rc)
                        return rc;
        }
@@ -726,7 +788,11 @@ xml_write_windows_version(xmlTextWriter *writer,
        if (rc < 0)
                return rc;
 
-       return xmlTextWriterEndElement(writer); /* </VERSION> */
+       rc = xmlTextWriterEndElement(writer); /* </VERSION> */
+       if (rc < 0)
+               return rc;
+
+       return 0;
 }
 
 /* Writes the information contained in a `struct windows_info' to the XML
@@ -774,18 +840,36 @@ xml_write_windows_info(xmlTextWriter *writer,
                        return rc;
        }
 
+       if (windows_info->pkeyconfigversion) {
+               rc = xmlTextWriterStartElement(writer, "SERVICINGDATA");
+               if (rc < 0)
+                       return rc;
+
+               rc = xml_write_string(writer, "PKEYCONFIGVERSION",
+                                     windows_info->pkeyconfigversion);
+               if (rc)
+                       return rc;
+
+               rc = xmlTextWriterEndElement(writer);
+               if (rc < 0)
+                       return rc;
+       }
+
        if (windows_info->windows_version_exists) {
                rc = xml_write_windows_version(writer, &windows_info->windows_version);
-               if (rc < 0)
+               if (rc)
                        return rc;
        }
 
-       rc = xml_write_string(writer, "SYSTEMROOT",
-                             windows_info->system_root);
+       rc = xml_write_string(writer, "SYSTEMROOT", windows_info->system_root);
        if (rc)
                return rc;
 
-       return xmlTextWriterEndElement(writer); /* </WINDOWS> */
+       rc = xmlTextWriterEndElement(writer); /* </WINDOWS> */
+       if (rc < 0)
+               return rc;
+
+       return 0;
 }
 
 /* Writes a time element to the XML document being constructed in memory. */
@@ -868,9 +952,16 @@ xml_write_image_info(xmlTextWriter *writer, const struct image_info *image_info)
        if (rc)
                return rc;
 
+       if (image_info->wimboot) {
+               rc = xmlTextWriterWriteFormatElement(writer, "WIMBOOT", "%d", 1);
+               if (rc < 0)
+                       return rc;
+       }
+
        rc = xmlTextWriterEndElement(writer); /* </IMAGE> */
        if (rc < 0)
                return rc;
+
        return 0;
 }
 
@@ -899,11 +990,19 @@ clone_windows_info(const struct windows_info *old, struct windows_info *new)
 {
        int ret;
 
+       new->arch = old->arch;
+
        ret = dup_strings_from_specs(old, new, windows_info_xml_string_specs,
                                     ARRAY_LEN(windows_info_xml_string_specs));
        if (ret)
                return ret;
 
+       if (old->pkeyconfigversion) {
+               new->pkeyconfigversion = TSTRDUP(old->pkeyconfigversion);
+               if (new->pkeyconfigversion == NULL)
+                       return WIMLIB_ERR_NOMEM;
+       }
+
        if (old->languages) {
                new->languages = CALLOC(old->num_languages, sizeof(new->languages[0]));
                if (!new->languages)
@@ -955,6 +1054,7 @@ clone_image_info(const struct image_info *old, struct image_info *new)
                if (ret)
                        return ret;
        }
+       new->wimboot = old->wimboot;
        return 0;
 }
 
@@ -1057,7 +1157,6 @@ xml_get_max_image_name_len(const WIMStruct *wim)
        return max_len;
 }
 
-#ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
 void
 xml_set_memory_allocator(void *(*malloc_func)(size_t),
                         void (*free_func)(void *),
@@ -1065,14 +1164,12 @@ xml_set_memory_allocator(void *(*malloc_func)(size_t),
 {
        xmlMemSetup(free_func, malloc_func, realloc_func, STRDUP);
 }
-#endif
 
 static int
 calculate_dentry_statistics(struct wim_dentry *dentry, void *arg)
 {
        struct image_info *info = arg;
        const struct wim_inode *inode = dentry->d_inode;
-       struct wim_lookup_table_entry *lte;
 
        /* Update directory count and file count.
         *
@@ -1083,19 +1180,19 @@ calculate_dentry_statistics(struct wim_dentry *dentry, void *arg)
         * 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;
 
-       if (inode_is_directory(inode))
-               info->dir_count++;
-       else
-               info->file_count++;
+       if (!dentry_is_root(dentry)) {
+               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.
+        * We try to act the same as the MS implementation, even though there
+        * are some inconsistencies/bugs in the way it operates.
         *
         * 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
@@ -1117,20 +1214,26 @@ calculate_dentry_statistics(struct wim_dentry *dentry, void *arg)
         * 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);
-       }
+       if (!(inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+                                    FILE_ATTRIBUTE_REPARSE_POINT)))
+       {
+               struct wim_lookup_table_entry *lte;
+
+               lte = inode_unnamed_lte(inode, info->lookup_table);
+               if (lte) {
+                       info->total_bytes += lte->size;
+                       if (!dentry_is_first_in_inode(dentry))
+                               info->hard_link_bytes += lte->size;
+               }
 
-       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_nbytes) {
-                               lte = inode_stream_lte(inode, i + 1, info->lookup_table);
-                               if (lte) {
-                                       info->hard_link_bytes += inode->i_nlink *
-                                                                wim_resource_size(lte);
+               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_nbytes) {
+                                       lte = inode_stream_lte(inode, i + 1, info->lookup_table);
+                                       if (lte) {
+                                               info->hard_link_bytes += inode->i_nlink *
+                                                                        lte->size;
+                                       }
                                }
                        }
                }
@@ -1141,9 +1244,6 @@ calculate_dentry_statistics(struct wim_dentry *dentry, void *arg)
 /*
  * Calculate what to put in the <FILECOUNT>, <DIRCOUNT>, <TOTALBYTES>, and
  * <HARDLINKBYTES> elements of each <IMAGE>.
- *
- * Please note there is no official documentation for exactly how this is done.
- * But, see calculate_dentry_statistics().
  */
 void
 xml_update_image_info(WIMStruct *wim, int image)
@@ -1255,6 +1355,8 @@ print_image_info(const struct wim_info *wim_info, int image)
                print_windows_info(&image_info->windows_info);
        if (image_info->flags)
                tprintf(T("Flags:                  %"TS"\n"), image_info->flags);
+       tprintf(T("WIMBoot compatible:     %"TS"\n"),
+               image_info->wimboot ? T("yes") : T("no"));
        tputchar('\n');
 }
 
@@ -1276,22 +1378,19 @@ libxml_global_cleanup(void)
 int
 read_wim_xml_data(WIMStruct *wim)
 {
+       void *buf;
+       size_t bufsize;
        u8 *xml_data;
        xmlDoc *doc;
        xmlNode *root;
        int ret;
-       const struct resource_entry *res_entry;
-
-       res_entry = &wim->hdr.xml_res_entry;
-
-       DEBUG("Reading XML data: %"PRIu64" bytes at offset %"PRIu64"",
-             (u64)res_entry->size, res_entry->offset);
 
-       ret = res_entry_to_data(res_entry, wim, (void**)&xml_data);
+       ret = wimlib_get_xml_data(wim, &buf, &bufsize);
        if (ret)
                goto out;
+       xml_data = buf;
 
-       doc = xmlReadMemory((const char *)xml_data, res_entry->original_size,
+       doc = xmlReadMemory((const char *)xml_data, bufsize,
                            NULL, "UTF-16LE", 0);
        if (!doc) {
                ERROR("Failed to parse XML data");
@@ -1452,6 +1551,7 @@ out_output_buffer_close:
 out_buffer_free:
        xmlBufferFree(buf);
 out:
+       DEBUG("ret=%d", ret);
        return ret;
 
 out_write_error:
@@ -1463,7 +1563,7 @@ out_write_error:
 /* Writes the XML data to a WIM file.  */
 int
 write_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
-                  struct resource_entry *out_res_entry,
+                  struct wim_reshdr *out_reshdr,
                   int write_resource_flags)
 {
        int ret;
@@ -1471,7 +1571,7 @@ write_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
        size_t xml_len;
 
        DEBUG("Writing WIM XML data (image=%d, offset=%"PRIu64")",
-             image, total_bytes, wim->out_fd.offset);
+             image, wim->out_fd.offset);
 
        ret = prepare_wim_xml_data(wim, image, total_bytes,
                                   &xml_data, &xml_len);
@@ -1485,10 +1585,12 @@ write_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
                                             WIM_RESHDR_FLAG_METADATA,
                                             &wim->out_fd,
                                             WIMLIB_COMPRESSION_TYPE_NONE,
-                                            out_res_entry,
+                                            0,
+                                            out_reshdr,
                                             NULL,
                                             write_resource_flags);
        FREE(xml_data);
+       DEBUG("ret=%d", ret);
        return ret;
 }
 
@@ -1525,30 +1627,39 @@ wimlib_image_name_in_use(const WIMStruct *wim, const tchar *name)
 
 /* API function documented in wimlib.h  */
 WIMLIBAPI int
-wimlib_extract_xml_data(WIMStruct *wim, FILE *fp)
+wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret)
 {
-       size_t size;
-       void *buf;
-       int ret;
+       const struct wim_reshdr *xml_reshdr;
 
-       if (!wim->filename)
+       if (wim->filename == NULL && filedes_is_seekable(&wim->in_fd))
                return WIMLIB_ERR_INVALID_PARAM;
 
-       ret = res_entry_to_data(&wim->hdr.xml_res_entry, wim, &buf);
+       if (buf_ret == NULL || bufsize_ret == NULL)
+               return WIMLIB_ERR_INVALID_PARAM;
+
+       xml_reshdr = &wim->hdr.xml_data_reshdr;
+
+       DEBUG("Reading XML data.");
+       *bufsize_ret = xml_reshdr->uncompressed_size;
+       return wim_reshdr_to_data(xml_reshdr, wim, buf_ret);
+}
+
+WIMLIBAPI int
+wimlib_extract_xml_data(WIMStruct *wim, FILE *fp)
+{
+       int ret;
+       void *buf;
+       size_t bufsize;
+
+       ret = wimlib_get_xml_data(wim, &buf, &bufsize);
        if (ret)
-               goto out;
+               return ret;
 
-       size = wim->hdr.xml_res_entry.original_size;
-       if (fwrite(buf, 1, size, fp) != size) {
+       if (fwrite(buf, 1, bufsize, fp) != bufsize) {
                ERROR_WITH_ERRNO("Failed to extract XML data");
                ret = WIMLIB_ERR_WRITE;
-               goto out_free_buf;
        }
-
-       ret = 0;
-out_free_buf:
        FREE(buf);
-out:
        return ret;
 }