4 Copyright 2004,2007 $ThePhpWikiProgrammingTeam
6 This file is NOT part of PhpWiki.
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.
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.
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
23 require_once("lib/TextSearchQuery.php");
24 require_once("lib/PageList.php");
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
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.
35 class WikiPlugin_SearchHighlight
39 return _("SearchHighlight");
42 function getDescription() {
43 return _("Hilight referred search terms.");
46 function getVersion() {
47 return preg_replace("/[Revision: $]/", '',
51 function getDefaultArguments() {
52 // s, engine and engine_url are picked from the request
53 return array('noheader' => false, //don't print the header
54 'hits' => false, //print the list of lines with lines terms additionally
56 'case_exact' => false, //not yet supported
57 'regex' => false, //not yet supported
61 function run($dbi, $argstr, &$request, $basepage) {
62 $args = $this->getArgs($argstr, $request);
63 if (empty($args['s']) and isset($request->_searchhighlight)) {
64 $args['s'] = $request->_searchhighlight['query'];
66 if (empty($args['s']))
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",
75 $request->_searchhighlight['query'],
79 $query = new TextSearchQuery($s, $case_exact, $regex);
81 $hilight_re = $query->getHighlightRegexp();
82 $page = $request->getPage();
83 $html->pushContent($this->showhits($page, $hilight_re));
88 function showhits($page, $hilight_re) {
89 $current = $page->getCurrentRevision();
90 $matches = preg_grep("/$hilight_re/i", $current->getContent());
92 foreach ($matches as $line) {
93 $line = $this->highlight_line($line, $hilight_re);
94 $html->pushContent(HTML::dd(array('class' => 'search-context'),
100 function highlight_line ($line, $hilight_re) {
102 while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
103 $line = substr($line, strlen($m[0]));
105 $html->pushContent($m[1], HTML::strong(array('class' => 'search-term'), $m[2]));
107 $html->pushContent($line); // postmatch
116 // c-hanging-comment-ender-p: nil
117 // indent-tabs-mode: nil