wimlib.net Git - wimlib/blob - src/extract.c

   1 /*
   2  * extract.c
   3  *
   4  * Support for extracting WIM images, or files or directories contained in a WIM
   5  * image.
   6  */
   7
   8 /*
   9  * Copyright (C) 2012, 2013 Eric Biggers
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU General Public License as published by the Free
  15  * Software Foundation; either version 3 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include "config.h"
  29 #endif
  30
  31 #ifdef __WIN32__
  32 #  include "wimlib/win32_common.h" /* For GetFullPathName() */
  33 #endif
  34
  35 #include "wimlib/apply.h"
  36 #include "wimlib/dentry.h"
  37 #include "wimlib/encoding.h"
  38 #include "wimlib/endianness.h"
  39 #include "wimlib/error.h"
  40 #include "wimlib/lookup_table.h"
  41 #include "wimlib/paths.h"
  42 #include "wimlib/resource.h"
  43 #include "wimlib/swm.h"
  44 #ifdef __WIN32__
  45 #  include "wimlib/win32.h" /* for realpath() equivalent */
  46 #endif
  47 #include "wimlib/xml.h"
  48
  49 #include <errno.h>
  50 #include <limits.h>
  51 #ifdef WITH_NTFS_3G
  52 #  include <ntfs-3g/volume.h> /* for ntfs_mount(), ntfs_umount() */
  53 #endif
  54 #include <stdlib.h>
  55 #include <sys/stat.h>
  56 #include <unistd.h>
  57
  58 #define MAX_EXTRACT_LONG_PATH_WARNINGS 5
  59
  60 static int
  61 do_apply_op(struct wim_dentry *dentry, struct apply_args *args,
  62             int (*apply_dentry_func)(const tchar *, size_t,
  63                                      struct wim_dentry *, struct apply_args *))
  64 {
  65         tchar *p;
  66         size_t extraction_path_nchars;
  67         struct wim_dentry *d;
  68         LIST_HEAD(ancestor_list);
  69         const tchar *target;
  70         size_t target_nchars;
  71
  72 #ifdef __WIN32__
  73         if (args->target_lowlevel_path) {
  74                 target = args->target_lowlevel_path;
  75                 target_nchars = args->target_lowlevel_path_nchars;
  76         } else
  77 #endif
  78         {
  79                 target = args->target;
  80                 target_nchars = args->target_nchars;
  81         }
  82
  83         extraction_path_nchars = target_nchars;
  84
  85         for (d = dentry; d != args->extract_root; d = d->parent) {
  86                 if (d->not_extracted)
  87                         return 0;
  88                 extraction_path_nchars += d->extraction_name_nchars + 1;
  89                 list_add(&d->tmp_list, &ancestor_list);
  90         }
  91
  92         tchar extraction_path[extraction_path_nchars + 1];
  93         p = tmempcpy(extraction_path, target, target_nchars);
  94
  95
  96         list_for_each_entry(d, &ancestor_list, tmp_list) {
  97                 *p++ = OS_PREFERRED_PATH_SEPARATOR;
  98                 p = tmempcpy(p, d->extraction_name, d->extraction_name_nchars);
  99         }
 100         *p = T('\0');
 101
 102 #ifdef __WIN32__
 103         /* Warn the user if the path exceeds MAX_PATH */
 104
 105         /* + 1 for '\0', -4 for \\?\.  */
 106         if (extraction_path_nchars + 1 - 4 > MAX_PATH) {
 107                 if (dentry->needs_extraction &&
 108                     args->num_long_paths < MAX_EXTRACT_LONG_PATH_WARNINGS)
 109                 {
 110                         WARNING("Path \"%ls\" exceeds MAX_PATH and will not be accessible "
 111                                 "to most Windows software", extraction_path);
 112                         if (++args->num_long_paths == MAX_EXTRACT_LONG_PATH_WARNINGS)
 113                                 WARNING("Suppressing further warnings about long paths");
 114                 }
 115         }
 116 #endif
 117         return (*apply_dentry_func)(extraction_path, extraction_path_nchars,
 118                                     dentry, args);
 119 }
 120
 121
 122 /* Extracts a file, directory, or symbolic link from the WIM archive. */
 123 static int
 124 apply_dentry_normal(struct wim_dentry *dentry, void *arg)
 125 {
 126 #ifdef __WIN32__
 127         return do_apply_op(dentry, arg, win32_do_apply_dentry);
 128 #else
 129         return do_apply_op(dentry, arg, unix_do_apply_dentry);
 130 #endif
 131 }
 132
 133
 134 /* Apply timestamps to an extracted file or directory */
 135 static int
 136 apply_dentry_timestamps_normal(struct wim_dentry *dentry, void *arg)
 137 {
 138 #ifdef __WIN32__
 139         return do_apply_op(dentry, arg, win32_do_apply_dentry_timestamps);
 140 #else
 141         return do_apply_op(dentry, arg, unix_do_apply_dentry_timestamps);
 142 #endif
 143 }
 144
 145 static bool
 146 dentry_is_dot_or_dotdot(const struct wim_dentry *dentry)
 147 {
 148         const utf16lechar *file_name = dentry->file_name;
 149         return file_name != NULL &&
 150                 file_name[0] == cpu_to_le16('.') &&
 151                 (file_name[1] == cpu_to_le16('\0') ||
 152                  (file_name[1] == cpu_to_le16('.') &&
 153                   file_name[2] == cpu_to_le16('\0')));
 154 }
 155
 156 /* Extract a dentry if it hasn't already been extracted and either
 157  * WIMLIB_EXTRACT_FLAG_NO_STREAMS is not specified, or the dentry is a directory
 158  * and/or has no unnamed stream. */
 159 static int
 160 maybe_apply_dentry(struct wim_dentry *dentry, void *arg)
 161 {
 162         struct apply_args *args = arg;
 163         int ret;
 164
 165         if (!dentry->needs_extraction)
 166                 return 0;
 167
 168         if (args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_STREAMS &&
 169             !dentry_is_directory(dentry) &&
 170             inode_unnamed_lte_resolved(dentry->d_inode) != NULL)
 171                 return 0;
 172
 173         if ((args->extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) &&
 174              args->progress_func) {
 175                 ret = calculate_dentry_full_path(dentry);
 176                 if (ret)
 177                         return ret;
 178                 args->progress.extract.cur_path = dentry->_full_path;
 179                 args->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
 180                                     &args->progress);
 181         }
 182         ret = args->apply_dentry(dentry, args);
 183         if (ret == 0)
 184                 dentry->needs_extraction = 0;
 185         return ret;
 186 }
 187
 188 static void
 189 calculate_bytes_to_extract(struct list_head *stream_list,
 190                            int extract_flags,
 191                            union wimlib_progress_info *progress)
 192 {
 193         struct wim_lookup_table_entry *lte;
 194         u64 total_bytes = 0;
 195         u64 num_streams = 0;
 196
 197         /* For each stream to be extracted... */
 198         list_for_each_entry(lte, stream_list, extraction_list) {
 199                 if (extract_flags &
 200                     (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
 201                 {
 202                         /* In the symlink or hard link extraction mode, each
 203                          * stream will be extracted one time regardless of how
 204                          * many dentries share the stream. */
 205                         wimlib_assert(!(extract_flags & WIMLIB_EXTRACT_FLAG_NTFS));
 206                         if (!lte->extracted_file) {
 207                                 num_streams++;
 208                                 total_bytes += wim_resource_size(lte);
 209                         }
 210                 } else {
 211                         num_streams += lte->out_refcnt;
 212                         total_bytes += lte->out_refcnt * wim_resource_size(lte);
 213                 }
 214         }
 215         progress->extract.num_streams = num_streams;
 216         progress->extract.total_bytes = total_bytes;
 217         progress->extract.completed_bytes = 0;
 218 }
 219
 220 static void
 221 maybe_add_stream_for_extraction(struct wim_lookup_table_entry *lte,
 222                                 struct list_head *stream_list)
 223 {
 224         if (++lte->out_refcnt == 1) {
 225                 INIT_LIST_HEAD(&lte->lte_dentry_list);
 226                 list_add_tail(&lte->extraction_list, stream_list);
 227         }
 228 }
 229
 230 struct find_streams_ctx {
 231         struct list_head stream_list;
 232         int extract_flags;
 233 };
 234
 235 static int
 236 dentry_find_streams_to_extract(struct wim_dentry *dentry, void *_ctx)
 237 {
 238         struct find_streams_ctx *ctx = _ctx;
 239         struct wim_inode *inode = dentry->d_inode;
 240         struct wim_lookup_table_entry *lte;
 241         bool dentry_added = false;
 242         struct list_head *stream_list = &ctx->stream_list;
 243         int extract_flags = ctx->extract_flags;
 244
 245         if (!dentry->needs_extraction)
 246                 return 0;
 247
 248         lte = inode_unnamed_lte_resolved(inode);
 249         if (lte) {
 250                 if (!inode->i_visited)
 251                         maybe_add_stream_for_extraction(lte, stream_list);
 252                 list_add_tail(&dentry->extraction_stream_list, &lte->lte_dentry_list);
 253                 dentry_added = true;
 254         }
 255
 256         /* Determine whether to include alternate data stream entries or not.
 257          *
 258          * UNIX:  Include them if extracting using NTFS-3g.
 259          *
 260          * Windows: Include them undconditionally, although if the filesystem is
 261          * not NTFS we won't actually be able to extract them. */
 262 #if defined(WITH_NTFS_3G)
 263         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
 264 #elif defined(__WIN32__)
 265         if (1)
 266 #else
 267         if (0)
 268 #endif
 269         {
 270                 for (unsigned i = 0; i < inode->i_num_ads; i++) {
 271                         if (inode->i_ads_entries[i].stream_name_nbytes != 0) {
 272                                 lte = inode->i_ads_entries[i].lte;
 273                                 if (lte) {
 274                                         if (!inode->i_visited) {
 275                                                 maybe_add_stream_for_extraction(lte,
 276                                                                                 stream_list);
 277                                         }
 278                                         if (!dentry_added) {
 279                                                 list_add_tail(&dentry->extraction_stream_list,
 280                                                               &lte->lte_dentry_list);
 281                                                 dentry_added = true;
 282                                         }
 283                                 }
 284                         }
 285                 }
 286         }
 287         inode->i_visited = 1;
 288         return 0;
 289 }
 290
 291 static int
 292 dentry_resolve_and_zero_lte_refcnt(struct wim_dentry *dentry, void *_lookup_table)
 293 {
 294         struct wim_inode *inode = dentry->d_inode;
 295         struct wim_lookup_table *lookup_table = _lookup_table;
 296         struct wim_lookup_table_entry *lte;
 297         int ret;
 298
 299         ret = inode_resolve_ltes(inode, lookup_table);
 300         if (ret)
 301                 return ret;
 302         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
 303                 lte = inode_stream_lte_resolved(inode, i);
 304                 if (lte)
 305                         lte->out_refcnt = 0;
 306         }
 307         return 0;
 308 }
 309
 310 static int
 311 find_streams_for_extraction(struct wim_dentry *root,
 312                             struct list_head *stream_list,
 313                             struct wim_lookup_table *lookup_table,
 314                             int extract_flags)
 315 {
 316         struct find_streams_ctx ctx;
 317         int ret;
 318
 319         INIT_LIST_HEAD(&ctx.stream_list);
 320         ctx.extract_flags = extract_flags;
 321         ret = for_dentry_in_tree(root, dentry_resolve_and_zero_lte_refcnt, lookup_table);
 322         if (ret)
 323                 return ret;
 324         for_dentry_in_tree(root, dentry_find_streams_to_extract, &ctx);
 325         list_transfer(&ctx.stream_list, stream_list);
 326         return 0;
 327 }
 328
 329 struct apply_operations {
 330         int (*apply_dentry)(struct wim_dentry *dentry, void *arg);
 331         int (*apply_dentry_timestamps)(struct wim_dentry *dentry, void *arg);
 332 };
 333
 334 static const struct apply_operations normal_apply_operations = {
 335         .apply_dentry = apply_dentry_normal,
 336         .apply_dentry_timestamps = apply_dentry_timestamps_normal,
 337 };
 338
 339 #ifdef WITH_NTFS_3G
 340 static const struct apply_operations ntfs_apply_operations = {
 341         .apply_dentry = apply_dentry_ntfs,
 342         .apply_dentry_timestamps = apply_dentry_timestamps_ntfs,
 343 };
 344 #endif
 345
 346 static int
 347 apply_stream_list(struct list_head *stream_list,
 348                   struct apply_args *args,
 349                   const struct apply_operations *ops,
 350                   wimlib_progress_func_t progress_func)
 351 {
 352         uint64_t bytes_per_progress = args->progress.extract.total_bytes / 100;
 353         uint64_t next_progress = bytes_per_progress;
 354         struct wim_lookup_table_entry *lte;
 355         struct wim_dentry *dentry;
 356         int ret;
 357
 358         /* This complicated loop is essentially looping through the dentries,
 359          * although dentries may be visited more than once (if a dentry contains
 360          * two different nonempty streams) or not at all (if a dentry contains
 361          * no non-empty streams).
 362          *
 363          * The outer loop is over the distinct streams to be extracted so that
 364          * sequential reading of the WIM can be implemented. */
 365
 366         /* For each distinct stream to be extracted */
 367         list_for_each_entry(lte, stream_list, extraction_list) {
 368                 /* For each dentry to be extracted that is a name for an inode
 369                  * containing the stream */
 370                 list_for_each_entry(dentry, &lte->lte_dentry_list, extraction_stream_list) {
 371                         /* Extract the dentry if it was not already
 372                          * extracted */
 373                         ret = maybe_apply_dentry(dentry, args);
 374                         if (ret)
 375                                 return ret;
 376                         if (progress_func &&
 377                             args->progress.extract.completed_bytes >= next_progress)
 378                         {
 379                                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
 380                                               &args->progress);
 381                                 if (args->progress.extract.completed_bytes >=
 382                                     args->progress.extract.total_bytes)
 383                                 {
 384                                         next_progress = ~0ULL;
 385                                 } else {
 386                                         next_progress =
 387                                                 min (args->progress.extract.completed_bytes +
 388                                                      bytes_per_progress,
 389                                                      args->progress.extract.total_bytes);
 390                                 }
 391                         }
 392                 }
 393         }
 394         return 0;
 395 }
 396
 397 static int
 398 sort_stream_list_by_wim_position(struct list_head *stream_list)
 399 {
 400         struct list_head *cur;
 401         size_t num_streams;
 402         struct wim_lookup_table_entry **array;
 403         size_t i;
 404         size_t array_size;
 405
 406         num_streams = 0;
 407         list_for_each(cur, stream_list)
 408                 num_streams++;
 409         array_size = num_streams * sizeof(array[0]);
 410         array = MALLOC(array_size);
 411         if (!array) {
 412                 ERROR("Failed to allocate %zu bytes to sort stream entries",
 413                       array_size);
 414                 return WIMLIB_ERR_NOMEM;
 415         }
 416         cur = stream_list->next;
 417         for (i = 0; i < num_streams; i++) {
 418                 array[i] = container_of(cur, struct wim_lookup_table_entry, extraction_list);
 419                 cur = cur->next;
 420         }
 421
 422         qsort(array, num_streams, sizeof(array[0]), cmp_streams_by_wim_position);
 423
 424         INIT_LIST_HEAD(stream_list);
 425         for (i = 0; i < num_streams; i++)
 426                 list_add_tail(&array[i]->extraction_list, stream_list);
 427         FREE(array);
 428         return 0;
 429 }
 430
 431 /*
 432  * Extract a dentry to standard output.
 433  *
 434  * This obviously doesn't make sense in all cases.  We return an error if the
 435  * dentry does not correspond to a regular file.  Otherwise we extract the
 436  * unnamed data stream only.
 437  */
 438 static int
 439 extract_dentry_to_stdout(struct wim_dentry *dentry)
 440 {
 441         int ret = 0;
 442         if (!dentry_is_regular_file(dentry)) {
 443                 ERROR("\"%"TS"\" is not a regular file and therefore cannot be "
 444                       "extracted to standard output", dentry->_full_path);
 445                 ret = WIMLIB_ERR_NOT_A_REGULAR_FILE;
 446         } else {
 447                 struct wim_lookup_table_entry *lte;
 448
 449                 lte = inode_unnamed_lte_resolved(dentry->d_inode);
 450                 if (lte) {
 451                         ret = extract_wim_resource_to_fd(lte, STDOUT_FILENO,
 452                                                          wim_resource_size(lte));
 453                 }
 454         }
 455         return ret;
 456 }
 457
 458 #ifdef __WIN32__
 459 static const utf16lechar replacement_char = cpu_to_le16(0xfffd);
 460 #else
 461 static const utf16lechar replacement_char = cpu_to_le16('?');
 462 #endif
 463
 464 static bool
 465 file_name_valid(utf16lechar *name, size_t num_chars, bool fix)
 466 {
 467         size_t i;
 468
 469         if (num_chars == 0)
 470                 return true;
 471         for (i = 0; i < num_chars; i++) {
 472                 switch (name[i]) {
 473         #ifdef __WIN32__
 474                 case cpu_to_le16('\\'):
 475                 case cpu_to_le16(':'):
 476                 case cpu_to_le16('*'):
 477                 case cpu_to_le16('?'):
 478                 case cpu_to_le16('"'):
 479                 case cpu_to_le16('<'):
 480                 case cpu_to_le16('>'):
 481                 case cpu_to_le16('|'):
 482         #endif
 483                 case cpu_to_le16('/'):
 484                 case cpu_to_le16('\0'):
 485                         if (fix)
 486                                 name[i] = replacement_char;
 487                         else
 488                                 return false;
 489                 }
 490         }
 491
 492 #ifdef __WIN32__
 493         if (name[num_chars - 1] == cpu_to_le16(' ') ||
 494             name[num_chars - 1] == cpu_to_le16('.'))
 495         {
 496                 if (fix)
 497                         name[num_chars - 1] = replacement_char;
 498                 else
 499                         return false;
 500         }
 501 #endif
 502         return true;
 503 }
 504
 505 /*
 506  * dentry_calculate_extraction_path-
 507  *
 508  * Calculate the actual filename component at which a WIM dentry will be
 509  * extracted, handling invalid filenames "properly".
 510  *
 511  * dentry->extraction_name usually will be set the same as dentry->file_name (on
 512  * UNIX, converted into the platform's multibyte encoding).  However, if the
 513  * file name contains characters that are not valid on the current platform or
 514  * has some other format that is not valid, leave dentry->extraction_name as
 515  * NULL and clear dentry->needs_extraction to indicate that this dentry should
 516  * not be extracted, unless the appropriate flag
 517  * WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES is set in the extract flags, in
 518  * which case a substitute filename will be created and set instead.
 519  *
 520  * Conflicts with case-insensitive names on Windows are handled similarly; see
 521  * below.
 522  */
 523 static int
 524 dentry_calculate_extraction_path(struct wim_dentry *dentry, void *_args)
 525 {
 526         struct apply_args *args = _args;
 527         int ret;
 528
 529         dentry->needs_extraction = 1;
 530
 531         if (dentry == args->extract_root)
 532                 return 0;
 533
 534         if (dentry_is_dot_or_dotdot(dentry)) {
 535                 /* WIM files shouldn't contain . or .. entries.  But if they are
 536                  * there, don't attempt to extract them. */
 537                 WARNING("Skipping extraction of unexpected . or .. file \"%"TS"\"",
 538                         dentry_full_path(dentry));
 539                 goto skip_dentry;
 540         }
 541
 542 #ifdef __WIN32__
 543         struct wim_dentry *other;
 544         list_for_each_entry(other, &dentry->case_insensitive_conflict_list,
 545                             case_insensitive_conflict_list)
 546         {
 547                 if (other->needs_extraction) {
 548                         if (args->extract_flags & WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS)
 549                         {
 550                                 WARNING("\"%"TS"\" has the same case-insensitive "
 551                                         "name as \"%"TS"\"; extracting dummy name instead",
 552                                         dentry_full_path(dentry),
 553                                         dentry_full_path(other));
 554                                 goto out_replace;
 555                         } else {
 556                                 WARNING("Not extracting \"%"TS"\": has same case-insensitive "
 557                                         "name as \"%"TS"\"",
 558                                         dentry_full_path(dentry),
 559                                         dentry_full_path(other));
 560                                 goto skip_dentry;
 561                         }
 562                 }
 563         }
 564 #endif
 565
 566         if (file_name_valid(dentry->file_name, dentry->file_name_nbytes / 2, false)) {
 567 #ifdef __WIN32__
 568                 dentry->extraction_name = dentry->file_name;
 569                 dentry->extraction_name_nchars = dentry->file_name_nbytes / 2;
 570                 return 0;
 571 #else
 572                 return utf16le_to_tstr(dentry->file_name,
 573                                        dentry->file_name_nbytes,
 574                                        &dentry->extraction_name,
 575                                        &dentry->extraction_name_nchars);
 576 #endif
 577         } else {
 578                 if (args->extract_flags & WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES)
 579                 {
 580                         WARNING("\"%"TS"\" has an invalid filename "
 581                                 "that is not supported on this platform; "
 582                                 "extracting dummy name instead",
 583                                 dentry_full_path(dentry));
 584                         goto out_replace;
 585                 } else {
 586                         WARNING("Not extracting \"%"TS"\": has an invalid filename "
 587                                 "that is not supported on this platform",
 588                                 dentry_full_path(dentry));
 589                         goto skip_dentry;
 590                 }
 591         }
 592
 593 out_replace:
 594         {
 595                 utf16lechar utf16_name_copy[dentry->file_name_nbytes / 2];
 596
 597                 memcpy(utf16_name_copy, dentry->file_name, dentry->file_name_nbytes);
 598                 file_name_valid(utf16_name_copy, dentry->file_name_nbytes / 2, true);
 599
 600                 tchar *tchar_name;
 601                 size_t tchar_nchars;
 602         #ifdef __WIN32__
 603                 tchar_name = utf16_name_copy;
 604                 tchar_nchars = dentry->file_name_nbytes / 2;
 605         #else
 606                 ret = utf16le_to_tstr(utf16_name_copy,
 607                                       dentry->file_name_nbytes,
 608                                       &tchar_name, &tchar_nchars);
 609                 if (ret)
 610                         return ret;
 611         #endif
 612                 size_t fixed_name_num_chars = tchar_nchars;
 613                 tchar fixed_name[tchar_nchars + 50];
 614
 615                 tmemcpy(fixed_name, tchar_name, tchar_nchars);
 616                 fixed_name_num_chars += tsprintf(fixed_name + tchar_nchars,
 617                                                  T(" (invalid filename #%lu)"),
 618                                                  ++args->invalid_sequence);
 619         #ifndef __WIN32__
 620                 FREE(tchar_name);
 621         #endif
 622                 dentry->extraction_name = memdup(fixed_name, 2 * fixed_name_num_chars + 2);
 623                 if (!dentry->extraction_name)
 624                         return WIMLIB_ERR_NOMEM;
 625                 dentry->extraction_name_nchars = fixed_name_num_chars;
 626         }
 627         return 0;
 628 skip_dentry:
 629         dentry->needs_extraction = 0;
 630         dentry->not_extracted = 1;
 631         return 0;
 632 }
 633
 634 static int
 635 dentry_reset_needs_extraction(struct wim_dentry *dentry, void *_ignore)
 636 {
 637         struct wim_inode *inode = dentry->d_inode;
 638
 639         dentry->needs_extraction = 0;
 640         dentry->not_extracted = 0;
 641         inode->i_visited = 0;
 642         inode->i_dos_name_extracted = 0;
 643         FREE(inode->i_extracted_file);
 644         inode->i_extracted_file = NULL;
 645         if ((void*)dentry->extraction_name != (void*)dentry->file_name)
 646                 FREE(dentry->extraction_name);
 647         dentry->extraction_name = NULL;
 648         return 0;
 649 }
 650
 651 #define WINDOWS_NT_MAX_PATH 32768
 652
 653 /*
 654  * extract_tree - Extract a file or directory tree from the currently selected
 655  *                WIM image.
 656  *
 657  * @wim:        WIMStruct for the WIM file, with the desired image selected
 658  *              (as wim->current_image).
 659  * @wim_source_path:
 660  *              "Canonical" (i.e. no leading or trailing slashes, path
 661  *              separators forwald slashes) path inside the WIM image to
 662  *              extract.  An empty string means the full image.
 663  * @target:
 664  *              Filesystem path to extract the file or directory tree to.
 665  *
 666  * @extract_flags:
 667  *              WIMLIB_EXTRACT_FLAG_*.  Also, the private flag
 668  *              WIMLIB_EXTRACT_FLAG_MULTI_IMAGE will be set if this is being
 669  *              called through wimlib_extract_image() with WIMLIB_ALL_IMAGES as
 670  *              the image.
 671  *
 672  * @progress_func:
 673  *              If non-NULL, progress function for the extraction.  The messages
 674  *              we may in this function are:
 675  *
 676  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN or
 677  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN;
 678  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN;
 679  *              WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END;
 680  *              WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY;
 681  *              WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS;
 682  *              WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS;
 683  *              WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END or
 684  *                      WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
 685  *
 686  * Returns 0 on success; nonzero on failure.
 687  */
 688 static int
 689 extract_tree(WIMStruct *wim, const tchar *wim_source_path, const tchar *target,
 690              int extract_flags, wimlib_progress_func_t progress_func)
 691 {
 692         int ret;
 693         struct list_head stream_list;
 694         struct apply_args args;
 695         const struct apply_operations *ops;
 696         struct wim_dentry *root;
 697
 698         memset(&args, 0, sizeof(args));
 699
 700
 701         args.w                      = wim;
 702         args.target                 = target;
 703         args.target_nchars          = tstrlen(target);
 704         args.extract_flags          = extract_flags;
 705         args.progress_func          = progress_func;
 706
 707 #ifdef __WIN32__
 708         /* Work around defective behavior in Windows where paths longer than 260
 709          * characters are not supported by default; instead they need to be
 710          * turned into absolute paths and prefixed with "\\?\".  */
 711         args.target_lowlevel_path = MALLOC(WINDOWS_NT_MAX_PATH * sizeof(wchar_t));
 712         if (!args.target_lowlevel_path)
 713         {
 714                 ret = WIMLIB_ERR_NOMEM;
 715                 goto out;
 716         }
 717         args.target_lowlevel_path_nchars =
 718                 GetFullPathName(args.target, WINDOWS_NT_MAX_PATH - 4,
 719                                 &args.target_lowlevel_path[4], NULL);
 720
 721         if (args.target_lowlevel_path_nchars == 0 ||
 722             args.target_lowlevel_path_nchars >= WINDOWS_NT_MAX_PATH - 4)
 723         {
 724                 WARNING("Can't get full path name for \"%ls\"", args.target);
 725                 FREE(args.target_lowlevel_path);
 726                 args.target_lowlevel_path = NULL;
 727         } else {
 728                 wmemcpy(args.target_lowlevel_path, L"\\\\?\\", 4);
 729                 args.target_lowlevel_path_nchars += 4;
 730         }
 731 #endif
 732
 733         if (progress_func) {
 734                 args.progress.extract.wimfile_name = wim->filename;
 735                 args.progress.extract.image = wim->current_image;
 736                 args.progress.extract.extract_flags = (extract_flags &
 737                                                        WIMLIB_EXTRACT_MASK_PUBLIC);
 738                 args.progress.extract.image_name = wimlib_get_image_name(wim,
 739                                                                          wim->current_image);
 740                 args.progress.extract.extract_root_wim_source_path = wim_source_path;
 741                 args.progress.extract.target = target;
 742         }
 743
 744 #ifdef WITH_NTFS_3G
 745         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
 746                 args.vol = ntfs_mount(target, 0);
 747                 if (!args.vol) {
 748                         ERROR_WITH_ERRNO("Failed to mount NTFS volume `%"TS"'",
 749                                          target);
 750                         ret = WIMLIB_ERR_NTFS_3G;
 751                         goto out_free_target_lowlevel_path;
 752                 }
 753                 ops = &ntfs_apply_operations;
 754         } else
 755 #endif
 756                 ops = &normal_apply_operations;
 757
 758         root = get_dentry(wim, wim_source_path);
 759         if (!root) {
 760                 ERROR("Path \"%"TS"\" does not exist in WIM image %d",
 761                       wim_source_path, wim->current_image);
 762                 ret = WIMLIB_ERR_PATH_DOES_NOT_EXIST;
 763                 goto out_ntfs_umount;
 764         }
 765         args.extract_root = root;
 766
 767         /* Calculate the actual filename component of each extracted dentry, and
 768          * in the process set the dentry->needs_extraction flag on dentries that
 769          * will be extracted. */
 770         ret = for_dentry_in_tree(root, dentry_calculate_extraction_path, &args);
 771         if (ret)
 772                 goto out_dentry_reset_needs_extraction;
 773
 774         /* Build a list of the streams that need to be extracted */
 775         ret = find_streams_for_extraction(root,
 776                                           &stream_list,
 777                                           wim->lookup_table, extract_flags);
 778         if (ret)
 779                 goto out_dentry_reset_needs_extraction;
 780
 781         /* Calculate the number of bytes of data that will be extracted */
 782         calculate_bytes_to_extract(&stream_list, extract_flags,
 783                                    &args.progress);
 784
 785         if (extract_flags & WIMLIB_EXTRACT_FLAG_TO_STDOUT) {
 786                 ret = extract_dentry_to_stdout(root);
 787                 goto out_dentry_reset_needs_extraction;
 788         }
 789
 790         if (progress_func) {
 791                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN :
 792                               WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
 793                               &args.progress);
 794         }
 795
 796         /* If a sequential extraction was specified, sort the streams to be
 797          * extracted by their position in the WIM file, so that the WIM file can
 798          * be read sequentially. */
 799         if (extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
 800                 ret = sort_stream_list_by_wim_position(&stream_list);
 801                 if (ret != 0) {
 802                         WARNING("Falling back to non-sequential extraction");
 803                         extract_flags &= ~WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
 804                 }
 805         }
 806
 807         if (progress_func) {
 808                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
 809                               &args.progress);
 810         }
 811
 812         /* Make the directory structure and extract empty files */
 813         args.extract_flags |= WIMLIB_EXTRACT_FLAG_NO_STREAMS;
 814         args.apply_dentry = ops->apply_dentry;
 815         ret = for_dentry_in_tree(root, maybe_apply_dentry, &args);
 816         args.extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_STREAMS;
 817         if (ret)
 818                 goto out_dentry_reset_needs_extraction;
 819
 820         if (progress_func) {
 821                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
 822                               &args.progress);
 823         }
 824
 825         if (extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX) {
 826                 args.target_realpath = realpath(target, NULL);
 827                 if (!args.target_realpath) {
 828                         ret = WIMLIB_ERR_NOMEM;
 829                         goto out_dentry_reset_needs_extraction;
 830                 }
 831                 args.target_realpath_len = tstrlen(args.target_realpath);
 832         }
 833
 834         /* Extract non-empty files */
 835         ret = apply_stream_list(&stream_list, &args, ops, progress_func);
 836         if (ret)
 837                 goto out_free_target_realpath;
 838
 839         if (progress_func) {
 840                 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
 841                               &args.progress);
 842         }
 843
 844         /* Apply timestamps */
 845         ret = for_dentry_in_tree_depth(root,
 846                                        ops->apply_dentry_timestamps, &args);
 847         if (ret)
 848                 goto out_free_target_realpath;
 849
 850         if (progress_func) {
 851                 progress_func(*wim_source_path ? WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END :
 852                               WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
 853                               &args.progress);
 854         }
 855 out_free_target_realpath:
 856         FREE(args.target_realpath);
 857 out_dentry_reset_needs_extraction:
 858         for_dentry_in_tree(root, dentry_reset_needs_extraction, NULL);
 859 out_ntfs_umount:
 860 #ifdef WITH_NTFS_3G
 861         /* Unmount the NTFS volume */
 862         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
 863                 if (ntfs_umount(args.vol, FALSE) != 0) {
 864                         ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%"TS"'",
 865                                          args.target);
 866                         if (ret == 0)
 867                                 ret = WIMLIB_ERR_NTFS_3G;
 868                 }
 869         }
 870 #endif
 871 out_free_target_lowlevel_path:
 872 #ifdef __WIN32__
 873         FREE(args.target_lowlevel_path);
 874 #endif
 875 out:
 876         return ret;
 877 }
 878
 879 /* Validates a single wimlib_extract_command, mostly checking to make sure the
 880  * extract flags make sense. */
 881 static int
 882 check_extract_command(struct wimlib_extract_command *cmd, int wim_header_flags)
 883 {
 884         int extract_flags;
 885         bool is_entire_image = (cmd->wim_source_path[0] == T('\0'));
 886
 887         /* Empty destination path? */
 888         if (cmd->fs_dest_path[0] == T('\0'))
 889                 return WIMLIB_ERR_INVALID_PARAM;
 890
 891         extract_flags = cmd->extract_flags;
 892
 893         /* Specified both symlink and hardlink modes? */
 894         if ((extract_flags &
 895              (WIMLIB_EXTRACT_FLAG_SYMLINK |
 896               WIMLIB_EXTRACT_FLAG_HARDLINK)) == (WIMLIB_EXTRACT_FLAG_SYMLINK |
 897                                                  WIMLIB_EXTRACT_FLAG_HARDLINK))
 898                 return WIMLIB_ERR_INVALID_PARAM;
 899
 900 #ifdef __WIN32__
 901         /* Wanted UNIX data on Windows? */
 902         if (extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) {
 903                 ERROR("Extracting UNIX data is not supported on Windows");
 904                 return WIMLIB_ERR_INVALID_PARAM;
 905         }
 906         /* Wanted linked extraction on Windows?  (XXX This is possible, just not
 907          * implemented yet.) */
 908         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
 909                              WIMLIB_EXTRACT_FLAG_HARDLINK))
 910         {
 911                 ERROR("Linked extraction modes are not supported on Windows");
 912                 return WIMLIB_ERR_INVALID_PARAM;
 913         }
 914 #endif
 915
 916         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
 917                 /* NTFS-3g extraction mode requested */
 918 #ifdef WITH_NTFS_3G
 919                 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
 920                                       WIMLIB_EXTRACT_FLAG_HARDLINK))) {
 921                         ERROR("Cannot specify symlink or hardlink flags when applying\n"
 922                               "        directly to a NTFS volume");
 923                         return WIMLIB_ERR_INVALID_PARAM;
 924                 }
 925                 if (!is_entire_image &&
 926                     (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS))
 927                 {
 928                         ERROR("When applying directly to a NTFS volume you can "
 929                               "only extract a full image, not part of one");
 930                         return WIMLIB_ERR_INVALID_PARAM;
 931                 }
 932                 if (extract_flags & WIMLIB_EXTRACT_FLAG_UNIX_DATA) {
 933                         ERROR("Cannot restore UNIX-specific data in "
 934                               "the NTFS extraction mode");
 935                         return WIMLIB_ERR_INVALID_PARAM;
 936                 }
 937 #else
 938                 ERROR("wimlib was compiled without support for NTFS-3g, so");
 939                 ERROR("we cannot apply a WIM image directly to a NTFS volume");
 940                 return WIMLIB_ERR_UNSUPPORTED;
 941 #endif
 942         }
 943
 944         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
 945                               WIMLIB_EXTRACT_FLAG_NORPFIX)) ==
 946                 (WIMLIB_EXTRACT_FLAG_RPFIX | WIMLIB_EXTRACT_FLAG_NORPFIX))
 947         {
 948                 ERROR("Cannot specify RPFIX and NORPFIX flags at the same time!");
 949                 return WIMLIB_ERR_INVALID_PARAM;
 950         }
 951
 952         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_RPFIX |
 953                               WIMLIB_EXTRACT_FLAG_NORPFIX)) == 0)
 954         {
 955                 /* Do reparse point fixups by default if the WIM header says
 956                  * they are enabled and we are extracting a full image. */
 957                 if ((wim_header_flags & WIM_HDR_FLAG_RP_FIX) && is_entire_image)
 958                         extract_flags |= WIMLIB_EXTRACT_FLAG_RPFIX;
 959         }
 960
 961         if (!is_entire_image && (extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)) {
 962                 ERROR("Cannot specify --rpfix when not extracting entire image");
 963                 return WIMLIB_ERR_INVALID_PARAM;
 964         }
 965
 966         cmd->extract_flags = extract_flags;
 967         return 0;
 968 }
 969
 970
 971 /* Internal function to execute extraction commands for a WIM image. */
 972 static int
 973 do_wimlib_extract_files(WIMStruct *wim,
 974                         int image,
 975                         struct wimlib_extract_command *cmds,
 976                         size_t num_cmds,
 977                         wimlib_progress_func_t progress_func)
 978 {
 979         int ret;
 980         bool found_link_cmd = false;
 981         bool found_nolink_cmd = false;
 982
 983         /* Select the image from which we are extracting files */
 984         ret = select_wim_image(wim, image);
 985         if (ret)
 986                 return ret;
 987
 988         /* Make sure there are no streams in the WIM that have not been
 989          * checksummed yet. */
 990         ret = wim_checksum_unhashed_streams(wim);
 991         if (ret)
 992                 return ret;
 993
 994         /* Check for problems with the extraction commands */
 995         for (size_t i = 0; i < num_cmds; i++) {
 996                 ret = check_extract_command(&cmds[i], wim->hdr.flags);
 997                 if (ret)
 998                         return ret;
 999                 if (cmds[i].extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
1000                                              WIMLIB_EXTRACT_FLAG_HARDLINK)) {
1001                         found_link_cmd = true;
1002                 } else {
1003                         found_nolink_cmd = true;
1004                 }
1005                 if (found_link_cmd && found_nolink_cmd) {
1006                         ERROR("Symlink or hardlink extraction mode must "
1007                               "be set on all extraction commands");
1008                         return WIMLIB_ERR_INVALID_PARAM;
1009                 }
1010         }
1011
1012         /* Execute the extraction commands */
1013         for (size_t i = 0; i < num_cmds; i++) {
1014                 ret = extract_tree(wim,
1015                                    cmds[i].wim_source_path,
1016                                    cmds[i].fs_dest_path,
1017                                    cmds[i].extract_flags,
1018                                    progress_func);
1019                 if (ret)
1020                         return ret;
1021         }
1022         return 0;
1023 }
1024
1025 /* Extract files or directories from a WIM image. */
1026 WIMLIBAPI int
1027 wimlib_extract_files(WIMStruct *wim,
1028                      int image,
1029                      const struct wimlib_extract_command *cmds,
1030                      size_t num_cmds,
1031                      int default_extract_flags,
1032                      WIMStruct **additional_swms,
1033                      unsigned num_additional_swms,
1034                      wimlib_progress_func_t progress_func)
1035 {
1036         int ret;
1037         struct wimlib_extract_command *cmds_copy;
1038         int all_flags = 0;
1039
1040         default_extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
1041
1042         ret = verify_swm_set(wim, additional_swms, num_additional_swms);
1043         if (ret)
1044                 goto out;
1045
1046         if (num_cmds == 0)
1047                 goto out;
1048
1049         if (num_additional_swms)
1050                 merge_lookup_tables(wim, additional_swms, num_additional_swms);
1051
1052         cmds_copy = CALLOC(num_cmds, sizeof(cmds[0]));
1053         if (!cmds_copy) {
1054                 ret = WIMLIB_ERR_NOMEM;
1055                 goto out_restore_lookup_table;
1056         }
1057
1058         for (size_t i = 0; i < num_cmds; i++) {
1059                 cmds_copy[i].extract_flags = (default_extract_flags |
1060                                                  cmds[i].extract_flags)
1061                                                 & WIMLIB_EXTRACT_MASK_PUBLIC;
1062                 all_flags |= cmds_copy[i].extract_flags;
1063
1064                 cmds_copy[i].wim_source_path = canonicalize_wim_path(cmds[i].wim_source_path);
1065                 if (!cmds_copy[i].wim_source_path) {
1066                         ret = WIMLIB_ERR_NOMEM;
1067                         goto out_free_cmds_copy;
1068                 }
1069
1070                 cmds_copy[i].fs_dest_path = canonicalize_fs_path(cmds[i].fs_dest_path);
1071                 if (!cmds_copy[i].fs_dest_path) {
1072                         ret = WIMLIB_ERR_NOMEM;
1073                         goto out_free_cmds_copy;
1074                 }
1075
1076         }
1077         ret = do_wimlib_extract_files(wim, image,
1078                                       cmds_copy, num_cmds,
1079                                       progress_func);
1080
1081         if (all_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
1082                          WIMLIB_EXTRACT_FLAG_HARDLINK))
1083         {
1084                 for_lookup_table_entry(wim->lookup_table,
1085                                        lte_free_extracted_file, NULL);
1086         }
1087 out_free_cmds_copy:
1088         for (size_t i = 0; i < num_cmds; i++) {
1089                 FREE(cmds_copy[i].wim_source_path);
1090                 FREE(cmds_copy[i].fs_dest_path);
1091         }
1092         FREE(cmds_copy);
1093 out_restore_lookup_table:
1094         if (num_additional_swms)
1095                 unmerge_lookup_table(wim);
1096 out:
1097         return ret;
1098 }
1099
1100 /*
1101  * Extracts an image from a WIM file.
1102  *
1103  * @wim:                WIMStruct for the WIM file.
1104  *
1105  * @image:              Number of the single image to extract.
1106  *
1107  * @target:             Directory or NTFS volume to extract the image to.
1108  *
1109  * @extract_flags:      Bitwise or of WIMLIB_EXTRACT_FLAG_*.
1110  *
1111  * @progress_func:      If non-NULL, a progress function to be called
1112  *                      periodically.
1113  *
1114  * Returns 0 on success; nonzero on failure.
1115  */
1116 static int
1117 extract_single_image(WIMStruct *wim, int image,
1118                      const tchar *target, int extract_flags,
1119                      wimlib_progress_func_t progress_func)
1120 {
1121         int ret;
1122         tchar *target_copy = canonicalize_fs_path(target);
1123         if (!target_copy)
1124                 return WIMLIB_ERR_NOMEM;
1125         struct wimlib_extract_command cmd = {
1126                 .wim_source_path = T(""),
1127                 .fs_dest_path = target_copy,
1128                 .extract_flags = extract_flags,
1129         };
1130         ret = do_wimlib_extract_files(wim, image, &cmd, 1, progress_func);
1131         FREE(target_copy);
1132         return ret;
1133 }
1134
1135 static const tchar * const filename_forbidden_chars =
1136 T(
1137 #ifdef __WIN32__
1138 "<>:\"/\\|?*"
1139 #else
1140 "/"
1141 #endif
1142 );
1143
1144 /* This function checks if it is okay to use a WIM image's name as a directory
1145  * name.  */
1146 static bool
1147 image_name_ok_as_dir(const tchar *image_name)
1148 {
1149         return image_name && *image_name &&
1150                 !tstrpbrk(image_name, filename_forbidden_chars) &&
1151                 tstrcmp(image_name, T(".")) &&
1152                 tstrcmp(image_name, T(".."));
1153 }
1154
1155 /* Extracts all images from the WIM to the directory @target, with the images
1156  * placed in subdirectories named by their image names. */
1157 static int
1158 extract_all_images(WIMStruct *wim,
1159                    const tchar *target,
1160                    int extract_flags,
1161                    wimlib_progress_func_t progress_func)
1162 {
1163         size_t image_name_max_len = max(xml_get_max_image_name_len(wim), 20);
1164         size_t output_path_len = tstrlen(target);
1165         tchar buf[output_path_len + 1 + image_name_max_len + 1];
1166         int ret;
1167         int image;
1168         const tchar *image_name;
1169         struct stat stbuf;
1170
1171         if (tstat(target, &stbuf)) {
1172                 if (errno == ENOENT)
1173                 {
1174                         if (tmkdir(target, S_IRWXU | S_IRGRP | S_IXGRP |
1175                                            S_IROTH | S_IXOTH))
1176                         {
1177                                 ERROR_WITH_ERRNO("Failed to create directory \"%"TS"\"", target);
1178                                 return WIMLIB_ERR_MKDIR;
1179                         }
1180                 } else {
1181                         ERROR_WITH_ERRNO("Failed to stat \"%"TS"\"", target);
1182                         return WIMLIB_ERR_STAT;
1183                 }
1184         } else if (!S_ISDIR(stbuf.st_mode)) {
1185                 ERROR("\"%"TS"\" is not a directory", target);
1186                 return WIMLIB_ERR_NOTDIR;
1187         }
1188
1189         tmemcpy(buf, target, output_path_len);
1190         buf[output_path_len] = OS_PREFERRED_PATH_SEPARATOR;
1191         for (image = 1; image <= wim->hdr.image_count; image++) {
1192                 image_name = wimlib_get_image_name(wim, image);
1193                 if (image_name_ok_as_dir(image_name)) {
1194                         tstrcpy(buf + output_path_len + 1, image_name);
1195                 } else {
1196                         /* Image name is empty or contains forbidden characters.
1197                          * Use image number instead. */
1198                         tsprintf(buf + output_path_len + 1, T("%d"), image);
1199                 }
1200                 ret = extract_single_image(wim, image, buf, extract_flags,
1201                                            progress_func);
1202                 if (ret)
1203                         return ret;
1204         }
1205         return 0;
1206 }
1207
1208 /* Extracts a single image or all images from a WIM file to a directory or NTFS
1209  * volume. */
1210 WIMLIBAPI int
1211 wimlib_extract_image(WIMStruct *wim,
1212                      int image,
1213                      const tchar *target,
1214                      int extract_flags,
1215                      WIMStruct **additional_swms,
1216                      unsigned num_additional_swms,
1217                      wimlib_progress_func_t progress_func)
1218 {
1219         int ret;
1220
1221         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
1222
1223         ret = verify_swm_set(wim, additional_swms, num_additional_swms);
1224         if (ret)
1225                 return ret;
1226
1227         if (num_additional_swms)
1228                 merge_lookup_tables(wim, additional_swms, num_additional_swms);
1229
1230         if (image == WIMLIB_ALL_IMAGES) {
1231                 ret = extract_all_images(wim, target,
1232                                          extract_flags | WIMLIB_EXTRACT_FLAG_MULTI_IMAGE,
1233                                          progress_func);
1234         } else {
1235                 ret = extract_single_image(wim, image, target, extract_flags,
1236                                            progress_func);
1237         }
1238
1239         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
1240                              WIMLIB_EXTRACT_FLAG_HARDLINK))
1241         {
1242                 for_lookup_table_entry(wim->lookup_table,
1243                                        lte_free_extracted_file,
1244                                        NULL);
1245         }
1246         if (num_additional_swms)
1247                 unmerge_lookup_table(wim);
1248         return ret;
1249 }