Replaced all @fixme with "@todo Fixme" since doxygen doesn't have a @fixme command
[lhc/web/wiklou.git] / includes / specials / SpecialActiveusers.php
index d4c6bfe..a5f1b3c 100644 (file)
-<?php\r
-\r
-# Copyright (C) 2008 Aaron Schulz\r
-#\r
-# http://www.mediawiki.org/\r
-#\r
-# This program is free software; you can redistribute it and/or modify\r
-# it under the terms of the GNU General Public License as published by\r
-# the Free Software Foundation; either version 2 of the License, or\r
-# (at your option) any later version.\r
-#\r
-# This program is distributed in the hope that it will be useful,\r
-# but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
-# GNU General Public License for more details.\r
-#\r
-# You should have received a copy of the GNU General Public License along\r
-# with this program; if not, write to the Free Software Foundation, Inc.,\r
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.\r
-# http://www.gnu.org/copyleft/gpl.html\r
-/**\r
- *\r
- * @addtogroup SpecialPage\r
- */\r
-\r
-/**\r
- * This class is used to get a list of user. The ones with specials\r
- * rights (sysop, bureaucrat, developer) will have them displayed\r
- * next to their names.\r
- *\r
- * @addtogroup SpecialPage\r
- */\r
-\r
-class ActiveUsersPager extends UsersPager {\r
-\r
-       function __construct($group=null) {\r
-               global $wgRequest;\r
-               $un = $wgRequest->getText( 'username' );\r
-               $this->requestedUser = '';\r
-               if ( $un != '' ) {\r
-                       $username = Title::makeTitleSafe( NS_USER, $un );\r
-                       if( ! is_null( $username ) ) {\r
-                               $this->requestedUser = $username->getText();\r
-                       }\r
-               }\r
-               parent::__construct();\r
-       }\r
-\r
-\r
-       function getIndexField() {\r
-               return 'rc_user_text';\r
-       }\r
-\r
-       function getQueryInfo() {\r
-               $dbr = wfGetDB( DB_SLAVE );\r
-               $conds = array();\r
-               // don't show hidden names\r
-               $conds[] = 'ipb_deleted IS NULL';\r
-               $useIndex = $dbr->useIndexClause('rc_user_text');\r
-               if( $this->requestedUser != "" ) {\r
-                       $conds[] = 'rc_user_text >= ' . $dbr->addQuotes( $this->requestedUser );\r
-               }\r
-               $conds[] = 'rc_user > 0'; // Users - no anons\r
-\r
-               list ($recentchanges,$ipblocks) = $dbr->tableNamesN('recentchanges','ipblocks');\r
-\r
-               $query = array(\r
-                       'tables' => " $recentchanges $useIndex \r
-                               LEFT JOIN $ipblocks ON rc_user=ipb_user AND ipb_auto=0 AND ipb_deleted=1 ",\r
-                       'fields' => array('rc_user_text AS user_name', // inheritance\r
-                               'rc_user_text', // for Pager\r
-                               'MAX(rc_user) AS user_id',\r
-                               'COUNT(*) AS recentedits',\r
-                               'MAX(ipb_user) AS blocked'),\r
-                       'options' => array('GROUP BY' => 'user_name'),\r
-                       'conds' => $conds\r
-               );\r
-               return $query;\r
-       }\r
-\r
-       function formatRow( $row ) {\r
-               $userPage = Title::makeTitle( NS_USER, $row->rc_user_text );\r
-               $name = $this->getSkin()->makeLinkObj( $userPage, htmlspecialchars( $userPage->getText() ) );\r
-\r
-               $list = array();\r
-               foreach( self::getGroups( $row->user_id ) as $group )\r
-                       $list[] = self::buildGroupLink( $group );\r
-               $groups = implode( ', ', $list );\r
-\r
-               $item = wfSpecialList( $name, $groups );\r
-               $count = wfMsgExt( 'activeusers-count', array('parsemag'), $row->recentedits );\r
-               $blocked = $row->blocked ? ' '.wfMsg('listusers-blocked') : '';\r
-\r
-               return "<li>{$item} [{$count}]{$blocked}</li>";\r
-       }\r
-\r
-       function getPageHeader() {\r
-               global $wgScript, $wgRequest;\r
-               $self = $this->getTitle();\r
-\r
-               # Form tag\r
-               $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .\r
-                       '<fieldset>' .\r
-                       Xml::element( 'legend', array(), wfMsg( 'activeusers' ) );\r
-               $out .= Xml::hidden( 'title', $self->getPrefixedDbKey() );\r
-\r
-               # Username field\r
-               $out .= Xml::label( wfMsg( 'activeusers-from' ), 'offset' ) . ' ' .\r
-                       Xml::input( 'username', 20, $this->requestedUser, array( 'id' => 'offset' ) ) . ' ';\r
-\r
-               # Submit button and form bottom\r
-               if( $this->mLimit )\r
-                       $out .= Xml::hidden( 'limit', $this->mLimit );\r
-               $out .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );\r
-\r
-               $out .= '</fieldset>' . Xml::closeElement( 'form' );\r
-\r
-               return $out;\r
-       }\r
-}\r
-\r
-/**\r
- * constructor\r
- * $par string (optional) A group to list users from\r
- */\r
-function wfSpecialActiveusers( $par = null ) {\r
-       global $wgRequest, $wgOut;\r
-\r
-       $up = new ActiveUsersPager();\r
-\r
-       # getBody() first to check, if empty\r
-       $usersbody = $up->getBody();\r
-       $s = $up->getPageHeader();\r
-       if( $usersbody ) {\r
-               $s .=   $up->getNavigationBar();\r
-               $s .=   '<ul>' . $usersbody . '</ul>';\r
-               $s .=   $up->getNavigationBar() ;\r
-       } else {\r
-               $s .=   '<p>' . wfMsgHTML('activeusers-noresult') . '</p>';\r
-       };\r
-\r
-       $wgOut->addHTML( $s );\r
-}\r
+<?php
+# Copyright (C) 2008 Aaron Schulz
+#
+# http://www.mediawiki.org/
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+# http://www.gnu.org/copyleft/gpl.html
+
+/**
+ * This class is used to get a list of active users. The ones with specials
+ * rights (sysop, bureaucrat, developer) will have them displayed
+ * next to their names.
+ *
+ * @file
+ * @ingroup SpecialPage
+ */
+class ActiveUsersPager extends UsersPager {
+
+       function __construct( $group = null ) {
+               global $wgRequest, $wgRCMaxAge;
+               $this->RCMaxAge = ceil( $wgRCMaxAge / ( 3600 * 24 ) ); // Constant
+
+               $un = $wgRequest->getText( 'username' );
+               $this->requestedUser = '';
+               if ( $un != '' ) {
+                       $username = Title::makeTitleSafe( NS_USER, $un );
+                       if( !is_null( $username ) ) {
+                               $this->requestedUser = $username->getText();
+                       }
+               }
+               
+               $this->setupOptions();
+               
+               parent::__construct();
+       }
+
+       public function setupOptions() {
+               global $wgRequest;
+               
+               $this->opts = new FormOptions();
+
+               $this->opts->add( 'hidebots', false, FormOptions::BOOL );
+               $this->opts->add( 'hidesysops', false, FormOptions::BOOL );
+
+               $this->opts->fetchValuesFromRequest( $wgRequest );
+
+               $this->groups = array();
+               if ($this->opts->getValue('hidebots') == 1)
+                       $this->groups['bot'] = true;
+               if ($this->opts->getValue('hidesysops') == 1)
+                       $this->groups['sysop'] = true;
+       }
+
+       function getIndexField() {
+               return 'rc_user_text';
+       }
+
+       function getQueryInfo() {
+               global $wgDBtype;
+
+               $dbr = wfGetDB( DB_SLAVE );
+               $conds = array( 'rc_user > 0' ); // Users - no anons
+               $conds[] = 'ipb_deleted IS NULL'; // don't show hidden names
+               $conds[] = "rc_log_type IS NULL OR rc_log_type != 'newusers'";
+               
+               if( $this->requestedUser != '' ) {
+                       $conds[] = 'rc_user_text >= ' . $dbr->addQuotes( $this->requestedUser );
+               }
+
+               $query = array(
+                       'tables' => array( 'recentchanges', 'user', 'ipblocks' ),
+                       'fields' => array( 'rc_user_text AS user_name', // inheritance
+                               'rc_user_text', // for Pager
+                               'MAX(user_id) AS user_id',
+                               'COUNT(*) AS recentedits',
+                               'MAX(ipb_user) AS blocked'
+                       ),
+                       'options' => array(
+                               'GROUP BY' => ( $dbr->implicitGroupby() || $wgDBtype == 'sqlite' ) ? 'rc_user_text' : 'rc_user_text, user_id',
+                               'USE INDEX' => array( 'recentchanges' => 'rc_user_text' )
+                       ),
+                       'join_conds' => array(
+                               'user' => array( 'INNER JOIN', 'rc_user_text=user_name' ),
+                               'ipblocks' => array( 'LEFT JOIN', 'user_id=ipb_user AND ipb_auto=0 AND ipb_deleted=1' ),
+                       ),
+                       'conds' => $conds
+               );
+               return $query;
+       }
+
+       function formatRow( $row ) {
+               global $wgLang;
+               $userName = $row->user_name;
+               
+               $ulinks = $this->getSkin()->userLink( $row->user_id, $userName );
+               $ulinks .= $this->getSkin()->userToolLinks( $row->user_id, $userName );
+
+               $list = array();
+               foreach( self::getGroups( $row->user_id ) as $group ) {
+                       if (isset($this->groups[$group]))
+                               return;
+                       $list[] = self::buildGroupLink( $group );
+               }
+               $groups = $wgLang->commaList( $list );
+
+               $item = wfSpecialList( $ulinks, $groups );
+               $count = wfMsgExt( 'activeusers-count',
+                       array( 'parsemag' ),
+                       $wgLang->formatNum( $row->recentedits ),
+                       $userName,
+                       $wgLang->formatNum ( $this->RCMaxAge )
+               );
+               $blocked = $row->blocked ? ' ' . wfMsgExt( 'listusers-blocked', array( 'parsemag' ), $userName ) : '';
+
+               return Html::rawElement( 'li', array(), "{$item} [{$count}]{$blocked}" );
+       }
+
+       function getPageHeader() {
+               global $wgScript, $wgRequest;
+
+               $self = $this->getTitle();
+               $limit = $this->mLimit ? Xml::hidden( 'limit', $this->mLimit ) : '';
+
+               $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ); # Form tag
+               $out .= Xml::fieldset( wfMsg( 'activeusers' ) ) . "\n";
+               $out .= Xml::hidden( 'title', $self->getPrefixedDBkey() ) . $limit . "\n";
+
+               $out .= Xml::inputLabel( wfMsg( 'activeusers-from' ), 'username', 'offset', 20, $this->requestedUser ) . '<br />';# Username field
+
+               $out .= Xml::checkLabel( wfMsg('activeusers-hidebots'), 'hidebots', 'hidebots', $this->opts->getValue( 'hidebots' ) );
+
+               $out .= Xml::checkLabel( wfMsg('activeusers-hidesysops'), 'hidesysops', 'hidesysops', $this->opts->getValue( 'hidesysops' ) ) . '<br />';
+
+               $out .= Xml::submitButton( wfMsg( 'allpagessubmit' ) ) .  "\n";# Submit button and form bottom
+               $out .= Xml::closeElement( 'fieldset' );
+               $out .= Xml::closeElement( 'form' );
+               
+               return $out;
+       }
+}
+
+/**
+ * @ingroup SpecialPage
+ */
+class SpecialActiveUsers extends SpecialPage {
+
+       /**
+        * Constructor
+        */
+       public function  __construct() {
+               parent::__construct( 'Activeusers' );
+       }
+
+       /**
+        * Show the special page
+        *
+        * @param $par Mixed: parameter passed to the page or null
+        */
+       public function execute( $par ) {
+               global $wgOut, $wgLang, $wgRCMaxAge;
+
+               $this->setHeaders();
+
+               $up = new ActiveUsersPager();
+
+               # getBody() first to check, if empty
+               $usersbody = $up->getBody();
+
+                $s = Html::rawElement( 'div', array( 'class' => 'mw-activeusers-intro' ),
+                        wfMsgExt( 'activeusers-intro', array( 'parsemag', 'escape' ), $wgLang->formatNum( ceil( $wgRCMaxAge / 86400 ) ) )
+                );
+
+               $s .= $up->getPageHeader();
+               if( $usersbody ) {
+                       $s .= $up->getNavigationBar();
+                       $s .= Html::rawElement( 'ul', array(), $usersbody );
+                       $s .= $up->getNavigationBar();
+               } else {
+                       $s .= Html::element( 'p', array(), wfMsg( 'activeusers-noresult' ) );
+               }
+
+               $wgOut->addHTML( $s );
+       }
+
+}