lib/plugin/AllPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: AllPages.php,v 1.32 2004-10-05 17:00:04 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/PageList.php');
  24
  25 /**
  26  * DONE: support author=[] (current user) and owner, creator
  27  * to be able to have pages:
  28  * AllPagesCreatedByMe, AllPagesOwnedByMe, AllPagesLastAuthoredByMe
  29  */
  30 class WikiPlugin_AllPages
  31 extends WikiPlugin
  32 {
  33     function getName () {
  34         return _("AllPages");
  35     }
  36
  37     function getDescription () {
  38         return _("List all pages in this wiki.");
  39     }
  40
  41     function getVersion() {
  42         return preg_replace("/[Revision: $]/", '',
  43                             "\$Revision: 1.32 $");
  44     }
  45
  46     function getDefaultArguments() {
  47         return array_merge
  48             (
  49              PageList::supportedArgs(),
  50              array(
  51                    'noheader'      => false,
  52                    'include_empty' => false,
  53                    //'pages'         => false, // DONT, this would be ListPages then.
  54                    'info'          => '',
  55                    'debug'         => false
  56                    ));
  57     }
  58
  59     // info arg allows multiple columns
  60     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  61     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  62     // sortby: [+|-] pagename|mtime|hits
  63
  64     // 2004-07-08 22:05:35 rurban: turned off &$request to prevent from strange bug below
  65     function run($dbi, $argstr, &$request, $basepage) {
  66         $args = $this->getArgs($argstr, $request);
  67         // very strange php reference bug: dbi gets destroyed at array_merge with defaults
  68         if (!is_object($dbi)) $dbi = $request->getDbh();
  69         if (!is_object($request->_dbi)) {
  70                 trigger_error("strange php reference bug destroyed request->_dbi", E_USER_WARNING);
  71                 return HTML();
  72         }
  73         //extract($args);
  74         //$pages = isset($args['pages']) ? $args['pages'] : false;
  75         // Todo: extend given _GET args
  76         // TODO: shouldn't the REQUEST sortby,limit override be handled in getArgs for all?
  77         if ($sorted = $request->getArg('sortby'))
  78             $args['sortby'] = $sorted;
  79         elseif (!empty($args['sortby']))
  80             $request->setArg('sortby', $args['sortby']);
  81         if ($args['debug'])
  82             $timer = new DebugTimer;
  83         $caption = _("All pages in this wiki (%d total):");
  84
  85         if ( !empty($args['owner']) ) {
  86             $pages = PageList::allPagesByOwner($args['owner'],$args['include_empty'],$args['sortby'],$args['limit']);
  87             if ($args['owner'])
  88                 $caption = fmt("List of pages owned by [%s] (%d total):",
  89                                WikiLink($args['owner'], 'if_known'),
  90                                count($pages));
  91         } elseif ( !empty($args['author']) ) {
  92             $pages = PageList::allPagesByAuthor($args['author'],$args['include_empty'],$args['sortby'],$args['limit']);
  93             if ($args['author'])
  94                 $caption = fmt("List of pages last edited by [%s] (%d total):",
  95                                WikiLink($args['author'], 'if_known'),
  96                                count($pages));
  97         } elseif ( !empty($args['creator']) ) {
  98             $pages = PageList::allPagesByCreator($args['creator'],$args['include_empty'],$args['sortby'],$args['limit']);
  99             if ($args['creator'])
 100                 $caption = fmt("List of pages created by [%s] (%d total):",
 101                                WikiLink($args['creator'], 'if_known'),
 102                                count($pages));
 103         //} elseif ($pages) {
 104         //    $args['count'] = count($pages);
 105         } else {
 106             if (! $request->getArg('count'))  $args['count'] = $dbi->numPages($args['include_empty'],$args['exclude']);
 107             else $args['count'] = $request->getArg('count');
 108             //$pages = false; // ??
 109         }
 110         //if (empty($args['count']) and !empty($pages))
 111         //    $args['count'] = count($pages);
 112         $pagelist = new PageList($args['info'], $args['exclude'], $args);
 113         if (!$args['noheader']) $pagelist->setCaption($caption);
 114
 115         // deleted pages show up as version 0.
 116         if ($args['include_empty'])
 117             $pagelist->_addColumn('version');
 118
 119         /*if ($pages !== false)
 120             $pagelist->addPageList($pages);
 121         else */
 122         $pagelist->addPages( $dbi->getAllPages($args['include_empty'], $args['sortby'], $args['limit']) );
 123         if ($args['debug']) {
 124             return HTML($pagelist,
 125                         HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
 126         } else {
 127             return $pagelist;
 128         }
 129     }
 130
 131     function getmicrotime(){
 132         list($usec, $sec) = explode(" ",microtime());
 133         return (float)$usec + (float)$sec;
 134     }
 135 };
 136
 137 // $Log: not supported by cvs2svn $
 138 // Revision 1.31  2004/09/17 14:25:45  rurban
 139 // update comments
 140 //
 141 // Revision 1.30  2004/07/09 10:06:50  rurban
 142 // Use backend specific sortby and sortable_columns method, to be able to
 143 // select between native (Db backend) and custom (PageList) sorting.
 144 // Fixed PageList::AddPageList (missed the first)
 145 // Added the author/creator.. name to AllPagesBy...
 146 //   display no pages if none matched.
 147 // Improved dba and file sortby().
 148 // Use &$request reference
 149 //
 150 // Revision 1.29  2004/07/08 21:32:36  rurban
 151 // Prevent from more warnings, minor db and sort optimizations
 152 //
 153 // Revision 1.28  2004/07/08 20:30:07  rurban
 154 // plugin->run consistency: request as reference, added basepage.
 155 // encountered strange bug in AllPages (and the test) which destroys ->_dbi
 156 //
 157 // Revision 1.27  2004/07/08 17:31:43  rurban
 158 // improve numPages for file (fixing AllPagesTest)
 159 //
 160 // Revision 1.26  2004/06/21 16:22:32  rurban
 161 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
 162 // fixed dumping buttons locally (images/buttons/),
 163 // support pages arg for dumphtml,
 164 // optional directory arg for dumpserial + dumphtml,
 165 // fix a AllPages warning,
 166 // show dump warnings/errors on DEBUG,
 167 // don't warn just ignore on wikilens pagelist columns, if not loaded.
 168 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
 169 //
 170 // Revision 1.25  2004/06/14 11:31:38  rurban
 171 // renamed global $Theme to $WikiTheme (gforge nameclash)
 172 // inherit PageList default options from PageList
 173 //   default sortby=pagename
 174 // use options in PageList_Selectable (limit, sortby, ...)
 175 // added action revert, with button at action=diff
 176 // added option regex to WikiAdminSearchReplace
 177 //
 178 // Revision 1.24  2004/06/13 16:02:12  rurban
 179 // empty list of pages if user=[] and not authenticated.
 180 //
 181 // Revision 1.23  2004/06/13 15:51:37  rurban
 182 // Support pagelist filter for current author,owner,creator by []
 183 //
 184 // Revision 1.22  2004/06/13 15:33:20  rurban
 185 // new support for arguments owner, author, creator in most relevant
 186 // PageList plugins. in WikiAdmin* via preSelectS()
 187 //
 188 // Revision 1.21  2004/04/20 00:06:53  rurban
 189 // paging support
 190 //
 191 // Revision 1.20  2004/02/22 23:20:33  rurban
 192 // fixed DumpHtmlToDir,
 193 // enhanced sortby handling in PageList
 194 //   new button_heading th style (enabled),
 195 // added sortby and limit support to the db backends and plugins
 196 //   for paging support (<<prev, next>> links on long lists)
 197 //
 198 // Revision 1.19  2004/02/17 12:11:36  rurban
 199 // 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, ...)
 200 //
 201 // Revision 1.18  2004/01/25 07:58:30  rurban
 202 // PageList sortby support in PearDB and ADODB backends
 203 //
 204 // Revision 1.17  2003/02/27 20:10:30  dairiki
 205 // Disable profiling output when DEBUG is defined but false.
 206 //
 207 // Revision 1.16  2003/02/21 04:08:26  dairiki
 208 // New class DebugTimer in prepend.php to help report timing.
 209 //
 210 // Revision 1.15  2003/01/18 21:19:25  carstenklapp
 211 // Code cleanup:
 212 // Reformatting; added copyleft, getVersion, getDescription
 213 //
 214
 215 // Local Variables:
 216 // mode: php
 217 // tab-width: 8
 218 // c-basic-offset: 4
 219 // c-hanging-comment-ender-p: nil
 220 // indent-tabs-mode: nil
 221 // End:
 222 ?>