]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/search.pm
note that this old bug affects more stuff now
[git.ikiwiki.info.git] / IkiWiki / Plugin / search.pm
index c45e59c8e168df673540d2e0177d1513511a3fa8..393c17e0fe8cf6b9ec137ba7cfc8ac64e008cd4b 100644 (file)
@@ -4,41 +4,46 @@ package IkiWiki::Plugin::search;
 
 use warnings;
 use strict;
 
 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 => "postscan", id => "search", call => \&index);
        hook(type => "delete", id => "search", call => \&delete);
        hook(type => "cgi", id => "search", call => \&cgi);
        hook(type => "getsetup", id => "search", call => \&getsetup);
        hook(type => "checkconfig", id => "search", call => \&checkconfig);
        hook(type => "pagetemplate", id => "search", call => \&pagetemplate);
        hook(type => "postscan", id => "search", call => \&index);
        hook(type => "delete", id => "search", call => \&delete);
        hook(type => "cgi", id => "search", call => \&cgi);
-} # }}}
+}
 
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+               },
                omega_cgi => {
                        type => "string",
                omega_cgi => {
                        type => "string",
+                       example => "/usr/lib/cgi-bin/omega/omega",
                        description => "path to the omega cgi program",
                        safe => 0, # external program
                        rebuild => 0,
                },
                        description => "path to the omega cgi program",
                        safe => 0, # external program
                        rebuild => 0,
                },
-} #}}}
+}
 
 
-sub checkconfig () { #{{{
+sub checkconfig () {
        foreach my $required (qw(url cgiurl)) {
                if (! length $config{$required}) {
        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";
        }
                $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
        }
-} #}}}
+}
 
 my $form;
 
 my $form;
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
        my $page=$params{page};
        my $template=$params{template};
        my %params=@_;
        my $page=$params{page};
        my $template=$params{template};
@@ -53,11 +58,11 @@ sub pagetemplate (@) { #{{{
 
                $template->param(searchform => $form);
        }
 
                $template->param(searchform => $form);
        }
-} #}}}
+}
 
 my $scrubber;
 my $stemmer;
 
 my $scrubber;
 my $stemmer;
-sub index (@) { #{{{
+sub index (@) {
        my %params=@_;
 
        setupfiles();
        my %params=@_;
 
        setupfiles();
@@ -68,7 +73,7 @@ sub index (@) { #{{{
        
        my $db=xapiandb();
        my $doc=Search::Xapian::Document->new();
        
        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}) {
        my $title;
        if (exists $pagestate{$params{page}}{meta} &&
                exists $pagestate{$params{page}}{meta}{title}) {
@@ -141,17 +146,17 @@ sub index (@) { #{{{
 
        $doc->add_term($pageterm);
        $db->replace_document_by_term($pageterm, $doc);
 
        $doc->add_term($pageterm);
        $db->replace_document_by_term($pageterm, $doc);
-} #}}}
+}
 
 
-sub delete (@) { #{{{
+sub delete (@) {
        my $db=xapiandb();
        foreach my $page (@_) {
                my $pageterm=pageterm(pagename($page));
                $db->delete_document_by_term($pageterm) if defined $pageterm;
        }
        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')) {
        my $cgi=shift;
 
        if (defined $cgi->param('P')) {
@@ -164,9 +169,9 @@ sub cgi ($) { #{{{
                        noimageinline => 1, linktext => "Help");
                exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
        }
                        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
        my $page=shift;
 
        # 240 is the number used by omindex to decide when to hash an
@@ -185,10 +190,10 @@ sub pageterm ($) { #{{{
        else {
                return "U:".$page;
        }
        else {
                return "U:".$page;
        }
-} #}}}
+}
 
 my $db;
 
 my $db;
-sub xapiandb () { #{{{
+sub xapiandb () {
        if (! defined $db) {
                eval q{
                        use Search::Xapian;
        if (! defined $db) {
                eval q{
                        use Search::Xapian;
@@ -199,11 +204,11 @@ sub xapiandb () { #{{{
                        Search::Xapian::DB_CREATE_OR_OPEN());
        }
        return $db;
                        Search::Xapian::DB_CREATE_OR_OPEN());
        }
        return $db;
-} #}}}
+}
 
 {
 my $setup=0;
 
 {
 my $setup=0;
-sub setupfiles () { #{{{
+sub setupfiles () {
        if (! $setup and (! -e $config{wikistatedir}."/xapian" || $config{rebuild})) {
                writefile("omega.conf", $config{wikistatedir}."/xapian",
                        "database_dir .\n".
        if (! $setup and (! -e $config{wikistatedir}."/xapian" || $config{rebuild})) {
                writefile("omega.conf", $config{wikistatedir}."/xapian",
                        "database_dir .\n".
@@ -213,7 +218,7 @@ sub setupfiles () { #{{{
                                readfile(IkiWiki::template_file("searchquery.tmpl"))));
                $setup=1;
        }
                                readfile(IkiWiki::template_file("searchquery.tmpl"))));
                $setup=1;
        }
-} #}}}
+}
 }
 
 1
 }
 
 1