[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.5 and 1.22

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