UsersPager - Code Metrics - Inspection of "Daily Inspection: Merge "Add new type SearchIndexF..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (098997)

unknown

created 2016-09-26 17:59 UTC

UsersPager B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	368
Duplicated Lines	1.9 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes

Metric	Value
dl	7
loc	368
rs	7.2559
c	0
b	0
f	0
wmc	50
lcom	1
cbo	15

10 Methods

Rating	Name	Duplication	Size	Complexity
D	__construct()	7	45	12
A	getIndexField()	0	3	2
C	getQueryInfo()	0	56	9
C	formatRow()	0	56	11
A	getPageHeader()	0	69	2
A	getAllGroups()	0	9	2
A	getDefaultQuery()	0	12	3
A	getGroups()	0	11	3
A	buildGroupLink()	0	6	1
B	doBatchLookups()	0	42	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UsersPager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UsersPager, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
 * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
 * 2006 Rob Church <[email protected]>
 *
 * 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 Pager
 */

/**
 * This class is used to get a list of user. The ones with specials
 * rights (sysop, bureaucrat, developer) will have them displayed
 * next to their names.
 *
 * @ingroup Pager
 */
class UsersPager extends AlphabeticPager {

	/**
	 * @var array A array with user ids as key and a array of groups as value
	 */
	protected $userGroupCache;

	/**
	 * @param IContextSource $context
	 * @param array $par (Default null)
	 * @param bool $including Whether this page is being transcluded in
	 * another page
	 */
	function __construct( IContextSource $context = null, $par = null, $including = null ) {
		if ( $context ) {
			$this->setContext( $context );
		}

		$request = $this->getRequest();
		$par = ( $par !== null ) ? $par : '';
		$parms = explode( '/', $par );
		$symsForAll = [ '*', 'user' ];

		if ( $parms[0] != '' &&
			( in_array( $par, User::getAllGroups() ) || in_array( $par, $symsForAll ) )
		) {
			$this->requestedGroup = $par;
class MyClass { }

$x = new MyClass();
$x->foo = true;
			$un = $request->getText( 'username' );
		} elseif ( count( $parms ) == 2 ) {
			$this->requestedGroup = $parms[0];
			$un = $parms[1];
		} else {
			$this->requestedGroup = $request->getVal( 'group' );
			$un = ( $par != '' ) ? $par : $request->getText( 'username' );
		}

		if ( in_array( $this->requestedGroup, $symsForAll ) ) {
			$this->requestedGroup = '';
		}
		$this->editsOnly = $request->getBool( 'editsOnly' );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->creationSort = $request->getBool( 'creationSort' );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->including = $including;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->mDefaultDirection = $request->getBool( 'desc' )
			? IndexPager::DIR_DESCENDING
			: IndexPager::DIR_ASCENDING;

		$this->requestedUser = '';
class MyClass { }

$x = new MyClass();
$x->foo = true;

		if ( $un != '' ) {
			$username = Title::makeTitleSafe( NS_USER, $un );

			if ( !is_null( $username ) ) {
				$this->requestedUser = $username->getText();
			}
		}

		parent::__construct();
	}

	/**
	 * @return string
	 */
	function getIndexField() {
		return $this->creationSort ? 'user_id' : 'user_name';
	}

	/**
	 * @return array
	 */
	function getQueryInfo() {
		$dbr = wfGetDB( DB_REPLICA );
		$conds = [];

		// Don't show hidden names
		if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
			$conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
		}

		$options = [];

		if ( $this->requestedGroup != '' ) {
			$conds['ug_group'] = $this->requestedGroup;
		}

		if ( $this->requestedUser != '' ) {
			# Sorted either by account creation or name
			if ( $this->creationSort ) {
				$conds[] = 'user_id >= ' . intval( User::idFromName( $this->requestedUser ) );
			} else {
				$conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser );
			}
		}

		if ( $this->editsOnly ) {
			$conds[] = 'user_editcount > 0';
		}

		$options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';

		$query = [
			'tables' => [ 'user', 'user_groups', 'ipblocks' ],
			'fields' => [
				'user_name' => $this->creationSort ? 'MAX(user_name)' : 'user_name',
				'user_id' => $this->creationSort ? 'user_id' : 'MAX(user_id)',
				'edits' => 'MAX(user_editcount)',
				'creation' => 'MIN(user_registration)',
				'ipb_deleted' => 'MAX(ipb_deleted)' // block/hide status
			],
			'options' => $options,
			'join_conds' => [
				'user_groups' => [ 'LEFT JOIN', 'user_id=ug_user' ],
				'ipblocks' => [
					'LEFT JOIN', [
						'user_id=ipb_user',
						'ipb_auto' => 0
					]
				],
			],
			'conds' => $conds
		];

		Hooks::run( 'SpecialListusersQueryInfo', [ $this, &$query ] );

		return $query;
	}

	/**
	 * @param stdClass $row
	 * @return string
	 */
	function formatRow( $row ) {
		if ( $row->user_id == 0 ) { # Bug 16487
			return '';
		}

		$userName = $row->user_name;

		$ulinks = Linker::userLink( $row->user_id, $userName );
		$ulinks .= Linker::userToolLinksRedContribs(
			$row->user_id,
			$userName,
			(int)$row->edits
		);

		$lang = $this->getLanguage();

		$groups = '';
		$groups_list = self::getGroups( intval( $row->user_id ), $this->userGroupCache );

		if ( !$this->including && count( $groups_list ) > 0 ) {
			$list = [];
			foreach ( $groups_list as $group ) {
				$list[] = self::buildGroupLink( $group, $userName );
			}
			$groups = $lang->commaList( $list );
		}

		$item = $lang->specialList( $ulinks, $groups );

		if ( $row->ipb_deleted ) {
			$item = "<span class=\"deleted\">$item</span>";
		}

		$edits = '';
		if ( !$this->including && $this->getConfig()->get( 'Edititis' ) ) {
			$count = $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped();
			$edits = $this->msg( 'word-separator' )->escaped() . $this->msg( 'brackets', $count )->escaped();
		}

		$created = '';
		# Some rows may be null
		if ( !$this->including && $row->creation ) {
			$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();
		}
		$blocked = !is_null( $row->ipb_deleted ) ?
			' ' . $this->msg( 'listusers-blocked', $userName )->escaped() :
			'';

		Hooks::run( 'SpecialListusersFormatRow', [ &$item, $row ] );

		return Html::rawElement( 'li', [], "{$item}{$edits}{$created}{$blocked}" );
	}

	function doBatchLookups() {
		$batch = new LinkBatch();
		$userIds = [];
		# 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 );
			$userIds[] = $row->user_id;
		}

		// Lookup groups for all the users
		$dbr = wfGetDB( DB_REPLICA );
		$groupRes = $dbr->select(
			'user_groups',
			[ 'ug_user', 'ug_group' ],
			[ 'ug_user' => $userIds ],
			__METHOD__
		);
		$cache = [];
		$groups = [];
		foreach ( $groupRes as $row ) {
			$cache[intval( $row->ug_user )][] = $row->ug_group;
			$groups[$row->ug_group] = true;
		}

		// Give extensions a chance to add things like global user group data
		// into the cache array to ensure proper output later on
		Hooks::run( 'UsersPagerDoBatchLookups', [ $dbr, $userIds, &$cache, &$groups ] );

		$this->userGroupCache = $cache;

		// Add page of groups to link batch
		foreach ( $groups as $group => $unused ) {
			$groupPage = User::getGroupPage( $group );
			if ( $groupPage ) {
				$batch->addObj( $groupPage );
			}
		}

		$batch->execute();
		$this->mResult->rewind();
	}

	/**
	 * @return string
	 */
	function getPageHeader() {
		list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );

		$this->getOutput()->addModules( 'mediawiki.userSuggest' );

		# Form tag
		$out = Xml::openElement(
				'form',
				[ 'method' => 'get', 'action' => wfScript(), 'id' => 'mw-listusers-form' ]
			) .
			Xml::fieldset( $this->msg( 'listusers' )->text() ) .
			Html::hidden( 'title', $self );

		# Username field (with autocompletion support)
		$out .= Xml::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
			Html::input(
				'username',
				$this->requestedUser,
				'text',
				[
					'class' => 'mw-autocomplete-user',
					'id' => 'offset',
					'size' => 20,
					'autofocus' => $this->requestedUser === ''
				]
			) . ' ';

		# Group drop-down list
		$sel = new XmlSelect( 'group', 'group', $this->requestedGroup );
		$sel->addOption( $this->msg( 'group-all' )->text(), '' );
		foreach ( $this->getAllGroups() as $group => $groupText ) {
			$sel->addOption( $groupText, $group );
		}

		$out .= Xml::label( $this->msg( 'group' )->text(), 'group' ) . ' ';
		$out .= $sel->getHTML() . '<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 .= '&#160;';
		$out .= Xml::checkLabel(
			$this->msg( 'listusers-desc' )->text(),
			'desc',
			'desc',
			$this->mDefaultDirection
		);
		$out .= '<br />';

		Hooks::run( 'SpecialListusersHeaderForm', [ $this, &$out ] );

		# Submit button and form bottom
		$out .= Html::hidden( 'limit', $this->mLimit );
		$out .= Xml::submitButton( $this->msg( 'listusers-submit' )->text() );
		Hooks::run( 'SpecialListusersHeader', [ $this, &$out ] );
		$out .= Xml::closeElement( 'fieldset' ) .
			Xml::closeElement( 'form' );

		return $out;
	}

	/**
	 * Get a list of all explicit groups
	 * @return array
	 */
	function getAllGroups() {
		$result = [];
		foreach ( User::getAllGroups() as $group ) {
			$result[$group] = User::getGroupName( $group );
		}
		asort( $result );

		return $result;
	}

	/**
	 * Preserve group and username offset parameters when paging
	 * @return array
	 */
	function getDefaultQuery() {
		$query = parent::getDefaultQuery();
		if ( $this->requestedGroup != '' ) {
			$query['group'] = $this->requestedGroup;
		}
		if ( $this->requestedUser != '' ) {
			$query['username'] = $this->requestedUser;
		}
		Hooks::run( 'SpecialListusersDefaultQuery', [ $this, &$query ] );

		return $query;
	}

	/**
	 * Get a list of groups the specified user belongs to
	 *
	 * @param int $uid User id
	 * @param array|null $cache
	 * @return array
	 */
	protected static function getGroups( $uid, $cache = null ) {
		if ( $cache === null ) {
			$user = User::newFromId( $uid );
			$effectiveGroups = $user->getEffectiveGroups();
		} else {
			$effectiveGroups = isset( $cache[$uid] ) ? $cache[$uid] : [];
		}
		$groups = array_diff( $effectiveGroups, User::getImplicitGroups() );

		return $groups;
	}

	/**
	 * Format a link to a group description page
	 *
	 * @param string $group Group name
	 * @param string $username Username
	 * @return string
	 */
	protected static function buildGroupLink( $group, $username ) {
		return User::makeGroupLinkHTML(
			$group,
			User::getGroupMember( $group, $username )
		);
	}

}


1		<?php
2		/**
3		* Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
4		* Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
5		* 2006 Rob Church <[email protected]>
6		*
7		* This program is free software; you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation; either version 2 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License along
18		* with this program; if not, write to the Free Software Foundation, Inc.,
19		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20		* http://www.gnu.org/copyleft/gpl.html
21		*
22		* @file
23		* @ingroup Pager
24		*/
25
26		/**
27		* This class is used to get a list of user. The ones with specials
28		* rights (sysop, bureaucrat, developer) will have them displayed
29		* next to their names.
30		*
31		* @ingroup Pager
32		*/
33		class UsersPager extends AlphabeticPager {
34
35		/**
36		* @var array A array with user ids as key and a array of groups as value
37		*/
38		protected $userGroupCache;
39
40		/**
41		* @param IContextSource $context
42		* @param array $par (Default null)
43		* @param bool $including Whether this page is being transcluded in
44		* another page
45		*/
46		function __construct( IContextSource $context = null, $par = null, $including = null ) {
47		if ( $context ) {
48		$this->setContext( $context );
49		}
50
51		$request = $this->getRequest();
52		$par = ( $par !== null ) ? $par : '';
53		$parms = explode( '/', $par );
54		$symsForAll = [ '*', 'user' ];
55
56		if ( $parms[0] != '' &&
57		( in_array( $par, User::getAllGroups() ) \|\| in_array( $par, $symsForAll ) )
58		) {
59		$this->requestedGroup = $par;
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `requestedGroup` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
60		$un = $request->getText( 'username' );
61		} elseif ( count( $parms ) == 2 ) {
62		$this->requestedGroup = $parms[0];
63		$un = $parms[1];
64		} else {
65		$this->requestedGroup = $request->getVal( 'group' );
66		$un = ( $par != '' ) ? $par : $request->getText( 'username' );
67		}
68
69		if ( in_array( $this->requestedGroup, $symsForAll ) ) {
70		$this->requestedGroup = '';
71		}
72		$this->editsOnly = $request->getBool( 'editsOnly' );
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `editsOnly` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
73		$this->creationSort = $request->getBool( 'creationSort' );
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `creationSort` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
74		$this->including = $including;
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `including` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
75		$this->mDefaultDirection = $request->getBool( 'desc' )
76		? IndexPager::DIR_DESCENDING
77		: IndexPager::DIR_ASCENDING;
78
79		$this->requestedUser = '';
		0 ignored issues – show Bug introduced 2016-03-28 17:29 UTC by Report Bug Copy Issue Report The property `requestedUser` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
80
81	View Code Duplication	if ( $un != '' ) {
82		$username = Title::makeTitleSafe( NS_USER, $un );
83
84		if ( !is_null( $username ) ) {
85		$this->requestedUser = $username->getText();
86		}
87		}
88
89		parent::__construct();
90		}
91
92		/**
93		* @return string
94		*/
95		function getIndexField() {
96		return $this->creationSort ? 'user_id' : 'user_name';
97		}
98
99		/**
100		* @return array
101		*/
102		function getQueryInfo() {
103		$dbr = wfGetDB( DB_REPLICA );
104		$conds = [];
105
106		// Don't show hidden names
107		if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
108		$conds[] = 'ipb_deleted IS NULL OR ipb_deleted = 0';
109		}
110
111		$options = [];
112
113		if ( $this->requestedGroup != '' ) {
114		$conds['ug_group'] = $this->requestedGroup;
115		}
116
117		if ( $this->requestedUser != '' ) {
118		# Sorted either by account creation or name
119		if ( $this->creationSort ) {
120		$conds[] = 'user_id >= ' . intval( User::idFromName( $this->requestedUser ) );
121		} else {
122		$conds[] = 'user_name >= ' . $dbr->addQuotes( $this->requestedUser );
123		}
124		}
125
126		if ( $this->editsOnly ) {
127		$conds[] = 'user_editcount > 0';
128		}
129
130		$options['GROUP BY'] = $this->creationSort ? 'user_id' : 'user_name';
131
132		$query = [
133		'tables' => [ 'user', 'user_groups', 'ipblocks' ],
134		'fields' => [
135		'user_name' => $this->creationSort ? 'MAX(user_name)' : 'user_name',
136		'user_id' => $this->creationSort ? 'user_id' : 'MAX(user_id)',
137		'edits' => 'MAX(user_editcount)',
138		'creation' => 'MIN(user_registration)',
139		'ipb_deleted' => 'MAX(ipb_deleted)' // block/hide status
140		],
141		'options' => $options,
142		'join_conds' => [
143		'user_groups' => [ 'LEFT JOIN', 'user_id=ug_user' ],
144		'ipblocks' => [
145		'LEFT JOIN', [
146		'user_id=ipb_user',
147		'ipb_auto' => 0
148		]
149		],
150		],
151		'conds' => $conds
152		];
153
154		Hooks::run( 'SpecialListusersQueryInfo', [ $this, &$query ] );
155
156		return $query;
157		}
158
159		/**
160		* @param stdClass $row
161		* @return string
162		*/
163		function formatRow( $row ) {
164		if ( $row->user_id == 0 ) { # Bug 16487
165		return '';
166		}
167
168		$userName = $row->user_name;
169
170		$ulinks = Linker::userLink( $row->user_id, $userName );
171		$ulinks .= Linker::userToolLinksRedContribs(
172		$row->user_id,
173		$userName,
174		(int)$row->edits
175		);
176
177		$lang = $this->getLanguage();
178
179		$groups = '';
180		$groups_list = self::getGroups( intval( $row->user_id ), $this->userGroupCache );
181
182		if ( !$this->including && count( $groups_list ) > 0 ) {
183		$list = [];
184		foreach ( $groups_list as $group ) {
185		$list[] = self::buildGroupLink( $group, $userName );
186		}
187		$groups = $lang->commaList( $list );
188		}
189
190		$item = $lang->specialList( $ulinks, $groups );
191
192		if ( $row->ipb_deleted ) {
193		$item = "<span class=\"deleted\">$item</span>";
194		}
195
196		$edits = '';
197		if ( !$this->including && $this->getConfig()->get( 'Edititis' ) ) {
198		$count = $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped();
199		$edits = $this->msg( 'word-separator' )->escaped() . $this->msg( 'brackets', $count )->escaped();
200		}
201
202		$created = '';
203		# Some rows may be null
204		if ( !$this->including && $row->creation ) {
205		$user = $this->getUser();
206		$d = $lang->userDate( $row->creation, $user );
207		$t = $lang->userTime( $row->creation, $user );
208		$created = $this->msg( 'usercreated', $d, $t, $row->user_name )->escaped();
209		$created = ' ' . $this->msg( 'parentheses' )->rawParams( $created )->escaped();
210		}
211		$blocked = !is_null( $row->ipb_deleted ) ?
212		' ' . $this->msg( 'listusers-blocked', $userName )->escaped() :
213		'';
214
215		Hooks::run( 'SpecialListusersFormatRow', [ &$item, $row ] );
216
217		return Html::rawElement( 'li', [], "{$item}{$edits}{$created}{$blocked}" );
218		}
219
220		function doBatchLookups() {
221		$batch = new LinkBatch();
222		$userIds = [];
223		# Give some pointers to make user links
224		foreach ( $this->mResult as $row ) {
225		$batch->add( NS_USER, $row->user_name );
226		$batch->add( NS_USER_TALK, $row->user_name );
227		$userIds[] = $row->user_id;
228		}
229
230		// Lookup groups for all the users
231		$dbr = wfGetDB( DB_REPLICA );
232		$groupRes = $dbr->select(
233		'user_groups',
234		[ 'ug_user', 'ug_group' ],
235		[ 'ug_user' => $userIds ],
236		__METHOD__
237		);
238		$cache = [];
239		$groups = [];
240		foreach ( $groupRes as $row ) {
241		$cache[intval( $row->ug_user )][] = $row->ug_group;
242		$groups[$row->ug_group] = true;
243		}
244
245		// Give extensions a chance to add things like global user group data
246		// into the cache array to ensure proper output later on
247		Hooks::run( 'UsersPagerDoBatchLookups', [ $dbr, $userIds, &$cache, &$groups ] );
248
249		$this->userGroupCache = $cache;
250
251		// Add page of groups to link batch
252		foreach ( $groups as $group => $unused ) {
253		$groupPage = User::getGroupPage( $group );
254		if ( $groupPage ) {
255		$batch->addObj( $groupPage );
256		}
257		}
258
259		$batch->execute();
260		$this->mResult->rewind();
261		}
262
263		/**
264		* @return string
265		*/
266		function getPageHeader() {
267		list( $self ) = explode( '/', $this->getTitle()->getPrefixedDBkey() );
268
269		$this->getOutput()->addModules( 'mediawiki.userSuggest' );
270
271		# Form tag
272		$out = Xml::openElement(
273		'form',
274		[ 'method' => 'get', 'action' => wfScript(), 'id' => 'mw-listusers-form' ]
275		) .
276		Xml::fieldset( $this->msg( 'listusers' )->text() ) .
277		Html::hidden( 'title', $self );
278
279		# Username field (with autocompletion support)
280		$out .= Xml::label( $this->msg( 'listusersfrom' )->text(), 'offset' ) . ' ' .
281		Html::input(
282		'username',
283		$this->requestedUser,
284		'text',
285		[
286		'class' => 'mw-autocomplete-user',
287		'id' => 'offset',
288		'size' => 20,
289		'autofocus' => $this->requestedUser === ''
290		]
291		) . ' ';
292
293		# Group drop-down list
294		$sel = new XmlSelect( 'group', 'group', $this->requestedGroup );
295		$sel->addOption( $this->msg( 'group-all' )->text(), '' );
296		foreach ( $this->getAllGroups() as $group => $groupText ) {
297		$sel->addOption( $groupText, $group );
298		}
299
300		$out .= Xml::label( $this->msg( 'group' )->text(), 'group' ) . ' ';
301		$out .= $sel->getHTML() . '<br />';
302		$out .= Xml::checkLabel(
303		$this->msg( 'listusers-editsonly' )->text(),
304		'editsOnly',
305		'editsOnly',
306		$this->editsOnly
307		);
308		$out .= ' ';
309		$out .= Xml::checkLabel(
310		$this->msg( 'listusers-creationsort' )->text(),
311		'creationSort',
312		'creationSort',
313		$this->creationSort
314		);
315		$out .= ' ';
316		$out .= Xml::checkLabel(
317		$this->msg( 'listusers-desc' )->text(),
318		'desc',
319		'desc',
320		$this->mDefaultDirection
321		);
322		$out .= '<br />';
323
324		Hooks::run( 'SpecialListusersHeaderForm', [ $this, &$out ] );
325
326		# Submit button and form bottom
327		$out .= Html::hidden( 'limit', $this->mLimit );
328		$out .= Xml::submitButton( $this->msg( 'listusers-submit' )->text() );
329		Hooks::run( 'SpecialListusersHeader', [ $this, &$out ] );
330		$out .= Xml::closeElement( 'fieldset' ) .
331		Xml::closeElement( 'form' );
332
333		return $out;
334		}
335
336		/**
337		* Get a list of all explicit groups
338		* @return array
339		*/
340		function getAllGroups() {
341		$result = [];
342		foreach ( User::getAllGroups() as $group ) {
343		$result[$group] = User::getGroupName( $group );
344		}
345		asort( $result );
346
347		return $result;
348		}
349
350		/**
351		* Preserve group and username offset parameters when paging
352		* @return array
353		*/
354		function getDefaultQuery() {
355		$query = parent::getDefaultQuery();
356		if ( $this->requestedGroup != '' ) {
357		$query['group'] = $this->requestedGroup;
358		}
359		if ( $this->requestedUser != '' ) {
360		$query['username'] = $this->requestedUser;
361		}
362		Hooks::run( 'SpecialListusersDefaultQuery', [ $this, &$query ] );
363
364		return $query;
365		}
366
367		/**
368		* Get a list of groups the specified user belongs to
369		*
370		* @param int $uid User id
371		* @param array\|null $cache
372		* @return array
373		*/
374		protected static function getGroups( $uid, $cache = null ) {
375		if ( $cache === null ) {
376		$user = User::newFromId( $uid );
377		$effectiveGroups = $user->getEffectiveGroups();
378		} else {
379		$effectiveGroups = isset( $cache[$uid] ) ? $cache[$uid] : [];
380		}
381		$groups = array_diff( $effectiveGroups, User::getImplicitGroups() );
382
383		return $groups;
384		}
385
386		/**
387		* Format a link to a group description page
388		*
389		* @param string $group Group name
390		* @param string $username Username
391		* @return string
392		*/
393		protected static function buildGroupLink( $group, $username ) {
394		return User::makeGroupLinkHTML(
395		$group,
396		User::getGroupMember( $group, $username )
397		);
398		}
399
400		}
401

wikimedia / mediawiki