update_copyrights revision 5c144477062a5df657acee41a82051d38537fd38
d0be1e954bd4674fc27f2616c72adb37cf3525a2David Lawrence#!/usr/local/bin/perl -w
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews#
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence# Copyright (C) 2004-2010, 2012-2015 Internet Systems Consortium, Inc. ("ISC")
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews# Copyright (C) 1998-2001 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews#
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews# Permission to use, copy, modify, and/or distribute this software for any
d0be1e954bd4674fc27f2616c72adb37cf3525a2David Lawrence# purpose with or without fee is hereby granted, provided that the above
d0be1e954bd4674fc27f2616c72adb37cf3525a2David Lawrence# copyright notice and this permission notice appear in all copies.
c1aef54e14bb92518b1c062ba8c0292a7cb949cbAutomatic Updater#
821644d49b73b49f2abc5463bc53a3132f612478Mark Andrews# THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews# AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1e7501fe074fcacd9512af8b7db073f2a3ee4478Tinderbox User# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence# PERFORMANCE OF THIS SOFTWARE.
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson
ee6fe1d1975604af266af6c370fc6193dae80fddMichael Sawyerrequire 5.002;
f333ea9bdd3f85b74ae790e6c8ce2684295b3483Andreas Gustafsson
4f37905cc38162128a507e619e38ae535720686bAndreas Gustafsson# Map copyright owners to the files containing copyright messages.
10bc8ffed60f064a2950527a82d7fdffe91b6206Michael Sawyer# The first line of the copyright message is not in the file;
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson# it is constructed by this script.
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson#
5a77e9620a0b2f7417469c98be374de49d0eccc6Andreas Gustafsson# Usage:
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson#
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson# perl util/update_copyrights <util/copyrights
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafssonmy %owner2filename = (
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson "" => "util/COPYRIGHT",
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson "NAI" => "util/COPYRIGHT.NAI",
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson "NOM" => "util/COPYRIGHT.NOM",
0e9dcd548051a8ec34744bfa18b4e09fea742a39Andreas Gustafsson "BSDI" => "util/COPYRIGHT.BSDI",
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews "BRIEF" => "util/COPYRIGHT.BRIEF",
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews "PORTION" => "util/COPYRIGHT.PORTION",
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews);
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews
2d96b63d311a5252c8583eb30a56b1fc58172419Mark Andrews# Map each copyright owner name to a reference to an array containing
43b9737b11f4f14b2d378746d0cd5561b1dc24a0Mark Andrews# the lines of the copyright message.
43b9737b11f4f14b2d378746d0cd5561b1dc24a0Mark Andrews
43b9737b11f4f14b2d378746d0cd5561b1dc24a0Mark Andrewsmy %owner2text = ();
43b9737b11f4f14b2d378746d0cd5561b1dc24a0Mark Andrews
43b9737b11f4f14b2d378746d0cd5561b1dc24a0Mark Andrewsmy $keyword_pat = '\$(Id:.*|Revision:.*|Id|Revision)\$';
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrews
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrewsforeach $owner (keys %owner2filename) {
9ab989b88ca3dc6a4f0f52ca450ea5e35242cc85Tinderbox User my $f = $owner2filename{$owner};
9ab989b88ca3dc6a4f0f52ca450ea5e35242cc85Tinderbox User open(COPYRIGHT, "<$f") || die "can't open $f: $!";
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrews @copyright_text = <COPYRIGHT>;
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrews close(COPYRIGHT);
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrews $owner2text{$owner} = [ @copyright_text ];
9ab989b88ca3dc6a4f0f52ca450ea5e35242cc85Tinderbox User}
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrews
9ab989b88ca3dc6a4f0f52ca450ea5e35242cc85Tinderbox Usermy %file_types = ();
744c1db6352c4c3f11c8538e4a2a57c8b0e0d570Mark Andrewsmy %file_years = ();
my $years_list;
my $parent;
($dummy,$dummy,$dummy,$dummy,$this_month,$this_year,$dummy,$dummy,$dummy) = localtime(time());
$this_year += 1900;
while (<>) {
chomp;
($file, $type, $years) = split(/\s+/);
$file_types{$file} = $type;
$file_years{$file} = $years;
}
sub getyears {
$parent = $_[0];
$parent =~ s/PARENT://;
$years_list = $file_years{$parent};
if (defined($years_list) && $years_list =~ /^PARENT:/) {
print "BAD PARENT:$parent\n";
undefine($years_list);
}
}
sub docbook {
$parent = $_[0];
$parent =~ s/\.[^.]*$/.docbook/;
$years_list = $file_years{$parent};
}
sub copyright {
my $holder = shift;
my $result = "";
return $result unless (@_);
$result = "$result <copyright>\n";
$result = "$result <year>$_</year>\n" foreach (@_);
$result = "$result <holder>$holder</holder>\n";
$result = "$result </copyright>\n";
return $result;
}
sub copyrights {
my $a = copyright("Internet Systems Consortium, Inc. (\"ISC\")",
grep({ $_ >= 2004} @_));
my $b = copyright("Internet Software Consortium.",
grep({ $_ < 2004} @_));
return "$a$b";
}
foreach $file (keys %file_types) {
$typeandowner = $file_types{$file};
$years_list = $file_years{$file};
if ( ! -f $file ) {
print "$file: missing\n";
next;
}
# print "Doing: $file";
if ($years_list =~ /PARENT:/) {
getyears($years_list);
if (!defined $years_list) {
print "$file: has bad parent $parent\n";
next;
}
}
# copyright notice is now generated from the source.
next if ($years_list eq "DOCBOOK");
if ($years_list eq "DOCBOOK") {
docbook($file);
if (!defined $years_list) {
print "$file: has bad parent $parent\n";
next;
}
}
@years = split(/,/, $years_list);
my ($type, $owner) = split(/\./, $typeandowner);
$owner = "" if !defined $owner;
$textp = $owner2text{$owner};
if (!defined $textp) {
print "$file: unknown copyright owner $owner\n";
next;
}
if ($file eq "./CHANGES" || $file eq "./EXCLUDED" ||
$file eq "./CHANGES.SE")
{
open(SOURCE, "<$file") || die "can't open $file: $!";
my $body = "";
while (<SOURCE>) {
# Process leading white space.
# Remove 1-7 spaces followed by a tab into a single
# tab if at start of line or proceeded by tabs.
s/^(\t*) {1,7}\t/$1\t/ while (/^\t* {1,7}\t/);
s/^(\s{0,3}\d*\.)\s(\[\w{1,5}\])\s+(\S+)/$1\t$2\t\t$3/;
s/^(\s{0,3}\d*\.)\s(\[\w{6,}\])\s+(\S+)/$1\t$2\t$3/;
# Convert 8 spaces into tabs if at start of line
# or preceeded by tabs.
s/^(\t*) /$1\t/ while (/^\t* /);
# Remove trailing white space.
s/[ \t]*$//;
$body = "$body$_";
}
$_ = $body;
open(TARGET, ">$file.new") || die "can't open $file.new: $!";
print TARGET $_;
close(TARGET);
close(SOURCE);
if (system("cmp -s $file.new $file") == 0) {
unlink("$file.new");
} else {
rename("$file.new", "$file")
or die "rename($file.new, $file): $!";
}
}
next if $type eq "X" or $type eq "BAT";
$before_copyright = "";
$c_comment = 0;
$shell_comment = 0;
$m4_comment = 0;
$sgml_comment = 0;
$mkd_comment = 0;
$zone_comment = 0;
$man_comment = 0;
$python_comment = 0;
$start_comment = "";
$end_comment = "";
$first = "";
if ($type =~ /^(C|YACC|CONF-C)$/) {
$c_comment = 1;
$start_comment = "/*\n";
$prefix = " * ";
$end_comment = " */\n";
} elsif ($type =~ /^(SH|PERL|TCL|MAKE|CONF-SH|RNC)$/) {
$shell_comment = 1;
$prefix = "# ";
} elsif ($type =~ /^PYTHON$/) {
$python_comment = 1;
$start_comment = "############################################################################\n";
$prefix = "# ";
$end_comment = "############################################################################\n"
} elsif ($type eq "ZONE" || $type eq "MC") {
$zone_comment = 1;
$prefix = "; ";
} elsif ($type eq "MAN") {
$man_comment = 1;
$prefix = ".\\\" ";
} elsif ($type eq "M4") {
$m4_comment = 1;
$prefix = "dnl ";
} elsif ($type eq "HTML" || $type eq "SGML") {
$sgml_comment = 1;
$start_comment = "<!--\n";
$prefix = " - ";
$end_comment = "-->\n";
} elsif ($type eq "MKD") {
$mkd_comment = 1;
$start_comment = "<!---\n";
$prefix = " - ";
$end_comment = "--->";
} elsif ($type eq "TXT") {
$prefix = "";
} else {
print "$file: type '$type' not supported yet; skipping\n";
next;
}
($nonspaceprefix = $prefix) =~ s/\s+$//;
open(SOURCE, "<$file") || die "can't open $file: $!";
$_ = <SOURCE>;
if ($type eq "YACC") {
unless ($_ eq "%{\n") {
print "$file: unexpected yacc file start ",
"(expected \"%{\\n\")\n";
close(SOURCE);
next;
}
$before_copyright = "$_";
$_ = <SOURCE>;
}
if ($c_comment && /^\/\*/) {
$_ = <SOURCE>;
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
if ($_ !~ /\*\//) {
while (<SOURCE>) {
last if $_ =~ /\*\//;
}
}
} elsif ($shell_comment) {
if (/^\#\!/) {
$before_copyright = "$_#\n";
$_ = <SOURCE>;
$_ = <SOURCE> if $_ eq "#\n";
}
if (/^\#/) {
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
while (<SOURCE>) {
if ($_ !~ /^\#/) {
$first = $_;
last;
}
}
} else {
$first = $_;
}
} elsif ($python_comment) {
if (/^\#\!/) {
$before_copyright = "$_";
$_ = <SOURCE>;
$_ = <SOURCE> if $_ eq "#\n";
$_ = <SOURCE> if $_ eq "############################################################################\n";
}
if (/^\#/) {
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
while (<SOURCE>) {
if ($_ !~ /^\#/) {
$first = $_;
last;
}
}
} else {
$first = $_;
}
} elsif (($m4_comment || $zone_comment || $man_comment) &&
/^\Q$nonspaceprefix\E/) {
while (/^\Q$nonspaceprefix\E\s*$/) {
$_ = <SOURCE>;
}
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
while (<SOURCE>) {
if ($_ !~ /^\Q$nonspaceprefix\E/ ||
$_ =~ /$keyword_pat/) {
$first = $_;
last;
}
}
} elsif ($sgml_comment) {
$before_copyright = "";
while (/^<!DOCTYPE/ || /^<\?xml-stylesheet/ || /^<\?xml /) {
# print "SGML: $_";
$before_copyright = "$before_copyright$_";
if (/>$/ ) {
$_ = <SOURCE>;
close(SOURCE) if (eof(SOURCE));
next;
}
$_ = <SOURCE>;
while (!eof(SOURCE) && ! /^<!/ ) {
$before_copyright = "$before_copyright$_";
$_ = <SOURCE>;
}
if (eof(SOURCE)) {
close(SOURCE);
next;
}
}
if (/^<!/) {
$_ = <SOURCE> if $_ eq "<!--\n";
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
while (defined($_)) {
last if s/.*-->//;
$_ = <SOURCE>;
}
print "$file: unterminated comment\n"
unless defined($_);
if ($_ ne "\n") {
$first = $_;
} else {
$first = <SOURCE>;
}
} else {
$first = $_;
}
} elsif ($mkd_comment) {
$before_copyright = "";
if (/^<!/) {
$_ = <SOURCE> if $_ eq "<!---\n";
if ($_ !~ /[Cc]opyright/) {
print "$file: non-copyright comment\n";
close(SOURCE);
next;
}
while (defined($_)) {
last if s/.*--->//;
$_ = <SOURCE>;
}
print "$file: unterminated comment\n"
unless defined($_);
if ($_ ne "\n") {
$first = $_;
} else {
$first = <SOURCE>;
}
} else {
$first = $_;
}
} elsif ($type eq "TXT") {
if ($_ =~ /[Cc]opyright/) {
$/ = ""; # paragraph at a time
while (<SOURCE>) {
# Not very maintainable, but ok enough for now.
last if /Portions of this code/;
last unless
/[Cc]opyright/ ||
/See COPYRIGHT in the source root/ ||
/Permission to use, copy, modify, and / ||
/THE SOFTWARE IS PROVIDED "AS IS" AND /;
}
$/ = "\n";
}
$first = $_;
} else {
$first = $_;
}
$first = "" if ! defined($first);
open(TARGET, ">$file.new") || die "can't open $file.new: $!";
print TARGET $before_copyright if $before_copyright;
print TARGET $start_comment if $start_comment;
$sysyears = "";
$sftyears = "";
$nomyears = "";
#
# Internet Software Consortium: up to 2003
#
$last_year = 0;
$anchor_year = 0;
$years = "";
foreach $year (@years) {
if ($year >= 2004) { next; }
if ($last_year != 0 && $year == $last_year + 1) {
if ($year > $anchor_year + 1) {
substr($years, $anchor_end) = "-$year";
} else {
$years .= ", $year";
}
} else {
$years .= $last_year == 0 ? "$year" : ", $year";
#if ($anchor_year != 0) {
# print "$file: noncontiguous year: ",
# "$year != $last_year + 1\n";
#}
$anchor_year = $year;
$anchor_end = length($years);
}
$last_year = $year;
}
$sftyears = $years;
#
# Nominum: up to 2001.
#
$last_year = 0;
$anchor_year = 0;
$years = "";
foreach $year (@years) {
if ($year >= 2002) { next; }
if ($last_year != 0 && $year == $last_year + 1) {
if ($year > $anchor_year + 1) {
substr($years, $anchor_end) = "-$year";
} else {
$years .= ", $year";
}
} else {
$years .= $last_year == 0 ? "$year" : ", $year";
#if ($anchor_year != 0) {
# print "$file: noncontiguous year: ",
# "$year != $last_year + 1\n";
#}
$anchor_year = $year;
$anchor_end = length($years);
}
$last_year = $year;
}
$nomyears = $years;
#
# Internet Systems Consortium: 2004 onwards.
#
$last_year = 0;
$anchor_year = 0;
$years = "";
$anchor_end = length($years);
my $andor = 0;
my $noid = 0;
foreach $year (@years) {
if ($year < 2004) { next; }
$andor = 1 if ($year >= 2007);
$noid = 1 if ($year > 2012 || ($year == 2012 && $this_month >= 5) );
if ($last_year != 0 && $year == $last_year + 1) {
if ($year > $anchor_year + 1) {
substr($years, $anchor_end) = "-$year";
} else {
$years .= ", $year";
}
} else {
$years .= $last_year == 0 ? "$year" : ", $year";
#if ($anchor_year != 0) {
# print "$file: noncontiguous year: ",
# "$year != $last_year + 1\n";
#}
$anchor_year = $year;
$anchor_end = length($years);
}
$last_year = $year;
}
$sysyears = $years;
($firstline, $secondline, @otherlines) = @$textp;
$firstline =~ s/\@SYSYEARS\@/$sysyears/;
$secondline =~ s/\@SFTYEARS\@/$sftyears/;
print TARGET "$prefix$firstline";
if ($sftyears ne "" ) {
print TARGET $secondline =~ /^$/ ? $nonspaceprefix : $prefix;
print TARGET "$secondline";
}
foreach $_ (@otherlines) {
s:modify, and distribute:modify, and/or distribute: if ($andor);
print TARGET (/^$/ ? $nonspaceprefix : $prefix);
s/\@NOMYEARS\@/$nomyears/;
print TARGET "$_";
}
print TARGET $end_comment if $end_comment;
if ($first eq "") {
$first = <SOURCE>;
}
if (defined($first)) {
if ($type eq 'MAN') {
print TARGET "$nonspaceprefix\n";
} else {
print TARGET "\n";
}
if (($type eq "C" || $type eq "CONF-C") &&
$sysyears =~ /$this_year/) {
my $body = "";
while (<SOURCE>) {
# Process leading white space.
# Remove 1-7 spaces followed by a tab into a single
# tab if at start of line or proceeded by tabs.
s/^(\t*) {1,7}\t/$1\t/ while (/^\t* {1,7}\t/);
# Convert 8 spaces into tabs if at start of line
# or preceeded by tabs.
s/^(\t*) {8}/$1\t/ while (/^\t* {8}/);
# Remove trailing white space.
s/[ \t]*$//;
$body = "$body$_";
}
$_ = $body;
} else {
undef $/;
$_ = <SOURCE>;
$/ = "\n";
}
if ($type eq 'SGML' && m:<articleinfo>.*?</articleinfo>:s) {
# print "docinfo: $file\n";
my $r = copyrights(@years);
s:<articleinfo>.*?</articleinfo>:<articleinfo>\n$r </articleinfo>:s;
}
if ($type eq 'SGML' && m:<docinfo>.*?</docinfo>:s) {
# print "docinfo: $file\n";
my $r = copyrights(@years);
s:<docinfo>.*?</docinfo>:<docinfo>\n$r </docinfo>:s;
}
if ($type eq 'SGML' && m:<bookinfo>.*?</bookinfo>:s) {
# print "bookinfo: $file\n";
my $r = copyrights(@years);
$r .= " <xi:include href=\"releaseinfo.xml\"/>\n";
s:<bookinfo>.*?</bookinfo>:<bookinfo>\n$r </bookinfo>:s;
}
my ($start, $end);
if ($type =~ /^PYTHON$/) {
($start = $prefix) =~ s/\s*\n//;
$end = "\n";
} elsif ($start_comment ne "") {
($start = $start_comment) =~ s/\s*\n/ /;
($end = $end_comment) =~ s/^\s*(.*)\n/ $1\n/;
} elsif ($prefix ne "") {
($start = $prefix) =~ s/\s*\n//;
$end = "\n";
} else {
$start = "";
$end = "\n";
}
if (!$noid && $first !~ /$keyword_pat/ &&
(!defined($_) || $_ !~ /$keyword_pat/)) {
$end = "\n$nonspaceprefix" if ($type eq "MAN");
print TARGET "$start\$";
print TARGET "Id";
print TARGET "\$$end\n";
}
print TARGET $first if $first !~ /^\s*$/;
print TARGET $_ if (defined($_));
}
close(TARGET);
close(SOURCE);
$mode = (stat $file)[2]&511;
chmod $mode, "$file.new";
if (system("cmp -s $file.new $file") == 0) {
unlink("$file.new");
} else {
rename("$file.new", "$file")
or die "rename($file.new, $file): $!";
}
}