win32-dir 0.4.7 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e5e981af6ec776b828331968e333f10e07a00da1
-  data.tar.gz: 6d4998906fc38e42b166b4f169bcd3e209e8fe50
+SHA256:
+  metadata.gz: 2a8115d4e340523af631d3637a12c7e69836ebf25557b68d7ff6cbe57c04af7b
+  data.tar.gz: 68d05c5b0298b4deaeba910386066a2f92fbff050606b3b3af8e27c6a09d786c
 SHA512:
-  metadata.gz: 3f6d943d7546b4b5a6df5507bf06e2dca571fe4f708eac4cf6f483f24cb20e304f3ab5cbbfb075d98cce0112e6e676069f0551d555f7e37ac78f536f2a5b45a9
-  data.tar.gz: cb65e88ec9fa7d671c4a2744ed4f7e0cb80405d88f63a22a15411b33b04bbfef00adf37fa24a3120f1f274569e92fd06bcadb465ddefc63f591a541c5b9f44db
+  metadata.gz: 1a61c6fc6ce9259d40d1922a095b760578da70a31e526aee950e91eef74db83b7ee0c3c1716b50574fd251f462c2fa36aa2dd1233d1bc0e5234972a230e07381
+  data.tar.gz: 6007e11c210cc84bed879c0d025f4c94238da5dc96bcf28dadd1a3cae908a48e8eb01823a2943e15bd701e793a9e48402bd5546239b24dab381f147e8eca7fe2

data/lib/win32-dir.rb

@@ -0,0 +1 @@
+require_relative "win32/dir"

data/lib/win32/dir.rb

@@ -1,92 +1,96 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'dir', 'constants')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'dir', 'functions')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'dir', 'structs')
+require_relative "dir/constants"
+require_relative "dir/functions"
+require_relative "dir/structs"
 
 class Dir
   include Dir::Structs
   include Dir::Constants
   extend Dir::Functions
 
-  # The version of the win32-dir library.
-  VERSION = '0.4.7'
-
   # CSIDL constants
   csidl = Hash[
-    'DESKTOP',                  0x0000,
-    'INTERNET',                 0x0001,
-    'PROGRAMS',                 0x0002,
-    'CONTROLS',                 0x0003,
-    'PRINTERS',                 0x0004,
-    'PERSONAL',                 0x0005,
-    'FAVORITES',                0x0006,
-    'STARTUP',                  0x0007,
-    'RECENT',                   0x0008,
-    'SENDTO',                   0x0009,
-    'BITBUCKET',                0x000a,
-    'STARTMENU',                0x000b,
-    'MYDOCUMENTS',              0x000c,
-    'MYMUSIC',                  0x000d,
-    'MYVIDEO',                  0x000e,
-    'DESKTOPDIRECTORY',         0x0010,
-    'DRIVES',                   0x0011,
-    'NETWORK',                  0x0012,
-    'NETHOOD',                  0x0013,
-    'FONTS',                    0x0014,
-    'TEMPLATES',                0x0015,
-    'COMMON_STARTMENU',         0x0016,
-    'COMMON_PROGRAMS',          0X0017,
-    'COMMON_STARTUP',           0x0018,
-    'COMMON_FAVORITES',         0x001f,
-    'COMMON_DESKTOPDIRECTORY',  0x0019,
-    'APPDATA',                  0x001a,
-    'PRINTHOOD',                0x001b,
-    'LOCAL_APPDATA',            0x001c,
-    'ALTSTARTUP',               0x001d,
-    'COMMON_ALTSTARTUP',        0x001e,
-    'INTERNET_CACHE',           0x0020,
-    'COOKIES',                  0x0021,
-    'HISTORY',                  0x0022,
-    'COMMON_APPDATA',           0x0023,
-    'WINDOWS',                  0x0024,
-    'SYSTEM',                   0x0025,
-    'PROGRAM_FILES',            0x0026,
-    'MYPICTURES',               0x0027,
-    'PROFILE',                  0x0028,
-    'SYSTEMX86',                0x0029,
-    'PROGRAM_FILESX86',         0x002a,
-    'PROGRAM_FILES_COMMON',     0x002b,
-    'PROGRAM_FILES_COMMONX86',  0x002c,
-    'COMMON_TEMPLATES',         0x002d,
-    'COMMON_DOCUMENTS',         0x002e,
-    'CONNECTIONS',              0x0031,
-    'COMMON_MUSIC',             0x0035,
-    'COMMON_PICTURES',          0x0036,
-    'COMMON_VIDEO',             0x0037,
-    'RESOURCES',                0x0038,
-    'RESOURCES_LOCALIZED',      0x0039,
-    'COMMON_OEM_LINKS',         0x003a,
-    'CDBURN_AREA',              0x003b,
-    'COMMON_ADMINTOOLS',        0x002f,
-    'ADMINTOOLS',               0x0030
+    "DESKTOP",                  0x0000,
+    "INTERNET",                 0x0001,
+    "PROGRAMS",                 0x0002,
+    "CONTROLS",                 0x0003,
+    "PRINTERS",                 0x0004,
+    "PERSONAL",                 0x0005,
+    "FAVORITES",                0x0006,
+    "STARTUP",                  0x0007,
+    "RECENT",                   0x0008,
+    "SENDTO",                   0x0009,
+    "BITBUCKET",                0x000a,
+    "STARTMENU",                0x000b,
+    "MYDOCUMENTS",              0x000c,
+    "MYMUSIC",                  0x000d,
+    "MYVIDEO",                  0x000e,
+    "DESKTOPDIRECTORY",         0x0010,
+    "DRIVES",                   0x0011,
+    "NETWORK",                  0x0012,
+    "NETHOOD",                  0x0013,
+    "FONTS",                    0x0014,
+    "TEMPLATES",                0x0015,
+    "COMMON_STARTMENU",         0x0016,
+    "COMMON_PROGRAMS",          0X0017,
+    "COMMON_STARTUP",           0x0018,
+    "COMMON_FAVORITES",         0x001f,
+    "COMMON_DESKTOPDIRECTORY",  0x0019,
+    "APPDATA",                  0x001a,
+    "PRINTHOOD",                0x001b,
+    "LOCAL_APPDATA",            0x001c,
+    "ALTSTARTUP",               0x001d,
+    "COMMON_ALTSTARTUP",        0x001e,
+    "INTERNET_CACHE",           0x0020,
+    "COOKIES",                  0x0021,
+    "HISTORY",                  0x0022,
+    "COMMON_APPDATA",           0x0023,
+    "WINDOWS",                  0x0024,
+    "SYSTEM",                   0x0025,
+    "PROGRAM_FILES",            0x0026,
+    "MYPICTURES",               0x0027,
+    "PROFILE",                  0x0028,
+    "SYSTEMX86",                0x0029,
+    "PROGRAM_FILESX86",         0x002a,
+    "PROGRAM_FILES_COMMON",     0x002b,
+    "PROGRAM_FILES_COMMONX86",  0x002c,
+    "COMMON_TEMPLATES",         0x002d,
+    "COMMON_DOCUMENTS",         0x002e,
+    "CONNECTIONS",              0x0031,
+    "COMMON_MUSIC",             0x0035,
+    "COMMON_PICTURES",          0x0036,
+    "COMMON_VIDEO",             0x0037,
+    "RESOURCES",                0x0038,
+    "RESOURCES_LOCALIZED",      0x0039,
+    "COMMON_OEM_LINKS",         0x003a,
+    "CDBURN_AREA",              0x003b,
+    "COMMON_ADMINTOOLS",        0x002f,
+    "ADMINTOOLS",               0x0030
   ]
 
   # Dynamically set each of the CSIDL constants
-  csidl.each{ |key, value|
+  csidl.each do |key, value|
     buf  = 0.chr * 1024
     path = nil
-    buf.encode!('UTF-16LE')
+    buf.encode!("UTF-16LE")
 
     if SHGetFolderPathW(0, value, 0, 0, buf) == 0 # Current path
       path = buf.strip
     elsif SHGetFolderPathW(0, value, 0, 1, buf) == 0 # Default path
       path = buf.strip
     else
-      ptr   = FFI::MemoryPointer.new(:long)
+      ptr   = FFI::MemoryPointer.new(:uint64)
       info  = SHFILEINFO.new
       flags = SHGFI_DISPLAYNAME | SHGFI_PIDL
 
       if SHGetFolderLocation(0, value, 0, 0, ptr) == 0
-        if SHGetFileInfo(ptr.read_long, 0, info, info.size, flags) != 0
+        # Use read_array_of_uint64 for compatibility with JRuby if necessary.
+        if ptr.respond_to?(:read_uint64)
+          res = SHGetFileInfo(ptr.read_uint64, 0, info, info.size, flags)
+        else
+          res = SHGetFileInfo(ptr.read_array_of_uint64(1).first, 0, info, info.size, flags)
+        end
+
+        if res != 0
           path = info[:szDisplayName].to_s
           path.force_encoding(Encoding.default_external)
         end
@@ -96,9 +100,9 @@ class Dir
     begin
       Dir.const_set(key, path.encode(Encoding.default_external)) if path
     rescue Encoding::UndefinedConversionError
-      Dir.const_set(key, path.encode('UTF-8')) if path
+      Dir.const_set(key, path.encode("UTF-8")) if path
     end
-  }
+  end
 
   # Set Dir::MYDOCUMENTS to the same as Dir::PERSONAL if undefined
   unless defined? MYDOCUMENTS
@@ -113,9 +117,9 @@ class Dir
     #
     def glob(glob_pattern, flags = 0, &block)
       if glob_pattern.is_a?(Array)
-        temp = glob_pattern.map!{ |pattern| "#{pattern}".tr("\\", "/") }
+        temp = glob_pattern.map! { |pattern| string_check(pattern).tr("\\", "/") }
       else
-        temp = "#{glob_pattern}".tr("\\", "/")
+        temp = string_check(glob_pattern).tr("\\", "/")
       end
 
       old_glob(temp, flags, &block)
@@ -127,12 +131,12 @@ class Dir
     # backslashes in path names.
     #
     def [](*glob_patterns)
-      temp = glob_patterns.map!{ |pattern| "#{pattern}".tr("\\", "/") }
+      temp = glob_patterns.map! { |pattern| "#{pattern}".tr("\\", "/") }
       old_ref(*temp)
     end
 
     # JRuby normalizes the path by default.
-    unless RUBY_PLATFORM == 'java'
+    unless RUBY_PLATFORM == "java"
       alias oldgetwd getwd
       alias oldpwd pwd
 
@@ -175,7 +179,7 @@ class Dir
         begin
           path.encode(Encoding.default_external)
         rescue Encoding::UndefinedConversionError
-          path.encode('UTF-8')
+          path.encode("UTF-8")
         end
       end
 
@@ -192,10 +196,10 @@ class Dir
   #    Dir.create_junction('C:/to', 'C:/from')
   #
   def self.create_junction(to, from)
-    to   = "#{to}".wincode
-    from = "#{from}".wincode
+    to   = string_check(to).wincode
+    from = string_check(from).wincode
 
-    from_path = (0.chr * 1024).encode('UTF-16LE')
+    from_path = (0.chr * 1024).encode("UTF-16LE")
 
     length = GetFullPathNameW(from, from_path.size, from_path, nil)
 
@@ -205,7 +209,7 @@ class Dir
       from_path.strip!
     end
 
-    to_path = (0.chr * 1024).encode('UTF-16LE')
+    to_path = (0.chr * 1024).encode("UTF-16LE")
 
     length = GetFullPathNameW(to, to_path.size, to_path, nil)
 
@@ -223,57 +227,55 @@ class Dir
       end
     end
 
+    # Generic read & write + open existing + reparse point & backup semantics
+    handle = CreateFileW(
+      to_path,
+      GENERIC_READ | GENERIC_WRITE,
+      0,
+      nil,
+      OPEN_EXISTING,
+      FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
+      0
+    )
+
+    if handle == INVALID_HANDLE_VALUE
+      raise SystemCallError.new("CreateFileW", FFI.errno)
+    end
+
+    target = "\\??\\".encode("UTF-16LE") + from_path
+
+    rdb = REPARSE_JDATA_BUFFER.new
+    rdb[:ReparseTag] = 2684354563 # IO_REPARSE_TAG_MOUNT_POINT
+    rdb[:ReparseDataLength] = target.bytesize + 12
+    rdb[:Reserved] = 0
+    rdb[:SubstituteNameOffset] = 0
+    rdb[:SubstituteNameLength] = target.bytesize
+    rdb[:PrintNameOffset] = target.bytesize + 2
+    rdb[:PrintNameLength] = 0
+    rdb[:PathBuffer] = target
+
+    bytes = FFI::MemoryPointer.new(:ulong)
+
     begin
-      # Generic read & write + open existing + reparse point & backup semantics
-      handle = CreateFileW(
-        to_path,
-        GENERIC_READ | GENERIC_WRITE,
-        0,
+      bool = DeviceIoControl(
+        handle,
+        CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, 0),
+        rdb,
+        rdb[:ReparseDataLength] + rdb.header_size,
         nil,
-        OPEN_EXISTING,
-        FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
-        0
+        0,
+        bytes,
+        nil
       )
 
-      if handle == INVALID_HANDLE_VALUE
-        raise SystemCallError.new("CreateFileW", FFI.errno)
-      end
+      error = FFI.errno
 
-      target = "\\??\\".encode('UTF-16LE') + from_path
-
-      rdb = REPARSE_JDATA_BUFFER.new
-      rdb[:ReparseTag] = 2684354563 # IO_REPARSE_TAG_MOUNT_POINT
-      rdb[:ReparseDataLength] = target.bytesize + 12
-      rdb[:Reserved] = 0
-      rdb[:SubstituteNameOffset] = 0
-      rdb[:SubstituteNameLength] = target.bytesize
-      rdb[:PrintNameOffset] = target.bytesize + 2
-      rdb[:PrintNameLength] = 0
-      rdb[:PathBuffer] = target
-
-      bytes = FFI::MemoryPointer.new(:ulong)
-
-      begin
-        bool = DeviceIoControl(
-          handle,
-          CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, 0),
-          rdb,
-          rdb[:ReparseDataLength] + rdb.header_size,
-          nil,
-          0,
-          bytes,
-          nil
-        )
-
-        error = FFI.errno
-
-        unless bool
-          RemoveDirectoryW(to_path)
-          raise SystemCallError.new("DeviceIoControl", error)
-        end
-      ensure
-        CloseHandle(handle)
+      unless bool
+        RemoveDirectoryW(to_path)
+        raise SystemCallError.new("DeviceIoControl", error)
       end
+    ensure
+      CloseHandle(handle)
     end
 
     self
@@ -290,11 +292,11 @@ class Dir
   #    Dir.read_junction("c:/to") # => "c:/from"
   #
   def self.read_junction(junction)
-    return false unless Dir.junction?("#{junction}")
+    return false unless Dir.junction?(junction)
 
-    junction = "#{junction}".wincode
+    junction = string_check(junction).wincode
 
-    junction_path = (0.chr * 1024).encode('UTF-16LE')
+    junction_path = (0.chr * 1024).encode("UTF-16LE")
 
     length = GetFullPathNameW(junction, junction_path.size, junction_path, nil)
 
@@ -304,65 +306,64 @@ class Dir
       junction_path.strip!
     end
 
+    # Generic read & write + open existing + reparse point & backup semantics
+    handle = CreateFileW(
+      junction_path,
+      GENERIC_READ | GENERIC_WRITE,
+      0,
+      nil,
+      OPEN_EXISTING,
+      FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
+      0
+    )
+
+    if handle == INVALID_HANDLE_VALUE
+      raise SystemCallError.new("CreateFileW", FFI.errno)
+    end
+
+    rdb = REPARSE_JDATA_BUFFER.new
+    rdb[:ReparseTag] = 0
+    rdb[:ReparseDataLength] = 0
+    rdb[:Reserved] = 0
+    rdb[:SubstituteNameOffset] = 0
+    rdb[:SubstituteNameLength] = 0
+    rdb[:PrintNameOffset] = 0
+    rdb[:PrintNameLength] = 0
+    rdb[:PathBuffer] = ""
+
+    bytes = FFI::MemoryPointer.new(:ulong)
+
     begin
-      # Generic read & write + open existing + reparse point & backup semantics
-      handle = CreateFileW(
-        junction_path,
-        GENERIC_READ | GENERIC_WRITE,
-        0,
+      bool = DeviceIoControl(
+        handle,
+        CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, 0),
         nil,
-        OPEN_EXISTING,
-        FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
-        0
+        0,
+        rdb,
+        1024,
+        bytes,
+        nil
       )
 
-      if handle == INVALID_HANDLE_VALUE
-        raise SystemCallError.new("CreateFileW", FFI.errno)
-      end
+      error = FFI.errno
 
-      rdb = REPARSE_JDATA_BUFFER.new
-      rdb[:ReparseTag] = 0
-      rdb[:ReparseDataLength] = 0
-      rdb[:Reserved] = 0
-      rdb[:SubstituteNameOffset] = 0
-      rdb[:SubstituteNameLength] = 0
-      rdb[:PrintNameOffset] = 0
-      rdb[:PrintNameLength] = 0
-      rdb[:PathBuffer] = ''
-
-      bytes = FFI::MemoryPointer.new(:ulong)
-
-      begin
-        bool = DeviceIoControl(
-          handle,
-          CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, 0),
-          nil,
-          0,
-          rdb,
-          1024,
-          bytes,
-          nil
-        )
-
-        error = FFI.errno
-
-        unless bool
-          raise SystemCallError.new("DeviceIoControl", error)
-        end
-      ensure
-        CloseHandle(handle)
+      unless bool
+        raise SystemCallError.new("DeviceIoControl", error)
       end
+    ensure
+      CloseHandle(handle)
     end
 
     # MSDN says print and substitute names can be in any order
     jname = (rdb[:PathBuffer].to_ptr + rdb[:SubstituteNameOffset]).read_string(rdb[:SubstituteNameLength])
-    jname = jname.bytes.to_a.pack('C*')
+    jname = jname.bytes.to_a.pack("C*")
     jname = jname.force_encoding("UTF-16LE")
-    raise "Junction name came back as #{jname}" unless jname[0..3] == "\\??\\".encode("UTF-16LE")
+    raise "Invalid junction name: #{jname.encode("UTF-8")}" unless jname[0..3] == "\\??\\".encode("UTF-16LE")
+
     begin
       File.expand_path(jname[4..-1].encode(Encoding.default_external))
     rescue Encoding::UndefinedConversionError
-      File.expand_path(jname[4..-1].encode('UTF-8'))
+      File.expand_path(jname[4..-1].encode("UTF-8"))
     end
   end
 
@@ -376,15 +377,15 @@ class Dir
   # Returns whether or not +path+ is a junction.
   #
   def self.junction?(path)
+    string_check(path)
     bool = true
 
     attrib = GetFileAttributesW("#{path}".wincode)
 
     # Only directories with a reparse point attribute can be junctions
     if attrib == INVALID_FILE_ATTRIBUTES ||
-       attrib & FILE_ATTRIBUTE_DIRECTORY == 0 ||
-       attrib & FILE_ATTRIBUTE_REPARSE_POINT == 0
-    then
+        attrib & FILE_ATTRIBUTE_DIRECTORY == 0 ||
+        attrib & FILE_ATTRIBUTE_REPARSE_POINT == 0
       bool = false
     end
 
@@ -399,6 +400,17 @@ class Dir
 
   private
 
+  class << self
+    # Simulate MRI's contortions for a stringiness check.
+    def string_check(arg)
+      return arg if arg.is_a?(String)
+      return arg.send(:to_str) if arg.respond_to?(:to_str, true) # MRI honors it, even if private
+      return arg.to_path if arg.respond_to?(:to_path)
+
+      raise TypeError
+    end
+  end
+
   # Macro from Windows header file, used by the create_junction method.
   def self.CTL_CODE(device, function, method, access)
     ((device) << 16) | ((access) << 14) | ((function) << 2) | (method)