File Coverage

blib/lib/RAS/PortMaster.pm

Criterion	Covered	Total	%
statement	6	80	7.5
branch	0	24	0.0
condition			n/a
subroutine	2	8	25.0
pod	6	6	100.0
total	14	118	11.8

### RAS::PortMaster.pm
### PERL 5 module for accessing a Livingston PortMaster
#########################################################

package RAS::PortMaster;
$RAS::PortMaster::VERSION = "1.16";

use strict;

# This uses Net::Telnet to connect to the RAS
use Net::Telnet ;

# The name $ras will be used consistently as the
# reference to the RAS::PortMaster object we're handling


# The constructor method, of course
sub new {
   my($class) = shift ;
   my($ras) = {} ;
   %{$ras} = @_ ;
   $ras->{'VERSION'} = $RAS::PortMaster::VERSION;
   bless($ras);
}


# for debugging - printenv() prints to STDERR
# the entire contents of %$ras
sub printenv {
   my($ras) = shift;
   while (my($key,$value) = each(%{$ras})) { print "$key = $value\n"; }
}


# This runs the specified commands on the router and returns
# a list of refs to arrays containing the commands' output
sub run_command {
   my($ras) = shift;
   my(@returnlist);

   while (my $command = shift) {
      my($session) = new Net::Telnet;
      $session->errmode("return");

      # connect
      $session->open($ras->{'hostname'});
      if ($session->errmsg) {
         warn "ERROR: ",ref($ras),' - ',$session->errmsg,"\n"; return(); }
      # login
      $session->login($ras->{'login'},$ras->{'password'});
      if ($session->errmsg) {
         warn "ERROR: ",ref($ras),' - ',$session->errmsg,"\n"; return(); }
      # we got logged in, so send the command
      $session->print($command);
      $session->print(""); # for some reason, this is necessary to make the prompt appear after the output

      my(@output);
      while (1) {
         my($line) = $session->getline;
         if ($session->errmsg) {
            warn "ERROR: ",ref($ras),' - ',$session->errmsg,"\n"; return(); }
         if ($line =~ /^\s*$/) { next; }
         if ($line =~ /^-- Press Return for More --\s+$/) { $session->print(""); next; }
         if ($line =~ /^[\w\.\-]+\>\s+$/) { $session->print("quit"); $session->close; last; }
         push(@output, $line);
      }


      # Net::Telnet to the PM leaves the echoed command at the start
      shift(@output);
      push(@returnlist, \@output);
   } # end of shifting commands

   # We're returning a list of references to lists.
   # Each ref points to an array containing the returned text
   # from the command, and the list of refs corresponds
   # to the list of commands we were given
   return(@returnlist);
} # end of run_command


# usergrep() - takes a username and returns an array of
# ports on which the user was found
sub usergrep {
   my($ras) = shift;
   my($username) = shift; return() unless $username;
   my($output) = $ras->run_command('sho ses');
   my(@ports);

   foreach (@$output) {
      next unless /^(S\d+)\s+$username\s+/;
      push(@ports, $1);
   }
   return(@ports);
}


# portusage() returns a list: # of ports, list of users
sub portusage {
   my($ras) = shift;
   my($output) = $ras->run_command('sho ses');
   my(@users,$totalports);
   $totalports = 0;

   foreach (@$output) {
      next unless /^S\d+\s+(\S+)\s+/;
      $totalports++;
      next if ($1 =~ /^PPP|\-$/);
      push(@users, $1);
   }
   return($totalports,@users);
}


# This does a usergrep() and then disconnects the specified user
sub userkill {
   my($ras) = shift;
   my($username); $username = shift; return() unless $username;
   my(@ports) = $ras->usergrep($username);
   return('') unless @ports;

   my @resetcmd = ();
   foreach (@ports) { push(@resetcmd,"reset $_"); }
   $ras->run_command(@resetcmd);

   return(@ports);
}


#############################################################
1;#So PERL knows we're cool
__END__;