[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.4 and 1.26

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