3 * Helper class for the index.php entry point.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Logger\LoggerFactory
;
26 * The MediaWiki class is the helper class for the index.php entry point.
40 * @var String Cache what action this request is
45 * @param IContextSource|null $context
47 public function __construct( IContextSource
$context = null ) {
49 $context = RequestContext
::getMain();
52 $this->context
= $context;
53 $this->config
= $context->getConfig();
57 * Parse the request to get the Title object
59 * @throws MalformedTitleException If a title has been provided by the user, but is invalid.
60 * @return Title Title object to be $wgTitle
62 private function parseTitle() {
65 $request = $this->context
->getRequest();
66 $curid = $request->getInt( 'curid' );
67 $title = $request->getVal( 'title' );
68 $action = $request->getVal( 'action' );
70 if ( $request->getCheck( 'search' ) ) {
71 // Compatibility with old search URLs which didn't use Special:Search
72 // Just check for presence here, so blank requests still
73 // show the search page when using ugly URLs (bug 8054).
74 $ret = SpecialPage
::getTitleFor( 'Search' );
76 // URLs like this are generated by RC, because rc_title isn't always accurate
77 $ret = Title
::newFromID( $curid );
79 $ret = Title
::newFromURL( $title );
80 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
81 // in wikitext links to tell Parser to make a direct file link
82 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA
) {
83 $ret = Title
::makeTitle( NS_FILE
, $ret->getDBkey() );
85 // Check variant links so that interwiki links don't have to worry
86 // about the possible different language variants
87 if ( count( $wgContLang->getVariants() ) > 1
88 && !is_null( $ret ) && $ret->getArticleID() == 0
90 $wgContLang->findVariantLink( $title, $ret );
94 // If title is not provided, always allow oldid and diff to set the title.
95 // If title is provided, allow oldid and diff to override the title, unless
96 // we are talking about a special page which might use these parameters for
98 if ( $ret === null ||
!$ret->isSpecialPage() ) {
99 // We can have urls with just ?diff=,?oldid= or even just ?diff=
100 $oldid = $request->getInt( 'oldid' );
101 $oldid = $oldid ?
$oldid : $request->getInt( 'diff' );
102 // Allow oldid to override a changed or missing title
104 $rev = Revision
::newFromId( $oldid );
105 $ret = $rev ?
$rev->getTitle() : $ret;
109 // Use the main page as default title if nothing else has been provided
111 && strval( $title ) === ''
112 && !$request->getCheck( 'curid' )
113 && $action !== 'delete'
115 $ret = Title
::newMainPage();
118 if ( $ret === null ||
( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
119 // If we get here, we definitely don't have a valid title; throw an exception.
120 // Try to get detailed invalid title exception first, fall back to MalformedTitleException.
121 Title
::newFromTextThrow( $title );
122 throw new MalformedTitleException( 'badtitletext', $title );
129 * Get the Title object that we'll be acting on, as specified in the WebRequest
132 public function getTitle() {
133 if ( !$this->context
->hasTitle() ) {
135 $this->context
->setTitle( $this->parseTitle() );
136 } catch ( MalformedTitleException
$ex ) {
137 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
140 return $this->context
->getTitle();
144 * Returns the name of the action that will be executed.
146 * @return string Action
148 public function getAction() {
149 if ( $this->action
=== null ) {
150 $this->action
= Action
::getActionName( $this->context
);
153 return $this->action
;
157 * Performs the request.
160 * - local interwiki redirects
165 * @throws MWException|PermissionsError|BadTitleError|HttpError
168 private function performRequest() {
171 $request = $this->context
->getRequest();
172 $requestTitle = $title = $this->context
->getTitle();
173 $output = $this->context
->getOutput();
174 $user = $this->context
->getUser();
176 if ( $request->getVal( 'printable' ) === 'yes' ) {
177 $output->setPrintable();
180 $unused = null; // To pass it by reference
181 Hooks
::run( 'BeforeInitialize', [ &$title, &$unused, &$output, &$user, $request, $this ] );
183 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
184 if ( is_null( $title ) ||
( $title->getDBkey() == '' && !$title->isExternal() )
185 ||
$title->isSpecial( 'Badtitle' )
187 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
190 } catch ( MalformedTitleException
$ex ) {
191 throw new BadTitleError( $ex );
193 throw new BadTitleError();
196 // Check user's permissions to read this page.
197 // We have to check here to catch special pages etc.
198 // We will check again in Article::view().
199 $permErrors = $title->isSpecial( 'RunJobs' )
200 ?
[] // relies on HMAC key signature alone
201 : $title->getUserPermissionsErrors( 'read', $user );
202 if ( count( $permErrors ) ) {
203 // Bug 32276: allowing the skin to generate output with $wgTitle or
204 // $this->context->title set to the input title would allow anonymous users to
205 // determine whether a page exists, potentially leaking private data. In fact, the
206 // curid and oldid request parameters would allow page titles to be enumerated even
207 // when they are not guessable. So we reset the title to Special:Badtitle before the
208 // permissions error is displayed.
210 // The skin mostly uses $this->context->getTitle() these days, but some extensions
211 // still use $wgTitle.
212 $badTitle = SpecialPage
::getTitleFor( 'Badtitle' );
213 $this->context
->setTitle( $badTitle );
214 $wgTitle = $badTitle;
216 throw new PermissionsError( 'read', $permErrors );
219 // Interwiki redirects
220 if ( $title->isExternal() ) {
221 $rdfrom = $request->getVal( 'rdfrom' );
223 $url = $title->getFullURL( [ 'rdfrom' => $rdfrom ] );
225 $query = $request->getValues();
226 unset( $query['title'] );
227 $url = $title->getFullURL( $query );
229 // Check for a redirect loop
230 if ( !preg_match( '/^' . preg_quote( $this->config
->get( 'Server' ), '/' ) . '/', $url )
233 // 301 so google et al report the target as the actual url.
234 $output->redirect( $url, 301 );
236 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
239 } catch ( MalformedTitleException
$ex ) {
240 throw new BadTitleError( $ex );
242 throw new BadTitleError();
244 // Handle any other redirects.
245 // Redirect loops, titleless URL, $wgUsePathInfo URLs, and URLs with a variant
246 } elseif ( !$this->tryNormaliseRedirect( $title ) ) {
247 // Prevent information leak via Special:MyPage et al (T109724)
248 if ( $title->isSpecialPage() ) {
249 $specialPage = SpecialPageFactory
::getPage( $title->getDBkey() );
250 if ( $specialPage instanceof RedirectSpecialPage
) {
251 $specialPage->setContext( $this->context
);
252 if ( $this->config
->get( 'HideIdentifiableRedirects' )
253 && $specialPage->personallyIdentifiableTarget()
255 list( , $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
256 $target = $specialPage->getRedirect( $subpage );
257 // target can also be true. We let that case fall through to normal processing.
258 if ( $target instanceof Title
) {
259 $query = $specialPage->getRedirectQuery() ?
: [];
260 $request = new DerivativeRequest( $this->context
->getRequest(), $query );
261 $request->setRequestURL( $this->context
->getRequest()->getRequestURL() );
262 $this->context
->setRequest( $request );
263 // Do not varnish cache these. May vary even for anons
264 $this->context
->getOutput()->lowerCdnMaxage( 0 );
265 $this->context
->setTitle( $target );
267 // Reset action type cache. (Special pages have only view)
268 $this->action
= null;
270 $output->addJsConfigVars( [
271 'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
273 $output->addModules( 'mediawiki.action.view.redirect' );
279 // Special pages ($title may have changed since if statement above)
280 if ( NS_SPECIAL
== $title->getNamespace() ) {
281 // Actions that need to be made when we have a special pages
282 SpecialPageFactory
::executePath( $title, $this->context
);
284 // ...otherwise treat it as an article view. The article
285 // may still be a wikipage redirect to another article or URL.
286 $article = $this->initializeArticle();
287 if ( is_object( $article ) ) {
288 $this->performAction( $article, $requestTitle );
289 } elseif ( is_string( $article ) ) {
290 $output->redirect( $article );
292 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
293 . " returned neither an object nor a URL" );
300 * Handle redirects for uncanonical title requests.
305 * - $wgUsePathInfo URLs.
306 * - URLs with a variant.
307 * - Other non-standard URLs (as long as they have no extra query parameters).
310 * - Normalise title values:
311 * /wiki/Foo%20Bar -> /wiki/Foo_Bar
312 * - Normalise empty title:
313 * /wiki/ -> /wiki/Main
314 * /w/index.php?title= -> /wiki/Main
315 * - Normalise non-standard title urls:
316 * /w/index.php?title=Foo_Bar -> /wiki/Foo_Bar
317 * - Don't redirect anything with query parameters other than 'title' or 'action=view'.
319 * @param Title $title
320 * @return bool True if a redirect was set.
323 private function tryNormaliseRedirect( Title
$title ) {
324 $request = $this->context
->getRequest();
325 $output = $this->context
->getOutput();
327 if ( $request->getVal( 'action', 'view' ) != 'view'
328 ||
$request->wasPosted()
329 ||
count( $request->getValueNames( [ 'action', 'title' ] ) )
330 ||
!Hooks
::run( 'TestCanonicalRedirect', [ $request, $title, $output ] )
335 if ( $title->isSpecialPage() ) {
336 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
338 $title = SpecialPage
::getTitleFor( $name, $subpage );
341 // Redirect to canonical url, make it a 301 to allow caching
342 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
344 if ( $targetUrl != $request->getFullRequestURL() ) {
345 $output->setCdnMaxage( 1200 );
346 $output->redirect( $targetUrl, '301' );
350 // If there is no title, or the title is in a non-standard encoding, we demand
351 // a redirect. If cgi somehow changed the 'title' query to be non-standard while
352 // the url is standard, the server is misconfigured.
353 if ( $request->getVal( 'title' ) === null
354 ||
$title->getPrefixedDBkey() != $request->getVal( 'title' )
356 $message = "Redirect loop detected!\n\n" .
357 "This means the wiki got confused about what page was " .
358 "requested; this sometimes happens when moving a wiki " .
359 "to a new server or changing the server configuration.\n\n";
361 if ( $this->config
->get( 'UsePathInfo' ) ) {
362 $message .= "The wiki is trying to interpret the page " .
363 "title from the URL path portion (PATH_INFO), which " .
364 "sometimes fails depending on the web server. Try " .
365 "setting \"\$wgUsePathInfo = false;\" in your " .
366 "LocalSettings.php, or check that \$wgArticlePath " .
369 $message .= "Your web server was detected as possibly not " .
370 "supporting URL path components (PATH_INFO) correctly; " .
371 "check your LocalSettings.php for a customized " .
372 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
375 throw new HttpError( 500, $message );
381 * Initialize the main Article object for "standard" actions (view, etc)
382 * Create an Article object for the page, following redirects if needed.
384 * @return Article|string An Article, or a string to redirect to another URL
386 private function initializeArticle() {
387 $title = $this->context
->getTitle();
388 if ( $this->context
->canUseWikiPage() ) {
389 // Try to use request context wiki page, as there
390 // is already data from db saved in per process
391 // cache there from this->getAction() call.
392 $page = $this->context
->getWikiPage();
394 // This case should not happen, but just in case.
395 // @TODO: remove this or use an exception
396 $page = WikiPage
::factory( $title );
397 $this->context
->setWikiPage( $page );
398 wfWarn( "RequestContext::canUseWikiPage() returned false" );
401 // Make GUI wrapper for the WikiPage
402 $article = Article
::newFromWikiPage( $page, $this->context
);
404 // Skip some unnecessary code if the content model doesn't support redirects
405 if ( !ContentHandler
::getForTitle( $title )->supportsRedirects() ) {
409 $request = $this->context
->getRequest();
411 // Namespace might change when using redirects
412 // Check for redirects ...
413 $action = $request->getVal( 'action', 'view' );
414 $file = ( $page instanceof WikiFilePage
) ?
$page->getFile() : null;
415 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
416 && !$request->getVal( 'oldid' ) // ... and are not old revisions
417 && !$request->getVal( 'diff' ) // ... and not when showing diff
418 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
419 // ... and the article is not a non-redirect image page with associated file
420 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
422 // Give extensions a change to ignore/handle redirects as needed
423 $ignoreRedirect = $target = false;
425 Hooks
::run( 'InitializeArticleMaybeRedirect',
426 [ &$title, &$request, &$ignoreRedirect, &$target, &$article ] );
427 $page = $article->getPage(); // reflect any hook changes
429 // Follow redirects only for... redirects.
430 // If $target is set, then a hook wanted to redirect.
431 if ( !$ignoreRedirect && ( $target ||
$page->isRedirect() ) ) {
432 // Is the target already set by an extension?
433 $target = $target ?
$target : $page->followRedirect();
434 if ( is_string( $target ) ) {
435 if ( !$this->config
->get( 'DisableHardRedirects' ) ) {
436 // we'll need to redirect
440 if ( is_object( $target ) ) {
441 // Rewrite environment to redirected article
442 $rpage = WikiPage
::factory( $target );
443 $rpage->loadPageData();
444 if ( $rpage->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
445 $rarticle = Article
::newFromWikiPage( $rpage, $this->context
);
446 $rarticle->setRedirectedFrom( $title );
448 $article = $rarticle;
449 $this->context
->setTitle( $target );
450 $this->context
->setWikiPage( $article->getPage() );
454 // Article may have been changed by hook
455 $this->context
->setTitle( $article->getTitle() );
456 $this->context
->setWikiPage( $article->getPage() );
464 * Perform one of the "standard" actions
467 * @param Title $requestTitle The original title, before any redirects were applied
469 private function performAction( Page
$page, Title
$requestTitle ) {
470 $request = $this->context
->getRequest();
471 $output = $this->context
->getOutput();
472 $title = $this->context
->getTitle();
473 $user = $this->context
->getUser();
475 if ( !Hooks
::run( 'MediaWikiPerformAction',
476 [ $output, $page, $title, $user, $request, $this ] )
481 $act = $this->getAction();
482 $action = Action
::factory( $act, $page, $this->context
);
484 if ( $action instanceof Action
) {
485 // Narrow DB query expectations for this HTTP request
486 $trxLimits = $this->config
->get( 'TrxProfilerLimits' );
487 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
488 if ( $request->wasPosted() && !$action->doesWrites() ) {
489 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__
);
492 # Let CDN cache things if we can purge them.
493 if ( $this->config
->get( 'UseSquid' ) &&
495 // Use PROTO_INTERNAL because that's what getCdnUrls() uses
496 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL
),
497 $requestTitle->getCdnUrls()
500 $output->setCdnMaxage( $this->config
->get( 'SquidMaxage' ) );
507 if ( Hooks
::run( 'UnknownAction', [ $request->getVal( 'action', 'view' ), $page ] ) ) {
508 $output->setStatusCode( 404 );
509 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
514 * Run the current MediaWiki instance; index.php just calls this
516 public function run() {
520 } catch ( ErrorPageError
$e ) {
521 // Bug 62091: while exceptions are convenient to bubble up GUI errors,
522 // they are not internal application faults. As with normal requests, this
523 // should commit, print the output, do deferred updates, jobs, and profiling.
524 $this->doPreOutputCommit();
525 $e->report(); // display the GUI error
527 } catch ( Exception
$e ) {
528 MWExceptionHandler
::handleException( $e );
531 $this->doPostOutputShutdown( 'normal' );
535 * @see MediaWiki::preOutputCommit()
538 public function doPreOutputCommit() {
539 self
::preOutputCommit( $this->context
);
543 * This function commits all DB changes as needed before
544 * the user can receive a response (in case commit fails)
546 * @param IContextSource $context
549 public static function preOutputCommit( IContextSource
$context ) {
550 // Either all DBs should commit or none
551 ignore_user_abort( true );
553 $config = $context->getConfig();
555 $factory = wfGetLBFactory();
556 // Commit all changes
557 $factory->commitMasterChanges(
559 // Abort if any transaction was too big
560 [ 'maxWriteDuration' => $config->get( 'MaxUserDBWriteDuration' ) ]
562 // Record ChronologyProtector positions
563 $factory->shutdown();
564 wfDebug( __METHOD__
. ': all transactions committed' );
566 DeferredUpdates
::doUpdates( 'enqueue', DeferredUpdates
::PRESEND
);
567 wfDebug( __METHOD__
. ': pre-send deferred updates completed' );
569 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
570 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
571 // ChronologyProtector works for cacheable URLs.
572 $request = $context->getRequest();
573 if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
574 $expires = time() +
$config->get( 'DataCenterUpdateStickTTL' );
575 $options = [ 'prefix' => '' ];
576 $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
577 $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
580 // Avoid letting a few seconds of slave lag cause a month of stale data. This logic is
581 // also intimately related to the value of $wgCdnReboundPurgeDelay.
582 if ( $factory->laggedSlaveUsed() ) {
583 $maxAge = $config->get( 'CdnMaxageLagged' );
584 $context->getOutput()->lowerCdnMaxage( $maxAge );
585 $request->response()->header( "X-Database-Lagged: true" );
586 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
591 * This function does work that can be done *after* the
592 * user gets the HTTP response so they don't block on it
594 * This manages deferred updates, job insertion,
595 * final commit, and the logging of profiling data
597 * @param string $mode Use 'fast' to always skip job running
600 public function doPostOutputShutdown( $mode = 'normal' ) {
601 $timing = $this->context
->getTiming();
602 $timing->mark( 'requestShutdown' );
604 // Show visible profiling data if enabled (which cannot be post-send)
605 Profiler
::instance()->logDataPageOutputOnly();
608 $callback = function () use ( $that, $mode ) {
610 $that->restInPeace( $mode );
611 } catch ( Exception
$e ) {
612 MWExceptionHandler
::handleException( $e );
616 // Defer everything else...
617 if ( function_exists( 'register_postsend_function' ) ) {
618 // https://github.com/facebook/hhvm/issues/1230
619 register_postsend_function( $callback );
621 if ( function_exists( 'fastcgi_finish_request' ) ) {
622 fastcgi_finish_request();
624 // Either all DB and deferred updates should happen or none.
625 // The later should not be cancelled due to client disconnect.
626 ignore_user_abort( true );
633 private function main() {
636 $request = $this->context
->getRequest();
638 // Send Ajax requests to the Ajax dispatcher.
639 if ( $this->config
->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
640 // Set a dummy title, because $wgTitle == null might break things
641 $title = Title
::makeTitle( NS_SPECIAL
, 'Badtitle/performing an AJAX call in '
644 $this->context
->setTitle( $title );
647 $dispatcher = new AjaxDispatcher( $this->config
);
648 $dispatcher->performAction( $this->context
->getUser() );
652 // Get title from request parameters,
653 // is set on the fly by parseTitle the first time.
654 $title = $this->getTitle();
655 $action = $this->getAction();
658 // Set DB query expectations for this HTTP request
659 $trxLimits = $this->config
->get( 'TrxProfilerLimits' );
660 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
661 $trxProfiler->setLogger( LoggerFactory
::getInstance( 'DBPerformance' ) );
662 if ( $request->wasPosted() ) {
663 $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__
);
665 $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__
);
668 // If the user has forceHTTPS set to true, or if the user
669 // is in a group requiring HTTPS, or if they have the HTTPS
670 // preference set, redirect them to HTTPS.
671 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
672 // isLoggedIn() will do all sorts of weird stuff.
674 $request->getProtocol() == 'http' &&
676 $request->getSession()->shouldForceHTTPS() ||
677 // Check the cookie manually, for paranoia
678 $request->getCookie( 'forceHTTPS', '' ) ||
679 // check for prefixed version that was used for a time in older MW versions
680 $request->getCookie( 'forceHTTPS' ) ||
681 // Avoid checking the user and groups unless it's enabled.
683 $this->context
->getUser()->isLoggedIn()
684 && $this->context
->getUser()->requiresHTTPS()
688 $oldUrl = $request->getFullRequestURL();
689 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
691 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
692 if ( Hooks
::run( 'BeforeHttpsRedirect', [ $this->context
, &$redirUrl ] ) ) {
694 if ( $request->wasPosted() ) {
695 // This is weird and we'd hope it almost never happens. This
696 // means that a POST came in via HTTP and policy requires us
697 // redirecting to HTTPS. It's likely such a request is going
698 // to fail due to post data being lost, but let's try anyway
699 // and just log the instance.
701 // @todo FIXME: See if we could issue a 307 or 308 here, need
702 // to see how clients (automated & browser) behave when we do
703 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
705 // Setup dummy Title, otherwise OutputPage::redirect will fail
706 $title = Title
::newFromText( 'REDIR', NS_MAIN
);
707 $this->context
->setTitle( $title );
708 $output = $this->context
->getOutput();
709 // Since we only do this redir to change proto, always send a vary header
710 $output->addVaryHeader( 'X-Forwarded-Proto' );
711 $output->redirect( $redirUrl );
717 if ( $this->config
->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
718 if ( HTMLFileCache
::useFileCache( $this->context
) ) {
719 // Try low-level file cache hit
720 $cache = new HTMLFileCache( $title, $action );
721 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
722 // Check incoming headers to see if client has this cached
723 $timestamp = $cache->cacheTimestamp();
724 if ( !$this->context
->getOutput()->checkLastModified( $timestamp ) ) {
725 $cache->loadFromFileCache( $this->context
);
727 // Do any stats increment/watchlist stuff
728 // Assume we're viewing the latest revision (this should always be the case with file cache)
729 $this->context
->getWikiPage()->doViewUpdates( $this->context
->getUser() );
730 // Tell OutputPage that output is taken care of
731 $this->context
->getOutput()->disable();
737 // Actually do the work of the request and build up any output
738 $this->performRequest();
740 // Now commit any transactions, so that unreported errors after
741 // output() don't roll back the whole DB transaction and so that
742 // we avoid having both success and error text in the response
743 $this->doPreOutputCommit();
745 // Output everything!
746 $this->context
->getOutput()->output();
750 * Ends this task peacefully
751 * @param string $mode Use 'fast' to always skip job running
753 public function restInPeace( $mode = 'fast' ) {
754 // Assure deferred updates are not in the main transaction
755 wfGetLBFactory()->commitMasterChanges( __METHOD__
);
757 // Ignore things like master queries/connections on GET requests
758 // as long as they are in deferred updates (which catch errors).
759 Profiler
::instance()->getTransactionProfiler()->resetExpectations();
761 // Do any deferred jobs
762 DeferredUpdates
::doUpdates( 'enqueue' );
764 // Make sure any lazy jobs are pushed
765 JobQueueGroup
::pushLazyJobs();
767 // Now that everything specific to this request is done,
768 // try to occasionally run jobs (if enabled) from the queues
769 if ( $mode === 'normal' ) {
770 $this->triggerJobs();
773 // Log profiling data, e.g. in the database or UDP
774 wfLogProfilingData();
776 // Commit and close up!
777 $factory = wfGetLBFactory();
778 $factory->commitMasterChanges( __METHOD__
);
779 $factory->shutdown( LBFactory
::SHUTDOWN_NO_CHRONPROT
);
781 wfDebug( "Request ended normally\n" );
785 * Potentially open a socket and sent an HTTP request back to the server
786 * to run a specified number of jobs. This registers a callback to cleanup
787 * the socket once it's done.
789 public function triggerJobs() {
790 $jobRunRate = $this->config
->get( 'JobRunRate' );
791 if ( $jobRunRate <= 0 ||
wfReadOnly() ) {
793 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
794 return; // recursion guard
797 if ( $jobRunRate < 1 ) {
798 $max = mt_getrandmax();
799 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
800 return; // the higher the job run rate, the less likely we return here
804 $n = intval( $jobRunRate );
807 $runJobsLogger = LoggerFactory
::getInstance( 'runJobs' );
809 if ( !$this->config
->get( 'RunJobsAsync' ) ) {
810 // Fall back to running the job here while the user waits
811 $runner = new JobRunner( $runJobsLogger );
812 $runner->run( [ 'maxJobs' => $n ] );
817 if ( !JobQueueGroup
::singleton()->queuesHaveJobs( JobQueueGroup
::TYPE_DEFAULT
) ) {
818 return; // do not send request if there are probably no jobs
820 } catch ( JobQueueError
$e ) {
821 MWExceptionHandler
::logException( $e );
822 return; // do not make the site unavailable
825 $query = [ 'title' => 'Special:RunJobs',
826 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() +
5 ];
827 $query['signature'] = SpecialRunJobs
::getQuerySignature(
828 $query, $this->config
->get( 'SecretKey' ) );
830 $errno = $errstr = null;
831 $info = wfParseUrl( $this->config
->get( 'Server' ) );
832 MediaWiki\
suppressWarnings();
833 $host = $info['host'];
835 if ( isset( $info['scheme'] ) && $info['scheme'] == 'https' ) {
836 $host = "tls://" . $host;
839 if ( isset( $info['port'] ) ) {
840 $port = $info['port'];
847 // If it takes more than 100ms to connect to ourselves there
848 // is a problem elsewhere.
851 MediaWiki\restoreWarnings
();
853 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
854 // Fall back to running the job here while the user waits
855 $runner = new JobRunner( $runJobsLogger );
856 $runner->run( [ 'maxJobs' => $n ] );
860 $url = wfAppendQuery( wfScript( 'index' ), $query );
862 "POST $url HTTP/1.1\r\n" .
863 "Host: {$info['host']}\r\n" .
864 "Connection: Close\r\n" .
865 "Content-Length: 0\r\n\r\n"
868 $runJobsLogger->info( "Running $n job(s) via '$url'" );
869 // Send a cron API request to be performed in the background.
870 // Give up if this takes too long to send (which should be rare).
871 stream_set_timeout( $sock, 1 );
872 $bytes = fwrite( $sock, $req );
873 if ( $bytes !== strlen( $req ) ) {
874 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
876 // Do not wait for the response (the script should handle client aborts).
877 // Make sure that we don't close before that script reaches ignore_user_abort().
878 $status = fgets( $sock );
879 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
880 $runJobsLogger->error( "Failed to start cron API: received '$status'" );