2 * unix_capture.c: Capture a directory tree on UNIX.
6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
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)
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
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/.
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"
45 unix_capture_regular_file(const char *path,
47 struct wim_inode *inode,
48 struct wim_lookup_table *lookup_table)
50 inode->i_attributes = FILE_ATTRIBUTE_NORMAL;
52 /* Empty files do not have to have a lookup table entry. */
54 struct wim_lookup_table_entry *lte;
57 file_on_disk = STRDUP(path);
59 return WIMLIB_ERR_NOMEM;
60 lte = new_lookup_table_entry();
63 return WIMLIB_ERR_NOMEM;
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);
75 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
78 struct add_image_params *params);
81 unix_capture_directory(struct wim_dentry *dir_dentry,
84 struct add_image_params *params)
89 struct wim_dentry *child;
92 dir_dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
95 ERROR_WITH_ERRNO("Failed to open the directory `%s'",
97 return WIMLIB_ERR_OPENDIR;
100 /* Recurse on directory contents */
104 entry = readdir(dir);
107 ret = WIMLIB_ERR_READ;
108 ERROR_WITH_ERRNO("Error reading the "
109 "directory `%s'", path);
114 if (entry->d_name[0] == '.' && (entry->d_name[1] == '\0'
115 || (entry->d_name[1] == '.' && entry->d_name[2] == '\0')))
118 size_t name_len = strlen(entry->d_name);
120 path[path_len] = '/';
121 memcpy(&path[path_len + 1], entry->d_name, name_len + 1);
122 ret = unix_build_dentry_tree_recursive(&child,
124 path_len + 1 + name_len,
129 dentry_add_child(dir_dentry, child);
136 unix_capture_symlink(struct wim_dentry **root_p,
138 struct wim_inode *inode,
139 struct add_image_params *params)
141 char deref_name_buf[4096];
142 ssize_t deref_name_len;
145 inode->i_attributes = FILE_ATTRIBUTE_REPARSE_POINT;
146 inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
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;
156 dest[deref_name_len] = '\0';
157 DEBUG("Read symlink `%s'", dest);
159 if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
162 dest = capture_fixup_absolute_symlink(dest,
163 params->capture_root_ino,
164 params->capture_root_dev);
166 WARNING("Ignoring out of tree absolute symlink "
168 " (Use --norpfix to capture "
169 "absolute symlinks as-is)",
170 path, deref_name_buf);
171 free_dentry(*root_p);
175 inode->i_not_rpfixed = 0;
177 ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
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
186 if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
187 inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
190 ERROR_WITH_ERRNO("Failed to read target of "
191 "symbolic link `%s'", path);
192 ret = WIMLIB_ERR_READLINK;
198 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
201 struct add_image_params *params)
203 struct wim_dentry *root = NULL;
205 struct wim_inode *inode;
207 if (exclude_path(path, path_len, params->config, true)) {
208 if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
209 && params->progress_func)
211 union wimlib_progress_info info;
212 info.scan.cur_path = path;
213 info.scan.excluded = true;
214 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
219 if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
220 && params->progress_func)
222 union wimlib_progress_info info;
223 info.scan.cur_path = path;
224 info.scan.excluded = false;
225 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
229 int (*stat_fn)(const char *restrict, struct stat *restrict);
230 if ((params->add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) ||
231 (params->add_flags & WIMLIB_ADD_FLAG_ROOT))
236 ret = (*stat_fn)(path, &stbuf);
238 ERROR_WITH_ERRNO("Failed to stat `%s'", path);
239 ret = WIMLIB_ERR_STAT;
242 if (!S_ISREG(stbuf.st_mode) && !S_ISDIR(stbuf.st_mode)
243 && !S_ISLNK(stbuf.st_mode)) {
244 ERROR("`%s' is not a regular file, directory, or symbolic link.",
246 ret = WIMLIB_ERR_SPECIAL_FILE;
250 ret = inode_table_new_dentry(¶ms->inode_table,
251 path_basename_with_len(path, path_len),
252 stbuf.st_ino, stbuf.st_dev, false, &root);
256 inode = root->d_inode;
258 if (inode->i_nlink > 1) /* Already captured this inode? */
261 #ifdef HAVE_STAT_NANOSECOND_PRECISION
262 inode->i_creation_time = timespec_to_wim_timestamp(stbuf.st_mtim);
263 inode->i_last_write_time = timespec_to_wim_timestamp(stbuf.st_mtim);
264 inode->i_last_access_time = timespec_to_wim_timestamp(stbuf.st_atim);
266 inode->i_creation_time = unix_timestamp_to_wim(stbuf.st_mtime);
267 inode->i_last_write_time = unix_timestamp_to_wim(stbuf.st_mtime);
268 inode->i_last_access_time = unix_timestamp_to_wim(stbuf.st_atime);
270 inode->i_resolved = 1;
271 if (params->add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
272 ret = inode_set_unix_data(inode, stbuf.st_uid,
275 params->lookup_table,
276 UNIX_DATA_ALL | UNIX_DATA_CREATE);
280 params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
281 if (S_ISREG(stbuf.st_mode))
282 ret = unix_capture_regular_file(path, stbuf.st_size,
283 inode, params->lookup_table);
284 else if (S_ISDIR(stbuf.st_mode))
285 ret = unix_capture_directory(root, path, path_len, params);
287 ret = unix_capture_symlink(&root, path, inode, params);
292 free_dentry_tree(root, params->lookup_table);
297 * unix_build_dentry_tree():
298 * Builds a tree of WIM dentries from an on-disk directory tree (UNIX
299 * version; no NTFS-specific data is captured).
301 * @root_ret: Place to return a pointer to the root of the dentry tree. Only
302 * modified if successful. Set to NULL if the file or directory was
303 * excluded from capture.
305 * @root_disk_path: The path to the root of the directory tree on disk.
307 * @params: See doc for `struct add_image_params'.
309 * @return: 0 on success, nonzero on failure. It is a failure if any of
310 * the files cannot be `stat'ed, or if any of the needed
311 * directories cannot be opened or read. Failure to add the files
312 * to the WIM may still occur later when trying to actually read
313 * the on-disk files during a call to wimlib_write() or
314 * wimlib_overwrite().
317 unix_build_dentry_tree(struct wim_dentry **root_ret,
318 const char *root_disk_path,
319 struct add_image_params *params)
327 struct stat root_stbuf;
328 if (stat(root_disk_path, &root_stbuf)) {
329 ERROR_WITH_ERRNO("Failed to stat \"%s\"", root_disk_path);
330 return WIMLIB_ERR_STAT;
333 if ((params->add_flags & WIMLIB_ADD_FLAG_ROOT) &&
334 !S_ISDIR(root_stbuf.st_mode))
336 ERROR("Root of capture \"%s\" is not a directory",
338 return WIMLIB_ERR_NOTDIR;
340 params->capture_root_ino = root_stbuf.st_ino;
341 params->capture_root_dev = root_stbuf.st_dev;
344 path_bufsz = min(32790, PATH_MAX + 1);
345 path_len = strlen(root_disk_path);
347 if (path_len >= path_bufsz)
348 return WIMLIB_ERR_INVALID_PARAM;
350 path_buf = MALLOC(path_bufsz);
352 return WIMLIB_ERR_NOMEM;
353 memcpy(path_buf, root_disk_path, path_len + 1);
355 ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
361 #endif /* !__WIN32__ */