lib/plugin/SearchHighlight.php

   1 <?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     {
  40         return _("SearchHighlight");
  41     }
  42
  43     function getDescription()
  44     {
  45         return _("Hilight referred search terms.");
  46     }
  47
  48     function getDefaultArguments()
  49     {
  50         // s, engine and engine_url are picked from the request
  51         return array('noheader' => false, //don't print the header
  52             'hits' => false, //print the list of lines with lines terms additionally
  53             's' => false,
  54             'case_exact' => false, //not yet supported
  55             'regex' => false, //not yet supported
  56         );
  57     }
  58
  59     function run($dbi, $argstr, &$request, $basepage)
  60     {
  61         $args = $this->getArgs($argstr, $request);
  62         if (empty($args['s']) and isset($request->_searchhighlight)) {
  63             $args['s'] = $request->_searchhighlight['query'];
  64         }
  65         if (empty($args['s'])) {
  66             return HTML();
  67         }
  68         extract($args);
  69         $html = HTML();
  70         if (!$noheader and isset($request->_searchhighlight)) {
  71             $engine = $request->_searchhighlight['engine'];
  72             $html->pushContent(HTML::div(array('class' => 'search-context'),
  73                 fmt("%s: Found %s through %s",
  74                     $basepage,
  75                     $request->_searchhighlight['query'],
  76                     $engine)));
  77         }
  78         if ($hits) {
  79             $query = new TextSearchQuery($s, $case_exact, $regex);
  80             $lines = array();
  81             $hilight_re = $query->getHighlightRegexp();
  82             $page = $request->getPage();
  83             $html->pushContent($this->showhits($page, $hilight_re));
  84         }
  85         return $html;
  86     }
  87
  88     function showhits($page, $hilight_re)
  89     {
  90         $current = $page->getCurrentRevision();
  91         $matches = preg_grep("/$hilight_re/i", $current->getContent());
  92         $html = HTML::dl();
  93         foreach ($matches as $line) {
  94             $line = $this->highlight_line($line, $hilight_re);
  95             $html->pushContent(HTML::dd(array('class' => 'search-context'),
  96                 HTML::small($line)));
  97         }
  98         return $html;
  99     }
 100
 101     function highlight_line($line, $hilight_re)
 102     {
 103         $html = HTML();
 104         while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
 105             $line = substr($line, strlen($m[0]));
 106             // prematch + match
 107             $html->pushContent($m[1], HTML::strong(array('class' => 'search-term'), $m[2]));
 108         }
 109         $html->pushContent($line); // postmatch
 110         return $html;
 111     }
 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: