[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.2 and 1.30

version 1.2, 2005/12/30 01:02:41 version 1.30, 2007/02/02 17:51:52
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver$  # $RedRiver: Trango.pm,v 1.29 2007/02/01 17:58:33 andrew Exp $
 use strict;  use strict;
 use warnings;  use warnings;
 use base 'Net::Telnet';  use base 'Net::Telnet';
   
 =pod  =pod
   
 =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;  
   my $t = new Net::Telnet::Trango ({    use Net::Telnet::Trango;
     Host    => $fox,    my $t = new Net::Telnet::Trango ( Timeout => 5 );
     Timeout => 5,  
   });    $t->open( Host => $fox ) or die "Error connecting: $!";
     
   my ($type, $version) = $t->open;    $t->login('password') or die "Couldn't log in: $!";
     
   unless (defined $type && defined $version) {    # Do whatever
     die "Error connecting: $!";  
   }    $t->exit;
     $t->close;
   $t->login('password') or die "Couldn't log in: $!";  
     =head1 DESCRIPTION
   # Do whatever  
     Perl access to the telnet interface on Trango Foxes, SUs and APs.
   $t->exit;  
   $t->close;  Another handy feature is that it will parse the output from certain
   commands that is in the format "[key1] value1 [key2] value2" and put
 =head1 DESCRIPTION  those in a hashref that is returned.  This makes using the output from
   things like sysinfo very easy to do.
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  
   =head2 EXPORT
 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.  
   None
 =head2 EXPORT  
   =head1 METHODS
 None  
   =over
 =cut  
   =cut
 our $VERSION = '0.01';  
   our $VERSION = '0.01';
 my %PRIVATE = (  
   is_connected => 0,  my %PRIVATE = (
   logged_in => 0,    is_connected => 0,
 );    logged_in => 0,
   );
 =pod  
   =pod
 =head1 METHODS  
   =item B<new>
 =head2 ACCESSORS  
   - Creates a new Net::Telnet::Trango object.
 =over  
           new([Options from Net::Telnet,]
 =item Host              [Decode => 0,]);
   
 returns the name of the host that you are accessing  Same as new from L<Net::Telnet> but sets the default Trango Prompt:
   '/#> *$/'
 =item firmware_version  
   It also takes an optional parameter 'Decode'.  If not defined it
 returns the firmware version on the trango if available otherwise undef.    defaults to 1, if it is set to 0, it will not decode the output and
 Available after a successful open()  instead return a reference to an array of the lines that were returned
 This is usually only set internally  from the command.
   
 =item host_type  =cut
   
 returns the type of host from the login banner for example M5830S or M5300S.    sub new
 Available after a successful open()  {
 This is usually only set internally    my $class = shift;
   
 =item is_connected    my %args;
     if (@_ == 1) {
 returns 1 after a successful open() otherwise undef      $args{'Host'} = shift;
 This is usually only set internally    } else {
       %args = @_;
 =item logged_in    }
   
 returns 1 after a successful login() 0 if it failed and undef if    $args{'Prompt'}  ||= '/#> *$/';
 login() was never called  
 This is usually only set internally    foreach my $key (keys %args) {
       $PRIVATE{$key} = $args{$key};
 =item login_banner    }
     $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
 returns the banner that is displayed when first connected at login.  Only set after a successful open()    delete $args{'Decode'};
   
 This is usually only set internally    my $self = $class->SUPER::new(%args);
     bless $self if ref $self;
 =item last_lines  
     return $self;
 returns the output from the last cmd() that was run as an array ref  }
 This is usually only set internally  
   #  _password <new password> <new password>
 =back  #  ? [command]
   #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
 =head2 ALIASES  #  arp -bcast <on|off>
   #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
 =over  #  bye
   #  cf2cf ap [default|<size>]
 =item bye  #  date
   #  date <month> <day> <year>
 alias of exit()  #  freq scantable
   #  freq channeltable
 =item reboot  #  freq writescan [<ch#> <h|v>]
   #  freq writechannel [<ch#> <freq>] ...
 alias of restart()  #  freq <ch #> <h|v>
   #  help [command]
 =back  #  heater [<on temp> <off temp>]
   #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 =head2 COMMANDS  #  log [<# of entries, 1..179>]
   #  log <sum> <# of entries, 1..179>
 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:  #  logout
 C<tftpd(args =E<gt> 'on')> would enable tftpd  #  opmode [ap [y]]
   #  password
 =over  #  ping <ip addr>
   #  polar <h|v>
 =item tftpd  #  power <setism|setunii> <max|min|<dBm>>
   #  reboot
 Returns a hash ref of the decoded output from the command.  #  restart
   #  remarks [<str>]
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 =item ver  #  sysinfo
   #  set suid <id>
 Returns a hash ref of the decoded output from the command.  #  set apid <id>
   #  set baseid <id>
 =item sysinfo  #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
 Returns a hash ref of the decoded output from the command.  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   #  set mir [on|off]
 =item exit  #  set mir threshold <kbps>
   #  set rssitarget [<ism|unii> <dBm>]
 exits the command session with the trango and closes the connection  #  set serviceradius [<ism | unii> <miles>]
   #  ssrssi <ch #> <h|v>
 =item reboot  #  su [<suid>|all]
   #  su changechannel <all|suid> <ch#> <h|v>
 reboots the trango and closes the connection  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   #  su [live|poweroff|priority]
 =cut  #  su <ping|info|status> <suid>
   #  su powerleveling <all|suid>
 #  _password <new password> <new password>  #  su reboot <all|suid>
 #  ? [command]  #  su restart <all|suid>
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  #  su testrflink <all|suid> [r]
 #  arp -bcast <on|off>  #  su testrflink <setlen> [64..1600]
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...  #  su testrflink <aptx> [20..100]
 #  bye  #  su sw <suid|all> <sw #> <on|off>
 #  cf2cf ap [default|<size>]  #  sudb [dload | view]
 #  date  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
 #  date <month> <day> <year>  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 #  freq scantable  #  sudb delete <all|<suid>>
 #  freq channeltable  #  sudb modify <suid> <cir|mir> <kbps>
 #  freq writescan [<ch#> <h|v>]  #  sudb modify <suid> <su2su> <group id,hex>
 #  freq writechannel [<ch#> <freq>] ...  #  sudb view
 #  freq <ch #> <h|v>  #  sulog [lastmins | sampleperiod <1..60>]
 #  help [command]  #  sulog [<# of entry,1..18>]
 #  heater [<on temp> <off temp>]  #  survey <ism|unii> <time, sec> <h|v>
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  #  sw [<sw #> <on|off>]
 #  log [<# of entries, 1..179>]  #  temp
 #  log <sum> <# of entries, 1..179>  #  tftpd [on|off]
 #  logout  #  time
 #  opmode [ap [y]]  #  time <hour> <min> <sec>
 #  password  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 #  ping <ip addr>  #  save <systemsetting|sudb>
 #  polar <h|v>  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 #  power <setism|setunii> <max|min|<dBm>>  #  updateflash <systemsetting|sudb>
 #  reboot  
 #  restart  =pod
 #  remarks [<str>]  
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  =back
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  
 #  sysinfo  =head2 ACCESSORS
 #  set suid <id>  
 #  set apid <id>  These are usually only set internally.
 #  set baseid <id>  
 #  set defaultopmode [<ap|su> <min,0..10>]  =over
 #  set defaultopmode off  
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  =item B<firmware_version>
 #  set mir [on|off]  
 #  set mir threshold <kbps>  - returns the firmware version
 #  set rssitarget [<ism|unii> <dBm>]  
 #  set serviceradius [<ism | unii> <miles>]  Returns the firmware version if available, otherwise undef.
 #  ssrssi <ch #> <h|v>  
 #  su [<suid>|all]  It should be available after a successful open().
 #  su changechannel <all|suid> <ch#> <h|v>  
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  =item B<host_type>
 #  su [live|poweroff|priority]  
 #  su <ping|info|status> <suid>  - return the type of host you are connected to.
 #  su powerleveling <all|suid>  
 #  su reboot <all|suid>  returns the type of host from the login banner for example M5830S or M5300S.
 #  su restart <all|suid>  
 #  su testrflink <all|suid> [r]  Should be available after a successful open().
 #  su testrflink <setlen> [64..1600]  
 #  su testrflink <aptx> [20..100]  =item B<is_connected>
 #  su sw <suid|all> <sw #> <on|off>  
 #  sudb [dload | view]  - Status of the connection to host.
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  returns 1 when connected, undef otherwise.
 #  sudb delete <all|<suid>>  
 #  sudb modify <suid> <cir|mir> <kbps>  =item B<logged_in>
 #  sudb modify <suid> <su2su> <group id,hex>  
 #  sudb view  - Status of being logged in to the host.
 #  sulog [lastmins | sampleperiod <1..60>]  
 #  sulog [<# of entry,1..18>]  returns 1 after a successful login(), 0 if it failed and undef if
 #  survey <ism|unii> <time, sec> <h|v>  login() was never called.
 #  sw [<sw #> <on|off>]  
 #  temp  =item B<login_banner>
 #  tftpd [on|off]  
 #  time  - The banner when first connecting to the host.
 #  time <hour> <min> <sec>  
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  returns the banner that is displayed when first connected at login.
 #  save <systemsetting|sudb>  Only set after a successful open().
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  
 #  updateflash <systemsetting|sudb>  =item B<last_lines>
   
   - The last lines of output from the last cmd().
 my $success = 'Success.';  
 my %COMMANDS = (  returns, as an array ref, the output from the last cmd() that was run.
   tftpd       => { decode => 1, expect => $success },  
   ver         => { decode => 1 },  =item B<last_error>
   sysinfo     => { decode => 1, expect => $success },  
   updateflash => { decode => 1, expect => $success },  - A text output of the last error that was encountered.
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  returns the last error reported.  Probably contains the last entry in
 );  last_lines.
   
 my %ALIASES = (  =back
   bye     => 'exit',  
   restart => 'reboot',  =head2 ALIASES
 );  
   =over
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  =item B<bye>
   host_type  
   Host  - alias of L<exit()>.
   is_connected  
   logged_in  =item B<restart>
   login_banner  
   Timeout  - alias of L<reboot()>.
   last_lines  
 );  =back
   
 sub AUTOLOAD  =head2 COMMANDS
 {  
   my $self = shift;  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   as such they accept the same options as C<cmd()>.
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  Specifically they take a named paramater "args", for example:
     or die "Weird: $AUTOLOAD";  C<tftpd(args =E<gt> 'on')> would enable tftpd
   
   if (exists $ALIASES{$method}) {  =over
     $method = $ALIASES{$method};  
     return $self->$method(@_);  =item B<tftpd>
   }  
   - Returns a hash ref of the decoded output from the
   if (exists $COMMANDS{$method}) {  command.
     $COMMANDS{$method}{'String'} ||= $method;  
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  Also see enable_tftpd() and disable_tftpd() as those check that it was
   }  successfully changed.
   
   if (exists $ACCESS{$method}) {  =item B<ver>
     my $prev = $PRIVATE{$method};  
     ($PRIVATE{$method}) = @_ if @_;  - Returns a hash ref of the decoded output from the
     return $prev;  command.
   }  
   =item B<sysinfo>
   $method = "SUPER::$method";  
   return $self->$method(@_);  - Returns a hash ref of the decoded output from the
 }  command.
   
 =pod  =item B<exit>
   
 =item new  - exits the command session with the Trango and closes
   the connection
 =cut  
   =item B<reboot>
 sub new  
 {  - reboots the Trango and closes the connection
   my $class = shift;  
   my $args = shift || {};  =item B<remarks>
   
   $args->{'Timeout'} ||= 5;  - Set or retrieve the remarks.
   $args->{'Prompt'}  ||= '/#> *$/';  
   Takes an optional argument, which sets the remarks.
   foreach my $key (keys %{ $args }) {  If there is no argument, returns the current remarks.
     $PRIVATE{$key} = $args->{$key};  
   }    my $old_remarks = $t->remarks();
     $t->remarks($new_remarks);
   my $self = $class->SUPER::new(%{ $args });  
   bless $self if ref $self;  =item B<sulog>
   
   return $self;  - returns an array ref of hashes containing each log
 }  line.
   
 =pod  =item B<save_sudb>
   
 =item open  - returns true on success, undef on failure
   
 =cut  =item B<syslog>
   
 sub open  - returns the output from the syslog command
 {  
   my $self = shift;  =item B<pipe>
   
   unless ( $self->SUPER::open(  - returns the output from the pipe command
       #Host => $self->Host,  
       #Errmode => 'return',  =item B<maclist>
   ) ) {  
     #$! = "Couldn't connect to " . $self->Host . ":  $!";  -  returns the output from the maclist command
     return undef;  
   }  =item B<maclist_reset>
   #$self->dump_log('dump.log');  
   - resets the maclist.
   ## Login to remote host.  
   unless ($self->waitfor(  No useful output.
     -match => '/password: ?$/i',  
     -errmode => "return",  =item B<eth_list>
   ) ) {  
   #$! = "problem connecting to host (" . $self->Host . "): " .  - returns the output from the eth list command
   #    $self->lastline;  
     return undef;  =item B<su_info>
   }  
   - returns information about the SU.
   $self->parse_login_banner($self->lastline);  
   You need to pass in the $suid and it will return the info for that suid.
   $self->is_connected(1);  
     $t->su_info($suid);
   return $self->is_connected;  
 }  =item B<save_ss>
   
 =pod  - saves the config.
   
 =item login  Returns 1 on success, undef on failure.
   
 =cut  =cut
   
 sub login  
 {  my $success = 'Success\\.';
   my $self = shift;  my %COMMANDS = (
     tftpd       => { decode => 'all',   expect => $success },
   unless ($self->is_connected) {    ver         => { decode => 'all' },
     $self->open or return undef;    sysinfo     => { decode => 'all',   expect => $success },
   }    updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
   my $password = shift;    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
     reboot      => { no_prompt => 1, cmd_disconnects => 1 },
   $self->print($password);    remarks     => { decode => 'all', expect => $success },
   unless ($self->waitfor(    save_sudb   => { String => 'save sudb', expect => $success },
     -match => $self->prompt,    syslog      => { expect => $success },
     -errmode => "return",    'pipe'      => { }, # XXX needs a special decode
   ) ) {    maclist     => { decode => 'maclist' },
     #$! = "login ($self->Host) failed: " . $self->lastline;    maclist_reset => { String => 'maclist reset', expect => 'done' },
     return undef;    eth_link    => { String => 'eth link', expect => $success },
   }    su_info     => { String => 'su info', decode => 'all', expect => $success },
     save_ss     => { String => 'save ss', expect => $success },
   $self->logged_in(1);    opmode      => { decode => 'all',   expect => $success },
     # eth r, w and reset???
   return $self->logged_in;    #su password???
 }    #_bootloader
     #temp
 =pod    #heater
   );
 =item parse_login_banner  
   my %ALIASES = (
 =cut    bye     => 'exit',
     restart => 'reboot',
 sub parse_login_banner    Host    => 'host',
 {  );
   my $self = shift;  
   my %ACCESS = map { $_ => 1 } qw(
   if (@_) {    firmware_version
     $self->login_banner(@_);    host_type
   }    is_connected
     logged_in
   my $banner = $self->login_banner;    login_banner
     Timeout
   my ($type, $ver) = $banner =~    last_lines
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;    last_vals
     last_error
   $self->login_banner($banner);    Decode
   $self->host_type($type);  );
   $self->firmware_version($ver);  
   sub AUTOLOAD
   return 1;  {
 }    my $self = shift;
   
 =pod    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
       or die "Weird: $AUTOLOAD";
 =item enable_tftpd  
     if (exists $ALIASES{$method}) {
 =cut      $method = $ALIASES{$method};
       return $self->$method(@_);
 sub enable_tftpd    }
 {  
   my $self = shift;    if (exists $COMMANDS{$method}) {
       my %cmd;
   my $vals = $self->tftpd( args => 'on' );      foreach my $k (keys %{ $COMMANDS{$method} }) {
         $cmd{$k} = $COMMANDS{$method}{$k};
   if ($vals->{'Tftpd'} eq 'listen') {      }
     return $vals;      $cmd{'String'} ||= $method;
   } else {      $cmd{'args'}   .= ' ' . shift if (@_ == 1);
     return undef;      return $self->cmd(%cmd, @_);
   }    }
 }  
     if (exists $ACCESS{$method}) {
 =pod      my $prev = $PRIVATE{$method};
       ($PRIVATE{$method}) = @_ if @_;
 =item disable_tftpd      return $prev;
     }
 =cut  
     $method = "SUPER::$method";
 sub disable_tftpd    return $self->$method(@_);
 {  }
   my $self = shift;  
   =pod
   my $vals = $self->tftpd( args => 'off' );  
   =item B<open>
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  
     return $vals;  - Open a connection to a Trango AP.
   } else {  
     return undef;  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()
   
 =pod  =cut
   
 =item cmd  sub open
   {
 =cut    my $self = shift;
   
 sub cmd    unless ( $self->SUPER::open(@_) ) {
 {      $self->last_error("Couldn't connect to " . $self->host . ":  $!");
   my $self = shift;      return;
     }
   my @valid_net_telnet_opts = qw(  
     String    ## Get to login prompt
     Output    unless ($self->waitfor(
     Cmd_remove_mode        -match => '/password: ?$/i',
     Errmode        -errmode => "return",
     Input_record_separator      ) ) {
     Ors      $self->last_error("problem connecting to host (" . $self->host . "): " .
     Output_record_separator          $self->lastline);
     Prompt      return;
     Rs    }
     Timeout  
   );    $self->parse_login_banner($self->lastline);
   
   my %cfg;    $self->is_connected(1);
   if (@_ == 2) {  
     $cfg{'String'} = shift;    return $self->is_connected;
   } elsif (@_ > 2) {  }
     %cfg = @_;  
   }  =pod
   
   $cfg{'Timeout'} ||= $self->Timeout;  =item B<login>
   
   unless ($cfg{'String'}) {  - Login to the AP.
     #$! = "No command passed";  
     warn "No command passed\n";  Calls open() if not already connected, then sends the password and sets
     return undef;  logged_in() if successful
   }  
   =cut
   unless ($self->is_connected) {  
     #$! = "Not connected";  sub login
     warn "Not connected\n";  {
     return undef;    my $self = shift;
   }  
     unless ($self->is_connected) {
   unless ($self->logged_in) {      $self->open or return;
     #$! = "Not logged in";    }
     warn "Not logged in\n";  
     return undef;    my $password = shift;
   }  
     $self->print($password);
     unless ($self->waitfor(
   my %cmd;      -match => $self->prompt,
   foreach (@valid_net_telnet_opts) {      -errmode => "return",
     if (exists $cfg{$_}) {    ) ) {
       $cmd{$_} = $cfg{$_};      $self->last_error("login ($self->host) failed: " . $self->lastline);
     }      return;
   }    }
   if ($cfg{'args'}) {  
     $cmd{'String'} .= ' ' . $cfg{'args'};    $self->logged_in(1);
   }  
   my @lines = $self->SUPER::cmd(%cmd);    return $self->logged_in;
   }
   $self->last_lines(\@lines);  
   =pod
   my $vals = 1;  
   if ($cfg{'decode'}) {  =item B<parse_login_banner>
     $vals = _decode_lines(@lines);  
   }  - Converts the login_banner to some useful
   variables.
   
   my $last = $self->lastline;  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
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  host_type() and firmware_version() as well as login_banner()
     if ($cfg{'cmd_disconnects'}) {  
       $self->logged_in(0);  =cut
       $self->close;  
       $self->is_connected(0);  sub parse_login_banner
     }  {
     my $self = shift;
     if ($cfg{'decode'}) {  
       return $vals;    if (@_) {
     } else {      $self->login_banner(@_);
       return @lines;    }
     }  
   } else {    my $banner = $self->login_banner;
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;    my ($type, $sep1, $subtype, $sep2, $ver) = $banner =~
   }      /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
 }  
     $type .= $sep1 . $subtype;
 #=item _decode_lines    $ver = $subtype . $sep2 . $ver;
   
 sub _decode_lines    $self->login_banner($banner);
 {    $self->host_type($type);
   my @lines = @_;    $self->firmware_version($ver);
   
   my %conf;    return 1;
   }
   my $key = '';  
   my $val = '';  =pod
   my $in_key = 0;  
   my $in_val = 0;  =item B<su_password>
   
   foreach my $line (@lines) {  - Set the password on SUs connected to the AP.
     my @chars = split //, $line;  
   su_password('new_password'[, 'suid']) If no suid is specified,
     my $last_key = '';  the default is "all".
     foreach my $c (@chars) {  
     $t->su_password('good_pass', 5);
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  
         if ($c eq '[') {  =cut
           $in_key = 1;  
           $in_val = 0;  sub su_password
         } else {  {
           $in_key = 0;    my $self     = shift;
           $in_val = 0;    my $new_pass = shift || '';
         }    my $su       = shift || 'all';
   
         if ($key) {    unless (defined $new_pass) {
           $key =~ s/^\s+//;      $self->last_error("No new password");
           $key =~ s/\s+$//;      #return;
     }
           $val =~ s/^\s+//;  
           $val =~ s/\s+$//;    return $self->cmd(String => 'su password ' .
                        $su . ' ' .
           if ($key eq 'Checksum' && $last_key) {                       $new_pass . ' ' .
             # Special case for these bastids.                       $new_pass,
             my $new = $last_key;                       expect => $success,
             $new =~ s/\s+\S+$//;                      );
             $key = $new . " " . $key;  }
           }  
   =pod
           $last_key = $key;  
           $conf{$key} = $val;  =item B<su_ipconfig>
           $key = '';  
           $val = '';  - Change IP configuration on SUs connected to
         }  the AP.
   
       } elsif ($c eq ']') {  su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
         $in_val = 1;  
         $in_key = 0;    $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
         $c = shift @chars;  
   =cut
       } elsif ($in_key) {  
         $key .= $c;  sub su_ipconfig
   {
       } elsif ($in_val) {          my $self        = shift;
         $val .= $c;  
       }          my $suid        = shift;
     }          my $new_ip      = shift;
   }          my $new_subnet  = shift;
           my $new_gateway = shift;
   if (%conf) {  
     return \%conf;          if ($suid =~ /\D/) {
   } else {                  $self->last_error("Invalid suid '$suid'");
     return \@lines;                  return;
   }          }
 }          unless ($new_ip) {
                   $self->last_error("no new_ip passed");
 1;                  return;
 __END__          }
           unless ($new_subnet) {
 =back                  $self->last_error("no new_subnet passed");
                   return;
 =head1 SEE ALSO          }
           unless ($new_gateway) {
 If you have a web site set up for your module, mention it here.                  $self->last_error("no new_gateway passed");
                   return;
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm          }
   
 L<Net::Telnet>          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
 =head1 TODO                       $suid       . ' ' .
                        $new_ip     . ' ' .
 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.                       $new_subnet . ' ' .
                        $new_gateway,
 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.                       expect => $success,
                       );
 =head1 AUTHOR  }
   
 Andrew Fresh E<lt>andrew@rraz.netE<gt>  =pod
   
 =head1 COPYRIGHT AND LICENSE  =item B<sudb_view>
   
 Copyright (C) 2005 by Andrew Fresh  - Returns the output from the sudb view command
   
 This library is free software; you can redistribute it and/or modify  returns a reference to an array of hashes each containing these keys
 it under the same terms as Perl itself, either Perl version 5.8.7 or,  'suid', 'type', 'cir', 'mir' and 'mac'
 at your option, any later version of Perl 5 you may have available.  
   =cut
   
 =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.2  
changed lines
  Added in v.1.30
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>