class WinRM::WSMV::Command

WSMV message to execute a command inside a remote shell

Attributes

command_id[R]

Public Class Methods

new(session_opts, cmd_opts) click to toggle source
# File lib/winrm/wsmv/command.rb, line 23
def initialize(session_opts, cmd_opts)
  @command_id = SecureRandom.uuid.to_s.upcase
  validate_opts(session_opts, cmd_opts)
  init_ops(session_opts, cmd_opts)
end

Public Instance Methods

build() click to toggle source
Calls superclass method WinRM::WSMV::Base#build
# File lib/winrm/wsmv/command.rb, line 29
def build
  xml = super
  issue69_unescape_single_quotes(xml)
end

Protected Instance Methods

create_body(body) click to toggle source
# File lib/winrm/wsmv/command.rb, line 40
def create_body(body)
  body.tag!("#{NS_WIN_SHELL}:CommandLine", 'CommandId' => @command_id) do |cl|
    cl << Gyoku.xml(command_body)
  end
end
create_header(header) click to toggle source
# File lib/winrm/wsmv/command.rb, line 36
def create_header(header)
  header << Gyoku.xml(command_headers)
end

Private Instance Methods

command_body() click to toggle source
# File lib/winrm/wsmv/command.rb, line 70
def command_body
  {
    "#{NS_WIN_SHELL}:Command" => "\"#{@command}\"", "#{NS_WIN_SHELL}:Arguments" => @arguments
  }
end
command_header_opts() click to toggle source
# File lib/winrm/wsmv/command.rb, line 84
def command_header_opts
  return {} if @shell_uri != RESOURCE_URI_CMD

  # this is only needed for the regular Windows shell
  {
    "#{NS_WSMAN_DMTF}:OptionSet" => {
      "#{NS_WSMAN_DMTF}:Option" => [@consolemode, @skipcmd], :attributes! => {
        "#{NS_WSMAN_DMTF}:Option" => {
          'Name' => %w[WINRS_CONSOLEMODE_STDIN WINRS_SKIP_CMD_SHELL]
        }
      }
    }
  }
end
command_headers() click to toggle source
# File lib/winrm/wsmv/command.rb, line 76
def command_headers
  merge_headers(shared_headers(@session_opts),
                resource_uri_shell(@shell_uri),
                action_command,
                command_header_opts,
                selector_shell_id(@shell_id))
end
init_ops(session_opts, cmd_opts) click to toggle source
# File lib/winrm/wsmv/command.rb, line 48
def init_ops(session_opts, cmd_opts)
  @session_opts = session_opts
  @shell_id = cmd_opts[:shell_id]
  @command = cmd_opts[:command]
  @arguments = cmd_opts[:arguments] || []
  @shell_uri = cmd_opts[:shell_uri] || RESOURCE_URI_CMD
  @consolemode = cmd_opts.key?(:console_mode_stdin) ? cmd_opts[:console_mode_stdin] : 'TRUE'
  @skipcmd = cmd_opts.key?(:skip_cmd_shell) ? cmd_opts[:skip_cmd_shell] : 'FALSE'
end
issue69_unescape_single_quotes(xml) click to toggle source
# File lib/winrm/wsmv/command.rb, line 64
def issue69_unescape_single_quotes(xml)
  escaped_cmd = %r{<#{NS_WIN_SHELL}:Command>(.+)<\/#{NS_WIN_SHELL}:Command>}m.match(xml)[1]
  xml[escaped_cmd] = escaped_cmd.gsub(/&#39;/, "'")
  xml
end
validate_opts(session_opts, cmd_opts) click to toggle source
# File lib/winrm/wsmv/command.rb, line 58
def validate_opts(session_opts, cmd_opts)
  raise 'session_opts is required' unless session_opts
  raise 'cmd_opts[:shell_id] is required' unless cmd_opts[:shell_id]
  raise 'cmd_opts[:command] is required' unless cmd_opts[:command]
end