windows-pr 0.9.3 → 0.9.4

data/CHANGES

@@ -1,3 +1,15 @@
+= 0.9.4 - 27-Sep-2008
+* Added some macros from windef.h to the Windows::SystemInfo module.
+* Added the windows_2000?, windows_xp?, windows_2003? and windows_vista?
+  helper methods to the Windows::SystemInfo module.
+* Added the umask and umask_s functions to the Windows::MSVCRT::File module.
+* Added SH_DENYNO and SHORT_LIVED constants to the Windows::MSVCRT::IO module.
+* Fixed the prototype for open and wopen in the Windows::MSVCRT::IO module.
+* Added SHGetFolderLocation to the Windows::Shell module.
+* Added NT privilege constants to the Windows::Security module.
+* The wide_to_multi helper function is now friendlier with regards to strings
+  that may be missing a trailing double null.
+
 = 0.9.3 - 12-Sep-2008
 * Added event logging functions for Windows Vista and later to the
   Windows::EventLog module.

data/lib/windows/file.rb

@@ -117,6 +117,7 @@ module Windows
       FILE_SUPPORTS_ENCRYPTION       = 0x20000
       
       # File flags
+
       FILE_FLAG_WRITE_THROUGH       = 0x80000000
       FILE_FLAG_OVERLAPPED          = 0x40000000
       FILE_FLAG_NO_BUFFERING        = 0x20000000
@@ -130,6 +131,7 @@ module Windows
       FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
       
       # File creation disposition
+
       CREATE_NEW        = 1
       CREATE_ALWAYS     = 2
       OPEN_EXISTING     = 3
@@ -151,12 +153,14 @@ module Windows
          SECTION_EXTEND_SIZE
            
       # Errors
+
       INVALID_FILE_ATTRIBUTES  = -1
       INVALID_HANDLE_VALUE     = -1
       INVALID_SET_FILE_POINTER = -1
       INVALID_FILE_SIZE        = 0xFFFFFFFF
       
       # Misc
+
       LOCKFILE_EXCLUSIVE_LOCK        = 0x00000001
       LOCKFILE_FAIL_IMMEDIATELY      = 0x00000002
       MOVEFILE_REPLACE_EXISTING      = 0x00000001
@@ -165,6 +169,7 @@ module Windows
       MOVEFILE_WRITE_THROUGH         = 0x00000008
       MOVEFILE_CREATE_HARDLINK       = 0x00000010
       MOVEFILE_FAIL_IF_NOT_TRACKABLE = 0x00000020      
+      SYMBOLIC_LINK_FLAG_DIRECTORY   = 0x1
      
       API.new('CopyFile', 'PPI', 'B')
       API.new('CopyFileEx', 'PPKPPL', 'B')
@@ -208,8 +213,16 @@ module Windows
          API.new('Wow64EnableWow64FsRedirection', 'I', 'I')
          API.new('Wow64RevertWow64FsRedirection', 'L', 'B')
       rescue Windows::API::Error
-         # Do nothing - not supported on current platform.  It's up to you to
-         # check for the existence of the constant in your code.
+         # Do nothing - unsupported on your system
+      end
+
+      # Windows Vista
+      begin
+         API.new('CreateSymbolicLink', 'PPL', 'B')
+         API.new('CreateSymbolicLinkTransacted', 'PPLL', 'B')
+         API.new('GetFinalPathNameByHandle', 'LPLL', 'L')
+      rescue
+         # Do nothing - unsupported on your system
       end
    end
 end

data/lib/windows/msvcrt/file.rb

@@ -22,6 +22,10 @@ module Windows
          API.new('_mktemp', 'P', 'P', MSVCRT_DLL)
          API.new('_stat', 'PP', 'I', 'msvcrt')
          API.new('_stat64', 'PP', 'I', MSVCRT_DLL)
+         API.new('_umask', 'I', 'I', MSVCRT_DLL)
+
+         # Wide character variants
+
          API.new('_wchmod', 'PI', 'I', MSVCRT_DLL)
          API.new('_wmktemp', 'P', 'P', MSVCRT_DLL)
          API.new('_wstat', 'PP', 'I', 'msvcrt')
@@ -31,6 +35,7 @@ module Windows
          begin
             API.new('_chsize_s', 'IL', 'I', MSVCRT_DLL)
             API.new('_mktemp_s', 'PL', 'L', MSVCRT_DLL)
+            API.new('_umask_s', 'IP', 'L', MSVCRT_DLL)
             API.new('_wmktemp_s', 'PL', 'L', MSVCRT_DLL)
          rescue Windows::API::Error
             # Ignore - you must check for it via 'defined?'

data/lib/windows/msvcrt/io.rb

@@ -17,6 +17,9 @@ module Windows
          S_IREAD  = 0000400 # read permission, owner
          S_IWRITE = 0000200 # write permission, owner
          S_IEXEC  = 0000100 # execute/search permission, owner
+         
+         SH_DENYNO = 0x40     # deny none mode
+         SHORT_LIVED = 0x1000 # temporary file storage
 
          API.new('clearerr', 'I', 'V', MSVCRT_DLL)
          API.new('_close', 'I', 'V', MSVCRT_DLL)
@@ -38,21 +41,28 @@ module Windows
          API.new('fputws', 'PL', 'I', MSVCRT_DLL)
          API.new('getc', 'L', 'I', MSVCRT_DLL)
          API.new('getwc', 'L', 'L', MSVCRT_DLL)
-         API.new('_open', 'PPI', 'I', MSVCRT_DLL)
+         API.new('_open', 'PII', 'I', MSVCRT_DLL)
          API.new('_rmtmp', 'V', 'I', MSVCRT_DLL)
          API.new('_setmode', 'II', 'I', MSVCRT_DLL)
+         API.new('_sopen', 'PIII', 'I', MSVCRT_DLL)
          API.new('_tempnam', 'PP', 'P', MSVCRT_DLL)
          API.new('tmpfile', 'V', 'L', MSVCRT_DLL)
          API.new('tmpnam', 'P', 'P', MSVCRT_DLL)
-         API.new('_wopen', 'PPI', 'I', MSVCRT_DLL)
+
+         # Wide character versions
+
+         API.new('_wopen', 'PII', 'I', MSVCRT_DLL)
          API.new('_wfdopen', 'IP', 'I', MSVCRT_DLL)
          API.new('_wfopen', 'PPI', 'I', MSVCRT_DLL)
+         API.new('_wsopen', 'PIII', 'I', MSVCRT_DLL)
          API.new('_wtempnam', 'PP', 'P', MSVCRT_DLL)
          API.new('_wtmpnam', 'P', 'P', MSVCRT_DLL)
 
          # VC++ 8.0 or later
          begin
+            API.new('_sopen_s', 'PPIII', 'L', MSVCRT_DLL)
             API.new('_tmpfile_s', 'P', 'L', MSVCRT_DLL)
+            API.new('_wsopen_s', 'PPIII', 'L', MSVCRT_DLL)
          rescue Windows::API::Error
             # Ignore - you must check for it via 'defined?'
          end

data/lib/windows/security.rb

@@ -126,6 +126,39 @@ module Windows
       SE_PRIVILEGE_REMOVED            = 0X00000004
       SE_PRIVILEGE_USED_FOR_ACCESS    = 0x80000000      
 
+      # Defined Privileges
+ 
+      SE_CREATE_TOKEN_NAME        = "SeCreateTokenPrivilege"
+      SE_ASSIGNPRIMARYTOKEN_NAME  = "SeAssignPrimaryTokenPrivilege"
+      SE_LOCK_MEMORY_NAME         = "SeLockMemoryPrivilege"
+      SE_INCREASE_QUOTA_NAME      = "SeIncreaseQuotaPrivilege"
+      SE_UNSOLICITED_INPUT_NAME   = "SeUnsolicitedInputPrivilege"
+      SE_MACHINE_ACCOUNT_NAME     = "SeMachineAccountPrivilege"
+      SE_TCB_NAME                 = "SeTcbPrivilege"
+      SE_SECURITY_NAME            = "SeSecurityPrivilege"
+      SE_TAKE_OWNERSHIP_NAME      = "SeTakeOwnershipPrivilege"
+      SE_LOAD_DRIVER_NAME         = "SeLoadDriverPrivilege"
+      SE_SYSTEM_PROFILE_NAME      = "SeSystemProfilePrivilege"
+      SE_SYSTEMTIME_NAME          = "SeSystemtimePrivilege"
+      SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege"
+      SE_INC_BASE_PRIORITY_NAME   = "SeIncreaseBasePriorityPrivilege"
+      SE_CREATE_PAGEFILE_NAME     = "SeCreatePagefilePrivilege"
+      SE_CREATE_PERMANENT_NAME    = "SeCreatePermanentPrivilege"
+      SE_BACKUP_NAME              = "SeBackupPrivilege"
+      SE_RESTORE_NAME             = "SeRestorePrivilege"
+      SE_SHUTDOWN_NAME            = "SeShutdownPrivilege"
+      SE_DEBUG_NAME               = "SeDebugPrivilege"
+      SE_AUDIT_NAME               = "SeAuditPrivilege"
+      SE_SYSTEM_ENVIRONMENT_NAME  = "SeSystemEnvironmentPrivilege"
+      SE_CHANGE_NOTIFY_NAME       = "SeChangeNotifyPrivilege"
+      SE_REMOTE_SHUTDOWN_NAME     = "SeRemoteShutdownPrivilege"
+      SE_UNDOCK_NAME              = "SeUndockPrivilege"
+      SE_SYNC_AGENT_NAME          = "SeSyncAgentPrivilege"
+      SE_ENABLE_DELEGATION_NAME   = "SeEnableDelegationPrivilege"
+      SE_MANAGE_VOLUME_NAME       = "SeManageVolumePrivilege"
+      SE_IMPERSONATE_NAME         = "SeImpersonatePrivilege"
+      SE_CREATE_GLOBAL_NAME       = "SeCreateGlobalPrivilege"
+
       ACCESS_MIN_MS_ACE_TYPE                  = 0x0
       ACCESS_ALLOWED_ACE_TYPE                 = 0x0
       ACCESS_DENIED_ACE_TYPE                  = 0x1
@@ -161,6 +194,7 @@ module Windows
       FAILED_ACCESS_ACE_FLAG                  = 0x80
 
       # Standard Access Rights
+
       DELETE                       = 0x00010000
       READ_CONTROL                 = 0x20000
       WRITE_DAC                    = 0x40000
@@ -180,6 +214,7 @@ module Windows
       GENERIC_ALL                  = 0x10000000
 
       # Enum SidNameUse
+
       SidTypeUser           = 1
       SidTypeGroup          = 2
       SidTypeDomain         = 3
@@ -191,6 +226,7 @@ module Windows
       SidTypeComputer       = 9
 
       # Enum TokenInformationClass
+
       TokenUser                  = 1
       TokenGroups                = 2
       TokenPrivileges            = 3               
@@ -222,6 +258,7 @@ module Windows
       MaxTokenInfoClass          = 29
 
       # Enum WellKnownSidType
+
       WinNullSid                                    = 0
       WinWorldSid                                   = 1
       WinLocalSid                                   = 2

data/lib/windows/shell.rb

@@ -151,10 +151,20 @@ module Windows
       API.new('ShellExecuteEx', 'P', 'B', 'shell32')
       API.new('SHFileOperation', 'P', 'I', 'shell32')
       API.new('SHGetFileInfo', 'PLPII', 'L', 'shell32')
+      API.new('SHGetFolderLocation', 'LILLP', 'L', 'shell32')
       API.new('SHGetFolderPath', 'LLLLP', 'L', 'shell32')
       API.new('SHGetNewLinkInfo', 'PPPPI', 'B', 'shell32')
       API.new('SHGetPathFromIDList', 'LL', 'B', 'shell32')
       API.new('SHGetSpecialFolderLocation', 'LIP', 'L', 'shell32')
       API.new('SHGetSpecialFolderPath', 'LPLL','L', 'shell32')
+
+      # Windows Vista
+      begin
+         API.new('SHGetKnownFolderPath', 'LLLP', 'L', 'shell32')
+         API.new('SHGetKnownFolderIDList', 'LLLP', 'L', 'shell32')
+         API.new('SHGetNameFromIDList', 'PLP', 'L', 'shell32')
+      rescue Windows::API::Error
+         # Not supported on your platform
+      end
    end
 end

data/lib/windows/system_info.rb

@@ -8,13 +8,58 @@ module Windows
       API.auto_unicode   = true
 
       # Obsolete processor info constants
+
       PROCESSOR_INTEL_386     = 386
       PROCESSOR_INTEL_486     = 486
       PROCESSOR_INTEL_PENTIUM = 586
       PROCESSOR_INTEL_IA64    = 2200
       PROCESSOR_AMD_X8664     = 8664
 
+      # Suite mask constants
+
+      VER_SERVER_NT                      = 0x80000000
+      VER_WORKSTATION_NT                 = 0x40000000
+      VER_SUITE_SMALLBUSINESS            = 0x00000001
+      VER_SUITE_ENTERPRISE               = 0x00000002
+      VER_SUITE_BACKOFFICE               = 0x00000004
+      VER_SUITE_COMMUNICATIONS           = 0x00000008
+      VER_SUITE_TERMINAL                 = 0x00000010
+      VER_SUITE_SMALLBUSINESS_RESTRICTED = 0x00000020
+      VER_SUITE_EMBEDDEDNT               = 0x00000040
+      VER_SUITE_DATACENTER               = 0x00000080
+      VER_SUITE_SINGLEUSERTS             = 0x00000100
+      VER_SUITE_PERSONAL                 = 0x00000200
+      VER_SUITE_BLADE                    = 0x00000400
+      VER_SUITE_EMBEDDED_RESTRICTED      = 0x00000800
+      VER_SUITE_SECURITY_APPLIANCE       = 0x00001000
+      VER_SUITE_STORAGE_SERVER           = 0x00002000
+      VER_SUITE_COMPUTE_SERVER           = 0x00004000
+
+      # Product mask constants
+
+      VER_NT_WORKSTATION       = 0x0000001
+      VER_NT_DOMAIN_CONTROLLER = 0x0000002
+      VER_NT_SERVER            = 0x0000003
+
+      # Platform definitions
+
+      VER_PLATFORM_WIN32s        = 0
+      VER_PLATFORM_WIN32_WINDOWS = 1
+      VER_PLATFORM_WIN32_NT      = 2
+
+      # Version info type constants
+
+      VER_MINORVERSION     = 0x0000001
+      VER_MAJORVERSION     = 0x0000002
+      VER_BUILDNUMBER      = 0x0000004
+      VER_PLATFORMID       = 0x0000008
+      VER_SERVICEPACKMINOR = 0x0000010
+      VER_SERVICEPACKMAJOR = 0x0000020
+      VER_SUITENAME        = 0x0000040
+      VER_PRODUCT_TYPE     = 0x0000080
+
       # Enum COMPUTER_NAME_FORMAT
+
       ComputerNameNetBIOS                    = 0
       ComputerNameDnsHostname                = 1
       ComputerNameDnsDomain                  = 2
@@ -41,5 +86,128 @@ module Windows
       rescue Windows::API::Error
          # Do nothing. Users must check for function.
       end
+
+      # These macros are from windef.h, but I've put them here for now
+      # since they can be used in conjunction with some of the functions
+      # declared in this module.
+
+      def MAKEWORD(a, b)
+         ((a & 0xff) | (b & 0xff)) << 8
+      end
+
+      def MAKELONG(a, b)
+         ((a & 0xffff) | (b & 0xffff)) << 16
+      end
+
+      def LOWORD(l)
+         l & 0xffff
+      end
+
+      def HIWORD(l)
+         l >> 16
+      end
+
+      def LOBYTE(w)
+         w & 0xff
+      end
+
+      def HIBYTE(w)
+         w >> 8
+      end
+      
+      # Custom methods that may come in handy
+
+      # Returns true if the current platform is Vista (any variant) or Windows
+      # Server 2008, i.e. major version 6, minor version 0. 
+      #
+      def windows_2000?
+         version = GetVersion()
+         LOBYTE(LOWORD(version)) == 5 && HIBYTE(LOWORD(version)) == 0
+      end
+      
+      # Returns true if the current platform is Windows XP or Windows XP
+      # Pro, i.e. major version 5, minor version 1 (or 2 in the case of a
+      # 64-bit Windows XP Pro).
+      #--
+      # Because of the exception for a 64-bit Windows XP Pro, we have to
+      # to do things the hard way. For version 2 we look for any of the
+      # suite masks that might be associated with Windows 2003. If we don't
+      # find any of them, assume it's Windows XP.
+      #
+      def windows_xp?
+         bool = false
+
+         buf = 0.chr * 156
+         buf[0,4] = [buf.size].pack("L") # Set dwOSVersionInfoSize
+
+         GetVersionEx(buf)
+
+         major = buf[4,4].unpack("L")[0]
+         minor = buf[8,4].unpack("L")[0]
+         suite = buf[152,2].unpack("S")[0]
+
+         # Make sure we detect a 64-bit Windows XP Pro
+         if major == 5
+            if minor == 1
+               bool = true
+            elsif minor == 2
+               if (suite & VER_SUITE_BLADE == 0)          &&
+                  (suite & VER_SUITE_COMPUTE_SERVER == 0) &&
+                  (suite & VER_SUITE_DATACENTER == 0)     &&
+                  (suite & VER_SUITE_ENTERPRISE == 0)     &&
+                  (suite & VER_SUITE_STORAGE_SERVER == 0)
+               then
+                  bool = true
+               end
+            else
+               # Do nothing - already false
+            end 
+         end
+
+         bool
+      end
+
+      # Returns true if the current platform is Windows 2003 (any version).
+      # i.e. major version 5, minor version 2.
+      #--
+      # Because of the exception for a 64-bit Windows XP Pro, we have to
+      # to do things the hard way. For version 2 we look for any of the
+      # suite masks that might be associated with Windows 2003. If we find
+      # any of them, assume it's Windows 2003.
+      #
+      def windows_2003?
+         bool = false
+
+         buf = 0.chr * 156
+         buf[0,4] = [buf.size].pack("L") # Set dwOSVersionInfoSize
+
+         GetVersionEx(buf)
+
+         major = buf[4,4].unpack("L")[0]
+         minor = buf[8,4].unpack("L")[0]
+         suite = buf[152,2].unpack("S")[0]
+
+         # Make sure we exclude a 64-bit Windows XP Pro
+         if major == 5 && minor == 2
+            if (suite & VER_SUITE_BLADE > 0)          ||
+               (suite & VER_SUITE_COMPUTE_SERVER > 0) ||
+               (suite & VER_SUITE_DATACENTER > 0)     ||
+               (suite & VER_SUITE_ENTERPRISE > 0)     ||
+               (suite & VER_SUITE_STORAGE_SERVER > 0)
+            then
+               bool = true
+            end
+         end
+
+         bool
+      end
+
+      # Returns true if the current platform is Windows Vista (any variant)
+      # or Windows Server 2008, i.e. major version 6, minor version 0. 
+      #
+      def windows_vista?
+         version = GetVersion()
+         LOBYTE(LOWORD(version)) == 6 && HIBYTE(LOWORD(version)) == 0
+      end
    end
 end

data/lib/windows/unicode.rb

@@ -123,6 +123,9 @@ module Windows
             encoding = ($KCODE == 'UTF8') ? CP_UTF8 : CP_ACP
          end
 
+         # Add a trailing double null if necessary
+         wstring << "\000\000" if wstring[-1].chr != "\000"
+
          int = WideCharToMultiByte(encoding, 0, wstring, -1, 0, 0, nil, nil)
          
          # Trailing nulls are stripped

data/test/tc_system_info.rb

@@ -29,6 +29,13 @@ class TC_Windows_SystemInfo < Test::Unit::TestCase
       assert_not_nil(SystemInfoFoo::GetComputerNameEx)
       assert_not_nil(SystemInfoFoo::GetSystemInfo)
    end
+
+   def test_custom_boolean_methods
+      assert_respond_to(@foo, :windows_2000?)
+      assert_respond_to(@foo, :windows_xp?)
+      assert_respond_to(@foo, :windows_2003?)
+      assert_respond_to(@foo, :windows_vista?)
+   end
    
    def teardown
       @foo = nil

data/windows-pr.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "windows-pr"
-   gem.version     = "0.9.3"
+   gem.version     = "0.9.4"
    gem.authors     = ["Daniel J. Berger", "Park Heesob"]
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: windows-pr
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 -06:00
+date: 2008-09-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Windows functions and constants bundled via Win32::API