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),
43 qw(getmaintainers_reverse),
46 misc => [qw(make_list globify_scalar english_join checkpid)],
47 date => [qw(secs_to_english)],
49 lock => [qw(filelock unfilelock lockpid)],
52 Exporter::export_ok_tags(qw(lock quit date util misc));
53 $EXPORT_TAGS{all} = [@EXPORT_OK];
56 #use Debbugs::Config qw(:globals);
60 use Debbugs::Config qw(:config);
63 use Debbugs::MIME qw(decode_rfc1522);
69 our $DEBUG_FH = \*STDERR if not defined $DEBUG_FH;
73 The following functions are exported by the C<:util> tag
75 =head2 getbugcomponent
77 my $file = getbugcomponent($bug_number,$extension,$location)
79 Returns the path to the bug file in location C<$location>, bug number
80 C<$bugnumber> and extension C<$extension>
85 my ($bugnum, $ext, $location) = @_;
87 if (not defined $location) {
88 $location = getbuglocation($bugnum, $ext);
89 # Default to non-archived bugs only for now; CGI scripts want
90 # archived bugs but most of the backend scripts don't. For now,
91 # anything that is prepared to accept archived bugs should call
92 # getbuglocation() directly first.
93 return undef if defined $location and
94 ($location ne 'db' and $location ne 'db-h');
96 my $dir = getlocationpath($location);
97 return undef if not defined $dir;
98 if (defined $location and $location eq 'db') {
99 return "$dir/$bugnum.$ext";
101 my $hash = get_hashname($bugnum);
102 return "$dir/$hash/$bugnum.$ext";
106 =head2 getbuglocation
108 getbuglocation($bug_number,$extension)
110 Returns the the location in which a particular bug exists; valid
111 locations returned currently are archive, db-h, or db. If the bug does
112 not exist, returns undef.
117 my ($bugnum, $ext) = @_;
118 my $archdir = get_hashname($bugnum);
119 return 'archive' if -r getlocationpath('archive')."/$archdir/$bugnum.$ext";
120 return 'db-h' if -r getlocationpath('db-h')."/$archdir/$bugnum.$ext";
121 return 'db' if -r getlocationpath('db')."/$bugnum.$ext";
126 =head2 getlocationpath
128 getlocationpath($location)
130 Returns the path to a specific location
134 sub getlocationpath {
136 if (defined $location and $location eq 'archive') {
137 return "$config{spool_dir}/archive";
138 } elsif (defined $location and $location eq 'db') {
139 return "$config{spool_dir}/db";
141 return "$config{spool_dir}/db-h";
150 Returns the hash of the bug which is the location within the archive
155 return "" if ( $_[ 0 ] < 0 );
156 return sprintf "%02d", $_[ 0 ] % 100;
163 Returns the path to the logfile corresponding to the bug.
165 Returns undef if the bug does not exist.
171 my $location = getbuglocation($bugnum, 'log');
172 return getbugcomponent($bugnum, 'log', $location) if ($location);
173 $location = getbuglocation($bugnum, 'log.gz');
174 return getbugcomponent($bugnum, 'log.gz', $location) if ($location);
181 appendfile($file,'data','to','append');
183 Opens a file for appending and writes data to it.
188 my ($file,@data) = @_;
189 my $fh = IO::File->new($file,'a') or
190 die "Unable top open $file for appending: $!";
191 print {$fh} @data or die "Unable to write to $file: $!";
192 close $fh or die "Unable to close $file: $!";
195 =head2 getparsedaddrs
197 my $address = getparsedaddrs($address);
198 my @address = getparsedaddrs($address);
200 Returns the output from Mail::Address->parse, or the cached output if
201 this address has been parsed before. In SCALAR context returns the
202 first address parsed.
210 return () unless defined $addr;
211 return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0]
212 if exists $_parsedaddrs{$addr};
214 # don't display the warnings from Mail::Address->parse
215 local $SIG{__WARN__} = sub { };
216 @{$_parsedaddrs{$addr}} = Mail::Address->parse($addr);
218 return wantarray?@{$_parsedaddrs{$addr}}:$_parsedaddrs{$addr}[0];
221 =head2 getmaintainers
223 my $maintainer = getmaintainers()->{debbugs}
225 Returns a hashref of package => maintainer pairs.
230 our $_maintainer_rev;
232 return $_maintainer if $_maintainer;
235 for my $file (@config{qw(maintainer_file maintainer_file_override pseduo_maint_file)}) {
236 next unless defined $file;
237 my $maintfile = IO::File->new($file,'r') or
238 die "Unable to open maintainer file $file: $!";
239 while(<$maintfile>) {
240 next unless m/^(\S+)\s+(\S.*\S)\s*$/;
244 for my $maint (map {lc($_->address)} getparsedaddrs($b)) {
245 push @{$maintainer_rev{$maint}},$a;
250 $_maintainer = \%maintainer;
251 $_maintainer_rev = \%maintainer_rev;
255 =head2 getmaintainers_reverse
257 my @packages = @{getmaintainers_reverse->{'don@debian.org'}||[]};
259 Returns a hashref of maintainer => [qw(list of packages)] pairs.
263 sub getmaintainers_reverse{
264 return $_maintainer_rev if $_maintainer_rev;
266 return $_maintainer_rev;
271 my $pseudopkgdesc = getpseudodesc(...);
273 Returns the entry for a pseudo package from the
274 $config{pseudo_desc_file}. In cases where pseudo_desc_file is not
275 defined, returns an empty arrayref.
277 This function can be used to see if a particular package is a
278 pseudopackage or not.
284 return $_pseudodesc if $_pseudodesc;
287 if (not defined $config{pseudo_desc_file}) {
291 my $pseudo = IO::File->new($config{pseudo_desc_file},'r')
292 or die "Unable to open $config{pseudo_desc_file}: $!";
294 next unless m/^(\S+)\s+(\S.*\S)\s*$/;
295 $pseudodesc{lc $1} = $2;
298 $_pseudodesc = \%pseudodesc;
305 my $english = secs_to_english($seconds);
306 my ($days,$english) = secs_to_english($seconds);
308 XXX This should probably be changed to use Date::Calc
315 my $days = int($seconds / 86400);
316 my $years = int($days / 365);
320 push @age, "1 year" if ($years == 1);
321 push @age, "$years years" if ($years > 1);
322 push @age, "1 day" if ($days == 1);
323 push @age, "$days days" if ($days > 1);
324 $result .= join(" and ", @age);
326 return wantarray?(int($seconds/86400),$result):$result;
332 These functions are exported with the :lock tag
338 FLOCKs the passed file. Use unfilelock to unlock it.
345 # NB - NOT COMPATIBLE WITH `with-lock'
347 if ($lockfile !~ m{^/}) {
348 $lockfile = cwd().'/'.$lockfile;
351 $count= 10; $errors= '';
354 my $fh2 = IO::File->new($lockfile,'w')
355 or die "Unable to open $lockfile for writing: $!";
356 flock($fh2,LOCK_EX|LOCK_NB)
357 or die "Unable to lock $lockfile $!";
364 push @filelocks, {fh => $fh, file => $lockfile};
369 die "failed to get lock on $lockfile -- $errors";
375 # clean up all outstanding locks at end time
387 Unlocks the file most recently locked.
389 Note that it is not currently possible to unlock a specific file
390 locked with filelock.
395 if (@filelocks == 0) {
396 warn "unfilelock called with no active filelocks!\n";
399 my %fl = %{pop(@filelocks)};
400 flock($fl{fh},LOCK_UN)
401 or warn "Unable to unlock lockfile $fl{file}: $!";
403 or warn "Unable to close lockfile $fl{file}: $!";
405 or warn "Unable to unlink lockfile $fl{file}: $!";
411 lockpid('/path/to/pidfile');
413 Creates a pidfile '/path/to/pidfile' if one doesn't exist or if the
414 pid in the file does not respond to kill 0.
416 Returns 1 on success, false on failure; dies on unusual errors.
423 my $pid = checkpid($pidfile);
424 die "Unable to read pidfile $pidfile: $!" if not defined $pid;
425 return 0 if $pid != 0;
427 die "Unable to unlink stale pidfile $pidfile $!";
429 my $pidfh = IO::File->new($pidfile,'w') or
430 die "Unable to open $pidfile for writing: $!";
431 print {$pidfh} $$ or die "Unable to write to $pidfile $!";
432 close $pidfh or die "Unable to close $pidfile $!";
438 checkpid('/path/to/pidfile');
440 Checks a pid file and determines if the process listed in the pidfile
441 is still running. Returns the pid if it is, 0 if it isn't running, and
442 undef if the pidfile doesn't exist or cannot be read.
449 my $pidfh = IO::File->new($pidfile, 'r') or
454 ($pid) = $pid =~ /(\d+)/;
455 if (defined $pid and kill(0,$pid)) {
468 These functions are exported with the :quit tag.
474 Exits the program by calling die.
476 Usage of quit is deprecated; just call die instead.
481 print {$DEBUG_FH} "quitting >$_[0]<\n" if $DEBUG;
482 carp "quit() is deprecated; call die directly instead";
488 These functions are exported with the :misc tag
492 LIST = make_list(@_);
494 Turns a scalar or an arrayref into a list; expands a list of arrayrefs
497 That is, make_list([qw(a b c)]); returns qw(a b c); make_list([qw(a
498 b)],[qw(c d)] returns qw(a b c d);
503 return map {(ref($_) eq 'ARRAY')?@{$_}:$_} @_;
509 print english_join(', ',' and ',@list);
511 Joins list properly to make an english phrase.
518 my ($normal,$last,@list) = @_;
520 return @list?$list[0]:'';
522 my $ret = $last . pop(@list);
523 $ret = join($normal,@list) . $ret;
528 =head2 globify_scalar
530 my $handle = globify_scalar(\$foo);
532 if $foo isn't already a glob or a globref, turn it into one using
533 IO::Scalar. Gives a new handle to /dev/null if $foo isn't defined.
535 Will carp if given a scalar which isn't a scalarref or a glob (or
536 globref), and return /dev/null. May return undef if IO::Scalar or
537 IO::File fails. (Check $!)
544 if (defined $scalar) {
545 if (defined ref($scalar)) {
546 if (ref($scalar) eq 'SCALAR' and
547 not UNIVERSAL::isa($scalar,'GLOB')) {
548 return IO::Scalar->new($scalar);
554 elsif (UNIVERSAL::isa(\$scalar,'GLOB')) {
558 carp "Given a non-scalar reference, non-glob to globify_scalar; returning /dev/null handle";
561 return IO::File->new('/dev/null','w');