lib/plugin/LikePages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: LikePages.php,v 1.19 2004-02-17 12:11:36 rurban Exp $');
   3 /**
   4  Copyright 1999, 2000, 2001, 2002 $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  */
  28 class WikiPlugin_LikePages
  29 extends WikiPlugin
  30 {
  31     function getName() {
  32         return _("LikePages");
  33     }
  34
  35     function getDescription() {
  36         return sprintf(_("List page names which share an initial or final title word with '%s'."),
  37                        '[pagename]');
  38     }
  39
  40     function getVersion() {
  41         return preg_replace("/[Revision: $]/", '',
  42                             "\$Revision: 1.19 $");
  43     }
  44
  45     function getDefaultArguments() {
  46         return array('page'     => '[pagename]',
  47                      'prefix'   => false,
  48                      'suffix'   => false,
  49                      'exclude'  => '',
  50                      'noheader' => false,
  51                      'info'     => ''
  52                      );
  53     }
  54     // info arg allows multiple columns
  55     // info=mtime,hits,summary,version,author,locked,minor
  56     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  57
  58     function run($dbi, $argstr, &$request, $basepage) {
  59         $args = $this->getArgs($argstr, $request);
  60         extract($args);
  61         if (empty($page) && empty($prefix) && empty($suffix))
  62             return '';
  63
  64         if ($prefix) {
  65             $suffix = false;
  66             $descrip = fmt("Page names with prefix '%s'", $prefix);
  67         }
  68         elseif ($suffix) {
  69             $descrip = fmt("Page names with suffix '%s'", $suffix);
  70         }
  71         elseif ($page) {
  72             $words = preg_split('/[\s:-;.,]+/',
  73                                 split_pagename($page));
  74             $words = preg_grep('/\S/', $words);
  75
  76             $prefix = reset($words);
  77             $suffix = end($words);
  78
  79             $descrip = fmt("These pages share an initial or final title word with '%s'",
  80                            WikiLink($page, 'auto'));
  81         }
  82
  83         // Search for pages containing either the suffix or the prefix.
  84         $search = $match = array();
  85         if (!empty($prefix)) {
  86             $search[] = $this->_quote($prefix);
  87             $match[]  = '^' . preg_quote($prefix, '/');
  88         }
  89         if (!empty($suffix)) {
  90             $search[] = $this->_quote($suffix);
  91             $match[]  = preg_quote($suffix, '/') . '$';
  92         }
  93
  94         if ($search)
  95             $query = new TextSearchQuery(join(' OR ', $search));
  96         else
  97             $query = new NullTextSearchQuery; // matches nothing
  98
  99         $match_re = '/' . join('|', $match) . '/';
 100
 101         $pagelist = new PageList($info, $exclude);
 102         if (!$noheader)
 103             $pagelist->setCaption($descrip);
 104
 105         $pages = $dbi->titleSearch($query);
 106
 107         while ($page = $pages->next()) {
 108             $name = $page->getName();
 109             if (!preg_match($match_re, $name))
 110                 continue;
 111             $pagelist->addPage($page);
 112         }
 113
 114         return $pagelist;
 115     }
 116
 117     function _quote($str) {
 118         return "'" . str_replace("'", "''", $str) . "'";
 119     }
 120 };
 121
 122 // $Log: not supported by cvs2svn $
 123 // Revision 1.18  2003/01/18 21:48:52  carstenklapp
 124 // Code cleanup:
 125 // Reformatting & tabs to spaces;
 126 // Added copyleft, getVersion, getDescription, rcs_id.
 127 //
 128
 129 // Local Variables:
 130 // mode: php
 131 // tab-width: 8
 132 // c-basic-offset: 4
 133 // c-hanging-comment-ender-p: nil
 134 // indent-tabs-mode: nil
 135 // End:
 136 ?>