4 * Created on Oct 16, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * Query action to List the log events, with optional filtering by various parameters.
36 class ApiQueryLogEvents
extends ApiQueryBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'le');
42 public function execute() {
43 $params = $this->extractRequestParams();
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);
55 list($tbl_logging, $tbl_page, $tbl_user) = $db->tableNamesN('logging', 'page', 'user');
57 $hideLogs = LogEventsList
::getExcludeClause($db);
58 if($hideLogs !== false)
59 $this->addWhere($hideLogs);
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
70 $this->addFields(array (
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
);
85 $this->addWhereFld('log_deleted', 0);
87 if( !is_null($params['type']) ) {
88 $this->addWhereFld('log_type', $params['type']);
89 $this->addOption('USE INDEX', array('logging' => array('type_time')));
92 $this->addWhereRange('log_timestamp', $params['dir'], $params['start'], $params['end']);
94 $limit = $params['limit'];
95 $this->addOption('LIMIT', $limit +
1);
98 $user = $params['user'];
99 if (!is_null($user)) {
100 $userid = User
::idFromName($user);
102 $this->dieUsage("User name $user not found", 'param_user');
103 $this->addWhereFld('log_user', $userid);
104 $index = 'user_time';
107 $title = $params['title'];
108 if (!is_null($title)) {
109 $titleObj = Title
:: newFromText($title);
110 if (is_null($titleObj))
111 $this->dieUsage("Bad title value '$title'", 'param_title');
112 $this->addWhereFld('log_namespace', $titleObj->getNamespace());
113 $this->addWhereFld('log_title', $titleObj->getDBkey());
115 // Use the title index in preference to the user index if there is a conflict
116 $index = 'page_time';
119 $this->addOption( 'USE INDEX', array( 'logging' => $index ) );
125 $res = $this->select(__METHOD__
);
126 while ($row = $db->fetchObject($res)) {
127 if (++
$count > $limit) {
128 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
129 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601
, $row->log_timestamp
));
133 $vals = $this->extractRowInfo($row);
137 $db->freeResult($res);
139 $this->getResult()->setIndexedTagName($data, 'item');
140 $this->getResult()->addValue('query', $this->getModuleName(), $data);
143 public static function addLogParams($result, &$vals, $params, $type) {
144 $params = explode("\n", $params);
147 if (isset ($params[0])) {
148 $title = Title
:: newFromText($params[0]);
151 ApiQueryBase
:: addTitleInfo($vals2, $title, "new_");
152 $vals[$type] = $vals2;
159 list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
160 $vals[$type] = $vals2;
165 list( $vals2['old'], $vals2['new'] ) = $params;
166 $vals[$type] = $vals2;
171 list( $vals2['duration'], $vals2['flags'] ) = $params;
172 $vals[$type] = $vals2;
176 if (!is_null($params)) {
177 $result->setIndexedTagName($params, 'param');
178 $vals = array_merge($vals, $params);
183 private function extractRowInfo($row) {
186 if ($this->fld_ids
) {
187 $vals['logid'] = intval($row->log_id
);
188 $vals['pageid'] = intval($row->page_id
);
191 if ($this->fld_title
) {
192 $title = Title
:: makeTitle($row->log_namespace
, $row->log_title
);
193 ApiQueryBase
:: addTitleInfo($vals, $title);
196 if ($this->fld_type
) {
197 $vals['type'] = $row->log_type
;
198 $vals['action'] = $row->log_action
;
201 if ($this->fld_details
&& $row->log_params
!== '') {
202 self
::addLogParams($this->getResult(), $vals,
203 $row->log_params
, $row->log_type
);
206 if ($this->fld_user
) {
207 $vals['user'] = $row->user_name
;
211 if ($this->fld_timestamp
) {
212 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->log_timestamp
);
214 if ($this->fld_comment
&& isset($row->log_comment
)) {
215 $vals['comment'] = $row->log_comment
;
222 public function getAllowedParams() {
226 ApiBase
:: PARAM_ISMULTI
=> true,
227 ApiBase
:: PARAM_DFLT
=> 'ids|title|type|user|timestamp|comment|details',
228 ApiBase
:: PARAM_TYPE
=> array (
239 ApiBase
:: PARAM_TYPE
=> $wgLogTypes
242 ApiBase
:: PARAM_TYPE
=> 'timestamp'
245 ApiBase
:: PARAM_TYPE
=> 'timestamp'
248 ApiBase
:: PARAM_DFLT
=> 'older',
249 ApiBase
:: PARAM_TYPE
=> array (
257 ApiBase
:: PARAM_DFLT
=> 10,
258 ApiBase
:: PARAM_TYPE
=> 'limit',
259 ApiBase
:: PARAM_MIN
=> 1,
260 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
261 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
266 public function getParamDescription() {
268 'prop' => 'Which properties to get',
269 'type' => 'Filter log entries to only this type(s)',
270 'start' => 'The timestamp to start enumerating from.',
271 'end' => 'The timestamp to end enumerating.',
272 'dir' => 'In which direction to enumerate.',
273 'user' => 'Filter entries to those made by the given user.',
274 'title' => 'Filter entries to those related to a page.',
275 'limit' => 'How many total event entries to return.'
279 public function getDescription() {
280 return 'Get events from logs.';
283 protected function getExamples() {
285 'api.php?action=query&list=logevents'
289 public function getVersion() {
290 return __CLASS__
. ': $Id$';