includes/api/ApiQueryUserContributions.php

   1 <?php
   2
   3 /*
   4  * Created on Oct 16, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * This query action adds a list of a specified user's contributions to the output.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryContributions extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'uc');
  40         }
  41
  42         private $params, $username;
  43         private $fld_ids = false, $fld_title = false, $fld_timestamp = false,
  44                         $fld_comment = false, $fld_flags = false;
  45
  46         public function execute() {
  47
  48                 // Parse some parameters
  49                 $this->params = $this->extractRequestParams();
  50
  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']);
  57
  58                 // TODO: if the query is going only against the revision table, should this be done?
  59                 $this->selectNamedDB('contributions', DB_SLAVE, 'contributions');
  60                 $db = $this->getDB();
  61
  62                 if(isset($this->params['userprefix']))
  63                 {
  64                         $this->prefixMode = true;
  65                         $this->multiUserMode = true;
  66                         $this->userprefix = $this->params['userprefix'];
  67                 }
  68                 else
  69                 {
  70                         $this->usernames = array();
  71                         if(!is_array($this->params['user']))
  72                                 $this->params['user'] = array($this->params['user']);
  73                         foreach($this->params['user'] as $u)
  74                                 $this->prepareUsername($u);
  75                         $this->prefixMode = false;
  76                         $this->multiUserMode = (count($this->params['user']) > 1);
  77                 }
  78                 $this->prepareQuery();
  79
  80                 //Do the actual query.
  81                 $res = $this->select( __METHOD__ );
  82
  83                 //Initialise some variables
  84                 $data = array ();
  85                 $count = 0;
  86                 $limit = $this->params['limit'];
  87
  88                 //Fetch each row
  89                 while ( $row = $db->fetchObject( $res ) ) {
  90                         if (++ $count > $limit) {
  91                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
  92                                 if($this->multiUserMode)
  93                                         $this->setContinueEnumParameter('continue', $this->continueStr($row));
  94                                 else
  95                                         $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rev_timestamp));
  96                                 break;
  97                         }
  98
  99                         $vals = $this->extractRowInfo($row);
 100                         if ($vals)
 101                                 $data[] = $vals;
 102                 }
 103
 104                 //Free the database record so the connection can get on with other stuff
 105                 $db->freeResult($res);
 106
 107                 //And send the whole shebang out as output.
 108                 $this->getResult()->setIndexedTagName($data, 'item');
 109                 $this->getResult()->addValue('query', $this->getModuleName(), $data);
 110         }
 111
 112         /**
 113          * Validate the 'user' parameter and set the value to compare
 114          * against `revision`.`rev_user_text`
 115          */
 116         private function prepareUsername($user) {
 117                 if( $user ) {
 118                         $name = User::isIP( $user )
 119                                 ? $user
 120                                 : User::getCanonicalName( $user, 'valid' );
 121                         if( $name === false ) {
 122                                 $this->dieUsage( "User name {$user} is not valid", 'param_user' );
 123                         } else {
 124                                 $this->usernames[] = $name;
 125                         }
 126                 } else {
 127                         $this->dieUsage( 'User parameter may not be empty', 'param_user' );
 128                 }
 129         }
 130
 131         /**
 132          * Prepares the query and returns the limit of rows requested
 133          */
 134         private function prepareQuery() {
 135
 136                 //We're after the revision table, and the corresponding page row for
 137                 //anything we retrieve.
 138                 $this->addTables(array('revision', 'page'));
 139                 $this->addWhere('page_id=rev_page');
 140
 141                 // Handle continue parameter
 142                 if($this->multiUserMode && !is_null($this->params['continue']))
 143                 {
 144                         $continue = explode('|', $this->params['continue']);
 145                         if(count($continue) != 2)
 146                                 $this->dieUsage("Invalid continue param. You should pass the original " .
 147                                         "value returned by the previous query", "_badcontinue");
 148                         $encUser = $this->getDB()->strencode($continue[0]);
 149                         $encTS = wfTimestamp(TS_MW, $continue[1]);
 150                         $op = ($this->params['dir'] == 'older' ? '<' : '>');
 151                         $this->addWhere("rev_user_text $op '$encUser' OR " .
 152                                         "(rev_user_text = '$encUser' AND " .
 153                                         "rev_timestamp $op= '$encTS')");
 154                 }
 155
 156                 $this->addWhereFld('rev_deleted', 0);
 157                 // We only want pages by the specified users.
 158                 if($this->prefixMode)
 159                         $this->addWhere("rev_user_text LIKE '" . $this->getDb()->escapeLike($this->userprefix) . "%'");
 160                 else
 161                         $this->addWhereFld('rev_user_text', $this->usernames);
 162                 // ... and in the specified timeframe.
 163                 // Ensure the same sort order for rev_user_text and rev_timestamp
 164                 // so our query is indexed
 165                 $this->addWhereRange('rev_user_text', $this->params['dir'], null, null);
 166                 $this->addWhereRange('rev_timestamp',
 167                         $this->params['dir'], $this->params['start'], $this->params['end'] );
 168                 $this->addWhereFld('page_namespace', $this->params['namespace']);
 169
 170                 $show = $this->params['show'];
 171                 if (!is_null($show)) {
 172                         $show = array_flip($show);
 173                         if (isset ($show['minor']) && isset ($show['!minor']))
 174                                 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
 175
 176                         $this->addWhereIf('rev_minor_edit = 0', isset ($show['!minor']));
 177                         $this->addWhereIf('rev_minor_edit != 0', isset ($show['minor']));
 178                 }
 179                 $this->addOption('LIMIT', $this->params['limit'] + 1);
 180
 181                 // Mandatory fields: timestamp allows request continuation
 182                 // ns+title checks if the user has access rights for this page
 183                 // user_text is necessary if multiple users were specified
 184                 $this->addFields(array(
 185                         'rev_timestamp',
 186                         'page_namespace',
 187                         'page_title',
 188                         'rev_user_text',
 189                         ));
 190
 191                 $this->addFieldsIf('rev_page', $this->fld_ids);
 192                 $this->addFieldsIf('rev_id', $this->fld_ids || $this->fld_flags);
 193                 $this->addFieldsIf('page_latest', $this->fld_flags);
 194                 // $this->addFieldsIf('rev_text_id', $this->fld_ids); // Should this field be exposed?
 195                 $this->addFieldsIf('rev_comment', $this->fld_comment);
 196                 $this->addFieldsIf('rev_minor_edit', $this->fld_flags);
 197                 $this->addFieldsIf('page_is_new', $this->fld_flags);
 198         }
 199
 200         /**
 201          * Extract fields from the database row and append them to a result array
 202          */
 203         private function extractRowInfo($row) {
 204
 205                 $vals = array();
 206
 207                 $vals['user'] = $row->rev_user_text;
 208                 if ($this->fld_ids) {
 209                         $vals['pageid'] = intval($row->rev_page);
 210                         $vals['revid'] = intval($row->rev_id);
 211                         // $vals['textid'] = intval($row->rev_text_id); // todo: Should this field be exposed?
 212                 }
 213
 214                 if ($this->fld_title)
 215                         ApiQueryBase :: addTitleInfo($vals,
 216                                 Title :: makeTitle($row->page_namespace, $row->page_title));
 217
 218                 if ($this->fld_timestamp)
 219                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rev_timestamp);
 220
 221                 if ($this->fld_flags) {
 222                         if ($row->page_is_new)
 223                                 $vals['new'] = '';
 224                         if ($row->rev_minor_edit)
 225                                 $vals['minor'] = '';
 226                         if ($row->page_latest == $row->rev_id)
 227                                 $vals['top'] = '';
 228                 }
 229
 230                 if ($this->fld_comment && !empty ($row->rev_comment))
 231                         $vals['comment'] = $row->rev_comment;
 232
 233                 return $vals;
 234         }
 235
 236         private function continueStr($row)
 237         {
 238                 return $row->rev_user_text . '|' .
 239                         wfTimestamp(TS_ISO_8601, $row->rev_timestamp);
 240         }
 241
 242         public function getAllowedParams() {
 243                 return array (
 244                         'limit' => array (
 245                                 ApiBase :: PARAM_DFLT => 10,
 246                                 ApiBase :: PARAM_TYPE => 'limit',
 247                                 ApiBase :: PARAM_MIN => 1,
 248                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 249                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 250                         ),
 251                         'start' => array (
 252                                 ApiBase :: PARAM_TYPE => 'timestamp'
 253                         ),
 254                         'end' => array (
 255                                 ApiBase :: PARAM_TYPE => 'timestamp'
 256                         ),
 257                         'continue' => null,
 258                         'user' => array (
 259                                 ApiBase :: PARAM_ISMULTI => true
 260                         ),
 261                         'userprefix' => null,
 262                         'dir' => array (
 263                                 ApiBase :: PARAM_DFLT => 'older',
 264                                 ApiBase :: PARAM_TYPE => array (
 265                                         'newer',
 266                                         'older'
 267                                 )
 268                         ),
 269                         'namespace' => array (
 270                                 ApiBase :: PARAM_ISMULTI => true,
 271                                 ApiBase :: PARAM_TYPE => 'namespace'
 272                         ),
 273                         'prop' => array (
 274                                 ApiBase :: PARAM_ISMULTI => true,
 275                                 ApiBase :: PARAM_DFLT => 'ids|title|timestamp|flags|comment',
 276                                 ApiBase :: PARAM_TYPE => array (
 277                                         'ids',
 278                                         'title',
 279                                         'timestamp',
 280                                         'comment',
 281                                         'flags'
 282                                 )
 283                         ),
 284                         'show' => array (
 285                                 ApiBase :: PARAM_ISMULTI => true,
 286                                 ApiBase :: PARAM_TYPE => array (
 287                                         'minor',
 288                                         '!minor',
 289                                 )
 290                         ),
 291                 );
 292         }
 293
 294         public function getParamDescription() {
 295                 return array (
 296                         'limit' => 'The maximum number of contributions to return.',
 297                         'start' => 'The start timestamp to return from.',
 298                         'end' => 'The end timestamp to return to.',
 299                         'continue' => 'When more results are available, use this to continue.',
 300                         'user' => 'The user to retrieve contributions for.',
 301                         'userprefix' => 'Retrieve contibutions for all users whose names begin with this value. Overrides ucuser.',
 302                         'dir' => 'The direction to search (older or newer).',
 303                         'namespace' => 'Only list contributions in these namespaces',
 304                         'prop' => 'Include additional pieces of information',
 305                         'show' => 'Show only items that meet this criteria, e.g. non minor edits only: show=!minor',
 306                 );
 307         }
 308
 309         public function getDescription() {
 310                 return 'Get all edits by a user';
 311         }
 312
 313         protected function getExamples() {
 314                 return array (
 315                         'api.php?action=query&list=usercontribs&ucuser=YurikBot',
 316                         'api.php?action=query&list=usercontribs&ucuserprefix=217.121.114.',
 317                 );
 318         }
 319
 320         public function getVersion() {
 321                 return __CLASS__ . ': $Id$';
 322         }
 323 }