[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.3 and 1.36

version 1.3, 2005/12/30 19:26:06 version 1.36, 2007/02/05 21:09:26
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.2 2005/12/30 01:02:41 andrew Exp $  
   # $RedRiver: Trango.pm,v 1.35 2007/02/05 21:03:40 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 );
     
   my ($type, $version) = $t->open( Host => $fox );  
     
   unless (defined $type && defined $version) {  
     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 32 
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
   
 =head1 METHODS  =head2 B<new>
   - Creates a new Net::Telnet::Trango object.
   
 =head2 ACCESSORS      new([Options from Net::Telnet,]
           [Decode => 0,]);
   
 =over  Same as new from L<Net::Telnet> but sets the default Trango Prompt:
   '/#> *$/'
   
 =item Host  It also takes an optional parameter 'Decode'.  If not defined it
   defaults to 1, if it is set to 0, it will not decode the output and
   instead return a reference to an array of the lines that were returned
   from the command.
   
 returns the name of the host that you are accessing  =cut
   
 =item firmware_version  sub new {
       my $class = shift;
   
 returns the firmware version on the trango if available otherwise undef.        my %args;
 Available after a successful open()      if ( @_ == 1 ) {
 This is usually only set internally          $args{'Host'} = shift;
       }
       else {
           %args = @_;
       }
   
 =item host_type      $args{'Prompt'} ||= '/#> *$/';
   
 returns the type of host from the login banner for example M5830S or M5300S.        foreach my $key ( keys %args ) {
 Available after a successful open()          $PRIVATE{$key} = $args{$key};
 This is usually only set internally      }
       $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
       delete $args{'Decode'};
   
 =item is_connected      my $self = $class->SUPER::new(%args);
       bless $self if ref $self;
   
 returns 1 after a successful open() otherwise undef      return $self;
 This is usually only set internally  }
   
 =item logged_in  
   
 returns 1 after a successful login() 0 if it failed and undef if  
 login() was never called  
 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()  
   
 This is usually only set internally  
   
 =item last_lines  
   
 returns the output from the last cmd() that was run as an array ref  
 This is usually only set internally  
   
 =back  
   
 =head2 ALIASES  
   
 =over  
   
 =item bye  
   
 alias of exit()  
   
 =item restart  
   
 alias of reboot()  
   
 =back  
   
 =head2 COMMANDS  
   
 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  
   
 =over  
   
 =item tftpd  
   
 Returns a hash ref of the decoded output from the command.  
   
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  
   
 =item ver  
   
 Returns a hash ref of the decoded output from the command.  
   
 =item sysinfo  
   
 Returns a hash ref of the decoded output from the command.  
   
 =item exit  
   
 exits the command session with the trango and closes the connection  
   
 =item reboot  
   
 reboots the trango and closes the connection  
   
 =cut  
   
 #  _password <new password> <new password>  #  _password <new password> <new password>
 #  ? [command]  #  ? [command]
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
Line 214 
Line 167 
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 #  updateflash <systemsetting|sudb>  #  updateflash <systemsetting|sudb>
   
   =pod
   
 my $success = 'Success.';  =head1 ACCESSORS
   
   These are usually only set internally.
   
   =head2 B<firmware_version>
   - returns the firmware version
   
   Returns the firmware version if available, otherwise undef.
   
   It should be available after a successful open().
   
   =head2 B<host_type>
   - return the type of host you are connected to.
   
   returns the type of host from the login banner for example M5830S or M5300S.  
   
   Should be available after a successful open().
   
   =head2 B<is_connected>
   - Status of the connection to host.
   
   returns 1 when connected, undef otherwise.
   
   =head2 B<logged_in>
   - Status of being logged in to the host.
   
   returns 1 after a successful login(), 0 if it failed and undef if
   login() was never called.
   
   =head2 B<login_banner>
   - The banner when first connecting to the host.
   
   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().
   
   returns, as an array ref, the output from the last cmd() that was run.
   
   =head2 B<last_error>
   - A text output of the last error that was encountered.
   
   returns the last error reported.  Probably contains the last entry in
   last_lines.
   
   =head1 ALIASES
   
   =head2 B<bye>
   - alias of exit()
   
   Does the same as exit()
   
   =head2 B<restart>
   - alias of reboot()
   
   Does the same as reboot()
   
   =head1 COMMANDS
   
   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
   
   =head2 B<tftpd>
   - The output from the tftpd command
   
   Returns a hash ref of the decoded output from the
   command.
   
   Also see enable_tftpd() and disable_tftpd() as those check that it was
   successfully changed.
   
   =head2 B<ver>
   - The output from the ver command
   
   Returns a hash ref of the decoded output from the
   command.
   
   =head2 B<sysinfo>
   - The output from the sysinfo command
   
   Returns a hash ref of the decoded output from the
   command.
   
   =head2 B<exit>
   - Exits the connection
   
   exits the command session with the Trango and closes
   the connection
   
   =head2 B<reboot>
   - Sends a reboot command
   
   reboots the Trango and closes the connection
   
   =head2 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);
   
   =head2 B<sulog>
   - The output from the sulog command
   
   Returns an array ref of hashes containing each log
   line.
   
   =head2 B<save_sudb>
   - saves the sudb
   
   Returns true on success, undef on failure
   
   =head2 B<syslog>
   - The output from the sulog command
   
   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_list>
   - eth list command
   
   Returns the output from the eth list command
   
   
   =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.
   
   =cut
   
   my $success  = 'Success\\.';
 my %COMMANDS = (  my %COMMANDS = (
   tftpd       => { decode => 1, expect => $success },      tftpd       => { decode    => 'all',       expect          => $success },
   ver         => { decode => 1 },      ver         => { decode    => 'all' },
   sysinfo     => { decode => 1, expect => $success },      sysinfo     => { decode    => 'all',       expect          => $success },
   updateflash => { decode => 1, expect => $success },      updateflash => { decode    => 'all',       expect          => $success },
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },      sulog       => { decode    => 'sulog',     expect          => $success },
   reboot      => { Prompt => '//', cmd_disconnects => 1 },      'exit'      => { no_prompt => 1,           cmd_disconnects => 1 },
   #su password???      reboot      => { no_prompt => 1,           cmd_disconnects => 1 },
   #_bootloader      remarks     => { decode    => 'all',       expect          => $success },
   #temp      save_sudb   => { String    => 'save sudb', expect          => $success },
   #heater      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 = (  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_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(@_);
       }
   
       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(@_);      return $self->$method(@_);
   }  }
   
   if (exists $COMMANDS{$method}) {  =pod
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  
   
   if (exists $ACCESS{$method}) {  =head2 B<open>
     my $prev = $PRIVATE{$method};  - Open a connection to a Trango AP.
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;  
   }  
   
   $method = "SUPER::$method";  Calls Net::Telnet::open() then makes sure you get a password prompt so
   return $self->$method(@_);  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  =pod
   
 =item new  =head2 B<login>
   - Login to the AP.
   
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  Calls open() if not already connected, then sends the password and sets
   logged_in() if successful
   
 =cut  =cut
   
 sub new  sub login {
 {      my $self = shift;
   my $class = shift;  
   
   my %args;      unless ( $self->is_connected ) {
   if (@_ == 1) {          $self->open or return;
     $args{'Host'} = shift;      }
   } else {  
     %args = @_;  
   }  
   
   $args{'Prompt'}  ||= '/#> *$/';      my $password = shift;
   
   foreach my $key (keys %args) {      $self->print($password);
     $PRIVATE{$key} = $args{$key};      unless (
   }          $self->waitfor(
               -match   => $self->prompt,
               -errmode => "return",
           )
         )
       {
           $self->last_error( "login ($self->host) failed: " . $self->lastline );
           return;
       }
   
   my $self = $class->SUPER::new(%args);      $self->logged_in(1);
   bless $self if ref $self;  
   
   return $self;      return $self->logged_in;
 }  }
   
 =pod  =pod
   
 =item open  =head2 B<parse_login_banner>
   - Converts the login_banner to some useful
   variables.
   
 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()  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 open  sub parse_login_banner {
 {      my $self = shift;
   my $self = shift;  
   
   unless ( $self->SUPER::open(@_) ) {      if (@_) {
     #$! = "Couldn't connect to " . $self->Host . ":  $!";          $self->login_banner(@_);
     return undef;      }
   }  
   
   ## Get to login prompt      my $banner = $self->login_banner;
   unless ($self->waitfor(  
       -match => '/password: ?$/i',  
       -errmode => "return",  
     ) ) {  
     #$! = "problem connecting to host (" . $self->Host . "): " .  
     #    $self->lastline;  
     return undef;  
   }  
   
   $self->parse_login_banner($self->lastline);      my ( $type, $sep1, $subtype, $sep2, $ver ) =
         $banner =~
         /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   
   $self->is_connected(1);      $type .= $sep1 . $subtype;
       $ver = $subtype . $sep2 . $ver;
   
   return $self->is_connected;      $self->login_banner($banner);
       $self->host_type($type);
       $self->firmware_version($ver);
   
       return 1;
 }  }
   
 =pod  =pod
   
 =item login  =head2 B<su_password>
   - Set the password on SUs connected to the AP.
   
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  su_password('new_password'[, 'suid']) If no suid is specified,
   the default is "all".
   
     $t->su_password('good_pass', 5);
   
 =cut  =cut
   
 sub login  sub su_password {
 {      my $self     = shift;
   my $self = shift;      my $new_pass = shift || '';
       my $su       = shift || 'all';
   
   unless ($self->is_connected) {      unless ( defined $new_pass ) {
     $self->open or return undef;          $self->last_error("No new password");
   }  
   
   my $password = shift;          #return;
       }
   
   $self->print($password);      return $self->cmd(
   unless ($self->waitfor(          String => 'su password ' . $su . ' ' . $new_pass . ' ' . $new_pass,
     -match => $self->prompt,          expect => $success,
     -errmode => "return",      );
   ) ) {  }
     #$! = "login ($self->Host) failed: " . $self->lastline;  
     return undef;  
   }  
   
   $self->logged_in(1);  =pod
   
   return $self->logged_in;  =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 . ' ' . $new_ip . ' '
             . $new_subnet . ' '
             . $new_gateway,
           expect => $success,
       );
 }  }
   
 =pod  =pod
   
 =item parse_login_banner  =head2 B<sudb_view>
   - Returns the output from the sudb view command
   
 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()  returns a reference to an array of hashes each containing these keys
   'suid', 'type', 'cir', 'mir' and 'mac'
   
 =cut  =cut
   
 sub parse_login_banner  sub sudb_view {
 {      my $self = shift;
   my $self = shift;  
   
   if (@_) {      my $lines = $self->cmd( String => 'sudb view', expect => $success ) || [];
     $self->login_banner(@_);  
   }  
   
   my $banner = $self->login_banner;      return unless @{$lines};
   
   my ($type, $ver) = $banner =~      unless ( $PRIVATE{'Decode'} ) {
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;          return $lines;
       }
   
   $self->login_banner($banner);      my @sus;
   $self->host_type($type);      foreach ( @{$lines} ) {
   $self->firmware_version($ver);          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,
               );
   
   return 1;              $s{'mac'} =~ s/\s//g;
               $s{'mac'} = uc( $s{'mac'} );
   
               push @sus, \%s;
           }
       }
   
       return \@sus;
 }  }
   
 =pod  =pod
   
 =item enable_tftpd  =head2 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
   
   =head2 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
   
   =head2 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
   
   =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 (@_ == 2) {      if ( @_ == 1 ) {
     $cfg{'String'} = shift;          $cfg{'String'} = shift;
   } elsif (@_ > 2) {      }
     %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 = $self->SUPER::cmd(%cmd);  
   
   $self->last_lines(\@lines);      $self->last_lines( \@lines );
   
   my $vals = 1;      my $vals = 1;
   if ($cfg{'decode'}) {      if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
     $vals = _decode_lines(@lines);          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;      my $last = $self->lastline;
   
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {      if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) {
     if ($cfg{'cmd_disconnects'}) {          if ( $cfg{'cmd_disconnects'} ) {
       $self->logged_in(0);              $self->logged_in(0);
       $self->close;              $self->close;
       $self->is_connected(0);              $self->is_connected(0);
     }          }
   
     if ($cfg{'decode'}) {          if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
       return $vals;              return $vals;
     } else {          }
       return @lines;          else {
               return \@lines;
           }
     }      }
   } else {      else {
     #$! = "Error with command ($cfg{'string'}): $last";          $self->last_error("Error with command ($cfg{'String'}): $last");
     return undef;          return;
   }      }
 }  }
   
 #=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) {
     my @chars = split //, $line;          next if $line =~ /$success$/;
   
     my $last_key = '';          my @chars = split //, $line;
     foreach my $c (@chars) {  
   
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {          my $last_key = '';
         if ($c eq '[') {          foreach my $c (@chars) {
           $in_key = 1;  
           $in_val = 0;              if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) {
         } else {                  if ( $c eq '[' ) {
           $in_key = 0;                      $in_key = 1;
           $in_val = 0;                      $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;
               }
         }          }
       }
   
         if ($key) {      unless ($key) {
           $key =~ s/^\s+//;          push @vals, $val;
           $key =~ s/\s+$//;      }
   
           $val =~ s/^\s+//;      if ( @vals == 1 ) {
           $val =~ s/\s+$//;          $val = $vals[0];
       }
       elsif (@vals) {
           $val = \@vals;
       }
       else {
           $val = undef;
       }
   
           if ($key eq 'Checksum' && $last_key) {      if (%conf) {
             # Special case for these bastids.          $conf{_pre} = $val if $val;
             my $new = $last_key;          return \%conf;
             $new =~ s/\s+\S+$//;      }
             $key = $new . " " . $key;      else {
           }          return $val;
       }
   }
   
           $last_key = $key;  #=item _decode_each_line
           $conf{$key} = $val;  
           $key = '';  sub _decode_each_line {
           $val = '';      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;
   }
   
       } elsif ($c eq ']') {  #=item _decode_maclist
         $in_val = 1;  
         $in_key = 0;  
         $c = shift @chars;  
   
       } elsif ($in_key) {  sub _decode_maclist {
         $key .= $c;      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;
   
       } elsif ($in_val) {          if ($mac) {
         $val .= $c;              $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;
           }
     }      }
   }  
   
   if (%conf) {      map { $_->{'cur_tm'} = $current_tm } @decoded;
     return \%conf;  
   } else {      if ( scalar @decoded == $total_entries ) {
     return \@lines;          return \@decoded;
   }      }
       else {
   
           # XXX we should have a way to set last error, not sure why we don't
           return;
       }
 }  }
   
 1;  1;    # End of Net::Telnet::Trango
 __END__  __END__
   
 =back  
   
 =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.3  
changed lines
  Added in v.1.36
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>