]> wimlib.net Git - wimlib/blobdiff - src/win32.c
win32_read_file: Use UTF16-LE name
[wimlib] / src / win32.c
index f094656a0c35df39b6d2cd747d276356a9a54aee..0c5c51cdb47594afcc5d7738f26b76bf418538ca 100644 (file)
 
 #include <errno.h>
 
+
+
+/* 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. */
+
+/* Vista and later */
+static HANDLE (WINAPI *win32func_FindFirstStreamW)(LPCWSTR lpFileName,
+                                           STREAM_INFO_LEVELS InfoLevel,
+                                           LPVOID lpFindStreamData,
+                                           DWORD dwFlags) = NULL;
+
+/* Vista and later */
+static BOOL (WINAPI *win32func_FindNextStreamW)(HANDLE hFindStream,
+                                        LPVOID lpFindStreamData) = NULL;
+
+static HMODULE hKernel32 = NULL;
+
+/* Try to dynamically load some functions */
+void
+win32_global_init()
+{
+       DWORD err;
+       bool warned;
+
+
+       if (hKernel32 == NULL) {
+               DEBUG("Loading Kernel32.dll");
+               hKernel32 = LoadLibraryA("Kernel32.dll");
+               if (hKernel32 == NULL) {
+                       err = GetLastError();
+                       WARNING("Can't load Kernel32.dll");
+                       win32_error(err);
+                       return;
+               }
+       }
+
+       DEBUG("Looking for FindFirstStreamW");
+       win32func_FindFirstStreamW = (void*)GetProcAddress(hKernel32, "FindFirstStreamW");
+       if (!win32func_FindFirstStreamW) {
+               WARNING("Could not find function FindFirstStreamW() in Kernel32.dll!");
+               WARNING("Capturing alternate data streams will not be supported.");
+               return;
+       }
+
+       DEBUG("Looking for FindNextStreamW");
+       win32func_FindNextStreamW = (void*)GetProcAddress(hKernel32, "FindNextStreamW");
+       if (!win32func_FindNextStreamW) {
+               WARNING("Could not find function FindNextStreamW() in Kernel32.dll!");
+               WARNING("Capturing alternate data streams will not be supported.");
+               win32func_FindFirstStreamW = NULL;
+       }
+}
+
+void
+win32_global_cleanup()
+{
+       if (hKernel32 != NULL) {
+               DEBUG("Closing Kernel32.dll");
+               FreeLibrary(hKernel32);
+               hKernel32 = NULL;
+       }
+}
+
 static const char *access_denied_msg =
 "         If you are not running this program as the administrator, you may\n"
 "         need to do so, so that all data and metadata can be backed up.\n"
@@ -75,12 +139,9 @@ win32_error_last()
 }
 #endif
 
-HANDLE
-win32_open_file_readonly(const wchar_t *path, bool data_only)
+static HANDLE
+win32_open_existing_file(const wchar_t *path, DWORD dwDesiredAccess)
 {
-       DWORD dwDesiredAccess = FILE_READ_DATA;
-       if (!data_only)
-               dwDesiredAccess |= FILE_READ_ATTRIBUTES | READ_CONTROL | ACCESS_SYSTEM_SECURITY;
        return CreateFileW(path,
                           dwDesiredAccess,
                           FILE_SHARE_READ,
@@ -91,8 +152,14 @@ win32_open_file_readonly(const wchar_t *path, bool data_only)
                           NULL /* hTemplateFile */);
 }
 
+HANDLE
+win32_open_file_data_only(const wchar_t *path)
+{
+       return win32_open_existing_file(path, FILE_READ_DATA);
+}
+
 int
-win32_read_file(const mbchar *filename,
+win32_read_file(const utf16lechar *win32_filename,
                void *handle, u64 offset, size_t size, void *buf)
 {
        HANDLE h = handle;
@@ -106,7 +173,7 @@ win32_read_file(const mbchar *filename,
                if (ReadFile(h, buf, size, &bytesRead, NULL) && bytesRead == size)
                        return 0;
        err = GetLastError();
-       ERROR("Error reading \"%s\"", filename);
+       ERROR("Error reading \"%ls\"", win32_filename);
        win32_error(err);
        return WIMLIB_ERR_READ;
 }
@@ -236,9 +303,10 @@ win32_recurse_directory(struct wim_dentry *root,
        ret = 0;
        do {
                /* Skip . and .. entries */
-               if (!(dat.cFileName[0] == L'.' &&
-                     (dat.cFileName[1] == L'\0' ||
-                      (dat.cFileName[1] == L'.' && dat.cFileName[2] == L'\0'))))
+               if (!(dat.cFileName[0] == cpu_to_le16(L'.') &&
+                     (dat.cFileName[1] == cpu_to_le16(L'\0') ||
+                      (dat.cFileName[1] == cpu_to_le16(L'.') &&
+                       dat.cFileName[2] == cpu_to_le16(L'\0')))))
                {
                        struct wim_dentry *child;
 
@@ -286,8 +354,7 @@ out_find_close:
  *                 for the reparse point unless an entry already exists for
  *                 the exact same data stream.
  *
- * @path:  External path to the parse point (UTF-8).  Used for error messages
- *         only.
+ * @path:  External path to the reparse point.  Used for error messages only.
  *
  * Returns 0 on success; nonzero on failure. */
 static int
@@ -302,8 +369,14 @@ win32_capture_reparse_point(HANDLE hFile,
        DWORD bytesReturned;
 
        if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT,
-                            NULL, 0, reparse_point_buf,
-                            sizeof(reparse_point_buf), &bytesReturned, NULL))
+                            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
+                                                  receives the reparse point data */
+                            sizeof(reparse_point_buf), /* "The size of the output
+                                                          buffer, in bytes */
+                            &bytesReturned,
+                            NULL))
        {
                DWORD err = GetLastError();
                ERROR("Win32 API: Failed to get reparse data of \"%s\"", path);
@@ -316,7 +389,7 @@ win32_capture_reparse_point(HANDLE hFile,
        }
        inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf);
        return inode_add_ads_with_data(inode, "",
-                                      (const u8*)reparse_point_buf + 8,
+                                      reparse_point_buf + 8,
                                       bytesReturned - 8, lookup_table);
 }
 
@@ -340,7 +413,7 @@ win32_sha1sum(const wchar_t *path, u8 hash[SHA1_HASH_SIZE])
        DWORD bytesRead;
        int ret;
 
-       hFile = win32_open_file_readonly(path, false);
+       hFile = win32_open_file_data_only(path);
        if (hFile == INVALID_HANDLE_VALUE)
                return WIMLIB_ERR_OPEN;
 
@@ -390,18 +463,22 @@ win32_capture_stream(const wchar_t *path_utf16,
        u8 hash[SHA1_HASH_SIZE];
        struct wim_lookup_table_entry *lte;
        int ret;
-       wchar_t *p, *colon;
+       wchar_t *stream_name, *colon;
+       size_t stream_name_nchars;
        bool is_named_stream;
        wchar_t *spath;
        size_t spath_nchars;
        DWORD err;
+       size_t spath_buf_nbytes;
+       const wchar_t *relpath_prefix;
+       const wchar_t *colonchar;
 
        /* The stream name should be returned as :NAME:TYPE */
-       p = dat->cStreamName;
-       if (*p != L':')
+       stream_name = dat->cStreamName;
+       if (*stream_name != L':')
                goto out_invalid_stream_name;
-       p += 1;
-       colon = wcschr(p, L':');
+       stream_name += 1;
+       colon = wcschr(stream_name, L':');
        if (colon == NULL)
                goto out_invalid_stream_name;
 
@@ -411,47 +488,56 @@ win32_capture_stream(const wchar_t *path_utf16,
                goto out;
        }
 
-       is_named_stream = (p != colon);
+       *colon = '\0';
+
+       stream_name_nchars = colon - stream_name;
+       is_named_stream = (stream_name_nchars != 0);
+
        if (is_named_stream) {
                /* Allocate an ADS entry for the named stream. */
-               mbchar *mbs_stream_name;
-               size_t mbs_stream_name_nbytes;
-               ret = utf16le_to_mbs(p,
-                                    (colon - p) * sizeof(wchar_t),
-                                    &mbs_stream_name,
-                                    &mbs_stream_name_nbytes);
-               if (ret)
-                       goto out;
-               ads_entry = inode_add_ads(inode, mbs_stream_name);
-               FREE(mbs_stream_name);
+               ads_entry = inode_add_ads_utf16le(inode, stream_name,
+                                                 stream_name_nchars * 2);
                if (!ads_entry) {
                        ret = WIMLIB_ERR_NOMEM;
                        goto out;
                }
        }
 
-       /* Create a UTF-16 string @spath that gives the filename, then a colon,
-        * then the stream name.  Or, if it's an unnamed stream, just the
+       /* 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
-        * wim_lookup_table_entry if needed. */
-       *colon = '\0';
+        * wim_lookup_table_entry if needed.
+        *
+        * As yet another special case, relative paths need to be changed to
+        * begin with an explicit "./" so that, for example, a file t:ads, where
+        * :ads is the part we added, is not interpreted as a file on the t:
+        * drive. */
        spath_nchars = path_utf16_nchars;
-       if (is_named_stream)
-               spath_nchars += colon - p + 1;
-
-       spath = MALLOC((spath_nchars + 1) * sizeof(wchar_t));
-       memcpy(spath, path_utf16, path_utf16_nchars * sizeof(wchar_t));
+       relpath_prefix = L"";
+       colonchar = L"";
        if (is_named_stream) {
-               spath[path_utf16_nchars] = L':';
-               memcpy(&spath[path_utf16_nchars + 1], p, (colon - p) * sizeof(wchar_t));
+               spath_nchars += 1 + stream_name_nchars;
+               colonchar = L":";
+               if (path_utf16_nchars == 1 &&
+                   path_utf16[0] != cpu_to_le16('/') &&
+                   path_utf16[0] != cpu_to_le16('\\'))
+               {
+                       spath_nchars += 2;
+                       relpath_prefix = L"./";
+               }
        }
-       spath[spath_nchars] = L'\0';
+
+       spath_buf_nbytes = (spath_nchars + 1) * sizeof(wchar_t);
+       spath = MALLOC(spath_buf_nbytes);
+
+       swprintf(spath, spath_buf_nbytes, L"%ls%ls%ls%ls",
+                relpath_prefix, path_utf16, colonchar, stream_name);
 
        ret = win32_sha1sum(spath, hash);
        if (ret) {
                err = GetLastError();
                ERROR("Win32 API: Failed to read \"%ls\" to calculate SHA1sum",
-                     path_utf16);
+                     spath);
                win32_error(err);
                goto out_free_spath;
        }
@@ -502,23 +588,33 @@ out_invalid_stream_name:
  *
  * @lookup_table:       Stream lookup table for the WIM.
  *
+ * @file_size:         Size of unnamed data stream.  (Used only if alternate
+ *                      data streams API appears to be unavailable.)
+ *
  * Returns 0 on success; nonzero on failure.
  */
 static int
 win32_capture_streams(const wchar_t *path_utf16,
                      size_t path_utf16_nchars,
                      struct wim_inode *inode,
-                     struct wim_lookup_table *lookup_table)
+                     struct wim_lookup_table *lookup_table,
+                     u64 file_size)
 {
        WIN32_FIND_STREAM_DATA dat;
        int ret;
        HANDLE hFind;
        DWORD err;
 
-       hFind = FindFirstStreamW(path_utf16, FindStreamInfoStandard, &dat, 0);
+       if (win32func_FindFirstStreamW == NULL)
+               goto unnamed_only;
+
+       hFind = win32func_FindFirstStreamW(path_utf16, FindStreamInfoStandard, &dat, 0);
        if (hFind == INVALID_HANDLE_VALUE) {
                err = GetLastError();
 
+               if (err == ERROR_CALL_NOT_IMPLEMENTED)
+                       goto unnamed_only;
+
                /* Seems legal for this to return ERROR_HANDLE_EOF on reparse
                 * points and directories */
                if ((inode->i_attributes &
@@ -547,7 +643,7 @@ win32_capture_streams(const wchar_t *path_utf16,
                                           &dat);
                if (ret)
                        goto out_find_close;
-       } while (FindNextStreamW(hFind, &dat));
+       } while (win32func_FindNextStreamW(hFind, &dat));
        err = GetLastError();
        if (err != ERROR_HANDLE_EOF) {
                ERROR("Win32 API: Error reading data streams from \"%ls\"", path_utf16);
@@ -557,6 +653,20 @@ win32_capture_streams(const wchar_t *path_utf16,
 out_find_close:
        FindClose(hFind);
        return ret;
+unnamed_only:
+       if (inode->i_attributes &
+            (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
+       {
+               ret = 0;
+       } else {
+               wcscpy(dat.cStreamName, L"::$DATA");
+               dat.StreamSize.QuadPart = file_size;
+               ret = win32_capture_stream(path_utf16,
+                                          path_utf16_nchars,
+                                          inode, lookup_table,
+                                          &dat);
+       }
+       return ret;
 }
 
 /* Win32 version of capturing a directory tree */
@@ -579,6 +689,7 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
        size_t path_utf16_nchars;
        struct sd_set *sd_set;
        DWORD err;
+       u64 file_size;
 
        if (exclude_path(root_disk_path, config, true)) {
                if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
@@ -620,7 +731,8 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
                goto out_destroy_sd_set;
        path_utf16_nchars = path_utf16_nbytes / sizeof(wchar_t);
 
-       HANDLE hFile = win32_open_file_readonly(path_utf16, false);
+       HANDLE hFile = win32_open_existing_file(path_utf16,
+                                               FILE_READ_DATA | FILE_READ_ATTRIBUTES);
        if (hFile == INVALID_HANDLE_VALUE) {
                err = GetLastError();
                ERROR("Win32 API: Failed to open \"%s\"", root_disk_path);
@@ -659,12 +771,18 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
 
        /* Get DOS name and security descriptor (if any). */
        ret = win32_get_short_name(root, path_utf16);
-       if (ret)
-               goto out_close_handle;
-       ret = win32_get_security_descriptor(root, sd_set, path_utf16);
        if (ret)
                goto out_close_handle;
 
+       if (!(add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS)) {
+               ret = win32_get_security_descriptor(root, sd_set, path_utf16);
+               if (ret)
+                       goto out_close_handle;
+       }
+
+       file_size = ((u64)file_info.nFileSizeHigh << 32) |
+                    (u64)file_info.nFileSizeLow;
+
        if (inode_is_directory(inode)) {
                /* Directory (not a reparse point) --- recurse to children */
 
@@ -673,7 +791,8 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
                ret = win32_capture_streams(path_utf16,
                                            path_utf16_nchars,
                                            inode,
-                                           lookup_table);
+                                           lookup_table,
+                                           file_size);
                if (ret)
                        goto out_close_handle;
                ret = win32_recurse_directory(root,
@@ -698,7 +817,8 @@ win32_build_dentry_tree(struct wim_dentry **root_ret,
                ret = win32_capture_streams(path_utf16,
                                            path_utf16_nchars,
                                            inode,
-                                           lookup_table);
+                                           lookup_table,
+                                           file_size);
        }
 out_close_handle:
        CloseHandle(hFile);
@@ -823,7 +943,8 @@ 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)
+                    struct wim_lookup_table_entry *lte,
+                    const struct wim_security_data *security_data)
 {
        wchar_t *stream_path;
        HANDLE h;
@@ -831,9 +952,20 @@ win32_extract_stream(const struct wim_inode *inode,
        DWORD err;
        DWORD creationDisposition = CREATE_ALWAYS;
 
+       SECURITY_ATTRIBUTES *secattr;
+
+       if (security_data && inode->i_security_id != -1) {
+               secattr = alloca(sizeof(*secattr));
+               secattr->nLength = sizeof(*secattr);
+               secattr->lpSecurityDescriptor = security_data->descriptors[inode->i_security_id];
+               secattr->bInheritHandle = FALSE;
+       } else {
+               secattr = NULL;
+       }
+
        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
@@ -847,7 +979,11 @@ win32_extract_stream(const struct wim_inode *inode,
                path_nchars = wcslen(path);
                stream_name_nchars = wcslen(stream_name_utf16);
                stream_path_nchars = path_nchars + 1 + stream_name_nchars;
-               if (path[0] != L'/' && path[0] != L'\\') {
+               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 {
@@ -865,7 +1001,7 @@ win32_extract_stream(const struct wim_inode *inode,
                 * 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)) {
+                       if (!CreateDirectoryW(stream_path, secattr)) {
                                err = GetLastError();
                                if (err != ERROR_ALREADY_EXISTS) {
                                        ERROR("Failed to create directory \"%ls\"",
@@ -886,9 +1022,9 @@ win32_extract_stream(const struct wim_inode *inode,
 
        DEBUG("Opening \"%ls\"", stream_path);
        h = CreateFileW(stream_path,
-                       GENERIC_WRITE | WRITE_OWNER | WRITE_DAC | ACCESS_SYSTEM_SECURITY,
+                       GENERIC_WRITE,
                        0,
-                       NULL,
+                       secattr,
                        creationDisposition,
                        FILE_FLAG_OPEN_REPARSE_POINT |
                            FILE_FLAG_BACKUP_SEMANTICS |
@@ -949,13 +1085,15 @@ out:
  */
 static int
 win32_extract_streams(const struct wim_inode *inode,
-                     const wchar_t *path, u64 *completed_bytes_p)
+                     const wchar_t *path, u64 *completed_bytes_p,
+                     const struct wim_security_data *security_data)
 {
        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);
+       ret = win32_extract_stream(inode, path, NULL, unnamed_lte,
+                                  security_data);
        if (ret)
                goto out;
        if (unnamed_lte)
@@ -973,7 +1111,8 @@ win32_extract_streams(const struct wim_inode *inode,
                        ret = win32_extract_stream(inode,
                                                   path,
                                                   ads_entry->stream_name,
-                                                  ads_entry->lte);
+                                                  ads_entry->lte,
+                                                  NULL);
                        if (ret)
                                break;
                        if (ads_entry->lte)
@@ -984,35 +1123,6 @@ out:
        return ret;
 }
 
-/*
- * Sets the security descriptor on an extracted file.  This is Win32-specific
- * code.
- *
- * @inode:     The WIM inode that was extracted and has a security descriptor.
- * @path:      UTF-16LE external path that the inode was extracted to.
- * @sd:                Security data for the WIM image.
- *
- * Returns 0 on success; nonzero on failure.
- */
-static int win32_set_security_data(const struct wim_inode *inode,
-                                  const wchar_t *path,
-                                  const struct wim_security_data *sd)
-{
-       SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION |
-                                                  SACL_SECURITY_INFORMATION |
-                                                  OWNER_SECURITY_INFORMATION |
-                                                  GROUP_SECURITY_INFORMATION;
-       if (!SetFileSecurityW(path, securityInformation,
-                             (PSECURITY_DESCRIPTOR)sd->descriptors[inode->i_security_id]))
-       {
-               DWORD err = GetLastError();
-               ERROR("Can't set security descriptor on \"%ls\"", path);
-               win32_error(err);
-               return WIMLIB_ERR_WRITE;
-       }
-       return 0;
-}
-
 /* Extract a file, directory, reparse point, or hard link to an
  * already-extracted file using the Win32 API */
 int win32_do_apply_dentry(const mbchar *output_path,
@@ -1047,21 +1157,18 @@ int win32_do_apply_dentry(const mbchar *output_path,
        } else {
                /* Create the file, directory, or reparse point, and extract the
                 * data streams. */
+               const struct wim_security_data *security_data;
+               if (args->extract_flags & WIMLIB_EXTRACT_FLAG_NOACLS)
+                       security_data = NULL;
+               else
+                       security_data = wim_const_security_data(args->w);
+
                ret = win32_extract_streams(inode, utf16le_path,
-                                           &args->progress.extract.completed_bytes);
+                                           &args->progress.extract.completed_bytes,
+                                           security_data);
                if (ret)
                        goto out_free_utf16_path;
 
-               /* Set security descriptor if present */
-               if (inode->i_security_id != -1) {
-                       DEBUG("Setting security descriptor %d on %s",
-                             inode->i_security_id, output_path);
-                       ret = win32_set_security_data(inode,
-                                                     utf16le_path,
-                                                     wim_const_security_data(args->w));
-                       if (ret)
-                               goto out_free_utf16_path;
-               }
                if (inode->i_nlink > 1) {
                        /* Save extracted path for a later call to
                         * CreateHardLinkW() if this inode has multiple links.
@@ -1097,13 +1204,7 @@ win32_do_apply_dentry_timestamps(const mbchar *output_path,
                return ret;
 
        DEBUG("Opening \"%s\" to set timestamps", output_path);
-       h = CreateFileW(utf16le_path,
-                       GENERIC_WRITE | WRITE_OWNER | WRITE_DAC | ACCESS_SYSTEM_SECURITY,
-                       FILE_SHARE_READ,
-                       NULL,
-                       OPEN_EXISTING,
-                       FILE_FLAG_BACKUP_SEMANTICS | FILE_FLAG_OPEN_REPARSE_POINT,
-                       NULL);
+       h = win32_open_existing_file(utf16le_path, FILE_WRITE_ATTRIBUTES);
 
        if (h == INVALID_HANDLE_VALUE)
                err = GetLastError();