lib/plugin/TitleSearch.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: TitleSearch.php,v 1.26 2004-11-27 14:39:05 rurban Exp $');
   3 /**
   4  Copyright 1999, 2000, 2001, 2002, 2004 $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
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 require_once('lib/TextSearchQuery.php');
  24 require_once('lib/PageList.php');
  25
  26 /**
  27  * Display results of pagename search.
  28  * Provides no own input box, just <?plugin-form TitleSearch ?> is enough.
  29  * Fancier Inputforms can be made using WikiForm Rich, to support regex and case_exact args.
  30  *
  31  * If only one pages is found and auto_redirect is true, this page is displayed immediatly,
  32  * otherwise the found pagelist is displayed.
  33  * The workhorse TextSearchQuery converts the query string from google-style words
  34  * to the required DB backend expression.
  35  *   (word and word) OR word, -word, "two words"
  36  * regex=auto tries to detect simple glob-style wildcards and expressions,
  37  * like xx*, *xx, ^xx, xx$, ^word$.
  38  */
  39 class WikiPlugin_TitleSearch
  40 extends WikiPlugin
  41 {
  42     function getName () {
  43         return _("TitleSearch");
  44     }
  45
  46     function getDescription () {
  47         return _("Search the titles of all pages in this wiki.");
  48     }
  49
  50     function getVersion() {
  51         return preg_replace("/[Revision: $]/", '',
  52                             "\$Revision: 1.26 $");
  53     }
  54
  55     function getDefaultArguments() {
  56         return array_merge
  57             (
  58              PageList::supportedArgs(), // paging and more.
  59              array('s'             => false,
  60                    'auto_redirect' => false,
  61                    'noheader'      => false,
  62                    'exclude'       => false,
  63                    'info'          => false,
  64                    'case_exact'    => false,
  65                    'regex'         => 'auto',
  66                    ));
  67     }
  68     // info arg allows multiple columns
  69     // info=mtime,hits,summary,version,author,locked,minor
  70     // exclude arg allows multiple pagenames exclude=Php*,RecentChanges
  71
  72     function run($dbi, $argstr, &$request, $basepage) {
  73         $args = $this->getArgs($argstr, $request);
  74         if (empty($args['s']))
  75             return '';
  76
  77         $query = new TextSearchQuery($args['s'], $args['case_exact'], $args['regex']);
  78         $pages = $dbi->titleSearch($query);
  79
  80         $pagelist = new PageList($args['info'], $args['exclude'], $args);
  81         while ($page = $pages->next()) {
  82             $pagelist->addPage($page);
  83             $last_name = $page->getName();
  84         }
  85         // Provide an unknown WikiWord link to allow for page creation
  86         // when a search returns no results
  87         if (!$args['noheader']) {
  88             $s = $args['s'];
  89             if (!$pagelist->getTotal() and !$query->_regex)
  90                 $s = WikiLink($args['s'], 'auto');
  91             $pagelist->setCaption(fmt("Title search results for '%s'", $s));
  92         }
  93
  94         if ($args['auto_redirect'] && ($pagelist->getTotal() == 1)) {
  95             return HTML($request->redirect(WikiURL($last_name, false, 'absurl'), false),
  96                         $pagelist);
  97         }
  98
  99         return $pagelist;
 100     }
 101 };
 102
 103 // $Log: not supported by cvs2svn $
 104 // Revision 1.25  2004/11/26 18:39:02  rurban
 105 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
 106 //
 107 // Revision 1.24  2004/11/25 08:30:58  rurban
 108 // dont extract args
 109 //
 110 // Revision 1.23  2004/11/23 15:17:19  rurban
 111 // better support for case_exact search (not caseexact for consistency),
 112 // plugin args simplification:
 113 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 114 //     and exclude in advance (at the sql level if possible)
 115 //   handle sortby and limit from request override in WikiPlugin::getArgs
 116 // ListSubpages: renamed pages to maxpages
 117 //
 118 // Revision 1.22  2004/11/23 13:35:49  rurban
 119 // add case_exact search
 120 //
 121 // Revision 1.21  2004/02/17 12:11:36  rurban
 122 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
 123 //
 124 // Revision 1.20  2003/11/02 20:42:35  carstenklapp
 125 // Allow for easy page creation when search returns no matches.
 126 // Based on cuthbertcat's patch, SF#655090 2002-12-17.
 127 //
 128 // Revision 1.19  2003/03/07 02:50:16  dairiki
 129 // Fixes for new javascript redirect.
 130 //
 131 // Revision 1.18  2003/02/21 04:16:51  dairiki
 132 // Don't NORETURN from redirect.
 133 //
 134 // Revision 1.17  2003/01/18 22:08:01  carstenklapp
 135 // Code cleanup:
 136 // Reformatting & tabs to spaces;
 137 // Added copyleft, getVersion, getDescription, rcs_id.
 138 //
 139
 140 // Local Variables:
 141 // mode: php
 142 // tab-width: 8
 143 // c-basic-offset: 4
 144 // c-hanging-comment-ender-p: nil
 145 // indent-tabs-mode: nil
 146 // End:
 147 ?>