aboutsummaryrefslogtreecommitdiffstats
path: root/CVSROOT/commit_prep.pl
blob: 0cdb22722bb8f8ff3a25bf466f3b818712b1307a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
#!/usr/bin/perl -w
#
# $FreeBSD$
#
#
# Perl filter to handle pre-commit checking of files.  This program
# records the last directory where commits will be taking place for
# use by the log_accumulate script.  For new file, it forcing the
# existence of a RCS "Id" keyword in the first ten lines of the file.
# For existing files, it checks version number in the "Id" line to
# prevent losing changes because an old version of a file was copied
# into the direcory.
#
# Possible future enhancements:
#
#
#    Check for cruft left by unresolved conflicts.  Search for
#    "^<<<<<<<$", "^-------$", and "^>>>>>>>$".
#
#    Look for a copyright and automagically update it to the
#    current year.
#
# Contributed by David Hampton <hampton@cisco.com>
#

require 5.003;  # to be sure.  log_accum needs perl5

use strict;
use lib $ENV{CVSROOT};
use CVSROOT::cfg;


############################################################
#
# Constants
#
############################################################
my $ENTRIES       = "CVS/Entries";


# The "Id" header to check for.
my $HEADER  = $cfg::IDHEADER;

my $cvsroot= $ENV{'CVSROOT'} || "/home/ncvs";

############################################################
#
# Error messages
#
############################################################
my $NoId = "
%s - Does not contain a line with the keyword \"\$$HEADER:\".\n";

# Protect string from substitution by RCS.
my $NoName = "
%s - The ID line should contain only \$$HEADER\$ for a newly created file.\n";

#$DelPath = "
#%s - The old path and version has been deleted from \$$HEADER\$.\n";

my $BadId = "
%s - The \$$HEADER\$ is mangled.\n";

my $BadName = "
%s - The pathname '%s'
    in the \$$HEADER\$ line does not match the actual filename.\n";

my $BadVersion = "
%s - GRRR!!  You spammed your copy of the file
    which was based upon version %s, with a different version based
    upon %s.  Please move your '%s' out of the way,
    perform an update to get the current version, and then
    CAREFULLY merge your changes into that file.\n";

############################################################
#
# Subroutines
#
############################################################

# Write a single line to a file.
sub write_line {
    my $filename = shift;   # File to write to.
    my $line = shift;   # Line to write to the file.

    open FILE, ">$filename" or die "Cannot open $filename, stopped\n";
    print FILE "$line\n";
    close FILE;
}

# Check to see whether a file is mentioned in the exclusion file.
sub exclude_file {
    my $filename = shift;
    my $directory = shift;

    my $exclude = "$cvsroot/CVSROOT/exclude";
    my $path = "$directory/$filename";
    if (open(EX, "<$exclude")) {
        while (<EX>) {
            chomp;
            my $ex_entry = $_;

            # Skip comments and blank lines.
            next if $ex_entry =~ /^#/;
            next if $ex_entry =~ /^$/;

            if ($path =~ /$ex_entry/) {
                close(EX);
                return(1);
            }
        }
        close(EX);
    }

    # File shouldn't be excluded.
    return(0);
}

sub check_version {
    my $filename = shift;
    my $directory = shift;
    my $hastag = shift;
    my $lastversion = shift;

    my $found_rcsid;    # True if our rcsid was found in the file.
    my $rcsid;      # The rcsid that was in the file.
    my $rcsid_info;     # The expanded values of the rcsid.
    my $rname;      # The file pathname, parsed from the rcsid.
    my $version;        # The file version, parsed from the rcsid.

    # not present - either removed or let cvs deal with it.
    return 0 unless -f $filename;

    # Search the file for our rcsid.
    # NOTE: We stop after finding the first potential match.
    open FILE, $filename or die "Cannot open $filename, stopped\n";
    $found_rcsid = 0;
    while (<FILE>) {
        next unless /^.*(\$$HEADER.*)/;
        $rcsid = $1;
        $found_rcsid = 1;
        last;
    }
    close FILE;

    # The file should have had an rcsid in it!
    unless ($found_rcsid) {
        printf($NoId, $filename);
        return(1);
    }

    # Is the rcsid corrupt?
    unless ($rcsid =~ /\$$HEADER(: ([^\$]* )?)?\$/) {
        printf($BadId, $filename);
        return(1);
    }
    $rcsid_info = $2 || "";
    ($rname, $version) = split /\s/, $rcsid_info;

    # Ignore version mismatches (MFC spamming etc) on branches.
    if ($hastag) {
        return (0);
    }

    # A new file should have an unexpanded rcsid.
    if ($lastversion eq '0') {
        unless ($rcsid_info eq "") {
            printf($NoName, $filename);
            return(1);
        }
        return(0);
    }

    # It's ok for the rcsid to be not expanded.
    if ($rcsid_info eq "") {
        return (0);
#       if ($directory =~ /^ports\//) {
#           return (0); # ok for ports
#       }
#       # Don't know whether to allow or trap this.  It means
#       # one could bypass the version spam checks by simply
#       # using a bare tag.
#       printf($DelPath, $filename);
#       return(1);
    }

    # Check that the file name in the rcsid matches reality.
    if ($rname ne "$directory/$filename,v") {
        # If ports and the pathname is just the basename
        # (eg: somebody sent in a port with $Id$ and the
        # committer changed Id -> $HEADER and the version
        # numbers otherwise match.
        if (!($directory =~ /^ports\// && $rname eq "$filename,v")) {
            printf($BadName, "$directory/$filename,v", $rname);
            return(1);
        }
    }

    # Check that the version in the rcsid matches reality.
    if ($lastversion ne $version) {
        printf($BadVersion, $filename, $lastversion,
            $version, $filename);
        return(1);
    }
    return(0);
}


# Do file fixups, i.e. replacing $ Id: .* $ with $ Id $.
sub fix_up_file {
    my $filename = shift;

    # not present - either removed or let cvs deal with it.
    return 0 unless -f $filename;

    open F, "< $filename" or die "Can't open $filename!\n";
    my @file = <F>;
    close F;

    open F, "> $filename.tmp" or die "Can't create $filename tmpfile!\n";
    while (@file) {
        my $line = shift @file;

        $line =~ s/\$$HEADER:.*?\$/\$$HEADER\$/g;
        print F $line or die "Out of disk space?\n";
    }
    close F;

    # overwrite the original file......
    system("/bin/mv", "$filename.tmp", $filename);
    die "Can't recreate $filename!\n" if $? >> 8;
}

#############################################################
#
# Main Body
#
############################################################

#print("ARGV - ", join(":", @ARGV), "\n");
#print("id   - ", $cfg::PID, "\n");

#
# Suck in the Entries file
#
my %cvsversion;
my %cvstag;
open ENTRIES, $ENTRIES or die "Cannot open $ENTRIES.\n";
while (<ENTRIES>) {
    chomp;
    next if /^D/;

    my ($filename, $ver, $stamp, $opt, $tag) = split '/', substr($_, 1);
    $cvsversion{$filename} = $ver;
    $cvstag{$filename} = $tag;
    $stamp = $opt;  #silence -w
}
close ENTRIES;

my $directory = $ARGV[0];
shift @ARGV;

$directory =~ s,^$cvsroot[/]+,,;

my $check_id = 0;
if ($directory =~ /^ports/) {
    $check_id = 2;
}
if ($directory =~ /^src\/contrib/) {
    $check_id = 3;
}
if ($directory =~ /^src\/crypto/) {
    $check_id = 3;
}
#
# Now check each file name passed in, except those excluded.
#
if ($cfg::CHECK_HEADERS) {
    my $failed = 0;
    foreach my $arg (@ARGV) {
        my $hastag = ($cvstag{$arg} ne '');
        next if ($check_id == 2 && $arg ne "Makefile");
        next if ($check_id == 3 && $hastag);

        # Ignore the file if it's in the exclude list.
        next if exclude_file($arg, $directory);

        # Check to make sure that the file hasn't had
        # it's revision string changed.
        $failed += &check_version($arg, $directory, $hastag,
            $cvsversion{$arg});

        # Unexpand the rcsid if required.
        fix_up_file($arg) if $cfg::UNEXPAND_RCSID and !$failed;

    }
    if ($failed) {
        print "\n";
        unlink($cfg::LAST_FILE);
        exit(1);
    }
}

#
# Record this directory as the last one checked.  This will be used
# by the log_accumulate script to determine when it is processing
# the final directory of a multi-directory commit.
#
&write_line($cfg::LAST_FILE, $directory);

exit(0);