5e1d98a7248a643d438bfb88086c3ac2d906df5a
[ikiwiki.git] / IkiWiki / Plugin / search.pm
1 #!/usr/bin/perl
2 # xapian-omega search engine plugin
3 package IkiWiki::Plugin::search;
4
5 use warnings;
6 use strict;
7 use IkiWiki 2.00;
8
9 sub import { #{{{
10         hook(type => "checkconfig", id => "search", call => \&checkconfig);
11         hook(type => "pagetemplate", id => "search", call => \&pagetemplate);
12         hook(type => "sanitize", id => "search", call => \&index);
13         hook(type => "delete", id => "search", call => \&delete);
14         hook(type => "cgi", id => "search", call => \&cgi);
15 } # }}}
16
17 sub checkconfig () { #{{{
18         foreach my $required (qw(url cgiurl)) {
19                 if (! length $config{$required}) {
20                         error(sprintf(gettext("Must specify %s when using the search plugin"), $required));
21                 }
22         }
23
24         if (! exists $config{omega_cgi}) {
25                 $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
26         }
27         
28         if (! -e $config{wikistatedir}."/xapian" || $config{rebuild}) {
29                 writefile("omega.conf", $config{wikistatedir}."/xapian",
30                         "database_dir .\n".
31                         "template_dir ./templates\n");
32                 writefile("query", $config{wikistatedir}."/xapian/templates",
33                         IkiWiki::misctemplate(gettext("search"),
34                                 readfile(IkiWiki::template_file("searchquery.tmpl"))));
35         }
36 } #}}}
37
38 my $form;
39 sub pagetemplate (@) { #{{{
40         my %params=@_;
41         my $page=$params{page};
42         my $template=$params{template};
43
44         # Add search box to page header.
45         if ($template->query(name => "searchform")) {
46                 if (! defined $form) {
47                         my $searchform = template("searchform.tmpl", blind_cache => 1);
48                         $searchform->param(searchaction => $config{cgiurl});
49                         $form=$searchform->output;
50                 }
51
52                 $template->param(searchform => $form);
53         }
54 } #}}}
55
56 my $scrubber;
57 sub index (@) { #{{{
58         my %params=@_;
59         
60         return $params{content} if $IkiWiki::preprocessing{$params{destpage}};
61         
62         my $db=xapiandb();
63         my $doc=Search::Xapian::Document->new();
64         my $title;
65         if (exists $pagestate{$params{page}}{meta} &&
66             exists $pagestate{$params{page}}{meta}{title}) {
67                 $title=$pagestate{$params{page}}{meta}{title};
68         }
69         else {
70                 $title=IkiWiki::pagetitle($params{page});
71         }
72
73         # Remove html from text to be indexed.
74         if (! defined $scrubber) {
75                 eval q{use HTML::Scrubber};
76                 if (! $@) {
77                         $scrubber=HTML::Scrubber->new(allow => []);
78                 }
79         }
80         my $toindex = defined $scrubber ? $scrubber->scrub($params{content}) : $params{content};
81         
82         # Take 512 characters for a sample, then extend it out
83         # if it stopped in the middle of a word.
84         my $size=512;
85         my ($sample)=substr($toindex, 0, $size);
86         if (length($sample) == $size) {
87                 my $max=length($toindex);
88                 my $next;
89                 while ($size < $max &&
90                        ($next=substr($toindex, $size++, 1)) !~ /\s/) {
91                         $sample.=$next;
92                 }
93         }
94         $sample=~s/\n/ /g;
95         
96         # data used by omega
97         # Decode html entities in it, since omega re-encodes them.
98         eval q{use HTML::Entities};
99         $doc->set_data(
100                 "url=".urlto($params{page}, "")."\n".
101                 "sample=".decode_entities($sample)."\n".
102                 "caption=".decode_entities($title)."\n".
103                 "modtime=$IkiWiki::pagemtime{$params{page}}\n".
104                 "size=".length($params{content})."\n"
105         );
106
107         my $tg = Search::Xapian::TermGenerator->new();
108         $tg->set_stemmer(new Search::Xapian::Stem("english"));
109         $tg->set_document($doc);
110         $tg->index_text($params{page}, 2);
111         $tg->index_text($title, 2);
112         $tg->index_text($toindex);
113
114         my $pageterm=pageterm($params{page});
115         $doc->add_term($pageterm);
116         $db->replace_document_by_term($pageterm, $doc);
117
118         return $params{content};
119 } #}}}
120
121 sub delete (@) { #{{{
122         my $db=xapiandb();
123         foreach my $page (@_) {
124                 $db->delete_document_by_term(pageterm(pagename($page)));
125         }
126 } #}}}
127
128 sub cgi ($) { #{{{
129         my $cgi=shift;
130
131         if (defined $cgi->param('P')) {
132                 # only works for GET requests
133                 chdir("$config{wikistatedir}/xapian") || error("chdir: $!");
134                 $ENV{OMEGA_CONFIG_FILE}="./omega.conf";
135                 $ENV{CGIURL}=$config{cgiurl},
136                 exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
137         }
138 } #}}}
139
140 sub pageterm ($) { #{{{
141         my $page=shift;
142
143         # TODO: check if > 255 char page names overflow term
144         # length; use sha1 if so?
145         return "U:".$page;
146 } #}}}
147
148 my $db;
149 sub xapiandb () { #{{{
150         if (! defined $db) {
151                 eval q{
152                         use Search::Xapian;
153                         use Search::Xapian::WritableDatabase;
154                 };
155                 error($@) if $@;
156                 $db=Search::Xapian::WritableDatabase->new($config{wikistatedir}."/xapian/default",
157                         Search::Xapian::DB_CREATE_OR_OPEN());
158         }
159         return $db;
160 } #}}}
161
162 1