wimlib: strict checks for unassigned flags
[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 == NULL)
49                 return WIMLIB_ERR_NOMEM;
50
51         metadata_lte->flags = WIM_RESHDR_FLAG_METADATA;
52         metadata_lte->unhashed = 1;
53
54         new_imd = new_image_metadata();
55         if (new_imd == NULL) {
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 /* API function documented in wimlib.h  */
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)
81                 name = T("");
82
83         ret = can_modify_wim(wim);
84         if (ret)
85                 goto out;
86
87         if (wimlib_image_name_in_use(wim, name)) {
88                 ERROR("There is already an image named \"%"TS"\" in the WIM!",
89                       name);
90                 ret = WIMLIB_ERR_IMAGE_NAME_COLLISION;
91                 goto out;
92         }
93
94         sd = new_wim_security_data();
95         if (sd == NULL) {
96                 ret = WIMLIB_ERR_NOMEM;
97                 goto out;
98         }
99
100         ret = add_new_dentry_tree(wim, NULL, sd);
101         if (ret)
102                 goto out_free_security_data;
103
104         ret = xml_add_image(wim, name);
105         if (ret)
106                 goto out_put_image_metadata;
107
108         if (new_idx_ret)
109                 *new_idx_ret = wim->hdr.image_count;
110         DEBUG("Successfully added new image (index %d)",
111               wim->hdr.image_count);
112         goto out;
113 out_put_image_metadata:
114         put_image_metadata(wim->image_metadata[--wim->hdr.image_count],
115                            wim->lookup_table);
116         goto out;
117 out_free_security_data:
118         free_wim_security_data(sd);
119 out:
120         return ret;
121 }
122
123 static struct wimlib_update_command *
124 capture_sources_to_add_cmds(const struct wimlib_capture_source *sources,
125                             size_t num_sources,
126                             int add_flags,
127                             const struct wimlib_capture_config *config)
128 {
129         struct wimlib_update_command *add_cmds;
130
131         DEBUG("Translating %zu capture sources to `struct wimlib_update_command's",
132               num_sources);
133         add_cmds = CALLOC(num_sources, sizeof(add_cmds[0]));
134         if (add_cmds) {
135                 for (size_t i = 0; i < num_sources; i++) {
136                         DEBUG("Source %zu of %zu: fs_source_path=\"%"TS"\", "
137                               "wim_target_path=\"%"TS"\"",
138                               i + 1, num_sources,
139                               sources[i].fs_source_path,
140                               sources[i].wim_target_path);
141                         add_cmds[i].op = WIMLIB_UPDATE_OP_ADD;
142                         add_cmds[i].add.add_flags = add_flags & ~WIMLIB_ADD_FLAG_BOOT;
143                         add_cmds[i].add.config = (struct wimlib_capture_config*)config;
144                         add_cmds[i].add.fs_source_path = sources[i].fs_source_path;
145                         add_cmds[i].add.wim_target_path = sources[i].wim_target_path;
146                 }
147         }
148         return add_cmds;
149 }
150
151 /* API function documented in wimlib.h  */
152 WIMLIBAPI int
153 wimlib_add_image_multisource(WIMStruct *wim,
154                              const struct wimlib_capture_source *sources,
155                              size_t num_sources,
156                              const tchar *name,
157                              const struct wimlib_capture_config *config,
158                              int add_flags,
159                              wimlib_progress_func_t progress_func)
160 {
161         int ret;
162         struct wimlib_update_command *add_cmds;
163
164         DEBUG("Adding image \"%"TS"\" from %zu sources (add_flags=%#x)",
165               name, num_sources, add_flags);
166
167         for (size_t i = 0; i < num_sources; i++)
168                 if (sources[i].reserved != 0)
169                         return WIMLIB_ERR_INVALID_PARAM;
170
171         /* Add the new image (initially empty) */
172         ret = wimlib_add_empty_image(wim, name, NULL);
173         if (ret)
174                 goto out;
175
176         /* Translate the "capture sources" into generic update commands. */
177         add_cmds = capture_sources_to_add_cmds(sources, num_sources,
178                                                add_flags, config);
179         if (add_cmds == NULL) {
180                 ret = WIMLIB_ERR_NOMEM;
181                 goto out_delete_image;
182         }
183
184         /* Delegate the work to wimlib_update_image(). */
185         ret = wimlib_update_image(wim, wim->hdr.image_count, add_cmds,
186                                   num_sources, 0, progress_func);
187         FREE(add_cmds);
188         if (ret)
189                 goto out_delete_image;
190
191         /* Success; set boot index if requested. */
192         if (add_flags & WIMLIB_ADD_FLAG_BOOT)
193                 wim->hdr.boot_idx = wim->hdr.image_count;
194         ret = 0;
195         goto out;
196 out_delete_image:
197         /* Roll back the image we added */
198         put_image_metadata(wim->image_metadata[wim->hdr.image_count - 1],
199                            wim->lookup_table);
200         xml_delete_image(&wim->wim_info, wim->hdr.image_count);
201         wim->hdr.image_count--;
202 out:
203         return ret;
204 }
205
206 /* API function documented in wimlib.h  */
207 WIMLIBAPI int
208 wimlib_add_image(WIMStruct *wim,
209                  const tchar *source,
210                  const tchar *name,
211                  const struct wimlib_capture_config *config,
212                  int add_flags,
213                  wimlib_progress_func_t progress_func)
214 {
215         /* Delegate the work to the more general wimlib_add_image_multisource().
216          * */
217         const struct wimlib_capture_source capture_src = {
218                 .fs_source_path = (tchar*)source,
219                 .wim_target_path = T(""),
220                 .reserved = 0,
221         };
222         return wimlib_add_image_multisource(wim, &capture_src, 1, name,
223                                             config, add_flags,
224                                             progress_func);
225 }