4 * Created on Oct 16, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * This query action adds a list of a specified user's contributions to the output.
36 class ApiQueryContributions
extends ApiQueryBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'uc');
42 private $params, $username;
43 private $fld_ids = false, $fld_title = false, $fld_timestamp = false,
44 $fld_comment = false, $fld_flags = false;
46 public function execute() {
48 // Parse some parameters
49 $this->params
= $this->extractRequestParams();
51 $prop = array_flip($this->params
['prop']);
52 $this->fld_ids
= isset($prop['ids']);
53 $this->fld_title
= isset($prop['title']);
54 $this->fld_comment
= isset($prop['comment']);
55 $this->fld_flags
= isset($prop['flags']);
56 $this->fld_timestamp
= isset($prop['timestamp']);
58 // TODO: if the query is going only against the revision table, should this be done?
59 $this->selectNamedDB('contributions', DB_SLAVE
, 'contributions');
63 $this->usernames
= array();
64 if(!is_array($this->params
['user']))
65 $this->params
['user'] = array($this->params
['user']);
66 foreach($this->params
['user'] as $u)
67 $this->prepareUsername($u);
68 $this->prepareQuery();
70 //Do the actual query.
71 $res = $this->select( __METHOD__
);
73 //Initialise some variables
76 $limit = $this->params
['limit'];
79 while ( $row = $db->fetchObject( $res ) ) {
80 if (++
$count > $limit) {
81 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
82 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601
, $row->rev_timestamp
));
86 $vals = $this->extractRowInfo($row);
91 //Free the database record so the connection can get on with other stuff
92 $db->freeResult($res);
94 //And send the whole shebang out as output.
95 $this->getResult()->setIndexedTagName($data, 'item');
96 $this->getResult()->addValue('query', $this->getModuleName(), $data);
100 * Validate the 'user' parameter and set the value to compare
101 * against `revision`.`rev_user_text`
103 private function prepareUsername($user) {
105 $name = User
::isIP( $user )
107 : User
::getCanonicalName( $user, 'valid' );
108 if( $name === false ) {
109 $this->dieUsage( "User name {$user} is not valid", 'param_user' );
111 $this->usernames
[] = $name;
114 $this->dieUsage( 'User parameter may not be empty', 'param_user' );
119 * Prepares the query and returns the limit of rows requested
121 private function prepareQuery() {
123 //We're after the revision table, and the corresponding page row for
124 //anything we retrieve.
125 list ($tbl_page, $tbl_revision) = $this->getDB()->tableNamesN('page', 'revision');
126 $this->addTables("$tbl_revision LEFT OUTER JOIN $tbl_page ON page_id=rev_page");
128 $this->addWhereFld('rev_deleted', 0);
129 // We only want pages by the specified users.
130 $this->addWhereFld( 'rev_user_text', $this->usernames
);
131 // ... and in the specified timeframe.
132 $this->addWhereRange('rev_timestamp',
133 $this->params
['dir'], $this->params
['start'], $this->params
['end'] );
134 $this->addWhereFld('page_namespace', $this->params
['namespace']);
136 $show = $this->params
['show'];
137 if (!is_null($show)) {
138 $show = array_flip($show);
139 if (isset ($show['minor']) && isset ($show['!minor']))
140 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
142 $this->addWhereIf('rev_minor_edit = 0', isset ($show['!minor']));
143 $this->addWhereIf('rev_minor_edit != 0', isset ($show['minor']));
145 $this->addOption('LIMIT', $this->params
['limit'] +
1);
147 // Mandatory fields: timestamp allows request continuation
148 // ns+title checks if the user has access rights for this page
149 // user_text is necessary if multiple users were specified
150 $this->addFields(array(
157 $this->addFieldsIf('rev_page', $this->fld_ids
);
158 $this->addFieldsIf('rev_id', $this->fld_ids
);
159 // $this->addFieldsIf('rev_text_id', $this->fld_ids); // Should this field be exposed?
160 $this->addFieldsIf('rev_comment', $this->fld_comment
);
161 $this->addFieldsIf('rev_minor_edit', $this->fld_flags
);
162 $this->addFieldsIf('page_is_new', $this->fld_flags
);
166 * Extract fields from the database row and append them to a result array
168 private function extractRowInfo($row) {
172 $vals['user'] = $row->rev_user_text
;
173 if ($this->fld_ids
) {
174 $vals['pageid'] = intval($row->rev_page
);
175 $vals['revid'] = intval($row->rev_id
);
176 // $vals['textid'] = intval($row->rev_text_id); // todo: Should this field be exposed?
179 if ($this->fld_title
)
180 ApiQueryBase
:: addTitleInfo($vals,
181 Title
:: makeTitle($row->page_namespace
, $row->page_title
));
183 if ($this->fld_timestamp
)
184 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->rev_timestamp
);
186 if ($this->fld_flags
) {
187 if ($row->page_is_new
)
189 if ($row->rev_minor_edit
)
193 if ($this->fld_comment
&& !empty ($row->rev_comment
))
194 $vals['comment'] = $row->rev_comment
;
199 public function getAllowedParams() {
202 ApiBase
:: PARAM_DFLT
=> 10,
203 ApiBase
:: PARAM_TYPE
=> 'limit',
204 ApiBase
:: PARAM_MIN
=> 1,
205 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
206 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
209 ApiBase
:: PARAM_TYPE
=> 'timestamp'
212 ApiBase
:: PARAM_TYPE
=> 'timestamp'
215 ApiBase
:: PARAM_ISMULTI
=> true
218 ApiBase
:: PARAM_DFLT
=> 'older',
219 ApiBase
:: PARAM_TYPE
=> array (
224 'namespace' => array (
225 ApiBase
:: PARAM_ISMULTI
=> true,
226 ApiBase
:: PARAM_TYPE
=> 'namespace'
229 ApiBase
:: PARAM_ISMULTI
=> true,
230 ApiBase
:: PARAM_DFLT
=> 'ids|title|timestamp|flags|comment',
231 ApiBase
:: PARAM_TYPE
=> array (
240 ApiBase
:: PARAM_ISMULTI
=> true,
241 ApiBase
:: PARAM_TYPE
=> array (
249 public function getParamDescription() {
251 'limit' => 'The maximum number of contributions to return.',
252 'start' => 'The start timestamp to return from.',
253 'end' => 'The end timestamp to return to.',
254 'user' => 'The user to retrieve contributions for.',
255 'dir' => 'The direction to search (older or newer).',
256 'namespace' => 'Only list contributions in these namespaces',
257 'prop' => 'Include additional pieces of information',
258 'show' => 'Show only items that meet this criteria, e.g. non minor edits only: show=!minor',
262 public function getDescription() {
263 return 'Get all edits by a user';
266 protected function getExamples() {
268 'api.php?action=query&list=usercontribs&ucuser=YurikBot'
272 public function getVersion() {
273 return __CLASS__
. ': $Id$';