* @file
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- // Eclipse helper - will be ignored in production
- require_once( 'ApiQueryBase.php' );
-}
-
/**
* Query module to enumerate all registered users.
*
* @ingroup API
*/
class ApiQueryAllUsers extends ApiQueryBase {
-
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'au' );
}
+ /**
+ * This function converts the user name to a canonical form
+ * which is stored in the database.
+ * @param String $name
+ * @return String
+ */
+ private function getCanonicalUserName( $name ) {
+ return str_replace( '_', ' ', $name );
+ }
+
public function execute() {
$db = $this->getDB();
$params = $this->extractRequestParams();
$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 = 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'] ) ) );
- }
- if ( !is_null( $params['to'] ) ) {
- $this->addWhere( 'u1.user_name <= ' . $db->addQuotes( $this->keyToTitle( $params['to'] ) ) );
- }
+ $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
+ $from = is_null( $params['from'] ) ? null : $this->getCanonicalUserName( $params['from'] );
+ $to = is_null( $params['to'] ) ? null : $this->getCanonicalUserName( $params['to'] );
+
+ # MySQL doesn't seem to use 'equality propagation' here, so like the
+ # ActiveUsers special page, we have to use rc_user_text for some cases.
+ $userFieldToSort = $params['activeusers'] ? 'rc_user_text' : 'user_name';
+
+ $this->addWhereRange( $userFieldToSort, $dir, $from, $to );
if ( !is_null( $params['prefix'] ) ) {
- $this->addWhere( 'u1.user_name' . $db->buildLike( $this->keyToTitle( $params['prefix'] ), $db->anyString() ) );
+ $this->addWhere( $userFieldToSort .
+ $db->buildLike( $this->getCanonicalUserName( $params['prefix'] ), $db->anyString() ) );
}
if ( !is_null( $params['rights'] ) ) {
$groups = array_merge( $groups, User::getGroupsWithPermission( $r ) );
}
- $groups = array_diff( array_unique( $groups ), User::getImplicitGroups() );
+ $groups = array_unique( $groups );
if ( is_null( $params['group'] ) ) {
$params['group'] = $groups;
}
}
- if ( !is_null( $params['group'] ) ) {
+ 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'] ) && 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' );
}
+ $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
$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;
}
- if ( $fld_blockinfo ) {
- $this->addTables( 'ipblocks' );
- $this->addTables( 'user', 'u2' );
- $u2 = $this->getAliasedName( 'user', 'u2' );
- $this->addJoinConds( array(
- 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=u1.user_id' ),
- $u2 => array( 'LEFT JOIN', 'ipb_by=u2.user_id' ) ) );
- $this->addFields( array( 'ipb_reason', 'u2.user_name AS blocker_name' ) );
+
+ 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', $userFieldToSort );
}
$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__ );
if ( is_array( $lastUserData ) ) {
$fit = $result->addValue( array( 'query', $this->getModuleName() ),
null, $lastUserData );
+
+ $lastUserData = null;
+
if ( !$fit ) {
- $this->setContinueEnumParameter( 'from',
- $this->keyToTitle( $lastUserData['name'] ) );
+ $this->setContinueEnumParameter( 'from', $lastUserData['name'] );
break;
}
}
if ( $count > $limit ) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
- $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->user_name ) );
+ $this->setContinueEnumParameter( 'from', $row->user_name );
break;
}
// 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'] = '';
}
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 ) {
'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function' );
}
+ $lastUserObj = User::newFromId( $row->user_id );
+
// 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'] ) ) {
+ if ( $lastUserObj ) {
+ $lastUserData['groups'] = ApiQueryUsers::getAutoGroups( $lastUserObj );
+ } else {
+ // This should not normally happen
+ $lastUserData['groups'] = array();
+ }
+ }
+
+ if ( !is_null( $row->ug_group2 ) ) {
+ $lastUserData['groups'][] = $row->ug_group2;
+ }
+
$result->setIndexedTagName( $lastUserData['groups'], 'g' );
}
- if ( $fld_rights && !is_null( $row->ug_group2 ) ) {
+ if ( $fld_implicitgroups && !isset( $lastUserData['implicitgroups'] ) && $lastUserObj ) {
+ $lastUserData['implicitgroups'] = ApiQueryUsers::getAutoGroups( $lastUserObj );
+ $result->setIndexedTagName( $lastUserData['implicitgroups'], 'g' );
+ }
+ if ( $fld_rights ) {
if ( !isset( $lastUserData['rights'] ) ) {
- $lastUserData['rights'] = User::getGroupPermissions( User::getImplicitGroups() );
+ if ( $lastUserObj ) {
+ $lastUserData['rights'] = User::getGroupPermissions( $lastUserObj->getAutomaticGroups() );
+ } else {
+ // This should not normally happen
+ $lastUserData['rights'] = array();
+ }
+ }
+
+ if ( !is_null( $row->ug_group2 ) ) {
+ $lastUserData['rights'] = array_unique( array_merge( $lastUserData['rights'],
+ User::getGroupPermissions( array( $row->ug_group2 ) ) ) );
}
- $lastUserData['rights'] = array_unique( array_merge( $lastUserData['rights'],
- User::getGroupPermissions( array( $row->ug_group2 ) ) ) );
$result->setIndexedTagName( $lastUserData['rights'], 'r' );
}
}
$fit = $result->addValue( array( 'query', $this->getModuleName() ),
null, $lastUserData );
if ( !$fit ) {
- $this->setContinueEnumParameter( 'from',
- $this->keyToTitle( $lastUserData['name'] ) );
+ $this->setContinueEnumParameter( 'from', $lastUserData['name'] );
}
}
}
public function getCacheMode( $params ) {
- return 'public';
+ return 'anon-public-user-private';
}
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 => array(
'blockinfo',
'groups',
+ 'implicitgroups',
'rights',
'editcount',
'registration'
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',
+ '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. This uses more server resources and may return fewer results than the limit',
- ' rights - Lists rights that the user has',
- ' editcount - Adds the edit count of the user',
- ' registration - Adds the timestamp of when the user registered',
+ ' 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)"
);
}
return 'Enumerate all registered users';
}
- protected function getExamples() {
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'code' => 'group-excludegroup', 'info' => 'group and excludegroup cannot be used together' ),
+ ) );
+ }
+
+ public 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$';
}
dépôts / lhc / web / wiklou.git / blobdiff