no need to return content from postscan hook

[git.ikiwiki.info.git] / IkiWiki / Plugin / search.pm

diff --git a/IkiWiki/Plugin/search.pm b/IkiWiki/Plugin/search.pm
index 8fc2f3724c9f4666e675aeaa79bc43e839230792..a1e7026caf0e11d783c65d90ea6e233123122bbb 100644 (file)
--- a/IkiWiki/Plugin/search.pm
+++ b/IkiWiki/Plugin/search.pm
@@ -4,30 +4,47 @@ package IkiWiki::Plugin::search;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "search", call => \&getsetup);
        hook(type => "checkconfig", id => "search", call => \&checkconfig);
        hook(type => "pagetemplate", id => "search", call => \&pagetemplate);
-       hook(type => "sanitize", id => "search", call => \&index);
+       hook(type => "postscan", id => "search", call => \&index);
        hook(type => "delete", id => "search", call => \&delete);
        hook(type => "cgi", id => "search", call => \&cgi);
-} # }}}
-
-sub checkconfig () { #{{{
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+                       section => "web",
+               },
+               omega_cgi => {
+                       type => "string",
+                       example => "/usr/lib/cgi-bin/omega/omega",
+                       description => "path to the omega cgi program",
+                       safe => 0, # external program
+                       rebuild => 0,
+               },
+}
+
+sub checkconfig () {
        foreach my $required (qw(url cgiurl)) {
                if (! length $config{$required}) {
-                       error(sprintf(gettext("Must specify %s when using the search plugin"), $required));
+                       error(sprintf(gettext("Must specify %s when using the %s plugin"), $required, 'search'));
                }
        }
        
-       if (! exists $config{omega_cgi}) {
+       if (! defined $config{omega_cgi}) {
                $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
        }
-} #}}}
+}
 
 my $form;
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
        my $page=$params{page};
        my $template=$params{template};
@@ -42,24 +59,22 @@ sub pagetemplate (@) { #{{{
 
                $template->param(searchform => $form);
        }
-} #}}}
+}
 
 my $scrubber;
 my $stemmer;
-sub index (@) { #{{{
+sub index (@) {
        my %params=@_;
-       
-       return $params{content} if $IkiWiki::preprocessing{$params{destpage}};
 
        setupfiles();
 
        # A unique pageterm is used to identify the document for a page.
        my $pageterm=pageterm($params{page});
-       return $params{content} unless defined $pageterm;
+       return unless defined $pageterm;
        
        my $db=xapiandb();
        my $doc=Search::Xapian::Document->new();
-       my $caption=IkiWiki::pagetitle($params{page});
+       my $caption=pagetitle($params{page});
        my $title;
        if (exists $pagestate{$params{page}}{meta} &&
                exists $pagestate{$params{page}}{meta}{title}) {
@@ -95,6 +110,7 @@ sub index (@) { #{{{
        # data used by omega
        # Decode html entities in it, since omega re-encodes them.
        eval q{use HTML::Entities};
+       error $@ if $@;
        $doc->set_data(
                "url=".urlto($params{page}, "")."\n".
                "sample=".decode_entities($sample)."\n".
@@ -125,26 +141,24 @@ sub index (@) { #{{{
        $tg->index_text($caption, 2);
        $tg->index_text($title, 2) if $title ne $caption;
        $tg->index_text($toindex);
-       $tg->index_text(lc($title), 1, "ZS"); # for title:foo
+       $tg->index_text(lc($title), 1, "S"); # for title:foo
        foreach my $link (@{$links{$params{page}}}) {
-               $tg->index_text(lc($link), 1, "ZLINK"); # for link:bar
+               $tg->index_text(lc($link), 1, "XLINK"); # for link:bar
        }
 
        $doc->add_term($pageterm);
        $db->replace_document_by_term($pageterm, $doc);
+}
 
-       return $params{content};
-} #}}}
-
-sub delete (@) { #{{{
+sub delete (@) {
        my $db=xapiandb();
        foreach my $page (@_) {
                my $pageterm=pageterm(pagename($page));
                $db->delete_document_by_term($pageterm) if defined $pageterm;
        }
-} #}}}
+}
 
-sub cgi ($) { #{{{
+sub cgi ($) {
        my $cgi=shift;
 
        if (defined $cgi->param('P')) {
@@ -157,9 +171,9 @@ sub cgi ($) { #{{{
                        noimageinline => 1, linktext => "Help");
                exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
        }
-} #}}}
+}
 
-sub pageterm ($) { #{{{
+sub pageterm ($) {
        my $page=shift;
 
        # 240 is the number used by omindex to decide when to hash an
@@ -178,10 +192,10 @@ sub pageterm ($) { #{{{
        else {
                return "U:".$page;
        }
-} #}}}
+}
 
 my $db;
-sub xapiandb () { #{{{
+sub xapiandb () {
        if (! defined $db) {
                eval q{
                        use Search::Xapian;
@@ -192,17 +206,31 @@ sub xapiandb () { #{{{
                        Search::Xapian::DB_CREATE_OR_OPEN());
        }
        return $db;
-} #}}}
+}
 
-sub setupfiles () { #{{{
-       if (! -e $config{wikistatedir}."/xapian" || $config{rebuild}) {
+{
+my $setup=0;
+sub setupfiles () {
+       if (! $setup and (! -e $config{wikistatedir}."/xapian" || $config{rebuild})) {
                writefile("omega.conf", $config{wikistatedir}."/xapian",
                        "database_dir .\n".
                        "template_dir ./templates\n");
+               
+               # Avoid omega interpreting anything in the misctemplate
+               # as an omegascript command.
+               my $misctemplate=IkiWiki::misctemplate(gettext("search"), "\0");
+               eval q{use HTML::Entities};
+               error $@ if $@;
+               $misctemplate=encode_entities($misctemplate, '\$');
+
+               my $querytemplate=readfile(IkiWiki::template_file("searchquery.tmpl"));
+               $misctemplate=~s/\0/$querytemplate/;
+
                writefile("query", $config{wikistatedir}."/xapian/templates",
-                       IkiWiki::misctemplate(gettext("search"),
-                               readfile(IkiWiki::template_file("searchquery.tmpl"))));
+                       $misctemplate);
+               $setup=1;
        }
-} #}}}
+}
+}
 
 1