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