4 * All the library code specific to native Windows builds is in here.
8 * Copyright (C) 2013 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
32 #include <shlwapi.h> /* shlwapi.h for PathMatchSpecW() */
33 #ifdef ERROR /* windows.h defines this */
39 #include "lookup_table.h"
41 #include "endianness.h"
42 #include "buffer_io.h"
47 #define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1
48 #define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1
49 struct win32_capture_state {
50 unsigned long num_get_sd_access_denied;
51 unsigned long num_get_sacl_priv_notheld;
54 #define MAX_SET_SD_ACCESS_DENIED_WARNINGS 1
55 #define MAX_SET_SACL_PRIV_NOTHELD_WARNINGS 1
57 #ifdef ENABLE_ERROR_MESSAGES
59 win32_error(u32 err_code)
63 nchars = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
64 FORMAT_MESSAGE_ALLOCATE_BUFFER,
66 (wchar_t*)&buffer, 0, NULL);
68 ERROR("Error printing error message! "
69 "Computer will self-destruct in 3 seconds.");
71 ERROR("Win32 error: %ls", buffer);
75 #else /* ENABLE_ERROR_MESSAGES */
76 # define win32_error(err_code)
77 #endif /* !ENABLE_ERROR_MESSAGES */
79 /* Pointers to functions that are not available on all targetted versions of
80 * Windows (XP and later). NOTE: The WINAPI annotations seem to be important; I
81 * assume it specifies a certain calling convention. */
84 static HANDLE (WINAPI *win32func_FindFirstStreamW)(LPCWSTR lpFileName,
85 STREAM_INFO_LEVELS InfoLevel,
86 LPVOID lpFindStreamData,
87 DWORD dwFlags) = NULL;
90 static BOOL (WINAPI *win32func_FindNextStreamW)(HANDLE hFindStream,
91 LPVOID lpFindStreamData) = NULL;
93 static HMODULE hKernel32 = NULL;
95 /* Try to dynamically load some functions */
101 if (hKernel32 == NULL) {
102 DEBUG("Loading Kernel32.dll");
103 hKernel32 = LoadLibraryW(L"Kernel32.dll");
104 if (hKernel32 == NULL) {
105 err = GetLastError();
106 WARNING("Can't load Kernel32.dll");
112 DEBUG("Looking for FindFirstStreamW");
113 win32func_FindFirstStreamW = (void*)GetProcAddress(hKernel32, "FindFirstStreamW");
114 if (!win32func_FindFirstStreamW) {
115 WARNING("Could not find function FindFirstStreamW() in Kernel32.dll!");
116 WARNING("Capturing alternate data streams will not be supported.");
120 DEBUG("Looking for FindNextStreamW");
121 win32func_FindNextStreamW = (void*)GetProcAddress(hKernel32, "FindNextStreamW");
122 if (!win32func_FindNextStreamW) {
123 WARNING("Could not find function FindNextStreamW() in Kernel32.dll!");
124 WARNING("Capturing alternate data streams will not be supported.");
125 win32func_FindFirstStreamW = NULL;
130 win32_global_cleanup()
132 if (hKernel32 != NULL) {
133 DEBUG("Closing Kernel32.dll");
134 FreeLibrary(hKernel32);
139 static const wchar_t *capture_access_denied_msg =
140 L" If you are not running this program as the administrator, you may\n"
141 " need to do so, so that all data and metadata can be backed up.\n"
142 " Otherwise, there may be no way to access the desired data or\n"
143 " metadata without taking ownership of the file or directory.\n"
146 static const wchar_t *apply_access_denied_msg =
147 L"If you are not running this program as the administrator, you may\n"
148 " need to do so, so that all data and metadata can be extracted\n"
149 " exactly as the origignal copy. However, if you do not care that\n"
150 " the security descriptors are extracted correctly, you could run\n"
151 " `wimlib-imagex apply' with the --no-acls flag instead.\n"
155 win32_open_existing_file(const wchar_t *path, DWORD dwDesiredAccess)
157 return CreateFileW(path,
160 NULL, /* lpSecurityAttributes */
162 FILE_FLAG_BACKUP_SEMANTICS |
163 FILE_FLAG_OPEN_REPARSE_POINT,
164 NULL /* hTemplateFile */);
168 win32_open_file_data_only(const wchar_t *path)
170 return win32_open_existing_file(path, FILE_READ_DATA);
174 read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
176 consume_data_callback_t cb,
185 HANDLE hFile = win32_open_file_data_only(lte->file_on_disk);
186 if (hFile == INVALID_HANDLE_VALUE) {
187 err = GetLastError();
188 ERROR("Failed to open \"%ls\"", lte->file_on_disk);
190 return WIMLIB_ERR_OPEN;
194 out_buf = alloca(WIM_CHUNK_SIZE);
196 out_buf = ctx_or_buf;
198 bytes_remaining = size;
199 while (bytes_remaining) {
200 DWORD bytesToRead, bytesRead;
202 bytesToRead = min(WIM_CHUNK_SIZE, bytes_remaining);
203 if (!ReadFile(hFile, out_buf, bytesToRead, &bytesRead, NULL) ||
204 bytesRead != bytesToRead)
206 err = GetLastError();
207 ERROR("Failed to read data from \"%ls\"", lte->file_on_disk);
209 ret = WIMLIB_ERR_READ;
212 bytes_remaining -= bytesRead;
214 ret = (*cb)(out_buf, bytesRead, ctx_or_buf);
218 out_buf += bytesRead;
225 struct win32_encrypted_read_ctx {
226 consume_data_callback_t read_prefix_cb;
227 void *read_prefix_ctx_or_buf;
235 win32_encrypted_export_cb(unsigned char *_data, void *_ctx, unsigned long len)
237 const void *data = _data;
238 struct win32_encrypted_read_ctx *ctx = _ctx;
241 DEBUG("len = %lu", len);
242 if (ctx->read_prefix_cb) {
243 /* The length of the buffer passed to the ReadEncryptedFileRaw()
244 * export callback is undocumented, so we assume it may be of
246 size_t bytes_to_buffer = min(ctx->bytes_remaining - ctx->buf_filled,
248 while (bytes_to_buffer) {
249 size_t bytes_to_copy_to_buf =
250 min(bytes_to_buffer, WIM_CHUNK_SIZE - ctx->buf_filled);
252 memcpy(ctx->buf + ctx->buf_filled, data,
253 bytes_to_copy_to_buf);
254 ctx->buf_filled += bytes_to_copy_to_buf;
255 data += bytes_to_copy_to_buf;
256 bytes_to_buffer -= bytes_to_copy_to_buf;
258 if (ctx->buf_filled == WIM_CHUNK_SIZE ||
259 ctx->buf_filled == ctx->bytes_remaining)
261 ret = (*ctx->read_prefix_cb)(ctx->buf,
263 ctx->read_prefix_ctx_or_buf);
265 ctx->wimlib_err_code = ret;
266 /* Shouldn't matter what error code is returned
267 * here, as long as it isn't ERROR_SUCCESS. */
268 return ERROR_READ_FAULT;
270 ctx->bytes_remaining -= ctx->buf_filled;
275 size_t len_to_copy = min(len, ctx->bytes_remaining);
276 memcpy(ctx->read_prefix_ctx_or_buf, data, len_to_copy);
277 ctx->bytes_remaining -= len_to_copy;
278 ctx->read_prefix_ctx_or_buf += len_to_copy;
280 return ERROR_SUCCESS;
284 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
286 consume_data_callback_t cb,
290 struct win32_encrypted_read_ctx export_ctx;
295 DEBUG("Reading %"PRIu64" bytes from encryted file \"%ls\"",
296 size, lte->file_on_disk);
298 export_ctx.read_prefix_cb = cb;
299 export_ctx.read_prefix_ctx_or_buf = ctx_or_buf;
300 export_ctx.wimlib_err_code = 0;
302 export_ctx.buf = MALLOC(WIM_CHUNK_SIZE);
304 return WIMLIB_ERR_NOMEM;
306 export_ctx.buf = NULL;
308 export_ctx.bytes_remaining = size;
310 err = OpenEncryptedFileRawW(lte->file_on_disk, 0, &file_ctx);
311 if (err != ERROR_SUCCESS) {
312 ERROR("Failed to open encrypted file \"%ls\" for raw read",
315 ret = WIMLIB_ERR_OPEN;
318 err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
319 &export_ctx, file_ctx);
320 if (err != ERROR_SUCCESS) {
321 ERROR("Failed to read encrypted file \"%ls\"",
324 ret = export_ctx.wimlib_err_code;
326 ret = WIMLIB_ERR_READ;
327 } else if (export_ctx.bytes_remaining != 0) {
328 ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from "
329 "encryted file \"%ls\"",
330 size - export_ctx.bytes_remaining, size,
332 ret = WIMLIB_ERR_READ;
336 CloseEncryptedFileRaw(file_ctx);
338 FREE(export_ctx.buf);
342 /* Given a path, which may not yet exist, get a set of flags that describe the
343 * features of the volume the path is on. */
345 win32_get_vol_flags(const wchar_t *path, unsigned *vol_flags_ret)
351 if (path[0] != L'\0' && path[0] != L'\\' &&
352 path[0] != L'/' && path[1] == L':')
354 /* Path starts with a drive letter; use it. */
355 volume = alloca(4 * sizeof(wchar_t));
361 /* Path does not start with a drive letter; use the volume of
362 * the current working directory. */
365 bret = GetVolumeInformationW(volume, /* lpRootPathName */
366 NULL, /* lpVolumeNameBuffer */
367 0, /* nVolumeNameSize */
368 NULL, /* lpVolumeSerialNumber */
369 NULL, /* lpMaximumComponentLength */
370 &vol_flags, /* lpFileSystemFlags */
371 NULL, /* lpFileSystemNameBuffer */
372 0); /* nFileSystemNameSize */
374 DWORD err = GetLastError();
375 WARNING("Failed to get volume information for path \"%ls\"", path);
377 vol_flags = 0xffffffff;
380 DEBUG("using vol_flags = %x", vol_flags);
381 *vol_flags_ret = vol_flags;
387 FILETIME_to_u64(const FILETIME *ft)
389 return ((u64)ft->dwHighDateTime << 32) | (u64)ft->dwLowDateTime;
393 win32_get_short_name(struct wim_dentry *dentry, const wchar_t *path)
395 WIN32_FIND_DATAW dat;
396 if (FindFirstFileW(path, &dat) && dat.cAlternateFileName[0] != L'\0') {
397 DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName);
398 size_t short_name_nbytes = wcslen(dat.cAlternateFileName) *
400 size_t n = short_name_nbytes + sizeof(wchar_t);
401 dentry->short_name = MALLOC(n);
402 if (!dentry->short_name)
403 return WIMLIB_ERR_NOMEM;
404 memcpy(dentry->short_name, dat.cAlternateFileName, n);
405 dentry->short_name_nbytes = short_name_nbytes;
407 /* If we can't read the short filename for some reason, we just ignore
408 * the error and assume the file has no short name. I don't think this
409 * should be an issue, since the short names are essentially obsolete
415 win32_get_security_descriptor(struct wim_dentry *dentry,
416 struct sd_set *sd_set,
418 struct win32_capture_state *state,
421 SECURITY_INFORMATION requestedInformation;
427 requestedInformation = DACL_SECURITY_INFORMATION |
428 SACL_SECURITY_INFORMATION |
429 OWNER_SECURITY_INFORMATION |
430 GROUP_SECURITY_INFORMATION;
432 /* Request length of security descriptor */
433 status = GetFileSecurityW(path, requestedInformation,
434 NULL, 0, &lenNeeded);
435 err = GetLastError();
436 if (!status && err == ERROR_INSUFFICIENT_BUFFER) {
437 DWORD len = lenNeeded;
439 if (GetFileSecurityW(path, requestedInformation,
440 (PSECURITY_DESCRIPTOR)buf, len, &lenNeeded))
442 int security_id = sd_set_add_sd(sd_set, buf, len);
444 return WIMLIB_ERR_NOMEM;
446 dentry->d_inode->i_security_id = security_id;
450 err = GetLastError();
454 if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS)
458 case ERROR_PRIVILEGE_NOT_HELD:
459 if (requestedInformation & SACL_SECURITY_INFORMATION) {
460 n = state->num_get_sacl_priv_notheld++;
461 requestedInformation &= ~SACL_SECURITY_INFORMATION;
462 if (n < MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
464 "We don't have enough privileges to read the full security\n"
465 " descriptor of \"%ls\"!\n"
466 " Re-trying with SACL omitted.\n", path);
467 } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
469 "Suppressing further privileges not held error messages when reading\n"
470 " security descriptors.");
475 case ERROR_ACCESS_DENIED:
476 n = state->num_get_sd_access_denied++;
477 if (n < MAX_GET_SD_ACCESS_DENIED_WARNINGS) {
478 WARNING("Failed to read security descriptor of \"%ls\": "
479 "Access denied!\n%ls", path, capture_access_denied_msg);
480 } else if (n == MAX_GET_SD_ACCESS_DENIED_WARNINGS) {
481 WARNING("Suppressing further access denied errors messages i"
482 "when reading security descriptors");
487 ERROR("Failed to read security descriptor of \"%ls\"", path);
489 return WIMLIB_ERR_READ;
494 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
496 size_t path_num_chars,
497 struct add_image_params *params,
498 struct win32_capture_state *state,
501 /* Reads the directory entries of directory using a Win32 API and recursively
502 * calls win32_build_dentry_tree() on them. */
504 win32_recurse_directory(struct wim_dentry *root,
506 size_t dir_path_num_chars,
507 struct add_image_params *params,
508 struct win32_capture_state *state,
511 WIN32_FIND_DATAW dat;
516 DEBUG("Recurse to directory \"%ls\"", dir_path);
518 /* Begin reading the directory by calling FindFirstFileW. Unlike UNIX
519 * opendir(), FindFirstFileW has file globbing built into it. But this
520 * isn't what we actually want, so just add a dummy glob to get all
522 dir_path[dir_path_num_chars] = L'/';
523 dir_path[dir_path_num_chars + 1] = L'*';
524 dir_path[dir_path_num_chars + 2] = L'\0';
525 hFind = FindFirstFileW(dir_path, &dat);
526 dir_path[dir_path_num_chars] = L'\0';
528 if (hFind == INVALID_HANDLE_VALUE) {
529 err = GetLastError();
530 if (err == ERROR_FILE_NOT_FOUND) {
533 ERROR("Failed to read directory \"%ls\"", dir_path);
535 return WIMLIB_ERR_READ;
540 /* Skip . and .. entries */
541 if (dat.cFileName[0] == L'.' &&
542 (dat.cFileName[1] == L'\0' ||
543 (dat.cFileName[1] == L'.' &&
544 dat.cFileName[2] == L'\0')))
546 size_t filename_len = wcslen(dat.cFileName);
548 dir_path[dir_path_num_chars] = L'/';
549 wmemcpy(dir_path + dir_path_num_chars + 1,
553 struct wim_dentry *child;
554 size_t path_len = dir_path_num_chars + 1 + filename_len;
555 ret = win32_build_dentry_tree_recursive(&child,
561 dir_path[dir_path_num_chars] = L'\0';
565 dentry_add_child(root, child);
566 } while (FindNextFileW(hFind, &dat));
567 err = GetLastError();
568 if (err != ERROR_NO_MORE_FILES) {
569 ERROR("Failed to read directory \"%ls\"", dir_path);
572 ret = WIMLIB_ERR_READ;
580 win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret)
584 BY_HANDLE_FILE_INFORMATION file_info;
587 hFile = win32_open_existing_file(path, FILE_READ_ATTRIBUTES);
588 if (hFile == INVALID_HANDLE_VALUE) {
589 err = GetLastError();
590 WARNING("Failed to open \"%ls\" to get file and volume IDs",
593 return WIMLIB_ERR_OPEN;
596 if (!GetFileInformationByHandle(hFile, &file_info)) {
597 err = GetLastError();
598 ERROR("Failed to get file information for \"%ls\"", path);
600 ret = WIMLIB_ERR_STAT;
602 *ino_ret = ((u64)file_info.nFileIndexHigh << 32) |
603 (u64)file_info.nFileIndexLow;
604 *dev_ret = file_info.dwVolumeSerialNumber;
614 RP_FIXED_FULLPATH = 0x2,
615 RP_FIXED_ABSPATH = 0x4,
616 RP_FIXED = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH,
619 static enum rp_status
620 win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
621 u64 capture_root_ino, u64 capture_root_dev)
623 size_t target_nchars= *target_nchars_p;
624 size_t stripped_chars;
625 wchar_t *orig_target;
627 if (target_nchars == 0)
630 if (target[0] == L'\\') {
631 if (target_nchars >= 2 && target[1] == L'\\') {
632 /* Probaby a volume. Can't do anything with it. */
633 DEBUG("Not fixing target (probably a volume)");
635 } else if (target_nchars >= 7 &&
643 DEBUG("Full style path");
644 /* Full \??\x:\ style path (may be junction or symlink)
648 DEBUG("Absolute target without drive letter");
649 /* Absolute target, without drive letter */
652 } else if (target_nchars >= 3 &&
653 target[0] != L'\0' &&
657 DEBUG("Absolute target with drive letter");
658 /* Absolute target, with drive letter */
661 DEBUG("Relative symlink or other link");
662 /* Relative symlink or other unexpected format */
665 target[target_nchars] = L'\0';
666 orig_target = target;
667 target = fixup_symlink(target + stripped_chars, capture_root_ino, capture_root_dev);
669 target_nchars = wcslen(target);
670 wmemmove(orig_target + stripped_chars, target, target_nchars + 1);
671 *target_nchars_p = target_nchars + stripped_chars;
672 DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
673 return stripped_chars ? RP_FIXED_FULLPATH : RP_FIXED_ABSPATH;
679 static enum rp_status
680 win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
681 u64 capture_root_ino, u64 capture_root_dev)
685 u16 substitute_name_offset;
686 u16 substitute_name_len;
688 size_t target_nchars;
689 enum rp_status status;
691 DWORD rpbuflen = *rpbuflen_p;
695 p_get = get_u32(rpbuf, &rptag);
697 p_get = get_u16(p_get, &substitute_name_offset);
698 p_get = get_u16(p_get, &substitute_name_len);
700 if ((size_t)substitute_name_offset + substitute_name_len > rpbuflen)
702 if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) {
709 target = (wchar_t*)&p_get[substitute_name_offset];
710 target_nchars = substitute_name_len / 2;
711 /* Note: target is not necessarily null-terminated */
713 status = win32_maybe_rpfix_target(target, &target_nchars,
714 capture_root_ino, capture_root_dev);
715 if (status & RP_FIXED) {
716 size_t target_nbytes = target_nchars * 2;
717 size_t print_nbytes = target_nbytes;
718 wchar_t target_copy[target_nchars];
719 wchar_t *print_name = target_copy;
721 if (status == RP_FIXED_FULLPATH) {
725 wmemcpy(target_copy, target, target_nchars);
727 p_put = put_u16(p_put, 0); /* Substitute name offset */
728 p_put = put_u16(p_put, target_nbytes); /* Substitute name length */
729 p_put = put_u16(p_put, target_nbytes + 2); /* Print name offset */
730 p_put = put_u16(p_put, print_nbytes); /* Print name length */
731 if (rptag == WIM_IO_REPARSE_TAG_SYMLINK)
732 p_put = put_u32(p_put, 1);
733 p_put = put_bytes(p_put, target_nbytes, target_copy);
734 p_put = put_u16(p_put, 0);
735 p_put = put_bytes(p_put, print_nbytes, print_name);
736 p_put = put_u16(p_put, 0);
737 rpbuflen = p_put - rpbuf;
738 put_u16(rpbuf + 4, rpbuflen - 8);
739 *rpbuflen_p = rpbuflen;
744 /* Load a reparse point into a WIM inode. It is just stored in memory.
746 * @hFile is the open handle to a reparse point, with permission to read the
749 * @inode is the WIM inode for the reparse point.
752 win32_capture_reparse_point(struct wim_dentry **root_p,
754 struct wim_inode *inode,
756 struct add_image_params *params)
758 DEBUG("Capturing reparse point \"%ls\"", path);
760 /* "Reparse point data, including the tag and optional GUID,
761 * cannot exceed 16 kilobytes." - MSDN */
762 char reparse_point_buf[REPARSE_POINT_MAX_SIZE];
767 if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT,
768 NULL, /* "Not used with this operation; set to NULL" */
769 0, /* "Not used with this operation; set to 0" */
770 reparse_point_buf, /* "A pointer to a buffer that
771 receives the reparse point data */
772 sizeof(reparse_point_buf), /* "The size of the output
777 DWORD err = GetLastError();
778 ERROR("Failed to get reparse data of \"%ls\"", path);
780 return WIMLIB_ERR_READ;
782 if (bytesReturned < 8) {
783 ERROR("Reparse data on \"%ls\" is invalid", path);
784 return WIMLIB_ERR_READ;
786 inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf);
788 if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX &&
789 (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
790 inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
792 enum rp_status status;
793 status = win32_do_capture_rpfix(reparse_point_buf,
795 params->capture_root_ino,
796 params->capture_root_dev);
797 if (status == RP_EXCLUDED) {
798 free_dentry(*root_p);
801 } else if (status & RP_FIXED) {
802 inode->i_not_rpfixed = 0;
805 return inode_set_unnamed_stream(inode, reparse_point_buf + 8,
806 bytesReturned - 8, params->lookup_table);
809 /* Scans an unnamed or named stream of a Win32 file (not a reparse point
810 * stream); calculates its SHA1 message digest and either creates a `struct
811 * wim_lookup_table_entry' in memory for it, or uses an existing 'struct
812 * wim_lookup_table_entry' for an identical stream.
814 * @path: Path to the file (UTF-16LE).
816 * @path_num_chars: Number of 2-byte characters in @path.
818 * @inode: WIM inode to save the stream into.
820 * @lookup_table: Stream lookup table for the WIM.
822 * @dat: A `WIN32_FIND_STREAM_DATA' structure that specifies the
825 * Returns 0 on success; nonzero on failure.
828 win32_capture_stream(const wchar_t *path,
829 size_t path_num_chars,
830 struct wim_inode *inode,
831 struct wim_lookup_table *lookup_table,
832 WIN32_FIND_STREAM_DATA *dat)
834 struct wim_ads_entry *ads_entry;
835 struct wim_lookup_table_entry *lte;
837 wchar_t *stream_name, *colon;
838 size_t stream_name_nchars;
839 bool is_named_stream;
842 size_t spath_buf_nbytes;
843 const wchar_t *relpath_prefix;
844 const wchar_t *colonchar;
846 DEBUG("Capture \"%ls\" stream \"%ls\"", path, dat->cStreamName);
848 /* The stream name should be returned as :NAME:TYPE */
849 stream_name = dat->cStreamName;
850 if (*stream_name != L':')
851 goto out_invalid_stream_name;
853 colon = wcschr(stream_name, L':');
855 goto out_invalid_stream_name;
857 if (wcscmp(colon + 1, L"$DATA")) {
858 /* Not a DATA stream */
865 stream_name_nchars = colon - stream_name;
866 is_named_stream = (stream_name_nchars != 0);
868 if (is_named_stream) {
869 /* Allocate an ADS entry for the named stream. */
870 ads_entry = inode_add_ads_utf16le(inode, stream_name,
871 stream_name_nchars * sizeof(wchar_t));
873 ret = WIMLIB_ERR_NOMEM;
878 /* Create a UTF-16LE string @spath that gives the filename, then a
879 * colon, then the stream name. Or, if it's an unnamed stream, just the
880 * filename. It is MALLOC()'ed so that it can be saved in the
881 * wim_lookup_table_entry if needed.
883 * As yet another special case, relative paths need to be changed to
884 * begin with an explicit "./" so that, for example, a file t:ads, where
885 * :ads is the part we added, is not interpreted as a file on the t:
887 spath_nchars = path_num_chars;
888 relpath_prefix = L"";
890 if (is_named_stream) {
891 spath_nchars += 1 + stream_name_nchars;
893 if (path_num_chars == 1 &&
898 relpath_prefix = L"./";
902 spath_buf_nbytes = (spath_nchars + 1) * sizeof(wchar_t);
903 spath = MALLOC(spath_buf_nbytes);
905 swprintf(spath, L"%ls%ls%ls%ls",
906 relpath_prefix, path, colonchar, stream_name);
908 /* Make a new wim_lookup_table_entry */
909 lte = new_lookup_table_entry();
911 ret = WIMLIB_ERR_NOMEM;
914 lte->file_on_disk = spath;
916 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream)
917 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
919 lte->resource_location = RESOURCE_WIN32;
920 lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart;
923 if (is_named_stream) {
924 stream_id = ads_entry->stream_id;
925 ads_entry->lte = lte;
930 lookup_table_insert_unhashed(lookup_table, lte, inode, stream_id);
936 out_invalid_stream_name:
937 ERROR("Invalid stream name: \"%ls:%ls\"", path, dat->cStreamName);
938 ret = WIMLIB_ERR_READ;
942 /* Scans a Win32 file for unnamed and named data streams (not reparse point
945 * @path: Path to the file (UTF-16LE).
947 * @path_num_chars: Number of 2-byte characters in @path.
949 * @inode: WIM inode to save the stream into.
951 * @lookup_table: Stream lookup table for the WIM.
953 * @file_size: Size of unnamed data stream. (Used only if alternate
954 * data streams API appears to be unavailable.)
956 * @vol_flags: Flags that specify features of the volume being
959 * Returns 0 on success; nonzero on failure.
962 win32_capture_streams(const wchar_t *path,
963 size_t path_num_chars,
964 struct wim_inode *inode,
965 struct wim_lookup_table *lookup_table,
969 WIN32_FIND_STREAM_DATA dat;
974 DEBUG("Capturing streams from \"%ls\"", path);
976 if (win32func_FindFirstStreamW == NULL ||
977 !(vol_flags & FILE_NAMED_STREAMS))
980 hFind = win32func_FindFirstStreamW(path, FindStreamInfoStandard, &dat, 0);
981 if (hFind == INVALID_HANDLE_VALUE) {
982 err = GetLastError();
983 if (err == ERROR_CALL_NOT_IMPLEMENTED)
986 /* Seems legal for this to return ERROR_HANDLE_EOF on reparse
987 * points and directories */
988 if ((inode->i_attributes &
989 (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
990 && err == ERROR_HANDLE_EOF)
992 DEBUG("ERROR_HANDLE_EOF (ok)");
995 if (err == ERROR_ACCESS_DENIED) {
996 ERROR("Failed to look up data streams "
997 "of \"%ls\": Access denied!\n%ls",
998 path, capture_access_denied_msg);
999 return WIMLIB_ERR_READ;
1001 ERROR("Failed to look up data streams "
1002 "of \"%ls\"", path);
1004 return WIMLIB_ERR_READ;
1009 ret = win32_capture_stream(path,
1011 inode, lookup_table,
1014 goto out_find_close;
1015 } while (win32func_FindNextStreamW(hFind, &dat));
1016 err = GetLastError();
1017 if (err != ERROR_HANDLE_EOF) {
1018 ERROR("Win32 API: Error reading data streams from \"%ls\"", path);
1020 ret = WIMLIB_ERR_READ;
1026 /* FindFirstStreamW() API is not available, or the volume does not
1027 * support named streams. Only capture the unnamed data stream. */
1028 DEBUG("Only capturing unnamed data stream");
1029 if (inode->i_attributes &
1030 (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
1034 /* Just create our own WIN32_FIND_STREAM_DATA for an unnamed
1035 * stream to reduce the code to a call to the
1036 * already-implemented win32_capture_stream() */
1037 wcscpy(dat.cStreamName, L"::$DATA");
1038 dat.StreamSize.QuadPart = file_size;
1039 ret = win32_capture_stream(path,
1041 inode, lookup_table,
1048 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1050 size_t path_num_chars,
1051 struct add_image_params *params,
1052 struct win32_capture_state *state,
1055 struct wim_dentry *root = NULL;
1056 struct wim_inode *inode;
1061 if (exclude_path(path, path_num_chars, params->config, true)) {
1062 if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
1063 ERROR("Cannot exclude the root directory from capture");
1064 ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
1067 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE)
1068 && params->progress_func)
1070 union wimlib_progress_info info;
1071 info.scan.cur_path = path;
1072 info.scan.excluded = true;
1073 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
1078 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
1079 && params->progress_func)
1081 union wimlib_progress_info info;
1082 info.scan.cur_path = path;
1083 info.scan.excluded = false;
1084 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
1087 HANDLE hFile = win32_open_existing_file(path,
1088 FILE_READ_DATA | FILE_READ_ATTRIBUTES);
1089 if (hFile == INVALID_HANDLE_VALUE) {
1090 err = GetLastError();
1091 ERROR("Win32 API: Failed to open \"%ls\"", path);
1093 ret = WIMLIB_ERR_OPEN;
1097 BY_HANDLE_FILE_INFORMATION file_info;
1098 if (!GetFileInformationByHandle(hFile, &file_info)) {
1099 err = GetLastError();
1100 ERROR("Win32 API: Failed to get file information for \"%ls\"",
1103 ret = WIMLIB_ERR_STAT;
1104 goto out_close_handle;
1107 /* Create a WIM dentry with an associated inode, which may be shared */
1108 ret = inode_table_new_dentry(params->inode_table,
1109 path_basename_with_len(path, path_num_chars),
1110 ((u64)file_info.nFileIndexHigh << 32) |
1111 (u64)file_info.nFileIndexLow,
1112 file_info.dwVolumeSerialNumber,
1115 goto out_close_handle;
1117 ret = win32_get_short_name(root, path);
1119 goto out_close_handle;
1121 inode = root->d_inode;
1123 if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
1124 goto out_close_handle;
1126 inode->i_attributes = file_info.dwFileAttributes;
1127 inode->i_creation_time = FILETIME_to_u64(&file_info.ftCreationTime);
1128 inode->i_last_write_time = FILETIME_to_u64(&file_info.ftLastWriteTime);
1129 inode->i_last_access_time = FILETIME_to_u64(&file_info.ftLastAccessTime);
1130 inode->i_resolved = 1;
1132 params->add_image_flags &= ~(WIMLIB_ADD_IMAGE_FLAG_ROOT | WIMLIB_ADD_IMAGE_FLAG_SOURCE);
1134 if (!(params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS)
1135 && (vol_flags & FILE_PERSISTENT_ACLS))
1137 ret = win32_get_security_descriptor(root, params->sd_set,
1139 params->add_image_flags);
1141 goto out_close_handle;
1144 file_size = ((u64)file_info.nFileSizeHigh << 32) |
1145 (u64)file_info.nFileSizeLow;
1147 if (inode_is_directory(inode)) {
1148 /* Directory (not a reparse point) --- recurse to children */
1150 /* But first... directories may have alternate data streams that
1151 * need to be captured. */
1152 ret = win32_capture_streams(path,
1155 params->lookup_table,
1159 goto out_close_handle;
1160 ret = win32_recurse_directory(root,
1166 } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1167 /* Reparse point: save the reparse tag and data. Alternate data
1168 * streams are not captured, if it's even possible for a reparse
1169 * point to have alternate data streams... */
1170 ret = win32_capture_reparse_point(&root, hFile, inode, path, params);
1172 /* Not a directory, not a reparse point; capture the default
1173 * file contents and any alternate data streams. */
1174 ret = win32_capture_streams(path,
1177 params->lookup_table,
1187 free_dentry_tree(root, params->lookup_table);
1192 win32_do_capture_warnings(const struct win32_capture_state *state,
1193 int add_image_flags)
1195 if (state->num_get_sacl_priv_notheld == 0 &&
1196 state->num_get_sd_access_denied == 0)
1200 WARNING("Built dentry tree successfully, but with the following problem(s):");
1201 if (state->num_get_sacl_priv_notheld != 0) {
1202 WARNING("Could not capture SACL (System Access Control List)\n"
1203 " on %lu files or directories.",
1204 state->num_get_sacl_priv_notheld);
1206 if (state->num_get_sd_access_denied != 0) {
1207 WARNING("Could not capture security descriptor at all\n"
1208 " on %lu files or directories.",
1209 state->num_get_sd_access_denied);
1212 "Try running the program as the Administrator to make sure all the\n"
1213 " desired metadata has been captured exactly. However, if you\n"
1214 " do not care about capturing security descriptors correctly, then\n"
1215 " nothing more needs to be done%ls\n",
1216 (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS) ? L"." :
1217 L", although you might consider\n"
1218 " passing the --no-acls flag to `wimlib-imagex capture' or\n"
1219 " `wimlib-imagex append' to explicitly capture no security\n"
1223 /* Win32 version of capturing a directory tree */
1225 win32_build_dentry_tree(struct wim_dentry **root_ret,
1226 const wchar_t *root_disk_path,
1227 struct add_image_params *params)
1232 struct win32_capture_state state;
1236 path_nchars = wcslen(root_disk_path);
1237 if (path_nchars > 32767)
1238 return WIMLIB_ERR_INVALID_PARAM;
1240 ret = win32_get_file_and_vol_ids(root_disk_path,
1241 ¶ms->capture_root_ino,
1242 ¶ms->capture_root_dev);
1246 win32_get_vol_flags(root_disk_path, &vol_flags);
1248 /* There is no check for overflow later when this buffer is being used!
1249 * But the max path length on NTFS is 32767 characters, and paths need
1250 * to be written specially to even go past 260 characters, so we should
1251 * be okay with 32770 characters. */
1252 path = MALLOC(32770 * sizeof(wchar_t));
1254 return WIMLIB_ERR_NOMEM;
1256 wmemcpy(path, root_disk_path, path_nchars + 1);
1258 memset(&state, 0, sizeof(state));
1259 ret = win32_build_dentry_tree_recursive(root_ret, path,
1260 path_nchars, params,
1264 win32_do_capture_warnings(&state, params->add_image_flags);
1269 win32_set_reparse_data(HANDLE h,
1271 const struct wim_lookup_table_entry *lte,
1272 const wchar_t *path)
1279 WARNING("\"%ls\" is marked as a reparse point but had no reparse data",
1283 len = wim_resource_size(lte);
1284 if (len > 16 * 1024 - 8) {
1285 WARNING("\"%ls\": reparse data too long!", path);
1289 /* The WIM stream omits the ReparseTag and ReparseDataLength fields, so
1290 * leave 8 bytes of space for them at the beginning of the buffer, then
1291 * set them manually. */
1292 buf = alloca(len + 8);
1293 ret = read_full_resource_into_buf(lte, buf + 8, false);
1296 *(u32*)(buf + 0) = cpu_to_le32(reparse_tag);
1297 *(u16*)(buf + 4) = cpu_to_le16(len);
1298 *(u16*)(buf + 6) = 0;
1300 /* Set the reparse data on the open file using the
1301 * FSCTL_SET_REPARSE_POINT ioctl.
1303 * There are contradictions in Microsoft's documentation for this:
1305 * "If hDevice was opened without specifying FILE_FLAG_OVERLAPPED,
1306 * lpOverlapped is ignored."
1308 * --- So setting lpOverlapped to NULL is okay since it's ignored.
1310 * "If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an
1311 * operation returns no output data and lpOutBuffer is NULL,
1312 * DeviceIoControl makes use of lpBytesReturned. After such an
1313 * operation, the value of lpBytesReturned is meaningless."
1315 * --- So lpOverlapped not really ignored, as it affects another
1316 * parameter. This is the actual behavior: lpBytesReturned must be
1317 * specified, even though lpBytesReturned is documented as:
1319 * "Not used with this operation; set to NULL."
1321 DWORD bytesReturned;
1322 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT, buf, len + 8,
1324 &bytesReturned /* lpBytesReturned */,
1325 NULL /* lpOverlapped */))
1327 DWORD err = GetLastError();
1328 ERROR("Failed to set reparse data on \"%ls\"", path);
1330 return WIMLIB_ERR_WRITE;
1336 win32_set_compressed(HANDLE hFile, const wchar_t *path)
1338 USHORT format = COMPRESSION_FORMAT_DEFAULT;
1339 DWORD bytesReturned = 0;
1340 if (!DeviceIoControl(hFile, FSCTL_SET_COMPRESSION,
1341 &format, sizeof(USHORT),
1343 &bytesReturned, NULL))
1345 /* Could be a warning only, but we only call this if the volume
1346 * supports compression. So I'm calling this an error. */
1347 DWORD err = GetLastError();
1348 ERROR("Failed to set compression flag on \"%ls\"", path);
1350 return WIMLIB_ERR_WRITE;
1356 win32_set_sparse(HANDLE hFile, const wchar_t *path)
1358 DWORD bytesReturned = 0;
1359 if (!DeviceIoControl(hFile, FSCTL_SET_SPARSE,
1362 &bytesReturned, NULL))
1364 /* Could be a warning only, but we only call this if the volume
1365 * supports sparse files. So I'm calling this an error. */
1366 DWORD err = GetLastError();
1367 WARNING("Failed to set sparse flag on \"%ls\"", path);
1369 return WIMLIB_ERR_WRITE;
1375 * Sets the security descriptor on an extracted file.
1378 win32_set_security_data(const struct wim_inode *inode,
1379 const wchar_t *path,
1380 struct apply_args *args)
1382 PSECURITY_DESCRIPTOR descriptor;
1386 descriptor = wim_const_security_data(args->w)->descriptors[inode->i_security_id];
1388 SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION |
1389 SACL_SECURITY_INFORMATION |
1390 OWNER_SECURITY_INFORMATION |
1391 GROUP_SECURITY_INFORMATION;
1393 if (SetFileSecurityW(path, securityInformation, descriptor))
1395 err = GetLastError();
1396 if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)
1399 case ERROR_PRIVILEGE_NOT_HELD:
1400 if (securityInformation & SACL_SECURITY_INFORMATION) {
1401 n = args->num_set_sacl_priv_notheld++;
1402 securityInformation &= ~SACL_SECURITY_INFORMATION;
1403 if (n < MAX_SET_SACL_PRIV_NOTHELD_WARNINGS) {
1405 "We don't have enough privileges to set the full security\n"
1406 " descriptor on \"%ls\"!\n", path);
1407 if (args->num_set_sd_access_denied +
1408 args->num_set_sacl_priv_notheld == 1)
1410 WARNING("%ls", apply_access_denied_msg);
1412 WARNING("Re-trying with SACL omitted.\n", path);
1413 } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
1415 "Suppressing further 'privileges not held' error messages when setting\n"
1416 " security descriptors.");
1421 case ERROR_INVALID_OWNER:
1422 case ERROR_ACCESS_DENIED:
1423 n = args->num_set_sd_access_denied++;
1424 if (n < MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
1425 WARNING("Failed to set security descriptor on \"%ls\": "
1426 "Access denied!\n", path);
1427 if (args->num_set_sd_access_denied +
1428 args->num_set_sacl_priv_notheld == 1)
1430 WARNING("%ls", apply_access_denied_msg);
1432 } else if (n == MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
1434 "Suppressing further access denied error messages when setting\n"
1435 " security descriptors");
1440 ERROR("Failed to set security descriptor on \"%ls\"", path);
1442 return WIMLIB_ERR_WRITE;
1448 win32_extract_chunk(const void *buf, size_t len, void *arg)
1450 HANDLE hStream = arg;
1452 DWORD nbytes_written;
1453 wimlib_assert(len <= 0xffffffff);
1455 if (!WriteFile(hStream, buf, len, &nbytes_written, NULL) ||
1456 nbytes_written != len)
1458 DWORD err = GetLastError();
1459 ERROR("WriteFile(): write error");
1461 return WIMLIB_ERR_WRITE;
1467 do_win32_extract_stream(HANDLE hStream, struct wim_lookup_table_entry *lte)
1469 return extract_wim_resource(lte, wim_resource_size(lte),
1470 win32_extract_chunk, hStream);
1474 do_win32_extract_encrypted_stream(const wchar_t *path,
1475 const struct wim_lookup_table_entry *lte)
1477 ERROR("Extracting encryted streams not implemented");
1478 return WIMLIB_ERR_INVALID_PARAM;
1482 path_is_root_of_drive(const wchar_t *path)
1487 if (*path != L'/' && *path != L'\\') {
1488 if (*(path + 1) == L':')
1493 while (*path == L'/' || *path == L'\\')
1495 return (*path == L'\0');
1499 win32_get_create_flags_and_attributes(DWORD i_attributes)
1504 * Some attributes cannot be set by passing them to CreateFile(). In
1507 * FILE_ATTRIBUTE_DIRECTORY:
1508 * CreateDirectory() must be called instead of CreateFile().
1510 * FILE_ATTRIBUTE_SPARSE_FILE:
1512 * See: win32_set_sparse().
1514 * FILE_ATTRIBUTE_COMPRESSED:
1515 * Not clear from the documentation, but apparently this needs an
1517 * See: win32_set_compressed().
1519 * FILE_ATTRIBUTE_REPARSE_POINT:
1520 * Needs an ioctl, with the reparse data specified.
1521 * See: win32_set_reparse_data().
1523 * In addition, clear any file flags in the attributes that we don't
1524 * want, but also specify FILE_FLAG_OPEN_REPARSE_POINT and
1525 * FILE_FLAG_BACKUP_SEMANTICS as we are a backup application.
1527 attributes = i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
1528 FILE_ATTRIBUTE_COMPRESSED |
1529 FILE_ATTRIBUTE_REPARSE_POINT |
1530 FILE_ATTRIBUTE_DIRECTORY |
1531 FILE_FLAG_DELETE_ON_CLOSE |
1532 FILE_FLAG_NO_BUFFERING |
1533 FILE_FLAG_OPEN_NO_RECALL |
1534 FILE_FLAG_OVERLAPPED |
1535 FILE_FLAG_RANDOM_ACCESS |
1536 /*FILE_FLAG_SESSION_AWARE |*/
1537 FILE_FLAG_SEQUENTIAL_SCAN |
1538 FILE_FLAG_WRITE_THROUGH);
1540 FILE_FLAG_OPEN_REPARSE_POINT |
1541 FILE_FLAG_BACKUP_SEMANTICS;
1545 inode_has_special_attributes(const struct wim_inode *inode)
1547 return (inode->i_attributes & (FILE_ATTRIBUTE_COMPRESSED |
1548 FILE_ATTRIBUTE_REPARSE_POINT |
1549 FILE_ATTRIBUTE_SPARSE_FILE)) != 0;
1552 /* Set compression or sparse attributes, and reparse data, if supported by the
1555 win32_set_special_attributes(HANDLE hFile, const struct wim_inode *inode,
1556 struct wim_lookup_table_entry *unnamed_stream_lte,
1557 const wchar_t *path, unsigned vol_flags)
1561 if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED) {
1562 if (vol_flags & FILE_FILE_COMPRESSION) {
1563 DEBUG("Setting compression flag on \"%ls\"", path);
1564 ret = win32_set_compressed(hFile, path);
1568 DEBUG("Cannot set compression attribute on \"%ls\": "
1569 "volume does not support transparent compression",
1574 if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE) {
1575 if (vol_flags & FILE_SUPPORTS_SPARSE_FILES) {
1576 DEBUG("Setting sparse flag on \"%ls\"", path);
1577 ret = win32_set_sparse(hFile, path);
1581 DEBUG("Cannot set sparse attribute on \"%ls\": "
1582 "volume does not support sparse files",
1587 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1588 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
1589 DEBUG("Setting reparse data on \"%ls\"", path);
1590 ret = win32_set_reparse_data(hFile, inode->i_reparse_tag,
1591 unnamed_stream_lte, path);
1595 DEBUG("Cannot set reparse data on \"%ls\": volume "
1596 "does not support reparse points", path);
1604 win32_extract_stream(const struct wim_inode *inode,
1605 const wchar_t *path,
1606 const wchar_t *stream_name_utf16,
1607 struct wim_lookup_table_entry *lte,
1610 wchar_t *stream_path;
1614 DWORD creationDisposition = CREATE_ALWAYS;
1616 if (stream_name_utf16) {
1617 /* Named stream. Create a buffer that contains the UTF-16LE
1618 * string [.\]@path:@stream_name_utf16. This is needed to
1619 * create and open the stream using CreateFileW(). I'm not
1620 * aware of any other APIs to do this. Note: the '$DATA' suffix
1621 * seems to be unneeded. Additional note: a "./" prefix needs
1622 * to be added when the path is not absolute to avoid ambiguity
1623 * with drive letters. */
1624 size_t stream_path_nchars;
1626 size_t stream_name_nchars;
1627 const wchar_t *prefix;
1629 path_nchars = wcslen(path);
1630 stream_name_nchars = wcslen(stream_name_utf16);
1631 stream_path_nchars = path_nchars + 1 + stream_name_nchars;
1632 if (path[0] != cpu_to_le16(L'\0') &&
1633 path[0] != cpu_to_le16(L'/') &&
1634 path[0] != cpu_to_le16(L'\\') &&
1635 path[1] != cpu_to_le16(L':'))
1638 stream_path_nchars += 2;
1642 stream_path = alloca((stream_path_nchars + 1) * sizeof(wchar_t));
1643 swprintf(stream_path, L"%ls%ls:%ls",
1644 prefix, path, stream_name_utf16);
1646 /* Unnamed stream; its path is just the path to the file itself.
1648 stream_path = (wchar_t*)path;
1650 /* Directories must be created with CreateDirectoryW(). Then
1651 * the call to CreateFileW() will merely open the directory that
1652 * was already created rather than creating a new file. */
1653 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1654 if (!CreateDirectoryW(stream_path, NULL)) {
1655 err = GetLastError();
1657 case ERROR_ALREADY_EXISTS:
1659 case ERROR_ACCESS_DENIED:
1660 if (path_is_root_of_drive(path))
1664 ERROR("Failed to create directory \"%ls\"",
1667 ret = WIMLIB_ERR_MKDIR;
1671 DEBUG("Created directory \"%ls\"", stream_path);
1672 if (!inode_has_special_attributes(inode)) {
1676 DEBUG("Directory \"%ls\" has special attributes!",
1678 creationDisposition = OPEN_EXISTING;
1682 DEBUG("Opening \"%ls\"", stream_path);
1683 h = CreateFileW(stream_path,
1684 GENERIC_READ | GENERIC_WRITE,
1687 creationDisposition,
1688 win32_get_create_flags_and_attributes(inode->i_attributes),
1690 if (h == INVALID_HANDLE_VALUE) {
1691 err = GetLastError();
1692 ERROR("Failed to create \"%ls\"", stream_path);
1694 ret = WIMLIB_ERR_OPEN;
1698 if (stream_name_utf16 == NULL && inode_has_special_attributes(inode)) {
1699 ret = win32_set_special_attributes(h, inode, lte, path,
1702 goto fail_close_handle;
1705 if (!(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1707 DEBUG("Extracting \"%ls\" (len = %"PRIu64")",
1708 stream_path, wim_resource_size(lte));
1709 if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED
1710 && stream_name_utf16 == NULL
1711 && (vol_flags & FILE_SUPPORTS_ENCRYPTION))
1713 ret = do_win32_extract_encrypted_stream(stream_path,
1716 ret = do_win32_extract_stream(h, lte);
1719 goto fail_close_handle;
1723 DEBUG("Closing \"%ls\"", stream_path);
1724 if (!CloseHandle(h)) {
1725 err = GetLastError();
1726 ERROR("Failed to close \"%ls\"", stream_path);
1728 ret = WIMLIB_ERR_WRITE;
1736 ERROR("Error extracting %ls", stream_path);
1742 * Creates a file, directory, or reparse point and extracts all streams to it
1743 * (unnamed data stream and/or reparse point stream, plus any alternate data
1744 * streams). This in Win32-specific code.
1746 * @inode: WIM inode for this file or directory.
1747 * @path: UTF-16LE external path to extract the inode to.
1749 * Returns 0 on success; nonzero on failure.
1752 win32_extract_streams(const struct wim_inode *inode,
1753 const wchar_t *path, u64 *completed_bytes_p,
1756 struct wim_lookup_table_entry *unnamed_lte;
1759 unnamed_lte = inode_unnamed_lte_resolved(inode);
1760 ret = win32_extract_stream(inode, path, NULL, unnamed_lte,
1764 if (unnamed_lte && inode->i_extracted_file == NULL)
1765 *completed_bytes_p += wim_resource_size(unnamed_lte);
1767 if (!(vol_flags & FILE_NAMED_STREAMS))
1769 for (u16 i = 0; i < inode->i_num_ads; i++) {
1770 const struct wim_ads_entry *ads_entry = &inode->i_ads_entries[i];
1771 if (ads_entry->stream_name_nbytes != 0) {
1772 /* Skip special UNIX data entries (see documentation for
1773 * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
1774 if (ads_entry->stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
1775 && !memcmp(ads_entry->stream_name,
1776 WIMLIB_UNIX_DATA_TAG_UTF16LE,
1777 WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
1779 ret = win32_extract_stream(inode,
1781 ads_entry->stream_name,
1786 if (ads_entry->lte && inode->i_extracted_file == NULL)
1787 *completed_bytes_p += wim_resource_size(ads_entry->lte);
1794 /* Extract a file, directory, reparse point, or hard link to an
1795 * already-extracted file using the Win32 API */
1797 win32_do_apply_dentry(const wchar_t *output_path,
1798 size_t output_path_num_chars,
1799 struct wim_dentry *dentry,
1800 struct apply_args *args)
1803 struct wim_inode *inode = dentry->d_inode;
1806 if (!args->have_vol_flags) {
1807 win32_get_vol_flags(output_path, &args->vol_flags);
1808 args->have_vol_flags = true;
1809 /* Warn the user about data that may not be extracted. */
1810 if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES))
1811 WARNING("Volume does not support sparse files!\n"
1812 " Sparse files will be extracted as non-sparse.");
1813 if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1814 WARNING("Volume does not support reparse points!\n"
1815 " Reparse point data will not be extracted.");
1816 if (!(args->vol_flags & FILE_NAMED_STREAMS)) {
1817 WARNING("Volume does not support named data streams!\n"
1818 " Named data streams will not be extracted.");
1820 if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) {
1821 WARNING("Volume does not support encryption!\n"
1822 " Encrypted files will be extracted as raw data.");
1824 if (!(args->vol_flags & FILE_FILE_COMPRESSION)) {
1825 WARNING("Volume does not support transparent compression!\n"
1826 " Compressed files will be extracted as non-compressed.");
1828 if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) {
1829 if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
1830 ERROR("Strict ACLs requested, but the volume does not "
1832 return WIMLIB_ERR_VOLUME_LACKS_FEATURES;
1834 WARNING("Volume does not support persistent ACLS!\n"
1835 " File permissions will not be extracted.");
1840 if (inode->i_nlink > 1 && inode->i_extracted_file != NULL) {
1841 /* Linked file, with another name already extracted. Create a
1844 /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS),
1845 * but it's only available on Windows 7 and later. So no use
1846 * even checking it, really. Instead, CreateHardLinkW() will
1847 * apparently return ERROR_INVALID_FUNCTION if the volume does
1848 * not support hard links. */
1849 DEBUG("Creating hard link \"%ls => %ls\"",
1850 output_path, inode->i_extracted_file);
1851 if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL))
1854 err = GetLastError();
1855 if (err != ERROR_INVALID_FUNCTION) {
1856 ERROR("Can't create hard link \"%ls => %ls\"",
1857 output_path, inode->i_extracted_file);
1859 return WIMLIB_ERR_LINK;
1861 WARNING("Can't create hard link \"%ls => %ls\":\n"
1862 " Volume does not support hard links!\n"
1863 " Falling back to extracting a copy of the file.",
1864 output_path, inode->i_extracted_file);
1868 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
1869 !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1871 WARNING("Skipping extraction of reparse point \"%ls\":\n"
1872 " Not supported by destination filesystem",
1874 struct wim_lookup_table_entry *lte;
1875 lte = inode_unnamed_lte_resolved(inode);
1877 args->progress.extract.completed_bytes += wim_resource_size(lte);
1881 /* Create the file, directory, or reparse point, and extract the
1883 ret = win32_extract_streams(inode, output_path,
1884 &args->progress.extract.completed_bytes,
1889 if (inode->i_security_id >= 0 &&
1890 !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
1891 && (args->vol_flags & FILE_PERSISTENT_ACLS))
1893 ret = win32_set_security_data(inode, output_path, args);
1897 if (inode->i_nlink > 1) {
1898 /* Save extracted path for a later call to
1899 * CreateHardLinkW() if this inode has multiple links.
1901 inode->i_extracted_file = WSTRDUP(output_path);
1902 if (!inode->i_extracted_file)
1903 ret = WIMLIB_ERR_NOMEM;
1908 /* Set timestamps on an extracted file using the Win32 API */
1910 win32_do_apply_dentry_timestamps(const wchar_t *path,
1911 size_t path_num_chars,
1912 const struct wim_dentry *dentry,
1913 const struct apply_args *args)
1917 const struct wim_inode *inode = dentry->d_inode;
1919 if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
1920 !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1922 /* Skip reparse points not extracted */
1926 /* Windows doesn't let you change the timestamps of the root directory
1927 * (at least on FAT, which is dumb but expected since FAT doesn't store
1928 * any metadata about the root directory...) */
1929 if (path_is_root_of_drive(path))
1932 DEBUG("Opening \"%ls\" to set timestamps", path);
1933 h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
1934 if (h == INVALID_HANDLE_VALUE) {
1935 err = GetLastError();
1939 FILETIME creationTime = {.dwLowDateTime = inode->i_creation_time & 0xffffffff,
1940 .dwHighDateTime = inode->i_creation_time >> 32};
1941 FILETIME lastAccessTime = {.dwLowDateTime = inode->i_last_access_time & 0xffffffff,
1942 .dwHighDateTime = inode->i_last_access_time >> 32};
1943 FILETIME lastWriteTime = {.dwLowDateTime = inode->i_last_write_time & 0xffffffff,
1944 .dwHighDateTime = inode->i_last_write_time >> 32};
1946 DEBUG("Calling SetFileTime() on \"%ls\"", path);
1947 if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime)) {
1948 err = GetLastError();
1952 DEBUG("Closing \"%ls\"", path);
1953 if (!CloseHandle(h)) {
1954 err = GetLastError();
1959 /* Only warn if setting timestamps failed; still return 0. */
1960 WARNING("Can't set timestamps on \"%ls\"", path);
1966 /* Replacement for POSIX fsync() */
1973 h = (HANDLE)_get_osfhandle(fd);
1974 if (h == INVALID_HANDLE_VALUE) {
1975 err = GetLastError();
1976 ERROR("Could not get Windows handle for file descriptor");
1981 if (!FlushFileBuffers(h)) {
1982 err = GetLastError();
1983 ERROR("Could not flush file buffers to disk");
1991 /* Use the Win32 API to get the number of processors */
1993 win32_get_number_of_processors()
1995 SYSTEM_INFO sysinfo;
1996 GetSystemInfo(&sysinfo);
1997 return sysinfo.dwNumberOfProcessors;
2000 /* Replacement for POSIX-2008 realpath(). Warning: partial functionality only
2001 * (resolved_path must be NULL). Also I highly doubt that GetFullPathName
2002 * really does the right thing under all circumstances. */
2004 realpath(const wchar_t *path, wchar_t *resolved_path)
2007 wimlib_assert(resolved_path == NULL);
2010 ret = GetFullPathNameW(path, 0, NULL, NULL);
2012 err = GetLastError();
2016 resolved_path = TMALLOC(ret);
2019 ret = GetFullPathNameW(path, ret, resolved_path, NULL);
2021 err = GetLastError();
2022 free(resolved_path);
2023 resolved_path = NULL;
2031 return resolved_path;
2034 /* rename() on Windows fails if the destination file exists. And we need to
2035 * make it work on wide characters. Fix it. */
2037 win32_rename_replacement(const wchar_t *oldpath, const wchar_t *newpath)
2039 if (MoveFileExW(oldpath, newpath, MOVEFILE_REPLACE_EXISTING)) {
2042 /* As usual, the possible error values are not documented */
2043 DWORD err = GetLastError();
2044 ERROR("MoveFileEx(): Can't rename \"%ls\" to \"%ls\"",
2052 /* Replacement for POSIX fnmatch() (partial functionality only) */
2054 fnmatch(const wchar_t *pattern, const wchar_t *string, int flags)
2056 if (PathMatchSpecW(string, pattern))
2062 /* truncate() replacement */
2064 win32_truncate_replacement(const wchar_t *path, off_t size)
2066 DWORD err = NO_ERROR;
2067 LARGE_INTEGER liOffset;
2069 HANDLE h = win32_open_existing_file(path, GENERIC_WRITE);
2070 if (h == INVALID_HANDLE_VALUE)
2073 liOffset.QuadPart = size;
2074 if (!SetFilePointerEx(h, liOffset, NULL, FILE_BEGIN))
2075 goto fail_close_handle;
2077 if (!SetEndOfFile(h))
2078 goto fail_close_handle;
2083 err = GetLastError();
2086 if (err == NO_ERROR)
2087 err = GetLastError();
2088 ERROR("Can't truncate \"%ls\" to %"PRIu64" bytes", path, size);
2095 /* This really could be replaced with _wcserror_s, but this doesn't seem to
2096 * actually be available in MSVCRT.DLL on Windows XP (perhaps it's statically
2097 * linked in by Visual Studio...?). */
2099 win32_strerror_r_replacement(int errnum, wchar_t *buf, size_t buflen)
2101 static pthread_mutex_t strerror_lock = PTHREAD_MUTEX_INITIALIZER;
2103 pthread_mutex_lock(&strerror_lock);
2104 mbstowcs(buf, strerror(errnum), buflen);
2105 buf[buflen - 1] = '\0';
2106 pthread_mutex_unlock(&strerror_lock);
2110 #endif /* __WIN32__ */