]> wimlib.net Git - wimlib/blobdiff - src/ntfs-capture.c
Comments etc.
[wimlib] / src / ntfs-capture.c
index 56e1c53995c37dbac6bffabcc4068cfdaeaddba1..eadedac725a5efc33872a76855ddb5904852b4b0 100644 (file)
@@ -63,15 +63,19 @@ struct sd_node {
        struct sd_node *right;
 };
 
-/* Frees a security descriptor index tree. */
-static void free_sd_set(struct sd_node *root)
+static void free_sd_tree(struct sd_node *root)
 {
        if (root) {
-               free_sd_set(root->left);
-               free_sd_set(root->right);
+               free_sd_tree(root->left);
+               free_sd_tree(root->right);
                FREE(root);
        }
 }
+/* Frees a security descriptor index set. */
+static void destroy_sd_set(struct sd_set *sd_set)
+{
+       free_sd_tree(sd_set->root);
+}
 
 /* Inserts a a new node into the security descriptor index tree. */
 static void insert_sd_node(struct sd_node *new, struct sd_node *root)
@@ -117,7 +121,7 @@ static int lookup_sd(const u8 hash[SHA1_HASH_SIZE], struct sd_node *root)
  * the security ID for it.  If a new security descriptor cannot be allocated,
  * return -1.
  */
-static int sd_set_add_sd(struct sd_set *sd_set, const u8 *descriptor,
+static int sd_set_add_sd(struct sd_set *sd_set, const char descriptor[],
                         size_t size)
 {
        u8 hash[SHA1_HASH_SIZE];
@@ -128,7 +132,7 @@ static int sd_set_add_sd(struct sd_set *sd_set, const u8 *descriptor,
        u8 *descr_copy;
        struct wim_security_data *sd;
 
-       sha1_buffer(descriptor, size, hash);
+       sha1_buffer((const u8*)descriptor, size, hash);
        security_id = lookup_sd(hash, sd_set->root);
        if (security_id >= 0)
                return security_id;
@@ -162,6 +166,7 @@ static int sd_set_add_sd(struct sd_set *sd_set, const u8 *descriptor,
        sd->descriptors[sd->num_entries] = descr_copy;
        sd->sizes[sd->num_entries] = size;
        sd->num_entries++;
+       DEBUG("There are now %d security descriptors", sd->num_entries);
        sd->total_length += size + sizeof(sd->sizes[0]);
 
        if (sd_set->root)
@@ -209,6 +214,9 @@ static int ntfs_attr_sha1sum(ntfs_inode *ni, ATTR_RECORD *ar,
        bytes_remaining = na->data_size;
        sha1_init(&ctx);
 
+       DEBUG("Calculating SHA1 message digest (%"PRIu64" bytes)",
+                       bytes_remaining);
+
        while (bytes_remaining) {
                s64 to_read = min(bytes_remaining, sizeof(buf));
                if (ntfs_attr_pread(na, pos, to_read, buf) != to_read) {
@@ -235,14 +243,16 @@ static int capture_ntfs_streams(struct dentry *dentry, ntfs_inode *ni,
 
        ntfs_attr_search_ctx *actx;
        u8 attr_hash[SHA1_HASH_SIZE];
-       struct ntfs_location *ntfs_loc;
+       struct ntfs_location *ntfs_loc = NULL;
        struct lookup_table_entry *lte;
        int ret = 0;
 
+       DEBUG("Capturing NTFS data streams from `%s'", path);
+
        /* Get context to search the streams of the NTFS file. */
        actx = ntfs_attr_get_search_ctx(ni, NULL);
        if (!actx) {
-               ERROR_WITH_ERRNO("Cannot get attribute search "
+               ERROR_WITH_ERRNO("Cannot get NTFS attribute search "
                                 "context");
                return WIMLIB_ERR_NTFS_3G;
        }
@@ -266,8 +276,6 @@ static int capture_ntfs_streams(struct dentry *dentry, ntfs_inode *ni,
                if (lte) {
                        lte->refcnt++;
                } else {
-                       struct ntfs_location *ntfs_loc;
-
                        ntfs_loc = CALLOC(1, sizeof(*ntfs_loc));
                        if (!ntfs_loc)
                                goto out_put_actx;
@@ -292,6 +300,9 @@ static int capture_ntfs_streams(struct dentry *dentry, ntfs_inode *ni,
                        lte->resource_location = RESOURCE_IN_NTFS_VOLUME;
                        lte->resource_entry.original_size = actx->attr->data_size;
                        lte->resource_entry.size = actx->attr->data_size;
+                       DEBUG("Add resource for `%s' (size = %zu)",
+                               dentry->file_name_utf8,
+                               lte->resource_entry.original_size);
                        copy_hash(lte->hash, attr_hash);
                        lookup_table_insert(lookup_table, lte);
                }
@@ -305,9 +316,10 @@ static int capture_ntfs_streams(struct dentry *dentry, ntfs_inode *ni,
                        dentry->lte = lte;
                } else {
                        struct ads_entry *new_ads_entry;
-                       stream_name_utf8 = utf16_to_utf8((const u8*)attr_record_name(actx->attr),
+                       size_t stream_name_utf8_len;
+                       stream_name_utf8 = utf16_to_utf8((const char*)attr_record_name(actx->attr),
                                                         actx->attr->name_length,
-                                                        &stream_name_utf16_len);
+                                                        &stream_name_utf8_len);
                        if (!stream_name_utf8)
                                goto out_free_lte;
                        new_ads_entry = dentry_add_ads(dentry, stream_name_utf8);
@@ -330,44 +342,64 @@ out_free_ntfs_loc:
        }
 out_put_actx:
        ntfs_attr_put_search_ctx(actx);
+       if (ret == 0)
+               DEBUG("Successfully captured NTFS streams from `%s'", path);
+       else
+               DEBUG("Failed to capture NTFS streams from `%s", path);
        return ret;
 }
 
 struct readdir_ctx {
-       struct dentry       *dentry;
+       struct dentry       *parent;
        ntfs_inode          *dir_ni;
        char                *path;
        size_t               path_len;
        struct lookup_table *lookup_table;
        struct sd_set       *sd_set;
+       const struct capture_config *config;
        ntfs_volume        **ntfs_vol_p;
 };
 
-static int __build_dentry_tree_ntfs(struct dentry *dentry, ntfs_inode *ni,
-                                   char path[], size_t path_len,
-                                   struct lookup_table *lookup_table,
-                                   struct sd_set *sd_set,
-                                   ntfs_volume **ntfs_vol_p);
-
-
-static int filldir(void *dirent, const ntfschar *name,
-                  const int name_len, const int name_type, const s64 pos,
-                  const MFT_REF mref, const unsigned dt_type)
+static int
+build_dentry_tree_ntfs_recursive(struct dentry **root_p, ntfs_inode *ni,
+                                char path[], size_t path_len,
+                                struct lookup_table *lookup_table,
+                                struct sd_set *sd_set,
+                                const struct capture_config *config,
+                                ntfs_volume **ntfs_vol_p);
+
+static int wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
+                                   const int name_len, const int name_type,
+                                   const s64 pos, const MFT_REF mref,
+                                   const unsigned dt_type)
 {
        struct readdir_ctx *ctx;
        size_t utf8_name_len;
        char *utf8_name;
-       struct dentry *child;
+       struct dentry *child = NULL;
        int ret;
        size_t path_len;
 
+       if (name_type == FILE_NAME_DOS)
+               return 0;
+
        ret = -1;
 
-       utf8_name = utf16_to_utf8((const u8*)name, name_len * 2,
+       utf8_name = utf16_to_utf8((const char*)name, name_len * 2,
                                  &utf8_name_len);
        if (!utf8_name)
                goto out;
 
+       if (utf8_name[0] == '.' &&
+            (utf8_name[1] == '\0' ||
+             (utf8_name[1] == '.' && utf8_name[2] == '\0'))) {
+               DEBUG("Skipping dentry `%s'", utf8_name);
+               ret = 0;
+               goto out_free_utf8_name;
+       }
+
+       DEBUG("Opening inode for `%s'", utf8_name);
+
        ctx = dirent;
 
        ntfs_inode *ni = ntfs_inode_open(ctx->dir_ni->vol, mref);
@@ -375,17 +407,20 @@ static int filldir(void *dirent, const ntfschar *name,
                ERROR_WITH_ERRNO("Failed to open NTFS inode");
                ret = 1;
        }
-       child = new_dentry(utf8_name);
-       if (!child)
-               goto out_close_ni;
-
-       memcpy(ctx->path + ctx->path_len, utf8_name, utf8_name_len + 1);
-       path_len = ctx->path_len + utf8_name_len;
-       ret = __build_dentry_tree_ntfs(child, ni, ctx->path, path_len,
-                                      ctx->lookup_table, ctx->sd_set,
-                                      ctx->ntfs_vol_p);
-       link_dentry(child, ctx->dentry);
-out_close_ni:
+       path_len = ctx->path_len;
+       if (path_len != 1)
+               ctx->path[path_len++] = '/';
+       memcpy(ctx->path + path_len, utf8_name, utf8_name_len + 1);
+       path_len += utf8_name_len;
+       ret = build_dentry_tree_ntfs_recursive(&child, ni, ctx->path, path_len,
+                                              ctx->lookup_table, ctx->sd_set,
+                                              ctx->config, ctx->ntfs_vol_p);
+
+       if (child) {
+               DEBUG("Linking dentry `%s' with parent `%s'",
+                     child->file_name_utf8, ctx->parent->file_name_utf8);
+               link_dentry(child, ctx->parent);
+       }
        ntfs_inode_close(ni);
 out_free_utf8_name:
        FREE(utf8_name);
@@ -397,88 +432,132 @@ out:
  * At the same time, update the WIM lookup table with lookup table entries for
  * the NTFS streams, and build an array of security descriptors.
  */
-static int __build_dentry_tree_ntfs(struct dentry *dentry, ntfs_inode *ni,
-                                   char path[], size_t path_len,
-                                   struct lookup_table *lookup_table,
-                                   struct sd_set *sd_set,
-                                   ntfs_volume **ntfs_vol_p)
+static int build_dentry_tree_ntfs_recursive(struct dentry **root_p,
+                                           ntfs_inode *ni,
+                                           char path[],
+                                           size_t path_len,
+                                           struct lookup_table *lookup_table,
+                                           struct sd_set *sd_set,
+                                           const struct capture_config *config,
+                                           ntfs_volume **ntfs_vol_p)
 {
-       u32 attributes = ntfs_inode_get_attributes(ni);
-       int mrec_flags = ni->mrec->flags;
-       u32 sd_size;
+       u32 attributes;
+       int mrec_flags;
+       u32 sd_size = 0;
        int ret = 0;
+       struct dentry *root;
+
+       if (exclude_path(path, config, false)) {
+               DEBUG("Excluding `%s' from capture", path);
+               return 0;
+       }
 
-       dentry->creation_time    = le64_to_cpu(ni->creation_time);
-       dentry->last_write_time  = le64_to_cpu(ni->last_data_change_time);
-       dentry->last_access_time = le64_to_cpu(ni->last_access_time);
-       dentry->security_id      = le32_to_cpu(ni->security_id);
-       dentry->attributes       = le32_to_cpu(attributes);
-       dentry->hard_link        = ni->mft_no;
-       dentry->resolved = true;
+       DEBUG("Starting recursive capture at path = `%s'", path);
+       mrec_flags = ni->mrec->flags;
+       attributes = ntfs_inode_get_attributes(ni);
+
+       root = new_dentry(path_basename(path));
+       if (!root)
+               return WIMLIB_ERR_NOMEM;
+
+       *root_p = root;
+       root->creation_time    = le64_to_cpu(ni->creation_time);
+       root->last_write_time  = le64_to_cpu(ni->last_data_change_time);
+       root->last_access_time = le64_to_cpu(ni->last_access_time);
+       root->attributes       = le32_to_cpu(attributes);
+       root->link_group_id    = ni->mft_no;
+       root->resolved         = true;
 
        if (attributes & FILE_ATTR_REPARSE_POINT) {
+               DEBUG("Reparse point `%s'", path);
                /* Junction point, symbolic link, or other reparse point */
-               ret = capture_ntfs_streams(dentry, ni, path, path_len,
+               ret = capture_ntfs_streams(root, ni, path, path_len,
                                           lookup_table, ntfs_vol_p,
                                           AT_REPARSE_POINT);
        } else if (mrec_flags & MFT_RECORD_IS_DIRECTORY) {
+               DEBUG("Directory `%s'", path);
+
                /* Normal directory */
                s64 pos = 0;
                struct readdir_ctx ctx = {
-                       .dentry       = dentry,
+                       .parent       = root,
                        .dir_ni       = ni,
                        .path         = path,
                        .path_len     = path_len,
                        .lookup_table = lookup_table,
                        .sd_set       = sd_set,
+                       .config       = config,
                        .ntfs_vol_p   = ntfs_vol_p,
                };
-               ret = ntfs_readdir(ni, &pos, &ctx, filldir);
-               if (ret != 0)
+               ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
+               if (ret != 0) {
+                       ERROR_WITH_ERRNO("ntfs_readdir()");
                        ret = WIMLIB_ERR_NTFS_3G;
+               }
        } else {
+               DEBUG("Normal file `%s'", path);
                /* Normal file */
-               ret = capture_ntfs_streams(dentry, ni, path, path_len,
+               ret = capture_ntfs_streams(root, ni, path, path_len,
                                           lookup_table, ntfs_vol_p,
                                           AT_DATA);
        }
        if (ret != 0)
                return ret;
+
        ret = ntfs_inode_get_security(ni,
                                      OWNER_SECURITY_INFORMATION |
                                      GROUP_SECURITY_INFORMATION |
                                      DACL_SECURITY_INFORMATION  |
                                      SACL_SECURITY_INFORMATION,
                                      NULL, 0, &sd_size);
-       u8 sd[sd_size];
+       char sd[sd_size];
        ret = ntfs_inode_get_security(ni,
                                      OWNER_SECURITY_INFORMATION |
                                      GROUP_SECURITY_INFORMATION |
                                      DACL_SECURITY_INFORMATION  |
                                      SACL_SECURITY_INFORMATION,
                                      sd, sd_size, &sd_size);
-       dentry->security_id = sd_set_add_sd(sd_set, sd, sd_size);
-       if (dentry->security_id == -1) {
-               ERROR("Could not allocate security ID");
-               ret = WIMLIB_ERR_NOMEM;
+       if (ret == 0) {
+               ERROR_WITH_ERRNO("Failed to get security information from "
+                                "`%s'", path);
+               ret = WIMLIB_ERR_NTFS_3G;
+       } else {
+               if (ret > 0) {
+                       /*print_security_descriptor(sd, sd_size);*/
+                       root->security_id = sd_set_add_sd(sd_set, sd, sd_size);
+                       if (root->security_id == -1) {
+                               ERROR("Out of memory");
+                               return WIMLIB_ERR_NOMEM;
+                       }
+                       DEBUG("Added security ID = %u for `%s'",
+                             root->security_id, path);
+               } else { 
+                       root->security_id = -1;
+                       DEBUG("No security ID for `%s'", path);
+               }
+               ret = 0;
        }
        return ret;
 }
 
-static int build_dentry_tree_ntfs(struct dentry *root_dentry,
+static int build_dentry_tree_ntfs(struct dentry **root_p,
                                  const char *device,
                                  struct lookup_table *lookup_table,
                                  struct wim_security_data *sd,
+                                 const struct capture_config *config,
                                  int flags,
                                  void *extra_arg)
 {
        ntfs_volume *vol;
        ntfs_inode *root_ni;
        int ret = 0;
-       struct sd_set tree;
-       tree.sd = sd;
-       tree.root = NULL;
+       struct sd_set sd_set = {
+               .sd = sd,
+               .root = NULL,
+       };
        ntfs_volume **ntfs_vol_p = extra_arg;
+
+       DEBUG("Mounting NTFS volume `%s' read-only", device);
        
        vol = ntfs_mount(device, MS_RDONLY);
        if (!vol) {
@@ -486,6 +565,13 @@ static int build_dentry_tree_ntfs(struct dentry *root_dentry,
                                 device);
                return WIMLIB_ERR_NTFS_3G;
        }
+
+       /* We don't want to capture the special NTFS files such as $Bitmap.  Not
+        * to be confused with "hidden" or "system" files which are real files
+        * that we do need to capture.  */
+       NVolClearShowSysFiles(vol);
+
+       DEBUG("Opening root NTFS dentry");
        root_ni = ntfs_inode_open(vol, FILE_root);
        if (!root_ni) {
                ERROR_WITH_ERRNO("Failed to open root inode of NTFS volume "
@@ -493,44 +579,64 @@ static int build_dentry_tree_ntfs(struct dentry *root_dentry,
                ret = WIMLIB_ERR_NTFS_3G;
                goto out;
        }
-       char path[4096];
+
+       /* Currently we assume that all the UTF-8 paths fit into this length and
+        * there is no check for overflow. */
+       char *path = MALLOC(32768);
+       if (!path) {
+               ERROR("Could not allocate memory for NTFS pathname");
+               goto out_cleanup;
+       }
+
        path[0] = '/';
        path[1] = '\0';
-       ret = __build_dentry_tree_ntfs(root_dentry, root_ni, path, 1,
-                                      lookup_table, &tree, ntfs_vol_p);
+       ret = build_dentry_tree_ntfs_recursive(root_p, root_ni, path, 1,
+                                              lookup_table, &sd_set,
+                                              config, ntfs_vol_p);
+out_cleanup:
+       FREE(path);
        ntfs_inode_close(root_ni);
+       destroy_sd_set(&sd_set);
 
 out:
-       if (ntfs_umount(vol, FALSE) != 0) {
-               ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'", device);
-               if (ret == 0)
-                       ret = WIMLIB_ERR_NTFS_3G;
+       if (ret) {
+               if (ntfs_umount(vol, FALSE) != 0) {
+                       ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'",
+                                        device);
+                       if (ret == 0)
+                               ret = WIMLIB_ERR_NTFS_3G;
+               }
+       } else {
+               /* We need to leave the NTFS volume mounted so that we can read
+                * the NTFS files again when we are actually writing the WIM */
+               *ntfs_vol_p = vol;
        }
        return ret;
 }
 
+
+
 WIMLIBAPI int wimlib_add_image_from_ntfs_volume(WIMStruct *w,
                                                const char *device,
                                                const char *name,
-                                               const char *description,
-                                               const char *flags_element,
+                                               const char *config_str,
+                                               size_t config_len,
                                                int flags)
 {
        if (flags & (WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE)) {
                ERROR("Cannot dereference files when capturing directly from NTFS");
                return WIMLIB_ERR_INVALID_PARAM;
        }
-       return do_add_image(w, device, name, description, flags_element, flags,
-                           build_dentry_tree_ntfs,
-                           &w->ntfs_vol);
+       return do_add_image(w, device, name, config_str, config_len, flags,
+                           build_dentry_tree_ntfs, &w->ntfs_vol);
 }
 
 #else /* WITH_NTFS_3G */
 WIMLIBAPI int wimlib_add_image_from_ntfs_volume(WIMStruct *w,
                                                const char *device,
                                                const char *name,
-                                               const char *description,
-                                               const char *flags_element,
+                                               const char *config_str,
+                                               size_t config_len,
                                                int flags)
 {
        ERROR("wimlib was compiled without support for NTFS-3g, so");