X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e3b0584a493d4d2178bc7c48ff89fde766ff322b..5bdcd4d57b2ca5dbf6e3d46a693cec4d27512020:/IkiWiki/Plugin/search.pm?ds=inline

diff --git a/IkiWiki/Plugin/search.pm b/IkiWiki/Plugin/search.pm
index eedfa6924..393c17e0f 100644
--- a/IkiWiki/Plugin/search.pm
+++ b/IkiWiki/Plugin/search.pm
@@ -4,30 +4,46 @@ 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 => "postscan", id => "search", call => \&index);
 	hook(type => "delete", id => "search", call => \&delete);
 	hook(type => "cgi", id => "search", call => \&cgi);
-} # }}}
+}
+
+sub getsetup () {
+	return
+		plugin => {
+			safe => 1,
+			rebuild => 1,
+		},
+		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 () { #{{{
+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,11 +58,11 @@ sub pagetemplate (@) { #{{{
 
 		$template->param(searchform => $form);
 	}
-} #}}}
+}
 
 my $scrubber;
 my $stemmer;
-sub index (@) { #{{{
+sub index (@) {
 	my %params=@_;
 
 	setupfiles();
@@ -57,7 +73,7 @@ sub index (@) { #{{{
 	
 	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}) {
@@ -130,17 +146,17 @@ sub index (@) { #{{{
 
 	$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;
 	}
-} #}}}
+}
 
-sub cgi ($) { #{{{
+sub cgi ($) {
 	my $cgi=shift;
 
 	if (defined $cgi->param('P')) {
@@ -153,9 +169,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
@@ -174,10 +190,10 @@ sub pageterm ($) { #{{{
 	else {
 		return "U:".$page;
 	}
-} #}}}
+}
 
 my $db;
-sub xapiandb () { #{{{
+sub xapiandb () {
 	if (! defined $db) {
 		eval q{
 			use Search::Xapian;
@@ -188,11 +204,11 @@ sub xapiandb () { #{{{
 			Search::Xapian::DB_CREATE_OR_OPEN());
 	}
 	return $db;
-} #}}}
+}
 
 {
 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".
@@ -202,7 +218,7 @@ sub setupfiles () { #{{{
 				readfile(IkiWiki::template_file("searchquery.tmpl"))));
 		$setup=1;
 	}
-} #}}}
+}
 }
 
 1