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

version 1.2, 2005/12/30 01:02:41 version 1.26, 2007/01/17 23:15:13
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver$  # $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 ({    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 an array of the lines that were returned from the
 This is usually only set internally  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<Host>
 #  set mir [on|off]  
 #  set mir threshold <kbps>  - returns the name of the host that you are accessing
 #  set rssitarget [<ism|unii> <dBm>]  
 #  set serviceradius [<ism | unii> <miles>]  =item B<firmware_version>
 #  ssrssi <ch #> <h|v>  
 #  su [<suid>|all]  - returns the firmware version
 #  su changechannel <all|suid> <ch#> <h|v>  
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  Returns the firmware version if available, otherwise undef.
 #  su [live|poweroff|priority]  
 #  su <ping|info|status> <suid>  It should be available after a successful open().
 #  su powerleveling <all|suid>  
 #  su reboot <all|suid>  =item B<host_type>
 #  su restart <all|suid>  
 #  su testrflink <all|suid> [r]  - return the type of host you are connected to.
 #  su testrflink <setlen> [64..1600]  
 #  su testrflink <aptx> [20..100]  returns the type of host from the login banner for example M5830S or M5300S.
 #  su sw <suid|all> <sw #> <on|off>  
 #  sudb [dload | view]  Should be available after a successful open().
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  =item B<is_connected>
 #  sudb delete <all|<suid>>  
 #  sudb modify <suid> <cir|mir> <kbps>  - Status of the connection to host.
 #  sudb modify <suid> <su2su> <group id,hex>  
 #  sudb view  returns 1 when connected, undef otherwise.
 #  sulog [lastmins | sampleperiod <1..60>]  
 #  sulog [<# of entry,1..18>]  =item B<logged_in>
 #  survey <ism|unii> <time, sec> <h|v>  
 #  sw [<sw #> <on|off>]  - Status of being logged in to the host.
 #  temp  
 #  tftpd [on|off]  returns 1 after a successful login(), 0 if it failed and undef if
 #  time  login() was never called.
 #  time <hour> <min> <sec>  
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  =item B<login_banner>
 #  save <systemsetting|sudb>  
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  - The banner when first connecting to the host.
 #  updateflash <systemsetting|sudb>  
   returns the banner that is displayed when first connected at login.
   Only set after a successful open().
 my $success = 'Success.';  
 my %COMMANDS = (  =item B<last_lines>
   tftpd       => { decode => 1, expect => $success },  
   ver         => { decode => 1 },  - The last lines of output from the last cmd().
   sysinfo     => { decode => 1, expect => $success },  
   updateflash => { decode => 1, expect => $success },  returns, as an array ref, the output from the last cmd() that was run.
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  =item B<last_error>
 );  
   - A text output of the last error that was encountered.
 my %ALIASES = (  
   bye     => 'exit',  returns the last error reported.  Probably contains the last entry in
   restart => 'reboot',  last_lines.
 );  
   =back
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  =head2 ALIASES
   host_type  
   Host  =over
   is_connected  
   logged_in  =item B<bye>
   login_banner  
   Timeout  - alias of L<exit()>.
   last_lines  
 );  =item B<restart>
   
 sub AUTOLOAD  - alias of L<reboot()>.
 {  
   my $self = shift;  =back
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  =head2 COMMANDS
     or die "Weird: $AUTOLOAD";  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   if (exists $ALIASES{$method}) {  as such they accept the same options as C<cmd()>.
     $method = $ALIASES{$method};  Specifically they take a named paramater "args", for example:
     return $self->$method(@_);  C<tftpd(args =E<gt> 'on')> would enable tftpd
   }  
   =over
   if (exists $COMMANDS{$method}) {  
     $COMMANDS{$method}{'String'} ||= $method;  =item B<tftpd>
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  - Returns a hash ref of the decoded output from the
   command.
   if (exists $ACCESS{$method}) {  
     my $prev = $PRIVATE{$method};  Also see enable_tftpd() and disable_tftpd() as those check that it was
     ($PRIVATE{$method}) = @_ if @_;  successfully changed.
     return $prev;  
   }  =item B<ver>
   
   $method = "SUPER::$method";  - Returns a hash ref of the decoded output from the
   return $self->$method(@_);  command.
 }  
   =item B<sysinfo>
 =pod  
   - Returns a hash ref of the decoded output from the
 =item new  command.
   
 =cut  =item B<exit>
   
 sub new  - exits the command session with the Trango and closes
 {  the connection
   my $class = shift;  
   my $args = shift || {};  =item B<reboot>
   
   $args->{'Timeout'} ||= 5;  - reboots the Trango and closes the connection
   $args->{'Prompt'}  ||= '/#> *$/';  
   =item B<remarks>
   foreach my $key (keys %{ $args }) {  
     $PRIVATE{$key} = $args->{$key};  - Set or retrieve the remarks.
   }  
   Takes an optional argument, which sets the remarks.
   my $self = $class->SUPER::new(%{ $args });  If there is no argument, returns the current remarks.
   bless $self if ref $self;  
     my $old_remarks = $t->remarks();
   return $self;    $t->remarks($new_remarks);
 }  
   =item B<sulog>
 =pod  
   - returns an array ref of hashes containing each log
 =item open  line.
   
 =cut  =item B<save_sudb>
   
 sub open  - returns true on success, undef on failure
 {  
   my $self = shift;  =item B<syslog>
   
   unless ( $self->SUPER::open(  - returns the output from the syslog command
       #Host => $self->Host,  
       #Errmode => 'return',  =item B<pipe>
   ) ) {  
     #$! = "Couldn't connect to " . $self->Host . ":  $!";  - returns the output from the pipe command
     return undef;  
   }  =item B<maclist>
   #$self->dump_log('dump.log');  
   -  returns the output from the maclist command
   ## Login to remote host.  
   unless ($self->waitfor(  =item B<maclist_reset>
     -match => '/password: ?$/i',  
     -errmode => "return",  - resets the maclist.
   ) ) {  
   #$! = "problem connecting to host (" . $self->Host . "): " .  No useful output.
   #    $self->lastline;  
     return undef;  =item B<eth_list>
   }  
   - returns the output from the eth list command
   $self->parse_login_banner($self->lastline);  
   =item B<su_info>
   $self->is_connected(1);  
   - returns information about the SU.
   return $self->is_connected;  
 }  You need to pass in the $suid and it will return the info for that suid.
   
 =pod    $t->su_info($suid);
   
 =item login  =item B<save_ss>
   
 =cut  - saves the config.
   
 sub login  Returns 1 on success, undef on failure.
 {  
   my $self = shift;  =cut
   
   unless ($self->is_connected) {  
     $self->open or return undef;  my $success = 'Success.';
   }  my %COMMANDS = (
     tftpd       => { decode => 'all',   expect => $success },
   my $password = shift;    ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
   $self->print($password);    updateflash => { decode => 'all',   expect => $success },
   unless ($self->waitfor(    sulog       => { decode => 'sulog', expect => $success },
     -match => $self->prompt,    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
     -errmode => "return",    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
   ) ) {    remarks     => { decode => 'all', expect => $success },
     #$! = "login ($self->Host) failed: " . $self->lastline;    save_sudb   => { String => 'save sudb', expect => $success },
     return undef;    syslog      => { expect => $success },
   }    'pipe'      => { }, # XXX needs a special decode
     maclist     => { decode => 'maclist' },
   $self->logged_in(1);    maclist_reset => { String => 'maclist reset', expect => 'done' },
     eth_link    => { String => 'eth link', expect => $success },
   return $self->logged_in;    su_info     => { String => 'su info', decode => 'all', expect => $success },
 }    save_ss     => { String => 'save ss', expect => $success },
     opmode      => { decode => 'all',   expect => $success },
 =pod    # eth r, w and reset???
     #su password???
 =item parse_login_banner    #_bootloader
     #temp
 =cut    #heater
   );
 sub parse_login_banner  
 {  my %ALIASES = (
   my $self = shift;    bye     => 'exit',
     restart => 'reboot',
   if (@_) {  );
     $self->login_banner(@_);  
   }  my %ACCESS = map { $_ => 1 } qw(
     firmware_version
   my $banner = $self->login_banner;    host_type
     Host
   my ($type, $ver) = $banner =~    is_connected
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;    logged_in
     login_banner
   $self->login_banner($banner);    Timeout
   $self->host_type($type);    last_lines
   $self->firmware_version($ver);    last_vals
     last_error
   return 1;  );
 }  
   sub AUTOLOAD
 =pod  {
     my $self = shift;
 =item enable_tftpd  
     my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
 =cut      or die "Weird: $AUTOLOAD";
   
 sub enable_tftpd    if (exists $ALIASES{$method}) {
 {      $method = $ALIASES{$method};
   my $self = shift;      return $self->$method(@_);
     }
   my $vals = $self->tftpd( args => 'on' );  
     if (exists $COMMANDS{$method}) {
   if ($vals->{'Tftpd'} eq 'listen') {      $COMMANDS{$method}{'String'} ||= $method;
     return $vals;      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
   } else {      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     return undef;    }
   }  
 }    if (exists $ACCESS{$method}) {
       my $prev = $PRIVATE{$method};
 =pod      ($PRIVATE{$method}) = @_ if @_;
       return $prev;
 =item disable_tftpd    }
   
 =cut    $method = "SUPER::$method";
     return $self->$method(@_);
 sub disable_tftpd  }
 {  
   my $self = shift;  =pod
   
   my $vals = $self->tftpd( args => 'off' );  =item B<open>
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  - Open a connection to a Trango AP.
     return $vals;  
   } else {  Calls Net::Telnet::open() then makes sure you get a password prompt so
     return undef;  you are ready to login() and parses the login banner so you can get
   }  host_type() and firmware_version()
 }  
   =cut
 =pod  
   sub open
 =item cmd  {
     my $self = shift;
 =cut  
     unless ( $self->SUPER::open(@_) ) {
 sub cmd      $self->last_error("Couldn't connect to " . $self->Host . ":  $!");
 {      return undef;
   my $self = shift;    }
   
   my @valid_net_telnet_opts = qw(    ## Get to login prompt
     String    unless ($self->waitfor(
     Output        -match => '/password: ?$/i',
     Cmd_remove_mode        -errmode => "return",
     Errmode      ) ) {
     Input_record_separator      $self->last_error("problem connecting to host (" . $self->Host . "): " .
     Ors          $self->lastline);
     Output_record_separator      return undef;
     Prompt    }
     Rs  
     Timeout    $self->parse_login_banner($self->lastline);
   );  
     $self->is_connected(1);
   my %cfg;  
   if (@_ == 2) {    return $self->is_connected;
     $cfg{'String'} = shift;  }
   } elsif (@_ > 2) {  
     %cfg = @_;  =pod
   }  
   =item B<login>
   $cfg{'Timeout'} ||= $self->Timeout;  
   - Login to the AP.
   unless ($cfg{'String'}) {  
     #$! = "No command passed";  Calls open() if not already connected, then sends the password and sets
     warn "No command passed\n";  logged_in() if successful
     return undef;  
   }  =cut
   
   unless ($self->is_connected) {  sub login
     #$! = "Not connected";  {
     warn "Not connected\n";    my $self = shift;
     return undef;  
   }    unless ($self->is_connected) {
       $self->open or return undef;
   unless ($self->logged_in) {    }
     #$! = "Not logged in";  
     warn "Not logged in\n";    my $password = shift;
     return undef;  
   }    $self->print($password);
     unless ($self->waitfor(
       -match => $self->prompt,
   my %cmd;      -errmode => "return",
   foreach (@valid_net_telnet_opts) {    ) ) {
     if (exists $cfg{$_}) {      $self->last_error("login ($self->Host) failed: " . $self->lastline);
       $cmd{$_} = $cfg{$_};      return undef;
     }    }
   }  
   if ($cfg{'args'}) {    $self->logged_in(1);
     $cmd{'String'} .= ' ' . $cfg{'args'};  
   }    return $self->logged_in;
   my @lines = $self->SUPER::cmd(%cmd);  }
   
   $self->last_lines(\@lines);  =pod
   
   my $vals = 1;  =item B<parse_login_banner>
   if ($cfg{'decode'}) {  
     $vals = _decode_lines(@lines);  - Converts the login_banner to some useful
   }  variables.
   
   Takes a login banner (what you get when you first connect to the Trango)
   my $last = $self->lastline;  or reads what is already in login_banner() then parses it and sets
   host_type() and firmware_version() as well as login_banner()
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  
     if ($cfg{'cmd_disconnects'}) {  =cut
       $self->logged_in(0);  
       $self->close;  sub parse_login_banner
       $self->is_connected(0);  {
     }    my $self = shift;
   
     if ($cfg{'decode'}) {    if (@_) {
       return $vals;      $self->login_banner(@_);
     } else {    }
       return @lines;  
     }    my $banner = $self->login_banner;
   } else {  
     #$! = "Error with command ($cfg{'string'}): $last";    my ($type, $ver) = $banner =~
     return undef;      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   }  
 }    $self->login_banner($banner);
     $self->host_type($type);
 #=item _decode_lines    $self->firmware_version($ver);
   
 sub _decode_lines    return 1;
 {  }
   my @lines = @_;  
   =pod
   my %conf;  
   =item B<su_password>
   my $key = '';  
   my $val = '';  - Set the password on SUs connected to the AP.
   my $in_key = 0;  
   my $in_val = 0;  su_password('new_password'[, 'suid']) If no suid is specified,
   the default is "all".
   foreach my $line (@lines) {  
     my @chars = split //, $line;    $t->su_password('good_pass', 5);
   
     my $last_key = '';  =cut
     foreach my $c (@chars) {  
   sub su_password
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  {
         if ($c eq '[') {    my $self     = shift;
           $in_key = 1;    my $new_pass = shift || '';
           $in_val = 0;    my $su       = shift || 'all';
         } else {  
           $in_key = 0;    unless (defined $new_pass) {
           $in_val = 0;      $self->last_error("No new password");
         }      #return undef;
     }
         if ($key) {  
           $key =~ s/^\s+//;    return $self->cmd(String => 'su password ' .
           $key =~ s/\s+$//;                       $su . ' ' .
                        $new_pass . ' ' .
           $val =~ s/^\s+//;                       $new_pass,
           $val =~ s/\s+$//;                       expect => $success,
                       );
           if ($key eq 'Checksum' && $last_key) {  }
             # Special case for these bastids.  
             my $new = $last_key;  =pod
             $new =~ s/\s+\S+$//;  
             $key = $new . " " . $key;  =item B<su_ipconfig>
           }  
   - Change IP configuration on SUs connected to
           $last_key = $key;  the AP.
           $conf{$key} = $val;  
           $key = '';  su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
           $val = '';  
         }    $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
   
       } elsif ($c eq ']') {  =cut
         $in_val = 1;  
         $in_key = 0;  sub su_ipconfig
         $c = shift @chars;  {
           my $self        = shift;
       } elsif ($in_key) {  
         $key .= $c;          my $suid        = shift;
           my $new_ip      = shift;
       } elsif ($in_val) {          my $new_subnet  = shift;
         $val .= $c;          my $new_gateway = shift;
       }  
     }          if ($suid =~ /\D/) {
   }                  $self->last_error("Invalid suid '$suid'");
                   return undef;
   if (%conf) {          }
     return \%conf;          unless ($new_ip) {
   } else {                  $self->last_error("no new_ip passed");
     return \@lines;                  return undef;
   }          }
 }          unless ($new_subnet) {
                   $self->last_error("no new_subnet passed");
 1;                  return undef;
 __END__          }
           unless ($new_gateway) {
 =back                  $self->last_error("no new_gateway passed");
                   return undef;
 =head1 SEE ALSO          }
   
 If you have a web site set up for your module, mention it here.          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm                       $suid       . ' ' .
                        $new_ip     . ' ' .
 L<Net::Telnet>                       $new_subnet . ' ' .
                        $new_gateway,
 =head1 TODO                       expect => $success,
                       );
 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.  =pod
   
 =head1 AUTHOR  =item B<sudb_view>
   
 Andrew Fresh E<lt>andrew@rraz.netE<gt>  - Returns the output from the sudb view command
   
 =head1 COPYRIGHT AND LICENSE  returns a reference to an array of hashes each containing these keys
   'suid', 'type', 'cir', 'mir' and 'mac'
 Copyright (C) 2005 by Andrew Fresh  
   =cut
 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,  sub sudb_view
 at your option, any later version of Perl 5 you may have available.  {
     my $self = shift;
   
 =cut    my @lines = $self->cmd( String => 'sudb view', expect => $success );
   
     return undef 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 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.2  
changed lines
  Added in v.1.26
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>