17 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
21 @EXPORT = qw(setup_sigwarn
22 debiantag_old debiantag_new server_branch server_ref
23 stat_exists link_ltarget
25 fail ensuredir executable_on_path
26 waitstatusmsg failedcmd
27 cmdoutput cmdoutput_errok
28 git_rev_parse git_get_ref git_for_each_ref
29 git_for_each_tag_referring is_fast_fwd
30 $package_re $component_re $deliberately_re
32 initdebug enabledebug enabledebuglevel
34 $debugprefix *debuglevel *DEBUG
35 shellquote printcmd messagequote);
36 # implicitly uses $main::us
37 %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
38 @EXPORT_OK = @{ $EXPORT_TAGS{policyflags} };
43 our $package_re = '[0-9a-z][-+.0-9a-z]*';
44 our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
45 our $deliberately_re = "(?:TEST-)?$package_re";
46 our $branchprefix = 'dgit';
48 # policy hook exit status bits
49 # see dgit-repos-server head comment for documentation
50 # 1 is reserved in case something fails with `exit 1' and to spot
51 # dynamic loader, runtime, etc., failures, which report 127 or 255
52 sub NOFFCHECK () { return 0x2; }
53 sub FRESHREPO () { return 0x4; }
58 sub setup_sigwarn () {
59 our $sigwarn_mainprocess = $$;
60 $SIG{__WARN__} = sub {
61 die $_[0] unless getppid == $sigwarn_mainprocess;
67 open DEBUG, ">/dev/null" or die $!;
71 open DEBUG, ">&STDERR" or die $!;
76 sub enabledebuglevel ($) {
77 my ($newlevel) = @_; # may be undef (eg from env var)
81 return unless $newlevel;
82 $debuglevel = $newlevel;
87 print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
90 sub messagequote ($) {
96 s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
105 if (!length || m{[^-=_./:0-9a-z]}i) {
112 return join ' ', @out;
117 my $intro = shift @_;
118 print $fh $intro," " or die $!;
119 print $fh shellquote @_ or die $!;
120 print $fh "\n" or die $!;
124 my $extraprefix = shift @_;
125 printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
128 sub debiantag_old ($$) {
129 my ($v,$distro) = @_;
134 sub debiantag_new ($$) {
135 my ($v,$distro) = @_;
137 return "archive/$distro/$v";
140 sub server_branch ($) { return "$branchprefix/$_[0]"; }
141 sub server_ref ($) { return "refs/".server_branch($_[0]); }
143 sub stat_exists ($) {
146 return 0 if $!==&ENOENT;
151 $::us // ($0 =~ m#[^/]*$#, $&);
156 my $prefix = _us().": ";
157 $s =~ s/^/$prefix/gm;
162 my ($dir) = @_; # does not create parents
163 return if mkdir $dir;
164 return if $! == EEXIST;
165 die "mkdir $dir: $!";
168 sub executable_on_path ($) {
170 return 1 if $program =~ m{/};
171 my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
172 foreach my $pe (@path) {
173 my $here = "$pe/$program";
174 return $here if stat_exists $here && -x _;
179 our @signames = split / /, $Config{sig_name};
181 sub waitstatusmsg () {
183 return "terminated, reporting successful completion";
184 } elsif (!($? & 255)) {
185 return "failed with error exit status ".WEXITSTATUS($?);
186 } elsif (WIFSIGNALED($?)) {
187 my $signum=WTERMSIG($?);
188 return "died due to fatal signal ".
189 ($signames[$signum] // "number $signum").
190 ($? & 128 ? " (core dumped)" : ""); # POSIX(3pm) has no WCOREDUMP
192 return "failed with unknown wait status ".$?;
197 # Expects $!,$? as set by close - see below.
198 # To use with system(), set $?=-1 first.
200 # Actual behaviour of perl operations:
201 # success $!==0 $?==0 close of piped open
202 # program failed $!==0 $? >0 close of piped open
203 # syscall failure $! >0 $?=-1 close of piped open
204 # failure $! >0 unchanged close of something else
205 # success trashed $?==0 system
206 # program failed trashed $? >0 system
207 # syscall failure $! >0 unchanged system
208 { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
210 fail "failed to fork/exec: $!";
212 fail "subprocess ".waitstatusmsg();
214 fail "subprocess produced invalid output";
218 sub cmdoutput_errok {
219 confess Dumper(\@_)." ?" if grep { !defined } @_;
221 open P, "-|", @_ or die "$_[0] $!";
224 { local $/ = undef; $d = <P>; }
226 if (!close P) { printdebug "=>!$?\n"; return undef; }
228 if ($debuglevel > 0) {
231 my $more = (length $' ? '...' : ''); #');
232 $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
233 printdebug "=> \`$dd'",$more,"\n";
239 my $d = cmdoutput_errok @_;
240 defined $d or failedcmd @_;
244 sub link_ltarget ($$) {
246 lstat $old or return undef;
248 $old = cmdoutput qw(realpath --), $old;
250 link $old, $new or die "link $old $new: $!";
255 my $h = Digest::SHA->new(256);
257 return $h->hexdigest();
260 sub git_rev_parse ($) {
261 return cmdoutput qw(git rev-parse), "$_[0]~0";
264 sub git_for_each_ref ($$;$) {
265 my ($pattern,$func,$gitdir) = @_;
266 # calls $func->($objid,$objtype,$fullrefname,$reftail);
267 # $reftail is RHS of ref after refs/[^/]+/
268 # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
269 my @cmd = (qw(git for-each-ref), $pattern);
270 if (defined $gitdir) {
271 @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
273 open GFER, "-|", @cmd or die $!;
277 printdebug "|> ", $_, "\n";
278 m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
279 $func->($1,$2,$3,$4);
281 $!=0; $?=0; close GFER or die "$pattern $? $!";
284 sub git_get_ref ($) {
285 # => '' if no such ref
288 s{^refs/}{[r]efs/} or die "$refname $_ ?";
289 return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
292 sub git_for_each_tag_referring ($$) {
293 my ($objreferring, $func) = @_;
294 # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
295 printdebug "git_for_each_tag_referring ",
296 ($objreferring // 'UNDEF'),"\n";
297 git_for_each_ref('refs/tags', sub {
298 my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
299 return unless $objtype eq 'tag';
300 my $refobjid = git_rev_parse $tagobjid;
302 !defined $objreferring # caller wants them all
303 or $tagobjid eq $objreferring
304 or $refobjid eq $objreferring;
305 $func->($tagobjid,$refobjid,$fullrefname,$tagname);
309 sub is_fast_fwd ($$) {
310 my ($ancestor,$child) = @_;
311 my @cmd = (qw(git merge-base), $ancestor, $child);
312 my $mb = cmdoutput_errok @cmd;
314 return git_rev_parse($mb) eq git_rev_parse($ancestor);
316 $?==256 or failedcmd @cmd;