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

version 1.4, 2005/12/30 20:26:41 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.3 2005/12/30 19:26:06 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 );
     
   my ($type, $version) = $t->open( Host => $fox );    $t->open( Host => $fox ) or die "Error connecting: $!";
     
   unless (defined $type && defined $version) {    $t->login('password') or die "Couldn't log in: $!";
     die "Error connecting: $!";  
   }    # Do whatever
   
   $t->login('password') or die "Couldn't log in: $!";    $t->exit;
       $t->close;
   # Do whatever  
     =head1 DESCRIPTION
   $t->exit;  
   $t->close;  Perl access to the telnet interface on Trango Foxes, SUs and APs.
   
 =head1 DESCRIPTION  Another handy feature is that it will parse the output from certain
   commands that is in the format "[key1] value1 [key2] value2" and put
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  those in a hashref that is returned.  This makes using the output from
   things like sysinfo very easy to do.
 Another handy feature is that it will parse the output from certain commands that is in the format "[key1] value1 [key2] value2" and put those in a hashref that is returned.  This makes using the output from things like sysinfo very easy to do.  
   =head2 EXPORT
 =head2 EXPORT  
   None
 None  
   =head1 METHODS
 =cut  
   =over
 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  =back
   
 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  
   =item last_error
 alias of reboot()  
   returns the last error reported.  Should contain the the last entry in
 =back  last_lines
   
 =head2 COMMANDS  =back
   
 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:  =head2 ALIASES
 C<tftpd(args =E<gt> 'on')> would enable tftpd  
   =over
 =over  
   =item bye
 =item tftpd  
   alias of exit()
 Returns a hash ref of the decoded output from the command.  
   =item restart
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  
   alias of reboot()
 =item ver  
   =back
 Returns a hash ref of the decoded output from the command.  
   =head2 COMMANDS
 =item sysinfo  
   Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
 Returns a hash ref of the decoded output from the command.  as such they accept the same options as C<cmd()>.
   Specifically they take a named paramater "args", for example:
 =item exit  C<tftpd(args =E<gt> 'on')> would enable tftpd
   
 exits the command session with the trango and closes the connection  =over
   
 =item reboot  =item tftpd
   
 reboots the trango and closes the connection  Returns a hash ref of the decoded output from the command.
   
 =item sulog  Also see enable_tftpd() and disable_tftpd() as those check for correct output
   
 returns an array ref of hashes containing each log line.  =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'      => { Prompt => '//', cmd_disconnects => 1 },  =item reboot
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  
   #su password???  reboots the trango and closes the connection
   #_bootloader  
   #temp  =item remarks
   #heater  
 );  Takes an optional argument, which sets the remarks.
   If there is no argument, returns the current remarks.
 my %ALIASES = (  
   bye     => 'exit',  =item sulog
   restart => 'reboot',  
 );  returns an array ref of hashes containing each log line.
   
 my %ACCESS = map { $_ => 1 } qw(  =item save_sudb
   firmware_version  
   host_type  returns true on success, undef on failure
   Host  
   is_connected  =item syslog
   logged_in  
   login_banner  returns the output from the syslog command
   Timeout  
   last_lines  =item pipe
 );  
   returns the output from the pipe command
 sub AUTOLOAD  
 {  =item maclist
   my $self = shift;  
   returns the output from the maclist command
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";  =item maclist_reset
   
   if (exists $ALIASES{$method}) {  resets the maclist.  No useful output.
     $method = $ALIASES{$method};  
     return $self->$method(@_);  =item eth_list
   }  
   returns the output from the eth list command
   if (exists $COMMANDS{$method}) {  
     $method = shift if (@_ == 1);  =item su_info
     $COMMANDS{$method}{'String'} ||= $method;  
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  You need to pass in args => <suid> and it will return the info for that suid.
   }  
   =item save_ss
   if (exists $ACCESS{$method}) {  
     my $prev = $PRIVATE{$method};  saves the config.  Returns 1 on success, undef on failure.
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;  =cut
   }  
   
   $method = "SUPER::$method";  my $success = 'Success.';
   return $self->$method(@_);  my %COMMANDS = (
 }    tftpd       => { decode => 'all',   expect => $success },
     ver         => { decode => 'all' },
 =pod    sysinfo     => { decode => 'all',   expect => $success },
     updateflash => { decode => 'all',   expect => $success },
 =item open    sulog       => { decode => 'sulog', expect => $success },
     'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
 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()    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
     remarks     => { decode => 'all', expect => $success },
 =cut    save_sudb   => { String => 'save sudb', expect => $success },
     syslog      => { expect => $success },
 sub open    'pipe'      => { }, # XXX needs a special decode
 {    maclist     => { decode => 'maclist' },
   my $self = shift;    maclist_reset => { String => 'maclist reset', expect => 'done' },
     eth_link    => { String => 'eth link', expect => $success },
   unless ( $self->SUPER::open(@_) ) {    su_info     => { String => 'su info', decode => 'all', expect => $success },
     #$! = "Couldn't connect to " . $self->Host . ":  $!";    save_ss     => { String => 'save ss', expect => $success },
     return undef;    opmode      => { decode => 'all',   expect => $success },
   }    # eth r, w and reset???
     #su password???
   ## Get to login prompt    #_bootloader
   unless ($self->waitfor(    #temp
       -match => '/password: ?$/i',    #heater
       -errmode => "return",  );
     ) ) {  
     #$! = "problem connecting to host (" . $self->Host . "): " .  my %ALIASES = (
     #    $self->lastline;    bye     => 'exit',
     return undef;    restart => 'reboot',
   }  );
   
   $self->parse_login_banner($self->lastline);  my %ACCESS = map { $_ => 1 } qw(
     firmware_version
   $self->is_connected(1);    host_type
     Host
   return $self->is_connected;    is_connected
 }    logged_in
     login_banner
 =pod    Timeout
     last_lines
 =item login    last_vals
     last_error
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  );
   
 =cut  sub AUTOLOAD
   {
 sub login    my $self = shift;
 {  
   my $self = shift;    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
       or die "Weird: $AUTOLOAD";
   unless ($self->is_connected) {  
     $self->open or return undef;    if (exists $ALIASES{$method}) {
   }      $method = $ALIASES{$method};
       return $self->$method(@_);
   my $password = shift;    }
   
   $self->print($password);    if (exists $COMMANDS{$method}) {
   unless ($self->waitfor(      $COMMANDS{$method}{'String'} ||= $method;
     -match => $self->prompt,      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
     -errmode => "return",      return $self->cmd(%{ $COMMANDS{$method} }, @_);
   ) ) {    }
     #$! = "login ($self->Host) failed: " . $self->lastline;  
     return undef;    if (exists $ACCESS{$method}) {
   }      my $prev = $PRIVATE{$method};
       ($PRIVATE{$method}) = @_ if @_;
   $self->logged_in(1);      return $prev;
     }
   return $self->logged_in;  
 }    $method = "SUPER::$method";
     return $self->$method(@_);
 =pod  }
   
 =item parse_login_banner  =pod
   
 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()  =item open
   
 =cut  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
 sub parse_login_banner  host_type() and firmware_version()
 {  
   my $self = shift;  =cut
   
   if (@_) {  sub open
     $self->login_banner(@_);  {
   }    my $self = shift;
   
   my $banner = $self->login_banner;    unless ( $self->SUPER::open(@_) ) {
       $self->last_error("Couldn't connect to " . $self->Host . ":  $!");
   my ($type, $ver) = $banner =~      return undef;
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;    }
   
   $self->login_banner($banner);    ## Get to login prompt
   $self->host_type($type);    unless ($self->waitfor(
   $self->firmware_version($ver);        -match => '/password: ?$/i',
         -errmode => "return",
   return 1;      ) ) {
 }      $self->last_error("problem connecting to host (" . $self->Host . "): " .
           $self->lastline);
 =pod      return undef;
     }
 =item enable_tftpd  
     $self->parse_login_banner($self->lastline);
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  
     $self->is_connected(1);
 =cut  
     return $self->is_connected;
 sub enable_tftpd  }
 {  
   my $self = shift;  =pod
   
   my $vals = $self->tftpd( args => 'on' );  =item login
   
   if ($vals->{'Tftpd'} eq 'listen') {  Calls open() if not already connected, then sends the password and sets
     return $vals;  logged_in() if successful
   } else {  
     return undef;  =cut
   }  
 }  sub login
   {
 =pod    my $self = shift;
   
 =item disable_tftpd    unless ($self->is_connected) {
       $self->open or return undef;
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'    }
   
 =cut    my $password = shift;
   
 sub disable_tftpd    $self->print($password);
 {    unless ($self->waitfor(
   my $self = shift;      -match => $self->prompt,
       -errmode => "return",
   my $vals = $self->tftpd( args => 'off' );    ) ) {
       $self->last_error("login ($self->Host) failed: " . $self->lastline);
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {      return undef;
     return $vals;    }
   } else {  
     return undef;    $self->logged_in(1);
   }  
 }    return $self->logged_in;
   }
 =pod  
   =pod
 =item cmd  
   =item parse_login_banner
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.  
   Takes a login banner (what you get when you first connect to the Trango)
 Normally returns the last lines from from the command  or reads what is already in login_banner() then parses it and sets
   host_type() and firmware_version() as well as login_banner()
 Also accepts these options:  
   =cut
 I<decode>  
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output  sub parse_login_banner
   {
 I<cmd_disconnects>    my $self = shift;
 - 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 (@_) {
 I<expect>      $self->login_banner(@_);
 - if this is set (usually to 'Success.') it will check for that in the last line of output and if it does not, will return undef because the command probably failed    }
   
 I<args>    my $banner = $self->login_banner;
 - a string containing the command line options that are passed to the command  
     my ($type, $ver) = $banner =~
 =cut      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   
 sub cmd    $self->login_banner($banner);
 {    $self->host_type($type);
   my $self = shift;    $self->firmware_version($ver);
   
   my @valid_net_telnet_opts = qw(    return 1;
     String  }
     Output  
     Cmd_remove_mode  =pod
     Errmode  
     Input_record_separator  =item su_password
     Ors  
     Output_record_separator  C<su_password('new_password'[, 'suid'])> If no suid is specified,
     Prompt  the default is "all".
     Rs  
     Timeout  =cut
   );  
   sub su_password
   my %cfg;  {
   if (@_ == 2) {    my $self     = shift;
     $cfg{'String'} = shift;    my $new_pass = shift || '';
   } elsif (@_ > 2) {    my $su       = shift || 'all';
     %cfg = @_;  
   }    unless (defined $new_pass) {
       $self->last_error("No new password");
   $cfg{'Timeout'} ||= $self->Timeout;      #return undef;
     }
   unless ($cfg{'String'}) {  
     #$! = "No command passed";    return $self->cmd(String => 'su password ' .
     #warn "No command passed\n";                       $su . ' ' .
     return undef;                       $new_pass . ' ' .
   }                       $new_pass,
                        expect => $success,
   unless ($self->is_connected) {                      );
     #$! = "Not connected";  }
     #warn "Not connected\n";  
     return undef;  =pod
   }  
   =item su_ipconfig
   unless ($self->logged_in) {  
     #$! = "Not logged in";  C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
     #warn "Not logged in\n";  
     return undef;  =cut
   }  
   sub su_ipconfig
   {
   my %cmd;          my $self        = shift;
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {          my $suid        = shift;
       $cmd{$_} = $cfg{$_};          my $new_ip      = shift;
     }          my $new_subnet  = shift;
   }          my $new_gateway = shift;
   if ($cfg{'args'}) {  
     $cmd{'String'} .= ' ' . $cfg{'args'};          if ($suid =~ /\D/) {
   }                  $self->last_error("Invalid suid '$suid'");
   my @lines = $self->SUPER::cmd(%cmd);                  return undef;
           }
   $self->last_lines(\@lines);          unless ($new_ip) {
                   $self->last_error("no new_ip passed");
   my $vals = 1;                  return undef;
   if ($cfg{'decode'}) {          }
     if ($cfg{'decode'} eq 'each') {          unless ($new_subnet) {
       $vals = _decode_each_line(@lines);                  $self->last_error("no new_subnet passed");
     } elsif ($cfg{'decode'} eq 'sulog') {                  return undef;
       $vals = _decode_sulog(@lines);          }
     } else {          unless ($new_gateway) {
       $vals = _decode_lines(@lines);                  $self->last_error("no new_gateway passed");
     }                  return undef;
   }          }
   
           # su ipconfig <suid> <new ip> <new subnet> <new gateway>
   my $last = $self->lastline;          return $self->cmd(String => 'su ipconfig ' .
                        $suid       . ' ' .
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {                       $new_ip     . ' ' .
     if ($cfg{'cmd_disconnects'}) {                       $new_subnet . ' ' .
       $self->logged_in(0);                       $new_gateway,
       $self->close;                       expect => $success,
       $self->is_connected(0);                      );
     }  }
   
     if ($cfg{'decode'}) {  =pod
       return $vals;  
     } else {  =item sudb_view
       return @lines;  
     }  returns a reference to an array of hashes each containing:
   } else {  
     #$! = "Error with command ($cfg{'string'}): $last";    suid
     return undef;    type
   }    cir
 }    mir
     mac
 #=item _decode_lines  
   =cut
 sub _decode_lines  
 {  sub sudb_view
   my @lines = @_;  {
     my $self = shift;
   my %conf;  
     my @lines = $self->cmd( String => 'sudb view', expect => $success );
   my $key = '';  
   my $val = '';    return undef unless @lines;
   my $in_key = 0;  
   my $in_val = 0;    unless ($PRIVATE{'Decode'}) {
       return @lines;
   foreach my $line (@lines) {    }
     next if $line =~ /$success$/;  
     my @sus;
     my @chars = split //, $line;    foreach (@lines) {
       next unless $_;
     my $last_key = '';      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
     foreach my $c (@chars) {        my %s = (
           suid => $1,
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {          type => $2,
         if ($c eq '[') {          cir  => $3,
           $in_key = 1;          mir  => $4,
           $in_val = 0;          mac  => $5,
         } else {        );
           $in_key = 0;  
           $in_val = 0;            $s{'mac'} =~ s/\s//g;
         }            $s{'mac'} = uc($s{'mac'});
   
         if ($key) {        push @sus, \%s;
           $key =~ s/^\s+//;      }
           $key =~ s/\s+$//;    }
   
           $val =~ s/^\s+//;    return \@sus;
           $val =~ s/\s+$//;  }
   
           if ($key eq 'Checksum' && $last_key) {  =pod
             # Special case for these bastids.  
             my $new = $last_key;  =item sudb_add
             $new =~ s/\s+\S+$//;  
             $key = $new . " " . $key;  Takes the following paramaters
           }  
           suid : numeric,
           $last_key = $key;          type : (reg|pr)
           $conf{$key} = $val;          cir  : numeric,
           $key = '';          mir  : numeric,
           $val = '';          mac  : Almost any format, it will be reformatted,
         }  
   and returns true on success or undef otherwise.
       } elsif ($c eq ']') {  
         $in_val = 1;  You should save_sudb() after calling this, or your changes  will be lost
         $in_key = 0;  when the AP is rebooted.
         $c = shift @chars;  
   =cut
       } elsif ($in_key) {  
         $key .= $c;  sub sudb_add
   {
       } elsif ($in_val) {          my $self = shift;
         $val .= $c;          my $suid = shift;
       }          my $type = shift;
     }          my $cir  = shift;
   }          my $mir  = shift;
           my $mac  = shift;
   if (%conf) {  
     return \%conf;          if ($suid =~ /\D/) {
   } else {                  $self->last_error("Invalid suid '$suid'");
     return undef;                  return undef;
   }          }
 }  
           unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
 #=item _decode_each_line                  $self->last_error("Invalid type '$type'");
                   return undef;
 sub _decode_each_line          }
 {  
   my @lines = @_;          if ($cir =~ /\D/) {
   my @decoded;                  $self->last_error("Invalid CIR '$cir'");
   foreach my $line (@lines) {                  return undef;
     my $decoded = _decode_lines($line);          }
     push @decoded, $decoded if defined $decoded;  
   }          if ($mir =~ /\D/) {
   return \@decoded;                  $self->last_error("Invalid MIR '$mir'");
 }                  return undef;
           }
 #=item _decode_sulog  
           my $new_mac = $mac;
 sub _decode_sulog          $new_mac =~ s/[^0-9A-Fa-f]//;
 {          unless (length $new_mac == 12) {
   my @lines = @_;                  $self->last_error("Invalid MAC '$mac'");
   my @decoded;                  return undef;
   my $last_tm;          }
   foreach my $line (@lines) {          $new_mac = join ' ', $new_mac =~ /../g;
     my $decoded = _decode_lines($line);  
           my $string = 'sudb add ' .
     if (defined $decoded) {                  $suid . ' ' .
       if ($decoded->{'tm'}) {                  $type . ' ' .
         $last_tm = $decoded->{'tm'};                  $cir  . ' ' .
         next;                  $mir  . ' ' .
       } else {                  $new_mac;
         $decoded->{'tm'} = $last_tm;  
       }  
       next unless $last_tm;          return $self->cmd( String => $string, expect => $success );
   }
       push @decoded, $decoded if defined $decoded;  
     }  =pod
   }  
   return \@decoded;  =item sudb_delete
 }  
   Takes either 'all' or the  suid of the su to delete
 1;  and returns true on success or undef otherwise.
 __END__  
   You should save_sudb() after calling this, or your changes  will be lost
 =back  when the AP is rebooted.
   
 =head1 SEE ALSO  =cut
   
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm  sub sudb_delete
   {
 L<Net::Telnet>          my $self = shift;
           my $suid = shift;
 =head1 TODO  
           #if (lc($suid) ne 'all' || $suid =~ /\D/) {
 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.          if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
 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.                  return undef;
           }
 =head1 AUTHOR  
           return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
 Andrew Fresh E<lt>andrew@rraz.netE<gt>  }
   
 =head1 COPYRIGHT AND LICENSE  =pod
   
 Copyright (C) 2005 by Andrew Fresh  =item sudb_modify
   
 This library is free software; you can redistribute it and/or modify  Takes either the  suid of the su to delete
 it under the same terms as Perl itself, either Perl version 5.8.7 or,  as well as what you are changing, either "cir, mir or su2su"
 at your option, any later version of Perl 5 you may have available.  and returns true on success or undef otherwise.
   
   cir and mir also take a value to set the cir/mir to.
 =cut  
   su2su takes a group id parameter that is in hex.
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_modify
   {
           my $self  = shift;
           my $suid  = shift;
           my $opt   = shift;
           my $value = shift;
   
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                   return undef;
           }
   
           if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                   if ($value =~ /\D/) {
                           $self->last_error("Invalid $opt '$value'");
                           return undef;
                   }
           } elsif (lc($opt) eq 'su2su') {
                   if ($value =~ /[^0-9A-Za-f]/) {
                           $self->last_error("Invalid MAC '$value'");
                           return undef;
                   }
           } else {
                   $self->last_error("Invalid option '$opt'");
                   return undef;
           }
   
           my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
   
           return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =item enable_tftpd
   
   runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
   =cut
   
   sub enable_tftpd
   {
     my $self = shift;
   
     my $vals = $self->tftpd( args => 'on' );
   
     if ($vals->{'Tftpd'} eq 'listen') {
       return $vals;
     } else {
       return undef;
     }
   }
   
   =pod
   
   =item disable_tftpd
   
   runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
   =cut
   
   sub disable_tftpd
   {
     my $self = shift;
   
     my $vals = $self->tftpd( args => 'off' );
   
     if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
       return $vals;
     } else {
       return undef;
     }
   }
   
   =pod
   
   =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.
   
   Normally returns the last lines from from the command
   
   Also accepts these options:
   
   I<decode>
   - if this is true, then it will send the output lines to _decode_lines()
   and then returns the decoded output
   
   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
   
   I<expect>
   - if this is set (usually to 'Success.') it will check for that in the
   last line of output and if it does not, will return undef because the
   command probably failed
   
   I<args>
   - a string containing the command line options that are passed to the
   command
   
   =cut
   
   sub cmd
   {
     my $self = shift;
   
     my @valid_net_telnet_opts = qw(
       String
       Output
       Cmd_remove_mode
       Errmode
       Input_record_separator
       Ors
       Output_record_separator
       Prompt
       Rs
       Timeout
     );
   
     my %cfg;
     if (@_ == 1) {
       $cfg{'String'} = shift;
     } elsif (@_ > 1) {
       %cfg = @_;
     }
   
     $cfg{'Timeout'} ||= $self->Timeout;
   
     unless ($cfg{'String'}) {
       $self->last_error("No command passed");
       return undef;
     }
   
     unless ($self->is_connected) {
       $self->last_error("Not connected");
       return undef;
     }
   
     unless ($self->logged_in) {
       $self->last_error("Not logged in");
       return undef;
     }
   
   
     my %cmd;
     foreach (@valid_net_telnet_opts) {
       if (exists $cfg{$_}) {
         $cmd{$_} = $cfg{$_};
       }
     }
     if ($cfg{'args'}) {
       $cmd{'String'} .= ' ' . $cfg{'args'};
     }
     my @lines;
     unless ($cfg{'no_prompt'}) {
       @lines = $self->SUPER::cmd(%cmd);
     } else {
       $self->print($cmd{'String'});
       @lines = $self->lastline;
     }
   
     $self->last_lines(\@lines);
   
     my $vals = 1;
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
       if ($cfg{'decode'} eq 'each') {
         $vals = _decode_each_line(@lines);
       } elsif ($cfg{'decode'} eq 'sulog') {
         $vals = _decode_sulog(@lines);
       } elsif ($cfg{'decode'} eq 'maclist') {
         $vals = _decode_maclist(@lines);
       } else {
         $vals = _decode_lines(@lines);
       }
     }
   
     $self->last_vals($vals);
   
   
     my $last = $self->lastline;
   
     if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
       if ($cfg{'cmd_disconnects'}) {
         $self->logged_in(0);
         $self->close;
         $self->is_connected(0);
       }
   
       if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
         return $vals;
       } else {
         return @lines;
       }
     } else {
       $self->last_error("Error with command ($cfg{'String'}): $last");
       return undef;
     }
   }
   
   #=item _decode_lines
   
   sub _decode_lines
   {
     my @lines = @_;
   
     my %conf;
   
     my $key = '';
     my $val = undef;
     my $in_key = 0;
     my $in_val = 1;
   
     foreach my $line (@lines) {
       next if $line =~ /$success$/;
   
       my @chars = split //, $line;
   
       my $last_key = '';
       foreach my $c (@chars) {
   
         if ($c eq '[' || $c eq "\r" || $c eq "\n") {
           if ($c eq '[') {
             $in_key = 1;
             $in_val = 0;
           } else {
             $in_key = 0;
             $in_val = 1;
           }
   
           if ($key) {
             $key =~ s/^\s+//;
             $key =~ s/\s+$//;
   
             if (defined $val) {
               $val =~ s/^\s+//;
               $val =~ s/\s+$//;
             }
   
             if ($key eq 'Checksum' && $last_key) {
               # Special case for these bastids.
               my $new = $last_key;
               $new =~ s/\s+\S+$//;
               $key = $new . " " . $key;
             }
   
             $last_key = $key;
             $conf{$key} = $val;
             $key = '';
             $val = '';
           }
   
         } elsif ($c eq ']') {
           $in_val = 1;
           $in_key = 0;
           $c = shift @chars;
   
         } elsif ($in_key) {
           $key .= $c;
   
         } elsif ($in_val) {
           $val .= $c;
         }
       }
     }
   
     if (%conf) {
       return \%conf;
     } else {
       return $val;
     }
   }
   
   #=item _decode_each_line
   
   sub _decode_each_line
   {
     my @lines = @_;
     my @decoded;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
       push @decoded, $decoded if defined $decoded;
     }
     return \@decoded;
   }
   
   #=item _decode_sulog
   
   sub _decode_sulog
   {
     my @lines = @_;
     my @decoded;
     my $last_tm;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
   
       if (defined $decoded) {
         if ($decoded->{'tm'}) {
           $last_tm = $decoded->{'tm'};
           next;
         } else {
           $decoded->{'tm'} = $last_tm;
         }
         next unless $last_tm;
   
         push @decoded, $decoded if defined $decoded;
       }
     }
     return \@decoded;
   }
   
   #=item _decode_maclist
   
   sub _decode_maclist
   {
           my @lines = @_;
           my @decoded;
           my $total_entries = 0;
           my $current_tm = 0;
           foreach my $line (@lines) {
                   $line =~ s/\r?\n$//;
                   my ($mac, $loc, $tm) = $line =~ /
                           ([0-9a-fA-F ]{17})\s+
                           (.*)\s+
                           tm\s+
                           (\d+)
                   /x;
   
                   if ($mac) {
                           $mac =~ s/\s+//g;
                           $loc =~ s/^\s+//;
                           $loc =~ s/\s+$//;
   
                           my $suid = undef;
                           if ($loc =~ /suid\s+=\s+(\d+)/) {
                                   $suid = $1;
                                   $loc = undef;
                           }
   
                           push @decoded, {
                                   mac  => $mac,
                                   loc  => $loc,
                                   tm   => $tm,
                                   suid => $suid,
                           };
                   } elsif ($line =~ /(\d+)\s+entries/) {
                           $total_entries = $1;
                   } elsif ($line =~ /current tm = (\d+)\s+sec/) {
                           $current_tm = $1
                   }
           }
   
           map { $_->{'cur_tm'} = $current_tm } @decoded;
   
           if (scalar @decoded == $total_entries) {
                   return \@decoded;
           } else {
                   # XXX we should have a way to set last error, not sure why we don't
                   return undef;
           }
   }
   
   1;
   __END__
   
   =back
   
   =head1 SEE ALSO
   
   Trango Documentation -
   http://www.trangobroadband.com/support/product_docs.htm
   
   L<Net::Telnet>
   
   =head1 TODO
   
   There are still a lot of commands that are not accessed directly.  If
   you call them (as cmd("command + args") or whatever) and it works,
   please send me examples that work and I will try to get it incorporated
   into the next version of the script.
   
   I also want to be able to parse the different types of output from
   commands like su, sudb all and anything else that would be better
   available as a perl datastructure.
   
   =head1 AUTHOR
   
   Andrew Fresh E<lt>andrew@rraz.netE<gt>
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005 by Andrew Fresh
   
   This library is free software; you can redistribute it and/or modify
   it under the same terms as Perl itself, either Perl version 5.8.7 or,
   at your option, any later version of Perl 5 you may have available.
   
   
   =cut
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.25
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>