Debbugs/Status.pm

   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.
   5 #
   6 # [Other people have contributed to this file; their copyrights should
   7 # go here too.]
   8 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
   9
  10 package Debbugs::Status;
  11
  12 =head1 NAME
  13
  14 Debbugs::Status -- Routines for dealing with summary and status files
  15
  16 =head1 SYNOPSIS
  17
  18 use Debbugs::Status;
  19
  20
  21 =head1 DESCRIPTION
  22
  23 This module is a replacement for the parts of errorlib.pl which write
  24 and read status and summary files.
  25
  26 It also contains generic routines for returning information about the
  27 status of a particular bug
  28
  29 =head1 FUNCTIONS
  30
  31 =cut
  32
  33 use warnings;
  34 use strict;
  35 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
  36 use base qw(Exporter);
  37
  38 use Params::Validate qw(validate_with :types);
  39 use Debbugs::Common qw(:util :lock :quit :misc);
  40 use Debbugs::Config qw(:config);
  41 use Debbugs::MIME qw(decode_rfc1522 encode_rfc1522);
  42 use Debbugs::Packages qw(makesourceversions getversions get_versions binarytosource);
  43 use Debbugs::Versions;
  44 use Debbugs::Versions::Dpkg;
  45 use POSIX qw(ceil);
  46
  47 use List::Util qw(min max);
  48
  49
  50 BEGIN{
  51      $VERSION = 1.00;
  52      $DEBUG = 0 unless defined $DEBUG;
  53
  54      @EXPORT = ();
  55      %EXPORT_TAGS = (status => [qw(splitpackages get_bug_status buggy bug_archiveable),
  56                                 qw(isstrongseverity bug_presence),
  57                                ],
  58                      read   => [qw(readbug read_bug lockreadbug lockreadbugmerge)],
  59                      write  => [qw(writebug makestatus unlockwritebug)],
  60                      versions => [qw(addfoundversions addfixedversions),
  61                                   qw(removefoundversions removefixedversions)
  62                                  ],
  63                      hook     => [qw(bughook bughook_archive)],
  64                     );
  65      @EXPORT_OK = ();
  66      Exporter::export_ok_tags(qw(status read write versions hook));
  67      $EXPORT_TAGS{all} = [@EXPORT_OK];
  68 }
  69
  70
  71 =head2 readbug
  72
  73      readbug($bug_num,$location)
  74      readbug($bug_num)
  75
  76 Reads a summary file from the archive given a bug number and a bug
  77 location. Valid locations are those understood by L</getbugcomponent>
  78
  79 =cut
  80
  81
  82 my %fields = (originator     => 'submitter',
  83               date           => 'date',
  84               subject        => 'subject',
  85               msgid          => 'message-id',
  86               'package'      => 'package',
  87               keywords       => 'tags',
  88               done           => 'done',
  89               forwarded      => 'forwarded-to',
  90               mergedwith     => 'merged-with',
  91               severity       => 'severity',
  92               owner          => 'owner',
  93               found_versions => 'found-in',
  94               found_date     => 'found-date',
  95               fixed_versions => 'fixed-in',
  96               fixed_date     => 'fixed-date',
  97               blocks         => 'blocks',
  98               blockedby      => 'blocked-by',
  99               unarchived     => 'unarchived',
 100              );
 101
 102 # Fields which need to be RFC1522-decoded in format versions earlier than 3.
 103 my @rfc1522_fields = qw(originator subject done forwarded owner);
 104
 105 sub readbug {
 106      return read_bug(bug => $_[0],
 107                      (@_ > 1)?(location => $_[1]):()
 108                     );
 109 }
 110
 111 =head2 read_bug
 112
 113      read_bug(bug => $bug_num,
 114               location => 'archive',
 115              );
 116      read_bug(summary => 'path/to/bugnum.summary');
 117      read_bug($bug_num);
 118
 119 A more complete function than readbug; it enables you to pass a full
 120 path to the summary file instead of the bug number and/or location.
 121
 122 =head3 Options
 123
 124 =over
 125
 126 =item bug -- the bug number
 127
 128 =item location -- optional location which is passed to getbugcomponent
 129
 130 =item summary -- complete path to the .summary file which will be read
 131
 132 =back
 133
 134 One of C<bug> or C<summary> must be passed. This function will return
 135 undef on failure, and will die if improper arguments are passed.
 136
 137 =cut
 138
 139 sub read_bug{
 140     if (@_ == 1) {
 141          unshift @_, 'bug';
 142     }
 143     my %param = validate_with(params => \@_,
 144                               spec   => {bug => {type => SCALAR,
 145                                                  optional => 1,
 146                                                  # something really
 147                                                  # stupid passes
 148                                                  # negative bugnumbers
 149                                                  regex    => qr/^-?\d+/,
 150                                                 },
 151                                          location => {type => SCALAR|UNDEF,
 152                                                       optional => 1,
 153                                                      },
 154                                          summary  => {type => SCALAR,
 155                                                       optional => 1,
 156                                                      },
 157                                         },
 158                              );
 159     die "One of bug or summary must be passed to read_bug"
 160          if not exists $param{bug} and not exists $param{summary};
 161     my $status;
 162     my $log;
 163     my $location;
 164     if (not defined $param{summary}) {
 165          my $lref;
 166          ($lref,$location) = @param{qw(bug location)};
 167          if (not defined $location) {
 168               $location = getbuglocation($lref,'summary');
 169               return undef if not defined $location;
 170          }
 171          $status = getbugcomponent($lref, 'summary', $location);
 172          $log    = getbugcomponent($lref, 'log'    , $location);
 173          return undef unless defined $status;
 174     }
 175     else {
 176          $status = $param{summary};
 177          $log = $status;
 178          $log =~ s/\.summary$/.log/;
 179          ($location) = $status =~ m/(db-h|db|archive)/;
 180     }
 181     my $status_fh = new IO::File $status, 'r' or
 182          warn "Unable to open $status for reading: $!" and return undef;
 183
 184     my %data;
 185     my @lines;
 186     my $version = 2;
 187     local $_;
 188
 189     while (<$status_fh>) {
 190         chomp;
 191         push @lines, $_;
 192         $version = $1 if /^Format-Version: ([0-9]+)/i;
 193     }
 194
 195     # Version 3 is the latest format version currently supported.
 196     return undef if $version > 3;
 197
 198     my %namemap = reverse %fields;
 199     for my $line (@lines) {
 200         if ($line =~ /(\S+?): (.*)/) {
 201             my ($name, $value) = (lc $1, $2);
 202             $data{$namemap{$name}} = $value if exists $namemap{$name};
 203         }
 204     }
 205     for my $field (keys %fields) {
 206         $data{$field} = '' unless exists $data{$field};
 207     }
 208
 209     $data{severity} = $config{default_severity} if $data{severity} eq '';
 210     for my $field (qw(found_versions fixed_versions found_date fixed_date)) {
 211          $data{$field} = [split ' ', $data{$field}];
 212     }
 213     for my $field (qw(found fixed)) {
 214          # create the found/fixed hashes which indicate when a
 215          # particular version was marked found or marked fixed.
 216          @{$data{$field}}{@{$data{"${field}_versions"}}} =
 217               (('') x (@{$data{"${field}_date"}} - @{$data{"${field}_versions"}}),
 218                @{$data{"${field}_date"}});
 219     }
 220
 221     if ($version < 3) {
 222         for my $field (@rfc1522_fields) {
 223             $data{$field} = decode_rfc1522($data{$field});
 224         }
 225     }
 226     # Add log last modified time
 227     $data{log_modified} = (stat($log))[9];
 228     $data{location} = $location;
 229
 230     return \%data;
 231 }
 232
 233 =head2 lockreadbug
 234
 235      lockreadbug($bug_num,$location)
 236
 237 Performs a filelock, then reads the bug; the bug is unlocked if the
 238 return is undefined, otherwise, you need to call unfilelock or
 239 unlockwritebug.
 240
 241 See readbug above for information on what this returns
 242
 243 =cut
 244
 245 sub lockreadbug {
 246     my ($lref, $location) = @_;
 247     &filelock("lock/$lref");
 248     my $data = read_bug(bug => $lref, location => $location);
 249     &unfilelock unless defined $data;
 250     return $data;
 251 }
 252
 253 =head2 lockreadbugmerge
 254
 255      my ($locks, $data) = lockreadbugmerge($bug_num,$location);
 256
 257 Performs a filelock, then reads the bug. If the bug is merged, locks
 258 the merge lock. Returns a list of the number of locks and the bug
 259 data.
 260
 261 =cut
 262
 263 sub lockreadbugmerge {
 264      my ($bug_num,$location) = @_;
 265      my $data = lockreadbug(@_);
 266      if (not defined $data) {
 267           return (0,undef);
 268      }
 269      if (not length $data->{mergedwith}) {
 270           return (1,$data);
 271      }
 272      unfilelock();
 273      filelock('lock/merge');
 274      $data = lockreadbug(@_);
 275      if (not defined $data) {
 276           unfilelock();
 277           return (0,undef);
 278      }
 279      return (2,$data);
 280 }
 281
 282
 283 my @v1fieldorder = qw(originator date subject msgid package
 284                       keywords done forwarded mergedwith severity);
 285
 286 =head2 makestatus
 287
 288      my $content = makestatus($status,$version)
 289      my $content = makestatus($status);
 290
 291 Creates the content for a status file based on the $status hashref
 292 passed.
 293
 294 Really only useful for writebug
 295
 296 Currently defaults to version 2 (non-encoded rfc1522 names) but will
 297 eventually default to version 3. If you care, you should specify a
 298 version.
 299
 300 =cut
 301
 302 sub makestatus {
 303     my ($data,$version) = @_;
 304     $version = 2 unless defined $version;
 305
 306     my $contents = '';
 307
 308     my %newdata = %$data;
 309     for my $field (qw(found fixed)) {
 310          if (exists $newdata{$field}) {
 311               $newdata{"${field}_date"} =
 312                    [map {$newdata{$field}{$_}||''} keys %{$newdata{$field}}];
 313          }
 314     }
 315
 316     for my $field (qw(found_versions fixed_versions found_date fixed_date)) {
 317          $newdata{$field} = join ' ', @{$newdata{$field}||[]};
 318     }
 319
 320     if ($version < 3) {
 321         for my $field (@rfc1522_fields) {
 322             $newdata{$field} = encode_rfc1522($newdata{$field});
 323         }
 324     }
 325
 326     if ($version == 1) {
 327         for my $field (@v1fieldorder) {
 328             if (exists $newdata{$field} and defined $newdata{$field}) {
 329                 $contents .= "$newdata{$field}\n";
 330             } else {
 331                 $contents .= "\n";
 332             }
 333         }
 334     } elsif ($version == 2 or $version == 3) {
 335         # Version 2 or 3. Add a file format version number for the sake of
 336         # further extensibility in the future.
 337         $contents .= "Format-Version: $version\n";
 338         for my $field (keys %fields) {
 339             if (exists $newdata{$field} and defined $newdata{$field}
 340                 and $newdata{$field} ne '') {
 341                 # Output field names in proper case, e.g. 'Merged-With'.
 342                 my $properfield = $fields{$field};
 343                 $properfield =~ s/(?:^|(?<=-))([a-z])/\u$1/g;
 344                 $contents .= "$properfield: $newdata{$field}\n";
 345             }
 346         }
 347     }
 348
 349     return $contents;
 350 }
 351
 352 =head2 writebug
 353
 354      writebug($bug_num,$status,$location,$minversion,$disablebughook)
 355
 356 Writes the bug status and summary files out.
 357
 358 Skips writting out a status file if minversion is 2
 359
 360 Does not call bughook if disablebughook is true.
 361
 362 =cut
 363
 364 sub writebug {
 365     my ($ref, $data, $location, $minversion, $disablebughook) = @_;
 366     my $change;
 367
 368     my %outputs = (1 => 'status', 2 => 'summary');
 369     for my $version (keys %outputs) {
 370         next if defined $minversion and $version < $minversion;
 371         my $status = getbugcomponent($ref, $outputs{$version}, $location);
 372         &quit("can't find location for $ref") unless defined $status;
 373         open(S,"> $status.new") || &quit("opening $status.new: $!");
 374         print(S makestatus($data, $version)) ||
 375             &quit("writing $status.new: $!");
 376         close(S) || &quit("closing $status.new: $!");
 377         if (-e $status) {
 378             $change = 'change';
 379         } else {
 380             $change = 'new';
 381         }
 382         rename("$status.new",$status) || &quit("installing new $status: $!");
 383     }
 384
 385     # $disablebughook is a bit of a hack to let format migration scripts use
 386     # this function rather than having to duplicate it themselves.
 387     &bughook($change,$ref,$data) unless $disablebughook;
 388 }
 389
 390 =head2 unlockwritebug
 391
 392      unlockwritebug($bug_num,$status,$location,$minversion,$disablebughook);
 393
 394 Writes a bug, then calls unfilelock; see writebug for what these
 395 options mean.
 396
 397 =cut
 398
 399 sub unlockwritebug {
 400     writebug(@_);
 401     &unfilelock;
 402 }
 403
 404 =head1 VERSIONS
 405
 406 The following functions are exported with the :versions tag
 407
 408 =head2 addfoundversions
 409
 410      addfoundversions($status,$package,$version,$isbinary);
 411
 412
 413
 414 =cut
 415
 416
 417 sub addfoundversions {
 418     my $data = shift;
 419     my $package = shift;
 420     my $version = shift;
 421     my $isbinary = shift;
 422     return unless defined $version;
 423     undef $package if $package =~ m[(?:\s|/)];
 424     my $source = $package;
 425
 426     if (defined $package and $isbinary) {
 427         my @srcinfo = binarytosource($package, $version, undef);
 428         if (@srcinfo) {
 429             # We know the source package(s). Use a fully-qualified version.
 430             addfoundversions($data, $_->[0], $_->[1], '') foreach @srcinfo;
 431             return;
 432         }
 433         # Otherwise, an unqualified version will have to do.
 434         undef $source;
 435     }
 436
 437     # Strip off various kinds of brain-damage.
 438     $version =~ s/;.*//;
 439     $version =~ s/ *\(.*\)//;
 440     $version =~ s/ +[A-Za-z].*//;
 441
 442     foreach my $ver (split /[,\s]+/, $version) {
 443         my $sver = defined($source) ? "$source/$ver" : '';
 444         unless (grep { $_ eq $ver or $_ eq $sver } @{$data->{found_versions}}) {
 445             push @{$data->{found_versions}}, defined($source) ? $sver : $ver;
 446         }
 447         @{$data->{fixed_versions}} =
 448             grep { $_ ne $ver and $_ ne $sver } @{$data->{fixed_versions}};
 449     }
 450 }
 451
 452 =head2 removefoundversions
 453
 454      removefoundversions($data,$package,$versiontoremove)
 455
 456 Removes found versions from $data
 457
 458 If a version is fully qualified (contains /) only versions matching
 459 exactly are removed. Otherwise, all versions matching the version
 460 number are removed.
 461
 462 Currently $package and $isbinary are entirely ignored, but accepted
 463 for backwards compatibilty.
 464
 465 =cut
 466
 467 sub removefoundversions {
 468     my $data = shift;
 469     my $package = shift;
 470     my $version = shift;
 471     my $isbinary = shift;
 472     return unless defined $version;
 473
 474     foreach my $ver (split /[,\s]+/, $version) {
 475          if ($ver =~ m{/}) {
 476               # fully qualified version
 477               @{$data->{found_versions}} =
 478                    grep {$_ ne $ver}
 479                         @{$data->{found_versions}};
 480          }
 481          else {
 482               # non qualified version; delete all matchers
 483               @{$data->{found_versions}} =
 484                    grep {$_ !~ m[(?:^|/)\Q$ver\E$]}
 485                         @{$data->{found_versions}};
 486          }
 487     }
 488 }
 489
 490
 491 sub addfixedversions {
 492     my $data = shift;
 493     my $package = shift;
 494     my $version = shift;
 495     my $isbinary = shift;
 496     return unless defined $version;
 497     undef $package if defined $package and $package =~ m[(?:\s|/)];
 498     my $source = $package;
 499
 500     if (defined $package and $isbinary) {
 501         my @srcinfo = binarytosource($package, $version, undef);
 502         if (@srcinfo) {
 503             # We know the source package(s). Use a fully-qualified version.
 504             addfixedversions($data, $_->[0], $_->[1], '') foreach @srcinfo;
 505             return;
 506         }
 507         # Otherwise, an unqualified version will have to do.
 508         undef $source;
 509     }
 510
 511     # Strip off various kinds of brain-damage.
 512     $version =~ s/;.*//;
 513     $version =~ s/ *\(.*\)//;
 514     $version =~ s/ +[A-Za-z].*//;
 515
 516     foreach my $ver (split /[,\s]+/, $version) {
 517         my $sver = defined($source) ? "$source/$ver" : '';
 518         unless (grep { $_ eq $ver or $_ eq $sver } @{$data->{fixed_versions}}) {
 519             push @{$data->{fixed_versions}}, defined($source) ? $sver : $ver;
 520         }
 521         @{$data->{found_versions}} =
 522             grep { $_ ne $ver and $_ ne $sver } @{$data->{found_versions}};
 523     }
 524 }
 525
 526 sub removefixedversions {
 527     my $data = shift;
 528     my $package = shift;
 529     my $version = shift;
 530     my $isbinary = shift;
 531     return unless defined $version;
 532
 533     foreach my $ver (split /[,\s]+/, $version) {
 534          if ($ver =~ m{/}) {
 535               # fully qualified version
 536               @{$data->{fixed_versions}} =
 537                    grep {$_ ne $ver}
 538                         @{$data->{fixed_versions}};
 539          }
 540          else {
 541               # non qualified version; delete all matchers
 542               @{$data->{fixed_versions}} =
 543                    grep {$_ !~ m[(?:^|/)\Q$ver\E$]}
 544                         @{$data->{fixed_versions}};
 545          }
 546     }
 547 }
 548
 549
 550
 551 =head2 splitpackages
 552
 553      splitpackages($pkgs)
 554
 555 Split a package string from the status file into a list of package names.
 556
 557 =cut
 558
 559 sub splitpackages {
 560     my $pkgs = shift;
 561     return unless defined $pkgs;
 562     return map lc, split /[ \t?,()]+/, $pkgs;
 563 }
 564
 565
 566 =head2 bug_archiveable
 567
 568      bug_archiveable(bug => $bug_num);
 569
 570 Options
 571
 572 =over
 573
 574 =item bug -- bug number (required)
 575
 576 =item status -- Status hashref returned by read_bug or get_bug_status (optional)
 577
 578 =item version -- Debbugs::Version information (optional)
 579
 580 =item days_until -- return days until the bug can be archived
 581
 582 =back
 583
 584 Returns 1 if the bug can be archived
 585 Returns 0 if the bug cannot be archived
 586
 587 If days_until is true, returns the number of days until the bug can be
 588 archived, -1 if it cannot be archived. 0 means that the bug can be
 589 archived the next time the archiver runs.
 590
 591 Returns undef on failure.
 592
 593 =cut
 594
 595 # This will eventually need to be fixed before we start using mod_perl
 596 our $version_cache = {};
 597 sub bug_archiveable{
 598      my %param = validate_with(params => \@_,
 599                                spec   => {bug => {type => SCALAR,
 600                                                   regex => qr/^\d+$/,
 601                                                  },
 602                                           status => {type => HASHREF,
 603                                                      optional => 1,
 604                                                     },
 605                                           days_until => {type => BOOLEAN,
 606                                                          default => 0,
 607                                                         },
 608                                           ignore_time => {type => BOOLEAN,
 609                                                           default => 0,
 610                                                          },
 611                                          },
 612                               );
 613      # This is what we return if the bug cannot be archived.
 614      my $cannot_archive = $param{days_until}?-1:0;
 615      # read the status information
 616      my $status = $param{status};
 617      if (not exists $param{status} or not defined $status) {
 618           $status = read_bug(bug=>$param{bug});
 619           return undef if not defined $status;
 620      }
 621      # Bugs can be archived if they are
 622      # 1. Closed
 623      return $cannot_archive if not defined $status->{done} or not length $status->{done};
 624      # If we just are checking if the bug can be archived, we'll not even bother
 625      # checking the versioning information if the bug has been -done for less than 28 days.
 626      my $log_file = getbugcomponent($param{bug},'log');
 627      if (not defined $log_file) {
 628           print STDERR "Cannot archive $param{bug} because the log doesn't exist\n" if $DEBUG;
 629           return $cannot_archive;
 630      }
 631      my $max_log_age = max(map {$config{remove_age} - -M $_}
 632                            $log_file, map {my $log = getbugcomponent($_,'log');
 633                                            defined $log ? ($log) : ();
 634                                       }
 635                            split / /, $status->{mergedwith}
 636                        );
 637      if (not $param{days_until} and not $param{ignore_time}
 638          and $max_log_age > 0
 639         ) {
 640           print STDERR "Cannot archive $param{bug} because of time\n" if $DEBUG;
 641           return $cannot_archive;
 642      }
 643      # At this point, we have to get the versioning information for this bug.
 644      # We examine the set of distribution tags. If a bug has no distribution
 645      # tags set, we assume a default set, otherwise we use the tags the bug
 646      # has set.
 647
 648      # In cases where we are assuming a default set, if the severity
 649      # is strong, we use the strong severity default; otherwise, we
 650      # use the normal default.
 651
 652      # There must be fixed_versions for us to look at the versioning
 653      # information
 654      my $min_fixed_time = time;
 655      my $min_archive_days = 0;
 656      if (@{$status->{fixed_versions}}) {
 657           my %dist_tags;
 658           @dist_tags{@{$config{removal_distribution_tags}}} =
 659                (1) x @{$config{removal_distribution_tags}};
 660           my %dists;
 661           for my $tag (split ' ', ($status->{tags}||'')) {
 662                next unless exists $config{distribution_aliases}{$tag};
 663                next unless $dist_tags{$config{distribution_aliases}{$tag}};
 664                $dists{$config{distribution_aliases}{$tag}} = 1;
 665           }
 666           if (not keys %dists) {
 667                if (isstrongseverity($status->{severity})) {
 668                     @dists{@{$config{removal_strong_severity_default_distribution_tags}}} =
 669                          (1) x @{$config{removal_strong_severity_default_distribution_tags}};
 670                }
 671                else {
 672                     @dists{@{$config{removal_default_distribution_tags}}} =
 673                          (1) x @{$config{removal_default_distribution_tags}};
 674                }
 675           }
 676           my %source_versions;
 677           my @sourceversions = get_versions(package => $status->{package},
 678                                             dist => [keys %dists],
 679                                             source => 1,
 680                                            );
 681           @source_versions{@sourceversions} = (1) x @sourceversions;
 682           # If the bug has not been fixed in the versions actually
 683           # distributed, then it cannot be archived.
 684           if ('found' eq max_buggy(bug => $param{bug},
 685                                    sourceversions => [keys %source_versions],
 686                                    found          => $status->{found_versions},
 687                                    fixed          => $status->{fixed_versions},
 688                                    version_cache  => $version_cache,
 689                                    package        => $status->{package},
 690                                   )) {
 691                print STDERR "Cannot archive $param{bug} because it's found\n" if $DEBUG;
 692                return $cannot_archive;
 693           }
 694           # Since the bug has at least been fixed in the architectures
 695           # that matters, we check to see how long it has been fixed.
 696
 697           # If $param{ignore_time}, then we should ignore time.
 698           if ($param{ignore_time}) {
 699                return $param{days_until}?0:1;
 700           }
 701
 702           # To do this, we order the times from most recent to oldest;
 703           # when we come to the first found version, we stop.
 704           # If we run out of versions, we only report the time of the
 705           # last one.
 706           my %time_versions = get_versions(package => $status->{package},
 707                                            dist    => [keys %dists],
 708                                            source  => 1,
 709                                            time    => 1,
 710                                           );
 711           for my $version (sort {$time_versions{$b} <=> $time_versions{$a}} keys %time_versions) {
 712                my $buggy = buggy(bug => $param{bug},
 713                                  version        => $version,
 714                                  found          => $status->{found_versions},
 715                                  fixed          => $status->{fixed_versions},
 716                                  version_cache  => $version_cache,
 717                                  package        => $status->{package},
 718                                 );
 719                last if $buggy eq 'found';
 720                $min_fixed_time = min($time_versions{$version},$min_fixed_time);
 721           }
 722           $min_archive_days = max($min_archive_days,ceil($config{remove_age} - (time - $min_fixed_time)/(60*60*24)));
 723      }
 724      # If $param{ignore_time}, then we should ignore time.
 725      if ($param{ignore_time}) {
 726           return $param{days_until}?0:1;
 727      }
 728      # 6. at least 28 days have passed since the last action has occured or the bug was closed
 729      my $age = ceil($max_log_age);
 730      if ($age > 0 or $min_archive_days > 0) {
 731           return $param{days_until}?max($age,$min_archive_days):0;
 732      }
 733      else {
 734           return $param{days_until}?0:1;
 735      }
 736 }
 737
 738
 739 =head2 get_bug_status
 740
 741      my $status = get_bug_status(bug => $nnn);
 742
 743      my $status = get_bug_status($bug_num)
 744
 745 =head3 Options
 746
 747 =over
 748
 749 =item bug -- scalar bug number
 750
 751 =item status -- optional hashref of bug status as returned by readbug
 752 (can be passed to avoid rereading the bug information)
 753
 754 =item bug_index -- optional tied index of bug status infomration;
 755 currently not correctly implemented.
 756
 757 =item version -- optional version(s) to check package status at
 758
 759 =item dist -- optional distribution(s) to check package status at
 760
 761 =item arch -- optional architecture(s) to check package status at
 762
 763 =item bugusertags -- optional hashref of bugusertags
 764
 765 =item sourceversion -- optional arrayref of source/version; overrides
 766 dist, arch, and version. [The entries in this array must be in the
 767 "source/version" format.] Eventually this can be used to for caching.
 768
 769 =back
 770
 771 Note: Currently the version information is cached; this needs to be
 772 changed before using this function in long lived programs.
 773
 774 =cut
 775
 776 sub get_bug_status {
 777      if (@_ == 1) {
 778           unshift @_, 'bug';
 779      }
 780      my %param = validate_with(params => \@_,
 781                                spec   => {bug       => {type => SCALAR,
 782                                                         regex => qr/^\d+$/,
 783                                                        },
 784                                           status    => {type => HASHREF,
 785                                                         optional => 1,
 786                                                        },
 787                                           bug_index => {type => OBJECT,
 788                                                         optional => 1,
 789                                                        },
 790                                           version   => {type => SCALAR|ARRAYREF,
 791                                                         optional => 1,
 792                                                        },
 793                                           dist       => {type => SCALAR|ARRAYREF,
 794                                                          optional => 1,
 795                                                         },
 796                                           arch       => {type => SCALAR|ARRAYREF,
 797                                                          optional => 1,
 798                                                         },
 799                                           bugusertags   => {type => HASHREF,
 800                                                             optional => 1,
 801                                                            },
 802                                           sourceversions => {type => ARRAYREF,
 803                                                              optional => 1,
 804                                                             },
 805                                          },
 806                               );
 807      my %status;
 808
 809      if (defined $param{bug_index} and
 810          exists $param{bug_index}{$param{bug}}) {
 811           %status = %{ $param{bug_index}{$param{bug}} };
 812           $status{pending} = $status{ status };
 813           $status{id} = $param{bug};
 814           return \%status;
 815      }
 816      if (defined $param{status}) {
 817           %status = %{$param{status}};
 818      }
 819      else {
 820           my $location = getbuglocation($param{bug}, 'summary');
 821           return {} if not defined $location or not length $location;
 822           %status = %{ readbug( $param{bug}, $location ) };
 823      }
 824      $status{id} = $param{bug};
 825
 826      if (defined $param{bugusertags}{$param{bug}}) {
 827           $status{keywords} = "" unless defined $status{keywords};
 828           $status{keywords} .= " " unless $status{keywords} eq "";
 829           $status{keywords} .= join(" ", @{$param{bugusertags}{$param{bug}}});
 830      }
 831      $status{tags} = $status{keywords};
 832      my %tags = map { $_ => 1 } split ' ', $status{tags};
 833
 834      $status{"package"} =~ s/\s*$//;
 835      $status{"package"} = 'unknown' if ($status{"package"} eq '');
 836      $status{"severity"} = 'normal' if ($status{"severity"} eq '');
 837
 838      $status{"pending"} = 'pending';
 839      $status{"pending"} = 'forwarded'       if (length($status{"forwarded"}));
 840      $status{"pending"} = 'pending-fixed'    if ($tags{pending});
 841      $status{"pending"} = 'fixed'           if ($tags{fixed});
 842
 843
 844      my $presence = bug_presence(map{(exists $param{$_})?($_,$param{$_}):()}
 845                                  qw(bug sourceversions arch dist version found fixed package)
 846                                 );
 847      if (defined $presence) {
 848           if ($presence eq 'fixed') {
 849                $status{pending} = 'done';
 850           }
 851           elsif ($presence eq 'absent') {
 852                $status{pending} = 'absent';
 853           }
 854      }
 855      return \%status;
 856 }
 857
 858 =head2 bug_presence
 859
 860      my $precence = bug_presence(bug => nnn,
 861                                  ...
 862                                 );
 863
 864 Returns 'found', 'absent', 'fixed' or undef based on whether the bug
 865 is found, absent, fixed, or no information is available in the
 866 distribution (dist) and/or architecture (arch) specified.
 867
 868
 869 =head3 Options
 870
 871 =over
 872
 873 =item bug -- scalar bug number
 874
 875 =item status -- optional hashref of bug status as returned by readbug
 876 (can be passed to avoid rereading the bug information)
 877
 878 =item bug_index -- optional tied index of bug status infomration;
 879 currently not correctly implemented.
 880
 881 =item version -- optional version to check package status at
 882
 883 =item dist -- optional distribution to check package status at
 884
 885 =item arch -- optional architecture to check package status at
 886
 887 =item sourceversion -- optional arrayref of source/version; overrides
 888 dist, arch, and version. [The entries in this array must be in the
 889 "source/version" format.] Eventually this can be used to for caching.
 890
 891 =back
 892
 893 =cut
 894
 895 sub bug_presence {
 896      my %param = validate_with(params => \@_,
 897                                spec   => {bug       => {type => SCALAR,
 898                                                         regex => qr/^\d+$/,
 899                                                        },
 900                                           status    => {type => HASHREF,
 901                                                         optional => 1,
 902                                                        },
 903                                           version   => {type => SCALAR|ARRAYREF,
 904                                                         optional => 1,
 905                                                        },
 906                                           dist       => {type => SCALAR|ARRAYREF,
 907                                                          optional => 1,
 908                                                         },
 909                                           arch       => {type => SCALAR|ARRAYREF,
 910                                                          optional => 1,
 911                                                         },
 912                                           sourceversions => {type => ARRAYREF,
 913                                                              optional => 1,
 914                                                             },
 915                                          },
 916                               );
 917      my %status;
 918      if (defined $param{status}) {
 919          %status = %{$param{status}};
 920      }
 921      else {
 922           my $location = getbuglocation($param{bug}, 'summary');
 923           return {} if not length $location;
 924           %status = %{ readbug( $param{bug}, $location ) };
 925      }
 926
 927      my @sourceversions;
 928      my $pseudo_desc = getpseudodesc();
 929      if (not exists $param{sourceversions}) {
 930           my %sourceversions;
 931           # pseudopackages do not have source versions by definition.
 932           if (exists $pseudo_desc->{$status{package}}) {
 933                # do nothing.
 934           }
 935           elsif (defined $param{version}) {
 936                foreach my $arch (make_list($param{arch})) {
 937                     for my $package (split /\s*,\s*/, $status{package}) {
 938                          my @temp = makesourceversions($package,
 939                                                        $arch,
 940                                                        make_list($param{version})
 941                                                       );
 942                          @sourceversions{@temp} = (1) x @temp;
 943                     }
 944                }
 945           } elsif (defined $param{dist}) {
 946                foreach my $arch (make_list($param{arch})) {
 947                     my @versions;
 948                     for my $package (split /\s*,\s*/, $status{package}) {
 949                          foreach my $dist (make_list($param{dist})) {
 950                               push @versions, getversions($package, $dist, $arch);
 951                          }
 952                          my @temp = makesourceversions($package,
 953                                                        $arch,
 954                                                        @versions
 955                                                       );
 956                          @sourceversions{@temp} = (1) x @temp;
 957                     }
 958                }
 959           }
 960
 961           # TODO: This should probably be handled further out for efficiency and
 962           # for more ease of distinguishing between pkg= and src= queries.
 963           # DLA: src= queries should just pass arch=source, and they'll be happy.
 964           @sourceversions = keys %sourceversions;
 965      }
 966      else {
 967           @sourceversions = @{$param{sourceversions}};
 968      }
 969      my $maxbuggy = 'undef';
 970      if (@sourceversions) {
 971           $maxbuggy = max_buggy(bug => $param{bug},
 972                                    sourceversions => \@sourceversions,
 973                                    found => $status{found_versions},
 974                                    fixed => $status{fixed_versions},
 975                                    package => $status{package},
 976                                    version_cache => $version_cache,
 977                                   );
 978      }
 979      elsif (defined $param{dist} and
 980             not exists $pseudo_desc->{$status{package}}) {
 981           return 'absent';
 982      }
 983      if (length($status{done}) and
 984          (not @sourceversions or not @{$status{fixed_versions}})) {
 985           return 'fixed';
 986      }
 987      return $maxbuggy;
 988 }
 989
 990
 991 =head2 max_buggy
 992
 993      max_buggy()
 994
 995 =head3 Options
 996
 997 =over
 998
 999 =item bug -- scalar bug number
1000
1001 =item sourceversion -- optional arrayref of source/version; overrides
1002 dist, arch, and version. [The entries in this array must be in the
1003 "source/version" format.] Eventually this can be used to for caching.
1004
1005 =back
1006
1007 Note: Currently the version information is cached; this needs to be
1008 changed before using this function in long lived programs.
1009
1010
1011 =cut
1012 sub max_buggy{
1013      my %param = validate_with(params => \@_,
1014                                spec   => {bug       => {type => SCALAR,
1015                                                         regex => qr/^\d+$/,
1016                                                        },
1017                                           sourceversions => {type => ARRAYREF,
1018                                                              default => [],
1019                                                             },
1020                                           found          => {type => ARRAYREF,
1021                                                              default => [],
1022                                                             },
1023                                           fixed          => {type => ARRAYREF,
1024                                                              default => [],
1025                                                             },
1026                                           package        => {type => SCALAR,
1027                                                             },
1028                                           version_cache  => {type => HASHREF,
1029                                                              default => {},
1030                                                             },
1031                                          },
1032                               );
1033      # Resolve bugginess states (we might be looking at multiple
1034      # architectures, say). Found wins, then fixed, then absent.
1035      my $maxbuggy = 'absent';
1036      for my $package (split /\s*,\s*/, $param{package}) {
1037           for my $version (@{$param{sourceversions}}) {
1038                my $buggy = buggy(bug => $param{bug},
1039                                  version => $version,
1040                                  found => $param{found},
1041                                  fixed => $param{fixed},
1042                                  version_cache => $param{version_cache},
1043                                  package => $package,
1044                                 );
1045                if ($buggy eq 'found') {
1046                     return 'found';
1047                } elsif ($buggy eq 'fixed') {
1048                     $maxbuggy = 'fixed';
1049                }
1050           }
1051      }
1052      return $maxbuggy;
1053 }
1054
1055
1056 =head2 buggy
1057
1058      buggy(bug => nnn,
1059            found => \@found,
1060            fixed => \@fixed,
1061            package => 'foo',
1062            version => '1.0',
1063           );
1064
1065 Returns the output of Debbugs::Versions::buggy for a particular
1066 package, version and found/fixed set. Automatically turns found, fixed
1067 and version into source/version strings.
1068
1069 Caching can be had by using the version_cache, but no attempt to check
1070 to see if the on disk information is more recent than the cache is
1071 made. [This will need to be fixed for long-lived processes.]
1072
1073 =cut
1074
1075 sub buggy {
1076      my %param = validate_with(params => \@_,
1077                                spec   => {bug => {type => SCALAR,
1078                                                   regex => qr/^\d+$/,
1079                                                  },
1080                                           found => {type => ARRAYREF,
1081                                                     default => [],
1082                                                    },
1083                                           fixed => {type => ARRAYREF,
1084                                                     default => [],
1085                                                    },
1086                                           version_cache => {type => HASHREF,
1087                                                             optional => 1,
1088                                                            },
1089                                           package => {type => SCALAR,
1090                                                      },
1091                                           version => {type => SCALAR,
1092                                                      },
1093                                          },
1094                               );
1095      my @found = @{$param{found}};
1096      my @fixed = @{$param{fixed}};
1097      if (grep {$_ !~ m{/}} (@{$param{found}}, @{$param{fixed}})) {
1098           # We have non-source version versions
1099           @found = makesourceversions($param{package},undef,
1100                                       @found
1101                                      );
1102           @fixed = makesourceversions($param{package},undef,
1103                                       @fixed
1104                                      );
1105      }
1106      if ($param{version} !~ m{/}) {
1107           my ($version) = makesourceversions($param{package},undef,
1108                                              $param{version}
1109                                             );
1110           $param{version} = $version if defined $version;
1111      }
1112      # Figure out which source packages we need
1113      my %sources;
1114      @sources{map {m{(.+)/}; $1} @found} = (1) x @found;
1115      @sources{map {m{(.+)/}; $1} @fixed} = (1) x @fixed;
1116      @sources{map {m{(.+)/}; $1} $param{version}} = 1 if
1117           $param{version} =~ m{/};
1118      my $version;
1119      if (not defined $param{version_cache} or
1120          not exists $param{version_cache}{join(',',sort keys %sources)}) {
1121           $version = Debbugs::Versions->new(\&Debbugs::Versions::Dpkg::vercmp);
1122           foreach my $source (keys %sources) {
1123                my $srchash = substr $source, 0, 1;
1124                my $version_fh = IO::File->new("$config{version_packages_dir}/$srchash/$source", 'r');
1125                if (not defined $version_fh) {
1126                     # We only want to warn if it's a package which actually has a maintainer
1127                     my $maints = getmaintainers();
1128                     next if not exists $maints->{$source};
1129                     warn "Bug $param{bug}: unable to open $config{version_packages_dir}/$srchash/$source: $!";
1130                     next;
1131                }
1132                $version->load($version_fh);
1133           }
1134           if (defined $param{version_cache}) {
1135                $param{version_cache}{join(',',sort keys %sources)} = $version;
1136           }
1137      }
1138      else {
1139           $version = $param{version_cache}{join(',',sort keys %sources)};
1140      }
1141      return $version->buggy($param{version},\@found,\@fixed);
1142 }
1143
1144 sub isstrongseverity {
1145     my $severity = shift;
1146     $severity = $config{default_severity} if
1147          not defined $severity or $severity eq '';
1148     return grep { $_ eq $severity } @{$config{strong_severities}};
1149 }
1150
1151
1152 =head1 PRIVATE FUNCTIONS
1153
1154 =cut
1155
1156 sub update_realtime {
1157         my ($file, %bugs) = @_;
1158
1159         # update realtime index.db
1160
1161         return () unless keys %bugs;
1162         my $idx_old = IO::File->new($file,'r')
1163              or die "Couldn't open ${file}: $!";
1164         my $idx_new = IO::File->new($file.'.new','w')
1165              or die "Couldn't open ${file}.new: $!";
1166
1167         my $min_bug = min(keys %bugs);
1168         my $line;
1169         my @line;
1170         my %changed_bugs;
1171         while($line = <$idx_old>) {
1172              @line = split /\s/, $line;
1173              # Two cases; replacing existing line or adding new line
1174              if (exists $bugs{$line[1]}) {
1175                   my $new = $bugs{$line[1]};
1176                   delete $bugs{$line[1]};
1177                   $min_bug = min(keys %bugs);
1178                   if ($new eq "NOCHANGE") {
1179                        print {$idx_new} $line;
1180                        $changed_bugs{$line[1]} = $line;
1181                   } elsif ($new eq "REMOVE") {
1182                        $changed_bugs{$line[1]} = $line;
1183                   } else {
1184                        print {$idx_new} $new;
1185                        $changed_bugs{$line[1]} = $line;
1186                   }
1187              }
1188              else {
1189                   while ($line[1] > $min_bug) {
1190                        print {$idx_new} $bugs{$min_bug};
1191                        delete $bugs{$min_bug};
1192                        last unless keys %bugs;
1193                        $min_bug = min(keys %bugs);
1194                   }
1195                   print {$idx_new} $line;
1196              }
1197              last unless keys %bugs;
1198         }
1199         print {$idx_new} map {$bugs{$_}} sort keys %bugs;
1200
1201         print {$idx_new} <$idx_old>;
1202
1203         close($idx_new);
1204         close($idx_old);
1205
1206         rename("$file.new", $file);
1207
1208         return %changed_bugs;
1209 }
1210
1211 sub bughook_archive {
1212         my @refs = @_;
1213         &filelock("debbugs.trace.lock");
1214         &appendfile("debbugs.trace","archive ".join(',',@refs)."\n");
1215         my %bugs = update_realtime("$config{spool_dir}/index.db.realtime",
1216                                    map{($_,'REMOVE')} @refs);
1217         update_realtime("$config{spool_dir}/index.archive.realtime",
1218                         %bugs);
1219         &unfilelock;
1220 }
1221
1222 sub bughook {
1223         my ( $type, %bugs_temp ) = @_;
1224         &filelock("debbugs.trace.lock");
1225
1226         my %bugs;
1227         for my $bug (keys %bugs_temp) {
1228              my $data = $bugs_temp{$bug};
1229              &appendfile("debbugs.trace","$type $bug\n",makestatus($data, 1));
1230
1231              my $whendone = "open";
1232              my $severity = $config{default_severity};
1233              (my $pkglist = $data->{package}) =~ s/[,\s]+/,/g;
1234              $pkglist =~ s/^,+//;
1235              $pkglist =~ s/,+$//;
1236              $whendone = "forwarded" if defined $data->{forwarded} and length $data->{forwarded};
1237              $whendone = "done" if defined $data->{done} and length $data->{done};
1238              $severity = $data->{severity} if length $data->{severity};
1239
1240              my $k = sprintf "%s %d %d %s [%s] %s %s\n",
1241                   $pkglist, $bug, $data->{date}, $whendone,
1242                        $data->{originator}, $severity, $data->{keywords};
1243              $bugs{$bug} = $k;
1244         }
1245         update_realtime("$config{spool_dir}/index.db.realtime", %bugs);
1246
1247         &unfilelock;
1248 }
1249
1250
1251 1;
1252
1253 __END__