Refactor headers
[wimlib] / src / add_image.c
1 /*
2  * add_image.c - Add an image to a WIM file.
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "wimlib.h"
29 #include "wimlib/capture.h"
30 #include "wimlib/error.h"
31 #include "wimlib/lookup_table.h"
32 #include "wimlib/metadata.h"
33 #include "wimlib/xml.h"
34
35 /*
36  * Adds the dentry tree and security data for a new image to the image metadata
37  * array of the WIMStruct.
38  */
39 static int
40 add_new_dentry_tree(WIMStruct *wim, struct wim_dentry *root_dentry,
41                     struct wim_security_data *sd)
42 {
43         struct wim_image_metadata *new_imd;
44         struct wim_lookup_table_entry *metadata_lte;
45         int ret;
46
47         metadata_lte = new_lookup_table_entry();
48         if (!metadata_lte)
49                 return WIMLIB_ERR_NOMEM;
50
51         metadata_lte->resource_entry.flags = WIM_RESHDR_FLAG_METADATA;
52         metadata_lte->unhashed = 1;
53
54         new_imd = new_image_metadata();
55         if (!new_imd) {
56                 free_lookup_table_entry(metadata_lte);
57                 return WIMLIB_ERR_NOMEM;
58         }
59
60         new_imd->root_dentry    = root_dentry;
61         new_imd->metadata_lte   = metadata_lte;
62         new_imd->security_data  = sd;
63         new_imd->modified       = 1;
64
65         ret = append_image_metadata(wim, new_imd);
66         if (ret)
67                 put_image_metadata(new_imd, NULL);
68         return ret;
69 }
70
71 /* Append an empty image to the WIMStruct. */
72 WIMLIBAPI int
73 wimlib_add_empty_image(WIMStruct *wim, const tchar *name, int *new_idx_ret)
74 {
75         int ret;
76         struct wim_security_data *sd;
77
78         DEBUG("Adding empty image \"%"TS"\"", name);
79
80         if (name == NULL || name[0] == T('\0')) {
81                 ERROR("Must specify a non-empty string for the image name");
82                 ret = WIMLIB_ERR_INVALID_PARAM;
83                 goto out;
84         }
85
86         if (wim->hdr.total_parts != 1) {
87                 ERROR("Cannot add an image to a split WIM");
88                 ret = WIMLIB_ERR_SPLIT_UNSUPPORTED;
89                 goto out;
90         }
91
92         if (wimlib_image_name_in_use(wim, name)) {
93                 ERROR("There is already an image named \"%"TS"\" in the WIM!",
94                       name);
95                 ret = WIMLIB_ERR_IMAGE_NAME_COLLISION;
96                 goto out;
97         }
98
99         sd = new_wim_security_data();
100         if (!sd) {
101                 ret = WIMLIB_ERR_NOMEM;
102                 goto out;
103         }
104
105         ret = add_new_dentry_tree(wim, NULL, sd);
106         if (ret)
107                 goto out_free_security_data;
108
109         ret = xml_add_image(wim, name);
110         if (ret)
111                 goto out_put_image_metadata;
112
113         if (new_idx_ret)
114                 *new_idx_ret = wim->hdr.image_count;
115         DEBUG("Successfully added new image (index %d)",
116               wim->hdr.image_count);
117         goto out;
118 out_put_image_metadata:
119         put_image_metadata(wim->image_metadata[--wim->hdr.image_count],
120                            wim->lookup_table);
121         goto out;
122 out_free_security_data:
123         free_security_data(sd);
124 out:
125         return ret;
126 }
127
128 static struct wimlib_update_command *
129 capture_sources_to_add_cmds(const struct wimlib_capture_source *sources,
130                             size_t num_sources,
131                             int add_flags,
132                             const struct wimlib_capture_config *config)
133 {
134         struct wimlib_update_command *add_cmds;
135
136         DEBUG("Translating %zu capture sources to `struct wimlib_update_command's",
137               num_sources);
138         add_cmds = CALLOC(num_sources, sizeof(add_cmds[0]));
139         if (add_cmds) {
140                 for (size_t i = 0; i < num_sources; i++) {
141                         DEBUG("Source %zu of %zu: fs_source_path=\"%"TS"\", "
142                               "wim_target_path=\"%"TS"\"",
143                               i + 1, num_sources,
144                               sources[i].fs_source_path,
145                               sources[i].wim_target_path);
146                         add_cmds[i].op = WIMLIB_UPDATE_OP_ADD;
147                         add_cmds[i].add.add_flags = add_flags;
148                         add_cmds[i].add.config = (struct wimlib_capture_config*)config;
149                         add_cmds[i].add.fs_source_path = sources[i].fs_source_path;
150                         add_cmds[i].add.wim_target_path = sources[i].wim_target_path;
151                 }
152         }
153         return add_cmds;
154 }
155
156 /* Adds an image to the WIMStruct from multiple on-disk directory trees, or a
157  * NTFS volume. */
158 WIMLIBAPI int
159 wimlib_add_image_multisource(WIMStruct *wim,
160                              const struct wimlib_capture_source *sources,
161                              size_t num_sources,
162                              const tchar *name,
163                              const struct wimlib_capture_config *config,
164                              int add_flags,
165                              wimlib_progress_func_t progress_func)
166 {
167         int ret;
168         struct wimlib_update_command *add_cmds;
169
170         DEBUG("Adding image \"%"TS"\" from %zu sources (add_flags=%#x)",
171               name, num_sources, add_flags);
172
173         /* Add the new image (initially empty) */
174         ret = wimlib_add_empty_image(wim, name, NULL);
175         if (ret)
176                 goto out;
177
178         /* Translate the "capture sources" into generic update commands. */
179         add_cmds = capture_sources_to_add_cmds(sources, num_sources,
180                                                add_flags, config);
181         if (!add_cmds) {
182                 ret = WIMLIB_ERR_NOMEM;
183                 goto out_delete_image;
184         }
185
186         /* Delegate the work to wimlib_update_image(). */
187         ret = wimlib_update_image(wim, wim->hdr.image_count, add_cmds,
188                                   num_sources, 0, progress_func);
189         FREE(add_cmds);
190         if (ret)
191                 goto out_delete_image;
192
193         /* Success; set boot index if requested. */
194         if (add_flags & WIMLIB_ADD_FLAG_BOOT)
195                 wim->hdr.boot_idx = wim->hdr.image_count;
196         ret = 0;
197         goto out;
198 out_delete_image:
199         /* Roll back the image we added */
200         put_image_metadata(wim->image_metadata[wim->hdr.image_count - 1],
201                            wim->lookup_table);
202         xml_delete_image(&wim->wim_info, wim->hdr.image_count);
203         wim->hdr.image_count--;
204 out:
205         return ret;
206 }
207
208 /* Adds an image to the WIMStruct from an on-disk directory tree or NTFS volume. */
209 WIMLIBAPI int
210 wimlib_add_image(WIMStruct *wim,
211                  const tchar *source,
212                  const tchar *name,
213                  const struct wimlib_capture_config *config,
214                  int add_flags,
215                  wimlib_progress_func_t progress_func)
216 {
217         /* Delegate the work to the more general wimlib_add_image_multisource().
218          * */
219         const struct wimlib_capture_source capture_src = {
220                 .fs_source_path = (tchar*)source,
221                 .wim_target_path = T(""),
222                 .reserved = 0,
223         };
224         return wimlib_add_image_multisource(wim, &capture_src, 1, name,
225                                             config, add_flags,
226                                             progress_func);
227 }