]> wimlib.net Git - wimlib/blobdiff - src/extract.c
wimlib_apply_image_to_ntfs_volume() API function
[wimlib] / src / extract.c
index 4a2f55b79da3f2eda9c55d1858a8cd5cdb794863..da637d2e55593345e06a1cc908d40511a9111b27 100644 (file)
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
-#include "wimlib_internal.h"
+
+#include <dirent.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <unistd.h>
+
+#include "config.h"
 #include "dentry.h"
 #include "lookup_table.h"
+#include "timestamp.h"
+#include "wimlib_internal.h"
 #include "xml.h"
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <unistd.h>
-#include <dirent.h>
-#include <string.h>
-#include <errno.h>
 
 #ifdef WITH_NTFS_3G
 #include <ntfs-3g/volume.h>
 #include <ntfs-3g/security.h>
 #endif
 
+
 /* Internal */
 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000
 
-/* Sets and creates the directory to which files are to be extracted when
- * extracting files from the WIM. */
-static int make_output_dir(const char *dir)
-{
-       char *p;
-       DEBUG("Setting output directory to `%s'", dir);
-
-       if (mkdir(dir, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) != 0) {
-               if (errno == EEXIST) {
-                       DEBUG("`%s' already exists", dir);
-                       return 0;
-               }
-               ERROR_WITH_ERRNO("Cannot create directory `%s'", dir);
-               return WIMLIB_ERR_MKDIR;
-       } else {
-               DEBUG("Created directory `%s'", dir);
-       }
-       return 0;
-}
-
 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);
 
+
        if (extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) {
                if (link(lte->file_on_disk, output_path) != 0) {
                        ERROR_WITH_ERRNO("Failed to hard link "
@@ -90,6 +78,8 @@ static int extract_regular_file_linked(const struct dentry *dentry,
                const char *p2;
                size_t i;
 
+               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 =
@@ -127,15 +117,50 @@ 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. */
+       const struct list_head *head = &dentry->link_group_list;
+
+       if (head->next != head) {
+               /* This dentry is one of a hard link set of at least 2 dentries.
+                * If 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 dentry->extracted_file field so that other
+                * dentries in the hard link group can link to it. */
+               struct dentry *other;
+               list_for_each_entry(other, head, link_group_list) {
+                       if (other->extracted_file) {
+                               DEBUG("Extracting hard link `%s' => `%s'",
+                                     output_path, other->extracted_file);
+                               if (link(other->extracted_file, output_path) != 0) {
+                                       ERROR_WITH_ERRNO("Failed to hard link "
+                                                        "`%s' to `%s'",
+                                                        output_path,
+                                                        other->extracted_file);
+                                       return WIMLIB_ERR_LINK;
+                               }
+                               return 0;
+                       }
+               }
+               FREE(dentry->extracted_file);
+               dentry->extracted_file = STRDUP(output_path);
+               if (!dentry->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) {
@@ -144,13 +169,14 @@ 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;
        }
 
+
        res_entry = &lte->resource_entry;
 
        ret = extract_resource_to_fd(w, res_entry, out_fd, 
@@ -161,14 +187,20 @@ static int extract_regular_file_unlinked(WIMStruct *w,
                goto done;
        }
 
-       /* 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;
+       if (extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) {
+               /* 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);
+       if (close(out_fd) != 0) {
+               ERROR_WITH_ERRNO("Failed to close file `%s'", output_path);
+               ret = WIMLIB_ERR_WRITE;
+       }
        return ret;
 }
 
@@ -176,26 +208,28 @@ done:
  * Extracts a regular file from the WIM archive. 
  */
 static int extract_regular_file(WIMStruct *w, 
-                               const struct dentry *dentry, 
+                               struct dentry *dentry, 
                                const char *output_dir,
                                const char *output_path,
                                int extract_flags)
 {
        struct lookup_table_entry *lte;
 
-       lte = __lookup_resource(w->lookup_table, dentry_hash(dentry));
+       lte = dentry_first_lte(dentry, w->lookup_table);
+
+       if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
+                             WIMLIB_EXTRACT_FLAG_HARDLINK)) && lte) {
+               if (lte->out_refcnt++ != 0)
+                       return extract_regular_file_linked(dentry, output_dir,
+                                                          output_path,
+                                                          extract_flags, lte);
+               lte->file_on_disk = STRDUP(output_path);
+               if (!lte->file_on_disk)
+                       return WIMLIB_ERR_NOMEM;
+       }
 
-       /* 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);
+       return extract_regular_file_unlinked(w, dentry, output_path,
+                                            extract_flags, lte);
 
 }
 
@@ -225,22 +259,32 @@ static int extract_symlink(const struct dentry *dentry, const char *output_path,
  * @output_path:       The path to which the directory is to be extracted to.
  * @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;
 }
@@ -255,11 +299,8 @@ struct extract_args {
 };
 
 /* 
- * 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)
 {
@@ -268,25 +309,48 @@ 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;
+       int ret;
 
-       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)) {
+       if (dentry_is_symlink(dentry))
                ret = extract_symlink(dentry, output_path, w);
-       } else if (dentry_is_directory(dentry)) {
-               if (!dentry_is_root(dentry)) /* Root doesn't need to be extracted. */
-                       ret = extract_directory(dentry, output_path);
-       } else {
+       else if (dentry_is_directory(dentry))
+               ret = extract_directory(output_path, dentry_is_root(dentry));
+       else
                ret = extract_regular_file(w, dentry, args->output_dir,
-                                          output_path, extract_flags);
+                                           output_path, extract_flags);
+       if (ret != 0)
+               return ret;
+
+       return 0;
+}
+
+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];
+
+       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(dentry->last_access_time, &tv[0]);
+       wim_timestamp_to_timeval(dentry->last_write_time, &tv[1]);
+       if (lutimes(output_path, tv) != 0) {
+               WARNING("Failed to set timestamp on file `%s': %s",
+                       output_path, strerror(errno));
        }
-       return ret;
+       return 0;
 }
 
 
@@ -309,7 +373,12 @@ static int extract_single_image(WIMStruct *w, int image,
        #endif
        };
 
-       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);
+
 }
 
 
@@ -327,6 +396,10 @@ static int extract_all_images(WIMStruct *w, const char *output_dir,
 
        DEBUG("Attempting to extract all images from `%s'", w->filename);
 
+       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++) {
@@ -338,9 +411,6 @@ static int extract_all_images(WIMStruct *w, const char *output_dir,
                        /* Image name is empty. Use image number instead */
                        sprintf(buf + output_path_len + 1, "%d", image);
                }
-               ret = make_output_dir(buf);
-               if (ret != 0)
-                       goto done;
                ret = extract_single_image(w, image, buf, extract_flags);
                if (ret != 0)
                        goto done;
@@ -355,51 +425,58 @@ done:
 WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image,
                                   const char *output_dir, int flags)
 {
-       int ret;
        if (!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)
+       for_lookup_table_entry(w->lookup_table, zero_out_refcnts, NULL);
+
+       if (image == WIM_ALL_IMAGES) {
                flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
-       else
+               return extract_all_images(w, output_dir, flags);
+       } else {
                flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
-       
-       ret = make_output_dir(output_dir);
+               return extract_single_image(w, image, output_dir, flags);
+       }
+
+}
+
+WIMLIBAPI int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
+                                               const char *device, int flags)
+{
+#ifdef WITH_NTFS_3G
+       int ret;
+
+       if (!device)
+               return WIMLIB_ERR_INVALID_PARAM;
+       if (image == WIM_ALL_IMAGES) {
+               ERROR("Can only apply a single image when applying "
+                     "directly to a NTFS volume");
+               return WIMLIB_ERR_INVALID_PARAM;
+       }
+       if (flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) {
+               ERROR("Cannot specifcy symlink or hardlink flags when applying ");
+               ERROR("directly to a NTFS volume");
+               return WIMLIB_ERR_INVALID_PARAM;
+       }
+       ret = wimlib_select_image(w, image);
        if (ret != 0)
                return ret;
 
-       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);
-               }
-               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
-       }
-       if (image == WIM_ALL_IMAGES)
-               ret = extract_all_images(w, output_dir, flags);
-       else
-               ret = extract_single_image(w, image, output_dir, flags);
-       return ret;
+       if (getuid() != 0) {
+               ERROR("We are not root, but NTFS-3g requires root privileges to set arbitrary");
+               ERROR("security data on the NTFS filesystem.  Please run this program as root");
+               ERROR("if you want to extract a WIM image while preserving NTFS-specific");
+               ERROR("information.");
 
+               return WIMLIB_ERR_NOT_ROOT;
+       }
+#else /* WITH_NTFS_3G */
+       ERROR("wimlib was compiled without support for NTFS-3g, so");
+       ERROR("we cannot apply a WIM image directly to a NTFS volume");
+       return WIMLIB_ERR_UNSUPPORTED;
+#endif /* !WITH_NTFS_3G */
 }