X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fextract.c;h=6e341cc0f396c414992efe0c5e7935750a26cd71;hb=051a59e4c6d114fc7abfa14ff78436adab5defb9;hp=bd3ef92922bf7292eccf42f6b264fd21a7d697fe;hpb=6f7956a06fcf92a304fae93e393e8eaee34e92d5;p=wimlib diff --git a/src/extract.c b/src/extract.c index bd3ef929..6e341cc0 100644 --- a/src/extract.c +++ b/src/extract.c @@ -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. */ /* @@ -11,123 +16,155 @@ * 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 "config.h" + +#include +#include +#include +#include +#include +#include + +#ifdef HAVE_UTIME_H +#include +#endif + +#include + #include "dentry.h" #include "lookup_table.h" +#include "timestamp.h" +#include "wimlib_internal.h" #include "xml.h" -#include -#include -#include -#include -#include -#include +/* Internal */ +#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE 0x80000000 -/* - * Extracts a regular file from the WIM archive. - * - * @dentry: The directory entry for the file, which must be a - * regular file. - * @output_path: The path to which the file is to be extracted. - * @lookup_table: The lookup table for the WIM file. - * @wim_fp: The FILE* for the WIM, opened for reading. - * @wim_ctype: The type of compression used in the WIM. - * @link_type: One of WIM_LINK_TYPE_*; specifies what to do with - * files that are hard-linked inside the WIM. - * @is_multi_image_extraction: - * True if the image currently being extracted is just one - * image of a multi-image extraction. This is needed so - * that cross-image symbolic links can be created - * correctly. - */ -static int extract_regular_file(WIMStruct *w, - const struct dentry *dentry, - const char *output_path) +static int extract_regular_file_linked(const struct dentry *dentry, + const char *output_dir, + const char *output_path, + int extract_flags, + struct lookup_table_entry *lte) { - struct lookup_table *lookup_table; - int link_type; - bool is_multi_image_extraction; - struct lookup_table_entry *lte; - int ret; - int out_fd; - const struct resource_entry *res_entry; - - lookup_table = w->lookup_table; - link_type = w->link_type; - is_multi_image_extraction = w->is_multi_image_extraction; - lte = lookup_resource(lookup_table, dentry->hash); - - /* 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 (link_type != WIM_LINK_TYPE_NONE && lte && lte->out_refcnt != 0) { - wimlib_assert(lte->file_on_disk); - - if (link_type == WIM_LINK_TYPE_HARD) { - if (link(lte->file_on_disk, output_path) != 0) { - ERROR_WITH_ERRNO("Failed to hard link " - "`%s' to `%s'", - output_path, lte->file_on_disk); - return WIMLIB_ERR_LINK; - } - } else { - int num_path_components; - int num_output_dir_path_components; - size_t file_on_disk_len; - char *p; - const char *p2; - size_t i; - - num_path_components = - get_num_path_components(dentry->full_path_utf8) - 1; - num_output_dir_path_components = - get_num_path_components(w->output_dir); - - if (is_multi_image_extraction) { - num_path_components++; - num_output_dir_path_components--; - } - file_on_disk_len = strlen(lte->file_on_disk); + /* 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->extracted_file); + + if (extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) { + if (link(lte->extracted_file, output_path) != 0) { + ERROR_WITH_ERRNO("Failed to hard link " + "`%s' to `%s'", + output_path, lte->extracted_file); + return WIMLIB_ERR_LINK; + } + } else { + int num_path_components; + int num_output_dir_path_components; + size_t extracted_file_len; + char *p; + 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 = + get_num_path_components(output_dir); + + if (extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) { + num_path_components++; + num_output_dir_path_components--; + } + extracted_file_len = strlen(lte->extracted_file); - char buf[file_on_disk_len + 3 * num_path_components + 1]; - p = &buf[0]; + char buf[extracted_file_len + 3 * num_path_components + 1]; + p = &buf[0]; - for (i = 0; i < num_path_components; i++) { - *p++ = '.'; - *p++ = '.'; - *p++ = '/'; + for (i = 0; i < num_path_components; i++) { + *p++ = '.'; + *p++ = '.'; + *p++ = '/'; + } + p2 = lte->extracted_file; + while (*p2 == '/') + p2++; + while (num_output_dir_path_components--) + p2 = path_next_part(p2, NULL); + strcpy(p, p2); + if (symlink(buf, output_path) != 0) { + ERROR_WITH_ERRNO("Failed to symlink `%s' to " + "`%s'", + buf, lte->extracted_file); + return WIMLIB_ERR_LINK; + } + + } + return 0; +} + +static int extract_regular_file_unlinked(WIMStruct *w, + 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; + int ret; + 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; } - p2 = lte->file_on_disk; - while (*p2 == '/') - p2++; - while (num_output_dir_path_components--) - p2 = path_next_part(p2, NULL); - strcpy(p, p2); - if (symlink(buf, output_path) != 0) { - ERROR_WITH_ERRNO("Failed to symlink `%s' to " - "`%s'", - buf, lte->file_on_disk); - return WIMLIB_ERR_LINK; + 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; } - } - return 0; - } + } - /* Otherwise, we must actually extract the file contents. */ + /* 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) { @@ -136,126 +173,244 @@ static int extract_regular_file(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 = <e->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 = 0; - else - 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 directory from the WIM archive. +/* + * Extracts a regular file from the WIM archive. + */ +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 = inode_unnamed_lte(inode, w->lookup_table); + + 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); + +} + +static int extract_symlink(const struct dentry *dentry, const char *output_path, + const WIMStruct *w) +{ + char target[4096]; + 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); + return WIMLIB_ERR_INVALID_DENTRY; + } + ret = symlink(target, output_path); + if (ret != 0) { + ERROR_WITH_ERRNO("Failed to symlink `%s' to `%s'", + output_path, target); + return WIMLIB_ERR_LINK; + } + return 0; +} + +/* + * 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; } +struct extract_args { + WIMStruct *w; + int extract_flags; + const char *output_dir; + 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_regular_file_or_directory(struct dentry *dentry, void *arg) +static int extract_dentry(struct dentry *dentry, void *arg) { - WIMStruct *w = (WIMStruct*)arg; - size_t len = strlen(w->output_dir); + struct extract_args *args = arg; + WIMStruct *w = args->w; + int extract_flags = args->extract_flags; + size_t len = strlen(args->output_dir); char output_path[len + dentry->full_path_utf8_len + 1]; - if (w->verbose) + if (extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) { + wimlib_assert(dentry->full_path_utf8); puts(dentry->full_path_utf8); + } - memcpy(output_path, w->output_dir, len); + 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)) + 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); +} - if (dentry_is_regular_file(dentry)) { - return extract_regular_file(w, dentry, output_path); - } else { - if (dentry_is_root(dentry)) /* Root doesn't need to be extracted. */ - return 0; - else - return extract_directory(dentry, output_path); +/* 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 0; } -static int extract_single_image(WIMStruct *w, int image) + +static int extract_single_image(WIMStruct *w, int image, + const char *output_dir, int extract_flags) { DEBUG("Extracting image %d", image); int ret; - ret = wimlib_select_image(w, image); + ret = select_wim_image(w, image); if (ret != 0) return ret; - return for_dentry_in_tree(wim_root_dentry(w), - extract_regular_file_or_directory, w); + struct extract_args args = { + .w = w, + .extract_flags = extract_flags, + .output_dir = output_dir, + .num_lutimes_warnings = 0, + }; + + 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); + } -/* Extracts all images from the WIM to w->output_dir, with the images placed in +/* Extracts all images from the WIM to @output_dir, with the images placed in * subdirectories named by their image names. */ -static int extract_all_images(WIMStruct *w) +static int extract_all_images(WIMStruct *w, const char *output_dir, + int extract_flags) { size_t image_name_max_len = max(xml_get_max_image_name_len(w), 20); - size_t output_path_len = strlen(w->output_dir); + size_t output_path_len = strlen(output_dir); char buf[output_path_len + 1 + image_name_max_len + 1]; int ret; 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); - memcpy(buf, w->output_dir, output_path_len); + 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); @@ -263,80 +418,60 @@ static int extract_all_images(WIMStruct *w) /* Image name is empty. Use image number instead */ sprintf(buf + output_path_len + 1, "%d", image); } - ret = wimlib_set_output_dir(w, buf); + ret = extract_single_image(w, image, buf, extract_flags); if (ret != 0) - goto done; - ret = extract_single_image(w, image); - if (ret != 0) - goto done; + return ret; } -done: - /* Restore original output directory */ - buf[output_path_len + 1] = '\0'; - return wimlib_set_output_dir(w, buf); + return 0; } + /* Extracts a single image or all images from a WIM file. */ -WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image) +WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image, + const char *output_dir, int flags, + WIMStruct **additional_swms, + unsigned num_additional_swms) { - if (!w->output_dir) { - ERROR("No output directory selected."); - return WIMLIB_ERR_NOTDIR; - } - if (image == WIM_ALL_IMAGES) { - w->is_multi_image_extraction = true; - return extract_all_images(w); - } else { - w->is_multi_image_extraction = false; - return extract_single_image(w, image); - } + struct lookup_table *joined_tab, *w_tab_save; + int ret; -} + 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); -/* Set the output directory for WIM extraction. The directory is created using - * mkdir(). Fails if directory cannot be created or already exists. */ -WIMLIBAPI int wimlib_set_output_dir(WIMStruct *w, const char *dir) -{ - char *p; - DEBUG("Setting output directory to `%s'", dir); + if (!w || !output_dir) + return WIMLIB_ERR_INVALID_PARAM; - if (!dir) { - ERROR("Must specify a directory!"); + if ((flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) + == (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) return WIMLIB_ERR_INVALID_PARAM; - } - p = STRDUP(dir); - if (!p) { - ERROR("Out of memory"); - return WIMLIB_ERR_NOMEM; + + 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 (mkdir(dir, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) != 0) { - if (errno == EEXIST) { - DEBUG("`%s' already exists", dir); - goto done; - } - ERROR_WITH_ERRNO("Cannot create directory `%s'", dir); - FREE(p); - return WIMLIB_ERR_MKDIR; + 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 { - DEBUG("Created directory `%s'", dir); + flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE; + ret = extract_single_image(w, image, output_dir, flags); } -done: - FREE(w->output_dir); - w->output_dir = p; - return 0; -} - -WIMLIBAPI int wimlib_set_link_type(WIMStruct *w, int link_type) -{ - switch (link_type) { - case WIM_LINK_TYPE_NONE: - case WIM_LINK_TYPE_HARD: - case WIM_LINK_TYPE_SYMBOLIC: - w->link_type = link_type; - return 0; - default: - return WIMLIB_ERR_INVALID_PARAM; + if (num_additional_swms) { + free_lookup_table(w->lookup_table); + w->lookup_table = w_tab_save; } -} + return ret; +}