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

version 1.1, 2005/12/29 18:41:17 version 1.30, 2007/02/02 17:51:52
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 use base 'Net::Telnet';  # $RedRiver: Trango.pm,v 1.29 2007/02/01 17:58:33 andrew Exp $
   use strict;
 my %PRIVATE = (  use warnings;
   is_connected => 0,  use base 'Net::Telnet';
   logged_in => 0,  
 );  =pod
   
   =head1 NAME
 sub AUTOLOAD  
 {  Net::Telnet::Trango
   my $self = shift;  - Perl extension for accessing the Trango telnet interface
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  =head1 SYNOPSIS
     or die "Weird: $AUTOLOAD";  
     use Net::Telnet::Trango;
   my $success = 'Success.';    my $t = new Net::Telnet::Trango ( Timeout => 5 );
   my %MEMBERS = (  
     ver     => {},    $t->open( Host => $fox ) or die "Error connecting: $!";
     sysinfo => { waitfor => $success },  
     tftpd   => { waitfor => $success },    $t->login('password') or die "Couldn't log in: $!";
   );  
     # Do whatever
   my %ACCESS = map { $_ => 1 } qw(  
     firmware_version    $t->exit;
     host_type    $t->close;
     Host  
     is_connected  =head1 DESCRIPTION
     logged_in  
     Timeout  Perl access to the telnet interface on Trango Foxes, SUs and APs.
   );  
   Another handy feature is that it will parse the output from certain
   if (exists $MEMBERS{$method}) {  commands that is in the format "[key1] value1 [key2] value2" and put
     return $self->cmd($method, $MEMBERS{$method}{waitfor});  those in a hashref that is returned.  This makes using the output from
   }  things like sysinfo very easy to do.
   
   if (exists $ACCESS{$method}) {  =head2 EXPORT
     my $var = shift || $PRIVATE{$method};  
     $PRIVATE{$method} = $var;  None
     return $var;  
   }  =head1 METHODS
   
   $method = "SUPER::$method";  =over
   return $self->$method(@_);  
 }  =cut
   
 sub new  our $VERSION = '0.01';
 {  
   my $class = shift;  my %PRIVATE = (
   my $args = shift || {};    is_connected => 0,
     logged_in => 0,
   $args->{'Timeout'} ||= 5;  );
   $args->{'Prompt'}  ||= '/#> *$/';  
   =pod
   foreach my $key (keys %{ $args }) {  
     $PRIVATE{$key} = $args->{$key};  =item 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.";  {
     return undef, undef;    my $class = shift;
   }  
   #$self->dump_log('dump.log');    my %args;
     if (@_ == 1) {
   ## Login to remote host.      $args{'Host'} = shift;
   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
 }  
   =back
 sub cmd  
 {  =head2 ACCESSORS
   my $self = shift;  
   These are usually only set internally.
   my $string = shift;  
   my $expect_last = shift;  =over
   my $timeout = shift || $self->Timeout;  
   =item B<firmware_version>
   unless (defined $string) {  
     $! = "No command passed";  - returns the firmware version
     return undef;  
   }  Returns the firmware version if available, otherwise undef.
   
   unless ($self->is_connected) {  It should be available after a successful open().
     $! = "Not connected";  
     return undef;  =item B<host_type>
   }  
   - return the type of host you are connected to.
   unless ($self->logged_in) {  
     $! = "Not logged in";  returns the type of host from the login banner for example M5830S or M5300S.
     return undef;  
   }  Should be available after a successful open().
   
   my @lines = $self->SUPER::cmd(String => $string, Timeout => $timeout);  =item B<is_connected>
   
   my $vals = _decode_lines(@lines);  - Status of the connection to host.
   
   unless ($expect_last) {  returns 1 when connected, undef otherwise.
     return $vals;  
   }  =item B<logged_in>
   
   my $last = $self->lastline;  - Status of being logged in to the host.
   
   if ($last =~ /$expect_last$/) {  returns 1 after a successful login(), 0 if it failed and undef if
     return $vals;  login() was never called.
   } else {  
     warn "Error with command ($string): $last";  =item B<login_banner>
     return undef;  
   }  - The banner when first connecting to the host.
 }  
   returns the banner that is displayed when first connected at login.
 sub _decode_lines  Only set after a successful open().
 {  
   my @lines = @_;  =item B<last_lines>
   
   my %conf;  - The last lines of output from the last cmd().
   
   my $key = '';  returns, as an array ref, the output from the last cmd() that was run.
   my $val = '';  
   my $in_key = 0;  =item B<last_error>
   my $in_val = 0;  
   - A text output of the last error that was encountered.
   foreach my $line (@lines) {  
     my @chars = split //, $line;  returns the last error reported.  Probably contains the last entry in
   last_lines.
     my $last_key = '';  
     foreach my $c (@chars) {  =back
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  =head2 ALIASES
         if ($c eq '[') {  
           $in_key = 1;  =over
           $in_val = 0;  
         } else {  =item B<bye>
           $in_key = 0;  
           $in_val = 0;  - alias of L<exit()>.
         }  
   =item B<restart>
         if ($key) {  
           $key =~ s/^\s+//;  - alias of L<reboot()>.
           $key =~ s/\s+$//;  
   =back
           $val =~ s/^\s+//;  
           $val =~ s/\s+$//;  =head2 COMMANDS
   
           if ($key eq 'Checksum' && $last_key) {  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
             # Special case for these bastids.  as such they accept the same options as C<cmd()>.
             my $new = $last_key;  Specifically they take a named paramater "args", for example:
             $new =~ s/\s+\S+$//;  C<tftpd(args =E<gt> 'on')> would enable tftpd
             $key = $new . " " . $key;  
           }  =over
   
           $last_key = $key;  =item B<tftpd>
           $conf{$key} = $val;  
           $key = '';  - Returns a hash ref of the decoded output from the
           $val = '';  command.
         }  
   Also see enable_tftpd() and disable_tftpd() as those check that it was
       } elsif ($c eq ']') {  successfully changed.
         $in_val = 1;  
         $in_key = 0;  =item B<ver>
         $c = shift @chars;  
   - Returns a hash ref of the decoded output from the
       } elsif ($in_key) {  command.
         $key .= $c;  
   =item B<sysinfo>
       } elsif ($in_val) {  
         $val .= $c;  - Returns a hash ref of the decoded output from the
       }  command.
     }  
   }  =item B<exit>
   #print Dump \%conf;  
   - exits the command session with the Trango and closes
   if (%conf) {  the connection
     return \%conf;  
   } else {  =item B<reboot>
     return \@lines;  
   }  - reboots the Trango and closes the connection
 }  
   =item B<remarks>
   
   - Set or retrieve the remarks.
   
   Takes an optional argument, which sets the remarks.
   If there is no argument, returns the current remarks.
   
     my $old_remarks = $t->remarks();
     $t->remarks($new_remarks);
   
   =item B<sulog>
   
   - returns an array ref of hashes containing each log
   line.
   
   =item B<save_sudb>
   
   - returns true on success, undef on failure
   
   =item B<syslog>
   
   - returns the output from the syslog command
   
   =item B<pipe>
   
   - returns the output from the pipe command
   
   =item B<maclist>
   
   -  returns the output from the maclist command
   
   =item B<maclist_reset>
   
   - resets the maclist.
   
   No useful output.
   
   =item B<eth_list>
   
   - returns the output from the eth list command
   
   =item B<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);
   
   =item B<save_ss>
   
   - saves the config.
   
   Returns 1 on success, undef on failure.
   
   =cut
   
   
   my $success = 'Success\\.';
   my %COMMANDS = (
     tftpd       => { decode => 'all',   expect => $success },
     ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
     updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
     'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
     reboot      => { no_prompt => 1, cmd_disconnects => 1 },
     remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
     syslog      => { expect => $success },
     'pipe'      => { }, # XXX needs a special decode
     maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
     eth_link    => { String => 'eth link', expect => $success },
     su_info     => { String => 'su info', decode => 'all', expect => $success },
     save_ss     => { String => 'save ss', expect => $success },
     opmode      => { decode => 'all',   expect => $success },
     # eth r, w and reset???
     #su password???
     #_bootloader
     #temp
     #heater
   );
   
   my %ALIASES = (
     bye     => 'exit',
     restart => 'reboot',
     Host    => 'host',
   );
   
   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'}   .= ' ' . 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
   
   =item 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
   
   =item 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
   
   =item B<parse_login_banner>
   
   - Converts the login_banner to some useful
   variables.
   
   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
   
   =item 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 || '';
     my $su       = shift || 'all';
   
     unless (defined $new_pass) {
       $self->last_error("No new password");
       #return;
     }
   
     return $self->cmd(String => 'su password ' .
                        $su . ' ' .
                        $new_pass . ' ' .
                        $new_pass,
                        expect => $success,
                       );
   }
   
   =pod
   
   =item 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       . ' ' .
                        $new_ip     . ' ' .
                        $new_subnet . ' ' .
                        $new_gateway,
                        expect => $success,
                       );
   }
   
   =pod
   
   =item 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
   
   =item B<sudb_add>
   
   Takes the following paramaters
   
           suid : numeric,
           type : (reg|pr)
           cir  : numeric,
           mir  : numeric,
           mac  : Almost any format, it will be reformatted,
   
   and returns true on success or undef otherwise.
   
     $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 ' ', $new_mac =~ /../g;
   
           my $string = 'sudb add ' .
                   $suid . ' ' .
                   $type . ' ' .
                   $cir  . ' ' .
                   $mir  . ' ' .
                   $new_mac;
   
   
           return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =item B<sudb_delete>
   
   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
   
   =item B<sudb_modify>
   
   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 . ' ' . $opt . ' ' . $value;
   
           return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =item 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 ($vals->{'Tftpd'} eq 'listen') {
       return $vals;
     } else {
       return;
     }
   }
   
   =pod
   
   =item 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
   
   =item 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'} .= ' ' . $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);
       } else {
         $vals = _decode_lines(@lines);
       }
     }
   
     $self->last_vals($vals);
   
   
     my $last = $self->lastline;
   
     if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
       if ($cfg{'cmd_disconnects'}) {
         $self->logged_in(0);
         $self->close;
         $self->is_connected(0);
       }
   
       if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
         return $vals;
       } else {
         return \@lines;
       }
     } else {
       $self->last_error("Error with command ($cfg{'String'}): $last");
       return;
     }
   }
   
   #=item _decode_lines
   
   sub _decode_lines
   {
     my @lines = @_;
   
     my %conf;
   
     my $key = '';
     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 = '';
       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 . " " . $key;
             }
   
             $conf{$key} = $val;
             $last_key = $key;
             $key = '';
           } elsif ($val) {
                           push @vals, $val;
                   }
           $val = '';
   
         } 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 {
                   # XXX we should have a way to set last error, not sure why we don't
                   return;
           }
   }
   
   1;
   __END__
   
   =back
   
   =head1 SEE ALSO
   
   Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm
   
   L<Net::Telnet>
   
   =head1 TODO
   
   There are still a lot of commands that are not accessed directly.  If
   you call them (as cmd("command + args") or whatever) and it works,
   please send me examples that work and I will try to get it incorporated
   into the next version of the script.
   
   I also want to be able to parse the different types of output from
   commands like su, sudb all and anything else that would be better
   available as a perl datastructure.
   
   =head1 AUTHOR
   
   Andrew Fresh E<lt>andrew@rraz.netE<gt>
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005,2006,2007 by Andrew Fresh
   
   This library is free software; you can redistribute it and/or modify
   it under the same terms as Perl itself, either Perl version 5.8.7 or,
   at your option, any later version of Perl 5 you may have available.
   
   =cut
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.30
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>