[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.2 and 1.51

version 1.2, 2005/12/30 01:02:41 version 1.51, 2008/02/18 16:37:35
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver$  
 use strict;  # $RedRiver: Trango.pm,v 1.50 2008/02/08 19:32:15 andrew Exp $
 use warnings;  use strict;
 use base 'Net::Telnet';  use warnings;
   use base 'Net::Telnet';
 =pod  
   =pod
 =head1 NAME  
   =head1 NAME
 Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface  
   Net::Telnet::Trango
 =head1 SYNOPSIS  - Perl extension for accessing the Trango telnet interface
   
   use Net::Telnet::Trango;  =head1 SYNOPSIS
   my $t = new Net::Telnet::Trango ({  
     Host    => $fox,    use Net::Telnet::Trango;
     Timeout => 5,    my $t = new Net::Telnet::Trango ( Timeout => 5 );
   });  
       $t->open( Host => $ap ) or die "Error connecting: $!";
   my ($type, $version) = $t->open;  
       $t->login('password') or die "Couldn't log in: $!";
   unless (defined $type && defined $version) {  
     die "Error connecting: $!";    # Do whatever
   }  
     $t->exit;
   $t->login('password') or die "Couldn't log in: $!";    $t->close;
     
   # Do whatever  =head1 DESCRIPTION
     
   $t->exit;  Perl access to the telnet interface on Trango APs and SUs.
   $t->close;  
   A handy feature is that it will parse the output from certain commands that is
 =head1 DESCRIPTION  in the format "[key1] value1 [key2] value2" and put those in a hashref that is
   returned.  This makes using the output from things like sysinfo very easy to
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  do.
   
 Another handy feature is that it will parse the output from certain commands that is in the format "[key1] value1 [key2] value2" and put those in a hashref that is returned.  This makes using the output from things like sysinfo very easy to do.  =head2 EXPORT
   
 =head2 EXPORT  None
   
 None  =head1 METHODS
   
 =cut  =cut
   
 our $VERSION = '0.01';  our $VERSION = '0.01';
   
 my %PRIVATE = (  my $EMPTY = q{};
   is_connected => 0,  my $SPACE = q{ };
   logged_in => 0,  
 );  my %PRIVATE = (
       is_connected => 0,
 =pod      logged_in    => 0,
   );
 =head1 METHODS  
   =pod
 =head2 ACCESSORS  
   =head2 B<new> - Creates a new Net::Telnet::Trango object.
 =over  
       new([Options from Net::Telnet,]
 =item Host          [Decode => 0,]);
   
 returns the name of the host that you are accessing  Same as new from L<Net::Telnet> but sets the default Trango Prompt:
   '/#> *$/'
 =item firmware_version  
   It also takes an optional parameter 'Decode'.  If not defined it
 returns the firmware version on the trango if available otherwise undef.    defaults to 1, if it is set to 0, it will not decode the output and
 Available after a successful open()  instead return a reference to an array of the lines that were returned
 This is usually only set internally  from the command.
   
 =item host_type  =cut
   
 returns the type of host from the login banner for example M5830S or M5300S.    sub new {
 Available after a successful open()      my $class = shift;
 This is usually only set internally  
       my %args;
 =item is_connected      if ( @_ == 1 ) {
           $args{'Host'} = shift;
 returns 1 after a successful open() otherwise undef      }
 This is usually only set internally      else {
           %args = @_;
 =item logged_in      }
   
 returns 1 after a successful login() 0 if it failed and undef if      $args{'Prompt'} ||= '/#> *$/';
 login() was never called  
 This is usually only set internally      foreach my $key ( keys %args ) {
           $PRIVATE{$key} = $args{$key};
 =item login_banner      }
       $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
 returns the banner that is displayed when first connected at login.  Only set after a successful open()      delete $args{'Decode'};
   
 This is usually only set internally      my $self = $class->SUPER::new(%args);
       bless $self if ref $self;
 =item last_lines  
       return $self;
 returns the output from the last cmd() that was run as an array ref  }
 This is usually only set internally  
   #  _password <new password> <new password>
 =back  #  ? [command]
   #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
 =head2 ALIASES  #  arp -bcast <on|off>
   #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
 =over  #  bye
   #  cf2cf ap [default|<size>]
 =item bye  #  date
   #  date <month> <day> <year>
 alias of exit()  #  freq scantable
   #  freq channeltable
 =item reboot  #  freq writescan [<ch#> <h|v>]
   #  freq writechannel [<ch#> <freq>] ...
 alias of restart()  #  freq <ch #> <h|v>
   #  help [command]
 =back  #  heater [<on temp> <off temp>]
   #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 =head2 COMMANDS  #  linktest <suid> [<pkt len, bytes> [<# of pkts> [<# of cycle>]]]
   #  log [<# of entries, 1..179>]
 Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>, as such they accept the same options as C<cmd()>.  Specifically they take a named paramater "args", for example:  #  log <sum> <# of entries, 1..179>
 C<tftpd(args =E<gt> 'on')> would enable tftpd  #  logout
   #  opmode [ap [y]]
 =over  #  password
   #  ping <ip addr>
 =item tftpd  #  polar <h|v>
   #  power <setism|setunii> <max|min|<dBm>>
 Returns a hash ref of the decoded output from the command.  #  reboot
   #  restart
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  #  remarks [<str>]
   #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 =item ver  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  sysinfo
 Returns a hash ref of the decoded output from the command.  #  set suid <id>
   #  set apid <id>
 =item sysinfo  #  set baseid <id>
   #  set defaultopmode [<ap|su> <min,0..10>]
 Returns a hash ref of the decoded output from the command.  #  set defaultopmode off
   #  set snmpcomm [<read | write | trap (id or setall)> <str>]
 =item exit  #  set mir [on|off]
   #  set mir threshold <kbps>
 exits the command session with the trango and closes the connection  #  set rssitarget [<ism|unii> <dBm>]
   #  set serviceradius [<ism | unii> <miles>]
 =item reboot  #  ssrssi <ch #> <h|v>
   #  su [<suid>|all]
 reboots the trango and closes the connection  #  su changechannel <all|suid> <ch#> <h|v>
   #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
 =cut  #  su [live|poweroff|priority]
   #  su <ping|info|status> <suid>
 #  _password <new password> <new password>  #  su powerleveling <all|suid>
 #  ? [command]  #  su reboot <all|suid>
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  #  su restart <all|suid>
 #  arp -bcast <on|off>  #  su testrflink <all|suid> [r]
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...  #  su testrflink <setlen> [64..1600]
 #  bye  #  su testrflink <aptx> [20..100]
 #  cf2cf ap [default|<size>]  #  su sw <suid|all> <sw #> <on|off>
 #  date  #  sudb [dload | view]
 #  date <month> <day> <year>  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
 #  freq scantable  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 #  freq channeltable  #  sudb delete <all|<suid>>
 #  freq writescan [<ch#> <h|v>]  #  sudb modify <suid> <cir|mir> <kbps>
 #  freq writechannel [<ch#> <freq>] ...  #  sudb modify <suid> <su2su> <group id,hex>
 #  freq <ch #> <h|v>  #  sudb view
 #  help [command]  #  sulog [lastmins | sampleperiod <1..60>]
 #  heater [<on temp> <off temp>]  #  sulog [<# of entry,1..18>]
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  #  survey <ism|unii> <time, sec> <h|v>
 #  log [<# of entries, 1..179>]  #  sw [<sw #> <on|off>]
 #  log <sum> <# of entries, 1..179>  #  temp
 #  logout  #  tftpd [on|off]
 #  opmode [ap [y]]  #  time
 #  password  #  time <hour> <min> <sec>
 #  ping <ip addr>  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 #  polar <h|v>  #  save <systemsetting|sudb>
 #  power <setism|setunii> <max|min|<dBm>>  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 #  reboot  #  updateflash <systemsetting|sudb>
 #  restart  
 #  remarks [<str>]  =pod
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  =head1 ACCESSORS
 #  sysinfo  
 #  set suid <id>  These are usually only set internally.
 #  set apid <id>  
 #  set baseid <id>  =head2 B<firmware_version> - returns the firmware version
 #  set defaultopmode [<ap|su> <min,0..10>]  
 #  set defaultopmode off  Returns the firmware version if available, otherwise undef.
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  
 #  set mir [on|off]  It should be available after a successful open().
 #  set mir threshold <kbps>  
 #  set rssitarget [<ism|unii> <dBm>]  =head2 B<host_type> - return the type of host you are connected to.
 #  set serviceradius [<ism | unii> <miles>]  
 #  ssrssi <ch #> <h|v>  returns the type of host from the login banner for example M5830S or M5300S.
 #  su [<suid>|all]  
 #  su changechannel <all|suid> <ch#> <h|v>  Should be available after a successful open().
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  
 #  su [live|poweroff|priority]  =head2 B<is_connected> - Status of the connection to host.
 #  su <ping|info|status> <suid>  
 #  su powerleveling <all|suid>  returns 1 when connected, undef otherwise.
 #  su reboot <all|suid>  
 #  su restart <all|suid>  =head2 B<logged_in> - Status of being logged in to the host.
 #  su testrflink <all|suid> [r]  
 #  su testrflink <setlen> [64..1600]  returns 1 after a successful login(), 0 if it failed and undef if
 #  su testrflink <aptx> [20..100]  login() was never called.
 #  su sw <suid|all> <sw #> <on|off>  
 #  sudb [dload | view]  =head2 B<login_banner> - The banner when first connecting to the host.
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  returns the banner that is displayed when first connected at login.
 #  sudb delete <all|<suid>>  Only set after a successful open().
 #  sudb modify <suid> <cir|mir> <kbps>  
 #  sudb modify <suid> <su2su> <group id,hex>  =head2 B<last_lines> - The last lines of output from the last cmd().
 #  sudb view  
 #  sulog [lastmins | sampleperiod <1..60>]  returns, as an array ref, the output from the last cmd() that was run.
 #  sulog [<# of entry,1..18>]  
 #  survey <ism|unii> <time, sec> <h|v>  =head2 B<last_error> - A text output of the last error that was encountered.
 #  sw [<sw #> <on|off>]  
 #  temp  returns the last error reported.  Probably contains the last entry in
 #  tftpd [on|off]  last_lines.
 #  time  
 #  time <hour> <min> <sec>  =head1 ALIASES
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  
 #  save <systemsetting|sudb>  =head2 B<bye> - alias of exit()
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  
 #  updateflash <systemsetting|sudb>  Does the same as exit()
   
   =head2 B<restart> - alias of reboot()
 my $success = 'Success.';  
 my %COMMANDS = (  Does the same as reboot()
   tftpd       => { decode => 1, expect => $success },  
   ver         => { decode => 1 },  =head2 B<save_systemsetting> - alias of save_ss()
   sysinfo     => { decode => 1, expect => $success },  
   updateflash => { decode => 1, expect => $success },  Does the same as save_ss()
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  =head1 COMMANDS
 );  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
 my %ALIASES = (  as such they accept the same options as C<cmd()>.
   bye     => 'exit',  Specifically they take a named paramater "args", for example:
   restart => 'reboot',  C<tftpd(args =E<gt> 'on')> would enable tftpd
 );  
   =head2 B<tftpd> - The output from the tftpd command
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  Returns a hash ref of the decoded output from the
   host_type  command.
   Host  
   is_connected  Also see enable_tftpd() and disable_tftpd() as those check that it was
   logged_in  successfully changed.
   login_banner  
   Timeout  =head2 B<ver> - The output from the ver command
   last_lines  
 );  Returns a hash ref of the decoded output from the
   command.
 sub AUTOLOAD  
 {  =head2 B<sysinfo> - The output from the sysinfo command
   my $self = shift;  
   Returns a hash ref of the decoded output from the
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  command.
     or die "Weird: $AUTOLOAD";  
   =head2 B<exit> - Exits the connection
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  exits the command session with the Trango and closes
     return $self->$method(@_);  the connection
   }  
   =head2 B<reboot> - Sends a reboot command
   if (exists $COMMANDS{$method}) {  
     $COMMANDS{$method}{'String'} ||= $method;  reboots the Trango and closes the connection
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  =head2 B<remarks> - Set or retrieve the remarks.
   
   if (exists $ACCESS{$method}) {  Takes an optional argument, which sets the remarks.
     my $prev = $PRIVATE{$method};  If there is no argument, returns the current remarks.
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;    my $old_remarks = $t->remarks();
   }    $t->remarks($new_remarks);
   
   $method = "SUPER::$method";  =head2 B<sulog> - The output from the sulog command
   return $self->$method(@_);  
 }  Returns an array ref of hashes containing each log
   line.
 =pod  
   =head2 B<save_sudb> - saves the sudb
 =item new  
   Returns true on success, undef on failure
 =cut  
   =head2 B<syslog> - The output from the sulog command
 sub new  
 {  Returns a hashref of the output from the syslog command
   my $class = shift;  
   my $args = shift || {};  =head2 B<pipe> - the pipe command
   
   $args->{'Timeout'} ||= 5;  Returns the output from the pipe command
   $args->{'Prompt'}  ||= '/#> *$/';  
   =head2 B<maclist> - retrieves the maclist
   foreach my $key (keys %{ $args }) {  
     $PRIVATE{$key} = $args->{$key};  Returns the output from the maclist command
   }  
   =head2 B<maclist_reset> - resets the maclist.
   my $self = $class->SUPER::new(%{ $args });  
   bless $self if ref $self;  No useful output.
   
   return $self;  =head2 B<eth_link> - eth link command
 }  
   Returns the output from the eth link command
 =pod  
   This command seems to cause some weird issues.  It often will cause the
 =item open  command after it to appear to fail.  I am not sure why.
   
 =cut  =head2 B<su_info> - gets the su info
   
 sub open  Returns information about the SU.
 {  
   my $self = shift;  You need to pass in the $suid and it will return the info for that suid.
   
   unless ( $self->SUPER::open(    $t->su_info($suid);
       #Host => $self->Host,  
       #Errmode => 'return',  =head2 B<su_testrflink> - tests the RF Link to an su
   ) ) {  
     #$! = "Couldn't connect to " . $self->Host . ":  $!";    $t->su_testrflink($suid|'all');
     return undef;  
   }  =head2 B<save_ss> - saves the config.
   #$self->dump_log('dump.log');  
   Returns 1 on success, undef on failure.
   ## Login to remote host.  
   unless ($self->waitfor(  =head2 B<opmode> - sets opmode ap y or returns the opmode
     -match => '/password: ?$/i',  
     -errmode => "return",      $t->opmode([ap y]);
   ) ) {  
   #$! = "problem connecting to host (" . $self->Host . "): " .  =cut
   #    $self->lastline;  
     return undef;  my $success  = 'Success\\.';
   }  my %COMMANDS = (
       _clear      => { String => "\n" },
   $self->parse_login_banner($self->lastline);      tftpd       => { decode    => 'all',       expect          => $success },
       ver         => { decode    => 'all' },
   $self->is_connected(1);      sysinfo     => { decode    => 'all',       expect          => $success },
       updateflash => { decode    => 'all',       expect          => $success },
   return $self->is_connected;      sulog       => { decode    => 'sulog',     expect          => $success },
 }      'exit'      => { no_prompt => 1,           cmd_disconnects => 1 },
       reboot      => { no_prompt => 1,           cmd_disconnects => 1 },
 =pod      remarks     => { decode    => 'all',       expect          => $success },
       save_sudb   => { String    => 'save sudb', expect          => $success },
 =item login      syslog      => { expect    => $success },
       'pipe'      => {},                        # XXX needs a special decode
 =cut      maclist     => { decode => 'maclist' },
       maclist_reset => { String => 'maclist reset', expect       => 'done' },
 sub login      eth_link    => { String => 'eth link',     expect          => $success },
 {      su_info     =>
   my $self = shift;        { String => 'su info',  decode => 'all', expect          => $success },
       su_testrflink =>
   unless ($self->is_connected) {        { String => 'su testrflink', decode => 'each', expect    => $success },
     $self->open or return undef;      save_ss     => { String => 'save ss',      expect          => $success },
   }      opmode      => { decode => 'all',          expect          => $success },
       arq         => { decode => 'all' },
   my $password = shift;  );
   
   $self->print($password);  my %ALIASES = (
   unless ($self->waitfor(      bye     => 'exit',
     -match => $self->prompt,      restart => 'reboot',
     -errmode => "return",      Host    => 'host',
   ) ) {      save_systemseting => 'save_ss',
     #$! = "login ($self->Host) failed: " . $self->lastline;  );
     return undef;  
   }  my %ACCESS = map { $_ => 1 } qw(
     firmware_version
   $self->logged_in(1);    host_type
     is_connected
   return $self->logged_in;    logged_in
 }    login_banner
     Timeout
 =pod    last_lines
     last_vals
 =item parse_login_banner    last_error
     Decode
 =cut  );
   
 sub parse_login_banner  sub AUTOLOAD {
 {      my $self = shift;
   my $self = shift;  
       my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/
   if (@_) {        or die "Weird: $AUTOLOAD";
     $self->login_banner(@_);  
   }      if ( exists $ALIASES{$method} ) {
           $method = $ALIASES{$method};
   my $banner = $self->login_banner;          return $self->$method(@_);
       }
   my ($type, $ver) = $banner =~  
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;      if ( exists $COMMANDS{$method} ) {
           my %cmd;
   $self->login_banner($banner);          foreach my $k ( keys %{ $COMMANDS{$method} } ) {
   $self->host_type($type);              $cmd{$k} = $COMMANDS{$method}{$k};
   $self->firmware_version($ver);          }
           $cmd{'String'} ||= $method;
   return 1;          $cmd{'args'} .= $SPACE . shift if ( @_ == 1 );
 }          return $self->cmd( %cmd, @_ );
       }
 =pod  
       if ( exists $ACCESS{$method} ) {
 =item enable_tftpd          my $prev = $PRIVATE{$method};
           ( $PRIVATE{$method} ) = @_ if @_;
 =cut          return $prev;
       }
 sub enable_tftpd  
 {      $method = "SUPER::$method";
   my $self = shift;      return $self->$method(@_);
   }
   my $vals = $self->tftpd( args => 'on' );  
   =pod
   if ($vals->{'Tftpd'} eq 'listen') {  
     return $vals;  =head2 B<open> - Open a connection to a Trango AP.
   } else {  
     return undef;  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()
   
 =pod  =cut
   
 =item disable_tftpd  sub open {
       my $self = shift;
 =cut  
       unless ( $self->SUPER::open(@_) ) {
 sub disable_tftpd          $self->last_error( "Couldn't connect to " . $self->host . ":  $!" );
 {          return;
   my $self = shift;      }
   
   my $vals = $self->tftpd( args => 'off' );      ## Get to login prompt
       unless (
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {          $self->waitfor(
     return $vals;              -match   => '/password: ?$/i',
   } else {              -errmode => "return",
     return undef;          )
   }        )
 }      {
           $self->last_error( "problem connecting to host ("
 =pod                . $self->host . "): "
                 . $self->lastline );
 =item cmd          return;
       }
 =cut  
       $self->parse_login_banner( $self->lastline );
 sub cmd  
 {      $self->is_connected(1);
   my $self = shift;  
       return $self->is_connected;
   my @valid_net_telnet_opts = qw(  }
     String  
     Output  =pod
     Cmd_remove_mode  
     Errmode  =head2 B<login> - Login to the AP.
     Input_record_separator  
     Ors  Calls open() if not already connected, then sends the password and sets
     Output_record_separator  logged_in() if successful
     Prompt  
     Rs  =cut
     Timeout  
   );  sub login {
       my $self = shift;
   my %cfg;  
   if (@_ == 2) {      unless ( $self->is_connected ) {
     $cfg{'String'} = shift;          $self->open or return;
   } elsif (@_ > 2) {      }
     %cfg = @_;  
   }      my $password = shift;
   
   $cfg{'Timeout'} ||= $self->Timeout;      $self->print($password);
       unless (
   unless ($cfg{'String'}) {          $self->waitfor(
     #$! = "No command passed";              -match   => $self->prompt,
     warn "No command passed\n";              -errmode => "return",
     return undef;          )
   }        )
       {
   unless ($self->is_connected) {          $self->last_error( "login ($self->host) failed: " . $self->lastline );
     #$! = "Not connected";          return;
     warn "Not connected\n";      }
     return undef;  
   }      $self->logged_in(1);
   
   unless ($self->logged_in) {      return $self->logged_in;
     #$! = "Not logged in";  }
     warn "Not logged in\n";  
     return undef;  =pod
   }  
   =head2 B<parse_login_banner> - Converts the login_banner to something useful.
   
   my %cmd;  Takes a login banner (what you get when you first connect to the Trango)
   foreach (@valid_net_telnet_opts) {  or reads what is already in login_banner() then parses it and sets
     if (exists $cfg{$_}) {  host_type() and firmware_version() as well as login_banner()
       $cmd{$_} = $cfg{$_};  
     }  =cut
   }  
   if ($cfg{'args'}) {  sub parse_login_banner {
     $cmd{'String'} .= ' ' . $cfg{'args'};      my $self = shift;
   }  
   my @lines = $self->SUPER::cmd(%cmd);      if (@_) {
           $self->login_banner(@_);
   $self->last_lines(\@lines);      }
   
   my $vals = 1;      my $banner = $self->login_banner;
   if ($cfg{'decode'}) {  
     $vals = _decode_lines(@lines);      my ( $type, $sep1, $subtype, $sep2, $ver ) =
   }        $banner =~
         /Welcome to Trango Broadband Wireless,? (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   
   my $last = $self->lastline;      $type .= $sep1 . $subtype;
       $ver = $subtype . $sep2 . $ver;
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  
     if ($cfg{'cmd_disconnects'}) {      $self->login_banner($banner);
       $self->logged_in(0);      $self->host_type($type);
       $self->close;      $self->firmware_version($ver);
       $self->is_connected(0);  
     }      return 1;
   }
     if ($cfg{'decode'}) {  
       return $vals;  =pod
     } else {  
       return @lines;  =head2 B<linktest> - Link test to SU
     }  
   } else {  linktest('suid'[, 'pkt len, bytes'[, '# of pkts'[, '# of cycles']]]);
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;  Returns a hash reference to the results of the test
   }  
 }  =cut
   
 #=item _decode_lines  sub linktest
   {
 sub _decode_lines      my $self    = shift;
 {      my $suid    = shift;
   my @lines = @_;      # These numbers are what I found as defaults when running the command
       my $pkt_len = shift || 1600;
   my %conf;      my $pkt_cnt = shift || 500;
       my $cycles  = shift || 10;
   my $key = '';  
   my $val = '';      my %config  = @_;
   my $in_key = 0;  
   my $in_val = 0;      # * 2, one for the FromAP, one FromSU.  Then / 1000 to get to ms.
       # XXX This might need to be changed, this makes the default timeout the
   foreach my $line (@lines) {      # same as $pkt_len, and that might not be enough at slower speeds.
     my @chars = split //, $line;      $config{Timeout} ||= int(($pkt_len * $pkt_cnt * $cycles * 2 ) / 1000);
   
     my $last_key = '';      my $string = join $SPACE, 'linktest', $suid, $pkt_len, $pkt_cnt, $cycles;
     foreach my $c (@chars) {      return $self->cmd(
           %config,
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {          String => $string,
         if ($c eq '[') {          decode => 'linktest',
           $in_key = 1;      );
           $in_val = 0;  
         } else {  }
           $in_key = 0;  
           $in_val = 0;  =pod
         }  
   =head2 B<su_password> - Set the password on SUs connected to the AP.
         if ($key) {  
           $key =~ s/^\s+//;  su_password('new_password'[, 'suid']) If no suid is specified,
           $key =~ s/\s+$//;  the default is "all".
   
           $val =~ s/^\s+//;    $t->su_password('good_pass', 5);
           $val =~ s/\s+$//;  
   =cut
           if ($key eq 'Checksum' && $last_key) {  
             # Special case for these bastids.  sub su_password {
             my $new = $last_key;      my $self     = shift;
             $new =~ s/\s+\S+$//;      my $new_pass = shift || $EMPTY;
             $key = $new . " " . $key;      my $su       = shift || 'all';
           }  
       unless ( defined $new_pass ) {
           $last_key = $key;          $self->last_error("No new password");
           $conf{$key} = $val;  
           $key = '';          #return;
           $val = '';      }
         }  
       return $self->cmd(
       } elsif ($c eq ']') {          String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass,
         $in_val = 1;          expect => $success,
         $in_key = 0;      );
         $c = shift @chars;  }
   
       } elsif ($in_key) {  =pod
         $key .= $c;  
   =head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP.
       } elsif ($in_val) {  
         $val .= $c;  su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
       }  
     }    $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
   }  
   =cut
   if (%conf) {  
     return \%conf;  sub su_ipconfig {
   } else {      my $self = shift;
     return \@lines;  
   }      my $suid        = shift;
 }      my $new_ip      = shift;
       my $new_subnet  = shift;
 1;      my $new_gateway = shift;
 __END__  
       if ( $suid =~ /\D/ ) {
 =back          $self->last_error("Invalid suid '$suid'");
           return;
 =head1 SEE ALSO      }
       unless ($new_ip) {
 If you have a web site set up for your module, mention it here.          $self->last_error("no new_ip passed");
           return;
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm      }
       unless ($new_subnet) {
 L<Net::Telnet>          $self->last_error("no new_subnet passed");
           return;
 =head1 TODO      }
       unless ($new_gateway) {
 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.          $self->last_error("no new_gateway passed");
           return;
 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      # su ipconfig <suid> <new ip> <new subnet> <new gateway>
       return $self->cmd(
 Andrew Fresh E<lt>andrew@rraz.netE<gt>          String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE
             . $new_subnet . $SPACE
 =head1 COPYRIGHT AND LICENSE            . $new_gateway,
           expect => $success,
 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,  =pod
 at your option, any later version of Perl 5 you may have available.  
   =head2 B<sudb_view> - Returns the output from the sudb view command
   
 =cut  returns a reference to an array of hashes each containing these keys
   'suid', 'type', 'cir', 'mir' and 'mac'
   
   =cut
   
   sub sudb_view {
       my $self = shift;
   
       my $lines = $self->cmd( String => 'sudb view', expect => $success ) || [];
   
       return 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
   
   =head2 B<sudb_add> - Adds an su to the sudb
   
   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.
   
     $t->sudb_add($suid, 'reg', $cir, $mir, $mac);
   
   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;
       }
   
       unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) {
           $self->last_error("Invalid type '$type'");
           return;
       }
   
       if ( $cir =~ /\D/ ) {
           $self->last_error("Invalid CIR '$cir'");
           return;
       }
   
       if ( $mir =~ /\D/ ) {
           $self->last_error("Invalid MIR '$mir'");
           return;
       }
   
       my $new_mac = $mac;
       $new_mac =~ s/[^0-9A-Fa-f]//;
       unless ( length $new_mac == 12 ) {
           $self->last_error("Invalid MAC '$mac'");
           return;
       }
       $new_mac = join $SPACE, $new_mac =~ /../g;
   
       my $string =
         'sudb add ' . $suid . $SPACE . $type . $SPACE . $cir . $SPACE . $mir . $SPACE
         . $new_mac;
   
       return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =head2 B<sudb_delete> - removes an su from the sudb
   
   Takes either 'all' or the  suid of the su to delete
   and returns true on success or undef otherwise.
   
     $t->sudb_delete($suid);
   
   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;
       }
   
       return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
   }
   
   =pod
   
   =head2 B<sudb_modify> - changes the su information in the sudb
   
   Takes either the  suid of the su to change
   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.
   
     $t->sudb_modify($suid, 'cir', 512);
   
   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;
       }
   
       if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) {
           if ( $value =~ /\D/ ) {
               $self->last_error("Invalid $opt '$value'");
               return;
           }
       }
       elsif ( lc($opt) eq 'su2su' ) {
           if ( $value =~ /[^0-9A-Za-f]/ ) {
               $self->last_error("Invalid MAC '$value'");
               return;
           }
       }
       else {
           $self->last_error("Invalid option '$opt'");
           return;
       }
   
       my $string = 'sudb modify ' . $suid . $SPACE . $opt . $SPACE . $value;
   
       return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =head2 B<enable_tftpd> - enable the TFTP server
   
   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 ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) {
           return $vals;
       }
       else {
           return;
       }
   }
   
   =pod
   
   =head2 B<disable_tftpd> - disable the TFTP server
   
   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;
       }
   }
   
   =pod
   
   =head2 B<cmd> - runs a command on the AP.
   
   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
   
   If you are using this, rather than one of the "easy" methods above,
   you probably want to read through the source of this module to see how
   some of the other commands are called.
   
   In addition to the Net::Telnet::cmd() options, it also accepts these:
   
   I<decode>
   - if this is true, then it will send the output lines to _decode_lines()
   and then returns the decoded output
   
   I<no_prompt>
   - if this is true, it does not wait for a prompt, so you are not stuck
   waiting for something that will never happen.
   
   I<cmd_disconnects>
   - if this is true, it then sets logged_in() to false, then it will
   close() the connection and set 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
   
       $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 );
   
   =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;
       }
   
       unless ( $self->is_connected ) {
           $self->last_error("Not connected");
           return;
       }
   
       unless ( $self->logged_in ) {
           $self->last_error("Not logged in");
           return;
       }
   
       my %cmd;
       foreach (@valid_net_telnet_opts) {
           if ( exists $cfg{$_} ) {
               $cmd{$_} = $cfg{$_};
           }
       }
       if ( $cfg{'args'} ) {
           $cmd{'String'} .= $SPACE . $cfg{'args'};
       }
   
       #print "Running cmd $cmd{String}\n";
       my @lines;
       if ( $cfg{'no_prompt'} ) {
           $self->print( $cmd{'String'} );
           @lines = $self->lastline;
       }
       else {
           @lines = $self->SUPER::cmd(%cmd);
       }
   
       $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);
               if (! $vals) {
                   $self->last_error("Error decoding maclist");
               }
           }
           elsif ( $cfg{'decode'} eq 'linktest' ) {
               $vals = _decode_linktest(@lines);
               if (! $vals) {
                   $self->last_error("Error decoding linktest");
               }
           }
           else {
               $vals = _decode_lines(@lines);
           }
       }
   
       $self->last_vals($vals);
   
       my $last = $self->lastline;
       $self->last_error($EMPTY);
   
       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 {
           my $err;
           if (grep { /\[ERR\]/ } @lines) {
               $err = _decode_lines(@lines);
           }
   
           if (ref $err eq 'HASH' && $err->{ERR}) {
               $self->last_error($err->{ERR} );
           } else {
               $self->last_error("Error with command ($cmd{'String'}): $last");
           }
           return;
       }
   }
   
   #=item _decode_lines
   
   sub _decode_lines {
       my @lines = @_;
   
       my %conf;
   
       my $key = $EMPTY;
       my $val = undef;
       my @vals;
       my $in_key = 0;
       my $in_val = 1;
   
       foreach my $line (@lines) {
           next if $line =~ /$success$/;
   
           my @chars = split //, $line;
   
           my $last_key = $EMPTY;
           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 ($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 . $SPACE . $key;
                       }
   
                       $conf{$key} = $val;
                       $last_key   = $key;
                       $key        = $EMPTY;
                   }
                   elsif ($val) {
                       push @vals, $val;
                   }
                   $val = $EMPTY;
   
               }
               elsif ( $c eq ']' ) {
                   $in_val = 1;
                   $in_key = 0;
                   $c      = shift @chars;
   
               }
               elsif ($in_key) {
                   $key .= $c;
   
               }
               elsif ($in_val) {
                   $val .= $c;
               }
           }
       }
   
       unless ($key) {
           push @vals, $val;
       }
   
       if ( @vals == 1 ) {
           $val = $vals[0];
       }
       elsif (@vals) {
           $val = \@vals;
       }
       else {
           $val = undef;
       }
   
       if (%conf) {
           $conf{_pre} = $val if $val;
           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_linktest
   
   sub _decode_linktest {
       my @lines = @_;
       my %decoded;
       foreach my $line (@lines) {
   
           if ($line =~ s/^(\d+) \s+ //xms) {
               my $line_id = $1;
                           my ($tm, $rt);
                           if ($line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms) {
                                   $rt = $1;
                           }
                           if ($line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms) {
                                   $tm = $1;
                           }
   
               my $d = _decode_lines($line. "\n");
               $decoded{tests}[$line_id] = $d;
               $decoded{tests}[$line_id]{'time'} = $tm;
               $decoded{tests}[$line_id]{rate}   = $rt;
           }
   
           else {
               my $d = _decode_lines($line . "\n");
               if ($d) {
                   while (my ($k, $v) = each %{ $d }) {
                       $decoded{$k} = $v;
                   }
              }
           }
   
       }
       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 {
           return;
       }
   }
   
   1;    # End of Net::Telnet::Trango
   __END__
   
   =head1 SEE ALSO
   
   Trango Documentation -
   L<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 SUPPORT
   
   You can find documentation for this module with the perldoc command.
   
       perldoc Net::Telnet::Trango
   
   You can also look for information at:
   
   =over 4
   
   =item * AnnoCPAN: Annotated CPAN documentation
   
   L<http://annocpan.org/dist/Net-Telnet-Trango>
   
   =item * CPAN Ratings
   
   L<http://cpanratings.perl.org/d/Net-Telnet-Trango>
   
   =item * RT: CPAN's request tracker
   
   L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Telnet-Trango>
   
   =item * Search CPAN
   
   L<http://search.cpan.org/dist/Net-Telnet-Trango>
   
   =back
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005,2006,2007 by Andrew Fresh
   
   This program is free software; you can redistribute it and/or modify it
   under the same terms as Perl itself.
   
   =cut
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.51
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>