lib/plugin/AllPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: AllPages.php,v 1.36 2005-01-28 12:08:42 rurban Exp $');
   3 /**
   4  Copyright 1999,2000,2001,2002,2004,2005 $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.36 $");
  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         $pages = false;
  68         // Todo: extend given _GET args
  69         if ($args['debug'])
  70             $timer = new DebugTimer;
  71         $caption = _("All pages in this wiki (%d total):");
  72
  73         if ( !empty($args['owner']) ) {
  74             $pages = PageList::allPagesByOwner($args['owner'], $args['include_empty'],
  75                                                $args['sortby'], $args['limit']);
  76             if ($args['owner'])
  77                 $caption = fmt("List of pages owned by [%s] (%d total):",
  78                                WikiLink($args['owner'] == '[]'
  79                                         ? $request->_user->getAuthenticatedId()
  80                                         : $args['owner'],
  81                                         'if_known'),
  82                                count($pages));
  83         } elseif ( !empty($args['author']) ) {
  84             $pages = PageList::allPagesByAuthor($args['author'], $args['include_empty'],
  85                                                 $args['sortby'], $args['limit']);
  86             if ($args['author'])
  87                 $caption = fmt("List of pages last edited by [%s] (%d total):",
  88                                WikiLink($args['author'] == '[]'
  89                                         ? $request->_user->getAuthenticatedId()
  90                                         : $args['author'],
  91                                         'if_known'),
  92                                count($pages));
  93         } elseif ( !empty($args['creator']) ) {
  94             $pages = PageList::allPagesByCreator($args['creator'], $args['include_empty'],
  95                                                  $args['sortby'], $args['limit']);
  96             if ($args['creator'])
  97                 $caption = fmt("List of pages created by [%s] (%d total):",
  98                                WikiLink($args['creator'] == '[]'
  99                                         ? $request->_user->getAuthenticatedId()
 100                                         : $args['creator'],
 101                                         'if_known'),
 102                                count($pages));
 103         //} elseif ($pages) {
 104         //    $args['count'] = count($pages);
 105         } else {
 106             if (! $request->getArg('count'))
 107                 $args['count'] = $dbi->numPages($args['include_empty'], $args['exclude']);
 108             else $args['count'] = $request->getArg('count');
 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'],
 123                                                    $args['limit']) );
 124         if ($args['debug']) {
 125             return HTML($pagelist,
 126                         HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
 127         } else {
 128             return $pagelist;
 129         }
 130     }
 131
 132     function getmicrotime(){
 133         list($usec, $sec) = explode(" ",microtime());
 134         return (float)$usec + (float)$sec;
 135     }
 136 };
 137
 138 // $Log: not supported by cvs2svn $
 139 // Revision 1.35  2004/12/06 19:50:04  rurban
 140 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
 141 // renamed delete_page to purge_page.
 142 // enable action=edit&version=-1 to force creation of a new version.
 143 // added BABYCART_PATH config
 144 // fixed magiqc in adodb.inc.php
 145 // and some more docs
 146 //
 147 // Revision 1.34  2004/11/23 15:17:19  rurban
 148 // better support for case_exact search (not caseexact for consistency),
 149 // plugin args simplification:
 150 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 151 //     and exclude in advance (at the sql level if possible)
 152 //   handle sortby and limit from request override in WikiPlugin::getArgs
 153 // ListSubpages: renamed pages to maxpages
 154 //
 155 // Revision 1.33  2004/11/01 10:43:59  rurban
 156 // seperate PassUser methods into seperate dir (memory usage)
 157 // fix WikiUser (old) overlarge data session
 158 // remove wikidb arg from various page class methods, use global ->_dbi instead
 159 // ...
 160 //
 161 // Revision 1.32  2004/10/05 17:00:04  rurban
 162 // support paging for simple lists
 163 // fix RatingDb sql backend.
 164 // remove pages from AllPages (this is ListPages then)
 165 //
 166 // Revision 1.31  2004/09/17 14:25:45  rurban
 167 // update comments
 168 //
 169 // Revision 1.30  2004/07/09 10:06:50  rurban
 170 // Use backend specific sortby and sortable_columns method, to be able to
 171 // select between native (Db backend) and custom (PageList) sorting.
 172 // Fixed PageList::AddPageList (missed the first)
 173 // Added the author/creator.. name to AllPagesBy...
 174 //   display no pages if none matched.
 175 // Improved dba and file sortby().
 176 // Use &$request reference
 177 //
 178 // Revision 1.29  2004/07/08 21:32:36  rurban
 179 // Prevent from more warnings, minor db and sort optimizations
 180 //
 181 // Revision 1.28  2004/07/08 20:30:07  rurban
 182 // plugin->run consistency: request as reference, added basepage.
 183 // encountered strange bug in AllPages (and the test) which destroys ->_dbi
 184 //
 185 // Revision 1.27  2004/07/08 17:31:43  rurban
 186 // improve numPages for file (fixing AllPagesTest)
 187 //
 188 // Revision 1.26  2004/06/21 16:22:32  rurban
 189 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
 190 // fixed dumping buttons locally (images/buttons/),
 191 // support pages arg for dumphtml,
 192 // optional directory arg for dumpserial + dumphtml,
 193 // fix a AllPages warning,
 194 // show dump warnings/errors on DEBUG,
 195 // don't warn just ignore on wikilens pagelist columns, if not loaded.
 196 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
 197 //
 198 // Revision 1.25  2004/06/14 11:31:38  rurban
 199 // renamed global $Theme to $WikiTheme (gforge nameclash)
 200 // inherit PageList default options from PageList
 201 //   default sortby=pagename
 202 // use options in PageList_Selectable (limit, sortby, ...)
 203 // added action revert, with button at action=diff
 204 // added option regex to WikiAdminSearchReplace
 205 //
 206 // Revision 1.24  2004/06/13 16:02:12  rurban
 207 // empty list of pages if user=[] and not authenticated.
 208 //
 209 // Revision 1.23  2004/06/13 15:51:37  rurban
 210 // Support pagelist filter for current author,owner,creator by []
 211 //
 212 // Revision 1.22  2004/06/13 15:33:20  rurban
 213 // new support for arguments owner, author, creator in most relevant
 214 // PageList plugins. in WikiAdmin* via preSelectS()
 215 //
 216 // Revision 1.21  2004/04/20 00:06:53  rurban
 217 // paging support
 218 //
 219 // Revision 1.20  2004/02/22 23:20:33  rurban
 220 // fixed DumpHtmlToDir,
 221 // enhanced sortby handling in PageList
 222 //   new button_heading th style (enabled),
 223 // added sortby and limit support to the db backends and plugins
 224 //   for paging support (<<prev, next>> links on long lists)
 225 //
 226 // Revision 1.19  2004/02/17 12:11:36  rurban
 227 // 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, ...)
 228 //
 229 // Revision 1.18  2004/01/25 07:58:30  rurban
 230 // PageList sortby support in PearDB and ADODB backends
 231 //
 232 // Revision 1.17  2003/02/27 20:10:30  dairiki
 233 // Disable profiling output when DEBUG is defined but false.
 234 //
 235 // Revision 1.16  2003/02/21 04:08:26  dairiki
 236 // New class DebugTimer in prepend.php to help report timing.
 237 //
 238 // Revision 1.15  2003/01/18 21:19:25  carstenklapp
 239 // Code cleanup:
 240 // Reformatting; added copyleft, getVersion, getDescription
 241 //
 242
 243 // Local Variables:
 244 // mode: php
 245 // tab-width: 8
 246 // c-basic-offset: 4
 247 // c-hanging-comment-ender-p: nil
 248 // indent-tabs-mode: nil
 249 // End:
 250 ?>