lib/plugin/WhoIsOnline.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  Copyright 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 /**
  24  * Show summary information of the current user sessions.
  25  * We support two modes: summary and detail. The optional page argument
  26  * links to the page with the other mode.
  27  *
  28  * Formatting and idea borrowed from postnuke. Requires USE_DB_SESSION.
  29  * Works with PearDB, ADODB and dba DbSessions.
  30  *
  31  * Author: Reini Urban
  32  */
  33
  34 class WikiPlugin_WhoIsOnline
  35 extends WikiPlugin
  36 {
  37     function getName () {
  38         return _("WhoIsOnline");
  39     }
  40
  41     function getDescription () {
  42         return _("Show summary information of the current user sessions.");
  43     }
  44
  45     function getVersion() {
  46         return preg_replace("/[Revision: $]/", '',
  47                             "\$Revision$");
  48     }
  49
  50     function getDefaultArguments() {
  51         // two modes: summary and detail, page links to the page with the other mode
  52         return array(
  53                      'mode'         => 'summary',    // or "detail"
  54                      'pagename'     => '[pagename]', // refer to the page with the other mode
  55                      'allow_detail' => false,        // if false, page is ignored
  56                      'dispose_admin' => false,
  57                      );
  58     }
  59
  60     function run($dbi, $argstr, &$request, $basepage) {
  61         global $WikiTheme;
  62         $request->setArg('nocache',1);
  63         $args = $this->getArgs($argstr, $request);
  64         // use the "online.tmpl" template
  65         // todo: check which arguments are really needed in the template.
  66         $stats = $this->getStats($dbi,$request,$args['mode']);
  67         if ($src = $WikiTheme->getImageURL("whosonline"))
  68             $img = HTML::img(array('src' => $src,
  69                                    'alt' => $this->getName(),
  70                                    'border' => 0));
  71         else $img = '';
  72         $other = array();
  73         $other['ONLINE_ICON'] = $img;
  74         return new Template('online', $request, array_merge($args, $stats, $other));
  75     }
  76
  77     // box is used to display a fixed-width, narrow version with common header
  78     // just the number of online users.
  79     function box($args=false, $request=false, $basepage=false) {
  80         if (!$request) $request =& $GLOBALS['request'];
  81         $stats = $this->getStats($request->_dbi,$request,'summary');
  82         return $this->makeBox(_("Who is online"),
  83                               HTML(HTML::Raw('&middot; '),
  84                                    WikiLink(_("WhoIsOnline"),'auto',
  85                                             fmt("%d online users", $stats['NUM_USERS']))));
  86     }
  87
  88     function getSessions($dbi, &$request) {
  89         // check the current user sessions and what they are doing
  90         ;
  91     }
  92
  93     // check the current sessions
  94     function getStats($dbi, &$request, $mode='summary') {
  95         $num_pages = 0; $num_users = 0;
  96         $page_iter = $dbi->getAllPages();
  97         while ($page = $page_iter->next()) {
  98             if ($page->isUserPage()) $num_users++;
  99             $num_pages++;
 100         }
 101         //get session data from database
 102         $num_online = 0; $num_guests = 0; $num_registered = 0;
 103         $registered = array(); $guests = array();
 104         $admins = array(); $uniquenames = array();
 105         $sess_time = ini_get('session.gc_maxlifetime'); // in seconds
 106         if (!$sess_time) $sess_time = 24*60;
 107         if (isset($request->_dbsession)) { // only ADODB and SQL backends
 108             $dbsession =& $request->_dbsession;
 109             if (method_exists($dbsession->_backend, "gc"))
 110                 $dbsession->_backend->gc($sess_time);
 111             $sessions = $dbsession->currentSessions();
 112             //$num_online = count($sessions);
 113             $guestname = _("Guest");
 114             foreach ($sessions as $row) {
 115                 $data = $row['wiki_user'];
 116                 $date = $row['date'];
 117                 //Todo: Security issue: Expose REMOTE_ADDR?
 118                 //      Probably only to WikiAdmin
 119                 $ip   = $row['ip'];
 120                 if (empty($date)) continue;
 121                 $num_online++;
 122                 $user = @unserialize($data);
 123                 if (!empty($user) and !isa($user, "__PHP_incomplete_Class")) {
 124                     // if "__PHP_incomplete_Class" try to avoid notice
 125                     $userid = @$user->_userid;
 126                     $level = @$user->_level;
 127                     if ($mode == 'summary' and in_array($userid, $uniquenames)) continue;
 128                     $uniquenames[] = $userid;
 129                     $page = _("<unknown>");  // where is he?
 130                     $action = 'browse';
 131                     $objvars = array_keys(get_object_vars($user));
 132                     if (in_array('action',$objvars))
 133                         $action = @$user->action;
 134                     if (in_array('page',$objvars))
 135                         $page = @$user->page;
 136                     if ($level and $userid) { // registered or guest or what?
 137                         //FIXME: htmlentitities name may not be called here. but where then?
 138                         $num_registered++;
 139                         $registered[] = array('name'  => $userid,
 140                                               'date'  => $date,
 141                                               'action'=> $action,
 142                                               'page'  => $page,
 143                                               'level' => $level,
 144                                               'ip'    => $ip,
 145                                               'x'     => 'x');
 146                         if ($user->_level == WIKIAUTH_ADMIN)
 147                            $admins[] = $registered[count($registered)-1];
 148                     } else {
 149                         $num_guests++;
 150                         $guests[] = array('name'  => $guestname,
 151                                           'date'  => $date,
 152                                           'action'=> $action,
 153                                           'page'  => $page,
 154                                           'level' => $level,
 155                                           'ip'    => $ip,
 156                                           'x'     => 'x');
 157                     }
 158                 } else {
 159                     $num_guests++;
 160                     $guests[] = array('name'  => $guestname,
 161                                       'date'  => $date,
 162                                       'action'=> '',
 163                                       'page'  => '',
 164                                       'level' => 0,
 165                                       'ip'    => $ip,
 166                                       'x'     => 'x');
 167                 }
 168             }
 169         }
 170         $num_users = $num_guests + $num_registered;
 171
 172         //TODO: get and sets max stats in global_data
 173         //$page = $dbi->getPage($request->getArg('pagename'));
 174         $stats = array(); $stats['max_online_num'] = 0;
 175         if ($stats = $dbi->get('stats')) {
 176             if ($num_users > $stats['max_online_num']) {
 177                 $stats['max_online_num'] = $num_users;
 178                 $stats['max_online_time'] = time();
 179                 $dbi->set('stats',$stats);
 180             }
 181         } else {
 182             $stats['max_online_num'] = $num_users;
 183             $stats['max_online_time'] = time();
 184             $dbi->set('stats',$stats);
 185         }
 186         return array('SESSDATA_BOOL'    => !empty($dbsession),
 187                      'NUM_PAGES'        => $num_pages,
 188                      'NUM_USERS'        => $num_users,
 189                      'NUM_ONLINE'       => $num_online,
 190                      'NUM_REGISTERED'   => $num_registered,
 191                      'NUM_GUESTS'       => $num_guests,
 192                      'NEWEST_USER'      => '', // todo
 193                      'MAX_ONLINE_NUM'   => $stats['max_online_num'],
 194                      'MAX_ONLINE_TIME'  => $stats['max_online_time'],
 195                      'REGISTERED'       => $registered,
 196                      'ADMINS'           => $admins,
 197                      'GUESTS'           => $guests,
 198                      'SESSION_TIME'     => sprintf(_("%d minutes"),$sess_time / 60),
 199                      );
 200     }
 201 };
 202
 203 // $Log: not supported by cvs2svn $
 204 // Revision 1.11  2005/02/02 19:39:42  rurban
 205 // better box layout
 206 //
 207 // Revision 1.10  2005/02/01 16:22:58  rurban
 208 // avoid __PHP_incomplete_Class notice
 209 //
 210 // Revision 1.9  2004/12/18 17:04:24  rurban
 211 // stabilize not to call UserName() of an incomplete (not loaded) object
 212 //
 213 // Revision 1.8  2004/06/14 11:31:39  rurban
 214 // renamed global $Theme to $WikiTheme (gforge nameclash)
 215 // inherit PageList default options from PageList
 216 //   default sortby=pagename
 217 // use options in PageList_Selectable (limit, sortby, ...)
 218 // added action revert, with button at action=diff
 219 // added option regex to WikiAdminSearchReplace
 220 //
 221 // Revision 1.7  2004/05/27 17:49:06  rurban
 222 // renamed DB_Session to DbSession (in CVS also)
 223 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
 224 // remove leading slash in error message
 225 // added force_unlock parameter to File_Passwd (no return on stale locks)
 226 // fixed adodb session AffectedRows
 227 // added FileFinder helpers to unify local filenames and DATA_PATH names
 228 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
 229 //
 230 // Revision 1.6  2004/05/02 15:10:08  rurban
 231 // new finally reliable way to detect if /index.php is called directly
 232 //   and if to include lib/main.php
 233 // new global AllActionPages
 234 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
 235 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
 236 // PageGroupTestOne => subpages
 237 // renamed PhpWikiRss to PhpWikiRecentChanges
 238 // more docs, default configs, ...
 239 //
 240 // Revision 1.5  2004/04/06 20:27:05  rurban
 241 // fixed guests (no wiki_user session)
 242 // added ip (to help in ip-throttling)
 243 //
 244 // Revision 1.4  2004/03/30 02:14:04  rurban
 245 // fixed yet another Prefs bug
 246 // added generic PearDb_iter
 247 // $request->appendValidators no so strict as before
 248 // added some box plugin methods
 249 // PageList commalist for condensed output
 250 //
 251 // Revision 1.3  2004/03/12 15:48:08  rurban
 252 // fixed explodePageList: wrong sortby argument order in UnfoldSubpages
 253 // simplified lib/stdlib.php:explodePageList
 254 //
 255 // Revision 1.2  2004/03/10 15:38:49  rurban
 256 // store current user->page and ->action in session for WhoIsOnline
 257 // better WhoIsOnline icon
 258 // fixed WhoIsOnline warnings
 259 //
 260 // Revision 1.1  2004/02/26 19:15:37  rurban
 261 // new WhoIsOnline plugin: session explorer (postnuke style)
 262 //
 263 //
 264
 265 // For emacs users
 266 // Local Variables:
 267 // mode: php
 268 // tab-width: 8
 269 // c-basic-offset: 4
 270 // c-hanging-comment-ender-p: nil
 271 // indent-tabs-mode: nil
 272 // End:
 273 ?>