chef 13.12.14-universal-mingw32 → 14.0.190-universal-mingw32

data/lib/chef/resource/windows_font.rb

@@ -0,0 +1,127 @@
+#
+# Copyright:: 2014-2018, Schuberg Philis BV.
+# Copyright:: 2017-2018, Chef Software, Inc.
+#
+# 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"
+
+class Chef
+  class Resource
+    class WindowsFont < Chef::Resource
+      require "chef/util/path_helper"
+
+      resource_name :windows_font
+      provides :windows_font
+
+      description "Use the windows_font resource to install font files on Windows."\
+                  " By default, the font is sourced from the cookbook using the resource, but a URI"\
+                  " source can be specified as well."
+      introduced "14.0"
+
+      property :font_name, String,
+               description: "The file name of the font file name to install if different than the resource name.",
+               name_property: true
+
+      property :source, String,
+               description: "A local filesystem path or URI to source the font file from.",
+               coerce: proc { |x| x =~ /^.:.*/ ? x.tr('\\', "/").gsub("//", "/") : x }
+
+      action :install do
+        description "Install a font to the system fonts directory."
+
+        if font_exists?
+          logger.trace("Not installing font: #{new_resource.font_name} as font already installed.")
+        else
+          retrieve_cookbook_font
+          install_font
+          del_cookbook_font
+        end
+      end
+
+      action_class do
+        # if a source is specified fetch using remote_file. If not use cookbook_file
+        def retrieve_cookbook_font
+          font_file = new_resource.font_name
+          if new_resource.source
+            declare_resource(:remote_file, font_file) do
+              action :nothing
+              source source_uri
+              path Chef::Util::PathHelper.join(ENV["TEMP"], font_file)
+            end.run_action(:create)
+          else
+            declare_resource(:cookbook_file, font_file) do
+              action    :nothing
+              cookbook  cookbook_name.to_s unless cookbook_name.nil?
+              path      Chef::Util::PathHelper.join(ENV["TEMP"], font_file)
+            end.run_action(:create)
+          end
+        end
+
+        # delete the temp cookbook file
+        def del_cookbook_font
+          file Chef::Util::PathHelper.join(ENV["TEMP"], new_resource.font_name) do
+            action :delete
+          end
+        end
+
+        # install the font into the appropriate fonts directory
+        def install_font
+          require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+          fonts_dir = Chef::Util::PathHelper.join(ENV["windir"], "fonts")
+          folder = WIN32OLE.new("Shell.Application").Namespace(fonts_dir)
+          converge_by("install font #{new_resource.font_name} to #{fonts_dir}") do
+            folder.CopyHere(Chef::Util::PathHelper.join(ENV["TEMP"], new_resource.font_name))
+          end
+        end
+
+        # Check to see if the font is installed in the fonts dir
+        #
+        # @return [Boolean] Is the font is installed?
+        def font_exists?
+          require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+          fonts_dir = WIN32OLE.new("WScript.Shell").SpecialFolders("Fonts")
+          logger.trace("Seeing if the font at #{Chef::Util::PathHelper.join(fonts_dir, new_resource.font_name)} exists")
+          ::File.exist?(Chef::Util::PathHelper.join(fonts_dir, new_resource.font_name))
+        end
+
+        # Parse out the schema provided to us to see if it's one we support via remote_file.
+        # We do this because URI will parse C:/foo as schema 'c', which won't work with remote_file
+        #
+        # @return [Boolean]
+        def remote_file_schema?(schema)
+          return true if %w{http https ftp}.include?(schema)
+        end
+
+        # return new_resource.source if we have a proper URI specified
+        # if it's a local file listed as a source return it in file:// format
+        #
+        # @return [String] path to the font
+        def source_uri
+          begin
+            require "uri"
+            if remote_file_schema?(URI.parse(new_resource.source).scheme)
+              logger.trace("source property starts with ftp/http. Using source property unmodified")
+              return new_resource.source
+            end
+          rescue URI::InvalidURIError
+            Chef::Log.warn("source property of #{new_resource.source} could not be processed as a URI. Check the format you provided.")
+          end
+          logger.trace("source property does not start with ftp/http. Prepending with file:// as it appears to be a local file.")
+          "file://#{new_resource.source}"
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_package.rb

@@ -23,15 +23,17 @@ require "chef/win32/error" if RUBY_PLATFORM =~ /mswin|mingw|windows/
 
 class Chef
   class Resource
-    # Use the windows_package resource to manage Microsoft Installer Package (MSI) packages for the Microsoft Windows
-    # platform.
     class WindowsPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
       resource_name :windows_package
-      provides :windows_package, os: "windows"
+      provides :windows_package
       provides :package, os: "windows"
 
+      description "Use the windows_package resource to manage Microsoft Installer Package"\
+                  " (MSI) packages for the Microsoft Windows platform."
+      introduced "11.12"
+
       allowed_actions :install, :remove
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/windows_pagefile.rb

@@ -0,0 +1,206 @@
+#
+# Copyright:: 2012-2018, Nordstrom, Inc.
+# Copyright:: 2017-2018, Chef Software, Inc.
+#
+# 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"
+
+class Chef
+  class Resource
+    class WindowsPagefile < Chef::Resource
+      resource_name :windows_pagefile
+      provides :windows_pagefile
+
+      description "Use the windows_pagefile resource to configure pagefile settings on Windows."
+      introduced "14.0"
+
+      property :path, String,
+               coerce: proc { |x| x.tr("/", '\\') },
+               description: "The path to the pagefile if different from the resource name.",
+               name_property: true
+
+      property :system_managed, [TrueClass, FalseClass],
+               description: "Configures whether the system manages the pagefile size."
+
+      property :automatic_managed, [TrueClass, FalseClass],
+               description: "Enable automatic management of pagefile initial and maximum size. Setting this to true ignores 'initial_size' and 'maximum_size' properties.",
+               default: false
+
+      property :initial_size, Integer,
+               description: "Initial size of the pagefile in megabytes."
+
+      property :maximum_size, Integer,
+               description: "Maximum size of the pagefile in megabytes."
+
+      action :set do
+        description "Configures the default pagefile, creating if it doesn't exist."
+
+        pagefile = new_resource.path
+        initial_size = new_resource.initial_size
+        maximum_size = new_resource.maximum_size
+        system_managed = new_resource.system_managed
+        automatic_managed = new_resource.automatic_managed
+
+        if automatic_managed
+          set_automatic_managed unless automatic_managed?
+        else
+          unset_automatic_managed if automatic_managed?
+
+          # Check that the resource is not just trying to unset automatic managed, if it is do nothing more
+          if (initial_size && maximum_size) || system_managed
+            validate_name
+            create(pagefile) unless exists?(pagefile)
+
+            if system_managed
+              set_system_managed(pagefile) unless max_and_min_set?(pagefile, 0, 0)
+            else
+              unless max_and_min_set?(pagefile, initial_size, maximum_size)
+                set_custom_size(pagefile, initial_size, maximum_size)
+              end
+            end
+          end
+        end
+      end
+
+      action :delete do
+        description "Deletes the specified pagefile."
+
+        validate_name
+        delete(new_resource.path) if exists?(new_resource.path)
+      end
+
+      action_class do
+        # make sure the provided name property matches the appropriate format
+        # we do this here and not in the property itself because if automatic_managed
+        # is set then this validation is not necessary / doesn't make sense at all
+        def validate_name
+          return if /^.:.*.sys/ =~ new_resource.path
+          raise "#{new_resource.path} does not match the format DRIVE:\\path\\file.sys for pagefiles. Example: C:\\pagefile.sys"
+        end
+
+        # See if the pagefile exists
+        #
+        # @param [String] pagefile path to the pagefile
+        # @return [Boolean]
+        def exists?(pagefile)
+          @exists ||= begin
+            logger.trace("Checking if #{pagefile} exists by runing: wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list")
+            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list", returns: [0])
+            cmd.stderr.empty? && (cmd.stdout =~ /SettingID=#{get_setting_id(pagefile)}/i)
+          end
+        end
+
+        # is the max/min pagefile size set?
+        #
+        # @param [String] pagefile path to the pagefile
+        # @param [String] min the minimum size of the pagefile
+        # @param [String] max the minimum size of the pagefile
+        # @return [Boolean]
+        def max_and_min_set?(pagefile, min, max)
+          @max_and_min_set ||= begin
+            logger.trace("Checking if #{pagefile} min: #{min} and max #{max} are set")
+            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" list /format:list", returns: [0])
+            cmd.stderr.empty? && (cmd.stdout =~ /InitialSize=#{min}/i) && (cmd.stdout =~ /MaximumSize=#{max}/i)
+          end
+        end
+
+        # create a pagefile
+        #
+        # @param [String] pagefile path to the pagefile
+        def create(pagefile)
+          converge_by("create pagefile #{pagefile}") do
+            logger.trace("Running wmic.exe pagefileset create name=\"#{pagefile}\"")
+            cmd = shell_out("wmic.exe pagefileset create name=\"#{pagefile}\"")
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        # delete a pagefile
+        #
+        # @param [String] pagefile path to the pagefile
+        def delete(pagefile)
+          converge_by("remove pagefile #{pagefile}") do
+            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" delete")
+            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" delete")
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        # see if the pagefile is automatically managed by Windows
+        #
+        # @return [Boolean]
+        def automatic_managed?
+          @automatic_managed ||= begin
+            logger.trace("Checking if pagefiles are automatically managed")
+            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" get AutomaticManagedPagefile /format:list")
+            cmd.stderr.empty? && (cmd.stdout =~ /AutomaticManagedPagefile=TRUE/i)
+          end
+        end
+
+        # turn on automatic management of all pagefiles by Windows
+        def set_automatic_managed
+          converge_by("set pagefile to Automatic Managed") do
+            logger.trace("Running wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=True")
+            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=True")
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        # turn off automatic management of all pagefiles by Windows
+        def unset_automatic_managed
+          converge_by("set pagefile to User Managed") do
+            logger.trace("Running wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=False")
+            cmd = shell_out("wmic.exe computersystem where name=\"%computername%\" set AutomaticManagedPagefile=False")
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        # set a custom size for the pagefile (vs the defaults)
+        #
+        # @param [String] pagefile path to the pagefile
+        # @param [String] min the minimum size of the pagefile
+        # @param [String] max the minimum size of the pagefile
+        def set_custom_size(pagefile, min, max)
+          converge_by("set #{pagefile} to InitialSize=#{min} & MaximumSize=#{max}") do
+            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=#{min},MaximumSize=#{max}")
+            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=#{min},MaximumSize=#{max}", returns: [0])
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        # set a pagefile size to be system managed
+        #
+        # @param [String] pagefile path to the pagefile
+        def set_system_managed(pagefile)
+          converge_by("set #{pagefile} to System Managed") do
+            logger.trace("Running wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=0,MaximumSize=0")
+            cmd = shell_out("wmic.exe pagefileset where SettingID=\"#{get_setting_id(pagefile)}\" set InitialSize=0,MaximumSize=0", returns: [0])
+            check_for_errors(cmd.stderr)
+          end
+        end
+
+        def get_setting_id(pagefile)
+          split_path = pagefile.split('\\')
+          "#{split_path[1]} @ #{split_path[0]}"
+        end
+
+        # raise if there's an error on stderr on a shellout
+        def check_for_errors(stderr)
+          raise stderr.chomp unless stderr.empty?
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/windows_path.rb

@@ -20,13 +20,13 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the windows_path resource to manage the path environment variable on Microsoft Windows.
-    #
-    # @since 13.4
     class WindowsPath < Chef::Resource
       resource_name :windows_path
       provides :windows_path
 
+      description "Use the windows_path resource to manage the path environment variable on Microsoft Windows."
+      introduced "13.4"
+
       allowed_actions :add, :remove
       default_action :add
 

data/lib/chef/resource/windows_printer.rb

@@ -0,0 +1,148 @@
+#
+# Author:: Doug Ireton (<doug@1strategy.com>)
+# Copyright:: 2012-2018, Nordstrom, Inc.
+#
+# 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.
+#
+# See here for more info:
+# http://msdn.microsoft.com/en-us/library/windows/desktop/aa394492(v=vs.85).aspx
+
+require "chef/resource"
+
+class Chef
+  class Resource
+    class WindowsPrinter < Chef::Resource
+      require "resolv"
+
+      resource_name :windows_printer
+      provides :windows_printer
+
+      description "Use the windows_printer resource to setup Windows printers. Note"\
+                  " that this doesn't currently install a printer driver. You must"\
+                  " already have the driver installed on the system."
+      introduced "14.0"
+
+      property :device_id, String,
+               description: "Printer queue name, e.g. 'HP LJ 5200 in fifth floor copy room'.",
+               name_property: true
+
+      property :comment, String,
+               description: "Optional descriptor for the printer queue."
+
+      property :default, [TrueClass, FalseClass],
+               description: "Should this be the system's default printer.",
+               default: false
+
+      property :driver_name, String,
+               description: "Exact name of printer driver. Note that the printer driver must already be installed on the node.",
+               required: true
+
+      property :location, String,
+               description: "Printer location, e.g. 'Fifth floor copy room'."
+
+      property :shared, [TrueClass, FalseClass],
+               description: "Should the printer be shared.",
+               default: false
+
+      property :share_name, String,
+               description: "The name to share the printer as."
+
+      property :ipv4_address, String,
+               description: "Printer IPv4 address, e.g. '10.4.64.23'.",
+               validation_message: "The ipv4_address property must be in the IPv4 format of WWW.XXX.YYY.ZZZ",
+               regex: Resolv::IPv4::Regex
+
+      property :exists, [TrueClass, FalseClass],
+               desired_state: true
+
+      PRINTERS_REG_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Print\Printers\\'.freeze unless defined?(PRINTERS_REG_KEY)
+
+      # does the printer exist
+      #
+      # @param [String] name the name of the printer
+      # @return [Boolean]
+      def printer_exists?(name)
+        printer_reg_key = PRINTERS_REG_KEY + name
+        logger.trace "Checking to see if this reg key exists: '#{printer_reg_key}'"
+        registry_key_exists?(printer_reg_key)
+      end
+
+      # @todo Set @current_resource printer properties from registry
+      load_current_value do |desired|
+        name desired.name
+        exists printer_exists?(desired.name)
+      end
+
+      action :create do
+        description "Create a new printer and a printer port if one doesn't already exist."
+
+        if @current_resource.exists
+          Chef::Log.info "#{@new_resource} already exists - nothing to do."
+        else
+          converge_by("Create #{@new_resource}") do
+            create_printer
+          end
+        end
+      end
+
+      action :delete do
+        description "Delete an existing printer. Note this does not delete the associated printer port."
+
+        if @current_resource.exists
+          converge_by("Delete #{@new_resource}") do
+            delete_printer
+          end
+        else
+          Chef::Log.info "#{@current_resource} doesn't exist - can't delete."
+        end
+      end
+
+      action_class do
+        # creates the printer port and then the printer
+        def create_printer
+          # Create the printer port first
+          windows_printer_port new_resource.ipv4_address do
+          end
+
+          port_name = "IP_#{new_resource.ipv4_address}"
+
+          declare_resource(:powershell_script, "Creating printer: #{new_resource.name}") do
+            code <<-EOH
+
+              Set-WmiInstance -class Win32_Printer `
+                -EnableAllPrivileges `
+                -Argument @{ DeviceID   = "#{new_resource.device_id}";
+                            Comment    = "#{new_resource.comment}";
+                            Default    = "$#{new_resource.default}";
+                            DriverName = "#{new_resource.driver_name}";
+                            Location   = "#{new_resource.location}";
+                            PortName   = "#{port_name}";
+                            Shared     = "$#{new_resource.shared}";
+                            ShareName  = "#{new_resource.share_name}";
+                          }
+            EOH
+          end
+        end
+
+        def delete_printer
+          declare_resource(:powershell_script, "Deleting printer: #{new_resource.name}") do
+            code <<-EOH
+              $printer = Get-WMIObject -class Win32_Printer -EnableAllPrivileges -Filter "name = '#{new_resource.name}'"
+              $printer.Delete()
+            EOH
+          end
+        end
+      end
+    end
+  end
+end