]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/search.pm
Added a comment: Solution
[git.ikiwiki.info.git] / IkiWiki / Plugin / search.pm
index cc2130ad5b4a2d55e514d3d6891adb89caaaecfc..f9193b6aad5f4d4cbd385d9fb18e586436654679 100644 (file)
@@ -4,15 +4,19 @@ package IkiWiki::Plugin::search;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 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 => "indexhtml", id => "search", call => \&indexhtml);
        hook(type => "delete", id => "search", call => \&delete);
        hook(type => "cgi", id => "search", call => \&cgi);
+       hook(type => "disable", id => "search", call => \&disable);
+       hook(type => "needsbuild", id => "search", call => \&needsbuild);
+               
+       eval q{ use Search::Xapian }; # load early to work around #622591
 }
 
 sub getsetup () {
@@ -20,6 +24,7 @@ sub getsetup () {
                plugin => {
                        safe => 1,
                        rebuild => 1,
+                       section => "web",
                },
                omega_cgi => {
                        type => "string",
@@ -28,18 +33,29 @@ sub getsetup () {
                        safe => 0, # external program
                        rebuild => 0,
                },
+               google_search => {
+                       type => "boolean",
+                       example => 1,
+                       description => "use google site search rather than internal xapian index?",
+                       safe => 1,
+                       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 (! defined $config{omega_cgi}) {
                $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
        }
+
+       # This is a mass dependency, so if the search form template
+       # changes, every page is rebuilt.
+       add_depends("", "templates/searchform.tmpl");
 }
 
 my $form;
@@ -52,7 +68,8 @@ sub pagetemplate (@) {
        if ($template->query(name => "searchform")) {
                if (! defined $form) {
                        my $searchform = template("searchform.tmpl", blind_cache => 1);
-                       $searchform->param(searchaction => $config{cgiurl});
+                       $searchform->param(searchaction => IkiWiki::cgiurl());
+                       $searchform->param(html5 => $config{html5});
                        $form=$searchform->output;
                }
 
@@ -62,14 +79,16 @@ sub pagetemplate (@) {
 
 my $scrubber;
 my $stemmer;
-sub index (@) {
+sub indexhtml (@) {
        my %params=@_;
 
+       return if $config{google_search};
+
        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();
@@ -106,11 +125,17 @@ sub index (@) {
        }
        $sample=~s/\n/ /g;
        
+       my $url=urlto($params{destpage}, "");
+       if (defined $pagestate{$params{page}}{meta}{permalink}) {
+               $url=$pagestate{$params{page}}{meta}{permalink}
+       }
+
        # 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".
+               "url=".$url."\n".
                "sample=".decode_entities($sample)."\n".
                "caption=".decode_entities($caption)."\n".
                "modtime=$IkiWiki::pagemtime{$params{page}}\n".
@@ -149,6 +174,8 @@ sub index (@) {
 }
 
 sub delete (@) {
+       return if $config{google_search};
+
        my $db=xapiandb();
        foreach my $page (@_) {
                my $pageterm=pageterm(pagename($page));
@@ -160,14 +187,20 @@ 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},
-               IkiWiki::loadindex();
-               $ENV{HELPLINK}=htmllink("", "", "ikiwiki/searching",
-                       noimageinline => 1, linktext => "Help");
-               exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
+               if ($config{google_search}) {
+                       print $cgi->redirect("https://www.google.com/search?sitesearch=$config{url}&q=".$cgi->param('P'));
+                       exit 0;
+               }
+               else {
+                       # only works for GET requests
+                       chdir("$config{wikistatedir}/xapian") || error("chdir: $!");
+                       $ENV{OMEGA_CONFIG_FILE}="./omega.conf";
+                       $ENV{CGIURL}=IkiWiki::cgiurl();
+                       IkiWiki::loadindex();
+                       $ENV{HELPLINK}=htmllink("", "", "ikiwiki/searching",
+                               noimageinline => 1, linktext => "Help");
+                       exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
+               }
        }
 }
 
@@ -176,16 +209,17 @@ sub pageterm ($) {
 
        # 240 is the number used by omindex to decide when to hash an
        # overlong term. This does not use a compatible hash method though.
-       if (length $page > 240) {
-               eval q{use Digest::SHA1};
+       eval q{use Encode};
+       if (length encode_utf8($page) > 240) {
+               eval q{use Digest::SHA};
                if ($@) {
-                       debug("search: ".sprintf(gettext("need Digest::SHA1 to index %s"), $page)) if $@;
+                       debug("search: ".sprintf(gettext("need Digest::SHA to index %s"), $page)) if $@;
                        return undef;
                }
 
                # Note no colon, therefore it's guaranteed to not overlap
                # with a page with the same name as the hash..
-               return "U".lc(Digest::SHA1::sha1_hex($page));
+               return "U".lc(Digest::SHA::sha1_hex($page));
        }
        else {
                return "U:".$page;
@@ -213,12 +247,43 @@ sub setupfiles () {
                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"))));
+               omega_template();       
                $setup=1;
        }
 }
 }
 
+sub needsbuild {
+       my $list=shift;
+       if (grep {
+               $_ eq "templates/page.tmpl" ||
+               $_ eq "templates/searchquery.tmpl"
+       } @$list) {
+               omega_template();
+       }
+}
+
+sub omega_template {
+       # Avoid omega interpreting anything in the cgitemplate
+       # as an omegascript command.
+       eval q{use IkiWiki::CGI};
+       my $template=IkiWiki::cgitemplate(undef, gettext("search"), "\0",
+               searchform => "", # avoid showing the small search form
+       );
+       eval q{use HTML::Entities};
+       error $@ if $@;
+       $template=encode_entities($template, '\$');
+
+       my $querytemplate=readfile(IkiWiki::template_file("searchquery.tmpl"));
+       $template=~s/\0/$querytemplate/;
+       writefile("query", $config{wikistatedir}."/xapian/templates",
+               $template);
+}
+
+sub disable () {
+       if (-d $config{wikistatedir}."/xapian") {
+               system("rm", "-rf", $config{wikistatedir}."/xapian");
+       }
+}
+
 1