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

version 1.6, 2006/06/28 23:00:15 version 1.21, 2006/10/05 18:10:39
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.20 2006/09/12 02:20: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.
 =cut  
   =item exit
   
 my $success = 'Success.';  exits the command session with the trango and closes the connection
 my %COMMANDS = (  
   tftpd       => { decode => 'all',   expect => $success },  =item reboot
   ver         => { decode => 'all' },  
   sysinfo     => { decode => 'all',   expect => $success },  reboots the trango and closes the connection
   updateflash => { decode => 'all',   expect => $success },  
   sulog       => { decode => 'sulog', expect => $success },  =item remarks
   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },  
   reboot      => { no_prompt => 1, cmd_disconnects => 1 },  Takes an optional argument, which sets the remarks.
   sudb_save   => { String => "sudb save", expect => $success },  If there is no argument, returns the current remarks.
   #su password???  
   #_bootloader  =item sulog
   #temp  
   #heater  returns an array ref of hashes containing each log line.
 );  
   =item save_sudb
 my %ALIASES = (  
   bye     => 'exit',  returns true on success, undef on failure
   restart => 'reboot',  
 );  =item syslog
   
 my %ACCESS = map { $_ => 1 } qw(  returns the output from the syslog command
   firmware_version  
   host_type  =item pipe
   Host  
   is_connected  returns the output from the pipe command
   logged_in  
   login_banner  =item maclist
   Timeout  
   last_lines  returns the output from the maclist command
   last_vals  
 );  =item maclist_reset
   
 sub AUTOLOAD  resets the maclist.  No useful output.
 {  
   my $self = shift;  =item eth_list
   
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  returns the output from the eth list command
     or die "Weird: $AUTOLOAD";  
   =item su_info
   if (exists $ALIASES{$method}) {  
     $method = $ALIASES{$method};  You need to pass in args => <suid> and it will return the info for that suid.
     return $self->$method(@_);  
   }  =item save_ss
   
   if (exists $COMMANDS{$method}) {  saves the config.  Returns 1 on success, undef on failure.
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  =cut
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  
   my $success = 'Success.';
   if (exists $ACCESS{$method}) {  my %COMMANDS = (
     my $prev = $PRIVATE{$method};    tftpd       => { decode => 'all',   expect => $success },
     ($PRIVATE{$method}) = @_ if @_;    ver         => { decode => 'all' },
     return $prev;    sysinfo     => { decode => 'all',   expect => $success },
   }    updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
   $method = "SUPER::$method";    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
   return $self->$method(@_);    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
 }    remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
 =pod    syslog      => { expect => $success },
     'pipe'      => { }, # XXX needs a special decode
 =item open    maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
 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_link    => { String => 'eth link', expect => $success },
     su_info     => { String => 'su info', decode => 'all', expect => $success },
 =cut    save_ss     => { String => 'save ss', expect => $success },
     opmode      => { decode => 'all',   expect => $success },
 sub open    # eth r, w and reset???
 {    #su password???
   my $self = shift;    #_bootloader
     #temp
   unless ( $self->SUPER::open(@_) ) {    #heater
     #$! = "Couldn't connect to " . $self->Host . ":  $!";  );
     return undef;  
   }  my %ALIASES = (
     bye     => 'exit',
   ## Get to login prompt    restart => 'reboot',
   unless ($self->waitfor(  );
       -match => '/password: ?$/i',  
       -errmode => "return",  my %ACCESS = map { $_ => 1 } qw(
     ) ) {    firmware_version
     #$! = "problem connecting to host (" . $self->Host . "): " .    host_type
     #    $self->lastline;    Host
     return undef;    is_connected
   }    logged_in
     login_banner
   $self->parse_login_banner($self->lastline);    Timeout
     last_lines
   $self->is_connected(1);    last_vals
   );
   return $self->is_connected;  
 }  sub AUTOLOAD
   {
 =pod    my $self = shift;
   
 =item login    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
       or die "Weird: $AUTOLOAD";
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  
     if (exists $ALIASES{$method}) {
 =cut      $method = $ALIASES{$method};
       return $self->$method(@_);
 sub login    }
 {  
   my $self = shift;    if (exists $COMMANDS{$method}) {
       $COMMANDS{$method}{'String'} ||= $method;
   unless ($self->is_connected) {      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
     $self->open or return undef;      return $self->cmd(%{ $COMMANDS{$method} }, @_);
   }    }
   
   my $password = shift;    if (exists $ACCESS{$method}) {
       my $prev = $PRIVATE{$method};
   $self->print($password);      ($PRIVATE{$method}) = @_ if @_;
   unless ($self->waitfor(      return $prev;
     -match => $self->prompt,    }
     -errmode => "return",  
   ) ) {    $method = "SUPER::$method";
     #$! = "login ($self->Host) failed: " . $self->lastline;    return $self->$method(@_);
     return undef;  }
   }  
   =pod
   $self->logged_in(1);  
   =item open
   return $self->logged_in;  
 }  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
 =pod  host_type() and firmware_version()
   
 =item parse_login_banner  =cut
   
 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()  sub open
   {
 =cut    my $self = shift;
   
 sub parse_login_banner    unless ( $self->SUPER::open(@_) ) {
 {      #$! = "Couldn't connect to " . $self->Host . ":  $!";
   my $self = shift;      return undef;
     }
   if (@_) {  
     $self->login_banner(@_);    ## Get to login prompt
   }    unless ($self->waitfor(
         -match => '/password: ?$/i',
   my $banner = $self->login_banner;        -errmode => "return",
       ) ) {
   my ($type, $ver) = $banner =~      #$! = "problem connecting to host (" . $self->Host . "): " .
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;      #    $self->lastline;
       return undef;
   $self->login_banner($banner);    }
   $self->host_type($type);  
   $self->firmware_version($ver);    $self->parse_login_banner($self->lastline);
   
   return 1;    $self->is_connected(1);
 }  
     return $self->is_connected;
 =pod  }
   
 =item su_password  =pod
   
 C<su_password('all'|suid, 'new_password')>  =item login
   
 =cut  Calls open() if not already connected, then sends the password and sets
   logged_in() if successful
 sub su_password  
 {  =cut
   my $self     = shift;  
   my $su       = shift || '!';  sub login
   my $new_pass = shift || '';  {
     my $self = shift;
   unless (defined $su) {  
     warn "No su passed!"    unless ($self->is_connected) {
     #return undef;      $self->open or return undef;
   }    }
   
   unless (defined $new_pass) {    my $password = shift;
     warn "No new password!"    
     #return undef;    $self->print($password);
   }    unless ($self->waitfor(
       -match => $self->prompt,
   return $self->cmd(String => 'su password ' .      -errmode => "return",
                      $su . ' ' .    ) ) {
                      $new_pass . ' ' .      #$! = "login ($self->Host) failed: " . $self->lastline;
                      $new_pass,      return undef;
                      expect => $success,    }
                     );  
 }    $self->logged_in(1);
   
     return $self->logged_in;
 =pod  }
   
 =item sudb_view  =pod
   
 returns a reference to an array of hashes each containing:  =item parse_login_banner
   
   suid  Takes a login banner (what you get when you first connect to the Trango)
   type  or reads what is already in login_banner() then parses it and sets
   cir  host_type() and firmware_version() as well as login_banner()
   mir  
   mac  =cut
   
 =cut  sub parse_login_banner
   {
 sub sudb_view    my $self = shift;
 {  
   my $self = shift;    if (@_) {
       $self->login_banner(@_);
   my @lines = $self->cmd( String => 'sudb view', expect => $success );    }
   
   return undef unless @lines;    my $banner = $self->login_banner;
   
   my @sus;    my ($type, $ver) = $banner =~
   foreach (@lines) {      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {  
       my %s = (    $self->login_banner($banner);
         suid => $1,    $self->host_type($type);
         type => $2,    $self->firmware_version($ver);
         cir  => $3,  
         mir  => $4,    return 1;
         mac  => $5,  }
       );  
   =pod
           $s{'mac'} =~ s/\s//g;  
           $s{'mac'} = uc($s{'mac'});  =item su_password
   
       push @sus, \%s;  C<su_password('all'|suid, 'new_password')>
     }  
   }  =cut
   
   return \@sus;  sub su_password
 }  {
     my $self     = shift;
 =pod    my $su       = shift || '!';
     my $new_pass = shift || '';
 =item sudb_add  
     unless (defined $su) {
 Takes the following paramaters      warn "No su passed!"
       #return undef;
         suid : numeric,    }
         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.21

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