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
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
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;
159 dest[deref_name_len] = '\0';
160 DEBUG("Read symlink `%s'", dest);
162 if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
165 dest = capture_fixup_absolute_symlink(dest,
166 params->capture_root_ino,
167 params->capture_root_dev);
169 WARNING("Ignoring out of tree absolute symlink "
171 " (Use --norpfix to capture "
172 "absolute symlinks as-is)",
173 path, deref_name_buf);
174 free_dentry(*root_p);
178 inode->i_not_rpfixed = 0;
180 ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
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
189 if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
190 inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
193 ERROR_WITH_ERRNO("Failed to read target of "
194 "symbolic link `%s'", path);
195 ret = WIMLIB_ERR_READLINK;
201 unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
204 struct add_image_params *params)
206 struct wim_dentry *root = NULL;
208 struct wim_inode *inode;
210 if (exclude_path(path, path_len, params->config, true)) {
211 if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
212 && params->progress_func)
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);
222 if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
223 && params->progress_func)
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);
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))
239 ret = (*stat_fn)(path, &stbuf);
241 ERROR_WITH_ERRNO("Failed to stat `%s'", path);
242 ret = WIMLIB_ERR_STAT;
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.",
249 ret = WIMLIB_ERR_SPECIAL_FILE;
253 ret = inode_table_new_dentry(¶ms->inode_table,
254 path_basename_with_len(path, path_len),
255 stbuf.st_ino, stbuf.st_dev, false, &root);
259 inode = root->d_inode;
261 if (inode->i_nlink > 1) /* Already captured this inode? */
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);
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);
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,
278 params->lookup_table,
279 UNIX_DATA_ALL | UNIX_DATA_CREATE);
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);
290 ret = unix_capture_symlink(&root, path, inode, params);
295 free_dentry_tree(root, params->lookup_table);
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).
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.
308 * @root_disk_path: The path to the root of the directory tree on disk.
310 * @params: See doc for `struct add_image_params'.
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().
320 unix_build_dentry_tree(struct wim_dentry **root_ret,
321 const char *root_disk_path,
322 struct add_image_params *params)
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;
336 if ((params->add_flags & WIMLIB_ADD_FLAG_ROOT) &&
337 !S_ISDIR(root_stbuf.st_mode))
339 ERROR("Root of capture \"%s\" is not a directory",
341 return WIMLIB_ERR_NOTDIR;
343 params->capture_root_ino = root_stbuf.st_ino;
344 params->capture_root_dev = root_stbuf.st_dev;
347 path_bufsz = min(32790, PATH_MAX + 1);
348 path_len = strlen(root_disk_path);
350 if (path_len >= path_bufsz)
351 return WIMLIB_ERR_INVALID_PARAM;
353 path_buf = MALLOC(path_bufsz);
355 return WIMLIB_ERR_NOMEM;
356 memcpy(path_buf, root_disk_path, path_len + 1);
358 ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
364 #endif /* !__WIN32__ */