lib/plugin/TitleSearch.php

   1 <?php // -*-php-*-
   2
   3 /**
   4  * Copyright 1999,2000,2001,2002,2004,2005,2010 $ThePhpWikiProgrammingTeam
   5  * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   6  *
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 require_once 'lib/TextSearchQuery.php';
  25 require_once 'lib/PageList.php';
  26
  27 /**
  28  * Display results of pagename search.
  29  * Provides no own input box, just <?plugin-form TitleSearch?> is enough.
  30  * Fancier Inputforms can be made using <<WikiFormRich ...>> to support regex and case_exact args.
  31  *
  32  * If only one pages is found and auto_redirect is true, this page is displayed immediatly,
  33  * otherwise the found pagelist is displayed.
  34  * The workhorse TextSearchQuery converts the query string from google-style words
  35  * to the required DB backend expression.
  36  *   (word and word) OR word, -word, "two words"
  37  * regex=auto tries to detect simple glob-style wildcards and expressions,
  38  * like xx*, *xx, ^xx, xx$, ^word$.
  39  */
  40 class WikiPlugin_TitleSearch
  41 extends WikiPlugin
  42 {
  43     function getName () {
  44         return _("TitleSearch");
  45     }
  46
  47     function getDescription () {
  48         return _("Search the titles of all pages in this wiki.");
  49     }
  50
  51     function getDefaultArguments() {
  52         return array_merge
  53             (
  54              PageList::supportedArgs(), // paging and more.
  55              array('s'             => false,
  56                    'auto_redirect' => false,
  57                    'noheader'      => false,
  58                    'exclude'       => false,
  59                    'info'          => false,
  60                    'case_exact'    => false,
  61                    'regex'         => 'auto',
  62                    'format'        => false,
  63                    ));
  64     }
  65     // info arg allows multiple columns
  66     // info=mtime,hits,summary,version,author,locked,minor
  67     // exclude arg allows multiple pagenames exclude=Php*,RecentChanges
  68
  69     function run($dbi, $argstr, &$request, $basepage) {
  70         $args = $this->getArgs($argstr, $request);
  71         if (empty($args['s'])) {
  72             return HTML();
  73         }
  74
  75         // ^S != S*   ^  matches only beginning of phrase, not of word.
  76         //            x* matches any word beginning with x
  77         $query = new TextSearchQuery($args['s'], $args['case_exact'], $args['regex']);
  78         $pages = $dbi->titleSearch($query,$args['sortby'],$args['limit'],$args['exclude']);
  79
  80         $pagelist = new PageList($args['info'], $args['exclude'], $args);
  81         $pagelist->addPages($pages);
  82
  83         // Provide an unknown WikiWord link to allow for page creation
  84         // when a search returns no results
  85         if (!$args['noheader']) {
  86             $s = $args['s'];
  87             $total = $pagelist->getTotal();
  88             if (!$total and !$query->_regex) {
  89                 $s = WikiLink($args['s'], 'auto');
  90             }
  91             if ($total) {
  92                 $pagelist->setCaption(fmt("Title search results for '%s' (%d total)", $s, $total));
  93             } else {
  94                 $pagelist->setCaption(fmt("Title search results for '%s'", $s));
  95             }
  96         }
  97
  98         if ($args['auto_redirect'] && ($pagelist->getTotal() == 1)) {
  99             $page = $pagelist->first();
 100             $request->redirect(WikiURL($page->getName(), false, 'absurl'), false);
 101         }
 102
 103         return $pagelist;
 104     }
 105 };
 106
 107 // Local Variables:
 108 // mode: php
 109 // tab-width: 8
 110 // c-basic-offset: 4
 111 // c-hanging-comment-ender-p: nil
 112 // indent-tabs-mode: nil
 113 // End: