MediaWiki REL1_30
ApiQueryRecentChanges.php
Go to the documentation of this file.
1<?php
34
35 public function __construct( ApiQuery $query, $moduleName ) {
36 parent::__construct( $query, $moduleName, 'rc' );
37 }
38
40
41 private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
42 $fld_flags = false, $fld_timestamp = false, $fld_title = false, $fld_ids = false,
43 $fld_sizes = false, $fld_redirect = false, $fld_patrolled = false, $fld_loginfo = false,
44 $fld_tags = false, $fld_sha1 = false, $token = [];
45
47
55 protected function getTokenFunctions() {
56 // Don't call the hooks twice
57 if ( isset( $this->tokenFunctions ) ) {
59 }
60
61 // If we're in a mode that breaks the same-origin policy, no tokens can
62 // be obtained
63 if ( $this->lacksSameOriginSecurity() ) {
64 return [];
65 }
66
67 $this->tokenFunctions = [
68 'patrol' => [ 'ApiQueryRecentChanges', 'getPatrolToken' ]
69 ];
70 Hooks::run( 'APIQueryRecentChangesTokens', [ &$this->tokenFunctions ] );
71
73 }
74
82 public static function getPatrolToken( $pageid, $title, $rc = null ) {
84
85 $validTokenUser = false;
86
87 if ( $rc ) {
88 if ( ( $wgUser->useRCPatrol() && $rc->getAttribute( 'rc_type' ) == RC_EDIT ) ||
89 ( $wgUser->useNPPatrol() && $rc->getAttribute( 'rc_type' ) == RC_NEW )
90 ) {
91 $validTokenUser = true;
92 }
93 } elseif ( $wgUser->useRCPatrol() || $wgUser->useNPPatrol() ) {
94 $validTokenUser = true;
95 }
96
97 if ( $validTokenUser ) {
98 // The patrol token is always the same, let's exploit that
99 static $cachedPatrolToken = null;
100
101 if ( is_null( $cachedPatrolToken ) ) {
102 $cachedPatrolToken = $wgUser->getEditToken( 'patrol' );
103 }
104
105 return $cachedPatrolToken;
106 }
107
108 return false;
109 }
110
115 public function initProperties( $prop ) {
116 $this->fld_comment = isset( $prop['comment'] );
117 $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
118 $this->fld_user = isset( $prop['user'] );
119 $this->fld_userid = isset( $prop['userid'] );
120 $this->fld_flags = isset( $prop['flags'] );
121 $this->fld_timestamp = isset( $prop['timestamp'] );
122 $this->fld_title = isset( $prop['title'] );
123 $this->fld_ids = isset( $prop['ids'] );
124 $this->fld_sizes = isset( $prop['sizes'] );
125 $this->fld_redirect = isset( $prop['redirect'] );
126 $this->fld_patrolled = isset( $prop['patrolled'] );
127 $this->fld_loginfo = isset( $prop['loginfo'] );
128 $this->fld_tags = isset( $prop['tags'] );
129 $this->fld_sha1 = isset( $prop['sha1'] );
130 }
131
132 public function execute() {
133 $this->run();
134 }
135
136 public function executeGenerator( $resultPageSet ) {
137 $this->run( $resultPageSet );
138 }
139
145 public function run( $resultPageSet = null ) {
146 $user = $this->getUser();
147 /* Get the parameters of the request. */
148 $params = $this->extractRequestParams();
149
150 /* Build our basic query. Namely, something along the lines of:
151 * SELECT * FROM recentchanges WHERE rc_timestamp > $start
152 * AND rc_timestamp < $end AND rc_namespace = $namespace
153 */
154 $this->addTables( 'recentchanges' );
155 $this->addTimestampWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
156
157 if ( !is_null( $params['continue'] ) ) {
158 $cont = explode( '|', $params['continue'] );
159 $this->dieContinueUsageIf( count( $cont ) != 2 );
160 $db = $this->getDB();
161 $timestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
162 $id = intval( $cont[1] );
163 $this->dieContinueUsageIf( $id != $cont[1] );
164 $op = $params['dir'] === 'older' ? '<' : '>';
165 $this->addWhere(
166 "rc_timestamp $op $timestamp OR " .
167 "(rc_timestamp = $timestamp AND " .
168 "rc_id $op= $id)"
169 );
170 }
171
172 $order = $params['dir'] === 'older' ? 'DESC' : 'ASC';
173 $this->addOption( 'ORDER BY', [
174 "rc_timestamp $order",
175 "rc_id $order",
176 ] );
177
178 $this->addWhereFld( 'rc_namespace', $params['namespace'] );
179
180 if ( !is_null( $params['type'] ) ) {
181 try {
182 $this->addWhereFld( 'rc_type', RecentChange::parseToRCType( $params['type'] ) );
183 } catch ( Exception $e ) {
184 ApiBase::dieDebug( __METHOD__, $e->getMessage() );
185 }
186 }
187
188 if ( !is_null( $params['show'] ) ) {
189 $show = array_flip( $params['show'] );
190
191 /* Check for conflicting parameters. */
192 if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
193 || ( isset( $show['bot'] ) && isset( $show['!bot'] ) )
194 || ( isset( $show['anon'] ) && isset( $show['!anon'] ) )
195 || ( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
196 || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
197 || ( isset( $show['patrolled'] ) && isset( $show['unpatrolled'] ) )
198 || ( isset( $show['!patrolled'] ) && isset( $show['unpatrolled'] ) )
199 ) {
200 $this->dieWithError( 'apierror-show' );
201 }
202
203 // Check permissions
204 if ( $this->includesPatrollingFlags( $show ) ) {
205 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
206 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
207 }
208 }
209
210 /* Add additional conditions to query depending upon parameters. */
211 $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
212 $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
213 $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
214 $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
215 $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
216 $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
217 $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
218 $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
219 $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
220
221 if ( isset( $show['unpatrolled'] ) ) {
222 // See ChangesList::isUnpatrolled
223 if ( $user->useRCPatrol() ) {
224 $this->addWhere( 'rc_patrolled = 0' );
225 } elseif ( $user->useNPPatrol() ) {
226 $this->addWhere( 'rc_patrolled = 0' );
227 $this->addWhereFld( 'rc_type', RC_NEW );
228 }
229 }
230
231 // Don't throw log entries out the window here
232 $this->addWhereIf(
233 'page_is_redirect = 0 OR page_is_redirect IS NULL',
234 isset( $show['!redirect'] )
235 );
236 }
237
238 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
239
240 if ( !is_null( $params['user'] ) ) {
241 $this->addWhereFld( 'rc_user_text', $params['user'] );
242 }
243
244 if ( !is_null( $params['excludeuser'] ) ) {
245 // We don't use the rc_user_text index here because
246 // * it would require us to sort by rc_user_text before rc_timestamp
247 // * the != condition doesn't throw out too many rows anyway
248 $this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
249 }
250
251 /* Add the fields we're concerned with to our query. */
252 $this->addFields( [
253 'rc_id',
254 'rc_timestamp',
255 'rc_namespace',
256 'rc_title',
257 'rc_cur_id',
258 'rc_type',
259 'rc_deleted'
260 ] );
261
262 $showRedirects = false;
263 /* Determine what properties we need to display. */
264 if ( !is_null( $params['prop'] ) ) {
265 $prop = array_flip( $params['prop'] );
266
267 /* Set up internal members based upon params. */
268 $this->initProperties( $prop );
269
270 if ( $this->fld_patrolled && !$user->useRCPatrol() && !$user->useNPPatrol() ) {
271 $this->dieWithError( 'apierror-permissiondenied-patrolflag', 'permissiondenied' );
272 }
273
274 /* Add fields to our query if they are specified as a needed parameter. */
275 $this->addFieldsIf( [ 'rc_this_oldid', 'rc_last_oldid' ], $this->fld_ids );
276 $this->addFieldsIf( 'rc_user', $this->fld_user || $this->fld_userid );
277 $this->addFieldsIf( 'rc_user_text', $this->fld_user );
278 $this->addFieldsIf( [ 'rc_minor', 'rc_type', 'rc_bot' ], $this->fld_flags );
279 $this->addFieldsIf( [ 'rc_old_len', 'rc_new_len' ], $this->fld_sizes );
280 $this->addFieldsIf( [ 'rc_patrolled', 'rc_log_type' ], $this->fld_patrolled );
281 $this->addFieldsIf(
282 [ 'rc_logid', 'rc_log_type', 'rc_log_action', 'rc_params' ],
283 $this->fld_loginfo
284 );
285 $showRedirects = $this->fld_redirect || isset( $show['redirect'] )
286 || isset( $show['!redirect'] );
287 }
288 $this->addFieldsIf( [ 'rc_this_oldid' ],
289 $resultPageSet && $params['generaterevisions'] );
290
291 if ( $this->fld_tags ) {
292 $this->addTables( 'tag_summary' );
293 $this->addJoinConds( [ 'tag_summary' => [ 'LEFT JOIN', [ 'rc_id=ts_rc_id' ] ] ] );
294 $this->addFields( 'ts_tags' );
295 }
296
297 if ( $this->fld_sha1 ) {
298 $this->addTables( 'revision' );
299 $this->addJoinConds( [ 'revision' => [ 'LEFT JOIN',
300 [ 'rc_this_oldid=rev_id' ] ] ] );
301 $this->addFields( [ 'rev_sha1', 'rev_deleted' ] );
302 }
303
304 if ( $params['toponly'] || $showRedirects ) {
305 $this->addTables( 'page' );
306 $this->addJoinConds( [ 'page' => [ 'LEFT JOIN',
307 [ 'rc_namespace=page_namespace', 'rc_title=page_title' ] ] ] );
308 $this->addFields( 'page_is_redirect' );
309
310 if ( $params['toponly'] ) {
311 $this->addWhere( 'rc_this_oldid = page_latest' );
312 }
313 }
314
315 if ( !is_null( $params['tag'] ) ) {
316 $this->addTables( 'change_tag' );
317 $this->addJoinConds( [ 'change_tag' => [ 'INNER JOIN', [ 'rc_id=ct_rc_id' ] ] ] );
318 $this->addWhereFld( 'ct_tag', $params['tag'] );
319 }
320
321 // Paranoia: avoid brute force searches (T19342)
322 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
323 if ( !$user->isAllowed( 'deletedhistory' ) ) {
324 $bitmask = Revision::DELETED_USER;
325 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
327 } else {
328 $bitmask = 0;
329 }
330 if ( $bitmask ) {
331 $this->addWhere( $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask" );
332 }
333 }
334 if ( $this->getRequest()->getCheck( 'namespace' ) ) {
335 // LogPage::DELETED_ACTION hides the affected page, too.
336 if ( !$user->isAllowed( 'deletedhistory' ) ) {
337 $bitmask = LogPage::DELETED_ACTION;
338 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
340 } else {
341 $bitmask = 0;
342 }
343 if ( $bitmask ) {
344 $this->addWhere( $this->getDB()->makeList( [
345 'rc_type != ' . RC_LOG,
346 $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
347 ], LIST_OR ) );
348 }
349 }
350
351 $this->token = $params['token'];
352
353 if ( $this->fld_comment || $this->fld_parsedcomment || $this->token ) {
354 $this->commentStore = new CommentStore( 'rc_comment' );
355 $commentQuery = $this->commentStore->getJoin();
356 $this->addTables( $commentQuery['tables'] );
357 $this->addFields( $commentQuery['fields'] );
358 $this->addJoinConds( $commentQuery['joins'] );
359 }
360
361 $this->addOption( 'LIMIT', $params['limit'] + 1 );
362
363 $hookData = [];
364 $count = 0;
365 /* Perform the actual query. */
366 $res = $this->select( __METHOD__, [], $hookData );
367
368 $revids = [];
369 $titles = [];
370
371 $result = $this->getResult();
372
373 /* Iterate through the rows, adding data extracted from them to our query result. */
374 foreach ( $res as $row ) {
375 if ( $count === 0 && $resultPageSet !== null ) {
376 // Set the non-continue since the list of recentchanges is
377 // prone to having entries added at the start frequently.
378 $this->getContinuationManager()->addGeneratorNonContinueParam(
379 $this, 'continue', "$row->rc_timestamp|$row->rc_id"
380 );
381 }
382 if ( ++$count > $params['limit'] ) {
383 // We've reached the one extra which shows that there are
384 // additional pages to be had. Stop here...
385 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
386 break;
387 }
388
389 if ( is_null( $resultPageSet ) ) {
390 /* Extract the data from a single row. */
391 $vals = $this->extractRowInfo( $row );
392
393 /* Add that row's data to our final output. */
394 $fit = $this->processRow( $row, $vals, $hookData ) &&
395 $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
396 if ( !$fit ) {
397 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
398 break;
399 }
400 } elseif ( $params['generaterevisions'] ) {
401 $revid = (int)$row->rc_this_oldid;
402 if ( $revid > 0 ) {
403 $revids[] = $revid;
404 }
405 } else {
406 $titles[] = Title::makeTitle( $row->rc_namespace, $row->rc_title );
407 }
408 }
409
410 if ( is_null( $resultPageSet ) ) {
411 /* Format the result */
412 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'rc' );
413 } elseif ( $params['generaterevisions'] ) {
414 $resultPageSet->populateFromRevisionIDs( $revids );
415 } else {
416 $resultPageSet->populateFromTitles( $titles );
417 }
418 }
419
427 public function extractRowInfo( $row ) {
428 /* Determine the title of the page that has been changed. */
429 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
430 $user = $this->getUser();
431
432 /* Our output data. */
433 $vals = [];
434
435 $type = intval( $row->rc_type );
436 $vals['type'] = RecentChange::parseFromRCType( $type );
437
438 $anyHidden = false;
439
440 /* Create a new entry in the result for the title. */
441 if ( $this->fld_title || $this->fld_ids ) {
442 if ( $type === RC_LOG && ( $row->rc_deleted & LogPage::DELETED_ACTION ) ) {
443 $vals['actionhidden'] = true;
444 $anyHidden = true;
445 }
446 if ( $type !== RC_LOG ||
448 ) {
449 if ( $this->fld_title ) {
451 }
452 if ( $this->fld_ids ) {
453 $vals['pageid'] = intval( $row->rc_cur_id );
454 $vals['revid'] = intval( $row->rc_this_oldid );
455 $vals['old_revid'] = intval( $row->rc_last_oldid );
456 }
457 }
458 }
459
460 if ( $this->fld_ids ) {
461 $vals['rcid'] = intval( $row->rc_id );
462 }
463
464 /* Add user data and 'anon' flag, if user is anonymous. */
465 if ( $this->fld_user || $this->fld_userid ) {
466 if ( $row->rc_deleted & Revision::DELETED_USER ) {
467 $vals['userhidden'] = true;
468 $anyHidden = true;
469 }
470 if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_USER, $user ) ) {
471 if ( $this->fld_user ) {
472 $vals['user'] = $row->rc_user_text;
473 }
474
475 if ( $this->fld_userid ) {
476 $vals['userid'] = (int)$row->rc_user;
477 }
478
479 if ( !$row->rc_user ) {
480 $vals['anon'] = true;
481 }
482 }
483 }
484
485 /* Add flags, such as new, minor, bot. */
486 if ( $this->fld_flags ) {
487 $vals['bot'] = (bool)$row->rc_bot;
488 $vals['new'] = $row->rc_type == RC_NEW;
489 $vals['minor'] = (bool)$row->rc_minor;
490 }
491
492 /* Add sizes of each revision. (Only available on 1.10+) */
493 if ( $this->fld_sizes ) {
494 $vals['oldlen'] = intval( $row->rc_old_len );
495 $vals['newlen'] = intval( $row->rc_new_len );
496 }
497
498 /* Add the timestamp. */
499 if ( $this->fld_timestamp ) {
500 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
501 }
502
503 /* Add edit summary / log summary. */
504 if ( $this->fld_comment || $this->fld_parsedcomment ) {
505 if ( $row->rc_deleted & Revision::DELETED_COMMENT ) {
506 $vals['commenthidden'] = true;
507 $anyHidden = true;
508 }
509 if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_COMMENT, $user ) ) {
510 $comment = $this->commentStore->getComment( $row )->text;
511 if ( $this->fld_comment ) {
512 $vals['comment'] = $comment;
513 }
514
515 if ( $this->fld_parsedcomment ) {
516 $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
517 }
518 }
519 }
520
521 if ( $this->fld_redirect ) {
522 $vals['redirect'] = (bool)$row->page_is_redirect;
523 }
524
525 /* Add the patrolled flag */
526 if ( $this->fld_patrolled ) {
527 $vals['patrolled'] = $row->rc_patrolled == 1;
528 $vals['unpatrolled'] = ChangesList::isUnpatrolled( $row, $user );
529 }
530
531 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
532 if ( $row->rc_deleted & LogPage::DELETED_ACTION ) {
533 $vals['actionhidden'] = true;
534 $anyHidden = true;
535 }
537 $vals['logid'] = intval( $row->rc_logid );
538 $vals['logtype'] = $row->rc_log_type;
539 $vals['logaction'] = $row->rc_log_action;
540 $vals['logparams'] = LogFormatter::newFromRow( $row )->formatParametersForApi();
541 }
542 }
543
544 if ( $this->fld_tags ) {
545 if ( $row->ts_tags ) {
546 $tags = explode( ',', $row->ts_tags );
547 ApiResult::setIndexedTagName( $tags, 'tag' );
548 $vals['tags'] = $tags;
549 } else {
550 $vals['tags'] = [];
551 }
552 }
553
554 if ( $this->fld_sha1 && $row->rev_sha1 !== null ) {
555 if ( $row->rev_deleted & Revision::DELETED_TEXT ) {
556 $vals['sha1hidden'] = true;
557 $anyHidden = true;
558 }
559 if ( Revision::userCanBitfield( $row->rev_deleted, Revision::DELETED_TEXT, $user ) ) {
560 if ( $row->rev_sha1 !== '' ) {
561 $vals['sha1'] = Wikimedia\base_convert( $row->rev_sha1, 36, 16, 40 );
562 } else {
563 $vals['sha1'] = '';
564 }
565 }
566 }
567
568 if ( !is_null( $this->token ) ) {
570 foreach ( $this->token as $t ) {
571 $val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
573 if ( $val === false ) {
574 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
575 } else {
576 $vals[$t . 'token'] = $val;
577 }
578 }
579 }
580
581 if ( $anyHidden && ( $row->rc_deleted & Revision::DELETED_RESTRICTED ) ) {
582 $vals['suppressed'] = true;
583 }
584
585 return $vals;
586 }
587
592 private function includesPatrollingFlags( array $flagsArray ) {
593 return isset( $flagsArray['patrolled'] ) ||
594 isset( $flagsArray['!patrolled'] ) ||
595 isset( $flagsArray['unpatrolled'] ) ||
596 isset( $flagsArray['autopatrolled'] ) ||
597 isset( $flagsArray['!autopatrolled'] );
598 }
599
600 public function getCacheMode( $params ) {
601 if ( isset( $params['show'] ) &&
602 $this->includesPatrollingFlags( array_flip( $params['show'] ) )
603 ) {
604 return 'private';
605 }
606 if ( isset( $params['token'] ) ) {
607 return 'private';
608 }
609 if ( $this->userCanSeeRevDel() ) {
610 return 'private';
611 }
612 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
613 // formatComment() calls wfMessage() among other things
614 return 'anon-public-user-private';
615 }
616
617 return 'public';
618 }
619
620 public function getAllowedParams() {
621 return [
622 'start' => [
623 ApiBase::PARAM_TYPE => 'timestamp'
624 ],
625 'end' => [
626 ApiBase::PARAM_TYPE => 'timestamp'
627 ],
628 'dir' => [
629 ApiBase::PARAM_DFLT => 'older',
631 'newer',
632 'older'
633 ],
634 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
635 ],
636 'namespace' => [
638 ApiBase::PARAM_TYPE => 'namespace',
640 ],
641 'user' => [
642 ApiBase::PARAM_TYPE => 'user'
643 ],
644 'excludeuser' => [
645 ApiBase::PARAM_TYPE => 'user'
646 ],
647 'tag' => null,
648 'prop' => [
650 ApiBase::PARAM_DFLT => 'title|timestamp|ids',
652 'user',
653 'userid',
654 'comment',
655 'parsedcomment',
656 'flags',
657 'timestamp',
658 'title',
659 'ids',
660 'sizes',
661 'redirect',
662 'patrolled',
663 'loginfo',
664 'tags',
665 'sha1',
666 ],
668 ],
669 'token' => [
671 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
673 ],
674 'show' => [
677 'minor',
678 '!minor',
679 'bot',
680 '!bot',
681 'anon',
682 '!anon',
683 'redirect',
684 '!redirect',
685 'patrolled',
686 '!patrolled',
687 'unpatrolled'
688 ]
689 ],
690 'limit' => [
692 ApiBase::PARAM_TYPE => 'limit',
696 ],
697 'type' => [
698 ApiBase::PARAM_DFLT => 'edit|new|log|categorize',
701 ],
702 'toponly' => false,
703 'continue' => [
704 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
705 ],
706 'generaterevisions' => false,
707 ];
708 }
709
710 protected function getExamplesMessages() {
711 return [
712 'action=query&list=recentchanges'
713 => 'apihelp-query+recentchanges-example-simple',
714 'action=query&generator=recentchanges&grcshow=!patrolled&prop=info'
715 => 'apihelp-query+recentchanges-example-generator',
716 ];
717 }
718
719 public function getHelpUrls() {
720 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Recentchanges';
721 }
722}
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgUser
Definition Setup.php:817
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:100
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:109
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:94
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2026
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2038
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:160
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:103
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:225
getResult()
Get the result object.
Definition ApiBase.php:632
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:814
const PARAM_EXTRA_NAMESPACES
(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.
Definition ApiBase.php:189
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:128
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1779
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:227
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
getContinuationManager()
Get the continuation manager.
Definition ApiBase.php:672
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:55
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition ApiBase.php:560
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only)
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
addWhere( $value)
Add a set of WHERE clauses to the internal array.
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
A query action to enumerate the recent changes that were done to the wiki.
includesPatrollingFlags(array $flagsArray)
__construct(ApiQuery $query, $moduleName)
static getPatrolToken( $pageid, $title, $rc=null)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
initProperties( $prop)
Sets internal state to include the desired properties in the output.
getExamplesMessages()
Returns usage examples for this module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
executeGenerator( $resultPageSet)
Execute this module as a generator.
run( $resultPageSet=null)
Generates and outputs the result of this query based upon the provided parameters.
getHelpUrls()
Return links to more detailed help pages about the module.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
extractRowInfo( $row)
Extracts from a single sql row the data needed to describe one recent change.
getTokenFunctions()
Get an array mapping token names to their handler functions.
This is the main query class.
Definition ApiQuery.php:40
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static isUnpatrolled( $rc, User $user)
CommentStore handles storage of comments (edit summaries, log reasons, etc) in the database.
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition Linker.php:1099
static userCanBitfield( $bitfield, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row,...
static newFromRow( $row)
Handy shortcut for constructing a formatter directly from database row.
const DELETED_RESTRICTED
Definition LogPage.php:35
const DELETED_ACTION
Definition LogPage.php:32
static parseToRCType( $type)
Parsing text to RC_* constants.
static newFromRow( $row)
static getChangeTypes()
Get an array of all change types.
static parseFromRCType( $rcType)
Parsing RC_* constants to human-readable test.
const DELETED_USER
Definition Revision.php:92
const DELETED_TEXT
Definition Revision.php:90
const DELETED_RESTRICTED
Definition Revision.php:93
static userCanBitfield( $bitfield, $field, User $user=null, Title $title=null)
Determine if the current user is allowed to view a particular field of this revision,...
const DELETED_COMMENT
Definition Revision.php:91
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const RC_NEW
Definition Defines.php:144
const NS_SPECIAL
Definition Defines.php:54
const LIST_OR
Definition Defines.php:47
const RC_LOG
Definition Defines.php:145
const NS_MEDIA
Definition Defines.php:53
const RC_EDIT
Definition Defines.php:143
the array() calling protocol came about after MediaWiki 1.4rc1.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1963
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:1976
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
returning false will NOT prevent logging $e
Definition hooks.txt:2146
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
$params