[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.5 and 1.25

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