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

version 1.3, 2005/12/30 19:26:06 version 1.24, 2007/01/17 19:00:51
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.23 2007/01/08 22:16:29 mike 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>  =back
 #  save <systemsetting|sudb>  
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  =head2 ALIASES
 #  updateflash <systemsetting|sudb>  
   =over
   
 my $success = 'Success.';  =item bye
 my %COMMANDS = (  
   tftpd       => { decode => 1, expect => $success },  alias of exit()
   ver         => { decode => 1 },  
   sysinfo     => { decode => 1, expect => $success },  =item restart
   updateflash => { decode => 1, expect => $success },  
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  alias of reboot()
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  
   #su password???  =back
   #_bootloader  
   #temp  =head2 COMMANDS
   #heater  
 );  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   as such they accept the same options as C<cmd()>.
 my %ALIASES = (  Specifically they take a named paramater "args", for example:
   bye     => 'exit',  C<tftpd(args =E<gt> 'on')> would enable tftpd
   restart => 'reboot',  
 );  =over
   
 my %ACCESS = map { $_ => 1 } qw(  =item tftpd
   firmware_version  
   host_type  Returns a hash ref of the decoded output from the command.
   Host  
   is_connected  Also see enable_tftpd() and disable_tftpd() as those check for correct output
   logged_in  
   login_banner  =item ver
   Timeout  
   last_lines  Returns a hash ref of the decoded output from the command.
 );  
   =item sysinfo
 sub AUTOLOAD  
 {  Returns a hash ref of the decoded output from the command.
   my $self = shift;  
   =item exit
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";  exits the command session with the trango and closes the connection
   
   if (exists $ALIASES{$method}) {  =item reboot
     $method = $ALIASES{$method};  
     return $self->$method(@_);  reboots the trango and closes the connection
   }  
   =item remarks
   if (exists $COMMANDS{$method}) {  
     $method = shift if (@_ == 1);  Takes an optional argument, which sets the remarks.
     $COMMANDS{$method}{'String'} ||= $method;  If there is no argument, returns the current remarks.
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  =item sulog
   
   if (exists $ACCESS{$method}) {  returns an array ref of hashes containing each log line.
     my $prev = $PRIVATE{$method};  
     ($PRIVATE{$method}) = @_ if @_;  =item save_sudb
     return $prev;  
   }  returns true on success, undef on failure
   
   $method = "SUPER::$method";  =item syslog
   return $self->$method(@_);  
 }  returns the output from the syslog command
   
 =pod  =item pipe
   
 =item new  returns the output from the pipe command
   
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  =item maclist
   
 =cut  returns the output from the maclist command
   
 sub new  =item maclist_reset
 {  
   my $class = shift;  resets the maclist.  No useful output.
   
   my %args;  =item eth_list
   if (@_ == 1) {  
     $args{'Host'} = shift;  returns the output from the eth list command
   } else {  
     %args = @_;  =item su_info
   }  
   You need to pass in args => <suid> and it will return the info for that suid.
   $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 . ":  $!";    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
   );
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  
   sub AUTOLOAD
 =cut  {
     my $self = shift;
 sub login  
 {    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
   my $self = shift;      or die "Weird: $AUTOLOAD";
   
   unless ($self->is_connected) {    if (exists $ALIASES{$method}) {
     $self->open or return undef;      $method = $ALIASES{$method};
   }      return $self->$method(@_);
     }
   my $password = shift;  
     if (exists $COMMANDS{$method}) {
   $self->print($password);      $COMMANDS{$method}{'String'} ||= $method;
   unless ($self->waitfor(      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
     -match => $self->prompt,      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     -errmode => "return",    }
   ) ) {  
     #$! = "login ($self->Host) failed: " . $self->lastline;    if (exists $ACCESS{$method}) {
     return undef;      my $prev = $PRIVATE{$method};
   }      ($PRIVATE{$method}) = @_ if @_;
       return $prev;
   $self->logged_in(1);    }
   
   return $self->logged_in;    $method = "SUPER::$method";
 }    return $self->$method(@_);
   }
 =pod  
   =pod
 =item parse_login_banner  
   =item open
 Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner()  
   Calls Net::Telnet::open() then makes sure you get a password prompt so
 =cut  you are ready to login() and parses the login banner so you can get
   host_type() and firmware_version()
 sub parse_login_banner  
 {  =cut
   my $self = shift;  
   sub open
   if (@_) {  {
     $self->login_banner(@_);    my $self = shift;
   }  
     unless ( $self->SUPER::open(@_) ) {
   my $banner = $self->login_banner;      #$! = "Couldn't connect to " . $self->Host . ":  $!";
       return undef;
   my ($type, $ver) = $banner =~    }
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  
     ## Get to login prompt
   $self->login_banner($banner);    unless ($self->waitfor(
   $self->host_type($type);        -match => '/password: ?$/i',
   $self->firmware_version($ver);        -errmode => "return",
       ) ) {
   return 1;      #$! = "problem connecting to host (" . $self->Host . "): " .
 }      #    $self->lastline;
       return undef;
 =pod    }
   
 =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  
 {  =pod
   my $self = shift;  
   =item login
   my $vals = $self->tftpd( args => 'on' );  
   Calls open() if not already connected, then sends the password and sets
   if ($vals->{'Tftpd'} eq 'listen') {  logged_in() if successful
     return $vals;  
   } else {  =cut
     return undef;  
   }  sub login
 }  {
     my $self = shift;
 =pod  
     unless ($self->is_connected) {
 =item disable_tftpd      $self->open or return undef;
     }
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  
     my $password = shift;
 =cut  
     $self->print($password);
 sub disable_tftpd    unless ($self->waitfor(
 {      -match => $self->prompt,
   my $self = shift;      -errmode => "return",
     ) ) {
   my $vals = $self->tftpd( args => 'off' );      #$! = "login ($self->Host) failed: " . $self->lastline;
       return undef;
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {    }
     return $vals;  
   } else {    $self->logged_in(1);
     return undef;  
   }    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)
   or reads what is already in login_banner() then parses it and sets
 Normally returns the last lines from from the command  host_type() and firmware_version() as well as login_banner()
   
 Also accepts these options:  =cut
   
 I<decode>  sub parse_login_banner
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output  {
     my $self = shift;
 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    if (@_) {
       $self->login_banner(@_);
 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  
     my $banner = $self->login_banner;
 I<args>  
 - a string containing the command line options that are passed to the command    my ($type, $ver) = $banner =~
       /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
 =cut  
     $self->login_banner($banner);
 sub cmd    $self->host_type($type);
 {    $self->firmware_version($ver);
   my $self = shift;  
     return 1;
   my @valid_net_telnet_opts = qw(  }
     String  
     Output  =pod
     Cmd_remove_mode  
     Errmode  =item su_password
     Input_record_separator  
     Ors  C<su_password('new_password'[, 'suid'])> If no suid is specified,
     Output_record_separator  the default is "all".
     Prompt  
     Rs  =cut
     Timeout  
   );  sub su_password
   {
   my %cfg;    my $self     = shift;
   if (@_ == 2) {    my $new_pass = shift || '';
     $cfg{'String'} = shift;    my $su       = shift || 'all';
   } elsif (@_ > 2) {  
     %cfg = @_;    unless (defined $new_pass) {
   }      warn "No new password!"
       #return undef;
   $cfg{'Timeout'} ||= $self->Timeout;    }
   
   unless ($cfg{'String'}) {    return $self->cmd(String => 'su password ' .
     #$! = "No command passed";                       $su . ' ' .
     #warn "No command passed\n";                       $new_pass . ' ' .
     return undef;                       $new_pass,
   }                       expect => $success,
                       );
   unless ($self->is_connected) {  }
     #$! = "Not connected";  
     #warn "Not connected\n";  =pod
     return undef;  
   }  =item su_ipconfig
   
   unless ($self->logged_in) {  C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
     #$! = "Not logged in";  
     #warn "Not logged in\n";  =cut
     return undef;  
   }  sub su_ipconfig
   {
           my $self        = shift;
   my %cmd;  
   foreach (@valid_net_telnet_opts) {          my $suid        = shift;
     if (exists $cfg{$_}) {          my $new_ip      = shift;
       $cmd{$_} = $cfg{$_};          my $new_subnet  = shift;
     }          my $new_gateway = shift;
   }  
   if ($cfg{'args'}) {          return undef unless $suid =~ /^\d+$/;
     $cmd{'String'} .= ' ' . $cfg{'args'};          return undef unless $new_ip;
   }          return undef unless $new_subnet;
   my @lines = $self->SUPER::cmd(%cmd);          return undef unless $new_gateway;
   
   $self->last_lines(\@lines);          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
   my $vals = 1;                       $suid       . ' ' .
   if ($cfg{'decode'}) {                       $new_ip     . ' ' .
     $vals = _decode_lines(@lines);                       $new_subnet . ' ' .
   }                       $new_gateway,
                        expect => $success,
                       );
   my $last = $self->lastline;  }
   
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  =pod
     if ($cfg{'cmd_disconnects'}) {  
       $self->logged_in(0);  =item sudb_view
       $self->close;  
       $self->is_connected(0);  returns a reference to an array of hashes each containing:
     }  
     suid
     if ($cfg{'decode'}) {    type
       return $vals;    cir
     } else {    mir
       return @lines;    mac
     }  
   } else {  =cut
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;  sub sudb_view
   }  {
 }    my $self = shift;
   
 #=item _decode_lines    my @lines = $self->cmd( String => 'sudb view', expect => $success );
   
 sub _decode_lines    return undef unless @lines;
 {  
   my @lines = @_;    unless ($PRIVATE{'Decode'}) {
       return @lines;
   my %conf;    }
   
   my $key = '';    my @sus;
   my $val = '';    foreach (@lines) {
   my $in_key = 0;      next unless $_;
   my $in_val = 0;      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
         my %s = (
   foreach my $line (@lines) {          suid => $1,
     my @chars = split //, $line;          type => $2,
           cir  => $3,
     my $last_key = '';          mir  => $4,
     foreach my $c (@chars) {          mac  => $5,
         );
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  
         if ($c eq '[') {            $s{'mac'} =~ s/\s//g;
           $in_key = 1;            $s{'mac'} = uc($s{'mac'});
           $in_val = 0;  
         } else {        push @sus, \%s;
           $in_key = 0;      }
           $in_val = 0;    }
         }  
     return \@sus;
         if ($key) {  }
           $key =~ s/^\s+//;  
           $key =~ s/\s+$//;  =pod
   
           $val =~ s/^\s+//;  =item sudb_add
           $val =~ s/\s+$//;  
   Takes the following paramaters
           if ($key eq 'Checksum' && $last_key) {  
             # Special case for these bastids.          suid : numeric,
             my $new = $last_key;          type : (reg|pr)
             $new =~ s/\s+\S+$//;          cir  : numeric,
             $key = $new . " " . $key;          mir  : numeric,
           }          mac  : Almost any format, it will be reformatted,
   
           $last_key = $key;  and returns true on success or undef otherwise.
           $conf{$key} = $val;  
           $key = '';  You should save_sudb() after calling this, or your changes  will be lost
           $val = '';  when the AP is rebooted.
         }  
   =cut
       } elsif ($c eq ']') {  
         $in_val = 1;  sub sudb_add
         $in_key = 0;  {
         $c = shift @chars;          my $self = shift;
           my $suid = shift;
       } elsif ($in_key) {          my $type = shift;
         $key .= $c;          my $cir  = shift;
           my $mir  = shift;
       } elsif ($in_val) {          my $mac  = shift;
         $val .= $c;  
       }          if ($suid =~ /\D/) {
     }                  return undef;
   }          }
   
   if (%conf) {          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
     return \%conf;                  warn "Invalid type '$type'!";
   } else {                  return undef;
     return \@lines;          }
   }  
 }          if ($cir =~ /\D/) {
                   warn "Invalid CIR '$cir'!";
 1;                  return undef;
 __END__          }
   
 =back          if ($mir =~ /\D/) {
                   warn "Invalid MIR '$mir'!";
 =head1 SEE ALSO                  return undef;
           }
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm  
           my $new_mac = $mac;
 L<Net::Telnet>          $new_mac =~ s/[^0-9A-Fa-f]//;
           unless (length $new_mac == 12) {
 =head1 TODO                  warn "Invalid MAC '$mac'!";
                   return undef;
 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.          }
           $new_mac = join ' ', $new_mac =~ /../g;
 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.  
           my $string = 'sudb add ' .
 =head1 AUTHOR                  $suid . ' ' .
                   $type . ' ' .
 Andrew Fresh E<lt>andrew@rraz.netE<gt>                  $cir  . ' ' .
                   $mir  . ' ' .
 =head1 COPYRIGHT AND LICENSE                  $new_mac;
   
 Copyright (C) 2005 by Andrew Fresh  
           return $self->cmd( String => $string, expect => $success );
 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.  =pod
   
   =item sudb_delete
 =cut  
   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.24
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>