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;
50 ctx->supported_features.compressed_files = !!(vol_flags & FILE_FILE_COMPRESSION);
51 ctx->supported_features.encrypted_files = !!(vol_flags & FILE_SUPPORTS_ENCRYPTION);
52 ctx->supported_features.encrypted_directories = !!(vol_flags & FILE_SUPPORTS_ENCRYPTION);
53 ctx->supported_features.not_context_indexed_files = 1;
54 ctx->supported_features.sparse_files = !!(vol_flags & FILE_SUPPORTS_SPARSE_FILES);
55 ctx->supported_features.named_data_streams = !!(vol_flags & FILE_NAMED_STREAMS);
56 ctx->supported_features.hard_links = !!(vol_flags & FILE_SUPPORTS_HARD_LINKS);
57 ctx->supported_features.reparse_points = !!(vol_flags & FILE_SUPPORTS_REPARSE_POINTS);
58 ctx->supported_features.security_descriptors = !!(vol_flags & FILE_PERSISTENT_ACLS);
59 ctx->supported_features.short_names = !!supports_SetFileShortName;
64 win32_create_file(const wchar_t *path, struct apply_ctx *ctx)
68 h = CreateFile(path, 0, 0, NULL, CREATE_ALWAYS,
69 FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS, NULL);
70 if (h == INVALID_HANDLE_VALUE)
76 set_errno_from_GetLastError();
77 return WIMLIB_ERR_OPEN;
81 win32_create_directory(const wchar_t *path, struct apply_ctx *ctx)
83 if (!CreateDirectory(path, NULL))
84 if (GetLastError() != ERROR_ALREADY_EXISTS)
89 set_errno_from_GetLastError();
90 return WIMLIB_ERR_MKDIR;
94 win32_create_hardlink(const wchar_t *oldpath, const wchar_t *newpath,
95 struct apply_ctx *ctx)
97 if (!CreateHardLink(newpath, oldpath, NULL))
102 set_errno_from_GetLastError();
103 return WIMLIB_ERR_LINK;
107 win32_extract_wim_chunk(const void *buf, size_t len, void *arg)
109 HANDLE h = (HANDLE)arg;
110 DWORD nbytes_written;
112 if (unlikely(!WriteFile(h, buf, len, &nbytes_written, NULL)))
114 if (unlikely(nbytes_written != len))
119 set_errno_from_GetLastError();
120 return WIMLIB_ERR_WRITE;
124 win32_extract_stream(const wchar_t *path, const wchar_t *stream_name,
125 size_t stream_name_nchars,
126 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
128 DWORD creationDisposition = OPEN_EXISTING;
129 wchar_t *stream_path = (wchar_t*)path;
133 if (stream_name_nchars) {
134 creationDisposition = CREATE_ALWAYS;
135 stream_path = alloca(sizeof(wchar_t) *
137 wcslen(stream_name) + 1));
138 swprintf(stream_path, L"%ls:%ls", path, stream_name);
141 h = CreateFile(stream_path, FILE_WRITE_DATA, 0, NULL,
142 creationDisposition, FILE_FLAG_BACKUP_SEMANTICS |
143 FILE_FLAG_OPEN_REPARSE_POINT,
145 if (h == INVALID_HANDLE_VALUE)
150 goto out_close_handle;
151 ret = extract_wim_resource(lte, wim_resource_size(lte),
152 win32_extract_wim_chunk, h);
161 set_errno_from_GetLastError();
162 return WIMLIB_ERR_WRITE;
166 win32_extract_unnamed_stream(file_spec_t file,
167 struct wim_lookup_table_entry *lte,
168 struct apply_ctx *ctx)
170 return win32_extract_stream(file.path, NULL, 0, lte, ctx);
174 win32_extract_named_stream(file_spec_t file, const wchar_t *stream_name,
175 size_t stream_name_nchars,
176 struct wim_lookup_table_entry *lte, struct apply_ctx *ctx)
178 return win32_extract_stream(file.path, stream_name,
179 stream_name_nchars, lte, ctx);
182 struct win32_encrypted_extract_ctx {
183 const struct wim_lookup_table_entry *lte;
188 win32_encrypted_import_cb(unsigned char *data, void *_import_ctx,
189 unsigned long *len_p)
191 struct win32_encrypted_extract_ctx *import_ctx = _import_ctx;
192 unsigned long len = *len_p;
193 const struct wim_lookup_table_entry *lte = import_ctx->lte;
195 len = min(len, wim_resource_size(lte) - import_ctx->offset);
197 if (read_partial_wim_resource_into_buf(lte, len, import_ctx->offset, data))
198 return ERROR_READ_FAULT;
200 import_ctx->offset += len;
202 return ERROR_SUCCESS;
206 win32_extract_encrypted_stream(const wchar_t *path,
207 struct wim_lookup_table_entry *lte,
208 struct apply_ctx *ctx)
213 struct win32_encrypted_extract_ctx extract_ctx;
215 err = OpenEncryptedFileRaw(path, CREATE_FOR_IMPORT, &file_ctx);
216 if (err != ERROR_SUCCESS) {
217 errno = win32_error_to_errno(err);
218 ret = WIMLIB_ERR_OPEN;
222 extract_ctx.lte = lte;
223 extract_ctx.offset = 0;
224 err = WriteEncryptedFileRaw(win32_encrypted_import_cb, &extract_ctx,
226 if (err != ERROR_SUCCESS) {
227 errno = win32_error_to_errno(err);
228 ret = WIMLIB_ERR_WRITE;
234 CloseEncryptedFileRaw(file_ctx);
240 win32_set_special_file_attributes(const wchar_t *path, u32 attributes)
244 USHORT compression_format = COMPRESSION_FORMAT_DEFAULT;
245 DWORD bytes_returned;
247 h = CreateFile(path, GENERIC_READ | GENERIC_WRITE, 0, NULL,
248 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
249 FILE_FLAG_OPEN_REPARSE_POINT,
251 if (h == INVALID_HANDLE_VALUE)
254 if (attributes & FILE_ATTRIBUTE_SPARSE_FILE)
255 if (!DeviceIoControl(h, FSCTL_SET_SPARSE,
258 &bytes_returned, NULL))
259 goto error_close_handle;
261 if (attributes & FILE_ATTRIBUTE_COMPRESSED)
262 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
263 &compression_format, sizeof(USHORT),
265 &bytes_returned, NULL))
266 goto error_close_handle;
271 if (attributes & FILE_ATTRIBUTE_ENCRYPTED)
272 if (!EncryptFile(path))
278 err = GetLastError();
286 win32_set_file_attributes(const wchar_t *path, u32 attributes,
287 struct apply_ctx *ctx)
289 u32 special_attributes =
290 FILE_ATTRIBUTE_REPARSE_POINT |
291 FILE_ATTRIBUTE_DIRECTORY |
292 FILE_ATTRIBUTE_SPARSE_FILE |
293 FILE_ATTRIBUTE_COMPRESSED |
294 FILE_ATTRIBUTE_ENCRYPTED;
295 u32 actual_attributes;
297 if (!SetFileAttributes(path, attributes & ~special_attributes))
300 if (attributes & (FILE_ATTRIBUTE_SPARSE_FILE |
301 FILE_ATTRIBUTE_ENCRYPTED |
302 FILE_ATTRIBUTE_COMPRESSED))
303 if (!win32_set_special_file_attributes(path, attributes))
306 /* If file is not supposed to be encrypted or compressed, remove
307 * defaulted encrypted or compressed attributes (from creating file in
308 * encrypted or compressed directory). */
309 actual_attributes = GetFileAttributes(path);
310 if (actual_attributes == INVALID_FILE_ATTRIBUTES)
313 if ((actual_attributes & FILE_ATTRIBUTE_ENCRYPTED) &&
314 !(attributes & FILE_ATTRIBUTE_ENCRYPTED))
315 if (!DecryptFile(path, 0))
317 if ((actual_attributes & FILE_ATTRIBUTE_COMPRESSED) &&
318 !(attributes & FILE_ATTRIBUTE_COMPRESSED))
321 DWORD bytes_returned;
322 USHORT compression_format = COMPRESSION_FORMAT_NONE;
324 h = CreateFile(path, GENERIC_READ | GENERIC_WRITE, 0, NULL,
325 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
326 FILE_FLAG_OPEN_REPARSE_POINT,
328 if (h == INVALID_HANDLE_VALUE)
331 if (!DeviceIoControl(h, FSCTL_SET_COMPRESSION,
332 &compression_format, sizeof(USHORT),
334 &bytes_returned, NULL))
336 DWORD err = GetLastError();
350 set_errno_from_GetLastError();
351 return WIMLIB_ERR_SET_ATTRIBUTES;
355 win32_set_reparse_data(const wchar_t *path, const u8 *rpbuf, u16 rpbuflen,
356 struct apply_ctx *ctx)
360 DWORD bytes_returned;
362 h = CreateFile(path, GENERIC_WRITE, 0, NULL,
363 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
364 FILE_FLAG_OPEN_REPARSE_POINT,
366 if (h == INVALID_HANDLE_VALUE)
369 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
370 (void*)rpbuf, rpbuflen,
371 NULL, 0, &bytes_returned, NULL))
372 goto error_close_handle;
380 err = GetLastError();
384 set_errno_from_GetLastError();
385 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
389 win32_set_short_name(const wchar_t *path, const wchar_t *short_name,
390 size_t short_name_nchars, struct apply_ctx *ctx)
395 h = CreateFile(path, GENERIC_WRITE | DELETE, 0, NULL,
396 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
397 FILE_FLAG_OPEN_REPARSE_POINT,
399 if (h == INVALID_HANDLE_VALUE)
402 if (short_name_nchars) {
403 if (!SetFileShortName(h, short_name))
404 goto error_close_handle;
405 } else if (running_on_windows_7_or_later()) {
406 if (!SetFileShortName(h, L""))
407 goto error_close_handle;
416 err = GetLastError();
420 set_errno_from_GetLastError();
421 return WIMLIB_ERR_WRITE; /* XXX: need better error code */
425 win32_set_security_descriptor(const wchar_t *path, const u8 *desc, size_t desc_size,
426 struct apply_ctx *ctx)
428 SECURITY_INFORMATION info;
430 info = OWNER_SECURITY_INFORMATION |
431 GROUP_SECURITY_INFORMATION |
432 DACL_SECURITY_INFORMATION |
433 SACL_SECURITY_INFORMATION;
435 if (!SetFileSecurity(path, info, (PSECURITY_DESCRIPTOR)desc)) {
436 if (!(ctx->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) &&
437 GetLastError() == ERROR_PRIVILEGE_NOT_HELD &&
438 (info & SACL_SECURITY_INFORMATION))
440 info &= ~SACL_SECURITY_INFORMATION;
448 set_errno_from_GetLastError();
449 return WIMLIB_ERR_SET_SECURITY;
453 win32_set_timestamps(const wchar_t *path, u64 creation_time,
454 u64 last_write_time, u64 last_access_time,
455 struct apply_ctx *ctx)
459 FILETIME creationTime = {.dwLowDateTime = creation_time & 0xffffffff,
460 .dwHighDateTime = creation_time >> 32};
461 FILETIME lastAccessTime = {.dwLowDateTime = last_access_time & 0xffffffff,
462 .dwHighDateTime = last_access_time >> 32};
463 FILETIME lastWriteTime = {.dwLowDateTime = last_write_time & 0xffffffff,
464 .dwHighDateTime = last_write_time >> 32};
466 h = CreateFile(path, FILE_WRITE_ATTRIBUTES, 0, NULL,
467 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS |
468 FILE_FLAG_OPEN_REPARSE_POINT,
470 if (h == INVALID_HANDLE_VALUE)
473 if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime))
474 goto error_close_handle;
482 err = GetLastError();
486 set_errno_from_GetLastError();
487 return WIMLIB_ERR_SET_TIMESTAMPS;
490 const struct apply_operations win32_apply_ops = {
493 .target_is_root = win32_path_is_root_of_drive,
494 .start_extract = win32_start_extract,
495 .create_file = win32_create_file,
496 .create_directory = win32_create_directory,
497 .create_hardlink = win32_create_hardlink,
498 .extract_unnamed_stream = win32_extract_unnamed_stream,
499 .extract_named_stream = win32_extract_named_stream,
500 .extract_encrypted_stream = win32_extract_encrypted_stream,
501 .set_file_attributes = win32_set_file_attributes,
502 .set_reparse_data = win32_set_reparse_data,
503 .set_short_name = win32_set_short_name,
504 .set_security_descriptor = win32_set_security_descriptor,
505 .set_timestamps = win32_set_timestamps,
507 .path_prefix = L"\\\\?\\",
508 .path_prefix_nchars = 4,
509 .path_separator = L'\\',
512 .requires_realtarget_in_paths = 1,
513 .realpath_works_on_nonexisting_files = 1,
514 .root_directory_is_special = 1,
517 #endif /* __WIN32__ */