From: Reedy Date: Fri, 25 May 2018 00:46:30 +0000 (+0100) Subject: Rename ApiQueryContributions to ApiQueryUserContribs to match api module name X-Git-Tag: 1.34.0-rc.0~5256^2~2 X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=0be39da9b0acc9616e623279a3ca4d77530ccbc0 Rename ApiQueryContributions to ApiQueryUserContribs to match api module name Change-Id: I865628b87eda7be349522fcfaf94f5563142026e --- diff --git a/.phpcs.xml b/.phpcs.xml index d36d80d35b..e83198b5e4 100644 --- a/.phpcs.xml +++ b/.phpcs.xml @@ -72,7 +72,6 @@ Whitelist existing violations, but enable the sniff to prevent any new occurrences. --> - */includes/api/ApiQueryUserContributions\.php */includes/api/ApiMessage\.php */includes/api/ApiUsageException\.php */includes/media/XCF\.php diff --git a/autoload.php b/autoload.php index 20062636b9..d4533a51ee 100644 --- a/autoload.php +++ b/autoload.php @@ -93,7 +93,7 @@ $wgAutoloadLocalClasses = [ 'ApiQueryCategories' => __DIR__ . '/includes/api/ApiQueryCategories.php', 'ApiQueryCategoryInfo' => __DIR__ . '/includes/api/ApiQueryCategoryInfo.php', 'ApiQueryCategoryMembers' => __DIR__ . '/includes/api/ApiQueryCategoryMembers.php', - 'ApiQueryContributions' => __DIR__ . '/includes/api/ApiQueryUserContributions.php', + 'ApiQueryContributions' => __DIR__ . '/includes/api/ApiQueryUserContribs.php', 'ApiQueryContributors' => __DIR__ . '/includes/api/ApiQueryContributors.php', 'ApiQueryDeletedRevisions' => __DIR__ . '/includes/api/ApiQueryDeletedRevisions.php', 'ApiQueryDeletedrevs' => __DIR__ . '/includes/api/ApiQueryDeletedrevs.php', @@ -129,6 +129,7 @@ $wgAutoloadLocalClasses = [ 'ApiQueryStashImageInfo' => __DIR__ . '/includes/api/ApiQueryStashImageInfo.php', 'ApiQueryTags' => __DIR__ . '/includes/api/ApiQueryTags.php', 'ApiQueryTokens' => __DIR__ . '/includes/api/ApiQueryTokens.php', + 'ApiQueryUserContribs' => __DIR__ . '/includes/api/ApiQueryUserContribs.php', 'ApiQueryUserInfo' => __DIR__ . '/includes/api/ApiQueryUserInfo.php', 'ApiQueryUsers' => __DIR__ . '/includes/api/ApiQueryUsers.php', 'ApiQueryWatchlist' => __DIR__ . '/includes/api/ApiQueryWatchlist.php', diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index e49024d1ed..c68ec2b949 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -98,7 +98,7 @@ class ApiQuery extends ApiBase { 'recentchanges' => ApiQueryRecentChanges::class, 'search' => ApiQuerySearch::class, 'tags' => ApiQueryTags::class, - 'usercontribs' => ApiQueryContributions::class, + 'usercontribs' => ApiQueryUserContribs::class, 'users' => ApiQueryUsers::class, 'watchlist' => ApiQueryWatchlist::class, 'watchlistraw' => ApiQueryWatchlistRaw::class, diff --git a/includes/api/ApiQueryUserContribs.php b/includes/api/ApiQueryUserContribs.php new file mode 100644 index 0000000000..4c6672b7aa --- /dev/null +++ b/includes/api/ApiQueryUserContribs.php @@ -0,0 +1,835 @@ +@gmail.com" + * + * 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 + */ + +/** + * This query action adds a list of a specified user's contributions to the output. + * + * @ingroup API + */ +class ApiQueryUserContribs extends ApiQueryBase { + + public function __construct( ApiQuery $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'uc' ); + } + + private $params, $multiUserMode, $orderBy, $parentLens, $commentStore; + + private $fld_ids = false, $fld_title = false, $fld_timestamp = false, + $fld_comment = false, $fld_parsedcomment = false, $fld_flags = false, + $fld_patrolled = false, $fld_tags = false, $fld_size = false, $fld_sizediff = false; + + public function execute() { + global $wgActorTableSchemaMigrationStage; + + // Parse some parameters + $this->params = $this->extractRequestParams(); + + $this->commentStore = CommentStore::getStore(); + + $prop = array_flip( $this->params['prop'] ); + $this->fld_ids = isset( $prop['ids'] ); + $this->fld_title = isset( $prop['title'] ); + $this->fld_comment = isset( $prop['comment'] ); + $this->fld_parsedcomment = isset( $prop['parsedcomment'] ); + $this->fld_size = isset( $prop['size'] ); + $this->fld_sizediff = isset( $prop['sizediff'] ); + $this->fld_flags = isset( $prop['flags'] ); + $this->fld_timestamp = isset( $prop['timestamp'] ); + $this->fld_patrolled = isset( $prop['patrolled'] ); + $this->fld_tags = isset( $prop['tags'] ); + + // Most of this code will use the 'contributions' group DB, which can map to replica DBs + // with extra user based indexes or partioning by user. The additional metadata + // queries should use a regular replica DB since the lookup pattern is not all by user. + $dbSecondary = $this->getDB(); // any random replica DB + + // TODO: if the query is going only against the revision table, should this be done? + $this->selectNamedDB( 'contributions', DB_REPLICA, 'contributions' ); + + $sort = ( $this->params['dir'] == 'newer' ? '' : ' DESC' ); + $op = ( $this->params['dir'] == 'older' ? '<' : '>' ); + + // Create an Iterator that produces the UserIdentity objects we need, depending + // on which of the 'userprefix', 'userids', or 'user' params was + // specified. + $this->requireOnlyOneParameter( $this->params, 'userprefix', 'userids', 'user' ); + if ( isset( $this->params['userprefix'] ) ) { + $this->multiUserMode = true; + $this->orderBy = 'name'; + $fname = __METHOD__; + + // Because 'userprefix' might produce a huge number of users (e.g. + // a wiki with users "Test00000001" to "Test99999999"), use a + // generator with batched lookup and continuation. + $userIter = call_user_func( function () use ( $dbSecondary, $sort, $op, $fname ) { + global $wgActorTableSchemaMigrationStage; + + $fromName = false; + if ( !is_null( $this->params['continue'] ) ) { + $continue = explode( '|', $this->params['continue'] ); + $this->dieContinueUsageIf( count( $continue ) != 4 ); + $this->dieContinueUsageIf( $continue[0] !== 'name' ); + $fromName = $continue[1]; + } + $like = $dbSecondary->buildLike( $this->params['userprefix'], $dbSecondary->anyString() ); + + $limit = 501; + + do { + $from = $fromName ? "$op= " . $dbSecondary->addQuotes( $fromName ) : false; + + // For the new schema, pull from the actor table. For the + // old, pull from rev_user. For migration a FULL [OUTER] + // JOIN would be what we want, except MySQL doesn't support + // that so we have to UNION instead. + if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { + $res = $dbSecondary->select( + 'actor', + [ 'actor_id', 'user_id' => 'COALESCE(actor_user,0)', 'user_name' => 'actor_name' ], + array_merge( [ "actor_name$like" ], $from ? [ "actor_name $from" ] : [] ), + $fname, + [ 'ORDER BY' => [ "user_name $sort" ], 'LIMIT' => $limit ] + ); + } elseif ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { + $res = $dbSecondary->select( + 'revision', + [ 'actor_id' => 'NULL', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], + array_merge( [ "rev_user_text$like" ], $from ? [ "rev_user_text $from" ] : [] ), + $fname, + [ 'DISTINCT', 'ORDER BY' => [ "rev_user_text $sort" ], 'LIMIT' => $limit ] + ); + } else { + // There are three queries we have to combine to be sure of getting all results: + // - actor table (any rows that have been migrated will have empty rev_user_text) + // - revision+actor by user id + // - revision+actor by name for anons + $options = $dbSecondary->unionSupportsOrderAndLimit() + ? [ 'ORDER BY' => [ "user_name $sort" ], 'LIMIT' => $limit ] : []; + $subsql = []; + $subsql[] = $dbSecondary->selectSQLText( + 'actor', + [ 'actor_id', 'user_id' => 'COALESCE(actor_user,0)', 'user_name' => 'actor_name' ], + array_merge( [ "actor_name$like" ], $from ? [ "actor_name $from" ] : [] ), + $fname, + $options + ); + $subsql[] = $dbSecondary->selectSQLText( + [ 'revision', 'actor' ], + [ 'actor_id', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], + array_merge( + [ "rev_user_text$like", 'rev_user != 0' ], + $from ? [ "rev_user_text $from" ] : [] + ), + $fname, + array_merge( [ 'DISTINCT' ], $options ), + [ 'actor' => [ 'LEFT JOIN', 'rev_user = actor_user' ] ] + ); + $subsql[] = $dbSecondary->selectSQLText( + [ 'revision', 'actor' ], + [ 'actor_id', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], + array_merge( + [ "rev_user_text$like", 'rev_user = 0' ], + $from ? [ "rev_user_text $from" ] : [] + ), + $fname, + array_merge( [ 'DISTINCT' ], $options ), + [ 'actor' => [ 'LEFT JOIN', 'rev_user_text = actor_name' ] ] + ); + $sql = $dbSecondary->unionQueries( $subsql, false ) . " ORDER BY user_name $sort"; + $sql = $dbSecondary->limitResult( $sql, $limit ); + $res = $dbSecondary->query( $sql, $fname ); + } + + $count = 0; + $fromName = false; + foreach ( $res as $row ) { + if ( ++$count >= $limit ) { + $fromName = $row->user_name; + break; + } + yield User::newFromRow( $row ); + } + } while ( $fromName !== false ); + } ); + // Do the actual sorting client-side, because otherwise + // prepareQuery might try to sort by actor and confuse everything. + $batchSize = 1; + } elseif ( isset( $this->params['userids'] ) ) { + if ( !count( $this->params['userids'] ) ) { + $encParamName = $this->encodeParamName( 'userids' ); + $this->dieWithError( [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" ); + } + + $ids = []; + foreach ( $this->params['userids'] as $uid ) { + if ( $uid <= 0 ) { + $this->dieWithError( [ 'apierror-invaliduserid', $uid ], 'invaliduserid' ); + } + $ids[] = $uid; + } + + $this->orderBy = 'id'; + $this->multiUserMode = count( $ids ) > 1; + + $from = $fromId = false; + if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) { + $continue = explode( '|', $this->params['continue'] ); + $this->dieContinueUsageIf( count( $continue ) != 4 ); + $this->dieContinueUsageIf( $continue[0] !== 'id' && $continue[0] !== 'actor' ); + $fromId = (int)$continue[1]; + $this->dieContinueUsageIf( $continue[1] !== (string)$fromId ); + $from = "$op= $fromId"; + } + + // For the new schema, just select from the actor table. For the + // old and transitional schemas, select from user and left join + // actor if it exists. + if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { + $res = $dbSecondary->select( + 'actor', + [ 'actor_id', 'user_id' => 'actor_user', 'user_name' => 'actor_name' ], + array_merge( [ 'actor_user' => $ids ], $from ? [ "actor_id $from" ] : [] ), + __METHOD__, + [ 'ORDER BY' => "user_id $sort" ] + ); + } elseif ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { + $res = $dbSecondary->select( + 'user', + [ 'actor_id' => 'NULL', 'user_id' => 'user_id', 'user_name' => 'user_name' ], + array_merge( [ 'user_id' => $ids ], $from ? [ "user_id $from" ] : [] ), + __METHOD__, + [ 'ORDER BY' => "user_id $sort" ] + ); + } else { + $res = $dbSecondary->select( + [ 'user', 'actor' ], + [ 'actor_id', 'user_id', 'user_name' ], + array_merge( [ 'user_id' => $ids ], $from ? [ "user_id $from" ] : [] ), + __METHOD__, + [ 'ORDER BY' => "user_id $sort" ], + [ 'actor' => [ 'LEFT JOIN', 'actor_user = user_id' ] ] + ); + } + $userIter = UserArray::newFromResult( $res ); + $batchSize = count( $ids ); + } else { + $names = []; + if ( !count( $this->params['user'] ) ) { + $encParamName = $this->encodeParamName( 'user' ); + $this->dieWithError( + [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" + ); + } + foreach ( $this->params['user'] as $u ) { + if ( $u === '' ) { + $encParamName = $this->encodeParamName( 'user' ); + $this->dieWithError( + [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" + ); + } + + if ( User::isIP( $u ) || ExternalUserNames::isExternal( $u ) ) { + $names[$u] = null; + } else { + $name = User::getCanonicalName( $u, 'valid' ); + if ( $name === false ) { + $encParamName = $this->encodeParamName( 'user' ); + $this->dieWithError( + [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $u ) ], "baduser_$encParamName" + ); + } + $names[$name] = null; + } + } + + $this->orderBy = 'name'; + $this->multiUserMode = count( $names ) > 1; + + $from = $fromName = false; + if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) { + $continue = explode( '|', $this->params['continue'] ); + $this->dieContinueUsageIf( count( $continue ) != 4 ); + $this->dieContinueUsageIf( $continue[0] !== 'name' && $continue[0] !== 'actor' ); + $fromName = $continue[1]; + $from = "$op= " . $dbSecondary->addQuotes( $fromName ); + } + + // For the new schema, just select from the actor table. For the + // old and transitional schemas, select from user and left join + // actor if it exists then merge in any unknown users (IPs and imports). + if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { + $res = $dbSecondary->select( + 'actor', + [ 'actor_id', 'user_id' => 'actor_user', 'user_name' => 'actor_name' ], + array_merge( [ 'actor_name' => array_keys( $names ) ], $from ? [ "actor_id $from" ] : [] ), + __METHOD__, + [ 'ORDER BY' => "actor_name $sort" ] + ); + $userIter = UserArray::newFromResult( $res ); + } else { + if ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { + $res = $dbSecondary->select( + 'user', + [ 'actor_id' => 'NULL', 'user_id', 'user_name' ], + array_merge( [ 'user_name' => array_keys( $names ) ], $from ? [ "user_name $from" ] : [] ), + __METHOD__ + ); + } else { + $res = $dbSecondary->select( + [ 'user', 'actor' ], + [ 'actor_id', 'user_id', 'user_name' ], + array_merge( [ 'user_name' => array_keys( $names ) ], $from ? [ "user_name $from" ] : [] ), + __METHOD__, + [], + [ 'actor' => [ 'LEFT JOIN', 'actor_user = user_id' ] ] + ); + } + foreach ( $res as $row ) { + $names[$row->user_name] = $row; + } + call_user_func_array( + $this->params['dir'] == 'newer' ? 'ksort' : 'krsort', [ &$names, SORT_STRING ] + ); + $neg = $op === '>' ? -1 : 1; + $userIter = call_user_func( function () use ( $names, $fromName, $neg ) { + foreach ( $names as $name => $row ) { + if ( $fromName === false || $neg * strcmp( $name, $fromName ) <= 0 ) { + $user = $row ? User::newFromRow( $row ) : User::newFromName( $name, false ); + yield $user; + } + } + } ); + } + $batchSize = count( $names ); + } + + // During migration, force ordering on the client side because we're + // having to combine multiple queries that would otherwise have + // different sort orders. + if ( $wgActorTableSchemaMigrationStage === MIGRATION_WRITE_BOTH || + $wgActorTableSchemaMigrationStage === MIGRATION_WRITE_NEW + ) { + $batchSize = 1; + } + + // With the new schema, the DB query will order by actor so update $this->orderBy to match. + if ( $batchSize > 1 && $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { + $this->orderBy = 'actor'; + } + + $count = 0; + $limit = $this->params['limit']; + $userIter->rewind(); + while ( $userIter->valid() ) { + $users = []; + while ( count( $users ) < $batchSize && $userIter->valid() ) { + $users[] = $userIter->current(); + $userIter->next(); + } + + // Ugh. We have to run the query three times, once for each + // possible 'orcond' from ActorMigration, and then merge them all + // together in the proper order. And preserving the correct + // $hookData for each one. + // @todo When ActorMigration is removed, this can go back to a + // single prepare and select. + $merged = []; + foreach ( [ 'actor', 'userid', 'username' ] as $which ) { + if ( $this->prepareQuery( $users, $limit - $count, $which ) ) { + $hookData = []; + $res = $this->select( __METHOD__, [], $hookData ); + foreach ( $res as $row ) { + $merged[] = [ $row, &$hookData ]; + } + } + } + $neg = $this->params['dir'] == 'newer' ? 1 : -1; + usort( $merged, function ( $a, $b ) use ( $neg, $batchSize ) { + if ( $batchSize === 1 ) { // One user, can't be different + $ret = 0; + } elseif ( $this->orderBy === 'id' ) { + $ret = $a[0]->rev_user - $b[0]->rev_user; + } elseif ( $this->orderBy === 'name' ) { + $ret = strcmp( $a[0]->rev_user_text, $b[0]->rev_user_text ); + } else { + $ret = $a[0]->rev_actor - $b[0]->rev_actor; + } + + if ( !$ret ) { + $ret = strcmp( + wfTimestamp( TS_MW, $a[0]->rev_timestamp ), + wfTimestamp( TS_MW, $b[0]->rev_timestamp ) + ); + } + + if ( !$ret ) { + $ret = $a[0]->rev_id - $b[0]->rev_id; + } + + return $neg * $ret; + } ); + $merged = array_slice( $merged, 0, $limit - $count + 1 ); + // (end "Ugh") + + if ( $this->fld_sizediff ) { + $revIds = []; + foreach ( $merged as $data ) { + if ( $data[0]->rev_parent_id ) { + $revIds[] = $data[0]->rev_parent_id; + } + } + $this->parentLens = Revision::getParentLengths( $dbSecondary, $revIds ); + } + + foreach ( $merged as $data ) { + $row = $data[0]; + $hookData = &$data[1]; + if ( ++$count > $limit ) { + // We've reached the one extra which shows that there are + // additional pages to be had. Stop here... + $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); + break 2; + } + + $vals = $this->extractRowInfo( $row ); + $fit = $this->processRow( $row, $vals, $hookData ) && + $this->getResult()->addValue( [ 'query', $this->getModuleName() ], null, $vals ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); + break 2; + } + } + } + + $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], 'item' ); + } + + /** + * Prepares the query and returns the limit of rows requested + * @param User[] $users + * @param int $limit + * @param string $which 'actor', 'userid', or 'username' + * @return bool + */ + private function prepareQuery( array $users, $limit, $which ) { + global $wgActorTableSchemaMigrationStage; + + $this->resetQueryParams(); + $db = $this->getDB(); + + $revQuery = Revision::getQueryInfo( [ 'page' ] ); + $this->addTables( $revQuery['tables'] ); + $this->addJoinConds( $revQuery['joins'] ); + $this->addFields( $revQuery['fields'] ); + + $revWhere = ActorMigration::newMigration()->getWhere( $db, 'rev_user', $users ); + if ( !isset( $revWhere['orconds'][$which] ) ) { + return false; + } + $this->addWhere( $revWhere['orconds'][$which] ); + + if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { + $orderUserField = 'rev_actor'; + $userField = $this->orderBy === 'actor' ? 'revactor_actor' : 'actor_name'; + } else { + $orderUserField = $this->orderBy === 'id' ? 'rev_user' : 'rev_user_text'; + $userField = $revQuery['fields'][$orderUserField]; + } + if ( $which === 'actor' ) { + $tsField = 'revactor_timestamp'; + $idField = 'revactor_rev'; + } else { + $tsField = 'rev_timestamp'; + $idField = 'rev_id'; + } + + // Handle continue parameter + if ( !is_null( $this->params['continue'] ) ) { + $continue = explode( '|', $this->params['continue'] ); + if ( $this->multiUserMode ) { + $this->dieContinueUsageIf( count( $continue ) != 4 ); + $modeFlag = array_shift( $continue ); + $this->dieContinueUsageIf( $modeFlag !== $this->orderBy ); + $encUser = $db->addQuotes( array_shift( $continue ) ); + } else { + $this->dieContinueUsageIf( count( $continue ) != 2 ); + } + $encTS = $db->addQuotes( $db->timestamp( $continue[0] ) ); + $encId = (int)$continue[1]; + $this->dieContinueUsageIf( $encId != $continue[1] ); + $op = ( $this->params['dir'] == 'older' ? '<' : '>' ); + if ( $this->multiUserMode ) { + $this->addWhere( + "$userField $op $encUser OR " . + "($userField = $encUser AND " . + "($tsField $op $encTS OR " . + "($tsField = $encTS AND " . + "$idField $op= $encId)))" + ); + } else { + $this->addWhere( + "$tsField $op $encTS OR " . + "($tsField = $encTS AND " . + "$idField $op= $encId)" + ); + } + } + + // Don't include any revisions where we're not supposed to be able to + // see the username. + $user = $this->getUser(); + if ( !$user->isAllowed( 'deletedhistory' ) ) { + $bitmask = Revision::DELETED_USER; + } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) { + $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED; + } else { + $bitmask = 0; + } + if ( $bitmask ) { + $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" ); + } + + // Add the user field to ORDER BY if there are multiple users + if ( count( $users ) > 1 ) { + $this->addWhereRange( $orderUserField, $this->params['dir'], null, null ); + } + + // Then timestamp + $this->addTimestampWhereRange( $tsField, + $this->params['dir'], $this->params['start'], $this->params['end'] ); + + // Then rev_id for a total ordering + $this->addWhereRange( $idField, $this->params['dir'], null, null ); + + $this->addWhereFld( 'page_namespace', $this->params['namespace'] ); + + $show = $this->params['show']; + if ( $this->params['toponly'] ) { // deprecated/old param + $show[] = 'top'; + } + if ( !is_null( $show ) ) { + $show = array_flip( $show ); + + if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) ) + || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) ) + || ( isset( $show['autopatrolled'] ) && isset( $show['!autopatrolled'] ) ) + || ( isset( $show['autopatrolled'] ) && isset( $show['!patrolled'] ) ) + || ( isset( $show['top'] ) && isset( $show['!top'] ) ) + || ( isset( $show['new'] ) && isset( $show['!new'] ) ) + ) { + $this->dieWithError( 'apierror-show' ); + } + + $this->addWhereIf( 'rev_minor_edit = 0', isset( $show['!minor'] ) ); + $this->addWhereIf( 'rev_minor_edit != 0', isset( $show['minor'] ) ); + $this->addWhereIf( + 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED, + isset( $show['!patrolled'] ) + ); + $this->addWhereIf( + 'rc_patrolled != ' . RecentChange::PRC_UNPATROLLED, + isset( $show['patrolled'] ) + ); + $this->addWhereIf( + 'rc_patrolled != ' . RecentChange::PRC_AUTOPATROLLED, + isset( $show['!autopatrolled'] ) + ); + $this->addWhereIf( + 'rc_patrolled = ' . RecentChange::PRC_AUTOPATROLLED, + isset( $show['autopatrolled'] ) + ); + $this->addWhereIf( $idField . ' != page_latest', isset( $show['!top'] ) ); + $this->addWhereIf( $idField . ' = page_latest', isset( $show['top'] ) ); + $this->addWhereIf( 'rev_parent_id != 0', isset( $show['!new'] ) ); + $this->addWhereIf( 'rev_parent_id = 0', isset( $show['new'] ) ); + } + $this->addOption( 'LIMIT', $limit + 1 ); + + if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) || + isset( $show['autopatrolled'] ) || isset( $show['!autopatrolled'] ) || $this->fld_patrolled + ) { + if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) { + $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' ); + } + + $isFilterset = isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) || + isset( $show['autopatrolled'] ) || isset( $show['!autopatrolled'] ); + $this->addTables( 'recentchanges' ); + $this->addJoinConds( [ 'recentchanges' => [ + $isFilterset ? 'JOIN' : 'LEFT JOIN', + [ + // This is a crazy hack. recentchanges has no index on rc_this_oldid, so instead of adding + // one T19237 did a join using rc_user_text and rc_timestamp instead. Now rc_user_text is + // probably unavailable, so just do rc_timestamp. + 'rc_timestamp = ' . $tsField, + 'rc_this_oldid = ' . $idField, + ] + ] ] ); + } + + $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled ); + + if ( $this->fld_tags ) { + $this->addTables( 'tag_summary' ); + $this->addJoinConds( + [ 'tag_summary' => [ 'LEFT JOIN', [ $idField . ' = ts_rev_id' ] ] ] + ); + $this->addFields( 'ts_tags' ); + } + + if ( isset( $this->params['tag'] ) ) { + $this->addTables( 'change_tag' ); + $this->addJoinConds( + [ 'change_tag' => [ 'INNER JOIN', [ $idField . ' = ct_rev_id' ] ] ] + ); + $this->addWhereFld( 'ct_tag', $this->params['tag'] ); + } + + return true; + } + + /** + * Extract fields from the database row and append them to a result array + * + * @param stdClass $row + * @return array + */ + private function extractRowInfo( $row ) { + $vals = []; + $anyHidden = false; + + if ( $row->rev_deleted & Revision::DELETED_TEXT ) { + $vals['texthidden'] = true; + $anyHidden = true; + } + + // Any rows where we can't view the user were filtered out in the query. + $vals['userid'] = (int)$row->rev_user; + $vals['user'] = $row->rev_user_text; + if ( $row->rev_deleted & Revision::DELETED_USER ) { + $vals['userhidden'] = true; + $anyHidden = true; + } + if ( $this->fld_ids ) { + $vals['pageid'] = intval( $row->rev_page ); + $vals['revid'] = intval( $row->rev_id ); + // $vals['textid'] = intval( $row->rev_text_id ); // todo: Should this field be exposed? + + if ( !is_null( $row->rev_parent_id ) ) { + $vals['parentid'] = intval( $row->rev_parent_id ); + } + } + + $title = Title::makeTitle( $row->page_namespace, $row->page_title ); + + if ( $this->fld_title ) { + ApiQueryBase::addTitleInfo( $vals, $title ); + } + + if ( $this->fld_timestamp ) { + $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rev_timestamp ); + } + + if ( $this->fld_flags ) { + $vals['new'] = $row->rev_parent_id == 0 && !is_null( $row->rev_parent_id ); + $vals['minor'] = (bool)$row->rev_minor_edit; + $vals['top'] = $row->page_latest == $row->rev_id; + } + + if ( $this->fld_comment || $this->fld_parsedcomment ) { + if ( $row->rev_deleted & Revision::DELETED_COMMENT ) { + $vals['commenthidden'] = true; + $anyHidden = true; + } + + $userCanView = Revision::userCanBitfield( + $row->rev_deleted, + Revision::DELETED_COMMENT, $this->getUser() + ); + + if ( $userCanView ) { + $comment = $this->commentStore->getComment( 'rev_comment', $row )->text; + if ( $this->fld_comment ) { + $vals['comment'] = $comment; + } + + if ( $this->fld_parsedcomment ) { + $vals['parsedcomment'] = Linker::formatComment( $comment, $title ); + } + } + } + + if ( $this->fld_patrolled ) { + $vals['patrolled'] = $row->rc_patrolled != RecentChange::PRC_UNPATROLLED; + $vals['autopatrolled'] = $row->rc_patrolled == RecentChange::PRC_AUTOPATROLLED; + } + + if ( $this->fld_size && !is_null( $row->rev_len ) ) { + $vals['size'] = intval( $row->rev_len ); + } + + if ( $this->fld_sizediff + && !is_null( $row->rev_len ) + && !is_null( $row->rev_parent_id ) + ) { + $parentLen = isset( $this->parentLens[$row->rev_parent_id] ) + ? $this->parentLens[$row->rev_parent_id] + : 0; + $vals['sizediff'] = intval( $row->rev_len - $parentLen ); + } + + if ( $this->fld_tags ) { + if ( $row->ts_tags ) { + $tags = explode( ',', $row->ts_tags ); + ApiResult::setIndexedTagName( $tags, 'tag' ); + $vals['tags'] = $tags; + } else { + $vals['tags'] = []; + } + } + + if ( $anyHidden && $row->rev_deleted & Revision::DELETED_RESTRICTED ) { + $vals['suppressed'] = true; + } + + return $vals; + } + + private function continueStr( $row ) { + if ( $this->multiUserMode ) { + switch ( $this->orderBy ) { + case 'id': + return "id|$row->rev_user|$row->rev_timestamp|$row->rev_id"; + case 'name': + return "name|$row->rev_user_text|$row->rev_timestamp|$row->rev_id"; + case 'actor': + return "actor|$row->rev_actor|$row->rev_timestamp|$row->rev_id"; + } + } else { + return "$row->rev_timestamp|$row->rev_id"; + } + } + + public function getCacheMode( $params ) { + // This module provides access to deleted revisions and patrol flags if + // the requester is logged in + return 'anon-public-user-private'; + } + + public function getAllowedParams() { + return [ + 'limit' => [ + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 + ], + 'start' => [ + ApiBase::PARAM_TYPE => 'timestamp' + ], + 'end' => [ + ApiBase::PARAM_TYPE => 'timestamp' + ], + 'continue' => [ + ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', + ], + 'user' => [ + ApiBase::PARAM_TYPE => 'user', + ApiBase::PARAM_ISMULTI => true + ], + 'userids' => [ + ApiBase::PARAM_TYPE => 'integer', + ApiBase::PARAM_ISMULTI => true + ], + 'userprefix' => null, + 'dir' => [ + ApiBase::PARAM_DFLT => 'older', + ApiBase::PARAM_TYPE => [ + 'newer', + 'older' + ], + ApiBase::PARAM_HELP_MSG => 'api-help-param-direction', + ], + 'namespace' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' + ], + 'prop' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_DFLT => 'ids|title|timestamp|comment|size|flags', + ApiBase::PARAM_TYPE => [ + 'ids', + 'title', + 'timestamp', + 'comment', + 'parsedcomment', + 'size', + 'sizediff', + 'flags', + 'patrolled', + 'tags' + ], + ApiBase::PARAM_HELP_MSG_PER_VALUE => [], + ], + 'show' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => [ + 'minor', + '!minor', + 'patrolled', + '!patrolled', + 'autopatrolled', + '!autopatrolled', + 'top', + '!top', + 'new', + '!new', + ], + ApiBase::PARAM_HELP_MSG => [ + 'apihelp-query+usercontribs-param-show', + $this->getConfig()->get( 'RCMaxAge' ) + ], + ], + 'tag' => null, + 'toponly' => [ + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_DEPRECATED => true, + ], + ]; + } + + protected function getExamplesMessages() { + return [ + 'action=query&list=usercontribs&ucuser=Example' + => 'apihelp-query+usercontribs-example-user', + 'action=query&list=usercontribs&ucuserprefix=192.0.2.' + => 'apihelp-query+usercontribs-example-ipprefix', + ]; + } + + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Usercontribs'; + } +} + +class_alias( ApiQueryUserContribs::class, 'ApiQueryContributions' ); diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php deleted file mode 100644 index 12f42edc48..0000000000 --- a/includes/api/ApiQueryUserContributions.php +++ /dev/null @@ -1,832 +0,0 @@ -@gmail.com" - * - * 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 - */ - -/** - * This query action adds a list of a specified user's contributions to the output. - * - * @ingroup API - */ -class ApiQueryContributions extends ApiQueryBase { - - public function __construct( ApiQuery $query, $moduleName ) { - parent::__construct( $query, $moduleName, 'uc' ); - } - - private $params, $multiUserMode, $orderBy, $parentLens; - private $fld_ids = false, $fld_title = false, $fld_timestamp = false, - $fld_comment = false, $fld_parsedcomment = false, $fld_flags = false, - $fld_patrolled = false, $fld_tags = false, $fld_size = false, $fld_sizediff = false; - - public function execute() { - global $wgActorTableSchemaMigrationStage; - - // Parse some parameters - $this->params = $this->extractRequestParams(); - - $this->commentStore = CommentStore::getStore(); - - $prop = array_flip( $this->params['prop'] ); - $this->fld_ids = isset( $prop['ids'] ); - $this->fld_title = isset( $prop['title'] ); - $this->fld_comment = isset( $prop['comment'] ); - $this->fld_parsedcomment = isset( $prop['parsedcomment'] ); - $this->fld_size = isset( $prop['size'] ); - $this->fld_sizediff = isset( $prop['sizediff'] ); - $this->fld_flags = isset( $prop['flags'] ); - $this->fld_timestamp = isset( $prop['timestamp'] ); - $this->fld_patrolled = isset( $prop['patrolled'] ); - $this->fld_tags = isset( $prop['tags'] ); - - // Most of this code will use the 'contributions' group DB, which can map to replica DBs - // with extra user based indexes or partioning by user. The additional metadata - // queries should use a regular replica DB since the lookup pattern is not all by user. - $dbSecondary = $this->getDB(); // any random replica DB - - // TODO: if the query is going only against the revision table, should this be done? - $this->selectNamedDB( 'contributions', DB_REPLICA, 'contributions' ); - - $sort = ( $this->params['dir'] == 'newer' ? '' : ' DESC' ); - $op = ( $this->params['dir'] == 'older' ? '<' : '>' ); - - // Create an Iterator that produces the UserIdentity objects we need, depending - // on which of the 'userprefix', 'userids', or 'user' params was - // specified. - $this->requireOnlyOneParameter( $this->params, 'userprefix', 'userids', 'user' ); - if ( isset( $this->params['userprefix'] ) ) { - $this->multiUserMode = true; - $this->orderBy = 'name'; - $fname = __METHOD__; - - // Because 'userprefix' might produce a huge number of users (e.g. - // a wiki with users "Test00000001" to "Test99999999"), use a - // generator with batched lookup and continuation. - $userIter = call_user_func( function () use ( $dbSecondary, $sort, $op, $fname ) { - global $wgActorTableSchemaMigrationStage; - - $fromName = false; - if ( !is_null( $this->params['continue'] ) ) { - $continue = explode( '|', $this->params['continue'] ); - $this->dieContinueUsageIf( count( $continue ) != 4 ); - $this->dieContinueUsageIf( $continue[0] !== 'name' ); - $fromName = $continue[1]; - } - $like = $dbSecondary->buildLike( $this->params['userprefix'], $dbSecondary->anyString() ); - - $limit = 501; - - do { - $from = $fromName ? "$op= " . $dbSecondary->addQuotes( $fromName ) : false; - - // For the new schema, pull from the actor table. For the - // old, pull from rev_user. For migration a FULL [OUTER] - // JOIN would be what we want, except MySQL doesn't support - // that so we have to UNION instead. - if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { - $res = $dbSecondary->select( - 'actor', - [ 'actor_id', 'user_id' => 'COALESCE(actor_user,0)', 'user_name' => 'actor_name' ], - array_merge( [ "actor_name$like" ], $from ? [ "actor_name $from" ] : [] ), - $fname, - [ 'ORDER BY' => [ "user_name $sort" ], 'LIMIT' => $limit ] - ); - } elseif ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { - $res = $dbSecondary->select( - 'revision', - [ 'actor_id' => 'NULL', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], - array_merge( [ "rev_user_text$like" ], $from ? [ "rev_user_text $from" ] : [] ), - $fname, - [ 'DISTINCT', 'ORDER BY' => [ "rev_user_text $sort" ], 'LIMIT' => $limit ] - ); - } else { - // There are three queries we have to combine to be sure of getting all results: - // - actor table (any rows that have been migrated will have empty rev_user_text) - // - revision+actor by user id - // - revision+actor by name for anons - $options = $dbSecondary->unionSupportsOrderAndLimit() - ? [ 'ORDER BY' => [ "user_name $sort" ], 'LIMIT' => $limit ] : []; - $subsql = []; - $subsql[] = $dbSecondary->selectSQLText( - 'actor', - [ 'actor_id', 'user_id' => 'COALESCE(actor_user,0)', 'user_name' => 'actor_name' ], - array_merge( [ "actor_name$like" ], $from ? [ "actor_name $from" ] : [] ), - $fname, - $options - ); - $subsql[] = $dbSecondary->selectSQLText( - [ 'revision', 'actor' ], - [ 'actor_id', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], - array_merge( - [ "rev_user_text$like", 'rev_user != 0' ], - $from ? [ "rev_user_text $from" ] : [] - ), - $fname, - array_merge( [ 'DISTINCT' ], $options ), - [ 'actor' => [ 'LEFT JOIN', 'rev_user = actor_user' ] ] - ); - $subsql[] = $dbSecondary->selectSQLText( - [ 'revision', 'actor' ], - [ 'actor_id', 'user_id' => 'rev_user', 'user_name' => 'rev_user_text' ], - array_merge( - [ "rev_user_text$like", 'rev_user = 0' ], - $from ? [ "rev_user_text $from" ] : [] - ), - $fname, - array_merge( [ 'DISTINCT' ], $options ), - [ 'actor' => [ 'LEFT JOIN', 'rev_user_text = actor_name' ] ] - ); - $sql = $dbSecondary->unionQueries( $subsql, false ) . " ORDER BY user_name $sort"; - $sql = $dbSecondary->limitResult( $sql, $limit ); - $res = $dbSecondary->query( $sql, $fname ); - } - - $count = 0; - $fromName = false; - foreach ( $res as $row ) { - if ( ++$count >= $limit ) { - $fromName = $row->user_name; - break; - } - yield User::newFromRow( $row ); - } - } while ( $fromName !== false ); - } ); - // Do the actual sorting client-side, because otherwise - // prepareQuery might try to sort by actor and confuse everything. - $batchSize = 1; - } elseif ( isset( $this->params['userids'] ) ) { - if ( !count( $this->params['userids'] ) ) { - $encParamName = $this->encodeParamName( 'userids' ); - $this->dieWithError( [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" ); - } - - $ids = []; - foreach ( $this->params['userids'] as $uid ) { - if ( $uid <= 0 ) { - $this->dieWithError( [ 'apierror-invaliduserid', $uid ], 'invaliduserid' ); - } - $ids[] = $uid; - } - - $this->orderBy = 'id'; - $this->multiUserMode = count( $ids ) > 1; - - $from = $fromId = false; - if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) { - $continue = explode( '|', $this->params['continue'] ); - $this->dieContinueUsageIf( count( $continue ) != 4 ); - $this->dieContinueUsageIf( $continue[0] !== 'id' && $continue[0] !== 'actor' ); - $fromId = (int)$continue[1]; - $this->dieContinueUsageIf( $continue[1] !== (string)$fromId ); - $from = "$op= $fromId"; - } - - // For the new schema, just select from the actor table. For the - // old and transitional schemas, select from user and left join - // actor if it exists. - if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { - $res = $dbSecondary->select( - 'actor', - [ 'actor_id', 'user_id' => 'actor_user', 'user_name' => 'actor_name' ], - array_merge( [ 'actor_user' => $ids ], $from ? [ "actor_id $from" ] : [] ), - __METHOD__, - [ 'ORDER BY' => "user_id $sort" ] - ); - } elseif ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { - $res = $dbSecondary->select( - 'user', - [ 'actor_id' => 'NULL', 'user_id' => 'user_id', 'user_name' => 'user_name' ], - array_merge( [ 'user_id' => $ids ], $from ? [ "user_id $from" ] : [] ), - __METHOD__, - [ 'ORDER BY' => "user_id $sort" ] - ); - } else { - $res = $dbSecondary->select( - [ 'user', 'actor' ], - [ 'actor_id', 'user_id', 'user_name' ], - array_merge( [ 'user_id' => $ids ], $from ? [ "user_id $from" ] : [] ), - __METHOD__, - [ 'ORDER BY' => "user_id $sort" ], - [ 'actor' => [ 'LEFT JOIN', 'actor_user = user_id' ] ] - ); - } - $userIter = UserArray::newFromResult( $res ); - $batchSize = count( $ids ); - } else { - $names = []; - if ( !count( $this->params['user'] ) ) { - $encParamName = $this->encodeParamName( 'user' ); - $this->dieWithError( - [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" - ); - } - foreach ( $this->params['user'] as $u ) { - if ( $u === '' ) { - $encParamName = $this->encodeParamName( 'user' ); - $this->dieWithError( - [ 'apierror-paramempty', $encParamName ], "paramempty_$encParamName" - ); - } - - if ( User::isIP( $u ) || ExternalUserNames::isExternal( $u ) ) { - $names[$u] = null; - } else { - $name = User::getCanonicalName( $u, 'valid' ); - if ( $name === false ) { - $encParamName = $this->encodeParamName( 'user' ); - $this->dieWithError( - [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $u ) ], "baduser_$encParamName" - ); - } - $names[$name] = null; - } - } - - $this->orderBy = 'name'; - $this->multiUserMode = count( $names ) > 1; - - $from = $fromName = false; - if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) { - $continue = explode( '|', $this->params['continue'] ); - $this->dieContinueUsageIf( count( $continue ) != 4 ); - $this->dieContinueUsageIf( $continue[0] !== 'name' && $continue[0] !== 'actor' ); - $fromName = $continue[1]; - $from = "$op= " . $dbSecondary->addQuotes( $fromName ); - } - - // For the new schema, just select from the actor table. For the - // old and transitional schemas, select from user and left join - // actor if it exists then merge in any unknown users (IPs and imports). - if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { - $res = $dbSecondary->select( - 'actor', - [ 'actor_id', 'user_id' => 'actor_user', 'user_name' => 'actor_name' ], - array_merge( [ 'actor_name' => array_keys( $names ) ], $from ? [ "actor_id $from" ] : [] ), - __METHOD__, - [ 'ORDER BY' => "actor_name $sort" ] - ); - $userIter = UserArray::newFromResult( $res ); - } else { - if ( $wgActorTableSchemaMigrationStage === MIGRATION_OLD ) { - $res = $dbSecondary->select( - 'user', - [ 'actor_id' => 'NULL', 'user_id', 'user_name' ], - array_merge( [ 'user_name' => array_keys( $names ) ], $from ? [ "user_name $from" ] : [] ), - __METHOD__ - ); - } else { - $res = $dbSecondary->select( - [ 'user', 'actor' ], - [ 'actor_id', 'user_id', 'user_name' ], - array_merge( [ 'user_name' => array_keys( $names ) ], $from ? [ "user_name $from" ] : [] ), - __METHOD__, - [], - [ 'actor' => [ 'LEFT JOIN', 'actor_user = user_id' ] ] - ); - } - foreach ( $res as $row ) { - $names[$row->user_name] = $row; - } - call_user_func_array( - $this->params['dir'] == 'newer' ? 'ksort' : 'krsort', [ &$names, SORT_STRING ] - ); - $neg = $op === '>' ? -1 : 1; - $userIter = call_user_func( function () use ( $names, $fromName, $neg ) { - foreach ( $names as $name => $row ) { - if ( $fromName === false || $neg * strcmp( $name, $fromName ) <= 0 ) { - $user = $row ? User::newFromRow( $row ) : User::newFromName( $name, false ); - yield $user; - } - } - } ); - } - $batchSize = count( $names ); - } - - // During migration, force ordering on the client side because we're - // having to combine multiple queries that would otherwise have - // different sort orders. - if ( $wgActorTableSchemaMigrationStage === MIGRATION_WRITE_BOTH || - $wgActorTableSchemaMigrationStage === MIGRATION_WRITE_NEW - ) { - $batchSize = 1; - } - - // With the new schema, the DB query will order by actor so update $this->orderBy to match. - if ( $batchSize > 1 && $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { - $this->orderBy = 'actor'; - } - - $count = 0; - $limit = $this->params['limit']; - $userIter->rewind(); - while ( $userIter->valid() ) { - $users = []; - while ( count( $users ) < $batchSize && $userIter->valid() ) { - $users[] = $userIter->current(); - $userIter->next(); - } - - // Ugh. We have to run the query three times, once for each - // possible 'orcond' from ActorMigration, and then merge them all - // together in the proper order. And preserving the correct - // $hookData for each one. - // @todo When ActorMigration is removed, this can go back to a - // single prepare and select. - $merged = []; - foreach ( [ 'actor', 'userid', 'username' ] as $which ) { - if ( $this->prepareQuery( $users, $limit - $count, $which ) ) { - $hookData = []; - $res = $this->select( __METHOD__, [], $hookData ); - foreach ( $res as $row ) { - $merged[] = [ $row, &$hookData ]; - } - } - } - $neg = $this->params['dir'] == 'newer' ? 1 : -1; - usort( $merged, function ( $a, $b ) use ( $neg, $batchSize ) { - if ( $batchSize === 1 ) { // One user, can't be different - $ret = 0; - } elseif ( $this->orderBy === 'id' ) { - $ret = $a[0]->rev_user - $b[0]->rev_user; - } elseif ( $this->orderBy === 'name' ) { - $ret = strcmp( $a[0]->rev_user_text, $b[0]->rev_user_text ); - } else { - $ret = $a[0]->rev_actor - $b[0]->rev_actor; - } - - if ( !$ret ) { - $ret = strcmp( - wfTimestamp( TS_MW, $a[0]->rev_timestamp ), - wfTimestamp( TS_MW, $b[0]->rev_timestamp ) - ); - } - - if ( !$ret ) { - $ret = $a[0]->rev_id - $b[0]->rev_id; - } - - return $neg * $ret; - } ); - $merged = array_slice( $merged, 0, $limit - $count + 1 ); - // (end "Ugh") - - if ( $this->fld_sizediff ) { - $revIds = []; - foreach ( $merged as $data ) { - if ( $data[0]->rev_parent_id ) { - $revIds[] = $data[0]->rev_parent_id; - } - } - $this->parentLens = Revision::getParentLengths( $dbSecondary, $revIds ); - } - - foreach ( $merged as $data ) { - $row = $data[0]; - $hookData = &$data[1]; - if ( ++$count > $limit ) { - // We've reached the one extra which shows that there are - // additional pages to be had. Stop here... - $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); - break 2; - } - - $vals = $this->extractRowInfo( $row ); - $fit = $this->processRow( $row, $vals, $hookData ) && - $this->getResult()->addValue( [ 'query', $this->getModuleName() ], null, $vals ); - if ( !$fit ) { - $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); - break 2; - } - } - } - - $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], 'item' ); - } - - /** - * Prepares the query and returns the limit of rows requested - * @param User[] $users - * @param int $limit - * @param string $which 'actor', 'userid', or 'username' - * @return bool - */ - private function prepareQuery( array $users, $limit, $which ) { - global $wgActorTableSchemaMigrationStage; - - $this->resetQueryParams(); - $db = $this->getDB(); - - $revQuery = Revision::getQueryInfo( [ 'page' ] ); - $this->addTables( $revQuery['tables'] ); - $this->addJoinConds( $revQuery['joins'] ); - $this->addFields( $revQuery['fields'] ); - - $revWhere = ActorMigration::newMigration()->getWhere( $db, 'rev_user', $users ); - if ( !isset( $revWhere['orconds'][$which] ) ) { - return false; - } - $this->addWhere( $revWhere['orconds'][$which] ); - - if ( $wgActorTableSchemaMigrationStage === MIGRATION_NEW ) { - $orderUserField = 'rev_actor'; - $userField = $this->orderBy === 'actor' ? 'revactor_actor' : 'actor_name'; - } else { - $orderUserField = $this->orderBy === 'id' ? 'rev_user' : 'rev_user_text'; - $userField = $revQuery['fields'][$orderUserField]; - } - if ( $which === 'actor' ) { - $tsField = 'revactor_timestamp'; - $idField = 'revactor_rev'; - } else { - $tsField = 'rev_timestamp'; - $idField = 'rev_id'; - } - - // Handle continue parameter - if ( !is_null( $this->params['continue'] ) ) { - $continue = explode( '|', $this->params['continue'] ); - if ( $this->multiUserMode ) { - $this->dieContinueUsageIf( count( $continue ) != 4 ); - $modeFlag = array_shift( $continue ); - $this->dieContinueUsageIf( $modeFlag !== $this->orderBy ); - $encUser = $db->addQuotes( array_shift( $continue ) ); - } else { - $this->dieContinueUsageIf( count( $continue ) != 2 ); - } - $encTS = $db->addQuotes( $db->timestamp( $continue[0] ) ); - $encId = (int)$continue[1]; - $this->dieContinueUsageIf( $encId != $continue[1] ); - $op = ( $this->params['dir'] == 'older' ? '<' : '>' ); - if ( $this->multiUserMode ) { - $this->addWhere( - "$userField $op $encUser OR " . - "($userField = $encUser AND " . - "($tsField $op $encTS OR " . - "($tsField = $encTS AND " . - "$idField $op= $encId)))" - ); - } else { - $this->addWhere( - "$tsField $op $encTS OR " . - "($tsField = $encTS AND " . - "$idField $op= $encId)" - ); - } - } - - // Don't include any revisions where we're not supposed to be able to - // see the username. - $user = $this->getUser(); - if ( !$user->isAllowed( 'deletedhistory' ) ) { - $bitmask = Revision::DELETED_USER; - } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) { - $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED; - } else { - $bitmask = 0; - } - if ( $bitmask ) { - $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" ); - } - - // Add the user field to ORDER BY if there are multiple users - if ( count( $users ) > 1 ) { - $this->addWhereRange( $orderUserField, $this->params['dir'], null, null ); - } - - // Then timestamp - $this->addTimestampWhereRange( $tsField, - $this->params['dir'], $this->params['start'], $this->params['end'] ); - - // Then rev_id for a total ordering - $this->addWhereRange( $idField, $this->params['dir'], null, null ); - - $this->addWhereFld( 'page_namespace', $this->params['namespace'] ); - - $show = $this->params['show']; - if ( $this->params['toponly'] ) { // deprecated/old param - $show[] = 'top'; - } - if ( !is_null( $show ) ) { - $show = array_flip( $show ); - - if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) ) - || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) ) - || ( isset( $show['autopatrolled'] ) && isset( $show['!autopatrolled'] ) ) - || ( isset( $show['autopatrolled'] ) && isset( $show['!patrolled'] ) ) - || ( isset( $show['top'] ) && isset( $show['!top'] ) ) - || ( isset( $show['new'] ) && isset( $show['!new'] ) ) - ) { - $this->dieWithError( 'apierror-show' ); - } - - $this->addWhereIf( 'rev_minor_edit = 0', isset( $show['!minor'] ) ); - $this->addWhereIf( 'rev_minor_edit != 0', isset( $show['minor'] ) ); - $this->addWhereIf( - 'rc_patrolled = ' . RecentChange::PRC_UNPATROLLED, - isset( $show['!patrolled'] ) - ); - $this->addWhereIf( - 'rc_patrolled != ' . RecentChange::PRC_UNPATROLLED, - isset( $show['patrolled'] ) - ); - $this->addWhereIf( - 'rc_patrolled != ' . RecentChange::PRC_AUTOPATROLLED, - isset( $show['!autopatrolled'] ) - ); - $this->addWhereIf( - 'rc_patrolled = ' . RecentChange::PRC_AUTOPATROLLED, - isset( $show['autopatrolled'] ) - ); - $this->addWhereIf( $idField . ' != page_latest', isset( $show['!top'] ) ); - $this->addWhereIf( $idField . ' = page_latest', isset( $show['top'] ) ); - $this->addWhereIf( 'rev_parent_id != 0', isset( $show['!new'] ) ); - $this->addWhereIf( 'rev_parent_id = 0', isset( $show['new'] ) ); - } - $this->addOption( 'LIMIT', $limit + 1 ); - - if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) || - isset( $show['autopatrolled'] ) || isset( $show['!autopatrolled'] ) || $this->fld_patrolled - ) { - if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) { - $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' ); - } - - $isFilterset = isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) || - isset( $show['autopatrolled'] ) || isset( $show['!autopatrolled'] ); - $this->addTables( 'recentchanges' ); - $this->addJoinConds( [ 'recentchanges' => [ - $isFilterset ? 'JOIN' : 'LEFT JOIN', - [ - // This is a crazy hack. recentchanges has no index on rc_this_oldid, so instead of adding - // one T19237 did a join using rc_user_text and rc_timestamp instead. Now rc_user_text is - // probably unavailable, so just do rc_timestamp. - 'rc_timestamp = ' . $tsField, - 'rc_this_oldid = ' . $idField, - ] - ] ] ); - } - - $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled ); - - if ( $this->fld_tags ) { - $this->addTables( 'tag_summary' ); - $this->addJoinConds( - [ 'tag_summary' => [ 'LEFT JOIN', [ $idField . ' = ts_rev_id' ] ] ] - ); - $this->addFields( 'ts_tags' ); - } - - if ( isset( $this->params['tag'] ) ) { - $this->addTables( 'change_tag' ); - $this->addJoinConds( - [ 'change_tag' => [ 'INNER JOIN', [ $idField . ' = ct_rev_id' ] ] ] - ); - $this->addWhereFld( 'ct_tag', $this->params['tag'] ); - } - - return true; - } - - /** - * Extract fields from the database row and append them to a result array - * - * @param stdClass $row - * @return array - */ - private function extractRowInfo( $row ) { - $vals = []; - $anyHidden = false; - - if ( $row->rev_deleted & Revision::DELETED_TEXT ) { - $vals['texthidden'] = true; - $anyHidden = true; - } - - // Any rows where we can't view the user were filtered out in the query. - $vals['userid'] = (int)$row->rev_user; - $vals['user'] = $row->rev_user_text; - if ( $row->rev_deleted & Revision::DELETED_USER ) { - $vals['userhidden'] = true; - $anyHidden = true; - } - if ( $this->fld_ids ) { - $vals['pageid'] = intval( $row->rev_page ); - $vals['revid'] = intval( $row->rev_id ); - // $vals['textid'] = intval( $row->rev_text_id ); // todo: Should this field be exposed? - - if ( !is_null( $row->rev_parent_id ) ) { - $vals['parentid'] = intval( $row->rev_parent_id ); - } - } - - $title = Title::makeTitle( $row->page_namespace, $row->page_title ); - - if ( $this->fld_title ) { - ApiQueryBase::addTitleInfo( $vals, $title ); - } - - if ( $this->fld_timestamp ) { - $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rev_timestamp ); - } - - if ( $this->fld_flags ) { - $vals['new'] = $row->rev_parent_id == 0 && !is_null( $row->rev_parent_id ); - $vals['minor'] = (bool)$row->rev_minor_edit; - $vals['top'] = $row->page_latest == $row->rev_id; - } - - if ( $this->fld_comment || $this->fld_parsedcomment ) { - if ( $row->rev_deleted & Revision::DELETED_COMMENT ) { - $vals['commenthidden'] = true; - $anyHidden = true; - } - - $userCanView = Revision::userCanBitfield( - $row->rev_deleted, - Revision::DELETED_COMMENT, $this->getUser() - ); - - if ( $userCanView ) { - $comment = $this->commentStore->getComment( 'rev_comment', $row )->text; - if ( $this->fld_comment ) { - $vals['comment'] = $comment; - } - - if ( $this->fld_parsedcomment ) { - $vals['parsedcomment'] = Linker::formatComment( $comment, $title ); - } - } - } - - if ( $this->fld_patrolled ) { - $vals['patrolled'] = $row->rc_patrolled != RecentChange::PRC_UNPATROLLED; - $vals['autopatrolled'] = $row->rc_patrolled == RecentChange::PRC_AUTOPATROLLED; - } - - if ( $this->fld_size && !is_null( $row->rev_len ) ) { - $vals['size'] = intval( $row->rev_len ); - } - - if ( $this->fld_sizediff - && !is_null( $row->rev_len ) - && !is_null( $row->rev_parent_id ) - ) { - $parentLen = isset( $this->parentLens[$row->rev_parent_id] ) - ? $this->parentLens[$row->rev_parent_id] - : 0; - $vals['sizediff'] = intval( $row->rev_len - $parentLen ); - } - - if ( $this->fld_tags ) { - if ( $row->ts_tags ) { - $tags = explode( ',', $row->ts_tags ); - ApiResult::setIndexedTagName( $tags, 'tag' ); - $vals['tags'] = $tags; - } else { - $vals['tags'] = []; - } - } - - if ( $anyHidden && $row->rev_deleted & Revision::DELETED_RESTRICTED ) { - $vals['suppressed'] = true; - } - - return $vals; - } - - private function continueStr( $row ) { - if ( $this->multiUserMode ) { - switch ( $this->orderBy ) { - case 'id': - return "id|$row->rev_user|$row->rev_timestamp|$row->rev_id"; - case 'name': - return "name|$row->rev_user_text|$row->rev_timestamp|$row->rev_id"; - case 'actor': - return "actor|$row->rev_actor|$row->rev_timestamp|$row->rev_id"; - } - } else { - return "$row->rev_timestamp|$row->rev_id"; - } - } - - public function getCacheMode( $params ) { - // This module provides access to deleted revisions and patrol flags if - // the requester is logged in - return 'anon-public-user-private'; - } - - public function getAllowedParams() { - return [ - 'limit' => [ - ApiBase::PARAM_DFLT => 10, - ApiBase::PARAM_TYPE => 'limit', - ApiBase::PARAM_MIN => 1, - ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, - ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 - ], - 'start' => [ - ApiBase::PARAM_TYPE => 'timestamp' - ], - 'end' => [ - ApiBase::PARAM_TYPE => 'timestamp' - ], - 'continue' => [ - ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', - ], - 'user' => [ - ApiBase::PARAM_TYPE => 'user', - ApiBase::PARAM_ISMULTI => true - ], - 'userids' => [ - ApiBase::PARAM_TYPE => 'integer', - ApiBase::PARAM_ISMULTI => true - ], - 'userprefix' => null, - 'dir' => [ - ApiBase::PARAM_DFLT => 'older', - ApiBase::PARAM_TYPE => [ - 'newer', - 'older' - ], - ApiBase::PARAM_HELP_MSG => 'api-help-param-direction', - ], - 'namespace' => [ - ApiBase::PARAM_ISMULTI => true, - ApiBase::PARAM_TYPE => 'namespace' - ], - 'prop' => [ - ApiBase::PARAM_ISMULTI => true, - ApiBase::PARAM_DFLT => 'ids|title|timestamp|comment|size|flags', - ApiBase::PARAM_TYPE => [ - 'ids', - 'title', - 'timestamp', - 'comment', - 'parsedcomment', - 'size', - 'sizediff', - 'flags', - 'patrolled', - 'tags' - ], - ApiBase::PARAM_HELP_MSG_PER_VALUE => [], - ], - 'show' => [ - ApiBase::PARAM_ISMULTI => true, - ApiBase::PARAM_TYPE => [ - 'minor', - '!minor', - 'patrolled', - '!patrolled', - 'autopatrolled', - '!autopatrolled', - 'top', - '!top', - 'new', - '!new', - ], - ApiBase::PARAM_HELP_MSG => [ - 'apihelp-query+usercontribs-param-show', - $this->getConfig()->get( 'RCMaxAge' ) - ], - ], - 'tag' => null, - 'toponly' => [ - ApiBase::PARAM_DFLT => false, - ApiBase::PARAM_DEPRECATED => true, - ], - ]; - } - - protected function getExamplesMessages() { - return [ - 'action=query&list=usercontribs&ucuser=Example' - => 'apihelp-query+usercontribs-example-user', - 'action=query&list=usercontribs&ucuserprefix=192.0.2.' - => 'apihelp-query+usercontribs-example-ipprefix', - ]; - } - - public function getHelpUrls() { - return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Usercontribs'; - } -} diff --git a/tests/phpunit/includes/api/query/ApiQueryUserContribsTest.php b/tests/phpunit/includes/api/query/ApiQueryUserContribsTest.php new file mode 100644 index 0000000000..1d0b47173e --- /dev/null +++ b/tests/phpunit/includes/api/query/ApiQueryUserContribsTest.php @@ -0,0 +1,194 @@ +overrideMwServices(); + }, [ $wgActorTableSchemaMigrationStage ] ); + $wgActorTableSchemaMigrationStage = MIGRATION_WRITE_BOTH; + $this->overrideMwServices(); + + $users = [ + User::newFromName( '192.168.2.2', false ), + User::newFromName( '192.168.2.1', false ), + User::newFromName( '192.168.2.3', false ), + User::createNew( __CLASS__ . ' B' ), + User::createNew( __CLASS__ . ' A' ), + User::createNew( __CLASS__ . ' C' ), + User::newFromName( 'IW>' . __CLASS__, false ), + ]; + + $title = Title::newFromText( __CLASS__ ); + $page = WikiPage::factory( $title ); + for ( $i = 0; $i < 3; $i++ ) { + foreach ( array_reverse( $users ) as $user ) { + $status = $page->doEditContent( + ContentHandler::makeContent( "Test revision $user #$i", $title ), 'Test edit', 0, false, $user + ); + if ( !$status->isOK() ) { + $this->fail( "Failed to edit $title: " . $status->getWikiText( false, false, 'en' ) ); + } + } + } + } + + /** + * @dataProvider provideSorting + * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage + * @param array $params Extra parameters for the query + * @param bool $reverse Reverse order? + * @param int $revs Number of revisions to expect + */ + public function testSorting( $stage, $params, $reverse, $revs ) { + if ( isset( $params['ucuserprefix'] ) && + ( $stage === MIGRATION_WRITE_BOTH || $stage === MIGRATION_WRITE_NEW ) && + $this->db->getType() === 'mysql' && $this->usesTemporaryTables() + ) { + // https://bugs.mysql.com/bug.php?id=10327 + $this->markTestSkipped( 'MySQL bug 10327 - can\'t reopen temporary tables' ); + } + + $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); + $this->overrideMwServices(); + + if ( isset( $params['ucuserids'] ) ) { + $params['ucuserids'] = implode( '|', array_map( 'User::idFromName', $params['ucuserids'] ) ); + } + if ( isset( $params['ucuser'] ) ) { + $params['ucuser'] = implode( '|', $params['ucuser'] ); + } + + $sort = 'rsort'; + if ( $reverse ) { + $params['ucdir'] = 'newer'; + $sort = 'sort'; + } + + $params += [ + 'action' => 'query', + 'list' => 'usercontribs', + 'ucprop' => 'ids', + ]; + + $apiResult = $this->doApiRequest( $params + [ 'uclimit' => 500 ] ); + $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); + $this->assertArrayHasKey( 'query', $apiResult[0] ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); + + $count = 0; + $ids = []; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $ids[$page['user']][] = $page['revid']; + } + $this->assertSame( $revs, $count, 'Expected number of revisions' ); + foreach ( $ids as $user => $revids ) { + $sorted = $revids; + call_user_func_array( $sort, [ &$sorted ] ); + $this->assertSame( $sorted, $revids, "IDs for $user are sorted" ); + } + + for ( $limit = 1; $limit < $revs; $limit++ ) { + $continue = []; + $count = 0; + $batchedIds = []; + while ( $continue !== null ) { + $apiResult = $this->doApiRequest( $params + [ 'uclimit' => $limit ] + $continue ); + $this->assertArrayHasKey( 'query', $apiResult[0], "Batching with limit $limit" ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'], + "Batching with limit $limit" ); + $continue = isset( $apiResult[0]['continue'] ) ? $apiResult[0]['continue'] : null; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $batchedIds[$page['user']][] = $page['revid']; + } + $this->assertLessThanOrEqual( $revs, $count, "Batching with limit $limit" ); + } + $this->assertSame( $ids, $batchedIds, "Result set is the same when batching with limit $limit" ); + } + } + + public static function provideSorting() { + $users = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' C' ]; + $users2 = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' D' ]; + $ips = [ '192.168.2.1', '192.168.2.2', '192.168.2.3', '192.168.2.4' ]; + + foreach ( + [ + 'old' => MIGRATION_OLD, + 'write both' => MIGRATION_WRITE_BOTH, + 'write new' => MIGRATION_WRITE_NEW, + 'new' => MIGRATION_NEW, + ] as $stageName => $stage + ) { + foreach ( [ false, true ] as $reverse ) { + $name = $stageName . ( $reverse ? ', reverse' : '' ); + yield "Named users, $name" => [ $stage, [ 'ucuser' => $users ], $reverse, 9 ]; + yield "Named users including a no-edit user, $name" => [ + $stage, [ 'ucuser' => $users2 ], $reverse, 6 + ]; + yield "IP users, $name" => [ $stage, [ 'ucuser' => $ips ], $reverse, 9 ]; + yield "All users, $name" => [ + $stage, [ 'ucuser' => array_merge( $users, $ips ) ], $reverse, 18 + ]; + yield "User IDs, $name" => [ $stage, [ 'ucuserids' => $users ], $reverse, 9 ]; + yield "Users by prefix, $name" => [ $stage, [ 'ucuserprefix' => __CLASS__ ], $reverse, 9 ]; + yield "IPs by prefix, $name" => [ $stage, [ 'ucuserprefix' => '192.168.2.' ], $reverse, 9 ]; + } + } + } + + /** + * @dataProvider provideInterwikiUser + * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage + */ + public function testInterwikiUser( $stage ) { + $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); + $this->overrideMwServices(); + + $params = [ + 'action' => 'query', + 'list' => 'usercontribs', + 'ucuser' => 'IW>' . __CLASS__, + 'ucprop' => 'ids', + 'uclimit' => 'max', + ]; + + $apiResult = $this->doApiRequest( $params ); + $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); + $this->assertArrayHasKey( 'query', $apiResult[0] ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); + + $count = 0; + $ids = []; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $this->assertSame( 'IW>' . __CLASS__, $page['user'], 'Correct user returned' ); + $ids[] = $page['revid']; + } + $this->assertSame( 3, $count, 'Expected number of revisions' ); + $sorted = $ids; + rsort( $sorted ); + $this->assertSame( $sorted, $ids, "IDs are sorted" ); + } + + public static function provideInterwikiUser() { + return [ + 'old' => [ MIGRATION_OLD ], + 'write both' => [ MIGRATION_WRITE_BOTH ], + 'write new' => [ MIGRATION_WRITE_NEW ], + 'new' => [ MIGRATION_NEW ], + ]; + } + +} diff --git a/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php b/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php deleted file mode 100644 index ca6a929ac8..0000000000 --- a/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php +++ /dev/null @@ -1,194 +0,0 @@ -overrideMwServices(); - }, [ $wgActorTableSchemaMigrationStage ] ); - $wgActorTableSchemaMigrationStage = MIGRATION_WRITE_BOTH; - $this->overrideMwServices(); - - $users = [ - User::newFromName( '192.168.2.2', false ), - User::newFromName( '192.168.2.1', false ), - User::newFromName( '192.168.2.3', false ), - User::createNew( __CLASS__ . ' B' ), - User::createNew( __CLASS__ . ' A' ), - User::createNew( __CLASS__ . ' C' ), - User::newFromName( 'IW>' . __CLASS__, false ), - ]; - - $title = Title::newFromText( __CLASS__ ); - $page = WikiPage::factory( $title ); - for ( $i = 0; $i < 3; $i++ ) { - foreach ( array_reverse( $users ) as $user ) { - $status = $page->doEditContent( - ContentHandler::makeContent( "Test revision $user #$i", $title ), 'Test edit', 0, false, $user - ); - if ( !$status->isOK() ) { - $this->fail( "Failed to edit $title: " . $status->getWikiText( false, false, 'en' ) ); - } - } - } - } - - /** - * @dataProvider provideSorting - * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage - * @param array $params Extra parameters for the query - * @param bool $reverse Reverse order? - * @param int $revs Number of revisions to expect - */ - public function testSorting( $stage, $params, $reverse, $revs ) { - if ( isset( $params['ucuserprefix'] ) && - ( $stage === MIGRATION_WRITE_BOTH || $stage === MIGRATION_WRITE_NEW ) && - $this->db->getType() === 'mysql' && $this->usesTemporaryTables() - ) { - // https://bugs.mysql.com/bug.php?id=10327 - $this->markTestSkipped( 'MySQL bug 10327 - can\'t reopen temporary tables' ); - } - - $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); - $this->overrideMwServices(); - - if ( isset( $params['ucuserids'] ) ) { - $params['ucuserids'] = implode( '|', array_map( 'User::idFromName', $params['ucuserids'] ) ); - } - if ( isset( $params['ucuser'] ) ) { - $params['ucuser'] = implode( '|', $params['ucuser'] ); - } - - $sort = 'rsort'; - if ( $reverse ) { - $params['ucdir'] = 'newer'; - $sort = 'sort'; - } - - $params += [ - 'action' => 'query', - 'list' => 'usercontribs', - 'ucprop' => 'ids', - ]; - - $apiResult = $this->doApiRequest( $params + [ 'uclimit' => 500 ] ); - $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); - $this->assertArrayHasKey( 'query', $apiResult[0] ); - $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); - - $count = 0; - $ids = []; - foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { - $count++; - $ids[$page['user']][] = $page['revid']; - } - $this->assertSame( $revs, $count, 'Expected number of revisions' ); - foreach ( $ids as $user => $revids ) { - $sorted = $revids; - call_user_func_array( $sort, [ &$sorted ] ); - $this->assertSame( $sorted, $revids, "IDs for $user are sorted" ); - } - - for ( $limit = 1; $limit < $revs; $limit++ ) { - $continue = []; - $count = 0; - $batchedIds = []; - while ( $continue !== null ) { - $apiResult = $this->doApiRequest( $params + [ 'uclimit' => $limit ] + $continue ); - $this->assertArrayHasKey( 'query', $apiResult[0], "Batching with limit $limit" ); - $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'], - "Batching with limit $limit" ); - $continue = isset( $apiResult[0]['continue'] ) ? $apiResult[0]['continue'] : null; - foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { - $count++; - $batchedIds[$page['user']][] = $page['revid']; - } - $this->assertLessThanOrEqual( $revs, $count, "Batching with limit $limit" ); - } - $this->assertSame( $ids, $batchedIds, "Result set is the same when batching with limit $limit" ); - } - } - - public static function provideSorting() { - $users = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' C' ]; - $users2 = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' D' ]; - $ips = [ '192.168.2.1', '192.168.2.2', '192.168.2.3', '192.168.2.4' ]; - - foreach ( - [ - 'old' => MIGRATION_OLD, - 'write both' => MIGRATION_WRITE_BOTH, - 'write new' => MIGRATION_WRITE_NEW, - 'new' => MIGRATION_NEW, - ] as $stageName => $stage - ) { - foreach ( [ false, true ] as $reverse ) { - $name = $stageName . ( $reverse ? ', reverse' : '' ); - yield "Named users, $name" => [ $stage, [ 'ucuser' => $users ], $reverse, 9 ]; - yield "Named users including a no-edit user, $name" => [ - $stage, [ 'ucuser' => $users2 ], $reverse, 6 - ]; - yield "IP users, $name" => [ $stage, [ 'ucuser' => $ips ], $reverse, 9 ]; - yield "All users, $name" => [ - $stage, [ 'ucuser' => array_merge( $users, $ips ) ], $reverse, 18 - ]; - yield "User IDs, $name" => [ $stage, [ 'ucuserids' => $users ], $reverse, 9 ]; - yield "Users by prefix, $name" => [ $stage, [ 'ucuserprefix' => __CLASS__ ], $reverse, 9 ]; - yield "IPs by prefix, $name" => [ $stage, [ 'ucuserprefix' => '192.168.2.' ], $reverse, 9 ]; - } - } - } - - /** - * @dataProvider provideInterwikiUser - * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage - */ - public function testInterwikiUser( $stage ) { - $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); - $this->overrideMwServices(); - - $params = [ - 'action' => 'query', - 'list' => 'usercontribs', - 'ucuser' => 'IW>' . __CLASS__, - 'ucprop' => 'ids', - 'uclimit' => 'max', - ]; - - $apiResult = $this->doApiRequest( $params ); - $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); - $this->assertArrayHasKey( 'query', $apiResult[0] ); - $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); - - $count = 0; - $ids = []; - foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { - $count++; - $this->assertSame( 'IW>' . __CLASS__, $page['user'], 'Correct user returned' ); - $ids[] = $page['revid']; - } - $this->assertSame( 3, $count, 'Expected number of revisions' ); - $sorted = $ids; - rsort( $sorted ); - $this->assertSame( $sorted, $ids, "IDs are sorted" ); - } - - public static function provideInterwikiUser() { - return [ - 'old' => [ MIGRATION_OLD ], - 'write both' => [ MIGRATION_WRITE_BOTH ], - 'write new' => [ MIGRATION_WRITE_NEW ], - 'new' => [ MIGRATION_NEW ], - ]; - } - -}