2 * win32_apply.c - Windows-specific code for applying files from a WIM image.
6 * Copyright (C) 2013 Eric Biggers
8 * This file is part of wimlib, a library for working with WIM files.
10 * wimlib is free software; you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 3 of the License, or (at your option)
15 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with wimlib; if not, see http://www.gnu.org/licenses/.
30 #include "wimlib/win32_common.h"
32 #include "wimlib/apply.h"
33 #include "wimlib/error.h"
34 #include "wimlib/lookup_table.h"
37 win32_start_extract(const wchar_t *path, struct apply_ctx *ctx)
41 bool supports_SetFileShortName;
43 ret = win32_get_vol_flags(path, &vol_flags, &supports_SetFileShortName);
47 ctx->supported_features.archive_files = 1;
48 ctx->supported_features.hidden_files = 1;
49 ctx->supported_features.system_files = 1;
51 if (vol_flags & FILE_FILE_COMPRESSION)
52 ctx->supported_features.compressed_files = 1;
54 if (vol_flags & FILE_SUPPORTS_ENCRYPTION) {
55 ctx->supported_features.encrypted_files = 1;
56 ctx->supported_features.encrypted_directories = 1;
59 ctx->supported_features.not_context_indexed_files = 1;
61 if (vol_flags & FILE_SUPPORTS_SPARSE_FILES)
62 ctx->supported_features.sparse_files = 1;
64 if (vol_flags & FILE_NAMED_STREAMS)
65 ctx->supported_features.named_data_streams = 1;
67 if (vol_flags & FILE_SUPPORTS_HARD_LINKS)
68 ctx->supported_features.hard_links = 1;
70 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
71 ctx->supported_features.reparse_points = 1;
72 if (win32func_CreateSymbolicLinkW)
73 ctx->supported_features.symlink_reparse_points = 1;
76 if (vol_flags & FILE_PERSISTENT_ACLS)
77 ctx->supported_features.security_descriptors = 1;
79 if (supports_SetFileShortName)
80 ctx->supported_features.short_names = 1;
85 win32_create_file(const wchar_t *path, struct apply_ctx *ctx, u64 *cookie_ret)
89 h = CreateFile(path, 0, 0, NULL, CREATE_ALWAYS,
90 FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS, NULL);
91 if (h == INVALID_HANDLE_VALUE)
97 set_errno_from_GetLastError();
98 return WIMLIB_ERR_OPEN;
102 win32_create_directory(const wchar_t *path, struct apply_ctx *ctx,
105 if (!CreateDirectory(path, NULL))
106 if (GetLastError() != ERROR_ALREADY_EXISTS)
111 set_errno_from_GetLastError();
112 return WIMLIB_ERR_MKDIR;
116 win32_create_hardlink(const wchar_t *oldpath, const wchar_t *newpath,
117 struct apply_ctx *ctx)
119 if (!CreateHardLink(newpath, oldpath, NULL)) {
120 if (GetLastError() != ERROR_ALREADY_EXISTS)
122 if (!DeleteFile(newpath))
124 if (!CreateHardLink(newpath, oldpath, NULL))
130 set_errno_from_GetLastError();
131 return WIMLIB_ERR_LINK;
135 win32_create_symlink(const wchar_t *oldpath, const wchar_t *newpath,
136 struct apply_ctx *ctx)
138 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0)) {
139 if (GetLastError() != ERROR_ALREADY_EXISTS)
141 if (!DeleteFile(newpath))
143 if (!(*win32func_CreateSymbolicLinkW)(newpath, oldpath, 0))
149 set_errno_from_GetLastError();
150 return WIMLIB_ERR_LINK;
154 win32_extract_wim_chunk(const void *buf, size_t len, void *arg)
156 HANDLE h = (HANDLE)arg;
157 DWORD nbytes_written;
159 if (unlikely(!WriteFile(h, buf, len, &nbytes_written, NULL)))
161 if (unlikely(nbytes_written != len))
166 set_errno_from_GetLastError();
167 return WIMLIB_ERR_WRITE;
171 win32_extract_stream(const wchar_t *path, const wchar_t *stream_name,
172 size_t stream_name_nchars,
173 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
175 DWORD creationDisposition = OPEN_EXISTING;
176 wchar_t *stream_path = (wchar_t*)path;
180 if (stream_name_nchars) {
181 creationDisposition = CREATE_ALWAYS;
182 stream_path = alloca(sizeof(wchar_t) *
184 wcslen(stream_name) + 1));
185 swprintf(stream_path, L"%ls:%ls", path, stream_name);
188 h = CreateFile(stream_path, FILE_WRITE_DATA, 0, NULL,
189 creationDisposition, FILE_FLAG_BACKUP_SEMANTICS |
190 FILE_FLAG_OPEN_REPARSE_POINT,
192 if (h == INVALID_HANDLE_VALUE)
197 goto out_close_handle;
198 ret = extract_wim_resource(lte, wim_resource_size(lte),
199 win32_extract_wim_chunk, h);
208 set_errno_from_GetLastError();
209 return WIMLIB_ERR_WRITE;
213 win32_extract_unnamed_stream(file_spec_t file,
214 struct wim_lookup_table_entry *lte,
215 struct apply_ctx *ctx)
217 return win32_extract_stream(file.path, NULL, 0, lte, ctx);
221 win32_extract_named_stream(file_spec_t file, const wchar_t *stream_name,
222 size_t stream_name_nchars,
223 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
225 return win32_extract_stream(file.path, stream_name,
226 stream_name_nchars, lte, ctx);
229 struct win32_encrypted_extract_ctx {
230 const struct wim_lookup_table_entry *lte;
235 win32_encrypted_import_cb(unsigned char *data, void *_import_ctx,
236 unsigned long *len_p)
238 struct win32_encrypted_extract_ctx *import_ctx = _import_ctx;
239 unsigned long len = *len_p;
240 const struct wim_lookup_table_entry *lte = import_ctx->lte;
242 len = min(len, wim_resource_size(lte) - import_ctx->offset);
244 if (read_partial_wim_resource_into_buf(lte, len, import_ctx->offset, data))
245 return ERROR_READ_FAULT;
247 import_ctx->offset += len;
249 return ERROR_SUCCESS;
253 win32_extract_encrypted_stream(file_spec_t file,
254 struct wim_lookup_table_entry *lte,
255 struct apply_ctx *ctx)
257 const tchar *path = file.path;
261 struct win32_encrypted_extract_ctx extract_ctx;
263 err = OpenEncryptedFileRaw(path, CREATE_FOR_IMPORT, &file_ctx);
264 if (err != ERROR_SUCCESS) {
265 errno = win32_error_to_errno(err);
266 ret = WIMLIB_ERR_OPEN;
270 extract_ctx.lte = lte;
271 extract_ctx.offset = 0;
272 err = WriteEncryptedFileRaw(win32_encrypted_import_cb, &extract_ctx,
274 if (err != ERROR_SUCCESS) {
275 errno = win32_error_to_errno(err);
276 ret = WIMLIB_ERR_WRITE;
282 CloseEncryptedFileRaw(file_ctx);
288 win32_set_special_file_attributes(const wchar_t *path, u32 attributes)
292 USHORT compression_format = COMPRESSION_FORMAT_DEFAULT;
293 DWORD bytes_returned;
295 h = CreateFile(path, GENERIC_READ | GENERIC_WRITE, 0, NULL,
296 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
297 FILE_FLAG_OPEN_REPARSE_POINT,
299 if (h == INVALID_HANDLE_VALUE)
302 if (attributes & FILE_ATTRIBUTE_SPARSE_FILE)
303 if (!DeviceIoControl(h, FSCTL_SET_SPARSE,
306 &bytes_returned, NULL))
307 goto error_close_handle;
309 if (attributes & FILE_ATTRIBUTE_COMPRESSED)
310 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
311 &compression_format, sizeof(USHORT),
313 &bytes_returned, NULL))
314 goto error_close_handle;
319 if (attributes & FILE_ATTRIBUTE_ENCRYPTED)
320 if (!EncryptFile(path))
326 err = GetLastError();
334 win32_set_file_attributes(const wchar_t *path, u32 attributes,
335 struct apply_ctx *ctx, unsigned pass)
337 u32 special_attributes =
338 FILE_ATTRIBUTE_REPARSE_POINT |
339 FILE_ATTRIBUTE_DIRECTORY |
340 FILE_ATTRIBUTE_SPARSE_FILE |
341 FILE_ATTRIBUTE_COMPRESSED |
342 FILE_ATTRIBUTE_ENCRYPTED;
343 u32 actual_attributes;
345 /* Delay setting FILE_ATTRIBUTE_READONLY on the initial pass (when files
346 * are created, but data not extracted); otherwise the system will
347 * refuse access to the file even if the process has SeRestorePrivilege.
350 attributes &= ~FILE_ATTRIBUTE_READONLY;
352 if (!SetFileAttributes(path, attributes & ~special_attributes))
358 if (attributes & (FILE_ATTRIBUTE_SPARSE_FILE |
359 FILE_ATTRIBUTE_ENCRYPTED |
360 FILE_ATTRIBUTE_COMPRESSED))
361 if (!win32_set_special_file_attributes(path, attributes))
364 /* If file is not supposed to be encrypted or compressed, remove
365 * defaulted encrypted or compressed attributes (from creating file in
366 * encrypted or compressed directory). */
367 actual_attributes = GetFileAttributes(path);
368 if (actual_attributes == INVALID_FILE_ATTRIBUTES)
371 if ((actual_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
372 !(attributes & FILE_ATTRIBUTE_ENCRYPTED))
373 if (!DecryptFile(path, 0))
375 if ((actual_attributes & FILE_ATTRIBUTE_COMPRESSED) &&
376 !(attributes & FILE_ATTRIBUTE_COMPRESSED))
379 DWORD bytes_returned;
380 USHORT compression_format = COMPRESSION_FORMAT_NONE;
382 h = CreateFile(path, GENERIC_READ | GENERIC_WRITE, 0, NULL,
383 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
384 FILE_FLAG_OPEN_REPARSE_POINT,
386 if (h == INVALID_HANDLE_VALUE)
389 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
390 &compression_format, sizeof(USHORT),
392 &bytes_returned, NULL))
394 DWORD err = GetLastError();
407 set_errno_from_GetLastError();
408 return WIMLIB_ERR_SET_ATTRIBUTES;
412 win32_set_reparse_data(const wchar_t *path, const u8 *rpbuf, u16 rpbuflen,
413 struct apply_ctx *ctx)
417 DWORD bytes_returned;
419 h = CreateFile(path, GENERIC_WRITE, 0, NULL,
420 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
421 FILE_FLAG_OPEN_REPARSE_POINT,
423 if (h == INVALID_HANDLE_VALUE)
426 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
427 (void*)rpbuf, rpbuflen,
428 NULL, 0, &bytes_returned, NULL))
429 goto error_close_handle;
437 err = GetLastError();
441 set_errno_from_GetLastError();
442 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
446 win32_set_short_name(const wchar_t *path, const wchar_t *short_name,
447 size_t short_name_nchars, struct apply_ctx *ctx)
452 h = CreateFile(path, GENERIC_WRITE | DELETE, 0, NULL,
453 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
454 FILE_FLAG_OPEN_REPARSE_POINT,
456 if (h == INVALID_HANDLE_VALUE)
459 if (short_name_nchars) {
460 if (!SetFileShortName(h, short_name))
461 goto error_close_handle;
462 } else if (running_on_windows_7_or_later()) {
463 if (!SetFileShortName(h, L""))
464 goto error_close_handle;
473 err = GetLastError();
477 set_errno_from_GetLastError();
478 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
482 win32_set_security_descriptor(const wchar_t *path, const u8 *desc, size_t desc_size,
483 struct apply_ctx *ctx)
485 SECURITY_INFORMATION info;
487 info = OWNER_SECURITY_INFORMATION |
488 GROUP_SECURITY_INFORMATION |
489 DACL_SECURITY_INFORMATION |
490 SACL_SECURITY_INFORMATION;
492 if (!SetFileSecurity(path, info, (PSECURITY_DESCRIPTOR)desc)) {
493 if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
494 GetLastError() == ERROR_PRIVILEGE_NOT_HELD &&
495 (info & SACL_SECURITY_INFORMATION))
497 info &= ~SACL_SECURITY_INFORMATION;
505 set_errno_from_GetLastError();
506 return WIMLIB_ERR_SET_SECURITY;
510 win32_set_timestamps(const wchar_t *path, u64 creation_time,
511 u64 last_write_time, u64 last_access_time,
512 struct apply_ctx *ctx)
516 FILETIME creationTime = {.dwLowDateTime = creation_time & 0xffffffff,
517 .dwHighDateTime = creation_time >> 32};
518 FILETIME lastAccessTime = {.dwLowDateTime = last_access_time & 0xffffffff,
519 .dwHighDateTime = last_access_time >> 32};
520 FILETIME lastWriteTime = {.dwLowDateTime = last_write_time & 0xffffffff,
521 .dwHighDateTime = last_write_time >> 32};
523 h = CreateFile(path, FILE_WRITE_ATTRIBUTES, 0, NULL,
524 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
525 FILE_FLAG_OPEN_REPARSE_POINT,
527 if (h == INVALID_HANDLE_VALUE)
530 if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime))
531 goto error_close_handle;
539 err = GetLastError();
543 set_errno_from_GetLastError();
544 return WIMLIB_ERR_SET_TIMESTAMPS;
547 const struct apply_operations win32_apply_ops = {
550 .target_is_root = win32_path_is_root_of_drive,
551 .start_extract = win32_start_extract,
552 .create_file = win32_create_file,
553 .create_directory = win32_create_directory,
554 .create_hardlink = win32_create_hardlink,
555 .create_symlink = win32_create_symlink,
556 .extract_unnamed_stream = win32_extract_unnamed_stream,
557 .extract_named_stream = win32_extract_named_stream,
558 .extract_encrypted_stream = win32_extract_encrypted_stream,
559 .set_file_attributes = win32_set_file_attributes,
560 .set_reparse_data = win32_set_reparse_data,
561 .set_short_name = win32_set_short_name,
562 .set_security_descriptor = win32_set_security_descriptor,
563 .set_timestamps = win32_set_timestamps,
565 .path_prefix = L"\\\\?\\",
566 .path_prefix_nchars = 4,
567 .path_separator = L'\\',
570 .requires_realtarget_in_paths = 1,
571 .realpath_works_on_nonexisting_files = 1,
572 .root_directory_is_special = 1,
573 .requires_final_set_attributes_pass = 1,
576 #endif /* __WIN32__ */