Debugging output: Break out debugcmd into Dgit.pm and use it everywhere (nfc)

[dgit.git] / Debian / Dgit.pm

diff --git a/Debian/Dgit.pm b/Debian/Dgit.pm
index 268439afaa44e5cdfdf4e9addb0dcf3c43a7ca87..2b9479db58d9b4e5f07c0301033657d449475c75 100644 (file)
--- a/Debian/Dgit.pm
+++ b/Debian/Dgit.pm
@@ -6,6 +6,7 @@ use strict;
 use warnings;
 
 use POSIX;
+use IO::Handle;
 
 BEGIN {
     use Exporter   ();
@@ -15,7 +16,10 @@ BEGIN {
     @ISA         = qw(Exporter);
     @EXPORT      = qw(debiantag server_branch server_ref
                       stat_exists git_for_each_ref
-                      $package_re $branchprefix);
+                      $package_re $component_re $branchprefix
+                      initdebug enabledebug printdebug debugcmd
+                      $debugprefix $debug
+                      shellquote printcmd);
     %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
     @EXPORT_OK   = @{ $EXPORT_TAGS{policyflags} };
 }
@@ -23,14 +27,15 @@ BEGIN {
 our @EXPORT_OK;
 
 our $package_re = '[0-9a-z][-+.0-9a-z]*';
+our $component_re = '[0-9a-zA-Z][-+.0-9a-zA-Z]*';
 our $branchprefix = 'dgit';
 
 # policy hook exit status bits
 # see dgit-repos-server head comment for documentation
 # 1 is reserved in case something fails with `exit 1'
-sub NOFFCHECK () { return 2; }
-sub FRESHREPO () { return 4; }
-# 128 is reserved
+sub NOFFCHECK () { return 0x2; }
+sub FRESHREPO () { return 0x4; }
+# 0x80 is reserved
 
 sub debiantag ($) { 
     my ($v) = @_;
@@ -72,4 +77,50 @@ sub git_for_each_tag_referring ($$) {
     });
 }
 
+our $debugprefix;
+our $debug = 0;
+
+sub initdebug ($) { 
+    ($debugprefix) = @_;
+    open ::DEBUG, ">/dev/null" or die $!;
+}
+
+sub enabledebug () {
+    open ::DEBUG, ">&STDERR" or die $!;
+    ::DEBUG->autoflush(1);
+    $debug ||= 1;
+}
+    
+sub printdebug {
+    print ::DEBUG $debugprefix, @_ or die $!;
+}
+
+sub shellquote {
+    my @out;
+    local $_;
+    foreach my $a (@_) {
+       $_ = $a;
+       if (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 $debug>0;
+}
+
 1;