[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.6 and 1.24

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

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