Add a way for packagers to override some installation details
[lhc/web/wiklou.git] / includes / specials / SpecialListusers.php
index 8d9213a..75be397 100644 (file)
@@ -1,27 +1,26 @@
 <?php
-
-# Copyright (C) 2004 Brion Vibber, lcrocker, Tim Starling,
-# Domas Mituzas, Ashar Voultoiz, Jens Frank, Zhengzhu.
-#
-# © 2006 Rob Church <robchur@gmail.com>
-#
-# 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
 /**
+ * Implements Special:Listusers
+ *
+ * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
+ * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
+ * 2006 Rob Church <robchur@gmail.com>
+ *
+ * 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
+ *
  * @file
  * @ingroup SpecialPage
  */
  */
 class UsersPager extends AlphabeticPager {
 
-       function __construct( $par=null ) {
-               global $wgRequest;
-               $parms = explode( '/', ($par = ( $par !== null ) ? $par : '' ) );
+       function __construct( IContextSource $context = null, $par = null ) {
+               if ( $context ) {
+                       $this->setContext( $context );
+               }
+
+               $request = $this->getRequest();
+               $par = ( $par !== null ) ? $par : '';
+               $parms = explode( '/', $par );
                $symsForAll = array( '*', 'user' );
                if ( $parms[0] != '' && ( in_array( $par, User::getAllGroups() ) || in_array( $par, $symsForAll ) ) ) {
                        $this->requestedGroup = $par;
-                       $un = $wgRequest->getText( 'username' );
-               } else if ( count( $parms ) == 2 ) {
+                       $un = $request->getText( 'username' );
+               } elseif ( count( $parms ) == 2 ) {
                        $this->requestedGroup = $parms[0];
                        $un = $parms[1];
                } else {
-                       $this->requestedGroup = $wgRequest->getVal( 'group' );
-                       $un = ( $par != '' ) ? $par : $wgRequest->getText( 'username' );
+                       $this->requestedGroup = $request->getVal( 'group' );
+                       $un = ( $par != '' ) ? $par : $request->getText( 'username' );
                }
                if ( in_array( $this->requestedGroup, $symsForAll ) ) {
                        $this->requestedGroup = '';
                }
-               $this->editsOnly = $wgRequest->getBool( 'editsOnly' );
-               $this->creationSort = $wgRequest->getBool( 'creationSort' );
+               $this->editsOnly = $request->getBool( 'editsOnly' );
+               $this->creationSort = $request->getBool( 'creationSort' );
 
                $this->requestedUser = '';
                if ( $un != '' ) {
@@ -65,23 +69,24 @@ class UsersPager extends AlphabeticPager {
                parent::__construct();
        }
 
-
        function getIndexField() {
                return $this->creationSort ? 'user_id' : 'user_name';
        }
 
        function getQueryInfo() {
-               global $wgUser;
                $dbr = wfGetDB( DB_SLAVE );
                $conds = array();
                // Don't show hidden names
-               if( !$wgUser->isAllowed('hideuser') )
+               if( !$this->getUser()->isAllowed('hideuser') ) {
                        $conds[] = 'ipb_deleted IS NULL';
+               }
+
+               $options = array();
+
                if( $this->requestedGroup != '' ) {
                        $conds['ug_group'] = $this->requestedGroup;
-                       $useIndex = '';
                } else {
-                       $useIndex = $dbr->useIndexClause( $this->creationSort ? 'PRIMARY' : 'user_name');
+                       //$options['USE INDEX'] = $this->creationSort ? 'PRIMARY' : 'user_name';
                }
                if( $this->requestedUser != '' ) {
                        # Sorted either by account creation or name
@@ -95,11 +100,10 @@ class UsersPager extends AlphabeticPager {
                        $conds[] = 'user_editcount > 0';
                }
 
-               list ($user,$user_groups,$ipblocks) = $dbr->tableNamesN('user','user_groups','ipblocks');
+               $options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';
 
                $query = array(
-                       'tables' => " $user $useIndex LEFT JOIN $user_groups ON user_id=ug_user
-                               LEFT JOIN $ipblocks ON user_id=ipb_user AND ipb_deleted=1 AND ipb_auto=0 ",
+                       'tables' => array( 'user', 'user_groups', 'ipblocks'),
                        'fields' => array(
                                $this->creationSort ? 'MAX(user_name) AS user_name' : 'user_name',
                                $this->creationSort ? 'user_id' : 'MAX(user_id) AS user_id',
@@ -109,7 +113,11 @@ class UsersPager extends AlphabeticPager {
                                'MIN(user_registration) AS creation',
                                'MAX(ipb_deleted) AS ipb_deleted' // block/hide status
                        ),
-                       'options' => array('GROUP BY' => $this->creationSort ? 'user_id' : 'user_name'),
+                       'options' => $options,
+                       'join_conds' => array(
+                               'user_groups' => array( 'LEFT JOIN', 'user_id=ug_user' ),
+                               'ipblocks' => array( 'LEFT JOIN', 'user_id=ipb_user AND ipb_deleted=1 AND ipb_auto=0' ),
+                       ),
                        'conds' => $conds
                );
 
@@ -118,31 +126,37 @@ class UsersPager extends AlphabeticPager {
        }
 
        function formatRow( $row ) {
-               global $wgLang;
+               if ($row->user_id == 0) #Bug 16487
+                       return '';
+
+               $userName = $row->user_name;
+
+               $ulinks = Linker::userLink( $row->user_id, $userName );
+               $ulinks .= Linker::userToolLinks( $row->user_id, $userName );
 
                $userPage = Title::makeTitle( NS_USER, $row->user_name );
-               $name = $this->getSkin()->link( $userPage, htmlspecialchars( $userPage->getText() ) );
+               $name = Linker::link( $userPage, htmlspecialchars( $userPage->getText() ) );
 
-               if( $row->numgroups > 1 || ( $this->requestedGroup && $row->numgroups == 1 ) ) {
+               $lang = $this->getLanguage();
+
+               $groups_list = self::getGroups( $row->user_id );
+               if( count( $groups_list ) > 0 ) {
                        $list = array();
-                       foreach( self::getGroups( $row->user_id ) as $group )
-                               $list[] = self::buildGroupLink( $group );
-                       $groups = $wgLang->commaList( $list );
-               } elseif( $row->numgroups == 1 ) {
-                       $groups = self::buildGroupLink( $row->singlegroup );
+                       foreach( $groups_list as $group )
+                               $list[] = self::buildGroupLink( $group, $userName );
+                       $groups = $lang->commaList( $list );
                } else {
                        $groups = '';
                }
 
-               $item = wfSpecialList( $name, $groups );
+               $item = $lang->specialList( $ulinks, $groups );
                if( $row->ipb_deleted ) {
                        $item = "<span class=\"deleted\">$item</span>";
                }
 
                global $wgEdititis;
                if ( $wgEdititis ) {
-                       $editCount = $wgLang->formatNum( $row->edits );
-                       $edits = ' [' . wfMsgExt( 'usereditcount', array( 'parsemag', 'escape' ), $editCount ) . ']';
+                       $edits = ' [' . $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped() . ']';
                } else {
                        $edits = '';
                }
@@ -150,60 +164,59 @@ class UsersPager extends AlphabeticPager {
                $created = '';
                # Some rows may be NULL
                if( $row->creation ) {
-                       $d = $wgLang->date( wfTimestamp( TS_MW, $row->creation ), true );
-                       $t = $wgLang->time( wfTimestamp( TS_MW, $row->creation ), true );
-                       $created = ' (' . wfMsg( 'usercreated', $d, $t ) . ')';
-                       $created = htmlspecialchars( $created );
+                       $user = $this->getUser();
+                       $d = $lang->userDate( $row->creation, $user );
+                       $t = $lang->userTime( $row->creation, $user );
+                       $created = $this->msg( 'usercreated', $d, $t, $row->user_name )->escaped();
+                       $created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
                }
 
                wfRunHooks( 'SpecialListusersFormatRow', array( &$item, $row ) );
                return "<li>{$item}{$edits}{$created}</li>";
        }
 
-       function getBody() {
-               if( !$this->mQueryDone ) {
-                       $this->doQuery();
-               }
-               $this->mResult->rewind();
-               $batch = new LinkBatch;
-               while ( $row = $this->mResult->fetchObject() ) {
-                       $batch->addObj( Title::makeTitleSafe( NS_USER, $row->user_name ) );
+       function doBatchLookups() {
+               $batch = new LinkBatch();
+               # Give some pointers to make user links
+               foreach ( $this->mResult as $row ) {
+                       $batch->add( NS_USER, $row->user_name );
+                       $batch->add( NS_USER_TALK, $row->user_name );
                }
                $batch->execute();
                $this->mResult->rewind();
-               return parent::getBody();
        }
 
        function getPageHeader( ) {
-               global $wgScript, $wgRequest;
-               $self = $this->getTitle();
+               global $wgScript;
+               // @todo Add a PrefixedBaseDBKey
+               list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
 
                # Form tag
                $out  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-listusers-form' ) ) .
-                       Xml::fieldset( wfMsg( 'listusers' ) ) .
-                       Xml::hidden( 'title', $self->getPrefixedDbKey() );
+                       Xml::fieldset( $this->msg( 'listusers' )->text() ) .
+                       Html::hidden( 'title', $self );
 
                # Username field
-               $out .= Xml::label( wfMsg( 'listusersfrom' ), 'offset' ) . ' ' .
+               $out .= Xml::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
                        Xml::input( 'username', 20, $this->requestedUser, array( 'id' => 'offset' ) ) . ' ';
 
                # Group drop-down list
-               $out .= Xml::label( wfMsg( 'group' ), 'group' ) . ' ' .
+               $out .= Xml::label( $this->msg( 'group' )->text(), 'group' ) . ' ' .
                        Xml::openElement('select',  array( 'name' => 'group', 'id' => 'group' ) ) .
-                       Xml::option( wfMsg( 'group-all' ), '' );
+                       Xml::option( $this->msg( 'group-all' )->text(), '' );
                foreach( $this->getAllGroups() as $group => $groupText )
                        $out .= Xml::option( $groupText, $group, $group == $this->requestedGroup );
-               $out .= Xml::closeElement( 'select' ) . '<br/>';
-               $out .= Xml::checkLabel( wfMsg('listusers-editsonly'), 'editsOnly', 'editsOnly', $this->editsOnly );
-               $out .= '&nbsp;';
-               $out .= Xml::checkLabel( wfMsg('listusers-creationsort'), 'creationSort', 'creationSort', $this->creationSort );
-               $out .= '<br/>';
+               $out .= Xml::closeElement( 'select' ) . '<br />';
+               $out .= Xml::checkLabel( $this->msg( 'listusers-editsonly' )->text(), 'editsOnly', 'editsOnly', $this->editsOnly );
+               $out .= '&#160;';
+               $out .= Xml::checkLabel( $this->msg( 'listusers-creationsort' )->text(), 'creationSort', 'creationSort', $this->creationSort );
+               $out .= '<br />';
 
                wfRunHooks( 'SpecialListusersHeaderForm', array( $this, &$out ) );
 
                # Submit button and form bottom
-               $out .= Xml::hidden( 'limit', $this->mLimit );
-               $out .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
+               $out .= Html::hidden( 'limit', $this->mLimit );
+               $out .= Xml::submitButton( $this->msg( 'allpagessubmit' )->text() );
                wfRunHooks( 'SpecialListusersHeader', array( $this, &$out ) );
                $out .= Xml::closeElement( 'fieldset' ) .
                        Xml::closeElement( 'form' );
@@ -246,7 +259,7 @@ class UsersPager extends AlphabeticPager {
         */
        protected static function getGroups( $uid ) {
                $user = User::newFromId( $uid );
-               $groups = array_diff( $user->getEffectiveGroups(), $user->getImplicitGroups() );
+               $groups = array_diff( $user->getEffectiveGroups(), User::getImplicitGroups() );
                return $groups;
        }
 
@@ -254,36 +267,49 @@ class UsersPager extends AlphabeticPager {
         * Format a link to a group description page
         *
         * @param $group String: group name
+        * @param $username String Username
         * @return string
         */
-       protected static function buildGroupLink( $group ) {
-               static $cache = array();
-               if( !isset( $cache[$group] ) )
-                       $cache[$group] = User::makeGroupLinkHtml( $group, htmlspecialchars( User::getGroupMember( $group ) ) );
-               return $cache[$group];
+       protected static function buildGroupLink( $group, $username ) {
+               return User::makeGroupLinkHtml( $group, htmlspecialchars( User::getGroupMember( $group, $username ) ) );
        }
 }
 
 /**
- * constructor
- * $par string (optional) A group to list users from
+ * @ingroup SpecialPage
  */
-function wfSpecialListusers( $par = null ) {
-       global $wgRequest, $wgOut;
-
-       $up = new UsersPager($par);
-
-       # getBody() first to check, if empty
-       $usersbody = $up->getBody();
-       $s = XML::openElement( 'div', array('class' => 'mw-spcontent') );
-       $s .= $up->getPageHeader();
-       if( $usersbody ) {
-               $s .=   $up->getNavigationBar();
-               $s .=   '<ul>' . $usersbody . '</ul>';
-               $s .=   $up->getNavigationBar() ;
-       } else {
-               $s .=   '<p>' . wfMsgHTML('listusers-noresult') . '</p>';
-       };
-       $s .= XML::closeElement( 'div' );
-       $wgOut->addHTML( $s );
+class SpecialListUsers extends SpecialPage {
+
+       /**
+        * Constructor
+        */
+       public function __construct() {
+               parent::__construct( 'Listusers' );
+       }
+
+       /**
+        * Show the special page
+        *
+        * @param $par string (optional) A group to list users from
+        */
+       public function execute( $par ) {
+               $this->setHeaders();
+               $this->outputHeader();
+
+               $up = new UsersPager( $this->getContext(), $par );
+
+               # getBody() first to check, if empty
+               $usersbody = $up->getBody();
+
+               $s = $up->getPageHeader();
+               if( $usersbody ) {
+                       $s .= $up->getNavigationBar();
+                       $s .= Html::rawElement( 'ul', array(), $usersbody );
+                       $s .= $up->getNavigationBar();
+               } else {
+                       $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
+               }
+
+               $this->getOutput()->addHTML( $s );
+       }
 }