lib/plugin/SearchHighlight.php

   1 <?php // -*-php-*-
   2
   3 /*
   4  * Copyright 2004,2007 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is NOT 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 along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 require_once 'lib/TextSearchQuery.php';
  24 require_once 'lib/PageList.php';
  25
  26 /**
  27  * When someone is referred from a search engine like Google, Yahoo
  28  * or our own fulltextsearch, the terms they search for are highlighted.
  29  * See http://wordpress.org/about/shots/1.2/plugins.png
  30  *
  31  * This plugin is normally just used to print a header through an action page.
  32  * The highlighting is done through InlineParser automatically if ENABLE_SEARCHHIGHLIGHT is enabled.
  33  * If hits = 1, then the list of found terms is also printed.
  34  */
  35 class WikiPlugin_SearchHighlight
  36 extends WikiPlugin
  37 {
  38     function getName() {
  39         return _("SearchHighlight");
  40     }
  41
  42     function getDescription() {
  43         return _("Hilight referred search terms.");
  44     }
  45
  46     function getDefaultArguments() {
  47         // s, engine and engine_url are picked from the request
  48         return array('noheader' => false,    //don't print the header
  49                      'hits'     => false,    //print the list of lines with lines terms additionally
  50                      's'        => false,
  51                      'case_exact' => false,  //not yet supported
  52                      'regex'    => false,    //not yet supported
  53                      );
  54     }
  55
  56     function run($dbi, $argstr, &$request, $basepage) {
  57         $args = $this->getArgs($argstr, $request);
  58         if (empty($args['s']) and isset($request->_searchhighlight)) {
  59             $args['s'] = $request->_searchhighlight['query'];
  60         }
  61         if (empty($args['s']))
  62             return '';
  63         extract($args);
  64         $html = HTML();
  65         if (!$noheader and isset($request->_searchhighlight)) {
  66             $engine = $request->_searchhighlight['engine'];
  67             $html->pushContent(HTML::div(array('class' => 'search-context'),
  68                                              fmt("%s: Found %s through %s",
  69                                                  $basepage,
  70                                              $request->_searchhighlight['query'],
  71                                              $engine)));
  72         }
  73         if ($hits) {
  74             $query = new TextSearchQuery($s, $case_exact, $regex);
  75             $lines = array();
  76             $hilight_re = $query->getHighlightRegexp();
  77             $page = $request->getPage();
  78             $html->pushContent($this->showhits($page, $hilight_re));
  79         }
  80         return $html;
  81     }
  82
  83     function showhits($page, $hilight_re) {
  84         $current = $page->getCurrentRevision();
  85         $matches = preg_grep("/$hilight_re/i", $current->getContent());
  86         $html = HTML::dl();
  87         foreach ($matches as $line) {
  88             $line = $this->highlight_line($line, $hilight_re);
  89             $html->pushContent(HTML::dd(array('class' => 'search-context'),
  90                                         HTML::small($line)));
  91         }
  92         return $html;
  93     }
  94
  95     function highlight_line ($line, $hilight_re) {
  96         $html = HTML();
  97         while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
  98             $line = substr($line, strlen($m[0]));
  99             // prematch + match
 100             $html->pushContent($m[1], HTML::strong(array('class' => 'search-term'), $m[2]));
 101         }
 102         $html->pushContent($line);       // postmatch
 103         return $html;
 104     }
 105 };
 106
 107 // Local Variables:
 108 // mode: php
 109 // tab-width: 8
 110 // c-basic-offset: 4
 111 // c-hanging-comment-ender-p: nil
 112 // indent-tabs-mode: nil
 113 // End: