[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.4 and 1.19

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