lib/plugin/AllUsers.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: AllUsers.php,v 1.11 2004-03-10 13:54:54 rurban Exp $');
   3 /*
   4  Copyright 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  * Based on AllPages and WikiGroup.
  27  *
  28  * We query homepage users (prefs stored in a page),
  29  * users with db prefs and externally authenticated users with a db users table,
  30  * if auth_user_exists is defined.
  31  */
  32 class WikiPlugin_AllUsers
  33 extends WikiPlugin
  34 {
  35     function getName () {
  36         return _("AllUsers");
  37     }
  38
  39     function getDescription() {
  40         return _("With external authentication all users which stored their Preferences. Without external authentication all once signed-in users (from version 1.3.4 on).");
  41     }
  42
  43     function getVersion() {
  44         return preg_replace("/[Revision: $]/", '',
  45                             "\$Revision: 1.11 $");
  46     }
  47
  48     function getDefaultArguments() {
  49         return array('noheader'      => false,
  50                      'include_empty' => true,
  51                      'exclude'       => '',
  52                      'info'          => '',   // which columns? default: list of pagenames only
  53                      'sortby'        => '',   // +mtime,-pagename
  54                      'limit'         => 0,
  55                      'debug'         => false
  56                      );
  57     }
  58     // info arg allows multiple columns
  59     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  60     // exclude arg allows multiple pagenames exclude=WikiAdmin,.SecretUser
  61     //
  62     // include_empty shows also users which stored their preferences,
  63     // but never saved their homepage
  64     //
  65     // sortby: [+|-] pagename|mtime|hits
  66
  67     function run($dbi, $argstr, &$request, $basepage) {
  68         extract($this->getArgs($argstr, $request));
  69         if ($sorted = $request->getArg('sortby'))
  70             $sortby = $sorted;
  71         elseif ($sortby)
  72             $request->setArg('sortby',$sortby);
  73
  74         $pagelist = new PageList($info, $exclude, $this->getArgs($argstr, $request));
  75         if (!$noheader)
  76             $pagelist->setCaption(_("Authenticated users on this wiki (%d total):"));
  77
  78         // deleted pages show up as version 0.
  79         if ($include_empty and empty($info))
  80             $pagelist->_addColumn('version');
  81
  82         //if (defined('DEBUG') and DEBUG) $debug = true;
  83         if ($debug)
  84             $timer = new DebugTimer;
  85
  86         $group = WikiGroup::getGroup($request);
  87         foreach ($group->_allUsers() as $user) {
  88             $pagelist->addPage($user);
  89         }
  90         /*
  91         $page_iter = $dbi->getAllPages($include_empty, $sortby, $limit);
  92         while ($page = $page_iter->next()) {
  93             if ($page->isUserPage($include_empty))
  94                 $pagelist->addPage($page);
  95         }
  96         */
  97
  98         if ($debug) {
  99             return HTML($pagelist,
 100                         HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
 101         } else {
 102             return $pagelist;
 103         }
 104     }
 105 };
 106
 107 // $Log: not supported by cvs2svn $
 108 // Revision 1.10  2004/03/08 19:30:01  rurban
 109 // fixed Theme->getButtonURL
 110 // AllUsers uses now WikiGroup (also DB User and DB Pref users)
 111 // PageList fix for empty pagenames
 112 //
 113 // Revision 1.9  2004/02/22 23:20:33  rurban
 114 // fixed DumpHtmlToDir,
 115 // enhanced sortby handling in PageList
 116 //   new button_heading th style (enabled),
 117 // added sortby and limit support to the db backends and plugins
 118 //   for paging support (<<prev, next>> links on long lists)
 119 //
 120 // Revision 1.8  2004/02/17 12:11:36  rurban
 121 // 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, ...)
 122 //
 123 // Revision 1.7  2003/12/21 00:29:45  carstenklapp
 124 // Minor bugfix: Fixed broken debug argument.
 125 //
 126 // Internal changes: Only create a DebugTimer when actually called for;
 127 // moved debug message out of page content and into deferred page error
 128 // notification via trigger_error. Memory management: Only include_once
 129 // lib/PageList when absolutely necessary (at this time, this will
 130 // probably only benefit the PluginManager as an incremental speedup &
 131 // slightly reduced memory).
 132 //
 133 // Revision 1.6  2003/02/27 20:10:31  dairiki
 134 // Disable profiling output when DEBUG is defined but false.
 135 //
 136 // Revision 1.5  2003/02/21 04:08:26  dairiki
 137 // New class DebugTimer in prepend.php to help report timing.
 138 //
 139 // Revision 1.4  2003/01/18 21:19:25  carstenklapp
 140 // Code cleanup:
 141 // Reformatting; added copyleft, getVersion, getDescription
 142 //
 143
 144 // Local Variables:
 145 // mode: php
 146 // tab-width: 8
 147 // c-basic-offset: 4
 148 // c-hanging-comment-ender-p: nil
 149 // indent-tabs-mode: nil
 150 // End:
 151 ?>