55d2a2a751a2a51dacea48111ea109133efdf180
[wimlib] / src / iterate_dir.c
1 /*
2  * iterate_dir.c
3  *
4  * Iterate through files in a WIM image.
5  * This is the stable API; internal code can just use for_dentry_in_tree().
6  */
7
8 /*
9  * Copyright (C) 2013-2016 Eric Biggers
10  *
11  * This file is free software; you can redistribute it and/or modify it under
12  * the terms of the GNU Lesser General Public License as published by the Free
13  * Software Foundation; either version 3 of the License, or (at your option) any
14  * later version.
15  *
16  * This file is distributed in the hope that it will be useful, but WITHOUT
17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
19  * details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this file; if not, see http://www.gnu.org/licenses/.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 #  include "config.h"
27 #endif
28
29 #include "wimlib.h"
30 #include "wimlib/blob_table.h"
31 #include "wimlib/dentry.h"
32 #include "wimlib/encoding.h"
33 #include "wimlib/metadata.h"
34 #include "wimlib/object_id.h"
35 #include "wimlib/paths.h"
36 #include "wimlib/security.h"
37 #include "wimlib/timestamp.h"
38 #include "wimlib/unix_data.h"
39 #include "wimlib/util.h"
40 #include "wimlib/wim.h"
41
42 static int
43 stream_to_wimlib_stream_entry(const struct wim_inode *inode,
44                               const struct wim_inode_stream *strm,
45                               struct wimlib_stream_entry *wstream,
46                               const struct blob_table *blob_table,
47                               int flags)
48 {
49         const struct blob_descriptor *blob;
50         const u8 *hash;
51
52         if (stream_is_named(strm)) {
53                 int ret;
54
55                 ret = utf16le_get_tstr(strm->stream_name,
56                                        utf16le_len_bytes(strm->stream_name),
57                                        &wstream->stream_name, NULL);
58                 if (ret)
59                         return ret;
60         }
61
62         blob = stream_blob(strm, blob_table);
63         if (blob) {
64                 blob_to_wimlib_resource_entry(blob, &wstream->resource);
65         } else if (!is_zero_hash((hash = stream_hash(strm)))) {
66                 if (flags & WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED)
67                         return blob_not_found_error(inode, hash);
68                 copy_hash(wstream->resource.sha1_hash, hash);
69                 wstream->resource.is_missing = 1;
70         }
71         return 0;
72 }
73
74 static int
75 get_default_stream_type(const struct wim_inode *inode)
76 {
77         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
78                 return STREAM_TYPE_EFSRPC_RAW_DATA;
79         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
80                 return STREAM_TYPE_REPARSE_POINT;
81         return STREAM_TYPE_DATA;
82 }
83
84 static int
85 init_wimlib_dentry(struct wimlib_dir_entry *wdentry, struct wim_dentry *dentry,
86                    WIMStruct *wim, int flags)
87 {
88         int ret;
89         const struct wim_inode *inode = dentry->d_inode;
90         const struct wim_inode_stream *strm;
91         struct wimlib_unix_data unix_data;
92         const void *object_id;
93         u32 object_id_len;
94
95         ret = utf16le_get_tstr(dentry->d_name, dentry->d_name_nbytes,
96                                &wdentry->filename, NULL);
97         if (ret)
98                 return ret;
99
100         ret = utf16le_get_tstr(dentry->d_short_name, dentry->d_short_name_nbytes,
101                                &wdentry->dos_name, NULL);
102         if (ret)
103                 return ret;
104
105         ret = calculate_dentry_full_path(dentry);
106         if (ret)
107                 return ret;
108         wdentry->full_path = dentry->d_full_path;
109
110         for (struct wim_dentry *d = dentry; !dentry_is_root(d); d = d->d_parent)
111                 wdentry->depth++;
112
113         if (inode_has_security_descriptor(inode)) {
114                 struct wim_security_data *sd;
115
116                 sd = wim_get_current_security_data(wim);
117                 wdentry->security_descriptor = sd->descriptors[inode->i_security_id];
118                 wdentry->security_descriptor_size = sd->sizes[inode->i_security_id];
119         }
120         wdentry->reparse_tag = inode->i_reparse_tag;
121         wdentry->num_links = inode->i_nlink;
122         wdentry->attributes = inode->i_attributes;
123         wdentry->hard_link_group_id = inode->i_ino;
124         wdentry->creation_time = wim_timestamp_to_timespec(inode->i_creation_time);
125         wdentry->last_write_time = wim_timestamp_to_timespec(inode->i_last_write_time);
126         wdentry->last_access_time = wim_timestamp_to_timespec(inode->i_last_access_time);
127         if (inode_get_unix_data(inode, &unix_data)) {
128                 wdentry->unix_uid = unix_data.uid;
129                 wdentry->unix_gid = unix_data.gid;
130                 wdentry->unix_mode = unix_data.mode;
131                 wdentry->unix_rdev = unix_data.rdev;
132         }
133         object_id = inode_get_object_id(inode, &object_id_len);
134         if (unlikely(object_id != NULL)) {
135                 memcpy(&wdentry->object_id, object_id,
136                        min(object_id_len, sizeof(wdentry->object_id)));
137         }
138
139         strm = inode_get_unnamed_stream(inode, get_default_stream_type(inode));
140         if (strm) {
141                 ret = stream_to_wimlib_stream_entry(inode, strm,
142                                                     &wdentry->streams[0],
143                                                     wim->blob_table, flags);
144                 if (ret)
145                         return ret;
146         }
147
148         for (unsigned i = 0; i < inode->i_num_streams; i++) {
149
150                 strm = &inode->i_streams[i];
151
152                 if (!stream_is_named_data_stream(strm))
153                         continue;
154
155                 wdentry->num_named_streams++;
156
157                 ret = stream_to_wimlib_stream_entry(inode, strm,
158                                                     &wdentry->streams[
159                                                         wdentry->num_named_streams],
160                                                     wim->blob_table, flags);
161                 if (ret)
162                         return ret;
163         }
164         return 0;
165 }
166
167 static void
168 free_wimlib_dentry(struct wimlib_dir_entry *wdentry)
169 {
170         utf16le_put_tstr(wdentry->filename);
171         utf16le_put_tstr(wdentry->dos_name);
172         for (unsigned i = 1; i <= wdentry->num_named_streams; i++)
173                 utf16le_put_tstr(wdentry->streams[i].stream_name);
174         FREE(wdentry);
175 }
176
177 static int
178 do_iterate_dir_tree(WIMStruct *wim,
179                     struct wim_dentry *dentry, int flags,
180                     wimlib_iterate_dir_tree_callback_t cb,
181                     void *user_ctx)
182 {
183         struct wimlib_dir_entry *wdentry;
184         int ret = WIMLIB_ERR_NOMEM;
185
186
187         wdentry = CALLOC(1, sizeof(struct wimlib_dir_entry) +
188                                   (1 + dentry->d_inode->i_num_streams) *
189                                         sizeof(struct wimlib_stream_entry));
190         if (wdentry == NULL)
191                 goto out;
192
193         ret = init_wimlib_dentry(wdentry, dentry, wim, flags);
194         if (ret)
195                 goto out_free_wimlib_dentry;
196
197         if (!(flags & WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN)) {
198                 ret = (*cb)(wdentry, user_ctx);
199                 if (ret)
200                         goto out_free_wimlib_dentry;
201         }
202
203         if (flags & (WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE |
204                      WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN))
205         {
206                 struct wim_dentry *child;
207
208                 ret = 0;
209                 for_dentry_child(child, dentry) {
210                         ret = do_iterate_dir_tree(wim, child,
211                                                   flags & ~WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN,
212                                                   cb, user_ctx);
213                         if (ret)
214                                 break;
215                 }
216         }
217 out_free_wimlib_dentry:
218         FREE(dentry->d_full_path);
219         dentry->d_full_path = NULL;
220         free_wimlib_dentry(wdentry);
221 out:
222         return ret;
223 }
224
225 struct image_iterate_dir_tree_ctx {
226         const tchar *path;
227         int flags;
228         wimlib_iterate_dir_tree_callback_t cb;
229         void *user_ctx;
230 };
231
232
233 static int
234 image_do_iterate_dir_tree(WIMStruct *wim)
235 {
236         struct image_iterate_dir_tree_ctx *ctx = wim->private;
237         struct wim_dentry *dentry;
238
239         dentry = get_dentry(wim, ctx->path, WIMLIB_CASE_PLATFORM_DEFAULT);
240         if (dentry == NULL)
241                 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
242         return do_iterate_dir_tree(wim, dentry, ctx->flags, ctx->cb, ctx->user_ctx);
243 }
244
245 /* API function documented in wimlib.h  */
246 WIMLIBAPI int
247 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const tchar *_path,
248                         int flags,
249                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx)
250 {
251         tchar *path;
252         int ret;
253
254         if (flags & ~(WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE |
255                       WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN |
256                       WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED))
257                 return WIMLIB_ERR_INVALID_PARAM;
258
259         path = canonicalize_wim_path(_path);
260         if (path == NULL)
261                 return WIMLIB_ERR_NOMEM;
262
263         ret = wim_checksum_unhashed_blobs(wim);
264         if (ret)
265                 return ret;
266
267         struct image_iterate_dir_tree_ctx ctx = {
268                 .path = path,
269                 .flags = flags,
270                 .cb = cb,
271                 .user_ctx = user_ctx,
272         };
273         wim->private = &ctx;
274         ret = for_image(wim, image, image_do_iterate_dir_tree);
275         FREE(path);
276         return ret;
277 }