]> wimlib.net Git - wimlib/blobdiff - src/ntfs-3g_capture.c
resource: pass blob and offset to consume_chunk
[wimlib] / src / ntfs-3g_capture.c
index 93d71e55bcefd951b84c5d57a271cd03285badff..ca8d1b2ffe4a335002569c0a6de780a52d13e9f2 100644 (file)
@@ -31,6 +31,7 @@
 #include <errno.h>
 
 #include <ntfs-3g/attrib.h>
+#include <ntfs-3g/compat.h> /* for ENODATA, if needed */
 #include <ntfs-3g/object_id.h>
 #include <ntfs-3g/reparse.h>
 #include <ntfs-3g/security.h>
@@ -39,7 +40,6 @@
 #include "wimlib/alloca.h"
 #include "wimlib/assert.h"
 #include "wimlib/blob_table.h"
-#include "wimlib/capture.h"
 #include "wimlib/dentry.h"
 #include "wimlib/encoding.h"
 #include "wimlib/endianness.h"
 #include "wimlib/object_id.h"
 #include "wimlib/paths.h"
 #include "wimlib/reparse.h"
+#include "wimlib/scan.h"
 #include "wimlib/security.h"
 
-/* NTFS-3g 2013 renamed MS_RDONLY to NTFS_MNT_RDONLY.  We can't check for the
+/* NTFS-3G 2013 renamed MS_RDONLY to NTFS_MNT_RDONLY.  We can't check for the
  * existence of NTFS_MNT_RDONLY at compilation time because it's an enum.  We
  * also can't check for MS_RDONLY being missing because it's also a system
- * constant.  So check if the NTFS-3g specific MS_IGNORE_HIBERFILE is defined;
+ * constant.  So check if the NTFS-3G specific MS_IGNORE_HIBERFILE is defined;
  * if yes, then we need to use the old MS_RDONLY.  */
 #ifdef MS_IGNORE_HIBERFILE
 #  define NTFS_MNT_RDONLY MS_RDONLY
@@ -64,6 +65,7 @@
 struct ntfs_volume_wrapper {
        ntfs_volume *vol;
        size_t refcnt;
+       bool dedup_warned;
 };
 
 /* Description of where data is located in an NTFS volume  */
@@ -115,7 +117,7 @@ open_ntfs_attr(ntfs_inode *ni, const struct ntfs_location *loc)
 
 int
 read_ntfs_attribute_prefix(const struct blob_descriptor *blob, u64 size,
-                          const struct read_blob_callbacks *cbs)
+                          const struct consume_chunk_callback *cb)
 {
        const struct ntfs_location *loc = blob->ntfs_loc;
        ntfs_volume *vol = loc->volume->vol;
@@ -152,7 +154,7 @@ read_ntfs_attribute_prefix(const struct blob_descriptor *blob, u64 size,
                }
                pos += to_read;
                bytes_remaining -= to_read;
-               ret = call_consume_chunk(buf, to_read, cbs);
+               ret = consume_chunk(cb, buf, to_read);
                if (ret)
                        goto out_close_ntfs_attr;
        }
@@ -230,6 +232,27 @@ read_reparse_header(ntfs_inode *ni, struct wim_inode *inode)
        return 0;
 }
 
+
+static void
+warn_special_reparse_points(const struct wim_inode *inode,
+                           const struct scan_params *params,
+                           struct ntfs_volume_wrapper *volume)
+{
+       if (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_DEDUP &&
+           (params->add_flags & WIMLIB_ADD_FLAG_WINCONFIG) &&
+           !volume->dedup_warned)
+       {
+               WARNING(
+         "Filesystem includes files deduplicated with Windows'\n"
+"          Data Deduplication feature, which to properly restore\n"
+"          would require that the chunk store in \"System Volume Information\"\n"
+"          be included in the WIM image. By default \"System Volume Information\"\n"
+"          is excluded, so you may want to use a custom capture configuration\n"
+"          file which includes it.");
+               volume->dedup_warned = true;
+       }
+}
+
 static int
 attr_type_to_wimlib_stream_type(ATTR_TYPES type)
 {
@@ -271,7 +294,7 @@ set_attr_sort_key(ntfs_inode *ni, struct ntfs_location *loc)
 /*
  * Add a new stream to the specified inode, with duplicate checking.
  *
- * This works around a problem where NTFS-3g can list multiple unnamed data
+ * This works around a problem where NTFS-3G can list multiple unnamed data
  * streams for a single file.  In this case we can only keep one.  We'll prefer
  * one that is nonempty.
  */
@@ -611,7 +634,7 @@ struct readdir_ctx {
        size_t path_len;
        struct dos_name_map dos_name_map;
        struct ntfs_volume_wrapper *volume;
-       struct capture_params *params;
+       struct scan_params *params;
        int ret;
 };
 
@@ -622,7 +645,7 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_p,
                                    size_t path_len,
                                    int name_type,
                                    struct ntfs_volume_wrapper *volume,
-                                   struct capture_params *params);
+                                   struct scan_params *params);
 
 static int
 filldir(void *_ctx, const ntfschar *name, const int name_nchars,
@@ -676,7 +699,7 @@ static int
 ntfs_3g_recurse_directory(ntfs_inode *ni, char *path, size_t path_len,
                          struct wim_dentry *parent,
                          struct ntfs_volume_wrapper *volume,
-                         struct capture_params *params)
+                         struct scan_params *params)
 {
        int ret;
        s64 pos = 0;
@@ -721,7 +744,7 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                                    size_t path_len,
                                    int name_type,
                                    struct ntfs_volume_wrapper *volume,
-                                   struct capture_params *params)
+                                   struct scan_params *params)
 {
        u32 attributes;
        int ret;
@@ -753,13 +776,13 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        if (unlikely(attributes & FILE_ATTRIBUTE_ENCRYPTED)) {
                if (params->add_flags & WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
                {
-                       ERROR("Can't archive \"%s\" because NTFS-3g capture mode "
+                       ERROR("Can't archive \"%s\" because NTFS-3G capture mode "
                              "does not support encrypted files and directories", path);
                        ret = WIMLIB_ERR_UNSUPPORTED_FILE;
                        goto out;
                }
                params->progress.scan.cur_path = path;
-               ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_UNSUPPORTED, NULL);
+               ret = do_scan_progress(params, WIMLIB_SCAN_DENTRY_UNSUPPORTED, NULL);
                goto out;
        }
 
@@ -792,6 +815,8 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
                                                volume, AT_REPARSE_POINT);
                if (ret)
                        goto out;
+
+               warn_special_reparse_points(inode, params, volume);
        }
 
        /* Load the object ID.  */
@@ -812,7 +837,7 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        if (ret)
                goto out;
 
-       /* Reparse-point fixups are a no-op because in NTFS-3g capture mode we
+       /* Reparse-point fixups are a no-op because in NTFS-3G capture mode we
         * only allow capturing an entire volume. */
        if (params->add_flags & WIMLIB_ADD_FLAG_RPFIX &&
            inode_is_symlink(inode))
@@ -838,16 +863,16 @@ ntfs_3g_build_dentry_tree_recursive(struct wim_dentry **root_ret,
 out_progress:
        params->progress.scan.cur_path = path;
        if (root == NULL)
-               ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
+               ret = do_scan_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL);
        else
-               ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
+               ret = do_scan_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
 out:
        if (ni)
                ntfs_inode_close(ni);
        if (unlikely(ret)) {
                free_dentry_tree(root, params->blob_table);
                root = NULL;
-               ret = report_capture_error(params, ret, path);
+               ret = report_scan_error(params, ret, path);
        }
        *root_ret = root;
        return ret;
@@ -855,15 +880,14 @@ out:
 
 int
 ntfs_3g_build_dentry_tree(struct wim_dentry **root_ret,
-                         const char *device,
-                         struct capture_params *params)
+                         const char *device, struct scan_params *params)
 {
        struct ntfs_volume_wrapper *volume;
        ntfs_volume *vol;
        char *path;
        int ret;
 
-       volume = MALLOC(sizeof(struct ntfs_volume_wrapper));
+       volume = CALLOC(1, sizeof(struct ntfs_volume_wrapper));
        if (!volume)
                return WIMLIB_ERR_NOMEM;
 
@@ -878,7 +902,16 @@ ntfs_3g_build_dentry_tree(struct wim_dentry **root_ret,
        volume->vol = vol;
        volume->refcnt = 1;
 
-       ntfs_open_secure(vol);
+       /* Currently, libntfs-3g users that need to read security descriptors
+        * are required to call ntfs_open_secure() to open the volume's security
+        * descriptor index, "$Secure".  This is only required to work on NTFS
+        * v3.0+, as older versions did not have a security descriptor index. */
+       if (ntfs_open_secure(vol) && vol->major_ver >= 3) {
+               ERROR_WITH_ERRNO("Unable to open security descriptor index of "
+                                "NTFS volume \"%s\"", device);
+               ret = WIMLIB_ERR_NTFS_3G;
+               goto out_put_ntfs_volume;
+       }
 
        /* 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
@@ -890,7 +923,7 @@ ntfs_3g_build_dentry_tree(struct wim_dentry **root_ret,
        path = MALLOC(32768);
        if (!path) {
                ret = WIMLIB_ERR_NOMEM;
-               goto out_put_ntfs_volume;
+               goto out_close_secure;
        }
 
        path[0] = '/';
@@ -899,10 +932,17 @@ ntfs_3g_build_dentry_tree(struct wim_dentry **root_ret,
                                                  FILE_NAME_POSIX, volume,
                                                  params);
        FREE(path);
+out_close_secure:
+       /* Undo the effects of ntfs_open_secure().  This is not yet done
+        * automatically by ntfs_umount().  But NULL out the inode to
+        * potentially be robust against future versions doing so. */
+       if (vol->secure_ni) {
+               ntfs_index_ctx_put(vol->secure_xsii);
+               ntfs_index_ctx_put(vol->secure_xsdh);
+               ntfs_inode_close(vol->secure_ni);
+               vol->secure_ni = NULL;
+       }
 out_put_ntfs_volume:
-       ntfs_index_ctx_put(vol->secure_xsii);
-       ntfs_index_ctx_put(vol->secure_xsdh);
-       ntfs_inode_close(vol->secure_ni);
        put_ntfs_volume(volume);
        return ret;
 }