[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.1 and 1.4

version 1.1, 2005/12/29 18:41:17 version 1.4, 2005/12/30 20:26:41
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
   # $RedRiver: Trango.pm,v 1.3 2005/12/30 19:26:06 andrew Exp $
   use strict;
   use warnings;
 use base 'Net::Telnet';  use base 'Net::Telnet';
   
   =pod
   
   =head1 NAME
   
   Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface
   
   =head1 SYNOPSIS
   
     use Net::Telnet::Trango;
     my $t = new Net::Telnet::Trango ( Timeout => 5 );
     
     my ($type, $version) = $t->open( Host => $fox );
     
     unless (defined $type && defined $version) {
       die "Error connecting: $!";
     }
   
     $t->login('password') or die "Couldn't log in: $!";
     
     # Do whatever
     
     $t->exit;
     $t->close;
   
   =head1 DESCRIPTION
   
   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.
   
   =head2 EXPORT
   
   None
   
   =cut
   
   our $VERSION = '0.01';
   
 my %PRIVATE = (  my %PRIVATE = (
   is_connected => 0,    is_connected => 0,
   logged_in => 0,    logged_in => 0,
 );  );
   
   =pod
   
   =item new
   
   Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
   
   =cut
   
   sub new
   {
     my $class = shift;
   
     my %args;
     if (@_ == 1) {
       $args{'Host'} = shift;
     } else {
       %args = @_;
     }
   
     $args{'Prompt'}  ||= '/#> *$/';
   
     foreach my $key (keys %args) {
       $PRIVATE{$key} = $args{$key};
     }
   
     my $self = $class->SUPER::new(%args);
     bless $self if ref $self;
   
     return $self;
   }
   
   #  _password <new password> <new password>
   #  ? [command]
   #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   #  arp -bcast <on|off>
   #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
   #  bye
   #  cf2cf ap [default|<size>]
   #  date
   #  date <month> <day> <year>
   #  freq scantable
   #  freq channeltable
   #  freq writescan [<ch#> <h|v>]
   #  freq writechannel [<ch#> <freq>] ...
   #  freq <ch #> <h|v>
   #  help [command]
   #  heater [<on temp> <off temp>]
   #  ipconfig [<new ip> <new subnet mask> <new gateway>]
   #  log [<# of entries, 1..179>]
   #  log <sum> <# of entries, 1..179>
   #  logout
   #  opmode [ap [y]]
   #  password
   #  ping <ip addr>
   #  polar <h|v>
   #  power <setism|setunii> <max|min|<dBm>>
   #  reboot
   #  restart
   #  remarks [<str>]
   #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  sysinfo
   #  set suid <id>
   #  set apid <id>
   #  set baseid <id>
   #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
   #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   #  set mir [on|off]
   #  set mir threshold <kbps>
   #  set rssitarget [<ism|unii> <dBm>]
   #  set serviceradius [<ism | unii> <miles>]
   #  ssrssi <ch #> <h|v>
   #  su [<suid>|all]
   #  su changechannel <all|suid> <ch#> <h|v>
   #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
   #  su [live|poweroff|priority]
   #  su <ping|info|status> <suid>
   #  su powerleveling <all|suid>
   #  su reboot <all|suid>
   #  su restart <all|suid>
   #  su testrflink <all|suid> [r]
   #  su testrflink <setlen> [64..1600]
   #  su testrflink <aptx> [20..100]
   #  su sw <suid|all> <sw #> <on|off>
   #  sudb [dload | view]
   #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
   #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
   #  sudb delete <all|<suid>>
   #  sudb modify <suid> <cir|mir> <kbps>
   #  sudb modify <suid> <su2su> <group id,hex>
   #  sudb view
   #  sulog [lastmins | sampleperiod <1..60>]
   #  sulog [<# of entry,1..18>]
   #  survey <ism|unii> <time, sec> <h|v>
   #  sw [<sw #> <on|off>]
   #  temp
   #  tftpd [on|off]
   #  time
   #  time <hour> <min> <sec>
   #  save <mainimage|fpgaimage> <current chksum> <new chksum>
   #  save <systemsetting|sudb>
   #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
   #  updateflash <systemsetting|sudb>
   
   =pod
   
   =head1 METHODS
   
   =head2 ACCESSORS
   
   =over
   
   =item Host
   
   returns the name of the host that you are accessing
   
   =item firmware_version
   
   returns the firmware version on the trango if available otherwise undef.  
   Available after a successful open()
   This is usually only set internally
   
   =item host_type
   
   returns the type of host from the login banner for example M5830S or M5300S.  
   Available after a successful open()
   This is usually only set internally
   
   =item is_connected
   
   returns 1 after a successful open() otherwise undef
   This is usually only set internally
   
   =item logged_in
   
   returns 1 after a successful login() 0 if it failed and undef if
   login() was never called
   This is usually only set internally
   
   =item login_banner
   
   returns the banner that is displayed when first connected at login.  Only set after a successful open()
   
   This is usually only set internally
   
   =item last_lines
   
   returns the output from the last cmd() that was run as an array ref
   This is usually only set internally
   
   =back
   
   =head2 ALIASES
   
   =over
   
   =item bye
   
   alias of exit()
   
   =item restart
   
   alias of reboot()
   
   =back
   
   =head2 COMMANDS
   
   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
   
   =item tftpd
   
   Returns a hash ref of the decoded output from the command.
   
   Also see enable_tftpd() and disable_tftpd() as those check for correct output
   
   =item ver
   
   Returns a hash ref of the decoded output from the command.
   
   =item sysinfo
   
   Returns a hash ref of the decoded output from the command.
   
   =item exit
   
   exits the command session with the trango and closes the connection
   
   =item reboot
   
   reboots the trango and closes the connection
   
   =item sulog
   
   returns an array ref of hashes containing each log line.
   
   =cut
   
   
   my $success = 'Success.';
   my %COMMANDS = (
     tftpd       => { decode => 'all',   expect => $success },
     ver         => { decode => 'all' },
     sysinfo     => { decode => 'all',   expect => $success },
     updateflash => { decode => 'all',   expect => $success },
     sulog       => { decode => 'sulog', expect => $success },
     'exit'      => { Prompt => '//', cmd_disconnects => 1 },
     reboot      => { Prompt => '//', cmd_disconnects => 1 },
     #su password???
     #_bootloader
     #temp
     #heater
   );
   
   my %ALIASES = (
     bye     => 'exit',
     restart => 'reboot',
   );
   
   my %ACCESS = map { $_ => 1 } qw(
     firmware_version
     host_type
     Host
     is_connected
     logged_in
     login_banner
     Timeout
     last_lines
   );
   
 sub AUTOLOAD  sub AUTOLOAD
 {  {
   my $self = shift;    my $self = shift;
Line 14 
Line 288 
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
     or die "Weird: $AUTOLOAD";      or die "Weird: $AUTOLOAD";
   
   my $success = 'Success.';    if (exists $ALIASES{$method}) {
   my %MEMBERS = (      $method = $ALIASES{$method};
     ver     => {},      return $self->$method(@_);
     sysinfo => { waitfor => $success },    }
     tftpd   => { waitfor => $success },  
   );  
   
   my %ACCESS = map { $_ => 1 } qw(    if (exists $COMMANDS{$method}) {
     firmware_version      $method = shift if (@_ == 1);
     host_type      $COMMANDS{$method}{'String'} ||= $method;
     Host      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     is_connected  
     logged_in  
     Timeout  
   );  
   
   if (exists $MEMBERS{$method}) {  
     return $self->cmd($method, $MEMBERS{$method}{waitfor});  
   }    }
   
   if (exists $ACCESS{$method}) {    if (exists $ACCESS{$method}) {
     my $var = shift || $PRIVATE{$method};      my $prev = $PRIVATE{$method};
     $PRIVATE{$method} = $var;      ($PRIVATE{$method}) = @_ if @_;
     return $var;      return $prev;
   }    }
   
   $method = "SUPER::$method";    $method = "SUPER::$method";
   return $self->$method(@_);    return $self->$method(@_);
 }  }
   
 sub new  =pod
 {  
   my $class = shift;  
   my $args = shift || {};  
   
   $args->{'Timeout'} ||= 5;  =item open
   $args->{'Prompt'}  ||= '/#> *$/';  
   
   foreach my $key (keys %{ $args }) {  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()
     $PRIVATE{$key} = $args->{$key};  
   }  
   
   my $self = $class->SUPER::new(%{ $args });  =cut
   bless $self;  
   
   #bless $self, $package;  sub open
   return $self;  
 }  
   
 sub connect  
 {  {
   my $self = shift;    my $self = shift;
   
   unless ( $self->open(    unless ( $self->SUPER::open(@_) ) {
       Host => $self->Host,      #$! = "Couldn't connect to " . $self->Host . ":  $!";
       Errmode => 'return',      return undef;
   ) ) {  
     $! = "Couldn't connect to $self->Host.  Connection timed out.";  
     return undef, undef;  
   }    }
   #$self->dump_log('dump.log');  
   
   ## Login to remote host.    ## Get to login prompt
   unless ($self->waitfor(    unless ($self->waitfor(
     -match => '/password: ?$/i',        -match => '/password: ?$/i',
     -errmode => "return",        -errmode => "return",
   ) ) {      ) ) {
     $! = "problem connecting to host ($self->Host): " . $self->lastline;      #$! = "problem connecting to host (" . $self->Host . "): " .
       #    $self->lastline;
     return undef;      return undef;
   }    }
   
   $self->login_banner($self->lastline);    $self->parse_login_banner($self->lastline);
   
   $self->is_connected(1);    $self->is_connected(1);
   
   return ($self->host_type, $self->firmware_version);    return $self->is_connected;
 }  }
   
   =pod
   
   =item login
   
   Calls open() if not already connected, then sends the password and sets logged_in() if successful
   
   =cut
   
 sub login  sub login
 {  {
   my $self = shift;    my $self = shift;
   
     unless ($self->is_connected) {
       $self->open or return undef;
     }
   
   my $password = shift;    my $password = shift;
   
   $self->print($password);    $self->print($password);
Line 103 
Line 366 
     -match => $self->prompt,      -match => $self->prompt,
     -errmode => "return",      -errmode => "return",
   ) ) {    ) ) {
     $! = "login ($self->Host) failed: " . $self->lastline;      #$! = "login ($self->Host) failed: " . $self->lastline;
     return undef;      return undef;
   }    }
   
Line 112 
Line 375 
   return $self->logged_in;    return $self->logged_in;
 }  }
   
 sub login_banner  =pod
   
   =item parse_login_banner
   
   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()
   
   =cut
   
   sub parse_login_banner
 {  {
   my $self = shift;    my $self = shift;
   
   my $banner = shift || $self->login_banner;    if (@_) {
       $self->login_banner(@_);
     }
   
     my $banner = $self->login_banner;
   
   my ($type, $ver) = $banner =~    my ($type, $ver) = $banner =~
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
   
     $self->login_banner($banner);
   $self->host_type($type);    $self->host_type($type);
   $self->firmware_version($ver);    $self->firmware_version($ver);
   
   return $banner;    return 1;
 }  }
   
 sub reboot  =pod
 {  
   my $self = shift;  
   
   $self->print("reboot\n");  =item enable_tftpd
   $self->getline;  
   
   return 1;  runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
 }  
   
 sub exit  =cut
   
   sub enable_tftpd
 {  {
   my $self = shift;    my $self = shift;
   
   $self->print("exit\n");    my $vals = $self->tftpd( args => 'on' );
   $self->getline;  
   
   return 1;    if ($vals->{'Tftpd'} eq 'listen') {
       return $vals;
     } else {
       return undef;
     }
 }  }
   
 sub enable_tftpd  =pod
   
   =item disable_tftpd
   
   runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
   =cut
   
   sub disable_tftpd
 {  {
   my $self = shift;    my $self = shift;
   
   my $vals = $self->cmd('tftpd on', 'Success.');    my $vals = $self->tftpd( args => 'off' );
   
   if ($vals->{'Tftpd'} eq 'listen') {    if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
     return $vals;      return $vals;
   } else {    } else {
     return undef;      return undef;
   }    }
 }  }
   
 sub updateflash  =pod
 {  
   my $self = shift;  
   
   my $old = shift;  =item cmd
   my $new = shift;  
   
   return undef unless $new;  This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.
   
   return $self->cmd("updateflash mainimage $old $new", 'Success.', 90);  Normally returns the last lines from from the command
 }  
   
   Also accepts these options:
   
   I<decode>
   - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output
   
   I<cmd_disconnects>
   - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false
   
   I<expect>
   - if this is set (usually to 'Success.') it will check for that in the last line of output and if it does not, will return undef because the command probably failed
   
   I<args>
   - a string containing the command line options that are passed to the command
   
   =cut
   
 sub cmd  sub cmd
 {  {
   my $self = shift;    my $self = shift;
   
   my $string = shift;    my @valid_net_telnet_opts = qw(
   my $expect_last = shift;      String
   my $timeout = shift || $self->Timeout;      Output
       Cmd_remove_mode
       Errmode
       Input_record_separator
       Ors
       Output_record_separator
       Prompt
       Rs
       Timeout
     );
   
   unless (defined $string) {    my %cfg;
     $! = "No command passed";    if (@_ == 2) {
       $cfg{'String'} = shift;
     } elsif (@_ > 2) {
       %cfg = @_;
     }
   
     $cfg{'Timeout'} ||= $self->Timeout;
   
     unless ($cfg{'String'}) {
       #$! = "No command passed";
       #warn "No command passed\n";
     return undef;      return undef;
   }    }
   
   unless ($self->is_connected) {    unless ($self->is_connected) {
     $! = "Not connected";      #$! = "Not connected";
       #warn "Not connected\n";
     return undef;      return undef;
   }    }
   
   unless ($self->logged_in) {    unless ($self->logged_in) {
     $! = "Not logged in";      #$! = "Not logged in";
       #warn "Not logged in\n";
     return undef;      return undef;
   }    }
   
   my @lines = $self->SUPER::cmd(String => $string, Timeout => $timeout);  
   
   my $vals = _decode_lines(@lines);    my %cmd;
     foreach (@valid_net_telnet_opts) {
       if (exists $cfg{$_}) {
         $cmd{$_} = $cfg{$_};
       }
     }
     if ($cfg{'args'}) {
       $cmd{'String'} .= ' ' . $cfg{'args'};
     }
     my @lines = $self->SUPER::cmd(%cmd);
   
   unless ($expect_last) {    $self->last_lines(\@lines);
     return $vals;  
     my $vals = 1;
     if ($cfg{'decode'}) {
       if ($cfg{'decode'} eq 'each') {
         $vals = _decode_each_line(@lines);
       } elsif ($cfg{'decode'} eq 'sulog') {
         $vals = _decode_sulog(@lines);
       } else {
         $vals = _decode_lines(@lines);
       }
   }    }
   
   
   my $last = $self->lastline;    my $last = $self->lastline;
   
   if ($last =~ /$expect_last$/) {    if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
     return $vals;      if ($cfg{'cmd_disconnects'}) {
         $self->logged_in(0);
         $self->close;
         $self->is_connected(0);
       }
   
       if ($cfg{'decode'}) {
         return $vals;
       } else {
         return @lines;
       }
   } else {    } else {
     warn "Error with command ($string): $last";      #$! = "Error with command ($cfg{'string'}): $last";
     return undef;      return undef;
   }    }
 }  }
   
   #=item _decode_lines
   
 sub _decode_lines  sub _decode_lines
 {  {
   my @lines = @_;    my @lines = @_;
Line 225 
Line 573 
   my $in_val = 0;    my $in_val = 0;
   
   foreach my $line (@lines) {    foreach my $line (@lines) {
       next if $line =~ /$success$/;
   
     my @chars = split //, $line;      my @chars = split //, $line;
   
     my $last_key = '';      my $last_key = '';
Line 272 
Line 622 
       }        }
     }      }
   }    }
   #print Dump \%conf;  
   
   if (%conf) {    if (%conf) {
     return \%conf;      return \%conf;
   } else {    } else {
     return \@lines;      return undef;
   }    }
 }  }
   
   #=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;
   }
   
   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.1  
changed lines
  Added in v.1.4
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>