[BACK]Return to Trango.pm CVS log [TXT][DIR] Up to [local] / trango / Net-Telnet-Trango / lib / Net / Telnet

Diff for /trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm between version 1.8 and 1.23

version 1.8, 2006/06/29 01:39:52 version 1.23, 2007/01/08 22:16:29
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.7 2006/06/28 22:33:18 andrew Exp $  # $RedRiver: Trango.pm,v 1.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 );
     
   $t->open( Host => $fox ) or die "Error connecting: $!";    $t->open( Host => $fox ) or die "Error connecting: $!";
   
   $t->login('password') or die "Couldn't log in: $!";    $t->login('password') or die "Couldn't log in: $!";
     
   # Do whatever    # Do whatever
     
   $t->exit;    $t->exit;
   $t->close;    $t->close;
   
 =head1 DESCRIPTION  =head1 DESCRIPTION
   
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  Perl access to the telnet interface on Trango Foxes, SUs and APs.
   
 Another handy feature is that it will parse the output from certain commands that is in the format "[key1] value1 [key2] value2" and put those in a hashref that is returned.  This makes using the output from things like sysinfo very easy to do.  Another handy feature is that it will parse the output from certain
   commands that is in the format "[key1] value1 [key2] value2" and put
 =head2 EXPORT  those in a hashref that is returned.  This makes using the output from
   things like sysinfo very easy to do.
 None  
   =head2 EXPORT
 =cut  
   None
 our $VERSION = '0.01';  
   =cut
 my %PRIVATE = (  
   is_connected => 0,  our $VERSION = '0.01';
   logged_in => 0,  
 );  my %PRIVATE = (
     is_connected => 0,
 =pod    logged_in => 0,
   );
 =item new  
   =pod
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  
   =item new
 =cut  
   Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
 sub new  
 {  It also takes an optional parameter 'Decode'.  If not defined it
   my $class = shift;  defaults to 1, if it is set to 0, it will not decode the output and
   instead return an array of the lines that were returned from the
   my %args;  command.
   if (@_ == 1) {  
     $args{'Host'} = shift;  =cut
   } else {  
     %args = @_;  sub new
   }  {
     my $class = shift;
   $args{'Prompt'}  ||= '/#> *$/';  
     my %args;
   foreach my $key (keys %args) {    if (@_ == 1) {
     $PRIVATE{$key} = $args{$key};      $args{'Host'} = shift;
   }    } else {
       %args = @_;
   my $self = $class->SUPER::new(%args);    }
   bless $self if ref $self;  
     $args{'Prompt'}  ||= '/#> *$/';
   return $self;  
 }    foreach my $key (keys %args) {
       $PRIVATE{$key} = $args{$key};
 #  _password <new password> <new password>    }
 #  ? [command]    $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...    delete $args{'Decode'};
 #  arp -bcast <on|off>  
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...    my $self = $class->SUPER::new(%args);
 #  bye    bless $self if ref $self;
 #  cf2cf ap [default|<size>]  
 #  date    return $self;
 #  date <month> <day> <year>  }
 #  freq scantable  
 #  freq channeltable  #  _password <new password> <new password>
 #  freq writescan [<ch#> <h|v>]  #  ? [command]
 #  freq writechannel [<ch#> <freq>] ...  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
 #  freq <ch #> <h|v>  #  arp -bcast <on|off>
 #  help [command]  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
 #  heater [<on temp> <off temp>]  #  bye
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  #  cf2cf ap [default|<size>]
 #  log [<# of entries, 1..179>]  #  date
 #  log <sum> <# of entries, 1..179>  #  date <month> <day> <year>
 #  logout  #  freq scantable
 #  opmode [ap [y]]  #  freq channeltable
 #  password  #  freq writescan [<ch#> <h|v>]
 #  ping <ip addr>  #  freq writechannel [<ch#> <freq>] ...
 #  polar <h|v>  #  freq <ch #> <h|v>
 #  power <setism|setunii> <max|min|<dBm>>  #  help [command]
 #  reboot  #  heater [<on temp> <off temp>]
 #  restart  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 #  remarks [<str>]  #  log [<# of entries, 1..179>]
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  #  log <sum> <# of entries, 1..179>
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  #  logout
 #  sysinfo  #  opmode [ap [y]]
 #  set suid <id>  #  password
 #  set apid <id>  #  ping <ip addr>
 #  set baseid <id>  #  polar <h|v>
 #  set defaultopmode [<ap|su> <min,0..10>]  #  power <setism|setunii> <max|min|<dBm>>
 #  set defaultopmode off  #  reboot
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  #  restart
 #  set mir [on|off]  #  remarks [<str>]
 #  set mir threshold <kbps>  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 #  set rssitarget [<ism|unii> <dBm>]  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 #  set serviceradius [<ism | unii> <miles>]  #  sysinfo
 #  ssrssi <ch #> <h|v>  #  set suid <id>
 #  su [<suid>|all]  #  set apid <id>
 #  su changechannel <all|suid> <ch#> <h|v>  #  set baseid <id>
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  #  set defaultopmode [<ap|su> <min,0..10>]
 #  su [live|poweroff|priority]  #  set defaultopmode off
 #  su <ping|info|status> <suid>  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
 #  su powerleveling <all|suid>  #  set mir [on|off]
 #  su reboot <all|suid>  #  set mir threshold <kbps>
 #  su restart <all|suid>  #  set rssitarget [<ism|unii> <dBm>]
 #  su testrflink <all|suid> [r]  #  set serviceradius [<ism | unii> <miles>]
 #  su testrflink <setlen> [64..1600]  #  ssrssi <ch #> <h|v>
 #  su testrflink <aptx> [20..100]  #  su [<suid>|all]
 #  su sw <suid|all> <sw #> <on|off>  #  su changechannel <all|suid> <ch#> <h|v>
 #  sudb [dload | view]  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  #  su [live|poweroff|priority]
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  #  su <ping|info|status> <suid>
 #  sudb delete <all|<suid>>  #  su powerleveling <all|suid>
 #  sudb modify <suid> <cir|mir> <kbps>  #  su reboot <all|suid>
 #  sudb modify <suid> <su2su> <group id,hex>  #  su restart <all|suid>
 #  sudb view  #  su testrflink <all|suid> [r]
 #  sulog [lastmins | sampleperiod <1..60>]  #  su testrflink <setlen> [64..1600]
 #  sulog [<# of entry,1..18>]  #  su testrflink <aptx> [20..100]
 #  survey <ism|unii> <time, sec> <h|v>  #  su sw <suid|all> <sw #> <on|off>
 #  sw [<sw #> <on|off>]  #  sudb [dload | view]
 #  temp  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
 #  tftpd [on|off]  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 #  time  #  sudb delete <all|<suid>>
 #  time <hour> <min> <sec>  #  sudb modify <suid> <cir|mir> <kbps>
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  #  sudb modify <suid> <su2su> <group id,hex>
 #  save <systemsetting|sudb>  #  sudb view
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  #  sulog [lastmins | sampleperiod <1..60>]
 #  updateflash <systemsetting|sudb>  #  sulog [<# of entry,1..18>]
   #  survey <ism|unii> <time, sec> <h|v>
 =pod  #  sw [<sw #> <on|off>]
   #  temp
 =head1 METHODS  #  tftpd [on|off]
   #  time
 =head2 ACCESSORS  #  time <hour> <min> <sec>
   #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 =over  #  save <systemsetting|sudb>
   #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 =item Host  #  updateflash <systemsetting|sudb>
   
 returns the name of the host that you are accessing  =pod
   
 =item firmware_version  =head1 METHODS
   
 returns the firmware version on the trango if available otherwise undef.    =head2 ACCESSORS
 Available after a successful open()  
 This is usually only set internally  =over
   
 =item host_type  =item Host
   
 returns the type of host from the login banner for example M5830S or M5300S.    returns the name of the host that you are accessing
 Available after a successful open()  
 This is usually only set internally  =item firmware_version
   
 =item is_connected  returns the firmware version on the trango if available otherwise undef.
   Available after a successful open()
 returns 1 after a successful open() otherwise undef  This is usually only set internally
 This is usually only set internally  
   =item host_type
 =item logged_in  
   returns the type of host from the login banner for example M5830S or M5300S.
 returns 1 after a successful login() 0 if it failed and undef if  Available after a successful open()
 login() was never called  This is usually only set internally
 This is usually only set internally  
   =item is_connected
 =item login_banner  
   returns 1 after a successful open() otherwise undef
 returns the banner that is displayed when first connected at login.  Only set after a successful open()  This is usually only set internally
   
 This is usually only set internally  =item logged_in
   
 =item last_lines  returns 1 after a successful login() 0 if it failed and undef if
   login() was never called
 returns the output from the last cmd() that was run as an array ref  This is usually only set internally
 This is usually only set internally  
   =item login_banner
 =back  
   returns the banner that is displayed when first connected at login.
 =head2 ALIASES  Only set after a successful open()
   
 =over  This is usually only set internally
   
 =item bye  =item last_lines
   
 alias of exit()  returns the output from the last cmd() that was run as an array ref
   This is usually only set internally
 =item restart  
   =back
 alias of reboot()  
   =head2 ALIASES
 =back  
   =over
 =head2 COMMANDS  
   =item bye
 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:  
 C<tftpd(args =E<gt> 'on')> would enable tftpd  alias of exit()
   
 =over  =item restart
   
 =item tftpd  alias of reboot()
   
 Returns a hash ref of the decoded output from the command.  =back
   
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  =head2 COMMANDS
   
 =item ver  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   as such they accept the same options as C<cmd()>.
 Returns a hash ref of the decoded output from the command.  Specifically they take a named paramater "args", for example:
   C<tftpd(args =E<gt> 'on')> would enable tftpd
 =item sysinfo  
   =over
 Returns a hash ref of the decoded output from the command.  
   =item tftpd
 =item exit  
   Returns a hash ref of the decoded output from the command.
 exits the command session with the trango and closes the connection  
   Also see enable_tftpd() and disable_tftpd() as those check for correct output
 =item reboot  
   =item ver
 reboots the trango and closes the connection  
   Returns a hash ref of the decoded output from the command.
 =item sulog  
   =item sysinfo
 returns an array ref of hashes containing each log line.  
   Returns a hash ref of the decoded output from the command.
 =item save_sudb  
   =item exit
 returns true on success, undef on failure  
   exits the command session with the trango and closes the connection
 =cut  
   =item reboot
   
 my $success = 'Success.';  reboots the trango and closes the connection
 my %COMMANDS = (  
   tftpd       => { decode => 'all',   expect => $success },  =item remarks
   ver         => { decode => 'all' },  
   sysinfo     => { decode => 'all',   expect => $success },  Takes an optional argument, which sets the remarks.
   updateflash => { decode => 'all',   expect => $success },  If there is no argument, returns the current remarks.
   sulog       => { decode => 'sulog', expect => $success },  
   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },  =item sulog
   reboot      => { no_prompt => 1, cmd_disconnects => 1 },  
   save_sudb   => { String => "save sudb", expect => $success },  returns an array ref of hashes containing each log line.
   #su password???  
   #_bootloader  =item save_sudb
   #temp  
   #heater  returns true on success, undef on failure
 );  
   =item syslog
 my %ALIASES = (  
   bye     => 'exit',  returns the output from the syslog command
   restart => 'reboot',  
 );  =item pipe
   
 my %ACCESS = map { $_ => 1 } qw(  returns the output from the pipe command
   firmware_version  
   host_type  =item maclist
   Host  
   is_connected  returns the output from the maclist command
   logged_in  
   login_banner  =item maclist_reset
   Timeout  
   last_lines  resets the maclist.  No useful output.
   last_vals  
 );  =item eth_list
   
 sub AUTOLOAD  returns the output from the eth list command
 {  
   my $self = shift;  =item su_info
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  You need to pass in args => <suid> and it will return the info for that suid.
     or die "Weird: $AUTOLOAD";  
   =item save_ss
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  saves the config.  Returns 1 on success, undef on failure.
     return $self->$method(@_);  
   }  =cut
   
   if (exists $COMMANDS{$method}) {  
     $method = shift if (@_ == 1);  my $success = 'Success.';
     $COMMANDS{$method}{'String'} ||= $method;  my %COMMANDS = (
     return $self->cmd(%{ $COMMANDS{$method} }, @_);    tftpd       => { decode => 'all',   expect => $success },
   }    ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
   if (exists $ACCESS{$method}) {    updateflash => { decode => 'all',   expect => $success },
     my $prev = $PRIVATE{$method};    sulog       => { decode => 'sulog', expect => $success },
     ($PRIVATE{$method}) = @_ if @_;    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
     return $prev;    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
   }    remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
   $method = "SUPER::$method";    syslog      => { expect => $success },
   return $self->$method(@_);    'pipe'      => { }, # XXX needs a special decode
 }    maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
 =pod    eth_link    => { String => 'eth link', expect => $success },
     su_info     => { String => 'su info', decode => 'all', expect => $success },
 =item open    save_ss     => { String => 'save ss', expect => $success },
     opmode      => { 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()    # eth r, w and reset???
     #su password???
 =cut    #_bootloader
     #temp
 sub open    #heater
 {  );
   my $self = shift;  
   my %ALIASES = (
   unless ( $self->SUPER::open(@_) ) {    bye     => 'exit',
     #$! = "Couldn't connect to " . $self->Host . ":  $!";    restart => 'reboot',
     return undef;  );
   }  
   my %ACCESS = map { $_ => 1 } qw(
   ## Get to login prompt    firmware_version
   unless ($self->waitfor(    host_type
       -match => '/password: ?$/i',    Host
       -errmode => "return",    is_connected
     ) ) {    logged_in
     #$! = "problem connecting to host (" . $self->Host . "): " .    login_banner
     #    $self->lastline;    Timeout
     return undef;    last_lines
   }    last_vals
   );
   $self->parse_login_banner($self->lastline);  
   sub AUTOLOAD
   $self->is_connected(1);  {
     my $self = shift;
   return $self->is_connected;  
 }    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
       or die "Weird: $AUTOLOAD";
 =pod  
     if (exists $ALIASES{$method}) {
 =item login      $method = $ALIASES{$method};
       return $self->$method(@_);
 Calls open() if not already connected, then sends the password and sets logged_in() if successful    }
   
 =cut    if (exists $COMMANDS{$method}) {
       $COMMANDS{$method}{'String'} ||= $method;
 sub login      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
 {      return $self->cmd(%{ $COMMANDS{$method} }, @_);
   my $self = shift;    }
   
   unless ($self->is_connected) {    if (exists $ACCESS{$method}) {
     $self->open or return undef;      my $prev = $PRIVATE{$method};
   }      ($PRIVATE{$method}) = @_ if @_;
       return $prev;
   my $password = shift;    }
   
   $self->print($password);    $method = "SUPER::$method";
   unless ($self->waitfor(    return $self->$method(@_);
     -match => $self->prompt,  }
     -errmode => "return",  
   ) ) {  =pod
     #$! = "login ($self->Host) failed: " . $self->lastline;  
     return undef;  =item open
   }  
   Calls Net::Telnet::open() then makes sure you get a password prompt so
   $self->logged_in(1);  you are ready to login() and parses the login banner so you can get
   host_type() and firmware_version()
   return $self->logged_in;  
 }  =cut
   
 =pod  sub open
   {
 =item parse_login_banner    my $self = shift;
   
 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()    unless ( $self->SUPER::open(@_) ) {
       #$! = "Couldn't connect to " . $self->Host . ":  $!";
 =cut      return undef;
     }
 sub parse_login_banner  
 {    ## Get to login prompt
   my $self = shift;    unless ($self->waitfor(
         -match => '/password: ?$/i',
   if (@_) {        -errmode => "return",
     $self->login_banner(@_);      ) ) {
   }      #$! = "problem connecting to host (" . $self->Host . "): " .
       #    $self->lastline;
   my $banner = $self->login_banner;      return undef;
     }
   my ($type, $ver) = $banner =~  
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;    $self->parse_login_banner($self->lastline);
   
   $self->login_banner($banner);    $self->is_connected(1);
   $self->host_type($type);  
   $self->firmware_version($ver);    return $self->is_connected;
   }
   return 1;  
 }  =pod
   
 =pod  =item login
   
 =item su_password  Calls open() if not already connected, then sends the password and sets
   logged_in() if successful
 C<su_password('all'|suid, 'new_password')>  
   =cut
 =cut  
   sub login
 sub su_password  {
 {    my $self = shift;
   my $self     = shift;  
   my $su       = shift || '!';    unless ($self->is_connected) {
   my $new_pass = shift || '';      $self->open or return undef;
     }
   unless (defined $su) {  
     warn "No su passed!"    my $password = shift;
     #return undef;  
   }    $self->print($password);
     unless ($self->waitfor(
   unless (defined $new_pass) {      -match => $self->prompt,
     warn "No new password!"        -errmode => "return",
     #return undef;    ) ) {
   }      #$! = "login ($self->Host) failed: " . $self->lastline;
       return undef;
   return $self->cmd(String => 'su password ' .    }
                      $su . ' ' .  
                      $new_pass . ' ' .    $self->logged_in(1);
                      $new_pass,  
                      expect => $success,    return $self->logged_in;
                     );  }
 }  
   =pod
   
 =pod  =item parse_login_banner
   
 =item sudb_view  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
 returns a reference to an array of hashes each containing:  host_type() and firmware_version() as well as login_banner()
   
   suid  =cut
   type  
   cir  sub parse_login_banner
   mir  {
   mac    my $self = shift;
   
 =cut    if (@_) {
       $self->login_banner(@_);
 sub sudb_view    }
 {  
   my $self = shift;    my $banner = $self->login_banner;
   
   my @lines = $self->cmd( String => 'sudb view', expect => $success );    my ($type, $ver) = $banner =~
       /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   return undef unless @lines;  
     $self->login_banner($banner);
   my @sus;    $self->host_type($type);
   foreach (@lines) {    $self->firmware_version($ver);
     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {  
       my %s = (    return 1;
         suid => $1,  }
         type => $2,  
         cir  => $3,  =pod
         mir  => $4,  
         mac  => $5,  =item su_password
       );  
   C<su_password('new_password'[, 'suid'])> If no suid is specified,
           $s{'mac'} =~ s/\s//g;  the default is "all".
           $s{'mac'} = uc($s{'mac'});  
   =cut
       push @sus, \%s;  
     }  sub su_password
   }  {
     my $self     = shift;
   return \@sus;    my $new_pass = shift || '';
 }    my $su       = shift || 'all';
   
 =pod    unless (defined $new_pass) {
       warn "No new password!"
 =item sudb_add      #return undef;
     }
 Takes the following paramaters  
     return $self->cmd(String => 'su password ' .
         suid : numeric,                       $su . ' ' .
         type : (reg|pr)                       $new_pass . ' ' .
         cir  : numeric,                       $new_pass,
         mir  : numeric,                       expect => $success,
         mac  : Almost any format, it will be reformatted,                      );
   }
 and returns true on success or undef otherwise.  
   =pod
 You should save_sudb() after calling this, or your changes  will be lost  
 when the AP is rebooted.  =item su_ipconfig
   
 =cut  C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
   
 sub sudb_add  =cut
 {  
         my $self = shift;  sub su_ipconfig
         my $suid = shift;  {
         my $type = shift;          my $self        = shift;
         my $cir  = shift;  
         my $mir  = shift;          my $suid        = shift;
         my $mac  = shift;          my $new_ip      = shift;
           my $new_subnet  = shift;
         if ($suid =~ /\D/) {          my $new_gateway = shift;
                 return undef;  
         }          return undef unless $suid =~ /^\d+$/;
           return undef unless $new_ip;
         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {          return undef unless $new_subnet;
                 warn "Invalid type '$type'!";          return undef unless $new_gateway;
                 return undef;  
         }          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
         if ($cir =~ /\D/) {                       $suid       . ' ' .
                 warn "Invalid CIR '$cir'!";                       $new_ip     . ' ' .
                 return undef;                       $new_subnet . ' ' .
         }                       $new_gateway,
                        expect => $success,
         if ($mir =~ /\D/) {                      );
                 warn "Invalid MIR '$mir'!";  }
                 return undef;  
         }  =pod
   
         my $new_mac = $mac;  =item sudb_view
         $new_mac =~ s/[^0-9A-Fa-f]//;  
         unless (length $new_mac == 12) {  returns a reference to an array of hashes each containing:
                 warn "Invalid MAC '$mac'!";  
                 return undef;    suid
         }    type
         $new_mac = join ' ', $new_mac =~ /../g;    cir
     mir
         my $string = 'sudb add ' .    mac
                 $suid . ' ' .  
                 $type . ' ' .  =cut
                 $cir  . ' ' .  
                 $mir  . ' ' .  sub sudb_view
                 $new_mac;  {
     my $self = shift;
   
         return $self->cmd( String => $string, expect => $success );    my @lines = $self->cmd( String => 'sudb view', expect => $success );
 }  
     return undef unless @lines;
 =pod  
     unless ($PRIVATE{'Decode'}) {
 =item sudb_delete      return @lines;
     }
 Takes either 'all' or the  suid of the su to delete  
 and returns true on success or undef otherwise.    my @sus;
     foreach (@lines) {
 You should save_sudb() after calling this, or your changes  will be lost      next unless $_;
 when the AP is rebooted.      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
         my %s = (
 =cut          suid => $1,
           type => $2,
 sub sudb_delete          cir  => $3,
 {          mir  => $4,
         my $self = shift;          mac  => $5,
         my $suid = shift;        );
   
         if (lc($suid) ne 'all' || $suid =~ /\D/) {            $s{'mac'} =~ s/\s//g;
                 return undef;            $s{'mac'} = uc($s{'mac'});
         }  
         push @sus, \%s;
         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );      }
 }    }
   
     return \@sus;
 =pod  }
   
 =item sudb_modify  =pod
   
 Takes either the  suid of the su to delete  =item sudb_add
 as well as what you are changing, either "cir, mir or su2su"  
 and returns true on success or undef otherwise.  Takes the following paramaters
   
 cir and mir also take a value to set the cir/mir to.          suid : numeric,
           type : (reg|pr)
 su2su takes a group id parameter that is in hex.          cir  : numeric,
           mir  : numeric,
 You should save_sudb() after calling this, or your changes  will be lost          mac  : Almost any format, it will be reformatted,
 when the AP is rebooted.  
   and returns true on success or undef otherwise.
 =cut  
   You should save_sudb() after calling this, or your changes  will be lost
 sub sudb_modify  when the AP is rebooted.
 {  
         my $self  = shift;  =cut
         my $suid  = shift;  
         my $opt   = shift;  sub sudb_add
         my $value = shift;  {
           my $self = shift;
         if ($suid =~ /\D/) {          my $suid = shift;
                 return undef;          my $type = shift;
         }          my $cir  = shift;
           my $mir  = shift;
         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {          my $mac  = shift;
                 if ($value =~ /\D/) {  
                         return undef;          if ($suid =~ /\D/) {
                 }                  return undef;
         } elsif (lc($opt) eq 'su2su') {          }
                 if ($value =~ /[^0-9A-Za-f]/) {  
                         return undef;          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                 }                  warn "Invalid type '$type'!";
         } else {                  return undef;
                 return undef;          }
         }  
           if ($cir =~ /\D/) {
         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;                  warn "Invalid CIR '$cir'!";
                   return undef;
         return $self->cmd( String => $string, expect => $success );          }
 }  
           if ($mir =~ /\D/) {
 =pod                  warn "Invalid MIR '$mir'!";
                   return undef;
 =item enable_tftpd          }
   
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing          my $new_mac = $mac;
           $new_mac =~ s/[^0-9A-Fa-f]//;
 =cut          unless (length $new_mac == 12) {
                   warn "Invalid MAC '$mac'!";
 sub enable_tftpd                  return undef;
 {          }
   my $self = shift;          $new_mac = join ' ', $new_mac =~ /../g;
   
   my $vals = $self->tftpd( args => 'on' );          my $string = 'sudb add ' .
                   $suid . ' ' .
   if ($vals->{'Tftpd'} eq 'listen') {                  $type . ' ' .
     return $vals;                  $cir  . ' ' .
   } else {                  $mir  . ' ' .
     return undef;                  $new_mac;
   }  
 }  
           return $self->cmd( String => $string, expect => $success );
 =pod  }
   
 =item disable_tftpd  =pod
   
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  =item sudb_delete
   
 =cut  Takes either 'all' or the  suid of the su to delete
   and returns true on success or undef otherwise.
 sub disable_tftpd  
 {  You should save_sudb() after calling this, or your changes  will be lost
   my $self = shift;  when the AP is rebooted.
   
   my $vals = $self->tftpd( args => 'off' );  =cut
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  sub sudb_delete
     return $vals;  {
   } else {          my $self = shift;
     return undef;          my $suid = shift;
   }  
 }          if (lc($suid) ne 'all' || $suid =~ /\D/) {
                   return undef;
 =pod          }
   
 =item cmd          return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
   }
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.  
   =pod
 Normally returns the last lines from from the command  
   =item sudb_modify
 Also accepts these options:  
   Takes either the  suid of the su to delete
 I<decode>  as well as what you are changing, either "cir, mir or su2su"
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output  and returns true on success or undef otherwise.
   
 I<cmd_disconnects>  cir and mir also take a value to set the cir/mir to.
 - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false  
   su2su takes a group id parameter that is in hex.
 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  You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
 I<args>  
 - a string containing the command line options that are passed to the command  =cut
   
 =cut  sub sudb_modify
   {
 sub cmd          my $self  = shift;
 {          my $suid  = shift;
   my $self = shift;          my $opt   = shift;
           my $value = shift;
   my @valid_net_telnet_opts = qw(  
     String          if ($suid =~ /\D/) {
     Output                  return undef;
     Cmd_remove_mode          }
     Errmode  
     Input_record_separator          if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
     Ors                  if ($value =~ /\D/) {
     Output_record_separator                          return undef;
     Prompt                  }
     Rs          } elsif (lc($opt) eq 'su2su') {
     Timeout                  if ($value =~ /[^0-9A-Za-f]/) {
   );                          return undef;
                   }
   my %cfg;          } else {
   if (@_ == 2) {                  return undef;
     $cfg{'String'} = shift;          }
   } elsif (@_ > 2) {  
     %cfg = @_;          my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
   }  
           return $self->cmd( String => $string, expect => $success );
   $cfg{'Timeout'} ||= $self->Timeout;  }
   
   unless ($cfg{'String'}) {  =pod
     #$! = "No command passed";  
     #warn "No command passed\n";  =item enable_tftpd
     return undef;  
   }  runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
   unless ($self->is_connected) {  =cut
     #$! = "Not connected";  
     #warn "Not connected\n";  sub enable_tftpd
     return undef;  {
   }    my $self = shift;
   
   unless ($self->logged_in) {    my $vals = $self->tftpd( args => 'on' );
     #$! = "Not logged in";  
     #warn "Not logged in\n";    if ($vals->{'Tftpd'} eq 'listen') {
     return undef;      return $vals;
   }    } else {
       return undef;
     }
   my %cmd;  }
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {  =pod
       $cmd{$_} = $cfg{$_};  
     }  =item disable_tftpd
   }  
   if ($cfg{'args'}) {  runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
     $cmd{'String'} .= ' ' . $cfg{'args'};  
   }  =cut
   my @lines;  
   unless ($cfg{'no_prompt'}) {  sub disable_tftpd
     @lines = $self->SUPER::cmd(%cmd);  {
   } else {    my $self = shift;
     $self->print($cmd{'String'});  
     @lines = $self->lastline;    my $vals = $self->tftpd( args => 'off' );
   }  
     if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
   $self->last_lines(\@lines);      return $vals;
     } else {
   my $vals = 1;      return undef;
   if ($cfg{'decode'}) {    }
     if ($cfg{'decode'} eq 'each') {  }
       $vals = _decode_each_line(@lines);  
     } elsif ($cfg{'decode'} eq 'sulog') {  =pod
       $vals = _decode_sulog(@lines);  
     } else {  =item cmd
       $vals = _decode_lines(@lines);  
     }  This does most of the work.  At the heart, it calls Net::Telnet::cmd()
   }  but it also does some special stuff for Trango.
   
   $self->last_vals($vals);  Normally returns the last lines from from the command
   
   Also accepts these options:
   my $last = $self->lastline;  
   I<decode>
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  - if this is true, then it will send the output lines to _decode_lines()
     if ($cfg{'cmd_disconnects'}) {  and then returns the decoded output
       $self->logged_in(0);  
       $self->close;  I<cmd_disconnects>
       $self->is_connected(0);  - 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 ($cfg{'decode'}) {  I<expect>
       return $vals;  - if this is set (usually to 'Success.') it will check for that in the
     } else {  last line of output and if it does not, will return undef because the
       return @lines;  command probably failed
     }  
   } else {  I<args>
     #$! = "Error with command ($cfg{'string'}): $last";  - a string containing the command line options that are passed to the
     return undef;  command
   }  
 }  =cut
   
 #=item _decode_lines  sub cmd
   {
 sub _decode_lines    my $self = shift;
 {  
   my @lines = @_;    my @valid_net_telnet_opts = qw(
       String
   my %conf;      Output
       Cmd_remove_mode
   my $key = '';      Errmode
   my $val = '';      Input_record_separator
   my $in_key = 0;      Ors
   my $in_val = 0;      Output_record_separator
       Prompt
   foreach my $line (@lines) {      Rs
     next if $line =~ /$success$/;      Timeout
     );
     my @chars = split //, $line;  
     my %cfg;
     my $last_key = '';    if (@_ == 1) {
     foreach my $c (@chars) {      $cfg{'String'} = shift;
     } elsif (@_ > 1) {
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {      %cfg = @_;
         if ($c eq '[') {    }
           $in_key = 1;  
           $in_val = 0;    $cfg{'Timeout'} ||= $self->Timeout;
         } else {  
           $in_key = 0;    unless ($cfg{'String'}) {
           $in_val = 0;      #$! = "No command passed";
         }      #warn "No command passed\n";
       return undef;
         if ($key) {    }
           $key =~ s/^\s+//;  
           $key =~ s/\s+$//;    unless ($self->is_connected) {
       #$! = "Not connected";
           $val =~ s/^\s+//;      #warn "Not connected\n";
           $val =~ s/\s+$//;      return undef;
     }
           if ($key eq 'Checksum' && $last_key) {  
             # Special case for these bastids.    unless ($self->logged_in) {
             my $new = $last_key;      #$! = "Not logged in";
             $new =~ s/\s+\S+$//;      #warn "Not logged in\n";
             $key = $new . " " . $key;      return undef;
           }    }
   
           $last_key = $key;  
           $conf{$key} = $val;    my %cmd;
           $key = '';    foreach (@valid_net_telnet_opts) {
           $val = '';      if (exists $cfg{$_}) {
         }        $cmd{$_} = $cfg{$_};
       }
       } elsif ($c eq ']') {    }
         $in_val = 1;    if ($cfg{'args'}) {
         $in_key = 0;      $cmd{'String'} .= ' ' . $cfg{'args'};
         $c = shift @chars;    }
     my @lines;
       } elsif ($in_key) {    unless ($cfg{'no_prompt'}) {
         $key .= $c;      @lines = $self->SUPER::cmd(%cmd);
     } else {
       } elsif ($in_val) {      $self->print($cmd{'String'});
         $val .= $c;      @lines = $self->lastline;
       }    }
     }  
   }    $self->last_lines(\@lines);
   
   if (%conf) {    my $vals = 1;
     return \%conf;    if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
   } else {      if ($cfg{'decode'} eq 'each') {
     return undef;        $vals = _decode_each_line(@lines);
   }      } elsif ($cfg{'decode'} eq 'sulog') {
 }        $vals = _decode_sulog(@lines);
       } elsif ($cfg{'decode'} eq 'maclist') {
 #=item _decode_each_line        $vals = _decode_maclist(@lines);
       } else {
 sub _decode_each_line        $vals = _decode_lines(@lines);
 {      }
   my @lines = @_;    }
   my @decoded;  
   foreach my $line (@lines) {    $self->last_vals($vals);
     my $decoded = _decode_lines($line);  
     push @decoded, $decoded if defined $decoded;  
   }    my $last = $self->lastline;
   return \@decoded;  
 }    if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
       if ($cfg{'cmd_disconnects'}) {
 #=item _decode_sulog        $self->logged_in(0);
         $self->close;
 sub _decode_sulog        $self->is_connected(0);
 {      }
   my @lines = @_;  
   my @decoded;      if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
   my $last_tm;        return $vals;
   foreach my $line (@lines) {      } else {
     my $decoded = _decode_lines($line);        return @lines;
       }
     if (defined $decoded) {    } else {
       if ($decoded->{'tm'}) {      #$! = "Error with command ($cfg{'string'}): $last";
         $last_tm = $decoded->{'tm'};      return undef;
         next;    }
       } else {  }
         $decoded->{'tm'} = $last_tm;  
       }  #=item _decode_lines
       next unless $last_tm;  
   sub _decode_lines
       push @decoded, $decoded if defined $decoded;  {
     }    my @lines = @_;
   }  
   return \@decoded;    my %conf;
 }  
     my $key = '';
 1;    my $val = undef;
 __END__    my $in_key = 0;
     my $in_val = 1;
 =back  
     foreach my $line (@lines) {
 =head1 SEE ALSO      next if $line =~ /$success$/;
   
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm      my @chars = split //, $line;
   
 L<Net::Telnet>      my $last_key = '';
       foreach my $c (@chars) {
 =head1 TODO  
         if ($c eq '[' || $c eq "\r" || $c eq "\n") {
 There are still a lot of commands that are not accessed directly.  If you call them (as cmd("command + args") or whatever) and it works, please send me examples that work and I will try to get it incorporated into the next version of the script.          if ($c eq '[') {
             $in_key = 1;
 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.            $in_val = 0;
           } else {
 =head1 AUTHOR            $in_key = 0;
             $in_val = 1;
 Andrew Fresh E<lt>andrew@rraz.netE<gt>          }
   
 =head1 COPYRIGHT AND LICENSE          if ($key) {
             $key =~ s/^\s+//;
 Copyright (C) 2005 by Andrew Fresh            $key =~ s/\s+$//;
   
 This library is free software; you can redistribute it and/or modify            if (defined $val) {
 it under the same terms as Perl itself, either Perl version 5.8.7 or,              $val =~ s/^\s+//;
 at your option, any later version of Perl 5 you may have available.              $val =~ s/\s+$//;
             }
   
 =cut            if ($key eq 'Checksum' && $last_key) {
               # Special case for these bastids.
               my $new = $last_key;
               $new =~ s/\s+\S+$//;
               $key = $new . " " . $key;
             }
   
             $last_key = $key;
             $conf{$key} = $val;
             $key = '';
             $val = '';
           }
   
         } elsif ($c eq ']') {
           $in_val = 1;
           $in_key = 0;
           $c = shift @chars;
   
         } elsif ($in_key) {
           $key .= $c;
   
         } elsif ($in_val) {
           $val .= $c;
         }
       }
     }
   
     if (%conf) {
       return \%conf;
     } else {
       return $val;
     }
   }
   
   #=item _decode_each_line
   
   sub _decode_each_line
   {
     my @lines = @_;
     my @decoded;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
       push @decoded, $decoded if defined $decoded;
     }
     return \@decoded;
   }
   
   #=item _decode_sulog
   
   sub _decode_sulog
   {
     my @lines = @_;
     my @decoded;
     my $last_tm;
     foreach my $line (@lines) {
       my $decoded = _decode_lines($line);
   
       if (defined $decoded) {
         if ($decoded->{'tm'}) {
           $last_tm = $decoded->{'tm'};
           next;
         } else {
           $decoded->{'tm'} = $last_tm;
         }
         next unless $last_tm;
   
         push @decoded, $decoded if defined $decoded;
       }
     }
     return \@decoded;
   }
   
   #=item _decode_maclist
   
   sub _decode_maclist
   {
           my @lines = @_;
           my @decoded;
           my $total_entries = 0;
           my $current_tm = 0;
           foreach my $line (@lines) {
                   $line =~ s/\r?\n$//;
                   my ($mac, $loc, $tm) = $line =~ /
                           ([0-9a-fA-F ]{17})\s+
                           (.*)\s+
                           tm\s+
                           (\d+)
                   /x;
   
                   if ($mac) {
                           $mac =~ s/\s+//g;
                           $loc =~ s/^\s+//;
                           $loc =~ s/\s+$//;
   
                           my $suid = undef;
                           if ($loc =~ /suid\s+=\s+(\d+)/) {
                                   $suid = $1;
                                   $loc = undef;
                           }
   
                           push @decoded, {
                                   mac  => $mac,
                                   loc  => $loc,
                                   tm   => $tm,
                                   suid => $suid,
                           };
                   } elsif ($line =~ /(\d+)\s+entries/) {
                           $total_entries = $1;
                   } elsif ($line =~ /current tm = (\d+)\s+sec/) {
                           $current_tm = $1
                   }
           }
   
           map { $_->{'cur_tm'} = $current_tm } @decoded;
   
           if (scalar @decoded == $total_entries) {
                   return \@decoded;
           } else {
                   # XXX we should have a way to set last error, not sure why we don't
                   return undef;
           }
   }
   
   1;
   __END__
   
   =back
   
   =head1 SEE ALSO
   
   Trango Documentation -
   http://www.trangobroadband.com/support/product_docs.htm
   
   L<Net::Telnet>
   
   =head1 TODO
   
   There are still a lot of commands that are not accessed directly.  If
   you call them (as cmd("command + args") or whatever) and it works,
   please send me examples that work and I will try to get it incorporated
   into the next version of the script.
   
   I also want to be able to parse the different types of output from
   commands like su, sudb all and anything else that would be better
   available as a perl datastructure.
   
   =head1 AUTHOR
   
   Andrew Fresh E<lt>andrew@rraz.netE<gt>
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005 by Andrew Fresh
   
   This library is free software; you can redistribute it and/or modify
   it under the same terms as Perl itself, either Perl version 5.8.7 or,
   at your option, any later version of Perl 5 you may have available.
   
   
   =cut

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.23

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