bolt 0.19.1 → 0.20.0

data/vendored/puppet/lib/puppet/util/windows/error.rb

@@ -1,83 +0,0 @@
-require 'puppet/util/windows'
-
-# represents an error resulting from a Win32 error code
-class Puppet::Util::Windows::Error < Puppet::Error
-  require 'ffi'
-  extend FFI::Library
-
-  attr_reader :code
-
-  # NOTE: FFI.errno only works properly when prior Win32 calls have been made
-  # through FFI bindings.  Calls made through Win32API do not have their error
-  # codes captured by FFI.errno
-  def initialize(message, code = FFI.errno, original = nil)
-    super(message + ":  #{self.class.format_error_code(code)}", original)
-
-    @code = code
-  end
-
-  # Helper method that wraps FormatMessage that returns a human readable string.
-  def self.format_error_code(code)
-    # specifying 0 will look for LANGID in the following order
-    # 1.Language neutral
-    # 2.Thread LANGID, based on the thread's locale value
-    # 3.User default LANGID, based on the user's default locale value
-    # 4.System default LANGID, based on the system default locale value
-    # 5.US English
-    dwLanguageId = 0
-    flags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
-            FORMAT_MESSAGE_FROM_SYSTEM |
-            FORMAT_MESSAGE_ARGUMENT_ARRAY |
-            FORMAT_MESSAGE_IGNORE_INSERTS |
-            FORMAT_MESSAGE_MAX_WIDTH_MASK
-    error_string = ''
-
-    # this pointer actually points to a :lpwstr (pointer) since we're letting Windows allocate for us
-    FFI::MemoryPointer.new(:pointer, 1) do |buffer_ptr|
-      length = FormatMessageW(flags, FFI::Pointer::NULL, code, dwLanguageId,
-        buffer_ptr, 0, FFI::Pointer::NULL)
-
-      if length == FFI::WIN32_FALSE
-        # can't raise same error type here or potentially recurse infinitely
-        raise Puppet::Error.new(_("FormatMessageW could not format code %{code}") % { code: code })
-      end
-
-      # returns an FFI::Pointer with autorelease set to false, which is what we want
-      buffer_ptr.read_win32_local_pointer do |wide_string_ptr|
-        if wide_string_ptr.null?
-          raise Puppet::Error.new(_("FormatMessageW failed to allocate buffer for code %{code}") % { code: code })
-        end
-
-        error_string = wide_string_ptr.read_wide_string(length)
-      end
-    end
-
-    error_string
-  end
-
-  ERROR_FILE_NOT_FOUND      = 2
-  ERROR_ACCESS_DENIED       = 5
-
-  FORMAT_MESSAGE_ALLOCATE_BUFFER   = 0x00000100
-  FORMAT_MESSAGE_IGNORE_INSERTS    = 0x00000200
-  FORMAT_MESSAGE_FROM_SYSTEM       = 0x00001000
-  FORMAT_MESSAGE_ARGUMENT_ARRAY    = 0x00002000
-  FORMAT_MESSAGE_MAX_WIDTH_MASK    = 0x000000FF
-
-  ffi_convention :stdcall
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx
-  # DWORD WINAPI FormatMessage(
-  #   _In_      DWORD dwFlags,
-  #   _In_opt_  LPCVOID lpSource,
-  #   _In_      DWORD dwMessageId,
-  #   _In_      DWORD dwLanguageId,
-  #   _Out_     LPTSTR lpBuffer,
-  #   _In_      DWORD nSize,
-  #   _In_opt_  va_list *Arguments
-  # );
-  # NOTE: since we're not preallocating the buffer, use a :pointer for lpBuffer
-  ffi_lib :kernel32
-  attach_function_private :FormatMessageW,
-    [:dword, :lpcvoid, :dword, :dword, :pointer, :dword, :pointer], :dword
-end

data/vendored/puppet/lib/puppet/util/windows/eventlog.rb

@@ -1,197 +0,0 @@
-require 'ffi'
-
-# Puppet::Util::Windows::EventLog needs to be requirable without having loaded
-# any other parts of Puppet so it can be leveraged independently by the code
-# that runs Puppet as a service on Windows.
-#
-# For this reason we:
-# - Define Puppet::Util::Windows
-# - Replicate logic that exists elsewhere in puppet/util/windows
-# - Raise generic RuntimeError instead of Puppet::Util::Windows::Error if its not defined
-module Puppet; module Util; module Windows ; end ; end ; end
-
-class Puppet::Util::Windows::EventLog
-  extend FFI::Library
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363679(v=vs.85).aspx
-  EVENTLOG_ERROR_TYPE       = 0x0001
-  EVENTLOG_WARNING_TYPE     = 0x0002
-  EVENTLOG_INFORMATION_TYPE = 0x0004
-
-  # These are duplicate definitions from Puppet::Util::Windows::ApiTypes,
-  # established here so this class can be standalone from Puppet, and public so
-  # we can reference them in tests.
-  NULL_HANDLE = 0
-  WIN32_FALSE = 0
-
-  # Register an event log handle for the application
-  # @param source_name [String] the name of the event source to retrieve a handle for
-  # @return [void]
-  # @api public
-  def initialize(source_name = 'Puppet')
-    @eventlog_handle = RegisterEventSourceW(FFI::Pointer::NULL, wide_string(source_name))
-    if @eventlog_handle == NULL_HANDLE
-      #TRANSLATORS 'Windows' is the operating system and 'RegisterEventSourceW' is a API call and should not be translated
-      raise EventLogError.new(_("RegisterEventSourceW failed to open Windows eventlog"), FFI.errno)
-    end
-  end
-
-  # Close this instance's event log handle
-  # @return [void]
-  # @api public
-  def close
-    DeregisterEventSource(@eventlog_handle)
-  ensure
-    @eventlog_handle = nil
-  end
-
-  # Report an event to this instance's event log handle. Accepts a string to
-  #   report (:data => <string>) and event type (:event_type => FixNum) and id
-  # (:event_id => FixNum) as returned by #to_native. The additional arguments to
-  # ReportEventW seen in this method aren't exposed - though ReportEventW
-  # technically can accept multiple strings as well as raw binary data to log,
-  # we accept a single string from Puppet::Util::Log
-  #
-  # @param args [Hash{Symbol=>Object}] options to the associated log event
-  # @return [void]
-  # @api public
-  def report_event(args = {})
-    unless args[:data].is_a?(String)
-      raise ArgumentError, _("data must be a string, not %{class_name}") % { class_name: args[:data].class }
-    end
-    from_string_to_wide_string(args[:data]) do |message_ptr|
-      FFI::MemoryPointer.new(:pointer) do |message_array_ptr|
-        message_array_ptr.write_pointer(message_ptr)
-        user_sid = FFI::Pointer::NULL
-        raw_data = FFI::Pointer::NULL
-        raw_data_size = 0
-        num_strings = 1
-        eventlog_category = 0
-        report_result = ReportEventW(@eventlog_handle, args[:event_type],
-          eventlog_category, args[:event_id], user_sid,
-          num_strings, raw_data_size, message_array_ptr, raw_data)
-
-        if report_result == WIN32_FALSE
-          #TRANSLATORS 'Windows' is the operating system and 'ReportEventW' is a API call and should not be translated
-          raise EventLogError.new(_("ReportEventW failed to report event to Windows eventlog"), FFI.errno)
-        end
-      end
-    end
-  end
-
-  class << self
-    # Feels more natural to do Puppet::Util::Window::EventLog.open("MyApplication")
-    alias :open :new
-
-    # Query event identifier info for a given log level
-    # @param level [Symbol] an event log level
-    # @return [Array] Win API Event ID, Puppet Event ID
-    # @api public
-    def to_native(level)
-      case level
-      when :debug,:info,:notice
-        [EVENTLOG_INFORMATION_TYPE, 0x01]
-      when :warning
-        [EVENTLOG_WARNING_TYPE, 0x02]
-      when :err,:alert,:emerg,:crit
-        [EVENTLOG_ERROR_TYPE, 0x03]
-      else
-        raise ArgumentError, _("Invalid log level %{level}") % { level: level }
-      end
-    end
-  end
-
-  private
-  # For the purposes of allowing this class to be standalone, the following are
-  # duplicate definitions from elsewhere in Puppet:
-
-  # If we're loaded via Puppet we should keep the previous behavior of raising
-  # Puppet::Util::Windows::Error on errors. If we aren't, at least concatenate
-  # the error code to the exception message to pass this information on to the
-  # user
-  if defined?(Puppet::Util::Windows::Error)
-    EventLogError = Puppet::Util::Windows::Error
-  else
-    class EventLogError < RuntimeError
-      def initialize(msg, code)
-        #TRANSLATORS 'Win32' is the Windows API and should not be translated
-        super(msg + ' ' + _("(Win32 error: %{detail})") % { detail: code})
-      end
-    end
-  end
-
-  # Private duplicate of Puppet::Util::Windows::String::wide_string
-  # Not for use outside of EventLog! - use Puppet::Util::Windows instead
-  # @api private
-  def wide_string(str)
-    # if given a nil string, assume caller wants to pass a nil pointer to win32
-    return nil if str.nil?
-    # ruby (< 2.1) does not respect multibyte terminators, so it is possible
-    # for a string to contain a single trailing null byte, followed by garbage
-    # causing buffer overruns.
-    #
-    # See http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?revision=41920&view=revision
-    newstr = str + "\0".encode(str.encoding)
-    newstr.encode!('UTF-16LE')
-  end
-
-  # Private duplicate of Puppet::Util::Windows::ApiTypes::from_string_to_wide_string
-  # Not for use outside of EventLog! - Use Puppet::Util::Windows instead
-  # @api private
-  def from_string_to_wide_string(str, &block)
-    str = wide_string(str)
-    FFI::MemoryPointer.new(:uchar, str.bytesize) do |ptr|
-      # uchar here is synonymous with byte
-      ptr.put_array_of_uchar(0, str.bytes.to_a)
-
-      yield ptr
-    end
-
-    # ptr has already had free called, so nothing to return
-    nil
-  end
-
-  ffi_convention :stdcall
-
-  # The following are typedefs in Puppet::Util::Winodws::ApiTypes, but here we
-  # use their original FFI counterparts:
-  # :uintptr_t for :handle
-  # :int32 for :win32_bool
-  # :uint16 for :word
-  # :uint32 for :dword
-  # :pointer for :lpvoid
-  # :uchar for :byte
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363678(v=vs.85).aspx
-  # HANDLE RegisterEventSource(
-  # _In_ LPCTSTR lpUNCServerName,
-  # _In_ LPCTSTR lpSourceName
-  # );
-  ffi_lib :advapi32
-  attach_function :RegisterEventSourceW, [:buffer_in, :buffer_in], :uintptr_t
-  private :RegisterEventSourceW
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363642(v=vs.85).aspx
-  # BOOL DeregisterEventSource(
-  # _Inout_ HANDLE hEventLog
-  # );
-  ffi_lib :advapi32
-  attach_function :DeregisterEventSource, [:uintptr_t], :int32
-  private :DeregisterEventSource
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363679(v=vs.85).aspx
-  # BOOL ReportEvent(
-  #   _In_ HANDLE  hEventLog,
-  #   _In_ WORD    wType,
-  #   _In_ WORD    wCategory,
-  #   _In_ DWORD   dwEventID,
-  #   _In_ PSID    lpUserSid,
-  #   _In_ WORD    wNumStrings,
-  #   _In_ DWORD   dwDataSize,
-  #   _In_ LPCTSTR *lpStrings,
-  #   _In_ LPVOID  lpRawData
-  # );
-  ffi_lib :advapi32
-  attach_function :ReportEventW, [:uintptr_t, :uint16, :uint16, :uint32, :pointer, :uint16, :uint32, :pointer, :pointer], :int32
-  private :ReportEventW
-end

data/vendored/puppet/lib/puppet/util/windows/file.rb

@@ -1,571 +0,0 @@
-require 'puppet/util/windows'
-
-module Puppet::Util::Windows::File
-  require 'ffi'
-  extend FFI::Library
-  extend Puppet::Util::Windows::String
-
-  FILE_ATTRIBUTE_READONLY      = 0x00000001
-
-  SYNCHRONIZE                 = 0x100000
-  STANDARD_RIGHTS_REQUIRED    = 0xf0000
-  STANDARD_RIGHTS_READ        = 0x20000
-  STANDARD_RIGHTS_WRITE       = 0x20000
-  STANDARD_RIGHTS_EXECUTE     = 0x20000
-  STANDARD_RIGHTS_ALL         = 0x1F0000
-  SPECIFIC_RIGHTS_ALL         = 0xFFFF
-
-  FILE_READ_DATA               = 1
-  FILE_WRITE_DATA              = 2
-  FILE_APPEND_DATA             = 4
-  FILE_READ_EA                 = 8
-  FILE_WRITE_EA                = 16
-  FILE_EXECUTE                 = 32
-  FILE_DELETE_CHILD            = 64
-  FILE_READ_ATTRIBUTES         = 128
-  FILE_WRITE_ATTRIBUTES        = 256
-
-  FILE_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x1FF
-
-  FILE_GENERIC_READ =
-     STANDARD_RIGHTS_READ |
-     FILE_READ_DATA |
-     FILE_READ_ATTRIBUTES |
-     FILE_READ_EA |
-     SYNCHRONIZE
-
-  FILE_GENERIC_WRITE =
-     STANDARD_RIGHTS_WRITE |
-     FILE_WRITE_DATA |
-     FILE_WRITE_ATTRIBUTES |
-     FILE_WRITE_EA |
-     FILE_APPEND_DATA |
-     SYNCHRONIZE
-
-  FILE_GENERIC_EXECUTE =
-     STANDARD_RIGHTS_EXECUTE |
-     FILE_READ_ATTRIBUTES |
-     FILE_EXECUTE |
-     SYNCHRONIZE
-
-  REPLACEFILE_WRITE_THROUGH         = 0x1
-  REPLACEFILE_IGNORE_MERGE_ERRORS   = 0x2
-  REPLACEFILE_IGNORE_ACL_ERRORS     = 0x3
-
-  def replace_file(target, source)
-    target_encoded = wide_string(target.to_s)
-    source_encoded = wide_string(source.to_s)
-
-    flags = REPLACEFILE_IGNORE_MERGE_ERRORS
-    backup_file = nil
-    result = ReplaceFileW(
-      target_encoded,
-      source_encoded,
-      backup_file,
-      flags,
-      FFI::Pointer::NULL,
-      FFI::Pointer::NULL
-    )
-
-    return true if result != FFI::WIN32_FALSE
-    raise Puppet::Util::Windows::Error.new("ReplaceFile(#{target}, #{source})")
-  end
-  module_function :replace_file
-
-  def move_file_ex(source, target, flags = 0)
-    result = MoveFileExW(wide_string(source.to_s),
-                         wide_string(target.to_s),
-                         flags)
-
-    return true if result != FFI::WIN32_FALSE
-    raise Puppet::Util::Windows::Error.
-      new("MoveFileEx(#{source}, #{target}, #{flags.to_s(8)})")
-  end
-  module_function :move_file_ex
-
-  def symlink(target, symlink)
-    flags = File.directory?(target) ? 0x1 : 0x0
-    result = CreateSymbolicLinkW(wide_string(symlink.to_s),
-      wide_string(target.to_s), flags)
-    return true if result != FFI::WIN32_FALSE
-    raise Puppet::Util::Windows::Error.new(
-      "CreateSymbolicLink(#{symlink}, #{target}, #{flags.to_s(8)})")
-  end
-  module_function :symlink
-
-
-  def exist?(path)
-    path = path.to_str if path.respond_to?(:to_str) # support WatchedFile
-    path = path.to_s # support String and Pathname
-
-    seen_paths = []
-    # follow up to 64 symlinks before giving up
-    0.upto(64) do |depth|
-      # return false if this path has been seen before.  This is protection against circular symlinks
-      return false if seen_paths.include?(path.downcase)
-
-      result = get_attributes(path,false)
-
-      # return false for path not found
-      return false if result == INVALID_FILE_ATTRIBUTES
-
-      # return true if path exists and it's not a symlink
-      # Other file attributes are ignored. https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117(v=vs.85).aspx
-      reparse_point = (result & FILE_ATTRIBUTE_REPARSE_POINT) == FILE_ATTRIBUTE_REPARSE_POINT
-      if reparse_point && symlink_reparse_point?(path)
-        # walk the symlink and try again...
-        seen_paths << path.downcase
-        path = readlink(path)
-      else
-        # file was found and its not a symlink
-        return true
-      end
-    end
-
-    false
-  end
-  module_function :exist?
-
-
-  INVALID_FILE_ATTRIBUTES = 0xFFFFFFFF #define INVALID_FILE_ATTRIBUTES (DWORD (-1))
-
-  def get_attributes(file_name, raise_on_invalid = true)
-    result = GetFileAttributesW(wide_string(file_name.to_s))
-    if raise_on_invalid && result == INVALID_FILE_ATTRIBUTES
-      raise Puppet::Util::Windows::Error.new("GetFileAttributes(#{file_name})")
-    end
-
-    result
-  end
-  module_function :get_attributes
-
-  def add_attributes(path, flags)
-    oldattrs = get_attributes(path)
-
-    if (oldattrs | flags) != oldattrs
-      set_attributes(path, oldattrs | flags)
-    end
-  end
-  module_function :add_attributes
-
-  def remove_attributes(path, flags)
-    oldattrs = get_attributes(path)
-
-    if (oldattrs & ~flags) != oldattrs
-      set_attributes(path, oldattrs & ~flags)
-    end
-  end
-  module_function :remove_attributes
-
-  def set_attributes(path, flags)
-    success = SetFileAttributesW(wide_string(path), flags) != FFI::WIN32_FALSE
-    raise Puppet::Util::Windows::Error.new(_("Failed to set file attributes")) if !success
-
-    success
-  end
-  module_function :set_attributes
-
-  #define INVALID_HANDLE_VALUE ((HANDLE)(LONG_PTR)-1)
-  INVALID_HANDLE_VALUE = FFI::Pointer.new(-1).address
-  def self.create_file(file_name, desired_access, share_mode, security_attributes,
-    creation_disposition, flags_and_attributes, template_file_handle)
-
-    result = CreateFileW(wide_string(file_name.to_s),
-      desired_access, share_mode, security_attributes, creation_disposition,
-      flags_and_attributes, template_file_handle)
-
-    return result unless result == INVALID_HANDLE_VALUE
-    raise Puppet::Util::Windows::Error.new(
-      "CreateFile(#{file_name}, #{desired_access.to_s(8)}, #{share_mode.to_s(8)}, " +
-        "#{security_attributes}, #{creation_disposition.to_s(8)}, " +
-        "#{flags_and_attributes.to_s(8)}, #{template_file_handle})")
-  end
-
-  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
-  IO_REPARSE_TAG_DEDUP        = 0x80000013
-  IO_REPARSE_TAG_NFS          = 0x80000014
-
-  def self.get_reparse_point_data(handle, &block)
-    # must be multiple of 1024, min 10240
-    FFI::MemoryPointer.new(MAXIMUM_REPARSE_DATA_BUFFER_SIZE) do |reparse_data_buffer_ptr|
-      device_io_control(handle, FSCTL_GET_REPARSE_POINT, nil, reparse_data_buffer_ptr)
-
-      reparse_tag = reparse_data_buffer_ptr.read_win32_ulong
-      buffer_type = case reparse_tag
-      when IO_REPARSE_TAG_SYMLINK
-        SYMLINK_REPARSE_DATA_BUFFER
-      when IO_REPARSE_TAG_MOUNT_POINT
-        MOUNT_POINT_REPARSE_DATA_BUFFER
-      when IO_REPARSE_TAG_NFS
-        raise Puppet::Util::Windows::Error.new("Retrieving NFS reparse point data is unsupported")
-      else
-        raise Puppet::Util::Windows::Error.new("DeviceIoControl(#{handle}, " +
-          "FSCTL_GET_REPARSE_POINT) returned unknown tag 0x#{reparse_tag.to_s(16).upcase}")
-      end
-
-      yield buffer_type.new(reparse_data_buffer_ptr)
-    end
-
-    # underlying struct MemoryPointer has been cleaned up by this point, nothing to return
-    nil
-  end
-
-  def self.get_reparse_point_tag(handle)
-    reparse_tag = nil
-
-    # must be multiple of 1024, min 10240
-    FFI::MemoryPointer.new(MAXIMUM_REPARSE_DATA_BUFFER_SIZE) do |reparse_data_buffer_ptr|
-      device_io_control(handle, FSCTL_GET_REPARSE_POINT, nil, reparse_data_buffer_ptr)
-
-      # DWORD ReparseTag is the first member of the struct
-      reparse_tag = reparse_data_buffer_ptr.read_win32_ulong
-    end
-
-    reparse_tag
-  end
-
-  def self.device_io_control(handle, io_control_code, in_buffer = nil, out_buffer = nil)
-    if out_buffer.nil?
-      raise Puppet::Util::Windows::Error.new(_("out_buffer is required"))
-    end
-
-    FFI::MemoryPointer.new(:dword, 1) do |bytes_returned_ptr|
-      result = DeviceIoControl(
-        handle,
-        io_control_code,
-        in_buffer, in_buffer.nil? ? 0 : in_buffer.size,
-        out_buffer, out_buffer.size,
-        bytes_returned_ptr,
-        nil
-      )
-
-      if result == FFI::WIN32_FALSE
-        raise Puppet::Util::Windows::Error.new(
-          "DeviceIoControl(#{handle}, #{io_control_code}, " +
-          "#{in_buffer}, #{in_buffer ? in_buffer.size : ''}, " +
-          "#{out_buffer}, #{out_buffer ? out_buffer.size : ''}")
-      end
-    end
-
-    out_buffer
-  end
-
-  FILE_ATTRIBUTE_REPARSE_POINT = 0x400
-  def reparse_point?(file_name)
-    attributes = get_attributes(file_name, false)
-
-    return false if (attributes == INVALID_FILE_ATTRIBUTES)
-    (attributes & FILE_ATTRIBUTE_REPARSE_POINT) == FILE_ATTRIBUTE_REPARSE_POINT
-  end
-  module_function :reparse_point?
-
-  def symlink?(file_name)
-    # Puppet currently only handles mount point and symlink reparse points, ignores others
-    reparse_point?(file_name) && symlink_reparse_point?(file_name)
-  end
-  module_function :symlink?
-
-  GENERIC_READ                  = 0x80000000
-  GENERIC_WRITE                 = 0x40000000
-  GENERIC_EXECUTE               = 0x20000000
-  GENERIC_ALL                   = 0x10000000
-  FILE_SHARE_READ               = 1
-  FILE_SHARE_WRITE              = 2
-  OPEN_EXISTING                 = 3
-  FILE_FLAG_OPEN_REPARSE_POINT  = 0x00200000
-  FILE_FLAG_BACKUP_SEMANTICS    = 0x02000000
-
-  def self.open_symlink(link_name)
-    begin
-      yield handle = create_file(
-      link_name,
-      GENERIC_READ,
-      FILE_SHARE_READ,
-      nil, # security_attributes
-      OPEN_EXISTING,
-      FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
-      0) # template_file
-    ensure
-      FFI::WIN32.CloseHandle(handle) if handle
-    end
-
-    # handle has had CloseHandle called against it, so nothing to return
-    nil
-  end
-
-  def readlink(link_name)
-    link = nil
-    open_symlink(link_name) do |handle|
-      link = resolve_symlink(handle)
-    end
-
-    link
-  end
-  module_function :readlink
-
-  ERROR_FILE_NOT_FOUND = 2
-  ERROR_PATH_NOT_FOUND = 3
-
-  def get_long_pathname(path)
-    converted = ''
-    FFI::Pointer.from_string_to_wide_string(path) do |path_ptr|
-      # includes terminating NULL
-      buffer_size = GetLongPathNameW(path_ptr, FFI::Pointer::NULL, 0)
-      FFI::MemoryPointer.new(:wchar, buffer_size) do |converted_ptr|
-        if GetLongPathNameW(path_ptr, converted_ptr, buffer_size) == FFI::WIN32_FALSE
-          raise Puppet::Util::Windows::Error.new(_("Failed to call GetLongPathName"))
-        end
-
-        converted = converted_ptr.read_wide_string(buffer_size - 1)
-      end
-    end
-
-    converted
-  end
-  module_function :get_long_pathname
-
-  def get_short_pathname(path)
-    converted = ''
-    FFI::Pointer.from_string_to_wide_string(path) do |path_ptr|
-      # includes terminating NULL
-      buffer_size = GetShortPathNameW(path_ptr, FFI::Pointer::NULL, 0)
-      FFI::MemoryPointer.new(:wchar, buffer_size) do |converted_ptr|
-        if GetShortPathNameW(path_ptr, converted_ptr, buffer_size) == FFI::WIN32_FALSE
-          raise Puppet::Util::Windows::Error.new("Failed to call GetShortPathName")
-        end
-
-        converted = converted_ptr.read_wide_string(buffer_size - 1)
-      end
-    end
-
-    converted
-  end
-  module_function :get_short_pathname
-
-  def stat(file_name)
-    file_name = file_name.to_s # accommodate PathName or String
-    stat = File.stat(file_name)
-    singleton_class = class << stat; self; end
-    target_path = file_name
-
-    if symlink?(file_name)
-      target_path = readlink(file_name)
-      link_ftype = File.stat(target_path).ftype
-
-      # sigh, monkey patch instance method for instance, and close over link_ftype
-      singleton_class.send(:define_method, :ftype) do
-        link_ftype
-      end
-    end
-
-    singleton_class.send(:define_method, :mode) do
-      Puppet::Util::Windows::Security.get_mode(target_path)
-    end
-
-    stat
-  end
-  module_function :stat
-
-  def lstat(file_name)
-    file_name = file_name.to_s # accommodate PathName or String
-    # monkey'ing around!
-    stat = File.lstat(file_name)
-
-    singleton_class = class << stat; self; end
-    singleton_class.send(:define_method, :mode) do
-      Puppet::Util::Windows::Security.get_mode(file_name)
-    end
-
-    if symlink?(file_name)
-      def stat.ftype
-        "link"
-      end
-    end
-    stat
-  end
-  module_function :lstat
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364571(v=vs.85).aspx
-  FSCTL_GET_REPARSE_POINT = 0x900a8
-
-  def self.resolve_symlink(handle)
-    path = nil
-    get_reparse_point_data(handle) do |reparse_data|
-      offset = reparse_data[:PrintNameOffset]
-      length = reparse_data[:PrintNameLength]
-
-      ptr = reparse_data.pointer + reparse_data.offset_of(:PathBuffer) + offset
-      path = ptr.read_wide_string(length / 2) # length is bytes, need UTF-16 wchars
-    end
-
-    path
-  end
-  private_class_method :resolve_symlink
-
-  # these reparse point types are the only ones Puppet currently understands
-  # so rather than raising an exception in readlink, prefer to not consider
-  # the path a symlink when stat'ing later
-  def self.symlink_reparse_point?(path)
-    symlink = false
-
-    open_symlink(path) do |handle|
-      symlink = [
-        IO_REPARSE_TAG_SYMLINK,
-        IO_REPARSE_TAG_MOUNT_POINT
-      ].include?(get_reparse_point_tag(handle))
-    end
-
-    symlink
-  end
-  private_class_method :symlink_reparse_point?
-
-  ffi_convention :stdcall
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365512(v=vs.85).aspx
-  # BOOL WINAPI ReplaceFile(
-  #   _In_        LPCTSTR lpReplacedFileName,
-  #   _In_        LPCTSTR lpReplacementFileName,
-  #   _In_opt_    LPCTSTR lpBackupFileName,
-  #   _In_        DWORD dwReplaceFlags - 0x1 REPLACEFILE_WRITE_THROUGH,
-  #                                      0x2 REPLACEFILE_IGNORE_MERGE_ERRORS,
-  #                                      0x4 REPLACEFILE_IGNORE_ACL_ERRORS
-  #   _Reserved_  LPVOID lpExclude,
-  #   _Reserved_  LPVOID lpReserved
-  # );
-  ffi_lib :kernel32
-  attach_function_private :ReplaceFileW,
-    [:lpcwstr, :lpcwstr, :lpcwstr, :dword, :lpvoid, :lpvoid], :win32_bool
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx
-  # BOOL WINAPI MoveFileEx(
-  #   _In_      LPCTSTR lpExistingFileName,
-  #   _In_opt_  LPCTSTR lpNewFileName,
-  #   _In_      DWORD dwFlags
-  # );
-  ffi_lib :kernel32
-  attach_function_private :MoveFileExW,
-    [:lpcwstr, :lpcwstr, :dword], :win32_bool
-
-  # BOOLEAN WINAPI CreateSymbolicLink(
-  #   _In_  LPTSTR lpSymlinkFileName, - symbolic link to be created
-  #   _In_  LPTSTR lpTargetFileName, - name of target for symbolic link
-  #   _In_  DWORD dwFlags - 0x0 target is a file, 0x1 target is a directory
-  # );
-  # rescue on Windows < 6.0 so that code doesn't explode
-  begin
-    ffi_lib :kernel32
-    attach_function_private :CreateSymbolicLinkW,
-      [:lpwstr, :lpwstr, :dword], :boolean
-  rescue LoadError
-  end
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364944(v=vs.85).aspx
-  # DWORD WINAPI GetFileAttributes(
-  #   _In_  LPCTSTR lpFileName
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetFileAttributesW,
-    [:lpcwstr], :dword
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365535(v=vs.85).aspx
-  # BOOL WINAPI SetFileAttributes(
-  #   _In_  LPCTSTR lpFileName,
-  #   _In_  DWORD dwFileAttributes
-  # );
-  ffi_lib :kernel32
-  attach_function_private :SetFileAttributesW,
-    [:lpcwstr, :dword], :win32_bool
-
-  # HANDLE WINAPI CreateFile(
-  #   _In_      LPCTSTR lpFileName,
-  #   _In_      DWORD dwDesiredAccess,
-  #   _In_      DWORD dwShareMode,
-  #   _In_opt_  LPSECURITY_ATTRIBUTES lpSecurityAttributes,
-  #   _In_      DWORD dwCreationDisposition,
-  #   _In_      DWORD dwFlagsAndAttributes,
-  #   _In_opt_  HANDLE hTemplateFile
-  # );
-  ffi_lib :kernel32
-  attach_function_private :CreateFileW,
-    [:lpcwstr, :dword, :dword, :pointer, :dword, :dword, :handle], :handle
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363216(v=vs.85).aspx
-  # 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
-  # );
-  ffi_lib :kernel32
-  attach_function_private :DeviceIoControl,
-    [:handle, :dword, :lpvoid, :dword, :lpvoid, :dword, :lpdword, :pointer], :win32_bool
-
-  MAXIMUM_REPARSE_DATA_BUFFER_SIZE = 16384
-
-  # SYMLINK_REPARSE_DATA_BUFFER
-  # https://msdn.microsoft.com/en-us/library/cc232006.aspx
-  # https://msdn.microsoft.com/en-us/library/windows/hardware/ff552012(v=vs.85).aspx
-  # struct is always MAXIMUM_REPARSE_DATA_BUFFER_SIZE bytes
-  class SYMLINK_REPARSE_DATA_BUFFER < FFI::Struct
-    layout :ReparseTag, :win32_ulong,
-           :ReparseDataLength, :ushort,
-           :Reserved, :ushort,
-           :SubstituteNameOffset, :ushort,
-           :SubstituteNameLength, :ushort,
-           :PrintNameOffset, :ushort,
-           :PrintNameLength, :ushort,
-           :Flags, :win32_ulong,
-           # max less above fields dword / uint 4 bytes, ushort 2 bytes
-           # technically a WCHAR buffer, but we care about size in bytes here
-           :PathBuffer, [:byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE - 20]
-  end
-
-  # MOUNT_POINT_REPARSE_DATA_BUFFER
-  # https://msdn.microsoft.com/en-us/library/cc232007.aspx
-  # https://msdn.microsoft.com/en-us/library/windows/hardware/ff552012(v=vs.85).aspx
-  # struct is always MAXIMUM_REPARSE_DATA_BUFFER_SIZE bytes
-  class MOUNT_POINT_REPARSE_DATA_BUFFER < FFI::Struct
-    layout :ReparseTag, :win32_ulong,
-           :ReparseDataLength, :ushort,
-           :Reserved, :ushort,
-           :SubstituteNameOffset, :ushort,
-           :SubstituteNameLength, :ushort,
-           :PrintNameOffset, :ushort,
-           :PrintNameLength, :ushort,
-           # max less above fields dword / uint 4 bytes, ushort 2 bytes
-           # technically a WCHAR buffer, but we care about size in bytes here
-           :PathBuffer, [:byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE - 16]
-  end
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364980(v=vs.85).aspx
-  # DWORD WINAPI GetLongPathName(
-  #   _In_  LPCTSTR lpszShortPath,
-  #   _Out_ LPTSTR  lpszLongPath,
-  #   _In_  DWORD   cchBuffer
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetLongPathNameW,
-    [:lpcwstr, :lpwstr, :dword], :dword
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364989(v=vs.85).aspx
-  # DWORD WINAPI GetShortPathName(
-  #   _In_  LPCTSTR lpszLongPath,
-  #   _Out_ LPTSTR  lpszShortPath,
-  #   _In_  DWORD   cchBuffer
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetShortPathNameW,
-    [:lpcwstr, :lpwstr, :dword], :dword
-end