]> wimlib.net Git - wimlib/blobdiff - src/update_image.c
Refactor headers
[wimlib] / src / update_image.c
index 49ac6021a2e331545c1af31aa563d22597044e57..d7a289a3a0dd5f6ffe253e0b5c37b776b87ce63a 100644 (file)
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
-#include "wimlib_internal.h"
-#include "dentry.h"
-#include "lookup_table.h"
-#include "security.h"
-#include "xml.h"
-#include <errno.h>
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
 
-/* Creates a new directory to place in the WIM image.  This is to create parent
- * directories that are not part of any target as needed.  */
-static int
-new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret)
-{
-       int ret;
-       struct wim_dentry *dentry;
+#include "wimlib/capture.h"
+#include "wimlib/dentry.h"
+#include "wimlib/error.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
+#ifdef WITH_NTFS_3G
+#  include "wimlib/ntfs_3g.h" /* for do_ntfs_umount() */
+#endif
+#include "wimlib/paths.h"
+#include "wimlib/xml.h"
 
-       DEBUG("Creating filler directory \"%"TS"\"", name);
-       ret = new_dentry_with_inode(name, &dentry);
-       if (ret)
-               goto out;
-       /* Leave the inode number as 0; this is allowed for non
-        * hard-linked files. */
-       dentry->d_inode->i_resolved = 1;
-       dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
-       *dentry_ret = dentry;
-       ret = 0;
-out:
-       return ret;
-}
+#include <errno.h>
 
 /* Overlays @branch onto @target, both of which must be directories. */
 static int
@@ -66,6 +54,7 @@ do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
        }
 
        rb_root = &branch->d_inode->i_children;
+       LIST_HEAD(moved_children);
        while (rb_root->rb_node) { /* While @branch has children... */
                struct wim_dentry *child = rbnode_dentry(rb_root->rb_node);
                struct wim_dentry *existing;
@@ -79,12 +68,17 @@ do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
                        int ret;
                        ret = do_overlay(existing, child);
                        if (ret) {
-                               /* Overlay failed.  Revert the change to avoid
-                                * leaking the directory tree rooted at @child.
-                                * */
+                               /* Overlay failed.  Revert the changes. */
                                dentry_add_child(branch, child);
+                               list_for_each_entry(child, &moved_children, tmp_list)
+                               {
+                                       unlink_dentry(child);
+                                       dentry_add_child(branch, child);
+                               }
                                return ret;
                        }
+               } else {
+                       list_add(&child->tmp_list, &moved_children);
                }
        }
        free_dentry(branch);
@@ -180,8 +174,6 @@ execute_add_command(WIMStruct *wim,
        int add_flags;
        tchar *fs_source_path;
        tchar *wim_target_path;
-       struct wim_inode_table inode_table;
-       struct sd_set sd_set;
        struct wim_image_metadata *imd;
        struct list_head unhashed_streams;
        struct add_image_params params;
@@ -207,7 +199,7 @@ execute_add_command(WIMStruct *wim,
 
        imd = wim->image_metadata[wim->current_image - 1];
 
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
+       if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
        #ifdef WITH_NTFS_3G
                capture_tree = build_dentry_tree_ntfs;
                extra_arg = &ntfs_vol;
@@ -229,21 +221,19 @@ execute_add_command(WIMStruct *wim,
                extra_arg = NULL;
        }
 
-       ret = init_inode_table(&inode_table, 9001);
+       ret = init_inode_table(&params.inode_table, 9001);
        if (ret)
                goto out;
 
-       ret = init_sd_set(&sd_set, imd->security_data);
+       ret = init_sd_set(&params.sd_set, imd->security_data);
        if (ret)
                goto out_destroy_inode_table;
 
        INIT_LIST_HEAD(&unhashed_streams);
        wim->lookup_table->unhashed_streams = &unhashed_streams;
        params.lookup_table = wim->lookup_table;
-       params.inode_table = &inode_table;
-       params.sd_set = &sd_set;
        params.config = config;
-       params.add_image_flags = add_flags;
+       params.add_flags = add_flags;
        params.progress_func = progress_func;
        params.extra_arg = extra_arg;
 
@@ -257,7 +247,7 @@ execute_add_command(WIMStruct *wim,
        config->_prefix_num_tchars = tstrlen(fs_source_path);
 
        if (wim_target_path[0] == T('\0'))
-               add_flags |= WIMLIB_ADD_IMAGE_FLAG_ROOT;
+               add_flags |= WIMLIB_ADD_FLAG_ROOT;
        ret = (*capture_tree)(&branch, fs_source_path, &params);
        if (ret) {
                ERROR("Failed to build dentry tree for \"%"TS"\"",
@@ -284,10 +274,10 @@ execute_add_command(WIMStruct *wim,
 #ifdef WITH_NTFS_3G
        imd->ntfs_vol = ntfs_vol;
 #endif
-       inode_table_prepare_inode_list(&inode_table, &imd->inode_list);
+       inode_table_prepare_inode_list(&params.inode_table, &imd->inode_list);
        ret = 0;
        rollback_sd = false;
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX)
+       if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
                wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
        goto out_destroy_sd_set;
 out_ntfs_umount:
@@ -297,9 +287,9 @@ out_ntfs_umount:
 #endif
        free_dentry_tree(branch, wim->lookup_table);
 out_destroy_sd_set:
-       destroy_sd_set(&sd_set, rollback_sd);
+       destroy_sd_set(&params.sd_set, rollback_sd);
 out_destroy_inode_table:
-       destroy_inode_table(&inode_table);
+       destroy_inode_table(&params.inode_table);
 out:
        return ret;
 }
@@ -317,6 +307,8 @@ execute_delete_command(WIMStruct *wim,
        flags = delete_cmd->delete.delete_flags;
        wim_path = delete_cmd->delete.wim_path;
 
+       DEBUG("Deleting WIM path \"%"TS"\" (flags=%#x)", wim_path, flags);
+
        tree = get_dentry(wim, wim_path);
        if (!tree) {
                /* Path to delete does not exist in the WIM. */
@@ -344,7 +336,15 @@ execute_delete_command(WIMStruct *wim,
        return 0;
 }
 
-/* 
+static int
+free_dentry_full_path(struct wim_dentry *dentry, void *_ignore)
+{
+       FREE(dentry->_full_path);
+       dentry->_full_path = NULL;
+       return 0;
+}
+
+/*
  * Rename a file or directory in the WIM.
  *
  * This is also called from wimfs_rename() in the FUSE mount code.
@@ -404,6 +404,8 @@ rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
        }
        unlink_dentry(src);
        dentry_add_child(parent_of_dst, src);
+       if (src->_full_path)
+               for_dentry_in_tree(src, free_dentry_full_path, NULL);
        return 0;
 }
 
@@ -419,18 +421,25 @@ execute_rename_command(WIMStruct *wim,
        ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
                              rename_cmd->rename.wim_target_path);
        if (ret) {
+               ret = -ret;
+               errno = ret;
+               ERROR_WITH_ERRNO("Can't rename \"%"TS"\" to \"%"TS"\"",
+                                rename_cmd->rename.wim_source_path,
+                                rename_cmd->rename.wim_target_path);
                switch (ret) {
-               case -ENOMEM:
+               case ENOMEM:
                        ret = WIMLIB_ERR_NOMEM;
                        break;
-               case -ENOTDIR:
+               case ENOTDIR:
                        ret = WIMLIB_ERR_NOTDIR;
                        break;
-               case -ENOTEMPTY:
-               case -EISDIR:
+               case ENOTEMPTY:
+                       ret = WIMLIB_ERR_NOTEMPTY;
+                       break;
+               case EISDIR:
                        ret = WIMLIB_ERR_IS_DIRECTORY;
                        break;
-               case -ENOENT:
+               case ENOENT:
                default:
                        ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
                        break;
@@ -450,7 +459,8 @@ update_op_to_str(int op)
        case WIMLIB_UPDATE_OP_RENAME:
                return T("rename");
        default:
-               return T("???");
+               wimlib_assert(0);
+               return NULL;
        }
 }
 
@@ -470,19 +480,15 @@ execute_update_commands(WIMStruct *wim,
                        break;
                case WIMLIB_UPDATE_OP_DELETE:
                        ret = execute_delete_command(wim, &cmds[i]);
-                       if (ret == 0)
-                               wim->deletion_occurred = 1;
                        break;
                case WIMLIB_UPDATE_OP_RENAME:
                        ret = execute_rename_command(wim, &cmds[i]);
                        break;
                default:
-                       ret = WIMLIB_ERR_INVALID_PARAM;
-                       break;
+                       wimlib_assert(0);
                }
                if (ret)
                        break;
-               wim->image_metadata[wim->current_image - 1]->modified = 1;
        }
        return ret;
 }
@@ -492,64 +498,72 @@ check_add_command(struct wimlib_update_command *cmd,
                  const struct wim_header *hdr)
 {
        int add_flags = cmd->add.add_flags;
+
+       /* Are we adding the entire image or not?  An empty wim_target_path
+        * indicates that the tree we're adding is to be placed in the root of
+        * the image.  We consider this to be capturing the entire image,
+        * although it could potentially be an overlay on an existing root as
+        * well. */
        bool is_entire_image = cmd->add.wim_target_path[0] == T('\0');
-       int ret;
+
 #ifdef __WIN32__
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
+       /* Check for flags not supported on Windows */
+       if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
                ERROR("wimlib was compiled without support for NTFS-3g, so");
                ERROR("we cannot capture a WIM image directly from a NTFS volume");
                return WIMLIB_ERR_UNSUPPORTED;
        }
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) {
+       if (add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
                ERROR("Capturing UNIX-specific data is not supported on Windows");
-               return WIMLIB_ERR_INVALID_PARAM;
+               return WIMLIB_ERR_UNSUPPORTED;
        }
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE) {
+       if (add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) {
                ERROR("Dereferencing symbolic links is not supported on Windows");
-               return WIMLIB_ERR_INVALID_PARAM;
+               return WIMLIB_ERR_UNSUPPORTED;
        }
 #endif
 
-       if (add_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
-               add_flags |= WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE;
+       /* VERBOSE implies EXCLUDE_VERBOSE */
+       if (add_flags & WIMLIB_ADD_FLAG_VERBOSE)
+               add_flags |= WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE;
 
-       if ((add_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
-                         WIMLIB_ADD_IMAGE_FLAG_NORPFIX)) ==
-               (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
-                WIMLIB_ADD_IMAGE_FLAG_NORPFIX))
+       /* Check for contradictory reparse point fixup flags */
+       if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
+                         WIMLIB_ADD_FLAG_NORPFIX)) ==
+               (WIMLIB_ADD_FLAG_RPFIX |
+                WIMLIB_ADD_FLAG_NORPFIX))
        {
                ERROR("Cannot specify RPFIX and NORPFIX flags "
                      "at the same time!");
                return WIMLIB_ERR_INVALID_PARAM;
        }
 
-       if ((add_flags & (WIMLIB_ADD_IMAGE_FLAG_RPFIX |
-                         WIMLIB_ADD_IMAGE_FLAG_NORPFIX)) == 0)
+       /* Set default behavior on reparse point fixups if requested */
+       if ((add_flags & (WIMLIB_ADD_FLAG_RPFIX |
+                         WIMLIB_ADD_FLAG_NORPFIX)) == 0)
        {
                /* Do reparse-point fixups by default if we are capturing an
                 * entire image and either the header flag is set from previous
                 * images, or if this is the first image being added. */
                if (is_entire_image &&
                    ((hdr->flags & WIM_HDR_FLAG_RP_FIX) || hdr->image_count == 1))
-                       add_flags |= WIMLIB_ADD_IMAGE_FLAG_RPFIX;
+                       add_flags |= WIMLIB_ADD_FLAG_RPFIX;
        }
 
        if (!is_entire_image) {
-               if (add_flags & WIMLIB_ADD_IMAGE_FLAG_NTFS) {
+               if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
                        ERROR("Cannot add directly from a NTFS volume "
                              "when not capturing a full image!");
                        return WIMLIB_ERR_INVALID_PARAM;
                }
 
-               if (add_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX) {
+               if (add_flags & WIMLIB_ADD_FLAG_RPFIX) {
                        ERROR("Cannot do reparse point fixups when "
                              "not capturing a full image!");
                        return WIMLIB_ERR_INVALID_PARAM;
                }
        }
-       ret = canonicalize_capture_config(cmd->add.config);
-       if (ret)
-               return ret;
+       /* We may have modified the add flags. */
        cmd->add.add_flags = add_flags;
        return 0;
 }
@@ -582,12 +596,12 @@ check_update_commands(struct wimlib_update_command *cmds, size_t num_cmds,
 }
 
 
-extern void
+static void
 free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
 {
        if (cmds) {
                for (size_t i = 0; i < num_cmds; i++) {
-                       switch (cmds->op) {
+                       switch (cmds[i].op) {
                        case WIMLIB_UPDATE_OP_ADD:
                                FREE(cmds[i].add.fs_source_path);
                                FREE(cmds[i].add.wim_target_path);
@@ -630,10 +644,10 @@ copy_update_commands(const struct wimlib_update_command *cmds,
                            !cmds_copy[i].add.wim_target_path)
                                goto oom;
                        if (cmds[i].add.config) {
-                               cmds_copy[i].add.config =
-                                       copy_capture_config(cmds[i].add.config);
-                               if (!cmds_copy[i].add.config)
-                                       goto oom;
+                               ret = copy_and_canonicalize_capture_config(cmds[i].add.config,
+                                                                          &cmds_copy[i].add.config);
+                               if (ret)
+                                       goto err;
                        }
                        cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
                        break;
@@ -670,6 +684,9 @@ err:
        goto out;
 }
 
+/*
+ * Entry point for making a series of updates to a WIM image.
+ */
 WIMLIBAPI int
 wimlib_update_image(WIMStruct *wim,
                    int image,
@@ -683,37 +700,51 @@ wimlib_update_image(WIMStruct *wim,
 
        DEBUG("Updating image %d with %zu commands", image, num_cmds);
 
+       /* Refuse to update a split WIM. */
        if (wim->hdr.total_parts != 1) {
                ERROR("Cannot update a split WIM!");
                ret = WIMLIB_ERR_SPLIT_UNSUPPORTED;
                goto out;
        }
 
+       /* Load the metadata for the image to modify (if not loaded already) */
        ret = select_wim_image(wim, image);
        if (ret)
                goto out;
 
-       DEBUG("Selected image %d for update", image);
-
+       /* Short circuit a successful return if no commands were specified.
+        * Avoids problems with trying to allocate 0 bytes of memory. */
        if (num_cmds == 0)
                goto out;
 
        DEBUG("Preparing %zu update commands", num_cmds);
 
+       /* Make a copy of the update commands, in the process doing certain
+        * canonicalizations on paths (e.g. translating backslashes to forward
+        * slashes).  This is done to avoid modifying the caller's copy of the
+        * commands. */
        ret = copy_update_commands(cmds, num_cmds, &cmds_copy);
        if (ret)
                goto out;
 
+       /* Perform additional checks on the update commands before we execute
+        * them. */
        ret = check_update_commands(cmds_copy, num_cmds, &wim->hdr);
        if (ret)
                goto out_free_cmds_copy;
 
+       /* Actually execute the update commands. */
        DEBUG("Executing %zu update commands", num_cmds);
-
        ret = execute_update_commands(wim, cmds_copy, num_cmds, progress_func);
        if (ret)
                goto out_free_cmds_copy;
-       xml_update_image_info(wim, wim->current_image);
+
+       wim->image_metadata[image - 1]->modified = 1;
+
+       /* Statistics about the WIM image, such as the numbers of files and
+        * directories, may have changed.  Call xml_update_image_info() to
+        * recalculate these statistics. */
+       xml_update_image_info(wim, image);
 out_free_cmds_copy:
        free_update_commands(cmds_copy, num_cmds);
 out: