win32-dir 0.3.7 → 0.4.0

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.4.0 - 29-Jun-2012
+* Conversion to FFI. Should work with JRuby now.
+* If current versions of Dir::XXX constant values cannot be found
+  then default values are tried.
+* Now requires Ruby 1.9 or later.
+
 == 0.3.7 - 18-Jul-2010
 * Modified Dir.glob and Dir[] to handle backslashes in path names.
 * Added tests for the modified Dir.glob and Dir[] behavior.

data/MANIFEST

@@ -1,8 +1,8 @@
-* README
-* MANIFEST
-* CHANGES
-* Rakefile
-* win32-dir.gemspec
-* examples/dir_example.rb
-* lib/win32/dir.rb
-* test/test_win32_dir.rb
+* README
+* MANIFEST
+* CHANGES
+* Rakefile
+* win32-dir.gemspec
+* examples/dir_example.rb
+* lib/win32/dir.rb
+* test/test_win32_dir.rb

data/README

@@ -233,16 +233,11 @@ Dir::TEMPLATES
   only instead of an actual path.
 	
 == Known Bugs
-  The Unicode support is not quite there for Dir.create_junction. It creates
-  the directory and junction fine, but the +to+ name appears to get garbled
-  with regards to the character set.
-	
-  Please log any other bug reports on the RubyForge project page at
-  http://www.rubyforge.net/projects/win32utils.
+  Please log any bug reports on the project page at
+  http://www.github.com/djberg96/win32-dir
 
 == Future Plans
-  Fix the Unicode issue with Dir.create_junction.
-  Other suggestions welcome.
+  Suggestions welcome.
 
 == Acknowledgements
   Shashank Date and Zach Dennis for the suggestion and supporting comments
@@ -258,7 +253,7 @@ Dir::TEMPLATES
   Artistic 2.0
     
 == Copyright
-  (C) 2003-2010 Daniel J. Berger, All Rights Reserved
+  (C) 2003-2012 Daniel J. Berger, All Rights Reserved
     
 == Warranty
   This package is provided "as is" and without any express or

data/Rakefile

@@ -1,9 +1,12 @@
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 
+CLEAN.include('**/*.gem', '**/*.log')
+
 namespace 'gem' do
   desc "Create the win32-dir gem"
-  task :build do
+  task :build => [:clean] do
     Dir["*.gem"].each{ |f| File.delete(f) }
     spec = eval(IO.read('win32-dir.gemspec'))
     Gem::Builder.new(spec).build
@@ -25,3 +28,5 @@ Rake::TestTask.new do |t|
   t.warning = true
   t.verbose = true
 end
+
+task :default => :test

data/examples/dir_example.rb

@@ -1,23 +1,23 @@
-####################################################################
-# dir_example.rb
-#
-# Generic test script for general futzing.  Modify as you see fit.
-# You can run this via the 'rake example' task.
-####################################################################
-require 'win32/dir'
-
-puts "Admin Tools:\t\t" + Dir::ADMINTOOLS
-puts "Common Admin Tools:\t" + Dir::COMMON_ADMINTOOLS
-puts "App Data:\t\t" + Dir::APPDATA
-puts "Common App Data:\t" + Dir::COMMON_APPDATA
-puts "Common Documents:\t" + Dir::COMMON_DOCUMENTS
-puts "Cookies:\t\t" + Dir::COOKIES
-puts "History:\t\t" + Dir::HISTORY
-puts "Internet Cache:\t\t" + Dir::INTERNET_CACHE
-puts "Local App Data:\t\t" + Dir::LOCAL_APPDATA
-puts "My Pictures:\t\t" + Dir::MYPICTURES
-puts "Personal:\t\t" + Dir::PERSONAL
-puts "Program Files:\t\t" + Dir::PROGRAM_FILES
-puts "Program Files Common:\t" + Dir::PROGRAM_FILES_COMMON
-puts "System:\t\t\t" + Dir::SYSTEM
+####################################################################
+# dir_example.rb
+#
+# Generic test script for general futzing.  Modify as you see fit.
+# You can run this via the 'rake example' task.
+####################################################################
+require 'win32/dir'
+
+puts "Admin Tools:\t\t" + Dir::ADMINTOOLS
+puts "Common Admin Tools:\t" + Dir::COMMON_ADMINTOOLS
+puts "App Data:\t\t" + Dir::APPDATA
+puts "Common App Data:\t" + Dir::COMMON_APPDATA
+puts "Common Documents:\t" + Dir::COMMON_DOCUMENTS
+puts "Cookies:\t\t" + Dir::COOKIES
+puts "History:\t\t" + Dir::HISTORY
+puts "Internet Cache:\t\t" + Dir::INTERNET_CACHE
+puts "Local App Data:\t\t" + Dir::LOCAL_APPDATA
+puts "My Pictures:\t\t" + Dir::MYPICTURES
+puts "Personal:\t\t" + Dir::PERSONAL
+puts "Program Files:\t\t" + Dir::PROGRAM_FILES
+puts "Program Files Common:\t" + Dir::PROGRAM_FILES_COMMON
+puts "System:\t\t\t" + Dir::SYSTEM
 puts "Windows:\t\t" + Dir::WINDOWS 

data/lib/win32/dir.rb

@@ -1,119 +1,188 @@
-require 'windows/directory'
-require 'windows/shell'
-require 'windows/file'
-require 'windows/error'
-require 'windows/device_io'
-require 'windows/unicode'
-require 'windows/directory'
-require 'windows/handle'
-require 'windows/path'
-require 'windows/limits'
-require 'windows/system_info'
+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')
 
 class Dir
-  include Windows::Directory
-  include Windows::Shell
-  include Windows::Error
-  include Windows::File
-  include Windows::DeviceIO
-  include Windows::Limits
-
-  extend Windows::Directory
-  extend Windows::Shell
-  extend Windows::File
-  extend Windows::Error
-  extend Windows::DeviceIO
-  extend Windows::Unicode
-  extend Windows::Handle
-  extend Windows::Path
-  extend Windows::Limits
-  extend Windows::SystemInfo
-   
+  include Dir::Structs
+  include Dir::Constants
+  extend Dir::Functions
+
+  private_class_method(
+    :SHGetFolderPathW,
+    :SHGetFolderLocation,
+    :SHGetFileInfo,
+    :PathIsDirectoryEmptyW,
+    :CloseHandle,
+    :CreateDirectoryW,
+    :CreateFileW,
+    :DeviceIoControl,
+    :GetCurrentDirectoryW,
+    :GetFileAttributesW,
+    :GetLastError,
+    :GetShortPathNameW,
+    :GetLongPathNameW,
+    :GetFullPathNameW,
+    :RemoveDirectoryW
+  )
+
   # The version of the win32-dir library.
-  VERSION = '0.3.7'
-   
-  # Dynamically set each of the CSIDL_ constants
-  constants.grep(/CSIDL/).each{ |constant|
-    path   = 0.chr * MAXPATH
-    nconst = constant.to_s.split('CSIDL_').last # to_s call for 1.9.x
-      
-    if SHGetFolderPath(0, const_get(constant), 0, 1, path) != 0
-      path = nil
-    else 
-      path.strip!
-    end
+  VERSION = '0.4.0'
+
+  # 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
+  ]
 
-    # Try another approach for virtual folders
-    if path.nil?
-      ppidl = 0.chr * 4 # PIDLIST_ABSOLUTE
+  # Dynamically set each of the CSIDL constants
+  csidl.each{ |key, value|
+    buf  = 0.chr * 1024
+    path = nil
+    buf.encode!('UTF-16LE')
 
-      if SHGetFolderLocation(0, const_get(constant), 0, 0, ppidl) == S_OK
-        info = 0.chr * 692 # sizeof(SHFILEINFO)
-        flags = SHGFI_DISPLAYNAME | SHGFI_PIDL
-        SHGetFileInfo(ppidl.unpack('L')[0], 0, info, 692, flags)
-        path = info[12..-1].strip
+    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)
+      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
+          path = info[:szDisplayName].to_s
+        end
       end
     end
 
-    Dir.const_set(nconst, path) if path
+    Dir.const_set(key, path) if path
   }
 
   # Set Dir::MYDOCUMENTS to the same as Dir::PERSONAL if undefined
   unless defined? MYDOCUMENTS
-    # Same as Dir::PERSONAL
     MYDOCUMENTS = PERSONAL
   end
-   
+
   class << self
-    remove_method :getwd
-    remove_method :pwd
-    alias :old_glob :glob
-    alias :old_ref :[]
-    remove_method :glob
-    remove_method :[]
-  end
+    alias old_glob glob
 
-  # Same as the standard MRI Dir.glob method except that it handles
-  # backslashes in path names.
-  #
-  def self.glob(glob_pattern, flags = 0, &block)
-    glob_pattern = glob_pattern.tr("\\", "/") 
-    old_glob(glob_pattern, flags, &block)
-  end
+    # Same as the standard MRI Dir.glob method except that it handles
+    # backslashes in path names.
+    #
+    def glob(glob_pattern, flags = 0, &block)
+      glob_pattern = glob_pattern.tr("\\", "/")
+      old_glob(glob_pattern, flags, &block)
+    end
 
-  # Same as the standard MRI Dir[] method except that it handles
-  # backslashes in path names.
-  #
-  def self.[](glob_pattern)
-    glob_pattern = glob_pattern.tr("\\", "/") 
-    old_ref(glob_pattern)
-  end
-   
-  # Returns the present working directory. Unlike MRI, this method always
-  # normalizes the path.
-  #
-  # Examples:
-  #
-  #    Dir.chdir("C:/Progra~1")
-  #    Dir.getwd # => C:\Program Files
-  #
-  #    Dir.chdir("C:/PROGRAM FILES")
-  #    Dir.getwd # => C:\Program Files
-  #
-  def self.getwd
-    path1 = 0.chr * MAXPATH
-    path2 = 0.chr * MAXPATH
-    path3 = 0.chr * MAXPATH
+    alias old_ref []
 
-    GetCurrentDirectory(MAXPATH, path1)
-    GetShortPathName(path1, path2, MAXPATH)
-    GetLongPathName(path2, path3, MAXPATH)
+    # Same as the standard MRI Dir[] method except that it handles
+    # backslashes in path names.
+    #
+    def [](glob_pattern)
+      glob_pattern = glob_pattern.tr("\\", "/")
+      old_ref(glob_pattern)
+    end
 
-    path3[/^[^\0]*/]
-  end
-   
-  class << self
-    alias :pwd :getwd
+    # JRuby normalizes the path by default.
+    unless RUBY_PLATFORM == 'java'
+      alias oldgetwd getwd
+      alias oldpwd pwd
+
+      # Returns the present working directory. Unlike MRI, this method always
+      # normalizes the path.
+      #
+      # Examples:
+      #
+      #    Dir.chdir("C:/Progra~1")
+      #    Dir.getwd # => C:\Program Files
+      #
+      #    Dir.chdir("C:/PROGRAM FILES")
+      #    Dir.getwd # => C:\Program Files
+      #
+      def getwd
+        path1 = 0.chr * 1024
+        path2 = 0.chr * 1024
+        path3 = 0.chr * 1024
+
+        path1.encode!('UTF-16LE')
+
+        if GetCurrentDirectoryW(path1.size, path1) == 0
+          raise SystemCallError, FFI.errno, "GetCurrentDirectoryW"
+        end
+
+        path2.encode!('UTF-16LE')
+
+        if GetShortPathNameW(path1, path2, path2.size) == 0
+          raise SystemCallError, FFi.errno, "GetShortPathNameW"
+        end
+
+        path3.encode!('UTF-16LE')
+
+        if GetLongPathNameW(path2, path3, path3.size) == 0
+          raise SystemCallError, FFI.errno, "GetLongPathNameW"
+        end
+
+        path3.strip.encode(Encoding.default_external)
+      end
+
+      alias :pwd :getwd
+    end
   end
 
   # Creates the symlink +to+, linked to the existing directory +from+. If the
@@ -123,121 +192,140 @@ class Dir
   #
   #    Dir.mkdir('C:/from')
   #    Dir.create_junction('C:/to', 'C:/from')
-  # 
+  #
   def self.create_junction(to, from)
-    to   = to.tr(File::SEPARATOR, File::ALT_SEPARATOR)   # Normalize path
-    from = from.tr(File::SEPARATOR, File::ALT_SEPARATOR) # Normalize path
-      
-    to_path    = 0.chr * MAXPATH
-    from_path  = 0.chr * MAXPATH
-    buf_target = 0.chr * MAXPATH
-      
-    length = GetFullPathName(from, from_path.size, from_path, 0)
+    to   = to.tr(File::SEPARATOR, File::ALT_SEPARATOR) + "\0"   # Normalize path
+    from = from.tr(File::SEPARATOR, File::ALT_SEPARATOR) + "\0" # Normalize path
+
+    to.encode!('UTF-16LE')
+    from.encode!('UTF-16LE')
+
+    from_path = 0.chr * 1024
+    from_path.encode!('UTF-16LE')
+
+    length = GetFullPathNameW(from, from_path.size, from_path, nil)
 
     if length == 0
-      raise StandardError, 'GetFullPathName() failed: ' + get_last_error
+      raise SystemCallError, FFI.errno, "GetFullPathNameW"
     else
-      from_path = from_path[0..length-1]
+      from_path.strip!
     end
-      
-    length = GetFullPathName(to, to_path.size, to_path, 0)
+
+    to_path = 0.chr * 1024
+    to.encode!('UTF-16LE')
+    to_path.encode!('UTF-16LE')
+
+    length = GetFullPathNameW(to, to_path.size, to_path, nil)
 
     if length == 0
-      raise StandardError, 'GetFullPathName() failed: ' + get_last_error
+      raise SystemCallError, FFI.errno, "GetFullPathNameW"
     else
-      to_path = to_path[0..length-1]
+      to_path.strip!
     end
 
     # You can create a junction to a directory that already exists, so
     # long as it's empty.
-    rv = CreateDirectory(to_path, 0)
-
-    if rv == 0 && rv != ERROR_ALREADY_EXISTS
-      raise StandardError, 'CreateDirectory() failed: ' + get_last_error
+    unless CreateDirectoryW(to_path, nil)
+      if FFI.errno != ERROR_ALREADY_EXISTS
+        raise SystemCallError, FFI.errno, "CreateDirectoryW"
+      end
     end
-      
-    handle = CreateFile(
-      to_path,
-      GENERIC_READ | GENERIC_WRITE, 
-      0,
-      0,
-      OPEN_EXISTING, 
-      FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
-      0
-    )
-      
-    if handle == INVALID_HANDLE_VALUE
-      raise StandardError, 'CreateFile() failed: ' + get_last_error
-    end 
-      
-    buf_target  = buf_target.split(0.chr).first
-    buf_target  = "\\??\\" << from_path
-    wide_string = multi_to_wide(buf_target)[0..-3]
-      
-    # REPARSE_JDATA_BUFFER
-    rdb = [
-      "0xA0000003L".hex,      # ReparseTag (IO_REPARSE_TAG_MOUNT_POINT)
-      wide_string.size + 12,  # ReparseDataLength
-      0,                      # Reserved
-      0,                      # SubstituteNameOffset
-      wide_string.size,       # SubstituteNameLength
-      wide_string.size + 2,   # PrintNameOffset
-      0,                      # PrintNameLength
-      wide_string             # PathBuffer
-    ].pack('LSSSSSSa' + (wide_string.size + 4).to_s)
-
-    bytes = [0].pack('L')
 
     begin
-      bool = DeviceIoControl(
-        handle,
-        CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, 0),
-        rdb,
-        rdb.size,
+      # Generic read & write + open existing + reparse point & backup semantics
+      handle = CreateFileW(
+        to_path,
+        GENERIC_READ | GENERIC_WRITE,
         0,
-        0,
-        bytes,
+        nil,
+        OPEN_EXISTING,
+        FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
         0
       )
-         
-      unless bool
-        error = 'DeviceIoControl() failed: ' + get_last_error
-        RemoveDirectory(to_path)
-        raise error
+
+      if handle == INVALID_HANDLE_VALUE
+        raise SystemCallError, FFI.errno, "CreateFileW"
+      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
+        bool = DeviceIoControl(
+          handle,
+          CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, 0),
+          rdb,
+          rdb[:ReparseDataLength] + 8,
+          nil,
+          0,
+          bytes,
+          nil
+        )
+
+        error = FFI.errno
+
+        unless bool
+          RemoveDirectoryW(to_path)
+          raise SystemCallError, error, "DeviceIoControl"
+        end
+      ensure
+        CloseHandle(handle)
       end
-    ensure
-      CloseHandle(handle)
     end
-      
-    self  
+
+    self
   end
-   
+
   # Returns whether or not +path+ is empty.  Returns false if +path+ is not
   # a directory, or contains any files other than '.' or '..'.
-  # 
+  #
   def self.empty?(path)
-    PathIsDirectoryEmpty(path)
+    path = path + "\0"
+    path = path.encode('UTF-16LE')
+    PathIsDirectoryEmptyW(path)
   end
-   
+
   # Returns whether or not +path+ is a junction.
-  # 
+  #
   def self.junction?(path)
-    bool   = true
-    attrib = GetFileAttributes(path)
-      
+    bool = true
+    path = path + "\0"
+    path.encode!('UTF-16LE')
+
+    attrib = GetFileAttributesW(path)
+
+    # 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
-       bool = false
+      bool = false
     end
-      
+
     bool
-  end 
-   
+  end
+
   # Class level aliases
   #
   class << self
     alias reparse_dir? junction?
   end
+
+  private
+
+  # 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)
+  end
 end