5 * Created on Oct 16, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * This query action adds a list of a specified user's contributions to the output.
37 class ApiQueryContributions
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'uc' );
43 private $params, $prefixMode, $userprefix, $multiUserMode, $usernames;
44 private $fld_ids = false, $fld_title = false, $fld_timestamp = false,
45 $fld_comment = false, $fld_parsedcomment = false, $fld_flags = false,
46 $fld_patrolled = false, $fld_tags = false, $fld_size = false;
48 public function execute() {
49 // Parse some parameters
50 $this->params
= $this->extractRequestParams();
52 $prop = array_flip( $this->params
['prop'] );
53 $this->fld_ids
= isset( $prop['ids'] );
54 $this->fld_title
= isset( $prop['title'] );
55 $this->fld_comment
= isset( $prop['comment'] );
56 $this->fld_parsedcomment
= isset ( $prop['parsedcomment'] );
57 $this->fld_size
= isset( $prop['size'] );
58 $this->fld_flags
= isset( $prop['flags'] );
59 $this->fld_timestamp
= isset( $prop['timestamp'] );
60 $this->fld_patrolled
= isset( $prop['patrolled'] );
61 $this->fld_tags
= isset( $prop['tags'] );
63 // TODO: if the query is going only against the revision table, should this be done?
64 $this->selectNamedDB( 'contributions', DB_SLAVE
, 'contributions' );
66 if ( isset( $this->params
['userprefix'] ) ) {
67 $this->prefixMode
= true;
68 $this->multiUserMode
= true;
69 $this->userprefix
= $this->params
['userprefix'];
71 $this->usernames
= array();
72 if ( !is_array( $this->params
['user'] ) ) {
73 $this->params
['user'] = array( $this->params
['user'] );
75 if ( !count( $this->params
['user'] ) ) {
76 $this->dieUsage( 'User parameter may not be empty.', 'param_user' );
78 foreach ( $this->params
['user'] as $u ) {
79 $this->prepareUsername( $u );
81 $this->prefixMode
= false;
82 $this->multiUserMode
= ( count( $this->params
['user'] ) > 1 );
85 $this->prepareQuery();
87 // Do the actual query.
88 $res = $this->select( __METHOD__
);
90 // Initialise some variables
92 $limit = $this->params
['limit'];
95 foreach ( $res as $row ) {
96 if ( ++
$count > $limit ) {
97 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
98 if ( $this->multiUserMode
) {
99 $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) );
101 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rev_timestamp
) );
106 $vals = $this->extractRowInfo( $row );
107 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
109 if ( $this->multiUserMode
) {
110 $this->setContinueEnumParameter( 'continue', $this->continueStr( $row ) );
112 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->rev_timestamp
) );
118 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
122 * Validate the 'user' parameter and set the value to compare
123 * against `revision`.`rev_user_text`
125 * @param $user string
127 private function prepareUsername( $user ) {
128 if ( !is_null( $user ) && $user !== '' ) {
129 $name = User
::isIP( $user )
131 : User
::getCanonicalName( $user, 'valid' );
132 if ( $name === false ) {
133 $this->dieUsage( "User name {$user} is not valid", 'param_user' );
135 $this->usernames
[] = $name;
138 $this->dieUsage( 'User parameter may not be empty', 'param_user' );
143 * Prepares the query and returns the limit of rows requested
145 private function prepareQuery() {
146 // We're after the revision table, and the corresponding page
147 // row for anything we retrieve. We may also need the
148 // recentchanges row and/or tag summary row.
149 $user = $this->getUser();
150 $tables = array( 'page', 'revision' ); // Order may change
151 $this->addWhere( 'page_id=rev_page' );
153 // Handle continue parameter
154 if ( $this->multiUserMode
&& !is_null( $this->params
['continue'] ) ) {
155 $continue = explode( '|', $this->params
['continue'] );
156 if ( count( $continue ) != 2 ) {
157 $this->dieUsage( 'Invalid continue param. You should pass the original ' .
158 'value returned by the previous query', '_badcontinue' );
160 $encUser = $this->getDB()->strencode( $continue[0] );
161 $encTS = wfTimestamp( TS_MW
, $continue[1] );
162 $op = ( $this->params
['dir'] == 'older' ?
'<' : '>' );
164 "rev_user_text $op '$encUser' OR " .
165 "(rev_user_text = '$encUser' AND " .
166 "rev_timestamp $op= '$encTS')"
170 if ( !$user->isAllowed( 'hideuser' ) ) {
171 $this->addWhere( $this->getDB()->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' );
173 // We only want pages by the specified users.
174 if ( $this->prefixMode
) {
175 $this->addWhere( 'rev_user_text' . $this->getDB()->buildLike( $this->userprefix
, $this->getDB()->anyString() ) );
177 $this->addWhereFld( 'rev_user_text', $this->usernames
);
179 // ... and in the specified timeframe.
180 // Ensure the same sort order for rev_user_text and rev_timestamp
181 // so our query is indexed
182 if ( $this->multiUserMode
) {
183 $this->addWhereRange( 'rev_user_text', $this->params
['dir'], null, null );
185 $this->addTimestampWhereRange( 'rev_timestamp',
186 $this->params
['dir'], $this->params
['start'], $this->params
['end'] );
187 $this->addWhereFld( 'page_namespace', $this->params
['namespace'] );
189 $show = $this->params
['show'];
190 if ( !is_null( $show ) ) {
191 $show = array_flip( $show );
192 if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
193 ||
( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) ) ) {
194 $this->dieUsageMsg( 'show' );
197 $this->addWhereIf( 'rev_minor_edit = 0', isset( $show['!minor'] ) );
198 $this->addWhereIf( 'rev_minor_edit != 0', isset( $show['minor'] ) );
199 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
200 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
202 $this->addOption( 'LIMIT', $this->params
['limit'] +
1 );
203 $index = array( 'revision' => 'usertext_timestamp' );
205 // Mandatory fields: timestamp allows request continuation
206 // ns+title checks if the user has access rights for this page
207 // user_text is necessary if multiple users were specified
208 $this->addFields( array(
217 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ||
218 $this->fld_patrolled
) {
219 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
220 $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
223 // Use a redundant join condition on both
224 // timestamp and ID so we can use the timestamp
226 $index['recentchanges'] = 'rc_user_text';
227 if ( isset( $show['patrolled'] ) ||
isset( $show['!patrolled'] ) ) {
228 // Put the tables in the right order for
230 $tables = array( 'revision', 'recentchanges', 'page' );
231 $this->addOption( 'STRAIGHT_JOIN' );
232 $this->addWhere( 'rc_user_text=rev_user_text' );
233 $this->addWhere( 'rc_timestamp=rev_timestamp' );
234 $this->addWhere( 'rc_this_oldid=rev_id' );
236 $tables[] = 'recentchanges';
237 $this->addJoinConds( array( 'recentchanges' => array(
239 'rc_user_text=rev_user_text',
240 'rc_timestamp=rev_timestamp',
241 'rc_this_oldid=rev_id' ) ) ) );
245 $this->addTables( $tables );
246 $this->addFieldsIf( 'rev_page', $this->fld_ids
);
247 $this->addFieldsIf( 'rev_id', $this->fld_ids ||
$this->fld_flags
);
248 $this->addFieldsIf( 'page_latest', $this->fld_flags
);
249 // $this->addFieldsIf( 'rev_text_id', $this->fld_ids ); // Should this field be exposed?
250 $this->addFieldsIf( 'rev_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
251 $this->addFieldsIf( 'rev_len', $this->fld_size
);
252 $this->addFieldsIf( array( 'rev_minor_edit', 'rev_parent_id' ), $this->fld_flags
);
253 $this->addFieldsIf( 'rc_patrolled', $this->fld_patrolled
);
255 if ( $this->fld_tags
) {
256 $this->addTables( 'tag_summary' );
257 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rev_id=ts_rev_id' ) ) ) );
258 $this->addFields( 'ts_tags' );
261 if ( isset( $this->params
['tag'] ) ) {
262 $this->addTables( 'change_tag' );
263 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rev_id=ct_rev_id' ) ) ) );
264 $this->addWhereFld( 'ct_tag', $this->params
['tag'] );
265 global $wgOldChangeTagsIndex;
266 $index['change_tag'] = $wgOldChangeTagsIndex ?
'ct_tag' : 'change_tag_tag_id';
269 if ( $this->params
['toponly'] ) {
270 $this->addWhere( 'rev_id = page_latest' );
273 $this->addOption( 'USE INDEX', $index );
277 * Extract fields from the database row and append them to a result array
281 private function extractRowInfo( $row ) {
284 $vals['userid'] = $row->rev_user
;
285 $vals['user'] = $row->rev_user_text
;
286 if ( $row->rev_deleted
& Revision
::DELETED_USER
) {
287 $vals['userhidden'] = '';
289 if ( $this->fld_ids
) {
290 $vals['pageid'] = intval( $row->rev_page
);
291 $vals['revid'] = intval( $row->rev_id
);
292 // $vals['textid'] = intval( $row->rev_text_id ); // todo: Should this field be exposed?
295 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
297 if ( $this->fld_title
) {
298 ApiQueryBase
::addTitleInfo( $vals, $title );
301 if ( $this->fld_timestamp
) {
302 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->rev_timestamp
);
305 if ( $this->fld_flags
) {
306 if ( $row->rev_parent_id
== 0 && !is_null( $row->rev_parent_id
) ) {
309 if ( $row->rev_minor_edit
) {
312 if ( $row->page_latest
== $row->rev_id
) {
317 if ( ( $this->fld_comment ||
$this->fld_parsedcomment
) && isset( $row->rev_comment
) ) {
318 if ( $row->rev_deleted
& Revision
::DELETED_COMMENT
) {
319 $vals['commenthidden'] = '';
321 if ( $this->fld_comment
) {
322 $vals['comment'] = $row->rev_comment
;
325 if ( $this->fld_parsedcomment
) {
326 $vals['parsedcomment'] = Linker
::formatComment( $row->rev_comment
, $title );
331 if ( $this->fld_patrolled
&& $row->rc_patrolled
) {
332 $vals['patrolled'] = '';
335 if ( $this->fld_size
&& !is_null( $row->rev_len
) ) {
336 $vals['size'] = intval( $row->rev_len
);
339 if ( $this->fld_tags
) {
340 if ( $row->ts_tags
) {
341 $tags = explode( ',', $row->ts_tags
);
342 $this->getResult()->setIndexedTagName( $tags, 'tag' );
343 $vals['tags'] = $tags;
345 $vals['tags'] = array();
352 private function continueStr( $row ) {
353 return $row->rev_user_text
. '|' .
354 wfTimestamp( TS_ISO_8601
, $row->rev_timestamp
);
357 public function getCacheMode( $params ) {
358 // This module provides access to deleted revisions and patrol flags if
359 // the requester is logged in
360 return 'anon-public-user-private';
363 public function getAllowedParams() {
366 ApiBase
::PARAM_DFLT
=> 10,
367 ApiBase
::PARAM_TYPE
=> 'limit',
368 ApiBase
::PARAM_MIN
=> 1,
369 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
370 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
373 ApiBase
::PARAM_TYPE
=> 'timestamp'
376 ApiBase
::PARAM_TYPE
=> 'timestamp'
380 ApiBase
::PARAM_ISMULTI
=> true
382 'userprefix' => null,
384 ApiBase
::PARAM_DFLT
=> 'older',
385 ApiBase
::PARAM_TYPE
=> array(
390 'namespace' => array(
391 ApiBase
::PARAM_ISMULTI
=> true,
392 ApiBase
::PARAM_TYPE
=> 'namespace'
395 ApiBase
::PARAM_ISMULTI
=> true,
396 ApiBase
::PARAM_DFLT
=> 'ids|title|timestamp|comment|size|flags',
397 ApiBase
::PARAM_TYPE
=> array(
410 ApiBase
::PARAM_ISMULTI
=> true,
411 ApiBase
::PARAM_TYPE
=> array(
423 public function getParamDescription() {
425 $p = $this->getModulePrefix();
427 'limit' => 'The maximum number of contributions to return',
428 'start' => 'The start timestamp to return from',
429 'end' => 'The end timestamp to return to',
430 'continue' => 'When more results are available, use this to continue',
431 'user' => 'The users to retrieve contributions for',
432 'userprefix' => "Retrieve contibutions for all users whose names begin with this value. Overrides {$p}user",
433 'dir' => $this->getDirectionDescription( $p ),
434 'namespace' => 'Only list contributions in these namespaces',
436 'Include additional pieces of information',
437 ' ids - Adds the page ID and revision ID',
438 ' title - Adds the title and namespace ID of the page',
439 ' timestamp - Adds the timestamp of the edit',
440 ' comment - Adds the comment of the edit',
441 ' parsedcomment - Adds the parsed comment of the edit',
442 ' size - Adds the size of the page',
443 ' flags - Adds flags of the edit',
444 ' patrolled - Tags patrolled edits',
445 ' tags - Lists tags for the edit',
447 'show' => array( "Show only items that meet this criteria, e.g. non minor edits only: {$p}show=!minor",
448 "NOTE: if {$p}show=patrolled or {$p}show=!patrolled is set, revisions older than $wgRCMaxAge won\'t be shown", ),
449 'tag' => 'Only list revisions tagged with this tag',
450 'toponly' => 'Only list changes which are the latest revision',
454 public function getDescription() {
455 return 'Get all edits by a user';
458 public function getPossibleErrors() {
459 return array_merge( parent
::getPossibleErrors(), array(
460 array( 'code' => 'param_user', 'info' => 'User parameter may not be empty.' ),
461 array( 'code' => 'param_user', 'info' => 'User name user is not valid' ),
463 array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
467 public function getExamples() {
469 'api.php?action=query&list=usercontribs&ucuser=YurikBot',
470 'api.php?action=query&list=usercontribs&ucuserprefix=217.121.114.',
474 public function getHelpUrls() {
475 return 'http://www.mediawiki.org/wiki/API:Usercontribs';
478 public function getVersion() {
479 return __CLASS__
. ': $Id$';