lib/plugin/AllPages.php

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