Refactor headers
[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
149          * the symbolic link, then turn the target into a reparse point
150          * data buffer that contains a relative or absolute symbolic
151          * link (NOT a junction point or *full* path symbolic link with
152          * drive letter).
153          */
154         deref_name_len = readlink(path, deref_name_buf,
155                                   sizeof(deref_name_buf) - 1);
156         if (deref_name_len >= 0) {
157                 char *dest = deref_name_buf;
158
159                 dest[deref_name_len] = '\0';
160                 DEBUG("Read symlink `%s'", dest);
161
162                 if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
163                      dest[0] == '/')
164                 {
165                         dest = capture_fixup_absolute_symlink(dest,
166                                                               params->capture_root_ino,
167                                                               params->capture_root_dev);
168                         if (!dest) {
169                                 WARNING("Ignoring out of tree absolute symlink "
170                                         "\"%s\" -> \"%s\"\n"
171                                         "          (Use --norpfix to capture "
172                                         "absolute symlinks as-is)",
173                                         path, deref_name_buf);
174                                 free_dentry(*root_p);
175                                 *root_p = NULL;
176                                 return 0;
177                         }
178                         inode->i_not_rpfixed = 0;
179                 }
180                 ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
181                 if (ret == 0) {
182                         /* Unfortunately, Windows seems to have the concept of
183                          * "file" symbolic links as being different from
184                          * "directory" symbolic links...  so
185                          * FILE_ATTRIBUTE_DIRECTORY needs to be set on the
186                          * symbolic link if the *target* of the symbolic link is
187                          * a directory.  */
188                         struct stat stbuf;
189                         if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
190                                 inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
191                 }
192         } else {
193                 ERROR_WITH_ERRNO("Failed to read target of "
194                                  "symbolic link `%s'", path);
195                 ret = WIMLIB_ERR_READLINK;
196         }
197         return ret;
198 }
199
200 static int
201 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
202                                  char *path,
203                                  size_t path_len,
204                                  struct add_image_params *params)
205 {
206         struct wim_dentry *root = NULL;
207         int ret = 0;
208         struct wim_inode *inode;
209
210         if (exclude_path(path, path_len, params->config, true)) {
211                 if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
212                     && params->progress_func)
213                 {
214                         union wimlib_progress_info info;
215                         info.scan.cur_path = path;
216                         info.scan.excluded = true;
217                         params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
218                 }
219                 goto out;
220         }
221
222         if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
223             && params->progress_func)
224         {
225                 union wimlib_progress_info info;
226                 info.scan.cur_path = path;
227                 info.scan.excluded = false;
228                 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
229         }
230
231         struct stat stbuf;
232         int (*stat_fn)(const char *restrict, struct stat *restrict);
233         if ((params->add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) ||
234             (params->add_flags & WIMLIB_ADD_FLAG_ROOT))
235                 stat_fn = stat;
236         else
237                 stat_fn = lstat;
238
239         ret = (*stat_fn)(path, &stbuf);
240         if (ret) {
241                 ERROR_WITH_ERRNO("Failed to stat `%s'", path);
242                 ret = WIMLIB_ERR_STAT;
243                 goto out;
244         }
245         if (!S_ISREG(stbuf.st_mode) && !S_ISDIR(stbuf.st_mode)
246             && !S_ISLNK(stbuf.st_mode)) {
247                 ERROR("`%s' is not a regular file, directory, or symbolic link.",
248                       path);
249                 ret = WIMLIB_ERR_SPECIAL_FILE;
250                 goto out;
251         }
252
253         ret = inode_table_new_dentry(&params->inode_table,
254                                      path_basename_with_len(path, path_len),
255                                      stbuf.st_ino, stbuf.st_dev, false, &root);
256         if (ret)
257                 goto out;
258
259         inode = root->d_inode;
260
261         if (inode->i_nlink > 1) /* Already captured this inode? */
262                 goto out;
263
264 #ifdef HAVE_STAT_NANOSECOND_PRECISION
265         inode->i_creation_time = timespec_to_wim_timestamp(stbuf.st_mtim);
266         inode->i_last_write_time = timespec_to_wim_timestamp(stbuf.st_mtim);
267         inode->i_last_access_time = timespec_to_wim_timestamp(stbuf.st_atim);
268 #else
269         inode->i_creation_time = unix_timestamp_to_wim(stbuf.st_mtime);
270         inode->i_last_write_time = unix_timestamp_to_wim(stbuf.st_mtime);
271         inode->i_last_access_time = unix_timestamp_to_wim(stbuf.st_atime);
272 #endif
273         inode->i_resolved = 1;
274         if (params->add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
275                 ret = inode_set_unix_data(inode, stbuf.st_uid,
276                                           stbuf.st_gid,
277                                           stbuf.st_mode,
278                                           params->lookup_table,
279                                           UNIX_DATA_ALL | UNIX_DATA_CREATE);
280                 if (ret)
281                         goto out;
282         }
283         params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
284         if (S_ISREG(stbuf.st_mode))
285                 ret = unix_capture_regular_file(path, stbuf.st_size,
286                                                 inode, params->lookup_table);
287         else if (S_ISDIR(stbuf.st_mode))
288                 ret = unix_capture_directory(root, path, path_len, params);
289         else
290                 ret = unix_capture_symlink(&root, path, inode, params);
291 out:
292         if (ret == 0)
293                 *root_ret = root;
294         else
295                 free_dentry_tree(root, params->lookup_table);
296         return ret;
297 }
298
299 /*
300  * unix_build_dentry_tree():
301  *      Builds a tree of WIM dentries from an on-disk directory tree (UNIX
302  *      version; no NTFS-specific data is captured).
303  *
304  * @root_ret:   Place to return a pointer to the root of the dentry tree.  Only
305  *              modified if successful.  Set to NULL if the file or directory was
306  *              excluded from capture.
307  *
308  * @root_disk_path:  The path to the root of the directory tree on disk.
309  *
310  * @params:     See doc for `struct add_image_params'.
311  *
312  * @return:     0 on success, nonzero on failure.  It is a failure if any of
313  *              the files cannot be `stat'ed, or if any of the needed
314  *              directories cannot be opened or read.  Failure to add the files
315  *              to the WIM may still occur later when trying to actually read
316  *              the on-disk files during a call to wimlib_write() or
317  *              wimlib_overwrite().
318  */
319 int
320 unix_build_dentry_tree(struct wim_dentry **root_ret,
321                        const char *root_disk_path,
322                        struct add_image_params *params)
323 {
324         char *path_buf;
325         int ret;
326         size_t path_len;
327         size_t path_bufsz;
328
329         {
330                 struct stat root_stbuf;
331                 if (stat(root_disk_path, &root_stbuf)) {
332                         ERROR_WITH_ERRNO("Failed to stat \"%s\"", root_disk_path);
333                         return WIMLIB_ERR_STAT;
334                 }
335
336                 if ((params->add_flags & WIMLIB_ADD_FLAG_ROOT) &&
337                     !S_ISDIR(root_stbuf.st_mode))
338                 {
339                         ERROR("Root of capture \"%s\" is not a directory",
340                               root_disk_path);
341                         return WIMLIB_ERR_NOTDIR;
342                 }
343                 params->capture_root_ino = root_stbuf.st_ino;
344                 params->capture_root_dev = root_stbuf.st_dev;
345         }
346
347         path_bufsz = min(32790, PATH_MAX + 1);
348         path_len = strlen(root_disk_path);
349
350         if (path_len >= path_bufsz)
351                 return WIMLIB_ERR_INVALID_PARAM;
352
353         path_buf = MALLOC(path_bufsz);
354         if (!path_buf)
355                 return WIMLIB_ERR_NOMEM;
356         memcpy(path_buf, root_disk_path, path_len + 1);
357
358         ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
359                                                path_len, params);
360         FREE(path_buf);
361         return ret;
362 }
363
364 #endif /* !__WIN32__ */