[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.7 and 1.25

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

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