MediaWiki REL1_31
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 ) {
56 }
57
58 $this->context = $context;
59 $this->config = $context->getConfig();
60 }
61
68 private function parseTitle() {
70
71 $request = $this->context->getRequest();
72 $curid = $request->getInt( 'curid' );
73 $title = $request->getVal( 'title' );
74 $action = $request->getVal( 'action' );
75
76 if ( $request->getCheck( 'search' ) ) {
77 // Compatibility with old search URLs which didn't use Special:Search
78 // Just check for presence here, so blank requests still
79 // show the search page when using ugly URLs (T10054).
80 $ret = SpecialPage::getTitleFor( 'Search' );
81 } elseif ( $curid ) {
82 // URLs like this are generated by RC, because rc_title isn't always accurate
83 $ret = Title::newFromID( $curid );
84 } else {
85 $ret = Title::newFromURL( $title );
86 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
87 // in wikitext links to tell Parser to make a direct file link
88 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
89 $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
90 }
91 // Check variant links so that interwiki links don't have to worry
92 // about the possible different language variants
93 if ( count( $wgContLang->getVariants() ) > 1
94 && !is_null( $ret ) && $ret->getArticleID() == 0
95 ) {
96 $wgContLang->findVariantLink( $title, $ret );
97 }
98 }
99
100 // If title is not provided, always allow oldid and diff to set the title.
101 // If title is provided, allow oldid and diff to override the title, unless
102 // we are talking about a special page which might use these parameters for
103 // other purposes.
104 if ( $ret === null || !$ret->isSpecialPage() ) {
105 // We can have urls with just ?diff=,?oldid= or even just ?diff=
106 $oldid = $request->getInt( 'oldid' );
107 $oldid = $oldid ? $oldid : $request->getInt( 'diff' );
108 // Allow oldid to override a changed or missing title
109 if ( $oldid ) {
110 $rev = Revision::newFromId( $oldid );
111 $ret = $rev ? $rev->getTitle() : $ret;
112 }
113 }
114
115 // Use the main page as default title if nothing else has been provided
116 if ( $ret === null
117 && strval( $title ) === ''
118 && !$request->getCheck( 'curid' )
119 && $action !== 'delete'
120 ) {
121 $ret = Title::newMainPage();
122 }
123
124 if ( $ret === null || ( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
125 // If we get here, we definitely don't have a valid title; throw an exception.
126 // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
127 Title::newFromTextThrow( $title );
128 throw new MalformedTitleException( 'badtitletext', $title );
129 }
130
131 return $ret;
132 }
133
138 public function getTitle() {
139 if ( !$this->context->hasTitle() ) {
140 try {
141 $this->context->setTitle( $this->parseTitle() );
142 } catch ( MalformedTitleException $ex ) {
143 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
144 }
145 }
146 return $this->context->getTitle();
147 }
148
154 public function getAction() {
155 if ( $this->action === null ) {
156 $this->action = Action::getActionName( $this->context );
157 }
158
159 return $this->action;
160 }
161
174 private function performRequest() {
176
177 $request = $this->context->getRequest();
178 $requestTitle = $title = $this->context->getTitle();
179 $output = $this->context->getOutput();
180 $user = $this->context->getUser();
181
182 if ( $request->getVal( 'printable' ) === 'yes' ) {
183 $output->setPrintable();
184 }
185
186 $unused = null; // To pass it by reference
187 Hooks::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
188
189 // Invalid titles. T23776: The interwikis must redirect even if the page name is empty.
190 if ( is_null( $title ) || ( $title->getDBkey() == '' && !$title->isExternal() )
191 || $title->isSpecial( 'Badtitle' )
192 ) {
193 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
194 try {
195 $this->parseTitle();
196 } catch ( MalformedTitleException $ex ) {
197 throw new BadTitleError( $ex );
198 }
199 throw new BadTitleError();
200 }
201
202 // Check user's permissions to read this page.
203 // We have to check here to catch special pages etc.
204 // We will check again in Article::view().
205 $permErrors = $title->isSpecial( 'RunJobs' )
206 ? [] // relies on HMAC key signature alone
207 : $title->getUserPermissionsErrors( 'read', $user );
208 if ( count( $permErrors ) ) {
209 // T34276: allowing the skin to generate output with $wgTitle or
210 // $this->context->title set to the input title would allow anonymous users to
211 // determine whether a page exists, potentially leaking private data. In fact, the
212 // curid and oldid request parameters would allow page titles to be enumerated even
213 // when they are not guessable. So we reset the title to Special:Badtitle before the
214 // permissions error is displayed.
215
216 // The skin mostly uses $this->context->getTitle() these days, but some extensions
217 // still use $wgTitle.
218 $badTitle = SpecialPage::getTitleFor( 'Badtitle' );
219 $this->context->setTitle( $badTitle );
220 $wgTitle = $badTitle;
221
222 throw new PermissionsError( 'read', $permErrors );
223 }
224
225 // Interwiki redirects
226 if ( $title->isExternal() ) {
227 $rdfrom = $request->getVal( 'rdfrom' );
228 if ( $rdfrom ) {
229 $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
230 } else {
231 $query = $request->getValues();
232 unset( $query['title'] );
233 $url = $title->getFullURL( $query );
234 }
235 // Check for a redirect loop
236 if ( !preg_match( '/^' . preg_quote( $this->config->get( 'Server' ), '/' ) . '/', $url )
237 && $title->isLocal()
238 ) {
239 // 301 so google et al report the target as the actual url.
240 $output->redirect( $url, 301 );
241 } else {
242 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
243 try {
244 $this->parseTitle();
245 } catch ( MalformedTitleException $ex ) {
246 throw new BadTitleError( $ex );
247 }
248 throw new BadTitleError();
249 }
250 // Handle any other redirects.
251 // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
252 } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
253 // Prevent information leak via Special:MyPage et al (T109724)
254 if ( $title->isSpecialPage() ) {
255 $specialPage = SpecialPageFactory::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 ) = SpecialPageFactory::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 SpecialPageFactory::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 ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
343 if ( $name ) {
344 $title = SpecialPage::getTitleFor( $name, $subpage );
345 }
346 }
347 // Redirect to canonical url, make it a 301 to allow caching
348 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
349 if ( $targetUrl == $request->getFullRequestURL() ) {
350 $message = "Redirect loop detected!\n\n" .
351 "This means the wiki got confused about what page was " .
352 "requested; this sometimes happens when moving a wiki " .
353 "to a new server or changing the server configuration.\n\n";
354
355 if ( $this->config->get( 'UsePathInfo' ) ) {
356 $message .= "The wiki is trying to interpret the page " .
357 "title from the URL path portion (PATH_INFO), which " .
358 "sometimes fails depending on the web server. Try " .
359 "setting \"\$wgUsePathInfo = false;\" in your " .
360 "LocalSettings.php, or check that \$wgArticlePath " .
361 "is correct.";
362 } else {
363 $message .= "Your web server was detected as possibly not " .
364 "supporting URL path components (PATH_INFO) correctly; " .
365 "check your LocalSettings.php for a customized " .
366 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
367 "to true.";
368 }
369 throw new HttpError( 500, $message );
370 }
371 $output->setCdnMaxage( 1200 );
372 $output->redirect( $targetUrl, '301' );
373 return true;
374 }
375
382 private function initializeArticle() {
383 $title = $this->context->getTitle();
384 if ( $this->context->canUseWikiPage() ) {
385 // Try to use request context wiki page, as there
386 // is already data from db saved in per process
387 // cache there from this->getAction() call.
388 $page = $this->context->getWikiPage();
389 } else {
390 // This case should not happen, but just in case.
391 // @TODO: remove this or use an exception
392 $page = WikiPage::factory( $title );
393 $this->context->setWikiPage( $page );
394 wfWarn( "RequestContext::canUseWikiPage() returned false" );
395 }
396
397 // Make GUI wrapper for the WikiPage
398 $article = Article::newFromWikiPage( $page, $this->context );
399
400 // Skip some unnecessary code if the content model doesn't support redirects
401 if ( !ContentHandler::getForTitle( $title )->supportsRedirects() ) {
402 return $article;
403 }
404
405 $request = $this->context->getRequest();
406
407 // Namespace might change when using redirects
408 // Check for redirects ...
409 $action = $request->getVal( 'action', 'view' );
410 $file = ( $page instanceof WikiFilePage ) ? $page->getFile() : null;
411 if ( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
412 && !$request->getVal( 'oldid' ) // ... and are not old revisions
413 && !$request->getVal( 'diff' ) // ... and not when showing diff
414 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
415 // ... and the article is not a non-redirect image page with associated file
416 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
417 ) {
418 // Give extensions a change to ignore/handle redirects as needed
419 $ignoreRedirect = $target = false;
420
421 Hooks::run( 'InitializeArticleMaybeRedirect',
422 [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
423 $page = $article->getPage(); // reflect any hook changes
424
425 // Follow redirects only for... redirects.
426 // If $target is set, then a hook wanted to redirect.
427 if ( !$ignoreRedirect && ( $target || $page->isRedirect() ) ) {
428 // Is the target already set by an extension?
429 $target = $target ? $target : $page->followRedirect();
430 if ( is_string( $target ) ) {
431 if ( !$this->config->get( 'DisableHardRedirects' ) ) {
432 // we'll need to redirect
433 return $target;
434 }
435 }
436 if ( is_object( $target ) ) {
437 // Rewrite environment to redirected article
438 $rpage = WikiPage::factory( $target );
439 $rpage->loadPageData();
440 if ( $rpage->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
441 $rarticle = Article::newFromWikiPage( $rpage, $this->context );
442 $rarticle->setRedirectedFrom( $title );
443
444 $article = $rarticle;
445 $this->context->setTitle( $target );
446 $this->context->setWikiPage( $article->getPage() );
447 }
448 }
449 } else {
450 // Article may have been changed by hook
451 $this->context->setTitle( $article->getTitle() );
452 $this->context->setWikiPage( $article->getPage() );
453 }
454 }
455
456 return $article;
457 }
458
465 private function performAction( Page $page, Title $requestTitle ) {
466 $request = $this->context->getRequest();
467 $output = $this->context->getOutput();
468 $title = $this->context->getTitle();
469 $user = $this->context->getUser();
470
471 if ( !Hooks::run( 'MediaWikiPerformAction',
472 [ $output, $page, $title, $user, $request, $this ] )
473 ) {
474 return;
475 }
476
477 $act = $this->getAction();
478 $action = Action::factory( $act, $page, $this->context );
479
480 if ( $action instanceof Action ) {
481 // Narrow DB query expectations for this HTTP request
482 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
483 $trxProfiler = Profiler::instance()->getTransactionProfiler();
484 if ( $request->wasPosted() && !$action->doesWrites() ) {
485 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
486 $request->markAsSafeRequest();
487 }
488
489 # Let CDN cache things if we can purge them.
490 if ( $this->config->get( 'UseSquid' ) &&
491 in_array(
492 // Use PROTO_INTERNAL because that's what getCdnUrls() uses
493 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL ),
494 $requestTitle->getCdnUrls()
495 )
496 ) {
497 $output->setCdnMaxage( $this->config->get( 'SquidMaxage' ) );
498 }
499
500 $action->show();
501 return;
502 }
503 // NOTE: deprecated hook. Add to $wgActions instead
504 if ( Hooks::run(
505 'UnknownAction',
506 [
507 $request->getVal( 'action', 'view' ),
508 $page
509 ],
510 '1.19'
511 ) ) {
512 $output->setStatusCode( 404 );
513 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
514 }
515 }
516
520 public function run() {
521 try {
522 $this->setDBProfilingAgent();
523 try {
524 $this->main();
525 } catch ( ErrorPageError $e ) {
526 // T64091: while exceptions are convenient to bubble up GUI errors,
527 // they are not internal application faults. As with normal requests, this
528 // should commit, print the output, do deferred updates, jobs, and profiling.
529 $this->doPreOutputCommit();
530 $e->report(); // display the GUI error
531 }
532 } catch ( Exception $e ) {
534 $action = $context->getRequest()->getVal( 'action', 'view' );
535 if (
536 $e instanceof DBConnectionError &&
537 $context->hasTitle() &&
538 $context->getTitle()->canExist() &&
539 in_array( $action, [ 'view', 'history' ], true ) &&
541 ) {
542 // Try to use any (even stale) file during outages...
544 if ( $cache->isCached() ) {
545 $cache->loadFromFileCache( $context, HTMLFileCache::MODE_OUTAGE );
547 exit;
548 }
549 }
550
551 MWExceptionHandler::handleException( $e );
552 } catch ( Error $e ) {
553 // Type errors and such: at least handle it now and clean up the LBFactory state
554 MWExceptionHandler::handleException( $e );
555 }
556
557 $this->doPostOutputShutdown( 'normal' );
558 }
559
560 private function setDBProfilingAgent() {
562 // Add a comment for easy SHOW PROCESSLIST interpretation
563 $name = $this->context->getUser()->getName();
564 $services->getDBLoadBalancerFactory()->setAgentName(
565 mb_strlen( $name ) > 15 ? mb_substr( $name, 0, 15 ) . '...' : $name
566 );
567 }
568
574 public function doPreOutputCommit( callable $postCommitWork = null ) {
575 self::preOutputCommit( $this->context, $postCommitWork );
576 }
577
586 public static function preOutputCommit(
587 IContextSource $context, callable $postCommitWork = null
588 ) {
589 // Either all DBs should commit or none
590 ignore_user_abort( true );
591
592 $config = $context->getConfig();
593 $request = $context->getRequest();
594 $output = $context->getOutput();
595 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
596
597 // Commit all changes
598 $lbFactory->commitMasterChanges(
599 __METHOD__,
600 // Abort if any transaction was too big
601 [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
602 );
603 wfDebug( __METHOD__ . ': primary transaction round committed' );
604
605 // Run updates that need to block the user or affect output (this is the last chance)
606 DeferredUpdates::doUpdates( 'enqueue', DeferredUpdates::PRESEND );
607 wfDebug( __METHOD__ . ': pre-send deferred updates completed' );
608
609 // Should the client return, their request should observe the new ChronologyProtector
610 // DB positions. This request might be on a foreign wiki domain, so synchronously update
611 // the DB positions in all datacenters to be safe. If this output is not a redirect,
612 // then OutputPage::output() will be relatively slow, meaning that running it in
613 // $postCommitWork should help mask the latency of those updates.
614 $flags = $lbFactory::SHUTDOWN_CHRONPROT_SYNC;
615 $strategy = 'cookie+sync';
616
617 $allowHeaders = !( $output->isDisabled() || headers_sent() );
618 if ( $output->getRedirect() && $lbFactory->hasOrMadeRecentMasterChanges( INF ) ) {
619 // OutputPage::output() will be fast, so $postCommitWork is useless for masking
620 // the latency of synchronously updating the DB positions in all datacenters.
621 // Try to make use of the time the client spends following redirects instead.
622 $domainDistance = self::getUrlDomainDistance( $output->getRedirect() );
623 if ( $domainDistance === 'local' && $allowHeaders ) {
624 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
625 $strategy = 'cookie'; // use same-domain cookie and keep the URL uncluttered
626 } elseif ( $domainDistance === 'remote' ) {
627 $flags = $lbFactory::SHUTDOWN_CHRONPROT_ASYNC;
628 $strategy = 'cookie+url'; // cross-domain cookie might not work
629 }
630 }
631
632 // Record ChronologyProtector positions for DBs affected in this request at this point
633 $cpIndex = null;
634 $lbFactory->shutdown( $flags, $postCommitWork, $cpIndex );
635 wfDebug( __METHOD__ . ': LBFactory shutdown completed' );
636
637 if ( $cpIndex > 0 ) {
638 if ( $allowHeaders ) {
639 $expires = time() + ChronologyProtector::POSITION_TTL;
640 $options = [ 'prefix' => '' ];
641 $request->response()->setCookie( 'cpPosIndex', $cpIndex, $expires, $options );
642 }
643
644 if ( $strategy === 'cookie+url' ) {
645 if ( $output->getRedirect() ) { // sanity
646 $safeUrl = $lbFactory->appendShutdownCPIndexAsQuery(
647 $output->getRedirect(),
648 $cpIndex
649 );
650 $output->redirect( $safeUrl );
651 } else {
652 $e = new LogicException( "No redirect; cannot append cpPosIndex parameter." );
653 MWExceptionHandler::logException( $e );
654 }
655 }
656 }
657
658 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
659 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
660 // ChronologyProtector works for cacheable URLs.
661 if ( $request->wasPosted() && $lbFactory->hasOrMadeRecentMasterChanges() ) {
662 $expires = time() + $config->get( 'DataCenterUpdateStickTTL' );
663 $options = [ 'prefix' => '' ];
664 $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
665 $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
666 }
667
668 // Avoid letting a few seconds of replica DB lag cause a month of stale data. This logic is
669 // also intimately related to the value of $wgCdnReboundPurgeDelay.
670 if ( $lbFactory->laggedReplicaUsed() ) {
671 $maxAge = $config->get( 'CdnMaxageLagged' );
672 $output->lowerCdnMaxage( $maxAge );
673 $request->response()->header( "X-Database-Lagged: true" );
674 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
675 }
676
677 // Avoid long-term cache pollution due to message cache rebuild timeouts (T133069)
678 if ( MessageCache::singleton()->isDisabled() ) {
679 $maxAge = $config->get( 'CdnMaxageSubstitute' );
680 $output->lowerCdnMaxage( $maxAge );
681 $request->response()->header( "X-Response-Substitute: true" );
682 }
683 }
684
689 private static function getUrlDomainDistance( $url ) {
690 $clusterWiki = WikiMap::getWikiFromUrl( $url );
691 if ( $clusterWiki === wfWikiID() ) {
692 return 'local'; // the current wiki
693 } elseif ( $clusterWiki !== false ) {
694 return 'remote'; // another wiki in this cluster/farm
695 }
696
697 return 'external';
698 }
699
710 public function doPostOutputShutdown( $mode = 'normal' ) {
711 // Perform the last synchronous operations...
712 try {
713 // Record backend request timing
714 $timing = $this->context->getTiming();
715 $timing->mark( 'requestShutdown' );
716 // Show visible profiling data if enabled (which cannot be post-send)
717 Profiler::instance()->logDataPageOutputOnly();
718 } catch ( Exception $e ) {
719 // An error may already have been shown in run(), so just log it to be safe
720 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
721 }
722
723 // Disable WebResponse setters for post-send processing (T191537).
725
726 $blocksHttpClient = true;
727 // Defer everything else if possible...
728 $callback = function () use ( $mode, &$blocksHttpClient ) {
729 try {
730 $this->restInPeace( $mode, $blocksHttpClient );
731 } catch ( Exception $e ) {
732 // If this is post-send, then displaying errors can cause broken HTML
733 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
734 }
735 };
736
737 if ( function_exists( 'register_postsend_function' ) ) {
738 // https://github.com/facebook/hhvm/issues/1230
739 register_postsend_function( $callback );
741 $blocksHttpClient = false;
742 } else {
743 if ( function_exists( 'fastcgi_finish_request' ) ) {
744 fastcgi_finish_request();
746 $blocksHttpClient = false;
747 } else {
748 // Either all DB and deferred updates should happen or none.
749 // The latter should not be cancelled due to client disconnect.
750 ignore_user_abort( true );
751 }
752
753 $callback();
754 }
755 }
756
757 private function main() {
759
760 $output = $this->context->getOutput();
761 $request = $this->context->getRequest();
762
763 // Send Ajax requests to the Ajax dispatcher.
764 if ( $this->config->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
765 // Set a dummy title, because $wgTitle == null might break things
766 $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/performing an AJAX call in '
767 . __METHOD__
768 );
769 $this->context->setTitle( $title );
771
772 $dispatcher = new AjaxDispatcher( $this->config );
773 $dispatcher->performAction( $this->context->getUser() );
774
775 return;
776 }
777
778 // Get title from request parameters,
779 // is set on the fly by parseTitle the first time.
780 $title = $this->getTitle();
781 $action = $this->getAction();
783
784 // Set DB query expectations for this HTTP request
785 $trxLimits = $this->config->get( 'TrxProfilerLimits' );
786 $trxProfiler = Profiler::instance()->getTransactionProfiler();
787 $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
788 if ( $request->hasSafeMethod() ) {
789 $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__ );
790 } else {
791 $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__ );
792 }
793
794 if ( $this->maybeDoHttpsRedirect() ) {
795 return;
796 }
797
798 if ( $title->canExist() && HTMLFileCache::useFileCache( $this->context ) ) {
799 // Try low-level file cache hit
801 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
802 // Check incoming headers to see if client has this cached
803 $timestamp = $cache->cacheTimestamp();
804 if ( !$output->checkLastModified( $timestamp ) ) {
805 $cache->loadFromFileCache( $this->context );
806 }
807 // Do any stats increment/watchlist stuff, assuming user is viewing the
808 // latest revision (which should always be the case for file cache)
809 $this->context->getWikiPage()->doViewUpdates( $this->context->getUser() );
810 // Tell OutputPage that output is taken care of
811 $output->disable();
812
813 return;
814 }
815 }
816
817 // Actually do the work of the request and build up any output
818 $this->performRequest();
819
820 // GUI-ify and stash the page output in MediaWiki::doPreOutputCommit() while
821 // ChronologyProtector synchronizes DB positions or replicas accross all datacenters.
822 $buffer = null;
823 $outputWork = function () use ( $output, &$buffer ) {
824 if ( $buffer === null ) {
825 $buffer = $output->output( true );
826 }
827
828 return $buffer;
829 };
830
831 // Now commit any transactions, so that unreported errors after
832 // output() don't roll back the whole DB transaction and so that
833 // we avoid having both success and error text in the response
834 $this->doPreOutputCommit( $outputWork );
835
836 // Now send the actual output
837 print $outputWork();
838 }
839
846 private function shouldDoHttpRedirect() {
847 $request = $this->context->getRequest();
848
849 // Don't redirect if we're already on HTTPS
850 if ( $request->getProtocol() !== 'http' ) {
851 return false;
852 }
853
854 $force = $this->config->get( 'ForceHTTPS' );
855
856 // Don't redirect if $wgServer is explicitly HTTP. We test for this here
857 // by checking whether wfExpandUrl() is able to force HTTPS.
858 if ( !preg_match( '#^https://#', wfExpandUrl( $request->getRequestURL(), PROTO_HTTPS ) ) ) {
859 if ( $force ) {
860 throw new RuntimeException( '$wgForceHTTPS is true but the server is not HTTPS' );
861 }
862 return false;
863 }
864
865 // Configured $wgForceHTTPS overrides the remaining conditions
866 if ( $force ) {
867 return true;
868 }
869
870 // Check if HTTPS is required by the session or user preferences
871 return $request->getSession()->shouldForceHTTPS() ||
872 // Check the cookie manually, for paranoia
873 $request->getCookie( 'forceHTTPS', '' ) ||
874 // Avoid checking the user and groups unless it's enabled.
875 (
876 $this->context->getUser()->isLoggedIn()
877 && $this->context->getUser()->requiresHTTPS()
878 );
879 }
880
890 private function maybeDoHttpsRedirect() {
891 if ( !$this->shouldDoHttpRedirect() ) {
892 return false;
893 }
894
895 $request = $this->context->getRequest();
896 $oldUrl = $request->getFullRequestURL();
897 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
898
899 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
900 if ( !Hooks::run( 'BeforeHttpsRedirect', [ $this->context, &$redirUrl ] ) ) {
901 return false;
902 }
903
904 if ( $request->wasPosted() ) {
905 // This is weird and we'd hope it almost never happens. This
906 // means that a POST came in via HTTP and policy requires us
907 // redirecting to HTTPS. It's likely such a request is going
908 // to fail due to post data being lost, but let's try anyway
909 // and just log the instance.
910
911 // @todo FIXME: See if we could issue a 307 or 308 here, need
912 // to see how clients (automated & browser) behave when we do
913 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
914 }
915 // Setup dummy Title, otherwise OutputPage::redirect will fail
916 $title = Title::newFromText( 'REDIR', NS_MAIN );
917 $this->context->setTitle( $title );
918 // Since we only do this redir to change proto, always send a vary header
919 $output = $this->context->getOutput();
920 $output->addVaryHeader( 'X-Forwarded-Proto' );
921 $output->redirect( $redirUrl );
922 $output->output();
923
924 return true;
925 }
926
932 public function restInPeace( $mode = 'fast', $blocksHttpClient = true ) {
933 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
934 // Assure deferred updates are not in the main transaction
935 $lbFactory->commitMasterChanges( __METHOD__ );
936
937 // Loosen DB query expectations since the HTTP client is unblocked
938 $trxProfiler = Profiler::instance()->getTransactionProfiler();
939 $trxProfiler->resetExpectations();
940 $trxProfiler->setExpectations(
941 $this->context->getRequest()->hasSafeMethod()
942 ? $this->config->get( 'TrxProfilerLimits' )['PostSend-GET']
943 : $this->config->get( 'TrxProfilerLimits' )['PostSend-POST'],
944 __METHOD__
945 );
946
947 // Important: this must be the last deferred update added (T100085, T154425)
948 DeferredUpdates::addCallableUpdate( [ JobQueueGroup::class, 'pushLazyJobs' ] );
949
950 // Do any deferred jobs; preferring to run them now if a client will not wait on them
951 DeferredUpdates::doUpdates( $blocksHttpClient ? 'enqueue' : 'run' );
952
953 // Now that everything specific to this request is done,
954 // try to occasionally run jobs (if enabled) from the queues
955 if ( $mode === 'normal' ) {
956 $this->triggerJobs();
957 }
958
959 // Log profiling data, e.g. in the database or UDP
961
962 // Commit and close up!
963 $lbFactory->commitMasterChanges( __METHOD__ );
964 $lbFactory->shutdown( LBFactory::SHUTDOWN_NO_CHRONPROT );
965
966 wfDebug( "Request ended normally\n" );
967 }
968
977 public static function emitBufferedStatsdData(
978 IBufferingStatsdDataFactory $stats, Config $config
979 ) {
980 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
981 try {
982 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
983 $statsdHost = $statsdServer[0];
984 $statsdPort = isset( $statsdServer[1] ) ? $statsdServer[1] : 8125;
985 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
986 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
987 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
988 $statsdClient->send( $stats->getData() );
989
990 $stats->clearData(); // empty buffer for the next round
991 } catch ( Exception $ex ) {
992 MWExceptionHandler::logException( $ex );
993 }
994 }
995 }
996
1002 public function triggerJobs() {
1003 $jobRunRate = $this->config->get( 'JobRunRate' );
1004 if ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
1005 return; // recursion guard
1006 } elseif ( $jobRunRate <= 0 || wfReadOnly() ) {
1007 return;
1008 }
1009
1010 if ( $jobRunRate < 1 ) {
1011 $max = mt_getrandmax();
1012 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
1013 return; // the higher the job run rate, the less likely we return here
1014 }
1015 $n = 1;
1016 } else {
1017 $n = intval( $jobRunRate );
1018 }
1019
1020 $logger = LoggerFactory::getInstance( 'runJobs' );
1021
1022 try {
1023 if ( $this->config->get( 'RunJobsAsync' ) ) {
1024 // Send an HTTP request to the job RPC entry point if possible
1025 $invokedWithSuccess = $this->triggerAsyncJobs( $n, $logger );
1026 if ( !$invokedWithSuccess ) {
1027 // Fall back to blocking on running the job(s)
1028 $logger->warning( "Jobs switched to blocking; Special:RunJobs disabled" );
1029 $this->triggerSyncJobs( $n, $logger );
1030 }
1031 } else {
1032 $this->triggerSyncJobs( $n, $logger );
1033 }
1034 } catch ( JobQueueError $e ) {
1035 // Do not make the site unavailable (T88312)
1036 MWExceptionHandler::logException( $e );
1037 }
1038 }
1039
1044 private function triggerSyncJobs( $n, LoggerInterface $runJobsLogger ) {
1045 $runner = new JobRunner( $runJobsLogger );
1046 $runner->run( [ 'maxJobs' => $n ] );
1047 }
1048
1054 private function triggerAsyncJobs( $n, LoggerInterface $runJobsLogger ) {
1055 // Do not send request if there are probably no jobs
1056 $group = JobQueueGroup::singleton();
1057 if ( !$group->queuesHaveJobs( JobQueueGroup::TYPE_DEFAULT ) ) {
1058 return true;
1059 }
1060
1061 $query = [ 'title' => 'Special:RunJobs',
1062 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() + 5 ];
1064 $query, $this->config->get( 'SecretKey' ) );
1065
1066 $errno = $errstr = null;
1067 $info = wfParseUrl( $this->config->get( 'CanonicalServer' ) );
1068 $host = $info ? $info['host'] : null;
1069 $port = 80;
1070 if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
1071 $host = "tls://" . $host;
1072 $port = 443;
1073 }
1074 if ( isset( $info['port'] ) ) {
1075 $port = $info['port'];
1076 }
1077
1078 Wikimedia\suppressWarnings();
1079 $sock = $host ? fsockopen(
1080 $host,
1081 $port,
1082 $errno,
1083 $errstr,
1084 // If it takes more than 100ms to connect to ourselves there is a problem...
1085 0.100
1086 ) : false;
1087 Wikimedia\restoreWarnings();
1088
1089 $invokedWithSuccess = true;
1090 if ( $sock ) {
1092 $url = $special->getPageTitle()->getCanonicalURL( $query );
1093 $req = (
1094 "POST $url HTTP/1.1\r\n" .
1095 "Host: {$info['host']}\r\n" .
1096 "Connection: Close\r\n" .
1097 "Content-Length: 0\r\n\r\n"
1098 );
1099
1100 $runJobsLogger->info( "Running $n job(s) via '$url'" );
1101 // Send a cron API request to be performed in the background.
1102 // Give up if this takes too long to send (which should be rare).
1103 stream_set_timeout( $sock, 2 );
1104 $bytes = fwrite( $sock, $req );
1105 if ( $bytes !== strlen( $req ) ) {
1106 $invokedWithSuccess = false;
1107 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
1108 } else {
1109 // Do not wait for the response (the script should handle client aborts).
1110 // Make sure that we don't close before that script reaches ignore_user_abort().
1111 $start = microtime( true );
1112 $status = fgets( $sock );
1113 $sec = microtime( true ) - $start;
1114 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
1115 $invokedWithSuccess = false;
1116 $runJobsLogger->error( "Failed to start cron API: received '$status' ($sec)" );
1117 }
1118 }
1119 fclose( $sock );
1120 } else {
1121 $invokedWithSuccess = false;
1122 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
1123 }
1124
1125 return $invokedWithSuccess;
1126 }
1127}
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'] !='') if(! $wgEnableAPI) $wgTitle
Definition api.php:68
Actions are things which can be done to pages (edit, delete, rollback, etc).
Definition Action.php:37
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition Action.php:95
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition Action.php:122
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:152
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
static singleton( $domain=false)
Job queue runner utility methods.
Definition JobRunner.php:40
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.
maybeDoHttpsRedirect()
If the stars are suitably aligned, do an HTTP->HTTPS redirect.
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.
shouldDoHttpRedirect()
Check if an HTTP->HTTPS redirect should be done.
static singleton()
Get the signleton instance of this class.
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 getMain()
Get the RequestContext object associated with the main request.
A statsd client that applies the sampling rate to the data items before sending them.
static executePath(Title &$title, IContextSource &$context, $including=false, LinkRenderer $linkRenderer=null)
Execute a special page path.
static getPage( $name)
Find the object with a given name and return it (or NULL)
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
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:3824
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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
const PROTO_HTTPS
Definition Defines.php:230
const NS_FILE
Definition Defines.php:80
const PROTO_CURRENT
Definition Defines.php:232
const NS_MAIN
Definition Defines.php:74
const PROTO_INTERNAL
Definition Defines.php:234
const NS_SPECIAL
Definition Defines.php:63
const NS_MEDIA
Definition Defines.php:62
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:990
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:2806
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2255
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:2001
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition hooks.txt:77
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:2811
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:964
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title 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:2273
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:2005
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. '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:1255
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition hooks.txt:998
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:1620
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:1777
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:2176
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.