diff options
Diffstat (limited to 'includes/api/ApiQueryLogEvents.php')
| -rw-r--r-- | includes/api/ApiQueryLogEvents.php | 155 |
1 files changed, 126 insertions, 29 deletions
diff --git a/includes/api/ApiQueryLogEvents.php b/includes/api/ApiQueryLogEvents.php index d9f23758..0f143658 100644 --- a/includes/api/ApiQueryLogEvents.php +++ b/includes/api/ApiQueryLogEvents.php @@ -5,7 +5,7 @@ * * API for MediaWiki 1.8+ * - * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com> + * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -29,6 +29,8 @@ if (!defined('MEDIAWIKI')) { } /** + * Query action to List the log events, with optional filtering by various parameters. + * * @addtogroup API */ class ApiQueryLogEvents extends ApiQueryBase { @@ -38,11 +40,18 @@ class ApiQueryLogEvents extends ApiQueryBase { } public function execute() { - $limit = $type = $start = $end = $dir = $user = $title = null; - extract($this->extractRequestParams()); - + $params = $this->extractRequestParams(); $db = $this->getDB(); + $prop = $params['prop']; + $this->fld_ids = in_array('ids', $prop); + $this->fld_title = in_array('title', $prop); + $this->fld_type = in_array('type', $prop); + $this->fld_user = in_array('user', $prop); + $this->fld_timestamp = in_array('timestamp', $prop); + $this->fld_comment = in_array('comment', $prop); + $this->fld_details = in_array('details', $prop); + list($tbl_logging, $tbl_page, $tbl_user) = $db->tableNamesN('logging', 'page', 'user'); $this->addOption('STRAIGHT_JOIN'); @@ -54,19 +63,27 @@ class ApiQueryLogEvents extends ApiQueryBase { 'log_type', 'log_action', 'log_timestamp', - 'log_user', - 'user_name', - 'log_namespace', - 'log_title', - 'page_id', - 'log_comment', - 'log_params' )); + + // FIXME: Fake out log_id for now until the column is live on Wikimedia + // $this->addFieldsIf('log_id', $this->fld_ids); + $this->addFieldsIf('page_id', $this->fld_ids); + $this->addFieldsIf('log_user', $this->fld_user); + $this->addFieldsIf('user_name', $this->fld_user); + $this->addFieldsIf('log_namespace', $this->fld_title); + $this->addFieldsIf('log_title', $this->fld_title); + $this->addFieldsIf('log_comment', $this->fld_comment); + $this->addFieldsIf('log_params', $this->fld_details); + + + $this->addWhereFld('log_deleted', 0); + $this->addWhereFld('log_type', $params['type']); + $this->addWhereRange('log_timestamp', $params['dir'], $params['start'], $params['end']); - $this->addWhereFld('log_type', $type); - $this->addWhereRange('log_timestamp', $dir, $start, $end); + $limit = $params['limit']; $this->addOption('LIMIT', $limit +1); + $user = $params['user']; if (!is_null($user)) { $userid = $db->selectField('user', 'user_id', array ( 'user_name' => $user @@ -76,6 +93,7 @@ class ApiQueryLogEvents extends ApiQueryBase { $this->addWhereFld('log_user', $userid); } + $title = $params['title']; if (!is_null($title)) { $titleObj = Title :: newFromText($title); if (is_null($titleObj)) @@ -90,11 +108,11 @@ class ApiQueryLogEvents extends ApiQueryBase { while ($row = $db->fetchObject($res)) { if (++ $count > $limit) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... - $this->setContinueEnumParameter('start', $row->log_timestamp); + $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->log_timestamp)); break; } - $vals = $this->addRowInfo('log', $row); + $vals = $this->extractRowInfo($row); if($vals) $data[] = $vals; } @@ -104,23 +122,102 @@ class ApiQueryLogEvents extends ApiQueryBase { $this->getResult()->addValue('query', $this->getModuleName(), $data); } + private function extractRowInfo($row) { + $vals = array(); + + if ($this->fld_ids) { + // FIXME: Fake out log_id for now until the column is live on Wikimedia + // $vals['logid'] = intval($row->log_id); + $vals['logid'] = 0; + $vals['pageid'] = intval($row->page_id); + } + + if ($this->fld_title) { + $title = Title :: makeTitle($row->log_namespace, $row->log_title); + ApiQueryBase :: addTitleInfo($vals, $title); + } + + if ($this->fld_type) { + $vals['type'] = $row->log_type; + $vals['action'] = $row->log_action; + } + + if ($this->fld_details && $row->log_params !== '') { + $params = explode("\n", $row->log_params); + switch ($row->log_type) { + case 'move': + if (isset ($params[0])) { + $title = Title :: newFromText($params[0]); + if ($title) { + $vals2 = array(); + ApiQueryBase :: addTitleInfo($vals2, $title, "new_"); + $vals[$row->log_type] = $vals2; + $params = null; + } + } + break; + case 'patrol': + $vals2 = array(); + list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params; + $vals[$row->log_type] = $vals2; + $params = null; + break; + case 'rights': + $vals2 = array(); + list( $vals2['old'], $vals2['new'] ) = $params; + $vals[$row->log_type] = $vals2; + $params = null; + break; + case 'block': + $vals2 = array(); + list( $vals2['duration'], $vals2['flags'] ) = $params; + $vals[$row->log_type] = $vals2; + $params = null; + break; + } + + if (isset($params)) { + $this->getResult()->setIndexedTagName($params, 'param'); + $vals = array_merge($vals, $params); + } + } + + if ($this->fld_user) { + $vals['user'] = $row->user_name; + if(!$row->log_user) + $vals['anon'] = ''; + } + if ($this->fld_timestamp) { + $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->log_timestamp); + } + if ($this->fld_comment && !empty ($row->log_comment)) { + $vals['comment'] = $row->log_comment; + } + + return $vals; + } + + protected function getAllowedParams() { + global $wgLogTypes; return array ( - 'type' => array ( + 'prop' => array ( ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details', ApiBase :: PARAM_TYPE => array ( - 'block', - 'protect', - 'rights', - 'delete', - 'upload', - 'move', - 'import', - 'renameuser', - 'newusers', - 'makebot' + 'ids', + 'title', + 'type', + 'user', + 'timestamp', + 'comment', + 'details', ) ), + 'type' => array ( + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => $wgLogTypes + ), 'start' => array ( ApiBase :: PARAM_TYPE => 'timestamp' ), @@ -140,7 +237,7 @@ class ApiQueryLogEvents extends ApiQueryBase { ApiBase :: PARAM_DFLT => 10, ApiBase :: PARAM_TYPE => 'limit', ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_BIG1, + ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 ) ); @@ -169,7 +266,7 @@ class ApiQueryLogEvents extends ApiQueryBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryLogEvents.php 21402 2007-04-20 08:55:14Z nickj $'; + return __CLASS__ . ': $Id: ApiQueryLogEvents.php 24256 2007-07-18 21:47:09Z robchurch $'; } } -?> + |