includes/api/ApiQueryLogEvents.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  * Query action to List the log events, with optional filtering by various parameters.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryLogEvents extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'le');
  40         }
  41
  42         public function execute() {
  43                 $params = $this->extractRequestParams();
  44                 $db = $this->getDB();
  45
  46                 $prop = $params['prop'];
  47                 $this->fld_ids = in_array('ids', $prop);
  48                 $this->fld_title = in_array('title', $prop);
  49                 $this->fld_type = in_array('type', $prop);
  50                 $this->fld_user = in_array('user', $prop);
  51                 $this->fld_timestamp = in_array('timestamp', $prop);
  52                 $this->fld_comment = in_array('comment', $prop);
  53                 $this->fld_details = in_array('details', $prop);
  54
  55                 list($tbl_logging, $tbl_page, $tbl_user) = $db->tableNamesN('logging', 'page', 'user');
  56
  57                 $hideLogs = LogEventsList::getExcludeClause($db);
  58                 if($hideLogs !== false)
  59                         $this->addWhere($hideLogs);
  60
  61                 // Order is significant here
  62                 $this->addTables(array('logging', 'user', 'page'));
  63                 $this->addOption('STRAIGHT_JOIN');
  64                 $this->addJoinConds(array(
  65                         'user' => array('JOIN',
  66                                 'user_id=log_user'),
  67                         'page' => array('LEFT JOIN',
  68                                 array(  'log_namespace=page_namespace',
  69                                         'log_title=page_title'))));
  70                 $index = 'times'; // default, may change
  71
  72                 $this->addFields(array (
  73                         'log_type',
  74                         'log_action',
  75                         'log_timestamp',
  76                         'log_deleted',
  77                 ));
  78
  79                 $this->addFieldsIf('log_id', $this->fld_ids);
  80                 $this->addFieldsIf('page_id', $this->fld_ids);
  81                 $this->addFieldsIf('log_user', $this->fld_user);
  82                 $this->addFieldsIf('user_name', $this->fld_user);
  83                 $this->addFieldsIf('log_namespace', $this->fld_title);
  84                 $this->addFieldsIf('log_title', $this->fld_title);
  85                 $this->addFieldsIf('log_comment', $this->fld_comment);
  86                 $this->addFieldsIf('log_params', $this->fld_details);
  87
  88                 if( !is_null($params['type']) ) {
  89                         $this->addWhereFld('log_type', $params['type']);
  90                         $index = 'type_time';
  91                 }
  92
  93                 $this->addWhereRange('log_timestamp', $params['dir'], $params['start'], $params['end']);
  94
  95                 $limit = $params['limit'];
  96                 $this->addOption('LIMIT', $limit +1);
  97
  98                 $user = $params['user'];
  99                 if (!is_null($user)) {
 100                         $userid = User::idFromName($user);
 101                         if (!$userid)
 102                                 $this->dieUsage("User name $user not found", 'param_user');
 103                         $this->addWhereFld('log_user', $userid);
 104                         $index = 'user_time';
 105                 }
 106
 107                 $title = $params['title'];
 108                 if (!is_null($title)) {
 109                         $titleObj = Title :: newFromText($title);
 110                         if (is_null($titleObj))
 111                                 $this->dieUsage("Bad title value '$title'", 'param_title');
 112                         $this->addWhereFld('log_namespace', $titleObj->getNamespace());
 113                         $this->addWhereFld('log_title', $titleObj->getDBkey());
 114
 115                         // Use the title index in preference to the user index if there is a conflict
 116                         $index = is_null($user) ? 'page_time' : array('page_time','user_time');
 117                 }
 118
 119                 $this->addOption( 'USE INDEX', array( 'logging' => $index ) );
 120
 121                 // Paranoia: avoid brute force searches (bug 17342)
 122                 if (!is_null($title)) {
 123                         $this->addWhere('log_deleted & ' . LogPage::DELETED_ACTION . ' = 0');
 124                 }
 125                 if (!is_null($user)) {
 126                         $this->addWhere('log_deleted & ' . LogPage::DELETED_USER . ' = 0');
 127                 }
 128
 129                 $count = 0;
 130                 $res = $this->select(__METHOD__);
 131                 while ($row = $db->fetchObject($res)) {
 132                         if (++ $count > $limit) {
 133                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 134                                 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp));
 135                                 break;
 136                         }
 137
 138                         $vals = $this->extractRowInfo($row);
 139                         if(!$vals)
 140                                 continue;
 141                         $fit = $this->getResult()->addValue(array('query', $this->getModuleName()), null, $vals);
 142                         if(!$fit)
 143                         {
 144                                 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp));
 145                                 break;
 146                         }
 147                 }
 148                 $db->freeResult($res);
 149
 150                 $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'item');
 151         }
 152
 153         public static function addLogParams($result, &$vals, $params, $type, $ts) {
 154                 $params = explode("\n", $params);
 155                 switch ($type) {
 156                         case 'move':
 157                                 if (isset ($params[0])) {
 158                                         $title = Title :: newFromText($params[0]);
 159                                         if ($title) {
 160                                                 $vals2 = array();
 161                                                 ApiQueryBase :: addTitleInfo($vals2, $title, "new_");
 162                                                 $vals[$type] = $vals2;
 163                                                 $params = null;
 164                                         }
 165                                 }
 166                                 break;
 167                         case 'patrol':
 168                                 $vals2 = array();
 169                                 list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
 170                                 $vals[$type] = $vals2;
 171                                 $params = null;
 172                                 break;
 173                         case 'rights':
 174                                 $vals2 = array();
 175                                 list( $vals2['old'], $vals2['new'] ) = $params;
 176                                 $vals[$type] = $vals2;
 177                                 $params = null;
 178                                 break;
 179                         case 'block':
 180                                 $vals2 = array();
 181                                 list( $vals2['duration'], $vals2['flags'] ) = $params;
 182                                 $vals2['expiry'] = wfTimestamp(TS_ISO_8601,
 183                                                 strtotime($params[0], wfTimestamp(TS_UNIX, $ts)));
 184                                 $vals[$type] = $vals2;
 185                                 $params = null;
 186                                 break;
 187                 }
 188                 if (!is_null($params)) {
 189                         $result->setIndexedTagName($params, 'param');
 190                         $vals = array_merge($vals, $params);
 191                 }
 192                 return $vals;
 193         }
 194
 195         private function extractRowInfo($row) {
 196                 $vals = array();
 197
 198                 if ($this->fld_ids) {
 199                         $vals['logid'] = intval($row->log_id);
 200                         $vals['pageid'] = intval($row->page_id);
 201                 }
 202
 203                 if ($this->fld_title) {
 204                         if (LogEventsList::isDeleted($row, LogPage::DELETED_ACTION)) {
 205                                 $vals['actionhidden'] = '';
 206                         } else {
 207                                 $title = Title :: makeTitle($row->log_namespace, $row->log_title);
 208                                 ApiQueryBase :: addTitleInfo($vals, $title);
 209                         }
 210                 }
 211
 212                 if ($this->fld_type) {
 213                         $vals['type'] = $row->log_type;
 214                         $vals['action'] = $row->log_action;
 215                 }
 216
 217                 if ($this->fld_details && $row->log_params !== '') {
 218                         if (LogEventsList::isDeleted($row, LogPage::DELETED_ACTION)) {
 219                                 $vals['actionhidden'] = '';
 220                         } else {
 221                                 self::addLogParams($this->getResult(), $vals,
 222                                         $row->log_params, $row->log_type,
 223                                         $row->log_timestamp);
 224                         }
 225                 }
 226
 227                 if ($this->fld_user) {
 228                         if (LogEventsList::isDeleted($row, LogPage::DELETED_USER)) {
 229                                 $vals['userhidden'] = '';
 230                         } else {
 231                                 $vals['user'] = $row->user_name;
 232                                 if(!$row->log_user)
 233                                         $vals['anon'] = '';
 234                         }
 235                 }
 236                 if ($this->fld_timestamp) {
 237                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->log_timestamp);
 238                 }
 239                 if ($this->fld_comment && isset($row->log_comment)) {
 240                         if (LogEventsList::isDeleted($row, LogPage::DELETED_COMMENT)) {
 241                                 $vals['commenthidden'] = '';
 242                         } else {
 243                                 $vals['comment'] = $row->log_comment;
 244                         }
 245                 }
 246
 247                 return $vals;
 248         }
 249
 250
 251         public function getAllowedParams() {
 252                 global $wgLogTypes;
 253                 return array (
 254                         'prop' => array (
 255                                 ApiBase :: PARAM_ISMULTI => true,
 256                                 ApiBase :: PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
 257                                 ApiBase :: PARAM_TYPE => array (
 258                                         'ids',
 259                                         'title',
 260                                         'type',
 261                                         'user',
 262                                         'timestamp',
 263                                         'comment',
 264                                         'details',
 265                                 )
 266                         ),
 267                         'type' => array (
 268                                 ApiBase :: PARAM_TYPE => $wgLogTypes
 269                         ),
 270                         'start' => array (
 271                                 ApiBase :: PARAM_TYPE => 'timestamp'
 272                         ),
 273                         'end' => array (
 274                                 ApiBase :: PARAM_TYPE => 'timestamp'
 275                         ),
 276                         'dir' => array (
 277                                 ApiBase :: PARAM_DFLT => 'older',
 278                                 ApiBase :: PARAM_TYPE => array (
 279                                         'newer',
 280                                         'older'
 281                                 )
 282                         ),
 283                         'user' => null,
 284                         'title' => null,
 285                         'limit' => array (
 286                                 ApiBase :: PARAM_DFLT => 10,
 287                                 ApiBase :: PARAM_TYPE => 'limit',
 288                                 ApiBase :: PARAM_MIN => 1,
 289                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 290                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 291                         )
 292                 );
 293         }
 294
 295         public function getParamDescription() {
 296                 return array (
 297                         'prop' => 'Which properties to get',
 298                         'type' => 'Filter log entries to only this type(s)',
 299                         'start' => 'The timestamp to start enumerating from.',
 300                         'end' => 'The timestamp to end enumerating.',
 301                         'dir' => 'In which direction to enumerate.',
 302                         'user' => 'Filter entries to those made by the given user.',
 303                         'title' => 'Filter entries to those related to a page.',
 304                         'limit' => 'How many total event entries to return.'
 305                 );
 306         }
 307
 308         public function getDescription() {
 309                 return 'Get events from logs.';
 310         }
 311
 312         protected function getExamples() {
 313                 return array (
 314                         'api.php?action=query&list=logevents'
 315                 );
 316         }
 317
 318         public function getVersion() {
 319                 return __CLASS__ . ': $Id$';
 320         }
 321 }