+# This module is part of debbugs, and is released
+# under the terms of the GPL version 2, or any later
+# version at your option.
+# See the file README and COPYING for more information.
+#
+# [Other people have contributed to this file; their copyrights should
+# go here too.]
+# Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
package Debbugs::Common;
qw(appendfile buglog getparsedaddrs getmaintainers),
qw(getmaintainers_reverse)
],
+ misc => [qw(make_list)],
+ date => [qw(secs_to_english)],
quit => [qw(quit)],
- lock => [qw(filelock unfilelock)],
+ lock => [qw(filelock unfilelock @cleanups lockpid)],
);
@EXPORT_OK = ();
- Exporter::export_ok_tags(qw(lock quit util));
+ Exporter::export_ok_tags(qw(lock quit date util misc));
$EXPORT_TAGS{all} = [@EXPORT_OK];
}
use IO::File;
use Debbugs::MIME qw(decode_rfc1522);
use Mail::Address;
+use Cwd qw(cwd);
use Fcntl qw(:flock);
+our $DEBUG_FH = \*STDERR if not defined $DEBUG_FH;
+
=head1 UTILITIES
The following functions are exported by the C<:util> tag
return undef if defined $location and
($location ne 'db' and $location ne 'db-h');
}
- return undef if not defined $location;
my $dir = getlocationpath($location);
return undef if not defined $dir;
- if ($location eq 'db') {
+ if (defined $location and $location eq 'db') {
return "$dir/$bugnum.$ext";
} else {
my $hash = get_hashname($bugnum);
sub appendfile {
my $file = shift;
if (!open(AP,">>$file")) {
- print DEBUG "failed open log<\n";
- print DEBUG "failed open log err $!<\n";
+ 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): $!");
=head2 getparsedaddrs
my $address = getparsedaddrs($address);
- my @address = getpasredaddrs($address);
+ my @address = getparsedaddrs($address);
Returns the output from Mail::Address->parse, or the cached output if
this address has been parsed before. In SCALAR context returns the
=cut
-my %_parsedaddrs;
+our %_parsedaddrs;
sub getparsedaddrs {
my $addr = shift;
return () unless defined $addr;
return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0];
}
-my $_maintainer;
-my $_maintainer_rev;
+our $_maintainer;
+our $_maintainer_rev;
sub getmaintainers {
return $_maintainer if $_maintainer;
my %maintainer;
return $_maintainer_rev;
}
+=head1 DATE
+
+ my $english = secs_to_english($seconds);
+ my ($days,$english) = secs_to_english($seconds);
+
+XXX This should probably be changed to use Date::Calc
+
+=cut
+
+sub secs_to_english{
+ my ($seconds) = @_;
+
+ my $days = int($seconds / 86400);
+ my $years = int($days / 365);
+ $days %= 365;
+ my $result;
+ my @age;
+ push @age, "1 year" if ($years == 1);
+ push @age, "$years years" if ($years > 1);
+ push @age, "1 day" if ($days == 1);
+ push @age, "$days days" if ($days > 1);
+ $result .= join(" and ", @age);
+
+ return wantarray?(int($seconds/86400),$result):$result;
+}
+
=head1 LOCK
=cut
-my @filelocks;
-my @cleanups;
+our @filelocks;
+our @cleanups;
sub filelock {
# NB - NOT COMPATIBLE WITH `with-lock'
my ($lockfile) = @_;
- my ($count,$errors) = @_;
+ if ($lockfile !~ m{^/}) {
+ $lockfile = cwd().'/'.$lockfile;
+ }
+ my ($count,$errors);
$count= 10; $errors= '';
for (;;) {
my $fh = eval {
- my $fh = new IO::File $lockfile,'w'
+ my $fh2 = IO::File->new($lockfile,'w')
or die "Unable to open $lockfile for writing: $!";
- flock($fh,LOCK_EX|LOCK_NB)
+ flock($fh2,LOCK_EX|LOCK_NB)
or die "Unable to lock $lockfile $!";
- return $fh;
+ return $fh2;
};
if ($@) {
$errors .= $@;
close($fl{fh})
or warn "Unable to close lockfile $fl{file}: $!";
unlink($fl{file})
- or warn "Unable to unlink locfile $fl{file}: $!";
+ or warn "Unable to unlink lockfile $fl{file}: $!";
}
+=head2 lockpid
+
+ lockpid('/path/to/pidfile');
+
+Creates a pidfile '/path/to/pidfile' if one doesn't exist or if the
+pid in the file does not respond to kill 0.
+
+Returns 1 on success, false on failure; dies on unusual errors.
+
+=cut
+
+sub lockpid {
+ my ($pidfile) = @_;
+ if (-e $pidfile) {
+ my $pidfh = IO::File->new($pidfile, 'r') or
+ die "Unable to open pidfile $pidfile: $!";
+ local $/;
+ my $pid = <$pidfh>;
+ ($pid) = $pid =~ /(\d+)/;
+ if (defined $pid and kill(0,$pid)) {
+ return 0;
+ }
+ close $pidfh;
+ unlink $pidfile or
+ die "Unable to unlink stale pidfile $pidfile $!";
+ }
+ my $pidfh = IO::File->new($pidfile,'w') or
+ die "Unable to open $pidfile for writing: $!";
+ print {$pidfh} $$ or die "Unable to write to $pidfile $!";
+ close $pidfh or die "Unable to close $pidfile $!";
+ return 1;
+}
=head1 QUIT
=cut
sub quit {
- print DEBUG "quitting >$_[0]<\n";
+ print $DEBUG_FH "quitting >$_[0]<\n" if $DEBUG;
my ($u);
while ($u= $cleanups[$#cleanups]) { &$u; }
die "*** $_[0]\n";
}
+=head1 MISC
+
+These functions are exported with the :misc tag
+
+=head2 make_list
+
+ LIST = make_list(@_);
+
+Turns a scalar or an arrayref into a list; expands a list of arrayrefs
+into a list.
+
+That is, make_list([qw(a b c)]); returns qw(a b c); make_list([qw(a
+b)],[qw(c d)] returns qw(a b c d);
+
+=cut
+
+sub make_list {
+ return map {(ref($_) eq 'ARRAY')?@{$_}:$_} @_;
+}
projects / debbugs.git / blobdiff