public function execute()
{
$params = $this->extractRequestParams();
if (!is_null($params['prop'])) {
$this->prop = array_flip($params['prop']);
} else {
$this->prop = [];
}
$users = (array) $params['users'];
$goodNames = $done = [];
$result = $this->getResult();
// Canonicalize user names
foreach ($users as $u) {
$n = User::getCanonicalName($u);
if ($n === false || $n === '') {
$vals = ['name' => $u, 'invalid' => true];
$fit = $result->addValue(['query', $this->getModuleName()], null, $vals);
if (!$fit) {
$this->setContinueEnumParameter('users', implode('|', array_diff($users, $done)));
$goodNames = [];
break;
}
$done[] = $u;
} else {
$goodNames[] = $n;
}
}
$result = $this->getResult();
if (count($goodNames)) {
$this->addTables('user');
$this->addFields(User::selectFields());
$this->addWhereFld('user_name', $goodNames);
$this->showHiddenUsersAddBlockInfo(isset($this->prop['blockinfo']));
$data = [];
$res = $this->select(__METHOD__);
$this->resetQueryParams();
// get user groups if needed
if (isset($this->prop['groups']) || isset($this->prop['rights'])) {
$userGroups = [];
$this->addTables('user');
$this->addWhereFld('user_name', $goodNames);
$this->addTables('user_groups');
$this->addJoinConds(['user_groups' => ['INNER JOIN', 'ug_user=user_id']]);
$this->addFields(['user_name', 'ug_group']);
$userGroupsRes = $this->select(__METHOD__);
foreach ($userGroupsRes as $row) {
$userGroups[$row->user_name][] = $row->ug_group;
}
}
foreach ($res as $row) {
// create user object and pass along $userGroups if set
// that reduces the number of database queries needed in User dramatically
if (!isset($userGroups)) {
$user = User::newFromRow($row);
} else {
if (!isset($userGroups[$row->user_name]) || !is_array($userGroups[$row->user_name])) {
$userGroups[$row->user_name] = [];
}
$user = User::newFromRow($row, ['user_groups' => $userGroups[$row->user_name]]);
}
$name = $user->getName();
$data[$name]['userid'] = $user->getId();
$data[$name]['name'] = $name;
if (isset($this->prop['editcount'])) {
$data[$name]['editcount'] = $user->getEditCount();
}
if (isset($this->prop['registration'])) {
$data[$name]['registration'] = wfTimestampOrNull(TS_ISO_8601, $user->getRegistration());
}
if (isset($this->prop['groups'])) {
$data[$name]['groups'] = $user->getEffectiveGroups();
}
if (isset($this->prop['implicitgroups'])) {
$data[$name]['implicitgroups'] = $user->getAutomaticGroups();
}
if (isset($this->prop['rights'])) {
$data[$name]['rights'] = $user->getRights();
}
if ($row->ipb_deleted) {
$data[$name]['hidden'] = true;
}
if (isset($this->prop['blockinfo']) && !is_null($row->ipb_by_text)) {
$data[$name]['blockid'] = (int) $row->ipb_id;
$data[$name]['blockedby'] = $row->ipb_by_text;
$data[$name]['blockedbyid'] = (int) $row->ipb_by;
$data[$name]['blockedtimestamp'] = wfTimestamp(TS_ISO_8601, $row->ipb_timestamp);
$data[$name]['blockreason'] = $row->ipb_reason;
$data[$name]['blockexpiry'] = $row->ipb_expiry;
}
if (isset($this->prop['emailable'])) {
$data[$name]['emailable'] = $user->canReceiveEmail();
}
if (isset($this->prop['gender'])) {
$gender = $user->getOption('gender');
if (strval($gender) === '') {
$gender = 'unknown';
}
$data[$name]['gender'] = $gender;
}
if (isset($this->prop['centralids'])) {
$data[$name] += ApiQueryUserInfo::getCentralUserInfo($this->getConfig(), $user, $params['attachedwiki']);
}
if (!is_null($params['token'])) {
$tokenFunctions = $this->getTokenFunctions();
foreach ($params['token'] as $t) {
$val = call_user_func($tokenFunctions[$t], $user);
if ($val === false) {
$this->setWarning("Action '{$t}' is not allowed for the current user");
} else {
$data[$name][$t . 'token'] = $val;
}
}
}
}
}
$context = $this->getContext();
// Second pass: add result data to $retval
foreach ($goodNames as $u) {
if (!isset($data[$u])) {
$data[$u] = ['name' => $u];
$urPage = new UserrightsPage();
$urPage->setContext($context);
$iwUser = $urPage->fetchUser($u);
if ($iwUser instanceof UserRightsProxy) {
$data[$u]['interwiki'] = true;
if (!is_null($params['token'])) {
$tokenFunctions = $this->getTokenFunctions();
foreach ($params['token'] as $t) {
$val = call_user_func($tokenFunctions[$t], $iwUser);
if ($val === false) {
$this->setWarning("Action '{$t}' is not allowed for the current user");
} else {
$data[$u][$t . 'token'] = $val;
}
}
}
} else {
$data[$u]['missing'] = true;
if (isset($this->prop['cancreate'])) {
$status = MediaWiki\Auth\AuthManager::singleton()->canCreateAccount($u);
$data[$u]['cancreate'] = $status->isGood();
if (!$status->isGood()) {
$data[$u]['cancreateerror'] = $this->getErrorFormatter()->arrayFromStatus($status);
}
}
}
} else {
if (isset($this->prop['groups']) && isset($data[$u]['groups'])) {
ApiResult::setArrayType($data[$u]['groups'], 'array');
ApiResult::setIndexedTagName($data[$u]['groups'], 'g');
}
if (isset($this->prop['implicitgroups']) && isset($data[$u]['implicitgroups'])) {
ApiResult::setArrayType($data[$u]['implicitgroups'], 'array');
ApiResult::setIndexedTagName($data[$u]['implicitgroups'], 'g');
}
if (isset($this->prop['rights']) && isset($data[$u]['rights'])) {
ApiResult::setArrayType($data[$u]['rights'], 'array');
ApiResult::setIndexedTagName($data[$u]['rights'], 'r');
}
}
$fit = $result->addValue(['query', $this->getModuleName()], null, $data[$u]);
if (!$fit) {
$this->setContinueEnumParameter('users', implode('|', array_diff($users, $done)));
break;
}
$done[] = $u;
}
$result->addIndexedTagName(['query', $this->getModuleName()], 'user');
}
public function execute()
{
$params = $this->extractRequestParams();
$activeUserDays = $this->getConfig()->get('ActiveUserDays');
$db = $this->getDB();
$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']);
$fld_rights = isset($prop['rights']);
$fld_registration = isset($prop['registration']);
$fld_implicitgroups = isset($prop['implicitgroups']);
$fld_centralids = isset($prop['centralids']);
} else {
$fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration = $fld_rights = $fld_implicitgroups = $fld_centralids = false;
}
$limit = $params['limit'];
$this->addTables('user');
$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 can't figure out that 'user_name' and 'qcc_title' are the same
# despite the JOIN condition, so manually sort on the correct one.
$userFieldToSort = $params['activeusers'] ? 'qcc_title' : 'user_name';
# Some of these subtable joins are going to give us duplicate rows, so
# calculate the maximum number of duplicates we might see.
$maxDuplicateRows = 1;
$this->addWhereRange($userFieldToSort, $dir, $from, $to);
if (!is_null($params['prefix'])) {
$this->addWhere($userFieldToSort . $db->buildLike($this->getCanonicalUserName($params['prefix']), $db->anyString()));
}
if (!is_null($params['rights']) && count($params['rights'])) {
$groups = array();
foreach ($params['rights'] as $r) {
$groups = array_merge($groups, User::getGroupsWithPermission($r));
}
// no group with the given right(s) exists, no need for a query
if (!count($groups)) {
$this->getResult()->addIndexedTagName(array('query', $this->getModuleName()), '');
return;
}
$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['group']) && !is_null($params['excludegroup'])) {
$this->dieUsage('group and excludegroup cannot be used together', 'group-excludegroup');
}
if (!is_null($params['group']) && count($params['group'])) {
// Filter only users that belong to a given group. This might
// produce as many rows-per-user as there are groups being checked.
$this->addTables('user_groups', 'ug1');
$this->addJoinConds(array('ug1' => array('INNER JOIN', array('ug1.ug_user=user_id', 'ug1.ug_group' => $params['group']))));
$maxDuplicateRows *= count($params['group']);
}
if (!is_null($params['excludegroup']) && count($params['excludegroup'])) {
// Filter only users don't belong to a given group. This can only
// produce one row-per-user, because we only keep on "no match".
$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('user_editcount > 0');
}
$this->showHiddenUsersAddBlockInfo($fld_blockinfo);
if ($fld_groups || $fld_rights) {
$this->addFields(array('groups' => $db->buildGroupConcatField('|', 'user_groups', 'ug_group', 'ug_user=user_id')));
}
if ($params['activeusers']) {
$activeUserSeconds = $activeUserDays * 86400;
// Filter query to only include users in the active users cache.
// There shouldn't be any duplicate rows in querycachetwo here.
$this->addTables('querycachetwo');
$this->addJoinConds(array('querycachetwo' => array('INNER JOIN', array('qcc_type' => 'activeusers', 'qcc_namespace' => NS_USER, 'qcc_title=user_name'))));
// Actually count the actions using a subquery (bug 64505 and bug 64507)
$timestamp = $db->timestamp(wfTimestamp(TS_UNIX) - $activeUserSeconds);
$this->addFields(array('recentactions' => '(' . $db->selectSQLText('recentchanges', 'COUNT(*)', array('rc_user_text = user_name', 'rc_type != ' . $db->addQuotes(RC_EXTERNAL), 'rc_log_type IS NULL OR rc_log_type != ' . $db->addQuotes('newusers'), 'rc_timestamp >= ' . $db->addQuotes($timestamp))) . ')'));
}
$sqlLimit = $limit + $maxDuplicateRows;
$this->addOption('LIMIT', $sqlLimit);
$this->addFields(array('user_name', 'user_id'));
$this->addFieldsIf('user_editcount', $fld_editcount);
$this->addFieldsIf('user_registration', $fld_registration);
$res = $this->select(__METHOD__);
$count = 0;
$countDuplicates = 0;
$lastUser = false;
$result = $this->getResult();
foreach ($res as $row) {
$count++;
if ($lastUser === $row->user_name) {
// Duplicate row due to one of the needed subtable joins.
// Ignore it, but count the number of them to sanely handle
// miscalculation of $maxDuplicateRows.
$countDuplicates++;
if ($countDuplicates == $maxDuplicateRows) {
ApiBase::dieDebug(__METHOD__, 'Saw more duplicate rows than expected');
}
continue;
}
$countDuplicates = 0;
$lastUser = $row->user_name;
if ($count > $limit) {
// We've reached the one extra which shows that there are
// additional pages to be had. Stop here...
$this->setContinueEnumParameter('from', $row->user_name);
break;
}
if ($count == $sqlLimit) {
// Should never hit this (either the $countDuplicates check or
// the $count > $limit check should hit first), but check it
// anyway just in case.
ApiBase::dieDebug(__METHOD__, 'Saw more duplicate rows than expected');
}
if ($params['activeusers'] && $row->recentactions === 0) {
// activeusers cache was out of date
continue;
}
$data = array('userid' => (int) $row->user_id, 'name' => $row->user_name);
if ($fld_centralids) {
$data += ApiQueryUserInfo::getCentralUserInfo($this->getConfig(), User::newFromId($row->user_id), $params['attachedwiki']);
}
if ($fld_blockinfo && !is_null($row->ipb_by_text)) {
$data['blockid'] = (int) $row->ipb_id;
$data['blockedby'] = $row->ipb_by_text;
$data['blockedbyid'] = (int) $row->ipb_by;
$data['blockedtimestamp'] = wfTimestamp(TS_ISO_8601, $row->ipb_timestamp);
$data['blockreason'] = $row->ipb_reason;
$data['blockexpiry'] = $row->ipb_expiry;
}
if ($row->ipb_deleted) {
$data['hidden'] = true;
}
if ($fld_editcount) {
$data['editcount'] = intval($row->user_editcount);
}
if ($params['activeusers']) {
$data['recentactions'] = intval($row->recentactions);
// @todo 'recenteditcount' is set for BC, remove in 1.25
$data['recenteditcount'] = $data['recentactions'];
}
if ($fld_registration) {
$data['registration'] = $row->user_registration ? wfTimestamp(TS_ISO_8601, $row->user_registration) : '';
}
if ($fld_implicitgroups || $fld_groups || $fld_rights) {
$implicitGroups = User::newFromId($row->user_id)->getAutomaticGroups();
if (isset($row->groups) && $row->groups !== '') {
$groups = array_merge($implicitGroups, explode('|', $row->groups));
} else {
$groups = $implicitGroups;
}
if ($fld_groups) {
$data['groups'] = $groups;
ApiResult::setIndexedTagName($data['groups'], 'g');
ApiResult::setArrayType($data['groups'], 'array');
}
if ($fld_implicitgroups) {
$data['implicitgroups'] = $implicitGroups;
ApiResult::setIndexedTagName($data['implicitgroups'], 'g');
ApiResult::setArrayType($data['implicitgroups'], 'array');
}
if ($fld_rights) {
$data['rights'] = User::getGroupPermissions($groups);
ApiResult::setIndexedTagName($data['rights'], 'r');
ApiResult::setArrayType($data['rights'], 'array');
}
}
$fit = $result->addValue(array('query', $this->getModuleName()), null, $data);
if (!$fit) {
$this->setContinueEnumParameter('from', $data['name']);
break;
}
}
$result->addIndexedTagName(array('query', $this->getModuleName()), 'u');
}
