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

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