wimlib.net Git - wimlib/blob - src/add_image.c

   1 /*
   2  * add_image.c - Add an image to a WIM file.
   3  */
   4
   5 /*
   6  * Copyright (C) 2012, 2013, 2014 Eric Biggers
   7  *
   8  * This file is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Lesser General Public License as published by the Free
  10  * Software Foundation; either version 3 of the License, or (at your option) any
  11  * later version.
  12  *
  13  * This file is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this file; if not, see http://www.gnu.org/licenses/.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #  include "config.h"
  24 #endif
  25
  26 #include "wimlib.h"
  27 #include "wimlib/blob_table.h"
  28 #include "wimlib/error.h"
  29 #include "wimlib/metadata.h"
  30 #include "wimlib/security.h"
  31 #include "wimlib/xml.h"
  32
  33 /* Creates and appends a 'struct wim_image_metadata' for an empty image.
  34  *
  35  * The resulting image will be the last in the WIM, so its index will be
  36  * the new value of wim->hdr.image_count.  */
  37 static int
  38 add_empty_image_metadata(WIMStruct *wim)
  39 {
  40         int ret;
  41         struct blob_descriptor *metadata_blob;
  42         struct wim_security_data *sd;
  43         struct wim_image_metadata *imd;
  44
  45         /* Create a blob descriptor for the new metadata resource.  */
  46         ret = WIMLIB_ERR_NOMEM;
  47         metadata_blob = new_blob_descriptor();
  48         if (!metadata_blob)
  49                 goto out;
  50
  51         metadata_blob->refcnt = 1;
  52         metadata_blob->unhashed = 1;
  53         metadata_blob->is_metadata = 1;
  54
  55         /* Create empty security data (no security descriptors).  */
  56         sd = new_wim_security_data();
  57         if (!sd)
  58                 goto out_free_metadata_blob;
  59
  60         imd = new_image_metadata();
  61         if (!imd)
  62                 goto out_free_security_data;
  63
  64         /* A NULL root_dentry indicates a completely empty image, without even a
  65          * root directory.  */
  66         imd->root_dentry = NULL;
  67         imd->metadata_blob = metadata_blob;
  68         imd->security_data = sd;
  69         imd->modified = 1;
  70
  71         /* Append as next image index.  */
  72         ret = append_image_metadata(wim, imd);
  73         if (ret)
  74                 put_image_metadata(imd, NULL);
  75         goto out;
  76
  77 out_free_security_data:
  78         free_wim_security_data(sd);
  79 out_free_metadata_blob:
  80         free_blob_descriptor(metadata_blob);
  81 out:
  82         return ret;
  83 }
  84
  85 /* API function documented in wimlib.h  */
  86 WIMLIBAPI int
  87 wimlib_add_empty_image(WIMStruct *wim, const tchar *name, int *new_idx_ret)
  88 {
  89         int ret;
  90
  91         if (wimlib_image_name_in_use(wim, name)) {
  92                 ERROR("There is already an image named \"%"TS"\" in the WIM!",
  93                       name);
  94                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
  95         }
  96
  97         ret = add_empty_image_metadata(wim);
  98         if (ret)
  99                 return ret;
 100
 101         ret = xml_add_image(wim->xml_info, name);
 102         if (ret) {
 103                 put_image_metadata(wim->image_metadata[--wim->hdr.image_count],
 104                                    NULL);
 105                 return ret;
 106         }
 107
 108         if (new_idx_ret)
 109                 *new_idx_ret = wim->hdr.image_count;
 110         return 0;
 111 }
 112
 113 /* Translate the 'struct wimlib_capture_source's passed to
 114  * wimlib_add_image_multisource() into 'struct wimlib_update_command's for
 115  * wimlib_update_image().  */
 116 static struct wimlib_update_command *
 117 capture_sources_to_add_cmds(const struct wimlib_capture_source *sources,
 118                             size_t num_sources,
 119                             int add_flags,
 120                             const tchar *config_file)
 121 {
 122         struct wimlib_update_command *add_cmds;
 123
 124         add_cmds = CALLOC(num_sources, sizeof(add_cmds[0]));
 125         if (!add_cmds)
 126                 return NULL;
 127
 128         /* WIMLIB_ADD_FLAG_BOOT is handled by wimlib_add_image_multisource(),
 129          * not wimlib_update_image(), so mask it out.
 130          *
 131          * However, WIMLIB_ADD_FLAG_WIMBOOT is handled by both.  */
 132         add_flags &= ~WIMLIB_ADD_FLAG_BOOT;
 133
 134         for (size_t i = 0; i < num_sources; i++) {
 135                 add_cmds[i].op = WIMLIB_UPDATE_OP_ADD;
 136                 add_cmds[i].add.fs_source_path = sources[i].fs_source_path;
 137                 add_cmds[i].add.wim_target_path = sources[i].wim_target_path;
 138                 add_cmds[i].add.add_flags = add_flags;
 139                 add_cmds[i].add.config_file = (tchar *)config_file;
 140         }
 141         return add_cmds;
 142 }
 143
 144 /* API function documented in wimlib.h  */
 145 WIMLIBAPI int
 146 wimlib_add_image_multisource(WIMStruct *wim,
 147                              const struct wimlib_capture_source *sources,
 148                              size_t num_sources,
 149                              const tchar *name,
 150                              const tchar *config_file,
 151                              int add_flags)
 152 {
 153         int ret;
 154         struct wimlib_update_command *add_cmds;
 155
 156         /* Make sure no reserved fields are set.  */
 157         for (size_t i = 0; i < num_sources; i++)
 158                 if (sources[i].reserved != 0)
 159                         return WIMLIB_ERR_INVALID_PARAM;
 160
 161         /* Add the new image (initially empty).  */
 162         ret = wimlib_add_empty_image(wim, name, NULL);
 163         if (ret)
 164                 return ret;
 165
 166         /* Translate the "capture sources" into generic update commands.  */
 167         ret = WIMLIB_ERR_NOMEM;
 168         add_cmds = capture_sources_to_add_cmds(sources, num_sources,
 169                                                add_flags, config_file);
 170         if (!add_cmds)
 171                 goto out_delete_image;
 172
 173         /* Delegate the work to wimlib_update_image().  */
 174         ret = wimlib_update_image(wim, wim->hdr.image_count, add_cmds,
 175                                   num_sources, 0);
 176         FREE(add_cmds);
 177         if (ret)
 178                 goto out_delete_image;
 179
 180         /* If requested, mark the new image as WIMBoot-compatible.  */
 181         if (add_flags & WIMLIB_ADD_FLAG_WIMBOOT) {
 182                 ret = xml_set_wimboot(wim->xml_info, wim->hdr.image_count);
 183                 if (ret)
 184                         goto out_delete_image;
 185         }
 186
 187         /* If requested, set this image as the WIM's bootable image.  */
 188         if (add_flags & WIMLIB_ADD_FLAG_BOOT)
 189                 wim->hdr.boot_idx = wim->hdr.image_count;
 190
 191         return 0;
 192
 193 out_delete_image:
 194         /* Unsuccessful; rollback by removing the new image.  */
 195         delete_wim_image(wim, wim->hdr.image_count);
 196         return ret;
 197 }
 198
 199 /* API function documented in wimlib.h  */
 200 WIMLIBAPI int
 201 wimlib_add_image(WIMStruct *wim,
 202                  const tchar *source,
 203                  const tchar *name,
 204                  const tchar *config_file,
 205                  int add_flags)
 206 {
 207         /* Use the more general wimlib_add_image_multisource().  */
 208         const struct wimlib_capture_source capture_src = {
 209                 .fs_source_path = (tchar *)source,
 210                 .wim_target_path = WIMLIB_WIM_ROOT_PATH,
 211                 .reserved = 0,
 212         };
 213         return wimlib_add_image_multisource(wim, &capture_src, 1, name,
 214                                             config_file, add_flags);
 215 }