3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Storage\NameTableAccessException
;
27 * Query action to List the log events, with optional filtering by various parameters.
31 class ApiQueryLogEvents
extends ApiQueryBase
{
33 private $commentStore;
35 public function __construct( ApiQuery
$query, $moduleName ) {
36 parent
::__construct( $query, $moduleName, 'le' );
39 private $fld_ids = false, $fld_title = false, $fld_type = false,
40 $fld_user = false, $fld_userid = false,
41 $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
42 $fld_details = false, $fld_tags = false;
44 public function execute() {
45 $params = $this->extractRequestParams();
47 $this->commentStore
= CommentStore
::getStore();
48 $this->requireMaxOneParameter( $params, 'title', 'prefix', 'namespace' );
50 $prop = array_flip( $params['prop'] );
52 $this->fld_ids
= isset( $prop['ids'] );
53 $this->fld_title
= isset( $prop['title'] );
54 $this->fld_type
= isset( $prop['type'] );
55 $this->fld_user
= isset( $prop['user'] );
56 $this->fld_userid
= isset( $prop['userid'] );
57 $this->fld_timestamp
= isset( $prop['timestamp'] );
58 $this->fld_comment
= isset( $prop['comment'] );
59 $this->fld_parsedcomment
= isset( $prop['parsedcomment'] );
60 $this->fld_details
= isset( $prop['details'] );
61 $this->fld_tags
= isset( $prop['tags'] );
63 $hideLogs = LogEventsList
::getExcludeClause( $db, 'user', $this->getUser() );
64 if ( $hideLogs !== false ) {
65 $this->addWhere( $hideLogs );
68 $actorMigration = ActorMigration
::newMigration();
69 $actorQuery = $actorMigration->getJoin( 'log_user' );
70 $this->addTables( 'logging' );
71 $this->addTables( $actorQuery['tables'] );
72 $this->addTables( [ 'user', 'page' ] );
73 $this->addJoinConds( $actorQuery['joins'] );
74 $this->addJoinConds( [
75 'user' => [ 'LEFT JOIN',
76 'user_id=' . $actorQuery['fields']['log_user'] ],
77 'page' => [ 'LEFT JOIN',
78 [ 'log_namespace=page_namespace',
79 'log_title=page_title' ] ] ] );
89 $this->addFieldsIf( 'page_id', $this->fld_ids
);
90 // log_page is the page_id saved at log time, whereas page_id is from a
91 // join at query time. This leads to different results in various
92 // scenarios, e.g. deletion, recreation.
93 $this->addFieldsIf( 'log_page', $this->fld_ids
);
94 $this->addFieldsIf( $actorQuery['fields'] +
[ 'user_name' ], $this->fld_user
);
95 $this->addFieldsIf( $actorQuery['fields'], $this->fld_userid
);
97 [ 'log_namespace', 'log_title' ],
98 $this->fld_title ||
$this->fld_parsedcomment
100 $this->addFieldsIf( 'log_params', $this->fld_details
);
102 if ( $this->fld_comment ||
$this->fld_parsedcomment
) {
103 $commentQuery = $this->commentStore
->getJoin( 'log_comment' );
104 $this->addTables( $commentQuery['tables'] );
105 $this->addFields( $commentQuery['fields'] );
106 $this->addJoinConds( $commentQuery['joins'] );
109 if ( $this->fld_tags
) {
110 $this->addFields( [ 'ts_tags' => ChangeTags
::makeTagSummarySubquery( 'logging' ) ] );
113 if ( !is_null( $params['tag'] ) ) {
114 $this->addTables( 'change_tag' );
115 $this->addJoinConds( [ 'change_tag' => [ 'JOIN',
116 [ 'log_id=ct_log_id' ] ] ] );
117 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
119 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
120 } catch ( NameTableAccessException
$exception ) {
122 $this->addWhere( '1=0' );
126 if ( !is_null( $params['action'] ) ) {
127 // Do validation of action param, list of allowed actions can contains wildcards
128 // Allow the param, when the actions is in the list or a wildcard version is listed.
129 $logAction = $params['action'];
130 if ( strpos( $logAction, '/' ) === false ) {
131 // all items in the list have a slash
134 $logActions = array_flip( $this->getAllowedLogActions() );
135 list( $type, $action ) = explode( '/', $logAction, 2 );
136 $valid = isset( $logActions[$logAction] ) ||
isset( $logActions[$type . '/*'] );
140 $encParamName = $this->encodeParamName( 'action' );
142 [ 'apierror-unrecognizedvalue', $encParamName, wfEscapeWikiText( $logAction ) ],
143 "unknown_$encParamName"
147 $this->addWhereFld( 'log_type', $type );
148 $this->addWhereFld( 'log_action', $action );
149 } elseif ( !is_null( $params['type'] ) ) {
150 $this->addWhereFld( 'log_type', $params['type'] );
153 $this->addTimestampWhereRange(
159 // Include in ORDER BY for uniqueness
160 $this->addWhereRange( 'log_id', $params['dir'], null, null );
162 if ( !is_null( $params['continue'] ) ) {
163 $cont = explode( '|', $params['continue'] );
164 $this->dieContinueUsageIf( count( $cont ) != 2 );
165 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
166 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
167 $continueId = (int)$cont[1];
168 $this->dieContinueUsageIf( $continueId != $cont[1] );
169 $this->addWhere( "log_timestamp $op $continueTimestamp OR " .
170 "(log_timestamp = $continueTimestamp AND " .
171 "log_id $op= $continueId)"
175 $limit = $params['limit'];
176 $this->addOption( 'LIMIT', $limit +
1 );
178 $user = $params['user'];
179 if ( !is_null( $user ) ) {
180 // Note the joins in $q are the same as those from ->getJoin() above
181 // so we only need to add 'conds' here.
182 $q = $actorMigration->getWhere(
183 $db, 'log_user', User
::newFromName( $params['user'], false )
185 $this->addWhere( $q['conds'] );
187 // T71222: MariaDB's optimizer, at least 10.1.37 and .38, likes to choose a wildly bad plan for
188 // some reason for this code path. Tell it not to use the wrong index it wants to pick.
189 $this->addOption( 'IGNORE INDEX', [ 'logging' => [ 'times' ] ] );
192 $title = $params['title'];
193 if ( !is_null( $title ) ) {
194 $titleObj = Title
::newFromText( $title );
195 if ( is_null( $titleObj ) ) {
196 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $title ) ] );
198 $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
199 $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
202 if ( $params['namespace'] !== null ) {
203 $this->addWhereFld( 'log_namespace', $params['namespace'] );
206 $prefix = $params['prefix'];
208 if ( !is_null( $prefix ) ) {
209 if ( $this->getConfig()->get( 'MiserMode' ) ) {
210 $this->dieWithError( 'apierror-prefixsearchdisabled' );
213 $title = Title
::newFromText( $prefix );
214 if ( is_null( $title ) ) {
215 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $prefix ) ] );
217 $this->addWhereFld( 'log_namespace', $title->getNamespace() );
218 $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
221 // Paranoia: avoid brute force searches (T19342)
222 if ( $params['namespace'] !== null ||
!is_null( $title ) ||
!is_null( $user ) ) {
223 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
224 $titleBits = LogPage
::DELETED_ACTION
;
225 $userBits = LogPage
::DELETED_USER
;
226 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
227 $titleBits = LogPage
::DELETED_ACTION | LogPage
::DELETED_RESTRICTED
;
228 $userBits = LogPage
::DELETED_USER | LogPage
::DELETED_RESTRICTED
;
233 if ( ( $params['namespace'] !== null ||
!is_null( $title ) ) && $titleBits ) {
234 $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
236 if ( !is_null( $user ) && $userBits ) {
237 $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
241 // T220999: MySQL/MariaDB (10.1.37) can sometimes irrationally decide that querying `actor` before
242 // `logging` and filesorting is somehow better than querying $limit+1 rows from `logging`.
243 // Tell it not to reorder the query. But not when `letag` was used, as it seems as likely
244 // to be harmed as helped in that case.
245 if ( $params['tag'] === null ) {
246 $this->addOption( 'STRAIGHT_JOIN' );
250 $res = $this->select( __METHOD__
);
251 $result = $this->getResult();
252 foreach ( $res as $row ) {
253 if ( ++
$count > $limit ) {
254 // We've reached the one extra which shows that there are
255 // additional pages to be had. Stop here...
256 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
260 $vals = $this->extractRowInfo( $row );
261 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
263 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
267 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'item' );
270 private function extractRowInfo( $row ) {
271 $logEntry = DatabaseLogEntry
::newFromRow( $row );
273 ApiResult
::META_TYPE
=> 'assoc',
276 $user = $this->getUser();
278 if ( $this->fld_ids
) {
279 $vals['logid'] = (int)$row->log_id
;
282 if ( $this->fld_title ||
$this->fld_parsedcomment
) {
283 $title = Title
::makeTitle( $row->log_namespace
, $row->log_title
);
286 if ( $this->fld_title ||
$this->fld_ids ||
$this->fld_details
&& $row->log_params
!== '' ) {
287 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_ACTION
) ) {
288 $vals['actionhidden'] = true;
291 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_ACTION
, $user ) ) {
292 if ( $this->fld_title
) {
293 ApiQueryBase
::addTitleInfo( $vals, $title );
295 if ( $this->fld_ids
) {
296 $vals['pageid'] = (int)$row->page_id
;
297 $vals['logpage'] = (int)$row->log_page
;
299 if ( $this->fld_details
) {
300 $vals['params'] = LogFormatter
::newFromEntry( $logEntry )->formatParametersForApi();
305 if ( $this->fld_type
) {
306 $vals['type'] = $row->log_type
;
307 $vals['action'] = $row->log_action
;
310 if ( $this->fld_user ||
$this->fld_userid
) {
311 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_USER
) ) {
312 $vals['userhidden'] = true;
315 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_USER
, $user ) ) {
316 if ( $this->fld_user
) {
317 $vals['user'] = $row->user_name ??
$row->log_user_text
;
319 if ( $this->fld_userid
) {
320 $vals['userid'] = (int)$row->log_user
;
323 if ( !$row->log_user
) {
324 $vals['anon'] = true;
328 if ( $this->fld_timestamp
) {
329 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->log_timestamp
);
332 if ( $this->fld_comment ||
$this->fld_parsedcomment
) {
333 if ( LogEventsList
::isDeleted( $row, LogPage
::DELETED_COMMENT
) ) {
334 $vals['commenthidden'] = true;
337 if ( LogEventsList
::userCan( $row, LogPage
::DELETED_COMMENT
, $user ) ) {
338 $comment = $this->commentStore
->getComment( 'log_comment', $row )->text
;
339 if ( $this->fld_comment
) {
340 $vals['comment'] = $comment;
343 if ( $this->fld_parsedcomment
) {
344 $vals['parsedcomment'] = Linker
::formatComment( $comment, $title );
349 if ( $this->fld_tags
) {
350 if ( $row->ts_tags
) {
351 $tags = explode( ',', $row->ts_tags
);
352 ApiResult
::setIndexedTagName( $tags, 'tag' );
353 $vals['tags'] = $tags;
359 if ( $anyHidden && LogEventsList
::isDeleted( $row, LogPage
::DELETED_RESTRICTED
) ) {
360 $vals['suppressed'] = true;
369 private function getAllowedLogActions() {
370 $config = $this->getConfig();
371 return array_keys( array_merge(
372 $config->get( 'LogActions' ),
373 $config->get( 'LogActionsHandlers' )
377 public function getCacheMode( $params ) {
378 if ( $this->userCanSeeRevDel() ) {
381 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
382 // formatComment() calls wfMessage() among other things
383 return 'anon-public-user-private';
384 } elseif ( LogEventsList
::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
385 === LogEventsList
::getExcludeClause( $this->getDB(), 'public' )
386 ) { // Output can only contain public data.
389 return 'anon-public-user-private';
393 public function getAllowedParams( $flags = 0 ) {
394 $config = $this->getConfig();
395 if ( $flags & ApiBase
::GET_VALUES_FOR_HELP
) {
396 $logActions = $this->getAllowedLogActions();
403 ApiBase
::PARAM_ISMULTI
=> true,
404 ApiBase
::PARAM_DFLT
=> 'ids|title|type|user|timestamp|comment|details',
405 ApiBase
::PARAM_TYPE
=> [
417 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
420 ApiBase
::PARAM_TYPE
=> LogPage
::validTypes(),
423 // validation on request is done in execute()
424 ApiBase
::PARAM_TYPE
=> $logActions
427 ApiBase
::PARAM_TYPE
=> 'timestamp'
430 ApiBase
::PARAM_TYPE
=> 'timestamp'
433 ApiBase
::PARAM_DFLT
=> 'older',
434 ApiBase
::PARAM_TYPE
=> [
438 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
441 ApiBase
::PARAM_TYPE
=> 'user',
445 ApiBase
::PARAM_TYPE
=> 'namespace',
446 ApiBase
::PARAM_EXTRA_NAMESPACES
=> [ NS_MEDIA
, NS_SPECIAL
],
451 ApiBase
::PARAM_DFLT
=> 10,
452 ApiBase
::PARAM_TYPE
=> 'limit',
453 ApiBase
::PARAM_MIN
=> 1,
454 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
455 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
458 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
462 if ( $config->get( 'MiserMode' ) ) {
463 $ret['prefix'][ApiBase
::PARAM_HELP_MSG
] = 'api-help-param-disabled-in-miser-mode';
469 protected function getExamplesMessages() {
471 'action=query&list=logevents'
472 => 'apihelp-query+logevents-example-simple',
476 public function getHelpUrls() {
477 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logevents';