1 # This module is part of debbugs, and is released
2 # under the terms of the GPL version 2, or any later
3 # version at your option.
4 # See the file README and COPYING for more information.
6 # [Other people have contributed to this file; their copyrights should
8 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
10 package Debbugs::Common;
14 Debbugs::Common -- Common routines for all of Debbugs
18 use Debbugs::Common qw(:url :html);
23 This module is a replacement for the general parts of errorlib.pl.
24 subroutines in errorlib.pl will be gradually phased out and replaced
25 with equivalent (or better) functionality here.
33 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
34 use base qw(Exporter);
38 $DEBUG = 0 unless defined $DEBUG;
41 %EXPORT_TAGS = (util => [qw(getbugcomponent getbuglocation getlocationpath get_hashname),
42 qw(appendfile buglog getparsedaddrs getmaintainers),
44 qw(getmaintainers_reverse),
46 qw(package_maintainer),
48 misc => [qw(make_list globify_scalar english_join checkpid),
49 qw(cleanup_eval_fail),
51 date => [qw(secs_to_english)],
53 lock => [qw(filelock unfilelock lockpid)],
56 Exporter::export_ok_tags(qw(lock quit date util misc));
57 $EXPORT_TAGS{all} = [@EXPORT_OK];
60 #use Debbugs::Config qw(:globals);
64 use Debbugs::Config qw(:config);
67 use Debbugs::MIME qw(decode_rfc1522);
71 use Params::Validate qw(validate_with :types);
75 our $DEBUG_FH = \*STDERR if not defined $DEBUG_FH;
79 The following functions are exported by the C<:util> tag
81 =head2 getbugcomponent
83 my $file = getbugcomponent($bug_number,$extension,$location)
85 Returns the path to the bug file in location C<$location>, bug number
86 C<$bugnumber> and extension C<$extension>
91 my ($bugnum, $ext, $location) = @_;
93 if (not defined $location) {
94 $location = getbuglocation($bugnum, $ext);
95 # Default to non-archived bugs only for now; CGI scripts want
96 # archived bugs but most of the backend scripts don't. For now,
97 # anything that is prepared to accept archived bugs should call
98 # getbuglocation() directly first.
99 return undef if defined $location and
100 ($location ne 'db' and $location ne 'db-h');
102 my $dir = getlocationpath($location);
103 return undef if not defined $dir;
104 if (defined $location and $location eq 'db') {
105 return "$dir/$bugnum.$ext";
107 my $hash = get_hashname($bugnum);
108 return "$dir/$hash/$bugnum.$ext";
112 =head2 getbuglocation
114 getbuglocation($bug_number,$extension)
116 Returns the the location in which a particular bug exists; valid
117 locations returned currently are archive, db-h, or db. If the bug does
118 not exist, returns undef.
123 my ($bugnum, $ext) = @_;
124 my $archdir = get_hashname($bugnum);
125 return 'archive' if -r getlocationpath('archive')."/$archdir/$bugnum.$ext";
126 return 'db-h' if -r getlocationpath('db-h')."/$archdir/$bugnum.$ext";
127 return 'db' if -r getlocationpath('db')."/$bugnum.$ext";
132 =head2 getlocationpath
134 getlocationpath($location)
136 Returns the path to a specific location
140 sub getlocationpath {
142 if (defined $location and $location eq 'archive') {
143 return "$config{spool_dir}/archive";
144 } elsif (defined $location and $location eq 'db') {
145 return "$config{spool_dir}/db";
147 return "$config{spool_dir}/db-h";
156 Returns the hash of the bug which is the location within the archive
161 return "" if ( $_[ 0 ] < 0 );
162 return sprintf "%02d", $_[ 0 ] % 100;
169 Returns the path to the logfile corresponding to the bug.
171 Returns undef if the bug does not exist.
177 my $location = getbuglocation($bugnum, 'log');
178 return getbugcomponent($bugnum, 'log', $location) if ($location);
179 $location = getbuglocation($bugnum, 'log.gz');
180 return getbugcomponent($bugnum, 'log.gz', $location) if ($location);
189 Returns the path to the summary file corresponding to the bug.
191 Returns undef if the bug does not exist.
197 my $location = getbuglocation($bugnum, 'summary');
198 return getbugcomponent($bugnum, 'summary', $location) if ($location);
204 appendfile($file,'data','to','append');
206 Opens a file for appending and writes data to it.
211 my ($file,@data) = @_;
212 my $fh = IO::File->new($file,'a') or
213 die "Unable top open $file for appending: $!";
214 print {$fh} @data or die "Unable to write to $file: $!";
215 close $fh or die "Unable to close $file: $!";
218 =head2 getparsedaddrs
220 my $address = getparsedaddrs($address);
221 my @address = getparsedaddrs($address);
223 Returns the output from Mail::Address->parse, or the cached output if
224 this address has been parsed before. In SCALAR context returns the
225 first address parsed.
233 return () unless defined $addr;
234 return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0]
235 if exists $_parsedaddrs{$addr};
237 # don't display the warnings from Mail::Address->parse
238 local $SIG{__WARN__} = sub { };
239 @{$_parsedaddrs{$addr}} = Mail::Address->parse($addr);
241 return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0];
244 =head2 getmaintainers
246 my $maintainer = getmaintainers()->{debbugs}
248 Returns a hashref of package => maintainer pairs.
252 our $_maintainer = undef;
253 our $_maintainer_rev = undef;
255 return $_maintainer if defined $_maintainer;
256 package_maintainer(rehash => 1);
260 =head2 getmaintainers_reverse
262 my @packages = @{getmaintainers_reverse->{'don@debian.org'}||[]};
264 Returns a hashref of maintainer => [qw(list of packages)] pairs.
268 sub getmaintainers_reverse{
269 return $_maintainer_rev if defined $_maintainer_rev;
270 package_maintainer(rehash => 1);
271 return $_maintainer_rev;
274 =head2 package_maintainer
276 my @s = package_maintainer(source => [qw(foo bar baz)],
277 binary => [qw(bleh blah)],
282 =item source -- scalar or arrayref of source package names to return
283 maintainers for, defaults to the empty arrayref.
285 =item binary -- scalar or arrayref of binary package names to return
286 maintainers for; automatically returns source package maintainer if
287 the package name starts with 'src:', defaults to the empty arrayref.
289 =item reverse -- whether to return the source/binary packages a
290 maintainer maintains instead
292 =item rehash -- whether to reread the maintainer and source maintainer
299 our $_source_maintainer = undef;
300 our $_source_maintainer_rev = undef;
301 sub package_maintainer {
302 my %param = validate_with(params => \@_,
303 spec => {source => {type => SCALAR|ARRAYREF,
306 binary => {type => SCALAR|ARRAYREF,
309 rehash => {type => BOOLEAN,
312 reverse => {type => BOOLEAN,
317 if ($param{rehash}) {
318 $_source_maintainer = undef;
319 $_source_maintainer_rev = undef;
320 $_maintainer = undef;
321 $_maintainer_rev = undef;
323 if (not defined $_source_maintainer or
324 not defined $_source_maintainer_rev) {
325 $_source_maintainer = {};
326 $_source_maintainer_rev = {};
327 for my $fn (@config{('source_maintainer_file',
328 'source_maintainer_file_override',
329 'pseduo_maint_file')}) {
330 next unless defined $fn;
331 __add_to_hash($fn,$_source_maintainer,
332 $_source_maintainer_rev);
335 if (not defined $_maintainer or
336 not defined $_maintainer_rev) {
338 $_maintainer_rev = {};
339 for my $fn (@config{('maintainer_file',
340 'maintainer_file_override',
341 'pseduo_maint_file')}) {
342 next unless defined $fn;
343 __add_to_hash($fn,$_maintainer,
349 my $b = $param{reverse}?$_maintainer_rev:$_maintainer;
350 for my $binary (make_list($param{binary})) {
351 if (not $param{reverse} and $binary =~ /^src:/) {
352 push @extra_source,$binary;
355 push @return,grep {defined $_} make_list($b->{$binary});
357 my $s = $param{reverse}?$_source_maintainer_rev:$_source_maintainer;
358 for my $source (make_list($param{source},@extra_source)) {
359 push @return,grep {defined $_} make_list($s->{$source});
364 #=head2 __add_to_hash
366 # __add_to_hash($file,$forward_hash,$reverse_hash,'address');
368 # Reads a maintainer/source maintainer/pseudo desc file and adds the
369 # maintainers from it to the forward and reverse hashref; assumes that
370 # the forward is unique; makes no assumptions of the reverse.
375 my ($fn,$forward,$reverse,$type) = @_;
376 if (ref($forward) ne 'HASH') {
377 croak "__add_to_hash must be passed a hashref for the forward";
379 if (defined $reverse and not ref($reverse) eq 'HASH') {
380 croak "if reverse is passed to __add_to_hash, it must be a hashref";
383 my $fh = IO::File->new($fn,'r') or
384 die "Unable to open $fn for reading: $!";
387 next unless m/^(\S+)\s+(\S.*\S)\s*$/;
388 my ($key,$value)=($1,$2);
390 $forward->{$key}= $value;
391 if (defined $reverse) {
392 if ($type eq 'address') {
393 for my $m (map {lc($_->address)} (getparsedaddrs($value))) {
394 push @{$reverse->{$m}},$key;
398 push @{$reverse->{$value}}, $key;
407 my $pseudopkgdesc = getpseudodesc(...);
409 Returns the entry for a pseudo package from the
410 $config{pseudo_desc_file}. In cases where pseudo_desc_file is not
411 defined, returns an empty arrayref.
413 This function can be used to see if a particular package is a
414 pseudopackage or not.
418 our $_pseudodesc = undef;
420 return $_pseudodesc if defined $_pseudodesc;
422 __add_to_hash($config{pseudo_desc_file},$_pseudodesc) if
423 defined $config{pseudo_desc_file};
430 my $english = secs_to_english($seconds);
431 my ($days,$english) = secs_to_english($seconds);
433 XXX This should probably be changed to use Date::Calc
440 my $days = int($seconds / 86400);
441 my $years = int($days / 365);
445 push @age, "1 year" if ($years == 1);
446 push @age, "$years years" if ($years > 1);
447 push @age, "1 day" if ($days == 1);
448 push @age, "$days days" if ($days > 1);
449 $result .= join(" and ", @age);
451 return wantarray?(int($seconds/86400),$result):$result;
457 These functions are exported with the :lock tag
463 FLOCKs the passed file. Use unfilelock to unlock it.
470 # NB - NOT COMPATIBLE WITH `with-lock'
472 if ($lockfile !~ m{^/}) {
473 $lockfile = cwd().'/'.$lockfile;
476 $count= 10; $errors= '';
479 my $fh2 = IO::File->new($lockfile,'w')
480 or die "Unable to open $lockfile for writing: $!";
481 flock($fh2,LOCK_EX|LOCK_NB)
482 or die "Unable to lock $lockfile $!";
489 push @filelocks, {fh => $fh, file => $lockfile};
494 die "failed to get lock on $lockfile -- $errors";
500 # clean up all outstanding locks at end time
512 Unlocks the file most recently locked.
514 Note that it is not currently possible to unlock a specific file
515 locked with filelock.
520 if (@filelocks == 0) {
521 warn "unfilelock called with no active filelocks!\n";
524 my %fl = %{pop(@filelocks)};
525 flock($fl{fh},LOCK_UN)
526 or warn "Unable to unlock lockfile $fl{file}: $!";
528 or warn "Unable to close lockfile $fl{file}: $!";
530 or warn "Unable to unlink lockfile $fl{file}: $!";
536 lockpid('/path/to/pidfile');
538 Creates a pidfile '/path/to/pidfile' if one doesn't exist or if the
539 pid in the file does not respond to kill 0.
541 Returns 1 on success, false on failure; dies on unusual errors.
548 my $pid = checkpid($pidfile);
549 die "Unable to read pidfile $pidfile: $!" if not defined $pid;
550 return 0 if $pid != 0;
552 die "Unable to unlink stale pidfile $pidfile $!";
554 my $pidfh = IO::File->new($pidfile,'w') or
555 die "Unable to open $pidfile for writing: $!";
556 print {$pidfh} $$ or die "Unable to write to $pidfile $!";
557 close $pidfh or die "Unable to close $pidfile $!";
563 checkpid('/path/to/pidfile');
565 Checks a pid file and determines if the process listed in the pidfile
566 is still running. Returns the pid if it is, 0 if it isn't running, and
567 undef if the pidfile doesn't exist or cannot be read.
574 my $pidfh = IO::File->new($pidfile, 'r') or
579 ($pid) = $pid =~ /(\d+)/;
580 if (defined $pid and kill(0,$pid)) {
593 These functions are exported with the :quit tag.
599 Exits the program by calling die.
601 Usage of quit is deprecated; just call die instead.
606 print {$DEBUG_FH} "quitting >$_[0]<\n" if $DEBUG;
607 carp "quit() is deprecated; call die directly instead";
613 These functions are exported with the :misc tag
617 LIST = make_list(@_);
619 Turns a scalar or an arrayref into a list; expands a list of arrayrefs
622 That is, make_list([qw(a b c)]); returns qw(a b c); make_list([qw(a
623 b)],[qw(c d)] returns qw(a b c d);
628 return map {(ref($_) eq 'ARRAY')?@{$_}:$_} @_;
634 print english_join(list => \@list);
635 print english_join(\@list);
637 Joins list properly to make an english phrase.
641 =item normal -- how to separate most values; defaults to ', '
643 =item last -- how to separate the last two values; defaults to ', and '
645 =item only_two -- how to separate only two values; defaults to ' and '
647 =item list -- ARRAYREF values to join; if the first argument is an
648 ARRAYREF, it's assumed to be the list of values to join
652 In cases where C<list> is empty, returns ''; when there is only one
653 element, returns that element.
658 if (ref $_[0] eq 'ARRAY') {
659 return english_join(list=>$_[0]);
661 my %param = validate_with(params => \@_,
662 spec => {normal => {type => SCALAR,
665 last => {type => SCALAR,
668 only_two => {type => SCALAR,
671 list => {type => ARRAYREF,
675 my @list = @{$param{list}};
677 return @list?$list[0]:'';
680 return join($param{only_two},@list);
682 my $ret = $param{last} . pop(@list);
683 return join($param{normal},@list) . $ret;
687 =head2 globify_scalar
689 my $handle = globify_scalar(\$foo);
691 if $foo isn't already a glob or a globref, turn it into one using
692 IO::Scalar. Gives a new handle to /dev/null if $foo isn't defined.
694 Will carp if given a scalar which isn't a scalarref or a glob (or
695 globref), and return /dev/null. May return undef if IO::Scalar or
696 IO::File fails. (Check $!)
703 if (defined $scalar) {
704 if (defined ref($scalar)) {
705 if (ref($scalar) eq 'SCALAR' and
706 not UNIVERSAL::isa($scalar,'GLOB')) {
707 return IO::Scalar->new($scalar);
713 elsif (UNIVERSAL::isa(\$scalar,'GLOB')) {
717 carp "Given a non-scalar reference, non-glob to globify_scalar; returning /dev/null handle";
720 return IO::File->new('/dev/null','w');
723 =head2 cleanup_eval_fail()
725 print "Something failed with: ".cleanup_eval_fail($@);
727 Does various bits of cleanup on the failure message from an eval (or
728 any other die message)
730 Takes at most two options; the first is the actual failure message
731 (usually $@ and defaults to $@), the second is the debug level
732 (defaults to $DEBUG).
734 If debug is non-zero, the code at which the failure occured is output.
738 sub cleanup_eval_fail {
739 my ($error,$debug) = @_;
740 if (not defined $error or not @_) {
741 $error = $@ // 'unknown reason';
744 $debug = $DEBUG // 0;
746 $debug = 0 if not defined $debug;
751 # ditch the "at foo/bar/baz.pm line 5"
752 $error =~ s/\sat\s\S+\sline\s\d+//;
753 # ditch trailing multiple periods in case there was a cascade of
755 $error =~ s/\.+$/\./;