| version 1.5, 2006/01/03 00:22:19 | version 1.59, 2009/07/31 22:44:33 | 
|  |  | 
| package Net::Telnet::Trango; | package Net::Telnet::Trango; | 
| # $RedRiver: Trango.pm,v 1.4 2005/12/30 20:26:41 andrew Exp $ |  | 
| use strict; | # $RedRiver: Trango.pm,v 1.58 2009/07/13 16:33:45 andrew Exp $ | 
| use warnings; | use strict; | 
| use base 'Net::Telnet'; | use warnings; | 
|  | use base 'Net::Telnet'; | 
| =pod |  | 
|  | =pod | 
| =head1 NAME |  | 
|  | =head1 NAME | 
| Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface |  | 
|  | Net::Telnet::Trango | 
| =head1 SYNOPSIS | - Perl extension for accessing the Trango telnet interface | 
|  |  | 
| use Net::Telnet::Trango; | =head1 SYNOPSIS | 
| my $t = new Net::Telnet::Trango ( Timeout => 5 ); |  | 
|  | use Net::Telnet::Trango; | 
| my ($type, $version) = $t->open( Host => $fox ); | my $t = new Net::Telnet::Trango ( Timeout => 5 ); | 
|  |  | 
| unless (defined $type && defined $version) { | $t->open( Host => $ap ) or die "Error connecting: $!"; | 
| 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->close; | 
| $t->exit; |  | 
| $t->close; | =head1 DESCRIPTION | 
|  |  | 
| =head1 DESCRIPTION | Perl access to the telnet interface on Trango APs and SUs. | 
|  |  | 
| Perl access to the telnet interface on Trango Foxes, SUs and APs. | A 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 | 
| 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. | returned.  This makes using the output from things like sysinfo very easy to | 
|  | do. | 
| =head2 EXPORT |  | 
|  | =head2 EXPORT | 
| None |  | 
|  | None | 
| =cut |  | 
|  | =head1 METHODS | 
| our $VERSION = '0.01'; |  | 
|  | =cut | 
| my %PRIVATE = ( |  | 
| is_connected => 0, | our $VERSION = '0.05'; | 
| logged_in => 0, |  | 
| ); | my $EMPTY = q{}; | 
|  | my $SPACE = q{ }; | 
| =pod |  | 
|  | =pod | 
| =item new |  | 
|  | =head2 B<new> - Creates a new Net::Telnet::Trango object. | 
| Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt' |  | 
|  | new([Options from Net::Telnet,] | 
| =cut | [Decode => 0,]); | 
|  |  | 
| sub new | Same as new from L<Net::Telnet> but sets the default Trango Prompt: | 
| { | '/[\$#]>\s*\Z/' | 
| my $class = shift; |  | 
|  | It also takes an optional parameter 'Decode'.  If not defined it | 
| my %args; | defaults to 1, if it is set to 0, it will not decode the output and | 
| if (@_ == 1) { | instead return a reference to an array of the lines that were returned | 
| $args{'Host'} = shift; | from the command. | 
| } else { |  | 
| %args = @_; | =cut | 
| } |  | 
|  | sub new { | 
| $args{'Prompt'}  ||= '/#> *$/'; | my $class = shift; | 
|  |  | 
| foreach my $key (keys %args) { | my %args = (); | 
| $PRIVATE{$key} = $args{$key}; | if ( @_ == 1 ) { | 
| } | $args{'Host'} = shift; | 
|  | } | 
| my $self = $class->SUPER::new(%args); | else { | 
| bless $self if ref $self; | %args = @_; | 
|  | } | 
| return $self; |  | 
| } | $args{'Prompt'} ||= '/[\$#]>\s*\r?\n?$/'; | 
|  |  | 
| #  _password <new password> <new password> | my $decode = $args{'Decode'}; | 
| #  ? [command] | delete $args{'Decode'}; | 
| #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]... |  | 
| #  arp -bcast <on|off> | my $self = $class->SUPER::new(%args); | 
| #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ... | bless $self if ref $self; | 
| #  bye |  | 
| #  cf2cf ap [default|<size>] | $args{Decode}       = defined $decode ? $decode : 1; | 
| #  date | $args{is_connected} = 0; | 
| #  date <month> <day> <year> | $args{logged_in}    = 0; | 
| #  freq scantable |  | 
| #  freq channeltable | *$self->{net_telnet_trango} = \%args; | 
| #  freq writescan [<ch#> <h|v>] |  | 
| #  freq writechannel [<ch#> <freq>] ... | return $self; | 
| #  freq <ch #> <h|v> | } | 
| #  help [command] |  | 
| #  heater [<on temp> <off temp>] | #  _password <new password> <new password> | 
| #  ipconfig [<new ip> <new subnet mask> <new gateway>] | #  ? [command] | 
| #  log [<# of entries, 1..179>] | #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]... | 
| #  log <sum> <# of entries, 1..179> | #  arp -bcast <on|off> | 
| #  logout | #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ... | 
| #  opmode [ap [y]] | #  bye | 
| #  password | #  cf2cf ap [default|<size>] | 
| #  ping <ip addr> | #  date | 
| #  polar <h|v> | #  date <month> <day> <year> | 
| #  power <setism|setunii> <max|min|<dBm>> | #  freq scantable | 
| #  reboot | #  freq channeltable | 
| #  restart | #  freq writescan [<ch#> <h|v>] | 
| #  remarks [<str>] | #  freq writechannel [<ch#> <freq>] ... | 
| #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>] | #  freq <ch #> <h|v> | 
| #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>] | #  help [command] | 
| #  sysinfo | #  heater [<on temp> <off temp>] | 
| #  set suid <id> | #  ipconfig [<new ip> <new subnet mask> <new gateway>] | 
| #  set apid <id> | #  linktest <suid> [<pkt len, bytes> [<# of pkts> [<# of cycle>]]] | 
| #  set baseid <id> | #  log [<# of entries, 1..179>] | 
| #  set defaultopmode [<ap|su> <min,0..10>] | #  log <sum> <# of entries, 1..179> | 
| #  set defaultopmode off | #  logout | 
| #  set snmpcomm [<read | write | trap (id or setall)> <str>] | #  opmode [ap [y]] | 
| #  set mir [on|off] | #  password | 
| #  set mir threshold <kbps> | #  ping <ip addr> | 
| #  set rssitarget [<ism|unii> <dBm>] | #  polar <h|v> | 
| #  set serviceradius [<ism | unii> <miles>] | #  power <setism|setunii> <max|min|<dBm>> | 
| #  ssrssi <ch #> <h|v> | #  reboot | 
| #  su [<suid>|all] | #  restart | 
| #  su changechannel <all|suid> <ch#> <h|v> | #  remarks [<str>] | 
| #  su ipconfig <suid> <new ip> <new subnet> <new gateway> | #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>] | 
| #  su [live|poweroff|priority] | #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>] | 
| #  su <ping|info|status> <suid> | #  sysinfo | 
| #  su powerleveling <all|suid> | #  set suid <id> | 
| #  su reboot <all|suid> | #  set apid <id> | 
| #  su restart <all|suid> | #  set baseid <id> | 
| #  su testrflink <all|suid> [r] | #  set defaultopmode [<ap|su> <min,0..10>] | 
| #  su testrflink <setlen> [64..1600] | #  set defaultopmode off | 
| #  su testrflink <aptx> [20..100] | #  set snmpcomm [<read | write | trap (id or setall)> <str>] | 
| #  su sw <suid|all> <sw #> <on|off> | #  set mir [on|off] | 
| #  sudb [dload | view] | #  set mir threshold <kbps> | 
| #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex> | #  set rssitarget [<ism|unii> <dBm>] | 
| #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex> | #  set serviceradius [<ism | unii> <miles>] | 
| #  sudb delete <all|<suid>> | #  ssrssi <ch #> <h|v> | 
| #  sudb modify <suid> <cir|mir> <kbps> | #  su [<suid>|all] | 
| #  sudb modify <suid> <su2su> <group id,hex> | #  su changechannel <all|suid> <ch#> <h|v> | 
| #  sudb view | #  su ipconfig <suid> <new ip> <new subnet> <new gateway> | 
| #  sulog [lastmins | sampleperiod <1..60>] | #  su [live|poweroff|priority] | 
| #  sulog [<# of entry,1..18>] | #  su <ping|info|status> <suid> | 
| #  survey <ism|unii> <time, sec> <h|v> | #  su powerleveling <all|suid> | 
| #  sw [<sw #> <on|off>] | #  su reboot <all|suid> | 
| #  temp | #  su restart <all|suid> | 
| #  tftpd [on|off] | #  su testrflink <all|suid> [r] | 
| #  time | #  su testrflink <setlen> [64..1600] | 
| #  time <hour> <min> <sec> | #  su testrflink <aptx> [20..100] | 
| #  save <mainimage|fpgaimage> <current chksum> <new chksum> | #  su sw <suid|all> <sw #> <on|off> | 
| #  save <systemsetting|sudb> | #  sudb [dload | view] | 
| #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum> | #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex> | 
| #  updateflash <systemsetting|sudb> | #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex> | 
|  | #  sudb delete <all|<suid>> | 
| =pod | #  sudb modify <suid> <cir|mir> <kbps> | 
|  | #  sudb modify <suid> <su2su> <group id,hex> | 
| =head1 METHODS | #  sudb view | 
|  | #  sulog [lastmins | sampleperiod <1..60>] | 
| =head2 ACCESSORS | #  sulog [<# of entry,1..18>] | 
|  | #  survey <ism|unii> <time, sec> <h|v> | 
| =over | #  sw [<sw #> <on|off>] | 
|  | #  temp | 
| =item Host | #  tftpd [on|off] | 
|  | #  time | 
| returns the name of the host that you are accessing | #  time <hour> <min> <sec> | 
|  | #  save <mainimage|fpgaimage> <current chksum> <new chksum> | 
| =item firmware_version | #  save <systemsetting|sudb> | 
|  | #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum> | 
| returns the firmware version on the trango if available otherwise undef. | #  updateflash <systemsetting|sudb> | 
| Available after a successful open() |  | 
| This is usually only set internally | =pod | 
|  |  | 
| =item host_type | =head1 ACCESSORS | 
|  |  | 
| returns the type of host from the login banner for example M5830S or M5300S. | These are usually only set internally. | 
| Available after a successful open() |  | 
| This is usually only set internally | =head2 B<firmware_version> - returns the firmware version | 
|  |  | 
| =item is_connected | Returns the firmware version if available, otherwise undef. | 
|  |  | 
| returns 1 after a successful open() otherwise undef | It should be available after a successful open(). | 
| This is usually only set internally |  | 
|  | =head2 B<host_type> - return the type of host you are connected to. | 
| =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 |  | 
| login() was never called | Should be available after a successful open(). | 
| This is usually only set internally |  | 
|  | =head2 B<is_connected> - Status of the connection to host. | 
| =item login_banner |  | 
|  | returns 1 when connected, undef otherwise. | 
| returns the banner that is displayed when first connected at login.  Only set after a successful open() |  | 
|  | =head2 B<logged_in> - Status of being logged in to the host. | 
| This is usually only set internally |  | 
|  | returns 1 after a successful login(), 0 if it failed and undef if | 
| =item last_lines | login() was never called. | 
|  |  | 
| returns the output from the last cmd() that was run as an array ref | =head2 B<login_banner> - The banner when first connecting to the host. | 
| This is usually only set internally |  | 
|  | returns the banner that is displayed when first connected at login. | 
| =back | Only set after a successful open(). | 
|  |  | 
| =head2 ALIASES | =head2 B<last_lines> - The last lines of output from the last cmd(). | 
|  |  | 
| =over | returns, as an array ref, the output from the last cmd() that was run. | 
|  |  | 
| =item bye | =head2 B<last_error> - A text output of the last error that was encountered. | 
|  |  | 
| alias of exit() | returns the last error reported.  Probably contains the last entry in | 
|  | last_lines. | 
| =item restart |  | 
|  | =head1 ALIASES | 
| alias of reboot() |  | 
|  | =head2 B<bye> - alias of exit() | 
| =back |  | 
|  | Does the same as exit() | 
| =head2 COMMANDS |  | 
|  | =head2 B<restart> - alias of reboot() | 
| 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 | Does the same as reboot() | 
|  |  | 
| =over | =head2 B<save_systemsetting> - alias of save_ss() | 
|  |  | 
| =item tftpd | Does the same as save_ss() | 
|  |  | 
| Returns a hash ref of the decoded output from the command. | =head1 COMMANDS | 
|  |  | 
| Also see enable_tftpd() and disable_tftpd() as those check for correct output | Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>, | 
|  | as such they accept the same options as C<cmd()>. | 
| =item ver | Specifically they take a named paramater "args", for example: | 
|  | C<tftpd(args =E<gt> 'on')> would enable tftpd | 
| Returns a hash ref of the decoded output from the command. |  | 
|  | =head2 B<tftpd> - The output from the tftpd command | 
| =item sysinfo |  | 
|  | Returns a hash ref of the decoded output from the | 
| Returns a hash ref of the decoded output from the command. | command. | 
|  |  | 
| =item exit | Also see enable_tftpd() and disable_tftpd() as those check that it was | 
|  | successfully changed. | 
| exits the command session with the trango and closes the connection |  | 
|  | =head2 B<ver> - The output from the ver command | 
| =item reboot |  | 
|  | Returns a hash ref of the decoded output from the | 
| reboots the trango and closes the connection | command. | 
|  |  | 
| =item sulog | =head2 B<sysinfo> - The output from the sysinfo command | 
|  |  | 
| returns an array ref of hashes containing each log line. | Returns a hash ref of the decoded output from the | 
|  | command. | 
| =cut |  | 
|  | =head2 B<exit> - Exits the connection | 
|  |  | 
| my $success = 'Success.'; | exits the command session with the Trango and closes | 
| my %COMMANDS = ( | the connection | 
| tftpd       => { decode => 'all',   expect => $success }, |  | 
| ver         => { decode => 'all' }, | =head2 B<reboot> - Sends a reboot command | 
| sysinfo     => { decode => 'all',   expect => $success }, |  | 
| updateflash => { decode => 'all',   expect => $success }, | reboots the Trango and closes the connection | 
| sulog       => { decode => 'sulog', expect => $success }, |  | 
| 'exit'      => { no_prompt => 1, cmd_disconnects => 1 }, | ==head2 B<reset> <all|0..2> - Sends a reset command | 
| reboot      => { no_prompt => 1, cmd_disconnects => 1 }, |  | 
| #su password??? | resets settings to default | 
| #_bootloader |  | 
| #temp | =head2 B<remarks> - Set or retrieve the remarks. | 
| #heater |  | 
| ); | Takes an optional argument, which sets the remarks. | 
|  | If there is no argument, returns the current remarks. | 
| my %ALIASES = ( |  | 
| bye     => 'exit', | my $old_remarks = $t->remarks(); | 
| restart => 'reboot', | $t->remarks($new_remarks); | 
| ); |  | 
|  | =head2 B<sulog> - The output from the sulog command | 
| my %ACCESS = map { $_ => 1 } qw( |  | 
| firmware_version | Returns an array ref of hashes containing each log | 
| host_type | line. | 
| Host |  | 
| is_connected | =head2 B<save_sudb> - saves the sudb | 
| logged_in |  | 
| login_banner | Returns true on success, undef on failure | 
| Timeout |  | 
| last_lines | =head2 B<syslog> - The output from the sulog command | 
| last_vals |  | 
| ); | Returns a hashref of the output from the syslog command | 
|  |  | 
| sub AUTOLOAD | =head2 B<pipe> - the pipe command | 
| { |  | 
| my $self = shift; | Returns the output from the pipe command | 
|  |  | 
| my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/ | =head2 B<maclist> - retrieves the maclist | 
| or die "Weird: $AUTOLOAD"; |  | 
|  | Returns the output from the maclist command | 
| if (exists $ALIASES{$method}) { |  | 
| $method = $ALIASES{$method}; | =head2 B<maclist_reset> - resets the maclist. | 
| return $self->$method(@_); |  | 
| } | No useful output. | 
|  |  | 
| if (exists $COMMANDS{$method}) { | =head2 B<eth_link> - eth link command | 
| $method = shift if (@_ == 1); |  | 
| $COMMANDS{$method}{'String'} ||= $method; | Returns the output from the eth link command | 
| return $self->cmd(%{ $COMMANDS{$method} }, @_); |  | 
| } | This command seems to cause some weird issues.  It often will cause the | 
|  | command after it to appear to fail.  I am not sure why. | 
| if (exists $ACCESS{$method}) { |  | 
| my $prev = $PRIVATE{$method}; | =head2 B<su_info> - gets the su info | 
| ($PRIVATE{$method}) = @_ if @_; |  | 
| return $prev; | Returns information about the SU. | 
| } |  | 
|  | You need to pass in the $suid and it will return the info for that suid. | 
| $method = "SUPER::$method"; |  | 
| return $self->$method(@_); | $t->su_info($suid); | 
| } |  | 
|  | =head2 B<su_testrflink> - tests the RF Link to an su | 
| =pod |  | 
|  | $t->su_testrflink($suid|'all'); | 
| =item open |  | 
|  | =head2 B<save_ss> - saves the config. | 
| 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() |  | 
|  | Returns 1 on success, undef on failure. | 
| =cut |  | 
|  | =head2 B<set_baseid> - sets baseid | 
| sub open |  | 
| { | $t->set_baseid($baseid); | 
| my $self = shift; |  | 
|  | =head2 B<set_suid> - sets baseid | 
| unless ( $self->SUPER::open(@_) ) { |  | 
| #$! = "Couldn't connect to " . $self->Host . ":  $!"; | $t->set_suid($baseid); | 
| return undef; |  | 
| } | =head2 B<set_defaultopmode> - sets default opmode | 
|  |  | 
| ## Get to login prompt | $t->set_defaultopmode(ap|su); | 
| unless ($self->waitfor( |  | 
| -match => '/password: ?$/i', | =head2 B<opmode> - sets or returns the opmode | 
| -errmode => "return", |  | 
| ) ) { | $t->opmode([ap y|su y]); | 
| #$! = "problem connecting to host (" . $self->Host . "): " . |  | 
| #    $self->lastline; | =head2 B<freq> - sets or returns the freq | 
| return undef; |  | 
| } | $channel = '11 v'; | 
|  | $t->freq([$channel]); | 
| $self->parse_login_banner($self->lastline); |  | 
|  | =head2 B<freq_writescan> - sets the freq writescan | 
| $self->is_connected(1); |  | 
|  | $channels = '11 v 11 h 12 v 12 h'; | 
| return $self->is_connected; | $t->freq_writescan($channels); | 
| } |  | 
|  | =head2 B<freq_scantable> - returns the freq scantable | 
| =pod |  | 
|  | $channels = $t->freq_scantable(); | 
| =item login | # now $channels eq '11 v 11 h 12 v 12 h'; | 
|  |  | 
| Calls open() if not already connected, then sends the password and sets logged_in() if successful |  | 
|  | =cut | 
| =cut |  | 
|  | my $success  = 'Success\\.'; | 
| sub login | my %COMMANDS = ( | 
| { | _clear      => { String    => "\n" }, | 
| my $self = shift; | tftpd       => { decode    => 'all', expect => $success }, | 
|  | ver         => { decode    => 'all' }, | 
| unless ($self->is_connected) { | sysinfo     => { decode    => 'all', expect => $success }, | 
| $self->open or return undef; | updateflash => { decode    => 'all', expect => $success }, | 
| } | sulog       => { decode    => 'sulog', expect => $success }, | 
|  | 'exit'      => { no_prompt => 1, cmd_disconnects => 1 }, | 
| my $password = shift; | reboot      => { no_prompt => 1, cmd_disconnects => 1 }, | 
|  | 'reset'   => {}, | 
| $self->print($password); | remarks   => { decode => 'all', expect => $success }, | 
| unless ($self->waitfor( | save_sudb => { String => 'save sudb', expect => $success }, | 
| -match => $self->prompt, | syslog  => { expect => $success }, | 
| -errmode => "return", | 'pipe'  => {},      # XXX needs a special decode | 
| ) ) { | maclist => { decode => 'maclist' }, | 
| #$! = "login ($self->Host) failed: " . $self->lastline; | maclist_reset => { String => 'maclist reset', expect => 'done' }, | 
| return undef; | eth_link      => { String => 'eth link',      expect => $success }, | 
| } | su_info => { String => 'su info', decode => 'all', expect => $success }, | 
|  | su_testrflink => | 
| $self->logged_in(1); | { String => 'su testrflink', decode => 'each', expect => $success }, | 
|  | save_ss    => { String => 'save ss', expect => $success }, | 
| return $self->logged_in; | set_baseid => { | 
| } | String => 'set baseid', | 
|  | decode => 'all', | 
| =pod | expect => $success | 
|  | }, | 
| =item parse_login_banner | set_suid => { | 
|  | String => 'set suid', | 
| 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() | decode => 'all', | 
|  | expect => $success | 
| =cut | }, | 
|  | set_defaultopmode => { | 
| sub parse_login_banner | String => 'set defaultopmode', | 
| { | decode => 'all', | 
| my $self = shift; | expect => $success | 
|  | }, | 
| if (@_) { | opmode => { decode => 'all',  expect => $success }, | 
| $self->login_banner(@_); | freq   => { decode => 'freq', expect => $success }, | 
| } | freq_writescan => | 
|  | { String => 'freq writescan', decode => 'all', expect => $success }, | 
| my $banner = $self->login_banner; | freq_scantable => | 
|  | { String => 'freq scantable', decode => 'all', expect => $success }, | 
| my ($type, $ver) = $banner =~ | arq => { decode => 'all' }, | 
| /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i; | ); | 
|  |  | 
| $self->login_banner($banner); | my %ALIASES = ( | 
| $self->host_type($type); | bye               => 'exit', | 
| $self->firmware_version($ver); | restart           => 'reboot', | 
|  | Host              => 'host', | 
| return 1; | save_systemseting => 'save_ss', | 
| } | ); | 
|  |  | 
| =pod | my %ACCESS = map { $_ => 1 } qw( | 
|  | firmware_version | 
| =item su_password | host_type | 
|  | is_connected | 
| C<su_password('all'|suid, 'new_password')> | logged_in | 
|  | login_banner | 
| =cut | Timeout | 
|  | last_lines | 
| sub su_password | last_vals | 
| { | last_error | 
| my $self     = shift; | Decode | 
| my $su       = shift || '!'; | ); | 
| my $new_pass = shift || ''; |  | 
|  | sub AUTOLOAD { | 
| unless (defined $su) { | my $self = shift; | 
| warn "No su passed!" |  | 
| #return undef; | my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/ | 
| } | or die "Weird: $AUTOLOAD"; | 
|  |  | 
| unless (defined $new_pass) { | if ( exists $ALIASES{$method} ) { | 
| warn "No new password!" | $method = $ALIASES{$method}; | 
| #return undef; | return $self->$method(@_); | 
| } | } | 
|  |  | 
| return $self->cmd(String => 'su password ' . | if ( exists $COMMANDS{$method} ) { | 
| $su . ' ' . | my %cmd; | 
| $new_pass . ' ' . | foreach my $k ( keys %{ $COMMANDS{$method} } ) { | 
| $new_pass, | $cmd{$k} = $COMMANDS{$method}{$k}; | 
| expect => $success, | } | 
| ); | $cmd{'String'} ||= $method; | 
| } | $cmd{'args'} .= $SPACE . shift if ( @_ == 1 ); | 
|  | return $self->cmd( %cmd, @_ ); | 
|  | } | 
| =pod |  | 
|  | if ( exists $ACCESS{$method} ) { | 
| =item sudb_view | my $s    = *$self->{net_telnet_trango}; | 
|  | my $prev = $s->{$method}; | 
| returns a reference to an array of hashes each containing: | ( $s->{$method} ) = @_ if @_; | 
|  | return $prev; | 
| suid | } | 
| type |  | 
| cir | $method = "SUPER::$method"; | 
| mir | return $self->$method(@_); | 
| mac | } | 
|  |  | 
| =cut | =pod | 
|  |  | 
| sub sudb_view | =head2 B<open> - Open a connection to a Trango AP. | 
| { |  | 
| my $self = shift; | 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 | 
| my @lines = $self->cmd( String => 'sudb view', expect => $success ); | host_type() and firmware_version() | 
|  |  | 
| return undef unless @lines; | =cut | 
|  |  | 
| my @sus; | sub open { | 
| foreach (@lines) { | my $self = shift; | 
| if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9a-fA-F]+)/) { |  | 
| my %s = ( | unless ( $self->SUPER::open(@_) ) { | 
| suid => $1, | $self->last_error( "Couldn't connect to " . $self->host . ":  $!" ); | 
| type => $2, | return; | 
| cir  => $3, | } | 
| mir  => $4, |  | 
| mac  => $5, | ## Get to login prompt | 
| ); | unless ( | 
| push @sus, \%s; | $self->waitfor( | 
| } | -match   => '/password: ?$/i', | 
| } | -errmode => "return", | 
|  | ) | 
| return \@sus; | ) | 
| } | { | 
|  | $self->last_error( "problem connecting to host (" | 
| =pod | . $self->host . "): " | 
|  | . $self->lastline ); | 
| =item enable_tftpd | return; | 
|  | } | 
| runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing |  | 
|  | $self->parse_login_banner( $self->lastline ); | 
| =cut |  | 
|  | $self->is_connected(1); | 
| sub enable_tftpd |  | 
| { | return $self->is_connected; | 
| my $self = shift; | } | 
|  |  | 
| my $vals = $self->tftpd( args => 'on' ); | =pod | 
|  |  | 
| if ($vals->{'Tftpd'} eq 'listen') { | =head2 B<login> - Login to the AP. | 
| return $vals; |  | 
| } else { | Calls open() if not already connected, then sends the password and sets | 
| return undef; | logged_in() if successful | 
| } |  | 
| } | =cut | 
|  |  | 
| =pod | sub login { | 
|  | my $self = shift; | 
| =item disable_tftpd |  | 
|  | unless ( $self->is_connected ) { | 
| runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled' | $self->open or return; | 
|  | } | 
| =cut |  | 
|  | my $password = shift; | 
| sub disable_tftpd |  | 
| { | $self->print($password); | 
| my $self = shift; | unless ( | 
|  | $self->waitfor( | 
| my $vals = $self->tftpd( args => 'off' ); | -match   => $self->prompt, | 
|  | -errmode => "return", | 
| if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') { | ) | 
| return $vals; | ) | 
| } else { | { | 
| return undef; | $self->last_error( "login ($self->host) failed: " . $self->lastline ); | 
| } | return; | 
| } | } | 
|  |  | 
| =pod | $self->logged_in(1); | 
|  |  | 
| =item cmd | return $self->logged_in; | 
|  | } | 
| This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango. |  | 
|  | =pod | 
| Normally returns the last lines from from the command |  | 
|  | =head2 B<parse_login_banner> - Converts the login_banner to something useful. | 
| Also accepts these options: |  | 
|  | Takes a login banner (what you get when you first connect to the Trango) | 
| I<decode> | or reads what is already in login_banner() then parses it and sets | 
| - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output | host_type() and firmware_version() as well as login_banner() | 
|  |  | 
| I<cmd_disconnects> | =cut | 
| - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false |  | 
|  | sub parse_login_banner { | 
| I<expect> | my $self = shift; | 
| - 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 |  | 
|  | if (@_) { | 
| I<args> | $self->login_banner(@_); | 
| - a string containing the command line options that are passed to the command | } | 
|  |  | 
| =cut | my $banner = $self->login_banner; | 
|  |  | 
| sub cmd | my ( $type, $sep1, $subtype, $sep2, $ver ) | 
| { | = $banner | 
| my $self = shift; | =~ /Welcome to Trango Broadband Wireless,? (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i; | 
|  |  | 
| my @valid_net_telnet_opts = qw( | $type .= $sep1 . $subtype; | 
| String | $ver = $subtype . $sep2 . $ver; | 
| Output |  | 
| Cmd_remove_mode | $self->login_banner($banner); | 
| Errmode | $self->host_type($type); | 
| Input_record_separator | $self->firmware_version($ver); | 
| Ors |  | 
| Output_record_separator | return 1; | 
| Prompt | } | 
| Rs |  | 
| Timeout | =pod | 
| ); |  | 
|  | =head2 B<linktest> - Link test to SU | 
| my %cfg; |  | 
| if (@_ == 2) { | linktest('suid'[, 'pkt len, bytes'[, '# of pkts'[, '# of cycles']]]); | 
| $cfg{'String'} = shift; |  | 
| } elsif (@_ > 2) { | Returns a hash reference to the results of the test | 
| %cfg = @_; |  | 
| } | =cut | 
|  |  | 
| $cfg{'Timeout'} ||= $self->Timeout; | sub linktest { | 
|  | my $self = shift; | 
| unless ($cfg{'String'}) { | my $suid = shift; | 
| #$! = "No command passed"; |  | 
| #warn "No command passed\n"; | # These numbers are what I found as defaults when running the command | 
| return undef; | my $pkt_len = shift || 1600; | 
| } | my $pkt_cnt = shift || 500; | 
|  | my $cycles  = shift || 10; | 
| unless ($self->is_connected) { |  | 
| #$! = "Not connected"; | my %config = @_; | 
| #warn "Not connected\n"; |  | 
| return undef; | # * 2, one for the FromAP, one FromSU.  Then / 1000 to get to ms. | 
| } | # XXX This might need to be changed, this makes the default timeout the | 
|  | # same as $pkt_len, and that might not be enough at slower speeds. | 
| unless ($self->logged_in) { | $config{Timeout} ||= int( ( $pkt_len * $pkt_cnt * $cycles * 2 ) / 1000 ); | 
| #$! = "Not logged in"; |  | 
| #warn "Not logged in\n"; | my $string = join $SPACE, 'linktest', $suid, $pkt_len, $pkt_cnt, $cycles; | 
| return undef; | return $self->cmd( | 
| } | %config, | 
|  | String => $string, | 
|  | decode => 'linktest', | 
| my %cmd; | ); | 
| foreach (@valid_net_telnet_opts) { |  | 
| if (exists $cfg{$_}) { | } | 
| $cmd{$_} = $cfg{$_}; |  | 
| } | =pod | 
| } |  | 
| if ($cfg{'args'}) { | =head2 B<su_password> - Set the password on SUs connected to the AP. | 
| $cmd{'String'} .= ' ' . $cfg{'args'}; |  | 
| } | su_password('new_password'[, 'suid']) If no suid is specified, | 
| my @lines; | the default is "all". | 
| unless ($cfg{'no_prompt'}) { |  | 
| @lines = $self->SUPER::cmd(%cmd); | $t->su_password('good_pass', 5); | 
| } else { |  | 
| $self->print($cmd{'String'}); | =cut | 
| @lines = $self->lastline; |  | 
| } | sub su_password { | 
|  | my $self     = shift; | 
| $self->last_lines(\@lines); | my $new_pass = shift || $EMPTY; | 
|  | my $su       = shift || 'all'; | 
| my $vals = 1; |  | 
| if ($cfg{'decode'}) { | unless ( defined $new_pass ) { | 
| if ($cfg{'decode'} eq 'each') { | $self->last_error("No new password"); | 
| $vals = _decode_each_line(@lines); |  | 
| } elsif ($cfg{'decode'} eq 'sulog') { | #return; | 
| $vals = _decode_sulog(@lines); | } | 
| } else { |  | 
| $vals = _decode_lines(@lines); | return $self->cmd( | 
| } | String => 'su password ' | 
| } | . $su | 
|  | . $SPACE | 
| $self->last_vals($vals); | . $new_pass | 
|  | . $SPACE | 
|  | . $new_pass, | 
| my $last = $self->lastline; | expect => $success, | 
|  | ); | 
| if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) { | } | 
| if ($cfg{'cmd_disconnects'}) { |  | 
| $self->logged_in(0); | =pod | 
| $self->close; |  | 
| $self->is_connected(0); | =head2 B<ipconfig> - Change IP configuration | 
| } |  | 
|  | ipconfig( 'new_ip', 'new_subnet', 'new_gateway' ) | 
| if ($cfg{'decode'}) { |  | 
| return $vals; | $t->ipconfig( '10.0.1.5', '255.255.255.0', '10.0.1.1' ); | 
| } else { |  | 
| return @lines; | =cut | 
| } |  | 
| } else { | sub ipconfig { | 
| #$! = "Error with command ($cfg{'string'}): $last"; | my $self = shift; | 
| return undef; |  | 
| } | my $string = join $SPACE, 'ipconfig', @_; | 
| } |  | 
|  | if ( @_ == 3 ) { | 
| #=item _decode_lines | $self->print($string); | 
|  | my @lines = $self->waitfor( Match => '/save\s+and\s+activate/', ); | 
| sub _decode_lines | $self->print('y'); | 
| { |  | 
| my @lines = @_; | $self->logged_in(0); | 
|  | $self->is_connected(0); | 
| my %conf; |  | 
|  | foreach my $line (@lines) { | 
| my $key = ''; | if ( $line =~ s/New \s configuration:\s+//xms ) { | 
| my $val = ''; | return _decode_lines($line); | 
| my $in_key = 0; | } | 
| my $in_val = 0; | } | 
|  |  | 
| foreach my $line (@lines) { | return {}; | 
| next if $line =~ /$success$/; | } | 
|  |  | 
| my @chars = split //, $line; | # ipconfig [ <new ip> <new subnet> <new gateway> ] | 
|  | return $self->cmd( String => $string, expect => $success ); | 
| my $last_key = ''; | } | 
| foreach my $c (@chars) { |  | 
|  | =pod | 
| if ($c eq '[' || $c eq "\r" || $c eq "\n") { |  | 
| if ($c eq '[') { | =head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP. | 
| $in_key = 1; |  | 
| $in_val = 0; | su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' ) | 
| } else { |  | 
| $in_key = 0; | $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' ); | 
| $in_val = 0; |  | 
| } | =cut | 
|  |  | 
| if ($key) { | sub su_ipconfig { | 
| $key =~ s/^\s+//; | my $self = shift; | 
| $key =~ s/\s+$//; |  | 
|  | my $suid        = shift; | 
| $val =~ s/^\s+//; | my $new_ip      = shift; | 
| $val =~ s/\s+$//; | my $new_subnet  = shift; | 
|  | my $new_gateway = shift; | 
| if ($key eq 'Checksum' && $last_key) { |  | 
| # Special case for these bastids. | if ( $suid =~ /\D/ ) { | 
| my $new = $last_key; | $self->last_error("Invalid suid '$suid'"); | 
| $new =~ s/\s+\S+$//; | return; | 
| $key = $new . " " . $key; | } | 
| } | unless ($new_ip) { | 
|  | $self->last_error("no new_ip passed"); | 
| $last_key = $key; | return; | 
| $conf{$key} = $val; | } | 
| $key = ''; | unless ($new_subnet) { | 
| $val = ''; | $self->last_error("no new_subnet passed"); | 
| } | return; | 
|  | } | 
| } elsif ($c eq ']') { | unless ($new_gateway) { | 
| $in_val = 1; | $self->last_error("no new_gateway passed"); | 
| $in_key = 0; | return; | 
| $c = shift @chars; | } | 
|  |  | 
| } elsif ($in_key) { | # su ipconfig <suid> <new ip> <new subnet> <new gateway> | 
| $key .= $c; | return $self->cmd( | 
|  | String => 'su ipconfig ' | 
| } elsif ($in_val) { | . $suid | 
| $val .= $c; | . $SPACE | 
| } | . $new_ip | 
| } | . $SPACE | 
| } | . $new_subnet | 
|  | . $SPACE | 
| if (%conf) { | . $new_gateway, | 
| return \%conf; | expect => $success, | 
| } else { | ); | 
| return undef; | } | 
| } |  | 
| } | =pod | 
|  |  | 
| #=item _decode_each_line | =head2 B<sudb_view> - Returns the output from the sudb view command | 
|  |  | 
| sub _decode_each_line | returns a reference to an array of hashes each containing these keys | 
| { | 'suid', 'su2su', 'type', 'cir', 'mir' and 'mac' | 
| my @lines = @_; |  | 
| my @decoded; | =cut | 
| foreach my $line (@lines) { |  | 
| my $decoded = _decode_lines($line); | sub sudb_view { | 
| push @decoded, $decoded if defined $decoded; | my $self = shift; | 
| } |  | 
| return \@decoded; | my $lines = $self->cmd( String => 'sudb view', expect => $success ) || []; | 
| } |  | 
|  | return unless @{$lines}; | 
| #=item _decode_sulog |  | 
|  | my $s = *$self->{net_telnet_trango}; | 
| sub _decode_sulog | return $lines if !$s->{'Decode'}; | 
| { |  | 
| my @lines = @_; | my @sus; | 
| my @decoded; | foreach ( @{$lines} ) { | 
| my $last_tm; | next unless $_; | 
| foreach my $line (@lines) { | if (/^ | 
| my $decoded = _decode_lines($line); | \[(\d+)\] | 
|  | \s+ | 
| if (defined $decoded) { | [[:xdigit:]]{2} | 
| if ($decoded->{'tm'}) { | ([[:xdigit:]]) | 
| $last_tm = $decoded->{'tm'}; | ([[:xdigit:]]) | 
| next; | \s+ | 
| } else { | (\d+) | 
| $decoded->{'tm'} = $last_tm; | \s+ | 
| } | (\d+) | 
| next unless $last_tm; | \s+ | 
|  | ([[:xdigit:]\s]+) | 
| push @decoded, $decoded if defined $decoded; | $/ixms | 
| } | ) | 
| } | { | 
| return \@decoded; | my %s = ( | 
| } | suid  => $1, | 
|  | su2su => $2 ? $2 : undef, | 
| 1; | type  => $3 == 1 ? 'reg' : $3 == 5 ? 'pri' : $3, | 
| __END__ | cir   => $4, | 
|  | mir   => $5, | 
| =back | mac   => $6, | 
|  | ); | 
| =head1 SEE ALSO |  | 
|  | $s{'mac'} =~ s/\s//gxms; | 
| Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm | $s{'mac'} = uc( $s{'mac'} ); | 
|  |  | 
| L<Net::Telnet> | push @sus, \%s; | 
|  | } | 
| =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. | return \@sus; | 
|  | } | 
| 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. |  | 
|  | =pod | 
| =head1 AUTHOR |  | 
|  | =head2 B<sudb_add> - Adds an su to the sudb | 
| Andrew Fresh E<lt>andrew@rraz.netE<gt> |  | 
|  | Takes the following paramaters | 
| =head1 COPYRIGHT AND LICENSE |  | 
|  | suid : numeric, | 
| Copyright (C) 2005 by Andrew Fresh | type : (reg|pr) | 
|  | cir  : numeric, | 
| This library is free software; you can redistribute it and/or modify | mir  : numeric, | 
| it under the same terms as Perl itself, either Perl version 5.8.7 or, | mac  : Almost any format, it will be reformatted, | 
| at your option, any later version of Perl 5 you may have available. |  | 
|  | and returns true on success or undef otherwise. | 
|  |  | 
| =cut | $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]//g; | 
|  | unless ( length $new_mac == 12 ) { | 
|  | $self->last_error("Invalid MAC '$mac'"); | 
|  | return; | 
|  | } | 
|  | $new_mac = join $SPACE, $new_mac =~ /../g; | 
|  |  | 
|  | my $string | 
|  | = 'sudb add ' | 
|  | . $suid | 
|  | . $SPACE | 
|  | . $type | 
|  | . $SPACE | 
|  | . $cir | 
|  | . $SPACE | 
|  | . $mir | 
|  | . $SPACE | 
|  | . $new_mac; | 
|  |  | 
|  | return $self->cmd( String => $string, expect => $success ); | 
|  | } | 
|  |  | 
|  | =pod | 
|  |  | 
|  | =head2 B<sudb_delete> - removes an su from the sudb | 
|  |  | 
|  | 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<sudb_modify> - changes the su information in the sudb | 
|  |  | 
|  | 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 . $SPACE . $opt . $SPACE . $value; | 
|  |  | 
|  | return $self->cmd( String => $string, expect => $success ); | 
|  | } | 
|  |  | 
|  | =pod | 
|  |  | 
|  | =head2 B<enable_tftpd> - enable the TFTP server | 
|  |  | 
|  | runs C<tftpd(args =E<gt> '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_tftpd> - disable the TFTP server | 
|  |  | 
|  | runs C<tftpd(args =E<gt> '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<cmd> - 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<decode> | 
|  | - if this is true, then it will send the output lines to _decode_lines() | 
|  | and then returns the decoded output | 
|  |  | 
|  | I<no_prompt> | 
|  | - if this is true, it does not wait for a prompt, so you are not stuck | 
|  | waiting for something that will never happen. | 
|  |  | 
|  | I<cmd_disconnects> | 
|  | - if this is true, it then sets logged_in() to false, then it will | 
|  | close() the connection and set 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 | 
|  |  | 
|  | $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); | 
|  |  | 
|  | =cut | 
|  |  | 
|  | sub cmd { | 
|  | my $self = shift; | 
|  | my $s    = *$self->{net_telnet_trango}; | 
|  |  | 
|  | 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'} .= $SPACE . $cfg{'args'}; | 
|  | } | 
|  |  | 
|  | #print "Running cmd $cmd{String}\n"; | 
|  | my @lines; | 
|  | if ( $cfg{'no_prompt'} ) { | 
|  | $self->print( $cmd{'String'} ); | 
|  | @lines = $self->lastline; | 
|  | } | 
|  | else { | 
|  | @lines = $self->SUPER::cmd(%cmd); | 
|  | } | 
|  |  | 
|  | $self->last_lines( \@lines ); | 
|  |  | 
|  | my $last   = $self->lastline; | 
|  | my $prompt = $self->prompt; | 
|  | $prompt =~ s{^/}{}xms; | 
|  | $prompt =~ s{/[gixms]*$}{}xms; | 
|  | while ( @lines && $last =~ qr($prompt) ) { | 
|  | pop @lines; | 
|  | $last = $lines[-1]; | 
|  | } | 
|  | $self->last_error($EMPTY); | 
|  |  | 
|  | my $vals = 1; | 
|  | if ( $s->{'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); | 
|  | if ( !$vals ) { | 
|  | $self->last_error("Error decoding maclist"); | 
|  | } | 
|  | } | 
|  | elsif ( $cfg{'decode'} eq 'linktest' ) { | 
|  | $vals = _decode_linktest(@lines); | 
|  | if ( !$vals ) { | 
|  | $self->last_error("Error decoding linktest"); | 
|  | } | 
|  | } | 
|  | elsif ( $cfg{'decode'} eq 'freq' ) { | 
|  | $vals = _decode_freq(@lines); | 
|  | } | 
|  | else { | 
|  | $vals = _decode_lines(@lines); | 
|  | } | 
|  | } | 
|  | if ( ref $vals eq 'HASH' ) { | 
|  | $vals->{_raw} = join q{}, @lines; | 
|  | } | 
|  | $self->last_vals($vals); | 
|  |  | 
|  | if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) { | 
|  | if ( $cfg{'cmd_disconnects'} ) { | 
|  | $self->logged_in(0); | 
|  | $self->close; | 
|  | $self->is_connected(0); | 
|  | } | 
|  |  | 
|  | if ( $s->{'Decode'} && $cfg{'decode'} ) { | 
|  | return $vals; | 
|  | } | 
|  | else { | 
|  | return \@lines; | 
|  | } | 
|  | } | 
|  | else { | 
|  | my $err; | 
|  | if ( grep {/\[ERR\]/} @lines ) { | 
|  | $err = _decode_lines(@lines); | 
|  | } | 
|  |  | 
|  | if ( ref $err eq 'HASH' && $err->{ERR} ) { | 
|  | $self->last_error( $err->{ERR} ); | 
|  | } | 
|  | else { | 
|  | $self->last_error("Error with command ($cmd{'String'}): $last"); | 
|  | } | 
|  | return; | 
|  | } | 
|  | } | 
|  |  | 
|  | #=item _decode_lines | 
|  |  | 
|  | sub _decode_lines { | 
|  | my @lines = @_; | 
|  |  | 
|  | my %conf; | 
|  |  | 
|  | my $key = $EMPTY; | 
|  | my $val = undef; | 
|  | my @vals; | 
|  | my $in_key = 0; | 
|  | my $in_val = 1; | 
|  |  | 
|  | LINE: while ( my $line = shift @lines ) { | 
|  | next LINE if $line =~ /$success\Z/; | 
|  | next LINE if $line =~ /^ \*+ \s+ \d+ \s+ \*+ \Z/xms; | 
|  |  | 
|  | # Special decode for sysinfo on a TrangoLink 45 | 
|  | if ( $line =~ /^(.* Channel \s+ Table):\s*(.*)\Z/xms ) { | 
|  | my $key  = $1; | 
|  | my $note = $2; | 
|  |  | 
|  | my %vals; | 
|  | while ( $line = shift @lines ) { | 
|  | if ( $line =~ /^\Z/ ) { | 
|  | $conf{$key} = \%vals; | 
|  | $conf{$key}{note} = $note; | 
|  | next LINE; | 
|  | } | 
|  |  | 
|  | my $decoded = _decode_lines($line); | 
|  | if ($decoded) { | 
|  | %vals = ( %vals, %{$decoded} ); | 
|  | } | 
|  | } | 
|  | } | 
|  |  | 
|  | # Another special decode for the TrangoLink | 
|  | elsif ( | 
|  | $line =~ /^ | 
|  | RF \s Band \s \# | 
|  | (\d+) \s+ | 
|  | \( ([^\)]+) \) \s* | 
|  | (.*)$ | 
|  | /xms | 
|  | ) | 
|  | { | 
|  | my $num   = $1; | 
|  | my $band  = $2; | 
|  | my $extra = $3; | 
|  |  | 
|  | if ( $extra =~ /\[/ ) { | 
|  | my $decoded = _decode_lines($extra); | 
|  | $conf{'RF Band'}{$num} = $decoded; | 
|  | } | 
|  | else { | 
|  | $conf{'RF Band'}{$num}{$extra} = 1; | 
|  | } | 
|  | next LINE; | 
|  | } | 
|  |  | 
|  | my @chars = split //, $line; | 
|  |  | 
|  | my $last_key = $EMPTY; | 
|  | 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 . $SPACE . $key; | 
|  | } | 
|  |  | 
|  | $conf{$key} = $val; | 
|  | $last_key   = $key; | 
|  | $key        = $EMPTY; | 
|  | } | 
|  | elsif ($val) { | 
|  | push @vals, $val; | 
|  | } | 
|  | $val = $EMPTY; | 
|  |  | 
|  | } | 
|  | 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; | 
|  | } | 
|  |  | 
|  | foreach my $val (@vals) { | 
|  | if ( defined $val && length $val ) { | 
|  | $val =~ s/^\s+//; | 
|  | $val =~ s/\s+\.*$//; | 
|  | } | 
|  | } | 
|  |  | 
|  | 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 && length $decoded; | 
|  | } | 
|  | return \@decoded; | 
|  | } | 
|  |  | 
|  | #=item _decode_linktest | 
|  |  | 
|  | sub _decode_linktest { | 
|  | my @lines = @_; | 
|  | my %decoded; | 
|  | foreach my $line (@lines) { | 
|  |  | 
|  | if ( $line =~ s/^(\d+) \s+ //xms ) { | 
|  | my $line_id = $1; | 
|  | my ( $tm, $rt ); | 
|  | if ( $line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms ) { | 
|  | $rt = $1; | 
|  | } | 
|  | if ( $line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms ) { | 
|  | $tm = $1; | 
|  | } | 
|  |  | 
|  | my $d = _decode_lines( $line . "\n" ); | 
|  | $decoded{tests}[$line_id]         = $d; | 
|  | $decoded{tests}[$line_id]{'time'} = $tm; | 
|  | $decoded{tests}[$line_id]{rate}   = $rt; | 
|  | } | 
|  |  | 
|  | else { | 
|  | my $d = _decode_lines( $line . "\n" ); | 
|  | if ($d) { | 
|  | while ( my ( $k, $v ) = each %{$d} ) { | 
|  | $decoded{$k} = $v; | 
|  | } | 
|  | } | 
|  | } | 
|  |  | 
|  | } | 
|  | 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 { | 
|  | return; | 
|  | } | 
|  | } | 
|  |  | 
|  | #=item _decode_freq | 
|  |  | 
|  | sub _decode_freq { | 
|  | my @lines   = @_; | 
|  | my $decoded = _decode_lines(@lines); | 
|  |  | 
|  | if ( $decoded && $decoded->{ERR} ) { | 
|  | return $decoded; | 
|  | } | 
|  |  | 
|  | LINE: foreach my $line (@lines) { | 
|  | if (my ( $channel, $polarity, $freq ) | 
|  | = $line =~ / | 
|  | Ch \s+ \#(\d+) | 
|  | \s+ | 
|  | (\w+) | 
|  | \s+ | 
|  | \[ (\d+) \s+ MHz\] | 
|  | /ixms | 
|  | ) | 
|  | { | 
|  | $decoded = { | 
|  | channel   => $channel, | 
|  | polarity  => $polarity, | 
|  | frequency => $freq, | 
|  | }; | 
|  | last LINE; | 
|  | } | 
|  | } | 
|  | return $decoded; | 
|  | } | 
|  |  | 
|  | 1;    # End of Net::Telnet::Trango | 
|  | __END__ | 
|  |  | 
|  | =head1 SEE ALSO | 
|  |  | 
|  | Trango Documentation - | 
|  | L<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 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<http://annocpan.org/dist/Net-Telnet-Trango> | 
|  |  | 
|  | =item * CPAN Ratings | 
|  |  | 
|  | L<http://cpanratings.perl.org/d/Net-Telnet-Trango> | 
|  |  | 
|  | =item * RT: CPAN's request tracker | 
|  |  | 
|  | L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Telnet-Trango> | 
|  |  | 
|  | =item * Search CPAN | 
|  |  | 
|  | L<http://search.cpan.org/dist/Net-Telnet-Trango> | 
|  |  | 
|  | =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 |