/**
* Query module to enumerate all registered users.
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
class ApiQueryAllUsers extends ApiQueryBase {
$prop = $params['prop'];
if (!is_null($prop)) {
$prop = array_flip($prop);
+ $fld_blockinfo = isset($prop['blockinfo']);
$fld_editcount = isset($prop['editcount']);
$fld_groups = isset($prop['groups']);
- } else {
- $fld_editcount = $fld_groups = false;
+ $fld_registration = isset($prop['registration']);
+ } else {
+ $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = false;
}
$limit = $params['limit'];
- $tables = $db->tableName('user');
-
+ $this->addTables('user', 'u1');
+
if( !is_null( $params['from'] ) )
- $this->addWhere( 'user_name >= ' . $db->addQuotes( self::keyToTitle( $params['from'] ) ) );
-
+ $this->addWhere( 'u1.user_name >= ' . $db->addQuotes( $this->keyToTitle( $params['from'] ) ) );
+
if( isset( $params['prefix'] ) )
- $this->addWhere( 'user_name LIKE "' . $db->escapeLike( self::keyToTitle( $params['prefix'] ) ) . '%"' );
+ $this->addWhere( 'u1.user_name LIKE "' . $db->escapeLike( $this->keyToTitle( $params['prefix'] ) ) . '%"' );
if (!is_null($params['group'])) {
// Filter only users that belong to a given group
- $tblName = $db->tableName('user_groups');
- $tables = "$tables INNER JOIN $tblName ug1 ON ug1.ug_user=user_id";
+ $this->addTables('user_groups', 'ug1');
+ $this->addWhere('ug1.ug_user=u1.user_id');
$this->addWhereFld('ug1.ug_group', $params['group']);
}
$groupCount = count(User::getAllGroups());
$sqlLimit = $limit+$groupCount+1;
- $tblName = $db->tableName('user_groups');
- $tables = "$tables LEFT JOIN $tblName ug2 ON ug2.ug_user=user_id";
+ $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->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 blocker_name'));
+ }
$this->addOption('LIMIT', $sqlLimit);
- $this->addTables($tables);
- $this->addFields('user_name');
- $this->addFieldsIf('user_editcount', $fld_editcount);
+ $this->addFields('u1.user_name');
+ $this->addFieldsIf('u1.user_editcount', $fld_editcount);
+ $this->addFieldsIf('u1.user_registration', $fld_registration);
- $this->addOption('ORDER BY', 'user_name');
+ $this->addOption('ORDER BY', 'u1.user_name');
$res = $this->select(__METHOD__);
$lastUserData = false;
$lastUser = false;
$result = $this->getResult();
-
+
//
// This loop keeps track of the last entry.
// For each new row, if the new row is for different user then the last, the last entry is added to results.
// to make sure all rows that belong to the same user are received.
//
while (true) {
-
+
$row = $db->fetchObject($res);
$count++;
-
+
if (!$row || $lastUser != $row->user_name) {
// Save the last pass's user data
if (is_array($lastUserData))
$data[] = $lastUserData;
-
+
// No more rows left
if (!$row)
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', ApiQueryBase :: keyToTitle($row->user_name));
+ $this->setContinueEnumParameter('from', $this->keyToTitle($row->user_name));
break;
}
// Record new user's data
$lastUser = $row->user_name;
$lastUserData = array( 'name' => $lastUser );
+ if ($fld_blockinfo) {
+ $lastUserData['blockedby'] = $row->blocker_name;
+ $lastUserData['blockreason'] = $row->ipb_reason;
+ }
if ($fld_editcount)
$lastUserData['editcount'] = intval($row->user_editcount);
-
+ if ($fld_registration)
+ $lastUserData['registration'] = wfTimestamp(TS_ISO_8601, $row->user_registration);
+
}
-
+
if ($sqlLimit == $count) {
// BUG! database contains group name that User::getAllGroups() does not return
// TODO: should handle this more gracefully
- ApiBase :: dieDebug(__METHOD__,
+ ApiBase :: dieDebug(__METHOD__,
'MediaWiki configuration error: the database contains more user groups than known to User::getAllGroups() function');
}
-
+
// Add user's group info
if ($fld_groups && !is_null($row->ug_group2)) {
$lastUserData['groups'][] = $row->ug_group2;
$result->setIndexedTagName($lastUserData['groups'], 'g');
}
}
-
+
$db->freeResult($res);
$result->setIndexedTagName($data, 'u');
$result->addValue('query', $this->getModuleName(), $data);
}
- protected function getAllowedParams() {
+ public function getAllowedParams() {
return array (
'from' => null,
'prefix' => null,
ApiBase :: PARAM_TYPE => User::getAllGroups()
),
'prop' => array (
- ApiBase :: PARAM_ISMULTI => true,
+ ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
- 'editcount',
+ 'blockinfo',
'groups',
+ 'editcount',
+ 'registration'
)
),
'limit' => array (
);
}
- protected function getParamDescription() {
+ public function getParamDescription() {
return array (
'from' => 'The user name to start enumerating from.',
'prefix' => 'Search for all page titles that begin with this value.',
);
}
- protected function getDescription() {
+ public function getDescription() {
return 'Enumerate all registered users';
}
dépôts / lhc / web / wiklou.git / blobdiff