chiark / gitweb /
Packaging: package the dgit-repos-* scripts
[dgit.git] / Debian / Dgit.pm
index 8b29ba2746be30267b9cef7cf73ff60b3d95e25e..37cbc51b68e52116705d1988cf040eef36919bda 100644 (file)
@@ -1,10 +1,14 @@
-#
+# -*- perl -*-
 
 package Debian::Dgit;
 
 use strict;
 use warnings;
 
+use POSIX;
+use IO::Handle;
+use Config;
+
 BEGIN {
     use Exporter   ();
     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
@@ -12,28 +16,90 @@ BEGIN {
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
     @EXPORT      = qw(debiantag server_branch server_ref
-                      stat_exists
-                      $package_re $branchprefix);
-    %EXPORT_TAGS = ( policyflags => qw() );
-    @EXPORT_OK   = qw();
+                      stat_exists fail ensuredir waitstatusmsg failedcmd
+                      cmdoutput cmdoutput_errok
+                      git_rev_parse git_get_ref git_for_each_ref
+                      git_for_each_tag_referring is_fast_fwd
+                      $package_re $component_re $deliberately_re
+                      $branchprefix
+                      initdebug enabledebug enabledebuglevel
+                      printdebug debugcmd
+                      $debugprefix *debuglevel *DEBUG
+                      shellquote printcmd);
+    # implicitly uses $main::us
+    %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
+    @EXPORT_OK   = @{ $EXPORT_TAGS{policyflags} };
 }
 
 our @EXPORT_OK;
 
 our $package_re = '[0-9a-z][-+.0-9a-z]*';
+our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
+our $deliberately_re = "(?:TEST-)?$package_re";
 our $branchprefix = 'dgit';
 
-
 # policy hook exit status bits
-# any unexpected bits mean failure, and then known set bits are ignored
+# see dgit-repos-server head comment for documentation
+# 1 is reserved in case something fails with `exit 1' and to spot
+# dynamic loader, runtime, etc., failures, which report 127 or 255
+sub NOFFCHECK () { return 0x2; }
+sub FRESHREPO () { return 0x4; }
+
+our $debugprefix;
+our $debuglevel = 0;
+
+sub initdebug ($) { 
+    ($debugprefix) = @_;
+    open DEBUG, ">/dev/null" or die $!;
+}
 
-sub NOFFCHECK () { return 2; }
-# suppress dgit-repos-server's ff check ("push" only)
+sub enabledebug () {
+    open DEBUG, ">&STDERR" or die $!;
+    DEBUG->autoflush(1);
+    $debuglevel ||= 1;
+}
+    
+sub enabledebuglevel ($) {
+    my ($newlevel) = @_; # may be undef (eg from env var)
+    die if $debuglevel;
+    $newlevel //= 0;
+    $newlevel += 0;
+    return unless $newlevel;
+    $debuglevel = $newlevel;
+    enabledebug();
+}
+    
+sub printdebug {
+    print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
+}
 
-sub FRESHREPO () { return 4; }
-# blow away repo right away (ie, as if before push or fetch)
-# ("check-package" and "push" only)
+sub shellquote {
+    my @out;
+    local $_;
+    foreach my $a (@_) {
+       $_ = $a;
+       if (!length || m{[^-=_./0-9a-z]}i) {
+           s{['\\]}{'\\$&'}g;
+           push @out, "'$_'";
+       } else {
+           push @out, $_;
+       }
+    }
+    return join ' ', @out;
+}
 
+sub printcmd {
+    my $fh = shift @_;
+    my $intro = shift @_;
+    print $fh $intro," " or die $!;
+    print $fh shellquote @_ or die $!;
+    print $fh "\n" or die $!;
+}
+
+sub debugcmd {
+    my $extraprefix = shift @_;
+    printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
+}
 
 sub debiantag ($) { 
     my ($v) = @_;
@@ -51,4 +117,132 @@ sub stat_exists ($) {
     die "stat $f: $!";
 }
 
+sub _us () {
+    $::us // ($0 =~ m#[^/]*$#, $&);
+}
+
+sub fail { 
+    my $s = "@_\n";
+    my $prefix = _us().": ";
+    $s =~ s/^/$prefix/gm;
+    die $s;
+}
+
+sub ensuredir ($) {
+    my ($dir) = @_; # does not create parents
+    return if mkdir $dir;
+    return if $! == EEXIST;
+    die "mkdir $dir: $!";
+}
+
+our @signames = split / /, $Config{sig_name};
+
+sub waitstatusmsg () {
+    if (!$?) {
+       return "terminated, reporting successful completion";
+    } elsif (!($? & 255)) {
+       return "failed with error exit status ".WEXITSTATUS($?);
+    } elsif (WIFSIGNALED($?)) {
+       my $signum=WTERMSIG($?);
+       return "died due to fatal signal ".
+           ($signames[$signum] // "number $signum").
+           ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
+    } else {
+       return "failed with unknown wait status ".$?;
+    }
+}
+
+sub failedcmd {
+    { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
+    if ($!) {
+       fail "failed to fork/exec: $!";
+    } elsif ($?) {
+       fail "subprocess ".waitstatusmsg();
+    } else {
+       fail "subprocess produced invalid output";
+    }
+}
+
+sub cmdoutput_errok {
+    die Dumper(\@_)." ?" if grep { !defined } @_;
+    debugcmd "|",@_;
+    open P, "-|", @_ or die $!;
+    my $d;
+    $!=0; $?=0;
+    { local $/ = undef; $d = <P>; }
+    die $! if P->error;
+    if (!close P) { printdebug "=>!$?\n"; return undef; }
+    chomp $d;
+    $d =~ m/^.*/;
+    printdebug "=> \`$&'",(length $' ? '...' : ''),"\n" if $debuglevel>0; #';
+    return $d;
+}
+
+sub cmdoutput {
+    my $d = cmdoutput_errok @_;
+    defined $d or failedcmd @_;
+    return $d;
+}
+
+sub git_rev_parse ($) {
+    return cmdoutput qw(git rev-parse), "$_[0]~0";
+}
+
+sub git_for_each_ref ($$;$) {
+    my ($pattern,$func,$gitdir) = @_;
+    # calls $func->($objid,$objtype,$fullrefname,$reftail);
+    # $reftail is RHS of ref after refs/[^/]+/
+    # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
+    my @cmd = (qw(git for-each-ref), $pattern);
+    if (defined $gitdir) {
+       @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
+    }
+    open GFER, "-|", @cmd or die $!;
+    debugcmd "|", @cmd;
+    while (<GFER>) {
+       chomp or die "$_ ?";
+       printdebug "|> ", $_, "\n";
+       m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
+       $func->($1,$2,$3,$4);
+    }
+    $!=0; $?=0; close GFER or die "$pattern $? $!";
+}
+
+sub git_get_ref ($) {
+    # => '' if no such ref
+    my ($refname) = @_;
+    local $_ = $refname;
+    s{^refs/}{[r]efs/} or die "$refname $_ ?";
+    return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
+}
+
+sub git_for_each_tag_referring ($$) {
+    my ($objreferring, $func) = @_;
+    # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
+    printdebug "git_for_each_tag_referring ",
+        ($objreferring // 'UNDEF'),"\n";
+    git_for_each_ref('refs/tags', sub {
+       my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
+       return unless $objtype eq 'tag';
+       my $refobjid = git_rev_parse $tagobjid;
+       return unless
+           !defined $objreferring # caller wants them all
+           or $tagobjid eq $objreferring
+           or $refobjid eq $objreferring;
+       $func->($tagobjid,$refobjid,$fullrefname,$tagname);
+    });
+}
+
+sub is_fast_fwd ($$) {
+    my ($ancestor,$child) = @_;
+    my @cmd = (qw(git merge-base), $ancestor, $child);
+    my $mb = cmdoutput_errok @cmd;
+    if (defined $mb) {
+       return git_rev_parse($mb) eq git_rev_parse($ancestor);
+    } else {
+       $?==256 or failedcmd @cmd;
+       return 0;
+    }
+}
+
 1;