[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.4 and 1.45

version 1.4, 2005/12/30 20:26:41 version 1.45, 2008/02/08 16:49:09
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.3 2005/12/30 19:26:06 andrew Exp $  
 use strict;  # $RedRiver: Trango.pm,v 1.44 2007/06/05 19:54:05 mike 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 ( Timeout => 5 );  
       use Net::Telnet::Trango;
   my ($type, $version) = $t->open( Host => $fox );    my $t = new Net::Telnet::Trango ( Timeout => 5 );
     
   unless (defined $type && defined $version) {    $t->open( Host => $ap ) or die "Error connecting: $!";
     die "Error connecting: $!";  
   }    $t->login('password') or die "Couldn't log in: $!";
   
   $t->login('password') or die "Couldn't log in: $!";    # Do whatever
     
   # Do whatever    $t->exit;
       $t->close;
   $t->exit;  
   $t->close;  =head1 DESCRIPTION
   
 =head1 DESCRIPTION  Perl access to the telnet interface on Trango APs and SUs.
   
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  A 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
 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.  returned.  This makes using the output from things like sysinfo very easy to
   do.
 =head2 EXPORT  
   =head2 EXPORT
 None  
   None
 =cut  
   =head1 METHODS
 our $VERSION = '0.01';  
   =cut
 my %PRIVATE = (  
   is_connected => 0,  our $VERSION = '0.01';
   logged_in => 0,  
 );  my $EMPTY = q{};
   my $SPACE = q{ };
 =pod  
   my %PRIVATE = (
 =item new      is_connected => 0,
       logged_in    => 0,
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  );
   
 =cut  =pod
   
 sub new  =head2 B<new> - Creates a new Net::Telnet::Trango object.
 {  
   my $class = shift;      new([Options from Net::Telnet,]
           [Decode => 0,]);
   my %args;  
   if (@_ == 1) {  Same as new from L<Net::Telnet> but sets the default Trango Prompt:
     $args{'Host'} = shift;  '/#> *$/'
   } else {  
     %args = @_;  It also takes an optional parameter 'Decode'.  If not defined it
   }  defaults to 1, if it is set to 0, it will not decode the output and
   instead return a reference to an array of the lines that were returned
   $args{'Prompt'}  ||= '/#> *$/';  from the command.
   
   foreach my $key (keys %args) {  =cut
     $PRIVATE{$key} = $args{$key};  
   }  sub new {
       my $class = shift;
   my $self = $class->SUPER::new(%args);  
   bless $self if ref $self;      my %args;
       if ( @_ == 1 ) {
   return $self;          $args{'Host'} = shift;
 }      }
       else {
 #  _password <new password> <new password>          %args = @_;
 #  ? [command]      }
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  
 #  arp -bcast <on|off>      $args{'Prompt'} ||= '/#> *$/';
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...  
 #  bye      foreach my $key ( keys %args ) {
 #  cf2cf ap [default|<size>]          $PRIVATE{$key} = $args{$key};
 #  date      }
 #  date <month> <day> <year>      $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
 #  freq scantable      delete $args{'Decode'};
 #  freq channeltable  
 #  freq writescan [<ch#> <h|v>]      my $self = $class->SUPER::new(%args);
 #  freq writechannel [<ch#> <freq>] ...      bless $self if ref $self;
 #  freq <ch #> <h|v>  
 #  help [command]      return $self;
 #  heater [<on temp> <off temp>]  }
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  
 #  log [<# of entries, 1..179>]  #  _password <new password> <new password>
 #  log <sum> <# of entries, 1..179>  #  ? [command]
 #  logout  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
 #  opmode [ap [y]]  #  arp -bcast <on|off>
 #  password  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
 #  ping <ip addr>  #  bye
 #  polar <h|v>  #  cf2cf ap [default|<size>]
 #  power <setism|setunii> <max|min|<dBm>>  #  date
 #  reboot  #  date <month> <day> <year>
 #  restart  #  freq scantable
 #  remarks [<str>]  #  freq channeltable
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  #  freq writescan [<ch#> <h|v>]
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  #  freq writechannel [<ch#> <freq>] ...
 #  sysinfo  #  freq <ch #> <h|v>
 #  set suid <id>  #  help [command]
 #  set apid <id>  #  heater [<on temp> <off temp>]
 #  set baseid <id>  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 #  set defaultopmode [<ap|su> <min,0..10>]  #  log [<# of entries, 1..179>]
 #  set defaultopmode off  #  log <sum> <# of entries, 1..179>
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  #  logout
 #  set mir [on|off]  #  opmode [ap [y]]
 #  set mir threshold <kbps>  #  password
 #  set rssitarget [<ism|unii> <dBm>]  #  ping <ip addr>
 #  set serviceradius [<ism | unii> <miles>]  #  polar <h|v>
 #  ssrssi <ch #> <h|v>  #  power <setism|setunii> <max|min|<dBm>>
 #  su [<suid>|all]  #  reboot
 #  su changechannel <all|suid> <ch#> <h|v>  #  restart
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  #  remarks [<str>]
 #  su [live|poweroff|priority]  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 #  su <ping|info|status> <suid>  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 #  su powerleveling <all|suid>  #  sysinfo
 #  su reboot <all|suid>  #  set suid <id>
 #  su restart <all|suid>  #  set apid <id>
 #  su testrflink <all|suid> [r]  #  set baseid <id>
 #  su testrflink <setlen> [64..1600]  #  set defaultopmode [<ap|su> <min,0..10>]
 #  su testrflink <aptx> [20..100]  #  set defaultopmode off
 #  su sw <suid|all> <sw #> <on|off>  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
 #  sudb [dload | view]  #  set mir [on|off]
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  #  set mir threshold <kbps>
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  #  set rssitarget [<ism|unii> <dBm>]
 #  sudb delete <all|<suid>>  #  set serviceradius [<ism | unii> <miles>]
 #  sudb modify <suid> <cir|mir> <kbps>  #  ssrssi <ch #> <h|v>
 #  sudb modify <suid> <su2su> <group id,hex>  #  su [<suid>|all]
 #  sudb view  #  su changechannel <all|suid> <ch#> <h|v>
 #  sulog [lastmins | sampleperiod <1..60>]  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
 #  sulog [<# of entry,1..18>]  #  su [live|poweroff|priority]
 #  survey <ism|unii> <time, sec> <h|v>  #  su <ping|info|status> <suid>
 #  sw [<sw #> <on|off>]  #  su powerleveling <all|suid>
 #  temp  #  su reboot <all|suid>
 #  tftpd [on|off]  #  su restart <all|suid>
 #  time  #  su testrflink <all|suid> [r]
 #  time <hour> <min> <sec>  #  su testrflink <setlen> [64..1600]
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  #  su testrflink <aptx> [20..100]
 #  save <systemsetting|sudb>  #  su sw <suid|all> <sw #> <on|off>
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  #  sudb [dload | view]
 #  updateflash <systemsetting|sudb>  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
   #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 =pod  #  sudb delete <all|<suid>>
   #  sudb modify <suid> <cir|mir> <kbps>
 =head1 METHODS  #  sudb modify <suid> <su2su> <group id,hex>
   #  sudb view
 =head2 ACCESSORS  #  sulog [lastmins | sampleperiod <1..60>]
   #  sulog [<# of entry,1..18>]
 =over  #  survey <ism|unii> <time, sec> <h|v>
   #  sw [<sw #> <on|off>]
 =item Host  #  temp
   #  tftpd [on|off]
 returns the name of the host that you are accessing  #  time
   #  time <hour> <min> <sec>
 =item firmware_version  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
   #  save <systemsetting|sudb>
 returns the firmware version on the trango if available otherwise undef.    #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 Available after a successful open()  #  updateflash <systemsetting|sudb>
 This is usually only set internally  
   =pod
 =item host_type  
   =head1 ACCESSORS
 returns the type of host from the login banner for example M5830S or M5300S.    
 Available after a successful open()  These are usually only set internally.
 This is usually only set internally  
   =head2 B<firmware_version> - returns the firmware version
 =item is_connected  
   Returns the firmware version if available, otherwise undef.
 returns 1 after a successful open() otherwise undef  
 This is usually only set internally  It should be available after a successful open().
   
 =item logged_in  =head2 B<host_type> - return the type of host you are connected to.
   
 returns 1 after a successful login() 0 if it failed and undef if  returns the type of host from the login banner for example M5830S or M5300S.
 login() was never called  
 This is usually only set internally  Should be available after a successful open().
   
 =item login_banner  =head2 B<is_connected> - Status of the connection to host.
   
 returns the banner that is displayed when first connected at login.  Only set after a successful open()  returns 1 when connected, undef otherwise.
   
 This is usually only set internally  =head2 B<logged_in> - Status of being logged in to the host.
   
 =item last_lines  returns 1 after a successful login(), 0 if it failed and undef if
   login() was never called.
 returns the output from the last cmd() that was run as an array ref  
 This is usually only set internally  =head2 B<login_banner> - The banner when first connecting to the host.
   
 =back  returns the banner that is displayed when first connected at login.
   Only set after a successful open().
 =head2 ALIASES  
   =head2 B<last_lines> - The last lines of output from the last cmd().
 =over  
   returns, as an array ref, the output from the last cmd() that was run.
 =item bye  
   =head2 B<last_error> - A text output of the last error that was encountered.
 alias of exit()  
   returns the last error reported.  Probably contains the last entry in
 =item restart  last_lines.
   
 alias of reboot()  =head1 ALIASES
   
 =back  =head2 B<bye> - alias of exit()
   
 =head2 COMMANDS  Does the same as exit()
   
 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:  =head2 B<restart> - alias of reboot()
 C<tftpd(args =E<gt> 'on')> would enable tftpd  
   Does the same as reboot()
 =over  
   =head2 B<save_systemsetting> - alias of save_ss()
 =item tftpd  
   Does the same as save_ss()
 Returns a hash ref of the decoded output from the command.  
   =head1 COMMANDS
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
 =item ver  as such they accept the same options as C<cmd()>.
   Specifically they take a named paramater "args", for example:
 Returns a hash ref of the decoded output from the command.  C<tftpd(args =E<gt> 'on')> would enable tftpd
   
 =item sysinfo  =head2 B<tftpd> - The output from the tftpd command
   
 Returns a hash ref of the decoded output from the command.  Returns a hash ref of the decoded output from the
   command.
 =item exit  
   Also see enable_tftpd() and disable_tftpd() as those check that it was
 exits the command session with the trango and closes the connection  successfully changed.
   
 =item reboot  =head2 B<ver> - The output from the ver command
   
 reboots the trango and closes the connection  Returns a hash ref of the decoded output from the
   command.
 =item sulog  
   =head2 B<sysinfo> - The output from the sysinfo command
 returns an array ref of hashes containing each log line.  
   Returns a hash ref of the decoded output from the
 =cut  command.
   
   =head2 B<exit> - Exits the connection
 my $success = 'Success.';  
 my %COMMANDS = (  exits the command session with the Trango and closes
   tftpd       => { decode => 'all',   expect => $success },  the connection
   ver         => { decode => 'all' },  
   sysinfo     => { decode => 'all',   expect => $success },  =head2 B<reboot> - Sends a reboot command
   updateflash => { decode => 'all',   expect => $success },  
   sulog       => { decode => 'sulog', expect => $success },  reboots the Trango and closes the connection
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  =head2 B<remarks> - Set or retrieve the remarks.
   #su password???  
   #_bootloader  Takes an optional argument, which sets the remarks.
   #temp  If there is no argument, returns the current remarks.
   #heater  
 );    my $old_remarks = $t->remarks();
     $t->remarks($new_remarks);
 my %ALIASES = (  
   bye     => 'exit',  =head2 B<sulog> - The output from the sulog command
   restart => 'reboot',  
 );  Returns an array ref of hashes containing each log
   line.
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  =head2 B<save_sudb> - saves the sudb
   host_type  
   Host  Returns true on success, undef on failure
   is_connected  
   logged_in  =head2 B<syslog> - The output from the sulog command
   login_banner  
   Timeout  Returns a hashref of the output from the syslog command
   last_lines  
 );  =head2 B<pipe> - the pipe command
   
 sub AUTOLOAD  Returns the output from the pipe command
 {  
   my $self = shift;  =head2 B<maclist> - retrieves the maclist
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  Returns the output from the maclist command
     or die "Weird: $AUTOLOAD";  
   =head2 B<maclist_reset> - resets the maclist.
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  No useful output.
     return $self->$method(@_);  
   }  =head2 B<eth_link> - eth link command
   
   if (exists $COMMANDS{$method}) {  Returns the output from the eth link command
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  This command seems to cause some weird issues.  It often will cause the
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  command after it to appear to fail.  I am not sure why.
   }  
   =head2 B<su_info> - gets the su info
   if (exists $ACCESS{$method}) {  
     my $prev = $PRIVATE{$method};  Returns information about the SU.
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;  You need to pass in the $suid and it will return the info for that suid.
   }  
     $t->su_info($suid);
   $method = "SUPER::$method";  
   return $self->$method(@_);  =head2 B<su_testrflink> - tests the RF Link to an su
 }  
     $t->su_testrflink($suid|'all');
 =pod  
   =head2 B<save_ss> - saves the config.
 =item open  
   Returns 1 on success, undef on failure.
 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()  
   =head2 B<opmode> - sets opmode ap y or returns the opmode
 =cut  
       $t->opmode([ap y]);
 sub open  
 {  =cut
   my $self = shift;  
   my $success  = 'Success\\.';
   unless ( $self->SUPER::open(@_) ) {  my %COMMANDS = (
     #$! = "Couldn't connect to " . $self->Host . ":  $!";      _clear      => { String => "\n" },
     return undef;      tftpd       => { decode    => 'all',       expect          => $success },
   }      ver         => { decode    => 'all' },
       sysinfo     => { decode    => 'all',       expect          => $success },
   ## Get to login prompt      updateflash => { decode    => 'all',       expect          => $success },
   unless ($self->waitfor(      sulog       => { decode    => 'sulog',     expect          => $success },
       -match => '/password: ?$/i',      'exit'      => { no_prompt => 1,           cmd_disconnects => 1 },
       -errmode => "return",      reboot      => { no_prompt => 1,           cmd_disconnects => 1 },
     ) ) {      remarks     => { decode    => 'all',       expect          => $success },
     #$! = "problem connecting to host (" . $self->Host . "): " .      save_sudb   => { String    => 'save sudb', expect          => $success },
     #    $self->lastline;      syslog      => { expect    => $success },
     return undef;      'pipe'      => {},                        # XXX needs a special decode
   }      maclist     => { decode => 'maclist' },
       maclist_reset => { String => 'maclist reset', expect       => 'done' },
   $self->parse_login_banner($self->lastline);      eth_link    => { String => 'eth link',     expect          => $success },
       su_info     =>
   $self->is_connected(1);        { String => 'su info',  decode => 'all', expect          => $success },
       su_testrflink =>
   return $self->is_connected;        { String => 'su testrflink', decode => 'each', expect    => $success },
 }      save_ss     => { String => 'save ss',      expect          => $success },
       opmode      => { decode => 'all',          expect          => $success },
 =pod      arq         => { decode => 'all' },
   );
 =item login  
   my %ALIASES = (
 Calls open() if not already connected, then sends the password and sets logged_in() if successful      bye     => 'exit',
       restart => 'reboot',
 =cut      Host    => 'host',
       save_systemseting => 'save_ss',
 sub login  );
 {  
   my $self = shift;  my %ACCESS = map { $_ => 1 } qw(
     firmware_version
   unless ($self->is_connected) {    host_type
     $self->open or return undef;    is_connected
   }    logged_in
     login_banner
   my $password = shift;    Timeout
     last_lines
   $self->print($password);    last_vals
   unless ($self->waitfor(    last_error
     -match => $self->prompt,    Decode
     -errmode => "return",  );
   ) ) {  
     #$! = "login ($self->Host) failed: " . $self->lastline;  sub AUTOLOAD {
     return undef;      my $self = shift;
   }  
       my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/
   $self->logged_in(1);        or die "Weird: $AUTOLOAD";
   
   return $self->logged_in;      if ( exists $ALIASES{$method} ) {
 }          $method = $ALIASES{$method};
           return $self->$method(@_);
 =pod      }
   
 =item parse_login_banner      if ( exists $COMMANDS{$method} ) {
           my %cmd;
 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()          foreach my $k ( keys %{ $COMMANDS{$method} } ) {
               $cmd{$k} = $COMMANDS{$method}{$k};
 =cut          }
           $cmd{'String'} ||= $method;
 sub parse_login_banner          $cmd{'args'} .= $SPACE . shift if ( @_ == 1 );
 {          return $self->cmd( %cmd, @_ );
   my $self = shift;      }
   
   if (@_) {      if ( exists $ACCESS{$method} ) {
     $self->login_banner(@_);          my $prev = $PRIVATE{$method};
   }          ( $PRIVATE{$method} ) = @_ if @_;
           return $prev;
   my $banner = $self->login_banner;      }
   
   my ($type, $ver) = $banner =~      $method = "SUPER::$method";
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;      return $self->$method(@_);
   }
   $self->login_banner($banner);  
   $self->host_type($type);  =pod
   $self->firmware_version($ver);  
   =head2 B<open> - Open a connection to a Trango AP.
   return 1;  
 }  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
 =pod  host_type() and firmware_version()
   
 =item enable_tftpd  =cut
   
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  sub open {
       my $self = shift;
 =cut  
       unless ( $self->SUPER::open(@_) ) {
 sub enable_tftpd          $self->last_error( "Couldn't connect to " . $self->host . ":  $!" );
 {          return;
   my $self = shift;      }
   
   my $vals = $self->tftpd( args => 'on' );      ## Get to login prompt
       unless (
   if ($vals->{'Tftpd'} eq 'listen') {          $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 disable_tftpd          return;
       }
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  
       $self->parse_login_banner( $self->lastline );
 =cut  
       $self->is_connected(1);
 sub disable_tftpd  
 {      return $self->is_connected;
   my $self = shift;  }
   
   my $vals = $self->tftpd( args => 'off' );  =pod
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  =head2 B<login> - Login to the AP.
     return $vals;  
   } else {  Calls open() if not already connected, then sends the password and sets
     return undef;  logged_in() if successful
   }  
 }  =cut
   
 =pod  sub login {
       my $self = shift;
 =item cmd  
       unless ( $self->is_connected ) {
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.          $self->open or return;
       }
 Normally returns the last lines from from the command  
       my $password = shift;
 Also accepts these options:  
       $self->print($password);
 I<decode>      unless (
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output          $self->waitfor(
               -match   => $self->prompt,
 I<cmd_disconnects>              -errmode => "return",
 - 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          $self->last_error( "login ($self->host) failed: " . $self->lastline );
           return;
 I<args>      }
 - a string containing the command line options that are passed to the command  
       $self->logged_in(1);
 =cut  
       return $self->logged_in;
 sub cmd  }
 {  
   my $self = shift;  =pod
   
   my @valid_net_telnet_opts = qw(  =head2 B<parse_login_banner> - Converts the login_banner to something useful.
     String  
     Output  Takes a login banner (what you get when you first connect to the Trango)
     Cmd_remove_mode  or reads what is already in login_banner() then parses it and sets
     Errmode  host_type() and firmware_version() as well as login_banner()
     Input_record_separator  
     Ors  =cut
     Output_record_separator  
     Prompt  sub parse_login_banner {
     Rs      my $self = shift;
     Timeout  
   );      if (@_) {
           $self->login_banner(@_);
   my %cfg;      }
   if (@_ == 2) {  
     $cfg{'String'} = shift;      my $banner = $self->login_banner;
   } elsif (@_ > 2) {  
     %cfg = @_;      my ( $type, $sep1, $subtype, $sep2, $ver ) =
   }        $banner =~
         /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   $cfg{'Timeout'} ||= $self->Timeout;  
       $type .= $sep1 . $subtype;
   unless ($cfg{'String'}) {      $ver = $subtype . $sep2 . $ver;
     #$! = "No command passed";  
     #warn "No command passed\n";      $self->login_banner($banner);
     return undef;      $self->host_type($type);
   }      $self->firmware_version($ver);
   
   unless ($self->is_connected) {      return 1;
     #$! = "Not connected";  }
     #warn "Not connected\n";  
     return undef;  =pod
   }  
   =head2 B<su_password> - Set the password on SUs connected to the AP.
   unless ($self->logged_in) {  
     #$! = "Not logged in";  su_password('new_password'[, 'suid']) If no suid is specified,
     #warn "Not logged in\n";  the default is "all".
     return undef;  
   }    $t->su_password('good_pass', 5);
   
   =cut
   my %cmd;  
   foreach (@valid_net_telnet_opts) {  sub su_password {
     if (exists $cfg{$_}) {      my $self     = shift;
       $cmd{$_} = $cfg{$_};      my $new_pass = shift || $EMPTY;
     }      my $su       = shift || 'all';
   }  
   if ($cfg{'args'}) {      unless ( defined $new_pass ) {
     $cmd{'String'} .= ' ' . $cfg{'args'};          $self->last_error("No new password");
   }  
   my @lines = $self->SUPER::cmd(%cmd);          #return;
       }
   $self->last_lines(\@lines);  
       return $self->cmd(
   my $vals = 1;          String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass,
   if ($cfg{'decode'}) {          expect => $success,
     if ($cfg{'decode'} eq 'each') {      );
       $vals = _decode_each_line(@lines);  }
     } elsif ($cfg{'decode'} eq 'sulog') {  
       $vals = _decode_sulog(@lines);  =pod
     } else {  
       $vals = _decode_lines(@lines);  =head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP.
     }  
   }  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' );
   my $last = $self->lastline;  
   =cut
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  
     if ($cfg{'cmd_disconnects'}) {  sub su_ipconfig {
       $self->logged_in(0);      my $self = shift;
       $self->close;  
       $self->is_connected(0);      my $suid        = shift;
     }      my $new_ip      = shift;
       my $new_subnet  = shift;
     if ($cfg{'decode'}) {      my $new_gateway = shift;
       return $vals;  
     } else {      if ( $suid =~ /\D/ ) {
       return @lines;          $self->last_error("Invalid suid '$suid'");
     }          return;
   } else {      }
     #$! = "Error with command ($cfg{'string'}): $last";      unless ($new_ip) {
     return undef;          $self->last_error("no new_ip passed");
   }          return;
 }      }
       unless ($new_subnet) {
 #=item _decode_lines          $self->last_error("no new_subnet passed");
           return;
 sub _decode_lines      }
 {      unless ($new_gateway) {
   my @lines = @_;          $self->last_error("no new_gateway passed");
           return;
   my %conf;      }
   
   my $key = '';      # su ipconfig <suid> <new ip> <new subnet> <new gateway>
   my $val = '';      return $self->cmd(
   my $in_key = 0;          String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE
   my $in_val = 0;            . $new_subnet . $SPACE
             . $new_gateway,
   foreach my $line (@lines) {          expect => $success,
     next if $line =~ /$success$/;      );
   }
     my @chars = split //, $line;  
   =pod
     my $last_key = '';  
     foreach my $c (@chars) {  =head2 B<sudb_view> - Returns the output from the sudb view command
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  returns a reference to an array of hashes each containing these keys
         if ($c eq '[') {  'suid', 'type', 'cir', 'mir' and 'mac'
           $in_key = 1;  
           $in_val = 0;  =cut
         } else {  
           $in_key = 0;  sub sudb_view {
           $in_val = 0;      my $self = shift;
         }  
       my $lines = $self->cmd( String => 'sudb view', expect => $success ) || [];
         if ($key) {  
           $key =~ s/^\s+//;      return unless @{$lines};
           $key =~ s/\s+$//;  
       unless ( $PRIVATE{'Decode'} ) {
           $val =~ s/^\s+//;          return $lines;
           $val =~ s/\s+$//;      }
   
           if ($key eq 'Checksum' && $last_key) {      my @sus;
             # Special case for these bastids.      foreach ( @{$lines} ) {
             my $new = $last_key;          next unless $_;
             $new =~ s/\s+\S+$//;          if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
             $key = $new . " " . $key;              my %s = (
           }                  suid => $1,
                   type => $2,
           $last_key = $key;                  cir  => $3,
           $conf{$key} = $val;                  mir  => $4,
           $key = '';                  mac  => $5,
           $val = '';              );
         }  
               $s{'mac'} =~ s/\s//g;
       } elsif ($c eq ']') {              $s{'mac'} = uc( $s{'mac'} );
         $in_val = 1;  
         $in_key = 0;              push @sus, \%s;
         $c = shift @chars;          }
       }
       } elsif ($in_key) {  
         $key .= $c;      return \@sus;
   }
       } elsif ($in_val) {  
         $val .= $c;  =pod
       }  
     }  =head2 B<sudb_add> - Adds an su to the sudb
   }  
   Takes the following paramaters
   if (%conf) {  
     return \%conf;      suid : numeric,
   } else {      type : (reg|pr)
     return undef;      cir  : numeric,
   }      mir  : numeric,
 }      mac  : Almost any format, it will be reformatted,
   
 #=item _decode_each_line  and returns true on success or undef otherwise.
   
 sub _decode_each_line    $t->sudb_add($suid, 'reg', $cir, $mir, $mac);
 {  
   my @lines = @_;  You should save_sudb() after calling this, or your changes  will be lost
   my @decoded;  when the AP is rebooted.
   foreach my $line (@lines) {  
     my $decoded = _decode_lines($line);  =cut
     push @decoded, $decoded if defined $decoded;  
   }  sub sudb_add {
   return \@decoded;      my $self = shift;
 }      my $suid = shift;
       my $type = shift;
 #=item _decode_sulog      my $cir  = shift;
       my $mir  = shift;
 sub _decode_sulog      my $mac  = shift;
 {  
   my @lines = @_;      if ( $suid =~ /\D/ ) {
   my @decoded;          $self->last_error("Invalid suid '$suid'");
   my $last_tm;          return;
   foreach my $line (@lines) {      }
     my $decoded = _decode_lines($line);  
       unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) {
     if (defined $decoded) {          $self->last_error("Invalid type '$type'");
       if ($decoded->{'tm'}) {          return;
         $last_tm = $decoded->{'tm'};      }
         next;  
       } else {      if ( $cir =~ /\D/ ) {
         $decoded->{'tm'} = $last_tm;          $self->last_error("Invalid CIR '$cir'");
       }          return;
       next unless $last_tm;      }
   
       push @decoded, $decoded if defined $decoded;      if ( $mir =~ /\D/ ) {
     }          $self->last_error("Invalid MIR '$mir'");
   }          return;
   return \@decoded;      }
 }  
       my $new_mac = $mac;
 1;      $new_mac =~ s/[^0-9A-Fa-f]//;
 __END__      unless ( length $new_mac == 12 ) {
           $self->last_error("Invalid MAC '$mac'");
 =back          return;
       }
 =head1 SEE ALSO      $new_mac = join $SPACE, $new_mac =~ /../g;
   
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm      my $string =
         'sudb add ' . $suid . $SPACE . $type . $SPACE . $cir . $SPACE . $mir . $SPACE
 L<Net::Telnet>        . $new_mac;
   
 =head1 TODO      return $self->cmd( String => $string, expect => $success );
   }
 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.  
   =pod
 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.  
   =head2 B<sudb_delete> - removes an su from the sudb
 =head1 AUTHOR  
   Takes either 'all' or the  suid of the su to delete
 Andrew Fresh E<lt>andrew@rraz.netE<gt>  and returns true on success or undef otherwise.
   
 =head1 COPYRIGHT AND LICENSE    $t->sudb_delete($suid);
   
 Copyright (C) 2005 by Andrew Fresh  You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
 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,  =cut
 at your option, any later version of Perl 5 you may have available.  
   sub sudb_delete {
       my $self = shift;
 =cut      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");
               }
           }
           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 {
           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 $d = _decode_lines($line . "\n");
               $decoded{tests}[$line_id] = $d;
           }
   
           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.4  
changed lines
  Added in v.1.45
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>