4 * Copyright 2002,2004 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
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.
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.
18 * You should have received a copy of the GNU General Public License along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 require_once 'lib/PageList.php';
26 * Based on AllPages and WikiGroup.
29 * either homepage users (prefs stored in a page),
30 * users with db prefs and
31 * externally authenticated users with a db users table, if auth_user_exists is defined.
33 class WikiPlugin_AllUsers
41 function getDescription()
43 return _("List all once authenticated users.");
46 function getDefaultArguments()
50 PageList::supportedArgs(),
51 array('noheader' => false,
52 'include_empty' => true,
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=WikiAdmin,.SecretUser
61 // include_empty shows also users which stored their preferences,
62 // but never saved their homepage
64 // sortby: [+|-] pagename|mtime|hits
66 function run($dbi, $argstr, &$request, $basepage)
68 $args = $this->getArgs($argstr, $request);
71 if (defined('DEBUG') && DEBUG && $debug) {
72 $timer = new DebugTimer;
75 $group = $request->getGroup();
76 if (method_exists($group, '_allUsers')) {
77 $allusers = $group->_allUsers();
81 $args['count'] = count($allusers);
82 // deleted pages show up as version 0.
83 $pagelist = new PageList($info, $exclude, $args);
85 $pagelist->setCaption(_("Authenticated users on this wiki (%d total):"));
86 if ($include_empty and empty($info))
87 $pagelist->_addColumn('version');
88 list($offset, $pagesize) = $pagelist->limit($args['limit']);
90 $pagelist->addPageList($allusers);
92 for ($i = $offset; $i < $offset + $pagesize - 1; $i++) {
93 if ($i >= $args['count']) break;
94 $pagelist->addPage(trim($allusers[$i]));
98 $page_iter = $dbi->getAllPages($include_empty, $sortby, $limit);
99 while ($page = $page_iter->next()) {
100 if ($page->isUserPage($include_empty))
101 $pagelist->addPage($page);
105 if (defined('DEBUG') && DEBUG and $debug) {
106 return HTML($pagelist,
107 HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
120 // c-hanging-comment-ender-p: nil
121 // indent-tabs-mode: nil