Move VERBOSE flags to progress callbacks
[wimlib] / src / extract.c
1 /*
2  * extract.c
3  *
4  * Support for extracting WIM files.
5  *
6  * This code does NOT contain any filesystem-specific features.  In particular,
7  * security information (i.e. file permissions) and alternate data streams are
8  * ignored, except possibly to read an alternate data stream that contains
9  * symbolic link data.
10  */
11
12 /*
13  * Copyright (C) 2010 Carl Thijssen
14  * Copyright (C) 2012 Eric Biggers
15  *
16  * This file is part of wimlib, a library for working with WIM files.
17  *
18  * wimlib is free software; you can redistribute it and/or modify it under the
19  * terms of the GNU General Public License as published by the Free
20  * Software Foundation; either version 3 of the License, or (at your option)
21  * any later version.
22  *
23  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
24  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
25  * A PARTICULAR PURPOSE. See the GNU General Public License for more
26  * details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with wimlib; if not, see http://www.gnu.org/licenses/.
30  */
31
32
33 #include "config.h"
34
35 #include <dirent.h>
36 #include <errno.h>
37 #include <fcntl.h>
38 #include <string.h>
39 #include <sys/stat.h>
40 #include <stdlib.h>
41 #include <sys/time.h>
42
43 #ifdef HAVE_UTIME_H
44 #include <utime.h>
45 #endif
46
47
48 #include <unistd.h>
49
50 #include "dentry.h"
51 #include "lookup_table.h"
52 #include "timestamp.h"
53 #include "wimlib_internal.h"
54 #include "xml.h"
55
56 #ifdef WITH_NTFS_3G
57 #include <ntfs-3g/volume.h>
58 #endif
59
60 static int extract_regular_file_linked(struct dentry *dentry,
61                                        const char *output_path,
62                                        struct apply_args *args,
63                                        struct lookup_table_entry *lte)
64 {
65         /* This mode overrides the normal hard-link extraction and
66          * instead either symlinks or hardlinks *all* identical files in
67          * the WIM, even if they are in a different image (in the case
68          * of a multi-image extraction) */
69
70         if (args->extract_flags & WIMLIB_EXTRACT_FLAG_HARDLINK) {
71                 if (link(lte->extracted_file, output_path) != 0) {
72                         ERROR_WITH_ERRNO("Failed to hard link "
73                                          "`%s' to `%s'",
74                                          output_path, lte->extracted_file);
75                         return WIMLIB_ERR_LINK;
76                 }
77         } else {
78                 int num_path_components;
79                 int num_output_dir_path_components;
80                 size_t extracted_file_len;
81                 char *p;
82                 const char *p2;
83                 size_t i;
84
85                 num_path_components =
86                         get_num_path_components(dentry->full_path_utf8) - 1;
87                 num_output_dir_path_components =
88                         get_num_path_components(args->target);
89
90                 if (args->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE) {
91                         num_path_components++;
92                         num_output_dir_path_components--;
93                 }
94                 extracted_file_len = strlen(lte->extracted_file);
95
96                 char buf[extracted_file_len + 3 * num_path_components + 1];
97                 p = &buf[0];
98
99                 for (i = 0; i < num_path_components; i++) {
100                         *p++ = '.';
101                         *p++ = '.';
102                         *p++ = '/';
103                 }
104                 p2 = lte->extracted_file;
105                 while (*p2 == '/')
106                         p2++;
107                 while (num_output_dir_path_components--)
108                         p2 = path_next_part(p2, NULL);
109                 strcpy(p, p2);
110                 if (symlink(buf, output_path) != 0) {
111                         ERROR_WITH_ERRNO("Failed to symlink `%s' to "
112                                          "`%s'",
113                                          buf, lte->extracted_file);
114                         return WIMLIB_ERR_LINK;
115                 }
116         }
117         return 0;
118 }
119
120 static int extract_regular_file_unlinked(struct dentry *dentry,
121                                          struct apply_args *args,
122                                          const char *output_path,
123                                          struct lookup_table_entry *lte)
124 {
125         /* Normal mode of extraction.  Regular files and hard links are
126          * extracted in the way that they appear in the WIM. */
127
128         int out_fd;
129         int ret;
130         struct inode *inode = dentry->d_inode;
131
132         if (!((args->extract_flags & WIMLIB_EXTRACT_FLAG_MULTI_IMAGE)
133                 && (args->extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
134                                      WIMLIB_EXTRACT_FLAG_HARDLINK))))
135         {
136                 /* If the dentry is one of a hard link set of at least 2
137                  * dentries and one of the other dentries has already been
138                  * extracted, make a hard link to the file corresponding to this
139                  * already-extracted directory.  Otherwise, extract the file,
140                  * and set the inode->extracted_file field so that other
141                  * dentries in the hard link group can link to it. */
142                 if (inode->link_count > 1) {
143                         if (inode->extracted_file) {
144                                 DEBUG("Extracting hard link `%s' => `%s'",
145                                       output_path, inode->extracted_file);
146                                 if (link(inode->extracted_file, output_path) != 0) {
147                                         ERROR_WITH_ERRNO("Failed to hard link "
148                                                          "`%s' to `%s'",
149                                                          output_path,
150                                                          inode->extracted_file);
151                                         return WIMLIB_ERR_LINK;
152                                 }
153                                 return 0;
154                         }
155                         FREE(inode->extracted_file);
156                         inode->extracted_file = STRDUP(output_path);
157                         if (!inode->extracted_file) {
158                                 ERROR("Failed to allocate memory for filename");
159                                 return WIMLIB_ERR_NOMEM;
160                         }
161                 }
162         }
163
164         /* Extract the contents of the file to @output_path. */
165
166         out_fd = open(output_path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
167         if (out_fd == -1) {
168                 ERROR_WITH_ERRNO("Failed to open the file `%s' for writing",
169                                  output_path);
170                 return WIMLIB_ERR_OPEN;
171         }
172
173         if (!lte) {
174                 /* Empty file with no lookup table entry */
175                 DEBUG("Empty file `%s'.", output_path);
176                 ret = 0;
177                 goto out;
178         }
179
180         ret = extract_full_wim_resource_to_fd(lte, out_fd);
181         if (ret != 0) {
182                 ERROR("Failed to extract resource to `%s'", output_path);
183                 goto out;
184         }
185         args->progress.extract.completed_bytes += wim_resource_size(lte);
186 out:
187         if (close(out_fd) != 0) {
188                 ERROR_WITH_ERRNO("Failed to close file `%s'", output_path);
189                 ret = WIMLIB_ERR_WRITE;
190         }
191         return ret;
192 }
193
194 /*
195  * Extracts a regular file from the WIM archive.
196  */
197 static int extract_regular_file(struct dentry *dentry,
198                                 struct apply_args *args,
199                                 const char *output_path)
200 {
201         struct lookup_table_entry *lte;
202         const struct inode *inode = dentry->d_inode;
203
204         lte = inode_unnamed_lte_resolved(inode);
205
206         if (lte && (args->extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
207                                            WIMLIB_EXTRACT_FLAG_HARDLINK)))
208         {
209                 if (lte->extracted_file) {
210                         return extract_regular_file_linked(dentry, output_path, args, lte);
211                 } else {
212                         lte->extracted_file = STRDUP(output_path);
213                         if (!lte->extracted_file)
214                                 return WIMLIB_ERR_NOMEM;
215                 }
216         }
217         return extract_regular_file_unlinked(dentry, args, output_path, lte);
218 }
219
220 static int extract_symlink(struct dentry *dentry,
221                            struct apply_args *args,
222                            const char *output_path)
223 {
224         char target[4096];
225         ssize_t ret = inode_readlink(dentry->d_inode, target,
226                                      sizeof(target), args->w, 0);
227         struct lookup_table_entry *lte;
228
229         if (ret <= 0) {
230                 ERROR("Could not read the symbolic link from dentry `%s'",
231                       dentry->full_path_utf8);
232                 return WIMLIB_ERR_INVALID_DENTRY;
233         }
234         ret = symlink(target, output_path);
235         if (ret != 0) {
236                 ERROR_WITH_ERRNO("Failed to symlink `%s' to `%s'",
237                                  output_path, target);
238                 return WIMLIB_ERR_LINK;
239         }
240         lte = inode_unnamed_lte_resolved(dentry->d_inode);
241         args->progress.extract.completed_bytes += wim_resource_size(lte);
242         return 0;
243 }
244
245 /*
246  * Extracts a directory from the WIM archive.
247  *
248  * @dentry:             The directory entry for the directory.
249  * @output_path:        The path to which the directory is to be extracted to.
250  * @return:             True on success, false on failure.
251  */
252 static int extract_directory(const char *output_path, bool is_root)
253 {
254         int ret;
255         struct stat stbuf;
256         ret = stat(output_path, &stbuf);
257         if (ret == 0) {
258                 if (S_ISDIR(stbuf.st_mode)) {
259                         /*if (!is_root)*/
260                                 /*WARNING("`%s' already exists", output_path);*/
261                         return 0;
262                 } else {
263                         ERROR("`%s' is not a directory", output_path);
264                         return WIMLIB_ERR_MKDIR;
265                 }
266         } else {
267                 if (errno != ENOENT) {
268                         ERROR_WITH_ERRNO("Failed to stat `%s'", output_path);
269                         return WIMLIB_ERR_STAT;
270                 }
271         }
272         /* Compute the output path directory to the directory. */
273         if (mkdir(output_path, S_IRWXU | S_IRGRP | S_IXGRP |
274                                S_IROTH | S_IXOTH) != 0) {
275                 ERROR_WITH_ERRNO("Cannot create directory `%s'",
276                                  output_path);
277                 return WIMLIB_ERR_MKDIR;
278         }
279         return 0;
280 }
281
282 /*
283  * Extracts a file, directory, or symbolic link from the WIM archive.  For use
284  * in for_dentry_in_tree().
285  */
286 static int apply_dentry_normal(struct dentry *dentry, void *arg)
287 {
288         struct apply_args *args = arg;
289         int extract_flags = args->extract_flags;
290         struct inode *inode = dentry->d_inode;
291         size_t len;
292         int ret;
293
294         if (dentry->is_extracted)
295                 return 0;
296
297         if (extract_flags & WIMLIB_EXTRACT_FLAG_NO_STREAMS)
298                 if (inode_unnamed_lte_resolved(inode))
299                         return 0;
300
301         if ((extract_flags & WIMLIB_EXTRACT_FLAG_VERBOSE) &&
302              args->progress_func)
303         {
304                 args->progress.extract.cur_path = dentry->full_path_utf8;
305                 args->progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
306                                     &args->progress);
307         }
308
309         len = strlen(args->target);
310         char output_path[len + dentry->full_path_utf8_len + 1];
311         memcpy(output_path, args->target, len);
312         memcpy(output_path + len, dentry->full_path_utf8, dentry->full_path_utf8_len);
313         output_path[len + dentry->full_path_utf8_len] = '\0';
314
315         if (inode_is_symlink(inode))
316                 ret = extract_symlink(dentry, args, output_path);
317         else if (inode_is_directory(inode))
318                 ret = extract_directory(output_path, false);
319         else
320                 ret = extract_regular_file(dentry, args, output_path);
321         if (ret == 0)
322                 dentry->is_extracted = 1;
323         return ret;
324 }
325
326 /* Apply timestamp to extracted file */
327 static int apply_dentry_timestamps_normal(struct dentry *dentry, void *arg)
328 {
329         struct apply_args *args = arg;
330         size_t len = strlen(args->target);
331         char output_path[len + dentry->full_path_utf8_len + 1];
332         const struct inode *inode = dentry->d_inode;
333         int ret;
334
335         memcpy(output_path, args->target, len);
336         memcpy(output_path + len, dentry->full_path_utf8, dentry->full_path_utf8_len);
337         output_path[len + dentry->full_path_utf8_len] = '\0';
338
339         struct timeval tv[2];
340         wim_timestamp_to_timeval(inode->last_access_time, &tv[0]);
341         wim_timestamp_to_timeval(inode->last_write_time, &tv[1]);
342         #ifdef HAVE_LUTIMES
343         ret = lutimes(output_path, tv);
344         #else
345         ret = -1;
346         errno = ENOSYS;
347         #endif
348         if (ret != 0) {
349                 #ifdef HAVE_UTIME
350                 if (errno == ENOSYS) {
351                         struct utimbuf buf;
352                         buf.actime = wim_timestamp_to_unix(inode->last_access_time);
353                         buf.modtime = wim_timestamp_to_unix(inode->last_write_time);
354                         if (utime(output_path, &buf) == 0)
355                                 return 0;
356                 }
357                 #endif
358                 if (errno != ENOSYS || args->num_lutimes_warnings < 10) {
359                         /*WARNING("Failed to set timestamp on file `%s': %s",*/
360                                 /*output_path, strerror(errno));*/
361                         args->num_lutimes_warnings++;
362                 }
363         }
364         return 0;
365 }
366
367 static int cmp_streams_by_wim_position(const void *p1, const void *p2)
368 {
369         const struct lookup_table_entry *lte1, *lte2;
370         lte1 = *(const struct lookup_table_entry**)p1;
371         lte2 = *(const struct lookup_table_entry**)p2;
372         if (lte1->resource_entry.offset < lte2->resource_entry.offset)
373                 return -1;
374         else if (lte1->resource_entry.offset > lte2->resource_entry.offset)
375                 return 1;
376         else
377                 return 0;
378 }
379
380 static int sort_stream_list_by_wim_position(struct list_head *stream_list)
381 {
382         struct list_head *cur;
383         size_t num_streams;
384         struct lookup_table_entry **array;
385         size_t i;
386         size_t array_size;
387
388         num_streams = 0;
389         list_for_each(cur, stream_list)
390                 num_streams++;
391         array_size = num_streams * sizeof(array[0]);
392         array = MALLOC(array_size);
393         if (!array) {
394                 ERROR("Failed to allocate %zu bytes to sort stream entries",
395                       array_size);
396                 return WIMLIB_ERR_NOMEM;
397         }
398         cur = stream_list->next;
399         for (i = 0; i < num_streams; i++) {
400                 array[i] = container_of(cur, struct lookup_table_entry, staging_list);
401                 cur = cur->next;
402         }
403
404         qsort(array, num_streams, sizeof(array[0]), cmp_streams_by_wim_position);
405
406         INIT_LIST_HEAD(stream_list);
407         for (i = 0; i < num_streams; i++)
408                 list_add_tail(&array[i]->staging_list, stream_list);
409         FREE(array);
410         return 0;
411 }
412
413 static void calculate_bytes_to_extract(struct list_head *stream_list,
414                                        int extract_flags,
415                                        union wimlib_progress_info *progress)
416 {
417         struct lookup_table_entry *lte;
418         struct inode *inode;
419         u64 total_bytes = 0;
420         u64 num_streams = 0;
421
422         /* For each stream to be extracted... */
423         list_for_each_entry(lte, stream_list, staging_list) {
424                 if (extract_flags &
425                     (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
426                 {
427                         /* In the symlink or hard link extraction mode, each
428                          * stream will be extracted one time regardless of how
429                          * many dentries share the stream. */
430                         wimlib_assert(!(extract_flags & WIMLIB_EXTRACT_FLAG_NTFS));
431                         if (!lte->extracted_file) {
432                                 num_streams++;
433                                 total_bytes += wim_resource_size(lte);
434                         }
435                 } else {
436                         list_for_each_entry(inode, &lte->inode_list,
437                                             lte_inode_list)
438                         {
439                                 num_streams++;
440                                 total_bytes += wim_resource_size(lte);
441                         }
442                 }
443         }
444         progress->extract.num_streams = num_streams;
445         progress->extract.total_bytes = total_bytes;
446         progress->extract.completed_bytes = 0;
447 }
448
449 static void maybe_add_stream_for_extraction(struct lookup_table_entry *lte,
450                                             struct list_head *stream_list)
451 {
452         if (lte->out_refcnt == 0) {
453                 lte->out_refcnt = 1;
454                 INIT_LIST_HEAD(&lte->inode_list);
455                 list_add_tail(&lte->staging_list, stream_list);
456         }
457 }
458
459 static void inode_find_streams_for_extraction(struct inode *inode,
460                                               struct list_head *stream_list,
461                                               int extract_flags)
462 {
463         struct lookup_table_entry *lte;
464         bool inode_added = false;
465
466         lte = inode_unnamed_lte_resolved(inode);
467
468         if (lte) {
469                 maybe_add_stream_for_extraction(lte, stream_list);
470                 list_add_tail(&inode->lte_inode_list, &lte->inode_list);
471                 inode_added = true;
472         }
473 #ifdef WITH_NTFS_3G
474         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
475                 for (unsigned i = 0; i < inode->num_ads; i++) {
476                         if (inode->ads_entries[i].stream_name_len != 0) {
477                                 lte = inode_stream_lte_resolved(inode, i + 1);
478                                 if (lte) {
479                                         maybe_add_stream_for_extraction(lte,
480                                                                         stream_list);
481                                         if (!inode_added) {
482                                                 list_add_tail(&inode->lte_inode_list,
483                                                               &lte->inode_list);
484                                                 inode_added = true;
485                                         }
486                                 }
487                         }
488                 }
489         }
490 #endif
491 }
492
493 static void find_streams_for_extraction(struct hlist_head *inode_list,
494                                         struct list_head *stream_list,
495                                         struct lookup_table *lookup_table,
496                                         int extract_flags)
497 {
498         struct inode *inode;
499         struct hlist_node *cur;
500         struct dentry *dentry;
501
502         for_lookup_table_entry(lookup_table, lte_zero_out_refcnt, NULL);
503         INIT_LIST_HEAD(stream_list);
504         hlist_for_each_entry(inode, cur, inode_list, hlist) {
505                 if (!inode->resolved)
506                         inode_resolve_ltes(inode, lookup_table);
507                 inode_for_each_dentry(dentry, inode)
508                         dentry->is_extracted = 0;
509                 inode_find_streams_for_extraction(inode, stream_list,
510                                                   extract_flags);
511         }
512 }
513
514 struct apply_operations {
515         int (*apply_dentry)(struct dentry *dentry, void *arg);
516         int (*apply_dentry_timestamps)(struct dentry *dentry, void *arg);
517 };
518
519 static const struct apply_operations normal_apply_operations = {
520         .apply_dentry = apply_dentry_normal,
521         .apply_dentry_timestamps = apply_dentry_timestamps_normal,
522 };
523
524 #ifdef WITH_NTFS_3G
525 static const struct apply_operations ntfs_apply_operations = {
526         .apply_dentry = wim_apply_dentry_ntfs,
527         .apply_dentry_timestamps = wim_apply_dentry_timestamps,
528 };
529 #endif
530
531 static int apply_stream_list(struct list_head *stream_list,
532                              struct apply_args *args,
533                              const struct apply_operations *ops,
534                              wimlib_progress_func_t progress_func)
535 {
536         uint64_t bytes_per_progress = args->progress.extract.total_bytes / 100;
537         uint64_t next_progress = bytes_per_progress;
538         struct lookup_table_entry *lte;
539         struct inode *inode;
540         struct dentry *dentry;
541         int ret = 0;
542         list_for_each_entry(lte, stream_list, staging_list) {
543                 list_for_each_entry(inode, &lte->inode_list, lte_inode_list) {
544                         inode_for_each_dentry(dentry, inode) {
545                                 ret = ops->apply_dentry(dentry, args);
546                                 if (ret != 0)
547                                         goto out;
548                                 if (args->progress.extract.completed_bytes >= next_progress) {
549                                         progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
550                                                       &args->progress);
551                                         next_progress += bytes_per_progress;
552                                 }
553                         }
554                 }
555         }
556 out:
557         return ret;
558 }
559
560 static int extract_single_image(WIMStruct *w, int image,
561                                 const char *target, int extract_flags,
562                                 wimlib_progress_func_t progress_func)
563 {
564         int ret;
565         struct list_head stream_list;
566         struct hlist_head *inode_list;
567
568         struct apply_args args;
569         const struct apply_operations *ops;
570
571         args.w                    = w;
572         args.target               = target;
573         args.extract_flags        = extract_flags;
574         args.num_lutimes_warnings = 0;
575         args.target               = target;
576         args.stream_list          = &stream_list;
577         args.progress_func        = progress_func;
578
579         if (progress_func) {
580                 args.progress.extract.image      = image;
581                 args.progress.extract.image_name = wimlib_get_image_name(w, image);
582                 args.progress.extract.target     = target;
583         }
584
585 #ifdef WITH_NTFS_3G
586         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
587                 args.vol = ntfs_mount(target, 0);
588                 if (!args.vol) {
589                         ERROR_WITH_ERRNO("Failed to mount NTFS volume `%s'", target);
590                         return WIMLIB_ERR_NTFS_3G;
591                 }
592         }
593 #endif
594
595 #ifdef WITH_NTFS_3G
596         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS)
597                 ops = &ntfs_apply_operations;
598         else
599 #endif
600                 ops = &normal_apply_operations;
601
602         ret = select_wim_image(w, image);
603         if (ret != 0)
604                 goto out;
605
606         inode_list = &w->image_metadata[image - 1].inode_list;
607         find_streams_for_extraction(inode_list,
608                                     &stream_list,
609                                     w->lookup_table,
610                                     extract_flags);
611
612         calculate_bytes_to_extract(&stream_list, extract_flags,
613                                    &args.progress);
614
615         if (progress_func) {
616                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
617                               &args.progress);
618         }
619
620         if (extract_flags & WIMLIB_EXTRACT_FLAG_SEQUENTIAL) {
621                 ret = sort_stream_list_by_wim_position(&stream_list);
622                 if (ret != 0) {
623                         WARNING("Falling back to non-sequential extraction");
624                         extract_flags &= ~WIMLIB_EXTRACT_FLAG_SEQUENTIAL;
625                 }
626         }
627
628         if (progress_func) {
629                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
630                               &args.progress);
631         }
632
633
634         args.extract_flags |= WIMLIB_EXTRACT_FLAG_NO_STREAMS;
635         ret = for_dentry_in_tree(wim_root_dentry(w), ops->apply_dentry, &args);
636         args.extract_flags &= ~WIMLIB_EXTRACT_FLAG_NO_STREAMS;
637         if (ret != 0)
638                 goto out;
639
640         if (progress_func) {
641                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
642                               &args.progress);
643         }
644
645         ret = apply_stream_list(&stream_list, &args, ops, progress_func);
646         if (ret != 0)
647                 goto out;
648
649         if (progress_func)
650                 progress_func(WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS, NULL);
651
652         ret = for_dentry_in_tree_depth(wim_root_dentry(w),
653                                        ops->apply_dentry_timestamps, &args);
654         if (ret != 0)
655                 goto out;
656
657         if (progress_func) {
658                 progress_func(WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
659                               &args.progress);
660         }
661 out:
662 #ifdef WITH_NTFS_3G
663         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
664                 if (ntfs_umount(args.vol, FALSE) != 0) {
665                         ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'", args.target);
666                         if (ret == 0)
667                                 ret = WIMLIB_ERR_NTFS_3G;
668                 }
669         }
670 #endif
671         return ret;
672 }
673
674
675 /* Extracts all images from the WIM to @output_dir, with the images placed in
676  * subdirectories named by their image names. */
677 static int extract_all_images(WIMStruct *w, const char *target,
678                               int extract_flags,
679                               wimlib_progress_func_t progress_func)
680 {
681         size_t image_name_max_len = max(xml_get_max_image_name_len(w), 20);
682         size_t output_path_len = strlen(target);
683         char buf[output_path_len + 1 + image_name_max_len + 1];
684         int ret;
685         int image;
686         const char *image_name;
687
688         ret = extract_directory(target, true);
689         if (ret != 0)
690                 return ret;
691
692         memcpy(buf, target, output_path_len);
693         buf[output_path_len] = '/';
694         for (image = 1; image <= w->hdr.image_count; image++) {
695                 image_name = wimlib_get_image_name(w, image);
696                 if (image_name && *image_name) {
697                         strcpy(buf + output_path_len + 1, image_name);
698                 } else {
699                         /* Image name is empty. Use image number instead */
700                         sprintf(buf + output_path_len + 1, "%d", image);
701                 }
702                 ret = extract_single_image(w, image, buf, extract_flags,
703                                            progress_func);
704                 if (ret != 0)
705                         return ret;
706         }
707         return 0;
708 }
709
710 /* Extracts a single image or all images from a WIM file. */
711 WIMLIBAPI int wimlib_extract_image(WIMStruct *w, int image,
712                                    const char *target,
713                                    int extract_flags,
714                                    WIMStruct **additional_swms,
715                                    unsigned num_additional_swms,
716                                    wimlib_progress_func_t progress_func)
717 {
718         struct lookup_table *joined_tab, *w_tab_save;
719         int ret;
720
721         if (!w || !target)
722                 return WIMLIB_ERR_INVALID_PARAM;
723
724         extract_flags &= WIMLIB_EXTRACT_MASK_PUBLIC;
725
726         if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
727                         == (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))
728                 return WIMLIB_ERR_INVALID_PARAM;
729
730         if (extract_flags & WIMLIB_EXTRACT_FLAG_NTFS) {
731 #ifdef WITH_NTFS_3G
732                 if ((extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK | WIMLIB_EXTRACT_FLAG_HARDLINK))) {
733                         ERROR("Cannot specify symlink or hardlink flags when applying ");
734                         ERROR("directly to a NTFS volume");
735                         return WIMLIB_ERR_INVALID_PARAM;
736                 }
737                 if (image == WIMLIB_ALL_IMAGES) {
738                         ERROR("Can only apply a single image when applying "
739                               "directly to a NTFS volume");
740                         return WIMLIB_ERR_INVALID_PARAM;
741                 }
742 #else
743                 ERROR("wimlib was compiled without support for NTFS-3g, so");
744                 ERROR("we cannot apply a WIM image directly to a NTFS volume");
745                 return WIMLIB_ERR_UNSUPPORTED;
746 #endif
747         }
748
749         ret = verify_swm_set(w, additional_swms, num_additional_swms);
750         if (ret != 0)
751                 return ret;
752
753         if (num_additional_swms) {
754                 ret = new_joined_lookup_table(w, additional_swms,
755                                               num_additional_swms, &joined_tab);
756                 if (ret != 0)
757                         return ret;
758                 w_tab_save = w->lookup_table;
759                 w->lookup_table = joined_tab;
760         }
761
762         if (image == WIMLIB_ALL_IMAGES) {
763                 extract_flags |= WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
764                 ret = extract_all_images(w, target, extract_flags,
765                                          progress_func);
766         } else {
767                 extract_flags &= ~WIMLIB_EXTRACT_FLAG_MULTI_IMAGE;
768                 ret = extract_single_image(w, image, target, extract_flags,
769                                            progress_func);
770         }
771
772         if (extract_flags & (WIMLIB_EXTRACT_FLAG_SYMLINK |
773                              WIMLIB_EXTRACT_FLAG_HARDLINK))
774         {
775                 for_lookup_table_entry(w->lookup_table,
776                                        lte_free_extracted_file,
777                                        NULL);
778         }
779
780         if (num_additional_swms) {
781                 free_lookup_table(w->lookup_table);
782                 w->lookup_table = w_tab_save;
783         }
784         return ret;
785 }