lib/plugin/AllPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: AllPages.php,v 1.27 2004-07-08 17:31:43 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.27 $");
  44     }
  45
  46     function getDefaultArguments() {
  47         return array_merge
  48             (
  49              PageList::supportedArgs(),
  50              array(
  51                    'noheader'      => false,
  52                    'include_empty' => false,
  53                    'info'          => '',
  54                    'debug'         => false
  55                    ));
  56     }
  57     // info arg allows multiple columns
  58     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  59     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  60     // sortby: [+|-] pagename|mtime|hits
  61
  62     function run($dbi, $argstr, &$request, $basepage) {
  63         $args = $this->getArgs($argstr, $request);
  64         extract($args);
  65         // Todo: extend given _GET args
  66         if ($sorted = $request->getArg('sortby'))
  67             $sortby = $sorted;
  68         elseif ($sortby)
  69             $request->setArg('sortby',$sortby);
  70
  71         if ($debug)
  72             $timer = new DebugTimer;
  73         if ( !empty($args['owner']) )
  74             $pages = PageList::allPagesByOwner($args['owner'],$include_empty,$args['sortby'],$args['limit']);
  75         elseif ( !empty($args['author']) )
  76             $pages = PageList::allPagesByAuthor($args['author'],$include_empty,$args['sortby'],$args['limit']);
  77         elseif ( !empty($args['creator']) ) {
  78             $pages = PageList::allPagesByCreator($args['creator'],$include_empty,$args['sortby'],$args['limit']);
  79         } else {
  80             if (! $request->getArg('count'))  $args['count'] = $dbi->numPages(false,$exclude);
  81             else $args['count'] = $request->getArg('count');
  82             $pages = false;
  83         }
  84         if (empty($args['count']) and is_array($pages))
  85             $args['count'] = count($pages);
  86         $pagelist = new PageList($info, $exclude, $args);
  87         //if (!$sortby) $sorted='pagename';
  88         if (!$noheader) {
  89             if (!is_array($pages))
  90                 $pagelist->setCaption(_("All pages in this wiki (%d total):"));
  91             else
  92                 $pagelist->setCaption(_("List of pages (%d total):"));
  93         }
  94
  95         // deleted pages show up as version 0.
  96         if ($include_empty)
  97             $pagelist->_addColumn('version');
  98
  99         if (is_array($pages))
 100             $pagelist->addPageList($pages);
 101         else
 102             $pagelist->addPages( $dbi->getAllPages($include_empty, $sortby, $limit) );
 103         if ($debug) {
 104             return HTML($pagelist,
 105                         HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
 106         } else {
 107             return $pagelist;
 108         }
 109     }
 110
 111     function getmicrotime(){
 112         list($usec, $sec) = explode(" ",microtime());
 113         return (float)$usec + (float)$sec;
 114     }
 115 };
 116
 117 // $Log: not supported by cvs2svn $
 118 // Revision 1.26  2004/06/21 16:22:32  rurban
 119 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
 120 // fixed dumping buttons locally (images/buttons/),
 121 // support pages arg for dumphtml,
 122 // optional directory arg for dumpserial + dumphtml,
 123 // fix a AllPages warning,
 124 // show dump warnings/errors on DEBUG,
 125 // don't warn just ignore on wikilens pagelist columns, if not loaded.
 126 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
 127 //
 128 // Revision 1.25  2004/06/14 11:31:38  rurban
 129 // renamed global $Theme to $WikiTheme (gforge nameclash)
 130 // inherit PageList default options from PageList
 131 //   default sortby=pagename
 132 // use options in PageList_Selectable (limit, sortby, ...)
 133 // added action revert, with button at action=diff
 134 // added option regex to WikiAdminSearchReplace
 135 //
 136 // Revision 1.24  2004/06/13 16:02:12  rurban
 137 // empty list of pages if user=[] and not authenticated.
 138 //
 139 // Revision 1.23  2004/06/13 15:51:37  rurban
 140 // Support pagelist filter for current author,owner,creator by []
 141 //
 142 // Revision 1.22  2004/06/13 15:33:20  rurban
 143 // new support for arguments owner, author, creator in most relevant
 144 // PageList plugins. in WikiAdmin* via preSelectS()
 145 //
 146 // Revision 1.21  2004/04/20 00:06:53  rurban
 147 // paging support
 148 //
 149 // Revision 1.20  2004/02/22 23:20:33  rurban
 150 // fixed DumpHtmlToDir,
 151 // enhanced sortby handling in PageList
 152 //   new button_heading th style (enabled),
 153 // added sortby and limit support to the db backends and plugins
 154 //   for paging support (<<prev, next>> links on long lists)
 155 //
 156 // Revision 1.19  2004/02/17 12:11:36  rurban
 157 // 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, ...)
 158 //
 159 // Revision 1.18  2004/01/25 07:58:30  rurban
 160 // PageList sortby support in PearDB and ADODB backends
 161 //
 162 // Revision 1.17  2003/02/27 20:10:30  dairiki
 163 // Disable profiling output when DEBUG is defined but false.
 164 //
 165 // Revision 1.16  2003/02/21 04:08:26  dairiki
 166 // New class DebugTimer in prepend.php to help report timing.
 167 //
 168 // Revision 1.15  2003/01/18 21:19:25  carstenklapp
 169 // Code cleanup:
 170 // Reformatting; added copyleft, getVersion, getDescription
 171 //
 172
 173 // Local Variables:
 174 // mode: php
 175 // tab-width: 8
 176 // c-basic-offset: 4
 177 // c-hanging-comment-ender-p: nil
 178 // indent-tabs-mode: nil
 179 // End:
 180 ?>