2 # xapian-omega search engine plugin
3 package IkiWiki::Plugin::search;
10 hook(type => "checkconfig", id => "search", call => \&checkconfig);
11 hook(type => "pagetemplate", id => "search", call => \&pagetemplate);
12 # run last so other needsbuild hooks can modify the list
13 hook(type => "needsbuild", id => "search", call => \&needsbuild,
15 hook(type => "filter", id => "search", call => \&filter);
16 hook(type => "delete", id => "search", call => \&delete);
17 hook(type => "cgi", id => "search", call => \&cgi);
20 sub checkconfig () { #{{{
21 foreach my $required (qw(url cgiurl)) {
22 if (! length $config{$required}) {
23 error(sprintf(gettext("Must specify %s when using the search plugin"), $required));
27 if (! exists $config{omega_cgi}) {
28 $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
31 if (! -e $config{wikistatedir}."/xapian" || $config{rebuild}) {
32 writefile("omega.conf", $config{wikistatedir}."/xapian",
34 "template_dir ./templates\n");
35 writefile("query", $config{wikistatedir}."/xapian/templates",
36 IkiWiki::misctemplate(gettext("search"),
37 readfile(IkiWiki::template_file("searchquery.tmpl"))));
42 sub pagetemplate (@) { #{{{
44 my $page=$params{page};
45 my $template=$params{template};
47 # Add search box to page header.
48 if ($template->query(name => "searchform")) {
49 if (! defined $form) {
50 my $searchform = template("searchform.tmpl", blind_cache => 1);
51 $searchform->param(searchaction => $config{cgiurl});
52 $form=$searchform->output;
55 $template->param(searchform => $form);
60 sub needsbuild ($) { #{{{
61 %toindex = map { $_ => 1 } @{shift()};
67 if ($params{page} eq $params{destpage} && $toindex{$params{page}}) {
70 my $doc=Search::Xapian::Document->new();
71 my $title=$params{page};
72 if (exists $pagestate{$params{page}}{meta} &&
73 exists $pagestate{$params{page}}{meta}{title}) {
74 $title=$pagestate{$params{page}}{meta}{title};
79 "url=".urlto($params{page}, "")."\n".
82 "modtime=$IkiWiki::pagemtime{$params{page}}\n".
83 "size=".length($params{content})."\n"
86 my $tg = Search::Xapian::TermGenerator->new();
87 $tg->set_stemmer(new Search::Xapian::Stem("english"));
88 $tg->set_document($doc);
89 $tg->index_text($params{page}, 2);
90 $tg->index_text($title, 2);
91 $tg->index_text($params{content}); # TODO html strip; preprocessor too
93 my $pageterm=pageterm($params{page});
94 $doc->add_term($pageterm);
95 $db->replace_document_by_term($pageterm, $doc);
98 return $params{content};
101 sub delete (@) { #{{{
103 foreach my $page (@_) {
104 $db->delete_document_by_term(pageterm($page));
111 if (defined $cgi->param('P')) {
112 # only works for GET requests
113 chdir("$config{wikistatedir}/xapian") || error("chdir: $!");
114 $ENV{OMEGA_CONFIG_FILE}="./omega.conf";
115 $ENV{CGIURL}=$config{cgiurl},
116 exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
120 sub pageterm ($) { #{{{
123 # TODO: check if > 255 char page names overflow term
124 # length; use sha1 if so?
129 sub xapiandb () { #{{{
133 use Search::Xapian::WritableDatabase;
136 $db=Search::Xapian::WritableDatabase->new($config{wikistatedir}."/xapian/default",
137 Search::Xapian::DB_CREATE_OR_OPEN());