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/error.h"
  28 #include "wimlib/lookup_table.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 wim_lookup_table_entry *metadata_lte;
  42         struct wim_security_data *sd;
  43         struct wim_image_metadata *imd;
  44
  45         /* Create lookup table entry for this metadata resource (for now really
  46          * just a dummy entry).  */
  47         ret = WIMLIB_ERR_NOMEM;
  48         metadata_lte = new_lookup_table_entry();
  49         if (!metadata_lte)
  50                 goto out;
  51
  52         metadata_lte->flags = WIM_RESHDR_FLAG_METADATA;
  53         metadata_lte->unhashed = 1;
  54
  55         /* Create empty security data (no security descriptors).  */
  56         sd = new_wim_security_data();
  57         if (!sd)
  58                 goto out_free_metadata_lte;
  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_lte = metadata_lte;
  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_lte:
  80         free_lookup_table_entry(metadata_lte);
  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 (!name)
  92                 name = T("");
  93
  94         if (wimlib_image_name_in_use(wim, name)) {
  95                 ERROR("There is already an image named \"%"TS"\" in the WIM!",
  96                       name);
  97                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
  98         }
  99
 100         ret = add_empty_image_metadata(wim);
 101         if (ret)
 102                 return ret;
 103
 104         ret = xml_add_image(wim, name);
 105         if (ret) {
 106                 put_image_metadata(wim->image_metadata[--wim->hdr.image_count],
 107                                    NULL);
 108                 return ret;
 109         }
 110
 111         if (new_idx_ret)
 112                 *new_idx_ret = wim->hdr.image_count;
 113         return 0;
 114 }
 115
 116 /* Translate the 'struct wimlib_capture_source's passed to
 117  * wimlib_add_image_multisource() into 'struct wimlib_update_command's for
 118  * wimlib_update_image().  */
 119 static struct wimlib_update_command *
 120 capture_sources_to_add_cmds(const struct wimlib_capture_source *sources,
 121                             size_t num_sources,
 122                             int add_flags,
 123                             const tchar *config_file)
 124 {
 125         struct wimlib_update_command *add_cmds;
 126
 127         add_cmds = CALLOC(num_sources, sizeof(add_cmds[0]));
 128         if (!add_cmds)
 129                 return NULL;
 130
 131         /* WIMLIB_ADD_FLAG_BOOT is handled by wimlib_add_image_multisource(),
 132          * not wimlib_update_image(), so mask it out.
 133          *
 134          * However, WIMLIB_ADD_FLAG_WIMBOOT is handled by both.  */
 135         add_flags &= ~WIMLIB_ADD_FLAG_BOOT;
 136
 137         for (size_t i = 0; i < num_sources; i++) {
 138                 add_cmds[i].op = WIMLIB_UPDATE_OP_ADD;
 139                 add_cmds[i].add.fs_source_path = sources[i].fs_source_path;
 140                 add_cmds[i].add.wim_target_path = sources[i].wim_target_path;
 141                 add_cmds[i].add.add_flags = add_flags;
 142                 add_cmds[i].add.config_file = (tchar *)config_file;
 143         }
 144         return add_cmds;
 145 }
 146
 147 /* API function documented in wimlib.h  */
 148 WIMLIBAPI int
 149 wimlib_add_image_multisource(WIMStruct *wim,
 150                              const struct wimlib_capture_source *sources,
 151                              size_t num_sources,
 152                              const tchar *name,
 153                              const tchar *config_file,
 154                              int add_flags)
 155 {
 156         int ret;
 157         struct wimlib_update_command *add_cmds;
 158
 159         /* Make sure no reserved fields are set.  */
 160         for (size_t i = 0; i < num_sources; i++)
 161                 if (sources[i].reserved != 0)
 162                         return WIMLIB_ERR_INVALID_PARAM;
 163
 164         /* Add the new image (initially empty).  */
 165         ret = wimlib_add_empty_image(wim, name, NULL);
 166         if (ret)
 167                 return ret;
 168
 169         /* Translate the "capture sources" into generic update commands.  */
 170         ret = WIMLIB_ERR_NOMEM;
 171         add_cmds = capture_sources_to_add_cmds(sources, num_sources,
 172                                                add_flags, config_file);
 173         if (!add_cmds)
 174                 goto out_delete_image;
 175
 176         /* Delegate the work to wimlib_update_image().  */
 177         ret = wimlib_update_image(wim, wim->hdr.image_count, add_cmds,
 178                                   num_sources, 0);
 179         FREE(add_cmds);
 180         if (ret)
 181                 goto out_delete_image;
 182
 183         /* If requested, set this image as the WIM's bootable image.  */
 184         if (add_flags & WIMLIB_ADD_FLAG_BOOT)
 185                 wim->hdr.boot_idx = wim->hdr.image_count;
 186
 187         /* If requested, mark new image as WIMBoot-compatible.  */
 188         if (add_flags & WIMLIB_ADD_FLAG_WIMBOOT)
 189                 wim_info_set_wimboot(wim->wim_info, wim->hdr.image_count, true);
 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 }