cnrancid

#! /usr/bin/perl
##
## $Id: mrvrancid.in 2246 2010-09-08 01:36:07Z heas $
##
## rancid 2.3.6
## 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.
#
# Amazingly hacked version of Hank's rancid - this one tries to
# deal with MegaVision MRV.
#
#  RANCID - Really Awesome New Cisco confIg Differ
#
# usage: rancid [-dV] [-l] [-f filename | hostname]
#
use Getopt::Std;
getopts('dflV');
if ($opt_V) {
    print "rancid 2.3.6\n";
    exit(0);
}
$log = $opt_l;
$debug = $opt_d;
$file = $opt_f;
$host = $ARGV[0];
$ios = "IOS";
$clean_run = 0;
$found_end = 0;
$found_version = 0;
$found_env = 0;
$found_diag = 0;
$timeo = 90;                # clogin timeout in seconds

# force a terminal type so as not to confuse the POS
$ENV{'TERM'} = "vt100";

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))
    && scalar(%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 (<INPUT>) {
#   tr/\015//d;
#   if (/^$prompt/) { $found_version = 1; last};
#   next if (/^(\s*|\s*$cmd\s*)$/);
#   return(1) if /(Invalid input detected|Type help or )/;
#   return(0) if ($found_version);      # Only do this routine once
#   return(-1) if (/command authorization failed/i);
#
#   /copyright/i && next;
#   /^up/ && next;
#   # skip voltage
#   /\s+\d+V\s*\:\s*\d+\.?\d*/ && next;
#   /Internal\ Temperature/i && next;
#   /u-boot/i &&
#       ProcessHistory("COMMENTS","keysort","C1", "!ROM: $_") && next;
#
#   ProcessHistory("COMMENTS","keysort","B1", "!Image: $_") && next;
#    }
#    ProcessHistory("COMMENTS","","","!\n");
#    return(0);
#}

# This routine parses "show chassis" for the gsr
# This will create arrays for hw info.
sub ShowChassis {
    # Skip if this is not a 1200n.
    print STDERR "    In ShowChassis: $_" if ($debug);

   while (<INPUT>) {
        tr/\015//d;
        if (/^$prompt/) { $found_version = 1; last};
        next if (/^(\s*|\s*$cmd\s*)$/);
        return(1) if /(Invalid input detected|Type help or )/;
        return(0) if ($found_version);          # Only do this routine once
        return(-1) if (/command authorization failed/i);

        #/u-boot/i &&
        #    ProcessHistory("COMMENTS","keysort","C1", "!ROM: $_") && next;

        ProcessHistory("COMMENTS","keysort","C1", "! $_") && next;
    }
 ProcessHistory("COMMENTS","","","!\n");
    return(0);
}

sub ShowSoftware {
    # Skip if this is not a 1200n.
    print STDERR "    In ShowSoftware: $_" if ($debug);

    while (<INPUT>) {
        tr/\015//d;
        last if (/^$prompt/);
        next if (/^(\s*|\s*$cmd\s*)$/);
        return(1) if /(Invalid input detected|Type help or )/;
        return(-1) if (/command authorization failed/i);

        if (/Chassis +Model/ || /=======/) {
            ProcessHistory("COMMENTS","keysort","C1","!$_");
            next;
        }
        # Trim the temp from the end of the slot line
    #    chomp; s/\s+$//;
     #   s/\S+$//;
        ProcessHistory("COMMENTS","keysort","C1","! $_");
    }
    # ! Zeichen vor jede Zeile setzen!
    ProcessHistory("COMMENTS","","","!\n");
    return(0);
}
sub ShowLicense {
    # Skip if this is not a 1200n.
    print STDERR "    In ShowSoftware: $_" if ($debug);

    while (<INPUT>) {
        tr/\015//d;
        last if (/^$prompt/);
        next if (/^(\s*|\s*$cmd\s*)$/);
        return(1) if /(Invalid input detected|Type help or )/;
        return(-1) if (/command authorization failed/i);

        if (/Chassis +Model/ || /=======/) {
            ProcessHistory("COMMENTS","keysort","C1","!$_");
            next;
        }
        # Trim the temp from the end of the slot line
    #    chomp; s/\s+$//;
     #   s/\S+$//;
        ProcessHistory("COMMENTS","keysort","C1","! $_");
    }
        # ! Zeichen vor jede Zeile setzen!
    ProcessHistory("COMMENTS","","","!\n");
    return(0);
}

sub ShowXcvr {
    # Skip if this is not a 1200n.
    print STDERR "    In ShowXcvr: $_" if ($debug);

    while (<INPUT>) {
        tr/\015//d;
        last if (/^$prompt/);
        next if (/^(\s*|\s*$cmd\s*)$/);
        return(1) if /(Invalid input detected|Type help or )/;
        return(-1) if (/command authorization failed/i);

        if (/Chassis +Model/ || /=======/) {
            ProcessHistory("COMMENTS","keysort","C1","!$_");
            next;
        }
        # Trim the temp from the end of the slot line
    #    chomp; s/\s+$//;
    #    s/\S+$//;
        ProcessHistory("COMMENTS","keysort","C1","! $_");
    }
    ProcessHistory("COMMENTS","","","!\n");
    return(0);
}

# This routine parses "show slots".
sub ShowSlots {
    print STDERR "    In ShowSlots: $_" if ($debug);

    while (<INPUT>) {
    tr/\015//d;
    return if (/^\s*\^$/);
    last if (/online diag status/i);
    last if (/^$prompt/);
    next if (/^(\s*|\s*$cmd\s*)$/);
    return(-1) if (/command authorization failed/i);

    ProcessHistory("SLOTS","","","!$_");
    next;
    }
    ProcessHistory("SLOTS","","","!\n");

    return(0);
}

# This routine processes a "write term"
sub WriteTerm {
    print STDERR "    In WriteTerm: $_"; # if ($debug);
    my($lineauto,$comment,$linecnt) = (0,0,0);

    while (<INPUT>) {
    tr/\015//d;
    last if (/^$prompt/);
        return(1) if /Line has invalid autocommand /;
    return(1) if (/(Invalid input detected|Type help or )/i);
    return(0) if ($found_end);      # Only do this routine once
    return(-1) if (/command authorization failed/i);

    /Non-Volatile memory is in use/  && return(-1); # NvRAM is locked
    $linecnt++;
    $lineauto = 0 if (/^[^ ]/);
    # skip the crap
    #if (/^(##+$|(Building|Current) configuration)/i) {
    #    while (<INPUT>) {
#       next if (/^Current configuration\s*:/i);
#       next if (/^:/);
#       next if (/^([%!].*|\s*)$/);
#       last;
#       }
#       tr/\015//d;
#   }

    # skip consecutive comment lines to avoid oscillating extra comment
    # line on some access servers.  grrr.
    if (/^!/) {
        next if ($comment);
        ProcessHistory("","","",$_);
        $comment++;
        next;
    }
    $comment = 0;

    # Dog gone Cool matches to process the rest of the config
    /^tftp-server flash /   && next; # kill any tftp remains
    /^ntp clock-period /    && next; # kill ntp clock-period
    /^ length /     && next; # kill length on serial lines
    /^ width /      && next; # kill width on serial lines
    $lineauto = 1 if /^ modem auto/;
    /^ speed / && $lineauto && next; # kill speed on serial lines
    if (/^(enable )?(password|passwd)( level \d+)? / && $filter_pwds >= 1) {
        ProcessHistory("ENABLE","","","!$1$2$3 <removed>\n");
        next;
    }
    if (/^(enable secret) / && $filter_pwds >= 2) {
        ProcessHistory("ENABLE","","","!$1 <removed>\n");
        next;
    }
    if (/^username (\S+)(\s.*)? password (encrypted \S+|\S+)(\sclass .*$)/){
        if ($filter_pwds >= 2) {
        ProcessHistory("USER","keysort","$1",
                   "!username $1$2 password <removed>$4\n");
        } else {
        ProcessHistory("USER","keysort","$1","$_");
        }
        next;
    }
    if (/^(\s*)password / && $filter_pwds >= 1) {
        ProcessHistory("LINE-PASS","","","!$1password <removed>\n");
        next;
    }

    # 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;
    # order extended access-lists
    /^access-list\s+(\d\d\d)\s+(\S+)\s+ip\s+host\s+(\S+)/ &&
        ProcessHistory("EACL $1 $2","$aclsort","$3","$_") && next;
    /^access-list\s+(\d\d\d)\s+(\S+)\s+ip\s+(\d\S+)/ &&
        ProcessHistory("EACL $1 $2","$aclsort","$3","$_") && next;
    /^access-list\s+(\d\d\d)\s+(\S+)\s+ip\s+any/ &&
        ProcessHistory("EACL $1 $2","$aclsort","0.0.0.0","$_") && next;
    # order arp lists
    /^arp\s+(\d+\.\d+\.\d+\.\d+)\s+/ &&
        ProcessHistory("ARP","$aclsort","$1","$_") && next;
    /^ip prefix-list\s+(\S+)\s+seq\s+(\d+)\s+(permit|deny)\s+(\d\S+)(\/.*)$/ &&
        ProcessHistory("PACL $1 $3","$aclsort","$4","ip prefix-list $1 $3 $4$5\n")
        && next;
    # order logging statements
    /^logging (\d+\.\d+\.\d+\.\d+)/ &&
        ProcessHistory("LOGGING","ipsort","$1","$_") && next;
    # order/prune snmp-server host statements
    # we only prune lines of the form
    # snmp-server host a.b.c.d <community>
    if (/^snmp-server host (\d+\.\d+\.\d+\.\d+) /) {
        if ($filter_commstr) {
        my($ip) = $1;
        my($line) = "snmp-server host $ip";
        my(@tokens) = split(' ', $');
        my($token);
        while ($token = shift(@tokens)) {
            if ($token eq 'version') {
            $line .= " " . join(' ', ($token, shift(@tokens)));
            if ($token eq '3') {
                $line .= " " . join(' ', ($token, shift(@tokens)));
            }
            } elsif ($token eq 'vrf') {
            $line .= " " . join(' ', ($token, shift(@tokens)));
            } elsif ($token =~ /^(informs?|traps?|(no)?auth)$/) {
            $line .= " " . $token;
            } else {
            $line = "!$line " . join(' ', ("<removed>", join(' ',@tokens)));
            last;
            }
        }
        ProcessHistory("SNMPSERVERHOST","ipsort","$ip","$line\n");
        } else {
        ProcessHistory("SNMPSERVERHOST","ipsort","$1","$_");
        }
        next;
    }
    if (/^(snmp-server community) (\S+)/) {
        if ($filter_commstr) {
        ProcessHistory("SNMPSERVERCOMM","keysort","$_",
                   "!$1 <removed>$'") && next;
        } else {
        ProcessHistory("SNMPSERVERCOMM","keysort","$_","$_") && next;
        }
    }
    # prune tacacs/radius server keys
    # radius-server host <1-5> IP SECRET [<ip port> [TIMEOUT [RETRY]]]
    if (/^((tacacs|radius)-server)\s(\d+\.\d+\.\d+\.\d+)\s(\w*)/
        && $filter_pwds >= 1) {
        ProcessHistory("","","","!$1 $2 <removed>$'"); next;
    }
    # order ntp peers/servers
    if (/^ntp (server|peer) (\d+)\.(\d+)\.(\d+)\.(\d+)/) {
        $sortkey = sprintf("$1 %03d%03d%03d%03d",$2,$3,$4,$5);
        ProcessHistory("NTP","keysort",$sortkey,"$_");
        next;
    }

    # catch anything that wasnt matched above.
    ProcessHistory("","","","$_");
    }

    # The MRV MCC lacks a definitive "end of config" marker.  If we have seen
    # at least 5 lines of show config output, we can be reasonably sure that
    # we got the config.
    warn "$linecnt<<<<---- Line Count!!\n";

   if ($linecnt > 2) {
    $found_end = 1;
#   return(0);
    }
#    $found_end = 1;
    return(0);
}

# dummy function
sub DoNothing {print STDOUT;}

# Main
@commandtable = (
    {'chassis show attributes'          => 'ShowChassis'},
    {'software license show'            => 'ShowLicense'},
    {'software show'        => 'ShowSoftware'},
    {'port xcvr show'       => 'ShowXcvr'},
    {'configuration show'       => 'WriteTerm'},
    {'software show'        => 'ShowSoftware'},
);
# 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);

$cisco_cmds = join(";",@commands);
$cmds_regexp = join("|", map quotemeta($_), @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 debugging
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 cnlogin -t $timeo -c\"$cisco_cmds\" $host\n" if ($debug);
    print STDOUT "executing cnlogin -t $timeo -c\"$cisco_cmds\" $host\n" if ($log);
    if (defined($ENV{NOPIPE})) {
    system "/var/lib/rancid/bin/cnlogin -t $timeo -c \"$cisco_cmds\" $host </dev/null > $host.raw 2>&1" || die "cnlogin failed for $host: $!\n";
    open(INPUT, "< $host.raw") || die "cnlogin failed for $host: $!\n";
    } else {
    open(INPUT,"/var/lib/rancid/bin/cnlogin -t $timeo -c \"$cisco_cmds\" $host </dev/null |") || die "cnlogin failed for $host: $!\n";
    }
}

# determine ACL sorting mode
if ($ENV{"ACLSORT"} =~ /no/i) {
    $aclsort = "";
}
# determine community string filtering mode
if (defined($ENV{"NOCOMMSTR"}) &&
    ($ENV{"NOCOMMSTR"} =~ /yes/i || $ENV{"NOCOMMSTR"} =~ /^$/)) {
    $filter_commstr = 1;
} else {
    $filter_commstr = 0;
}
# determine password filtering mode
if ($ENV{"FILTER_PWDS"} =~ /no/i) {
    $filter_pwds = 0;
} elsif ($ENV{"FILTER_PWDS"} =~ /all/i) {
    $filter_pwds = 2;
} else {
    $filter_pwds = 1;
}

ProcessHistory("","","","!RANCID-CONTENT-TYPE: Ciena\n!\n");
ProcessHistory("COMMENTS","keysort","B0","!\n");
ProcessHistory("COMMENTS","keysort","C0","!\n");
TOP: while(<INPUT>) {
    tr/\015//d;
    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;
        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 TOP;
    }

    $rval = &{$commands{$cmd}};
    delete($commands{$cmd});
    if ($rval == -1) {
        $clean_run = 0;
        last TOP;
    }
    }

    if (/[>#]\s*exit$/) {
    $clean_run = 1;
    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);
    warn "$clean_run<<<<<<----- Clean Run!!";
    warn "$found_end<<<<<<<<<------- Found End!!!";
    system("/usr/bin/tail -1 $host.new");
    }
    unlink "$host.new" if (! $debug);
}