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

version 1.6, 2006/06/28 23:00:15 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.5 2006/01/03 00:22:19 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.
 =cut  
   =item exit
   
 my $success = 'Success.';  exits the command session with the trango and closes the connection
 my %COMMANDS = (  
   tftpd       => { decode => 'all',   expect => $success },  =item reboot
   ver         => { decode => 'all' },  
   sysinfo     => { decode => 'all',   expect => $success },  reboots the trango and closes the connection
   updateflash => { decode => 'all',   expect => $success },  
   sulog       => { decode => 'sulog', expect => $success },  =item remarks
   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },  
   reboot      => { no_prompt => 1, cmd_disconnects => 1 },  Takes an optional argument, which sets the remarks.
   sudb_save   => { String => "sudb save", expect => $success },  If there is no argument, returns the current remarks.
   #su password???  
   #_bootloader  =item sulog
   #temp  
   #heater  returns an array ref of hashes containing each log line.
 );  
   =item save_sudb
 my %ALIASES = (  
   bye     => 'exit',  returns true on success, undef on failure
   restart => 'reboot',  
 );  =item syslog
   
 my %ACCESS = map { $_ => 1 } qw(  returns the output from the syslog command
   firmware_version  
   host_type  =item pipe
   Host  
   is_connected  returns the output from the pipe command
   logged_in  
   login_banner  =item maclist
   Timeout  
   last_lines  returns the output from the maclist command
   last_vals  
 );  =item maclist_reset
   
 sub AUTOLOAD  resets the maclist.  No useful output.
 {  
   my $self = shift;  =item eth_list
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  returns the output from the eth list command
     or die "Weird: $AUTOLOAD";  
   =item su_info
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  You need to pass in args => <suid> and it will return the info for that suid.
     return $self->$method(@_);  
   }  =item save_ss
   
   if (exists $COMMANDS{$method}) {  saves the config.  Returns 1 on success, undef on failure.
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  =cut
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  
   my $success = 'Success.';
   if (exists $ACCESS{$method}) {  my %COMMANDS = (
     my $prev = $PRIVATE{$method};    tftpd       => { decode => 'all',   expect => $success },
     ($PRIVATE{$method}) = @_ if @_;    ver         => { decode => 'all' },
     return $prev;    sysinfo     => { decode => 'all',   expect => $success },
   }    updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
   $method = "SUPER::$method";    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
   return $self->$method(@_);    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
 }    remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
 =pod    syslog      => { expect => $success },
     'pipe'      => { }, # XXX needs a special decode
 =item open    maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
 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()    eth_link    => { String => 'eth link', expect => $success },
     su_info     => { String => 'su info', decode => 'all', expect => $success },
 =cut    save_ss     => { String => 'save ss', expect => $success },
     # eth r, w and reset???
 sub open    #su password???
 {    #_bootloader
   my $self = shift;    #temp
     #heater
   unless ( $self->SUPER::open(@_) ) {  );
     #$! = "Couldn't connect to " . $self->Host . ":  $!";  
     return undef;  my %ALIASES = (
   }    bye     => 'exit',
     restart => 'reboot',
   ## Get to login prompt  );
   unless ($self->waitfor(  
       -match => '/password: ?$/i',  my %ACCESS = map { $_ => 1 } qw(
       -errmode => "return",    firmware_version
     ) ) {    host_type
     #$! = "problem connecting to host (" . $self->Host . "): " .    Host
     #    $self->lastline;    is_connected
     return undef;    logged_in
   }    login_banner
     Timeout
   $self->parse_login_banner($self->lastline);    last_lines
     last_vals
   $self->is_connected(1);  );
   
   return $self->is_connected;  sub AUTOLOAD
 }  {
     my $self = shift;
 =pod  
     my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
 =item login      or die "Weird: $AUTOLOAD";
   
 Calls open() if not already connected, then sends the password and sets logged_in() if successful    if (exists $ALIASES{$method}) {
       $method = $ALIASES{$method};
 =cut      return $self->$method(@_);
     }
 sub login  
 {    if (exists $COMMANDS{$method}) {
   my $self = shift;      $COMMANDS{$method}{'String'} ||= $method;
       $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
   unless ($self->is_connected) {      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     $self->open or return undef;    }
   }  
     if (exists $ACCESS{$method}) {
   my $password = shift;      my $prev = $PRIVATE{$method};
       ($PRIVATE{$method}) = @_ if @_;
   $self->print($password);      return $prev;
   unless ($self->waitfor(    }
     -match => $self->prompt,  
     -errmode => "return",    $method = "SUPER::$method";
   ) ) {    return $self->$method(@_);
     #$! = "login ($self->Host) failed: " . $self->lastline;  }
     return undef;  
   }  =pod
   
   $self->logged_in(1);  =item open
   
   return $self->logged_in;  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()
 =pod  
   =cut
 =item parse_login_banner  
   sub 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()  {
     my $self = shift;
 =cut  
     unless ( $self->SUPER::open(@_) ) {
 sub parse_login_banner      #$! = "Couldn't connect to " . $self->Host . ":  $!";
 {      return undef;
   my $self = shift;    }
   
   if (@_) {    ## Get to login prompt
     $self->login_banner(@_);    unless ($self->waitfor(
   }        -match => '/password: ?$/i',
         -errmode => "return",
   my $banner = $self->login_banner;      ) ) {
       #$! = "problem connecting to host (" . $self->Host . "): " .
   my ($type, $ver) = $banner =~      #    $self->lastline;
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;      return undef;
     }
   $self->login_banner($banner);  
   $self->host_type($type);    $self->parse_login_banner($self->lastline);
   $self->firmware_version($ver);  
     $self->is_connected(1);
   return 1;  
 }    return $self->is_connected;
   }
 =pod  
   =pod
 =item su_password  
   =item login
 C<su_password('all'|suid, 'new_password')>  
   Calls open() if not already connected, then sends the password and sets
 =cut  logged_in() if successful
   
 sub su_password  =cut
 {  
   my $self     = shift;  sub login
   my $su       = shift || '!';  {
   my $new_pass = shift || '';    my $self = shift;
   
   unless (defined $su) {    unless ($self->is_connected) {
     warn "No su passed!"      $self->open or return undef;
     #return undef;    }
   }  
     my $password = shift;
   unless (defined $new_pass) {  
     warn "No new password!"      $self->print($password);
     #return undef;    unless ($self->waitfor(
   }      -match => $self->prompt,
       -errmode => "return",
   return $self->cmd(String => 'su password ' .    ) ) {
                      $su . ' ' .      #$! = "login ($self->Host) failed: " . $self->lastline;
                      $new_pass . ' ' .      return undef;
                      $new_pass,    }
                      expect => $success,  
                     );    $self->logged_in(1);
 }  
     return $self->logged_in;
   }
 =pod  
   =pod
 =item sudb_view  
   =item parse_login_banner
 returns a reference to an array of hashes each containing:  
   Takes a login banner (what you get when you first connect to the Trango)
   suid  or reads what is already in login_banner() then parses it and sets
   type  host_type() and firmware_version() as well as login_banner()
   cir  
   mir  =cut
   mac  
   sub parse_login_banner
 =cut  {
     my $self = shift;
 sub sudb_view  
 {    if (@_) {
   my $self = shift;      $self->login_banner(@_);
     }
   my @lines = $self->cmd( String => 'sudb view', expect => $success );  
     my $banner = $self->login_banner;
   return undef unless @lines;  
     my ($type, $ver) = $banner =~
   my @sus;      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   foreach (@lines) {  
     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {    $self->login_banner($banner);
       my %s = (    $self->host_type($type);
         suid => $1,    $self->firmware_version($ver);
         type => $2,  
         cir  => $3,    return 1;
         mir  => $4,  }
         mac  => $5,  
       );  =pod
   
           $s{'mac'} =~ s/\s//g;  =item su_password
           $s{'mac'} = uc($s{'mac'});  
   C<su_password('all'|suid, 'new_password')>
       push @sus, \%s;  
     }  =cut
   }  
   sub su_password
   return \@sus;  {
 }    my $self     = shift;
     my $su       = shift || '!';
 =pod    my $new_pass = shift || '';
   
 =item sudb_add    unless (defined $su) {
       warn "No su passed!"
 Takes the following paramaters      #return undef;
     }
         suid : numeric,  
         type : (reg|pr)    unless (defined $new_pass) {
         cir  : numeric,      warn "No new password!"
         mir  : numeric,      #return undef;
         mac  : Almost any format, it will be reformatted,    }
   
 and returns true on success or undef otherwise.    return $self->cmd(String => 'su password ' .
                        $su . ' ' .
 You should sudb_save() after calling this, or your changes  will be lost                       $new_pass . ' ' .
 when the AP is rebooted.                       $new_pass,
                        expect => $success,
 =cut                      );
   }
 sub sudb_add  
 {  =pod
         my $self = shift;  
         my $suid = shift;  =item su_ipconfig
         my $type = shift;  
         my $cir  = shift;  C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
         my $mir  = shift;  
         my $mac  = shift;  =cut
   
         if ($suid =~ /\D/) {  sub su_ipconfig
                 return undef;  {
         }          my $self        = shift;
   
         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {          my $suid        = shift;
                 warn "Invalid type '$type'!";          my $new_ip      = shift;
                 return undef;          my $new_subnet  = shift;
         }          my $new_gateway = shift;
   
         if ($cir =~ /\D/) {          return undef unless $suid =~ /^\d+$/;
                 warn "Invalid CIR '$cir'!";          return undef unless $new_ip;
                 return undef;          return undef unless $new_subnet;
         }          return undef unless $new_gateway;
   
         if ($mir =~ /\D/) {          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
                 warn "Invalid MIR '$mir'!";          return $self->cmd(String => 'su ipconfig ' .
                 return undef;                       $suid       . ' ' .
         }                       $new_ip     . ' ' .
                        $new_subnet . ' ' .
         my $new_mac = $mac;                       $new_gateway,
         $new_mac =~ s/[^0-9A-Fa-f]//;                       expect => $success,
         unless (length $new_mac == 12) {                      );
                 warn "Invalid MAC '$mac'!";  }
                 return undef;  
         }  =pod
         $new_mac = join ' ', $new_mac =~ /../g;  
   =item sudb_view
         my $string = 'sudb add ' .  
                 $suid . ' ' .  returns a reference to an array of hashes each containing:
                 $type . ' ' .  
                 $cir  . ' ' .    suid
                 $mir  . ' ' .    type
                 $new_mac;    cir
     mir
     mac
         return $self->cmd( String => $string, expect => $success );  
 }  =cut
   
 =pod  sub sudb_view
   {
 =item sudb_delete    my $self = shift;
   
 Takes either 'all' or the  suid of the su to delete    my @lines = $self->cmd( String => 'sudb view', expect => $success );
 and returns true on success or undef otherwise.  
     return undef unless @lines;
 You should sudb_save() after calling this, or your changes  will be lost  
 when the AP is rebooted.    unless ($PRIVATE{'Decode'}) {
       return @lines;
 =cut    }
   
 sub sudb_delete    my @sus;
 {    foreach (@lines) {
         my $self = shift;      next unless $_;
         my $suid = shift;      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
         my %s = (
         if ($suid =~ /\D/) {          suid => $1,
                 return undef;          type => $2,
         }          cir  => $3,
           mir  => $4,
         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );          mac  => $5,
 }        );
   
             $s{'mac'} =~ s/\s//g;
 =pod            $s{'mac'} = uc($s{'mac'});
   
 =item sudb_modify        push @sus, \%s;
       }
 Takes either the  suid of the su to delete    }
 as well as what you are changing, either "cir, mir or su2su"  
 and returns true on success or undef otherwise.    return \@sus;
   }
 cir and mir also take a value to set the cir/mir to.  
   =pod
 su2su takes a group id parameter that is in hex.  
   =item sudb_add
 You should sudb_save() after calling this, or your changes  will be lost  
 when the AP is rebooted.  Takes the following paramaters
   
 =cut          suid : numeric,
           type : (reg|pr)
 sub sudb_modify          cir  : numeric,
 {          mir  : numeric,
         my $self  = shift;          mac  : Almost any format, it will be reformatted,
         my $suid  = shift;  
         my $opt   = shift;  and returns true on success or undef otherwise.
         my $value = shift;  
   You should save_sudb() after calling this, or your changes  will be lost
         if ($suid =~ /\D/) {  when the AP is rebooted.
                 return undef;  
         }  =cut
   
         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {  sub sudb_add
                 if ($value =~ /\D/) {  {
                         return undef;          my $self = shift;
                 }          my $suid = shift;
         } elsif (lc($opt) eq 'su2su') {          my $type = shift;
                 if ($value =~ /[^0-9A-Za-f]/) {          my $cir  = shift;
                         return undef;          my $mir  = shift;
                 }          my $mac  = shift;
         } else {  
                 return undef;          if ($suid =~ /\D/) {
         }                  return undef;
           }
         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;  
           unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
         return $self->cmd( String => $string, expect => $success );                  warn "Invalid type '$type'!";
 }                  return undef;
           }
 =pod  
           if ($cir =~ /\D/) {
 =item enable_tftpd                  warn "Invalid CIR '$cir'!";
                   return undef;
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing          }
   
 =cut          if ($mir =~ /\D/) {
                   warn "Invalid MIR '$mir'!";
 sub enable_tftpd                  return undef;
 {          }
   my $self = shift;  
           my $new_mac = $mac;
   my $vals = $self->tftpd( args => 'on' );          $new_mac =~ s/[^0-9A-Fa-f]//;
           unless (length $new_mac == 12) {
   if ($vals->{'Tftpd'} eq 'listen') {                  warn "Invalid MAC '$mac'!";
     return $vals;                  return undef;
   } else {          }
     return undef;          $new_mac = join ' ', $new_mac =~ /../g;
   }  
 }          my $string = 'sudb add ' .
                   $suid . ' ' .
 =pod                  $type . ' ' .
                   $cir  . ' ' .
 =item disable_tftpd                  $mir  . ' ' .
                   $new_mac;
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  
   
 =cut          return $self->cmd( String => $string, expect => $success );
   }
 sub disable_tftpd  
 {  =pod
   my $self = shift;  
   =item sudb_delete
   my $vals = $self->tftpd( args => 'off' );  
   Takes either 'all' or the  suid of the su to delete
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  and returns true on success or undef otherwise.
     return $vals;  
   } else {  You should save_sudb() after calling this, or your changes  will be lost
     return undef;  when the AP is rebooted.
   }  
 }  =cut
   
 =pod  sub sudb_delete
   {
 =item cmd          my $self = shift;
           my $suid = shift;
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.  
           if (lc($suid) ne 'all' || $suid =~ /\D/) {
 Normally returns the last lines from from the command                  return undef;
           }
 Also accepts these options:  
           return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
 I<decode>  }
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output  
   =pod
 I<cmd_disconnects>  
 - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false  =item sudb_modify
   
 I<expect>  Takes either the  suid of the su to delete
 - 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  as well as what you are changing, either "cir, mir or su2su"
   and returns true on success or undef otherwise.
 I<args>  
 - a string containing the command line options that are passed to the command  cir and mir also take a value to set the cir/mir to.
   
 =cut  su2su takes a group id parameter that is in hex.
   
 sub cmd  You should save_sudb() after calling this, or your changes  will be lost
 {  when the AP is rebooted.
   my $self = shift;  
   =cut
   my @valid_net_telnet_opts = qw(  
     String  sub sudb_modify
     Output  {
     Cmd_remove_mode          my $self  = shift;
     Errmode          my $suid  = shift;
     Input_record_separator          my $opt   = shift;
     Ors          my $value = shift;
     Output_record_separator  
     Prompt          if ($suid =~ /\D/) {
     Rs                  return undef;
     Timeout          }
   );  
           if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
   my %cfg;                  if ($value =~ /\D/) {
   if (@_ == 2) {                          return undef;
     $cfg{'String'} = shift;                  }
   } elsif (@_ > 2) {          } elsif (lc($opt) eq 'su2su') {
     %cfg = @_;                  if ($value =~ /[^0-9A-Za-f]/) {
   }                          return undef;
                   }
   $cfg{'Timeout'} ||= $self->Timeout;          } else {
                   return undef;
   unless ($cfg{'String'}) {          }
     #$! = "No command passed";  
     #warn "No command passed\n";          my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
     return undef;  
   }          return $self->cmd( String => $string, expect => $success );
   }
   unless ($self->is_connected) {  
     #$! = "Not connected";  =pod
     #warn "Not connected\n";  
     return undef;  =item enable_tftpd
   }  
   runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   unless ($self->logged_in) {  
     #$! = "Not logged in";  =cut
     #warn "Not logged in\n";  
     return undef;  sub enable_tftpd
   }  {
     my $self = shift;
   
   my %cmd;    my $vals = $self->tftpd( args => 'on' );
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {    if ($vals->{'Tftpd'} eq 'listen') {
       $cmd{$_} = $cfg{$_};      return $vals;
     }    } else {
   }      return undef;
   if ($cfg{'args'}) {    }
     $cmd{'String'} .= ' ' . $cfg{'args'};  }
   }  
   my @lines;  =pod
   unless ($cfg{'no_prompt'}) {  
     @lines = $self->SUPER::cmd(%cmd);  =item disable_tftpd
   } else {  
     $self->print($cmd{'String'});  runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
     @lines = $self->lastline;  
   }  =cut
   
   $self->last_lines(\@lines);  sub disable_tftpd
   {
   my $vals = 1;    my $self = shift;
   if ($cfg{'decode'}) {  
     if ($cfg{'decode'} eq 'each') {    my $vals = $self->tftpd( args => 'off' );
       $vals = _decode_each_line(@lines);  
     } elsif ($cfg{'decode'} eq 'sulog') {    if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
       $vals = _decode_sulog(@lines);      return $vals;
     } else {    } else {
       $vals = _decode_lines(@lines);      return undef;
     }    }
   }  }
   
   $self->last_vals($vals);  =pod
   
   =item cmd
   my $last = $self->lastline;  
   This does most of the work.  At the heart, it calls Net::Telnet::cmd()
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  but it also does some special stuff for Trango.
     if ($cfg{'cmd_disconnects'}) {  
       $self->logged_in(0);  Normally returns the last lines from from the command
       $self->close;  
       $self->is_connected(0);  Also accepts these options:
     }  
   I<decode>
     if ($cfg{'decode'}) {  - if this is true, then it will send the output lines to _decode_lines()
       return $vals;  and then returns the decoded output
     } else {  
       return @lines;  I<cmd_disconnects>
     }  - if this is true, it then sets logged_in() to false, then it will
   } else {  close() the connection and then sets is_connected() to false
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;  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
 #=item _decode_lines  
   I<args>
 sub _decode_lines  - a string containing the command line options that are passed to the
 {  command
   my @lines = @_;  
   =cut
   my %conf;  
   sub cmd
   my $key = '';  {
   my $val = '';    my $self = shift;
   my $in_key = 0;  
   my $in_val = 0;    my @valid_net_telnet_opts = qw(
       String
   foreach my $line (@lines) {      Output
     next if $line =~ /$success$/;      Cmd_remove_mode
       Errmode
     my @chars = split //, $line;      Input_record_separator
       Ors
     my $last_key = '';      Output_record_separator
     foreach my $c (@chars) {      Prompt
       Rs
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {      Timeout
         if ($c eq '[') {    );
           $in_key = 1;  
           $in_val = 0;    my %cfg;
         } else {    if (@_ == 1) {
           $in_key = 0;      $cfg{'String'} = shift;
           $in_val = 0;    } elsif (@_ > 1) {
         }      %cfg = @_;
     }
         if ($key) {  
           $key =~ s/^\s+//;    $cfg{'Timeout'} ||= $self->Timeout;
           $key =~ s/\s+$//;  
     unless ($cfg{'String'}) {
           $val =~ s/^\s+//;      #$! = "No command passed";
           $val =~ s/\s+$//;      #warn "No command passed\n";
       return undef;
           if ($key eq 'Checksum' && $last_key) {    }
             # Special case for these bastids.  
             my $new = $last_key;    unless ($self->is_connected) {
             $new =~ s/\s+\S+$//;      #$! = "Not connected";
             $key = $new . " " . $key;      #warn "Not connected\n";
           }      return undef;
     }
           $last_key = $key;  
           $conf{$key} = $val;    unless ($self->logged_in) {
           $key = '';      #$! = "Not logged in";
           $val = '';      #warn "Not logged in\n";
         }      return undef;
     }
       } elsif ($c eq ']') {  
         $in_val = 1;  
         $in_key = 0;    my %cmd;
         $c = shift @chars;    foreach (@valid_net_telnet_opts) {
       if (exists $cfg{$_}) {
       } elsif ($in_key) {        $cmd{$_} = $cfg{$_};
         $key .= $c;      }
     }
       } elsif ($in_val) {    if ($cfg{'args'}) {
         $val .= $c;      $cmd{'String'} .= ' ' . $cfg{'args'};
       }    }
     }    my @lines;
   }    unless ($cfg{'no_prompt'}) {
       @lines = $self->SUPER::cmd(%cmd);
   if (%conf) {    } else {
     return \%conf;      $self->print($cmd{'String'});
   } else {      @lines = $self->lastline;
     return undef;    }
   }  
 }    $self->last_lines(\@lines);
   
 #=item _decode_each_line    my $vals = 1;
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
 sub _decode_each_line      if ($cfg{'decode'} eq 'each') {
 {        $vals = _decode_each_line(@lines);
   my @lines = @_;      } elsif ($cfg{'decode'} eq 'sulog') {
   my @decoded;        $vals = _decode_sulog(@lines);
   foreach my $line (@lines) {      } elsif ($cfg{'decode'} eq 'maclist') {
     my $decoded = _decode_lines($line);        $vals = _decode_maclist(@lines);
     push @decoded, $decoded if defined $decoded;      } else {
   }        $vals = _decode_lines(@lines);
   return \@decoded;      }
 }    }
   
 #=item _decode_sulog    $self->last_vals($vals);
   
 sub _decode_sulog  
 {    my $last = $self->lastline;
   my @lines = @_;  
   my @decoded;    if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
   my $last_tm;      if ($cfg{'cmd_disconnects'}) {
   foreach my $line (@lines) {        $self->logged_in(0);
     my $decoded = _decode_lines($line);        $self->close;
         $self->is_connected(0);
     if (defined $decoded) {      }
       if ($decoded->{'tm'}) {  
         $last_tm = $decoded->{'tm'};      if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
         next;        return $vals;
       } else {      } else {
         $decoded->{'tm'} = $last_tm;        return @lines;
       }      }
       next unless $last_tm;    } else {
       #$! = "Error with command ($cfg{'string'}): $last";
       push @decoded, $decoded if defined $decoded;      return undef;
     }    }
   }  }
   return \@decoded;  
 }  #=item _decode_lines
   
 1;  sub _decode_lines
 __END__  {
     my @lines = @_;
 =back  
     my %conf;
 =head1 SEE ALSO  
     my $key = '';
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm    my $val = undef;
     my $in_key = 0;
 L<Net::Telnet>    my $in_val = 1;
   
 =head1 TODO    foreach my $line (@lines) {
       next if $line =~ /$success$/;
 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.  
       my @chars = split //, $line;
 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.  
       my $last_key = '';
 =head1 AUTHOR      foreach my $c (@chars) {
   
 Andrew Fresh E<lt>andrew@rraz.netE<gt>        if ($c eq '[' || $c eq "\r" || $c eq "\n") {
           if ($c eq '[') {
 =head1 COPYRIGHT AND LICENSE            $in_key = 1;
             $in_val = 0;
 Copyright (C) 2005 by Andrew Fresh          } else {
             $in_key = 0;
 This library is free software; you can redistribute it and/or modify            $in_val = 1;
 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.  
           if ($key) {
             $key =~ s/^\s+//;
 =cut            $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.6  
changed lines
  Added in v.1.20

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