[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.25

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

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