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