]> wimlib.net Git - wimlib/blobdiff - src/extract.c
Make different threads use different FILE*'s
[wimlib] / src / extract.c
index 70384329455a1cba7ef60570b0e7bce40e31dce9..6e341cc0f396c414992efe0c5e7935750a26cd71 100644 (file)
@@ -2,6 +2,11 @@
  * extract.c
  *
  * Support for extracting WIM files.
+ *
+ * This code does NOT contain any filesystem-specific features.  In particular,
+ * security information (i.e. file permissions) and alternate data streams are
+ * ignored, except possibly to read an alternate data stream that contains
+ * symbolic link data.
  */
 
 /*
  * This file is part of wimlib, a library for working with WIM files.
  *
  * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
  * any later version.
  *
  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
  * details.
  *
- * You should have received a copy of the GNU Lesser General Public License
+ * You should have received a copy of the GNU General Public License
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
-#include "wimlib_internal.h"
-#include "dentry.h"
-#include "lookup_table.h"
-#include "xml.h"
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <unistd.h>
+
+#include "config.h"
+
 #include <dirent.h>
-#include <string.h>
 #include <errno.h>
+#include <fcntl.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <sys/time.h>
 
-#ifdef WITH_NTFS_3G
-#include <ntfs-3g/volume.h>
-#include <ntfs-3g/security.h>
+#ifdef HAVE_UTIME_H
+#include <utime.h>
 #endif
 
+#include <unistd.h>
+
+#include "dentry.h"
+#include "lookup_table.h"
+#include "timestamp.h"
+#include "wimlib_internal.h"
+#include "xml.h"
+
 /* Internal */
 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
 
-static int extract_regular_file_linked(const struct dentry *dentry, 
+static int extract_regular_file_linked(const struct dentry *dentry,
                                       const char *output_dir,
                                       const char *output_path,
                                       int extract_flags,
-                                      const struct lookup_table_entry *lte)
+                                      struct lookup_table_entry *lte)
 {
        /* This mode overrides the normal hard-link extraction and
         * instead either symlinks or hardlinks *all* identical files in
         * the WIM, even if they are in a different image (in the case
         * of a multi-image extraction) */
-       wimlib_assert(lte->file_on_disk);
+       wimlib_assert(lte->extracted_file);
 
        if (extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) {
-               if (link(lte->file_on_disk, output_path) != 0) {
+               if (link(lte->extracted_file, output_path) != 0) {
                        ERROR_WITH_ERRNO("Failed to hard link "
                                         "`%s' to `%s'",
-                                        output_path, lte->file_on_disk);
+                                        output_path, lte->extracted_file);
                        return WIMLIB_ERR_LINK;
                }
        } else {
                int num_path_components;
                int num_output_dir_path_components;
-               size_t file_on_disk_len;
+               size_t extracted_file_len;
                char *p;
                const char *p2;
                size_t i;
 
-               num_path_components = 
+               wimlib_assert(extract_flags & WIMLIB_EXTRACT_FLAG_SYMLINK);
+
+               num_path_components =
                        get_num_path_components(dentry->full_path_utf8) - 1;
                num_output_dir_path_components =
                        get_num_path_components(output_dir);
@@ -79,9 +92,9 @@ static int extract_regular_file_linked(const struct dentry *dentry,
                        num_path_components++;
                        num_output_dir_path_components--;
                }
-               file_on_disk_len = strlen(lte->file_on_disk);
+               extracted_file_len = strlen(lte->extracted_file);
 
-               char buf[file_on_disk_len + 3 * num_path_components + 1];
+               char buf[extracted_file_len + 3 * num_path_components + 1];
                p = &buf[0];
 
                for (i = 0; i < num_path_components; i++) {
@@ -89,7 +102,7 @@ static int extract_regular_file_linked(const struct dentry *dentry,
                        *p++ = '.';
                        *p++ = '/';
                }
-               p2 = lte->file_on_disk;
+               p2 = lte->extracted_file;
                while (*p2 == '/')
                        p2++;
                while (num_output_dir_path_components--)
@@ -98,7 +111,7 @@ static int extract_regular_file_linked(const struct dentry *dentry,
                if (symlink(buf, output_path) != 0) {
                        ERROR_WITH_ERRNO("Failed to symlink `%s' to "
                                         "`%s'",
-                                        buf, lte->file_on_disk);
+                                        buf, lte->extracted_file);
                        return WIMLIB_ERR_LINK;
                }
 
@@ -107,15 +120,51 @@ static int extract_regular_file_linked(const struct dentry *dentry,
 }
 
 static int extract_regular_file_unlinked(WIMStruct *w,
-                                        const struct dentry *dentry, 
+                                        struct dentry *dentry,
                                         const char *output_path,
                                         int extract_flags,
                                         struct lookup_table_entry *lte)
 {
+       /* Normal mode of extraction.  Regular files and hard links are
+        * extracted in the way that they appear in the WIM. */
+
        int out_fd;
-       const struct resource_entry *res_entry;
        int ret;
-       /* Otherwise, we must actually extract the file contents. */
+       struct inode *inode = dentry->d_inode;
+
+       if (!((extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE)
+               && (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
+                                    WIMLIB_EXTRACT_FLAG_HARDLINK))))
+       {
+               /* If the dentry is one of a hard link set of at least 2
+                * dentries and one of the other dentries has already been
+                * extracted, make a hard link to the file corresponding to this
+                * already-extracted directory.  Otherwise, extract the file,
+                * and set the inode->extracted_file field so that other
+                * dentries in the hard link group can link to it. */
+               if (inode->link_count > 1) {
+                       if (inode->extracted_file) {
+                               DEBUG("Extracting hard link `%s' => `%s'",
+                                     output_path, inode->extracted_file);
+                               if (link(inode->extracted_file, output_path) != 0) {
+                                       ERROR_WITH_ERRNO("Failed to hard link "
+                                                        "`%s' to `%s'",
+                                                        output_path,
+                                                        inode->extracted_file);
+                                       return WIMLIB_ERR_LINK;
+                               }
+                               return 0;
+                       }
+                       FREE(inode->extracted_file);
+                       inode->extracted_file = STRDUP(output_path);
+                       if (!inode->extracted_file) {
+                               ERROR("Failed to allocate memory for filename");
+                               return WIMLIB_ERR_NOMEM;
+                       }
+               }
+       }
+
+       /* Extract the contents of the file to @output_path. */
 
        out_fd = open(output_path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
        if (out_fd == -1) {
@@ -124,58 +173,56 @@ static int extract_regular_file_unlinked(WIMStruct *w,
                return WIMLIB_ERR_OPEN;
        }
 
-       /* Extract empty file, with no lookup table entry... */
        if (!lte) {
+               /* Empty file with no lookup table entry */
                DEBUG("Empty file `%s'.", output_path);
                ret = 0;
-               goto done;
+               goto out;
        }
 
-       res_entry = &lte->resource_entry;
-
-       ret = extract_resource_to_fd(w, res_entry, out_fd, 
-                                    res_entry->original_size);
-
+       ret = extract_full_wim_resource_to_fd(lte, out_fd);
        if (ret != 0) {
                ERROR("Failed to extract resource to `%s'", output_path);
-               goto done;
+               goto out;
        }
 
-       /* Mark the lookup table entry to indicate this file has been extracted. */
-       lte->out_refcnt++;
-       FREE(lte->file_on_disk);
-       lte->file_on_disk = STRDUP(output_path);
-       if (!lte->file_on_disk)
-               ret = WIMLIB_ERR_NOMEM;
-done:
-       close(out_fd);
+out:
+       if (close(out_fd) != 0) {
+               ERROR_WITH_ERRNO("Failed to close file `%s'", output_path);
+               ret = WIMLIB_ERR_WRITE;
+       }
        return ret;
 }
 
-/* 
- * Extracts a regular file from the WIM archive. 
+/*
+ * Extracts a regular file from the WIM archive.
  */
-static int extract_regular_file(WIMStruct *w, 
-                               const struct dentry *dentry, 
+static int extract_regular_file(WIMStruct *w,
+                               struct dentry *dentry,
                                const char *output_dir,
                                const char *output_path,
                                int extract_flags)
 {
        struct lookup_table_entry *lte;
+       const struct inode *inode = dentry->d_inode;
 
-       lte = __lookup_resource(w->lookup_table, dentry_hash(dentry));
+       lte = inode_unnamed_lte(inode, w->lookup_table);
 
-       /* If we already extracted the same file or a hard link copy of it, we
-        * may be able to simply create a link.  The exact action is specified
-        * by the current @link_type. */
-       if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) &&
-             lte && lte->out_refcnt != 0)
-               return extract_regular_file_linked(dentry, output_dir,
-                                                  output_path, extract_flags,
-                                                  lte);
-       else
-               return extract_regular_file_unlinked(w, dentry, output_path,
-                                                    extract_flags, lte);
+       if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
+                             WIMLIB_EXTRACT_FLAG_HARDLINK)) && lte) {
+               if (lte->extracted_file) {
+                       return extract_regular_file_linked(dentry, output_dir,
+                                                          output_path,
+                                                          extract_flags, lte);
+               } else {
+                       lte->extracted_file = STRDUP(output_path);
+                       if (!lte->extracted_file)
+                               return WIMLIB_ERR_NOMEM;
+               }
+       }
+
+       return extract_regular_file_unlinked(w, dentry, output_path,
+                                            extract_flags, lte);
 
 }
 
@@ -183,7 +230,8 @@ static int extract_symlink(const struct dentry *dentry, const char *output_path,
                           const WIMStruct *w)
 {
        char target[4096];
-       ssize_t ret = dentry_readlink(dentry, target, sizeof(target), w);
+       ssize_t ret = inode_readlink(dentry->d_inode, target,
+                                    sizeof(target), w, 0);
        if (ret <= 0) {
                ERROR("Could not read the symbolic link from dentry `%s'",
                      dentry->full_path_utf8);
@@ -198,29 +246,39 @@ static int extract_symlink(const struct dentry *dentry, const char *output_path,
        return 0;
 }
 
-/* 
- * Extracts a directory from the WIM archive. 
+/*
+ * Extracts a directory from the WIM archive.
  *
  * @dentry:            The directory entry for the directory.
  * @output_path:       The path to which the directory is to be extracted to.
- * @return:            True on success, false on failure. 
+ * @return:            True on success, false on failure.
  */
-static int extract_directory(struct dentry *dentry, const char *output_path)
+static int extract_directory(const char *output_path, bool is_root)
 {
-       /* Compute the output path directory to the directory. */
-       if (mkdir(output_path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) != 0) 
-       {
-               switch (errno) {
-               case EEXIST: /* Already existing directory is OK */
-               case EACCES: /* We may have permissions to extract files inside
-                                the directory, but not for the directory
-                                itself. */
+       int ret;
+       struct stat stbuf;
+       ret = stat(output_path, &stbuf);
+       if (ret == 0) {
+               if (S_ISDIR(stbuf.st_mode)) {
+                       if (!is_root)
+                               WARNING("`%s' already exists", output_path);
                        return 0;
-               default:
-                       ERROR_WITH_ERRNO("Cannot create directory `%s'",
-                                        output_path);
+               } else {
+                       ERROR("`%s' is not a directory", output_path);
                        return WIMLIB_ERR_MKDIR;
                }
+       } else {
+               if (errno != ENOENT) {
+                       ERROR_WITH_ERRNO("Failed to stat `%s'", output_path);
+                       return WIMLIB_ERR_STAT;
+               }
+       }
+       /* Compute the output path directory to the directory. */
+       if (mkdir(output_path, S_IRWXU | S_IRGRP | S_IXGRP |
+                              S_IROTH | S_IXOTH) != 0) {
+               ERROR_WITH_ERRNO("Cannot create directory `%s'",
+                                output_path);
+               return WIMLIB_ERR_MKDIR;
        }
        return 0;
 }
@@ -229,17 +287,12 @@ struct extract_args {
        WIMStruct *w;
        int extract_flags;
        const char *output_dir;
-#ifdef WITH_NTFS_3G
-       struct SECURITY_API *scapi;
-#endif
+       unsigned num_lutimes_warnings;
 };
 
-/* 
- * Extracts a file or directory from the WIM archive.  For use in
- * for_dentry_in_tree().
- *
- * @dentry:    The dentry to extract.
- * @arg:       A pointer to the WIMStruct for the WIM file.
+/*
+ * Extracts a file, directory, or symbolic link from the WIM archive.  For use
+ * in for_dentry_in_tree().
  */
 static int extract_dentry(struct dentry *dentry, void *arg)
 {
@@ -248,24 +301,64 @@ static int extract_dentry(struct dentry *dentry, void *arg)
        int extract_flags = args->extract_flags;
        size_t len = strlen(args->output_dir);
        char output_path[len + dentry->full_path_utf8_len + 1];
-       int ret = 0;
 
-       if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE)
+       if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) {
+               wimlib_assert(dentry->full_path_utf8);
                puts(dentry->full_path_utf8);
+       }
 
        memcpy(output_path, args->output_dir, len);
        memcpy(output_path + len, dentry->full_path_utf8, dentry->full_path_utf8_len);
        output_path[len + dentry->full_path_utf8_len] = '\0';
 
-       if (dentry_is_symlink(dentry)) {
-               ret = extract_symlink(dentry, output_path, w);
-       } else if (dentry_is_directory(dentry)) {
-               ret = extract_directory(dentry, output_path);
-       } else {
-               ret = extract_regular_file(w, dentry, args->output_dir,
-                                          output_path, extract_flags);
+       if (dentry_is_symlink(dentry))
+               return extract_symlink(dentry, output_path, w);
+       else if (dentry_is_directory(dentry))
+               return extract_directory(output_path, dentry_is_root(dentry));
+       else
+               return extract_regular_file(w, dentry, args->output_dir,
+                                           output_path, extract_flags);
+}
+
+/* Apply timestamp to extracted file */
+static int apply_dentry_timestamps(struct dentry *dentry, void *arg)
+{
+       struct extract_args *args = arg;
+       size_t len = strlen(args->output_dir);
+       char output_path[len + dentry->full_path_utf8_len + 1];
+       const struct inode *inode = dentry->d_inode;
+       int ret;
+
+       memcpy(output_path, args->output_dir, len);
+       memcpy(output_path + len, dentry->full_path_utf8, dentry->full_path_utf8_len);
+       output_path[len + dentry->full_path_utf8_len] = '\0';
+
+       struct timeval tv[2];
+       wim_timestamp_to_timeval(inode->last_access_time, &tv[0]);
+       wim_timestamp_to_timeval(inode->last_write_time, &tv[1]);
+       #ifdef HAVE_LUTIMES
+       ret = lutimes(output_path, tv);
+       #else
+       ret = -1;
+       errno = ENOSYS;
+       #endif
+       if (ret != 0) {
+               #ifdef HAVE_UTIME
+               if (errno == ENOSYS) {
+                       struct utimbuf buf;
+                       buf.actime = wim_timestamp_to_unix(inode->last_access_time);
+                       buf.modtime = wim_timestamp_to_unix(inode->last_write_time);
+                       if (utime(output_path, &buf) == 0)
+                               return 0;
+               }
+               #endif
+               if (errno != ENOSYS || args->num_lutimes_warnings < 10) {
+                       WARNING("Failed to set timestamp on file `%s': %s",
+                               output_path, strerror(errno));
+                       args->num_lutimes_warnings++;
+               }
        }
-       return ret;
+       return 0;
 }
 
 
@@ -275,20 +368,23 @@ static int extract_single_image(WIMStruct *w, int image,
        DEBUG("Extracting image %d", image);
 
        int ret;
-       ret = wimlib_select_image(w, image);
+       ret = select_wim_image(w, image);
        if (ret != 0)
                return ret;
 
        struct extract_args args = {
-               .w = w,
-               .extract_flags = extract_flags,
-               .output_dir = output_dir,
-       #ifdef WITH_NTFS_3G
-               .scapi = NULL
-       #endif
+               .w                    = w,
+               .extract_flags        = extract_flags,
+               .output_dir           = output_dir,
+               .num_lutimes_warnings = 0,
        };
 
-       return for_dentry_in_tree(wim_root_dentry(w), extract_dentry, &args);
+       ret = for_dentry_in_tree(wim_root_dentry(w), extract_dentry, &args);
+       if (ret != 0)
+               return ret;
+       return for_dentry_in_tree_depth(wim_root_dentry(w),
+                                       apply_dentry_timestamps, &args);
+
 }
 
 
@@ -304,12 +400,17 @@ static int extract_all_images(WIMStruct *w, const char *output_dir,
        int image;
        const char *image_name;
 
-       DEBUG("Attempting to extract all images from `%s'", w->filename);
+       DEBUG("Attempting to extract all images from `%s' to `%s'",
+             w->filename, output_dir);
+
+       ret = extract_directory(output_dir, true);
+       if (ret != 0)
+               return ret;
 
        memcpy(buf, output_dir, output_path_len);
        buf[output_path_len] = '/';
        for (image = 1; image <= w->hdr.image_count; image++) {
-               
+
                image_name = wimlib_get_image_name(w, image);
                if (*image_name) {
                        strcpy(buf + output_path_len + 1, image_name);
@@ -319,60 +420,58 @@ static int extract_all_images(WIMStruct *w, const char *output_dir,
                }
                ret = extract_single_image(w, image, buf, extract_flags);
                if (ret != 0)
-                       goto done;
+                       return ret;
        }
-done:
-       /* Restore original output directory */
-       buf[output_path_len + 1] = '\0';
        return 0;
 }
 
+
 /* Extracts a single image or all images from a WIM file. */
 WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image,
-                                  const char *output_dir, int flags)
+                                  const char *output_dir, int flags,
+                                  WIMStruct **additional_swms,
+                                  unsigned num_additional_swms)
 {
+       struct lookup_table *joined_tab, *w_tab_save;
        int ret;
-       if (!output_dir)
+
+       DEBUG("w->filename = %s, image = %d, output_dir = %s, flags = 0x%x, "
+             "num_additional_swms = %u",
+             w->filename, image, output_dir, flags, num_additional_swms);
+
+       if (!w || !output_dir)
                return WIMLIB_ERR_INVALID_PARAM;
+
        if ((flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
                        == (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
                return WIMLIB_ERR_INVALID_PARAM;
 
-       if (image == WIM_ALL_IMAGES)
-               flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
-       else
-               flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
-       
-       if ((flags & WIMLIB_EXTRACT_FLAG_NTFS)) {
-       #ifdef WITH_NTFS_3G
-               unsigned long mnt_flags;
-               ret = ntfs_check_if_mounted(output_dir, &mnt_flags);
-               if (ret != 0) {
-                       ERROR_WITH_ERRNO("NTFS-3g: Cannot determine if `%s' "
-                                        "is mounted", output_dir);
-                       return WIMLIB_ERR_NTFS_3G;
-               }
-               if (!(mnt_flags & NTFS_MF_MOUNTED)) {
-                       ERROR("NTFS-3g: Filesystem on `%s' is not mounted ",
-                             output_dir);
-                       return WIMLIB_ERR_NTFS_3G;
-               }
-               if (mnt_flags & NTFS_MF_READONLY) {
-                       ERROR("NTFS-3g: Filesystem on `%s' is mounted "
-                             "read-only", output_dir);
-                       return WIMLIB_ERR_NTFS_3G;
-               }
-       #else
-               ERROR("wimlib was compiled without support for NTFS-3g, so");
-               ERROR("we cannot extract a WIM image while preserving NTFS-");
-               ERROR("specific information");
-               return WIMLIB_ERR_UNSUPPORTED;
-       #endif
+       ret = verify_swm_set(w, additional_swms, num_additional_swms);
+       if (ret != 0)
+               return ret;
+
+       if (num_additional_swms) {
+               ret = new_joined_lookup_table(w, additional_swms,
+                                             num_additional_swms, &joined_tab);
+               if (ret != 0)
+                       return ret;
+               w_tab_save = w->lookup_table;
+               w->lookup_table = joined_tab;
        }
-       if (image == WIM_ALL_IMAGES)
+
+       for_lookup_table_entry(w->lookup_table, lte_free_extracted_file, NULL);
+
+       if (image == WIM_ALL_IMAGES) {
+               flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
                ret = extract_all_images(w, output_dir, flags);
-       else
+       } else {
+               flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
                ret = extract_single_image(w, image, output_dir, flags);
+       }
+       if (num_additional_swms) {
+               free_lookup_table(w->lookup_table);
+               w->lookup_table = w_tab_save;
+       }
        return ret;
 
 }