[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.8 and 1.20

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

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