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  * @addtogroup 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                 $user = $params['user'];
  98                 if (!is_null($user)) {
  99                         $userid = $db->selectField('user', 'user_id', array (
 100                                 'user_name' => $user
 101                         ));
 102                         if (!$userid)
 103                                 $this->dieUsage("User name $user not found", 'param_user');
 104                         $this->addWhereFld('log_user', $userid);
 105                         $this->addOption('USE INDEX', array('logging' => array('user_time','page_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                         $this->addOption('USE INDEX', array('logging' => array('user_time','page_time')));
 116                 }
 117
 118                 $data = array ();
 119                 $count = 0;
 120                 $res = $this->select(__METHOD__);
 121                 while ($row = $db->fetchObject($res)) {
 122                         if (++ $count > $limit) {
 123                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 124                                 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp));
 125                                 break;
 126                         }
 127
 128                         $vals = $this->extractRowInfo($row);
 129                         if($vals)
 130                                 $data[] = $vals;
 131                 }
 132                 $db->freeResult($res);
 133
 134                 $this->getResult()->setIndexedTagName($data, 'item');
 135                 $this->getResult()->addValue('query', $this->getModuleName(), $data);
 136         }
 137
 138         private function extractRowInfo($row) {
 139                 $vals = array();
 140
 141                 if ($this->fld_ids) {
 142                         // FIXME: Fake out log_id for now until the column is live on Wikimedia
 143                         // $vals['logid'] = intval($row->log_id);
 144                         $vals['logid'] = 0;
 145                         $vals['pageid'] = intval($row->page_id);
 146                 }
 147
 148                 if ($this->fld_title) {
 149                         $title = Title :: makeTitle($row->log_namespace, $row->log_title);
 150                         ApiQueryBase :: addTitleInfo($vals, $title);
 151                 }
 152
 153                 if ($this->fld_type) {
 154                         $vals['type'] = $row->log_type;
 155                         $vals['action'] = $row->log_action;
 156                 }
 157
 158                 if ($this->fld_details && $row->log_params !== '') {
 159                         $params = explode("\n", $row->log_params);
 160                         switch ($row->log_type) {
 161                                 case 'move':
 162                                         if (isset ($params[0])) {
 163                                                 $title = Title :: newFromText($params[0]);
 164                                                 if ($title) {
 165                                                         $vals2 = array();
 166                                                         ApiQueryBase :: addTitleInfo($vals2, $title, "new_");
 167                                                         $vals[$row->log_type] = $vals2;
 168                                                         $params = null;
 169                                                 }
 170                                         }
 171                                         break;
 172                                 case 'patrol':
 173                                         $vals2 = array();
 174                                         list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
 175                                         $vals[$row->log_type] = $vals2;
 176                                         $params = null;
 177                                         break;
 178                                 case 'rights':
 179                                         $vals2 = array();
 180                                         list( $vals2['old'], $vals2['new'] ) = $params;
 181                                         $vals[$row->log_type] = $vals2;
 182                                         $params = null;
 183                                         break;
 184                                 case 'block':
 185                                         $vals2 = array();
 186                                         list( $vals2['duration'], $vals2['flags'] ) = $params;
 187                                         $vals[$row->log_type] = $vals2;
 188                                         $params = null;
 189                                         break;
 190                         }
 191
 192                         if (isset($params)) {
 193                                 $this->getResult()->setIndexedTagName($params, 'param');
 194                                 $vals = array_merge($vals, $params);
 195                         }
 196                 }
 197
 198                 if ($this->fld_user) {
 199                         $vals['user'] = $row->user_name;
 200                         if(!$row->log_user)
 201                                 $vals['anon'] = '';
 202                 }
 203                 if ($this->fld_timestamp) {
 204                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->log_timestamp);
 205                 }
 206                 if ($this->fld_comment && !empty ($row->log_comment)) {
 207                         $vals['comment'] = $row->log_comment;
 208                 }
 209
 210                 return $vals;
 211         }
 212
 213
 214         public function getAllowedParams() {
 215                 global $wgLogTypes;
 216                 return array (
 217                         'prop' => array (
 218                                 ApiBase :: PARAM_ISMULTI => true,
 219                                 ApiBase :: PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
 220                                 ApiBase :: PARAM_TYPE => array (
 221                                         'ids',
 222                                         'title',
 223                                         'type',
 224                                         'user',
 225                                         'timestamp',
 226                                         'comment',
 227                                         'details',
 228                                 )
 229                         ),
 230                         'type' => array (
 231                                 ApiBase :: PARAM_TYPE => $wgLogTypes
 232                         ),
 233                         'start' => array (
 234                                 ApiBase :: PARAM_TYPE => 'timestamp'
 235                         ),
 236                         'end' => array (
 237                                 ApiBase :: PARAM_TYPE => 'timestamp'
 238                         ),
 239                         'dir' => array (
 240                                 ApiBase :: PARAM_DFLT => 'older',
 241                                 ApiBase :: PARAM_TYPE => array (
 242                                         'newer',
 243                                         'older'
 244                                 )
 245                         ),
 246                         'user' => null,
 247                         'title' => null,
 248                         'limit' => array (
 249                                 ApiBase :: PARAM_DFLT => 10,
 250                                 ApiBase :: PARAM_TYPE => 'limit',
 251                                 ApiBase :: PARAM_MIN => 1,
 252                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 253                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 254                         )
 255                 );
 256         }
 257
 258         public function getParamDescription() {
 259                 return array (
 260                         'prop' => 'Which properties to get',
 261                         'type' => 'Filter log entries to only this type(s)',
 262                         'start' => 'The timestamp to start enumerating from.',
 263                         'end' => 'The timestamp to end enumerating.',
 264                         'dir' => 'In which direction to enumerate.',
 265                         'user' => 'Filter entries to those made by the given user.',
 266                         'title' => 'Filter entries to those related to a page.',
 267                         'limit' => 'How many total event entries to return.'
 268                 );
 269         }
 270
 271         public function getDescription() {
 272                 return 'Get events from logs.';
 273         }
 274
 275         protected function getExamples() {
 276                 return array (
 277                         'api.php?action=query&list=logevents'
 278                 );
 279         }
 280
 281         public function getVersion() {
 282                 return __CLASS__ . ': $Id$';
 283         }
 284 }