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