X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryUserContributions.php;h=ab5acf5f0ea454cc09e945d473c672fd5627f2c3;hb=8f390bcfac38ec47e8a1068ea016e5c654bf7be9;hp=79ceb86189832aac641ae7a738f584747c0e2e0a;hpb=91f1c4c9036a56eb3af5a7fbce567282501c2dd0;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php index 79ceb86189..ab5acf5f0e 100644 --- a/includes/api/ApiQueryUserContributions.php +++ b/includes/api/ApiQueryUserContributions.php @@ -1,11 +1,10 @@ @gmail.com + * Created on Oct 16, 2006 + * + * Copyright © 2006 Yuri Astrakhan @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 @@ -19,15 +18,12 @@ * * 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., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ -if ( !defined( 'MEDIAWIKI' ) ) { - // Eclipse helper - will be ignored in production - require_once ( 'ApiQueryBase.php' ); -} - /** * This query action adds a list of a specified user's contributions to the output. * @@ -36,13 +32,13 @@ if ( !defined( 'MEDIAWIKI' ) ) { class ApiQueryContributions extends ApiQueryBase { public function __construct( $query, $moduleName ) { - parent :: __construct( $query, $moduleName, 'uc' ); + parent::__construct( $query, $moduleName, 'uc' ); } - private $params, $username; + private $params, $prefixMode, $userprefix, $multiUserMode, $usernames; 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_patrolled = false, $fld_tags = false, $fld_size = false; public function execute() { // Parse some parameters @@ -61,26 +57,26 @@ class ApiQueryContributions extends ApiQueryBase { // TODO: if the query is going only against the revision table, should this be done? $this->selectNamedDB( 'contributions', DB_SLAVE, 'contributions' ); - $db = $this->getDB(); - if ( isset( $this->params['userprefix'] ) ) - { + if ( isset( $this->params['userprefix'] ) ) { $this->prefixMode = true; $this->multiUserMode = true; $this->userprefix = $this->params['userprefix']; - } - else - { + } else { $this->usernames = array(); - if ( !is_array( $this->params['user'] ) ) + if ( !is_array( $this->params['user'] ) ) { $this->params['user'] = array( $this->params['user'] ); - if ( !count( $this->params['user'] ) ) + } + if ( !count( $this->params['user'] ) ) { $this->dieUsage( 'User parameter may not be empty.', 'param_user' ); - foreach ( $this->params['user'] as $u ) + } + foreach ( $this->params['user'] as $u ) { $this->prepareUsername( $u ); + } $this->prefixMode = false; $this->multiUserMode = ( count( $this->params['user'] ) > 1 ); } + $this->prepareQuery(); // Do the actual query. @@ -91,37 +87,37 @@ class ApiQueryContributions extends ApiQueryBase { $limit = $this->params['limit']; // Fetch each row - while ( $row = $db->fetchObject( $res ) ) { + foreach ( $res as $row ) { if ( ++ $count > $limit ) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... - if ( $this->multiUserMode ) + if ( $this->multiUserMode ) { $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); - else + } else { $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rev_timestamp ) ); + } break; } $vals = $this->extractRowInfo( $row ); $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals ); - if ( !$fit ) - { - if ( $this->multiUserMode ) + if ( !$fit ) { + if ( $this->multiUserMode ) { $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) ); - else + } else { $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rev_timestamp ) ); + } break; } } - // Free the database record so the connection can get on with other stuff - $db->freeResult( $res ); - $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' ); } /** * Validate the 'user' parameter and set the value to compare * against `revision`.`rev_user_text` + * + * @param $user string */ private function prepareUsername( $user ) { if ( !is_null( $user ) && $user !== '' ) { @@ -145,38 +141,44 @@ class ApiQueryContributions extends ApiQueryBase { // We're after the revision table, and the corresponding page // row for anything we retrieve. We may also need the // recentchanges row and/or tag summary row. - global $wgUser; + $user = $this->getUser(); $tables = array( 'page', 'revision' ); // Order may change $this->addWhere( 'page_id=rev_page' ); // Handle continue parameter - if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) - { + if ( $this->multiUserMode && !is_null( $this->params['continue'] ) ) { $continue = explode( '|', $this->params['continue'] ); - if ( count( $continue ) != 2 ) - $this->dieUsage( "Invalid continue param. You should pass the original " . - "value returned by the previous query", "_badcontinue" ); - $encUser = $this->getDB()->strencode( $continue[0] ); - $encTS = wfTimestamp( TS_MW, $continue[1] ); + if ( count( $continue ) != 2 ) { + $this->dieUsage( 'Invalid continue param. You should pass the original ' . + 'value returned by the previous query', '_badcontinue' ); + } + $db = $this->getDB(); + $encUser = $db->addQuotes( $continue[0] ); + $encTS = $db->addQuotes( $db->timestamp( $continue[1] ) ); $op = ( $this->params['dir'] == 'older' ? '<' : '>' ); - $this->addWhere( "rev_user_text $op '$encUser' OR " . - "(rev_user_text = '$encUser' AND " . - "rev_timestamp $op= '$encTS')" ); + $this->addWhere( + "rev_user_text $op $encUser OR " . + "(rev_user_text = $encUser AND " . + "rev_timestamp $op= $encTS)" + ); } - if ( !$wgUser->isAllowed( 'hideuser' ) ) + if ( !$user->isAllowed( 'hideuser' ) ) { $this->addWhere( $this->getDB()->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ); + } // We only want pages by the specified users. - if ( $this->prefixMode ) + if ( $this->prefixMode ) { $this->addWhere( 'rev_user_text' . $this->getDB()->buildLike( $this->userprefix, $this->getDB()->anyString() ) ); - else + } else { $this->addWhereFld( 'rev_user_text', $this->usernames ); + } // ... and in the specified timeframe. // Ensure the same sort order for rev_user_text and rev_timestamp // so our query is indexed - if ( $this->multiUserMode ) + if ( $this->multiUserMode ) { $this->addWhereRange( 'rev_user_text', $this->params['dir'], null, null ); - $this->addWhereRange( 'rev_timestamp', + } + $this->addTimestampWhereRange( 'rev_timestamp', $this->params['dir'], $this->params['start'], $this->params['end'] ); $this->addWhereFld( 'page_namespace', $this->params['namespace'] ); @@ -184,8 +186,9 @@ class ApiQueryContributions extends ApiQueryBase { if ( !is_null( $show ) ) { $show = array_flip( $show ); if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) ) - || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) ) ) - $this->dieUsage( "Incorrect parameter - mutually exclusive values may not be supplied", 'show' ); + || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) ) ) { + $this->dieUsageMsg( 'show' ); + } $this->addWhereIf( 'rev_minor_edit = 0', isset( $show['!minor'] ) ); $this->addWhereIf( 'rev_minor_edit != 0', isset( $show['minor'] ) ); @@ -202,22 +205,22 @@ class ApiQueryContributions extends ApiQueryBase { 'rev_timestamp', 'page_namespace', 'page_title', + 'rev_user', 'rev_user_text', 'rev_deleted' ) ); - + if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) || - $this->fld_patrolled ) - { - global $wgUser; - if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) - $this->dieUsage( "You need the patrol right to request the patrolled flag", 'permissiondenied' ); + $this->fld_patrolled ) { + if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) { + $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' ); + } + // Use a redundant join condition on both // timestamp and ID so we can use the timestamp // index $index['recentchanges'] = 'rc_user_text'; - if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) - { + if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) { // Put the tables in the right order for // STRAIGHT_JOIN $tables = array( 'revision', 'recentchanges', 'page' ); @@ -225,9 +228,7 @@ class ApiQueryContributions extends ApiQueryBase { $this->addWhere( 'rc_user_text=rev_user_text' ); $this->addWhere( 'rc_timestamp=rev_timestamp' ); $this->addWhere( 'rc_this_oldid=rev_id' ); - } - else - { + } else { $tables[] = 'recentchanges'; $this->addJoinConds( array( 'recentchanges' => array( 'LEFT JOIN', array( @@ -241,83 +242,96 @@ class ApiQueryContributions extends ApiQueryBase { $this->addFieldsIf( 'rev_page', $this->fld_ids ); $this->addFieldsIf( 'rev_id', $this->fld_ids || $this->fld_flags ); $this->addFieldsIf( 'page_latest', $this->fld_flags ); - // $this->addFieldsIf('rev_text_id', $this->fld_ids); // Should this field be exposed? + // $this->addFieldsIf( 'rev_text_id', $this->fld_ids ); // Should this field be exposed? $this->addFieldsIf( 'rev_comment', $this->fld_comment || $this->fld_parsedcomment ); $this->addFieldsIf( 'rev_len', $this->fld_size ); - $this->addFieldsIf( 'rev_minor_edit', $this->fld_flags ); - $this->addFieldsIf( 'rev_parent_id', $this->fld_flags ); + $this->addFieldsIf( array( 'rev_minor_edit', 'rev_parent_id' ), $this->fld_flags ); $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled ); - - if ( $this->fld_tags ) - { + + if ( $this->fld_tags ) { $this->addTables( 'tag_summary' ); $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rev_id=ts_rev_id' ) ) ) ); $this->addFields( 'ts_tags' ); } - + if ( isset( $this->params['tag'] ) ) { $this->addTables( 'change_tag' ); $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rev_id=ct_rev_id' ) ) ) ); $this->addWhereFld( 'ct_tag', $this->params['tag'] ); global $wgOldChangeTagsIndex; - $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id'; + $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id'; } - + + if ( $this->params['toponly'] ) { + $this->addWhere( 'rev_id = page_latest' ); + } + $this->addOption( 'USE INDEX', $index ); } /** * Extract fields from the database row and append them to a result array + * + * @param $row + * @return array */ private function extractRowInfo( $row ) { - $vals = array(); + $vals['userid'] = $row->rev_user; $vals['user'] = $row->rev_user_text; - if ( $row->rev_deleted & Revision::DELETED_USER ) + if ( $row->rev_deleted & Revision::DELETED_USER ) { $vals['userhidden'] = ''; + } 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? + // $vals['textid'] = intval( $row->rev_text_id ); // todo: Should this field be exposed? } $title = Title::makeTitle( $row->page_namespace, $row->page_title ); - if ( $this->fld_title ) + if ( $this->fld_title ) { ApiQueryBase::addTitleInfo( $vals, $title ); + } - if ( $this->fld_timestamp ) + if ( $this->fld_timestamp ) { $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rev_timestamp ); + } if ( $this->fld_flags ) { - if ( $row->rev_parent_id == 0 && !is_null( $row->rev_parent_id ) ) + if ( $row->rev_parent_id == 0 && !is_null( $row->rev_parent_id ) ) { $vals['new'] = ''; - if ( $row->rev_minor_edit ) + } + if ( $row->rev_minor_edit ) { $vals['minor'] = ''; - if ( $row->page_latest == $row->rev_id ) + } + if ( $row->page_latest == $row->rev_id ) { $vals['top'] = ''; + } } if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->rev_comment ) ) { - if ( $row->rev_deleted & Revision::DELETED_COMMENT ) + if ( $row->rev_deleted & Revision::DELETED_COMMENT ) { $vals['commenthidden'] = ''; - else { - if ( $this->fld_comment ) + } else { + if ( $this->fld_comment ) { $vals['comment'] = $row->rev_comment; - + } + if ( $this->fld_parsedcomment ) { - global $wgUser; - $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rev_comment, $title ); + $vals['parsedcomment'] = Linker::formatComment( $row->rev_comment, $title ); } } } - if ( $this->fld_patrolled && $row->rc_patrolled ) + if ( $this->fld_patrolled && $row->rc_patrolled ) { $vals['patrolled'] = ''; - - if ( $this->fld_size && !is_null( $row->rev_len ) ) + } + + if ( $this->fld_size && !is_null( $row->rev_len ) ) { $vals['size'] = intval( $row->rev_len ); + } if ( $this->fld_tags ) { if ( $row->ts_tags ) { @@ -328,51 +342,56 @@ class ApiQueryContributions extends ApiQueryBase { $vals['tags'] = array(); } } - + return $vals; } - - private function continueStr( $row ) - { + + private function continueStr( $row ) { return $row->rev_user_text . '|' . wfTimestamp( TS_ISO_8601, $row->rev_timestamp ); } + 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 array ( - 'limit' => array ( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + return array( + 'limit' => array( + 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' => array ( - ApiBase :: PARAM_TYPE => 'timestamp' + 'start' => array( + ApiBase::PARAM_TYPE => 'timestamp' ), - 'end' => array ( - ApiBase :: PARAM_TYPE => 'timestamp' + 'end' => array( + ApiBase::PARAM_TYPE => 'timestamp' ), 'continue' => null, - 'user' => array ( - ApiBase :: PARAM_ISMULTI => true + 'user' => array( + ApiBase::PARAM_ISMULTI => true ), 'userprefix' => null, - 'dir' => array ( - ApiBase :: PARAM_DFLT => 'older', - ApiBase :: PARAM_TYPE => array ( + 'dir' => array( + ApiBase::PARAM_DFLT => 'older', + ApiBase::PARAM_TYPE => array( 'newer', 'older' ) ), - 'namespace' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => 'namespace' + 'namespace' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' ), - 'prop' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_DFLT => 'ids|title|timestamp|comment|size|flags', - ApiBase :: PARAM_TYPE => array ( + 'prop' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_DFLT => 'ids|title|timestamp|comment|size|flags', + ApiBase::PARAM_TYPE => array( 'ids', 'title', 'timestamp', @@ -384,9 +403,9 @@ class ApiQueryContributions extends ApiQueryBase { 'tags' ) ), - 'show' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => array ( + 'show' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( 'minor', '!minor', 'patrolled', @@ -394,23 +413,87 @@ class ApiQueryContributions extends ApiQueryBase { ) ), 'tag' => null, + 'toponly' => false, ); } public function getParamDescription() { - return array ( - 'limit' => 'The maximum number of contributions to return.', - 'start' => 'The start timestamp to return from.', - 'end' => 'The end timestamp to return to.', - 'continue' => 'When more results are available, use this to continue.', - 'user' => 'The user to retrieve contributions for.', - 'userprefix' => 'Retrieve contibutions for all users whose names begin with this value. Overrides ucuser.', - 'dir' => 'The direction to search (older or newer).', + global $wgRCMaxAge; + $p = $this->getModulePrefix(); + return array( + 'limit' => 'The maximum number of contributions to return', + 'start' => 'The start timestamp to return from', + 'end' => 'The end timestamp to return to', + 'continue' => 'When more results are available, use this to continue', + 'user' => 'The users to retrieve contributions for', + 'userprefix' => "Retrieve contibutions for all users whose names begin with this value. Overrides {$p}user", + 'dir' => $this->getDirectionDescription( $p ), 'namespace' => 'Only list contributions in these namespaces', - 'prop' => 'Include additional pieces of information', - 'show' => array( 'Show only items that meet this criteria, e.g. non minor edits only: show=!minor', - 'NOTE: if show=patrolled or show=!patrolled is set, revisions older than $wgRCMaxAge won\'t be shown', ), + 'prop' => array( + 'Include additional pieces of information', + ' ids - Adds the page ID and revision ID', + ' title - Adds the title and namespace ID of the page', + ' timestamp - Adds the timestamp of the edit', + ' comment - Adds the comment of the edit', + ' parsedcomment - Adds the parsed comment of the edit', + ' size - Adds the size of the page', + ' flags - Adds flags of the edit', + ' patrolled - Tags patrolled edits', + ' tags - Lists tags for the edit', + ), + 'show' => array( "Show only items that meet this criteria, e.g. non minor edits only: {$p}show=!minor", + "NOTE: if {$p}show=patrolled or {$p}show=!patrolled is set, revisions older than \$wgRCMaxAge ($wgRCMaxAge) won't be shown", ), 'tag' => 'Only list revisions tagged with this tag', + 'toponly' => 'Only list changes which are the latest revision', + ); + } + + public function getResultProperties() { + return array( + '' => array( + 'userid' => 'integer', + 'user' => 'string', + 'userhidden' => 'boolean' + ), + 'ids' => array( + 'pageid' => 'integer', + 'revid' => 'integer' + ), + 'title' => array( + 'ns' => 'namespace', + 'title' => 'string' + ), + 'timestamp' => array( + 'timestamp' => 'timestamp' + ), + 'flags' => array( + 'new' => 'boolean', + 'minor' => 'boolean', + 'top' => 'boolean' + ), + 'comment' => array( + 'commenthidden' => 'boolean', + 'comment' => array( + ApiBase::PROP_TYPE => 'string', + ApiBase::PROP_NULLABLE => true + ) + ), + 'parsedcomment' => array( + 'commenthidden' => 'boolean', + 'parsedcomment' => array( + ApiBase::PROP_TYPE => 'string', + ApiBase::PROP_NULLABLE => true + ) + ), + 'patrolled' => array( + 'patrolled' => 'boolean' + ), + 'size' => array( + 'size' => array( + ApiBase::PROP_TYPE => 'integer', + ApiBase::PROP_NULLABLE => true + ) + ) ); } @@ -418,13 +501,26 @@ class ApiQueryContributions extends ApiQueryBase { return 'Get all edits by a user'; } - protected function getExamples() { - return array ( + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'param_user', 'info' => 'User parameter may not be empty.' ), + array( 'code' => 'param_user', 'info' => 'User name user is not valid' ), + array( 'show' ), + array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ), + ) ); + } + + public function getExamples() { + return array( 'api.php?action=query&list=usercontribs&ucuser=YurikBot', 'api.php?action=query&list=usercontribs&ucuserprefix=217.121.114.', ); } + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/API:Usercontribs'; + } + public function getVersion() { return __CLASS__ . ': $Id$'; }