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, $userTitle;
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->getUserTitle();
64 $this->prepareQuery();
66 //Do the actual query.
67 $res = $this->select( __METHOD__
);
69 //Initialise some variables
72 $limit = $this->params
['limit'];
75 while ( $row = $db->fetchObject( $res ) ) {
76 if (++
$count > $limit) {
77 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
78 $this->setContinueEnumParameter('start', $row->rev_timestamp
);
82 $vals = $this->extractRowInfo($row);
87 //Free the database record so the connection can get on with other stuff
88 $db->freeResult($res);
90 //And send the whole shebang out as output.
91 $this->getResult()->setIndexedTagName($data, 'item');
92 $this->getResult()->addValue('query', $this->getModuleName(), $data);
96 * Convert 'user' parameter into a proper user login name.
97 * This method also validates that this user actually exists in the database.
99 private function getUserTitle() {
101 $user = $this->params
['user'];
103 $this->dieUsage("User parameter may not be empty", 'param_user');
105 $userTitle = Title
::makeTitleSafe( NS_USER
, $user );
106 if ( is_null( $userTitle ) )
107 $this->dieUsage("User name $user is not valid", 'param_user');
109 $userid = $this->getDB()->selectField('user', 'user_id', array (
110 'user_name' => $userTitle->getText()
114 $this->dieUsage("User name $user not found", 'param_user');
116 $this->userTitle
= $userTitle;
120 * Prepares the query and returns the limit of rows requested
122 private function prepareQuery() {
124 //We're after the revision table, and the corresponding page row for
125 //anything we retrieve.
126 list ($tbl_page, $tbl_revision) = $this->getDB()->tableNamesN('page', 'revision');
127 $this->addTables("$tbl_revision LEFT OUTER JOIN $tbl_page ON page_id=rev_page");
129 $this->addWhereFld('rev_deleted', 0);
131 // We only want pages by the specified user.
132 $this->addWhereFld('rev_user_text', $this->userTitle
->getText());
134 // ... and in the specified timeframe.
135 $this->addWhereRange('rev_timestamp',
136 $this->params
['dir'], $this->params
['start'], $this->params
['end'] );
138 $show = $this->params
['show'];
139 if (!is_null($show)) {
140 $show = array_flip($show);
141 if (isset ($show['minor']) && isset ($show['!minor']))
142 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
144 $this->addWhereIf('rev_minor_edit = 0', isset ($show['!minor']));
145 $this->addWhereIf('rev_minor_edit != 0', isset ($show['minor']));
148 $this->addOption('LIMIT', $this->params
['limit'] +
1);
150 // Mandatory fields: timestamp allows request continuation
151 // ns+title checks if the user has access rights for this page
152 $this->addFields(array(
158 $this->addFieldsIf('rev_page', $this->fld_ids
);
159 $this->addFieldsIf('rev_id', $this->fld_ids
);
160 // $this->addFieldsIf('rev_text_id', $this->fld_ids); // Should this field be exposed?
161 $this->addFieldsIf('rev_comment', $this->fld_comment
);
162 $this->addFieldsIf('rev_minor_edit', $this->fld_flags
);
164 // These fields depend only work if the page table is joined
165 $this->addFieldsIf('page_is_new', $this->fld_flags
);
169 * Extract fields from the database row and append them to a result array
171 private function extractRowInfo($row) {
173 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
174 if (!$title->userCanRead())
179 if ($this->fld_ids
) {
180 $vals['pageid'] = intval($row->rev_page
);
181 $vals['revid'] = intval($row->rev_id
);
182 // $vals['textid'] = intval($row->rev_text_id); // todo: Should this field be exposed?
185 if ($this->fld_title
)
186 ApiQueryBase
:: addTitleInfo($vals, $title);
188 if ($this->fld_timestamp
)
189 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->rev_timestamp
);
191 if ($this->fld_flags
) {
192 if ($row->page_is_new
)
194 if ($row->rev_minor_edit
)
198 if ($this->fld_comment
&& !empty ($row->rev_comment
))
199 $vals['comment'] = $row->rev_comment
;
204 protected function getAllowedParams() {
207 ApiBase
:: PARAM_DFLT
=> 10,
208 ApiBase
:: PARAM_TYPE
=> 'limit',
209 ApiBase
:: PARAM_MIN
=> 1,
210 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
211 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
214 ApiBase
:: PARAM_TYPE
=> 'timestamp'
217 ApiBase
:: PARAM_TYPE
=> 'timestamp'
220 ApiBase
:: PARAM_TYPE
=> 'user'
223 ApiBase
:: PARAM_DFLT
=> 'older',
224 ApiBase
:: PARAM_TYPE
=> array (
230 ApiBase
:: PARAM_ISMULTI
=> true,
231 ApiBase
:: PARAM_DFLT
=> 'ids|title|timestamp|flags|comment',
232 ApiBase
:: PARAM_TYPE
=> array (
241 ApiBase
:: PARAM_ISMULTI
=> true,
242 ApiBase
:: PARAM_TYPE
=> array (
250 protected function getParamDescription() {
252 'limit' => 'The maximum number of contributions to return.',
253 'start' => 'The start timestamp to return from.',
254 'end' => 'The end timestamp to return to.',
255 'user' => 'The user to retrieve contributions for.',
256 'dir' => 'The direction to search (older or newer).',
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 protected function getDescription() {
263 return 'Get 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$';