[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.22

version 1.1, 2005/12/29 18:41:17 version 1.22, 2007/01/03 19:40:03
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 use base 'Net::Telnet';  # $RedRiver: Trango.pm,v 1.21 2006/10/05 17:10:39 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;  =cut
   }  
   our $VERSION = '0.01';
   $method = "SUPER::$method";  
   return $self->$method(@_);  my %PRIVATE = (
 }    is_connected => 0,
     logged_in => 0,
 sub new  );
 {  
   my $class = shift;  =pod
   my $args = shift || {};  
   =item new
   $args->{'Timeout'} ||= 5;  
   $args->{'Prompt'}  ||= '/#> *$/';  Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
   
   foreach my $key (keys %{ $args }) {  It also takes an optional parameter 'Decode'.  If not defined it
     $PRIVATE{$key} = $args->{$key};  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
   command.
   my $self = $class->SUPER::new(%{ $args });  
   bless $self;  =cut
   
   #bless $self, $package;  sub new
   return $self;  {
 }    my $class = shift;
   
 sub connect    my %args;
 {    if (@_ == 1) {
   my $self = shift;      $args{'Host'} = shift;
     } else {
   unless ( $self->open(      %args = @_;
       Host => $self->Host,    }
       Errmode => 'return',  
   ) ) {    $args{'Prompt'}  ||= '/#> *$/';
     $! = "Couldn't connect to $self->Host.  Connection timed out.";  
     return undef, undef;    foreach my $key (keys %args) {
   }      $PRIVATE{$key} = $args{$key};
   #$self->dump_log('dump.log');    }
     $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
   ## Login to remote host.    delete $args{'Decode'};
   unless ($self->waitfor(  
     -match => '/password: ?$/i',    my $self = $class->SUPER::new(%args);
     -errmode => "return",    bless $self if ref $self;
   ) ) {  
     $! = "problem connecting to host ($self->Host): " . $self->lastline;    return $self;
     return undef;  }
   }  
   #  _password <new password> <new password>
   $self->login_banner($self->lastline);  #  ? [command]
   #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   $self->is_connected(1);  #  arp -bcast <on|off>
   #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
   return ($self->host_type, $self->firmware_version);  #  bye
 }  #  cf2cf ap [default|<size>]
   #  date
 sub login  #  date <month> <day> <year>
 {  #  freq scantable
   my $self = shift;  #  freq channeltable
   #  freq writescan [<ch#> <h|v>]
   my $password = shift;  #  freq writechannel [<ch#> <freq>] ...
   #  freq <ch #> <h|v>
   $self->print($password);  #  help [command]
   unless ($self->waitfor(  #  heater [<on temp> <off temp>]
     -match => $self->prompt,  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
     -errmode => "return",  #  log [<# of entries, 1..179>]
   ) ) {  #  log <sum> <# of entries, 1..179>
     $! = "login ($self->Host) failed: " . $self->lastline;  #  logout
     return undef;  #  opmode [ap [y]]
   }  #  password
   #  ping <ip addr>
   $self->logged_in(1);  #  polar <h|v>
   #  power <setism|setunii> <max|min|<dBm>>
   return $self->logged_in;  #  reboot
 }  #  restart
   #  remarks [<str>]
 sub login_banner  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 {  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   my $self = shift;  #  sysinfo
   #  set suid <id>
   my $banner = shift || $self->login_banner;  #  set apid <id>
   #  set baseid <id>
   my ($type, $ver) = $banner =~  #  set defaultopmode [<ap|su> <min,0..10>]
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  #  set defaultopmode off
   #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   $self->host_type($type);  #  set mir [on|off]
   $self->firmware_version($ver);  #  set mir threshold <kbps>
   #  set rssitarget [<ism|unii> <dBm>]
   return $banner;  #  set serviceradius [<ism | unii> <miles>]
 }  #  ssrssi <ch #> <h|v>
   #  su [<suid>|all]
 sub reboot  #  su changechannel <all|suid> <ch#> <h|v>
 {  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   my $self = shift;  #  su [live|poweroff|priority]
   #  su <ping|info|status> <suid>
   $self->print("reboot\n");  #  su powerleveling <all|suid>
   $self->getline;  #  su reboot <all|suid>
   #  su restart <all|suid>
   return 1;  #  su testrflink <all|suid> [r]
 }  #  su testrflink <setlen> [64..1600]
   #  su testrflink <aptx> [20..100]
 sub exit  #  su sw <suid|all> <sw #> <on|off>
 {  #  sudb [dload | view]
   my $self = shift;  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
   #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
   $self->print("exit\n");  #  sudb delete <all|<suid>>
   $self->getline;  #  sudb modify <suid> <cir|mir> <kbps>
   #  sudb modify <suid> <su2su> <group id,hex>
   return 1;  #  sudb view
 }  #  sulog [lastmins | sampleperiod <1..60>]
   #  sulog [<# of entry,1..18>]
 sub enable_tftpd  #  survey <ism|unii> <time, sec> <h|v>
 {  #  sw [<sw #> <on|off>]
   my $self = shift;  #  temp
   #  tftpd [on|off]
   my $vals = $self->cmd('tftpd on', 'Success.');  #  time
   #  time <hour> <min> <sec>
   if ($vals->{'Tftpd'} eq 'listen') {  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
     return $vals;  #  save <systemsetting|sudb>
   } else {  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
     return undef;  #  updateflash <systemsetting|sudb>
   }  
 }  =pod
   
 sub updateflash  =head1 METHODS
 {  
   my $self = shift;  =head2 ACCESSORS
   
   my $old = shift;  =over
   my $new = shift;  
   =item Host
   return undef unless $new;  
   returns the name of the host that you are accessing
   return $self->cmd("updateflash mainimage $old $new", 'Success.', 90);  
 }  =item firmware_version
   
 sub cmd  returns the firmware version on the trango if available otherwise undef.
 {  Available after a successful open()
   my $self = shift;  This is usually only set internally
   
   my $string = shift;  =item host_type
   my $expect_last = shift;  
   my $timeout = shift || $self->Timeout;  returns the type of host from the login banner for example M5830S or M5300S.
   Available after a successful open()
   unless (defined $string) {  This is usually only set internally
     $! = "No command passed";  
     return undef;  =item is_connected
   }  
   returns 1 after a successful open() otherwise undef
   unless ($self->is_connected) {  This is usually only set internally
     $! = "Not connected";  
     return undef;  =item logged_in
   }  
   returns 1 after a successful login() 0 if it failed and undef if
   unless ($self->logged_in) {  login() was never called
     $! = "Not logged in";  This is usually only set internally
     return undef;  
   }  =item login_banner
   
   my @lines = $self->SUPER::cmd(String => $string, Timeout => $timeout);  returns the banner that is displayed when first connected at login.
   Only set after a successful open()
   my $vals = _decode_lines(@lines);  
   This is usually only set internally
   unless ($expect_last) {  
     return $vals;  =item last_lines
   }  
   returns the output from the last cmd() that was run as an array ref
   my $last = $self->lastline;  This is usually only set internally
   
   if ($last =~ /$expect_last$/) {  =back
     return $vals;  
   } else {  =head2 ALIASES
     warn "Error with command ($string): $last";  
     return undef;  =over
   }  
 }  =item bye
   
 sub _decode_lines  alias of exit()
 {  
   my @lines = @_;  =item restart
   
   my %conf;  alias of reboot()
   
   my $key = '';  =back
   my $val = '';  
   my $in_key = 0;  =head2 COMMANDS
   my $in_val = 0;  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   foreach my $line (@lines) {  as such they accept the same options as C<cmd()>.
     my @chars = split //, $line;  Specifically they take a named paramater "args", for example:
   C<tftpd(args =E<gt> 'on')> would enable tftpd
     my $last_key = '';  
     foreach my $c (@chars) {  =over
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  =item tftpd
         if ($c eq '[') {  
           $in_key = 1;  Returns a hash ref of the decoded output from the command.
           $in_val = 0;  
         } else {  Also see enable_tftpd() and disable_tftpd() as those check for correct output
           $in_key = 0;  
           $in_val = 0;  =item ver
         }  
   Returns a hash ref of the decoded output from the command.
         if ($key) {  
           $key =~ s/^\s+//;  =item sysinfo
           $key =~ s/\s+$//;  
   Returns a hash ref of the decoded output from the command.
           $val =~ s/^\s+//;  
           $val =~ s/\s+$//;  =item exit
   
           if ($key eq 'Checksum' && $last_key) {  exits the command session with the trango and closes the connection
             # Special case for these bastids.  
             my $new = $last_key;  =item reboot
             $new =~ s/\s+\S+$//;  
             $key = $new . " " . $key;  reboots the trango and closes the connection
           }  
   =item remarks
           $last_key = $key;  
           $conf{$key} = $val;  Takes an optional argument, which sets the remarks.
           $key = '';  If there is no argument, returns the current remarks.
           $val = '';  
         }  =item sulog
   
       } elsif ($c eq ']') {  returns an array ref of hashes containing each log line.
         $in_val = 1;  
         $in_key = 0;  =item save_sudb
         $c = shift @chars;  
   returns true on success, undef on failure
       } elsif ($in_key) {  
         $key .= $c;  =item syslog
   
       } elsif ($in_val) {  returns the output from the syslog command
         $val .= $c;  
       }  =item pipe
     }  
   }  returns the output from the pipe command
   #print Dump \%conf;  
   =item maclist
   if (%conf) {  
     return \%conf;  returns the output from the maclist command
   } else {  
     return \@lines;  =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 su_testrflink
   
   you need to pass in args => <suid> and it will return the rflink test results for that SU.
   
   =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 },
     su_testrflink=> { String => 'su testrflink', decode => 'each', 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
   );
   
   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(@_) ) {
       #$! = "Couldn't connect to " . $self->Host . ":  $!";
       return undef;
     }
   
     ## Get to login prompt
     unless ($self->waitfor(
         -match => '/password: ?$/i',
         -errmode => "return",
       ) ) {
       #$! = "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",
     ) ) {
       #$! = "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('all'|suid, 'new_password')>
   
   =cut
   
   sub su_password
   {
     my $self     = shift;
     my $su       = shift || '!';
     my $new_pass = shift || '';
   
     unless (defined $su) {
       warn "No su passed!"
       #return undef;
     }
   
     unless (defined $new_pass) {
       warn "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;
   
           return undef unless $suid =~ /^\d+$/;
           return undef unless $new_ip;
           return undef unless $new_subnet;
           return undef unless $new_gateway;
   
           # 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/) {
                   return undef;
           }
   
           unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                   warn "Invalid type '$type'!";
                   return undef;
           }
   
           if ($cir =~ /\D/) {
                   warn "Invalid CIR '$cir'!";
                   return undef;
           }
   
           if ($mir =~ /\D/) {
                   warn "Invalid MIR '$mir'!";
                   return undef;
           }
   
           my $new_mac = $mac;
           $new_mac =~ s/[^0-9A-Fa-f]//;
           unless (length $new_mac == 12) {
                   warn "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/) {
                   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/) {
                   return undef;
           }
   
           if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                   if ($value =~ /\D/) {
                           return undef;
                   }
           } elsif (lc($opt) eq 'su2su') {
                   if ($value =~ /[^0-9A-Za-f]/) {
                           return undef;
                   }
           } else {
                   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'}) {
       #$! = "No command passed";
       #warn "No command passed\n";
       return undef;
     }
   
     unless ($self->is_connected) {
       #$! = "Not connected";
       #warn "Not connected\n";
       return undef;
     }
   
     unless ($self->logged_in) {
       #$! = "Not logged in";
       #warn "Not logged in\n";
       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 {
       #$! = "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.22
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>