+ /* Nothing needs to be done. */
+ return 0;
+ }
+
+ /* Set the new compression state */
+
+ if (compressed)
+ compression_state = COMPRESSION_FORMAT_DEFAULT;
+ else
+ compression_state = COMPRESSION_FORMAT_NONE;
+
+ status = (*func_NtFsControlFile)(h,
+ NULL,
+ NULL,
+ NULL,
+ &ctx->iosb,
+ FSCTL_SET_COMPRESSION,
+ &compression_state,
+ sizeof(USHORT),
+ NULL,
+ 0);
+ if (NT_SUCCESS(status))
+ return 0;
+
+ winnt_error(status, L"Can't %s compression attribute on \"%ls\"",
+ (compressed ? "set" : "clear"), current_path(ctx));
+ return WIMLIB_ERR_SET_ATTRIBUTES;
+}
+
+/* Try to enable short name support on the target volume. If successful, return
+ * true. If unsuccessful, issue a warning and return false. */
+static bool
+try_to_enable_short_names(const wchar_t *volume)
+{
+ HANDLE h;
+ FILE_FS_PERSISTENT_VOLUME_INFORMATION info;
+ BOOL bret;
+ DWORD bytesReturned;
+
+ h = CreateFile(volume, GENERIC_WRITE,
+ FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
+ FILE_FLAG_BACKUP_SEMANTICS, NULL);
+ if (h == INVALID_HANDLE_VALUE)
+ goto fail;
+
+ info.VolumeFlags = 0;
+ info.FlagMask = PERSISTENT_VOLUME_STATE_SHORT_NAME_CREATION_DISABLED;
+ info.Version = 1;
+ info.Reserved = 0;
+
+ bret = DeviceIoControl(h, FSCTL_SET_PERSISTENT_VOLUME_STATE,
+ &info, sizeof(info), NULL, 0,
+ &bytesReturned, NULL);
+
+ CloseHandle(h);
+
+ if (!bret)
+ goto fail;
+ return true;
+
+fail:
+ win32_warning(GetLastError(),
+ L"Failed to enable short name support on %ls",
+ volume + 4);
+ return false;
+}
+
+static NTSTATUS
+remove_conflicting_short_name(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
+{
+ wchar_t *name;
+ wchar_t *end;
+ NTSTATUS status;
+ HANDLE h;
+ size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
+ (13 * sizeof(wchar_t));
+ u8 buf[bufsize] _aligned_attribute(8);
+ bool retried = false;
+ FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
+
+ memset(buf, 0, bufsize);
+
+ /* Build the path with the short name. */
+ name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
+ while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
+ name--;
+ end = mempcpy(name, dentry->short_name, dentry->short_name_nbytes);
+ ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
+
+ /* Open the conflicting file (by short name). */
+ status = (*func_NtOpenFile)(&h, GENERIC_WRITE | DELETE,
+ &ctx->attr, &ctx->iosb,
+ FILE_SHARE_VALID_FLAGS,
+ FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT);
+ if (!NT_SUCCESS(status)) {
+ winnt_warning(status, L"Can't open \"%ls\"", current_path(ctx));
+ goto out;
+ }
+
+#if 0
+ WARNING("Overriding conflicting short name; path=\"%ls\"",
+ current_path(ctx));
+#endif
+
+ /* Try to remove the short name on the conflicting file. */
+
+retry:
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
+ FileShortNameInformation);
+
+ if (status == STATUS_INVALID_PARAMETER && !retried) {
+
+ /* Microsoft forgot to make it possible to remove short names
+ * until Windows 7. Oops. Use a random short name instead. */
+
+ info->FileNameLength = 12 * sizeof(wchar_t);
+ for (int i = 0; i < 8; i++)
+ info->FileName[i] = 'A' + (rand() % 26);
+ info->FileName[8] = L'.';
+ info->FileName[9] = L'W';
+ info->FileName[10] = L'L';
+ info->FileName[11] = L'B';
+ info->FileName[12] = L'\0';
+ retried = true;
+ goto retry;
+ }
+ (*func_NtClose)(h);
+out:
+ build_extraction_path(dentry, ctx);
+ return status;
+}
+
+/* Set the short name on the open file @h which has been created at the location
+ * indicated by @dentry.
+ *
+ * Note that this may add, change, or remove the short name.
+ *
+ * @h must be opened with DELETE access.
+ *
+ * Returns 0 or WIMLIB_ERR_SET_SHORT_NAME. The latter only happens in
+ * STRICT_SHORT_NAMES mode.
+ */
+static int
+set_short_name(HANDLE h, const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+
+ if (!ctx->common.supported_features.short_names)
+ return 0;
+
+ /*
+ * Note: The size of the FILE_NAME_INFORMATION buffer must be such that
+ * FileName contains at least 2 wide characters (4 bytes). Otherwise,
+ * NtSetInformationFile() will return STATUS_INFO_LENGTH_MISMATCH. This
+ * is despite the fact that FileNameLength can validly be 0 or 2 bytes,
+ * with the former case being removing the existing short name if
+ * present, rather than setting one.
+ *
+ * The null terminator is seemingly optional, but to be safe we include
+ * space for it and zero all unused space.
+ */
+
+ size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
+ max(dentry->short_name_nbytes, sizeof(wchar_t)) +
+ sizeof(wchar_t);
+ u8 buf[bufsize] _aligned_attribute(8);
+ FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
+ NTSTATUS status;
+ bool tried_to_remove_existing = false;
+
+ memset(buf, 0, bufsize);
+
+ info->FileNameLength = dentry->short_name_nbytes;
+ memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
+
+retry:
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
+ FileShortNameInformation);
+ if (NT_SUCCESS(status))
+ return 0;
+
+ if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
+ if (dentry->short_name_nbytes == 0)
+ return 0;
+ if (!ctx->tried_to_enable_short_names) {
+ wchar_t volume[7];
+ int ret;
+
+ ctx->tried_to_enable_short_names = true;
+
+ ret = win32_get_drive_path(ctx->common.target,
+ volume);
+ if (ret)
+ return ret;
+ if (try_to_enable_short_names(volume))
+ goto retry;
+ }
+ }
+
+ /*
+ * Short names can conflict in several cases:
+ *
+ * - a file being extracted has a short name conflicting with an
+ * existing file
+ *
+ * - a file being extracted has a short name conflicting with another
+ * file being extracted (possible, but shouldn't happen)
+ *
+ * - a file being extracted has a short name that conflicts with the
+ * automatically generated short name of a file we previously
+ * extracted, but failed to set the short name for. Sounds unlikely,
+ * but this actually does happen fairly often on versions of Windows
+ * prior to Windows 7 because they do not support removing short names
+ * from files.
+ */
+ if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
+ dentry->short_name_nbytes && !tried_to_remove_existing)
+ {
+ tried_to_remove_existing = true;
+ status = remove_conflicting_short_name(dentry, ctx);
+ if (NT_SUCCESS(status))
+ goto retry;
+ }
+
+ /* By default, failure to set short names is not an error (since short
+ * names aren't too important anymore...). */
+ if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
+ if (dentry->short_name_nbytes)
+ ctx->num_set_short_name_failures++;
+ else
+ ctx->num_remove_short_name_failures++;
+ return 0;
+ }
+
+ winnt_error(status, L"Can't set short name on \"%ls\"", current_path(ctx));
+ return WIMLIB_ERR_SET_SHORT_NAME;
+}
+
+/*
+ * A wrapper around NtCreateFile() to make it slightly more usable...
+ * This uses the path currently constructed in ctx->pathbuf.
+ *
+ * Also, we always specify FILE_OPEN_FOR_BACKUP_INTENT and
+ * FILE_OPEN_REPARSE_POINT.
+ */
+static NTSTATUS
+do_create_file(PHANDLE FileHandle,
+ ACCESS_MASK DesiredAccess,
+ PLARGE_INTEGER AllocationSize,
+ ULONG FileAttributes,
+ ULONG CreateDisposition,
+ ULONG CreateOptions,
+ struct win32_apply_ctx *ctx)
+{
+ return (*func_NtCreateFile)(FileHandle,
+ DesiredAccess,
+ &ctx->attr,
+ &ctx->iosb,
+ AllocationSize,
+ FileAttributes,
+ FILE_SHARE_VALID_FLAGS,
+ CreateDisposition,
+ CreateOptions |
+ FILE_OPEN_FOR_BACKUP_INTENT |
+ FILE_OPEN_REPARSE_POINT,
+ NULL,
+ 0);
+}
+
+/* Like do_create_file(), but builds the extraction path of the @dentry first.
+ */
+static NTSTATUS
+create_file(PHANDLE FileHandle,
+ ACCESS_MASK DesiredAccess,
+ PLARGE_INTEGER AllocationSize,
+ ULONG FileAttributes,
+ ULONG CreateDisposition,
+ ULONG CreateOptions,
+ const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+ build_extraction_path(dentry, ctx);
+ return do_create_file(FileHandle,
+ DesiredAccess,
+ AllocationSize,
+ FileAttributes,
+ CreateDisposition,
+ CreateOptions,
+ ctx);
+}
+
+static int
+delete_file_or_stream(struct win32_apply_ctx *ctx)
+{
+ NTSTATUS status;
+ HANDLE h;
+ FILE_DISPOSITION_INFORMATION disposition_info;
+ FILE_BASIC_INFORMATION basic_info;
+ bool retried = false;
+
+ status = do_create_file(&h,
+ DELETE,
+ NULL,
+ 0,
+ FILE_OPEN,
+ FILE_NON_DIRECTORY_FILE,
+ ctx);
+ if (unlikely(!NT_SUCCESS(status))) {
+ winnt_error(status, L"Can't open \"%ls\" for deletion",
+ current_path(ctx));
+ return WIMLIB_ERR_OPEN;
+ }
+
+retry:
+ disposition_info.DoDeleteFile = TRUE;
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb,
+ &disposition_info,
+ sizeof(disposition_info),
+ FileDispositionInformation);
+ (*func_NtClose)(h);
+ if (likely(NT_SUCCESS(status)))
+ return 0;
+
+ if (status == STATUS_CANNOT_DELETE && !retried) {
+ /* Clear file attributes and try again. This is necessary for
+ * FILE_ATTRIBUTE_READONLY files. */
+ status = do_create_file(&h,
+ FILE_WRITE_ATTRIBUTES | DELETE,
+ NULL,
+ 0,
+ FILE_OPEN,
+ FILE_NON_DIRECTORY_FILE,
+ ctx);
+ if (!NT_SUCCESS(status)) {
+ winnt_error(status,
+ L"Can't open \"%ls\" to reset attributes",
+ current_path(ctx));
+ return WIMLIB_ERR_OPEN;
+ }
+ memset(&basic_info, 0, sizeof(basic_info));
+ basic_info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb,
+ &basic_info,
+ sizeof(basic_info),
+ FileBasicInformation);
+ if (!NT_SUCCESS(status)) {
+ winnt_error(status,
+ L"Can't reset file attributes on \"%ls\"",
+ current_path(ctx));
+ (*func_NtClose)(h);
+ return WIMLIB_ERR_SET_ATTRIBUTES;
+ }
+ retried = true;
+ goto retry;
+ }
+ winnt_error(status, L"Can't delete \"%ls\"", current_path(ctx));
+ return WIMLIB_ERR_OPEN;
+}
+
+/*
+ * Create a nondirectory file or named data stream at the current path,
+ * superseding any that already exists at that path. If successful, return an
+ * open handle to the file or named data stream.
+ */
+static int
+supersede_file_or_stream(struct win32_apply_ctx *ctx, HANDLE *h_ret)
+{
+ NTSTATUS status;
+ bool retried = false;
+
+ /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
+ * FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
+retry:
+ status = do_create_file(h_ret,
+ GENERIC_READ | GENERIC_WRITE | DELETE,
+ NULL,
+ FILE_ATTRIBUTE_SYSTEM,
+ FILE_CREATE,
+ FILE_NON_DIRECTORY_FILE,
+ ctx);
+ if (likely(NT_SUCCESS(status)))
+ return 0;
+
+ /* STATUS_OBJECT_NAME_COLLISION means that the file or stream already
+ * exists. Delete the existing file or stream, then try again.
+ *
+ * Note: we don't use FILE_OVERWRITE_IF or FILE_SUPERSEDE because of
+ * problems with certain file attributes, especially
+ * FILE_ATTRIBUTE_ENCRYPTED. FILE_SUPERSEDE is also broken in the
+ * Windows PE ramdisk. */
+ if (status == STATUS_OBJECT_NAME_COLLISION && !retried) {
+ int ret = delete_file_or_stream(ctx);
+ if (ret)
+ return ret;
+ retried = true;
+ goto retry;
+ }
+ winnt_error(status, L"Can't create \"%ls\"", current_path(ctx));
+ return WIMLIB_ERR_OPEN;
+}
+
+/* Create empty named data streams.
+ *
+ * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
+ * in the call to extract_stream_list(). Hence the need for the special case.
+ */
+static int
+create_any_empty_ads(const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+ const struct wim_inode *inode = dentry->d_inode;
+ bool path_modified = false;
+ int ret = 0;
+
+ if (!ctx->common.supported_features.named_data_streams)
+ return 0;
+
+ for (u16 i = 0; i < inode->i_num_ads; i++) {
+ const struct wim_ads_entry *entry;