make-version.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # Copyright 2004 Jörg Mayer (see AUTHORS file)
   4 #
   5 # $Id$
   6 #
   7 # Wireshark - Network traffic analyzer
   8 # By Gerald Combs <gerald@wireshark.org>
   9 # Copyright 1998 Gerald Combs
  10 #
  11 # This program is free software; you can redistribute it and/or
  12 # modify it under the terms of the GNU General Public License
  13 # as published by the Free Software Foundation; either version 2
  14 # of the License, or (at your option) any later version.
  15 #
  16 # This program is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with this program; if not, write to the Free Software
  23 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  24
  25 # usage:  ./make-version.pl [-p] [--package-version]
  26 #
  27 # If "version.conf" is present, it is parsed for configuration values.
  28 # Possible values are:
  29 #
  30 #   enable     - Enable or disable versioning.  Zero (0) disables, nonzero
  31 #                enables.
  32 #   svn_client - Use svn client i.s.o. ugly internal SVN file hack
  33 #   format     - A strftime() formatted string to use as a template for
  34 #                the version string.  The sequence "%#" will substitute
  35 #                the SVN revision number.
  36 #   pkg_enable - Enable or disable package versioning.
  37 #   pkg_format - Like "format", but used for the package version.
  38 #
  39 # If run with the "-p" or "--package-version" argument, the
  40 # AM_INIT_AUTOMAKE macro in configure.in and the VERSION macro in
  41 # config.nmake will have the pkg_format template appended to the
  42 # version number.  svnversion.h will _not_ be generated if either
  43 # argument is present.
  44 #
  45 # Default configuration:
  46 #
  47 # enable: 1
  48 # svn_client: 0 <- This needs to change in order to support SVN 1.4
  49 # format: SVN %Y%m%d%H%M%S
  50 # pkg_enable: 1
  51 # pkg_format: -SVN-%#
  52 # am_init: 0
  53
  54 # XXX - We're pretty dumb about the "%#" substitution, and about having
  55 # spaces in the package format.
  56
  57 use strict;
  58
  59 use Time::Local;
  60 use POSIX qw(strftime);
  61 use Getopt::Long;
  62
  63 my $version_file = 'svnversion.h';
  64 my $package_string = "";
  65 my $vconf_file = 'version.conf';
  66 my $last = 0;
  67 my $revision = 0;
  68 my $pkg_version = 0;
  69 my %version_pref = (
  70         "enable"     => 1,
  71         "svn_client" => 0,
  72         "format"     => "SVN %Y%m%d%H%M%S",
  73         "pkg_enable" => 1,
  74         "pkg_format" => "-SVN-%#",
  75         );
  76 my $srcdir = ".";
  77
  78
  79 # Run "svn info".  Parse out the most recent modification time and the
  80 # revision number.
  81 sub read_svn_info {
  82         my $line;
  83         my $version_format = $version_pref{"format"};
  84         my $package_format = "";
  85         my $in_entries = 0;
  86         my $svn_name;
  87         my $repo_version;
  88
  89         if ($version_pref{"pkg_enable"}) {
  90                 $package_format = $version_pref{"pkg_format"};
  91         }
  92
  93         if (!$version_pref{"svn_client"}) {
  94                 # Start of ugly internal SVN file hack
  95                 if (! open (ENTRIES, "< $srcdir/.svn/entries")) {
  96                         print ("Unable to open $srcdir/.svn/entries, trying 'svn info'\n");
  97                         # Fall back to "svn info"
  98                         $version_pref{"svn_client"} = 1;
  99                 }
 100
 101                 else {
 102                         # We need to find out whether our parser can handle the entries file
 103                         $line = <ENTRIES>;
 104                         chomp $line;
 105                         if ($line eq '<?xml version="1.0" encoding="utf-8"?>') {
 106                                 $repo_version = "pre1.4";
 107                         } elsif ($line =~ /^8$/) {
 108                                 $repo_version = "1.4";
 109                         } else {
 110                                 $repo_version = "unknown";
 111                         }
 112                 }
 113         }
 114         if ($version_pref{"svn_client"} || ($repo_version ne "pre1.4")) {
 115                 $line = qx{svn info $srcdir};
 116                 if ($line =~ /Last Changed Date: (\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)/) {
 117                         $last = timegm($6, $5, $4, $3, $2 - 1, $1);
 118                 }
 119                 if ($line =~ /Last Changed Rev: (\d+)/) {
 120                         $revision = $1;
 121                 }
 122         } else {
 123                 # The entries schema is flat, so we can use regexes to parse its contents.
 124                 while ($line = <ENTRIES>) {
 125                         if ($line =~ /<entry$/ || $line =~ /<entry\s/) {
 126                                 $in_entries = 1;
 127                                 $svn_name = "";
 128                         }
 129                         if ($in_entries) {
 130                                 if ($line =~ /name="(.*)"/) { $svn_name = $1; }
 131                                 if ($line =~ /committed-date="(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)/) {
 132                                         $last = timegm($6, $5, $4, $3, $2 - 1, $1);
 133                                 }
 134                                 if ($line =~ /revision="(\d+)"/) { $revision = $1; }
 135                         }
 136                         if ($line =~ /\/>/) {
 137                                 if (($svn_name eq "" || $svn_name eq "svn:this_dir") &&
 138                                                 $last && $revision) {
 139                                         $in_entries = 0;
 140                                         last;
 141                                 }
 142                         }
 143                 }
 144                 close ENTRIES;
 145         }
 146
 147         # If we picked up the revision and modification time,
 148         # generate our strings.
 149         if ($revision && $last) {
 150                 $version_format =~ s/%#/$revision/;
 151                 $package_format =~ s/%#/$revision/;
 152                 $package_string = strftime($package_format, gmtime($last));
 153         }
 154
 155 }
 156
 157
 158 # Read configure.in, then write it back out with an updated
 159 # "AM_INIT_AUTOMAKE" line.
 160 sub update_configure_in
 161 {
 162         my $line;
 163         my $contents = "";
 164         my $version = "";
 165
 166         return if ($package_string eq "");
 167
 168         open(CFGIN, "< configure.in") || die "Can't read configure.in!";
 169         while ($line = <CFGIN>) {
 170                 if ($line =~ /^AM_INIT_AUTOMAKE\(wireshark, (\d+)\.(\d+).(\d+)/) {
 171                         $line = "AM_INIT_AUTOMAKE\(wireshark, $1.$2.$3$package_string)\n";
 172                 }
 173                 $contents .= $line
 174         }
 175
 176         open(CFGIN, "> configure.in") || die "Can't write configure.in!";
 177         print(CFGIN $contents);
 178         close(CFGIN);
 179         print "configure.in has been updated.\n";
 180 }
 181
 182 # Read config.nmake, then write it back out with an updated
 183 # "VERSION" line.
 184 sub update_config_nmake
 185 {
 186         my $line;
 187         my $contents = "";
 188         my $version = "";
 189
 190         return if ($package_string eq "");
 191
 192         open(CFGIN, "< config.nmake") || die "Can't read config.nmake!";
 193         while ($line = <CFGIN>) {
 194                 if ($line =~ /^VERSION_EXTRA=/) {
 195                         $line = "VERSION_EXTRA=$package_string\n";
 196                 }
 197                 $contents .= $line
 198         }
 199
 200         open(CFGIN, "> config.nmake") || die "Can't write config.nmake!";
 201         print(CFGIN $contents);
 202         close(CFGIN);
 203         print "config.nmake has been updated.\n";
 204 }
 205
 206
 207
 208 # Print the SVN version to $version_file.
 209 # Don't change the file if it is not needed.
 210 sub print_svn_version
 211 {
 212         my $svn_version;
 213         my $needs_update = 1;
 214
 215         if ($pkg_version) { return; }
 216
 217         if ($last && $revision) {
 218                 $svn_version = "#define SVNVERSION \"SVN Rev " .
 219                         $revision . "\"\n";
 220         } else {
 221                 $svn_version = "/* #define SVNVERSION \"\" */\n";
 222         }
 223         if (open(OLDVER, "<$version_file")) {
 224                 if (<OLDVER> eq $svn_version) {
 225                         print "$version_file is up-to-date.\n";
 226                         $needs_update = 0;
 227                 }
 228                 close OLDVER;
 229         }
 230
 231         if ($needs_update == 1) {
 232                 # print "Updating $version_file so it contains:\n$svn_version";
 233                 open(VER, ">$version_file") || die ("Cannot write to $version_file ($!)\n");
 234                 print VER "$svn_version";
 235                 close VER;
 236                 print "$version_file has been updated.\n";
 237         }
 238 }
 239
 240 # Read values from the configuration file, if it exists.
 241 sub get_config {
 242         my $arg;
 243
 244         # Get our command-line args
 245         GetOptions("package-version", \$pkg_version);
 246
 247         if ($#ARGV >= 0) {
 248                 $srcdir = $ARGV[0]
 249         }
 250
 251
 252         if (! open(FILE, "<$vconf_file")) {
 253                 print STDERR "Version configuration file $vconf_file not "
 254                 . "found.  Using defaults.\n";
 255                 return 1;
 256         }
 257
 258         while (<FILE>) {
 259                 chomp;
 260                 next if (/^#/);
 261                 next unless (/^(\w+)(:|=)\s*(\S.*)/);
 262                 $version_pref{$1} = $3;
 263         }
 264         close FILE;
 265         return 1;
 266 }
 267
 268 ##
 269 ## Start of code
 270 ##
 271
 272 &get_config();
 273
 274 if (-d "$srcdir/.svn") {
 275         print "This is a build from SVN (or a SVN snapshot).\n";
 276         &read_svn_info();
 277         if ($pkg_version) {
 278                 print "Generating package version.  Ignoring $version_file\n";
 279                 &update_configure_in;
 280                 &update_config_nmake;
 281         } elsif ($version_pref{"enable"} == 0) {
 282                 print "Version tag disabled in $vconf_file.\n";
 283                 $last = 0;
 284                 $revision = 0;
 285         } else {
 286                 print "SVN version tag will be computed.\n";
 287         }
 288 } else {
 289         print "This is not a SVN build.\n";
 290 }
 291
 292 &print_svn_version;
 293
 294 __END__