15 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
19 @EXPORT = qw(setup_sigwarn
20 debiantag server_branch server_ref
21 stat_exists link_ltarget
23 fail ensuredir executable_on_path
24 waitstatusmsg failedcmd
25 cmdoutput cmdoutput_errok
26 git_rev_parse git_get_ref git_for_each_ref
27 git_for_each_tag_referring is_fast_fwd
28 $package_re $component_re $deliberately_re
30 initdebug enabledebug enabledebuglevel
32 $debugprefix *debuglevel *DEBUG
33 shellquote printcmd messagequote);
34 # implicitly uses $main::us
35 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
36 @EXPORT_OK = @{ $EXPORT_TAGS{policyflags} };
41 our $package_re = '[0-9a-z][-+.0-9a-z]*';
42 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
43 our $deliberately_re = "(?:TEST-)?$package_re";
44 our $branchprefix = 'dgit';
46 # policy hook exit status bits
47 # see dgit-repos-server head comment for documentation
48 # 1 is reserved in case something fails with `exit 1' and to spot
49 # dynamic loader, runtime, etc., failures, which report 127 or 255
50 sub NOFFCHECK () { return 0x2; }
51 sub FRESHREPO () { return 0x4; }
56 sub setup_sigwarn () {
57 our $sigwarn_mainprocess = $$;
58 $SIG{__WARN__} = sub {
59 die $_[0] unless getppid == $sigwarn_mainprocess;
65 open DEBUG, ">/dev/null" or die $!;
69 open DEBUG, ">&STDERR" or die $!;
74 sub enabledebuglevel ($) {
75 my ($newlevel) = @_; # may be undef (eg from env var)
79 return unless $newlevel;
80 $debuglevel = $newlevel;
85 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
88 sub messagequote ($) {
94 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
103 if (!length || m{[^-=_./:0-9a-z]}i) {
110 return join ' ', @out;
115 my $intro = shift @_;
116 print $fh $intro," " or die $!;
117 print $fh shellquote @_ or die $!;
118 print $fh "\n" or die $!;
122 my $extraprefix = shift @_;
123 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
127 my ($v,$distro) = @_;
132 sub server_branch ($) { return "$branchprefix/$_[0]"; }
133 sub server_ref ($) { return "refs/".server_branch($_[0]); }
135 sub stat_exists ($) {
138 return 0 if $!==&ENOENT;
143 $::us // ($0 =~ m#[^/]*$#, $&);
148 my $prefix = _us().": ";
149 $s =~ s/^/$prefix/gm;
154 my ($dir) = @_; # does not create parents
155 return if mkdir $dir;
156 return if $! == EEXIST;
157 die "mkdir $dir: $!";
160 sub executable_on_path ($) {
162 return 1 if $program =~ m{/};
163 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
164 foreach my $pe (@path) {
165 my $here = "$pe/$program";
166 return $here if stat_exists $here && -x _;
171 our @signames = split / /, $Config{sig_name};
173 sub waitstatusmsg () {
175 return "terminated, reporting successful completion";
176 } elsif (!($? & 255)) {
177 return "failed with error exit status ".WEXITSTATUS($?);
178 } elsif (WIFSIGNALED($?)) {
179 my $signum=WTERMSIG($?);
180 return "died due to fatal signal ".
181 ($signames[$signum] // "number $signum").
182 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
184 return "failed with unknown wait status ".$?;
189 # Expects $!,$? as set by close - see below.
190 # To use with system(), set $?=-1 first.
192 # Actual behaviour of perl operations:
193 # success $!==0 $?==0 close of piped open
194 # program failed $!==0 $? >0 close of piped open
195 # syscall failure $! >0 $?=-1 close of piped open
196 # failure $! >0 unchanged close of something else
197 # success trashed $?==0 system
198 # program failed trashed $? >0 system
199 # syscall failure $! >0 unchanged system
200 { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
202 fail "failed to fork/exec: $!";
204 fail "subprocess ".waitstatusmsg();
206 fail "subprocess produced invalid output";
210 sub cmdoutput_errok {
211 die Dumper(\@_)." ?" if grep { !defined } @_;
213 open P, "-|", @_ or die "$_[0] $!";
216 { local $/ = undef; $d = <P>; }
218 if (!close P) { printdebug "=>!$?\n"; return undef; }
220 if ($debuglevel > 0) {
223 my $more = (length $' ? '...' : ''); #');
224 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
225 printdebug "=> \`$dd'",$more,"\n";
231 my $d = cmdoutput_errok @_;
232 defined $d or failedcmd @_;
236 sub link_ltarget ($$) {
238 lstat $old or return undef;
240 $old = cmdoutput qw(realpath --), $old;
242 link $old, $new or die "link $old $new: $!";
247 my $h = Digest::SHA->new(256);
249 return $h->hexdigest();
252 sub git_rev_parse ($) {
253 return cmdoutput qw(git rev-parse), "$_[0]~0";
256 sub git_for_each_ref ($$;$) {
257 my ($pattern,$func,$gitdir) = @_;
258 # calls $func->($objid,$objtype,$fullrefname,$reftail);
259 # $reftail is RHS of ref after refs/[^/]+/
260 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
261 my @cmd = (qw(git for-each-ref), $pattern);
262 if (defined $gitdir) {
263 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
265 open GFER, "-|", @cmd or die $!;
269 printdebug "|> ", $_, "\n";
270 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
271 $func->($1,$2,$3,$4);
273 $!=0; $?=0; close GFER or die "$pattern $? $!";
276 sub git_get_ref ($) {
277 # => '' if no such ref
280 s{^refs/}{[r]efs/} or die "$refname $_ ?";
281 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
284 sub git_for_each_tag_referring ($$) {
285 my ($objreferring, $func) = @_;
286 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
287 printdebug "git_for_each_tag_referring ",
288 ($objreferring // 'UNDEF'),"\n";
289 git_for_each_ref('refs/tags', sub {
290 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
291 return unless $objtype eq 'tag';
292 my $refobjid = git_rev_parse $tagobjid;
294 !defined $objreferring # caller wants them all
295 or $tagobjid eq $objreferring
296 or $refobjid eq $objreferring;
297 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
301 sub is_fast_fwd ($$) {
302 my ($ancestor,$child) = @_;
303 my @cmd = (qw(git merge-base), $ancestor, $child);
304 my $mb = cmdoutput_errok @cmd;
306 return git_rev_parse($mb) eq git_rev_parse($ancestor);
308 $?==256 or failedcmd @cmd;