Debian/Dgit.pm

   1 # -*- perl -*-
   2
   3 package Debian::Dgit;
   4
   5 use strict;
   6 use warnings;
   7
   8 use POSIX;
   9 use IO::Handle;
  10 use Config;
  11
  12 BEGIN {
  13     use Exporter   ();
  14     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
  15
  16     $VERSION     = 1.00;
  17     @ISA         = qw(Exporter);
  18     @EXPORT      = qw(setup_sigwarn
  19                       debiantag server_branch server_ref
  20                       stat_exists fail ensuredir waitstatusmsg failedcmd
  21                       cmdoutput cmdoutput_errok
  22                       git_rev_parse git_get_ref git_for_each_ref
  23                       git_for_each_tag_referring is_fast_fwd
  24                       $package_re $component_re $deliberately_re
  25                       $branchprefix
  26                       initdebug enabledebug enabledebuglevel
  27                       printdebug debugcmd
  28                       $debugprefix *debuglevel *DEBUG
  29                       shellquote printcmd);
  30     # implicitly uses $main::us
  31     %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
  32     @EXPORT_OK   = @{ $EXPORT_TAGS{policyflags} };
  33 }
  34
  35 our @EXPORT_OK;
  36
  37 our $package_re = '[0-9a-z][-+.0-9a-z]*';
  38 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
  39 our $deliberately_re = "(?:TEST-)?$package_re";
  40 our $branchprefix = 'dgit';
  41
  42 # policy hook exit status bits
  43 # see dgit-repos-server head comment for documentation
  44 # 1 is reserved in case something fails with `exit 1' and to spot
  45 # dynamic loader, runtime, etc., failures, which report 127 or 255
  46 sub NOFFCHECK () { return 0x2; }
  47 sub FRESHREPO () { return 0x4; }
  48
  49 our $debugprefix;
  50 our $debuglevel = 0;
  51
  52 sub setup_sigwarn () {
  53     our $sigwarn_mainprocess = $$;
  54     $SIG{__WARN__} = sub {
  55         die $_[0] unless getppid == $sigwarn_mainprocess;
  56     };
  57 }
  58
  59 sub initdebug ($) {
  60     ($debugprefix) = @_;
  61     open DEBUG, ">/dev/null" or die $!;
  62 }
  63
  64 sub enabledebug () {
  65     open DEBUG, ">&STDERR" or die $!;
  66     DEBUG->autoflush(1);
  67     $debuglevel ||= 1;
  68 }
  69
  70 sub enabledebuglevel ($) {
  71     my ($newlevel) = @_; # may be undef (eg from env var)
  72     die if $debuglevel;
  73     $newlevel //= 0;
  74     $newlevel += 0;
  75     return unless $newlevel;
  76     $debuglevel = $newlevel;
  77     enabledebug();
  78 }
  79
  80 sub printdebug {
  81     print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
  82 }
  83
  84 sub shellquote {
  85     my @out;
  86     local $_;
  87     foreach my $a (@_) {
  88         $_ = $a;
  89         if (!length || m{[^-=_./0-9a-z]}i) {
  90             s{['\\]}{'\\$&'}g;
  91             push @out, "'$_'";
  92         } else {
  93             push @out, $_;
  94         }
  95     }
  96     return join ' ', @out;
  97 }
  98
  99 sub printcmd {
 100     my $fh = shift @_;
 101     my $intro = shift @_;
 102     print $fh $intro," " or die $!;
 103     print $fh shellquote @_ or die $!;
 104     print $fh "\n" or die $!;
 105 }
 106
 107 sub debugcmd {
 108     my $extraprefix = shift @_;
 109     printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
 110 }
 111
 112 sub debiantag ($$) {
 113     my ($v,$distro) = @_;
 114     $v =~ y/~:/_%/;
 115     return "$distro/$v";
 116 }
 117
 118 sub server_branch ($) { return "$branchprefix/$_[0]"; }
 119 sub server_ref ($) { return "refs/".server_branch($_[0]); }
 120
 121 sub stat_exists ($) {
 122     my ($f) = @_;
 123     return 1 if stat $f;
 124     return 0 if $!==&ENOENT;
 125     die "stat $f: $!";
 126 }
 127
 128 sub _us () {
 129     $::us // ($0 =~ m#[^/]*$#, $&);
 130 }
 131
 132 sub fail {
 133     my $s = "@_\n";
 134     my $prefix = _us().": ";
 135     $s =~ s/^/$prefix/gm;
 136     die $s;
 137 }
 138
 139 sub ensuredir ($) {
 140     my ($dir) = @_; # does not create parents
 141     return if mkdir $dir;
 142     return if $! == EEXIST;
 143     die "mkdir $dir: $!";
 144 }
 145
 146 our @signames = split / /, $Config{sig_name};
 147
 148 sub waitstatusmsg () {
 149     if (!$?) {
 150         return "terminated, reporting successful completion";
 151     } elsif (!($? & 255)) {
 152         return "failed with error exit status ".WEXITSTATUS($?);
 153     } elsif (WIFSIGNALED($?)) {
 154         my $signum=WTERMSIG($?);
 155         return "died due to fatal signal ".
 156             ($signames[$signum] // "number $signum").
 157             ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
 158     } else {
 159         return "failed with unknown wait status ".$?;
 160     }
 161 }
 162
 163 sub failedcmd {
 164     { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
 165     if ($!) {
 166         fail "failed to fork/exec: $!";
 167     } elsif ($?) {
 168         fail "subprocess ".waitstatusmsg();
 169     } else {
 170         fail "subprocess produced invalid output";
 171     }
 172 }
 173
 174 sub cmdoutput_errok {
 175     die Dumper(\@_)." ?" if grep { !defined } @_;
 176     debugcmd "|",@_;
 177     open P, "-|", @_ or die $!;
 178     my $d;
 179     $!=0; $?=0;
 180     { local $/ = undef; $d = <P>; }
 181     die $! if P->error;
 182     if (!close P) { printdebug "=>!$?\n"; return undef; }
 183     chomp $d;
 184     if ($debuglevel > 0) {
 185         $d =~ m/^.*/;
 186         my $dd = $&;
 187         my $more = (length $' ? '...' : ''); #');
 188         $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
 189         printdebug "=> \`$dd'",$more,"\n";
 190     }
 191     return $d;
 192 }
 193
 194 sub cmdoutput {
 195     my $d = cmdoutput_errok @_;
 196     defined $d or failedcmd @_;
 197     return $d;
 198 }
 199
 200 sub git_rev_parse ($) {
 201     return cmdoutput qw(git rev-parse), "$_[0]~0";
 202 }
 203
 204 sub git_for_each_ref ($$;$) {
 205     my ($pattern,$func,$gitdir) = @_;
 206     # calls $func->($objid,$objtype,$fullrefname,$reftail);
 207     # $reftail is RHS of ref after refs/[^/]+/
 208     # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
 209     my @cmd = (qw(git for-each-ref), $pattern);
 210     if (defined $gitdir) {
 211         @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
 212     }
 213     open GFER, "-|", @cmd or die $!;
 214     debugcmd "|", @cmd;
 215     while (<GFER>) {
 216         chomp or die "$_ ?";
 217         printdebug "|> ", $_, "\n";
 218         m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
 219         $func->($1,$2,$3,$4);
 220     }
 221     $!=0; $?=0; close GFER or die "$pattern $? $!";
 222 }
 223
 224 sub git_get_ref ($) {
 225     # => '' if no such ref
 226     my ($refname) = @_;
 227     local $_ = $refname;
 228     s{^refs/}{[r]efs/} or die "$refname $_ ?";
 229     return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
 230 }
 231
 232 sub git_for_each_tag_referring ($$) {
 233     my ($objreferring, $func) = @_;
 234     # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
 235     printdebug "git_for_each_tag_referring ",
 236         ($objreferring // 'UNDEF'),"\n";
 237     git_for_each_ref('refs/tags', sub {
 238         my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
 239         return unless $objtype eq 'tag';
 240         my $refobjid = git_rev_parse $tagobjid;
 241         return unless
 242             !defined $objreferring # caller wants them all
 243             or $tagobjid eq $objreferring
 244             or $refobjid eq $objreferring;
 245         $func->($tagobjid,$refobjid,$fullrefname,$tagname);
 246     });
 247 }
 248
 249 sub is_fast_fwd ($$) {
 250     my ($ancestor,$child) = @_;
 251     my @cmd = (qw(git merge-base), $ancestor, $child);
 252     my $mb = cmdoutput_errok @cmd;
 253     if (defined $mb) {
 254         return git_rev_parse($mb) eq git_rev_parse($ancestor);
 255     } else {
 256         $?==256 or failedcmd @cmd;
 257         return 0;
 258     }
 259 }
 260
 261 1;