]> git.deb.at Git - deb/packages.git/blobdiff - lib/Packages/Search.pm
Remove obsolete descriptions.txt previously used for fulltext search
[deb/packages.git] / lib / Packages / Search.pm
index 6ae7d9722173de7bf89aa99ab37b7259d1c36b06..671e3401c1f75fe7eadef8f82182e7a1cb2660ae 100644 (file)
@@ -43,10 +43,11 @@ package Packages::Search;
 use strict;
 use warnings;
 
-use CGI qw( -oldstyle_urls );
 use POSIX;
 use HTML::Entities;
 use DB_File;
+use Lingua::Stem v0.82;
+use Search::Xapian qw(:ops);
 
 use Deb::Versions;
 use Packages::CGI;
@@ -54,302 +55,39 @@ use Exporter;
 
 our @ISA = qw( Exporter );
 
-our @EXPORT_OK = qw( nextlink prevlink indexline
-                     resperpagelink
-                    read_entry read_entry_all read_entry_simple
+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
-                    printindexline multipageheader );
+                    do_names_search do_fulltext_search do_xapian_search
+                    );
 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 );
-        %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 );
-
-       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 ($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 ($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 );
-
-       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 );
-       my @p_value_no_replace = @p_value;
-
-       if ($params{$param}{replace} && @p_value) {
-           @p_value = ();
-           foreach my $pattern (keys %{$params{$param}{replace}}) {
-               foreach (@p_value_no_replace) {
-                   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 ($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) );
-    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";
+sub read_entry_all {
+    my ($hash, $key, $results, $non_results, $opts) = @_;
+    my ($virt, $result) = split /\000/o, $hash->{$key} || "-\01-", 2;
+
+    my %virt = split /\01/o, $virt;
+    while (my ($suite, $provides) = each %virt) {
+       next if $suite eq '-';
+       if ($opts->{h_suites}{$suite}) {
+           push @$results, [ $key, "-", $suite, 'virtual', 'v', 'v', 'v', 'v',
+                             $provides];
        } else {
-           push @resperpagelinks, resperpagelink($input, $opts, "all");
+           push @$non_results, [ $key, "-", $suite, 'virtual', 'v', 'v', 'v', 'v',
+                                 $provides];
        }
-       print join( " | ", @resperpagelinks )."</p>";
     }
-    return ( $start, $end );
-}
 
-sub read_entry_all {
-    my ($hash, $key, $results, $non_results, $opts) = @_;
-    my $result = $hash->{$key} || '';
     foreach (split /\000/o, $result) {
        my @data = split ( /\s/o, $_, 8 );
-       debug( "Considering entry ".join( ':', @data), 2);
-       if ($opts->{h_archives}{$data[0]} && $opts->{h_suites}{$data[1]}
-           && ($opts->{h_archs}{$data[2]} || $data[2] eq 'all'
-               || $data[2] eq 'virtual')
-           && ($opts->{h_sections}{$data[3]} || $data[3] eq 'v')) {
-           debug( "Using entry ".join( ':', @data), 2);
+       debug( "Considering entry ".join( ':', @data), 2) if DEBUG;
+       if ($opts->{h_suites}{$data[1]}
+           && ($opts->{h_archs}{$data[2]} || $data[2] eq 'all')
+           && $opts->{h_sections}{$data[3]}) {
+           debug( "Using entry ".join( ':', @data), 2) if DEBUG;
            push @$results, [ $key, @data ];
        } else {
            push @$non_results, [ $key, @data ];
@@ -361,35 +99,53 @@ 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) = @_;
-    my $result = $hash->{$key} || '';
-    my @data_fuzzy;
+    # FIXME: drop $archives
+
+    my ($virt, $result) = split /\000/o, $hash->{$key} || "-\01-\0", 2;
+    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( "Considering entry ".join( ':', @data), 2);
-       if ($data[1] eq $suite) {
-           if ($archives->{$data[0]}) {
-               debug( "Using entry ".join( ':', @data), 2);
-               return \@data;
-           } elsif ($data[0] eq 'us') {
-               debug( "Fuzzy entry ".join( ':', @data), 2);
-               @data_fuzzy = @data;
-           }
-       } 
+       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 \@data_fuzzy;
+    return [ $virt{$suite} ];
 }
+
 sub read_src_entry_all {
     my ($hash, $key, $results, $non_results, $opts) = @_;
     my $result = $hash->{$key} || '';
+    debug( "read_src_entry_all: key=$key", 1) if DEBUG;
     foreach (split /\000/o, $result) {
        my @data = split ( /\s/o, $_, 6 );
-       debug( "Considering entry ".join( ':', @data), 2);
+       debug( "Considering entry ".join( ':', @data), 2) if DEBUG;
        if ($opts->{h_archives}{$data[0]}
            && $opts->{h_suites}{$data[1]}
            && $opts->{h_sections}{$data[2]}) {
-           debug( "Using entry ".join( ':', @data), 2);
+           debug( "Using entry ".join( ':', @data), 2) if DEBUG;
            push @$results, [ $key, @data ];
        } else {
            push @$non_results, [ $key, @data ];
@@ -402,77 +158,89 @@ 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 @results;
+    my ($keywords, $packages, $postfixes, $read_entry, $opts,
+       $results, $non_results) = @_;
 
-    $keyword = lc $keyword unless $opts->{case_bool};
+    my $first_keyword = lc shift @$keywords;
+    @$keywords = map { lc $_ } @$keywords;
         
-    if ($opts->{exact}) {
-       &$read_entry( $packages, $keyword, \@results, $opts );
-    } else {
-       my ($key, $prefixes) = ($keyword, '');
-       my %pkgs;
-       $postfixes->seq( $key, $prefixes, R_CURSOR );
-       while (index($key, $keyword) >= 0) {
-            if ($prefixes =~ /^\001(\d+)/o) {
-                $too_many_hits += $1;
-            } else {
-               foreach (split /\000/o, $prefixes) {
-                   $_ = '' if $_ eq '^';
-                   debug( "add word $_$key", 2);
-                   $pkgs{$_.$key}++;
+    my ($key, $prefixes) = ($first_keyword, '');
+    my %pkgs;
+    $postfixes->seq( $key, $prefixes, R_CURSOR );
+    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 '^';
+               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;
-           last if $too_many_hits or keys %pkgs >= 100;
-       }
-        
-        my $no_results = keys %pkgs;
-        if ($too_many_hits || ($no_results >= 100)) {
-           $too_many_hits += $no_results;
-           %pkgs = ( $keyword => 1 );
-       }
-       foreach my $pkg (sort keys %pkgs) {
-           &$read_entry( $packages, $pkg, \@results, $opts );
        }
+       last if $postfixes->seq( $key, $prefixes, R_NEXT ) != 0;
+       last if $too_many_hits or keys %pkgs >= 100;
+    }
+    
+    my $no_results = keys %pkgs;
+    if ($too_many_hits || ($no_results >= 100)) {
+       $too_many_hits += $no_results;
+       %pkgs = ( $first_keyword => 1 ) unless @$keywords;
+    }
+    foreach my $pkg (sort keys %pkgs) {
+       &$read_entry( $packages, $pkg, $results, $non_results, $opts );
     }
-    return \@results;
 }
-sub do_fulltext_search {
-    my ($keyword, $file, $did2pkg, $packages, $read_entry, $opts) = @_;
-    my @results;
+
+sub do_xapian_search {
+    my ($keywords, $db, $did2pkg, $packages, $read_entry, $opts,
+       $results, $non_results) = @_;
 
 # NOTE: this needs to correspond with parse-packages!
-    my @lines;
-    $keyword =~ tr [A-Z] [a-z];
-    if ($opts->{exact}) {
-       $keyword = " $keyword ";
-    }
-    $keyword =~ s/[(),.-]+//og;
-    $keyword =~ s#[^a-z0-9_/+]+# #og;
-
-    open DESC, '<', "$file"
-       or die "couldn't open $file: $!";
-    while (<DESC>) {
-       next if index $_, $keyword < 0;
-       debug( "Matched line $.", 2);
-       push @lines, $.;
+    my @tmp;
+    foreach my $keyword (@$keywords) {
+       $keyword =~ tr [A-Z] [a-z];
+       if ($opts->{exact}) {
+           $keyword = " $keyword ";
+       }
+       $keyword =~ s/[(),.-]+//og;
+       $keyword =~ s;[^a-z0-9_/+]+; ;og;
+       push @tmp, $keyword;
     }
-    close DESC;
+    my $stemmer = Lingua::Stem->new();
+    $keywords = $stemmer->stem( @tmp );
+
+    my $db = Search::Xapian::Database->new( $db );
+    my $enq = $db->enquire( OP_AND, @$keywords );
+    debug( "Xapian Query was: ".$enq->get_query()->get_description(), 1) if DEBUG;
+    my @matches = $enq->matches(0, 100);
 
+    my $numres = 0;
     my %tmp_results;
-    foreach my $l (@lines) {
-       my $result = $did2pkg->{$l};
+    foreach my $match ( @matches ) {
+       my $id = $match->get_docid();
+       my $result = $did2pkg->{$id};
+
        foreach (split /\000/o, $result) {
            my @data = split /\s/, $_, 3;
-           next unless $opts->{h_archs}{$data[2]};
-           $tmp_results{$data[0]}++;
+#          debug ("Considering $data[0], arch = $data[2]", 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]}++;
        }
+       last if $numres > 100;
     }
+    undef $db;
+    $too_many_hits++ if $numres > 100;
+
     foreach my $pkg (keys %tmp_results) {
-       &$read_entry( $packages, $pkg, \@results, $opts );
+       &$read_entry( $packages, $pkg, $results, $non_results, $opts );
     }
-    return \@results;
 }
 
 sub find_binaries {
@@ -483,11 +251,11 @@ sub find_binaries {
     foreach (split /\000/o, $bins) {
        my @data = split /\s/, $_, 5;
 
-       debug( "find_binaries: considering @data", 3 );
+       debug( "find_binaries: considering @data", 3 ) if DEBUG;
        if (($data[0] eq $archive)
            && ($data[1] eq $suite)) {
            $bins{$data[2]}++;
-           debug( "find_binaries: using @data", 3 );
+           debug( "find_binaries: using @data", 3 ) if DEBUG;
        }
     }