wimlib: Clean up code that sends capture progress messages
[wimlib] / src / unix_capture.c
1 /*
2  * unix_capture.c:  Capture a directory tree on UNIX.
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 #ifndef __WIN32__
25
26 #ifdef HAVE_CONFIG_H
27 #  include "config.h"
28 #endif
29
30 #include <dirent.h>
31 #include <errno.h>
32 #include <limits.h>
33 #include <sys/stat.h>
34 #include <unistd.h>
35
36 #include "wimlib/capture.h"
37 #include "wimlib/dentry.h"
38 #include "wimlib/error.h"
39 #include "wimlib/lookup_table.h"
40 #include "wimlib/paths.h"
41 #include "wimlib/reparse.h"
42 #include "wimlib/timestamp.h"
43
44 static int
45 unix_capture_regular_file(const char *path,
46                           u64 size,
47                           struct wim_inode *inode,
48                           struct wim_lookup_table *lookup_table)
49 {
50         inode->i_attributes = FILE_ATTRIBUTE_NORMAL;
51
52         /* Empty files do not have to have a lookup table entry. */
53         if (size != 0) {
54                 struct wim_lookup_table_entry *lte;
55                 char *file_on_disk;
56
57                 file_on_disk = STRDUP(path);
58                 if (!file_on_disk)
59                         return WIMLIB_ERR_NOMEM;
60                 lte = new_lookup_table_entry();
61                 if (!lte) {
62                         FREE(file_on_disk);
63                         return WIMLIB_ERR_NOMEM;
64                 }
65                 lte->file_on_disk = file_on_disk;
66                 lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
67                 lte->resource_entry.original_size = size;
68                 lookup_table_insert_unhashed(lookup_table, lte, inode, 0);
69                 inode->i_lte = lte;
70         }
71         return 0;
72 }
73
74 static int
75 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
76                                  char *path,
77                                  size_t path_len,
78                                  struct add_image_params *params);
79
80 static int
81 unix_capture_directory(struct wim_dentry *dir_dentry,
82                        char *path,
83                        size_t path_len,
84                        struct add_image_params *params)
85 {
86
87         DIR *dir;
88         struct dirent *entry;
89         struct wim_dentry *child;
90         int ret;
91
92         dir_dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
93         dir = opendir(path);
94         if (!dir) {
95                 ERROR_WITH_ERRNO("Failed to open the directory `%s'",
96                                  path);
97                 return WIMLIB_ERR_OPENDIR;
98         }
99
100         /* Recurse on directory contents */
101         ret = 0;
102         for (;;) {
103                 errno = 0;
104                 entry = readdir(dir);
105                 if (!entry) {
106                         if (errno) {
107                                 ret = WIMLIB_ERR_READ;
108                                 ERROR_WITH_ERRNO("Error reading the "
109                                                  "directory `%s'", path);
110                         }
111                         break;
112                 }
113
114                 if (entry->d_name[0] == '.' && (entry->d_name[1] == '\0'
115                       || (entry->d_name[1] == '.' && entry->d_name[2] == '\0')))
116                                 continue;
117
118                 size_t name_len = strlen(entry->d_name);
119
120                 path[path_len] = '/';
121                 memcpy(&path[path_len + 1], entry->d_name, name_len + 1);
122                 ret = unix_build_dentry_tree_recursive(&child,
123                                                        path,
124                                                        path_len + 1 + name_len,
125                                                        params);
126                 if (ret)
127                         break;
128                 if (child)
129                         dentry_add_child(dir_dentry, child);
130         }
131         closedir(dir);
132         return ret;
133 }
134
135 static int
136 unix_capture_symlink(struct wim_dentry **root_p,
137                      const char *path,
138                      struct wim_inode *inode,
139                      struct add_image_params *params)
140 {
141         char deref_name_buf[4096];
142         ssize_t deref_name_len;
143         int ret;
144
145         inode->i_attributes = FILE_ATTRIBUTE_REPARSE_POINT;
146         inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
147
148         /* The idea here is to call readlink() to get the UNIX target of the
149          * symbolic link, then turn the target into a reparse point data buffer
150          * that contains a relative or absolute symbolic link. */
151         deref_name_len = readlink(path, deref_name_buf,
152                                   sizeof(deref_name_buf) - 1);
153         if (deref_name_len >= 0) {
154                 char *dest = deref_name_buf;
155
156                 dest[deref_name_len] = '\0';
157                 DEBUG("Read symlink `%s'", dest);
158
159                 if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
160                      dest[0] == '/')
161                 {
162                         dest = capture_fixup_absolute_symlink(dest,
163                                                               params->capture_root_ino,
164                                                               params->capture_root_dev);
165                         if (!dest) {
166                                 WARNING("Ignoring out of tree absolute symlink "
167                                         "\"%s\" -> \"%s\"\n"
168                                         "          (Use --norpfix to capture "
169                                         "absolute symlinks as-is)",
170                                         path, deref_name_buf);
171                                 free_dentry(*root_p);
172                                 *root_p = NULL;
173                                 return 0;
174                         }
175                         inode->i_not_rpfixed = 0;
176                 }
177                 ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
178                 if (ret == 0) {
179                         /* Unfortunately, Windows seems to have the concept of
180                          * "file" symbolic links as being different from
181                          * "directory" symbolic links...  so
182                          * FILE_ATTRIBUTE_DIRECTORY needs to be set on the
183                          * symbolic link if the *target* of the symbolic link is
184                          * a directory.  */
185                         struct stat stbuf;
186                         if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
187                                 inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
188                 }
189         } else {
190                 ERROR_WITH_ERRNO("Failed to read target of "
191                                  "symbolic link `%s'", path);
192                 ret = WIMLIB_ERR_READLINK;
193         }
194         return ret;
195 }
196
197 static int
198 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
199                                  char *path,
200                                  size_t path_len,
201                                  struct add_image_params *params)
202 {
203         struct wim_dentry *root = NULL;
204         int ret;
205         struct wim_inode *inode;
206
207         params->progress.scan.cur_path = path;
208
209         if (exclude_path(path, path_len, params->config, true)) {
210                 do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED);
211                 ret = 0;
212                 goto out;
213         }
214
215         struct stat stbuf;
216         int (*stat_fn)(const char *restrict, struct stat *restrict);
217         if ((params->add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) ||
218             (params->add_flags & WIMLIB_ADD_FLAG_ROOT))
219                 stat_fn = stat;
220         else
221                 stat_fn = lstat;
222
223         ret = (*stat_fn)(path, &stbuf);
224         if (ret) {
225                 ERROR_WITH_ERRNO("Failed to stat `%s'", path);
226                 ret = WIMLIB_ERR_STAT;
227                 goto out;
228         }
229         if (!S_ISREG(stbuf.st_mode) && !S_ISDIR(stbuf.st_mode)
230             && !S_ISLNK(stbuf.st_mode)) {
231                 if (params->add_flags & WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
232                 {
233                         ERROR("Can't archive unsupported file \"%s\"", path);
234                         ret = WIMLIB_ERR_UNSUPPORTED_FILE;
235                         goto out;
236                 }
237                 do_capture_progress(params, WIMLIB_SCAN_DENTRY_UNSUPPORTED);
238                 ret = 0;
239                 goto out;
240         }
241
242         do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK);
243
244         ret = inode_table_new_dentry(&params->inode_table,
245                                      path_basename_with_len(path, path_len),
246                                      stbuf.st_ino, stbuf.st_dev, false, &root);
247         if (ret)
248                 goto out;
249
250         inode = root->d_inode;
251
252         if (inode->i_nlink > 1) {
253                 /* Already captured this inode? */
254                 ret = 0;
255                 goto out;
256         }
257
258 #ifdef HAVE_STAT_NANOSECOND_PRECISION
259         inode->i_creation_time = timespec_to_wim_timestamp(stbuf.st_mtim);
260         inode->i_last_write_time = timespec_to_wim_timestamp(stbuf.st_mtim);
261         inode->i_last_access_time = timespec_to_wim_timestamp(stbuf.st_atim);
262 #else
263         inode->i_creation_time = unix_timestamp_to_wim(stbuf.st_mtime);
264         inode->i_last_write_time = unix_timestamp_to_wim(stbuf.st_mtime);
265         inode->i_last_access_time = unix_timestamp_to_wim(stbuf.st_atime);
266 #endif
267         inode->i_resolved = 1;
268         if (params->add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
269                 ret = inode_set_unix_data(inode, stbuf.st_uid,
270                                           stbuf.st_gid,
271                                           stbuf.st_mode,
272                                           params->lookup_table,
273                                           UNIX_DATA_ALL | UNIX_DATA_CREATE);
274                 if (ret)
275                         goto out;
276         }
277         params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
278         if (S_ISREG(stbuf.st_mode))
279                 ret = unix_capture_regular_file(path, stbuf.st_size,
280                                                 inode, params->lookup_table);
281         else if (S_ISDIR(stbuf.st_mode))
282                 ret = unix_capture_directory(root, path, path_len, params);
283         else
284                 ret = unix_capture_symlink(&root, path, inode, params);
285
286         if (ret)
287                 goto out;
288
289 out:
290         if (ret)
291                 free_dentry_tree(root, params->lookup_table);
292         else
293                 *root_ret = root;
294         return ret;
295 }
296
297 /*
298  * unix_build_dentry_tree():
299  *      Builds a tree of WIM dentries from an on-disk directory tree (UNIX
300  *      version; no NTFS-specific data is captured).
301  *
302  * @root_ret:   Place to return a pointer to the root of the dentry tree.  Only
303  *              modified if successful.  Set to NULL if the file or directory was
304  *              excluded from capture.
305  *
306  * @root_disk_path:  The path to the root of the directory tree on disk.
307  *
308  * @params:     See doc for `struct add_image_params'.
309  *
310  * @return:     0 on success, nonzero on failure.  It is a failure if any of
311  *              the files cannot be `stat'ed, or if any of the needed
312  *              directories cannot be opened or read.  Failure to add the files
313  *              to the WIM may still occur later when trying to actually read
314  *              the on-disk files during a call to wimlib_write() or
315  *              wimlib_overwrite().
316  */
317 int
318 unix_build_dentry_tree(struct wim_dentry **root_ret,
319                        const char *root_disk_path,
320                        struct add_image_params *params)
321 {
322         char *path_buf;
323         int ret;
324         size_t path_len;
325         size_t path_bufsz;
326
327         {
328                 struct stat root_stbuf;
329                 if (stat(root_disk_path, &root_stbuf)) {
330                         ERROR_WITH_ERRNO("Failed to stat \"%s\"", root_disk_path);
331                         return WIMLIB_ERR_STAT;
332                 }
333
334                 if ((params->add_flags & WIMLIB_ADD_FLAG_ROOT) &&
335                     !S_ISDIR(root_stbuf.st_mode))
336                 {
337                         ERROR("Root of capture \"%s\" is not a directory",
338                               root_disk_path);
339                         return WIMLIB_ERR_NOTDIR;
340                 }
341                 params->capture_root_ino = root_stbuf.st_ino;
342                 params->capture_root_dev = root_stbuf.st_dev;
343         }
344
345         path_bufsz = min(32790, PATH_MAX + 1);
346         path_len = strlen(root_disk_path);
347
348         if (path_len >= path_bufsz)
349                 return WIMLIB_ERR_INVALID_PARAM;
350
351         path_buf = MALLOC(path_bufsz);
352         if (!path_buf)
353                 return WIMLIB_ERR_NOMEM;
354         memcpy(path_buf, root_disk_path, path_len + 1);
355
356         ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
357                                                path_len, params);
358         FREE(path_buf);
359         return ret;
360 }
361
362 #endif /* !__WIN32__ */