Dgit.pm: Introduce $deliberately_re and use it everywhere

[dgit.git] / Debian / Dgit.pm

diff --git a/Debian/Dgit.pm b/Debian/Dgit.pm
index b93477402c72dc3a3662c7a99cab81d6735b66b2..3f2988e4b3599f08b4b9e54fa5b2170c53d96723 100644 (file)
--- a/Debian/Dgit.pm
+++ b/Debian/Dgit.pm
@@ -1,37 +1,45 @@
-#
+# -*- perl -*-
 
 package Debian::Dgit;
 
 use strict;
 use warnings;
 
+use POSIX;
+use IO::Handle;
+
 BEGIN {
     use Exporter   ();
     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
 
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
-    @EXPORT      = qw(debiantag
-                      $package_re);
-    %EXPORT_TAGS = ( policyflags => qw() );
-    @EXPORT_OK   = qw();
+    @EXPORT      = qw(debiantag server_branch server_ref
+                      stat_exists git_for_each_ref
+                      git_for_each_tag_referring
+                      $package_re $component_re $deliberately_re
+                      $branchprefix
+                      initdebug enabledebug enabledebuglevel
+                      printdebug debugcmd
+                      $debugprefix *debuglevel *DEBUG
+                      shellquote printcmd);
+    %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
+    @EXPORT_OK   = @{ $EXPORT_TAGS{policyflags} };
 }
 
 our @EXPORT_OK;
 
 our $package_re = '[0-9a-z][-+.0-9a-z]*';
-
+our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
+our $deliberately_re = "(?:TEST-)?$package_re";
+our $branchprefix = 'dgit';
 
 # policy hook exit status bits
-# any unexpected bits mean failure, and then known set bits are ignored
-
-sub NOFFCHECK () { return 2; }
-# suppress dgit-repos-server's ff check ("push" only)
-
-sub FRESHREPO () { return 4; }
-# blow away repo right away (ie, as if before push or fetch)
-# ("check-package" and "push" only)
-
+# see dgit-repos-server head comment for documentation
+# 1 is reserved in case something fails with `exit 1'
+sub NOFFCHECK () { return 0x2; }
+sub FRESHREPO () { return 0x4; }
+# 0x80 is reserved
 
 sub debiantag ($) { 
     my ($v) = @_;
@@ -39,4 +47,94 @@ sub debiantag ($) {
     return "debian/$v";
 }
 
+sub server_branch ($) { return "$branchprefix/$_[0]"; }
+sub server_ref ($) { return "refs/".server_branch($_[0]); }
+
+sub stat_exists ($) {
+    my ($f) = @_;
+    return 1 if stat $f;
+    return 0 if $!==&ENOENT;
+    die "stat $f: $!";
+}
+
+sub git_for_each_ref ($$) {
+    my ($pattern,$func) = @_;
+    # calls $func->($objid,$objtype,$fullrefname,$reftail);
+    # $reftail is RHS of ref after refs/\w+/
+    # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
+    open GFER, "-|", qw(git for-each-ref), $pattern or die $!;
+    while (<GFER>) {
+       m#^(\w+)\s+(\w+)\s+(refs/\w+/(\S+))\s# or die "$_ ?";
+       $func->($1,$2,$3,$4);
+    }
+    $!=0; $?=0; close GFER or die "$pattern $? $!";
+}
+
+sub git_for_each_tag_referring ($$) {
+    my ($objreferring, $func) = @_;
+    # calls $func->($objid,$fullrefname,$tagname);
+    git_for_each_ref('refs/tags', sub {
+       my ($objid,$objtype,$fullrefname,$tagname) = @_;
+       next unless $objtype eq 'tag';
+       next if defined $objreferring and $objid ne $objreferring;
+       $func->($objid,$fullrefname,$tagname);
+    });
+}
+
+our $debugprefix;
+our $debuglevel = 0;
+
+sub initdebug ($) { 
+    ($debugprefix) = @_;
+    open DEBUG, ">/dev/null" or die $!;
+}
+
+sub enabledebug () {
+    open DEBUG, ">&STDERR" or die $!;
+    DEBUG->autoflush(1);
+    $debuglevel ||= 1;
+}
+    
+sub enabledebuglevel ($) {
+    my ($newlevel) = @_; # may be undef (eg from env var)
+    die if $debuglevel;
+    $newlevel //= 0;
+    $newlevel += 0;
+    return unless $newlevel;
+    $debuglevel = $newlevel;
+    enabledebug();
+}
+    
+sub printdebug {
+    print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
+}
+
+sub shellquote {
+    my @out;
+    local $_;
+    foreach my $a (@_) {
+       $_ = $a;
+       if (!length || m{[^-=_./0-9a-z]}i) {
+           s{['\\]}{'\\$&'}g;
+           push @out, "'$_'";
+       } else {
+           push @out, $_;
+       }
+    }
+    return join ' ', @out;
+}
+
+sub printcmd {
+    my $fh = shift @_;
+    my $intro = shift @_;
+    print $fh $intro," " or die $!;
+    print $fh shellquote @_ or die $!;
+    print $fh "\n" or die $!;
+}
+
+sub debugcmd {
+    my $extraprefix = shift @_;
+    printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
+}
+
 1;