]> wimlib.net Git - wimlib/blobdiff - src/update_image.c
update_image.c: Add file comment
[wimlib] / src / update_image.c
index 2577e037faa145adcb1bd557543d5b670c72b9ed..facdfff202ed4f702cad097a10155690ad2d404e 100644 (file)
@@ -1,24 +1,48 @@
 /*
- * update_image.c - Update a WIM image.
+ * update_image.c - see description below
  */
 
 /*
  * Copyright (C) 2013, 2014 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/.
+ */
+
+/*
+ * This file contains the implementation of wimlib_update_image(), which is one
+ * of the two ways by which library users can make changes to a WIM image.  (The
+ * other way is by mounting an image read-write.)  wimlib_update_image() is also
+ * used in the implementation of wimlib_add_image(), since "create a WIM image
+ * from this directory tree" is equivalent to "create an empty WIM image, then
+ * update it to add this directory tree as the root".
+ *
+ * wimlib_update_image() processes a list of commands passed to it.  Currently,
+ * the following types of commands are supported:
+ *
+ * - Add a directory tree from an external source (filesystem or NTFS volume).
+ *   This can be used to add new files or to replace existing files.
+ * - Delete a file or directory tree.
+ * - Rename a file or directory tree.
+ *
+ * Not supported are creating links to existing files or changing metadata of
+ * existing files.
+ *
+ * wimlib_update_image() is atomic.  If it cannot complete successfully, then
+ * all changes are rolled back and the WIMStruct is left unchanged.  Rollback is
+ * implemented by breaking the commands into primitive operations such as "link
+ * this dentry tree here" which can be undone by doing the opposite operations
+ * in reverse order.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -767,7 +791,7 @@ execute_add_command(struct update_command_journal *j,
        tchar *fs_source_path;
        tchar *wim_target_path;
        const tchar *config_file;
-       struct add_image_params params;
+       struct capture_params params;
        struct capture_config config;
        capture_tree_t capture_tree = platform_default_capture_tree;
 #ifdef WITH_NTFS_3G
@@ -869,8 +893,6 @@ execute_add_command(struct update_command_journal *j,
 #ifdef WITH_NTFS_3G
        wim_get_current_image_metadata(wim)->ntfs_vol = ntfs_vol;
 #endif
-       if (add_flags & WIMLIB_ADD_FLAG_RPFIX)
-               wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
        ret = 0;
        goto out_destroy_config;
 out_cleanup_after_capture:
@@ -1224,7 +1246,8 @@ check_add_command(struct wimlib_update_command *cmd,
                          WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE |
                          WIMLIB_ADD_FLAG_WINCONFIG |
                          WIMLIB_ADD_FLAG_WIMBOOT |
-                         WIMLIB_ADD_FLAG_NO_REPLACE))
+                         WIMLIB_ADD_FLAG_NO_REPLACE |
+                         WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION))
                return WIMLIB_ERR_INVALID_PARAM;
 
        bool is_entire_image = WIMLIB_IS_WIM_ROOT_PATH(cmd->add.wim_target_path);
@@ -1436,14 +1459,6 @@ wimlib_update_image(WIMStruct *wim,
 
        DEBUG("Updating image %d with %zu commands", image, num_cmds);
 
-       if (have_command_type(cmds, num_cmds, WIMLIB_UPDATE_OP_DELETE))
-               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);
        if (ret)
@@ -1477,18 +1492,17 @@ wimlib_update_image(WIMStruct *wim,
         * directories, may have changed.  Call xml_update_image_info() to
         * recalculate these statistics. */
        xml_update_image_info(wim, image);
+
+       for (size_t i = 0; i < num_cmds; i++)
+               if (cmds_copy[i].op == WIMLIB_UPDATE_OP_ADD &&
+                   cmds_copy[i].add.add_flags & WIMLIB_ADD_FLAG_RPFIX)
+                       wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
 out_free_cmds_copy:
        free_update_commands(cmds_copy, num_cmds);
 out:
        return ret;
 }
 
-static int
-update1(WIMStruct *wim, int image, const struct wimlib_update_command *cmd)
-{
-       return wimlib_update_image(wim, image, cmd, 1, 0);
-}
-
 WIMLIBAPI int
 wimlib_delete_path(WIMStruct *wim, int image,
                   const tchar *path, int delete_flags)
@@ -1499,7 +1513,7 @@ wimlib_delete_path(WIMStruct *wim, int image,
        cmd.delete_.wim_path = (tchar *)path;
        cmd.delete_.delete_flags = delete_flags;
 
-       return update1(wim, image, &cmd);
+       return wimlib_update_image(wim, image, &cmd, 1, 0);
 }
 
 WIMLIBAPI int
@@ -1513,7 +1527,7 @@ wimlib_rename_path(WIMStruct *wim, int image,
        cmd.rename.wim_target_path = (tchar *)dest_path;
        cmd.rename.rename_flags = 0;
 
-       return update1(wim, image, &cmd);
+       return wimlib_update_image(wim, image, &cmd, 1, 0);
 }
 
 WIMLIBAPI int
@@ -1529,5 +1543,5 @@ wimlib_add_tree(WIMStruct *wim, int image,
        cmd.add.add_flags = add_flags;
        cmd.add.config_file = NULL;
 
-       return update1(wim, image, &cmd);
+       return wimlib_update_image(wim, image, &cmd, 1, 0);
 }