=================================================================== RCS file: /cvs/trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm,v retrieving revision 1.33 retrieving revision 1.34 diff -u -r1.33 -r1.34 --- trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/02/02 21:26:56 1.33 +++ trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/02/05 21:02:07 1.34 @@ -1,1211 +1,1222 @@ -package Net::Telnet::Trango; -# $RedRiver: Trango.pm,v 1.32 2007/02/02 18:59:50 andrew Exp $ -use strict; -use warnings; -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 ); - - $t->open( Host => $fox ) or 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 - -=head1 METHODS - -=over - -=cut - -our $VERSION = '0.01'; - -my %PRIVATE = ( - is_connected => 0, - logged_in => 0, -); - -=pod - -=item B - -- Creates a new Net::Telnet::Trango object. - - new([Options from Net::Telnet,] - [Decode => 0,]); - -Same as new from L but sets the default Trango Prompt: -'/#> *$/' - -It also takes an optional parameter 'Decode'. If not defined it -defaults to 1, if it is set to 0, it will not decode the output and -instead return a reference to an array of the lines that were returned -from the command. - -=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}; - } - $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'}; - delete $args{'Decode'}; - - my $self = $class->SUPER::new(%args); - bless $self if ref $self; - - return $self; -} - -# _password -# ? [command] -# apsearch [ ]... -# arp -bcast -# bcastscant [ ... -# bye -# cf2cf ap [default|] -# date -# date -# freq scantable -# freq channeltable -# freq writescan [ ] -# freq writechannel [ ] ... -# freq -# help [command] -# heater [ ] -# ipconfig [ ] -# log [<# of entries, 1..179>] -# log <# of entries, 1..179> -# logout -# opmode [ap [y]] -# password -# ping -# polar -# power > -# reboot -# restart -# remarks [] -# rfrxthreshold [ <-90|-85|-80|-75|-70|-65>] -# rfrxth [ <-90|-85|-80|-75|-70|-65>] -# sysinfo -# set suid -# set apid -# set baseid -# set defaultopmode [ ] -# set defaultopmode off -# set snmpcomm [ ] -# set mir [on|off] -# set mir threshold -# set rssitarget [ ] -# set serviceradius [ ] -# ssrssi -# su [|all] -# su changechannel -# su ipconfig -# su [live|poweroff|priority] -# su -# su powerleveling -# su reboot -# su restart -# su testrflink [r] -# su testrflink [64..1600] -# su testrflink [20..100] -# su sw -# sudb [dload | view] -# sudb add pr -# sudb add reg -# sudb delete > -# sudb modify -# sudb modify -# sudb view -# sulog [lastmins | sampleperiod <1..60>] -# sulog [<# of entry,1..18>] -# survey -# sw [ ] -# temp -# tftpd [on|off] -# time -# time -# save -# save -# updateflash -# updateflash - -=pod - -=back - -=head2 ACCESSORS - -These are usually only set internally. - -=over - -=item B - -- returns the firmware version - -Returns the firmware version if available, otherwise undef. - -It should be available after a successful open(). - -=item B - -- return the type of host you are connected to. - -returns the type of host from the login banner for example M5830S or M5300S. - -Should be available after a successful open(). - -=item B - -- Status of the connection to host. - -returns 1 when connected, undef otherwise. - -=item B - -- Status of being logged in to the host. - -returns 1 after a successful login(), 0 if it failed and undef if -login() was never called. - -=item B - -- The banner when first connecting to the host. - -returns the banner that is displayed when first connected at login. -Only set after a successful open(). - -=item B - -- The last lines of output from the last cmd(). - -returns, as an array ref, the output from the last cmd() that was run. - -=item B - -- A text output of the last error that was encountered. - -returns the last error reported. Probably contains the last entry in -last_lines. - -=back - -=head2 ALIASES - -=over - -=item B - -- alias of L. - -=item B - -- alias of L. - -=back - -=head2 COMMANDS - -Most of these are just shortcuts to C METHOD)>, -as such they accept the same options as C. -Specifically they take a named paramater "args", for example: -C 'on')> would enable tftpd - -=over - -=item B - -- Returns a hash ref of the decoded output from the -command. - -Also see enable_tftpd() and disable_tftpd() as those check that it was -successfully changed. - -=item B - -- Returns a hash ref of the decoded output from the -command. - -=item B - -- Returns a hash ref of the decoded output from the -command. - -=item B - -- exits the command session with the Trango and closes -the connection - -=item B - -- reboots the Trango and closes the connection - -=item B - -- Set or retrieve the remarks. - -Takes an optional argument, which sets the remarks. -If there is no argument, returns the current remarks. - - my $old_remarks = $t->remarks(); - $t->remarks($new_remarks); - -=item B - -- returns an array ref of hashes containing each log -line. - -=item B - -- returns true on success, undef on failure - -=item B - -- returns the output from the syslog command - -=item B - -- returns the output from the pipe command - -=item B - -- returns the output from the maclist command - -=item B - -- resets the maclist. - -No useful output. - -=item B - -- returns the output from the eth list command - -=item B - -- returns information about the SU. - -You need to pass in the $suid and it will return the info for that suid. - - $t->su_info($suid); - -=item B - -- tests the RF Link to an su - - $t->su_testrflink($suid|'all'); - -=item B - -- saves the config. - -Returns 1 on success, undef on failure. - -=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' => { no_prompt => 1, cmd_disconnects => 1 }, - reboot => { no_prompt => 1, cmd_disconnects => 1 }, - remarks => { decode => 'all', expect => $success }, - save_sudb => { String => 'save sudb', expect => $success }, - syslog => { expect => $success }, - 'pipe' => { }, # XXX needs a special decode - maclist => { decode => 'maclist' }, - maclist_reset => { String => 'maclist reset', expect => 'done' }, - eth_link => { String => 'eth link', expect => $success }, - su_info => { String => 'su info', decode => 'all', expect => $success }, - su_testrflink => { String => 'su testrflink', decode => 'each', expect => $success }, - save_ss => { String => 'save ss', expect => $success }, - opmode => { decode => 'all', expect => $success }, - # eth r, w and reset??? - #su password??? - #_bootloader - #temp - #heater -); - -my %ALIASES = ( - bye => 'exit', - restart => 'reboot', - Host => 'host', -); - -my %ACCESS = map { $_ => 1 } qw( - firmware_version - host_type - is_connected - logged_in - login_banner - Timeout - last_lines - last_vals - last_error - Decode -); - -sub AUTOLOAD -{ - my $self = shift; - - my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/ - or die "Weird: $AUTOLOAD"; - - if (exists $ALIASES{$method}) { - $method = $ALIASES{$method}; - return $self->$method(@_); - } - - if (exists $COMMANDS{$method}) { - my %cmd; - foreach my $k (keys %{ $COMMANDS{$method} }) { - $cmd{$k} = $COMMANDS{$method}{$k}; - } - $cmd{'String'} ||= $method; - $cmd{'args'} .= ' ' . shift if (@_ == 1); - return $self->cmd(%cmd, @_); - } - - if (exists $ACCESS{$method}) { - my $prev = $PRIVATE{$method}; - ($PRIVATE{$method}) = @_ if @_; - return $prev; - } - - $method = "SUPER::$method"; - return $self->$method(@_); -} - -=pod - -=item B - -- Open a connection to a Trango AP. - -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() - -=cut - -sub open -{ - my $self = shift; - - unless ( $self->SUPER::open(@_) ) { - $self->last_error("Couldn't connect to " . $self->host . ": $!"); - return; - } - - ## Get to login prompt - unless ($self->waitfor( - -match => '/password: ?$/i', - -errmode => "return", - ) ) { - $self->last_error("problem connecting to host (" . $self->host . "): " . - $self->lastline); - return; - } - - $self->parse_login_banner($self->lastline); - - $self->is_connected(1); - - return $self->is_connected; -} - -=pod - -=item B - -- Login to the AP. - -Calls open() if not already connected, then sends the password and sets -logged_in() if successful - -=cut - -sub login -{ - my $self = shift; - - unless ($self->is_connected) { - $self->open or return; - } - - my $password = shift; - - $self->print($password); - unless ($self->waitfor( - -match => $self->prompt, - -errmode => "return", - ) ) { - $self->last_error("login ($self->host) failed: " . $self->lastline); - return; - } - - $self->logged_in(1); - - return $self->logged_in; -} - -=pod - -=item B - -- Converts the login_banner to some useful -variables. - -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; - - if (@_) { - $self->login_banner(@_); - } - - my $banner = $self->login_banner; - - my ($type, $sep1, $subtype, $sep2, $ver) = $banner =~ - /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i; - - $type .= $sep1 . $subtype; - $ver = $subtype . $sep2 . $ver; - - $self->login_banner($banner); - $self->host_type($type); - $self->firmware_version($ver); - - return 1; -} - -=pod - -=item B - -- Set the password on SUs connected to the AP. - -su_password('new_password'[, 'suid']) If no suid is specified, -the default is "all". - - $t->su_password('good_pass', 5); - -=cut - -sub su_password -{ - my $self = shift; - my $new_pass = shift || ''; - my $su = shift || 'all'; - - unless (defined $new_pass) { - $self->last_error("No new password"); - #return; - } - - return $self->cmd(String => 'su password ' . - $su . ' ' . - $new_pass . ' ' . - $new_pass, - expect => $success, - ); -} - -=pod - -=item B - -- Change IP configuration on SUs connected to -the AP. - -su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' ) - - $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' ); - -=cut - -sub su_ipconfig -{ - my $self = shift; - - my $suid = shift; - my $new_ip = shift; - my $new_subnet = shift; - my $new_gateway = shift; - - if ($suid =~ /\D/) { - $self->last_error("Invalid suid '$suid'"); - return; - } - unless ($new_ip) { - $self->last_error("no new_ip passed"); - return; - } - unless ($new_subnet) { - $self->last_error("no new_subnet passed"); - return; - } - unless ($new_gateway) { - $self->last_error("no new_gateway passed"); - return; - } - - # su ipconfig - return $self->cmd(String => 'su ipconfig ' . - $suid . ' ' . - $new_ip . ' ' . - $new_subnet . ' ' . - $new_gateway, - expect => $success, - ); -} - -=pod - -=item B - -- Returns the output from the sudb view command - -returns a reference to an array of hashes each containing these keys -'suid', 'type', 'cir', 'mir' and 'mac' - -=cut - -sub sudb_view -{ - my $self = shift; - - my $lines = $self->cmd( String => 'sudb view', expect => $success ) || []; - - return unless @{ $lines }; - - unless ($PRIVATE{'Decode'}) { - return $lines; - } - - my @sus; - foreach (@{ $lines }) { - next unless $_; - if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) { - my %s = ( - suid => $1, - type => $2, - cir => $3, - mir => $4, - mac => $5, - ); - - $s{'mac'} =~ s/\s//g; - $s{'mac'} = uc($s{'mac'}); - - push @sus, \%s; - } - } - - return \@sus; -} - -=pod - -=item B - -Takes the following paramaters - - suid : numeric, - type : (reg|pr) - cir : numeric, - mir : numeric, - mac : Almost any format, it will be reformatted, - -and returns true on success or undef otherwise. - - $t->sudb_add($suid, 'reg', $cir, $mir, $mac); - -You should save_sudb() after calling this, or your changes will be lost -when the AP is rebooted. - -=cut - -sub sudb_add -{ - my $self = shift; - my $suid = shift; - my $type = shift; - my $cir = shift; - my $mir = shift; - my $mac = shift; - - if ($suid =~ /\D/) { - $self->last_error("Invalid suid '$suid'"); - return; - } - - unless (lc($type) eq 'reg' || lc($type) eq 'pr') { - $self->last_error("Invalid type '$type'"); - return; - } - - if ($cir =~ /\D/) { - $self->last_error("Invalid CIR '$cir'"); - return; - } - - if ($mir =~ /\D/) { - $self->last_error("Invalid MIR '$mir'"); - return; - } - - my $new_mac = $mac; - $new_mac =~ s/[^0-9A-Fa-f]//; - unless (length $new_mac == 12) { - $self->last_error("Invalid MAC '$mac'"); - return; - } - $new_mac = join ' ', $new_mac =~ /../g; - - my $string = 'sudb add ' . - $suid . ' ' . - $type . ' ' . - $cir . ' ' . - $mir . ' ' . - $new_mac; - - - return $self->cmd( String => $string, expect => $success ); -} - -=pod - -=item B - -Takes either 'all' or the suid of the su to delete -and returns true on success or undef otherwise. - - $t->sudb_delete($suid); - -You should save_sudb() after calling this, or your changes will be lost -when the AP is rebooted. - -=cut - -sub sudb_delete -{ - my $self = shift; - my $suid = shift; - - #if (lc($suid) ne 'all' || $suid =~ /\D/) { - if ($suid =~ /\D/) { - $self->last_error("Invalid suid '$suid'"); - return; - } - - return $self->cmd( String => 'sudb delete ' . $suid, expect => $success ); -} - -=pod - -=item B - -Takes either the suid of the su to change -as well as what you are changing, either "cir, mir or su2su" -and returns true on success or undef otherwise. - -cir and mir also take a value to set the cir/mir to. - -su2su takes a group id parameter that is in hex. - - $t->sudb_modify($suid, 'cir', 512); - -You should save_sudb() after calling this, or your changes will be lost -when the AP is rebooted. - -=cut - -sub sudb_modify -{ - my $self = shift; - my $suid = shift; - my $opt = shift; - my $value = shift; - - if ($suid =~ /\D/) { - $self->last_error("Invalid suid '$suid'"); - return; - } - - if (lc($opt) eq 'cir' or lc($opt) eq 'mir') { - if ($value =~ /\D/) { - $self->last_error("Invalid $opt '$value'"); - return; - } - } elsif (lc($opt) eq 'su2su') { - if ($value =~ /[^0-9A-Za-f]/) { - $self->last_error("Invalid MAC '$value'"); - return; - } - } else { - $self->last_error("Invalid option '$opt'"); - return; - } - - my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value; - - return $self->cmd( String => $string, expect => $success ); -} - -=pod - -=item B - -- enable the TFTP server - -runs C 'on')> and makes sure that Tftpd is now 'listen'ing - -=cut - -sub enable_tftpd -{ - my $self = shift; - - my $vals = $self->tftpd( args => 'on' ); - - if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen') { - return $vals; - } else { - return; - } -} - -=pod - -=item B - -- disable the TFTP server - -runs C 'off')> and makes sure that Tftpd is now 'disabled' - -=cut - -sub disable_tftpd -{ - my $self = shift; - - my $vals = $self->tftpd( args => 'off' ); - - if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') { - return $vals; - } else { - return; - } -} - -=pod - -=item B - -- runs a command on the AP. - -This does most of the work. At the heart, it calls Net::Telnet::cmd() -but it also does some special stuff for Trango. - -Normally returns the last lines from from the command - -If you are using this, rather than one of the "easy" methods above, -you probably want to read through the source of this module to see how -some of the other commands are called. - -In addition to the Net::Telnet::cmd() options, it also accepts these: - -I - -- if this is true, then it will send the output lines to _decode_lines() -and then returns the decoded output - -I - -- if this is true, it does not wait for a prompt, so you are not stuck -waiting for something that will never happen. - -I - -- if this is true, it then sets logged_in() to false, then it will -close() the connection and set is_connected() to false - -I - -- 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 - -- a string containing the command line options that are passed to the -command - - $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); - -=cut - -sub cmd -{ - my $self = shift; - - my @valid_net_telnet_opts = qw( - String - Output - Cmd_remove_mode - Errmode - Input_record_separator - Ors - Output_record_separator - Prompt - Rs - Timeout - ); - - my %cfg; - if (@_ == 1) { - $cfg{'String'} = shift; - } elsif (@_ > 1) { - %cfg = @_; - } - - $cfg{'Timeout'} ||= $self->Timeout; - - unless ($cfg{'String'}) { - $self->last_error("No command passed"); - return; - } - - unless ($self->is_connected) { - $self->last_error("Not connected"); - return; - } - - unless ($self->logged_in) { - $self->last_error("Not logged in"); - return; - } - - - my %cmd; - foreach (@valid_net_telnet_opts) { - if (exists $cfg{$_}) { - $cmd{$_} = $cfg{$_}; - } - } - if ($cfg{'args'}) { - $cmd{'String'} .= ' ' . $cfg{'args'}; - } - - my @lines; - if ($cfg{'no_prompt'}) { - $self->print($cmd{'String'}); - @lines = $self->lastline; - } else { - @lines = $self->SUPER::cmd(%cmd); - } - - $self->last_lines(\@lines); - - my $vals = 1; - if ($PRIVATE{'Decode'} && $cfg{'decode'}) { - if ($cfg{'decode'} eq 'each') { - $vals = _decode_each_line(@lines); - } elsif ($cfg{'decode'} eq 'sulog') { - $vals = _decode_sulog(@lines); - } elsif ($cfg{'decode'} eq 'maclist') { - $vals = _decode_maclist(@lines); - } else { - $vals = _decode_lines(@lines); - } - } - - $self->last_vals($vals); - - - my $last = $self->lastline; - - if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) { - if ($cfg{'cmd_disconnects'}) { - $self->logged_in(0); - $self->close; - $self->is_connected(0); - } - - if ($PRIVATE{'Decode'} && $cfg{'decode'}) { - return $vals; - } else { - return \@lines; - } - } else { - $self->last_error("Error with command ($cfg{'String'}): $last"); - return; - } -} - -#=item _decode_lines - -sub _decode_lines -{ - my @lines = @_; - - my %conf; - - my $key = ''; - my $val = undef; - my @vals; - my $in_key = 0; - my $in_val = 1; - - foreach my $line (@lines) { - next if $line =~ /$success$/; - - my @chars = split //, $line; - - my $last_key = ''; - foreach my $c (@chars) { - - if ($c eq '[' || $c eq "\r" || $c eq "\n") { - if ($c eq '[') { - $in_key = 1; - $in_val = 0; - } else { - $in_key = 0; - $in_val = 1; - } - - if ($key) { - $key =~ s/^\s+//; - $key =~ s/\s+$//; - - if ($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; - } - - $conf{$key} = $val; - $last_key = $key; - $key = ''; - } elsif ($val) { - push @vals, $val; - } - $val = ''; - - } elsif ($c eq ']') { - $in_val = 1; - $in_key = 0; - $c = shift @chars; - - } elsif ($in_key) { - $key .= $c; - - } elsif ($in_val) { - $val .= $c; - } - } - } - - unless ($key) { - push @vals, $val; - } - - if (@vals == 1) { - $val = $vals[0]; - } elsif (@vals) { - $val= \@vals; - } else { - $val = undef; - } - - if (%conf) { - $conf{_pre} = $val if $val; - 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; - } -} - -1; -__END__ - -=back - -=head1 SEE ALSO - -Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm - -L - -=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 Eandrew@rraz.netE - -=head1 COPYRIGHT AND LICENSE - -Copyright (C) 2005,2006,2007 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 +package Net::Telnet::Trango; + +# $RedRiver: Trango.pm,v 1.33 2007/02/02 21:26:56 andrew Exp $ +use strict; +use warnings; +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 ); + + $t->open( Host => $fox ) or 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 + +=head1 METHODS + +=cut + +our $VERSION = '0.01'; + +my %PRIVATE = ( + is_connected => 0, + logged_in => 0, +); + +=pod + +=head2 B +- Creates a new Net::Telnet::Trango object. + + new([Options from Net::Telnet,] + [Decode => 0,]); + +Same as new from L but sets the default Trango Prompt: +'/#> *$/' + +It also takes an optional parameter 'Decode'. If not defined it +defaults to 1, if it is set to 0, it will not decode the output and +instead return a reference to an array of the lines that were returned +from the command. + +=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}; + } + $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'}; + delete $args{'Decode'}; + + my $self = $class->SUPER::new(%args); + bless $self if ref $self; + + return $self; +} + +# _password +# ? [command] +# apsearch [ ]... +# arp -bcast +# bcastscant [ ... +# bye +# cf2cf ap [default|] +# date +# date +# freq scantable +# freq channeltable +# freq writescan [ ] +# freq writechannel [ ] ... +# freq +# help [command] +# heater [ ] +# ipconfig [ ] +# log [<# of entries, 1..179>] +# log <# of entries, 1..179> +# logout +# opmode [ap [y]] +# password +# ping +# polar +# power > +# reboot +# restart +# remarks [] +# rfrxthreshold [ <-90|-85|-80|-75|-70|-65>] +# rfrxth [ <-90|-85|-80|-75|-70|-65>] +# sysinfo +# set suid +# set apid +# set baseid +# set defaultopmode [ ] +# set defaultopmode off +# set snmpcomm [ ] +# set mir [on|off] +# set mir threshold +# set rssitarget [ ] +# set serviceradius [ ] +# ssrssi +# su [|all] +# su changechannel +# su ipconfig +# su [live|poweroff|priority] +# su +# su powerleveling +# su reboot +# su restart +# su testrflink [r] +# su testrflink [64..1600] +# su testrflink [20..100] +# su sw +# sudb [dload | view] +# sudb add pr +# sudb add reg +# sudb delete > +# sudb modify +# sudb modify +# sudb view +# sulog [lastmins | sampleperiod <1..60>] +# sulog [<# of entry,1..18>] +# survey +# sw [ ] +# temp +# tftpd [on|off] +# time +# time +# save +# save +# updateflash +# updateflash + +=pod + +=head1 ACCESSORS + +These are usually only set internally. + +=head2 B +- returns the firmware version + +Returns the firmware version if available, otherwise undef. + +It should be available after a successful open(). + +=head2 B +- return the type of host you are connected to. + +returns the type of host from the login banner for example M5830S or M5300S. + +Should be available after a successful open(). + +=head2 B +- Status of the connection to host. + +returns 1 when connected, undef otherwise. + +=head2 B +- Status of being logged in to the host. + +returns 1 after a successful login(), 0 if it failed and undef if +login() was never called. + +=head2 B +- The banner when first connecting to the host. + +returns the banner that is displayed when first connected at login. +Only set after a successful open(). + +=head2 B +- The last lines of output from the last cmd(). + +returns, as an array ref, the output from the last cmd() that was run. + +=head2 B +- A text output of the last error that was encountered. + +returns the last error reported. Probably contains the last entry in +last_lines. + +=head1 ALIASES + +=head2 B +- alias of exit() + +Does the same as exit() + +=head2 B +- alias of reboot() + +Does the same as reboot() + +=head1 COMMANDS + +Most of these are just shortcuts to C METHOD)>, +as such they accept the same options as C. +Specifically they take a named paramater "args", for example: +C 'on')> would enable tftpd + +=head2 B +- The output from the tftpd command + +Returns a hash ref of the decoded output from the +command. + +Also see enable_tftpd() and disable_tftpd() as those check that it was +successfully changed. + +=head2 B +- The output from the ver command + +Returns a hash ref of the decoded output from the +command. + +=head2 B +- The output from the sysinfo command + +Returns a hash ref of the decoded output from the +command. + +=head2 B +- Exits the connection + +exits the command session with the Trango and closes +the connection + +=head2 B +- Sends a reboot command + +reboots the Trango and closes the connection + +=head2 B +- Set or retrieve the remarks. + +Takes an optional argument, which sets the remarks. +If there is no argument, returns the current remarks. + + my $old_remarks = $t->remarks(); + $t->remarks($new_remarks); + +=head2 B +- The output from the sulog command + +Returns an array ref of hashes containing each log +line. + +=head2 B +- saves the sudb + +Returns true on success, undef on failure + +=head2 B +- The output from the sulog command + +Returns a hashref of the output from the syslog command + +=head2 B +- the pipe command + +Returns the output from the pipe command + +=head2 B +- retrieves the maclist + +Returns the output from the maclist command + +=head2 B +- resets the maclist. + +No useful output. + +=head2 B +- eth list command + +Returns the output from the eth list command + + +=head2 B +- gets the su info + +Returns information about the SU. + +You need to pass in the $suid and it will return the info for that suid. + + $t->su_info($suid); + +=head2 B +- tests the RF Link to an su + + $t->su_testrflink($suid|'all'); + +=head2 B +- saves the config. + +Returns 1 on success, undef on failure. + +=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' => { no_prompt => 1, cmd_disconnects => 1 }, + reboot => { no_prompt => 1, cmd_disconnects => 1 }, + remarks => { decode => 'all', expect => $success }, + save_sudb => { String => 'save sudb', expect => $success }, + syslog => { expect => $success }, + 'pipe' => {}, # XXX needs a special decode + maclist => { decode => 'maclist' }, + maclist_reset => { String => 'maclist reset', expect => 'done' }, + eth_link => { String => 'eth link', expect => $success }, + su_info => { String => 'su info', decode => 'all', expect => $success }, + su_testrflink => + { String => 'su testrflink', decode => 'each', expect => $success }, + save_ss => { String => 'save ss', expect => $success }, + opmode => { decode => 'all', expect => $success }, + + # eth r, w and reset??? + #su password??? + #_bootloader + #temp + #heater +); + +my %ALIASES = ( + bye => 'exit', + restart => 'reboot', + Host => 'host', +); + +my %ACCESS = map { $_ => 1 } qw( + firmware_version + host_type + is_connected + logged_in + login_banner + Timeout + last_lines + last_vals + last_error + Decode +); + +sub AUTOLOAD { + my $self = shift; + + my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/ + or die "Weird: $AUTOLOAD"; + + if ( exists $ALIASES{$method} ) { + $method = $ALIASES{$method}; + return $self->$method(@_); + } + + if ( exists $COMMANDS{$method} ) { + my %cmd; + foreach my $k ( keys %{ $COMMANDS{$method} } ) { + $cmd{$k} = $COMMANDS{$method}{$k}; + } + $cmd{'String'} ||= $method; + $cmd{'args'} .= ' ' . shift if ( @_ == 1 ); + return $self->cmd( %cmd, @_ ); + } + + if ( exists $ACCESS{$method} ) { + my $prev = $PRIVATE{$method}; + ( $PRIVATE{$method} ) = @_ if @_; + return $prev; + } + + $method = "SUPER::$method"; + return $self->$method(@_); +} + +=pod + +=head2 B +- Open a connection to a Trango AP. + +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() + +=cut + +sub open { + my $self = shift; + + unless ( $self->SUPER::open(@_) ) { + $self->last_error( "Couldn't connect to " . $self->host . ": $!" ); + return; + } + + ## Get to login prompt + unless ( + $self->waitfor( + -match => '/password: ?$/i', + -errmode => "return", + ) + ) + { + $self->last_error( "problem connecting to host (" + . $self->host . "): " + . $self->lastline ); + return; + } + + $self->parse_login_banner( $self->lastline ); + + $self->is_connected(1); + + return $self->is_connected; +} + +=pod + +=head2 B +- Login to the AP. + +Calls open() if not already connected, then sends the password and sets +logged_in() if successful + +=cut + +sub login { + my $self = shift; + + unless ( $self->is_connected ) { + $self->open or return; + } + + my $password = shift; + + $self->print($password); + unless ( + $self->waitfor( + -match => $self->prompt, + -errmode => "return", + ) + ) + { + $self->last_error( "login ($self->host) failed: " . $self->lastline ); + return; + } + + $self->logged_in(1); + + return $self->logged_in; +} + +=pod + +=head2 B +- Converts the login_banner to some useful +variables. + +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; + + if (@_) { + $self->login_banner(@_); + } + + my $banner = $self->login_banner; + + my ( $type, $sep1, $subtype, $sep2, $ver ) = + $banner =~ + /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i; + + $type .= $sep1 . $subtype; + $ver = $subtype . $sep2 . $ver; + + $self->login_banner($banner); + $self->host_type($type); + $self->firmware_version($ver); + + return 1; +} + +=pod + +=head2 B +- Set the password on SUs connected to the AP. + +su_password('new_password'[, 'suid']) If no suid is specified, +the default is "all". + + $t->su_password('good_pass', 5); + +=cut + +sub su_password { + my $self = shift; + my $new_pass = shift || ''; + my $su = shift || 'all'; + + unless ( defined $new_pass ) { + $self->last_error("No new password"); + + #return; + } + + return $self->cmd( + String => 'su password ' . $su . ' ' . $new_pass . ' ' . $new_pass, + expect => $success, + ); +} + +=pod + +=head2 B +- Change IP configuration on SUs connected to +the AP. + +su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' ) + + $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' ); + +=cut + +sub su_ipconfig { + my $self = shift; + + my $suid = shift; + my $new_ip = shift; + my $new_subnet = shift; + my $new_gateway = shift; + + if ( $suid =~ /\D/ ) { + $self->last_error("Invalid suid '$suid'"); + return; + } + unless ($new_ip) { + $self->last_error("no new_ip passed"); + return; + } + unless ($new_subnet) { + $self->last_error("no new_subnet passed"); + return; + } + unless ($new_gateway) { + $self->last_error("no new_gateway passed"); + return; + } + + # su ipconfig + return $self->cmd( + String => 'su ipconfig ' . $suid . ' ' . $new_ip . ' ' + . $new_subnet . ' ' + . $new_gateway, + expect => $success, + ); +} + +=pod + +=head2 B +- Returns the output from the sudb view command + +returns a reference to an array of hashes each containing these keys +'suid', 'type', 'cir', 'mir' and 'mac' + +=cut + +sub sudb_view { + my $self = shift; + + my $lines = $self->cmd( String => 'sudb view', expect => $success ) || []; + + return unless @{$lines}; + + unless ( $PRIVATE{'Decode'} ) { + return $lines; + } + + my @sus; + foreach ( @{$lines} ) { + next unless $_; + if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) { + my %s = ( + suid => $1, + type => $2, + cir => $3, + mir => $4, + mac => $5, + ); + + $s{'mac'} =~ s/\s//g; + $s{'mac'} = uc( $s{'mac'} ); + + push @sus, \%s; + } + } + + return \@sus; +} + +=pod + +=head2 B + +Takes the following paramaters + + suid : numeric, + type : (reg|pr) + cir : numeric, + mir : numeric, + mac : Almost any format, it will be reformatted, + +and returns true on success or undef otherwise. + + $t->sudb_add($suid, 'reg', $cir, $mir, $mac); + +You should save_sudb() after calling this, or your changes will be lost +when the AP is rebooted. + +=cut + +sub sudb_add { + my $self = shift; + my $suid = shift; + my $type = shift; + my $cir = shift; + my $mir = shift; + my $mac = shift; + + if ( $suid =~ /\D/ ) { + $self->last_error("Invalid suid '$suid'"); + return; + } + + unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) { + $self->last_error("Invalid type '$type'"); + return; + } + + if ( $cir =~ /\D/ ) { + $self->last_error("Invalid CIR '$cir'"); + return; + } + + if ( $mir =~ /\D/ ) { + $self->last_error("Invalid MIR '$mir'"); + return; + } + + my $new_mac = $mac; + $new_mac =~ s/[^0-9A-Fa-f]//; + unless ( length $new_mac == 12 ) { + $self->last_error("Invalid MAC '$mac'"); + return; + } + $new_mac = join ' ', $new_mac =~ /../g; + + my $string = + 'sudb add ' . $suid . ' ' . $type . ' ' . $cir . ' ' . $mir . ' ' + . $new_mac; + + return $self->cmd( String => $string, expect => $success ); +} + +=pod + +=head2 B + +Takes either 'all' or the suid of the su to delete +and returns true on success or undef otherwise. + + $t->sudb_delete($suid); + +You should save_sudb() after calling this, or your changes will be lost +when the AP is rebooted. + +=cut + +sub sudb_delete { + my $self = shift; + my $suid = shift; + + #if (lc($suid) ne 'all' || $suid =~ /\D/) { + if ( $suid =~ /\D/ ) { + $self->last_error("Invalid suid '$suid'"); + return; + } + + return $self->cmd( String => 'sudb delete ' . $suid, expect => $success ); +} + +=pod + +=head2 B + +Takes either the suid of the su to change +as well as what you are changing, either "cir, mir or su2su" +and returns true on success or undef otherwise. + +cir and mir also take a value to set the cir/mir to. + +su2su takes a group id parameter that is in hex. + + $t->sudb_modify($suid, 'cir', 512); + +You should save_sudb() after calling this, or your changes will be lost +when the AP is rebooted. + +=cut + +sub sudb_modify { + my $self = shift; + my $suid = shift; + my $opt = shift; + my $value = shift; + + if ( $suid =~ /\D/ ) { + $self->last_error("Invalid suid '$suid'"); + return; + } + + if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) { + if ( $value =~ /\D/ ) { + $self->last_error("Invalid $opt '$value'"); + return; + } + } + elsif ( lc($opt) eq 'su2su' ) { + if ( $value =~ /[^0-9A-Za-f]/ ) { + $self->last_error("Invalid MAC '$value'"); + return; + } + } + else { + $self->last_error("Invalid option '$opt'"); + return; + } + + my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value; + + return $self->cmd( String => $string, expect => $success ); +} + +=pod + +=head2 B +- enable the TFTP server + +runs C 'on')> and makes sure that Tftpd is now 'listen'ing + +=cut + +sub enable_tftpd { + my $self = shift; + + my $vals = $self->tftpd( args => 'on' ); + + if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) { + return $vals; + } + else { + return; + } +} + +=pod + +=head2 B +- disable the TFTP server + +runs C 'off')> and makes sure that Tftpd is now 'disabled' + +=cut + +sub disable_tftpd { + my $self = shift; + + my $vals = $self->tftpd( args => 'off' ); + + if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled' ) { + return $vals; + } + else { + return; + } +} + +=pod + +=head2 B - runs a command on the AP. + +This does most of the work. At the heart, it calls Net::Telnet::cmd() +but it also does some special stuff for Trango. + +Normally returns the last lines from from the command + +If you are using this, rather than one of the "easy" methods above, +you probably want to read through the source of this module to see how +some of the other commands are called. + +In addition to the Net::Telnet::cmd() options, it also accepts these: + +I +- if this is true, then it will send the output lines to _decode_lines() +and then returns the decoded output + +I +- if this is true, it does not wait for a prompt, so you are not stuck +waiting for something that will never happen. + +I +- if this is true, it then sets logged_in() to false, then it will +close() the connection and set is_connected() to false + +I +- 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 +- a string containing the command line options that are passed to the +command + + $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); + +=cut + +sub cmd { + my $self = shift; + + my @valid_net_telnet_opts = qw( + String + Output + Cmd_remove_mode + Errmode + Input_record_separator + Ors + Output_record_separator + Prompt + Rs + Timeout + ); + + my %cfg; + if ( @_ == 1 ) { + $cfg{'String'} = shift; + } + elsif ( @_ > 1 ) { + %cfg = @_; + } + + $cfg{'Timeout'} ||= $self->Timeout; + + unless ( $cfg{'String'} ) { + $self->last_error("No command passed"); + return; + } + + unless ( $self->is_connected ) { + $self->last_error("Not connected"); + return; + } + + unless ( $self->logged_in ) { + $self->last_error("Not logged in"); + return; + } + + my %cmd; + foreach (@valid_net_telnet_opts) { + if ( exists $cfg{$_} ) { + $cmd{$_} = $cfg{$_}; + } + } + if ( $cfg{'args'} ) { + $cmd{'String'} .= ' ' . $cfg{'args'}; + } + + my @lines; + if ( $cfg{'no_prompt'} ) { + $self->print( $cmd{'String'} ); + @lines = $self->lastline; + } + else { + @lines = $self->SUPER::cmd(%cmd); + } + + $self->last_lines( \@lines ); + + my $vals = 1; + if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) { + if ( $cfg{'decode'} eq 'each' ) { + $vals = _decode_each_line(@lines); + } + elsif ( $cfg{'decode'} eq 'sulog' ) { + $vals = _decode_sulog(@lines); + } + elsif ( $cfg{'decode'} eq 'maclist' ) { + $vals = _decode_maclist(@lines); + } + else { + $vals = _decode_lines(@lines); + } + } + + $self->last_vals($vals); + + my $last = $self->lastline; + + if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) { + if ( $cfg{'cmd_disconnects'} ) { + $self->logged_in(0); + $self->close; + $self->is_connected(0); + } + + if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) { + return $vals; + } + else { + return \@lines; + } + } + else { + $self->last_error("Error with command ($cfg{'String'}): $last"); + return; + } +} + +#=item _decode_lines + +sub _decode_lines { + my @lines = @_; + + my %conf; + + my $key = ''; + my $val = undef; + my @vals; + my $in_key = 0; + my $in_val = 1; + + foreach my $line (@lines) { + next if $line =~ /$success$/; + + my @chars = split //, $line; + + my $last_key = ''; + foreach my $c (@chars) { + + if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) { + if ( $c eq '[' ) { + $in_key = 1; + $in_val = 0; + } + else { + $in_key = 0; + $in_val = 1; + } + + if ($key) { + $key =~ s/^\s+//; + $key =~ s/\s+$//; + + if ($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; + } + + $conf{$key} = $val; + $last_key = $key; + $key = ''; + } + elsif ($val) { + push @vals, $val; + } + $val = ''; + + } + elsif ( $c eq ']' ) { + $in_val = 1; + $in_key = 0; + $c = shift @chars; + + } + elsif ($in_key) { + $key .= $c; + + } + elsif ($in_val) { + $val .= $c; + } + } + } + + unless ($key) { + push @vals, $val; + } + + if ( @vals == 1 ) { + $val = $vals[0]; + } + elsif (@vals) { + $val = \@vals; + } + else { + $val = undef; + } + + if (%conf) { + $conf{_pre} = $val if $val; + 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; + } +} + +1; # End of Net::Telnet::Trango +__END__ + +=head1 SEE ALSO + +Trango Documentation - +L + +L + +=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 Eandrew@rraz.netE + +=head1 SUPPORT + +You can find documentation for this module with the perldoc command. + + perldoc Net::Telnet::Trango + +You can also look for information at: + +=over 4 + +=item * AnnoCPAN: Annotated CPAN documentation + +L + +=item * CPAN Ratings + +L + +=item * RT: CPAN's request tracker + +L + +=item * Search CPAN + +L + +=back + +=head1 COPYRIGHT AND LICENSE + +Copyright (C) 2005,2006,2007 by Andrew Fresh + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +=cut