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

version 1.3, 2005/12/30 19:26:06 version 1.22, 2007/01/03 19:40:03
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.21 2006/10/05 17:10:39 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  
   =cut
 =cut  
   our $VERSION = '0.01';
 our $VERSION = '0.01';  
   my %PRIVATE = (
 my %PRIVATE = (    is_connected => 0,
   is_connected => 0,    logged_in => 0,
   logged_in => 0,  );
 );  
   =pod
 =pod  
   =item new
 =head1 METHODS  
   Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
 =head2 ACCESSORS  
   It also takes an optional parameter 'Decode'.  If not defined it
 =over  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 Host  command.
   
 returns the name of the host that you are accessing  =cut
   
 =item firmware_version  sub new
   {
 returns the firmware version on the trango if available otherwise undef.      my $class = shift;
 Available after a successful open()  
 This is usually only set internally    my %args;
     if (@_ == 1) {
 =item host_type      $args{'Host'} = shift;
     } else {
 returns the type of host from the login banner for example M5830S or M5300S.        %args = @_;
 Available after a successful open()    }
 This is usually only set internally  
     $args{'Prompt'}  ||= '/#> *$/';
 =item is_connected  
     foreach my $key (keys %args) {
 returns 1 after a successful open() otherwise undef      $PRIVATE{$key} = $args{$key};
 This is usually only set internally    }
     $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
 =item logged_in    delete $args{'Decode'};
   
 returns 1 after a successful login() 0 if it failed and undef if    my $self = $class->SUPER::new(%args);
 login() was never called    bless $self if ref $self;
 This is usually only set internally  
     return $self;
 =item login_banner  }
   
 returns the banner that is displayed when first connected at login.  Only set after a successful open()  #  _password <new password> <new password>
   #  ? [command]
 This is usually only set internally  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   #  arp -bcast <on|off>
 =item last_lines  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
   #  bye
 returns the output from the last cmd() that was run as an array ref  #  cf2cf ap [default|<size>]
 This is usually only set internally  #  date
   #  date <month> <day> <year>
 =back  #  freq scantable
   #  freq channeltable
 =head2 ALIASES  #  freq writescan [<ch#> <h|v>]
   #  freq writechannel [<ch#> <freq>] ...
 =over  #  freq <ch #> <h|v>
   #  help [command]
 =item bye  #  heater [<on temp> <off temp>]
   #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 alias of exit()  #  log [<# of entries, 1..179>]
   #  log <sum> <# of entries, 1..179>
 =item restart  #  logout
   #  opmode [ap [y]]
 alias of reboot()  #  password
   #  ping <ip addr>
 =back  #  polar <h|v>
   #  power <setism|setunii> <max|min|<dBm>>
 =head2 COMMANDS  #  reboot
   #  restart
 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:  #  remarks [<str>]
 C<tftpd(args =E<gt> 'on')> would enable tftpd  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 =over  #  sysinfo
   #  set suid <id>
 =item tftpd  #  set apid <id>
   #  set baseid <id>
 Returns a hash ref of the decoded output from the command.  #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   #  set mir [on|off]
 =item ver  #  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 sysinfo  #  su [<suid>|all]
   #  su changechannel <all|suid> <ch#> <h|v>
 Returns a hash ref of the decoded output from the command.  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   #  su [live|poweroff|priority]
 =item exit  #  su <ping|info|status> <suid>
   #  su powerleveling <all|suid>
 exits the command session with the trango and closes the connection  #  su reboot <all|suid>
   #  su restart <all|suid>
 =item reboot  #  su testrflink <all|suid> [r]
   #  su testrflink <setlen> [64..1600]
 reboots the trango and closes the connection  #  su testrflink <aptx> [20..100]
   #  su sw <suid|all> <sw #> <on|off>
 =cut  #  sudb [dload | view]
   #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
 #  _password <new password> <new password>  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 #  ? [command]  #  sudb delete <all|<suid>>
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  #  sudb modify <suid> <cir|mir> <kbps>
 #  arp -bcast <on|off>  #  sudb modify <suid> <su2su> <group id,hex>
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...  #  sudb view
 #  bye  #  sulog [lastmins | sampleperiod <1..60>]
 #  cf2cf ap [default|<size>]  #  sulog [<# of entry,1..18>]
 #  date  #  survey <ism|unii> <time, sec> <h|v>
 #  date <month> <day> <year>  #  sw [<sw #> <on|off>]
 #  freq scantable  #  temp
 #  freq channeltable  #  tftpd [on|off]
 #  freq writescan [<ch#> <h|v>]  #  time
 #  freq writechannel [<ch#> <freq>] ...  #  time <hour> <min> <sec>
 #  freq <ch #> <h|v>  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 #  help [command]  #  save <systemsetting|sudb>
 #  heater [<on temp> <off temp>]  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  #  updateflash <systemsetting|sudb>
 #  log [<# of entries, 1..179>]  
 #  log <sum> <# of entries, 1..179>  =pod
 #  logout  
 #  opmode [ap [y]]  =head1 METHODS
 #  password  
 #  ping <ip addr>  =head2 ACCESSORS
 #  polar <h|v>  
 #  power <setism|setunii> <max|min|<dBm>>  =over
 #  reboot  
 #  restart  =item Host
 #  remarks [<str>]  
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  returns the name of the host that you are accessing
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  
 #  sysinfo  =item firmware_version
 #  set suid <id>  
 #  set apid <id>  returns the firmware version on the trango if available otherwise undef.
 #  set baseid <id>  Available after a successful open()
 #  set defaultopmode [<ap|su> <min,0..10>]  This is usually only set internally
 #  set defaultopmode off  
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  =item host_type
 #  set mir [on|off]  
 #  set mir threshold <kbps>  returns the type of host from the login banner for example M5830S or M5300S.
 #  set rssitarget [<ism|unii> <dBm>]  Available after a successful open()
 #  set serviceradius [<ism | unii> <miles>]  This is usually only set internally
 #  ssrssi <ch #> <h|v>  
 #  su [<suid>|all]  =item is_connected
 #  su changechannel <all|suid> <ch#> <h|v>  
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  returns 1 after a successful open() otherwise undef
 #  su [live|poweroff|priority]  This is usually only set internally
 #  su <ping|info|status> <suid>  
 #  su powerleveling <all|suid>  =item logged_in
 #  su reboot <all|suid>  
 #  su restart <all|suid>  returns 1 after a successful login() 0 if it failed and undef if
 #  su testrflink <all|suid> [r]  login() was never called
 #  su testrflink <setlen> [64..1600]  This is usually only set internally
 #  su testrflink <aptx> [20..100]  
 #  su sw <suid|all> <sw #> <on|off>  =item login_banner
 #  sudb [dload | view]  
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  returns the banner that is displayed when first connected at login.
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  Only set after a successful open()
 #  sudb delete <all|<suid>>  
 #  sudb modify <suid> <cir|mir> <kbps>  This is usually only set internally
 #  sudb modify <suid> <su2su> <group id,hex>  
 #  sudb view  =item last_lines
 #  sulog [lastmins | sampleperiod <1..60>]  
 #  sulog [<# of entry,1..18>]  returns the output from the last cmd() that was run as an array ref
 #  survey <ism|unii> <time, sec> <h|v>  This is usually only set internally
 #  sw [<sw #> <on|off>]  
 #  temp  =back
 #  tftpd [on|off]  
 #  time  =head2 ALIASES
 #  time <hour> <min> <sec>  
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  =over
 #  save <systemsetting|sudb>  
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  =item bye
 #  updateflash <systemsetting|sudb>  
   alias of exit()
   
 my $success = 'Success.';  =item restart
 my %COMMANDS = (  
   tftpd       => { decode => 1, expect => $success },  alias of reboot()
   ver         => { decode => 1 },  
   sysinfo     => { decode => 1, expect => $success },  =back
   updateflash => { decode => 1, expect => $success },  
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  =head2 COMMANDS
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  
   #su password???  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   #_bootloader  as such they accept the same options as C<cmd()>.
   #temp  Specifically they take a named paramater "args", for example:
   #heater  C<tftpd(args =E<gt> 'on')> would enable tftpd
 );  
   =over
 my %ALIASES = (  
   bye     => 'exit',  =item tftpd
   restart => 'reboot',  
 );  Returns a hash ref of the decoded output from the command.
   
 my %ACCESS = map { $_ => 1 } qw(  Also see enable_tftpd() and disable_tftpd() as those check for correct output
   firmware_version  
   host_type  =item ver
   Host  
   is_connected  Returns a hash ref of the decoded output from the command.
   logged_in  
   login_banner  =item sysinfo
   Timeout  
   last_lines  Returns a hash ref of the decoded output from the command.
 );  
   =item exit
 sub AUTOLOAD  
 {  exits the command session with the trango and closes the connection
   my $self = shift;  
   =item reboot
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";  reboots the trango and closes the connection
   
   if (exists $ALIASES{$method}) {  =item remarks
     $method = $ALIASES{$method};  
     return $self->$method(@_);  Takes an optional argument, which sets the remarks.
   }  If there is no argument, returns the current remarks.
   
   if (exists $COMMANDS{$method}) {  =item sulog
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  returns an array ref of hashes containing each log line.
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  =item save_sudb
   
   if (exists $ACCESS{$method}) {  returns true on success, undef on failure
     my $prev = $PRIVATE{$method};  
     ($PRIVATE{$method}) = @_ if @_;  =item syslog
     return $prev;  
   }  returns the output from the syslog command
   
   $method = "SUPER::$method";  =item pipe
   return $self->$method(@_);  
 }  returns the output from the pipe command
   
 =pod  =item maclist
   
 =item new  returns the output from the maclist command
   
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  =item maclist_reset
   
 =cut  resets the maclist.  No useful output.
   
 sub new  =item eth_list
 {  
   my $class = shift;  returns the output from the eth list command
   
   my %args;  =item su_info
   if (@_ == 1) {  
     $args{'Host'} = shift;  You need to pass in args => <suid> and it will return the info for that suid.
   } else {  
     %args = @_;  =item su_testrflink
   }  
   you need to pass in args => <suid> and it will return the rflink test results for that SU.
   $args{'Prompt'}  ||= '/#> *$/';  
   =item save_ss
   foreach my $key (keys %args) {  
     $PRIVATE{$key} = $args{$key};  saves the config.  Returns 1 on success, undef on failure.
   }  
   =cut
   my $self = $class->SUPER::new(%args);  
   bless $self if ref $self;  
   my $success = 'Success.';
   return $self;  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 . ":  $!";    su_testrflink=> { String => 'su testrflink', decode => 'each', expect => $success },
     return undef;    save_ss     => { String => 'save ss', expect => $success },
   }    opmode      => { decode => 'all',   expect => $success },
     # eth r, w and reset???
   ## Get to login prompt    #su password???
   unless ($self->waitfor(    #_bootloader
       -match => '/password: ?$/i',    #temp
       -errmode => "return",    #heater
     ) ) {  );
     #$! = "problem connecting to host (" . $self->Host . "): " .  
     #    $self->lastline;  my %ALIASES = (
     return undef;    bye     => 'exit',
   }    restart => 'reboot',
   );
   $self->parse_login_banner($self->lastline);  
   my %ACCESS = map { $_ => 1 } qw(
   $self->is_connected(1);    firmware_version
     host_type
   return $self->is_connected;    Host
 }    is_connected
     logged_in
 =pod    login_banner
     Timeout
 =item login    last_lines
     last_vals
 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(@_) ) {
       #$! = "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;      ) ) {
 }      #$! = "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' );    ) ) {
       #$! = "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('all'|suid, 'new_password')>
     Prompt  
     Rs  =cut
     Timeout  
   );  sub su_password
   {
   my %cfg;    my $self     = shift;
   if (@_ == 2) {    my $su       = shift || '!';
     $cfg{'String'} = shift;    my $new_pass = shift || '';
   } elsif (@_ > 2) {  
     %cfg = @_;    unless (defined $su) {
   }      warn "No su passed!"
       #return undef;
   $cfg{'Timeout'} ||= $self->Timeout;    }
   
   unless ($cfg{'String'}) {    unless (defined $new_pass) {
     #$! = "No command passed";      warn "No new password!"
     #warn "No command passed\n";      #return undef;
     return undef;    }
   }  
     return $self->cmd(String => 'su password ' .
   unless ($self->is_connected) {                       $su . ' ' .
     #$! = "Not connected";                       $new_pass . ' ' .
     #warn "Not connected\n";                       $new_pass,
     return undef;                       expect => $success,
   }                      );
   }
   unless ($self->logged_in) {  
     #$! = "Not logged in";  =pod
     #warn "Not logged in\n";  
     return undef;  =item su_ipconfig
   }  
   C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
   
   my %cmd;  =cut
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {  sub su_ipconfig
       $cmd{$_} = $cfg{$_};  {
     }          my $self        = shift;
   }  
   if ($cfg{'args'}) {          my $suid        = shift;
     $cmd{'String'} .= ' ' . $cfg{'args'};          my $new_ip      = shift;
   }          my $new_subnet  = shift;
   my @lines = $self->SUPER::cmd(%cmd);          my $new_gateway = shift;
   
   $self->last_lines(\@lines);          return undef unless $suid =~ /^\d+$/;
           return undef unless $new_ip;
   my $vals = 1;          return undef unless $new_subnet;
   if ($cfg{'decode'}) {          return undef unless $new_gateway;
     $vals = _decode_lines(@lines);  
   }          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
                        $suid       . ' ' .
   my $last = $self->lastline;                       $new_ip     . ' ' .
                        $new_subnet . ' ' .
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {                       $new_gateway,
     if ($cfg{'cmd_disconnects'}) {                       expect => $success,
       $self->logged_in(0);                      );
       $self->close;  }
       $self->is_connected(0);  
     }  =pod
   
     if ($cfg{'decode'}) {  =item sudb_view
       return $vals;  
     } else {  returns a reference to an array of hashes each containing:
       return @lines;  
     }    suid
   } else {    type
     #$! = "Error with command ($cfg{'string'}): $last";    cir
     return undef;    mir
   }    mac
 }  
   =cut
 #=item _decode_lines  
   sub sudb_view
 sub _decode_lines  {
 {    my $self = shift;
   my @lines = @_;  
     my @lines = $self->cmd( String => 'sudb view', expect => $success );
   my %conf;  
     return undef unless @lines;
   my $key = '';  
   my $val = '';    unless ($PRIVATE{'Decode'}) {
   my $in_key = 0;      return @lines;
   my $in_val = 0;    }
   
   foreach my $line (@lines) {    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 {                  return undef;
     return \@lines;          }
   }  
 }          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                   warn "Invalid type '$type'!";
 1;                  return undef;
 __END__          }
   
 =back          if ($cir =~ /\D/) {
                   warn "Invalid CIR '$cir'!";
 =head1 SEE ALSO                  return undef;
           }
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm  
           if ($mir =~ /\D/) {
 L<Net::Telnet>                  warn "Invalid MIR '$mir'!";
                   return undef;
 =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.          my $new_mac = $mac;
           $new_mac =~ s/[^0-9A-Fa-f]//;
 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.          unless (length $new_mac == 12) {
                   warn "Invalid MAC '$mac'!";
 =head1 AUTHOR                  return undef;
           }
 Andrew Fresh E<lt>andrew@rraz.netE<gt>          $new_mac = join ' ', $new_mac =~ /../g;
   
 =head1 COPYRIGHT AND LICENSE          my $string = 'sudb add ' .
                   $suid . ' ' .
 Copyright (C) 2005 by Andrew Fresh                  $type . ' ' .
                   $cir  . ' ' .
 This library is free software; you can redistribute it and/or modify                  $mir  . ' ' .
 it under the same terms as Perl itself, either Perl version 5.8.7 or,                  $new_mac;
 at your option, any later version of Perl 5 you may have available.  
   
           return $self->cmd( String => $string, expect => $success );
 =cut  }
   
   =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/) {
                   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/) {
                   return undef;
           }
   
           if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                   if ($value =~ /\D/) {
                           return undef;
                   }
           } elsif (lc($opt) eq 'su2su') {
                   if ($value =~ /[^0-9A-Za-f]/) {
                           return undef;
                   }
           } else {
                   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'}) {
       #$! = "No command passed";
       #warn "No command passed\n";
       return undef;
     }
   
     unless ($self->is_connected) {
       #$! = "Not connected";
       #warn "Not connected\n";
       return undef;
     }
   
     unless ($self->logged_in) {
       #$! = "Not logged in";
       #warn "Not logged in\n";
       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 {
       #$! = "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.22
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>