X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fextract_image.c;h=2092cf713521b39709600ae353191ee8f11054cc;hp=ba9b8c675d47e90dd98c70e502236330dcfbf199;hb=17188d279139f919f862aa8b0858570131abce50;hpb=36a737d734cdc6c6eb0ce9da3183a1f8fa4288e6 diff --git a/src/extract_image.c b/src/extract_image.c index ba9b8c67..2092cf71 100644 --- a/src/extract_image.c +++ b/src/extract_image.c @@ -2,15 +2,10 @@ * extract_image.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. */ /* - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * @@ -31,33 +26,71 @@ #include "config.h" #include + +#ifdef __WIN32__ +# include "win32.h" +#else +# ifdef HAVE_UTIME_H +# include +# endif +# include "timestamp.h" +# include +#endif + #include #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" #ifdef WITH_NTFS_3G -#include +# include +#endif + +#ifdef HAVE_ALLOCA_H +# include #endif -static int extract_regular_file_linked(struct dentry *dentry, - const char *output_path, - struct apply_args *args, - struct lookup_table_entry *lte) + +#ifndef __WIN32__ + +/* Returns the number of components of @path. */ +static unsigned +get_num_path_components(const char *path) +{ + unsigned num_components = 0; + while (*path) { + while (*path == '/') + path++; + if (*path) + num_components++; + while (*path && *path != '/') + path++; + } + return num_components; +} + +static const char * +path_next_part(const char *path) +{ + while (*path && *path != '/') + path++; + while (*path && *path == '/') + path++; + return path; +} + +static int +extract_regular_file_linked(struct wim_dentry *dentry, + const char *output_path, + struct apply_args *args, + struct wim_lookup_table_entry *lte) { /* This mode overrides the normal hard-link extraction and * instead either symlinks or hardlinks *all* identical files in @@ -79,10 +112,8 @@ static int extract_regular_file_linked(struct dentry *dentry, 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(args->target); + num_path_components = get_num_path_components(dentry->_full_path) - 1; + num_output_dir_path_components = get_num_path_components(args->target); if (args->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) { num_path_components++; @@ -101,12 +132,13 @@ static int extract_regular_file_linked(struct dentry *dentry, p2 = lte->extracted_file; while (*p2 == '/') p2++; - while (num_output_dir_path_components--) - p2 = path_next_part(p2, NULL); + while (num_output_dir_path_components > 0) { + p2 = path_next_part(p2); + num_output_dir_path_components--; + } strcpy(p, p2); if (symlink(buf, output_path) != 0) { - ERROR_WITH_ERRNO("Failed to symlink `%s' to " - "`%s'", + ERROR_WITH_ERRNO("Failed to symlink `%s' to `%s'", buf, lte->extracted_file); return WIMLIB_ERR_LINK; } @@ -114,44 +146,120 @@ static int extract_regular_file_linked(struct dentry *dentry, return 0; } -static int extract_regular_file_unlinked(struct dentry *dentry, - struct apply_args *args, - const char *output_path, - struct lookup_table_entry *lte) +static int +symlink_apply_unix_data(const char *link, + const struct wimlib_unix_data *unix_data) +{ + if (lchown(link, unix_data->uid, unix_data->gid)) { + if (errno == EPERM) { + /* Ignore */ + WARNING_WITH_ERRNO("failed to set symlink UNIX " + "owner/group on \"%s\"", link); + } else { + ERROR_WITH_ERRNO("failed to set symlink UNIX " + "owner/group on \"%s\"", link); + return WIMLIB_ERR_INVALID_DENTRY; + } + } + return 0; +} + +static int +fd_apply_unix_data(int fd, const char *path, + const struct wimlib_unix_data *unix_data, + int extract_flags) +{ + if (extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) + return 0; + + if (fchown(fd, unix_data->uid, unix_data->gid)) { + if (errno == EPERM && + !(extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) + { + WARNING_WITH_ERRNO("failed to set file UNIX " + "owner/group on \"%s\"", path); + } else { + ERROR_WITH_ERRNO("failed to set file UNIX " + "owner/group on \"%s\"", path); + return (errno == EPERM) ? WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT : + WIMLIB_ERR_WRITE; + } + } + + if (fchmod(fd, unix_data->mode)) { + if (errno == EPERM && + !(extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)) + { + WARNING_WITH_ERRNO("failed to set UNIX file mode " + "on \"%s\"", path); + } else { + ERROR_WITH_ERRNO("failed to set UNIX file mode " + "on \"%s\"", path); + return (errno == EPERM) ? WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT : + WIMLIB_ERR_WRITE; + } + } + return 0; +} + +static int +dir_apply_unix_data(const char *dir, const struct wimlib_unix_data *unix_data, + int extract_flags) +{ + int dfd = open(dir, O_RDONLY); + int ret; + if (dfd >= 0) { + ret = fd_apply_unix_data(dfd, dir, unix_data, extract_flags); + if (close(dfd) && ret == 0) { + ERROR_WITH_ERRNO("can't close directory `%s'", dir); + ret = WIMLIB_ERR_WRITE; + } + } else { + ERROR_WITH_ERRNO("can't open directory `%s'", dir); + ret = WIMLIB_ERR_OPENDIR; + } + return ret; +} + +static int +extract_regular_file_unlinked(struct wim_dentry *dentry, + struct apply_args *args, + const char *output_path, + struct wim_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; + struct wim_inode *inode = dentry->d_inode; if (!((args->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) && (args->extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)))) { - /* If the dentry is one of a hard link set of at least 2 + /* If the dentry is part 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) { + * already-extracted directory. Otherwise, extract the file and + * set the inode->i_extracted_file field so that other dentries + * in the hard link group can link to it. */ + if (inode->i_nlink > 1) { + if (inode->i_extracted_file) { DEBUG("Extracting hard link `%s' => `%s'", - output_path, inode->extracted_file); - if (link(inode->extracted_file, output_path) != 0) { + output_path, inode->i_extracted_file); + if (link(inode->i_extracted_file, output_path) != 0) { ERROR_WITH_ERRNO("Failed to hard link " "`%s' to `%s'", output_path, - inode->extracted_file); + inode->i_extracted_file); return WIMLIB_ERR_LINK; } return 0; } - FREE(inode->extracted_file); - inode->extracted_file = STRDUP(output_path); - if (!inode->extracted_file) { + FREE(inode->i_extracted_file); + inode->i_extracted_file = STRDUP(output_path); + if (!inode->i_extracted_file) { ERROR("Failed to allocate memory for filename"); return WIMLIB_ERR_NOMEM; } @@ -171,32 +279,47 @@ static int extract_regular_file_unlinked(struct dentry *dentry, /* Empty file with no lookup table entry */ DEBUG("Empty file `%s'.", output_path); ret = 0; - goto out; + goto out_extract_unix_data; } ret = extract_wim_resource_to_fd(lte, out_fd, wim_resource_size(lte)); - if (ret != 0) { + if (ret) { ERROR("Failed to extract resource to `%s'", output_path); goto out; } - args->progress.extract.completed_bytes += wim_resource_size(lte); + +out_extract_unix_data: + if (args->extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) { + struct wimlib_unix_data unix_data; + ret = inode_get_unix_data(inode, &unix_data, NULL); + if (ret > 0) + ; + else if (ret < 0) + ret = 0; + else + ret = fd_apply_unix_data(out_fd, output_path, &unix_data, + args->extract_flags); + if (ret) + goto out; + } + if (lte) + args->progress.extract.completed_bytes += wim_resource_size(lte); out: if (close(out_fd) != 0) { ERROR_WITH_ERRNO("Failed to close file `%s'", output_path); - ret = WIMLIB_ERR_WRITE; + if (ret == 0) + ret = WIMLIB_ERR_WRITE; } return ret; } -/* - * Extracts a regular file from the WIM archive. - */ -static int extract_regular_file(struct dentry *dentry, - struct apply_args *args, - const char *output_path) +static int +extract_regular_file(struct wim_dentry *dentry, + struct apply_args *args, + const char *output_path) { - struct lookup_table_entry *lte; - const struct inode *inode = dentry->d_inode; + struct wim_lookup_table_entry *lte; + const struct wim_inode *inode = dentry->d_inode; lte = inode_unnamed_lte_resolved(inode); @@ -214,209 +337,304 @@ static int extract_regular_file(struct dentry *dentry, return extract_regular_file_unlinked(dentry, args, output_path, lte); } -static int extract_symlink(struct dentry *dentry, - struct apply_args *args, - const char *output_path) +static int +extract_symlink(struct wim_dentry *dentry, + struct apply_args *args, + const char *output_path) { - char target[4096]; - ssize_t ret = inode_readlink(dentry->d_inode, target, - sizeof(target), args->w, 0); - struct lookup_table_entry *lte; + char target[4096 + args->target_realpath_len]; + char *fixed_target; + const struct wim_inode *inode = dentry->d_inode; + + ssize_t ret = wim_inode_readlink(inode, + target + args->target_realpath_len, + sizeof(target) - args->target_realpath_len - 1); + struct wim_lookup_table_entry *lte; if (ret <= 0) { ERROR("Could not read the symbolic link from dentry `%s'", - dentry->full_path_utf8); + dentry->_full_path); return WIMLIB_ERR_INVALID_DENTRY; } - ret = symlink(target, output_path); - if (ret != 0) { + target[args->target_realpath_len + ret] = '\0'; + if (target[args->target_realpath_len] == '/' && + args->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) + { + /* Fix absolute symbolic link target to point into the actual + * extraction destination */ + memcpy(target, args->target_realpath, + args->target_realpath_len); + fixed_target = target; + } else { + /* Keep same link target */ + fixed_target = target + args->target_realpath_len; + } + ret = symlink(fixed_target, output_path); + if (ret) { ERROR_WITH_ERRNO("Failed to symlink `%s' to `%s'", - output_path, target); + output_path, fixed_target); return WIMLIB_ERR_LINK; } - lte = inode_unnamed_lte_resolved(dentry->d_inode); + if (args->extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) { + struct wimlib_unix_data unix_data; + ret = inode_get_unix_data(inode, &unix_data, NULL); + if (ret > 0) + ; + else if (ret < 0) + ret = 0; + else + ret = symlink_apply_unix_data(output_path, &unix_data); + if (ret) + return ret; + } + lte = inode_unnamed_lte_resolved(inode); + wimlib_assert(lte != NULL); args->progress.extract.completed_bytes += wim_resource_size(lte); 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. - */ -static int extract_directory(const char *output_path, bool is_root) +#endif /* !__WIN32__ */ + +static int +extract_directory(struct wim_dentry *dentry, + const tchar *output_path, bool is_root, + int extract_flags) { int ret; struct stat stbuf; - ret = stat(output_path, &stbuf); + + ret = tstat(output_path, &stbuf); if (ret == 0) { if (S_ISDIR(stbuf.st_mode)) { /*if (!is_root)*/ /*WARNING("`%s' already exists", output_path);*/ - return 0; + goto dir_exists; } else { - ERROR("`%s' is not a directory", output_path); + ERROR("`%"TS"' is not a directory", output_path); return WIMLIB_ERR_MKDIR; } } else { if (errno != ENOENT) { - ERROR_WITH_ERRNO("Failed to stat `%s'", output_path); + ERROR_WITH_ERRNO("Failed to stat `%"TS"'", 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); + + if (tmkdir(output_path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)) + { + ERROR_WITH_ERRNO("Cannot create directory `%"TS"'", output_path); return WIMLIB_ERR_MKDIR; } - return 0; +dir_exists: + ret = 0; +#ifndef __WIN32__ + if (extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) { + struct wimlib_unix_data unix_data; + ret = inode_get_unix_data(dentry->d_inode, &unix_data, NULL); + if (ret > 0) + ; + else if (ret < 0) + ret = 0; + else + ret = dir_apply_unix_data(output_path, &unix_data, + extract_flags); + } +#endif + return ret; } -/* - * Extracts a file, directory, or symbolic link from the WIM archive. For use - * in for_dentry_in_tree(). - */ -static int apply_dentry_normal(struct dentry *dentry, void *arg) +#ifndef __WIN32__ +static int +unix_do_apply_dentry(const char *output_path, size_t output_path_len, + struct wim_dentry *dentry, struct apply_args *args) { - struct apply_args *args = arg; - int extract_flags = args->extract_flags; - struct inode *inode = dentry->d_inode; - size_t len; - int ret; - - if (dentry->is_extracted) - return 0; - - if (extract_flags & WIMLIB_EXTRACT_FLAG_NO_STREAMS) - if (inode_unnamed_lte_resolved(inode)) - return 0; - - if ((extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) && - args->progress_func) - { - args->progress.extract.cur_path = dentry->full_path_utf8; - args->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY, - &args->progress); - } - - len = strlen(args->target); - char output_path[len + dentry->full_path_utf8_len + 1]; - memcpy(output_path, args->target, len); - memcpy(output_path + len, dentry->full_path_utf8, dentry->full_path_utf8_len); - output_path[len + dentry->full_path_utf8_len] = '\0'; + const struct wim_inode *inode = dentry->d_inode; if (inode_is_symlink(inode)) - ret = extract_symlink(dentry, args, output_path); + return extract_symlink(dentry, args, output_path); else if (inode_is_directory(inode)) - ret = extract_directory(output_path, false); + return extract_directory((args->extract_flags & + WIMLIB_EXTRACT_FLAG_UNIX_DATA) ? dentry : NULL, + output_path, false, args->extract_flags); else - ret = extract_regular_file(dentry, args, output_path); - if (ret == 0) - dentry->is_extracted = 1; - return ret; + return extract_regular_file(dentry, args, output_path); } -/* Apply timestamp to extracted file */ -static int apply_dentry_timestamps_normal(struct dentry *dentry, void *arg) +static int +unix_do_apply_dentry_timestamps(const char *output_path, + size_t output_path_len, + struct wim_dentry *dentry, + struct apply_args *args) { - struct apply_args *args = arg; - size_t len = strlen(args->target); - char output_path[len + dentry->full_path_utf8_len + 1]; - const struct inode *inode = dentry->d_inode; int ret; + const struct wim_inode *inode = dentry->d_inode; + +#ifdef HAVE_UTIMENSAT + /* Convert the WIM timestamps, which are accurate to 100 nanoseconds, + * into `struct timespec's for passing to utimensat(), which is accurate + * to 1 nanosecond. */ + + struct timespec ts[2]; + ts[0] = wim_timestamp_to_timespec(inode->i_last_access_time); + ts[1] = wim_timestamp_to_timespec(inode->i_last_write_time); + ret = utimensat(AT_FDCWD, output_path, ts, AT_SYMLINK_NOFOLLOW); + if (ret) + ret = errno; +#else + ret = ENOSYS; +#endif - memcpy(output_path, args->target, 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]); + if (ret == ENOSYS) { + /* utimensat() not implemented or not available */ #ifdef HAVE_LUTIMES - ret = lutimes(output_path, tv); - #else - ret = -1; - errno = ENOSYS; + /* Convert the WIM timestamps, which are accurate to 100 + * nanoseconds, into `struct timeval's for passing to lutimes(), + * which is accurate to 1 microsecond. */ + struct timeval tv[2]; + tv[0] = wim_timestamp_to_timeval(inode->i_last_access_time); + tv[1] = wim_timestamp_to_timeval(inode->i_last_write_time); + ret = lutimes(output_path, tv); + if (ret) + ret = errno; #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++; - } + } + + if (ret == ENOSYS) { + /* utimensat() and lutimes() both not implemented or not + * available */ + #ifdef HAVE_UTIME + /* Convert the WIM timestamps, which are accurate to 100 + * nanoseconds, into a `struct utimbuf's for passing to + * utime(), which is accurate to 1 second. */ + struct utimbuf buf; + buf.actime = wim_timestamp_to_unix(inode->i_last_access_time); + buf.modtime = wim_timestamp_to_unix(inode->i_last_write_time); + ret = utime(output_path, &buf); + #endif + } + if (ret && args->num_utime_warnings < 10) { + WARNING_WITH_ERRNO("Failed to set timestamp on file `%s'", + output_path); + args->num_utime_warnings++; } return 0; } +#endif /* !__WIN32__ */ -static int cmp_streams_by_wim_position(const void *p1, const void *p2) +static int +do_apply_op(struct wim_dentry *dentry, struct apply_args *args, + int (*apply_dentry_func)(const tchar *, size_t, + struct wim_dentry *, struct apply_args *)) { - const struct lookup_table_entry *lte1, *lte2; - lte1 = *(const struct lookup_table_entry**)p1; - lte2 = *(const struct lookup_table_entry**)p2; - if (lte1->resource_entry.offset < lte2->resource_entry.offset) - return -1; - else if (lte1->resource_entry.offset > lte2->resource_entry.offset) - return 1; - else - return 0; + tchar *p; + const tchar *full_path; + size_t full_path_nchars; + + wimlib_assert(dentry->_full_path != NULL); + full_path = dentry->_full_path + 1; + full_path_nchars = dentry->full_path_nbytes / sizeof(tchar) - 1; + tchar output_path[args->target_nchars + 1 + + (full_path_nchars - args->wim_source_path_nchars) + 1]; + p = output_path; + + /*print_dentry(dentry, NULL);*/ + /*ERROR("%"TS" %"TS, args->target, dentry->_full_path);*/ + /*ERROR("");*/ + + tmemcpy(p, args->target, args->target_nchars); + p += args->target_nchars; + + if (dentry != args->extract_root) { + *p++ = T('/'); + tmemcpy(p, full_path + args->wim_source_path_nchars, + full_path_nchars - args->wim_source_path_nchars); + p += full_path_nchars - args->wim_source_path_nchars; + } + *p = T('\0'); + return (*apply_dentry_func)(output_path, p - output_path, + dentry, args); } -static int sort_stream_list_by_wim_position(struct list_head *stream_list) + +/* Extracts a file, directory, or symbolic link from the WIM archive. */ +static int +apply_dentry_normal(struct wim_dentry *dentry, void *arg) { - struct list_head *cur; - size_t num_streams; - struct lookup_table_entry **array; - size_t i; - size_t array_size; +#ifdef __WIN32__ + return do_apply_op(dentry, arg, win32_do_apply_dentry); +#else + return do_apply_op(dentry, arg, unix_do_apply_dentry); +#endif +} - num_streams = 0; - list_for_each(cur, stream_list) - num_streams++; - array_size = num_streams * sizeof(array[0]); - array = MALLOC(array_size); - if (!array) { - ERROR("Failed to allocate %zu bytes to sort stream entries", - array_size); - return WIMLIB_ERR_NOMEM; - } - cur = stream_list->next; - for (i = 0; i < num_streams; i++) { - array[i] = container_of(cur, struct lookup_table_entry, staging_list); - cur = cur->next; + +/* Apply timestamps to an extracted file or directory */ +static int +apply_dentry_timestamps_normal(struct wim_dentry *dentry, void *arg) +{ +#ifdef __WIN32__ + return do_apply_op(dentry, arg, win32_do_apply_dentry_timestamps); +#else + return do_apply_op(dentry, arg, unix_do_apply_dentry_timestamps); +#endif +} + +static bool +dentry_is_descendent(const struct wim_dentry *dentry, + const struct wim_dentry *ancestor) +{ + for (;;) { + if (dentry == ancestor) + return true; + if (dentry_is_root(dentry)) + return false; + dentry = dentry->parent; } +} - qsort(array, num_streams, sizeof(array[0]), cmp_streams_by_wim_position); +/* Extract a dentry if it hasn't already been extracted and either + * WIMLIB_EXTRACT_FLAG_NO_STREAMS is not specified, or the dentry is a directory + * and/or has no unnamed stream. */ +static int +maybe_apply_dentry(struct wim_dentry *dentry, void *arg) +{ + struct apply_args *args = arg; + int ret; - INIT_LIST_HEAD(stream_list); - for (i = 0; i < num_streams; i++) - list_add_tail(&array[i]->staging_list, stream_list); - FREE(array); - return 0; + if (dentry->is_extracted) + return 0; + + if (!dentry_is_descendent(dentry, args->extract_root)) + return 0; + + if (args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_STREAMS && + !dentry_is_directory(dentry) && + inode_unnamed_lte_resolved(dentry->d_inode) != NULL) + return 0; + + if ((args->extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) && + args->progress_func) { + args->progress.extract.cur_path = dentry->_full_path; + args->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY, + &args->progress); + } + ret = args->apply_dentry(dentry, args); + if (ret == 0) + dentry->is_extracted = 1; + return ret; } -static void calculate_bytes_to_extract(struct list_head *stream_list, - int extract_flags, - union wimlib_progress_info *progress) +static void +calculate_bytes_to_extract(struct list_head *stream_list, + int extract_flags, + union wimlib_progress_info *progress) { - struct lookup_table_entry *lte; + struct wim_lookup_table_entry *lte; u64 total_bytes = 0; u64 num_streams = 0; /* For each stream to be extracted... */ - list_for_each_entry(lte, stream_list, staging_list) { + list_for_each_entry(lte, stream_list, extraction_list) { if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) { @@ -438,39 +656,53 @@ static void calculate_bytes_to_extract(struct list_head *stream_list, progress->extract.completed_bytes = 0; } -static void maybe_add_stream_for_extraction(struct lookup_table_entry *lte, - struct list_head *stream_list) +static void +maybe_add_stream_for_extraction(struct wim_lookup_table_entry *lte, + struct list_head *stream_list) { if (++lte->out_refcnt == 1) { INIT_LIST_HEAD(<e->inode_list); - list_add_tail(<e->staging_list, stream_list); + list_add_tail(<e->extraction_list, stream_list); } } -static void inode_find_streams_for_extraction(struct inode *inode, - struct list_head *stream_list, - int extract_flags) +static void +inode_find_streams_for_extraction(struct wim_inode *inode, + struct list_head *stream_list, + int extract_flags) { - struct lookup_table_entry *lte; + struct wim_lookup_table_entry *lte; bool inode_added = false; lte = inode_unnamed_lte_resolved(inode); - if (lte) { maybe_add_stream_for_extraction(lte, stream_list); - list_add_tail(&inode->lte_inode_list, <e->inode_list); + list_add_tail(&inode->i_lte_inode_list, <e->inode_list); inode_added = true; } -#ifdef WITH_NTFS_3G - if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { - for (unsigned i = 0; i < inode->num_ads; i++) { - if (inode->ads_entries[i].stream_name_len != 0) { - lte = inode->ads_entries[i].lte; + + /* Determine whether to include alternate data stream entries or not. + * + * UNIX: Include them if extracting using NTFS-3g. + * + * Windows: Include them undconditionally, although if the filesystem is + * not NTFS we won't actually be able to extract them. */ +#if defined(WITH_NTFS_3G) + if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) +#elif defined(__WIN32__) + if (1) +#else + if (0) +#endif + { + for (unsigned i = 0; i < inode->i_num_ads; i++) { + if (inode->i_ads_entries[i].stream_name_nbytes != 0) { + lte = inode->i_ads_entries[i].lte; if (lte) { maybe_add_stream_for_extraction(lte, stream_list); if (!inode_added) { - list_add_tail(&inode->lte_inode_list, + list_add_tail(&inode->i_lte_inode_list, <e->inode_list); inode_added = true; } @@ -478,33 +710,69 @@ static void inode_find_streams_for_extraction(struct inode *inode, } } } -#endif } -static void find_streams_for_extraction(struct hlist_head *inode_list, - struct list_head *stream_list, - struct lookup_table *lookup_table, - int extract_flags) +struct find_streams_ctx { + struct list_head stream_list; + int extract_flags; +}; + +static int +dentry_find_streams_to_extract(struct wim_dentry *dentry, void *_ctx) { - struct inode *inode; - struct hlist_node *cur; - struct dentry *dentry; + struct find_streams_ctx *ctx = _ctx; + struct wim_inode *inode = dentry->d_inode; + + dentry->is_extracted = 0; + if (!inode->i_visited) { + inode_find_streams_for_extraction(inode, &ctx->stream_list, + ctx->extract_flags); + inode->i_visited = 1; + } + return 0; +} - for_lookup_table_entry(lookup_table, lte_zero_out_refcnt, NULL); - INIT_LIST_HEAD(stream_list); - hlist_for_each_entry(inode, cur, inode_list, hlist) { - if (!inode->resolved) - inode_resolve_ltes(inode, lookup_table); - inode_for_each_dentry(dentry, inode) - dentry->is_extracted = 0; - inode_find_streams_for_extraction(inode, stream_list, - extract_flags); +static int +dentry_resolve_and_zero_lte_refcnt(struct wim_dentry *dentry, void *_lookup_table) +{ + struct wim_inode *inode = dentry->d_inode; + struct wim_lookup_table *lookup_table = _lookup_table; + struct wim_lookup_table_entry *lte; + + inode_resolve_ltes(inode, lookup_table); + for (unsigned i = 0; i <= inode->i_num_ads; i++) { + lte = inode_stream_lte_resolved(inode, i); + if (lte) + lte->out_refcnt = 0; } + return 0; +} + +static void +find_streams_for_extraction(struct wim_dentry *root, + struct list_head *stream_list, + struct wim_lookup_table *lookup_table, + int extract_flags) +{ + struct find_streams_ctx ctx; + + INIT_LIST_HEAD(&ctx.stream_list); + ctx.extract_flags = extract_flags; + for_dentry_in_tree(root, dentry_resolve_and_zero_lte_refcnt, lookup_table); + for_dentry_in_tree(root, dentry_find_streams_to_extract, &ctx); + list_transfer(&ctx.stream_list, stream_list); +} + +static int +dentry_mark_inode_unvisited(struct wim_dentry *dentry, void *_ignore) +{ + dentry->d_inode->i_visited = 0; + return 0; } struct apply_operations { - int (*apply_dentry)(struct dentry *dentry, void *arg); - int (*apply_dentry_timestamps)(struct dentry *dentry, void *arg); + int (*apply_dentry)(struct wim_dentry *dentry, void *arg); + int (*apply_dentry_timestamps)(struct wim_dentry *dentry, void *arg); }; static const struct apply_operations normal_apply_operations = { @@ -519,72 +787,183 @@ static const struct apply_operations ntfs_apply_operations = { }; #endif -static int apply_stream_list(struct list_head *stream_list, - struct apply_args *args, - const struct apply_operations *ops, - wimlib_progress_func_t progress_func) +static int +apply_stream_list(struct list_head *stream_list, + struct apply_args *args, + const struct apply_operations *ops, + wimlib_progress_func_t progress_func) { uint64_t bytes_per_progress = args->progress.extract.total_bytes / 100; uint64_t next_progress = bytes_per_progress; - struct lookup_table_entry *lte; - struct inode *inode; - struct dentry *dentry; - int ret = 0; + struct wim_lookup_table_entry *lte; + struct wim_inode *inode; + struct wim_dentry *dentry; + int ret; - /* This complicated loop is actually just looping through the dentries - * (as for_dentry_in_tree() does), but the outer loop is actually over - * the distinct streams to be extracted so that sequential reading of - * the WIM can be implemented. */ + /* This complicated loop is essentially looping through the dentries, + * although dentries may be visited more than once (if a dentry contains + * two different nonempty streams) or not at all (if a dentry contains + * no non-empty streams). + * + * The outer loop is over the distinct streams to be extracted so that + * sequential reading of the WIM can be implemented. */ /* For each distinct stream to be extracted */ - list_for_each_entry(lte, stream_list, staging_list) { + list_for_each_entry(lte, stream_list, extraction_list) { /* For each inode that contains the stream */ - list_for_each_entry(inode, <e->inode_list, lte_inode_list) { + list_for_each_entry(inode, <e->inode_list, i_lte_inode_list) { /* For each dentry that points to the inode */ inode_for_each_dentry(dentry, inode) { - ret = ops->apply_dentry(dentry, args); - if (ret != 0) - goto out; + /* Extract the dentry if it was not already + * extracted */ + ret = maybe_apply_dentry(dentry, args); + if (ret) + return ret; if (progress_func && - args->progress.extract.completed_bytes >= next_progress && - args->progress.extract.total_bytes != 0) + args->progress.extract.completed_bytes >= next_progress) { progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, &args->progress); - next_progress += bytes_per_progress; + if (args->progress.extract.completed_bytes >= + args->progress.extract.total_bytes) + { + next_progress = ~0ULL; + } else { + next_progress = + min (args->progress.extract.completed_bytes + + bytes_per_progress, + args->progress.extract.total_bytes); + } } } } } -out: + return 0; +} + +static int +sort_stream_list_by_wim_position(struct list_head *stream_list) +{ + struct list_head *cur; + size_t num_streams; + struct wim_lookup_table_entry **array; + size_t i; + size_t array_size; + + num_streams = 0; + list_for_each(cur, stream_list) + num_streams++; + array_size = num_streams * sizeof(array[0]); + array = MALLOC(array_size); + if (!array) { + ERROR("Failed to allocate %zu bytes to sort stream entries", + array_size); + return WIMLIB_ERR_NOMEM; + } + cur = stream_list->next; + for (i = 0; i < num_streams; i++) { + array[i] = container_of(cur, struct wim_lookup_table_entry, extraction_list); + cur = cur->next; + } + + qsort(array, num_streams, sizeof(array[0]), cmp_streams_by_wim_position); + + INIT_LIST_HEAD(stream_list); + for (i = 0; i < num_streams; i++) + list_add_tail(&array[i]->extraction_list, stream_list); + FREE(array); + return 0; +} + +/* + * Extract a dentry to standard output. + * + * This obviously doesn't make sense in all cases. We return an error if the + * dentry does not correspond to a regular file. Otherwise we extract the + * unnamed data stream only. + */ +static int +extract_dentry_to_stdout(struct wim_dentry *dentry) +{ + int ret = 0; + if (!dentry_is_regular_file(dentry)) { + ERROR("\"%"TS"\" is not a regular file and therefore cannot be " + "extracted to standard output", dentry->_full_path); + ret = WIMLIB_ERR_NOT_A_REGULAR_FILE; + } else { + struct wim_lookup_table_entry *lte; + + lte = inode_unnamed_lte_resolved(dentry->d_inode); + if (lte) { + ret = extract_wim_resource_to_fd(lte, STDOUT_FILENO, + wim_resource_size(lte)); + } + } return ret; } -static int extract_single_image(WIMStruct *w, int image, - const char *target, int extract_flags, - wimlib_progress_func_t progress_func) +/* + * extract_tree - Extract a file or directory tree from the currently selected + * WIM image. + * + * @wim: WIMStruct for the WIM file, with the desired image selected + * (as wim->current_image). + * @wim_source_path: + * "Canonical" (i.e. no leading or trailing slashes, path + * separators forwald slashes) path inside the WIM image to + * extract. An empty string means the full image. + * @target: + * Filesystem path to extract the file or directory tree to. + * + * @extract_flags: + * WIMLIB_EXTRACT_FLAG_*. Also, the private flag + * WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being + * called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as + * the image. + * + * @progress_func: + * If non-NULL, progress function for the extraction. The messages + * we may in this function are: + * + * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or + * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN; + * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN; + * WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END; + * WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY; + * WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; + * WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS; + * WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or + * WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. + * + * Returns 0 on success; nonzero on failure. + */ +static int +extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target, + int extract_flags, wimlib_progress_func_t progress_func) { int ret; struct list_head stream_list; - struct hlist_head *inode_list; - struct apply_args args; const struct apply_operations *ops; + struct wim_dentry *root; - args.w = w; - args.target = target; - args.extract_flags = extract_flags; - args.num_lutimes_warnings = 0; - args.target = target; - args.stream_list = &stream_list; - args.progress_func = progress_func; + memset(&args, 0, sizeof(args)); + + args.w = wim; + args.target = target; + args.extract_flags = extract_flags; + args.progress_func = progress_func; + args.target_nchars = tstrlen(target); + args.wim_source_path_nchars = tstrlen(wim_source_path); if (progress_func) { - args.progress.extract.wimfile_name = w->filename; - args.progress.extract.image = image; + args.progress.extract.wimfile_name = wim->filename; + args.progress.extract.image = wim->current_image; args.progress.extract.extract_flags = (extract_flags & WIMLIB_EXTRACT_MASK_PUBLIC); - args.progress.extract.image_name = wimlib_get_image_name(w, image); + args.progress.extract.image_name = wimlib_get_image_name(wim, + wim->current_image); + args.progress.extract.extract_root_wim_source_path = wim_source_path; args.progress.extract.target = target; } @@ -592,31 +971,53 @@ static int extract_single_image(WIMStruct *w, int image, if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { args.vol = ntfs_mount(target, 0); if (!args.vol) { - ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s'", target); - return WIMLIB_ERR_NTFS_3G; + ERROR_WITH_ERRNO("Failed to mount NTFS volume `%"TS"'", + target); + ret = WIMLIB_ERR_NTFS_3G; + goto out; } ops = &ntfs_apply_operations; } else #endif ops = &normal_apply_operations; - ret = select_wim_image(w, image); - if (ret != 0) - goto out; + root = get_dentry(wim, wim_source_path); + if (!root) { + ERROR("Path \"%"TS"\" does not exist in WIM image %d", + wim_source_path, wim->current_image); + ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST; + goto out_ntfs_umount; + } + args.extract_root = root; - inode_list = &w->image_metadata[image - 1].inode_list; + ret = calculate_dentry_tree_full_paths(root); + if (ret) + goto out_ntfs_umount; - find_streams_for_extraction(inode_list, &stream_list, - w->lookup_table, extract_flags); + /* Build a list of the streams that need to be extracted */ + find_streams_for_extraction(root, + &stream_list, + wim->lookup_table, extract_flags); + + /* Calculate the number of bytes of data that will be extracted */ calculate_bytes_to_extract(&stream_list, extract_flags, &args.progress); + if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) { + ret = extract_dentry_to_stdout(root); + goto out_mark_inodes_unvisited; + } + if (progress_func) { - progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, + progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN : + WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, &args.progress); } + /* If a sequential extraction was specified, sort the streams to be + * extracted by their position in the WIM file, so that the WIM file can + * be read sequentially. */ if (extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) { ret = sort_stream_list_by_wim_position(&stream_list); if (ret != 0) { @@ -630,155 +1031,440 @@ static int extract_single_image(WIMStruct *w, int image, &args.progress); } + /* Make the directory structure and extract empty files */ args.extract_flags |= WIMLIB_EXTRACT_FLAG_NO_STREAMS; - ret = for_dentry_in_tree(wim_root_dentry(w), ops->apply_dentry, &args); + args.apply_dentry = ops->apply_dentry; + ret = for_dentry_in_tree(root, maybe_apply_dentry, &args); args.extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_STREAMS; - if (ret != 0) - goto out; + if (ret) + goto out_mark_inodes_unvisited; if (progress_func) { progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END, &args.progress); } + if (extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) { + args.target_realpath = realpath(target, NULL); + if (!args.target_realpath) { + ret = WIMLIB_ERR_NOMEM; + goto out_mark_inodes_unvisited; + } + args.target_realpath_len = tstrlen(args.target_realpath); + } + + /* Extract non-empty files */ ret = apply_stream_list(&stream_list, &args, ops, progress_func); - if (ret != 0) - goto out; + if (ret) + goto out_free_target_realpath; - if (progress_func) - progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS, NULL); + if (progress_func) { + progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS, + &args.progress); + } - ret = for_dentry_in_tree_depth(wim_root_dentry(w), + /* Apply timestamps */ + ret = for_dentry_in_tree_depth(root, ops->apply_dentry_timestamps, &args); - if (ret != 0) - goto out; + if (ret) + goto out_free_target_realpath; if (progress_func) { - progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END, + progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END : + WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END, &args.progress); } -out: +out_free_target_realpath: + FREE(args.target_realpath); +out_mark_inodes_unvisited: + for_dentry_in_tree(root, dentry_mark_inode_unvisited, NULL); +out_ntfs_umount: #ifdef WITH_NTFS_3G + /* Unmount the NTFS volume */ if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { if (ntfs_umount(args.vol, FALSE) != 0) { - ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'", args.target); + ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%"TS"'", + args.target); if (ret == 0) ret = WIMLIB_ERR_NTFS_3G; } } #endif +out: return ret; } +/* Validates a single wimlib_extract_command, mostly checking to make sure the + * extract flags make sense. */ +static int +check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags) +{ + int extract_flags; + bool is_entire_image = (cmd->wim_source_path[0] == T('\0')); + + /* Empty destination path? */ + if (cmd->fs_dest_path[0] == T('\0')) + return WIMLIB_ERR_INVALID_PARAM; + + extract_flags = cmd->extract_flags; + + /* Specified both symlink and hardlink modes? */ + if ((extract_flags & + (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK)) + return WIMLIB_ERR_INVALID_PARAM; + +#ifdef __WIN32__ + /* Wanted UNIX data on Win32? */ + if (extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) { + ERROR("Extracting UNIX data is not supported on Windows"); + return WIMLIB_ERR_INVALID_PARAM; + } + /* Wanted linked extraction on Windows? (XXX This is possible, just not + * implemented yet.) */ + if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK)) + { + ERROR("Linked extraction modes are not supported on Windows"); + return WIMLIB_ERR_INVALID_PARAM; + } +#endif + + if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { + /* NTFS-3g extraction mode requested */ +#ifdef WITH_NTFS_3G + if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK))) { + ERROR("Cannot specify symlink or hardlink flags when applying\n" + " directly to a NTFS volume"); + return WIMLIB_ERR_INVALID_PARAM; + } + if (!is_entire_image && + (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)) + { + ERROR("When applying directly to a NTFS volume you can " + "only extract a full image, not part of one"); + return WIMLIB_ERR_INVALID_PARAM; + } + if (extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) { + ERROR("Cannot restore UNIX-specific data in " + "the NTFS extraction mode"); + return WIMLIB_ERR_INVALID_PARAM; + } +#else + 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 + } + + if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX | + WIMLIB_EXTRACT_FLAG_NORPFIX)) == + (WIMLIB_EXTRACT_FLAG_RPFIX | WIMLIB_EXTRACT_FLAG_NORPFIX)) + { + ERROR("Cannot specify RPFIX and NORPFIX flags at the same time!"); + return WIMLIB_ERR_INVALID_PARAM; + } + + if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX | + WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0) + { + /* Do reparse point fixups by default if the WIM header says + * they are enabled and we are extracting a full image. */ + if ((wim_header_flags & WIM_HDR_FLAG_RP_FIX) && is_entire_image) + extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX; + } + + if (!is_entire_image && (extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)) { + ERROR("Cannot specify --rpfix when not extracting entire image"); + return WIMLIB_ERR_INVALID_PARAM; + } + + cmd->extract_flags = extract_flags; + return 0; +} + -/* 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, const char *target, - int extract_flags, - wimlib_progress_func_t progress_func) +/* Internal function to execute extraction commands for a WIM image. */ +static int +do_wimlib_extract_files(WIMStruct *wim, + int image, + struct wimlib_extract_command *cmds, + size_t num_cmds, + wimlib_progress_func_t progress_func) { - size_t image_name_max_len = max(xml_get_max_image_name_len(w), 20); - size_t output_path_len = strlen(target); - char buf[output_path_len + 1 + image_name_max_len + 1]; int ret; - int image; - const char *image_name; + bool found_link_cmd = false; + bool found_nolink_cmd = false; - ret = extract_directory(target, true); - if (ret != 0) + /* Select the image from which we are extracting files */ + ret = select_wim_image(wim, image); + if (ret) return ret; - memcpy(buf, target, 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 && *image_name) { - strcpy(buf + output_path_len + 1, image_name); + /* Make sure there are no streams in the WIM that have not been + * checksummed yet. */ + ret = wim_checksum_unhashed_streams(wim); + if (ret) + return ret; + + /* Check for problems with the extraction commands */ + for (size_t i = 0; i < num_cmds; i++) { + ret = check_extract_command(&cmds[i], wim->hdr.flags); + if (ret) + return ret; + if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK)) { + found_link_cmd = true; } else { - /* Image name is empty. Use image number instead */ - sprintf(buf + output_path_len + 1, "%d", image); + found_nolink_cmd = true; } - ret = extract_single_image(w, image, buf, extract_flags, - progress_func); - if (ret != 0) + if (found_link_cmd && found_nolink_cmd) { + ERROR("Symlink or hardlink extraction mode must " + "be set on all extraction commands"); + return WIMLIB_ERR_INVALID_PARAM; + } + } + + /* Execute the extraction commands */ + for (size_t i = 0; i < num_cmds; i++) { + ret = extract_tree(wim, + cmds[i].wim_source_path, + cmds[i].fs_dest_path, + cmds[i].extract_flags, + progress_func); + if (ret) return ret; } return 0; } -/* Extracts a single image or all images from a WIM file. */ -WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image, - const char *target, - int extract_flags, - WIMStruct **additional_swms, - unsigned num_additional_swms, - wimlib_progress_func_t progress_func) +/* Extract files or directories from a WIM image. */ +WIMLIBAPI int +wimlib_extract_files(WIMStruct *wim, + int image, + int default_extract_flags, + const struct wimlib_extract_command *cmds, + size_t num_cmds, + WIMStruct **additional_swms, + unsigned num_additional_swms, + wimlib_progress_func_t progress_func) { - struct lookup_table *joined_tab, *w_tab_save; int ret; + struct wimlib_extract_command *cmds_copy; + struct wim_lookup_table *wim_tab_save, *joined_tab; + int all_flags = 0; - if (!target) - return WIMLIB_ERR_INVALID_PARAM; + default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC; - extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC; + ret = verify_swm_set(wim, additional_swms, num_additional_swms); + if (ret) + goto out; - if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) - == (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) - return WIMLIB_ERR_INVALID_PARAM; + if (num_cmds == 0) + goto out; - if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) { -#ifdef WITH_NTFS_3G - if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))) { - ERROR("Cannot specify symlink or hardlink flags when applying\n" - " directly to a NTFS volume"); - return WIMLIB_ERR_INVALID_PARAM; + if (num_additional_swms) { + ret = new_joined_lookup_table(wim, additional_swms, + num_additional_swms, + &joined_tab); + if (ret) + goto out; + wim_tab_save = wim->lookup_table; + wim->lookup_table = joined_tab; + } + + cmds_copy = CALLOC(num_cmds, sizeof(cmds[0])); + if (!cmds_copy) { + ret = WIMLIB_ERR_NOMEM; + goto out_restore_lookup_table; + } + + for (size_t i = 0; i < num_cmds; i++) { + cmds_copy[i].extract_flags = (default_extract_flags | + cmds[i].extract_flags) + & WIMLIB_EXTRACT_MASK_PUBLIC; + all_flags |= cmds_copy[i].extract_flags; + + cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path); + if (!cmds_copy[i].wim_source_path) { + ret = WIMLIB_ERR_NOMEM; + goto out_free_cmds_copy; } - if (image == WIMLIB_ALL_IMAGES) { - ERROR("Can only apply a single image when applying " - "directly to a NTFS volume"); - return WIMLIB_ERR_INVALID_PARAM; + + cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path); + if (!cmds_copy[i].fs_dest_path) { + ret = WIMLIB_ERR_NOMEM; + goto out_free_cmds_copy; } + + } + ret = do_wimlib_extract_files(wim, image, + cmds_copy, num_cmds, + progress_func); + + if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | + WIMLIB_EXTRACT_FLAG_HARDLINK)) + { + for_lookup_table_entry(wim->lookup_table, + lte_free_extracted_file, NULL); + } +out_free_cmds_copy: + for (size_t i = 0; i < num_cmds; i++) { + FREE(cmds_copy[i].wim_source_path); + FREE(cmds_copy[i].fs_dest_path); + } + FREE(cmds_copy); +out_restore_lookup_table: + if (num_additional_swms) { + free_lookup_table(wim->lookup_table); + wim->lookup_table = wim_tab_save; + } +out: + return ret; +} + +/* + * Extracts an image from a WIM file. + * + * @wim: WIMStruct for the WIM file. + * + * @image: Number of the single image to extract. + * + * @target: Directory or NTFS volume to extract the image to. + * + * @extract_flags: Bitwise or of WIMLIB_EXTRACT_FLAG_*. + * + * @progress_func: If non-NULL, a progress function to be called + * periodically. + * + * Returns 0 on success; nonzero on failure. + */ +static int +extract_single_image(WIMStruct *wim, int image, + const tchar *target, int extract_flags, + wimlib_progress_func_t progress_func) +{ + int ret; + tchar *target_copy = canonicalize_fs_path(target); + if (!target_copy) + return WIMLIB_ERR_NOMEM; + struct wimlib_extract_command cmd = { + .wim_source_path = T(""), + .fs_dest_path = target_copy, + .extract_flags = extract_flags, + }; + ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func); + FREE(target_copy); + return ret; +} + +static const tchar * const filename_forbidden_chars = +T( +#ifdef __WIN32__ +"<>:\"/\\|?*" #else - 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 +); + +/* This function checks if it is okay to use a WIM image's name as a directory + * name. */ +static bool +image_name_ok_as_dir(const tchar *image_name) +{ + return image_name && *image_name && + !tstrpbrk(image_name, filename_forbidden_chars); +} + +/* Extracts all images from the WIM to the directory @target, with the images + * placed in subdirectories named by their image names. */ +static int +extract_all_images(WIMStruct *wim, + const tchar *target, + int extract_flags, + wimlib_progress_func_t progress_func) +{ + size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20); + size_t output_path_len = tstrlen(target); + tchar buf[output_path_len + 1 + image_name_max_len + 1]; + int ret; + int image; + const tchar *image_name; + + ret = extract_directory(NULL, target, true, 0); + if (ret) + return ret; + + tmemcpy(buf, target, output_path_len); + buf[output_path_len] = T('/'); + for (image = 1; image <= wim->hdr.image_count; image++) { + image_name = wimlib_get_image_name(wim, image); + if (image_name_ok_as_dir(image_name)) { + tstrcpy(buf + output_path_len + 1, image_name); + } else { + /* Image name is empty or contains forbidden characters. + * Use image number instead. */ + tsprintf(buf + output_path_len + 1, T("%d"), image); + } + ret = extract_single_image(wim, image, buf, extract_flags, + progress_func); + if (ret) + return ret; } + return 0; +} - ret = verify_swm_set(w, additional_swms, num_additional_swms); - if (ret != 0) +/* Extracts a single image or all images from a WIM file to a directory or NTFS + * volume. */ +WIMLIBAPI int +wimlib_extract_image(WIMStruct *wim, + int image, + const tchar *target, + int extract_flags, + WIMStruct **additional_swms, + unsigned num_additional_swms, + wimlib_progress_func_t progress_func) +{ + struct wim_lookup_table *joined_tab, *wim_tab_save; + int ret; + + extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC; + + ret = verify_swm_set(wim, additional_swms, num_additional_swms); + if (ret) return ret; if (num_additional_swms) { - ret = new_joined_lookup_table(w, additional_swms, + ret = new_joined_lookup_table(wim, additional_swms, num_additional_swms, &joined_tab); - if (ret != 0) + if (ret) return ret; - w_tab_save = w->lookup_table; - w->lookup_table = joined_tab; + wim_tab_save = wim->lookup_table; + wim->lookup_table = joined_tab; } if (image == WIMLIB_ALL_IMAGES) { extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE; - ret = extract_all_images(w, target, extract_flags, + ret = extract_all_images(wim, target, extract_flags, progress_func); } else { extract_flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE; - ret = extract_single_image(w, image, target, extract_flags, + ret = extract_single_image(wim, image, target, extract_flags, progress_func); } if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK)) { - for_lookup_table_entry(w->lookup_table, + for_lookup_table_entry(wim->lookup_table, lte_free_extracted_file, NULL); } - if (num_additional_swms) { - free_lookup_table(w->lookup_table); - w->lookup_table = w_tab_save; + free_lookup_table(wim->lookup_table); + wim->lookup_table = wim_tab_save; } return ret; }