File Coverage

blib/lib/XAS/Lib/WS/RemoteShell.pm

Criterion	Covered	Total	%
statement	1	3	33.3
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	2	4	50.0

package XAS::Lib::WS::RemoteShell;

our $VERSION = '0.02';

use XAS::Lib::XML;
use XAS::Class
  version   => $VERSION,
  base      => 'XAS::Lib::WS::Base',
  utils     => ':validation dotid',
  codec     => 'base64',
  accessors => 'created command_id shell_id stderr stdout exitcode clixml',
;

# ----------------------------------------------------------------------
# Public Methods
# ----------------------------------------------------------------------

sub create {
    my $self = shift;

    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_create_xml($uuid);

    $self->log->debug(sprintf('create: uuid - %s', $uuid));

    $self->_make_call($xml);

    return $self->_create_response($uuid);

}

sub command {
    my $self = shift;
    my ($command) = validate_params(\@_, [1]);

    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_command_xml($uuid, $command);

    $self->{'stdout'} = '';
    $self->{'stderr'} = '';
    $self->{'exitcode'} = -1;

    $self->log->debug(sprintf('command: uuid - %s', $uuid));

    $self->_make_call($xml);
    $self->_command_response($uuid);

}

sub delete {
    my $self = shift;

    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_delete_xml($uuid);

    $self->_make_call($xml);

    return $self->_delete_response($uuid);

}

sub destroy {
    my $self = shift;

    if ($self->created) {

        $self->delete();

        $self->{'created'} = 0;

    }

}

sub receive {
    my $self = shift;

    my $running;
    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_receive_xml($uuid);

    do {

        $self->_make_call($xml);
        $running = $self->_receive_response($uuid);

    } while ($running);

}

sub send {
    my $self = shift;
    my ($buffer, $eot) = validate_params(\@_, [
        1,
        { optional => 1, default => 1 },
    ]);

    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_send_xml($uuid, $buffer, $eot);

    $self->_make_call($xml);

    return $self->_send_response($uuid);

}

sub signal {
    my $self = shift;

    my $uuid = $self->uuid->create_str;
    my $xml  = $self->_signal_xml($uuid);

    $self->_make_call($xml);

    return $self->_signal_response($uuid);

}

sub check_exitcode {
    my $self = shift;

    my $caller = (caller(1))[3];
    my $errmsg = $self->stdout;

    if ($self->exitcode > 0) {

        if ($self->stderr =~ /CLIXML/) { # Powershell error response

            $self->_parse_clixml();
            $errmsg = $self->clixml->doc->toString();

        } else {

            $errmsg = $self->stderr;

        }

        $self->throw_msg(
            dotid($self->class) . sprintf('.%s.badrc', $caller),
            'ws_badrc',
            $self->exitcode,
            $errmsg
        );

    }

}

# ----------------------------------------------------------------------
# Private Methods
# ----------------------------------------------------------------------

sub _check_command_id {
    my $self = shift;
    my $uuid = shift;

    $self->log->debug(sprintf('check_command_id: %s = %s', $uuid, $self->command_id));

    unless ($uuid eq $self->command_id) {

        $self->throw_msg(
            dotid($self->class) . '.check_command_id.wrongid',
            'ws_wrongid'
        );

    }

}

sub _parse_clixml {
    my $self = shift;

    my $xml = $self->stderr;

    $xml =~ s/\#< CLIXML//g;
    $xml =~ s/_x000D_//g;
    $xml =~ s/_x000A_//g;

    $self->clixml->load($xml);

}

sub _create_response {
    my $self = shift;
    my $uuid = shift;

    my $xpath;
    my $stat = 0;

    $self->_check_relates_to($uuid);

    if ($self->xml->get_item('//x:ResourceCreated')) {

        if (my $item = $self->xml->get_item('//rsp:ShellId')) {

            $self->{'shell_id'} = $item;
            $self->{'created'} = 1;

            $self->log->debug(sprintf('create_response: shell_id = %s', $self->shell_id));

            $stat = 1;

        } else {

            $self->throw_msg(
                dotid($self->class) . '._create_response.shell_id',
                'ws_noshellid',
            );

        }

    } else {

        $self->throw_msg(
            dotid($self->class) . '._create_response.shell_id',
            'ws_noresource',
        );

    }

    return $stat;

}

sub _command_response {
    my $self = shift;
    my $uuid = shift;

    my $xpath = '//rsp:CommandId';

    $self->_check_relates_to($uuid);

    if (my $id = $self->xml->get_item($xpath)) {

        $self->{'command_id'} = $id;

    } else {

        $self->throw_msg(
            dotid($self->class) . '._command_reponse.command_id',
            'ws_nocmdid',
        );

    }

}

sub _receive_response {
    my $self = shift;
    my $uuid = shift;

    my $running = 1;
    my $xpath = '//rsp:ReceiveResponse';

    $self->_check_relates_to($uuid);

    my $elements = $self->xml->get_items($xpath);

    foreach my $element (@$elements) {

        if ($element->nodeName =~ /Stream/) {

            my $name = $element->getAttribute('Name');
            my $id   = $element->getAttribute('CommandId');

            $self->_check_command_id($id);

            if ($name =~ /stdout/) {

                if (my $stuff = $element->textContent) {

                    $self->{'stdout'} .= decode($stuff);

                }

            } elsif ($name =~ /stderr/) {

                if (my $stuff = $element->textContent) {

                    $self->{'stderr'} .= decode($stuff);

                }

            }

        } elsif ($element->nodeName =~ /CommandState/) {

            my $state = $element->getAttribute('State');
            my $id    = $element->getAttribute('CommandId');

            $self->_check_command_id($id);

            $running = ($state =~ /Running/ || 0);

            if (my $children = $element->childNodes) {

                foreach my $child (@$children) {

                    if ($child->nodeName =~ /ExitCode/) {

                        $self->{'exitcode'} = $child->textContent;

                    }

                }

            }

        }

    }

    return $running;

}

sub _send_response {
    my $self = shift;
    my $uuid = shift;

    my $stat = 0;
    my $xpath = '//rsp:SendResponse';

    $self->_check_relates_to($uuid);

    $stat = 1 if ($self->xml->get_items($xpath));

    return $stat;

}

sub _signal_response {
    my $self = shift;
    my $uuid = shift;

    my $stat = 0;
    my $xpath = '//rsp:SignalResponse';

    $self->_check_relates_to($uuid);

    $stat = 1 if ($self->xml->get_item($xpath));

    return $stat;

}

sub _delete_response {
    my $self = shift;
    my $uuid = shift;

    my $stat = 0;
    my $xpath = '//rsp:DeleteResponse';

    $self->_check_relates_to($uuid);

    $stat = 1 if ($self->xml->get_item($xpath));

}

sub init {
    my $class = shift;

    my $self = $class->SUPER::init(@_);

    $self->{'created'} = 0;
    $self->{'clixml'}  = XAS::Lib::XML->new();

    return $self;

}

# ----------------------------------------------------------------------
# XML boilerplate - we're using heredoc for simplcity
#
# XML for ws-manage RemoteShell was taken from
# http://msdn.microsoft.com/en-us/library/cc251731.aspx
# ----------------------------------------------------------------------

sub _command_xml {
    my $self = shift;
    my $uuid = shift;
    my $command = shift;

    my $url      = $self->url;
    my $timeout  = $self->timeout;
    my $shell_id = $self->shell_id;

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url


      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command


      512000


      uuid:$uuid




        $shell_id



      TRUE
      FALSE

    PT$timeout.000S




        "$command"




XML

    return $xml;

}

sub _create_xml {
    my $self = shift;
    my $uuid = shift;

    my $url     = $self->url;
    my $timeout = $self->timeout;

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url


      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.xmlsoap.org/ws/2004/09/transfer/Create


      512000


      uuid:$uuid



      TRUE
      437


      PT$timeout.000S




      stdin
      stdout stderr



XML

    return $xml;

}

sub _delete_xml {
    my $self = shift;
    my $uuid = shift;

    my $url      = $self->url;
    my $timeout  = $self->timeout;
    my $shell_id = $self->shell_id;

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete


      512000


      uuid:$uuid



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        $shell_id


    PT$timeout.000S



XML

    return $xml;

}

sub _receive_xml {
    my $self = shift;
    my $uuid = shift;

    my $url        = $self->url;
    my $timeout    = $self->timeout;
    my $shell_id   = $self->shell_id;
    my $command_id = $self->command_id;

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Receive


      512000


      uuid:$uuid



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        $shell_id


    PT$timeout.000S



      xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell"
      SequenceId="0">

        stdout stderr




XML

    return $xml;

}

sub _send_xml {
    my $self   = shift;
    my $uuid   = shift;
    my $buffer = shift;
    my $eot    = shift;

    my $url        = $self->url;
    my $timeout    = $self->timeout;
    my $shell_id   = $self->shell_id;
    my $command_id = $self->command_id;

    $buffer = encode($buffer);

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Send


      153600


      uuid:$uuid



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        $shell_id


    PT$timeout.000S




        xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell"
        Name="stdin" CommandId="$command_id">
        $buffer




XML

    return $xml;

}

sub _signal_xml {
    my $self = shift;
    my $uuid = shift;

    my $url        = $self->url;
    my $timeout    = $self->timeout;
    my $shell_id   = $self->shell_id;
    my $command_id = $self->command_id;

    my $xml = <<"XML";


  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">


      $url



        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Signal


      512000


      uuid:$uuid



      http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd



        $shell_id


    PT$timeout.000S



      xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell"
      CommandId="$command_id">

        http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate




XML

    return $xml;

}


1;

__END__