lib/plugin/FullTextSearch.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: FullTextSearch.php,v 1.16 2004-02-17 12:11:36 rurban Exp $');
   3 /*
   4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
   5
   6 This file is part of PhpWiki.
   7
   8 PhpWiki is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 PhpWiki is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with PhpWiki; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21 */
  22
  23 require_once('lib/TextSearchQuery.php');
  24
  25 /**
  26  */
  27 class WikiPlugin_FullTextSearch
  28 extends WikiPlugin
  29 {
  30     function getName() {
  31         return _("FullTextSearch");
  32     }
  33
  34     function getDescription() {
  35         return _("Search the content of all pages in this wiki.");
  36     }
  37
  38     function getVersion() {
  39         return preg_replace("/[Revision: $]/", '',
  40                             "\$Revision: 1.16 $");
  41     }
  42
  43     function getDefaultArguments() {
  44         return array('s'        => false,
  45                      'noheader' => false);
  46         // TODO: multiple page exclude
  47     }
  48
  49
  50     function run($dbi, $argstr, &$request, $basepage) {
  51
  52         $args = $this->getArgs($argstr, $request);
  53         if (empty($args['s']))
  54             return '';
  55
  56         extract($args);
  57
  58         $query = new TextSearchQuery($s);
  59         $pages = $dbi->fullSearch($query);
  60         $lines = array();
  61         $hilight_re = $query->getHighlightRegexp();
  62         $count = 0;
  63         $found = 0;
  64
  65         $list = HTML::dl();
  66
  67         while ($page = $pages->next()) {
  68             $count++;
  69             $name = $page->getName();
  70             $list->pushContent(HTML::dt(WikiLink($name)));
  71             if ($hilight_re)
  72                 $list->pushContent($this->showhits($page, $hilight_re));
  73         }
  74         if (!$list->getContent())
  75             $list->pushContent(HTML::dd(_("<no matches>")));
  76
  77         if ($noheader)
  78             return $list;
  79
  80         return HTML(HTML::p(fmt("Full text search results for '%s'", $s)),
  81                     $list);
  82     }
  83
  84     function showhits($page, $hilight_re) {
  85         $current = $page->getCurrentRevision();
  86         $matches = preg_grep("/$hilight_re/i", $current->getContent());
  87         $html = array();
  88         foreach ($matches as $line) {
  89             $line = $this->highlight_line($line, $hilight_re);
  90             $html[] = HTML::dd(HTML::small(array('class' => 'search-context'),
  91                                            $line));
  92         }
  93         return $html;
  94     }
  95
  96     function highlight_line ($line, $hilight_re) {
  97         while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
  98             $line = substr($line, strlen($m[0]));
  99             $html[] = $m[1];    // prematch
 100             $html[] = HTML::strong(array('class' => 'search-term'), $m[2]); // match
 101         }
 102         $html[] = $line;        // postmatch
 103         return $html;
 104     }
 105 };
 106
 107 // $Log: not supported by cvs2svn $
 108 // Revision 1.15  2003/01/18 21:41:01  carstenklapp
 109 // Code cleanup:
 110 // Reformatting & tabs to spaces;
 111 // Added copyleft, getVersion, getDescription, rcs_id.
 112 //
 113
 114 // Local Variables:
 115 // mode: php
 116 // tab-width: 8
 117 // c-basic-offset: 4
 118 // c-hanging-comment-ender-p: nil
 119 // indent-tabs-mode: nil
 120 // End:
 121 ?>