+ return 0;
+}
+
+static int
+win32_set_compressed(HANDLE hFile, const wchar_t *path)
+{
+ USHORT format = COMPRESSION_FORMAT_DEFAULT;
+ DWORD bytesReturned = 0;
+ if (!DeviceIoControl(hFile, FSCTL_SET_COMPRESSION,
+ &format, sizeof(USHORT),
+ NULL, 0,
+ &bytesReturned, NULL))
+ {
+ /* Could be a warning only, but we only call this if the volume
+ * supports compression. So I'm calling this an error. */
+ DWORD err = GetLastError();
+ ERROR("Failed to set compression flag on \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ return 0;
+}
+
+static int
+win32_set_sparse(HANDLE hFile, const wchar_t *path)
+{
+ DWORD bytesReturned = 0;
+ if (!DeviceIoControl(hFile, FSCTL_SET_SPARSE,
+ NULL, 0,
+ NULL, 0,
+ &bytesReturned, NULL))
+ {
+ /* Could be a warning only, but we only call this if the volume
+ * supports sparse files. So I'm calling this an error. */
+ DWORD err = GetLastError();
+ WARNING("Failed to set sparse flag on \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ return 0;
+}
+
+/*
+ * Sets the security descriptor on an extracted file.
+ */
+static int
+win32_set_security_data(const struct wim_inode *inode,
+ const wchar_t *path,
+ struct apply_args *args)
+{
+ PSECURITY_DESCRIPTOR descriptor;
+ unsigned long n;
+ DWORD err;
+
+ descriptor = wim_const_security_data(args->w)->descriptors[inode->i_security_id];
+
+ SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION |
+ SACL_SECURITY_INFORMATION |
+ OWNER_SECURITY_INFORMATION |
+ GROUP_SECURITY_INFORMATION;
+again:
+ if (SetFileSecurityW(path, securityInformation, descriptor))
+ return 0;
+ err = GetLastError();
+ if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)
+ goto fail;
+ switch (err) {
+ case ERROR_PRIVILEGE_NOT_HELD:
+ if (securityInformation & SACL_SECURITY_INFORMATION) {
+ n = args->num_set_sacl_priv_notheld++;
+ securityInformation &= ~SACL_SECURITY_INFORMATION;
+ if (n < MAX_SET_SACL_PRIV_NOTHELD_WARNINGS) {
+ WARNING(
+"We don't have enough privileges to set the full security\n"
+" descriptor on \"%ls\"!\n", path);
+ if (args->num_set_sd_access_denied +
+ args->num_set_sacl_priv_notheld == 1)
+ {
+ WARNING("%ls", apply_access_denied_msg);
+ }
+ WARNING("Re-trying with SACL omitted.\n", path);
+ } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
+ WARNING(
+"Suppressing further 'privileges not held' error messages when setting\n"
+" security descriptors.");
+ }
+ goto again;
+ }
+ /* Fall through */
+ case ERROR_INVALID_OWNER:
+ case ERROR_ACCESS_DENIED:
+ n = args->num_set_sd_access_denied++;
+ if (n < MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
+ WARNING("Failed to set security descriptor on \"%ls\": "
+ "Access denied!\n", path);
+ if (args->num_set_sd_access_denied +
+ args->num_set_sacl_priv_notheld == 1)
+ {
+ WARNING("%ls", apply_access_denied_msg);
+ }
+ } else if (n == MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
+ WARNING(
+"Suppressing further access denied error messages when setting\n"
+" security descriptors");
+ }
+ return 0;
+ default:
+fail:
+ ERROR("Failed to set security descriptor on \"%ls\"", path);
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+}
+
+
+static int
+win32_extract_chunk(const void *buf, size_t len, void *arg)
+{
+ HANDLE hStream = arg;
+
+ DWORD nbytes_written;
+ wimlib_assert(len <= 0xffffffff);
+
+ if (!WriteFile(hStream, buf, len, &nbytes_written, NULL) ||
+ nbytes_written != len)
+ {
+ DWORD err = GetLastError();
+ ERROR("WriteFile(): write error");
+ win32_error(err);
+ return WIMLIB_ERR_WRITE;
+ }
+ return 0;
+}
+
+static int
+do_win32_extract_stream(HANDLE hStream, struct wim_lookup_table_entry *lte)
+{
+ return extract_wim_resource(lte, wim_resource_size(lte),
+ win32_extract_chunk, hStream);
+}
+
+static int
+do_win32_extract_encrypted_stream(const wchar_t *path,
+ const struct wim_lookup_table_entry *lte)
+{
+ ERROR("Extracting encryted streams not implemented");
+ return WIMLIB_ERR_INVALID_PARAM;
+}
+
+static bool
+path_is_root_of_drive(const wchar_t *path)
+{
+ if (!*path)
+ return false;
+
+ if (*path != L'/' && *path != L'\\') {
+ if (*(path + 1) == L':')
+ path += 2;
+ else
+ return false;
+ }
+ while (*path == L'/' || *path == L'\\')
+ path++;
+ return (*path == L'\0');
+}
+
+static DWORD
+win32_get_create_flags_and_attributes(DWORD i_attributes)
+{
+ DWORD attributes;
+
+ /*
+ * Some attributes cannot be set by passing them to CreateFile(). In
+ * particular:
+ *
+ * FILE_ATTRIBUTE_DIRECTORY:
+ * CreateDirectory() must be called instead of CreateFile().
+ *
+ * FILE_ATTRIBUTE_SPARSE_FILE:
+ * Needs an ioctl.
+ * See: win32_set_sparse().
+ *
+ * FILE_ATTRIBUTE_COMPRESSED:
+ * Not clear from the documentation, but apparently this needs an
+ * ioctl as well.
+ * See: win32_set_compressed().
+ *
+ * FILE_ATTRIBUTE_REPARSE_POINT:
+ * Needs an ioctl, with the reparse data specified.
+ * See: win32_set_reparse_data().
+ *
+ * In addition, clear any file flags in the attributes that we don't
+ * want, but also specify FILE_FLAG_OPEN_REPARSE_POINT and
+ * FILE_FLAG_BACKUP_SEMANTICS as we are a backup application.
+ */
+ attributes = i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
+ FILE_ATTRIBUTE_COMPRESSED |
+ FILE_ATTRIBUTE_REPARSE_POINT |
+ FILE_ATTRIBUTE_DIRECTORY |
+ FILE_FLAG_DELETE_ON_CLOSE |
+ FILE_FLAG_NO_BUFFERING |
+ FILE_FLAG_OPEN_NO_RECALL |
+ FILE_FLAG_OVERLAPPED |
+ FILE_FLAG_RANDOM_ACCESS |
+ /*FILE_FLAG_SESSION_AWARE |*/
+ FILE_FLAG_SEQUENTIAL_SCAN |
+ FILE_FLAG_WRITE_THROUGH);
+ return attributes |
+ FILE_FLAG_OPEN_REPARSE_POINT |
+ FILE_FLAG_BACKUP_SEMANTICS;
+}
+
+static bool
+inode_has_special_attributes(const struct wim_inode *inode)
+{
+ return (inode->i_attributes & (FILE_ATTRIBUTE_COMPRESSED |
+ FILE_ATTRIBUTE_REPARSE_POINT |
+ FILE_ATTRIBUTE_SPARSE_FILE)) != 0;
+}
+
+/* Set compression or sparse attributes, and reparse data, if supported by the
+ * volume. */
+static int
+win32_set_special_attributes(HANDLE hFile, const struct wim_inode *inode,
+ struct wim_lookup_table_entry *unnamed_stream_lte,
+ const wchar_t *path, unsigned vol_flags)
+{
+ int ret;
+
+ if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED) {
+ if (vol_flags & FILE_FILE_COMPRESSION) {
+ DEBUG("Setting compression flag on \"%ls\"", path);
+ ret = win32_set_compressed(hFile, path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set compression attribute on \"%ls\": "
+ "volume does not support transparent compression",
+ path);
+ }
+ }
+
+ if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE) {
+ if (vol_flags & FILE_SUPPORTS_SPARSE_FILES) {
+ DEBUG("Setting sparse flag on \"%ls\"", path);
+ ret = win32_set_sparse(hFile, path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set sparse attribute on \"%ls\": "
+ "volume does not support sparse files",
+ path);
+ }
+ }
+
+ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
+ DEBUG("Setting reparse data on \"%ls\"", path);
+ ret = win32_set_reparse_data(hFile, inode->i_reparse_tag,
+ unnamed_stream_lte, path);
+ if (ret)
+ return ret;
+ } else {
+ DEBUG("Cannot set reparse data on \"%ls\": volume "
+ "does not support reparse points", path);
+ }
+ }
+
+ return 0;
+}
+
+static int
+win32_extract_stream(const struct wim_inode *inode,
+ const wchar_t *path,
+ const wchar_t *stream_name_utf16,
+ struct wim_lookup_table_entry *lte,
+ unsigned vol_flags)
+{
+ wchar_t *stream_path;
+ HANDLE h;
+ int ret;
+ DWORD err;
+ DWORD creationDisposition = CREATE_ALWAYS;
+
+ if (stream_name_utf16) {
+ /* Named stream. Create a buffer that contains the UTF-16LE
+ * string [.\]@path:@stream_name_utf16. This is needed to
+ * create and open the stream using CreateFileW(). I'm not
+ * aware of any other APIs to do this. Note: the '$DATA' suffix
+ * seems to be unneeded. Additional note: a "./" prefix needs
+ * to be added when the path is not absolute to avoid ambiguity
+ * with drive letters. */
+ size_t stream_path_nchars;
+ size_t path_nchars;
+ size_t stream_name_nchars;
+ const wchar_t *prefix;
+
+ path_nchars = wcslen(path);
+ stream_name_nchars = wcslen(stream_name_utf16);
+ stream_path_nchars = path_nchars + 1 + stream_name_nchars;
+ if (path[0] != cpu_to_le16(L'\0') &&
+ path[0] != cpu_to_le16(L'/') &&
+ path[0] != cpu_to_le16(L'\\') &&
+ path[1] != cpu_to_le16(L':'))
+ {
+ prefix = L"./";
+ stream_path_nchars += 2;
+ } else {
+ prefix = L"";
+ }
+ stream_path = alloca((stream_path_nchars + 1) * sizeof(wchar_t));
+ swprintf(stream_path, L"%ls%ls:%ls",
+ prefix, path, stream_name_utf16);
+ } else {
+ /* Unnamed stream; its path is just the path to the file itself.
+ * */
+ stream_path = (wchar_t*)path;
+
+ /* Directories must be created with CreateDirectoryW(). Then
+ * the call to CreateFileW() will merely open the directory that
+ * was already created rather than creating a new file. */
+ if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
+ if (!CreateDirectoryW(stream_path, NULL)) {
+ err = GetLastError();
+ switch (err) {
+ case ERROR_ALREADY_EXISTS:
+ break;
+ case ERROR_ACCESS_DENIED:
+ if (path_is_root_of_drive(path))
+ break;
+ /* Fall through */
+ default:
+ ERROR("Failed to create directory \"%ls\"",
+ stream_path);
+ win32_error(err);
+ ret = WIMLIB_ERR_MKDIR;
+ goto fail;
+ }
+ }
+ DEBUG("Created directory \"%ls\"", stream_path);
+ if (!inode_has_special_attributes(inode)) {
+ ret = 0;
+ goto out;
+ }
+ DEBUG("Directory \"%ls\" has special attributes!",
+ stream_path);
+ creationDisposition = OPEN_EXISTING;
+ }
+ }
+
+ DEBUG("Opening \"%ls\"", stream_path);
+ h = CreateFileW(stream_path,
+ GENERIC_READ | GENERIC_WRITE,
+ 0,
+ NULL,
+ creationDisposition,
+ win32_get_create_flags_and_attributes(inode->i_attributes),
+ NULL);
+ if (h == INVALID_HANDLE_VALUE) {
+ err = GetLastError();
+ ERROR("Failed to create \"%ls\"", stream_path);
+ win32_error(err);
+ ret = WIMLIB_ERR_OPEN;
+ goto fail;
+ }
+
+ if (stream_name_utf16 == NULL && inode_has_special_attributes(inode)) {
+ ret = win32_set_special_attributes(h, inode, lte, path,
+ vol_flags);
+ if (ret)
+ goto fail_close_handle;
+ }
+
+ if (!(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
+ if (lte) {
+ DEBUG("Extracting \"%ls\" (len = %"PRIu64")",
+ stream_path, wim_resource_size(lte));
+ if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED
+ && stream_name_utf16 == NULL
+ && (vol_flags & FILE_SUPPORTS_ENCRYPTION))
+ {
+ ret = do_win32_extract_encrypted_stream(stream_path,
+ lte);
+ } else {
+ ret = do_win32_extract_stream(h, lte);
+ }
+ if (ret)
+ goto fail_close_handle;
+ }
+ }
+
+ DEBUG("Closing \"%ls\"", stream_path);
+ if (!CloseHandle(h)) {
+ err = GetLastError();
+ ERROR("Failed to close \"%ls\"", stream_path);
+ win32_error(err);
+ ret = WIMLIB_ERR_WRITE;
+ goto fail;
+ }
+ ret = 0;
+ goto out;
+fail_close_handle:
+ CloseHandle(h);
+fail:
+ ERROR("Error extracting %ls", stream_path);
+out:
+ return ret;
+}
+
+/*
+ * Creates a file, directory, or reparse point and extracts all streams to it
+ * (unnamed data stream and/or reparse point stream, plus any alternate data
+ * streams). This in Win32-specific code.
+ *
+ * @inode: WIM inode for this file or directory.
+ * @path: UTF-16LE external path to extract the inode to.
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
+static int
+win32_extract_streams(const struct wim_inode *inode,
+ const wchar_t *path, u64 *completed_bytes_p,
+ unsigned vol_flags)
+{
+ struct wim_lookup_table_entry *unnamed_lte;
+ int ret;
+
+ unnamed_lte = inode_unnamed_lte_resolved(inode);
+ ret = win32_extract_stream(inode, path, NULL, unnamed_lte,
+ vol_flags);
+ if (ret)
+ goto out;
+ if (unnamed_lte && inode->i_extracted_file == NULL)
+ *completed_bytes_p += wim_resource_size(unnamed_lte);
+
+ if (!(vol_flags & FILE_NAMED_STREAMS))
+ goto out;
+ for (u16 i = 0; i < inode->i_num_ads; i++) {
+ const struct wim_ads_entry *ads_entry = &inode->i_ads_entries[i];
+ if (ads_entry->stream_name_nbytes != 0) {
+ /* Skip special UNIX data entries (see documentation for
+ * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
+ if (ads_entry->stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
+ && !memcmp(ads_entry->stream_name,
+ WIMLIB_UNIX_DATA_TAG_UTF16LE,
+ WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
+ continue;
+ ret = win32_extract_stream(inode,
+ path,
+ ads_entry->stream_name,
+ ads_entry->lte,
+ vol_flags);
+ if (ret)
+ break;
+ if (ads_entry->lte && inode->i_extracted_file == NULL)
+ *completed_bytes_p += wim_resource_size(ads_entry->lte);
+ }
+ }
+out: