diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2011-12-03 13:29:22 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2011-12-03 13:29:22 +0100 |
commit | ca32f08966f1b51fcb19460f0996bb0c4048e6fe (patch) | |
tree | ec04cc15b867bc21eedca904cea9af0254531a11 /includes/api/ApiQueryAllUsers.php | |
parent | a22fbfc60f36f5f7ee10d5ae6fe347340c2ee67c (diff) |
Update to MediaWiki 1.18.0
* also update ArchLinux skin to chagnes in MonoBook
* Use only css to hide our menu bar when printing
Diffstat (limited to 'includes/api/ApiQueryAllUsers.php')
-rw-r--r-- | includes/api/ApiQueryAllUsers.php | 189 |
1 files changed, 151 insertions, 38 deletions
diff --git a/includes/api/ApiQueryAllUsers.php b/includes/api/ApiQueryAllUsers.php index 77f507fc..c0984d95 100644 --- a/includes/api/ApiQueryAllUsers.php +++ b/includes/api/ApiQueryAllUsers.php @@ -1,6 +1,6 @@ <?php /** - * API for MediaWiki 1.8+ + * * * Created on July 7, 2007 * @@ -49,67 +49,119 @@ class ApiQueryAllUsers extends ApiQueryBase { $fld_blockinfo = isset( $prop['blockinfo'] ); $fld_editcount = isset( $prop['editcount'] ); $fld_groups = isset( $prop['groups'] ); + $fld_rights = isset( $prop['rights'] ); $fld_registration = isset( $prop['registration'] ); + $fld_implicitgroups = isset( $prop['implicitgroups'] ); } else { - $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = $fld_rights = false; + $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = $fld_rights = $fld_implicitgroups = false; } $limit = $params['limit']; - $this->addTables( 'user', 'u1' ); + + $this->addTables( 'user' ); $useIndex = true; - if ( !is_null( $params['from'] ) ) { - $this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) ); + $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); + $from = is_null( $params['from'] ) ? null : $this->keyToTitle( $params['from'] ); + $to = is_null( $params['to'] ) ? null : $this->keyToTitle( $params['to'] ); + + $this->addWhereRange( 'user_name', $dir, $from, $to ); + + if ( !is_null( $params['prefix'] ) ) { + $this->addWhere( 'user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) ); } - if ( !is_null( $params['to'] ) ) { - $this->addWhere( 'u1.user_name <= ' . $db->addQuotes( $this->keyToTitle( $params['to'] ) ) ); + + if ( !is_null( $params['rights'] ) ) { + $groups = array(); + foreach( $params['rights'] as $r ) { + $groups = array_merge( $groups, User::getGroupsWithPermission( $r ) ); + } + + $groups = array_unique( $groups ); + + if ( is_null( $params['group'] ) ) { + $params['group'] = $groups; + } else { + $params['group'] = array_unique( array_merge( $params['group'], $groups ) ); + } } - if ( !is_null( $params['prefix'] ) ) { - $this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) ); + if ( !is_null( $params['group'] ) && !is_null( $params['excludegroup'] ) ) { + $this->dieUsage( 'group and excludegroup cannot be used together', 'group-excludegroup' ); } - if ( !is_null( $params['group'] ) ) { + if ( !is_null( $params['group'] ) && count( $params['group'] ) ) { $useIndex = false; // Filter only users that belong to a given group $this->addTables( 'user_groups', 'ug1' ); - $ug1 = $this->getAliasedName( 'user_groups', 'ug1' ); - $this->addJoinConds( array( $ug1 => array( 'INNER JOIN', array( 'ug1.ug_user=u1.user_id', + $this->addJoinConds( array( 'ug1' => array( 'INNER JOIN', array( 'ug1.ug_user=user_id', 'ug1.ug_group' => $params['group'] ) ) ) ); } + if ( !is_null( $params['excludegroup'] ) && count( $params['excludegroup'] ) ) { + $useIndex = false; + // Filter only users don't belong to a given group + $this->addTables( 'user_groups', 'ug1' ); + + if ( count( $params['excludegroup'] ) == 1 ) { + $exclude = array( 'ug1.ug_group' => $params['excludegroup'][0] ); + } else { + $exclude = array( $db->makeList( array( 'ug1.ug_group' => $params['excludegroup'] ), LIST_OR ) ); + } + $this->addJoinConds( array( 'ug1' => array( 'LEFT OUTER JOIN', + array_merge( array( 'ug1.ug_user=user_id' ), $exclude ) + ) + ) ); + $this->addWhere( 'ug1.ug_user IS NULL' ); + } + if ( $params['witheditsonly'] ) { - $this->addWhere( 'u1.user_editcount > 0' ); + $this->addWhere( 'user_editcount > 0' ); } - if ( $fld_groups ) { + $this->showHiddenUsersAddBlockInfo( $fld_blockinfo ); + + if ( $fld_groups || $fld_rights ) { // Show the groups the given users belong to // request more than needed to avoid not getting all rows that belong to one user $groupCount = count( User::getAllGroups() ); $sqlLimit = $limit + $groupCount + 1; $this->addTables( 'user_groups', 'ug2' ); - $tname = $this->getAliasedName( 'user_groups', 'ug2' ); - $this->addJoinConds( array( $tname => array( 'LEFT JOIN', 'ug2.ug_user=u1.user_id' ) ) ); + $this->addJoinConds( array( 'ug2' => array( 'LEFT JOIN', 'ug2.ug_user=user_id' ) ) ); $this->addFields( 'ug2.ug_group ug_group2' ); } else { $sqlLimit = $limit + 1; } - $this->showHiddenUsersAddBlockInfo( $fld_blockinfo ); + + if ( $params['activeusers'] ) { + global $wgActiveUserDays; + $this->addTables( 'recentchanges' ); + + $this->addJoinConds( array( 'recentchanges' => array( + 'INNER JOIN', 'rc_user_text=user_name' + ) ) ); + + $this->addFields( 'COUNT(*) AS recentedits' ); + + $this->addWhere( "rc_log_type IS NULL OR rc_log_type != 'newusers'" ); + $timestamp = $db->timestamp( wfTimestamp( TS_UNIX ) - $wgActiveUserDays*24*3600 ); + $this->addWhere( "rc_timestamp >= {$db->addQuotes( $timestamp )}" ); + + $this->addOption( 'GROUP BY', 'user_name' ); + } $this->addOption( 'LIMIT', $sqlLimit ); $this->addFields( array( - 'u1.user_name', - 'u1.user_id' + 'user_name', + 'user_id' ) ); - $this->addFieldsIf( 'u1.user_editcount', $fld_editcount ); - $this->addFieldsIf( 'u1.user_registration', $fld_registration ); + $this->addFieldsIf( 'user_editcount', $fld_editcount ); + $this->addFieldsIf( 'user_registration', $fld_registration ); - $this->addOption( 'ORDER BY', 'u1.user_name' ); if ( $useIndex ) { - $u1 = $this->getAliasedName( 'user', 'u1' ); - $this->addOption( 'USE INDEX', array( $u1 => 'user_name' ) ); + $this->addOption( 'USE INDEX', array( 'user' => 'user_name' ) ); } $res = $this->select( __METHOD__ ); @@ -153,12 +205,13 @@ class ApiQueryAllUsers extends ApiQueryBase { // Record new user's data $lastUser = $row->user_name; $lastUserData = array( - 'name' => $lastUser, 'userid' => $row->user_id, + 'name' => $lastUser, ); - if ( $fld_blockinfo && !is_null( $row->blocker_name ) ) { - $lastUserData['blockedby'] = $row->blocker_name; + if ( $fld_blockinfo && !is_null( $row->ipb_by_text ) ) { + $lastUserData['blockedby'] = $row->ipb_by_text; $lastUserData['blockreason'] = $row->ipb_reason; + $lastUserData['blockexpiry'] = $row->ipb_expiry; } if ( $row->ipb_deleted ) { $lastUserData['hidden'] = ''; @@ -166,11 +219,13 @@ class ApiQueryAllUsers extends ApiQueryBase { if ( $fld_editcount ) { $lastUserData['editcount'] = intval( $row->user_editcount ); } + if ( $params['activeusers'] ) { + $lastUserData['recenteditcount'] = intval( $row->recentedits ); + } if ( $fld_registration ) { $lastUserData['registration'] = $row->user_registration ? wfTimestamp( TS_ISO_8601, $row->user_registration ) : ''; } - } if ( $sqlLimit == $count ) { @@ -181,10 +236,31 @@ class ApiQueryAllUsers extends ApiQueryBase { } // Add user's group info - if ( $fld_groups && !is_null( $row->ug_group2 ) ) { - $lastUserData['groups'][] = $row->ug_group2; + if ( $fld_groups ) { + if ( !isset( $lastUserData['groups'] ) ) { + $lastUserData['groups'] = ApiQueryUsers::getAutoGroups( User::newFromName( $lastUser ) ); + } + + if ( !is_null( $row->ug_group2 ) ) { + $lastUserData['groups'][] = $row->ug_group2; + } $result->setIndexedTagName( $lastUserData['groups'], 'g' ); } + + if ( $fld_implicitgroups && !isset( $lastUserData['implicitgroups'] ) ) { + $lastUserData['implicitgroups'] = ApiQueryUsers::getAutoGroups( User::newFromName( $lastUser ) ); + $result->setIndexedTagName( $lastUserData['implicitgroups'], 'g' ); + } + if ( $fld_rights ) { + if ( !isset( $lastUserData['rights'] ) ) { + $lastUserData['rights'] = User::getGroupPermissions( User::newFromName( $lastUser )->getAutomaticGroups() ); + } + if ( !is_null( $row->ug_group2 ) ) { + $lastUserData['rights'] = array_unique( array_merge( $lastUserData['rights'], + User::getGroupPermissions( array( $row->ug_group2 ) ) ) ); + } + $result->setIndexedTagName( $lastUserData['rights'], 'r' ); + } } if ( is_array( $lastUserData ) ) { @@ -204,18 +280,37 @@ class ApiQueryAllUsers extends ApiQueryBase { } public function getAllowedParams() { + $userGroups = User::getAllGroups(); return array( 'from' => null, 'to' => null, 'prefix' => null, + 'dir' => array( + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => array( + 'ascending', + 'descending' + ), + ), 'group' => array( - ApiBase::PARAM_TYPE => User::getAllGroups() + ApiBase::PARAM_TYPE => $userGroups, + ApiBase::PARAM_ISMULTI => true, + ), + 'excludegroup' => array( + ApiBase::PARAM_TYPE => $userGroups, + ApiBase::PARAM_ISMULTI => true, + ), + 'rights' => array( + ApiBase::PARAM_TYPE => User::getAllRights(), + ApiBase::PARAM_ISMULTI => true, ), 'prop' => array( ApiBase::PARAM_ISMULTI => true, ApiBase::PARAM_TYPE => array( 'blockinfo', 'groups', + 'implicitgroups', + 'rights', 'editcount', 'registration' ) @@ -228,24 +323,32 @@ class ApiQueryAllUsers extends ApiQueryBase { ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 ), 'witheditsonly' => false, + 'activeusers' => false, ); } public function getParamDescription() { + global $wgActiveUserDays; return array( 'from' => 'The user name to start enumerating from', 'to' => 'The user name to stop enumerating at', 'prefix' => 'Search for all users that begin with this value', - 'group' => 'Limit users to a given group name', + 'dir' => 'Direction to sort in', + 'group' => 'Limit users to given group name(s)', + 'excludegroup' => 'Exclude users in given group name(s)', + 'rights' => 'Limit users to given right(s)', 'prop' => array( 'What pieces of information to include.', - ' blockinfo - Adds the information about a current block on the user', - ' groups - Lists groups that the user is in', - ' editcount - Adds the edit count of the user', - ' registration - Adds the timestamp of when the user registered', - '`groups` property uses more server resources and may return fewer results than the limit' ), + ' blockinfo - Adds the information about a current block on the user', + ' groups - Lists groups that the user is in. This uses more server resources and may return fewer results than the limit', + ' implicitgroups - Lists all the groups the user is automatically in', + ' rights - Lists rights that the user has', + ' editcount - Adds the edit count of the user', + ' registration - Adds the timestamp of when the user registered if available (may be blank)', + ), 'limit' => 'How many total user names to return', 'witheditsonly' => 'Only list users who have made edits', + 'activeusers' => "Only list users active in the last {$wgActiveUserDays} days(s)" ); } @@ -253,13 +356,23 @@ class ApiQueryAllUsers extends ApiQueryBase { return 'Enumerate all registered users'; } + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'group-excludegroup', 'info' => 'group and excludegroup cannot be used together' ), + ) ); + } + protected function getExamples() { return array( 'api.php?action=query&list=allusers&aufrom=Y', ); } + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/API:Allusers'; + } + public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryAllUsers.php 85354 2011-04-04 18:25:31Z demon $'; + return __CLASS__ . ': $Id: ApiQueryAllUsers.php 104449 2011-11-28 15:52:04Z reedy $'; } } |