]> wimlib.net Git - wimlib/blobdiff - src/win32.c
Win32: Fix, comment capture reparse-point fixups
[wimlib] / src / win32.c
index 4a9e8becec2a762876765834e0d8dc9d4655002e..643832fbdc61dfb151286c1d3d268325afcf44a0 100644 (file)
@@ -46,6 +46,7 @@
 
 #define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1
 #define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1
+#define MAX_CREATE_HARD_LINK_WARNINGS 5
 struct win32_capture_state {
        unsigned long num_get_sd_access_denied;
        unsigned long num_get_sacl_priv_notheld;
@@ -393,22 +394,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
@@ -608,14 +618,47 @@ 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)
@@ -625,11 +668,12 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        wchar_t *orig_target;
 
        if (target_nchars == 0)
+               /* Invalid reparse point (empty target) */
                return RP_NOT_FIXED;
 
        if (target[0] == L'\\') {
                if (target_nchars >= 2 && target[1] == L'\\') {
-                       /* Probaby a volume.  Can't do anything with it. */
+                       /* Probably a volume.  Can't do anything with it. */
                        DEBUG("Not fixing target (probably a volume)");
                        return RP_NOT_FIXED;
                } else if (target_nchars >= 7 &&
@@ -643,7 +687,7 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
                        DEBUG("Full style path");
                        /* Full \??\x:\ style path (may be junction or symlink)
                         * */
-                       stripped_chars = 4;
+                       stripped_chars = 6;
                } else {
                        DEBUG("Absolute target without drive letter");
                        /* Absolute target, without drive letter */
@@ -656,7 +700,7 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        {
                DEBUG("Absolute target with drive letter");
                /* Absolute target, with drive letter */
-               stripped_chars = 0;
+               stripped_chars = 2;
        } else {
                DEBUG("Relative symlink or other link");
                /* Relative symlink or other unexpected format */
@@ -665,15 +709,17 @@ win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
        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 {
+       if (!target)
                return RP_EXCLUDED;
-       }
+
+       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);
+       if (stripped_chars == 6)
+               return RP_FIXED_FULLPATH;
+       else
+               return RP_FIXED_ABSPATH;
 }
 
 static enum rp_status
@@ -690,21 +736,22 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
        u32 rptag;
        DWORD rpbuflen = *rpbuflen_p;
 
-       if (rpbuflen < 16)
-               return RP_EXCLUDED;
+       if (rpbuflen < 16) /* Invalid reparse point (length too small) */
+               return RP_NOT_FIXED;
        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;
+               if (rpbuflen < 20) /* Invalid reparse point (length too small) */
+                       return RP_NOT_FIXED;
                p_get += 4;
        }
-
+       if ((DWORD)substitute_name_offset +
+           substitute_name_len + (p_get - rpbuf) > rpbuflen)
+               /* Invalid reparse point (length too small) */
+               return RP_NOT_FIXED;
 
        target = (wchar_t*)&p_get[substitute_name_offset];
        target_nchars = substitute_name_len / 2;
@@ -719,6 +766,9 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
                wchar_t *print_name = target_copy;
 
                if (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. */
                        print_nbytes -= 8;
                        print_name += 4;
                }
@@ -734,6 +784,9 @@ win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
                p_put = put_u16(p_put, 0);
                p_put = put_bytes(p_put, print_nbytes, print_name);
                p_put = put_u16(p_put, 0);
+
+               /* Wrote the end of the reparse data.  Recalculate the length,
+                * set the length field correctly, and return it. */
                rpbuflen = p_put - rpbuf;
                put_u16(rpbuf + 4, rpbuflen - 8);
                *rpbuflen_p = rpbuflen;
@@ -789,16 +842,20 @@ win32_capture_reparse_point(struct wim_dentry **root_p,
            (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
             inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
        {
+               /* Try doing reparse point fixup */
                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) {
+                       /* Absolute path points out of capture tree.  Free the
+                        * dentry; we're not including it at all. */
                        free_dentry(*root_p);
                        *root_p = NULL;
                        return 0;
                } else if (status & RP_FIXED) {
+                       /* Absolute path fixup was done. */
                        inode->i_not_rpfixed = 0;
                }
        }
@@ -875,6 +932,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
@@ -1057,6 +1120,7 @@ win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
        DWORD err;
        u64 file_size;
        int ret = 0;
+       const wchar_t *basename;
 
        if (exclude_path(path, path_num_chars, params->config, true)) {
                if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
@@ -1104,15 +1168,31 @@ 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 */
-       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,
-                                    file_info.dwVolumeSerialNumber,
-                                    &root);
-       if (ret)
-               goto out_close_handle;
+       /* 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. */
+       basename = path_basename_with_len(path, path_num_chars);
+       if (!(file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
+           && file_info.nNumberOfLinks > 1)
+       {
+               ret = inode_table_new_dentry(params->inode_table,
+                                            basename,
+                                            ((u64)file_info.nFileIndexHigh << 32) |
+                                                (u64)file_info.nFileIndexLow,
+                                            file_info.dwVolumeSerialNumber,
+                                            &root);
+               if (ret)
+                       goto out_close_handle;
+       } else {
+               ret = new_dentry_with_inode(basename, &root);
+               if (ret)
+                       goto out_close_handle;
+               list_add_tail(&root->d_inode->i_list, &params->inode_table->extra_inodes);
+       }
+
 
        ret = win32_get_short_name(root, path);
        if (ret)
@@ -1858,10 +1938,15 @@ win32_do_apply_dentry(const wchar_t *output_path,
                        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);
+                       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);
+                       } else if (args->num_hard_links_failed == MAX_CREATE_HARD_LINK_WARNINGS) {
+                               WARNING("Suppressing further hard linking warnings...");
+                       }
                }
        }