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

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