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

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