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

version 1.1, 2005/12/29 18:41:17 version 1.41, 2007/02/07 20:08:32
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 use base 'Net::Telnet';  
   # $RedRiver: Trango.pm,v 1.40 2007/02/06 21:15:28 andrew Exp $
 my %PRIVATE = (  use strict;
   is_connected => 0,  use warnings;
   logged_in => 0,  use base 'Net::Telnet';
 );  
   =pod
   
 sub AUTOLOAD  =head1 NAME
 {  
   my $self = shift;  Net::Telnet::Trango
   - Perl extension for accessing the Trango telnet interface
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";  =head1 SYNOPSIS
   
   my $success = 'Success.';    use Net::Telnet::Trango;
   my %MEMBERS = (    my $t = new Net::Telnet::Trango ( Timeout => 5 );
     ver     => {},  
     sysinfo => { waitfor => $success },    $t->open( Host => $ap ) or die "Error connecting: $!";
     tftpd   => { waitfor => $success },  
   );    $t->login('password') or die "Couldn't log in: $!";
   
   my %ACCESS = map { $_ => 1 } qw(    # Do whatever
     firmware_version  
     host_type    $t->exit;
     Host    $t->close;
     is_connected  
     logged_in  =head1 DESCRIPTION
     Timeout  
   );  Perl access to the telnet interface on Trango APs and SUs.
   
   if (exists $MEMBERS{$method}) {  A handy feature is that it will parse the output from certain commands that is
     return $self->cmd($method, $MEMBERS{$method}{waitfor});  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.
   if (exists $ACCESS{$method}) {  
     my $var = shift || $PRIVATE{$method};  =head2 EXPORT
     $PRIVATE{$method} = $var;  
     return $var;  None
   }  
   =head1 METHODS
   $method = "SUPER::$method";  
   return $self->$method(@_);  =cut
 }  
   our $VERSION = '0.01';
 sub new  
 {  my $EMPTY = q{};
   my $class = shift;  my $SPACE = q{ };
   my $args = shift || {};  
   my %PRIVATE = (
   $args->{'Timeout'} ||= 5;      is_connected => 0,
   $args->{'Prompt'}  ||= '/#> *$/';      logged_in    => 0,
   );
   foreach my $key (keys %{ $args }) {  
     $PRIVATE{$key} = $args->{$key};  =pod
   }  
   =head2 B<new> - Creates a new Net::Telnet::Trango object.
   my $self = $class->SUPER::new(%{ $args });  
   bless $self;      new([Options from Net::Telnet,]
           [Decode => 0,]);
   #bless $self, $package;  
   return $self;  Same as new from L<Net::Telnet> but sets the default Trango Prompt:
 }  '/#> *$/'
   
 sub connect  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
   my $self = shift;  instead return a reference to an array of the lines that were returned
   from the command.
   unless ( $self->open(  
       Host => $self->Host,  =cut
       Errmode => 'return',  
   ) ) {  sub new {
     $! = "Couldn't connect to $self->Host.  Connection timed out.";      my $class = shift;
     return undef, undef;  
   }      my %args;
   #$self->dump_log('dump.log');      if ( @_ == 1 ) {
           $args{'Host'} = shift;
   ## Login to remote host.      }
   unless ($self->waitfor(      else {
     -match => '/password: ?$/i',          %args = @_;
     -errmode => "return",      }
   ) ) {  
     $! = "problem connecting to host ($self->Host): " . $self->lastline;      $args{'Prompt'} ||= '/#> *$/';
     return undef;  
   }      foreach my $key ( keys %args ) {
           $PRIVATE{$key} = $args{$key};
   $self->login_banner($self->lastline);      }
       $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
   $self->is_connected(1);      delete $args{'Decode'};
   
   return ($self->host_type, $self->firmware_version);      my $self = $class->SUPER::new(%args);
 }      bless $self if ref $self;
   
 sub login      return $self;
 {  }
   my $self = shift;  
   #  _password <new password> <new password>
   my $password = shift;  #  ? [command]
   #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   $self->print($password);  #  arp -bcast <on|off>
   unless ($self->waitfor(  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
     -match => $self->prompt,  #  bye
     -errmode => "return",  #  cf2cf ap [default|<size>]
   ) ) {  #  date
     $! = "login ($self->Host) failed: " . $self->lastline;  #  date <month> <day> <year>
     return undef;  #  freq scantable
   }  #  freq channeltable
   #  freq writescan [<ch#> <h|v>]
   $self->logged_in(1);  #  freq writechannel [<ch#> <freq>] ...
   #  freq <ch #> <h|v>
   return $self->logged_in;  #  help [command]
 }  #  heater [<on temp> <off temp>]
   #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 sub login_banner  #  log [<# of entries, 1..179>]
 {  #  log <sum> <# of entries, 1..179>
   my $self = shift;  #  logout
   #  opmode [ap [y]]
   my $banner = shift || $self->login_banner;  #  password
   #  ping <ip addr>
   my ($type, $ver) = $banner =~  #  polar <h|v>
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  #  power <setism|setunii> <max|min|<dBm>>
   #  reboot
   $self->host_type($type);  #  restart
   $self->firmware_version($ver);  #  remarks [<str>]
   #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   return $banner;  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 }  #  sysinfo
   #  set suid <id>
 sub reboot  #  set apid <id>
 {  #  set baseid <id>
   my $self = shift;  #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
   $self->print("reboot\n");  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   $self->getline;  #  set mir [on|off]
   #  set mir threshold <kbps>
   return 1;  #  set rssitarget [<ism|unii> <dBm>]
 }  #  set serviceradius [<ism | unii> <miles>]
   #  ssrssi <ch #> <h|v>
 sub exit  #  su [<suid>|all]
 {  #  su changechannel <all|suid> <ch#> <h|v>
   my $self = shift;  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   #  su [live|poweroff|priority]
   $self->print("exit\n");  #  su <ping|info|status> <suid>
   $self->getline;  #  su powerleveling <all|suid>
   #  su reboot <all|suid>
   return 1;  #  su restart <all|suid>
 }  #  su testrflink <all|suid> [r]
   #  su testrflink <setlen> [64..1600]
 sub enable_tftpd  #  su testrflink <aptx> [20..100]
 {  #  su sw <suid|all> <sw #> <on|off>
   my $self = shift;  #  sudb [dload | view]
   #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
   my $vals = $self->cmd('tftpd on', 'Success.');  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
   #  sudb delete <all|<suid>>
   if ($vals->{'Tftpd'} eq 'listen') {  #  sudb modify <suid> <cir|mir> <kbps>
     return $vals;  #  sudb modify <suid> <su2su> <group id,hex>
   } else {  #  sudb view
     return undef;  #  sulog [lastmins | sampleperiod <1..60>]
   }  #  sulog [<# of entry,1..18>]
 }  #  survey <ism|unii> <time, sec> <h|v>
   #  sw [<sw #> <on|off>]
 sub updateflash  #  temp
 {  #  tftpd [on|off]
   my $self = shift;  #  time
   #  time <hour> <min> <sec>
   my $old = shift;  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
   my $new = shift;  #  save <systemsetting|sudb>
   #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
   return undef unless $new;  #  updateflash <systemsetting|sudb>
   
   return $self->cmd("updateflash mainimage $old $new", 'Success.', 90);  =pod
 }  
   =head1 ACCESSORS
 sub cmd  
 {  These are usually only set internally.
   my $self = shift;  
   =head2 B<firmware_version> - returns the firmware version
   my $string = shift;  
   my $expect_last = shift;  Returns the firmware version if available, otherwise undef.
   my $timeout = shift || $self->Timeout;  
   It should be available after a successful open().
   unless (defined $string) {  
     $! = "No command passed";  =head2 B<host_type> - return the type of host you are connected to.
     return undef;  
   }  returns the type of host from the login banner for example M5830S or M5300S.
   
   unless ($self->is_connected) {  Should be available after a successful open().
     $! = "Not connected";  
     return undef;  =head2 B<is_connected> - Status of the connection to host.
   }  
   returns 1 when connected, undef otherwise.
   unless ($self->logged_in) {  
     $! = "Not logged in";  =head2 B<logged_in> - Status of being logged in to the host.
     return undef;  
   }  returns 1 after a successful login(), 0 if it failed and undef if
   login() was never called.
   my @lines = $self->SUPER::cmd(String => $string, Timeout => $timeout);  
   =head2 B<login_banner> - The banner when first connecting to the host.
   my $vals = _decode_lines(@lines);  
   returns the banner that is displayed when first connected at login.
   unless ($expect_last) {  Only set after a successful open().
     return $vals;  
   }  =head2 B<last_lines> - The last lines of output from the last cmd().
   
   my $last = $self->lastline;  returns, as an array ref, the output from the last cmd() that was run.
   
   if ($last =~ /$expect_last$/) {  =head2 B<last_error> - A text output of the last error that was encountered.
     return $vals;  
   } else {  returns the last error reported.  Probably contains the last entry in
     warn "Error with command ($string): $last";  last_lines.
     return undef;  
   }  =head1 ALIASES
 }  
   =head2 B<bye> - alias of exit()
 sub _decode_lines  
 {  Does the same as exit()
   my @lines = @_;  
   =head2 B<restart> - alias of reboot()
   my %conf;  
   Does the same as reboot()
   my $key = '';  
   my $val = '';  =head2 B<save_systemsetting> - alias of save_ss()
   my $in_key = 0;  
   my $in_val = 0;  Does the same as save_ss()
   
   foreach my $line (@lines) {  =head1 COMMANDS
     my @chars = split //, $line;  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
     my $last_key = '';  as such they accept the same options as C<cmd()>.
     foreach my $c (@chars) {  Specifically they take a named paramater "args", for example:
   C<tftpd(args =E<gt> 'on')> would enable tftpd
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  
         if ($c eq '[') {  =head2 B<tftpd> - The output from the tftpd command
           $in_key = 1;  
           $in_val = 0;  Returns a hash ref of the decoded output from the
         } else {  command.
           $in_key = 0;  
           $in_val = 0;  Also see enable_tftpd() and disable_tftpd() as those check that it was
         }  successfully changed.
   
         if ($key) {  =head2 B<ver> - The output from the ver command
           $key =~ s/^\s+//;  
           $key =~ s/\s+$//;  Returns a hash ref of the decoded output from the
   command.
           $val =~ s/^\s+//;  
           $val =~ s/\s+$//;  =head2 B<sysinfo> - The output from the sysinfo command
   
           if ($key eq 'Checksum' && $last_key) {  Returns a hash ref of the decoded output from the
             # Special case for these bastids.  command.
             my $new = $last_key;  
             $new =~ s/\s+\S+$//;  =head2 B<exit> - Exits the connection
             $key = $new . " " . $key;  
           }  exits the command session with the Trango and closes
   the connection
           $last_key = $key;  
           $conf{$key} = $val;  =head2 B<reboot> - Sends a reboot command
           $key = '';  
           $val = '';  reboots the Trango and closes the connection
         }  
   =head2 B<remarks> - Set or retrieve the remarks.
       } elsif ($c eq ']') {  
         $in_val = 1;  Takes an optional argument, which sets the remarks.
         $in_key = 0;  If there is no argument, returns the current remarks.
         $c = shift @chars;  
     my $old_remarks = $t->remarks();
       } elsif ($in_key) {    $t->remarks($new_remarks);
         $key .= $c;  
   =head2 B<sulog> - The output from the sulog command
       } elsif ($in_val) {  
         $val .= $c;  Returns an array ref of hashes containing each log
       }  line.
     }  
   }  =head2 B<save_sudb> - saves the sudb
   #print Dump \%conf;  
   Returns true on success, undef on failure
   if (%conf) {  
     return \%conf;  =head2 B<syslog> - The output from the sulog command
   } else {  
     return \@lines;  Returns a hashref of the output from the syslog command
   }  
 }  =head2 B<pipe> - the pipe command
   
   Returns the output from the pipe command
   
   =head2 B<maclist> - retrieves the maclist
   
   Returns the output from the maclist command
   
   =head2 B<maclist_reset> - resets the maclist.
   
   No useful output.
   
   =head2 B<eth_link> - eth link command
   
   Returns the output from the eth link command
   
   This command seems to cause some weird issues.  It often will cause the
   command after it to appear to fail.  I am not sure why.
   
   =head2 B<su_info> - gets the su info
   
   Returns information about the SU.
   
   You need to pass in the $suid and it will return the info for that suid.
   
     $t->su_info($suid);
   
   =head2 B<su_testrflink> - tests the RF Link to an su
   
     $t->su_testrflink($suid|'all');
   
   =head2 B<save_ss> - saves the config.
   
   Returns 1 on success, undef on failure.
   
   =head2 B<opmode> - sets opmode ap y or returns the opmode
   
       $t->opmode([ap y]);
   
   =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 },
   );
   
   my %ALIASES = (
       bye     => 'exit',
       restart => 'reboot',
       Host    => 'host',
       save_systemseting => 'save_ss',
   );
   
   my %ACCESS = map { $_ => 1 } qw(
     firmware_version
     host_type
     is_connected
     logged_in
     login_banner
     Timeout
     last_lines
     last_vals
     last_error
     Decode
   );
   
   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} ) {
           my %cmd;
           foreach my $k ( keys %{ $COMMANDS{$method} } ) {
               $cmd{$k} = $COMMANDS{$method}{$k};
           }
           $cmd{'String'} ||= $method;
           $cmd{'args'} .= $SPACE . shift if ( @_ == 1 );
           return $self->cmd( %cmd, @_ );
       }
   
       if ( exists $ACCESS{$method} ) {
           my $prev = $PRIVATE{$method};
           ( $PRIVATE{$method} ) = @_ if @_;
           return $prev;
       }
   
       $method = "SUPER::$method";
       return $self->$method(@_);
   }
   
   =pod
   
   =head2 B<open> - Open a connection to a Trango AP.
   
   Calls Net::Telnet::open() then makes sure you get a password prompt so
   you are ready to login() and parses the login banner so you can get
   host_type() and firmware_version()
   
   =cut
   
   sub open {
       my $self = shift;
   
       unless ( $self->SUPER::open(@_) ) {
           $self->last_error( "Couldn't connect to " . $self->host . ":  $!" );
           return;
       }
   
       ## Get to login prompt
       unless (
           $self->waitfor(
               -match   => '/password: ?$/i',
               -errmode => "return",
           )
         )
       {
           $self->last_error( "problem connecting to host ("
                 . $self->host . "): "
                 . $self->lastline );
           return;
       }
   
       $self->parse_login_banner( $self->lastline );
   
       $self->is_connected(1);
   
       return $self->is_connected;
   }
   
   =pod
   
   =head2 B<login> - Login to the AP.
   
   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;
       }
   
       my $password = shift;
   
       $self->print($password);
       unless (
           $self->waitfor(
               -match   => $self->prompt,
               -errmode => "return",
           )
         )
       {
           $self->last_error( "login ($self->host) failed: " . $self->lastline );
           return;
       }
   
       $self->logged_in(1);
   
       return $self->logged_in;
   }
   
   =pod
   
   =head2 B<parse_login_banner> - Converts the login_banner to something useful.
   
   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, $sep1, $subtype, $sep2, $ver ) =
         $banner =~
         /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   
       $type .= $sep1 . $subtype;
       $ver = $subtype . $sep2 . $ver;
   
       $self->login_banner($banner);
       $self->host_type($type);
       $self->firmware_version($ver);
   
       return 1;
   }
   
   =pod
   
   =head2 B<su_password> - Set the password on SUs connected to the AP.
   
   su_password('new_password'[, 'suid']) If no suid is specified,
   the default is "all".
   
     $t->su_password('good_pass', 5);
   
   =cut
   
   sub su_password {
       my $self     = shift;
       my $new_pass = shift || $EMPTY;
       my $su       = shift || 'all';
   
       unless ( defined $new_pass ) {
           $self->last_error("No new password");
   
           #return;
       }
   
       return $self->cmd(
           String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass,
           expect => $success,
       );
   }
   
   =pod
   
   =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' );
   
   =cut
   
   sub su_ipconfig {
       my $self = shift;
   
       my $suid        = shift;
       my $new_ip      = shift;
       my $new_subnet  = shift;
       my $new_gateway = shift;
   
       if ( $suid =~ /\D/ ) {
           $self->last_error("Invalid suid '$suid'");
           return;
       }
       unless ($new_ip) {
           $self->last_error("no new_ip passed");
           return;
       }
       unless ($new_subnet) {
           $self->last_error("no new_subnet passed");
           return;
       }
       unless ($new_gateway) {
           $self->last_error("no new_gateway passed");
           return;
       }
   
       # su ipconfig <suid> <new ip> <new subnet> <new gateway>
       return $self->cmd(
           String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE
             . $new_subnet . $SPACE
             . $new_gateway,
           expect => $success,
       );
   }
   
   =pod
   
   =head2 B<sudb_view> - Returns the output from the sudb view command
   
   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'};
       }
   
       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 ($cfg{'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_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.1  
changed lines
  Added in v.1.41
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>