]> git.donarmstrong.com Git - debbugs.git/blobdiff - Debbugs/Bugs.pm
properly use array ref
[debbugs.git] / Debbugs / Bugs.pm
index ac6c719447e5b0a3ada0d43b689bbe594f46b4a4..8162bd301b846d9f7cc5eb2ae7f26307bfecc7e7 100644 (file)
@@ -38,7 +38,7 @@ incomplete) to slowest (and most complete).]
 use warnings;
 use strict;
 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
-use base qw(Exporter);
+use Exporter qw(import);
 
 BEGIN{
      $VERSION = 1.00;
@@ -54,8 +54,8 @@ use Debbugs::Config qw(:config);
 use Params::Validate qw(validate_with :types);
 use IO::File;
 use Debbugs::Status qw(splitpackages get_bug_status);
-use Debbugs::Packages qw(getsrcpkgs);
-use Debbugs::Common qw(getparsedaddrs getmaintainers getmaintainers_reverse make_list);
+use Debbugs::Packages qw(getsrcpkgs getpkgsrc);
+use Debbugs::Common qw(getparsedaddrs package_maintainer getmaintainers make_list hash_slice);
 use Fcntl qw(O_RDONLY);
 use MLDBM qw(DB_File Storable);
 use List::Util qw(first);
@@ -152,55 +152,65 @@ bug should not.
 
 =cut
 
+my $_non_search_key_regex = qr/^(bugs|archive|usertags|schema)$/;
+
+my %_get_bugs_common_options =
+    (package   => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     src       => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     maint     => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     submitter => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     severity  => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     status    => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     tag       => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     owner     => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     dist      => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     correspondent => {type => SCALAR|ARRAYREF,
+                       optional => 1,
+                      },
+     affects   => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     function  => {type => CODEREF,
+                   optional => 1,
+                  },
+     bugs      => {type => SCALAR|ARRAYREF,
+                   optional => 1,
+                  },
+     archive   => {type => BOOLEAN|SCALAR,
+                   default => 0,
+                  },
+     usertags  => {type => HASHREF,
+                   optional => 1,
+                  },
+     schema => {type     => OBJECT,
+                optional => 1,
+               },
+    );
+
+
+my $_get_bugs_options = {%_get_bugs_common_options};
 sub get_bugs{
      my %param = validate_with(params => \@_,
-                              spec   => {package   => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         src       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         maint     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         submitter => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         severity  => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         status    => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         tag       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         owner     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         dist      => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         correspondent => {type => SCALAR|ARRAYREF,
-                                                           optional => 1,
-                                                          },
-                                         affects   => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         function  => {type => CODEREF,
-                                                       optional => 1,
-                                                      },
-                                         bugs      => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         archive   => {type => BOOLEAN|SCALAR,
-                                                       default => 0,
-                                                      },
-                                         usertags  => {type => HASHREF,
-                                                       optional => 1,
-                                                      },
-                                        },
-                             );
+                              spec   => $_get_bugs_options,
+                              );
 
      # Normalize options
      my %options = %param;
@@ -213,7 +223,7 @@ sub get_bugs{
          return keys %bugs;
      }
      # A configuration option will set an array that we'll use here instead.
-     for my $routine (qw(Debbugs::Bugs::get_bugs_by_idx Debbugs::Bugs::get_bugs_flatfile)) {
+     for my $routine (qw(Debbugs::Bugs::get_bugs_by_db Debbugs::Bugs::get_bugs_by_idx Debbugs::Bugs::get_bugs_flatfile)) {
          my ($package) = $routine =~ m/^(.+)\:\:/;
          eval "use $package;";
          if ($@) {
@@ -325,7 +335,7 @@ sub bug_filter {
                                                          optional => 1,
                                                         },
                                          repeat_merged => {type => BOOLEAN,
-                                                           optional => 1,
+                                                           default => 1,
                                                           },
                                          include => {type => HASHREF,
                                                      optional => 1,
@@ -388,45 +398,17 @@ searches.
 
 =cut
 
+
+my $_get_bugs_by_idx_options =
+   {hash_slice(%_get_bugs_common_options,
+               (qw(package submitter severity tag archive),
+                qw(owner src maint bugs correspondent),
+                qw(affects usertags))
+              )
+   };
 sub get_bugs_by_idx{
      my %param = validate_with(params => \@_,
-                              spec   => {package   => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         submitter => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         severity  => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         tag       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         archive   => {type => BOOLEAN,
-                                                       default => 0,
-                                                      },
-                                         owner     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         src       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         maint     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         bugs      => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         correspondent => {type => SCALAR|ARRAYREF,
-                                                           optional => 1,
-                                                          },
-                                         affects => {type => SCALAR|ARRAYREF,
-                                                     optional => 1,
-                                                    },
-                                         usertags  => {type => HASHREF,
-                                                       optional => 1,
-                                                      },
-                                        },
+                              spec   => $_get_bugs_by_idx_options
                              );
      my %bugs = ();
 
@@ -450,11 +432,11 @@ sub get_bugs_by_idx{
          delete @param{qw(maint src)};
          $param{package} = [@packages];
      }
-     my $keys = grep {$_ !~ /^(archive|usertags|bugs)$/} keys(%param);
+     my $keys = grep {$_ !~ $_non_search_key_regex} keys(%param);
      die "Need at least 1 key to search by" unless $keys;
      my $arc = $param{archive} ? '-arc':'';
      my %idx;
-     for my $key (grep {$_ !~ /^(archive|usertags|bugs)$/} keys %param) {
+     for my $key (grep {$_ !~ $_non_search_key_regex} keys %param) {
          my $index = $key;
          $index = 'submitter-email' if $key eq 'submitter';
          $index = "$config{spool_dir}/by-${index}${arc}.idx";
@@ -497,6 +479,115 @@ sub get_bugs_by_idx{
 }
 
 
+=head2 get_bugs_by_db
+
+This routine uses the database to try to speed up
+searches.
+
+
+=cut
+
+my $_get_bugs_by_db_options =
+   {hash_slice(%_get_bugs_common_options,
+               (qw(package submitter severity tag archive),
+                qw(owner src maint bugs correspondent),
+                qw(affects usertags))
+              ),
+    schema => {type     => OBJECT,
+              },
+   };
+sub get_bugs_by_db{
+     my %param = validate_with(params => \@_,
+                              spec   => $_get_bugs_by_db_options,
+                              );
+     my %bugs = ();
+
+     # If we're given an empty maint (unmaintained packages), we can't
+     # handle it, so bail out here
+     for my $maint (make_list(exists $param{maint}?$param{maint}:[])) {
+         if (defined $maint and $maint eq '') {
+              die "Can't handle empty maint (unmaintained packages) in get_bugs_by_db";
+         }
+     }
+
+     # We handle src packages, maint and maintenc by mapping to the
+     # appropriate binary packages, then removing all packages which
+     # don't match all queries
+     my @packages = __handle_pkg_src_and_maint(map {exists $param{$_}?($_,$param{$_}):()}
+                                              qw(package src maint)
+                                             );
+     if (exists $param{package} or
+        exists $param{src} or
+        exists $param{maint}) {
+         delete @param{qw(maint src)};
+         $param{package} = [@packages];
+     }
+     my $keys = grep {$_ !~ $_non_search_key_regex} keys(%param);
+     die "Need at least 1 key to search by" unless $keys;
+     my $rs = $param{schema}->resultset('Bug');
+     if (exists $param{severity}) {
+         $rs = $rs->search([map {('severity.severity' => $_)} make_list($param{severity})],
+                          {join => 'severity'},
+                          );
+     }
+     for my $key (qw(owner submitter done)) {
+         if (exists $param{$key}) {
+             $rs = $rs->search([map {("${key}.addr" => $_)} make_list($param{$key})],
+                              {join => $key},
+                              );
+         }
+     }
+     if (exists $param{correspondent}) {
+         $rs = $rs->search([map {('message_correspondents.addr' => $_)} make_list($param{correspondent})],
+                          {join => {correspondent =>
+                                   {bug_messages =>
+                                   {message => 'message_correspondents'}}}},
+                          );
+     }
+     if (exists $param{affects}) {
+         $rs = $rs->search([map {('bin_pkg.pkg' => $_)} make_list($param{affects}),
+                            map {('src_pkg.pkg' => $_)} make_list($param{affects}),
+                           ],
+                          {join => [{bug_affects_binpackages => 'bin_pkg'},
+                                   {bug_affects_srcpackages => 'src_pkg'},
+                                   ],
+                          },
+                          );
+     }
+     if (exists $param{package}) {
+         $rs = $rs->search([map {('bin_pkg.pkg' => $_)} make_list($param{package})],
+                          {join => {bug_binpackages => 'bin_pkg'}});
+     }
+     if (exists $param{src}) {
+         $rs = $rs->search([map {('src_pkg.pkg' => $_)} make_list($param{src})],
+                          {join => {bug_srcpackages => 'src_pkg'}});
+     }
+     # tags are very odd, because we must handle usertags.
+     if (exists $param{tag}) {
+         # bugs from usertags which matter
+         my %bugs_matching_usertags;
+         for my $bug (make_list(grep {defined $_ } @{$param{usertags}}{make_list($param{tag})})) {
+             $bugs_matching_usertags{$bug} = 1;
+         }
+         # we want all bugs which either match the tag name given in
+         # param, or have a usertag set which matches one of the tag
+         # names given in param.
+         $rs = $rs->search([map {('tag.tag' => $_)} make_list($param{tag}),
+                            map {('me.id' => $_)} keys %bugs_matching_usertags
+                           ],
+                          {join => {bug_tags => 'tag'}});
+     }
+     if (exists $param{bugs}) {
+         $rs = $rs->search([map {('me.id' => $_)} make_list($param{bugs})]);
+     }
+     # handle archive
+     if (defined $param{archive} and $param{archive} ne 'both') {
+         $rs = $rs->search({'me.archived' => $param{archive}})
+     }
+     return $rs->get_column('id')->all();
+}
+
+
 =head2 get_bugs_flatfile
 
 This is the fallback search routine. It should be able to complete all
@@ -504,55 +595,15 @@ searches. [Or at least, that's the idea.]
 
 =cut
 
+my $_get_bugs_flatfile_options =
+   {hash_slice(%_get_bugs_common_options,
+               map {$_ eq 'dist'?():($_)} keys %_get_bugs_common_options
+              )
+   };
+
 sub get_bugs_flatfile{
      my %param = validate_with(params => \@_,
-                              spec   => {package   => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         src       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         maint     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         submitter => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         severity  => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         status    => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         tag       => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         owner     => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         correspondent => {type => SCALAR|ARRAYREF,
-                                                           optional => 1,
-                                                          },
-                                         affects   => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-# not yet supported
-#                                        dist      => {type => SCALAR|ARRAYREF,
-#                                                      optional => 1,
-#                                                     },
-                                         bugs      => {type => SCALAR|ARRAYREF,
-                                                       optional => 1,
-                                                      },
-                                         archive   => {type => BOOLEAN,
-                                                       default => 1,
-                                                      },
-                                         usertags  => {type => HASHREF,
-                                                       optional => 1,
-                                                      },
-                                         function  => {type => CODEREF,
-                                                       optional => 1,
-                                                      },
-                                        },
+                              spec   => $_get_bugs_flatfile_options
                              );
      my $flatfile;
      if ($param{archive}) {
@@ -572,20 +623,27 @@ sub get_bugs_flatfile{
      }
      my $unmaintained_packages = 0;
      # unmaintained packages is a special case
-     for my $maint (make_list(exists $param{maint}?$param{maint}:[])) {
+     my @maints = make_list(exists $param{maint}?$param{maint}:[]);
+     $param{maint} = [];
+     for my $maint (@maints) {
          if (defined $maint and $maint eq '' and not $unmaintained_packages) {
               $unmaintained_packages = 1;
               our %maintainers = %{getmaintainers()};
-              $param{function} = [exists $param{function}?
-                                  (ref $param{function}?@{$param{function}}:$param{function}):(),
+              $param{function} = [(exists $param{function}?
+                                   (ref $param{function}?@{$param{function}}:$param{function}):()),
                                   sub {my %d=@_;
-                                       foreach my $try (splitpackages($d{"pkg"})) {
+                                       foreach my $try (make_list($d{"pkg"})) {
+                                            next unless length $try;
+                                            ($try) = $try =~ m/^(?:src:)?(.+)/;
                                             return 1 if not exists $maintainers{$try};
                                        }
                                        return 0;
                                   }
                                  ];
          }
+         elsif (defined $maint and $maint ne '') {
+              push @{$param{maint}},$maint;
+         }
      }
      # We handle src packages, maint and maintenc by mapping to the
      # appropriate binary packages, then removing all packages which
@@ -616,7 +674,7 @@ sub get_bugs_flatfile{
      }
      my @bugs;
      BUG: while (<$flatfile>) {
-         next unless m/^(\S+)\s+(\d+)\s+(\d+)\s+(\S+)\s+\[\s*([^]]*)\s*\]\s+(\w+)\s+(.*)$/;
+         next unless m/^(\S+)\s+(\d+)\s+(\d+)\s+(\S+)\s+\[\s*(.*)\s*\]\s+(\w+)\s+(.*)$/;
          my ($pkg,$bug,$time,$status,$submitter,$severity,$tags) = ($1,$2,$3,$4,$5,$6,$7);
          next if $grep_bugs and not exists $bugs{$bug};
          if (exists $param{package}) {
@@ -735,10 +793,8 @@ sub __handle_pkg_src_and_maint{
      }
      if (exists $param{maint}) {
          my $key_inc = 0;
-         my $maint_rev = getmaintainers_reverse();
          my %_temp_p = ();
-         for my $package (map { exists $maint_rev->{$_}?@{$maint_rev->{$_}}:()}
-                          make_list($param{maint})) {
+         for my $package (package_maintainer(maintainer=>$param{maint})) {
               $packages{$package}++ unless exists $_temp_p{$package};
               $_temp_p{$package} = 1;
               $key_inc = 1;
@@ -770,7 +826,11 @@ sub __bug_matches {
     my ($hash, $status) = @_;
     foreach my $key( keys( %$hash ) ) {
         my $value = $hash->{$key};
+       next unless exists $field_match{$key};
        my $sub = $field_match{$key};
+       if (not defined $sub) {
+           die "No defined subroutine for key: $key";
+       }
        return 1 if ($sub->($key, $value, $status));
     }
     return 0;