From 1635a052c1837d0c4ba20e85cdda070b683f808f Mon Sep 17 00:00:00 2001
From: Don Armstrong <don@donarmstrong.com>
Date: Fri, 30 May 2008 08:39:10 +0200
Subject: [PATCH]  * Rip out the @cleanups; use an END{} instead  * deprecate
 quit  * Document getmaintainers and getmaintainers_reverse  * Clean up lock
 die messages

---
 Debbugs/Common.pm | 62 +++++++++++++++++++++++++++++++----------------
 1 file changed, 41 insertions(+), 21 deletions(-)

diff --git a/Debbugs/Common.pm b/Debbugs/Common.pm
index aae0451..0875fab 100644
--- a/Debbugs/Common.pm
+++ b/Debbugs/Common.pm
@@ -54,6 +54,9 @@ BEGIN{
 }
 
 #use Debbugs::Config qw(:globals);
+
+use Carp;
+
 use Debbugs::Config qw(:config);
 use IO::File;
 use IO::Scalar;
@@ -179,14 +182,11 @@ Opens a file for appending and writes data to it.
 =cut
 
 sub appendfile {
-	my $file = shift;
-	if (!open(AP,">>$file")) {
-		print $DEBUG_FH "failed open log<\n" if $DEBUG;
-		print $DEBUG_FH "failed open log err $!<\n" if $DEBUG;
-		&quit("opening $file (appendfile): $!");
-	}
-	print(AP @_) || &quit("writing $file (appendfile): $!");
-	close(AP) || &quit("closing $file (appendfile): $!");
+	my ($file,@data) = @_;
+	my $fh = IO::File->new($file,'a') or
+	     die "Unable top open $file for appending: $!";
+	print {$fh} @data or die "Unable to write to $file: $!";
+	close $fh or die "Unable to close $file: $!";
 }
 
 =head2 getparsedaddrs
@@ -215,6 +215,14 @@ sub getparsedaddrs {
     return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0];
 }
 
+=head2 getmaintainers
+
+     my $maintainer = getmaintainers()->{debbugs}
+
+Returns a hashref of package => maintainer pairs.
+
+=cut
+
 our $_maintainer;
 our $_maintainer_rev;
 sub getmaintainers {
@@ -223,8 +231,8 @@ sub getmaintainers {
     my %maintainer_rev;
     for my $file (@config{qw(maintainer_file maintainer_file_override pseduo_maint_file)}) {
 	 next unless defined $file;
-	 my $maintfile = new IO::File $file,'r' or
-	      &quitcgi("Unable to open $file: $!");
+	 my $maintfile = IO::File->new($file,'r') or
+	      die "Unable to open maintainer file $file: $!");
 	 while(<$maintfile>) {
 	      next unless m/^(\S+)\s+(\S.*\S)\s*$/;
 	      ($a,$b)=($1,$2);
@@ -240,6 +248,15 @@ sub getmaintainers {
     $_maintainer_rev = \%maintainer_rev;
     return $_maintainer;
 }
+
+=head2 getmaintainers_reverse
+
+     my @packages = @{getmaintainers_reverse->{'don@debian.org'}||[]};
+
+Returns a hashref of maintainer => [qw(list of packages)] pairs.
+
+=cut
+
 sub getmaintainers_reverse{
      return $_maintainer_rev if $_maintainer_rev;
      getmaintainers();
@@ -320,7 +337,6 @@ FLOCKs the passed file. Use unfilelock to unlock it.
 =cut
 
 our @filelocks;
-our @cleanups;
 
 sub filelock {
     # NB - NOT COMPATIBLE WITH `with-lock'
@@ -347,11 +363,17 @@ sub filelock {
 	}
         if (--$count <=0) {
             $errors =~ s/\n+$//;
-            &quit("failed to get lock on $lockfile -- $errors");
+            die "failed to get lock on $lockfile -- $errors";
         }
         sleep 10;
     }
-    push(@cleanups,\&unfilelock);
+}
+
+# clean up all outstanding locks at end time
+END {
+     while (@filelocks) {
+	  unfilelock();
+     }
 }
 
 
@@ -372,7 +394,6 @@ sub unfilelock {
         return;
     }
     my %fl = %{pop(@filelocks)};
-    pop(@cleanups);
     flock($fl{fh},LOCK_UN)
 	 or warn "Unable to unlock lockfile $fl{file}: $!";
     close($fl{fh})
@@ -381,6 +402,7 @@ sub unfilelock {
 	 or warn "Unable to unlink lockfile $fl{file}: $!";
 }
 
+
 =head2 lockpid
 
       lockpid('/path/to/pidfile');
@@ -423,20 +445,18 @@ These functions are exported with the :quit tag.
 
      quit()
 
-Exits the program by calling die after running some cleanups.
+Exits the program by calling die.
 
-This should be replaced with an END handler which runs the cleanups
-instead. (Or possibly a die handler, if the cleanups are important)
+Usage of quit is deprecated; just call die instead.
 
 =cut
 
 sub quit {
-    print {$DEBUG_FH} "quitting >$_[0]<\n" if $DEBUG;
-    my ($u);
-    while ($u= $cleanups[$#cleanups]) { &$u; }
-    die "*** $_[0]\n";
+     print {$DEBUG_FH} "quitting >$_[0]<\n" if $DEBUG;
+     carp "quit() is deprecated; call die directly instead";
 }
 
+
 =head1 MISC
 
 These functions are exported with the :misc tag
-- 
2.39.2