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

version 1.2, 2005/12/30 01:02:41 version 1.15, 2006/09/07 03:59:03
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver$  # $RedRiver: Trango.pm,v 1.14 2006/09/07 02:49:34 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)>, as such they accept the same options as C<cmd()>.  Specifically they take a named paramater "args", for example:
   tftpd       => { decode => 1, expect => $success },  C<tftpd(args =E<gt> 'on')> would enable tftpd
   ver         => { decode => 1 },  
   sysinfo     => { decode => 1, expect => $success },  =over
   updateflash => { decode => 1, expect => $success },  
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  =item tftpd
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  
 );  Returns a hash ref of the decoded output from the command.
   
 my %ALIASES = (  Also see enable_tftpd() and disable_tftpd() as those check for correct output
   bye     => 'exit',  
   restart => 'reboot',  =item ver
 );  
   Returns a hash ref of the decoded output from the command.
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  =item sysinfo
   host_type  
   Host  Returns a hash ref of the decoded output from the command.
   is_connected  
   logged_in  =item exit
   login_banner  
   Timeout  exits the command session with the trango and closes the connection
   last_lines  
 );  =item reboot
   
 sub AUTOLOAD  reboots the trango and closes the connection
 {  
   my $self = shift;  =item sulog
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  returns an array ref of hashes containing each log line.
     or die "Weird: $AUTOLOAD";  
   =item save_sudb
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  returns true on success, undef on failure
     return $self->$method(@_);  
   }  =item syslog
   
   if (exists $COMMANDS{$method}) {  returns the output from the syslog command
     $COMMANDS{$method}{'String'} ||= $method;  
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  =item pipe
   }  
   returns the output from the pipe command
   if (exists $ACCESS{$method}) {  
     my $prev = $PRIVATE{$method};  =item maclist
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;  returns the output from the maclist command
   }  
   =item maclist_reset
   $method = "SUPER::$method";  
   return $self->$method(@_);  resets the maclist.  No useful output.
 }  
   =item eth_list
 =pod  
   returns the output from the eth list command
 =item new  
   =cut
 =cut  
   
 sub new  my $success = 'Success.';
 {  my %COMMANDS = (
   my $class = shift;    tftpd       => { decode => 'all',   expect => $success },
   my $args = shift || {};    ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
   $args->{'Timeout'} ||= 5;    updateflash => { decode => 'all',   expect => $success },
   $args->{'Prompt'}  ||= '/#> *$/';    sulog       => { decode => 'sulog', expect => $success },
     'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
   foreach my $key (keys %{ $args }) {    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
     $PRIVATE{$key} = $args->{$key};    save_sudb   => { String => 'save sudb', expect => $success },
   }    syslog      => { expect => $success },
     'pipe'      => { }, # XXX needs a special decode
   my $self = $class->SUPER::new(%{ $args });    maclist     => { decode => 'maclist' },
   bless $self if ref $self;    maclist_reset => { String => 'maclist reset', expect => 'done' },
     eth_link    => { String => 'eth link', expect => $success },
   return $self;    # eth r, w and reset???
 }    #su password???
     #_bootloader
 =pod    #temp
     #heater
 =item open  );
   
 =cut  my %ALIASES = (
     bye     => 'exit',
 sub open    restart => 'reboot',
 {  );
   my $self = shift;  
   my %ACCESS = map { $_ => 1 } qw(
   unless ( $self->SUPER::open(    firmware_version
       #Host => $self->Host,    host_type
       #Errmode => 'return',    Host
   ) ) {    is_connected
     #$! = "Couldn't connect to " . $self->Host . ":  $!";    logged_in
     return undef;    login_banner
   }    Timeout
   #$self->dump_log('dump.log');    last_lines
     last_vals
   ## Login to remote host.  );
   unless ($self->waitfor(  
     -match => '/password: ?$/i',  sub AUTOLOAD
     -errmode => "return",  {
   ) ) {    my $self = shift;
   #$! = "problem connecting to host (" . $self->Host . "): " .  
   #    $self->lastline;    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
     return undef;      or die "Weird: $AUTOLOAD";
   }  
     if (exists $ALIASES{$method}) {
   $self->parse_login_banner($self->lastline);      $method = $ALIASES{$method};
       return $self->$method(@_);
   $self->is_connected(1);    }
   
   return $self->is_connected;    if (exists $COMMANDS{$method}) {
 }      $method = shift if (@_ == 1);
       $COMMANDS{$method}{'String'} ||= $method;
 =pod      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     }
 =item login  
     if (exists $ACCESS{$method}) {
 =cut      my $prev = $PRIVATE{$method};
       ($PRIVATE{$method}) = @_ if @_;
 sub login      return $prev;
 {    }
   my $self = shift;  
     $method = "SUPER::$method";
   unless ($self->is_connected) {    return $self->$method(@_);
     $self->open or return undef;  }
   }  
   =pod
   my $password = shift;  
   =item open
   $self->print($password);  
   unless ($self->waitfor(  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()
     -match => $self->prompt,  
     -errmode => "return",  =cut
   ) ) {  
     #$! = "login ($self->Host) failed: " . $self->lastline;  sub open
     return undef;  {
   }    my $self = shift;
   
   $self->logged_in(1);    unless ( $self->SUPER::open(@_) ) {
       #$! = "Couldn't connect to " . $self->Host . ":  $!";
   return $self->logged_in;      return undef;
 }    }
   
 =pod    ## Get to login prompt
     unless ($self->waitfor(
 =item parse_login_banner        -match => '/password: ?$/i',
         -errmode => "return",
 =cut      ) ) {
       #$! = "problem connecting to host (" . $self->Host . "): " .
 sub parse_login_banner      #    $self->lastline;
 {      return undef;
   my $self = shift;    }
   
   if (@_) {    $self->parse_login_banner($self->lastline);
     $self->login_banner(@_);  
   }    $self->is_connected(1);
   
   my $banner = $self->login_banner;    return $self->is_connected;
   }
   my ($type, $ver) = $banner =~  
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  =pod
   
   $self->login_banner($banner);  =item login
   $self->host_type($type);  
   $self->firmware_version($ver);  Calls open() if not already connected, then sends the password and sets logged_in() if successful
   
   return 1;  =cut
 }  
   sub login
 =pod  {
     my $self = shift;
 =item enable_tftpd  
     unless ($self->is_connected) {
 =cut      $self->open or return undef;
     }
 sub enable_tftpd  
 {    my $password = shift;
   my $self = shift;  
     $self->print($password);
   my $vals = $self->tftpd( args => 'on' );    unless ($self->waitfor(
       -match => $self->prompt,
   if ($vals->{'Tftpd'} eq 'listen') {      -errmode => "return",
     return $vals;    ) ) {
   } else {      #$! = "login ($self->Host) failed: " . $self->lastline;
     return undef;      return undef;
   }    }
 }  
     $self->logged_in(1);
 =pod  
     return $self->logged_in;
 =item disable_tftpd  }
   
 =cut  =pod
   
 sub disable_tftpd  =item parse_login_banner
 {  
   my $self = shift;  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 $vals = $self->tftpd( args => 'off' );  =cut
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  sub parse_login_banner
     return $vals;  {
   } else {    my $self = shift;
     return undef;  
   }    if (@_) {
 }      $self->login_banner(@_);
     }
 =pod  
     my $banner = $self->login_banner;
 =item cmd  
     my ($type, $ver) = $banner =~
 =cut      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   
 sub cmd    $self->login_banner($banner);
 {    $self->host_type($type);
   my $self = shift;    $self->firmware_version($ver);
   
   my @valid_net_telnet_opts = qw(    return 1;
     String  }
     Output  
     Cmd_remove_mode  =pod
     Errmode  
     Input_record_separator  =item su_password
     Ors  
     Output_record_separator  C<su_password('all'|suid, 'new_password')>
     Prompt  
     Rs  =cut
     Timeout  
   );  sub su_password
   {
   my %cfg;    my $self     = shift;
   if (@_ == 2) {    my $su       = shift || '!';
     $cfg{'String'} = shift;    my $new_pass = shift || '';
   } elsif (@_ > 2) {  
     %cfg = @_;    unless (defined $su) {
   }      warn "No su passed!"
       #return undef;
   $cfg{'Timeout'} ||= $self->Timeout;    }
   
   unless ($cfg{'String'}) {    unless (defined $new_pass) {
     #$! = "No command passed";      warn "No new password!"
     warn "No command passed\n";      #return undef;
     return undef;    }
   }  
     return $self->cmd(String => 'su password ' .
   unless ($self->is_connected) {                       $su . ' ' .
     #$! = "Not connected";                       $new_pass . ' ' .
     warn "Not connected\n";                       $new_pass,
     return undef;                       expect => $success,
   }                      );
   }
   unless ($self->logged_in) {  
     #$! = "Not logged in";  =pod
     warn "Not logged in\n";  
     return undef;  =item su_ipconfig
   }  
   C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
   
   my %cmd;  =cut
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {  sub su_ipconfig
       $cmd{$_} = $cfg{$_};  {
     }          my $self        = shift;
   }  
   if ($cfg{'args'}) {          my $suid        = shift;
     $cmd{'String'} .= ' ' . $cfg{'args'};          my $new_ip      = shift;
   }          my $new_subnet  = shift;
   my @lines = $self->SUPER::cmd(%cmd);          my $new_gateway = shift;
   
   $self->last_lines(\@lines);          return undef unless $suid =~ /^\d+$/;
           return undef unless $new_ip;
   my $vals = 1;          return undef unless $new_subnet;
   if ($cfg{'decode'}) {          return undef unless $new_gateway;
     $vals = _decode_lines(@lines);  
   }          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
                        $suid       . ' ' .
   my $last = $self->lastline;                       $new_ip     . ' ' .
                        $new_subnet . ' ' .
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {                       $new_gateway,
     if ($cfg{'cmd_disconnects'}) {                       expect => $success,
       $self->logged_in(0);                      );
       $self->close;  }
       $self->is_connected(0);  
     }  =pod
   
     if ($cfg{'decode'}) {  =item sudb_view
       return $vals;  
     } else {  returns a reference to an array of hashes each containing:
       return @lines;  
     }    suid
   } else {    type
     #$! = "Error with command ($cfg{'string'}): $last";    cir
     return undef;    mir
   }    mac
 }  
   =cut
 #=item _decode_lines  
   sub sudb_view
 sub _decode_lines  {
 {    my $self = shift;
   my @lines = @_;  
     my @lines = $self->cmd( String => 'sudb view', expect => $success );
   my %conf;  
     return undef unless @lines;
   my $key = '';  
   my $val = '';    unless ($PRIVATE{'Decode'}) {
   my $in_key = 0;      return @lines;
   my $in_val = 0;    }
   
   foreach my $line (@lines) {    my @sus;
     my @chars = split //, $line;    foreach (@lines) {
       next unless $_;
     my $last_key = '';      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
     foreach my $c (@chars) {        my %s = (
           suid => $1,
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {          type => $2,
         if ($c eq '[') {          cir  => $3,
           $in_key = 1;          mir  => $4,
           $in_val = 0;          mac  => $5,
         } else {        );
           $in_key = 0;  
           $in_val = 0;            $s{'mac'} =~ s/\s//g;
         }            $s{'mac'} = uc($s{'mac'});
   
         if ($key) {        push @sus, \%s;
           $key =~ s/^\s+//;      }
           $key =~ s/\s+$//;    }
   
           $val =~ s/^\s+//;    return \@sus;
           $val =~ s/\s+$//;  }
   
           if ($key eq 'Checksum' && $last_key) {  =pod
             # Special case for these bastids.  
             my $new = $last_key;  =item sudb_add
             $new =~ s/\s+\S+$//;  
             $key = $new . " " . $key;  Takes the following paramaters
           }  
           suid : numeric,
           $last_key = $key;          type : (reg|pr)
           $conf{$key} = $val;          cir  : numeric,
           $key = '';          mir  : numeric,
           $val = '';          mac  : Almost any format, it will be reformatted,
         }  
   and returns true on success or undef otherwise.
       } elsif ($c eq ']') {  
         $in_val = 1;  You should save_sudb() after calling this, or your changes  will be lost
         $in_key = 0;  when the AP is rebooted.
         $c = shift @chars;  
   =cut
       } elsif ($in_key) {  
         $key .= $c;  sub sudb_add
   {
       } elsif ($in_val) {          my $self = shift;
         $val .= $c;          my $suid = shift;
       }          my $type = shift;
     }          my $cir  = shift;
   }          my $mir  = shift;
           my $mac  = shift;
   if (%conf) {  
     return \%conf;          if ($suid =~ /\D/) {
   } else {                  return undef;
     return \@lines;          }
   }  
 }          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                   warn "Invalid type '$type'!";
 1;                  return undef;
 __END__          }
   
 =back          if ($cir =~ /\D/) {
                   warn "Invalid CIR '$cir'!";
 =head1 SEE ALSO                  return undef;
           }
 If you have a web site set up for your module, mention it here.  
           if ($mir =~ /\D/) {
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm                  warn "Invalid MIR '$mir'!";
                   return undef;
 L<Net::Telnet>          }
   
 =head1 TODO          my $new_mac = $mac;
           $new_mac =~ s/[^0-9A-Fa-f]//;
 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 (length $new_mac == 12) {
                   warn "Invalid MAC '$mac'!";
 I also want to be able to parse the different types of output from commands like su, sudb all and anything else that would be better available as a perl datastructure.                  return undef;
           }
 =head1 AUTHOR          $new_mac = join ' ', $new_mac =~ /../g;
   
 Andrew Fresh E<lt>andrew@rraz.netE<gt>          my $string = 'sudb add ' .
                   $suid . ' ' .
 =head1 COPYRIGHT AND LICENSE                  $type . ' ' .
                   $cir  . ' ' .
 Copyright (C) 2005 by Andrew Fresh                  $mir  . ' ' .
                   $new_mac;
 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.          return $self->cmd( String => $string, expect => $success );
   }
   
 =cut  =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 = '';
     my $in_key = 0;
     my $in_val = 0;
   
     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 = 0;
           }
   
           if ($key) {
             $key =~ s/^\s+//;
             $key =~ s/\s+$//;
   
             $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 undef;
     }
   }
   
   #=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.15
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>