MediaWiki REL1_32
MediaWiki.php
Go to the documentation of this file.
1<?php
24use Psr\Log\LoggerInterface;
29use Liuggio\StatsdClient\Sender\SocketSender;
30
34class MediaWiki {
38 private $context;
39
43 private $config;
44
48 private $action;
49
53 public function __construct( IContextSource $context = null ) {
54 if ( !$context ) {
55 $context = RequestContext::getMain();
56 }
57
58 $this->context = $context;
59 $this->config = $context->getConfig();
60 }
61
68 private function parseTitle() {
69 $request = $this->context->getRequest();
70 $curid = $request->getInt( 'curid' );
71 $title = $request->getVal( 'title' );
72 $action = $request->getVal( 'action' );
73
74 if ( $request->getCheck( 'search' ) ) {
75 // Compatibility with old search URLs which didn't use Special:Search
76 // Just check for presence here, so blank requests still
77 // show the search page when using ugly URLs (T10054).
78 $ret = SpecialPage::getTitleFor( 'Search' );
79 } elseif ( $curid ) {
80 // URLs like this are generated by RC, because rc_title isn't always accurate
81 $ret = Title::newFromID( $curid );
82 } else {
83 $ret = Title::newFromURL( $title );
84 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
85 // in wikitext links to tell Parser to make a direct file link
86 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
87 $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
88 }
89 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
90 // Check variant links so that interwiki links don't have to worry
91 // about the possible different language variants
92 if (
93 $contLang->hasVariants() && !is_null( $ret ) && $ret->getArticleID() == 0
94 ) {
95 $contLang->findVariantLink( $title, $ret );
96 }
97 }
98
99 // If title is not provided, always allow oldid and diff to set the title.
100 // If title is provided, allow oldid and diff to override the title, unless
101 // we are talking about a special page which might use these parameters for
102 // other purposes.
103 if ( $ret === null || !$ret->isSpecialPage() ) {
104 // We can have urls with just ?diff=,?oldid= or even just ?diff=
105 $oldid = $request->getInt( 'oldid' );
106 $oldid = $oldid ?: $request->getInt( 'diff' );
107 // Allow oldid to override a changed or missing title
108 if ( $oldid ) {
109 $rev = Revision::newFromId( $oldid );
110 $ret = $rev ? $rev->getTitle() : $ret;
111 }
112 }
113
114 // Use the main page as default title if nothing else has been provided
115 if ( $ret === null
116 && strval( $title ) === ''
117 && !$request->getCheck( 'curid' )
118 && $action !== 'delete'
119 ) {
120 $ret = Title::newMainPage();
121 }
122
123 if ( $ret === null || ( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
124 // If we get here, we definitely don't have a valid title; throw an exception.
125 // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
126 Title::newFromTextThrow( $title );
127 throw new MalformedTitleException( 'badtitletext', $title );
128 }
129
130 return $ret;
131 }
132
137 public function getTitle() {
138 if ( !$this->context->hasTitle() ) {
139 try {
140 $this->context->setTitle( $this->parseTitle() );
141 } catch ( MalformedTitleException $ex ) {
142 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
143 }
144 }
145 return $this->context->getTitle();
146 }
147
153 public function getAction() {
154 if ( $this->action === null ) {
155 $this->action = Action::getActionName( $this->context );
156 }
157
158 return $this->action;
159 }
160
173 private function performRequest() {
174 global $wgTitle;
175
176 $request = $this->context->getRequest();
177 $requestTitle = $title = $this->context->getTitle();
178 $output = $this->context->getOutput();
179 $user = $this->context->getUser();
180
181 if ( $request->getVal( 'printable' ) === 'yes' ) {
182 $output->setPrintable();
183 }
184
185 $unused = null; // To pass it by reference
186 Hooks::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
187
188 // Invalid titles. T23776: The interwikis must redirect even if the page name is empty.
189 if ( is_null( $title ) || ( $title->getDBkey() == '' && !$title->isExternal() )
190 || $title->isSpecial( 'Badtitle' )
191 ) {
192 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
193 try {
194 $this->parseTitle();
195 } catch ( MalformedTitleException $ex ) {
196 throw new BadTitleError( $ex );
197 }
198 throw new BadTitleError();
199 }
200
201 // Check user's permissions to read this page.
202 // We have to check here to catch special pages etc.
203 // We will check again in Article::view().
204 $permErrors = $title->isSpecial( 'RunJobs' )
205 ? [] // relies on HMAC key signature alone
206 : $title->getUserPermissionsErrors( 'read', $user );
207 if ( count( $permErrors ) ) {
208 // T34276: allowing the skin to generate output with $wgTitle or
209 // $this->context->title set to the input title would allow anonymous users to
210 // determine whether a page exists, potentially leaking private data. In fact, the
211 // curid and oldid request parameters would allow page titles to be enumerated even
212 // when they are not guessable. So we reset the title to Special:Badtitle before the
213 // permissions error is displayed.
214
215 // The skin mostly uses $this->context->getTitle() these days, but some extensions
216 // still use $wgTitle.
217 $badTitle = SpecialPage::getTitleFor( 'Badtitle' );
218 $this->context->setTitle( $badTitle );
219 $wgTitle = $badTitle;
220
221 throw new PermissionsError( 'read', $permErrors );
222 }
223
224 // Interwiki redirects
225 if ( $title->isExternal() ) {
226 $rdfrom = $request->getVal( 'rdfrom' );
227 if ( $rdfrom ) {
228 $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
229 } else {
230 $query = $request->getValues();
231 unset( $query['title'] );
232 $url = $title->getFullURL( $query );
233 }
234 // Check for a redirect loop
235 if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
236 && $title->isLocal()
237 ) {
238 // 301 so google et al report the target as the actual url.
239 $output->redirect( $url, 301 );
240 } else {
241 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
242 try {
243 $this->parseTitle();
244 } catch ( MalformedTitleException $ex ) {
245 throw new BadTitleError( $ex );
246 }
247 throw new BadTitleError();
248 }
249 // Handle any other redirects.
250 // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
251 } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
252 // Prevent information leak via Special:MyPage et al (T109724)
253 $spFactory = MediaWikiServices::getInstance()->getSpecialPageFactory();
254 if ( $title->isSpecialPage() ) {
255 $specialPage = $spFactory->getPage( $title->getDBkey() );
256 if ( $specialPage instanceof RedirectSpecialPage ) {
257 $specialPage->setContext( $this->context );
258 if ( $this->config->get( 'HideIdentifiableRedirects' )
259 && $specialPage->personallyIdentifiableTarget()
260 ) {
261 list( , $subpage ) = $spFactory->resolveAlias( $title->getDBkey() );
262 $target = $specialPage->getRedirect( $subpage );
263 // target can also be true. We let that case fall through to normal processing.
264 if ( $target instanceof Title ) {
265 $query = $specialPage->getRedirectQuery() ?: [];
266 $request = new DerivativeRequest( $this->context->getRequest(), $query );
267 $request->setRequestURL( $this->context->getRequest()->getRequestURL() );
268 $this->context->setRequest( $request );
269 // Do not varnish cache these. May vary even for anons
270 $this->context->getOutput()->lowerCdnMaxage( 0 );
271 $this->context->setTitle( $target );
272 $wgTitle = $target;
273 // Reset action type cache. (Special pages have only view)
274 $this->action = null;
275 $title = $target;
276 $output->addJsConfigVars( [
277 'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
278 ] );
279 $output->addModules( 'mediawiki.action.view.redirect' );
280 }
281 }
282 }
283 }
284
285 // Special pages ($title may have changed since if statement above)
286 if ( $title->isSpecialPage() ) {
287 // Actions that need to be made when we have a special pages
288 $spFactory->executePath( $title, $this->context );
289 } else {
290 // ...otherwise treat it as an article view. The article
291 // may still be a wikipage redirect to another article or URL.
292 $article = $this->initializeArticle();
293 if ( is_object( $article ) ) {
294 $this->performAction( $article, $requestTitle );
295 } elseif ( is_string( $article ) ) {
296 $output->redirect( $article );
297 } else {
298 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
299 . " returned neither an object nor a URL" );
300 }
301 }
302 }
303 }
304
327 private function tryNormaliseRedirect( Title $title ) {
328 $request = $this->context->getRequest();
329 $output = $this->context->getOutput();
330
331 if ( $request->getVal( 'action', 'view' ) != 'view'
332 || $request->wasPosted()
333 || ( $request->getVal( 'title' ) !== null
334 && $title->getPrefixedDBkey() == $request->getVal( 'title' ) )
335 || count( $request->getValueNames( [ 'action', 'title' ] ) )
336 || !Hooks::run( 'TestCanonicalRedirect', [ $request, $title, $output ] )
337 ) {
338 return false;
339 }
340
341 if ( $title->isSpecialPage() ) {
342 list( $name, $subpage ) = MediaWikiServices::getInstance()->getSpecialPageFactory()->
343 resolveAlias( $title->getDBkey() );
344 if ( $name ) {
345 $title = SpecialPage::getTitleFor( $name, $subpage );
346 }
347 }
348 // Redirect to canonical url, make it a 301 to allow caching
349 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
350 if ( $targetUrl == $request->getFullRequestURL() ) {
351 $message = "Redirect loop detected!\n\n" .
352 "This means the wiki got confused about what page was " .
353 "requested; this sometimes happens when moving a wiki " .
354 "to a new server or changing the server configuration.\n\n";
355
356 if ( $this->config->get( 'UsePathInfo' ) ) {
357 $message .= "The wiki is trying to interpret the page " .
358 "title from the URL path portion (PATH_INFO), which " .
359 "sometimes fails depending on the web server. Try " .
360 "setting \"\$wgUsePathInfo = false;\" in your " .
361 "LocalSettings.php, or check that \$wgArticlePath " .
362 "is correct.";
363 } else {
364 $message .= "Your web server was detected as possibly not " .
365 "supporting URL path components (PATH_INFO) correctly; " .
366 "check your LocalSettings.php for a customized " .
367 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
368 "to true.";
369 }
370 throw new HttpError( 500, $message );
371 }
372 $output->setCdnMaxage( 1200 );
373 $output->redirect( $targetUrl, '301' );
374 return true;
375 }
376
383 private function initializeArticle() {
384 $title = $this->context->getTitle();
385 if ( $this->context->canUseWikiPage() ) {
386 // Try to use request context wiki page, as there
387 // is already data from db saved in per process
388 // cache there from this->getAction() call.
389 $page = $this->context->getWikiPage();
390 } else {
391 // This case should not happen, but just in case.
392 // @TODO: remove this or use an exception
393 $page = WikiPage::factory( $title );
394 $this->context->setWikiPage( $page );
395 wfWarn( "RequestContext::canUseWikiPage() returned false" );
396 }
397
398 // Make GUI wrapper for the WikiPage
399 $article = Article::newFromWikiPage( $page, $this->context );
400
401 // Skip some unnecessary code if the content model doesn't support redirects
402 if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
403 return $article;
404 }
405
406 $request = $this->context->getRequest();
407
408 // Namespace might change when using redirects
409 // Check for redirects ...
410 $action = $request->getVal( 'action', 'view' );
411 $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
412 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
413 && !$request->getVal( 'oldid' ) // ... and are not old revisions
414 && !$request->getVal( 'diff' ) // ... and not when showing diff
415 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
416 // ... and the article is not a non-redirect image page with associated file
417 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
418 ) {
419 // Give extensions a change to ignore/handle redirects as needed
420 $ignoreRedirect = $target = false;
421
422 Hooks::run( 'InitializeArticleMaybeRedirect',
423 [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
424 $page = $article->getPage(); // reflect any hook changes
425
426 // Follow redirects only for... redirects.
427 // If $target is set, then a hook wanted to redirect.
428 if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
429 // Is the target already set by an extension?
430 $target = $target ?: $page->followRedirect();
431 if ( is_string( $target ) ) {
432 if ( !$this->config->get( 'DisableHardRedirects' ) ) {
433 // we'll need to redirect
434 return $target;
435 }
436 }
437 if ( is_object( $target ) ) {
438 // Rewrite environment to redirected article
439 $rpage = WikiPage::factory( $target );
440 $rpage->loadPageData();
441 if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
442 $rarticle = Article::newFromWikiPage( $rpage, $this->context );
443 $rarticle->setRedirectedFrom( $title );
444
445 $article = $rarticle;
446 $this->context->setTitle( $target );
447 $this->context->setWikiPage( $article->getPage() );
448 }
449 }
450 } else {
451 // Article may have been changed by hook
452 $this->context->setTitle( $article->getTitle() );
453 $this->context->setWikiPage( $article->getPage() );
454 }
455 }
456
457 return $article;
458 }
459
466 private function performAction( Page $page, Title $requestTitle ) {
467 $request = $this->context->getRequest();
468 $output = $this->context->getOutput();
469 $title = $this->context->getTitle();
470 $user = $this->context->getUser();
471
472 if ( !Hooks::run( 'MediaWikiPerformAction',
473 [ $output, $page, $title, $user, $request, $this ] )
474 ) {
475 return;
476 }
477
478 $act = $this->getAction();
479 $action = Action::factory( $act, $page, $this->context );
480
481 if ( $action instanceof Action ) {
482 // Narrow DB query expectations for this HTTP request
483 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
484 $trxProfiler = Profiler::instance()->getTransactionProfiler();
485 if ( $request->wasPosted() && !$action->doesWrites() ) {
486 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
487 $request->markAsSafeRequest();
488 }
489
490 # Let CDN cache things if we can purge them.
491 if ( $this->config->get( 'UseSquid' ) &&
492 in_array(
493 // Use PROTO_INTERNAL because that's what getCdnUrls() uses
494 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
495 $requestTitle->getCdnUrls()
496 )
497 ) {
498 $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
499 }
500
501 $action->show();
502 return;
503 }
504
505 // If we've not found out which action it is by now, it's unknown
506 $output->setStatusCode( 404 );
507 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
508 }
509
513 public function run() {
514 try {
515 $this->setDBProfilingAgent();
516 try {
517 $this->main();
518 } catch ( ErrorPageError $e ) {
519 // T64091: while exceptions are convenient to bubble up GUI errors,
520 // they are not internal application faults. As with normal requests, this
521 // should commit, print the output, do deferred updates, jobs, and profiling.
522 $this->doPreOutputCommit();
523 $e->report(); // display the GUI error
524 }
525 } catch ( Exception $e ) {
527 $action = $context->getRequest()->getVal( 'action', 'view' );
528 if (
529 $e instanceof DBConnectionError &&
530 $context->hasTitle() &&
531 $context->getTitle()->canExist() &&
532 in_array( $action, [ 'view', 'history' ], true ) &&
534 ) {
535 // Try to use any (even stale) file during outages...
537 if ( $cache->isCached() ) {
538 $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
540 exit;
541 }
542 }
543
544 MWExceptionHandler::handleException( $e );
545 } catch ( Error $e ) {
546 // Type errors and such: at least handle it now and clean up the LBFactory state
547 MWExceptionHandler::handleException( $e );
548 }
549
550 $this->doPostOutputShutdown( 'normal' );
551 }
552
553 private function setDBProfilingAgent() {
555 // Add a comment for easy SHOW PROCESSLIST interpretation
556 $name = $this->context->getUser()->getName();
557 $services->getDBLoadBalancerFactory()->setAgentName(
558 mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
559 );
560 }
561
567 public function doPreOutputCommit( callable $postCommitWork = null ) {
568 self::preOutputCommit( $this->context, $postCommitWork );
569 }
570
579 public static function preOutputCommit(
580 IContextSource $context, callable $postCommitWork = null
581 ) {
582 // Either all DBs should commit or none
583 ignore_user_abort( true );
584
585 $config = $context->getConfig();
586 $request = $context->getRequest();
587 $output = $context->getOutput();
588 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
589
590 // Commit all changes
591 $lbFactory->commitMasterChanges(
592 __METHOD__,
593 // Abort if any transaction was too big
594 [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
595 );
596 wfDebug( __METHOD__ . ': primary transaction round committed' );
597
598 // Run updates that need to block the user or affect output (this is the last chance)
599 DeferredUpdates::doUpdates( 'enqueue', DeferredUpdates::PRESEND );
600 wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
601
602 // Should the client return, their request should observe the new ChronologyProtector
603 // DB positions. This request might be on a foreign wiki domain, so synchronously update
604 // the DB positions in all datacenters to be safe. If this output is not a redirect,
605 // then OutputPage::output() will be relatively slow, meaning that running it in
606 // $postCommitWork should help mask the latency of those updates.
607 $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
608 $strategy = 'cookie+sync';
609
610 $allowHeaders = !( $output->isDisabled() || headers_sent() );
611 if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
612 // OutputPage::output() will be fast, so $postCommitWork is useless for masking
613 // the latency of synchronously updating the DB positions in all datacenters.
614 // Try to make use of the time the client spends following redirects instead.
615 $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
616 if ( $domainDistance === 'local' && $allowHeaders ) {
617 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
618 $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
619 } elseif ( $domainDistance === 'remote' ) {
620 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
621 $strategy = 'cookie+url'; // cross-domain cookie might not work
622 }
623 }
624
625 // Record ChronologyProtector positions for DBs affected in this request at this point
626 $cpIndex = null;
627 $cpClientId = null;
628 $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex, $cpClientId );
629 wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
630
631 if ( $cpIndex > 0 ) {
632 if ( $allowHeaders ) {
633 $now = time();
634 $expires = $now + ChronologyProtector::POSITION_COOKIE_TTL;
635 $options = [ 'prefix' => '' ];
636 $value = LBFactory::makeCookieValueFromCPIndex( $cpIndex, $now, $cpClientId );
637 $request->response()->setCookie( 'cpPosIndex', $value, $expires, $options );
638 }
639
640 if ( $strategy === 'cookie+url' ) {
641 if ( $output->getRedirect() ) { // sanity
642 $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
643 $output->getRedirect(),
644 $cpIndex
645 );
646 $output->redirect( $safeUrl );
647 } else {
648 $e = new LogicException( "No redirect; cannot append cpPosIndex parameter." );
649 MWExceptionHandler::logException( $e );
650 }
651 }
652 }
653
654 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
655 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
656 // ChronologyProtector works for cacheable URLs.
657 if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
658 $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
659 $options = [ 'prefix' => '' ];
660 $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
661 $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
662 }
663
664 // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
665 // also intimately related to the value of $wgCdnReboundPurgeDelay.
666 if ( $lbFactory->laggedReplicaUsed() ) {
667 $maxAge = $config->get( 'CdnMaxageLagged' );
668 $output->lowerCdnMaxage( $maxAge );
669 $request->response()->header( "X-Database-Lagged: true" );
670 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
671 }
672
673 // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
674 if ( MessageCache::singleton()->isDisabled() ) {
675 $maxAge = $config->get( 'CdnMaxageSubstitute' );
676 $output->lowerCdnMaxage( $maxAge );
677 $request->response()->header( "X-Response-Substitute: true" );
678 }
679 }
680
685 private static function getUrlDomainDistance( $url ) {
686 $clusterWiki = WikiMap::getWikiFromUrl( $url );
687 if ( $clusterWiki === wfWikiID() ) {
688 return 'local'; // the current wiki
689 } elseif ( $clusterWiki !== false ) {
690 return 'remote'; // another wiki in this cluster/farm
691 }
692
693 return 'external';
694 }
695
706 public function doPostOutputShutdown( $mode = 'normal' ) {
707 // Perform the last synchronous operations...
708 try {
709 // Record backend request timing
710 $timing = $this->context->getTiming();
711 $timing->mark( 'requestShutdown' );
712 // Show visible profiling data if enabled (which cannot be post-send)
713 Profiler::instance()->logDataPageOutputOnly();
714 } catch ( Exception $e ) {
715 // An error may already have been shown in run(), so just log it to be safe
716 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
717 }
718
719 // Disable WebResponse setters for post-send processing (T191537).
721
722 $blocksHttpClient = true;
723 // Defer everything else if possible...
724 $callback = function () use ( $mode, &$blocksHttpClient ) {
725 try {
726 $this->restInPeace( $mode, $blocksHttpClient );
727 } catch ( Exception $e ) {
728 // If this is post-send, then displaying errors can cause broken HTML
729 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
730 }
731 };
732
733 if ( function_exists( 'register_postsend_function' ) ) {
734 // https://github.com/facebook/hhvm/issues/1230
735 register_postsend_function( $callback );
737 $blocksHttpClient = false;
738 } else {
739 if ( function_exists( 'fastcgi_finish_request' ) ) {
740 fastcgi_finish_request();
742 $blocksHttpClient = false;
743 } else {
744 // Either all DB and deferred updates should happen or none.
745 // The latter should not be cancelled due to client disconnect.
746 ignore_user_abort( true );
747 }
748
749 $callback();
750 }
751 }
752
753 private function main() {
754 global $wgTitle;
755
756 $output = $this->context->getOutput();
757 $request = $this->context->getRequest();
758
759 // Send Ajax requests to the Ajax dispatcher.
760 if ( $request->getVal( 'action' ) === 'ajax' ) {
761 // Set a dummy title, because $wgTitle == null might break things
762 $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
763 . __METHOD__
764 );
765 $this->context->setTitle( $title );
767
768 $dispatcher = new AjaxDispatcher( $this->config );
769 $dispatcher->performAction( $this->context->getUser() );
770
771 return;
772 }
773
774 // Get title from request parameters,
775 // is set on the fly by parseTitle the first time.
776 $title = $this->getTitle();
777 $action = $this->getAction();
779
780 // Set DB query expectations for this HTTP request
781 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
782 $trxProfiler = Profiler::instance()->getTransactionProfiler();
783 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
784 if ( $request->hasSafeMethod() ) {
785 $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
786 } else {
787 $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
788 }
789
790 // If the user has forceHTTPS set to true, or if the user
791 // is in a group requiring HTTPS, or if they have the HTTPS
792 // preference set, redirect them to HTTPS.
793 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
794 // isLoggedIn() will do all sorts of weird stuff.
795 if (
796 $request->getProtocol() == 'http' &&
797 // switch to HTTPS only when supported by the server
798 preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) &&
799 (
800 $request->getSession()->shouldForceHTTPS() ||
801 // Check the cookie manually, for paranoia
802 $request->getCookie( 'forceHTTPS', '' ) ||
803 // check for prefixed version that was used for a time in older MW versions
804 $request->getCookie( 'forceHTTPS' ) ||
805 // Avoid checking the user and groups unless it's enabled.
806 (
807 $this->context->getUser()->isLoggedIn()
808 && $this->context->getUser()->requiresHTTPS()
809 )
810 )
811 ) {
812 $oldUrl = $request->getFullRequestURL();
813 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
814
815 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
816 if ( Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
817 if ( $request->wasPosted() ) {
818 // This is weird and we'd hope it almost never happens. This
819 // means that a POST came in via HTTP and policy requires us
820 // redirecting to HTTPS. It's likely such a request is going
821 // to fail due to post data being lost, but let's try anyway
822 // and just log the instance.
823
824 // @todo FIXME: See if we could issue a 307 or 308 here, need
825 // to see how clients (automated & browser) behave when we do
826 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
827 }
828 // Setup dummy Title, otherwise OutputPage::redirect will fail
829 $title = Title::newFromText( 'REDIR', NS_MAIN );
830 $this->context->setTitle( $title );
831 // Since we only do this redir to change proto, always send a vary header
832 $output->addVaryHeader( 'X-Forwarded-Proto' );
833 $output->redirect( $redirUrl );
834 $output->output();
835
836 return;
837 }
838 }
839
840 if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
841 // Try low-level file cache hit
843 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
844 // Check incoming headers to see if client has this cached
845 $timestamp = $cache->cacheTimestamp();
846 if ( !$output->checkLastModified( $timestamp ) ) {
847 $cache->loadFromFileCache( $this->context );
848 }
849 // Do any stats increment/watchlist stuff, assuming user is viewing the
850 // latest revision (which should always be the case for file cache)
851 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
852 // Tell OutputPage that output is taken care of
853 $output->disable();
854
855 return;
856 }
857 }
858
859 // Actually do the work of the request and build up any output
860 $this->performRequest();
861
862 // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
863 // ChronologyProtector synchronizes DB positions or replicas across all datacenters.
864 $buffer = null;
865 $outputWork = function () use ( $output, &$buffer ) {
866 if ( $buffer === null ) {
867 $buffer = $output->output( true );
868 }
869
870 return $buffer;
871 };
872
873 // Now commit any transactions, so that unreported errors after
874 // output() don't roll back the whole DB transaction and so that
875 // we avoid having both success and error text in the response
876 $this->doPreOutputCommit( $outputWork );
877
878 // Now send the actual output
879 print $outputWork();
880 }
881
887 public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
888 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
889 // Assure deferred updates are not in the main transaction
890 $lbFactory->commitMasterChanges( __METHOD__ );
891
892 // Loosen DB query expectations since the HTTP client is unblocked
893 $trxProfiler = Profiler::instance()->getTransactionProfiler();
894 $trxProfiler->resetExpectations();
895 $trxProfiler->setExpectations(
896 $this->context->getRequest()->hasSafeMethod()
897 ? $this->config->get( 'TrxProfilerLimits' )['PostSend-GET']
898 : $this->config->get( 'TrxProfilerLimits' )['PostSend-POST'],
899 __METHOD__
900 );
901
902 // Do any deferred jobs; preferring to run them now if a client will not wait on them
903 DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
904
905 // Now that everything specific to this request is done,
906 // try to occasionally run jobs (if enabled) from the queues
907 if ( $mode === 'normal' ) {
908 $this->triggerJobs();
909 }
910
911 // Log profiling data, e.g. in the database or UDP
913
914 // Commit and close up!
915 $lbFactory->commitMasterChanges( __METHOD__ );
916 $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
917
918 wfDebug( "Request ended normally\n" );
919 }
920
929 public static function emitBufferedStatsdData(
930 IBufferingStatsdDataFactory $stats, Config $config
931 ) {
932 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
933 try {
934 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
935 $statsdHost = $statsdServer[0];
936 $statsdPort = $statsdServer[1] ?? 8125;
937 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
938 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
939 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
940 $statsdClient->send( $stats->getData() );
941
942 $stats->clearData(); // empty buffer for the next round
943 } catch ( Exception $ex ) {
944 MWExceptionHandler::logException( $ex );
945 }
946 }
947 }
948
954 public function triggerJobs() {
955 $jobRunRate = $this->config->get( 'JobRunRate' );
956 if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
957 return; // recursion guard
958 } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
959 return;
960 }
961
962 if ( $jobRunRate < 1 ) {
963 $max = mt_getrandmax();
964 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
965 return; // the higher the job run rate, the less likely we return here
966 }
967 $n = 1;
968 } else {
969 $n = intval( $jobRunRate );
970 }
971
972 $logger = LoggerFactory::getInstance( 'runJobs' );
973
974 try {
975 if ( $this->config->get( 'RunJobsAsync' ) ) {
976 // Send an HTTP request to the job RPC entry point if possible
977 $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
978 if ( !$invokedWithSuccess ) {
979 // Fall back to blocking on running the job(s)
980 $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
981 $this->triggerSyncJobs( $n, $logger );
982 }
983 } else {
984 $this->triggerSyncJobs( $n, $logger );
985 }
986 } catch ( JobQueueError $e ) {
987 // Do not make the site unavailable (T88312)
988 MWExceptionHandler::logException( $e );
989 }
990 }
991
996 private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
997 $trxProfiler = Profiler::instance()->getTransactionProfiler();
998 $old = $trxProfiler->setSilenced( true );
999 try {
1000 $runner = new JobRunner( $runJobsLogger );
1001 $runner->run( [ 'maxJobs' => $n ] );
1002 } finally {
1003 $trxProfiler->setSilenced( $old );
1004 }
1005 }
1006
1012 private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
1013 // Do not send request if there are probably no jobs
1014 $group = JobQueueGroup::singleton();
1015 if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
1016 return true;
1017 }
1018
1019 $query = [ 'title' => 'Special:RunJobs',
1020 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
1022 $query, $this->config->get( 'SecretKey' ) );
1023
1024 $errno = $errstr = null;
1025 $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
1026 $host = $info ? $info['host'] : null;
1027 $port = 80;
1028 if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
1029 $host = "tls://" . $host;
1030 $port = 443;
1031 }
1032 if ( isset( $info['port'] ) ) {
1033 $port = $info['port'];
1034 }
1035
1036 Wikimedia\suppressWarnings();
1037 $sock = $host ? fsockopen(
1038 $host,
1039 $port,
1040 $errno,
1041 $errstr,
1042 // If it takes more than 100ms to connect to ourselves there is a problem...
1043 0.100
1044 ) : false;
1045 Wikimedia\restoreWarnings();
1046
1047 $invokedWithSuccess = true;
1048 if ( $sock ) {
1049 $special = MediaWikiServices::getInstance()->getSpecialPageFactory()->
1050 getPage( 'RunJobs' );
1051 $url = $special->getPageTitle()->getCanonicalURL( $query );
1052 $req = (
1053 "POST $url HTTP/1.1\r\n" .
1054 "Host: {$info['host']}\r\n" .
1055 "Connection: Close\r\n" .
1056 "Content-Length: 0\r\n\r\n"
1057 );
1058
1059 $runJobsLogger->info( "Running $n job(s) via '$url'" );
1060 // Send a cron API request to be performed in the background.
1061 // Give up if this takes too long to send (which should be rare).
1062 stream_set_timeout( $sock, 2 );
1063 $bytes = fwrite( $sock, $req );
1064 if ( $bytes !== strlen( $req ) ) {
1065 $invokedWithSuccess = false;
1066 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1067 } else {
1068 // Do not wait for the response (the script should handle client aborts).
1069 // Make sure that we don't close before that script reaches ignore_user_abort().
1070 $start = microtime( true );
1071 $status = fgets( $sock );
1072 $sec = microtime( true ) - $start;
1073 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1074 $invokedWithSuccess = false;
1075 $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1076 }
1077 }
1078 fclose( $sock );
1079 } else {
1080 $invokedWithSuccess = false;
1081 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1082 }
1083
1084 return $invokedWithSuccess;
1085 }
1086}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfLogProfilingData()
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition api.php:57
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition Action.php:39
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition Action.php:97
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition Action.php:124
Object-Oriented Ajax functions.
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition Article.php:192
Show an error page on a badtitle.
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
An error page which can definitely be safely rendered using the OutputPage.
Page view caching in the file system.
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
Show an error that looks like an HTTP server error.
Definition HttpError.php:30
Job queue runner utility methods.
Definition JobRunner.php:39
static getHTML( $e)
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
MediaWiki exception.
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static getInstance()
Returns the global default instance of the top level service locator.
parseTitle()
Parse the request to get the Title object.
Definition MediaWiki.php:68
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
triggerAsyncJobs( $n, LoggerInterface $runJobsLogger)
doPostOutputShutdown( $mode='normal')
This function does work that can be done after the user gets the HTTP response so they don't block on...
initializeArticle()
Initialize the main Article object for "standard" actions (view, etc) Create an Article object for th...
Config $config
Definition MediaWiki.php:43
run()
Run the current MediaWiki instance; index.php just calls this.
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
__construct(IContextSource $context=null)
Definition MediaWiki.php:53
triggerSyncJobs( $n, LoggerInterface $runJobsLogger)
getAction()
Returns the name of the action that will be executed.
restInPeace( $mode='fast', $blocksHttpClient=true)
Ends this task peacefully.
tryNormaliseRedirect(Title $title)
Handle redirects for uncanonical title requests.
String $action
Cache what action this request is.
Definition MediaWiki.php:48
static preOutputCommit(IContextSource $context, callable $postCommitWork=null)
This function commits all DB changes as needed before the user can receive a response (in case commit...
IContextSource $context
Definition MediaWiki.php:38
triggerJobs()
Potentially open a socket and sent an HTTP request back to the server to run a specified number of jo...
performRequest()
Performs the request.
static getUrlDomainDistance( $url)
setDBProfilingAgent()
doPreOutputCommit(callable $postCommitWork=null)
performAction(Page $page, Title $requestTitle)
Perform one of the "standard" actions.
Show an error when a user tries to do something they do not have the necessary permissions for.
Shortcut to construct a special page alias.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition Revision.php:114
A statsd client that applies the sampling rate to the data items before sending them.
static getQuerySignature(array $query, $secretKey)
Represents a title within MediaWiki.
Definition Title.php:39
getCdnUrls()
Get a list of URLs to purge from the CDN cache when this page changes.
Definition Title.php:3945
static disableForPostSend()
Disable setters for post-send processing.
Special handling for file pages.
static getWikiFromUrl( $url)
Definition WikiMap.php:222
Class for ensuring a consistent ordering of events as seen by the user, despite replication.
An interface for generating database load balancers.
Definition LBFactory.php:39
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
const PROTO_HTTPS
Definition Defines.php:220
const NS_FILE
Definition Defines.php:70
const PROTO_CURRENT
Definition Defines.php:222
const NS_MAIN
Definition Defines.php:64
const PROTO_INTERNAL
Definition Defines.php:224
const NS_SPECIAL
Definition Defines.php:53
const NS_MEDIA
Definition Defines.php:52
register_postsend_function( $callback)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition hhvm.php:25
this hook is for auditing only $req
Definition hooks.txt:1018
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2880
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1305
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 & $options
Definition hooks.txt:2050
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2885
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition hooks.txt:2335
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 & $ret
Definition hooks.txt:2054
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition hooks.txt:1619
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:1656
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2317
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1818
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:2226
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
Interface for configuration instances.
Definition Config.php:28
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
MediaWiki adaptation of StatsdDataFactory that provides buffering functionality.
hasData()
Check whether this data factory has any buffered data.
clearData()
Clear all buffered data from the factory.
getData()
Return the buffered data from the factory.
Interface for objects which can provide a MediaWiki context on request.
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition Page.php:24
$cache
Definition mcc.php:33
$buffer
A helper class for throttling authentication attempts.