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

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