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/>.
35 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
39 @EXPORT = qw(setup_sigwarn forkcheck_setup forkcheck_mainprocess
41 debiantags debiantag_old debiantag_new
42 server_branch server_ref
43 stat_exists link_ltarget
45 fail ensuredir executable_on_path
46 waitstatusmsg failedcmd_waitstatus
47 failedcmd_report_cmd failedcmd
48 cmdoutput cmdoutput_errok
49 git_rev_parse git_cat_file
50 git_get_ref git_for_each_ref
51 git_for_each_tag_referring is_fast_fwd
52 $package_re $component_re $deliberately_re
53 $distro_re $versiontag_re
55 initdebug enabledebug enabledebuglevel
57 $debugprefix *debuglevel *DEBUG
58 shellquote printcmd messagequote);
59 # implicitly uses $main::us
60 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO NOCOMMITCHECK)] );
61 @EXPORT_OK = @{ $EXPORT_TAGS{policyflags} };
66 our $package_re = '[0-9a-z][-+.0-9a-z]*';
67 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
68 our $deliberately_re = "(?:TEST-)?$package_re";
69 our $distro_re = $component_re;
70 our $versiontag_re = qr{[-+.\%_0-9a-zA-Z/]+};
71 our $branchprefix = 'dgit';
73 # policy hook exit status bits
74 # see dgit-repos-server head comment for documentation
75 # 1 is reserved in case something fails with `exit 1' and to spot
76 # dynamic loader, runtime, etc., failures, which report 127 or 255
77 sub NOFFCHECK () { return 0x2; }
78 sub FRESHREPO () { return 0x4; }
79 sub NOCOMMITCHECK () { return 0x8; }
84 our $forkcheck_mainprocess;
86 sub forkcheck_setup () {
87 $forkcheck_mainprocess = $$;
90 sub forkcheck_mainprocess () {
91 # You must have called forkcheck_setup or setup_sigwarn already
92 getppid != $forkcheck_mainprocess;
95 sub setup_sigwarn () {
97 $SIG{__WARN__} = sub {
98 die $_[0] if forkcheck_mainprocess;
104 open DEBUG, ">/dev/null" or die $!;
108 open DEBUG, ">&STDERR" or die $!;
113 sub enabledebuglevel ($) {
114 my ($newlevel) = @_; # may be undef (eg from env var)
118 return unless $newlevel;
119 $debuglevel = $newlevel;
124 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
127 sub messagequote ($) {
133 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
140 defined or confess 'internal error' foreach @_;
143 if (!length || m{[^-=_./:0-9a-z]}i) {
150 return join ' ', @out;
155 my $intro = shift @_;
156 print $fh $intro," " or die $!;
157 print $fh shellquote @_ or die $!;
158 print $fh "\n" or die $!;
162 my $extraprefix = shift @_;
163 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
166 sub dep14_version_mangle ($) {
168 # DEP-14 patch proposed 2016-11-09 "Version Mangling"
170 $v =~ s/\.(?=\.|$|lock$)/.#/g;
174 sub debiantag_old ($$) {
175 my ($v,$distro) = @_;
176 return "$distro/". dep14_version_mangle $v;
179 sub debiantag_new ($$) {
180 my ($v,$distro) = @_;
181 return "archive/$distro/".dep14_version_mangle $v;
184 sub debiantags ($$) {
185 my ($version,$distro) = @_;
186 map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
189 sub server_branch ($) { return "$branchprefix/$_[0]"; }
190 sub server_ref ($) { return "refs/".server_branch($_[0]); }
192 sub stat_exists ($) {
195 return 0 if $!==&ENOENT;
200 $::us // ($0 =~ m#[^/]*$#, $&);
206 my $prefix = _us().": ";
207 $s =~ s/^/$prefix/gm;
212 my ($dir) = @_; # does not create parents
213 return if mkdir $dir;
214 return if $! == EEXIST;
215 die "mkdir $dir: $!";
218 sub executable_on_path ($) {
220 return 1 if $program =~ m{/};
221 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
222 foreach my $pe (@path) {
223 my $here = "$pe/$program";
224 return $here if stat_exists $here && -x _;
229 our @signames = split / /, $Config{sig_name};
231 sub waitstatusmsg () {
233 return "terminated, reporting successful completion";
234 } elsif (!($? & 255)) {
235 return "failed with error exit status ".WEXITSTATUS($?);
236 } elsif (WIFSIGNALED($?)) {
237 my $signum=WTERMSIG($?);
238 return "died due to fatal signal ".
239 ($signames[$signum] // "number $signum").
240 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
242 return "failed with unknown wait status ".$?;
246 sub failedcmd_report_cmd {
247 my $intro = shift @_;
248 $intro //= "failed command";
249 { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or die $!; };
252 sub failedcmd_waitstatus {
254 return "failed to fork/exec: $!";
256 return "subprocess ".waitstatusmsg();
258 return "subprocess produced invalid output";
263 # Expects $!,$? as set by close - see below.
264 # To use with system(), set $?=-1 first.
266 # Actual behaviour of perl operations:
267 # success $!==0 $?==0 close of piped open
268 # program failed $!==0 $? >0 close of piped open
269 # syscall failure $! >0 $?=-1 close of piped open
270 # failure $! >0 unchanged close of something else
271 # success trashed $?==0 system
272 # program failed trashed $? >0 system
273 # syscall failure $! >0 unchanged system
274 failedcmd_report_cmd undef, @_;
275 fail failedcmd_waitstatus();
278 sub cmdoutput_errok {
279 confess Dumper(\@_)." ?" if grep { !defined } @_;
281 open P, "-|", @_ or die "$_[0] $!";
284 { local $/ = undef; $d = <P>; }
286 if (!close P) { printdebug "=>!$?\n"; return undef; }
288 if ($debuglevel > 0) {
291 my $more = (length $' ? '...' : ''); #');
292 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
293 printdebug "=> \`$dd'",$more,"\n";
299 my $d = cmdoutput_errok @_;
300 defined $d or failedcmd @_;
304 sub link_ltarget ($$) {
306 lstat $old or return undef;
308 $old = cmdoutput qw(realpath --), $old;
310 my $r = link $old, $new;
311 $r = symlink $old, $new if !$r && $!==EXDEV;
312 $r or die "(sym)link $old $new: $!";
317 my $h = Digest::SHA->new(256);
319 return $h->hexdigest();
322 sub git_rev_parse ($) {
323 return cmdoutput qw(git rev-parse), "$_[0]~0";
326 sub git_cat_file ($) {
328 # => ($type, $data) or ('missing', undef)
329 # in scalar context, just the data
330 our ($gcf_pid, $gcf_i, $gcf_o);
332 my @cmd = qw(git cat-file --batch);
333 debugcmd "GCF|", @cmd;
334 $gcf_pid = open2 $gcf_o, $gcf_i, @cmd or die $!;
336 printdebug "GCF>| ", $objname, "\n";
337 print $gcf_i $objname, "\n" or die $!;
339 printdebug "GCF<| ", $x;
340 if ($x =~ m/ (missing)$/) { return ($1, undef); }
341 my ($type, $size) = $x =~ m/^.* (\w+) (\d+)\n/ or die "$objname ?";
343 (read $gcf_o, $data, $size) == $size or die "$objname $!";
345 $x eq "\n" or die "$objname ($_) $!";
346 return ($type, $data);
349 sub git_for_each_ref ($$;$) {
350 my ($pattern,$func,$gitdir) = @_;
351 # calls $func->($objid,$objtype,$fullrefname,$reftail);
352 # $reftail is RHS of ref after refs/[^/]+/
353 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
354 # $pattern may be an array ref to mean multiple patterns
355 $pattern = [ $pattern ] unless ref $pattern;
356 my @cmd = (qw(git for-each-ref), @$pattern);
357 if (defined $gitdir) {
358 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
360 open GFER, "-|", @cmd or die $!;
364 printdebug "|> ", $_, "\n";
365 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
366 $func->($1,$2,$3,$4);
368 $!=0; $?=0; close GFER or die "$pattern $? $!";
371 sub git_get_ref ($) {
372 # => '' if no such ref
375 s{^refs/}{[r]efs/} or die "$refname $_ ?";
376 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
379 sub git_for_each_tag_referring ($$) {
380 my ($objreferring, $func) = @_;
381 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
382 printdebug "git_for_each_tag_referring ",
383 ($objreferring // 'UNDEF'),"\n";
384 git_for_each_ref('refs/tags', sub {
385 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
386 return unless $objtype eq 'tag';
387 my $refobjid = git_rev_parse $tagobjid;
389 !defined $objreferring # caller wants them all
390 or $tagobjid eq $objreferring
391 or $refobjid eq $objreferring;
392 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
396 sub is_fast_fwd ($$) {
397 my ($ancestor,$child) = @_;
398 my @cmd = (qw(git merge-base), $ancestor, $child);
399 my $mb = cmdoutput_errok @cmd;
401 return git_rev_parse($mb) eq git_rev_parse($ancestor);
403 $?==256 or failedcmd @cmd;