update info on my split-view setup, and ask for plugin advice

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

diff --git a/IkiWiki/Plugin/search.pm b/IkiWiki/Plugin/search.pm
index cb12d9500d95a31545426fd3c984e3297286d457..42d2e0d3009d9e190fa78790f581c536355a8d70 100644 (file)
--- a/IkiWiki/Plugin/search.pm
+++ b/IkiWiki/Plugin/search.pm
@@ -4,19 +4,28 @@ 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 => "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 => "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 () { #{{{
+sub getsetup () {

        return
        return

+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+                       section => "web",
+               },

                omega_cgi => {
                        type => "string",
                        example => "/usr/lib/cgi-bin/omega/omega",
                omega_cgi => {
                        type => "string",
                        example => "/usr/lib/cgi-bin/omega/omega",


@@ -24,22 +33,26 @@ sub getsetup () { #{{{
                        safe => 0, # external program
                        rebuild => 0,
                },
                        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 (! defined $config{omega_cgi}) {
                $config{omega_cgi}="/usr/lib/cgi-bin/omega/omega";
        }
                }
        }
        
        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;
 
 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};


@@ -48,28 +61,29 @@ sub pagetemplate (@) { #{{{
        if ($template->query(name => "searchform")) {
                if (! defined $form) {
                        my $searchform = template("searchform.tmpl", blind_cache => 1);
        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;
                }
 
                $template->param(searchform => $form);
        }
                        $form=$searchform->output;
                }
 
                $template->param(searchform => $form);
        }

-} #}}}
+}

 
 my $scrubber;
 my $stemmer;
 
 my $scrubber;
 my $stemmer;

-sub index (@) { #{{{
+sub indexhtml (@) {

        my %params=@_;
 
        setupfiles();
 
        # A unique pageterm is used to identify the document for a page.
        my $pageterm=pageterm($params{page});
        my %params=@_;
 
        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 $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}) {


@@ -102,11 +116,17 @@ sub index (@) { #{{{
        }
        $sample=~s/\n/ /g;
        
        }
        $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};
        # data used by omega
        # Decode html entities in it, since omega re-encodes them.
        eval q{use HTML::Entities};

+       error $@ if $@;

        $doc->set_data(
        $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".
                "sample=".decode_entities($sample)."\n".
                "caption=".decode_entities($caption)."\n".
                "modtime=$IkiWiki::pagemtime{$params{page}}\n".


@@ -142,54 +162,55 @@ 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')) {
                # only works for GET requests
                chdir("$config{wikistatedir}/xapian") || error("chdir: $!");
                $ENV{OMEGA_CONFIG_FILE}="./omega.conf";
        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},
+               $ENV{CGIURL}=IkiWiki::cgiurl();

                IkiWiki::loadindex();
                $ENV{HELPLINK}=htmllink("", "", "ikiwiki/searching",
                        noimageinline => 1, linktext => "Help");
                exec($config{omega_cgi}) || error("$config{omega_cgi} failed: $!");
        }
                IkiWiki::loadindex();
                $ENV{HELPLINK}=htmllink("", "", "ikiwiki/searching",
                        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
        # overlong term. This does not use a compatible hash method though.
        my $page=shift;
 
        # 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 ($@) {
                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 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;
        }
        }
        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;


@@ -200,21 +221,52 @@ 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".
                        "template_dir ./templates\n");
        if (! $setup and (! -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"))));
+               omega_template();       

                $setup=1;
        }
                $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
 }
 
 1