CHEF-5087: Add a Windows Installer package provider

Adds the framework for a windows package provider, which must determine the
correct provider by examining metadata about the source file, or the source
file itself.

Provides FFI based access to the Windows Installer functions to retrieve
metadata from the MSI files and from the Windows product database.

Combines both of these into an MSI package provider.

Continues to work alongside the windows_package LWRP.

5 files changed, 395 insertions, 0 deletions

diff --git a/lib/chef/provider/package/windows.rb b/lib/chef/provider/package/windows.rb
new file mode 100644
index 0000000000..be1de0b969
--- /dev/null
+++ b/lib/chef/provider/package/windows.rb
@@ -0,0 +1,80 @@
+#
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright (c) 2014 Chef Software, 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/resource/windows_package'
+require 'chef/provider/package'
+
+class Chef
+  class Provider
+    class Package
+      class Windows < Chef::Provider::Package
+
+        # Depending on the installer, we may need to examine installer_type or 
+        # source attributes, or search for text strings in the installer file 
+        # binary to determine the installer type for the user. Since the file
+        # must be on disk to do so, we have to make this choice in the provider.
+        require 'chef/provider/package/windows/msi.rb'
+
+        # load_current_resource is run in Chef::Provider#run_action when not in whyrun_mode?
+        def load_current_resource
+          @current_resource = Chef::Resource::WindowsPackage.new(@new_resource.name)
+          @current_resource.version(package_provider.installed_version)
+          @new_resource.version(package_provider.package_version)
+          @current_resource
+        end
+
+        def package_provider
+          @package_provider ||= begin
+            case installer_type
+            when :msi
+              Chef::Provider::Package::Windows::MSI.new(@new_resource)
+            else
+              raise "Unable to find a Chef::Provider::Package::Windows provider for installer_type '#{installer_type}'"
+            end
+          end
+        end
+
+        def installer_type
+          @installer_type ||= begin
+            if @new_resource.installer_type
+              @new_resource.installer_type
+            else
+              file_extension = ::File.basename(@new_resource.source).split(".").last.downcase
+
+              if file_extension == "msi"
+                :msi
+              else
+                raise ArgumentError, "Installer type for Windows Package '#{@new_resource.name}' not specified and cannot be determined from file extension '#{file_extension}'"
+              end
+            end
+          end
+        end
+
+        # Chef::Provider::Package action_install + action_remove call install_package + remove_package
+        # Pass those calls to the correct sub-provider
+        def install_package(name, version)
+          package_provider.install_package(name, version)
+        end
+
+        def remove_package(name, version)
+          package_provider.remove_package(name, version)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/chef/provider/package/windows/msi.rb b/lib/chef/provider/package/windows/msi.rb
new file mode 100644
index 0000000000..0764a15901
--- /dev/null
+++ b/lib/chef/provider/package/windows/msi.rb
@@ -0,0 +1,69 @@
+#
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright (c) 2014 Chef Software, 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.
+#
+
+# TODO: Allow @new_resource.source to be a Product Code as a GUID for uninstall / network install
+
+require 'chef/mixin/shell_out'
+require 'chef/win32/api/installer'
+
+class Chef
+  class Provider
+    class Package
+      class Windows
+        class MSI
+          include Chef::ReservedNames::Win32::API::Installer
+          include Chef::Mixin::ShellOut
+
+          def initialize(resource)
+            @new_resource = resource
+          end
+
+          # From Chef::Provider::Package
+          def expand_options(options)
+            options ? " #{options}" : ""
+          end
+
+          # Returns a version if the package is installed or nil if it is not.
+          def installed_version
+            Chef::Log.debug("#{@new_resource} getting product code for package at #{@new_resource.source}")
+            product_code = get_product_property(@new_resource.source, "ProductCode")
+            Chef::Log.debug("#{@new_resource} checking package status and verion for #{product_code}")
+            get_installed_version(product_code)
+          end
+
+          def package_version
+            Chef::Log.debug("#{@new_resource} getting product version for package at #{@new_resource.source}")
+            get_product_property(@new_resource.source, "ProductVersion")
+          end
+
+          def install_package(name, version)
+            # We could use MsiConfigureProduct here, but we'll start off with msiexec
+            Chef::Log.debug("#{@new_resource} installing MSI package '#{@new_resource.source}'")
+            shell_out!("msiexec /qn /i \"#{@new_resource.source}\" #{expand_options(@new_resource.options)}", {:timeout => @new_resource.timeout, :returns => @new_resource.returns})
+          end
+  
+          def remove_package(name, version)
+            # We could use MsiConfigureProduct here, but we'll start off with msiexec
+            Chef::Log.debug("#{@new_resource} removing MSI package '#{@new_resource.source}'")
+            shell_out!("msiexec /qn /x \"#{@new_resource.source}\" #{expand_options(@new_resource.options)}", {:timeout => @new_resource.timeout, :returns => @new_resource.returns})
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/chef/resource/windows_package.rb b/lib/chef/resource/windows_package.rb
new file mode 100644
index 0000000000..ff80b47115
--- /dev/null
+++ b/lib/chef/resource/windows_package.rb
@@ -0,0 +1,79 @@
+#
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright (c) 2014 Chef Software, 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/resource/package'
+require 'chef/provider/package/windows'
+require 'chef/win32/error'
+
+class Chef
+  class Resource
+    class WindowsPackage < Chef::Resource::Package
+
+      provides :package, :on_platforms => ["windows"]
+
+      def initialize(name, run_context=nil)
+        super
+        @allowed_actions = [ :install, :remove ]
+        @provider = Chef::Provider::Package::Windows
+        @resource_name = :windows_package
+        @source ||= source(@package_name)
+
+        # Unique to this resource
+        @installer_type = nil
+        @timeout = 600
+        # In the past we accepted return code 127 for an unknown reason and 42 because of a bug
+        @returns = [ 0 ]
+      end
+
+      def installer_type(arg=nil)
+        set_or_return(
+          :installer_type,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+
+      def timeout(arg=nil)
+        set_or_return(
+          :timeout,
+          arg,
+          :kind_of => [ String, Integer ]
+        )
+      end
+
+      def returns(arg=nil)
+        set_or_return(
+          :returns,
+          arg,
+          :kind_of => [ String, Integer, Array ]
+        )
+      end
+
+      def source(arg=nil)
+        if arg == nil && self.instance_variable_defined?(:@source) == true
+          @source
+        else
+          raise ArgumentError, "Bad type for WindowsPackage resource, use a String" unless arg.is_a?(String)
+          Chef::Log.debug("#{package_name}: sanitizing source path '#{arg}'")
+          @source = ::File.absolute_path(arg).gsub(::File::SEPARATOR, ::File::ALT_SEPARATOR)
+        end
+      end
+    end
+  end
+end
+
diff --git a/lib/chef/resources.rb b/lib/chef/resources.rb
index 76adb6f1e1..711becef8c 100644
--- a/lib/chef/resources.rb
+++ b/lib/chef/resources.rb
@@ -69,6 +69,7 @@ require 'chef/resource/template'
 require 'chef/resource/timestamped_deploy'
 require 'chef/resource/user'
 require 'chef/resource/whyrun_safe_ruby_block'
+require 'chef/resource/windows_package'
 require 'chef/resource/yum_package'
 require 'chef/resource/lwrp_base'
 require 'chef/resource/bff_package'
diff --git a/lib/chef/win32/api/installer.rb b/lib/chef/win32/api/installer.rb
new file mode 100644
index 0000000000..745802d260
--- /dev/null
+++ b/lib/chef/win32/api/installer.rb
@@ -0,0 +1,166 @@
+#
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright (c) 2014 Chef Software, 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/exceptions'
+require 'chef/win32/api'
+require 'chef/win32/error'
+require 'pathname'
+
+class Chef
+  module ReservedNames::Win32
+    module API
+      module Installer
+        extend Chef::ReservedNames::Win32
+        extend Chef::ReservedNames::Win32::API
+
+        ###############################################
+        # Win32 API Constants
+        ###############################################
+
+
+        ###############################################
+        # Win32 API Bindings
+        ###############################################
+
+        ffi_lib 'msi'
+
+=begin
+UINT MsiOpenPackage(
+  _In_   LPCTSTR szPackagePath,
+  _Out_  MSIHANDLE *hProduct
+);
+=end
+        safe_attach_function :msi_open_package, :MsiOpenPackageExA, [ :string, :int, :pointer ], :int
+
+=begin
+UINT MsiGetProductProperty(
+  _In_     MSIHANDLE hProduct,
+  _In_     LPCTSTR szProperty,
+  _Out_    LPTSTR lpValueBuf,
+  _Inout_  DWORD *pcchValueBuf
+);
+=end
+        safe_attach_function :msi_get_product_property, :MsiGetProductPropertyA, [ :pointer, :pointer, :pointer, :pointer ], :int
+
+=begin
+UINT MsiGetProductInfo(
+  _In_     LPCTSTR szProduct,
+  _In_     LPCTSTR szProperty,
+  _Out_    LPTSTR lpValueBuf,
+  _Inout_  DWORD *pcchValueBuf
+);
+=end
+        safe_attach_function :msi_get_product_info, :MsiGetProductInfoA, [ :pointer, :pointer, :pointer, :pointer ], :int
+
+=begin
+UINT MsiCloseHandle(
+  _In_  MSIHANDLE hAny
+);
+=end
+        safe_attach_function :msi_close_handle, :MsiCloseHandle, [ :pointer ], :int
+
+        ###############################################
+        # Helpers
+        ###############################################
+
+        # Opens a Microsoft Installer (MSI) file from an absolute path and returns the specified property
+        def get_product_property(package_path, property_name)
+          pkg_ptr = open_package(package_path)
+
+          buffer = 0.chr
+          buffer_length = FFI::Buffer.new(:long).write_long(0)
+
+          # Fetch the length of the property
+          status = msi_get_product_property(pkg_ptr.read_pointer, property_name, buffer, buffer_length)
+
+          # We expect error ERROR_MORE_DATA (234) here because we passed a buffer length of 0
+          if status != 234
+            msg = "msi_get_product_property: returned unknown error #{status} when retrieving #{property_name}: "
+            msg << Chef::ReservedNames::Win32::Error.format_message(status)
+            raise Chef::Exceptions::Package, msg
+          end
+         
+          buffer_length = FFI::Buffer.new(:long).write_long(buffer_length.read_long + 1)
+          buffer = 0.chr * buffer_length.read_long
+
+          # Fetch the property
+          status = msi_get_product_property(pkg_ptr.read_pointer, property_name, buffer, buffer_length)
+
+          if status != 0
+            msg = "msi_get_product_property: returned unknown error #{status} when retrieving #{property_name}: "
+            msg << Chef::ReservedNames::Win32::Error.format_message(status)
+            raise Chef::Exceptions::Package, msg
+          end
+
+          msi_close_handle(pkg_ptr.read_pointer)
+          return buffer
+        end
+
+        # Opens a Microsoft Installer (MSI) file from an absolute path and returns a pointer to a handle
+        # Remember to close the handle with msi_close_handle()
+        def open_package(package_path)
+          # MsiOpenPackage expects a perfect absolute Windows path to the MSI 
+          raise ArgumentError, "Provided path '#{package_path}' must be an absolute path" unless Pathname.new(package_path).absolute?
+
+          pkg_ptr = FFI::MemoryPointer.new(:pointer, 4)
+          status = msi_open_package(package_path, 1, pkg_ptr)
+          case status
+          when 0 
+            # success
+          else
+            raise Chef::Exceptions::Package, "msi_open_package: unexpected status #{status}: #{Chef::ReservedNames::Win32::Error.format_message(status)}"
+          end
+          return pkg_ptr        
+        end
+
+        # All installed product_codes should have a VersionString
+        # Returns a version if installed, nil if not installed
+        def get_installed_version(product_code)
+          version = 0.chr
+          version_length = FFI::Buffer.new(:long).write_long(0)
+         
+          status = msi_get_product_info(product_code, "VersionString", version, version_length)
+          
+          return nil if status == 1605 # ERROR_UNKNOWN_PRODUCT (0x645)
+         
+          # We expect error ERROR_MORE_DATA (234) here because we passed a buffer length of 0
+          if status != 234
+            msg = "msi_get_product_info: product code '#{product_code}' returned unknown error #{status} when retrieving VersionString: "
+            msg << Chef::ReservedNames::Win32::Error.format_message(status)
+            raise Chef::Exceptions::Package, msg
+          end
+
+          # We could fetch the product version now that we know the variable length, but we don't need it here.
+
+          version_length = FFI::Buffer.new(:long).write_long(version_length.read_long + 1)
+          version = 0.chr * version_length.read_long
+           
+          status = msi_get_product_info(product_code, "VersionString", version, version_length)
+           
+          if status != 0
+            msg = "msi_get_product_info: product code '#{product_code}' returned unknown error #{status} when retrieving VersionString: "
+            msg << Chef::ReservedNames::Win32::Error.format_message(status)
+            raise Chef::Exceptions::Package, msg
+          end
+
+          version
+        end
+      end
+    end
+  end
+end