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