chef 0.10.8 → 0.10.10.beta.1

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

@@ -0,0 +1,178 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/win32/api'
+
+class Chef
+  module Win32
+    module API
+      module Unicode
+        extend Chef::Win32::API
+
+        ###############################################
+        # Win32 API Constants
+        ###############################################
+
+        CP_ACP         = 0
+        CP_OEMCP       = 1
+        CP_MACCP       = 2
+        CP_THREAD_ACP  = 3
+        CP_SYMBOL      = 42
+        CP_UTF7        = 65000
+        CP_UTF8        = 65001
+
+        MB_PRECOMPOSED       = 0x00000001
+        MB_COMPOSITE         = 0x00000002
+        MB_USEGLYPHCHARS     = 0x00000004
+        MB_ERR_INVALID_CHARS = 0x00000008
+
+        WC_COMPOSITECHECK    = 0x00000200
+        WC_DISCARDNS         = 0x00000010
+        WC_SEPCHARS          = 0x00000020
+        WC_DEFAULTCHAR       = 0x00000040
+        WC_NO_BEST_FIT_CHARS = 0x00000400
+
+        ANSI_CHARSET        = 0
+        DEFAULT_CHARSET     = 1
+        SYMBOL_CHARSET      = 2
+        SHIFTJIS_CHARSET    = 128
+        HANGEUL_CHARSET     = 129
+        HANGUL_CHARSET      = 129
+        GB2312_CHARSET      = 134
+        CHINESEBIG5_CHARSET = 136
+        OEM_CHARSET         = 255
+        JOHAB_CHARSET       = 130
+        HEBREW_CHARSET      = 177
+        ARABIC_CHARSET      = 178
+        GREEK_CHARSET       = 161
+        TURKISH_CHARSET     = 162
+        VIETNAMESE_CHARSET  = 163
+        THAI_CHARSET        = 222
+        EASTEUROPE_CHARSET  = 238
+        RUSSIAN_CHARSET     = 204
+
+        IS_TEXT_UNICODE_ASCII16            = 0x0001
+        IS_TEXT_UNICODE_REVERSE_ASCII16    = 0x0010
+        IS_TEXT_UNICODE_STATISTICS         = 0x0002
+        IS_TEXT_UNICODE_REVERSE_STATISTICS = 0x0020
+        IS_TEXT_UNICODE_CONTROLS           = 0x0004
+        IS_TEXT_UNICODE_REVERSE_CONTROLS   = 0x0040
+        IS_TEXT_UNICODE_SIGNATURE          = 0x0008
+        IS_TEXT_UNICODE_REVERSE_SIGNATURE  = 0x0080
+        IS_TEXT_UNICODE_ILLEGAL_CHARS      = 0x0100
+        IS_TEXT_UNICODE_ODD_LENGTH         = 0x0200
+        IS_TEXT_UNICODE_DBCS_LEADBYTE      = 0x0400
+        IS_TEXT_UNICODE_NULL_BYTES         = 0x1000
+        IS_TEXT_UNICODE_UNICODE_MASK       = 0x000F
+        IS_TEXT_UNICODE_REVERSE_MASK       = 0x00F0
+        IS_TEXT_UNICODE_NOT_UNICODE_MASK   = 0x0F00
+        IS_TEXT_UNICODE_NOT_ASCII_MASK     = 0xF000
+
+        TCI_SRCCHARSET  = 1
+        TCI_SRCCODEPAGE = 2
+        TCI_SRCFONTSIG  = 3
+        TCI_SRCLOCALE   = 0x100
+
+        ###############################################
+        # Win32 API Bindings
+        ###############################################
+
+        ffi_lib 'kernel32', 'advapi32'
+
+=begin
+BOOL IsTextUnicode(
+  __in     const VOID *lpv,
+  __in     int iSize,
+  __inout  LPINT lpiResult
+);
+=end
+        attach_function :IsTextUnicode, [:pointer, :int, :LPINT], :BOOL
+
+=begin
+int MultiByteToWideChar(
+  __in   UINT CodePage,
+  __in   DWORD dwFlags,
+  __in   LPCSTR lpMultiByteStr,
+  __in   int cbMultiByte,
+  __out  LPWSTR lpWideCharStr,
+  __in   int cchWideChar
+);
+=end
+        attach_function :MultiByteToWideChar, [:UINT, :DWORD, :LPCSTR, :int, :LPWSTR, :int], :int
+
+=begin
+int WideCharToMultiByte(
+  __in   UINT CodePage,
+  __in   DWORD dwFlags,
+  __in   LPCWSTR lpWideCharStr,
+  __in   int cchWideChar,
+  __out  LPSTR lpMultiByteStr,
+  __in   int cbMultiByte,
+  __in   LPCSTR lpDefaultChar,
+  __out  LPBOOL lpUsedDefaultChar
+);
+=end
+        attach_function :WideCharToMultiByte, [:UINT, :DWORD, :LPCWSTR, :int, :LPSTR, :int, :LPCSTR, :LPBOOL], :int
+
+        ###############################################
+        # Helpers
+        ###############################################
+
+        def utf8_to_wide(ustring)
+          # ensure it is actually UTF-8
+          # Ruby likes to mark binary data as ASCII-8BIT
+          ustring = (ustring + "").force_encoding('UTF-8') if ustring.respond_to?(:force_encoding) && ustring.encoding.name != "UTF-8"
+
+          # ensure we have the double-null termination Windows Wide likes
+          ustring = ustring << "\000\000" if ustring[-1].chr != "\000"
+
+          # encode it all as UTF-16LE AKA Windows Wide Character AKA Windows Unicode
+          ustring = begin
+            if ustring.respond_to?(:encode)
+              ustring.encode('UTF-16LE')
+            else
+              require 'iconv'
+              Iconv.conv("UTF-16LE", "UTF-8", ustring)
+            end
+          end
+          ustring
+        end
+
+        def wide_to_utf8(wstring)
+          # ensure it is actually UTF-16LE
+          # Ruby likes to mark binary data as ASCII-8BIT
+          wstring = wstring.force_encoding('UTF-16LE') if wstring.respond_to?(:force_encoding)
+
+          # encode it all as UTF-8
+          wstring = begin
+            if wstring.respond_to?(:encode)
+              wstring.encode('UTF-8')
+            else
+              require 'iconv'
+              Iconv.conv("UTF-8", "UTF-16LE", wstring)
+            end
+          end
+          # remove trailing CRLF and NULL characters
+          wstring.strip!
+          wstring
+        end
+
+      end
+    end
+  end
+end

data/lib/chef/win32/error.rb

@@ -0,0 +1,73 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/win32/api/error'
+require 'chef/win32/memory'
+require 'chef/win32/unicode'
+require 'chef/exceptions'
+
+class Chef
+  module Win32
+    class Error
+      include Chef::Win32::API::Error
+      extend Chef::Win32::API::Error
+
+      def self.format_message(message_id = 0, args = {})
+        flags = args[:flags] || FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ARGUMENT_ARRAY
+        source = args[:source]
+        language_id = args[:language_id] || 0
+        varargs = args[:varargs] || [:int, 0]
+        buffer = FFI::MemoryPointer.new :pointer
+        num_chars = FormatMessageW(flags | FORMAT_MESSAGE_ALLOCATE_BUFFER, source, message_id, language_id, buffer, 0, *varargs)
+        if num_chars == 0
+          raise!
+        end
+
+        # Extract the string
+        begin
+          return buffer.read_pointer.read_wstring(num_chars)
+        ensure
+          Chef::Win32::Memory.local_free(buffer.read_pointer)
+        end
+      end
+
+      def self.get_last_error
+        GetLastError()
+      end
+
+      # Raises the last error.  This should only be called by
+      # Win32 API wrapper functions, and then only when wrapped
+      # in an if() statement (since it unconditionally exits)
+      # === Returns
+      # nil::: always returns nil when it does not raise
+      # === Raises
+      # Chef::Exceptions::Win32APIError:::
+      def self.raise!(message = nil)
+        code = get_last_error
+        msg = format_message(code).strip
+        formatted_message = ""
+        formatted_message << message if message
+        formatted_message << "---- Begin Win32 API output ----\n"
+        formatted_message << "System Error Code: #{code}\n"
+        formatted_message << "System Error Message: #{msg}\n"
+        formatted_message << "---- End Win32 API output ----\n"
+        raise Chef::Exceptions::Win32APIError, msg + "\n" + formatted_message
+      end
+    end
+  end
+end

data/lib/chef/win32/file.rb

@@ -0,0 +1,117 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Mark Mzyk (<mmzyk@ospcode.com>)
+# Copyright:: Copyright 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/win32/api/file'
+require 'chef/win32/api/security'
+require 'chef/win32/error'
+
+class Chef
+  module Win32
+    class File
+      include Chef::Win32::API::File
+      extend Chef::Win32::API::File
+
+      # Creates a symbolic link called +new_name+ for the file or directory
+      # +old_name+.
+      #
+      # This method requires Windows Vista or later to work. Otherwise, it
+      # returns nil as per MRI.
+      #
+      def self.link(old_name, new_name)
+        raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name)
+        # TODO do a check for CreateHardLinkW and
+        # raise NotImplemented exception on older Windows
+        old_name = encode_path(old_name)
+        new_name = encode_path(new_name)
+        unless CreateHardLinkW(new_name, old_name, nil)
+          Chef::Win32::Error.raise!
+        end
+      end
+
+      # Creates a symbolic link called +new_name+ for the file or directory
+      # +old_name+.
+      #
+      # This method requires Windows Vista or later to work. Otherwise, it
+      # returns nil as per MRI.
+      #
+      def self.symlink(old_name, new_name)
+        raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name)
+        # TODO do a check for CreateSymbolicLinkW and
+        # raise NotImplemented exception on older Windows
+        flags = ::File.directory?(old_name) ? SYMBOLIC_LINK_FLAG_DIRECTORY : 0
+        old_name = encode_path(old_name)
+        new_name = encode_path(new_name)
+        unless CreateSymbolicLinkW(new_name, old_name, flags)
+          Chef::Win32::Error.raise!
+        end
+      end
+
+      # Return true if the named file is a symbolic link, false otherwise.
+      #
+      # This method requires Windows Vista or later to work. Otherwise, it
+      # always returns false as per MRI.
+      #
+      def self.symlink?(file_name)
+        is_symlink = false
+        path = encode_path(file_name)
+        if ::File.exists?(file_name)
+          if ((GetFileAttributesW(path) & FILE_ATTRIBUTE_REPARSE_POINT) > 0)
+            file_search_handle(file_name) do |handle, find_data|
+              if find_data[:dw_reserved_0] == IO_REPARSE_TAG_SYMLINK
+                is_symlink = true
+              end
+            end
+          end
+        end
+        is_symlink
+      end
+
+      # Returns the path of the of the symbolic link referred to by +file+.
+      #
+      # Requires Windows Vista or later. On older versions of Windows it
+      # will raise a NotImplementedError, as per MRI.
+      #
+      def self.readlink(link_name)
+        raise Errno::ENOENT, link_name unless ::File.exist?(link_name)
+        # TODO do a check for GetFinalPathNameByHandleW and
+        # raise NotImplemented exception on older Windows
+        file_handle(link_name) do |handle|
+          buffer = FFI::MemoryPointer.new(0.chr * MAX_PATH)
+          num_chars = GetFinalPathNameByHandleW(handle, buffer, buffer.size, FILE_NAME_NORMALIZED)
+          if num_chars == 0
+            Chef::Win32::Error.raise! #could be misleading if problem is too small buffer size as GetLastError won't report failure
+          end
+          buffer.read_wstring(num_chars).sub(path_prepender, "")
+        end
+      end
+
+      def self.info(file_name)
+        Info.new(file_name)
+      end
+
+      # ::File compat
+      class << self
+        alias :stat :info
+      end
+
+    end
+  end
+end
+
+require 'chef/win32/file/info'

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

@@ -0,0 +1,100 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/win32/file'
+
+class Chef
+  module Win32
+    class File
+
+      # Objects of class Chef::Win32::File::Stat encapsulate common status
+      # information for Chef::Win32::File objects. The information
+      # is recorded at the moment the Chef::Win32::File::Stat object is
+      # created; changes made to the file after that point will not be reflected.
+      class Info
+
+        include Chef::Win32::API::File
+        include Chef::Win32::API
+
+        # http://msdn.microsoft.com/en-us/library/windows/desktop/aa363788(v=vs.85).aspx
+        def initialize(file_name)
+          raise Errno::ENOENT, file_name unless ::File.exist?(file_name)
+          @file_info = retrieve_file_info(file_name)
+        end
+
+        def volume_serial_number
+          @file_info[:dw_volume_serial_number]
+        end
+
+        def index
+          make_uint64(@file_info[:n_file_index_low], @file_info[:n_file_index_high])
+        end
+
+        def last_access_time
+          parse_time(@file_info[:ft_last_access_time])
+        end
+
+        def creation_time
+          parse_time(@file_info[:ft_creation_time])
+        end
+
+        def last_write_time
+          parse_time(@file_info[:ft_last_write_time])
+        end
+
+        def links
+          @file_info[:n_number_of_links]
+        end
+
+        def size
+          make_uint64(@file_info[:n_file_size_low], @file_info[:n_file_size_high])
+        end
+
+        ##############################
+        # ::File::Stat compat
+        alias :atime :last_access_time
+        alias :mtime :last_write_time
+        alias :ctime :creation_time
+
+        # we're faking it here, but this is in the spirit of ino in *nix
+        #
+        # from MSDN:
+        #
+        # "The identifier (low and high parts) and the volume serial number
+        # uniquely identify a file on a single computer. To determine whether
+        # two open handles represent the same file, combine the identifier
+        # and the volume serial number for each file and compare them.""
+        #
+        def ino
+          volume_serial_number + index
+        end
+        ##############################
+
+        # given a +Chef::Win32::API::File::FILETIME+ structure convert into a
+        # Ruby +Time+ object.
+        #
+        def parse_time(file_time_struct)
+          wtime_to_time(make_uint64(file_time_struct[:dw_low_date_time],
+            file_time_struct[:dw_high_date_time]))
+        end
+
+
+      end
+    end
+  end
+end