3 # Debian::Dgit: functions common to dgit and its helpers and servers
5 # Copyright (C) 2015-2016 Ian Jackson
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
34 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
38 @EXPORT = qw(setup_sigwarn
39 debiantags debiantag_old debiantag_new
40 server_branch server_ref
41 stat_exists link_ltarget
43 fail ensuredir executable_on_path
44 waitstatusmsg failedcmd
45 cmdoutput cmdoutput_errok
46 git_rev_parse git_get_ref git_for_each_ref
47 git_for_each_tag_referring is_fast_fwd
48 $package_re $component_re $deliberately_re
50 initdebug enabledebug enabledebuglevel
52 $debugprefix *debuglevel *DEBUG
53 shellquote printcmd messagequote);
54 # implicitly uses $main::us
55 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
56 @EXPORT_OK = @{ $EXPORT_TAGS{policyflags} };
61 our $package_re = '[0-9a-z][-+.0-9a-z]*';
62 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
63 our $deliberately_re = "(?:TEST-)?$package_re";
64 our $branchprefix = 'dgit';
66 # policy hook exit status bits
67 # see dgit-repos-server head comment for documentation
68 # 1 is reserved in case something fails with `exit 1' and to spot
69 # dynamic loader, runtime, etc., failures, which report 127 or 255
70 sub NOFFCHECK () { return 0x2; }
71 sub FRESHREPO () { return 0x4; }
76 sub setup_sigwarn () {
77 our $sigwarn_mainprocess = $$;
78 $SIG{__WARN__} = sub {
79 die $_[0] unless getppid == $sigwarn_mainprocess;
85 open DEBUG, ">/dev/null" or die $!;
89 open DEBUG, ">&STDERR" or die $!;
94 sub enabledebuglevel ($) {
95 my ($newlevel) = @_; # may be undef (eg from env var)
99 return unless $newlevel;
100 $debuglevel = $newlevel;
105 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
108 sub messagequote ($) {
114 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
123 if (!length || m{[^-=_./:0-9a-z]}i) {
130 return join ' ', @out;
135 my $intro = shift @_;
136 print $fh $intro," " or die $!;
137 print $fh shellquote @_ or die $!;
138 print $fh "\n" or die $!;
142 my $extraprefix = shift @_;
143 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
146 sub debiantag_old ($$) {
147 my ($v,$distro) = @_;
152 sub debiantag_new ($$) {
153 my ($v,$distro) = @_;
155 return "archive/$distro/$v";
158 sub debiantags ($$) {
159 my ($version,$distro) = @_;
160 map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
163 sub server_branch ($) { return "$branchprefix/$_[0]"; }
164 sub server_ref ($) { return "refs/".server_branch($_[0]); }
166 sub stat_exists ($) {
169 return 0 if $!==&ENOENT;
174 $::us // ($0 =~ m#[^/]*$#, $&);
180 my $prefix = _us().": ";
181 $s =~ s/^/$prefix/gm;
186 my ($dir) = @_; # does not create parents
187 return if mkdir $dir;
188 return if $! == EEXIST;
189 die "mkdir $dir: $!";
192 sub executable_on_path ($) {
194 return 1 if $program =~ m{/};
195 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
196 foreach my $pe (@path) {
197 my $here = "$pe/$program";
198 return $here if stat_exists $here && -x _;
203 our @signames = split / /, $Config{sig_name};
205 sub waitstatusmsg () {
207 return "terminated, reporting successful completion";
208 } elsif (!($? & 255)) {
209 return "failed with error exit status ".WEXITSTATUS($?);
210 } elsif (WIFSIGNALED($?)) {
211 my $signum=WTERMSIG($?);
212 return "died due to fatal signal ".
213 ($signames[$signum] // "number $signum").
214 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
216 return "failed with unknown wait status ".$?;
221 # Expects $!,$? as set by close - see below.
222 # To use with system(), set $?=-1 first.
224 # Actual behaviour of perl operations:
225 # success $!==0 $?==0 close of piped open
226 # program failed $!==0 $? >0 close of piped open
227 # syscall failure $! >0 $?=-1 close of piped open
228 # failure $! >0 unchanged close of something else
229 # success trashed $?==0 system
230 # program failed trashed $? >0 system
231 # syscall failure $! >0 unchanged system
232 { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
234 fail "failed to fork/exec: $!";
236 fail "subprocess ".waitstatusmsg();
238 fail "subprocess produced invalid output";
242 sub cmdoutput_errok {
243 confess Dumper(\@_)." ?" if grep { !defined } @_;
245 open P, "-|", @_ or die "$_[0] $!";
248 { local $/ = undef; $d = <P>; }
250 if (!close P) { printdebug "=>!$?\n"; return undef; }
252 if ($debuglevel > 0) {
255 my $more = (length $' ? '...' : ''); #');
256 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
257 printdebug "=> \`$dd'",$more,"\n";
263 my $d = cmdoutput_errok @_;
264 defined $d or failedcmd @_;
268 sub link_ltarget ($$) {
270 lstat $old or return undef;
272 $old = cmdoutput qw(realpath --), $old;
274 link $old, $new or die "link $old $new: $!";
279 my $h = Digest::SHA->new(256);
281 return $h->hexdigest();
284 sub git_rev_parse ($) {
285 return cmdoutput qw(git rev-parse), "$_[0]~0";
288 sub git_for_each_ref ($$;$) {
289 my ($pattern,$func,$gitdir) = @_;
290 # calls $func->($objid,$objtype,$fullrefname,$reftail);
291 # $reftail is RHS of ref after refs/[^/]+/
292 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
293 # $pattern may be an array ref to mean multiple patterns
294 $pattern = [ $pattern ] unless ref $pattern;
295 my @cmd = (qw(git for-each-ref), @$pattern);
296 if (defined $gitdir) {
297 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
299 open GFER, "-|", @cmd or die $!;
303 printdebug "|> ", $_, "\n";
304 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
305 $func->($1,$2,$3,$4);
307 $!=0; $?=0; close GFER or die "$pattern $? $!";
310 sub git_get_ref ($) {
311 # => '' if no such ref
314 s{^refs/}{[r]efs/} or die "$refname $_ ?";
315 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
318 sub git_for_each_tag_referring ($$) {
319 my ($objreferring, $func) = @_;
320 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
321 printdebug "git_for_each_tag_referring ",
322 ($objreferring // 'UNDEF'),"\n";
323 git_for_each_ref('refs/tags', sub {
324 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
325 return unless $objtype eq 'tag';
326 my $refobjid = git_rev_parse $tagobjid;
328 !defined $objreferring # caller wants them all
329 or $tagobjid eq $objreferring
330 or $refobjid eq $objreferring;
331 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
335 sub is_fast_fwd ($$) {
336 my ($ancestor,$child) = @_;
337 my @cmd = (qw(git merge-base), $ancestor, $child);
338 my $mb = cmdoutput_errok @cmd;
340 return git_rev_parse($mb) eq git_rev_parse($ancestor);
342 $?==256 or failedcmd @cmd;