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', array( &$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 ?
array() // 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( array( '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 && $this->config
->get( 'HideIdentifiableRedirects' )
252 && $specialPage->personallyIdentifiableTarget()
254 list( , $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBKey() );
255 $target = $specialPage->getRedirect( $subpage );
256 // target can also be true. We let that case fall through to normal processing.
257 if ( $target instanceof Title
) {
258 $query = $specialPage->getRedirectQuery() ?
: array();
259 $request = new DerivativeRequest( $this->context
->getRequest(), $query );
260 $request->setRequestURL( $this->context
->getRequest()->getRequestURL() );
261 $this->context
->setRequest( $request );
262 // Do not varnish cache these. May vary even for anons
263 $this->context
->getOutput()->lowerCdnMaxage( 0 );
264 $this->context
->setTitle( $target );
266 // Reset action type cache. (Special pages have only view)
267 $this->action
= null;
269 $output->addJsConfigVars( array(
270 'wgInternalRedirectTargetUrl' => $target->getFullURL( $query ),
272 $output->addModules( 'mediawiki.action.view.redirect' );
277 // Special pages ($title may have changed since if statement above)
278 if ( NS_SPECIAL
== $title->getNamespace() ) {
279 // Actions that need to be made when we have a special pages
280 SpecialPageFactory
::executePath( $title, $this->context
);
282 // ...otherwise treat it as an article view. The article
283 // may still be a wikipage redirect to another article or URL.
284 $article = $this->initializeArticle();
285 if ( is_object( $article ) ) {
286 $this->performAction( $article, $requestTitle );
287 } elseif ( is_string( $article ) ) {
288 $output->redirect( $article );
290 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
291 . " returned neither an object nor a URL" );
298 * Handle redirects for uncanonical title requests.
303 * - $wgUsePathInfo URLs.
304 * - URLs with a variant.
305 * - Other non-standard URLs (as long as they have no extra query parameters).
308 * - Normalise title values:
309 * /wiki/Foo%20Bar -> /wiki/Foo_Bar
310 * - Normalise empty title:
311 * /wiki/ -> /wiki/Main
312 * /w/index.php?title= -> /wiki/Main
313 * - Normalise non-standard title urls:
314 * /w/index.php?title=Foo_Bar -> /wiki/Foo_Bar
315 * - Don't redirect anything with query parameters other than 'title' or 'action=view'.
317 * @param Title $title
318 * @return bool True if a redirect was set.
321 private function tryNormaliseRedirect( Title
$title ) {
322 $request = $this->context
->getRequest();
323 $output = $this->context
->getOutput();
325 if ( $request->getVal( 'action', 'view' ) != 'view'
326 ||
$request->wasPosted()
327 ||
count( $request->getValueNames( array( 'action', 'title' ) ) )
328 ||
!Hooks
::run( 'TestCanonicalRedirect', array( $request, $title, $output ) )
333 if ( $title->isSpecialPage() ) {
334 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
336 $title = SpecialPage
::getTitleFor( $name, $subpage );
339 // Redirect to canonical url, make it a 301 to allow caching
340 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
342 if ( $targetUrl != $request->getFullRequestURL() ) {
343 $output->setCdnMaxage( 1200 );
344 $output->redirect( $targetUrl, '301' );
348 // If there is no title, or the title is in a non-standard encoding, we demand
349 // a redirect. If cgi somehow changed the 'title' query to be non-standard while
350 // the url is standard, the server is misconfigured.
351 if ( $request->getVal( 'title' ) === null
352 ||
$title->getPrefixedDBkey() != $request->getVal( 'title' )
354 $message = "Redirect loop detected!\n\n" .
355 "This means the wiki got confused about what page was " .
356 "requested; this sometimes happens when moving a wiki " .
357 "to a new server or changing the server configuration.\n\n";
359 if ( $this->config
->get( 'UsePathInfo' ) ) {
360 $message .= "The wiki is trying to interpret the page " .
361 "title from the URL path portion (PATH_INFO), which " .
362 "sometimes fails depending on the web server. Try " .
363 "setting \"\$wgUsePathInfo = false;\" in your " .
364 "LocalSettings.php, or check that \$wgArticlePath " .
367 $message .= "Your web server was detected as possibly not " .
368 "supporting URL path components (PATH_INFO) correctly; " .
369 "check your LocalSettings.php for a customized " .
370 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
373 throw new HttpError( 500, $message );
379 * Initialize the main Article object for "standard" actions (view, etc)
380 * Create an Article object for the page, following redirects if needed.
382 * @return Article|string An Article, or a string to redirect to another URL
384 private function initializeArticle() {
385 $title = $this->context
->getTitle();
386 if ( $this->context
->canUseWikiPage() ) {
387 // Try to use request context wiki page, as there
388 // is already data from db saved in per process
389 // cache there from this->getAction() call.
390 $page = $this->context
->getWikiPage();
392 // This case should not happen, but just in case.
393 // @TODO: remove this or use an exception
394 $page = WikiPage
::factory( $title );
395 $this->context
->setWikiPage( $page );
396 wfWarn( "RequestContext::canUseWikiPage() returned false" );
399 // Make GUI wrapper for the WikiPage
400 $article = Article
::newFromWikiPage( $page, $this->context
);
402 // Skip some unnecessary code if the content model doesn't support redirects
403 if ( !ContentHandler
::getForTitle( $title )->supportsRedirects() ) {
407 $request = $this->context
->getRequest();
409 // Namespace might change when using redirects
410 // Check for redirects ...
411 $action = $request->getVal( 'action', 'view' );
412 $file = ( $page instanceof WikiFilePage
) ?
$page->getFile() : null;
413 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
414 && !$request->getVal( 'oldid' ) // ... and are not old revisions
415 && !$request->getVal( 'diff' ) // ... and not when showing diff
416 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
417 // ... and the article is not a non-redirect image page with associated file
418 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
420 // Give extensions a change to ignore/handle redirects as needed
421 $ignoreRedirect = $target = false;
423 Hooks
::run( 'InitializeArticleMaybeRedirect',
424 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
425 $page = $article->getPage(); // reflect any hook changes
427 // Follow redirects only for... redirects.
428 // If $target is set, then a hook wanted to redirect.
429 if ( !$ignoreRedirect && ( $target ||
$page->isRedirect() ) ) {
430 // Is the target already set by an extension?
431 $target = $target ?
$target : $page->followRedirect();
432 if ( is_string( $target ) ) {
433 if ( !$this->config
->get( 'DisableHardRedirects' ) ) {
434 // we'll need to redirect
438 if ( is_object( $target ) ) {
439 // Rewrite environment to redirected article
440 $rpage = WikiPage
::factory( $target );
441 $rpage->loadPageData();
442 if ( $rpage->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
443 $rarticle = Article
::newFromWikiPage( $rpage, $this->context
);
444 $rarticle->setRedirectedFrom( $title );
446 $article = $rarticle;
447 $this->context
->setTitle( $target );
448 $this->context
->setWikiPage( $article->getPage() );
452 // Article may have been changed by hook
453 $this->context
->setTitle( $article->getTitle() );
454 $this->context
->setWikiPage( $article->getPage() );
462 * Perform one of the "standard" actions
465 * @param Title $requestTitle The original title, before any redirects were applied
467 private function performAction( Page
$page, Title
$requestTitle ) {
468 $request = $this->context
->getRequest();
469 $output = $this->context
->getOutput();
470 $title = $this->context
->getTitle();
471 $user = $this->context
->getUser();
473 if ( !Hooks
::run( 'MediaWikiPerformAction',
474 array( $output, $page, $title, $user, $request, $this ) )
479 $act = $this->getAction();
480 $action = Action
::factory( $act, $page, $this->context
);
482 if ( $action instanceof Action
) {
483 // Narrow DB query expectations for this HTTP request
484 $trxLimits = $this->config
->get( 'TrxProfilerLimits' );
485 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
486 if ( $request->wasPosted() && !$action->doesWrites() ) {
487 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__
);
490 # Let CDN cache things if we can purge them.
491 if ( $this->config
->get( 'UseSquid' ) &&
493 // Use PROTO_INTERNAL because that's what getCdnUrls() uses
494 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL
),
495 $requestTitle->getCdnUrls()
498 $output->setCdnMaxage( $this->config
->get( 'SquidMaxage' ) );
505 if ( Hooks
::run( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
506 $output->setStatusCode( 404 );
507 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
512 * Run the current MediaWiki instance; index.php just calls this
514 public function run() {
518 } catch ( ErrorPageError
$e ) {
519 // Bug 62091: 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
525 } catch ( Exception
$e ) {
526 MWExceptionHandler
::handleException( $e );
529 $this->doPostOutputShutdown( 'normal' );
533 * @see MediaWiki::preOutputCommit()
536 public function doPreOutputCommit() {
537 self
::preOutputCommit( $this->context
);
541 * This function commits all DB changes as needed before
542 * the user can receive a response (in case commit fails)
544 * @param IContextSource $context
547 public static function preOutputCommit( IContextSource
$context ) {
548 // Either all DBs should commit or none
549 ignore_user_abort( true );
551 $config = $context->getConfig();
553 $factory = wfGetLBFactory();
554 // Check if any transaction was too big
555 $limit = $config->get( 'MaxUserDBWriteDuration' );
556 $factory->forEachLB( function ( LoadBalancer
$lb ) use ( $limit ) {
557 $lb->forEachOpenConnection( function ( IDatabase
$db ) use ( $limit ) {
558 $time = $db->pendingWriteQueryDuration();
559 if ( $limit > 0 && $time > $limit ) {
560 throw new DBTransactionError(
562 wfMessage( 'transaction-duration-limit-exceeded', $time, $limit )->text()
567 // Commit all changes
568 $factory->commitMasterChanges( __METHOD__
);
569 // Record ChronologyProtector positions
570 $factory->shutdown();
571 wfDebug( __METHOD__
. ': all transactions committed' );
573 DeferredUpdates
::doUpdates( 'enqueue', DeferredUpdates
::PRESEND
);
574 wfDebug( __METHOD__
. ': pre-send deferred updates completed' );
576 // Set a cookie to tell all CDN edge nodes to "stick" the user to the DC that handles this
577 // POST request (e.g. the "master" data center). Also have the user briefly bypass CDN so
578 // ChronologyProtector works for cacheable URLs.
579 $request = $context->getRequest();
580 if ( $request->wasPosted() && $factory->hasOrMadeRecentMasterChanges() ) {
581 $expires = time() +
$config->get( 'DataCenterUpdateStickTTL' );
582 $options = array( 'prefix' => '' );
583 $request->response()->setCookie( 'UseDC', 'master', $expires, $options );
584 $request->response()->setCookie( 'UseCDNCache', 'false', $expires, $options );
587 // Avoid letting a few seconds of slave lag cause a month of stale data. This logic is
588 // also intimately related to the value of $wgCdnReboundPurgeDelay.
589 if ( $factory->laggedSlaveUsed() ) {
590 $maxAge = $config->get( 'CdnMaxageLagged' );
591 $context->getOutput()->lowerCdnMaxage( $maxAge );
592 $request->response()->header( "X-Database-Lagged: true" );
593 wfDebugLog( 'replication', "Lagged DB used; CDN cache TTL limited to $maxAge seconds" );
598 * This function does work that can be done *after* the
599 * user gets the HTTP response so they don't block on it
601 * This manages deferred updates, job insertion,
602 * final commit, and the logging of profiling data
604 * @param string $mode Use 'fast' to always skip job running
607 public function doPostOutputShutdown( $mode = 'normal' ) {
608 $timing = $this->context
->getTiming();
609 $timing->mark( 'requestShutdown' );
611 // Show visible profiling data if enabled (which cannot be post-send)
612 Profiler
::instance()->logDataPageOutputOnly();
615 $callback = function () use ( $that, $mode ) {
617 $that->restInPeace( $mode );
618 } catch ( Exception
$e ) {
619 MWExceptionHandler
::handleException( $e );
623 // Defer everything else...
624 if ( function_exists( 'register_postsend_function' ) ) {
625 // https://github.com/facebook/hhvm/issues/1230
626 register_postsend_function( $callback );
628 if ( function_exists( 'fastcgi_finish_request' ) ) {
629 fastcgi_finish_request();
631 // Either all DB and deferred updates should happen or none.
632 // The later should not be cancelled due to client disconnect.
633 ignore_user_abort( true );
640 private function main() {
643 $request = $this->context
->getRequest();
645 // Send Ajax requests to the Ajax dispatcher.
646 if ( $this->config
->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
647 // Set a dummy title, because $wgTitle == null might break things
648 $title = Title
::makeTitle( NS_SPECIAL
, 'Badtitle/performing an AJAX call in '
651 $this->context
->setTitle( $title );
654 $dispatcher = new AjaxDispatcher( $this->config
);
655 $dispatcher->performAction( $this->context
->getUser() );
659 // Get title from request parameters,
660 // is set on the fly by parseTitle the first time.
661 $title = $this->getTitle();
662 $action = $this->getAction();
665 // Set DB query expectations for this HTTP request
666 $trxLimits = $this->config
->get( 'TrxProfilerLimits' );
667 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
668 $trxProfiler->setLogger( LoggerFactory
::getInstance( 'DBPerformance' ) );
669 if ( $request->wasPosted() ) {
670 $trxProfiler->setExpectations( $trxLimits['POST'], __METHOD__
);
672 $trxProfiler->setExpectations( $trxLimits['GET'], __METHOD__
);
675 // If the user has forceHTTPS set to true, or if the user
676 // is in a group requiring HTTPS, or if they have the HTTPS
677 // preference set, redirect them to HTTPS.
678 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
679 // isLoggedIn() will do all sorts of weird stuff.
681 $request->getProtocol() == 'http' &&
683 $request->getSession()->shouldForceHTTPS() ||
684 // Check the cookie manually, for paranoia
685 $request->getCookie( 'forceHTTPS', '' ) ||
686 // check for prefixed version that was used for a time in older MW versions
687 $request->getCookie( 'forceHTTPS' ) ||
688 // Avoid checking the user and groups unless it's enabled.
690 $this->context
->getUser()->isLoggedIn()
691 && $this->context
->getUser()->requiresHTTPS()
695 $oldUrl = $request->getFullRequestURL();
696 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
698 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
699 if ( Hooks
::run( 'BeforeHttpsRedirect', array( $this->context
, &$redirUrl ) ) ) {
701 if ( $request->wasPosted() ) {
702 // This is weird and we'd hope it almost never happens. This
703 // means that a POST came in via HTTP and policy requires us
704 // redirecting to HTTPS. It's likely such a request is going
705 // to fail due to post data being lost, but let's try anyway
706 // and just log the instance.
708 // @todo FIXME: See if we could issue a 307 or 308 here, need
709 // to see how clients (automated & browser) behave when we do
710 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
712 // Setup dummy Title, otherwise OutputPage::redirect will fail
713 $title = Title
::newFromText( 'REDIR', NS_MAIN
);
714 $this->context
->setTitle( $title );
715 $output = $this->context
->getOutput();
716 // Since we only do this redir to change proto, always send a vary header
717 $output->addVaryHeader( 'X-Forwarded-Proto' );
718 $output->redirect( $redirUrl );
724 if ( $this->config
->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
725 if ( HTMLFileCache
::useFileCache( $this->context
) ) {
726 // Try low-level file cache hit
727 $cache = new HTMLFileCache( $title, $action );
728 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
729 // Check incoming headers to see if client has this cached
730 $timestamp = $cache->cacheTimestamp();
731 if ( !$this->context
->getOutput()->checkLastModified( $timestamp ) ) {
732 $cache->loadFromFileCache( $this->context
);
734 // Do any stats increment/watchlist stuff
735 // Assume we're viewing the latest revision (this should always be the case with file cache)
736 $this->context
->getWikiPage()->doViewUpdates( $this->context
->getUser() );
737 // Tell OutputPage that output is taken care of
738 $this->context
->getOutput()->disable();
744 // Actually do the work of the request and build up any output
745 $this->performRequest();
747 // Now commit any transactions, so that unreported errors after
748 // output() don't roll back the whole DB transaction and so that
749 // we avoid having both success and error text in the response
750 $this->doPreOutputCommit();
752 // Output everything!
753 $this->context
->getOutput()->output();
757 * Ends this task peacefully
758 * @param string $mode Use 'fast' to always skip job running
760 public function restInPeace( $mode = 'fast' ) {
761 // Assure deferred updates are not in the main transaction
762 wfGetLBFactory()->commitMasterChanges( __METHOD__
);
764 // Ignore things like master queries/connections on GET requests
765 // as long as they are in deferred updates (which catch errors).
766 Profiler
::instance()->getTransactionProfiler()->resetExpectations();
768 // Do any deferred jobs
769 DeferredUpdates
::doUpdates( 'enqueue' );
771 // Make sure any lazy jobs are pushed
772 JobQueueGroup
::pushLazyJobs();
774 // Now that everything specific to this request is done,
775 // try to occasionally run jobs (if enabled) from the queues
776 if ( $mode === 'normal' ) {
777 $this->triggerJobs();
780 // Log profiling data, e.g. in the database or UDP
781 wfLogProfilingData();
783 // Commit and close up!
784 $factory = wfGetLBFactory();
785 $factory->commitMasterChanges( __METHOD__
);
786 $factory->shutdown( LBFactory
::SHUTDOWN_NO_CHRONPROT
);
788 wfDebug( "Request ended normally\n" );
792 * Potentially open a socket and sent an HTTP request back to the server
793 * to run a specified number of jobs. This registers a callback to cleanup
794 * the socket once it's done.
796 public function triggerJobs() {
797 $jobRunRate = $this->config
->get( 'JobRunRate' );
798 if ( $jobRunRate <= 0 ||
wfReadOnly() ) {
800 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
801 return; // recursion guard
804 if ( $jobRunRate < 1 ) {
805 $max = mt_getrandmax();
806 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
807 return; // the higher the job run rate, the less likely we return here
811 $n = intval( $jobRunRate );
814 $runJobsLogger = LoggerFactory
::getInstance( 'runJobs' );
816 if ( !$this->config
->get( 'RunJobsAsync' ) ) {
817 // Fall back to running the job here while the user waits
818 $runner = new JobRunner( $runJobsLogger );
819 $runner->run( array( 'maxJobs' => $n ) );
824 if ( !JobQueueGroup
::singleton()->queuesHaveJobs( JobQueueGroup
::TYPE_DEFAULT
) ) {
825 return; // do not send request if there are probably no jobs
827 } catch ( JobQueueError
$e ) {
828 MWExceptionHandler
::logException( $e );
829 return; // do not make the site unavailable
832 $query = array( 'title' => 'Special:RunJobs',
833 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() +
5 );
834 $query['signature'] = SpecialRunJobs
::getQuerySignature(
835 $query, $this->config
->get( 'SecretKey' ) );
837 $errno = $errstr = null;
838 $info = wfParseUrl( $this->config
->get( 'Server' ) );
839 MediaWiki\
suppressWarnings();
842 isset( $info['port'] ) ?
$info['port'] : 80,
845 // If it takes more than 100ms to connect to ourselves there
846 // is a problem elsewhere.
849 MediaWiki\restoreWarnings
();
851 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
852 // Fall back to running the job here while the user waits
853 $runner = new JobRunner( $runJobsLogger );
854 $runner->run( array( 'maxJobs' => $n ) );
858 $url = wfAppendQuery( wfScript( 'index' ), $query );
860 "POST $url HTTP/1.1\r\n" .
861 "Host: {$info['host']}\r\n" .
862 "Connection: Close\r\n" .
863 "Content-Length: 0\r\n\r\n"
866 $runJobsLogger->info( "Running $n job(s) via '$url'" );
867 // Send a cron API request to be performed in the background.
868 // Give up if this takes too long to send (which should be rare).
869 stream_set_timeout( $sock, 1 );
870 $bytes = fwrite( $sock, $req );
871 if ( $bytes !== strlen( $req ) ) {
872 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
874 // Do not wait for the response (the script should handle client aborts).
875 // Make sure that we don't close before that script reaches ignore_user_abort().
876 $status = fgets( $sock );
877 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
878 $runJobsLogger->error( "Failed to start cron API: received '$status'" );