]> wimlib.net Git - wimlib/blobdiff - src/xml.c
xml.c: Fix writing XML data for one image only
[wimlib] / src / xml.c
index dc910f3758ed2a63bfce64eb7cb166ca8f0d80ae..0fb6472342d43c8396eea152087bc76107939595 100644 (file)
--- a/src/xml.c
+++ b/src/xml.c
@@ -7,45 +7,42 @@
 /*
  * Copyright (C) 2012, 2013 Eric Biggers
  *
- * This file is part of wimlib, a library for working with WIM files.
+ * 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 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.
- *
- * 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 http://www.gnu.org/licenses/.
  */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
 
+#include <libxml/encoding.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+#include <libxml/xmlwriter.h>
+#include <string.h>
+
+#include "wimlib/assert.h"
+#include "wimlib/blob_table.h"
 #include "wimlib/dentry.h"
 #include "wimlib/encoding.h"
 #include "wimlib/error.h"
 #include "wimlib/file_io.h"
-#include "wimlib/lookup_table.h"
 #include "wimlib/metadata.h"
 #include "wimlib/resource.h"
 #include "wimlib/timestamp.h"
 #include "wimlib/xml.h"
 #include "wimlib/write.h"
 
-#include <libxml/encoding.h>
-#include <libxml/parser.h>
-#include <libxml/tree.h>
-#include <libxml/xmlwriter.h>
-#include <limits.h>
-#include <string.h>
-#include <unistd.h>
-
 /* Structures used to form an in-memory representation of the XML data (other
  * than the raw parse tree from libxml). */
 
@@ -93,7 +90,7 @@ struct image_info {
 
        /* Note: must update clone_image_info() if adding new fields here  */
 
-       struct wim_lookup_table *lookup_table; /* temporary field */
+       struct blob_table *blob_table; /* temporary field */
 };
 
 /* A struct wim_info structure corresponds to the entire XML data for a WIM file. */
@@ -492,7 +489,7 @@ xml_read_image_info(xmlNode *image_node, struct image_info *image_info)
        index_prop = xmlGetProp(image_node, "INDEX");
        if (index_prop) {
                image_info->index = atoi(index_prop);
-               FREE(index_prop);
+               xmlFree(index_prop);
        } else {
                image_info->index = 1;
        }
@@ -514,7 +511,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;
@@ -538,7 +534,6 @@ xml_read_image_info(xmlNode *image_node, struct image_info *image_info)
        }
        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;
@@ -588,7 +583,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)
@@ -632,10 +626,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)
 {
@@ -905,15 +896,16 @@ xml_write_time(xmlTextWriter *writer, const char *element_name, u64 time)
 
 /* Writes an <IMAGE> element to the XML document. */
 static int
-xml_write_image_info(xmlTextWriter *writer, const struct image_info *image_info)
+xml_write_image_info(xmlTextWriter *writer, const struct image_info *image_info,
+                    int index)
 {
        int rc;
+
        rc = xmlTextWriterStartElement(writer, "IMAGE");
        if (rc < 0)
                return rc;
 
-       rc = xmlTextWriterWriteFormatAttribute(writer, "INDEX", "%d",
-                                              image_info->index);
+       rc = xmlTextWriterWriteFormatAttribute(writer, "INDEX", "%d", index);
        if (rc < 0)
                return rc;
 
@@ -1172,87 +1164,35 @@ xml_set_memory_allocator(void *(*malloc_func)(size_t),
 }
 
 static int
-calculate_dentry_statistics(struct wim_dentry *dentry, void *arg)
+calculate_dentry_statistics(struct wim_dentry *dentry, void *_info)
 {
-       struct image_info *info = arg;
+       struct image_info *info = _info;
        const struct wim_inode *inode = dentry->d_inode;
 
-       /* 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)) {
-               if (inode_is_directory(inode))
-                       info->dir_count++;
-               else
-                       info->file_count++;
-       }
+       if (inode_is_directory(inode))
+               info->dir_count++;
+       else
+               info->file_count++;
 
-       /*
-        * Update total bytes and hard link bytes.
-        *
-        * 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
-        * 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).
-        */
-       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;
-               }
+       for (unsigned i = 0; i < inode->i_num_streams; i++) {
+               const struct blob_descriptor *blob;
 
-               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;
-                                       }
-                               }
-                       }
-               }
+               blob = stream_blob(&inode->i_streams[i], info->blob_table);
+               if (!blob)
+                       continue;
+               info->total_bytes += blob->size;
+               if (!dentry_is_first_in_inode(dentry))
+                       info->hard_link_bytes += blob->size;
        }
        return 0;
 }
 
 /*
  * Calculate what to put in the <FILECOUNT>, <DIRCOUNT>, <TOTALBYTES>, and
- * <HARDLINKBYTES> elements of each <IMAGE>.
+ * <HARDLINKBYTES> elements of the specified WIM image.
  *
- * Please note there is no official documentation for exactly how this is done.
- * But, see calculate_dentry_statistics().
+ * 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.
  */
 void
 xml_update_image_info(WIMStruct *wim, int image)
@@ -1267,12 +1207,12 @@ xml_update_image_info(WIMStruct *wim, int image)
        image_info->dir_count       = 0;
        image_info->total_bytes     = 0;
        image_info->hard_link_bytes = 0;
-       image_info->lookup_table = wim->lookup_table;
+       image_info->blob_table = wim->blob_table;
 
        for_dentry_in_tree(wim->image_metadata[image - 1]->root_dentry,
                           calculate_dentry_statistics,
                           image_info);
-       image_info->last_modification_time = get_wim_timestamp();
+       image_info->last_modification_time = now_as_wim_timestamp();
 }
 
 /* Adds an image to the XML information. */
@@ -1303,7 +1243,7 @@ xml_add_image(WIMStruct *wim, const tchar *name)
 
        wim->wim_info = wim_info;
        image_info->index = wim_info->num_images;
-       image_info->creation_time = get_wim_timestamp();
+       image_info->creation_time = now_as_wim_timestamp();
        xml_update_image_info(wim, image_info->index);
        return 0;
 
@@ -1438,7 +1378,6 @@ prepare_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
        xmlOutputBuffer *outbuf;
        xmlTextWriter *writer;
        int ret;
-       int first, last;
        const xmlChar *content;
        int len;
        u8 *xml_data;
@@ -1500,20 +1439,23 @@ prepare_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
        }
 
        if (image == WIMLIB_ALL_IMAGES) {
-               first = 1;
-               last = wim->hdr.image_count;
-       } else {
-               first = image;
-               last = image;
-       }
-
-       for (int i = first; i <= last; i++) {
-               ret = xml_write_image_info(writer, &wim->wim_info->images[i - 1]);
-               if (ret) {
+               for (int i = 0; i < wim->hdr.image_count; i++) {
+                       ret = xml_write_image_info(writer,
+                                                  &wim->wim_info->images[i],
+                                                  i + 1);
                        if (ret < 0)
                                goto out_write_error;
-                       goto out_free_text_writer;
+                       if (ret > 0)
+                               goto out_free_text_writer;
                }
+       } else {
+               ret = xml_write_image_info(writer,
+                                          &wim->wim_info->images[image - 1],
+                                          1);
+               if (ret < 0)
+                       goto out_write_error;
+               if (ret > 0)
+                       goto out_free_text_writer;
        }
 
        ret = xmlTextWriterEndElement(writer);
@@ -1591,7 +1533,7 @@ write_wim_xml_data(WIMStruct *wim, int image, u64 total_bytes,
         * compressed XML data, MS software cannot.  */
        ret = write_wim_resource_from_buffer(xml_data,
                                             xml_len,
-                                            WIM_RESHDR_FLAG_METADATA,
+                                            true,
                                             &wim->out_fd,
                                             WIMLIB_COMPRESSION_TYPE_NONE,
                                             0,
@@ -1641,7 +1583,7 @@ wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret)
        const struct wim_reshdr *xml_reshdr;
 
        if (wim->filename == NULL && filedes_is_seekable(&wim->in_fd))
-               return WIMLIB_ERR_INVALID_PARAM;
+               return WIMLIB_ERR_NO_FILENAME;
 
        if (buf_ret == NULL || bufsize_ret == NULL)
                return WIMLIB_ERR_INVALID_PARAM;
@@ -1678,29 +1620,19 @@ wimlib_set_image_name(WIMStruct *wim, int image, const tchar *name)
 {
        tchar *p;
        int i;
-       int ret;
-
-       DEBUG("Setting the name of image %d to %"TS, image, name);
-
-       ret = can_modify_wim(wim);
-       if (ret)
-               return ret;
 
        if (name == NULL)
                name = T("");
 
-       if (image < 1 || image > wim->hdr.image_count) {
-               ERROR("%d is not a valid image", image);
+       if (image < 1 || image > wim->hdr.image_count)
                return WIMLIB_ERR_INVALID_IMAGE;
-       }
 
-       for (i = 1; i <= wim->hdr.image_count; i++) {
-               if (i == image)
-                       continue;
-               if (!tstrcmp(wim->wim_info->images[i - 1].name, name)) {
-                       ERROR("The name \"%"TS"\" is already in use in the WIM!",
-                             name);
-                       return WIMLIB_ERR_IMAGE_NAME_COLLISION;
+       if (*name) {
+               for (i = 1; i <= wim->hdr.image_count; i++) {
+                       if (i == image)
+                               continue;
+                       if (!tstrcmp(wim->wim_info->images[i - 1].name, name))
+                               return WIMLIB_ERR_IMAGE_NAME_COLLISION;
                }
        }
 
@@ -1719,11 +1651,6 @@ do_set_image_info_str(WIMStruct *wim, int image, const tchar *tstr,
 {
        tchar *tstr_copy;
        tchar **dest_tstr_p;
-       int ret;
-
-       ret = can_modify_wim(wim);
-       if (ret)
-               return ret;
 
        if (image < 1 || image > wim->hdr.image_count) {
                ERROR("%d is not a valid image", image);