#
# Copyright 2004 Jörg Mayer (see AUTHORS file)
#
-# $Id: make-version.pl,v 1.5 2004/02/01 11:32:23 obiot Exp $
+# $Id$
#
-# Ethereal - Network traffic analyzer
-# By Gerald Combs <gerald@ethereal.com>
+# Wireshark - Network traffic analyzer
+# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# usage: ./make-version.pl
+# usage: ./make-version.pl [-p] [--package-version]
+#
+# If "version.conf" is present, it is parsed for configuration values.
+# Possible values are:
+#
+# enable - Enable or disable versioning. Zero (0) disables, nonzero
+# enables.
+# svn_client - Use svn client i.s.o. ugly internal SVN file hack
+# format - A strftime() formatted string to use as a template for
+# the version string. The sequence "%#" will substitute
+# the SVN revision number.
+# pkg_enable - Enable or disable package versioning.
+# pkg_format - Like "format", but used for the package version.
+#
+# If run with the "-p" or "--package-version" argument, the
+# AM_INIT_AUTOMAKE macro in configure.in and the VERSION macro in
+# config.nmake will have the pkg_format template appended to the
+# version number. svnversion.h will _not_ be generated if either
+# argument is present.
+#
+# Default configuration:
+#
+# enable: 1
+# svn_client: 0 <- This needs to change in order to support SVN 1.4
+# format: SVN %Y%m%d%H%M%S
+# pkg_enable: 1
+# pkg_format: -SVN-%#
+# am_init: 0
+
+# XXX - We're pretty dumb about the "%#" substitution, and about having
+# spaces in the package format.
use strict;
-my $version_file = 'cvsversion.h';
-my %asctonum = ( "Jan" => "01", "Feb" => "02", "Mar" => "03", "Apr" => "04",
- "May" => "05", "Jun" => "06", "Jul" => "07", "Aug" => "08",
- "Sep" => "09", "Oct" => "10", "Nov" => "11", "Dec" => "12" );
-my $last = "";
-my $last_modified = 0;
-my $last_file = undef;
-
-
-# Recursively find all CVS Entries files starting from the given directory,
-# and compute the modification time of the most recently modified Entries file.
-sub find_last_CVS_Entries {
- my $dir = shift;
- my $d;
-
- opendir(DIR, "$dir") || print STDERR "Can't open directory $dir ($!)\n" && next;
- foreach $d (readdir(DIR)) {
- if (-d "$dir/$d" && $d !~ /^\.(|.)$/) {
- if ($d =~ /^CVS$/) {
- my @stat = stat("$dir/CVS/Entries");
-
- if (@stat) {
- if ($last_modified < $stat[9]) {
- $last_modified = $stat[9];
- $last_file = "$dir/CVS/Entries"
- }
+use Time::Local;
+use POSIX qw(strftime);
+use Getopt::Long;
+
+my $version_file = 'svnversion.h';
+my $package_string = "";
+my $vconf_file = 'version.conf';
+my $last = 0;
+my $revision = 0;
+my $pkg_version = 0;
+my %version_pref = (
+ "enable" => 1,
+ "svn_client" => 0,
+ "format" => "SVN %Y%m%d%H%M%S",
+ "pkg_enable" => 1,
+ "pkg_format" => "-SVN-%#",
+ );
+my $srcdir = ".";
+
+
+# Run "svn info". Parse out the most recent modification time and the
+# revision number.
+sub read_svn_info {
+ my $line;
+ my $version_format = $version_pref{"format"};
+ my $package_format = "";
+ my $in_entries = 0;
+ my $svn_name;
+ my $repo_version;
+
+ if ($version_pref{"pkg_enable"}) {
+ $package_format = $version_pref{"pkg_format"};
+ }
+
+ if (!$version_pref{"svn_client"}) {
+ # Start of ugly internal SVN file hack
+ if (! open (ENTRIES, "< $srcdir/.svn/entries")) {
+ print ("Unable to open $srcdir/.svn/entries, trying 'svn info'\n");
+ # Fall back to "svn info"
+ $version_pref{"svn_client"} = 1;
+ }
+
+ # We need to find out whether our parser can handle the entries file
+ $line = <ENTRIES>;
+ chomp $line;
+ if ($line eq '<?xml version="1.0" encoding="utf-8"?>') {
+ $repo_version = "pre1.4";
+ } elsif ($line =~ /^8$/) {
+ $repo_version = "1.4";
+ } else {
+ $repo_version = "unknown";
+ }
+ }
+ if ($version_pref{"svn_client"} || ($repo_version ne "pre1.4")) {
+ $line = qx{svn info};
+ if ($line =~ /Last Changed Date: (\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)/) {
+ $last = timegm($6, $5, $4, $3, $2 - 1, $1);
+ }
+ if ($line =~ /Last Changed Rev: (\d+)/) {
+ $revision = $1;
+ }
+ } else {
+ # The entries schema is flat, so we can use regexes to parse its contents.
+ while ($line = <ENTRIES>) {
+ if ($line =~ /<entry$/ || $line =~ /<entry\s/) {
+ $in_entries = 1;
+ $svn_name = "";
+ }
+ if ($in_entries) {
+ if ($line =~ /name="(.*)"/) { $svn_name = $1; }
+ if ($line =~ /committed-date="(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)/) {
+ $last = timegm($6, $5, $4, $3, $2 - 1, $1);
+ }
+ if ($line =~ /revision="(\d+)"/) { $revision = $1; }
+ }
+ if ($line =~ /\/>/) {
+ if (($svn_name eq "" || $svn_name eq "svn:this_dir") &&
+ $last && $revision) {
+ $in_entries = 0;
+ last;
}
- } else { # Recurse in directory
- &find_last_CVS_Entries("$dir/$d");
}
}
+ close ENTRIES;
}
- closedir DIR;
-}
+ # If we picked up the revision and modification time,
+ # generate our strings.
+ if ($revision && $last) {
+ $version_format =~ s/%#/$revision/;
+ $package_format =~ s/%#/$revision/;
+ $package_string = strftime($package_format, gmtime($last));
+ }
+
+}
-# Check all entries in $file. In case they are newer, update $last accordingly
-# Args: Entries file
-sub lastentry {
- my $date;
- my ($wdayascii, $monthascii, $day, $time, $year);
- my $file = shift;
- my $current;
- open(FILE, "<$file") || print STDERR "Open $file for reading failed ($!)\n" && return 1;
+# Read configure.in, then write it back out with an updated
+# "AM_INIT_AUTOMAKE" line.
+sub update_configure_in
+{
+ my $line;
+ my $contents = "";
+ my $version = "";
+
+ return if ($package_string eq "");
+
+ open(CFGIN, "< configure.in") || die "Can't read configure.in!";
+ while ($line = <CFGIN>) {
+ if ($line =~ /^AM_INIT_AUTOMAKE\(wireshark, (\d+)\.(\d+).(\d+)/) {
+ $line = "AM_INIT_AUTOMAKE\(wireshark, $1.$2.$3$package_string)\n";
+ }
+ $contents .= $line
+ }
+
+ open(CFGIN, "> configure.in") || die "Can't write configure.in!";
+ print(CFGIN $contents);
+ close(CFGIN);
+ print "configure.in has been updated.\n";
+}
- while (<FILE>) {
- chomp;
- # Regular lines look like this: /ethereal_be.py/1.6/Fri Aug 2 22:55:19 2002//
- next if (/^D/);
- $date = (split(/\//, $_, 5))[3];
- next if ($date !~ /\d:\d\d:\d\d/);
- ($wdayascii, $monthascii, $day, $time, $year) = split(/\s+/, $date);
- $day = substr("0".$day, -2, 2);
- $time =~ s/://g;
- $current = "$year$asctonum{$monthascii}$day$time";
- if ($current gt $last) {
- $last = $current;
+# Read config.nmake, then write it back out with an updated
+# "VERSION" line.
+sub update_config_nmake
+{
+ my $line;
+ my $contents = "";
+ my $version = "";
+
+ return if ($package_string eq "");
+
+ open(CFGIN, "< config.nmake") || die "Can't read config.nmake!";
+ while ($line = <CFGIN>) {
+ if ($line =~ /^VERSION_EXTRA=/) {
+ $line = "VERSION_EXTRA=$package_string\n";
}
+ $contents .= $line
}
- close FILE;
- return 1;
+
+ open(CFGIN, "> config.nmake") || die "Can't write config.nmake!";
+ print(CFGIN $contents);
+ close(CFGIN);
+ print "config.nmake has been updated.\n";
}
-# Print the CVS version to $version_file.
+
+# Print the SVN version to $version_file.
# Don't change the file if it is not needed.
-sub print_cvs_version
+sub print_svn_version
{
- my $cvs_version;
+ my $svn_version;
my $needs_update = 1;
- if ($last ne "") {
- $cvs_version = "#define CVSVERSION \"$last\"\n";
+ if ($pkg_version) { return; }
+
+ if ($last && $revision) {
+ $svn_version = "#define SVNVERSION \"SVN Rev " .
+ $revision . "\"\n";
} else {
- $cvs_version = "/* #define CVSVERSION \"\" */\n";
+ $svn_version = "/* #define SVNVERSION \"\" */\n";
}
if (open(OLDVER, "<$version_file")) {
- if (<OLDVER> eq $cvs_version) {
+ if (<OLDVER> eq $svn_version) {
print "$version_file is up-to-date.\n";
$needs_update = 0;
}
}
if ($needs_update == 1) {
- # print "Updating $version_file so it contains:\n$cvs_version";
+ # print "Updating $version_file so it contains:\n$svn_version";
open(VER, ">$version_file") || die ("Cannot write to $version_file ($!)\n");
- print VER "$cvs_version";
+ print VER "$svn_version";
close VER;
print "$version_file has been updated.\n";
}
}
+# Read values from the configuration file, if it exists.
+sub get_config {
+ my $arg;
+
+ # Get our command-line args
+ GetOptions("package-version", \$pkg_version);
+
+ if ($#ARGV >= 0) {
+ $srcdir = $ARGV[0]
+ }
+
+
+ if (! open(FILE, "<$vconf_file")) {
+ print STDERR "Version configuration file $vconf_file not "
+ . "found. Using defaults.\n";
+ return 1;
+ }
+
+ while (<FILE>) {
+ chomp;
+ next if (/^#/);
+ next unless (/^(\w+)(:|=)\s*(\S.*)/);
+ $version_pref{$1} = $3;
+ }
+ close FILE;
+ return 1;
+}
+
##
## Start of code
##
-if (-d "./CVS") {
- print "This is a build from CVS (or a CVS snapshot), "
- . "CVS version tag will be computed.\n";
- &find_last_CVS_Entries(".");
-} else {
- print "This is not a CVS build.\n";
-}
-
-# Now $last_modified and $last_file are set if we found one CVS/Entries file.
-# We need to invoke lastentry on the most recent entries file.
+&get_config();
-if (defined $last_file) {
- my @version_stat = stat($version_file);
- my $version_mtime = 0;
- if (@version_stat) {
- $version_mtime = $version_stat[9];
+if (-d "./.svn") {
+ print "This is a build from SVN (or a SVN snapshot).\n";
+ &read_svn_info(".");
+ if ($pkg_version) {
+ print "Generating package version. Ignoring $version_file\n";
+ &update_configure_in;
+ &update_config_nmake;
+ } elsif ($version_pref{"enable"} == 0) {
+ print "Version tag disabled in $vconf_file.\n";
+ $last = 0;
+ $revision = 0;
+ } else {
+ print "SVN version tag will be computed.\n";
}
- &lastentry($last_file);
- # print "Last: $last_file\t($last)\n";
+} else {
+ print "This is not a SVN build.\n";
}
-# Now that we've computed everything, print the CVS version to $version_file
-&print_cvs_version;
+&print_svn_version;
__END__