win32-file-stat 1.3.2 → 1.3.3

data/CHANGES

@@ -1,3 +1,10 @@
+== 1.3.3 - 9-Feb-2009
+* Fixed a bug where File::Stat.new failed on locked files. Thanks go to
+  Montgomery Kosma for the spot.
+* Now requires windows-pr 1.0.0 or later.
+* Updated the README to note that 32 bit versions of Ruby which attempt
+  to access locked system files on 64 bit versions of MS Windows will fail.
+
 == 1.3.2 - 1-Oct-2008
 * Fixed an issue with the private get_blksize method.
 * Updated the test suite to use Test::Unit 2.x, which also makes it a

data/README

@@ -6,6 +6,10 @@ A redefinition of the File::Stat class for MS Windows.
 * windows-pr 0.9.1 or later.
 
 = Installation
+== Remote Installation
+gem install win32-file-stat
+
+== Local Installation
 rake install (non-gem) OR rake install_gem (gems)
 
 = Synopsis
@@ -47,6 +51,9 @@ Failure to follow these instructions could lead to cases where the core Ruby
 File class attempts to use the custom File::Stat object defined in this class,
 and that will likely cause problems.
 
+Also, a 32 bit Ruby attempting to access a locked system file on a 64 bit
+version of MS Windows will fail.
+
 = Known bugs
 None that I'm aware of beyond the Known Issues listed above. Please report any
 bugs you find on the project page at:

data/Rakefile

@@ -3,19 +3,15 @@ require 'rake/testtask'
 require 'rbconfig'
 include Config
 
-desc 'Install the win32-file-stat package (non-gem)'
+desc 'Install the win32-file-stat library (non-gem)'
 task :install do
-   sitelibdir = CONFIG['sitelibdir']
-   installdir = sitelibdir + '/win32/file'
-   basedir = File.dirname(installdir)
+   install_dir = File.join(CONFIG['sitelibdir'], 'win32', 'file')
    file = 'lib\win32\file\stat.rb'
-   
-   Dir.mkdir(basedir) unless File.exists?(basedir)
-   Dir.mkdir(installdir) unless File.exists?(installdir)
-   FileUtils.cp(file, installdir, :verbose => true)
+   FileUtils.mkdir_p(install_dir)
+   FileUtils.cp(file, install_dir, :verbose => true)
 end
 
-desc 'Install the win32-file-stat package as a gem'
+desc 'Install the win32-file-stat library as a gem'
 task :install_gem do
    ruby 'win32-file-stat.gemspec'
    file = Dir["win32-file-stat*.gem"].first

data/lib/win32/file/stat.rb

@@ -7,6 +7,10 @@ require 'windows/file'
 require 'windows/error'
 require 'windows/handle'
 require 'windows/volume'
+require 'windows/process'
+require 'windows/security'
+require 'windows/time'
+require 'windows/ntfs/winternl'
 require 'pp'
 
 class File::Stat
@@ -19,9 +23,14 @@ class File::Stat
    include Windows::Error
    include Windows::Handle
    include Windows::Volume
+   include Windows::Process
+   include Windows::Security
+   include Windows::Time
+   include Windows::NTFS::Winternl
    include Comparable
    
-   VERSION = '1.3.2'
+   # The version of this library
+   VERSION = '1.3.3'
 
    private
 
@@ -33,7 +42,7 @@ class File::Stat
    # it later, after we've defined our initialize method.
    alias old_init initialize # :nodoc:
    
-   # Make this package -w clean
+   # Make this library -w clean
    undef_method(:atime, :blksize, :blockdev?, :blocks, :chardev?, :ctime)
    undef_method(:dev, :directory?, :executable?, :file?, :ftype, :gid, :ino)
    undef_method(:executable_real?, :grpowned?, :mode, :mtime, :nlink, :owned?)
@@ -52,9 +61,10 @@ class File::Stat
    # the file after that point will not be reflected.
    #
    def initialize(file)
-      @file = file.tr('/', "\\")
+      @file = File.expand_path(file)
+      @file = @file.tr('/', "\\")
       @file = multi_to_wide(@file)
-      
+
       @file_type = get_file_type(@file)
       @chardev = @file_type == FILE_TYPE_CHAR
 
@@ -64,13 +74,13 @@ class File::Stat
          else
             @blockdev = false
       end
-
+      
       # The stat struct in stat.h only has 11 members on Windows
       stat_buf = [0,0,0,0,0,0,0,0,0,0,0].pack('ISSsssIQQQQ')
-      
+
       # The stat64 function doesn't seem to like character devices
       if wstat64(@file, stat_buf) != 0
-          raise ArgumentError, get_last_error unless @chardev
+         raise ArgumentError, get_last_error unless @chardev
       end
 
       # Some bytes skipped (padding for struct alignment)
@@ -99,15 +109,46 @@ class File::Stat
 
       attributes = GetFileAttributesW(@file)
       error_num  = GetLastError()
-      
+
+      # Locked files.
+      if error_num == ERROR_SHARING_VIOLATION
+         buffer = 0.chr * 512
+
+         begin
+            handle = FindFirstFileW(@file, buffer)
+
+            if handle == INVALID_HANDLE_VALUE
+               raise SystemCallError, get_last_error()
+            end
+         ensure
+            FindClose(handle) if handle != INVALID_HANDLE_VALUE
+         end
+
+         attributes = buffer[0,4].unpack('L').first
+         st = 0.chr * 16
+         FileTimeToSystemTime(buffer[4,8],st)
+         y,m,w,d,h,n,s,i = st.unpack('SSSSSSSS')
+         @ctime = Time.local(y,m,d,h,n,s)
+           
+         st = 0.chr * 16
+         FileTimeToSystemTime(buffer[12,8],st)
+         y,m,w,d,h,n,s,i = st.unpack('SSSSSSSS')
+         @atime = Time.local(y,m,d,h,n,s)
+           
+         st = 0.chr * 16
+         FileTimeToSystemTime(buffer[20,8],st)
+         y,m,w,d,h,n,s,i = st.unpack('SSSSSSSS')
+         @mtime = Time.local(y,m,d,h,n,s)
+      end
+
       # Ignore errors caused by empty/open/used block devices.
       if attributes == INVALID_FILE_ATTRIBUTES
          unless error_num == ERROR_NOT_READY
             raise ArgumentError, get_last_error(error_num)
          end
       end
-      
-      @blksize = get_blksize(@file)
+     
+     @blksize = get_blksize(@file)
       
       # This is a reasonable guess
       case @blksize
@@ -563,6 +604,81 @@ class File::Stat
       size
    end
    
+   # Private method to get a HANDLE when CreateFile() won't cut it.
+   #
+   def get_handle(file)
+      file = file.upcase
+
+      begin
+         hdlTokenHandle = 0.chr * 4
+
+         OpenProcessToken(
+            GetCurrentProcess(),
+            TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY,
+            hdlTokenHandle
+         )
+
+         hdlTokenHandle = hdlTokenHandle.unpack('L').first
+
+         # Get the LUID for shutdown privilege.
+         tmpLuid = 0.chr * 8
+         LookupPrivilegeValue("", "SeDebugPrivilege", tmpLuid)
+         tkp = [1].pack('L') + tmpLuid + [SE_PRIVILEGE_ENABLED].pack('L')
+
+         # Enable the shutdown privilege in the access token of this process.
+         AdjustTokenPrivileges(hdlTokenHandle, 0,tkp, tkp.length , nil, nil)
+      ensure
+         CloseHandle(hdlTokenHandle)
+      end
+      
+      # First call is to get the required length
+      handle_info = 0.chr * 4096
+      required = 0.chr * 4
+      NtQuerySystemInformation(16, handle_info, 4096, required)
+
+      # Second call is the actual call
+      handle_info = 0.chr * required.unpack('L').first
+      NtQuerySystemInformation(16, handle_info, handle_info.length, required)
+
+      count = handle_info[0,4].unpack('L').first
+
+      for i in 0...count
+         pid, type, handle, addr, access = handle_info[4+i*16,16].unpack('LSSLL')
+         if access & 0xffff == 3
+            begin
+               process = OpenProcess(0x40,1,pid)
+               dup_handle = 0.chr * 4
+
+               DuplicateHandle(
+                  process,
+                  handle,
+                  GetCurrentProcess(),
+                  dup_handle,
+                  0,
+                  1,
+                  2
+               )
+            ensure
+               CloseHandle(process)
+            end
+
+            handle = dup_handle.unpack('L').first
+            buffer = 0.chr * 0x2000
+            NtQueryObject(handle, 1, buffer, 0x2000, nil)
+            len = buffer[0,2].unpack('S').first
+
+            if len>0
+               if buffer[8..-1].upcase[file]
+                  return handle
+               end
+            end
+            CloseHandle(handle)
+         end
+      end
+
+      return 0
+   end
+   
    # Returns the file's type (as a numeric).
    #
    def get_file_type(file)
@@ -578,10 +694,18 @@ class File::Stat
          )
       
          error_num = GetLastError()
-      
-         # Ignore errors caused by open/empty/used block devices. We raise a
-         # SystemCallError explicitly here in order to maintain compatibility
-         # with the FileUtils module.
+         
+         # CreateFile() chokes on locked files
+         if error_num == ERROR_SHARING_VIOLATION
+            drive  = file[0,4] + 0.chr * 2
+            device = 0.chr * 512
+            QueryDosDeviceW(drive, device, 256)
+            file = device.strip + 0.chr + file[4..-1]
+            handle = get_handle(file)
+         end
+
+         # We raise a SystemCallError explicitly here in order to maintain
+         # compatibility with the FileUtils module.
          if handle == INVALID_HANDLE_VALUE
             raise SystemCallError, get_last_error(error_num)
          end
@@ -605,4 +729,4 @@ class File::Stat
    def check_bool(val)
       raise TypeError unless val == true || val == false
    end
-end
+end

data/test/test_file_stat.rb

@@ -35,11 +35,12 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
    def setup
       @dir  = Dir.pwd 
       @stat = File::Stat.new(@@txt_file)
-      @attr = GetFileAttributes(@@txt_file)  
+      @attr = GetFileAttributes(@@txt_file)
+      @sys  = 'C:/pagefile.sys'  
    end
    
    def test_version
-      assert_equal('1.3.2', File::Stat::VERSION)
+      assert_equal('1.3.3', File::Stat::VERSION)
    end
    
    # One or more tests will fail if the archive attribute on @@text_file
@@ -268,6 +269,10 @@ class TC_Win32_File_Stat < Test::Unit::TestCase
       assert_equal(21, @stat.size)
    end
    
+   def test_size_system_file
+      assert_nothing_raised{ File::Stat.new(@sys).size }      
+   end
+   
    def test_size_bool
       assert_respond_to(@stat, :size?)
       assert_equal(21, @stat.size?)

data/win32-file-stat.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "win32-file-stat"
-   gem.version     = "1.3.2"
+   gem.version     = "1.3.3"
    gem.authors     = ["Daniel J. Berger", "Park Heesob"]
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
@@ -15,12 +15,12 @@ spec = Gem::Specification.new do |gem|
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
    gem.extra_rdoc_files = ["README", "CHANGES"]
-   gem.add_dependency("windows-pr", ">= 0.9.1")
-   gem.add_dependency("test-unit", ">= 2.0.0")
+   gem.add_dependency("windows-pr", ">= 1.0.0")
+   gem.add_dependency("test-unit", ">= 2.0.2")
    gem.rubyforge_project = 'Win32Utils'
 end
 
 if $0 == __FILE__
-   Gem.manage_gems
+   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.0
    Gem::Builder.new(spec).build
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-file-stat
 version: !ruby/object:Gem::Version 
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-01 00:00:00 -06:00
+date: 2009-02-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.1
+        version: 1.0.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 2.0.2
     version: 
 description: A File::Stat class tailored to MS Windows
 email: djberg96@gmail.com
@@ -52,7 +52,6 @@ files:
 - test
 - win32-file-stat.gemspec
 - test/test_file_stat.rb
-- test/test_file_stat.rb~
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
 post_install_message: 
@@ -75,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: Win32Utils
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A File::Stat class tailored to MS Windows

data/test/test_file_stat.rb~

@@ -1,343 +0,0 @@
-#####################################################################
-# test_file_stat.rb
-#
-# Test case for stat related methods of win32-file. You should use
-# the 'rake test' task to run these tests.
-#####################################################################
-require 'rubygems'
-gem 'test-unit'
-require 'test/unit'
-require 'win32/file/stat'
-include Windows::Volume
-
-class TC_Win32_File_Stat < Test::Unit::TestCase
-   include Windows::File
-
-   def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
-
-      'A'.upto('Z'){ |volume|
-         volume += ":\\"
-         case GetDriveType(volume)
-         when DRIVE_REMOVABLE, DRIVE_CDROM, DRIVE_RAMDISK
-            @@block_dev = volume
-            break
-         end
-      }
-
-      @@txt_file = 'test_file.txt'
-      @@exe_file = 'test_file.exe'
-
-      File.open(@@txt_file, "w"){ |fh| fh.print "This is a test\nHello" }
-      File.open(@@exe_file, "wb"){ |fh| fh.print "This is a test" }
-   end
-     
-   def setup
-      @dir  = Dir.pwd 
-      @stat = File::Stat.new(@@txt_file)
-      @attr = GetFileAttributes(@@txt_file)  
-   end
-   
-   def test_version
-      assert_equal('1.3.3', File::Stat::VERSION)
-   end
-   
-   # One or more tests will fail if the archive attribute on @@text_file
-   # is not set.
-   def test_archive
-      assert_respond_to(@stat, :archive?)
-      assert_nothing_raised{ @stat.archive? }
-      assert(@stat.archive?, '=> May fail - ignore')
-   end
-   
-   def test_atime
-      assert_respond_to(@stat, :atime)
-      assert_kind_of(Time, @stat.atime)
-   end
-   
-   def test_blksize
-      assert_respond_to(@stat, :blksize)
-      assert_equal(4096, @stat.blksize)
-      assert_equal(4096, File::Stat.new("C:\\").blksize)
-   end
-   
-   # The block dev test error out if there's no media in it.
-   def test_blockdev
-      assert_respond_to(@stat, :blockdev?)
-      assert_equal(false, @stat.blockdev?)
-      assert_equal(false, File::Stat.new('NUL').blockdev?)
-
-      begin
-         assert_equal(true, File::Stat.new(@@block_dev).blockdev?)
-      rescue SystemCallError      
-         omit("Skipping because drive is empty")
-      end
-   end
-   
-   def test_blocks
-      assert_respond_to(@stat, :blocks)
-      assert_equal(1, @stat.blocks)
-   end
-   
-   def test_chardev
-      assert_respond_to(@stat, :chardev?)
-      assert_nothing_raised{ File::Stat.new("NUL").chardev? }     
-      assert_equal(true, File::Stat.new("NUL").chardev?)
-      assert_equal(false, File::Stat.new("C:\\").chardev?)
-   end
-   
-   def test_comparison
-      assert_respond_to(@stat, :<=>)
-      assert_nothing_raised{ @stat <=> File::Stat.new(@@exe_file) }
-   end
-   
-   def test_compressed
-      assert_respond_to(@stat, :compressed?)
-      assert_nothing_raised{ @stat.compressed? }
-      assert_equal(false, @stat.compressed?)
-   end
-   
-   def test_ctime
-      assert_respond_to(@stat, :ctime)
-      assert_kind_of(Time, @stat.ctime)
-   end
-   
-   # Assumes you've installed on C: drive.
-   def test_dev
-      assert_respond_to(@stat, :dev)
-      assert_equal('C:', @stat.dev)
-   end
-   
-   def test_dev_major
-      assert_respond_to(@stat, :dev_major)
-      assert_nil(@stat.dev_major)
-   end
-   
-   def test_dev_minor
-      assert_respond_to(@stat, :dev_minor)
-      assert_nil(@stat.dev_minor)
-   end
-   
-   def test_directory
-      assert_respond_to(@stat, :directory?)
-      assert_equal(false, @stat.directory?)
-      assert_equal(true, File::Stat.new("C:\\").directory?)
-   end
-   
-   def test_executable
-      assert_respond_to(@stat, :executable?)
-      assert_equal(false, @stat.executable?)
-      assert_equal(true, File::Stat.new(@@exe_file).executable?)
-   end
-   
-   def test_executable_real
-      assert_respond_to(@stat, :executable_real?)
-      assert_equal(false, @stat.executable_real?)
-      assert_equal(true, File::Stat.new(@@exe_file).executable_real?)
-   end
-   
-   def test_file
-      assert_respond_to(@stat, :file?)
-      assert_equal(true, @stat.file?)
-      assert_equal(true, File::Stat.new(@@exe_file).file?)
-      assert_equal(true, File::Stat.new(Dir.pwd).file?)
-      assert_equal(false, File::Stat.new('NUL').file?)
-   end
-   
-   def test_ftype
-      assert_respond_to(@stat, :ftype)
-      assert_equal('file', @stat.ftype)
-      assert_equal('characterSpecial', File::Stat.new('NUL').ftype)
-      assert_equal('directory', File::Stat.new(Dir.pwd).ftype)
-   end
-   
-   def encrypted
-      assert_respond_to(@stat, :encrypted?)
-      assert_nothing_raised{ @stat.encrypted? }
-   end
-   
-   def test_gid
-      assert_respond_to(@stat, :gid)
-      assert_equal(0, @stat.gid)
-   end
-   
-   def test_grpowned
-      assert_respond_to(@stat, :grpowned?)
-   end
-   
-   def test_hidden
-      assert_respond_to(@stat, :hidden?)
-      assert_nothing_raised{ @stat.hidden? }
-      assert_equal(false, @stat.hidden?)
-   end
-   
-   def test_indexed
-      assert_respond_to(@stat, :indexed?)
-      assert_respond_to(@stat, :content_indexed?) # alias
-      assert_nothing_raised{ @stat.indexed? }
-      assert(@stat.indexed?)
-   end
-   
-   def test_ino
-      assert_respond_to(@stat, :ino)
-      assert_equal(0, @stat.ino)
-   end
-   
-   def test_inspect
-      assert_respond_to(@stat, :inspect)
-   end
-   
-   def test_mode
-      assert_respond_to(@stat, :mode)
-      assert_equal(33188, File::Stat.new(@@txt_file).mode)
-      assert_equal(33261, File::Stat.new(@@exe_file).mode)
-      assert_equal(16877, File::Stat.new(@dir).mode)
-      
-      SetFileAttributes(@@txt_file, 1) # Set to readonly.
-      assert_equal(33060, File::Stat.new(@@txt_file).mode)
-   end
-   
-   def test_mtime
-      assert_respond_to(@stat, :mtime)
-      assert_kind_of(Time, @stat.mtime)
-   end
-   
-   def test_nlink
-      assert_respond_to(@stat, :nlink)
-      assert_equal(1, @stat.nlink)
-   end
-   
-   def test_normal
-      assert_respond_to(@stat, :normal?)
-      assert_nothing_raised{ @stat.normal? }
-      assert_equal(false, @stat.normal?)
-   end
-   
-   def test_offline
-      assert_respond_to(@stat, :offline?)
-      assert_nothing_raised{ @stat.offline? }
-      assert_equal(false, @stat.offline?)
-   end
-   
-   def test_pipe
-      assert_respond_to(@stat, :pipe?)
-      assert_equal(false, @stat.pipe?)
-   end
-   
-   def test_readable
-      assert_respond_to(@stat, :readable?)
-      assert_equal(true, @stat.readable?)
-   end
-   
-   def test_readable_real
-      assert_respond_to(@stat, :readable_real?)
-      assert_equal(true, @stat.readable_real?)
-   end
-   
-   def test_readonly
-      assert_respond_to(@stat, :readonly?)
-      assert_nothing_raised{ @stat.readonly? }
-      assert_equal(false, @stat.readonly?)
-   end
-   
-   def test_reparse_point
-      assert_respond_to(@stat, :reparse_point?)
-      assert_nothing_raised{ @stat.reparse_point? }
-      assert_equal(false, @stat.reparse_point?)
-   end 
-   
-   # Assumes you've installed on C: drive.
-   def test_rdev
-      msg = "ignore failure if Ruby is not installed on C: drive"
-      assert_respond_to(@stat, :rdev)
-      assert_equal(2, @stat.rdev, msg)
-   end
-   
-   def test_setgid
-      assert_respond_to(@stat, :setgid?)
-      assert_equal(false, @stat.setgid?)
-   end
-   
-   def test_setuid
-      assert_respond_to(@stat, :setuid?)
-      assert_equal(false, @stat.setuid?)
-   end
-
-   def test_size
-      assert_respond_to(@stat, :size)
-      assert_equal(21, @stat.size)
-   end
-   
-   def test_size_bool
-      assert_respond_to(@stat, :size?)
-      assert_equal(21, @stat.size?)
-   end
-   
-   def test_socket
-      assert_respond_to(@stat, :socket?)
-      assert_equal(false, @stat.socket?)
-   end
-   
-   def test_sparse
-      assert_respond_to(@stat, :sparse?)
-      assert_nothing_raised{ @stat.sparse? }
-      assert_equal(false, @stat.sparse?)
-   end
-   
-   def test_sticky
-      assert_respond_to(@stat, :sticky?)
-      assert_equal(false, @stat.sticky?)
-   end
-   
-   def test_symlink
-      assert_respond_to(@stat, :symlink?)
-      assert_equal(false, @stat.symlink?)
-   end
-   
-   def test_system
-      assert_respond_to(@stat, :system?)
-      assert_nothing_raised{ @stat.system? }
-      assert_equal(false, @stat.system?)
-   end
-   
-   def test_temporary
-      assert_respond_to(@stat, :temporary?)
-      assert_nothing_raised{ @stat.temporary? }
-      assert_equal(false, @stat.temporary?)
-   end  
-   
-   def test_uid
-      assert_respond_to(@stat, :uid)
-      assert_equal(0, @stat.uid)
-   end
-   
-   def test_writable
-      assert_respond_to(@stat, :writable?)
-      assert_equal(true, @stat.writable?)
-   end
-   
-   def test_writable_real
-      assert_respond_to(@stat, :writable_real?)
-      assert_equal(true, @stat.writable_real?)
-   end
-   
-   def test_zero
-      assert_respond_to(@stat, :zero?)
-      assert_equal(false, @stat.zero?)
-   end
-
-   def teardown
-      SetFileAttributes(@@txt_file, @attr) # Set file back to normal
-      @dir  = nil
-      @stat = nil     
-      @attr = nil
-   end
-
-   def self.shutdown
-      File.delete(@@txt_file) if File.exists?(@@txt_file)
-      File.delete(@@exe_file) if File.exists?(@@exe_file)
-      @@block_dev = nil
-      @@txt_file  = nil
-      @@exe_file  = nil
-   end
-end