+/*
+ * Creates the directory named by @dentry, or uses an existing directory at that
+ * location. If necessary, sets the short name and/or fixes compression and
+ * encryption attributes.
+ *
+ * Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
+ */
+static int
+create_directory(const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+ HANDLE h;
+ NTSTATUS status;
+ int ret;
+ ULONG attrib;
+
+ /* Special attributes:
+ *
+ * Use FILE_ATTRIBUTE_ENCRYPTED if the directory needs to have it set.
+ * This doesn't work for FILE_ATTRIBUTE_COMPRESSED (unfortunately).
+ *
+ * Don't specify FILE_ATTRIBUTE_DIRECTORY; it gets set anyway as a
+ * result of the FILE_DIRECTORY_FILE option. */
+ attrib = (dentry->d_inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED);
+
+ /* DELETE is needed for set_short_name().
+ * GENERIC_READ and GENERIC_WRITE are needed for
+ * adjust_compression_attribute(). */
+ status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
+ attrib, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
+ dentry, ctx);
+ if (!NT_SUCCESS(status)) {
+ set_errno_from_nt_status(status);
+ ERROR_WITH_ERRNO("Can't create directory \"%ls\" "
+ "(status=0x%08"PRIx32")",
+ current_path(ctx), (u32)status);
+ return WIMLIB_ERR_MKDIR;
+ }
+
+ ret = set_short_name(h, dentry, ctx);
+
+ if (!ret)
+ ret = adjust_compression_attribute(h, dentry, ctx);
+
+ if (!ret)
+ ret = maybe_clear_encryption_attribute(&h, dentry, ctx);
+ /* May close the handle!!! */
+
+ if (h)
+ (*func_NtClose)(h);
+ return ret;
+}
+
+/*
+ * Create all the directories being extracted, other than the target directory
+ * itself.
+ *
+ * Note: we don't honor directory hard links. However, we don't allow them to
+ * exist in WIM images anyway (see inode_fixup.c).
+ */
+static int
+create_directories(struct list_head *dentry_list,
+ struct win32_apply_ctx *ctx)
+{
+ const struct wim_dentry *dentry;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
+
+ if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
+ continue;
+
+ /* Note: Here we include files with
+ * FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
+ * wait until later to actually set the reparse data. */
+
+ /* If the root dentry is being extracted, it was already done so
+ * in prepare_target(). */
+ if (!dentry_is_root(dentry)) {
+ ret = create_directory(dentry, ctx);
+ ret = check_apply_error(dentry, ctx, ret);
+ if (ret)
+ return ret;
+
+ ret = create_any_empty_ads(dentry, ctx);
+ ret = check_apply_error(dentry, ctx, ret);
+ if (ret)
+ return ret;
+ }
+
+ ret = report_file_created(&ctx->common);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+/*
+ * Creates the nondirectory file named by @dentry.
+ *
+ * On success, returns an open handle to the file in @h_ret, with GENERIC_READ,
+ * GENERIC_WRITE, and DELETE access. Also, the path to the file will be saved
+ * in ctx->pathbuf. On failure, returns WIMLIB_ERR_OPEN.
+ */
+static int
+create_nondirectory_inode(HANDLE *h_ret, const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+ const struct wim_inode *inode;
+ ULONG attrib;
+ NTSTATUS status;
+ bool retried = false;
+ DWORD disposition;
+
+ inode = dentry->d_inode;
+
+ /* If the file already exists and has FILE_ATTRIBUTE_SYSTEM and/or
+ * FILE_ATTRIBUTE_HIDDEN, these must be specified in order to supersede
+ * the file.
+ *
+ * Normally the user shouldn't be trying to overwrite such files anyway,
+ * but we at least provide FILE_ATTRIBUTE_SYSTEM and
+ * FILE_ATTRIBUTE_HIDDEN if the WIM inode has those attributes so that
+ * we catch the case where the user extracts the same files to the same
+ * location more than one time.
+ *
+ * Also specify FILE_ATTRIBUTE_ENCRYPTED if the file needs to be
+ * encrypted.
+ *
+ * In NO_ATTRIBUTES mode just don't specify any attributes at all.
+ */
+ if (ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES) {
+ attrib = 0;
+ } else {
+ attrib = (inode->i_attributes & (FILE_ATTRIBUTE_SYSTEM |
+ FILE_ATTRIBUTE_HIDDEN |
+ FILE_ATTRIBUTE_ENCRYPTED));
+ }
+ build_extraction_path(dentry, ctx);
+ disposition = FILE_SUPERSEDE;
+retry:
+ status = do_create_file(h_ret, GENERIC_READ | GENERIC_WRITE | DELETE,
+ NULL, attrib, disposition,
+ FILE_NON_DIRECTORY_FILE, ctx);
+ if (likely(NT_SUCCESS(status))) {
+ int ret;
+
+ ret = adjust_compression_attribute(*h_ret, dentry, ctx);
+ if (ret) {
+ (*func_NtClose)(*h_ret);
+ return ret;
+ }
+
+ ret = maybe_clear_encryption_attribute(h_ret, dentry, ctx);
+ /* May close the handle!!! */
+
+ if (ret) {
+ if (*h_ret)
+ (*func_NtClose)(*h_ret);
+ return ret;
+ }
+
+ if (!*h_ret) {
+ /* Re-open the handle so that we can return it on
+ * success. */
+ status = do_create_file(h_ret,
+ GENERIC_READ |
+ GENERIC_WRITE | DELETE,
+ NULL, 0, FILE_OPEN,
+ FILE_NON_DIRECTORY_FILE, ctx);
+ if (!NT_SUCCESS(status))
+ goto fail;
+ }
+
+ ret = create_any_empty_ads(dentry, ctx);
+ if (ret) {
+ (*func_NtClose)(*h_ret);
+ return ret;
+ }
+ return 0;
+ }
+
+ if (status == STATUS_OBJECT_NAME_NOT_FOUND && !retried) {
+ /* Workaround for defect in the Windows PE in-memory filesystem
+ * implementation: FILE_SUPERSEDE does not create the file, as
+ * expected and documented, when the named file does not exist.
+ */
+ retried = true;
+ disposition = FILE_CREATE;
+ goto retry;
+ }
+
+ if (status == STATUS_ACCESS_DENIED && !retried) {
+ /* We also can't supersede an existing file that has
+ * FILE_ATTRIBUTE_READONLY set; doing so causes NtCreateFile()
+ * to return STATUS_ACCESS_DENIED . The only workaround seems
+ * to be to explicitly remove FILE_ATTRIBUTE_READONLY on the
+ * existing file, then try again. */
+
+ FILE_BASIC_INFORMATION info;
+ HANDLE h;
+
+ status = do_create_file(&h, FILE_WRITE_ATTRIBUTES, NULL, 0,
+ FILE_OPEN, FILE_NON_DIRECTORY_FILE, ctx);
+ if (!NT_SUCCESS(status))
+ goto fail;
+
+ memset(&info, 0, sizeof(info));
+ info.FileAttributes = FILE_ATTRIBUTE_NORMAL;
+
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb,
+ &info, sizeof(info),
+ FileBasicInformation);
+ (*func_NtClose)(h);
+ if (!NT_SUCCESS(status))
+ goto fail;
+ retried = true;
+ goto retry;
+ }
+fail:
+ set_errno_from_nt_status(status);
+ ERROR_WITH_ERRNO("Can't create file \"%ls\" (status=0x%08"PRIx32")",
+ current_path(ctx), (u32)status);
+ return WIMLIB_ERR_OPEN;
+}
+
+/* Creates a hard link at the location named by @dentry to the file represented
+ * by the open handle @h. Or, if the target volume does not support hard links,
+ * create a separate file instead. */
+static int
+create_link(HANDLE h, const struct wim_dentry *dentry,
+ struct win32_apply_ctx *ctx)
+{
+ if (ctx->common.supported_features.hard_links) {
+
+ build_extraction_path(dentry, ctx);
+
+ size_t bufsize = offsetof(FILE_LINK_INFORMATION, FileName) +
+ ctx->pathbuf.Length + sizeof(wchar_t);
+ u8 buf[bufsize] _aligned_attribute(8);
+ FILE_LINK_INFORMATION *info = (FILE_LINK_INFORMATION *)buf;
+ NTSTATUS status;
+
+ info->ReplaceIfExists = TRUE;
+ info->RootDirectory = ctx->attr.RootDirectory;
+ info->FileNameLength = ctx->pathbuf.Length;
+ memcpy(info->FileName, ctx->pathbuf.Buffer, ctx->pathbuf.Length);
+ info->FileName[info->FileNameLength / 2] = L'\0';
+
+ /* Note: the null terminator isn't actually necessary,
+ * but if you don't add the extra character, you get
+ * STATUS_INFO_LENGTH_MISMATCH when FileNameLength
+ * happens to be 2 */
+
+ status = (*func_NtSetInformationFile)(h, &ctx->iosb,
+ info, bufsize,
+ FileLinkInformation);
+ if (NT_SUCCESS(status))
+ return 0;
+ ERROR("Failed to create link \"%ls\" (status=0x%08"PRIx32")",
+ current_path(ctx), (u32)status);
+ return WIMLIB_ERR_LINK;
+ } else {
+ HANDLE h2;
+ int ret;
+
+ ret = create_nondirectory_inode(&h2, dentry, ctx);
+ if (ret)
+ return ret;
+
+ (*func_NtClose)(h2);
+ return 0;
+ }
+}
+
+/* Given an inode (represented by the open handle @h) for which one link has
+ * been created (named by @first_dentry), create the other links.
+ *
+ * Or, if the target volume does not support hard links, create separate files.
+ *
+ * Note: This uses ctx->pathbuf and does not reset it.
+ */
+static int
+create_links(HANDLE h, const struct wim_dentry *first_dentry,
+ struct win32_apply_ctx *ctx)
+{
+ const struct wim_inode *inode;
+ const struct list_head *next;
+ const struct wim_dentry *dentry;
+ int ret;
+
+ inode = first_dentry->d_inode;
+ next = inode->i_extraction_aliases.next;
+ do {
+ dentry = list_entry(next, struct wim_dentry,
+ d_extraction_alias_node);
+ if (dentry != first_dentry) {
+ ret = create_link(h, dentry, ctx);
+ if (ret)
+ return ret;
+ }
+ next = next->next;
+ } while (next != &inode->i_extraction_aliases);
+ return 0;
+}
+
+/* Create a nondirectory file, including all links. */
+static int
+create_nondirectory(struct wim_inode *inode, struct win32_apply_ctx *ctx)
+{
+ struct wim_dentry *first_dentry;
+ HANDLE h;
+ int ret;
+
+ first_dentry = first_extraction_alias(inode);
+
+ /* Create first link. */
+ ret = create_nondirectory_inode(&h, first_dentry, ctx);
+ if (ret)
+ return ret;
+
+ /* Set short name. */
+ ret = set_short_name(h, first_dentry, ctx);
+
+ /* Create additional links, OR if hard links are not supported just
+ * create more files. */
+ if (!ret)
+ ret = create_links(h, first_dentry, ctx);
+
+ /* "WIMBoot" extraction: set external backing by the WIM file if needed. */
+ if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
+ ret = set_external_backing(h, inode, ctx);
+
+ (*func_NtClose)(h);
+ return ret;
+}
+
+/* Create all the nondirectory files being extracted, including all aliases
+ * (hard links). */
+static int
+create_nondirectories(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
+{
+ struct wim_dentry *dentry;
+ struct wim_inode *inode;
+ int ret;
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
+ inode = dentry->d_inode;
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
+ continue;
+ /* Call create_nondirectory() only once per inode */
+ if (dentry == inode_first_extraction_dentry(inode)) {
+ ret = create_nondirectory(inode, ctx);
+ ret = check_apply_error(dentry, ctx, ret);
+ if (ret)
+ return ret;
+ }
+ ret = report_file_created(&ctx->common);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
+static void
+close_handles(struct win32_apply_ctx *ctx)
+{
+ for (unsigned i = 0; i < ctx->num_open_handles; i++)
+ (*func_NtClose)(ctx->open_handles[i]);
+}
+
+/* Prepare to read the next stream, which has size @stream_size, into an
+ * in-memory buffer. */
+static bool
+prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
+{
+ if (stream_size > ctx->data_buffer_size) {
+ /* Larger buffer needed. */
+ void *new_buffer;
+ if ((size_t)stream_size != stream_size)
+ return false;
+ new_buffer = REALLOC(ctx->data_buffer, stream_size);
+ if (!new_buffer)
+ return false;
+ ctx->data_buffer = new_buffer;
+ ctx->data_buffer_size = stream_size;
+ }
+ /* On the first call this changes data_buffer_ptr from NULL, which tells
+ * extract_chunk() that the data buffer needs to be filled while reading
+ * the stream data. */
+ ctx->data_buffer_ptr = ctx->data_buffer;
+ return true;
+}
+
+static int
+begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
+ struct wim_dentry *dentry,
+ const wchar_t *stream_name,
+ struct win32_apply_ctx *ctx)
+{
+ const struct wim_inode *inode = dentry->d_inode;
+ size_t stream_name_nchars = 0;
+ FILE_ALLOCATION_INFORMATION alloc_info;
+ HANDLE h;
+ NTSTATUS status;
+
+ if (unlikely(stream_name))
+ stream_name_nchars = wcslen(stream_name);
+
+ if (unlikely(stream_name_nchars)) {
+ build_extraction_path_with_ads(dentry, ctx,
+ stream_name, stream_name_nchars);
+ } else {
+ build_extraction_path(dentry, ctx);
+ }
+
+ /* Reparse point? */
+ if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
+ && (stream_name_nchars == 0))
+ {
+ if (!ctx->common.supported_features.reparse_points)
+ return 0;
+
+ /* We can't write the reparse stream directly; we must set it
+ * with FSCTL_SET_REPARSE_POINT, which requires that all the
+ * data be available. So, stage the data in a buffer. */
+
+ if (!prepare_data_buffer(ctx, stream->size))
+ return WIMLIB_ERR_NOMEM;
+ list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
+ return 0;
+ }
+
+ /* Encrypted file? */
+ if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
+ && (stream_name_nchars == 0))
+ {
+ if (!ctx->common.supported_features.encrypted_files)
+ return 0;
+
+ /* We can't write encrypted file streams directly; we must use
+ * WriteEncryptedFileRaw(), which requires providing the data
+ * through a callback function. This can't easily be combined
+ * with our own callback-based approach.
+ *
+ * The current workaround is to simply read the stream into
+ * memory and write the encrypted file from that.
+ *
+ * TODO: This isn't sufficient for extremely large encrypted
+ * files. Perhaps we should create an extra thread to write
+ * such files... */
+ if (!prepare_data_buffer(ctx, stream->size))
+ return WIMLIB_ERR_NOMEM;
+ list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
+ return 0;
+ }
+
+ if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
+ /* XXX: Fix this. But because of the checks in
+ * extract_stream_list(), this can now only happen on a
+ * filesystem that does not support hard links. */
+ ERROR("Can't extract data: too many open files!");
+ return WIMLIB_ERR_UNSUPPORTED;
+ }
+
+ /* Open a new handle */
+ status = do_create_file(&h,
+ FILE_WRITE_DATA | SYNCHRONIZE,
+ NULL, 0, FILE_OPEN_IF,
+ FILE_SEQUENTIAL_ONLY |
+ FILE_SYNCHRONOUS_IO_NONALERT,
+ ctx);
+ if (!NT_SUCCESS(status)) {
+ set_errno_from_nt_status(status);
+ ERROR_WITH_ERRNO("Can't open \"%ls\" for writing "
+ "(status=0x%08"PRIx32")",
+ current_path(ctx), (u32)status);
+ return WIMLIB_ERR_OPEN;
+ }
+
+ ctx->open_handles[ctx->num_open_handles++] = h;
+
+ /* Allocate space for the data. */
+ alloc_info.AllocationSize.QuadPart = stream->size;
+ (*func_NtSetInformationFile)(h, &ctx->iosb,
+ &alloc_info, sizeof(alloc_info),
+ FileAllocationInformation);
+ return 0;
+}
+
+/* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
+ * corresponding to the WIM dentry @dentry. */
+static int
+do_set_reparse_data(const struct wim_dentry *dentry,
+ const void *rpbuf, u16 rpbuflen,
+ struct win32_apply_ctx *ctx)
+{
+ NTSTATUS status;
+ HANDLE h;
+
+ status = create_file(&h, GENERIC_WRITE, NULL,
+ 0, FILE_OPEN, 0, dentry, ctx);
+ if (!NT_SUCCESS(status))
+ goto fail;
+
+ status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
+ &ctx->iosb, FSCTL_SET_REPARSE_POINT,
+ (void *)rpbuf, rpbuflen,
+ NULL, 0);
+ (*func_NtClose)(h);
+
+ if (NT_SUCCESS(status))
+ return 0;
+
+ /* On Windows, by default only the Administrator can create symbolic
+ * links for some reason. By default we just issue a warning if this
+ * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
+ * to get a hard error. */
+ if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
+ && (status == STATUS_PRIVILEGE_NOT_HELD ||
+ status == STATUS_ACCESS_DENIED)
+ && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
+ dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
+ {
+ WARNING("Can't create symbolic link \"%ls\"! \n"
+ " (Need Administrator rights, or at least "
+ "the\n"
+ " SeCreateSymbolicLink privilege.)",
+ current_path(ctx));
+ return 0;
+ }
+
+fail:
+ set_errno_from_nt_status(status);
+ ERROR_WITH_ERRNO("Can't set reparse data on \"%ls\" "
+ "(status=0x%08"PRIx32")",
+ current_path(ctx), (u32)status);
+ return WIMLIB_ERR_SET_REPARSE_DATA;
+}
+
+/* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
+ * pointer to the suffix of the path that begins with the device directly, such
+ * as e:\Windows\System32. */
+static const wchar_t *
+skip_nt_toplevel_component(const wchar_t *path, size_t path_nchars)
+{
+ static const wchar_t * const dirs[] = {
+ L"\\??\\",
+ L"\\DosDevices\\",
+ L"\\Device\\",
+ };
+ size_t first_dir_len = 0;
+ const wchar_t * const end = path + path_nchars;
+
+ for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
+ size_t len = wcslen(dirs[i]);
+ if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
+ first_dir_len = len;
+ break;
+ }
+ }
+ if (first_dir_len == 0)
+ return path;
+ path += first_dir_len;
+ while (path != end && *path == L'\\')
+ path++;
+ return path;
+}
+
+/* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
+ * pointer to the suffix of the path that is device-relative, such as
+ * Windows\System32.