class Chef::Provider::Package::Windows

Public Instance Methods

candidate_version() click to toggle source

@return [String] candidate_version

# File lib/chef/provider/package/windows.rb, line 152
def candidate_version
  @candidate_version ||= (new_resource.version || "latest")
end
current_version_array() click to toggle source

@return [Array] current_version(s) as an array this package provider does not support package arrays However, There may be multiple versions for a single package so the first element may be a nested array

FIXME: this breaks the semantics of the superclass and needs to get unwound. Since these package providers don't support multipackage they can't put multiple versions into this array. The windows package managers need this in order to uninstall multiple installed version, and they should track that in something like an `uninstall_version_array` of their own. The superclass does not implement this kind of feature. Doing this here breaks LSP and will create bugs since the superclass will not expect it at all. The `current_resource.version` also MUST NOT be an array if the package provider is not multipackage. The existing implementation of package_provider.installed_version should probably be what `uninstall_version_array` is, and then that list should be sorted and last/first'd into the current_resource.version. The current_version_array method was not intended to be overwritten by subclasses (but ruby provides no feature to block doing so – it is already marked as private).

# File lib/chef/provider/package/windows.rb, line 172
def current_version_array
  [ current_resource.version ]
end
define_resource_requirements() click to toggle source
# File lib/chef/provider/package/windows.rb, line 38
def define_resource_requirements
  if new_resource.checksum
    requirements.assert(:install) do |a|
      a.assertion { new_resource.checksum == checksum(source_location) }
      a.failure_message Chef::Exceptions::Package, "Checksum on resource (#{short_cksum(new_resource.checksum)}) does not match checksum on content (#{short_cksum(source_location)})"
    end
  end

  requirements.assert(:install) do |a|
    a.assertion { new_resource.source || msi? }
    a.failure_message Chef::Exceptions::NoWindowsPackageSource, "Source for package #{new_resource.package_name} must be specified in the resource's source property for package to be installed because the package_name property is used to test for the package installation state for this package type."
  end

  unless uri_scheme?(new_resource.source)
    requirements.assert(:install) do |a|
      a.assertion { ::File.exist?(new_resource.source) }
      a.failure_message Chef::Exceptions::Package, "Source for package #{new_resource.package_name} does not exist"
      a.whyrun "Assuming source file #{new_resource.source} would have been created."
    end
  end
end
have_any_matching_version?() click to toggle source
# File lib/chef/provider/package/windows.rb, line 193
def have_any_matching_version?
  target_version_already_installed?(current_resource.version, new_resource.version)
end
install_package(name, version) click to toggle source

Chef::Provider::Package action_install + action_remove call install_package + remove_package Pass those calls to the correct sub-provider

# File lib/chef/provider/package/windows.rb, line 137
def install_package(name, version)
  package_provider.install_package
end
installer_type() click to toggle source
# File lib/chef/provider/package/windows.rb, line 85
def installer_type
  # 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.
  @installer_type ||= begin
    return :msi if msi?

    if new_resource.installer_type
      new_resource.installer_type
    elsif source_location.nil?
      inferred_registry_type
    else
      basename = ::File.basename(source_location)
      file_extension = basename.split(".").last.downcase

      # search the binary file for installer type
      ::Kernel.open(::File.expand_path(source_location), "rb") do |io|
        filesize = io.size
        bufsize = 4096 # read 4K buffers
        overlap = 16 # bytes to overlap between buffer reads

        until io.eof
          contents = io.read(bufsize)

          case contents
          when /inno/i # Inno Setup
            return :inno
          when /wise/i # Wise InstallMaster
            return :wise
          when /nullsoft/i # Nullsoft Scriptable Install System
            return :nsis
          end

          if io.tell < filesize
            io.seek(io.tell - overlap)
          end
        end

        # if file is named 'setup.exe' assume installshield
        if basename == "setup.exe"
          :installshield
        else
          raise Chef::Exceptions::CannotDetermineWindowsInstallerType, "Installer type for Windows Package '#{new_resource.package_name}' not specified and cannot be determined from file extension '#{file_extension}'"
        end
      end
    end
  end
end
load_current_resource() click to toggle source
# File lib/chef/provider/package/windows.rb, line 60
def load_current_resource
  if uri_scheme?(new_resource.source) && action == :install
    download_source_file
  end

  @current_resource = Chef::Resource::WindowsPackage.new(new_resource.name)
  current_resource.version(package_provider.installed_version)
  new_resource.version(package_provider.package_version) if package_provider.package_version

  current_resource
end
new_version_array() click to toggle source

@return [Array] new_version(s) as an array

# File lib/chef/provider/package/windows.rb, line 146
def new_version_array
  # Because the one in the parent caches things
  [new_resource.version]
end
package_provider() click to toggle source
# File lib/chef/provider/package/windows.rb, line 72
def package_provider
  @package_provider ||= case installer_type
    when :msi
      logger.trace("#{new_resource} is MSI")
      require_relative "windows/msi"
      Chef::Provider::Package::Windows::MSI.new(resource_for_provider, uninstall_registry_entries)
    else
      logger.trace("#{new_resource} is EXE with type '#{installer_type}'")
      require_relative "windows/exe"
      Chef::Provider::Package::Windows::Exe.new(resource_for_provider, installer_type, uninstall_registry_entries)
                        end
end
remove_package(name, version) click to toggle source
# File lib/chef/provider/package/windows.rb, line 141
def remove_package(name, version)
  package_provider.remove_package
end
target_version_already_installed?(current_version, new_version) click to toggle source

@param current_version<String> one or more versions currently installed @param new_version<String> version of the new resource

@return [Boolean] true if new_version is equal to or included in current_version

# File lib/chef/provider/package/windows.rb, line 180
def target_version_already_installed?(current_version, new_version)
  version_equals?(current_version, new_version)
end
version_equals?(current_version, new_version) click to toggle source
# File lib/chef/provider/package/windows.rb, line 184
def version_equals?(current_version, new_version)
  logger.trace("Checking if #{new_resource} version '#{new_version}' is already installed. #{current_version} is currently installed")
  if current_version.is_a?(Array)
    current_version.include?(new_version)
  else
    new_version == current_version
  end
end

Private Instance Methods

default_download_cache_path() click to toggle source
# File lib/chef/provider/package/windows.rb, line 266
def default_download_cache_path
  uri = ::URI.parse(new_resource.source)
  filename = ::File.basename(::CGI.unescape(uri.path))
  file_cache_dir = Chef::FileCache.create_cache_path("package/")
  Chef::Util::PathHelper.cleanpath("#{file_cache_dir}/#{filename}")
end
download_source_file() click to toggle source
# File lib/chef/provider/package/windows.rb, line 242
def download_source_file
  source_resource.run_action(:create)
  logger.trace("#{new_resource} fetched source file to #{default_download_cache_path}")
end
downloadable_file_missing?() click to toggle source
# File lib/chef/provider/package/windows.rb, line 225
def downloadable_file_missing?
  !new_resource.source.nil? && uri_scheme?(new_resource.source) && !::File.exist?(source_location)
end
inferred_registry_type() click to toggle source
# File lib/chef/provider/package/windows.rb, line 214
def inferred_registry_type
  @inferred_registry_type ||= begin
    uninstall_registry_entries.each do |entry|
      return :inno if entry.key.end_with?("_is1")
      return :msi if entry.uninstall_string.downcase.start_with?("msiexec.exe ")
      return :nsis if entry.uninstall_string.downcase.end_with?("uninst.exe\"")
    end
    nil
  end
end
msi?() click to toggle source
# File lib/chef/provider/package/windows.rb, line 284
def msi?
  return true if new_resource.installer_type == :msi

  if source_location.nil?
    inferred_registry_type == :msi
  else
    ::File.extname(source_location).casecmp(".msi") == 0
  end
end
resource_for_provider() click to toggle source
# File lib/chef/provider/package/windows.rb, line 229
def resource_for_provider
  # XXX: this is crazy
  @resource_for_provider = Chef::Resource::WindowsPackage.new(new_resource.name).tap do |r|
    r.source(Chef::Util::PathHelper.validate_path(source_location)) unless source_location.nil?
    r.cookbook_name = new_resource.cookbook_name
    r.version(new_resource.version)
    r.timeout(new_resource.timeout)
    r.returns(new_resource.returns)
    r.options(new_resource.options)
    r.sensitive(new_resource.sensitive)
  end
end
source_location() click to toggle source
# File lib/chef/provider/package/windows.rb, line 273
def source_location
  if new_resource.source.nil?
    nil
  elsif uri_scheme?(new_resource.source)
    source_resource.path
  else
    new_source = Chef::Util::PathHelper.cleanpath(new_resource.source)
    ::File.exist?(new_source) ? new_source : nil
  end
end
source_resource() click to toggle source
# File lib/chef/provider/package/windows.rb, line 247
def source_resource
  # It seems correct that this is a build_resource rather than declare_resource/DSL use since updating should not trigger a notification
  # unless the downloaded file is actually installed.  The case where the remote_file downloads the package but the package is already
  # installed on the target should not trigger a notification since the running state did not change.
  @source_resource ||= build_resource(:remote_file, default_download_cache_path) do
    source(new_resource.source)
    cookbook_name = new_resource.cookbook_name
    checksum(new_resource.checksum)
    backup(false)

    # since the source_resource can mutate here, we save off the @source_resource so we can inspect the actual state later
    if new_resource.remote_file_attributes
      new_resource.remote_file_attributes.each do |(k, v)|
        send(k.to_sym, v)
      end
    end
  end
end
uninstall_registry_entries() click to toggle source
# File lib/chef/provider/package/windows.rb, line 210
def uninstall_registry_entries
  @uninstall_registry_entries ||= Chef::Provider::Package::Windows::RegistryUninstallEntry.find_entries(new_resource.package_name)
end
version_compare(v1, v2) click to toggle source
# File lib/chef/provider/package/windows.rb, line 199
def version_compare(v1, v2)
  if v1 == "latest" || v2 == "latest"
    return 0
  end

  gem_v1 = Gem::Version.new(v1)
  gem_v2 = Gem::Version.new(v2)

  gem_v1 <=> gem_v2
end