[BACK]Return to Trango.pm CVS log [TXT][DIR] Up to [local] / trango / Net-Telnet-Trango / lib / Net / Telnet

Diff for /trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm between version 1.1 and 1.25

version 1.1, 2005/12/29 18:41:17 version 1.25, 2007/01/17 20:48:46
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 use base 'Net::Telnet';  # $RedRiver: Trango.pm,v 1.24 2007/01/17 19:00:51 andrew Exp $
   use strict;
 my %PRIVATE = (  use warnings;
   is_connected => 0,  use base 'Net::Telnet';
   logged_in => 0,  
 );  =pod
   
   =head1 NAME
 sub AUTOLOAD  
 {  Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface
   my $self = shift;  
   =head1 SYNOPSIS
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";    use Net::Telnet::Trango;
     my $t = new Net::Telnet::Trango ( Timeout => 5 );
   my $success = 'Success.';  
   my %MEMBERS = (    $t->open( Host => $fox ) or die "Error connecting: $!";
     ver     => {},  
     sysinfo => { waitfor => $success },    $t->login('password') or die "Couldn't log in: $!";
     tftpd   => { waitfor => $success },  
   );    # Do whatever
   
   my %ACCESS = map { $_ => 1 } qw(    $t->exit;
     firmware_version    $t->close;
     host_type  
     Host  =head1 DESCRIPTION
     is_connected  
     logged_in  Perl access to the telnet interface on Trango Foxes, SUs and APs.
     Timeout  
   );  Another handy feature is that it will parse the output from certain
   commands that is in the format "[key1] value1 [key2] value2" and put
   if (exists $MEMBERS{$method}) {  those in a hashref that is returned.  This makes using the output from
     return $self->cmd($method, $MEMBERS{$method}{waitfor});  things like sysinfo very easy to do.
   }  
   =head2 EXPORT
   if (exists $ACCESS{$method}) {  
     my $var = shift || $PRIVATE{$method};  None
     $PRIVATE{$method} = $var;  
     return $var;  =head1 METHODS
   }  
   =over
   $method = "SUPER::$method";  
   return $self->$method(@_);  =cut
 }  
   our $VERSION = '0.01';
 sub new  
 {  my %PRIVATE = (
   my $class = shift;    is_connected => 0,
   my $args = shift || {};    logged_in => 0,
   );
   $args->{'Timeout'} ||= 5;  
   $args->{'Prompt'}  ||= '/#> *$/';  =pod
   
   foreach my $key (keys %{ $args }) {  =item new
     $PRIVATE{$key} = $args->{$key};  
   }  Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
   
   my $self = $class->SUPER::new(%{ $args });  It also takes an optional parameter 'Decode'.  If not defined it
   bless $self;  defaults to 1, if it is set to 0, it will not decode the output and
   instead return an array of the lines that were returned from the
   #bless $self, $package;  command.
   return $self;  
 }  =cut
   
 sub connect  sub new
 {  {
   my $self = shift;    my $class = shift;
   
   unless ( $self->open(    my %args;
       Host => $self->Host,    if (@_ == 1) {
       Errmode => 'return',      $args{'Host'} = shift;
   ) ) {    } else {
     $! = "Couldn't connect to $self->Host.  Connection timed out.";      %args = @_;
     return undef, undef;    }
   }  
   #$self->dump_log('dump.log');    $args{'Prompt'}  ||= '/#> *$/';
   
   ## Login to remote host.    foreach my $key (keys %args) {
   unless ($self->waitfor(      $PRIVATE{$key} = $args{$key};
     -match => '/password: ?$/i',    }
     -errmode => "return",    $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
   ) ) {    delete $args{'Decode'};
     $! = "problem connecting to host ($self->Host): " . $self->lastline;  
     return undef;    my $self = $class->SUPER::new(%args);
   }    bless $self if ref $self;
   
   $self->login_banner($self->lastline);    return $self;
   }
   $self->is_connected(1);  
   #  _password <new password> <new password>
   return ($self->host_type, $self->firmware_version);  #  ? [command]
 }  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   #  arp -bcast <on|off>
 sub login  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
 {  #  bye
   my $self = shift;  #  cf2cf ap [default|<size>]
   #  date
   my $password = shift;  #  date <month> <day> <year>
   #  freq scantable
   $self->print($password);  #  freq channeltable
   unless ($self->waitfor(  #  freq writescan [<ch#> <h|v>]
     -match => $self->prompt,  #  freq writechannel [<ch#> <freq>] ...
     -errmode => "return",  #  freq <ch #> <h|v>
   ) ) {  #  help [command]
     $! = "login ($self->Host) failed: " . $self->lastline;  #  heater [<on temp> <off temp>]
     return undef;  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
   }  #  log [<# of entries, 1..179>]
   #  log <sum> <# of entries, 1..179>
   $self->logged_in(1);  #  logout
   #  opmode [ap [y]]
   return $self->logged_in;  #  password
 }  #  ping <ip addr>
   #  polar <h|v>
 sub login_banner  #  power <setism|setunii> <max|min|<dBm>>
 {  #  reboot
   my $self = shift;  #  restart
   #  remarks [<str>]
   my $banner = shift || $self->login_banner;  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   my ($type, $ver) = $banner =~  #  sysinfo
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  #  set suid <id>
   #  set apid <id>
   $self->host_type($type);  #  set baseid <id>
   $self->firmware_version($ver);  #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
   return $banner;  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
 }  #  set mir [on|off]
   #  set mir threshold <kbps>
 sub reboot  #  set rssitarget [<ism|unii> <dBm>]
 {  #  set serviceradius [<ism | unii> <miles>]
   my $self = shift;  #  ssrssi <ch #> <h|v>
   #  su [<suid>|all]
   $self->print("reboot\n");  #  su changechannel <all|suid> <ch#> <h|v>
   $self->getline;  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   #  su [live|poweroff|priority]
   return 1;  #  su <ping|info|status> <suid>
 }  #  su powerleveling <all|suid>
   #  su reboot <all|suid>
 sub exit  #  su restart <all|suid>
 {  #  su testrflink <all|suid> [r]
   my $self = shift;  #  su testrflink <setlen> [64..1600]
   #  su testrflink <aptx> [20..100]
   $self->print("exit\n");  #  su sw <suid|all> <sw #> <on|off>
   $self->getline;  #  sudb [dload | view]
   #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
   return 1;  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 }  #  sudb delete <all|<suid>>
   #  sudb modify <suid> <cir|mir> <kbps>
 sub enable_tftpd  #  sudb modify <suid> <su2su> <group id,hex>
 {  #  sudb view
   my $self = shift;  #  sulog [lastmins | sampleperiod <1..60>]
   #  sulog [<# of entry,1..18>]
   my $vals = $self->cmd('tftpd on', 'Success.');  #  survey <ism|unii> <time, sec> <h|v>
   #  sw [<sw #> <on|off>]
   if ($vals->{'Tftpd'} eq 'listen') {  #  temp
     return $vals;  #  tftpd [on|off]
   } else {  #  time
     return undef;  #  time <hour> <min> <sec>
   }  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 }  #  save <systemsetting|sudb>
   #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 sub updateflash  #  updateflash <systemsetting|sudb>
 {  
   my $self = shift;  =pod
   
   my $old = shift;  =back
   my $new = shift;  
   =head2 ACCESSORS
   return undef unless $new;  
   =over
   return $self->cmd("updateflash mainimage $old $new", 'Success.', 90);  
 }  =item Host
   
 sub cmd  returns the name of the host that you are accessing
 {  
   my $self = shift;  =item firmware_version
   
   my $string = shift;  returns the firmware version on the trango if available otherwise undef.
   my $expect_last = shift;  Available after a successful open()
   my $timeout = shift || $self->Timeout;  This is usually only set internally
   
   unless (defined $string) {  =item host_type
     $! = "No command passed";  
     return undef;  returns the type of host from the login banner for example M5830S or M5300S.
   }  Available after a successful open()
   This is usually only set internally
   unless ($self->is_connected) {  
     $! = "Not connected";  =item is_connected
     return undef;  
   }  returns 1 after a successful open() otherwise undef
   This is usually only set internally
   unless ($self->logged_in) {  
     $! = "Not logged in";  =item logged_in
     return undef;  
   }  returns 1 after a successful login() 0 if it failed and undef if
   login() was never called
   my @lines = $self->SUPER::cmd(String => $string, Timeout => $timeout);  This is usually only set internally
   
   my $vals = _decode_lines(@lines);  =item login_banner
   
   unless ($expect_last) {  returns the banner that is displayed when first connected at login.
     return $vals;  Only set after a successful open()
   }  
   This is usually only set internally
   my $last = $self->lastline;  
   =item last_lines
   if ($last =~ /$expect_last$/) {  
     return $vals;  returns the output from the last cmd() that was run as an array ref
   } else {  This is usually only set internally
     warn "Error with command ($string): $last";  
     return undef;  =item last_error
   }  
 }  returns the last error reported.  Should contain the the last entry in
   last_lines
 sub _decode_lines  
 {  =back
   my @lines = @_;  
   =head2 ALIASES
   my %conf;  
   =over
   my $key = '';  
   my $val = '';  =item bye
   my $in_key = 0;  
   my $in_val = 0;  alias of exit()
   
   foreach my $line (@lines) {  =item restart
     my @chars = split //, $line;  
   alias of reboot()
     my $last_key = '';  
     foreach my $c (@chars) {  =back
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  =head2 COMMANDS
         if ($c eq '[') {  
           $in_key = 1;  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
           $in_val = 0;  as such they accept the same options as C<cmd()>.
         } else {  Specifically they take a named paramater "args", for example:
           $in_key = 0;  C<tftpd(args =E<gt> 'on')> would enable tftpd
           $in_val = 0;  
         }  =over
   
         if ($key) {  =item tftpd
           $key =~ s/^\s+//;  
           $key =~ s/\s+$//;  Returns a hash ref of the decoded output from the command.
   
           $val =~ s/^\s+//;  Also see enable_tftpd() and disable_tftpd() as those check for correct output
           $val =~ s/\s+$//;  
   =item ver
           if ($key eq 'Checksum' && $last_key) {  
             # Special case for these bastids.  Returns a hash ref of the decoded output from the command.
             my $new = $last_key;  
             $new =~ s/\s+\S+$//;  =item sysinfo
             $key = $new . " " . $key;  
           }  Returns a hash ref of the decoded output from the command.
   
           $last_key = $key;  =item exit
           $conf{$key} = $val;  
           $key = '';  exits the command session with the trango and closes the connection
           $val = '';  
         }  =item reboot
   
       } elsif ($c eq ']') {  reboots the trango and closes the connection
         $in_val = 1;  
         $in_key = 0;  =item remarks
         $c = shift @chars;  
   Takes an optional argument, which sets the remarks.
       } elsif ($in_key) {  If there is no argument, returns the current remarks.
         $key .= $c;  
   =item sulog
       } elsif ($in_val) {  
         $val .= $c;  returns an array ref of hashes containing each log line.
       }  
     }  =item save_sudb
   }  
   #print Dump \%conf;  returns true on success, undef on failure
   
   if (%conf) {  =item syslog
     return \%conf;  
   } else {  returns the output from the syslog command
     return \@lines;  
   }  =item pipe
 }  
   returns the output from the pipe command
   
   =item maclist
   
   returns the output from the maclist command
   
   =item maclist_reset
   
   resets the maclist.  No useful output.
   
   =item eth_list
   
   returns the output from the eth list command
   
   =item su_info
   
   You need to pass in args => <suid> and it will return the info for that suid.
   
   =item save_ss
   
   saves the config.  Returns 1 on success, undef on failure.
   
   =cut
   
   
   my $success = 'Success.';
   my %COMMANDS = (
     tftpd       => { decode => 'all',   expect => $success },
     ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
     updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
     'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
     reboot      => { no_prompt => 1, cmd_disconnects => 1 },
     remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
     syslog      => { expect => $success },
     'pipe'      => { }, # XXX needs a special decode
     maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
     eth_link    => { String => 'eth link', expect => $success },
     su_info     => { String => 'su info', decode => 'all', expect => $success },
     save_ss     => { String => 'save ss', expect => $success },
     opmode      => { decode => 'all',   expect => $success },
     # eth r, w and reset???
     #su password???
     #_bootloader
     #temp
     #heater
   );
   
   my %ALIASES = (
     bye     => 'exit',
     restart => 'reboot',
   );
   
   my %ACCESS = map { $_ => 1 } qw(
     firmware_version
     host_type
     Host
     is_connected
     logged_in
     login_banner
     Timeout
     last_lines
     last_vals
     last_error
   );
   
   sub AUTOLOAD
   {
     my $self = shift;
   
     my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
       or die "Weird: $AUTOLOAD";
   
     if (exists $ALIASES{$method}) {
       $method = $ALIASES{$method};
       return $self->$method(@_);
     }
   
     if (exists $COMMANDS{$method}) {
       $COMMANDS{$method}{'String'} ||= $method;
       $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
       return $self->cmd(%{ $COMMANDS{$method} }, @_);
     }
   
     if (exists $ACCESS{$method}) {
       my $prev = $PRIVATE{$method};
       ($PRIVATE{$method}) = @_ if @_;
       return $prev;
     }
   
     $method = "SUPER::$method";
     return $self->$method(@_);
   }
   
   =pod
   
   =item open
   
   Calls Net::Telnet::open() then makes sure you get a password prompt so
   you are ready to login() and parses the login banner so you can get
   host_type() and firmware_version()
   
   =cut
   
   sub open
   {
     my $self = shift;
   
     unless ( $self->SUPER::open(@_) ) {
       $self->last_error("Couldn't connect to " . $self->Host . ":  $!");
       return undef;
     }
   
     ## Get to login prompt
     unless ($self->waitfor(
         -match => '/password: ?$/i',
         -errmode => "return",
       ) ) {
       $self->last_error("problem connecting to host (" . $self->Host . "): " .
           $self->lastline);
       return undef;
     }
   
     $self->parse_login_banner($self->lastline);
   
     $self->is_connected(1);
   
     return $self->is_connected;
   }
   
   =pod
   
   =item login
   
   Calls open() if not already connected, then sends the password and sets
   logged_in() if successful
   
   =cut
   
   sub login
   {
     my $self = shift;
   
     unless ($self->is_connected) {
       $self->open or return undef;
     }
   
     my $password = shift;
   
     $self->print($password);
     unless ($self->waitfor(
       -match => $self->prompt,
       -errmode => "return",
     ) ) {
       $self->last_error("login ($self->Host) failed: " . $self->lastline);
       return undef;
     }
   
     $self->logged_in(1);
   
     return $self->logged_in;
   }
   
   =pod
   
   =item parse_login_banner
   
   Takes a login banner (what you get when you first connect to the Trango)
   or reads what is already in login_banner() then parses it and sets
   host_type() and firmware_version() as well as login_banner()
   
   =cut
   
   sub parse_login_banner
   {
     my $self = shift;
   
     if (@_) {
       $self->login_banner(@_);
     }
   
     my $banner = $self->login_banner;
   
     my ($type, $ver) = $banner =~
       /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   
     $self->login_banner($banner);
     $self->host_type($type);
     $self->firmware_version($ver);
   
     return 1;
   }
   
   =pod
   
   =item su_password
   
   C<su_password('new_password'[, 'suid'])> If no suid is specified,
   the default is "all".
   
   =cut
   
   sub su_password
   {
     my $self     = shift;
     my $new_pass = shift || '';
     my $su       = shift || 'all';
   
     unless (defined $new_pass) {
       $self->last_error("No new password");
       #return undef;
     }
   
     return $self->cmd(String => 'su password ' .
                        $su . ' ' .
                        $new_pass . ' ' .
                        $new_pass,
                        expect => $success,
                       );
   }
   
   =pod
   
   =item su_ipconfig
   
   C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
   
   =cut
   
   sub su_ipconfig
   {
           my $self        = shift;
   
           my $suid        = shift;
           my $new_ip      = shift;
           my $new_subnet  = shift;
           my $new_gateway = shift;
   
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                   return undef;
           }
           unless ($new_ip) {
                   $self->last_error("no new_ip passed");
                   return undef;
           }
           unless ($new_subnet) {
                   $self->last_error("no new_subnet passed");
                   return undef;
           }
           unless ($new_gateway) {
                   $self->last_error("no new_gateway passed");
                   return undef;
           }
   
           # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
                        $suid       . ' ' .
                        $new_ip     . ' ' .
                        $new_subnet . ' ' .
                        $new_gateway,
                        expect => $success,
                       );
   }
   
   =pod
   
   =item sudb_view
   
   returns a reference to an array of hashes each containing:
   
     suid
     type
     cir
     mir
     mac
   
   =cut
   
   sub sudb_view
   {
     my $self = shift;
   
     my @lines = $self->cmd( String => 'sudb view', expect => $success );
   
     return undef unless @lines;
   
     unless ($PRIVATE{'Decode'}) {
       return @lines;
     }
   
     my @sus;
     foreach (@lines) {
       next unless $_;
       if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
         my %s = (
           suid => $1,
           type => $2,
           cir  => $3,
           mir  => $4,
           mac  => $5,
         );
   
             $s{'mac'} =~ s/\s//g;
             $s{'mac'} = uc($s{'mac'});
   
         push @sus, \%s;
       }
     }
   
     return \@sus;
   }
   
   =pod
   
   =item sudb_add
   
   Takes the following paramaters
   
           suid : numeric,
           type : (reg|pr)
           cir  : numeric,
           mir  : numeric,
           mac  : Almost any format, it will be reformatted,
   
   and returns true on success or undef otherwise.
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_add
   {
           my $self = shift;
           my $suid = shift;
           my $type = shift;
           my $cir  = shift;
           my $mir  = shift;
           my $mac  = shift;
   
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                   return undef;
           }
   
           unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                   $self->last_error("Invalid type '$type'");
                   return undef;
           }
   
           if ($cir =~ /\D/) {
                   $self->last_error("Invalid CIR '$cir'");
                   return undef;
           }
   
           if ($mir =~ /\D/) {
                   $self->last_error("Invalid MIR '$mir'");
                   return undef;
           }
   
           my $new_mac = $mac;
           $new_mac =~ s/[^0-9A-Fa-f]//;
           unless (length $new_mac == 12) {
                   $self->last_error("Invalid MAC '$mac'");
                   return undef;
           }
           $new_mac = join ' ', $new_mac =~ /../g;
   
           my $string = 'sudb add ' .
                   $suid . ' ' .
                   $type . ' ' .
                   $cir  . ' ' .
                   $mir  . ' ' .
                   $new_mac;
   
   
           return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =item sudb_delete
   
   Takes either 'all' or the  suid of the su to delete
   and returns true on success or undef otherwise.
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_delete
   {
           my $self = shift;
           my $suid = shift;
   
           #if (lc($suid) ne 'all' || $suid =~ /\D/) {
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                   return undef;
           }
   
           return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
   }
   
   =pod
   
   =item sudb_modify
   
   Takes either the  suid of the su to delete
   as well as what you are changing, either "cir, mir or su2su"
   and returns true on success or undef otherwise.
   
   cir and mir also take a value to set the cir/mir to.
   
   su2su takes a group id parameter that is in hex.
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_modify
   {
           my $self  = shift;
           my $suid  = shift;
           my $opt   = shift;
           my $value = shift;
   
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                   return undef;
           }
   
           if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                   if ($value =~ /\D/) {
                           $self->last_error("Invalid $opt '$value'");
                           return undef;
                   }
           } elsif (lc($opt) eq 'su2su') {
                   if ($value =~ /[^0-9A-Za-f]/) {
                           $self->last_error("Invalid MAC '$value'");
                           return undef;
                   }
           } else {
                   $self->last_error("Invalid option '$opt'");
                   return undef;
           }
   
           my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
   
           return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =item enable_tftpd
   
   runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
   =cut
   
   sub enable_tftpd
   {
     my $self = shift;
   
     my $vals = $self->tftpd( args => 'on' );
   
     if ($vals->{'Tftpd'} eq 'listen') {
       return $vals;
     } else {
       return undef;
     }
   }
   
   =pod
   
   =item disable_tftpd
   
   runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
   =cut
   
   sub disable_tftpd
   {
     my $self = shift;
   
     my $vals = $self->tftpd( args => 'off' );
   
     if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
       return $vals;
     } else {
       return undef;
     }
   }
   
   =pod
   
   =item cmd
   
   This does most of the work.  At the heart, it calls Net::Telnet::cmd()
   but it also does some special stuff for Trango.
   
   Normally returns the last lines from from the command
   
   Also accepts these options:
   
   I<decode>
   - if this is true, then it will send the output lines to _decode_lines()
   and then returns the decoded output
   
   I<cmd_disconnects>
   - if this is true, it then sets logged_in() to false, then it will
   close() the connection and then sets is_connected() to false
   
   I<expect>
   - if this is set (usually to 'Success.') it will check for that in the
   last line of output and if it does not, will return undef because the
   command probably failed
   
   I<args>
   - a string containing the command line options that are passed to the
   command
   
   =cut
   
   sub cmd
   {
     my $self = shift;
   
     my @valid_net_telnet_opts = qw(
       String
       Output
       Cmd_remove_mode
       Errmode
       Input_record_separator
       Ors
       Output_record_separator
       Prompt
       Rs
       Timeout
     );
   
     my %cfg;
     if (@_ == 1) {
       $cfg{'String'} = shift;
     } elsif (@_ > 1) {
       %cfg = @_;
     }
   
     $cfg{'Timeout'} ||= $self->Timeout;
   
     unless ($cfg{'String'}) {
       $self->last_error("No command passed");
       return undef;
     }
   
     unless ($self->is_connected) {
       $self->last_error("Not connected");
       return undef;
     }
   
     unless ($self->logged_in) {
       $self->last_error("Not logged in");
       return undef;
     }
   
   
     my %cmd;
     foreach (@valid_net_telnet_opts) {
       if (exists $cfg{$_}) {
         $cmd{$_} = $cfg{$_};
       }
     }
     if ($cfg{'args'}) {
       $cmd{'String'} .= ' ' . $cfg{'args'};
     }
     my @lines;
     unless ($cfg{'no_prompt'}) {
       @lines = $self->SUPER::cmd(%cmd);
     } else {
       $self->print($cmd{'String'});
       @lines = $self->lastline;
     }
   
     $self->last_lines(\@lines);
   
     my $vals = 1;
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
       if ($cfg{'decode'} eq 'each') {
         $vals = _decode_each_line(@lines);
       } elsif ($cfg{'decode'} eq 'sulog') {
         $vals = _decode_sulog(@lines);
       } elsif ($cfg{'decode'} eq 'maclist') {
         $vals = _decode_maclist(@lines);
       } else {
         $vals = _decode_lines(@lines);
       }
     }
   
     $self->last_vals($vals);
   
   
     my $last = $self->lastline;
   
     if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
       if ($cfg{'cmd_disconnects'}) {
         $self->logged_in(0);
         $self->close;
         $self->is_connected(0);
       }
   
       if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
         return $vals;
       } else {
         return @lines;
       }
     } else {
       $self->last_error("Error with command ($cfg{'String'}): $last");
       return undef;
     }
   }
   
   #=item _decode_lines
   
   sub _decode_lines
   {
     my @lines = @_;
   
     my %conf;
   
     my $key = '';
     my $val = undef;
     my $in_key = 0;
     my $in_val = 1;
   
     foreach my $line (@lines) {
       next if $line =~ /$success$/;
   
       my @chars = split //, $line;
   
       my $last_key = '';
       foreach my $c (@chars) {
   
         if ($c eq '[' || $c eq "\r" || $c eq "\n") {
           if ($c eq '[') {
             $in_key = 1;
             $in_val = 0;
           } else {
             $in_key = 0;
             $in_val = 1;
           }
   
           if ($key) {
             $key =~ s/^\s+//;
             $key =~ s/\s+$//;
   
             if (defined $val) {
               $val =~ s/^\s+//;
               $val =~ s/\s+$//;
             }
   
             if ($key eq 'Checksum' && $last_key) {
               # Special case for these bastids.
               my $new = $last_key;
               $new =~ s/\s+\S+$//;
               $key = $new . " " . $key;
             }
   
             $last_key = $key;
             $conf{$key} = $val;
             $key = '';
             $val = '';
           }
   
         } elsif ($c eq ']') {
           $in_val = 1;
           $in_key = 0;
           $c = shift @chars;
   
         } elsif ($in_key) {
           $key .= $c;
   
         } elsif ($in_val) {
           $val .= $c;
         }
       }
     }
   
     if (%conf) {
       return \%conf;
     } else {
       return $val;
     }
   }
   
   #=item _decode_each_line
   
   sub _decode_each_line
   {
     my @lines = @_;
     my @decoded;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
       push @decoded, $decoded if defined $decoded;
     }
     return \@decoded;
   }
   
   #=item _decode_sulog
   
   sub _decode_sulog
   {
     my @lines = @_;
     my @decoded;
     my $last_tm;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
   
       if (defined $decoded) {
         if ($decoded->{'tm'}) {
           $last_tm = $decoded->{'tm'};
           next;
         } else {
           $decoded->{'tm'} = $last_tm;
         }
         next unless $last_tm;
   
         push @decoded, $decoded if defined $decoded;
       }
     }
     return \@decoded;
   }
   
   #=item _decode_maclist
   
   sub _decode_maclist
   {
           my @lines = @_;
           my @decoded;
           my $total_entries = 0;
           my $current_tm = 0;
           foreach my $line (@lines) {
                   $line =~ s/\r?\n$//;
                   my ($mac, $loc, $tm) = $line =~ /
                           ([0-9a-fA-F ]{17})\s+
                           (.*)\s+
                           tm\s+
                           (\d+)
                   /x;
   
                   if ($mac) {
                           $mac =~ s/\s+//g;
                           $loc =~ s/^\s+//;
                           $loc =~ s/\s+$//;
   
                           my $suid = undef;
                           if ($loc =~ /suid\s+=\s+(\d+)/) {
                                   $suid = $1;
                                   $loc = undef;
                           }
   
                           push @decoded, {
                                   mac  => $mac,
                                   loc  => $loc,
                                   tm   => $tm,
                                   suid => $suid,
                           };
                   } elsif ($line =~ /(\d+)\s+entries/) {
                           $total_entries = $1;
                   } elsif ($line =~ /current tm = (\d+)\s+sec/) {
                           $current_tm = $1
                   }
           }
   
           map { $_->{'cur_tm'} = $current_tm } @decoded;
   
           if (scalar @decoded == $total_entries) {
                   return \@decoded;
           } else {
                   # XXX we should have a way to set last error, not sure why we don't
                   return undef;
           }
   }
   
   1;
   __END__
   
   =back
   
   =head1 SEE ALSO
   
   Trango Documentation -
   http://www.trangobroadband.com/support/product_docs.htm
   
   L<Net::Telnet>
   
   =head1 TODO
   
   There are still a lot of commands that are not accessed directly.  If
   you call them (as cmd("command + args") or whatever) and it works,
   please send me examples that work and I will try to get it incorporated
   into the next version of the script.
   
   I also want to be able to parse the different types of output from
   commands like su, sudb all and anything else that would be better
   available as a perl datastructure.
   
   =head1 AUTHOR
   
   Andrew Fresh E<lt>andrew@rraz.netE<gt>
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005 by Andrew Fresh
   
   This library is free software; you can redistribute it and/or modify
   it under the same terms as Perl itself, either Perl version 5.8.7 or,
   at your option, any later version of Perl 5 you may have available.
   
   
   =cut
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.25
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>