]> wimlib.net Git - wimlib/blobdiff - src/unix_capture.c
Add support for special files on UNIX
[wimlib] / src / unix_capture.c
index 4f526f7dda1029815a5cfd553458b83b38dc7696..ba540c98237abbb41b1c9678c7c75ded74f0a470 100644 (file)
@@ -1,5 +1,9 @@
 /*
- * Copyright (C) 2013 Eric Biggers
+ * unix_capture.c:  Capture a directory tree on UNIX.
+ */
+
+/*
+ * Copyright (C) 2012, 2013, 2014 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
  *
 
 #ifndef __WIN32__
 
-#include "wimlib_internal.h"
-#include "dentry.h"
-#include "lookup_table.h"
-#include "timestamp.h"
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
 
 #include <dirent.h>
 #include <errno.h>
-#include <unistd.h>
+#include <fcntl.h>
+#include <limits.h> /* for PATH_MAX */
 #include <sys/stat.h>
+#include <unistd.h>
+
+#include "wimlib/capture.h"
+#include "wimlib/dentry.h"
+#include "wimlib/error.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/reparse.h"
+#include "wimlib/timestamp.h"
+#include "wimlib/unix_data.h"
+
+#ifdef HAVE_FDOPENDIR
+#  define my_fdopendir(dirfd_p) fdopendir(*(dirfd_p))
+#else
+static DIR *
+my_fdopendir(int *dirfd_p)
+{
+       DIR *dir = NULL;
+       int old_pwd;
+
+       old_pwd = open(".", O_RDONLY);
+       if (old_pwd >= 0) {
+               if (!fchdir(*dirfd_p)) {
+                       dir = opendir(".");
+                       if (dir) {
+                               close(*dirfd_p);
+                               *dirfd_p = dirfd(dir);
+                       }
+                       fchdir(old_pwd);
+               }
+               close(old_pwd);
+       }
+       return dir;
+}
+#endif
+
+#ifdef HAVE_OPENAT
+#  define my_openat(full_path, dirfd, relpath, flags) \
+               openat((dirfd), (relpath), (flags))
+#else
+#  define my_openat(full_path, dirfd, relpath, flags) \
+               open((full_path), (flags))
+#endif
+
+#ifdef HAVE_READLINKAT
+#  define my_readlinkat(full_path, dirfd, relpath, buf, bufsize) \
+               readlinkat((dirfd), (relpath), (buf), (bufsize))
+#else
+#  define my_readlinkat(full_path, dirfd, relpath, buf, bufsize) \
+               readlink((full_path), (buf), (bufsize))
+#endif
+
+#ifdef HAVE_FSTATAT
+#  define my_fstatat(full_path, dirfd, relpath, stbuf, flags)  \
+       fstatat((dirfd), (relpath), (stbuf), (flags))
+#else
+#  define my_fstatat(full_path, dirfd, relpath, stbuf, flags)  \
+       ((flags) & AT_SYMLINK_NOFOLLOW) ? \
+               lstat((full_path), (stbuf)) : \
+               stat((full_path), (stbuf))
+#endif
+
+#ifndef AT_FDCWD
+#  define AT_FDCWD     -100
+#endif
+
+#ifndef AT_SYMLINK_NOFOLLOW
+#  define AT_SYMLINK_NOFOLLOW  0x100
+#endif
 
 static int
-unix_capture_regular_file(const char *path,
-                         u64 size,
-                         struct wim_inode *inode,
-                         struct wim_lookup_table *lookup_table)
+unix_scan_regular_file(const char *path, u64 size, struct wim_inode *inode,
+                      struct list_head *unhashed_streams)
 {
+       struct wim_lookup_table_entry *lte;
+       char *file_on_disk;
+
        inode->i_attributes = FILE_ATTRIBUTE_NORMAL;
 
        /* Empty files do not have to have a lookup table entry. */
-       if (size != 0) {
-               struct wim_lookup_table_entry *lte;
-               char *file_on_disk;
-
-               file_on_disk = STRDUP(path);
-               if (!file_on_disk)
-                       return WIMLIB_ERR_NOMEM;
-               lte = new_lookup_table_entry();
-               if (!lte) {
-                       FREE(file_on_disk);
-                       return WIMLIB_ERR_NOMEM;
-               }
-               lte->file_on_disk = file_on_disk;
-               lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
-               lte->resource_entry.original_size = size;
-               lookup_table_insert_unhashed(lookup_table, lte, inode, 0);
-               inode->i_lte = lte;
+       if (!size)
+               return 0;
+
+       file_on_disk = STRDUP(path);
+       if (!file_on_disk)
+               return WIMLIB_ERR_NOMEM;
+       lte = new_lookup_table_entry();
+       if (!lte) {
+               FREE(file_on_disk);
+               return WIMLIB_ERR_NOMEM;
        }
+       lte->file_on_disk = file_on_disk;
+       lte->resource_location = RESOURCE_IN_FILE_ON_DISK;
+       lte->size = size;
+       add_unhashed_stream(lte, inode, 0, unhashed_streams);
+       inode->i_lte = lte;
        return 0;
 }
 
 static int
-unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
-                                char *path,
-                                size_t path_len,
+unix_build_dentry_tree_recursive(struct wim_dentry **tree_ret,
+                                char *path, size_t path_len,
+                                int dirfd, const char *relpath,
                                 struct add_image_params *params);
 
 static int
-unix_capture_directory(struct wim_dentry *dir_dentry,
-                      char *path,
-                      size_t path_len,
-                      struct add_image_params *params)
+unix_scan_directory(struct wim_dentry *dir_dentry,
+                   char *full_path, size_t full_path_len,
+                   int parent_dirfd, const char *dir_relpath,
+                   struct add_image_params *params)
 {
 
+       int dirfd;
        DIR *dir;
-       struct dirent *entry;
-       struct wim_dentry *child;
        int ret;
 
+       dirfd = my_openat(full_path, parent_dirfd, dir_relpath, O_RDONLY);
+       if (dirfd < 0) {
+               ERROR_WITH_ERRNO("\"%s\": Can't open directory", full_path);
+               return WIMLIB_ERR_OPENDIR;
+       }
+
        dir_dentry->d_inode->i_attributes = FILE_ATTRIBUTE_DIRECTORY;
-       dir = opendir(path);
+       dir = my_fdopendir(&dirfd);
        if (!dir) {
-               ERROR_WITH_ERRNO("Failed to open the directory `%s'",
-                                path);
-               return WIMLIB_ERR_OPEN;
+               ERROR_WITH_ERRNO("\"%s\": Can't open directory", full_path);
+               close(dirfd);
+               return WIMLIB_ERR_OPENDIR;
        }
 
-       /* Recurse on directory contents */
        ret = 0;
        for (;;) {
+               struct dirent *entry;
+               struct wim_dentry *child;
+               size_t name_len;
+
                errno = 0;
                entry = readdir(dir);
                if (!entry) {
                        if (errno) {
                                ret = WIMLIB_ERR_READ;
-                               ERROR_WITH_ERRNO("Error reading the "
-                                                "directory `%s'", path);
+                               ERROR_WITH_ERRNO("\"%s\": Error reading directory",
+                                                full_path);
                        }
                        break;
                }
 
-               if (entry->d_name[0] == '.' && (entry->d_name[1] == '\0'
-                     || (entry->d_name[1] == '.' && entry->d_name[2] == '\0')))
-                               continue;
-
-               size_t name_len = strlen(entry->d_name);
+               if (entry->d_name[0] == '.' &&
+                   (entry->d_name[1] == '\0' ||
+                    (entry->d_name[1] == '.' && entry->d_name[2] == '\0')))
+                       continue;
 
-               path[path_len] = '/';
-               memcpy(&path[path_len + 1], entry->d_name, name_len + 1);
+               full_path[full_path_len] = '/';
+               name_len = strlen(entry->d_name);
+               memcpy(&full_path[full_path_len + 1], entry->d_name, name_len + 1);
                ret = unix_build_dentry_tree_recursive(&child,
-                                                      path,
-                                                      path_len + 1 + name_len,
+                                                      full_path,
+                                                      full_path_len + 1 + name_len,
+                                                      dirfd,
+                                                      &full_path[full_path_len + 1],
                                                       params);
+               full_path[full_path_len] = '\0';
                if (ret)
                        break;
                if (child)
@@ -120,133 +202,185 @@ unix_capture_directory(struct wim_dentry *dir_dentry,
        return ret;
 }
 
+/* Given an absolute symbolic link target @dest (UNIX-style, beginning
+ * with '/'), determine whether it points into the directory specified by
+ * @ino and @dev.  If so, return the target modified to be "absolute"
+ * relative to this directory.  Otherwise, return NULL.  */
+static char *
+unix_fixup_abslink(char *dest, u64 ino, u64 dev)
+{
+       char *p = dest;
+
+       do {
+               char save;
+               struct stat stbuf;
+               int ret;
+
+               /* Skip non-slashes.  */
+               while (*p && *p != '/')
+                       p++;
+
+               /* Skip slashes.  */
+               while (*p && *p == '/')
+                       p++;
+
+               /* Get inode and device for this prefix.  */
+               save = *p;
+               *p = '\0';
+               ret = stat(dest, &stbuf);
+               *p = save;
+
+               if (ret) {
+                       /* stat() failed.  Assume the link points outside the
+                        * directory tree being captured.  */
+                       break;
+               }
+
+               if (stbuf.st_ino == ino && stbuf.st_dev == dev) {
+                       /* Link points inside directory tree being captured.
+                        * Return abbreviated path.  */
+                       *--p = '/';
+                       while (p > dest && *(p - 1) == '/')
+                               p--;
+                       return p;
+               }
+       } while (*p);
+
+       /* Link does not point inside directory tree being captured.  */
+       return NULL;
+}
+
 static int
-unix_capture_symlink(struct wim_dentry **root_p,
-                    const char *path,
-                    struct wim_inode *inode,
-                    struct add_image_params *params)
+unix_scan_symlink(struct wim_dentry **root_p, const char *full_path,
+                 int dirfd, const char *relpath,
+                 struct wim_inode *inode, struct add_image_params *params)
 {
        char deref_name_buf[4096];
        ssize_t deref_name_len;
+       char *dest;
        int ret;
 
        inode->i_attributes = FILE_ATTRIBUTE_REPARSE_POINT;
        inode->i_reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
 
-       /* The idea here is to call readlink() to get the UNIX target of
-        * the symbolic link, then turn the target into a reparse point
-        * data buffer that contains a relative or absolute symbolic
-        * link (NOT a junction point or *full* path symbolic link with
-        * drive letter).
-        */
-       deref_name_len = readlink(path, deref_name_buf,
-                                 sizeof(deref_name_buf) - 1);
-       if (deref_name_len >= 0) {
-               char *dest = deref_name_buf;
-
-               dest[deref_name_len] = '\0';
-               DEBUG("Read symlink `%s'", dest);
-
-               if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
-                    dest[0] == '/')
-               {
-                       dest = capture_fixup_absolute_symlink(dest,
-                                                             params->capture_root_ino,
-                                                             params->capture_root_dev);
-                       if (!dest) {
-                               WARNING("Ignoring out of tree absolute symlink "
-                                       "\"%s\" -> \"%s\"\n"
-                                       "          (Use --norpfix to capture "
-                                       "absolute symlinks as-is)",
-                                       path, deref_name_buf);
-                               free_dentry(*root_p);
-                               *root_p = NULL;
-                               return 0;
-                       }
-                       inode->i_not_rpfixed = 0;
-               }
-               ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
-               if (ret == 0) {
-                       /* Unfortunately, Windows seems to have the concept of
-                        * "file" symbolic links as being different from
-                        * "directory" symbolic links...  so
-                        * FILE_ATTRIBUTE_DIRECTORY needs to be set on the
-                        * symbolic link if the *target* of the symbolic link is
-                        * a directory.  */
-                       struct stat stbuf;
-                       if (stat(path, &stbuf) == 0 && S_ISDIR(stbuf.st_mode))
-                               inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
+       /* The idea here is to call readlink() to get the UNIX target of the
+        * symbolic link, then turn the target into a reparse point data buffer
+        * that contains a relative or absolute symbolic link. */
+       deref_name_len = my_readlinkat(full_path, dirfd, relpath,
+                                      deref_name_buf, sizeof(deref_name_buf) - 1);
+       if (deref_name_len < 0) {
+               ERROR_WITH_ERRNO("\"%s\": Can't read target of symbolic link",
+                                full_path);
+               return WIMLIB_ERR_READLINK;
+       }
+
+       dest = deref_name_buf;
+
+       dest[deref_name_len] = '\0';
+
+       if ((params->add_flags & WIMLIB_ADD_FLAG_RPFIX) &&
+            dest[0] == '/')
+       {
+               dest = unix_fixup_abslink(dest,
+                                         params->capture_root_ino,
+                                         params->capture_root_dev);
+               if (!dest) {
+                       /* RPFIX (reparse point fixup) mode:  Ignore
+                        * absolute symbolic link that points out of the
+                        * tree to be captured.  */
+                       free_dentry(*root_p);
+                       *root_p = NULL;
+                       params->progress.scan.cur_path = full_path;
+                       params->progress.scan.symlink_target = deref_name_buf;
+                       return do_capture_progress(params,
+                                                  WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
+                                                  NULL);
                }
-       } else {
-               ERROR_WITH_ERRNO("Failed to read target of "
-                                "symbolic link `%s'", path);
-               ret = WIMLIB_ERR_READLINK;
+               inode->i_not_rpfixed = 0;
        }
-       return ret;
+       ret = wim_inode_set_symlink(inode, dest, params->lookup_table);
+       if (ret)
+               return ret;
+
+       /* Unfortunately, Windows seems to have the concept of "file" symbolic
+        * links as being different from "directory" symbolic links...  so
+        * FILE_ATTRIBUTE_DIRECTORY needs to be set on the symbolic link if the
+        * *target* of the symbolic link is a directory.  */
+       struct stat stbuf;
+       if (my_fstatat(full_path, dirfd, relpath, &stbuf, 0) == 0 &&
+           S_ISDIR(stbuf.st_mode))
+               inode->i_attributes |= FILE_ATTRIBUTE_DIRECTORY;
+       return 0;
 }
 
 static int
-unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
-                                char *path,
-                                size_t path_len,
+unix_build_dentry_tree_recursive(struct wim_dentry **tree_ret,
+                                char *full_path, size_t full_path_len,
+                                int dirfd, const char *relpath,
                                 struct add_image_params *params)
 {
-       struct wim_dentry *root = NULL;
-       int ret = 0;
-       struct wim_inode *inode;
-
-       if (exclude_path(path, path_len, params->config, true)) {
-               if ((params->add_flags & WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE)
-                   && params->progress_func)
-               {
-                       union wimlib_progress_info info;
-                       info.scan.cur_path = path;
-                       info.scan.excluded = true;
-                       params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
-               }
-               goto out;
-       }
+       struct wim_dentry *tree = NULL;
+       struct wim_inode *inode = NULL;
+       int ret;
+       struct stat stbuf;
+       int stat_flags;
 
-       if ((params->add_flags & WIMLIB_ADD_FLAG_VERBOSE)
-           && params->progress_func)
+       if (should_exclude_path(full_path + params->capture_root_nchars,
+                               full_path_len - params->capture_root_nchars,
+                               params->config))
        {
-               union wimlib_progress_info info;
-               info.scan.cur_path = path;
-               info.scan.excluded = false;
-               params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
+               ret = 0;
+               goto out_progress;
        }
 
-       struct stat stbuf;
-       int (*stat_fn)(const char *restrict, struct stat *restrict);
-       if ((params->add_flags & WIMLIB_ADD_FLAG_DEREFERENCE) ||
-           (params->add_flags & WIMLIB_ADD_FLAG_ROOT))
-               stat_fn = stat;
+       if (params->add_flags & (WIMLIB_ADD_FLAG_DEREFERENCE |
+                                WIMLIB_ADD_FLAG_ROOT))
+               stat_flags = 0;
        else
-               stat_fn = lstat;
+               stat_flags = AT_SYMLINK_NOFOLLOW;
 
-       ret = (*stat_fn)(path, &stbuf);
-       if (ret != 0) {
-               ERROR_WITH_ERRNO("Failed to stat `%s'", path);
+       ret = my_fstatat(full_path, dirfd, relpath, &stbuf, stat_flags);
+
+       if (ret) {
+               ERROR_WITH_ERRNO("\"%s\": Can't read metadata", full_path);
+               ret = WIMLIB_ERR_STAT;
                goto out;
        }
-       if (!S_ISREG(stbuf.st_mode) && !S_ISDIR(stbuf.st_mode)
-           && !S_ISLNK(stbuf.st_mode)) {
-               ERROR("`%s' is not a regular file, directory, or symbolic link.",
-                     path);
-               ret = WIMLIB_ERR_SPECIAL_FILE;
-               goto out;
+
+       if (!(params->add_flags & WIMLIB_ADD_FLAG_UNIX_DATA)) {
+               if (unlikely(!S_ISREG(stbuf.st_mode) &&
+                            !S_ISDIR(stbuf.st_mode) &&
+                            !S_ISLNK(stbuf.st_mode)))
+               {
+                       if (params->add_flags &
+                           WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
+                       {
+                               ERROR("\"%s\": File type is unsupported",
+                                     full_path);
+                               ret = WIMLIB_ERR_UNSUPPORTED_FILE;
+                               goto out;
+                       }
+                       params->progress.scan.cur_path = full_path;
+                       ret = do_capture_progress(params,
+                                                 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
+                                                 NULL);
+                       goto out;
+               }
        }
 
-       ret = inode_table_new_dentry(params->inode_table,
-                                    path_basename_with_len(path, path_len),
-                                    stbuf.st_ino, stbuf.st_dev, false, &root);
+       ret = inode_table_new_dentry(params->inode_table, relpath,
+                                    stbuf.st_ino, stbuf.st_dev,
+                                    S_ISDIR(stbuf.st_mode), &tree);
        if (ret)
                goto out;
 
-       inode = root->d_inode;
+       inode = tree->d_inode;
 
-       if (inode->i_nlink > 1) /* Already captured this inode? */
-               goto out;
+       if (inode->i_nlink > 1) {
+               /* Already seen this inode?  */
+               ret = 0;
+               goto out_progress;
+       }
 
 #ifdef HAVE_STAT_NANOSECOND_PRECISION
        inode->i_creation_time = timespec_to_wim_timestamp(stbuf.st_mtim);
@@ -259,34 +393,58 @@ unix_build_dentry_tree_recursive(struct wim_dentry **root_ret,
 #endif
        inode->i_resolved = 1;
        if (params->add_flags & WIMLIB_ADD_FLAG_UNIX_DATA) {
-               ret = inode_set_unix_data(inode, stbuf.st_uid,
-                                         stbuf.st_gid,
-                                         stbuf.st_mode,
-                                         params->lookup_table,
-                                         UNIX_DATA_ALL | UNIX_DATA_CREATE);
-               if (ret)
+               struct wimlib_unix_data unix_data;
+
+               unix_data.uid = stbuf.st_uid;
+               unix_data.gid = stbuf.st_gid;
+               unix_data.mode = stbuf.st_mode;
+               unix_data.rdev = stbuf.st_rdev;
+               if (!inode_set_unix_data(inode, &unix_data, UNIX_DATA_ALL)) {
+                       ret = WIMLIB_ERR_NOMEM;
+                       goto out;
+               }
+       }
+
+       if (params->add_flags & WIMLIB_ADD_FLAG_ROOT) {
+               params->capture_root_ino = stbuf.st_ino;
+               params->capture_root_dev = stbuf.st_dev;
+               params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
+       }
+
+       if (S_ISREG(stbuf.st_mode)) {
+               ret = unix_scan_regular_file(full_path, stbuf.st_size,
+                                            inode, params->unhashed_streams);
+       } else if (S_ISDIR(stbuf.st_mode)) {
+               ret = unix_scan_directory(tree, full_path, full_path_len,
+                                         dirfd, relpath, params);
+       } else if (S_ISLNK(stbuf.st_mode)) {
+               ret = unix_scan_symlink(&tree, full_path, dirfd, relpath,
+                                       inode, params);
+               if (!tree)
                        goto out;
        }
-       params->add_flags &= ~WIMLIB_ADD_FLAG_ROOT;
-       if (S_ISREG(stbuf.st_mode))
-               ret = unix_capture_regular_file(path, stbuf.st_size,
-                                               inode, params->lookup_table);
-       else if (S_ISDIR(stbuf.st_mode))
-               ret = unix_capture_directory(root, path, path_len, params);
+
+       if (ret)
+               goto out;
+
+out_progress:
+       params->progress.scan.cur_path = full_path;
+       if (likely(tree))
+               ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
        else
-               ret = unix_capture_symlink(&root, path, inode, params);
+               ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
 out:
-       if (ret == 0)
-               *root_ret = root;
+       if (likely(ret == 0))
+               *tree_ret = tree;
        else
-               free_dentry_tree(root, params->lookup_table);
+               free_dentry_tree(tree, params->lookup_table);
        return ret;
 }
 
 /*
  * unix_build_dentry_tree():
- *     Builds a tree of WIM dentries from an on-disk directory tree (UNIX
- *     version; no NTFS-specific data is captured).
+ *     Builds a tree of WIM dentries from an on-disk directory tree (UNIX
+ *     version; no NTFS-specific data is captured).
  *
  * @root_ret:   Place to return a pointer to the root of the dentry tree.  Only
  *             modified if successful.  Set to NULL if the file or directory was
@@ -308,42 +466,26 @@ unix_build_dentry_tree(struct wim_dentry **root_ret,
                       const char *root_disk_path,
                       struct add_image_params *params)
 {
-       char *path_buf;
-       int ret;
        size_t path_len;
        size_t path_bufsz;
+       char *path_buf;
+       int ret;
 
-       {
-               struct stat root_stbuf;
-               if (stat(root_disk_path, &root_stbuf)) {
-                       ERROR_WITH_ERRNO("Failed to stat \"%s\"", root_disk_path);
-                       return WIMLIB_ERR_STAT;
-               }
-
-               if ((params->add_flags & WIMLIB_ADD_FLAG_ROOT) &&
-                   !S_ISDIR(root_stbuf.st_mode))
-               {
-                       ERROR("Root of capture \"%s\" is not a directory",
-                             root_disk_path);
-                       return WIMLIB_ERR_NOTDIR;
-               }
-               params->capture_root_ino = root_stbuf.st_ino;
-               params->capture_root_dev = root_stbuf.st_dev;
-       }
-
-       path_bufsz = min(32790, PATH_MAX + 1);
        path_len = strlen(root_disk_path);
+       path_bufsz = min(32790, PATH_MAX + 1);
 
        if (path_len >= path_bufsz)
                return WIMLIB_ERR_INVALID_PARAM;
 
-       path_buf = MALLOC(path_bufsz);
+       path_buf = MALLOC(path_bufsz);
        if (!path_buf)
                return WIMLIB_ERR_NOMEM;
        memcpy(path_buf, root_disk_path, path_len + 1);
 
-       ret = unix_build_dentry_tree_recursive(root_ret, path_buf,
-                                              path_len, params);
+       params->capture_root_nchars = path_len;
+
+       ret = unix_build_dentry_tree_recursive(root_ret, path_buf, path_len,
+                                              AT_FDCWD, path_buf, params);
        FREE(path_buf);
        return ret;
 }