chef 0.10.10 → 10.12.0.rc.1

data/lib/chef/version.rb

@@ -17,7 +17,7 @@
 
 class Chef
   CHEF_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
-  VERSION = '0.10.10'
+  VERSION = '10.12.0.rc.1'
 end
 
 # NOTE: the Chef::Version class is defined in version_class.rb

data/lib/chef/win32/api.rb

@@ -18,11 +18,26 @@
 #
 
 require 'ffi'
+require 'chef/reserved_names'
+require 'chef/exceptions'
 
 class Chef
-  module Win32
+  module ReservedNames::Win32
     module API
 
+      # Attempts to use FFI's attach_function method to link a native Win32
+      # function into the calling module.  If this fails a dummy method is
+      # defined which when called, raises a helpful exception to the end-user.
+      def safe_attach_function(win32_func, *args)
+        begin
+          attach_function(win32_func.to_sym, *args)
+        rescue FFI::NotFoundError
+          define_method(win32_func.to_sym) do |*margs|
+            raise Chef::Exceptions::Win32APIFunctionNotImplemented, "This version of Windows does not implement the Win32 function [#{win32_func}]."
+          end
+        end
+      end
+
       # put shared stuff (like constants) for all raw Win32 API calls
       def self.extended(host)
         host.extend FFI::Library

data/lib/chef/win32/api/error.rb

@@ -19,10 +19,10 @@
 require 'chef/win32/api'
 
 class Chef
-  module Win32
+  module ReservedNames::Win32
     module API
       module Error
-        extend Chef::Win32::API
+        extend Chef::ReservedNames::Win32::API
 
         ###############################################
         # Win32 API Constants
@@ -890,30 +890,30 @@ DWORD WINAPI FormatMessage(
   __in_opt  va_list *Arguments
 );
 =end
-        attach_function :FormatMessageA, [:DWORD, :LPCVOID, :DWORD, :DWORD, :LPTSTR, :DWORD, :varargs], :DWORD
-        attach_function :FormatMessageW, [:DWORD, :LPCVOID, :DWORD, :DWORD, :LPWSTR, :DWORD, :varargs], :DWORD
+        safe_attach_function :FormatMessageA, [:DWORD, :LPCVOID, :DWORD, :DWORD, :LPTSTR, :DWORD, :varargs], :DWORD
+        safe_attach_function :FormatMessageW, [:DWORD, :LPCVOID, :DWORD, :DWORD, :LPWSTR, :DWORD, :varargs], :DWORD
 
 =begin
 DWORD WINAPI GetLastError(void);
 =end
-        attach_function :GetLastError, [], :DWORD
+        safe_attach_function :GetLastError, [], :DWORD
 =begin
 void WINAPI SetLastError(
   __in  DWORD dwErrCode
 );
 =end
-        attach_function :SetLastError, [:DWORD], :void
-        attach_function :SetLastErrorEx, [:DWORD, :DWORD], :void
+        safe_attach_function :SetLastError, [:DWORD], :void
+        safe_attach_function :SetLastErrorEx, [:DWORD, :DWORD], :void
 =begin
 UINT WINAPI GetErrorMode(void);s
 =end
-        attach_function :GetErrorMode, [], :uint
+        safe_attach_function :GetErrorMode, [], :uint
 =begin
 UINT WINAPI SetErrorMode(
   __in  UINT uMode
 );
 =end
-        attach_function :SetErrorMode, [:UINT], :UINT
+        safe_attach_function :SetErrorMode, [:UINT], :UINT
 
       end
     end

data/lib/chef/win32/api/file.rb

@@ -22,12 +22,12 @@ require 'chef/win32/api/security'
 require 'chef/win32/api/system'
 
 class Chef
-  module Win32
+  module ReservedNames::Win32
     module API
       module File
-        extend Chef::Win32::API
-        include Chef::Win32::API::Security
-        include Chef::Win32::API::System
+        extend Chef::ReservedNames::Win32::API
+        include Chef::ReservedNames::Win32::API::Security
+        include Chef::ReservedNames::Win32::API::System
 
         ###############################################
         # Win32 API Constants
@@ -50,7 +50,18 @@ class Chef
         FILE_ATTRIBUTE_VIRTUAL             = 0x00010000
         INVALID_FILE_ATTRIBUTES            = 0xFFFFFFFF
 
-        IO_REPARSE_TAG_SYMLINK = 0xA000000C
+        FILE_FLAG_WRITE_THROUGH            = 0x80000000
+        FILE_FLAG_OVERLAPPED               = 0x40000000
+        FILE_FLAG_NO_BUFFERING             = 0x20000000
+        FILE_FLAG_RANDOM_ACCESS            = 0x10000000
+        FILE_FLAG_SEQUENTIAL_SCAN          = 0x08000000
+        FILE_FLAG_DELETE_ON_CLOSE          = 0x04000000
+        FILE_FLAG_BACKUP_SEMANTICS         = 0x02000000
+        FILE_FLAG_POSIX_SEMANTICS          = 0x01000000
+        FILE_FLAG_OPEN_REPARSE_POINT       = 0x00200000
+        FILE_FLAG_OPEN_NO_RECALL           = 0x00100000
+        FILE_FLAG_FIRST_PIPE_INSTANCE      = 0x00080000
+
         INVALID_HANDLE_VALUE = 0xFFFFFFFF
         MAX_PATH = 260
 
@@ -63,6 +74,109 @@ class Chef
         FILE_SHARE_READ = 0x00000001
         OPEN_EXISTING = 3
 
+        # DeviceIoControl control codes
+        # -----------------------------
+        FILE_DEVICE_BEEP                = 0x00000001
+        FILE_DEVICE_CD_ROM              = 0x00000002
+        FILE_DEVICE_CD_ROM_FILE_SYSTEM  = 0x00000003
+        FILE_DEVICE_CONTROLLER          = 0x00000004
+        FILE_DEVICE_DATALINK            = 0x00000005
+        FILE_DEVICE_DFS                 = 0x00000006
+        FILE_DEVICE_DISK                = 0x00000007
+        FILE_DEVICE_DISK_FILE_SYSTEM    = 0x00000008
+        FILE_DEVICE_FILE_SYSTEM         = 0x00000009
+        FILE_DEVICE_INPORT_PORT         = 0x0000000a
+        FILE_DEVICE_KEYBOARD            = 0x0000000b
+        FILE_DEVICE_MAILSLOT            = 0x0000000c
+        FILE_DEVICE_MIDI_IN             = 0x0000000d
+        FILE_DEVICE_MIDI_OUT            = 0x0000000e
+        FILE_DEVICE_MOUSE               = 0x0000000f
+        FILE_DEVICE_MULTI_UNC_PROVIDER  = 0x00000010
+        FILE_DEVICE_NAMED_PIPE          = 0x00000011
+        FILE_DEVICE_NETWORK             = 0x00000012
+        FILE_DEVICE_NETWORK_BROWSER     = 0x00000013
+        FILE_DEVICE_NETWORK_FILE_SYSTEM = 0x00000014
+        FILE_DEVICE_NULL                = 0x00000015
+        FILE_DEVICE_PARALLEL_PORT       = 0x00000016
+        FILE_DEVICE_PHYSICAL_NETCARD    = 0x00000017
+        FILE_DEVICE_PRINTER             = 0x00000018
+        FILE_DEVICE_SCANNER             = 0x00000019
+        FILE_DEVICE_SERIAL_MOUSE_PORT   = 0x0000001a
+        FILE_DEVICE_SERIAL_PORT         = 0x0000001b
+        FILE_DEVICE_SCREEN              = 0x0000001c
+        FILE_DEVICE_SOUND               = 0x0000001d
+        FILE_DEVICE_STREAMS             = 0x0000001e
+        FILE_DEVICE_TAPE                = 0x0000001f
+        FILE_DEVICE_TAPE_FILE_SYSTEM    = 0x00000020
+        FILE_DEVICE_TRANSPORT           = 0x00000021
+        FILE_DEVICE_UNKNOWN             = 0x00000022
+        FILE_DEVICE_VIDEO               = 0x00000023
+        FILE_DEVICE_VIRTUAL_DISK        = 0x00000024
+        FILE_DEVICE_WAVE_IN             = 0x00000025
+        FILE_DEVICE_WAVE_OUT            = 0x00000026
+        FILE_DEVICE_8042_PORT           = 0x00000027
+        FILE_DEVICE_NETWORK_REDIRECTOR  = 0x00000028
+        FILE_DEVICE_BATTERY             = 0x00000029
+        FILE_DEVICE_BUS_EXTENDER        = 0x0000002a
+        FILE_DEVICE_MODEM               = 0x0000002b
+        FILE_DEVICE_VDM                 = 0x0000002c
+        FILE_DEVICE_MASS_STORAGE        = 0x0000002d
+        FILE_DEVICE_SMB                 = 0x0000002e
+        FILE_DEVICE_KS                  = 0x0000002f
+        FILE_DEVICE_CHANGER             = 0x00000030
+        FILE_DEVICE_SMARTCARD           = 0x00000031
+        FILE_DEVICE_ACPI                = 0x00000032
+        FILE_DEVICE_DVD                 = 0x00000033
+        FILE_DEVICE_FULLSCREEN_VIDEO    = 0x00000034
+        FILE_DEVICE_DFS_FILE_SYSTEM     = 0x00000035
+        FILE_DEVICE_DFS_VOLUME          = 0x00000036
+        FILE_DEVICE_SERENUM             = 0x00000037
+        FILE_DEVICE_TERMSRV             = 0x00000038
+        FILE_DEVICE_KSEC                = 0x00000039
+        FILE_DEVICE_FIPS                = 0x0000003A
+        FILE_DEVICE_INFINIBAND          = 0x0000003B
+        FILE_DEVICE_VMBUS               = 0x0000003E
+        FILE_DEVICE_CRYPT_PROVIDER      = 0x0000003F
+        FILE_DEVICE_WPD                 = 0x00000040
+        FILE_DEVICE_BLUETOOTH           = 0x00000041
+        FILE_DEVICE_MT_COMPOSITE        = 0x00000042
+        FILE_DEVICE_MT_TRANSPORT        = 0x00000043
+        FILE_DEVICE_BIOMETRIC           = 0x00000044
+        FILE_DEVICE_PMI                 = 0x00000045
+
+        # Methods
+        METHOD_BUFFERED                 = 0
+        METHOD_IN_DIRECT                = 1
+        METHOD_OUT_DIRECT               = 2
+        METHOD_NEITHER                  = 3
+        METHOD_DIRECT_TO_HARDWARE       = METHOD_IN_DIRECT
+        METHOD_DIRECT_FROM_HARDWARE     = METHOD_OUT_DIRECT
+
+        # Access
+        FILE_ANY_ACCESS                 = 0
+        FILE_SPECIAL_ACCESS             = FILE_ANY_ACCESS
+        FILE_READ_ACCESS                = 0x0001
+        FILE_WRITE_ACCESS               = 0x0002
+
+        def self.CTL_CODE( device_type, function, method, access )
+          (device_type << 16) | (access << 14) | (function << 2) | method
+        end
+
+        FSCTL_GET_REPARSE_POINT         = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, FILE_ANY_ACCESS)
+
+        # Reparse point tags
+        IO_REPARSE_TAG_MOUNT_POINT              = 0xA0000003
+        IO_REPARSE_TAG_HSM                      = 0xC0000004
+        IO_REPARSE_TAG_HSM2                     = 0x80000006
+        IO_REPARSE_TAG_SIS                      = 0x80000007
+        IO_REPARSE_TAG_WIM                      = 0x80000008
+        IO_REPARSE_TAG_CSV                      = 0x80000009
+        IO_REPARSE_TAG_DFS                      = 0x8000000A
+        IO_REPARSE_TAG_SYMLINK                  = 0xA000000C
+        IO_REPARSE_TAG_DFSR                     = 0x80000012
+
+        MAXIMUM_REPARSE_DATA_BUFFER_SIZE        = 16*1024
+
         ###############################################
         # Win32 API Bindings
         ###############################################
@@ -147,6 +261,92 @@ typedef struct _BY_HANDLE_FILE_INFORMATION {
           :n_file_index_low, :DWORD
         end
 
+=begin
+typedef struct _REPARSE_DATA_BUFFER {
+  ULONG  ReparseTag;
+  USHORT ReparseDataLength;
+  USHORT Reserved;
+  union {
+    struct {
+      USHORT SubstituteNameOffset;
+      USHORT SubstituteNameLength;
+      USHORT PrintNameOffset;
+      USHORT PrintNameLength;
+      ULONG  Flags;
+      WCHAR  PathBuffer[1];
+    } SymbolicLinkReparseBuffer;
+    struct {
+      USHORT SubstituteNameOffset;
+      USHORT SubstituteNameLength;
+      USHORT PrintNameOffset;
+      USHORT PrintNameLength;
+      WCHAR  PathBuffer[1];
+    } MountPointReparseBuffer;
+    struct {
+      UCHAR DataBuffer[1];
+    } GenericReparseBuffer;
+  };
+} REPARSE_DATA_BUFFER, *PREPARSE_DATA_BUFFER;
+=end
+
+        class REPARSE_DATA_BUFFER_SYMBOLIC_LINK < FFI::Struct
+          layout :SubstituteNameOffset, :ushort,
+            :SubstituteNameLength, :ushort,
+            :PrintNameOffset, :ushort,
+            :PrintNameLength, :ushort,
+            :Flags, :uint32,
+            :PathBuffer, :ushort
+
+          def substitute_name
+            string_pointer = FFI::Pointer.new(pointer.address) + offset_of(:PathBuffer) + self[:SubstituteNameOffset]
+            string_pointer.read_wstring(self[:SubstituteNameLength]/2)
+          end
+          def print_name
+            string_pointer = FFI::Pointer.new(pointer.address) + offset_of(:PathBuffer) + self[:PrintNameOffset]
+            string_pointer.read_wstring(self[:PrintNameLength]/2)
+          end
+        end
+        class REPARSE_DATA_BUFFER_MOUNT_POINT < FFI::Struct
+          layout :SubstituteNameOffset, :ushort,
+            :SubstituteNameLength, :ushort,
+            :PrintNameOffset, :ushort,
+            :PrintNameLength, :ushort,
+            :PathBuffer, :ushort
+
+          def substitute_name
+            string_pointer = FFI::Pointer.new(pointer.address) + offset_of(:PathBuffer) + self[:SubstituteNameOffset]
+            string_pointer.read_wstring(self[:SubstituteNameLength]/2)
+          end
+          def print_name
+            string_pointer = FFI::Pointer.new(pointer.address) + offset_of(:PathBuffer) + self[:PrintNameOffset]
+            string_pointer.read_wstring(self[:PrintNameLength]/2)
+          end
+        end
+        class REPARSE_DATA_BUFFER_GENERIC < FFI::Struct
+          layout :DataBuffer, :uchar
+        end
+        class REPARSE_DATA_BUFFER_UNION < FFI::Union
+          layout :SymbolicLinkReparseBuffer, REPARSE_DATA_BUFFER_SYMBOLIC_LINK,
+            :MountPointReparseBuffer, REPARSE_DATA_BUFFER_MOUNT_POINT,
+            :GenericReparseBuffer, REPARSE_DATA_BUFFER_GENERIC
+        end
+        class REPARSE_DATA_BUFFER < FFI::Struct
+          layout :ReparseTag, :uint32,
+            :ReparseDataLength, :ushort,
+            :Reserved, :ushort,
+            :ReparseBuffer, REPARSE_DATA_BUFFER_UNION
+
+          def reparse_buffer
+            if self[:ReparseTag] == IO_REPARSE_TAG_SYMLINK
+              self[:ReparseBuffer][:SymbolicLinkReparseBuffer]
+            elsif self[:ReparseTag] == IO_REPARSE_TAG_MOUNT_POINT
+              self[:ReparseBuffer][:MountPointReparseBuffer]
+            else
+              self[:ReparseBuffer][:GenericReparseBuffer]
+            end
+          end
+        end
+
 =begin
 HANDLE WINAPI CreateFile(
   __in      LPCTSTR lpFileName,
@@ -158,21 +358,21 @@ HANDLE WINAPI CreateFile(
   __in_opt  HANDLE hTemplateFile
 );
 =end
-        attach_function :CreateFileW, [:LPCTSTR, :DWORD, :DWORD, :LPSECURITY_ATTRIBUTES, :DWORD, :DWORD, :pointer], :HANDLE
+        safe_attach_function :CreateFileW, [:LPCTSTR, :DWORD, :DWORD, :LPSECURITY_ATTRIBUTES, :DWORD, :DWORD, :pointer], :HANDLE
 
 =begin
 BOOL WINAPI FindClose(
   __inout  HANDLE hFindFile
 );
 =end
-        attach_function :FindClose, [:HANDLE], :BOOL
+        safe_attach_function :FindClose, [:HANDLE], :BOOL
 
 =begin
 DWORD WINAPI GetFileAttributes(
   __in  LPCTSTR lpFileName
 );
 =end
-        attach_function :GetFileAttributesW, [:LPCWSTR], :DWORD
+        safe_attach_function :GetFileAttributesW, [:LPCWSTR], :DWORD
 
 =begin
 DWORD WINAPI GetFinalPathNameByHandle(
@@ -182,7 +382,7 @@ DWORD WINAPI GetFinalPathNameByHandle(
   __in   DWORD dwFlags
 );
 =end
-        attach_function :GetFinalPathNameByHandleW, [:HANDLE, :LPTSTR, :DWORD, :DWORD], :DWORD
+        safe_attach_function :GetFinalPathNameByHandleW, [:HANDLE, :LPTSTR, :DWORD, :DWORD], :DWORD
 
 =begin
 BOOL WINAPI GetFileInformationByHandle(
@@ -190,7 +390,7 @@ BOOL WINAPI GetFileInformationByHandle(
   __out  LPBY_HANDLE_FILE_INFORMATION lpFileInformation
 );
 =end
-        attach_function :GetFileInformationByHandle, [:HANDLE, :LPBY_HANDLE_FILE_INFORMATION], :BOOL
+        safe_attach_function :GetFileInformationByHandle, [:HANDLE, :LPBY_HANDLE_FILE_INFORMATION], :BOOL
 
 =begin
 HANDLE WINAPI FindFirstFile(
@@ -198,7 +398,7 @@ HANDLE WINAPI FindFirstFile(
   __out  LPWIN32_FIND_DATA lpFindFileData
 );
 =end
-        attach_function :FindFirstFileW, [:LPCTSTR, :LPWIN32_FIND_DATA], :HANDLE
+        safe_attach_function :FindFirstFileW, [:LPCTSTR, :LPWIN32_FIND_DATA], :HANDLE
 
 =begin
 BOOL WINAPI CreateHardLink(
@@ -207,7 +407,7 @@ BOOL WINAPI CreateHardLink(
   __reserved  LPSECURITY_ATTRIBUTES lpSecurityAttributes
 );
 =end
-        attach_function :CreateHardLinkW, [:LPCTSTR, :LPCTSTR, :LPSECURITY_ATTRIBUTES], :BOOLEAN
+        safe_attach_function :CreateHardLinkW, [:LPCTSTR, :LPCTSTR, :LPSECURITY_ATTRIBUTES], :BOOLEAN
 
 =begin
 BOOLEAN WINAPI CreateSymbolicLink(
@@ -216,8 +416,39 @@ BOOLEAN WINAPI CreateSymbolicLink(
   __in  DWORD dwFlags
 );
 =end
-        attach_function :CreateSymbolicLinkW, [:LPTSTR, :LPTSTR, :DWORD], :BOOLEAN
+        safe_attach_function :CreateSymbolicLinkW, [:LPTSTR, :LPTSTR, :DWORD], :BOOLEAN
+
+=begin
+DWORD WINAPI GetLongPathName(
+  __in   LPCTSTR lpszShortPath,
+  __out  LPTSTR lpszLongPath,
+  __in   DWORD cchBuffer
+);
+=end
+        safe_attach_function :GetLongPathNameW, [:LPCTSTR, :LPTSTR, :DWORD], :DWORD
 
+=begin
+DWORD WINAPI GetShortPathName(
+  __in   LPCTSTR lpszLongPath,
+  __out  LPTSTR lpszShortPath,
+  __in   DWORD cchBuffer
+);
+=end
+        safe_attach_function :GetShortPathNameW, [:LPCTSTR, :LPTSTR, :DWORD], :DWORD
+
+=begin
+BOOL WINAPI DeviceIoControl(
+  __in         HANDLE hDevice,
+  __in         DWORD dwIoControlCode,
+  __in_opt     LPVOID lpInBuffer,
+  __in         DWORD nInBufferSize,
+  __out_opt    LPVOID lpOutBuffer,
+  __in         DWORD nOutBufferSize,
+  __out_opt    LPDWORD lpBytesReturned,
+  __inout_opt  LPOVERLAPPED lpOverlapped
+);
+=end
+        safe_attach_function :DeviceIoControl, [:HANDLE, :DWORD, :LPVOID, :DWORD, :LPVOID, :DWORD, :LPDWORD, :pointer], :BOOL
 
         ###############################################
         # Helpers
@@ -245,7 +476,7 @@ BOOLEAN WINAPI CreateSymbolicLink(
             find_data = WIN32_FIND_DATA.new
             handle = FindFirstFileW(path, find_data)
             if handle == INVALID_HANDLE_VALUE
-              Chef::Win32::Error.raise!
+              Chef::ReservedNames::Win32::Error.raise!
             end
             block.call(handle, find_data)
           ensure
@@ -260,10 +491,25 @@ BOOLEAN WINAPI CreateSymbolicLink(
           begin
             path = encode_path(path)
             handle = CreateFileW(path, GENERIC_READ, FILE_SHARE_READ,
-                                  nil, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nil)
+                                  nil, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_BACKUP_SEMANTICS, nil)
+
+            if handle == INVALID_HANDLE_VALUE
+              Chef::ReservedNames::Win32::Error.raise!
+            end
+            block.call(handle)
+          ensure
+            CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
+          end
+        end
+
+        def symlink_file_handle(path, &block)
+          begin
+            path = encode_path(path)
+            handle = CreateFileW(path, FILE_READ_EA, FILE_SHARE_READ,
+                                  nil, OPEN_EXISTING, FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, nil)
 
             if handle == INVALID_HANDLE_VALUE
-              Chef::Win32::Error.raise!
+              Chef::ReservedNames::Win32::Error.raise!
             end
             block.call(handle)
           ensure
@@ -277,7 +523,7 @@ BOOLEAN WINAPI CreateSymbolicLink(
             file_information = BY_HANDLE_FILE_INFORMATION.new
             success = GetFileInformationByHandle(handle, file_information)
             if success == 0
-              Chef::Win32::Error.raise!
+              Chef::ReservedNames::Win32::Error.raise!
             end
           end
           file_information