#! @PERLV_PATH@
##
## $Id$
##
## @PACKAGE@ @VERSION@
## Copyright (c) 1997-2008 by Terrapin Communications, Inc.
## All rights reserved.
##
## This code is derived from software contributed to and maintained by
## Terrapin Communications, Inc. by Henry Kilmer, John Heasley, Andrew Partan,
## Pete Whiting, Austin Schutz, and Andrew Fort.
##
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following conditions
## are met:
## 1. Redistributions of source code must retain the above copyright
## notice, this list of conditions and the following disclaimer.
## 2. Redistributions in binary form must reproduce the above copyright
## notice, this list of conditions and the following disclaimer in the
## documentation and/or other materials provided with the distribution.
## 3. All advertising materials mentioning features or use of this software
## must display the following acknowledgement:
## This product includes software developed by Terrapin Communications,
## Inc. and its contributors for RANCID.
## 4. Neither the name of Terrapin Communications, Inc. nor the names of its
## contributors may be used to endorse or promote products derived from
## this software without specific prior written permission.
## 5. It is requested that non-binding fixes and modifications be contributed
## back to Terrapin Communications, Inc.
##
## THIS SOFTWARE IS PROVIDED BY Terrapin Communications, INC. AND CONTRIBUTORS
## ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
## PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COMPANY OR CONTRIBUTORS
## BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
## CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
## SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
## INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
## CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
## ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
## POSSIBILITY OF SUCH DAMAGE.
#
# hacked version of Hank's rancid - this one tries to deal with redbacks.
#
# RANCID - Really Awesome New Cisco confIg Differ
#
# usage: rancid [-dV] [-l] [-f filename | hostname]
#
use Getopt::Std;
getopts('dflV');
if ($opt_V) {
print "@PACKAGE@ @VERSION@\n";
exit(0);
}
$log = $opt_l;
$debug = $opt_d;
$file = $opt_f;
$host = $ARGV[0];
$clean_run = 0;
$found_end = 0;
$timeo = 90; # clogin timeout in seconds
my(@commandtable, %commands, @commands);# command lists
my($aclsort) = ("ipsort"); # ACL sorting mode
my($filter_commstr); # SNMP community string filtering
my($filter_pwds); # password filtering mode
# This routine is used to print out the router configuration
sub ProcessHistory {
my($new_hist_tag,$new_command,$command_string,@string) = (@_);
if ((($new_hist_tag ne $hist_tag) || ($new_command ne $command))
&& defined %history) {
print eval "$command \%history";
undef %history;
}
if (($new_hist_tag) && ($new_command) && ($command_string)) {
if ($history{$command_string}) {
$history{$command_string} = "$history{$command_string}@string";
} else {
$history{$command_string} = "@string";
}
} elsif (($new_hist_tag) && ($new_command)) {
$history{++$#history} = "@string";
} else {
print "@string";
}
$hist_tag = $new_hist_tag;
$command = $new_command;
1;
}
sub numerically { $a <=> $b; }
# This is a sort routine that will sort numerically on the
# keys of a hash as if it were a normal array.
sub keynsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort numerically keys(%lines)) {
$sorted_lines[$i] = $lines{$key};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# keys of a hash as if it were a normal array.
sub keysort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort keys(%lines)) {
$sorted_lines[$i] = $lines{$key};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# values of a hash as if it were a normal array.
sub valsort{
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort values %lines) {
$sorted_lines[$i] = $key;
$i++;
}
@sorted_lines;
}
# This is a numerical sort routine (ascending).
sub numsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $num (sort {$a <=> $b} keys %lines) {
$sorted_lines[$i] = $lines{$num};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# ip address when the ip address is anywhere in
# the strings.
sub ipsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $addr (sort sortbyipaddr keys %lines) {
$sorted_lines[$i] = $lines{$addr};
$i++;
}
@sorted_lines;
}
# These two routines will sort based upon IP addresses
sub ipaddrval {
my(@a) = ($_[0] =~ m#^(\d+)\.(\d+)\.(\d+)\.(\d+)$#);
$a[3] + 256 * ($a[2] + 256 * ($a[1] +256 * $a[0]));
}
sub sortbyipaddr {
&ipaddrval($a) <=> &ipaddrval($b);
}
# This routine parses "show version"
sub ShowVersion {
print STDERR " In ShowVersion: $_" if ($debug);
while () {
tr/\015//d;
last if(/^$prompt/);
/(Copyright|uptime|restarted|^\s*$)/ && next;
/(Up Time|Boot Time)/ && next;
ProcessHistory("COMMENTS","keysort","A1","!Image: $_");
}
return;
}
# This routine parses "dir /"
sub DirFlash {
print STDERR " In DirFlash: $_" if ($debug);
my($dev) = (/\/(.*)$/);
while () {
tr/\015//d;
last if(/^$prompt/);
/^\s*$/ && next;
/(Can\'t open|No such device)/ && return;
/is not a valid path on a local file system/ && return;
ProcessHistory("FLASH","keysort",$dev,"!Flash: $dev: $_");
}
ProcessHistory("FLASH","keysort",$dev,"!\n");
return;
}
# This routine parses "show hardware"
sub ShowHardware {
print STDERR " In ShowHardware: $_" if ($debug);
while () {
tr/\015//d;
last if(/^$prompt/);
s/\s*$/\n/;
/Can not retrieve information/ && return;
/^Temperature:/ && next;
/^Voltage/ && next;
/^$/ && next;
#ProcessHistory("","","","!Chassis: $_") && next;
ProcessHistory("COMMENTS","keysort","B1","!Chassis: $_");
}
ProcessHistory("COMMENTS","keysort","B1","!\n");
return;
}
# This routine parses "show chassis"
sub ShowChassis {
print STDERR " In ShowChassis: $_" if ($debug);
while () {
tr/\015//d;
last if(/^$prompt/);
last if(/^invalid input at/i);
next if(/^(\s*|\s*$cmd\s*|\s+\^)$/);
ProcessHistory("COMMENTS","keysort","C1","!Chassis: $_");
}
ProcessHistory("COMMENTS","keysort","C1","!\n");
return;
}
# This routine parses "show slot table"
sub ShowSlotTable {
print STDERR " In ShowSlotTable: $_" if ($debug);
while () {
tr/\015//d;
last if(/^$prompt/);
/(Slot Table|^$)/ && next;
/^\s+\^/ && next;
/Invalid input at/ && return;
s/^\s*//;
ProcessHistory("COMMENTS","keysort","D1","!Slot Table: $_");
}
ProcessHistory("COMMENTS","keysort","D1","!\n");
return;
}
# This routine processes a "write term"
sub WriteTerm {
print STDERR " In WriteTerm: $_" if ($debug);
while () {
tr/\015//d;
last if(/^$prompt/);
next if(/^\s*$/);
# /Non-Volatile memory is in use/ && return(-1); # NvRAM is locked
# Dog gone Cool matches to process the rest of the config
/^! last updated: .*$/ && next; # kill last updated line
/^Building configuration/ && next; # kill Building config line
/^Current configuration/ && next; # kill Current config line
/^! Configuration last changed by user / && next;
/^ length / && next; # kill length on serial lines
/^ width / && next; # kill width on serial lines
# filter out any RCS/CVS tags to avoid confusing local CVS storage
s/\$(Revision|Id):/ $1:/;
# order access-lists
/^access-list\s+(\d\d?)\s+(\S+)\s+(\S+)/ &&
ProcessHistory("ACL $1 $2","$aclsort","$3","$_") && next;
# prune snmp community statements
if (/^snmp (group|community) (\S+)/) {
if ($filter_commstr) {
ProcessHistory("SNMPSERVERCOMM","keysort","$_","!snmp $1 $'") && next;
} else {
ProcessHistory("SNMPSERVERCOMM","keysort","$_","$_") && next;
}
}
ProcessHistory("","","","$_");
# end of config
if (/^end$/) {
$found_end = 1;
last;
}
}
return;
}
# dummy function
sub DoNothing {print STDOUT;}
# Main subroutine that splits up the work
# All Subs return the name of the next function to use.
# If the sub returns a new funtion name, that name will be used
# else the main loop keeps using the current function
sub FlailHelplessly {
print STDERR "Flailing: $_" if ($debug);
print STDOUT "Flailing: $_" if ($log);
/#(show version)$/ && delete($commands{$1}) && return("ShowVersion");
/#(show hardware)$/ && delete($commands{$1}) && return("ShowHardware");
/#(show chassis)$/ && delete($commands{$1}) && return("ShowChassis");
/#(show slot table)$/ && delete($commands{$1}) && return("ShowSlotTable");
/#(show config)$/ && delete($commands{$1}) && return("WriteTerm");
return "FlailHelplessly";
}
# Main
@commandtable = (
{'show version' => 'ShowVersion'},
{'dir /flash' => 'DirFlash'},
{'dir /pcmcia0' => 'DirFlash'},
{'dir /pcmcia1' => 'DirFlash'},
{'show hardware' => 'ShowHardware'},
{'show chassis' => 'ShowChassis'},
{'show slot table' => 'ShowSlotTable'},
{'show config' => 'WriteTerm'}
);
# Use an array to preserve the order of the commands and a hash for mapping
# commands to the subroutine and track commands that have been completed.
@commands = map(keys(%$_), @commandtable);
%commands = map(%$_, @commandtable);
$redback_cmds=join(";",@commands);
$cmds_regexp=join("|",@commands);
if (length($host) == 0) {
if ($file) {
print(STDERR "Too few arguments: file name required\n");
exit(1);
} else {
print(STDERR "Too few arguments: host name required\n");
exit(1);
}
}
open(OUTPUT,">$host.new") || die "Can't open $host.new for writing: $!\n";
select(OUTPUT);
# make OUTPUT unbuffered
if ($debug) { $| = 1; }
if ($file) {
print STDERR "opening file $host\n" if ($debug);
print STDOUT "opening file $host\n" if ($log);
open(INPUT,"<$host") || die "open failed for $host: $!\n";
} else {
print STDERR "executing clogin -t $timeo -c\"$redback_cmds\" $host\n" if ($debug);
print STDOUT "executing clogin -t $timeo -c\"$redback_cmds\" $host\n" if ($log);
if (defined($ENV{NOPIPE})) {
system "clogin -t $timeo -c \"$redback_cmds\" $host $host.raw" || die "clogin failed for $host: $!\n";
open(INPUT, "< $host.raw") || die "clogin failed for $host: $!\n";
} else {
open(INPUT,"clogin -t $timeo -c \"$redback_cmds\" $host ) {
tr/\015//d;
if (/\#exit$/) {
$clean_run=1;
last;
}
if (/^Error:/) {
print STDOUT ("$host clogin error: $_");
print STDERR ("$host clogin error: $_") if ($debug);
$clean_run=0;
last;
}
while (/#\s*($cmds_regexp)\s*$/) {
$cmd = $1;
if (!defined($prompt)) {
$prompt = ($_ =~ /^([^#]*#)/)[0];
$prompt =~ s/([][}{)(\\])/\\$1/g; # quote the damn []'s
print STDERR ("PROMPT MATCH: $prompt\n") if ($debug);
}
print STDERR ("HIT COMMAND:$_") if ($debug);
if (! defined($commands{$cmd})) {
print STDERR "$host: found unexpected command - \"$cmd\"\n";
$clean_run = 0;
last;
}
$rval = &{$commands{$cmd}};
delete($commands{$cmd});
if ($rval == -1) {
$clean_run = 0;
last;
}
}
}
print STDOUT "Done $logincmd: $_\n" if ($log);
# Flush History
ProcessHistory("","","","");
# Cleanup
close(INPUT);
close(OUTPUT);
if (defined($ENV{NOPIPE})) {
unlink("$host.raw") if (! $debug);
}
# check for completeness
if (scalar(%commands) || !$clean_run || !$found_end) {
if (scalar(%commands)) {
printf(STDOUT "$host: missed cmd(s): %s\n", join(',', keys(%commands)));
printf(STDERR "$host: missed cmd(s): %s\n", join(',', keys(%commands))) if ($debug);
}
if (!$clean_run || !$found_end) {
print STDOUT "$host: End of run not found\n";
print STDERR "$host: End of run not found\n" if ($debug);
system("/usr/bin/tail -1 $host.new");
}
unlink "$host.new" if (! $debug);
}