]> wimlib.net Git - wimlib/blob - src/win32_apply.c
win32_apply.c: add message about known issue with WindowsApps directory
[wimlib] / src / win32_apply.c
1 /*
2  * win32_apply.c - Windows-specific code for applying files from a WIM image.
3  */
4
5 /*
6  * Copyright (C) 2013-2016 Eric Biggers
7  *
8  * This file is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU Lesser General Public License as published by the Free
10  * Software Foundation; either version 3 of the License, or (at your option) any
11  * later version.
12  *
13  * This file is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this file; if not, see http://www.gnu.org/licenses/.
20  */
21
22 #ifdef __WIN32__
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "wimlib/win32_common.h"
29
30 #include "wimlib/apply.h"
31 #include "wimlib/assert.h"
32 #include "wimlib/blob_table.h"
33 #include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list()  */
34 #include "wimlib/dentry.h"
35 #include "wimlib/encoding.h"
36 #include "wimlib/error.h"
37 #include "wimlib/metadata.h"
38 #include "wimlib/paths.h"
39 #include "wimlib/pattern.h"
40 #include "wimlib/reparse.h"
41 #include "wimlib/textfile.h"
42 #include "wimlib/xml.h"
43 #include "wimlib/wimboot.h"
44 #include "wimlib/wof.h"
45
46 struct win32_apply_ctx {
47
48         /* Extract flags, the pointer to the WIMStruct, etc.  */
49         struct apply_ctx common;
50
51         /* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
52          * was provided  */
53         struct {
54                 /* This array contains the WIM files registered with WOF on the
55                  * target volume for this extraction operation.  All WIMStructs
56                  * in this array are distinct and have ->filename != NULL.  */
57                 struct wimboot_wim {
58                         WIMStruct *wim;
59                         u64 data_source_id;
60                         u8 blob_table_hash[SHA1_HASH_SIZE];
61                 } *wims;
62                 size_t num_wims;
63                 bool wof_running;
64                 bool have_wrong_version_wims;
65                 bool have_uncompressed_wims;
66                 bool have_unsupported_compressed_resources;
67                 bool have_huge_resources;
68         } wimboot;
69
70         /* External backing information  */
71         struct string_set *prepopulate_pats;
72         void *mem_prepopulate_pats;
73         bool tried_to_load_prepopulate_list;
74
75         /* Open handle to the target directory  */
76         HANDLE h_target;
77
78         /* NT namespace path to the target directory (buffer allocated)  */
79         UNICODE_STRING target_ntpath;
80
81         /* Temporary buffer for building paths (buffer allocated)  */
82         UNICODE_STRING pathbuf;
83
84         /* Object attributes to reuse for opening files in the target directory.
85          * (attr.ObjectName == &pathbuf) and (attr.RootDirectory == h_target).
86          */
87         OBJECT_ATTRIBUTES attr;
88
89         /* Temporary I/O status block for system calls  */
90         IO_STATUS_BLOCK iosb;
91
92         /* Allocated buffer for creating "printable" paths from our
93          * target-relative NT paths  */
94         wchar_t *print_buffer;
95
96         /* Allocated buffer for reading blob data when it cannot be extracted
97          * directly  */
98         u8 *data_buffer;
99
100         /* Pointer to the next byte in @data_buffer to fill  */
101         u8 *data_buffer_ptr;
102
103         /* Size allocated in @data_buffer  */
104         size_t data_buffer_size;
105
106         /* Current offset in the raw encrypted file being written  */
107         size_t encrypted_offset;
108
109         /* Current size of the raw encrypted file being written  */
110         size_t encrypted_size;
111
112         /* Temporary buffer for reparse data  */
113         struct reparse_buffer_disk rpbuf;
114
115         /* Temporary buffer for reparse data of "fixed" absolute symbolic links
116          * and junctions  */
117         struct reparse_buffer_disk rpfixbuf;
118
119         /* Array of open handles to filesystem streams currently being written
120          */
121         HANDLE open_handles[MAX_OPEN_FILES];
122
123         /* Number of handles in @open_handles currently open (filled in from the
124          * beginning of the array)  */
125         unsigned num_open_handles;
126
127         /* List of dentries, joined by @d_tmp_list, that need to have reparse
128          * data extracted as soon as the whole blob has been read into
129          * @data_buffer.  */
130         struct list_head reparse_dentries;
131
132         /* List of dentries, joined by @d_tmp_list, that need to have raw
133          * encrypted data extracted as soon as the whole blob has been read into
134          * @data_buffer.  */
135         struct list_head encrypted_dentries;
136
137         /* Number of files for which we didn't have permission to set the full
138          * security descriptor.  */
139         unsigned long partial_security_descriptors;
140
141         /* Number of files for which we didn't have permission to set any part
142          * of the security descriptor.  */
143         unsigned long no_security_descriptors;
144
145         /* Number of files for which we couldn't set the short name.  */
146         unsigned long num_set_short_name_failures;
147
148         /* Number of files for which we couldn't remove the short name.  */
149         unsigned long num_remove_short_name_failures;
150
151         /* Number of files on which we couldn't set System Compression.  */
152         unsigned long num_system_compression_failures;
153
154         /* The number of files which, for compatibility with the Windows
155          * bootloader, were not compressed using the requested system
156          * compression format.  This includes matches with the hardcoded pattern
157          * list only; it does not include matches with patterns in
158          * [PrepopulateList].  */
159         unsigned long num_system_compression_exclusions;
160
161         /* The Windows build number of the image being applied, or 0 if unknown.
162          */
163         u64 windows_build_number;
164
165         /* Have we tried to enable short name support on the target volume yet?
166          */
167         bool tried_to_enable_short_names;
168 };
169
170 /* Get the drive letter from a Windows path, or return the null character if the
171  * path is relative.  */
172 static wchar_t
173 get_drive_letter(const wchar_t *path)
174 {
175         /* Skip \\?\ prefix  */
176         if (!wcsncmp(path, L"\\\\?\\", 4))
177                 path += 4;
178
179         /* Return drive letter if valid  */
180         if (((path[0] >= L'a' && path[0] <= L'z') ||
181              (path[0] >= L'A' && path[0] <= L'Z')) && path[1] == L':')
182                 return path[0];
183
184         return L'\0';
185 }
186
187 static void
188 get_vol_flags(const wchar_t *target, DWORD *vol_flags_ret,
189               bool *short_names_supported_ret)
190 {
191         wchar_t filesystem_name[MAX_PATH + 1];
192         wchar_t drive[4];
193         wchar_t *volume = NULL;
194
195         *vol_flags_ret = 0;
196         *short_names_supported_ret = false;
197
198         drive[0] = get_drive_letter(target);
199         if (drive[0]) {
200                 drive[1] = L':';
201                 drive[2] = L'\\';
202                 drive[3] = L'\0';
203                 volume = drive;
204         }
205
206         if (!GetVolumeInformation(volume, NULL, 0, NULL, NULL,
207                                   vol_flags_ret, filesystem_name,
208                                   ARRAY_LEN(filesystem_name)))
209         {
210                 win32_warning(GetLastError(),
211                               L"Failed to get volume information for \"%ls\"",
212                               target);
213                 return;
214         }
215
216         if (wcsstr(filesystem_name, L"NTFS")) {
217                 /* FILE_SUPPORTS_HARD_LINKS is only supported on Windows 7 and
218                  * later.  Force it on anyway if filesystem is NTFS.  */
219                 *vol_flags_ret |= FILE_SUPPORTS_HARD_LINKS;
220
221                 /* There's no volume flag for short names, but according to the
222                  * MS documentation they are only user-settable on NTFS.  */
223                 *short_names_supported_ret = true;
224         }
225 }
226
227 /* Is the image being extracted an OS image for Windows 10 or later?  */
228 static bool
229 is_image_windows_10_or_later(struct win32_apply_ctx *ctx)
230 {
231         /* Note: if no build number is available, this returns false.  */
232         return ctx->windows_build_number >= 10240;
233 }
234
235 static const wchar_t *
236 current_path(struct win32_apply_ctx *ctx);
237
238 static void
239 build_extraction_path(const struct wim_dentry *dentry,
240                       struct win32_apply_ctx *ctx);
241
242 static int
243 report_dentry_apply_error(const struct wim_dentry *dentry,
244                           struct win32_apply_ctx *ctx, int ret)
245 {
246         build_extraction_path(dentry, ctx);
247         return report_apply_error(&ctx->common, ret, current_path(ctx));
248 }
249
250 static inline int
251 check_apply_error(const struct wim_dentry *dentry,
252                   struct win32_apply_ctx *ctx, int ret)
253 {
254         if (unlikely(ret))
255                 ret = report_dentry_apply_error(dentry, ctx, ret);
256         return ret;
257 }
258
259 static int
260 win32_get_supported_features(const wchar_t *target,
261                              struct wim_features *supported_features)
262 {
263         DWORD vol_flags;
264         bool short_names_supported;
265
266         /* Query the features of the target volume.  */
267
268         get_vol_flags(target, &vol_flags, &short_names_supported);
269
270         supported_features->readonly_files = 1;
271         supported_features->hidden_files = 1;
272         supported_features->system_files = 1;
273         supported_features->archive_files = 1;
274
275         if (vol_flags & FILE_FILE_COMPRESSION)
276                 supported_features->compressed_files = 1;
277
278         if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
279                 supported_features->encrypted_files = 1;
280                 supported_features->encrypted_directories = 1;
281         }
282
283         supported_features->not_context_indexed_files = 1;
284
285         /* Don't do anything with FILE_SUPPORTS_SPARSE_FILES.  */
286
287         if (vol_flags & FILE_NAMED_STREAMS)
288                 supported_features->named_data_streams = 1;
289
290         if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
291                 supported_features->hard_links = 1;
292
293         if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS)
294                 supported_features->reparse_points = 1;
295
296         if (vol_flags & FILE_PERSISTENT_ACLS)
297                 supported_features->security_descriptors = 1;
298
299         if (short_names_supported)
300                 supported_features->short_names = 1;
301
302         supported_features->timestamps = 1;
303
304         /* Note: Windows does not support case sensitive filenames!  At least
305          * not without changing the registry and rebooting...  */
306
307         return 0;
308 }
309
310 #define COMPACT_FLAGS   (WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K |         \
311                          WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K |         \
312                          WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K |        \
313                          WIMLIB_EXTRACT_FLAG_COMPACT_LZX)
314
315
316
317 /*
318  * If not done already, load the patterns from the [PrepopulateList] section of
319  * WimBootCompress.ini in the WIM image being extracted.
320  *
321  * Note: WimBootCompress.ini applies to both types of "external backing":
322  *
323  *      - WIM backing ("WIMBoot" - Windows 8.1 and later)
324  *      - File backing ("System Compression" - Windows 10 and later)
325  */
326 static int
327 load_prepopulate_pats(struct win32_apply_ctx *ctx)
328 {
329         const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
330         struct wim_dentry *dentry;
331         const struct blob_descriptor *blob;
332         int ret;
333         void *buf;
334         struct string_set *s;
335         void *mem;
336         struct text_file_section sec;
337
338         if (ctx->tried_to_load_prepopulate_list)
339                 return 0;
340
341         ctx->tried_to_load_prepopulate_list = true;
342
343         dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
344         if (!dentry ||
345             (dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
346                                               FILE_ATTRIBUTE_REPARSE_POINT |
347                                               FILE_ATTRIBUTE_ENCRYPTED)) ||
348             !(blob = inode_get_blob_for_unnamed_data_stream(dentry->d_inode,
349                                                             ctx->common.wim->blob_table)))
350         {
351                 WARNING("%ls does not exist in the WIM image.\n"
352                         "          The default configuration will be used instead; it assumes that all\n"
353                         "          files are valid for external backing regardless of path, equivalent\n"
354                         "          to an empty [PrepopulateList] section.", path);
355                 return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
356         }
357
358         ret = read_blob_into_alloc_buf(blob, &buf);
359         if (ret)
360                 return ret;
361
362         s = CALLOC(1, sizeof(struct string_set));
363         if (!s) {
364                 FREE(buf);
365                 return WIMLIB_ERR_NOMEM;
366         }
367
368         sec.name = T("PrepopulateList");
369         sec.strings = s;
370
371         ret = do_load_text_file(path, buf, blob->size, &mem, &sec, 1,
372                                 LOAD_TEXT_FILE_REMOVE_QUOTES |
373                                         LOAD_TEXT_FILE_NO_WARNINGS,
374                                 mangle_pat);
375         STATIC_ASSERT(OS_PREFERRED_PATH_SEPARATOR == WIM_PATH_SEPARATOR);
376         FREE(buf);
377         if (ret) {
378                 FREE(s);
379                 return ret;
380         }
381         ctx->prepopulate_pats = s;
382         ctx->mem_prepopulate_pats = mem;
383         return 0;
384 }
385
386 /* Returns %true if the specified absolute path to a file in the WIM image can
387  * be subject to external backing when extracted.  Otherwise returns %false.  */
388 static bool
389 can_externally_back_path(const wchar_t *path, const struct win32_apply_ctx *ctx)
390 {
391         /* Does the path match a pattern given in the [PrepopulateList] section
392          * of WimBootCompress.ini?  */
393         if (ctx->prepopulate_pats && match_pattern_list(path, ctx->prepopulate_pats))
394                 return false;
395
396         /* Since we attempt to modify the SYSTEM registry after it's extracted
397          * (see end_wimboot_extraction()), it can't be extracted as externally
398          * backed.  This extends to associated files such as SYSTEM.LOG that
399          * also must be writable in order to write to the registry.  Normally,
400          * SYSTEM is in [PrepopulateList], and the SYSTEM.* files match patterns
401          * in [ExclusionList] and therefore are not captured in the WIM at all.
402          * However, a WIM that wasn't specifically captured in "WIMBoot mode"
403          * may contain SYSTEM.* files.  So to make things "just work", hard-code
404          * the pattern.  */
405         if (match_path(path, L"\\Windows\\System32\\config\\SYSTEM*", false))
406                 return false;
407
408         return true;
409 }
410
411 /* Can the specified WIM resource be used as the source of an external backing
412  * for the wof.sys WIM provider?  */
413 static bool
414 is_resource_valid_for_external_backing(const struct wim_resource_descriptor *rdesc,
415                                        struct win32_apply_ctx *ctx)
416 {
417         /* Must be the original WIM file format.  This check excludes pipable
418          * resources and solid resources.  It also excludes other resources
419          * contained in such files even if they would be otherwise compatible.
420          */
421         if (rdesc->wim->hdr.magic != WIM_MAGIC ||
422             rdesc->wim->hdr.wim_version != WIM_VERSION_DEFAULT)
423         {
424                 ctx->wimboot.have_wrong_version_wims = true;
425                 return false;
426         }
427
428         /*
429          * Whitelist of compression types and chunk sizes supported by
430          * Microsoft's WOF driver.
431          *
432          * Notes:
433          *    - Uncompressed WIMs result in BSOD.  However, this only applies to
434          *      the WIM file itself, not to uncompressed resources in a WIM file
435          *      that is otherwise compressed.
436          *    - XPRESS 64K sometimes appears to work, but sometimes it causes
437          *      reads to fail with STATUS_UNSUCCESSFUL.
438          */
439         switch (rdesc->compression_type) {
440         case WIMLIB_COMPRESSION_TYPE_NONE:
441                 if (rdesc->wim->compression_type == WIMLIB_COMPRESSION_TYPE_NONE) {
442                         ctx->wimboot.have_uncompressed_wims = true;
443                         return false;
444                 }
445                 break;
446         case WIMLIB_COMPRESSION_TYPE_XPRESS:
447                 switch (rdesc->chunk_size) {
448                 case 4096:
449                 case 8192:
450                 case 16384:
451                 case 32768:
452                         break;
453                 default:
454                         ctx->wimboot.have_unsupported_compressed_resources = true;
455                         return false;
456                 }
457                 break;
458         case WIMLIB_COMPRESSION_TYPE_LZX:
459                 switch (rdesc->chunk_size) {
460                 case 32768:
461                         break;
462                 default:
463                         ctx->wimboot.have_unsupported_compressed_resources = true;
464                         return false;
465                 }
466                 break;
467         default:
468                 ctx->wimboot.have_unsupported_compressed_resources = true;
469                 return false;
470         }
471
472         /* Microsoft's WoF driver errors out if it tries to satisfy a read with
473          * ending offset >= 4 GiB from an externally backed file.  */
474         if (rdesc->uncompressed_size > 4200000000) {
475                 ctx->wimboot.have_huge_resources = true;
476                 return false;
477         }
478
479         return true;
480 }
481
482 #define EXTERNAL_BACKING_NOT_ENABLED            -1
483 #define EXTERNAL_BACKING_NOT_POSSIBLE           -2
484 #define EXTERNAL_BACKING_EXCLUDED               -3
485
486 /*
487  * Determines whether the specified file will be externally backed.  Returns a
488  * negative status code if no, 0 if yes, or a positive wimlib error code on
489  * error.  If the file is excluded from external backing based on its path, then
490  * *excluded_dentry_ret is set to the dentry for the path that matched the
491  * exclusion rule.
492  *
493  * Note that this logic applies to both types of "external backing":
494  *
495  *      - WIM backing ("WIMBoot" - Windows 8.1 and later)
496  *      - File backing ("System Compression" - Windows 10 and later)
497  *
498  * However, in the case of WIM backing we also need to validate that the WIM
499  * resource that would be the source of the backing is supported by the wof.sys
500  * WIM provider.
501  */
502 static int
503 will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
504                            const struct wim_dentry **excluded_dentry_ret,
505                            bool wimboot_mode)
506 {
507         struct wim_dentry *dentry;
508         struct blob_descriptor *blob;
509         int ret;
510
511         if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
512                 return WIMLIB_ERR_NOMEM;
513
514         if (inode->i_can_externally_back)
515                 return 0;
516
517         /* This may do redundant checks because the cached value
518          * i_can_externally_back is 2-state (as opposed to 3-state:
519          * unknown/no/yes).  But most files can be externally backed, so this
520          * way is fine.  */
521
522         if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
523                                    FILE_ATTRIBUTE_REPARSE_POINT |
524                                    FILE_ATTRIBUTE_ENCRYPTED))
525                 return EXTERNAL_BACKING_NOT_POSSIBLE;
526
527         blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
528
529         if (!blob)
530                 return EXTERNAL_BACKING_NOT_POSSIBLE;
531
532         if (wimboot_mode &&
533             (blob->blob_location != BLOB_IN_WIM ||
534              !is_resource_valid_for_external_backing(blob->rdesc, ctx)))
535                 return EXTERNAL_BACKING_NOT_POSSIBLE;
536
537         /*
538          * We need to check the patterns in [PrepopulateList] against every name
539          * of the inode, in case any of them match.
540          */
541
542         inode_for_each_extraction_alias(dentry, inode) {
543
544                 ret = calculate_dentry_full_path(dentry);
545                 if (ret)
546                         return ret;
547
548                 if (!can_externally_back_path(dentry->d_full_path, ctx)) {
549                         if (excluded_dentry_ret)
550                                 *excluded_dentry_ret = dentry;
551                         return EXTERNAL_BACKING_EXCLUDED;
552                 }
553         }
554
555         inode->i_can_externally_back = 1;
556         return 0;
557 }
558
559 /*
560  * Determines if the unnamed data stream of a file will be created as a WIM
561  * external backing (a "WIMBoot pointer file"), as opposed to a standard
562  * extraction.
563  */
564 static int
565 win32_will_back_from_wim(struct wim_dentry *dentry, struct apply_ctx *_ctx)
566 {
567         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
568
569         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
570                 return EXTERNAL_BACKING_NOT_ENABLED;
571
572         return will_externally_back_inode(dentry->d_inode, ctx, NULL, true);
573 }
574
575 /* Find the WOF registration information for the specified WIM file.  */
576 static struct wimboot_wim *
577 find_wimboot_wim(WIMStruct *wim_to_find, struct win32_apply_ctx *ctx)
578 {
579         for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
580                 if (wim_to_find == ctx->wimboot.wims[i].wim)
581                         return &ctx->wimboot.wims[i];
582
583         wimlib_assert(0);
584         return NULL;
585 }
586
587 static int
588 set_backed_from_wim(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
589 {
590         int ret;
591         const struct wim_dentry *excluded_dentry;
592         const struct blob_descriptor *blob;
593         const struct wimboot_wim *wimboot_wim;
594
595         ret = will_externally_back_inode(inode, ctx, &excluded_dentry, true);
596         if (ret > 0) /* Error.  */
597                 return ret;
598
599         if (ret < 0 && ret != EXTERNAL_BACKING_EXCLUDED)
600                 return 0; /* Not externally backing, other than due to exclusion.  */
601
602         if (unlikely(ret == EXTERNAL_BACKING_EXCLUDED)) {
603                 /* Not externally backing due to exclusion.  */
604                 union wimlib_progress_info info;
605
606                 build_extraction_path(excluded_dentry, ctx);
607
608                 info.wimboot_exclude.path_in_wim = excluded_dentry->d_full_path;
609                 info.wimboot_exclude.extraction_path = current_path(ctx);
610
611                 return call_progress(ctx->common.progfunc,
612                                      WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
613                                      &info, ctx->common.progctx);
614         }
615
616         /* Externally backing.  */
617
618         blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
619         wimboot_wim = find_wimboot_wim(blob->rdesc->wim, ctx);
620
621         if (unlikely(!wimboot_set_pointer(h,
622                                           blob,
623                                           wimboot_wim->data_source_id,
624                                           wimboot_wim->blob_table_hash,
625                                           ctx->wimboot.wof_running)))
626         {
627                 const DWORD err = GetLastError();
628
629                 build_extraction_path(inode_first_extraction_dentry(inode), ctx);
630                 win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
631                             current_path(ctx));
632                 return WIMLIB_ERR_WIMBOOT;
633         }
634         return 0;
635 }
636
637 /* Calculates the SHA-1 message digest of the WIM's blob table.  */
638 static int
639 hash_blob_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
640 {
641         return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
642 }
643
644 static int
645 register_wim_with_wof(WIMStruct *wim, struct win32_apply_ctx *ctx)
646 {
647         struct wimboot_wim *p;
648         int ret;
649
650         /* Check if already registered  */
651         for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
652                 if (wim == ctx->wimboot.wims[i].wim)
653                         return 0;
654
655         /* Not yet registered  */
656
657         p = REALLOC(ctx->wimboot.wims,
658                     (ctx->wimboot.num_wims + 1) * sizeof(ctx->wimboot.wims[0]));
659         if (!p)
660                 return WIMLIB_ERR_NOMEM;
661         ctx->wimboot.wims = p;
662
663         ctx->wimboot.wims[ctx->wimboot.num_wims].wim = wim;
664
665         ret = hash_blob_table(wim, ctx->wimboot.wims[ctx->wimboot.num_wims].blob_table_hash);
666         if (ret)
667                 return ret;
668
669         ret = wimboot_alloc_data_source_id(wim->filename,
670                                            wim->hdr.guid,
671                                            ctx->common.wim->current_image,
672                                            ctx->common.target,
673                                            &ctx->wimboot.wims[ctx->wimboot.num_wims].data_source_id,
674                                            &ctx->wimboot.wof_running);
675         if (ret)
676                 return ret;
677
678         ctx->wimboot.num_wims++;
679         return 0;
680 }
681
682 /* Prepare for doing a "WIMBoot" extraction by registering each source WIM file
683  * with WOF on the target volume.  */
684 static int
685 start_wimboot_extraction(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
686 {
687         int ret;
688         struct wim_dentry *dentry;
689
690         if (!xml_get_wimboot(ctx->common.wim->xml_info,
691                              ctx->common.wim->current_image))
692                 WARNING("The WIM image is not marked as WIMBoot compatible.  This usually\n"
693                         "          means it is not intended to be used to back a Windows operating\n"
694                         "          system.  Proceeding anyway.");
695
696         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
697                 struct blob_descriptor *blob;
698
699                 ret = win32_will_back_from_wim(dentry, &ctx->common);
700                 if (ret > 0) /* Error */
701                         return ret;
702                 if (ret < 0) /* Won't externally back */
703                         continue;
704
705                 blob = inode_get_blob_for_unnamed_data_stream_resolved(dentry->d_inode);
706                 ret = register_wim_with_wof(blob->rdesc->wim, ctx);
707                 if (ret)
708                         return ret;
709         }
710
711         if (ctx->wimboot.have_wrong_version_wims) {
712   WARNING("At least one of the source WIM files uses a version of the WIM\n"
713 "          file format that not supported by Microsoft's wof.sys driver.\n"
714 "          Files whose data is contained in one of these WIM files will be\n"
715 "          extracted as full files rather than externally backed.");
716         }
717
718         if (ctx->wimboot.have_uncompressed_wims) {
719   WARNING("At least one of the source WIM files is uncompressed.  Files whose\n"
720 "          data is contained in an uncompressed WIM file will be extracted as\n"
721 "          full files rather than externally backed, since uncompressed WIM\n"
722 "          files are not supported by Microsoft's wof.sys driver.");
723         }
724
725         if (ctx->wimboot.have_unsupported_compressed_resources) {
726   WARNING("At least one of the source WIM files uses a compression format that\n"
727 "          is not supported by Microsoft's wof.sys driver.  Files whose data is\n"
728 "          contained in a compressed resource in one of these WIM files will be\n"
729 "          extracted as full files rather than externally backed.  (The\n"
730 "          compression formats supported by wof.sys are: XPRESS 4K, XPRESS 8K,\n"
731 "          XPRESS 16K, XPRESS 32K, and LZX 32K.)");
732         }
733
734         if (ctx->wimboot.have_huge_resources) {
735   WARNING("Some files exceeded 4.2 GB in size.  Such files will be extracted\n"
736 "          as full files rather than externally backed, since very large files\n"
737 "          are not supported by Microsoft's wof.sys driver.");
738         }
739
740         return 0;
741 }
742
743 static void
744 build_win32_extraction_path(const struct wim_dentry *dentry,
745                             struct win32_apply_ctx *ctx);
746
747 /* Sets WimBoot=1 in the extracted SYSTEM registry hive.
748  *
749  * WIMGAPI does this, and it's possible that it's important.
750  * But I don't know exactly what this value means to Windows.  */
751 static int
752 end_wimboot_extraction(struct win32_apply_ctx *ctx)
753 {
754         struct wim_dentry *dentry;
755         wchar_t subkeyname[32];
756         LONG res;
757         LONG res2;
758         HKEY key;
759         DWORD value;
760
761         dentry = get_dentry(ctx->common.wim, L"\\Windows\\System32\\config\\SYSTEM",
762                             WIMLIB_CASE_INSENSITIVE);
763
764         if (!dentry || !will_extract_dentry(dentry))
765                 goto out;
766
767         if (!will_extract_dentry(wim_get_current_root_dentry(ctx->common.wim)))
768                 goto out;
769
770         /* Not bothering to use the native routines (e.g. NtLoadKey()) for this.
771          * If this doesn't work, you probably also have many other problems.  */
772
773         build_win32_extraction_path(dentry, ctx);
774
775         randomize_char_array_with_alnum(subkeyname, 20);
776         subkeyname[20] = L'\0';
777
778         res = RegLoadKey(HKEY_LOCAL_MACHINE, subkeyname, ctx->pathbuf.Buffer);
779         if (res)
780                 goto out_check_res;
781
782         wcscpy(&subkeyname[20], L"\\Setup");
783
784         res = RegCreateKeyEx(HKEY_LOCAL_MACHINE, subkeyname, 0, NULL,
785                              REG_OPTION_BACKUP_RESTORE, 0, NULL, &key, NULL);
786         if (res)
787                 goto out_unload_key;
788
789         value = 1;
790
791         res = RegSetValueEx(key, L"WimBoot", 0, REG_DWORD,
792                             (const BYTE *)&value, sizeof(DWORD));
793         if (res)
794                 goto out_close_key;
795
796         res = RegFlushKey(key);
797
798 out_close_key:
799         res2 = RegCloseKey(key);
800         if (!res)
801                 res = res2;
802 out_unload_key:
803         subkeyname[20] = L'\0';
804         RegUnLoadKey(HKEY_LOCAL_MACHINE, subkeyname);
805 out_check_res:
806         if (res) {
807                 /* Warning only.  */
808                 win32_warning(res, L"Failed to set \\Setup: dword \"WimBoot\"=1 "
809                               "value in registry hive \"%ls\"",
810                               ctx->pathbuf.Buffer);
811         }
812 out:
813         return 0;
814 }
815
816 /* Returns the number of wide characters needed to represent the path to the
817  * specified @dentry, relative to the target directory, when extracted.
818  *
819  * Does not include null terminator (not needed for NtCreateFile).  */
820 static size_t
821 dentry_extraction_path_length(const struct wim_dentry *dentry)
822 {
823         size_t len = 0;
824         const struct wim_dentry *d;
825
826         d = dentry;
827         do {
828                 len += d->d_extraction_name_nchars + 1;
829                 d = d->d_parent;
830         } while (!dentry_is_root(d) && will_extract_dentry(d));
831
832         return --len;  /* No leading slash  */
833 }
834
835 /* Returns the length of the longest string that might need to be appended to
836  * the path to an alias of an inode to open or create a named data stream.
837  *
838  * If the inode has no named data streams, this will be 0.  Otherwise, this will
839  * be 1 plus the length of the longest-named data stream, since the data stream
840  * name must be separated from the path by the ':' character.  */
841 static size_t
842 inode_longest_named_data_stream_spec(const struct wim_inode *inode)
843 {
844         size_t max = 0;
845         for (unsigned i = 0; i < inode->i_num_streams; i++) {
846                 const struct wim_inode_stream *strm = &inode->i_streams[i];
847                 if (!stream_is_named_data_stream(strm))
848                         continue;
849                 size_t len = utf16le_len_chars(strm->stream_name);
850                 if (len > max)
851                         max = len;
852         }
853         if (max)
854                 max += 1;
855         return max;
856 }
857
858 /* Find the length, in wide characters, of the longest path needed for
859  * extraction of any file in @dentry_list relative to the target directory.
860  *
861  * Accounts for named data streams, but does not include null terminator (not
862  * needed for NtCreateFile).  */
863 static size_t
864 compute_path_max(struct list_head *dentry_list)
865 {
866         size_t max = 0;
867         const struct wim_dentry *dentry;
868
869         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
870                 size_t len;
871
872                 len = dentry_extraction_path_length(dentry);
873
874                 /* Account for named data streams  */
875                 len += inode_longest_named_data_stream_spec(dentry->d_inode);
876
877                 if (len > max)
878                         max = len;
879         }
880
881         return max;
882 }
883
884 /* Build the path at which to extract the @dentry, relative to the target
885  * directory.
886  *
887  * The path is saved in ctx->pathbuf.  */
888 static void
889 build_extraction_path(const struct wim_dentry *dentry,
890                       struct win32_apply_ctx *ctx)
891 {
892         size_t len;
893         wchar_t *p;
894         const struct wim_dentry *d;
895
896         len = dentry_extraction_path_length(dentry);
897
898         ctx->pathbuf.Length = len * sizeof(wchar_t);
899         p = ctx->pathbuf.Buffer + len;
900         for (d = dentry;
901              !dentry_is_root(d->d_parent) && will_extract_dentry(d->d_parent);
902              d = d->d_parent)
903         {
904                 p -= d->d_extraction_name_nchars;
905                 if (d->d_extraction_name_nchars)
906                         wmemcpy(p, d->d_extraction_name,
907                                 d->d_extraction_name_nchars);
908                 *--p = '\\';
909         }
910         /* No leading slash  */
911         p -= d->d_extraction_name_nchars;
912         wmemcpy(p, d->d_extraction_name, d->d_extraction_name_nchars);
913 }
914
915 /* Build the path at which to extract the @dentry, relative to the target
916  * directory, adding the suffix for a named data stream.
917  *
918  * The path is saved in ctx->pathbuf.  */
919 static void
920 build_extraction_path_with_ads(const struct wim_dentry *dentry,
921                                struct win32_apply_ctx *ctx,
922                                const wchar_t *stream_name,
923                                size_t stream_name_nchars)
924 {
925         wchar_t *p;
926
927         build_extraction_path(dentry, ctx);
928
929         /* Add :NAME for named data stream  */
930         p = ctx->pathbuf.Buffer + (ctx->pathbuf.Length / sizeof(wchar_t));
931         *p++ = L':';
932         wmemcpy(p, stream_name, stream_name_nchars);
933         ctx->pathbuf.Length += (1 + stream_name_nchars) * sizeof(wchar_t);
934 }
935
936 /* Build the Win32 namespace path to the specified @dentry when extracted.
937  *
938  * The path is saved in ctx->pathbuf and will be null terminated.
939  *
940  * XXX: We could get rid of this if it wasn't needed for the file encryption
941  * APIs, and the registry manipulation in WIMBoot mode.  */
942 static void
943 build_win32_extraction_path(const struct wim_dentry *dentry,
944                             struct win32_apply_ctx *ctx)
945 {
946         build_extraction_path(dentry, ctx);
947
948         /* Prepend target_ntpath to our relative path, then change \??\ into \\?\  */
949
950         memmove(ctx->pathbuf.Buffer +
951                         (ctx->target_ntpath.Length / sizeof(wchar_t)) + 1,
952                 ctx->pathbuf.Buffer, ctx->pathbuf.Length);
953         memcpy(ctx->pathbuf.Buffer, ctx->target_ntpath.Buffer,
954                 ctx->target_ntpath.Length);
955         ctx->pathbuf.Buffer[ctx->target_ntpath.Length / sizeof(wchar_t)] = L'\\';
956         ctx->pathbuf.Length += ctx->target_ntpath.Length + sizeof(wchar_t);
957         ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)] = L'\0';
958
959         wimlib_assert(ctx->pathbuf.Length >= 4 * sizeof(wchar_t) &&
960                       !wmemcmp(ctx->pathbuf.Buffer, L"\\??\\", 4));
961
962         ctx->pathbuf.Buffer[1] = L'\\';
963
964 }
965
966 /* Returns a "printable" representation of the last relative NT path that was
967  * constructed with build_extraction_path() or build_extraction_path_with_ads().
968  *
969  * This will be overwritten by the next call to this function.  */
970 static const wchar_t *
971 current_path(struct win32_apply_ctx *ctx)
972 {
973         wchar_t *p = ctx->print_buffer;
974
975         p = wmempcpy(p, ctx->common.target, ctx->common.target_nchars);
976         *p++ = L'\\';
977         p = wmempcpy(p, ctx->pathbuf.Buffer, ctx->pathbuf.Length / sizeof(wchar_t));
978         *p = L'\0';
979         return ctx->print_buffer;
980 }
981
982 /* Open handle to the target directory if it is not already open.  If the target
983  * directory does not exist, this creates it.  */
984 static int
985 open_target_directory(struct win32_apply_ctx *ctx)
986 {
987         NTSTATUS status;
988
989         if (ctx->h_target)
990                 return 0;
991
992         ctx->attr.Length = sizeof(ctx->attr);
993         ctx->attr.RootDirectory = NULL;
994         ctx->attr.ObjectName = &ctx->target_ntpath;
995
996         /* Don't use FILE_OPEN_REPARSE_POINT here; we want the extraction to
997          * happen at the directory "pointed to" by the reparse point. */
998         status = (*func_NtCreateFile)(&ctx->h_target,
999                                       FILE_TRAVERSE,
1000                                       &ctx->attr,
1001                                       &ctx->iosb,
1002                                       NULL,
1003                                       0,
1004                                       FILE_SHARE_VALID_FLAGS,
1005                                       FILE_OPEN_IF,
1006                                       FILE_DIRECTORY_FILE |
1007                                               FILE_OPEN_FOR_BACKUP_INTENT,
1008                                       NULL,
1009                                       0);
1010         if (!NT_SUCCESS(status)) {
1011                 winnt_error(status, L"Can't open or create directory \"%ls\"",
1012                             ctx->common.target);
1013                 return WIMLIB_ERR_OPENDIR;
1014         }
1015         ctx->attr.RootDirectory = ctx->h_target;
1016         ctx->attr.ObjectName = &ctx->pathbuf;
1017         return 0;
1018 }
1019
1020 static void
1021 close_target_directory(struct win32_apply_ctx *ctx)
1022 {
1023         if (ctx->h_target) {
1024                 (*func_NtClose)(ctx->h_target);
1025                 ctx->h_target = NULL;
1026                 ctx->attr.RootDirectory = NULL;
1027         }
1028 }
1029
1030 /*
1031  * Ensures the target directory exists and opens a handle to it, in preparation
1032  * of using paths relative to it.
1033  */
1034 static int
1035 prepare_target(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1036 {
1037         int ret;
1038         size_t path_max;
1039
1040         ret = win32_path_to_nt_path(ctx->common.target, &ctx->target_ntpath);
1041         if (ret)
1042                 return ret;
1043
1044         ret = open_target_directory(ctx);
1045         if (ret)
1046                 return ret;
1047
1048         path_max = compute_path_max(dentry_list);
1049         /* Add some extra for building Win32 paths for the file encryption APIs,
1050          * and ensure we have at least enough to potentially use a 8.3 name for
1051          * the last component.  */
1052         path_max += max(2 + (ctx->target_ntpath.Length / sizeof(wchar_t)),
1053                         8 + 1 + 3);
1054
1055         ctx->pathbuf.MaximumLength = path_max * sizeof(wchar_t);
1056         ctx->pathbuf.Buffer = MALLOC(ctx->pathbuf.MaximumLength);
1057         if (!ctx->pathbuf.Buffer)
1058                 return WIMLIB_ERR_NOMEM;
1059
1060         ctx->print_buffer = MALLOC((ctx->common.target_nchars + 1 + path_max + 1) *
1061                                    sizeof(wchar_t));
1062         if (!ctx->print_buffer)
1063                 return WIMLIB_ERR_NOMEM;
1064
1065         return 0;
1066 }
1067
1068 /* When creating an inode that will have a short (DOS) name, we create it using
1069  * the long name associated with the short name.  This ensures that the short
1070  * name gets associated with the correct long name.  */
1071 static struct wim_dentry *
1072 first_extraction_alias(const struct wim_inode *inode)
1073 {
1074         struct wim_dentry *dentry;
1075
1076         inode_for_each_extraction_alias(dentry, inode)
1077                 if (dentry_has_short_name(dentry))
1078                         return dentry;
1079         return inode_first_extraction_dentry(inode);
1080 }
1081
1082 /*
1083  * Set or clear FILE_ATTRIBUTE_COMPRESSED if the inherited value is different
1084  * from the desired value.
1085  *
1086  * Note that you can NOT override the inherited value of
1087  * FILE_ATTRIBUTE_COMPRESSED directly with NtCreateFile().
1088  */
1089 static int
1090 adjust_compression_attribute(HANDLE h, const struct wim_dentry *dentry,
1091                              struct win32_apply_ctx *ctx)
1092 {
1093         const bool compressed = (dentry->d_inode->i_attributes &
1094                                  FILE_ATTRIBUTE_COMPRESSED);
1095
1096         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)
1097                 return 0;
1098
1099         if (!ctx->common.supported_features.compressed_files)
1100                 return 0;
1101
1102         FILE_BASIC_INFORMATION info;
1103         NTSTATUS status;
1104         USHORT compression_state;
1105         DWORD bytes_returned;
1106
1107         /* Get current attributes  */
1108         status = (*func_NtQueryInformationFile)(h, &ctx->iosb,
1109                                                 &info, sizeof(info),
1110                                                 FileBasicInformation);
1111         if (NT_SUCCESS(status) &&
1112             compressed == !!(info.FileAttributes & FILE_ATTRIBUTE_COMPRESSED))
1113         {
1114                 /* Nothing needs to be done.  */
1115                 return 0;
1116         }
1117
1118         /* Set the new compression state  */
1119
1120         if (compressed)
1121                 compression_state = COMPRESSION_FORMAT_DEFAULT;
1122         else
1123                 compression_state = COMPRESSION_FORMAT_NONE;
1124
1125         /* Note: don't use NtFsControlFile() here unless prepared to handle
1126          * STATUS_PENDING.  */
1127         if (DeviceIoControl(h, FSCTL_SET_COMPRESSION,
1128                             &compression_state, sizeof(USHORT), NULL, 0,
1129                             &bytes_returned, NULL))
1130                 return 0;
1131
1132         win32_error(GetLastError(), L"Can't %s compression attribute on \"%ls\"",
1133                     (compressed ? "set" : "clear"), current_path(ctx));
1134         return WIMLIB_ERR_SET_ATTRIBUTES;
1135 }
1136
1137 /* Try to enable short name support on the target volume.  If successful, return
1138  * true.  If unsuccessful, issue a warning and return false.  */
1139 static bool
1140 try_to_enable_short_names(const wchar_t *volume)
1141 {
1142         HANDLE h;
1143         FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
1144         BOOL bret;
1145         DWORD bytesReturned;
1146
1147         h = CreateFile(volume, GENERIC_WRITE,
1148                        FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
1149                        FILE_FLAG_BACKUP_SEMANTICS, NULL);
1150         if (h == INVALID_HANDLE_VALUE)
1151                 goto fail;
1152
1153         info.VolumeFlags = 0;
1154         info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
1155         info.Version = 1;
1156         info.Reserved = 0;
1157
1158         bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
1159                                &info, sizeof(info), NULL, 0,
1160                                &bytesReturned, NULL);
1161
1162         CloseHandle(h);
1163
1164         if (!bret)
1165                 goto fail;
1166         return true;
1167
1168 fail:
1169         win32_warning(GetLastError(),
1170                       L"Failed to enable short name support on %ls",
1171                       volume + 4);
1172         return false;
1173 }
1174
1175 static NTSTATUS
1176 remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1177 {
1178         wchar_t *name;
1179         wchar_t *end;
1180         NTSTATUS status;
1181         HANDLE h;
1182         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1183                          (13 * sizeof(wchar_t));
1184         u8 buf[bufsize] _aligned_attribute(8);
1185         bool retried = false;
1186         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1187
1188         memset(buf, 0, bufsize);
1189
1190         /* Build the path with the short name.  */
1191         name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
1192         while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
1193                 name--;
1194         end = mempcpy(name, dentry->d_short_name, dentry->d_short_name_nbytes);
1195         ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
1196
1197         /* Open the conflicting file (by short name).  */
1198         status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
1199                                     &ctx->attr, &ctx->iosb,
1200                                     FILE_SHARE_VALID_FLAGS,
1201                                     FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
1202         if (!NT_SUCCESS(status)) {
1203                 winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
1204                 goto out;
1205         }
1206
1207 #if 0
1208         WARNING("Overriding conflicting short name; path=\"%ls\"",
1209                 current_path(ctx));
1210 #endif
1211
1212         /* Try to remove the short name on the conflicting file.  */
1213
1214 retry:
1215         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1216                                               FileShortNameInformation);
1217
1218         if (status == STATUS_INVALID_PARAMETER && !retried) {
1219
1220                 /* Microsoft forgot to make it possible to remove short names
1221                  * until Windows 7.  Oops.  Use a random short name instead.  */
1222
1223                 info->FileNameLength = 12 * sizeof(wchar_t);
1224                 for (int i = 0; i < 8; i++)
1225                         info->FileName[i] = 'A' + (rand() % 26);
1226                 info->FileName[8] = L'.';
1227                 info->FileName[9] = L'W';
1228                 info->FileName[10] = L'L';
1229                 info->FileName[11] = L'B';
1230                 info->FileName[12] = L'\0';
1231                 retried = true;
1232                 goto retry;
1233         }
1234         (*func_NtClose)(h);
1235 out:
1236         build_extraction_path(dentry, ctx);
1237         return status;
1238 }
1239
1240 /* Set the short name on the open file @h which has been created at the location
1241  * indicated by @dentry.
1242  *
1243  * Note that this may add, change, or remove the short name.
1244  *
1245  * @h must be opened with DELETE access.
1246  *
1247  * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME.  The latter only happens in
1248  * STRICT_SHORT_NAMES mode.
1249  */
1250 static int
1251 set_short_name(HANDLE h, const struct wim_dentry *dentry,
1252                struct win32_apply_ctx *ctx)
1253 {
1254
1255         if (!ctx->common.supported_features.short_names)
1256                 return 0;
1257
1258         /*
1259          * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
1260          * FileName contains at least 2 wide characters (4 bytes).  Otherwise,
1261          * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH.  This
1262          * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
1263          * with the former case being removing the existing short name if
1264          * present, rather than setting one.
1265          *
1266          * The null terminator is seemingly optional, but to be safe we include
1267          * space for it and zero all unused space.
1268          */
1269
1270         size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
1271                          max(dentry->d_short_name_nbytes, sizeof(wchar_t)) +
1272                          sizeof(wchar_t);
1273         u8 buf[bufsize] _aligned_attribute(8);
1274         FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
1275         NTSTATUS status;
1276         bool tried_to_remove_existing = false;
1277
1278         memset(buf, 0, bufsize);
1279
1280         info->FileNameLength = dentry->d_short_name_nbytes;
1281         memcpy(info->FileName, dentry->d_short_name, dentry->d_short_name_nbytes);
1282
1283 retry:
1284         status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
1285                                               FileShortNameInformation);
1286         if (NT_SUCCESS(status))
1287                 return 0;
1288
1289         if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
1290                 if (dentry->d_short_name_nbytes == 0)
1291                         return 0;
1292                 if (!ctx->tried_to_enable_short_names) {
1293                         wchar_t volume[7];
1294                         int ret;
1295
1296                         ctx->tried_to_enable_short_names = true;
1297
1298                         ret = win32_get_drive_path(ctx->common.target,
1299                                                    volume);
1300                         if (ret)
1301                                 return ret;
1302                         if (try_to_enable_short_names(volume))
1303                                 goto retry;
1304                 }
1305         }
1306
1307         /*
1308          * Short names can conflict in several cases:
1309          *
1310          * - a file being extracted has a short name conflicting with an
1311          *   existing file
1312          *
1313          * - a file being extracted has a short name conflicting with another
1314          *   file being extracted (possible, but shouldn't happen)
1315          *
1316          * - a file being extracted has a short name that conflicts with the
1317          *   automatically generated short name of a file we previously
1318          *   extracted, but failed to set the short name for.  Sounds unlikely,
1319          *   but this actually does happen fairly often on versions of Windows
1320          *   prior to Windows 7 because they do not support removing short names
1321          *   from files.
1322          */
1323         if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
1324             dentry->d_short_name_nbytes && !tried_to_remove_existing)
1325         {
1326                 tried_to_remove_existing = true;
1327                 status = remove_conflicting_short_name(dentry, ctx);
1328                 if (NT_SUCCESS(status))
1329                         goto retry;
1330         }
1331
1332         /* By default, failure to set short names is not an error (since short
1333          * names aren't too important anymore...).  */
1334         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
1335                 if (dentry->d_short_name_nbytes)
1336                         ctx->num_set_short_name_failures++;
1337                 else
1338                         ctx->num_remove_short_name_failures++;
1339                 return 0;
1340         }
1341
1342         winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
1343         return WIMLIB_ERR_SET_SHORT_NAME;
1344 }
1345
1346 /*
1347  * A wrapper around NtCreateFile() to make it slightly more usable...
1348  * This uses the path currently constructed in ctx->pathbuf.
1349  *
1350  * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
1351  * FILE_OPEN_REPARSE_POINT.
1352  */
1353 static NTSTATUS
1354 do_create_file(PHANDLE FileHandle,
1355                ACCESS_MASK DesiredAccess,
1356                PLARGE_INTEGER AllocationSize,
1357                ULONG FileAttributes,
1358                ULONG CreateDisposition,
1359                ULONG CreateOptions,
1360                struct win32_apply_ctx *ctx)
1361 {
1362         return (*func_NtCreateFile)(FileHandle,
1363                                     DesiredAccess,
1364                                     &ctx->attr,
1365                                     &ctx->iosb,
1366                                     AllocationSize,
1367                                     FileAttributes,
1368                                     FILE_SHARE_VALID_FLAGS,
1369                                     CreateDisposition,
1370                                     CreateOptions |
1371                                         FILE_OPEN_FOR_BACKUP_INTENT |
1372                                         FILE_OPEN_REPARSE_POINT,
1373                                     NULL,
1374                                     0);
1375 }
1376
1377 /* Like do_create_file(), but builds the extraction path of the @dentry first.
1378  */
1379 static NTSTATUS
1380 create_file(PHANDLE FileHandle,
1381             ACCESS_MASK DesiredAccess,
1382             PLARGE_INTEGER AllocationSize,
1383             ULONG FileAttributes,
1384             ULONG CreateDisposition,
1385             ULONG CreateOptions,
1386             const struct wim_dentry *dentry,
1387             struct win32_apply_ctx *ctx)
1388 {
1389         build_extraction_path(dentry, ctx);
1390         return do_create_file(FileHandle,
1391                               DesiredAccess,
1392                               AllocationSize,
1393                               FileAttributes,
1394                               CreateDisposition,
1395                               CreateOptions,
1396                               ctx);
1397 }
1398
1399 static int
1400 delete_file_or_stream(struct win32_apply_ctx *ctx)
1401 {
1402         NTSTATUS status;
1403         HANDLE h;
1404         ULONG perms = DELETE;
1405         ULONG flags = FILE_NON_DIRECTORY_FILE | FILE_DELETE_ON_CLOSE;
1406
1407         /* First try opening the file with FILE_DELETE_ON_CLOSE.  In most cases,
1408          * all we have to do is that plus close the file handle.  */
1409 retry:
1410         status = do_create_file(&h, perms, NULL, 0, FILE_OPEN, flags, ctx);
1411
1412         if (unlikely(status == STATUS_CANNOT_DELETE)) {
1413                 /* This error occurs for files with FILE_ATTRIBUTE_READONLY set.
1414                  * Try an alternate approach: first open the file without
1415                  * FILE_DELETE_ON_CLOSE, then reset the file attributes, then
1416                  * set the "delete" disposition on the handle.  */
1417                 if (flags & FILE_DELETE_ON_CLOSE) {
1418                         flags &= ~FILE_DELETE_ON_CLOSE;
1419                         perms |= FILE_WRITE_ATTRIBUTES;
1420                         goto retry;
1421                 }
1422         }
1423
1424         if (unlikely(!NT_SUCCESS(status))) {
1425                 winnt_error(status, L"Can't open \"%ls\" for deletion "
1426                             "(perms=%x, flags=%x)",
1427                             current_path(ctx), perms, flags);
1428                 return WIMLIB_ERR_OPEN;
1429         }
1430
1431         if (unlikely(!(flags & FILE_DELETE_ON_CLOSE))) {
1432
1433                 FILE_BASIC_INFORMATION basic_info =
1434                         { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1435                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1436                                                       &basic_info,
1437                                                       sizeof(basic_info),
1438                                                       FileBasicInformation);
1439
1440                 if (!NT_SUCCESS(status)) {
1441                         winnt_error(status, L"Can't reset attributes of \"%ls\" "
1442                                     "to prepare for deletion", current_path(ctx));
1443                         (*func_NtClose)(h);
1444                         return WIMLIB_ERR_SET_ATTRIBUTES;
1445                 }
1446
1447                 FILE_DISPOSITION_INFORMATION disp_info =
1448                         { .DoDeleteFile = TRUE };
1449                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1450                                                       &disp_info,
1451                                                       sizeof(disp_info),
1452                                                       FileDispositionInformation);
1453                 if (!NT_SUCCESS(status)) {
1454                         winnt_error(status, L"Can't set delete-on-close "
1455                                     "disposition on \"%ls\"", current_path(ctx));
1456                         (*func_NtClose)(h);
1457                         return WIMLIB_ERR_SET_ATTRIBUTES;
1458                 }
1459         }
1460
1461         status = (*func_NtClose)(h);
1462         if (unlikely(!NT_SUCCESS(status))) {
1463                 winnt_error(status, L"Error closing \"%ls\" after setting "
1464                             "delete-on-close disposition", current_path(ctx));
1465                 return WIMLIB_ERR_OPEN;
1466         }
1467
1468         return 0;
1469 }
1470
1471 /*
1472  * Create a nondirectory file or named data stream at the current path,
1473  * superseding any that already exists at that path.  If successful, return an
1474  * open handle to the file or named data stream.
1475  */
1476 static int
1477 supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
1478 {
1479         NTSTATUS status;
1480         bool retried = false;
1481
1482         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1483          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1484 retry:
1485         status = do_create_file(h_ret,
1486                                 GENERIC_READ | GENERIC_WRITE | DELETE,
1487                                 NULL,
1488                                 FILE_ATTRIBUTE_SYSTEM,
1489                                 FILE_CREATE,
1490                                 FILE_NON_DIRECTORY_FILE,
1491                                 ctx);
1492         if (likely(NT_SUCCESS(status)))
1493                 return 0;
1494
1495         /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
1496          * exists.  Delete the existing file or stream, then try again.
1497          *
1498          * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
1499          * problems with certain file attributes, especially
1500          * FILE_ATTRIBUTE_ENCRYPTED.  FILE_SUPERSEDE is also broken in the
1501          * Windows PE ramdisk.  */
1502         if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
1503                 int ret = delete_file_or_stream(ctx);
1504                 if (ret)
1505                         return ret;
1506                 retried = true;
1507                 goto retry;
1508         }
1509         winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
1510         return WIMLIB_ERR_OPEN;
1511 }
1512
1513 /* Set the reparse point @rpbuf of length @rpbuflen on the extracted file
1514  * corresponding to the WIM dentry @dentry.  */
1515 static int
1516 do_set_reparse_point(const struct wim_dentry *dentry,
1517                      const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
1518                      struct win32_apply_ctx *ctx)
1519 {
1520         NTSTATUS status;
1521         HANDLE h;
1522
1523         status = create_file(&h, GENERIC_WRITE, NULL,
1524                              0, FILE_OPEN, 0, dentry, ctx);
1525         if (!NT_SUCCESS(status))
1526                 goto fail;
1527
1528         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
1529                                          &ctx->iosb, FSCTL_SET_REPARSE_POINT,
1530                                          (void *)rpbuf, rpbuflen,
1531                                          NULL, 0);
1532         (*func_NtClose)(h);
1533
1534         if (NT_SUCCESS(status))
1535                 return 0;
1536
1537         /* On Windows, by default only the Administrator can create symbolic
1538          * links for some reason.  By default we just issue a warning if this
1539          * appears to be the problem.  Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
1540          * to get a hard error.  */
1541         if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
1542             && (status == STATUS_PRIVILEGE_NOT_HELD ||
1543                 status == STATUS_ACCESS_DENIED)
1544             && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
1545                 dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
1546         {
1547                 WARNING("Can't create symbolic link \"%ls\"!              \n"
1548                         "          (Need Administrator rights, or at least "
1549                         "the\n"
1550                         "          SeCreateSymbolicLink privilege.)",
1551                         current_path(ctx));
1552                 return 0;
1553         }
1554
1555 fail:
1556         winnt_error(status, L"Can't set reparse data on \"%ls\"",
1557                     current_path(ctx));
1558         return WIMLIB_ERR_SET_REPARSE_DATA;
1559 }
1560
1561 /*
1562  * Create empty named data streams and potentially a reparse point for the
1563  * specified file, if any.
1564  *
1565  * Since these won't have blob descriptors, they won't show up in the call to
1566  * extract_blob_list().  Hence the need for the special case.
1567  */
1568 static int
1569 create_empty_streams(const struct wim_dentry *dentry,
1570                      struct win32_apply_ctx *ctx)
1571 {
1572         const struct wim_inode *inode = dentry->d_inode;
1573         int ret;
1574
1575         for (unsigned i = 0; i < inode->i_num_streams; i++) {
1576                 const struct wim_inode_stream *strm = &inode->i_streams[i];
1577
1578                 if (stream_blob_resolved(strm) != NULL)
1579                         continue;
1580
1581                 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT &&
1582                     ctx->common.supported_features.reparse_points)
1583                 {
1584                         u8 buf[REPARSE_DATA_OFFSET] _aligned_attribute(8);
1585                         struct reparse_buffer_disk *rpbuf =
1586                                 (struct reparse_buffer_disk *)buf;
1587                         complete_reparse_point(rpbuf, inode, 0);
1588                         ret = do_set_reparse_point(dentry, rpbuf,
1589                                                    REPARSE_DATA_OFFSET, ctx);
1590                         if (ret)
1591                                 return ret;
1592                 } else if (stream_is_named_data_stream(strm) &&
1593                            ctx->common.supported_features.named_data_streams)
1594                 {
1595                         HANDLE h;
1596
1597                         build_extraction_path_with_ads(dentry, ctx,
1598                                                        strm->stream_name,
1599                                                        utf16le_len_chars(strm->stream_name));
1600                         ret = supersede_file_or_stream(ctx, &h);
1601
1602                         build_extraction_path(dentry, ctx);
1603
1604                         if (ret)
1605                                 return ret;
1606                         (*func_NtClose)(h);
1607                 }
1608         }
1609
1610         return 0;
1611 }
1612
1613 /*
1614  * Creates the directory named by @dentry, or uses an existing directory at that
1615  * location.  If necessary, sets the short name and/or fixes compression and
1616  * encryption attributes.
1617  *
1618  * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
1619  */
1620 static int
1621 create_directory(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
1622 {
1623         DWORD perms;
1624         NTSTATUS status;
1625         HANDLE h;
1626         int ret;
1627
1628         /* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
1629          * are needed for adjust_compression_attribute(); WRITE_DAC is needed to
1630          * remove the directory's DACL if the directory already existed  */
1631         perms = GENERIC_READ | GENERIC_WRITE | WRITE_DAC;
1632         if (!dentry_is_root(dentry))
1633                 perms |= DELETE;
1634
1635         /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
1636          * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be.  */
1637 retry:
1638         status = create_file(&h, perms, NULL, FILE_ATTRIBUTE_SYSTEM,
1639                              FILE_OPEN_IF, FILE_DIRECTORY_FILE, dentry, ctx);
1640         if (unlikely(!NT_SUCCESS(status))) {
1641                 if (status == STATUS_ACCESS_DENIED) {
1642                         if (perms & WRITE_DAC) {
1643                                 perms &= ~WRITE_DAC;
1644                                 goto retry;
1645                         }
1646                         if (perms & DELETE) {
1647                                 perms &= ~DELETE;
1648                                 goto retry;
1649                         }
1650                 }
1651                 const wchar_t *path = current_path(ctx);
1652                 winnt_error(status, L"Can't create directory \"%ls\"", path);
1653
1654                 /* Check for known issue with WindowsApps directory.  */
1655                 if (status == STATUS_ACCESS_DENIED &&
1656                     (wcsstr(path, L"\\WindowsApps\\") ||
1657                      wcsstr(path, L"\\InfusedApps\\"))) {
1658                         ERROR(
1659 "You seem to be trying to extract files to the WindowsApps directory.\n"
1660 "        Windows 8.1 and later use new file permissions in this directory that\n"
1661 "        cannot be overridden, even by backup/restore programs.  To extract your\n"
1662 "        files anyway, you need to choose a different target directory, delete\n"
1663 "        the WindowsApps directory entirely, reformat the volume, do the\n"
1664 "        extraction from a non-broken operating system such as Windows 7 or\n"
1665 "        Linux, or wait for Microsoft to fix the design flaw in their operating\n"
1666 "        system.  This is *not* a bug in wimlib.  See this thread for more\n"
1667 "        information: https://wimlib.net/forums/viewtopic.php?f=1&t=261");
1668                 }
1669                 return WIMLIB_ERR_MKDIR;
1670         }
1671
1672         if (ctx->iosb.Information == FILE_OPENED) {
1673                 /* If we opened an existing directory, try to clear its file
1674                  * attributes.  As far as I know, this only actually makes a
1675                  * difference in the case where a FILE_ATTRIBUTE_READONLY
1676                  * directory has a named data stream which needs to be
1677                  * extracted.  You cannot create a named data stream of such a
1678                  * directory, even though this contradicts Microsoft's
1679                  * documentation for FILE_ATTRIBUTE_READONLY which states it is
1680                  * not honored for directories!  */
1681                 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
1682                         FILE_BASIC_INFORMATION basic_info =
1683                                 { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
1684                         (*func_NtSetInformationFile)(h, &ctx->iosb, &basic_info,
1685                                                      sizeof(basic_info),
1686                                                      FileBasicInformation);
1687                 }
1688
1689                 /* Also try to remove the directory's DACL.  This isn't supposed
1690                  * to be necessary because we *always* use backup semantics.
1691                  * However, there is a case where NtCreateFile() fails with
1692                  * STATUS_ACCESS_DENIED when creating a named data stream that
1693                  * was just deleted, using a directory-relative open.  I have no
1694                  * idea why Windows is broken in this case.  */
1695                 if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)) {
1696                         static const SECURITY_DESCRIPTOR_RELATIVE desc = {
1697                                 .Revision = SECURITY_DESCRIPTOR_REVISION1,
1698                                 .Control = SE_SELF_RELATIVE | SE_DACL_PRESENT,
1699                                 .Owner = 0,
1700                                 .Group = 0,
1701                                 .Sacl = 0,
1702                                 .Dacl = 0,
1703                         };
1704                         (*func_NtSetSecurityObject)(h, DACL_SECURITY_INFORMATION,
1705                                                     (void *)&desc);
1706                 }
1707         }
1708
1709         if (!dentry_is_root(dentry)) {
1710                 ret = set_short_name(h, dentry, ctx);
1711                 if (ret)
1712                         goto out;
1713         }
1714
1715         ret = adjust_compression_attribute(h, dentry, ctx);
1716 out:
1717         (*func_NtClose)(h);
1718         return ret;
1719 }
1720
1721 /*
1722  * Create all the directories being extracted, other than the target directory
1723  * itself.
1724  *
1725  * Note: we don't honor directory hard links.  However, we don't allow them to
1726  * exist in WIM images anyway (see inode_fixup.c).
1727  */
1728 static int
1729 create_directories(struct list_head *dentry_list,
1730                    struct win32_apply_ctx *ctx)
1731 {
1732         const struct wim_dentry *dentry;
1733         int ret;
1734
1735         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1736
1737                 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
1738                         continue;
1739
1740                 /* Note: Here we include files with
1741                  * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
1742                  * wait until later to actually set the reparse data.  */
1743
1744                 ret = create_directory(dentry, ctx);
1745
1746                 if (!ret)
1747                         ret = create_empty_streams(dentry, ctx);
1748
1749                 ret = check_apply_error(dentry, ctx, ret);
1750                 if (ret)
1751                         return ret;
1752
1753                 ret = report_file_created(&ctx->common);
1754                 if (ret)
1755                         return ret;
1756         }
1757         return 0;
1758 }
1759
1760 /*
1761  * Creates the nondirectory file named by @dentry.
1762  *
1763  * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
1764  * GENERIC_WRITE, and DELETE access.  Also, the path to the file will be saved
1765  * in ctx->pathbuf.  On failure, returns an error code.
1766  */
1767 static int
1768 create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
1769                           struct win32_apply_ctx *ctx)
1770 {
1771         int ret;
1772         HANDLE h;
1773
1774         build_extraction_path(dentry, ctx);
1775
1776         ret = supersede_file_or_stream(ctx, &h);
1777         if (ret)
1778                 goto out;
1779
1780         ret = adjust_compression_attribute(h, dentry, ctx);
1781         if (ret)
1782                 goto out_close;
1783
1784         ret = create_empty_streams(dentry, ctx);
1785         if (ret)
1786                 goto out_close;
1787
1788         *h_ret = h;
1789         return 0;
1790
1791 out_close:
1792         (*func_NtClose)(h);
1793 out:
1794         return ret;
1795 }
1796
1797 /* Creates a hard link at the location named by @dentry to the file represented
1798  * by the open handle @h.  Or, if the target volume does not support hard links,
1799  * create a separate file instead.  */
1800 static int
1801 create_link(HANDLE h, const struct wim_dentry *dentry,
1802             struct win32_apply_ctx *ctx)
1803 {
1804         if (ctx->common.supported_features.hard_links) {
1805
1806                 build_extraction_path(dentry, ctx);
1807
1808                 size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
1809                                  ctx->pathbuf.Length + sizeof(wchar_t);
1810                 u8 buf[bufsize] _aligned_attribute(8);
1811                 FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
1812                 NTSTATUS status;
1813
1814                 info->ReplaceIfExists = TRUE;
1815                 info->RootDirectory = ctx->attr.RootDirectory;
1816                 info->FileNameLength = ctx->pathbuf.Length;
1817                 memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
1818                 info->FileName[info->FileNameLength / 2] = L'\0';
1819
1820                 /* Note: the null terminator isn't actually necessary,
1821                  * but if you don't add the extra character, you get
1822                  * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
1823                  * happens to be 2  */
1824
1825                 status = (*func_NtSetInformationFile)(h, &ctx->iosb,
1826                                                       info, bufsize,
1827                                                       FileLinkInformation);
1828                 if (NT_SUCCESS(status))
1829                         return 0;
1830                 winnt_error(status, L"Failed to create link \"%ls\"",
1831                             current_path(ctx));
1832                 return WIMLIB_ERR_LINK;
1833         } else {
1834                 HANDLE h2;
1835                 int ret;
1836
1837                 ret = create_nondirectory_inode(&h2, dentry, ctx);
1838                 if (ret)
1839                         return ret;
1840
1841                 (*func_NtClose)(h2);
1842                 return 0;
1843         }
1844 }
1845
1846 /* Given an inode (represented by the open handle @h) for which one link has
1847  * been created (named by @first_dentry), create the other links.
1848  *
1849  * Or, if the target volume does not support hard links, create separate files.
1850  *
1851  * Note: This uses ctx->pathbuf and does not reset it.
1852  */
1853 static int
1854 create_links(HANDLE h, const struct wim_dentry *first_dentry,
1855              struct win32_apply_ctx *ctx)
1856 {
1857         const struct wim_inode *inode = first_dentry->d_inode;
1858         const struct wim_dentry *dentry;
1859         int ret;
1860
1861         inode_for_each_extraction_alias(dentry, inode) {
1862                 if (dentry != first_dentry) {
1863                         ret = create_link(h, dentry, ctx);
1864                         if (ret)
1865                                 return ret;
1866                 }
1867         }
1868         return 0;
1869 }
1870
1871 /* Create a nondirectory file, including all links.  */
1872 static int
1873 create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
1874 {
1875         struct wim_dentry *first_dentry;
1876         HANDLE h;
1877         int ret;
1878
1879         first_dentry = first_extraction_alias(inode);
1880
1881         /* Create first link.  */
1882         ret = create_nondirectory_inode(&h, first_dentry, ctx);
1883         if (ret)
1884                 return ret;
1885
1886         /* Set short name.  */
1887         ret = set_short_name(h, first_dentry, ctx);
1888
1889         /* Create additional links, OR if hard links are not supported just
1890          * create more files.  */
1891         if (!ret)
1892                 ret = create_links(h, first_dentry, ctx);
1893
1894         /* "WIMBoot" extraction: set external backing by the WIM file if needed.  */
1895         if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
1896                 ret = set_backed_from_wim(h, inode, ctx);
1897
1898         (*func_NtClose)(h);
1899         return ret;
1900 }
1901
1902 /* Create all the nondirectory files being extracted, including all aliases
1903  * (hard links).  */
1904 static int
1905 create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
1906 {
1907         struct wim_dentry *dentry;
1908         struct wim_inode *inode;
1909         int ret;
1910
1911         list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
1912                 inode = dentry->d_inode;
1913                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
1914                         continue;
1915                 /* Call create_nondirectory() only once per inode  */
1916                 if (dentry == inode_first_extraction_dentry(inode)) {
1917                         ret = create_nondirectory(inode, ctx);
1918                         ret = check_apply_error(dentry, ctx, ret);
1919                         if (ret)
1920                                 return ret;
1921                 }
1922                 ret = report_file_created(&ctx->common);
1923                 if (ret)
1924                         return ret;
1925         }
1926         return 0;
1927 }
1928
1929 static void
1930 close_handles(struct win32_apply_ctx *ctx)
1931 {
1932         for (unsigned i = 0; i < ctx->num_open_handles; i++)
1933                 (*func_NtClose)(ctx->open_handles[i]);
1934 }
1935
1936 /* Prepare to read the next blob, which has size @blob_size, into an in-memory
1937  * buffer.  */
1938 static bool
1939 prepare_data_buffer(struct win32_apply_ctx *ctx, u64 blob_size)
1940 {
1941         if (blob_size > ctx->data_buffer_size) {
1942                 /* Larger buffer needed.  */
1943                 void *new_buffer;
1944                 if ((size_t)blob_size != blob_size)
1945                         return false;
1946                 new_buffer = REALLOC(ctx->data_buffer, blob_size);
1947                 if (!new_buffer)
1948                         return false;
1949                 ctx->data_buffer = new_buffer;
1950                 ctx->data_buffer_size = blob_size;
1951         }
1952         /* On the first call this changes data_buffer_ptr from NULL, which tells
1953          * extract_chunk() that the data buffer needs to be filled while reading
1954          * the stream data.  */
1955         ctx->data_buffer_ptr = ctx->data_buffer;
1956         return true;
1957 }
1958
1959 static int
1960 begin_extract_blob_instance(const struct blob_descriptor *blob,
1961                             struct wim_dentry *dentry,
1962                             const struct wim_inode_stream *strm,
1963                             struct win32_apply_ctx *ctx)
1964 {
1965         FILE_ALLOCATION_INFORMATION alloc_info;
1966         HANDLE h;
1967         NTSTATUS status;
1968
1969         if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
1970                 /* We can't write the reparse point stream directly; we must set
1971                  * it with FSCTL_SET_REPARSE_POINT, which requires that all the
1972                  * data be available.  So, stage the data in a buffer.  */
1973                 if (!prepare_data_buffer(ctx, blob->size))
1974                         return WIMLIB_ERR_NOMEM;
1975                 list_add_tail(&dentry->d_tmp_list, &ctx->reparse_dentries);
1976                 return 0;
1977         }
1978
1979         if (unlikely(strm->stream_type == STREAM_TYPE_EFSRPC_RAW_DATA)) {
1980                 /* We can't write encrypted files directly; we must use
1981                  * WriteEncryptedFileRaw(), which requires providing the data
1982                  * through a callback function.  This can't easily be combined
1983                  * with our own callback-based approach.
1984                  *
1985                  * The current workaround is to simply read the blob into memory
1986                  * and write the encrypted file from that.
1987                  *
1988                  * TODO: This isn't sufficient for extremely large encrypted
1989                  * files.  Perhaps we should create an extra thread to write
1990                  * such files...  */
1991                 if (!prepare_data_buffer(ctx, blob->size))
1992                         return WIMLIB_ERR_NOMEM;
1993                 list_add_tail(&dentry->d_tmp_list, &ctx->encrypted_dentries);
1994                 return 0;
1995         }
1996
1997         /* It's a data stream (may be unnamed or named).  */
1998         wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
1999
2000         if (ctx->num_open_handles == MAX_OPEN_FILES) {
2001                 /* XXX: Fix this.  But because of the checks in
2002                  * extract_blob_list(), this can now only happen on a filesystem
2003                  * that does not support hard links.  */
2004                 ERROR("Can't extract data: too many open files!");
2005                 return WIMLIB_ERR_UNSUPPORTED;
2006         }
2007
2008
2009         if (unlikely(stream_is_named(strm))) {
2010                 build_extraction_path_with_ads(dentry, ctx,
2011                                                strm->stream_name,
2012                                                utf16le_len_chars(strm->stream_name));
2013         } else {
2014                 build_extraction_path(dentry, ctx);
2015         }
2016
2017
2018         /* Open a new handle  */
2019         status = do_create_file(&h,
2020                                 FILE_WRITE_DATA | SYNCHRONIZE,
2021                                 NULL, 0, FILE_OPEN_IF,
2022                                 FILE_SEQUENTIAL_ONLY |
2023                                         FILE_SYNCHRONOUS_IO_NONALERT,
2024                                 ctx);
2025         if (!NT_SUCCESS(status)) {
2026                 winnt_error(status, L"Can't open \"%ls\" for writing",
2027                             current_path(ctx));
2028                 return WIMLIB_ERR_OPEN;
2029         }
2030
2031         ctx->open_handles[ctx->num_open_handles++] = h;
2032
2033         /* Allocate space for the data.  */
2034         alloc_info.AllocationSize.QuadPart = blob->size;
2035         (*func_NtSetInformationFile)(h, &ctx->iosb,
2036                                      &alloc_info, sizeof(alloc_info),
2037                                      FileAllocationInformation);
2038         return 0;
2039 }
2040
2041 /* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
2042  * pointer to the suffix of the path that begins with the device directly, such
2043  * as e:\Windows\System32.  */
2044 static const wchar_t *
2045 skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
2046 {
2047         static const wchar_t * const dirs[] = {
2048                 L"\\??\\",
2049                 L"\\DosDevices\\",
2050                 L"\\Device\\",
2051         };
2052         const wchar_t * const end = path + path_nchars;
2053
2054         for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
2055                 size_t len = wcslen(dirs[i]);
2056                 if (len <= (end - path) && !wmemcmp(path, dirs[i], len)) {
2057                         path += len;
2058                         while (path != end && *path == L'\\')
2059                                 path++;
2060                         return path;
2061                 }
2062         }
2063         return path;
2064 }
2065
2066 /*
2067  * Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
2068  * pointer to the suffix of the path that is device-relative but possibly with
2069  * leading slashes, such as \Windows\System32.
2070  *
2071  * The path has an explicit length and is not necessarily null terminated.
2072  */
2073 static const wchar_t *
2074 get_device_relative_path(const wchar_t *path, size_t path_nchars)
2075 {
2076         const wchar_t * const orig_path = path;
2077         const wchar_t * const end = path + path_nchars;
2078
2079         path = skip_nt_toplevel_component(path, path_nchars);
2080         if (path == orig_path)
2081                 return orig_path;
2082
2083         while (path != end && *path != L'\\')
2084                 path++;
2085
2086         return path;
2087 }
2088
2089 /*
2090  * Given a reparse point buffer for an inode for which the absolute link target
2091  * was relativized when it was archived, de-relative the link target to be
2092  * consistent with the actual extraction location.
2093  */
2094 static void
2095 try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p,
2096           struct win32_apply_ctx *ctx)
2097 {
2098         struct link_reparse_point link;
2099         size_t orig_subst_name_nchars;
2100         const wchar_t *relpath;
2101         size_t relpath_nchars;
2102         size_t target_ntpath_nchars;
2103         size_t fixed_subst_name_nchars;
2104         const wchar_t *fixed_print_name;
2105         size_t fixed_print_name_nchars;
2106
2107         /* Do nothing if the reparse data is invalid.  */
2108         if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link))
2109                 return;
2110
2111         /* Do nothing if the reparse point is a relative symbolic link.  */
2112         if (link_is_relative_symlink(&link))
2113                 return;
2114
2115         /* Build the new substitute name from the NT namespace path to the
2116          * target directory, then a path separator, then the "device relative"
2117          * part of the old substitute name.  */
2118
2119         orig_subst_name_nchars = link.substitute_name_nbytes / sizeof(wchar_t);
2120
2121         relpath = get_device_relative_path(link.substitute_name,
2122                                            orig_subst_name_nchars);
2123         relpath_nchars = orig_subst_name_nchars -
2124                          (relpath - link.substitute_name);
2125
2126         target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
2127
2128         /* If the target directory is a filesystem root, such as \??\C:\, then
2129          * it already will have a trailing slash.  Don't include this slash if
2130          * we are already adding slashes via 'relpath'.  This prevents an extra
2131          * slash from being generated each time the link is extracted.  And
2132          * unlike on UNIX, the number of slashes in paths on Windows can be
2133          * significant; Windows won't understand the link target if it contains
2134          * too many slashes.  */
2135         if (target_ntpath_nchars > 0 && relpath_nchars > 0 &&
2136             ctx->target_ntpath.Buffer[target_ntpath_nchars - 1] == L'\\')
2137                 target_ntpath_nchars--;
2138
2139         /* Also remove extra slashes from the beginning of 'relpath'.  Normally
2140          * this isn't needed, but this is here to make the extra slash(es) added
2141          * by wimlib pre-v1.9.1 get removed automatically.  */
2142         while (relpath_nchars >= 2 &&
2143                relpath[0] == L'\\' && relpath[1] == L'\\') {
2144                 relpath++;
2145                 relpath_nchars--;
2146         }
2147
2148         fixed_subst_name_nchars = target_ntpath_nchars + relpath_nchars;
2149
2150         wchar_t fixed_subst_name[fixed_subst_name_nchars];
2151
2152         wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer, target_ntpath_nchars);
2153         wmemcpy(&fixed_subst_name[target_ntpath_nchars], relpath, relpath_nchars);
2154         /* Doesn't need to be null-terminated.  */
2155
2156         /* Print name should be Win32, but not all NT names can even be
2157          * translated to Win32 names.  But we can at least delete the top-level
2158          * directory, such as \??\, and this will have the expected result in
2159          * the usual case.  */
2160         fixed_print_name = skip_nt_toplevel_component(fixed_subst_name,
2161                                                       fixed_subst_name_nchars);
2162         fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
2163                                                              fixed_subst_name);
2164
2165         link.substitute_name = fixed_subst_name;
2166         link.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
2167         link.print_name = (wchar_t *)fixed_print_name;
2168         link.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
2169         make_link_reparse_point(&link, rpbuf, rpbuflen_p);
2170 }
2171
2172 /* Sets the reparse point on the specified file.  This handles "fixing" the
2173  * targets of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX
2174  * was specified.  */
2175 static int
2176 set_reparse_point(const struct wim_dentry *dentry,
2177                   const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
2178                   struct win32_apply_ctx *ctx)
2179 {
2180         if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
2181             && !(dentry->d_inode->i_rp_flags & WIM_RP_FLAG_NOT_FIXED))
2182         {
2183                 memcpy(&ctx->rpfixbuf, rpbuf, rpbuflen);
2184                 try_rpfix(&ctx->rpfixbuf, &rpbuflen, ctx);
2185                 rpbuf = &ctx->rpfixbuf;
2186         }
2187         return do_set_reparse_point(dentry, rpbuf, rpbuflen, ctx);
2188
2189 }
2190
2191 /* Import the next block of raw encrypted data  */
2192 static DWORD WINAPI
2193 import_encrypted_data(PBYTE pbData, PVOID pvCallbackContext, PULONG Length)
2194 {
2195         struct win32_apply_ctx *ctx = pvCallbackContext;
2196         ULONG copy_len;
2197
2198         copy_len = min(ctx->encrypted_size - ctx->encrypted_offset, *Length);
2199         memcpy(pbData, &ctx->data_buffer[ctx->encrypted_offset], copy_len);
2200         ctx->encrypted_offset += copy_len;
2201         *Length = copy_len;
2202         return ERROR_SUCCESS;
2203 }
2204
2205 /*
2206  * Write the raw encrypted data to the already-created file (or directory)
2207  * corresponding to @dentry.
2208  *
2209  * The raw encrypted data is provided in ctx->data_buffer, and its size is
2210  * ctx->encrypted_size.
2211  *
2212  * This function may close the target directory, in which case the caller needs
2213  * to re-open it if needed.
2214  */
2215 static int
2216 extract_encrypted_file(const struct wim_dentry *dentry,
2217                        struct win32_apply_ctx *ctx)
2218 {
2219         void *rawctx;
2220         DWORD err;
2221         ULONG flags;
2222         bool retried;
2223
2224         /* Temporarily build a Win32 path for OpenEncryptedFileRaw()  */
2225         build_win32_extraction_path(dentry, ctx);
2226
2227         flags = CREATE_FOR_IMPORT | OVERWRITE_HIDDEN;
2228         if (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
2229                 flags |= CREATE_FOR_DIR;
2230
2231         retried = false;
2232 retry:
2233         err = OpenEncryptedFileRaw(ctx->pathbuf.Buffer, flags, &rawctx);
2234         if (err == ERROR_SHARING_VIOLATION && !retried) {
2235                 /* This can be caused by the handle we have open to the target
2236                  * directory.  Try closing it temporarily.  */
2237                 close_target_directory(ctx);
2238                 retried = true;
2239                 goto retry;
2240         }
2241
2242         /* Restore the NT namespace path  */
2243         build_extraction_path(dentry, ctx);
2244
2245         if (err != ERROR_SUCCESS) {
2246                 win32_error(err, L"Can't open \"%ls\" for encrypted import",
2247                             current_path(ctx));
2248                 return WIMLIB_ERR_OPEN;
2249         }
2250
2251         ctx->encrypted_offset = 0;
2252
2253         err = WriteEncryptedFileRaw(import_encrypted_data, ctx, rawctx);
2254
2255         CloseEncryptedFileRaw(rawctx);
2256
2257         if (err != ERROR_SUCCESS) {
2258                 win32_error(err, L"Can't import encrypted file \"%ls\"",
2259                             current_path(ctx));
2260                 return WIMLIB_ERR_WRITE;
2261         }
2262
2263         return 0;
2264 }
2265
2266 /* Called when starting to read a blob for extraction on Windows  */
2267 static int
2268 begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
2269 {
2270         struct win32_apply_ctx *ctx = _ctx;
2271         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2272         int ret;
2273
2274         ctx->num_open_handles = 0;
2275         ctx->data_buffer_ptr = NULL;
2276         INIT_LIST_HEAD(&ctx->reparse_dentries);
2277         INIT_LIST_HEAD(&ctx->encrypted_dentries);
2278
2279         for (u32 i = 0; i < blob->out_refcnt; i++) {
2280                 const struct wim_inode *inode = targets[i].inode;
2281                 const struct wim_inode_stream *strm = targets[i].stream;
2282                 struct wim_dentry *dentry;
2283
2284                 /* A copy of the blob needs to be extracted to @inode.  */
2285
2286                 if (ctx->common.supported_features.hard_links) {
2287                         dentry = inode_first_extraction_dentry(inode);
2288                         ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2289                         ret = check_apply_error(dentry, ctx, ret);
2290                         if (ret)
2291                                 goto fail;
2292                 } else {
2293                         /* Hard links not supported.  Extract the blob
2294                          * separately to each alias of the inode.  */
2295                         inode_for_each_extraction_alias(dentry, inode) {
2296                                 ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
2297                                 ret = check_apply_error(dentry, ctx, ret);
2298                                 if (ret)
2299                                         goto fail;
2300                         }
2301                 }
2302         }
2303
2304         return 0;
2305
2306 fail:
2307         close_handles(ctx);
2308         return ret;
2309 }
2310
2311 /* Called when the next chunk of a blob has been read for extraction on Windows
2312  */
2313 static int
2314 extract_chunk(const void *chunk, size_t size, void *_ctx)
2315 {
2316         struct win32_apply_ctx *ctx = _ctx;
2317
2318         /* Write the data chunk to each open handle  */
2319         for (unsigned i = 0; i < ctx->num_open_handles; i++) {
2320                 u8 *bufptr = (u8 *)chunk;
2321                 size_t bytes_remaining = size;
2322                 NTSTATUS status;
2323                 while (bytes_remaining) {
2324                         ULONG count = min(0xFFFFFFFF, bytes_remaining);
2325
2326                         status = (*func_NtWriteFile)(ctx->open_handles[i],
2327                                                      NULL, NULL, NULL,
2328                                                      &ctx->iosb, bufptr, count,
2329                                                      NULL, NULL);
2330                         if (!NT_SUCCESS(status)) {
2331                                 winnt_error(status, L"Error writing data to target volume");
2332                                 return WIMLIB_ERR_WRITE;
2333                         }
2334                         bufptr += ctx->iosb.Information;
2335                         bytes_remaining -= ctx->iosb.Information;
2336                 }
2337         }
2338
2339         /* Copy the data chunk into the buffer (if needed)  */
2340         if (ctx->data_buffer_ptr)
2341                 ctx->data_buffer_ptr = mempcpy(ctx->data_buffer_ptr,
2342                                                chunk, size);
2343         return 0;
2344 }
2345
2346 static int
2347 get_system_compression_format(int extract_flags)
2348 {
2349         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K)
2350                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2351
2352         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K)
2353                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K;
2354
2355         if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K)
2356                 return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K;
2357
2358         return FILE_PROVIDER_COMPRESSION_FORMAT_LZX;
2359 }
2360
2361
2362 static const wchar_t *
2363 get_system_compression_format_string(int format)
2364 {
2365         switch (format) {
2366         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K:
2367                 return L"XPRESS4K";
2368         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K:
2369                 return L"XPRESS8K";
2370         case FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K:
2371                 return L"XPRESS16K";
2372         default:
2373                 return L"LZX";
2374         }
2375 }
2376
2377 static NTSTATUS
2378 set_system_compression(HANDLE h, int format)
2379 {
2380         NTSTATUS status;
2381         IO_STATUS_BLOCK iosb;
2382         struct {
2383                 struct wof_external_info wof_info;
2384                 struct file_provider_external_info file_info;
2385         } in = {
2386                 .wof_info = {
2387                         .version = WOF_CURRENT_VERSION,
2388                         .provider = WOF_PROVIDER_FILE,
2389                 },
2390                 .file_info = {
2391                         .version = FILE_PROVIDER_CURRENT_VERSION,
2392                         .compression_format = format,
2393                 },
2394         };
2395
2396         /* We intentionally use NtFsControlFile() rather than DeviceIoControl()
2397          * here because the "compressing this object would not save space"
2398          * status code does not map to a valid Win32 error code on older
2399          * versions of Windows (before Windows 10?).  This can be a problem if
2400          * the WOFADK driver is being used rather than the regular WOF, since
2401          * WOFADK can be used on older versions of Windows.  */
2402         status = (*func_NtFsControlFile)(h, NULL, NULL, NULL, &iosb,
2403                                          FSCTL_SET_EXTERNAL_BACKING,
2404                                          &in, sizeof(in), NULL, 0);
2405
2406         if (status == 0xC000046F) /* "Compressing this object would not save space."  */
2407                 return STATUS_SUCCESS;
2408
2409         return status;
2410 }
2411
2412 /* Hard-coded list of files which the Windows bootloader may need to access
2413  * before the WOF driver has been loaded.  */
2414 static wchar_t *bootloader_pattern_strings[] = {
2415         L"*winload.*",
2416         L"*winresume.*",
2417         L"\\Windows\\AppPatch\\drvmain.sdb",
2418         L"\\Windows\\Boot\\DVD\\*",
2419         L"\\Windows\\Boot\\EFI\\*",
2420         L"\\Windows\\bootstat.dat",
2421         L"\\Windows\\Fonts\\vgaoem.fon",
2422         L"\\Windows\\Fonts\\vgasys.fon",
2423         L"\\Windows\\INF\\errata.inf",
2424         L"\\Windows\\System32\\config\\*",
2425         L"\\Windows\\System32\\ntkrnlpa.exe",
2426         L"\\Windows\\System32\\ntoskrnl.exe",
2427         L"\\Windows\\System32\\bootvid.dll",
2428         L"\\Windows\\System32\\ci.dll",
2429         L"\\Windows\\System32\\hal*.dll",
2430         L"\\Windows\\System32\\mcupdate_AuthenticAMD.dll",
2431         L"\\Windows\\System32\\mcupdate_GenuineIntel.dll",
2432         L"\\Windows\\System32\\pshed.dll",
2433         L"\\Windows\\System32\\apisetschema.dll",
2434         L"\\Windows\\System32\\api-ms-win*.dll",
2435         L"\\Windows\\System32\\ext-ms-win*.dll",
2436         L"\\Windows\\System32\\KernelBase.dll",
2437         L"\\Windows\\System32\\drivers\\*.sys",
2438         L"\\Windows\\System32\\*.nls",
2439         L"\\Windows\\System32\\kbd*.dll",
2440         L"\\Windows\\System32\\kd*.dll",
2441         L"\\Windows\\System32\\clfs.sys",
2442         L"\\Windows\\System32\\CodeIntegrity\\driver.stl",
2443 };
2444
2445 static const struct string_set bootloader_patterns = {
2446         .strings = bootloader_pattern_strings,
2447         .num_strings = ARRAY_LEN(bootloader_pattern_strings),
2448 };
2449
2450 static NTSTATUS
2451 set_system_compression_on_inode(struct wim_inode *inode, int format,
2452                                 struct win32_apply_ctx *ctx)
2453 {
2454         bool retried = false;
2455         NTSTATUS status;
2456         HANDLE h;
2457
2458         /* If it may be needed for compatibility with the Windows bootloader,
2459          * force this file to XPRESS4K or uncompressed format.  The bootloader
2460          * of Windows 10 supports XPRESS4K only; older versions don't support
2461          * system compression at all.  */
2462         if (!is_image_windows_10_or_later(ctx) ||
2463             format != FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K)
2464         {
2465                 /* We need to check the patterns against every name of the
2466                  * inode, in case any of them match.  */
2467                 struct wim_dentry *dentry;
2468                 inode_for_each_extraction_alias(dentry, inode) {
2469                         bool incompatible;
2470                         bool warned;
2471
2472                         if (calculate_dentry_full_path(dentry)) {
2473                                 ERROR("Unable to compute file path!");
2474                                 return STATUS_NO_MEMORY;
2475                         }
2476
2477                         incompatible = match_pattern_list(dentry->d_full_path,
2478                                                           &bootloader_patterns);
2479                         FREE(dentry->d_full_path);
2480                         dentry->d_full_path = NULL;
2481
2482                         if (!incompatible)
2483                                 continue;
2484
2485                         warned = (ctx->num_system_compression_exclusions++ > 0);
2486
2487                         if (is_image_windows_10_or_later(ctx)) {
2488                                 /* Force to XPRESS4K  */
2489                                 if (!warned) {
2490                                         WARNING("For compatibility with the "
2491                                                 "Windows bootloader, some "
2492                                                 "files are being\n"
2493                                                 "          compacted "
2494                                                 "using the XPRESS4K format "
2495                                                 "instead of the %"TS" format\n"
2496                                                 "          you requested.",
2497                                                 get_system_compression_format_string(format));
2498                                 }
2499                                 format = FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
2500                                 break;
2501                         } else {
2502                                 /* Force to uncompressed  */
2503                                 if (!warned) {
2504                                         WARNING("For compatibility with the "
2505                                                 "Windows bootloader, some "
2506                                                 "files will not\n"
2507                                                 "          be compressed with"
2508                                                 " system compression "
2509                                                 "(\"compacted\").");
2510                                 }
2511                                 return STATUS_SUCCESS;
2512                         }
2513
2514                 }
2515         }
2516
2517         /* Open the extracted file.  */
2518         status = create_file(&h, GENERIC_READ | GENERIC_WRITE, NULL,
2519                              0, FILE_OPEN, 0,
2520                              inode_first_extraction_dentry(inode), ctx);
2521
2522         if (!NT_SUCCESS(status))
2523                 return status;
2524 retry:
2525         /* Compress the file.  If the attempt fails with "invalid device
2526          * request", then attach wof.sys (or wofadk.sys) and retry.  */
2527         status = set_system_compression(h, format);
2528         if (unlikely(status == STATUS_INVALID_DEVICE_REQUEST && !retried)) {
2529                 wchar_t drive_path[7];
2530                 if (!win32_get_drive_path(ctx->common.target, drive_path) &&
2531                     win32_try_to_attach_wof(drive_path + 4)) {
2532                         retried = true;
2533                         goto retry;
2534                 }
2535         }
2536
2537         (*func_NtClose)(h);
2538         return status;
2539 }
2540
2541 /*
2542  * This function is called when doing a "compact-mode" extraction and we just
2543  * finished extracting a blob to one or more locations.  For each location that
2544  * was the unnamed data stream of a file, this function compresses the
2545  * corresponding file using System Compression, if allowed.
2546  *
2547  * Note: we're doing the compression immediately after extracting the data
2548  * rather than during a separate compression pass.  This way should be faster
2549  * since the operating system should still have the file's data cached.
2550  *
2551  * Note: we're having the operating system do the compression, which is not
2552  * ideal because wimlib could create the compressed data faster and more
2553  * efficiently (the compressed data format is identical to a WIM resource).  But
2554  * we seemingly don't have a choice because WOF prevents applications from
2555  * creating its reparse points.
2556  */
2557 static void
2558 handle_system_compression(struct blob_descriptor *blob, struct win32_apply_ctx *ctx)
2559 {
2560         const struct blob_extraction_target *targets = blob_extraction_targets(blob);
2561
2562         const int format = get_system_compression_format(ctx->common.extract_flags);
2563
2564         for (u32 i = 0; i < blob->out_refcnt; i++) {
2565                 struct wim_inode *inode = targets[i].inode;
2566                 struct wim_inode_stream *strm = targets[i].stream;
2567                 NTSTATUS status;
2568
2569                 if (!stream_is_unnamed_data_stream(strm))
2570                         continue;
2571
2572                 if (will_externally_back_inode(inode, ctx, NULL, false) != 0)
2573                         continue;
2574
2575                 status = set_system_compression_on_inode(inode, format, ctx);
2576                 if (likely(NT_SUCCESS(status)))
2577                         continue;
2578
2579                 if (status == STATUS_INVALID_DEVICE_REQUEST) {
2580                         WARNING(
2581           "The request to compress the extracted files using System Compression\n"
2582 "          will not be honored because the operating system or target volume\n"
2583 "          does not support it.  System Compression is only supported on\n"
2584 "          Windows 10 and later, and only on NTFS volumes.");
2585                         ctx->common.extract_flags &= ~COMPACT_FLAGS;
2586                         return;
2587                 }
2588
2589                 ctx->num_system_compression_failures++;
2590                 if (ctx->num_system_compression_failures < 10) {
2591                         winnt_warning(status, L"\"%ls\": Failed to compress "
2592                                       "extracted file using System Compression",
2593                                       current_path(ctx));
2594                 } else if (ctx->num_system_compression_failures == 10) {
2595                         WARNING("Suppressing further warnings about "
2596                                 "System Compression failures.");
2597                 }
2598         }
2599 }
2600
2601 /* Called when a blob has been fully read for extraction on Windows  */
2602 static int
2603 end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
2604 {
2605         struct win32_apply_ctx *ctx = _ctx;
2606         int ret;
2607         const struct wim_dentry *dentry;
2608
2609         close_handles(ctx);
2610
2611         if (status)
2612                 return status;
2613
2614         if (unlikely(ctx->common.extract_flags & COMPACT_FLAGS))
2615                 handle_system_compression(blob, ctx);
2616
2617         if (likely(!ctx->data_buffer_ptr))
2618                 return 0;
2619
2620         if (!list_empty(&ctx->reparse_dentries)) {
2621                 if (blob->size > REPARSE_DATA_MAX_SIZE) {
2622                         dentry = list_first_entry(&ctx->reparse_dentries,
2623                                                   struct wim_dentry, d_tmp_list);
2624                         build_extraction_path(dentry, ctx);
2625                         ERROR("Reparse data of \"%ls\" has size "
2626                               "%"PRIu64" bytes (exceeds %u bytes)",
2627                               current_path(ctx), blob->size,
2628                               REPARSE_DATA_MAX_SIZE);
2629                         ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
2630                         return check_apply_error(dentry, ctx, ret);
2631                 }
2632                 /* Reparse data  */
2633                 memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, blob->size);
2634
2635                 list_for_each_entry(dentry, &ctx->reparse_dentries, d_tmp_list) {
2636
2637                         /* Reparse point header  */
2638                         complete_reparse_point(&ctx->rpbuf, dentry->d_inode,
2639                                                blob->size);
2640
2641                         ret = set_reparse_point(dentry, &ctx->rpbuf,
2642                                                 REPARSE_DATA_OFFSET + blob->size,
2643                                                 ctx);
2644                         ret = check_apply_error(dentry, ctx, ret);
2645                         if (ret)
2646                                 return ret;
2647                 }
2648         }
2649
2650         if (!list_empty(&ctx->encrypted_dentries)) {
2651                 ctx->encrypted_size = blob->size;
2652                 list_for_each_entry(dentry, &ctx->encrypted_dentries, d_tmp_list) {
2653                         ret = extract_encrypted_file(dentry, ctx);
2654                         ret = check_apply_error(dentry, ctx, ret);
2655                         if (ret)
2656                                 return ret;
2657                         /* Re-open the target directory if needed.  */
2658                         ret = open_target_directory(ctx);
2659                         if (ret)
2660                                 return ret;
2661                 }
2662         }
2663
2664         return 0;
2665 }
2666
2667 /* Attributes that can't be set directly  */
2668 #define SPECIAL_ATTRIBUTES                      \
2669         (FILE_ATTRIBUTE_REPARSE_POINT   |       \
2670          FILE_ATTRIBUTE_DIRECTORY       |       \
2671          FILE_ATTRIBUTE_ENCRYPTED       |       \
2672          FILE_ATTRIBUTE_SPARSE_FILE     |       \
2673          FILE_ATTRIBUTE_COMPRESSED)
2674
2675 /* Set the security descriptor @desc, of @desc_size bytes, on the file with open
2676  * handle @h.  */
2677 static NTSTATUS
2678 set_security_descriptor(HANDLE h, const void *_desc,
2679                         size_t desc_size, struct win32_apply_ctx *ctx)
2680 {
2681         SECURITY_INFORMATION info;
2682         NTSTATUS status;
2683         SECURITY_DESCRIPTOR_RELATIVE *desc;
2684
2685         /*
2686          * Ideally, we would just pass in the security descriptor buffer as-is.
2687          * But it turns out that Windows can mess up the security descriptor
2688          * even when using the low-level NtSetSecurityObject() function:
2689          *
2690          * - Windows will clear SE_DACL_AUTO_INHERITED if it is set in the
2691          *   passed buffer.  To actually get Windows to set
2692          *   SE_DACL_AUTO_INHERITED, the application must set the non-persistent
2693          *   flag SE_DACL_AUTO_INHERIT_REQ.  As usual, Microsoft didn't bother
2694          *   to properly document either of these flags.  It's unclear how
2695          *   important SE_DACL_AUTO_INHERITED actually is, but to be safe we use
2696          *   the SE_DACL_AUTO_INHERIT_REQ workaround to set it if needed.
2697          *
2698          * - The above also applies to the equivalent SACL flags,
2699          *   SE_SACL_AUTO_INHERITED and SE_SACL_AUTO_INHERIT_REQ.
2700          *
2701          * - If the application says that it's setting
2702          *   DACL_SECURITY_INFORMATION, then Windows sets SE_DACL_PRESENT in the
2703          *   resulting security descriptor, even if the security descriptor the
2704          *   application provided did not have a DACL.  This seems to be
2705          *   unavoidable, since omitting DACL_SECURITY_INFORMATION would cause a
2706          *   default DACL to remain.  Fortunately, this behavior seems harmless,
2707          *   since the resulting DACL will still be "null" --- but it will be
2708          *   "the other representation of null".
2709          *
2710          * - The above also applies to SACL_SECURITY_INFORMATION and
2711          *   SE_SACL_PRESENT.  Again, it's seemingly unavoidable but "harmless"
2712          *   that Windows changes the representation of a "null SACL".
2713          */
2714         if (likely(desc_size <= STACK_MAX)) {
2715                 desc = alloca(desc_size);
2716         } else {
2717                 desc = MALLOC(desc_size);
2718                 if (!desc)
2719                         return STATUS_NO_MEMORY;
2720         }
2721
2722         memcpy(desc, _desc, desc_size);
2723
2724         if (likely(desc_size >= 4)) {
2725
2726                 if (desc->Control & SE_DACL_AUTO_INHERITED)
2727                         desc->Control |= SE_DACL_AUTO_INHERIT_REQ;
2728
2729                 if (desc->Control & SE_SACL_AUTO_INHERITED)
2730                         desc->Control |= SE_SACL_AUTO_INHERIT_REQ;
2731         }
2732
2733         /*
2734          * More API insanity.  We want to set the entire security descriptor
2735          * as-is.  But all available APIs require specifying the specific parts
2736          * of the security descriptor being set.  Especially annoying is that
2737          * mandatory integrity labels are part of the SACL, but they aren't set
2738          * with SACL_SECURITY_INFORMATION.  Instead, applications must also
2739          * specify LABEL_SECURITY_INFORMATION (Windows Vista, Windows 7) or
2740          * BACKUP_SECURITY_INFORMATION (Windows 8).  But at least older versions
2741          * of Windows don't error out if you provide these newer flags...
2742          *
2743          * Also, if the process isn't running as Administrator, then it probably
2744          * doesn't have SE_RESTORE_PRIVILEGE.  In this case, it will always get
2745          * the STATUS_PRIVILEGE_NOT_HELD error by trying to set the SACL, even
2746          * if the security descriptor it provided did not have a SACL.  By
2747          * default, in this case we try to recover and set as much of the
2748          * security descriptor as possible --- potentially excluding the DACL, and
2749          * even the owner, as well as the SACL.
2750          */
2751
2752         info = OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
2753                DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION |
2754                LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION;
2755
2756
2757         /*
2758          * It's also worth noting that SetFileSecurity() is unusable because it
2759          * doesn't request "backup semantics" when it opens the file internally.
2760          * NtSetSecurityObject() seems to be the best function to use in backup
2761          * applications.  (SetSecurityInfo() should also work, but it's harder
2762          * to use and must call NtSetSecurityObject() internally anyway.
2763          * BackupWrite() is theoretically usable as well, but it's inflexible
2764          * and poorly documented.)
2765          */
2766
2767 retry:
2768         status = (*func_NtSetSecurityObject)(h, info, desc);
2769         if (NT_SUCCESS(status))
2770                 goto out_maybe_free_desc;
2771
2772         /* Failed to set the requested parts of the security descriptor.  If the
2773          * error was permissions-related, try to set fewer parts of the security
2774          * descriptor, unless WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled.  */
2775         if ((status == STATUS_PRIVILEGE_NOT_HELD ||
2776              status == STATUS_ACCESS_DENIED) &&
2777             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2778         {
2779                 if (info & SACL_SECURITY_INFORMATION) {
2780                         info &= ~(SACL_SECURITY_INFORMATION |
2781                                   LABEL_SECURITY_INFORMATION |
2782                                   BACKUP_SECURITY_INFORMATION);
2783                         ctx->partial_security_descriptors++;
2784                         goto retry;
2785                 }
2786                 if (info & DACL_SECURITY_INFORMATION) {
2787                         info &= ~DACL_SECURITY_INFORMATION;
2788                         goto retry;
2789                 }
2790                 if (info & OWNER_SECURITY_INFORMATION) {
2791                         info &= ~OWNER_SECURITY_INFORMATION;
2792                         goto retry;
2793                 }
2794                 /* Nothing left except GROUP, and if we removed it we
2795                  * wouldn't have anything at all.  */
2796         }
2797
2798         /* No part of the security descriptor could be set, or
2799          * WIMLIB_EXTRACT_FLAG_STRICT_ACLS is enabled and the full security
2800          * descriptor could not be set.  */
2801         if (!(info & SACL_SECURITY_INFORMATION))
2802                 ctx->partial_security_descriptors--;
2803         ctx->no_security_descriptors++;
2804
2805 out_maybe_free_desc:
2806         if (unlikely(desc_size > STACK_MAX))
2807                 FREE(desc);
2808         return status;
2809 }
2810
2811 /* Set metadata on the open file @h from the WIM inode @inode.  */
2812 static int
2813 do_apply_metadata_to_file(HANDLE h, const struct wim_inode *inode,
2814                           struct win32_apply_ctx *ctx)
2815 {
2816         FILE_BASIC_INFORMATION info;
2817         NTSTATUS status;
2818
2819         /* Set security descriptor if present and not in NO_ACLS mode  */
2820         if (inode_has_security_descriptor(inode) &&
2821             !(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
2822         {
2823                 const struct wim_security_data *sd;
2824                 const void *desc;
2825                 size_t desc_size;
2826
2827                 sd = wim_get_current_security_data(ctx->common.wim);
2828                 desc = sd->descriptors[inode->i_security_id];
2829                 desc_size = sd->sizes[inode->i_security_id];
2830
2831                 status = set_security_descriptor(h, desc, desc_size, ctx);
2832                 if (!NT_SUCCESS(status) &&
2833                     (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS))
2834                 {
2835                         winnt_error(status,
2836                                     L"Can't set security descriptor on \"%ls\"",
2837                                     current_path(ctx));
2838                         return WIMLIB_ERR_SET_SECURITY;
2839                 }
2840         }
2841
2842         /* Set attributes and timestamps  */
2843         info.CreationTime.QuadPart = inode->i_creation_time;
2844         info.LastAccessTime.QuadPart = inode->i_last_access_time;
2845         info.LastWriteTime.QuadPart = inode->i_last_write_time;
2846         info.ChangeTime.QuadPart = 0;
2847         if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
2848                 info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2849         } else {
2850                 info.FileAttributes = inode->i_attributes & ~SPECIAL_ATTRIBUTES;
2851                 if (info.FileAttributes == 0)
2852                         info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
2853         }
2854
2855         status = (*func_NtSetInformationFile)(h, &ctx->iosb,
2856                                               &info, sizeof(info),
2857                                               FileBasicInformation);
2858         /* On FAT volumes we get STATUS_INVALID_PARAMETER if we try to set
2859          * attributes on the root directory.  (Apparently because FAT doesn't
2860          * actually have a place to store those attributes!)  */
2861         if (!NT_SUCCESS(status)
2862             && !(status == STATUS_INVALID_PARAMETER &&
2863                  dentry_is_root(inode_first_extraction_dentry(inode))))
2864         {
2865                 winnt_error(status, L"Can't set basic metadata on \"%ls\"",
2866                             current_path(ctx));
2867                 return WIMLIB_ERR_SET_ATTRIBUTES;
2868         }
2869
2870         return 0;
2871 }
2872
2873 static int
2874 apply_metadata_to_file(const struct wim_dentry *dentry,
2875                        struct win32_apply_ctx *ctx)
2876 {
2877         const struct wim_inode *inode = dentry->d_inode;
2878         DWORD perms;
2879         HANDLE h;
2880         NTSTATUS status;
2881         int ret;
2882
2883         perms = FILE_WRITE_ATTRIBUTES | WRITE_DAC |
2884                 WRITE_OWNER | ACCESS_SYSTEM_SECURITY;
2885
2886         build_extraction_path(dentry, ctx);
2887
2888         /* Open a handle with as many relevant permissions as possible.  */
2889         while (!NT_SUCCESS(status = do_create_file(&h, perms, NULL,
2890                                                    0, FILE_OPEN, 0, ctx)))
2891         {
2892                 if (status == STATUS_PRIVILEGE_NOT_HELD ||
2893                     status == STATUS_ACCESS_DENIED)
2894                 {
2895                         if (perms & ACCESS_SYSTEM_SECURITY) {
2896                                 perms &= ~ACCESS_SYSTEM_SECURITY;
2897                                 continue;
2898                         }
2899                         if (perms & WRITE_DAC) {
2900                                 perms &= ~WRITE_DAC;
2901                                 continue;
2902                         }
2903                         if (perms & WRITE_OWNER) {
2904                                 perms &= ~WRITE_OWNER;
2905                                 continue;
2906                         }
2907                 }
2908                 winnt_error(status, L"Can't open \"%ls\" to set metadata",
2909                             current_path(ctx));
2910                 return WIMLIB_ERR_OPEN;
2911         }
2912
2913         ret = do_apply_metadata_to_file(h, inode, ctx);
2914
2915         (*func_NtClose)(h);
2916
2917         return ret;
2918 }
2919
2920 static int
2921 apply_metadata(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
2922 {
2923         const struct wim_dentry *dentry;
2924         int ret;
2925
2926         /* We go in reverse so that metadata is set on all a directory's
2927          * children before the directory itself.  This avoids any potential
2928          * problems with attributes, timestamps, or security descriptors.  */
2929         list_for_each_entry_reverse(dentry, dentry_list, d_extraction_list_node)
2930         {
2931                 ret = apply_metadata_to_file(dentry, ctx);
2932                 ret = check_apply_error(dentry, ctx, ret);
2933                 if (ret)
2934                         return ret;
2935                 ret = report_file_metadata_applied(&ctx->common);
2936                 if (ret)
2937                         return ret;
2938         }
2939         return 0;
2940 }
2941
2942 /* Issue warnings about problems during the extraction for which warnings were
2943  * not already issued (due to the high number of potential warnings if we issued
2944  * them per-file).  */
2945 static void
2946 do_warnings(const struct win32_apply_ctx *ctx)
2947 {
2948         if (ctx->partial_security_descriptors == 0
2949             && ctx->no_security_descriptors == 0
2950             && ctx->num_set_short_name_failures == 0
2951         #if 0
2952             && ctx->num_remove_short_name_failures == 0
2953         #endif
2954             )
2955                 return;
2956
2957         WARNING("Extraction to \"%ls\" complete, but with one or more warnings:",
2958                 ctx->common.target);
2959         if (ctx->num_set_short_name_failures) {
2960                 WARNING("- Could not set short names on %lu files or directories",
2961                         ctx->num_set_short_name_failures);
2962         }
2963 #if 0
2964         if (ctx->num_remove_short_name_failures) {
2965                 WARNING("- Could not remove short names on %lu files or directories"
2966                         "          (This is expected on Vista and earlier)",
2967                         ctx->num_remove_short_name_failures);
2968         }
2969 #endif
2970         if (ctx->partial_security_descriptors) {
2971                 WARNING("- Could only partially set the security descriptor\n"
2972                         "            on %lu files or directories.",
2973                         ctx->partial_security_descriptors);
2974         }
2975         if (ctx->no_security_descriptors) {
2976                 WARNING("- Could not set security descriptor at all\n"
2977                         "            on %lu files or directories.",
2978                         ctx->no_security_descriptors);
2979         }
2980         if (ctx->partial_security_descriptors || ctx->no_security_descriptors) {
2981                 WARNING("To fully restore all security descriptors, run the program\n"
2982                         "          with Administrator rights.");
2983         }
2984 }
2985
2986 static u64
2987 count_dentries(const struct list_head *dentry_list)
2988 {
2989         const struct list_head *cur;
2990         u64 count = 0;
2991
2992         list_for_each(cur, dentry_list)
2993                 count++;
2994
2995         return count;
2996 }
2997
2998 /* Extract files from a WIM image to a directory on Windows  */
2999 static int
3000 win32_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
3001 {
3002         int ret;
3003         struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
3004         u64 dentry_count;
3005
3006         ret = prepare_target(dentry_list, ctx);
3007         if (ret)
3008                 goto out;
3009
3010         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
3011                 ret = start_wimboot_extraction(dentry_list, ctx);
3012                 if (ret)
3013                         goto out;
3014         }
3015
3016         ctx->windows_build_number = xml_get_windows_build_number(ctx->common.wim->xml_info,
3017                                                                  ctx->common.wim->current_image);
3018
3019         dentry_count = count_dentries(dentry_list);
3020
3021         ret = start_file_structure_phase(&ctx->common, dentry_count);
3022         if (ret)
3023                 goto out;
3024
3025         ret = create_directories(dentry_list, ctx);
3026         if (ret)
3027                 goto out;
3028
3029         ret = create_nondirectories(dentry_list, ctx);
3030         if (ret)
3031                 goto out;
3032
3033         ret = end_file_structure_phase(&ctx->common);
3034         if (ret)
3035                 goto out;
3036
3037         struct read_blob_callbacks cbs = {
3038                 .begin_blob     = begin_extract_blob,
3039                 .consume_chunk  = extract_chunk,
3040                 .end_blob       = end_extract_blob,
3041                 .ctx            = ctx,
3042         };
3043         ret = extract_blob_list(&ctx->common, &cbs);
3044         if (ret)
3045                 goto out;
3046
3047         ret = start_file_metadata_phase(&ctx->common, dentry_count);
3048         if (ret)
3049                 goto out;
3050
3051         ret = apply_metadata(dentry_list, ctx);
3052         if (ret)
3053                 goto out;
3054
3055         ret = end_file_metadata_phase(&ctx->common);
3056         if (ret)
3057                 goto out;
3058
3059         if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
3060                 ret = end_wimboot_extraction(ctx);
3061                 if (ret)
3062                         goto out;
3063         }
3064
3065         do_warnings(ctx);
3066 out:
3067         close_target_directory(ctx);
3068         if (ctx->target_ntpath.Buffer)
3069                 HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
3070         FREE(ctx->pathbuf.Buffer);
3071         FREE(ctx->print_buffer);
3072         FREE(ctx->wimboot.wims);
3073         if (ctx->prepopulate_pats) {
3074                 FREE(ctx->prepopulate_pats->strings);
3075                 FREE(ctx->prepopulate_pats);
3076         }
3077         FREE(ctx->mem_prepopulate_pats);
3078         FREE(ctx->data_buffer);
3079         return ret;
3080 }
3081
3082 const struct apply_operations win32_apply_ops = {
3083         .name                   = "Windows",
3084         .get_supported_features = win32_get_supported_features,
3085         .extract                = win32_extract,
3086         .will_back_from_wim     = win32_will_back_from_wim,
3087         .context_size           = sizeof(struct win32_apply_ctx),
3088 };
3089
3090 #endif /* __WIN32__ */