lib/plugin/FullTextSearch.php

   1 <?php
   2
   3 /*
   4  * Copyright 1999-2002,2004,2005,2007,2009 $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 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  * Case insensitive fulltext search
  28  * Options: case_exact, regex, hilight
  29  *          Stoplist
  30  *
  31  * See also:
  32  *   Hooks to search in external documents: ExternalTextSearch
  33  *   Only uploaded: textfiles, PDF, HTML, DOC, XLS, ... or
  34  *   External apps: xapian-omages seems to be the better than lucene,
  35  *   lucene.net, swish, nakamazu, ...
  36  *
  37  * See http://sf.net/tracker/index.php?aid=927395&group_id=6121&atid=106121
  38  * Wordaround to let the dead locks occur somewhat later:
  39  *   Increase the memory limit of PHP from 8 MB to 32 MB
  40  *   php.ini: memory_limit = 32 MB
  41  */
  42 class WikiPlugin_FullTextSearch
  43     extends WikiPlugin
  44 {
  45     function getName()
  46     {
  47         return _("FullTextSearch");
  48     }
  49
  50     function getDescription()
  51     {
  52         return _("Search the content of all pages in this wiki.");
  53     }
  54
  55     function getDefaultArguments()
  56     {
  57         return array_merge
  58         (
  59             PageList::supportedArgs(), // paging and more.
  60             array('s' => false,
  61                 'hilight' => true,
  62                 'case_exact' => false,
  63                 'regex' => 'auto',
  64                 'sortby' => '-hi_content',
  65                 'noheader' => false,
  66                 'exclude' => false, // comma-separated list of glob
  67                 'quiet' => true)); // be less verbose
  68     }
  69
  70     function run($dbi, $argstr, &$request, $basepage)
  71     {
  72
  73         $args = $this->getArgs($argstr, $request);
  74
  75         if (empty($args['s'])) {
  76             return HTML();
  77         }
  78         extract($args);
  79
  80         $query = new TextSearchQuery($s, $case_exact, $regex);
  81         $pages = $dbi->fullSearch($query, $sortby, $limit, $exclude);
  82         $hilight_re = $hilight ? $query->getHighlightRegexp() : false;
  83         $count = 0;
  84
  85         if ($quiet) { // see how easy it is with PageList...
  86             unset($args['info']);
  87             $args['listtype'] = 'dl';
  88             $args['types'] = array(new _PageList_Column_content
  89             ('rev:hi_content', _("Content"), "left", $s, $hilight_re));
  90             $list = new PageList(false, $exclude, $args);
  91             $list->setCaption(fmt("Full text search results for “%s”", $s));
  92             while ($page = $pages->next()) {
  93                 $list->addPage($page);
  94             }
  95             return $list;
  96         }
  97
  98         // Todo: we should better define a new PageListDL class for dl/dt/dd lists
  99         // But the new column types must have a callback then. (showhits)
 100         // See e.g. WikiAdminSearchReplace for custom pagelist columns
 101         $list = HTML::dl();
 102         if (!$limit or !is_int($limit))
 103             $limit = 0;
 104         // expand all page wildcards to a list of pages which should be ignored
 105         if ($exclude) $exclude = explodePageList($exclude);
 106         while ($page = $pages->next() and (!$limit or ($count < $limit))) {
 107             $name = $page->getName();
 108             if ($exclude and in_array($name, $exclude)) continue;
 109             $count++;
 110             $list->pushContent(HTML::dt(WikiLink($page)));
 111             if ($hilight_re)
 112                 $list->pushContent($this->showhits($page, $hilight_re));
 113             unset($page);
 114         }
 115         if ($limit and $count >= $limit) //todo: pager link to list of next matches
 116             $list->pushContent(HTML::dd(fmt("only %d pages displayed", $limit)));
 117         if (!$list->getContent())
 118             $list->pushContent(HTML::dd(_("<no matches>")));
 119
 120         if (!empty($pages->stoplisted))
 121             $list = HTML(HTML::p(fmt(_("Ignored stoplist words “%s”"),
 122                     join(', ', $pages->stoplisted))),
 123                 $list);
 124         if ($noheader)
 125             return $list;
 126         return HTML(HTML::p(fmt("Full text search results for “%s”", $s)),
 127             $list);
 128     }
 129
 130     function showhits($page, $hilight_re)
 131     {
 132         $current = $page->getCurrentRevision();
 133         $matches = preg_grep("/$hilight_re/i", $current->getContent());
 134         $html = array();
 135         foreach ($matches as $line) {
 136             $line = $this->highlight_line($line, $hilight_re);
 137             $html[] = HTML::dd(HTML::small(array('class' => 'search-context'),
 138                 $line));
 139         }
 140         return $html;
 141     }
 142
 143     function highlight_line($line, $hilight_re)
 144     {
 145         while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
 146             $line = substr($line, strlen($m[0]));
 147             $html[] = $m[1]; // prematch
 148             $html[] = HTML::strong(array('class' => 'search-term'), $m[2]); // match
 149         }
 150         $html[] = $line; // postmatch
 151         return $html;
 152     }
 153 }
 154
 155 /*
 156  * List of Links and link to ListLinks
 157  */
 158 class _PageList_Column_hilight extends _PageList_Column
 159 {
 160     function _PageList_Column_WantedPages_links(&$params)
 161     {
 162         $this->parentobj =& $params[3];
 163         $this->_PageList_Column($params[0], $params[1], $params[2]);
 164     }
 165
 166     function _getValue(&$page, $revision_handle)
 167     {
 168         $pagename = $page->getName();
 169         $count = count($this->parentobj->_wpagelist[$pagename]);
 170         return LinkURL(WikiURL($page, array('action' => 'BackLinks'), false),
 171             fmt("(%d Links)", $count));
 172     }
 173 }
 174
 175 // Local Variables:
 176 // mode: php
 177 // tab-width: 8
 178 // c-basic-offset: 4
 179 // c-hanging-comment-ender-p: nil
 180 // indent-tabs-mode: nil
 181 // End: