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 );
54 $this->fld_tags
= in_array( 'tags', $prop );
56 list( $tbl_logging, $tbl_page, $tbl_user ) = $db->tableNamesN( 'logging', 'page', 'user' );
58 $hideLogs = LogEventsList
::getExcludeClause( $db );
59 if ( $hideLogs !== false )
60 $this->addWhere( $hideLogs );
62 // Order is significant here
63 $this->addTables( array( 'logging', 'user', 'page' ) );
64 $this->addOption( 'STRAIGHT_JOIN' );
65 $this->addJoinConds( array(
66 'user' => array( 'JOIN',
68 'page' => array( 'LEFT JOIN',
69 array( 'log_namespace=page_namespace',
70 'log_title=page_title' ) ) ) );
71 $index = 'times'; // default, may change
73 $this->addFields( array (
80 $this->addFieldsIf( 'log_id', $this->fld_ids
);
81 $this->addFieldsIf( 'page_id', $this->fld_ids
);
82 $this->addFieldsIf( 'log_user', $this->fld_user
);
83 $this->addFieldsIf( 'user_name', $this->fld_user
);
84 $this->addFieldsIf( 'log_namespace', $this->fld_title
);
85 $this->addFieldsIf( 'log_title', $this->fld_title
);
86 $this->addFieldsIf( 'log_comment', $this->fld_comment
);
87 $this->addFieldsIf( 'log_params', $this->fld_details
);
89 if ( $this->fld_tags
) {
90 $this->addTables( 'tag_summary' );
91 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', 'log_id=ts_log_id' ) ) );
92 $this->addFields( 'ts_tags' );
95 if ( !is_null( $params['tag'] ) ) {
96 $this->addTables( 'change_tag' );
97 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'log_id=ct_log_id' ) ) ) );
98 $this->addWhereFld( 'ct_tag', $params['tag'] );
101 if ( !is_null( $params['type'] ) ) {
102 $this->addWhereFld( 'log_type', $params['type'] );
103 $index = 'type_time';
106 $this->addWhereRange( 'log_timestamp', $params['dir'], $params['start'], $params['end'] );
108 $limit = $params['limit'];
109 $this->addOption( 'LIMIT', $limit +
1 );
111 $user = $params['user'];
112 if ( !is_null( $user ) ) {
113 $userid = User
::idFromName( $user );
115 $this->dieUsage( "User name $user not found", 'param_user' );
116 $this->addWhereFld( 'log_user', $userid );
117 $index = 'user_time';
120 $title = $params['title'];
121 if ( !is_null( $title ) ) {
122 $titleObj = Title
:: newFromText( $title );
123 if ( is_null( $titleObj ) )
124 $this->dieUsage( "Bad title value '$title'", 'param_title' );
125 $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
126 $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
128 // Use the title index in preference to the user index if there is a conflict
129 $index = is_null( $user ) ?
'page_time' : array( 'page_time', 'user_time' );
132 $this->addOption( 'USE INDEX', array( 'logging' => $index ) );
134 // Paranoia: avoid brute force searches (bug 17342)
135 if ( !is_null( $title ) ) {
136 $this->addWhere( $db->bitAnd( 'log_deleted', LogPage
::DELETED_ACTION
) . ' = 0' );
138 if ( !is_null( $user ) ) {
139 $this->addWhere( $db->bitAnd( 'log_deleted', LogPage
::DELETED_USER
) . ' = 0' );
143 $res = $this->select( __METHOD__
);
144 while ( $row = $db->fetchObject( $res ) ) {
145 if ( ++
$count > $limit ) {
146 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
147 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->log_timestamp
) );
151 $vals = $this->extractRowInfo( $row );
154 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
157 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->log_timestamp
) );
161 $db->freeResult( $res );
163 $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
166 public static function addLogParams( $result, &$vals, $params, $type, $ts ) {
167 $params = explode( "\n", $params );
170 if ( isset ( $params[0] ) ) {
171 $title = Title
:: newFromText( $params[0] );
174 ApiQueryBase
:: addTitleInfo( $vals2, $title, "new_" );
175 $vals[$type] = $vals2;
178 if ( isset ( $params[1] ) && $params[1] ) {
179 $vals[$type]['suppressedredirect'] = '';
185 list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
186 $vals[$type] = $vals2;
191 list( $vals2['old'], $vals2['new'] ) = $params;
192 $vals[$type] = $vals2;
197 list( $vals2['duration'], $vals2['flags'] ) = $params;
198 $vals2['expiry'] = wfTimestamp( TS_ISO_8601
,
199 strtotime( $params[0], wfTimestamp( TS_UNIX
, $ts ) ) );
200 $vals[$type] = $vals2;
204 if ( !is_null( $params ) ) {
205 $result->setIndexedTagName( $params, 'param' );
206 $vals = array_merge( $vals, $params );
211 private function extractRowInfo( $row ) {
214 if ( $this->fld_ids
) {
215 $vals['logid'] = intval( $row->log_id
);
216 $vals['pageid'] = intval( $row->page_id
);
219 if ( $this->fld_title
) {
220 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
221 $vals['actionhidden'] = '';
223 $title = Title
:: makeTitle( $row->log_namespace
, $row->log_title
);
224 ApiQueryBase
:: addTitleInfo( $vals, $title );
228 if ( $this->fld_type
) {
229 $vals['type'] = $row->log_type
;
230 $vals['action'] = $row->log_action
;
233 if ( $this->fld_details
&& $row->log_params
!== '' ) {
234 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
235 $vals['actionhidden'] = '';
237 self
::addLogParams( $this->getResult(), $vals,
238 $row->log_params
, $row->log_type
,
239 $row->log_timestamp
);
243 if ( $this->fld_user
) {
244 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_USER
) ) {
245 $vals['userhidden'] = '';
247 $vals['user'] = $row->user_name
;
248 if ( !$row->log_user
)
252 if ( $this->fld_timestamp
) {
253 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->log_timestamp
);
255 if ( $this->fld_comment
&& isset( $row->log_comment
) ) {
256 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_COMMENT
) ) {
257 $vals['commenthidden'] = '';
259 $vals['comment'] = $row->log_comment
;
263 if ( $this->fld_tags
) {
264 if ( $row->ts_tags
) {
265 $tags = explode( ',', $row->ts_tags
);
266 $this->getResult()->setIndexedTagName( $tags, 'tag' );
267 $vals['tags'] = $tags;
269 $vals['tags'] = array();
277 public function getAllowedParams() {
281 ApiBase
:: PARAM_ISMULTI
=> true,
282 ApiBase
:: PARAM_DFLT
=> 'ids|title|type|user|timestamp|comment|details',
283 ApiBase
:: PARAM_TYPE
=> array (
295 ApiBase
:: PARAM_TYPE
=> $wgLogTypes
298 ApiBase
:: PARAM_TYPE
=> 'timestamp'
301 ApiBase
:: PARAM_TYPE
=> 'timestamp'
304 ApiBase
:: PARAM_DFLT
=> 'older',
305 ApiBase
:: PARAM_TYPE
=> array (
314 ApiBase
:: PARAM_DFLT
=> 10,
315 ApiBase
:: PARAM_TYPE
=> 'limit',
316 ApiBase
:: PARAM_MIN
=> 1,
317 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
318 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
323 public function getParamDescription() {
325 'prop' => 'Which properties to get',
326 'type' => 'Filter log entries to only this type(s)',
327 'start' => 'The timestamp to start enumerating from.',
328 'end' => 'The timestamp to end enumerating.',
329 'dir' => 'In which direction to enumerate.',
330 'user' => 'Filter entries to those made by the given user.',
331 'title' => 'Filter entries to those related to a page.',
332 'limit' => 'How many total event entries to return.',
333 'tag' => 'Only list event entries tagged with this tag.',
337 public function getDescription() {
338 return 'Get events from logs.';
341 protected function getExamples() {
343 'api.php?action=query&list=logevents'
347 public function getVersion() {
348 return __CLASS__
. ': $Id$';