X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwin32.c;h=2977ffc8b1b810ae5476808e4762aaa70f0fa1ee;hp=4a9e8becec2a762876765834e0d8dc9d4655002e;hb=fb964811a120ad28cac62a9a3343def5bf474f03;hpb=c45322ae535237af2de3b6e4e58f5113c08f3a68 diff --git a/src/win32.c b/src/win32.c index 4a9e8bec..2977ffc8 100644 --- a/src/win32.c +++ b/src/win32.c @@ -29,7 +29,8 @@ #include #include #include -#include /* shlwapi.h for PathMatchSpecW() */ +#include /* for PathMatchSpecW() */ +#include /* for SetSecurityInfo() */ #ifdef ERROR /* windows.h defines this */ # undef ERROR #endif @@ -46,6 +47,8 @@ #define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1 #define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1 +#define MAX_CREATE_HARD_LINK_WARNINGS 5 +#define MAX_CREATE_SOFT_LINK_WARNINGS 5 struct win32_capture_state { unsigned long num_get_sd_access_denied; unsigned long num_get_sacl_priv_notheld; @@ -76,6 +79,279 @@ win32_error(u32 err_code) # define win32_error(err_code) #endif /* !ENABLE_ERROR_MESSAGES */ +static int +win32_error_to_errno(DWORD err_code) +{ + /* This mapping is that used in Cygwin. + * Some of these choices are arbitrary. */ + switch (err_code) { + case ERROR_ACCESS_DENIED: + return EACCES; + case ERROR_ACTIVE_CONNECTIONS: + return EAGAIN; + case ERROR_ALREADY_EXISTS: + return EEXIST; + case ERROR_BAD_DEVICE: + return ENODEV; + case ERROR_BAD_EXE_FORMAT: + return ENOEXEC; + case ERROR_BAD_NETPATH: + return ENOENT; + case ERROR_BAD_NET_NAME: + return ENOENT; + case ERROR_BAD_NET_RESP: + return ENOSYS; + case ERROR_BAD_PATHNAME: + return ENOENT; + case ERROR_BAD_PIPE: + return EINVAL; + case ERROR_BAD_UNIT: + return ENODEV; + case ERROR_BAD_USERNAME: + return EINVAL; + case ERROR_BEGINNING_OF_MEDIA: + return EIO; + case ERROR_BROKEN_PIPE: + return EPIPE; + case ERROR_BUSY: + return EBUSY; + case ERROR_BUS_RESET: + return EIO; + case ERROR_CALL_NOT_IMPLEMENTED: + return ENOSYS; + case ERROR_CANNOT_MAKE: + return EPERM; + case ERROR_CHILD_NOT_COMPLETE: + return EBUSY; + case ERROR_COMMITMENT_LIMIT: + return EAGAIN; + case ERROR_CRC: + return EIO; + case ERROR_DEVICE_DOOR_OPEN: + return EIO; + case ERROR_DEVICE_IN_USE: + return EAGAIN; + case ERROR_DEVICE_REQUIRES_CLEANING: + return EIO; + case ERROR_DIRECTORY: + return ENOTDIR; + case ERROR_DIR_NOT_EMPTY: + return ENOTEMPTY; + case ERROR_DISK_CORRUPT: + return EIO; + case ERROR_DISK_FULL: + return ENOSPC; +#ifdef ENOTUNIQ + case ERROR_DUP_NAME: + return ENOTUNIQ; +#endif + case ERROR_EAS_DIDNT_FIT: + return ENOSPC; + case ERROR_EAS_NOT_SUPPORTED: + return ENOTSUP; + case ERROR_EA_LIST_INCONSISTENT: + return EINVAL; + case ERROR_EA_TABLE_FULL: + return ENOSPC; + case ERROR_END_OF_MEDIA: + return ENOSPC; + case ERROR_EOM_OVERFLOW: + return EIO; + case ERROR_EXE_MACHINE_TYPE_MISMATCH: + return ENOEXEC; + case ERROR_EXE_MARKED_INVALID: + return ENOEXEC; + case ERROR_FILEMARK_DETECTED: + return EIO; + case ERROR_FILENAME_EXCED_RANGE: + return ENAMETOOLONG; + case ERROR_FILE_CORRUPT: + return EEXIST; + case ERROR_FILE_EXISTS: + return EEXIST; + case ERROR_FILE_INVALID: + return ENXIO; + case ERROR_FILE_NOT_FOUND: + return ENOENT; + case ERROR_HANDLE_DISK_FULL: + return ENOSPC; +#ifdef ENODATA + case ERROR_HANDLE_EOF: + return ENODATA; +#endif + case ERROR_INVALID_ADDRESS: + return EINVAL; + case ERROR_INVALID_AT_INTERRUPT_TIME: + return EINTR; + case ERROR_INVALID_BLOCK_LENGTH: + return EIO; + case ERROR_INVALID_DATA: + return EINVAL; + case ERROR_INVALID_DRIVE: + return ENODEV; + case ERROR_INVALID_EA_NAME: + return EINVAL; + case ERROR_INVALID_EXE_SIGNATURE: + return ENOEXEC; +#ifdef EBADRQC + case ERROR_INVALID_FUNCTION: + return EBADRQC; +#endif + case ERROR_INVALID_HANDLE: + return EBADF; + case ERROR_INVALID_NAME: + return ENOENT; + case ERROR_INVALID_PARAMETER: + return EINVAL; + case ERROR_INVALID_SIGNAL_NUMBER: + return EINVAL; + case ERROR_IOPL_NOT_ENABLED: + return ENOEXEC; + case ERROR_IO_DEVICE: + return EIO; + case ERROR_IO_INCOMPLETE: + return EAGAIN; + case ERROR_IO_PENDING: + return EAGAIN; + case ERROR_LOCK_VIOLATION: + return EBUSY; + case ERROR_MAX_THRDS_REACHED: + return EAGAIN; + case ERROR_META_EXPANSION_TOO_LONG: + return EINVAL; + case ERROR_MOD_NOT_FOUND: + return ENOENT; +#ifdef EMSGSIZE + case ERROR_MORE_DATA: + return EMSGSIZE; +#endif + case ERROR_NEGATIVE_SEEK: + return EINVAL; + case ERROR_NETNAME_DELETED: + return ENOENT; + case ERROR_NOACCESS: + return EFAULT; + case ERROR_NONE_MAPPED: + return EINVAL; + case ERROR_NONPAGED_SYSTEM_RESOURCES: + return EAGAIN; +#ifdef ENOLINK + case ERROR_NOT_CONNECTED: + return ENOLINK; +#endif + case ERROR_NOT_ENOUGH_MEMORY: + return ENOMEM; + case ERROR_NOT_OWNER: + return EPERM; +#ifdef ENOMEDIUM + case ERROR_NOT_READY: + return ENOMEDIUM; +#endif + case ERROR_NOT_SAME_DEVICE: + return EXDEV; + case ERROR_NOT_SUPPORTED: + return ENOSYS; + case ERROR_NO_DATA: + return EPIPE; + case ERROR_NO_DATA_DETECTED: + return EIO; +#ifdef ENOMEDIUM + case ERROR_NO_MEDIA_IN_DRIVE: + return ENOMEDIUM; +#endif +#ifdef ENMFILE + case ERROR_NO_MORE_FILES: + return ENMFILE; +#endif +#ifdef ENMFILE + case ERROR_NO_MORE_ITEMS: + return ENMFILE; +#endif + case ERROR_NO_MORE_SEARCH_HANDLES: + return ENFILE; + case ERROR_NO_PROC_SLOTS: + return EAGAIN; + case ERROR_NO_SIGNAL_SENT: + return EIO; + case ERROR_NO_SYSTEM_RESOURCES: + return EFBIG; + case ERROR_NO_TOKEN: + return EINVAL; + case ERROR_OPEN_FAILED: + return EIO; + case ERROR_OPEN_FILES: + return EAGAIN; + case ERROR_OUTOFMEMORY: + return ENOMEM; + case ERROR_PAGED_SYSTEM_RESOURCES: + return EAGAIN; + case ERROR_PAGEFILE_QUOTA: + return EAGAIN; + case ERROR_PATH_NOT_FOUND: + return ENOENT; + case ERROR_PIPE_BUSY: + return EBUSY; + case ERROR_PIPE_CONNECTED: + return EBUSY; +#ifdef ECOMM + case ERROR_PIPE_LISTENING: + return ECOMM; + case ERROR_PIPE_NOT_CONNECTED: + return ECOMM; +#endif + case ERROR_POSSIBLE_DEADLOCK: + return EDEADLOCK; + case ERROR_PRIVILEGE_NOT_HELD: + return EPERM; + case ERROR_PROCESS_ABORTED: + return EFAULT; + case ERROR_PROC_NOT_FOUND: + return ESRCH; +#ifdef ENONET + case ERROR_REM_NOT_LIST: + return ENONET; +#endif + case ERROR_SECTOR_NOT_FOUND: + return EINVAL; + case ERROR_SEEK: + return EINVAL; + case ERROR_SETMARK_DETECTED: + return EIO; + case ERROR_SHARING_BUFFER_EXCEEDED: + return ENOLCK; + case ERROR_SHARING_VIOLATION: + return EBUSY; + case ERROR_SIGNAL_PENDING: + return EBUSY; + case ERROR_SIGNAL_REFUSED: + return EIO; +#ifdef ELIBBAD + case ERROR_SXS_CANT_GEN_ACTCTX: + return ELIBBAD; +#endif + case ERROR_THREAD_1_INACTIVE: + return EINVAL; + case ERROR_TOO_MANY_LINKS: + return EMLINK; + case ERROR_TOO_MANY_OPEN_FILES: + return EMFILE; + case ERROR_WAIT_NO_CHILDREN: + return ECHILD; + case ERROR_WORKING_SET_QUOTA: + return EAGAIN; + case ERROR_WRITE_PROTECT: + return EROFS; + default: + return -1; + } +} + +static void +set_errno_from_GetLastError() +{ + errno = win32_error_to_errno(GetLastError()); +} + /* Pointers to functions that are not available on all targetted versions of * Windows (XP and later). NOTE: The WINAPI annotations seem to be important; I * assume it specifies a certain calling convention. */ @@ -305,6 +581,7 @@ read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte, } else { export_ctx.buf = NULL; } + export_ctx.buf_filled = 0; export_ctx.bytes_remaining = size; err = OpenEncryptedFileRawW(lte->file_on_disk, 0, &file_ctx); @@ -393,22 +670,31 @@ static int win32_get_short_name(struct wim_dentry *dentry, const wchar_t *path) { WIN32_FIND_DATAW dat; - if (FindFirstFileW(path, &dat) && dat.cAlternateFileName[0] != L'\0') { - DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName); - size_t short_name_nbytes = wcslen(dat.cAlternateFileName) * - sizeof(wchar_t); - size_t n = short_name_nbytes + sizeof(wchar_t); - dentry->short_name = MALLOC(n); - if (!dentry->short_name) - return WIMLIB_ERR_NOMEM; - memcpy(dentry->short_name, dat.cAlternateFileName, n); - dentry->short_name_nbytes = short_name_nbytes; - } + HANDLE hFind; + int ret = 0; + /* If we can't read the short filename for some reason, we just ignore * the error and assume the file has no short name. I don't think this * should be an issue, since the short names are essentially obsolete * anyway. */ - return 0; + hFind = FindFirstFileW(path, &dat); + if (hFind != INVALID_HANDLE_VALUE) { + if (dat.cAlternateFileName[0] != L'\0') { + DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName); + size_t short_name_nbytes = wcslen(dat.cAlternateFileName) * + sizeof(wchar_t); + size_t n = short_name_nbytes + sizeof(wchar_t); + dentry->short_name = MALLOC(n); + if (dentry->short_name) { + memcpy(dentry->short_name, dat.cAlternateFileName, n); + dentry->short_name_nbytes = short_name_nbytes; + } else { + ret = WIMLIB_ERR_NOMEM; + } + } + FindClose(hFind); + } + return ret; } static int @@ -587,9 +873,11 @@ win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret) hFile = win32_open_existing_file(path, FILE_READ_ATTRIBUTES); if (hFile == INVALID_HANDLE_VALUE) { err = GetLastError(); - WARNING("Failed to open \"%ls\" to get file and volume IDs", - path); - win32_error(err); + if (err != ERROR_FILE_NOT_FOUND) { + WARNING("Failed to open \"%ls\" to get file " + "and volume IDs", path); + win32_error(err); + } return WIMLIB_ERR_OPEN; } @@ -608,202 +896,245 @@ win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret) return ret; } +/* Reparse point fixup status code */ enum rp_status { + /* Reparse point corresponded to an absolute symbolic link or junction + * point that pointed outside the directory tree being captured, and + * therefore was excluded. */ RP_EXCLUDED = 0x0, + + /* Reparse point was not fixed as it was either a relative symbolic + * link, a mount point, or something else we could not understand. */ RP_NOT_FIXED = 0x1, + + /* Reparse point corresponded to an absolute symbolic link or junction + * point that pointed inside the directory tree being captured, where + * the target was specified by a "full" \??\ prefixed path, and + * therefore was fixed to be relative to the root of the directory tree + * being captured. */ RP_FIXED_FULLPATH = 0x2, + + /* Same as RP_FIXED_FULLPATH, except the absolute link target did not + * have the \??\ prefix. It may have begun with a drive letter though. + * */ RP_FIXED_ABSPATH = 0x4, + + /* Either RP_FIXED_FULLPATH or RP_FIXED_ABSPATH. */ RP_FIXED = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH, }; +/* Given the "substitute name" target of a Windows reparse point, try doing a + * fixup where we change it to be absolute relative to the root of the directory + * tree being captured. + * + * Note that this is only executed when WIMLIB_ADD_IMAGE_FLAG_RPFIX has been + * set. + * + * @capture_root_ino and @capture_root_dev indicate the inode number and device + * of the root of the directory tree being captured. They are meant to identify + * this directory (as an alternative to its actual path, which could potentially + * be reached via multiple destinations due to other symbolic links). This may + * not work properly on FAT, which doesn't seem to supply proper inode numbers + * or file IDs. However, FAT doesn't support reparse points so this function + * wouldn't even be called anyway. + */ static enum rp_status -win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p, - u64 capture_root_ino, u64 capture_root_dev) +win32_capture_maybe_rpfix_target(wchar_t *target, u16 *target_nbytes_p, + u64 capture_root_ino, u64 capture_root_dev, + u32 rptag) { - size_t target_nchars= *target_nchars_p; + u16 target_nchars = *target_nbytes_p / 2; size_t stripped_chars; wchar_t *orig_target; + int ret; - if (target_nchars == 0) - return RP_NOT_FIXED; - - if (target[0] == L'\\') { - if (target_nchars >= 2 && target[1] == L'\\') { - /* Probaby a volume. Can't do anything with it. */ - DEBUG("Not fixing target (probably a volume)"); - return RP_NOT_FIXED; - } else if (target_nchars >= 7 && - target[1] == '?' && - target[2] == '?' && - target[3] == '\\' && - target[4] != '\0' && - target[5] == ':' && - target[6] == '\\') - { - DEBUG("Full style path"); - /* Full \??\x:\ style path (may be junction or symlink) - * */ - stripped_chars = 4; - } else { - DEBUG("Absolute target without drive letter"); - /* Absolute target, without drive letter */ - stripped_chars = 0; - } - } else if (target_nchars >= 3 && - target[0] != L'\0' && - target[1] == L':' && - target[2] == L'\\') - { - DEBUG("Absolute target with drive letter"); - /* Absolute target, with drive letter */ - stripped_chars = 0; - } else { - DEBUG("Relative symlink or other link"); - /* Relative symlink or other unexpected format */ + ret = parse_substitute_name(target, *target_nbytes_p, rptag); + if (ret < 0) return RP_NOT_FIXED; - } + stripped_chars = ret; + if (stripped_chars) + stripped_chars -= 2; target[target_nchars] = L'\0'; orig_target = target; - target = fixup_symlink(target + stripped_chars, capture_root_ino, capture_root_dev); - if (target) { - target_nchars = wcslen(target); - wmemmove(orig_target + stripped_chars, target, target_nchars + 1); - *target_nchars_p = target_nchars + stripped_chars; - DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target); - return stripped_chars ? RP_FIXED_FULLPATH : RP_FIXED_ABSPATH; - } else { + target = capture_fixup_absolute_symlink(target + stripped_chars, + capture_root_ino, capture_root_dev); + if (!target) return RP_EXCLUDED; - } + target_nchars = wcslen(target); + wmemmove(orig_target + stripped_chars, target, target_nchars + 1); + *target_nbytes_p = (target_nchars + stripped_chars) * sizeof(wchar_t); + DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target); + if (stripped_chars) + return RP_FIXED_FULLPATH; + else + return RP_FIXED_ABSPATH; } -static enum rp_status -win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p, - u64 capture_root_ino, u64 capture_root_dev) +/* Returns: `enum rp_status' value on success; negative WIMLIB_ERR_* value on + * failure. */ +static int +win32_capture_try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, + u64 capture_root_ino, u64 capture_root_dev, + const wchar_t *path) { - const char *p_get; - char *p_put; - u16 substitute_name_offset; - u16 substitute_name_len; - wchar_t *target; - size_t target_nchars; - enum rp_status status; - u32 rptag; - DWORD rpbuflen = *rpbuflen_p; - - if (rpbuflen < 16) - return RP_EXCLUDED; - p_get = get_u32(rpbuf, &rptag); - p_get += 4; - p_get = get_u16(p_get, &substitute_name_offset); - p_get = get_u16(p_get, &substitute_name_len); - p_get += 4; - if ((size_t)substitute_name_offset + substitute_name_len > rpbuflen) - return RP_EXCLUDED; - if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) { - if (rpbuflen < 20) - return RP_EXCLUDED; - p_get += 4; - } - - - target = (wchar_t*)&p_get[substitute_name_offset]; - target_nchars = substitute_name_len / 2; - /* Note: target is not necessarily null-terminated */ - - status = win32_maybe_rpfix_target(target, &target_nchars, - capture_root_ino, capture_root_dev); - if (status & RP_FIXED) { - size_t target_nbytes = target_nchars * 2; - size_t print_nbytes = target_nbytes; - wchar_t target_copy[target_nchars]; - wchar_t *print_name = target_copy; + struct reparse_data rpdata; + DWORD rpbuflen; + int ret; + enum rp_status rp_status; - if (status == RP_FIXED_FULLPATH) { - print_nbytes -= 8; - print_name += 4; + rpbuflen = *rpbuflen_p; + ret = parse_reparse_data(rpbuf, rpbuflen, &rpdata); + if (ret) + return -ret; + + rp_status = win32_capture_maybe_rpfix_target(rpdata.substitute_name, + &rpdata.substitute_name_nbytes, + capture_root_ino, + capture_root_dev, + le32_to_cpu(*(u32*)rpbuf)); + if (rp_status & RP_FIXED) { + wimlib_assert(rpdata.substitute_name_nbytes % 2 == 0); + utf16lechar substitute_name_copy[rpdata.substitute_name_nbytes / 2]; + wmemcpy(substitute_name_copy, rpdata.substitute_name, + rpdata.substitute_name_nbytes / 2); + rpdata.substitute_name = substitute_name_copy; + rpdata.print_name = substitute_name_copy; + rpdata.print_name_nbytes = rpdata.substitute_name_nbytes; + if (rp_status == RP_FIXED_FULLPATH) { + /* "full path", meaning \??\ prefixed. We should not + * include this prefix in the print name, as it is + * apparently meant for the filesystem driver only. */ + rpdata.print_name += 4; + rpdata.print_name_nbytes -= 8; + } + ret = make_reparse_buffer(&rpdata, rpbuf); + if (ret == 0) + ret = rp_status; + else + ret = -ret; + } else { + if (rp_status == RP_EXCLUDED) { + size_t print_name_nchars = rpdata.print_name_nbytes / 2; + wchar_t print_name0[print_name_nchars + 1]; + print_name0[print_name_nchars] = L'\0'; + wmemcpy(print_name0, rpdata.print_name, print_name_nchars); + WARNING("Ignoring %ls pointing out of capture directory:\n" + " \"%ls\" -> \"%ls\"\n" + " (Use --norpfix to capture all symbolic links " + "and junction points as-is)", + (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK) ? + L"absolute symbolic link" : L"junction point", + path, print_name0); } - wmemcpy(target_copy, target, target_nchars); - p_put = rpbuf + 8; - p_put = put_u16(p_put, 0); /* Substitute name offset */ - p_put = put_u16(p_put, target_nbytes); /* Substitute name length */ - p_put = put_u16(p_put, target_nbytes + 2); /* Print name offset */ - p_put = put_u16(p_put, print_nbytes); /* Print name length */ - if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) - p_put = put_u32(p_put, 1); - p_put = put_bytes(p_put, target_nbytes, target_copy); - p_put = put_u16(p_put, 0); - p_put = put_bytes(p_put, print_nbytes, print_name); - p_put = put_u16(p_put, 0); - rpbuflen = p_put - rpbuf; - put_u16(rpbuf + 4, rpbuflen - 8); - *rpbuflen_p = rpbuflen; - } - return status; + ret = rp_status; + } + return ret; } -/* Load a reparse point into a WIM inode. It is just stored in memory. +/* + * Loads the reparse point data from a reparse point into memory, optionally + * fixing the targets of absolute symbolic links and junction points to be + * relative to the root of capture. * - * @hFile is the open handle to a reparse point, with permission to read the - * reparse data. + * @hFile: Open handle to the reparse point. + * @path: Path to the reparse point. Used for error messages only. + * @params: Additional parameters, including whether to do reparse point fixups + * or not. + * @rpbuf: Buffer of length at least REPARSE_POINT_MAX_SIZE bytes into which + * the reparse point buffer will be loaded. + * @rpbuflen_ret: On success, the length of the reparse point buffer in bytes + * is written to this location. * - * @inode is the WIM inode for the reparse point. + * Returns: + * On success, returns an `enum rp_status' value that indicates if and/or + * how the reparse point fixup was done. + * + * On failure, returns a negative value that is a negated WIMLIB_ERR_* + * code. */ static int -win32_capture_reparse_point(struct wim_dentry **root_p, - HANDLE hFile, - struct wim_inode *inode, - const wchar_t *path, - struct add_image_params *params) +win32_get_reparse_data(HANDLE hFile, const wchar_t *path, + struct add_image_params *params, + u8 *rpbuf, u16 *rpbuflen_ret) { - DEBUG("Capturing reparse point \"%ls\"", path); - - /* "Reparse point data, including the tag and optional GUID, - * cannot exceed 16 kilobytes." - MSDN */ - char reparse_point_buf[REPARSE_POINT_MAX_SIZE]; DWORD bytesReturned; - char *fixed_buf; - DWORD fixed_len; + u32 reparse_tag; + int ret; + u16 rpbuflen; + DEBUG("Loading reparse data from \"%ls\"", path); if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT, NULL, /* "Not used with this operation; set to NULL" */ 0, /* "Not used with this operation; set to 0" */ - reparse_point_buf, /* "A pointer to a buffer that + rpbuf, /* "A pointer to a buffer that receives the reparse point data */ - sizeof(reparse_point_buf), /* "The size of the output - buffer, in bytes */ + REPARSE_POINT_MAX_SIZE, /* "The size of the output + buffer, in bytes */ &bytesReturned, NULL)) { DWORD err = GetLastError(); ERROR("Failed to get reparse data of \"%ls\"", path); win32_error(err); - return WIMLIB_ERR_READ; + return -WIMLIB_ERR_READ; } - if (bytesReturned < 8) { + if (bytesReturned < 8 || bytesReturned > REPARSE_POINT_MAX_SIZE) { ERROR("Reparse data on \"%ls\" is invalid", path); - return WIMLIB_ERR_READ; + return -WIMLIB_ERR_INVALID_REPARSE_DATA; } - inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf); + rpbuflen = bytesReturned; + reparse_tag = le32_to_cpu(*(u32*)rpbuf); if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX && - (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK || - inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT)) + (reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK || + reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT)) { - enum rp_status status; - status = win32_do_capture_rpfix(reparse_point_buf, - &bytesReturned, - params->capture_root_ino, - params->capture_root_dev); - if (status == RP_EXCLUDED) { - free_dentry(*root_p); - *root_p = NULL; - return 0; - } else if (status & RP_FIXED) { - inode->i_not_rpfixed = 0; - } + /* Try doing reparse point fixup */ + ret = win32_capture_try_rpfix(rpbuf, + &rpbuflen, + params->capture_root_ino, + params->capture_root_dev, + path); + } else { + ret = RP_NOT_FIXED; + } + *rpbuflen_ret = rpbuflen; + return ret; +} + +static DWORD WINAPI +win32_tally_encrypted_size_cb(unsigned char *_data, void *_ctx, + unsigned long len) +{ + *(u64*)_ctx += len; + return ERROR_SUCCESS; +} + +static int +win32_get_encrypted_file_size(const wchar_t *path, u64 *size_ret) +{ + DWORD err; + void *file_ctx; + int ret; + + *size_ret = 0; + err = OpenEncryptedFileRawW(path, 0, &file_ctx); + if (err != ERROR_SUCCESS) { + ERROR("Failed to open encrypted file \"%ls\" for raw read", path); + win32_error(err); + return WIMLIB_ERR_OPEN; } - return inode_set_unnamed_stream(inode, reparse_point_buf + 8, - bytesReturned - 8, params->lookup_table); + err = ReadEncryptedFileRaw(win32_tally_encrypted_size_cb, + size_ret, file_ctx); + if (err != ERROR_SUCCESS) { + ERROR("Failed to read raw encrypted data from \"%ls\"", path); + win32_error(err); + ret = WIMLIB_ERR_READ; + } else { + ret = 0; + } + CloseEncryptedFileRaw(file_ctx); + return ret; } /* Scans an unnamed or named stream of a Win32 file (not a reparse point @@ -875,6 +1206,12 @@ win32_capture_stream(const wchar_t *path, } } + /* If zero length stream, no lookup table entry needed. */ + if ((u64)dat->StreamSize.QuadPart == 0) { + ret = 0; + goto out; + } + /* Create a UTF-16LE string @spath that gives the filename, then a * colon, then the stream name. Or, if it's an unnamed stream, just the * filename. It is MALLOC()'ed so that it can be saved in the @@ -913,11 +1250,17 @@ win32_capture_stream(const wchar_t *path, } lte->file_on_disk = spath; spath = NULL; - if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream) + if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream) { + u64 encrypted_size; lte->resource_location = RESOURCE_WIN32_ENCRYPTED; - else + ret = win32_get_encrypted_file_size(path, &encrypted_size); + if (ret) + goto out_free_spath; + lte->resource_entry.original_size = encrypted_size; + } else { lte->resource_location = RESOURCE_WIN32; - lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart; + lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart; + } u32 stream_id; if (is_named_stream) { @@ -993,10 +1336,10 @@ win32_capture_streams(const wchar_t *path, return 0; } else { if (err == ERROR_ACCESS_DENIED) { - ERROR("Failed to look up data streams " - "of \"%ls\": Access denied!\n%ls", - path, capture_access_denied_msg); - return WIMLIB_ERR_READ; + WARNING("Failed to look up data streams " + "of \"%ls\": Access denied!\n%ls", + path, capture_access_denied_msg); + return 0; } else { ERROR("Failed to look up data streams " "of \"%ls\"", path); @@ -1056,7 +1399,10 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, struct wim_inode *inode; DWORD err; u64 file_size; - int ret = 0; + int ret; + u8 *rpbuf; + u16 rpbuflen; + u16 not_rpfixed; if (exclude_path(path, path_num_chars, params->config, true)) { if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) { @@ -1072,6 +1418,7 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, info.scan.excluded = true; params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info); } + ret = 0; goto out; } @@ -1104,12 +1451,37 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, goto out_close_handle; } - /* Create a WIM dentry with an associated inode, which may be shared */ + if (file_info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) { + rpbuf = alloca(REPARSE_POINT_MAX_SIZE); + ret = win32_get_reparse_data(hFile, path, params, + rpbuf, &rpbuflen); + if (ret < 0) { + /* WIMLIB_ERR_* (inverted) */ + ret = -ret; + goto out_close_handle; + } else if (ret & RP_FIXED) { + not_rpfixed = 0; + } else if (ret == RP_EXCLUDED) { + ret = 0; + goto out_close_handle; + } else { + not_rpfixed = 1; + } + } + + /* Create a WIM dentry with an associated inode, which may be shared. + * + * However, we need to explicitly check for directories and files with + * only 1 link and refuse to hard link them. This is because Windows + * has a bug where it can return duplicate File IDs for files and + * directories on the FAT filesystem. */ ret = inode_table_new_dentry(params->inode_table, path_basename_with_len(path, path_num_chars), ((u64)file_info.nFileIndexHigh << 32) | - (u64)file_info.nFileIndexLow, + (u64)file_info.nFileIndexLow, file_info.dwVolumeSerialNumber, + (file_info.nNumberOfLinks <= 1 || + (file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)), &root); if (ret) goto out_close_handle; @@ -1144,40 +1516,36 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret, file_size = ((u64)file_info.nFileSizeHigh << 32) | (u64)file_info.nFileSizeLow; - if (inode_is_directory(inode)) { - /* Directory (not a reparse point) --- recurse to children */ + CloseHandle(hFile); - /* But first... directories may have alternate data streams that - * need to be captured. */ - ret = win32_capture_streams(path, - path_num_chars, - inode, - params->lookup_table, - file_size, - vol_flags); - if (ret) - goto out_close_handle; + /* Capture the unnamed data stream (only should be present for regular + * files) and any alternate data streams. */ + ret = win32_capture_streams(path, + path_num_chars, + inode, + params->lookup_table, + file_size, + vol_flags); + if (ret) + goto out; + + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + /* Reparse point: set the reparse data (which we read already) + * */ + inode->i_not_rpfixed = not_rpfixed; + inode->i_reparse_tag = le32_to_cpu(*(u32*)rpbuf); + ret = inode_set_unnamed_stream(inode, rpbuf + 8, rpbuflen - 8, + params->lookup_table); + } else if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) { + /* Directory (not a reparse point) --- recurse to children */ ret = win32_recurse_directory(root, path, path_num_chars, params, state, vol_flags); - } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { - /* Reparse point: save the reparse tag and data. Alternate data - * streams are not captured, if it's even possible for a reparse - * point to have alternate data streams... */ - ret = win32_capture_reparse_point(&root, hFile, inode, path, params); - } else { - /* Not a directory, not a reparse point; capture the default - * file contents and any alternate data streams. */ - ret = win32_capture_streams(path, - path_num_chars, - inode, - params->lookup_table, - file_size, - vol_flags); } + goto out; out_close_handle: CloseHandle(hFile); out: @@ -1237,6 +1605,14 @@ win32_build_dentry_tree(struct wim_dentry **root_ret, if (path_nchars > 32767) return WIMLIB_ERR_INVALID_PARAM; + if (GetFileAttributesW(root_disk_path) == INVALID_FILE_ATTRIBUTES && + GetLastError() == ERROR_FILE_NOT_FOUND) + { + ERROR("Capture directory \"%ls\" does not exist!", + root_disk_path); + return WIMLIB_ERR_OPENDIR; + } + ret = win32_get_file_and_vol_ids(root_disk_path, ¶ms->capture_root_ino, ¶ms->capture_root_dev); @@ -1266,36 +1642,121 @@ win32_build_dentry_tree(struct wim_dentry **root_ret, } static int -win32_set_reparse_data(HANDLE h, - u32 reparse_tag, - const struct wim_lookup_table_entry *lte, - const wchar_t *path) +win32_extract_try_rpfix(u8 *rpbuf, + const wchar_t *extract_root_realpath, + unsigned extract_root_realpath_nchars) { + struct reparse_data rpdata; + wchar_t *target; + size_t target_nchars; + size_t stripped_nchars; + wchar_t *stripped_target; + wchar_t stripped_target_nchars; int ret; - u8 *buf; - size_t len; - if (!lte) { - WARNING("\"%ls\" is marked as a reparse point but had no reparse data", - path); - return 0; + utf16lechar *new_target; + utf16lechar *new_print_name; + size_t new_target_nchars; + size_t new_print_name_nchars; + utf16lechar *p; + + ret = parse_reparse_data(rpbuf, 8 + le16_to_cpu(*(u16*)(rpbuf + 4)), + &rpdata); + if (ret) + return ret; + + if (extract_root_realpath[0] == L'\0' || + extract_root_realpath[1] != L':' || + extract_root_realpath[2] != L'\\') + { + ERROR("Can't understand full path format \"%ls\". " + "Try turning reparse point fixups off...", + extract_root_realpath); + return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED; } - len = wim_resource_size(lte); - if (len > 16 * 1024 - 8) { - WARNING("\"%ls\": reparse data too long!", path); + + ret = parse_substitute_name(rpdata.substitute_name, + rpdata.substitute_name_nbytes, + rpdata.rptag); + if (ret < 0) return 0; - } + stripped_nchars = ret; + target = rpdata.substitute_name; + target_nchars = rpdata.substitute_name_nbytes / sizeof(utf16lechar); + stripped_target = target + 6; + stripped_target_nchars = target_nchars - stripped_nchars; + + new_target = alloca((6 + extract_root_realpath_nchars + + stripped_target_nchars) * sizeof(utf16lechar)); + + p = new_target; + if (stripped_nchars == 6) { + /* Include \??\ prefix if it was present before */ + wmemcpy(p, L"\\??\\", 4); + p += 4; + } + + /* Print name excludes the \??\ if present. */ + new_print_name = p; + if (stripped_nchars != 0) { + /* Get drive letter from real path to extract root, if a drive + * letter was present before. */ + *p++ = extract_root_realpath[0]; + *p++ = extract_root_realpath[1]; + } + /* Copy the rest of the extract root */ + wmemcpy(p, extract_root_realpath + 2, extract_root_realpath_nchars - 2); + p += extract_root_realpath_nchars - 2; + + /* Append the stripped target */ + wmemcpy(p, stripped_target, stripped_target_nchars); + p += stripped_target_nchars; + new_target_nchars = p - new_target; + new_print_name_nchars = p - new_print_name; + + if (new_target_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE || + new_print_name_nchars * sizeof(utf16lechar) >= REPARSE_POINT_MAX_SIZE) + { + ERROR("Path names too long to do reparse point fixup!"); + return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED; + } + rpdata.substitute_name = new_target; + rpdata.substitute_name_nbytes = new_target_nchars * sizeof(utf16lechar); + rpdata.print_name = new_print_name; + rpdata.print_name_nbytes = new_print_name_nchars * sizeof(utf16lechar); + return make_reparse_buffer(&rpdata, rpbuf); +} + +/* Wrapper around the FSCTL_SET_REPARSE_POINT ioctl to set the reparse data on + * an extracted reparse point. */ +static int +win32_set_reparse_data(HANDLE h, + const struct wim_inode *inode, + const struct wim_lookup_table_entry *lte, + const wchar_t *path, + struct apply_args *args) +{ + int ret; + u8 rpbuf[REPARSE_POINT_MAX_SIZE]; + DWORD bytesReturned; - /* The WIM stream omits the ReparseTag and ReparseDataLength fields, so - * leave 8 bytes of space for them at the beginning of the buffer, then - * set them manually. */ - buf = alloca(len + 8); - ret = read_full_resource_into_buf(lte, buf + 8, false); + DEBUG("Setting reparse data on \"%ls\"", path); + + ret = wim_inode_get_reparse_data(inode, rpbuf); if (ret) return ret; - *(u32*)(buf + 0) = cpu_to_le32(reparse_tag); - *(u16*)(buf + 4) = cpu_to_le16(len); - *(u16*)(buf + 6) = 0; + + if (args->extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX && + (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK || + inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) && + !inode->i_not_rpfixed) + { + ret = win32_extract_try_rpfix(rpbuf, + args->target_realpath, + args->target_realpath_len); + if (ret) + return WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED; + } /* Set the reparse data on the open file using the * FSCTL_SET_REPARSE_POINT ioctl. @@ -1318,25 +1779,47 @@ win32_set_reparse_data(HANDLE h, * * "Not used with this operation; set to NULL." */ - DWORD bytesReturned; - if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT, buf, len + 8, + if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT, rpbuf, + 8 + le16_to_cpu(*(u16*)(rpbuf + 4)), NULL, 0, &bytesReturned /* lpBytesReturned */, NULL /* lpOverlapped */)) { DWORD err = GetLastError(); - ERROR("Failed to set reparse data on \"%ls\"", path); - win32_error(err); - return WIMLIB_ERR_WRITE; + if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD) + { + args->num_soft_links_failed++; + if (args->num_soft_links_failed <= MAX_CREATE_SOFT_LINK_WARNINGS) { + WARNING("Can't set reparse data on \"%ls\": Access denied!\n" + " You may be trying to extract a symbolic " + "link without the\n" + " SeCreateSymbolicLink privilege, which by " + "default non-Administrator\n" + " accounts do not have.", path); + } + if (args->num_hard_links_failed == MAX_CREATE_HARD_LINK_WARNINGS) { + WARNING("Suppressing further warnings regarding failure to extract\n" + " reparse points due to insufficient privileges..."); + } + } else { + ERROR("Failed to set reparse data on \"%ls\"", path); + win32_error(err); + if (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK || + inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) + return WIMLIB_ERR_LINK; + else + return WIMLIB_ERR_WRITE; + } } return 0; } +/* Wrapper around the FSCTL_SET_COMPRESSION ioctl to change the + * FILE_ATTRIBUTE_COMPRESSED flag of a file or directory. */ static int -win32_set_compressed(HANDLE hFile, const wchar_t *path) +win32_set_compression_state(HANDLE hFile, USHORT format, const wchar_t *path) { - USHORT format = COMPRESSION_FORMAT_DEFAULT; - DWORD bytesReturned = 0; + DWORD bytesReturned; if (!DeviceIoControl(hFile, FSCTL_SET_COMPRESSION, &format, sizeof(USHORT), NULL, 0, @@ -1347,15 +1830,19 @@ win32_set_compressed(HANDLE hFile, const wchar_t *path) DWORD err = GetLastError(); ERROR("Failed to set compression flag on \"%ls\"", path); win32_error(err); - return WIMLIB_ERR_WRITE; + if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD) + return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT; + else + return WIMLIB_ERR_WRITE; } return 0; } +/* Wrapper around FSCTL_SET_SPARSE ioctl to set a file as sparse. */ static int win32_set_sparse(HANDLE hFile, const wchar_t *path) { - DWORD bytesReturned = 0; + DWORD bytesReturned; if (!DeviceIoControl(hFile, FSCTL_SET_SPARSE, NULL, 0, NULL, 0, @@ -1366,7 +1853,10 @@ win32_set_sparse(HANDLE hFile, const wchar_t *path) DWORD err = GetLastError(); WARNING("Failed to set sparse flag on \"%ls\"", path); win32_error(err); - return WIMLIB_ERR_WRITE; + if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD) + return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT; + else + return WIMLIB_ERR_WRITE; } return 0; } @@ -1376,21 +1866,55 @@ win32_set_sparse(HANDLE hFile, const wchar_t *path) */ static int win32_set_security_data(const struct wim_inode *inode, + HANDLE hFile, const wchar_t *path, struct apply_args *args) { PSECURITY_DESCRIPTOR descriptor; unsigned long n; DWORD err; + const struct wim_security_data *sd; + + SECURITY_INFORMATION securityInformation = 0; + + void *owner = NULL; + void *group = NULL; + ACL *dacl = NULL; + ACL *sacl = NULL; - descriptor = wim_const_security_data(args->w)->descriptors[inode->i_security_id]; + BOOL owner_defaulted; + BOOL group_defaulted; + BOOL dacl_present; + BOOL dacl_defaulted; + BOOL sacl_present; + BOOL sacl_defaulted; + + sd = wim_const_security_data(args->w); + descriptor = sd->descriptors[inode->i_security_id]; + + GetSecurityDescriptorOwner(descriptor, &owner, &owner_defaulted); + if (owner) + securityInformation |= OWNER_SECURITY_INFORMATION; + + GetSecurityDescriptorGroup(descriptor, &group, &group_defaulted); + if (group) + securityInformation |= GROUP_SECURITY_INFORMATION; + + GetSecurityDescriptorDacl(descriptor, &dacl_present, + &dacl, &dacl_defaulted); + if (dacl) + securityInformation |= DACL_SECURITY_INFORMATION; + + GetSecurityDescriptorSacl(descriptor, &sacl_present, + &sacl, &sacl_defaulted); + if (sacl) + securityInformation |= SACL_SECURITY_INFORMATION; - SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION | - SACL_SECURITY_INFORMATION | - OWNER_SECURITY_INFORMATION | - GROUP_SECURITY_INFORMATION; again: - if (SetFileSecurityW(path, securityInformation, descriptor)) + if (securityInformation == 0) + return 0; + if (SetSecurityInfo(hFile, SE_FILE_OBJECT, + securityInformation, owner, group, dacl, sacl)) return 0; err = GetLastError(); if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) @@ -1400,6 +1924,7 @@ again: if (securityInformation & SACL_SECURITY_INFORMATION) { n = args->num_set_sacl_priv_notheld++; securityInformation &= ~SACL_SECURITY_INFORMATION; + sacl = NULL; if (n < MAX_SET_SACL_PRIV_NOTHELD_WARNINGS) { WARNING( "We don't have enough privileges to set the full security\n" @@ -1439,7 +1964,10 @@ again: fail: ERROR("Failed to set security descriptor on \"%ls\"", path); win32_error(err); - return WIMLIB_ERR_WRITE; + if (err == ERROR_ACCESS_DENIED || err == ERROR_PRIVILEGE_NOT_HELD) + return WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT; + else + return WIMLIB_ERR_WRITE; } } @@ -1464,18 +1992,78 @@ win32_extract_chunk(const void *buf, size_t len, void *arg) } static int -do_win32_extract_stream(HANDLE hStream, struct wim_lookup_table_entry *lte) +do_win32_extract_stream(HANDLE hStream, const struct wim_lookup_table_entry *lte) { return extract_wim_resource(lte, wim_resource_size(lte), win32_extract_chunk, hStream); } +struct win32_encrypted_extract_ctx { + const struct wim_lookup_table_entry *lte; + u64 offset; +}; + +static DWORD WINAPI +win32_encrypted_import_cb(unsigned char *data, void *_ctx, + unsigned long *len_p) +{ + struct win32_encrypted_extract_ctx *ctx = _ctx; + unsigned long len = *len_p; + const struct wim_lookup_table_entry *lte = ctx->lte; + + len = min(len, wim_resource_size(lte) - ctx->offset); + + if (read_partial_wim_resource_into_buf(lte, len, ctx->offset, data)) + return ERROR_READ_FAULT; + + ctx->offset += len; + *len_p = len; + return ERROR_SUCCESS; +} + +/* Create an encrypted file and extract the raw encrypted data to it. + * + * @path: Path to encrypted file to create. + * @lte: WIM lookup_table entry for the raw encrypted data. + * + * This is separate from do_win32_extract_stream() because the WIM is supposed + * to contain the *raw* encrypted data, which needs to be extracted ("imported") + * using the special APIs OpenEncryptedFileRawW(), WriteEncryptedFileRaw(), and + * CloseEncryptedFileRaw(). + * + * Returns 0 on success; nonzero on failure. + */ 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; + void *file_ctx; + int ret; + + DEBUG("Opening file \"%ls\" to extract raw encrypted data", path); + + ret = OpenEncryptedFileRawW(path, CREATE_FOR_IMPORT, &file_ctx); + if (ret) { + ERROR("Failed to open \"%ls\" to write raw encrypted data", path); + win32_error(ret); + return WIMLIB_ERR_OPEN; + } + + if (lte) { + struct win32_encrypted_extract_ctx ctx; + + ctx.lte = lte; + ctx.offset = 0; + ret = WriteEncryptedFileRaw(win32_encrypted_import_cb, &ctx, file_ctx); + if (ret == ERROR_SUCCESS) { + ret = 0; + } else { + ret = WIMLIB_ERR_WRITE; + ERROR("Failed to extract encrypted file \"%ls\"", path); + } + } + CloseEncryptedFileRaw(file_ctx); + return ret; } static bool @@ -1495,11 +2083,27 @@ path_is_root_of_drive(const wchar_t *path) return (*path == L'\0'); } -static DWORD -win32_get_create_flags_and_attributes(DWORD i_attributes) +static inline DWORD +win32_mask_attributes(DWORD i_attributes) { - DWORD attributes; + return i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE | + FILE_ATTRIBUTE_COMPRESSED | + FILE_ATTRIBUTE_REPARSE_POINT | + FILE_ATTRIBUTE_DIRECTORY | + FILE_ATTRIBUTE_ENCRYPTED | + 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); +} +static inline DWORD +win32_get_create_flags_and_attributes(DWORD i_attributes) +{ /* * Some attributes cannot be set by passing them to CreateFile(). In * particular: @@ -1524,44 +2128,25 @@ win32_get_create_flags_and_attributes(DWORD i_attributes) * 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; + return win32_mask_attributes(i_attributes) | + FILE_FLAG_OPEN_REPARSE_POINT | + FILE_FLAG_BACKUP_SEMANTICS; } -/* Set compression or sparse attributes, and reparse data, if supported by the +/* Set compression and/or sparse attributes on a stream, 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) +win32_set_special_stream_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); + ret = win32_set_compression_state(hFile, + COMPRESSION_FORMAT_DEFAULT, + path); if (ret) return ret; } else { @@ -1583,39 +2168,244 @@ win32_set_special_attributes(HANDLE hFile, const struct wim_inode *inode, path); } } + return 0; +} - 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); +/* Pre-create directories; extract encrypted streams */ +static int +win32_begin_extract_unnamed_stream(const struct wim_inode *inode, + const struct wim_lookup_table_entry *lte, + const wchar_t *path, + DWORD *creationDisposition_ret, + unsigned int vol_flags) +{ + DWORD err; + int ret; + + /* 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 && + !path_is_root_of_drive(path)) { + if (!CreateDirectoryW(path, NULL)) { + err = GetLastError(); + if (err != ERROR_ALREADY_EXISTS) { + ERROR("Failed to create directory \"%ls\"", + path); + win32_error(err); + return WIMLIB_ERR_MKDIR; + } + } + DEBUG("Created directory \"%ls\"", path); + *creationDisposition_ret = OPEN_EXISTING; + } + if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && + vol_flags & FILE_SUPPORTS_ENCRYPTION) + { + if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) { + unsigned remaining_sharing_violations = 100; + while (!EncryptFile(path)) { + if (remaining_sharing_violations && + err == ERROR_SHARING_VIOLATION) + { + WARNING("Couldn't encrypt directory \"%ls\" " + "due to sharing violation; re-trying " + "after 100 ms", path); + Sleep(100); + remaining_sharing_violations--; + } else { + err = GetLastError(); + ERROR("Failed to encrypt directory \"%ls\"", + path); + win32_error(err); + return WIMLIB_ERR_WRITE; + } + } + } else { + ret = do_win32_extract_encrypted_stream(path, lte); if (ret) return ret; - } else { - DEBUG("Cannot set reparse data on \"%ls\": volume " - "does not support reparse points", path); + DEBUG("Extracted encrypted file \"%ls\"", path); } + *creationDisposition_ret = OPEN_EXISTING; } + /* Set file attributes if we created the file. Otherwise, we haven't + * created the file set and we will set the attributes in the call to + * CreateFileW(). + * + * The FAT filesystem does not let you change the attributes of the root + * directory, so treat that as a special case and do not set attributes. + * */ + if (*creationDisposition_ret == OPEN_EXISTING && + !path_is_root_of_drive(path)) + { + if (!SetFileAttributesW(path, + win32_mask_attributes(inode->i_attributes))) + { + err = GetLastError(); + ERROR("Failed to set attributes on \"%ls\"", path); + win32_error(err); + return WIMLIB_ERR_WRITE; + } + } return 0; } +/* Set security descriptor and extract stream data or reparse data (skip the + * unnamed data stream of encrypted files, which was already extracted). */ static int -win32_extract_stream(const struct wim_inode *inode, +win32_finish_extract_stream(HANDLE h, const struct wim_dentry *dentry, + const struct wim_lookup_table_entry *lte, + const wchar_t *stream_path, + const wchar_t *stream_name_utf16, + struct apply_args *args) +{ + int ret = 0; + const struct wim_inode *inode = dentry->d_inode; + const wchar_t *short_name; + if (stream_name_utf16 == NULL) { + /* Unnamed stream. */ + + /* Set security descriptor, unless the extract_flags indicate + * not to or the volume does not supported it. Note that this + * is only done when the unnamed stream is being extracted, as + * security descriptors are per-file and not per-stream. */ + if (inode->i_security_id >= 0 && + !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) + && (args->vol_flags & FILE_PERSISTENT_ACLS)) + { + ret = win32_set_security_data(inode, h, stream_path, args); + if (ret) + return ret; + } + + /* Handle reparse points. The data for them needs to be set + * using a special ioctl. Note that the reparse point may have + * been created using CreateFileW() in the case of + * non-directories or CreateDirectoryW() in the case of + * directories; but the ioctl works either way. Also, it is + * only this step that actually sets the + * FILE_ATTRIBUTE_REPARSE_POINT, as it is not valid to set it + * using SetFileAttributesW() or CreateFileW(). + * + * If the volume does not support reparse points we simply + * ignore the reparse data. (N.B. the code currently doesn't + * actually reach this case because reparse points are skipped + * entirely on such volumes.) */ + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + if (args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS) { + ret = win32_set_reparse_data(h, inode, + lte, stream_path, + args); + if (ret) + return ret; + } else { + DEBUG("Cannot set reparse data on \"%ls\": volume " + "does not support reparse points", stream_path); + } + } else if (lte != NULL && + !(args->vol_flags & FILE_SUPPORTS_ENCRYPTION && + inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) + { + /* Extract the data of the unnamed stream, unless the + * lookup table entry is NULL (indicating an empty + * stream for which no data needs to be extracted), or + * the stream is encrypted and therefore was already + * extracted as a special case. */ + ret = do_win32_extract_stream(h, lte); + if (ret) + return ret; + } + + if (dentry_has_short_name(dentry)) + short_name = dentry->short_name; + else + short_name = L""; + /* Set short name */ + if (!SetFileShortNameW(h, short_name)) { + #if 0 + DWORD err = GetLastError(); + ERROR("Could not set short name on \"%ls\"", stream_path); + win32_error(err); + #endif + } + } else { + /* Extract the data for a named data stream. */ + if (lte != NULL) { + DEBUG("Extracting named data stream \"%ls\" (len = %"PRIu64")", + stream_path, wim_resource_size(lte)); + ret = do_win32_extract_stream(h, lte); + } + } + return ret; +} + +static int +win32_decrypt_file(HANDLE open_handle, const wchar_t *path) +{ + DWORD err; + /* We cannot call DecryptFileW() while there is an open handle to the + * file. So close it first. */ + if (!CloseHandle(open_handle)) { + err = GetLastError(); + ERROR("Failed to close handle for \"%ls\"", path); + win32_error(err); + return WIMLIB_ERR_WRITE; + } + if (!DecryptFileW(path, 0 /* reserved parameter; set to 0 */)) { + err = GetLastError(); + ERROR("Failed to decrypt file \"%ls\"", path); + win32_error(err); + return WIMLIB_ERR_WRITE; + } + return 0; +} + +/* + * Create and extract a stream to a file, or create a directory, using the + * Windows API. + * + * This handles reparse points, directories, alternate data streams, encrypted + * files, compressed files, etc. + * + * @dentry: WIM dentry for the file or directory being extracted. + * + * @path: Path to extract the file to. + * + * @stream_name_utf16: + * Name of the stream, or NULL if the stream is unnamed. This will + * be called with a NULL stream_name_utf16 before any non-NULL + * stream_name_utf16's. + * + * @lte: WIM lookup table entry for the stream. May be NULL to indicate + * a stream of length 0. + * + * @args: Additional apply context, including flags indicating supported + * volume features. + * + * Returns 0 on success; nonzero on failure. + */ +static int +win32_extract_stream(const struct wim_dentry *dentry, const wchar_t *path, const wchar_t *stream_name_utf16, struct wim_lookup_table_entry *lte, - unsigned vol_flags) + struct apply_args *args) { wchar_t *stream_path; HANDLE h; int ret; DWORD err; DWORD creationDisposition = CREATE_ALWAYS; + DWORD requestedAccess; + BY_HANDLE_FILE_INFORMATION file_info; + unsigned remaining_sharing_violations = 1000; + const struct wim_inode *inode = dentry->d_inode; if (stream_name_utf16) { /* Named stream. Create a buffer that contains the UTF-16LE - * string [.\]@path:@stream_name_utf16. This is needed to + * 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 @@ -1647,79 +2437,129 @@ win32_extract_stream(const struct wim_inode *inode, * */ 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; - } + ret = win32_begin_extract_unnamed_stream(inode, lte, path, + &creationDisposition, + args->vol_flags); + if (ret) + goto fail; } DEBUG("Opening \"%ls\"", stream_path); + /* DELETE access is needed for SetFileShortNameW(), for some reason. */ + requestedAccess = GENERIC_READ | GENERIC_WRITE | DELETE | + ACCESS_SYSTEM_SECURITY; +try_open_again: + /* Open the stream to be extracted. Depending on what we have set + * creationDisposition to, we may be creating this for the first time, + * or we may be opening on existing stream we already created using + * CreateDirectoryW() or OpenEncryptedFileRawW(). */ h = CreateFileW(stream_path, - GENERIC_READ | GENERIC_WRITE, - 0, + requestedAccess, + FILE_SHARE_READ, 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); + if (err == ERROR_ACCESS_DENIED && + path_is_root_of_drive(stream_path)) + { + ret = 0; + goto out; + } + if ((err == ERROR_PRIVILEGE_NOT_HELD || + err == ERROR_ACCESS_DENIED) && + (requestedAccess & ACCESS_SYSTEM_SECURITY)) + { + /* Try opening the file again without privilege to + * modify SACL. */ + requestedAccess &= ~ACCESS_SYSTEM_SECURITY; + goto try_open_again; + } + if (err == ERROR_SHARING_VIOLATION) { + if (remaining_sharing_violations) { + --remaining_sharing_violations; + /* This can happen when restoring encrypted directories + * for some reason. Probably a bug in EncryptFile(). */ + WARNING("Couldn't open \"%ls\" due to sharing violation; " + "re-trying after 100ms", stream_path); + Sleep(100); + goto try_open_again; + } else { + ERROR("Too many sharing violations; giving up..."); + } + } else { + if (creationDisposition == OPEN_EXISTING) + ERROR("Failed to open \"%ls\"", stream_path); + else + 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); + /* Check the attributes of the file we just opened, and remove + * encryption or compression if either was set by default but is not + * supposed to be set based on the WIM inode attributes. */ + if (!GetFileInformationByHandle(h, &file_info)) { + err = GetLastError(); + ERROR("Failed to get attributes of \"%ls\"", stream_path); + win32_error(err); + ret = WIMLIB_ERR_STAT; + goto fail_close_handle; + } + + /* Remove encryption? */ + if (file_info.dwFileAttributes & FILE_ATTRIBUTE_ENCRYPTED && + !(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)) + { + /* File defaulted to encrypted due to being in an encrypted + * directory, but is not actually supposed to be encrypted. + * + * This is a workaround, because I'm not aware of any way to + * directly (e.g. with CreateFileW()) create an unencrypted file + * in a directory with FILE_ATTRIBUTE_ENCRYPTED set. */ + ret = win32_decrypt_file(h, stream_path); if (ret) - goto fail_close_handle; + goto fail; /* win32_decrypt_file() closed the handle. */ + creationDisposition = OPEN_EXISTING; + goto try_open_again; } - 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; - } + /* Remove compression? */ + if (file_info.dwFileAttributes & FILE_ATTRIBUTE_COMPRESSED && + !(inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED)) + { + /* Similar to the encrypted case, above, if the file defaulted + * to compressed due to being in an compressed directory, but is + * not actually supposed to be compressed, explicitly set the + * compression format to COMPRESSION_FORMAT_NONE. */ + ret = win32_set_compression_state(h, COMPRESSION_FORMAT_NONE, + stream_path); + if (ret) + goto fail_close_handle; } + /* Set compression and/or sparse attributes if needed */ + ret = win32_set_special_stream_attributes(h, inode, lte, path, + args->vol_flags); + + if (ret) + goto fail_close_handle; + + /* At this point we have at least created the needed stream with the + * appropriate attributes. We have yet to set the appropriate security + * descriptor and actually extract the stream data (other than for + * extracted files, which were already extracted). + * win32_finish_extract_stream() handles these additional steps. */ + ret = win32_finish_extract_stream(h, dentry, lte, stream_path, + stream_name_utf16, args); + if (ret) + goto fail_close_handle; + + /* Done extracting the stream. Close the handle and return. */ DEBUG("Closing \"%ls\"", stream_path); if (!CloseHandle(h)) { err = GetLastError(); @@ -1733,7 +2573,7 @@ win32_extract_stream(const struct wim_inode *inode, fail_close_handle: CloseHandle(h); fail: - ERROR("Error extracting %ls", stream_path); + ERROR("Error extracting \"%ls\"", stream_path); out: return ret; } @@ -1741,56 +2581,162 @@ out: /* * 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. + * streams). Handles sparse, compressed, and/or encrypted files. * - * @inode: WIM inode for this file or directory. + * @dentry: WIM dentry for this file or directory. * @path: UTF-16LE external path to extract the inode to. + * @args: Additional extraction context. * * 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) +win32_extract_streams(const struct wim_dentry *dentry, + const wchar_t *path, struct apply_args *args) { struct wim_lookup_table_entry *unnamed_lte; int ret; + const struct wim_inode *inode = dentry->d_inode; + + /* First extract the unnamed stream. */ unnamed_lte = inode_unnamed_lte_resolved(inode); - ret = win32_extract_stream(inode, path, NULL, unnamed_lte, - vol_flags); + ret = win32_extract_stream(dentry, path, NULL, unnamed_lte, args); 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)) + /* Extract any named streams, if supported by the volume. */ + + if (!(args->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); - } + + /* Skip the unnamed stream if it's in the ADS entries (we + * already extracted it...) */ + if (ads_entry->stream_name_nbytes == 0) + continue; + + /* 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; + + /* Extract the named stream */ + ret = win32_extract_stream(dentry, + path, + ads_entry->stream_name, + ads_entry->lte, + args); + if (ret) + break; } out: return ret; } +/* If not done already, load the supported feature flags for the volume onto + * which the image is being extracted, and warn the user about any missing + * features that could be important. */ +static int +win32_check_vol_flags(const wchar_t *output_path, struct apply_args *args) +{ + if (args->have_vol_flags) + return 0; + + win32_get_vol_flags(output_path, &args->vol_flags); + args->have_vol_flags = true; + /* Warn the user about data that may not be extracted. */ + if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES)) + WARNING("Volume does not support sparse files!\n" + " Sparse files will be extracted as non-sparse."); + if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS)) + WARNING("Volume does not support reparse points!\n" + " Reparse point data will not be extracted."); + if (!(args->vol_flags & FILE_NAMED_STREAMS)) { + WARNING("Volume does not support named data streams!\n" + " Named data streams will not be extracted."); + } + if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) { + WARNING("Volume does not support encryption!\n" + " Encrypted files will be extracted as raw data."); + } + if (!(args->vol_flags & FILE_FILE_COMPRESSION)) { + WARNING("Volume does not support transparent compression!\n" + " Compressed files will be extracted as non-compressed."); + } + if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) { + if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) { + ERROR("Strict ACLs requested, but the volume does not " + "support ACLs!"); + return WIMLIB_ERR_VOLUME_LACKS_FEATURES; + } else { + WARNING("Volume does not support persistent ACLS!\n" + " File permissions will not be extracted."); + } + } + return 0; +} + +/* + * Try extracting a hard link. + * + * @output_path: Path to link to be extracted. + * + * @inode: WIM inode that the link is to; inode->i_extracted_file + * the path to a name of the file that has already been + * extracted (we use this to create the hard link). + * + * @args: Additional apply context, used here to keep track of + * the number of times creating a hard link failed due to + * ERROR_INVALID_FUNCTION. This error should indicate that hard + * links are not supported by the volume, and we would like to + * warn the user a few times, but not too many times. + * + * Returns 0 if the hard link was successfully extracted. Returns + * WIMLIB_ERR_LINK (> 0) if an error occurred, other than hard links possibly + * being unsupported by the volume. Returns a negative value if creating the + * hard link failed due to ERROR_INVALID_FUNCTION. + */ +static int +win32_try_hard_link(const wchar_t *output_path, const struct wim_inode *inode, + struct apply_args *args) +{ + DWORD err; + + /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS), + * but it's only available on Windows 7 and later. So no use + * even checking it, really. Instead, CreateHardLinkW() will + * apparently return ERROR_INVALID_FUNCTION if the volume does + * not support hard links. */ + DEBUG("Creating hard link \"%ls => %ls\"", + output_path, inode->i_extracted_file); + if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL)) + return 0; + + err = GetLastError(); + if (err != ERROR_INVALID_FUNCTION) { + ERROR("Can't create hard link \"%ls => %ls\"", + output_path, inode->i_extracted_file); + win32_error(err); + return WIMLIB_ERR_LINK; + } else { + args->num_hard_links_failed++; + if (args->num_hard_links_failed <= MAX_CREATE_HARD_LINK_WARNINGS) { + WARNING("Can't create hard link \"%ls => %ls\":\n" + " Volume does not support hard links!\n" + " Falling back to extracting a copy of the file.", + output_path, inode->i_extracted_file); + } + if (args->num_hard_links_failed == MAX_CREATE_HARD_LINK_WARNINGS) { + WARNING("Suppressing further hard linking warnings..."); + } + return -1; + } +} + /* Extract a file, directory, reparse point, or hard link to an * already-extracted file using the Win32 API */ int @@ -1801,106 +2747,56 @@ win32_do_apply_dentry(const wchar_t *output_path, { int ret; struct wim_inode *inode = dentry->d_inode; - DWORD err; - - if (!args->have_vol_flags) { - win32_get_vol_flags(output_path, &args->vol_flags); - args->have_vol_flags = true; - /* Warn the user about data that may not be extracted. */ - if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES)) - WARNING("Volume does not support sparse files!\n" - " Sparse files will be extracted as non-sparse."); - if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS)) - WARNING("Volume does not support reparse points!\n" - " Reparse point data will not be extracted."); - if (!(args->vol_flags & FILE_NAMED_STREAMS)) { - WARNING("Volume does not support named data streams!\n" - " Named data streams will not be extracted."); - } - if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) { - WARNING("Volume does not support encryption!\n" - " Encrypted files will be extracted as raw data."); - } - if (!(args->vol_flags & FILE_FILE_COMPRESSION)) { - WARNING("Volume does not support transparent compression!\n" - " Compressed files will be extracted as non-compressed."); - } - if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) { - if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) { - ERROR("Strict ACLs requested, but the volume does not " - "support ACLs!"); - return WIMLIB_ERR_VOLUME_LACKS_FEATURES; - } else { - WARNING("Volume does not support persistent ACLS!\n" - " File permissions will not be extracted."); - } - } - } + ret = win32_check_vol_flags(output_path, args); + if (ret) + return ret; if (inode->i_nlink > 1 && inode->i_extracted_file != NULL) { /* Linked file, with another name already extracted. Create a * hard link. */ - - /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS), - * but it's only available on Windows 7 and later. So no use - * even checking it, really. Instead, CreateHardLinkW() will - * apparently return ERROR_INVALID_FUNCTION if the volume does - * not support hard links. */ - DEBUG("Creating hard link \"%ls => %ls\"", - output_path, inode->i_extracted_file); - if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL)) - return 0; - - err = GetLastError(); - if (err != ERROR_INVALID_FUNCTION) { - ERROR("Can't create hard link \"%ls => %ls\"", - output_path, inode->i_extracted_file); - win32_error(err); - return WIMLIB_ERR_LINK; - } else { - WARNING("Can't create hard link \"%ls => %ls\":\n" - " Volume does not support hard links!\n" - " Falling back to extracting a copy of the file.", - output_path, inode->i_extracted_file); - } + ret = win32_try_hard_link(output_path, inode, args); + if (ret >= 0) + return ret; + /* Negative return value from win32_try_hard_link() indicates + * that hard links are probably not supported by the volume. + * Fall back to extracting a copy of the file. */ } + /* If this is a reparse point and the volume does not support reparse + * points, just skip it completely. */ if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT && !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS)) { WARNING("Skipping extraction of reparse point \"%ls\":\n" " Not supported by destination filesystem", output_path); - struct wim_lookup_table_entry *lte; - lte = inode_unnamed_lte_resolved(inode); - if (lte) - args->progress.extract.completed_bytes += wim_resource_size(lte); - return 0; - } - - /* Create the file, directory, or reparse point, and extract the - * data streams. */ - ret = win32_extract_streams(inode, output_path, - &args->progress.extract.completed_bytes, - args->vol_flags); - if (ret) - return ret; - - if (inode->i_security_id >= 0 && - !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS) - && (args->vol_flags & FILE_PERSISTENT_ACLS)) - { - ret = win32_set_security_data(inode, output_path, args); + } else { + /* Create the file, directory, or reparse point, and extract the + * data streams. */ + ret = win32_extract_streams(dentry, output_path, args); if (ret) return ret; } - if (inode->i_nlink > 1) { - /* Save extracted path for a later call to - * CreateHardLinkW() if this inode has multiple links. - * */ - inode->i_extracted_file = WSTRDUP(output_path); - if (!inode->i_extracted_file) - ret = WIMLIB_ERR_NOMEM; + if (inode->i_extracted_file == NULL) { + const struct wim_lookup_table_entry *lte; + + /* Tally bytes extracted, including all alternate data streams, + * unless we extracted a hard link (or, at least extracted a + * name that was supposed to be a hard link) */ + for (unsigned i = 0; i <= inode->i_num_ads; i++) { + lte = inode_stream_lte_resolved(inode, i); + if (lte) + args->progress.extract.completed_bytes += + wim_resource_size(lte); + } + if (inode->i_nlink > 1) { + /* Save extracted path for a later call to + * CreateHardLinkW() if this inode has multiple links. + * */ + inode->i_extracted_file = WSTRDUP(output_path); + if (!inode->i_extracted_file) + return WIMLIB_ERR_NOMEM; + } } return 0; } @@ -1909,8 +2805,8 @@ win32_do_apply_dentry(const wchar_t *output_path, int win32_do_apply_dentry_timestamps(const wchar_t *path, size_t path_num_chars, - const struct wim_dentry *dentry, - const struct apply_args *args) + struct wim_dentry *dentry, + struct apply_args *args) { DWORD err; HANDLE h; @@ -1967,25 +2863,18 @@ out: int fsync(int fd) { - DWORD err; HANDLE h; h = (HANDLE)_get_osfhandle(fd); - if (h == INVALID_HANDLE_VALUE) { - err = GetLastError(); - ERROR("Could not get Windows handle for file descriptor"); - win32_error(err); - errno = EBADF; - return -1; - } - if (!FlushFileBuffers(h)) { - err = GetLastError(); - ERROR("Could not flush file buffers to disk"); - win32_error(err); - errno = EIO; - return -1; - } + if (h == INVALID_HANDLE_VALUE) + goto err; + if (!FlushFileBuffers(h)) + goto err_set_errno; return 0; +err_set_errno: + set_errno_from_GetLastError(); +err: + return -1; } /* Use the Win32 API to get the number of processors */ @@ -2004,8 +2893,8 @@ wchar_t * realpath(const wchar_t *path, wchar_t *resolved_path) { DWORD ret; - wimlib_assert(resolved_path == NULL); DWORD err; + wimlib_assert(resolved_path == NULL); ret = GetFullPathNameW(path, 0, NULL, NULL); if (!ret) { @@ -2025,8 +2914,7 @@ realpath(const wchar_t *path, wchar_t *resolved_path) } goto out; fail_win32: - win32_error(err); - errno = -1; + errno = win32_error_to_errno(err); out: return resolved_path; } @@ -2039,12 +2927,7 @@ win32_rename_replacement(const wchar_t *oldpath, const wchar_t *newpath) if (MoveFileExW(oldpath, newpath, MOVEFILE_REPLACE_EXISTING)) { return 0; } else { - /* As usual, the possible error values are not documented */ - DWORD err = GetLastError(); - ERROR("MoveFileEx(): Can't rename \"%ls\" to \"%ls\"", - oldpath, newpath); - win32_error(err); - errno = -1; + set_errno_from_GetLastError(); return -1; } } @@ -2085,9 +2968,7 @@ fail_close_handle: fail: if (err == NO_ERROR) err = GetLastError(); - ERROR("Can't truncate \"%ls\" to %"PRIu64" bytes", path, size); - win32_error(err); - errno = -1; + errno = win32_error_to_errno(err); return -1; } @@ -2107,4 +2988,93 @@ win32_strerror_r_replacement(int errnum, wchar_t *buf, size_t buflen) return 0; } +static int +do_pread_or_pwrite(int fd, void *buf, size_t count, off_t offset, + bool is_pwrite) +{ + HANDLE h; + LARGE_INTEGER orig_offset; + DWORD bytes_read_or_written; + LARGE_INTEGER relative_offset; + OVERLAPPED overlapped; + BOOL bret; + + wimlib_assert(count <= 0xffffffff); + + h = (HANDLE)_get_osfhandle(fd); + if (h == INVALID_HANDLE_VALUE) + goto err; + + /* Get original position */ + relative_offset.QuadPart = 0; + if (!SetFilePointerEx(h, relative_offset, &orig_offset, FILE_CURRENT)) + goto err_set_errno; + + memset(&overlapped, 0, sizeof(overlapped)); + overlapped.Offset = offset; + overlapped.OffsetHigh = offset >> 32; + + /* Do the read or write at the specified offset */ + if (is_pwrite) + bret = WriteFile(h, buf, count, &bytes_read_or_written, &overlapped); + else + bret = ReadFile(h, buf, count, &bytes_read_or_written, &overlapped); + if (!bret) + goto err_set_errno; + + /* Restore the original position */ + if (!SetFilePointerEx(h, orig_offset, NULL, FILE_BEGIN)) + goto err_set_errno; + + return bytes_read_or_written; +err_set_errno: + set_errno_from_GetLastError(); +err: + return -1; +} + +/* Dumb Windows implementation of pread(). It temporarily changes the file + * offset, so it is not safe to use with readers/writers on the same file + * descriptor. */ +extern ssize_t +win32_pread(int fd, void *buf, size_t count, off_t offset) +{ + return do_pread_or_pwrite(fd, buf, count, offset, false); +} + +/* Dumb Windows implementation of pwrite(). It temporarily changes the file + * offset, so it is not safe to use with readers/writers on the same file + * descriptor. */ +extern ssize_t +win32_pwrite(int fd, const void *buf, size_t count, off_t offset) +{ + return do_pread_or_pwrite(fd, (void*)buf, count, offset, true); +} + +/* Dumb Windows implementation of writev(). It writes the vectors one at a + * time. */ +extern ssize_t +win32_writev(int fd, const struct iovec *iov, int iovcnt) +{ + ssize_t total_bytes_written = 0; + + if (iovcnt <= 0) { + errno = EINVAL; + return -1; + } + for (int i = 0; i < iovcnt; i++) { + ssize_t bytes_written; + + bytes_written = write(fd, iov[i].iov_base, iov[i].iov_len); + if (bytes_written >= 0) + total_bytes_written += bytes_written; + if (bytes_written != iov[i].iov_len) { + if (total_bytes_written == 0) + total_bytes_written = -1; + break; + } + } + return total_bytes_written; +} + #endif /* __WIN32__ */