pdk 2.3.0 → 2.4.0

data/lib/pdk/util/vendored_file.rb

@@ -1,93 +1,93 @@
-require 'pdk'
-
-module PDK
-  module Util
-    class VendoredFile
-      class DownloadError < StandardError; end
-
-      attr_reader :file_name
-      attr_reader :url
-
-      def initialize(file_name, url)
-        @file_name = file_name
-        @url = url
-      end
-
-      def read
-        require 'pdk/util'
-        require 'pdk/util/filesystem'
-
-        return PDK::Util::Filesystem.read_file(package_vendored_path) if PDK::Util.package_install?
-        return PDK::Util::Filesystem.read_file(gem_vendored_path) if PDK::Util::Filesystem.file?(gem_vendored_path)
-
-        content = download_file
-
-        # TODO: should only write if it's valid JSON
-        # TODO: need a way to invalidate if out of date
-        PDK::Util::Filesystem.mkdir_p(File.dirname(gem_vendored_path))
-        PDK::Util::Filesystem.write_file(gem_vendored_path, content)
-        content
-      end
-
-      private
-
-      def download_file
-        require 'uri'
-        require 'net/https'
-        require 'openssl'
-
-        http_errors = [
-          EOFError,
-          Errno::ECONNRESET,
-          Errno::EINVAL,
-          Errno::ECONNREFUSED,
-          Net::HTTPBadResponse,
-          Net::HTTPHeaderSyntaxError,
-          Net::ProtocolError,
-          Timeout::Error,
-        ]
-
-        PDK.logger.debug _('%{file_name} was not found in the cache, downloading it from %{url}.') % {
-          file_name: file_name,
-          url:       url,
-        }
-
-        uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        # TODO: Get rid of this
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if Gem.win_platform?
-        request = Net::HTTP::Get.new(uri.request_uri)
-        response = http.request(request)
-
-        unless response.code == '200'
-          raise DownloadError, _('Unable to download %{url}. %{code}: %{message}.') % {
-            url:     url,
-            code:    response.code,
-            message: response.message,
-          }
-        end
-
-        response.body
-      rescue *http_errors => e
-        raise DownloadError, _('Unable to download %{url}. Check internet connectivity and try again. %{error}') % {
-          url: url,
-          error: e,
-        }
-      end
-
-      def package_vendored_path
-        require 'pdk/util'
-
-        @package_vendored_path ||= File.join(PDK::Util.package_cachedir, file_name)
-      end
-
-      def gem_vendored_path
-        require 'pdk/util'
-        require 'pdk/version'
-
-        @gem_vendored_path ||= File.join(PDK::Util.cachedir, PDK::VERSION, file_name)
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Util
+    class VendoredFile
+      class DownloadError < StandardError; end
+
+      attr_reader :file_name
+      attr_reader :url
+
+      def initialize(file_name, url)
+        @file_name = file_name
+        @url = url
+      end
+
+      def read
+        require 'pdk/util'
+        require 'pdk/util/filesystem'
+
+        return PDK::Util::Filesystem.read_file(package_vendored_path) if PDK::Util.package_install?
+        return PDK::Util::Filesystem.read_file(gem_vendored_path) if PDK::Util::Filesystem.file?(gem_vendored_path)
+
+        content = download_file
+
+        # TODO: should only write if it's valid JSON
+        # TODO: need a way to invalidate if out of date
+        PDK::Util::Filesystem.mkdir_p(File.dirname(gem_vendored_path))
+        PDK::Util::Filesystem.write_file(gem_vendored_path, content)
+        content
+      end
+
+      private
+
+      def download_file
+        require 'uri'
+        require 'net/https'
+        require 'openssl'
+
+        http_errors = [
+          EOFError,
+          Errno::ECONNRESET,
+          Errno::EINVAL,
+          Errno::ECONNREFUSED,
+          Net::HTTPBadResponse,
+          Net::HTTPHeaderSyntaxError,
+          Net::ProtocolError,
+          Timeout::Error,
+        ]
+
+        PDK.logger.debug _('%{file_name} was not found in the cache, downloading it from %{url}.') % {
+          file_name: file_name,
+          url:       url,
+        }
+
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        # TODO: Get rid of this
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if Gem.win_platform?
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+
+        unless response.code == '200'
+          raise DownloadError, _('Unable to download %{url}. %{code}: %{message}.') % {
+            url:     url,
+            code:    response.code,
+            message: response.message,
+          }
+        end
+
+        response.body
+      rescue *http_errors => e
+        raise DownloadError, _('Unable to download %{url}. Check internet connectivity and try again. %{error}') % {
+          url: url,
+          error: e,
+        }
+      end
+
+      def package_vendored_path
+        require 'pdk/util'
+
+        @package_vendored_path ||= File.join(PDK::Util.package_cachedir, file_name)
+      end
+
+      def gem_vendored_path
+        require 'pdk/util'
+        require 'pdk/version'
+
+        @gem_vendored_path ||= File.join(PDK::Util.cachedir, PDK::VERSION, file_name)
+      end
+    end
+  end
+end

data/lib/pdk/util/version.rb

@@ -1,43 +1,43 @@
-require 'pdk'
-
-module PDK
-  module Util
-    module Version
-      def self.version_string
-        require 'pdk/version'
-
-        "#{PDK::VERSION} #{pdk_ref}".strip.freeze
-      end
-
-      def self.pdk_ref
-        ref = "#{pkg_sha} #{git_ref}".strip
-        ref.empty? ? nil : "(#{ref})"
-      end
-
-      def self.pkg_sha
-        if version_file && PDK::Util::Filesystem.exist?(version_file)
-          ver = PDK::Util::Filesystem.read_file(version_file)
-          sha = ver.strip.split('.')[5] unless ver.nil?
-        end
-
-        sha
-      end
-
-      def self.git_ref
-        require 'pdk/util/git'
-        source_git_dir = File.join(PDK::Util::Filesystem.expand_path('../../..', File.dirname(__FILE__)), '.git')
-
-        return unless PDK::Util::Filesystem.directory?(source_git_dir)
-
-        PDK::Util::Git.describe(source_git_dir)
-      end
-
-      def self.version_file
-        require 'pdk/util'
-
-        # FIXME: this gets called a LOT and doesn't currently get cached
-        PDK::Util.find_upwards('PDK_VERSION', File.dirname(__FILE__))
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Util
+    module Version
+      def self.version_string
+        require 'pdk/version'
+
+        "#{PDK::VERSION} #{pdk_ref}".strip.freeze
+      end
+
+      def self.pdk_ref
+        ref = "#{pkg_sha} #{git_ref}".strip
+        ref.empty? ? nil : "(#{ref})"
+      end
+
+      def self.pkg_sha
+        if version_file && PDK::Util::Filesystem.exist?(version_file)
+          ver = PDK::Util::Filesystem.read_file(version_file)
+          sha = ver.strip.split('.')[5] unless ver.nil?
+        end
+
+        sha
+      end
+
+      def self.git_ref
+        require 'pdk/util/git'
+        source_git_dir = File.join(PDK::Util::Filesystem.expand_path('../../..', File.dirname(__FILE__)), '.git')
+
+        return unless PDK::Util::Filesystem.directory?(source_git_dir)
+
+        PDK::Util::Git.describe(source_git_dir)
+      end
+
+      def self.version_file
+        require 'pdk/util'
+
+        # FIXME: this gets called a LOT and doesn't currently get cached
+        PDK::Util.find_upwards('PDK_VERSION', File.dirname(__FILE__))
+      end
+    end
+  end
+end

data/lib/pdk/util/windows/api_types.rb

@@ -1,82 +1,82 @@
-require 'ffi'
-require 'pdk/util/windows/string'
-
-module PDK::Util::Windows::APITypes
-  module ::FFI::Library
-    def attach_function_private(*args)
-      attach_function(*args)
-      private args[0]
-    end
-  end
-
-  class ::FFI::Pointer
-    def self.from_string_to_wide_string(str, &_block)
-      str = PDK::Util::Windows::String.wide_string(str)
-      FFI::MemoryPointer.new(:byte, 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
-
-    def read_wide_string(char_length, dst_encoding = Encoding::UTF_8, encode_options = {})
-      # char_length is number of wide chars (typically excluding NULLs), *not* bytes
-      str = get_bytes(0, char_length * 2).force_encoding('UTF-16LE')
-      str.encode(dst_encoding, str.encoding, encode_options)
-    rescue StandardError => e
-      PDK.logger.debug _('Unable to convert value %{string} to encoding %{encoding} due to %{error}') % {
-        string:   str.dump,
-        encoding: dst_encoding,
-        error:    e.inspect,
-      }
-      raise
-    end
-
-    def read_arbitrary_wide_string_up_to(max_char_length = 512, null_terminator = :single_null, encode_options = {})
-      unless [:single_null, :double_null].include?(null_terminator)
-        raise ArgumentError, _(
-          'Unable to read wide strings with %{null_terminator} terminal nulls',
-        ) % { null_terminator: null_terminator }
-      end
-
-      terminator_width = (null_terminator == :single_null) ? 1 : 2
-      reader_method = (null_terminator == :single_null) ? :get_uint16 : :get_uint32
-
-      # Look for the null_terminator; if found, read up to that null
-      # (exclusive)
-      (0...max_char_length - terminator_width).each do |i|
-        return read_wide_string(i, Encoding::UTF_8, encode_options) if send(reader_method, (i * 2)).zero?
-      end
-
-      # String is longer than the max, read just up to the max
-      read_wide_string(max_char_length, Encoding::UTF_8, encode_options)
-    end
-  end
-
-  # FFI Types
-  # https://github.com/ffi/ffi/wiki/Types
-
-  # Windows - Common Data Types
-  # https://msdn.microsoft.com/en-us/library/cc230309.aspx
-
-  # Windows Data Types
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa383751(v=vs.85).aspx
-
-  FFI.typedef :uint32, :dword
-  # buffer_inout is similar to pointer (platform specific), but optimized for buffers
-  FFI.typedef :buffer_inout, :lpwstr
-  # buffer_in is similar to pointer (platform specific), but optimized for CONST read only buffers
-  FFI.typedef :buffer_in, :lpcwstr
-  # 8 bits per byte
-  FFI.typedef :uchar, :byte
-  FFI.typedef :uint16, :wchar
-
-  # FFI bool can be only 1 byte at times,
-  # Win32 BOOL is a signed int, and is always 4 bytes, even on x64
-  # https://blogs.msdn.com/b/oldnewthing/archive/2011/03/28/10146459.aspx
-  FFI.typedef :int32, :win32_bool
-end
+require 'ffi'
+require 'pdk/util/windows/string'
+
+module PDK::Util::Windows::APITypes
+  module ::FFI::Library
+    def attach_function_private(*args)
+      attach_function(*args)
+      private args[0]
+    end
+  end
+
+  class ::FFI::Pointer
+    def self.from_string_to_wide_string(str, &_block)
+      str = PDK::Util::Windows::String.wide_string(str)
+      FFI::MemoryPointer.new(:byte, 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
+
+    def read_wide_string(char_length, dst_encoding = Encoding::UTF_8, encode_options = {})
+      # char_length is number of wide chars (typically excluding NULLs), *not* bytes
+      str = get_bytes(0, char_length * 2).force_encoding('UTF-16LE')
+      str.encode(dst_encoding, str.encoding, encode_options)
+    rescue StandardError => e
+      PDK.logger.debug _('Unable to convert value %{string} to encoding %{encoding} due to %{error}') % {
+        string:   str.dump,
+        encoding: dst_encoding,
+        error:    e.inspect,
+      }
+      raise
+    end
+
+    def read_arbitrary_wide_string_up_to(max_char_length = 512, null_terminator = :single_null, encode_options = {})
+      unless [:single_null, :double_null].include?(null_terminator)
+        raise ArgumentError, _(
+          'Unable to read wide strings with %{null_terminator} terminal nulls',
+        ) % { null_terminator: null_terminator }
+      end
+
+      terminator_width = (null_terminator == :single_null) ? 1 : 2
+      reader_method = (null_terminator == :single_null) ? :get_uint16 : :get_uint32
+
+      # Look for the null_terminator; if found, read up to that null
+      # (exclusive)
+      (0...max_char_length - terminator_width).each do |i|
+        return read_wide_string(i, Encoding::UTF_8, encode_options) if send(reader_method, (i * 2)).zero?
+      end
+
+      # String is longer than the max, read just up to the max
+      read_wide_string(max_char_length, Encoding::UTF_8, encode_options)
+    end
+  end
+
+  # FFI Types
+  # https://github.com/ffi/ffi/wiki/Types
+
+  # Windows - Common Data Types
+  # https://msdn.microsoft.com/en-us/library/cc230309.aspx
+
+  # Windows Data Types
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa383751(v=vs.85).aspx
+
+  FFI.typedef :uint32, :dword
+  # buffer_inout is similar to pointer (platform specific), but optimized for buffers
+  FFI.typedef :buffer_inout, :lpwstr
+  # buffer_in is similar to pointer (platform specific), but optimized for CONST read only buffers
+  FFI.typedef :buffer_in, :lpcwstr
+  # 8 bits per byte
+  FFI.typedef :uchar, :byte
+  FFI.typedef :uint16, :wchar
+
+  # FFI bool can be only 1 byte at times,
+  # Win32 BOOL is a signed int, and is always 4 bytes, even on x64
+  # https://blogs.msdn.com/b/oldnewthing/archive/2011/03/28/10146459.aspx
+  FFI.typedef :int32, :win32_bool
+end

data/lib/pdk/util/windows/file.rb

@@ -1,36 +1,36 @@
-require 'pdk/util/windows'
-
-module PDK::Util::Windows::File
-  require 'ffi'
-  extend FFI::Library
-  extend PDK::Util::Windows::String
-
-  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) == PDK::Util::Windows::WIN32_FALSE
-          raise _('Failed to call GetLongPathName')
-        end
-
-        converted = converted_ptr.read_wide_string(buffer_size - 1)
-      end
-    end
-
-    converted
-  end
-  module_function :get_long_pathname
-
-  ffi_convention :stdcall
-
-  # 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 :GetLongPathNameW, [:lpcwstr, :lpwstr, :dword], :dword
-end
+require 'pdk/util/windows'
+
+module PDK::Util::Windows::File
+  require 'ffi'
+  extend FFI::Library
+  extend PDK::Util::Windows::String
+
+  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) == PDK::Util::Windows::WIN32_FALSE
+          raise _('Failed to call GetLongPathName')
+        end
+
+        converted = converted_ptr.read_wide_string(buffer_size - 1)
+      end
+    end
+
+    converted
+  end
+  module_function :get_long_pathname
+
+  ffi_convention :stdcall
+
+  # 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 :GetLongPathNameW, [:lpcwstr, :lpwstr, :dword], :dword
+end

data/lib/pdk/util/windows/process.rb

@@ -1,79 +1,79 @@
-require 'pdk/util/windows'
-
-module PDK::Util::Windows::Process
-  require 'ffi'
-  extend PDK::Util::Windows::String
-  extend FFI::Library
-
-  def environment_hash
-    env_ptr = GetEnvironmentStringsW()
-
-    contains_unicode_replacement = ->(string) do
-      return false unless string.include?("\uFFFD")
-
-      PDK.logger.warning _(
-        'Discarding environment variable %{string} which contains invalid ' \
-        'bytes',
-      ) % { string: string }
-      true
-    end
-
-    # pass :invalid => :replace to the Ruby String#encode to use replacement
-    # characters
-    pairs = env_ptr.read_arbitrary_wide_string_up_to(65_534, :double_null, invalid: :replace)
-                   .split(?\x00)
-                   .reject { |env_str| env_str.nil? || env_str.empty? || env_str[0] == '=' }
-                   .reject { |env_str| contains_unicode_replacement.call(env_str) }
-                   .map { |env_pair| env_pair.split('=', 2) }
-    Hash[pairs]
-  ensure
-    if env_ptr && !env_ptr.null?
-      if FreeEnvironmentStringsW(env_ptr) == PDK::Util::Windows::WIN32_FALSE
-        PDK.logger.debug _('FreeEnvironmentStringsW memory leak')
-      end
-    end
-  end
-  module_function :environment_hash
-
-  def set_environment_variable(name, val)
-    raise ArgumentError, _('Environment variable name must not be nil or empty') if name.nil? || name.empty?
-
-    FFI::MemoryPointer.from_string_to_wide_string(name) do |name_ptr|
-      if val.nil?
-        if SetEnvironmentVariableW(name_ptr, FFI::MemoryPointer::NULL) == PDK::Util::Windows::WIN32_FALSE
-          raise _('Failed to remove environment variable: %{name}') % { name: name }
-        end
-      else
-        FFI::MemoryPointer.from_string_to_wide_string(val) do |val_ptr|
-          if SetEnvironmentVariableW(name_ptr, val_ptr) == PDK::Util::Windows::WIN32_FALSE
-            raise _('Failed to set environment variaible: %{name}') % { name: name }
-          end
-        end
-      end
-    end
-  end
-  module_function :set_environment_variable
-
-  ffi_convention :stdcall
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683187(v=vs.85).aspx
-  # LPTCH GetEnvironmentStrings(void);
-  ffi_lib :kernel32
-  attach_function_private :GetEnvironmentStringsW, [], :pointer
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683151(v=vs.85).aspx
-  # BOOL FreeEnvironmentStrings(
-  #   _In_ LPTCH lpszEnvironmentBlock
-  # );
-  ffi_lib :kernel32
-  attach_function_private :FreeEnvironmentStringsW, [:pointer], :win32_bool
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms686206(v=vs.85).aspx
-  # BOOL WINAPI SetEnvironmentVariableW(
-  #   _In_     LPCTSTR lpName,
-  #   _In_opt_ LPCTSTR lpValue
-  # );
-  ffi_lib :kernel32
-  attach_function_private :SetEnvironmentVariableW, [:lpcwstr, :lpcwstr],
-                          :win32_bool
-end
+require 'pdk/util/windows'
+
+module PDK::Util::Windows::Process
+  require 'ffi'
+  extend PDK::Util::Windows::String
+  extend FFI::Library
+
+  def environment_hash
+    env_ptr = GetEnvironmentStringsW()
+
+    contains_unicode_replacement = ->(string) do
+      return false unless string.include?("\uFFFD")
+
+      PDK.logger.warning _(
+        'Discarding environment variable %{string} which contains invalid ' \
+        'bytes',
+      ) % { string: string }
+      true
+    end
+
+    # pass :invalid => :replace to the Ruby String#encode to use replacement
+    # characters
+    pairs = env_ptr.read_arbitrary_wide_string_up_to(65_534, :double_null, invalid: :replace)
+                   .split(?\x00)
+                   .reject { |env_str| env_str.nil? || env_str.empty? || env_str[0] == '=' }
+                   .reject { |env_str| contains_unicode_replacement.call(env_str) }
+                   .map { |env_pair| env_pair.split('=', 2) }
+    Hash[pairs]
+  ensure
+    if env_ptr && !env_ptr.null?
+      if FreeEnvironmentStringsW(env_ptr) == PDK::Util::Windows::WIN32_FALSE
+        PDK.logger.debug _('FreeEnvironmentStringsW memory leak')
+      end
+    end
+  end
+  module_function :environment_hash
+
+  def set_environment_variable(name, val)
+    raise ArgumentError, _('Environment variable name must not be nil or empty') if name.nil? || name.empty?
+
+    FFI::MemoryPointer.from_string_to_wide_string(name) do |name_ptr|
+      if val.nil?
+        if SetEnvironmentVariableW(name_ptr, FFI::MemoryPointer::NULL) == PDK::Util::Windows::WIN32_FALSE
+          raise _('Failed to remove environment variable: %{name}') % { name: name }
+        end
+      else
+        FFI::MemoryPointer.from_string_to_wide_string(val) do |val_ptr|
+          if SetEnvironmentVariableW(name_ptr, val_ptr) == PDK::Util::Windows::WIN32_FALSE
+            raise _('Failed to set environment variaible: %{name}') % { name: name }
+          end
+        end
+      end
+    end
+  end
+  module_function :set_environment_variable
+
+  ffi_convention :stdcall
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683187(v=vs.85).aspx
+  # LPTCH GetEnvironmentStrings(void);
+  ffi_lib :kernel32
+  attach_function_private :GetEnvironmentStringsW, [], :pointer
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms683151(v=vs.85).aspx
+  # BOOL FreeEnvironmentStrings(
+  #   _In_ LPTCH lpszEnvironmentBlock
+  # );
+  ffi_lib :kernel32
+  attach_function_private :FreeEnvironmentStringsW, [:pointer], :win32_bool
+
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/ms686206(v=vs.85).aspx
+  # BOOL WINAPI SetEnvironmentVariableW(
+  #   _In_     LPCTSTR lpName,
+  #   _In_opt_ LPCTSTR lpValue
+  # );
+  ffi_lib :kernel32
+  attach_function_private :SetEnvironmentVariableW, [:lpcwstr, :lpcwstr],
+                          :win32_bool
+end