allow more control over how words are picked out of text we're indexing
[bse.git] / site / cgi-bin / modules / BSE / Index / BSE.pm
1 package BSE::Index::BSE;
2 use strict;
3 use base 'BSE::Index::Base';
4 use BSE::DB;
5 use Constants qw($DATADIR $MAXPHRASE);
6
7 sub new {
8   my ($class, %opts) = @_;
9
10   my $self = bless \%opts, $class;
11
12   $self->{dh} = BSE::DB->single;
13   $self->{dropIndex} = $self->{dh}->stmt('dropIndex')
14     or die "No dropIndex member in BSE::DB";
15   $self->{insertIndex} = $self->{dh}->stmt('insertIndex')
16     or die "No insertIndex member in BSE::DB";
17   $self->{index} = {};
18
19   $self->{decay_multiplier} = 0.4;
20
21   $self->{wordre} = $self->{cfg}->entry("search", "wordre", "\\w+");
22
23   return $self;
24 }
25
26 sub start_index {
27   my $self = shift;
28
29   my $stopwords = "$DATADIR/stopwords.txt";
30
31   # load the stop words
32   open STOP, "< $stopwords"
33     or die "Cannot open $stopwords: $!";
34   chomp(my @stopwords = <STOP>);
35   tr/\r//d for @stopwords; # just in case
36   my %stopwords;
37   @stopwords{@stopwords} = (1) x @stopwords;
38   close STOP;
39   $self->{weights} = {};
40
41   return 1;
42 }
43
44 sub process_article {
45   my ($self, $article, $section, $indexas, $fields) = @_;
46
47   $self->{weights}{$indexas} ||= {};
48   for my $field (sort { $self->{scores}{$b} <=> $self->{scores}{$a} }
49                  keys %$fields) {
50     my $word_re = $self->{cfg}->entry("search", "wordre_$field", $self->{wordre});
51     my $text = $fields->{$field};
52     my $score = $self->{scores}{$field};
53     my %seen; # $seen{phrase} non-zero if seen for this field
54     
55     # for each paragraph
56     for my $para (split /\n/, $text) {
57       my @words;
58       while ($para =~ /($word_re)/g) {
59         push @words, $1;
60       }
61       my @buffer;
62       
63       for my $word (@words) {
64         if ($self->{stopwords}{lc $word}) {
65           $self->process($indexas, $section->{id}, $score, $self->{weights}{$indexas}, \%seen,
66                          @buffer) if @buffer;
67           @buffer = ();
68         }
69         else {
70           push(@buffer, $word);
71         }
72       }
73       $self->process($indexas, $section->{id}, $score, $self->{weights}{$indexas}, \%seen,
74                      @buffer) if @buffer;
75     }
76     if ($field eq 'product_code' && $text) {
77       $self->process($indexas, $section->{id}, $score, $self->{weights}{$indexas}, \%seen, $text);
78     }
79   }
80 }
81
82 sub process {
83   my ($self, $id, $sectionid, $score, $weights, $seen, @words) = @_;
84   
85   for (my $start = 0; $start < @words; ++$start) {
86     my $end = $start + $MAXPHRASE-1;
87     $end = $#words if $end > $#words;
88     
89     for my $phrase (map { "@words[$start..$_]" } $start..$end) {
90       if (lc $phrase ne $phrase && !$seen->{lc $phrase}++) {
91         if (exists $self->{index}{lc $phrase}{$id}) {
92           $weights->{lc $phrase} *= $self->{decay_multiplier};
93           $self->{index}{lc $phrase}{$id}[1] += 
94             $score * $weights->{lc $phrase};
95         }
96         else {
97           $weights->{lc $phrase} = 1.0;
98           $self->{index}{lc $phrase}{$id} = [ $sectionid, $score ];
99         }
100       }
101       if (!$seen->{$phrase}++) {
102         if (exists $self->{index}{$phrase}{$id}) {
103           $weights->{$phrase} *= $self->{decay_multiplier};
104           $self->{index}{$phrase}{$id}[1] += 
105             $score * $weights->{$phrase};
106         }
107         else {
108           $weights->{$phrase} = 1.0;
109           $self->{index}{$phrase}{$id} = [ $sectionid, $score ];
110         }
111       }
112     }
113   }
114 }
115
116 sub end_index {
117   my $self = shift;
118
119   $self->{dropIndex}->execute()
120     or die "dropIndex failed: ", $self->{dropindex}->errstr, "\n";
121
122   my $insertIndex = $self->{insertIndex};
123   for my $key (sort keys %{$self->{index}}) {
124     my $word = $self->{index}{$key};
125     # sort by reverse score so that if we overflow the field we
126     # get the highest scoring matches
127     my @ids = sort { $word->{$b}[1] <=> $word->{$a}[1] } keys %$word;
128     my @sections = map { $_->[0] } @$word{@ids};
129     my @scores = map { $_->[1] } @$word{@ids};
130     
131     $insertIndex->execute($key, "@ids", "@sections", "@scores")
132       or die "Cannot insert into index: ", $insertIndex->errstr;
133   }
134 }
135
136 1;