]> wimlib.net Git - wimlib/blobdiff - src/update_image.c
wimlib: strict checks for unassigned flags
[wimlib] / src / update_image.c
index 7247b1c06b8fb61064974f21c27e0baa670d1964..5a5ae69066f590f119fed933296a410c545be2bc 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
 
-#ifdef __WIN32__
-#  include "win32.h"
+#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"
+
+#include <errno.h>
 
 /* Overlays @branch onto @target, both of which must be directories. */
 static int
@@ -48,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;
@@ -61,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);
@@ -76,17 +88,17 @@ do_overlay(struct wim_dentry *target, struct wim_dentry *branch)
 /* Attach or overlay a branch onto the WIM image.
  *
  * @root_p:
- *     Pointer to the root of the WIM image, or pointer to NULL if it has not
- *     been created yet.
+ *     Pointer to the root of the WIM image, or pointer to NULL if it has not
+ *     been created yet.
  * @branch
- *     Branch to add.
+ *     Branch to add.
  * @target_path:
- *     Path in the WIM image to add the branch, with leading and trailing
- *     slashes stripped.
+ *     Path in the WIM image to add the branch, with leading and trailing
+ *     slashes stripped.
  */
 static int
 attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
-             tchar *target_path)
+             tchar *target_path, CASE_SENSITIVITY_TYPE case_type)
 {
        tchar *slash;
        struct wim_dentry *dentry, *parent, *target;
@@ -122,9 +134,10 @@ attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
        /* Walk the path to the branch, creating filler directories as needed.
         * */
        parent = *root_p;
-       while ((slash = tstrchr(target_path, T('/')))) {
+       while ((slash = tstrchr(target_path, WIM_PATH_SEPARATOR))) {
                *slash = T('\0');
-               dentry = get_dentry_child_with_name(parent, target_path);
+               dentry = get_dentry_child_with_name(parent, target_path,
+                                                   case_type);
                if (!dentry) {
                        ret = new_filler_directory(target_path, &dentry);
                        if (ret)
@@ -138,13 +151,14 @@ attach_branch(struct wim_dentry **root_p, struct wim_dentry *branch,
                 * trailing slashes were tripped.  */
                do {
                        ++target_path;
-               } while (*target_path == T('/'));
+               } while (*target_path == WIM_PATH_SEPARATOR);
        }
 
        /* If the target path already existed, overlay the branch onto it.
         * Otherwise, set the branch as the target path. */
        target = get_dentry_child_with_utf16le_name(parent, branch->file_name,
-                                                   branch->file_name_nbytes);
+                                                   branch->file_name_nbytes,
+                                                   case_type);
        if (target) {
                return do_overlay(target, branch);
        } else {
@@ -162,15 +176,12 @@ 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;
        int (*capture_tree)(struct wim_dentry **,
                            const tchar *,
                            struct add_image_params *);
-       union wimlib_progress_info progress;
        struct wimlib_capture_config *config;
 #ifdef WITH_NTFS_3G
        struct _ntfs_volume *ntfs_vol = NULL;
@@ -180,6 +191,7 @@ execute_add_command(WIMStruct *wim,
        bool rollback_sd = true;
 
        wimlib_assert(add_cmd->op == WIMLIB_UPDATE_OP_ADD);
+
        add_flags = add_cmd->add.add_flags;
        fs_source_path = add_cmd->add.fs_source_path;
        wim_target_path = add_cmd->add.wim_target_path;
@@ -187,6 +199,8 @@ execute_add_command(WIMStruct *wim,
        DEBUG("fs_source_path=\"%"TS"\", wim_target_path=\"%"TS"\", add_flags=%#x",
              fs_source_path, wim_target_path, add_flags);
 
+       memset(&params, 0, sizeof(params));
+
        imd = wim->image_metadata[wim->current_image - 1];
 
        if (add_flags & WIMLIB_ADD_FLAG_NTFS) {
@@ -211,62 +225,60 @@ 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.unhashed_streams = &unhashed_streams;
        params.config = config;
        params.add_flags = add_flags;
-       params.progress_func = progress_func;
        params.extra_arg = extra_arg;
 
-       if (progress_func) {
-               memset(&progress, 0, sizeof(progress));
-               progress.scan.source = fs_source_path;
-               progress.scan.wim_target_path = wim_target_path;
-               progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &progress);
+       params.progress_func = progress_func;
+       params.progress.scan.source = fs_source_path;
+       params.progress.scan.wim_target_path = wim_target_path;
+       if (progress_func)
+               progress_func(WIMLIB_PROGRESS_MSG_SCAN_BEGIN, &params.progress);
+       if (config) {
+               config->_prefix = fs_source_path;
+               config->_prefix_num_tchars = tstrlen(fs_source_path);
        }
-       config->_prefix = fs_source_path;
-       config->_prefix_num_tchars = tstrlen(fs_source_path);
 
        if (wim_target_path[0] == T('\0'))
-               add_flags |= WIMLIB_ADD_FLAG_ROOT;
+               params.add_flags |= WIMLIB_ADD_FLAG_ROOT;
        ret = (*capture_tree)(&branch, fs_source_path, &params);
-       if (ret) {
-               ERROR("Failed to build dentry tree for \"%"TS"\"",
-                     fs_source_path);
+       if (ret)
                goto out_destroy_sd_set;
-       }
+
        if (branch) {
                /* Use the target name, not the source name, for
                 * the root of each branch from a capture
                 * source.  (This will also set the root dentry
                 * of the entire image to be unnamed.) */
-               ret = set_dentry_name(branch,
+               ret = dentry_set_name(branch,
                                      path_basename(wim_target_path));
                if (ret)
                        goto out_ntfs_umount;
 
-               ret = attach_branch(&imd->root_dentry, branch, wim_target_path);
+               ret = attach_branch(&imd->root_dentry, branch, wim_target_path,
+                                   WIMLIB_CASE_PLATFORM_DEFAULT);
                if (ret)
                        goto out_ntfs_umount;
        }
        if (progress_func)
-               progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &progress);
+               progress_func(WIMLIB_PROGRESS_MSG_SCAN_END, &params.progress);
        list_splice_tail(&unhashed_streams, &imd->unhashed_streams);
 #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_FLAG_RPFIX)
@@ -279,9 +291,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;
 }
@@ -296,12 +308,12 @@ execute_delete_command(WIMStruct *wim,
        bool is_root;
 
        wimlib_assert(delete_cmd->op == WIMLIB_UPDATE_OP_DELETE);
-       flags = delete_cmd->delete.delete_flags;
-       wim_path = delete_cmd->delete.wim_path;
+       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);
+       tree = get_dentry(wim, wim_path, WIMLIB_CASE_PLATFORM_DEFAULT);
        if (!tree) {
                /* Path to delete does not exist in the WIM. */
                if (flags & WIMLIB_DELETE_FLAG_FORCE) {
@@ -328,70 +340,6 @@ execute_delete_command(WIMStruct *wim,
        return 0;
 }
 
-/*
- * Rename a file or directory in the WIM.
- *
- * This is also called from wimfs_rename() in the FUSE mount code.
- */
-int
-rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to)
-{
-       struct wim_dentry *src;
-       struct wim_dentry *dst;
-       struct wim_dentry *parent_of_dst;
-       int ret;
-
-       /* This rename() implementation currently only supports actual files
-        * (not alternate data streams) */
-
-       src = get_dentry(wim, from);
-       if (!src)
-               return -errno;
-
-       dst = get_dentry(wim, to);
-
-       if (dst) {
-               /* Destination file exists */
-
-               if (src == dst) /* Same file */
-                       return 0;
-
-               if (!dentry_is_directory(src)) {
-                       /* Cannot rename non-directory to directory. */
-                       if (dentry_is_directory(dst))
-                               return -EISDIR;
-               } else {
-                       /* Cannot rename directory to a non-directory or a non-empty
-                        * directory */
-                       if (!dentry_is_directory(dst))
-                               return -ENOTDIR;
-                       if (inode_has_children(dst->d_inode))
-                               return -ENOTEMPTY;
-               }
-               parent_of_dst = dst->parent;
-       } else {
-               /* Destination does not exist */
-               parent_of_dst = get_parent_dentry(wim, to);
-               if (!parent_of_dst)
-                       return -errno;
-
-               if (!dentry_is_directory(parent_of_dst))
-                       return -ENOTDIR;
-       }
-
-       ret = set_dentry_name(src, path_basename(to));
-       if (ret)
-               return -ENOMEM;
-       if (dst) {
-               unlink_dentry(dst);
-               free_dentry_tree(dst, wim->lookup_table);
-       }
-       unlink_dentry(src);
-       dentry_add_child(parent_of_dst, src);
-       return 0;
-}
-
-
 static int
 execute_rename_command(WIMStruct *wim,
                       const struct wimlib_update_command *rename_cmd)
@@ -401,7 +349,8 @@ execute_rename_command(WIMStruct *wim,
        wimlib_assert(rename_cmd->op == WIMLIB_UPDATE_OP_RENAME);
 
        ret = rename_wim_path(wim, rename_cmd->rename.wim_source_path,
-                             rename_cmd->rename.wim_target_path);
+                             rename_cmd->rename.wim_target_path,
+                             WIMLIB_CASE_PLATFORM_DEFAULT);
        if (ret) {
                ret = -ret;
                errno = ret;
@@ -442,6 +391,7 @@ update_op_to_str(int op)
                return T("rename");
        default:
                wimlib_assert(0);
+               return NULL;
        }
 }
 
@@ -449,12 +399,23 @@ static int
 execute_update_commands(WIMStruct *wim,
                        const struct wimlib_update_command *cmds,
                        size_t num_cmds,
+                       int update_flags,
                        wimlib_progress_func_t progress_func)
 {
        int ret = 0;
+       union wimlib_progress_info info;
+       info.update.completed_commands = 0;
+       info.update.total_commands = num_cmds;
        for (size_t i = 0; i < num_cmds; i++) {
                DEBUG("Executing update command %zu of %zu (op=%"TS")",
                      i + 1, num_cmds, update_op_to_str(cmds[i].op));
+               if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
+                   progress_func)
+               {
+                       info.update.command = &cmds[i];
+                       (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
+                                        &info);
+               }
                switch (cmds[i].op) {
                case WIMLIB_UPDATE_OP_ADD:
                        ret = execute_add_command(wim, &cmds[i], progress_func);
@@ -470,16 +431,55 @@ execute_update_commands(WIMStruct *wim,
                }
                if (ret)
                        break;
+               info.update.completed_commands++;
+               if (update_flags & WIMLIB_UPDATE_FLAG_SEND_PROGRESS &&
+                   progress_func)
+               {
+                       (*progress_func)(WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
+                                        &info);
+               }
        }
        return ret;
 }
 
+
+tchar *winpats[] = {
+       T("/$ntfs.log"),
+       T("/hiberfil.sys"),
+       T("/pagefile.sys"),
+       T("/System Volume Information"),
+       T("/RECYCLER"),
+       T("/Windows/CSC"),
+};
+
+static const struct wimlib_capture_config winconfig = {
+       .exclusion_pats = {
+               .num_pats = ARRAY_LEN(winpats),
+               .pats = winpats,
+       },
+};
+
 static int
 check_add_command(struct wimlib_update_command *cmd,
                  const struct wim_header *hdr)
 {
        int add_flags = cmd->add.add_flags;
 
+       if (add_flags & ~(WIMLIB_ADD_FLAG_NTFS |
+                         WIMLIB_ADD_FLAG_DEREFERENCE |
+                         WIMLIB_ADD_FLAG_VERBOSE |
+                         /* BOOT doesn't make sense for wimlib_update_image()  */
+                         /*WIMLIB_ADD_FLAG_BOOT |*/
+                         WIMLIB_ADD_FLAG_UNIX_DATA |
+                         WIMLIB_ADD_FLAG_NO_ACLS |
+                         WIMLIB_ADD_FLAG_STRICT_ACLS |
+                         WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE |
+                         WIMLIB_ADD_FLAG_RPFIX |
+                         WIMLIB_ADD_FLAG_NORPFIX |
+                         WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE |
+                         WIMLIB_ADD_FLAG_WINCONFIG))
+               return WIMLIB_ERR_INVALID_PARAM;
+
        /* 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,
@@ -549,6 +549,23 @@ check_add_command(struct wimlib_update_command *cmd,
        return 0;
 }
 
+static int
+check_delete_command(const struct wimlib_update_command *cmd)
+{
+       if (cmd->delete_.delete_flags & ~(WIMLIB_DELETE_FLAG_FORCE |
+                                         WIMLIB_DELETE_FLAG_RECURSIVE))
+               return WIMLIB_ERR_INVALID_PARAM;
+       return 0;
+}
+
+static int
+check_rename_command(const struct wimlib_update_command *cmd)
+{
+       if (cmd->rename.rename_flags != 0)
+               return WIMLIB_ERR_INVALID_PARAM;
+       return 0;
+}
+
 static int
 check_update_command(struct wimlib_update_command *cmd,
                     const struct wim_header *hdr)
@@ -557,8 +574,9 @@ check_update_command(struct wimlib_update_command *cmd,
        case WIMLIB_UPDATE_OP_ADD:
                return check_add_command(cmd, hdr);
        case WIMLIB_UPDATE_OP_DELETE:
+               return check_delete_command(cmd);
        case WIMLIB_UPDATE_OP_RENAME:
-               break;
+               return check_rename_command(cmd);
        }
        return 0;
 }
@@ -577,7 +595,7 @@ 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) {
@@ -589,7 +607,7 @@ free_update_commands(struct wimlib_update_command *cmds, size_t num_cmds)
                                free_capture_config(cmds[i].add.config);
                                break;
                        case WIMLIB_UPDATE_OP_DELETE:
-                               FREE(cmds[i].delete.wim_path);
+                               FREE(cmds[i].delete_.wim_path);
                                break;
                        case WIMLIB_UPDATE_OP_RENAME:
                                FREE(cmds[i].rename.wim_source_path);
@@ -608,6 +626,7 @@ copy_update_commands(const struct wimlib_update_command *cmds,
 {
        int ret;
        struct wimlib_update_command *cmds_copy;
+       const struct wimlib_capture_config *config;
 
        cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
        if (!cmds_copy)
@@ -624,8 +643,11 @@ copy_update_commands(const struct wimlib_update_command *cmds,
                        if (!cmds_copy[i].add.fs_source_path ||
                            !cmds_copy[i].add.wim_target_path)
                                goto oom;
-                       if (cmds[i].add.config) {
-                               ret = copy_and_canonicalize_capture_config(cmds[i].add.config,
+                       config = cmds[i].add.config;
+                       if (cmds[i].add.add_flags & WIMLIB_ADD_FLAG_WINCONFIG)
+                               config = &winconfig;
+                       if (config) {
+                               ret = copy_and_canonicalize_capture_config(config,
                                                                           &cmds_copy[i].add.config);
                                if (ret)
                                        goto err;
@@ -633,11 +655,11 @@ copy_update_commands(const struct wimlib_update_command *cmds,
                        cmds_copy[i].add.add_flags = cmds[i].add.add_flags;
                        break;
                case WIMLIB_UPDATE_OP_DELETE:
-                       cmds_copy[i].delete.wim_path =
-                               canonicalize_wim_path(cmds[i].delete.wim_path);
-                       if (!cmds_copy[i].delete.wim_path)
+                       cmds_copy[i].delete_.wim_path =
+                               canonicalize_wim_path(cmds[i].delete_.wim_path);
+                       if (!cmds_copy[i].delete_.wim_path)
                                goto oom;
-                       cmds_copy[i].delete.delete_flags = cmds[i].delete.delete_flags;
+                       cmds_copy[i].delete_.delete_flags = cmds[i].delete_.delete_flags;
                        break;
                case WIMLIB_UPDATE_OP_RENAME:
                        cmds_copy[i].rename.wim_source_path =
@@ -665,9 +687,7 @@ err:
        goto out;
 }
 
-/*
- * Entry point for making a series of updates to a WIM image.
- */
+/* API function documented in wimlib.h  */
 WIMLIBAPI int
 wimlib_update_image(WIMStruct *wim,
                    int image,
@@ -678,15 +698,24 @@ wimlib_update_image(WIMStruct *wim,
 {
        int ret;
        struct wimlib_update_command *cmds_copy;
+       bool deletion_requested = false;
+
+       if (update_flags & ~WIMLIB_UPDATE_FLAG_SEND_PROGRESS)
+               return WIMLIB_ERR_INVALID_PARAM;
 
        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;
+       for (size_t i = 0; i < num_cmds; i++)
+               if (cmds[i].op == WIMLIB_UPDATE_OP_DELETE)
+                       deletion_requested = true;
+
+       if (deletion_requested)
+               ret = can_delete_from_wim(wim);
+       else
+               ret = can_modify_wim(wim);
+
+       if (ret)
                goto out;
-       }
 
        /* Load the metadata for the image to modify (if not loaded already) */
        ret = select_wim_image(wim, image);
@@ -716,7 +745,8 @@ wimlib_update_image(WIMStruct *wim,
 
        /* Actually execute the update commands. */
        DEBUG("Executing %zu update commands", num_cmds);
-       ret = execute_update_commands(wim, cmds_copy, num_cmds, progress_func);
+       ret = execute_update_commands(wim, cmds_copy, num_cmds, update_flags,
+                                     progress_func);
        if (ret)
                goto out_free_cmds_copy;