5 * Created on Oct 16, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * Query action to List the log events, with optional filtering by various parameters.
37 class ApiQueryLogEvents
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'le' );
43 private $fld_ids = false, $fld_title = false, $fld_type = false,
44 $fld_action = false, $fld_user = false, $fld_userid = false,
45 $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
46 $fld_details = false, $fld_tags = false;
48 public function execute() {
49 $params = $this->extractRequestParams();
52 $prop = array_flip( $params['prop'] );
54 $this->fld_ids
= isset( $prop['ids'] );
55 $this->fld_title
= isset( $prop['title'] );
56 $this->fld_type
= isset( $prop['type'] );
57 $this->fld_action
= isset ( $prop['action'] );
58 $this->fld_user
= isset( $prop['user'] );
59 $this->fld_userid
= isset( $prop['userid'] );
60 $this->fld_timestamp
= isset( $prop['timestamp'] );
61 $this->fld_comment
= isset( $prop['comment'] );
62 $this->fld_parsedcomment
= isset ( $prop['parsedcomment'] );
63 $this->fld_details
= isset( $prop['details'] );
64 $this->fld_tags
= isset( $prop['tags'] );
66 $hideLogs = LogEventsList
::getExcludeClause( $db );
67 if ( $hideLogs !== false ) {
68 $this->addWhere( $hideLogs );
71 // Order is significant here
72 $this->addTables( array( 'logging', 'user', 'page' ) );
73 $this->addOption( 'STRAIGHT_JOIN' );
74 $this->addJoinConds( array(
75 'user' => array( 'JOIN',
77 'page' => array( 'LEFT JOIN',
78 array( 'log_namespace=page_namespace',
79 'log_title=page_title' ) ) ) );
80 $index = array( 'logging' => 'times' ); // default, may change
82 $this->addFields( array(
89 $this->addFieldsIf( array( 'log_id', 'page_id' ), $this->fld_ids
);
90 $this->addFieldsIf( array( 'log_user', 'user_name' ), $this->fld_user
);
91 $this->addFieldsIf( 'user_id', $this->fld_userid
);
92 $this->addFieldsIf( array( 'log_namespace', 'log_title' ), $this->fld_title ||
$this->fld_parsedcomment
);
93 $this->addFieldsIf( 'log_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
94 $this->addFieldsIf( 'log_params', $this->fld_details
);
96 if ( $this->fld_tags
) {
97 $this->addTables( 'tag_summary' );
98 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', 'log_id=ts_log_id' ) ) );
99 $this->addFields( 'ts_tags' );
102 if ( !is_null( $params['tag'] ) ) {
103 $this->addTables( 'change_tag' );
104 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'log_id=ct_log_id' ) ) ) );
105 $this->addWhereFld( 'ct_tag', $params['tag'] );
106 global $wgOldChangeTagsIndex;
107 $index['change_tag'] = $wgOldChangeTagsIndex ?
'ct_tag' : 'change_tag_tag_id';
110 if ( !is_null( $params['action'] ) ) {
111 list( $type, $action ) = explode( '/', $params['action'] );
112 $this->addWhereFld( 'log_type', $type );
113 $this->addWhereFld( 'log_action', $action );
114 } elseif ( !is_null( $params['type'] ) ) {
115 $this->addWhereFld( 'log_type', $params['type'] );
116 $index['logging'] = 'type_time';
119 $this->addWhereRange( 'log_timestamp', $params['dir'], $params['start'], $params['end'] );
121 $limit = $params['limit'];
122 $this->addOption( 'LIMIT', $limit +
1 );
124 $user = $params['user'];
125 if ( !is_null( $user ) ) {
126 $userid = User
::idFromName( $user );
128 $this->dieUsage( "User name $user not found", 'param_user' );
130 $this->addWhereFld( 'log_user', $userid );
131 $index['logging'] = 'user_time';
134 $title = $params['title'];
135 if ( !is_null( $title ) ) {
136 $titleObj = Title
::newFromText( $title );
137 if ( is_null( $titleObj ) ) {
138 $this->dieUsage( "Bad title value '$title'", 'param_title' );
140 $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
141 $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
143 // Use the title index in preference to the user index if there is a conflict
144 $index['logging'] = is_null( $user ) ?
'page_time' : array( 'page_time', 'user_time' );
147 $prefix = $params['prefix'];
149 if ( !is_null( $prefix ) ) {
151 if ( $wgMiserMode ) {
152 $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
155 $title = Title
::newFromText( $prefix );
156 if ( is_null( $title ) ) {
157 $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
159 $this->addWhereFld( 'log_namespace', $title->getNamespace() );
160 $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
163 $this->addOption( 'USE INDEX', $index );
165 // Paranoia: avoid brute force searches (bug 17342)
166 if ( !is_null( $title ) ) {
167 $this->addWhere( $db->bitAnd( 'log_deleted', LogPage
::DELETED_ACTION
) . ' = 0' );
169 if ( !is_null( $user ) ) {
170 $this->addWhere( $db->bitAnd( 'log_deleted', LogPage
::DELETED_USER
) . ' = 0' );
174 $res = $this->select( __METHOD__
);
175 $result = $this->getResult();
176 foreach ( $res as $row ) {
177 if ( ++
$count > $limit ) {
178 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
179 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->log_timestamp
) );
183 $vals = $this->extractRowInfo( $row );
187 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
189 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->log_timestamp
) );
193 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
197 * @param $result ApiResult
199 * @param $params string
200 * @param $type string
201 * @param $action string
205 public static function addLogParams( $result, &$vals, $params, $type, $action, $ts ) {
206 $params = explode( "\n", $params );
209 if ( isset( $params[0] ) ) {
210 $title = Title
::newFromText( $params[0] );
213 ApiQueryBase
::addTitleInfo( $vals2, $title, 'new_' );
214 $vals[$type] = $vals2;
217 if ( isset( $params[1] ) && $params[1] ) {
218 $vals[$type]['suppressedredirect'] = '';
224 list( $vals2['cur'], $vals2['prev'], $vals2['auto'] ) = $params;
225 $vals[$type] = $vals2;
230 list( $vals2['old'], $vals2['new'] ) = $params;
231 $vals[$type] = $vals2;
235 if ( $action == 'unblock' ) {
239 list( $vals2['duration'], $vals2['flags'] ) = $params;
241 // Indefinite blocks have no expiry time
242 if ( SpecialBlock
::parseExpiryInput( $params[0] ) !== wfGetDB( DB_SLAVE
)->getInfinity() ) {
243 $vals2['expiry'] = wfTimestamp( TS_ISO_8601
,
244 strtotime( $params[0], wfTimestamp( TS_UNIX
, $ts ) ) );
246 $vals[$type] = $vals2;
250 if ( !is_null( $params ) ) {
251 $result->setIndexedTagName( $params, 'param' );
252 $vals = array_merge( $vals, $params );
257 private function extractRowInfo( $row ) {
260 if ( $this->fld_ids
) {
261 $vals['logid'] = intval( $row->log_id
);
262 $vals['pageid'] = intval( $row->page_id
);
265 if ( $this->fld_title ||
$this->fld_parsedcomment
) {
266 $title = Title
::makeTitle( $row->log_namespace
, $row->log_title
);
269 if ( $this->fld_title
) {
270 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
271 $vals['actionhidden'] = '';
273 ApiQueryBase
::addTitleInfo( $vals, $title );
277 if ( $this->fld_type ||
$this->fld_action
) {
278 $vals['type'] = $row->log_type
;
279 $vals['action'] = $row->log_action
;
282 if ( $this->fld_details
&& $row->log_params
!== '' ) {
283 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
284 $vals['actionhidden'] = '';
297 if ( $this->fld_user ||
$this->fld_userid
) {
298 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_USER
) ) {
299 $vals['userhidden'] = '';
301 if ( $this->fld_user
) {
302 $vals['user'] = $row->user_name
;
304 if ( $this->fld_userid
) {
305 $vals['userid'] = $row->user_id
;
308 if ( !$row->log_user
) {
313 if ( $this->fld_timestamp
) {
314 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->log_timestamp
);
317 if ( ( $this->fld_comment ||
$this->fld_parsedcomment
) && isset( $row->log_comment
) ) {
318 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_COMMENT
) ) {
319 $vals['commenthidden'] = '';
321 if ( $this->fld_comment
) {
322 $vals['comment'] = $row->log_comment
;
325 if ( $this->fld_parsedcomment
) {
326 $vals['parsedcomment'] = Linker
::formatComment( $row->log_comment
, $title );
331 if ( $this->fld_tags
) {
332 if ( $row->ts_tags
) {
333 $tags = explode( ',', $row->ts_tags
);
334 $this->getResult()->setIndexedTagName( $tags, 'tag' );
335 $vals['tags'] = $tags;
337 $vals['tags'] = array();
344 public function getCacheMode( $params ) {
345 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
346 // formatComment() calls wfMsg() among other things
347 return 'anon-public-user-private';
353 public function getAllowedParams() {
354 global $wgLogTypes, $wgLogActions;
357 ApiBase
::PARAM_ISMULTI
=> true,
358 ApiBase
::PARAM_DFLT
=> 'ids|title|type|user|timestamp|comment|details',
359 ApiBase
::PARAM_TYPE
=> array(
373 ApiBase
::PARAM_TYPE
=> $wgLogTypes
376 ApiBase
::PARAM_TYPE
=> array_keys( $wgLogActions )
379 ApiBase
::PARAM_TYPE
=> 'timestamp'
382 ApiBase
::PARAM_TYPE
=> 'timestamp'
385 ApiBase
::PARAM_DFLT
=> 'older',
386 ApiBase
::PARAM_TYPE
=> array(
396 ApiBase
::PARAM_DFLT
=> 10,
397 ApiBase
::PARAM_TYPE
=> 'limit',
398 ApiBase
::PARAM_MIN
=> 1,
399 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
400 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
405 public function getParamDescription() {
406 $p = $this->getModulePrefix();
409 'Which properties to get',
410 ' ids - Adds the ID of the log event',
411 ' title - Adds the title of the page for the log event',
412 ' type - Adds the type of log event',
413 ' user - Adds the user responsible for the log event',
414 ' userid - Adds the user ID who was responsible for the log event',
415 ' timestamp - Adds the timestamp for the event',
416 ' comment - Adds the comment of the event',
417 ' parsedcomment - Adds the parsed comment of the event',
418 ' details - Lists addtional details about the event',
419 ' tags - Lists tags for the event',
421 'type' => 'Filter log entries to only this type',
422 'action' => "Filter log actions to only this type. Overrides {$p}type",
423 'start' => 'The timestamp to start enumerating from',
424 'end' => 'The timestamp to end enumerating',
425 'dir' => $this->getDirectionDescription( $p ),
426 'user' => 'Filter entries to those made by the given user',
427 'title' => 'Filter entries to those related to a page',
428 'prefix' => 'Filter entries that start with this prefix. Disabled in Miser Mode',
429 'limit' => 'How many total event entries to return',
430 'tag' => 'Only list event entries tagged with this tag',
434 public function getDescription() {
435 return 'Get events from logs';
438 public function getPossibleErrors() {
439 return array_merge( parent
::getPossibleErrors(), array(
440 array( 'code' => 'param_user', 'info' => 'User name $user not found' ),
441 array( 'code' => 'param_title', 'info' => 'Bad title value \'title\'' ),
442 array( 'code' => 'param_prefix', 'info' => 'Bad title value \'prefix\'' ),
443 array( 'code' => 'prefixsearchdisabled', 'info' => 'Prefix search disabled in Miser Mode' ),
447 public function getExamples() {
449 'api.php?action=query&list=logevents'
453 public function getHelpUrls() {
454 return 'http://www.mediawiki.org/wiki/API:Logevents';
457 public function getVersion() {
458 return __CLASS__
. ': $Id$';