Merge "Add hook for custom difference engine (WikEdDiff)"
[lhc/web/wiklou.git] / includes / api / ApiQueryLogEvents.php
1 <?php
2 /**
3 *
4 *
5 * Created on Oct 16, 2006
6 *
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
8 *
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.
13 *
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.
18 *
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
23 *
24 * @file
25 */
26
27 /**
28 * Query action to List the log events, with optional filtering by various parameters.
29 *
30 * @ingroup API
31 */
32 class ApiQueryLogEvents extends ApiQueryBase {
33
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'le' );
36 }
37
38 private $fld_ids = false, $fld_title = false, $fld_type = false,
39 $fld_user = false, $fld_userid = false,
40 $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
41 $fld_details = false, $fld_tags = false;
42
43 public function execute() {
44 $params = $this->extractRequestParams();
45 $db = $this->getDB();
46 $this->requireMaxOneParameter( $params, 'title', 'prefix', 'namespace' );
47
48 $prop = array_flip( $params['prop'] );
49
50 $this->fld_ids = isset( $prop['ids'] );
51 $this->fld_title = isset( $prop['title'] );
52 $this->fld_type = isset( $prop['type'] );
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'] );
60
61 $hideLogs = LogEventsList::getExcludeClause( $db, 'user', $this->getUser() );
62 if ( $hideLogs !== false ) {
63 $this->addWhere( $hideLogs );
64 }
65
66 // Order is significant here
67 $this->addTables( array( 'logging', 'user', 'page' ) );
68 $this->addJoinConds( array(
69 'user' => array( 'LEFT JOIN',
70 'user_id=log_user' ),
71 'page' => array( 'LEFT JOIN',
72 array( 'log_namespace=page_namespace',
73 'log_title=page_title' ) ) ) );
74
75 $this->addFields( array(
76 'log_id',
77 'log_type',
78 'log_action',
79 'log_timestamp',
80 'log_deleted',
81 ) );
82
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 );
90 $this->addFieldsIf(
91 array( 'log_namespace', 'log_title' ),
92 $this->fld_title || $this->fld_parsedcomment
93 );
94 $this->addFieldsIf( 'log_comment', $this->fld_comment || $this->fld_parsedcomment );
95 $this->addFieldsIf( 'log_params', $this->fld_details );
96
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' );
101 }
102
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'] );
108 }
109
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
116 $valid = false;
117 } else {
118 $logActions = array_flip( $this->getAllowedLogActions() );
119 list( $type, $action ) = explode( '/', $logAction, 2 );
120 $valid = isset( $logActions[$logAction] ) || isset( $logActions[$type . '/*'] );
121 }
122
123 if ( !$valid ) {
124 $valueName = $this->encodeParamName( 'action' );
125 $this->dieUsage(
126 "Unrecognized value for parameter '$valueName': {$logAction}",
127 "unknown_$valueName"
128 );
129 }
130
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'] );
135 }
136
137 $this->addTimestampWhereRange(
138 'log_timestamp',
139 $params['dir'],
140 $params['start'],
141 $params['end']
142 );
143 // Include in ORDER BY for uniqueness
144 $this->addWhereRange( 'log_id', $params['dir'], null, null );
145
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)"
156 );
157 }
158
159 $limit = $params['limit'];
160 $this->addOption( 'LIMIT', $limit + 1 );
161
162 $user = $params['user'];
163 if ( !is_null( $user ) ) {
164 $userid = User::idFromName( $user );
165 if ( $userid ) {
166 $this->addWhereFld( 'log_user', $userid );
167 } else {
168 $this->addWhereFld( 'log_user_text', IP::sanitizeIP( $user ) );
169 }
170 }
171
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' );
177 }
178 $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
179 $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
180 }
181
182 if ( $params['namespace'] !== null ) {
183 $this->addWhereFld( 'log_namespace', $params['namespace'] );
184 }
185
186 $prefix = $params['prefix'];
187
188 if ( !is_null( $prefix ) ) {
189 if ( $this->getConfig()->get( 'MiserMode' ) ) {
190 $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
191 }
192
193 $title = Title::newFromText( $prefix );
194 if ( is_null( $title ) ) {
195 $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
196 }
197 $this->addWhereFld( 'log_namespace', $title->getNamespace() );
198 $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
199 }
200
201 // Paranoia: avoid brute force searches (bug 17342)
202 if ( $params['namespace'] !== null || !is_null( $title ) || !is_null( $user ) ) {
203 if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
204 $titleBits = LogPage::DELETED_ACTION;
205 $userBits = LogPage::DELETED_USER;
206 } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
207 $titleBits = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
208 $userBits = LogPage::DELETED_USER | LogPage::DELETED_RESTRICTED;
209 } else {
210 $titleBits = 0;
211 $userBits = 0;
212 }
213 if ( ( $params['namespace'] !== null || !is_null( $title ) ) && $titleBits ) {
214 $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
215 }
216 if ( !is_null( $user ) && $userBits ) {
217 $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
218 }
219 }
220
221 $count = 0;
222 $res = $this->select( __METHOD__ );
223 $result = $this->getResult();
224 foreach ( $res as $row ) {
225 if ( ++$count > $limit ) {
226 // We've reached the one extra which shows that there are
227 // additional pages to be had. Stop here...
228 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
229 break;
230 }
231
232 $vals = $this->extractRowInfo( $row );
233 if ( !$vals ) {
234 continue;
235 }
236 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
237 if ( !$fit ) {
238 $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
239 break;
240 }
241 }
242 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
243 }
244
245 /**
246 * @param ApiResult $result
247 * @param array $vals
248 * @param string $params
249 * @param string $type
250 * @param string $action
251 * @param string $ts
252 * @param bool $legacy
253 * @return array
254 */
255 public static function addLogParams( $result, &$vals, $params, $type,
256 $action, $ts, $legacy = false
257 ) {
258 switch ( $type ) {
259 case 'move':
260 if ( $legacy ) {
261 $targetKey = 0;
262 $noredirKey = 1;
263 } else {
264 $targetKey = '4::target';
265 $noredirKey = '5::noredir';
266 }
267
268 if ( isset( $params[$targetKey] ) ) {
269 $title = Title::newFromText( $params[$targetKey] );
270 if ( $title ) {
271 $vals2 = array();
272 ApiQueryBase::addTitleInfo( $vals2, $title, 'new_' );
273 $vals[$type] = $vals2;
274 }
275 }
276 if ( isset( $params[$noredirKey] ) && $params[$noredirKey] ) {
277 $vals[$type]['suppressedredirect'] = '';
278 }
279 $params = null;
280 break;
281 case 'patrol':
282 if ( $legacy ) {
283 $cur = 0;
284 $prev = 1;
285 $auto = 2;
286 } else {
287 $cur = '4::curid';
288 $prev = '5::previd';
289 $auto = '6::auto';
290 }
291 $vals2 = array();
292 $vals2['cur'] = $params[$cur];
293 $vals2['prev'] = $params[$prev];
294 $vals2['auto'] = $params[$auto];
295 $vals[$type] = $vals2;
296 $params = null;
297 break;
298 case 'rights':
299 $vals2 = array();
300 if ( $legacy ) {
301 list( $vals2['old'], $vals2['new'] ) = $params;
302 } else {
303 $vals2['new'] = implode( ', ', $params['5::newgroups'] );
304 $vals2['old'] = implode( ', ', $params['4::oldgroups'] );
305 }
306 $vals[$type] = $vals2;
307 $params = null;
308 break;
309 case 'block':
310 if ( $action == 'unblock' ) {
311 break;
312 }
313 $vals2 = array();
314 $vals2['duration'] = $params[0];
315 $vals2['flags'] = isset( $params[1] ) ? $params[1] : '';
316
317 // Indefinite blocks have no expiry time
318 if ( SpecialBlock::parseExpiryInput( $params[0] ) !== wfGetDB( DB_SLAVE )->getInfinity() ) {
319 $vals2['expiry'] = wfTimestamp( TS_ISO_8601,
320 strtotime( $params[0], wfTimestamp( TS_UNIX, $ts ) ) );
321 }
322 $vals[$type] = $vals2;
323 $params = null;
324 break;
325 case 'upload':
326 if ( isset( $params['img_timestamp'] ) ) {
327 $params['img_timestamp'] = wfTimestamp( TS_ISO_8601, $params['img_timestamp'] );
328 }
329 break;
330 case 'merge':
331 // replace the named parameter with numbered for backward compatibility
332 if ( isset( $params['4::dest'] ) ) {
333 $params[] = $params['4::dest'];
334 unset( $params['4::dest'] );
335 }
336 if ( isset( $params['5::mergepoint'] ) ) {
337 $params[] = $params['5::mergepoint'];
338 unset( $params['5::mergepoint'] );
339 }
340 break;
341 case 'delete':
342 if ( $action === 'event' || $action === 'revision' ) {
343 // replace the named parameter with numbered for backward compatibility
344 if ( $action === 'event' ) {
345 $idsKey = '4::ids';
346 $ofieldKey = '5::ofield';
347 $nfieldKey = '6::nfield';
348 } else {
349 if ( isset( $params['4::type'] ) ) {
350 $params[] = $params['4::type'];
351 unset( $params['4::type'] );
352 }
353 $idsKey = '5::ids';
354 $ofieldKey = '6::ofield';
355 $nfieldKey = '7::nfield';
356 }
357 if ( isset( $params[$idsKey] ) ) {
358 $params[] = implode( ',', $params[$idsKey] );
359 unset( $params[$idsKey] );
360 }
361 if ( isset( $params[$ofieldKey] ) ) {
362 $params[] = $params[$ofieldKey];
363 unset( $params[$ofieldKey] );
364 }
365 if ( isset( $params[$nfieldKey] ) ) {
366 $params[] = $params[$nfieldKey];
367 unset( $params[$nfieldKey] );
368 }
369 }
370 break;
371 }
372 if ( !is_null( $params ) ) {
373 $logParams = array();
374 // Keys like "4::paramname" can't be used for output so we change them to "paramname"
375 foreach ( $params as $key => $value ) {
376 if ( strpos( $key, ':' ) === false ) {
377 $logParams[$key] = $value;
378 continue;
379 }
380 $logParam = explode( ':', $key, 3 );
381 $logParams[$logParam[2]] = $value;
382 }
383 $result->setIndexedTagName( $logParams, 'param' );
384 $result->setIndexedTagName_recursive( $logParams, 'param' );
385 $vals = array_merge( $vals, $logParams );
386 }
387
388 return $vals;
389 }
390
391 private function extractRowInfo( $row ) {
392 $logEntry = DatabaseLogEntry::newFromRow( $row );
393 $vals = array();
394 $anyHidden = false;
395 $user = $this->getUser();
396
397 if ( $this->fld_ids ) {
398 $vals['logid'] = intval( $row->log_id );
399 }
400
401 if ( $this->fld_title || $this->fld_parsedcomment ) {
402 $title = Title::makeTitle( $row->log_namespace, $row->log_title );
403 }
404
405 if ( $this->fld_title || $this->fld_ids || $this->fld_details && $row->log_params !== '' ) {
406 if ( LogEventsList::isDeleted( $row, LogPage::DELETED_ACTION ) ) {
407 $vals['actionhidden'] = '';
408 $anyHidden = true;
409 }
410 if ( LogEventsList::userCan( $row, LogPage::DELETED_ACTION, $user ) ) {
411 if ( $this->fld_title ) {
412 ApiQueryBase::addTitleInfo( $vals, $title );
413 }
414 if ( $this->fld_ids ) {
415 $vals['pageid'] = intval( $row->page_id );
416 $vals['logpage'] = intval( $row->log_page );
417 }
418 if ( $this->fld_details && $row->log_params !== '' ) {
419 self::addLogParams(
420 $this->getResult(),
421 $vals,
422 $logEntry->getParameters(),
423 $logEntry->getType(),
424 $logEntry->getSubtype(),
425 $logEntry->getTimestamp(),
426 $logEntry->isLegacy()
427 );
428 }
429 }
430 }
431
432 if ( $this->fld_type ) {
433 $vals['type'] = $row->log_type;
434 $vals['action'] = $row->log_action;
435 }
436
437 if ( $this->fld_user || $this->fld_userid ) {
438 if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
439 $vals['userhidden'] = '';
440 $anyHidden = true;
441 }
442 if ( LogEventsList::userCan( $row, LogPage::DELETED_USER, $user ) ) {
443 if ( $this->fld_user ) {
444 $vals['user'] = $row->user_name === null ? $row->log_user_text : $row->user_name;
445 }
446 if ( $this->fld_userid ) {
447 $vals['userid'] = intval( $row->log_user );
448 }
449
450 if ( !$row->log_user ) {
451 $vals['anon'] = '';
452 }
453 }
454 }
455 if ( $this->fld_timestamp ) {
456 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->log_timestamp );
457 }
458
459 if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->log_comment ) ) {
460 if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
461 $vals['commenthidden'] = '';
462 $anyHidden = true;
463 }
464 if ( LogEventsList::userCan( $row, LogPage::DELETED_COMMENT, $user ) ) {
465 if ( $this->fld_comment ) {
466 $vals['comment'] = $row->log_comment;
467 }
468
469 if ( $this->fld_parsedcomment ) {
470 $vals['parsedcomment'] = Linker::formatComment( $row->log_comment, $title );
471 }
472 }
473 }
474
475 if ( $this->fld_tags ) {
476 if ( $row->ts_tags ) {
477 $tags = explode( ',', $row->ts_tags );
478 $this->getResult()->setIndexedTagName( $tags, 'tag' );
479 $vals['tags'] = $tags;
480 } else {
481 $vals['tags'] = array();
482 }
483 }
484
485 if ( $anyHidden && LogEventsList::isDeleted( $row, LogPage::DELETED_RESTRICTED ) ) {
486 $vals['suppressed'] = '';
487 }
488
489 return $vals;
490 }
491
492 /**
493 * @return array
494 */
495 private function getAllowedLogActions() {
496 $config = $this->getConfig();
497 return array_keys( array_merge( $config->get( 'LogActions' ), $config->get( 'LogActionsHandlers' ) ) );
498 }
499
500 public function getCacheMode( $params ) {
501 if ( $this->userCanSeeRevDel() ) {
502 return 'private';
503 }
504 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
505 // formatComment() calls wfMessage() among other things
506 return 'anon-public-user-private';
507 } elseif ( LogEventsList::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
508 === LogEventsList::getExcludeClause( $this->getDB(), 'public' )
509 ) { // Output can only contain public data.
510 return 'public';
511 } else {
512 return 'anon-public-user-private';
513 }
514 }
515
516 public function getAllowedParams( $flags = 0 ) {
517 $config = $this->getConfig();
518 $ret = array(
519 'prop' => array(
520 ApiBase::PARAM_ISMULTI => true,
521 ApiBase::PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
522 ApiBase::PARAM_TYPE => array(
523 'ids',
524 'title',
525 'type',
526 'user',
527 'userid',
528 'timestamp',
529 'comment',
530 'parsedcomment',
531 'details',
532 'tags'
533 )
534 ),
535 'type' => array(
536 ApiBase::PARAM_TYPE => $config->get( 'LogTypes' )
537 ),
538 'action' => array(
539 // validation on request is done in execute()
540 ApiBase::PARAM_TYPE => ( $flags & ApiBase::GET_VALUES_FOR_HELP )
541 ? $this->getAllowedLogActions()
542 : null
543 ),
544 'start' => array(
545 ApiBase::PARAM_TYPE => 'timestamp'
546 ),
547 'end' => array(
548 ApiBase::PARAM_TYPE => 'timestamp'
549 ),
550 'dir' => array(
551 ApiBase::PARAM_DFLT => 'older',
552 ApiBase::PARAM_TYPE => array(
553 'newer',
554 'older'
555 ),
556 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
557 ),
558 'user' => null,
559 'title' => null,
560 'namespace' => array(
561 ApiBase::PARAM_TYPE => 'namespace'
562 ),
563 'prefix' => array(),
564 'tag' => null,
565 'limit' => array(
566 ApiBase::PARAM_DFLT => 10,
567 ApiBase::PARAM_TYPE => 'limit',
568 ApiBase::PARAM_MIN => 1,
569 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
570 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
571 ),
572 'continue' => array(
573 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
574 ),
575 );
576
577 if ( $config->get( 'MiserMode' ) ) {
578 $ret['prefix'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
579 }
580
581 return $ret;
582 }
583
584 protected function getExamplesMessages() {
585 return array(
586 'action=query&list=logevents'
587 => 'apihelp-query+logevents-example-simple',
588 );
589 }
590
591 public function getHelpUrls() {
592 return 'https://www.mediawiki.org/wiki/API:Logevents';
593 }
594 }