response

[git.ikiwiki.info.git] / doc / todo / different_search_engine.mdwn

diff --git a/doc/todo/different_search_engine.mdwn b/doc/todo/different_search_engine.mdwn
index a6364b43268bd4ba8b2094122cdd8fa72680d44d..9d0fc92c9f891699175f3afe0dbbf4f92b9b9ba8 100644 (file)
--- a/doc/todo/different_search_engine.mdwn
+++ b/doc/todo/different_search_engine.mdwn
@@ -1,4 +1,6 @@
-After using it for a while, my feeling is that [[hyperestraier]], as used in
+[[done]], using xapian-omega! --[[Joey]]
+
+After using it for a while, my feeling is that hyperestraier, as used in

 the [[plugins/search]] plugin, is not robust enough for ikiwiki. It doesn't
 upgrade well, and it has a habit of sig-11 on certain input from time to
 time.
 the [[plugins/search]] plugin, is not robust enough for ikiwiki. It doesn't
 upgrade well, and it has a habit of sig-11 on certain input from time to
 time.


@@ -31,35 +33,25 @@ Possibilities:
   written on the page would be indexed. Not text generated by directives,
   pulled in by inlining, etc. There's something to be said for that. And
   something to be said against it. It would also get markdown formatted
   written on the page would be indexed. Not text generated by directives,
   pulled in by inlining, etc. There's something to be said for that. And
   something to be said against it. It would also get markdown formatted

-  content, mostly, though it would still need to strip html.
+  content, mostly, though it would still need to strip html, and also
+  probably strip preprocessor directives too.

 * `sanitize` - Would get the htmlized content, so would need to strip html.
 * `sanitize` - Would get the htmlized content, so would need to strip html.

-  Preprocessor directive output would be indexed.
+  Preprocessor directive output would be indexed. Doesn't get a destpage
+  parameter, making optimisation hard.

 * `format` - Would get the entire html page, including the page template.
   Probably not a good choice as indexing the same template for each page
   is unnecessary.
 
 * `format` - Would get the entire html page, including the page template.
   Probably not a good choice as indexing the same template for each page
   is unnecessary.
 

-Currently, a filter hook seems the best option.
-

 The hook would remove any html from the content, and index it.
 The hook would remove any html from the content, and index it.

-It would need to add the same document data that omindex would, as well as
-adding the same special terms (see
-http://xapian.org/docs/omega/overview.html "Boolean terms").
-
-(Note that the U term is a bit tricky because I'll have to replicate
-ominxes's hash_string() to hash terms > 240 chars.)
+It would need to add the same document data that omindex would.

 
 The indexer (and deleter) will need a way to figure out the ids in xapian
 of the documents to delete. One way is storing the id of each page in the
 ikiwiki index.
 
 The other way would be adding a special term to the xapian db that can be
 
 The indexer (and deleter) will need a way to figure out the ids in xapian
 of the documents to delete. One way is storing the id of each page in the
 ikiwiki index.
 
 The other way would be adding a special term to the xapian db that can be

-used with replace_document_by_term/delete_document_by_term. omindex uses
-U<url> as a term, and I guess I could just use that, and then map page
-names to urls when deleting a page  ... only real problem being the
-hashing; a collision would be bad.
-
-At the moment, storing xapian ids in the ikiwiki index file seems like the
-best approach.
+used with replace_document_by_term/delete_document_by_term. 
+Hmm, let's use a term named "P<pagename>".

 
 The hook should try to avoid re-indexing pages that have not changed since
 they were last indexed. One problem is that, if a page with an inline is
 
 The hook should try to avoid re-indexing pages that have not changed since
 they were last indexed. One problem is that, if a page with an inline is


@@ -67,7 +59,8 @@ built, every inlined item will get each hook run. And so a naive hook would
 index each of those items, even though none of them have necessarily
 changed. Date stamps are one possibility. Another would be to avoid having
 the hook not do any indexing when `%preprocessing` is set (Ikiwiki.pm would
 index each of those items, even though none of them have necessarily
 changed. Date stamps are one possibility. Another would be to avoid having
 the hook not do any indexing when `%preprocessing` is set (Ikiwiki.pm would

-need to expose that variable.)
+need to expose that variable.) Another approach would be to use a
+needsbuild hook and only index the pages that are being built.

 
 #### cgi
 
 
 #### cgi
 


@@ -133,7 +126,7 @@ Index: IkiWiki/Plugin/search.pm
 +  $PLUCENE_DIR = $config{wikistatedir}.'/plucene';  
 +}
 +
 +  $PLUCENE_DIR = $config{wikistatedir}.'/plucene';  
 +}
 +

- sub import { #{{{
+ sub import {

 -       hook(type => "getopt", id => "hyperestraier",
 -               call => \&amp;getopt);
 -       hook(type => "checkconfig", id => "hyperestraier",
 -       hook(type => "getopt", id => "hyperestraier",
 -               call => \&amp;getopt);
 -       hook(type => "checkconfig", id => "hyperestraier",


@@ -149,14 +142,14 @@ Index: IkiWiki/Plugin/search.pm
                 call => \&amp;change);
 -       hook(type => "cgi", id => "hyperestraier",
 -               call => \&amp;cgi);
                 call => \&amp;change);
 -       hook(type => "cgi", id => "hyperestraier",
 -               call => \&amp;cgi);

- } # }}}
+ }

  
  

--sub getopt () { #{{{
+-sub getopt () {

 -        eval q{use Getopt::Long};
 -       error($@) if $@;
 -        Getopt::Long::Configure('pass_through');
 -        GetOptions("estseek=s" => \$config{estseek});
 -        eval q{use Getopt::Long};
 -       error($@) if $@;
 -        Getopt::Long::Configure('pass_through');
 -        GetOptions("estseek=s" => \$config{estseek});

--} #}}}
+-}

  
 +sub writer {
 +  init();
  
 +sub writer {
 +  init();


@@ -172,20 +165,20 @@ Index: IkiWiki/Plugin/search.pm
 +    grep { defined pagetype($_) } @_;
 +}
 +
 +    grep { defined pagetype($_) } @_;
 +}
 +

- sub checkconfig () { #{{{
+ sub checkconfig () {

         foreach my $required (qw(url cgiurl)) {
                 if (! length $config{$required}) {
 @@ -36,112 +58,55 @@
         }
         foreach my $required (qw(url cgiurl)) {
                 if (! length $config{$required}) {
 @@ -36,112 +58,55 @@
         }

- } #}}}
+ }

  
 -my $form;
  
 -my $form;

--sub pagetemplate (@) { #{{{
+-sub pagetemplate (@) {

 -       my %params=@_;
 -       my $page=$params{page};
 -       my $template=$params{template};
 +#my $form;
 -       my %params=@_;
 -       my $page=$params{page};
 -       my $template=$params{template};
 +#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};


@@ -200,7 +193,7 @@ Index: IkiWiki/Plugin/search.pm
 +#
 +#              $template->param(searchform => $form);
 +#      }
 +#
 +#              $template->param(searchform => $form);
 +#      }

-+#} #}}}
++#}

  
 -       # Add search box to page header.
 -       if ($template->query(name => "searchform")) {
  
 -       # Add search box to page header.
 -       if ($template->query(name => "searchform")) {


@@ -212,9 +205,9 @@ Index: IkiWiki/Plugin/search.pm
 -
 -               $template->param(searchform => $form);
 -       }
 -
 -               $template->param(searchform => $form);
 -       }

--} #}}}
+-}

 -
 -

- sub delete (@) { #{{{
+ sub delete (@) {

 -       debug(gettext("cleaning hyperestraier search index"));
 -       estcmd("purge -cl");
 -       estcfg();
 -       debug(gettext("cleaning hyperestraier search index"));
 -       estcmd("purge -cl");
 -       estcfg();


@@ -226,9 +219,9 @@ Index: IkiWiki/Plugin/search.pm
 +    $reader->delete_term( Plucene::Index::Term->new({ field => "id", text => $_ }));
 +  }
 +  $reader->close;
 +    $reader->delete_term( Plucene::Index::Term->new({ field => "id", text => $_ }));
 +  }
 +  $reader->close;

- } #}}}
+ }

  
  

- sub change (@) { #{{{
+ sub change (@) {

 -       debug(gettext("updating hyperestraier search index"));
 -       estcmd("gather -cm -bc -cl -sd",
 -               map {
 -       debug(gettext("updating hyperestraier search index"));
 -       estcmd("gather -cm -bc -cl -sd",
 -               map {


@@ -257,9 +250,9 @@ Index: IkiWiki/Plugin/search.pm
 +    $doc->add(Plucene::Document::Field->UnStored('text' => $data));
 +    $writer->add_document($doc);
 +  }
 +    $doc->add(Plucene::Document::Field->UnStored('text' => $data));
 +    $writer->add_document($doc);
 +  }

- } #}}}
+ }

 -
 -

--sub cgi ($) { #{{{
+-sub cgi ($) {

 -       my $cgi=shift;
 -
 -       if (defined $cgi->param('phrase') || defined $cgi->param("navi")) {
 -       my $cgi=shift;
 -
 -       if (defined $cgi->param('phrase') || defined $cgi->param("navi")) {


@@ -267,10 +260,10 @@ Index: IkiWiki/Plugin/search.pm
 -               chdir("$config{wikistatedir}/hyperestraier") || error("chdir: $!");
 -               exec("./".IkiWiki::basename($config{cgiurl})) || error("estseek.cgi failed");
 -       }
 -               chdir("$config{wikistatedir}/hyperestraier") || error("chdir: $!");
 -               exec("./".IkiWiki::basename($config{cgiurl})) || error("estseek.cgi failed");
 -       }

--} #}}}
+-}

 -
 -my $configured=0;
 -
 -my $configured=0;

--sub estcfg () { #{{{
+-sub estcfg () {

 -       return if $configured;
 -       $configured=1;
 -
 -       return if $configured;
 -       $configured=1;
 -


@@ -308,9 +301,9 @@ Index: IkiWiki/Plugin/search.pm
 -       unlink($cgi);
 -       my $estseek = defined $config{estseek} ? $config{estseek} : '/usr/lib/estraier/estseek.cgi';
 -       symlink($estseek, $cgi) || error("symlink $estseek $cgi: $!");
 -       unlink($cgi);
 -       my $estseek = defined $config{estseek} ? $config{estseek} : '/usr/lib/estraier/estseek.cgi';
 -       symlink($estseek, $cgi) || error("symlink $estseek $cgi: $!");

--} # }}}
+-}

 -
 -

--sub estcmd ($;@) { #{{{
+-sub estcmd ($;@) {

 -       my @params=split(' ', shift);
 -       push @params, "-cl", "$config{wikistatedir}/hyperestraier";
 -       if (@_) {
 -       my @params=split(' ', shift);
 -       push @params, "-cl", "$config{wikistatedir}/hyperestraier";
 -       if (@_) {


@@ -330,7 +323,7 @@ Index: IkiWiki/Plugin/search.pm
 -               open(STDOUT, "/dev/null"); # shut it up (closing won't work)
 -               exec("estcmd", @params) || error("can't run estcmd");
 -       }
 -               open(STDOUT, "/dev/null"); # shut it up (closing won't work)
 -               exec("estcmd", @params) || error("can't run estcmd");
 -       }

--} #}}}
+-}

 -
 -1
 +1;
 -
 -1
 +1;