[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.13 and 1.16

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

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.16

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>