[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.10 and 1.35

version 1.10, 2006/07/31 23:16:52 version 1.35, 2007/02/05 21:03:40
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.9 2006/07/14 01:17:29 andrew Exp $  
   # $RedRiver: Trango.pm,v 1.34 2007/02/05 21:02:07 andrew Exp $
 use strict;  use strict;
 use warnings;  use warnings;
 use base 'Net::Telnet';  use base 'Net::Telnet';
Line 8 
Line 9 
   
 =head1 NAME  =head1 NAME
   
 Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface  Net::Telnet::Trango
   - Perl extension for accessing the Trango telnet interface
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
   use Net::Telnet::Trango;    use Net::Telnet::Trango;
   my $t = new Net::Telnet::Trango ( Timeout => 5 );    my $t = new Net::Telnet::Trango ( Timeout => 5 );
     
   $t->open( Host => $fox ) or die "Error connecting: $!";    $t->open( Host => $fox ) or 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->exit;
   $t->close;    $t->close;
   
Line 28 
Line 30 
   
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  Perl access to the telnet interface on Trango Foxes, SUs and APs.
   
 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.  Another handy feature is that it will parse the output from certain
   commands that is in the format "[key1] value1 [key2] value2" and put
   those in a hashref that is returned.  This makes using the output from
   things like sysinfo very easy to do.
   
 =head2 EXPORT  =head2 EXPORT
   
 None  None
   
   =head1 METHODS
   
 =cut  =cut
   
 our $VERSION = '0.01';  our $VERSION = '0.01';
   
 my %PRIVATE = (  my %PRIVATE = (
   is_connected => 0,      is_connected => 0,
   logged_in => 0,      logged_in    => 0,
 );  );
   
 =pod  =pod
   
 =item new  =head2 B<new>
   - Creates a new Net::Telnet::Trango object.
   
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'      new([Options from Net::Telnet,]
           [Decode => 0,]);
   
   Same as new from L<Net::Telnet> but sets the default Trango Prompt:
   '/#> *$/'
   
 It also takes an optional parameter 'Decode'.  If not defined it  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  defaults to 1, if it is set to 0, it will not decode the output and
 instead return an array of the lines that were returned from the  instead return a reference to an array of the lines that were returned
 command.  from the command.
   
 =cut  =cut
   
 sub new  sub new {
 {      my $class = shift;
   my $class = shift;  
   
   my %args;      my %args;
   if (@_ == 1) {      if ( @_ == 1 ) {
     $args{'Host'} = shift;          $args{'Host'} = shift;
   } else {      }
     %args = @_;      else {
   }          %args = @_;
       }
   
   $args{'Prompt'}  ||= '/#> *$/';      $args{'Prompt'} ||= '/#> *$/';
   
   foreach my $key (keys %args) {      foreach my $key ( keys %args ) {
     $PRIVATE{$key} = $args{$key};          $PRIVATE{$key} = $args{$key};
   }      }
   $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};      $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
   delete $args{'Decode'};      delete $args{'Decode'};
   
   my $self = $class->SUPER::new(%args);      my $self = $class->SUPER::new(%args);
   bless $self if ref $self;      bless $self if ref $self;
   
   return $self;      return $self;
 }  }
   
 #  _password <new password> <new password>  #  _password <new password> <new password>
Line 157 
Line 169 
   
 =pod  =pod
   
 =head1 METHODS  =head1 ACCESSORS
   
 =head2 ACCESSORS  These are usually only set internally.
   
 =over  =head2 B<firmware_version>
   - returns the firmware version
   
 =item Host  Returns the firmware version if available, otherwise undef.
   
 returns the name of the host that you are accessing  It should be available after a successful open().
   
 =item firmware_version  =head2 B<host_type>
   - return the type of host you are connected to.
   
 returns the firmware version on the trango if available otherwise undef.    returns the type of host from the login banner for example M5830S or M5300S.  
 Available after a successful open()  
 This is usually only set internally  
   
 =item host_type  Should be available after a successful open().
   
 returns the type of host from the login banner for example M5830S or M5300S.    =head2 B<is_connected>
 Available after a successful open()  - Status of the connection to host.
 This is usually only set internally  
   
 =item is_connected  returns 1 when connected, undef otherwise.
   
 returns 1 after a successful open() otherwise undef  =head2 B<logged_in>
 This is usually only set internally  - Status of being logged in to the host.
   
 =item logged_in  returns 1 after a successful login(), 0 if it failed and undef if
   login() was never called.
   
 returns 1 after a successful login() 0 if it failed and undef if  =head2 B<login_banner>
 login() was never called  - The banner when first connecting to the host.
 This is usually only set internally  
   
 =item login_banner  returns the banner that is displayed when first connected at login.  
   Only set after a successful open().
   
 returns the banner that is displayed when first connected at login.  Only set after a successful open()  =head2 B<last_lines>
   - The last lines of output from the last cmd().
   
 This is usually only set internally  returns, as an array ref, the output from the last cmd() that was run.
   
 =item last_lines  =head2 B<last_error>
   - A text output of the last error that was encountered.
   
 returns the output from the last cmd() that was run as an array ref  returns the last error reported.  Probably contains the last entry in
 This is usually only set internally  last_lines.
   
 =back  =head1 ALIASES
   
 =head2 ALIASES  =head2 B<bye>
   - alias of exit()
   
 =over  Does the same as exit()
   
 =item bye  =head2 B<restart>
   - alias of reboot()
   
 alias of exit()  Does the same as reboot()
   
 =item restart  =head1 COMMANDS
   
 alias of reboot()  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:
   C<tftpd(args =E<gt> 'on')> would enable tftpd
   
 =back  =head2 B<tftpd>
   - The output from the tftpd command
   
 =head2 COMMANDS  Returns a hash ref of the decoded output from the
   command.
   
 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:  Also see enable_tftpd() and disable_tftpd() as those check that it was
 C<tftpd(args =E<gt> 'on')> would enable tftpd  successfully changed.
   
 =over  =head2 B<ver>
   - The output from the ver command
   
 =item tftpd  Returns a hash ref of the decoded output from the
   command.
   
 Returns a hash ref of the decoded output from the command.  =head2 B<sysinfo>
   - The output from the sysinfo command
   
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  Returns a hash ref of the decoded output from the
   command.
   
 =item ver  =head2 B<exit>
   - Exits the connection
   
 Returns a hash ref of the decoded output from the command.  exits the command session with the Trango and closes
   the connection
   
 =item sysinfo  =head2 B<reboot>
   - Sends a reboot command
   
 Returns a hash ref of the decoded output from the command.  reboots the Trango and closes the connection
   
 =item exit  =head2 B<remarks>
   - Set or retrieve the remarks.
   
 exits the command session with the trango and closes the connection  Takes an optional argument, which sets the remarks.  
   If there is no argument, returns the current remarks.
   
 =item reboot    my $old_remarks = $t->remarks();
     $t->remarks($new_remarks);
   
 reboots the trango and closes the connection  =head2 B<sulog>
   - The output from the sulog command
   
 =item sulog  Returns an array ref of hashes containing each log
   line.
   
 returns an array ref of hashes containing each log line.  =head2 B<save_sudb>
   - saves the sudb
   
 =item save_sudb  Returns true on success, undef on failure
   
 returns true on success, undef on failure  =head2 B<syslog>
   - The output from the sulog command
   
 =item syslog  Returns a hashref of the output from the syslog command
   
 returns the output from the syslog command  =head2 B<pipe>
   - the pipe command
   
 =item pipe  Returns the output from the pipe command
   
 returns the output from the pipe command  =head2 B<maclist>
   - retrieves the maclist
   
 =item maclist  Returns the output from the maclist command
   
 returns the output from the maclist command  =head2 B<maclist_reset>
   - resets the maclist.  
   
 =item maclist_reset  No useful output.
   
 resets the maclist.  No useful output.  =head2 B<eth_list>
   - eth list command
   
 =item eth_list  Returns the output from the eth list command
   
 returns the output from the eth list command  
   
 =cut  =head2 B<su_info>
   - gets the su info
   
   Returns information about the SU.
   
 my $success = 'Success.';  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.
   
   =cut
   
   my $success  = 'Success\\.';
 my %COMMANDS = (  my %COMMANDS = (
   tftpd       => { decode => 'all',   expect => $success },      tftpd       => { decode    => 'all',       expect          => $success },
   ver         => { decode => 'all' },      ver         => { decode    => 'all' },
   sysinfo     => { decode => 'all',   expect => $success },      sysinfo     => { decode    => 'all',       expect          => $success },
   updateflash => { decode => 'all',   expect => $success },      updateflash => { decode    => 'all',       expect          => $success },
   sulog       => { decode => 'sulog', expect => $success },      sulog       => { decode    => 'sulog',     expect          => $success },
   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },      'exit'      => { no_prompt => 1,           cmd_disconnects => 1 },
   reboot      => { no_prompt => 1, cmd_disconnects => 1 },      reboot      => { no_prompt => 1,           cmd_disconnects => 1 },
   save_sudb   => { String => 'save sudb', expect => $success },      remarks     => { decode    => 'all',       expect          => $success },
   syslog      => { expect => $success },      save_sudb   => { String    => 'save sudb', expect          => $success },
   'pipe'      => { }, # XXX needs a special decode      syslog      => { expect    => $success },
   maclist     => { }, # XXX needs a special decode and a special expect      'pipe'  => {},                        # XXX needs a special decode
   maclist_reset => { String => 'maclist reset', expect => 'done' },      maclist => { decode => 'maclist' },
   eth_link    => { String => 'eth link', expect => $success },      maclist_reset => { String => 'maclist reset', expect => 'done' },
   # eth r, w and reset???      eth_link => { String => 'eth link', expect => $success },
   #su password???      su_info  => { String => 'su info',  decode => 'all', expect => $success },
   #_bootloader      su_testrflink =>
   #temp        { String => 'su testrflink', decode => 'each', expect => $success },
   #heater      save_ss => { String => 'save ss', expect => $success },
       opmode  => { decode => 'all',     expect => $success },
   
       # eth r, w and reset???
       #su password???
       #_bootloader
       #temp
       #heater
 );  );
   
 my %ALIASES = (  my %ALIASES = (
   bye     => 'exit',      bye     => 'exit',
   restart => 'reboot',      restart => 'reboot',
       Host    => 'host',
 );  );
   
 my %ACCESS = map { $_ => 1 } qw(  my %ACCESS = map { $_ => 1 } qw(
   firmware_version    firmware_version
   host_type    host_type
   Host    is_connected
   is_connected  
   logged_in    logged_in
   login_banner    login_banner
   Timeout    Timeout
   last_lines    last_lines
   last_vals    last_vals
     last_error
     Decode
 );  );
   
 sub AUTOLOAD  sub AUTOLOAD {
 {      my $self = shift;
   my $self = shift;  
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/      my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/
     or die "Weird: $AUTOLOAD";        or die "Weird: $AUTOLOAD";
   
   if (exists $ALIASES{$method}) {      if ( exists $ALIASES{$method} ) {
     $method = $ALIASES{$method};          $method = $ALIASES{$method};
     return $self->$method(@_);          return $self->$method(@_);
   }      }
   
   if (exists $COMMANDS{$method}) {      if ( exists $COMMANDS{$method} ) {
     $method = shift if (@_ == 1);          my %cmd;
     $COMMANDS{$method}{'String'} ||= $method;          foreach my $k ( keys %{ $COMMANDS{$method} } ) {
     return $self->cmd(%{ $COMMANDS{$method} }, @_);              $cmd{$k} = $COMMANDS{$method}{$k};
   }          }
           $cmd{'String'} ||= $method;
           $cmd{'args'} .= ' ' . shift if ( @_ == 1 );
           return $self->cmd( %cmd, @_ );
       }
   
   if (exists $ACCESS{$method}) {      if ( exists $ACCESS{$method} ) {
     my $prev = $PRIVATE{$method};          my $prev = $PRIVATE{$method};
     ($PRIVATE{$method}) = @_ if @_;          ( $PRIVATE{$method} ) = @_ if @_;
     return $prev;          return $prev;
   }      }
   
   $method = "SUPER::$method";      $method = "SUPER::$method";
   return $self->$method(@_);      return $self->$method(@_);
 }  }
   
 =pod  =pod
   
 =item open  =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()  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  =cut
   
 sub open  sub open {
 {      my $self = shift;
   my $self = shift;  
   
   unless ( $self->SUPER::open(@_) ) {      unless ( $self->SUPER::open(@_) ) {
     #$! = "Couldn't connect to " . $self->Host . ":  $!";          $self->last_error( "Couldn't connect to " . $self->host . ":  $!" );
     return undef;          return;
   }      }
   
   ## Get to login prompt      ## Get to login prompt
   unless ($self->waitfor(      unless (
       -match => '/password: ?$/i',          $self->waitfor(
       -errmode => "return",              -match   => '/password: ?$/i',
     ) ) {              -errmode => "return",
     #$! = "problem connecting to host (" . $self->Host . "): " .          )
     #    $self->lastline;        )
     return undef;      {
   }          $self->last_error( "problem connecting to host ("
                 . $self->host . "): "
                 . $self->lastline );
           return;
       }
   
   $self->parse_login_banner($self->lastline);      $self->parse_login_banner( $self->lastline );
   
   $self->is_connected(1);      $self->is_connected(1);
   
   return $self->is_connected;      return $self->is_connected;
 }  }
   
 =pod  =pod
   
 =item login  =head2 B<login>
   - Login to the AP.
   
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  Calls open() if not already connected, then sends the password and sets
   logged_in() if successful
   
 =cut  =cut
   
 sub login  sub login {
 {      my $self = shift;
   my $self = shift;  
   
   unless ($self->is_connected) {      unless ( $self->is_connected ) {
     $self->open or return undef;          $self->open or return;
   }      }
   
   my $password = shift;      my $password = shift;
   
   $self->print($password);      $self->print($password);
   unless ($self->waitfor(      unless (
     -match => $self->prompt,          $self->waitfor(
     -errmode => "return",              -match   => $self->prompt,
   ) ) {              -errmode => "return",
     #$! = "login ($self->Host) failed: " . $self->lastline;          )
     return undef;        )
   }      {
           $self->last_error( "login ($self->host) failed: " . $self->lastline );
           return;
       }
   
   $self->logged_in(1);      $self->logged_in(1);
   
   return $self->logged_in;      return $self->logged_in;
 }  }
   
 =pod  =pod
   
 =item parse_login_banner  =head2 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()  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  =cut
   
 sub parse_login_banner  sub parse_login_banner {
 {      my $self = shift;
   my $self = shift;  
   
   if (@_) {      if (@_) {
     $self->login_banner(@_);          $self->login_banner(@_);
   }      }
   
   my $banner = $self->login_banner;      my $banner = $self->login_banner;
   
   my ($type, $ver) = $banner =~      my ( $type, $sep1, $subtype, $sep2, $ver ) =
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;        $banner =~
         /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   
   $self->login_banner($banner);      $type .= $sep1 . $subtype;
   $self->host_type($type);      $ver = $subtype . $sep2 . $ver;
   $self->firmware_version($ver);  
   
   return 1;      $self->login_banner($banner);
       $self->host_type($type);
       $self->firmware_version($ver);
   
       return 1;
 }  }
   
 =pod  =pod
   
 =item su_password  =head2 B<su_password>
   - Set the password on SUs connected to the AP.
   
 C<su_password('all'|suid, 'new_password')>  su_password('new_password'[, 'suid']) If no suid is specified,
   the default is "all".
   
     $t->su_password('good_pass', 5);
   
 =cut  =cut
   
 sub su_password  sub su_password {
 {      my $self     = shift;
   my $self     = shift;      my $new_pass = shift || '';
   my $su       = shift || '!';      my $su       = shift || 'all';
   my $new_pass = shift || '';  
   
   unless (defined $su) {      unless ( defined $new_pass ) {
     warn "No su passed!"          $self->last_error("No new password");
     #return undef;  
   }  
   
   unless (defined $new_pass) {          #return;
     warn "No new password!"        }
     #return undef;  
   }  
   
   return $self->cmd(String => 'su password ' .      return $self->cmd(
                      $su . ' ' .          String => 'su password ' . $su . ' ' . $new_pass . ' ' . $new_pass,
                      $new_pass . ' ' .          expect => $success,
                      $new_pass,      );
                      expect => $success,  
                     );  
 }  }
   
 =pod  =pod
   
 =item sudb_view  =head2 B<su_ipconfig>
   - Change IP configuration on SUs connected to
   the AP.
   
 returns a reference to an array of hashes each containing:  su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
   
   suid    $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
   type  
   cir  
   mir  
   mac  
   
 =cut  =cut
   
 sub sudb_view  sub su_ipconfig {
 {      my $self = shift;
   my $self = shift;  
   
   my @lines = $self->cmd( String => 'sudb view', expect => $success );      my $suid        = shift;
       my $new_ip      = shift;
       my $new_subnet  = shift;
       my $new_gateway = shift;
   
   return undef unless @lines;      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;
       }
   
   unless ($PRIVATE{'Decode'}) {      # su ipconfig <suid> <new ip> <new subnet> <new gateway>
     return @lines;      return $self->cmd(
   }          String => 'su ipconfig ' . $suid . ' ' . $new_ip . ' '
             . $new_subnet . ' '
             . $new_gateway,
           expect => $success,
       );
   }
   
   my @sus;  =pod
   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;  =head2 B<sudb_view>
           $s{'mac'} = uc($s{'mac'});  - Returns the output from the sudb view command
   
       push @sus, \%s;  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;
     }      }
   }  
   
   return \@sus;      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  =pod
   
 =item sudb_add  =head2 B<sudb_add>
   
 Takes the following paramaters  Takes the following paramaters
   
         suid : numeric,      suid : numeric,
         type : (reg|pr)      type : (reg|pr)
         cir  : numeric,      cir  : numeric,
         mir  : numeric,      mir  : numeric,
         mac  : Almost any format, it will be reformatted,      mac  : Almost any format, it will be reformatted,
   
 and returns true on success or undef otherwise.  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  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
 =cut  =cut
   
 sub sudb_add  sub sudb_add {
 {      my $self = shift;
         my $self = shift;      my $suid = shift;
         my $suid = shift;      my $type = shift;
         my $type = shift;      my $cir  = shift;
         my $cir  = shift;      my $mir  = shift;
         my $mir  = shift;      my $mac  = shift;
         my $mac  = shift;  
   
         if ($suid =~ /\D/) {      if ( $suid =~ /\D/ ) {
                 return undef;          $self->last_error("Invalid suid '$suid'");
         }          return;
       }
   
         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {      unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) {
                 warn "Invalid type '$type'!";          $self->last_error("Invalid type '$type'");
                 return undef;          return;
         }      }
   
         if ($cir =~ /\D/) {      if ( $cir =~ /\D/ ) {
                 warn "Invalid CIR '$cir'!";          $self->last_error("Invalid CIR '$cir'");
                 return undef;          return;
         }      }
   
         if ($mir =~ /\D/) {      if ( $mir =~ /\D/ ) {
                 warn "Invalid MIR '$mir'!";          $self->last_error("Invalid MIR '$mir'");
                 return undef;          return;
         }      }
   
         my $new_mac = $mac;      my $new_mac = $mac;
         $new_mac =~ s/[^0-9A-Fa-f]//;      $new_mac =~ s/[^0-9A-Fa-f]//;
         unless (length $new_mac == 12) {      unless ( length $new_mac == 12 ) {
                 warn "Invalid MAC '$mac'!";          $self->last_error("Invalid MAC '$mac'");
                 return undef;          return;
         }      }
         $new_mac = join ' ', $new_mac =~ /../g;      $new_mac = join ' ', $new_mac =~ /../g;
   
         my $string = 'sudb add ' .      my $string =
                 $suid . ' ' .        'sudb add ' . $suid . ' ' . $type . ' ' . $cir . ' ' . $mir . ' '
                 $type . ' ' .        . $new_mac;
                 $cir  . ' ' .  
                 $mir  . ' ' .  
                 $new_mac;  
   
       return $self->cmd( String => $string, expect => $success );
         return $self->cmd( String => $string, expect => $success );  
 }  }
   
 =pod  =pod
   
 =item sudb_delete  =head2 B<sudb_delete>
   
 Takes either 'all' or the  suid of the su to delete  Takes either 'all' or the  suid of the su to delete
 and returns true on success or undef otherwise.  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  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
 =cut  =cut
   
 sub sudb_delete  sub sudb_delete {
 {      my $self = shift;
         my $self = shift;      my $suid = shift;
         my $suid = shift;  
   
         if (lc($suid) ne 'all' || $suid =~ /\D/) {      #if (lc($suid) ne 'all' || $suid =~ /\D/) {
                 return undef;      if ( $suid =~ /\D/ ) {
         }          $self->last_error("Invalid suid '$suid'");
           return;
       }
   
         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );      return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
 }  }
   
 =pod  =pod
   
 =item sudb_modify  =head2 B<sudb_modify>
   
 Takes either the  suid of the su to delete  Takes either the  suid of the su to change
 as well as what you are changing, either "cir, mir or su2su"  as well as what you are changing, either "cir, mir or su2su"
 and returns true on success or undef otherwise.  and returns true on success or undef otherwise.
   
Line 620 
Line 744 
   
 su2su takes a group id parameter that is in hex.  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  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
 =cut  =cut
   
 sub sudb_modify  sub sudb_modify {
 {      my $self  = shift;
         my $self  = shift;      my $suid  = shift;
         my $suid  = shift;      my $opt   = shift;
         my $opt   = shift;      my $value = shift;
         my $value = shift;  
   
         if ($suid =~ /\D/) {      if ( $suid =~ /\D/ ) {
                 return undef;          $self->last_error("Invalid suid '$suid'");
         }          return;
       }
   
         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {      if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) {
                 if ($value =~ /\D/) {          if ( $value =~ /\D/ ) {
                         return undef;              $self->last_error("Invalid $opt '$value'");
                 }              return;
         } elsif (lc($opt) eq 'su2su') {          }
                 if ($value =~ /[^0-9A-Za-f]/) {      }
                         return undef;      elsif ( lc($opt) eq 'su2su' ) {
                 }          if ( $value =~ /[^0-9A-Za-f]/ ) {
         } else {              $self->last_error("Invalid MAC '$value'");
                 return undef;              return;
         }          }
       }
       else {
           $self->last_error("Invalid option '$opt'");
           return;
       }
   
         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;      my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
   
         return $self->cmd( String => $string, expect => $success );      return $self->cmd( String => $string, expect => $success );
 }  }
   
 =pod  =pod
   
 =item enable_tftpd  =head2 B<enable_tftpd>
   - enable the TFTP server
   
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
 =cut  =cut
   
 sub enable_tftpd  sub enable_tftpd {
 {      my $self = shift;
   my $self = shift;  
   
   my $vals = $self->tftpd( args => 'on' );      my $vals = $self->tftpd( args => 'on' );
   
   if ($vals->{'Tftpd'} eq 'listen') {      if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) {
     return $vals;          return $vals;
   } else {      }
     return undef;      else {
   }          return;
       }
 }  }
   
 =pod  =pod
   
 =item disable_tftpd  =head2 B<disable_tftpd>
   - disable the TFTP server
   
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
 =cut  =cut
   
 sub disable_tftpd  sub disable_tftpd {
 {      my $self = shift;
   my $self = shift;  
   
   my $vals = $self->tftpd( args => 'off' );      my $vals = $self->tftpd( args => 'off' );
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {      if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled' ) {
     return $vals;          return $vals;
   } else {      }
     return undef;      else {
   }          return;
       }
 }  }
   
 =pod  =pod
   
 =item cmd  =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.  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  Normally returns the last lines from from the command
   
 Also accepts these options:  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.
   
 I<decode>  In addition to the Net::Telnet::cmd() options, it also accepts these:
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output  
   
   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>  I<cmd_disconnects>
 - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false  - 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>  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  - 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>  I<args>
 - a string containing the command line options that are passed to the command  - a string containing the command line options that are passed to the
   command
   
       $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 );
   
 =cut  =cut
   
 sub cmd  sub cmd {
 {      my $self = shift;
   my $self = shift;  
   
   my @valid_net_telnet_opts = qw(      my @valid_net_telnet_opts = qw(
     String        String
     Output        Output
     Cmd_remove_mode        Cmd_remove_mode
     Errmode        Errmode
     Input_record_separator        Input_record_separator
     Ors        Ors
     Output_record_separator        Output_record_separator
     Prompt        Prompt
     Rs        Rs
     Timeout        Timeout
   );      );
   
   my %cfg;      my %cfg;
   if (@_ == 1) {      if ( @_ == 1 ) {
     $cfg{'String'} = shift;          $cfg{'String'} = shift;
   } elsif (@_ > 1) {      }
     %cfg = @_;      elsif ( @_ > 1 ) {
   }          %cfg = @_;
       }
   
   $cfg{'Timeout'} ||= $self->Timeout;      $cfg{'Timeout'} ||= $self->Timeout;
   
   unless ($cfg{'String'}) {      unless ( $cfg{'String'} ) {
     #$! = "No command passed";          $self->last_error("No command passed");
     #warn "No command passed\n";          return;
     return undef;      }
   }  
   
   unless ($self->is_connected) {      unless ( $self->is_connected ) {
     #$! = "Not connected";          $self->last_error("Not connected");
     #warn "Not connected\n";          return;
     return undef;      }
   }  
   
   unless ($self->logged_in) {      unless ( $self->logged_in ) {
     #$! = "Not logged in";          $self->last_error("Not logged in");
     #warn "Not logged in\n";          return;
     return undef;      }
   }  
   
       my %cmd;
       foreach (@valid_net_telnet_opts) {
           if ( exists $cfg{$_} ) {
               $cmd{$_} = $cfg{$_};
           }
       }
       if ( $cfg{'args'} ) {
           $cmd{'String'} .= ' ' . $cfg{'args'};
       }
   
   my %cmd;      my @lines;
   foreach (@valid_net_telnet_opts) {      if ( $cfg{'no_prompt'} ) {
     if (exists $cfg{$_}) {          $self->print( $cmd{'String'} );
       $cmd{$_} = $cfg{$_};          @lines = $self->lastline;
     }      }
   }      else {
   if ($cfg{'args'}) {          @lines = $self->SUPER::cmd(%cmd);
     $cmd{'String'} .= ' ' . $cfg{'args'};      }
   }  
   my @lines;  
   unless ($cfg{'no_prompt'}) {  
     @lines = $self->SUPER::cmd(%cmd);  
   } else {  
     $self->print($cmd{'String'});  
     @lines = $self->lastline;  
   }  
   
   $self->last_lines(\@lines);      $self->last_lines( \@lines );
   
   my $vals = 1;      my $vals = 1;
   if ($PRIVATE{'Decode'} && $cfg{'decode'}) {      if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
     if ($cfg{'decode'} eq 'each') {          if ( $cfg{'decode'} eq 'each' ) {
       $vals = _decode_each_line(@lines);              $vals = _decode_each_line(@lines);
     } elsif ($cfg{'decode'} eq 'sulog') {          }
       $vals = _decode_sulog(@lines);          elsif ( $cfg{'decode'} eq 'sulog' ) {
     } else {              $vals = _decode_sulog(@lines);
       $vals = _decode_lines(@lines);          }
           elsif ( $cfg{'decode'} eq 'maclist' ) {
               $vals = _decode_maclist(@lines);
           }
           else {
               $vals = _decode_lines(@lines);
           }
     }      }
   }  
   
   $self->last_vals($vals);      $self->last_vals($vals);
   
       my $last = $self->lastline;
   
   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 ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {          if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
     if ($cfg{'cmd_disconnects'}) {              return $vals;
       $self->logged_in(0);          }
       $self->close;          else {
       $self->is_connected(0);              return \@lines;
           }
     }      }
       else {
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {          $self->last_error("Error with command ($cfg{'String'}): $last");
       return $vals;          return;
     } else {  
       return @lines;  
     }      }
   } else {  
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;  
   }  
 }  }
   
 #=item _decode_lines  #=item _decode_lines
   
 sub _decode_lines  sub _decode_lines {
 {      my @lines = @_;
   my @lines = @_;  
   
   my %conf;      my %conf;
   
   my $key = '';      my $key = '';
   my $val = '';      my $val = undef;
   my $in_key = 0;      my @vals;
   my $in_val = 0;      my $in_key = 0;
       my $in_val = 1;
   
   foreach my $line (@lines) {      foreach my $line (@lines) {
     next if $line =~ /$success$/;          next if $line =~ /$success$/;
   
     my @chars = split //, $line;          my @chars = split //, $line;
   
     my $last_key = '';          my $last_key = '';
     foreach my $c (@chars) {          foreach my $c (@chars) {
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {              if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) {
         if ($c eq '[') {                  if ( $c eq '[' ) {
           $in_key = 1;                      $in_key = 1;
           $in_val = 0;                      $in_val = 0;
         } else {                  }
           $in_key = 0;                  else {
           $in_val = 0;                      $in_key = 0;
         }                      $in_val = 1;
                   }
   
         if ($key) {                  if ($key) {
           $key =~ s/^\s+//;                      $key =~ s/^\s+//;
           $key =~ s/\s+$//;                      $key =~ s/\s+$//;
   
           $val =~ s/^\s+//;                      if ($val) {
           $val =~ s/\s+$//;                          $val =~ s/^\s+//;
                           $val =~ s/\s+$//;
                       }
   
           if ($key eq 'Checksum' && $last_key) {                      if ( $key eq 'Checksum' && $last_key ) {
             # Special case for these bastids.  
             my $new = $last_key;  
             $new =~ s/\s+\S+$//;  
             $key = $new . " " . $key;  
           }  
   
           $last_key = $key;                          # Special case for these bastids.
           $conf{$key} = $val;                          my $new = $last_key;
           $key = '';                          $new =~ s/\s+\S+$//;
           $val = '';                          $key = $new . " " . $key;
         }                      }
   
       } elsif ($c eq ']') {                      $conf{$key} = $val;
         $in_val = 1;                      $last_key   = $key;
         $in_key = 0;                      $key        = '';
         $c = shift @chars;                  }
                   elsif ($val) {
                       push @vals, $val;
                   }
                   $val = '';
   
       } elsif ($in_key) {              }
         $key .= $c;              elsif ( $c eq ']' ) {
                   $in_val = 1;
                   $in_key = 0;
                   $c      = shift @chars;
   
       } elsif ($in_val) {              }
         $val .= $c;              elsif ($in_key) {
       }                  $key .= $c;
   
               }
               elsif ($in_val) {
                   $val .= $c;
               }
           }
     }      }
   }  
   
   if (%conf) {      unless ($key) {
     return \%conf;          push @vals, $val;
   } else {      }
     return undef;  
   }      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  #=item _decode_each_line
   
 sub _decode_each_line  sub _decode_each_line {
 {      my @lines = @_;
   my @lines = @_;      my @decoded;
   my @decoded;      foreach my $line (@lines) {
   foreach my $line (@lines) {          my $decoded = _decode_lines($line);
     my $decoded = _decode_lines($line);          push @decoded, $decoded if defined $decoded;
     push @decoded, $decoded if defined $decoded;      }
   }      return \@decoded;
   return \@decoded;  
 }  }
   
 #=item _decode_sulog  #=item _decode_sulog
   
 sub _decode_sulog  sub _decode_sulog {
 {      my @lines = @_;
   my @lines = @_;      my @decoded;
   my @decoded;      my $last_tm;
   my $last_tm;      foreach my $line (@lines) {
   foreach my $line (@lines) {          my $decoded = _decode_lines($line);
     my $decoded = _decode_lines($line);  
   
     if (defined $decoded) {          if ( defined $decoded ) {
       if ($decoded->{'tm'}) {              if ( $decoded->{'tm'} ) {
         $last_tm = $decoded->{'tm'};                  $last_tm = $decoded->{'tm'};
         next;                  next;
       } else {              }
         $decoded->{'tm'} = $last_tm;              else {
       }                  $decoded->{'tm'} = $last_tm;
       next unless $last_tm;              }
               next unless $last_tm;
   
       push @decoded, $decoded if defined $decoded;              push @decoded, $decoded if defined $decoded;
           }
     }      }
   }      return \@decoded;
   return \@decoded;  
 }  }
   
 1;  #=item _decode_maclist
 __END__  
   
 =back  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 of Net::Telnet::Trango
   __END__
   
 =head1 SEE ALSO  =head1 SEE ALSO
   
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm  Trango Documentation -
   L<http://www.trangobroadband.com/support/product_docs.htm>
   
 L<Net::Telnet>  L<Net::Telnet>
   
 =head1 TODO  =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.  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.  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  =head1 AUTHOR
   
 Andrew Fresh E<lt>andrew@rraz.netE<gt>  Andrew Fresh E<lt>andrew@rraz.netE<gt>
   
 =head1 COPYRIGHT AND LICENSE  =head1 SUPPORT
   
 Copyright (C) 2005 by Andrew Fresh  You can find documentation for this module with the perldoc command.
   
 This library is free software; you can redistribute it and/or modify      perldoc Net::Telnet::Trango
 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.  
   
   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  =cut
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.35
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>