]> git.deb.at Git - deb/packages.git/blobdiff - lib/Packages/Search.pm
Comment clean-up: Remove $Id$, fix FSF address, copyright years
[deb/packages.git] / lib / Packages / Search.pm
index d8d559a188929f0060f2416b81810dbafe477a53..ebb1b7d8f1e025ec4d5b48ab8b08877547e0126c 100644 (file)
@@ -1,8 +1,8 @@
 #
 # Packages::Search
 #
-# Copyright (C) 2004-2006 Frank Lichtenheld <frank@lichtenheld.de>
-# 
+# Copyright (C) 2004-2007 Frank Lichtenheld <frank@lichtenheld.de>
+#
 # The code is based on the old search_packages.pl script that
 # was:
 #
@@ -23,7 +23,7 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
-#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
 =head1 NAME
@@ -43,10 +43,11 @@ package Packages::Search;
 use strict;
 use warnings;
 
-#use CGI ();
 use POSIX;
 use HTML::Entities;
 use DB_File;
+use Lingua::Stem v0.82;
+use Search::Xapian qw(:ops);
 
 use Deb::Versions;
 use Packages::CGI;
@@ -56,288 +57,15 @@ our @ISA = qw( Exporter );
 
 our @EXPORT_OK = qw( read_entry read_entry_all read_entry_simple
                     read_src_entry read_src_entry_all find_binaries
-                    do_names_search do_fulltext_search
+                    do_names_search do_fulltext_search do_xapian_search
+                    find_similar
                     );
 our %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
 
 our $VERSION = 0.01;
 
-our $USE_PAGED_MODE = 1;
-use constant DEFAULT_PAGE => 1;
-use constant DEFAULT_RES_PER_PAGE => 50;
-our %page_params = ( page => { default => DEFAULT_PAGE,
-                               match => '(\d+)' },
-                     number => { default => DEFAULT_RES_PER_PAGE,
-                                 match => '(\d+)' } );
-
 our $too_many_hits = 0;
 
-sub parse_params {
-    my ( $cgi, $params_def, $opts ) = @_;
-
-    my %params_ret = ( values => {}, errors => {} );
-    my %params;
-    if ($USE_PAGED_MODE) {
-        debug( "Use PAGED_MODE", 2 ) if DEBUG;
-        %params = %$params_def;
-        foreach (keys %page_params) {
-            delete $params{$_};
-        }
-        %params = ( %params, %page_params );
-    } else {
-        %params = %$params_def;
-    }
-
-    foreach my $param ( keys %params ) {
-       
-       debug( "Param <strong>$param</strong>", 2 ) if DEBUG;
-
-       my $p_value_orig = $cgi->param($param);
-
-       if (!defined($p_value_orig)
-           && defined $params_def->{$param}{alias}
-           && defined $cgi->param($params_def->{$param}{alias})) {
-           $p_value_orig = $cgi->param($params_def->{$param}{alias});
-           debug( "Used alias <strong>$params_def->{$param}{alias}</strong>",
-                  2 );
-       }
-
-       my @p_value = ($p_value_orig);
-
-       debug( "Value (Orig) ".($p_value_orig||""), 2 ) if DEBUG;
-
-       if ($params_def->{$param}{array} && defined $p_value_orig) {
-           @p_value = split /$params_def->{$param}{array}/, $p_value_orig;
-           debug( "Value (Array Split) ". join('##',@p_value), 2 ) if DEBUG;
-       }
-
-       if ($params_def->{$param}{match} && defined $p_value_orig) {
-           @p_value = map
-           { $_ =~ m/$params_def->{$param}{match}/; $_ = $1 }
-           @p_value;
-       }
-       @p_value = grep { defined $_ } @p_value;
-
-       debug( "Value (Match) ". join('##',@p_value), 2 ) if DEBUG;
-
-       unless (@p_value) {
-           if (defined $params{$param}{default}) {
-               @p_value = ($params{$param}{default});
-           } else {
-               @p_value = undef;
-               $params_ret{errors}{$param} = "undef";
-               next;
-           }
-       }
-
-       debug( "Value (Default) ". join('##',@p_value), 2 ) if DEBUG;
-       my @p_value_no_replace = @p_value;
-
-       if ($params{$param}{replace} && @p_value) {
-           foreach my $pattern (keys %{$params{$param}{replace}}) {
-               my @p_value_tmp = @p_value;
-               @p_value = ();
-               foreach (@p_value_tmp) {
-                   if ($_ eq $pattern) {
-                       my $replacement = $params{$param}{replace}{$_};
-                       if (ref $replacement) {
-                           push @p_value, @$replacement;
-                       } else {
-                           push @p_value, $replacement;
-                       }
-                   } else {
-                       push @p_value, $_;
-                   }
-               }
-           }
-       }
-       
-       debug( "Value (Final) ". join('##',@p_value), 2 ) if DEBUG;
-
-       if ($params_def->{$param}{array}) {
-           $params_ret{values}{$param} = {
-               orig => $p_value_orig,
-               no_replace => \@p_value_no_replace,
-               final => \@p_value,
-           };
-           @{$params_def->{$param}{var}} = @p_value
-               if $params_def->{$param}{var};
-       } else {
-           $params_ret{values}{$param} = {
-               orig => $p_value_orig,
-               no_replace => $p_value_no_replace[0],
-               final => $p_value[0],
-           };
-           ${$params_def->{$param}{var}} = $p_value[0]
-               if $params_def->{$param}{var};
-       }
-       $opts->{$param} = $params_ret{values}{$param}{final} if $opts;
-    }
-
-    if ($USE_PAGED_MODE) {
-        $cgi->delete( "page" );
-        $cgi->delete( "number" );
-    }
-
-    return %params_ret;
-}
-
-sub start { 
-    my $params = shift;
-
-    my $page = $params->{values}{page}{final}
-    || DEFAULT_PAGE;
-    my $res_per_page = $params->{values}{number}{final}
-    || DEFAULT_RES_PER_PAGE;
-
-    return 1 if $res_per_page =~ /^all$/i;
-    return $res_per_page * ($page - 1) + 1;
-}
-
-sub end {
-    my $params = shift;
-
-    use Data::Dumper;
-    debug( "end: ".Dumper($params) ) if DEBUG;
-    my $page = $params->{page}
-    || DEFAULT_PAGE;
-    my $res_per_page = $params->{number}
-    || DEFAULT_RES_PER_PAGE;
-
-    return $page * $res_per_page;
-}
-
-sub indexline {
-    my ($cgi, $params, $num_res) = @_;
-
-    my $index_line = "";
-    my $page = $params->{page}
-    || DEFAULT_PAGE;
-    my $res_per_page = $params->{number}
-    || DEFAULT_RES_PER_PAGE;
-    my $numpages = ceil($num_res /
-                        $res_per_page);
-    for (my $i = 1; $i <= $numpages; $i++) {
-        if ($i == $page) {
-            $index_line .= $i;
-        } else {
-            $index_line .= "<a href=\"".encode_entities($cgi->self_url).
-                "&amp;page=$i&amp;number=$res_per_page\">".
-                "$i</a>";
-        }
-       if ($i < $numpages) {
-          $index_line .= " | ";
-       }
-    }
-    return $index_line;
-}
-
-sub nextlink {
-    my ($cgi, $params, $no_results ) = @_;
-
-    my $page = $params->{page}
-    || DEFAULT_PAGE;
-    $page++;
-    my $res_per_page = $params->{number}
-    || DEFAULT_RES_PER_PAGE;
-
-    if ((($page-1)*$res_per_page + 1) > $no_results) {
-        return "&gt;&gt;";
-    }
-
-    return "<a href=\"".encode_entities($cgi->self_url).
-        "&amp;page=$page&amp;number=$res_per_page\">&gt;&gt;</a>";
-}
-
-sub prevlink {
-    my ($cgi, $params ) = @_;
-
-    my $page = $params->{page}
-    || DEFAULT_PAGE;
-    $page--;
-    if (!$page) {
-        return "&lt;&lt;";
-    }
-
-    my $res_per_page = $params->{number}
-    || DEFAULT_RES_PER_PAGE;
-
-    return "<a href=\"".encode_entities($cgi->self_url).
-        "&amp;page=$page&amp;number=$res_per_page\">&lt;&lt;</a>";
-}
-
-sub resperpagelink {
-    my ($cgi, $params, $res_per_page ) = @_;
-
-    my $page;
-    if ($res_per_page =~ /^all$/i) {
-       $page = 1;
-    } else {
-       $page = ceil(start( $params ) / $res_per_page);
-    }
-
-    return "<a href=\"".encode_entities($cgi->self_url).
-        "&amp;page=$page&amp;number=$res_per_page\">$res_per_page</a>";
-}
-
-sub printindexline {
-    my ( $input, $no_results, $opts ) = @_;
-
-    my $index_line;
-    if ($no_results > $opts->{number}) {
-       
-       $index_line = prevlink( $input, $opts)." | ".
-           indexline( $input, $opts, $no_results)." | ".
-           nextlink( $input, $opts, $no_results);
-       
-       print "<p style=\"text-align:center\">$index_line</p>";
-    }
-}
-
-#sub multipageheader {
-#    my ( $input, $no_results, $opts ) = @_;
-#
-#    my ($start, $end);
-#    if ($opts->{number} =~ /^all$/i) {
-#      $start = 1;
-#      $end = $no_results;
-#      $opts->{number} = $no_results;
-#      $opts->{number_all}++;
-#    } else {
-#      $start = Packages::Search::start( $opts );
-#      $end = Packages::Search::end( $opts );
-#      if ($end > $no_results) { $end = $no_results; }
-#    }
-#
-#      print "<p>Found <em>$no_results</em> matching packages,";
-#    if ($end == $start) {
-#      print " displaying package $end.</p>";
-#    } else {
-#      print " displaying packages $start to $end.</p>";
-#    }
-#
-#    printindexline( $input, $no_results, $opts );
-#
-#    if ($no_results > 100) {
-#      print "<p>Results per page: ";
-#      my @resperpagelinks;
-#      for (50, 100, 200) {
-#          if ($opts->{number} == $_) {
-#              push @resperpagelinks, $_;
-#          } else {
-#              push @resperpagelinks, resperpagelink($input,$opts,$_);
-#          }
-#      }
-#      if ($opts->{number_all}) {
-#          push @resperpagelinks, "all";
-#      } else {
-#          push @resperpagelinks, resperpagelink($input, $opts, "all");
-#      }
-#      print join( " | ", @resperpagelinks )."</p>";
-#    }
-#    return ( $start, $end );
-#}
-
 sub read_entry_all {
     my ($hash, $key, $results, $non_results, $opts) = @_;
     my ($virt, $result) = split /\000/o, $hash->{$key} || "-\01-", 2;
@@ -354,7 +82,7 @@ sub read_entry_all {
        }
     }
 
-    foreach (split /\000/o, $result) {
+    foreach (split(/\000/o, $result||'')) {
        my @data = split ( /\s/o, $_, 8 );
        debug( "Considering entry ".join( ':', @data), 2) if DEBUG;
        if ($opts->{h_suites}{$data[1]}
@@ -372,6 +100,15 @@ sub read_entry {
     my @non_results;
     read_entry_all( $hash, $key, $results, \@non_results, $opts );
 }
+
+#FIXME: make configurable
+my %fallback_suites = (
+                      'oldstable-backports' => 'oldstable',
+                      'oldstable-volatile' => 'oldstable',
+                      'stable-backports' => 'stable',
+                      'stable-volatile' => 'stable',
+                      experimental => 'unstable' );
+
 sub read_entry_simple {
     my ($hash, $key, $archives, $suite) = @_;
     # FIXME: drop $archives
@@ -380,12 +117,22 @@ sub read_entry_simple {
     my %virt = split /\01/o, $virt; 
     debug( "read_entry_simple: key=$key, archives=".
           join(" ",(keys %$archives)).", suite=$suite", 1) if DEBUG;
+    debug( "read_entry_simple: virt=".join(" ",(%virt)), 2) if DEBUG;
+    # FIXME: not all of the 2^4=16 combinations of empty(results),
+    # empty(virt{suite}), empty(fb_result), empty(virt{fb_suite}) are dealt
+    # with correctly, but it's adequate enough for now
     return [ $virt{$suite} ] unless defined $result;
     foreach (split /\000/o, $result) {
        my @data = split ( /\s/o, $_, 8 );
        debug( "use entry: @data", 2 ) if DEBUG && $data[1] eq $suite;
        return [ $virt{$suite}, @data ] if $data[1] eq $suite;
     }
+    if (my $fb_suite = $fallback_suites{$suite}) {
+       my $fb_result = read_entry_simple( $hash, $key, $archives, $fb_suite );
+       my $fb_virt = shift(@$fb_result);
+       $virt{$suite} .= $virt{$suite} ? " $fb_virt" : $fb_virt if $fb_virt;
+       return [ $virt{$suite}, @$fb_result ] if @$fb_result;
+    }
     return [ $virt{$suite} ];
 }
 
@@ -412,23 +159,29 @@ sub read_src_entry {
     read_src_entry_all( $hash, $key, $results, \@non_results, $opts );
 }
 sub do_names_search {
-    my ($keyword, $packages, $postfixes, $read_entry, $opts,
+    my ($keywords, $packages, $postfixes, $read_entry, $opts,
        $results, $non_results) = @_;
 
-    $keyword = lc $keyword;
+    my $first_keyword = lc shift @$keywords;
+    @$keywords = map { lc $_ } @$keywords;
         
-    my ($key, $prefixes) = ($keyword, '');
+    my ($key, $prefixes) = ($first_keyword, '');
     my %pkgs;
     $postfixes->seq( $key, $prefixes, R_CURSOR );
-    while (index($key, $keyword) >= 0) {
+    while (index($key, $first_keyword) >= 0) {
        if ($prefixes =~ /^\001(\d+)/o) {
            debug( "$key has too many hits", 2 ) if DEBUG;
            $too_many_hits += $1;
        } else {
+         PREFIX:
            foreach (split /\000/o, $prefixes) {
                $_ = '' if $_ eq '^';
-               debug( "add word $_$key", 2) if DEBUG;
-               $pkgs{$_.$key}++;
+               my $word = "$_$key";
+               foreach my $k (@$keywords) {
+                   next PREFIX unless $word =~ /\Q$k\E/;
+               }
+               debug( "add word $word", 2) if DEBUG;
+               $pkgs{$word}++;
            }
        }
        last if $postfixes->seq( $key, $prefixes, R_NEXT ) != 0;
@@ -438,51 +191,99 @@ sub do_names_search {
     my $no_results = keys %pkgs;
     if ($too_many_hits || ($no_results >= 100)) {
        $too_many_hits += $no_results;
-       %pkgs = ( $keyword => 1 );
+       %pkgs = ( $first_keyword => 1 ) unless @$keywords;
     }
     foreach my $pkg (sort keys %pkgs) {
        &$read_entry( $packages, $pkg, $results, $non_results, $opts );
     }
 }
-sub do_fulltext_search {
-    my ($keyword, $file, $did2pkg, $packages, $read_entry, $opts,
+
+sub do_xapian_search {
+    my ($keywords, $dbpath, $did2pkg, $packages, $read_entry, $opts,
        $results, $non_results) = @_;
 
 # NOTE: this needs to correspond with parse-packages!
-    $keyword =~ tr [A-Z] [a-z];
-    if ($opts->{exact}) {
-       $keyword = " $keyword ";
+    my @tmp;
+    foreach my $keyword (@$keywords) {
+       $keyword =~ s;[^\w/+]+; ;og;
+       push @tmp, $keyword;
     }
-    $keyword =~ s/[(),.-]+//og;
-    $keyword =~ s#[^a-z0-9_/+]+# #og;
-
-    my $numres = 0;
-    my %tmp_results;
-    # fgrep is seriously faster than using perl
-    open DESC, '-|', 'fgrep', '-n', '--', $keyword, $file
-       or die "couldn't open $file: $!";
-    while (<DESC>) {
-       /^(\d+)/;
-       my $nr = $1;
-       debug( "Matched line $_", 2) if DEBUG;
-       my $result = $did2pkg->{$nr};
+    my $stemmer = Lingua::Stem->new();
+    my $stemmed_keywords = $stemmer->stem( @tmp );
+
+    my $db = Search::Xapian::Database->new( $dbpath );
+    my $enq = $db->enquire( OP_OR, @$keywords, @$stemmed_keywords );
+    debug( "Xapian Query was: ".$enq->get_query()->get_description(), 1) if DEBUG;
+    my @matches = $enq->matches(0, 999);
+
+    my (@order, %tmp_results);
+    foreach my $match ( @matches ) {
+       my $id = $match->get_docid();
+       my $result = $did2pkg->{$id};
+
        foreach (split /\000/o, $result) {
            my @data = split /\s/, $_, 3;
-#          debug ("Considering $data[0], arch = $data[2]", 3) if DEBUG;
+           debug ("Considering $data[0], arch = $data[2], relevance=".$match->get_percent(), 3) if DEBUG;
 #          next unless $data[2] eq 'all' || $opts->{h_archs}{$data[2]};
 #          debug ("Ok", 3) if DEBUG;
-           $numres++ unless $tmp_results{$data[0]}++;
+           unless ($tmp_results{$data[0]}++) {
+               push @order, $data[0];
+           }
        }
-       last if $numres > 100;
+       last if @order > 100;
     }
-    close DESC;
-    $too_many_hits++ if $numres > 100;
+    undef $db;
+    $too_many_hits++ if @order > 100;
 
-    my @results;
-    foreach my $pkg (keys %tmp_results) {
+    debug ("ORDER: @order", 2) if DEBUG;
+    foreach my $pkg (@order) {
        &$read_entry( $packages, $pkg, $results, $non_results, $opts );
     }
- }
+}
+
+sub find_similar {
+    my ($pkg, $dbpath, $did2pkg) = @_;
+
+    my $db = Search::Xapian::Database->new( $dbpath );
+    my $enq = $db->enquire( "P$pkg" );
+    debug( "Xapian Query was: ".$enq->get_query()->get_description(), 1) if DEBUG;
+    my $first_match = ($enq->matches(0,1))[0]->get_document();
+
+    my @terms;
+    my $term_it = $first_match->termlist_begin();
+    my $term_end = $first_match->termlist_end();
+
+    for (; $term_it ne $term_end; $term_it++) {
+       debug( "TERM: ".$term_it->get_termname(), 3);
+       push @terms, $term_it->get_termname();
+    }
+
+    my $rel_enq = $db->enquire( OP_OR, @terms );
+    debug( "Xapian Query was: ".$rel_enq->get_query()->get_description(), 1) if DEBUG;
+    my @rel_pkg = $rel_enq->matches(2,20);
+
+#    use Data::Dumper;
+#    debug(Dumper(\@rel_pkg),1);
+
+    my (@order, %tmp_results);
+    foreach my $match ( @rel_pkg ) {
+       my $id = $match->get_docid();
+       my $result = $did2pkg->{$id};
+
+       foreach (split /\000/o, $result) {
+           my @data = split /\s/, $_, 3;
+           debug ("Considering $data[0], arch = $data[2], relevance=".$match->get_percent(), 3) if DEBUG;
+           next if $data[0] eq $pkg;
+           unless ($tmp_results{$data[0]}++) {
+               push @order, $data[0];
+           }
+       }
+    }
+    undef $db;
+
+    debug ("ORDER: @order", 2) if DEBUG;
+    return @order[0..10];
+}
 
 sub find_binaries {
     my ($pkg, $archive, $suite, $src2bin) = @_;