includes/api/ApiQueryRecentChanges.php

   1 <?php
   2
   3 /*
   4  * Created on Oct 19, 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  * A query action to enumerate the recent changes that were done to the wiki.
  33  * Various filters are supported.
  34  *
  35  * @addtogroup API
  36  */
  37 class ApiQueryRecentChanges extends ApiQueryBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'rc');
  41         }
  42
  43         private $fld_comment = false, $fld_user = false, $fld_flags = false,
  44                         $fld_timestamp = false, $fld_title = false, $fld_ids = false,
  45                         $fld_sizes = false;
  46
  47         public function execute() {
  48                 $limit = $prop = $namespace = $show = $dir = $start = $end = null;
  49                 extract($this->extractRequestParams());
  50
  51                 $this->addTables('recentchanges');
  52                 $this->addWhereRange('rc_timestamp', $dir, $start, $end);
  53                 $this->addWhereFld('rc_namespace', $namespace);
  54                 $this->addWhereFld('rc_deleted', 0);
  55
  56                 if (!is_null($show)) {
  57                         $show = array_flip($show);
  58                         if ((isset ($show['minor']) && isset ($show['!minor'])) || (isset ($show['bot']) && isset ($show['!bot'])) || (isset ($show['anon']) && isset ($show['!anon'])))
  59                                 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
  60
  61                         $this->addWhereIf('rc_minor = 0', isset ($show['!minor']));
  62                         $this->addWhereIf('rc_minor != 0', isset ($show['minor']));
  63                         $this->addWhereIf('rc_bot = 0', isset ($show['!bot']));
  64                         $this->addWhereIf('rc_bot != 0', isset ($show['bot']));
  65                         $this->addWhereIf('rc_user = 0', isset ($show['anon']));
  66                         $this->addWhereIf('rc_user != 0', isset ($show['!anon']));
  67                 }
  68
  69                 $this->addFields(array (
  70                         'rc_timestamp',
  71                         'rc_namespace',
  72                         'rc_title',
  73                         'rc_type',
  74                         'rc_moved_to_ns',
  75                         'rc_moved_to_title'
  76                 ));
  77
  78                 if (!is_null($prop)) {
  79                         $prop = array_flip($prop);
  80
  81                         $this->fld_comment = isset ($prop['comment']);
  82                         $this->fld_user = isset ($prop['user']);
  83                         $this->fld_flags = isset ($prop['flags']);
  84                         $this->fld_timestamp = isset ($prop['timestamp']);
  85                         $this->fld_title = isset ($prop['title']);
  86                         $this->fld_ids = isset ($prop['ids']);
  87                         $this->fld_sizes = isset ($prop['sizes']);
  88
  89                         $this->addFieldsIf('rc_id', $this->fld_ids);
  90                         $this->addFieldsIf('rc_cur_id', $this->fld_ids);
  91                         $this->addFieldsIf('rc_this_oldid', $this->fld_ids);
  92                         $this->addFieldsIf('rc_last_oldid', $this->fld_ids);
  93                         $this->addFieldsIf('rc_comment', $this->fld_comment);
  94                         $this->addFieldsIf('rc_user', $this->fld_user);
  95                         $this->addFieldsIf('rc_user_text', $this->fld_user);
  96                         $this->addFieldsIf('rc_minor', $this->fld_flags);
  97                         $this->addFieldsIf('rc_bot', $this->fld_flags);
  98                         $this->addFieldsIf('rc_new', $this->fld_flags);
  99                         $this->addFieldsIf('rc_old_len', $this->fld_sizes);
 100                         $this->addFieldsIf('rc_new_len', $this->fld_sizes);
 101                 }
 102
 103                 $this->addOption('LIMIT', $limit +1);
 104                 $this->addOption('USE INDEX', 'rc_timestamp');
 105
 106                 $data = array ();
 107                 $count = 0;
 108                 $db = $this->getDB();
 109                 $res = $this->select(__METHOD__);
 110
 111                 while ($row = $db->fetchObject($res)) {
 112                         if (++ $count > $limit) {
 113                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 114                                 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
 115                                 break;
 116                         }
 117
 118                         $vals = $this->extractRowInfo($row);
 119                         if($vals)
 120                                 $data[] = $vals;
 121                 }
 122                 $db->freeResult($res);
 123
 124                 $result = $this->getResult();
 125                 $result->setIndexedTagName($data, 'rc');
 126                 $result->addValue('query', $this->getModuleName(), $data);
 127         }
 128
 129         private function extractRowInfo($row) {
 130                 $movedToTitle = false;
 131                 if (!empty($row->rc_moved_to_title))
 132                         $movedToTitle = Title :: makeTitle($row->rc_moved_to_ns, $row->rc_moved_to_title);
 133
 134                 $title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
 135                 $vals = array ();
 136
 137                 $vals['type'] = intval($row->rc_type);
 138
 139                 if ($this->fld_title) {
 140                         ApiQueryBase :: addTitleInfo($vals, $title);
 141                         if ($movedToTitle)
 142                                 ApiQueryBase :: addTitleInfo($vals, $movedToTitle, "new_");
 143                 }
 144
 145                 if ($this->fld_ids) {
 146                         $vals['rcid'] = intval($row->rc_id);
 147                         $vals['pageid'] = intval($row->rc_cur_id);
 148                         $vals['revid'] = intval($row->rc_this_oldid);
 149                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 150                 }
 151
 152                 if ($this->fld_user) {
 153                         $vals['user'] = $row->rc_user_text;
 154                         if(!$row->rc_user)
 155                                 $vals['anon'] = '';
 156                 }
 157
 158                 if ($this->fld_flags) {
 159                         if ($row->rc_bot)
 160                                 $vals['bot'] = '';
 161                         if ($row->rc_new)
 162                                 $vals['new'] = '';
 163                         if ($row->rc_minor)
 164                                 $vals['minor'] = '';
 165                 }
 166
 167                 if ($this->fld_sizes) {
 168                         $vals['oldlen'] = intval($row->rc_old_len);
 169                         $vals['newlen'] = intval($row->rc_new_len);
 170                 }
 171
 172                 if ($this->fld_timestamp)
 173                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rc_timestamp);
 174
 175                 if ($this->fld_comment && !empty ($row->rc_comment)) {
 176                         $vals['comment'] = $row->rc_comment;
 177                 }
 178
 179                 return $vals;
 180         }
 181
 182         protected function getAllowedParams() {
 183                 return array (
 184                         'start' => array (
 185                                 ApiBase :: PARAM_TYPE => 'timestamp'
 186                         ),
 187                         'end' => array (
 188                                 ApiBase :: PARAM_TYPE => 'timestamp'
 189                         ),
 190                         'dir' => array (
 191                                 ApiBase :: PARAM_DFLT => 'older',
 192                                 ApiBase :: PARAM_TYPE => array (
 193                                         'newer',
 194                                         'older'
 195                                 )
 196                         ),
 197                         'namespace' => array (
 198                                 ApiBase :: PARAM_ISMULTI => true,
 199                                 ApiBase :: PARAM_TYPE => 'namespace'
 200                         ),
 201                         'prop' => array (
 202                                 ApiBase :: PARAM_ISMULTI => true,
 203                                 ApiBase :: PARAM_DFLT => 'title|timestamp|ids',
 204                                 ApiBase :: PARAM_TYPE => array (
 205                                         'user',
 206                                         'comment',
 207                                         'flags',
 208                                         'timestamp',
 209                                         'title',
 210                                         'ids',
 211                                         'sizes'
 212                                 )
 213                         ),
 214                         'show' => array (
 215                                 ApiBase :: PARAM_ISMULTI => true,
 216                                 ApiBase :: PARAM_TYPE => array (
 217                                         'minor',
 218                                         '!minor',
 219                                         'bot',
 220                                         '!bot',
 221                                         'anon',
 222                                         '!anon'
 223                                 )
 224                         ),
 225                         'limit' => array (
 226                                 ApiBase :: PARAM_DFLT => 10,
 227                                 ApiBase :: PARAM_TYPE => 'limit',
 228                                 ApiBase :: PARAM_MIN => 1,
 229                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 230                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 231                         )
 232                 );
 233         }
 234
 235         protected function getParamDescription() {
 236                 return array (
 237                         'start' => 'The timestamp to start enumerating from.',
 238                         'end' => 'The timestamp to end enumerating.',
 239                         'dir' => 'In which direction to enumerate.',
 240                         'namespace' => 'Filter log entries to only this namespace(s)',
 241                         'prop' => 'Include additional pieces of information',
 242                         'show' => array (
 243                                 'Show only items that meet this criteria.',
 244                                 'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
 245                         ),
 246                         'limit' => 'How many total pages to return.'
 247                 );
 248         }
 249
 250         protected function getDescription() {
 251                 return 'Enumerate recent changes';
 252         }
 253
 254         protected function getExamples() {
 255                 return array (
 256                         'api.php?action=query&list=recentchanges'
 257                 );
 258         }
 259
 260         public function getVersion() {
 261                 return __CLASS__ . ': $Id$';
 262         }
 263 }
 264