pvcs.pl

#! /usr/bin/env perl
#
# ICON
#
# ---------------------------------------------------------------
# Copyright (C) 2004-2024, DWD, MPI-M, DKRZ, KIT, ETH, MeteoSwiss
# Contact information: icon-model.org
# See AUTHORS.TXT for a list of authors
# See LICENSES/ for license information
# SPDX-License-Identifier: BSD-3-Clause
# ---------------------------------------------------------------
#
#_____________________________________________________________________________
#
# Luis Kornblueh, MPIM, 2012-05-31 
# Luis Kornblueh, MPIM, 2013-10-16
#                 - add functions to return strings with 
#                   the revision information  
# Luis Kornblueh, MPIM, 2024-01-15
#                 - remove svn support
#                 - add VERSION file replacing querying
#                   git when git is not available
#_____________________________________________________________________________

=head1 pvcs

pvcs - Enabling provenance collection for VCSs

=head1 SYNOPSIS

pvcs [options] [VCS working directory]

Options:

   --srcdir  <VCS working directory>
   --version creates a VERSION file for VCS less handling of package 
   --help    usage

=cut

=head1 OPTIONS

=over 8

=item B<--srcdir <VCS working directory>>

VCS handled top level directory which gets compiled

=item B<--version

Creates a VERSION file for VCS less handling of package 

=item B<--help>

Prints the usage documentation and exits

=back

=cut

=head1 DESCRIPTION

This program will generate a c source file which contains persistent 
information on the repository, branch, and revision of the compiled
source code. The file is suitable for being linked into the executable.  

=cut

#_____________________________________________________________________________

use strict;
use warnings;

use constant { true => 1, false => 0 };

use Getopt::Long;
use Pod::Usage;

use File::Temp;
use File::Compare;
use File::Copy;

my $srcdir = '.';
my $version = 0;
my $help = 0;

GetOptions( 'help|?' => \$help, 'srcdir=s' => \$srcdir, 'version' => \$version) or pod2usage(-exitstatus => 2);

pod2usage(-exitstatus => 1) if $help;

my $version_fn = "VERSION";
    
my $remote_url = '';
my $branch = '';
my $revision = '';
my $git_tag = '';

my $art_branch = '';
my $art_revision = '';
my $art_remote_url = '';

if ( -d $srcdir."/.git" ) {
    $remote_url = `git --git-dir $srcdir/.git config --get remote.origin.url`;
    chomp($remote_url);
    if (index("$remote_url", "gitlab.dkrz.de") != -1) {
        my @branches = `git --git-dir $srcdir/.git branch`;	
        @branches = grep(/^\*/, @branches); 
        $branch = $branches[0];
        $branch =~ s/\* *//;
        $branch =~ s/ *\n//;
        my @revisions = `git --git-dir $srcdir/.git --no-pager log --max-count=1`; 
        @revisions = grep(/commit/, @revisions);
        $revision = $revisions[0];
        $revision =~ s/commit *//;
        $revision =~ s/ *\n//;
        if ( -d $srcdir."/externals/art/.git" ) {
            $art_remote_url = `git --git-dir $srcdir/externals/art/.git config --get remote.origin.url`;
            chomp($art_remote_url);
            my @art_branches = `git --git-dir $srcdir//externals/art/.git branch`;	
            @art_branches = grep(/^\*/, @art_branches); 
            $art_branch = $art_branches[0];
            $art_branch =~ s/\* *//;
            $art_branch =~ s/ *\n//;
            my @art_revisions = `git --git-dir $srcdir/externals/art/.git --no-pager log --max-count=1`; 
            @art_revisions = grep(/commit/, @art_revisions);
            $art_revision = $art_revisions[0];
            $art_revision =~ s/commit *//;
            $art_revision =~ s/ *\n//;
        }
        $git_tag = `git describe --tags --abbrev=0 --exact-match 2>/dev/null`;
        if ($?) {
            $git_tag = 'No GIT tag matches exactly.';
        } else {
            $git_tag =~ s/ *\n//;
        }
    }

} else {
    if ( not -e $version_fn ) {
        print "Unknown repository type or no working copy/repository: no support will be given.\n";
        $remote_url = "Unknown";
        $branch = "Unknown";
        $revision = "Unknown";
    }
}

if ( $version == 1 ){
    my $version_v;
    print "Write VERSION file ...\n";
    open $version_v, ">", "$version_fn" or die "$0: open $version_fn: $!";
    print $version_v "ICON remote URL:     $remote_url\n";
    print $version_v "ICON branch:         $branch\n";
    print $version_v "ICON revision:       retrieved from VERSION file\n"; 
    print $version_v "ICON tag:            $git_tag\n"; 
    print $version_v "ICON ART remote URL: $art_remote_url\n";
    print $version_v "ICON ART branch:     $art_branch\n";
    print $version_v "ICON ART revision:   $art_revision\n"; 
    close $version_v;
    exit 0;
}

my $need_to_compare = false;
my $version_c;
my $fname;

if ( -e $version_fn ) {
    my $header;
    open my $version_info, "<", "$version_fn" or die "Could not open $version_fn: $!"; 
    ($header, $remote_url)     = split /:/, <$version_info>, 2; $remote_url =~ s/^\s+|\s+$//g;
    ($header, $branch)         = split /:/, <$version_info>, 2; $branch =~ s/^\s+|\s+$//g;         
    ($header, $revision)       = split /:/, <$version_info>, 2; $revision =~ s/^\s+|\s+$//g;       
    ($header, $git_tag)        = split /:/, <$version_info>, 2; $git_tag =~ s/^\s+|\s+$//g;        
    ($header, $art_remote_url) = split /:/, <$version_info>, 2; $art_remote_url =~ s/^\s+|\s+$//g; 
    ($header, $art_branch)     = split /:/, <$version_info>, 2; $art_branch =~ s/^\s+|\s+$//g;     
    ($header, $art_revision)   = split /:/, <$version_info>, 2; $art_revision =~ s/^\s+|\s+$//g;   
    close($version_info);
}

if ( -e "version.c") {
    $need_to_compare = true;
    $version_c = File::Temp->new(UNLINK => false);
    $fname = $version_c->filename;
} else {
    open $version_c, ">", "version.c" or die "$0: open version.c: $!";
}

print $version_c "#ifdef __xlc__\n";
print $version_c "#pragma comment(user,\"$remote_url,$branch,$revision\")\n";
print $version_c "#pragma comment(user,\"$art_remote_url,$art_branch,$art_revision\")\n";
print $version_c "#endif\n";
print $version_c "#include <string.h>\n";
print $version_c "\n";
print $version_c "const char remote_url[] = \"$remote_url\";\n";
print $version_c "const char branch[] = \"$branch\";\n";
print $version_c "const char revision[] = \"$revision\";\n"; 
print $version_c "const char git_tag[] = \"$git_tag\";\n"; 
print $version_c "const char art_remote_url[] = \"$art_remote_url\";\n";
print $version_c "const char art_branch[] = \"$art_branch\";\n";
print $version_c "const char art_revision[] = \"$art_revision\";\n"; 
print $version_c "\n";
print $version_c "void repository_url(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(remote_url) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, remote_url);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";
print $version_c "void branch_name(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(branch) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, branch);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";
print $version_c "void revision_key(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(revision) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, revision);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";
print $version_c "void git_tag_name(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(git_tag) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, git_tag);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";

print $version_c "void art_repository_url(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(art_remote_url) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, art_remote_url);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "void art_branch_name(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(art_branch) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, art_branch);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";
print $version_c "void art_revision_key(char *name, int *actual_len)\n";
print $version_c "{\n";
print $version_c "  if (strlen(art_revision) > *actual_len)\n";
print $version_c "    {\n";
print $version_c "      *actual_len = 0;\n";
print $version_c "    }\n";
print $version_c "  else\n";
print $version_c "    {\n";
print $version_c "      strcpy(name, art_revision);\n";
print $version_c "      *actual_len = strlen(name);\n";
print $version_c "    }\n";
print $version_c "\n";
print $version_c "  return;\n";
print $version_c "}\n";
print $version_c "\n";
close $version_c;

if ($need_to_compare) {
    if (compare($fname, "version.c") == 0) {
        unlink $fname;
    } else {
        move($fname, "version.c") or die "Copy failed: $!";
    }
}

exit 0;