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
28 * Query action to List the log events, with optional filtering by various parameters.
32 class ApiQueryLogEvents
extends ApiQueryBase
{
34 public function __construct( ApiQuery
$query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'le' );
38 private $fld_ids = false, $fld_title = false, $fld_type = false,
39 $fld_action = false, $fld_user = false, $fld_userid = false,
40 $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
41 $fld_details = false, $fld_tags = false;
43 public function execute() {
44 $params = $this->extractRequestParams();
47 $prop = array_flip( $params['prop'] );
49 $this->fld_ids
= isset( $prop['ids'] );
50 $this->fld_title
= isset( $prop['title'] );
51 $this->fld_type
= isset( $prop['type'] );
52 $this->fld_action
= isset( $prop['action'] );
53 $this->fld_user
= isset( $prop['user'] );
54 $this->fld_userid
= isset( $prop['userid'] );
55 $this->fld_timestamp
= isset( $prop['timestamp'] );
56 $this->fld_comment
= isset( $prop['comment'] );
57 $this->fld_parsedcomment
= isset( $prop['parsedcomment'] );
58 $this->fld_details
= isset( $prop['details'] );
59 $this->fld_tags
= isset( $prop['tags'] );
61 $hideLogs = LogEventsList
::getExcludeClause( $db, 'user', $this->getUser() );
62 if ( $hideLogs !== false ) {
63 $this->addWhere( $hideLogs );
66 // Order is significant here
67 $this->addTables( array( 'logging', 'user', 'page' ) );
68 $this->addJoinConds( array(
69 'user' => array( 'LEFT JOIN',
71 'page' => array( 'LEFT JOIN',
72 array( 'log_namespace=page_namespace',
73 'log_title=page_title' ) ) ) );
75 $this->addFields( array(
83 $this->addFieldsIf( 'page_id', $this->fld_ids
);
84 // log_page is the page_id saved at log time, whereas page_id is from a
85 // join at query time. This leads to different results in various
86 // scenarios, e.g. deletion, recreation.
87 $this->addFieldsIf( 'log_page', $this->fld_ids
);
88 $this->addFieldsIf( array( 'log_user', 'log_user_text', 'user_name' ), $this->fld_user
);
89 $this->addFieldsIf( 'log_user', $this->fld_userid
);
91 array( 'log_namespace', 'log_title' ),
92 $this->fld_title ||
$this->fld_parsedcomment
94 $this->addFieldsIf( 'log_comment', $this->fld_comment ||
$this->fld_parsedcomment
);
95 $this->addFieldsIf( 'log_params', $this->fld_details
);
97 if ( $this->fld_tags
) {
98 $this->addTables( 'tag_summary' );
99 $this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', 'log_id=ts_log_id' ) ) );
100 $this->addFields( 'ts_tags' );
103 if ( !is_null( $params['tag'] ) ) {
104 $this->addTables( 'change_tag' );
105 $this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN',
106 array( 'log_id=ct_log_id' ) ) ) );
107 $this->addWhereFld( 'ct_tag', $params['tag'] );
110 if ( !is_null( $params['action'] ) ) {
111 // Do validation of action param, list of allowed actions can contains wildcards
112 // Allow the param, when the actions is in the list or a wildcard version is listed.
113 $logAction = $params['action'];
114 if ( strpos( $logAction, '/' ) === false ) {
115 // all items in the list have a slash
118 $logActions = array_flip( $this->getAllowedLogActions() );
119 list( $type, $action ) = explode( '/', $logAction, 2 );
120 $valid = isset( $logActions[$logAction] ) ||
isset( $logActions[$type . '/*'] );
124 $valueName = $this->encodeParamName( 'action' );
126 "Unrecognized value for parameter '$valueName': {$logAction}",
131 $this->addWhereFld( 'log_type', $type );
132 $this->addWhereFld( 'log_action', $action );
133 } elseif ( !is_null( $params['type'] ) ) {
134 $this->addWhereFld( 'log_type', $params['type'] );
137 $this->addTimestampWhereRange(
143 // Include in ORDER BY for uniqueness
144 $this->addWhereRange( 'log_id', $params['dir'], null, null );
146 if ( !is_null( $params['continue'] ) ) {
147 $cont = explode( '|', $params['continue'] );
148 $this->dieContinueUsageIf( count( $cont ) != 2 );
149 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
150 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
151 $continueId = (int)$cont[1];
152 $this->dieContinueUsageIf( $continueId != $cont[1] );
153 $this->addWhere( "log_timestamp $op $continueTimestamp OR " .
154 "(log_timestamp = $continueTimestamp AND " .
155 "log_id $op= $continueId)"
159 $limit = $params['limit'];
160 $this->addOption( 'LIMIT', $limit +
1 );
162 $user = $params['user'];
163 if ( !is_null( $user ) ) {
164 $userid = User
::idFromName( $user );
166 $this->addWhereFld( 'log_user', $userid );
168 $this->addWhereFld( 'log_user_text', IP
::sanitizeIP( $user ) );
172 $title = $params['title'];
173 if ( !is_null( $title ) ) {
174 $titleObj = Title
::newFromText( $title );
175 if ( is_null( $titleObj ) ) {
176 $this->dieUsage( "Bad title value '$title'", 'param_title' );
178 $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
179 $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
182 $prefix = $params['prefix'];
184 if ( !is_null( $prefix ) ) {
186 if ( $wgMiserMode ) {
187 $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
190 $title = Title
::newFromText( $prefix );
191 if ( is_null( $title ) ) {
192 $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
194 $this->addWhereFld( 'log_namespace', $title->getNamespace() );
195 $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
198 // Paranoia: avoid brute force searches (bug 17342)
199 if ( !is_null( $title ) ||
!is_null( $user ) ) {
200 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
201 $titleBits = LogPage
::DELETED_ACTION
;
202 $userBits = LogPage
::DELETED_USER
;
203 } elseif ( !$this->getUser()->isAllowed( 'suppressrevision' ) ) {
204 $titleBits = LogPage
::DELETED_ACTION | LogPage
::DELETED_RESTRICTED
;
205 $userBits = LogPage
::DELETED_USER | LogPage
::DELETED_RESTRICTED
;
210 if ( !is_null( $title ) && $titleBits ) {
211 $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
213 if ( !is_null( $user ) && $userBits ) {
214 $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
219 $res = $this->select( __METHOD__
);
220 $result = $this->getResult();
221 foreach ( $res as $row ) {
222 if ( ++
$count > $limit ) {
223 // We've reached the one extra which shows that there are
224 // additional pages to be had. Stop here...
225 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
229 $vals = $this->extractRowInfo( $row );
233 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
235 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
239 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
243 * @param ApiResult $result
245 * @param string $params
246 * @param string $type
247 * @param string $action
249 * @param bool $legacy
252 public static function addLogParams( $result, &$vals, $params, $type,
253 $action, $ts, $legacy = false
261 $targetKey = '4::target';
262 $noredirKey = '5::noredir';
265 if ( isset( $params[$targetKey] ) ) {
266 $title = Title
::newFromText( $params[$targetKey] );
269 ApiQueryBase
::addTitleInfo( $vals2, $title, 'new_' );
270 $vals[$type] = $vals2;
273 if ( isset( $params[$noredirKey] ) && $params[$noredirKey] ) {
274 $vals[$type]['suppressedredirect'] = '';
289 $vals2['cur'] = $params[$cur];
290 $vals2['prev'] = $params[$prev];
291 $vals2['auto'] = $params[$auto];
292 $vals[$type] = $vals2;
298 list( $vals2['old'], $vals2['new'] ) = $params;
300 $vals2['new'] = implode( ', ', $params['5::newgroups'] );
301 $vals2['old'] = implode( ', ', $params['4::oldgroups'] );
303 $vals[$type] = $vals2;
307 if ( $action == 'unblock' ) {
311 list( $vals2['duration'], $vals2['flags'] ) = $params;
313 // Indefinite blocks have no expiry time
314 if ( SpecialBlock
::parseExpiryInput( $params[0] ) !== wfGetDB( DB_SLAVE
)->getInfinity() ) {
315 $vals2['expiry'] = wfTimestamp( TS_ISO_8601
,
316 strtotime( $params[0], wfTimestamp( TS_UNIX
, $ts ) ) );
318 $vals[$type] = $vals2;
322 if ( isset( $params['img_timestamp'] ) ) {
323 $params['img_timestamp'] = wfTimestamp( TS_ISO_8601
, $params['img_timestamp'] );
327 if ( !is_null( $params ) ) {
328 $logParams = array();
329 // Keys like "4::paramname" can't be used for output so we change them to "paramname"
330 foreach ( $params as $key => $value ) {
331 if ( strpos( $key, ':' ) === false ) {
332 $logParams[$key] = $value;
335 $logParam = explode( ':', $key, 3 );
336 $logParams[$logParam[2]] = $value;
338 $result->setIndexedTagName( $logParams, 'param' );
339 $result->setIndexedTagName_recursive( $logParams, 'param' );
340 $vals = array_merge( $vals, $logParams );
346 private function extractRowInfo( $row ) {
347 $logEntry = DatabaseLogEntry
::newFromRow( $row );
350 $user = $this->getUser();
352 if ( $this->fld_ids
) {
353 $vals['logid'] = intval( $row->log_id
);
356 if ( $this->fld_title ||
$this->fld_parsedcomment
) {
357 $title = Title
::makeTitle( $row->log_namespace
, $row->log_title
);
360 if ( $this->fld_title ||
$this->fld_ids ||
$this->fld_details
&& $row->log_params
!== '' ) {
361 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
362 $vals['actionhidden'] = '';
365 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_ACTION
, $user ) ) {
366 if ( $this->fld_title
) {
367 ApiQueryBase
::addTitleInfo( $vals, $title );
369 if ( $this->fld_ids
) {
370 $vals['pageid'] = intval( $row->page_id
);
371 $vals['logpage'] = intval( $row->log_page
);
373 if ( $this->fld_details
&& $row->log_params
!== '' ) {
377 $logEntry->getParameters(),
378 $logEntry->getType(),
379 $logEntry->getSubtype(),
380 $logEntry->getTimestamp(),
381 $logEntry->isLegacy()
387 if ( $this->fld_type ||
$this->fld_action
) {
388 $vals['type'] = $row->log_type
;
389 $vals['action'] = $row->log_action
;
392 if ( $this->fld_user ||
$this->fld_userid
) {
393 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_USER
) ) {
394 $vals['userhidden'] = '';
397 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_USER
, $user ) ) {
398 if ( $this->fld_user
) {
399 $vals['user'] = $row->user_name
=== null ?
$row->log_user_text
: $row->user_name
;
401 if ( $this->fld_userid
) {
402 $vals['userid'] = $row->log_user
;
405 if ( !$row->log_user
) {
410 if ( $this->fld_timestamp
) {
411 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->log_timestamp
);
414 if ( ( $this->fld_comment ||
$this->fld_parsedcomment
) && isset( $row->log_comment
) ) {
415 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_COMMENT
) ) {
416 $vals['commenthidden'] = '';
419 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_COMMENT
, $user ) ) {
420 if ( $this->fld_comment
) {
421 $vals['comment'] = $row->log_comment
;
424 if ( $this->fld_parsedcomment
) {
425 $vals['parsedcomment'] = Linker
::formatComment( $row->log_comment
, $title );
430 if ( $this->fld_tags
) {
431 if ( $row->ts_tags
) {
432 $tags = explode( ',', $row->ts_tags
);
433 $this->getResult()->setIndexedTagName( $tags, 'tag' );
434 $vals['tags'] = $tags;
436 $vals['tags'] = array();
440 if ( $anyHidden && LogEventsList
::isDeleted( $row, LogPage
::DELETED_RESTRICTED
) ) {
441 $vals['suppressed'] = '';
447 private function getAllowedLogActions() {
448 global $wgLogActions, $wgLogActionsHandlers;
450 return array_keys( array_merge( $wgLogActions, $wgLogActionsHandlers ) );
453 public function getCacheMode( $params ) {
454 if ( $this->userCanSeeRevDel() ) {
457 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
458 // formatComment() calls wfMessage() among other things
459 return 'anon-public-user-private';
460 } elseif ( LogEventsList
::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
461 === LogEventsList
::getExcludeClause( $this->getDB(), 'public' )
462 ) { // Output can only contain public data.
465 return 'anon-public-user-private';
469 public function getAllowedParams( $flags = 0 ) {
474 ApiBase
::PARAM_ISMULTI
=> true,
475 ApiBase
::PARAM_DFLT
=> 'ids|title|type|user|timestamp|comment|details',
476 ApiBase
::PARAM_TYPE
=> array(
490 ApiBase
::PARAM_TYPE
=> $wgLogTypes
493 // validation on request is done in execute()
494 ApiBase
::PARAM_TYPE
=> ( $flags & ApiBase
::GET_VALUES_FOR_HELP
)
495 ?
$this->getAllowedLogActions()
499 ApiBase
::PARAM_TYPE
=> 'timestamp'
502 ApiBase
::PARAM_TYPE
=> 'timestamp'
505 ApiBase
::PARAM_DFLT
=> 'older',
506 ApiBase
::PARAM_TYPE
=> array(
516 ApiBase
::PARAM_DFLT
=> 10,
517 ApiBase
::PARAM_TYPE
=> 'limit',
518 ApiBase
::PARAM_MIN
=> 1,
519 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
520 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
526 public function getParamDescription() {
527 $p = $this->getModulePrefix();
531 'Which properties to get',
532 ' ids - Adds the ID of the log event',
533 ' title - Adds the title of the page for the log event',
534 ' type - Adds the type of log event',
535 ' user - Adds the user responsible for the log event',
536 ' userid - Adds the user ID who was responsible for the log event',
537 ' timestamp - Adds the timestamp for the event',
538 ' comment - Adds the comment of the event',
539 ' parsedcomment - Adds the parsed comment of the event',
540 ' details - Lists additional details about the event',
541 ' tags - Lists tags for the event',
543 'type' => 'Filter log entries to only this type',
545 "Filter log actions to only this action. Overrides {$p}type",
546 "Wildcard actions like 'action/*' allows to specify any string for the asterisk"
548 'start' => 'The timestamp to start enumerating from',
549 'end' => 'The timestamp to end enumerating',
550 'dir' => $this->getDirectionDescription( $p ),
551 'user' => 'Filter entries to those made by the given user',
552 'title' => 'Filter entries to those related to a page',
553 'prefix' => 'Filter entries that start with this prefix. Disabled in Miser Mode',
554 'limit' => 'How many total event entries to return',
555 'tag' => 'Only list event entries tagged with this tag',
556 'continue' => 'When more results are available, use this to continue',
560 public function getResultProperties() {
565 'logid' => 'integer',
566 'pageid' => 'integer'
574 ApiBase
::PROP_TYPE
=> $wgLogTypes
579 'actionhidden' => 'boolean'
582 'userhidden' => 'boolean',
584 ApiBase
::PROP_TYPE
=> 'string',
585 ApiBase
::PROP_NULLABLE
=> true
590 'userhidden' => 'boolean',
592 ApiBase
::PROP_TYPE
=> 'integer',
593 ApiBase
::PROP_NULLABLE
=> true
597 'timestamp' => array(
598 'timestamp' => 'timestamp'
601 'commenthidden' => 'boolean',
603 ApiBase
::PROP_TYPE
=> 'string',
604 ApiBase
::PROP_NULLABLE
=> true
607 'parsedcomment' => array(
608 'commenthidden' => 'boolean',
609 'parsedcomment' => array(
610 ApiBase
::PROP_TYPE
=> 'string',
611 ApiBase
::PROP_NULLABLE
=> true
617 public function getDescription() {
618 return 'Get events from logs.';
621 public function getPossibleErrors() {
622 return array_merge( parent
::getPossibleErrors(), array(
623 array( 'code' => 'param_user', 'info' => 'User name $user not found' ),
624 array( 'code' => 'param_title', 'info' => 'Bad title value \'title\'' ),
625 array( 'code' => 'param_prefix', 'info' => 'Bad title value \'prefix\'' ),
626 array( 'code' => 'prefixsearchdisabled', 'info' => 'Prefix search disabled in Miser Mode' ),
630 public function getExamples() {
632 'api.php?action=query&list=logevents'
636 public function getHelpUrls() {
637 return 'https://www.mediawiki.org/wiki/API:Logevents';