lib/plugin/FullTextSearch.php

   1 <?php // -*-php-*-
   2 // $Id$
   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         return _("FullTextSearch");
  47     }
  48
  49     function getDescription() {
  50         return _("Search the content of all pages in this wiki.");
  51     }
  52
  53     function getDefaultArguments() {
  54         return array_merge
  55             (
  56              PageList::supportedArgs(), // paging and more.
  57              array('s'        => false,
  58                    'hilight'  => true,
  59                    'case_exact' => false,
  60                    'regex'    => 'auto',
  61                    'sortby'   => '-hi_content',
  62                    'noheader' => false,
  63                    'exclude'  => false,   // comma-seperated list of glob
  64                    'quiet'    => true));  // be less verbose
  65     }
  66
  67     function run($dbi, $argstr, &$request, $basepage) {
  68
  69         $args = $this->getArgs($argstr, $request);
  70
  71         if (empty($args['s'])) {
  72             return HTML();
  73         }
  74         extract($args);
  75
  76         $query = new TextSearchQuery($s, $case_exact, $regex);
  77         $pages = $dbi->fullSearch($query, $sortby, $limit, $exclude);
  78         $lines = array();
  79         $hilight_re = $hilight ? $query->getHighlightRegexp() : false;
  80         $count = 0;
  81
  82         if ($quiet) { // see how easy it is with PageList...
  83             unset($args['info']);
  84             $args['listtype'] = 'dl';
  85             $args['types'] = array(new _PageList_Column_content
  86               ('rev:hi_content', _("Content"), "left", $s, $hilight_re));
  87             $list = new PageList(false, $exclude, $args);
  88             $list->setCaption(fmt("Full text search results for '%s'", $s));
  89             while ($page = $pages->next()) {
  90                 $list->addPage( $page );
  91             }
  92             return $list;
  93         }
  94
  95         // Todo: we should better define a new PageListDL class for dl/dt/dd lists
  96         // But the new column types must have a callback then. (showhits)
  97         // See e.g. WikiAdminSearchReplace for custom pagelist columns
  98         $list = HTML::dl();
  99         if (!$limit or !is_int($limit))
 100             $limit = 0;
 101         // expand all page wildcards to a list of pages which should be ignored
 102         if ($exclude) $exclude = explodePageList($exclude);
 103         while ($page = $pages->next() and (!$limit or ($count < $limit))) {
 104             $name = $page->getName();
 105             if ($exclude and in_array($name,$exclude)) continue;
 106             $count++;
 107             $list->pushContent(HTML::dt(WikiLink($page)));
 108             if ($hilight_re)
 109                 $list->pushContent($this->showhits($page, $hilight_re));
 110             unset($page);
 111         }
 112         if ($limit and $count >= $limit) //todo: pager link to list of next matches
 113             $list->pushContent(HTML::dd(fmt("only %d pages displayed",$limit)));
 114         if (!$list->getContent())
 115             $list->pushContent(HTML::dd(_("<no matches>")));
 116
 117         if (!empty($pages->stoplisted))
 118             $list = HTML(HTML::p(fmt(_("Ignored stoplist words '%s'"),
 119                                      join(', ', $pages->stoplisted))),
 120                          $list);
 121         if ($noheader)
 122             return $list;
 123         return HTML(HTML::p(fmt("Full text search results for '%s'", $s)),
 124                     $list);
 125     }
 126
 127     function showhits($page, $hilight_re) {
 128         $current = $page->getCurrentRevision();
 129         $matches = preg_grep("/$hilight_re/i", $current->getContent());
 130         $html = array();
 131         foreach ($matches as $line) {
 132             $line = $this->highlight_line($line, $hilight_re);
 133             $html[] = HTML::dd(HTML::small(array('class' => 'search-context'),
 134                                            $line));
 135         }
 136         return $html;
 137     }
 138
 139     function highlight_line ($line, $hilight_re) {
 140         while (preg_match("/^(.*?)($hilight_re)/i", $line, $m)) {
 141             $line = substr($line, strlen($m[0]));
 142             $html[] = $m[1];    // prematch
 143             $html[] = HTML::strong(array('class' => 'search-term'), $m[2]); // match
 144         }
 145         $html[] = $line;        // postmatch
 146         return $html;
 147     }
 148 };
 149
 150 /*
 151  * List of Links and link to ListLinks
 152  */
 153 class _PageList_Column_hilight extends _PageList_Column {
 154     function _PageList_Column_WantedPages_links (&$params) {
 155         $this->parentobj =& $params[3];
 156         $this->_PageList_Column($params[0],$params[1],$params[2]);
 157     }
 158     function _getValue(&$page, $revision_handle) {
 159             $html = false;
 160         $pagename = $page->getName();
 161         $count = count($this->parentobj->_wpagelist[$pagename]);
 162         return LinkURL(WikiURL($page, array('action' => 'BackLinks'), false),
 163                         fmt("(%d Links)", $count));
 164     }
 165 }
 166
 167 // Local Variables:
 168 // mode: php
 169 // tab-width: 8
 170 // c-basic-offset: 4
 171 // c-hanging-comment-ender-p: nil
 172 // indent-tabs-mode: nil
 173 // End:
 174 ?>