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_waitstatus
45 failedcmd_report_cmd failedcmd
46 cmdoutput cmdoutput_errok
47 git_rev_parse git_get_ref git_for_each_ref
48 git_for_each_tag_referring is_fast_fwd
49 $package_re $component_re $deliberately_re
51 initdebug enabledebug enabledebuglevel
53 $debugprefix *debuglevel *DEBUG
54 shellquote printcmd messagequote);
55 # implicitly uses $main::us
56 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
57 @EXPORT_OK = @{ $EXPORT_TAGS{policyflags} };
62 our $package_re = '[0-9a-z][-+.0-9a-z]*';
63 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
64 our $deliberately_re = "(?:TEST-)?$package_re";
65 our $branchprefix = 'dgit';
67 # policy hook exit status bits
68 # see dgit-repos-server head comment for documentation
69 # 1 is reserved in case something fails with `exit 1' and to spot
70 # dynamic loader, runtime, etc., failures, which report 127 or 255
71 sub NOFFCHECK () { return 0x2; }
72 sub FRESHREPO () { return 0x4; }
77 sub setup_sigwarn () {
78 our $sigwarn_mainprocess = $$;
79 $SIG{__WARN__} = sub {
80 die $_[0] unless getppid == $sigwarn_mainprocess;
86 open DEBUG, ">/dev/null" or die $!;
90 open DEBUG, ">&STDERR" or die $!;
95 sub enabledebuglevel ($) {
96 my ($newlevel) = @_; # may be undef (eg from env var)
100 return unless $newlevel;
101 $debuglevel = $newlevel;
106 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
109 sub messagequote ($) {
115 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
124 if (!length || m{[^-=_./:0-9a-z]}i) {
131 return join ' ', @out;
136 my $intro = shift @_;
137 print $fh $intro," " or die $!;
138 print $fh shellquote @_ or die $!;
139 print $fh "\n" or die $!;
143 my $extraprefix = shift @_;
144 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
147 sub debiantag_old ($$) {
148 my ($v,$distro) = @_;
153 sub debiantag_new ($$) {
154 my ($v,$distro) = @_;
156 return "archive/$distro/$v";
159 sub debiantags ($$) {
160 my ($version,$distro) = @_;
161 map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
164 sub server_branch ($) { return "$branchprefix/$_[0]"; }
165 sub server_ref ($) { return "refs/".server_branch($_[0]); }
167 sub stat_exists ($) {
170 return 0 if $!==&ENOENT;
175 $::us // ($0 =~ m#[^/]*$#, $&);
181 my $prefix = _us().": ";
182 $s =~ s/^/$prefix/gm;
187 my ($dir) = @_; # does not create parents
188 return if mkdir $dir;
189 return if $! == EEXIST;
190 die "mkdir $dir: $!";
193 sub executable_on_path ($) {
195 return 1 if $program =~ m{/};
196 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
197 foreach my $pe (@path) {
198 my $here = "$pe/$program";
199 return $here if stat_exists $here && -x _;
204 our @signames = split / /, $Config{sig_name};
206 sub waitstatusmsg () {
208 return "terminated, reporting successful completion";
209 } elsif (!($? & 255)) {
210 return "failed with error exit status ".WEXITSTATUS($?);
211 } elsif (WIFSIGNALED($?)) {
212 my $signum=WTERMSIG($?);
213 return "died due to fatal signal ".
214 ($signames[$signum] // "number $signum").
215 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
217 return "failed with unknown wait status ".$?;
221 sub failedcmd_report_cmd {
222 my $intro = shift @_;
223 $intro //= "failed command";
224 { local ($!); printcmd \*STDERR, _us().": $intro:", @_ or die $!; };
227 sub failedcmd_waitstatus {
229 return "failed to fork/exec: $!";
231 return "subprocess ".waitstatusmsg();
233 return "subprocess produced invalid output";
238 # Expects $!,$? as set by close - see below.
239 # To use with system(), set $?=-1 first.
241 # Actual behaviour of perl operations:
242 # success $!==0 $?==0 close of piped open
243 # program failed $!==0 $? >0 close of piped open
244 # syscall failure $! >0 $?=-1 close of piped open
245 # failure $! >0 unchanged close of something else
246 # success trashed $?==0 system
247 # program failed trashed $? >0 system
248 # syscall failure $! >0 unchanged system
249 failedcmd_report_cmd undef, @_;
250 fail failedcmd_waitstatus();
253 sub cmdoutput_errok {
254 confess Dumper(\@_)." ?" if grep { !defined } @_;
256 open P, "-|", @_ or die "$_[0] $!";
259 { local $/ = undef; $d = <P>; }
261 if (!close P) { printdebug "=>!$?\n"; return undef; }
263 if ($debuglevel > 0) {
266 my $more = (length $' ? '...' : ''); #');
267 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
268 printdebug "=> \`$dd'",$more,"\n";
274 my $d = cmdoutput_errok @_;
275 defined $d or failedcmd @_;
279 sub link_ltarget ($$) {
281 lstat $old or return undef;
283 $old = cmdoutput qw(realpath --), $old;
285 link $old, $new or die "link $old $new: $!";
290 my $h = Digest::SHA->new(256);
292 return $h->hexdigest();
295 sub git_rev_parse ($) {
296 return cmdoutput qw(git rev-parse), "$_[0]~0";
299 sub git_for_each_ref ($$;$) {
300 my ($pattern,$func,$gitdir) = @_;
301 # calls $func->($objid,$objtype,$fullrefname,$reftail);
302 # $reftail is RHS of ref after refs/[^/]+/
303 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
304 # $pattern may be an array ref to mean multiple patterns
305 $pattern = [ $pattern ] unless ref $pattern;
306 my @cmd = (qw(git for-each-ref), @$pattern);
307 if (defined $gitdir) {
308 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
310 open GFER, "-|", @cmd or die $!;
314 printdebug "|> ", $_, "\n";
315 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
316 $func->($1,$2,$3,$4);
318 $!=0; $?=0; close GFER or die "$pattern $? $!";
321 sub git_get_ref ($) {
322 # => '' if no such ref
325 s{^refs/}{[r]efs/} or die "$refname $_ ?";
326 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
329 sub git_for_each_tag_referring ($$) {
330 my ($objreferring, $func) = @_;
331 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
332 printdebug "git_for_each_tag_referring ",
333 ($objreferring // 'UNDEF'),"\n";
334 git_for_each_ref('refs/tags', sub {
335 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
336 return unless $objtype eq 'tag';
337 my $refobjid = git_rev_parse $tagobjid;
339 !defined $objreferring # caller wants them all
340 or $tagobjid eq $objreferring
341 or $refobjid eq $objreferring;
342 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
346 sub is_fast_fwd ($$) {
347 my ($ancestor,$child) = @_;
348 my @cmd = (qw(git merge-base), $ancestor, $child);
349 my $mb = cmdoutput_errok @cmd;
351 return git_rev_parse($mb) eq git_rev_parse($ancestor);
353 $?==256 or failedcmd @cmd;