path: root/lib/chef/provider/windows_task.rb

#
# Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
# Copyright:: Copyright 2008-2018, 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/mixin/shell_out"
require "rexml/document"
require "iso8601"
require "chef/mixin/powershell_out"

class Chef
  class Provider
    class WindowsTask < Chef::Provider
      include Chef::Mixin::ShellOut
      include Chef::Mixin::PowershellOut

      provides :windows_task, os: "windows"

      def load_current_resource
        self.current_resource = Chef::Resource::WindowsTask.new(new_resource.name)
        pathed_task_name = new_resource.task_name.start_with?('\\') ? new_resource.task_name : "\\#{new_resource.task_name}"

        current_resource.task_name(pathed_task_name)
        task_hash = load_task_hash(pathed_task_name)

        set_current_resource(task_hash) if task_hash.respond_to?(:[]) && task_hash[:TaskName] == pathed_task_name
        current_resource
      end

      def set_current_resource(task_hash)
        current_resource.exists = true
        current_resource.command(task_hash[:TaskToRun])
        current_resource.cwd(task_hash[:StartIn]) unless task_hash[:StartIn] == "N/A"
        current_resource.user(task_hash[:RunAsUser])
        set_current_run_level task_hash[:run_level]
        set_current_frequency task_hash
        current_resource.day(task_hash[:day]) if task_hash[:day]
        current_resource.months(task_hash[:months]) if task_hash[:months]
        set_current_idle_time(task_hash[:idle_time]) if task_hash[:idle_time]
        current_resource.random_delay(task_hash[:random_delay]) if task_hash[:random_delay]
        # schtask sets execution_time_limit as PT72H by default
        current_resource.execution_time_limit(task_hash[:execution_time_limit] || "PT72H")
        current_resource.status = :running if task_hash[:Status] == "Running"
        current_resource.enabled = true if task_hash[:ScheduledTaskState] == "Enabled"
        current_resource.start_time = task_hash[:StartTime] if task_hash[:StartTime]
        current_resource.start_day = task_hash[:StartDate] if task_hash[:StartDate]
      end

      # This method checks if task and command attributes exist since those two are mandatory attributes to create a schedules task.
      def basic_validation
        validate = []
        validate << "Command" if new_resource.command.nil? || new_resource.command.empty?
        validate << "Task Name" if new_resource.task_name.nil? || new_resource.task_name.empty?
        return true if validate.empty?
        raise Chef::Exceptions::ValidationFailed.new "Value for '#{validate.join(', ')}' option cannot be empty"
      end

      # get array of windows task resource attributes
      def resource_attributes
        %w{ command user run_level cwd frequency_modifier frequency idle_time random_delay execution_time_limit start_day start_time }
      end

      def action_create
        if current_resource.exists
          Chef::Log.debug "#{new_resource} task exists."
          if !(task_need_update? || new_resource.force)
            Chef::Log.info "#{new_resource} task does not need updating and force is not specified - nothing to do"
            return
          end
          # Setting the attributes of new_resource as current_resource.
          # This is required to handle update scenarios when the user specifies
          # only those attributes in the recipe which require update
          resource_attributes.each do |attribute|
            new_resource_attribute = new_resource.send(attribute)
            current_resource_attribute = current_resource.send(attribute)
            # We accept start_day in mm/dd/yyyy format only. Hence while copying the start_day from system to new_resource.start_day,
            # we are converting from system date format to mm/dd/yyyy
            current_resource_attribute = convert_system_date_to_mm_dd_yyyy(current_resource_attribute) if attribute == "start_day" && current_resource_attribute != "N/A"
            # Convert start_time into 24hr time format
            current_resource_attribute = DateTime.parse(current_resource_attribute).strftime("%H:%M") if attribute == "start_time" && current_resource_attribute != "N/A"
            new_resource.send("#{attribute}=", current_resource_attribute ) if current_resource_attribute && new_resource_attribute.nil?
          end
        end
        basic_validation
        options = {}
        options["F"] = "" if new_resource.force || task_need_update?
        if schedule == :none
          options["SC"] = :once
          options["ST"] = "00:00"
          options["SD"] = convert_user_date_to_system_date "12/12/2012"
        else
          options["SC"] = schedule
          options["ST"] = new_resource.start_time unless new_resource.start_time.nil? || new_resource.start_time == "N/A"
          options["SD"] = convert_user_date_to_system_date new_resource.start_day unless new_resource.start_day.nil? || new_resource.start_day == "N/A"
        end
        options["MO"] = new_resource.frequency_modifier if frequency_modifier_allowed
        options["I"]  = new_resource.idle_time unless new_resource.idle_time.nil?
        options["TR"] = new_resource.command
        options["RU"] = new_resource.user
        options["RP"] = new_resource.password if use_password?
        options["RL"] = "HIGHEST" if new_resource.run_level == :highest
        options["IT"] = "" if new_resource.interactive_enabled
        options["D"] = new_resource.day if new_resource.day
        options["M"] = new_resource.months unless new_resource.months.nil?
        run_schtasks "CREATE", options
        xml_options = []
        xml_options << "cwd" if new_resource.cwd
        xml_options << "random_delay" if new_resource.random_delay
        xml_options << "execution_time_limit" if new_resource.execution_time_limit

        converge_by("#{new_resource} task created") do
          update_task_xml(xml_options) unless xml_options.empty?
        end
      end

      def action_run
        if current_resource.exists
          Chef::Log.debug "#{new_resource} task exists."
          if current_resource.status == :running
            Chef::Log.info "#{new_resource} task is currently running, skipping run."
          else
            converge_by("run scheduled task #{new_resource}") do
              run_schtasks "RUN"
            end
          end
        else
          Chef::Log.warn "#{new_resource} task does not exist - nothing to do"
        end
      end

      def action_delete
        if current_resource.exists
          Chef::Log.debug "#{new_resource} task exists."
          converge_by("delete scheduled task #{new_resource}") do
            # always need to force deletion
            run_schtasks "DELETE", "F" => ""
          end
        else
          Chef::Log.warn "#{new_resource} task does not exist - nothing to do"
        end
      end

      def action_end
        if current_resource.exists
          Chef::Log.debug "#{new_resource} task exists."
          if current_resource.status != :running
            Chef::Log.debug "#{new_resource} is not running - nothing to do"
          else
            converge_by("#{new_resource} task ended") do
              run_schtasks "END"
            end
          end
        else
          Chef::Log.warn "#{new_resource} task does not exist - nothing to do"
        end
      end

      def action_enable
        if current_resource.exists
          Chef::Log.debug "#{new_resource} task exists."
          if current_resource.enabled
            Chef::Log.debug "#{new_resource} already enabled - nothing to do"
          else
            converge_by("#{new_resource} task enabled") do
              run_schtasks "CHANGE", "ENABLE" => ""
            end
          end
        else
          Chef::Log.fatal "#{new_resource} task does not exist - nothing to do"
          raise Errno::ENOENT, "#{new_resource}: task does not exist, cannot enable"
        end
      end

      def action_disable
        if current_resource.exists
          Chef::Log.info "#{new_resource} task exists."
          if current_resource.enabled
            converge_by("#{new_resource} task disabled") do
              run_schtasks "CHANGE", "DISABLE" => ""
            end
          else
            Chef::Log.warn "#{new_resource} already disabled - nothing to do"
          end
        else
          Chef::Log.warn "#{new_resource} task does not exist - nothing to do"
        end
      end

      private

      # rubocop:disable Style/StringLiteralsInInterpolation
      def run_schtasks(task_action, options = {})
        cmd = "schtasks /#{task_action} /TN \"#{new_resource.task_name}\" "
        options.each_key do |option|
          unless option == "TR"
            cmd += "/#{option} "
            cmd += "\"#{options[option].to_s.gsub('"', "\\\"")}\" " unless options[option] == ""
          end
        end
        # Appending Task Run [TR] option at the end since appending causing sometimes to append other options in option["TR"] value
        if options["TR"]
          cmd += "/TR \"#{options["TR"]} \" " unless task_action == "DELETE"
        end
        Chef::Log.debug("running: ")
        Chef::Log.debug("    #{cmd}")
        shell_out!(cmd, returns: [0])
      end
      # rubocop:enable Style/StringLiteralsInInterpolation

      def task_need_update?
        return true if (new_resource.command &&
            current_resource.command != new_resource.command.tr("'", '"')) ||
            current_resource.user != new_resource.user ||
            current_resource.run_level != new_resource.run_level ||
            current_resource.cwd != new_resource.cwd ||
            current_resource.frequency_modifier != new_resource.frequency_modifier ||
            current_resource.frequency != new_resource.frequency ||
            current_resource.idle_time != new_resource.idle_time ||
            random_delay_updated? || execution_time_limit_updated? ||
            (new_resource.start_day && new_resource.start_day != "N/A" && start_day_updated?) ||
            (new_resource.start_time && new_resource.start_time != "N/A" && start_time_updated?)
        begin
          return true if new_resource.day.to_s.casecmp(current_resource.day.to_s) != 0 ||
              new_resource.months.to_s.casecmp(current_resource.months.to_s) != 0
        rescue
          Chef::Log.debug "caught a raise in task_needs_update?"
        end

        false
      end

      # Comparing random_delay values using ISO8601::Duration object Ref: https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
      # di = ISO8601::Duration.new(65707200)
      # ds = ISO8601::Duration.new('P65707200S')
      # dp = ISO8601::Duration.new('P2Y1MT2H')
      # di == dp # => true
      # di == ds # => true
      def random_delay_updated?
        if new_resource.random_delay.nil?
          false
        elsif current_resource.random_delay.nil? && new_resource.random_delay == "PT0S" # when user sets random_dealy to 0 sec
          false
        elsif current_resource.random_delay.nil?
          true
        else
          ISO8601::Duration.new(current_resource.random_delay) != ISO8601::Duration.new(new_resource.random_delay)
        end
      end

      # Comparing execution_time_limit values using Ref: https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
      def execution_time_limit_updated?
        if new_resource.execution_time_limit.nil?
          false
        elsif current_resource.execution_time_limit.nil? && new_resource.execution_time_limit == "PT0S" # when user sets random_dealy to 0 sec
          false
        elsif current_resource.execution_time_limit.nil?
          true
        else
          ISO8601::Duration.new(current_resource.execution_time_limit) != ISO8601::Duration.new(new_resource.execution_time_limit)
        end
      end

      def start_day_updated?
        current_day = DateTime.strptime(current_resource.start_day, convert_system_date_format_to_ruby_date_format)
        new_day = parse_day(new_resource.start_day)
        current_day != new_day
      end

      def start_time_updated?
        time = DateTime.parse(current_resource.start_time).strftime("%H:%M")
        time != new_resource.start_time
      end

      def convert_user_date_to_system_date(date_in_string)
        parse_day(date_in_string).strftime(convert_system_date_format_to_ruby_long_date)
      end

      def convert_system_date_format_to_ruby_long_date
        date_format = get_system_short_date_format.dup
        date_format.sub!("MMM", "%m")
        common_date_format_conversion(date_format)
        date_format.sub!("yy", "%Y")
        date_format
      end

      def convert_system_date_format_to_ruby_date_format
        date_format = get_system_short_date_format.dup
        date_format.sub!("MMM", "%b")
        common_date_format_conversion(date_format)
        date_format.sub!("yy", "%y")
        date_format
      end

      def common_date_format_conversion(date_format)
        date_format.sub!("dd", "d")
        date_format.sub!("d", "%d")
        date_format.sub!("MM", "%m")
        date_format.sub!("M", "%m")
        date_format.sub!("yyyy", "%Y")
      end

      def get_system_short_date_format
        return @system_short_date_format if @system_short_date_format
        Chef::Log.debug "Finding system date format"
        task_script = <<-EOH
          [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
          [Globalization.Cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern
        EOH
        @system_short_date_format = powershell_out(task_script).stdout.force_encoding("UTF-8").gsub(/[\s+\uFEFF]/, "")
        @system_short_date_format
      end

      def convert_system_date_to_mm_dd_yyyy(system_date)
        system_date_format = convert_system_date_format_to_ruby_date_format
        unless system_date_format == "%m/%d/%Y"
          system_date = Date.strptime(system_date, system_date_format).strftime("%m/%d/%Y")
        end
        system_date
      end

      def update_task_xml(options = [])
        # random_delay xml element is different for different frequencies
        random_delay_xml_element = {
          :minute => "Triggers/TimeTrigger/RandomDelay",
          :hourly => "Triggers/TimeTrigger/RandomDelay",
          :once => "Triggers/TimeTrigger/RandomDelay",
          :daily => "Triggers/CalendarTrigger/RandomDelay",
          :weekly => "Triggers/CalendarTrigger/RandomDelay",
          :monthly => "Triggers/CalendarTrigger/RandomDelay",
          :none => "Triggers",
        }

        xml_element_mapping = {
          "cwd" => "Actions/Exec/WorkingDirectory",
          "random_delay" => random_delay_xml_element[new_resource.frequency],
          "execution_time_limit" => "Settings/ExecutionTimeLimit",
        }

        Chef::Log.debug "looking for existing tasks"

        task_script = <<-EOH
            [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
            schtasks /Query /TN \"#{new_resource.task_name}\" /XML
        EOH
        xml_cmd = powershell_out(task_script)

        return if xml_cmd.exitstatus != 0

        doc = REXML::Document.new(xml_cmd.stdout)

        if new_resource.frequency == :none
          doc.root.elements.delete(xml_element_mapping["random_delay"])
          trigger_element = REXML::Element.new(xml_element_mapping["random_delay"])
          doc.root.elements.add(trigger_element)
        end

        options.each do |option|
          Chef::Log.debug "Removing former #{option} if any"
          doc.root.elements.delete(xml_element_mapping[option])
          option_value = new_resource.send("#{option}")

          if option_value
            Chef::Log.debug "Setting #{option} as #{option_value}"
            split_xml_path = xml_element_mapping[option].split("/") # eg. if xml_element_mapping[option] = "Actions/Exec/WorkingDirectory"
            element_name = split_xml_path.last # element_name = "WorkingDirectory"
            cwd_element = REXML::Element.new(element_name)
            cwd_element.add_text(option_value)
            element_root = (split_xml_path - [element_name]).join("/") # element_root = 'Actions/Exec'
            exec_element = doc.root.elements[element_root]
            exec_element.add_element(cwd_element)
          end
        end

        temp_task_file = ::File.join(ENV["TEMP"], "windows_task.xml")
        begin
          ::File.open(temp_task_file, "w:UTF-16LE") do |f|
            doc.write(f)
          end

          options = {}
          options["RU"] = new_resource.user if new_resource.user
          options["RP"] = new_resource.password if new_resource.password
          options["IT"] = "" if new_resource.interactive_enabled
          options["XML"] = temp_task_file
          run_schtasks("DELETE", "F" => "")
          run_schtasks("CREATE", options)
        ensure
          ::File.delete(temp_task_file)
        end
      end

      def load_task_hash(task_name)
        Chef::Log.debug "Looking for existing tasks"

        task_script = <<-EOH
          [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
          schtasks /Query /FO LIST /V /TN \"#{task_name}\"
        EOH

        output = powershell_out(task_script).stdout.force_encoding("UTF-8")
        if output.empty?
          task = false
        else
          task = {}

          output.split("\n").map! do |line|
            line.split(": ").map!(&:strip)
          end.each do |field|
            if field.is_a?(Array) && field[0].respond_to?(:to_sym)
              key = (field - [field.last]).join(": ")
              task[key.gsub(/\s+/, "").to_sym] = field.last
            end
          end
        end

        task_xml = load_task_xml task_name
        task.merge!(task_xml) if task && task_xml

        task
      end

      def load_task_xml(task_name)
        task_script = <<-EOH
            [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
            schtasks /Query /TN \"#{task_name}\" /XML
        EOH
        xml_cmd = powershell_out(task_script)

        return if xml_cmd.exitstatus != 0

        doc = REXML::Document.new(xml_cmd.stdout)
        root = doc.root

        task = {}
        task[:run_level] = root.elements["Principals/Principal/RunLevel"].text if root.elements["Principals/Principal/RunLevel"]

        # for frequency = :minutes, :hourly
        task[:repetition_interval] = root.elements["Triggers/TimeTrigger/Repetition/Interval"].text if root.elements["Triggers/TimeTrigger/Repetition/Interval"]

        # for frequency = :daily
        task[:schedule_by_day] = root.elements["Triggers/CalendarTrigger/ScheduleByDay/DaysInterval"].text if root.elements["Triggers/CalendarTrigger/ScheduleByDay/DaysInterval"]

        # for frequency = :weekly
        task[:schedule_by_week] = root.elements["Triggers/CalendarTrigger/ScheduleByWeek/WeeksInterval"].text if root.elements["Triggers/CalendarTrigger/ScheduleByWeek/WeeksInterval"]
        if root.elements["Triggers/CalendarTrigger/ScheduleByWeek/DaysOfWeek"]
          task[:day] = []
          root.elements["Triggers/CalendarTrigger/ScheduleByWeek/DaysOfWeek"].elements.each do |e|
            task[:day] << e.to_s[0..3].delete("<").delete("/>")
          end
          task[:day] = task[:day].join(", ")
        end

        # for frequency = :monthly
        task[:schedule_by_month] = root.elements["Triggers/CalendarTrigger/ScheduleByMonth/DaysOfMonth/Day"].text if root.elements["Triggers/CalendarTrigger/ScheduleByMonth/DaysOfMonth/Day"]
        if root.elements["Triggers/CalendarTrigger/ScheduleByMonth/Months"]
          task[:months] = []
          root.elements["Triggers/CalendarTrigger/ScheduleByMonth/Months"].elements.each do |e|
            task[:months] << e.to_s[0..3].delete("<").delete("/>")
          end
          task[:months] = task[:months].join(", ")
        end

        task[:on_logon] = true if root.elements["Triggers/LogonTrigger"]
        task[:onstart] = true if root.elements["Triggers/BootTrigger"]
        task[:on_idle] = true if root.elements["Triggers/IdleTrigger"]

        task[:idle_time] = root.elements["Settings/IdleSettings/Duration"].text if root.elements["Settings/IdleSettings/Duration"] && task[:on_idle]

        task[:none] = true if root.elements["Triggers/"] && root.elements["Triggers/"].entries.empty?
        task[:once] = true if !(task[:repetition_interval] || task[:schedule_by_day] || task[:schedule_by_week] || task[:schedule_by_month] || task[:on_logon] || task[:onstart] || task[:on_idle] || task[:none])
        task[:execution_time_limit] = root.elements["Settings/ExecutionTimeLimit"].text if root.elements["Settings/ExecutionTimeLimit"] #by default PT72H
        task[:random_delay] = root.elements["Triggers/TimeTrigger/RandomDelay"].text if root.elements["Triggers/TimeTrigger/RandomDelay"]
        task[:random_delay] = root.elements["Triggers/CalendarTrigger/RandomDelay"].text if root.elements["Triggers/CalendarTrigger/RandomDelay"]
        task
      end

      SYSTEM_USERS = ['NT AUTHORITY\SYSTEM', "SYSTEM", 'NT AUTHORITY\LOCALSERVICE', 'NT AUTHORITY\NETWORKSERVICE', 'BUILTIN\USERS', "USERS"].freeze

      def use_password?
        @use_password ||= !SYSTEM_USERS.include?(new_resource.user.upcase)
      end

      def schedule
        case new_resource.frequency
        when :on_logon
          "ONLOGON"
        when :on_idle
          "ONIDLE"
        else
          new_resource.frequency
        end
      end

      def frequency_modifier_allowed
        case new_resource.frequency
        when :minute, :hourly, :daily, :weekly
          true
        when :monthly
          new_resource.months.nil? || %w{ FIRST SECOND THIRD FOURTH LAST LASTDAY }.include?(new_resource.frequency_modifier)
        else
          false
        end
      end

      def set_current_run_level(run_level)
        case run_level
        when "HighestAvailable"
          current_resource.run_level(:highest)
        when "LeastPrivilege"
          current_resource.run_level(:limited)
        end
      end

      def set_current_frequency(task_hash)
        if task_hash[:repetition_interval]
          duration = ISO8601::Duration.new(task_hash[:repetition_interval])
          if task_hash[:repetition_interval].include?("M")
            current_resource.frequency(:minute)
            current_resource.frequency_modifier(duration.minutes.atom.to_i)
          elsif task_hash[:repetition_interval].include?("H")
            current_resource.frequency(:hourly)
            current_resource.frequency_modifier(duration.hours.atom.to_i)
          end
        end

        if task_hash[:schedule_by_day]
          current_resource.frequency(:daily)
          current_resource.frequency_modifier(task_hash[:schedule_by_day].to_i)
        end

        if task_hash[:schedule_by_week]
          current_resource.frequency(:weekly)
          current_resource.frequency_modifier(task_hash[:schedule_by_week].to_i)
        end

        current_resource.frequency(:monthly) if task_hash[:schedule_by_month]
        current_resource.frequency(:on_logon) if task_hash[:on_logon]
        current_resource.frequency(:onstart) if task_hash[:onstart]
        current_resource.frequency(:on_idle) if task_hash[:on_idle]
        current_resource.frequency(:once) if task_hash[:once]
        current_resource.frequency(:none) if task_hash[:none]
      end

      def set_current_idle_time(idle_time)
        duration = ISO8601::Duration.new(idle_time)
        current_resource.idle_time(duration.minutes.atom.to_i)
      end

      def parse_day(str)
        Date.strptime(str, "%m/%d/%Y")
      end

    end
  end
end